2 * This file define a set of standard wireless extensions
6 * Authors : Jean Tourrilhes - HPL - <jt@hpl.hp.com>
7 * Copyright (c) 1997-2005 Jean Tourrilhes, All Rights Reserved.
10 #ifndef _LINUX_WIRELESS_H
11 #define _LINUX_WIRELESS_H
13 /************************** DOCUMENTATION **************************/
15 * Initial APIs (1996 -> onward) :
16 * -----------------------------
17 * Basically, the wireless extensions are for now a set of standard ioctl
18 * call + /proc/net/wireless
20 * The entry /proc/net/wireless give statistics and information on the
22 * This is better than having each driver having its entry because
23 * its centralised and we may remove the driver module safely.
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.
29 * The ioctl mechanimsm are copied from standard devices ioctl.
30 * We have the list of command plus a structure descibing the
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)
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)
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
49 * Note as well that /proc/net/wireless implementation has now moved in :
50 * # net/core/wireless.c
52 * Wireless Events (2002 -> onward) :
53 * --------------------------------
54 * Events are defined at the end of this file, and implemented in :
55 * # net/core/wireless.c
59 * Do not add here things that are redundant with other mechanisms
60 * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
63 * These wireless extensions are not magic : each driver has to provide
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...
70 /***************************** INCLUDES *****************************/
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... */
78 /***************************** VERSION *****************************/
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.
85 #define WIRELESS_EXT 18
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
102 * - Missing encoding definitions in range
103 * - Access points stuff
107 * - 802.11 support (ESSID ioctls)
111 * - define IW_ESSID_MAX_SIZE and IW_MAX_AP
115 * - Changed my e-mail address
116 * - More 802.11 support (nickname, rate, rts, frag)
117 * - List index in frequencies
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
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)
136 * - Add WE version in range (help backward/forward compatibility)
137 * - Add retry ioctls (work like PM)
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)
148 * - Document creation of new driver API.
149 * - Extract union iwreq_data from struct iwreq (for new driver API).
150 * - Rename SIOCSIWNAME as SIOCSIWCOMMIT
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)
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
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
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 !)
186 * V17 to V18 (From Jouni Malinen <jkmaline@cc.hut.fi>)
188 * - Add support for WPA/WPA2
189 * - Add extended encoding configuration (SIOCSIWENCODEEXT and
191 * - Add SIOCSIWGENIE/SIOCGIWGENIE
194 * - Add struct iw_range bit field for supported encoding capabilities
195 * - Add optional scan request parameters for SIOCSIWSCAN
196 * - Add SIOCSIWAUTH/SIOCGIWAUTH for setting authentication and WPA
197 * related parameters (extensible up to 4096 parameter values)
198 * - Add wireless events: IWEVGENIE, IWEVMICHAELMICFAILURE,
199 * IWEVASSOCREQIE, IWEVASSOCRESPIE, IWEVPMKIDCAND
202 /**************************** CONSTANTS ****************************/
204 /* -------------------------- IOCTL LIST -------------------------- */
206 /* Wireless Identification */
207 #define SIOCSIWCOMMIT 0x8B00 /* Commit pending changes to driver */
208 #define SIOCGIWNAME 0x8B01 /* get name == wireless protocol */
209 /* SIOCGIWNAME is used to verify the presence of Wireless Extensions.
210 * Common values : "IEEE 802.11-DS", "IEEE 802.11-FH", "IEEE 802.11b"...
211 * Don't put the name of your driver there, it's useless. */
213 /* Basic operations */
214 #define SIOCSIWNWID 0x8B02 /* set network id (pre-802.11) */
215 #define SIOCGIWNWID 0x8B03 /* get network id (the cell) */
216 #define SIOCSIWFREQ 0x8B04 /* set channel/frequency (Hz) */
217 #define SIOCGIWFREQ 0x8B05 /* get channel/frequency (Hz) */
218 #define SIOCSIWMODE 0x8B06 /* set operation mode */
219 #define SIOCGIWMODE 0x8B07 /* get operation mode */
220 #define SIOCSIWSENS 0x8B08 /* set sensitivity (dBm) */
221 #define SIOCGIWSENS 0x8B09 /* get sensitivity (dBm) */
223 /* Informative stuff */
224 #define SIOCSIWRANGE 0x8B0A /* Unused */
225 #define SIOCGIWRANGE 0x8B0B /* Get range of parameters */
226 #define SIOCSIWPRIV 0x8B0C /* Unused */
227 #define SIOCGIWPRIV 0x8B0D /* get private ioctl interface info */
228 #define SIOCSIWSTATS 0x8B0E /* Unused */
229 #define SIOCGIWSTATS 0x8B0F /* Get /proc/net/wireless stats */
230 /* SIOCGIWSTATS is strictly used between user space and the kernel, and
231 * is never passed to the driver (i.e. the driver will never see it). */
233 /* Spy support (statistics per MAC address - used for Mobile IP support) */
234 #define SIOCSIWSPY 0x8B10 /* set spy addresses */
235 #define SIOCGIWSPY 0x8B11 /* get spy info (quality of link) */
236 #define SIOCSIWTHRSPY 0x8B12 /* set spy threshold (spy event) */
237 #define SIOCGIWTHRSPY 0x8B13 /* get spy threshold */
239 /* Access Point manipulation */
240 #define SIOCSIWAP 0x8B14 /* set access point MAC addresses */
241 #define SIOCGIWAP 0x8B15 /* get access point MAC addresses */
242 #define SIOCGIWAPLIST 0x8B17 /* Deprecated in favor of scanning */
243 #define SIOCSIWSCAN 0x8B18 /* trigger scanning (list cells) */
244 #define SIOCGIWSCAN 0x8B19 /* get scanning results */
246 /* 802.11 specific support */
247 #define SIOCSIWESSID 0x8B1A /* set ESSID (network name) */
248 #define SIOCGIWESSID 0x8B1B /* get ESSID */
249 #define SIOCSIWNICKN 0x8B1C /* set node name/nickname */
250 #define SIOCGIWNICKN 0x8B1D /* get node name/nickname */
251 /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
252 * within the 'iwreq' structure, so we need to use the 'data' member to
253 * point to a string in user space, like it is done for RANGE... */
255 /* Other parameters useful in 802.11 and some other devices */
256 #define SIOCSIWRATE 0x8B20 /* set default bit rate (bps) */
257 #define SIOCGIWRATE 0x8B21 /* get default bit rate (bps) */
258 #define SIOCSIWRTS 0x8B22 /* set RTS/CTS threshold (bytes) */
259 #define SIOCGIWRTS 0x8B23 /* get RTS/CTS threshold (bytes) */
260 #define SIOCSIWFRAG 0x8B24 /* set fragmentation thr (bytes) */
261 #define SIOCGIWFRAG 0x8B25 /* get fragmentation thr (bytes) */
262 #define SIOCSIWTXPOW 0x8B26 /* set transmit power (dBm) */
263 #define SIOCGIWTXPOW 0x8B27 /* get transmit power (dBm) */
264 #define SIOCSIWRETRY 0x8B28 /* set retry limits and lifetime */
265 #define SIOCGIWRETRY 0x8B29 /* get retry limits and lifetime */
267 /* Encoding stuff (scrambling, hardware security, WEP...) */
268 #define SIOCSIWENCODE 0x8B2A /* set encoding token & mode */
269 #define SIOCGIWENCODE 0x8B2B /* get encoding token & mode */
270 /* Power saving stuff (power management, unicast and multicast) */
271 #define SIOCSIWPOWER 0x8B2C /* set Power Management settings */
272 #define SIOCGIWPOWER 0x8B2D /* get Power Management settings */
274 /* WPA : Generic IEEE 802.11 informatiom element (e.g., for WPA/RSN/WMM).
275 * This ioctl uses struct iw_point and data buffer that includes IE id and len
276 * fields. More than one IE may be included in the request. Setting the generic
277 * IE to empty buffer (len=0) removes the generic IE from the driver. Drivers
278 * are allowed to generate their own WPA/RSN IEs, but in these cases, drivers
279 * are required to report the used IE as a wireless event, e.g., when
280 * associating with an AP. */
281 #define SIOCSIWGENIE 0x8B30 /* set generic IE */
282 #define SIOCGIWGENIE 0x8B31 /* get generic IE */
284 /* WPA : IEEE 802.11 MLME requests */
285 #define SIOCSIWMLME 0x8B16 /* request MLME operation; uses
287 /* WPA : Authentication mode parameters */
288 #define SIOCSIWAUTH 0x8B32 /* set authentication mode params */
289 #define SIOCGIWAUTH 0x8B33 /* get authentication mode params */
291 /* WPA : Extended version of encoding configuration */
292 #define SIOCSIWENCODEEXT 0x8B34 /* set encoding token & mode */
293 #define SIOCGIWENCODEEXT 0x8B35 /* get encoding token & mode */
295 /* WPA2 : PMKSA cache management */
296 #define SIOCSIWPMKSA 0x8B36 /* PMKSA cache operation */
298 /* -------------------- DEV PRIVATE IOCTL LIST -------------------- */
300 /* These 32 ioctl are wireless device private, for 16 commands.
301 * Each driver is free to use them for whatever purpose it chooses,
302 * however the driver *must* export the description of those ioctls
303 * with SIOCGIWPRIV and *must* use arguments as defined below.
304 * If you don't follow those rules, DaveM is going to hate you (reason :
305 * it make mixed 32/64bit operation impossible).
307 #define SIOCIWFIRSTPRIV 0x8BE0
308 #define SIOCIWLASTPRIV 0x8BFF
309 /* Previously, we were using SIOCDEVPRIVATE, but we now have our
310 * separate range because of collisions with other tools such as
312 * We now have 32 commands, so a bit more space ;-).
313 * Also, all 'odd' commands are only usable by root and don't return the
314 * content of ifr/iwr to user (but you are not obliged to use the set/get
315 * convention, just use every other two command). More details in iwpriv.c.
316 * And I repeat : you are not forced to use them with iwpriv, but you
317 * must be compliant with it.
320 /* ------------------------- IOCTL STUFF ------------------------- */
322 /* The first and the last (range) */
323 #define SIOCIWFIRST 0x8B00
324 #define SIOCIWLAST SIOCIWLASTPRIV /* 0x8BFF */
326 /* Even : get (world access), odd : set (root access) */
327 #define IW_IS_SET(cmd) (!((cmd) & 0x1))
328 #define IW_IS_GET(cmd) ((cmd) & 0x1)
330 /* ----------------------- WIRELESS EVENTS ----------------------- */
331 /* Those are *NOT* ioctls, do not issue request on them !!! */
332 /* Most events use the same identifier as ioctl requests */
334 #define IWEVTXDROP 0x8C00 /* Packet dropped to excessive retry */
335 #define IWEVQUAL 0x8C01 /* Quality part of statistics (scan) */
336 #define IWEVCUSTOM 0x8C02 /* Driver specific ascii string */
337 #define IWEVREGISTERED 0x8C03 /* Discovered a new node (AP mode) */
338 #define IWEVEXPIRED 0x8C04 /* Expired a node (AP mode) */
339 #define IWEVGENIE 0x8C05 /* Generic IE (WPA, RSN, WMM, ..)
340 * (scan results); This includes id and
341 * length fields. One IWEVGENIE may
342 * contain more than one IE. Scan
343 * results may contain one or more
344 * IWEVGENIE events. */
345 #define IWEVMICHAELMICFAILURE 0x8C06 /* Michael MIC failure
346 * (struct iw_michaelmicfailure)
348 #define IWEVASSOCREQIE 0x8C07 /* IEs used in (Re)Association Request.
349 * The data includes id and length
350 * fields and may contain more than one
351 * IE. This event is required in
352 * Managed mode if the driver
353 * generates its own WPA/RSN IE. This
354 * should be sent just before
355 * IWEVREGISTERED event for the
357 #define IWEVASSOCRESPIE 0x8C08 /* IEs used in (Re)Association
358 * Response. The data includes id and
359 * length fields and may contain more
360 * than one IE. This may be sent
361 * between IWEVASSOCREQIE and
362 * IWEVREGISTERED events for the
364 #define IWEVPMKIDCAND 0x8C09 /* PMKID candidate for RSN
366 * (struct iw_pmkid_cand) */
368 #define IWEVFIRST 0x8C00
370 /* ------------------------- PRIVATE INFO ------------------------- */
372 * The following is used with SIOCGIWPRIV. It allow a driver to define
373 * the interface (name, type of data) for its private ioctl.
374 * Privates ioctl are SIOCIWFIRSTPRIV -> SIOCIWLASTPRIV
377 #define IW_PRIV_TYPE_MASK 0x7000 /* Type of arguments */
378 #define IW_PRIV_TYPE_NONE 0x0000
379 #define IW_PRIV_TYPE_BYTE 0x1000 /* Char as number */
380 #define IW_PRIV_TYPE_CHAR 0x2000 /* Char as character */
381 #define IW_PRIV_TYPE_INT 0x4000 /* 32 bits int */
382 #define IW_PRIV_TYPE_FLOAT 0x5000 /* struct iw_freq */
383 #define IW_PRIV_TYPE_ADDR 0x6000 /* struct sockaddr */
385 #define IW_PRIV_SIZE_FIXED 0x0800 /* Variable or fixed number of args */
387 #define IW_PRIV_SIZE_MASK 0x07FF /* Max number of those args */
390 * Note : if the number of args is fixed and the size < 16 octets,
391 * instead of passing a pointer we will put args in the iwreq struct...
394 /* ----------------------- OTHER CONSTANTS ----------------------- */
396 /* Maximum frequencies in the range struct */
397 #define IW_MAX_FREQUENCIES 32
398 /* Note : if you have something like 80 frequencies,
399 * don't increase this constant and don't fill the frequency list.
400 * The user will be able to set by channel anyway... */
402 /* Maximum bit rates in the range struct */
403 #define IW_MAX_BITRATES 32
405 /* Maximum tx powers in the range struct */
406 #define IW_MAX_TXPOWER 8
407 /* Note : if you more than 8 TXPowers, just set the max and min or
408 * a few of them in the struct iw_range. */
410 /* Maximum of address that you may set with SPY */
413 /* Maximum of address that you may get in the
414 list of access points in range */
417 /* Maximum size of the ESSID and NICKN strings */
418 #define IW_ESSID_MAX_SIZE 32
420 /* Modes of operation */
421 #define IW_MODE_AUTO 0 /* Let the driver decides */
422 #define IW_MODE_ADHOC 1 /* Single cell network */
423 #define IW_MODE_INFRA 2 /* Multi cell network, roaming, ... */
424 #define IW_MODE_MASTER 3 /* Synchronisation master or Access Point */
425 #define IW_MODE_REPEAT 4 /* Wireless Repeater (forwarder) */
426 #define IW_MODE_SECOND 5 /* Secondary master/repeater (backup) */
427 #define IW_MODE_MONITOR 6 /* Passive monitor (listen only) */
429 /* Statistics flags (bitmask in updated) */
430 #define IW_QUAL_QUAL_UPDATED 0x1 /* Value was updated since last read */
431 #define IW_QUAL_LEVEL_UPDATED 0x2
432 #define IW_QUAL_NOISE_UPDATED 0x4
433 #define IW_QUAL_QUAL_INVALID 0x10 /* Driver doesn't provide value */
434 #define IW_QUAL_LEVEL_INVALID 0x20
435 #define IW_QUAL_NOISE_INVALID 0x40
437 /* Frequency flags */
438 #define IW_FREQ_AUTO 0x00 /* Let the driver decides */
439 #define IW_FREQ_FIXED 0x01 /* Force a specific value */
441 /* Maximum number of size of encoding token available
442 * they are listed in the range structure */
443 #define IW_MAX_ENCODING_SIZES 8
445 /* Maximum size of the encoding token in bytes */
446 #define IW_ENCODING_TOKEN_MAX 32 /* 256 bits (for now) */
448 /* Flags for encoding (along with the token) */
449 #define IW_ENCODE_INDEX 0x00FF /* Token index (if needed) */
450 #define IW_ENCODE_FLAGS 0xFF00 /* Flags defined below */
451 #define IW_ENCODE_MODE 0xF000 /* Modes defined below */
452 #define IW_ENCODE_DISABLED 0x8000 /* Encoding disabled */
453 #define IW_ENCODE_ENABLED 0x0000 /* Encoding enabled */
454 #define IW_ENCODE_RESTRICTED 0x4000 /* Refuse non-encoded packets */
455 #define IW_ENCODE_OPEN 0x2000 /* Accept non-encoded packets */
456 #define IW_ENCODE_NOKEY 0x0800 /* Key is write only, so not present */
457 #define IW_ENCODE_TEMP 0x0400 /* Temporary key */
459 /* Power management flags available (along with the value, if any) */
460 #define IW_POWER_ON 0x0000 /* No details... */
461 #define IW_POWER_TYPE 0xF000 /* Type of parameter */
462 #define IW_POWER_PERIOD 0x1000 /* Value is a period/duration of */
463 #define IW_POWER_TIMEOUT 0x2000 /* Value is a timeout (to go asleep) */
464 #define IW_POWER_MODE 0x0F00 /* Power Management mode */
465 #define IW_POWER_UNICAST_R 0x0100 /* Receive only unicast messages */
466 #define IW_POWER_MULTICAST_R 0x0200 /* Receive only multicast messages */
467 #define IW_POWER_ALL_R 0x0300 /* Receive all messages though PM */
468 #define IW_POWER_FORCE_S 0x0400 /* Force PM procedure for sending unicast */
469 #define IW_POWER_REPEATER 0x0800 /* Repeat broadcast messages in PM period */
470 #define IW_POWER_MODIFIER 0x000F /* Modify a parameter */
471 #define IW_POWER_MIN 0x0001 /* Value is a minimum */
472 #define IW_POWER_MAX 0x0002 /* Value is a maximum */
473 #define IW_POWER_RELATIVE 0x0004 /* Value is not in seconds/ms/us */
475 /* Transmit Power flags available */
476 #define IW_TXPOW_TYPE 0x00FF /* Type of value */
477 #define IW_TXPOW_DBM 0x0000 /* Value is in dBm */
478 #define IW_TXPOW_MWATT 0x0001 /* Value is in mW */
479 #define IW_TXPOW_RELATIVE 0x0002 /* Value is in arbitrary units */
480 #define IW_TXPOW_RANGE 0x1000 /* Range of value between min/max */
482 /* Retry limits and lifetime flags available */
483 #define IW_RETRY_ON 0x0000 /* No details... */
484 #define IW_RETRY_TYPE 0xF000 /* Type of parameter */
485 #define IW_RETRY_LIMIT 0x1000 /* Maximum number of retries*/
486 #define IW_RETRY_LIFETIME 0x2000 /* Maximum duration of retries in us */
487 #define IW_RETRY_MODIFIER 0x000F /* Modify a parameter */
488 #define IW_RETRY_MIN 0x0001 /* Value is a minimum */
489 #define IW_RETRY_MAX 0x0002 /* Value is a maximum */
490 #define IW_RETRY_RELATIVE 0x0004 /* Value is not in seconds/ms/us */
492 /* Scanning request flags */
493 #define IW_SCAN_DEFAULT 0x0000 /* Default scan of the driver */
494 #define IW_SCAN_ALL_ESSID 0x0001 /* Scan all ESSIDs */
495 #define IW_SCAN_THIS_ESSID 0x0002 /* Scan only this ESSID */
496 #define IW_SCAN_ALL_FREQ 0x0004 /* Scan all Frequencies */
497 #define IW_SCAN_THIS_FREQ 0x0008 /* Scan only this Frequency */
498 #define IW_SCAN_ALL_MODE 0x0010 /* Scan all Modes */
499 #define IW_SCAN_THIS_MODE 0x0020 /* Scan only this Mode */
500 #define IW_SCAN_ALL_RATE 0x0040 /* Scan all Bit-Rates */
501 #define IW_SCAN_THIS_RATE 0x0080 /* Scan only this Bit-Rate */
502 /* struct iw_scan_req scan_type */
503 #define IW_SCAN_TYPE_ACTIVE 0
504 #define IW_SCAN_TYPE_PASSIVE 1
505 /* Maximum size of returned data */
506 #define IW_SCAN_MAX_DATA 4096 /* In bytes */
508 /* Max number of char in custom event - use multiple of them if needed */
509 #define IW_CUSTOM_MAX 256 /* In bytes */
511 /* Generic information element */
512 #define IW_GENERIC_IE_MAX 1024
514 /* MLME requests (SIOCSIWMLME / struct iw_mlme) */
515 #define IW_MLME_DEAUTH 0
516 #define IW_MLME_DISASSOC 1
518 /* SIOCSIWAUTH/SIOCGIWAUTH struct iw_param flags */
519 #define IW_AUTH_INDEX 0x0FFF
520 #define IW_AUTH_FLAGS 0xF000
521 /* SIOCSIWAUTH/SIOCGIWAUTH parameters (0 .. 4095)
522 * (IW_AUTH_INDEX mask in struct iw_param flags; this is the index of the
523 * parameter that is being set/get to; value will be read/written to
524 * struct iw_param value field) */
525 #define IW_AUTH_WPA_VERSION 0
526 #define IW_AUTH_CIPHER_PAIRWISE 1
527 #define IW_AUTH_CIPHER_GROUP 2
528 #define IW_AUTH_KEY_MGMT 3
529 #define IW_AUTH_TKIP_COUNTERMEASURES 4
530 #define IW_AUTH_DROP_UNENCRYPTED 5
531 #define IW_AUTH_80211_AUTH_ALG 6
532 #define IW_AUTH_WPA_ENABLED 7
533 #define IW_AUTH_RX_UNENCRYPTED_EAPOL 8
534 #define IW_AUTH_ROAMING_CONTROL 9
535 #define IW_AUTH_PRIVACY_INVOKED 10
537 /* IW_AUTH_WPA_VERSION values (bit field) */
538 #define IW_AUTH_WPA_VERSION_DISABLED 0x00000001
539 #define IW_AUTH_WPA_VERSION_WPA 0x00000002
540 #define IW_AUTH_WPA_VERSION_WPA2 0x00000004
542 /* IW_AUTH_PAIRWISE_CIPHER and IW_AUTH_GROUP_CIPHER values (bit field) */
543 #define IW_AUTH_CIPHER_NONE 0x00000001
544 #define IW_AUTH_CIPHER_WEP40 0x00000002
545 #define IW_AUTH_CIPHER_TKIP 0x00000004
546 #define IW_AUTH_CIPHER_CCMP 0x00000008
547 #define IW_AUTH_CIPHER_WEP104 0x00000010
549 /* IW_AUTH_KEY_MGMT values (bit field) */
550 #define IW_AUTH_KEY_MGMT_802_1X 1
551 #define IW_AUTH_KEY_MGMT_PSK 2
553 /* IW_AUTH_80211_AUTH_ALG values (bit field) */
554 #define IW_AUTH_ALG_OPEN_SYSTEM 0x00000001
555 #define IW_AUTH_ALG_SHARED_KEY 0x00000002
556 #define IW_AUTH_ALG_LEAP 0x00000004
558 /* IW_AUTH_ROAMING_CONTROL values */
559 #define IW_AUTH_ROAMING_ENABLE 0 /* driver/firmware based roaming */
560 #define IW_AUTH_ROAMING_DISABLE 1 /* user space program used for roaming
563 /* SIOCSIWENCODEEXT definitions */
564 #define IW_ENCODE_SEQ_MAX_SIZE 8
565 /* struct iw_encode_ext ->alg */
566 #define IW_ENCODE_ALG_NONE 0
567 #define IW_ENCODE_ALG_WEP 1
568 #define IW_ENCODE_ALG_TKIP 2
569 #define IW_ENCODE_ALG_CCMP 3
570 /* struct iw_encode_ext ->ext_flags */
571 #define IW_ENCODE_EXT_TX_SEQ_VALID 0x00000001
572 #define IW_ENCODE_EXT_RX_SEQ_VALID 0x00000002
573 #define IW_ENCODE_EXT_GROUP_KEY 0x00000004
574 #define IW_ENCODE_EXT_SET_TX_KEY 0x00000008
576 /* IWEVMICHAELMICFAILURE : struct iw_michaelmicfailure ->flags */
577 #define IW_MICFAILURE_KEY_ID 0x00000003 /* Key ID 0..3 */
578 #define IW_MICFAILURE_GROUP 0x00000004
579 #define IW_MICFAILURE_PAIRWISE 0x00000008
580 #define IW_MICFAILURE_STAKEY 0x00000010
581 #define IW_MICFAILURE_COUNT 0x00000060 /* 1 or 2 (0 = count not supported)
584 /* Bit field values for enc_capa in struct iw_range */
585 #define IW_ENC_CAPA_WPA 0x00000001
586 #define IW_ENC_CAPA_WPA2 0x00000002
587 #define IW_ENC_CAPA_CIPHER_TKIP 0x00000004
588 #define IW_ENC_CAPA_CIPHER_CCMP 0x00000008
590 /* Event capability macros - in (struct iw_range *)->event_capa
591 * Because we have more than 32 possible events, we use an array of
592 * 32 bit bitmasks. Note : 32 bits = 0x20 = 2^5. */
593 #define IW_EVENT_CAPA_BASE(cmd) ((cmd >= SIOCIWFIRSTPRIV) ? \
594 (cmd - SIOCIWFIRSTPRIV + 0x60) : \
595 (cmd - SIOCSIWCOMMIT))
596 #define IW_EVENT_CAPA_INDEX(cmd) (IW_EVENT_CAPA_BASE(cmd) >> 5)
597 #define IW_EVENT_CAPA_MASK(cmd) (1 << (IW_EVENT_CAPA_BASE(cmd) & 0x1F))
598 /* Event capability constants - event autogenerated by the kernel
599 * This list is valid for most 802.11 devices, customise as needed... */
600 #define IW_EVENT_CAPA_K_0 (IW_EVENT_CAPA_MASK(0x8B04) | \
601 IW_EVENT_CAPA_MASK(0x8B06) | \
602 IW_EVENT_CAPA_MASK(0x8B1A))
603 #define IW_EVENT_CAPA_K_1 (IW_EVENT_CAPA_MASK(0x8B2A))
604 /* "Easy" macro to set events in iw_range (less efficient) */
605 #define IW_EVENT_CAPA_SET(event_capa, cmd) (event_capa[IW_EVENT_CAPA_INDEX(cmd)] |= IW_EVENT_CAPA_MASK(cmd))
606 #define IW_EVENT_CAPA_SET_KERNEL(event_capa) {event_capa[0] |= IW_EVENT_CAPA_K_0; event_capa[1] |= IW_EVENT_CAPA_K_1; }
609 /****************************** TYPES ******************************/
611 /* --------------------------- SUBTYPES --------------------------- */
613 * Generic format for most parameters that fit in an int
617 __s32 value
; /* The value of the parameter itself */
618 __u8 fixed
; /* Hardware should not use auto select */
619 __u8 disabled
; /* Disable the feature */
620 __u16 flags
; /* Various specifc flags (if any) */
624 * For all data larger than 16 octets, we need to use a
625 * pointer to memory allocated in user space.
629 void __user
*pointer
; /* Pointer to the data (in user space) */
630 __u16 length
; /* number of fields or size in bytes */
631 __u16 flags
; /* Optional params */
636 * For numbers lower than 10^9, we encode the number in 'm' and
638 * For number greater than 10^9, we divide it by the lowest power
639 * of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
640 * The power of 10 is in 'e', the result of the division is in 'm'.
644 __s32 m
; /* Mantissa */
645 __s16 e
; /* Exponent */
646 __u8 i
; /* List index (when in range struct) */
647 __u8 flags
; /* Flags (fixed/auto) */
651 * Quality of the link
655 __u8 qual
; /* link quality (%retries, SNR,
656 %missed beacons or better...) */
657 __u8 level
; /* signal level (dBm) */
658 __u8 noise
; /* noise level (dBm) */
659 __u8 updated
; /* Flags to know if updated */
663 * Packet discarded in the wireless adapter due to
664 * "wireless" specific problems...
665 * Note : the list of counter and statistics in net_device_stats
666 * is already pretty exhaustive, and you should use that first.
667 * This is only additional stats...
671 __u32 nwid
; /* Rx : Wrong nwid/essid */
672 __u32 code
; /* Rx : Unable to code/decode (WEP) */
673 __u32 fragment
; /* Rx : Can't perform MAC reassembly */
674 __u32 retries
; /* Tx : Max MAC retries num reached */
675 __u32 misc
; /* Others cases */
679 * Packet/Time period missed in the wireless adapter due to
680 * "wireless" specific problems...
684 __u32 beacon
; /* Missed beacons/superframe */
688 * Quality range (for spy threshold)
692 struct sockaddr addr
; /* Source address (hw/mac) */
693 struct iw_quality qual
; /* Quality of the link */
694 struct iw_quality low
; /* Low threshold */
695 struct iw_quality high
; /* High threshold */
699 * Optional data for scan request
701 * Note: these optional parameters are controlling parameters for the
702 * scanning behavior, these do not apply to getting scan results
703 * (SIOCGIWSCAN). Drivers are expected to keep a local BSS table and
704 * provide a merged results with all BSSes even if the previous scan
705 * request limited scanning to a subset, e.g., by specifying an SSID.
706 * Especially, scan results are required to include an entry for the
707 * current BSS if the driver is in Managed mode and associated with an AP.
711 __u8 scan_type
; /* IW_SCAN_TYPE_{ACTIVE,PASSIVE} */
713 __u8 num_channels
; /* num entries in channel_list;
714 * 0 = scan all allowed channels */
715 __u8 flags
; /* reserved as padding; use zero, this may
716 * be used in the future for adding flags
717 * to request different scan behavior */
718 struct sockaddr bssid
; /* ff:ff:ff:ff:ff:ff for broadcast BSSID or
719 * individual address of a specific BSS */
722 * Use this ESSID if IW_SCAN_THIS_ESSID flag is used instead of using
723 * the current ESSID. This allows scan requests for specific ESSID
724 * without having to change the current ESSID and potentially breaking
725 * the current association.
727 __u8 essid
[IW_ESSID_MAX_SIZE
];
730 * Optional parameters for changing the default scanning behavior.
731 * These are based on the MLME-SCAN.request from IEEE Std 802.11.
732 * TU is 1.024 ms. If these are set to 0, driver is expected to use
733 * reasonable default values. min_channel_time defines the time that
734 * will be used to wait for the first reply on each channel. If no
735 * replies are received, next channel will be scanned after this. If
736 * replies are received, total time waited on the channel is defined by
739 __u32 min_channel_time
; /* in TU */
740 __u32 max_channel_time
; /* in TU */
742 struct iw_freq channel_list
[IW_MAX_FREQUENCIES
];
745 /* ------------------------- WPA SUPPORT ------------------------- */
748 * Extended data structure for get/set encoding (this is used with
749 * SIOCSIWENCODEEXT/SIOCGIWENCODEEXT. struct iw_point and IW_ENCODE_*
750 * flags are used in the same way as with SIOCSIWENCODE/SIOCGIWENCODE and
751 * only the data contents changes (key data -> this structure, including
754 * If the new key is the first group key, it will be set as the default
755 * TX key. Otherwise, default TX key index is only changed if
756 * IW_ENCODE_EXT_SET_TX_KEY flag is set.
758 * Key will be changed with SIOCSIWENCODEEXT in all cases except for
759 * special "change TX key index" operation which is indicated by setting
760 * key_len = 0 and ext_flags |= IW_ENCODE_EXT_SET_TX_KEY.
762 * tx_seq/rx_seq are only used when respective
763 * IW_ENCODE_EXT_{TX,RX}_SEQ_VALID flag is set in ext_flags. Normal
764 * TKIP/CCMP operation is to set RX seq with SIOCSIWENCODEEXT and start
765 * TX seq from zero whenever key is changed. SIOCGIWENCODEEXT is normally
766 * used only by an Authenticator (AP or an IBSS station) to get the
767 * current TX sequence number. Using TX_SEQ_VALID for SIOCSIWENCODEEXT and
768 * RX_SEQ_VALID for SIOCGIWENCODEEXT are optional, but can be useful for
773 __u32 ext_flags
; /* IW_ENCODE_EXT_* */
774 __u8 tx_seq
[IW_ENCODE_SEQ_MAX_SIZE
]; /* LSB first */
775 __u8 rx_seq
[IW_ENCODE_SEQ_MAX_SIZE
]; /* LSB first */
776 struct sockaddr addr
; /* ff:ff:ff:ff:ff:ff for broadcast/multicast
777 * (group) keys or unicast address for
779 __u16 alg
; /* IW_ENCODE_ALG_* */
784 /* SIOCSIWMLME data */
787 __u16 cmd
; /* IW_MLME_* */
789 struct sockaddr addr
;
792 /* SIOCSIWPMKSA data */
793 #define IW_PMKSA_ADD 1
794 #define IW_PMKSA_REMOVE 2
795 #define IW_PMKSA_FLUSH 3
797 #define IW_PMKID_LEN 16
801 __u32 cmd
; /* IW_PMKSA_* */
802 struct sockaddr bssid
;
803 __u8 pmkid
[IW_PMKID_LEN
];
806 /* IWEVMICHAELMICFAILURE data */
807 struct iw_michaelmicfailure
810 struct sockaddr src_addr
;
811 __u8 tsc
[IW_ENCODE_SEQ_MAX_SIZE
]; /* LSB first */
814 /* IWEVPMKIDCAND data */
815 #define IW_PMKID_CAND_PREAUTH 0x00000001 /* RNS pre-authentication enabled */
818 __u32 flags
; /* IW_PMKID_CAND_* */
819 __u32 index
; /* the smaller the index, the higher the
821 struct sockaddr bssid
;
824 /* ------------------------ WIRELESS STATS ------------------------ */
826 * Wireless statistics (used for /proc/net/wireless)
830 __u16 status
; /* Status
831 * - device dependent for now */
833 struct iw_quality qual
; /* Quality of the link
834 * (instant/mean/max) */
835 struct iw_discarded discard
; /* Packet discarded counts */
836 struct iw_missed miss
; /* Packet missed counts */
839 /* ------------------------ IOCTL REQUEST ------------------------ */
841 * This structure defines the payload of an ioctl, and is used
844 * Note that this structure should fit on the memory footprint
845 * of iwreq (which is the same as ifreq), which mean a max size of
846 * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
847 * You should check this when increasing the structures defined
848 * above in this file...
852 /* Config - generic */
854 /* Name : used to verify the presence of wireless extensions.
855 * Name of the protocol/provider... */
857 struct iw_point essid
; /* Extended network name */
858 struct iw_param nwid
; /* network id (or domain - the cell) */
859 struct iw_freq freq
; /* frequency or channel :
861 * > 1000 = frequency in Hz */
863 struct iw_param sens
; /* signal level threshold */
864 struct iw_param bitrate
; /* default bit rate */
865 struct iw_param txpower
; /* default transmit power */
866 struct iw_param rts
; /* RTS threshold threshold */
867 struct iw_param frag
; /* Fragmentation threshold */
868 __u32 mode
; /* Operation mode */
869 struct iw_param retry
; /* Retry limits & lifetime */
871 struct iw_point encoding
; /* Encoding stuff : tokens */
872 struct iw_param power
; /* PM duration/timeout */
873 struct iw_quality qual
; /* Quality part of statistics */
875 struct sockaddr ap_addr
; /* Access point address */
876 struct sockaddr addr
; /* Destination address (hw/mac) */
878 struct iw_param param
; /* Other small parameters */
879 struct iw_point data
; /* Other large parameters */
883 * The structure to exchange data for ioctl.
884 * This structure is the same as 'struct ifreq', but (re)defined for
886 * Do I need to remind you about structure size (32 octets) ?
892 char ifrn_name
[IFNAMSIZ
]; /* if name, e.g. "eth0" */
895 /* Data part (defined just above) */
899 /* -------------------------- IOCTL DATA -------------------------- */
901 * For those ioctl which want to exchange mode data that what could
902 * fit in the above structure...
906 * Range of parameters
911 /* Informative stuff (to choose between different interface) */
912 __u32 throughput
; /* To give an idea... */
913 /* In theory this value should be the maximum benchmarked
914 * TCP/IP throughput, because with most of these devices the
915 * bit rate is meaningless (overhead an co) to estimate how
916 * fast the connection will go and pick the fastest one.
917 * I suggest people to play with Netperf or any benchmark...
920 /* NWID (or domain id) */
921 __u32 min_nwid
; /* Minimal NWID we are able to set */
922 __u32 max_nwid
; /* Maximal NWID we are able to set */
924 /* Old Frequency (backward compat - moved lower ) */
925 __u16 old_num_channels
;
926 __u8 old_num_frequency
;
928 /* Wireless event capability bitmasks */
931 /* signal level threshold range */
934 /* Quality of link & SNR stuff */
935 /* Quality range (link, level, noise)
936 * If the quality is absolute, it will be in the range [0 ; max_qual],
937 * if the quality is dBm, it will be in the range [max_qual ; 0].
938 * Don't forget that we use 8 bit arithmetics... */
939 struct iw_quality max_qual
; /* Quality of the link */
940 /* This should contain the average/typical values of the quality
941 * indicator. This should be the threshold between a "good" and
942 * a "bad" link (example : monitor going from green to orange).
943 * Currently, user space apps like quality monitors don't have any
944 * way to calibrate the measurement. With this, they can split
945 * the range between 0 and max_qual in different quality level
946 * (using a geometric subdivision centered on the average).
947 * I expect that people doing the user space apps will feedback
948 * us on which value we need to put in each driver... */
949 struct iw_quality avg_qual
; /* Quality of the link */
952 __u8 num_bitrates
; /* Number of entries in the list */
953 __s32 bitrate
[IW_MAX_BITRATES
]; /* list, in bps */
956 __s32 min_rts
; /* Minimal RTS threshold */
957 __s32 max_rts
; /* Maximal RTS threshold */
960 __s32 min_frag
; /* Minimal frag threshold */
961 __s32 max_frag
; /* Maximal frag threshold */
963 /* Power Management duration & timeout */
964 __s32 min_pmp
; /* Minimal PM period */
965 __s32 max_pmp
; /* Maximal PM period */
966 __s32 min_pmt
; /* Minimal PM timeout */
967 __s32 max_pmt
; /* Maximal PM timeout */
968 __u16 pmp_flags
; /* How to decode max/min PM period */
969 __u16 pmt_flags
; /* How to decode max/min PM timeout */
970 __u16 pm_capa
; /* What PM options are supported */
973 __u16 encoding_size
[IW_MAX_ENCODING_SIZES
]; /* Different token sizes */
974 __u8 num_encoding_sizes
; /* Number of entry in the list */
975 __u8 max_encoding_tokens
; /* Max number of tokens */
976 /* For drivers that need a "login/passwd" form */
977 __u8 encoding_login_index
; /* token index for login token */
980 __u16 txpower_capa
; /* What options are supported */
981 __u8 num_txpower
; /* Number of entries in the list */
982 __s32 txpower
[IW_MAX_TXPOWER
]; /* list, in bps */
984 /* Wireless Extension version info */
985 __u8 we_version_compiled
; /* Must be WIRELESS_EXT */
986 __u8 we_version_source
; /* Last update of source */
988 /* Retry limits and lifetime */
989 __u16 retry_capa
; /* What retry options are supported */
990 __u16 retry_flags
; /* How to decode max/min retry limit */
991 __u16 r_time_flags
; /* How to decode max/min retry life */
992 __s32 min_retry
; /* Minimal number of retries */
993 __s32 max_retry
; /* Maximal number of retries */
994 __s32 min_r_time
; /* Minimal retry lifetime */
995 __s32 max_r_time
; /* Maximal retry lifetime */
998 __u16 num_channels
; /* Number of channels [0; num - 1] */
999 __u8 num_frequency
; /* Number of entry in the list */
1000 struct iw_freq freq
[IW_MAX_FREQUENCIES
]; /* list */
1001 /* Note : this frequency list doesn't need to fit channel numbers,
1002 * because each entry contain its channel index */
1004 __u32 enc_capa
; /* IW_ENC_CAPA_* bit field */
1008 * Private ioctl interface information
1013 __u32 cmd
; /* Number of the ioctl to issue */
1014 __u16 set_args
; /* Type and number of args */
1015 __u16 get_args
; /* Type and number of args */
1016 char name
[IFNAMSIZ
]; /* Name of the extension */
1019 /* ----------------------- WIRELESS EVENTS ----------------------- */
1021 * Wireless events are carried through the rtnetlink socket to user
1022 * space. They are encapsulated in the IFLA_WIRELESS field of
1023 * a RTM_NEWLINK message.
1027 * A Wireless Event. Contains basically the same data as the ioctl...
1031 __u16 len
; /* Real lenght of this stuff */
1032 __u16 cmd
; /* Wireless IOCTL */
1033 union iwreq_data u
; /* IOCTL fixed payload */
1036 /* Size of the Event prefix (including padding and alignement junk) */
1037 #define IW_EV_LCP_LEN (sizeof(struct iw_event) - sizeof(union iwreq_data))
1038 /* Size of the various events */
1039 #define IW_EV_CHAR_LEN (IW_EV_LCP_LEN + IFNAMSIZ)
1040 #define IW_EV_UINT_LEN (IW_EV_LCP_LEN + sizeof(__u32))
1041 #define IW_EV_FREQ_LEN (IW_EV_LCP_LEN + sizeof(struct iw_freq))
1042 #define IW_EV_POINT_LEN (IW_EV_LCP_LEN + sizeof(struct iw_point))
1043 #define IW_EV_PARAM_LEN (IW_EV_LCP_LEN + sizeof(struct iw_param))
1044 #define IW_EV_ADDR_LEN (IW_EV_LCP_LEN + sizeof(struct sockaddr))
1045 #define IW_EV_QUAL_LEN (IW_EV_LCP_LEN + sizeof(struct iw_quality))
1047 /* Note : in the case of iw_point, the extra data will come at the
1048 * end of the event */
1050 #endif /* _LINUX_WIRELESS_H */