1/*
2 * Linux ARCnet driver - COM90xx chipset (IO-mapped buffers)
3 *
4 * Written 1997 by David Woodhouse.
5 * Written 1994-1999 by Avery Pennarun.
6 * Written 1999-2000 by Martin Mares <mj@ucw.cz>.
7 * Derived from skeleton.c by Donald Becker.
8 *
9 * Special thanks to Contemporary Controls, Inc. (www.ccontrols.com)
10 *  for sponsoring the further development of this driver.
11 *
12 * **********************
13 *
14 * The original copyright of skeleton.c was as follows:
15 *
16 * skeleton.c Written 1993 by Donald Becker.
17 * Copyright 1993 United States Government as represented by the
18 * Director, National Security Agency.  This software may only be used
19 * and distributed according to the terms of the GNU General Public License as
20 * modified by SRC, incorporated herein by reference.
21 *
22 * **********************
23 *
24 * For more details, see drivers/net/arcnet.c
25 *
26 * **********************
27 */
28#include <linux/kernel.h>
29#include <linux/module.h>
30#include <linux/moduleparam.h>
31#include <linux/ioport.h>
32#include <linux/slab.h>
33#include <linux/delay.h>
34#include <linux/netdevice.h>
35#include <linux/bootmem.h>
36#include <linux/init.h>
37#include <asm/io.h>
38#include <linux/arcdevice.h>
39
40
41#define VERSION "arcnet: COM90xx IO-mapped mode support (by David Woodhouse et el.)\n"
42
43
44/* Internal function declarations */
45
46static int com90io_found(struct net_device *dev);
47static void com90io_command(struct net_device *dev, int command);
48static int com90io_status(struct net_device *dev);
49static void com90io_setmask(struct net_device *dev, int mask);
50static int com90io_reset(struct net_device *dev, int really_reset);
51static void com90io_copy_to_card(struct net_device *dev, int bufnum, int offset,
52				 void *buf, int count);
53static void com90io_copy_from_card(struct net_device *dev, int bufnum, int offset,
54				   void *buf, int count);
55
56
57/* Handy defines for ARCnet specific stuff */
58
59/* The number of low I/O ports used by the card. */
60#define ARCNET_TOTAL_SIZE 16
61
62/* COM 9026 controller chip --> ARCnet register addresses */
63#define _INTMASK (ioaddr+0)	/* writable */
64#define _STATUS  (ioaddr+0)	/* readable */
65#define _COMMAND (ioaddr+1)	/* writable, returns random vals on read (?) */
66#define _RESET  (ioaddr+8)	/* software reset (on read) */
67#define _MEMDATA  (ioaddr+12)	/* Data port for IO-mapped memory */
68#define _ADDR_HI  (ioaddr+15)	/* Control registers for said */
69#define _ADDR_LO  (ioaddr+14)
70#define _CONFIG  (ioaddr+2)	/* Configuration register */
71
72#undef ASTATUS
73#undef ACOMMAND
74#undef AINTMASK
75
76#define ASTATUS()	inb(_STATUS)
77#define ACOMMAND(cmd) outb((cmd),_COMMAND)
78#define AINTMASK(msk)	outb((msk),_INTMASK)
79#define SETCONF() 	outb((lp->config),_CONFIG)
80
81
82/****************************************************************************
83 *                                                                          *
84 * IO-mapped operation routines                                             *
85 *                                                                          *
86 ****************************************************************************/
87
88#undef ONE_AT_A_TIME_TX
89#undef ONE_AT_A_TIME_RX
90
91static u_char get_buffer_byte(struct net_device *dev, unsigned offset)
92{
93	int ioaddr = dev->base_addr;
94
95	outb(offset >> 8, _ADDR_HI);
96	outb(offset & 0xff, _ADDR_LO);
97
98	return inb(_MEMDATA);
99}
100
101#ifdef ONE_AT_A_TIME_TX
102static void put_buffer_byte(struct net_device *dev, unsigned offset, u_char datum)
103{
104	int ioaddr = dev->base_addr;
105
106	outb(offset >> 8, _ADDR_HI);
107	outb(offset & 0xff, _ADDR_LO);
108
109	outb(datum, _MEMDATA);
110}
111
112#endif
113
114
115static void get_whole_buffer(struct net_device *dev, unsigned offset, unsigned length, char *dest)
116{
117	int ioaddr = dev->base_addr;
118
119	outb((offset >> 8) | AUTOINCflag, _ADDR_HI);
120	outb(offset & 0xff, _ADDR_LO);
121
122	while (length--)
123#ifdef ONE_AT_A_TIME_RX
124		*(dest++) = get_buffer_byte(dev, offset++);
125#else
126		*(dest++) = inb(_MEMDATA);
127#endif
128}
129
130static void put_whole_buffer(struct net_device *dev, unsigned offset, unsigned length, char *dest)
131{
132	int ioaddr = dev->base_addr;
133
134	outb((offset >> 8) | AUTOINCflag, _ADDR_HI);
135	outb(offset & 0xff, _ADDR_LO);
136
137	while (length--)
138#ifdef ONE_AT_A_TIME_TX
139		put_buffer_byte(dev, offset++, *(dest++));
140#else
141		outb(*(dest++), _MEMDATA);
142#endif
143}
144
145/*
146 * We cannot probe for an IO mapped card either, although we can check that
147 * it's where we were told it was, and even autoirq
148 */
149static int __init com90io_probe(struct net_device *dev)
150{
151	int ioaddr = dev->base_addr, status;
152	unsigned long airqmask;
153
154	BUGLVL(D_NORMAL) printk(VERSION);
155	BUGLVL(D_NORMAL) printk("E-mail me if you actually test this driver, please!\n");
156
157	if (!ioaddr) {
158		BUGMSG(D_NORMAL, "No autoprobe for IO mapped cards; you "
159		       "must specify the base address!\n");
160		return -ENODEV;
161	}
162	if (!request_region(ioaddr, ARCNET_TOTAL_SIZE, "com90io probe")) {
163		BUGMSG(D_INIT_REASONS, "IO request_region %x-%x failed.\n",
164		       ioaddr, ioaddr + ARCNET_TOTAL_SIZE - 1);
165		return -ENXIO;
166	}
167	if (ASTATUS() == 0xFF) {
168		BUGMSG(D_INIT_REASONS, "IO address %x empty\n", ioaddr);
169		goto err_out;
170	}
171	inb(_RESET);
172	mdelay(RESETtime);
173
174	status = ASTATUS();
175
176	if ((status & 0x9D) != (NORXflag | RECONflag | TXFREEflag | RESETflag)) {
177		BUGMSG(D_INIT_REASONS, "Status invalid (%Xh).\n", status);
178		goto err_out;
179	}
180	BUGMSG(D_INIT_REASONS, "Status after reset: %X\n", status);
181
182	ACOMMAND(CFLAGScmd | RESETclear | CONFIGclear);
183
184	BUGMSG(D_INIT_REASONS, "Status after reset acknowledged: %X\n", status);
185
186	status = ASTATUS();
187
188	if (status & RESETflag) {
189		BUGMSG(D_INIT_REASONS, "Eternal reset (status=%Xh)\n", status);
190		goto err_out;
191	}
192	outb((0x16 | IOMAPflag) & ~ENABLE16flag, _CONFIG);
193
194	/* Read first loc'n of memory */
195
196	outb(AUTOINCflag, _ADDR_HI);
197	outb(0, _ADDR_LO);
198
199	if ((status = inb(_MEMDATA)) != 0xd1) {
200		BUGMSG(D_INIT_REASONS, "Signature byte not found"
201		       " (%Xh instead).\n", status);
202		goto err_out;
203	}
204	if (!dev->irq) {
205		/*
206		 * if we do this, we're sure to get an IRQ since the
207		 * card has just reset and the NORXflag is on until
208		 * we tell it to start receiving.
209		 */
210
211		airqmask = probe_irq_on();
212		outb(NORXflag, _INTMASK);
213		udelay(1);
214		outb(0, _INTMASK);
215		dev->irq = probe_irq_off(airqmask);
216
217		if (dev->irq <= 0) {
218			BUGMSG(D_INIT_REASONS, "Autoprobe IRQ failed\n");
219			goto err_out;
220		}
221	}
222	release_region(ioaddr, ARCNET_TOTAL_SIZE); /* end of probing */
223	return com90io_found(dev);
224
225err_out:
226	release_region(ioaddr, ARCNET_TOTAL_SIZE);
227	return -ENODEV;
228}
229
230
231/* Set up the struct net_device associated with this card.  Called after
232 * probing succeeds.
233 */
234static int __init com90io_found(struct net_device *dev)
235{
236	struct arcnet_local *lp;
237	int ioaddr = dev->base_addr;
238	int err;
239
240	/* Reserve the irq */
241	if (request_irq(dev->irq, &arcnet_interrupt, 0, "arcnet (COM90xx-IO)", dev)) {
242		BUGMSG(D_NORMAL, "Can't get IRQ %d!\n", dev->irq);
243		return -ENODEV;
244	}
245	/* Reserve the I/O region */
246	if (!request_region(dev->base_addr, ARCNET_TOTAL_SIZE, "arcnet (COM90xx-IO)")) {
247		free_irq(dev->irq, dev);
248		return -EBUSY;
249	}
250
251	lp = dev->priv;
252	lp->card_name = "COM90xx I/O";
253	lp->hw.command = com90io_command;
254	lp->hw.status = com90io_status;
255	lp->hw.intmask = com90io_setmask;
256	lp->hw.reset = com90io_reset;
257	lp->hw.owner = THIS_MODULE;
258	lp->hw.copy_to_card = com90io_copy_to_card;
259	lp->hw.copy_from_card = com90io_copy_from_card;
260
261	lp->config = (0x16 | IOMAPflag) & ~ENABLE16flag;
262	SETCONF();
263
264	/* get and check the station ID from offset 1 in shmem */
265
266	dev->dev_addr[0] = get_buffer_byte(dev, 1);
267
268	err = register_netdev(dev);
269	if (err) {
270		outb((inb(_CONFIG) & ~IOMAPflag), _CONFIG);
271		free_irq(dev->irq, dev);
272		release_region(dev->base_addr, ARCNET_TOTAL_SIZE);
273		return err;
274	}
275
276	BUGMSG(D_NORMAL, "COM90IO: station %02Xh found at %03lXh, IRQ %d.\n",
277	       dev->dev_addr[0], dev->base_addr, dev->irq);
278
279	return 0;
280}
281
282
283/*
284 * Do a hardware reset on the card, and set up necessary registers.
285 *
286 * This should be called as little as possible, because it disrupts the
287 * token on the network (causes a RECON) and requires a significant delay.
288 *
289 * However, it does make sure the card is in a defined state.
290 */
291static int com90io_reset(struct net_device *dev, int really_reset)
292{
293	struct arcnet_local *lp = dev->priv;
294	short ioaddr = dev->base_addr;
295
296	BUGMSG(D_INIT, "Resetting %s (status=%02Xh)\n", dev->name, ASTATUS());
297
298	if (really_reset) {
299		/* reset the card */
300		inb(_RESET);
301		mdelay(RESETtime);
302	}
303	/* Set the thing to IO-mapped, 8-bit  mode */
304	lp->config = (0x1C | IOMAPflag) & ~ENABLE16flag;
305	SETCONF();
306
307	ACOMMAND(CFLAGScmd | RESETclear);	/* clear flags & end reset */
308	ACOMMAND(CFLAGScmd | CONFIGclear);
309
310	/* verify that the ARCnet signature byte is present */
311	if (get_buffer_byte(dev, 0) != TESTvalue) {
312		BUGMSG(D_NORMAL, "reset failed: TESTvalue not present.\n");
313		return 1;
314	}
315	/* enable extended (512-byte) packets */
316	ACOMMAND(CONFIGcmd | EXTconf);
317
318	/* done!  return success. */
319	return 0;
320}
321
322
323static void com90io_command(struct net_device *dev, int cmd)
324{
325	short ioaddr = dev->base_addr;
326
327	ACOMMAND(cmd);
328}
329
330
331static int com90io_status(struct net_device *dev)
332{
333	short ioaddr = dev->base_addr;
334
335	return ASTATUS();
336}
337
338
339static void com90io_setmask(struct net_device *dev, int mask)
340{
341	short ioaddr = dev->base_addr;
342
343	AINTMASK(mask);
344}
345
346static void com90io_copy_to_card(struct net_device *dev, int bufnum, int offset,
347				 void *buf, int count)
348{
349	TIME("put_whole_buffer", count, put_whole_buffer(dev, bufnum * 512 + offset, count, buf));
350}
351
352
353static void com90io_copy_from_card(struct net_device *dev, int bufnum, int offset,
354				   void *buf, int count)
355{
356	TIME("get_whole_buffer", count, get_whole_buffer(dev, bufnum * 512 + offset, count, buf));
357}
358
359static int io;			/* use the insmod io= irq= shmem= options */
360static int irq;
361static char device[9];		/* use eg. device=arc1 to change name */
362
363module_param(io, int, 0);
364module_param(irq, int, 0);
365module_param_string(device, device, sizeof(device), 0);
366MODULE_LICENSE("GPL");
367
368#ifndef MODULE
369static int __init com90io_setup(char *s)
370{
371	int ints[4];
372	s = get_options(s, 4, ints);
373	if (!ints[0])
374		return 0;
375	switch (ints[0]) {
376	default:		/* ERROR */
377		printk("com90io: Too many arguments.\n");
378	case 2:		/* IRQ */
379		irq = ints[2];
380	case 1:		/* IO address */
381		io = ints[1];
382	}
383	if (*s)
384		snprintf(device, sizeof(device), "%s", s);
385	return 1;
386}
387__setup("com90io=", com90io_setup);
388#endif
389
390static struct net_device *my_dev;
391
392static int __init com90io_init(void)
393{
394	struct net_device *dev;
395	int err;
396
397	dev = alloc_arcdev(device);
398	if (!dev)
399		return -ENOMEM;
400
401	SET_MODULE_OWNER(dev);
402
403	dev->base_addr = io;
404	dev->irq = irq;
405	if (dev->irq == 2)
406		dev->irq = 9;
407
408	err = com90io_probe(dev);
409
410	if (err) {
411		free_netdev(dev);
412		return err;
413	}
414
415	my_dev = dev;
416	return 0;
417}
418
419static void __exit com90io_exit(void)
420{
421	struct net_device *dev = my_dev;
422	int ioaddr = dev->base_addr;
423
424	unregister_netdev(dev);
425
426	/* Set the thing back to MMAP mode, in case the old driver is loaded later */
427	outb((inb(_CONFIG) & ~IOMAPflag), _CONFIG);
428
429	free_irq(dev->irq, dev);
430	release_region(dev->base_addr, ARCNET_TOTAL_SIZE);
431	free_netdev(dev);
432}
433
434module_init(com90io_init)
435module_exit(com90io_exit)
436