1/*
2 * Linux ARCnet driver - COM20020 chipset support
3 *
4 * Written 1997 by David Woodhouse.
5 * Written 1994-1999 by Avery Pennarun.
6 * Written 1999 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
29#define pr_fmt(fmt) "arcnet:" KBUILD_MODNAME ": " fmt
30
31#include <linux/module.h>
32#include <linux/kernel.h>
33#include <linux/types.h>
34#include <linux/ioport.h>
35#include <linux/errno.h>
36#include <linux/delay.h>
37#include <linux/netdevice.h>
38#include <linux/init.h>
39#include <linux/interrupt.h>
40#include <linux/io.h>
41
42#include "arcdevice.h"
43#include "com20020.h"
44
45static const char * const clockrates[] = {
46	"XXXXXXX", "XXXXXXXX", "XXXXXX", "2.5 Mb/s",
47	"1.25Mb/s", "625 Kb/s", "312.5 Kb/s", "156.25 Kb/s",
48	"Reserved", "Reserved", "Reserved"
49};
50
51static void com20020_command(struct net_device *dev, int command);
52static int com20020_status(struct net_device *dev);
53static void com20020_setmask(struct net_device *dev, int mask);
54static int com20020_reset(struct net_device *dev, int really_reset);
55static void com20020_copy_to_card(struct net_device *dev, int bufnum,
56				  int offset, void *buf, int count);
57static void com20020_copy_from_card(struct net_device *dev, int bufnum,
58				    int offset, void *buf, int count);
59static void com20020_set_mc_list(struct net_device *dev);
60static void com20020_close(struct net_device *);
61
62static void com20020_copy_from_card(struct net_device *dev, int bufnum,
63				    int offset, void *buf, int count)
64{
65	int ioaddr = dev->base_addr, ofs = 512 * bufnum + offset;
66
67	/* set up the address register */
68	arcnet_outb((ofs >> 8) | RDDATAflag | AUTOINCflag,
69		    ioaddr, COM20020_REG_W_ADDR_HI);
70	arcnet_outb(ofs & 0xff, ioaddr, COM20020_REG_W_ADDR_LO);
71
72	/* copy the data */
73	TIME(dev, "insb", count,
74	     arcnet_insb(ioaddr, COM20020_REG_RW_MEMDATA, buf, count));
75}
76
77static void com20020_copy_to_card(struct net_device *dev, int bufnum,
78				  int offset, void *buf, int count)
79{
80	int ioaddr = dev->base_addr, ofs = 512 * bufnum + offset;
81
82	/* set up the address register */
83	arcnet_outb((ofs >> 8) | AUTOINCflag, ioaddr, COM20020_REG_W_ADDR_HI);
84	arcnet_outb(ofs & 0xff, ioaddr, COM20020_REG_W_ADDR_LO);
85
86	/* copy the data */
87	TIME(dev, "outsb", count,
88	     arcnet_outsb(ioaddr, COM20020_REG_RW_MEMDATA, buf, count));
89}
90
91/* Reset the card and check some basic stuff during the detection stage. */
92int com20020_check(struct net_device *dev)
93{
94	int ioaddr = dev->base_addr, status;
95	struct arcnet_local *lp = netdev_priv(dev);
96
97	arcnet_outb(XTOcfg(3) | RESETcfg, ioaddr, COM20020_REG_W_CONFIG);
98	udelay(5);
99	arcnet_outb(XTOcfg(3), ioaddr, COM20020_REG_W_CONFIG);
100	mdelay(RESETtime);
101
102	lp->setup = lp->clockm ? 0 : (lp->clockp << 1);
103	lp->setup2 = (lp->clockm << 4) | 8;
104
105	/* CHECK: should we do this for SOHARD cards ? */
106	/* Enable P1Mode for backplane mode */
107	lp->setup = lp->setup | P1MODE;
108
109	com20020_set_subaddress(lp, ioaddr, SUB_SETUP1);
110	arcnet_outb(lp->setup, ioaddr, COM20020_REG_W_XREG);
111
112	if (lp->clockm != 0) {
113		com20020_set_subaddress(lp, ioaddr, SUB_SETUP2);
114		arcnet_outb(lp->setup2, ioaddr, COM20020_REG_W_XREG);
115
116		/* must now write the magic "restart operation" command */
117		mdelay(1);
118		arcnet_outb(STARTIOcmd, ioaddr, COM20020_REG_W_COMMAND);
119	}
120
121	lp->config = (lp->timeout << 3) | (lp->backplane << 2) | SUB_NODE;
122	/* set node ID to 0x42 (but transmitter is disabled, so it's okay) */
123	arcnet_outb(lp->config, ioaddr, COM20020_REG_W_CONFIG);
124	arcnet_outb(0x42, ioaddr, COM20020_REG_W_XREG);
125
126	status = arcnet_inb(ioaddr, COM20020_REG_R_STATUS);
127
128	if ((status & 0x99) != (NORXflag | TXFREEflag | RESETflag)) {
129		arc_printk(D_NORMAL, dev, "status invalid (%Xh).\n", status);
130		return -ENODEV;
131	}
132	arc_printk(D_INIT_REASONS, dev, "status after reset: %X\n", status);
133
134	arcnet_outb(CFLAGScmd | RESETclear | CONFIGclear,
135		    ioaddr, COM20020_REG_W_COMMAND);
136	status = arcnet_inb(ioaddr, COM20020_REG_R_STATUS);
137	arc_printk(D_INIT_REASONS, dev, "status after reset acknowledged: %X\n",
138		   status);
139
140	/* Read first location of memory */
141	arcnet_outb(0 | RDDATAflag | AUTOINCflag,
142		    ioaddr, COM20020_REG_W_ADDR_HI);
143	arcnet_outb(0, ioaddr, COM20020_REG_W_ADDR_LO);
144
145	status = arcnet_inb(ioaddr, COM20020_REG_RW_MEMDATA);
146	if (status != TESTvalue) {
147		arc_printk(D_NORMAL, dev, "Signature byte not found (%02Xh != D1h).\n",
148			   status);
149		return -ENODEV;
150	}
151	return 0;
152}
153
154static int com20020_set_hwaddr(struct net_device *dev, void *addr)
155{
156	int ioaddr = dev->base_addr;
157	struct arcnet_local *lp = netdev_priv(dev);
158	struct sockaddr *hwaddr = addr;
159
160	memcpy(dev->dev_addr, hwaddr->sa_data, 1);
161	com20020_set_subaddress(lp, ioaddr, SUB_NODE);
162	arcnet_outb(dev->dev_addr[0], ioaddr, COM20020_REG_W_XREG);
163
164	return 0;
165}
166
167static int com20020_netdev_open(struct net_device *dev)
168{
169	int ioaddr = dev->base_addr;
170	struct arcnet_local *lp = netdev_priv(dev);
171
172	lp->config |= TXENcfg;
173	arcnet_outb(lp->config, ioaddr, COM20020_REG_W_CONFIG);
174
175	return arcnet_open(dev);
176}
177
178static int com20020_netdev_close(struct net_device *dev)
179{
180	int ioaddr = dev->base_addr;
181	struct arcnet_local *lp = netdev_priv(dev);
182
183	arcnet_close(dev);
184
185	/* disable transmitter */
186	lp->config &= ~TXENcfg;
187	arcnet_outb(lp->config, ioaddr, COM20020_REG_W_CONFIG);
188	return 0;
189}
190
191const struct net_device_ops com20020_netdev_ops = {
192	.ndo_open	= com20020_netdev_open,
193	.ndo_stop	= com20020_netdev_close,
194	.ndo_start_xmit = arcnet_send_packet,
195	.ndo_tx_timeout = arcnet_timeout,
196	.ndo_set_mac_address = com20020_set_hwaddr,
197	.ndo_set_rx_mode = com20020_set_mc_list,
198};
199
200/* Set up the struct net_device associated with this card.  Called after
201 * probing succeeds.
202 */
203int com20020_found(struct net_device *dev, int shared)
204{
205	struct arcnet_local *lp;
206	int ioaddr = dev->base_addr;
207
208	/* Initialize the rest of the device structure. */
209
210	lp = netdev_priv(dev);
211
212	lp->hw.owner = THIS_MODULE;
213	lp->hw.command = com20020_command;
214	lp->hw.status = com20020_status;
215	lp->hw.intmask = com20020_setmask;
216	lp->hw.reset = com20020_reset;
217	lp->hw.copy_to_card = com20020_copy_to_card;
218	lp->hw.copy_from_card = com20020_copy_from_card;
219	lp->hw.close = com20020_close;
220
221	/* FIXME: do this some other way! */
222	if (!dev->dev_addr[0])
223		dev->dev_addr[0] = arcnet_inb(ioaddr, 8);
224
225	com20020_set_subaddress(lp, ioaddr, SUB_SETUP1);
226	arcnet_outb(lp->setup, ioaddr, COM20020_REG_W_XREG);
227
228	if (lp->card_flags & ARC_CAN_10MBIT) {
229		com20020_set_subaddress(lp, ioaddr, SUB_SETUP2);
230		arcnet_outb(lp->setup2, ioaddr, COM20020_REG_W_XREG);
231
232		/* must now write the magic "restart operation" command */
233		mdelay(1);
234		arcnet_outb(STARTIOcmd, ioaddr, COM20020_REG_W_COMMAND);
235	}
236
237	lp->config = (lp->timeout << 3) | (lp->backplane << 2) | SUB_NODE;
238	/* Default 0x38 + register: Node ID */
239	arcnet_outb(lp->config, ioaddr, COM20020_REG_W_CONFIG);
240	arcnet_outb(dev->dev_addr[0], ioaddr, COM20020_REG_W_XREG);
241
242	/* reserve the irq */
243	if (request_irq(dev->irq, arcnet_interrupt, shared,
244			"arcnet (COM20020)", dev)) {
245		arc_printk(D_NORMAL, dev, "Can't get IRQ %d!\n", dev->irq);
246		return -ENODEV;
247	}
248
249	dev->base_addr = ioaddr;
250
251	arc_printk(D_NORMAL, dev, "%s: station %02Xh found at %03lXh, IRQ %d.\n",
252		   lp->card_name, dev->dev_addr[0], dev->base_addr, dev->irq);
253
254	if (lp->backplane)
255		arc_printk(D_NORMAL, dev, "Using backplane mode.\n");
256
257	if (lp->timeout != 3)
258		arc_printk(D_NORMAL, dev, "Using extended timeout value of %d\n",
259			   lp->timeout);
260
261	arc_printk(D_NORMAL, dev, "Using CKP %d - data rate %s\n",
262		   lp->setup >> 1,
263		   clockrates[3 -
264			      ((lp->setup2 & 0xF0) >> 4) +
265			      ((lp->setup & 0x0F) >> 1)]);
266			/* The clockrates array index looks very fragile.
267			 * It seems like it could have negative indexing.
268			 */
269
270	if (register_netdev(dev)) {
271		free_irq(dev->irq, dev);
272		return -EIO;
273	}
274	return 0;
275}
276
277/* Do a hardware reset on the card, and set up necessary registers.
278 *
279 * This should be called as little as possible, because it disrupts the
280 * token on the network (causes a RECON) and requires a significant delay.
281 *
282 * However, it does make sure the card is in a defined state.
283 */
284static int com20020_reset(struct net_device *dev, int really_reset)
285{
286	struct arcnet_local *lp = netdev_priv(dev);
287	u_int ioaddr = dev->base_addr;
288	u_char inbyte;
289
290	arc_printk(D_DEBUG, dev, "%s: %d: %s: dev: %p, lp: %p, dev->name: %s\n",
291		   __FILE__, __LINE__, __func__, dev, lp, dev->name);
292	arc_printk(D_INIT, dev, "Resetting %s (status=%02Xh)\n",
293		   dev->name, arcnet_inb(ioaddr, COM20020_REG_R_STATUS));
294
295	arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
296	lp->config |= (lp->timeout << 3) | (lp->backplane << 2);
297	/* power-up defaults */
298	arcnet_outb(lp->config, ioaddr, COM20020_REG_W_CONFIG);
299	arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
300
301	if (really_reset) {
302		/* reset the card */
303		arcnet_outb(lp->config | RESETcfg, ioaddr, COM20020_REG_W_CONFIG);
304		udelay(5);
305		arcnet_outb(lp->config, ioaddr, COM20020_REG_W_CONFIG);
306		mdelay(RESETtime * 2);
307				/* COM20020 seems to be slower sometimes */
308	}
309	/* clear flags & end reset */
310	arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
311	arcnet_outb(CFLAGScmd | RESETclear | CONFIGclear,
312		    ioaddr, COM20020_REG_W_COMMAND);
313
314	/* verify that the ARCnet signature byte is present */
315	arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
316
317	com20020_copy_from_card(dev, 0, 0, &inbyte, 1);
318	arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
319	if (inbyte != TESTvalue) {
320		arc_printk(D_DEBUG, dev, "%s: %d: %s\n",
321			   __FILE__, __LINE__, __func__);
322		arc_printk(D_NORMAL, dev, "reset failed: TESTvalue not present.\n");
323		return 1;
324	}
325	/* enable extended (512-byte) packets */
326	arcnet_outb(CONFIGcmd | EXTconf, ioaddr, COM20020_REG_W_COMMAND);
327
328	arc_printk(D_DEBUG, dev, "%s: %d: %s\n", __FILE__, __LINE__, __func__);
329
330	/* done!  return success. */
331	return 0;
332}
333
334static void com20020_setmask(struct net_device *dev, int mask)
335{
336	u_int ioaddr = dev->base_addr;
337
338	arc_printk(D_DURING, dev, "Setting mask to %x at %x\n", mask, ioaddr);
339	arcnet_outb(mask, ioaddr, COM20020_REG_W_INTMASK);
340}
341
342static void com20020_command(struct net_device *dev, int cmd)
343{
344	u_int ioaddr = dev->base_addr;
345
346	arcnet_outb(cmd, ioaddr, COM20020_REG_W_COMMAND);
347}
348
349static int com20020_status(struct net_device *dev)
350{
351	u_int ioaddr = dev->base_addr;
352
353	return arcnet_inb(ioaddr, COM20020_REG_R_STATUS) +
354		(arcnet_inb(ioaddr, COM20020_REG_R_DIAGSTAT) << 8);
355}
356
357static void com20020_close(struct net_device *dev)
358{
359	struct arcnet_local *lp = netdev_priv(dev);
360	int ioaddr = dev->base_addr;
361
362	/* disable transmitter */
363	lp->config &= ~TXENcfg;
364	arcnet_outb(lp->config, ioaddr, COM20020_REG_W_CONFIG);
365}
366
367/* Set or clear the multicast filter for this adaptor.
368 * num_addrs == -1    Promiscuous mode, receive all packets
369 * num_addrs == 0       Normal mode, clear multicast list
370 * num_addrs > 0        Multicast mode, receive normal and MC packets, and do
371 *                      best-effort filtering.
372 *      FIXME - do multicast stuff, not just promiscuous.
373 */
374static void com20020_set_mc_list(struct net_device *dev)
375{
376	struct arcnet_local *lp = netdev_priv(dev);
377	int ioaddr = dev->base_addr;
378
379	if ((dev->flags & IFF_PROMISC) && (dev->flags & IFF_UP)) {
380		/* Enable promiscuous mode */
381		if (!(lp->setup & PROMISCset))
382			arc_printk(D_NORMAL, dev, "Setting promiscuous flag...\n");
383		com20020_set_subaddress(lp, ioaddr, SUB_SETUP1);
384		lp->setup |= PROMISCset;
385		arcnet_outb(lp->setup, ioaddr, COM20020_REG_W_XREG);
386	} else {
387		/* Disable promiscuous mode, use normal mode */
388		if ((lp->setup & PROMISCset))
389			arc_printk(D_NORMAL, dev, "Resetting promiscuous flag...\n");
390		com20020_set_subaddress(lp, ioaddr, SUB_SETUP1);
391		lp->setup &= ~PROMISCset;
392		arcnet_outb(lp->setup, ioaddr, COM20020_REG_W_XREG);
393	}
394}
395
396#if defined(CONFIG_ARCNET_COM20020_PCI_MODULE) || \
397    defined(CONFIG_ARCNET_COM20020_ISA_MODULE) || \
398    defined(CONFIG_ARCNET_COM20020_CS_MODULE)
399EXPORT_SYMBOL(com20020_check);
400EXPORT_SYMBOL(com20020_found);
401EXPORT_SYMBOL(com20020_netdev_ops);
402#endif
403
404MODULE_LICENSE("GPL");
405
406#ifdef MODULE
407
408static int __init com20020_module_init(void)
409{
410	if (BUGLVL(D_NORMAL))
411		pr_info("%s\n", "COM20020 chipset support (by David Woodhouse et al.)");
412	return 0;
413}
414
415static void __exit com20020_module_exit(void)
416{
417}
418module_init(com20020_module_init);
419module_exit(com20020_module_exit);
420#endif				/* MODULE */
421