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 COM9026_REG_W_INTMASK 0 /* writable */
83 #define COM9026_REG_R_STATUS 0 /* readable */
84 #define COM9026_REG_W_COMMAND 1 /* writable, returns random vals on read (?) */
85 #define COM9026_REG_RW_CONFIG 2 /* Configuration register */
86 #define COM9026_REG_R_RESET 8 /* software reset (on read) */
87 #define COM9026_REG_RW_MEMDATA 12 /* Data port for IO-mapped memory */
88 #define COM9026_REG_W_ADDR_LO 14 /* Control registers for said */
89 #define COM9026_REG_W_ADDR_HI 15
91 #define COM9026_REG_R_STATION 1 /* Station ID */
93 static int com90xx_skip_probe __initdata = 0;
95 /* Module parameters */
97 static int io; /* use the insmod io= irq= shmem= options */
100 static char device[9]; /* use eg. device=arc1 to change name */
102 module_param(io, int, 0);
103 module_param(irq, int, 0);
104 module_param(shmem, int, 0);
105 module_param_string(device, device, sizeof(device), 0);
107 static void __init com90xx_probe(void)
109 int count, status, ioaddr, numprint, airq, openparen = 0;
110 unsigned long airqmask;
111 int ports[(0x3f0 - 0x200) / 16 + 1] = { 0 };
112 unsigned long *shmems;
113 void __iomem **iomem;
114 int numports, numshmems, *port;
118 if (!io && !irq && !shmem && !*device && com90xx_skip_probe)
121 shmems = kzalloc(((0x100000 - 0xa0000) / 0x800) * sizeof(unsigned long),
125 iomem = kzalloc(((0x100000 - 0xa0000) / 0x800) * sizeof(void __iomem *),
132 if (BUGLVL(D_NORMAL))
133 pr_info("%s\n", "COM90xx chipset support");
135 /* set up the arrays where we'll store the possible probe addresses */
136 numports = numshmems = 0;
138 ports[numports++] = io;
140 for (count = 0x200; count <= 0x3f0; count += 16)
141 ports[numports++] = count;
143 shmems[numshmems++] = shmem;
145 for (count = 0xA0000; count <= 0xFF800; count += 2048)
146 shmems[numshmems++] = count;
148 /* Stage 1: abandon any reserved ports, or ones with status==0xFF
149 * (empty), and reset any others by reading the reset port.
152 for (port = &ports[0]; port - ports < numports; port++) {
156 arc_cont(D_INIT, "\n");
157 arc_cont(D_INIT, "S1: ");
159 arc_cont(D_INIT, "%Xh ", *port);
163 if (!request_region(*port, ARCNET_TOTAL_SIZE,
165 arc_cont(D_INIT_REASONS, "(request_region)\n");
166 arc_cont(D_INIT_REASONS, "S1: ");
167 if (BUGLVL(D_INIT_REASONS))
169 *port-- = ports[--numports];
172 if (arcnet_inb(ioaddr, COM9026_REG_R_STATUS) == 0xFF) {
173 arc_cont(D_INIT_REASONS, "(empty)\n");
174 arc_cont(D_INIT_REASONS, "S1: ");
175 if (BUGLVL(D_INIT_REASONS))
177 release_region(*port, ARCNET_TOTAL_SIZE);
178 *port-- = ports[--numports];
181 /* begin resetting card */
182 arcnet_inb(ioaddr, COM9026_REG_R_RESET);
184 arc_cont(D_INIT_REASONS, "\n");
185 arc_cont(D_INIT_REASONS, "S1: ");
186 if (BUGLVL(D_INIT_REASONS))
189 arc_cont(D_INIT, "\n");
192 arc_cont(D_NORMAL, "S1: No ARCnet cards found.\n");
197 /* Stage 2: we have now reset any possible ARCnet cards, so we can't
198 * do anything until they finish. If D_INIT, print the list of
199 * cards that are left.
202 for (port = &ports[0]; port < ports + numports; port++) {
206 arc_cont(D_INIT, "\n");
207 arc_cont(D_INIT, "S2: ");
209 arc_cont(D_INIT, "%Xh ", *port);
211 arc_cont(D_INIT, "\n");
214 /* Stage 3: abandon any shmem addresses that don't have the signature
215 * 0xD1 byte in the right place, or are read-only.
218 for (index = 0, p = &shmems[0]; index < numshmems; p++, index++) {
224 arc_cont(D_INIT, "\n");
225 arc_cont(D_INIT, "S3: ");
227 arc_cont(D_INIT, "%lXh ", *p);
229 if (!request_mem_region(*p, MIRROR_SIZE, "arcnet (90xx)")) {
230 arc_cont(D_INIT_REASONS, "(request_mem_region)\n");
231 arc_cont(D_INIT_REASONS, "Stage 3: ");
232 if (BUGLVL(D_INIT_REASONS))
236 base = ioremap(*p, MIRROR_SIZE);
238 arc_cont(D_INIT_REASONS, "(ioremap)\n");
239 arc_cont(D_INIT_REASONS, "Stage 3: ");
240 if (BUGLVL(D_INIT_REASONS))
244 if (arcnet_readb(base, COM9026_REG_R_STATUS) != TESTvalue) {
245 arc_cont(D_INIT_REASONS, "(%02Xh != %02Xh)\n",
246 arcnet_readb(base, COM9026_REG_R_STATUS),
248 arc_cont(D_INIT_REASONS, "S3: ");
249 if (BUGLVL(D_INIT_REASONS))
253 /* By writing 0x42 to the TESTvalue location, we also make
254 * sure no "mirror" shmem areas show up - if they occur
255 * in another pass through this loop, they will be discarded
256 * because *cptr != TESTvalue.
258 arcnet_writeb(0x42, base, COM9026_REG_W_INTMASK);
259 if (arcnet_readb(base, COM9026_REG_R_STATUS) != 0x42) {
260 arc_cont(D_INIT_REASONS, "(read only)\n");
261 arc_cont(D_INIT_REASONS, "S3: ");
264 arc_cont(D_INIT_REASONS, "\n");
265 arc_cont(D_INIT_REASONS, "S3: ");
266 if (BUGLVL(D_INIT_REASONS))
273 release_mem_region(*p, MIRROR_SIZE);
275 *p-- = shmems[--numshmems];
278 arc_cont(D_INIT, "\n");
281 arc_cont(D_NORMAL, "S3: No ARCnet cards found.\n");
282 for (port = &ports[0]; port < ports + numports; port++)
283 release_region(*port, ARCNET_TOTAL_SIZE);
288 /* Stage 4: something of a dummy, to report the shmems that are
289 * still possible after stage 3.
292 for (p = &shmems[0]; p < shmems + numshmems; p++) {
296 arc_cont(D_INIT, "\n");
297 arc_cont(D_INIT, "S4: ");
299 arc_cont(D_INIT, "%lXh ", *p);
301 arc_cont(D_INIT, "\n");
303 /* Stage 5: for any ports that have the correct status, can disable
304 * the RESET flag, and (if no irq is given) generate an autoirq,
305 * register an ARCnet device.
307 * Currently, we can only register one device per probe, so quit
308 * after the first one is found.
311 for (port = &ports[0]; port < ports + numports; port++) {
317 arc_cont(D_INIT, "\n");
318 arc_cont(D_INIT, "S5: ");
320 arc_cont(D_INIT, "%Xh ", *port);
323 status = arcnet_inb(ioaddr, COM9026_REG_R_STATUS);
326 != (NORXflag | RECONflag | TXFREEflag | RESETflag)) {
327 arc_cont(D_INIT_REASONS, "(status=%Xh)\n", status);
328 arc_cont(D_INIT_REASONS, "S5: ");
329 if (BUGLVL(D_INIT_REASONS))
331 release_region(*port, ARCNET_TOTAL_SIZE);
332 *port-- = ports[--numports];
335 arcnet_outb(CFLAGScmd | RESETclear | CONFIGclear,
336 ioaddr, COM9026_REG_W_COMMAND);
337 status = arcnet_inb(ioaddr, COM9026_REG_R_STATUS);
338 if (status & RESETflag) {
339 arc_cont(D_INIT_REASONS, " (eternal reset, status=%Xh)\n",
341 arc_cont(D_INIT_REASONS, "S5: ");
342 if (BUGLVL(D_INIT_REASONS))
344 release_region(*port, ARCNET_TOTAL_SIZE);
345 *port-- = ports[--numports];
348 /* skip this completely if an IRQ was given, because maybe
349 * we're on a machine that locks during autoirq!
352 /* if we do this, we're sure to get an IRQ since the
353 * card has just reset and the NORXflag is on until
354 * we tell it to start receiving.
356 airqmask = probe_irq_on();
357 arcnet_outb(NORXflag, ioaddr, COM9026_REG_W_INTMASK);
359 arcnet_outb(0, ioaddr, COM9026_REG_W_INTMASK);
360 airq = probe_irq_off(airqmask);
363 arc_cont(D_INIT_REASONS, "(airq=%d)\n", airq);
364 arc_cont(D_INIT_REASONS, "S5: ");
365 if (BUGLVL(D_INIT_REASONS))
367 release_region(*port, ARCNET_TOTAL_SIZE);
368 *port-- = ports[--numports];
375 arc_cont(D_INIT, "(%d,", airq);
378 /* Everything seems okay. But which shmem, if any, puts
379 * back its signature byte when the card is reset?
381 * If there are multiple cards installed, there might be
382 * multiple shmems still in the list.
385 if (numports > 1 || numshmems > 1) {
386 arcnet_inb(ioaddr, COM9026_REG_R_RESET);
389 /* just one shmem and port, assume they match */
390 arcnet_writeb(TESTvalue, iomem[0],
391 COM9026_REG_W_INTMASK);
394 arcnet_inb(ioaddr, COM9026_REG_R_RESET);
398 for (index = 0; index < numshmems; index++) {
399 u_long ptr = shmems[index];
400 void __iomem *base = iomem[index];
402 if (arcnet_readb(base, COM9026_REG_R_STATUS) == 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-",
417 arcnet_readb(base, COM9026_REG_R_STATUS));
423 pr_cont("no matching shmem)\n");
424 if (BUGLVL(D_INIT_REASONS)) {
430 release_region(*port, ARCNET_TOTAL_SIZE);
431 *port-- = ports[--numports];
434 if (BUGLVL(D_INIT_REASONS))
437 /* Now put back TESTvalue on all leftover shmems. */
438 for (index = 0; index < numshmems; index++) {
439 arcnet_writeb(TESTvalue, iomem[index], COM9026_REG_W_INTMASK);
440 iounmap(iomem[index]);
441 release_mem_region(shmems[index], MIRROR_SIZE);
447 static int check_mirror(unsigned long addr, size_t size)
452 if (!request_mem_region(addr, size, "arcnet (90xx)"))
455 p = ioremap(addr, size);
457 if (arcnet_readb(p, COM9026_REG_R_STATUS) == TESTvalue)
464 release_mem_region(addr, size);
468 /* Set up the struct net_device associated with this card. Called after
471 static int __init com90xx_found(int ioaddr, int airq, u_long shmem,
474 struct net_device *dev = NULL;
475 struct arcnet_local *lp;
476 u_long first_mirror, last_mirror;
479 /* allocate struct net_device */
480 dev = alloc_arcdev(device);
482 arc_cont(D_NORMAL, "com90xx: Can't allocate device!\n");
484 release_mem_region(shmem, MIRROR_SIZE);
487 lp = netdev_priv(dev);
488 /* find the real shared memory start/end points, including mirrors */
490 /* guess the actual size of one "memory mirror" - the number of
491 * bytes between copies of the shared memory. On most cards, it's
492 * 2k (or there are no mirrors at all) but on some, it's 4k.
494 mirror_size = MIRROR_SIZE;
495 if (arcnet_readb(p, COM9026_REG_R_STATUS) == TESTvalue &&
496 check_mirror(shmem - MIRROR_SIZE, MIRROR_SIZE) == 0 &&
497 check_mirror(shmem - 2 * MIRROR_SIZE, MIRROR_SIZE) == 1)
498 mirror_size = 2 * MIRROR_SIZE;
500 first_mirror = shmem - mirror_size;
501 while (check_mirror(first_mirror, mirror_size) == 1)
502 first_mirror -= mirror_size;
503 first_mirror += mirror_size;
505 last_mirror = shmem + mirror_size;
506 while (check_mirror(last_mirror, mirror_size) == 1)
507 last_mirror += mirror_size;
508 last_mirror -= mirror_size;
510 dev->mem_start = first_mirror;
511 dev->mem_end = last_mirror + MIRROR_SIZE - 1;
514 release_mem_region(shmem, MIRROR_SIZE);
516 if (!request_mem_region(dev->mem_start,
517 dev->mem_end - dev->mem_start + 1,
521 /* reserve the irq */
522 if (request_irq(airq, arcnet_interrupt, 0, "arcnet (90xx)", dev)) {
523 arc_printk(D_NORMAL, dev, "Can't get IRQ %d!\n", airq);
524 goto err_release_mem;
528 /* Initialize the rest of the device structure. */
529 lp->card_name = "COM90xx";
530 lp->hw.command = com90xx_command;
531 lp->hw.status = com90xx_status;
532 lp->hw.intmask = com90xx_setmask;
533 lp->hw.reset = com90xx_reset;
534 lp->hw.owner = THIS_MODULE;
535 lp->hw.copy_to_card = com90xx_copy_to_card;
536 lp->hw.copy_from_card = com90xx_copy_from_card;
537 lp->mem_start = ioremap(dev->mem_start,
538 dev->mem_end - dev->mem_start + 1);
539 if (!lp->mem_start) {
540 arc_printk(D_NORMAL, dev, "Can't remap device memory!\n");
544 /* get and check the station ID from offset 1 in shmem */
545 dev->dev_addr[0] = arcnet_readb(lp->mem_start, COM9026_REG_R_STATION);
547 dev->base_addr = ioaddr;
549 arc_printk(D_NORMAL, dev, "COM90xx station %02Xh found at %03lXh, IRQ %d, ShMem %lXh (%ld*%xh).\n",
551 dev->base_addr, dev->irq, dev->mem_start,
552 (dev->mem_end - dev->mem_start + 1) / mirror_size,
555 if (register_netdev(dev))
558 cards[numcards++] = dev;
562 iounmap(lp->mem_start);
564 free_irq(dev->irq, dev);
566 release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
572 static void com90xx_command(struct net_device *dev, int cmd)
574 short ioaddr = dev->base_addr;
576 arcnet_outb(cmd, ioaddr, COM9026_REG_W_COMMAND);
579 static int com90xx_status(struct net_device *dev)
581 short ioaddr = dev->base_addr;
583 return arcnet_inb(ioaddr, COM9026_REG_R_STATUS);
586 static void com90xx_setmask(struct net_device *dev, int mask)
588 short ioaddr = dev->base_addr;
590 arcnet_outb(mask, ioaddr, COM9026_REG_W_INTMASK);
593 /* Do a hardware reset on the card, and set up necessary registers.
595 * This should be called as little as possible, because it disrupts the
596 * token on the network (causes a RECON) and requires a significant delay.
598 * However, it does make sure the card is in a defined state.
600 static int com90xx_reset(struct net_device *dev, int really_reset)
602 struct arcnet_local *lp = netdev_priv(dev);
603 short ioaddr = dev->base_addr;
605 arc_printk(D_INIT, dev, "Resetting (status=%02Xh)\n",
606 arcnet_inb(ioaddr, COM9026_REG_R_STATUS));
610 arcnet_inb(ioaddr, COM9026_REG_R_RESET);
613 /* clear flags & end reset */
614 arcnet_outb(CFLAGScmd | RESETclear, ioaddr, COM9026_REG_W_COMMAND);
615 arcnet_outb(CFLAGScmd | CONFIGclear, ioaddr, COM9026_REG_W_COMMAND);
618 /* don't do this until we verify that it doesn't hurt older cards! */
619 arcnet_outb(arcnet_inb(ioaddr, COM9026_REG_RW_CONFIG) | ENABLE16flag,
620 ioaddr, COM9026_REG_RW_CONFIG);
623 /* verify that the ARCnet signature byte is present */
624 if (arcnet_readb(lp->mem_start, COM9026_REG_R_STATUS) != TESTvalue) {
626 arc_printk(D_NORMAL, dev, "reset failed: TESTvalue not present.\n");
629 /* enable extended (512-byte) packets */
630 arcnet_outb(CONFIGcmd | EXTconf, ioaddr, COM9026_REG_W_COMMAND);
632 /* clean out all the memory to make debugging make more sense :) */
633 if (BUGLVL(D_DURING))
634 memset_io(lp->mem_start, 0x42, 2048);
636 /* done! return success. */
640 static void com90xx_copy_to_card(struct net_device *dev, int bufnum,
641 int offset, void *buf, int count)
643 struct arcnet_local *lp = netdev_priv(dev);
644 void __iomem *memaddr = lp->mem_start + bufnum * 512 + offset;
646 TIME(dev, "memcpy_toio", count, memcpy_toio(memaddr, buf, count));
649 static void com90xx_copy_from_card(struct net_device *dev, int bufnum,
650 int offset, void *buf, int count)
652 struct arcnet_local *lp = netdev_priv(dev);
653 void __iomem *memaddr = lp->mem_start + bufnum * 512 + offset;
655 TIME(dev, "memcpy_fromio", count, memcpy_fromio(buf, memaddr, count));
658 MODULE_LICENSE("GPL");
660 static int __init com90xx_init(void)
670 static void __exit com90xx_exit(void)
672 struct net_device *dev;
673 struct arcnet_local *lp;
676 for (count = 0; count < numcards; count++) {
678 lp = netdev_priv(dev);
680 unregister_netdev(dev);
681 free_irq(dev->irq, dev);
682 iounmap(lp->mem_start);
683 release_region(dev->base_addr, ARCNET_TOTAL_SIZE);
684 release_mem_region(dev->mem_start,
685 dev->mem_end - dev->mem_start + 1);
690 module_init(com90xx_init);
691 module_exit(com90xx_exit);
694 static int __init com90xx_setup(char *s)
698 s = get_options(s, 8, ints);
699 if (!ints[0] && !*s) {
700 pr_notice("Disabled\n");
706 pr_err("Too many arguments\n");
707 case 3: /* Mem address */
711 case 1: /* IO address */
716 snprintf(device, sizeof(device), "%s", s);
721 __setup("com90xx=", com90xx_setup);