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/ptrace.h>
35 #include <linux/ioport.h>
37 #include <linux/slab.h>
38 #include <linux/string.h>
39 #include <linux/errno.h>
40 #include <linux/netdevice.h>
41 #include <linux/etherdevice.h>
42 #include <linux/ethtool.h>
43 #include <linux/skbuff.h>
44 #include <linux/delay.h>
45 #include <linux/device.h>
46 #include <linux/init.h>
47 #include <linux/bitops.h>
48 #include <linux/jiffies.h>
50 #include <asm/system.h>
51 #include <asm/ecard.h>
54 #define EI_SHIFT(x) (ei_local->reg_offset[x])
56 #define ei_inb(_p) readb((void __iomem *)_p)
57 #define ei_outb(_v,_p) writeb(_v,(void __iomem *)_p)
58 #define ei_inb_p(_p) readb((void __iomem *)_p)
59 #define ei_outb_p(_v,_p) writeb(_v,(void __iomem *)_p)
64 #define DRV_NAME "etherh"
65 #define DRV_VERSION "1.11"
67 static char version[] __initdata =
68 "EtherH/EtherM Driver (c) 2002-2004 Russell King " DRV_VERSION "\n";
70 #include "../lib8390.c"
72 static unsigned int net_debug = NET_DEBUG;
75 void __iomem *ioc_fast;
77 void __iomem *dma_base;
79 void __iomem *ctrl_port;
85 unsigned long ns8390_offset;
86 unsigned long dataport_offset;
87 unsigned long ctrlport_offset;
91 unsigned char tx_start_page;
92 unsigned char stop_page;
95 MODULE_AUTHOR("Russell King");
96 MODULE_DESCRIPTION("EtherH/EtherM driver");
97 MODULE_LICENSE("GPL");
99 #define ETHERH500_DATAPORT 0x800 /* MEMC */
100 #define ETHERH500_NS8390 0x000 /* MEMC */
101 #define ETHERH500_CTRLPORT 0x800 /* IOC */
103 #define ETHERH600_DATAPORT 0x040 /* MEMC */
104 #define ETHERH600_NS8390 0x800 /* MEMC */
105 #define ETHERH600_CTRLPORT 0x200 /* MEMC */
107 #define ETHERH_CP_IE 1
108 #define ETHERH_CP_IF 2
109 #define ETHERH_CP_HEARTBEAT 2
111 #define ETHERH_TX_START_PAGE 1
112 #define ETHERH_STOP_PAGE 127
115 * These came from CK/TEW
117 #define ETHERM_DATAPORT 0x200 /* MEMC */
118 #define ETHERM_NS8390 0x800 /* MEMC */
119 #define ETHERM_CTRLPORT 0x23c /* MEMC */
121 #define ETHERM_TX_START_PAGE 64
122 #define ETHERM_STOP_PAGE 127
124 /* ------------------------------------------------------------------------ */
126 #define etherh_priv(dev) \
127 ((struct etherh_priv *)(((char *)netdev_priv(dev)) + sizeof(struct ei_device)))
129 static inline void etherh_set_ctrl(struct etherh_priv *eh, unsigned char mask)
131 unsigned char ctrl = eh->ctrl | mask;
133 writeb(ctrl, eh->ctrl_port);
136 static inline void etherh_clr_ctrl(struct etherh_priv *eh, unsigned char mask)
138 unsigned char ctrl = eh->ctrl & ~mask;
140 writeb(ctrl, eh->ctrl_port);
143 static inline unsigned int etherh_get_stat(struct etherh_priv *eh)
145 return readb(eh->ctrl_port);
151 static void etherh_irq_enable(ecard_t *ec, int irqnr)
153 struct etherh_priv *eh = ec->irq_data;
155 etherh_set_ctrl(eh, ETHERH_CP_IE);
158 static void etherh_irq_disable(ecard_t *ec, int irqnr)
160 struct etherh_priv *eh = ec->irq_data;
162 etherh_clr_ctrl(eh, ETHERH_CP_IE);
165 static expansioncard_ops_t etherh_ops = {
166 .irqenable = etherh_irq_enable,
167 .irqdisable = etherh_irq_disable,
174 etherh_setif(struct net_device *dev)
176 struct ei_device *ei_local = netdev_priv(dev);
180 local_irq_save(flags);
182 /* set the interface type */
183 switch (etherh_priv(dev)->id) {
184 case PROD_I3_ETHERLAN600:
185 case PROD_I3_ETHERLAN600A:
186 addr = (void __iomem *)dev->base_addr + EN0_RCNTHI;
188 switch (dev->if_port) {
189 case IF_PORT_10BASE2:
190 writeb((readb(addr) & 0xf8) | 1, addr);
192 case IF_PORT_10BASET:
193 writeb((readb(addr) & 0xf8), addr);
198 case PROD_I3_ETHERLAN500:
199 switch (dev->if_port) {
200 case IF_PORT_10BASE2:
201 etherh_clr_ctrl(etherh_priv(dev), ETHERH_CP_IF);
204 case IF_PORT_10BASET:
205 etherh_set_ctrl(etherh_priv(dev), ETHERH_CP_IF);
214 local_irq_restore(flags);
218 etherh_getifstat(struct net_device *dev)
220 struct ei_device *ei_local = netdev_priv(dev);
224 switch (etherh_priv(dev)->id) {
225 case PROD_I3_ETHERLAN600:
226 case PROD_I3_ETHERLAN600A:
227 addr = (void __iomem *)dev->base_addr + EN0_RCNTHI;
228 switch (dev->if_port) {
229 case IF_PORT_10BASE2:
232 case IF_PORT_10BASET:
233 stat = readb(addr) & 4;
238 case PROD_I3_ETHERLAN500:
239 switch (dev->if_port) {
240 case IF_PORT_10BASE2:
243 case IF_PORT_10BASET:
244 stat = etherh_get_stat(etherh_priv(dev)) & ETHERH_CP_HEARTBEAT;
258 * Configure the interface. Note that we ignore the other
259 * parts of ifmap, since its mostly meaningless for this driver.
261 static int etherh_set_config(struct net_device *dev, struct ifmap *map)
264 case IF_PORT_10BASE2:
265 case IF_PORT_10BASET:
267 * If the user explicitly sets the interface
268 * media type, turn off automedia detection.
270 dev->flags &= ~IFF_AUTOMEDIA;
271 dev->if_port = map->port;
284 * Reset the 8390 (hard reset). Note that we can't actually do this.
287 etherh_reset(struct net_device *dev)
289 struct ei_device *ei_local = netdev_priv(dev);
290 void __iomem *addr = (void __iomem *)dev->base_addr;
292 writeb(E8390_NODMA+E8390_PAGE0+E8390_STOP, addr);
295 * See if we need to change the interface type.
296 * Note that we use 'interface_num' as a flag
297 * to indicate that we need to change the media.
299 if (dev->flags & IFF_AUTOMEDIA && ei_local->interface_num) {
300 ei_local->interface_num = 0;
302 if (dev->if_port == IF_PORT_10BASET)
303 dev->if_port = IF_PORT_10BASE2;
305 dev->if_port = IF_PORT_10BASET;
312 * Write a block of data out to the 8390
315 etherh_block_output (struct net_device *dev, int count, const unsigned char *buf, int start_page)
317 struct ei_device *ei_local = netdev_priv(dev);
318 unsigned long dma_start;
319 void __iomem *dma_base, *addr;
321 if (ei_local->dmaing) {
322 printk(KERN_ERR "%s: DMAing conflict in etherh_block_input: "
323 " DMAstat %d irqlock %d\n", dev->name,
324 ei_local->dmaing, ei_local->irqlock);
329 * Make sure we have a round number of bytes if we're in word mode.
331 if (count & 1 && ei_local->word16)
334 ei_local->dmaing = 1;
336 addr = (void __iomem *)dev->base_addr;
337 dma_base = etherh_priv(dev)->dma_base;
339 count = (count + 1) & ~1;
340 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
342 writeb (0x42, addr + EN0_RCNTLO);
343 writeb (0x00, addr + EN0_RCNTHI);
344 writeb (0x42, addr + EN0_RSARLO);
345 writeb (0x00, addr + EN0_RSARHI);
346 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
350 writeb (ENISR_RDC, addr + EN0_ISR);
351 writeb (count, addr + EN0_RCNTLO);
352 writeb (count >> 8, addr + EN0_RCNTHI);
353 writeb (0, addr + EN0_RSARLO);
354 writeb (start_page, addr + EN0_RSARHI);
355 writeb (E8390_RWRITE | E8390_START, addr + E8390_CMD);
357 if (ei_local->word16)
358 writesw (dma_base, buf, count >> 1);
360 writesb (dma_base, buf, count);
364 while ((readb (addr + EN0_ISR) & ENISR_RDC) == 0)
365 if (time_after(jiffies, dma_start + 2*HZ/100)) { /* 20ms */
366 printk(KERN_ERR "%s: timeout waiting for TX RDC\n",
369 __NS8390_init (dev, 1);
373 writeb (ENISR_RDC, addr + EN0_ISR);
374 ei_local->dmaing = 0;
378 * Read a block of data from the 8390
381 etherh_block_input (struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
383 struct ei_device *ei_local = netdev_priv(dev);
385 void __iomem *dma_base, *addr;
387 if (ei_local->dmaing) {
388 printk(KERN_ERR "%s: DMAing conflict in etherh_block_input: "
389 " DMAstat %d irqlock %d\n", dev->name,
390 ei_local->dmaing, ei_local->irqlock);
394 ei_local->dmaing = 1;
396 addr = (void __iomem *)dev->base_addr;
397 dma_base = etherh_priv(dev)->dma_base;
400 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
401 writeb (count, addr + EN0_RCNTLO);
402 writeb (count >> 8, addr + EN0_RCNTHI);
403 writeb (ring_offset, addr + EN0_RSARLO);
404 writeb (ring_offset >> 8, addr + EN0_RSARHI);
405 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
407 if (ei_local->word16) {
408 readsw (dma_base, buf, count >> 1);
410 buf[count - 1] = readb (dma_base);
412 readsb (dma_base, buf, count);
414 writeb (ENISR_RDC, addr + EN0_ISR);
415 ei_local->dmaing = 0;
419 * Read a header from the 8390
422 etherh_get_header (struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
424 struct ei_device *ei_local = netdev_priv(dev);
425 void __iomem *dma_base, *addr;
427 if (ei_local->dmaing) {
428 printk(KERN_ERR "%s: DMAing conflict in etherh_get_header: "
429 " DMAstat %d irqlock %d\n", dev->name,
430 ei_local->dmaing, ei_local->irqlock);
434 ei_local->dmaing = 1;
436 addr = (void __iomem *)dev->base_addr;
437 dma_base = etherh_priv(dev)->dma_base;
439 writeb (E8390_NODMA | E8390_PAGE0 | E8390_START, addr + E8390_CMD);
440 writeb (sizeof (*hdr), addr + EN0_RCNTLO);
441 writeb (0, addr + EN0_RCNTHI);
442 writeb (0, addr + EN0_RSARLO);
443 writeb (ring_page, addr + EN0_RSARHI);
444 writeb (E8390_RREAD | E8390_START, addr + E8390_CMD);
446 if (ei_local->word16)
447 readsw (dma_base, hdr, sizeof (*hdr) >> 1);
449 readsb (dma_base, hdr, sizeof (*hdr));
451 writeb (ENISR_RDC, addr + EN0_ISR);
452 ei_local->dmaing = 0;
456 * Open/initialize the board. This is called (in the current kernel)
457 * sometime after booting when the 'ifconfig' program is run.
459 * This routine should set everything up anew at each open, even
460 * registers that "should" only need to be set once at boot, so that
461 * there is non-reboot way to recover if something goes wrong.
464 etherh_open(struct net_device *dev)
466 struct ei_device *ei_local = netdev_priv(dev);
468 if (!is_valid_ether_addr(dev->dev_addr)) {
469 printk(KERN_WARNING "%s: invalid ethernet MAC address\n",
474 if (request_irq(dev->irq, __ei_interrupt, 0, dev->name, dev))
478 * Make sure that we aren't going to change the
479 * media type on the next reset - we are about to
480 * do automedia manually now.
482 ei_local->interface_num = 0;
485 * If we are doing automedia detection, do it now.
486 * This is more reliable than the 8390's detection.
488 if (dev->flags & IFF_AUTOMEDIA) {
489 dev->if_port = IF_PORT_10BASET;
492 if (!etherh_getifstat(dev)) {
493 dev->if_port = IF_PORT_10BASE2;
506 * The inverse routine to etherh_open().
509 etherh_close(struct net_device *dev)
512 free_irq (dev->irq, dev);
520 static void __init etherh_banner(void)
522 static int version_printed;
524 if (net_debug && version_printed++ == 0)
525 printk(KERN_INFO "%s", version);
529 * Read the ethernet address string from the on board rom.
530 * This is an ascii string...
532 static int __init etherh_addr(char *addr, struct expansion_card *ec)
534 struct in_chunk_dir cd;
537 if (!ecard_readchunk(&cd, ec, 0xf5, 0)) {
538 printk(KERN_ERR "%s: unable to read podule description string\n",
543 s = strchr(cd.d.string, '(');
547 for (i = 0; i < 6; i++) {
548 addr[i] = simple_strtoul(s + 1, &s, 0x10);
549 if (*s != (i == 5? ')' : ':'))
557 printk(KERN_ERR "%s: unable to parse MAC address: %s\n",
558 ec->dev.bus_id, cd.d.string);
565 * Create an ethernet address from the system serial number.
567 static int __init etherm_addr(char *addr)
571 if (system_serial_low == 0 && system_serial_high == 0)
574 serial = system_serial_low | system_serial_high;
579 addr[3] = 0x10 + (serial >> 24);
580 addr[4] = serial >> 16;
581 addr[5] = serial >> 8;
585 static void etherh_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
587 strlcpy(info->driver, DRV_NAME, sizeof(info->driver));
588 strlcpy(info->version, DRV_VERSION, sizeof(info->version));
589 strlcpy(info->bus_info, dev->dev.parent->bus_id,
590 sizeof(info->bus_info));
593 static int etherh_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
595 cmd->supported = etherh_priv(dev)->supported;
596 cmd->speed = SPEED_10;
597 cmd->duplex = DUPLEX_HALF;
598 cmd->port = dev->if_port == IF_PORT_10BASET ? PORT_TP : PORT_BNC;
599 cmd->autoneg = dev->flags & IFF_AUTOMEDIA ? AUTONEG_ENABLE : AUTONEG_DISABLE;
603 static int etherh_set_settings(struct net_device *dev, struct ethtool_cmd *cmd)
605 switch (cmd->autoneg) {
607 dev->flags |= IFF_AUTOMEDIA;
610 case AUTONEG_DISABLE:
613 dev->if_port = IF_PORT_10BASET;
617 dev->if_port = IF_PORT_10BASE2;
623 dev->flags &= ~IFF_AUTOMEDIA;
635 static const struct ethtool_ops etherh_ethtool_ops = {
636 .get_settings = etherh_get_settings,
637 .set_settings = etherh_set_settings,
638 .get_drvinfo = etherh_get_drvinfo,
641 static u32 etherh_regoffsets[16];
642 static u32 etherm_regoffsets[16];
645 etherh_probe(struct expansion_card *ec, const struct ecard_id *id)
647 const struct etherh_data *data = id->data;
648 struct ei_device *ei_local;
649 struct net_device *dev;
650 struct etherh_priv *eh;
655 ret = ecard_request_resources(ec);
659 dev = ____alloc_ei_netdev(sizeof(struct etherh_priv));
665 SET_MODULE_OWNER(dev);
666 SET_NETDEV_DEV(dev, &ec->dev);
668 dev->open = etherh_open;
669 dev->stop = etherh_close;
670 dev->set_config = etherh_set_config;
672 dev->ethtool_ops = ðerh_ethtool_ops;
674 if (data->supported & SUPPORTED_Autoneg)
675 dev->flags |= IFF_AUTOMEDIA;
676 if (data->supported & SUPPORTED_TP) {
677 dev->flags |= IFF_PORTSEL;
678 dev->if_port = IF_PORT_10BASET;
679 } else if (data->supported & SUPPORTED_BNC) {
680 dev->flags |= IFF_PORTSEL;
681 dev->if_port = IF_PORT_10BASE2;
683 dev->if_port = IF_PORT_UNKNOWN;
685 eh = etherh_priv(dev);
686 eh->supported = data->supported;
688 eh->id = ec->cid.product;
689 eh->memc = ecardm_iomap(ec, ECARD_RES_MEMC, 0, PAGE_SIZE);
695 eh->ctrl_port = eh->memc;
696 if (data->ctrl_ioc) {
697 eh->ioc_fast = ecardm_iomap(ec, ECARD_RES_IOCFAST, 0, PAGE_SIZE);
702 eh->ctrl_port = eh->ioc_fast;
705 dev->base_addr = (unsigned long)eh->memc + data->ns8390_offset;
706 eh->dma_base = eh->memc + data->dataport_offset;
707 eh->ctrl_port += data->ctrlport_offset;
710 * IRQ and control port handling - only for non-NIC slot cards.
712 if (ec->slot_no != 8) {
713 ecard_setirq(ec, ðerh_ops, eh);
716 * If we're in the NIC slot, make sure the IRQ is enabled
718 etherh_set_ctrl(eh, ETHERH_CP_IE);
721 ei_local = netdev_priv(dev);
722 spin_lock_init(&ei_local->page_lock);
724 if (ec->cid.product == PROD_ANT_ETHERM) {
725 etherm_addr(dev->dev_addr);
726 ei_local->reg_offset = etherm_regoffsets;
728 etherh_addr(dev->dev_addr, ec);
729 ei_local->reg_offset = etherh_regoffsets;
732 ei_local->name = dev->name;
733 ei_local->word16 = 1;
734 ei_local->tx_start_page = data->tx_start_page;
735 ei_local->rx_start_page = ei_local->tx_start_page + TX_PAGES;
736 ei_local->stop_page = data->stop_page;
737 ei_local->reset_8390 = etherh_reset;
738 ei_local->block_input = etherh_block_input;
739 ei_local->block_output = etherh_block_output;
740 ei_local->get_8390_hdr = etherh_get_header;
741 ei_local->interface_num = 0;
744 __NS8390_init(dev, 0);
746 ret = register_netdev(dev);
750 printk(KERN_INFO "%s: %s in slot %d, ",
751 dev->name, data->name, ec->slot_no);
753 for (i = 0; i < 6; i++)
754 printk("%2.2x%c", dev->dev_addr[i], i == 5 ? '\n' : ':');
756 ecard_set_drvdata(ec, dev);
763 ecard_release_resources(ec);
768 static void __devexit etherh_remove(struct expansion_card *ec)
770 struct net_device *dev = ecard_get_drvdata(ec);
772 ecard_set_drvdata(ec, NULL);
774 unregister_netdev(dev);
778 ecard_release_resources(ec);
781 static struct etherh_data etherm_data = {
782 .ns8390_offset = ETHERM_NS8390,
783 .dataport_offset = ETHERM_NS8390 + ETHERM_DATAPORT,
784 .ctrlport_offset = ETHERM_NS8390 + ETHERM_CTRLPORT,
785 .name = "ANT EtherM",
786 .supported = SUPPORTED_10baseT_Half,
787 .tx_start_page = ETHERM_TX_START_PAGE,
788 .stop_page = ETHERM_STOP_PAGE,
791 static struct etherh_data etherlan500_data = {
792 .ns8390_offset = ETHERH500_NS8390,
793 .dataport_offset = ETHERH500_NS8390 + ETHERH500_DATAPORT,
794 .ctrlport_offset = ETHERH500_CTRLPORT,
796 .name = "i3 EtherH 500",
797 .supported = SUPPORTED_10baseT_Half,
798 .tx_start_page = ETHERH_TX_START_PAGE,
799 .stop_page = ETHERH_STOP_PAGE,
802 static struct etherh_data etherlan600_data = {
803 .ns8390_offset = ETHERH600_NS8390,
804 .dataport_offset = ETHERH600_NS8390 + ETHERH600_DATAPORT,
805 .ctrlport_offset = ETHERH600_NS8390 + ETHERH600_CTRLPORT,
806 .name = "i3 EtherH 600",
807 .supported = SUPPORTED_10baseT_Half | SUPPORTED_TP | SUPPORTED_BNC | SUPPORTED_Autoneg,
808 .tx_start_page = ETHERH_TX_START_PAGE,
809 .stop_page = ETHERH_STOP_PAGE,
812 static struct etherh_data etherlan600a_data = {
813 .ns8390_offset = ETHERH600_NS8390,
814 .dataport_offset = ETHERH600_NS8390 + ETHERH600_DATAPORT,
815 .ctrlport_offset = ETHERH600_NS8390 + ETHERH600_CTRLPORT,
816 .name = "i3 EtherH 600A",
817 .supported = SUPPORTED_10baseT_Half | SUPPORTED_TP | SUPPORTED_BNC | SUPPORTED_Autoneg,
818 .tx_start_page = ETHERH_TX_START_PAGE,
819 .stop_page = ETHERH_STOP_PAGE,
822 static const struct ecard_id etherh_ids[] = {
823 { MANU_ANT, PROD_ANT_ETHERM, ðerm_data },
824 { MANU_I3, PROD_I3_ETHERLAN500, ðerlan500_data },
825 { MANU_I3, PROD_I3_ETHERLAN600, ðerlan600_data },
826 { MANU_I3, PROD_I3_ETHERLAN600A, ðerlan600a_data },
830 static struct ecard_driver etherh_driver = {
831 .probe = etherh_probe,
832 .remove = __devexit_p(etherh_remove),
833 .id_table = etherh_ids,
839 static int __init etherh_init(void)
843 for (i = 0; i < 16; i++) {
844 etherh_regoffsets[i] = i << 2;
845 etherm_regoffsets[i] = i << 5;
848 return ecard_register_driver(ðerh_driver);
851 static void __exit etherh_exit(void)
853 ecard_remove_driver(ðerh_driver);
856 module_init(etherh_init);
857 module_exit(etherh_exit);