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.10 2005/02/19 17:59:38 joerg 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 <machine/clock.h>
95 #include <machine/bus.h>
96 #include <machine/resource.h>
100 #include <net/ifq_var.h>
101 #include <net/if_types.h>
102 #include <net/netisr.h>
104 #include <netinet/in.h>
105 #include <netinet/in_var.h>
109 #include <bus/ppbus/ppbconf.h>
110 #include "ppbus_if.h"
111 #include <bus/ppbus/ppbio.h>
113 #ifndef LPMTU /* MTU for the lp# interfaces */
117 #ifndef LPMAXSPIN1 /* DELAY factor for the lp# interfaces */
118 #define LPMAXSPIN1 8000 /* Spinning for remote intr to happen */
121 #ifndef LPMAXSPIN2 /* DELAY factor for the lp# interfaces */
122 #define LPMAXSPIN2 500 /* Spinning for remote handshake to happen */
125 #ifndef LPMAXERRS /* Max errors before !RUNNING */
126 #define LPMAXERRS 100
129 #define CLPIPHDRLEN 14 /* We send dummy ethernet addresses (two) + packet type in front of packet */
130 #define CLPIP_SHAKE 0x80 /* This bit toggles between nibble reception */
131 #define MLPIPHDRLEN CLPIPHDRLEN
133 #define LPIPHDRLEN 2 /* We send 0x08, 0x00 in front of packet */
134 #define LPIP_SHAKE 0x40 /* This bit toggles between nibble reception */
135 #if !defined(MLPIPHDRLEN) || LPIPHDRLEN > MLPIPHDRLEN
136 #define MLPIPHDRLEN LPIPHDRLEN
139 #define LPIPTBLSIZE 256 /* Size of octet translation table */
141 #define lprintf if (lptflag) printf
144 static int volatile lptflag = 1;
146 static int volatile lptflag = 0;
150 unsigned short lp_unit;
156 struct resource *res_irq;
159 /* Tables for the lp# interface */
160 static u_char *txmith;
161 #define txmitl (txmith+(1*LPIPTBLSIZE))
162 #define trecvh (txmith+(2*LPIPTBLSIZE))
163 #define trecvl (txmith+(3*LPIPTBLSIZE))
165 static u_char *ctxmith;
166 #define ctxmitl (ctxmith+(1*LPIPTBLSIZE))
167 #define ctrecvh (ctxmith+(2*LPIPTBLSIZE))
168 #define ctrecvl (ctxmith+(3*LPIPTBLSIZE))
170 /* Functions for the lp# interface */
171 static int lpinittables(void);
172 static int lpioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
173 static int lpoutput(struct ifnet *, struct mbuf *, struct sockaddr *,
175 static void lp_intr(void *);
177 #define DEVTOSOFTC(dev) \
178 ((struct lp_data *)device_get_softc(dev))
179 #define UNITOSOFTC(unit) \
180 ((struct lp_data *)devclass_get_softc(lp_devclass, (unit)))
181 #define UNITODEVICE(unit) \
182 (devclass_get_device(lp_devclass, (unit)))
184 static devclass_t lp_devclass;
187 lp_identify(driver_t *driver, device_t parent)
190 BUS_ADD_CHILD(parent, 0, "plip", 0);
196 lp_probe(device_t dev)
198 device_t ppbus = device_get_parent(dev);
203 lp = DEVTOSOFTC(dev);
204 bzero(lp, sizeof(struct lp_data));
206 /* retrieve the ppbus irq */
207 BUS_READ_IVAR(ppbus, dev, PPBUS_IVAR_IRQ, &irq);
209 /* if we haven't interrupts, the probe fails */
211 device_printf(dev, "not an interrupt driven port, failed.\n");
215 /* reserve the interrupt resource, expecting irq is available to continue */
216 lp->res_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &zero, irq, irq, 1,
218 if (lp->res_irq == 0) {
219 device_printf(dev, "cannot reserve interrupt, failed.\n");
224 * lp dependent initialisation.
226 lp->lp_unit = device_get_unit(dev);
228 device_set_desc(dev, "PLIP network interface");
234 lp_attach (device_t dev)
236 struct lp_data *lp = DEVTOSOFTC(dev);
237 struct ifnet *ifp = &lp->sc_if;
240 if_initname(ifp, "lp", device_get_unit(dev));
242 ifp->if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST;
243 ifp->if_ioctl = lpioctl;
244 ifp->if_output = lpoutput;
245 ifp->if_type = IFT_PARA;
248 ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
251 bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
256 * Build the translation tables for the LPIP (BSD unix) protocol.
257 * We don't want to calculate these nasties in our tight loop, so we
258 * precalculate them when we initialize.
266 txmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_WAITOK);
269 ctxmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_WAITOK);
271 for (i=0; i < LPIPTBLSIZE; i++) {
272 ctxmith[i] = (i & 0xF0) >> 4;
273 ctxmitl[i] = 0x10 | (i & 0x0F);
274 ctrecvh[i] = (i & 0x78) << 1;
275 ctrecvl[i] = (i & 0x78) >> 3;
278 for (i=0; i < LPIPTBLSIZE; i++) {
279 txmith[i] = ((i & 0x80) >> 3) | ((i & 0x70) >> 4) | 0x08;
280 txmitl[i] = ((i & 0x08) << 1) | (i & 0x07);
281 trecvh[i] = ((~i) & 0x80) | ((i & 0x38) << 1);
282 trecvl[i] = (((~i) & 0x80) >> 4) | ((i & 0x38) >> 3);
289 * Process an ioctl request.
293 lpioctl (struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
295 device_t dev = UNITODEVICE(ifp->if_dunit);
296 device_t ppbus = device_get_parent(dev);
297 struct lp_data *sc = DEVTOSOFTC(dev);
298 struct ifaddr *ifa = (struct ifaddr *)data;
299 struct ifreq *ifr = (struct ifreq *)data;
309 if (ifa->ifa_addr->sa_family != AF_INET)
312 ifp->if_flags |= IFF_UP;
315 if ((!(ifp->if_flags & IFF_UP)) && (ifp->if_flags & IFF_RUNNING)) {
317 ppb_wctr(ppbus, 0x00);
318 ifp->if_flags &= ~IFF_RUNNING;
320 /* IFF_UP is not set, try to release the bus anyway */
321 ppb_release_bus(ppbus, dev);
324 if (((ifp->if_flags & IFF_UP)) && (!(ifp->if_flags & IFF_RUNNING))) {
327 * Should the request be interruptible?
329 if ((error = ppb_request_bus(ppbus, dev, PPB_WAIT|PPB_INTR)))
332 /* Now IFF_UP means that we own the bus */
334 ppb_set_mode(ppbus, PPB_COMPATIBLE);
336 if (lpinittables()) {
337 ppb_release_bus(ppbus, dev);
341 sc->sc_ifbuf = malloc(sc->sc_if.if_mtu + MLPIPHDRLEN,
344 ppb_release_bus(ppbus, dev);
348 /* attach our interrupt handler, later detached when the bus is released */
349 if ((error = BUS_SETUP_INTR(ppbus, dev, sc->res_irq,
350 INTR_TYPE_NET, lp_intr, dev, &ih))) {
351 ppb_release_bus(ppbus, dev);
355 ppb_wctr(ppbus, IRQENABLE);
356 ifp->if_flags |= IFF_RUNNING;
362 sc->sc_ifbuf = malloc(ifr->ifr_mtu+MLPIPHDRLEN, M_DEVBUF, M_WAITOK);
365 sc->sc_if.if_mtu = ifr->ifr_mtu;
369 ifr->ifr_mtu = sc->sc_if.if_mtu;
375 return EAFNOSUPPORT; /* XXX */
377 switch (ifr->ifr_addr.sa_family) {
389 * No ifmedia support at this stage; maybe use it
390 * in future for eg. protocol selection.
395 lprintf("LP:ioctl(0x%lx)\n", cmd);
402 clpoutbyte (u_char byte, int spin, device_t ppbus)
404 ppb_wdtr(ppbus, ctxmitl[byte]);
405 while (ppb_rstr(ppbus) & CLPIP_SHAKE)
409 ppb_wdtr(ppbus, ctxmith[byte]);
410 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
418 clpinbyte (int spin, device_t ppbus)
422 while((ppb_rstr(ppbus) & CLPIP_SHAKE))
426 cl = ppb_rstr(ppbus);
427 ppb_wdtr(ppbus, 0x10);
429 while(!(ppb_rstr(ppbus) & CLPIP_SHAKE))
434 ppb_wdtr(ppbus, 0x00);
436 return (ctrecvl[cl] | ctrecvh[c]);
440 lptap(struct ifnet *ifp, struct mbuf *m)
443 * We need to prepend the address family as a four byte field.
445 static const uint32_t af = AF_INET;
448 bpf_ptap(ifp->if_bpf, m, &af, sizeof(af));
454 device_t dev = (device_t)arg;
455 device_t ppbus = device_get_parent(dev);
456 struct lp_data *sc = DEVTOSOFTC(dev);
464 if (sc->sc_if.if_flags & IFF_LINK0) {
466 /* Ack. the request */
467 ppb_wdtr(ppbus, 0x01);
469 /* Get the packet length */
470 j = clpinbyte(LPMAXSPIN2, ppbus);
474 j = clpinbyte(LPMAXSPIN2, ppbus);
477 len = len + (j << 8);
478 if (len > sc->sc_if.if_mtu + MLPIPHDRLEN)
484 j = clpinbyte(LPMAXSPIN2, ppbus);
490 /* Get and ignore checksum */
491 j = clpinbyte(LPMAXSPIN2, ppbus);
496 len = bp - sc->sc_ifbuf;
497 if (len <= CLPIPHDRLEN)
503 sc->sc_if.if_ipackets++;
504 sc->sc_if.if_ibytes += len;
505 top = m_devget(sc->sc_ifbuf + CLPIPHDRLEN, len, 0, &sc->sc_if, 0);
507 if (sc->sc_if.if_bpf)
508 lptap(&sc->sc_if, top);
509 netisr_queue(NETISR_IP, top);
513 while ((ppb_rstr(ppbus) & LPIP_SHAKE)) {
514 len = sc->sc_if.if_mtu + LPIPHDRLEN;
518 cl = ppb_rstr(ppbus);
522 while((ppb_rstr(ppbus) & LPIP_SHAKE))
528 *bp++= trecvh[cl] | trecvl[c];
531 while (!((cl=ppb_rstr(ppbus)) & LPIP_SHAKE)) {
533 (((cl = ppb_rstr(ppbus)) ^ 0xb8) & 0xf8) ==
541 len = bp - sc->sc_ifbuf;
542 if (len <= LPIPHDRLEN)
548 sc->sc_if.if_ipackets++;
549 sc->sc_if.if_ibytes += len;
550 top = m_devget(sc->sc_ifbuf + LPIPHDRLEN, len, 0, &sc->sc_if, 0);
552 if (sc->sc_if.if_bpf)
553 lptap(&sc->sc_if, top);
554 netisr_queue(NETISR_IP, top);
562 sc->sc_if.if_ierrors++;
566 * We are not able to send receive anything for now,
567 * so stop wasting our time
569 if (sc->sc_iferrs > LPMAXERRS) {
570 printf("lp%d: Too many errors, Going off-line.\n", device_get_unit(dev));
571 ppb_wctr(ppbus, 0x00);
572 sc->sc_if.if_flags &= ~IFF_RUNNING;
582 lpoutbyte (u_char byte, int spin, device_t ppbus)
584 ppb_wdtr(ppbus, txmith[byte]);
585 while (!(ppb_rstr(ppbus) & LPIP_SHAKE))
588 ppb_wdtr(ppbus, txmitl[byte]);
589 while (ppb_rstr(ppbus) & LPIP_SHAKE)
596 lpoutput (struct ifnet *ifp, struct mbuf *m,
597 struct sockaddr *dst, struct rtentry *rt)
599 device_t dev = UNITODEVICE(ifp->if_dunit);
600 device_t ppbus = device_get_parent(dev);
608 /* We need a sensible value if we abort */
610 ifp->if_flags |= IFF_RUNNING;
612 err = 1; /* assume we're aborting because of an error */
616 /* Suspend (on laptops) or receive-errors might have taken us offline */
617 ppb_wctr(ppbus, IRQENABLE);
619 if (ifp->if_flags & IFF_LINK0) {
621 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
626 /* Alert other end to pending packet */
628 ppb_wdtr(ppbus, 0x08);
629 while ((ppb_rstr(ppbus) & 0x08) == 0)
634 /* Calculate length of packet, then send that */
636 count += 14; /* Ethernet header len */
639 for (mm = m; mm; mm = mm->m_next) {
642 if (clpoutbyte(count & 0xFF, LPMAXSPIN1, ppbus))
644 if (clpoutbyte((count >> 8) & 0xFF, LPMAXSPIN1, ppbus))
647 /* Send dummy ethernet header */
648 for (i = 0; i < 12; i++) {
649 if (clpoutbyte(i, LPMAXSPIN1, ppbus))
654 if (clpoutbyte(0x08, LPMAXSPIN1, ppbus))
656 if (clpoutbyte(0x00, LPMAXSPIN1, ppbus))
658 chksum += 0x08 + 0x00; /* Add into checksum */
662 cp = mtod(mm, u_char *);
666 if (clpoutbyte(*cp++, LPMAXSPIN2, ppbus))
669 } while ((mm = mm->m_next));
672 if (clpoutbyte(chksum, LPMAXSPIN2, ppbus))
678 err = 0; /* No errors */
681 if (err) { /* if we didn't timeout... */
686 ifp->if_obytes += m->m_pkthdr.len;
693 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
701 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
706 if (lpoutbyte(0x08, LPMAXSPIN1, ppbus))
708 if (lpoutbyte(0x00, LPMAXSPIN2, ppbus))
713 cp = mtod(mm,u_char *);
716 if (lpoutbyte(*cp++, LPMAXSPIN2, ppbus))
718 } while ((mm = mm->m_next));
720 err = 0; /* no errors were encountered */
724 ppb_wdtr(ppbus, txmitl[*cp] ^ 0x17);
726 if (err) { /* if we didn't timeout... */
731 ifp->if_obytes += m->m_pkthdr.len;
738 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
747 static device_method_t lp_methods[] = {
748 /* device interface */
749 DEVMETHOD(device_identify, lp_identify),
750 DEVMETHOD(device_probe, lp_probe),
751 DEVMETHOD(device_attach, lp_attach),
756 static driver_t lp_driver = {
759 sizeof(struct lp_data),
762 DECLARE_DUMMY_MODULE(if_plip);
763 DRIVER_MODULE(if_plip, ppbus, lp_driver, lp_devclass, 0, 0);