2 dm9000.c: Version 1.2 12/15/2003
4 A Davicom DM9000 ISA NIC fast Ethernet driver for Linux.
5 Copyright (C) 1997 Sten Wang
7 * SPDX-License-Identifier: GPL-2.0+
9 (C)Copyright 1997-1998 DAVICOM Semiconductor,Inc. All Rights Reserved.
11 V0.11 06/20/2001 REG_0A bit3=1, default enable BP with DA match
12 06/22/2001 Support DM9801 progrmming
13 E3: R25 = ((R24 + NF) & 0x00ff) | 0xf000
14 E4: R25 = ((R24 + NF) & 0x00ff) | 0xc200
15 R17 = (R17 & 0xfff0) | NF + 3
16 E5: R25 = ((R24 + NF - 3) & 0x00ff) | 0xc200
17 R17 = (R17 & 0xfff0) | NF
19 v1.00 modify by simon 2001.9.5
20 change for kernel 2.4.x
22 v1.1 11/09/2001 fix force mode bug
24 v1.2 03/18/2003 Weilun Huang <weilun_huang@davicom.com.tw>:
26 Added tx/rx 32 bit mode.
27 Cleaned up for kernel merge.
29 --------------------------------------
31 12/15/2003 Initial port to u-boot by
32 Sascha Hauer <saschahauer@web.de>
34 06/03/2008 Remy Bohmer <linux@bohmer.net>
35 - Fixed the driver to work with DM9000A.
36 (check on ISR receive status bit before reading the
37 FIFO as described in DM9000 programming guide and
39 - Added autodetect of databus width.
40 - Made debug code compile again.
41 - Adapt eth_send such that it matches the DM9000*
42 application notes. Needed to make it work properly
44 - Adapted reset procedure to match DM9000 application
45 notes (i.e. double reset)
46 - some minor code cleanups
47 These changes are tested with DM9000{A,EP,E} together
48 with a 200MHz Atmel AT91SAM9261 core
50 TODO: external MII is not functional, only internal at the moment.
61 /* Board/System/Debug information/definition ---------------- */
63 /* #define CONFIG_DM9000_DEBUG */
65 #ifdef CONFIG_DM9000_DEBUG
66 #define DM9000_DBG(fmt,args...) printf(fmt, ##args)
67 #define DM9000_DMP_PACKET(func,packet,length) \
70 printf("%s: length: %d\n", func, length); \
71 for (i = 0; i < length; i++) { \
73 printf("\n%s: %02x: ", func, i); \
74 printf("%02x ", ((unsigned char *) packet)[i]); \
78 #define DM9000_DBG(fmt,args...)
79 #define DM9000_DMP_PACKET(func,packet,length)
82 /* Structure/enum declaration ------------------------------- */
83 typedef struct board_info {
84 u32 runt_length_counter; /* counter: RX length < 64byte */
85 u32 long_length_counter; /* counter: RX length > 1514byte */
86 u32 reset_counter; /* counter: RESET */
87 u32 reset_tx_timeout; /* RESET caused by TX Timeout */
88 u32 reset_rx_status; /* RESET caused by RX Statsus wrong */
93 u8 device_wait_reset; /* device state */
94 unsigned char srom[128];
95 void (*outblk)(volatile void *data_ptr, int count);
96 void (*inblk)(void *data_ptr, int count);
97 void (*rx_status)(u16 *RxStatus, u16 *RxLen);
98 struct eth_device netdev;
100 static board_info_t dm9000_info;
103 /* function declaration ------------------------------------- */
104 static int dm9000_probe(void);
105 static u16 dm9000_phy_read(int);
106 static void dm9000_phy_write(int, u16);
107 static u8 DM9000_ior(int);
108 static void DM9000_iow(int reg, u8 value);
110 /* DM9000 network board routine ---------------------------- */
111 #ifndef CONFIG_DM9000_BYTE_SWAPPED
112 #define DM9000_outb(d,r) writeb(d, (volatile u8 *)(r))
113 #define DM9000_outw(d,r) writew(d, (volatile u16 *)(r))
114 #define DM9000_outl(d,r) writel(d, (volatile u32 *)(r))
115 #define DM9000_inb(r) readb((volatile u8 *)(r))
116 #define DM9000_inw(r) readw((volatile u16 *)(r))
117 #define DM9000_inl(r) readl((volatile u32 *)(r))
119 #define DM9000_outb(d, r) __raw_writeb(d, r)
120 #define DM9000_outw(d, r) __raw_writew(d, r)
121 #define DM9000_outl(d, r) __raw_writel(d, r)
122 #define DM9000_inb(r) __raw_readb(r)
123 #define DM9000_inw(r) __raw_readw(r)
124 #define DM9000_inl(r) __raw_readl(r)
127 #ifdef CONFIG_DM9000_DEBUG
132 DM9000_DBG("NCR (0x00): %02x\n", DM9000_ior(0));
133 DM9000_DBG("NSR (0x01): %02x\n", DM9000_ior(1));
134 DM9000_DBG("TCR (0x02): %02x\n", DM9000_ior(2));
135 DM9000_DBG("TSRI (0x03): %02x\n", DM9000_ior(3));
136 DM9000_DBG("TSRII (0x04): %02x\n", DM9000_ior(4));
137 DM9000_DBG("RCR (0x05): %02x\n", DM9000_ior(5));
138 DM9000_DBG("RSR (0x06): %02x\n", DM9000_ior(6));
139 DM9000_DBG("ISR (0xFE): %02x\n", DM9000_ior(DM9000_ISR));
144 static void dm9000_outblk_8bit(volatile void *data_ptr, int count)
147 for (i = 0; i < count; i++)
148 DM9000_outb((((u8 *) data_ptr)[i] & 0xff), DM9000_DATA);
151 static void dm9000_outblk_16bit(volatile void *data_ptr, int count)
154 u32 tmplen = (count + 1) / 2;
156 for (i = 0; i < tmplen; i++)
157 DM9000_outw(((u16 *) data_ptr)[i], DM9000_DATA);
159 static void dm9000_outblk_32bit(volatile void *data_ptr, int count)
162 u32 tmplen = (count + 3) / 4;
164 for (i = 0; i < tmplen; i++)
165 DM9000_outl(((u32 *) data_ptr)[i], DM9000_DATA);
168 static void dm9000_inblk_8bit(void *data_ptr, int count)
171 for (i = 0; i < count; i++)
172 ((u8 *) data_ptr)[i] = DM9000_inb(DM9000_DATA);
175 static void dm9000_inblk_16bit(void *data_ptr, int count)
178 u32 tmplen = (count + 1) / 2;
180 for (i = 0; i < tmplen; i++)
181 ((u16 *) data_ptr)[i] = DM9000_inw(DM9000_DATA);
183 static void dm9000_inblk_32bit(void *data_ptr, int count)
186 u32 tmplen = (count + 3) / 4;
188 for (i = 0; i < tmplen; i++)
189 ((u32 *) data_ptr)[i] = DM9000_inl(DM9000_DATA);
192 static void dm9000_rx_status_32bit(u16 *RxStatus, u16 *RxLen)
196 DM9000_outb(DM9000_MRCMD, DM9000_IO);
198 tmpdata = DM9000_inl(DM9000_DATA);
199 *RxStatus = __le16_to_cpu(tmpdata);
200 *RxLen = __le16_to_cpu(tmpdata >> 16);
203 static void dm9000_rx_status_16bit(u16 *RxStatus, u16 *RxLen)
205 DM9000_outb(DM9000_MRCMD, DM9000_IO);
207 *RxStatus = __le16_to_cpu(DM9000_inw(DM9000_DATA));
208 *RxLen = __le16_to_cpu(DM9000_inw(DM9000_DATA));
211 static void dm9000_rx_status_8bit(u16 *RxStatus, u16 *RxLen)
213 DM9000_outb(DM9000_MRCMD, DM9000_IO);
216 __le16_to_cpu(DM9000_inb(DM9000_DATA) +
217 (DM9000_inb(DM9000_DATA) << 8));
219 __le16_to_cpu(DM9000_inb(DM9000_DATA) +
220 (DM9000_inb(DM9000_DATA) << 8));
224 Search DM9000 board, allocate space and register it
230 id_val = DM9000_ior(DM9000_VIDL);
231 id_val |= DM9000_ior(DM9000_VIDH) << 8;
232 id_val |= DM9000_ior(DM9000_PIDL) << 16;
233 id_val |= DM9000_ior(DM9000_PIDH) << 24;
234 if (id_val == DM9000_ID) {
235 printf("dm9000 i/o: 0x%x, id: 0x%x \n", CONFIG_DM9000_BASE,
239 printf("dm9000 not found at 0x%08x id: 0x%08x\n",
240 CONFIG_DM9000_BASE, id_val);
245 /* General Purpose dm9000 reset routine */
249 DM9000_DBG("resetting DM9000\n");
252 see DM9000 Application Notes V1.22 Jun 11, 2004 page 29 */
254 /* DEBUG: Make all GPIO0 outputs, all others inputs */
255 DM9000_iow(DM9000_GPCR, GPCR_GPIO0_OUT);
256 /* Step 1: Power internal PHY by writing 0 to GPIO0 pin */
257 DM9000_iow(DM9000_GPR, 0);
258 /* Step 2: Software reset */
259 DM9000_iow(DM9000_NCR, (NCR_LBK_INT_MAC | NCR_RST));
262 DM9000_DBG("resetting the DM9000, 1st reset\n");
263 udelay(25); /* Wait at least 20 us */
264 } while (DM9000_ior(DM9000_NCR) & 1);
266 DM9000_iow(DM9000_NCR, 0);
267 DM9000_iow(DM9000_NCR, (NCR_LBK_INT_MAC | NCR_RST)); /* Issue a second reset */
270 DM9000_DBG("resetting the DM9000, 2nd reset\n");
271 udelay(25); /* Wait at least 20 us */
272 } while (DM9000_ior(DM9000_NCR) & 1);
274 /* Check whether the ethernet controller is present */
275 if ((DM9000_ior(DM9000_PIDL) != 0x0) ||
276 (DM9000_ior(DM9000_PIDH) != 0x90))
277 printf("ERROR: resetting DM9000 -> not responding\n");
280 /* Initialize dm9000 board
282 static int dm9000_init(struct eth_device *dev, bd_t *bd)
286 struct board_info *db = &dm9000_info;
288 DM9000_DBG("%s\n", __func__);
293 if (dm9000_probe() < 0)
296 /* Auto-detect 8/16/32 bit mode, ISR Bit 6+7 indicate bus width */
297 io_mode = DM9000_ior(DM9000_ISR) >> 6;
300 case 0x0: /* 16-bit mode */
301 printf("DM9000: running in 16 bit mode\n");
302 db->outblk = dm9000_outblk_16bit;
303 db->inblk = dm9000_inblk_16bit;
304 db->rx_status = dm9000_rx_status_16bit;
306 case 0x01: /* 32-bit mode */
307 printf("DM9000: running in 32 bit mode\n");
308 db->outblk = dm9000_outblk_32bit;
309 db->inblk = dm9000_inblk_32bit;
310 db->rx_status = dm9000_rx_status_32bit;
312 case 0x02: /* 8 bit mode */
313 printf("DM9000: running in 8 bit mode\n");
314 db->outblk = dm9000_outblk_8bit;
315 db->inblk = dm9000_inblk_8bit;
316 db->rx_status = dm9000_rx_status_8bit;
319 /* Assume 8 bit mode, will probably not work anyway */
320 printf("DM9000: Undefined IO-mode:0x%x\n", io_mode);
321 db->outblk = dm9000_outblk_8bit;
322 db->inblk = dm9000_inblk_8bit;
323 db->rx_status = dm9000_rx_status_8bit;
327 /* Program operating register, only internal phy supported */
328 DM9000_iow(DM9000_NCR, 0x0);
329 /* TX Polling clear */
330 DM9000_iow(DM9000_TCR, 0);
331 /* Less 3Kb, 200us */
332 DM9000_iow(DM9000_BPTR, BPTR_BPHW(3) | BPTR_JPT_600US);
333 /* Flow Control : High/Low Water */
334 DM9000_iow(DM9000_FCTR, FCTR_HWOT(3) | FCTR_LWOT(8));
335 /* SH FIXME: This looks strange! Flow Control */
336 DM9000_iow(DM9000_FCR, 0x0);
338 DM9000_iow(DM9000_SMCR, 0);
339 /* clear TX status */
340 DM9000_iow(DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);
341 /* Clear interrupt status */
342 DM9000_iow(DM9000_ISR, ISR_ROOS | ISR_ROS | ISR_PTS | ISR_PRS);
344 printf("MAC: %pM\n", dev->enetaddr);
345 if (!is_valid_ethaddr(dev->enetaddr)) {
346 printf("WARNING: Bad MAC address (uninitialized EEPROM?)\n");
349 /* fill device MAC address registers */
350 for (i = 0, oft = DM9000_PAR; i < 6; i++, oft++)
351 DM9000_iow(oft, dev->enetaddr[i]);
352 for (i = 0, oft = 0x16; i < 8; i++, oft++)
353 DM9000_iow(oft, 0xff);
355 /* read back mac, just to be sure */
356 for (i = 0, oft = 0x10; i < 6; i++, oft++)
357 DM9000_DBG("%02x:", DM9000_ior(oft));
360 /* Activate DM9000 */
362 DM9000_iow(DM9000_RCR, RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN);
363 /* Enable TX/RX interrupt mask */
364 DM9000_iow(DM9000_IMR, IMR_PAR);
367 while (!(dm9000_phy_read(1) & 0x20)) { /* autonegation complete bit */
371 printf("could not establish link\n");
376 /* see what we've got */
377 lnk = dm9000_phy_read(17) >> 12;
378 printf("operating at ");
381 printf("10M half duplex ");
384 printf("10M full duplex ");
387 printf("100M half duplex ");
390 printf("100M full duplex ");
393 printf("unknown: %d ", lnk);
401 Hardware start transmission.
402 Send a packet to media from the upper layer.
404 static int dm9000_send(struct eth_device *netdev, void *packet, int length)
407 struct board_info *db = &dm9000_info;
409 DM9000_DMP_PACKET(__func__ , packet, length);
411 DM9000_iow(DM9000_ISR, IMR_PTM); /* Clear Tx bit in ISR */
413 /* Move data to DM9000 TX RAM */
414 DM9000_outb(DM9000_MWCMD, DM9000_IO); /* Prepare for TX-data */
416 /* push the data to the TX-fifo */
417 (db->outblk)(packet, length);
419 /* Set TX length to DM9000 */
420 DM9000_iow(DM9000_TXPLL, length & 0xff);
421 DM9000_iow(DM9000_TXPLH, (length >> 8) & 0xff);
423 /* Issue TX polling command */
424 DM9000_iow(DM9000_TCR, TCR_TXREQ); /* Cleared after TX complete */
426 /* wait for end of transmission */
427 tmo = get_timer(0) + 5 * CONFIG_SYS_HZ;
428 while ( !(DM9000_ior(DM9000_NSR) & (NSR_TX1END | NSR_TX2END)) ||
429 !(DM9000_ior(DM9000_ISR) & IMR_PTM) ) {
430 if (get_timer(0) >= tmo) {
431 printf("transmission timeout\n");
435 DM9000_iow(DM9000_ISR, IMR_PTM); /* Clear Tx bit in ISR */
437 DM9000_DBG("transmit done\n\n");
443 The interface is stopped when it is brought.
445 static void dm9000_halt(struct eth_device *netdev)
447 DM9000_DBG("%s\n", __func__);
450 dm9000_phy_write(0, 0x8000); /* PHY RESET */
451 DM9000_iow(DM9000_GPR, 0x01); /* Power-Down PHY */
452 DM9000_iow(DM9000_IMR, 0x80); /* Disable all interrupt */
453 DM9000_iow(DM9000_RCR, 0x00); /* Disable RX */
457 Received a packet and pass to upper layer
459 static int dm9000_rx(struct eth_device *netdev)
462 u8 *rdptr = (u8 *)net_rx_packets[0];
463 u16 RxStatus, RxLen = 0;
464 struct board_info *db = &dm9000_info;
466 /* Check packet ready or not, we must check
467 the ISR status first for DM9000A */
468 if (!(DM9000_ior(DM9000_ISR) & 0x01)) /* Rx-ISR bit must be set. */
471 DM9000_iow(DM9000_ISR, 0x01); /* clear PR status latched in bit 0 */
473 /* There is _at least_ 1 package in the fifo, read them all */
475 DM9000_ior(DM9000_MRCMDX); /* Dummy read */
477 /* Get most updated data,
478 only look at bits 0:1, See application notes DM9000 */
479 rxbyte = DM9000_inb(DM9000_DATA) & 0x03;
481 /* Status check: this byte must be 0 or 1 */
482 if (rxbyte > DM9000_PKT_RDY) {
483 DM9000_iow(DM9000_RCR, 0x00); /* Stop Device */
484 DM9000_iow(DM9000_ISR, 0x80); /* Stop INT request */
485 printf("DM9000 error: status check fail: 0x%x\n",
490 if (rxbyte != DM9000_PKT_RDY)
491 return 0; /* No packet received, ignore */
493 DM9000_DBG("receiving packet\n");
495 /* A packet ready now & Get status/length */
496 (db->rx_status)(&RxStatus, &RxLen);
498 DM9000_DBG("rx status: 0x%04x rx len: %d\n", RxStatus, RxLen);
500 /* Move data from DM9000 */
501 /* Read received packet from RX SRAM */
502 (db->inblk)(rdptr, RxLen);
504 if ((RxStatus & 0xbf00) || (RxLen < 0x40)
505 || (RxLen > DM9000_PKT_MAX)) {
506 if (RxStatus & 0x100) {
507 printf("rx fifo error\n");
509 if (RxStatus & 0x200) {
510 printf("rx crc error\n");
512 if (RxStatus & 0x8000) {
513 printf("rx length error\n");
515 if (RxLen > DM9000_PKT_MAX) {
516 printf("rx length too big\n");
520 DM9000_DMP_PACKET(__func__ , rdptr, RxLen);
522 DM9000_DBG("passing packet to upper layer\n");
523 net_process_received_packet(net_rx_packets[0], RxLen);
530 Read a word data from SROM
532 #if !defined(CONFIG_DM9000_NO_SROM)
533 void dm9000_read_srom_word(int offset, u8 *to)
535 DM9000_iow(DM9000_EPAR, offset);
536 DM9000_iow(DM9000_EPCR, 0x4);
538 DM9000_iow(DM9000_EPCR, 0x0);
539 to[0] = DM9000_ior(DM9000_EPDRL);
540 to[1] = DM9000_ior(DM9000_EPDRH);
543 void dm9000_write_srom_word(int offset, u16 val)
545 DM9000_iow(DM9000_EPAR, offset);
546 DM9000_iow(DM9000_EPDRH, ((val >> 8) & 0xff));
547 DM9000_iow(DM9000_EPDRL, (val & 0xff));
548 DM9000_iow(DM9000_EPCR, 0x12);
550 DM9000_iow(DM9000_EPCR, 0);
554 static void dm9000_get_enetaddr(struct eth_device *dev)
556 #if !defined(CONFIG_DM9000_NO_SROM)
558 for (i = 0; i < 3; i++)
559 dm9000_read_srom_word(i, dev->enetaddr + (2 * i));
564 Read a byte from I/O port
569 DM9000_outb(reg, DM9000_IO);
570 return DM9000_inb(DM9000_DATA);
574 Write a byte to I/O port
577 DM9000_iow(int reg, u8 value)
579 DM9000_outb(reg, DM9000_IO);
580 DM9000_outb(value, DM9000_DATA);
584 Read a word from phyxcer
587 dm9000_phy_read(int reg)
591 /* Fill the phyxcer register into REG_0C */
592 DM9000_iow(DM9000_EPAR, DM9000_PHY | reg);
593 DM9000_iow(DM9000_EPCR, 0xc); /* Issue phyxcer read command */
594 udelay(100); /* Wait read complete */
595 DM9000_iow(DM9000_EPCR, 0x0); /* Clear phyxcer read command */
596 val = (DM9000_ior(DM9000_EPDRH) << 8) | DM9000_ior(DM9000_EPDRL);
598 /* The read data keeps on REG_0D & REG_0E */
599 DM9000_DBG("dm9000_phy_read(0x%x): 0x%x\n", reg, val);
604 Write a word to phyxcer
607 dm9000_phy_write(int reg, u16 value)
610 /* Fill the phyxcer register into REG_0C */
611 DM9000_iow(DM9000_EPAR, DM9000_PHY | reg);
613 /* Fill the written data into REG_0D & REG_0E */
614 DM9000_iow(DM9000_EPDRL, (value & 0xff));
615 DM9000_iow(DM9000_EPDRH, ((value >> 8) & 0xff));
616 DM9000_iow(DM9000_EPCR, 0xa); /* Issue phyxcer write command */
617 udelay(500); /* Wait write complete */
618 DM9000_iow(DM9000_EPCR, 0x0); /* Clear phyxcer write command */
619 DM9000_DBG("dm9000_phy_write(reg:0x%x, value:0x%x)\n", reg, value);
622 int dm9000_initialize(bd_t *bis)
624 struct eth_device *dev = &(dm9000_info.netdev);
626 /* Load MAC address from EEPROM */
627 dm9000_get_enetaddr(dev);
629 dev->init = dm9000_init;
630 dev->halt = dm9000_halt;
631 dev->send = dm9000_send;
632 dev->recv = dm9000_rx;
633 strcpy(dev->name, "dm9000");