1 // SPDX-License-Identifier: GPL-2.0+
3 * dm9000.c: Version 1.2 12/15/2003
5 * A Davicom DM9000 ISA NIC fast Ethernet driver for Linux.
6 * Copyright (C) 1997 Sten Wang
8 * (C)Copyright 1997-1998 DAVICOM Semiconductor,Inc. All Rights Reserved.
10 * V0.11 06/20/2001 REG_0A bit3=1, default enable BP with DA match
11 * 06/22/2001 Support DM9801 progrmming
12 * E3: R25 = ((R24 + NF) & 0x00ff) | 0xf000
13 * E4: R25 = ((R24 + NF) & 0x00ff) | 0xc200
14 * R17 = (R17 & 0xfff0) | NF + 3
15 * E5: R25 = ((R24 + NF - 3) & 0x00ff) | 0xc200
16 * R17 = (R17 & 0xfff0) | NF
18 * v1.00 modify by simon 2001.9.5
19 * change for kernel 2.4.x
21 * v1.1 11/09/2001 fix force mode bug
23 * v1.2 03/18/2003 Weilun Huang <weilun_huang@davicom.com.tw>:
25 * Added tx/rx 32 bit mode.
26 * Cleaned up for kernel merge.
28 * --------------------------------------
30 * 12/15/2003 Initial port to u-boot by
31 * Sascha Hauer <saschahauer@web.de>
33 * 06/03/2008 Remy Bohmer <linux@bohmer.net>
34 * - Fixed the driver to work with DM9000A.
35 * (check on ISR receive status bit before reading the
36 * FIFO as described in DM9000 programming guide and
38 * - Added autodetect of databus width.
39 * - Made debug code compile again.
40 * - Adapt eth_send such that it matches the DM9000*
41 * application notes. Needed to make it work properly
43 * - Adapted reset procedure to match DM9000 application
44 * notes (i.e. double reset)
45 * - some minor code cleanups
46 * These changes are tested with DM9000{A,EP,E} together
47 * with a 200MHz Atmel AT91SAM9261 core
49 * TODO: external MII is not functional, only internal at the moment.
58 #include <linux/delay.h>
62 /* Structure/enum declaration ------------------------------- */
64 u32 runt_length_counter; /* counter: RX length < 64byte */
65 u32 long_length_counter; /* counter: RX length > 1514byte */
66 u32 reset_counter; /* counter: RESET */
67 u32 reset_tx_timeout; /* RESET caused by TX Timeout */
68 u32 reset_rx_status; /* RESET caused by RX Statsus wrong */
73 u8 device_wait_reset; /* device state */
74 unsigned char srom[128];
75 void (*outblk)(struct dm9000_priv *db, void *data_ptr, int count);
76 void (*inblk)(struct dm9000_priv *db, void *data_ptr, int count);
77 void (*rx_status)(struct dm9000_priv *db, u16 *rxstatus, u16 *rxlen);
79 struct eth_device dev;
81 void __iomem *base_io;
82 void __iomem *base_data;
85 /* DM9000 network board routine ---------------------------- */
86 #ifndef CONFIG_DM9000_BYTE_SWAPPED
87 #define dm9000_outb(d, r) writeb((d), (r))
88 #define dm9000_outw(d, r) writew((d), (r))
89 #define dm9000_outl(d, r) writel((d), (r))
90 #define dm9000_inb(r) readb(r)
91 #define dm9000_inw(r) readw(r)
92 #define dm9000_inl(r) readl(r)
94 #define dm9000_outb(d, r) __raw_writeb(d, r)
95 #define dm9000_outw(d, r) __raw_writew(d, r)
96 #define dm9000_outl(d, r) __raw_writel(d, r)
97 #define dm9000_inb(r) __raw_readb(r)
98 #define dm9000_inw(r) __raw_readw(r)
99 #define dm9000_inl(r) __raw_readl(r)
103 static void dm9000_dump_packet(const char *func, u8 *packet, int length)
107 printf("%s: length: %d\n", func, length);
109 for (i = 0; i < length; i++) {
111 printf("\n%s: %02x: ", func, i);
112 printf("%02x ", packet[i]);
118 static void dm9000_dump_packet(const char *func, u8 *packet, int length) {}
121 static void dm9000_outblk_8bit(struct dm9000_priv *db, void *data_ptr, int count)
125 for (i = 0; i < count; i++)
126 dm9000_outb((((u8 *)data_ptr)[i] & 0xff), db->base_data);
129 static void dm9000_outblk_16bit(struct dm9000_priv *db, void *data_ptr, int count)
132 u32 tmplen = (count + 1) / 2;
134 for (i = 0; i < tmplen; i++)
135 dm9000_outw(((u16 *)data_ptr)[i], db->base_data);
138 static void dm9000_outblk_32bit(struct dm9000_priv *db, void *data_ptr, int count)
141 u32 tmplen = (count + 3) / 4;
143 for (i = 0; i < tmplen; i++)
144 dm9000_outl(((u32 *)data_ptr)[i], db->base_data);
147 static void dm9000_inblk_8bit(struct dm9000_priv *db, void *data_ptr, int count)
151 for (i = 0; i < count; i++)
152 ((u8 *)data_ptr)[i] = dm9000_inb(db->base_data);
155 static void dm9000_inblk_16bit(struct dm9000_priv *db, void *data_ptr, int count)
158 u32 tmplen = (count + 1) / 2;
160 for (i = 0; i < tmplen; i++)
161 ((u16 *)data_ptr)[i] = dm9000_inw(db->base_data);
164 static void dm9000_inblk_32bit(struct dm9000_priv *db, void *data_ptr, int count)
167 u32 tmplen = (count + 3) / 4;
169 for (i = 0; i < tmplen; i++)
170 ((u32 *)data_ptr)[i] = dm9000_inl(db->base_data);
173 static void dm9000_rx_status_32bit(struct dm9000_priv *db, u16 *rxstatus, u16 *rxlen)
177 dm9000_outb(DM9000_MRCMD, db->base_io);
179 tmpdata = dm9000_inl(db->base_data);
180 *rxstatus = __le16_to_cpu(tmpdata);
181 *rxlen = __le16_to_cpu(tmpdata >> 16);
184 static void dm9000_rx_status_16bit(struct dm9000_priv *db, u16 *rxstatus, u16 *rxlen)
186 dm9000_outb(DM9000_MRCMD, db->base_io);
188 *rxstatus = __le16_to_cpu(dm9000_inw(db->base_data));
189 *rxlen = __le16_to_cpu(dm9000_inw(db->base_data));
192 static void dm9000_rx_status_8bit(struct dm9000_priv *db, u16 *rxstatus, u16 *rxlen)
194 dm9000_outb(DM9000_MRCMD, db->base_io);
197 __le16_to_cpu(dm9000_inb(db->base_data) +
198 (dm9000_inb(db->base_data) << 8));
200 __le16_to_cpu(dm9000_inb(db->base_data) +
201 (dm9000_inb(db->base_data) << 8));
205 * Read a byte from I/O port
207 static u8 dm9000_ior(struct dm9000_priv *db, int reg)
209 dm9000_outb(reg, db->base_io);
210 return dm9000_inb(db->base_data);
214 * Write a byte to I/O port
216 static void dm9000_iow(struct dm9000_priv *db, int reg, u8 value)
218 dm9000_outb(reg, db->base_io);
219 dm9000_outb(value, db->base_data);
223 * Read a word from phyxcer
225 static u16 dm9000_phy_read(struct dm9000_priv *db, int reg)
229 /* Fill the phyxcer register into REG_0C */
230 dm9000_iow(db, DM9000_EPAR, DM9000_PHY | reg);
231 dm9000_iow(db, DM9000_EPCR, 0xc); /* Issue phyxcer read command */
232 udelay(100); /* Wait read complete */
233 dm9000_iow(db, DM9000_EPCR, 0x0); /* Clear phyxcer read command */
234 val = (dm9000_ior(db, DM9000_EPDRH) << 8) |
235 dm9000_ior(db, DM9000_EPDRL);
237 /* The read data keeps on REG_0D & REG_0E */
238 debug("%s(0x%x): 0x%x\n", __func__, reg, val);
243 * Write a word to phyxcer
245 static void dm9000_phy_write(struct dm9000_priv *db, int reg, u16 value)
247 /* Fill the phyxcer register into REG_0C */
248 dm9000_iow(db, DM9000_EPAR, DM9000_PHY | reg);
250 /* Fill the written data into REG_0D & REG_0E */
251 dm9000_iow(db, DM9000_EPDRL, (value & 0xff));
252 dm9000_iow(db, DM9000_EPDRH, ((value >> 8) & 0xff));
253 dm9000_iow(db, DM9000_EPCR, 0xa); /* Issue phyxcer write command */
254 udelay(500); /* Wait write complete */
255 dm9000_iow(db, DM9000_EPCR, 0x0); /* Clear phyxcer write command */
256 debug("%s(reg:0x%x, value:0x%x)\n", __func__, reg, value);
260 * Search DM9000 board, allocate space and register it
262 static int dm9000_probe(struct dm9000_priv *db)
266 id_val = dm9000_ior(db, DM9000_VIDL);
267 id_val |= dm9000_ior(db, DM9000_VIDH) << 8;
268 id_val |= dm9000_ior(db, DM9000_PIDL) << 16;
269 id_val |= dm9000_ior(db, DM9000_PIDH) << 24;
270 if (id_val != DM9000_ID) {
271 printf("dm9000 not found at 0x%p id: 0x%08x\n",
272 db->base_io, id_val);
276 printf("dm9000 i/o: 0x%p, id: 0x%x\n", db->base_io, id_val);
280 /* General Purpose dm9000 reset routine */
281 static void dm9000_reset(struct dm9000_priv *db)
283 debug("resetting DM9000\n");
287 * see DM9000 Application Notes V1.22 Jun 11, 2004 page 29
290 /* DEBUG: Make all GPIO0 outputs, all others inputs */
291 dm9000_iow(db, DM9000_GPCR, GPCR_GPIO0_OUT);
292 /* Step 1: Power internal PHY by writing 0 to GPIO0 pin */
293 dm9000_iow(db, DM9000_GPR, 0);
294 /* Step 2: Software reset */
295 dm9000_iow(db, DM9000_NCR, (NCR_LBK_INT_MAC | NCR_RST));
298 debug("resetting the DM9000, 1st reset\n");
299 udelay(25); /* Wait at least 20 us */
300 } while (dm9000_ior(db, DM9000_NCR) & 1);
302 dm9000_iow(db, DM9000_NCR, 0);
303 dm9000_iow(db, DM9000_NCR, (NCR_LBK_INT_MAC | NCR_RST)); /* Issue a second reset */
306 debug("resetting the DM9000, 2nd reset\n");
307 udelay(25); /* Wait at least 20 us */
308 } while (dm9000_ior(db, DM9000_NCR) & 1);
310 /* Check whether the ethernet controller is present */
311 if ((dm9000_ior(db, DM9000_PIDL) != 0x0) ||
312 (dm9000_ior(db, DM9000_PIDH) != 0x90))
313 printf("ERROR: resetting DM9000 -> not responding\n");
316 /* Initialize dm9000 board */
317 static int dm9000_init_common(struct dm9000_priv *db, u8 enetaddr[6])
325 if (dm9000_probe(db) < 0)
328 /* Auto-detect 8/16/32 bit mode, ISR Bit 6+7 indicate bus width */
329 io_mode = dm9000_ior(db, DM9000_ISR) >> 6;
332 case 0x0: /* 16-bit mode */
333 printf("DM9000: running in 16 bit mode\n");
334 db->outblk = dm9000_outblk_16bit;
335 db->inblk = dm9000_inblk_16bit;
336 db->rx_status = dm9000_rx_status_16bit;
338 case 0x01: /* 32-bit mode */
339 printf("DM9000: running in 32 bit mode\n");
340 db->outblk = dm9000_outblk_32bit;
341 db->inblk = dm9000_inblk_32bit;
342 db->rx_status = dm9000_rx_status_32bit;
344 case 0x02: /* 8 bit mode */
345 printf("DM9000: running in 8 bit mode\n");
346 db->outblk = dm9000_outblk_8bit;
347 db->inblk = dm9000_inblk_8bit;
348 db->rx_status = dm9000_rx_status_8bit;
351 /* Assume 8 bit mode, will probably not work anyway */
352 printf("DM9000: Undefined IO-mode:0x%x\n", io_mode);
353 db->outblk = dm9000_outblk_8bit;
354 db->inblk = dm9000_inblk_8bit;
355 db->rx_status = dm9000_rx_status_8bit;
359 /* Program operating register, only internal phy supported */
360 dm9000_iow(db, DM9000_NCR, 0x0);
361 /* TX Polling clear */
362 dm9000_iow(db, DM9000_TCR, 0);
363 /* Less 3Kb, 200us */
364 dm9000_iow(db, DM9000_BPTR, BPTR_BPHW(3) | BPTR_JPT_600US);
365 /* Flow Control : High/Low Water */
366 dm9000_iow(db, DM9000_FCTR, FCTR_HWOT(3) | FCTR_LWOT(8));
367 /* SH FIXME: This looks strange! Flow Control */
368 dm9000_iow(db, DM9000_FCR, 0x0);
370 dm9000_iow(db, DM9000_SMCR, 0);
371 /* clear TX status */
372 dm9000_iow(db, DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);
373 /* Clear interrupt status */
374 dm9000_iow(db, DM9000_ISR, ISR_ROOS | ISR_ROS | ISR_PTS | ISR_PRS);
376 printf("MAC: %pM\n", enetaddr);
377 if (!is_valid_ethaddr(enetaddr))
378 printf("WARNING: Bad MAC address (uninitialized EEPROM?)\n");
380 /* fill device MAC address registers */
381 for (i = 0, oft = DM9000_PAR; i < 6; i++, oft++)
382 dm9000_iow(db, oft, enetaddr[i]);
383 for (i = 0, oft = 0x16; i < 8; i++, oft++)
384 dm9000_iow(db, oft, 0xff);
386 /* read back mac, just to be sure */
387 for (i = 0, oft = 0x10; i < 6; i++, oft++)
388 debug("%02x:", dm9000_ior(db, oft));
391 /* Activate DM9000 */
393 dm9000_iow(db, DM9000_RCR, RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN);
394 /* Enable TX/RX interrupt mask */
395 dm9000_iow(db, DM9000_IMR, IMR_PAR);
398 while (!(dm9000_phy_read(db, 1) & 0x20)) { /* autonegation complete bit */
402 printf("could not establish link\n");
407 /* see what we've got */
408 lnk = dm9000_phy_read(db, 17) >> 12;
409 printf("operating at ");
412 printf("10M half duplex ");
415 printf("10M full duplex ");
418 printf("100M half duplex ");
421 printf("100M full duplex ");
424 printf("unknown: %d ", lnk);
432 * Hardware start transmission.
433 * Send a packet to media from the upper layer.
435 static int dm9000_send_common(struct dm9000_priv *db, void *packet, int length)
439 dm9000_dump_packet(__func__, packet, length);
441 dm9000_iow(db, DM9000_ISR, IMR_PTM); /* Clear Tx bit in ISR */
443 /* Move data to DM9000 TX RAM */
444 dm9000_outb(DM9000_MWCMD, db->base_io); /* Prepare for TX-data */
446 /* push the data to the TX-fifo */
447 db->outblk(db, packet, length);
449 /* Set TX length to DM9000 */
450 dm9000_iow(db, DM9000_TXPLL, length & 0xff);
451 dm9000_iow(db, DM9000_TXPLH, (length >> 8) & 0xff);
453 /* Issue TX polling command */
454 dm9000_iow(db, DM9000_TCR, TCR_TXREQ); /* Cleared after TX complete */
456 /* wait for end of transmission */
457 tmo = get_timer(0) + 5 * CONFIG_SYS_HZ;
458 while (!(dm9000_ior(db, DM9000_NSR) & (NSR_TX1END | NSR_TX2END)) ||
459 !(dm9000_ior(db, DM9000_ISR) & IMR_PTM)) {
460 if (get_timer(0) >= tmo) {
461 printf("transmission timeout\n");
465 dm9000_iow(db, DM9000_ISR, IMR_PTM); /* Clear Tx bit in ISR */
467 debug("transmit done\n\n");
472 * Stop the interface.
473 * The interface is stopped when it is brought.
475 static void dm9000_halt_common(struct dm9000_priv *db)
478 dm9000_phy_write(db, 0, 0x8000); /* PHY RESET */
479 dm9000_iow(db, DM9000_GPR, 0x01); /* Power-Down PHY */
480 dm9000_iow(db, DM9000_IMR, 0x80); /* Disable all interrupt */
481 dm9000_iow(db, DM9000_RCR, 0x00); /* Disable RX */
485 * Received a packet and pass to upper layer
487 static int dm9000_recv_common(struct dm9000_priv *db, uchar *rdptr)
490 u16 rxstatus, rxlen = 0;
493 * Check packet ready or not, we must check
494 * the ISR status first for DM9000A
496 if (!(dm9000_ior(db, DM9000_ISR) & 0x01)) /* Rx-ISR bit must be set. */
499 dm9000_iow(db, DM9000_ISR, 0x01); /* clear PR status latched in bit 0 */
501 /* There is _at least_ 1 package in the fifo, read them all */
502 dm9000_ior(db, DM9000_MRCMDX); /* Dummy read */
505 * Get most updated data,
506 * only look at bits 0:1, See application notes DM9000
508 rxbyte = dm9000_inb(db->base_data) & 0x03;
510 /* Status check: this byte must be 0 or 1 */
511 if (rxbyte > DM9000_PKT_RDY) {
512 dm9000_iow(db, DM9000_RCR, 0x00); /* Stop Device */
513 dm9000_iow(db, DM9000_ISR, 0x80); /* Stop INT request */
514 printf("DM9000 error: status check fail: 0x%x\n",
519 if (rxbyte != DM9000_PKT_RDY)
520 return 0; /* No packet received, ignore */
522 debug("receiving packet\n");
524 /* A packet ready now & Get status/length */
525 db->rx_status(db, &rxstatus, &rxlen);
527 debug("rx status: 0x%04x rx len: %d\n", rxstatus, rxlen);
529 /* Move data from DM9000 */
530 /* Read received packet from RX SRAM */
531 db->inblk(db, rdptr, rxlen);
533 if (rxstatus & 0xbf00 || rxlen < 0x40 || rxlen > DM9000_PKT_MAX) {
534 if (rxstatus & 0x100)
535 printf("rx fifo error\n");
536 if (rxstatus & 0x200)
537 printf("rx crc error\n");
538 if (rxstatus & 0x8000)
539 printf("rx length error\n");
540 if (rxlen > DM9000_PKT_MAX) {
541 printf("rx length too big\n");
551 * Read a word data from SROM
553 #if !defined(CONFIG_DM9000_NO_SROM)
554 static void dm9000_read_srom_word(struct dm9000_priv *db, int offset, u8 *to)
556 dm9000_iow(db, DM9000_EPAR, offset);
557 dm9000_iow(db, DM9000_EPCR, 0x4);
559 dm9000_iow(db, DM9000_EPCR, 0x0);
560 to[0] = dm9000_ior(db, DM9000_EPDRL);
561 to[1] = dm9000_ior(db, DM9000_EPDRH);
564 static void dm9000_get_enetaddr(struct dm9000_priv *db, u8 *enetaddr)
568 for (i = 0; i < 3; i++)
569 dm9000_read_srom_word(db, i, enetaddr + (2 * i));
572 static void dm9000_get_enetaddr(struct dm9000_priv *db, u8 *enetaddr) {}
575 #ifndef CONFIG_DM_ETH
576 static int dm9000_init(struct eth_device *dev, struct bd_info *bd)
578 struct dm9000_priv *db = container_of(dev, struct dm9000_priv, dev);
580 return dm9000_init_common(db, dev->enetaddr);
583 static void dm9000_halt(struct eth_device *dev)
585 struct dm9000_priv *db = container_of(dev, struct dm9000_priv, dev);
587 dm9000_halt_common(db);
590 static int dm9000_send(struct eth_device *dev, void *packet, int length)
592 struct dm9000_priv *db = container_of(dev, struct dm9000_priv, dev);
594 return dm9000_send_common(db, packet, length);
597 static int dm9000_recv(struct eth_device *dev)
599 struct dm9000_priv *db = container_of(dev, struct dm9000_priv, dev);
602 ret = dm9000_recv_common(db, net_rx_packets[0]);
604 net_process_received_packet(net_rx_packets[0], ret);
609 int dm9000_initialize(struct bd_info *bis)
611 struct dm9000_priv *priv;
612 struct eth_device *dev;
614 priv = calloc(1, sizeof(*priv));
620 priv->base_io = (void __iomem *)DM9000_IO;
621 priv->base_data = (void __iomem *)DM9000_DATA;
623 /* Load MAC address from EEPROM */
624 dm9000_get_enetaddr(priv, dev->enetaddr);
626 dev->init = dm9000_init;
627 dev->halt = dm9000_halt;
628 dev->send = dm9000_send;
629 dev->recv = dm9000_recv;
630 strcpy(dev->name, "dm9000");
632 eth_register(&priv->dev);
636 #else /* ifdef CONFIG_DM_ETH */
637 static int dm9000_start(struct udevice *dev)
639 struct dm9000_priv *db = dev_get_priv(dev);
640 struct eth_pdata *pdata = dev_get_plat(dev);
642 return dm9000_init_common(db, pdata->enetaddr);
645 static void dm9000_stop(struct udevice *dev)
647 struct dm9000_priv *db = dev_get_priv(dev);
649 dm9000_halt_common(db);
652 static int dm9000_send(struct udevice *dev, void *packet, int length)
654 struct dm9000_priv *db = dev_get_priv(dev);
657 ret = dm9000_send_common(db, packet, length);
659 return ret ? 0 : -ETIMEDOUT;
662 static int dm9000_recv(struct udevice *dev, int flags, uchar **packetp)
664 struct dm9000_priv *db = dev_get_priv(dev);
665 uchar *data = net_rx_packets[0];
668 ret = dm9000_recv_common(db, data);
670 *packetp = (void *)data;
672 return ret >= 0 ? ret : -EAGAIN;
675 static int dm9000_write_hwaddr(struct udevice *dev)
677 struct dm9000_priv *db = dev_get_priv(dev);
678 struct eth_pdata *pdata = dev_get_plat(dev);
681 /* fill device MAC address registers */
682 for (i = 0, oft = DM9000_PAR; i < 6; i++, oft++)
683 dm9000_iow(db, oft, pdata->enetaddr[i]);
685 for (i = 0, oft = 0x16; i < 8; i++, oft++)
686 dm9000_iow(db, oft, 0xff);
688 /* read back mac, just to be sure */
689 for (i = 0, oft = 0x10; i < 6; i++, oft++)
690 debug("%02x:", dm9000_ior(db, oft));
697 static int dm9000_read_rom_hwaddr(struct udevice *dev)
699 struct dm9000_priv *db = dev_get_priv(dev);
700 struct eth_pdata *pdata = dev_get_plat(dev);
702 dm9000_get_enetaddr(db, pdata->enetaddr);
704 return !is_valid_ethaddr(pdata->enetaddr);
707 static int dm9000_bind(struct udevice *dev)
709 return device_set_name(dev, dev->name);
712 static int dm9000_of_to_plat(struct udevice *dev)
714 struct dm9000_priv *db = dev_get_priv(dev);
715 struct eth_pdata *pdata = dev_get_plat(dev);
717 pdata->iobase = dev_read_addr_index(dev, 0);
718 db->base_io = (void __iomem *)pdata->iobase;
719 db->base_data = (void __iomem *)dev_read_addr_index(dev, 1);
724 static const struct eth_ops dm9000_ops = {
725 .start = dm9000_start,
729 .write_hwaddr = dm9000_write_hwaddr,
730 .read_rom_hwaddr = dm9000_read_rom_hwaddr,
733 static const struct udevice_id dm9000_ids[] = {
734 { .compatible = "davicom,dm9000" },
738 U_BOOT_DRIVER(dm9000) = {
739 .name = "eth_dm9000",
741 .of_match = dm9000_ids,
743 .of_to_plat = dm9000_of_to_plat,
745 .priv_auto = sizeof(struct dm9000_priv),
746 .plat_auto = sizeof(struct eth_pdata),
747 .flags = DM_FLAG_ALLOC_PRIV_DMA,