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.16 2005/11/28 17:13:43 dillon 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>
93 #include <sys/thread2.h>
95 #include <machine/clock.h>
96 #include <machine/bus.h>
97 #include <machine/resource.h>
101 #include <net/ifq_var.h>
102 #include <net/if_types.h>
103 #include <net/netisr.h>
105 #include <netinet/in.h>
106 #include <netinet/in_var.h>
110 #include <bus/ppbus/ppbconf.h>
111 #include "ppbus_if.h"
112 #include <bus/ppbus/ppbio.h>
114 #ifndef LPMTU /* MTU for the lp# interfaces */
118 #ifndef LPMAXSPIN1 /* DELAY factor for the lp# interfaces */
119 #define LPMAXSPIN1 8000 /* Spinning for remote intr to happen */
122 #ifndef LPMAXSPIN2 /* DELAY factor for the lp# interfaces */
123 #define LPMAXSPIN2 500 /* Spinning for remote handshake to happen */
126 #ifndef LPMAXERRS /* Max errors before !RUNNING */
127 #define LPMAXERRS 100
130 #define CLPIPHDRLEN 14 /* We send dummy ethernet addresses (two) + packet type in front of packet */
131 #define CLPIP_SHAKE 0x80 /* This bit toggles between nibble reception */
132 #define MLPIPHDRLEN CLPIPHDRLEN
134 #define LPIPHDRLEN 2 /* We send 0x08, 0x00 in front of packet */
135 #define LPIP_SHAKE 0x40 /* This bit toggles between nibble reception */
136 #if !defined(MLPIPHDRLEN) || LPIPHDRLEN > MLPIPHDRLEN
137 #define MLPIPHDRLEN LPIPHDRLEN
140 #define LPIPTBLSIZE 256 /* Size of octet translation table */
142 #define lprintf if (lptflag) printf
145 static int volatile lptflag = 1;
147 static int volatile lptflag = 0;
151 unsigned short lp_unit;
157 struct resource *res_irq;
160 /* Tables for the lp# interface */
161 static u_char *txmith;
162 #define txmitl (txmith+(1*LPIPTBLSIZE))
163 #define trecvh (txmith+(2*LPIPTBLSIZE))
164 #define trecvl (txmith+(3*LPIPTBLSIZE))
166 static u_char *ctxmith;
167 #define ctxmitl (ctxmith+(1*LPIPTBLSIZE))
168 #define ctrecvh (ctxmith+(2*LPIPTBLSIZE))
169 #define ctrecvl (ctxmith+(3*LPIPTBLSIZE))
171 /* Functions for the lp# interface */
172 static int lpinittables(void);
173 static int lpioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
174 static int lpoutput(struct ifnet *, struct mbuf *, struct sockaddr *,
176 static void lp_intr(void *);
178 #define DEVTOSOFTC(dev) \
179 ((struct lp_data *)device_get_softc(dev))
180 #define UNITOSOFTC(unit) \
181 ((struct lp_data *)devclass_get_softc(lp_devclass, (unit)))
182 #define UNITODEVICE(unit) \
183 (devclass_get_device(lp_devclass, (unit)))
185 static devclass_t lp_devclass;
191 lp_probe(device_t dev)
193 device_t ppbus = device_get_parent(dev);
198 lp = DEVTOSOFTC(dev);
200 /* retrieve the ppbus irq */
201 BUS_READ_IVAR(ppbus, dev, PPBUS_IVAR_IRQ, &irq);
203 /* if we haven't interrupts, the probe fails */
205 device_printf(dev, "not an interrupt driven port, failed.\n");
209 /* reserve the interrupt resource, expecting irq is available to continue */
210 lp->res_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &zero, irq, irq, 1,
212 if (lp->res_irq == 0) {
213 device_printf(dev, "cannot reserve interrupt, failed.\n");
218 * lp dependent initialisation.
220 lp->lp_unit = device_get_unit(dev);
222 device_set_desc(dev, "PLIP network interface");
228 lp_attach (device_t dev)
230 struct lp_data *lp = DEVTOSOFTC(dev);
231 struct ifnet *ifp = &lp->sc_if;
234 if_initname(ifp, "lp", device_get_unit(dev));
236 ifp->if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST;
237 ifp->if_ioctl = lpioctl;
238 ifp->if_output = lpoutput;
239 ifp->if_type = IFT_PARA;
242 ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
243 if_attach(ifp, NULL);
245 bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
250 * Build the translation tables for the LPIP (BSD unix) protocol.
251 * We don't want to calculate these nasties in our tight loop, so we
252 * precalculate them when we initialize.
260 txmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_WAITOK);
263 ctxmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_WAITOK);
265 for (i=0; i < LPIPTBLSIZE; i++) {
266 ctxmith[i] = (i & 0xF0) >> 4;
267 ctxmitl[i] = 0x10 | (i & 0x0F);
268 ctrecvh[i] = (i & 0x78) << 1;
269 ctrecvl[i] = (i & 0x78) >> 3;
272 for (i=0; i < LPIPTBLSIZE; i++) {
273 txmith[i] = ((i & 0x80) >> 3) | ((i & 0x70) >> 4) | 0x08;
274 txmitl[i] = ((i & 0x08) << 1) | (i & 0x07);
275 trecvh[i] = ((~i) & 0x80) | ((i & 0x38) << 1);
276 trecvl[i] = (((~i) & 0x80) >> 4) | ((i & 0x38) >> 3);
283 * Process an ioctl request.
287 lpioctl (struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
289 device_t dev = UNITODEVICE(ifp->if_dunit);
290 device_t ppbus = device_get_parent(dev);
291 struct lp_data *sc = DEVTOSOFTC(dev);
292 struct ifaddr *ifa = (struct ifaddr *)data;
293 struct ifreq *ifr = (struct ifreq *)data;
303 if (ifa->ifa_addr->sa_family != AF_INET)
306 ifp->if_flags |= IFF_UP;
309 if ((!(ifp->if_flags & IFF_UP)) && (ifp->if_flags & IFF_RUNNING)) {
311 ppb_wctr(ppbus, 0x00);
312 ifp->if_flags &= ~IFF_RUNNING;
314 /* IFF_UP is not set, try to release the bus anyway */
315 ppb_release_bus(ppbus, dev);
318 if (((ifp->if_flags & IFF_UP)) && (!(ifp->if_flags & IFF_RUNNING))) {
321 * Should the request be interruptible?
323 if ((error = ppb_request_bus(ppbus, dev, PPB_WAIT|PPB_INTR)))
326 /* Now IFF_UP means that we own the bus */
328 ppb_set_mode(ppbus, PPB_COMPATIBLE);
330 if (lpinittables()) {
331 ppb_release_bus(ppbus, dev);
335 sc->sc_ifbuf = malloc(sc->sc_if.if_mtu + MLPIPHDRLEN,
338 ppb_release_bus(ppbus, dev);
342 /* attach our interrupt handler, later detached when the bus is released */
343 error = BUS_SETUP_INTR(ppbus, dev, sc->res_irq, 0,
344 lp_intr, dev, &ih, NULL);
346 ppb_release_bus(ppbus, dev);
350 ppb_wctr(ppbus, IRQENABLE);
351 ifp->if_flags |= IFF_RUNNING;
357 sc->sc_ifbuf = malloc(ifr->ifr_mtu+MLPIPHDRLEN, M_DEVBUF, M_WAITOK);
360 sc->sc_if.if_mtu = ifr->ifr_mtu;
364 ifr->ifr_mtu = sc->sc_if.if_mtu;
370 return EAFNOSUPPORT; /* XXX */
372 switch (ifr->ifr_addr.sa_family) {
384 * No ifmedia support at this stage; maybe use it
385 * in future for eg. protocol selection.
390 lprintf("LP:ioctl(0x%lx)\n", cmd);
397 clpoutbyte (u_char byte, int spin, device_t ppbus)
399 ppb_wdtr(ppbus, ctxmitl[byte]);
400 while (ppb_rstr(ppbus) & CLPIP_SHAKE)
404 ppb_wdtr(ppbus, ctxmith[byte]);
405 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
413 clpinbyte (int spin, device_t ppbus)
417 while((ppb_rstr(ppbus) & CLPIP_SHAKE))
421 cl = ppb_rstr(ppbus);
422 ppb_wdtr(ppbus, 0x10);
424 while(!(ppb_rstr(ppbus) & CLPIP_SHAKE))
429 ppb_wdtr(ppbus, 0x00);
431 return (ctrecvl[cl] | ctrecvh[c]);
435 lptap(struct ifnet *ifp, struct mbuf *m)
438 * We need to prepend the address family as a four byte field.
440 static const uint32_t af = AF_INET;
443 bpf_ptap(ifp->if_bpf, m, &af, sizeof(af));
449 device_t dev = (device_t)arg;
450 device_t ppbus = device_get_parent(dev);
451 struct lp_data *sc = DEVTOSOFTC(dev);
459 if (sc->sc_if.if_flags & IFF_LINK0) {
461 /* Ack. the request */
462 ppb_wdtr(ppbus, 0x01);
464 /* Get the packet length */
465 j = clpinbyte(LPMAXSPIN2, ppbus);
469 j = clpinbyte(LPMAXSPIN2, ppbus);
472 len = len + (j << 8);
473 if (len > sc->sc_if.if_mtu + MLPIPHDRLEN)
479 j = clpinbyte(LPMAXSPIN2, ppbus);
485 /* Get and ignore checksum */
486 j = clpinbyte(LPMAXSPIN2, ppbus);
491 len = bp - sc->sc_ifbuf;
492 if (len <= CLPIPHDRLEN)
498 sc->sc_if.if_ipackets++;
499 sc->sc_if.if_ibytes += len;
500 top = m_devget(sc->sc_ifbuf + CLPIPHDRLEN, len, 0, &sc->sc_if, 0);
502 if (sc->sc_if.if_bpf)
503 lptap(&sc->sc_if, top);
504 netisr_queue(NETISR_IP, top);
508 while ((ppb_rstr(ppbus) & LPIP_SHAKE)) {
509 len = sc->sc_if.if_mtu + LPIPHDRLEN;
513 cl = ppb_rstr(ppbus);
517 while((ppb_rstr(ppbus) & LPIP_SHAKE))
523 *bp++= trecvh[cl] | trecvl[c];
526 while (!((cl=ppb_rstr(ppbus)) & LPIP_SHAKE)) {
528 (((cl = ppb_rstr(ppbus)) ^ 0xb8) & 0xf8) ==
536 len = bp - sc->sc_ifbuf;
537 if (len <= LPIPHDRLEN)
543 sc->sc_if.if_ipackets++;
544 sc->sc_if.if_ibytes += len;
545 top = m_devget(sc->sc_ifbuf + LPIPHDRLEN, len, 0, &sc->sc_if, 0);
547 if (sc->sc_if.if_bpf)
548 lptap(&sc->sc_if, top);
549 netisr_queue(NETISR_IP, top);
557 sc->sc_if.if_ierrors++;
561 * We are not able to send receive anything for now,
562 * so stop wasting our time
564 if (sc->sc_iferrs > LPMAXERRS) {
565 printf("lp%d: Too many errors, Going off-line.\n", device_get_unit(dev));
566 ppb_wctr(ppbus, 0x00);
567 sc->sc_if.if_flags &= ~IFF_RUNNING;
577 lpoutbyte (u_char byte, int spin, device_t ppbus)
579 ppb_wdtr(ppbus, txmith[byte]);
580 while (!(ppb_rstr(ppbus) & LPIP_SHAKE))
583 ppb_wdtr(ppbus, txmitl[byte]);
584 while (ppb_rstr(ppbus) & LPIP_SHAKE)
591 lpoutput (struct ifnet *ifp, struct mbuf *m,
592 struct sockaddr *dst, struct rtentry *rt)
594 device_t dev = UNITODEVICE(ifp->if_dunit);
595 device_t ppbus = device_get_parent(dev);
603 /* We need a sensible value if we abort */
605 ifp->if_flags |= IFF_RUNNING;
607 err = 1; /* assume we're aborting because of an error */
611 /* Suspend (on laptops) or receive-errors might have taken us offline */
612 ppb_wctr(ppbus, IRQENABLE);
614 if (ifp->if_flags & IFF_LINK0) {
616 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
621 /* Alert other end to pending packet */
623 ppb_wdtr(ppbus, 0x08);
624 while ((ppb_rstr(ppbus) & 0x08) == 0)
629 /* Calculate length of packet, then send that */
631 count += 14; /* Ethernet header len */
634 for (mm = m; mm; mm = mm->m_next) {
637 if (clpoutbyte(count & 0xFF, LPMAXSPIN1, ppbus))
639 if (clpoutbyte((count >> 8) & 0xFF, LPMAXSPIN1, ppbus))
642 /* Send dummy ethernet header */
643 for (i = 0; i < 12; i++) {
644 if (clpoutbyte(i, LPMAXSPIN1, ppbus))
649 if (clpoutbyte(0x08, LPMAXSPIN1, ppbus))
651 if (clpoutbyte(0x00, LPMAXSPIN1, ppbus))
653 chksum += 0x08 + 0x00; /* Add into checksum */
657 cp = mtod(mm, u_char *);
661 if (clpoutbyte(*cp++, LPMAXSPIN2, ppbus))
664 } while ((mm = mm->m_next));
667 if (clpoutbyte(chksum, LPMAXSPIN2, ppbus))
673 err = 0; /* No errors */
676 if (err) { /* if we didn't timeout... */
681 ifp->if_obytes += m->m_pkthdr.len;
688 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
696 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
701 if (lpoutbyte(0x08, LPMAXSPIN1, ppbus))
703 if (lpoutbyte(0x00, LPMAXSPIN2, ppbus))
708 cp = mtod(mm,u_char *);
711 if (lpoutbyte(*cp++, LPMAXSPIN2, ppbus))
713 } while ((mm = mm->m_next));
715 err = 0; /* no errors were encountered */
719 ppb_wdtr(ppbus, txmitl[*cp] ^ 0x17);
721 if (err) { /* if we didn't timeout... */
726 ifp->if_obytes += m->m_pkthdr.len;
733 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
743 * Because plip is a static device that always exists under any attached
744 * ppbus device, and not scanned by the ppbus device, we need an identify
745 * function to install the device.
747 static device_method_t lp_methods[] = {
748 /* device interface */
749 DEVMETHOD(device_identify, bus_generic_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);