2 .\" The Aerospace Corporation. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AEROSPACE CORPORATION ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AEROSPACE CORPORATION BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd standard interface to IEEE 802.11 devices
41 .In net/if_ieee80211.h
43 This section describes the interface standard interface to configuration
44 and status information on IEEE 802.11 devices.
45 Most devices support options not configurable by this interface.
46 They must be set by their respective, specific control program.
47 The interface is via one
51 .Bl -tag -width ".Dv SIOCG80211"
53 Get configuration or status information.
55 Set configuration information.
58 These requests are made via a modified
61 This structure is defined as follows:
64 char i_name[IFNAMSIZ]; /* if_name, e.g. "wi0" */
65 u_int16_t i_type; /* req type */
66 int16_t i_val; /* Index or simple value */
67 int16_t i_len; /* Index or simple value */
68 void *i_data; /* Extra data */
74 the following values of
77 .Bl -tag -width ".Dv IEEE80211_IOC_POWERSAVESLEEP"
78 .It Dv IEEE80211_IOC_SSID
79 Returns the requested SSID by copying it into the buffer pointed to by
86 is \(>= 0 then the request refers to the configured value for that slot.
87 Generally, 0 is the only valid value, but some interfaces support more
91 is \-1 then the request refers to the currently active value.
92 .It Dv IEEE80211_IOC_NUMSSIDS
93 Returns the number of SSIDs this card supports.
94 In most cases, this is
95 1, but some devices such as
98 .It Dv IEEE80211_IOC_WEP
99 Returns the current WEP status in
102 .Dv IEEE80211_WEP_NOSUP , IEEE80211_WEP_ON , IEEE80211_WEP_OFF ,
104 .Dv IEEE80211_WEP_MIXED .
105 Respectively, these values mean unsupported, mandatory for all devices,
106 off, and on, but not required for all devices.
107 .It Dv IEEE80211_IOC_WEPKEY
108 Returns the requested WEP key via
112 If the device does not support returning the WEP key or the user is not
113 root then the key may be returned as all zeros.
114 Technically this is a
115 valid key, but it's the kind of key an idiot would put on his luggage so
116 we use it as a special value.
117 Generally, only four WEP keys are allowed, but some devices support more.
118 If so, the first four (0-3) are
119 the standard keys stored in volatile storage and the others are device
121 .It Dv IEEE80211_IOC_NUMWEPKEYS
122 Returns the number of WEP keys supported by this device, generally 4.
123 A device that does not support WEP may either report 0 or simply return
125 .It Dv IEEE80211_IOC_WEPTXKEY
126 Returns the WEP key used for transmission.
127 .It Dv IEEE80211_IOC_AUTHMODE
128 Returns the current authentication mode in
131 .Dv IEEE80211_AUTH_NONE , IEEE80211_AUTH_OPEN ,
133 .Dv IEEE80211_AUTH_SHARED .
134 .It Dv IEEE80211_IOC_STATIONNAME
135 Returns the station name via
139 While all known devices seem to support this in some way or another,
140 they all do it differently and it appears to not have anything to do
141 with the actual IEEE 802.11 standard so making up an answer may be
142 necessary for future devices.
143 .It Dv IEEE80211_IOC_CHANNEL
144 Returns the current direct sequence spread spectrum channel in use.
145 .It Dv IEEE80211_IOC_POWERSAVE
146 Returns the current powersaving mode.
148 .Dv IEEE80211_POWERSAVE_NOSUP , IEEE80211_POWERSAVE_OFF ,
149 .Dv IEEE80211_POWERSAVE_ON , IEEE80211_POWERSAVE_CAM ,
150 .Dv IEEE80211_POWERSAVE_PSP ,
152 .Dv IEEE80211_POWERSAVE_PSP_CAM .
154 .Dv IEEE80211_POWERSAVE_ON
155 is defined to be equal to
156 .Dv IEEE80211_POWERSAVE_CAM ,
157 but this may be incorrect.
158 .It Dv IEEE80211_IOC_POWERSAVESLEEP
159 Returns the powersave sleep time in msec in
165 the following values of
168 .Bl -tag -width ".Dv IEEE80211_IOC_POWERSAVESLEEP"
169 .It Dv IEEE80211_IOC_SSID
170 Set the desired SSID for infrastructure and ad-hoc modes to value given
175 The length should be no longer than 32 characters.
176 .It Dv IEEE80211_IOC_WEP
177 Set the current WEP mode to the value given in
179 Valid values are the same as those for this value above.
181 do not support all modes may choose to either return
183 or choose a reasonable alternate (supported) setting.
184 .It Dv IEEE80211_IOC_WEPKEY
185 Set the WEP key indicated by
187 to the value given by
191 Generally, valid values of
193 are 0, 5, and 13 though not all devices with WEP support have support
195 .It Dv IEEE80211_IOC_WEPTXKEY
196 Set the WEP key used for transmission to the value in
198 Not all values which are valid for setting keys may be valid for setting
199 transmit keys due to strange device interfaces.
200 .It Dv IEEE80211_IOC_AUTHMODE
201 Set the current authorization mode to the value given in
203 Valid values are given above.
204 Not all devices support this.
205 .It Dv IEEE80211_IOC_STATIONNAME
206 Set the station name to the value given by
210 The standard does not appear to deal with this feature so the range of
211 valid values may vary from device to device.
212 .It Dv IEEE80211_IOC_CHANNEL
213 Set the desired ad-hoc channel to the value given by
215 On some devices this has an impact on infrastructure mode as well.
216 Valid values are 1-14, but 0 should be allowed and should return the
217 device to the default value.
218 May devices support this directly by
219 converting any invalid value to the default value.
220 .It Dv IEEE80211_IOC_POWERSAVE
221 Set the current powersaving mode to the value given in
223 Valid values are the same as those for this value above.
225 do not support all modes may choose to either return
227 or choose a reasonable alternate (supported) setting.
230 .It Dv IEEE80211_IOC_POWERSAVESLEEP
231 Set the powersave sleep time in msec to the value in