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 July 8, 2017
  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 DEPRECATION NOTICE
  41 The
  42 .Nm
  43 driver will be removed in
  44 .Fx 12.0 .
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 driver controls a radio lan card system made originally by
  49 NCR, then ATT, now Lucent.
  50 The system is spread-spectrum radio
  51 at around 915 MHz (or 2.4 GHz).
  52 With the supplied omni-directional antennae,
  53 about 400 feet (indoors, more outdoors) can be covered in circumference.
  54 This card can talk to the companion (wlp0) pccard.
  55 Speeds vary
  56 from 1 megabit to theoretically 2 megabits (roughly T1 in speed).
  57 .Pp
  58 The card has three fundamental hardware
  59 units, a so-called PSA or programmable storage area, a radio modem,
  60 and a Ethernet lan controller.
  61 The latter component is the
  62 ancient (and not very honorable) Intel 82586 Ethernet chip.
  63 Fundamentally it appears to the operating system as an Ethernet system,
  64 and speaks IEEE MAC addresses.
  65 The radio modem simply translates
  66 Ethernet packets to/from radio packets, that are either at 2.4 GHz
  67 or 915 MHz depending on the radio modem.
  68 It supports a collision
  69 avoidance scheme.
  70 The lan controller
  71 supports promiscuous mode, broadcast, and multicasting
  72 (although there is a glitch
  73 in the latter).
  74 "It thinks it is Ethernet".
  75 .Pp
  76 How it is used
  77 depends on the kind of antennae deployed with it.
  78 Point to point
  79 applications are possible as are Ethernet-like lan use.
  80 The vendor
  81 ships an omni-directional antennae that works in the
  82 vicinity of 400 feet (indoors).
  83 Point to point antennae can be purchased that will go miles.
  84 .Sh SETUP
  85 The card can either be initialized with the vendor supplied DOS setup software.
  86 Typically minimally an IRQ, port, and Network ID must be supplied.
  87 Michael Smith's
  88 .Xr wlconfig 8
  89 utility can now be used to do this work from
  90 the UNIX side.
  91 The card is "not" plug and play.
  92 The network id controls whether one set of cards can hear another.
  93 If different, cards will read physical packets, but they will be discarded
  94 by the radio modem.
  95 .Sh CONTROL
  96 In addition to the config utility, there are several sysctl
  97 switches that can be used to modify runtime parameters.
  98 The
  99 .Xr sysctl 8
 100 variables are as follows:
 101 .Bl -diag
 102 .It "machdep.wl_xmit_delay <useconds>"
 103 This variable will cause the driver to insert a delay on transmit.
 104 250 is the default.
 105 The delay should probably be a bit longer
 106 on faster cpus and less on slower cpus.
 107 It exists because the 82586
 108 was not designed to work with Pentium-speed cpu systems and if overdriven
 109 will have copious xmit side errors.
 110 .It machdep.wl_ignore_nwid <0 | 1>
 111 This switch defaults to 0; i.e., the nwid is not ignored.
 112 It can
 113 be set to 1 to cause the nwid to not be used.
 114 This may be useful
 115 when the device is in promiscuous mode as one can watch for all
 116 packets and ignore nwid differences.
 117 .It machdep.wl_xmit_watch <milliseconds>
 118 This switch is not currently useful.
 119 .It machdep.wl_gather_snr <milliseconds>
 120 This switch is not currently useful.
 121 .Pp
 122 There is also a signal strength cache in the driver.
 123 It may be interrogated
 124 with
 125 .Xr wlconfig 8 .
 126 Incoming packets
 127 are checked for certain hardware radio-modem values including signal
 128 strength, silence, and quality, which range fro 0..63, 0..63, and 0..15
 129 respectively.
 130 Thus one can read out signal strenth values to see
 131 how close/far peer nodes are.
 132 The signal strength cache is indexed by
 133 sender MAC address.
 134 There are two sysctls that change how it filters packets.
 135 Both are on
 136 by default.
 137 .It machdep.wl_wlcache_mcastonly <0 | 1>
 138 By default this switch is on.
 139 It forces the cache to filter out
 140 unicast packets.
 141 Only broadcast or multicast packets are accepted.
 142 .It machdep.wl_wlcache_iponly <0 | 1>
 143 By default this switch is on.
 144 It forces the driver to discard non-IP
 145 packets and also stores the IP src address.
 146 ARP packets are ignored,
 147 as are any other network protocol barring IPv4 packets.
 148 .El
 149 .Sh SEE ALSO
 150 .Xr sysctl 8 ,
 151 .Xr wlconfig 8
 152 .Pp
 153 .Pa http://www.wavelan.com
 154 .Sh HISTORY
 155 The
 156 .Nm
 157 driver was written by
 158 .An Anders Klemets
 159 (thousands of years ago?) and
 160 appears to be based on an even older Intel 82586 driver.
 161 The 82586
 162 controller was one of the first (if not the first?) integrated lan
 163 controller on the block.
 164 That does not mean it was the best either.
 165 Anders ported and or created a driver for the ISA wavelan and PCCARD
 166 wavelan system too (wlp).
 167 .An Robert T. Morris, Jr.
 168 ported the Mach drivers to BSDI.
 169 .An Jim Binkley
 170 ported them to
 171 .Fx 2.1 .
 172 .An Michael Smith
 173 ported the wl driver only to 2.2.2.
 174 Jim and Michael have been
 175 maintaining them.
 176 The current state of the driver is NOT ANYONE'S
 177 FAULT.
 178 Thanks to
 179 .An Bernie Doehner
 180 and
 181 .An Robert Buaas
 182 for contributions.
 183 .Sh AUTHORS
 184 Too numerous to mention.
 185 See above.
 186 .Sh CAVEATS
 187 The 82586 has numerous defects.
 188 It may experience transmit-side
 189 errors when modern faster cpus send packets at it faster than it can handle.
 190 The driver (and probably the chip) does not support an all multicast mode.
 191 As a result, it can be used with applications like
 192 .Xr mrouted 8 Pq Pa ports/net/mrouted ,
 193 but it must go into promiscuous mode for that to work.
 194 The driver
 195 is slow to change modes from "normal" to promiscuous mode, presumably
 196 due to delays in the configuration code.