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