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
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
86 #include <sys/param.h>
87 #include <sys/systm.h>
88 #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/clock.h>
98 #include <machine/bus.h>
99 #include <machine/resource.h>
100 #include <sys/rman.h>
103 #include <net/if_types.h>
104 #include <net/netisr.h>
106 #include <netinet/in.h>
107 #include <netinet/in_var.h>
111 #include <dev/ppbus/ppbconf.h>
112 #include "ppbus_if.h"
113 #include <dev/ppbus/ppbio.h>
115 #ifndef LPMTU /* MTU for the lp# interfaces */
119 #ifndef LPMAXSPIN1 /* DELAY factor for the lp# interfaces */
120 #define LPMAXSPIN1 8000 /* Spinning for remote intr to happen */
123 #ifndef LPMAXSPIN2 /* DELAY factor for the lp# interfaces */
124 #define LPMAXSPIN2 500 /* Spinning for remote handshake to happen */
127 #ifndef LPMAXERRS /* Max errors before !RUNNING */
128 #define LPMAXERRS 100
131 #define CLPIPHDRLEN 14 /* We send dummy ethernet addresses (two) + packet type in front of packet */
132 #define CLPIP_SHAKE 0x80 /* This bit toggles between nibble reception */
133 #define MLPIPHDRLEN CLPIPHDRLEN
135 #define LPIPHDRLEN 2 /* We send 0x08, 0x00 in front of packet */
136 #define LPIP_SHAKE 0x40 /* This bit toggles between nibble reception */
137 #if !defined(MLPIPHDRLEN) || LPIPHDRLEN > MLPIPHDRLEN
138 #define MLPIPHDRLEN LPIPHDRLEN
141 #define LPIPTBLSIZE 256 /* Size of octet translation table */
143 #define lprintf if (lptflag) printf
146 static int volatile lptflag = 1;
148 static int volatile lptflag = 0;
152 unsigned short lp_unit;
158 struct resource *res_irq;
161 /* Tables for the lp# interface */
162 static u_char *txmith;
163 #define txmitl (txmith+(1*LPIPTBLSIZE))
164 #define trecvh (txmith+(2*LPIPTBLSIZE))
165 #define trecvl (txmith+(3*LPIPTBLSIZE))
167 static u_char *ctxmith;
168 #define ctxmitl (ctxmith+(1*LPIPTBLSIZE))
169 #define ctrecvh (ctxmith+(2*LPIPTBLSIZE))
170 #define ctrecvl (ctxmith+(3*LPIPTBLSIZE))
172 /* Functions for the lp# interface */
173 static int lp_probe(device_t dev);
174 static int lp_attach(device_t dev);
176 static int lpinittables(void);
177 static int lpioctl(struct ifnet *, u_long, caddr_t);
178 static int lpoutput(struct ifnet *, struct mbuf *, struct sockaddr *,
180 static void lp_intr(void *);
182 #define DEVTOSOFTC(dev) \
183 ((struct lp_data *)device_get_softc(dev))
184 #define UNITOSOFTC(unit) \
185 ((struct lp_data *)devclass_get_softc(lp_devclass, (unit)))
186 #define UNITODEVICE(unit) \
187 (devclass_get_device(lp_devclass, (unit)))
189 static devclass_t lp_devclass;
191 static device_method_t lp_methods[] = {
192 /* device interface */
193 DEVMETHOD(device_probe, lp_probe),
194 DEVMETHOD(device_attach, lp_attach),
199 static driver_t lp_driver = {
202 sizeof(struct lp_data),
209 lp_probe(device_t dev)
211 device_t ppbus = device_get_parent(dev);
215 lp = DEVTOSOFTC(dev);
216 bzero(lp, sizeof(struct lp_data));
218 /* retrieve the ppbus irq */
219 BUS_READ_IVAR(ppbus, dev, PPBUS_IVAR_IRQ, &irq);
221 /* if we haven't interrupts, the probe fails */
223 device_printf(dev, "not an interrupt driven port, failed.\n");
227 /* reserve the interrupt resource, expecting irq is available to continue */
228 lp->res_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &zero, irq, irq, 1,
230 if (lp->res_irq == 0) {
231 device_printf(dev, "cannot reserve interrupt, failed.\n");
236 * lp dependent initialisation.
238 lp->lp_unit = device_get_unit(dev);
240 device_set_desc(dev, "PLIP network interface");
246 lp_attach (device_t dev)
248 struct lp_data *lp = DEVTOSOFTC(dev);
249 struct ifnet *ifp = &lp->sc_if;
253 ifp->if_unit = device_get_unit(dev);
255 ifp->if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST;
256 ifp->if_ioctl = lpioctl;
257 ifp->if_output = lpoutput;
258 ifp->if_type = IFT_PARA;
261 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
264 bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
269 * Build the translation tables for the LPIP (BSD unix) protocol.
270 * We don't want to calculate these nasties in our tight loop, so we
271 * precalculate them when we initialize.
279 txmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_NOWAIT);
285 ctxmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_NOWAIT);
290 for (i=0; i < LPIPTBLSIZE; i++) {
291 ctxmith[i] = (i & 0xF0) >> 4;
292 ctxmitl[i] = 0x10 | (i & 0x0F);
293 ctrecvh[i] = (i & 0x78) << 1;
294 ctrecvl[i] = (i & 0x78) >> 3;
297 for (i=0; i < LPIPTBLSIZE; i++) {
298 txmith[i] = ((i & 0x80) >> 3) | ((i & 0x70) >> 4) | 0x08;
299 txmitl[i] = ((i & 0x08) << 1) | (i & 0x07);
300 trecvh[i] = ((~i) & 0x80) | ((i & 0x38) << 1);
301 trecvl[i] = (((~i) & 0x80) >> 4) | ((i & 0x38) >> 3);
308 * Process an ioctl request.
312 lpioctl (struct ifnet *ifp, u_long cmd, caddr_t data)
314 device_t dev = UNITODEVICE(ifp->if_unit);
315 device_t ppbus = device_get_parent(dev);
316 struct lp_data *sc = DEVTOSOFTC(dev);
317 struct ifaddr *ifa = (struct ifaddr *)data;
318 struct ifreq *ifr = (struct ifreq *)data;
328 if (ifa->ifa_addr->sa_family != AF_INET)
331 ifp->if_flags |= IFF_UP;
334 if ((!(ifp->if_flags & IFF_UP)) && (ifp->if_flags & IFF_RUNNING)) {
336 ppb_wctr(ppbus, 0x00);
337 ifp->if_flags &= ~IFF_RUNNING;
339 /* IFF_UP is not set, try to release the bus anyway */
340 ppb_release_bus(ppbus, dev);
343 if (((ifp->if_flags & IFF_UP)) && (!(ifp->if_flags & IFF_RUNNING))) {
346 * Should the request be interruptible?
348 if ((error = ppb_request_bus(ppbus, dev, PPB_WAIT|PPB_INTR)))
351 /* Now IFF_UP means that we own the bus */
353 ppb_set_mode(ppbus, PPB_COMPATIBLE);
355 if (lpinittables()) {
356 ppb_release_bus(ppbus, dev);
360 sc->sc_ifbuf = malloc(sc->sc_if.if_mtu + MLPIPHDRLEN,
363 ppb_release_bus(ppbus, dev);
367 /* attach our interrupt handler, later detached when the bus is released */
368 if ((error = BUS_SETUP_INTR(ppbus, dev, sc->res_irq,
369 INTR_TYPE_NET, lp_intr, dev, &ih))) {
370 ppb_release_bus(ppbus, dev);
374 ppb_wctr(ppbus, IRQENABLE);
375 ifp->if_flags |= IFF_RUNNING;
381 sc->sc_ifbuf = malloc(ifr->ifr_mtu+MLPIPHDRLEN, M_DEVBUF, M_NOWAIT);
388 sc->sc_if.if_mtu = ifr->ifr_mtu;
392 ifr->ifr_mtu = sc->sc_if.if_mtu;
398 return EAFNOSUPPORT; /* XXX */
400 switch (ifr->ifr_addr.sa_family) {
412 * No ifmedia support at this stage; maybe use it
413 * in future for eg. protocol selection.
418 lprintf("LP:ioctl(0x%lx)\n", cmd);
425 clpoutbyte (u_char byte, int spin, device_t ppbus)
427 ppb_wdtr(ppbus, ctxmitl[byte]);
428 while (ppb_rstr(ppbus) & CLPIP_SHAKE)
432 ppb_wdtr(ppbus, ctxmith[byte]);
433 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
441 clpinbyte (int spin, device_t ppbus)
445 while((ppb_rstr(ppbus) & CLPIP_SHAKE))
449 cl = ppb_rstr(ppbus);
450 ppb_wdtr(ppbus, 0x10);
452 while(!(ppb_rstr(ppbus) & CLPIP_SHAKE))
457 ppb_wdtr(ppbus, 0x00);
459 return (ctrecvl[cl] | ctrecvh[c]);
463 lptap(struct ifnet *ifp, struct mbuf *m)
466 * Send a packet through bpf. We need to prepend the address family
467 * as a four byte field. Cons up a dummy header to pacify bpf. This
468 * is safe because bpf will only read from the mbuf (i.e., it won't
469 * try to free it or keep a pointer to it).
471 u_int32_t af = AF_INET;
475 m0.m_len = sizeof(u_int32_t);
476 m0.m_data = (char *)⁡
483 device_t dev = (device_t)arg;
484 device_t ppbus = device_get_parent(dev);
485 struct lp_data *sc = DEVTOSOFTC(dev);
493 if (sc->sc_if.if_flags & IFF_LINK0) {
495 /* Ack. the request */
496 ppb_wdtr(ppbus, 0x01);
498 /* Get the packet length */
499 j = clpinbyte(LPMAXSPIN2, ppbus);
503 j = clpinbyte(LPMAXSPIN2, ppbus);
506 len = len + (j << 8);
507 if (len > sc->sc_if.if_mtu + MLPIPHDRLEN)
513 j = clpinbyte(LPMAXSPIN2, ppbus);
519 /* Get and ignore checksum */
520 j = clpinbyte(LPMAXSPIN2, ppbus);
525 len = bp - sc->sc_ifbuf;
526 if (len <= CLPIPHDRLEN)
531 if (IF_QFULL(&ipintrq)) {
537 sc->sc_if.if_ipackets++;
538 sc->sc_if.if_ibytes += len;
539 top = m_devget(sc->sc_ifbuf + CLPIPHDRLEN, len, 0, &sc->sc_if, 0);
541 if (sc->sc_if.if_bpf)
542 lptap(&sc->sc_if, top);
543 IF_ENQUEUE(&ipintrq, top);
544 schednetisr(NETISR_IP);
548 while ((ppb_rstr(ppbus) & LPIP_SHAKE)) {
549 len = sc->sc_if.if_mtu + LPIPHDRLEN;
553 cl = ppb_rstr(ppbus);
557 while((ppb_rstr(ppbus) & LPIP_SHAKE))
563 *bp++= trecvh[cl] | trecvl[c];
566 while (!((cl=ppb_rstr(ppbus)) & LPIP_SHAKE)) {
568 (((cl = ppb_rstr(ppbus)) ^ 0xb8) & 0xf8) ==
576 len = bp - sc->sc_ifbuf;
577 if (len <= LPIPHDRLEN)
582 if (IF_QFULL(&ipintrq)) {
588 sc->sc_if.if_ipackets++;
589 sc->sc_if.if_ibytes += len;
590 top = m_devget(sc->sc_ifbuf + LPIPHDRLEN, len, 0, &sc->sc_if, 0);
592 if (sc->sc_if.if_bpf)
593 lptap(&sc->sc_if, top);
594 IF_ENQUEUE(&ipintrq, top);
595 schednetisr(NETISR_IP);
603 sc->sc_if.if_ierrors++;
607 * We are not able to send receive anything for now,
608 * so stop wasting our time
610 if (sc->sc_iferrs > LPMAXERRS) {
611 printf("lp%d: Too many errors, Going off-line.\n", device_get_unit(dev));
612 ppb_wctr(ppbus, 0x00);
613 sc->sc_if.if_flags &= ~IFF_RUNNING;
623 lpoutbyte (u_char byte, int spin, device_t ppbus)
625 ppb_wdtr(ppbus, txmith[byte]);
626 while (!(ppb_rstr(ppbus) & LPIP_SHAKE))
629 ppb_wdtr(ppbus, txmitl[byte]);
630 while (ppb_rstr(ppbus) & LPIP_SHAKE)
637 lpoutput (struct ifnet *ifp, struct mbuf *m,
638 struct sockaddr *dst, struct rtentry *rt)
640 device_t dev = UNITODEVICE(ifp->if_unit);
641 device_t ppbus = device_get_parent(dev);
649 /* We need a sensible value if we abort */
651 ifp->if_flags |= IFF_RUNNING;
653 err = 1; /* assume we're aborting because of an error */
657 /* Suspend (on laptops) or receive-errors might have taken us offline */
658 ppb_wctr(ppbus, IRQENABLE);
660 if (ifp->if_flags & IFF_LINK0) {
662 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
667 /* Alert other end to pending packet */
669 ppb_wdtr(ppbus, 0x08);
670 while ((ppb_rstr(ppbus) & 0x08) == 0)
675 /* Calculate length of packet, then send that */
677 count += 14; /* Ethernet header len */
680 for (mm = m; mm; mm = mm->m_next) {
683 if (clpoutbyte(count & 0xFF, LPMAXSPIN1, ppbus))
685 if (clpoutbyte((count >> 8) & 0xFF, LPMAXSPIN1, ppbus))
688 /* Send dummy ethernet header */
689 for (i = 0; i < 12; i++) {
690 if (clpoutbyte(i, LPMAXSPIN1, ppbus))
695 if (clpoutbyte(0x08, LPMAXSPIN1, ppbus))
697 if (clpoutbyte(0x00, LPMAXSPIN1, ppbus))
699 chksum += 0x08 + 0x00; /* Add into checksum */
703 cp = mtod(mm, u_char *);
707 if (clpoutbyte(*cp++, LPMAXSPIN2, ppbus))
710 } while ((mm = mm->m_next));
713 if (clpoutbyte(chksum, LPMAXSPIN2, ppbus))
719 err = 0; /* No errors */
722 if (err) { /* if we didn't timeout... */
727 ifp->if_obytes += m->m_pkthdr.len;
734 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
742 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
747 if (lpoutbyte(0x08, LPMAXSPIN1, ppbus))
749 if (lpoutbyte(0x00, LPMAXSPIN2, ppbus))
754 cp = mtod(mm,u_char *);
757 if (lpoutbyte(*cp++, LPMAXSPIN2, ppbus))
759 } while ((mm = mm->m_next));
761 err = 0; /* no errors were encountered */
765 ppb_wdtr(ppbus, txmitl[*cp] ^ 0x17);
767 if (err) { /* if we didn't timeout... */
772 ifp->if_obytes += m->m_pkthdr.len;
779 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
788 DRIVER_MODULE(plip, ppbus, lp_driver, lp_devclass, 0, 0);
790 #endif /* NPLIP > 0 */