1 // SPDX-License-Identifier: GPL-2.0+
9 #include <linux/bitops.h>
10 #include <linux/delay.h>
17 #define PCI_CFDA_PSM 0x43
19 #define CFRV_RN 0x000000f0 /* Revision Number */
21 #define WAKEUP 0x00 /* Power Saving Wakeup */
22 #define SLEEP 0x80 /* Power Saving Sleep Mode */
24 #define DC2114x_BRK 0x0020 /* CFRV break between DC21142 & DC21143 */
26 /* Ethernet chip registers. */
27 #define DE4X5_BMR 0x000 /* Bus Mode Register */
28 #define DE4X5_TPD 0x008 /* Transmit Poll Demand Reg */
29 #define DE4X5_RRBA 0x018 /* RX Ring Base Address Reg */
30 #define DE4X5_TRBA 0x020 /* TX Ring Base Address Reg */
31 #define DE4X5_STS 0x028 /* Status Register */
32 #define DE4X5_OMR 0x030 /* Operation Mode Register */
33 #define DE4X5_SICR 0x068 /* SIA Connectivity Register */
34 #define DE4X5_APROM 0x048 /* Ethernet Address PROM */
37 #define BMR_SWR 0x00000001 /* Software Reset */
38 #define STS_TS 0x00700000 /* Transmit Process State */
39 #define STS_RS 0x000e0000 /* Receive Process State */
40 #define OMR_ST 0x00002000 /* Start/Stop Transmission Command */
41 #define OMR_SR 0x00000002 /* Start/Stop Receive */
42 #define OMR_PS 0x00040000 /* Port Select */
43 #define OMR_SDP 0x02000000 /* SD Polarity - MUST BE ASSERTED */
44 #define OMR_PM 0x00000080 /* Pass All Multicast */
46 /* Descriptor bits. */
47 #define R_OWN 0x80000000 /* Own Bit */
48 #define RD_RER 0x02000000 /* Receive End Of Ring */
49 #define RD_LS 0x00000100 /* Last Descriptor */
50 #define RD_ES 0x00008000 /* Error Summary */
51 #define TD_TER 0x02000000 /* Transmit End Of Ring */
52 #define T_OWN 0x80000000 /* Own Bit */
53 #define TD_LS 0x40000000 /* Last Segment */
54 #define TD_FS 0x20000000 /* First Segment */
55 #define TD_ES 0x00008000 /* Error Summary */
56 #define TD_SET 0x08000000 /* Setup Packet */
58 /* The EEPROM commands include the alway-set leading bit. */
59 #define SROM_WRITE_CMD 5
60 #define SROM_READ_CMD 6
61 #define SROM_ERASE_CMD 7
63 #define SROM_HWADD 0x0014 /* Hardware Address offset in SROM */
64 #define SROM_RD 0x00004000 /* Read from Boot ROM */
65 #define EE_DATA_WRITE 0x04 /* EEPROM chip data in. */
66 #define EE_WRITE_0 0x4801
67 #define EE_WRITE_1 0x4805
68 #define EE_DATA_READ 0x08 /* EEPROM chip data out. */
69 #define SROM_SR 0x00000800 /* Select Serial ROM when set */
71 #define DT_IN 0x00000004 /* Serial Data In */
72 #define DT_CLK 0x00000002 /* Serial ROM Clock */
73 #define DT_CS 0x00000001 /* Serial ROM Chip Select */
77 #if defined(CONFIG_E500)
78 #define phys_to_bus(a) (a)
80 #define phys_to_bus(a) pci_phys_to_mem((pci_dev_t)dev->priv, a)
83 #define NUM_RX_DESC PKTBUFSRX
84 #define NUM_TX_DESC 1 /* Number of TX descriptors */
85 #define RX_BUFF_SZ PKTSIZE_ALIGN
87 #define TOUT_LOOP 1000000
89 #define SETUP_FRAME_LEN 192
98 /* RX and TX descriptor ring */
99 static struct de4x5_desc rx_ring[NUM_RX_DESC] __aligned(32);
100 static struct de4x5_desc tx_ring[NUM_TX_DESC] __aligned(32);
101 static int rx_new; /* RX descriptor ring pointer */
102 static int tx_new; /* TX descriptor ring pointer */
104 static char rx_ring_size;
105 static char tx_ring_size;
107 static u32 dc2114x_inl(struct eth_device *dev, u32 addr)
109 return le32_to_cpu(*(volatile u32 *)(addr + dev->iobase));
112 static void dc2114x_outl(struct eth_device *dev, u32 command, u32 addr)
114 *(volatile u32 *)(addr + dev->iobase) = cpu_to_le32(command);
117 static void reset_de4x5(struct eth_device *dev)
121 i = dc2114x_inl(dev, DE4X5_BMR);
123 dc2114x_outl(dev, i | BMR_SWR, DE4X5_BMR);
125 dc2114x_outl(dev, i, DE4X5_BMR);
128 for (i = 0; i < 5; i++) {
129 dc2114x_inl(dev, DE4X5_BMR);
136 static void start_de4x5(struct eth_device *dev)
140 omr = dc2114x_inl(dev, DE4X5_OMR);
141 omr |= OMR_ST | OMR_SR;
142 dc2114x_outl(dev, omr, DE4X5_OMR); /* Enable the TX and/or RX */
145 static void stop_de4x5(struct eth_device *dev)
149 omr = dc2114x_inl(dev, DE4X5_OMR);
150 omr &= ~(OMR_ST | OMR_SR);
151 dc2114x_outl(dev, omr, DE4X5_OMR); /* Disable the TX and/or RX */
154 /* SROM Read and write routines. */
155 static void sendto_srom(struct eth_device *dev, u_int command, u_long addr)
157 dc2114x_outl(dev, command, addr);
161 static int getfrom_srom(struct eth_device *dev, u_long addr)
163 u32 tmp = dc2114x_inl(dev, addr);
169 /* Note: this routine returns extra data bits for size detection. */
170 static int do_read_eeprom(struct eth_device *dev, u_long ioaddr, int location,
173 int read_cmd = location | (SROM_READ_CMD << addr_len);
174 unsigned int retval = 0;
177 sendto_srom(dev, SROM_RD | SROM_SR, ioaddr);
178 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS, ioaddr);
180 debug_cond(SROM_DLEVEL >= 1, " EEPROM read at %d ", location);
182 /* Shift the read command bits out. */
183 for (i = 4 + addr_len; i >= 0; i--) {
184 short dataval = (read_cmd & (1 << i)) ? EE_DATA_WRITE : 0;
186 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS | dataval,
189 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS | dataval | DT_CLK,
192 debug_cond(SROM_DLEVEL >= 2, "%X",
193 getfrom_srom(dev, ioaddr) & 15);
194 retval = (retval << 1) |
195 !!(getfrom_srom(dev, ioaddr) & EE_DATA_READ);
198 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS, ioaddr);
200 debug_cond(SROM_DLEVEL >= 2, " :%X:", getfrom_srom(dev, ioaddr) & 15);
202 for (i = 16; i > 0; i--) {
203 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS | DT_CLK, ioaddr);
205 debug_cond(SROM_DLEVEL >= 2, "%X",
206 getfrom_srom(dev, ioaddr) & 15);
207 retval = (retval << 1) |
208 !!(getfrom_srom(dev, ioaddr) & EE_DATA_READ);
209 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS, ioaddr);
213 /* Terminate the EEPROM access. */
214 sendto_srom(dev, SROM_RD | SROM_SR, ioaddr);
216 debug_cond(SROM_DLEVEL >= 2, " EEPROM value at %d is %5.5x.\n",
223 * This executes a generic EEPROM command, typically a write or write
224 * enable. It returns the data output from the EEPROM, and thus may
225 * also be used for reads.
227 static int do_eeprom_cmd(struct eth_device *dev, u_long ioaddr, int cmd,
230 unsigned int retval = 0;
232 debug_cond(SROM_DLEVEL >= 1, " EEPROM op 0x%x: ", cmd);
234 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS | DT_CLK, ioaddr);
236 /* Shift the command bits out. */
238 short dataval = (cmd & BIT(cmd_len)) ? EE_WRITE_1 : EE_WRITE_0;
240 sendto_srom(dev, dataval, ioaddr);
243 debug_cond(SROM_DLEVEL >= 2, "%X",
244 getfrom_srom(dev, ioaddr) & 15);
246 sendto_srom(dev, dataval | DT_CLK, ioaddr);
248 retval = (retval << 1) |
249 !!(getfrom_srom(dev, ioaddr) & EE_DATA_READ);
250 } while (--cmd_len >= 0);
252 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS, ioaddr);
254 /* Terminate the EEPROM access. */
255 sendto_srom(dev, SROM_RD | SROM_SR, ioaddr);
257 debug_cond(SROM_DLEVEL >= 1, " EEPROM result is 0x%5.5x.\n", retval);
262 static int read_srom(struct eth_device *dev, u_long ioaddr, int index)
266 ee_addr_size = (do_read_eeprom(dev, ioaddr, 0xff, 8) & BIT(18)) ? 8 : 6;
268 return do_eeprom_cmd(dev, ioaddr, 0xffff |
269 (((SROM_READ_CMD << ee_addr_size) | index) << 16),
270 3 + ee_addr_size + 16);
274 static int write_srom(struct eth_device *dev, u_long ioaddr, int index,
277 unsigned short newval;
281 ee_addr_size = (do_read_eeprom(dev, ioaddr, 0xff, 8) & BIT(18)) ? 8 : 6;
283 udelay(10 * 1000); /* test-only */
285 debug_cond(SROM_DLEVEL >= 1, "ee_addr_size=%d.\n", ee_addr_size);
286 debug_cond(SROM_DLEVEL >= 1,
287 "Writing new entry 0x%4.4x to offset %d.\n",
290 /* Enable programming modes. */
291 do_eeprom_cmd(dev, ioaddr, 0x4f << (ee_addr_size - 4),
294 /* Do the actual write. */
295 do_eeprom_cmd(dev, ioaddr, new_value |
296 (((SROM_WRITE_CMD << ee_addr_size) | index) << 16),
297 3 + ee_addr_size + 16);
299 /* Poll for write finished. */
300 sendto_srom(dev, SROM_RD | SROM_SR | DT_CS, ioaddr);
301 for (i = 0; i < 10000; i++) { /* Typical 2000 ticks */
302 if (getfrom_srom(dev, ioaddr) & EE_DATA_READ)
306 debug_cond(SROM_DLEVEL >= 1, " Write finished after %d ticks.\n", i);
308 /* Disable programming. */
309 do_eeprom_cmd(dev, ioaddr, (0x40 << (ee_addr_size - 4)),
312 /* And read the result. */
313 newval = do_eeprom_cmd(dev, ioaddr,
314 (((SROM_READ_CMD << ee_addr_size) | index) << 16)
315 | 0xffff, 3 + ee_addr_size + 16);
317 debug_cond(SROM_DLEVEL >= 1, " New value at offset %d is %4.4x.\n",
323 static void update_srom(struct eth_device *dev, bd_t *bis)
325 static unsigned short eeprom[0x40] = {
326 0x140b, 0x6610, 0x0000, 0x0000, /* 00 */
327 0x0000, 0x0000, 0x0000, 0x0000, /* 04 */
328 0x00a3, 0x0103, 0x0000, 0x0000, /* 08 */
329 0x0000, 0x1f00, 0x0000, 0x0000, /* 0c */
330 0x0108, 0x038d, 0x0000, 0x0000, /* 10 */
331 0xe078, 0x0001, 0x0040, 0x0018, /* 14 */
332 0x0000, 0x0000, 0x0000, 0x0000, /* 18 */
333 0x0000, 0x0000, 0x0000, 0x0000, /* 1c */
334 0x0000, 0x0000, 0x0000, 0x0000, /* 20 */
335 0x0000, 0x0000, 0x0000, 0x0000, /* 24 */
336 0x0000, 0x0000, 0x0000, 0x0000, /* 28 */
337 0x0000, 0x0000, 0x0000, 0x0000, /* 2c */
338 0x0000, 0x0000, 0x0000, 0x0000, /* 30 */
339 0x0000, 0x0000, 0x0000, 0x0000, /* 34 */
340 0x0000, 0x0000, 0x0000, 0x0000, /* 38 */
341 0x0000, 0x0000, 0x0000, 0x4e07, /* 3c */
346 /* Ethernet Addr... */
347 if (!eth_env_get_enetaddr("ethaddr", enetaddr))
350 eeprom[0x0a] = (enetaddr[1] << 8) | enetaddr[0];
351 eeprom[0x0b] = (enetaddr[3] << 8) | enetaddr[2];
352 eeprom[0x0c] = (enetaddr[5] << 8) | enetaddr[4];
354 for (i = 0; i < 0x40; i++)
355 write_srom(dev, DE4X5_APROM, i, eeprom[i]);
357 #endif /* UPDATE_SROM */
359 static void send_setup_frame(struct eth_device *dev, bd_t *bis)
361 char setup_frame[SETUP_FRAME_LEN];
362 char *pa = &setup_frame[0];
365 memset(pa, 0xff, SETUP_FRAME_LEN);
367 for (i = 0; i < ETH_ALEN; i++) {
368 *(pa + (i & 1)) = dev->enetaddr[i];
373 for (i = 0; tx_ring[tx_new].status & cpu_to_le32(T_OWN); i++) {
377 printf("%s: tx error buffer not ready\n", dev->name);
381 tx_ring[tx_new].buf = cpu_to_le32(phys_to_bus((u32)&setup_frame[0]));
382 tx_ring[tx_new].des1 = cpu_to_le32(TD_TER | TD_SET | SETUP_FRAME_LEN);
383 tx_ring[tx_new].status = cpu_to_le32(T_OWN);
385 dc2114x_outl(dev, POLL_DEMAND, DE4X5_TPD);
387 for (i = 0; tx_ring[tx_new].status & cpu_to_le32(T_OWN); i++) {
391 printf("%s: tx buffer not ready\n", dev->name);
395 if (le32_to_cpu(tx_ring[tx_new].status) != 0x7FFFFFFF) {
396 printf("TX error status2 = 0x%08X\n",
397 le32_to_cpu(tx_ring[tx_new].status));
400 tx_new = (tx_new + 1) % NUM_TX_DESC;
403 static int dc21x4x_send(struct eth_device *dev, void *packet, int length)
409 printf("%s: bad packet size: %d\n", dev->name, length);
413 for (i = 0; tx_ring[tx_new].status & cpu_to_le32(T_OWN); i++) {
417 printf("%s: tx error buffer not ready\n", dev->name);
421 tx_ring[tx_new].buf = cpu_to_le32(phys_to_bus((u32)packet));
422 tx_ring[tx_new].des1 = cpu_to_le32(TD_TER | TD_LS | TD_FS | length);
423 tx_ring[tx_new].status = cpu_to_le32(T_OWN);
425 dc2114x_outl(dev, POLL_DEMAND, DE4X5_TPD);
427 for (i = 0; tx_ring[tx_new].status & cpu_to_le32(T_OWN); i++) {
431 printf(".%s: tx buffer not ready\n", dev->name);
435 if (le32_to_cpu(tx_ring[tx_new].status) & TD_ES) {
436 tx_ring[tx_new].status = 0x0;
443 tx_new = (tx_new + 1) % NUM_TX_DESC;
447 static int dc21x4x_recv(struct eth_device *dev)
453 status = le32_to_cpu(rx_ring[rx_new].status);
458 if (status & RD_LS) {
459 /* Valid frame status. */
460 if (status & RD_ES) {
461 /* There was an error. */
462 printf("RX error status = 0x%08X\n", status);
464 /* A valid frame received. */
465 length = (le32_to_cpu(rx_ring[rx_new].status)
468 /* Pass the packet up to the protocol layers */
469 net_process_received_packet
470 (net_rx_packets[rx_new], length - 4);
474 * Change buffer ownership for this frame,
475 * back to the adapter.
477 rx_ring[rx_new].status = cpu_to_le32(R_OWN);
480 /* Update entry information. */
481 rx_new = (rx_new + 1) % rx_ring_size;
487 static int dc21x4x_init(struct eth_device *dev, bd_t *bis)
490 int devbusfn = (int)dev->priv;
492 /* Ensure we're not sleeping. */
493 pci_write_config_byte(devbusfn, PCI_CFDA_PSM, WAKEUP);
497 if (dc2114x_inl(dev, DE4X5_STS) & (STS_TS | STS_RS)) {
498 printf("Error: Cannot reset ethernet controller.\n");
502 dc2114x_outl(dev, OMR_SDP | OMR_PS | OMR_PM, DE4X5_OMR);
504 for (i = 0; i < NUM_RX_DESC; i++) {
505 rx_ring[i].status = cpu_to_le32(R_OWN);
506 rx_ring[i].des1 = cpu_to_le32(RX_BUFF_SZ);
508 cpu_to_le32(phys_to_bus((u32)net_rx_packets[i]));
512 for (i = 0; i < NUM_TX_DESC; i++) {
513 tx_ring[i].status = 0;
519 rx_ring_size = NUM_RX_DESC;
520 tx_ring_size = NUM_TX_DESC;
522 /* Write the end of list marker to the descriptor lists. */
523 rx_ring[rx_ring_size - 1].des1 |= cpu_to_le32(RD_RER);
524 tx_ring[tx_ring_size - 1].des1 |= cpu_to_le32(TD_TER);
526 /* Tell the adapter where the TX/RX rings are located. */
527 dc2114x_outl(dev, phys_to_bus((u32)&rx_ring), DE4X5_RRBA);
528 dc2114x_outl(dev, phys_to_bus((u32)&tx_ring), DE4X5_TRBA);
535 send_setup_frame(dev, bis);
540 static void dc21x4x_halt(struct eth_device *dev)
542 int devbusfn = (int)dev->priv;
545 dc2114x_outl(dev, 0, DE4X5_SICR);
547 pci_write_config_byte(devbusfn, PCI_CFDA_PSM, SLEEP);
550 static void read_hw_addr(struct eth_device *dev, bd_t *bis)
552 u_short tmp, *p = (u_short *)(&dev->enetaddr[0]);
555 for (i = 0; i < (ETH_ALEN >> 1); i++) {
556 tmp = read_srom(dev, DE4X5_APROM, (SROM_HWADD >> 1) + i);
557 *p = le16_to_cpu(tmp);
561 if (!j || j == 0x2fffd) {
562 memset(dev->enetaddr, 0, ETH_ALEN);
563 debug("Warning: can't read HW address from SROM.\n");
565 update_srom(dev, bis);
570 static struct pci_device_id supported[] = {
571 { PCI_VENDOR_ID_DEC, PCI_DEVICE_ID_DEC_TULIP_FAST },
572 { PCI_VENDOR_ID_DEC, PCI_DEVICE_ID_DEC_21142 },
576 int dc21x4x_initialize(bd_t *bis)
578 struct eth_device *dev;
579 unsigned short status;
588 devbusfn = pci_find_devices(supported, idx++);
592 /* Get the chip configuration revision register. */
593 pci_read_config_dword(devbusfn, PCI_REVISION_ID, &cfrv);
595 if ((cfrv & CFRV_RN) < DC2114x_BRK) {
596 printf("Error: The chip is not DC21143.\n");
600 pci_read_config_word(devbusfn, PCI_COMMAND, &status);
601 status |= PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
602 pci_write_config_word(devbusfn, PCI_COMMAND, status);
604 pci_read_config_word(devbusfn, PCI_COMMAND, &status);
605 if (!(status & PCI_COMMAND_MEMORY)) {
606 printf("Error: Can not enable MEMORY access.\n");
610 if (!(status & PCI_COMMAND_MASTER)) {
611 printf("Error: Can not enable Bus Mastering.\n");
615 /* Check the latency timer for values >= 0x60. */
616 pci_read_config_byte(devbusfn, PCI_LATENCY_TIMER, &timer);
619 pci_write_config_byte(devbusfn, PCI_LATENCY_TIMER,
623 /* read BAR for memory space access */
624 pci_read_config_dword(devbusfn, PCI_BASE_ADDRESS_1, &iobase);
625 iobase &= PCI_BASE_ADDRESS_MEM_MASK;
626 debug("dc21x4x: DEC 21142 PCI Device @0x%x\n", iobase);
628 dev = (struct eth_device *)malloc(sizeof(*dev));
630 printf("Can not allocalte memory of dc21x4x\n");
634 memset(dev, 0, sizeof(*dev));
636 sprintf(dev->name, "dc21x4x#%d", card_number);
638 dev->iobase = pci_mem_to_phys(devbusfn, iobase);
639 dev->priv = (void *)devbusfn;
640 dev->init = dc21x4x_init;
641 dev->halt = dc21x4x_halt;
642 dev->send = dc21x4x_send;
643 dev->recv = dc21x4x_recv;
645 /* Ensure we're not sleeping. */
646 pci_write_config_byte(devbusfn, PCI_CFDA_PSM, WAKEUP);
650 read_hw_addr(dev, bis);