2 * Copyright (c) 1997 Poul-Henning Kamp
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * From Id: lpt.c,v 1.55.2.1 1996/11/12 09:08:38 phk Exp
27 * $FreeBSD: src/sys/dev/ppbus/if_plip.c,v 1.19.2.1 2000/05/24 00:20:57 n_hibma Exp $
28 * $DragonFly: src/sys/dev/netif/plip/if_plip.c,v 1.19 2006/12/22 23:26:21 swildner Exp $
32 * Parallel port TCP/IP interfaces added. I looked at the driver from
33 * MACH but this is a complete rewrite, and btw. incompatible, and it
34 * should perform better too. I have never run the MACH driver though.
36 * This driver sends two bytes (0x08, 0x00) in front of each packet,
37 * to allow us to distinguish another format later.
39 * Now added an Linux/Crynwr compatibility mode which is enabled using
40 * IF_LINK0 - Tim Wilkinson.
43 * Make HDLC/PPP mode, use IF_LLC1 to enable.
45 * Connect the two computers using a Laplink parallel cable to use this
48 * +----------------------------------------+
49 * |A-name A-End B-End Descr. Port/Bit |
50 * +----------------------------------------+
51 * |DATA0 2 15 Data 0/0x01 |
52 * |-ERROR 15 2 1/0x08 |
53 * +----------------------------------------+
54 * |DATA1 3 13 Data 0/0x02 |
55 * |+SLCT 13 3 1/0x10 |
56 * +----------------------------------------+
57 * |DATA2 4 12 Data 0/0x04 |
59 * +----------------------------------------+
60 * |DATA3 5 10 Strobe 0/0x08 |
62 * +----------------------------------------+
63 * |DATA4 6 11 Data 0/0x10 |
64 * |BUSY 11 6 1/~0x80 |
65 * +----------------------------------------+
66 * |GND 18-25 18-25 GND - |
67 * +----------------------------------------+
69 * Expect transfer-rates up to 75 kbyte/sec.
71 * If GCC could correctly grok
72 * register int port asm("edx")
73 * the code would be cleaner
75 * Poul-Henning Kamp <phk@freebsd.org>
79 * Update for ppbus, PLIP support only - Nicolas Souchu
84 #include <sys/param.h>
85 #include <sys/systm.h>
86 #include <sys/module.h>
89 #include <sys/socket.h>
90 #include <sys/sockio.h>
91 #include <sys/kernel.h>
92 #include <sys/malloc.h>
94 #include <sys/thread2.h>
96 #include <machine/clock.h>
99 #include <net/ifq_var.h>
100 #include <net/if_types.h>
101 #include <net/netisr.h>
103 #include <netinet/in.h>
104 #include <netinet/in_var.h>
108 #include <bus/ppbus/ppbconf.h>
109 #include "ppbus_if.h"
110 #include <bus/ppbus/ppbio.h>
112 #ifndef LPMTU /* MTU for the lp# interfaces */
116 #ifndef LPMAXSPIN1 /* DELAY factor for the lp# interfaces */
117 #define LPMAXSPIN1 8000 /* Spinning for remote intr to happen */
120 #ifndef LPMAXSPIN2 /* DELAY factor for the lp# interfaces */
121 #define LPMAXSPIN2 500 /* Spinning for remote handshake to happen */
124 #ifndef LPMAXERRS /* Max errors before !RUNNING */
125 #define LPMAXERRS 100
128 #define CLPIPHDRLEN 14 /* We send dummy ethernet addresses (two) + packet type in front of packet */
129 #define CLPIP_SHAKE 0x80 /* This bit toggles between nibble reception */
130 #define MLPIPHDRLEN CLPIPHDRLEN
132 #define LPIPHDRLEN 2 /* We send 0x08, 0x00 in front of packet */
133 #define LPIP_SHAKE 0x40 /* This bit toggles between nibble reception */
134 #if !defined(MLPIPHDRLEN) || LPIPHDRLEN > MLPIPHDRLEN
135 #define MLPIPHDRLEN LPIPHDRLEN
138 #define LPIPTBLSIZE 256 /* Size of octet translation table */
140 #define lprintf if (lptflag) kprintf
143 static int volatile lptflag = 1;
145 static int volatile lptflag = 0;
149 unsigned short lp_unit;
155 struct resource *res_irq;
158 /* Tables for the lp# interface */
159 static u_char *txmith;
160 #define txmitl (txmith+(1*LPIPTBLSIZE))
161 #define trecvh (txmith+(2*LPIPTBLSIZE))
162 #define trecvl (txmith+(3*LPIPTBLSIZE))
164 static u_char *ctxmith;
165 #define ctxmitl (ctxmith+(1*LPIPTBLSIZE))
166 #define ctrecvh (ctxmith+(2*LPIPTBLSIZE))
167 #define ctrecvl (ctxmith+(3*LPIPTBLSIZE))
169 /* Functions for the lp# interface */
170 static int lpinittables(void);
171 static int lpioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
172 static int lpoutput(struct ifnet *, struct mbuf *, struct sockaddr *,
174 static void lp_intr(void *);
176 #define DEVTOSOFTC(dev) \
177 ((struct lp_data *)device_get_softc(dev))
178 #define UNITOSOFTC(unit) \
179 ((struct lp_data *)devclass_get_softc(lp_devclass, (unit)))
180 #define UNITODEVICE(unit) \
181 (devclass_get_device(lp_devclass, (unit)))
183 static devclass_t lp_devclass;
189 lp_probe(device_t dev)
191 device_t ppbus = device_get_parent(dev);
196 lp = DEVTOSOFTC(dev);
198 /* retrieve the ppbus irq */
199 BUS_READ_IVAR(ppbus, dev, PPBUS_IVAR_IRQ, &irq);
201 /* if we haven't interrupts, the probe fails */
203 device_printf(dev, "not an interrupt driven port, failed.\n");
207 /* reserve the interrupt resource, expecting irq is available to continue */
208 lp->res_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &zero, irq, irq, 1,
210 if (lp->res_irq == 0) {
211 device_printf(dev, "cannot reserve interrupt, failed.\n");
216 * lp dependent initialisation.
218 lp->lp_unit = device_get_unit(dev);
220 device_set_desc(dev, "PLIP network interface");
226 lp_attach (device_t dev)
228 struct lp_data *lp = DEVTOSOFTC(dev);
229 struct ifnet *ifp = &lp->sc_if;
232 if_initname(ifp, "lp", device_get_unit(dev));
234 ifp->if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST;
235 ifp->if_ioctl = lpioctl;
236 ifp->if_output = lpoutput;
237 ifp->if_type = IFT_PARA;
240 ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
241 if_attach(ifp, NULL);
243 bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
248 * Build the translation tables for the LPIP (BSD unix) protocol.
249 * We don't want to calculate these nasties in our tight loop, so we
250 * precalculate them when we initialize.
258 txmith = kmalloc(4*LPIPTBLSIZE, M_DEVBUF, M_WAITOK);
261 ctxmith = kmalloc(4*LPIPTBLSIZE, M_DEVBUF, M_WAITOK);
263 for (i=0; i < LPIPTBLSIZE; i++) {
264 ctxmith[i] = (i & 0xF0) >> 4;
265 ctxmitl[i] = 0x10 | (i & 0x0F);
266 ctrecvh[i] = (i & 0x78) << 1;
267 ctrecvl[i] = (i & 0x78) >> 3;
270 for (i=0; i < LPIPTBLSIZE; i++) {
271 txmith[i] = ((i & 0x80) >> 3) | ((i & 0x70) >> 4) | 0x08;
272 txmitl[i] = ((i & 0x08) << 1) | (i & 0x07);
273 trecvh[i] = ((~i) & 0x80) | ((i & 0x38) << 1);
274 trecvl[i] = (((~i) & 0x80) >> 4) | ((i & 0x38) >> 3);
281 * Process an ioctl request.
285 lpioctl (struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
287 device_t dev = UNITODEVICE(ifp->if_dunit);
288 device_t ppbus = device_get_parent(dev);
289 struct lp_data *sc = DEVTOSOFTC(dev);
290 struct ifaddr *ifa = (struct ifaddr *)data;
291 struct ifreq *ifr = (struct ifreq *)data;
301 if (ifa->ifa_addr->sa_family != AF_INET)
304 ifp->if_flags |= IFF_UP;
307 if ((!(ifp->if_flags & IFF_UP)) && (ifp->if_flags & IFF_RUNNING)) {
309 ppb_wctr(ppbus, 0x00);
310 ifp->if_flags &= ~IFF_RUNNING;
312 /* IFF_UP is not set, try to release the bus anyway */
313 ppb_release_bus(ppbus, dev);
316 if (((ifp->if_flags & IFF_UP)) && (!(ifp->if_flags & IFF_RUNNING))) {
319 * Should the request be interruptible?
321 if ((error = ppb_request_bus(ppbus, dev, PPB_WAIT|PPB_INTR)))
324 /* Now IFF_UP means that we own the bus */
326 ppb_set_mode(ppbus, PPB_COMPATIBLE);
328 if (lpinittables()) {
329 ppb_release_bus(ppbus, dev);
333 sc->sc_ifbuf = kmalloc(sc->sc_if.if_mtu + MLPIPHDRLEN,
336 ppb_release_bus(ppbus, dev);
340 /* attach our interrupt handler, later detached when the bus is released */
341 error = BUS_SETUP_INTR(ppbus, dev, sc->res_irq, 0,
342 lp_intr, dev, &ih, NULL);
344 ppb_release_bus(ppbus, dev);
348 ppb_wctr(ppbus, IRQENABLE);
349 ifp->if_flags |= IFF_RUNNING;
355 sc->sc_ifbuf = kmalloc(ifr->ifr_mtu+MLPIPHDRLEN, M_DEVBUF, M_WAITOK);
358 sc->sc_if.if_mtu = ifr->ifr_mtu;
362 ifr->ifr_mtu = sc->sc_if.if_mtu;
368 return EAFNOSUPPORT; /* XXX */
370 switch (ifr->ifr_addr.sa_family) {
382 * No ifmedia support at this stage; maybe use it
383 * in future for eg. protocol selection.
388 lprintf("LP:ioctl(0x%lx)\n", cmd);
395 clpoutbyte (u_char byte, int spin, device_t ppbus)
397 ppb_wdtr(ppbus, ctxmitl[byte]);
398 while (ppb_rstr(ppbus) & CLPIP_SHAKE)
402 ppb_wdtr(ppbus, ctxmith[byte]);
403 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
411 clpinbyte (int spin, device_t ppbus)
415 while((ppb_rstr(ppbus) & CLPIP_SHAKE))
419 cl = ppb_rstr(ppbus);
420 ppb_wdtr(ppbus, 0x10);
422 while(!(ppb_rstr(ppbus) & CLPIP_SHAKE))
427 ppb_wdtr(ppbus, 0x00);
429 return (ctrecvl[cl] | ctrecvh[c]);
433 lptap(struct ifnet *ifp, struct mbuf *m)
436 * We need to prepend the address family as a four byte field.
438 static const uint32_t af = AF_INET;
441 bpf_ptap(ifp->if_bpf, m, &af, sizeof(af));
447 device_t dev = (device_t)arg;
448 device_t ppbus = device_get_parent(dev);
449 struct lp_data *sc = DEVTOSOFTC(dev);
457 if (sc->sc_if.if_flags & IFF_LINK0) {
459 /* Ack. the request */
460 ppb_wdtr(ppbus, 0x01);
462 /* Get the packet length */
463 j = clpinbyte(LPMAXSPIN2, ppbus);
467 j = clpinbyte(LPMAXSPIN2, ppbus);
470 len = len + (j << 8);
471 if (len > sc->sc_if.if_mtu + MLPIPHDRLEN)
477 j = clpinbyte(LPMAXSPIN2, ppbus);
483 /* Get and ignore checksum */
484 j = clpinbyte(LPMAXSPIN2, ppbus);
489 len = bp - sc->sc_ifbuf;
490 if (len <= CLPIPHDRLEN)
496 sc->sc_if.if_ipackets++;
497 sc->sc_if.if_ibytes += len;
498 top = m_devget(sc->sc_ifbuf + CLPIPHDRLEN, len, 0, &sc->sc_if, 0);
500 if (sc->sc_if.if_bpf)
501 lptap(&sc->sc_if, top);
502 netisr_queue(NETISR_IP, top);
506 while ((ppb_rstr(ppbus) & LPIP_SHAKE)) {
507 len = sc->sc_if.if_mtu + LPIPHDRLEN;
511 cl = ppb_rstr(ppbus);
515 while((ppb_rstr(ppbus) & LPIP_SHAKE))
521 *bp++= trecvh[cl] | trecvl[c];
524 while (!((cl=ppb_rstr(ppbus)) & LPIP_SHAKE)) {
526 (((cl = ppb_rstr(ppbus)) ^ 0xb8) & 0xf8) ==
534 len = bp - sc->sc_ifbuf;
535 if (len <= LPIPHDRLEN)
541 sc->sc_if.if_ipackets++;
542 sc->sc_if.if_ibytes += len;
543 top = m_devget(sc->sc_ifbuf + LPIPHDRLEN, len, 0, &sc->sc_if, 0);
545 if (sc->sc_if.if_bpf)
546 lptap(&sc->sc_if, top);
547 netisr_queue(NETISR_IP, top);
555 sc->sc_if.if_ierrors++;
559 * We are not able to send receive anything for now,
560 * so stop wasting our time
562 if (sc->sc_iferrs > LPMAXERRS) {
563 kprintf("lp%d: Too many errors, Going off-line.\n", device_get_unit(dev));
564 ppb_wctr(ppbus, 0x00);
565 sc->sc_if.if_flags &= ~IFF_RUNNING;
575 lpoutbyte (u_char byte, int spin, device_t ppbus)
577 ppb_wdtr(ppbus, txmith[byte]);
578 while (!(ppb_rstr(ppbus) & LPIP_SHAKE))
581 ppb_wdtr(ppbus, txmitl[byte]);
582 while (ppb_rstr(ppbus) & LPIP_SHAKE)
589 lpoutput (struct ifnet *ifp, struct mbuf *m,
590 struct sockaddr *dst, struct rtentry *rt)
592 device_t dev = UNITODEVICE(ifp->if_dunit);
593 device_t ppbus = device_get_parent(dev);
601 /* We need a sensible value if we abort */
603 ifp->if_flags |= IFF_RUNNING;
605 err = 1; /* assume we're aborting because of an error */
609 /* Suspend (on laptops) or receive-errors might have taken us offline */
610 ppb_wctr(ppbus, IRQENABLE);
612 if (ifp->if_flags & IFF_LINK0) {
614 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
619 /* Alert other end to pending packet */
621 ppb_wdtr(ppbus, 0x08);
622 while ((ppb_rstr(ppbus) & 0x08) == 0)
627 /* Calculate length of packet, then send that */
629 count += 14; /* Ethernet header len */
632 for (mm = m; mm; mm = mm->m_next) {
635 if (clpoutbyte(count & 0xFF, LPMAXSPIN1, ppbus))
637 if (clpoutbyte((count >> 8) & 0xFF, LPMAXSPIN1, ppbus))
640 /* Send dummy ethernet header */
641 for (i = 0; i < 12; i++) {
642 if (clpoutbyte(i, LPMAXSPIN1, ppbus))
647 if (clpoutbyte(0x08, LPMAXSPIN1, ppbus))
649 if (clpoutbyte(0x00, LPMAXSPIN1, ppbus))
651 chksum += 0x08 + 0x00; /* Add into checksum */
655 cp = mtod(mm, u_char *);
659 if (clpoutbyte(*cp++, LPMAXSPIN2, ppbus))
662 } while ((mm = mm->m_next));
665 if (clpoutbyte(chksum, LPMAXSPIN2, ppbus))
671 err = 0; /* No errors */
674 if (err) { /* if we didn't timeout... */
679 ifp->if_obytes += m->m_pkthdr.len;
686 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
694 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
699 if (lpoutbyte(0x08, LPMAXSPIN1, ppbus))
701 if (lpoutbyte(0x00, LPMAXSPIN2, ppbus))
706 cp = mtod(mm,u_char *);
709 if (lpoutbyte(*cp++, LPMAXSPIN2, ppbus))
711 } while ((mm = mm->m_next));
713 err = 0; /* no errors were encountered */
717 ppb_wdtr(ppbus, txmitl[*cp] ^ 0x17);
719 if (err) { /* if we didn't timeout... */
724 ifp->if_obytes += m->m_pkthdr.len;
731 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
741 * Because plip is a static device that always exists under any attached
742 * ppbus device, and not scanned by the ppbus device, we need an identify
743 * function to install the device.
745 static device_method_t lp_methods[] = {
746 /* device interface */
747 DEVMETHOD(device_identify, bus_generic_identify),
748 DEVMETHOD(device_probe, lp_probe),
749 DEVMETHOD(device_attach, lp_attach),
754 static driver_t lp_driver = {
757 sizeof(struct lp_data),
760 DECLARE_DUMMY_MODULE(if_plip);
761 DRIVER_MODULE(if_plip, ppbus, lp_driver, lp_devclass, 0, 0);