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