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/sched.h>
32 #include <linux/types.h>
33 #include <linux/fcntl.h>
34 #include <linux/interrupt.h>
35 #include <linux/ptrace.h>
36 #include <linux/ioport.h>
38 #include <linux/slab.h>
39 #include <linux/string.h>
40 #include <linux/errno.h>
41 #include <linux/netdevice.h>
42 #include <linux/etherdevice.h>
43 #include <linux/ethtool.h>
44 #include <linux/skbuff.h>
45 #include <linux/delay.h>
46 #include <linux/device.h>
47 #include <linux/init.h>
48 #include <linux/bitops.h>
50 #include <asm/system.h>
51 #include <asm/ecard.h>
59 #define DRV_NAME "etherh"
60 #define DRV_VERSION "1.11"
62 static unsigned int net_debug = NET_DEBUG;
65 void __iomem *ioc_fast;
67 void __iomem *dma_base;
69 void __iomem *ctrl_port;
75 unsigned long ns8390_offset;
76 unsigned long dataport_offset;
77 unsigned long ctrlport_offset;
81 unsigned char tx_start_page;
82 unsigned char stop_page;
85 MODULE_AUTHOR("Russell King");
86 MODULE_DESCRIPTION("EtherH/EtherM driver");
87 MODULE_LICENSE("GPL");
89 static char version[] __initdata =
90 "EtherH/EtherM Driver (c) 2002-2004 Russell King " DRV_VERSION "\n";
92 #define ETHERH500_DATAPORT 0x800 /* MEMC */
93 #define ETHERH500_NS8390 0x000 /* MEMC */
94 #define ETHERH500_CTRLPORT 0x800 /* IOC */
96 #define ETHERH600_DATAPORT 0x040 /* MEMC */
97 #define ETHERH600_NS8390 0x800 /* MEMC */
98 #define ETHERH600_CTRLPORT 0x200 /* MEMC */
100 #define ETHERH_CP_IE 1
101 #define ETHERH_CP_IF 2
102 #define ETHERH_CP_HEARTBEAT 2
104 #define ETHERH_TX_START_PAGE 1
105 #define ETHERH_STOP_PAGE 127
108 * These came from CK/TEW
110 #define ETHERM_DATAPORT 0x200 /* MEMC */
111 #define ETHERM_NS8390 0x800 /* MEMC */
112 #define ETHERM_CTRLPORT 0x23c /* MEMC */
114 #define ETHERM_TX_START_PAGE 64
115 #define ETHERM_STOP_PAGE 127
117 /* ------------------------------------------------------------------------ */
119 #define etherh_priv(dev) \
120 ((struct etherh_priv *)(((char *)netdev_priv(dev)) + sizeof(struct ei_device)))
122 static inline void etherh_set_ctrl(struct etherh_priv *eh, unsigned char mask)
124 unsigned char ctrl = eh->ctrl | mask;
126 writeb(ctrl, eh->ctrl_port);
129 static inline void etherh_clr_ctrl(struct etherh_priv *eh, unsigned char mask)
131 unsigned char ctrl = eh->ctrl & ~mask;
133 writeb(ctrl, eh->ctrl_port);
136 static inline unsigned int etherh_get_stat(struct etherh_priv *eh)
138 return readb(eh->ctrl_port);
144 static void etherh_irq_enable(ecard_t *ec, int irqnr)
146 struct etherh_priv *eh = ec->irq_data;
148 etherh_set_ctrl(eh, ETHERH_CP_IE);
151 static void etherh_irq_disable(ecard_t *ec, int irqnr)
153 struct etherh_priv *eh = ec->irq_data;
155 etherh_clr_ctrl(eh, ETHERH_CP_IE);
158 static expansioncard_ops_t etherh_ops = {
159 .irqenable = etherh_irq_enable,
160 .irqdisable = etherh_irq_disable,
167 etherh_setif(struct net_device *dev)
169 struct ei_device *ei_local = netdev_priv(dev);
173 local_irq_save(flags);
175 /* set the interface type */
176 switch (etherh_priv(dev)->id) {
177 case PROD_I3_ETHERLAN600:
178 case PROD_I3_ETHERLAN600A:
179 addr = (void *)dev->base_addr + EN0_RCNTHI;
181 switch (dev->if_port) {
182 case IF_PORT_10BASE2:
183 writeb((readb(addr) & 0xf8) | 1, addr);
185 case IF_PORT_10BASET:
186 writeb((readb(addr) & 0xf8), addr);
191 case PROD_I3_ETHERLAN500:
192 switch (dev->if_port) {
193 case IF_PORT_10BASE2:
194 etherh_clr_ctrl(etherh_priv(dev), ETHERH_CP_IF);
197 case IF_PORT_10BASET:
198 etherh_set_ctrl(etherh_priv(dev), ETHERH_CP_IF);
207 local_irq_restore(flags);
211 etherh_getifstat(struct net_device *dev)
213 struct ei_device *ei_local = netdev_priv(dev);
217 switch (etherh_priv(dev)->id) {
218 case PROD_I3_ETHERLAN600:
219 case PROD_I3_ETHERLAN600A:
220 addr = (void *)dev->base_addr + EN0_RCNTHI;
221 switch (dev->if_port) {
222 case IF_PORT_10BASE2:
225 case IF_PORT_10BASET:
226 stat = readb(addr) & 4;
231 case PROD_I3_ETHERLAN500:
232 switch (dev->if_port) {
233 case IF_PORT_10BASE2:
236 case IF_PORT_10BASET:
237 stat = etherh_get_stat(etherh_priv(dev)) & ETHERH_CP_HEARTBEAT;
251 * Configure the interface. Note that we ignore the other
252 * parts of ifmap, since its mostly meaningless for this driver.
254 static int etherh_set_config(struct net_device *dev, struct ifmap *map)
257 case IF_PORT_10BASE2:
258 case IF_PORT_10BASET:
260 * If the user explicitly sets the interface
261 * media type, turn off automedia detection.
263 dev->flags &= ~IFF_AUTOMEDIA;
264 dev->if_port = map->port;
277 * Reset the 8390 (hard reset). Note that we can't actually do this.
280 etherh_reset(struct net_device *dev)
282 struct ei_device *ei_local = netdev_priv(dev);
283 void __iomem *addr = (void *)dev->base_addr;
285 writeb(E8390_NODMA+E8390_PAGE0+E8390_STOP, addr);
288 * See if we need to change the interface type.
289 * Note that we use 'interface_num' as a flag
290 * to indicate that we need to change the media.
292 if (dev->flags & IFF_AUTOMEDIA && ei_local->interface_num) {
293 ei_local->interface_num = 0;
295 if (dev->if_port == IF_PORT_10BASET)
296 dev->if_port = IF_PORT_10BASE2;
298 dev->if_port = IF_PORT_10BASET;
305 * Write a block of data out to the 8390
308 etherh_block_output (struct net_device *dev, int count, const unsigned char *buf, int start_page)
310 struct ei_device *ei_local = netdev_priv(dev);
311 unsigned long dma_start;
312 void __iomem *dma_base, *addr;
314 if (ei_local->dmaing) {
315 printk(KERN_ERR "%s: DMAing conflict in etherh_block_input: "
316 " DMAstat %d irqlock %d\n", dev->name,
317 ei_local->dmaing, ei_local->irqlock);
322 * Make sure we have a round number of bytes if we're in word mode.
324 if (count & 1 && ei_local->word16)
327 ei_local->dmaing = 1;
329 addr = (void *)dev->base_addr;
330 dma_base = etherh_priv(dev)->dma_base;
332 count = (count + 1) & ~1;
333 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
335 writeb (0x42, addr + EN0_RCNTLO);
336 writeb (0x00, addr + EN0_RCNTHI);
337 writeb (0x42, addr + EN0_RSARLO);
338 writeb (0x00, addr + EN0_RSARHI);
339 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
343 writeb (ENISR_RDC, addr + EN0_ISR);
344 writeb (count, addr + EN0_RCNTLO);
345 writeb (count >> 8, addr + EN0_RCNTHI);
346 writeb (0, addr + EN0_RSARLO);
347 writeb (start_page, addr + EN0_RSARHI);
348 writeb (E8390_RWRITE | E8390_START, addr + E8390_CMD);
350 if (ei_local->word16)
351 writesw (dma_base, buf, count >> 1);
353 writesb (dma_base, buf, count);
357 while ((readb (addr + EN0_ISR) & ENISR_RDC) == 0)
358 if (jiffies - dma_start > 2*HZ/100) { /* 20ms */
359 printk(KERN_ERR "%s: timeout waiting for TX RDC\n",
362 NS8390_init (dev, 1);
366 writeb (ENISR_RDC, addr + EN0_ISR);
367 ei_local->dmaing = 0;
371 * Read a block of data from the 8390
374 etherh_block_input (struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
376 struct ei_device *ei_local = netdev_priv(dev);
378 void __iomem *dma_base, *addr;
380 if (ei_local->dmaing) {
381 printk(KERN_ERR "%s: DMAing conflict in etherh_block_input: "
382 " DMAstat %d irqlock %d\n", dev->name,
383 ei_local->dmaing, ei_local->irqlock);
387 ei_local->dmaing = 1;
389 addr = (void *)dev->base_addr;
390 dma_base = etherh_priv(dev)->dma_base;
393 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
394 writeb (count, addr + EN0_RCNTLO);
395 writeb (count >> 8, addr + EN0_RCNTHI);
396 writeb (ring_offset, addr + EN0_RSARLO);
397 writeb (ring_offset >> 8, addr + EN0_RSARHI);
398 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
400 if (ei_local->word16) {
401 readsw (dma_base, buf, count >> 1);
403 buf[count - 1] = readb (dma_base);
405 readsb (dma_base, buf, count);
407 writeb (ENISR_RDC, addr + EN0_ISR);
408 ei_local->dmaing = 0;
412 * Read a header from the 8390
415 etherh_get_header (struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
417 struct ei_device *ei_local = netdev_priv(dev);
418 void __iomem *dma_base, *addr;
420 if (ei_local->dmaing) {
421 printk(KERN_ERR "%s: DMAing conflict in etherh_get_header: "
422 " DMAstat %d irqlock %d\n", dev->name,
423 ei_local->dmaing, ei_local->irqlock);
427 ei_local->dmaing = 1;
429 addr = (void *)dev->base_addr;
430 dma_base = etherh_priv(dev)->dma_base;
432 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
433 writeb (sizeof (*hdr), addr + EN0_RCNTLO);
434 writeb (0, addr + EN0_RCNTHI);
435 writeb (0, addr + EN0_RSARLO);
436 writeb (ring_page, addr + EN0_RSARHI);
437 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
439 if (ei_local->word16)
440 readsw (dma_base, hdr, sizeof (*hdr) >> 1);
442 readsb (dma_base, hdr, sizeof (*hdr));
444 writeb (ENISR_RDC, addr + EN0_ISR);
445 ei_local->dmaing = 0;
449 * Open/initialize the board. This is called (in the current kernel)
450 * sometime after booting when the 'ifconfig' program is run.
452 * This routine should set everything up anew at each open, even
453 * registers that "should" only need to be set once at boot, so that
454 * there is non-reboot way to recover if something goes wrong.
457 etherh_open(struct net_device *dev)
459 struct ei_device *ei_local = netdev_priv(dev);
461 if (!is_valid_ether_addr(dev->dev_addr)) {
462 printk(KERN_WARNING "%s: invalid ethernet MAC address\n",
467 if (request_irq(dev->irq, ei_interrupt, 0, dev->name, dev))
471 * Make sure that we aren't going to change the
472 * media type on the next reset - we are about to
473 * do automedia manually now.
475 ei_local->interface_num = 0;
478 * If we are doing automedia detection, do it now.
479 * This is more reliable than the 8390's detection.
481 if (dev->flags & IFF_AUTOMEDIA) {
482 dev->if_port = IF_PORT_10BASET;
485 if (!etherh_getifstat(dev)) {
486 dev->if_port = IF_PORT_10BASE2;
499 * The inverse routine to etherh_open().
502 etherh_close(struct net_device *dev)
505 free_irq (dev->irq, dev);
513 static void __init etherh_banner(void)
515 static int version_printed;
517 if (net_debug && version_printed++ == 0)
518 printk(KERN_INFO "%s", version);
522 * Read the ethernet address string from the on board rom.
523 * This is an ascii string...
525 static int __init etherh_addr(char *addr, struct expansion_card *ec)
527 struct in_chunk_dir cd;
530 if (!ecard_readchunk(&cd, ec, 0xf5, 0)) {
531 printk(KERN_ERR "%s: unable to read podule description string\n",
536 s = strchr(cd.d.string, '(');
540 for (i = 0; i < 6; i++) {
541 addr[i] = simple_strtoul(s + 1, &s, 0x10);
542 if (*s != (i == 5? ')' : ':'))
550 printk(KERN_ERR "%s: unable to parse MAC address: %s\n",
551 ec->dev.bus_id, cd.d.string);
558 * Create an ethernet address from the system serial number.
560 static int __init etherm_addr(char *addr)
564 if (system_serial_low == 0 && system_serial_high == 0)
567 serial = system_serial_low | system_serial_high;
572 addr[3] = 0x10 + (serial >> 24);
573 addr[4] = serial >> 16;
574 addr[5] = serial >> 8;
578 static void etherh_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
580 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
581 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
582 strlcpy(info->bus_info, dev->class_dev.dev->bus_id,
583 sizeof(info->bus_info));
586 static int etherh_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
588 cmd->supported = etherh_priv(dev)->supported;
589 cmd->speed = SPEED_10;
590 cmd->duplex = DUPLEX_HALF;
591 cmd->port = dev->if_port == IF_PORT_10BASET ? PORT_TP : PORT_BNC;
592 cmd->autoneg = dev->flags & IFF_AUTOMEDIA ? AUTONEG_ENABLE : AUTONEG_DISABLE;
596 static int etherh_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
598 switch (cmd->autoneg) {
600 dev->flags |= IFF_AUTOMEDIA;
603 case AUTONEG_DISABLE:
606 dev->if_port = IF_PORT_10BASET;
610 dev->if_port = IF_PORT_10BASE2;
616 dev->flags &= ~IFF_AUTOMEDIA;
628 static struct ethtool_ops etherh_ethtool_ops = {
629 .get_settings = etherh_get_settings,
630 .set_settings = etherh_set_settings,
631 .get_drvinfo = etherh_get_drvinfo,
634 static u32 etherh_regoffsets[16];
635 static u32 etherm_regoffsets[16];
638 etherh_probe(struct expansion_card *ec, const struct ecard_id *id)
640 const struct etherh_data *data = id->data;
641 struct ei_device *ei_local;
642 struct net_device *dev;
643 struct etherh_priv *eh;
648 ret = ecard_request_resources(ec);
652 dev = __alloc_ei_netdev(sizeof(struct etherh_priv));
658 SET_MODULE_OWNER(dev);
659 SET_NETDEV_DEV(dev, &ec->dev);
661 dev->open = etherh_open;
662 dev->stop = etherh_close;
663 dev->set_config = etherh_set_config;
665 dev->ethtool_ops = ðerh_ethtool_ops;
667 if (data->supported & SUPPORTED_Autoneg)
668 dev->flags |= IFF_AUTOMEDIA;
669 if (data->supported & SUPPORTED_TP) {
670 dev->flags |= IFF_PORTSEL;
671 dev->if_port = IF_PORT_10BASET;
672 } else if (data->supported & SUPPORTED_BNC) {
673 dev->flags |= IFF_PORTSEL;
674 dev->if_port = IF_PORT_10BASE2;
676 dev->if_port = IF_PORT_UNKNOWN;
678 eh = etherh_priv(dev);
679 eh->supported = data->supported;
681 eh->id = ec->cid.product;
682 eh->memc = ioremap(ecard_resource_start(ec, ECARD_RES_MEMC), PAGE_SIZE);
688 eh->ctrl_port = eh->memc;
689 if (data->ctrl_ioc) {
690 eh->ioc_fast = ioremap(ecard_resource_start(ec, ECARD_RES_IOCFAST), PAGE_SIZE);
695 eh->ctrl_port = eh->ioc_fast;
698 dev->base_addr = (unsigned long)eh->memc + data->ns8390_offset;
699 eh->dma_base = eh->memc + data->dataport_offset;
700 eh->ctrl_port += data->ctrlport_offset;
703 * IRQ and control port handling - only for non-NIC slot cards.
705 if (ec->slot_no != 8) {
706 ec->ops = ðerh_ops;
710 * If we're in the NIC slot, make sure the IRQ is enabled
712 etherh_set_ctrl(eh, ETHERH_CP_IE);
715 ei_local = netdev_priv(dev);
716 spin_lock_init(&ei_local->page_lock);
718 if (ec->cid.product == PROD_ANT_ETHERM) {
719 etherm_addr(dev->dev_addr);
720 ei_local->reg_offset = etherm_regoffsets;
722 etherh_addr(dev->dev_addr, ec);
723 ei_local->reg_offset = etherh_regoffsets;
726 ei_local->name = dev->name;
727 ei_local->word16 = 1;
728 ei_local->tx_start_page = data->tx_start_page;
729 ei_local->rx_start_page = ei_local->tx_start_page + TX_PAGES;
730 ei_local->stop_page = data->stop_page;
731 ei_local->reset_8390 = etherh_reset;
732 ei_local->block_input = etherh_block_input;
733 ei_local->block_output = etherh_block_output;
734 ei_local->get_8390_hdr = etherh_get_header;
735 ei_local->interface_num = 0;
740 ret = register_netdev(dev);
744 printk(KERN_INFO "%s: %s in slot %d, ",
745 dev->name, data->name, ec->slot_no);
747 for (i = 0; i < 6; i++)
748 printk("%2.2x%c", dev->dev_addr[i], i == 5 ? '\n' : ':');
750 ecard_set_drvdata(ec, dev);
756 iounmap(eh->ioc_fast);
761 ecard_release_resources(ec);
766 static void __devexit etherh_remove(struct expansion_card *ec)
768 struct net_device *dev = ecard_get_drvdata(ec);
769 struct etherh_priv *eh = etherh_priv(dev);
771 ecard_set_drvdata(ec, NULL);
773 unregister_netdev(dev);
777 iounmap(eh->ioc_fast);
782 ecard_release_resources(ec);
785 static struct etherh_data etherm_data = {
786 .ns8390_offset = ETHERM_NS8390,
787 .dataport_offset = ETHERM_NS8390 + ETHERM_DATAPORT,
788 .ctrlport_offset = ETHERM_NS8390 + ETHERM_CTRLPORT,
789 .name = "ANT EtherM",
790 .supported = SUPPORTED_10baseT_Half,
791 .tx_start_page = ETHERM_TX_START_PAGE,
792 .stop_page = ETHERM_STOP_PAGE,
795 static struct etherh_data etherlan500_data = {
796 .ns8390_offset = ETHERH500_NS8390,
797 .dataport_offset = ETHERH500_NS8390 + ETHERH500_DATAPORT,
798 .ctrlport_offset = ETHERH500_CTRLPORT,
800 .name = "i3 EtherH 500",
801 .supported = SUPPORTED_10baseT_Half,
802 .tx_start_page = ETHERH_TX_START_PAGE,
803 .stop_page = ETHERH_STOP_PAGE,
806 static struct etherh_data etherlan600_data = {
807 .ns8390_offset = ETHERH600_NS8390,
808 .dataport_offset = ETHERH600_NS8390 + ETHERH600_DATAPORT,
809 .ctrlport_offset = ETHERH600_NS8390 + ETHERH600_CTRLPORT,
810 .name = "i3 EtherH 600",
811 .supported = SUPPORTED_10baseT_Half | SUPPORTED_TP | SUPPORTED_BNC | SUPPORTED_Autoneg,
812 .tx_start_page = ETHERH_TX_START_PAGE,
813 .stop_page = ETHERH_STOP_PAGE,
816 static struct etherh_data etherlan600a_data = {
817 .ns8390_offset = ETHERH600_NS8390,
818 .dataport_offset = ETHERH600_NS8390 + ETHERH600_DATAPORT,
819 .ctrlport_offset = ETHERH600_NS8390 + ETHERH600_CTRLPORT,
820 .name = "i3 EtherH 600A",
821 .supported = SUPPORTED_10baseT_Half | SUPPORTED_TP | SUPPORTED_BNC | SUPPORTED_Autoneg,
822 .tx_start_page = ETHERH_TX_START_PAGE,
823 .stop_page = ETHERH_STOP_PAGE,
826 static const struct ecard_id etherh_ids[] = {
827 { MANU_ANT, PROD_ANT_ETHERM, ðerm_data },
828 { MANU_I3, PROD_I3_ETHERLAN500, ðerlan500_data },
829 { MANU_I3, PROD_I3_ETHERLAN600, ðerlan600_data },
830 { MANU_I3, PROD_I3_ETHERLAN600A, ðerlan600a_data },
834 static struct ecard_driver etherh_driver = {
835 .probe = etherh_probe,
836 .remove = __devexit_p(etherh_remove),
837 .id_table = etherh_ids,
843 static int __init etherh_init(void)
847 for (i = 0; i < 16; i++) {
848 etherh_regoffsets[i] = i << 2;
849 etherm_regoffsets[i] = i << 5;
852 return ecard_register_driver(ðerh_driver);
855 static void __exit etherh_exit(void)
857 ecard_remove_driver(ðerh_driver);
860 module_init(etherh_init);
861 module_exit(etherh_exit);