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