2 * This file define a set of standard wireless extensions
6 * Authors : Jean Tourrilhes - HPL - <jt@hpl.hp.com>
7 * Copyright (c) 1997-2007 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 #include <linux/types.h> /* for __u* and __s* typedefs */
73 #include <linux/socket.h> /* for "struct sockaddr" et al */
74 #include <linux/if.h> /* for IFNAMSIZ and co... */
76 /***************************** VERSION *****************************/
78 * This constant is used to know the availability of the wireless
79 * extensions and to know which version of wireless extensions it is
80 * (there is some stuff that will be added in the future...)
81 * I just plan to increment with each new version.
83 #define WIRELESS_EXT 22
90 * Alan Cox start some incompatibles changes. I've integrated a bit more.
91 * - Encryption renamed to Encode to avoid US regulation problems
92 * - Frequency changed from float to struct to avoid problems on old 386
100 * - Missing encoding definitions in range
101 * - Access points stuff
105 * - 802.11 support (ESSID ioctls)
109 * - define IW_ESSID_MAX_SIZE and IW_MAX_AP
113 * - Changed my e-mail address
114 * - More 802.11 support (nickname, rate, rts, frag)
115 * - List index in frequencies
119 * - Support for 'mode of operation' (ad-hoc, managed...)
120 * - Support for unicast and multicast power saving
121 * - Change encoding to support larger tokens (>64 bits)
122 * - Updated iw_params (disable, flags) and use it for NWID
123 * - Extracted iw_point from iwreq for clarity
127 * - Add PM capability to range structure
128 * - Add PM modifier : MAX/MIN/RELATIVE
129 * - Add encoding option : IW_ENCODE_NOKEY
130 * - Add TxPower ioctls (work like TxRate)
134 * - Add WE version in range (help backward/forward compatibility)
135 * - Add retry ioctls (work like PM)
139 * - Add SIOCSIWSTATS to get /proc/net/wireless programatically
140 * - Add DEV PRIVATE IOCTL to avoid collisions in SIOCDEVPRIVATE space
141 * - Add new statistics (frag, retry, beacon)
142 * - Add average quality (for user space calibration)
146 * - Document creation of new driver API.
147 * - Extract union iwreq_data from struct iwreq (for new driver API).
148 * - Rename SIOCSIWNAME as SIOCSIWCOMMIT
152 * - Wireless Events support : define struct iw_event
153 * - Define additional specific event numbers
154 * - Add "addr" and "param" fields in union iwreq_data
155 * - AP scanning stuff (SIOCSIWSCAN and friends)
159 * - Add IW_PRIV_TYPE_ADDR for struct sockaddr private arg
160 * - Make struct iw_freq signed (both m & e), add explicit padding
161 * - Add IWEVCUSTOM for driver specific event/scanning token
162 * - Add IW_MAX_GET_SPY for driver returning a lot of addresses
163 * - Add IW_TXPOW_RANGE for range of Tx Powers
164 * - Add IWEVREGISTERED & IWEVEXPIRED events for Access Points
165 * - Add IW_MODE_MONITOR for passive monitor
169 * - Increase the number of bitrates in iw_range to 32 (for 802.11g)
170 * - Increase the number of frequencies in iw_range to 32 (for 802.11b+a)
171 * - Reshuffle struct iw_range for increases, add filler
172 * - Increase IW_MAX_AP to 64 for driver returning a lot of addresses
173 * - Remove IW_MAX_GET_SPY because conflict with enhanced spy support
174 * - Add SIOCSIWTHRSPY/SIOCGIWTHRSPY and "struct iw_thrspy"
175 * - Add IW_ENCODE_TEMP and iw_range->encoding_login_index
179 * - Add flags to frequency -> auto/fixed
180 * - Document (struct iw_quality *)->updated, add new flags (INVALID)
181 * - Wireless Event capability in struct iw_range
182 * - Add support for relative TxPower (yick !)
184 * V17 to V18 (From Jouni Malinen <j@w1.fi>)
186 * - Add support for WPA/WPA2
187 * - Add extended encoding configuration (SIOCSIWENCODEEXT and
189 * - Add SIOCSIWGENIE/SIOCGIWGENIE
192 * - Add struct iw_range bit field for supported encoding capabilities
193 * - Add optional scan request parameters for SIOCSIWSCAN
194 * - Add SIOCSIWAUTH/SIOCGIWAUTH for setting authentication and WPA
195 * related parameters (extensible up to 4096 parameter values)
196 * - Add wireless events: IWEVGENIE, IWEVMICHAELMICFAILURE,
197 * IWEVASSOCREQIE, IWEVASSOCRESPIE, IWEVPMKIDCAND
201 * - Remove (struct iw_point *)->pointer from events and streams
202 * - Remove header includes to help user space
203 * - Increase IW_ENCODING_TOKEN_MAX from 32 to 64
204 * - Add IW_QUAL_ALL_UPDATED and IW_QUAL_ALL_INVALID macros
205 * - Add explicit flag to tell stats are in dBm : IW_QUAL_DBM
206 * - Add IW_IOCTL_IDX() and IW_EVENT_IDX() macros
210 * - RtNetlink requests support (SET/GET)
214 * - Remove (struct net_device *)->get_wireless_stats()
215 * - Change length in ESSID and NICK to strlen() instead of strlen()+1
216 * - Add IW_RETRY_SHORT/IW_RETRY_LONG retry modifiers
217 * - Power/Retry relative values no longer * 100000
218 * - Add explicit flag to tell stats are in 802.11k RCPI : IW_QUAL_RCPI
222 * - Prevent leaking of kernel space in stream on 64 bits.
225 /**************************** CONSTANTS ****************************/
227 /* -------------------------- IOCTL LIST -------------------------- */
229 /* Wireless Identification */
230 #define SIOCSIWCOMMIT 0x8B00 /* Commit pending changes to driver */
231 #define SIOCGIWNAME 0x8B01 /* get name == wireless protocol */
232 /* SIOCGIWNAME is used to verify the presence of Wireless Extensions.
233 * Common values : "IEEE 802.11-DS", "IEEE 802.11-FH", "IEEE 802.11b"...
234 * Don't put the name of your driver there, it's useless. */
236 /* Basic operations */
237 #define SIOCSIWNWID 0x8B02 /* set network id (pre-802.11) */
238 #define SIOCGIWNWID 0x8B03 /* get network id (the cell) */
239 #define SIOCSIWFREQ 0x8B04 /* set channel/frequency (Hz) */
240 #define SIOCGIWFREQ 0x8B05 /* get channel/frequency (Hz) */
241 #define SIOCSIWMODE 0x8B06 /* set operation mode */
242 #define SIOCGIWMODE 0x8B07 /* get operation mode */
243 #define SIOCSIWSENS 0x8B08 /* set sensitivity (dBm) */
244 #define SIOCGIWSENS 0x8B09 /* get sensitivity (dBm) */
246 /* Informative stuff */
247 #define SIOCSIWRANGE 0x8B0A /* Unused */
248 #define SIOCGIWRANGE 0x8B0B /* Get range of parameters */
249 #define SIOCSIWPRIV 0x8B0C /* Unused */
250 #define SIOCGIWPRIV 0x8B0D /* get private ioctl interface info */
251 #define SIOCSIWSTATS 0x8B0E /* Unused */
252 #define SIOCGIWSTATS 0x8B0F /* Get /proc/net/wireless stats */
253 /* SIOCGIWSTATS is strictly used between user space and the kernel, and
254 * is never passed to the driver (i.e. the driver will never see it). */
256 /* Spy support (statistics per MAC address - used for Mobile IP support) */
257 #define SIOCSIWSPY 0x8B10 /* set spy addresses */
258 #define SIOCGIWSPY 0x8B11 /* get spy info (quality of link) */
259 #define SIOCSIWTHRSPY 0x8B12 /* set spy threshold (spy event) */
260 #define SIOCGIWTHRSPY 0x8B13 /* get spy threshold */
262 /* Access Point manipulation */
263 #define SIOCSIWAP 0x8B14 /* set access point MAC addresses */
264 #define SIOCGIWAP 0x8B15 /* get access point MAC addresses */
265 #define SIOCGIWAPLIST 0x8B17 /* Deprecated in favor of scanning */
266 #define SIOCSIWSCAN 0x8B18 /* trigger scanning (list cells) */
267 #define SIOCGIWSCAN 0x8B19 /* get scanning results */
269 /* 802.11 specific support */
270 #define SIOCSIWESSID 0x8B1A /* set ESSID (network name) */
271 #define SIOCGIWESSID 0x8B1B /* get ESSID */
272 #define SIOCSIWNICKN 0x8B1C /* set node name/nickname */
273 #define SIOCGIWNICKN 0x8B1D /* get node name/nickname */
274 /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
275 * within the 'iwreq' structure, so we need to use the 'data' member to
276 * point to a string in user space, like it is done for RANGE... */
278 /* Other parameters useful in 802.11 and some other devices */
279 #define SIOCSIWRATE 0x8B20 /* set default bit rate (bps) */
280 #define SIOCGIWRATE 0x8B21 /* get default bit rate (bps) */
281 #define SIOCSIWRTS 0x8B22 /* set RTS/CTS threshold (bytes) */
282 #define SIOCGIWRTS 0x8B23 /* get RTS/CTS threshold (bytes) */
283 #define SIOCSIWFRAG 0x8B24 /* set fragmentation thr (bytes) */
284 #define SIOCGIWFRAG 0x8B25 /* get fragmentation thr (bytes) */
285 #define SIOCSIWTXPOW 0x8B26 /* set transmit power (dBm) */
286 #define SIOCGIWTXPOW 0x8B27 /* get transmit power (dBm) */
287 #define SIOCSIWRETRY 0x8B28 /* set retry limits and lifetime */
288 #define SIOCGIWRETRY 0x8B29 /* get retry limits and lifetime */
290 /* Encoding stuff (scrambling, hardware security, WEP...) */
291 #define SIOCSIWENCODE 0x8B2A /* set encoding token & mode */
292 #define SIOCGIWENCODE 0x8B2B /* get encoding token & mode */
293 /* Power saving stuff (power management, unicast and multicast) */
294 #define SIOCSIWPOWER 0x8B2C /* set Power Management settings */
295 #define SIOCGIWPOWER 0x8B2D /* get Power Management settings */
297 /* WPA : Generic IEEE 802.11 informatiom element (e.g., for WPA/RSN/WMM).
298 * This ioctl uses struct iw_point and data buffer that includes IE id and len
299 * fields. More than one IE may be included in the request. Setting the generic
300 * IE to empty buffer (len=0) removes the generic IE from the driver. Drivers
301 * are allowed to generate their own WPA/RSN IEs, but in these cases, drivers
302 * are required to report the used IE as a wireless event, e.g., when
303 * associating with an AP. */
304 #define SIOCSIWGENIE 0x8B30 /* set generic IE */
305 #define SIOCGIWGENIE 0x8B31 /* get generic IE */
307 /* WPA : IEEE 802.11 MLME requests */
308 #define SIOCSIWMLME 0x8B16 /* request MLME operation; uses
310 /* WPA : Authentication mode parameters */
311 #define SIOCSIWAUTH 0x8B32 /* set authentication mode params */
312 #define SIOCGIWAUTH 0x8B33 /* get authentication mode params */
314 /* WPA : Extended version of encoding configuration */
315 #define SIOCSIWENCODEEXT 0x8B34 /* set encoding token & mode */
316 #define SIOCGIWENCODEEXT 0x8B35 /* get encoding token & mode */
318 /* WPA2 : PMKSA cache management */
319 #define SIOCSIWPMKSA 0x8B36 /* PMKSA cache operation */
321 /* -------------------- DEV PRIVATE IOCTL LIST -------------------- */
323 /* These 32 ioctl are wireless device private, for 16 commands.
324 * Each driver is free to use them for whatever purpose it chooses,
325 * however the driver *must* export the description of those ioctls
326 * with SIOCGIWPRIV and *must* use arguments as defined below.
327 * If you don't follow those rules, DaveM is going to hate you (reason :
328 * it make mixed 32/64bit operation impossible).
330 #define SIOCIWFIRSTPRIV 0x8BE0
331 #define SIOCIWLASTPRIV 0x8BFF
332 /* Previously, we were using SIOCDEVPRIVATE, but we now have our
333 * separate range because of collisions with other tools such as
335 * We now have 32 commands, so a bit more space ;-).
336 * Also, all 'even' commands are only usable by root and don't return the
337 * content of ifr/iwr to user (but you are not obliged to use the set/get
338 * convention, just use every other two command). More details in iwpriv.c.
339 * And I repeat : you are not forced to use them with iwpriv, but you
340 * must be compliant with it.
343 /* ------------------------- IOCTL STUFF ------------------------- */
345 /* The first and the last (range) */
346 #define SIOCIWFIRST 0x8B00
347 #define SIOCIWLAST SIOCIWLASTPRIV /* 0x8BFF */
348 #define IW_IOCTL_IDX(cmd) ((cmd) - SIOCIWFIRST)
350 /* Odd : get (world access), even : set (root access) */
351 #define IW_IS_SET(cmd) (!((cmd) & 0x1))
352 #define IW_IS_GET(cmd) ((cmd) & 0x1)
354 /* ----------------------- WIRELESS EVENTS ----------------------- */
355 /* Those are *NOT* ioctls, do not issue request on them !!! */
356 /* Most events use the same identifier as ioctl requests */
358 #define IWEVTXDROP 0x8C00 /* Packet dropped to excessive retry */
359 #define IWEVQUAL 0x8C01 /* Quality part of statistics (scan) */
360 #define IWEVCUSTOM 0x8C02 /* Driver specific ascii string */
361 #define IWEVREGISTERED 0x8C03 /* Discovered a new node (AP mode) */
362 #define IWEVEXPIRED 0x8C04 /* Expired a node (AP mode) */
363 #define IWEVGENIE 0x8C05 /* Generic IE (WPA, RSN, WMM, ..)
364 * (scan results); This includes id and
365 * length fields. One IWEVGENIE may
366 * contain more than one IE. Scan
367 * results may contain one or more
368 * IWEVGENIE events. */
369 #define IWEVMICHAELMICFAILURE 0x8C06 /* Michael MIC failure
370 * (struct iw_michaelmicfailure)
372 #define IWEVASSOCREQIE 0x8C07 /* IEs used in (Re)Association Request.
373 * The data includes id and length
374 * fields and may contain more than one
375 * IE. This event is required in
376 * Managed mode if the driver
377 * generates its own WPA/RSN IE. This
378 * should be sent just before
379 * IWEVREGISTERED event for the
381 #define IWEVASSOCRESPIE 0x8C08 /* IEs used in (Re)Association
382 * Response. The data includes id and
383 * length fields and may contain more
384 * than one IE. This may be sent
385 * between IWEVASSOCREQIE and
386 * IWEVREGISTERED events for the
388 #define IWEVPMKIDCAND 0x8C09 /* PMKID candidate for RSN
390 * (struct iw_pmkid_cand) */
392 #define IWEVFIRST 0x8C00
393 #define IW_EVENT_IDX(cmd) ((cmd) - IWEVFIRST)
395 /* ------------------------- PRIVATE INFO ------------------------- */
397 * The following is used with SIOCGIWPRIV. It allow a driver to define
398 * the interface (name, type of data) for its private ioctl.
399 * Privates ioctl are SIOCIWFIRSTPRIV -> SIOCIWLASTPRIV
402 #define IW_PRIV_TYPE_MASK 0x7000 /* Type of arguments */
403 #define IW_PRIV_TYPE_NONE 0x0000
404 #define IW_PRIV_TYPE_BYTE 0x1000 /* Char as number */
405 #define IW_PRIV_TYPE_CHAR 0x2000 /* Char as character */
406 #define IW_PRIV_TYPE_INT 0x4000 /* 32 bits int */
407 #define IW_PRIV_TYPE_FLOAT 0x5000 /* struct iw_freq */
408 #define IW_PRIV_TYPE_ADDR 0x6000 /* struct sockaddr */
410 #define IW_PRIV_SIZE_FIXED 0x0800 /* Variable or fixed number of args */
412 #define IW_PRIV_SIZE_MASK 0x07FF /* Max number of those args */
415 * Note : if the number of args is fixed and the size < 16 octets,
416 * instead of passing a pointer we will put args in the iwreq struct...
419 /* ----------------------- OTHER CONSTANTS ----------------------- */
421 /* Maximum frequencies in the range struct */
422 #define IW_MAX_FREQUENCIES 32
423 /* Note : if you have something like 80 frequencies,
424 * don't increase this constant and don't fill the frequency list.
425 * The user will be able to set by channel anyway... */
427 /* Maximum bit rates in the range struct */
428 #define IW_MAX_BITRATES 32
430 /* Maximum tx powers in the range struct */
431 #define IW_MAX_TXPOWER 8
432 /* Note : if you more than 8 TXPowers, just set the max and min or
433 * a few of them in the struct iw_range. */
435 /* Maximum of address that you may set with SPY */
438 /* Maximum of address that you may get in the
439 list of access points in range */
442 /* Maximum size of the ESSID and NICKN strings */
443 #define IW_ESSID_MAX_SIZE 32
445 /* Modes of operation */
446 #define IW_MODE_AUTO 0 /* Let the driver decides */
447 #define IW_MODE_ADHOC 1 /* Single cell network */
448 #define IW_MODE_INFRA 2 /* Multi cell network, roaming, ... */
449 #define IW_MODE_MASTER 3 /* Synchronisation master or Access Point */
450 #define IW_MODE_REPEAT 4 /* Wireless Repeater (forwarder) */
451 #define IW_MODE_SECOND 5 /* Secondary master/repeater (backup) */
452 #define IW_MODE_MONITOR 6 /* Passive monitor (listen only) */
453 #define IW_MODE_MESH 7 /* Mesh (IEEE 802.11s) network */
455 /* Statistics flags (bitmask in updated) */
456 #define IW_QUAL_QUAL_UPDATED 0x01 /* Value was updated since last read */
457 #define IW_QUAL_LEVEL_UPDATED 0x02
458 #define IW_QUAL_NOISE_UPDATED 0x04
459 #define IW_QUAL_ALL_UPDATED 0x07
460 #define IW_QUAL_DBM 0x08 /* Level + Noise are dBm */
461 #define IW_QUAL_QUAL_INVALID 0x10 /* Driver doesn't provide value */
462 #define IW_QUAL_LEVEL_INVALID 0x20
463 #define IW_QUAL_NOISE_INVALID 0x40
464 #define IW_QUAL_RCPI 0x80 /* Level + Noise are 802.11k RCPI */
465 #define IW_QUAL_ALL_INVALID 0x70
467 /* Frequency flags */
468 #define IW_FREQ_AUTO 0x00 /* Let the driver decides */
469 #define IW_FREQ_FIXED 0x01 /* Force a specific value */
471 /* Maximum number of size of encoding token available
472 * they are listed in the range structure */
473 #define IW_MAX_ENCODING_SIZES 8
475 /* Maximum size of the encoding token in bytes */
476 #define IW_ENCODING_TOKEN_MAX 64 /* 512 bits (for now) */
478 /* Flags for encoding (along with the token) */
479 #define IW_ENCODE_INDEX 0x00FF /* Token index (if needed) */
480 #define IW_ENCODE_FLAGS 0xFF00 /* Flags defined below */
481 #define IW_ENCODE_MODE 0xF000 /* Modes defined below */
482 #define IW_ENCODE_DISABLED 0x8000 /* Encoding disabled */
483 #define IW_ENCODE_ENABLED 0x0000 /* Encoding enabled */
484 #define IW_ENCODE_RESTRICTED 0x4000 /* Refuse non-encoded packets */
485 #define IW_ENCODE_OPEN 0x2000 /* Accept non-encoded packets */
486 #define IW_ENCODE_NOKEY 0x0800 /* Key is write only, so not present */
487 #define IW_ENCODE_TEMP 0x0400 /* Temporary key */
489 /* Power management flags available (along with the value, if any) */
490 #define IW_POWER_ON 0x0000 /* No details... */
491 #define IW_POWER_TYPE 0xF000 /* Type of parameter */
492 #define IW_POWER_PERIOD 0x1000 /* Value is a period/duration of */
493 #define IW_POWER_TIMEOUT 0x2000 /* Value is a timeout (to go asleep) */
494 #define IW_POWER_MODE 0x0F00 /* Power Management mode */
495 #define IW_POWER_UNICAST_R 0x0100 /* Receive only unicast messages */
496 #define IW_POWER_MULTICAST_R 0x0200 /* Receive only multicast messages */
497 #define IW_POWER_ALL_R 0x0300 /* Receive all messages though PM */
498 #define IW_POWER_FORCE_S 0x0400 /* Force PM procedure for sending unicast */
499 #define IW_POWER_REPEATER 0x0800 /* Repeat broadcast messages in PM period */
500 #define IW_POWER_MODIFIER 0x000F /* Modify a parameter */
501 #define IW_POWER_MIN 0x0001 /* Value is a minimum */
502 #define IW_POWER_MAX 0x0002 /* Value is a maximum */
503 #define IW_POWER_RELATIVE 0x0004 /* Value is not in seconds/ms/us */
505 /* Transmit Power flags available */
506 #define IW_TXPOW_TYPE 0x00FF /* Type of value */
507 #define IW_TXPOW_DBM 0x0000 /* Value is in dBm */
508 #define IW_TXPOW_MWATT 0x0001 /* Value is in mW */
509 #define IW_TXPOW_RELATIVE 0x0002 /* Value is in arbitrary units */
510 #define IW_TXPOW_RANGE 0x1000 /* Range of value between min/max */
512 /* Retry limits and lifetime flags available */
513 #define IW_RETRY_ON 0x0000 /* No details... */
514 #define IW_RETRY_TYPE 0xF000 /* Type of parameter */
515 #define IW_RETRY_LIMIT 0x1000 /* Maximum number of retries*/
516 #define IW_RETRY_LIFETIME 0x2000 /* Maximum duration of retries in us */
517 #define IW_RETRY_MODIFIER 0x00FF /* Modify a parameter */
518 #define IW_RETRY_MIN 0x0001 /* Value is a minimum */
519 #define IW_RETRY_MAX 0x0002 /* Value is a maximum */
520 #define IW_RETRY_RELATIVE 0x0004 /* Value is not in seconds/ms/us */
521 #define IW_RETRY_SHORT 0x0010 /* Value is for short packets */
522 #define IW_RETRY_LONG 0x0020 /* Value is for long packets */
524 /* Scanning request flags */
525 #define IW_SCAN_DEFAULT 0x0000 /* Default scan of the driver */
526 #define IW_SCAN_ALL_ESSID 0x0001 /* Scan all ESSIDs */
527 #define IW_SCAN_THIS_ESSID 0x0002 /* Scan only this ESSID */
528 #define IW_SCAN_ALL_FREQ 0x0004 /* Scan all Frequencies */
529 #define IW_SCAN_THIS_FREQ 0x0008 /* Scan only this Frequency */
530 #define IW_SCAN_ALL_MODE 0x0010 /* Scan all Modes */
531 #define IW_SCAN_THIS_MODE 0x0020 /* Scan only this Mode */
532 #define IW_SCAN_ALL_RATE 0x0040 /* Scan all Bit-Rates */
533 #define IW_SCAN_THIS_RATE 0x0080 /* Scan only this Bit-Rate */
534 /* struct iw_scan_req scan_type */
535 #define IW_SCAN_TYPE_ACTIVE 0
536 #define IW_SCAN_TYPE_PASSIVE 1
537 /* Maximum size of returned data */
538 #define IW_SCAN_MAX_DATA 4096 /* In bytes */
540 /* Scan capability flags - in (struct iw_range *)->scan_capa */
541 #define IW_SCAN_CAPA_NONE 0x00
542 #define IW_SCAN_CAPA_ESSID 0x01
543 #define IW_SCAN_CAPA_BSSID 0x02
544 #define IW_SCAN_CAPA_CHANNEL 0x04
545 #define IW_SCAN_CAPA_MODE 0x08
546 #define IW_SCAN_CAPA_RATE 0x10
547 #define IW_SCAN_CAPA_TYPE 0x20
548 #define IW_SCAN_CAPA_TIME 0x40
550 /* Max number of char in custom event - use multiple of them if needed */
551 #define IW_CUSTOM_MAX 256 /* In bytes */
553 /* Generic information element */
554 #define IW_GENERIC_IE_MAX 1024
556 /* MLME requests (SIOCSIWMLME / struct iw_mlme) */
557 #define IW_MLME_DEAUTH 0
558 #define IW_MLME_DISASSOC 1
559 #define IW_MLME_AUTH 2
560 #define IW_MLME_ASSOC 3
562 /* SIOCSIWAUTH/SIOCGIWAUTH struct iw_param flags */
563 #define IW_AUTH_INDEX 0x0FFF
564 #define IW_AUTH_FLAGS 0xF000
565 /* SIOCSIWAUTH/SIOCGIWAUTH parameters (0 .. 4095)
566 * (IW_AUTH_INDEX mask in struct iw_param flags; this is the index of the
567 * parameter that is being set/get to; value will be read/written to
568 * struct iw_param value field) */
569 #define IW_AUTH_WPA_VERSION 0
570 #define IW_AUTH_CIPHER_PAIRWISE 1
571 #define IW_AUTH_CIPHER_GROUP 2
572 #define IW_AUTH_KEY_MGMT 3
573 #define IW_AUTH_TKIP_COUNTERMEASURES 4
574 #define IW_AUTH_DROP_UNENCRYPTED 5
575 #define IW_AUTH_80211_AUTH_ALG 6
576 #define IW_AUTH_WPA_ENABLED 7
577 #define IW_AUTH_RX_UNENCRYPTED_EAPOL 8
578 #define IW_AUTH_ROAMING_CONTROL 9
579 #define IW_AUTH_PRIVACY_INVOKED 10
581 /* IW_AUTH_WPA_VERSION values (bit field) */
582 #define IW_AUTH_WPA_VERSION_DISABLED 0x00000001
583 #define IW_AUTH_WPA_VERSION_WPA 0x00000002
584 #define IW_AUTH_WPA_VERSION_WPA2 0x00000004
586 /* IW_AUTH_PAIRWISE_CIPHER and IW_AUTH_GROUP_CIPHER values (bit field) */
587 #define IW_AUTH_CIPHER_NONE 0x00000001
588 #define IW_AUTH_CIPHER_WEP40 0x00000002
589 #define IW_AUTH_CIPHER_TKIP 0x00000004
590 #define IW_AUTH_CIPHER_CCMP 0x00000008
591 #define IW_AUTH_CIPHER_WEP104 0x00000010
593 /* IW_AUTH_KEY_MGMT values (bit field) */
594 #define IW_AUTH_KEY_MGMT_802_1X 1
595 #define IW_AUTH_KEY_MGMT_PSK 2
597 /* IW_AUTH_80211_AUTH_ALG values (bit field) */
598 #define IW_AUTH_ALG_OPEN_SYSTEM 0x00000001
599 #define IW_AUTH_ALG_SHARED_KEY 0x00000002
600 #define IW_AUTH_ALG_LEAP 0x00000004
602 /* IW_AUTH_ROAMING_CONTROL values */
603 #define IW_AUTH_ROAMING_ENABLE 0 /* driver/firmware based roaming */
604 #define IW_AUTH_ROAMING_DISABLE 1 /* user space program used for roaming
607 /* SIOCSIWENCODEEXT definitions */
608 #define IW_ENCODE_SEQ_MAX_SIZE 8
609 /* struct iw_encode_ext ->alg */
610 #define IW_ENCODE_ALG_NONE 0
611 #define IW_ENCODE_ALG_WEP 1
612 #define IW_ENCODE_ALG_TKIP 2
613 #define IW_ENCODE_ALG_CCMP 3
614 /* struct iw_encode_ext ->ext_flags */
615 #define IW_ENCODE_EXT_TX_SEQ_VALID 0x00000001
616 #define IW_ENCODE_EXT_RX_SEQ_VALID 0x00000002
617 #define IW_ENCODE_EXT_GROUP_KEY 0x00000004
618 #define IW_ENCODE_EXT_SET_TX_KEY 0x00000008
620 /* IWEVMICHAELMICFAILURE : struct iw_michaelmicfailure ->flags */
621 #define IW_MICFAILURE_KEY_ID 0x00000003 /* Key ID 0..3 */
622 #define IW_MICFAILURE_GROUP 0x00000004
623 #define IW_MICFAILURE_PAIRWISE 0x00000008
624 #define IW_MICFAILURE_STAKEY 0x00000010
625 #define IW_MICFAILURE_COUNT 0x00000060 /* 1 or 2 (0 = count not supported)
628 /* Bit field values for enc_capa in struct iw_range */
629 #define IW_ENC_CAPA_WPA 0x00000001
630 #define IW_ENC_CAPA_WPA2 0x00000002
631 #define IW_ENC_CAPA_CIPHER_TKIP 0x00000004
632 #define IW_ENC_CAPA_CIPHER_CCMP 0x00000008
634 /* Event capability macros - in (struct iw_range *)->event_capa
635 * Because we have more than 32 possible events, we use an array of
636 * 32 bit bitmasks. Note : 32 bits = 0x20 = 2^5. */
637 #define IW_EVENT_CAPA_BASE(cmd) ((cmd >= SIOCIWFIRSTPRIV) ? \
638 (cmd - SIOCIWFIRSTPRIV + 0x60) : \
639 (cmd - SIOCSIWCOMMIT))
640 #define IW_EVENT_CAPA_INDEX(cmd) (IW_EVENT_CAPA_BASE(cmd) >> 5)
641 #define IW_EVENT_CAPA_MASK(cmd) (1 << (IW_EVENT_CAPA_BASE(cmd) & 0x1F))
642 /* Event capability constants - event autogenerated by the kernel
643 * This list is valid for most 802.11 devices, customise as needed... */
644 #define IW_EVENT_CAPA_K_0 (IW_EVENT_CAPA_MASK(0x8B04) | \
645 IW_EVENT_CAPA_MASK(0x8B06) | \
646 IW_EVENT_CAPA_MASK(0x8B1A))
647 #define IW_EVENT_CAPA_K_1 (IW_EVENT_CAPA_MASK(0x8B2A))
648 /* "Easy" macro to set events in iw_range (less efficient) */
649 #define IW_EVENT_CAPA_SET(event_capa, cmd) (event_capa[IW_EVENT_CAPA_INDEX(cmd)] |= IW_EVENT_CAPA_MASK(cmd))
650 #define IW_EVENT_CAPA_SET_KERNEL(event_capa) {event_capa[0] |= IW_EVENT_CAPA_K_0; event_capa[1] |= IW_EVENT_CAPA_K_1; }
653 /****************************** TYPES ******************************/
655 /* --------------------------- SUBTYPES --------------------------- */
657 * Generic format for most parameters that fit in an int
661 __s32 value; /* The value of the parameter itself */
662 __u8 fixed; /* Hardware should not use auto select */
663 __u8 disabled; /* Disable the feature */
664 __u16 flags; /* Various specifc flags (if any) */
668 * For all data larger than 16 octets, we need to use a
669 * pointer to memory allocated in user space.
673 void __user *pointer; /* Pointer to the data (in user space) */
674 __u16 length; /* number of fields or size in bytes */
675 __u16 flags; /* Optional params */
680 * For numbers lower than 10^9, we encode the number in 'm' and
682 * For number greater than 10^9, we divide it by the lowest power
683 * of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
684 * The power of 10 is in 'e', the result of the division is in 'm'.
688 __s32 m; /* Mantissa */
689 __s16 e; /* Exponent */
690 __u8 i; /* List index (when in range struct) */
691 __u8 flags; /* Flags (fixed/auto) */
695 * Quality of the link
699 __u8 qual; /* link quality (%retries, SNR,
700 %missed beacons or better...) */
701 __u8 level; /* signal level (dBm) */
702 __u8 noise; /* noise level (dBm) */
703 __u8 updated; /* Flags to know if updated */
707 * Packet discarded in the wireless adapter due to
708 * "wireless" specific problems...
709 * Note : the list of counter and statistics in net_device_stats
710 * is already pretty exhaustive, and you should use that first.
711 * This is only additional stats...
715 __u32 nwid; /* Rx : Wrong nwid/essid */
716 __u32 code; /* Rx : Unable to code/decode (WEP) */
717 __u32 fragment; /* Rx : Can't perform MAC reassembly */
718 __u32 retries; /* Tx : Max MAC retries num reached */
719 __u32 misc; /* Others cases */
723 * Packet/Time period missed in the wireless adapter due to
724 * "wireless" specific problems...
728 __u32 beacon; /* Missed beacons/superframe */
732 * Quality range (for spy threshold)
736 struct sockaddr addr; /* Source address (hw/mac) */
737 struct iw_quality qual; /* Quality of the link */
738 struct iw_quality low; /* Low threshold */
739 struct iw_quality high; /* High threshold */
743 * Optional data for scan request
745 * Note: these optional parameters are controlling parameters for the
746 * scanning behavior, these do not apply to getting scan results
747 * (SIOCGIWSCAN). Drivers are expected to keep a local BSS table and
748 * provide a merged results with all BSSes even if the previous scan
749 * request limited scanning to a subset, e.g., by specifying an SSID.
750 * Especially, scan results are required to include an entry for the
751 * current BSS if the driver is in Managed mode and associated with an AP.
755 __u8 scan_type; /* IW_SCAN_TYPE_{ACTIVE,PASSIVE} */
757 __u8 num_channels; /* num entries in channel_list;
758 * 0 = scan all allowed channels */
759 __u8 flags; /* reserved as padding; use zero, this may
760 * be used in the future for adding flags
761 * to request different scan behavior */
762 struct sockaddr bssid; /* ff:ff:ff:ff:ff:ff for broadcast BSSID or
763 * individual address of a specific BSS */
766 * Use this ESSID if IW_SCAN_THIS_ESSID flag is used instead of using
767 * the current ESSID. This allows scan requests for specific ESSID
768 * without having to change the current ESSID and potentially breaking
769 * the current association.
771 __u8 essid[IW_ESSID_MAX_SIZE];
774 * Optional parameters for changing the default scanning behavior.
775 * These are based on the MLME-SCAN.request from IEEE Std 802.11.
776 * TU is 1.024 ms. If these are set to 0, driver is expected to use
777 * reasonable default values. min_channel_time defines the time that
778 * will be used to wait for the first reply on each channel. If no
779 * replies are received, next channel will be scanned after this. If
780 * replies are received, total time waited on the channel is defined by
783 __u32 min_channel_time; /* in TU */
784 __u32 max_channel_time; /* in TU */
786 struct iw_freq channel_list[IW_MAX_FREQUENCIES];
789 /* ------------------------- WPA SUPPORT ------------------------- */
792 * Extended data structure for get/set encoding (this is used with
793 * SIOCSIWENCODEEXT/SIOCGIWENCODEEXT. struct iw_point and IW_ENCODE_*
794 * flags are used in the same way as with SIOCSIWENCODE/SIOCGIWENCODE and
795 * only the data contents changes (key data -> this structure, including
798 * If the new key is the first group key, it will be set as the default
799 * TX key. Otherwise, default TX key index is only changed if
800 * IW_ENCODE_EXT_SET_TX_KEY flag is set.
802 * Key will be changed with SIOCSIWENCODEEXT in all cases except for
803 * special "change TX key index" operation which is indicated by setting
804 * key_len = 0 and ext_flags |= IW_ENCODE_EXT_SET_TX_KEY.
806 * tx_seq/rx_seq are only used when respective
807 * IW_ENCODE_EXT_{TX,RX}_SEQ_VALID flag is set in ext_flags. Normal
808 * TKIP/CCMP operation is to set RX seq with SIOCSIWENCODEEXT and start
809 * TX seq from zero whenever key is changed. SIOCGIWENCODEEXT is normally
810 * used only by an Authenticator (AP or an IBSS station) to get the
811 * current TX sequence number. Using TX_SEQ_VALID for SIOCSIWENCODEEXT and
812 * RX_SEQ_VALID for SIOCGIWENCODEEXT are optional, but can be useful for
817 __u32 ext_flags; /* IW_ENCODE_EXT_* */
818 __u8 tx_seq[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
819 __u8 rx_seq[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
820 struct sockaddr addr; /* ff:ff:ff:ff:ff:ff for broadcast/multicast
821 * (group) keys or unicast address for
823 __u16 alg; /* IW_ENCODE_ALG_* */
828 /* SIOCSIWMLME data */
831 __u16 cmd; /* IW_MLME_* */
833 struct sockaddr addr;
836 /* SIOCSIWPMKSA data */
837 #define IW_PMKSA_ADD 1
838 #define IW_PMKSA_REMOVE 2
839 #define IW_PMKSA_FLUSH 3
841 #define IW_PMKID_LEN 16
845 __u32 cmd; /* IW_PMKSA_* */
846 struct sockaddr bssid;
847 __u8 pmkid[IW_PMKID_LEN];
850 /* IWEVMICHAELMICFAILURE data */
851 struct iw_michaelmicfailure
854 struct sockaddr src_addr;
855 __u8 tsc[IW_ENCODE_SEQ_MAX_SIZE]; /* LSB first */
858 /* IWEVPMKIDCAND data */
859 #define IW_PMKID_CAND_PREAUTH 0x00000001 /* RNS pre-authentication enabled */
862 __u32 flags; /* IW_PMKID_CAND_* */
863 __u32 index; /* the smaller the index, the higher the
865 struct sockaddr bssid;
868 /* ------------------------ WIRELESS STATS ------------------------ */
870 * Wireless statistics (used for /proc/net/wireless)
874 __u16 status; /* Status
875 * - device dependent for now */
877 struct iw_quality qual; /* Quality of the link
878 * (instant/mean/max) */
879 struct iw_discarded discard; /* Packet discarded counts */
880 struct iw_missed miss; /* Packet missed counts */
883 /* ------------------------ IOCTL REQUEST ------------------------ */
885 * This structure defines the payload of an ioctl, and is used
888 * Note that this structure should fit on the memory footprint
889 * of iwreq (which is the same as ifreq), which mean a max size of
890 * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
891 * You should check this when increasing the structures defined
892 * above in this file...
896 /* Config - generic */
898 /* Name : used to verify the presence of wireless extensions.
899 * Name of the protocol/provider... */
901 struct iw_point essid; /* Extended network name */
902 struct iw_param nwid; /* network id (or domain - the cell) */
903 struct iw_freq freq; /* frequency or channel :
905 * > 1000 = frequency in Hz */
907 struct iw_param sens; /* signal level threshold */
908 struct iw_param bitrate; /* default bit rate */
909 struct iw_param txpower; /* default transmit power */
910 struct iw_param rts; /* RTS threshold threshold */
911 struct iw_param frag; /* Fragmentation threshold */
912 __u32 mode; /* Operation mode */
913 struct iw_param retry; /* Retry limits & lifetime */
915 struct iw_point encoding; /* Encoding stuff : tokens */
916 struct iw_param power; /* PM duration/timeout */
917 struct iw_quality qual; /* Quality part of statistics */
919 struct sockaddr ap_addr; /* Access point address */
920 struct sockaddr addr; /* Destination address (hw/mac) */
922 struct iw_param param; /* Other small parameters */
923 struct iw_point data; /* Other large parameters */
927 * The structure to exchange data for ioctl.
928 * This structure is the same as 'struct ifreq', but (re)defined for
930 * Do I need to remind you about structure size (32 octets) ?
936 char ifrn_name[IFNAMSIZ]; /* if name, e.g. "eth0" */
939 /* Data part (defined just above) */
943 /* -------------------------- IOCTL DATA -------------------------- */
945 * For those ioctl which want to exchange mode data that what could
946 * fit in the above structure...
950 * Range of parameters
955 /* Informative stuff (to choose between different interface) */
956 __u32 throughput; /* To give an idea... */
957 /* In theory this value should be the maximum benchmarked
958 * TCP/IP throughput, because with most of these devices the
959 * bit rate is meaningless (overhead an co) to estimate how
960 * fast the connection will go and pick the fastest one.
961 * I suggest people to play with Netperf or any benchmark...
964 /* NWID (or domain id) */
965 __u32 min_nwid; /* Minimal NWID we are able to set */
966 __u32 max_nwid; /* Maximal NWID we are able to set */
968 /* Old Frequency (backward compat - moved lower ) */
969 __u16 old_num_channels;
970 __u8 old_num_frequency;
972 /* Scan capabilities */
973 __u8 scan_capa; /* IW_SCAN_CAPA_* bit field */
975 /* Wireless event capability bitmasks */
978 /* signal level threshold range */
981 /* Quality of link & SNR stuff */
982 /* Quality range (link, level, noise)
983 * If the quality is absolute, it will be in the range [0 ; max_qual],
984 * if the quality is dBm, it will be in the range [max_qual ; 0].
985 * Don't forget that we use 8 bit arithmetics... */
986 struct iw_quality max_qual; /* Quality of the link */
987 /* This should contain the average/typical values of the quality
988 * indicator. This should be the threshold between a "good" and
989 * a "bad" link (example : monitor going from green to orange).
990 * Currently, user space apps like quality monitors don't have any
991 * way to calibrate the measurement. With this, they can split
992 * the range between 0 and max_qual in different quality level
993 * (using a geometric subdivision centered on the average).
994 * I expect that people doing the user space apps will feedback
995 * us on which value we need to put in each driver... */
996 struct iw_quality avg_qual; /* Quality of the link */
999 __u8 num_bitrates; /* Number of entries in the list */
1000 __s32 bitrate[IW_MAX_BITRATES]; /* list, in bps */
1003 __s32 min_rts; /* Minimal RTS threshold */
1004 __s32 max_rts; /* Maximal RTS threshold */
1006 /* Frag threshold */
1007 __s32 min_frag; /* Minimal frag threshold */
1008 __s32 max_frag; /* Maximal frag threshold */
1010 /* Power Management duration & timeout */
1011 __s32 min_pmp; /* Minimal PM period */
1012 __s32 max_pmp; /* Maximal PM period */
1013 __s32 min_pmt; /* Minimal PM timeout */
1014 __s32 max_pmt; /* Maximal PM timeout */
1015 __u16 pmp_flags; /* How to decode max/min PM period */
1016 __u16 pmt_flags; /* How to decode max/min PM timeout */
1017 __u16 pm_capa; /* What PM options are supported */
1020 __u16 encoding_size[IW_MAX_ENCODING_SIZES]; /* Different token sizes */
1021 __u8 num_encoding_sizes; /* Number of entry in the list */
1022 __u8 max_encoding_tokens; /* Max number of tokens */
1023 /* For drivers that need a "login/passwd" form */
1024 __u8 encoding_login_index; /* token index for login token */
1026 /* Transmit power */
1027 __u16 txpower_capa; /* What options are supported */
1028 __u8 num_txpower; /* Number of entries in the list */
1029 __s32 txpower[IW_MAX_TXPOWER]; /* list, in bps */
1031 /* Wireless Extension version info */
1032 __u8 we_version_compiled; /* Must be WIRELESS_EXT */
1033 __u8 we_version_source; /* Last update of source */
1035 /* Retry limits and lifetime */
1036 __u16 retry_capa; /* What retry options are supported */
1037 __u16 retry_flags; /* How to decode max/min retry limit */
1038 __u16 r_time_flags; /* How to decode max/min retry life */
1039 __s32 min_retry; /* Minimal number of retries */
1040 __s32 max_retry; /* Maximal number of retries */
1041 __s32 min_r_time; /* Minimal retry lifetime */
1042 __s32 max_r_time; /* Maximal retry lifetime */
1045 __u16 num_channels; /* Number of channels [0; num - 1] */
1046 __u8 num_frequency; /* Number of entry in the list */
1047 struct iw_freq freq[IW_MAX_FREQUENCIES]; /* list */
1048 /* Note : this frequency list doesn't need to fit channel numbers,
1049 * because each entry contain its channel index */
1051 __u32 enc_capa; /* IW_ENC_CAPA_* bit field */
1055 * Private ioctl interface information
1060 __u32 cmd; /* Number of the ioctl to issue */
1061 __u16 set_args; /* Type and number of args */
1062 __u16 get_args; /* Type and number of args */
1063 char name[IFNAMSIZ]; /* Name of the extension */
1066 /* ----------------------- WIRELESS EVENTS ----------------------- */
1068 * Wireless events are carried through the rtnetlink socket to user
1069 * space. They are encapsulated in the IFLA_WIRELESS field of
1070 * a RTM_NEWLINK message.
1074 * A Wireless Event. Contains basically the same data as the ioctl...
1078 __u16 len; /* Real length of this stuff */
1079 __u16 cmd; /* Wireless IOCTL */
1080 union iwreq_data u; /* IOCTL fixed payload */
1083 /* Size of the Event prefix (including padding and alignement junk) */
1084 #define IW_EV_LCP_LEN (sizeof(struct iw_event) - sizeof(union iwreq_data))
1085 /* Size of the various events */
1086 #define IW_EV_CHAR_LEN (IW_EV_LCP_LEN + IFNAMSIZ)
1087 #define IW_EV_UINT_LEN (IW_EV_LCP_LEN + sizeof(__u32))
1088 #define IW_EV_FREQ_LEN (IW_EV_LCP_LEN + sizeof(struct iw_freq))
1089 #define IW_EV_PARAM_LEN (IW_EV_LCP_LEN + sizeof(struct iw_param))
1090 #define IW_EV_ADDR_LEN (IW_EV_LCP_LEN + sizeof(struct sockaddr))
1091 #define IW_EV_QUAL_LEN (IW_EV_LCP_LEN + sizeof(struct iw_quality))
1093 /* iw_point events are special. First, the payload (extra data) come at
1094 * the end of the event, so they are bigger than IW_EV_POINT_LEN. Second,
1095 * we omit the pointer, so start at an offset. */
1096 #define IW_EV_POINT_OFF (((char *) &(((struct iw_point *) NULL)->length)) - \
1098 #define IW_EV_POINT_LEN (IW_EV_LCP_LEN + sizeof(struct iw_point) - \
1101 /* Size of the Event prefix when packed in stream */
1102 #define IW_EV_LCP_PK_LEN (4)
1103 /* Size of the various events when packed in stream */
1104 #define IW_EV_CHAR_PK_LEN (IW_EV_LCP_PK_LEN + IFNAMSIZ)
1105 #define IW_EV_UINT_PK_LEN (IW_EV_LCP_PK_LEN + sizeof(__u32))
1106 #define IW_EV_FREQ_PK_LEN (IW_EV_LCP_PK_LEN + sizeof(struct iw_freq))
1107 #define IW_EV_PARAM_PK_LEN (IW_EV_LCP_PK_LEN + sizeof(struct iw_param))
1108 #define IW_EV_ADDR_PK_LEN (IW_EV_LCP_PK_LEN + sizeof(struct sockaddr))
1109 #define IW_EV_QUAL_PK_LEN (IW_EV_LCP_PK_LEN + sizeof(struct iw_quality))
1110 #define IW_EV_POINT_PK_LEN (IW_EV_LCP_LEN + 4)
1112 #endif /* _LINUX_WIRELESS_H */