]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * This file define a set of standard wireless extensions | |
3 | * | |
4 | * Version : 17 21.6.04 | |
5 | * | |
6 | * Authors : Jean Tourrilhes - HPL - <jt@hpl.hp.com> | |
7 | * Copyright (c) 1997-2004 Jean Tourrilhes, All Rights Reserved. | |
8 | */ | |
9 | ||
10 | #ifndef _LINUX_WIRELESS_H | |
11 | #define _LINUX_WIRELESS_H | |
12 | ||
13 | /************************** DOCUMENTATION **************************/ | |
14 | /* | |
15 | * Initial APIs (1996 -> onward) : | |
16 | * ----------------------------- | |
17 | * Basically, the wireless extensions are for now a set of standard ioctl | |
18 | * call + /proc/net/wireless | |
19 | * | |
20 | * The entry /proc/net/wireless give statistics and information on the | |
21 | * driver. | |
22 | * This is better than having each driver having its entry because | |
23 | * its centralised and we may remove the driver module safely. | |
24 | * | |
25 | * Ioctl are used to configure the driver and issue commands. This is | |
26 | * better than command line options of insmod because we may want to | |
27 | * change dynamically (while the driver is running) some parameters. | |
28 | * | |
29 | * The ioctl mechanimsm are copied from standard devices ioctl. | |
30 | * We have the list of command plus a structure descibing the | |
31 | * data exchanged... | |
32 | * Note that to add these ioctl, I was obliged to modify : | |
33 | * # net/core/dev.c (two place + add include) | |
34 | * # net/ipv4/af_inet.c (one place + add include) | |
35 | * | |
36 | * /proc/net/wireless is a copy of /proc/net/dev. | |
37 | * We have a structure for data passed from the driver to /proc/net/wireless | |
38 | * Too add this, I've modified : | |
39 | * # net/core/dev.c (two other places) | |
40 | * # include/linux/netdevice.h (one place) | |
41 | * # include/linux/proc_fs.h (one place) | |
42 | * | |
43 | * New driver API (2002 -> onward) : | |
44 | * ------------------------------- | |
45 | * This file is only concerned with the user space API and common definitions. | |
46 | * The new driver API is defined and documented in : | |
47 | * # include/net/iw_handler.h | |
48 | * | |
49 | * Note as well that /proc/net/wireless implementation has now moved in : | |
50 | * # net/core/wireless.c | |
51 | * | |
52 | * Wireless Events (2002 -> onward) : | |
53 | * -------------------------------- | |
54 | * Events are defined at the end of this file, and implemented in : | |
55 | * # net/core/wireless.c | |
56 | * | |
57 | * Other comments : | |
58 | * -------------- | |
59 | * Do not add here things that are redundant with other mechanisms | |
60 | * (drivers init, ifconfig, /proc/net/dev, ...) and with are not | |
61 | * wireless specific. | |
62 | * | |
63 | * These wireless extensions are not magic : each driver has to provide | |
64 | * support for them... | |
65 | * | |
66 | * IMPORTANT NOTE : As everything in the kernel, this is very much a | |
67 | * work in progress. Contact me if you have ideas of improvements... | |
68 | */ | |
69 | ||
70 | /***************************** INCLUDES *****************************/ | |
71 | ||
72 | /* To minimise problems in user space, I might remove those headers | |
73 | * at some point. Jean II */ | |
74 | #include <linux/types.h> /* for "caddr_t" et al */ | |
75 | #include <linux/socket.h> /* for "struct sockaddr" et al */ | |
76 | #include <linux/if.h> /* for IFNAMSIZ and co... */ | |
77 | ||
78 | /***************************** VERSION *****************************/ | |
79 | /* | |
80 | * This constant is used to know the availability of the wireless | |
81 | * extensions and to know which version of wireless extensions it is | |
82 | * (there is some stuff that will be added in the future...) | |
83 | * I just plan to increment with each new version. | |
84 | */ | |
85 | #define WIRELESS_EXT 17 | |
86 | ||
87 | /* | |
88 | * Changes : | |
89 | * | |
90 | * V2 to V3 | |
91 | * -------- | |
92 | * Alan Cox start some incompatibles changes. I've integrated a bit more. | |
93 | * - Encryption renamed to Encode to avoid US regulation problems | |
94 | * - Frequency changed from float to struct to avoid problems on old 386 | |
95 | * | |
96 | * V3 to V4 | |
97 | * -------- | |
98 | * - Add sensitivity | |
99 | * | |
100 | * V4 to V5 | |
101 | * -------- | |
102 | * - Missing encoding definitions in range | |
103 | * - Access points stuff | |
104 | * | |
105 | * V5 to V6 | |
106 | * -------- | |
107 | * - 802.11 support (ESSID ioctls) | |
108 | * | |
109 | * V6 to V7 | |
110 | * -------- | |
111 | * - define IW_ESSID_MAX_SIZE and IW_MAX_AP | |
112 | * | |
113 | * V7 to V8 | |
114 | * -------- | |
115 | * - Changed my e-mail address | |
116 | * - More 802.11 support (nickname, rate, rts, frag) | |
117 | * - List index in frequencies | |
118 | * | |
119 | * V8 to V9 | |
120 | * -------- | |
121 | * - Support for 'mode of operation' (ad-hoc, managed...) | |
122 | * - Support for unicast and multicast power saving | |
123 | * - Change encoding to support larger tokens (>64 bits) | |
124 | * - Updated iw_params (disable, flags) and use it for NWID | |
125 | * - Extracted iw_point from iwreq for clarity | |
126 | * | |
127 | * V9 to V10 | |
128 | * --------- | |
129 | * - Add PM capability to range structure | |
130 | * - Add PM modifier : MAX/MIN/RELATIVE | |
131 | * - Add encoding option : IW_ENCODE_NOKEY | |
132 | * - Add TxPower ioctls (work like TxRate) | |
133 | * | |
134 | * V10 to V11 | |
135 | * ---------- | |
136 | * - Add WE version in range (help backward/forward compatibility) | |
137 | * - Add retry ioctls (work like PM) | |
138 | * | |
139 | * V11 to V12 | |
140 | * ---------- | |
141 | * - Add SIOCSIWSTATS to get /proc/net/wireless programatically | |
142 | * - Add DEV PRIVATE IOCTL to avoid collisions in SIOCDEVPRIVATE space | |
143 | * - Add new statistics (frag, retry, beacon) | |
144 | * - Add average quality (for user space calibration) | |
145 | * | |
146 | * V12 to V13 | |
147 | * ---------- | |
148 | * - Document creation of new driver API. | |
149 | * - Extract union iwreq_data from struct iwreq (for new driver API). | |
150 | * - Rename SIOCSIWNAME as SIOCSIWCOMMIT | |
151 | * | |
152 | * V13 to V14 | |
153 | * ---------- | |
154 | * - Wireless Events support : define struct iw_event | |
155 | * - Define additional specific event numbers | |
156 | * - Add "addr" and "param" fields in union iwreq_data | |
157 | * - AP scanning stuff (SIOCSIWSCAN and friends) | |
158 | * | |
159 | * V14 to V15 | |
160 | * ---------- | |
161 | * - Add IW_PRIV_TYPE_ADDR for struct sockaddr private arg | |
162 | * - Make struct iw_freq signed (both m & e), add explicit padding | |
163 | * - Add IWEVCUSTOM for driver specific event/scanning token | |
164 | * - Add IW_MAX_GET_SPY for driver returning a lot of addresses | |
165 | * - Add IW_TXPOW_RANGE for range of Tx Powers | |
166 | * - Add IWEVREGISTERED & IWEVEXPIRED events for Access Points | |
167 | * - Add IW_MODE_MONITOR for passive monitor | |
168 | * | |
169 | * V15 to V16 | |
170 | * ---------- | |
171 | * - Increase the number of bitrates in iw_range to 32 (for 802.11g) | |
172 | * - Increase the number of frequencies in iw_range to 32 (for 802.11b+a) | |
173 | * - Reshuffle struct iw_range for increases, add filler | |
174 | * - Increase IW_MAX_AP to 64 for driver returning a lot of addresses | |
175 | * - Remove IW_MAX_GET_SPY because conflict with enhanced spy support | |
176 | * - Add SIOCSIWTHRSPY/SIOCGIWTHRSPY and "struct iw_thrspy" | |
177 | * - Add IW_ENCODE_TEMP and iw_range->encoding_login_index | |
178 | * | |
179 | * V16 to V17 | |
180 | * ---------- | |
181 | * - Add flags to frequency -> auto/fixed | |
182 | * - Document (struct iw_quality *)->updated, add new flags (INVALID) | |
183 | * - Wireless Event capability in struct iw_range | |
184 | * - Add support for relative TxPower (yick !) | |
185 | */ | |
186 | ||
187 | /**************************** CONSTANTS ****************************/ | |
188 | ||
189 | /* -------------------------- IOCTL LIST -------------------------- */ | |
190 | ||
191 | /* Wireless Identification */ | |
192 | #define SIOCSIWCOMMIT 0x8B00 /* Commit pending changes to driver */ | |
193 | #define SIOCGIWNAME 0x8B01 /* get name == wireless protocol */ | |
194 | /* SIOCGIWNAME is used to verify the presence of Wireless Extensions. | |
195 | * Common values : "IEEE 802.11-DS", "IEEE 802.11-FH", "IEEE 802.11b"... | |
196 | * Don't put the name of your driver there, it's useless. */ | |
197 | ||
198 | /* Basic operations */ | |
199 | #define SIOCSIWNWID 0x8B02 /* set network id (pre-802.11) */ | |
200 | #define SIOCGIWNWID 0x8B03 /* get network id (the cell) */ | |
201 | #define SIOCSIWFREQ 0x8B04 /* set channel/frequency (Hz) */ | |
202 | #define SIOCGIWFREQ 0x8B05 /* get channel/frequency (Hz) */ | |
203 | #define SIOCSIWMODE 0x8B06 /* set operation mode */ | |
204 | #define SIOCGIWMODE 0x8B07 /* get operation mode */ | |
205 | #define SIOCSIWSENS 0x8B08 /* set sensitivity (dBm) */ | |
206 | #define SIOCGIWSENS 0x8B09 /* get sensitivity (dBm) */ | |
207 | ||
208 | /* Informative stuff */ | |
209 | #define SIOCSIWRANGE 0x8B0A /* Unused */ | |
210 | #define SIOCGIWRANGE 0x8B0B /* Get range of parameters */ | |
211 | #define SIOCSIWPRIV 0x8B0C /* Unused */ | |
212 | #define SIOCGIWPRIV 0x8B0D /* get private ioctl interface info */ | |
213 | #define SIOCSIWSTATS 0x8B0E /* Unused */ | |
214 | #define SIOCGIWSTATS 0x8B0F /* Get /proc/net/wireless stats */ | |
215 | /* SIOCGIWSTATS is strictly used between user space and the kernel, and | |
216 | * is never passed to the driver (i.e. the driver will never see it). */ | |
217 | ||
218 | /* Spy support (statistics per MAC address - used for Mobile IP support) */ | |
219 | #define SIOCSIWSPY 0x8B10 /* set spy addresses */ | |
220 | #define SIOCGIWSPY 0x8B11 /* get spy info (quality of link) */ | |
221 | #define SIOCSIWTHRSPY 0x8B12 /* set spy threshold (spy event) */ | |
222 | #define SIOCGIWTHRSPY 0x8B13 /* get spy threshold */ | |
223 | ||
224 | /* Access Point manipulation */ | |
225 | #define SIOCSIWAP 0x8B14 /* set access point MAC addresses */ | |
226 | #define SIOCGIWAP 0x8B15 /* get access point MAC addresses */ | |
227 | #define SIOCGIWAPLIST 0x8B17 /* Deprecated in favor of scanning */ | |
228 | #define SIOCSIWSCAN 0x8B18 /* trigger scanning (list cells) */ | |
229 | #define SIOCGIWSCAN 0x8B19 /* get scanning results */ | |
230 | ||
231 | /* 802.11 specific support */ | |
232 | #define SIOCSIWESSID 0x8B1A /* set ESSID (network name) */ | |
233 | #define SIOCGIWESSID 0x8B1B /* get ESSID */ | |
234 | #define SIOCSIWNICKN 0x8B1C /* set node name/nickname */ | |
235 | #define SIOCGIWNICKN 0x8B1D /* get node name/nickname */ | |
236 | /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit | |
237 | * within the 'iwreq' structure, so we need to use the 'data' member to | |
238 | * point to a string in user space, like it is done for RANGE... */ | |
239 | ||
240 | /* Other parameters useful in 802.11 and some other devices */ | |
241 | #define SIOCSIWRATE 0x8B20 /* set default bit rate (bps) */ | |
242 | #define SIOCGIWRATE 0x8B21 /* get default bit rate (bps) */ | |
243 | #define SIOCSIWRTS 0x8B22 /* set RTS/CTS threshold (bytes) */ | |
244 | #define SIOCGIWRTS 0x8B23 /* get RTS/CTS threshold (bytes) */ | |
245 | #define SIOCSIWFRAG 0x8B24 /* set fragmentation thr (bytes) */ | |
246 | #define SIOCGIWFRAG 0x8B25 /* get fragmentation thr (bytes) */ | |
247 | #define SIOCSIWTXPOW 0x8B26 /* set transmit power (dBm) */ | |
248 | #define SIOCGIWTXPOW 0x8B27 /* get transmit power (dBm) */ | |
249 | #define SIOCSIWRETRY 0x8B28 /* set retry limits and lifetime */ | |
250 | #define SIOCGIWRETRY 0x8B29 /* get retry limits and lifetime */ | |
251 | ||
252 | /* Encoding stuff (scrambling, hardware security, WEP...) */ | |
253 | #define SIOCSIWENCODE 0x8B2A /* set encoding token & mode */ | |
254 | #define SIOCGIWENCODE 0x8B2B /* get encoding token & mode */ | |
255 | /* Power saving stuff (power management, unicast and multicast) */ | |
256 | #define SIOCSIWPOWER 0x8B2C /* set Power Management settings */ | |
257 | #define SIOCGIWPOWER 0x8B2D /* get Power Management settings */ | |
258 | ||
259 | /* -------------------- DEV PRIVATE IOCTL LIST -------------------- */ | |
260 | ||
261 | /* These 32 ioctl are wireless device private, for 16 commands. | |
262 | * Each driver is free to use them for whatever purpose it chooses, | |
263 | * however the driver *must* export the description of those ioctls | |
264 | * with SIOCGIWPRIV and *must* use arguments as defined below. | |
265 | * If you don't follow those rules, DaveM is going to hate you (reason : | |
266 | * it make mixed 32/64bit operation impossible). | |
267 | */ | |
268 | #define SIOCIWFIRSTPRIV 0x8BE0 | |
269 | #define SIOCIWLASTPRIV 0x8BFF | |
270 | /* Previously, we were using SIOCDEVPRIVATE, but we now have our | |
271 | * separate range because of collisions with other tools such as | |
272 | * 'mii-tool'. | |
273 | * We now have 32 commands, so a bit more space ;-). | |
274 | * Also, all 'odd' commands are only usable by root and don't return the | |
275 | * content of ifr/iwr to user (but you are not obliged to use the set/get | |
276 | * convention, just use every other two command). More details in iwpriv.c. | |
277 | * And I repeat : you are not forced to use them with iwpriv, but you | |
278 | * must be compliant with it. | |
279 | */ | |
280 | ||
281 | /* ------------------------- IOCTL STUFF ------------------------- */ | |
282 | ||
283 | /* The first and the last (range) */ | |
284 | #define SIOCIWFIRST 0x8B00 | |
285 | #define SIOCIWLAST SIOCIWLASTPRIV /* 0x8BFF */ | |
286 | ||
287 | /* Even : get (world access), odd : set (root access) */ | |
288 | #define IW_IS_SET(cmd) (!((cmd) & 0x1)) | |
289 | #define IW_IS_GET(cmd) ((cmd) & 0x1) | |
290 | ||
291 | /* ----------------------- WIRELESS EVENTS ----------------------- */ | |
292 | /* Those are *NOT* ioctls, do not issue request on them !!! */ | |
293 | /* Most events use the same identifier as ioctl requests */ | |
294 | ||
295 | #define IWEVTXDROP 0x8C00 /* Packet dropped to excessive retry */ | |
296 | #define IWEVQUAL 0x8C01 /* Quality part of statistics (scan) */ | |
297 | #define IWEVCUSTOM 0x8C02 /* Driver specific ascii string */ | |
298 | #define IWEVREGISTERED 0x8C03 /* Discovered a new node (AP mode) */ | |
299 | #define IWEVEXPIRED 0x8C04 /* Expired a node (AP mode) */ | |
300 | ||
301 | #define IWEVFIRST 0x8C00 | |
302 | ||
303 | /* ------------------------- PRIVATE INFO ------------------------- */ | |
304 | /* | |
305 | * The following is used with SIOCGIWPRIV. It allow a driver to define | |
306 | * the interface (name, type of data) for its private ioctl. | |
307 | * Privates ioctl are SIOCIWFIRSTPRIV -> SIOCIWLASTPRIV | |
308 | */ | |
309 | ||
310 | #define IW_PRIV_TYPE_MASK 0x7000 /* Type of arguments */ | |
311 | #define IW_PRIV_TYPE_NONE 0x0000 | |
312 | #define IW_PRIV_TYPE_BYTE 0x1000 /* Char as number */ | |
313 | #define IW_PRIV_TYPE_CHAR 0x2000 /* Char as character */ | |
314 | #define IW_PRIV_TYPE_INT 0x4000 /* 32 bits int */ | |
315 | #define IW_PRIV_TYPE_FLOAT 0x5000 /* struct iw_freq */ | |
316 | #define IW_PRIV_TYPE_ADDR 0x6000 /* struct sockaddr */ | |
317 | ||
318 | #define IW_PRIV_SIZE_FIXED 0x0800 /* Variable or fixed number of args */ | |
319 | ||
320 | #define IW_PRIV_SIZE_MASK 0x07FF /* Max number of those args */ | |
321 | ||
322 | /* | |
323 | * Note : if the number of args is fixed and the size < 16 octets, | |
324 | * instead of passing a pointer we will put args in the iwreq struct... | |
325 | */ | |
326 | ||
327 | /* ----------------------- OTHER CONSTANTS ----------------------- */ | |
328 | ||
329 | /* Maximum frequencies in the range struct */ | |
330 | #define IW_MAX_FREQUENCIES 32 | |
331 | /* Note : if you have something like 80 frequencies, | |
332 | * don't increase this constant and don't fill the frequency list. | |
333 | * The user will be able to set by channel anyway... */ | |
334 | ||
335 | /* Maximum bit rates in the range struct */ | |
336 | #define IW_MAX_BITRATES 32 | |
337 | ||
338 | /* Maximum tx powers in the range struct */ | |
339 | #define IW_MAX_TXPOWER 8 | |
340 | /* Note : if you more than 8 TXPowers, just set the max and min or | |
341 | * a few of them in the struct iw_range. */ | |
342 | ||
343 | /* Maximum of address that you may set with SPY */ | |
344 | #define IW_MAX_SPY 8 | |
345 | ||
346 | /* Maximum of address that you may get in the | |
347 | list of access points in range */ | |
348 | #define IW_MAX_AP 64 | |
349 | ||
350 | /* Maximum size of the ESSID and NICKN strings */ | |
351 | #define IW_ESSID_MAX_SIZE 32 | |
352 | ||
353 | /* Modes of operation */ | |
354 | #define IW_MODE_AUTO 0 /* Let the driver decides */ | |
355 | #define IW_MODE_ADHOC 1 /* Single cell network */ | |
356 | #define IW_MODE_INFRA 2 /* Multi cell network, roaming, ... */ | |
357 | #define IW_MODE_MASTER 3 /* Synchronisation master or Access Point */ | |
358 | #define IW_MODE_REPEAT 4 /* Wireless Repeater (forwarder) */ | |
359 | #define IW_MODE_SECOND 5 /* Secondary master/repeater (backup) */ | |
360 | #define IW_MODE_MONITOR 6 /* Passive monitor (listen only) */ | |
361 | ||
362 | /* Statistics flags (bitmask in updated) */ | |
363 | #define IW_QUAL_QUAL_UPDATED 0x1 /* Value was updated since last read */ | |
364 | #define IW_QUAL_LEVEL_UPDATED 0x2 | |
365 | #define IW_QUAL_NOISE_UPDATED 0x4 | |
366 | #define IW_QUAL_QUAL_INVALID 0x10 /* Driver doesn't provide value */ | |
367 | #define IW_QUAL_LEVEL_INVALID 0x20 | |
368 | #define IW_QUAL_NOISE_INVALID 0x40 | |
369 | ||
370 | /* Frequency flags */ | |
371 | #define IW_FREQ_AUTO 0x00 /* Let the driver decides */ | |
372 | #define IW_FREQ_FIXED 0x01 /* Force a specific value */ | |
373 | ||
374 | /* Maximum number of size of encoding token available | |
375 | * they are listed in the range structure */ | |
376 | #define IW_MAX_ENCODING_SIZES 8 | |
377 | ||
378 | /* Maximum size of the encoding token in bytes */ | |
379 | #define IW_ENCODING_TOKEN_MAX 32 /* 256 bits (for now) */ | |
380 | ||
381 | /* Flags for encoding (along with the token) */ | |
382 | #define IW_ENCODE_INDEX 0x00FF /* Token index (if needed) */ | |
383 | #define IW_ENCODE_FLAGS 0xFF00 /* Flags defined below */ | |
384 | #define IW_ENCODE_MODE 0xF000 /* Modes defined below */ | |
385 | #define IW_ENCODE_DISABLED 0x8000 /* Encoding disabled */ | |
386 | #define IW_ENCODE_ENABLED 0x0000 /* Encoding enabled */ | |
387 | #define IW_ENCODE_RESTRICTED 0x4000 /* Refuse non-encoded packets */ | |
388 | #define IW_ENCODE_OPEN 0x2000 /* Accept non-encoded packets */ | |
389 | #define IW_ENCODE_NOKEY 0x0800 /* Key is write only, so not present */ | |
390 | #define IW_ENCODE_TEMP 0x0400 /* Temporary key */ | |
391 | ||
392 | /* Power management flags available (along with the value, if any) */ | |
393 | #define IW_POWER_ON 0x0000 /* No details... */ | |
394 | #define IW_POWER_TYPE 0xF000 /* Type of parameter */ | |
395 | #define IW_POWER_PERIOD 0x1000 /* Value is a period/duration of */ | |
396 | #define IW_POWER_TIMEOUT 0x2000 /* Value is a timeout (to go asleep) */ | |
397 | #define IW_POWER_MODE 0x0F00 /* Power Management mode */ | |
398 | #define IW_POWER_UNICAST_R 0x0100 /* Receive only unicast messages */ | |
399 | #define IW_POWER_MULTICAST_R 0x0200 /* Receive only multicast messages */ | |
400 | #define IW_POWER_ALL_R 0x0300 /* Receive all messages though PM */ | |
401 | #define IW_POWER_FORCE_S 0x0400 /* Force PM procedure for sending unicast */ | |
402 | #define IW_POWER_REPEATER 0x0800 /* Repeat broadcast messages in PM period */ | |
403 | #define IW_POWER_MODIFIER 0x000F /* Modify a parameter */ | |
404 | #define IW_POWER_MIN 0x0001 /* Value is a minimum */ | |
405 | #define IW_POWER_MAX 0x0002 /* Value is a maximum */ | |
406 | #define IW_POWER_RELATIVE 0x0004 /* Value is not in seconds/ms/us */ | |
407 | ||
408 | /* Transmit Power flags available */ | |
409 | #define IW_TXPOW_TYPE 0x00FF /* Type of value */ | |
410 | #define IW_TXPOW_DBM 0x0000 /* Value is in dBm */ | |
411 | #define IW_TXPOW_MWATT 0x0001 /* Value is in mW */ | |
412 | #define IW_TXPOW_RELATIVE 0x0002 /* Value is in arbitrary units */ | |
413 | #define IW_TXPOW_RANGE 0x1000 /* Range of value between min/max */ | |
414 | ||
415 | /* Retry limits and lifetime flags available */ | |
416 | #define IW_RETRY_ON 0x0000 /* No details... */ | |
417 | #define IW_RETRY_TYPE 0xF000 /* Type of parameter */ | |
418 | #define IW_RETRY_LIMIT 0x1000 /* Maximum number of retries*/ | |
419 | #define IW_RETRY_LIFETIME 0x2000 /* Maximum duration of retries in us */ | |
420 | #define IW_RETRY_MODIFIER 0x000F /* Modify a parameter */ | |
421 | #define IW_RETRY_MIN 0x0001 /* Value is a minimum */ | |
422 | #define IW_RETRY_MAX 0x0002 /* Value is a maximum */ | |
423 | #define IW_RETRY_RELATIVE 0x0004 /* Value is not in seconds/ms/us */ | |
424 | ||
425 | /* Scanning request flags */ | |
426 | #define IW_SCAN_DEFAULT 0x0000 /* Default scan of the driver */ | |
427 | #define IW_SCAN_ALL_ESSID 0x0001 /* Scan all ESSIDs */ | |
428 | #define IW_SCAN_THIS_ESSID 0x0002 /* Scan only this ESSID */ | |
429 | #define IW_SCAN_ALL_FREQ 0x0004 /* Scan all Frequencies */ | |
430 | #define IW_SCAN_THIS_FREQ 0x0008 /* Scan only this Frequency */ | |
431 | #define IW_SCAN_ALL_MODE 0x0010 /* Scan all Modes */ | |
432 | #define IW_SCAN_THIS_MODE 0x0020 /* Scan only this Mode */ | |
433 | #define IW_SCAN_ALL_RATE 0x0040 /* Scan all Bit-Rates */ | |
434 | #define IW_SCAN_THIS_RATE 0x0080 /* Scan only this Bit-Rate */ | |
435 | /* Maximum size of returned data */ | |
436 | #define IW_SCAN_MAX_DATA 4096 /* In bytes */ | |
437 | ||
438 | /* Max number of char in custom event - use multiple of them if needed */ | |
439 | #define IW_CUSTOM_MAX 256 /* In bytes */ | |
440 | ||
441 | /* Event capability macros - in (struct iw_range *)->event_capa | |
442 | * Because we have more than 32 possible events, we use an array of | |
443 | * 32 bit bitmasks. Note : 32 bits = 0x20 = 2^5. */ | |
444 | #define IW_EVENT_CAPA_BASE(cmd) ((cmd >= SIOCIWFIRSTPRIV) ? \ | |
445 | (cmd - SIOCIWFIRSTPRIV + 0x60) : \ | |
446 | (cmd - SIOCSIWCOMMIT)) | |
447 | #define IW_EVENT_CAPA_INDEX(cmd) (IW_EVENT_CAPA_BASE(cmd) >> 5) | |
448 | #define IW_EVENT_CAPA_MASK(cmd) (1 << (IW_EVENT_CAPA_BASE(cmd) & 0x1F)) | |
449 | /* Event capability constants - event autogenerated by the kernel | |
450 | * This list is valid for most 802.11 devices, customise as needed... */ | |
451 | #define IW_EVENT_CAPA_K_0 (IW_EVENT_CAPA_MASK(0x8B04) | \ | |
452 | IW_EVENT_CAPA_MASK(0x8B06) | \ | |
453 | IW_EVENT_CAPA_MASK(0x8B1A)) | |
454 | #define IW_EVENT_CAPA_K_1 (IW_EVENT_CAPA_MASK(0x8B2A)) | |
455 | /* "Easy" macro to set events in iw_range (less efficient) */ | |
456 | #define IW_EVENT_CAPA_SET(event_capa, cmd) (event_capa[IW_EVENT_CAPA_INDEX(cmd)] |= IW_EVENT_CAPA_MASK(cmd)) | |
457 | #define IW_EVENT_CAPA_SET_KERNEL(event_capa) {event_capa[0] |= IW_EVENT_CAPA_K_0; event_capa[1] |= IW_EVENT_CAPA_K_1; } | |
458 | ||
459 | ||
460 | /****************************** TYPES ******************************/ | |
461 | ||
462 | /* --------------------------- SUBTYPES --------------------------- */ | |
463 | /* | |
464 | * Generic format for most parameters that fit in an int | |
465 | */ | |
466 | struct iw_param | |
467 | { | |
468 | __s32 value; /* The value of the parameter itself */ | |
469 | __u8 fixed; /* Hardware should not use auto select */ | |
470 | __u8 disabled; /* Disable the feature */ | |
471 | __u16 flags; /* Various specifc flags (if any) */ | |
472 | }; | |
473 | ||
474 | /* | |
475 | * For all data larger than 16 octets, we need to use a | |
476 | * pointer to memory allocated in user space. | |
477 | */ | |
478 | struct iw_point | |
479 | { | |
480 | void __user *pointer; /* Pointer to the data (in user space) */ | |
481 | __u16 length; /* number of fields or size in bytes */ | |
482 | __u16 flags; /* Optional params */ | |
483 | }; | |
484 | ||
485 | /* | |
486 | * A frequency | |
487 | * For numbers lower than 10^9, we encode the number in 'm' and | |
488 | * set 'e' to 0 | |
489 | * For number greater than 10^9, we divide it by the lowest power | |
490 | * of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')... | |
491 | * The power of 10 is in 'e', the result of the division is in 'm'. | |
492 | */ | |
493 | struct iw_freq | |
494 | { | |
495 | __s32 m; /* Mantissa */ | |
496 | __s16 e; /* Exponent */ | |
497 | __u8 i; /* List index (when in range struct) */ | |
498 | __u8 flags; /* Flags (fixed/auto) */ | |
499 | }; | |
500 | ||
501 | /* | |
502 | * Quality of the link | |
503 | */ | |
504 | struct iw_quality | |
505 | { | |
506 | __u8 qual; /* link quality (%retries, SNR, | |
507 | %missed beacons or better...) */ | |
508 | __u8 level; /* signal level (dBm) */ | |
509 | __u8 noise; /* noise level (dBm) */ | |
510 | __u8 updated; /* Flags to know if updated */ | |
511 | }; | |
512 | ||
513 | /* | |
514 | * Packet discarded in the wireless adapter due to | |
515 | * "wireless" specific problems... | |
516 | * Note : the list of counter and statistics in net_device_stats | |
517 | * is already pretty exhaustive, and you should use that first. | |
518 | * This is only additional stats... | |
519 | */ | |
520 | struct iw_discarded | |
521 | { | |
522 | __u32 nwid; /* Rx : Wrong nwid/essid */ | |
523 | __u32 code; /* Rx : Unable to code/decode (WEP) */ | |
524 | __u32 fragment; /* Rx : Can't perform MAC reassembly */ | |
525 | __u32 retries; /* Tx : Max MAC retries num reached */ | |
526 | __u32 misc; /* Others cases */ | |
527 | }; | |
528 | ||
529 | /* | |
530 | * Packet/Time period missed in the wireless adapter due to | |
531 | * "wireless" specific problems... | |
532 | */ | |
533 | struct iw_missed | |
534 | { | |
535 | __u32 beacon; /* Missed beacons/superframe */ | |
536 | }; | |
537 | ||
538 | /* | |
539 | * Quality range (for spy threshold) | |
540 | */ | |
541 | struct iw_thrspy | |
542 | { | |
543 | struct sockaddr addr; /* Source address (hw/mac) */ | |
544 | struct iw_quality qual; /* Quality of the link */ | |
545 | struct iw_quality low; /* Low threshold */ | |
546 | struct iw_quality high; /* High threshold */ | |
547 | }; | |
548 | ||
549 | /* ------------------------ WIRELESS STATS ------------------------ */ | |
550 | /* | |
551 | * Wireless statistics (used for /proc/net/wireless) | |
552 | */ | |
553 | struct iw_statistics | |
554 | { | |
555 | __u16 status; /* Status | |
556 | * - device dependent for now */ | |
557 | ||
558 | struct iw_quality qual; /* Quality of the link | |
559 | * (instant/mean/max) */ | |
560 | struct iw_discarded discard; /* Packet discarded counts */ | |
561 | struct iw_missed miss; /* Packet missed counts */ | |
562 | }; | |
563 | ||
564 | /* ------------------------ IOCTL REQUEST ------------------------ */ | |
565 | /* | |
566 | * This structure defines the payload of an ioctl, and is used | |
567 | * below. | |
568 | * | |
569 | * Note that this structure should fit on the memory footprint | |
570 | * of iwreq (which is the same as ifreq), which mean a max size of | |
571 | * 16 octets = 128 bits. Warning, pointers might be 64 bits wide... | |
572 | * You should check this when increasing the structures defined | |
573 | * above in this file... | |
574 | */ | |
575 | union iwreq_data | |
576 | { | |
577 | /* Config - generic */ | |
578 | char name[IFNAMSIZ]; | |
579 | /* Name : used to verify the presence of wireless extensions. | |
580 | * Name of the protocol/provider... */ | |
581 | ||
582 | struct iw_point essid; /* Extended network name */ | |
583 | struct iw_param nwid; /* network id (or domain - the cell) */ | |
584 | struct iw_freq freq; /* frequency or channel : | |
585 | * 0-1000 = channel | |
586 | * > 1000 = frequency in Hz */ | |
587 | ||
588 | struct iw_param sens; /* signal level threshold */ | |
589 | struct iw_param bitrate; /* default bit rate */ | |
590 | struct iw_param txpower; /* default transmit power */ | |
591 | struct iw_param rts; /* RTS threshold threshold */ | |
592 | struct iw_param frag; /* Fragmentation threshold */ | |
593 | __u32 mode; /* Operation mode */ | |
594 | struct iw_param retry; /* Retry limits & lifetime */ | |
595 | ||
596 | struct iw_point encoding; /* Encoding stuff : tokens */ | |
597 | struct iw_param power; /* PM duration/timeout */ | |
598 | struct iw_quality qual; /* Quality part of statistics */ | |
599 | ||
600 | struct sockaddr ap_addr; /* Access point address */ | |
601 | struct sockaddr addr; /* Destination address (hw/mac) */ | |
602 | ||
603 | struct iw_param param; /* Other small parameters */ | |
604 | struct iw_point data; /* Other large parameters */ | |
605 | }; | |
606 | ||
607 | /* | |
608 | * The structure to exchange data for ioctl. | |
609 | * This structure is the same as 'struct ifreq', but (re)defined for | |
610 | * convenience... | |
611 | * Do I need to remind you about structure size (32 octets) ? | |
612 | */ | |
613 | struct iwreq | |
614 | { | |
615 | union | |
616 | { | |
617 | char ifrn_name[IFNAMSIZ]; /* if name, e.g. "eth0" */ | |
618 | } ifr_ifrn; | |
619 | ||
620 | /* Data part (defined just above) */ | |
621 | union iwreq_data u; | |
622 | }; | |
623 | ||
624 | /* -------------------------- IOCTL DATA -------------------------- */ | |
625 | /* | |
626 | * For those ioctl which want to exchange mode data that what could | |
627 | * fit in the above structure... | |
628 | */ | |
629 | ||
630 | /* | |
631 | * Range of parameters | |
632 | */ | |
633 | ||
634 | struct iw_range | |
635 | { | |
636 | /* Informative stuff (to choose between different interface) */ | |
637 | __u32 throughput; /* To give an idea... */ | |
638 | /* In theory this value should be the maximum benchmarked | |
639 | * TCP/IP throughput, because with most of these devices the | |
640 | * bit rate is meaningless (overhead an co) to estimate how | |
641 | * fast the connection will go and pick the fastest one. | |
642 | * I suggest people to play with Netperf or any benchmark... | |
643 | */ | |
644 | ||
645 | /* NWID (or domain id) */ | |
646 | __u32 min_nwid; /* Minimal NWID we are able to set */ | |
647 | __u32 max_nwid; /* Maximal NWID we are able to set */ | |
648 | ||
649 | /* Old Frequency (backward compat - moved lower ) */ | |
650 | __u16 old_num_channels; | |
651 | __u8 old_num_frequency; | |
652 | ||
653 | /* Wireless event capability bitmasks */ | |
654 | __u32 event_capa[6]; | |
655 | ||
656 | /* signal level threshold range */ | |
657 | __s32 sensitivity; | |
658 | ||
659 | /* Quality of link & SNR stuff */ | |
660 | /* Quality range (link, level, noise) | |
661 | * If the quality is absolute, it will be in the range [0 ; max_qual], | |
662 | * if the quality is dBm, it will be in the range [max_qual ; 0]. | |
663 | * Don't forget that we use 8 bit arithmetics... */ | |
664 | struct iw_quality max_qual; /* Quality of the link */ | |
665 | /* This should contain the average/typical values of the quality | |
666 | * indicator. This should be the threshold between a "good" and | |
667 | * a "bad" link (example : monitor going from green to orange). | |
668 | * Currently, user space apps like quality monitors don't have any | |
669 | * way to calibrate the measurement. With this, they can split | |
670 | * the range between 0 and max_qual in different quality level | |
671 | * (using a geometric subdivision centered on the average). | |
672 | * I expect that people doing the user space apps will feedback | |
673 | * us on which value we need to put in each driver... */ | |
674 | struct iw_quality avg_qual; /* Quality of the link */ | |
675 | ||
676 | /* Rates */ | |
677 | __u8 num_bitrates; /* Number of entries in the list */ | |
678 | __s32 bitrate[IW_MAX_BITRATES]; /* list, in bps */ | |
679 | ||
680 | /* RTS threshold */ | |
681 | __s32 min_rts; /* Minimal RTS threshold */ | |
682 | __s32 max_rts; /* Maximal RTS threshold */ | |
683 | ||
684 | /* Frag threshold */ | |
685 | __s32 min_frag; /* Minimal frag threshold */ | |
686 | __s32 max_frag; /* Maximal frag threshold */ | |
687 | ||
688 | /* Power Management duration & timeout */ | |
689 | __s32 min_pmp; /* Minimal PM period */ | |
690 | __s32 max_pmp; /* Maximal PM period */ | |
691 | __s32 min_pmt; /* Minimal PM timeout */ | |
692 | __s32 max_pmt; /* Maximal PM timeout */ | |
693 | __u16 pmp_flags; /* How to decode max/min PM period */ | |
694 | __u16 pmt_flags; /* How to decode max/min PM timeout */ | |
695 | __u16 pm_capa; /* What PM options are supported */ | |
696 | ||
697 | /* Encoder stuff */ | |
698 | __u16 encoding_size[IW_MAX_ENCODING_SIZES]; /* Different token sizes */ | |
699 | __u8 num_encoding_sizes; /* Number of entry in the list */ | |
700 | __u8 max_encoding_tokens; /* Max number of tokens */ | |
701 | /* For drivers that need a "login/passwd" form */ | |
702 | __u8 encoding_login_index; /* token index for login token */ | |
703 | ||
704 | /* Transmit power */ | |
705 | __u16 txpower_capa; /* What options are supported */ | |
706 | __u8 num_txpower; /* Number of entries in the list */ | |
707 | __s32 txpower[IW_MAX_TXPOWER]; /* list, in bps */ | |
708 | ||
709 | /* Wireless Extension version info */ | |
710 | __u8 we_version_compiled; /* Must be WIRELESS_EXT */ | |
711 | __u8 we_version_source; /* Last update of source */ | |
712 | ||
713 | /* Retry limits and lifetime */ | |
714 | __u16 retry_capa; /* What retry options are supported */ | |
715 | __u16 retry_flags; /* How to decode max/min retry limit */ | |
716 | __u16 r_time_flags; /* How to decode max/min retry life */ | |
717 | __s32 min_retry; /* Minimal number of retries */ | |
718 | __s32 max_retry; /* Maximal number of retries */ | |
719 | __s32 min_r_time; /* Minimal retry lifetime */ | |
720 | __s32 max_r_time; /* Maximal retry lifetime */ | |
721 | ||
722 | /* Frequency */ | |
723 | __u16 num_channels; /* Number of channels [0; num - 1] */ | |
724 | __u8 num_frequency; /* Number of entry in the list */ | |
725 | struct iw_freq freq[IW_MAX_FREQUENCIES]; /* list */ | |
726 | /* Note : this frequency list doesn't need to fit channel numbers, | |
727 | * because each entry contain its channel index */ | |
728 | }; | |
729 | ||
730 | /* | |
731 | * Private ioctl interface information | |
732 | */ | |
733 | ||
734 | struct iw_priv_args | |
735 | { | |
736 | __u32 cmd; /* Number of the ioctl to issue */ | |
737 | __u16 set_args; /* Type and number of args */ | |
738 | __u16 get_args; /* Type and number of args */ | |
739 | char name[IFNAMSIZ]; /* Name of the extension */ | |
740 | }; | |
741 | ||
742 | /* ----------------------- WIRELESS EVENTS ----------------------- */ | |
743 | /* | |
744 | * Wireless events are carried through the rtnetlink socket to user | |
745 | * space. They are encapsulated in the IFLA_WIRELESS field of | |
746 | * a RTM_NEWLINK message. | |
747 | */ | |
748 | ||
749 | /* | |
750 | * A Wireless Event. Contains basically the same data as the ioctl... | |
751 | */ | |
752 | struct iw_event | |
753 | { | |
754 | __u16 len; /* Real lenght of this stuff */ | |
755 | __u16 cmd; /* Wireless IOCTL */ | |
756 | union iwreq_data u; /* IOCTL fixed payload */ | |
757 | }; | |
758 | ||
759 | /* Size of the Event prefix (including padding and alignement junk) */ | |
760 | #define IW_EV_LCP_LEN (sizeof(struct iw_event) - sizeof(union iwreq_data)) | |
761 | /* Size of the various events */ | |
762 | #define IW_EV_CHAR_LEN (IW_EV_LCP_LEN + IFNAMSIZ) | |
763 | #define IW_EV_UINT_LEN (IW_EV_LCP_LEN + sizeof(__u32)) | |
764 | #define IW_EV_FREQ_LEN (IW_EV_LCP_LEN + sizeof(struct iw_freq)) | |
765 | #define IW_EV_POINT_LEN (IW_EV_LCP_LEN + sizeof(struct iw_point)) | |
766 | #define IW_EV_PARAM_LEN (IW_EV_LCP_LEN + sizeof(struct iw_param)) | |
767 | #define IW_EV_ADDR_LEN (IW_EV_LCP_LEN + sizeof(struct sockaddr)) | |
768 | #define IW_EV_QUAL_LEN (IW_EV_LCP_LEN + sizeof(struct iw_quality)) | |
769 | ||
770 | /* Note : in the case of iw_point, the extra data will come at the | |
771 | * end of the event */ | |
772 | ||
773 | #endif /* _LINUX_WIRELESS_H */ |