blob: 01e2ac55c137ee10f69641fcea8168aaee9696cf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*** ltpc.c -- a driver for the LocalTalk PC card.
2 *
3 * Copyright (c) 1995,1996 Bradford W. Johnson <johns393@maroon.tc.umn.edu>
4 *
5 * This software may be used and distributed according to the terms
6 * of the GNU General Public License, incorporated herein by reference.
7 *
8 * This is ALPHA code at best. It may not work for you. It may
9 * damage your equipment. It may damage your relations with other
10 * users of your network. Use it at your own risk!
11 *
12 * Based in part on:
13 * skeleton.c by Donald Becker
14 * dummy.c by Nick Holloway and Alan Cox
15 * loopback.c by Ross Biro, Fred van Kampen, Donald Becker
16 * the netatalk source code (UMICH)
17 * lots of work on the card...
18 *
19 * I do not have access to the (proprietary) SDK that goes with the card.
20 * If you do, I don't want to know about it, and you can probably write
21 * a better driver yourself anyway. This does mean that the pieces that
22 * talk to the card are guesswork on my part, so use at your own risk!
23 *
24 * This is my first try at writing Linux networking code, and is also
25 * guesswork. Again, use at your own risk! (Although on this part, I'd
26 * welcome suggestions)
27 *
28 * This is a loadable kernel module which seems to work at my site
29 * consisting of a 1.2.13 linux box running netatalk 1.3.3, and with
30 * the kernel support from 1.3.3b2 including patches routing.patch
31 * and ddp.disappears.from.chooser. In order to run it, you will need
32 * to patch ddp.c and aarp.c in the kernel, but only a little...
33 *
34 * I'm fairly confident that while this is arguably badly written, the
35 * problems that people experience will be "higher level", that is, with
36 * complications in the netatalk code. The driver itself doesn't do
37 * anything terribly complicated -- it pretends to be an ether device
38 * as far as netatalk is concerned, strips the DDP data out of the ether
39 * frame and builds a LLAP packet to send out the card. In the other
40 * direction, it receives LLAP frames from the card and builds a fake
41 * ether packet that it then tosses up to the networking code. You can
42 * argue (correctly) that this is an ugly way to do things, but it
43 * requires a minimal amount of fooling with the code in ddp.c and aarp.c.
44 *
45 * The card will do a lot more than is used here -- I *think* it has the
46 * layers up through ATP. Even if you knew how that part works (which I
47 * don't) it would be a big job to carve up the kernel ddp code to insert
48 * things at a higher level, and probably a bad idea...
49 *
50 * There are a number of other cards that do LocalTalk on the PC. If
51 * nobody finds any insurmountable (at the netatalk level) problems
52 * here, this driver should encourage people to put some work into the
53 * other cards (some of which I gather are still commercially available)
54 * and also to put hooks for LocalTalk into the official ddp code.
55 *
56 * I welcome comments and suggestions. This is my first try at Linux
57 * networking stuff, and there are probably lots of things that I did
58 * suboptimally.
59 *
60 ***/
61
62/***
63 *
64 * $Log: ltpc.c,v $
65 * Revision 1.1.2.1 2000/03/01 05:35:07 jgarzik
66 * at and tr cleanup
67 *
68 * Revision 1.8 1997/01/28 05:44:54 bradford
69 * Clean up for non-module a little.
70 * Hacked about a bit to clean things up - Alan Cox
71 * Probably broken it from the origina 1.8
72 *
73
74 * 1998/11/09: David Huggins-Daines <dhd@debian.org>
75 * Cleaned up the initialization code to use the standard autoirq methods,
76 and to probe for things in the standard order of i/o, irq, dma. This
77 removes the "reset the reset" hack, because I couldn't figure out an
78 easy way to get the card to trigger an interrupt after it.
79 * Added support for passing configuration parameters on the kernel command
80 line and through insmod
81 * Changed the device name from "ltalk0" to "lt0", both to conform with the
82 other localtalk driver, and to clear up the inconsistency between the
83 module and the non-module versions of the driver :-)
84 * Added a bunch of comments (I was going to make some enums for the state
85 codes and the register offsets, but I'm still not sure exactly what their
86 semantics are)
87 * Don't poll anymore in interrupt-driven mode
88 * It seems to work as a module now (as of 2.1.127), but I don't think
89 I'm responsible for that...
90
91 *
92 * Revision 1.7 1996/12/12 03:42:33 bradford
93 * DMA alloc cribbed from 3c505.c.
94 *
95 * Revision 1.6 1996/12/12 03:18:58 bradford
96 * Added virt_to_bus; works in 2.1.13.
97 *
98 * Revision 1.5 1996/12/12 03:13:22 root
99 * xmitQel initialization -- think through better though.
100 *
101 * Revision 1.4 1996/06/18 14:55:55 root
102 * Change names to ltpc. Tabs. Took a shot at dma alloc,
103 * although more needs to be done eventually.
104 *
105 * Revision 1.3 1996/05/22 14:59:39 root
106 * Change dev->open, dev->close to track dummy.c in 1.99.(around 7)
107 *
108 * Revision 1.2 1996/05/22 14:58:24 root
109 * Change tabs mostly.
110 *
111 * Revision 1.1 1996/04/23 04:45:09 root
112 * Initial revision
113 *
114 * Revision 0.16 1996/03/05 15:59:56 root
115 * Change ARPHRD_LOCALTLK definition to the "real" one.
116 *
117 * Revision 0.15 1996/03/05 06:28:30 root
118 * Changes for kernel 1.3.70. Still need a few patches to kernel, but
119 * it's getting closer.
120 *
121 * Revision 0.14 1996/02/25 17:38:32 root
122 * More cleanups. Removed query to card on get_stats.
123 *
124 * Revision 0.13 1996/02/21 16:27:40 root
125 * Refix debug_print_skb. Fix mac.raw gotcha that appeared in 1.3.65.
126 * Clean up receive code a little.
127 *
128 * Revision 0.12 1996/02/19 16:34:53 root
129 * Fix debug_print_skb. Kludge outgoing snet to 0 when using startup
130 * range. Change debug to mask: 1 for verbose, 2 for higher level stuff
131 * including packet printing, 4 for lower level (card i/o) stuff.
132 *
133 * Revision 0.11 1996/02/12 15:53:38 root
134 * Added router sends (requires new aarp.c patch)
135 *
136 * Revision 0.10 1996/02/11 00:19:35 root
137 * Change source LTALK_LOGGING debug switch to insmod ... debug=2.
138 *
139 * Revision 0.9 1996/02/10 23:59:35 root
140 * Fixed those fixes for 1.2 -- DANGER! The at.h that comes with netatalk
141 * has a *different* definition of struct sockaddr_at than the Linux kernel
142 * does. This is an "insidious and invidious" bug...
143 * (Actually the preceding comment is false -- it's the atalk.h in the
144 * ancient atalk-0.06 that's the problem)
145 *
146 * Revision 0.8 1996/02/10 19:09:00 root
147 * Merge 1.3 changes. Tested OK under 1.3.60.
148 *
149 * Revision 0.7 1996/02/10 17:56:56 root
150 * Added debug=1 parameter on insmod for debugging prints. Tried
151 * to fix timer unload on rmmod, but I don't think that's the problem.
152 *
153 * Revision 0.6 1995/12/31 19:01:09 root
154 * Clean up rmmod, irq comments per feedback from Corin Anderson (Thanks Corey!)
155 * Clean up initial probing -- sometimes the card wakes up latched in reset.
156 *
157 * Revision 0.5 1995/12/22 06:03:44 root
158 * Added comments in front and cleaned up a bit.
159 * This version sent out to people.
160 *
161 * Revision 0.4 1995/12/18 03:46:44 root
162 * Return shortDDP to longDDP fake to 0/0. Added command structs.
163 *
164 ***/
165
166/* ltpc jumpers are:
167*
168* Interrupts -- set at most one. If none are set, the driver uses
169* polled mode. Because the card was developed in the XT era, the
170* original documentation refers to IRQ2. Since you'll be running
171* this on an AT (or later) class machine, that really means IRQ9.
172*
173* SW1 IRQ 4
174* SW2 IRQ 3
175* SW3 IRQ 9 (2 in original card documentation only applies to XT)
176*
177*
178* DMA -- choose DMA 1 or 3, and set both corresponding switches.
179*
180* SW4 DMA 3
181* SW5 DMA 1
182* SW6 DMA 3
183* SW7 DMA 1
184*
185*
186* I/O address -- choose one.
187*
188* SW8 220 / 240
189*/
190
191/* To have some stuff logged, do
192* insmod ltpc.o debug=1
193*
194* For a whole bunch of stuff, use higher numbers.
195*
196* The default is 0, i.e. no messages except for the probe results.
197*/
198
199/* insmod-tweakable variables */
200static int debug;
201#define DEBUG_VERBOSE 1
202#define DEBUG_UPPER 2
203#define DEBUG_LOWER 4
204
205static int io;
206static int irq;
207static int dma;
208
209#include <linux/module.h>
210#include <linux/kernel.h>
211#include <linux/types.h>
212#include <linux/fcntl.h>
213#include <linux/interrupt.h>
214#include <linux/ptrace.h>
215#include <linux/ioport.h>
216#include <linux/spinlock.h>
217#include <linux/in.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218#include <linux/string.h>
219#include <linux/errno.h>
220#include <linux/init.h>
221#include <linux/netdevice.h>
222#include <linux/etherdevice.h>
223#include <linux/skbuff.h>
224#include <linux/if_arp.h>
225#include <linux/if_ltalk.h>
226#include <linux/delay.h>
227#include <linux/timer.h>
228#include <linux/atalk.h>
229#include <linux/bitops.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +0900230#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232#include <asm/dma.h>
233#include <asm/io.h>
234
235/* our stuff */
236#include "ltpc.h"
237
238static DEFINE_SPINLOCK(txqueue_lock);
239static DEFINE_SPINLOCK(mbox_lock);
240
241/* function prototypes */
242static int do_read(struct net_device *dev, void *cbuf, int cbuflen,
243 void *dbuf, int dbuflen);
244static int sendup_buffer (struct net_device *dev);
245
246/* Dma Memory related stuff, cribbed directly from 3c505.c */
247
248static unsigned long dma_mem_alloc(int size)
249{
250 int order = get_order(size);
251
252 return __get_dma_pages(GFP_KERNEL, order);
253}
254
255/* DMA data buffer, DMA command buffer */
256static unsigned char *ltdmabuf;
257static unsigned char *ltdmacbuf;
258
259/* private struct, holds our appletalk address */
260
261struct ltpc_private
262{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 struct atalk_addr my_addr;
264};
265
266/* transmit queue element struct */
267
268struct xmitQel {
269 struct xmitQel *next;
270 /* command buffer */
271 unsigned char *cbuf;
272 short cbuflen;
273 /* data buffer */
274 unsigned char *dbuf;
275 short dbuflen;
276 unsigned char QWrite; /* read or write data */
277 unsigned char mailbox;
278};
279
280/* the transmit queue itself */
281
282static struct xmitQel *xmQhd, *xmQtl;
283
284static void enQ(struct xmitQel *qel)
285{
286 unsigned long flags;
287 qel->next = NULL;
288
289 spin_lock_irqsave(&txqueue_lock, flags);
290 if (xmQtl) {
291 xmQtl->next = qel;
292 } else {
293 xmQhd = qel;
294 }
295 xmQtl = qel;
296 spin_unlock_irqrestore(&txqueue_lock, flags);
297
298 if (debug & DEBUG_LOWER)
299 printk("enqueued a 0x%02x command\n",qel->cbuf[0]);
300}
301
302static struct xmitQel *deQ(void)
303{
304 unsigned long flags;
305 int i;
306 struct xmitQel *qel=NULL;
307
308 spin_lock_irqsave(&txqueue_lock, flags);
309 if (xmQhd) {
310 qel = xmQhd;
311 xmQhd = qel->next;
312 if(!xmQhd) xmQtl = NULL;
313 }
314 spin_unlock_irqrestore(&txqueue_lock, flags);
315
316 if ((debug & DEBUG_LOWER) && qel) {
317 int n;
318 printk(KERN_DEBUG "ltpc: dequeued command ");
319 n = qel->cbuflen;
320 if (n>100) n=100;
321 for(i=0;i<n;i++) printk("%02x ",qel->cbuf[i]);
322 printk("\n");
323 }
324
325 return qel;
326}
327
328/* and... the queue elements we'll be using */
329static struct xmitQel qels[16];
330
331/* and their corresponding mailboxes */
332static unsigned char mailbox[16];
333static unsigned char mboxinuse[16] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
334
335static int wait_timeout(struct net_device *dev, int c)
336{
337 /* returns true if it stayed c */
338 /* this uses base+6, but it's ok */
339 int i;
340
341 /* twenty second or so total */
342
343 for(i=0;i<200000;i++) {
344 if ( c != inb_p(dev->base_addr+6) ) return 0;
345 udelay(100);
346 }
347 return 1; /* timed out */
348}
349
350/* get the first free mailbox */
351
352static int getmbox(void)
353{
354 unsigned long flags;
355 int i;
356
357 spin_lock_irqsave(&mbox_lock, flags);
358 for(i=1;i<16;i++) if(!mboxinuse[i]) {
359 mboxinuse[i]=1;
360 spin_unlock_irqrestore(&mbox_lock, flags);
361 return i;
362 }
363 spin_unlock_irqrestore(&mbox_lock, flags);
364 return 0;
365}
366
367/* read a command from the card */
368static void handlefc(struct net_device *dev)
369{
370 /* called *only* from idle, non-reentrant */
371 int dma = dev->dma;
372 int base = dev->base_addr;
373 unsigned long flags;
374
375
376 flags=claim_dma_lock();
377 disable_dma(dma);
378 clear_dma_ff(dma);
379 set_dma_mode(dma,DMA_MODE_READ);
380 set_dma_addr(dma,virt_to_bus(ltdmacbuf));
381 set_dma_count(dma,50);
382 enable_dma(dma);
383 release_dma_lock(flags);
384
385 inb_p(base+3);
386 inb_p(base+2);
387
388 if ( wait_timeout(dev,0xfc) ) printk("timed out in handlefc\n");
389}
390
391/* read data from the card */
392static void handlefd(struct net_device *dev)
393{
394 int dma = dev->dma;
395 int base = dev->base_addr;
396 unsigned long flags;
397
398 flags=claim_dma_lock();
399 disable_dma(dma);
400 clear_dma_ff(dma);
401 set_dma_mode(dma,DMA_MODE_READ);
402 set_dma_addr(dma,virt_to_bus(ltdmabuf));
403 set_dma_count(dma,800);
404 enable_dma(dma);
405 release_dma_lock(flags);
406
407 inb_p(base+3);
408 inb_p(base+2);
409
410 if ( wait_timeout(dev,0xfd) ) printk("timed out in handlefd\n");
411 sendup_buffer(dev);
412}
413
414static void handlewrite(struct net_device *dev)
415{
416 /* called *only* from idle, non-reentrant */
417 /* on entry, 0xfb and ltdmabuf holds data */
418 int dma = dev->dma;
419 int base = dev->base_addr;
420 unsigned long flags;
421
422 flags=claim_dma_lock();
423 disable_dma(dma);
424 clear_dma_ff(dma);
425 set_dma_mode(dma,DMA_MODE_WRITE);
426 set_dma_addr(dma,virt_to_bus(ltdmabuf));
427 set_dma_count(dma,800);
428 enable_dma(dma);
429 release_dma_lock(flags);
430
431 inb_p(base+3);
432 inb_p(base+2);
433
434 if ( wait_timeout(dev,0xfb) ) {
435 flags=claim_dma_lock();
436 printk("timed out in handlewrite, dma res %d\n",
437 get_dma_residue(dev->dma) );
438 release_dma_lock(flags);
439 }
440}
441
442static void handleread(struct net_device *dev)
443{
444 /* on entry, 0xfb */
445 /* on exit, ltdmabuf holds data */
446 int dma = dev->dma;
447 int base = dev->base_addr;
448 unsigned long flags;
449
450
451 flags=claim_dma_lock();
452 disable_dma(dma);
453 clear_dma_ff(dma);
454 set_dma_mode(dma,DMA_MODE_READ);
455 set_dma_addr(dma,virt_to_bus(ltdmabuf));
456 set_dma_count(dma,800);
457 enable_dma(dma);
458 release_dma_lock(flags);
459
460 inb_p(base+3);
461 inb_p(base+2);
462 if ( wait_timeout(dev,0xfb) ) printk("timed out in handleread\n");
463}
464
465static void handlecommand(struct net_device *dev)
466{
467 /* on entry, 0xfa and ltdmacbuf holds command */
468 int dma = dev->dma;
469 int base = dev->base_addr;
470 unsigned long flags;
471
472 flags=claim_dma_lock();
473 disable_dma(dma);
474 clear_dma_ff(dma);
475 set_dma_mode(dma,DMA_MODE_WRITE);
476 set_dma_addr(dma,virt_to_bus(ltdmacbuf));
477 set_dma_count(dma,50);
478 enable_dma(dma);
479 release_dma_lock(flags);
480 inb_p(base+3);
481 inb_p(base+2);
482 if ( wait_timeout(dev,0xfa) ) printk("timed out in handlecommand\n");
483}
484
485/* ready made command for getting the result from the card */
486static unsigned char rescbuf[2] = {LT_GETRESULT,0};
487static unsigned char resdbuf[2];
488
489static int QInIdle;
490
491/* idle expects to be called with the IRQ line high -- either because of
492 * an interrupt, or because the line is tri-stated
493 */
494
495static void idle(struct net_device *dev)
496{
497 unsigned long flags;
498 int state;
499 /* FIXME This is initialized to shut the warning up, but I need to
500 * think this through again.
501 */
502 struct xmitQel *q = NULL;
503 int oops;
504 int i;
505 int base = dev->base_addr;
506
507 spin_lock_irqsave(&txqueue_lock, flags);
508 if(QInIdle) {
509 spin_unlock_irqrestore(&txqueue_lock, flags);
510 return;
511 }
512 QInIdle = 1;
513 spin_unlock_irqrestore(&txqueue_lock, flags);
514
515 /* this tri-states the IRQ line */
516 (void) inb_p(base+6);
517
518 oops = 100;
519
520loop:
521 if (0>oops--) {
522 printk("idle: looped too many times\n");
523 goto done;
524 }
525
526 state = inb_p(base+6);
527 if (state != inb_p(base+6)) goto loop;
528
529 switch(state) {
530 case 0xfc:
531 /* incoming command */
532 if (debug & DEBUG_LOWER) printk("idle: fc\n");
533 handlefc(dev);
534 break;
535 case 0xfd:
536 /* incoming data */
537 if(debug & DEBUG_LOWER) printk("idle: fd\n");
538 handlefd(dev);
539 break;
540 case 0xf9:
541 /* result ready */
542 if (debug & DEBUG_LOWER) printk("idle: f9\n");
543 if(!mboxinuse[0]) {
544 mboxinuse[0] = 1;
545 qels[0].cbuf = rescbuf;
546 qels[0].cbuflen = 2;
547 qels[0].dbuf = resdbuf;
548 qels[0].dbuflen = 2;
549 qels[0].QWrite = 0;
550 qels[0].mailbox = 0;
551 enQ(&qels[0]);
552 }
553 inb_p(dev->base_addr+1);
554 inb_p(dev->base_addr+0);
555 if( wait_timeout(dev,0xf9) )
556 printk("timed out idle f9\n");
557 break;
558 case 0xf8:
559 /* ?? */
560 if (xmQhd) {
561 inb_p(dev->base_addr+1);
562 inb_p(dev->base_addr+0);
563 if(wait_timeout(dev,0xf8) )
564 printk("timed out idle f8\n");
565 } else {
566 goto done;
567 }
568 break;
569 case 0xfa:
570 /* waiting for command */
571 if(debug & DEBUG_LOWER) printk("idle: fa\n");
572 if (xmQhd) {
573 q=deQ();
574 memcpy(ltdmacbuf,q->cbuf,q->cbuflen);
575 ltdmacbuf[1] = q->mailbox;
576 if (debug>1) {
577 int n;
578 printk("ltpc: sent command ");
579 n = q->cbuflen;
580 if (n>100) n=100;
581 for(i=0;i<n;i++)
582 printk("%02x ",ltdmacbuf[i]);
583 printk("\n");
584 }
585 handlecommand(dev);
586 if(0xfa==inb_p(base+6)) {
587 /* we timed out, so return */
588 goto done;
589 }
590 } else {
591 /* we don't seem to have a command */
592 if (!mboxinuse[0]) {
593 mboxinuse[0] = 1;
594 qels[0].cbuf = rescbuf;
595 qels[0].cbuflen = 2;
596 qels[0].dbuf = resdbuf;
597 qels[0].dbuflen = 2;
598 qels[0].QWrite = 0;
599 qels[0].mailbox = 0;
600 enQ(&qels[0]);
601 } else {
602 printk("trouble: response command already queued\n");
603 goto done;
604 }
605 }
606 break;
607 case 0Xfb:
608 /* data transfer ready */
609 if(debug & DEBUG_LOWER) printk("idle: fb\n");
610 if(q->QWrite) {
611 memcpy(ltdmabuf,q->dbuf,q->dbuflen);
612 handlewrite(dev);
613 } else {
614 handleread(dev);
615 /* non-zero mailbox numbers are for
616 commmands, 0 is for GETRESULT
617 requests */
618 if(q->mailbox) {
619 memcpy(q->dbuf,ltdmabuf,q->dbuflen);
620 } else {
621 /* this was a result */
622 mailbox[ 0x0f & ltdmabuf[0] ] = ltdmabuf[1];
623 mboxinuse[0]=0;
624 }
625 }
626 break;
627 }
628 goto loop;
629
630done:
631 QInIdle=0;
632
633 /* now set the interrupts back as appropriate */
634 /* the first read takes it out of tri-state (but still high) */
635 /* the second resets it */
636 /* note that after this point, any read of base+6 will
637 trigger an interrupt */
638
639 if (dev->irq) {
640 inb_p(base+7);
641 inb_p(base+7);
642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643}
644
645
646static int do_write(struct net_device *dev, void *cbuf, int cbuflen,
647 void *dbuf, int dbuflen)
648{
649
650 int i = getmbox();
651 int ret;
652
653 if(i) {
Joe Perches43d620c2011-06-16 19:08:06 +0000654 qels[i].cbuf = cbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 qels[i].cbuflen = cbuflen;
Joe Perches43d620c2011-06-16 19:08:06 +0000656 qels[i].dbuf = dbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 qels[i].dbuflen = dbuflen;
658 qels[i].QWrite = 1;
659 qels[i].mailbox = i; /* this should be initted rather */
660 enQ(&qels[i]);
661 idle(dev);
662 ret = mailbox[i];
663 mboxinuse[i]=0;
664 return ret;
665 }
666 printk("ltpc: could not allocate mbox\n");
667 return -1;
668}
669
670static int do_read(struct net_device *dev, void *cbuf, int cbuflen,
671 void *dbuf, int dbuflen)
672{
673
674 int i = getmbox();
675 int ret;
676
677 if(i) {
Joe Perches43d620c2011-06-16 19:08:06 +0000678 qels[i].cbuf = cbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 qels[i].cbuflen = cbuflen;
Joe Perches43d620c2011-06-16 19:08:06 +0000680 qels[i].dbuf = dbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 qels[i].dbuflen = dbuflen;
682 qels[i].QWrite = 0;
683 qels[i].mailbox = i; /* this should be initted rather */
684 enQ(&qels[i]);
685 idle(dev);
686 ret = mailbox[i];
687 mboxinuse[i]=0;
688 return ret;
689 }
690 printk("ltpc: could not allocate mbox\n");
691 return -1;
692}
693
694/* end of idle handlers -- what should be seen is do_read, do_write */
695
696static struct timer_list ltpc_timer;
697
Stephen Hemminger0fc48092009-08-31 19:50:56 +0000698static netdev_tx_t ltpc_xmit(struct sk_buff *skb, struct net_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
700static int read_30 ( struct net_device *dev)
701{
702 lt_command c;
703 c.getflags.command = LT_GETFLAGS;
704 return do_read(dev, &c, sizeof(c.getflags),&c,0);
705}
706
707static int set_30 (struct net_device *dev,int x)
708{
709 lt_command c;
710 c.setflags.command = LT_SETFLAGS;
711 c.setflags.flags = x;
712 return do_write(dev, &c, sizeof(c.setflags),&c,0);
713}
714
715/* LLAP to DDP translation */
716
717static int sendup_buffer (struct net_device *dev)
718{
719 /* on entry, command is in ltdmacbuf, data in ltdmabuf */
720 /* called from idle, non-reentrant */
721
722 int dnode, snode, llaptype, len;
723 int sklen;
724 struct sk_buff *skb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 struct lt_rcvlap *ltc = (struct lt_rcvlap *) ltdmacbuf;
726
727 if (ltc->command != LT_RCVLAP) {
728 printk("unknown command 0x%02x from ltpc card\n",ltc->command);
Eric Dumazet807540b2010-09-23 05:40:09 +0000729 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 }
731 dnode = ltc->dnode;
732 snode = ltc->snode;
733 llaptype = ltc->laptype;
734 len = ltc->length;
735
736 sklen = len;
737 if (llaptype == 1)
738 sklen += 8; /* correct for short ddp */
739 if(sklen > 800) {
740 printk(KERN_INFO "%s: nonsense length in ltpc command 0x14: 0x%08x\n",
741 dev->name,sklen);
742 return -1;
743 }
744
745 if ( (llaptype==0) || (llaptype>2) ) {
746 printk(KERN_INFO "%s: unknown LLAP type: %d\n",dev->name,llaptype);
747 return -1;
748 }
749
750
751 skb = dev_alloc_skb(3+sklen);
752 if (skb == NULL)
753 {
754 printk("%s: dropping packet due to memory squeeze.\n",
755 dev->name);
756 return -1;
757 }
758 skb->dev = dev;
759
760 if (sklen > len)
761 skb_reserve(skb,8);
762 skb_put(skb,len+3);
763 skb->protocol = htons(ETH_P_LOCALTALK);
764 /* add LLAP header */
765 skb->data[0] = dnode;
766 skb->data[1] = snode;
767 skb->data[2] = llaptype;
Arnaldo Carvalho de Melo459a98e2007-03-19 15:30:44 -0700768 skb_reset_mac_header(skb); /* save pointer to llap header */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 skb_pull(skb,3);
770
771 /* copy ddp(s,e)hdr + contents */
Arnaldo Carvalho de Melo27d7ff42007-03-31 11:55:19 -0300772 skb_copy_to_linear_data(skb, ltdmabuf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Arnaldo Carvalho de Melobadff6d2007-03-13 13:06:52 -0300774 skb_reset_transport_header(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
Stephen Hemminger4fafc122009-03-26 15:11:20 +0000776 dev->stats.rx_packets++;
777 dev->stats.rx_bytes += skb->len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
779 /* toss it onwards */
780 netif_rx(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 return 0;
782}
783
784/* the handler for the board interrupt */
785
786static irqreturn_t
David Howells7d12e782006-10-05 14:55:46 +0100787ltpc_interrupt(int irq, void *dev_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788{
789 struct net_device *dev = dev_id;
790
791 if (dev==NULL) {
792 printk("ltpc_interrupt: unknown device.\n");
793 return IRQ_NONE;
794 }
795
796 inb_p(dev->base_addr+6); /* disable further interrupts from board */
797
798 idle(dev); /* handle whatever is coming in */
799
800 /* idle re-enables interrupts from board */
801
802 return IRQ_HANDLED;
803}
804
805/***
806 *
807 * The ioctls that the driver responds to are:
808 *
809 * SIOCSIFADDR -- do probe using the passed node hint.
810 * SIOCGIFADDR -- return net, node.
811 *
812 * some of this stuff should be done elsewhere.
813 *
814 ***/
815
816static int ltpc_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
817{
818 struct sockaddr_at *sa = (struct sockaddr_at *) &ifr->ifr_addr;
819 /* we'll keep the localtalk node address in dev->pa_addr */
Wang Chen454d7c92008-11-12 23:37:49 -0800820 struct ltpc_private *ltpc_priv = netdev_priv(dev);
821 struct atalk_addr *aa = &ltpc_priv->my_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 struct lt_init c;
823 int ltflags;
824
825 if(debug & DEBUG_VERBOSE) printk("ltpc_ioctl called\n");
826
827 switch(cmd) {
828 case SIOCSIFADDR:
829
830 aa->s_net = sa->sat_addr.s_net;
831
832 /* this does the probe and returns the node addr */
833 c.command = LT_INIT;
834 c.hint = sa->sat_addr.s_node;
835
836 aa->s_node = do_read(dev,&c,sizeof(c),&c,0);
837
838 /* get all llap frames raw */
839 ltflags = read_30(dev);
840 ltflags |= LT_FLAG_ALLLAP;
841 set_30 (dev,ltflags);
842
843 dev->broadcast[0] = 0xFF;
844 dev->dev_addr[0] = aa->s_node;
845
846 dev->addr_len=1;
847
848 return 0;
849
850 case SIOCGIFADDR:
851
852 sa->sat_addr.s_net = aa->s_net;
853 sa->sat_addr.s_node = aa->s_node;
854
855 return 0;
856
857 default:
858 return -EINVAL;
859 }
860}
861
862static void set_multicast_list(struct net_device *dev)
863{
864 /* This needs to be present to keep netatalk happy. */
865 /* Actually netatalk needs fixing! */
866}
867
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868static int ltpc_poll_counter;
869
870static void ltpc_poll(unsigned long l)
871{
872 struct net_device *dev = (struct net_device *) l;
873
874 del_timer(&ltpc_timer);
875
876 if(debug & DEBUG_VERBOSE) {
877 if (!ltpc_poll_counter) {
878 ltpc_poll_counter = 50;
879 printk("ltpc poll is alive\n");
880 }
881 ltpc_poll_counter--;
882 }
883
884 if (!dev)
885 return; /* we've been downed */
886
887 /* poll 20 times per second */
888 idle(dev);
889 ltpc_timer.expires = jiffies + HZ/20;
890
891 add_timer(&ltpc_timer);
892}
893
894/* DDP to LLAP translation */
895
Stephen Hemminger0fc48092009-08-31 19:50:56 +0000896static netdev_tx_t ltpc_xmit(struct sk_buff *skb, struct net_device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897{
898 /* in kernel 1.3.xx, on entry skb->data points to ddp header,
899 * and skb->len is the length of the ddp data + ddp header
900 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 int i;
902 struct lt_sendlap cbuf;
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -0700903 unsigned char *hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
905 cbuf.command = LT_SENDLAP;
906 cbuf.dnode = skb->data[0];
907 cbuf.laptype = skb->data[2];
908 skb_pull(skb,3); /* skip past LLAP header */
909 cbuf.length = skb->len; /* this is host order */
Arnaldo Carvalho de Melobadff6d2007-03-13 13:06:52 -0300910 skb_reset_transport_header(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
912 if(debug & DEBUG_UPPER) {
913 printk("command ");
914 for(i=0;i<6;i++)
915 printk("%02x ",((unsigned char *)&cbuf)[i]);
916 printk("\n");
917 }
918
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -0700919 hdr = skb_transport_header(skb);
920 do_write(dev, &cbuf, sizeof(cbuf), hdr, skb->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
922 if(debug & DEBUG_UPPER) {
923 printk("sent %d ddp bytes\n",skb->len);
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -0700924 for (i = 0; i < skb->len; i++)
925 printk("%02x ", hdr[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 printk("\n");
927 }
928
Stephen Hemminger4fafc122009-03-26 15:11:20 +0000929 dev->stats.tx_packets++;
930 dev->stats.tx_bytes += skb->len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
932 dev_kfree_skb(skb);
Patrick McHardy6ed10652009-06-23 06:03:08 +0000933 return NETDEV_TX_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934}
935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936/* initialization stuff */
937
938static int __init ltpc_probe_dma(int base, int dma)
939{
940 int want = (dma == 3) ? 2 : (dma == 1) ? 1 : 3;
941 unsigned long timeout;
942 unsigned long f;
943
944 if (want & 1) {
945 if (request_dma(1,"ltpc")) {
946 want &= ~1;
947 } else {
948 f=claim_dma_lock();
949 disable_dma(1);
950 clear_dma_ff(1);
951 set_dma_mode(1,DMA_MODE_WRITE);
952 set_dma_addr(1,virt_to_bus(ltdmabuf));
953 set_dma_count(1,sizeof(struct lt_mem));
954 enable_dma(1);
955 release_dma_lock(f);
956 }
957 }
958 if (want & 2) {
959 if (request_dma(3,"ltpc")) {
960 want &= ~2;
961 } else {
962 f=claim_dma_lock();
963 disable_dma(3);
964 clear_dma_ff(3);
965 set_dma_mode(3,DMA_MODE_WRITE);
966 set_dma_addr(3,virt_to_bus(ltdmabuf));
967 set_dma_count(3,sizeof(struct lt_mem));
968 enable_dma(3);
969 release_dma_lock(f);
970 }
971 }
972 /* set up request */
973
974 /* FIXME -- do timings better! */
975
976 ltdmabuf[0] = LT_READMEM;
977 ltdmabuf[1] = 1; /* mailbox */
978 ltdmabuf[2] = 0; ltdmabuf[3] = 0; /* address */
979 ltdmabuf[4] = 0; ltdmabuf[5] = 1; /* read 0x0100 bytes */
980 ltdmabuf[6] = 0; /* dunno if this is necessary */
981
982 inb_p(io+1);
983 inb_p(io+0);
984 timeout = jiffies+100*HZ/100;
985 while(time_before(jiffies, timeout)) {
986 if ( 0xfa == inb_p(io+6) ) break;
987 }
988
989 inb_p(io+3);
990 inb_p(io+2);
991 while(time_before(jiffies, timeout)) {
992 if ( 0xfb == inb_p(io+6) ) break;
993 }
994
995 /* release the other dma channel (if we opened both of them) */
996
997 if ((want & 2) && (get_dma_residue(3)==sizeof(struct lt_mem))) {
998 want &= ~2;
999 free_dma(3);
1000 }
1001
1002 if ((want & 1) && (get_dma_residue(1)==sizeof(struct lt_mem))) {
1003 want &= ~1;
1004 free_dma(1);
1005 }
1006
1007 if (!want)
1008 return 0;
1009
1010 return (want & 2) ? 3 : 1;
1011}
1012
Stephen Hemminger816b26f2009-03-26 15:11:21 +00001013static const struct net_device_ops ltpc_netdev = {
1014 .ndo_start_xmit = ltpc_xmit,
1015 .ndo_do_ioctl = ltpc_ioctl,
Jiri Pirkoafc4b132011-08-16 06:29:01 +00001016 .ndo_set_rx_mode = set_multicast_list,
Stephen Hemminger816b26f2009-03-26 15:11:21 +00001017};
1018
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019struct net_device * __init ltpc_probe(void)
1020{
1021 struct net_device *dev;
1022 int err = -ENOMEM;
1023 int x=0,y=0;
1024 int autoirq;
1025 unsigned long f;
1026 unsigned long timeout;
1027
Christoph Hellwig3ef4e9a2005-05-05 14:25:59 -07001028 dev = alloc_ltalkdev(sizeof(struct ltpc_private));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 if (!dev)
1030 goto out;
1031
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 /* probe for the I/O port address */
1033
1034 if (io != 0x240 && request_region(0x220,8,"ltpc")) {
1035 x = inb_p(0x220+6);
1036 if ( (x!=0xff) && (x>=0xf0) ) {
1037 io = 0x220;
1038 goto got_port;
1039 }
1040 release_region(0x220,8);
1041 }
1042 if (io != 0x220 && request_region(0x240,8,"ltpc")) {
1043 y = inb_p(0x240+6);
1044 if ( (y!=0xff) && (y>=0xf0) ){
1045 io = 0x240;
1046 goto got_port;
1047 }
1048 release_region(0x240,8);
1049 }
1050
1051 /* give up in despair */
1052 printk(KERN_ERR "LocalTalk card not found; 220 = %02x, 240 = %02x.\n", x,y);
1053 err = -ENODEV;
1054 goto out1;
1055
1056 got_port:
1057 /* probe for the IRQ line */
1058 if (irq < 2) {
1059 unsigned long irq_mask;
1060
1061 irq_mask = probe_irq_on();
1062 /* reset the interrupt line */
1063 inb_p(io+7);
1064 inb_p(io+7);
1065 /* trigger an interrupt (I hope) */
1066 inb_p(io+6);
1067 mdelay(2);
1068 autoirq = probe_irq_off(irq_mask);
1069
1070 if (autoirq == 0) {
1071 printk(KERN_ERR "ltpc: probe at %#x failed to detect IRQ line.\n", io);
1072 } else {
1073 irq = autoirq;
1074 }
1075 }
1076
1077 /* allocate a DMA buffer */
1078 ltdmabuf = (unsigned char *) dma_mem_alloc(1000);
1079 if (!ltdmabuf) {
1080 printk(KERN_ERR "ltpc: mem alloc failed\n");
1081 err = -ENOMEM;
1082 goto out2;
1083 }
1084
1085 ltdmacbuf = &ltdmabuf[800];
1086
1087 if(debug & DEBUG_VERBOSE) {
1088 printk("ltdmabuf pointer %08lx\n",(unsigned long) ltdmabuf);
1089 }
1090
1091 /* reset the card */
1092
1093 inb_p(io+1);
1094 inb_p(io+3);
1095
Nishanth Aravamudan2c4ee8f2005-06-22 22:19:52 -07001096 msleep(20);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
1098 inb_p(io+0);
1099 inb_p(io+2);
1100 inb_p(io+7); /* clear reset */
1101 inb_p(io+4);
1102 inb_p(io+5);
1103 inb_p(io+5); /* enable dma */
1104 inb_p(io+6); /* tri-state interrupt line */
1105
Nishanth Aravamudan2c4ee8f2005-06-22 22:19:52 -07001106 ssleep(1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107
1108 /* now, figure out which dma channel we're using, unless it's
1109 already been specified */
1110 /* well, 0 is a legal DMA channel, but the LTPC card doesn't
1111 use it... */
1112 dma = ltpc_probe_dma(io, dma);
1113 if (!dma) { /* no dma channel */
1114 printk(KERN_ERR "No DMA channel found on ltpc card.\n");
1115 err = -ENODEV;
1116 goto out3;
1117 }
1118
1119 /* print out friendly message */
1120 if(irq)
1121 printk(KERN_INFO "Apple/Farallon LocalTalk-PC card at %03x, IR%d, DMA%d.\n",io,irq,dma);
1122 else
1123 printk(KERN_INFO "Apple/Farallon LocalTalk-PC card at %03x, DMA%d. Using polled mode.\n",io,dma);
1124
Stephen Hemminger816b26f2009-03-26 15:11:21 +00001125 dev->netdev_ops = &ltpc_netdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 dev->base_addr = io;
1127 dev->irq = irq;
1128 dev->dma = dma;
1129
1130 /* the card will want to send a result at this point */
1131 /* (I think... leaving out this part makes the kernel crash,
1132 so I put it back in...) */
1133
1134 f=claim_dma_lock();
1135 disable_dma(dma);
1136 clear_dma_ff(dma);
1137 set_dma_mode(dma,DMA_MODE_READ);
1138 set_dma_addr(dma,virt_to_bus(ltdmabuf));
1139 set_dma_count(dma,0x100);
1140 enable_dma(dma);
1141 release_dma_lock(f);
1142
1143 (void) inb_p(io+3);
1144 (void) inb_p(io+2);
1145 timeout = jiffies+100*HZ/100;
1146
1147 while(time_before(jiffies, timeout)) {
1148 if( 0xf9 == inb_p(io+6))
1149 break;
1150 schedule();
1151 }
1152
1153 if(debug & DEBUG_VERBOSE) {
1154 printk("setting up timer and irq\n");
1155 }
1156
1157 /* grab it and don't let go :-) */
Joe Perchesa0607fd2009-11-18 23:29:17 -08001158 if (irq && request_irq( irq, ltpc_interrupt, 0, "ltpc", dev) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 {
1160 (void) inb_p(io+7); /* enable interrupts from board */
1161 (void) inb_p(io+7); /* and reset irq line */
1162 } else {
1163 if( irq )
1164 printk(KERN_ERR "ltpc: IRQ already in use, using polled mode.\n");
1165 dev->irq = 0;
1166 /* polled mode -- 20 times per second */
1167 /* this is really, really slow... should it poll more often? */
1168 init_timer(&ltpc_timer);
1169 ltpc_timer.function=ltpc_poll;
1170 ltpc_timer.data = (unsigned long) dev;
1171
1172 ltpc_timer.expires = jiffies + HZ/20;
1173 add_timer(&ltpc_timer);
1174 }
1175 err = register_netdev(dev);
1176 if (err)
1177 goto out4;
1178
1179 return NULL;
1180out4:
1181 del_timer_sync(&ltpc_timer);
1182 if (dev->irq)
1183 free_irq(dev->irq, dev);
1184out3:
1185 free_pages((unsigned long)ltdmabuf, get_order(1000));
1186out2:
1187 release_region(io, 8);
1188out1:
1189 free_netdev(dev);
1190out:
1191 return ERR_PTR(err);
1192}
1193
1194#ifndef MODULE
1195/* handles "ltpc=io,irq,dma" kernel command lines */
1196static int __init ltpc_setup(char *str)
1197{
1198 int ints[5];
1199
1200 str = get_options(str, ARRAY_SIZE(ints), ints);
1201
1202 if (ints[0] == 0) {
1203 if (str && !strncmp(str, "auto", 4)) {
1204 /* do nothing :-) */
1205 }
1206 else {
1207 /* usage message */
1208 printk (KERN_ERR
1209 "ltpc: usage: ltpc=auto|iobase[,irq[,dma]]\n");
1210 return 0;
1211 }
1212 } else {
1213 io = ints[1];
1214 if (ints[0] > 1) {
1215 irq = ints[2];
1216 }
1217 if (ints[0] > 2) {
1218 dma = ints[3];
1219 }
Martin Olsson98a17082009-04-22 18:21:29 +02001220 /* ignore any other parameters */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 }
1222 return 1;
1223}
1224
1225__setup("ltpc=", ltpc_setup);
1226#endif /* MODULE */
1227
1228static struct net_device *dev_ltpc;
1229
1230#ifdef MODULE
1231
1232MODULE_LICENSE("GPL");
1233module_param(debug, int, 0);
1234module_param(io, int, 0);
1235module_param(irq, int, 0);
1236module_param(dma, int, 0);
1237
1238
Jon Schindler32c98742008-03-05 18:49:21 -08001239static int __init ltpc_module_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240{
1241 if(io == 0)
1242 printk(KERN_NOTICE
1243 "ltpc: Autoprobing is not recommended for modules\n");
1244
1245 dev_ltpc = ltpc_probe();
Rusty Russell8c6ffba2013-07-15 11:20:32 +09301246 return PTR_ERR_OR_ZERO(dev_ltpc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247}
Jon Schindler32c98742008-03-05 18:49:21 -08001248module_init(ltpc_module_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249#endif
1250
1251static void __exit ltpc_cleanup(void)
1252{
1253
1254 if(debug & DEBUG_VERBOSE) printk("unregister_netdev\n");
1255 unregister_netdev(dev_ltpc);
1256
1257 ltpc_timer.data = 0; /* signal the poll routine that we're done */
1258
1259 del_timer_sync(&ltpc_timer);
1260
1261 if(debug & DEBUG_VERBOSE) printk("freeing irq\n");
1262
1263 if (dev_ltpc->irq)
1264 free_irq(dev_ltpc->irq, dev_ltpc);
1265
1266 if(debug & DEBUG_VERBOSE) printk("freeing dma\n");
1267
1268 if (dev_ltpc->dma)
1269 free_dma(dev_ltpc->dma);
1270
1271 if(debug & DEBUG_VERBOSE) printk("freeing ioaddr\n");
1272
1273 if (dev_ltpc->base_addr)
1274 release_region(dev_ltpc->base_addr,8);
1275
1276 free_netdev(dev_ltpc);
1277
1278 if(debug & DEBUG_VERBOSE) printk("free_pages\n");
1279
1280 free_pages( (unsigned long) ltdmabuf, get_order(1000));
1281
1282 if(debug & DEBUG_VERBOSE) printk("returning from cleanup_module\n");
1283}
1284
1285module_exit(ltpc_cleanup);