nexmon – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 /*
2 * This file define a set of standard wireless extensions
3 *
4 * Version : 11 28.3.01
5 *
6 * Authors : Jean Tourrilhes - HPL - <jt@hpl.hp.com>
7 */
8  
9 #ifndef _LINUX_WIRELESS_H
10 #define _LINUX_WIRELESS_H
11  
12 /************************** DOCUMENTATION **************************/
13 /*
14 * Basically, the wireless extensions are for now a set of standard ioctl
15 * call + /proc/net/wireless
16 *
17 * The entry /proc/net/wireless give statistics and information on the
18 * driver.
19 * This is better than having each driver having its entry because
20 * its centralised and we may remove the driver module safely.
21 *
22 * Ioctl are used to configure the driver and issue commands. This is
23 * better than command line options of insmod because we may want to
24 * change dynamically (while the driver is running) some parameters.
25 *
26 * The ioctl mechanimsm are copied from standard devices ioctl.
27 * We have the list of command plus a structure descibing the
28 * data exchanged...
29 * Note that to add these ioctl, I was obliged to modify :
30 * net/core/dev.c (two place + add include)
31 * net/ipv4/af_inet.c (one place + add include)
32 *
33 * /proc/net/wireless is a copy of /proc/net/dev.
34 * We have a structure for data passed from the driver to /proc/net/wireless
35 * Too add this, I've modified :
36 * net/core/dev.c (two other places)
37 * include/linux/netdevice.h (one place)
38 * include/linux/proc_fs.h (one place)
39 *
40 * Do not add here things that are redundant with other mechanisms
41 * (drivers init, ifconfig, /proc/net/dev, ...) and with are not
42 * wireless specific.
43 *
44 * These wireless extensions are not magic : each driver has to provide
45 * support for them...
46 *
47 * IMPORTANT NOTE : As everything in the kernel, this is very much a
48 * work in progress. Contact me if you have ideas of improvements...
49 */
50  
51 /***************************** INCLUDES *****************************/
52  
53 #include <linux/types.h> /* for "caddr_t" et al */
54 #include <linux/socket.h> /* for "struct sockaddr" et al */
55 #include <linux/if.h> /* for IFNAMSIZ and co... */
56  
57 /**************************** CONSTANTS ****************************/
58  
59 /* --------------------------- VERSION --------------------------- */
60 /*
61 * This constant is used to know the availability of the wireless
62 * extensions and to know which version of wireless extensions it is
63 * (there is some stuff that will be added in the future...)
64 * I just plan to increment with each new version.
65 */
66 #define WIRELESS_EXT 11
67  
68 /*
69 * Changes :
70 *
71 * V2 to V3
72 * --------
73 * Alan Cox start some incompatibles changes. I've integrated a bit more.
74 * - Encryption renamed to Encode to avoid US regulation problems
75 * - Frequency changed from float to struct to avoid problems on old 386
76 *
77 * V3 to V4
78 * --------
79 * - Add sensitivity
80 *
81 * V4 to V5
82 * --------
83 * - Missing encoding definitions in range
84 * - Access points stuff
85 *
86 * V5 to V6
87 * --------
88 * - 802.11 support (ESSID ioctls)
89 *
90 * V6 to V7
91 * --------
92 * - define IW_ESSID_MAX_SIZE and IW_MAX_AP
93 *
94 * V7 to V8
95 * --------
96 * - Changed my e-mail address
97 * - More 802.11 support (nickname, rate, rts, frag)
98 * - List index in frequencies
99 *
100 * V8 to V9
101 * --------
102 * - Support for 'mode of operation' (ad-hoc, managed...)
103 * - Support for unicast and multicast power saving
104 * - Change encoding to support larger tokens (>64 bits)
105 * - Updated iw_params (disable, flags) and use it for NWID
106 * - Extracted iw_point from iwreq for clarity
107 *
108 * V9 to V10
109 * ---------
110 * - Add PM capability to range structure
111 * - Add PM modifier : MAX/MIN/RELATIVE
112 * - Add encoding option : IW_ENCODE_NOKEY
113 * - Add TxPower ioctls (work like TxRate)
114 *
115 * V10 to V11
116 * ----------
117 * - Add WE version in range (help backward/forward compatibility)
118 * - Add retry ioctls (work like PM)
119 */
120  
121 /* -------------------------- IOCTL LIST -------------------------- */
122  
123 /* Basic operations */
124 #define SIOCSIWNAME 0x8B00 /* Unused */
125 #define SIOCGIWNAME 0x8B01 /* get name == wireless protocol */
126 #define SIOCSIWNWID 0x8B02 /* set network id (the cell) */
127 #define SIOCGIWNWID 0x8B03 /* get network id */
128 #define SIOCSIWFREQ 0x8B04 /* set channel/frequency (Hz) */
129 #define SIOCGIWFREQ 0x8B05 /* get channel/frequency (Hz) */
130 #define SIOCSIWMODE 0x8B06 /* set operation mode */
131 #define SIOCGIWMODE 0x8B07 /* get operation mode */
132 #define SIOCSIWSENS 0x8B08 /* set sensitivity (dBm) */
133 #define SIOCGIWSENS 0x8B09 /* get sensitivity (dBm) */
134  
135 /* Informative stuff */
136 #define SIOCSIWRANGE 0x8B0A /* Unused */
137 #define SIOCGIWRANGE 0x8B0B /* Get range of parameters */
138 #define SIOCSIWPRIV 0x8B0C /* Unused */
139 #define SIOCGIWPRIV 0x8B0D /* get private ioctl interface info */
140  
141 /* Mobile IP support */
142 #define SIOCSIWSPY 0x8B10 /* set spy addresses */
143 #define SIOCGIWSPY 0x8B11 /* get spy info (quality of link) */
144  
145 /* Access Point manipulation */
146 #define SIOCSIWAP 0x8B14 /* set access point MAC addresses */
147 #define SIOCGIWAP 0x8B15 /* get access point MAC addresses */
148 #define SIOCGIWAPLIST 0x8B17 /* get list of access point in range */
149  
150 /* 802.11 specific support */
151 #define SIOCSIWESSID 0x8B1A /* set ESSID (network name) */
152 #define SIOCGIWESSID 0x8B1B /* get ESSID */
153 #define SIOCSIWNICKN 0x8B1C /* set node name/nickname */
154 #define SIOCGIWNICKN 0x8B1D /* get node name/nickname */
155 /* As the ESSID and NICKN are strings up to 32 bytes long, it doesn't fit
156 * within the 'iwreq' structure, so we need to use the 'data' member to
157 * point to a string in user space, like it is done for RANGE...
158 * The "flags" member indicate if the ESSID is active or not (promiscuous).
159 */
160  
161 /* Other parameters usefull in 802.11 and some other devices */
162 #define SIOCSIWRATE 0x8B20 /* set default bit rate (bps) */
163 #define SIOCGIWRATE 0x8B21 /* get default bit rate (bps) */
164 #define SIOCSIWRTS 0x8B22 /* set RTS/CTS threshold (bytes) */
165 #define SIOCGIWRTS 0x8B23 /* get RTS/CTS threshold (bytes) */
166 #define SIOCSIWFRAG 0x8B24 /* set fragmentation thr (bytes) */
167 #define SIOCGIWFRAG 0x8B25 /* get fragmentation thr (bytes) */
168 #define SIOCSIWTXPOW 0x8B26 /* set transmit power (dBm) */
169 #define SIOCGIWTXPOW 0x8B27 /* get transmit power (dBm) */
170 #define SIOCSIWRETRY 0x8B28 /* set retry limits and lifetime */
171 #define SIOCGIWRETRY 0x8B29 /* get retry limits and lifetime */
172  
173 /* Encoding stuff (scrambling, hardware security, WEP...) */
174 #define SIOCSIWENCODE 0x8B2A /* set encoding token & mode */
175 #define SIOCGIWENCODE 0x8B2B /* get encoding token & mode */
176 /* Power saving stuff (power management, unicast and multicast) */
177 #define SIOCSIWPOWER 0x8B2C /* set Power Management settings */
178 #define SIOCGIWPOWER 0x8B2D /* get Power Management settings */
179  
180 /* ------------------------- IOCTL STUFF ------------------------- */
181  
182 /* The first and the last (range) */
183 #define SIOCIWFIRST 0x8B00
184 #define SIOCIWLAST 0x8B30
185  
186 /* Even : get (world access), odd : set (root access) */
187 #define IW_IS_SET(cmd) (!((cmd) & 0x1))
188 #define IW_IS_GET(cmd) ((cmd) & 0x1)
189  
190 /* ------------------------- PRIVATE INFO ------------------------- */
191 /*
192 * The following is used with SIOCGIWPRIV. It allow a driver to define
193 * the interface (name, type of data) for its private ioctl.
194 * Privates ioctl are SIOCDEVPRIVATE -> SIOCDEVPRIVATE + 0xF
195 */
196  
197 #define IW_PRIV_TYPE_MASK 0x7000 /* Type of arguments */
198 #define IW_PRIV_TYPE_NONE 0x0000
199 #define IW_PRIV_TYPE_BYTE 0x1000 /* Char as number */
200 #define IW_PRIV_TYPE_CHAR 0x2000 /* Char as character */
201 #define IW_PRIV_TYPE_INT 0x4000 /* 32 bits int */
202 #define IW_PRIV_TYPE_FLOAT 0x5000
203  
204 #define IW_PRIV_SIZE_FIXED 0x0800 /* Variable or fixed nuber of args */
205  
206 #define IW_PRIV_SIZE_MASK 0x07FF /* Max number of those args */
207  
208 /*
209 * Note : if the number of args is fixed and the size < 16 octets,
210 * instead of passing a pointer we will put args in the iwreq struct...
211 */
212  
213 /* ----------------------- OTHER CONSTANTS ----------------------- */
214  
215 /* Maximum frequencies in the range struct */
216 #define IW_MAX_FREQUENCIES 16
217 /* Note : if you have something like 80 frequencies,
218 * don't increase this constant and don't fill the frequency list.
219 * The user will be able to set by channel anyway... */
220  
221 /* Maximum bit rates in the range struct */
222 #define IW_MAX_BITRATES 8
223  
224 /* Maximum tx powers in the range struct */
225 #define IW_MAX_TXPOWER 8
226  
227 /* Maximum of address that you may set with SPY */
228 #define IW_MAX_SPY 8
229  
230 /* Maximum of address that you may get in the
231 list of access points in range */
232 #define IW_MAX_AP 8
233  
234 /* Maximum size of the ESSID and NICKN strings */
235 #define IW_ESSID_MAX_SIZE 32
236  
237 /* Modes of operation */
238 #define IW_MODE_AUTO 0 /* Let the driver decides */
239 #define IW_MODE_ADHOC 1 /* Single cell network */
240 #define IW_MODE_INFRA 2 /* Multi cell network, roaming, ... */
241 #define IW_MODE_MASTER 3 /* Synchronisation master or Access Point */
242 #define IW_MODE_REPEAT 4 /* Wireless Repeater (forwarder) */
243 #define IW_MODE_SECOND 5 /* Secondary master/repeater (backup) */
244  
245 /* Maximum number of size of encoding token available
246 * they are listed in the range structure */
247 #define IW_MAX_ENCODING_SIZES 8
248  
249 /* Maximum size of the encoding token in bytes */
250 #define IW_ENCODING_TOKEN_MAX 32 /* 256 bits (for now) */
251  
252 /* Flags for encoding (along with the token) */
253 #define IW_ENCODE_INDEX 0x00FF /* Token index (if needed) */
254 #define IW_ENCODE_FLAGS 0xFF00 /* Flags defined below */
255 #define IW_ENCODE_MODE 0xF000 /* Modes defined below */
256 #define IW_ENCODE_DISABLED 0x8000 /* Encoding disabled */
257 #define IW_ENCODE_ENABLED 0x0000 /* Encoding enabled */
258 #define IW_ENCODE_RESTRICTED 0x4000 /* Refuse non-encoded packets */
259 #define IW_ENCODE_OPEN 0x2000 /* Accept non-encoded packets */
260 #define IW_ENCODE_NOKEY 0x0800 /* Key is write only, so not present */
261  
262 /* Power management flags available (along with the value, if any) */
263 #define IW_POWER_ON 0x0000 /* No details... */
264 #define IW_POWER_TYPE 0xF000 /* Type of parameter */
265 #define IW_POWER_PERIOD 0x1000 /* Value is a period/duration of */
266 #define IW_POWER_TIMEOUT 0x2000 /* Value is a timeout (to go asleep) */
267 #define IW_POWER_MODE 0x0F00 /* Power Management mode */
268 #define IW_POWER_UNICAST_R 0x0100 /* Receive only unicast messages */
269 #define IW_POWER_MULTICAST_R 0x0200 /* Receive only multicast messages */
270 #define IW_POWER_ALL_R 0x0300 /* Receive all messages though PM */
271 #define IW_POWER_FORCE_S 0x0400 /* Force PM procedure for sending unicast */
272 #define IW_POWER_REPEATER 0x0800 /* Repeat broadcast messages in PM period */
273 #define IW_POWER_MODIFIER 0x000F /* Modify a parameter */
274 #define IW_POWER_MIN 0x0001 /* Value is a minimum */
275 #define IW_POWER_MAX 0x0002 /* Value is a maximum */
276 #define IW_POWER_RELATIVE 0x0004 /* Value is not in seconds/ms/us */
277  
278 /* Transmit Power flags available */
279 #define IW_TXPOW_DBM 0x0000 /* Value is in dBm */
280 #define IW_TXPOW_MWATT 0x0001 /* Value is in mW */
281  
282 /* Retry limits and lifetime flags available */
283 #define IW_RETRY_ON 0x0000 /* No details... */
284 #define IW_RETRY_TYPE 0xF000 /* Type of parameter */
285 #define IW_RETRY_LIMIT 0x1000 /* Maximum number of retries*/
286 #define IW_RETRY_LIFETIME 0x2000 /* Maximum duration of retries in us */
287 #define IW_RETRY_MODIFIER 0x000F /* Modify a parameter */
288 #define IW_RETRY_MIN 0x0001 /* Value is a minimum */
289 #define IW_RETRY_MAX 0x0002 /* Value is a maximum */
290 #define IW_RETRY_RELATIVE 0x0004 /* Value is not in seconds/ms/us */
291  
292 /****************************** TYPES ******************************/
293  
294 /* --------------------------- SUBTYPES --------------------------- */
295 /*
296 * Generic format for most parameters that fit in an int
297 */
298 struct iw_param
299 {
300 __s32 value; /* The value of the parameter itself */
301 __u8 fixed; /* Hardware should not use auto select */
302 __u8 disabled; /* Disable the feature */
303 __u16 flags; /* Various specifc flags (if any) */
304 };
305  
306 /*
307 * For all data larger than 16 octets, we need to use a
308 * pointer to memory alocated in user space.
309 */
310 struct iw_point
311 {
312 caddr_t pointer; /* Pointer to the data (in user space) */
313 __u16 length; /* number of fields or size in bytes */
314 __u16 flags; /* Optional params */
315 };
316  
317 /*
318 * A frequency
319 * For numbers lower than 10^9, we encode the number in 'm' and
320 * set 'e' to 0
321 * For number greater than 10^9, we divide it by the lowest power
322 * of 10 to get 'm' lower than 10^9, with 'm'= f / (10^'e')...
323 * The power of 10 is in 'e', the result of the division is in 'm'.
324 */
325 struct iw_freq
326 {
327 __u32 m; /* Mantissa */
328 __u16 e; /* Exponent */
329 __u8 i; /* List index (when in range struct) */
330 };
331  
332 /*
333 * Quality of the link
334 */
335 struct iw_quality
336 {
337 __u8 qual; /* link quality (%retries, SNR or better...) */
338 __u8 level; /* signal level */
339 __u8 noise; /* noise level */
340 __u8 updated; /* Flags to know if updated */
341 };
342  
343 /*
344 * Packet discarded in the wireless adapter due to
345 * "wireless" specific problems...
346 */
347 struct iw_discarded
348 {
349 __u32 nwid; /* Wrong nwid */
350 __u32 code; /* Unable to code/decode */
351 __u32 misc; /* Others cases */
352 };
353  
354 /* ------------------------ WIRELESS STATS ------------------------ */
355 /*
356 * Wireless statistics (used for /proc/net/wireless)
357 */
358 struct iw_statistics
359 {
360 __u16 status; /* Status
361 * - device dependent for now */
362  
363 struct iw_quality qual; /* Quality of the link
364 * (instant/mean/max) */
365 struct iw_discarded discard; /* Packet discarded counts */
366 };
367  
368 /* ------------------------ IOCTL REQUEST ------------------------ */
369 /*
370 * The structure to exchange data for ioctl.
371 * This structure is the same as 'struct ifreq', but (re)defined for
372 * convenience...
373 *
374 * Note that it should fit on the same memory footprint !
375 * You should check this when increasing the above structures (16 octets)
376 * 16 octets = 128 bits. Warning, pointers might be 64 bits wide...
377 */
378 struct iwreq
379 {
380 union
381 {
382 char ifrn_name[IFNAMSIZ]; /* if name, e.g. "eth0" */
383 } ifr_ifrn;
384  
385 /* Data part */
386 union
387 {
388 /* Config - generic */
389 char name[IFNAMSIZ];
390 /* Name : used to verify the presence of wireless extensions.
391 * Name of the protocol/provider... */
392  
393 struct iw_point essid; /* Extended network name */
394 struct iw_param nwid; /* network id (or domain - the cell) */
395 struct iw_freq freq; /* frequency or channel :
396 * 0-1000 = channel
397 * > 1000 = frequency in Hz */
398  
399 struct iw_param sens; /* signal level threshold */
400 struct iw_param bitrate; /* default bit rate */
401 struct iw_param txpower; /* default transmit power */
402 struct iw_param rts; /* RTS threshold threshold */
403 struct iw_param frag; /* Fragmentation threshold */
404 __u32 mode; /* Operation mode */
405 struct iw_param retry; /* Retry limits & lifetime */
406  
407 struct iw_point encoding; /* Encoding stuff : tokens */
408 struct iw_param power; /* PM duration/timeout */
409  
410 struct sockaddr ap_addr; /* Access point address */
411  
412 struct iw_point data; /* Other large parameters */
413 } u;
414 };
415  
416 /* -------------------------- IOCTL DATA -------------------------- */
417 /*
418 * For those ioctl which want to exchange mode data that what could
419 * fit in the above structure...
420 */
421  
422 /*
423 * Range of parameters
424 */
425  
426 struct iw_range
427 {
428 /* Informative stuff (to choose between different interface) */
429 __u32 throughput; /* To give an idea... */
430 /* In theory this value should be the maximum benchmarked
431 * TCP/IP throughput, because with most of these devices the
432 * bit rate is meaningless (overhead an co) to estimate how
433 * fast the connection will go and pick the fastest one.
434 * I suggest people to play with Netperf or any benchmark...
435 */
436  
437 /* NWID (or domain id) */
438 __u32 min_nwid; /* Minimal NWID we are able to set */
439 __u32 max_nwid; /* Maximal NWID we are able to set */
440  
441 /* Frequency */
442 __u16 num_channels; /* Number of channels [0; num - 1] */
443 __u8 num_frequency; /* Number of entry in the list */
444 struct iw_freq freq[IW_MAX_FREQUENCIES]; /* list */
445 /* Note : this frequency list doesn't need to fit channel numbers */
446  
447 /* signal level threshold range */
448 __s32 sensitivity;
449  
450 /* Quality of link & SNR stuff */
451 struct iw_quality max_qual; /* Quality of the link */
452  
453 /* Rates */
454 __u8 num_bitrates; /* Number of entries in the list */
455 __s32 bitrate[IW_MAX_BITRATES]; /* list, in bps */
456  
457 /* RTS threshold */
458 __s32 min_rts; /* Minimal RTS threshold */
459 __s32 max_rts; /* Maximal RTS threshold */
460  
461 /* Frag threshold */
462 __s32 min_frag; /* Minimal frag threshold */
463 __s32 max_frag; /* Maximal frag threshold */
464  
465 /* Power Management duration & timeout */
466 __s32 min_pmp; /* Minimal PM period */
467 __s32 max_pmp; /* Maximal PM period */
468 __s32 min_pmt; /* Minimal PM timeout */
469 __s32 max_pmt; /* Maximal PM timeout */
470 __u16 pmp_flags; /* How to decode max/min PM period */
471 __u16 pmt_flags; /* How to decode max/min PM timeout */
472 __u16 pm_capa; /* What PM options are supported */
473  
474 /* Encoder stuff */
475 __u16 encoding_size[IW_MAX_ENCODING_SIZES]; /* Different token sizes */
476 __u8 num_encoding_sizes; /* Number of entry in the list */
477 __u8 max_encoding_tokens; /* Max number of tokens */
478  
479 /* Transmit power */
480 __u16 txpower_capa; /* What options are supported */
481 __u8 num_txpower; /* Number of entries in the list */
482 __s32 txpower[IW_MAX_TXPOWER]; /* list, in bps */
483  
484 /* Wireless Extension version info */
485 __u8 we_version_compiled; /* Must be WIRELESS_EXT */
486 __u8 we_version_source; /* Last update of source */
487  
488 /* Retry limits and lifetime */
489 __u16 retry_capa; /* What retry options are supported */
490 __u16 retry_flags; /* How to decode max/min retry limit */
491 __u16 r_time_flags; /* How to decode max/min retry life */
492 __s32 min_retry; /* Minimal number of retries */
493 __s32 max_retry; /* Maximal number of retries */
494 __s32 min_r_time; /* Minimal retry lifetime */
495 __s32 max_r_time; /* Maximal retry lifetime */
496 };
497  
498 /*
499 * Private ioctl interface information
500 */
501  
502 struct iw_priv_args
503 {
504 __u32 cmd; /* Number of the ioctl to issue */
505 __u16 set_args; /* Type and number of args */
506 __u16 get_args; /* Type and number of args */
507 char name[IFNAMSIZ]; /* Name of the extension */
508 };
509  
510 #endif /* _LINUX_WIRELESS_H */