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 $
31 * Parallel port TCP/IP interfaces added. I looked at the driver from
32 * MACH but this is a complete rewrite, and btw. incompatible, and it
33 * should perform better too. I have never run the MACH driver though.
35 * This driver sends two bytes (0x08, 0x00) in front of each packet,
36 * to allow us to distinguish another format later.
38 * Now added an Linux/Crynwr compatibility mode which is enabled using
39 * IF_LINK0 - Tim Wilkinson.
42 * Make HDLC/PPP mode, use IF_LLC1 to enable.
44 * Connect the two computers using a Laplink parallel cable to use this
47 * +----------------------------------------+
48 * |A-name A-End B-End Descr. Port/Bit |
49 * +----------------------------------------+
50 * |DATA0 2 15 Data 0/0x01 |
51 * |-ERROR 15 2 1/0x08 |
52 * +----------------------------------------+
53 * |DATA1 3 13 Data 0/0x02 |
54 * |+SLCT 13 3 1/0x10 |
55 * +----------------------------------------+
56 * |DATA2 4 12 Data 0/0x04 |
58 * +----------------------------------------+
59 * |DATA3 5 10 Strobe 0/0x08 |
61 * +----------------------------------------+
62 * |DATA4 6 11 Data 0/0x10 |
63 * |BUSY 11 6 1/~0x80 |
64 * +----------------------------------------+
65 * |GND 18-25 18-25 GND - |
66 * +----------------------------------------+
68 * Expect transfer-rates up to 75 kbyte/sec.
70 * If GCC could correctly grok
71 * register int port asm("edx")
72 * the code would be cleaner
74 * Poul-Henning Kamp <phk@freebsd.org>
78 * Update for ppbus, PLIP support only - Nicolas Souchu
83 #include <sys/param.h>
84 #include <sys/systm.h>
85 #include <sys/module.h>
88 #include <sys/socket.h>
89 #include <sys/sockio.h>
90 #include <sys/kernel.h>
91 #include <sys/malloc.h>
93 #include <sys/thread2.h>
95 #include <machine/clock.h>
98 #include <net/ifq_var.h>
99 #include <net/if_types.h>
100 #include <net/netisr.h>
102 #include <netinet/in.h>
103 #include <netinet/in_var.h>
107 #include <bus/ppbus/ppbconf.h>
108 #include "ppbus_if.h"
109 #include <bus/ppbus/ppbio.h>
111 #ifndef LPMTU /* MTU for the lp# interfaces */
115 #ifndef LPMAXSPIN1 /* DELAY factor for the lp# interfaces */
116 #define LPMAXSPIN1 8000 /* Spinning for remote intr to happen */
119 #ifndef LPMAXSPIN2 /* DELAY factor for the lp# interfaces */
120 #define LPMAXSPIN2 500 /* Spinning for remote handshake to happen */
123 #ifndef LPMAXERRS /* Max errors before !RUNNING */
124 #define LPMAXERRS 100
127 #define CLPIPHDRLEN 14 /* We send dummy ethernet addresses (two) + packet type in front of packet */
128 #define CLPIP_SHAKE 0x80 /* This bit toggles between nibble reception */
129 #define MLPIPHDRLEN CLPIPHDRLEN
131 #define LPIPHDRLEN 2 /* We send 0x08, 0x00 in front of packet */
132 #define LPIP_SHAKE 0x40 /* This bit toggles between nibble reception */
133 #if !defined(MLPIPHDRLEN) || LPIPHDRLEN > MLPIPHDRLEN
134 #define MLPIPHDRLEN LPIPHDRLEN
137 #define LPIPTBLSIZE 256 /* Size of octet translation table */
139 #define lprintf if (lptflag) kprintf
142 static int volatile lptflag = 1;
144 static int volatile lptflag = 0;
148 unsigned short lp_unit;
154 struct resource *res_irq;
157 /* Tables for the lp# interface */
158 static u_char *txmith;
159 #define txmitl (txmith+(1*LPIPTBLSIZE))
160 #define trecvh (txmith+(2*LPIPTBLSIZE))
161 #define trecvl (txmith+(3*LPIPTBLSIZE))
163 static u_char *ctxmith;
164 #define ctxmitl (ctxmith+(1*LPIPTBLSIZE))
165 #define ctrecvh (ctxmith+(2*LPIPTBLSIZE))
166 #define ctrecvl (ctxmith+(3*LPIPTBLSIZE))
168 /* Functions for the lp# interface */
169 static int lpinittables(void);
170 static int lpioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
171 static int lpoutput(struct ifnet *, struct mbuf *, struct sockaddr *,
173 static void lp_intr(void *);
175 #define DEVTOSOFTC(dev) \
176 ((struct lp_data *)device_get_softc(dev))
177 #define UNITOSOFTC(unit) \
178 ((struct lp_data *)devclass_get_softc(lp_devclass, (unit)))
179 #define UNITODEVICE(unit) \
180 (devclass_get_device(lp_devclass, (unit)))
182 static devclass_t lp_devclass;
188 lp_probe(device_t dev)
190 device_t ppbus = device_get_parent(dev);
195 lp = DEVTOSOFTC(dev);
197 /* retrieve the ppbus irq */
198 BUS_READ_IVAR(ppbus, dev, PPBUS_IVAR_IRQ, &irq);
200 /* if we haven't interrupts, the probe fails */
202 device_printf(dev, "not an interrupt driven port, failed.\n");
206 /* reserve the interrupt resource, expecting irq is available to continue */
207 lp->res_irq = bus_alloc_legacy_irq_resource(dev, &zero, irq,
209 if (lp->res_irq == 0) {
210 device_printf(dev, "cannot reserve interrupt, failed.\n");
215 * lp dependent initialisation.
217 lp->lp_unit = device_get_unit(dev);
219 device_set_desc(dev, "PLIP network interface");
225 lp_attach (device_t dev)
227 struct lp_data *lp = DEVTOSOFTC(dev);
228 struct ifnet *ifp = &lp->sc_if;
231 if_initname(ifp, "lp", device_get_unit(dev));
233 ifp->if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST;
234 ifp->if_ioctl = lpioctl;
235 ifp->if_output = lpoutput;
236 ifp->if_type = IFT_PARA;
239 ifq_set_maxlen(&ifp->if_snd, IFQ_MAXLEN);
240 if_attach(ifp, NULL);
242 bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
247 * Build the translation tables for the LPIP (BSD unix) protocol.
248 * We don't want to calculate these nasties in our tight loop, so we
249 * precalculate them when we initialize.
257 txmith = kmalloc(4*LPIPTBLSIZE, M_DEVBUF, M_WAITOK);
260 ctxmith = kmalloc(4*LPIPTBLSIZE, M_DEVBUF, M_WAITOK);
262 for (i=0; i < LPIPTBLSIZE; i++) {
263 ctxmith[i] = (i & 0xF0) >> 4;
264 ctxmitl[i] = 0x10 | (i & 0x0F);
265 ctrecvh[i] = (i & 0x78) << 1;
266 ctrecvl[i] = (i & 0x78) >> 3;
269 for (i=0; i < LPIPTBLSIZE; i++) {
270 txmith[i] = ((i & 0x80) >> 3) | ((i & 0x70) >> 4) | 0x08;
271 txmitl[i] = ((i & 0x08) << 1) | (i & 0x07);
272 trecvh[i] = ((~i) & 0x80) | ((i & 0x38) << 1);
273 trecvl[i] = (((~i) & 0x80) >> 4) | ((i & 0x38) >> 3);
280 * Process an ioctl request.
284 lpioctl (struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
286 device_t dev = UNITODEVICE(ifp->if_dunit);
287 device_t ppbus = device_get_parent(dev);
288 struct lp_data *sc = DEVTOSOFTC(dev);
289 struct ifaddr *ifa = (struct ifaddr *)data;
290 struct ifreq *ifr = (struct ifreq *)data;
300 if (ifa->ifa_addr->sa_family != AF_INET)
303 ifp->if_flags |= IFF_UP;
306 if ((!(ifp->if_flags & IFF_UP)) && (ifp->if_flags & IFF_RUNNING)) {
308 ppb_wctr(ppbus, 0x00);
309 ifp->if_flags &= ~IFF_RUNNING;
311 /* IFF_UP is not set, try to release the bus anyway */
312 ppb_release_bus(ppbus, dev);
315 if (((ifp->if_flags & IFF_UP)) && (!(ifp->if_flags & IFF_RUNNING))) {
318 * Should the request be interruptible?
320 if ((error = ppb_request_bus(ppbus, dev, PPB_WAIT|PPB_INTR)))
323 /* Now IFF_UP means that we own the bus */
325 ppb_set_mode(ppbus, PPB_COMPATIBLE);
327 if (lpinittables()) {
328 ppb_release_bus(ppbus, dev);
332 sc->sc_ifbuf = kmalloc(sc->sc_if.if_mtu + MLPIPHDRLEN,
335 /* attach our interrupt handler, later detached when the bus is released */
336 error = BUS_SETUP_INTR(ppbus, dev, sc->res_irq, 0,
337 lp_intr, dev, &ih, NULL);
339 ppb_release_bus(ppbus, dev);
343 ppb_wctr(ppbus, IRQENABLE);
344 ifp->if_flags |= IFF_RUNNING;
350 sc->sc_ifbuf = kmalloc(ifr->ifr_mtu+MLPIPHDRLEN, M_DEVBUF, M_WAITOK);
353 sc->sc_if.if_mtu = ifr->ifr_mtu;
357 ifr->ifr_mtu = sc->sc_if.if_mtu;
363 return EAFNOSUPPORT; /* XXX */
365 switch (ifr->ifr_addr.sa_family) {
377 * No ifmedia support at this stage; maybe use it
378 * in future for eg. protocol selection.
383 lprintf("LP:ioctl(0x%lx)\n", cmd);
390 clpoutbyte (u_char byte, int spin, device_t ppbus)
392 ppb_wdtr(ppbus, ctxmitl[byte]);
393 while (ppb_rstr(ppbus) & CLPIP_SHAKE)
397 ppb_wdtr(ppbus, ctxmith[byte]);
398 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
406 clpinbyte (int spin, device_t ppbus)
410 while((ppb_rstr(ppbus) & CLPIP_SHAKE))
414 cl = ppb_rstr(ppbus);
415 ppb_wdtr(ppbus, 0x10);
417 while(!(ppb_rstr(ppbus) & CLPIP_SHAKE))
422 ppb_wdtr(ppbus, 0x00);
424 return (ctrecvl[cl] | ctrecvh[c]);
428 lptap(struct ifnet *ifp, struct mbuf *m)
431 * We need to prepend the address family as a four byte field.
433 static const uint32_t af = AF_INET;
436 bpf_ptap(ifp->if_bpf, m, &af, sizeof(af));
442 device_t dev = (device_t)arg;
443 device_t ppbus = device_get_parent(dev);
444 struct lp_data *sc = DEVTOSOFTC(dev);
452 if (sc->sc_if.if_flags & IFF_LINK0) {
454 /* Ack. the request */
455 ppb_wdtr(ppbus, 0x01);
457 /* Get the packet length */
458 j = clpinbyte(LPMAXSPIN2, ppbus);
462 j = clpinbyte(LPMAXSPIN2, ppbus);
465 len = len + (j << 8);
466 if (len > sc->sc_if.if_mtu + MLPIPHDRLEN)
472 j = clpinbyte(LPMAXSPIN2, ppbus);
478 /* Get and ignore checksum */
479 j = clpinbyte(LPMAXSPIN2, ppbus);
484 len = bp - sc->sc_ifbuf;
485 if (len <= CLPIPHDRLEN)
491 sc->sc_if.if_ipackets++;
492 sc->sc_if.if_ibytes += len;
493 top = m_devget(sc->sc_ifbuf + CLPIPHDRLEN, len, 0, &sc->sc_if, 0);
495 if (sc->sc_if.if_bpf)
496 lptap(&sc->sc_if, top);
497 netisr_queue(NETISR_IP, top);
501 while ((ppb_rstr(ppbus) & LPIP_SHAKE)) {
502 len = sc->sc_if.if_mtu + LPIPHDRLEN;
506 cl = ppb_rstr(ppbus);
510 while((ppb_rstr(ppbus) & LPIP_SHAKE))
516 *bp++= trecvh[cl] | trecvl[c];
519 while (!((cl=ppb_rstr(ppbus)) & LPIP_SHAKE)) {
521 (((cl = ppb_rstr(ppbus)) ^ 0xb8) & 0xf8) ==
529 len = bp - sc->sc_ifbuf;
530 if (len <= LPIPHDRLEN)
536 sc->sc_if.if_ipackets++;
537 sc->sc_if.if_ibytes += len;
538 top = m_devget(sc->sc_ifbuf + LPIPHDRLEN, len, 0, &sc->sc_if, 0);
540 if (sc->sc_if.if_bpf)
541 lptap(&sc->sc_if, top);
542 netisr_queue(NETISR_IP, top);
550 sc->sc_if.if_ierrors++;
554 * We are not able to send receive anything for now,
555 * so stop wasting our time
557 if (sc->sc_iferrs > LPMAXERRS) {
558 kprintf("lp%d: Too many errors, Going off-line.\n", device_get_unit(dev));
559 ppb_wctr(ppbus, 0x00);
560 sc->sc_if.if_flags &= ~IFF_RUNNING;
570 lpoutbyte (u_char byte, int spin, device_t ppbus)
572 ppb_wdtr(ppbus, txmith[byte]);
573 while (!(ppb_rstr(ppbus) & LPIP_SHAKE))
576 ppb_wdtr(ppbus, txmitl[byte]);
577 while (ppb_rstr(ppbus) & LPIP_SHAKE)
584 lpoutput (struct ifnet *ifp, struct mbuf *m,
585 struct sockaddr *dst, struct rtentry *rt)
587 device_t dev = UNITODEVICE(ifp->if_dunit);
588 device_t ppbus = device_get_parent(dev);
596 /* We need a sensible value if we abort */
598 ifp->if_flags |= IFF_RUNNING;
600 err = 1; /* assume we're aborting because of an error */
604 /* Suspend (on laptops) or receive-errors might have taken us offline */
605 ppb_wctr(ppbus, IRQENABLE);
607 if (ifp->if_flags & IFF_LINK0) {
609 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
614 /* Alert other end to pending packet */
616 ppb_wdtr(ppbus, 0x08);
617 while ((ppb_rstr(ppbus) & 0x08) == 0)
622 /* Calculate length of packet, then send that */
624 count += 14; /* Ethernet header len */
627 for (mm = m; mm; mm = mm->m_next) {
630 if (clpoutbyte(count & 0xFF, LPMAXSPIN1, ppbus))
632 if (clpoutbyte((count >> 8) & 0xFF, LPMAXSPIN1, ppbus))
635 /* Send dummy ethernet header */
636 for (i = 0; i < 12; i++) {
637 if (clpoutbyte(i, LPMAXSPIN1, ppbus))
642 if (clpoutbyte(0x08, LPMAXSPIN1, ppbus))
644 if (clpoutbyte(0x00, LPMAXSPIN1, ppbus))
646 chksum += 0x08 + 0x00; /* Add into checksum */
650 cp = mtod(mm, u_char *);
654 if (clpoutbyte(*cp++, LPMAXSPIN2, ppbus))
657 } while ((mm = mm->m_next));
660 if (clpoutbyte(chksum, LPMAXSPIN2, ppbus))
666 err = 0; /* No errors */
669 if (err) { /* if we didn't timeout... */
674 ifp->if_obytes += m->m_pkthdr.len;
681 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
689 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
694 if (lpoutbyte(0x08, LPMAXSPIN1, ppbus))
696 if (lpoutbyte(0x00, LPMAXSPIN2, ppbus))
701 cp = mtod(mm,u_char *);
704 if (lpoutbyte(*cp++, LPMAXSPIN2, ppbus))
706 } while ((mm = mm->m_next));
708 err = 0; /* no errors were encountered */
712 ppb_wdtr(ppbus, txmitl[*cp] ^ 0x17);
714 if (err) { /* if we didn't timeout... */
719 ifp->if_obytes += m->m_pkthdr.len;
726 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
736 * Because plip is a static device that always exists under any attached
737 * ppbus device, and not scanned by the ppbus device, we need an identify
738 * function to install the device.
740 static device_method_t lp_methods[] = {
741 /* device interface */
742 DEVMETHOD(device_identify, bus_generic_identify),
743 DEVMETHOD(device_probe, lp_probe),
744 DEVMETHOD(device_attach, lp_attach),
749 static driver_t lp_driver = {
752 sizeof(struct lp_data),
755 DECLARE_DUMMY_MODULE(if_plip);
756 DRIVER_MODULE(if_plip, ppbus, lp_driver, lp_devclass, NULL, NULL);