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/slab.h>
30 #include <linux/string.h>
31 #include <linux/skbuff.h>
33 /* Used for the temporal inet entries and routing */
34 #include <linux/socket.h>
35 #include <linux/bitops.h>
37 #include <asm/system.h>
40 #include <asm/pgtable.h>
42 #include <asm/blinken.h>
47 #define WRITERAP(lp,x) out_be16(lp->base + LANCE_RAP, (x))
48 #define WRITERDP(lp,x) out_be16(lp->base + LANCE_RDP, (x))
49 #define READRDP(lp) in_be16(lp->base + LANCE_RDP)
51 #if defined(CONFIG_HPLANCE) || defined(CONFIG_HPLANCE_MODULE)
58 #if defined(CONFIG_MVME147_NET) || defined(CONFIG_MVME147_NET_MODULE)
60 /* Lossage Factor Nine, Mr Sulu. */
61 #define WRITERAP(lp,x) (lp->writerap(lp,x))
62 #define WRITERDP(lp,x) (lp->writerdp(lp,x))
63 #define READRDP(lp) (lp->readrdp(lp))
67 /* These inlines can be used if only CONFIG_HPLANCE is defined */
68 static inline void WRITERAP(struct lance_private
*lp
, __u16 value
)
71 out_be16(lp
->base
+ HPLANCE_REGOFF
+ LANCE_RAP
, value
);
72 } while ((in_8(lp
->base
+ HPLANCE_STATUS
) & LE_ACK
) == 0);
75 static inline void WRITERDP(struct lance_private
*lp
, __u16 value
)
78 out_be16(lp
->base
+ HPLANCE_REGOFF
+ LANCE_RDP
, value
);
79 } while ((in_8(lp
->base
+ HPLANCE_STATUS
) & LE_ACK
) == 0);
82 static inline __u16
READRDP(struct lance_private
*lp
)
86 value
= in_be16(lp
->base
+ HPLANCE_REGOFF
+ LANCE_RDP
);
87 } while ((in_8(lp
->base
+ HPLANCE_STATUS
) & LE_ACK
) == 0);
92 #endif /* CONFIG_HPLANCE || CONFIG_HPLANCE_MODULE */
94 /* debugging output macros, various flavours */
95 /* #define TEST_HITS */
97 #define PRINT_RINGS() \
100 for (t=0; t < RX_RING_SIZE; t++) { \
101 printk("R%d: @(%02X %04X) len %04X, mblen %04X, bits %02X\n",\
102 t, ib->brx_ring[t].rmd1_hadr, ib->brx_ring[t].rmd0,\
103 ib->brx_ring[t].length,\
104 ib->brx_ring[t].mblength, ib->brx_ring[t].rmd1_bits);\
106 for (t=0; t < TX_RING_SIZE; t++) { \
107 printk("T%d: @(%02X %04X) len %04X, misc %04X, bits %02X\n",\
108 t, ib->btx_ring[t].tmd1_hadr, ib->btx_ring[t].tmd0,\
109 ib->btx_ring[t].length,\
110 ib->btx_ring[t].misc, ib->btx_ring[t].tmd1_bits);\
114 #define PRINT_RINGS()
117 /* Load the CSR registers. The LANCE has to be STOPped when we do this! */
118 static void load_csrs (struct lance_private
*lp
)
120 volatile struct lance_init_block
*aib
= lp
->lance_init_block
;
123 leptr
= LANCE_ADDR (aib
);
125 WRITERAP(lp
, LE_CSR1
); /* load address of init block */
126 WRITERDP(lp
, leptr
& 0xFFFF);
127 WRITERAP(lp
, LE_CSR2
);
128 WRITERDP(lp
, leptr
>> 16);
129 WRITERAP(lp
, LE_CSR3
);
130 WRITERDP(lp
, lp
->busmaster_regval
); /* set byteswap/ALEctrl/byte ctrl */
132 /* Point back to csr0 */
133 WRITERAP(lp
, LE_CSR0
);
136 /* #define to 0 or 1 appropriately */
137 #define DEBUG_IRING 0
138 /* Set up the Lance Rx and Tx rings and the init block */
139 static void lance_init_ring (struct net_device
*dev
)
141 struct lance_private
*lp
= netdev_priv(dev
);
142 volatile struct lance_init_block
*ib
= lp
->init_block
;
143 volatile struct lance_init_block
*aib
; /* for LANCE_ADDR computations */
147 aib
= lp
->lance_init_block
;
149 lp
->rx_new
= lp
->tx_new
= 0;
150 lp
->rx_old
= lp
->tx_old
= 0;
152 ib
->mode
= LE_MO_PROM
; /* normal, enable Tx & Rx */
154 /* Copy the ethernet address to the lance init block
155 * Notice that we do a byteswap if we're big endian.
156 * [I think this is the right criterion; at least, sunlance,
157 * a2065 and atarilance do the byteswap and lance.c (PC) doesn't.
158 * However, the datasheet says that the BSWAP bit doesn't affect
159 * the init block, so surely it should be low byte first for
161 * We could define the ib->physaddr as three 16bit values and
162 * use (addr[1] << 8) | addr[0] & co, but this is more efficient.
165 ib
->phys_addr
[0] = dev
->dev_addr
[1];
166 ib
->phys_addr
[1] = dev
->dev_addr
[0];
167 ib
->phys_addr
[2] = dev
->dev_addr
[3];
168 ib
->phys_addr
[3] = dev
->dev_addr
[2];
169 ib
->phys_addr
[4] = dev
->dev_addr
[5];
170 ib
->phys_addr
[5] = dev
->dev_addr
[4];
173 ib
->phys_addr
[i
] = dev
->dev_addr
[i
];
177 printk ("TX rings:\n");
180 /* Setup the Tx ring entries */
181 for (i
= 0; i
< (1<<lp
->lance_log_tx_bufs
); i
++) {
182 leptr
= LANCE_ADDR(&aib
->tx_buf
[i
][0]);
183 ib
->btx_ring
[i
].tmd0
= leptr
;
184 ib
->btx_ring
[i
].tmd1_hadr
= leptr
>> 16;
185 ib
->btx_ring
[i
].tmd1_bits
= 0;
186 ib
->btx_ring
[i
].length
= 0xf000; /* The ones required by tmd2 */
187 ib
->btx_ring
[i
].misc
= 0;
189 printk ("%d: 0x%8.8x\n", i
, leptr
);
192 /* Setup the Rx ring entries */
194 printk ("RX rings:\n");
195 for (i
= 0; i
< (1<<lp
->lance_log_rx_bufs
); i
++) {
196 leptr
= LANCE_ADDR(&aib
->rx_buf
[i
][0]);
198 ib
->brx_ring
[i
].rmd0
= leptr
;
199 ib
->brx_ring
[i
].rmd1_hadr
= leptr
>> 16;
200 ib
->brx_ring
[i
].rmd1_bits
= LE_R1_OWN
;
201 /* 0xf000 == bits that must be one (reserved, presumably) */
202 ib
->brx_ring
[i
].length
= -RX_BUFF_SIZE
| 0xf000;
203 ib
->brx_ring
[i
].mblength
= 0;
205 printk ("%d: 0x%8.8x\n", i
, leptr
);
208 /* Setup the initialization block */
210 /* Setup rx descriptor pointer */
211 leptr
= LANCE_ADDR(&aib
->brx_ring
);
212 ib
->rx_len
= (lp
->lance_log_rx_bufs
<< 13) | (leptr
>> 16);
215 printk ("RX ptr: %8.8x\n", leptr
);
217 /* Setup tx descriptor pointer */
218 leptr
= LANCE_ADDR(&aib
->btx_ring
);
219 ib
->tx_len
= (lp
->lance_log_tx_bufs
<< 13) | (leptr
>> 16);
222 printk ("TX ptr: %8.8x\n", leptr
);
224 /* Clear the multicast filter */
230 /* LANCE must be STOPped before we do this, too... */
231 static int init_restart_lance (struct lance_private
*lp
)
235 WRITERAP(lp
, LE_CSR0
);
236 WRITERDP(lp
, LE_C0_INIT
);
238 /* Need a hook here for sunlance ledma stuff */
240 /* Wait for the lance to complete initialization */
241 for (i
= 0; (i
< 100) && !(READRDP(lp
) & (LE_C0_ERR
| LE_C0_IDON
)); i
++)
243 if ((i
== 100) || (READRDP(lp
) & LE_C0_ERR
)) {
244 printk ("LANCE unopened after %d ticks, csr0=%4.4x.\n", i
, READRDP(lp
));
248 /* Clear IDON by writing a "1", enable interrupts and start lance */
249 WRITERDP(lp
, LE_C0_IDON
);
250 WRITERDP(lp
, LE_C0_INEA
| LE_C0_STRT
);
255 static int lance_reset (struct net_device
*dev
)
257 struct lance_private
*lp
= netdev_priv(dev
);
261 WRITERAP(lp
, LE_CSR0
);
262 WRITERDP(lp
, LE_C0_STOP
);
265 lance_init_ring (dev
);
266 dev
->trans_start
= jiffies
;
267 status
= init_restart_lance (lp
);
269 printk ("Lance restart=%d\n", status
);
274 static int lance_rx (struct net_device
*dev
)
276 struct lance_private
*lp
= netdev_priv(dev
);
277 volatile struct lance_init_block
*ib
= lp
->init_block
;
278 volatile struct lance_rx_desc
*rd
;
280 int len
= 0; /* XXX shut up gcc warnings */
281 struct sk_buff
*skb
= 0; /* XXX shut up gcc warnings */
288 for (i
= 0; i
< RX_RING_SIZE
; i
++) {
291 ib
->brx_ring
[i
].rmd1_bits
& LE_R1_OWN
? "_" : "X");
294 ib
->brx_ring
[i
].rmd1_bits
& LE_R1_OWN
? "." : "1");
299 blinken_leds(0x40, 0);
301 WRITERDP(lp
, LE_C0_RINT
| LE_C0_INEA
); /* ack Rx int, reenable ints */
302 for (rd
= &ib
->brx_ring
[lp
->rx_new
]; /* For each Rx ring we own... */
303 !((bits
= rd
->rmd1_bits
) & LE_R1_OWN
);
304 rd
= &ib
->brx_ring
[lp
->rx_new
]) {
306 /* We got an incomplete frame? */
307 if ((bits
& LE_R1_POK
) != LE_R1_POK
) {
308 dev
->stats
.rx_over_errors
++;
309 dev
->stats
.rx_errors
++;
311 } else if (bits
& LE_R1_ERR
) {
312 /* Count only the end frame as a rx error,
315 if (bits
& LE_R1_BUF
) dev
->stats
.rx_fifo_errors
++;
316 if (bits
& LE_R1_CRC
) dev
->stats
.rx_crc_errors
++;
317 if (bits
& LE_R1_OFL
) dev
->stats
.rx_over_errors
++;
318 if (bits
& LE_R1_FRA
) dev
->stats
.rx_frame_errors
++;
319 if (bits
& LE_R1_EOP
) dev
->stats
.rx_errors
++;
321 len
= (rd
->mblength
& 0xfff) - 4;
322 skb
= dev_alloc_skb (len
+2);
325 printk ("%s: Memory squeeze, deferring packet.\n",
327 dev
->stats
.rx_dropped
++;
329 rd
->rmd1_bits
= LE_R1_OWN
;
330 lp
->rx_new
= (lp
->rx_new
+ 1) & lp
->rx_ring_mod_mask
;
334 skb_reserve (skb
, 2); /* 16 byte align */
335 skb_put (skb
, len
); /* make room */
336 skb_copy_to_linear_data(skb
,
337 (unsigned char *)&(ib
->rx_buf
[lp
->rx_new
][0]),
339 skb
->protocol
= eth_type_trans (skb
, dev
);
341 dev
->last_rx
= jiffies
;
342 dev
->stats
.rx_packets
++;
343 dev
->stats
.rx_bytes
+= len
;
346 /* Return the packet to the pool */
348 rd
->rmd1_bits
= LE_R1_OWN
;
349 lp
->rx_new
= (lp
->rx_new
+ 1) & lp
->rx_ring_mod_mask
;
354 static int lance_tx (struct net_device
*dev
)
356 struct lance_private
*lp
= netdev_priv(dev
);
357 volatile struct lance_init_block
*ib
= lp
->init_block
;
358 volatile struct lance_tx_desc
*td
;
363 blinken_leds(0x80, 0);
366 WRITERDP(lp
, LE_C0_TINT
| LE_C0_INEA
);
370 for (i
= j
; i
!= lp
->tx_new
; i
= j
) {
371 td
= &ib
->btx_ring
[i
];
373 /* If we hit a packet not owned by us, stop */
374 if (td
->tmd1_bits
& LE_T1_OWN
)
377 if (td
->tmd1_bits
& LE_T1_ERR
) {
380 dev
->stats
.tx_errors
++;
381 if (status
& LE_T3_RTY
) dev
->stats
.tx_aborted_errors
++;
382 if (status
& LE_T3_LCOL
) dev
->stats
.tx_window_errors
++;
384 if (status
& LE_T3_CLOS
) {
385 dev
->stats
.tx_carrier_errors
++;
386 if (lp
->auto_select
) {
387 lp
->tpe
= 1 - lp
->tpe
;
388 printk("%s: Carrier Lost, trying %s\n",
389 dev
->name
, lp
->tpe
?"TPE":"AUI");
391 WRITERAP(lp
, LE_CSR0
);
392 WRITERDP(lp
, LE_C0_STOP
);
393 lance_init_ring (dev
);
395 init_restart_lance (lp
);
400 /* buffer errors and underflows turn off the transmitter */
401 /* Restart the adapter */
402 if (status
& (LE_T3_BUF
|LE_T3_UFL
)) {
403 dev
->stats
.tx_fifo_errors
++;
405 printk ("%s: Tx: ERR_BUF|ERR_UFL, restarting\n",
408 WRITERAP(lp
, LE_CSR0
);
409 WRITERDP(lp
, LE_C0_STOP
);
410 lance_init_ring (dev
);
412 init_restart_lance (lp
);
415 } else if ((td
->tmd1_bits
& LE_T1_POK
) == LE_T1_POK
) {
417 * So we don't count the packet more than once.
419 td
->tmd1_bits
&= ~(LE_T1_POK
);
421 /* One collision before packet was sent. */
422 if (td
->tmd1_bits
& LE_T1_EONE
)
423 dev
->stats
.collisions
++;
425 /* More than one collision, be optimistic. */
426 if (td
->tmd1_bits
& LE_T1_EMORE
)
427 dev
->stats
.collisions
+= 2;
429 dev
->stats
.tx_packets
++;
432 j
= (j
+ 1) & lp
->tx_ring_mod_mask
;
435 WRITERDP(lp
, LE_C0_TINT
| LE_C0_INEA
);
440 lance_interrupt (int irq
, void *dev_id
)
442 struct net_device
*dev
= (struct net_device
*)dev_id
;
443 struct lance_private
*lp
= netdev_priv(dev
);
446 spin_lock (&lp
->devlock
);
448 WRITERAP(lp
, LE_CSR0
); /* LANCE Controller Status */
453 if (!(csr0
& LE_C0_INTR
)) { /* Check if any interrupt has */
454 spin_unlock (&lp
->devlock
);
455 return IRQ_NONE
; /* been generated by the Lance. */
458 /* Acknowledge all the interrupt sources ASAP */
459 WRITERDP(lp
, csr0
& ~(LE_C0_INEA
|LE_C0_TDMD
|LE_C0_STOP
|LE_C0_STRT
|LE_C0_INIT
));
461 if ((csr0
& LE_C0_ERR
)) {
462 /* Clear the error condition */
463 WRITERDP(lp
, LE_C0_BABL
|LE_C0_ERR
|LE_C0_MISS
|LE_C0_INEA
);
466 if (csr0
& LE_C0_RINT
)
469 if (csr0
& LE_C0_TINT
)
472 /* Log misc errors. */
473 if (csr0
& LE_C0_BABL
)
474 dev
->stats
.tx_errors
++; /* Tx babble. */
475 if (csr0
& LE_C0_MISS
)
476 dev
->stats
.rx_errors
++; /* Missed a Rx frame. */
477 if (csr0
& LE_C0_MERR
) {
478 printk("%s: Bus master arbitration failure, status %4.4x.\n",
480 /* Restart the chip. */
481 WRITERDP(lp
, LE_C0_STRT
);
484 if (lp
->tx_full
&& netif_queue_stopped(dev
) && (TX_BUFFS_AVAIL
>= 0)) {
486 netif_wake_queue (dev
);
489 WRITERAP(lp
, LE_CSR0
);
490 WRITERDP(lp
, LE_C0_BABL
|LE_C0_CERR
|LE_C0_MISS
|LE_C0_MERR
|LE_C0_IDON
|LE_C0_INEA
);
492 spin_unlock (&lp
->devlock
);
496 int lance_open (struct net_device
*dev
)
498 struct lance_private
*lp
= netdev_priv(dev
);
501 /* Install the Interrupt handler. Or we could shunt this out to specific drivers? */
502 if (request_irq(lp
->irq
, lance_interrupt
, IRQF_SHARED
, lp
->name
, dev
))
505 res
= lance_reset(dev
);
506 spin_lock_init(&lp
->devlock
);
507 netif_start_queue (dev
);
512 int lance_close (struct net_device
*dev
)
514 struct lance_private
*lp
= netdev_priv(dev
);
516 netif_stop_queue (dev
);
519 WRITERAP(lp
, LE_CSR0
);
520 WRITERDP(lp
, LE_C0_STOP
);
522 free_irq(lp
->irq
, dev
);
527 void lance_tx_timeout(struct net_device
*dev
)
529 printk("lance_tx_timeout\n");
531 dev
->trans_start
= jiffies
;
532 netif_wake_queue (dev
);
536 int lance_start_xmit (struct sk_buff
*skb
, struct net_device
*dev
)
538 struct lance_private
*lp
= netdev_priv(dev
);
539 volatile struct lance_init_block
*ib
= lp
->init_block
;
540 int entry
, skblen
, len
;
547 netif_stop_queue (dev
);
552 /* dump the packet */
556 for (i
= 0; i
< 64; i
++) {
559 printk ("%2.2x ", skb
->data
[i
]);
563 len
= (skblen
<= ETH_ZLEN
) ? ETH_ZLEN
: skblen
;
564 entry
= lp
->tx_new
& lp
->tx_ring_mod_mask
;
565 ib
->btx_ring
[entry
].length
= (-len
) | 0xf000;
566 ib
->btx_ring
[entry
].misc
= 0;
568 if (skb
->len
< ETH_ZLEN
)
569 memset((void *)&ib
->tx_buf
[entry
][0], 0, ETH_ZLEN
);
570 skb_copy_from_linear_data(skb
, (void *)&ib
->tx_buf
[entry
][0], skblen
);
572 /* Now, give the packet to the lance */
573 ib
->btx_ring
[entry
].tmd1_bits
= (LE_T1_POK
|LE_T1_OWN
);
574 lp
->tx_new
= (lp
->tx_new
+1) & lp
->tx_ring_mod_mask
;
577 /* Kick the lance: transmit now */
578 WRITERDP(lp
, LE_C0_INEA
| LE_C0_TDMD
);
579 dev
->trans_start
= jiffies
;
582 spin_lock_irqsave (&lp
->devlock
, flags
);
584 netif_start_queue (dev
);
587 spin_unlock_irqrestore (&lp
->devlock
, flags
);
592 /* taken from the depca driver via a2065.c */
593 static void lance_load_multicast (struct net_device
*dev
)
595 struct lance_private
*lp
= netdev_priv(dev
);
596 volatile struct lance_init_block
*ib
= lp
->init_block
;
597 volatile u16
*mcast_table
= (u16
*)&ib
->filter
;
598 struct dev_mc_list
*dmi
=dev
->mc_list
;
603 /* set all multicast bits */
604 if (dev
->flags
& IFF_ALLMULTI
){
605 ib
->filter
[0] = 0xffffffff;
606 ib
->filter
[1] = 0xffffffff;
609 /* clear the multicast filter */
614 for (i
= 0; i
< dev
->mc_count
; i
++){
615 addrs
= dmi
->dmi_addr
;
618 /* multicast address? */
622 crc
= ether_crc_le(6, addrs
);
624 mcast_table
[crc
>> 4] |= 1 << (crc
& 0xf);
630 void lance_set_multicast (struct net_device
*dev
)
632 struct lance_private
*lp
= netdev_priv(dev
);
633 volatile struct lance_init_block
*ib
= lp
->init_block
;
636 stopped
= netif_queue_stopped(dev
);
638 netif_stop_queue (dev
);
640 while (lp
->tx_old
!= lp
->tx_new
)
643 WRITERAP(lp
, LE_CSR0
);
644 WRITERDP(lp
, LE_C0_STOP
);
645 lance_init_ring (dev
);
647 if (dev
->flags
& IFF_PROMISC
) {
648 ib
->mode
|= LE_MO_PROM
;
650 ib
->mode
&= ~LE_MO_PROM
;
651 lance_load_multicast (dev
);
654 init_restart_lance (lp
);
657 netif_start_queue (dev
);
660 #ifdef CONFIG_NET_POLL_CONTROLLER
661 void lance_poll(struct net_device
*dev
)
663 struct lance_private
*lp
= netdev_priv(dev
);
665 spin_lock (&lp
->devlock
);
666 WRITERAP(lp
, LE_CSR0
);
667 WRITERDP(lp
, LE_C0_STRT
);
668 spin_unlock (&lp
->devlock
);
669 lance_interrupt(dev
->irq
, dev
);
673 MODULE_LICENSE("GPL");