2 * Cirrus Logic EP93xx ethernet MAC / MII driver.
4 * Copyright (C) 2010, 2009
5 * Matthias Kaehlcke <matthias@kaehlcke.net>
7 * Copyright (C) 2004, 2005
8 * Cory T. Tusar, Videon Central, Inc., <ctusar@videon-central.com>
10 * Based on the original eth.[ch] Cirrus Logic EP93xx Rev D. Ethernet Driver,
13 * (C) Copyright 2002 2003
14 * Adam Bezanson, Network Audio Technologies, Inc.
15 * <bezanson@netaudiotech.com>
17 * SPDX-License-Identifier: GPL-2.0+
22 #include <asm/arch/ep93xx.h>
26 #include <linux/types.h>
27 #include "ep93xx_eth.h"
29 #define GET_PRIV(eth_dev) ((struct ep93xx_priv *)(eth_dev)->priv)
30 #define GET_REGS(eth_dev) (GET_PRIV(eth_dev)->regs)
32 /* ep93xx_miiphy ops forward declarations */
33 static int ep93xx_miiphy_read(const char * const dev, unsigned char const addr,
34 unsigned char const reg, unsigned short * const value);
35 static int ep93xx_miiphy_write(const char * const dev, unsigned char const addr,
36 unsigned char const reg, unsigned short const value);
38 #if defined(EP93XX_MAC_DEBUG)
40 * Dump ep93xx_mac values to the terminal.
42 static void dump_dev(struct eth_device *dev)
44 struct ep93xx_priv *priv = GET_PRIV(dev);
47 printf("\ndump_dev()\n");
48 printf(" rx_dq.base %p\n", priv->rx_dq.base);
49 printf(" rx_dq.current %p\n", priv->rx_dq.current);
50 printf(" rx_dq.end %p\n", priv->rx_dq.end);
51 printf(" rx_sq.base %p\n", priv->rx_sq.base);
52 printf(" rx_sq.current %p\n", priv->rx_sq.current);
53 printf(" rx_sq.end %p\n", priv->rx_sq.end);
55 for (i = 0; i < NUMRXDESC; i++)
56 printf(" rx_buffer[%2.d] %p\n", i, NetRxPackets[i]);
58 printf(" tx_dq.base %p\n", priv->tx_dq.base);
59 printf(" tx_dq.current %p\n", priv->tx_dq.current);
60 printf(" tx_dq.end %p\n", priv->tx_dq.end);
61 printf(" tx_sq.base %p\n", priv->tx_sq.base);
62 printf(" tx_sq.current %p\n", priv->tx_sq.current);
63 printf(" tx_sq.end %p\n", priv->tx_sq.end);
67 * Dump all RX status queue entries to the terminal.
69 static void dump_rx_status_queue(struct eth_device *dev)
71 struct ep93xx_priv *priv = GET_PRIV(dev);
74 printf("\ndump_rx_status_queue()\n");
75 printf(" descriptor address word1 word2\n");
76 for (i = 0; i < NUMRXDESC; i++) {
77 printf(" [ %p ] %08X %08X\n",
79 (priv->rx_sq.base + i)->word1,
80 (priv->rx_sq.base + i)->word2);
85 * Dump all RX descriptor queue entries to the terminal.
87 static void dump_rx_descriptor_queue(struct eth_device *dev)
89 struct ep93xx_priv *priv = GET_PRIV(dev);
92 printf("\ndump_rx_descriptor_queue()\n");
93 printf(" descriptor address word1 word2\n");
94 for (i = 0; i < NUMRXDESC; i++) {
95 printf(" [ %p ] %08X %08X\n",
97 (priv->rx_dq.base + i)->word1,
98 (priv->rx_dq.base + i)->word2);
103 * Dump all TX descriptor queue entries to the terminal.
105 static void dump_tx_descriptor_queue(struct eth_device *dev)
107 struct ep93xx_priv *priv = GET_PRIV(dev);
110 printf("\ndump_tx_descriptor_queue()\n");
111 printf(" descriptor address word1 word2\n");
112 for (i = 0; i < NUMTXDESC; i++) {
113 printf(" [ %p ] %08X %08X\n",
114 priv->tx_dq.base + i,
115 (priv->tx_dq.base + i)->word1,
116 (priv->tx_dq.base + i)->word2);
121 * Dump all TX status queue entries to the terminal.
123 static void dump_tx_status_queue(struct eth_device *dev)
125 struct ep93xx_priv *priv = GET_PRIV(dev);
128 printf("\ndump_tx_status_queue()\n");
129 printf(" descriptor address word1\n");
130 for (i = 0; i < NUMTXDESC; i++) {
131 printf(" [ %p ] %08X\n",
132 priv->rx_sq.base + i,
133 (priv->rx_sq.base + i)->word1);
138 #define dump_rx_descriptor_queue(x)
139 #define dump_rx_status_queue(x)
140 #define dump_tx_descriptor_queue(x)
141 #define dump_tx_status_queue(x)
142 #endif /* defined(EP93XX_MAC_DEBUG) */
145 * Reset the EP93xx MAC by twiddling the soft reset bit and spinning until
148 static void ep93xx_mac_reset(struct eth_device *dev)
150 struct mac_regs *mac = GET_REGS(dev);
153 debug("+ep93xx_mac_reset");
155 value = readl(&mac->selfctl);
156 value |= SELFCTL_RESET;
157 writel(value, &mac->selfctl);
159 while (readl(&mac->selfctl) & SELFCTL_RESET)
162 debug("-ep93xx_mac_reset");
165 /* Eth device open */
166 static int ep93xx_eth_open(struct eth_device *dev, bd_t *bd)
168 struct ep93xx_priv *priv = GET_PRIV(dev);
169 struct mac_regs *mac = GET_REGS(dev);
170 uchar *mac_addr = dev->enetaddr;
173 debug("+ep93xx_eth_open");
176 ep93xx_mac_reset(dev);
178 /* Reset the descriptor queues' current and end address values */
179 priv->tx_dq.current = priv->tx_dq.base;
180 priv->tx_dq.end = (priv->tx_dq.base + NUMTXDESC);
182 priv->tx_sq.current = priv->tx_sq.base;
183 priv->tx_sq.end = (priv->tx_sq.base + NUMTXDESC);
185 priv->rx_dq.current = priv->rx_dq.base;
186 priv->rx_dq.end = (priv->rx_dq.base + NUMRXDESC);
188 priv->rx_sq.current = priv->rx_sq.base;
189 priv->rx_sq.end = (priv->rx_sq.base + NUMRXDESC);
192 * Set the transmit descriptor and status queues' base address,
193 * current address, and length registers. Set the maximum frame
194 * length and threshold. Enable the transmit descriptor processor.
196 writel((uint32_t)priv->tx_dq.base, &mac->txdq.badd);
197 writel((uint32_t)priv->tx_dq.base, &mac->txdq.curadd);
198 writel(sizeof(struct tx_descriptor) * NUMTXDESC, &mac->txdq.blen);
200 writel((uint32_t)priv->tx_sq.base, &mac->txstsq.badd);
201 writel((uint32_t)priv->tx_sq.base, &mac->txstsq.curadd);
202 writel(sizeof(struct tx_status) * NUMTXDESC, &mac->txstsq.blen);
204 writel(0x00040000, &mac->txdthrshld);
205 writel(0x00040000, &mac->txststhrshld);
207 writel((TXSTARTMAX << 0) | (PKTSIZE_ALIGN << 16), &mac->maxfrmlen);
208 writel(BMCTL_TXEN, &mac->bmctl);
211 * Set the receive descriptor and status queues' base address,
212 * current address, and length registers. Enable the receive
213 * descriptor processor.
215 writel((uint32_t)priv->rx_dq.base, &mac->rxdq.badd);
216 writel((uint32_t)priv->rx_dq.base, &mac->rxdq.curadd);
217 writel(sizeof(struct rx_descriptor) * NUMRXDESC, &mac->rxdq.blen);
219 writel((uint32_t)priv->rx_sq.base, &mac->rxstsq.badd);
220 writel((uint32_t)priv->rx_sq.base, &mac->rxstsq.curadd);
221 writel(sizeof(struct rx_status) * NUMRXDESC, &mac->rxstsq.blen);
223 writel(0x00040000, &mac->rxdthrshld);
225 writel(BMCTL_RXEN, &mac->bmctl);
227 writel(0x00040000, &mac->rxststhrshld);
229 /* Wait until the receive descriptor processor is active */
230 while (!(readl(&mac->bmsts) & BMSTS_RXACT))
234 * Initialize the RX descriptor queue. Clear the TX descriptor queue.
235 * Clear the RX and TX status queues. Enqueue the RX descriptor and
236 * status entries to the MAC.
238 for (i = 0; i < NUMRXDESC; i++) {
239 /* set buffer address */
240 (priv->rx_dq.base + i)->word1 = (uint32_t)NetRxPackets[i];
242 /* set buffer length, clear buffer index and NSOF */
243 (priv->rx_dq.base + i)->word2 = PKTSIZE_ALIGN;
246 memset(priv->tx_dq.base, 0,
247 (sizeof(struct tx_descriptor) * NUMTXDESC));
248 memset(priv->rx_sq.base, 0,
249 (sizeof(struct rx_status) * NUMRXDESC));
250 memset(priv->tx_sq.base, 0,
251 (sizeof(struct tx_status) * NUMTXDESC));
253 writel(NUMRXDESC, &mac->rxdqenq);
254 writel(NUMRXDESC, &mac->rxstsqenq);
256 /* Set the primary MAC address */
257 writel(AFP_IAPRIMARY, &mac->afp);
258 writel(mac_addr[0] | (mac_addr[1] << 8) |
259 (mac_addr[2] << 16) | (mac_addr[3] << 24),
261 writel(mac_addr[4] | (mac_addr[5] << 8), &mac->indad_upper);
263 /* Turn on RX and TX */
264 writel(RXCTL_IA0 | RXCTL_BA | RXCTL_SRXON |
265 RXCTL_RCRCA | RXCTL_MA, &mac->rxctl);
266 writel(TXCTL_STXON, &mac->txctl);
268 /* Dump data structures if we're debugging */
270 dump_rx_descriptor_queue(dev);
271 dump_rx_status_queue(dev);
272 dump_tx_descriptor_queue(dev);
273 dump_tx_status_queue(dev);
275 debug("-ep93xx_eth_open");
281 * Halt EP93xx MAC transmit and receive by clearing the TxCTL and RxCTL
284 static void ep93xx_eth_close(struct eth_device *dev)
286 struct mac_regs *mac = GET_REGS(dev);
288 debug("+ep93xx_eth_close");
290 writel(0x00000000, &mac->rxctl);
291 writel(0x00000000, &mac->txctl);
293 debug("-ep93xx_eth_close");
297 * Copy a frame of data from the MAC into the protocol layer for further
300 static int ep93xx_eth_rcv_packet(struct eth_device *dev)
302 struct mac_regs *mac = GET_REGS(dev);
303 struct ep93xx_priv *priv = GET_PRIV(dev);
306 debug("+ep93xx_eth_rcv_packet");
308 if (RX_STATUS_RFP(priv->rx_sq.current)) {
309 if (RX_STATUS_RWE(priv->rx_sq.current)) {
311 * We have a good frame. Extract the frame's length
312 * from the current rx_status_queue entry, and copy
313 * the frame's data into NetRxPackets[] of the
314 * protocol stack. We track the total number of
315 * bytes in the frame (nbytes_frame) which will be
316 * used when we pass the data off to the protocol
317 * layer via NetReceive().
319 len = RX_STATUS_FRAME_LEN(priv->rx_sq.current);
321 NetReceive((uchar *)priv->rx_dq.current->word1, len);
323 debug("reporting %d bytes...\n", len);
325 /* Do we have an erroneous packet? */
326 error("packet rx error, status %08X %08X",
327 priv->rx_sq.current->word1,
328 priv->rx_sq.current->word2);
329 dump_rx_descriptor_queue(dev);
330 dump_rx_status_queue(dev);
334 * Clear the associated status queue entry, and
335 * increment our current pointers to the next RX
336 * descriptor and status queue entries (making sure
339 memset((void *)priv->rx_sq.current, 0,
340 sizeof(struct rx_status));
342 priv->rx_sq.current++;
343 if (priv->rx_sq.current >= priv->rx_sq.end)
344 priv->rx_sq.current = priv->rx_sq.base;
346 priv->rx_dq.current++;
347 if (priv->rx_dq.current >= priv->rx_dq.end)
348 priv->rx_dq.current = priv->rx_dq.base;
351 * Finally, return the RX descriptor and status entries
352 * back to the MAC engine, and loop again, checking for
353 * more descriptors to process.
355 writel(1, &mac->rxdqenq);
356 writel(1, &mac->rxstsqenq);
361 debug("-ep93xx_eth_rcv_packet %d", len);
366 * Send a block of data via ethernet.
368 static int ep93xx_eth_send_packet(struct eth_device *dev,
369 void * const packet, int const length)
371 struct mac_regs *mac = GET_REGS(dev);
372 struct ep93xx_priv *priv = GET_PRIV(dev);
375 debug("+ep93xx_eth_send_packet");
377 /* Parameter check */
378 BUG_ON(packet == NULL);
381 * Initialize the TX descriptor queue with the new packet's info.
382 * Clear the associated status queue entry. Enqueue the packet
383 * to the MAC for transmission.
386 /* set buffer address */
387 priv->tx_dq.current->word1 = (uint32_t)packet;
389 /* set buffer length and EOF bit */
390 priv->tx_dq.current->word2 = length | TX_DESC_EOF;
392 /* clear tx status */
393 priv->tx_sq.current->word1 = 0;
395 /* enqueue the TX descriptor */
396 writel(1, &mac->txdqenq);
398 /* wait for the frame to become processed */
399 while (!TX_STATUS_TXFP(priv->tx_sq.current))
402 if (!TX_STATUS_TXWE(priv->tx_sq.current)) {
403 error("packet tx error, status %08X",
404 priv->tx_sq.current->word1);
405 dump_tx_descriptor_queue(dev);
406 dump_tx_status_queue(dev);
408 /* TODO: Add better error handling? */
416 debug("-ep93xx_eth_send_packet %d", ret);
420 #if defined(CONFIG_MII)
421 int ep93xx_miiphy_initialize(bd_t * const bd)
423 miiphy_register("ep93xx_eth0", ep93xx_miiphy_read, ep93xx_miiphy_write);
429 * Initialize the EP93xx MAC. The MAC hardware is reset. Buffers are
430 * allocated, if necessary, for the TX and RX descriptor and status queues,
431 * as well as for received packets. The EP93XX MAC hardware is initialized.
432 * Transmit and receive operations are enabled.
434 int ep93xx_eth_initialize(u8 dev_num, int base_addr)
437 struct eth_device *dev;
438 struct ep93xx_priv *priv;
440 debug("+ep93xx_eth_initialize");
442 priv = malloc(sizeof(*priv));
444 error("malloc() failed");
445 goto eth_init_failed_0;
447 memset(priv, 0, sizeof(*priv));
449 priv->regs = (struct mac_regs *)base_addr;
451 priv->tx_dq.base = calloc(NUMTXDESC,
452 sizeof(struct tx_descriptor));
453 if (priv->tx_dq.base == NULL) {
454 error("calloc() failed");
455 goto eth_init_failed_1;
458 priv->tx_sq.base = calloc(NUMTXDESC,
459 sizeof(struct tx_status));
460 if (priv->tx_sq.base == NULL) {
461 error("calloc() failed");
462 goto eth_init_failed_2;
465 priv->rx_dq.base = calloc(NUMRXDESC,
466 sizeof(struct rx_descriptor));
467 if (priv->rx_dq.base == NULL) {
468 error("calloc() failed");
469 goto eth_init_failed_3;
472 priv->rx_sq.base = calloc(NUMRXDESC,
473 sizeof(struct rx_status));
474 if (priv->rx_sq.base == NULL) {
475 error("calloc() failed");
476 goto eth_init_failed_4;
479 dev = malloc(sizeof *dev);
481 error("malloc() failed");
482 goto eth_init_failed_5;
484 memset(dev, 0, sizeof *dev);
486 dev->iobase = base_addr;
488 dev->init = ep93xx_eth_open;
489 dev->halt = ep93xx_eth_close;
490 dev->send = ep93xx_eth_send_packet;
491 dev->recv = ep93xx_eth_rcv_packet;
493 sprintf(dev->name, "ep93xx_eth-%hu", dev_num);
502 free(priv->rx_sq.base);
506 free(priv->rx_dq.base);
510 free(priv->tx_sq.base);
514 free(priv->tx_dq.base);
525 debug("-ep93xx_eth_initialize %d", ret);
529 #if defined(CONFIG_MII)
532 * Maximum MII address we support
534 #define MII_ADDRESS_MAX 31
537 * Maximum MII register address we support
539 #define MII_REGISTER_MAX 31
542 * Read a 16-bit value from an MII register.
544 static int ep93xx_miiphy_read(const char * const dev, unsigned char const addr,
545 unsigned char const reg, unsigned short * const value)
547 struct mac_regs *mac = (struct mac_regs *)MAC_BASE;
551 debug("+ep93xx_miiphy_read");
553 /* Parameter checks */
555 BUG_ON(addr > MII_ADDRESS_MAX);
556 BUG_ON(reg > MII_REGISTER_MAX);
557 BUG_ON(value == NULL);
560 * Save the current SelfCTL register value. Set MAC to suppress
561 * preamble bits. Wait for any previous MII command to complete
562 * before issuing the new command.
564 self_ctl = readl(&mac->selfctl);
565 #if defined(CONFIG_MII_SUPPRESS_PREAMBLE)
566 writel(self_ctl & ~(1 << 8), &mac->selfctl);
567 #endif /* defined(CONFIG_MII_SUPPRESS_PREAMBLE) */
569 while (readl(&mac->miists) & MIISTS_BUSY)
573 * Issue the MII 'read' command. Wait for the command to complete.
574 * Read the MII data value.
576 writel(MIICMD_OPCODE_READ | ((uint32_t)addr << 5) | (uint32_t)reg,
578 while (readl(&mac->miists) & MIISTS_BUSY)
581 *value = (unsigned short)readl(&mac->miidata);
583 /* Restore the saved SelfCTL value and return. */
584 writel(self_ctl, &mac->selfctl);
589 debug("-ep93xx_miiphy_read");
594 * Write a 16-bit value to an MII register.
596 static int ep93xx_miiphy_write(const char * const dev, unsigned char const addr,
597 unsigned char const reg, unsigned short const value)
599 struct mac_regs *mac = (struct mac_regs *)MAC_BASE;
603 debug("+ep93xx_miiphy_write");
605 /* Parameter checks */
607 BUG_ON(addr > MII_ADDRESS_MAX);
608 BUG_ON(reg > MII_REGISTER_MAX);
611 * Save the current SelfCTL register value. Set MAC to suppress
612 * preamble bits. Wait for any previous MII command to complete
613 * before issuing the new command.
615 self_ctl = readl(&mac->selfctl);
616 #if defined(CONFIG_MII_SUPPRESS_PREAMBLE)
617 writel(self_ctl & ~(1 << 8), &mac->selfctl);
618 #endif /* defined(CONFIG_MII_SUPPRESS_PREAMBLE) */
620 while (readl(&mac->miists) & MIISTS_BUSY)
623 /* Issue the MII 'write' command. Wait for the command to complete. */
624 writel((uint32_t)value, &mac->miidata);
625 writel(MIICMD_OPCODE_WRITE | ((uint32_t)addr << 5) | (uint32_t)reg,
627 while (readl(&mac->miists) & MIISTS_BUSY)
630 /* Restore the saved SelfCTL value and return. */
631 writel(self_ctl, &mac->selfctl);
636 debug("-ep93xx_miiphy_write");
639 #endif /* defined(CONFIG_MII) */