usr.sbin/wlconfig/wlconfig.8

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