]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/net/arcnet/arc-rimi.c
treewide: Use fallthrough pseudo-keyword
[mirror_ubuntu-jammy-kernel.git] / drivers / net / arcnet / arc-rimi.c
CommitLineData
1da177e4
LT
1/*
2 * Linux ARCnet driver - "RIM I" (entirely mem-mapped) cards
cb334648 3 *
1da177e4
LT
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.
7 *
8 * Special thanks to Contemporary Controls, Inc. (www.ccontrols.com)
9 * for sponsoring the further development of this driver.
10 *
11 * **********************
12 *
13 * The original copyright of skeleton.c was as follows:
14 *
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.
20 *
21 * **********************
22 *
23 * For more details, see drivers/net/arcnet.c
24 *
25 * **********************
26 */
05a24b23
JP
27
28#define pr_fmt(fmt) "arcnet:" KBUILD_MODNAME ": " fmt
29
1da177e4
LT
30#include <linux/kernel.h>
31#include <linux/module.h>
32#include <linux/moduleparam.h>
33#include <linux/ioport.h>
1da177e4
LT
34#include <linux/delay.h>
35#include <linux/netdevice.h>
57c8a661 36#include <linux/memblock.h>
1da177e4 37#include <linux/init.h>
a6b7a407 38#include <linux/interrupt.h>
5e7ef913 39#include <linux/io.h>
26c6d281
JP
40
41#include "arcdevice.h"
8e0f295e 42#include "com9026.h"
1da177e4 43
1da177e4
LT
44/* Internal function declarations */
45
46static int arcrimi_probe(struct net_device *dev);
47static int arcrimi_found(struct net_device *dev);
48static void arcrimi_command(struct net_device *dev, int command);
49static int arcrimi_status(struct net_device *dev);
50static void arcrimi_setmask(struct net_device *dev, int mask);
51static int arcrimi_reset(struct net_device *dev, int really_reset);
52static void arcrimi_copy_to_card(struct net_device *dev, int bufnum, int offset,
53 void *buf, int count);
d6d7d3ed
JP
54static void arcrimi_copy_from_card(struct net_device *dev, int bufnum,
55 int offset, void *buf, int count);
1da177e4
LT
56
57/* Handy defines for ARCnet specific stuff */
58
59/* Amount of I/O memory used by the card */
cb334648
JP
60#define BUFFER_SIZE (512)
61#define MIRROR_SIZE (BUFFER_SIZE * 4)
1da177e4 62
f2f0a16b 63/* We cannot probe for a RIM I card; one reason is I don't know how to reset
1da177e4
LT
64 * them. In fact, we can't even get their node ID automatically. So, we
65 * need to be passed a specific shmem address, IRQ, and node ID.
66 */
67static int __init arcrimi_probe(struct net_device *dev)
68{
72aeea48 69 if (BUGLVL(D_NORMAL)) {
05a24b23
JP
70 pr_info("%s\n", "RIM I (entirely mem-mapped) support");
71 pr_info("E-mail me if you actually test the RIM I driver, please!\n");
72 pr_info("Given: node %02Xh, shmem %lXh, irq %d\n",
73 dev->dev_addr[0], dev->mem_start, dev->irq);
72aeea48 74 }
1da177e4
LT
75
76 if (dev->mem_start <= 0 || dev->irq <= 0) {
72aeea48 77 if (BUGLVL(D_NORMAL))
05a24b23 78 pr_err("No autoprobe for RIM I; you must specify the shmem and irq!\n");
1da177e4
LT
79 return -ENODEV;
80 }
d0f6ecad 81 if (dev->dev_addr[0] == 0) {
72aeea48 82 if (BUGLVL(D_NORMAL))
05a24b23 83 pr_err("You need to specify your card's station ID!\n");
d0f6ecad
AV
84 return -ENODEV;
85 }
f2f0a16b 86 /* Grab the memory region at mem_start for MIRROR_SIZE bytes.
1da177e4
LT
87 * Later in arcrimi_found() the real size will be determined
88 * and this reserve will be released and the correct size
89 * will be taken.
90 */
d0f6ecad 91 if (!request_mem_region(dev->mem_start, MIRROR_SIZE, "arcnet (90xx)")) {
72aeea48 92 if (BUGLVL(D_NORMAL))
05a24b23 93 pr_notice("Card memory already allocated\n");
1da177e4
LT
94 return -ENODEV;
95 }
1da177e4
LT
96 return arcrimi_found(dev);
97}
98
d0f6ecad
AV
99static int check_mirror(unsigned long addr, size_t size)
100{
101 void __iomem *p;
102 int res = -1;
103
104 if (!request_mem_region(addr, size, "arcnet (90xx)"))
105 return -1;
106
107 p = ioremap(addr, size);
108 if (p) {
4e2f9f1b 109 if (arcnet_readb(p, COM9026_REG_R_STATUS) == TESTvalue)
d0f6ecad
AV
110 res = 1;
111 else
112 res = 0;
113 iounmap(p);
114 }
115
116 release_mem_region(addr, size);
117 return res;
118}
1da177e4 119
f2f0a16b
JP
120/* Set up the struct net_device associated with this card.
121 * Called after probing succeeds.
1da177e4
LT
122 */
123static int __init arcrimi_found(struct net_device *dev)
124{
125 struct arcnet_local *lp;
126 unsigned long first_mirror, last_mirror, shmem;
d0f6ecad 127 void __iomem *p;
1da177e4
LT
128 int mirror_size;
129 int err;
130
d0f6ecad
AV
131 p = ioremap(dev->mem_start, MIRROR_SIZE);
132 if (!p) {
133 release_mem_region(dev->mem_start, MIRROR_SIZE);
a34c0932 134 arc_printk(D_NORMAL, dev, "Can't ioremap\n");
d0f6ecad
AV
135 return -ENODEV;
136 }
137
1da177e4 138 /* reserve the irq */
a0607fd3 139 if (request_irq(dev->irq, arcnet_interrupt, 0, "arcnet (RIM I)", dev)) {
d0f6ecad
AV
140 iounmap(p);
141 release_mem_region(dev->mem_start, MIRROR_SIZE);
a34c0932 142 arc_printk(D_NORMAL, dev, "Can't get IRQ %d!\n", dev->irq);
1da177e4
LT
143 return -ENODEV;
144 }
145
146 shmem = dev->mem_start;
4e2f9f1b
JP
147 arcnet_writeb(TESTvalue, p, COM9026_REG_W_INTMASK);
148 arcnet_writeb(TESTvalue, p, COM9026_REG_W_COMMAND);
149 /* actually the station/node ID */
1da177e4
LT
150
151 /* find the real shared memory start/end points, including mirrors */
152
153 /* guess the actual size of one "memory mirror" - the number of
154 * bytes between copies of the shared memory. On most cards, it's
155 * 2k (or there are no mirrors at all) but on some, it's 4k.
156 */
157 mirror_size = MIRROR_SIZE;
4e2f9f1b 158 if (arcnet_readb(p, COM9026_REG_R_STATUS) == TESTvalue &&
8e95a202
JP
159 check_mirror(shmem - MIRROR_SIZE, MIRROR_SIZE) == 0 &&
160 check_mirror(shmem - 2 * MIRROR_SIZE, MIRROR_SIZE) == 1)
d0f6ecad 161 mirror_size = 2 * MIRROR_SIZE;
1da177e4 162
d0f6ecad
AV
163 first_mirror = shmem - mirror_size;
164 while (check_mirror(first_mirror, mirror_size) == 1)
1da177e4
LT
165 first_mirror -= mirror_size;
166 first_mirror += mirror_size;
167
d0f6ecad
AV
168 last_mirror = shmem + mirror_size;
169 while (check_mirror(last_mirror, mirror_size) == 1)
1da177e4
LT
170 last_mirror += mirror_size;
171 last_mirror -= mirror_size;
172
173 dev->mem_start = first_mirror;
174 dev->mem_end = last_mirror + MIRROR_SIZE - 1;
175
176 /* initialize the rest of the device structure. */
177
454d7c9b 178 lp = netdev_priv(dev);
1da177e4
LT
179 lp->card_name = "RIM I";
180 lp->hw.command = arcrimi_command;
181 lp->hw.status = arcrimi_status;
182 lp->hw.intmask = arcrimi_setmask;
183 lp->hw.reset = arcrimi_reset;
184 lp->hw.owner = THIS_MODULE;
185 lp->hw.copy_to_card = arcrimi_copy_to_card;
186 lp->hw.copy_from_card = arcrimi_copy_from_card;
187
f2f0a16b 188 /* re-reserve the memory region - arcrimi_probe() alloced this reqion
1da177e4
LT
189 * but didn't know the real size. Free that region and then re-get
190 * with the correct size. There is a VERY slim chance this could
191 * fail.
192 */
d0f6ecad
AV
193 iounmap(p);
194 release_mem_region(shmem, MIRROR_SIZE);
1da177e4
LT
195 if (!request_mem_region(dev->mem_start,
196 dev->mem_end - dev->mem_start + 1,
197 "arcnet (90xx)")) {
a34c0932 198 arc_printk(D_NORMAL, dev, "Card memory already allocated\n");
1da177e4
LT
199 goto err_free_irq;
200 }
201
d6d7d3ed
JP
202 lp->mem_start = ioremap(dev->mem_start,
203 dev->mem_end - dev->mem_start + 1);
1da177e4 204 if (!lp->mem_start) {
a34c0932 205 arc_printk(D_NORMAL, dev, "Can't remap device memory!\n");
1da177e4
LT
206 goto err_release_mem;
207 }
208
209 /* get and check the station ID from offset 1 in shmem */
4e2f9f1b 210 dev->dev_addr[0] = arcnet_readb(lp->mem_start, COM9026_REG_R_STATION);
1da177e4 211
a34c0932
JP
212 arc_printk(D_NORMAL, dev, "ARCnet RIM I: station %02Xh found at IRQ %d, ShMem %lXh (%ld*%d bytes)\n",
213 dev->dev_addr[0],
214 dev->irq, dev->mem_start,
215 (dev->mem_end - dev->mem_start + 1) / mirror_size,
216 mirror_size);
1da177e4
LT
217
218 err = register_netdev(dev);
219 if (err)
220 goto err_unmap;
221
222 return 0;
223
224err_unmap:
225 iounmap(lp->mem_start);
226err_release_mem:
227 release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
228err_free_irq:
229 free_irq(dev->irq, dev);
230 return -EIO;
231}
232
f2f0a16b 233/* Do a hardware reset on the card, and set up necessary registers.
1da177e4
LT
234 *
235 * This should be called as little as possible, because it disrupts the
236 * token on the network (causes a RECON) and requires a significant delay.
237 *
238 * However, it does make sure the card is in a defined state.
239 */
240static int arcrimi_reset(struct net_device *dev, int really_reset)
241{
454d7c9b 242 struct arcnet_local *lp = netdev_priv(dev);
1da177e4
LT
243 void __iomem *ioaddr = lp->mem_start + 0x800;
244
a34c0932 245 arc_printk(D_INIT, dev, "Resetting %s (status=%02Xh)\n",
4e2f9f1b 246 dev->name, arcnet_readb(ioaddr, COM9026_REG_R_STATUS));
1da177e4
LT
247
248 if (really_reset) {
4e2f9f1b 249 arcnet_writeb(TESTvalue, ioaddr, -0x800); /* fake reset */
1da177e4
LT
250 return 0;
251 }
4e2f9f1b
JP
252 /* clear flags & end reset */
253 arcnet_writeb(CFLAGScmd | RESETclear, ioaddr, COM9026_REG_W_COMMAND);
254 arcnet_writeb(CFLAGScmd | CONFIGclear, ioaddr, COM9026_REG_W_COMMAND);
1da177e4
LT
255
256 /* enable extended (512-byte) packets */
4e2f9f1b 257 arcnet_writeb(CONFIGcmd | EXTconf, ioaddr, COM9026_REG_W_COMMAND);
1da177e4
LT
258
259 /* done! return success. */
260 return 0;
261}
262
263static void arcrimi_setmask(struct net_device *dev, int mask)
264{
454d7c9b 265 struct arcnet_local *lp = netdev_priv(dev);
1da177e4
LT
266 void __iomem *ioaddr = lp->mem_start + 0x800;
267
4e2f9f1b 268 arcnet_writeb(mask, ioaddr, COM9026_REG_W_INTMASK);
1da177e4
LT
269}
270
271static int arcrimi_status(struct net_device *dev)
272{
454d7c9b 273 struct arcnet_local *lp = netdev_priv(dev);
1da177e4
LT
274 void __iomem *ioaddr = lp->mem_start + 0x800;
275
4e2f9f1b 276 return arcnet_readb(ioaddr, COM9026_REG_R_STATUS);
1da177e4
LT
277}
278
279static void arcrimi_command(struct net_device *dev, int cmd)
280{
454d7c9b 281 struct arcnet_local *lp = netdev_priv(dev);
1da177e4
LT
282 void __iomem *ioaddr = lp->mem_start + 0x800;
283
4e2f9f1b 284 arcnet_writeb(cmd, ioaddr, COM9026_REG_W_COMMAND);
1da177e4
LT
285}
286
287static void arcrimi_copy_to_card(struct net_device *dev, int bufnum, int offset,
288 void *buf, int count)
289{
454d7c9b 290 struct arcnet_local *lp = netdev_priv(dev);
1da177e4 291 void __iomem *memaddr = lp->mem_start + 0x800 + bufnum * 512 + offset;
01a1d5ac 292
a34c0932 293 TIME(dev, "memcpy_toio", count, memcpy_toio(memaddr, buf, count));
1da177e4
LT
294}
295
d6d7d3ed
JP
296static void arcrimi_copy_from_card(struct net_device *dev, int bufnum,
297 int offset, void *buf, int count)
1da177e4 298{
454d7c9b 299 struct arcnet_local *lp = netdev_priv(dev);
1da177e4 300 void __iomem *memaddr = lp->mem_start + 0x800 + bufnum * 512 + offset;
01a1d5ac 301
a34c0932 302 TIME(dev, "memcpy_fromio", count, memcpy_fromio(buf, memaddr, count));
1da177e4
LT
303}
304
305static int node;
306static int io; /* use the insmod io= irq= node= options */
307static int irq;
308static char device[9]; /* use eg. device=arc1 to change name */
309
310module_param(node, int, 0);
311module_param(io, int, 0);
312module_param(irq, int, 0);
313module_param_string(device, device, sizeof(device), 0);
314MODULE_LICENSE("GPL");
315
316static struct net_device *my_dev;
317
318static int __init arc_rimi_init(void)
319{
320 struct net_device *dev;
321
322 dev = alloc_arcdev(device);
323 if (!dev)
324 return -ENOMEM;
325
326 if (node && node != 0xff)
327 dev->dev_addr[0] = node;
328
329 dev->mem_start = io;
330 dev->irq = irq;
331 if (dev->irq == 2)
332 dev->irq = 9;
333
334 if (arcrimi_probe(dev)) {
335 free_netdev(dev);
336 return -EIO;
337 }
338
339 my_dev = dev;
340 return 0;
341}
342
343static void __exit arc_rimi_exit(void)
344{
345 struct net_device *dev = my_dev;
454d7c9b 346 struct arcnet_local *lp = netdev_priv(dev);
1da177e4
LT
347
348 unregister_netdev(dev);
349 iounmap(lp->mem_start);
350 release_mem_region(dev->mem_start, dev->mem_end - dev->mem_start + 1);
351 free_irq(dev->irq, dev);
352 free_netdev(dev);
353}
354
355#ifndef MODULE
356static int __init arcrimi_setup(char *s)
357{
358 int ints[8];
01a1d5ac 359
1da177e4
LT
360 s = get_options(s, 8, ints);
361 if (!ints[0])
362 return 1;
363 switch (ints[0]) {
364 default: /* ERROR */
05a24b23 365 pr_err("Too many arguments\n");
df561f66 366 fallthrough;
1da177e4
LT
367 case 3: /* Node ID */
368 node = ints[3];
df561f66 369 fallthrough;
1da177e4
LT
370 case 2: /* IRQ */
371 irq = ints[2];
df561f66 372 fallthrough;
1da177e4
LT
373 case 1: /* IO address */
374 io = ints[1];
375 }
376 if (*s)
377 snprintf(device, sizeof(device), "%s", s);
378 return 1;
379}
380__setup("arcrimi=", arcrimi_setup);
381#endif /* MODULE */
382
383module_init(arc_rimi_init)
384module_exit(arc_rimi_exit)