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
83 #include <sys/param.h>
84 #include <sys/systm.h>
85 #include <sys/module.h>
89 #include <sys/socket.h>
90 #include <sys/sockio.h>
91 #include <sys/kernel.h>
92 #include <sys/malloc.h>
94 #include <machine/clock.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 unsigned short lp_unit;
155 struct resource *res_irq;
158 /* Tables for the lp# interface */
159 static u_char *txmith;
160 #define txmitl (txmith+(1*LPIPTBLSIZE))
161 #define trecvh (txmith+(2*LPIPTBLSIZE))
162 #define trecvl (txmith+(3*LPIPTBLSIZE))
164 static u_char *ctxmith;
165 #define ctxmitl (ctxmith+(1*LPIPTBLSIZE))
166 #define ctrecvh (ctxmith+(2*LPIPTBLSIZE))
167 #define ctrecvl (ctxmith+(3*LPIPTBLSIZE))
169 /* Functions for the lp# interface */
170 static int lpinittables(void);
171 static int lpioctl(struct ifnet *, u_long, caddr_t);
172 static int lpoutput(struct ifnet *, struct mbuf *, struct sockaddr *,
174 static void lp_intr(void *);
176 #define DEVTOSOFTC(dev) \
177 ((struct lp_data *)device_get_softc(dev))
178 #define UNITOSOFTC(unit) \
179 ((struct lp_data *)devclass_get_softc(lp_devclass, (unit)))
180 #define UNITODEVICE(unit) \
181 (devclass_get_device(lp_devclass, (unit)))
183 static devclass_t lp_devclass;
186 lp_identify(driver_t *driver, device_t parent)
189 BUS_ADD_CHILD(parent, 0, "plip", 0);
195 lp_probe(device_t dev)
197 device_t ppbus = device_get_parent(dev);
201 lp = DEVTOSOFTC(dev);
202 bzero(lp, sizeof(struct lp_data));
204 /* retrieve the ppbus irq */
205 BUS_READ_IVAR(ppbus, dev, PPBUS_IVAR_IRQ, &irq);
207 /* if we haven't interrupts, the probe fails */
209 device_printf(dev, "not an interrupt driven port, failed.\n");
213 /* reserve the interrupt resource, expecting irq is available to continue */
214 lp->res_irq = bus_alloc_resource(dev, SYS_RES_IRQ, &zero, irq, irq, 1,
216 if (lp->res_irq == 0) {
217 device_printf(dev, "cannot reserve interrupt, failed.\n");
222 * lp dependent initialisation.
224 lp->lp_unit = device_get_unit(dev);
226 device_set_desc(dev, "PLIP network interface");
232 lp_attach (device_t dev)
234 struct lp_data *lp = DEVTOSOFTC(dev);
235 struct ifnet *ifp = &lp->sc_if;
239 ifp->if_unit = device_get_unit(dev);
241 ifp->if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST;
242 ifp->if_ioctl = lpioctl;
243 ifp->if_output = lpoutput;
244 ifp->if_type = IFT_PARA;
247 ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
250 bpfattach(ifp, DLT_NULL, sizeof(u_int32_t));
255 * Build the translation tables for the LPIP (BSD unix) protocol.
256 * We don't want to calculate these nasties in our tight loop, so we
257 * precalculate them when we initialize.
265 txmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_NOWAIT);
271 ctxmith = malloc(4*LPIPTBLSIZE, M_DEVBUF, M_NOWAIT);
276 for (i=0; i < LPIPTBLSIZE; i++) {
277 ctxmith[i] = (i & 0xF0) >> 4;
278 ctxmitl[i] = 0x10 | (i & 0x0F);
279 ctrecvh[i] = (i & 0x78) << 1;
280 ctrecvl[i] = (i & 0x78) >> 3;
283 for (i=0; i < LPIPTBLSIZE; i++) {
284 txmith[i] = ((i & 0x80) >> 3) | ((i & 0x70) >> 4) | 0x08;
285 txmitl[i] = ((i & 0x08) << 1) | (i & 0x07);
286 trecvh[i] = ((~i) & 0x80) | ((i & 0x38) << 1);
287 trecvl[i] = (((~i) & 0x80) >> 4) | ((i & 0x38) >> 3);
294 * Process an ioctl request.
298 lpioctl (struct ifnet *ifp, u_long cmd, caddr_t data)
300 device_t dev = UNITODEVICE(ifp->if_unit);
301 device_t ppbus = device_get_parent(dev);
302 struct lp_data *sc = DEVTOSOFTC(dev);
303 struct ifaddr *ifa = (struct ifaddr *)data;
304 struct ifreq *ifr = (struct ifreq *)data;
314 if (ifa->ifa_addr->sa_family != AF_INET)
317 ifp->if_flags |= IFF_UP;
320 if ((!(ifp->if_flags & IFF_UP)) && (ifp->if_flags & IFF_RUNNING)) {
322 ppb_wctr(ppbus, 0x00);
323 ifp->if_flags &= ~IFF_RUNNING;
325 /* IFF_UP is not set, try to release the bus anyway */
326 ppb_release_bus(ppbus, dev);
329 if (((ifp->if_flags & IFF_UP)) && (!(ifp->if_flags & IFF_RUNNING))) {
332 * Should the request be interruptible?
334 if ((error = ppb_request_bus(ppbus, dev, PPB_WAIT|PPB_INTR)))
337 /* Now IFF_UP means that we own the bus */
339 ppb_set_mode(ppbus, PPB_COMPATIBLE);
341 if (lpinittables()) {
342 ppb_release_bus(ppbus, dev);
346 sc->sc_ifbuf = malloc(sc->sc_if.if_mtu + MLPIPHDRLEN,
349 ppb_release_bus(ppbus, dev);
353 /* attach our interrupt handler, later detached when the bus is released */
354 if ((error = BUS_SETUP_INTR(ppbus, dev, sc->res_irq,
355 INTR_TYPE_NET, lp_intr, dev, &ih))) {
356 ppb_release_bus(ppbus, dev);
360 ppb_wctr(ppbus, IRQENABLE);
361 ifp->if_flags |= IFF_RUNNING;
367 sc->sc_ifbuf = malloc(ifr->ifr_mtu+MLPIPHDRLEN, M_DEVBUF, M_NOWAIT);
374 sc->sc_if.if_mtu = ifr->ifr_mtu;
378 ifr->ifr_mtu = sc->sc_if.if_mtu;
384 return EAFNOSUPPORT; /* XXX */
386 switch (ifr->ifr_addr.sa_family) {
398 * No ifmedia support at this stage; maybe use it
399 * in future for eg. protocol selection.
404 lprintf("LP:ioctl(0x%lx)\n", cmd);
411 clpoutbyte (u_char byte, int spin, device_t ppbus)
413 ppb_wdtr(ppbus, ctxmitl[byte]);
414 while (ppb_rstr(ppbus) & CLPIP_SHAKE)
418 ppb_wdtr(ppbus, ctxmith[byte]);
419 while (!(ppb_rstr(ppbus) & CLPIP_SHAKE))
427 clpinbyte (int spin, device_t ppbus)
431 while((ppb_rstr(ppbus) & CLPIP_SHAKE))
435 cl = ppb_rstr(ppbus);
436 ppb_wdtr(ppbus, 0x10);
438 while(!(ppb_rstr(ppbus) & CLPIP_SHAKE))
443 ppb_wdtr(ppbus, 0x00);
445 return (ctrecvl[cl] | ctrecvh[c]);
449 lptap(struct ifnet *ifp, struct mbuf *m)
452 * Send a packet through bpf. We need to prepend the address family
453 * as a four byte field. Cons up a dummy header to pacify bpf. This
454 * is safe because bpf will only read from the mbuf (i.e., it won't
455 * try to free it or keep a pointer to it).
457 u_int32_t af = AF_INET;
461 m0.m_len = sizeof(u_int32_t);
462 m0.m_data = (char *)⁡
469 device_t dev = (device_t)arg;
470 device_t ppbus = device_get_parent(dev);
471 struct lp_data *sc = DEVTOSOFTC(dev);
479 if (sc->sc_if.if_flags & IFF_LINK0) {
481 /* Ack. the request */
482 ppb_wdtr(ppbus, 0x01);
484 /* Get the packet length */
485 j = clpinbyte(LPMAXSPIN2, ppbus);
489 j = clpinbyte(LPMAXSPIN2, ppbus);
492 len = len + (j << 8);
493 if (len > sc->sc_if.if_mtu + MLPIPHDRLEN)
499 j = clpinbyte(LPMAXSPIN2, ppbus);
505 /* Get and ignore checksum */
506 j = clpinbyte(LPMAXSPIN2, ppbus);
511 len = bp - sc->sc_ifbuf;
512 if (len <= CLPIPHDRLEN)
517 if (IF_QFULL(&ipintrq)) {
523 sc->sc_if.if_ipackets++;
524 sc->sc_if.if_ibytes += len;
525 top = m_devget(sc->sc_ifbuf + CLPIPHDRLEN, len, 0, &sc->sc_if, 0);
527 if (sc->sc_if.if_bpf)
528 lptap(&sc->sc_if, top);
529 IF_ENQUEUE(&ipintrq, top);
530 schednetisr(NETISR_IP);
534 while ((ppb_rstr(ppbus) & LPIP_SHAKE)) {
535 len = sc->sc_if.if_mtu + LPIPHDRLEN;
539 cl = ppb_rstr(ppbus);
543 while((ppb_rstr(ppbus) & LPIP_SHAKE))
549 *bp++= trecvh[cl] | trecvl[c];
552 while (!((cl=ppb_rstr(ppbus)) & LPIP_SHAKE)) {
554 (((cl = ppb_rstr(ppbus)) ^ 0xb8) & 0xf8) ==
562 len = bp - sc->sc_ifbuf;
563 if (len <= LPIPHDRLEN)
568 if (IF_QFULL(&ipintrq)) {
574 sc->sc_if.if_ipackets++;
575 sc->sc_if.if_ibytes += len;
576 top = m_devget(sc->sc_ifbuf + LPIPHDRLEN, len, 0, &sc->sc_if, 0);
578 if (sc->sc_if.if_bpf)
579 lptap(&sc->sc_if, top);
580 IF_ENQUEUE(&ipintrq, top);
581 schednetisr(NETISR_IP);
589 sc->sc_if.if_ierrors++;
593 * We are not able to send receive anything for now,
594 * so stop wasting our time
596 if (sc->sc_iferrs > LPMAXERRS) {
597 printf("lp%d: Too many errors, Going off-line.\n", device_get_unit(dev));
598 ppb_wctr(ppbus, 0x00);
599 sc->sc_if.if_flags &= ~IFF_RUNNING;
609 lpoutbyte (u_char byte, int spin, device_t ppbus)
611 ppb_wdtr(ppbus, txmith[byte]);
612 while (!(ppb_rstr(ppbus) & LPIP_SHAKE))
615 ppb_wdtr(ppbus, txmitl[byte]);
616 while (ppb_rstr(ppbus) & LPIP_SHAKE)
623 lpoutput (struct ifnet *ifp, struct mbuf *m,
624 struct sockaddr *dst, struct rtentry *rt)
626 device_t dev = UNITODEVICE(ifp->if_unit);
627 device_t ppbus = device_get_parent(dev);
635 /* We need a sensible value if we abort */
637 ifp->if_flags |= IFF_RUNNING;
639 err = 1; /* assume we're aborting because of an error */
643 /* Suspend (on laptops) or receive-errors might have taken us offline */
644 ppb_wctr(ppbus, IRQENABLE);
646 if (ifp->if_flags & IFF_LINK0) {
648 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
653 /* Alert other end to pending packet */
655 ppb_wdtr(ppbus, 0x08);
656 while ((ppb_rstr(ppbus) & 0x08) == 0)
661 /* Calculate length of packet, then send that */
663 count += 14; /* Ethernet header len */
666 for (mm = m; mm; mm = mm->m_next) {
669 if (clpoutbyte(count & 0xFF, LPMAXSPIN1, ppbus))
671 if (clpoutbyte((count >> 8) & 0xFF, LPMAXSPIN1, ppbus))
674 /* Send dummy ethernet header */
675 for (i = 0; i < 12; i++) {
676 if (clpoutbyte(i, LPMAXSPIN1, ppbus))
681 if (clpoutbyte(0x08, LPMAXSPIN1, ppbus))
683 if (clpoutbyte(0x00, LPMAXSPIN1, ppbus))
685 chksum += 0x08 + 0x00; /* Add into checksum */
689 cp = mtod(mm, u_char *);
693 if (clpoutbyte(*cp++, LPMAXSPIN2, ppbus))
696 } while ((mm = mm->m_next));
699 if (clpoutbyte(chksum, LPMAXSPIN2, ppbus))
705 err = 0; /* No errors */
708 if (err) { /* if we didn't timeout... */
713 ifp->if_obytes += m->m_pkthdr.len;
720 if (!(ppb_rstr(ppbus) & CLPIP_SHAKE)) {
728 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
733 if (lpoutbyte(0x08, LPMAXSPIN1, ppbus))
735 if (lpoutbyte(0x00, LPMAXSPIN2, ppbus))
740 cp = mtod(mm,u_char *);
743 if (lpoutbyte(*cp++, LPMAXSPIN2, ppbus))
745 } while ((mm = mm->m_next));
747 err = 0; /* no errors were encountered */
751 ppb_wdtr(ppbus, txmitl[*cp] ^ 0x17);
753 if (err) { /* if we didn't timeout... */
758 ifp->if_obytes += m->m_pkthdr.len;
765 if (ppb_rstr(ppbus) & LPIP_SHAKE) {
774 static device_method_t lp_methods[] = {
775 /* device interface */
776 DEVMETHOD(device_identify, lp_identify),
777 DEVMETHOD(device_probe, lp_probe),
778 DEVMETHOD(device_attach, lp_attach),
783 static driver_t lp_driver = {
786 sizeof(struct lp_data),
789 DRIVER_MODULE(plip, ppbus, lp_driver, lp_devclass, 0, 0);