2 * linux/drivers/acorn/net/etherh.c
4 * Copyright (C) 2000-2002 Russell King
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * NS8390 I-cubed EtherH and ANT EtherM specific driver
11 * Thanks to I-Cubed for information on their cards.
12 * EtherM conversion (C) 1999 Chris Kemp and Tim Watterton
13 * EtherM integration (C) 2000 Aleph One Ltd (Tak-Shing Chan)
14 * EtherM integration re-engineered by Russell King.
17 * 08-12-1996 RMK 1.00 Created
18 * RMK 1.03 Added support for EtherLan500 cards
19 * 23-11-1997 RMK 1.04 Added media autodetection
20 * 16-04-1998 RMK 1.05 Improved media autodetection
21 * 10-02-2000 RMK 1.06 Updated for 2.3.43
22 * 13-05-2000 RMK 1.07 Updated for 2.3.99-pre8
23 * 12-10-1999 CK/TEW EtherM driver first release
24 * 21-12-2000 TTC EtherH/EtherM integration
25 * 25-12-2000 RMK 1.08 Clean integration of EtherM into this driver.
26 * 03-01-2002 RMK 1.09 Always enable IRQs if we're in the nic slot.
29 #include <linux/module.h>
30 #include <linux/kernel.h>
31 #include <linux/types.h>
32 #include <linux/fcntl.h>
33 #include <linux/interrupt.h>
34 #include <linux/ioport.h>
36 #include <linux/slab.h>
37 #include <linux/string.h>
38 #include <linux/errno.h>
39 #include <linux/netdevice.h>
40 #include <linux/etherdevice.h>
41 #include <linux/ethtool.h>
42 #include <linux/skbuff.h>
43 #include <linux/delay.h>
44 #include <linux/device.h>
45 #include <linux/init.h>
46 #include <linux/bitops.h>
47 #include <linux/jiffies.h>
49 #include <asm/system.h>
50 #include <asm/ecard.h>
53 #define EI_SHIFT(x) (ei_local->reg_offset[x])
55 #define ei_inb(_p) readb((void __iomem *)_p)
56 #define ei_outb(_v,_p) writeb(_v,(void __iomem *)_p)
57 #define ei_inb_p(_p) readb((void __iomem *)_p)
58 #define ei_outb_p(_v,_p) writeb(_v,(void __iomem *)_p)
63 #define DRV_NAME "etherh"
64 #define DRV_VERSION "1.11"
66 static char version[] __initdata =
67 "EtherH/EtherM Driver (c) 2002-2004 Russell King " DRV_VERSION "\n";
69 #include "../lib8390.c"
71 static unsigned int net_debug = NET_DEBUG;
74 void __iomem *ioc_fast;
76 void __iomem *dma_base;
78 void __iomem *ctrl_port;
84 unsigned long ns8390_offset;
85 unsigned long dataport_offset;
86 unsigned long ctrlport_offset;
90 unsigned char tx_start_page;
91 unsigned char stop_page;
94 MODULE_AUTHOR("Russell King");
95 MODULE_DESCRIPTION("EtherH/EtherM driver");
96 MODULE_LICENSE("GPL");
98 #define ETHERH500_DATAPORT 0x800 /* MEMC */
99 #define ETHERH500_NS8390 0x000 /* MEMC */
100 #define ETHERH500_CTRLPORT 0x800 /* IOC */
102 #define ETHERH600_DATAPORT 0x040 /* MEMC */
103 #define ETHERH600_NS8390 0x800 /* MEMC */
104 #define ETHERH600_CTRLPORT 0x200 /* MEMC */
106 #define ETHERH_CP_IE 1
107 #define ETHERH_CP_IF 2
108 #define ETHERH_CP_HEARTBEAT 2
110 #define ETHERH_TX_START_PAGE 1
111 #define ETHERH_STOP_PAGE 127
114 * These came from CK/TEW
116 #define ETHERM_DATAPORT 0x200 /* MEMC */
117 #define ETHERM_NS8390 0x800 /* MEMC */
118 #define ETHERM_CTRLPORT 0x23c /* MEMC */
120 #define ETHERM_TX_START_PAGE 64
121 #define ETHERM_STOP_PAGE 127
123 /* ------------------------------------------------------------------------ */
125 #define etherh_priv(dev) \
126 ((struct etherh_priv *)(((char *)netdev_priv(dev)) + sizeof(struct ei_device)))
128 static inline void etherh_set_ctrl(struct etherh_priv *eh, unsigned char mask)
130 unsigned char ctrl = eh->ctrl | mask;
132 writeb(ctrl, eh->ctrl_port);
135 static inline void etherh_clr_ctrl(struct etherh_priv *eh, unsigned char mask)
137 unsigned char ctrl = eh->ctrl & ~mask;
139 writeb(ctrl, eh->ctrl_port);
142 static inline unsigned int etherh_get_stat(struct etherh_priv *eh)
144 return readb(eh->ctrl_port);
150 static void etherh_irq_enable(ecard_t *ec, int irqnr)
152 struct etherh_priv *eh = ec->irq_data;
154 etherh_set_ctrl(eh, ETHERH_CP_IE);
157 static void etherh_irq_disable(ecard_t *ec, int irqnr)
159 struct etherh_priv *eh = ec->irq_data;
161 etherh_clr_ctrl(eh, ETHERH_CP_IE);
164 static expansioncard_ops_t etherh_ops = {
165 .irqenable = etherh_irq_enable,
166 .irqdisable = etherh_irq_disable,
173 etherh_setif(struct net_device *dev)
175 struct ei_device *ei_local = netdev_priv(dev);
179 local_irq_save(flags);
181 /* set the interface type */
182 switch (etherh_priv(dev)->id) {
183 case PROD_I3_ETHERLAN600:
184 case PROD_I3_ETHERLAN600A:
185 addr = (void __iomem *)dev->base_addr + EN0_RCNTHI;
187 switch (dev->if_port) {
188 case IF_PORT_10BASE2:
189 writeb((readb(addr) & 0xf8) | 1, addr);
191 case IF_PORT_10BASET:
192 writeb((readb(addr) & 0xf8), addr);
197 case PROD_I3_ETHERLAN500:
198 switch (dev->if_port) {
199 case IF_PORT_10BASE2:
200 etherh_clr_ctrl(etherh_priv(dev), ETHERH_CP_IF);
203 case IF_PORT_10BASET:
204 etherh_set_ctrl(etherh_priv(dev), ETHERH_CP_IF);
213 local_irq_restore(flags);
217 etherh_getifstat(struct net_device *dev)
219 struct ei_device *ei_local = netdev_priv(dev);
223 switch (etherh_priv(dev)->id) {
224 case PROD_I3_ETHERLAN600:
225 case PROD_I3_ETHERLAN600A:
226 addr = (void __iomem *)dev->base_addr + EN0_RCNTHI;
227 switch (dev->if_port) {
228 case IF_PORT_10BASE2:
231 case IF_PORT_10BASET:
232 stat = readb(addr) & 4;
237 case PROD_I3_ETHERLAN500:
238 switch (dev->if_port) {
239 case IF_PORT_10BASE2:
242 case IF_PORT_10BASET:
243 stat = etherh_get_stat(etherh_priv(dev)) & ETHERH_CP_HEARTBEAT;
257 * Configure the interface. Note that we ignore the other
258 * parts of ifmap, since its mostly meaningless for this driver.
260 static int etherh_set_config(struct net_device *dev, struct ifmap *map)
263 case IF_PORT_10BASE2:
264 case IF_PORT_10BASET:
266 * If the user explicitly sets the interface
267 * media type, turn off automedia detection.
269 dev->flags &= ~IFF_AUTOMEDIA;
270 dev->if_port = map->port;
283 * Reset the 8390 (hard reset). Note that we can't actually do this.
286 etherh_reset(struct net_device *dev)
288 struct ei_device *ei_local = netdev_priv(dev);
289 void __iomem *addr = (void __iomem *)dev->base_addr;
291 writeb(E8390_NODMA+E8390_PAGE0+E8390_STOP, addr);
294 * See if we need to change the interface type.
295 * Note that we use 'interface_num' as a flag
296 * to indicate that we need to change the media.
298 if (dev->flags & IFF_AUTOMEDIA && ei_local->interface_num) {
299 ei_local->interface_num = 0;
301 if (dev->if_port == IF_PORT_10BASET)
302 dev->if_port = IF_PORT_10BASE2;
304 dev->if_port = IF_PORT_10BASET;
311 * Write a block of data out to the 8390
314 etherh_block_output (struct net_device *dev, int count, const unsigned char *buf, int start_page)
316 struct ei_device *ei_local = netdev_priv(dev);
317 unsigned long dma_start;
318 void __iomem *dma_base, *addr;
320 if (ei_local->dmaing) {
321 printk(KERN_ERR "%s: DMAing conflict in etherh_block_input: "
322 " DMAstat %d irqlock %d\n", dev->name,
323 ei_local->dmaing, ei_local->irqlock);
328 * Make sure we have a round number of bytes if we're in word mode.
330 if (count & 1 && ei_local->word16)
333 ei_local->dmaing = 1;
335 addr = (void __iomem *)dev->base_addr;
336 dma_base = etherh_priv(dev)->dma_base;
338 count = (count + 1) & ~1;
339 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
341 writeb (0x42, addr + EN0_RCNTLO);
342 writeb (0x00, addr + EN0_RCNTHI);
343 writeb (0x42, addr + EN0_RSARLO);
344 writeb (0x00, addr + EN0_RSARHI);
345 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
349 writeb (ENISR_RDC, addr + EN0_ISR);
350 writeb (count, addr + EN0_RCNTLO);
351 writeb (count >> 8, addr + EN0_RCNTHI);
352 writeb (0, addr + EN0_RSARLO);
353 writeb (start_page, addr + EN0_RSARHI);
354 writeb (E8390_RWRITE | E8390_START, addr + E8390_CMD);
356 if (ei_local->word16)
357 writesw (dma_base, buf, count >> 1);
359 writesb (dma_base, buf, count);
363 while ((readb (addr + EN0_ISR) & ENISR_RDC) == 0)
364 if (time_after(jiffies, dma_start + 2*HZ/100)) { /* 20ms */
365 printk(KERN_ERR "%s: timeout waiting for TX RDC\n",
368 __NS8390_init (dev, 1);
372 writeb (ENISR_RDC, addr + EN0_ISR);
373 ei_local->dmaing = 0;
377 * Read a block of data from the 8390
380 etherh_block_input (struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
382 struct ei_device *ei_local = netdev_priv(dev);
384 void __iomem *dma_base, *addr;
386 if (ei_local->dmaing) {
387 printk(KERN_ERR "%s: DMAing conflict in etherh_block_input: "
388 " DMAstat %d irqlock %d\n", dev->name,
389 ei_local->dmaing, ei_local->irqlock);
393 ei_local->dmaing = 1;
395 addr = (void __iomem *)dev->base_addr;
396 dma_base = etherh_priv(dev)->dma_base;
399 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
400 writeb (count, addr + EN0_RCNTLO);
401 writeb (count >> 8, addr + EN0_RCNTHI);
402 writeb (ring_offset, addr + EN0_RSARLO);
403 writeb (ring_offset >> 8, addr + EN0_RSARHI);
404 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
406 if (ei_local->word16) {
407 readsw (dma_base, buf, count >> 1);
409 buf[count - 1] = readb (dma_base);
411 readsb (dma_base, buf, count);
413 writeb (ENISR_RDC, addr + EN0_ISR);
414 ei_local->dmaing = 0;
418 * Read a header from the 8390
421 etherh_get_header (struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
423 struct ei_device *ei_local = netdev_priv(dev);
424 void __iomem *dma_base, *addr;
426 if (ei_local->dmaing) {
427 printk(KERN_ERR "%s: DMAing conflict in etherh_get_header: "
428 " DMAstat %d irqlock %d\n", dev->name,
429 ei_local->dmaing, ei_local->irqlock);
433 ei_local->dmaing = 1;
435 addr = (void __iomem *)dev->base_addr;
436 dma_base = etherh_priv(dev)->dma_base;
438 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
439 writeb (sizeof (*hdr), addr + EN0_RCNTLO);
440 writeb (0, addr + EN0_RCNTHI);
441 writeb (0, addr + EN0_RSARLO);
442 writeb (ring_page, addr + EN0_RSARHI);
443 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
445 if (ei_local->word16)
446 readsw (dma_base, hdr, sizeof (*hdr) >> 1);
448 readsb (dma_base, hdr, sizeof (*hdr));
450 writeb (ENISR_RDC, addr + EN0_ISR);
451 ei_local->dmaing = 0;
455 * Open/initialize the board. This is called (in the current kernel)
456 * sometime after booting when the 'ifconfig' program is run.
458 * This routine should set everything up anew at each open, even
459 * registers that "should" only need to be set once at boot, so that
460 * there is non-reboot way to recover if something goes wrong.
463 etherh_open(struct net_device *dev)
465 struct ei_device *ei_local = netdev_priv(dev);
467 if (!is_valid_ether_addr(dev->dev_addr)) {
468 printk(KERN_WARNING "%s: invalid ethernet MAC address\n",
473 if (request_irq(dev->irq, __ei_interrupt, 0, dev->name, dev))
477 * Make sure that we aren't going to change the
478 * media type on the next reset - we are about to
479 * do automedia manually now.
481 ei_local->interface_num = 0;
484 * If we are doing automedia detection, do it now.
485 * This is more reliable than the 8390's detection.
487 if (dev->flags & IFF_AUTOMEDIA) {
488 dev->if_port = IF_PORT_10BASET;
491 if (!etherh_getifstat(dev)) {
492 dev->if_port = IF_PORT_10BASE2;
505 * The inverse routine to etherh_open().
508 etherh_close(struct net_device *dev)
511 free_irq (dev->irq, dev);
519 static void __init etherh_banner(void)
521 static int version_printed;
523 if (net_debug && version_printed++ == 0)
524 printk(KERN_INFO "%s", version);
528 * Read the ethernet address string from the on board rom.
529 * This is an ascii string...
531 static int __init etherh_addr(char *addr, struct expansion_card *ec)
533 struct in_chunk_dir cd;
536 if (!ecard_readchunk(&cd, ec, 0xf5, 0)) {
537 printk(KERN_ERR "%s: unable to read podule description string\n",
542 s = strchr(cd.d.string, '(');
546 for (i = 0; i < 6; i++) {
547 addr[i] = simple_strtoul(s + 1, &s, 0x10);
548 if (*s != (i == 5? ')' : ':'))
556 printk(KERN_ERR "%s: unable to parse MAC address: %s\n",
557 ec->dev.bus_id, cd.d.string);
564 * Create an ethernet address from the system serial number.
566 static int __init etherm_addr(char *addr)
570 if (system_serial_low == 0 && system_serial_high == 0)
573 serial = system_serial_low | system_serial_high;
578 addr[3] = 0x10 + (serial >> 24);
579 addr[4] = serial >> 16;
580 addr[5] = serial >> 8;
584 static void etherh_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
586 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
587 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
588 strlcpy(info->bus_info, dev->dev.parent->bus_id,
589 sizeof(info->bus_info));
592 static int etherh_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
594 cmd->supported = etherh_priv(dev)->supported;
595 cmd->speed = SPEED_10;
596 cmd->duplex = DUPLEX_HALF;
597 cmd->port = dev->if_port == IF_PORT_10BASET ? PORT_TP : PORT_BNC;
598 cmd->autoneg = dev->flags & IFF_AUTOMEDIA ? AUTONEG_ENABLE : AUTONEG_DISABLE;
602 static int etherh_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
604 switch (cmd->autoneg) {
606 dev->flags |= IFF_AUTOMEDIA;
609 case AUTONEG_DISABLE:
612 dev->if_port = IF_PORT_10BASET;
616 dev->if_port = IF_PORT_10BASE2;
622 dev->flags &= ~IFF_AUTOMEDIA;
634 static const struct ethtool_ops etherh_ethtool_ops = {
635 .get_settings = etherh_get_settings,
636 .set_settings = etherh_set_settings,
637 .get_drvinfo = etherh_get_drvinfo,
640 static u32 etherh_regoffsets[16];
641 static u32 etherm_regoffsets[16];
644 etherh_probe(struct expansion_card *ec, const struct ecard_id *id)
646 const struct etherh_data *data = id->data;
647 struct ei_device *ei_local;
648 struct net_device *dev;
649 struct etherh_priv *eh;
654 ret = ecard_request_resources(ec);
658 dev = ____alloc_ei_netdev(sizeof(struct etherh_priv));
664 SET_MODULE_OWNER(dev);
665 SET_NETDEV_DEV(dev, &ec->dev);
667 dev->open = etherh_open;
668 dev->stop = etherh_close;
669 dev->set_config = etherh_set_config;
671 dev->ethtool_ops = ðerh_ethtool_ops;
673 if (data->supported & SUPPORTED_Autoneg)
674 dev->flags |= IFF_AUTOMEDIA;
675 if (data->supported & SUPPORTED_TP) {
676 dev->flags |= IFF_PORTSEL;
677 dev->if_port = IF_PORT_10BASET;
678 } else if (data->supported & SUPPORTED_BNC) {
679 dev->flags |= IFF_PORTSEL;
680 dev->if_port = IF_PORT_10BASE2;
682 dev->if_port = IF_PORT_UNKNOWN;
684 eh = etherh_priv(dev);
685 eh->supported = data->supported;
687 eh->id = ec->cid.product;
688 eh->memc = ecardm_iomap(ec, ECARD_RES_MEMC, 0, PAGE_SIZE);
694 eh->ctrl_port = eh->memc;
695 if (data->ctrl_ioc) {
696 eh->ioc_fast = ecardm_iomap(ec, ECARD_RES_IOCFAST, 0, PAGE_SIZE);
701 eh->ctrl_port = eh->ioc_fast;
704 dev->base_addr = (unsigned long)eh->memc + data->ns8390_offset;
705 eh->dma_base = eh->memc + data->dataport_offset;
706 eh->ctrl_port += data->ctrlport_offset;
709 * IRQ and control port handling - only for non-NIC slot cards.
711 if (ec->slot_no != 8) {
712 ecard_setirq(ec, ðerh_ops, eh);
715 * If we're in the NIC slot, make sure the IRQ is enabled
717 etherh_set_ctrl(eh, ETHERH_CP_IE);
720 ei_local = netdev_priv(dev);
721 spin_lock_init(&ei_local->page_lock);
723 if (ec->cid.product == PROD_ANT_ETHERM) {
724 etherm_addr(dev->dev_addr);
725 ei_local->reg_offset = etherm_regoffsets;
727 etherh_addr(dev->dev_addr, ec);
728 ei_local->reg_offset = etherh_regoffsets;
731 ei_local->name = dev->name;
732 ei_local->word16 = 1;
733 ei_local->tx_start_page = data->tx_start_page;
734 ei_local->rx_start_page = ei_local->tx_start_page + TX_PAGES;
735 ei_local->stop_page = data->stop_page;
736 ei_local->reset_8390 = etherh_reset;
737 ei_local->block_input = etherh_block_input;
738 ei_local->block_output = etherh_block_output;
739 ei_local->get_8390_hdr = etherh_get_header;
740 ei_local->interface_num = 0;
743 __NS8390_init(dev, 0);
745 ret = register_netdev(dev);
749 printk(KERN_INFO "%s: %s in slot %d, ",
750 dev->name, data->name, ec->slot_no);
752 for (i = 0; i < 6; i++)
753 printk("%2.2x%c", dev->dev_addr[i], i == 5 ? '\n' : ':');
755 ecard_set_drvdata(ec, dev);
762 ecard_release_resources(ec);
767 static void __devexit etherh_remove(struct expansion_card *ec)
769 struct net_device *dev = ecard_get_drvdata(ec);
771 ecard_set_drvdata(ec, NULL);
773 unregister_netdev(dev);
777 ecard_release_resources(ec);
780 static struct etherh_data etherm_data = {
781 .ns8390_offset = ETHERM_NS8390,
782 .dataport_offset = ETHERM_NS8390 + ETHERM_DATAPORT,
783 .ctrlport_offset = ETHERM_NS8390 + ETHERM_CTRLPORT,
784 .name = "ANT EtherM",
785 .supported = SUPPORTED_10baseT_Half,
786 .tx_start_page = ETHERM_TX_START_PAGE,
787 .stop_page = ETHERM_STOP_PAGE,
790 static struct etherh_data etherlan500_data = {
791 .ns8390_offset = ETHERH500_NS8390,
792 .dataport_offset = ETHERH500_NS8390 + ETHERH500_DATAPORT,
793 .ctrlport_offset = ETHERH500_CTRLPORT,
795 .name = "i3 EtherH 500",
796 .supported = SUPPORTED_10baseT_Half,
797 .tx_start_page = ETHERH_TX_START_PAGE,
798 .stop_page = ETHERH_STOP_PAGE,
801 static struct etherh_data etherlan600_data = {
802 .ns8390_offset = ETHERH600_NS8390,
803 .dataport_offset = ETHERH600_NS8390 + ETHERH600_DATAPORT,
804 .ctrlport_offset = ETHERH600_NS8390 + ETHERH600_CTRLPORT,
805 .name = "i3 EtherH 600",
806 .supported = SUPPORTED_10baseT_Half | SUPPORTED_TP | SUPPORTED_BNC | SUPPORTED_Autoneg,
807 .tx_start_page = ETHERH_TX_START_PAGE,
808 .stop_page = ETHERH_STOP_PAGE,
811 static struct etherh_data etherlan600a_data = {
812 .ns8390_offset = ETHERH600_NS8390,
813 .dataport_offset = ETHERH600_NS8390 + ETHERH600_DATAPORT,
814 .ctrlport_offset = ETHERH600_NS8390 + ETHERH600_CTRLPORT,
815 .name = "i3 EtherH 600A",
816 .supported = SUPPORTED_10baseT_Half | SUPPORTED_TP | SUPPORTED_BNC | SUPPORTED_Autoneg,
817 .tx_start_page = ETHERH_TX_START_PAGE,
818 .stop_page = ETHERH_STOP_PAGE,
821 static const struct ecard_id etherh_ids[] = {
822 { MANU_ANT, PROD_ANT_ETHERM, ðerm_data },
823 { MANU_I3, PROD_I3_ETHERLAN500, ðerlan500_data },
824 { MANU_I3, PROD_I3_ETHERLAN600, ðerlan600_data },
825 { MANU_I3, PROD_I3_ETHERLAN600A, ðerlan600a_data },
829 static struct ecard_driver etherh_driver = {
830 .probe = etherh_probe,
831 .remove = __devexit_p(etherh_remove),
832 .id_table = etherh_ids,
838 static int __init etherh_init(void)
842 for (i = 0; i < 16; i++) {
843 etherh_regoffsets[i] = i << 2;
844 etherm_regoffsets[i] = i << 5;
847 return ecard_register_driver(ðerh_driver);
850 static void __exit etherh_exit(void)
852 ecard_remove_driver(ðerh_driver);
855 module_init(etherh_init);
856 module_exit(etherh_exit);