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>
39 #include <linux/arcdevice.h>
41 /* Define this to speed up the autoprobe by assuming if only one io port and
42 * shmem are left in the list at Stage 5, they must correspond to each
45 * This is undefined by default because it might not always be true, and the
46 * extra check makes the autoprobe even more careful. Speed demons can turn
47 * it on - I think it should be fine if you only have one ARCnet card
50 * If no ARCnet cards are installed, this delay never happens anyway and thus
51 * the option has no effect.
55 /* Internal function declarations */
56 static int com90xx_found(int ioaddr, int airq, u_long shmem, void __iomem *);
57 static void com90xx_command(struct net_device *dev, int command);
58 static int com90xx_status(struct net_device *dev);
59 static void com90xx_setmask(struct net_device *dev, int mask);
60 static int com90xx_reset(struct net_device *dev, int really_reset);
61 static void com90xx_copy_to_card(struct net_device *dev, int bufnum, int offset,
62 void *buf, int count);
63 static void com90xx_copy_from_card(struct net_device *dev, int bufnum, int offset,
64 void *buf, int count);
66 /* Known ARCnet cards */
68 static struct net_device *cards[16];
71 /* Handy defines for ARCnet specific stuff */
73 /* The number of low I/O ports used by the card */
74 #define ARCNET_TOTAL_SIZE 16
76 /* Amount of I/O memory used by the card */
77 #define BUFFER_SIZE (512)
78 #define MIRROR_SIZE (BUFFER_SIZE * 4)
80 /* COM 9026 controller chip --> ARCnet register addresses */
81 #define _INTMASK (ioaddr + 0) /* writable */
82 #define _STATUS (ioaddr + 0) /* readable */
83 #define _COMMAND (ioaddr + 1) /* writable, returns random vals on read (?) */
84 #define _CONFIG (ioaddr + 2) /* Configuration register */
85 #define _RESET (ioaddr + 8) /* software reset (on read) */
86 #define _MEMDATA (ioaddr + 12) /* Data port for IO-mapped memory */
87 #define _ADDR_HI (ioaddr + 15) /* Control registers for said */
88 #define _ADDR_LO (ioaddr + 14)
94 #define ASTATUS() inb(_STATUS)
95 #define ACOMMAND(cmd) outb((cmd), _COMMAND)
96 #define AINTMASK(msk) outb((msk), _INTMASK)
98 static int com90xx_skip_probe __initdata = 0;
100 /* Module parameters */
102 static int io; /* use the insmod io= irq= shmem= options */
105 static char device[9]; /* use eg. device=arc1 to change name */
107 module_param(io, int, 0);
108 module_param(irq, int, 0);
109 module_param(shmem, int, 0);
110 module_param_string(device, device, sizeof(device), 0);
112 static void __init com90xx_probe(void)
114 int count, status, ioaddr, numprint, airq, openparen = 0;
115 unsigned long airqmask;
116 int ports[(0x3f0 - 0x200) / 16 + 1] = { 0 };
117 unsigned long *shmems;
118 void __iomem **iomem;
119 int numports, numshmems, *port;
123 if (!io && !irq && !shmem && !*device && com90xx_skip_probe)
126 shmems = kzalloc(((0x100000 - 0xa0000) / 0x800) * sizeof(unsigned long),
130 iomem = kzalloc(((0x100000 - 0xa0000) / 0x800) * sizeof(void __iomem *),
137 if (BUGLVL(D_NORMAL))
138 pr_info("%s\n", "COM90xx chipset support");
140 /* set up the arrays where we'll store the possible probe addresses */
141 numports = numshmems = 0;
143 ports[numports++] = io;
145 for (count = 0x200; count <= 0x3f0; count += 16)
146 ports[numports++] = count;
148 shmems[numshmems++] = shmem;
150 for (count = 0xA0000; count <= 0xFF800; count += 2048)
151 shmems[numshmems++] = count;
153 /* Stage 1: abandon any reserved ports, or ones with status==0xFF
154 * (empty), and reset any others by reading the reset port.
157 for (port = &ports[0]; port - ports < numports; port++) {
161 arc_cont(D_INIT, "\n");
162 arc_cont(D_INIT, "S1: ");
164 arc_cont(D_INIT, "%Xh ", *port);
168 if (!request_region(*port, ARCNET_TOTAL_SIZE, "arcnet (90xx)")) {
169 arc_cont(D_INIT_REASONS, "(request_region)\n");
170 arc_cont(D_INIT_REASONS, "S1: ");
171 if (BUGLVL(D_INIT_REASONS))
173 *port-- = ports[--numports];
176 if (ASTATUS() == 0xFF) {
177 arc_cont(D_INIT_REASONS, "(empty)\n");
178 arc_cont(D_INIT_REASONS, "S1: ");
179 if (BUGLVL(D_INIT_REASONS))
181 release_region(*port, ARCNET_TOTAL_SIZE);
182 *port-- = ports[--numports];
185 inb(_RESET); /* begin resetting card */
187 arc_cont(D_INIT_REASONS, "\n");
188 arc_cont(D_INIT_REASONS, "S1: ");
189 if (BUGLVL(D_INIT_REASONS))
192 arc_cont(D_INIT, "\n");
195 arc_cont(D_NORMAL, "S1: No ARCnet cards found.\n");
200 /* Stage 2: we have now reset any possible ARCnet cards, so we can't
201 * do anything until they finish. If D_INIT, print the list of
202 * cards that are left.
205 for (port = &ports[0]; port < ports + numports; port++) {
209 arc_cont(D_INIT, "\n");
210 arc_cont(D_INIT, "S2: ");
212 arc_cont(D_INIT, "%Xh ", *port);
214 arc_cont(D_INIT, "\n");
217 /* Stage 3: abandon any shmem addresses that don't have the signature
218 * 0xD1 byte in the right place, or are read-only.
221 for (index = 0, p = &shmems[0]; index < numshmems; p++, index++) {
227 arc_cont(D_INIT, "\n");
228 arc_cont(D_INIT, "S3: ");
230 arc_cont(D_INIT, "%lXh ", *p);
232 if (!request_mem_region(*p, MIRROR_SIZE, "arcnet (90xx)")) {
233 arc_cont(D_INIT_REASONS, "(request_mem_region)\n");
234 arc_cont(D_INIT_REASONS, "Stage 3: ");
235 if (BUGLVL(D_INIT_REASONS))
239 base = ioremap(*p, MIRROR_SIZE);
241 arc_cont(D_INIT_REASONS, "(ioremap)\n");
242 arc_cont(D_INIT_REASONS, "Stage 3: ");
243 if (BUGLVL(D_INIT_REASONS))
247 if (readb(base) != TESTvalue) {
248 arc_cont(D_INIT_REASONS, "(%02Xh != %02Xh)\n",
249 readb(base), TESTvalue);
250 arc_cont(D_INIT_REASONS, "S3: ");
251 if (BUGLVL(D_INIT_REASONS))
255 /* By writing 0x42 to the TESTvalue location, we also make
256 * sure no "mirror" shmem areas show up - if they occur
257 * in another pass through this loop, they will be discarded
258 * because *cptr != TESTvalue.
261 if (readb(base) != 0x42) {
262 arc_cont(D_INIT_REASONS, "(read only)\n");
263 arc_cont(D_INIT_REASONS, "S3: ");
266 arc_cont(D_INIT_REASONS, "\n");
267 arc_cont(D_INIT_REASONS, "S3: ");
268 if (BUGLVL(D_INIT_REASONS))
275 release_mem_region(*p, MIRROR_SIZE);
277 *p-- = shmems[--numshmems];
280 arc_cont(D_INIT, "\n");
283 arc_cont(D_NORMAL, "S3: No ARCnet cards found.\n");
284 for (port = &ports[0]; port < ports + numports; port++)
285 release_region(*port, ARCNET_TOTAL_SIZE);
290 /* Stage 4: something of a dummy, to report the shmems that are
291 * still possible after stage 3.
294 for (p = &shmems[0]; p < shmems + numshmems; p++) {
298 arc_cont(D_INIT, "\n");
299 arc_cont(D_INIT, "S4: ");
301 arc_cont(D_INIT, "%lXh ", *p);
303 arc_cont(D_INIT, "\n");
305 /* Stage 5: for any ports that have the correct status, can disable
306 * the RESET flag, and (if no irq is given) generate an autoirq,
307 * register an ARCnet device.
309 * Currently, we can only register one device per probe, so quit
310 * after the first one is found.
313 for (port = &ports[0]; port < ports + numports; port++) {
319 arc_cont(D_INIT, "\n");
320 arc_cont(D_INIT, "S5: ");
322 arc_cont(D_INIT, "%Xh ", *port);
328 != (NORXflag | RECONflag | TXFREEflag | RESETflag)) {
329 arc_cont(D_INIT_REASONS, "(status=%Xh)\n", status);
330 arc_cont(D_INIT_REASONS, "S5: ");
331 if (BUGLVL(D_INIT_REASONS))
333 release_region(*port, ARCNET_TOTAL_SIZE);
334 *port-- = ports[--numports];
337 ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
339 if (status & RESETflag) {
340 arc_cont(D_INIT_REASONS, " (eternal reset, status=%Xh)\n",
342 arc_cont(D_INIT_REASONS, "S5: ");
343 if (BUGLVL(D_INIT_REASONS))
345 release_region(*port, ARCNET_TOTAL_SIZE);
346 *port-- = ports[--numports];
349 /* skip this completely if an IRQ was given, because maybe
350 * we're on a machine that locks during autoirq!
353 /* if we do this, we're sure to get an IRQ since the
354 * card has just reset and the NORXflag is on until
355 * we tell it to start receiving.
357 airqmask = probe_irq_on();
361 airq = probe_irq_off(airqmask);
364 arc_cont(D_INIT_REASONS, "(airq=%d)\n", airq);
365 arc_cont(D_INIT_REASONS, "S5: ");
366 if (BUGLVL(D_INIT_REASONS))
368 release_region(*port, ARCNET_TOTAL_SIZE);
369 *port-- = ports[--numports];
376 arc_cont(D_INIT, "(%d,", airq);
379 /* Everything seems okay. But which shmem, if any, puts
380 * back its signature byte when the card is reset?
382 * If there are multiple cards installed, there might be
383 * multiple shmems still in the list.
386 if (numports > 1 || numshmems > 1) {
390 /* just one shmem and port, assume they match */
391 writeb(TESTvalue, iomem[0]);
398 for (index = 0; index < numshmems; index++) {
399 u_long ptr = shmems[index];
400 void __iomem *base = iomem[index];
402 if (readb(base) == TESTvalue) { /* found one */
403 arc_cont(D_INIT, "%lXh)\n", *p);
406 /* register the card */
407 if (com90xx_found(*port, airq, ptr, base) == 0)
411 /* remove shmem from the list */
412 shmems[index] = shmems[--numshmems];
413 iomem[index] = iomem[numshmems];
414 break; /* go to the next I/O port */
416 arc_cont(D_INIT_REASONS, "%Xh-", readb(base));
422 pr_cont("no matching shmem)\n");
423 if (BUGLVL(D_INIT_REASONS)) {
429 release_region(*port, ARCNET_TOTAL_SIZE);
430 *port-- = ports[--numports];
433 if (BUGLVL(D_INIT_REASONS))
436 /* Now put back TESTvalue on all leftover shmems. */
437 for (index = 0; index < numshmems; index++) {
438 writeb(TESTvalue, iomem[index]);
439 iounmap(iomem[index]);
440 release_mem_region(shmems[index], MIRROR_SIZE);
446 static int check_mirror(unsigned long addr, size_t size)
451 if (!request_mem_region(addr, size, "arcnet (90xx)"))
454 p = ioremap(addr, size);
456 if (readb(p) == TESTvalue)
463 release_mem_region(addr, size);
467 /* Set up the struct net_device associated with this card. Called after
470 static int __init com90xx_found(int ioaddr, int airq, u_long shmem, void __iomem *p)
472 struct net_device *dev = NULL;
473 struct arcnet_local *lp;
474 u_long first_mirror, last_mirror;
477 /* allocate struct net_device */
478 dev = alloc_arcdev(device);
480 arc_cont(D_NORMAL, "com90xx: Can't allocate device!\n");
482 release_mem_region(shmem, MIRROR_SIZE);
485 lp = netdev_priv(dev);
486 /* find the real shared memory start/end points, including mirrors */
488 /* guess the actual size of one "memory mirror" - the number of
489 * bytes between copies of the shared memory. On most cards, it's
490 * 2k (or there are no mirrors at all) but on some, it's 4k.
492 mirror_size = MIRROR_SIZE;
493 if (readb(p) == TESTvalue &&
494 check_mirror(shmem - MIRROR_SIZE, MIRROR_SIZE) == 0 &&
495 check_mirror(shmem - 2 * MIRROR_SIZE, MIRROR_SIZE) == 1)
496 mirror_size = 2 * MIRROR_SIZE;
498 first_mirror = shmem - mirror_size;
499 while (check_mirror(first_mirror, mirror_size) == 1)
500 first_mirror -= mirror_size;
501 first_mirror += mirror_size;
503 last_mirror = shmem + mirror_size;
504 while (check_mirror(last_mirror, mirror_size) == 1)
505 last_mirror += mirror_size;
506 last_mirror -= mirror_size;
508 dev->mem_start = first_mirror;
509 dev->mem_end = last_mirror + MIRROR_SIZE - 1;
512 release_mem_region(shmem, MIRROR_SIZE);
514 if (!request_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1, "arcnet (90xx)"))
517 /* reserve the irq */
518 if (request_irq(airq, arcnet_interrupt, 0, "arcnet (90xx)", dev)) {
519 arc_printk(D_NORMAL, dev, "Can't get IRQ %d!\n", airq);
520 goto err_release_mem;
524 /* Initialize the rest of the device structure. */
525 lp->card_name = "COM90xx";
526 lp->hw.command = com90xx_command;
527 lp->hw.status = com90xx_status;
528 lp->hw.intmask = com90xx_setmask;
529 lp->hw.reset = com90xx_reset;
530 lp->hw.owner = THIS_MODULE;
531 lp->hw.copy_to_card = com90xx_copy_to_card;
532 lp->hw.copy_from_card = com90xx_copy_from_card;
533 lp->mem_start = ioremap(dev->mem_start, dev->mem_end - dev->mem_start + 1);
534 if (!lp->mem_start) {
535 arc_printk(D_NORMAL, dev, "Can't remap device memory!\n");
539 /* get and check the station ID from offset 1 in shmem */
540 dev->dev_addr[0] = readb(lp->mem_start + 1);
542 dev->base_addr = ioaddr;
544 arc_printk(D_NORMAL, dev, "COM90xx station %02Xh found at %03lXh, IRQ %d, ShMem %lXh (%ld*%xh).\n",
546 dev->base_addr, dev->irq, dev->mem_start,
547 (dev->mem_end - dev->mem_start + 1) / mirror_size,
550 if (register_netdev(dev))
553 cards[numcards++] = dev;
557 iounmap(lp->mem_start);
559 free_irq(dev->irq, dev);
561 release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
567 static void com90xx_command(struct net_device *dev, int cmd)
569 short ioaddr = dev->base_addr;
574 static int com90xx_status(struct net_device *dev)
576 short ioaddr = dev->base_addr;
581 static void com90xx_setmask(struct net_device *dev, int mask)
583 short ioaddr = dev->base_addr;
588 /* Do a hardware reset on the card, and set up necessary registers.
590 * This should be called as little as possible, because it disrupts the
591 * token on the network (causes a RECON) and requires a significant delay.
593 * However, it does make sure the card is in a defined state.
595 static int com90xx_reset(struct net_device *dev, int really_reset)
597 struct arcnet_local *lp = netdev_priv(dev);
598 short ioaddr = dev->base_addr;
600 arc_printk(D_INIT, dev, "Resetting (status=%02Xh)\n", ASTATUS());
607 ACOMMAND(CFLAGScmd | RESETclear); /* clear flags & end reset */
608 ACOMMAND(CFLAGScmd | CONFIGclear);
610 /* don't do this until we verify that it doesn't hurt older cards! */
611 /* outb(inb(_CONFIG) | ENABLE16flag, _CONFIG); */
613 /* verify that the ARCnet signature byte is present */
614 if (readb(lp->mem_start) != TESTvalue) {
616 arc_printk(D_NORMAL, dev, "reset failed: TESTvalue not present.\n");
619 /* enable extended (512-byte) packets */
620 ACOMMAND(CONFIGcmd | EXTconf);
622 /* clean out all the memory to make debugging make more sense :) */
623 if (BUGLVL(D_DURING))
624 memset_io(lp->mem_start, 0x42, 2048);
626 /* done! return success. */
630 static void com90xx_copy_to_card(struct net_device *dev, int bufnum, int offset,
631 void *buf, int count)
633 struct arcnet_local *lp = netdev_priv(dev);
634 void __iomem *memaddr = lp->mem_start + bufnum * 512 + offset;
636 TIME(dev, "memcpy_toio", count, memcpy_toio(memaddr, buf, count));
639 static void com90xx_copy_from_card(struct net_device *dev, int bufnum, int offset,
640 void *buf, int count)
642 struct arcnet_local *lp = netdev_priv(dev);
643 void __iomem *memaddr = lp->mem_start + bufnum * 512 + offset;
645 TIME(dev, "memcpy_fromio", count, memcpy_fromio(buf, memaddr, count));
648 MODULE_LICENSE("GPL");
650 static int __init com90xx_init(void)
660 static void __exit com90xx_exit(void)
662 struct net_device *dev;
663 struct arcnet_local *lp;
666 for (count = 0; count < numcards; count++) {
668 lp = netdev_priv(dev);
670 unregister_netdev(dev);
671 free_irq(dev->irq, dev);
672 iounmap(lp->mem_start);
673 release_region(dev->base_addr, ARCNET_TOTAL_SIZE);
674 release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
679 module_init(com90xx_init);
680 module_exit(com90xx_exit);
683 static int __init com90xx_setup(char *s)
687 s = get_options(s, 8, ints);
688 if (!ints[0] && !*s) {
689 pr_notice("Disabled\n");
695 pr_err("Too many arguments\n");
696 case 3: /* Mem address */
700 case 1: /* IO address */
705 snprintf(device, sizeof(device), "%s", s);
710 __setup("com90xx=", com90xx_setup);