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