1 /* Advanced Micro Devices Inc. AMD8111E Linux Network Driver
2 * Copyright (C) 2004 Advanced Micro Devices
3 * Copyright (C) 2005 Liu Tao <liutao1980@gmail.com> [etherboot port]
5 * Copyright 2001,2002 Jeff Garzik <jgarzik@mandrakesoft.com> [ 8139cp.c,tg3.c ]
6 * Copyright (C) 2001, 2002 David S. Miller (davem@redhat.com)[ tg3.c]
7 * Copyright 1996-1999 Thomas Bogendoerfer [ pcnet32.c ]
8 * Derived from the lance driver written 1993,1994,1995 by Donald Becker.
9 * Copyright 1993 United States Government as represented by the
10 * Director, National Security Agency.[ pcnet32.c ]
11 * Carsten Langgaard, carstenl@mips.com [ pcnet32.c ]
12 * Copyright (C) 2000 MIPS Technologies, Inc. All rights reserved.
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
32 FILE_LICENCE ( GPL2_OR_LATER );
34 #include "etherboot.h"
38 #include <ipxe/ethernet.h>
44 /* driver definitions */
45 #define NUM_TX_SLOTS 2
46 #define NUM_RX_SLOTS 4
47 #define TX_SLOTS_MASK 1
48 #define RX_SLOTS_MASK 3
50 #define TX_BUF_LEN 1536
51 #define RX_BUF_LEN 1536
53 #define TX_PKT_LEN_MAX (ETH_FRAME_LEN - ETH_HLEN)
54 #define RX_PKT_LEN_MIN 60
55 #define RX_PKT_LEN_MAX ETH_FRAME_LEN
57 #define TX_TIMEOUT 3000
58 #define TX_PROCESS_TIME 10
59 #define TX_RETRY (TX_TIMEOUT / TX_PROCESS_TIME)
61 #define PHY_RW_RETRY 10
64 struct amd8111e_tx_desc {
73 struct amd8111e_rx_desc {
83 u8 dst_addr[ETH_ALEN];
84 u8 src_addr[ETH_ALEN];
86 u8 data[ETH_FRAME_LEN - ETH_HLEN];
87 } __attribute__((packed));
89 struct amd8111e_priv {
90 struct amd8111e_tx_desc tx_ring[NUM_TX_SLOTS];
91 struct amd8111e_rx_desc rx_ring[NUM_RX_SLOTS];
92 unsigned char tx_buf[NUM_TX_SLOTS][TX_BUF_LEN];
93 unsigned char rx_buf[NUM_RX_SLOTS][RX_BUF_LEN];
94 unsigned long tx_idx, rx_idx;
104 struct pci_device *pdev;
109 static struct amd8111e_priv amd8111e;
112 /********************************************************
114 ********************************************************/
115 static void amd8111e_init_hw_default(struct amd8111e_priv *lp);
116 static int amd8111e_start(struct amd8111e_priv *lp);
117 static int amd8111e_read_phy(struct amd8111e_priv *lp, int phy_addr, int reg, u32 *val);
119 static int amd8111e_write_phy(struct amd8111e_priv *lp, int phy_addr, int reg, u32 val);
121 static void amd8111e_probe_ext_phy(struct amd8111e_priv *lp);
122 static void amd8111e_disable_interrupt(struct amd8111e_priv *lp);
123 static void amd8111e_enable_interrupt(struct amd8111e_priv *lp);
124 static void amd8111e_force_interrupt(struct amd8111e_priv *lp);
125 static int amd8111e_get_mac_address(struct amd8111e_priv *lp);
126 static int amd8111e_init_rx_ring(struct amd8111e_priv *lp);
127 static int amd8111e_init_tx_ring(struct amd8111e_priv *lp);
128 static int amd8111e_wait_tx_ring(struct amd8111e_priv *lp, unsigned int index);
129 static void amd8111e_wait_link(struct amd8111e_priv *lp);
130 static void amd8111e_poll_link(struct amd8111e_priv *lp);
131 static void amd8111e_restart(struct amd8111e_priv *lp);
135 * This function clears necessary the device registers.
137 static void amd8111e_init_hw_default(struct amd8111e_priv *lp)
139 unsigned int reg_val;
140 void *mmio = lp->mmio;
143 writel(RUN, mmio + CMD0);
145 /* Clear RCV_RING_BASE_ADDR */
146 writel(0, mmio + RCV_RING_BASE_ADDR0);
148 /* Clear XMT_RING_BASE_ADDR */
149 writel(0, mmio + XMT_RING_BASE_ADDR0);
150 writel(0, mmio + XMT_RING_BASE_ADDR1);
151 writel(0, mmio + XMT_RING_BASE_ADDR2);
152 writel(0, mmio + XMT_RING_BASE_ADDR3);
155 writel(CMD0_CLEAR, mmio + CMD0);
158 writel(CMD2_CLEAR, mmio + CMD2);
161 writel(CMD7_CLEAR, mmio + CMD7);
163 /* Clear DLY_INT_A and DLY_INT_B */
164 writel(0x0, mmio + DLY_INT_A);
165 writel(0x0, mmio + DLY_INT_B);
167 /* Clear FLOW_CONTROL */
168 writel(0x0, mmio + FLOW_CONTROL);
170 /* Clear INT0 write 1 to clear register */
171 reg_val = readl(mmio + INT0);
172 writel(reg_val, mmio + INT0);
175 writel(0x0, mmio + STVAL);
178 writel(INTEN0_CLEAR, mmio + INTEN0);
181 writel(0x0, mmio + LADRF);
183 /* Set SRAM_SIZE & SRAM_BOUNDARY registers */
184 writel(0x80010, mmio + SRAM_SIZE);
186 /* Clear RCV_RING0_LEN */
187 writel(0x0, mmio + RCV_RING_LEN0);
189 /* Clear XMT_RING0/1/2/3_LEN */
190 writel(0x0, mmio + XMT_RING_LEN0);
191 writel(0x0, mmio + XMT_RING_LEN1);
192 writel(0x0, mmio + XMT_RING_LEN2);
193 writel(0x0, mmio + XMT_RING_LEN3);
195 /* Clear XMT_RING_LIMIT */
196 writel(0x0, mmio + XMT_RING_LIMIT);
199 writew(MIB_CLEAR, mmio + MIB_ADDR);
202 writel( 0, mmio + LADRF);
203 writel( 0, mmio + LADRF + 4);
205 /* SRAM_SIZE register */
206 reg_val = readl(mmio + SRAM_SIZE);
208 /* Set default value to CTRL1 Register */
209 writel(CTRL1_DEFAULT, mmio + CTRL1);
211 /* To avoid PCI posting bug */
216 * This function initializes the device registers and starts the device.
218 static int amd8111e_start(struct amd8111e_priv *lp)
220 struct nic *nic = lp->nic;
221 void *mmio = lp->mmio;
225 writel(RUN, mmio + CMD0);
227 /* AUTOPOLL0 Register *//*TBD default value is 8100 in FPS */
228 writew(0x8100 | lp->ext_phy_addr, mmio + AUTOPOLL0);
230 /* enable the port manager and set auto negotiation always */
231 writel(VAL1 | EN_PMGR, mmio + CMD3 );
232 writel(XPHYANE | XPHYRST, mmio + CTRL2);
234 /* set control registers */
235 reg_val = readl(mmio + CTRL1);
236 reg_val &= ~XMTSP_MASK;
237 writel(reg_val | XMTSP_128 | CACHE_ALIGN, mmio + CTRL1);
239 /* initialize tx and rx ring base addresses */
240 amd8111e_init_tx_ring(lp);
241 amd8111e_init_rx_ring(lp);
242 writel(virt_to_bus(lp->tx_ring), mmio + XMT_RING_BASE_ADDR0);
243 writel(virt_to_bus(lp->rx_ring), mmio + RCV_RING_BASE_ADDR0);
244 writew(NUM_TX_SLOTS, mmio + XMT_RING_LEN0);
245 writew(NUM_RX_SLOTS, mmio + RCV_RING_LEN0);
247 /* set default IPG to 96 */
248 writew(DEFAULT_IPG, mmio + IPG);
249 writew(DEFAULT_IPG - IFS1_DELTA, mmio + IFS1);
251 /* AutoPAD transmit, Retransmit on Underflow */
252 writel(VAL0 | APAD_XMT | REX_RTRY | REX_UFLO, mmio + CMD2);
255 writel(JUMBO, mmio + CMD3);
257 /* Setting the MAC address to the device */
258 for(i = 0; i < ETH_ALEN; i++)
259 writeb(nic->node_addr[i], mmio + PADR + i);
261 /* set RUN bit to start the chip, interrupt not enabled */
262 writel(VAL2 | RDMD0 | VAL0 | RUN, mmio + CMD0);
264 /* To avoid PCI posting bug */
270 This function will read the PHY registers.
272 static int amd8111e_read_phy(struct amd8111e_priv *lp, int phy_addr, int reg, u32 *val)
274 void *mmio = lp->mmio;
275 unsigned int reg_val;
276 unsigned int retry = PHY_RW_RETRY;
278 reg_val = readl(mmio + PHY_ACCESS);
279 while (reg_val & PHY_CMD_ACTIVE)
280 reg_val = readl(mmio + PHY_ACCESS);
282 writel(PHY_RD_CMD | ((phy_addr & 0x1f) << 21) | ((reg & 0x1f) << 16),
285 reg_val = readl(mmio + PHY_ACCESS);
286 udelay(30); /* It takes 30 us to read/write data */
287 } while (--retry && (reg_val & PHY_CMD_ACTIVE));
289 if (reg_val & PHY_RD_ERR) {
294 *val = reg_val & 0xffff;
299 This function will write into PHY registers.
302 static int amd8111e_write_phy(struct amd8111e_priv *lp, int phy_addr, int reg, u32 val)
304 void *mmio = lp->mmio;
305 unsigned int reg_val;
306 unsigned int retry = PHY_RW_RETRY;
308 reg_val = readl(mmio + PHY_ACCESS);
309 while (reg_val & PHY_CMD_ACTIVE)
310 reg_val = readl(mmio + PHY_ACCESS);
312 writel(PHY_WR_CMD | ((phy_addr & 0x1f) << 21) | ((reg & 0x1f) << 16) | val,
315 reg_val = readl(mmio + PHY_ACCESS);
316 udelay(30); /* It takes 30 us to read/write the data */
317 } while (--retry && (reg_val & PHY_CMD_ACTIVE));
319 if(reg_val & PHY_RD_ERR)
326 static void amd8111e_probe_ext_phy(struct amd8111e_priv *lp)
331 lp->ext_phy_addr = 1;
333 for (i = 0x1e; i >= 0; i--) {
336 if (amd8111e_read_phy(lp, i, MII_PHYSID1, &id1))
338 if (amd8111e_read_phy(lp, i, MII_PHYSID2, &id2))
340 lp->ext_phy_id = (id1 << 16) | id2;
341 lp->ext_phy_addr = i;
346 printf("Found MII PHY ID 0x%08x at address 0x%02x\n",
347 (unsigned int) lp->ext_phy_id, lp->ext_phy_addr);
349 printf("Couldn't detect MII PHY, assuming address 0x01\n");
352 static void amd8111e_disable_interrupt(struct amd8111e_priv *lp)
354 void *mmio = lp->mmio;
357 writel(INTREN, mmio + CMD0);
358 writel(INTEN0_CLEAR, mmio + INTEN0);
359 int0 = readl(mmio + INT0);
360 writel(int0, mmio + INT0);
364 static void amd8111e_enable_interrupt(struct amd8111e_priv *lp)
366 void *mmio = lp->mmio;
368 writel(VAL3 | LCINTEN | VAL1 | TINTEN0 | VAL0 | RINTEN0, mmio + INTEN0);
369 writel(VAL0 | INTREN, mmio + CMD0);
373 static void amd8111e_force_interrupt(struct amd8111e_priv *lp)
375 void *mmio = lp->mmio;
377 writel(VAL0 | UINTCMD, mmio + CMD0);
381 static int amd8111e_get_mac_address(struct amd8111e_priv *lp)
383 struct nic *nic = lp->nic;
384 void *mmio = lp->mmio;
387 /* BIOS should have set mac address to PADR register,
388 * so we read PADR to get it.
390 for (i = 0; i < ETH_ALEN; i++)
391 nic->node_addr[i] = readb(mmio + PADR + i);
393 DBG ( "Ethernet addr: %s\n", eth_ntoa ( nic->node_addr ) );
398 static int amd8111e_init_rx_ring(struct amd8111e_priv *lp)
404 /* Initilaizing receive descriptors */
405 for (i = 0; i < NUM_RX_SLOTS; i++) {
406 lp->rx_ring[i].buf_phy_addr = cpu_to_le32(virt_to_bus(lp->rx_buf[i]));
407 lp->rx_ring[i].buf_len = cpu_to_le16(RX_BUF_LEN);
409 lp->rx_ring[i].rx_flags = cpu_to_le16(OWN_BIT);
415 static int amd8111e_init_tx_ring(struct amd8111e_priv *lp)
420 lp->tx_consistent = 1;
422 /* Initializing transmit descriptors */
423 for (i = 0; i < NUM_TX_SLOTS; i++) {
424 lp->tx_ring[i].tx_flags = 0;
425 lp->tx_ring[i].buf_phy_addr = 0;
426 lp->tx_ring[i].buf_len = 0;
432 static int amd8111e_wait_tx_ring(struct amd8111e_priv *lp, unsigned int index)
435 int retry = TX_RETRY;
437 status = le16_to_cpu(lp->tx_ring[index].tx_flags);
438 while (--retry && (status & OWN_BIT)) {
439 mdelay(TX_PROCESS_TIME);
440 status = le16_to_cpu(lp->tx_ring[index].tx_flags);
442 if (status & OWN_BIT) {
443 printf("Error: tx slot %d timeout, stat = 0x%x\n", index, status);
444 amd8111e_restart(lp);
451 static void amd8111e_wait_link(struct amd8111e_priv *lp)
457 /* read phy to update STAT0 register */
458 amd8111e_read_phy(lp, lp->ext_phy_addr, MII_BMCR, ®_val);
459 amd8111e_read_phy(lp, lp->ext_phy_addr, MII_BMSR, ®_val);
460 amd8111e_read_phy(lp, lp->ext_phy_addr, MII_ADVERTISE, ®_val);
461 amd8111e_read_phy(lp, lp->ext_phy_addr, MII_LPA, ®_val);
462 status = readl(lp->mmio + STAT0);
463 } while (!(status & AUTONEG_COMPLETE) || !(status & LINK_STATS));
466 static void amd8111e_poll_link(struct amd8111e_priv *lp)
468 unsigned int status, speed;
472 /* read phy to update STAT0 register */
473 amd8111e_read_phy(lp, lp->ext_phy_addr, MII_BMCR, ®_val);
474 amd8111e_read_phy(lp, lp->ext_phy_addr, MII_BMSR, ®_val);
475 amd8111e_read_phy(lp, lp->ext_phy_addr, MII_ADVERTISE, ®_val);
476 amd8111e_read_phy(lp, lp->ext_phy_addr, MII_LPA, ®_val);
477 status = readl(lp->mmio + STAT0);
479 if (status & LINK_STATS) {
481 speed = (status & SPEED_MASK) >> 7;
482 if (speed == PHY_SPEED_100)
486 if (status & FULL_DPLX)
491 printf("Link is up: %s Mbps %s duplex\n",
492 lp->speed ? "100" : "10", lp->duplex ? "full" : "half");
495 status = readl(lp->mmio + STAT0);
496 if (!(status & LINK_STATS)) {
498 printf("Link is down\n");
503 static void amd8111e_restart(struct amd8111e_priv *lp)
505 printf("\nStarting nic...\n");
506 amd8111e_disable_interrupt(lp);
507 amd8111e_init_hw_default(lp);
508 amd8111e_probe_ext_phy(lp);
509 amd8111e_get_mac_address(lp);
512 printf("Waiting link up...\n");
514 amd8111e_wait_link(lp);
515 amd8111e_poll_link(lp);
519 /********************************************************
520 * Interface Functions *
521 ********************************************************/
523 static void amd8111e_transmit(struct nic *nic, const char *dst_addr,
524 unsigned int type, unsigned int size, const char *packet)
526 struct amd8111e_priv *lp = nic->priv_data;
527 struct eth_frame *frame;
530 /* check packet size */
531 if (size > TX_PKT_LEN_MAX) {
532 printf("amd8111e_transmit(): too large packet, drop\n");
538 if (amd8111e_wait_tx_ring(lp, index))
542 frame = (struct eth_frame *)lp->tx_buf[index];
543 memset(frame->data, 0, TX_PKT_LEN_MAX);
544 memcpy(frame->dst_addr, dst_addr, ETH_ALEN);
545 memcpy(frame->src_addr, nic->node_addr, ETH_ALEN);
546 frame->type = htons(type);
547 memcpy(frame->data, packet, size);
550 lp->tx_ring[index].buf_len = cpu_to_le16(ETH_HLEN + size);
551 lp->tx_ring[index].buf_phy_addr = cpu_to_le32(virt_to_bus(frame));
553 lp->tx_ring[index].tx_flags =
554 cpu_to_le16(OWN_BIT | STP_BIT | ENP_BIT | ADD_FCS_BIT | LTINT_BIT);
555 writel(VAL1 | TDMD0, lp->mmio + CMD0);
556 readl(lp->mmio + CMD0);
558 /* update slot pointer */
559 lp->tx_idx = (lp->tx_idx + 1) & TX_SLOTS_MASK;
562 static int amd8111e_poll(struct nic *nic, int retrieve)
564 /* return true if there's an ethernet packet ready to read */
565 /* nic->packet should contain data on return */
566 /* nic->packetlen should contain length of data */
568 struct amd8111e_priv *lp = nic->priv_data;
570 unsigned int index, pkt_ok;
572 amd8111e_poll_link(lp);
575 status = le16_to_cpu(lp->rx_ring[index].rx_flags);
576 pkt_len = le16_to_cpu(lp->rx_ring[index].msg_len) - 4; /* remove 4bytes FCS */
578 if (status & OWN_BIT)
581 if (status & ERR_BIT)
583 else if (!(status & STP_BIT))
585 else if (!(status & ENP_BIT))
587 else if (pkt_len < RX_PKT_LEN_MIN)
589 else if (pkt_len > RX_PKT_LEN_MAX)
597 nic->packetlen = pkt_len;
598 memcpy(nic->packet, lp->rx_buf[index], nic->packetlen);
601 lp->rx_ring[index].buf_phy_addr = cpu_to_le32(virt_to_bus(lp->rx_buf[index]));
602 lp->rx_ring[index].buf_len = cpu_to_le16(RX_BUF_LEN);
604 lp->rx_ring[index].rx_flags = cpu_to_le16(OWN_BIT);
605 writel(VAL2 | RDMD0, lp->mmio + CMD0);
606 readl(lp->mmio + CMD0);
608 lp->rx_idx = (lp->rx_idx + 1) & RX_SLOTS_MASK;
612 static void amd8111e_disable(struct nic *nic)
614 struct amd8111e_priv *lp = nic->priv_data;
616 /* disable interrupt */
617 amd8111e_disable_interrupt(lp);
620 amd8111e_init_hw_default(lp);
629 static void amd8111e_irq(struct nic *nic, irq_action_t action)
631 struct amd8111e_priv *lp = nic->priv_data;
635 amd8111e_disable_interrupt(lp);
638 amd8111e_enable_interrupt(lp);
641 amd8111e_force_interrupt(lp);
646 static struct nic_operations amd8111e_operations = {
647 .connect = dummy_connect,
648 .poll = amd8111e_poll,
649 .transmit = amd8111e_transmit,
653 static int amd8111e_probe(struct nic *nic, struct pci_device *pdev)
655 struct amd8111e_priv *lp = &amd8111e;
656 unsigned long mmio_start, mmio_len;
658 nic->ioaddr = pdev->ioaddr;
659 nic->irqno = pdev->irq;
661 mmio_start = pci_bar_start(pdev, PCI_BASE_ADDRESS_0);
662 mmio_len = pci_bar_size(pdev, PCI_BASE_ADDRESS_0);
664 memset(lp, 0, sizeof(*lp));
667 lp->mmio = ioremap(mmio_start, mmio_len);
669 adjust_pci_device(pdev);
673 amd8111e_restart(lp);
675 nic->nic_op = &amd8111e_operations;
679 static struct pci_device_id amd8111e_nics[] = {
680 PCI_ROM(0x1022, 0x7462, "amd8111e", "AMD8111E", 0),
683 PCI_DRIVER ( amd8111e_driver, amd8111e_nics, PCI_NO_CLASS );
685 DRIVER ( "AMD8111E", nic_driver, pci_driver, amd8111e_driver,
686 amd8111e_probe, amd8111e_disable );