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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
33 * Parallel port TCP/IP interfaces added. I looked at the driver from
34 * MACH but this is a complete rewrite, and btw. incompatible, and it
35 * should perform better too. I have never run the MACH driver though.
37 * This driver sends two bytes (0x08, 0x00) in front of each packet,
38 * to allow us to distinguish another format later.
40 * Now added a Linux/Crynwr compatibility mode which is enabled using
41 * IF_LINK0 - Tim Wilkinson.
44 * Make HDLC/PPP mode, use IF_LLC1 to enable.
46 * Connect the two computers using a Laplink parallel cable to use this
49 * +----------------------------------------+
50 * |A-name A-End B-End Descr. Port/Bit |
51 * +----------------------------------------+
52 * |DATA0 2 15 Data 0/0x01 |
53 * |-ERROR 15 2 1/0x08 |
54 * +----------------------------------------+
55 * |DATA1 3 13 Data 0/0x02 |
56 * |+SLCT 13 3 1/0x10 |
57 * +----------------------------------------+
58 * |DATA2 4 12 Data 0/0x04 |
60 * +----------------------------------------+
61 * |DATA3 5 10 Strobe 0/0x08 |
63 * +----------------------------------------+
64 * |DATA4 6 11 Data 0/0x10 |
65 * |BUSY 11 6 1/~0x80 |
66 * +----------------------------------------+
67 * |GND 18-25 18-25 GND - |
68 * +----------------------------------------+
70 * Expect transfer-rates up to 75 kbyte/sec.
72 * If GCC could correctly grok
73 * register int port asm("edx")
74 * the code would be cleaner
76 * Poul-Henning Kamp <phk@freebsd.org>
80 * Update for ppbus, PLIP support only - Nicolas Souchu
85 #include <sys/param.h>
86 #include <sys/systm.h>
87 #include <sys/module.h>
90 #include <sys/socket.h>
91 #include <sys/sockio.h>
92 #include <sys/kernel.h>
93 #include <sys/malloc.h>
95 #include <machine/bus.h>
96 #include <machine/resource.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 <dev/ppbus/ppbconf.h>
109 #include "ppbus_if.h"
110 #include <dev/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) printf
143 static int volatile lptflag = 1;
145 static int volatile lptflag = 0;
149 struct ifnet *sc_ifp;
153 struct resource *res_irq;
156 /* Tables for the lp# interface */
157 static u_char *txmith;
158 #define txmitl (txmith+(1*LPIPTBLSIZE))
159 #define trecvh (txmith+(2*LPIPTBLSIZE))
160 #define trecvl (txmith+(3*LPIPTBLSIZE))
162 static u_char *ctxmith;
163 #define ctxmitl (ctxmith+(1*LPIPTBLSIZE))
164 #define ctrecvh (ctxmith+(2*LPIPTBLSIZE))
165 #define ctrecvl (ctxmith+(3*LPIPTBLSIZE))
167 /* Functions for the lp# interface */
168 static int lpinittables(void);
169 static int lpioctl(struct ifnet *, u_long, caddr_t);
170 static int lpoutput(struct ifnet *, struct mbuf *, struct sockaddr *,
172 static void lp_intr(void *);
174 #define DEVTOSOFTC(dev) \
175 ((struct lp_data *)device_get_softc(dev))
176 #define UNITOSOFTC(unit) \
177 ((struct lp_data *)devclass_get_softc(lp_devclass, (unit)))
178 #define UNITODEVICE(unit) \
179 (devclass_get_device(lp_devclass, (unit)))
181 static devclass_t lp_devclass;
184 lp_identify(driver_t *driver, device_t parent)
188 dev = device_find_child(parent, "plip", -1);
190 BUS_ADD_CHILD(parent, 0, "plip", -1);
196 lp_probe(device_t dev)
198 device_t ppbus = device_get_parent(dev);
203 lp = DEVTOSOFTC(dev);
205 /* retrieve the ppbus irq */
206 BUS_READ_IVAR(ppbus, dev, PPBUS_IVAR_IRQ, &irq);
208 /* if we haven't interrupts, the probe fails */
210 device_printf(dev, "not an interrupt driven port, failed.\n");
214 /* reserve the interrupt resource, expecting irq is available to continue */
215 lp->res_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &zero, irq, irq, 1,
217 if (lp->res_irq == 0) {
218 device_printf(dev, "cannot reserve interrupt, failed.\n");
223 * lp dependent initialisation.
226 device_set_desc(dev, "PLIP network interface");
232 lp_attach (device_t dev)
234 struct lp_data *lp = DEVTOSOFTC(dev);
237 ifp = lp->sc_ifp = if_alloc(IFT_PARA);
243 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
245 ifp->if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST |
247 ifp->if_ioctl = lpioctl;
248 ifp->if_output = lpoutput;
251 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
254 bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
259 * Build the translation tables for the LPIP (BSD unix) protocol.
260 * We don't want to calculate these nasties in our tight loop, so we
261 * precalculate them when we initialize.
269 txmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_NOWAIT);
275 ctxmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_NOWAIT);
280 for (i=0; i < LPIPTBLSIZE; i++) {
281 ctxmith[i] = (i & 0xF0) >> 4;
282 ctxmitl[i] = 0x10 | (i & 0x0F);
283 ctrecvh[i] = (i & 0x78) << 1;
284 ctrecvl[i] = (i & 0x78) >> 3;
287 for (i=0; i < LPIPTBLSIZE; i++) {
288 txmith[i] = ((i & 0x80) >> 3) | ((i & 0x70) >> 4) | 0x08;
289 txmitl[i] = ((i & 0x08) << 1) | (i & 0x07);
290 trecvh[i] = ((~i) & 0x80) | ((i & 0x38) << 1);
291 trecvl[i] = (((~i) & 0x80) >> 4) | ((i & 0x38) >> 3);
298 * Process an ioctl request.
302 lpioctl (struct ifnet *ifp, u_long cmd, caddr_t data)
304 device_t dev = UNITODEVICE(ifp->if_dunit);
305 device_t ppbus = device_get_parent(dev);
306 struct lp_data *sc = DEVTOSOFTC(dev);
307 struct ifaddr *ifa = (struct ifaddr *)data;
308 struct ifreq *ifr = (struct ifreq *)data;
318 if (ifa->ifa_addr->sa_family != AF_INET)
321 ifp->if_flags |= IFF_UP;
324 if ((!(ifp->if_flags & IFF_UP)) &&
325 (ifp->if_drv_flags & IFF_DRV_RUNNING)) {
327 ppb_wctr(ppbus, 0x00);
328 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
330 /* IFF_UP is not set, try to release the bus anyway */
331 ppb_release_bus(ppbus, dev);
334 if (((ifp->if_flags & IFF_UP)) &&
335 (!(ifp->if_drv_flags & IFF_DRV_RUNNING))) {
338 * Should the request be interruptible?
340 if ((error = ppb_request_bus(ppbus, dev, PPB_WAIT|PPB_INTR)))
343 /* Now IFF_UP means that we own the bus */
345 ppb_set_mode(ppbus, PPB_COMPATIBLE);
347 if (lpinittables()) {
348 ppb_release_bus(ppbus, dev);
352 sc->sc_ifbuf = malloc(sc->sc_ifp->if_mtu + MLPIPHDRLEN,
355 ppb_release_bus(ppbus, dev);
359 /* attach our interrupt handler, later detached when the bus is released */
360 if ((error = bus_setup_intr(dev, sc->res_irq,
361 INTR_TYPE_NET, NULL, lp_intr, dev, &ih))) {
362 ppb_release_bus(ppbus, dev);
366 ppb_wctr(ppbus, IRQENABLE);
367 ifp->if_drv_flags |= IFF_DRV_RUNNING;
373 sc->sc_ifbuf = malloc(ifr->ifr_mtu+MLPIPHDRLEN, M_DEVBUF, M_NOWAIT);
380 sc->sc_ifp->if_mtu = ifr->ifr_mtu;
384 ifr->ifr_mtu = sc->sc_ifp->if_mtu;
390 return EAFNOSUPPORT; /* XXX */
392 switch (ifr->ifr_addr.sa_family) {
404 * No ifmedia support at this stage; maybe use it
405 * in future for eg. protocol selection.
410 lprintf("LP:ioctl(0x%lx)\n", cmd);
417 clpoutbyte (u_char byte, int spin, device_t ppbus)
419 ppb_wdtr(ppbus, ctxmitl[byte]);
420 while (ppb_rstr(ppbus) & CLPIP_SHAKE)
424 ppb_wdtr(ppbus, ctxmith[byte]);
425 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
433 clpinbyte (int spin, device_t ppbus)
437 while((ppb_rstr(ppbus) & CLPIP_SHAKE))
441 cl = ppb_rstr(ppbus);
442 ppb_wdtr(ppbus, 0x10);
444 while(!(ppb_rstr(ppbus) & CLPIP_SHAKE))
449 ppb_wdtr(ppbus, 0x00);
451 return (ctrecvl[cl] | ctrecvh[c]);
455 lptap(struct ifnet *ifp, struct mbuf *m)
457 u_int32_t af = AF_INET;
458 bpf_mtap2(ifp->if_bpf, &af, sizeof(af), m);
464 device_t dev = (device_t)arg;
465 device_t ppbus = device_get_parent(dev);
466 struct lp_data *sc = DEVTOSOFTC(dev);
474 if (sc->sc_ifp->if_flags & IFF_LINK0) {
476 /* Ack. the request */
477 ppb_wdtr(ppbus, 0x01);
479 /* Get the packet length */
480 j = clpinbyte(LPMAXSPIN2, ppbus);
484 j = clpinbyte(LPMAXSPIN2, ppbus);
487 len = len + (j << 8);
488 if (len > sc->sc_ifp->if_mtu + MLPIPHDRLEN)
494 j = clpinbyte(LPMAXSPIN2, ppbus);
500 /* Get and ignore checksum */
501 j = clpinbyte(LPMAXSPIN2, ppbus);
506 len = bp - sc->sc_ifbuf;
507 if (len <= CLPIPHDRLEN)
513 sc->sc_ifp->if_ipackets++;
514 sc->sc_ifp->if_ibytes += len;
515 top = m_devget(sc->sc_ifbuf + CLPIPHDRLEN, len, 0, sc->sc_ifp, 0);
517 if (bpf_peers_present(sc->sc_ifp->if_bpf))
518 lptap(sc->sc_ifp, top);
519 netisr_queue(NETISR_IP, top); /* mbuf is free'd on failure. */
523 while ((ppb_rstr(ppbus) & LPIP_SHAKE)) {
524 len = sc->sc_ifp->if_mtu + LPIPHDRLEN;
528 cl = ppb_rstr(ppbus);
532 while((ppb_rstr(ppbus) & LPIP_SHAKE))
538 *bp++= trecvh[cl] | trecvl[c];
541 while (!((cl=ppb_rstr(ppbus)) & LPIP_SHAKE)) {
543 (((cl = ppb_rstr(ppbus)) ^ 0xb8) & 0xf8) ==
551 len = bp - sc->sc_ifbuf;
552 if (len <= LPIPHDRLEN)
558 sc->sc_ifp->if_ipackets++;
559 sc->sc_ifp->if_ibytes += len;
560 top = m_devget(sc->sc_ifbuf + LPIPHDRLEN, len, 0, sc->sc_ifp, 0);
562 if (bpf_peers_present(sc->sc_ifp->if_bpf))
563 lptap(sc->sc_ifp, top);
564 netisr_queue(NETISR_IP, top); /* mbuf is free'd on failure. */
572 sc->sc_ifp->if_ierrors++;
576 * We are not able to send receive anything for now,
577 * so stop wasting our time
579 if (sc->sc_iferrs > LPMAXERRS) {
580 printf("lp%d: Too many errors, Going off-line.\n", device_get_unit(dev));
581 ppb_wctr(ppbus, 0x00);
582 sc->sc_ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
592 lpoutbyte (u_char byte, int spin, device_t ppbus)
594 ppb_wdtr(ppbus, txmith[byte]);
595 while (!(ppb_rstr(ppbus) & LPIP_SHAKE))
598 ppb_wdtr(ppbus, txmitl[byte]);
599 while (ppb_rstr(ppbus) & LPIP_SHAKE)
606 lpoutput (struct ifnet *ifp, struct mbuf *m,
607 struct sockaddr *dst, struct rtentry *rt)
609 device_t dev = UNITODEVICE(ifp->if_dunit);
610 device_t ppbus = device_get_parent(dev);
618 /* We need a sensible value if we abort */
620 ifp->if_drv_flags |= IFF_DRV_RUNNING;
622 err = 1; /* assume we're aborting because of an error */
626 /* Suspend (on laptops) or receive-errors might have taken us offline */
627 ppb_wctr(ppbus, IRQENABLE);
629 if (ifp->if_flags & IFF_LINK0) {
631 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
636 /* Alert other end to pending packet */
638 ppb_wdtr(ppbus, 0x08);
639 while ((ppb_rstr(ppbus) & 0x08) == 0)
644 /* Calculate length of packet, then send that */
646 count += 14; /* Ethernet header len */
649 for (mm = m; mm; mm = mm->m_next) {
652 if (clpoutbyte(count & 0xFF, LPMAXSPIN1, ppbus))
654 if (clpoutbyte((count >> 8) & 0xFF, LPMAXSPIN1, ppbus))
657 /* Send dummy ethernet header */
658 for (i = 0; i < 12; i++) {
659 if (clpoutbyte(i, LPMAXSPIN1, ppbus))
664 if (clpoutbyte(0x08, LPMAXSPIN1, ppbus))
666 if (clpoutbyte(0x00, LPMAXSPIN1, ppbus))
668 chksum += 0x08 + 0x00; /* Add into checksum */
672 cp = mtod(mm, u_char *);
676 if (clpoutbyte(*cp++, LPMAXSPIN2, ppbus))
679 } while ((mm = mm->m_next));
682 if (clpoutbyte(chksum, LPMAXSPIN2, ppbus))
688 err = 0; /* No errors */
691 if (err) { /* if we didn't timeout... */
696 ifp->if_obytes += m->m_pkthdr.len;
697 if (bpf_peers_present(ifp->if_bpf))
703 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
711 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
716 if (lpoutbyte(0x08, LPMAXSPIN1, ppbus))
718 if (lpoutbyte(0x00, LPMAXSPIN2, ppbus))
723 cp = mtod(mm,u_char *);
726 if (lpoutbyte(*cp++, LPMAXSPIN2, ppbus))
728 } while ((mm = mm->m_next));
730 err = 0; /* no errors were encountered */
734 ppb_wdtr(ppbus, txmitl[*cp] ^ 0x17);
736 if (err) { /* if we didn't timeout... */
741 ifp->if_obytes += m->m_pkthdr.len;
742 if (bpf_peers_present(ifp->if_bpf))
748 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
757 static device_method_t lp_methods[] = {
758 /* device interface */
759 DEVMETHOD(device_identify, lp_identify),
760 DEVMETHOD(device_probe, lp_probe),
761 DEVMETHOD(device_attach, lp_attach),
766 static driver_t lp_driver = {
769 sizeof(struct lp_data),
772 DRIVER_MODULE(plip, ppbus, lp_driver, lp_devclass, 0, 0);
773 MODULE_DEPEND(plip, ppbus, 1, 1, 1);