2 * abyss.c: Network driver for the Madge Smart 16/4 PCI Mk2 token ring card.
4 * Written 1999-2000 by Adam Fritzler
6 * This software may be used and distributed according to the terms
7 * of the GNU General Public License, incorporated herein by reference.
9 * This driver module supports the following cards:
10 * - Madge Smart 16/4 PCI Mk2
15 * Modification History:
16 * 30-Dec-99 AF Split off from the tms380tr driver.
17 * 22-Jan-00 AF Updated to use indirect read/writes
18 * 23-Nov-00 JG New PCI API, cleanups
22 * 1. See if we can use MMIO instead of inb/outb/inw/outw
23 * 2. Add support for Mk1 (has AT24 attached to the PCI
28 #include <linux/module.h>
29 #include <linux/kernel.h>
30 #include <linux/errno.h>
31 #include <linux/pci.h>
32 #include <linux/init.h>
33 #include <linux/netdevice.h>
34 #include <linux/trdevice.h>
36 #include <asm/system.h>
41 #include "abyss.h" /* Madge-specific constants */
43 static char version[] __devinitdata =
44 "abyss.c: v1.02 23/11/2000 by Adam Fritzler\n";
46 #define ABYSS_IO_EXTENT 64
48 static struct pci_device_id abyss_pci_tbl[] = {
49 { PCI_VENDOR_ID_MADGE, PCI_DEVICE_ID_MADGE_MK2,
50 PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_NETWORK_TOKEN_RING << 8, 0x00ffffff, },
51 { } /* Terminating entry */
53 MODULE_DEVICE_TABLE(pci, abyss_pci_tbl);
55 MODULE_LICENSE("GPL");
57 static int abyss_open(struct net_device *dev);
58 static int abyss_close(struct net_device *dev);
59 static void abyss_enable(struct net_device *dev);
60 static int abyss_chipset_init(struct net_device *dev);
61 static void abyss_read_eeprom(struct net_device *dev);
62 static unsigned short abyss_setnselout_pins(struct net_device *dev);
64 static void at24_writedatabyte(unsigned long regaddr, unsigned char byte);
65 static int at24_sendfullcmd(unsigned long regaddr, unsigned char cmd, unsigned char addr);
66 static int at24_sendcmd(unsigned long regaddr, unsigned char cmd);
67 static unsigned char at24_readdatabit(unsigned long regaddr);
68 static unsigned char at24_readdatabyte(unsigned long regaddr);
69 static int at24_waitforack(unsigned long regaddr);
70 static int at24_waitfornack(unsigned long regaddr);
71 static void at24_setlines(unsigned long regaddr, unsigned char clock, unsigned char data);
72 static void at24_start(unsigned long regaddr);
73 static unsigned char at24_readb(unsigned long regaddr, unsigned char addr);
75 static unsigned short abyss_sifreadb(struct net_device *dev, unsigned short reg)
77 return inb(dev->base_addr + reg);
80 static unsigned short abyss_sifreadw(struct net_device *dev, unsigned short reg)
82 return inw(dev->base_addr + reg);
85 static void abyss_sifwriteb(struct net_device *dev, unsigned short val, unsigned short reg)
87 outb(val, dev->base_addr + reg);
90 static void abyss_sifwritew(struct net_device *dev, unsigned short val, unsigned short reg)
92 outw(val, dev->base_addr + reg);
95 static int __devinit abyss_attach(struct pci_dev *pdev, const struct pci_device_id *ent)
97 static int versionprinted;
98 struct net_device *dev;
100 int ret, pci_irq_line;
101 unsigned long pci_ioaddr;
102 DECLARE_MAC_BUF(mac);
104 if (versionprinted++ == 0)
105 printk("%s", version);
107 if (pci_enable_device(pdev))
110 /* Remove I/O space marker in bit 0. */
111 pci_irq_line = pdev->irq;
112 pci_ioaddr = pci_resource_start (pdev, 0);
114 /* At this point we have found a valid card. */
116 dev = alloc_trdev(sizeof(struct net_local));
120 if (!request_region(pci_ioaddr, ABYSS_IO_EXTENT, dev->name)) {
125 ret = request_irq(pdev->irq, tms380tr_interrupt, IRQF_SHARED,
130 dev->base_addr = pci_ioaddr;
131 dev->irq = pci_irq_line;
133 printk("%s: Madge Smart 16/4 PCI Mk2 (Abyss)\n", dev->name);
134 printk("%s: IO: %#4lx IRQ: %d\n",
135 dev->name, pci_ioaddr, dev->irq);
137 * The TMS SIF registers lay 0x10 above the card base address.
139 dev->base_addr += 0x10;
141 ret = tmsdev_init(dev, &pdev->dev);
143 printk("%s: unable to get memory for dev->priv.\n",
148 abyss_read_eeprom(dev);
150 printk("%s: Ring Station Address: %s\n",
151 dev->name, print_mac(mac, dev->dev_addr));
153 tp = netdev_priv(dev);
154 tp->setnselout = abyss_setnselout_pins;
155 tp->sifreadb = abyss_sifreadb;
156 tp->sifreadw = abyss_sifreadw;
157 tp->sifwriteb = abyss_sifwriteb;
158 tp->sifwritew = abyss_sifwritew;
160 memcpy(tp->ProductID, "Madge PCI 16/4 Mk2", PROD_ID_SIZE + 1);
162 dev->open = abyss_open;
163 dev->stop = abyss_close;
165 pci_set_drvdata(pdev, dev);
166 SET_NETDEV_DEV(dev, &pdev->dev);
168 ret = register_netdev(dev);
174 pci_set_drvdata(pdev, NULL);
177 free_irq(pdev->irq, dev);
179 release_region(pci_ioaddr, ABYSS_IO_EXTENT);
185 static unsigned short abyss_setnselout_pins(struct net_device *dev)
187 unsigned short val = 0;
188 struct net_local *tp = netdev_priv(dev);
190 if(tp->DataRate == SPEED_4)
191 val |= 0x01; /* Set 4Mbps */
193 val |= 0x00; /* Set 16Mbps */
199 * The following Madge boards should use this code:
200 * - Smart 16/4 PCI Mk2 (Abyss)
201 * - Smart 16/4 PCI Mk1 (PCI T)
202 * - Smart 16/4 Client Plus PnP (Big Apple)
203 * - Smart 16/4 Cardbus Mk2
205 * These access an Atmel AT24 SEEPROM using their glue chip registers.
208 static void at24_writedatabyte(unsigned long regaddr, unsigned char byte)
212 for (i = 0; i < 8; i++) {
213 at24_setlines(regaddr, 0, (byte >> (7-i))&0x01);
214 at24_setlines(regaddr, 1, (byte >> (7-i))&0x01);
215 at24_setlines(regaddr, 0, (byte >> (7-i))&0x01);
219 static int at24_sendfullcmd(unsigned long regaddr, unsigned char cmd, unsigned char addr)
221 if (at24_sendcmd(regaddr, cmd)) {
222 at24_writedatabyte(regaddr, addr);
223 return at24_waitforack(regaddr);
228 static int at24_sendcmd(unsigned long regaddr, unsigned char cmd)
232 for (i = 0; i < 10; i++) {
234 at24_writedatabyte(regaddr, cmd);
235 if (at24_waitforack(regaddr))
241 static unsigned char at24_readdatabit(unsigned long regaddr)
245 at24_setlines(regaddr, 0, 1);
246 at24_setlines(regaddr, 1, 1);
247 val = (inb(regaddr) & AT24_DATA)?1:0;
248 at24_setlines(regaddr, 1, 1);
249 at24_setlines(regaddr, 0, 1);
253 static unsigned char at24_readdatabyte(unsigned long regaddr)
255 unsigned char data = 0;
258 for (i = 0; i < 8; i++) {
260 data |= at24_readdatabit(regaddr);
266 static int at24_waitforack(unsigned long regaddr)
270 for (i = 0; i < 10; i++) {
271 if ((at24_readdatabit(regaddr) & 0x01) == 0x00)
277 static int at24_waitfornack(unsigned long regaddr)
280 for (i = 0; i < 10; i++) {
281 if ((at24_readdatabit(regaddr) & 0x01) == 0x01)
287 static void at24_setlines(unsigned long regaddr, unsigned char clock, unsigned char data)
289 unsigned char val = AT24_ENABLE;
296 tms380tr_wait(20); /* Very necessary. */
299 static void at24_start(unsigned long regaddr)
301 at24_setlines(regaddr, 0, 1);
302 at24_setlines(regaddr, 1, 1);
303 at24_setlines(regaddr, 1, 0);
304 at24_setlines(regaddr, 0, 1);
307 static unsigned char at24_readb(unsigned long regaddr, unsigned char addr)
309 unsigned char data = 0xff;
311 if (at24_sendfullcmd(regaddr, AT24_WRITE, addr)) {
312 if (at24_sendcmd(regaddr, AT24_READ)) {
313 data = at24_readdatabyte(regaddr);
314 if (!at24_waitfornack(regaddr))
323 * Enable basic functions of the Madge chipset needed
324 * for initialization.
326 static void abyss_enable(struct net_device *dev)
328 unsigned char reset_reg;
329 unsigned long ioaddr;
331 ioaddr = dev->base_addr;
332 reset_reg = inb(ioaddr + PCIBM2_RESET_REG);
333 reset_reg |= PCIBM2_RESET_REG_CHIP_NRES;
334 outb(reset_reg, ioaddr + PCIBM2_RESET_REG);
339 * Enable the functions of the Madge chipset needed for
340 * full working order.
342 static int abyss_chipset_init(struct net_device *dev)
344 unsigned char reset_reg;
345 unsigned long ioaddr;
347 ioaddr = dev->base_addr;
349 reset_reg = inb(ioaddr + PCIBM2_RESET_REG);
351 reset_reg |= PCIBM2_RESET_REG_CHIP_NRES;
352 outb(reset_reg, ioaddr + PCIBM2_RESET_REG);
354 reset_reg &= ~(PCIBM2_RESET_REG_CHIP_NRES |
355 PCIBM2_RESET_REG_FIFO_NRES |
356 PCIBM2_RESET_REG_SIF_NRES);
357 outb(reset_reg, ioaddr + PCIBM2_RESET_REG);
361 reset_reg |= PCIBM2_RESET_REG_CHIP_NRES;
362 outb(reset_reg, ioaddr + PCIBM2_RESET_REG);
364 reset_reg |= PCIBM2_RESET_REG_SIF_NRES;
365 outb(reset_reg, ioaddr + PCIBM2_RESET_REG);
367 reset_reg |= PCIBM2_RESET_REG_FIFO_NRES;
368 outb(reset_reg, ioaddr + PCIBM2_RESET_REG);
370 outb(PCIBM2_INT_CONTROL_REG_SINTEN |
371 PCIBM2_INT_CONTROL_REG_PCI_ERR_ENABLE,
372 ioaddr + PCIBM2_INT_CONTROL_REG);
374 outb(30, ioaddr + PCIBM2_FIFO_THRESHOLD);
379 static inline void abyss_chipset_close(struct net_device *dev)
381 unsigned long ioaddr;
383 ioaddr = dev->base_addr;
384 outb(0, ioaddr + PCIBM2_RESET_REG);
388 * Read configuration data from the AT24 SEEPROM on Madge cards.
391 static void abyss_read_eeprom(struct net_device *dev)
393 struct net_local *tp;
394 unsigned long ioaddr;
398 tp = netdev_priv(dev);
399 ioaddr = dev->base_addr;
401 /* Must enable glue chip first */
404 val = at24_readb(ioaddr + PCIBM2_SEEPROM_REG,
405 PCIBM2_SEEPROM_RING_SPEED);
406 tp->DataRate = val?SPEED_4:SPEED_16; /* set open speed */
407 printk("%s: SEEPROM: ring speed: %dMb/sec\n", dev->name, tp->DataRate);
409 val = at24_readb(ioaddr + PCIBM2_SEEPROM_REG,
410 PCIBM2_SEEPROM_RAM_SIZE) * 128;
411 printk("%s: SEEPROM: adapter RAM: %dkb\n", dev->name, val);
414 for (i = 0; i < 6; i++)
415 dev->dev_addr[i] = at24_readb(ioaddr + PCIBM2_SEEPROM_REG,
416 PCIBM2_SEEPROM_BIA+i);
419 static int abyss_open(struct net_device *dev)
421 abyss_chipset_init(dev);
426 static int abyss_close(struct net_device *dev)
429 abyss_chipset_close(dev);
433 static void __devexit abyss_detach (struct pci_dev *pdev)
435 struct net_device *dev = pci_get_drvdata(pdev);
438 unregister_netdev(dev);
439 release_region(dev->base_addr-0x10, ABYSS_IO_EXTENT);
440 free_irq(dev->irq, dev);
443 pci_set_drvdata(pdev, NULL);
446 static struct pci_driver abyss_driver = {
448 .id_table = abyss_pci_tbl,
449 .probe = abyss_attach,
450 .remove = __devexit_p(abyss_detach),
453 static int __init abyss_init (void)
455 return pci_register_driver(&abyss_driver);
458 static void __exit abyss_rmmod (void)
460 pci_unregister_driver (&abyss_driver);
463 module_init(abyss_init);
464 module_exit(abyss_rmmod);