2 * 7990.c -- LANCE ethernet IC generic routines.
3 * This is an attempt to separate out the bits of various ethernet
4 * drivers that are common because they all use the AMD 7990 LANCE
5 * (Local Area Network Controller for Ethernet) chip.
7 * Copyright (C) 05/1998 Peter Maydell <pmaydell@chiark.greenend.org.uk>
9 * Most of this stuff was obtained by looking at other LANCE drivers,
10 * in particular a2065.[ch]. The AMD C-LANCE datasheet was also helpful.
11 * NB: this was made easy by the fact that Jes Sorensen had cleaned up
12 * most of a2025 and sunlance with the aim of merging them, so the
13 * common code was pretty obvious.
15 #include <linux/crc32.h>
16 #include <linux/delay.h>
17 #include <linux/errno.h>
18 #include <linux/netdevice.h>
19 #include <linux/etherdevice.h>
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/types.h>
24 #include <linux/fcntl.h>
25 #include <linux/interrupt.h>
26 #include <linux/ioport.h>
28 #include <linux/route.h>
29 #include <linux/string.h>
30 #include <linux/skbuff.h>
32 /* Used for the temporal inet entries and routing */
33 #include <linux/socket.h>
34 #include <linux/bitops.h>
36 #include <asm/system.h>
39 #include <asm/pgtable.h>
41 #include <asm/blinken.h>
46 #define WRITERAP(lp,x) out_be16(lp->base + LANCE_RAP, (x))
47 #define WRITERDP(lp,x) out_be16(lp->base + LANCE_RDP, (x))
48 #define READRDP(lp) in_be16(lp->base + LANCE_RDP)
50 #if defined(CONFIG_HPLANCE) || defined(CONFIG_HPLANCE_MODULE)
57 #if defined(CONFIG_MVME147_NET) || defined(CONFIG_MVME147_NET_MODULE)
59 /* Lossage Factor Nine, Mr Sulu. */
60 #define WRITERAP(lp,x) (lp->writerap(lp,x))
61 #define WRITERDP(lp,x) (lp->writerdp(lp,x))
62 #define READRDP(lp) (lp->readrdp(lp))
66 /* These inlines can be used if only CONFIG_HPLANCE is defined */
67 static inline void WRITERAP(struct lance_private
*lp
, __u16 value
)
70 out_be16(lp
->base
+ HPLANCE_REGOFF
+ LANCE_RAP
, value
);
71 } while ((in_8(lp
->base
+ HPLANCE_STATUS
) & LE_ACK
) == 0);
74 static inline void WRITERDP(struct lance_private
*lp
, __u16 value
)
77 out_be16(lp
->base
+ HPLANCE_REGOFF
+ LANCE_RDP
, value
);
78 } while ((in_8(lp
->base
+ HPLANCE_STATUS
) & LE_ACK
) == 0);
81 static inline __u16
READRDP(struct lance_private
*lp
)
85 value
= in_be16(lp
->base
+ HPLANCE_REGOFF
+ LANCE_RDP
);
86 } while ((in_8(lp
->base
+ HPLANCE_STATUS
) & LE_ACK
) == 0);
91 #endif /* CONFIG_HPLANCE || CONFIG_HPLANCE_MODULE */
93 /* debugging output macros, various flavours */
94 /* #define TEST_HITS */
96 #define PRINT_RINGS() \
99 for (t=0; t < RX_RING_SIZE; t++) { \
100 printk("R%d: @(%02X %04X) len %04X, mblen %04X, bits %02X\n",\
101 t, ib->brx_ring[t].rmd1_hadr, ib->brx_ring[t].rmd0,\
102 ib->brx_ring[t].length,\
103 ib->brx_ring[t].mblength, ib->brx_ring[t].rmd1_bits);\
105 for (t=0; t < TX_RING_SIZE; t++) { \
106 printk("T%d: @(%02X %04X) len %04X, misc %04X, bits %02X\n",\
107 t, ib->btx_ring[t].tmd1_hadr, ib->btx_ring[t].tmd0,\
108 ib->btx_ring[t].length,\
109 ib->btx_ring[t].misc, ib->btx_ring[t].tmd1_bits);\
113 #define PRINT_RINGS()
116 /* Load the CSR registers. The LANCE has to be STOPped when we do this! */
117 static void load_csrs (struct lance_private
*lp
)
119 volatile struct lance_init_block
*aib
= lp
->lance_init_block
;
122 leptr
= LANCE_ADDR (aib
);
124 WRITERAP(lp
, LE_CSR1
); /* load address of init block */
125 WRITERDP(lp
, leptr
& 0xFFFF);
126 WRITERAP(lp
, LE_CSR2
);
127 WRITERDP(lp
, leptr
>> 16);
128 WRITERAP(lp
, LE_CSR3
);
129 WRITERDP(lp
, lp
->busmaster_regval
); /* set byteswap/ALEctrl/byte ctrl */
131 /* Point back to csr0 */
132 WRITERAP(lp
, LE_CSR0
);
135 /* #define to 0 or 1 appropriately */
136 #define DEBUG_IRING 0
137 /* Set up the Lance Rx and Tx rings and the init block */
138 static void lance_init_ring (struct net_device
*dev
)
140 struct lance_private
*lp
= netdev_priv(dev
);
141 volatile struct lance_init_block
*ib
= lp
->init_block
;
142 volatile struct lance_init_block
*aib
; /* for LANCE_ADDR computations */
146 aib
= lp
->lance_init_block
;
148 lp
->rx_new
= lp
->tx_new
= 0;
149 lp
->rx_old
= lp
->tx_old
= 0;
151 ib
->mode
= LE_MO_PROM
; /* normal, enable Tx & Rx */
153 /* Copy the ethernet address to the lance init block
154 * Notice that we do a byteswap if we're big endian.
155 * [I think this is the right criterion; at least, sunlance,
156 * a2065 and atarilance do the byteswap and lance.c (PC) doesn't.
157 * However, the datasheet says that the BSWAP bit doesn't affect
158 * the init block, so surely it should be low byte first for
160 * We could define the ib->physaddr as three 16bit values and
161 * use (addr[1] << 8) | addr[0] & co, but this is more efficient.
164 ib
->phys_addr
[0] = dev
->dev_addr
[1];
165 ib
->phys_addr
[1] = dev
->dev_addr
[0];
166 ib
->phys_addr
[2] = dev
->dev_addr
[3];
167 ib
->phys_addr
[3] = dev
->dev_addr
[2];
168 ib
->phys_addr
[4] = dev
->dev_addr
[5];
169 ib
->phys_addr
[5] = dev
->dev_addr
[4];
172 ib
->phys_addr
[i
] = dev
->dev_addr
[i
];
176 printk ("TX rings:\n");
179 /* Setup the Tx ring entries */
180 for (i
= 0; i
< (1<<lp
->lance_log_tx_bufs
); i
++) {
181 leptr
= LANCE_ADDR(&aib
->tx_buf
[i
][0]);
182 ib
->btx_ring
[i
].tmd0
= leptr
;
183 ib
->btx_ring
[i
].tmd1_hadr
= leptr
>> 16;
184 ib
->btx_ring
[i
].tmd1_bits
= 0;
185 ib
->btx_ring
[i
].length
= 0xf000; /* The ones required by tmd2 */
186 ib
->btx_ring
[i
].misc
= 0;
188 printk ("%d: 0x%8.8x\n", i
, leptr
);
191 /* Setup the Rx ring entries */
193 printk ("RX rings:\n");
194 for (i
= 0; i
< (1<<lp
->lance_log_rx_bufs
); i
++) {
195 leptr
= LANCE_ADDR(&aib
->rx_buf
[i
][0]);
197 ib
->brx_ring
[i
].rmd0
= leptr
;
198 ib
->brx_ring
[i
].rmd1_hadr
= leptr
>> 16;
199 ib
->brx_ring
[i
].rmd1_bits
= LE_R1_OWN
;
200 /* 0xf000 == bits that must be one (reserved, presumably) */
201 ib
->brx_ring
[i
].length
= -RX_BUFF_SIZE
| 0xf000;
202 ib
->brx_ring
[i
].mblength
= 0;
204 printk ("%d: 0x%8.8x\n", i
, leptr
);
207 /* Setup the initialization block */
209 /* Setup rx descriptor pointer */
210 leptr
= LANCE_ADDR(&aib
->brx_ring
);
211 ib
->rx_len
= (lp
->lance_log_rx_bufs
<< 13) | (leptr
>> 16);
214 printk ("RX ptr: %8.8x\n", leptr
);
216 /* Setup tx descriptor pointer */
217 leptr
= LANCE_ADDR(&aib
->btx_ring
);
218 ib
->tx_len
= (lp
->lance_log_tx_bufs
<< 13) | (leptr
>> 16);
221 printk ("TX ptr: %8.8x\n", leptr
);
223 /* Clear the multicast filter */
229 /* LANCE must be STOPped before we do this, too... */
230 static int init_restart_lance (struct lance_private
*lp
)
234 WRITERAP(lp
, LE_CSR0
);
235 WRITERDP(lp
, LE_C0_INIT
);
237 /* Need a hook here for sunlance ledma stuff */
239 /* Wait for the lance to complete initialization */
240 for (i
= 0; (i
< 100) && !(READRDP(lp
) & (LE_C0_ERR
| LE_C0_IDON
)); i
++)
242 if ((i
== 100) || (READRDP(lp
) & LE_C0_ERR
)) {
243 printk ("LANCE unopened after %d ticks, csr0=%4.4x.\n", i
, READRDP(lp
));
247 /* Clear IDON by writing a "1", enable interrupts and start lance */
248 WRITERDP(lp
, LE_C0_IDON
);
249 WRITERDP(lp
, LE_C0_INEA
| LE_C0_STRT
);
254 static int lance_reset (struct net_device
*dev
)
256 struct lance_private
*lp
= netdev_priv(dev
);
260 WRITERAP(lp
, LE_CSR0
);
261 WRITERDP(lp
, LE_C0_STOP
);
264 lance_init_ring (dev
);
265 dev
->trans_start
= jiffies
; /* prevent tx timeout */
266 status
= init_restart_lance (lp
);
268 printk ("Lance restart=%d\n", status
);
273 static int lance_rx (struct net_device
*dev
)
275 struct lance_private
*lp
= netdev_priv(dev
);
276 volatile struct lance_init_block
*ib
= lp
->init_block
;
277 volatile struct lance_rx_desc
*rd
;
285 for (i
= 0; i
< RX_RING_SIZE
; i
++) {
288 ib
->brx_ring
[i
].rmd1_bits
& LE_R1_OWN
? "_" : "X");
291 ib
->brx_ring
[i
].rmd1_bits
& LE_R1_OWN
? "." : "1");
296 blinken_leds(0x40, 0);
298 WRITERDP(lp
, LE_C0_RINT
| LE_C0_INEA
); /* ack Rx int, reenable ints */
299 for (rd
= &ib
->brx_ring
[lp
->rx_new
]; /* For each Rx ring we own... */
300 !((bits
= rd
->rmd1_bits
) & LE_R1_OWN
);
301 rd
= &ib
->brx_ring
[lp
->rx_new
]) {
303 /* We got an incomplete frame? */
304 if ((bits
& LE_R1_POK
) != LE_R1_POK
) {
305 dev
->stats
.rx_over_errors
++;
306 dev
->stats
.rx_errors
++;
308 } else if (bits
& LE_R1_ERR
) {
309 /* Count only the end frame as a rx error,
312 if (bits
& LE_R1_BUF
) dev
->stats
.rx_fifo_errors
++;
313 if (bits
& LE_R1_CRC
) dev
->stats
.rx_crc_errors
++;
314 if (bits
& LE_R1_OFL
) dev
->stats
.rx_over_errors
++;
315 if (bits
& LE_R1_FRA
) dev
->stats
.rx_frame_errors
++;
316 if (bits
& LE_R1_EOP
) dev
->stats
.rx_errors
++;
318 int len
= (rd
->mblength
& 0xfff) - 4;
319 struct sk_buff
*skb
= dev_alloc_skb (len
+2);
322 printk ("%s: Memory squeeze, deferring packet.\n",
324 dev
->stats
.rx_dropped
++;
326 rd
->rmd1_bits
= LE_R1_OWN
;
327 lp
->rx_new
= (lp
->rx_new
+ 1) & lp
->rx_ring_mod_mask
;
331 skb_reserve (skb
, 2); /* 16 byte align */
332 skb_put (skb
, len
); /* make room */
333 skb_copy_to_linear_data(skb
,
334 (unsigned char *)&(ib
->rx_buf
[lp
->rx_new
][0]),
336 skb
->protocol
= eth_type_trans (skb
, dev
);
338 dev
->stats
.rx_packets
++;
339 dev
->stats
.rx_bytes
+= len
;
342 /* Return the packet to the pool */
344 rd
->rmd1_bits
= LE_R1_OWN
;
345 lp
->rx_new
= (lp
->rx_new
+ 1) & lp
->rx_ring_mod_mask
;
350 static int lance_tx (struct net_device
*dev
)
352 struct lance_private
*lp
= netdev_priv(dev
);
353 volatile struct lance_init_block
*ib
= lp
->init_block
;
354 volatile struct lance_tx_desc
*td
;
359 blinken_leds(0x80, 0);
362 WRITERDP(lp
, LE_C0_TINT
| LE_C0_INEA
);
366 for (i
= j
; i
!= lp
->tx_new
; i
= j
) {
367 td
= &ib
->btx_ring
[i
];
369 /* If we hit a packet not owned by us, stop */
370 if (td
->tmd1_bits
& LE_T1_OWN
)
373 if (td
->tmd1_bits
& LE_T1_ERR
) {
376 dev
->stats
.tx_errors
++;
377 if (status
& LE_T3_RTY
) dev
->stats
.tx_aborted_errors
++;
378 if (status
& LE_T3_LCOL
) dev
->stats
.tx_window_errors
++;
380 if (status
& LE_T3_CLOS
) {
381 dev
->stats
.tx_carrier_errors
++;
382 if (lp
->auto_select
) {
383 lp
->tpe
= 1 - lp
->tpe
;
384 printk("%s: Carrier Lost, trying %s\n",
385 dev
->name
, lp
->tpe
?"TPE":"AUI");
387 WRITERAP(lp
, LE_CSR0
);
388 WRITERDP(lp
, LE_C0_STOP
);
389 lance_init_ring (dev
);
391 init_restart_lance (lp
);
396 /* buffer errors and underflows turn off the transmitter */
397 /* Restart the adapter */
398 if (status
& (LE_T3_BUF
|LE_T3_UFL
)) {
399 dev
->stats
.tx_fifo_errors
++;
401 printk ("%s: Tx: ERR_BUF|ERR_UFL, restarting\n",
404 WRITERAP(lp
, LE_CSR0
);
405 WRITERDP(lp
, LE_C0_STOP
);
406 lance_init_ring (dev
);
408 init_restart_lance (lp
);
411 } else if ((td
->tmd1_bits
& LE_T1_POK
) == LE_T1_POK
) {
413 * So we don't count the packet more than once.
415 td
->tmd1_bits
&= ~(LE_T1_POK
);
417 /* One collision before packet was sent. */
418 if (td
->tmd1_bits
& LE_T1_EONE
)
419 dev
->stats
.collisions
++;
421 /* More than one collision, be optimistic. */
422 if (td
->tmd1_bits
& LE_T1_EMORE
)
423 dev
->stats
.collisions
+= 2;
425 dev
->stats
.tx_packets
++;
428 j
= (j
+ 1) & lp
->tx_ring_mod_mask
;
431 WRITERDP(lp
, LE_C0_TINT
| LE_C0_INEA
);
436 lance_interrupt (int irq
, void *dev_id
)
438 struct net_device
*dev
= (struct net_device
*)dev_id
;
439 struct lance_private
*lp
= netdev_priv(dev
);
442 spin_lock (&lp
->devlock
);
444 WRITERAP(lp
, LE_CSR0
); /* LANCE Controller Status */
449 if (!(csr0
& LE_C0_INTR
)) { /* Check if any interrupt has */
450 spin_unlock (&lp
->devlock
);
451 return IRQ_NONE
; /* been generated by the Lance. */
454 /* Acknowledge all the interrupt sources ASAP */
455 WRITERDP(lp
, csr0
& ~(LE_C0_INEA
|LE_C0_TDMD
|LE_C0_STOP
|LE_C0_STRT
|LE_C0_INIT
));
457 if ((csr0
& LE_C0_ERR
)) {
458 /* Clear the error condition */
459 WRITERDP(lp
, LE_C0_BABL
|LE_C0_ERR
|LE_C0_MISS
|LE_C0_INEA
);
462 if (csr0
& LE_C0_RINT
)
465 if (csr0
& LE_C0_TINT
)
468 /* Log misc errors. */
469 if (csr0
& LE_C0_BABL
)
470 dev
->stats
.tx_errors
++; /* Tx babble. */
471 if (csr0
& LE_C0_MISS
)
472 dev
->stats
.rx_errors
++; /* Missed a Rx frame. */
473 if (csr0
& LE_C0_MERR
) {
474 printk("%s: Bus master arbitration failure, status %4.4x.\n",
476 /* Restart the chip. */
477 WRITERDP(lp
, LE_C0_STRT
);
480 if (lp
->tx_full
&& netif_queue_stopped(dev
) && (TX_BUFFS_AVAIL
>= 0)) {
482 netif_wake_queue (dev
);
485 WRITERAP(lp
, LE_CSR0
);
486 WRITERDP(lp
, LE_C0_BABL
|LE_C0_CERR
|LE_C0_MISS
|LE_C0_MERR
|LE_C0_IDON
|LE_C0_INEA
);
488 spin_unlock (&lp
->devlock
);
492 int lance_open (struct net_device
*dev
)
494 struct lance_private
*lp
= netdev_priv(dev
);
497 /* Install the Interrupt handler. Or we could shunt this out to specific drivers? */
498 if (request_irq(lp
->irq
, lance_interrupt
, IRQF_SHARED
, lp
->name
, dev
))
501 res
= lance_reset(dev
);
502 spin_lock_init(&lp
->devlock
);
503 netif_start_queue (dev
);
507 EXPORT_SYMBOL_GPL(lance_open
);
509 int lance_close (struct net_device
*dev
)
511 struct lance_private
*lp
= netdev_priv(dev
);
513 netif_stop_queue (dev
);
516 WRITERAP(lp
, LE_CSR0
);
517 WRITERDP(lp
, LE_C0_STOP
);
519 free_irq(lp
->irq
, dev
);
523 EXPORT_SYMBOL_GPL(lance_close
);
525 void lance_tx_timeout(struct net_device
*dev
)
527 printk("lance_tx_timeout\n");
529 dev
->trans_start
= jiffies
; /* prevent tx timeout */
530 netif_wake_queue (dev
);
532 EXPORT_SYMBOL_GPL(lance_tx_timeout
);
534 int lance_start_xmit (struct sk_buff
*skb
, struct net_device
*dev
)
536 struct lance_private
*lp
= netdev_priv(dev
);
537 volatile struct lance_init_block
*ib
= lp
->init_block
;
538 int entry
, skblen
, len
;
543 return NETDEV_TX_LOCKED
;
545 netif_stop_queue (dev
);
550 /* dump the packet */
554 for (i
= 0; i
< 64; i
++) {
557 printk ("%2.2x ", skb
->data
[i
]);
561 len
= (skblen
<= ETH_ZLEN
) ? ETH_ZLEN
: skblen
;
562 entry
= lp
->tx_new
& lp
->tx_ring_mod_mask
;
563 ib
->btx_ring
[entry
].length
= (-len
) | 0xf000;
564 ib
->btx_ring
[entry
].misc
= 0;
566 if (skb
->len
< ETH_ZLEN
)
567 memset((void *)&ib
->tx_buf
[entry
][0], 0, ETH_ZLEN
);
568 skb_copy_from_linear_data(skb
, (void *)&ib
->tx_buf
[entry
][0], skblen
);
570 /* Now, give the packet to the lance */
571 ib
->btx_ring
[entry
].tmd1_bits
= (LE_T1_POK
|LE_T1_OWN
);
572 lp
->tx_new
= (lp
->tx_new
+1) & lp
->tx_ring_mod_mask
;
575 /* Kick the lance: transmit now */
576 WRITERDP(lp
, LE_C0_INEA
| LE_C0_TDMD
);
579 spin_lock_irqsave (&lp
->devlock
, flags
);
581 netif_start_queue (dev
);
584 spin_unlock_irqrestore (&lp
->devlock
, flags
);
588 EXPORT_SYMBOL_GPL(lance_start_xmit
);
590 /* taken from the depca driver via a2065.c */
591 static void lance_load_multicast (struct net_device
*dev
)
593 struct lance_private
*lp
= netdev_priv(dev
);
594 volatile struct lance_init_block
*ib
= lp
->init_block
;
595 volatile u16
*mcast_table
= (u16
*)&ib
->filter
;
596 struct netdev_hw_addr
*ha
;
600 /* set all multicast bits */
601 if (dev
->flags
& IFF_ALLMULTI
){
602 ib
->filter
[0] = 0xffffffff;
603 ib
->filter
[1] = 0xffffffff;
606 /* clear the multicast filter */
611 netdev_for_each_mc_addr(ha
, dev
) {
614 /* multicast address? */
618 crc
= ether_crc_le(6, addrs
);
620 mcast_table
[crc
>> 4] |= 1 << (crc
& 0xf);
625 void lance_set_multicast (struct net_device
*dev
)
627 struct lance_private
*lp
= netdev_priv(dev
);
628 volatile struct lance_init_block
*ib
= lp
->init_block
;
631 stopped
= netif_queue_stopped(dev
);
633 netif_stop_queue (dev
);
635 while (lp
->tx_old
!= lp
->tx_new
)
638 WRITERAP(lp
, LE_CSR0
);
639 WRITERDP(lp
, LE_C0_STOP
);
640 lance_init_ring (dev
);
642 if (dev
->flags
& IFF_PROMISC
) {
643 ib
->mode
|= LE_MO_PROM
;
645 ib
->mode
&= ~LE_MO_PROM
;
646 lance_load_multicast (dev
);
649 init_restart_lance (lp
);
652 netif_start_queue (dev
);
654 EXPORT_SYMBOL_GPL(lance_set_multicast
);
656 #ifdef CONFIG_NET_POLL_CONTROLLER
657 void lance_poll(struct net_device
*dev
)
659 struct lance_private
*lp
= netdev_priv(dev
);
661 spin_lock (&lp
->devlock
);
662 WRITERAP(lp
, LE_CSR0
);
663 WRITERDP(lp
, LE_C0_STRT
);
664 spin_unlock (&lp
->devlock
);
665 lance_interrupt(dev
->irq
, dev
);
669 MODULE_LICENSE("GPL");