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 * **********************
27 #include <linux/module.h>
28 #include <linux/moduleparam.h>
29 #include <linux/init.h>
30 #include <linux/ioport.h>
31 #include <linux/delay.h>
32 #include <linux/netdevice.h>
34 #include <linux/arcdevice.h>
37 #define VERSION "arcnet: COM90xx chipset support\n"
40 /* Define this to speed up the autoprobe by assuming if only one io port and
41 * shmem are left in the list at Stage 5, they must correspond to each
44 * This is undefined by default because it might not always be true, and the
45 * extra check makes the autoprobe even more careful. Speed demons can turn
46 * it on - I think it should be fine if you only have one ARCnet card
49 * If no ARCnet cards are installed, this delay never happens anyway and thus
50 * 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)
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] =
119 unsigned long *shmems
;
120 void __iomem
**iomem
;
121 int numports
, numshmems
, *port
;
125 if (!io
&& !irq
&& !shmem
&& !*device
&& com90xx_skip_probe
)
128 shmems
= kzalloc(((0x100000-0xa0000) / 0x800) * sizeof(unsigned long),
132 iomem
= kzalloc(((0x100000-0xa0000) / 0x800) * sizeof(void __iomem
*),
139 BUGLVL(D_NORMAL
) printk(VERSION
);
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 BUGMSG2(D_INIT
, "\n");
163 BUGMSG2(D_INIT
, "S1: ");
165 BUGMSG2(D_INIT
, "%Xh ", *port
);
169 if (!request_region(*port
, ARCNET_TOTAL_SIZE
, "arcnet (90xx)")) {
170 BUGMSG2(D_INIT_REASONS
, "(request_region)\n");
171 BUGMSG2(D_INIT_REASONS
, "S1: ");
172 BUGLVL(D_INIT_REASONS
) numprint
= 0;
173 *port
-- = ports
[--numports
];
176 if (ASTATUS() == 0xFF) {
177 BUGMSG2(D_INIT_REASONS
, "(empty)\n");
178 BUGMSG2(D_INIT_REASONS
, "S1: ");
179 BUGLVL(D_INIT_REASONS
) numprint
= 0;
180 release_region(*port
, ARCNET_TOTAL_SIZE
);
181 *port
-- = ports
[--numports
];
184 inb(_RESET
); /* begin resetting card */
186 BUGMSG2(D_INIT_REASONS
, "\n");
187 BUGMSG2(D_INIT_REASONS
, "S1: ");
188 BUGLVL(D_INIT_REASONS
) numprint
= 0;
190 BUGMSG2(D_INIT
, "\n");
193 BUGMSG2(D_NORMAL
, "S1: No ARCnet cards found.\n");
198 /* Stage 2: we have now reset any possible ARCnet cards, so we can't
199 * do anything until they finish. If D_INIT, print the list of
200 * cards that are left.
203 for (port
= &ports
[0]; port
< ports
+ numports
; port
++) {
207 BUGMSG2(D_INIT
, "\n");
208 BUGMSG2(D_INIT
, "S2: ");
210 BUGMSG2(D_INIT
, "%Xh ", *port
);
212 BUGMSG2(D_INIT
, "\n");
215 /* Stage 3: abandon any shmem addresses that don't have the signature
216 * 0xD1 byte in the right place, or are read-only.
219 for (index
= 0, p
= &shmems
[0]; index
< numshmems
; p
++, index
++) {
225 BUGMSG2(D_INIT
, "\n");
226 BUGMSG2(D_INIT
, "S3: ");
228 BUGMSG2(D_INIT
, "%lXh ", *p
);
230 if (!request_mem_region(*p
, MIRROR_SIZE
, "arcnet (90xx)")) {
231 BUGMSG2(D_INIT_REASONS
, "(request_mem_region)\n");
232 BUGMSG2(D_INIT_REASONS
, "Stage 3: ");
233 BUGLVL(D_INIT_REASONS
) numprint
= 0;
236 base
= ioremap(*p
, MIRROR_SIZE
);
238 BUGMSG2(D_INIT_REASONS
, "(ioremap)\n");
239 BUGMSG2(D_INIT_REASONS
, "Stage 3: ");
240 BUGLVL(D_INIT_REASONS
) numprint
= 0;
243 if (readb(base
) != TESTvalue
) {
244 BUGMSG2(D_INIT_REASONS
, "(%02Xh != %02Xh)\n",
245 readb(base
), TESTvalue
);
246 BUGMSG2(D_INIT_REASONS
, "S3: ");
247 BUGLVL(D_INIT_REASONS
) numprint
= 0;
250 /* By writing 0x42 to the TESTvalue location, we also make
251 * sure no "mirror" shmem areas show up - if they occur
252 * in another pass through this loop, they will be discarded
253 * because *cptr != TESTvalue.
256 if (readb(base
) != 0x42) {
257 BUGMSG2(D_INIT_REASONS
, "(read only)\n");
258 BUGMSG2(D_INIT_REASONS
, "S3: ");
261 BUGMSG2(D_INIT_REASONS
, "\n");
262 BUGMSG2(D_INIT_REASONS
, "S3: ");
263 BUGLVL(D_INIT_REASONS
) numprint
= 0;
269 release_mem_region(*p
, MIRROR_SIZE
);
271 *p
-- = shmems
[--numshmems
];
274 BUGMSG2(D_INIT
, "\n");
277 BUGMSG2(D_NORMAL
, "S3: No ARCnet cards found.\n");
278 for (port
= &ports
[0]; port
< ports
+ numports
; port
++)
279 release_region(*port
, ARCNET_TOTAL_SIZE
);
284 /* Stage 4: something of a dummy, to report the shmems that are
285 * still possible after stage 3.
288 for (p
= &shmems
[0]; p
< shmems
+ numshmems
; p
++) {
292 BUGMSG2(D_INIT
, "\n");
293 BUGMSG2(D_INIT
, "S4: ");
295 BUGMSG2(D_INIT
, "%lXh ", *p
);
297 BUGMSG2(D_INIT
, "\n");
299 /* Stage 5: for any ports that have the correct status, can disable
300 * the RESET flag, and (if no irq is given) generate an autoirq,
301 * register an ARCnet device.
303 * Currently, we can only register one device per probe, so quit
304 * after the first one is found.
307 for (port
= &ports
[0]; port
< ports
+ numports
; port
++) {
312 BUGMSG2(D_INIT
, "\n");
313 BUGMSG2(D_INIT
, "S5: ");
315 BUGMSG2(D_INIT
, "%Xh ", *port
);
321 != (NORXflag
| RECONflag
| TXFREEflag
| RESETflag
)) {
322 BUGMSG2(D_INIT_REASONS
, "(status=%Xh)\n", status
);
323 BUGMSG2(D_INIT_REASONS
, "S5: ");
324 BUGLVL(D_INIT_REASONS
) numprint
= 0;
325 release_region(*port
, ARCNET_TOTAL_SIZE
);
326 *port
-- = ports
[--numports
];
329 ACOMMAND(CFLAGScmd
| RESETclear
| CONFIGclear
);
331 if (status
& RESETflag
) {
332 BUGMSG2(D_INIT_REASONS
, " (eternal reset, status=%Xh)\n",
334 BUGMSG2(D_INIT_REASONS
, "S5: ");
335 BUGLVL(D_INIT_REASONS
) numprint
= 0;
336 release_region(*port
, ARCNET_TOTAL_SIZE
);
337 *port
-- = ports
[--numports
];
340 /* skip this completely if an IRQ was given, because maybe
341 * we're on a machine that locks during autoirq!
344 /* if we do this, we're sure to get an IRQ since the
345 * card has just reset and the NORXflag is on until
346 * we tell it to start receiving.
348 airqmask
= probe_irq_on();
352 airq
= probe_irq_off(airqmask
);
355 BUGMSG2(D_INIT_REASONS
, "(airq=%d)\n", airq
);
356 BUGMSG2(D_INIT_REASONS
, "S5: ");
357 BUGLVL(D_INIT_REASONS
) numprint
= 0;
358 release_region(*port
, ARCNET_TOTAL_SIZE
);
359 *port
-- = ports
[--numports
];
366 BUGMSG2(D_INIT
, "(%d,", airq
);
369 /* Everything seems okay. But which shmem, if any, puts
370 * back its signature byte when the card is reset?
372 * If there are multiple cards installed, there might be
373 * multiple shmems still in the list.
376 if (numports
> 1 || numshmems
> 1) {
380 /* just one shmem and port, assume they match */
381 writeb(TESTvalue
, iomem
[0]);
388 for (index
= 0; index
< numshmems
; index
++) {
389 u_long ptr
= shmems
[index
];
390 void __iomem
*base
= iomem
[index
];
392 if (readb(base
) == TESTvalue
) { /* found one */
393 BUGMSG2(D_INIT
, "%lXh)\n", *p
);
396 /* register the card */
397 if (com90xx_found(*port
, airq
, ptr
, base
) == 0)
401 /* remove shmem from the list */
402 shmems
[index
] = shmems
[--numshmems
];
403 iomem
[index
] = iomem
[numshmems
];
404 break; /* go to the next I/O port */
406 BUGMSG2(D_INIT_REASONS
, "%Xh-", readb(base
));
411 BUGLVL(D_INIT
) printk("no matching shmem)\n");
412 BUGLVL(D_INIT_REASONS
) printk("S5: ");
413 BUGLVL(D_INIT_REASONS
) numprint
= 0;
416 release_region(*port
, ARCNET_TOTAL_SIZE
);
417 *port
-- = ports
[--numports
];
420 BUGLVL(D_INIT_REASONS
) printk("\n");
422 /* Now put back TESTvalue on all leftover shmems. */
423 for (index
= 0; index
< numshmems
; index
++) {
424 writeb(TESTvalue
, iomem
[index
]);
425 iounmap(iomem
[index
]);
426 release_mem_region(shmems
[index
], MIRROR_SIZE
);
432 static int check_mirror(unsigned long addr
, size_t size
)
437 if (!request_mem_region(addr
, size
, "arcnet (90xx)"))
440 p
= ioremap(addr
, size
);
442 if (readb(p
) == TESTvalue
)
449 release_mem_region(addr
, size
);
453 /* Set up the struct net_device associated with this card. Called after
456 static int __init
com90xx_found(int ioaddr
, int airq
, u_long shmem
, void __iomem
*p
)
458 struct net_device
*dev
= NULL
;
459 struct arcnet_local
*lp
;
460 u_long first_mirror
, last_mirror
;
463 /* allocate struct net_device */
464 dev
= alloc_arcdev(device
);
466 BUGMSG2(D_NORMAL
, "com90xx: Can't allocate device!\n");
468 release_mem_region(shmem
, MIRROR_SIZE
);
471 lp
= netdev_priv(dev
);
472 /* find the real shared memory start/end points, including mirrors */
474 /* guess the actual size of one "memory mirror" - the number of
475 * bytes between copies of the shared memory. On most cards, it's
476 * 2k (or there are no mirrors at all) but on some, it's 4k.
478 mirror_size
= MIRROR_SIZE
;
479 if (readb(p
) == TESTvalue
&&
480 check_mirror(shmem
- MIRROR_SIZE
, MIRROR_SIZE
) == 0 &&
481 check_mirror(shmem
- 2 * MIRROR_SIZE
, MIRROR_SIZE
) == 1)
482 mirror_size
= 2 * MIRROR_SIZE
;
484 first_mirror
= shmem
- mirror_size
;
485 while (check_mirror(first_mirror
, mirror_size
) == 1)
486 first_mirror
-= mirror_size
;
487 first_mirror
+= mirror_size
;
489 last_mirror
= shmem
+ mirror_size
;
490 while (check_mirror(last_mirror
, mirror_size
) == 1)
491 last_mirror
+= mirror_size
;
492 last_mirror
-= mirror_size
;
494 dev
->mem_start
= first_mirror
;
495 dev
->mem_end
= last_mirror
+ MIRROR_SIZE
- 1;
498 release_mem_region(shmem
, MIRROR_SIZE
);
500 if (!request_mem_region(dev
->mem_start
, dev
->mem_end
- dev
->mem_start
+ 1, "arcnet (90xx)"))
503 /* reserve the irq */
504 if (request_irq(airq
, &arcnet_interrupt
, 0, "arcnet (90xx)", dev
)) {
505 BUGMSG(D_NORMAL
, "Can't get IRQ %d!\n", airq
);
506 goto err_release_mem
;
510 /* Initialize the rest of the device structure. */
511 lp
->card_name
= "COM90xx";
512 lp
->hw
.command
= com90xx_command
;
513 lp
->hw
.status
= com90xx_status
;
514 lp
->hw
.intmask
= com90xx_setmask
;
515 lp
->hw
.reset
= com90xx_reset
;
516 lp
->hw
.owner
= THIS_MODULE
;
517 lp
->hw
.copy_to_card
= com90xx_copy_to_card
;
518 lp
->hw
.copy_from_card
= com90xx_copy_from_card
;
519 lp
->mem_start
= ioremap(dev
->mem_start
, dev
->mem_end
- dev
->mem_start
+ 1);
520 if (!lp
->mem_start
) {
521 BUGMSG(D_NORMAL
, "Can't remap device memory!\n");
525 /* get and check the station ID from offset 1 in shmem */
526 dev
->dev_addr
[0] = readb(lp
->mem_start
+ 1);
528 dev
->base_addr
= ioaddr
;
530 BUGMSG(D_NORMAL
, "COM90xx station %02Xh found at %03lXh, IRQ %d, "
531 "ShMem %lXh (%ld*%xh).\n",
533 dev
->base_addr
, dev
->irq
, dev
->mem_start
,
534 (dev
->mem_end
- dev
->mem_start
+ 1) / mirror_size
, mirror_size
);
536 if (register_netdev(dev
))
539 cards
[numcards
++] = dev
;
543 iounmap(lp
->mem_start
);
545 free_irq(dev
->irq
, dev
);
547 release_mem_region(dev
->mem_start
, dev
->mem_end
- dev
->mem_start
+ 1);
554 static void com90xx_command(struct net_device
*dev
, int cmd
)
556 short ioaddr
= dev
->base_addr
;
562 static int com90xx_status(struct net_device
*dev
)
564 short ioaddr
= dev
->base_addr
;
570 static void com90xx_setmask(struct net_device
*dev
, int mask
)
572 short ioaddr
= dev
->base_addr
;
579 * Do a hardware reset on the card, and set up necessary registers.
581 * This should be called as little as possible, because it disrupts the
582 * token on the network (causes a RECON) and requires a significant delay.
584 * However, it does make sure the card is in a defined state.
586 static int com90xx_reset(struct net_device
*dev
, int really_reset
)
588 struct arcnet_local
*lp
= netdev_priv(dev
);
589 short ioaddr
= dev
->base_addr
;
591 BUGMSG(D_INIT
, "Resetting (status=%02Xh)\n", ASTATUS());
598 ACOMMAND(CFLAGScmd
| RESETclear
); /* clear flags & end reset */
599 ACOMMAND(CFLAGScmd
| CONFIGclear
);
601 /* don't do this until we verify that it doesn't hurt older cards! */
602 /* outb(inb(_CONFIG) | ENABLE16flag, _CONFIG); */
604 /* verify that the ARCnet signature byte is present */
605 if (readb(lp
->mem_start
) != TESTvalue
) {
607 BUGMSG(D_NORMAL
, "reset failed: TESTvalue not present.\n");
610 /* enable extended (512-byte) packets */
611 ACOMMAND(CONFIGcmd
| EXTconf
);
613 /* clean out all the memory to make debugging make more sense :) */
615 memset_io(lp
->mem_start
, 0x42, 2048);
617 /* done! return success. */
621 static void com90xx_copy_to_card(struct net_device
*dev
, int bufnum
, int offset
,
622 void *buf
, int count
)
624 struct arcnet_local
*lp
= netdev_priv(dev
);
625 void __iomem
*memaddr
= lp
->mem_start
+ bufnum
* 512 + offset
;
626 TIME("memcpy_toio", count
, memcpy_toio(memaddr
, buf
, count
));
630 static void com90xx_copy_from_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
;
635 TIME("memcpy_fromio", count
, memcpy_fromio(buf
, memaddr
, count
));
639 MODULE_LICENSE("GPL");
641 static int __init
com90xx_init(void)
651 static void __exit
com90xx_exit(void)
653 struct net_device
*dev
;
654 struct arcnet_local
*lp
;
657 for (count
= 0; count
< numcards
; count
++) {
659 lp
= netdev_priv(dev
);
661 unregister_netdev(dev
);
662 free_irq(dev
->irq
, dev
);
663 iounmap(lp
->mem_start
);
664 release_region(dev
->base_addr
, ARCNET_TOTAL_SIZE
);
665 release_mem_region(dev
->mem_start
, dev
->mem_end
- dev
->mem_start
+ 1);
670 module_init(com90xx_init
);
671 module_exit(com90xx_exit
);
674 static int __init
com90xx_setup(char *s
)
678 s
= get_options(s
, 8, ints
);
679 if (!ints
[0] && !*s
) {
680 printk("com90xx: Disabled.\n");
686 printk("com90xx: Too many arguments.\n");
687 case 3: /* Mem address */
691 case 1: /* IO address */
696 snprintf(device
, sizeof(device
), "%s", s
);
701 __setup("com90xx=", com90xx_setup
);