1 /*======================================================================
2 
3     A PCMCIA ethernet driver for Asix AX88190-based cards
4 
5     The Asix AX88190 is a NS8390-derived chipset with a few nasty
6     idiosyncracies that make it very inconvenient to support with a
7     standard 8390 driver.  This driver is based on pcnet_cs, with the
8     tweaked 8390 code grafted on the end.  Much of what I did was to
9     clean up and update a similar driver supplied by Asix, which was
10     adapted by William Lee, william@asix.com.tw.
11 
12     Copyright (C) 2001 David A. Hinds -- dahinds@users.sourceforge.net
13 
14     axnet_cs.c 1.28 2002/06/29 06:27:37
15 
16     The network driver code is based on Donald Becker's NE2000 code:
17 
18     Written 1992,1993 by Donald Becker.
19     Copyright 1993 United States Government as represented by the
20     Director, National Security Agency.  This software may be used and
21     distributed according to the terms of the GNU General Public License,
22     incorporated herein by reference.
23     Donald Becker may be reached at becker@scyld.com
24 
25 ======================================================================*/
26 
27 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28 
29 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/ptrace.h>
32 #include <linux/string.h>
33 #include <linux/timer.h>
34 #include <linux/delay.h>
35 #include <linux/spinlock.h>
36 #include <linux/netdevice.h>
37 #include <linux/etherdevice.h>
38 #include <linux/crc32.h>
39 #include <linux/mii.h>
40 #include "8390.h"
41 
42 #include <pcmcia/cistpl.h>
43 #include <pcmcia/ciscode.h>
44 #include <pcmcia/ds.h>
45 #include <pcmcia/cisreg.h>
46 
47 #include <asm/io.h>
48 #include <asm/byteorder.h>
49 #include <linux/uaccess.h>
50 
51 #define AXNET_CMD	0x00
52 #define AXNET_DATAPORT	0x10	/* NatSemi-defined port window offset. */
53 #define AXNET_RESET	0x1f	/* Issue a read to reset, a write to clear. */
54 #define AXNET_MII_EEP	0x14	/* Offset of MII access port */
55 #define AXNET_TEST	0x15	/* Offset of TEST Register port */
56 #define AXNET_GPIO	0x17	/* Offset of General Purpose Register Port */
57 
58 #define AXNET_START_PG	0x40	/* First page of TX buffer */
59 #define AXNET_STOP_PG	0x80	/* Last page +1 of RX ring */
60 
61 #define AXNET_RDC_TIMEOUT 0x02	/* Max wait in jiffies for Tx RDC */
62 
63 #define IS_AX88190	0x0001
64 #define IS_AX88790	0x0002
65 
66 /*====================================================================*/
67 
68 /* Module parameters */
69 
70 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
71 MODULE_DESCRIPTION("Asix AX88190 PCMCIA ethernet driver");
72 MODULE_LICENSE("GPL");
73 
74 
75 /*====================================================================*/
76 
77 static int axnet_config(struct pcmcia_device *link);
78 static void axnet_release(struct pcmcia_device *link);
79 static int axnet_open(struct net_device *dev);
80 static int axnet_close(struct net_device *dev);
81 static int axnet_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
82 static netdev_tx_t axnet_start_xmit(struct sk_buff *skb,
83 					  struct net_device *dev);
84 static struct net_device_stats *get_stats(struct net_device *dev);
85 static void set_multicast_list(struct net_device *dev);
86 static void axnet_tx_timeout(struct net_device *dev);
87 static irqreturn_t ei_irq_wrapper(int irq, void *dev_id);
88 static void ei_watchdog(u_long arg);
89 static void axnet_reset_8390(struct net_device *dev);
90 
91 static int mdio_read(unsigned int addr, int phy_id, int loc);
92 static void mdio_write(unsigned int addr, int phy_id, int loc, int value);
93 
94 static void get_8390_hdr(struct net_device *,
95 			 struct e8390_pkt_hdr *, int);
96 static void block_input(struct net_device *dev, int count,
97 			struct sk_buff *skb, int ring_offset);
98 static void block_output(struct net_device *dev, int count,
99 			 const u_char *buf, const int start_page);
100 
101 static void axnet_detach(struct pcmcia_device *p_dev);
102 
103 static void AX88190_init(struct net_device *dev, int startp);
104 static int ax_open(struct net_device *dev);
105 static int ax_close(struct net_device *dev);
106 static irqreturn_t ax_interrupt(int irq, void *dev_id);
107 static u32 axnet_msg_enable;
108 
109 /*====================================================================*/
110 
111 struct axnet_dev {
112 	struct pcmcia_device	*p_dev;
113 	caddr_t	base;
114 	struct timer_list	watchdog;
115 	int	stale, fast_poll;
116 	u_short	link_status;
117 	u_char	duplex_flag;
118 	int	phy_id;
119 	int	flags;
120 	int	active_low;
121 };
122 
123 static inline struct axnet_dev *PRIV(struct net_device *dev)
124 {
125 	void *p = (char *)netdev_priv(dev) + sizeof(struct ei_device);
126 	return p;
127 }
128 
129 static const struct net_device_ops axnet_netdev_ops = {
130 	.ndo_open 		= axnet_open,
131 	.ndo_stop		= axnet_close,
132 	.ndo_do_ioctl		= axnet_ioctl,
133 	.ndo_start_xmit		= axnet_start_xmit,
134 	.ndo_tx_timeout		= axnet_tx_timeout,
135 	.ndo_get_stats		= get_stats,
136 	.ndo_set_rx_mode	= set_multicast_list,
137 	.ndo_set_mac_address 	= eth_mac_addr,
138 	.ndo_validate_addr	= eth_validate_addr,
139 };
140 
141 static int axnet_probe(struct pcmcia_device *link)
142 {
143     struct axnet_dev *info;
144     struct net_device *dev;
145     struct ei_device *ei_local;
146 
147     dev_dbg(&link->dev, "axnet_attach()\n");
148 
149     dev = alloc_etherdev(sizeof(struct ei_device) + sizeof(struct axnet_dev));
150     if (!dev)
151 	return -ENOMEM;
152 
153     ei_local = netdev_priv(dev);
154     ei_local->msg_enable = axnet_msg_enable;
155     spin_lock_init(&ei_local->page_lock);
156 
157     info = PRIV(dev);
158     info->p_dev = link;
159     link->priv = dev;
160     link->config_flags |= CONF_ENABLE_IRQ;
161 
162     dev->netdev_ops = &axnet_netdev_ops;
163 
164     dev->watchdog_timeo = TX_TIMEOUT;
165 
166     return axnet_config(link);
167 } /* axnet_attach */
168 
169 static void axnet_detach(struct pcmcia_device *link)
170 {
171     struct net_device *dev = link->priv;
172 
173     dev_dbg(&link->dev, "axnet_detach(0x%p)\n", link);
174 
175     unregister_netdev(dev);
176 
177     axnet_release(link);
178 
179     free_netdev(dev);
180 } /* axnet_detach */
181 
182 /*======================================================================
183 
184     This probes for a card's hardware address by reading the PROM.
185 
186 ======================================================================*/
187 
188 static int get_prom(struct pcmcia_device *link)
189 {
190     struct net_device *dev = link->priv;
191     unsigned int ioaddr = dev->base_addr;
192     int i, j;
193 
194     /* This is based on drivers/net/ethernet/8390/ne.c */
195     struct {
196 	u_char value, offset;
197     } program_seq[] = {
198 	{E8390_NODMA+E8390_PAGE0+E8390_STOP, E8390_CMD}, /* Select page 0*/
199 	{0x01,	EN0_DCFG},	/* Set word-wide access. */
200 	{0x00,	EN0_RCNTLO},	/* Clear the count regs. */
201 	{0x00,	EN0_RCNTHI},
202 	{0x00,	EN0_IMR},	/* Mask completion irq. */
203 	{0xFF,	EN0_ISR},
204 	{E8390_RXOFF|0x40, EN0_RXCR},	/* 0x60  Set to monitor */
205 	{E8390_TXOFF, EN0_TXCR},	/* 0x02  and loopback mode. */
206 	{0x10,	EN0_RCNTLO},
207 	{0x00,	EN0_RCNTHI},
208 	{0x00,	EN0_RSARLO},	/* DMA starting at 0x0400. */
209 	{0x04,	EN0_RSARHI},
210 	{E8390_RREAD+E8390_START, E8390_CMD},
211     };
212 
213     /* Not much of a test, but the alternatives are messy */
214     if (link->config_base != 0x03c0)
215 	return 0;
216 
217     axnet_reset_8390(dev);
218     mdelay(10);
219 
220     for (i = 0; i < ARRAY_SIZE(program_seq); i++)
221 	outb_p(program_seq[i].value, ioaddr + program_seq[i].offset);
222 
223     for (i = 0; i < 6; i += 2) {
224 	j = inw(ioaddr + AXNET_DATAPORT);
225 	dev->dev_addr[i] = j & 0xff;
226 	dev->dev_addr[i+1] = j >> 8;
227     }
228     return 1;
229 } /* get_prom */
230 
231 static int try_io_port(struct pcmcia_device *link)
232 {
233     int j, ret;
234     link->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
235     link->resource[1]->flags &= ~IO_DATA_PATH_WIDTH;
236     if (link->resource[0]->end == 32) {
237 	link->resource[0]->flags |= IO_DATA_PATH_WIDTH_AUTO;
238 	/* for master/slave multifunction cards */
239 	if (link->resource[1]->end > 0)
240 	    link->resource[1]->flags |= IO_DATA_PATH_WIDTH_8;
241     } else {
242 	/* This should be two 16-port windows */
243 	link->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
244 	link->resource[1]->flags |= IO_DATA_PATH_WIDTH_16;
245     }
246     if (link->resource[0]->start == 0) {
247 	for (j = 0; j < 0x400; j += 0x20) {
248 	    link->resource[0]->start = j ^ 0x300;
249 	    link->resource[1]->start = (j ^ 0x300) + 0x10;
250 	    link->io_lines = 16;
251 	    ret = pcmcia_request_io(link);
252 	    if (ret == 0)
253 		    return ret;
254 	}
255 	return ret;
256     } else {
257 	return pcmcia_request_io(link);
258     }
259 }
260 
261 static int axnet_configcheck(struct pcmcia_device *p_dev, void *priv_data)
262 {
263 	if (p_dev->config_index == 0)
264 		return -EINVAL;
265 
266 	p_dev->config_index = 0x05;
267 	if (p_dev->resource[0]->end + p_dev->resource[1]->end < 32)
268 		return -ENODEV;
269 
270 	return try_io_port(p_dev);
271 }
272 
273 static int axnet_config(struct pcmcia_device *link)
274 {
275     struct net_device *dev = link->priv;
276     struct axnet_dev *info = PRIV(dev);
277     int i, j, j2, ret;
278 
279     dev_dbg(&link->dev, "axnet_config(0x%p)\n", link);
280 
281     /* don't trust the CIS on this; Linksys got it wrong */
282     link->config_regs = 0x63;
283     link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_IO;
284     ret = pcmcia_loop_config(link, axnet_configcheck, NULL);
285     if (ret != 0)
286 	goto failed;
287 
288     if (!link->irq)
289 	    goto failed;
290 
291     if (resource_size(link->resource[1]) == 8)
292 	link->config_flags |= CONF_ENABLE_SPKR;
293 
294     ret = pcmcia_enable_device(link);
295     if (ret)
296 	    goto failed;
297 
298     dev->irq = link->irq;
299     dev->base_addr = link->resource[0]->start;
300 
301     if (!get_prom(link)) {
302 	pr_notice("this is not an AX88190 card!\n");
303 	pr_notice("use pcnet_cs instead.\n");
304 	goto failed;
305     }
306 
307     ei_status.name = "AX88190";
308     ei_status.word16 = 1;
309     ei_status.tx_start_page = AXNET_START_PG;
310     ei_status.rx_start_page = AXNET_START_PG + TX_PAGES;
311     ei_status.stop_page = AXNET_STOP_PG;
312     ei_status.reset_8390 = axnet_reset_8390;
313     ei_status.get_8390_hdr = get_8390_hdr;
314     ei_status.block_input = block_input;
315     ei_status.block_output = block_output;
316 
317     if (inb(dev->base_addr + AXNET_TEST) != 0)
318 	info->flags |= IS_AX88790;
319     else
320 	info->flags |= IS_AX88190;
321 
322     if (info->flags & IS_AX88790)
323 	outb(0x10, dev->base_addr + AXNET_GPIO);  /* select Internal PHY */
324 
325     info->active_low = 0;
326 
327     for (i = 0; i < 32; i++) {
328 	j = mdio_read(dev->base_addr + AXNET_MII_EEP, i, 1);
329 	j2 = mdio_read(dev->base_addr + AXNET_MII_EEP, i, 2);
330 	if (j == j2) continue;
331 	if ((j != 0) && (j != 0xffff)) break;
332     }
333 
334     if (i == 32) {
335 	/* Maybe PHY is in power down mode. (PPD_SET = 1)
336 	   Bit 2 of CCSR is active low. */
337 	pcmcia_write_config_byte(link, CISREG_CCSR, 0x04);
338 	for (i = 0; i < 32; i++) {
339 	    j = mdio_read(dev->base_addr + AXNET_MII_EEP, i, 1);
340 	    j2 = mdio_read(dev->base_addr + AXNET_MII_EEP, i, 2);
341 	    if (j == j2) continue;
342 	    if ((j != 0) && (j != 0xffff)) {
343 		info->active_low = 1;
344 		break;
345 	    }
346 	}
347     }
348 
349     info->phy_id = (i < 32) ? i : -1;
350     SET_NETDEV_DEV(dev, &link->dev);
351 
352     if (register_netdev(dev) != 0) {
353 	pr_notice("register_netdev() failed\n");
354 	goto failed;
355     }
356 
357     netdev_info(dev, "Asix AX88%d90: io %#3lx, irq %d, hw_addr %pM\n",
358 		((info->flags & IS_AX88790) ? 7 : 1),
359 		dev->base_addr, dev->irq, dev->dev_addr);
360     if (info->phy_id != -1) {
361 	netdev_dbg(dev, "  MII transceiver at index %d, status %x\n",
362 		   info->phy_id, j);
363     } else {
364 	netdev_notice(dev, "  No MII transceivers found!\n");
365     }
366     return 0;
367 
368 failed:
369     axnet_release(link);
370     return -ENODEV;
371 } /* axnet_config */
372 
373 static void axnet_release(struct pcmcia_device *link)
374 {
375 	pcmcia_disable_device(link);
376 }
377 
378 static int axnet_suspend(struct pcmcia_device *link)
379 {
380 	struct net_device *dev = link->priv;
381 
382 	if (link->open)
383 		netif_device_detach(dev);
384 
385 	return 0;
386 }
387 
388 static int axnet_resume(struct pcmcia_device *link)
389 {
390 	struct net_device *dev = link->priv;
391 	struct axnet_dev *info = PRIV(dev);
392 
393 	if (link->open) {
394 		if (info->active_low == 1)
395 			pcmcia_write_config_byte(link, CISREG_CCSR, 0x04);
396 
397 		axnet_reset_8390(dev);
398 		AX88190_init(dev, 1);
399 		netif_device_attach(dev);
400 	}
401 
402 	return 0;
403 }
404 
405 
406 /*======================================================================
407 
408     MII interface support
409 
410 ======================================================================*/
411 
412 #define MDIO_SHIFT_CLK		0x01
413 #define MDIO_DATA_WRITE0	0x00
414 #define MDIO_DATA_WRITE1	0x08
415 #define MDIO_DATA_READ		0x04
416 #define MDIO_MASK		0x0f
417 #define MDIO_ENB_IN		0x02
418 
419 static void mdio_sync(unsigned int addr)
420 {
421     int bits;
422     for (bits = 0; bits < 32; bits++) {
423 	outb_p(MDIO_DATA_WRITE1, addr);
424 	outb_p(MDIO_DATA_WRITE1 | MDIO_SHIFT_CLK, addr);
425     }
426 }
427 
428 static int mdio_read(unsigned int addr, int phy_id, int loc)
429 {
430     u_int cmd = (0xf6<<10)|(phy_id<<5)|loc;
431     int i, retval = 0;
432 
433     mdio_sync(addr);
434     for (i = 14; i >= 0; i--) {
435 	int dat = (cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
436 	outb_p(dat, addr);
437 	outb_p(dat | MDIO_SHIFT_CLK, addr);
438     }
439     for (i = 19; i > 0; i--) {
440 	outb_p(MDIO_ENB_IN, addr);
441 	retval = (retval << 1) | ((inb_p(addr) & MDIO_DATA_READ) != 0);
442 	outb_p(MDIO_ENB_IN | MDIO_SHIFT_CLK, addr);
443     }
444     return (retval>>1) & 0xffff;
445 }
446 
447 static void mdio_write(unsigned int addr, int phy_id, int loc, int value)
448 {
449     u_int cmd = (0x05<<28)|(phy_id<<23)|(loc<<18)|(1<<17)|value;
450     int i;
451 
452     mdio_sync(addr);
453     for (i = 31; i >= 0; i--) {
454 	int dat = (cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
455 	outb_p(dat, addr);
456 	outb_p(dat | MDIO_SHIFT_CLK, addr);
457     }
458     for (i = 1; i >= 0; i--) {
459 	outb_p(MDIO_ENB_IN, addr);
460 	outb_p(MDIO_ENB_IN | MDIO_SHIFT_CLK, addr);
461     }
462 }
463 
464 /*====================================================================*/
465 
466 static int axnet_open(struct net_device *dev)
467 {
468     int ret;
469     struct axnet_dev *info = PRIV(dev);
470     struct pcmcia_device *link = info->p_dev;
471     unsigned int nic_base = dev->base_addr;
472 
473     dev_dbg(&link->dev, "axnet_open('%s')\n", dev->name);
474 
475     if (!pcmcia_dev_present(link))
476 	return -ENODEV;
477 
478     outb_p(0xFF, nic_base + EN0_ISR); /* Clear bogus intr. */
479     ret = request_irq(dev->irq, ei_irq_wrapper, IRQF_SHARED, "axnet_cs", dev);
480     if (ret)
481 	    return ret;
482 
483     link->open++;
484 
485     info->link_status = 0x00;
486     setup_timer(&info->watchdog, ei_watchdog, (u_long)dev);
487     mod_timer(&info->watchdog, jiffies + HZ);
488 
489     return ax_open(dev);
490 } /* axnet_open */
491 
492 /*====================================================================*/
493 
494 static int axnet_close(struct net_device *dev)
495 {
496     struct axnet_dev *info = PRIV(dev);
497     struct pcmcia_device *link = info->p_dev;
498 
499     dev_dbg(&link->dev, "axnet_close('%s')\n", dev->name);
500 
501     ax_close(dev);
502     free_irq(dev->irq, dev);
503 
504     link->open--;
505     netif_stop_queue(dev);
506     del_timer_sync(&info->watchdog);
507 
508     return 0;
509 } /* axnet_close */
510 
511 /*======================================================================
512 
513     Hard reset the card.  This used to pause for the same period that
514     a 8390 reset command required, but that shouldn't be necessary.
515 
516 ======================================================================*/
517 
518 static void axnet_reset_8390(struct net_device *dev)
519 {
520     unsigned int nic_base = dev->base_addr;
521     int i;
522 
523     ei_status.txing = ei_status.dmaing = 0;
524 
525     outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, nic_base + E8390_CMD);
526 
527     outb(inb(nic_base + AXNET_RESET), nic_base + AXNET_RESET);
528 
529     for (i = 0; i < 100; i++) {
530 	if ((inb_p(nic_base+EN0_ISR) & ENISR_RESET) != 0)
531 	    break;
532 	udelay(100);
533     }
534     outb_p(ENISR_RESET, nic_base + EN0_ISR); /* Ack intr. */
535 
536     if (i == 100)
537 	netdev_err(dev, "axnet_reset_8390() did not complete\n");
538 
539 } /* axnet_reset_8390 */
540 
541 /*====================================================================*/
542 
543 static irqreturn_t ei_irq_wrapper(int irq, void *dev_id)
544 {
545     struct net_device *dev = dev_id;
546     PRIV(dev)->stale = 0;
547     return ax_interrupt(irq, dev_id);
548 }
549 
550 static void ei_watchdog(u_long arg)
551 {
552     struct net_device *dev = (struct net_device *)(arg);
553     struct axnet_dev *info = PRIV(dev);
554     unsigned int nic_base = dev->base_addr;
555     unsigned int mii_addr = nic_base + AXNET_MII_EEP;
556     u_short link;
557 
558     if (!netif_device_present(dev)) goto reschedule;
559 
560     /* Check for pending interrupt with expired latency timer: with
561        this, we can limp along even if the interrupt is blocked */
562     if (info->stale++ && (inb_p(nic_base + EN0_ISR) & ENISR_ALL)) {
563 	if (!info->fast_poll)
564 	    netdev_info(dev, "interrupt(s) dropped!\n");
565 	ei_irq_wrapper(dev->irq, dev);
566 	info->fast_poll = HZ;
567     }
568     if (info->fast_poll) {
569 	info->fast_poll--;
570 	info->watchdog.expires = jiffies + 1;
571 	add_timer(&info->watchdog);
572 	return;
573     }
574 
575     if (info->phy_id < 0)
576 	goto reschedule;
577     link = mdio_read(mii_addr, info->phy_id, 1);
578     if (!link || (link == 0xffff)) {
579 	netdev_info(dev, "MII is missing!\n");
580 	info->phy_id = -1;
581 	goto reschedule;
582     }
583 
584     link &= 0x0004;
585     if (link != info->link_status) {
586 	u_short p = mdio_read(mii_addr, info->phy_id, 5);
587 	netdev_info(dev, "%s link beat\n", link ? "found" : "lost");
588 	if (link) {
589 	    info->duplex_flag = (p & 0x0140) ? 0x80 : 0x00;
590 	    if (p)
591 		netdev_info(dev, "autonegotiation complete: %dbaseT-%cD selected\n",
592 			    (p & 0x0180) ? 100 : 10, (p & 0x0140) ? 'F' : 'H');
593 	    else
594 		netdev_info(dev, "link partner did not autonegotiate\n");
595 	    AX88190_init(dev, 1);
596 	}
597 	info->link_status = link;
598     }
599 
600 reschedule:
601     info->watchdog.expires = jiffies + HZ;
602     add_timer(&info->watchdog);
603 }
604 
605 /*====================================================================*/
606 
607 static int axnet_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
608 {
609     struct axnet_dev *info = PRIV(dev);
610     struct mii_ioctl_data *data = if_mii(rq);
611     unsigned int mii_addr = dev->base_addr + AXNET_MII_EEP;
612     switch (cmd) {
613     case SIOCGMIIPHY:
614 	data->phy_id = info->phy_id;
615     case SIOCGMIIREG:		/* Read MII PHY register. */
616 	data->val_out = mdio_read(mii_addr, data->phy_id, data->reg_num & 0x1f);
617 	return 0;
618     case SIOCSMIIREG:		/* Write MII PHY register. */
619 	mdio_write(mii_addr, data->phy_id, data->reg_num & 0x1f, data->val_in);
620 	return 0;
621     }
622     return -EOPNOTSUPP;
623 }
624 
625 /*====================================================================*/
626 
627 static void get_8390_hdr(struct net_device *dev,
628 			 struct e8390_pkt_hdr *hdr,
629 			 int ring_page)
630 {
631     unsigned int nic_base = dev->base_addr;
632 
633     outb_p(0, nic_base + EN0_RSARLO);		/* On page boundary */
634     outb_p(ring_page, nic_base + EN0_RSARHI);
635     outb_p(E8390_RREAD+E8390_START, nic_base + AXNET_CMD);
636 
637     insw(nic_base + AXNET_DATAPORT, hdr,
638 	    sizeof(struct e8390_pkt_hdr)>>1);
639     /* Fix for big endian systems */
640     hdr->count = le16_to_cpu(hdr->count);
641 
642 }
643 
644 /*====================================================================*/
645 
646 static void block_input(struct net_device *dev, int count,
647 			struct sk_buff *skb, int ring_offset)
648 {
649     unsigned int nic_base = dev->base_addr;
650     struct ei_device *ei_local = netdev_priv(dev);
651     int xfer_count = count;
652     char *buf = skb->data;
653 
654     if ((netif_msg_rx_status(ei_local)) && (count != 4))
655 	netdev_dbg(dev, "[bi=%d]\n", count+4);
656     outb_p(ring_offset & 0xff, nic_base + EN0_RSARLO);
657     outb_p(ring_offset >> 8, nic_base + EN0_RSARHI);
658     outb_p(E8390_RREAD+E8390_START, nic_base + AXNET_CMD);
659 
660     insw(nic_base + AXNET_DATAPORT,buf,count>>1);
661     if (count & 0x01)
662 	buf[count-1] = inb(nic_base + AXNET_DATAPORT), xfer_count++;
663 
664 }
665 
666 /*====================================================================*/
667 
668 static void block_output(struct net_device *dev, int count,
669 			 const u_char *buf, const int start_page)
670 {
671     unsigned int nic_base = dev->base_addr;
672 
673     pr_debug("%s: [bo=%d]\n", dev->name, count);
674 
675     /* Round the count up for word writes.  Do we need to do this?
676        What effect will an odd byte count have on the 8390?
677        I should check someday. */
678     if (count & 0x01)
679 	count++;
680 
681     outb_p(0x00, nic_base + EN0_RSARLO);
682     outb_p(start_page, nic_base + EN0_RSARHI);
683     outb_p(E8390_RWRITE+E8390_START, nic_base + AXNET_CMD);
684     outsw(nic_base + AXNET_DATAPORT, buf, count>>1);
685 }
686 
687 static const struct pcmcia_device_id axnet_ids[] = {
688 	PCMCIA_PFC_DEVICE_MANF_CARD(0, 0x016c, 0x0081),
689 	PCMCIA_DEVICE_MANF_CARD(0x018a, 0x0301),
690 	PCMCIA_DEVICE_MANF_CARD(0x01bf, 0x2328),
691 	PCMCIA_DEVICE_MANF_CARD(0x026f, 0x0301),
692 	PCMCIA_DEVICE_MANF_CARD(0x026f, 0x0303),
693 	PCMCIA_DEVICE_MANF_CARD(0x026f, 0x0309),
694 	PCMCIA_DEVICE_MANF_CARD(0x0274, 0x1106),
695 	PCMCIA_DEVICE_MANF_CARD(0x8a01, 0xc1ab),
696 	PCMCIA_DEVICE_MANF_CARD(0x021b, 0x0202),
697 	PCMCIA_DEVICE_MANF_CARD(0xffff, 0x1090),
698 	PCMCIA_DEVICE_PROD_ID12("AmbiCom,Inc.", "Fast Ethernet PC Card(AMB8110)", 0x49b020a7, 0x119cc9fc),
699 	PCMCIA_DEVICE_PROD_ID124("Fast Ethernet", "16-bit PC Card", "AX88190", 0xb4be14e3, 0x9a12eb6a, 0xab9be5ef),
700 	PCMCIA_DEVICE_PROD_ID12("ASIX", "AX88190", 0x0959823b, 0xab9be5ef),
701 	PCMCIA_DEVICE_PROD_ID12("Billionton", "LNA-100B", 0x552ab682, 0xbc3b87e1),
702 	PCMCIA_DEVICE_PROD_ID12("CHEETAH ETHERCARD", "EN2228", 0x00fa7bc8, 0x00e990cc),
703 	PCMCIA_DEVICE_PROD_ID12("CNet", "CNF301", 0xbc477dde, 0x78c5f40b),
704 	PCMCIA_DEVICE_PROD_ID12("corega K.K.", "corega FEther PCC-TXD", 0x5261440f, 0x436768c5),
705 	PCMCIA_DEVICE_PROD_ID12("corega K.K.", "corega FEtherII PCC-TXD", 0x5261440f, 0x730df72e),
706 	PCMCIA_DEVICE_PROD_ID12("corega K.K.", "corega FEther PCC-TXM", 0x5261440f, 0x3abbd061),
707 	PCMCIA_DEVICE_PROD_ID12("Dynalink", "L100C16", 0x55632fd5, 0x66bc2a90),
708 	PCMCIA_DEVICE_PROD_ID12("IO DATA", "ETXPCM", 0x547e66dc, 0x233adac2),
709 	PCMCIA_DEVICE_PROD_ID12("Linksys", "EtherFast 10/100 PC Card (PCMPC100 V3)", 0x0733cc81, 0x232019a8),
710 	PCMCIA_DEVICE_PROD_ID12("MELCO", "LPC3-TX", 0x481e0094, 0xf91af609),
711 	PCMCIA_DEVICE_PROD_ID12("NETGEAR", "FA411", 0x9aa79dc3, 0x40fad875),
712 	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "100BASE", 0x281f1c5d, 0x7c2add04),
713 	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "FastEtherCard", 0x281f1c5d, 0x7ef26116),
714 	PCMCIA_DEVICE_PROD_ID12("PCMCIA", "FEP501", 0x281f1c5d, 0x2e272058),
715 	PCMCIA_DEVICE_PROD_ID14("Network Everywhere", "AX88190", 0x820a67b6,  0xab9be5ef),
716 	PCMCIA_DEVICE_NULL,
717 };
718 MODULE_DEVICE_TABLE(pcmcia, axnet_ids);
719 
720 static struct pcmcia_driver axnet_cs_driver = {
721 	.owner		= THIS_MODULE,
722 	.name		= "axnet_cs",
723 	.probe		= axnet_probe,
724 	.remove		= axnet_detach,
725 	.id_table       = axnet_ids,
726 	.suspend	= axnet_suspend,
727 	.resume		= axnet_resume,
728 };
729 module_pcmcia_driver(axnet_cs_driver);
730 
731 /*====================================================================*/
732 
733 /* 8390.c: A general NS8390 ethernet driver core for linux. */
734 /*
735 	Written 1992-94 by Donald Becker.
736 
737 	Copyright 1993 United States Government as represented by the
738 	Director, National Security Agency.
739 
740 	This software may be used and distributed according to the terms
741 	of the GNU General Public License, incorporated herein by reference.
742 
743 	The author may be reached as becker@scyld.com, or C/O
744 	Scyld Computing Corporation
745 	410 Severn Ave., Suite 210
746 	Annapolis MD 21403
747 
748   This is the chip-specific code for many 8390-based ethernet adaptors.
749   This is not a complete driver, it must be combined with board-specific
750   code such as ne.c, wd.c, 3c503.c, etc.
751 
752   Seeing how at least eight drivers use this code, (not counting the
753   PCMCIA ones either) it is easy to break some card by what seems like
754   a simple innocent change. Please contact me or Donald if you think
755   you have found something that needs changing. -- PG
756 
757   Changelog:
758 
759   Paul Gortmaker	: remove set_bit lock, other cleanups.
760   Paul Gortmaker	: add ei_get_8390_hdr() so we can pass skb's to
761 			  ei_block_input() for eth_io_copy_and_sum().
762   Paul Gortmaker	: exchange static int ei_pingpong for a #define,
763 			  also add better Tx error handling.
764   Paul Gortmaker	: rewrite Rx overrun handling as per NS specs.
765   Alexey Kuznetsov	: use the 8390's six bit hash multicast filter.
766   Paul Gortmaker	: tweak ANK's above multicast changes a bit.
767   Paul Gortmaker	: update packet statistics for v2.1.x
768   Alan Cox		: support arbitrary stupid port mappings on the
769   			  68K Macintosh. Support >16bit I/O spaces
770   Paul Gortmaker	: add kmod support for auto-loading of the 8390
771 			  module by all drivers that require it.
772   Alan Cox		: Spinlocking work, added 'BUG_83C690'
773   Paul Gortmaker	: Separate out Tx timeout code from Tx path.
774 
775   Sources:
776   The National Semiconductor LAN Databook, and the 3Com 3c503 databook.
777 
778   */
779 
780 #include <linux/bitops.h>
781 #include <asm/irq.h>
782 #include <linux/fcntl.h>
783 #include <linux/in.h>
784 #include <linux/interrupt.h>
785 
786 #define BUG_83C690
787 
788 /* These are the operational function interfaces to board-specific
789    routines.
790 	void reset_8390(struct net_device *dev)
791 		Resets the board associated with DEV, including a hardware reset of
792 		the 8390.  This is only called when there is a transmit timeout, and
793 		it is always followed by 8390_init().
794 	void block_output(struct net_device *dev, int count, const unsigned char *buf,
795 					  int start_page)
796 		Write the COUNT bytes of BUF to the packet buffer at START_PAGE.  The
797 		"page" value uses the 8390's 256-byte pages.
798 	void get_8390_hdr(struct net_device *dev, struct e8390_hdr *hdr, int ring_page)
799 		Read the 4 byte, page aligned 8390 header. *If* there is a
800 		subsequent read, it will be of the rest of the packet.
801 	void block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
802 		Read COUNT bytes from the packet buffer into the skb data area. Start
803 		reading from RING_OFFSET, the address as the 8390 sees it.  This will always
804 		follow the read of the 8390 header.
805 */
806 #define ei_reset_8390 (ei_local->reset_8390)
807 #define ei_block_output (ei_local->block_output)
808 #define ei_block_input (ei_local->block_input)
809 #define ei_get_8390_hdr (ei_local->get_8390_hdr)
810 
811 /* Index to functions. */
812 static void ei_tx_intr(struct net_device *dev);
813 static void ei_tx_err(struct net_device *dev);
814 static void ei_receive(struct net_device *dev);
815 static void ei_rx_overrun(struct net_device *dev);
816 
817 /* Routines generic to NS8390-based boards. */
818 static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
819 								int start_page);
820 static void do_set_multicast_list(struct net_device *dev);
821 
822 /*
823  *	SMP and the 8390 setup.
824  *
825  *	The 8390 isn't exactly designed to be multithreaded on RX/TX. There is
826  *	a page register that controls bank and packet buffer access. We guard
827  *	this with ei_local->page_lock. Nobody should assume or set the page other
828  *	than zero when the lock is not held. Lock holders must restore page 0
829  *	before unlocking. Even pure readers must take the lock to protect in
830  *	page 0.
831  *
832  *	To make life difficult the chip can also be very slow. We therefore can't
833  *	just use spinlocks. For the longer lockups we disable the irq the device
834  *	sits on and hold the lock. We must hold the lock because there is a dual
835  *	processor case other than interrupts (get stats/set multicast list in
836  *	parallel with each other and transmit).
837  *
838  *	Note: in theory we can just disable the irq on the card _but_ there is
839  *	a latency on SMP irq delivery. So we can easily go "disable irq" "sync irqs"
840  *	enter lock, take the queued irq. So we waddle instead of flying.
841  *
842  *	Finally by special arrangement for the purpose of being generally
843  *	annoying the transmit function is called bh atomic. That places
844  *	restrictions on the user context callers as disable_irq won't save
845  *	them.
846  */
847 
848 /**
849  * ax_open - Open/initialize the board.
850  * @dev: network device to initialize
851  *
852  * This routine goes all-out, setting everything
853  * up anew at each open, even though many of these registers should only
854  * need to be set once at boot.
855  */
856 static int ax_open(struct net_device *dev)
857 {
858 	unsigned long flags;
859 	struct ei_device *ei_local = netdev_priv(dev);
860 
861 	/*
862 	 *	Grab the page lock so we own the register set, then call
863 	 *	the init function.
864 	 */
865 
866       	spin_lock_irqsave(&ei_local->page_lock, flags);
867 	AX88190_init(dev, 1);
868 	/* Set the flag before we drop the lock, That way the IRQ arrives
869 	   after its set and we get no silly warnings */
870 	netif_start_queue(dev);
871       	spin_unlock_irqrestore(&ei_local->page_lock, flags);
872 	ei_local->irqlock = 0;
873 	return 0;
874 }
875 
876 #define dev_lock(dev) (((struct ei_device *)netdev_priv(dev))->page_lock)
877 
878 /**
879  * ax_close - shut down network device
880  * @dev: network device to close
881  *
882  * Opposite of ax_open(). Only used when "ifconfig <devname> down" is done.
883  */
884 static int ax_close(struct net_device *dev)
885 {
886 	unsigned long flags;
887 
888 	/*
889 	 *      Hold the page lock during close
890 	 */
891 
892 	spin_lock_irqsave(&dev_lock(dev), flags);
893 	AX88190_init(dev, 0);
894 	spin_unlock_irqrestore(&dev_lock(dev), flags);
895 	netif_stop_queue(dev);
896 	return 0;
897 }
898 
899 /**
900  * axnet_tx_timeout - handle transmit time out condition
901  * @dev: network device which has apparently fallen asleep
902  *
903  * Called by kernel when device never acknowledges a transmit has
904  * completed (or failed) - i.e. never posted a Tx related interrupt.
905  */
906 
907 static void axnet_tx_timeout(struct net_device *dev)
908 {
909 	long e8390_base = dev->base_addr;
910 	struct ei_device *ei_local = netdev_priv(dev);
911 	int txsr, isr, tickssofar = jiffies - dev_trans_start(dev);
912 	unsigned long flags;
913 
914 	dev->stats.tx_errors++;
915 
916 	spin_lock_irqsave(&ei_local->page_lock, flags);
917 	txsr = inb(e8390_base+EN0_TSR);
918 	isr = inb(e8390_base+EN0_ISR);
919 	spin_unlock_irqrestore(&ei_local->page_lock, flags);
920 
921 	netdev_dbg(dev, "Tx timed out, %s TSR=%#2x, ISR=%#2x, t=%d.\n",
922 		   (txsr & ENTSR_ABT) ? "excess collisions." :
923 		   (isr) ? "lost interrupt?" : "cable problem?",
924 		   txsr, isr, tickssofar);
925 
926 	if (!isr && !dev->stats.tx_packets)
927 	{
928 		/* The 8390 probably hasn't gotten on the cable yet. */
929 		ei_local->interface_num ^= 1;   /* Try a different xcvr.  */
930 	}
931 
932 	/* Ugly but a reset can be slow, yet must be protected */
933 
934 	spin_lock_irqsave(&ei_local->page_lock, flags);
935 
936 	/* Try to restart the card.  Perhaps the user has fixed something. */
937 	ei_reset_8390(dev);
938 	AX88190_init(dev, 1);
939 
940 	spin_unlock_irqrestore(&ei_local->page_lock, flags);
941 	netif_wake_queue(dev);
942 }
943 
944 /**
945  * axnet_start_xmit - begin packet transmission
946  * @skb: packet to be sent
947  * @dev: network device to which packet is sent
948  *
949  * Sends a packet to an 8390 network device.
950  */
951 
952 static netdev_tx_t axnet_start_xmit(struct sk_buff *skb,
953 					  struct net_device *dev)
954 {
955 	long e8390_base = dev->base_addr;
956 	struct ei_device *ei_local = netdev_priv(dev);
957 	int length, send_length, output_page;
958 	unsigned long flags;
959 	u8 packet[ETH_ZLEN];
960 
961 	netif_stop_queue(dev);
962 
963 	length = skb->len;
964 
965 	/* Mask interrupts from the ethercard.
966 	   SMP: We have to grab the lock here otherwise the IRQ handler
967 	   on another CPU can flip window and race the IRQ mask set. We end
968 	   up trashing the mcast filter not disabling irqs if we don't lock */
969 
970 	spin_lock_irqsave(&ei_local->page_lock, flags);
971 	outb_p(0x00, e8390_base + EN0_IMR);
972 
973 	/*
974 	 *	Slow phase with lock held.
975 	 */
976 
977 	ei_local->irqlock = 1;
978 
979 	send_length = max(length, ETH_ZLEN);
980 
981 	/*
982 	 * We have two Tx slots available for use. Find the first free
983 	 * slot, and then perform some sanity checks. With two Tx bufs,
984 	 * you get very close to transmitting back-to-back packets. With
985 	 * only one Tx buf, the transmitter sits idle while you reload the
986 	 * card, leaving a substantial gap between each transmitted packet.
987 	 */
988 
989 	if (ei_local->tx1 == 0)
990 	{
991 		output_page = ei_local->tx_start_page;
992 		ei_local->tx1 = send_length;
993 		if ((netif_msg_tx_queued(ei_local)) &&
994 		    ei_local->tx2 > 0)
995 			netdev_dbg(dev,
996 				   "idle transmitter tx2=%d, lasttx=%d, txing=%d\n",
997 				   ei_local->tx2, ei_local->lasttx,
998 				   ei_local->txing);
999 	}
1000 	else if (ei_local->tx2 == 0)
1001 	{
1002 		output_page = ei_local->tx_start_page + TX_PAGES/2;
1003 		ei_local->tx2 = send_length;
1004 		if ((netif_msg_tx_queued(ei_local)) &&
1005 		    ei_local->tx1 > 0)
1006 			netdev_dbg(dev,
1007 				   "idle transmitter, tx1=%d, lasttx=%d, txing=%d\n",
1008 				   ei_local->tx1, ei_local->lasttx,
1009 				   ei_local->txing);
1010 	}
1011 	else
1012 	{	/* We should never get here. */
1013 		netif_dbg(ei_local, tx_err, dev,
1014 			  "No Tx buffers free! tx1=%d tx2=%d last=%d\n",
1015 			  ei_local->tx1, ei_local->tx2,
1016 			  ei_local->lasttx);
1017 		ei_local->irqlock = 0;
1018 		netif_stop_queue(dev);
1019 		outb_p(ENISR_ALL, e8390_base + EN0_IMR);
1020 		spin_unlock_irqrestore(&ei_local->page_lock, flags);
1021 		dev->stats.tx_errors++;
1022 		return NETDEV_TX_BUSY;
1023 	}
1024 
1025 	/*
1026 	 * Okay, now upload the packet and trigger a send if the transmitter
1027 	 * isn't already sending. If it is busy, the interrupt handler will
1028 	 * trigger the send later, upon receiving a Tx done interrupt.
1029 	 */
1030 
1031 	if (length == skb->len)
1032 		ei_block_output(dev, length, skb->data, output_page);
1033 	else {
1034 		memset(packet, 0, ETH_ZLEN);
1035 		skb_copy_from_linear_data(skb, packet, skb->len);
1036 		ei_block_output(dev, length, packet, output_page);
1037 	}
1038 
1039 	if (! ei_local->txing)
1040 	{
1041 		ei_local->txing = 1;
1042 		NS8390_trigger_send(dev, send_length, output_page);
1043 		netif_trans_update(dev);
1044 		if (output_page == ei_local->tx_start_page)
1045 		{
1046 			ei_local->tx1 = -1;
1047 			ei_local->lasttx = -1;
1048 		}
1049 		else
1050 		{
1051 			ei_local->tx2 = -1;
1052 			ei_local->lasttx = -2;
1053 		}
1054 	}
1055 	else ei_local->txqueue++;
1056 
1057 	if (ei_local->tx1  &&  ei_local->tx2)
1058 		netif_stop_queue(dev);
1059 	else
1060 		netif_start_queue(dev);
1061 
1062 	/* Turn 8390 interrupts back on. */
1063 	ei_local->irqlock = 0;
1064 	outb_p(ENISR_ALL, e8390_base + EN0_IMR);
1065 
1066 	spin_unlock_irqrestore(&ei_local->page_lock, flags);
1067 
1068 	dev_kfree_skb (skb);
1069 	dev->stats.tx_bytes += send_length;
1070 
1071 	return NETDEV_TX_OK;
1072 }
1073 
1074 /**
1075  * ax_interrupt - handle the interrupts from an 8390
1076  * @irq: interrupt number
1077  * @dev_id: a pointer to the net_device
1078  *
1079  * Handle the ether interface interrupts. We pull packets from
1080  * the 8390 via the card specific functions and fire them at the networking
1081  * stack. We also handle transmit completions and wake the transmit path if
1082  * necessary. We also update the counters and do other housekeeping as
1083  * needed.
1084  */
1085 
1086 static irqreturn_t ax_interrupt(int irq, void *dev_id)
1087 {
1088 	struct net_device *dev = dev_id;
1089 	long e8390_base;
1090 	int interrupts, nr_serviced = 0, i;
1091 	struct ei_device *ei_local;
1092     	int handled = 0;
1093 	unsigned long flags;
1094 
1095 	e8390_base = dev->base_addr;
1096 	ei_local = netdev_priv(dev);
1097 
1098 	/*
1099 	 *	Protect the irq test too.
1100 	 */
1101 
1102 	spin_lock_irqsave(&ei_local->page_lock, flags);
1103 
1104 	if (ei_local->irqlock) {
1105 #if 1 /* This might just be an interrupt for a PCI device sharing this line */
1106 		const char *msg;
1107 		/* The "irqlock" check is only for testing. */
1108 		if (ei_local->irqlock)
1109 			msg = "Interrupted while interrupts are masked!";
1110 		else
1111 			msg = "Reentering the interrupt handler!";
1112 		netdev_info(dev, "%s, isr=%#2x imr=%#2x\n",
1113 			    msg,
1114 			    inb_p(e8390_base + EN0_ISR),
1115 			    inb_p(e8390_base + EN0_IMR));
1116 #endif
1117 		spin_unlock_irqrestore(&ei_local->page_lock, flags);
1118 		return IRQ_NONE;
1119 	}
1120 
1121 	netif_dbg(ei_local, intr, dev, "interrupt(isr=%#2.2x)\n",
1122 		  inb_p(e8390_base + EN0_ISR));
1123 
1124 	outb_p(0x00, e8390_base + EN0_ISR);
1125 	ei_local->irqlock = 1;
1126 
1127 	/* !!Assumption!! -- we stay in page 0.	 Don't break this. */
1128 	while ((interrupts = inb_p(e8390_base + EN0_ISR)) != 0 &&
1129 	       ++nr_serviced < MAX_SERVICE)
1130 	{
1131 		if (!netif_running(dev) || (interrupts == 0xff)) {
1132 			netif_warn(ei_local, intr, dev,
1133 				   "interrupt from stopped card\n");
1134 			outb_p(interrupts, e8390_base + EN0_ISR);
1135 			interrupts = 0;
1136 			break;
1137 		}
1138 		handled = 1;
1139 
1140 		/* AX88190 bug fix. */
1141 		outb_p(interrupts, e8390_base + EN0_ISR);
1142 		for (i = 0; i < 10; i++) {
1143 			if (!(inb(e8390_base + EN0_ISR) & interrupts))
1144 				break;
1145 			outb_p(0, e8390_base + EN0_ISR);
1146 			outb_p(interrupts, e8390_base + EN0_ISR);
1147 		}
1148 		if (interrupts & ENISR_OVER)
1149 			ei_rx_overrun(dev);
1150 		else if (interrupts & (ENISR_RX+ENISR_RX_ERR))
1151 		{
1152 			/* Got a good (?) packet. */
1153 			ei_receive(dev);
1154 		}
1155 		/* Push the next to-transmit packet through. */
1156 		if (interrupts & ENISR_TX)
1157 			ei_tx_intr(dev);
1158 		else if (interrupts & ENISR_TX_ERR)
1159 			ei_tx_err(dev);
1160 
1161 		if (interrupts & ENISR_COUNTERS)
1162 		{
1163 			dev->stats.rx_frame_errors += inb_p(e8390_base + EN0_COUNTER0);
1164 			dev->stats.rx_crc_errors   += inb_p(e8390_base + EN0_COUNTER1);
1165 			dev->stats.rx_missed_errors+= inb_p(e8390_base + EN0_COUNTER2);
1166 		}
1167 	}
1168 
1169 	if (interrupts && (netif_msg_intr(ei_local)))
1170 	{
1171 		handled = 1;
1172 		if (nr_serviced >= MAX_SERVICE)
1173 		{
1174 			/* 0xFF is valid for a card removal */
1175 			if (interrupts != 0xFF)
1176 				netdev_warn(dev,
1177 					    "Too much work at interrupt, status %#2.2x\n",
1178 					    interrupts);
1179 			outb_p(ENISR_ALL, e8390_base + EN0_ISR); /* Ack. most intrs. */
1180 		} else {
1181 			netdev_warn(dev, "unknown interrupt %#2x\n",
1182 				    interrupts);
1183 			outb_p(0xff, e8390_base + EN0_ISR); /* Ack. all intrs. */
1184 		}
1185 	}
1186 
1187 	/* Turn 8390 interrupts back on. */
1188 	ei_local->irqlock = 0;
1189 	outb_p(ENISR_ALL, e8390_base + EN0_IMR);
1190 
1191 	spin_unlock_irqrestore(&ei_local->page_lock, flags);
1192 	return IRQ_RETVAL(handled);
1193 }
1194 
1195 /**
1196  * ei_tx_err - handle transmitter error
1197  * @dev: network device which threw the exception
1198  *
1199  * A transmitter error has happened. Most likely excess collisions (which
1200  * is a fairly normal condition). If the error is one where the Tx will
1201  * have been aborted, we try and send another one right away, instead of
1202  * letting the failed packet sit and collect dust in the Tx buffer. This
1203  * is a much better solution as it avoids kernel based Tx timeouts, and
1204  * an unnecessary card reset.
1205  *
1206  * Called with lock held.
1207  */
1208 
1209 static void ei_tx_err(struct net_device *dev)
1210 {
1211 	long e8390_base = dev->base_addr;
1212 	unsigned char txsr = inb_p(e8390_base+EN0_TSR);
1213 	unsigned char tx_was_aborted = txsr & (ENTSR_ABT+ENTSR_FU);
1214 
1215 #ifdef VERBOSE_ERROR_DUMP
1216 	netdev_dbg(dev, "transmitter error (%#2x):", txsr);
1217 	if (txsr & ENTSR_ABT)
1218 		pr_cont(" excess-collisions");
1219 	if (txsr & ENTSR_ND)
1220 		pr_cont(" non-deferral");
1221 	if (txsr & ENTSR_CRS)
1222 		pr_cont(" lost-carrier");
1223 	if (txsr & ENTSR_FU)
1224 		pr_cont(" FIFO-underrun");
1225 	if (txsr & ENTSR_CDH)
1226 		pr_cont(" lost-heartbeat");
1227 	pr_cont("\n");
1228 #endif
1229 
1230 	if (tx_was_aborted)
1231 		ei_tx_intr(dev);
1232 	else
1233 	{
1234 		dev->stats.tx_errors++;
1235 		if (txsr & ENTSR_CRS) dev->stats.tx_carrier_errors++;
1236 		if (txsr & ENTSR_CDH) dev->stats.tx_heartbeat_errors++;
1237 		if (txsr & ENTSR_OWC) dev->stats.tx_window_errors++;
1238 	}
1239 }
1240 
1241 /**
1242  * ei_tx_intr - transmit interrupt handler
1243  * @dev: network device for which tx intr is handled
1244  *
1245  * We have finished a transmit: check for errors and then trigger the next
1246  * packet to be sent. Called with lock held.
1247  */
1248 
1249 static void ei_tx_intr(struct net_device *dev)
1250 {
1251 	long e8390_base = dev->base_addr;
1252 	struct ei_device *ei_local = netdev_priv(dev);
1253 	int status = inb(e8390_base + EN0_TSR);
1254 
1255 	/*
1256 	 * There are two Tx buffers, see which one finished, and trigger
1257 	 * the send of another one if it exists.
1258 	 */
1259 	ei_local->txqueue--;
1260 
1261 	if (ei_local->tx1 < 0)
1262 	{
1263 		if (ei_local->lasttx != 1 && ei_local->lasttx != -1)
1264 			netdev_err(dev, "%s: bogus last_tx_buffer %d, tx1=%d\n",
1265 				   ei_local->name, ei_local->lasttx,
1266 				   ei_local->tx1);
1267 		ei_local->tx1 = 0;
1268 		if (ei_local->tx2 > 0)
1269 		{
1270 			ei_local->txing = 1;
1271 			NS8390_trigger_send(dev, ei_local->tx2, ei_local->tx_start_page + 6);
1272 			netif_trans_update(dev);
1273 			ei_local->tx2 = -1,
1274 			ei_local->lasttx = 2;
1275 		}
1276 		else ei_local->lasttx = 20, ei_local->txing = 0;
1277 	}
1278 	else if (ei_local->tx2 < 0)
1279 	{
1280 		if (ei_local->lasttx != 2  &&  ei_local->lasttx != -2)
1281 			netdev_err(dev, "%s: bogus last_tx_buffer %d, tx2=%d\n",
1282 				   ei_local->name, ei_local->lasttx,
1283 				   ei_local->tx2);
1284 		ei_local->tx2 = 0;
1285 		if (ei_local->tx1 > 0)
1286 		{
1287 			ei_local->txing = 1;
1288 			NS8390_trigger_send(dev, ei_local->tx1, ei_local->tx_start_page);
1289 			netif_trans_update(dev);
1290 			ei_local->tx1 = -1;
1291 			ei_local->lasttx = 1;
1292 		}
1293 		else
1294 			ei_local->lasttx = 10, ei_local->txing = 0;
1295 	}
1296 //	else
1297 //		netdev_warn(dev, "unexpected TX-done interrupt, lasttx=%d\n",
1298 //			    ei_local->lasttx);
1299 
1300 	/* Minimize Tx latency: update the statistics after we restart TXing. */
1301 	if (status & ENTSR_COL)
1302 		dev->stats.collisions++;
1303 	if (status & ENTSR_PTX)
1304 		dev->stats.tx_packets++;
1305 	else
1306 	{
1307 		dev->stats.tx_errors++;
1308 		if (status & ENTSR_ABT)
1309 		{
1310 			dev->stats.tx_aborted_errors++;
1311 			dev->stats.collisions += 16;
1312 		}
1313 		if (status & ENTSR_CRS)
1314 			dev->stats.tx_carrier_errors++;
1315 		if (status & ENTSR_FU)
1316 			dev->stats.tx_fifo_errors++;
1317 		if (status & ENTSR_CDH)
1318 			dev->stats.tx_heartbeat_errors++;
1319 		if (status & ENTSR_OWC)
1320 			dev->stats.tx_window_errors++;
1321 	}
1322 	netif_wake_queue(dev);
1323 }
1324 
1325 /**
1326  * ei_receive - receive some packets
1327  * @dev: network device with which receive will be run
1328  *
1329  * We have a good packet(s), get it/them out of the buffers.
1330  * Called with lock held.
1331  */
1332 
1333 static void ei_receive(struct net_device *dev)
1334 {
1335 	long e8390_base = dev->base_addr;
1336 	struct ei_device *ei_local = netdev_priv(dev);
1337 	unsigned char rxing_page, this_frame, next_frame;
1338 	unsigned short current_offset;
1339 	int rx_pkt_count = 0;
1340 	struct e8390_pkt_hdr rx_frame;
1341 
1342 	while (++rx_pkt_count < 10)
1343 	{
1344 		int pkt_len, pkt_stat;
1345 
1346 		/* Get the rx page (incoming packet pointer). */
1347 		rxing_page = inb_p(e8390_base + EN1_CURPAG -1);
1348 
1349 		/* Remove one frame from the ring.  Boundary is always a page behind. */
1350 		this_frame = inb_p(e8390_base + EN0_BOUNDARY) + 1;
1351 		if (this_frame >= ei_local->stop_page)
1352 			this_frame = ei_local->rx_start_page;
1353 
1354 		/* Someday we'll omit the previous, iff we never get this message.
1355 		   (There is at least one clone claimed to have a problem.)
1356 
1357 		   Keep quiet if it looks like a card removal. One problem here
1358 		   is that some clones crash in roughly the same way.
1359 		 */
1360 		if ((netif_msg_rx_err(ei_local)) &&
1361 		    this_frame != ei_local->current_page &&
1362 		    (this_frame != 0x0 || rxing_page != 0xFF))
1363 			netdev_err(dev, "mismatched read page pointers %2x vs %2x\n",
1364 				   this_frame, ei_local->current_page);
1365 
1366 		if (this_frame == rxing_page)	/* Read all the frames? */
1367 			break;				/* Done for now */
1368 
1369 		current_offset = this_frame << 8;
1370 		ei_get_8390_hdr(dev, &rx_frame, this_frame);
1371 
1372 		pkt_len = rx_frame.count - sizeof(struct e8390_pkt_hdr);
1373 		pkt_stat = rx_frame.status;
1374 
1375 		next_frame = this_frame + 1 + ((pkt_len+4)>>8);
1376 
1377 		if (pkt_len < 60  ||  pkt_len > 1518)
1378 		{
1379 			netif_err(ei_local, rx_err, dev,
1380 				  "bogus packet size: %d, status=%#2x nxpg=%#2x\n",
1381 				  rx_frame.count, rx_frame.status,
1382 				  rx_frame.next);
1383 			dev->stats.rx_errors++;
1384 			dev->stats.rx_length_errors++;
1385 		}
1386 		 else if ((pkt_stat & 0x0F) == ENRSR_RXOK)
1387 		{
1388 			struct sk_buff *skb;
1389 
1390 			skb = netdev_alloc_skb(dev, pkt_len + 2);
1391 			if (skb == NULL)
1392 			{
1393 				netif_err(ei_local, rx_err, dev,
1394 					  "Couldn't allocate a sk_buff of size %d\n",
1395 					  pkt_len);
1396 				dev->stats.rx_dropped++;
1397 				break;
1398 			}
1399 			else
1400 			{
1401 				skb_reserve(skb,2);	/* IP headers on 16 byte boundaries */
1402 				skb_put(skb, pkt_len);	/* Make room */
1403 				ei_block_input(dev, pkt_len, skb, current_offset + sizeof(rx_frame));
1404 				skb->protocol=eth_type_trans(skb,dev);
1405 				netif_rx(skb);
1406 				dev->stats.rx_packets++;
1407 				dev->stats.rx_bytes += pkt_len;
1408 				if (pkt_stat & ENRSR_PHY)
1409 					dev->stats.multicast++;
1410 			}
1411 		}
1412 		else
1413 		{
1414 			netif_err(ei_local, rx_err, dev,
1415 				  "bogus packet: status=%#2x nxpg=%#2x size=%d\n",
1416 				  rx_frame.status, rx_frame.next,
1417 				  rx_frame.count);
1418 			dev->stats.rx_errors++;
1419 			/* NB: The NIC counts CRC, frame and missed errors. */
1420 			if (pkt_stat & ENRSR_FO)
1421 				dev->stats.rx_fifo_errors++;
1422 		}
1423 		next_frame = rx_frame.next;
1424 
1425 		/* This _should_ never happen: it's here for avoiding bad clones. */
1426 		if (next_frame >= ei_local->stop_page) {
1427 			netdev_info(dev, "next frame inconsistency, %#2x\n",
1428 				    next_frame);
1429 			next_frame = ei_local->rx_start_page;
1430 		}
1431 		ei_local->current_page = next_frame;
1432 		outb_p(next_frame-1, e8390_base+EN0_BOUNDARY);
1433 	}
1434 }
1435 
1436 /**
1437  * ei_rx_overrun - handle receiver overrun
1438  * @dev: network device which threw exception
1439  *
1440  * We have a receiver overrun: we have to kick the 8390 to get it started
1441  * again. Problem is that you have to kick it exactly as NS prescribes in
1442  * the updated datasheets, or "the NIC may act in an unpredictable manner."
1443  * This includes causing "the NIC to defer indefinitely when it is stopped
1444  * on a busy network."  Ugh.
1445  * Called with lock held. Don't call this with the interrupts off or your
1446  * computer will hate you - it takes 10ms or so.
1447  */
1448 
1449 static void ei_rx_overrun(struct net_device *dev)
1450 {
1451 	struct axnet_dev *info = PRIV(dev);
1452 	long e8390_base = dev->base_addr;
1453 	unsigned char was_txing, must_resend = 0;
1454 	struct ei_device *ei_local = netdev_priv(dev);
1455 
1456 	/*
1457 	 * Record whether a Tx was in progress and then issue the
1458 	 * stop command.
1459 	 */
1460 	was_txing = inb_p(e8390_base+E8390_CMD) & E8390_TRANS;
1461 	outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
1462 
1463 	netif_dbg(ei_local, rx_err, dev, "Receiver overrun\n");
1464 	dev->stats.rx_over_errors++;
1465 
1466 	/*
1467 	 * Wait a full Tx time (1.2ms) + some guard time, NS says 1.6ms total.
1468 	 * We wait at least 2ms.
1469 	 */
1470 
1471 	mdelay(2);
1472 
1473 	/*
1474 	 * Reset RBCR[01] back to zero as per magic incantation.
1475 	 */
1476 	outb_p(0x00, e8390_base+EN0_RCNTLO);
1477 	outb_p(0x00, e8390_base+EN0_RCNTHI);
1478 
1479 	/*
1480 	 * See if any Tx was interrupted or not. According to NS, this
1481 	 * step is vital, and skipping it will cause no end of havoc.
1482 	 */
1483 
1484 	if (was_txing)
1485 	{
1486 		unsigned char tx_completed = inb_p(e8390_base+EN0_ISR) & (ENISR_TX+ENISR_TX_ERR);
1487 		if (!tx_completed)
1488 			must_resend = 1;
1489 	}
1490 
1491 	/*
1492 	 * Have to enter loopback mode and then restart the NIC before
1493 	 * you are allowed to slurp packets up off the ring.
1494 	 */
1495 	outb_p(E8390_TXOFF, e8390_base + EN0_TXCR);
1496 	outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START, e8390_base + E8390_CMD);
1497 
1498 	/*
1499 	 * Clear the Rx ring of all the debris, and ack the interrupt.
1500 	 */
1501 	ei_receive(dev);
1502 
1503 	/*
1504 	 * Leave loopback mode, and resend any packet that got stopped.
1505 	 */
1506 	outb_p(E8390_TXCONFIG | info->duplex_flag, e8390_base + EN0_TXCR);
1507 	if (must_resend)
1508     		outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START + E8390_TRANS, e8390_base + E8390_CMD);
1509 }
1510 
1511 /*
1512  *	Collect the stats. This is called unlocked and from several contexts.
1513  */
1514 
1515 static struct net_device_stats *get_stats(struct net_device *dev)
1516 {
1517 	long ioaddr = dev->base_addr;
1518 	struct ei_device *ei_local = netdev_priv(dev);
1519 	unsigned long flags;
1520 
1521 	/* If the card is stopped, just return the present stats. */
1522 	if (!netif_running(dev))
1523 		return &dev->stats;
1524 
1525 	spin_lock_irqsave(&ei_local->page_lock,flags);
1526 	/* Read the counter registers, assuming we are in page 0. */
1527 	dev->stats.rx_frame_errors += inb_p(ioaddr + EN0_COUNTER0);
1528 	dev->stats.rx_crc_errors   += inb_p(ioaddr + EN0_COUNTER1);
1529 	dev->stats.rx_missed_errors+= inb_p(ioaddr + EN0_COUNTER2);
1530 	spin_unlock_irqrestore(&ei_local->page_lock, flags);
1531 
1532 	return &dev->stats;
1533 }
1534 
1535 /*
1536  * Form the 64 bit 8390 multicast table from the linked list of addresses
1537  * associated with this dev structure.
1538  */
1539 
1540 static inline void make_mc_bits(u8 *bits, struct net_device *dev)
1541 {
1542 	struct netdev_hw_addr *ha;
1543 	u32 crc;
1544 
1545 	netdev_for_each_mc_addr(ha, dev) {
1546 		crc = ether_crc(ETH_ALEN, ha->addr);
1547 		/*
1548 		 * The 8390 uses the 6 most significant bits of the
1549 		 * CRC to index the multicast table.
1550 		 */
1551 		bits[crc>>29] |= (1<<((crc>>26)&7));
1552 	}
1553 }
1554 
1555 /**
1556  * do_set_multicast_list - set/clear multicast filter
1557  * @dev: net device for which multicast filter is adjusted
1558  *
1559  *	Set or clear the multicast filter for this adaptor.
1560  *	Must be called with lock held.
1561  */
1562 
1563 static void do_set_multicast_list(struct net_device *dev)
1564 {
1565 	long e8390_base = dev->base_addr;
1566 	int i;
1567 	struct ei_device *ei_local = netdev_priv(dev);
1568 
1569 	if (!(dev->flags&(IFF_PROMISC|IFF_ALLMULTI))) {
1570 		memset(ei_local->mcfilter, 0, 8);
1571 		if (!netdev_mc_empty(dev))
1572 			make_mc_bits(ei_local->mcfilter, dev);
1573 	} else {
1574 		/* set to accept-all */
1575 		memset(ei_local->mcfilter, 0xFF, 8);
1576 	}
1577 
1578 	outb_p(E8390_NODMA + E8390_PAGE1, e8390_base + E8390_CMD);
1579 	for(i = 0; i < 8; i++)
1580 	{
1581 		outb_p(ei_local->mcfilter[i], e8390_base + EN1_MULT_SHIFT(i));
1582 	}
1583 	outb_p(E8390_NODMA + E8390_PAGE0, e8390_base + E8390_CMD);
1584 
1585   	if(dev->flags&IFF_PROMISC)
1586   		outb_p(E8390_RXCONFIG | 0x58, e8390_base + EN0_RXCR);
1587 	else if (dev->flags & IFF_ALLMULTI || !netdev_mc_empty(dev))
1588   		outb_p(E8390_RXCONFIG | 0x48, e8390_base + EN0_RXCR);
1589   	else
1590   		outb_p(E8390_RXCONFIG | 0x40, e8390_base + EN0_RXCR);
1591 
1592 	outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base+E8390_CMD);
1593 }
1594 
1595 /*
1596  *	Called without lock held. This is invoked from user context and may
1597  *	be parallel to just about everything else. Its also fairly quick and
1598  *	not called too often. Must protect against both bh and irq users
1599  */
1600 
1601 static void set_multicast_list(struct net_device *dev)
1602 {
1603 	unsigned long flags;
1604 
1605 	spin_lock_irqsave(&dev_lock(dev), flags);
1606 	do_set_multicast_list(dev);
1607 	spin_unlock_irqrestore(&dev_lock(dev), flags);
1608 }
1609 
1610 /* This page of functions should be 8390 generic */
1611 /* Follow National Semi's recommendations for initializing the "NIC". */
1612 
1613 /**
1614  * AX88190_init - initialize 8390 hardware
1615  * @dev: network device to initialize
1616  * @startp: boolean.  non-zero value to initiate chip processing
1617  *
1618  *	Must be called with lock held.
1619  */
1620 
1621 static void AX88190_init(struct net_device *dev, int startp)
1622 {
1623 	struct axnet_dev *info = PRIV(dev);
1624 	long e8390_base = dev->base_addr;
1625 	struct ei_device *ei_local = netdev_priv(dev);
1626 	int i;
1627 	int endcfg = ei_local->word16 ? (0x48 | ENDCFG_WTS) : 0x48;
1628 
1629 	if(sizeof(struct e8390_pkt_hdr)!=4)
1630     		panic("8390.c: header struct mispacked\n");
1631 	/* Follow National Semi's recommendations for initing the DP83902. */
1632 	outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD); /* 0x21 */
1633 	outb_p(endcfg, e8390_base + EN0_DCFG);	/* 0x48 or 0x49 */
1634 	/* Clear the remote byte count registers. */
1635 	outb_p(0x00,  e8390_base + EN0_RCNTLO);
1636 	outb_p(0x00,  e8390_base + EN0_RCNTHI);
1637 	/* Set to monitor and loopback mode -- this is vital!. */
1638 	outb_p(E8390_RXOFF|0x40, e8390_base + EN0_RXCR); /* 0x60 */
1639 	outb_p(E8390_TXOFF, e8390_base + EN0_TXCR); /* 0x02 */
1640 	/* Set the transmit page and receive ring. */
1641 	outb_p(ei_local->tx_start_page, e8390_base + EN0_TPSR);
1642 	ei_local->tx1 = ei_local->tx2 = 0;
1643 	outb_p(ei_local->rx_start_page, e8390_base + EN0_STARTPG);
1644 	outb_p(ei_local->stop_page-1, e8390_base + EN0_BOUNDARY);	/* 3c503 says 0x3f,NS0x26*/
1645 	ei_local->current_page = ei_local->rx_start_page;		/* assert boundary+1 */
1646 	outb_p(ei_local->stop_page, e8390_base + EN0_STOPPG);
1647 	/* Clear the pending interrupts and mask. */
1648 	outb_p(0xFF, e8390_base + EN0_ISR);
1649 	outb_p(0x00,  e8390_base + EN0_IMR);
1650 
1651 	/* Copy the station address into the DS8390 registers. */
1652 
1653 	outb_p(E8390_NODMA + E8390_PAGE1 + E8390_STOP, e8390_base+E8390_CMD); /* 0x61 */
1654 	for(i = 0; i < 6; i++)
1655 	{
1656 		outb_p(dev->dev_addr[i], e8390_base + EN1_PHYS_SHIFT(i));
1657 		if(inb_p(e8390_base + EN1_PHYS_SHIFT(i))!=dev->dev_addr[i])
1658 			netdev_err(dev, "Hw. address read/write mismap %d\n", i);
1659 	}
1660 
1661 	outb_p(ei_local->rx_start_page, e8390_base + EN1_CURPAG);
1662 	outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
1663 
1664 	netif_start_queue(dev);
1665 	ei_local->tx1 = ei_local->tx2 = 0;
1666 	ei_local->txing = 0;
1667 
1668 	if (info->flags & IS_AX88790)	/* select Internal PHY */
1669 		outb(0x10, e8390_base + AXNET_GPIO);
1670 
1671 	if (startp)
1672 	{
1673 		outb_p(0xff,  e8390_base + EN0_ISR);
1674 		outb_p(ENISR_ALL,  e8390_base + EN0_IMR);
1675 		outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base+E8390_CMD);
1676 		outb_p(E8390_TXCONFIG | info->duplex_flag,
1677 		       e8390_base + EN0_TXCR); /* xmit on. */
1678 		/* 3c503 TechMan says rxconfig only after the NIC is started. */
1679 		outb_p(E8390_RXCONFIG | 0x40, e8390_base + EN0_RXCR); /* rx on, */
1680 		do_set_multicast_list(dev);	/* (re)load the mcast table */
1681 	}
1682 }
1683 
1684 /* Trigger a transmit start, assuming the length is valid.
1685    Always called with the page lock held */
1686 
1687 static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
1688 								int start_page)
1689 {
1690 	long e8390_base = dev->base_addr;
1691  	struct ei_device *ei_local __attribute((unused)) = netdev_priv(dev);
1692 
1693 	if (inb_p(e8390_base) & E8390_TRANS)
1694 	{
1695 		netdev_warn(dev, "trigger_send() called with the transmitter busy\n");
1696 		return;
1697 	}
1698 	outb_p(length & 0xff, e8390_base + EN0_TCNTLO);
1699 	outb_p(length >> 8, e8390_base + EN0_TCNTHI);
1700 	outb_p(start_page, e8390_base + EN0_TPSR);
1701 	outb_p(E8390_NODMA+E8390_TRANS+E8390_START, e8390_base+E8390_CMD);
1702 }
1703