1 // SPDX-License-Identifier: GPL-2.0+
10 #include <linux/bitops.h>
11 #include <linux/delay.h>
16 #define PCI_CFDA_PSM 0x43
18 #define CFRV_RN 0x000000f0 /* Revision Number */
20 #define WAKEUP 0x00 /* Power Saving Wakeup */
21 #define SLEEP 0x80 /* Power Saving Sleep Mode */
23 #define DC2114x_BRK 0x0020 /* CFRV break between DC21142 & DC21143 */
25 /* Ethernet chip registers. */
26 #define DE4X5_BMR 0x000 /* Bus Mode Register */
27 #define DE4X5_TPD 0x008 /* Transmit Poll Demand Reg */
28 #define DE4X5_RRBA 0x018 /* RX Ring Base Address Reg */
29 #define DE4X5_TRBA 0x020 /* TX Ring Base Address Reg */
30 #define DE4X5_STS 0x028 /* Status Register */
31 #define DE4X5_OMR 0x030 /* Operation Mode Register */
32 #define DE4X5_SICR 0x068 /* SIA Connectivity Register */
33 #define DE4X5_APROM 0x048 /* Ethernet Address PROM */
36 #define BMR_SWR 0x00000001 /* Software Reset */
37 #define STS_TS 0x00700000 /* Transmit Process State */
38 #define STS_RS 0x000e0000 /* Receive Process State */
39 #define OMR_ST 0x00002000 /* Start/Stop Transmission Command */
40 #define OMR_SR 0x00000002 /* Start/Stop Receive */
41 #define OMR_PS 0x00040000 /* Port Select */
42 #define OMR_SDP 0x02000000 /* SD Polarity - MUST BE ASSERTED */
43 #define OMR_PM 0x00000080 /* Pass All Multicast */
45 /* Descriptor bits. */
46 #define R_OWN 0x80000000 /* Own Bit */
47 #define RD_RER 0x02000000 /* Receive End Of Ring */
48 #define RD_LS 0x00000100 /* Last Descriptor */
49 #define RD_ES 0x00008000 /* Error Summary */
50 #define TD_TER 0x02000000 /* Transmit End Of Ring */
51 #define T_OWN 0x80000000 /* Own Bit */
52 #define TD_LS 0x40000000 /* Last Segment */
53 #define TD_FS 0x20000000 /* First Segment */
54 #define TD_ES 0x00008000 /* Error Summary */
55 #define TD_SET 0x08000000 /* Setup Packet */
57 /* The EEPROM commands include the alway-set leading bit. */
58 #define SROM_WRITE_CMD 5
59 #define SROM_READ_CMD 6
60 #define SROM_ERASE_CMD 7
62 #define SROM_HWADD 0x0014 /* Hardware Address offset in SROM */
63 #define SROM_RD 0x00004000 /* Read from Boot ROM */
64 #define EE_DATA_WRITE 0x04 /* EEPROM chip data in. */
65 #define EE_WRITE_0 0x4801
66 #define EE_WRITE_1 0x4805
67 #define EE_DATA_READ 0x08 /* EEPROM chip data out. */
68 #define SROM_SR 0x00000800 /* Select Serial ROM when set */
70 #define DT_IN 0x00000004 /* Serial Data In */
71 #define DT_CLK 0x00000002 /* Serial ROM Clock */
72 #define DT_CS 0x00000001 /* Serial ROM Chip Select */
76 #if defined(CONFIG_DM_ETH)
77 #define phys_to_bus(dev, a) dm_pci_phys_to_mem((dev), (a))
78 #elif defined(CONFIG_E500)
79 #define phys_to_bus(dev, a) (a)
81 #define phys_to_bus(dev, a) pci_phys_to_mem((dev), (a))
84 #define NUM_RX_DESC PKTBUFSRX
85 #define NUM_TX_DESC 1 /* Number of TX descriptors */
86 #define RX_BUFF_SZ PKTSIZE_ALIGN
88 #define TOUT_LOOP 1000000
90 #define SETUP_FRAME_LEN 192
100 struct de4x5_desc rx_ring[NUM_RX_DESC] __aligned(32);
101 struct de4x5_desc tx_ring[NUM_TX_DESC] __aligned(32);
102 int rx_new; /* RX descriptor ring pointer */
103 int tx_new; /* TX descriptor ring pointer */
107 struct udevice *devno;
109 struct eth_device dev;
113 void __iomem *iobase;
117 /* RX and TX descriptor ring */
118 static u32 dc2114x_inl(struct dc2114x_priv *priv, u32 addr)
120 return le32_to_cpu(readl(priv->iobase + addr));
123 static void dc2114x_outl(struct dc2114x_priv *priv, u32 command, u32 addr)
125 writel(cpu_to_le32(command), priv->iobase + addr);
128 static void reset_de4x5(struct dc2114x_priv *priv)
132 i = dc2114x_inl(priv, DE4X5_BMR);
134 dc2114x_outl(priv, i | BMR_SWR, DE4X5_BMR);
136 dc2114x_outl(priv, i, DE4X5_BMR);
139 for (i = 0; i < 5; i++) {
140 dc2114x_inl(priv, DE4X5_BMR);
147 static void start_de4x5(struct dc2114x_priv *priv)
151 omr = dc2114x_inl(priv, DE4X5_OMR);
152 omr |= OMR_ST | OMR_SR;
153 dc2114x_outl(priv, omr, DE4X5_OMR); /* Enable the TX and/or RX */
156 static void stop_de4x5(struct dc2114x_priv *priv)
160 omr = dc2114x_inl(priv, DE4X5_OMR);
161 omr &= ~(OMR_ST | OMR_SR);
162 dc2114x_outl(priv, omr, DE4X5_OMR); /* Disable the TX and/or RX */
165 /* SROM Read and write routines. */
166 static void sendto_srom(struct dc2114x_priv *priv, u_int command, u_long addr)
168 dc2114x_outl(priv, command, addr);
172 static int getfrom_srom(struct dc2114x_priv *priv, u_long addr)
174 u32 tmp = dc2114x_inl(priv, addr);
180 /* Note: this routine returns extra data bits for size detection. */
181 static int do_read_eeprom(struct dc2114x_priv *priv, u_long ioaddr, int location,
184 int read_cmd = location | (SROM_READ_CMD << addr_len);
185 unsigned int retval = 0;
188 sendto_srom(priv, SROM_RD | SROM_SR, ioaddr);
189 sendto_srom(priv, SROM_RD | SROM_SR | DT_CS, ioaddr);
191 debug_cond(SROM_DLEVEL >= 1, " EEPROM read at %d ", location);
193 /* Shift the read command bits out. */
194 for (i = 4 + addr_len; i >= 0; i--) {
195 short dataval = (read_cmd & (1 << i)) ? EE_DATA_WRITE : 0;
197 sendto_srom(priv, SROM_RD | SROM_SR | DT_CS | dataval,
200 sendto_srom(priv, SROM_RD | SROM_SR | DT_CS | dataval | DT_CLK,
203 debug_cond(SROM_DLEVEL >= 2, "%X",
204 getfrom_srom(priv, ioaddr) & 15);
205 retval = (retval << 1) |
206 !!(getfrom_srom(priv, ioaddr) & EE_DATA_READ);
209 sendto_srom(priv, SROM_RD | SROM_SR | DT_CS, ioaddr);
211 debug_cond(SROM_DLEVEL >= 2, " :%X:", getfrom_srom(priv, ioaddr) & 15);
213 for (i = 16; i > 0; i--) {
214 sendto_srom(priv, SROM_RD | SROM_SR | DT_CS | DT_CLK, ioaddr);
216 debug_cond(SROM_DLEVEL >= 2, "%X",
217 getfrom_srom(priv, ioaddr) & 15);
218 retval = (retval << 1) |
219 !!(getfrom_srom(priv, ioaddr) & EE_DATA_READ);
220 sendto_srom(priv, SROM_RD | SROM_SR | DT_CS, ioaddr);
224 /* Terminate the EEPROM access. */
225 sendto_srom(priv, SROM_RD | SROM_SR, ioaddr);
227 debug_cond(SROM_DLEVEL >= 2, " EEPROM value at %d is %5.5x.\n",
234 * This executes a generic EEPROM command, typically a write or write
235 * enable. It returns the data output from the EEPROM, and thus may
236 * also be used for reads.
238 static int do_eeprom_cmd(struct dc2114x_priv *priv, u_long ioaddr, int cmd,
241 unsigned int retval = 0;
243 debug_cond(SROM_DLEVEL >= 1, " EEPROM op 0x%x: ", cmd);
245 sendto_srom(priv, SROM_RD | SROM_SR | DT_CS | DT_CLK, ioaddr);
247 /* Shift the command bits out. */
249 short dataval = (cmd & BIT(cmd_len)) ? EE_WRITE_1 : EE_WRITE_0;
251 sendto_srom(priv, dataval, ioaddr);
254 debug_cond(SROM_DLEVEL >= 2, "%X",
255 getfrom_srom(priv, ioaddr) & 15);
257 sendto_srom(priv, dataval | DT_CLK, ioaddr);
259 retval = (retval << 1) |
260 !!(getfrom_srom(priv, ioaddr) & EE_DATA_READ);
261 } while (--cmd_len >= 0);
263 sendto_srom(priv, SROM_RD | SROM_SR | DT_CS, ioaddr);
265 /* Terminate the EEPROM access. */
266 sendto_srom(priv, SROM_RD | SROM_SR, ioaddr);
268 debug_cond(SROM_DLEVEL >= 1, " EEPROM result is 0x%5.5x.\n", retval);
273 static int read_srom(struct dc2114x_priv *priv, u_long ioaddr, int index)
277 ee_addr_size = (do_read_eeprom(priv, ioaddr, 0xff, 8) & BIT(18)) ? 8 : 6;
279 return do_eeprom_cmd(priv, ioaddr, 0xffff |
280 (((SROM_READ_CMD << ee_addr_size) | index) << 16),
281 3 + ee_addr_size + 16);
284 static void send_setup_frame(struct dc2114x_priv *priv)
286 char setup_frame[SETUP_FRAME_LEN];
287 char *pa = &setup_frame[0];
290 memset(pa, 0xff, SETUP_FRAME_LEN);
292 for (i = 0; i < ETH_ALEN; i++) {
293 *(pa + (i & 1)) = priv->enetaddr[i];
298 for (i = 0; priv->tx_ring[priv->tx_new].status & cpu_to_le32(T_OWN); i++) {
302 printf("%s: tx error buffer not ready\n", priv->name);
306 priv->tx_ring[priv->tx_new].buf = cpu_to_le32(phys_to_bus(priv->devno,
307 (u32)&setup_frame[0]));
308 priv->tx_ring[priv->tx_new].des1 = cpu_to_le32(TD_TER | TD_SET | SETUP_FRAME_LEN);
309 priv->tx_ring[priv->tx_new].status = cpu_to_le32(T_OWN);
311 dc2114x_outl(priv, POLL_DEMAND, DE4X5_TPD);
313 for (i = 0; priv->tx_ring[priv->tx_new].status & cpu_to_le32(T_OWN); i++) {
317 printf("%s: tx buffer not ready\n", priv->name);
321 if (le32_to_cpu(priv->tx_ring[priv->tx_new].status) != 0x7FFFFFFF) {
322 printf("TX error status2 = 0x%08X\n",
323 le32_to_cpu(priv->tx_ring[priv->tx_new].status));
326 priv->tx_new = (priv->tx_new + 1) % NUM_TX_DESC;
329 static int dc21x4x_send_common(struct dc2114x_priv *priv, void *packet, int length)
335 printf("%s: bad packet size: %d\n", priv->name, length);
339 for (i = 0; priv->tx_ring[priv->tx_new].status & cpu_to_le32(T_OWN); i++) {
343 printf("%s: tx error buffer not ready\n", priv->name);
347 priv->tx_ring[priv->tx_new].buf = cpu_to_le32(phys_to_bus(priv->devno,
349 priv->tx_ring[priv->tx_new].des1 = cpu_to_le32(TD_TER | TD_LS | TD_FS | length);
350 priv->tx_ring[priv->tx_new].status = cpu_to_le32(T_OWN);
352 dc2114x_outl(priv, POLL_DEMAND, DE4X5_TPD);
354 for (i = 0; priv->tx_ring[priv->tx_new].status & cpu_to_le32(T_OWN); i++) {
358 printf(".%s: tx buffer not ready\n", priv->name);
362 if (le32_to_cpu(priv->tx_ring[priv->tx_new].status) & TD_ES) {
363 priv->tx_ring[priv->tx_new].status = 0x0;
370 priv->tx_new = (priv->tx_new + 1) % NUM_TX_DESC;
374 static int dc21x4x_recv_check(struct dc2114x_priv *priv)
379 status = le32_to_cpu(priv->rx_ring[priv->rx_new].status);
384 if (status & RD_LS) {
385 /* Valid frame status. */
386 if (status & RD_ES) {
387 /* There was an error. */
388 printf("RX error status = 0x%08X\n", status);
391 /* A valid frame received. */
392 length = (le32_to_cpu(priv->rx_ring[priv->rx_new].status)
402 static int dc21x4x_init_common(struct dc2114x_priv *priv)
408 if (dc2114x_inl(priv, DE4X5_STS) & (STS_TS | STS_RS)) {
409 printf("Error: Cannot reset ethernet controller.\n");
413 dc2114x_outl(priv, OMR_SDP | OMR_PS | OMR_PM, DE4X5_OMR);
415 for (i = 0; i < NUM_RX_DESC; i++) {
416 priv->rx_ring[i].status = cpu_to_le32(R_OWN);
417 priv->rx_ring[i].des1 = cpu_to_le32(RX_BUFF_SZ);
418 priv->rx_ring[i].buf = cpu_to_le32(phys_to_bus(priv->devno,
419 (u32)net_rx_packets[i]));
420 priv->rx_ring[i].next = 0;
423 for (i = 0; i < NUM_TX_DESC; i++) {
424 priv->tx_ring[i].status = 0;
425 priv->tx_ring[i].des1 = 0;
426 priv->tx_ring[i].buf = 0;
427 priv->tx_ring[i].next = 0;
430 priv->rx_ring_size = NUM_RX_DESC;
431 priv->tx_ring_size = NUM_TX_DESC;
433 /* Write the end of list marker to the descriptor lists. */
434 priv->rx_ring[priv->rx_ring_size - 1].des1 |= cpu_to_le32(RD_RER);
435 priv->tx_ring[priv->tx_ring_size - 1].des1 |= cpu_to_le32(TD_TER);
437 /* Tell the adapter where the TX/RX rings are located. */
438 dc2114x_outl(priv, phys_to_bus(priv->devno, (u32)&priv->rx_ring),
440 dc2114x_outl(priv, phys_to_bus(priv->devno, (u32)&priv->tx_ring),
448 send_setup_frame(priv);
453 static void dc21x4x_halt_common(struct dc2114x_priv *priv)
456 dc2114x_outl(priv, 0, DE4X5_SICR);
459 static void read_hw_addr(struct dc2114x_priv *priv)
461 u_short tmp, *p = (u_short *)(&priv->enetaddr[0]);
464 for (i = 0; i < (ETH_ALEN >> 1); i++) {
465 tmp = read_srom(priv, DE4X5_APROM, (SROM_HWADD >> 1) + i);
466 *p = le16_to_cpu(tmp);
470 if (!j || j == 0x2fffd) {
471 memset(priv->enetaddr, 0, ETH_ALEN);
472 debug("Warning: can't read HW address from SROM.\n");
476 static struct pci_device_id supported[] = {
477 { PCI_DEVICE(PCI_VENDOR_ID_DEC, PCI_DEVICE_ID_DEC_TULIP_FAST) },
478 { PCI_DEVICE(PCI_VENDOR_ID_DEC, PCI_DEVICE_ID_DEC_21142) },
482 #ifndef CONFIG_DM_ETH
483 static int dc21x4x_init(struct eth_device *dev, struct bd_info *bis)
485 struct dc2114x_priv *priv =
486 container_of(dev, struct dc2114x_priv, dev);
488 /* Ensure we're not sleeping. */
489 pci_write_config_byte(priv->devno, PCI_CFDA_PSM, WAKEUP);
491 return dc21x4x_init_common(priv);
494 static void dc21x4x_halt(struct eth_device *dev)
496 struct dc2114x_priv *priv =
497 container_of(dev, struct dc2114x_priv, dev);
499 dc21x4x_halt_common(priv);
501 pci_write_config_byte(priv->devno, PCI_CFDA_PSM, SLEEP);
504 static int dc21x4x_send(struct eth_device *dev, void *packet, int length)
506 struct dc2114x_priv *priv =
507 container_of(dev, struct dc2114x_priv, dev);
509 return dc21x4x_send_common(priv, packet, length);
512 static int dc21x4x_recv(struct eth_device *dev)
514 struct dc2114x_priv *priv =
515 container_of(dev, struct dc2114x_priv, dev);
520 ret = dc21x4x_recv_check(priv);
526 /* Pass the packet up to the protocol layers */
527 net_process_received_packet
528 (net_rx_packets[priv->rx_new], length - 4);
532 * Change buffer ownership for this frame,
533 * back to the adapter.
536 priv->rx_ring[priv->rx_new].status = cpu_to_le32(R_OWN);
538 /* Update entry information. */
539 priv->rx_new = (priv->rx_new + 1) % priv->rx_ring_size;
545 int dc21x4x_initialize(struct bd_info *bis)
547 struct dc2114x_priv *priv;
548 struct eth_device *dev;
549 unsigned short status;
557 devbusfn = pci_find_devices(supported, idx++);
561 pci_read_config_word(devbusfn, PCI_COMMAND, &status);
562 status |= PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
563 pci_write_config_word(devbusfn, PCI_COMMAND, status);
565 pci_read_config_word(devbusfn, PCI_COMMAND, &status);
566 if (!(status & PCI_COMMAND_MEMORY)) {
567 printf("Error: Can not enable MEMORY access.\n");
571 if (!(status & PCI_COMMAND_MASTER)) {
572 printf("Error: Can not enable Bus Mastering.\n");
576 /* Check the latency timer for values >= 0x60. */
577 pci_read_config_byte(devbusfn, PCI_LATENCY_TIMER, &timer);
580 pci_write_config_byte(devbusfn, PCI_LATENCY_TIMER,
584 /* read BAR for memory space access */
585 pci_read_config_dword(devbusfn, PCI_BASE_ADDRESS_1, &iobase);
586 iobase &= PCI_BASE_ADDRESS_MEM_MASK;
587 debug("dc21x4x: DEC 21142 PCI Device @0x%x\n", iobase);
589 priv = memalign(32, sizeof(*priv));
591 printf("Can not allocalte memory of dc21x4x\n");
594 memset(priv, 0, sizeof(*priv));
598 sprintf(dev->name, "dc21x4x#%d", card_number);
599 priv->devno = devbusfn;
600 priv->name = dev->name;
601 priv->enetaddr = dev->enetaddr;
603 dev->iobase = pci_mem_to_phys(devbusfn, iobase);
604 dev->priv = (void *)devbusfn;
605 dev->init = dc21x4x_init;
606 dev->halt = dc21x4x_halt;
607 dev->send = dc21x4x_send;
608 dev->recv = dc21x4x_recv;
610 /* Ensure we're not sleeping. */
611 pci_write_config_byte(devbusfn, PCI_CFDA_PSM, WAKEUP);
626 static int dc2114x_start(struct udevice *dev)
628 struct eth_pdata *plat = dev_get_plat(dev);
629 struct dc2114x_priv *priv = dev_get_priv(dev);
631 memcpy(priv->enetaddr, plat->enetaddr, sizeof(plat->enetaddr));
633 /* Ensure we're not sleeping. */
634 dm_pci_write_config8(dev, PCI_CFDA_PSM, WAKEUP);
636 return dc21x4x_init_common(priv);
639 static void dc2114x_stop(struct udevice *dev)
641 struct dc2114x_priv *priv = dev_get_priv(dev);
643 dc21x4x_halt_common(priv);
645 dm_pci_write_config8(dev, PCI_CFDA_PSM, SLEEP);
648 static int dc2114x_send(struct udevice *dev, void *packet, int length)
650 struct dc2114x_priv *priv = dev_get_priv(dev);
653 ret = dc21x4x_send_common(priv, packet, length);
655 return ret ? 0 : -ETIMEDOUT;
658 static int dc2114x_recv(struct udevice *dev, int flags, uchar **packetp)
660 struct dc2114x_priv *priv = dev_get_priv(dev);
663 ret = dc21x4x_recv_check(priv);
666 /* Update entry information. */
667 priv->rx_new = (priv->rx_new + 1) % priv->rx_ring_size;
674 *packetp = net_rx_packets[priv->rx_new];
679 static int dc2114x_free_pkt(struct udevice *dev, uchar *packet, int length)
681 struct dc2114x_priv *priv = dev_get_priv(dev);
683 priv->rx_ring[priv->rx_new].status = cpu_to_le32(R_OWN);
685 /* Update entry information. */
686 priv->rx_new = (priv->rx_new + 1) % priv->rx_ring_size;
691 static int dc2114x_read_rom_hwaddr(struct udevice *dev)
693 struct dc2114x_priv *priv = dev_get_priv(dev);
700 static int dc2114x_bind(struct udevice *dev)
702 static int card_number;
705 sprintf(name, "dc2114x#%u", card_number++);
707 return device_set_name(dev, name);
710 static int dc2114x_probe(struct udevice *dev)
712 struct eth_pdata *plat = dev_get_plat(dev);
713 struct dc2114x_priv *priv = dev_get_priv(dev);
717 dm_pci_read_config32(dev, PCI_BASE_ADDRESS_1, &iobase);
720 debug("dc2114x: DEC 2114x PCI Device @0x%x\n", iobase);
723 priv->enetaddr = plat->enetaddr;
724 priv->iobase = (void __iomem *)dm_pci_mem_to_phys(dev, iobase);
726 command = PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
727 dm_pci_write_config16(dev, PCI_COMMAND, command);
728 dm_pci_read_config16(dev, PCI_COMMAND, &status);
729 if ((status & command) != command) {
730 printf("dc2114x: Couldn't enable IO access or Bus Mastering\n");
734 dm_pci_write_config8(dev, PCI_LATENCY_TIMER, 0x60);
739 static const struct eth_ops dc2114x_ops = {
740 .start = dc2114x_start,
741 .send = dc2114x_send,
742 .recv = dc2114x_recv,
743 .stop = dc2114x_stop,
744 .free_pkt = dc2114x_free_pkt,
745 .read_rom_hwaddr = dc2114x_read_rom_hwaddr,
748 U_BOOT_DRIVER(eth_dc2114x) = {
749 .name = "eth_dc2114x",
751 .bind = dc2114x_bind,
752 .probe = dc2114x_probe,
754 .priv_auto = sizeof(struct dc2114x_priv),
755 .plat_auto = sizeof(struct eth_pdata),
758 U_BOOT_PCI_DEVICE(eth_dc2114x, supported);