2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997 Poul-Henning Kamp
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * From Id: lpt.c,v 1.55.2.1 1996/11/12 09:08:38 phk Exp
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
35 * Parallel port TCP/IP interfaces added. I looked at the driver from
36 * MACH but this is a complete rewrite, and btw. incompatible, and it
37 * should perform better too. I have never run the MACH driver though.
39 * This driver sends two bytes (0x08, 0x00) in front of each packet,
40 * to allow us to distinguish another format later.
42 * Now added a Linux/Crynwr compatibility mode which is enabled using
43 * IF_LINK0 - Tim Wilkinson.
46 * Make HDLC/PPP mode, use IF_LLC1 to enable.
48 * Connect the two computers using a Laplink parallel cable to use this
51 * +----------------------------------------+
52 * |A-name A-End B-End Descr. Port/Bit |
53 * +----------------------------------------+
54 * |DATA0 2 15 Data 0/0x01 |
55 * |-ERROR 15 2 1/0x08 |
56 * +----------------------------------------+
57 * |DATA1 3 13 Data 0/0x02 |
58 * |+SLCT 13 3 1/0x10 |
59 * +----------------------------------------+
60 * |DATA2 4 12 Data 0/0x04 |
62 * +----------------------------------------+
63 * |DATA3 5 10 Strobe 0/0x08 |
65 * +----------------------------------------+
66 * |DATA4 6 11 Data 0/0x10 |
67 * |BUSY 11 6 1/~0x80 |
68 * +----------------------------------------+
69 * |GND 18-25 18-25 GND - |
70 * +----------------------------------------+
72 * Expect transfer-rates up to 75 kbyte/sec.
74 * If GCC could correctly grok
75 * register int port asm("edx")
76 * the code would be cleaner
78 * Poul-Henning Kamp <phk@freebsd.org>
82 * Update for ppbus, PLIP support only - Nicolas Souchu
87 #include <sys/param.h>
88 #include <sys/systm.h>
89 #include <sys/module.h>
92 #include <sys/socket.h>
93 #include <sys/sockio.h>
94 #include <sys/kernel.h>
95 #include <sys/malloc.h>
97 #include <machine/bus.h>
98 #include <machine/resource.h>
102 #include <net/if_var.h>
103 #include <net/if_types.h>
104 #include <net/netisr.h>
105 #include <net/route.h>
107 #include <netinet/in.h>
108 #include <netinet/in_var.h>
112 #include <dev/ppbus/ppbconf.h>
113 #include "ppbus_if.h"
114 #include <dev/ppbus/ppbio.h>
116 #ifndef LPMTU /* MTU for the lp# interfaces */
120 #ifndef LPMAXSPIN1 /* DELAY factor for the lp# interfaces */
121 #define LPMAXSPIN1 8000 /* Spinning for remote intr to happen */
124 #ifndef LPMAXSPIN2 /* DELAY factor for the lp# interfaces */
125 #define LPMAXSPIN2 500 /* Spinning for remote handshake to happen */
128 #ifndef LPMAXERRS /* Max errors before !RUNNING */
129 #define LPMAXERRS 100
132 #define CLPIPHDRLEN 14 /* We send dummy ethernet addresses (two) + packet type in front of packet */
133 #define CLPIP_SHAKE 0x80 /* This bit toggles between nibble reception */
134 #define MLPIPHDRLEN CLPIPHDRLEN
136 #define LPIPHDRLEN 2 /* We send 0x08, 0x00 in front of packet */
137 #define LPIP_SHAKE 0x40 /* This bit toggles between nibble reception */
138 #if !defined(MLPIPHDRLEN) || LPIPHDRLEN > MLPIPHDRLEN
139 #define MLPIPHDRLEN LPIPHDRLEN
142 #define LPIPTBLSIZE 256 /* Size of octet translation table */
144 #define lprintf if (lptflag) printf
147 static int volatile lptflag = 1;
149 static int volatile lptflag = 0;
153 struct ifnet *sc_ifp;
158 struct resource *res_irq;
159 void *sc_intr_cookie;
162 static struct mtx lp_tables_lock;
163 MTX_SYSINIT(lp_tables, &lp_tables_lock, "plip tables", MTX_DEF);
165 /* Tables for the lp# interface */
166 static u_char *txmith;
167 #define txmitl (txmith + (1 * LPIPTBLSIZE))
168 #define trecvh (txmith + (2 * LPIPTBLSIZE))
169 #define trecvl (txmith + (3 * LPIPTBLSIZE))
171 static u_char *ctxmith;
172 #define ctxmitl (ctxmith + (1 * LPIPTBLSIZE))
173 #define ctrecvh (ctxmith + (2 * LPIPTBLSIZE))
174 #define ctrecvl (ctxmith + (3 * LPIPTBLSIZE))
176 /* Functions for the lp# interface */
177 static int lpinittables(void);
178 static int lpioctl(struct ifnet *, u_long, caddr_t);
179 static int lpoutput(struct ifnet *, struct mbuf *, const struct sockaddr *,
181 static void lpstop(struct lp_data *);
182 static void lp_intr(void *);
183 static int lp_module_handler(module_t, int, void *);
185 #define DEVTOSOFTC(dev) \
186 ((struct lp_data *)device_get_softc(dev))
188 static devclass_t lp_devclass;
191 lp_module_handler(module_t mod, int what, void *arg)
196 mtx_lock(&lp_tables_lock);
197 if (txmith != NULL) {
198 free(txmith, M_DEVBUF);
201 if (ctxmith != NULL) {
202 free(ctxmith, M_DEVBUF);
205 mtx_unlock(&lp_tables_lock);
217 lp_identify(driver_t *driver, device_t parent)
221 dev = device_find_child(parent, "plip", -1);
223 BUS_ADD_CHILD(parent, 0, "plip", -1);
227 lp_probe(device_t dev)
230 device_set_desc(dev, "PLIP network interface");
236 lp_attach(device_t dev)
238 struct lp_data *lp = DEVTOSOFTC(dev);
245 * Reserve the interrupt resource. If we don't have one, the
248 lp->res_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
250 if (lp->res_irq == NULL) {
251 device_printf(dev, "cannot reserve interrupt, failed.\n");
255 ifp = lp->sc_ifp = if_alloc(IFT_PARA);
261 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
263 ifp->if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST;
264 ifp->if_ioctl = lpioctl;
265 ifp->if_output = lpoutput;
268 ifp->if_snd.ifq_maxlen = ifqmaxlen;
271 bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
274 * Attach our interrupt handler. It is only called while we
277 error = bus_setup_intr(dev, lp->res_irq, INTR_TYPE_NET | INTR_MPSAFE,
278 NULL, lp_intr, lp, &lp->sc_intr_cookie);
282 bus_release_resource(dev, SYS_RES_IRQ, 0, lp->res_irq);
283 device_printf(dev, "Unable to register interrupt handler\n");
291 lp_detach(device_t dev)
293 struct lp_data *sc = device_get_softc(dev);
294 device_t ppbus = device_get_parent(dev);
299 bpfdetach(sc->sc_ifp);
300 if_detach(sc->sc_ifp);
301 bus_teardown_intr(dev, sc->res_irq, sc->sc_intr_cookie);
302 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->res_irq);
307 * Build the translation tables for the LPIP (BSD unix) protocol.
308 * We don't want to calculate these nasties in our tight loop, so we
309 * precalculate them when we initialize.
316 mtx_lock(&lp_tables_lock);
318 txmith = malloc(4 * LPIPTBLSIZE, M_DEVBUF, M_NOWAIT);
320 if (txmith == NULL) {
321 mtx_unlock(&lp_tables_lock);
326 ctxmith = malloc(4 * LPIPTBLSIZE, M_DEVBUF, M_NOWAIT);
328 if (ctxmith == NULL) {
329 mtx_unlock(&lp_tables_lock);
333 for (i = 0; i < LPIPTBLSIZE; i++) {
334 ctxmith[i] = (i & 0xF0) >> 4;
335 ctxmitl[i] = 0x10 | (i & 0x0F);
336 ctrecvh[i] = (i & 0x78) << 1;
337 ctrecvl[i] = (i & 0x78) >> 3;
340 for (i = 0; i < LPIPTBLSIZE; i++) {
341 txmith[i] = ((i & 0x80) >> 3) | ((i & 0x70) >> 4) | 0x08;
342 txmitl[i] = ((i & 0x08) << 1) | (i & 0x07);
343 trecvh[i] = ((~i) & 0x80) | ((i & 0x38) << 1);
344 trecvl[i] = (((~i) & 0x80) >> 4) | ((i & 0x38) >> 3);
346 mtx_unlock(&lp_tables_lock);
352 lpstop(struct lp_data *sc)
354 device_t ppbus = device_get_parent(sc->sc_dev);
356 ppb_assert_locked(ppbus);
357 ppb_wctr(ppbus, 0x00);
358 sc->sc_ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
359 free(sc->sc_ifbuf, M_DEVBUF);
362 /* IFF_UP is not set, try to release the bus anyway */
363 ppb_release_bus(ppbus, sc->sc_dev);
367 lpinit_locked(struct ifnet *ifp)
369 struct lp_data *sc = ifp->if_softc;
370 device_t dev = sc->sc_dev;
371 device_t ppbus = device_get_parent(dev);
374 ppb_assert_locked(ppbus);
375 error = ppb_request_bus(ppbus, dev, PPB_DONTWAIT);
379 /* Now IFF_UP means that we own the bus */
380 ppb_set_mode(ppbus, PPB_COMPATIBLE);
382 if (lpinittables()) {
383 ppb_release_bus(ppbus, dev);
387 sc->sc_ifbuf = malloc(sc->sc_ifp->if_mtu + MLPIPHDRLEN,
389 if (sc->sc_ifbuf == NULL) {
390 ppb_release_bus(ppbus, dev);
394 ppb_wctr(ppbus, IRQENABLE);
396 ifp->if_drv_flags |= IFF_DRV_RUNNING;
397 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
402 * Process an ioctl request.
405 lpioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
407 struct lp_data *sc = ifp->if_softc;
408 device_t dev = sc->sc_dev;
409 device_t ppbus = device_get_parent(dev);
410 struct ifaddr *ifa = (struct ifaddr *)data;
411 struct ifreq *ifr = (struct ifreq *)data;
418 if (ifa->ifa_addr->sa_family != AF_INET)
419 return (EAFNOSUPPORT);
421 ifp->if_flags |= IFF_UP;
426 if ((!(ifp->if_flags & IFF_UP)) &&
427 (ifp->if_drv_flags & IFF_DRV_RUNNING))
429 else if (((ifp->if_flags & IFF_UP)) &&
430 (!(ifp->if_drv_flags & IFF_DRV_RUNNING)))
431 error = lpinit_locked(ifp);
437 if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
438 ptr = malloc(ifr->ifr_mtu + MLPIPHDRLEN, M_DEVBUF,
445 free(sc->sc_ifbuf, M_DEVBUF);
448 sc->sc_ifp->if_mtu = ifr->ifr_mtu;
453 ifr->ifr_mtu = sc->sc_ifp->if_mtu;
459 return (EAFNOSUPPORT); /* XXX */
461 switch (ifr->ifr_addr.sa_family) {
465 return (EAFNOSUPPORT);
471 * No ifmedia support at this stage; maybe use it
472 * in future for eg. protocol selection.
477 lprintf("LP:ioctl(0x%lx)\n", cmd);
484 clpoutbyte(u_char byte, int spin, device_t ppbus)
487 ppb_wdtr(ppbus, ctxmitl[byte]);
488 while (ppb_rstr(ppbus) & CLPIP_SHAKE)
492 ppb_wdtr(ppbus, ctxmith[byte]);
493 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
501 clpinbyte(int spin, device_t ppbus)
505 while ((ppb_rstr(ppbus) & CLPIP_SHAKE))
509 cl = ppb_rstr(ppbus);
510 ppb_wdtr(ppbus, 0x10);
512 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
517 ppb_wdtr(ppbus, 0x00);
519 return (ctrecvl[cl] | ctrecvh[c]);
523 lptap(struct ifnet *ifp, struct mbuf *m)
525 u_int32_t af = AF_INET;
527 bpf_mtap2(ifp->if_bpf, &af, sizeof(af), m);
533 struct lp_data *sc = arg;
534 device_t ppbus = device_get_parent(sc->sc_dev);
540 ppb_assert_locked(ppbus);
541 if (sc->sc_ifp->if_flags & IFF_LINK0) {
542 /* Ack. the request */
543 ppb_wdtr(ppbus, 0x01);
545 /* Get the packet length */
546 j = clpinbyte(LPMAXSPIN2, ppbus);
550 j = clpinbyte(LPMAXSPIN2, ppbus);
553 len = len + (j << 8);
554 if (len > sc->sc_ifp->if_mtu + MLPIPHDRLEN)
560 j = clpinbyte(LPMAXSPIN2, ppbus);
567 /* Get and ignore checksum */
568 j = clpinbyte(LPMAXSPIN2, ppbus);
573 len = bp - sc->sc_ifbuf;
574 if (len <= CLPIPHDRLEN)
580 if_inc_counter(sc->sc_ifp, IFCOUNTER_IPACKETS, 1);
581 if_inc_counter(sc->sc_ifp, IFCOUNTER_IBYTES, len);
582 top = m_devget(sc->sc_ifbuf + CLPIPHDRLEN, len, 0, sc->sc_ifp,
586 if (bpf_peers_present(sc->sc_ifp->if_bpf))
587 lptap(sc->sc_ifp, top);
589 M_SETFIB(top, sc->sc_ifp->if_fib);
591 /* mbuf is free'd on failure. */
592 netisr_queue(NETISR_IP, top);
597 while ((ppb_rstr(ppbus) & LPIP_SHAKE)) {
598 len = sc->sc_ifp->if_mtu + LPIPHDRLEN;
601 cl = ppb_rstr(ppbus);
605 while ((ppb_rstr(ppbus) & LPIP_SHAKE))
612 *bp++= trecvh[cl] | trecvl[c];
615 while (!((cl = ppb_rstr(ppbus)) & LPIP_SHAKE)) {
617 (((cl = ppb_rstr(ppbus)) ^ 0xb8) & 0xf8) ==
626 len = bp - sc->sc_ifbuf;
627 if (len <= LPIPHDRLEN)
633 if_inc_counter(sc->sc_ifp, IFCOUNTER_IPACKETS, 1);
634 if_inc_counter(sc->sc_ifp, IFCOUNTER_IBYTES, len);
635 top = m_devget(sc->sc_ifbuf + LPIPHDRLEN, len, 0, sc->sc_ifp,
639 if (bpf_peers_present(sc->sc_ifp->if_bpf))
640 lptap(sc->sc_ifp, top);
642 M_SETFIB(top, sc->sc_ifp->if_fib);
644 /* mbuf is free'd on failure. */
645 netisr_queue(NETISR_IP, top);
654 if_inc_counter(sc->sc_ifp, IFCOUNTER_IERRORS, 1);
658 * We are not able to send receive anything for now,
659 * so stop wasting our time
661 if (sc->sc_iferrs > LPMAXERRS) {
662 if_printf(sc->sc_ifp, "Too many errors, Going off-line.\n");
663 ppb_wctr(ppbus, 0x00);
664 sc->sc_ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
670 lpoutbyte(u_char byte, int spin, device_t ppbus)
673 ppb_wdtr(ppbus, txmith[byte]);
674 while (!(ppb_rstr(ppbus) & LPIP_SHAKE))
677 ppb_wdtr(ppbus, txmitl[byte]);
678 while (ppb_rstr(ppbus) & LPIP_SHAKE)
685 lpoutput(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *dst,
688 struct lp_data *sc = ifp->if_softc;
689 device_t dev = sc->sc_dev;
690 device_t ppbus = device_get_parent(dev);
698 /* We need a sensible value if we abort */
701 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
703 err = 1; /* assume we're aborting because of an error */
705 /* Suspend (on laptops) or receive-errors might have taken us offline */
706 ppb_wctr(ppbus, IRQENABLE);
708 if (ifp->if_flags & IFF_LINK0) {
709 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
714 /* Alert other end to pending packet */
716 ppb_wdtr(ppbus, 0x08);
717 while ((ppb_rstr(ppbus) & 0x08) == 0)
722 /* Calculate length of packet, then send that */
724 count += 14; /* Ethernet header len */
727 for (mm = m; mm; mm = mm->m_next) {
730 if (clpoutbyte(count & 0xFF, LPMAXSPIN1, ppbus))
732 if (clpoutbyte((count >> 8) & 0xFF, LPMAXSPIN1, ppbus))
735 /* Send dummy ethernet header */
736 for (i = 0; i < 12; i++) {
737 if (clpoutbyte(i, LPMAXSPIN1, ppbus))
742 if (clpoutbyte(0x08, LPMAXSPIN1, ppbus))
744 if (clpoutbyte(0x00, LPMAXSPIN1, ppbus))
746 chksum += 0x08 + 0x00; /* Add into checksum */
750 cp = mtod(mm, u_char *);
754 if (clpoutbyte(*cp++, LPMAXSPIN2, ppbus))
757 } while ((mm = mm->m_next));
760 if (clpoutbyte(chksum, LPMAXSPIN2, ppbus))
766 err = 0; /* No errors */
769 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
770 if (err) { /* if we didn't timeout... */
771 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
774 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
775 if_inc_counter(ifp, IFCOUNTER_OBYTES, m->m_pkthdr.len);
776 if (bpf_peers_present(ifp->if_bpf))
782 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
790 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
795 if (lpoutbyte(0x08, LPMAXSPIN1, ppbus))
797 if (lpoutbyte(0x00, LPMAXSPIN2, ppbus))
802 cp = mtod(mm, u_char *);
805 if (lpoutbyte(*cp++, LPMAXSPIN2, ppbus))
807 } while ((mm = mm->m_next));
809 err = 0; /* no errors were encountered */
813 ppb_wdtr(ppbus, txmitl[*cp] ^ 0x17);
815 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
816 if (err) { /* if we didn't timeout... */
817 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
820 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
821 if_inc_counter(ifp, IFCOUNTER_OBYTES, m->m_pkthdr.len);
822 if (bpf_peers_present(ifp->if_bpf))
828 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
837 static device_method_t lp_methods[] = {
838 /* device interface */
839 DEVMETHOD(device_identify, lp_identify),
840 DEVMETHOD(device_probe, lp_probe),
841 DEVMETHOD(device_attach, lp_attach),
842 DEVMETHOD(device_detach, lp_detach),
846 static driver_t lp_driver = {
849 sizeof(struct lp_data),
852 DRIVER_MODULE(plip, ppbus, lp_driver, lp_devclass, lp_module_handler, 0);
853 MODULE_DEPEND(plip, ppbus, 1, 1, 1);