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