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>
33 #include <linux/slab.h>
35 #include <linux/arcdevice.h>
38 #define VERSION "arcnet: COM90xx chipset support\n"
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.
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
, int offset
,
65 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)
100 static int com90xx_skip_probe __initdata
= 0;
102 /* Module parameters */
104 static int io
; /* use the insmod io= irq= shmem= options */
107 static char device
[9]; /* use eg. device=arc1 to change name */
109 module_param(io
, int, 0);
110 module_param(irq
, int, 0);
111 module_param(shmem
, int, 0);
112 module_param_string(device
, device
, sizeof(device
), 0);
114 static void __init
com90xx_probe(void)
116 int count
, status
, ioaddr
, numprint
, airq
, openparen
= 0;
117 unsigned long airqmask
;
118 int ports
[(0x3f0 - 0x200) / 16 + 1] =
120 unsigned long *shmems
;
121 void __iomem
**iomem
;
122 int numports
, numshmems
, *port
;
126 if (!io
&& !irq
&& !shmem
&& !*device
&& com90xx_skip_probe
)
129 shmems
= kzalloc(((0x100000-0xa0000) / 0x800) * sizeof(unsigned long),
133 iomem
= kzalloc(((0x100000-0xa0000) / 0x800) * sizeof(void __iomem
*),
140 BUGLVL(D_NORMAL
) printk(VERSION
);
142 /* set up the arrays where we'll store the possible probe addresses */
143 numports
= numshmems
= 0;
145 ports
[numports
++] = io
;
147 for (count
= 0x200; count
<= 0x3f0; count
+= 16)
148 ports
[numports
++] = count
;
150 shmems
[numshmems
++] = shmem
;
152 for (count
= 0xA0000; count
<= 0xFF800; count
+= 2048)
153 shmems
[numshmems
++] = count
;
155 /* Stage 1: abandon any reserved ports, or ones with status==0xFF
156 * (empty), and reset any others by reading the reset port.
159 for (port
= &ports
[0]; port
- ports
< numports
; port
++) {
163 BUGMSG2(D_INIT
, "\n");
164 BUGMSG2(D_INIT
, "S1: ");
166 BUGMSG2(D_INIT
, "%Xh ", *port
);
170 if (!request_region(*port
, ARCNET_TOTAL_SIZE
, "arcnet (90xx)")) {
171 BUGMSG2(D_INIT_REASONS
, "(request_region)\n");
172 BUGMSG2(D_INIT_REASONS
, "S1: ");
173 BUGLVL(D_INIT_REASONS
) numprint
= 0;
174 *port
-- = ports
[--numports
];
177 if (ASTATUS() == 0xFF) {
178 BUGMSG2(D_INIT_REASONS
, "(empty)\n");
179 BUGMSG2(D_INIT_REASONS
, "S1: ");
180 BUGLVL(D_INIT_REASONS
) numprint
= 0;
181 release_region(*port
, ARCNET_TOTAL_SIZE
);
182 *port
-- = ports
[--numports
];
185 inb(_RESET
); /* begin resetting card */
187 BUGMSG2(D_INIT_REASONS
, "\n");
188 BUGMSG2(D_INIT_REASONS
, "S1: ");
189 BUGLVL(D_INIT_REASONS
) numprint
= 0;
191 BUGMSG2(D_INIT
, "\n");
194 BUGMSG2(D_NORMAL
, "S1: No ARCnet cards found.\n");
199 /* Stage 2: we have now reset any possible ARCnet cards, so we can't
200 * do anything until they finish. If D_INIT, print the list of
201 * cards that are left.
204 for (port
= &ports
[0]; port
< ports
+ numports
; port
++) {
208 BUGMSG2(D_INIT
, "\n");
209 BUGMSG2(D_INIT
, "S2: ");
211 BUGMSG2(D_INIT
, "%Xh ", *port
);
213 BUGMSG2(D_INIT
, "\n");
216 /* Stage 3: abandon any shmem addresses that don't have the signature
217 * 0xD1 byte in the right place, or are read-only.
220 for (index
= 0, p
= &shmems
[0]; index
< numshmems
; p
++, index
++) {
226 BUGMSG2(D_INIT
, "\n");
227 BUGMSG2(D_INIT
, "S3: ");
229 BUGMSG2(D_INIT
, "%lXh ", *p
);
231 if (!request_mem_region(*p
, MIRROR_SIZE
, "arcnet (90xx)")) {
232 BUGMSG2(D_INIT_REASONS
, "(request_mem_region)\n");
233 BUGMSG2(D_INIT_REASONS
, "Stage 3: ");
234 BUGLVL(D_INIT_REASONS
) numprint
= 0;
237 base
= ioremap(*p
, MIRROR_SIZE
);
239 BUGMSG2(D_INIT_REASONS
, "(ioremap)\n");
240 BUGMSG2(D_INIT_REASONS
, "Stage 3: ");
241 BUGLVL(D_INIT_REASONS
) numprint
= 0;
244 if (readb(base
) != TESTvalue
) {
245 BUGMSG2(D_INIT_REASONS
, "(%02Xh != %02Xh)\n",
246 readb(base
), TESTvalue
);
247 BUGMSG2(D_INIT_REASONS
, "S3: ");
248 BUGLVL(D_INIT_REASONS
) numprint
= 0;
251 /* By writing 0x42 to the TESTvalue location, we also make
252 * sure no "mirror" shmem areas show up - if they occur
253 * in another pass through this loop, they will be discarded
254 * because *cptr != TESTvalue.
257 if (readb(base
) != 0x42) {
258 BUGMSG2(D_INIT_REASONS
, "(read only)\n");
259 BUGMSG2(D_INIT_REASONS
, "S3: ");
262 BUGMSG2(D_INIT_REASONS
, "\n");
263 BUGMSG2(D_INIT_REASONS
, "S3: ");
264 BUGLVL(D_INIT_REASONS
) numprint
= 0;
270 release_mem_region(*p
, MIRROR_SIZE
);
272 *p
-- = shmems
[--numshmems
];
275 BUGMSG2(D_INIT
, "\n");
278 BUGMSG2(D_NORMAL
, "S3: No ARCnet cards found.\n");
279 for (port
= &ports
[0]; port
< ports
+ numports
; port
++)
280 release_region(*port
, ARCNET_TOTAL_SIZE
);
285 /* Stage 4: something of a dummy, to report the shmems that are
286 * still possible after stage 3.
289 for (p
= &shmems
[0]; p
< shmems
+ numshmems
; p
++) {
293 BUGMSG2(D_INIT
, "\n");
294 BUGMSG2(D_INIT
, "S4: ");
296 BUGMSG2(D_INIT
, "%lXh ", *p
);
298 BUGMSG2(D_INIT
, "\n");
300 /* Stage 5: for any ports that have the correct status, can disable
301 * the RESET flag, and (if no irq is given) generate an autoirq,
302 * register an ARCnet device.
304 * Currently, we can only register one device per probe, so quit
305 * after the first one is found.
308 for (port
= &ports
[0]; port
< ports
+ numports
; port
++) {
313 BUGMSG2(D_INIT
, "\n");
314 BUGMSG2(D_INIT
, "S5: ");
316 BUGMSG2(D_INIT
, "%Xh ", *port
);
322 != (NORXflag
| RECONflag
| TXFREEflag
| RESETflag
)) {
323 BUGMSG2(D_INIT_REASONS
, "(status=%Xh)\n", status
);
324 BUGMSG2(D_INIT_REASONS
, "S5: ");
325 BUGLVL(D_INIT_REASONS
) numprint
= 0;
326 release_region(*port
, ARCNET_TOTAL_SIZE
);
327 *port
-- = ports
[--numports
];
330 ACOMMAND(CFLAGScmd
| RESETclear
| CONFIGclear
);
332 if (status
& RESETflag
) {
333 BUGMSG2(D_INIT_REASONS
, " (eternal reset, status=%Xh)\n",
335 BUGMSG2(D_INIT_REASONS
, "S5: ");
336 BUGLVL(D_INIT_REASONS
) numprint
= 0;
337 release_region(*port
, ARCNET_TOTAL_SIZE
);
338 *port
-- = ports
[--numports
];
341 /* skip this completely if an IRQ was given, because maybe
342 * we're on a machine that locks during autoirq!
345 /* if we do this, we're sure to get an IRQ since the
346 * card has just reset and the NORXflag is on until
347 * we tell it to start receiving.
349 airqmask
= probe_irq_on();
353 airq
= probe_irq_off(airqmask
);
356 BUGMSG2(D_INIT_REASONS
, "(airq=%d)\n", airq
);
357 BUGMSG2(D_INIT_REASONS
, "S5: ");
358 BUGLVL(D_INIT_REASONS
) numprint
= 0;
359 release_region(*port
, ARCNET_TOTAL_SIZE
);
360 *port
-- = ports
[--numports
];
367 BUGMSG2(D_INIT
, "(%d,", airq
);
370 /* Everything seems okay. But which shmem, if any, puts
371 * back its signature byte when the card is reset?
373 * If there are multiple cards installed, there might be
374 * multiple shmems still in the list.
377 if (numports
> 1 || numshmems
> 1) {
381 /* just one shmem and port, assume they match */
382 writeb(TESTvalue
, iomem
[0]);
389 for (index
= 0; index
< numshmems
; index
++) {
390 u_long ptr
= shmems
[index
];
391 void __iomem
*base
= iomem
[index
];
393 if (readb(base
) == TESTvalue
) { /* found one */
394 BUGMSG2(D_INIT
, "%lXh)\n", *p
);
397 /* register the card */
398 if (com90xx_found(*port
, airq
, ptr
, base
) == 0)
402 /* remove shmem from the list */
403 shmems
[index
] = shmems
[--numshmems
];
404 iomem
[index
] = iomem
[numshmems
];
405 break; /* go to the next I/O port */
407 BUGMSG2(D_INIT_REASONS
, "%Xh-", readb(base
));
412 BUGLVL(D_INIT
) printk("no matching shmem)\n");
413 BUGLVL(D_INIT_REASONS
) printk("S5: ");
414 BUGLVL(D_INIT_REASONS
) numprint
= 0;
417 release_region(*port
, ARCNET_TOTAL_SIZE
);
418 *port
-- = ports
[--numports
];
421 BUGLVL(D_INIT_REASONS
) printk("\n");
423 /* Now put back TESTvalue on all leftover shmems. */
424 for (index
= 0; index
< numshmems
; index
++) {
425 writeb(TESTvalue
, iomem
[index
]);
426 iounmap(iomem
[index
]);
427 release_mem_region(shmems
[index
], MIRROR_SIZE
);
433 static int check_mirror(unsigned long addr
, size_t size
)
438 if (!request_mem_region(addr
, size
, "arcnet (90xx)"))
441 p
= ioremap(addr
, size
);
443 if (readb(p
) == TESTvalue
)
450 release_mem_region(addr
, size
);
454 /* Set up the struct net_device associated with this card. Called after
457 static int __init
com90xx_found(int ioaddr
, int airq
, u_long shmem
, void __iomem
*p
)
459 struct net_device
*dev
= NULL
;
460 struct arcnet_local
*lp
;
461 u_long first_mirror
, last_mirror
;
464 /* allocate struct net_device */
465 dev
= alloc_arcdev(device
);
467 BUGMSG2(D_NORMAL
, "com90xx: Can't allocate device!\n");
469 release_mem_region(shmem
, MIRROR_SIZE
);
472 lp
= netdev_priv(dev
);
473 /* find the real shared memory start/end points, including mirrors */
475 /* guess the actual size of one "memory mirror" - the number of
476 * bytes between copies of the shared memory. On most cards, it's
477 * 2k (or there are no mirrors at all) but on some, it's 4k.
479 mirror_size
= MIRROR_SIZE
;
480 if (readb(p
) == TESTvalue
&&
481 check_mirror(shmem
- MIRROR_SIZE
, MIRROR_SIZE
) == 0 &&
482 check_mirror(shmem
- 2 * MIRROR_SIZE
, MIRROR_SIZE
) == 1)
483 mirror_size
= 2 * MIRROR_SIZE
;
485 first_mirror
= shmem
- mirror_size
;
486 while (check_mirror(first_mirror
, mirror_size
) == 1)
487 first_mirror
-= mirror_size
;
488 first_mirror
+= mirror_size
;
490 last_mirror
= shmem
+ mirror_size
;
491 while (check_mirror(last_mirror
, mirror_size
) == 1)
492 last_mirror
+= mirror_size
;
493 last_mirror
-= mirror_size
;
495 dev
->mem_start
= first_mirror
;
496 dev
->mem_end
= last_mirror
+ MIRROR_SIZE
- 1;
499 release_mem_region(shmem
, MIRROR_SIZE
);
501 if (!request_mem_region(dev
->mem_start
, dev
->mem_end
- dev
->mem_start
+ 1, "arcnet (90xx)"))
504 /* reserve the irq */
505 if (request_irq(airq
, arcnet_interrupt
, 0, "arcnet (90xx)", dev
)) {
506 BUGMSG(D_NORMAL
, "Can't get IRQ %d!\n", airq
);
507 goto err_release_mem
;
511 /* Initialize the rest of the device structure. */
512 lp
->card_name
= "COM90xx";
513 lp
->hw
.command
= com90xx_command
;
514 lp
->hw
.status
= com90xx_status
;
515 lp
->hw
.intmask
= com90xx_setmask
;
516 lp
->hw
.reset
= com90xx_reset
;
517 lp
->hw
.owner
= THIS_MODULE
;
518 lp
->hw
.copy_to_card
= com90xx_copy_to_card
;
519 lp
->hw
.copy_from_card
= com90xx_copy_from_card
;
520 lp
->mem_start
= ioremap(dev
->mem_start
, dev
->mem_end
- dev
->mem_start
+ 1);
521 if (!lp
->mem_start
) {
522 BUGMSG(D_NORMAL
, "Can't remap device memory!\n");
526 /* get and check the station ID from offset 1 in shmem */
527 dev
->dev_addr
[0] = readb(lp
->mem_start
+ 1);
529 dev
->base_addr
= ioaddr
;
531 BUGMSG(D_NORMAL
, "COM90xx station %02Xh found at %03lXh, IRQ %d, "
532 "ShMem %lXh (%ld*%xh).\n",
534 dev
->base_addr
, dev
->irq
, dev
->mem_start
,
535 (dev
->mem_end
- dev
->mem_start
+ 1) / mirror_size
, mirror_size
);
537 if (register_netdev(dev
))
540 cards
[numcards
++] = dev
;
544 iounmap(lp
->mem_start
);
546 free_irq(dev
->irq
, dev
);
548 release_mem_region(dev
->mem_start
, dev
->mem_end
- dev
->mem_start
+ 1);
555 static void com90xx_command(struct net_device
*dev
, int cmd
)
557 short ioaddr
= dev
->base_addr
;
563 static int com90xx_status(struct net_device
*dev
)
565 short ioaddr
= dev
->base_addr
;
571 static void com90xx_setmask(struct net_device
*dev
, int mask
)
573 short ioaddr
= dev
->base_addr
;
580 * Do a hardware reset on the card, and set up necessary registers.
582 * This should be called as little as possible, because it disrupts the
583 * token on the network (causes a RECON) and requires a significant delay.
585 * However, it does make sure the card is in a defined state.
587 static int com90xx_reset(struct net_device
*dev
, int really_reset
)
589 struct arcnet_local
*lp
= netdev_priv(dev
);
590 short ioaddr
= dev
->base_addr
;
592 BUGMSG(D_INIT
, "Resetting (status=%02Xh)\n", ASTATUS());
599 ACOMMAND(CFLAGScmd
| RESETclear
); /* clear flags & end reset */
600 ACOMMAND(CFLAGScmd
| CONFIGclear
);
602 /* don't do this until we verify that it doesn't hurt older cards! */
603 /* outb(inb(_CONFIG) | ENABLE16flag, _CONFIG); */
605 /* verify that the ARCnet signature byte is present */
606 if (readb(lp
->mem_start
) != TESTvalue
) {
608 BUGMSG(D_NORMAL
, "reset failed: TESTvalue not present.\n");
611 /* enable extended (512-byte) packets */
612 ACOMMAND(CONFIGcmd
| EXTconf
);
614 /* clean out all the memory to make debugging make more sense :) */
616 memset_io(lp
->mem_start
, 0x42, 2048);
618 /* done! return success. */
622 static void com90xx_copy_to_card(struct net_device
*dev
, int bufnum
, int offset
,
623 void *buf
, int count
)
625 struct arcnet_local
*lp
= netdev_priv(dev
);
626 void __iomem
*memaddr
= lp
->mem_start
+ bufnum
* 512 + offset
;
627 TIME("memcpy_toio", count
, memcpy_toio(memaddr
, buf
, count
));
631 static void com90xx_copy_from_card(struct net_device
*dev
, int bufnum
, int offset
,
632 void *buf
, int count
)
634 struct arcnet_local
*lp
= netdev_priv(dev
);
635 void __iomem
*memaddr
= lp
->mem_start
+ bufnum
* 512 + offset
;
636 TIME("memcpy_fromio", count
, memcpy_fromio(buf
, memaddr
, count
));
640 MODULE_LICENSE("GPL");
642 static int __init
com90xx_init(void)
652 static void __exit
com90xx_exit(void)
654 struct net_device
*dev
;
655 struct arcnet_local
*lp
;
658 for (count
= 0; count
< numcards
; count
++) {
660 lp
= netdev_priv(dev
);
662 unregister_netdev(dev
);
663 free_irq(dev
->irq
, dev
);
664 iounmap(lp
->mem_start
);
665 release_region(dev
->base_addr
, ARCNET_TOTAL_SIZE
);
666 release_mem_region(dev
->mem_start
, dev
->mem_end
- dev
->mem_start
+ 1);
671 module_init(com90xx_init
);
672 module_exit(com90xx_exit
);
675 static int __init
com90xx_setup(char *s
)
679 s
= get_options(s
, 8, ints
);
680 if (!ints
[0] && !*s
) {
681 printk("com90xx: Disabled.\n");
687 printk("com90xx: Too many arguments.\n");
688 case 3: /* Mem address */
692 case 1: /* IO address */
697 snprintf(device
, sizeof(device
), "%s", s
);
702 __setup("com90xx=", com90xx_setup
);