2 * Linux ARCnet driver - COM90xx chipset (memory-mapped buffers)
4 * Written 1994-1999 by Avery Pennarun.
5 * Written 1999 by Martin Mares <mj@ucw.cz>.
6 * Derived from skeleton.c by Donald Becker.
8 * Special thanks to Contemporary Controls, Inc. (www.ccontrols.com)
9 * for sponsoring the further development of this driver.
11 * **********************
13 * The original copyright of skeleton.c was as follows:
15 * skeleton.c Written 1993 by Donald Becker.
16 * Copyright 1993 United States Government as represented by the
17 * Director, National Security Agency. This software may only be used
18 * and distributed according to the terms of the GNU General Public License as
19 * modified by SRC, incorporated herein by reference.
21 * **********************
23 * For more details, see drivers/net/arcnet.c
25 * **********************
28 #define pr_fmt(fmt) "arcnet:" KBUILD_MODNAME ": " fmt
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/init.h>
33 #include <linux/interrupt.h>
34 #include <linux/ioport.h>
35 #include <linux/delay.h>
36 #include <linux/netdevice.h>
37 #include <linux/slab.h>
40 #include "arcdevice.h"
42 /* Define this to speed up the autoprobe by assuming if only one io port and
43 * shmem are left in the list at Stage 5, they must correspond to each
46 * This is undefined by default because it might not always be true, and the
47 * extra check makes the autoprobe even more careful. Speed demons can turn
48 * it on - I think it should be fine if you only have one ARCnet card
51 * If no ARCnet cards are installed, this delay never happens anyway and thus
52 * the option has no effect.
56 /* Internal function declarations */
57 static int com90xx_found(int ioaddr, int airq, u_long shmem, void __iomem *);
58 static void com90xx_command(struct net_device *dev, int command);
59 static int com90xx_status(struct net_device *dev);
60 static void com90xx_setmask(struct net_device *dev, int mask);
61 static int com90xx_reset(struct net_device *dev, int really_reset);
62 static void com90xx_copy_to_card(struct net_device *dev, int bufnum, int offset,
63 void *buf, int count);
64 static void com90xx_copy_from_card(struct net_device *dev, int bufnum,
65 int offset, void *buf, int count);
67 /* Known ARCnet cards */
69 static struct net_device *cards[16];
72 /* Handy defines for ARCnet specific stuff */
74 /* The number of low I/O ports used by the card */
75 #define ARCNET_TOTAL_SIZE 16
77 /* Amount of I/O memory used by the card */
78 #define BUFFER_SIZE (512)
79 #define MIRROR_SIZE (BUFFER_SIZE * 4)
81 /* COM 9026 controller chip --> ARCnet register addresses */
82 #define _INTMASK (ioaddr + 0) /* writable */
83 #define _STATUS (ioaddr + 0) /* readable */
84 #define _COMMAND (ioaddr + 1) /* writable, returns random vals on read (?) */
85 #define _CONFIG (ioaddr + 2) /* Configuration register */
86 #define _RESET (ioaddr + 8) /* software reset (on read) */
87 #define _MEMDATA (ioaddr + 12) /* Data port for IO-mapped memory */
88 #define _ADDR_HI (ioaddr + 15) /* Control registers for said */
89 #define _ADDR_LO (ioaddr + 14)
95 #define ASTATUS() inb(_STATUS)
96 #define ACOMMAND(cmd) outb((cmd), _COMMAND)
97 #define AINTMASK(msk) outb((msk), _INTMASK)
99 static int com90xx_skip_probe __initdata = 0;
101 /* Module parameters */
103 static int io; /* use the insmod io= irq= shmem= options */
106 static char device[9]; /* use eg. device=arc1 to change name */
108 module_param(io, int, 0);
109 module_param(irq, int, 0);
110 module_param(shmem, int, 0);
111 module_param_string(device, device, sizeof(device), 0);
113 static void __init com90xx_probe(void)
115 int count, status, ioaddr, numprint, airq, openparen = 0;
116 unsigned long airqmask;
117 int ports[(0x3f0 - 0x200) / 16 + 1] = { 0 };
118 unsigned long *shmems;
119 void __iomem **iomem;
120 int numports, numshmems, *port;
124 if (!io && !irq && !shmem && !*device && com90xx_skip_probe)
127 shmems = kzalloc(((0x100000 - 0xa0000) / 0x800) * sizeof(unsigned long),
131 iomem = kzalloc(((0x100000 - 0xa0000) / 0x800) * sizeof(void __iomem *),
138 if (BUGLVL(D_NORMAL))
139 pr_info("%s\n", "COM90xx chipset support");
141 /* set up the arrays where we'll store the possible probe addresses */
142 numports = numshmems = 0;
144 ports[numports++] = io;
146 for (count = 0x200; count <= 0x3f0; count += 16)
147 ports[numports++] = count;
149 shmems[numshmems++] = shmem;
151 for (count = 0xA0000; count <= 0xFF800; count += 2048)
152 shmems[numshmems++] = count;
154 /* Stage 1: abandon any reserved ports, or ones with status==0xFF
155 * (empty), and reset any others by reading the reset port.
158 for (port = &ports[0]; port - ports < numports; port++) {
162 arc_cont(D_INIT, "\n");
163 arc_cont(D_INIT, "S1: ");
165 arc_cont(D_INIT, "%Xh ", *port);
169 if (!request_region(*port, ARCNET_TOTAL_SIZE,
171 arc_cont(D_INIT_REASONS, "(request_region)\n");
172 arc_cont(D_INIT_REASONS, "S1: ");
173 if (BUGLVL(D_INIT_REASONS))
175 *port-- = ports[--numports];
178 if (ASTATUS() == 0xFF) {
179 arc_cont(D_INIT_REASONS, "(empty)\n");
180 arc_cont(D_INIT_REASONS, "S1: ");
181 if (BUGLVL(D_INIT_REASONS))
183 release_region(*port, ARCNET_TOTAL_SIZE);
184 *port-- = ports[--numports];
187 inb(_RESET); /* begin resetting card */
189 arc_cont(D_INIT_REASONS, "\n");
190 arc_cont(D_INIT_REASONS, "S1: ");
191 if (BUGLVL(D_INIT_REASONS))
194 arc_cont(D_INIT, "\n");
197 arc_cont(D_NORMAL, "S1: No ARCnet cards found.\n");
202 /* Stage 2: we have now reset any possible ARCnet cards, so we can't
203 * do anything until they finish. If D_INIT, print the list of
204 * cards that are left.
207 for (port = &ports[0]; port < ports + numports; port++) {
211 arc_cont(D_INIT, "\n");
212 arc_cont(D_INIT, "S2: ");
214 arc_cont(D_INIT, "%Xh ", *port);
216 arc_cont(D_INIT, "\n");
219 /* Stage 3: abandon any shmem addresses that don't have the signature
220 * 0xD1 byte in the right place, or are read-only.
223 for (index = 0, p = &shmems[0]; index < numshmems; p++, index++) {
229 arc_cont(D_INIT, "\n");
230 arc_cont(D_INIT, "S3: ");
232 arc_cont(D_INIT, "%lXh ", *p);
234 if (!request_mem_region(*p, MIRROR_SIZE, "arcnet (90xx)")) {
235 arc_cont(D_INIT_REASONS, "(request_mem_region)\n");
236 arc_cont(D_INIT_REASONS, "Stage 3: ");
237 if (BUGLVL(D_INIT_REASONS))
241 base = ioremap(*p, MIRROR_SIZE);
243 arc_cont(D_INIT_REASONS, "(ioremap)\n");
244 arc_cont(D_INIT_REASONS, "Stage 3: ");
245 if (BUGLVL(D_INIT_REASONS))
249 if (readb(base) != TESTvalue) {
250 arc_cont(D_INIT_REASONS, "(%02Xh != %02Xh)\n",
251 readb(base), TESTvalue);
252 arc_cont(D_INIT_REASONS, "S3: ");
253 if (BUGLVL(D_INIT_REASONS))
257 /* By writing 0x42 to the TESTvalue location, we also make
258 * sure no "mirror" shmem areas show up - if they occur
259 * in another pass through this loop, they will be discarded
260 * because *cptr != TESTvalue.
263 if (readb(base) != 0x42) {
264 arc_cont(D_INIT_REASONS, "(read only)\n");
265 arc_cont(D_INIT_REASONS, "S3: ");
268 arc_cont(D_INIT_REASONS, "\n");
269 arc_cont(D_INIT_REASONS, "S3: ");
270 if (BUGLVL(D_INIT_REASONS))
277 release_mem_region(*p, MIRROR_SIZE);
279 *p-- = shmems[--numshmems];
282 arc_cont(D_INIT, "\n");
285 arc_cont(D_NORMAL, "S3: No ARCnet cards found.\n");
286 for (port = &ports[0]; port < ports + numports; port++)
287 release_region(*port, ARCNET_TOTAL_SIZE);
292 /* Stage 4: something of a dummy, to report the shmems that are
293 * still possible after stage 3.
296 for (p = &shmems[0]; p < shmems + numshmems; p++) {
300 arc_cont(D_INIT, "\n");
301 arc_cont(D_INIT, "S4: ");
303 arc_cont(D_INIT, "%lXh ", *p);
305 arc_cont(D_INIT, "\n");
307 /* Stage 5: for any ports that have the correct status, can disable
308 * the RESET flag, and (if no irq is given) generate an autoirq,
309 * register an ARCnet device.
311 * Currently, we can only register one device per probe, so quit
312 * after the first one is found.
315 for (port = &ports[0]; port < ports + numports; port++) {
321 arc_cont(D_INIT, "\n");
322 arc_cont(D_INIT, "S5: ");
324 arc_cont(D_INIT, "%Xh ", *port);
330 != (NORXflag | RECONflag | TXFREEflag | RESETflag)) {
331 arc_cont(D_INIT_REASONS, "(status=%Xh)\n", status);
332 arc_cont(D_INIT_REASONS, "S5: ");
333 if (BUGLVL(D_INIT_REASONS))
335 release_region(*port, ARCNET_TOTAL_SIZE);
336 *port-- = ports[--numports];
339 ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
341 if (status & RESETflag) {
342 arc_cont(D_INIT_REASONS, " (eternal reset, status=%Xh)\n",
344 arc_cont(D_INIT_REASONS, "S5: ");
345 if (BUGLVL(D_INIT_REASONS))
347 release_region(*port, ARCNET_TOTAL_SIZE);
348 *port-- = ports[--numports];
351 /* skip this completely if an IRQ was given, because maybe
352 * we're on a machine that locks during autoirq!
355 /* if we do this, we're sure to get an IRQ since the
356 * card has just reset and the NORXflag is on until
357 * we tell it to start receiving.
359 airqmask = probe_irq_on();
363 airq = probe_irq_off(airqmask);
366 arc_cont(D_INIT_REASONS, "(airq=%d)\n", airq);
367 arc_cont(D_INIT_REASONS, "S5: ");
368 if (BUGLVL(D_INIT_REASONS))
370 release_region(*port, ARCNET_TOTAL_SIZE);
371 *port-- = ports[--numports];
378 arc_cont(D_INIT, "(%d,", airq);
381 /* Everything seems okay. But which shmem, if any, puts
382 * back its signature byte when the card is reset?
384 * If there are multiple cards installed, there might be
385 * multiple shmems still in the list.
388 if (numports > 1 || numshmems > 1) {
392 /* just one shmem and port, assume they match */
393 writeb(TESTvalue, iomem[0]);
400 for (index = 0; index < numshmems; index++) {
401 u_long ptr = shmems[index];
402 void __iomem *base = iomem[index];
404 if (readb(base) == TESTvalue) { /* found one */
405 arc_cont(D_INIT, "%lXh)\n", *p);
408 /* register the card */
409 if (com90xx_found(*port, airq, ptr, base) == 0)
413 /* remove shmem from the list */
414 shmems[index] = shmems[--numshmems];
415 iomem[index] = iomem[numshmems];
416 break; /* go to the next I/O port */
418 arc_cont(D_INIT_REASONS, "%Xh-", readb(base));
424 pr_cont("no matching shmem)\n");
425 if (BUGLVL(D_INIT_REASONS)) {
431 release_region(*port, ARCNET_TOTAL_SIZE);
432 *port-- = ports[--numports];
435 if (BUGLVL(D_INIT_REASONS))
438 /* Now put back TESTvalue on all leftover shmems. */
439 for (index = 0; index < numshmems; index++) {
440 writeb(TESTvalue, iomem[index]);
441 iounmap(iomem[index]);
442 release_mem_region(shmems[index], MIRROR_SIZE);
448 static int check_mirror(unsigned long addr, size_t size)
453 if (!request_mem_region(addr, size, "arcnet (90xx)"))
456 p = ioremap(addr, size);
458 if (readb(p) == TESTvalue)
465 release_mem_region(addr, size);
469 /* Set up the struct net_device associated with this card. Called after
472 static int __init com90xx_found(int ioaddr, int airq, u_long shmem,
475 struct net_device *dev = NULL;
476 struct arcnet_local *lp;
477 u_long first_mirror, last_mirror;
480 /* allocate struct net_device */
481 dev = alloc_arcdev(device);
483 arc_cont(D_NORMAL, "com90xx: Can't allocate device!\n");
485 release_mem_region(shmem, MIRROR_SIZE);
488 lp = netdev_priv(dev);
489 /* find the real shared memory start/end points, including mirrors */
491 /* guess the actual size of one "memory mirror" - the number of
492 * bytes between copies of the shared memory. On most cards, it's
493 * 2k (or there are no mirrors at all) but on some, it's 4k.
495 mirror_size = MIRROR_SIZE;
496 if (readb(p) == TESTvalue &&
497 check_mirror(shmem - MIRROR_SIZE, MIRROR_SIZE) == 0 &&
498 check_mirror(shmem - 2 * MIRROR_SIZE, MIRROR_SIZE) == 1)
499 mirror_size = 2 * MIRROR_SIZE;
501 first_mirror = shmem - mirror_size;
502 while (check_mirror(first_mirror, mirror_size) == 1)
503 first_mirror -= mirror_size;
504 first_mirror += mirror_size;
506 last_mirror = shmem + mirror_size;
507 while (check_mirror(last_mirror, mirror_size) == 1)
508 last_mirror += mirror_size;
509 last_mirror -= mirror_size;
511 dev->mem_start = first_mirror;
512 dev->mem_end = last_mirror + MIRROR_SIZE - 1;
515 release_mem_region(shmem, MIRROR_SIZE);
517 if (!request_mem_region(dev->mem_start,
518 dev->mem_end - dev->mem_start + 1,
522 /* reserve the irq */
523 if (request_irq(airq, arcnet_interrupt, 0, "arcnet (90xx)", dev)) {
524 arc_printk(D_NORMAL, dev, "Can't get IRQ %d!\n", airq);
525 goto err_release_mem;
529 /* Initialize the rest of the device structure. */
530 lp->card_name = "COM90xx";
531 lp->hw.command = com90xx_command;
532 lp->hw.status = com90xx_status;
533 lp->hw.intmask = com90xx_setmask;
534 lp->hw.reset = com90xx_reset;
535 lp->hw.owner = THIS_MODULE;
536 lp->hw.copy_to_card = com90xx_copy_to_card;
537 lp->hw.copy_from_card = com90xx_copy_from_card;
538 lp->mem_start = ioremap(dev->mem_start,
539 dev->mem_end - dev->mem_start + 1);
540 if (!lp->mem_start) {
541 arc_printk(D_NORMAL, dev, "Can't remap device memory!\n");
545 /* get and check the station ID from offset 1 in shmem */
546 dev->dev_addr[0] = readb(lp->mem_start + 1);
548 dev->base_addr = ioaddr;
550 arc_printk(D_NORMAL, dev, "COM90xx station %02Xh found at %03lXh, IRQ %d, ShMem %lXh (%ld*%xh).\n",
552 dev->base_addr, dev->irq, dev->mem_start,
553 (dev->mem_end - dev->mem_start + 1) / mirror_size,
556 if (register_netdev(dev))
559 cards[numcards++] = dev;
563 iounmap(lp->mem_start);
565 free_irq(dev->irq, dev);
567 release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
573 static void com90xx_command(struct net_device *dev, int cmd)
575 short ioaddr = dev->base_addr;
580 static int com90xx_status(struct net_device *dev)
582 short ioaddr = dev->base_addr;
587 static void com90xx_setmask(struct net_device *dev, int mask)
589 short ioaddr = dev->base_addr;
594 /* Do a hardware reset on the card, and set up necessary registers.
596 * This should be called as little as possible, because it disrupts the
597 * token on the network (causes a RECON) and requires a significant delay.
599 * However, it does make sure the card is in a defined state.
601 static int com90xx_reset(struct net_device *dev, int really_reset)
603 struct arcnet_local *lp = netdev_priv(dev);
604 short ioaddr = dev->base_addr;
606 arc_printk(D_INIT, dev, "Resetting (status=%02Xh)\n", ASTATUS());
613 ACOMMAND(CFLAGScmd | RESETclear); /* clear flags & end reset */
614 ACOMMAND(CFLAGScmd | CONFIGclear);
616 /* don't do this until we verify that it doesn't hurt older cards! */
617 /* outb(inb(_CONFIG) | ENABLE16flag, _CONFIG); */
619 /* verify that the ARCnet signature byte is present */
620 if (readb(lp->mem_start) != TESTvalue) {
622 arc_printk(D_NORMAL, dev, "reset failed: TESTvalue not present.\n");
625 /* enable extended (512-byte) packets */
626 ACOMMAND(CONFIGcmd | EXTconf);
628 /* clean out all the memory to make debugging make more sense :) */
629 if (BUGLVL(D_DURING))
630 memset_io(lp->mem_start, 0x42, 2048);
632 /* done! return success. */
636 static void com90xx_copy_to_card(struct net_device *dev, int bufnum,
637 int offset, void *buf, int count)
639 struct arcnet_local *lp = netdev_priv(dev);
640 void __iomem *memaddr = lp->mem_start + bufnum * 512 + offset;
642 TIME(dev, "memcpy_toio", count, memcpy_toio(memaddr, buf, count));
645 static void com90xx_copy_from_card(struct net_device *dev, int bufnum,
646 int offset, void *buf, int count)
648 struct arcnet_local *lp = netdev_priv(dev);
649 void __iomem *memaddr = lp->mem_start + bufnum * 512 + offset;
651 TIME(dev, "memcpy_fromio", count, memcpy_fromio(buf, memaddr, count));
654 MODULE_LICENSE("GPL");
656 static int __init com90xx_init(void)
666 static void __exit com90xx_exit(void)
668 struct net_device *dev;
669 struct arcnet_local *lp;
672 for (count = 0; count < numcards; count++) {
674 lp = netdev_priv(dev);
676 unregister_netdev(dev);
677 free_irq(dev->irq, dev);
678 iounmap(lp->mem_start);
679 release_region(dev->base_addr, ARCNET_TOTAL_SIZE);
680 release_mem_region(dev->mem_start,
681 dev->mem_end - dev->mem_start + 1);
686 module_init(com90xx_init);
687 module_exit(com90xx_exit);
690 static int __init com90xx_setup(char *s)
694 s = get_options(s, 8, ints);
695 if (!ints[0] && !*s) {
696 pr_notice("Disabled\n");
702 pr_err("Too many arguments\n");
703 case 3: /* Mem address */
707 case 1: /* IO address */
712 snprintf(device, sizeof(device), "%s", s);
717 __setup("com90xx=", com90xx_setup);