share/man/man4/strip.4

   1 .\" $NetBSD: strip.4,v 1.13 2004/12/05 13:24:10 peter Exp $
   2 .\"
   3 .\" Copyright 1996 The Board of Trustees of The Leland Stanford
   4 .\" Junior University. All Rights Reserved.
   5 .\"
   6 .\" Author: Jonathan Stone
   7 .\"
   8 .\" Permission to use, copy, modify, and distribute this
   9 .\" software and its documentation for any purpose and without
  10 .\" fee is hereby granted, provided that the above copyright
  11 .\" notice and the above authorship notice appear in all copies.
  12 .\" Stanford University makes no representations about the suitability
  13 .\" of this software for any purpose.  It is provided "as is" without
  14 .\" express or implied warranty.
  15 .Dd December 5, 2004
  16 .Dt STRIP 4
  17 .Os
  18 .Sh NAME
  19 .Nm strip
  20 .Nd Metricom Ricochet packet radio wireless network device
  21 .Sh SYNOPSIS
  22 .Cd pseudo-device strip
  23 .Sh DESCRIPTION
  24 The
  25 .Nm
  26 driver takes outbound network packets, encapsulates them using the
  27 .Tn Metricom
  28 .Qq star mode
  29 framing, and sends the packets out an
  30 .Tn RS-232
  31 interface to a
  32 .Tn Metricom
  33 .Em Ricochet
  34 packet radio.
  35 Packets arriving from the packet radio via the serial link are decapsulated
  36 and then passed up to the local host's networking stack.
  37 .Pp
  38 .Nm
  39 is an acronym for
  40 .Sy ST Ns armode
  41 .Sy R Ns adio
  42 .Sy IP .
  43 .Pp
  44 The
  45 .Nm
  46 interfaces can be created by using the
  47 .Xr ifconfig 8
  48 .Cm create
  49 command.
  50 Each
  51 .Nm
  52 interface is a pseudo-device driver for the
  53 .Tn Metricom
  54 .Em Ricochet
  55 packet radio, operating in peer-to-peer packet mode.
  56 .Pp
  57 In many ways,
  58 the
  59 .Nm
  60 driver is very much like the
  61 .Xr sl 4
  62 SLIP pseudo-device driver.
  63 A
  64 .Nm
  65 device is attached to a tty line with
  66 .Xr slattach 8 .
  67 Once attached, the interface is configured via
  68 .Xr ifconfig 8 .
  69 The major difference between the
  70 .Xr sl 4
  71 SLIP pseudo-device driver and the
  72 .Nm
  73 driver is that SLIP works only between two hosts over
  74 a dedicated point-to-point connection.
  75 .Pp
  76 In contrast,
  77 .Nm
  78 sends packets to a frequency-hopping packet radio, which can address
  79 packets to any peer
  80 .Tn Metricom
  81 .Em Ricochet
  82 packet radio, rather than just to a single host at the other end
  83 of a point-to-point line.
  84 Thus, one
  85 .Nm
  86 pseudo-device is usually sufficient for any kernel.
  87 .Pp
  88 In other respects, a
  89 .Nm
  90 interface is rather like an
  91 .Tn Ethernet
  92 interface.
  93 Packets are individually addressed, and subsequent packets can
  94 be sent independently to different MAC addresses.
  95 However, the
  96 .Qq star mode
  97 framing and MAC addressing are not in any way compatible with
  98 .Tn Ethernet .
  99 Broadcast or multicast to more than one packet radio is not possible,
 100 due to the independent frequency-hopping operation of the packet radios.
 101 The interface flags
 102 .Dv IFF_POINTOPOINT
 103 and
 104 .Dv IFF_BROADCAST
 105 are not supported on the
 106 .Nm
 107 interface.
 108 .Pp
 109 In other words,
 110 .Nm
 111 implements a multiple-access, non-broadcast device, accessed via
 112 an RS-232 serial line, using a proprietary packet framing scheme.
 113 .Pp
 114 This version of the
 115 .Nm
 116 driver maps
 117 .Tn IP
 118 addresses to
 119 .Tn Metricom
 120 .Em Ricochet
 121 packet radio addresses using statically configured entries in the
 122 normal routing table.
 123 These entries map
 124 .Tn IP
 125 addresses of peer packet radios to the MAC-level addresses.
 126 The exact syntax of this mapping and an example are discussed below.
 127 The Internet Assigned Numbers Authority
 128 .Pq Tn IANA
 129 has allocated an
 130 .Tn ARP
 131 type code for use with STRIP.
 132 A future version of this driver will support
 133 .Xr arp 4
 134 to obtain the
 135 .Tn IP
 136 address of reachable peer packet radios dynamically.
 137 .Sh ADDRESS CONFIGURATION
 138 This version of the STRIP driver requires static pre-configuration of
 139 the mapping from
 140 .Tn IP
 141 addresses to packet radio MAC addresses.
 142 The
 143 .Xr route 8
 144 command should be used to bind a peer STRIP host's packet radio
 145 .Tn IP
 146 address to the peer's link-level packet radio address.
 147 .Pp
 148 Radio addresses are encoded using the hex equivalent of the packet
 149 radio's decimal
 150 .Tn ASCII
 151 address.
 152 For example, the following route command will configure a routing
 153 entry to a packet radio with a MAC address of 1234-5678, and an
 154 .Tn IP
 155 address 10.11.12.13, reachable via the
 156 .Em strip0
 157 interface:
 158 .Pp
 159 .Bd -literal -offset indent
 160 .Ic route add -host 10.11.12.13 -link strip0:1:2:3:4:5:6:7:8
 161 .Ed
 162 .Pp
 163 Generalising from this example to other
 164 .Tn IP
 165 addresses and to other 8-digit MAC addresses should be clear.
 166 .Sh RADIO CONFIGURATION
 167 The
 168 .Tn Metricom
 169 .Em Ricochet
 170 packet radios can auto-baud at speeds up to 38.4K baud.
 171 At higher speeds -- 57600 or 115200 -- the packet radio cannot autobaud.
 172 When running at high speeds, the packet radio's serial port should be
 173 manually configured to permanently run at the desired speed.
 174 Use a terminal emulator and the Hayes command
 175 .Ic ATS304=115200
 176 to set the serial baudrate to the specified number (or 0 for autobaud).
 177 The command
 178 .Ic AT\*[Am]W
 179 will then save the current packet radio state in non-volatile memory.
 180 .Pp
 181 .Tn Metricom
 182 .Em Ricochet
 183 packet radios can operate in either
 184 .Dq modem-emulation
 185 mode or in packet mode (i.e.
 186 .Qq star mode ) .
 187 The
 188 .Nm
 189 driver automatically detects if the packet radio has fallen out of
 190 .Qq star mode ,
 191 and resets it back into
 192 .Qq star mode ,
 193 if the baud rate was set correctly by
 194 .Xr slattach 8 .
 195 .\" .Sh DIAGNOSTICS
 196 .Sh SEE ALSO
 197 .Xr arp 4 ,
 198 .Xr inet 4 ,
 199 .Xr sl 4 ,
 200 .Xr ifconfig 8 ,
 201 .Xr route 8 ,
 202 .Xr slattach 8
 203 .Sh HISTORY
 204 .Nm
 205 was originally developed for the
 206 .Tn Linux
 207 kernel by Stuart Cheshire of Stanford's Operating Systems and
 208 Networking group, as part of Mary Baker's MosquitoNet
 209 .Sy http://mosquitonet.stanford.edu/mosquitonet.html
 210 project.
 211 .Pp
 212 This
 213 .Nm
 214 driver was ported to
 215 .Nx
 216 by Jonathan Stone at Stanford's Distributed Systems Group and first
 217 distributed with
 218 .Nx 1.2 .
 219 .Sh BUGS
 220 Currently,
 221 .Nm
 222 is IP-only.
 223 Encapsulations for
 224 .Tn AppleTalk
 225 and
 226 .Tn ARP
 227 have been defined, but are not yet implemented in this driver.
 228 .Pp
 229 .Nm
 230 has not been widely tested on a variety of lower-level serial drivers.
 231 .Pp
 232 The detection and resetting of packet radios that crash out of
 233 .Qq star mode
 234 does not always work in this version of the driver.
 235 One workaround is to kill the
 236 .Xr slattach 8
 237 process,
 238 .Xr ifconfig 8
 239 the
 240 .Nm
 241 interface down, and then start a new slattach and rerun ifconfig
 242 to enable the interface again.