xref: /openbmc/linux/drivers/net/appletalk/cops.c (revision 64c70b1c)
1 /*      cops.c: LocalTalk driver for Linux.
2  *
3  *	Authors:
4  *      - Jay Schulist <jschlst@samba.org>
5  *
6  *	With more than a little help from;
7  *	- Alan Cox <Alan.Cox@linux.org>
8  *
9  *      Derived from:
10  *      - skeleton.c: A network driver outline for linux.
11  *        Written 1993-94 by Donald Becker.
12  *	- ltpc.c: A driver for the LocalTalk PC card.
13  *	  Written by Bradford W. Johnson.
14  *
15  *      Copyright 1993 United States Government as represented by the
16  *      Director, National Security Agency.
17  *
18  *      This software may be used and distributed according to the terms
19  *      of the GNU General Public License, incorporated herein by reference.
20  *
21  *	Changes:
22  *	19970608	Alan Cox	Allowed dual card type support
23  *					Can set board type in insmod
24  *					Hooks for cops_setup routine
25  *					(not yet implemented).
26  *	19971101	Jay Schulist	Fixes for multiple lt* devices.
27  *	19980607	Steven Hirsch	Fixed the badly broken support
28  *					for Tangent type cards. Only
29  *                                      tested on Daystar LT200. Some
30  *                                      cleanup of formatting and program
31  *                                      logic.  Added emacs 'local-vars'
32  *                                      setup for Jay's brace style.
33  *	20000211	Alan Cox	Cleaned up for softnet
34  */
35 
36 static const char *version =
37 "cops.c:v0.04 6/7/98 Jay Schulist <jschlst@samba.org>\n";
38 /*
39  *  Sources:
40  *      COPS Localtalk SDK. This provides almost all of the information
41  *      needed.
42  */
43 
44 /*
45  * insmod/modprobe configurable stuff.
46  *	- IO Port, choose one your card supports or 0 if you dare.
47  *	- IRQ, also choose one your card supports or nothing and let
48  *	  the driver figure it out.
49  */
50 
51 #include <linux/module.h>
52 #include <linux/kernel.h>
53 #include <linux/types.h>
54 #include <linux/fcntl.h>
55 #include <linux/interrupt.h>
56 #include <linux/ptrace.h>
57 #include <linux/ioport.h>
58 #include <linux/in.h>
59 #include <linux/slab.h>
60 #include <linux/string.h>
61 #include <linux/errno.h>
62 #include <linux/init.h>
63 #include <linux/netdevice.h>
64 #include <linux/etherdevice.h>
65 #include <linux/skbuff.h>
66 #include <linux/if_arp.h>
67 #include <linux/if_ltalk.h>
68 #include <linux/delay.h>	/* For udelay() */
69 #include <linux/atalk.h>
70 #include <linux/spinlock.h>
71 #include <linux/bitops.h>
72 
73 #include <asm/system.h>
74 #include <asm/io.h>
75 #include <asm/dma.h>
76 
77 #include "cops.h"		/* Our Stuff */
78 #include "cops_ltdrv.h"		/* Firmware code for Tangent type cards. */
79 #include "cops_ffdrv.h"		/* Firmware code for Dayna type cards. */
80 
81 /*
82  *      The name of the card. Is used for messages and in the requests for
83  *      io regions, irqs and dma channels
84  */
85 
86 static const char *cardname = "cops";
87 
88 #ifdef CONFIG_COPS_DAYNA
89 static int board_type = DAYNA;	/* Module exported */
90 #else
91 static int board_type = TANGENT;
92 #endif
93 
94 static int io = 0x240;		/* Default IO for Dayna */
95 static int irq = 5;		/* Default IRQ */
96 
97 /*
98  *	COPS Autoprobe information.
99  *	Right now if port address is right but IRQ is not 5 this will
100  *      return a 5 no matter what since we will still get a status response.
101  *      Need one more additional check to narrow down after we have gotten
102  *      the ioaddr. But since only other possible IRQs is 3 and 4 so no real
103  *	hurry on this. I *STRONGLY* recommend using IRQ 5 for your card with
104  *	this driver.
105  *
106  *	This driver has 2 modes and they are: Dayna mode and Tangent mode.
107  *	Each mode corresponds with the type of card. It has been found
108  *	that there are 2 main types of cards and all other cards are
109  *	the same and just have different names or only have minor differences
110  *	such as more IO ports. As this driver is tested it will
111  *	become more clear on exactly what cards are supported. The driver
112  *	defaults to using Dayna mode. To change the drivers mode, simply
113  *	select Dayna or Tangent mode when configuring the kernel.
114  *
115  *      This driver should support:
116  *      TANGENT driver mode:
117  *              Tangent ATB-II, Novell NL-1000, Daystar Digital LT-200,
118  *		COPS LT-1
119  *      DAYNA driver mode:
120  *              Dayna DL2000/DaynaTalk PC (Half Length), COPS LT-95,
121  *		Farallon PhoneNET PC III, Farallon PhoneNET PC II
122  *	Other cards possibly supported mode unkown though:
123  *		Dayna DL2000 (Full length), COPS LT/M (Micro-Channel)
124  *
125  *	Cards NOT supported by this driver but supported by the ltpc.c
126  *	driver written by Bradford W. Johnson <johns393@maroon.tc.umn.edu>
127  *		Farallon PhoneNET PC
128  *		Original Apple LocalTalk PC card
129  *
130  *      N.B.
131  *
132  *      The Daystar Digital LT200 boards do not support interrupt-driven
133  *      IO.  You must specify 'irq=0xff' as a module parameter to invoke
134  *      polled mode.  I also believe that the port probing logic is quite
135  *      dangerous at best and certainly hopeless for a polled card.  Best to
136  *      specify both. - Steve H.
137  *
138  */
139 
140 /*
141  * Zero terminated list of IO ports to probe.
142  */
143 
144 static unsigned int ports[] = {
145 	0x240, 0x340, 0x200, 0x210, 0x220, 0x230, 0x260,
146 	0x2A0, 0x300, 0x310, 0x320, 0x330, 0x350, 0x360,
147 	0
148 };
149 
150 /*
151  * Zero terminated list of IRQ ports to probe.
152  */
153 
154 static int cops_irqlist[] = {
155 	5, 4, 3, 0
156 };
157 
158 static struct timer_list cops_timer;
159 
160 /* use 0 for production, 1 for verification, 2 for debug, 3 for verbose debug */
161 #ifndef COPS_DEBUG
162 #define COPS_DEBUG 1
163 #endif
164 static unsigned int cops_debug = COPS_DEBUG;
165 
166 /* The number of low I/O ports used by the card. */
167 #define COPS_IO_EXTENT       8
168 
169 /* Information that needs to be kept for each board. */
170 
171 struct cops_local
172 {
173         struct net_device_stats stats;
174         int board;			/* Holds what board type is. */
175 	int nodeid;			/* Set to 1 once have nodeid. */
176         unsigned char node_acquire;	/* Node ID when acquired. */
177         struct atalk_addr node_addr;	/* Full node address */
178 	spinlock_t lock;		/* RX/TX lock */
179 };
180 
181 /* Index to functions, as function prototypes. */
182 static int  cops_probe1 (struct net_device *dev, int ioaddr);
183 static int  cops_irq (int ioaddr, int board);
184 
185 static int  cops_open (struct net_device *dev);
186 static int  cops_jumpstart (struct net_device *dev);
187 static void cops_reset (struct net_device *dev, int sleep);
188 static void cops_load (struct net_device *dev);
189 static int  cops_nodeid (struct net_device *dev, int nodeid);
190 
191 static irqreturn_t cops_interrupt (int irq, void *dev_id);
192 static void cops_poll (unsigned long ltdev);
193 static void cops_timeout(struct net_device *dev);
194 static void cops_rx (struct net_device *dev);
195 static int  cops_send_packet (struct sk_buff *skb, struct net_device *dev);
196 static void set_multicast_list (struct net_device *dev);
197 static int  cops_hard_header (struct sk_buff *skb, struct net_device *dev,
198 			      unsigned short type, void *daddr, void *saddr,
199 			      unsigned len);
200 
201 static int  cops_ioctl (struct net_device *dev, struct ifreq *rq, int cmd);
202 static int  cops_close (struct net_device *dev);
203 static struct net_device_stats *cops_get_stats (struct net_device *dev);
204 
205 static void cleanup_card(struct net_device *dev)
206 {
207 	if (dev->irq)
208 		free_irq(dev->irq, dev);
209 	release_region(dev->base_addr, COPS_IO_EXTENT);
210 }
211 
212 /*
213  *      Check for a network adaptor of this type, and return '0' iff one exists.
214  *      If dev->base_addr == 0, probe all likely locations.
215  *      If dev->base_addr in [1..0x1ff], always return failure.
216  *        otherwise go with what we pass in.
217  */
218 struct net_device * __init cops_probe(int unit)
219 {
220 	struct net_device *dev;
221 	unsigned *port;
222 	int base_addr;
223 	int err = 0;
224 
225 	dev = alloc_ltalkdev(sizeof(struct cops_local));
226 	if (!dev)
227 		return ERR_PTR(-ENOMEM);
228 
229 	if (unit >= 0) {
230 		sprintf(dev->name, "lt%d", unit);
231 		netdev_boot_setup_check(dev);
232 		irq = dev->irq;
233 		base_addr = dev->base_addr;
234 	} else {
235 		base_addr = dev->base_addr = io;
236 	}
237 
238 	SET_MODULE_OWNER(dev);
239 
240 	if (base_addr > 0x1ff) {    /* Check a single specified location. */
241 		err = cops_probe1(dev, base_addr);
242 	} else if (base_addr != 0) { /* Don't probe at all. */
243 		err = -ENXIO;
244 	} else {
245 		/* FIXME  Does this really work for cards which generate irq?
246 		 * It's definitely N.G. for polled Tangent. sh
247 		 * Dayna cards don't autoprobe well at all, but if your card is
248 		 * at IRQ 5 & IO 0x240 we find it every time. ;) JS
249 		 */
250 		for (port = ports; *port && cops_probe1(dev, *port) < 0; port++)
251 			;
252 		if (!*port)
253 			err = -ENODEV;
254 	}
255 	if (err)
256 		goto out;
257 	err = register_netdev(dev);
258 	if (err)
259 		goto out1;
260 	return dev;
261 out1:
262 	cleanup_card(dev);
263 out:
264 	free_netdev(dev);
265 	return ERR_PTR(err);
266 }
267 
268 /*
269  *      This is the real probe routine. Linux has a history of friendly device
270  *      probes on the ISA bus. A good device probes avoids doing writes, and
271  *      verifies that the correct device exists and functions.
272  */
273 static int __init cops_probe1(struct net_device *dev, int ioaddr)
274 {
275         struct cops_local *lp;
276 	static unsigned version_printed;
277 	int board = board_type;
278 	int retval;
279 
280         if(cops_debug && version_printed++ == 0)
281 		printk("%s", version);
282 
283 	/* Grab the region so no one else tries to probe our ioports. */
284 	if (!request_region(ioaddr, COPS_IO_EXTENT, dev->name))
285 		return -EBUSY;
286 
287         /*
288          * Since this board has jumpered interrupts, allocate the interrupt
289          * vector now. There is no point in waiting since no other device
290          * can use the interrupt, and this marks the irq as busy. Jumpered
291          * interrupts are typically not reported by the boards, and we must
292          * used AutoIRQ to find them.
293 	 */
294 	dev->irq = irq;
295 	switch (dev->irq)
296 	{
297 		case 0:
298 			/* COPS AutoIRQ routine */
299 			dev->irq = cops_irq(ioaddr, board);
300 			if (dev->irq)
301 				break;
302 			/* No IRQ found on this port, fallthrough */
303 		case 1:
304 			retval = -EINVAL;
305 			goto err_out;
306 
307 		/* Fixup for users that don't know that IRQ 2 is really
308 		 * IRQ 9, or don't know which one to set.
309 		 */
310 		case 2:
311 			dev->irq = 9;
312 			break;
313 
314 		/* Polled operation requested. Although irq of zero passed as
315 		 * a parameter tells the init routines to probe, we'll
316 		 * overload it to denote polled operation at runtime.
317 		 */
318 		case 0xff:
319 			dev->irq = 0;
320 			break;
321 
322 		default:
323 			break;
324 	}
325 
326 	/* Reserve any actual interrupt. */
327 	if (dev->irq) {
328 		retval = request_irq(dev->irq, &cops_interrupt, 0, dev->name, dev);
329 		if (retval)
330 			goto err_out;
331 	}
332 
333 	dev->base_addr = ioaddr;
334 
335         lp = netdev_priv(dev);
336         memset(lp, 0, sizeof(struct cops_local));
337         spin_lock_init(&lp->lock);
338 
339 	/* Copy local board variable to lp struct. */
340 	lp->board               = board;
341 
342 	dev->hard_start_xmit    = cops_send_packet;
343 	dev->tx_timeout		= cops_timeout;
344 	dev->watchdog_timeo	= HZ * 2;
345 	dev->hard_header	= cops_hard_header;
346         dev->get_stats          = cops_get_stats;
347 	dev->open               = cops_open;
348         dev->stop               = cops_close;
349         dev->do_ioctl           = cops_ioctl;
350 	dev->set_multicast_list = set_multicast_list;
351         dev->mc_list            = NULL;
352 
353 	/* Tell the user where the card is and what mode we're in. */
354 	if(board==DAYNA)
355 		printk("%s: %s at %#3x, using IRQ %d, in Dayna mode.\n",
356 			dev->name, cardname, ioaddr, dev->irq);
357 	if(board==TANGENT) {
358 		if(dev->irq)
359 			printk("%s: %s at %#3x, IRQ %d, in Tangent mode\n",
360 				dev->name, cardname, ioaddr, dev->irq);
361 		else
362 			printk("%s: %s at %#3x, using polled IO, in Tangent mode.\n",
363 				dev->name, cardname, ioaddr);
364 
365 	}
366         return 0;
367 
368 err_out:
369 	release_region(ioaddr, COPS_IO_EXTENT);
370 	return retval;
371 }
372 
373 static int __init cops_irq (int ioaddr, int board)
374 {       /*
375          * This does not use the IRQ to determine where the IRQ is. We just
376          * assume that when we get a correct status response that it's the IRQ.
377          * This really just verifies the IO port but since we only have access
378          * to such a small number of IRQs (5, 4, 3) this is not bad.
379          * This will probably not work for more than one card.
380          */
381         int irqaddr=0;
382         int i, x, status;
383 
384         if(board==DAYNA)
385         {
386                 outb(0, ioaddr+DAYNA_RESET);
387                 inb(ioaddr+DAYNA_RESET);
388                 mdelay(333);
389         }
390         if(board==TANGENT)
391         {
392                 inb(ioaddr);
393                 outb(0, ioaddr);
394                 outb(0, ioaddr+TANG_RESET);
395         }
396 
397         for(i=0; cops_irqlist[i] !=0; i++)
398         {
399                 irqaddr = cops_irqlist[i];
400                 for(x = 0xFFFF; x>0; x --)    /* wait for response */
401                 {
402                         if(board==DAYNA)
403                         {
404                                 status = (inb(ioaddr+DAYNA_CARD_STATUS)&3);
405                                 if(status == 1)
406                                         return irqaddr;
407                         }
408                         if(board==TANGENT)
409                         {
410                                 if((inb(ioaddr+TANG_CARD_STATUS)& TANG_TX_READY) !=0)
411                                         return irqaddr;
412                         }
413                 }
414         }
415         return 0;       /* no IRQ found */
416 }
417 
418 /*
419  * Open/initialize the board. This is called (in the current kernel)
420  * sometime after booting when the 'ifconfig' program is run.
421  */
422 static int cops_open(struct net_device *dev)
423 {
424     struct cops_local *lp = netdev_priv(dev);
425 
426 	if(dev->irq==0)
427 	{
428 		/*
429 		 * I don't know if the Dayna-style boards support polled
430 		 * operation.  For now, only allow it for Tangent.
431 		 */
432 		if(lp->board==TANGENT)	/* Poll 20 times per second */
433 		{
434 		    init_timer(&cops_timer);
435 		    cops_timer.function = cops_poll;
436 		    cops_timer.data 	= (unsigned long)dev;
437 		    cops_timer.expires 	= jiffies + HZ/20;
438 		    add_timer(&cops_timer);
439 		}
440 		else
441 		{
442 			printk(KERN_WARNING "%s: No irq line set\n", dev->name);
443 			return -EAGAIN;
444 		}
445 	}
446 
447 	cops_jumpstart(dev);	/* Start the card up. */
448 
449 	netif_start_queue(dev);
450         return 0;
451 }
452 
453 /*
454  *	This allows for a dynamic start/restart of the entire card.
455  */
456 static int cops_jumpstart(struct net_device *dev)
457 {
458 	struct cops_local *lp = netdev_priv(dev);
459 
460 	/*
461          *      Once the card has the firmware loaded and has acquired
462          *      the nodeid, if it is reset it will lose it all.
463          */
464         cops_reset(dev,1);	/* Need to reset card before load firmware. */
465         cops_load(dev);		/* Load the firmware. */
466 
467 	/*
468 	 *	If atalkd already gave us a nodeid we will use that
469 	 *	one again, else we wait for atalkd to give us a nodeid
470 	 *	in cops_ioctl. This may cause a problem if someone steals
471 	 *	our nodeid while we are resetting.
472 	 */
473 	if(lp->nodeid == 1)
474 		cops_nodeid(dev,lp->node_acquire);
475 
476 	return 0;
477 }
478 
479 static void tangent_wait_reset(int ioaddr)
480 {
481 	int timeout=0;
482 
483 	while(timeout++ < 5 && (inb(ioaddr+TANG_CARD_STATUS)&TANG_TX_READY)==0)
484 		mdelay(1);   /* Wait 1 second */
485 }
486 
487 /*
488  *      Reset the LocalTalk board.
489  */
490 static void cops_reset(struct net_device *dev, int sleep)
491 {
492         struct cops_local *lp = netdev_priv(dev);
493         int ioaddr=dev->base_addr;
494 
495         if(lp->board==TANGENT)
496         {
497                 inb(ioaddr);		/* Clear request latch. */
498                 outb(0,ioaddr);		/* Clear the TANG_TX_READY flop. */
499                 outb(0, ioaddr+TANG_RESET);	/* Reset the adapter. */
500 
501 		tangent_wait_reset(ioaddr);
502                 outb(0, ioaddr+TANG_CLEAR_INT);
503         }
504         if(lp->board==DAYNA)
505         {
506                 outb(0, ioaddr+DAYNA_RESET);	/* Assert the reset port */
507                 inb(ioaddr+DAYNA_RESET);	/* Clear the reset */
508                 if(sleep)
509                 {
510                         long snap=jiffies;
511 
512 			/* Let card finish initializing, about 1/3 second */
513 	                while(jiffies-snap<HZ/3)
514                                 schedule();
515                 }
516                 else
517                         mdelay(333);
518         }
519 	netif_wake_queue(dev);
520 	return;
521 }
522 
523 static void cops_load (struct net_device *dev)
524 {
525         struct ifreq ifr;
526         struct ltfirmware *ltf= (struct ltfirmware *)&ifr.ifr_ifru;
527         struct cops_local *lp = netdev_priv(dev);
528         int ioaddr=dev->base_addr;
529 	int length, i = 0;
530 
531         strcpy(ifr.ifr_name,"lt0");
532 
533         /* Get card's firmware code and do some checks on it. */
534 #ifdef CONFIG_COPS_DAYNA
535         if(lp->board==DAYNA)
536         {
537                 ltf->length=sizeof(ffdrv_code);
538                 ltf->data=ffdrv_code;
539         }
540         else
541 #endif
542 #ifdef CONFIG_COPS_TANGENT
543         if(lp->board==TANGENT)
544         {
545                 ltf->length=sizeof(ltdrv_code);
546                 ltf->data=ltdrv_code;
547         }
548         else
549 #endif
550 	{
551 		printk(KERN_INFO "%s; unsupported board type.\n", dev->name);
552 		return;
553 	}
554 
555         /* Check to make sure firmware is correct length. */
556         if(lp->board==DAYNA && ltf->length!=5983)
557         {
558                 printk(KERN_WARNING "%s: Firmware is not length of FFDRV.BIN.\n", dev->name);
559                 return;
560         }
561         if(lp->board==TANGENT && ltf->length!=2501)
562         {
563                 printk(KERN_WARNING "%s: Firmware is not length of DRVCODE.BIN.\n", dev->name);
564                 return;
565         }
566 
567         if(lp->board==DAYNA)
568         {
569                 /*
570                  *      We must wait for a status response
571                  *      with the DAYNA board.
572                  */
573                 while(++i<65536)
574                 {
575                        if((inb(ioaddr+DAYNA_CARD_STATUS)&3)==1)
576                                 break;
577                 }
578 
579                 if(i==65536)
580                         return;
581         }
582 
583         /*
584          *      Upload the firmware and kick. Byte-by-byte works nicely here.
585          */
586 	i=0;
587         length = ltf->length;
588         while(length--)
589         {
590                 outb(ltf->data[i], ioaddr);
591                 i++;
592         }
593 
594 	if(cops_debug > 1)
595 		printk("%s: Uploaded firmware - %d bytes of %d bytes.\n",
596 			dev->name, i, ltf->length);
597 
598         if(lp->board==DAYNA) 	/* Tell Dayna to run the firmware code. */
599                 outb(1, ioaddr+DAYNA_INT_CARD);
600 	else			/* Tell Tang to run the firmware code. */
601 		inb(ioaddr);
602 
603         if(lp->board==TANGENT)
604         {
605                 tangent_wait_reset(ioaddr);
606                 inb(ioaddr);	/* Clear initial ready signal. */
607         }
608 
609         return;
610 }
611 
612 /*
613  * 	Get the LocalTalk Nodeid from the card. We can suggest
614  *	any nodeid 1-254. The card will try and get that exact
615  *	address else we can specify 0 as the nodeid and the card
616  *	will autoprobe for a nodeid.
617  */
618 static int cops_nodeid (struct net_device *dev, int nodeid)
619 {
620 	struct cops_local *lp = netdev_priv(dev);
621 	int ioaddr = dev->base_addr;
622 
623 	if(lp->board == DAYNA)
624         {
625         	/* Empty any pending adapter responses. */
626                 while((inb(ioaddr+DAYNA_CARD_STATUS)&DAYNA_TX_READY)==0)
627                 {
628 			outb(0, ioaddr+COPS_CLEAR_INT);	/* Clear interrupts. */
629         		if((inb(ioaddr+DAYNA_CARD_STATUS)&0x03)==DAYNA_RX_REQUEST)
630                 		cops_rx(dev);	/* Kick any packets waiting. */
631 			schedule();
632                 }
633 
634                 outb(2, ioaddr);       	/* Output command packet length as 2. */
635                 outb(0, ioaddr);
636                 outb(LAP_INIT, ioaddr);	/* Send LAP_INIT command byte. */
637                 outb(nodeid, ioaddr);  	/* Suggest node address. */
638         }
639 
640 	if(lp->board == TANGENT)
641         {
642                 /* Empty any pending adapter responses. */
643                 while(inb(ioaddr+TANG_CARD_STATUS)&TANG_RX_READY)
644                 {
645 			outb(0, ioaddr+COPS_CLEAR_INT);	/* Clear interrupt. */
646                 	cops_rx(dev);          	/* Kick out packets waiting. */
647 			schedule();
648                 }
649 
650 		/* Not sure what Tangent does if nodeid picked is used. */
651                 if(nodeid == 0)	         		/* Seed. */
652                 	nodeid = jiffies&0xFF;		/* Get a random try */
653                 outb(2, ioaddr);        		/* Command length LSB */
654                 outb(0, ioaddr);       			/* Command length MSB */
655                 outb(LAP_INIT, ioaddr); 		/* Send LAP_INIT byte */
656                 outb(nodeid, ioaddr); 		  	/* LAP address hint. */
657                 outb(0xFF, ioaddr);     		/* Int. level to use */
658         }
659 
660 	lp->node_acquire=0;		/* Set nodeid holder to 0. */
661         while(lp->node_acquire==0)	/* Get *True* nodeid finally. */
662 	{
663 		outb(0, ioaddr+COPS_CLEAR_INT);	/* Clear any interrupt. */
664 
665 		if(lp->board == DAYNA)
666 		{
667                 	if((inb(ioaddr+DAYNA_CARD_STATUS)&0x03)==DAYNA_RX_REQUEST)
668                 		cops_rx(dev);	/* Grab the nodeid put in lp->node_acquire. */
669 		}
670 		if(lp->board == TANGENT)
671 		{
672 			if(inb(ioaddr+TANG_CARD_STATUS)&TANG_RX_READY)
673                                 cops_rx(dev);   /* Grab the nodeid put in lp->node_acquire. */
674 		}
675 		schedule();
676 	}
677 
678 	if(cops_debug > 1)
679 		printk(KERN_DEBUG "%s: Node ID %d has been acquired.\n",
680 			dev->name, lp->node_acquire);
681 
682 	lp->nodeid=1;	/* Set got nodeid to 1. */
683 
684         return 0;
685 }
686 
687 /*
688  *	Poll the Tangent type cards to see if we have work.
689  */
690 
691 static void cops_poll(unsigned long ltdev)
692 {
693 	int ioaddr, status;
694 	int boguscount = 0;
695 
696 	struct net_device *dev = (struct net_device *)ltdev;
697 
698 	del_timer(&cops_timer);
699 
700 	if(dev == NULL)
701 		return;	/* We've been downed */
702 
703 	ioaddr = dev->base_addr;
704 	do {
705 		status=inb(ioaddr+TANG_CARD_STATUS);
706 		if(status & TANG_RX_READY)
707 			cops_rx(dev);
708 		if(status & TANG_TX_READY)
709 			netif_wake_queue(dev);
710 		status = inb(ioaddr+TANG_CARD_STATUS);
711 	} while((++boguscount < 20) && (status&(TANG_RX_READY|TANG_TX_READY)));
712 
713 	/* poll 20 times per second */
714 	cops_timer.expires = jiffies + HZ/20;
715 	add_timer(&cops_timer);
716 
717 	return;
718 }
719 
720 /*
721  *      The typical workload of the driver:
722  *      Handle the network interface interrupts.
723  */
724 static irqreturn_t cops_interrupt(int irq, void *dev_id)
725 {
726         struct net_device *dev = dev_id;
727         struct cops_local *lp;
728         int ioaddr, status;
729         int boguscount = 0;
730 
731         ioaddr = dev->base_addr;
732         lp = netdev_priv(dev);
733 
734 	if(lp->board==DAYNA)
735 	{
736 		do {
737 			outb(0, ioaddr + COPS_CLEAR_INT);
738                        	status=inb(ioaddr+DAYNA_CARD_STATUS);
739                        	if((status&0x03)==DAYNA_RX_REQUEST)
740                        	        cops_rx(dev);
741                 	netif_wake_queue(dev);
742 		} while(++boguscount < 20);
743 	}
744 	else
745 	{
746 		do {
747                        	status=inb(ioaddr+TANG_CARD_STATUS);
748 			if(status & TANG_RX_READY)
749 				cops_rx(dev);
750 			if(status & TANG_TX_READY)
751 				netif_wake_queue(dev);
752 			status=inb(ioaddr+TANG_CARD_STATUS);
753 		} while((++boguscount < 20) && (status&(TANG_RX_READY|TANG_TX_READY)));
754 	}
755 
756         return IRQ_HANDLED;
757 }
758 
759 /*
760  *      We have a good packet(s), get it/them out of the buffers.
761  */
762 static void cops_rx(struct net_device *dev)
763 {
764         int pkt_len = 0;
765         int rsp_type = 0;
766         struct sk_buff *skb = NULL;
767         struct cops_local *lp = netdev_priv(dev);
768         int ioaddr = dev->base_addr;
769         int boguscount = 0;
770         unsigned long flags;
771 
772 
773 	spin_lock_irqsave(&lp->lock, flags);
774 
775         if(lp->board==DAYNA)
776         {
777                 outb(0, ioaddr);                /* Send out Zero length. */
778                 outb(0, ioaddr);
779                 outb(DATA_READ, ioaddr);        /* Send read command out. */
780 
781                 /* Wait for DMA to turn around. */
782                 while(++boguscount<1000000)
783                 {
784 			barrier();
785                         if((inb(ioaddr+DAYNA_CARD_STATUS)&0x03)==DAYNA_RX_READY)
786                                 break;
787                 }
788 
789                 if(boguscount==1000000)
790                 {
791                         printk(KERN_WARNING "%s: DMA timed out.\n",dev->name);
792 			spin_unlock_irqrestore(&lp->lock, flags);
793                         return;
794                 }
795         }
796 
797         /* Get response length. */
798 	if(lp->board==DAYNA)
799         	pkt_len = inb(ioaddr) & 0xFF;
800 	else
801 		pkt_len = inb(ioaddr) & 0x00FF;
802         pkt_len |= (inb(ioaddr) << 8);
803         /* Input IO code. */
804         rsp_type=inb(ioaddr);
805 
806         /* Malloc up new buffer. */
807         skb = dev_alloc_skb(pkt_len);
808         if(skb == NULL)
809         {
810                 printk(KERN_WARNING "%s: Memory squeeze, dropping packet.\n",
811 			dev->name);
812                 lp->stats.rx_dropped++;
813                 while(pkt_len--)        /* Discard packet */
814                         inb(ioaddr);
815                 spin_unlock_irqrestore(&lp->lock, flags);
816                 return;
817         }
818         skb->dev = dev;
819         skb_put(skb, pkt_len);
820         skb->protocol = htons(ETH_P_LOCALTALK);
821 
822         insb(ioaddr, skb->data, pkt_len);               /* Eat the Data */
823 
824         if(lp->board==DAYNA)
825                 outb(1, ioaddr+DAYNA_INT_CARD);         /* Interrupt the card */
826 
827         spin_unlock_irqrestore(&lp->lock, flags);  /* Restore interrupts. */
828 
829         /* Check for bad response length */
830         if(pkt_len < 0 || pkt_len > MAX_LLAP_SIZE)
831         {
832 		printk(KERN_WARNING "%s: Bad packet length of %d bytes.\n",
833 			dev->name, pkt_len);
834                 lp->stats.tx_errors++;
835                 dev_kfree_skb_any(skb);
836                 return;
837         }
838 
839         /* Set nodeid and then get out. */
840         if(rsp_type == LAP_INIT_RSP)
841         {	/* Nodeid taken from received packet. */
842                 lp->node_acquire = skb->data[0];
843                 dev_kfree_skb_any(skb);
844                 return;
845         }
846 
847         /* One last check to make sure we have a good packet. */
848         if(rsp_type != LAP_RESPONSE)
849         {
850                 printk(KERN_WARNING "%s: Bad packet type %d.\n", dev->name, rsp_type);
851                 lp->stats.tx_errors++;
852                 dev_kfree_skb_any(skb);
853                 return;
854         }
855 
856         skb_reset_mac_header(skb);    /* Point to entire packet. */
857         skb_pull(skb,3);
858         skb_reset_transport_header(skb);    /* Point to data (Skip header). */
859 
860         /* Update the counters. */
861         lp->stats.rx_packets++;
862         lp->stats.rx_bytes += skb->len;
863 
864         /* Send packet to a higher place. */
865         netif_rx(skb);
866 	dev->last_rx = jiffies;
867 }
868 
869 static void cops_timeout(struct net_device *dev)
870 {
871         struct cops_local *lp = netdev_priv(dev);
872         int ioaddr = dev->base_addr;
873 
874 	lp->stats.tx_errors++;
875         if(lp->board==TANGENT)
876         {
877 		if((inb(ioaddr+TANG_CARD_STATUS)&TANG_TX_READY)==0)
878                		printk(KERN_WARNING "%s: No TX complete interrupt.\n", dev->name);
879 	}
880 	printk(KERN_WARNING "%s: Transmit timed out.\n", dev->name);
881 	cops_jumpstart(dev);	/* Restart the card. */
882 	dev->trans_start = jiffies;
883 	netif_wake_queue(dev);
884 }
885 
886 
887 /*
888  *	Make the card transmit a LocalTalk packet.
889  */
890 
891 static int cops_send_packet(struct sk_buff *skb, struct net_device *dev)
892 {
893         struct cops_local *lp = netdev_priv(dev);
894         int ioaddr = dev->base_addr;
895         unsigned long flags;
896 
897         /*
898          * Block a timer-based transmit from overlapping.
899 	 */
900 
901 	netif_stop_queue(dev);
902 
903 	spin_lock_irqsave(&lp->lock, flags);
904 	if(lp->board == DAYNA)	 /* Wait for adapter transmit buffer. */
905 		while((inb(ioaddr+DAYNA_CARD_STATUS)&DAYNA_TX_READY)==0)
906 			cpu_relax();
907 	if(lp->board == TANGENT) /* Wait for adapter transmit buffer. */
908 		while((inb(ioaddr+TANG_CARD_STATUS)&TANG_TX_READY)==0)
909 			cpu_relax();
910 
911 	/* Output IO length. */
912 	outb(skb->len, ioaddr);
913 	if(lp->board == DAYNA)
914                	outb(skb->len >> 8, ioaddr);
915 	else
916 		outb((skb->len >> 8)&0x0FF, ioaddr);
917 
918 	/* Output IO code. */
919 	outb(LAP_WRITE, ioaddr);
920 
921 	if(lp->board == DAYNA)	/* Check the transmit buffer again. */
922         	while((inb(ioaddr+DAYNA_CARD_STATUS)&DAYNA_TX_READY)==0);
923 
924 	outsb(ioaddr, skb->data, skb->len);	/* Send out the data. */
925 
926 	if(lp->board==DAYNA)	/* Dayna requires you kick the card */
927 		outb(1, ioaddr+DAYNA_INT_CARD);
928 
929 	spin_unlock_irqrestore(&lp->lock, flags);	/* Restore interrupts. */
930 
931 	/* Done sending packet, update counters and cleanup. */
932 	lp->stats.tx_packets++;
933 	lp->stats.tx_bytes += skb->len;
934 	dev->trans_start = jiffies;
935 	dev_kfree_skb (skb);
936         return 0;
937 }
938 
939 /*
940  *	Dummy function to keep the Appletalk layer happy.
941  */
942 
943 static void set_multicast_list(struct net_device *dev)
944 {
945         if(cops_debug >= 3)
946 		printk("%s: set_multicast_list executed\n", dev->name);
947 }
948 
949 /*
950  *      Another Dummy function to keep the Appletalk layer happy.
951  */
952 
953 static int cops_hard_header(struct sk_buff *skb, struct net_device *dev,
954 			    unsigned short type, void *daddr, void *saddr,
955 			    unsigned len)
956 {
957         if(cops_debug >= 3)
958                 printk("%s: cops_hard_header executed. Wow!\n", dev->name);
959         return 0;
960 }
961 
962 /*
963  *      System ioctls for the COPS LocalTalk card.
964  */
965 
966 static int cops_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
967 {
968         struct cops_local *lp = netdev_priv(dev);
969         struct sockaddr_at *sa = (struct sockaddr_at *)&ifr->ifr_addr;
970         struct atalk_addr *aa = (struct atalk_addr *)&lp->node_addr;
971 
972         switch(cmd)
973         {
974                 case SIOCSIFADDR:
975 			/* Get and set the nodeid and network # atalkd wants. */
976 			cops_nodeid(dev, sa->sat_addr.s_node);
977 			aa->s_net               = sa->sat_addr.s_net;
978                         aa->s_node              = lp->node_acquire;
979 
980 			/* Set broardcast address. */
981                         dev->broadcast[0]       = 0xFF;
982 
983 			/* Set hardware address. */
984                         dev->dev_addr[0]        = aa->s_node;
985                         dev->addr_len           = 1;
986                         return 0;
987 
988                 case SIOCGIFADDR:
989                         sa->sat_addr.s_net      = aa->s_net;
990                         sa->sat_addr.s_node     = aa->s_node;
991                         return 0;
992 
993                 default:
994                         return -EOPNOTSUPP;
995         }
996 }
997 
998 /*
999  *	The inverse routine to cops_open().
1000  */
1001 
1002 static int cops_close(struct net_device *dev)
1003 {
1004 	struct cops_local *lp = netdev_priv(dev);
1005 
1006 	/* If we were running polled, yank the timer.
1007 	 */
1008 	if(lp->board==TANGENT && dev->irq==0)
1009 		del_timer(&cops_timer);
1010 
1011 	netif_stop_queue(dev);
1012         return 0;
1013 }
1014 
1015 /*
1016  *      Get the current statistics.
1017  *      This may be called with the card open or closed.
1018  */
1019 static struct net_device_stats *cops_get_stats(struct net_device *dev)
1020 {
1021         struct cops_local *lp = netdev_priv(dev);
1022         return &lp->stats;
1023 }
1024 
1025 #ifdef MODULE
1026 static struct net_device *cops_dev;
1027 
1028 MODULE_LICENSE("GPL");
1029 module_param(io, int, 0);
1030 module_param(irq, int, 0);
1031 module_param(board_type, int, 0);
1032 
1033 int __init init_module(void)
1034 {
1035 	if (io == 0)
1036 		printk(KERN_WARNING "%s: You shouldn't autoprobe with insmod\n",
1037 			cardname);
1038 	cops_dev = cops_probe(-1);
1039 	if (IS_ERR(cops_dev))
1040 		return PTR_ERR(cops_dev);
1041         return 0;
1042 }
1043 
1044 void __exit cleanup_module(void)
1045 {
1046 	unregister_netdev(cops_dev);
1047 	cleanup_card(cops_dev);
1048 	free_netdev(cops_dev);
1049 }
1050 #endif /* MODULE */
1051 
1052 /*
1053  * Local variables:
1054  *  compile-command: "gcc -DMODVERSIONS -DMODULE -D__KERNEL__ -Wall -Wstrict-prototypes -O2 -c cops.c"
1055  *  c-basic-offset: 4
1056  *  c-file-offsets: ((substatement-open . 0))
1057  * End:
1058  */
1059