share/man/man4/lp.4

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 1996 A.R.Gordon, andrew.gordon@net-tel.co.uk
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     Id: man4.i386/lp.4,v 1.9 1999/02/14 12:06:16 nsouch Exp
  31 .\" $FreeBSD: src/share/man/man4/lp.4,v 1.5.2.3 2000/12/29 10:18:00 ru Exp $
  32 .\"
  33 .Dd March 4, 1996
  34 .Dt LP 4
  35 .Os
  36 .Sh NAME
  37 .Nm lp
  38 .Nd printer port Internet Protocol driver
  39 .Sh SYNOPSIS
  40 .Nm ifconfig
  41 .Ar lp0
  42 .Ar myaddress hisaddress
  43 .Op Fl link0
  44 .Pp
  45 .Cd "device ppbus"
  46 .Cd "device plip"
  47 .Cd "device ppc0 at isa? port? irq 7"
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver allows a PC parallel printer port to be used as a
  52 point-to-point network interface between two similarly configured systems.
  53 Data is transferred 4 bits at a time, using the printer status lines for
  54 input: hence there is no requirement for special bidirectional hardware
  55 and any standard AT-compatible printer port with working interrupts may be used.
  56 .Pp
  57 During the boot process, for each
  58 .Nm plip
  59 device which is probed and has an interrupt assigned, a corresponding
  60 .Nm network
  61 device is created.
  62 .Pp
  63 Configuring an
  64 .Nm
  65 device with
  66 .Xr ifconfig 8
  67 causes the corresponding
  68 .Nm parallel port bus
  69 to be reserved for PLIP until the network interface is configured 'down'.
  70 .Pp
  71 The communication protocol is selected by the
  72 .Cm link0
  73 flag:
  74 .Bl -tag -width Fl
  75 .It Fl link0
  76 (default) Use
  77 .Dx
  78 mode (LPIP).  This is the simpler of the two modes
  79 and therefore slightly more efficient.
  80 .It Cm link0
  81 Use Crynwr/Linux compatible mode (CLPIP).  This mode has a simulated ethernet
  82 packet header, and is easier to interface to other types of equipment.
  83 .El
  84 .Pp
  85 The interface MTU defaults to 1500, but may be set to any value.  Both ends
  86 of the link must be configured with the same MTU.
  87 .Ss Cable Connections
  88 The cable connecting the two parallel ports should be wired as follows:
  89 .Bd -literal
  90         Pin     Pin     Description
  91         2       15      Data0 -> ERROR*
  92         3       13      Data1 -> SLCT
  93         4       12      Data2 -> PE
  94         5       10      Data3 -> ACK*
  95         6       11      Data4 -> BUSY
  96         15      2       ERROR* -> Data0
  97         13      3       SLCT   -> Data1
  98         12      4       PE     -> Data2
  99         10      5       ACK*   -> Data3
 100         11      6       BUSY   -> Data4
 101         18-25   18-25   Ground
 102 .Ed
 103 .Pp
 104 Cables with this wiring are widely available as 'Laplink' cables, and
 105 are often coloured yellow.
 106 .Pp
 107 The connections are symmetric, and provide 5 lines in each direction (four
 108 data plus one handshake).  The two modes use the same wiring, but make a
 109 different choice of which line to use as handshake.
 110 .Ss LPIP mode
 111 The signal lines are used as follows:
 112 .Bl -tag -width dataxxxx(Pinxx)
 113 .It Em Data0 (Pin 2)
 114 Data out, bit 0.
 115 .It Em Data1 (Pin 3)
 116 Data out, bit 1.
 117 .It Em Data2 (Pin 4)
 118 Data out, bit 2.
 119 .It Em Data3 (Pin 5)
 120 Handshake out.
 121 .It Em Data4 (Pin 6)
 122 Data out, bit 3.
 123 .It Em ERROR* (pin 15)
 124 Data in, bit 0.
 125 .It Em SLCT (pin 13)
 126 Data in, bit 1.
 127 .It Em PE (pin 12)
 128 Data in, bit 2.
 129 .It Em BUSY (pin 11)
 130 Data in, bit 3.
 131 .It Em ACK* (pin 10)
 132 Handshake in.
 133 .El
 134 .Pp
 135 When idle, all data lines are at zero.  Each byte is signalled in four steps:
 136 sender writes the 4 most significant bits and raises the handshake line;
 137 receiver reads the 4 bits and raises its handshake to acknowledge;
 138 sender places the 4 least significant bits on the data lines and lowers
 139 the handshake; receiver reads the data and lowers its handshake.
 140 .Pp
 141 The packet format has a two-byte header, comprising the fixed values 0x08,
 142 0x00, immediately followed by the IP header and data.
 143 .Pp
 144 The start of a packet is indicated by simply signalling the first byte
 145 of the header.  The end of the packet is indicated by inverting
 146 the data lines (ie. writing the ones-complement of the previous nibble
 147 to be transmitted) without changing the state of the handshake.
 148 .Pp
 149 Note that the end-of-packet marker assumes that the handshake signal and
 150 the data-out bits can be written in a single instruction - otherwise
 151 certain byte values in the packet data would falsely be interpreted
 152 as end-of-packet.  This is not a problem for the PC printer port,
 153 but requires care when implementing this protocol on other equipment.
 154 .Ss Crynwr/Linux CLPIP mode
 155 The signal lines are used as follows:
 156 .Bl -tag -width dataxxxx(Pinxx)
 157 .It Em Data0 (Pin 2)
 158 Data out, bit 0.
 159 .It Em Data1 (Pin 3)
 160 Data out, bit 1.
 161 .It Em Data2 (Pin 4)
 162 Data out, bit 2.
 163 .It Em Data3 (Pin 5)
 164 Data out, bit 3.
 165 .It Em Data4 (Pin 6)
 166 Handshake out.
 167 .It Em ERROR* (pin 15)
 168 Data in, bit 0.
 169 .It Em SLCT (pin 13)
 170 Data in, bit 1.
 171 .It Em PE (pin 12)
 172 Data in, bit 2.
 173 .It Em ACK* (pin 10)
 174 Data in, bit 3.
 175 .It Em BUSY (pin 11)
 176 Handshake in.
 177 .El
 178 .Pp
 179 When idle, all data lines are at zero.  Each byte is signalled in four steps:
 180 sender writes the 4 least significant bits and raises the handshake line;
 181 receiver reads the 4 bits and raises its handshake to acknowledge;
 182 sender places the 4 most significant bits on the data lines and lowers
 183 the handshake; receiver reads the data and lowers its handshake.
 184 [Note that this is the opposite nibble order to LPIP mode].
 185 .Pp
 186 Packet format is:
 187 .Bd -literal
 188 Length (least significant byte)
 189 Length (most significant byte)
 190 12 bytes of supposed MAC addresses (ignored by
 191 .Dx Ns ).
 192 Fixed byte 0x08
 193 Fixed byte 0x00
 194 <IP datagram>
 195 Checksum byte.
 196 .Ed
 197 .Pp
 198 The length includes the 14 header bytes, but not the length bytes themselves
 199 nor the checksum byte.
 200 .Pp
 201 The checksum is a simple arithmetic sum of all the bytes (again, including
 202 the header but not checksum or length bytes).
 203 .Dx
 204 calculates
 205 outgoing checksums, but does not validate incoming ones.
 206 .Pp
 207 The start of packet has to be signalled specially, since the line chosen
 208 for handshake-in cannot be used to generate an interrupt.  The sender
 209 writes the value 0x08 to the data lines, and waits for the receiver
 210 to respond by writing 0x01 to its data lines.  The sender then starts
 211 signalling the first byte of the packet (the length byte).
 212 .Pp
 213 End of packet is deduced from the packet length and is not signalled
 214 specially (although the data lines are restored to the zero, idle
 215 state to avoid spuriously indicating the start of the next packet).
 216 .Sh SEE ALSO
 217 .Xr ppbus 4 ,
 218 .Xr ppc 4 ,
 219 .Xr ifconfig 8
 220 .Sh BUGS
 221 Busy-waiting loops are used while handshaking bytes, (and worse still when
 222 waiting for the receiving system to respond to an interrupt for the start
 223 of a packet).  Hence a fast system talking to a slow one will consume
 224 excessive amounts of CPU.  This is unavoidable in the case of CLPIP mode
 225 due to the choice of handshake lines; it could theoretically be improved
 226 in the case of LPIP mode.
 227 .Pp
 228 Polling timeouts are controlled by counting loop iterations rather than
 229 timers, and so are dependent on CPU speed.  This is somewhat stabilised
 230 by the need to perform (slow) ISA bus cycles to actually read the port.