share/man/man4/man4.i386/wl.4

   1 .\"
   2 .\" Copyright (c) 1997, Jim Binkley
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   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.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by Jim Binkley
  16 .\" 4. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .Dd September 29, 2006
  33 .Dt WL 4 i386
  34 .Os
  35 .Sh NAME
  36 .Nm wl
  37 .Nd T1 speed ISA/radio lan card
  38 .Sh SYNOPSIS
  39 .Cd "device wl0 at isa? port 0x300 irq 5"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver controls a radio lan card system made originally by
  44 NCR, then ATT, now Lucent.
  45 The system is spread-spectrum radio
  46 at around 915 MHz (or 2.4 GHz).
  47 With the supplied omni-directional antennae,
  48 about 400 feet (indoors, more outdoors) can be covered in circumference.
  49 This card can talk to the companion (wlp0) pccard.
  50 Speeds vary
  51 from 1 megabit to theoretically 2 megabits (roughly T1 in speed).
  52 .Pp
  53 The card has three fundamental hardware
  54 units, a so-called PSA or programmable storage area, a radio modem,
  55 and a Ethernet lan controller.
  56 The latter component is the
  57 ancient (and not very honorable) Intel 82586 Ethernet chip.
  58 Fundamentally it appears to the operating system as an Ethernet system,
  59 and speaks IEEE MAC addresses.
  60 The radio modem simply translates
  61 Ethernet packets to/from radio packets, that are either at 2.4 GHz
  62 or 915 MHz depending on the radio modem.
  63 It supports a collision
  64 avoidance scheme.
  65 The lan controller
  66 supports promiscuous mode, broadcast, and multicasting
  67 (although there is a glitch
  68 in the latter).
  69 "It thinks it is Ethernet".
  70 .Pp
  71 How it is used
  72 depends on the kind of antennae deployed with it.
  73 Point to point
  74 applications are possible as are Ethernet-like lan use.
  75 The vendor
  76 ships an omni-directional antennae that works in the
  77 vicinity of 400 feet (indoors).
  78 Point to point antennae can be purchased that will go miles.
  79 .Sh SETUP
  80 The card can either be initialized with the vendor supplied DOS setup software.
  81 Typically minimally an IRQ, port, and Network ID must be supplied.
  82 Michael Smith's
  83 .Xr wlconfig 8
  84 utility can now be used to do this work from
  85 the UNIX side.
  86 The card is "not" plug and play.
  87 The network id controls whether one set of cards can hear another.
  88 If different, cards will read physical packets, but they will be discarded
  89 by the radio modem.
  90 .Sh CONTROL
  91 In addition to the config utility, there are several sysctl
  92 switches that can be used to modify runtime parameters.
  93 The
  94 .Xr sysctl 8
  95 variables are as follows:
  96 .Bl -diag
  97 .It "machdep.wl_xmit_delay <useconds>"
  98 This variable will cause the driver to insert a delay on transmit.
  99 250 is the default.
 100 The delay should probably be a bit longer
 101 on faster cpus and less on slower cpus.
 102 It exists because the 82586
 103 was not designed to work with Pentium-speed cpu systems and if overdriven
 104 will have copious xmit side errors.
 105 .It machdep.wl_ignore_nwid <0 | 1>
 106 This switch defaults to 0; i.e., the nwid is not ignored.
 107 It can
 108 be set to 1 to cause the nwid to not be used.
 109 This may be useful
 110 when the device is in promiscuous mode as one can watch for all
 111 packets and ignore nwid differences.
 112 .It machdep.wl_xmit_watch <milliseconds>
 113 This switch is not currently useful.
 114 .It machdep.wl_gather_snr <milliseconds>
 115 This switch is not currently useful.
 116 .Pp
 117 There is also a signal strength cache in the driver.
 118 It may be interrogated
 119 with
 120 .Xr wlconfig 8 .
 121 Incoming packets
 122 are checked for certain hardware radio-modem values including signal
 123 strength, silence, and quality, which range fro 0..63, 0..63, and 0..15
 124 respectively.
 125 Thus one can read out signal strenth values to see
 126 how close/far peer nodes are.
 127 The signal strength cache is indexed by
 128 sender MAC address.
 129 There are two sysctls that change how it filters packets.
 130 Both are on
 131 by default.
 132 .It machdep.wl_wlcache_mcastonly <0 | 1>
 133 By default this switch is on.
 134 It forces the cache to filter out
 135 unicast packets.
 136 Only broadcast or multicast packets are accepted.
 137 .It machdep.wl_wlcache_iponly <0 | 1>
 138 By default this switch is on.
 139 It forces the driver to discard non-IP
 140 packets and also stores the IP src address.
 141 ARP packets are ignored,
 142 as are any other network protocol barring IPv4 packets.
 143 .El
 144 .Sh SEE ALSO
 145 .Xr sysctl 8 ,
 146 .Xr wlconfig 8
 147 .Pp
 148 .Pa http://www.wavelan.com
 149 .Sh HISTORY
 150 The
 151 .Nm
 152 driver was written by
 153 .An Anders Klemets
 154 (thousands of years ago?) and
 155 appears to be based on an even older Intel 82586 driver.
 156 The 82586
 157 controller was one of the first (if not the first?) integrated lan
 158 controller on the block.
 159 That does not mean it was the best either.
 160 Anders ported and or created a driver for the ISA wavelan and PCCARD
 161 wavelan system too (wlp).
 162 .An Robert T. Morris, Jr.
 163 ported the Mach drivers to BSDI.
 164 .An Jim Binkley
 165 ported them to
 166 .Fx 2.1 .
 167 .An Michael Smith
 168 ported the wl driver only to 2.2.2.
 169 Jim and Michael have been
 170 maintaining them.
 171 The current state of the driver is NOT ANYONE'S
 172 FAULT.
 173 Thanks to
 174 .An Bernie Doehner
 175 and
 176 .An Robert Buaas
 177 for contributions.
 178 .Sh AUTHORS
 179 Too numerous to mention.
 180 See above.
 181 .Sh CAVEATS
 182 The 82586 has numerous defects.
 183 It may experience transmit-side
 184 errors when modern faster cpus send packets at it faster than it can handle.
 185 The driver (and probably the chip) does not support an all multicast mode.
 186 As a result, it can be used with applications like
 187 .Xr mrouted 8 Pq Pa ports/net/mrouted ,
 188 but it must go into promiscuous mode for that to work.
 189 The driver
 190 is slow to change modes from "normal" to promiscuous mode, presumably
 191 due to delays in the configuration code.