usr.sbin/wlconfig/wlconfig.8

   1 .\" $FreeBSD$
   2 .\"
   3 .Dd December 26, 1996
   4 .Dt WLCONFIG 8 i386
   5 .Os
   6 .Sh NAME
   7 .Nm wlconfig
   8 .Nd read/write wavelan config parameters
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Ar ifname
  12 .Op Ar param value ...
  13 .Sh DESCRIPTION
  14 The
  15 .Nm
  16 utility can be used to read and set parameters for the NCR/AT&T Wavelan
  17 radio LAN card.
  18 Various parameters stored in the non-volatile Parameter
  19 Storage Area (PSA) on the card can be modified with this program, replacing
  20 the DOS-based
  21 .Nm instconf.exe
  22 program.
  23 It can also be used to interrogate the optional signal
  24 strength cache which may have been compiled into the driver.
  25 .Pp
  26 The
  27 .Ar ifname
  28 parameter specifies the wavelan interface name (eg.
  29 .Pa wl0 ) .
  30 If no other arguments are supplied, the current contents of the PSA
  31 are interpreted and displayed.
  32 .Pp
  33 The
  34 .Ar param
  35 and
  36 .Ar value
  37 arguments can be used to change the value of several parameters.
  38 Any number of
  39 .Ar param value
  40 pairs may be supplied.
  41 .Bl -tag -width 15n -offset indent
  42 .It Va param
  43 .Va value
  44 .It irq
  45 IRQ value (used at next reset), may be one of 3,4,5,6,10,11,12,15.
  46 .It mac
  47 Local MAC value (ethernet address).
  48 .It macsel
  49 .Sq soft
  50 (as set by the
  51 .Sq mac
  52 parameter) or
  53 .Sq default
  54 (as set at the factory).
  55 .It nwid
  56 The NWID is a 2-byte parameter passed to the card's radio modem.
  57 NWIDs allow multiple logically discrete networks to operate
  58 independently whilst occupying the same airspace.
  59 Packets with a different NWID are simply ignored by the modem.
  60 In the hardware, NWIDs are stored long-term in non-volatile memory
  61 (called the PSA or programmable storage area), and are loaded by
  62 software into the radio modem when the driver is
  63 initialized.
  64 This sets the default NWID loaded at startup.
  65 .It currnwid
  66 This sets the current operating NWID (but does not save it to the
  67 PSA).
  68 .It cache
  69 The driver may maintain a per interface fixed size cache of signal strength,
  70 silence, and quality levels, which are indexed by sender MAC addresses.
  71 Input packets are stored in the cache, and when received, the values
  72 stored in the radio modem are interrogated and stored.
  73 There are also two sysctl values (iponly and multicast only) which
  74 can be used for filtering out some input packets.
  75 By default, the
  76 cache mechanism stores only non-unicast IP packets, but this can
  77 be changed with
  78 .Xr sysctl 8 .
  79 Each non-filtered
  80 input packet causes a cache update, hence one can monitor
  81 the antennae signal strength to a remote system.
  82 There are three commands that can be given as values:
  83 .Sq raw ,
  84 which prints out the raw signal strength data as found in the radio
  85 modem hardware value,
  86 .Sq scale ,
  87 which scales the raw hardware values to 0..100%, and
  88 .Sq zero
  89 which clears out the cache in case you want to store new samples.
  90 .El
  91 .Pp
  92 Note that if the IRQ on the Wavelan card is incorrect, the interface
  93 will be configured, but will not function.
  94 The
  95 .Nm
  96 utility should then be used to reconfigure the card to a sensible
  97 value.
  98 .Sh EXAMPLES
  99 Set the NWID to 0x1234:
 100 .Bd -literal -offset indent
 101 # wlconfig wl0 nwid 0x1234
 102 .Ed
 103 .Pp
 104 Show the current settings:
 105 .Bd -literal -offset indent
 106 # wlconfig wl0
 107 Board type            : ISA
 108 Base address options  : 0x300, 0x390, 0x3c0, 0x3e0
 109 Waitstates            : 0
 110 Bus mode              : ISA
 111 IRQ                   : 10
 112 Default MAC address   : 08:00:0e:20:3d:4b
 113 Soft MAC address      : 00:00:00:00:00:00
 114 Current MAC address   : Default
 115 Adapter compatibility : PC-AT 2.4GHz
 116 Threshold preset      : 1
 117 Call code required    : NO
 118 Subband               : 2425MHz
 119 Quality threshold     : 3
 120 Hardware version      : 0 (Rel1/Rel2)
 121 Network ID enable     : YES
 122 NWID                  : 0xdead
 123 Datalink security     : NO
 124 Databus width         : 16 (variable)
 125 Configuration state   : unconfigured
 126 CRC-16                : 0x3c26
 127 CRC status            : OK
 128 .Ed
 129 .Pp
 130 Print a scaled version of the signal strength cache:
 131 .Bd -literal -offset indent
 132 # wlconfig wl0 cache scale
 133 .Ed
 134 .Sh SEE ALSO
 135 .Xr wl 4 ,
 136 .Xr sysctl 8
 137 .Sh HISTORY
 138 This implementation of the
 139 .Nm
 140 utility is completely new, written for Hilink Internet by
 141 .An Michael Smith ,
 142 and updated by
 143 .An Jim Binkley &c .