2 * Linux ARCnet driver - "RIM I" (entirely mem-mapped) cards
4 * Written 1994-1999 by Avery Pennarun.
5 * Written 1999-2000 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/kernel.h>
28 #include <linux/module.h>
29 #include <linux/moduleparam.h>
30 #include <linux/ioport.h>
31 #include <linux/delay.h>
32 #include <linux/netdevice.h>
33 #include <linux/bootmem.h>
34 #include <linux/init.h>
35 #include <linux/interrupt.h>
37 #include <linux/arcdevice.h>
39 #define VERSION "arcnet: RIM I (entirely mem-mapped) support\n"
41 /* Internal function declarations */
43 static int arcrimi_probe(struct net_device *dev);
44 static int arcrimi_found(struct net_device *dev);
45 static void arcrimi_command(struct net_device *dev, int command);
46 static int arcrimi_status(struct net_device *dev);
47 static void arcrimi_setmask(struct net_device *dev, int mask);
48 static int arcrimi_reset(struct net_device *dev, int really_reset);
49 static void arcrimi_copy_to_card(struct net_device *dev, int bufnum, int offset,
50 void *buf, int count);
51 static void arcrimi_copy_from_card(struct net_device *dev, int bufnum, int offset,
52 void *buf, int count);
54 /* Handy defines for ARCnet specific stuff */
56 /* Amount of I/O memory used by the card */
57 #define BUFFER_SIZE (512)
58 #define MIRROR_SIZE (BUFFER_SIZE * 4)
60 /* COM 9026 controller chip --> ARCnet register addresses */
61 #define _INTMASK (ioaddr + 0) /* writable */
62 #define _STATUS (ioaddr + 0) /* readable */
63 #define _COMMAND (ioaddr + 1) /* writable, returns random vals on read (?) */
64 #define _RESET (ioaddr + 8) /* software reset (on read) */
65 #define _MEMDATA (ioaddr + 12) /* Data port for IO-mapped memory */
66 #define _ADDR_HI (ioaddr + 15) /* Control registers for said */
67 #define _ADDR_LO (ioaddr + 14)
68 #define _CONFIG (ioaddr + 2) /* Configuration register */
74 #define ASTATUS() readb(_STATUS)
75 #define ACOMMAND(cmd) writeb((cmd), _COMMAND)
76 #define AINTMASK(msk) writeb((msk), _INTMASK)
77 #define SETCONF() writeb(lp->config, _CONFIG)
80 * We cannot probe for a RIM I card; one reason is I don't know how to reset
81 * them. In fact, we can't even get their node ID automatically. So, we
82 * need to be passed a specific shmem address, IRQ, and node ID.
84 static int __init arcrimi_probe(struct net_device *dev)
86 BUGLVL(D_NORMAL) printk(VERSION);
87 BUGLVL(D_NORMAL) printk("E-mail me if you actually test the RIM I driver, please!\n");
89 BUGLVL(D_NORMAL) printk("Given: node %02Xh, shmem %lXh, irq %d\n",
90 dev->dev_addr[0], dev->mem_start, dev->irq);
92 if (dev->mem_start <= 0 || dev->irq <= 0) {
93 BUGLVL(D_NORMAL) printk("No autoprobe for RIM I; you must specify the shmem and irq!\n");
96 if (dev->dev_addr[0] == 0) {
97 BUGLVL(D_NORMAL) printk("You need to specify your card's station ID!\n");
101 * Grab the memory region at mem_start for MIRROR_SIZE bytes.
102 * Later in arcrimi_found() the real size will be determined
103 * and this reserve will be released and the correct size
106 if (!request_mem_region(dev->mem_start, MIRROR_SIZE, "arcnet (90xx)")) {
107 BUGLVL(D_NORMAL) printk("Card memory already allocated\n");
110 return arcrimi_found(dev);
113 static int check_mirror(unsigned long addr, size_t size)
118 if (!request_mem_region(addr, size, "arcnet (90xx)"))
121 p = ioremap(addr, size);
123 if (readb(p) == TESTvalue)
130 release_mem_region(addr, size);
135 * Set up the struct net_device associated with this card. Called after
138 static int __init arcrimi_found(struct net_device *dev)
140 struct arcnet_local *lp;
141 unsigned long first_mirror, last_mirror, shmem;
146 p = ioremap(dev->mem_start, MIRROR_SIZE);
148 release_mem_region(dev->mem_start, MIRROR_SIZE);
149 BUGMSG(D_NORMAL, "Can't ioremap\n");
153 /* reserve the irq */
154 if (request_irq(dev->irq, arcnet_interrupt, 0, "arcnet (RIM I)", dev)) {
156 release_mem_region(dev->mem_start, MIRROR_SIZE);
157 BUGMSG(D_NORMAL, "Can't get IRQ %d!\n", dev->irq);
161 shmem = dev->mem_start;
162 writeb(TESTvalue, p);
163 writeb(dev->dev_addr[0], p + 1); /* actually the node ID */
165 /* find the real shared memory start/end points, including mirrors */
167 /* guess the actual size of one "memory mirror" - the number of
168 * bytes between copies of the shared memory. On most cards, it's
169 * 2k (or there are no mirrors at all) but on some, it's 4k.
171 mirror_size = MIRROR_SIZE;
172 if (readb(p) == TESTvalue &&
173 check_mirror(shmem - MIRROR_SIZE, MIRROR_SIZE) == 0 &&
174 check_mirror(shmem - 2 * MIRROR_SIZE, MIRROR_SIZE) == 1)
175 mirror_size = 2 * MIRROR_SIZE;
177 first_mirror = shmem - mirror_size;
178 while (check_mirror(first_mirror, mirror_size) == 1)
179 first_mirror -= mirror_size;
180 first_mirror += mirror_size;
182 last_mirror = shmem + mirror_size;
183 while (check_mirror(last_mirror, mirror_size) == 1)
184 last_mirror += mirror_size;
185 last_mirror -= mirror_size;
187 dev->mem_start = first_mirror;
188 dev->mem_end = last_mirror + MIRROR_SIZE - 1;
190 /* initialize the rest of the device structure. */
192 lp = netdev_priv(dev);
193 lp->card_name = "RIM I";
194 lp->hw.command = arcrimi_command;
195 lp->hw.status = arcrimi_status;
196 lp->hw.intmask = arcrimi_setmask;
197 lp->hw.reset = arcrimi_reset;
198 lp->hw.owner = THIS_MODULE;
199 lp->hw.copy_to_card = arcrimi_copy_to_card;
200 lp->hw.copy_from_card = arcrimi_copy_from_card;
203 * re-reserve the memory region - arcrimi_probe() alloced this reqion
204 * but didn't know the real size. Free that region and then re-get
205 * with the correct size. There is a VERY slim chance this could
209 release_mem_region(shmem, MIRROR_SIZE);
210 if (!request_mem_region(dev->mem_start,
211 dev->mem_end - dev->mem_start + 1,
213 BUGMSG(D_NORMAL, "Card memory already allocated\n");
217 lp->mem_start = ioremap(dev->mem_start, dev->mem_end - dev->mem_start + 1);
218 if (!lp->mem_start) {
219 BUGMSG(D_NORMAL, "Can't remap device memory!\n");
220 goto err_release_mem;
223 /* get and check the station ID from offset 1 in shmem */
224 dev->dev_addr[0] = readb(lp->mem_start + 1);
226 BUGMSG(D_NORMAL, "ARCnet RIM I: station %02Xh found at IRQ %d, ShMem %lXh (%ld*%d bytes)\n",
228 dev->irq, dev->mem_start,
229 (dev->mem_end - dev->mem_start + 1) / mirror_size, mirror_size);
231 err = register_netdev(dev);
238 iounmap(lp->mem_start);
240 release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
242 free_irq(dev->irq, dev);
247 * Do a hardware reset on the card, and set up necessary registers.
249 * This should be called as little as possible, because it disrupts the
250 * token on the network (causes a RECON) and requires a significant delay.
252 * However, it does make sure the card is in a defined state.
254 static int arcrimi_reset(struct net_device *dev, int really_reset)
256 struct arcnet_local *lp = netdev_priv(dev);
257 void __iomem *ioaddr = lp->mem_start + 0x800;
259 BUGMSG(D_INIT, "Resetting %s (status=%02Xh)\n", dev->name, ASTATUS());
262 writeb(TESTvalue, ioaddr - 0x800); /* fake reset */
265 ACOMMAND(CFLAGScmd | RESETclear); /* clear flags & end reset */
266 ACOMMAND(CFLAGScmd | CONFIGclear);
268 /* enable extended (512-byte) packets */
269 ACOMMAND(CONFIGcmd | EXTconf);
271 /* done! return success. */
275 static void arcrimi_setmask(struct net_device *dev, int mask)
277 struct arcnet_local *lp = netdev_priv(dev);
278 void __iomem *ioaddr = lp->mem_start + 0x800;
283 static int arcrimi_status(struct net_device *dev)
285 struct arcnet_local *lp = netdev_priv(dev);
286 void __iomem *ioaddr = lp->mem_start + 0x800;
291 static void arcrimi_command(struct net_device *dev, int cmd)
293 struct arcnet_local *lp = netdev_priv(dev);
294 void __iomem *ioaddr = lp->mem_start + 0x800;
299 static void arcrimi_copy_to_card(struct net_device *dev, int bufnum, int offset,
300 void *buf, int count)
302 struct arcnet_local *lp = netdev_priv(dev);
303 void __iomem *memaddr = lp->mem_start + 0x800 + bufnum * 512 + offset;
305 TIME("memcpy_toio", count, memcpy_toio(memaddr, buf, count));
308 static void arcrimi_copy_from_card(struct net_device *dev, int bufnum, int offset,
309 void *buf, int count)
311 struct arcnet_local *lp = netdev_priv(dev);
312 void __iomem *memaddr = lp->mem_start + 0x800 + bufnum * 512 + offset;
314 TIME("memcpy_fromio", count, memcpy_fromio(buf, memaddr, count));
318 static int io; /* use the insmod io= irq= node= options */
320 static char device[9]; /* use eg. device=arc1 to change name */
322 module_param(node, int, 0);
323 module_param(io, int, 0);
324 module_param(irq, int, 0);
325 module_param_string(device, device, sizeof(device), 0);
326 MODULE_LICENSE("GPL");
328 static struct net_device *my_dev;
330 static int __init arc_rimi_init(void)
332 struct net_device *dev;
334 dev = alloc_arcdev(device);
338 if (node && node != 0xff)
339 dev->dev_addr[0] = node;
346 if (arcrimi_probe(dev)) {
355 static void __exit arc_rimi_exit(void)
357 struct net_device *dev = my_dev;
358 struct arcnet_local *lp = netdev_priv(dev);
360 unregister_netdev(dev);
361 iounmap(lp->mem_start);
362 release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
363 free_irq(dev->irq, dev);
368 static int __init arcrimi_setup(char *s)
372 s = get_options(s, 8, ints);
377 printk("arcrimi: Too many arguments.\n");
378 case 3: /* Node ID */
382 case 1: /* IO address */
386 snprintf(device, sizeof(device), "%s", s);
389 __setup("arcrimi=", arcrimi_setup);
392 module_init(arc_rimi_init)
393 module_exit(arc_rimi_exit)