usr.sbin/wlconfig/wlconfig.8

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