inet: Pass flowi to ->queue_xmit().
[deliverable/linux.git] / include / net / cfg80211.h
1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
3 /*
4 * 802.11 device and configuration interface
5 *
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/netlink.h>
17 #include <linux/skbuff.h>
18 #include <linux/nl80211.h>
19 #include <linux/if_ether.h>
20 #include <linux/ieee80211.h>
21 #include <net/regulatory.h>
22
23 /* remove once we remove the wext stuff */
24 #include <net/iw_handler.h>
25 #include <linux/wireless.h>
26
27
28 /**
29 * DOC: Introduction
30 *
31 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32 * userspace and drivers, and offers some utility functionality associated
33 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34 * by all modern wireless drivers in Linux, so that they offer a consistent
35 * API through nl80211. For backward compatibility, cfg80211 also offers
36 * wireless extensions to userspace, but hides them from drivers completely.
37 *
38 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
39 * use restrictions.
40 */
41
42
43 /**
44 * DOC: Device registration
45 *
46 * In order for a driver to use cfg80211, it must register the hardware device
47 * with cfg80211. This happens through a number of hardware capability structs
48 * described below.
49 *
50 * The fundamental structure for each device is the 'wiphy', of which each
51 * instance describes a physical wireless device connected to the system. Each
52 * such wiphy can have zero, one, or many virtual interfaces associated with
53 * it, which need to be identified as such by pointing the network interface's
54 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55 * the wireless part of the interface, normally this struct is embedded in the
56 * network interface's private data area. Drivers can optionally allow creating
57 * or destroying virtual interfaces on the fly, but without at least one or the
58 * ability to create some the wireless device isn't useful.
59 *
60 * Each wiphy structure contains device capability information, and also has
61 * a pointer to the various operations the driver offers. The definitions and
62 * structures here describe these capabilities in detail.
63 */
64
65 /*
66 * wireless hardware capability structures
67 */
68
69 /**
70 * enum ieee80211_band - supported frequency bands
71 *
72 * The bands are assigned this way because the supported
73 * bitrates differ in these bands.
74 *
75 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
76 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
77 * @IEEE80211_NUM_BANDS: number of defined bands
78 */
79 enum ieee80211_band {
80 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
82
83 /* keep last */
84 IEEE80211_NUM_BANDS
85 };
86
87 /**
88 * enum ieee80211_channel_flags - channel flags
89 *
90 * Channel flags set by the regulatory control code.
91 *
92 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
93 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
94 * on this channel.
95 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
96 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
97 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
98 * is not permitted.
99 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
100 * is not permitted.
101 */
102 enum ieee80211_channel_flags {
103 IEEE80211_CHAN_DISABLED = 1<<0,
104 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
105 IEEE80211_CHAN_NO_IBSS = 1<<2,
106 IEEE80211_CHAN_RADAR = 1<<3,
107 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
108 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
109 };
110
111 #define IEEE80211_CHAN_NO_HT40 \
112 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
113
114 /**
115 * struct ieee80211_channel - channel definition
116 *
117 * This structure describes a single channel for use
118 * with cfg80211.
119 *
120 * @center_freq: center frequency in MHz
121 * @hw_value: hardware-specific value for the channel
122 * @flags: channel flags from &enum ieee80211_channel_flags.
123 * @orig_flags: channel flags at registration time, used by regulatory
124 * code to support devices with additional restrictions
125 * @band: band this channel belongs to.
126 * @max_antenna_gain: maximum antenna gain in dBi
127 * @max_power: maximum transmission power (in dBm)
128 * @beacon_found: helper to regulatory code to indicate when a beacon
129 * has been found on this channel. Use regulatory_hint_found_beacon()
130 * to enable this, this is useful only on 5 GHz band.
131 * @orig_mag: internal use
132 * @orig_mpwr: internal use
133 */
134 struct ieee80211_channel {
135 enum ieee80211_band band;
136 u16 center_freq;
137 u16 hw_value;
138 u32 flags;
139 int max_antenna_gain;
140 int max_power;
141 bool beacon_found;
142 u32 orig_flags;
143 int orig_mag, orig_mpwr;
144 };
145
146 /**
147 * enum ieee80211_rate_flags - rate flags
148 *
149 * Hardware/specification flags for rates. These are structured
150 * in a way that allows using the same bitrate structure for
151 * different bands/PHY modes.
152 *
153 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
154 * preamble on this bitrate; only relevant in 2.4GHz band and
155 * with CCK rates.
156 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
157 * when used with 802.11a (on the 5 GHz band); filled by the
158 * core code when registering the wiphy.
159 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
160 * when used with 802.11b (on the 2.4 GHz band); filled by the
161 * core code when registering the wiphy.
162 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
163 * when used with 802.11g (on the 2.4 GHz band); filled by the
164 * core code when registering the wiphy.
165 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
166 */
167 enum ieee80211_rate_flags {
168 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
169 IEEE80211_RATE_MANDATORY_A = 1<<1,
170 IEEE80211_RATE_MANDATORY_B = 1<<2,
171 IEEE80211_RATE_MANDATORY_G = 1<<3,
172 IEEE80211_RATE_ERP_G = 1<<4,
173 };
174
175 /**
176 * struct ieee80211_rate - bitrate definition
177 *
178 * This structure describes a bitrate that an 802.11 PHY can
179 * operate with. The two values @hw_value and @hw_value_short
180 * are only for driver use when pointers to this structure are
181 * passed around.
182 *
183 * @flags: rate-specific flags
184 * @bitrate: bitrate in units of 100 Kbps
185 * @hw_value: driver/hardware value for this rate
186 * @hw_value_short: driver/hardware value for this rate when
187 * short preamble is used
188 */
189 struct ieee80211_rate {
190 u32 flags;
191 u16 bitrate;
192 u16 hw_value, hw_value_short;
193 };
194
195 /**
196 * struct ieee80211_sta_ht_cap - STA's HT capabilities
197 *
198 * This structure describes most essential parameters needed
199 * to describe 802.11n HT capabilities for an STA.
200 *
201 * @ht_supported: is HT supported by the STA
202 * @cap: HT capabilities map as described in 802.11n spec
203 * @ampdu_factor: Maximum A-MPDU length factor
204 * @ampdu_density: Minimum A-MPDU spacing
205 * @mcs: Supported MCS rates
206 */
207 struct ieee80211_sta_ht_cap {
208 u16 cap; /* use IEEE80211_HT_CAP_ */
209 bool ht_supported;
210 u8 ampdu_factor;
211 u8 ampdu_density;
212 struct ieee80211_mcs_info mcs;
213 };
214
215 /**
216 * struct ieee80211_supported_band - frequency band definition
217 *
218 * This structure describes a frequency band a wiphy
219 * is able to operate in.
220 *
221 * @channels: Array of channels the hardware can operate in
222 * in this band.
223 * @band: the band this structure represents
224 * @n_channels: Number of channels in @channels
225 * @bitrates: Array of bitrates the hardware can operate with
226 * in this band. Must be sorted to give a valid "supported
227 * rates" IE, i.e. CCK rates first, then OFDM.
228 * @n_bitrates: Number of bitrates in @bitrates
229 * @ht_cap: HT capabilities in this band
230 */
231 struct ieee80211_supported_band {
232 struct ieee80211_channel *channels;
233 struct ieee80211_rate *bitrates;
234 enum ieee80211_band band;
235 int n_channels;
236 int n_bitrates;
237 struct ieee80211_sta_ht_cap ht_cap;
238 };
239
240 /*
241 * Wireless hardware/device configuration structures and methods
242 */
243
244 /**
245 * DOC: Actions and configuration
246 *
247 * Each wireless device and each virtual interface offer a set of configuration
248 * operations and other actions that are invoked by userspace. Each of these
249 * actions is described in the operations structure, and the parameters these
250 * operations use are described separately.
251 *
252 * Additionally, some operations are asynchronous and expect to get status
253 * information via some functions that drivers need to call.
254 *
255 * Scanning and BSS list handling with its associated functionality is described
256 * in a separate chapter.
257 */
258
259 /**
260 * struct vif_params - describes virtual interface parameters
261 * @use_4addr: use 4-address frames
262 */
263 struct vif_params {
264 int use_4addr;
265 };
266
267 /**
268 * struct key_params - key information
269 *
270 * Information about a key
271 *
272 * @key: key material
273 * @key_len: length of key material
274 * @cipher: cipher suite selector
275 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
276 * with the get_key() callback, must be in little endian,
277 * length given by @seq_len.
278 * @seq_len: length of @seq.
279 */
280 struct key_params {
281 u8 *key;
282 u8 *seq;
283 int key_len;
284 int seq_len;
285 u32 cipher;
286 };
287
288 /**
289 * enum survey_info_flags - survey information flags
290 *
291 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
292 * @SURVEY_INFO_IN_USE: channel is currently being used
293 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
294 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
295 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
296 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
297 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
298 *
299 * Used by the driver to indicate which info in &struct survey_info
300 * it has filled in during the get_survey().
301 */
302 enum survey_info_flags {
303 SURVEY_INFO_NOISE_DBM = 1<<0,
304 SURVEY_INFO_IN_USE = 1<<1,
305 SURVEY_INFO_CHANNEL_TIME = 1<<2,
306 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
307 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
308 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
309 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
310 };
311
312 /**
313 * struct survey_info - channel survey response
314 *
315 * @channel: the channel this survey record reports, mandatory
316 * @filled: bitflag of flags from &enum survey_info_flags
317 * @noise: channel noise in dBm. This and all following fields are
318 * optional
319 * @channel_time: amount of time in ms the radio spent on the channel
320 * @channel_time_busy: amount of time the primary channel was sensed busy
321 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
322 * @channel_time_rx: amount of time the radio spent receiving data
323 * @channel_time_tx: amount of time the radio spent transmitting data
324 *
325 * Used by dump_survey() to report back per-channel survey information.
326 *
327 * This structure can later be expanded with things like
328 * channel duty cycle etc.
329 */
330 struct survey_info {
331 struct ieee80211_channel *channel;
332 u64 channel_time;
333 u64 channel_time_busy;
334 u64 channel_time_ext_busy;
335 u64 channel_time_rx;
336 u64 channel_time_tx;
337 u32 filled;
338 s8 noise;
339 };
340
341 /**
342 * struct beacon_parameters - beacon parameters
343 *
344 * Used to configure the beacon for an interface.
345 *
346 * @head: head portion of beacon (before TIM IE)
347 * or %NULL if not changed
348 * @tail: tail portion of beacon (after TIM IE)
349 * or %NULL if not changed
350 * @interval: beacon interval or zero if not changed
351 * @dtim_period: DTIM period or zero if not changed
352 * @head_len: length of @head
353 * @tail_len: length of @tail
354 */
355 struct beacon_parameters {
356 u8 *head, *tail;
357 int interval, dtim_period;
358 int head_len, tail_len;
359 };
360
361 /**
362 * enum plink_action - actions to perform in mesh peers
363 *
364 * @PLINK_ACTION_INVALID: action 0 is reserved
365 * @PLINK_ACTION_OPEN: start mesh peer link establishment
366 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
367 */
368 enum plink_actions {
369 PLINK_ACTION_INVALID,
370 PLINK_ACTION_OPEN,
371 PLINK_ACTION_BLOCK,
372 };
373
374 /**
375 * struct station_parameters - station parameters
376 *
377 * Used to change and create a new station.
378 *
379 * @vlan: vlan interface station should belong to
380 * @supported_rates: supported rates in IEEE 802.11 format
381 * (or NULL for no change)
382 * @supported_rates_len: number of supported rates
383 * @sta_flags_mask: station flags that changed
384 * (bitmask of BIT(NL80211_STA_FLAG_...))
385 * @sta_flags_set: station flags values
386 * (bitmask of BIT(NL80211_STA_FLAG_...))
387 * @listen_interval: listen interval or -1 for no change
388 * @aid: AID or zero for no change
389 * @plink_action: plink action to take
390 * @ht_capa: HT capabilities of station
391 */
392 struct station_parameters {
393 u8 *supported_rates;
394 struct net_device *vlan;
395 u32 sta_flags_mask, sta_flags_set;
396 int listen_interval;
397 u16 aid;
398 u8 supported_rates_len;
399 u8 plink_action;
400 struct ieee80211_ht_cap *ht_capa;
401 };
402
403 /**
404 * enum station_info_flags - station information flags
405 *
406 * Used by the driver to indicate which info in &struct station_info
407 * it has filled in during get_station() or dump_station().
408 *
409 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
410 * @STATION_INFO_RX_BYTES: @rx_bytes filled
411 * @STATION_INFO_TX_BYTES: @tx_bytes filled
412 * @STATION_INFO_LLID: @llid filled
413 * @STATION_INFO_PLID: @plid filled
414 * @STATION_INFO_PLINK_STATE: @plink_state filled
415 * @STATION_INFO_SIGNAL: @signal filled
416 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
417 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
418 * @STATION_INFO_RX_PACKETS: @rx_packets filled
419 * @STATION_INFO_TX_PACKETS: @tx_packets filled
420 * @STATION_INFO_TX_RETRIES: @tx_retries filled
421 * @STATION_INFO_TX_FAILED: @tx_failed filled
422 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
423 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
424 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
425 * @STATION_INFO_BSS_PARAM: @bss_param filled
426 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
427 */
428 enum station_info_flags {
429 STATION_INFO_INACTIVE_TIME = 1<<0,
430 STATION_INFO_RX_BYTES = 1<<1,
431 STATION_INFO_TX_BYTES = 1<<2,
432 STATION_INFO_LLID = 1<<3,
433 STATION_INFO_PLID = 1<<4,
434 STATION_INFO_PLINK_STATE = 1<<5,
435 STATION_INFO_SIGNAL = 1<<6,
436 STATION_INFO_TX_BITRATE = 1<<7,
437 STATION_INFO_RX_PACKETS = 1<<8,
438 STATION_INFO_TX_PACKETS = 1<<9,
439 STATION_INFO_TX_RETRIES = 1<<10,
440 STATION_INFO_TX_FAILED = 1<<11,
441 STATION_INFO_RX_DROP_MISC = 1<<12,
442 STATION_INFO_SIGNAL_AVG = 1<<13,
443 STATION_INFO_RX_BITRATE = 1<<14,
444 STATION_INFO_BSS_PARAM = 1<<15,
445 STATION_INFO_CONNECTED_TIME = 1<<16
446 };
447
448 /**
449 * enum station_info_rate_flags - bitrate info flags
450 *
451 * Used by the driver to indicate the specific rate transmission
452 * type for 802.11n transmissions.
453 *
454 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
455 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
456 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
457 */
458 enum rate_info_flags {
459 RATE_INFO_FLAGS_MCS = 1<<0,
460 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
461 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
462 };
463
464 /**
465 * struct rate_info - bitrate information
466 *
467 * Information about a receiving or transmitting bitrate
468 *
469 * @flags: bitflag of flags from &enum rate_info_flags
470 * @mcs: mcs index if struct describes a 802.11n bitrate
471 * @legacy: bitrate in 100kbit/s for 802.11abg
472 */
473 struct rate_info {
474 u8 flags;
475 u8 mcs;
476 u16 legacy;
477 };
478
479 /**
480 * enum station_info_rate_flags - bitrate info flags
481 *
482 * Used by the driver to indicate the specific rate transmission
483 * type for 802.11n transmissions.
484 *
485 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
486 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
487 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
488 */
489 enum bss_param_flags {
490 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
491 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
492 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
493 };
494
495 /**
496 * struct sta_bss_parameters - BSS parameters for the attached station
497 *
498 * Information about the currently associated BSS
499 *
500 * @flags: bitflag of flags from &enum bss_param_flags
501 * @dtim_period: DTIM period for the BSS
502 * @beacon_interval: beacon interval
503 */
504 struct sta_bss_parameters {
505 u8 flags;
506 u8 dtim_period;
507 u16 beacon_interval;
508 };
509
510 /**
511 * struct station_info - station information
512 *
513 * Station information filled by driver for get_station() and dump_station.
514 *
515 * @filled: bitflag of flags from &enum station_info_flags
516 * @connected_time: time(in secs) since a station is last connected
517 * @inactive_time: time since last station activity (tx/rx) in milliseconds
518 * @rx_bytes: bytes received from this station
519 * @tx_bytes: bytes transmitted to this station
520 * @llid: mesh local link id
521 * @plid: mesh peer link id
522 * @plink_state: mesh peer link state
523 * @signal: signal strength of last received packet in dBm
524 * @signal_avg: signal strength average in dBm
525 * @txrate: current unicast bitrate from this station
526 * @rxrate: current unicast bitrate to this station
527 * @rx_packets: packets received from this station
528 * @tx_packets: packets transmitted to this station
529 * @tx_retries: cumulative retry counts
530 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
531 * @rx_dropped_misc: Dropped for un-specified reason.
532 * @generation: generation number for nl80211 dumps.
533 * This number should increase every time the list of stations
534 * changes, i.e. when a station is added or removed, so that
535 * userspace can tell whether it got a consistent snapshot.
536 */
537 struct station_info {
538 u32 filled;
539 u32 connected_time;
540 u32 inactive_time;
541 u32 rx_bytes;
542 u32 tx_bytes;
543 u16 llid;
544 u16 plid;
545 u8 plink_state;
546 s8 signal;
547 s8 signal_avg;
548 struct rate_info txrate;
549 struct rate_info rxrate;
550 u32 rx_packets;
551 u32 tx_packets;
552 u32 tx_retries;
553 u32 tx_failed;
554 u32 rx_dropped_misc;
555 struct sta_bss_parameters bss_param;
556
557 int generation;
558 };
559
560 /**
561 * enum monitor_flags - monitor flags
562 *
563 * Monitor interface configuration flags. Note that these must be the bits
564 * according to the nl80211 flags.
565 *
566 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
567 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
568 * @MONITOR_FLAG_CONTROL: pass control frames
569 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
570 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
571 */
572 enum monitor_flags {
573 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
574 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
575 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
576 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
577 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
578 };
579
580 /**
581 * enum mpath_info_flags - mesh path information flags
582 *
583 * Used by the driver to indicate which info in &struct mpath_info it has filled
584 * in during get_station() or dump_station().
585 *
586 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
587 * @MPATH_INFO_SN: @sn filled
588 * @MPATH_INFO_METRIC: @metric filled
589 * @MPATH_INFO_EXPTIME: @exptime filled
590 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
591 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
592 * @MPATH_INFO_FLAGS: @flags filled
593 */
594 enum mpath_info_flags {
595 MPATH_INFO_FRAME_QLEN = BIT(0),
596 MPATH_INFO_SN = BIT(1),
597 MPATH_INFO_METRIC = BIT(2),
598 MPATH_INFO_EXPTIME = BIT(3),
599 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
600 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
601 MPATH_INFO_FLAGS = BIT(6),
602 };
603
604 /**
605 * struct mpath_info - mesh path information
606 *
607 * Mesh path information filled by driver for get_mpath() and dump_mpath().
608 *
609 * @filled: bitfield of flags from &enum mpath_info_flags
610 * @frame_qlen: number of queued frames for this destination
611 * @sn: target sequence number
612 * @metric: metric (cost) of this mesh path
613 * @exptime: expiration time for the mesh path from now, in msecs
614 * @flags: mesh path flags
615 * @discovery_timeout: total mesh path discovery timeout, in msecs
616 * @discovery_retries: mesh path discovery retries
617 * @generation: generation number for nl80211 dumps.
618 * This number should increase every time the list of mesh paths
619 * changes, i.e. when a station is added or removed, so that
620 * userspace can tell whether it got a consistent snapshot.
621 */
622 struct mpath_info {
623 u32 filled;
624 u32 frame_qlen;
625 u32 sn;
626 u32 metric;
627 u32 exptime;
628 u32 discovery_timeout;
629 u8 discovery_retries;
630 u8 flags;
631
632 int generation;
633 };
634
635 /**
636 * struct bss_parameters - BSS parameters
637 *
638 * Used to change BSS parameters (mainly for AP mode).
639 *
640 * @use_cts_prot: Whether to use CTS protection
641 * (0 = no, 1 = yes, -1 = do not change)
642 * @use_short_preamble: Whether the use of short preambles is allowed
643 * (0 = no, 1 = yes, -1 = do not change)
644 * @use_short_slot_time: Whether the use of short slot time is allowed
645 * (0 = no, 1 = yes, -1 = do not change)
646 * @basic_rates: basic rates in IEEE 802.11 format
647 * (or NULL for no change)
648 * @basic_rates_len: number of basic rates
649 * @ap_isolate: do not forward packets between connected stations
650 * @ht_opmode: HT Operation mode
651 * (u16 = opmode, -1 = do not change)
652 */
653 struct bss_parameters {
654 int use_cts_prot;
655 int use_short_preamble;
656 int use_short_slot_time;
657 u8 *basic_rates;
658 u8 basic_rates_len;
659 int ap_isolate;
660 int ht_opmode;
661 };
662
663 /*
664 * struct mesh_config - 802.11s mesh configuration
665 *
666 * These parameters can be changed while the mesh is active.
667 */
668 struct mesh_config {
669 /* Timeouts in ms */
670 /* Mesh plink management parameters */
671 u16 dot11MeshRetryTimeout;
672 u16 dot11MeshConfirmTimeout;
673 u16 dot11MeshHoldingTimeout;
674 u16 dot11MeshMaxPeerLinks;
675 u8 dot11MeshMaxRetries;
676 u8 dot11MeshTTL;
677 /* ttl used in path selection information elements */
678 u8 element_ttl;
679 bool auto_open_plinks;
680 /* HWMP parameters */
681 u8 dot11MeshHWMPmaxPREQretries;
682 u32 path_refresh_time;
683 u16 min_discovery_timeout;
684 u32 dot11MeshHWMPactivePathTimeout;
685 u16 dot11MeshHWMPpreqMinInterval;
686 u16 dot11MeshHWMPnetDiameterTraversalTime;
687 u8 dot11MeshHWMPRootMode;
688 };
689
690 /**
691 * struct mesh_setup - 802.11s mesh setup configuration
692 * @mesh_id: the mesh ID
693 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
694 * @path_sel_proto: which path selection protocol to use
695 * @path_metric: which metric to use
696 * @ie: vendor information elements (optional)
697 * @ie_len: length of vendor information elements
698 * @is_secure: or not
699 *
700 * These parameters are fixed when the mesh is created.
701 */
702 struct mesh_setup {
703 const u8 *mesh_id;
704 u8 mesh_id_len;
705 u8 path_sel_proto;
706 u8 path_metric;
707 const u8 *ie;
708 u8 ie_len;
709 bool is_secure;
710 };
711
712 /**
713 * struct ieee80211_txq_params - TX queue parameters
714 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
715 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
716 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
717 * 1..32767]
718 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
719 * 1..32767]
720 * @aifs: Arbitration interframe space [0..255]
721 */
722 struct ieee80211_txq_params {
723 enum nl80211_txq_q queue;
724 u16 txop;
725 u16 cwmin;
726 u16 cwmax;
727 u8 aifs;
728 };
729
730 /* from net/wireless.h */
731 struct wiphy;
732
733 /**
734 * DOC: Scanning and BSS list handling
735 *
736 * The scanning process itself is fairly simple, but cfg80211 offers quite
737 * a bit of helper functionality. To start a scan, the scan operation will
738 * be invoked with a scan definition. This scan definition contains the
739 * channels to scan, and the SSIDs to send probe requests for (including the
740 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
741 * probe. Additionally, a scan request may contain extra information elements
742 * that should be added to the probe request. The IEs are guaranteed to be
743 * well-formed, and will not exceed the maximum length the driver advertised
744 * in the wiphy structure.
745 *
746 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
747 * it is responsible for maintaining the BSS list; the driver should not
748 * maintain a list itself. For this notification, various functions exist.
749 *
750 * Since drivers do not maintain a BSS list, there are also a number of
751 * functions to search for a BSS and obtain information about it from the
752 * BSS structure cfg80211 maintains. The BSS list is also made available
753 * to userspace.
754 */
755
756 /**
757 * struct cfg80211_ssid - SSID description
758 * @ssid: the SSID
759 * @ssid_len: length of the ssid
760 */
761 struct cfg80211_ssid {
762 u8 ssid[IEEE80211_MAX_SSID_LEN];
763 u8 ssid_len;
764 };
765
766 /**
767 * struct cfg80211_scan_request - scan request description
768 *
769 * @ssids: SSIDs to scan for (active scan only)
770 * @n_ssids: number of SSIDs
771 * @channels: channels to scan on.
772 * @n_channels: total number of channels to scan
773 * @ie: optional information element(s) to add into Probe Request or %NULL
774 * @ie_len: length of ie in octets
775 * @wiphy: the wiphy this was for
776 * @dev: the interface
777 * @aborted: (internal) scan request was notified as aborted
778 */
779 struct cfg80211_scan_request {
780 struct cfg80211_ssid *ssids;
781 int n_ssids;
782 u32 n_channels;
783 const u8 *ie;
784 size_t ie_len;
785
786 /* internal */
787 struct wiphy *wiphy;
788 struct net_device *dev;
789 bool aborted;
790
791 /* keep last */
792 struct ieee80211_channel *channels[0];
793 };
794
795 /**
796 * enum cfg80211_signal_type - signal type
797 *
798 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
799 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
800 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
801 */
802 enum cfg80211_signal_type {
803 CFG80211_SIGNAL_TYPE_NONE,
804 CFG80211_SIGNAL_TYPE_MBM,
805 CFG80211_SIGNAL_TYPE_UNSPEC,
806 };
807
808 /**
809 * struct cfg80211_bss - BSS description
810 *
811 * This structure describes a BSS (which may also be a mesh network)
812 * for use in scan results and similar.
813 *
814 * @channel: channel this BSS is on
815 * @bssid: BSSID of the BSS
816 * @tsf: timestamp of last received update
817 * @beacon_interval: the beacon interval as from the frame
818 * @capability: the capability field in host byte order
819 * @information_elements: the information elements (Note that there
820 * is no guarantee that these are well-formed!); this is a pointer to
821 * either the beacon_ies or proberesp_ies depending on whether Probe
822 * Response frame has been received
823 * @len_information_elements: total length of the information elements
824 * @beacon_ies: the information elements from the last Beacon frame
825 * @len_beacon_ies: total length of the beacon_ies
826 * @proberesp_ies: the information elements from the last Probe Response frame
827 * @len_proberesp_ies: total length of the proberesp_ies
828 * @signal: signal strength value (type depends on the wiphy's signal_type)
829 * @free_priv: function pointer to free private data
830 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
831 */
832 struct cfg80211_bss {
833 struct ieee80211_channel *channel;
834
835 u8 bssid[ETH_ALEN];
836 u64 tsf;
837 u16 beacon_interval;
838 u16 capability;
839 u8 *information_elements;
840 size_t len_information_elements;
841 u8 *beacon_ies;
842 size_t len_beacon_ies;
843 u8 *proberesp_ies;
844 size_t len_proberesp_ies;
845
846 s32 signal;
847
848 void (*free_priv)(struct cfg80211_bss *bss);
849 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
850 };
851
852 /**
853 * ieee80211_bss_get_ie - find IE with given ID
854 * @bss: the bss to search
855 * @ie: the IE ID
856 * Returns %NULL if not found.
857 */
858 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
859
860
861 /**
862 * struct cfg80211_crypto_settings - Crypto settings
863 * @wpa_versions: indicates which, if any, WPA versions are enabled
864 * (from enum nl80211_wpa_versions)
865 * @cipher_group: group key cipher suite (or 0 if unset)
866 * @n_ciphers_pairwise: number of AP supported unicast ciphers
867 * @ciphers_pairwise: unicast key cipher suites
868 * @n_akm_suites: number of AKM suites
869 * @akm_suites: AKM suites
870 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
871 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
872 * required to assume that the port is unauthorized until authorized by
873 * user space. Otherwise, port is marked authorized by default.
874 * @control_port_ethertype: the control port protocol that should be
875 * allowed through even on unauthorized ports
876 * @control_port_no_encrypt: TRUE to prevent encryption of control port
877 * protocol frames.
878 */
879 struct cfg80211_crypto_settings {
880 u32 wpa_versions;
881 u32 cipher_group;
882 int n_ciphers_pairwise;
883 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
884 int n_akm_suites;
885 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
886 bool control_port;
887 __be16 control_port_ethertype;
888 bool control_port_no_encrypt;
889 };
890
891 /**
892 * struct cfg80211_auth_request - Authentication request data
893 *
894 * This structure provides information needed to complete IEEE 802.11
895 * authentication.
896 *
897 * @bss: The BSS to authenticate with.
898 * @auth_type: Authentication type (algorithm)
899 * @ie: Extra IEs to add to Authentication frame or %NULL
900 * @ie_len: Length of ie buffer in octets
901 * @key_len: length of WEP key for shared key authentication
902 * @key_idx: index of WEP key for shared key authentication
903 * @key: WEP key for shared key authentication
904 * @local_state_change: This is a request for a local state only, i.e., no
905 * Authentication frame is to be transmitted and authentication state is
906 * to be changed without having to wait for a response from the peer STA
907 * (AP).
908 */
909 struct cfg80211_auth_request {
910 struct cfg80211_bss *bss;
911 const u8 *ie;
912 size_t ie_len;
913 enum nl80211_auth_type auth_type;
914 const u8 *key;
915 u8 key_len, key_idx;
916 bool local_state_change;
917 };
918
919 /**
920 * struct cfg80211_assoc_request - (Re)Association request data
921 *
922 * This structure provides information needed to complete IEEE 802.11
923 * (re)association.
924 * @bss: The BSS to associate with.
925 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
926 * @ie_len: Length of ie buffer in octets
927 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
928 * @crypto: crypto settings
929 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
930 */
931 struct cfg80211_assoc_request {
932 struct cfg80211_bss *bss;
933 const u8 *ie, *prev_bssid;
934 size_t ie_len;
935 struct cfg80211_crypto_settings crypto;
936 bool use_mfp;
937 };
938
939 /**
940 * struct cfg80211_deauth_request - Deauthentication request data
941 *
942 * This structure provides information needed to complete IEEE 802.11
943 * deauthentication.
944 *
945 * @bss: the BSS to deauthenticate from
946 * @ie: Extra IEs to add to Deauthentication frame or %NULL
947 * @ie_len: Length of ie buffer in octets
948 * @reason_code: The reason code for the deauthentication
949 * @local_state_change: This is a request for a local state only, i.e., no
950 * Deauthentication frame is to be transmitted.
951 */
952 struct cfg80211_deauth_request {
953 struct cfg80211_bss *bss;
954 const u8 *ie;
955 size_t ie_len;
956 u16 reason_code;
957 bool local_state_change;
958 };
959
960 /**
961 * struct cfg80211_disassoc_request - Disassociation request data
962 *
963 * This structure provides information needed to complete IEEE 802.11
964 * disassocation.
965 *
966 * @bss: the BSS to disassociate from
967 * @ie: Extra IEs to add to Disassociation frame or %NULL
968 * @ie_len: Length of ie buffer in octets
969 * @reason_code: The reason code for the disassociation
970 * @local_state_change: This is a request for a local state only, i.e., no
971 * Disassociation frame is to be transmitted.
972 */
973 struct cfg80211_disassoc_request {
974 struct cfg80211_bss *bss;
975 const u8 *ie;
976 size_t ie_len;
977 u16 reason_code;
978 bool local_state_change;
979 };
980
981 /**
982 * struct cfg80211_ibss_params - IBSS parameters
983 *
984 * This structure defines the IBSS parameters for the join_ibss()
985 * method.
986 *
987 * @ssid: The SSID, will always be non-null.
988 * @ssid_len: The length of the SSID, will always be non-zero.
989 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
990 * search for IBSSs with a different BSSID.
991 * @channel: The channel to use if no IBSS can be found to join.
992 * @channel_fixed: The channel should be fixed -- do not search for
993 * IBSSs to join on other channels.
994 * @ie: information element(s) to include in the beacon
995 * @ie_len: length of that
996 * @beacon_interval: beacon interval to use
997 * @privacy: this is a protected network, keys will be configured
998 * after joining
999 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1000 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1001 */
1002 struct cfg80211_ibss_params {
1003 u8 *ssid;
1004 u8 *bssid;
1005 struct ieee80211_channel *channel;
1006 u8 *ie;
1007 u8 ssid_len, ie_len;
1008 u16 beacon_interval;
1009 u32 basic_rates;
1010 bool channel_fixed;
1011 bool privacy;
1012 int mcast_rate[IEEE80211_NUM_BANDS];
1013 };
1014
1015 /**
1016 * struct cfg80211_connect_params - Connection parameters
1017 *
1018 * This structure provides information needed to complete IEEE 802.11
1019 * authentication and association.
1020 *
1021 * @channel: The channel to use or %NULL if not specified (auto-select based
1022 * on scan results)
1023 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1024 * results)
1025 * @ssid: SSID
1026 * @ssid_len: Length of ssid in octets
1027 * @auth_type: Authentication type (algorithm)
1028 * @ie: IEs for association request
1029 * @ie_len: Length of assoc_ie in octets
1030 * @privacy: indicates whether privacy-enabled APs should be used
1031 * @crypto: crypto settings
1032 * @key_len: length of WEP key for shared key authentication
1033 * @key_idx: index of WEP key for shared key authentication
1034 * @key: WEP key for shared key authentication
1035 */
1036 struct cfg80211_connect_params {
1037 struct ieee80211_channel *channel;
1038 u8 *bssid;
1039 u8 *ssid;
1040 size_t ssid_len;
1041 enum nl80211_auth_type auth_type;
1042 u8 *ie;
1043 size_t ie_len;
1044 bool privacy;
1045 struct cfg80211_crypto_settings crypto;
1046 const u8 *key;
1047 u8 key_len, key_idx;
1048 };
1049
1050 /**
1051 * enum wiphy_params_flags - set_wiphy_params bitfield values
1052 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1053 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1054 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1055 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1056 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1057 */
1058 enum wiphy_params_flags {
1059 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1060 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1061 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1062 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1063 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1064 };
1065
1066 /*
1067 * cfg80211_bitrate_mask - masks for bitrate control
1068 */
1069 struct cfg80211_bitrate_mask {
1070 struct {
1071 u32 legacy;
1072 /* TODO: add support for masking MCS rates; e.g.: */
1073 /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
1074 } control[IEEE80211_NUM_BANDS];
1075 };
1076 /**
1077 * struct cfg80211_pmksa - PMK Security Association
1078 *
1079 * This structure is passed to the set/del_pmksa() method for PMKSA
1080 * caching.
1081 *
1082 * @bssid: The AP's BSSID.
1083 * @pmkid: The PMK material itself.
1084 */
1085 struct cfg80211_pmksa {
1086 u8 *bssid;
1087 u8 *pmkid;
1088 };
1089
1090 /**
1091 * struct cfg80211_ops - backend description for wireless configuration
1092 *
1093 * This struct is registered by fullmac card drivers and/or wireless stacks
1094 * in order to handle configuration requests on their interfaces.
1095 *
1096 * All callbacks except where otherwise noted should return 0
1097 * on success or a negative error code.
1098 *
1099 * All operations are currently invoked under rtnl for consistency with the
1100 * wireless extensions but this is subject to reevaluation as soon as this
1101 * code is used more widely and we have a first user without wext.
1102 *
1103 * @suspend: wiphy device needs to be suspended
1104 * @resume: wiphy device needs to be resumed
1105 *
1106 * @add_virtual_intf: create a new virtual interface with the given name,
1107 * must set the struct wireless_dev's iftype. Beware: You must create
1108 * the new netdev in the wiphy's network namespace! Returns the netdev,
1109 * or an ERR_PTR.
1110 *
1111 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1112 *
1113 * @change_virtual_intf: change type/configuration of virtual interface,
1114 * keep the struct wireless_dev's iftype updated.
1115 *
1116 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1117 * when adding a group key.
1118 *
1119 * @get_key: get information about the key with the given parameters.
1120 * @mac_addr will be %NULL when requesting information for a group
1121 * key. All pointers given to the @callback function need not be valid
1122 * after it returns. This function should return an error if it is
1123 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1124 *
1125 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1126 * and @key_index, return -ENOENT if the key doesn't exist.
1127 *
1128 * @set_default_key: set the default key on an interface
1129 *
1130 * @set_default_mgmt_key: set the default management frame key on an interface
1131 *
1132 * @add_beacon: Add a beacon with given parameters, @head, @interval
1133 * and @dtim_period will be valid, @tail is optional.
1134 * @set_beacon: Change the beacon parameters for an access point mode
1135 * interface. This should reject the call when no beacon has been
1136 * configured.
1137 * @del_beacon: Remove beacon configuration and stop sending the beacon.
1138 *
1139 * @add_station: Add a new station.
1140 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1141 * @change_station: Modify a given station.
1142 * @get_station: get station information for the station identified by @mac
1143 * @dump_station: dump station callback -- resume dump at index @idx
1144 *
1145 * @add_mpath: add a fixed mesh path
1146 * @del_mpath: delete a given mesh path
1147 * @change_mpath: change a given mesh path
1148 * @get_mpath: get a mesh path for the given parameters
1149 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1150 * @join_mesh: join the mesh network with the specified parameters
1151 * @leave_mesh: leave the current mesh network
1152 *
1153 * @get_mesh_config: Get the current mesh configuration
1154 *
1155 * @update_mesh_config: Update mesh parameters on a running mesh.
1156 * The mask is a bitfield which tells us which parameters to
1157 * set, and which to leave alone.
1158 *
1159 * @change_bss: Modify parameters for a given BSS.
1160 *
1161 * @set_txq_params: Set TX queue parameters
1162 *
1163 * @set_channel: Set channel for a given wireless interface. Some devices
1164 * may support multi-channel operation (by channel hopping) so cfg80211
1165 * doesn't verify much. Note, however, that the passed netdev may be
1166 * %NULL as well if the user requested changing the channel for the
1167 * device itself, or for a monitor interface.
1168 *
1169 * @scan: Request to do a scan. If returning zero, the scan request is given
1170 * the driver, and will be valid until passed to cfg80211_scan_done().
1171 * For scan results, call cfg80211_inform_bss(); you can call this outside
1172 * the scan/scan_done bracket too.
1173 *
1174 * @auth: Request to authenticate with the specified peer
1175 * @assoc: Request to (re)associate with the specified peer
1176 * @deauth: Request to deauthenticate from the specified peer
1177 * @disassoc: Request to disassociate from the specified peer
1178 *
1179 * @connect: Connect to the ESS with the specified parameters. When connected,
1180 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1181 * If the connection fails for some reason, call cfg80211_connect_result()
1182 * with the status from the AP.
1183 * @disconnect: Disconnect from the BSS/ESS.
1184 *
1185 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1186 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1187 * to a merge.
1188 * @leave_ibss: Leave the IBSS.
1189 *
1190 * @set_wiphy_params: Notify that wiphy parameters have changed;
1191 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1192 * have changed. The actual parameter values are available in
1193 * struct wiphy. If returning an error, no value should be changed.
1194 *
1195 * @set_tx_power: set the transmit power according to the parameters
1196 * @get_tx_power: store the current TX power into the dbm variable;
1197 * return 0 if successful
1198 *
1199 * @set_wds_peer: set the WDS peer for a WDS interface
1200 *
1201 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1202 * functions to adjust rfkill hw state
1203 *
1204 * @dump_survey: get site survey information.
1205 *
1206 * @remain_on_channel: Request the driver to remain awake on the specified
1207 * channel for the specified duration to complete an off-channel
1208 * operation (e.g., public action frame exchange). When the driver is
1209 * ready on the requested channel, it must indicate this with an event
1210 * notification by calling cfg80211_ready_on_channel().
1211 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1212 * This allows the operation to be terminated prior to timeout based on
1213 * the duration value.
1214 * @mgmt_tx: Transmit a management frame.
1215 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1216 * frame on another channel
1217 *
1218 * @testmode_cmd: run a test mode command
1219 *
1220 * @set_bitrate_mask: set the bitrate mask configuration
1221 *
1222 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1223 * devices running firmwares capable of generating the (re) association
1224 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1225 * @del_pmksa: Delete a cached PMKID.
1226 * @flush_pmksa: Flush all cached PMKIDs.
1227 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1228 * allows the driver to adjust the dynamic ps timeout value.
1229 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1230 *
1231 * @mgmt_frame_register: Notify driver that a management frame type was
1232 * registered. Note that this callback may not sleep, and cannot run
1233 * concurrently with itself.
1234 *
1235 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1236 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1237 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1238 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1239 *
1240 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1241 *
1242 * @set_ringparam: Set tx and rx ring sizes.
1243 *
1244 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1245 */
1246 struct cfg80211_ops {
1247 int (*suspend)(struct wiphy *wiphy);
1248 int (*resume)(struct wiphy *wiphy);
1249
1250 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
1251 char *name,
1252 enum nl80211_iftype type,
1253 u32 *flags,
1254 struct vif_params *params);
1255 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1256 int (*change_virtual_intf)(struct wiphy *wiphy,
1257 struct net_device *dev,
1258 enum nl80211_iftype type, u32 *flags,
1259 struct vif_params *params);
1260
1261 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1262 u8 key_index, bool pairwise, const u8 *mac_addr,
1263 struct key_params *params);
1264 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1265 u8 key_index, bool pairwise, const u8 *mac_addr,
1266 void *cookie,
1267 void (*callback)(void *cookie, struct key_params*));
1268 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1269 u8 key_index, bool pairwise, const u8 *mac_addr);
1270 int (*set_default_key)(struct wiphy *wiphy,
1271 struct net_device *netdev,
1272 u8 key_index, bool unicast, bool multicast);
1273 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1274 struct net_device *netdev,
1275 u8 key_index);
1276
1277 int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
1278 struct beacon_parameters *info);
1279 int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
1280 struct beacon_parameters *info);
1281 int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
1282
1283
1284 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1285 u8 *mac, struct station_parameters *params);
1286 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1287 u8 *mac);
1288 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1289 u8 *mac, struct station_parameters *params);
1290 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1291 u8 *mac, struct station_info *sinfo);
1292 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1293 int idx, u8 *mac, struct station_info *sinfo);
1294
1295 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1296 u8 *dst, u8 *next_hop);
1297 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1298 u8 *dst);
1299 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1300 u8 *dst, u8 *next_hop);
1301 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1302 u8 *dst, u8 *next_hop,
1303 struct mpath_info *pinfo);
1304 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1305 int idx, u8 *dst, u8 *next_hop,
1306 struct mpath_info *pinfo);
1307 int (*get_mesh_config)(struct wiphy *wiphy,
1308 struct net_device *dev,
1309 struct mesh_config *conf);
1310 int (*update_mesh_config)(struct wiphy *wiphy,
1311 struct net_device *dev, u32 mask,
1312 const struct mesh_config *nconf);
1313 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1314 const struct mesh_config *conf,
1315 const struct mesh_setup *setup);
1316 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1317
1318 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1319 struct bss_parameters *params);
1320
1321 int (*set_txq_params)(struct wiphy *wiphy,
1322 struct ieee80211_txq_params *params);
1323
1324 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
1325 struct ieee80211_channel *chan,
1326 enum nl80211_channel_type channel_type);
1327
1328 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1329 struct cfg80211_scan_request *request);
1330
1331 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1332 struct cfg80211_auth_request *req);
1333 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1334 struct cfg80211_assoc_request *req);
1335 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1336 struct cfg80211_deauth_request *req,
1337 void *cookie);
1338 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1339 struct cfg80211_disassoc_request *req,
1340 void *cookie);
1341
1342 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1343 struct cfg80211_connect_params *sme);
1344 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1345 u16 reason_code);
1346
1347 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1348 struct cfg80211_ibss_params *params);
1349 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1350
1351 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1352
1353 int (*set_tx_power)(struct wiphy *wiphy,
1354 enum nl80211_tx_power_setting type, int mbm);
1355 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1356
1357 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1358 const u8 *addr);
1359
1360 void (*rfkill_poll)(struct wiphy *wiphy);
1361
1362 #ifdef CONFIG_NL80211_TESTMODE
1363 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1364 #endif
1365
1366 int (*set_bitrate_mask)(struct wiphy *wiphy,
1367 struct net_device *dev,
1368 const u8 *peer,
1369 const struct cfg80211_bitrate_mask *mask);
1370
1371 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1372 int idx, struct survey_info *info);
1373
1374 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1375 struct cfg80211_pmksa *pmksa);
1376 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1377 struct cfg80211_pmksa *pmksa);
1378 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1379
1380 int (*remain_on_channel)(struct wiphy *wiphy,
1381 struct net_device *dev,
1382 struct ieee80211_channel *chan,
1383 enum nl80211_channel_type channel_type,
1384 unsigned int duration,
1385 u64 *cookie);
1386 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1387 struct net_device *dev,
1388 u64 cookie);
1389
1390 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1391 struct ieee80211_channel *chan, bool offchan,
1392 enum nl80211_channel_type channel_type,
1393 bool channel_type_valid, unsigned int wait,
1394 const u8 *buf, size_t len, u64 *cookie);
1395 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1396 struct net_device *dev,
1397 u64 cookie);
1398
1399 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1400 bool enabled, int timeout);
1401
1402 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1403 struct net_device *dev,
1404 s32 rssi_thold, u32 rssi_hyst);
1405
1406 void (*mgmt_frame_register)(struct wiphy *wiphy,
1407 struct net_device *dev,
1408 u16 frame_type, bool reg);
1409
1410 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1411 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1412
1413 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1414 void (*get_ringparam)(struct wiphy *wiphy,
1415 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1416 };
1417
1418 /*
1419 * wireless hardware and networking interfaces structures
1420 * and registration/helper functions
1421 */
1422
1423 /**
1424 * enum wiphy_flags - wiphy capability flags
1425 *
1426 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1427 * has its own custom regulatory domain and cannot identify the
1428 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1429 * we will disregard the first regulatory hint (when the
1430 * initiator is %REGDOM_SET_BY_CORE).
1431 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1432 * ignore regulatory domain settings until it gets its own regulatory
1433 * domain via its regulatory_hint() unless the regulatory hint is
1434 * from a country IE. After its gets its own regulatory domain it will
1435 * only allow further regulatory domain settings to further enhance
1436 * compliance. For example if channel 13 and 14 are disabled by this
1437 * regulatory domain no user regulatory domain can enable these channels
1438 * at a later time. This can be used for devices which do not have
1439 * calibration information guaranteed for frequencies or settings
1440 * outside of its regulatory domain.
1441 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1442 * that passive scan flags and beaconing flags may not be lifted by
1443 * cfg80211 due to regulatory beacon hints. For more information on beacon
1444 * hints read the documenation for regulatory_hint_found_beacon()
1445 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1446 * wiphy at all
1447 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1448 * by default -- this flag will be set depending on the kernel's default
1449 * on wiphy_new(), but can be changed by the driver if it has a good
1450 * reason to override the default
1451 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1452 * on a VLAN interface)
1453 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1454 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1455 * control port protocol ethertype. The device also honours the
1456 * control_port_no_encrypt flag.
1457 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1458 * @WIPHY_FLAG_SUPPORTS_SEPARATE_DEFAULT_KEYS: The device supports separate
1459 * unicast and multicast TX keys.
1460 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1461 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1462 */
1463 enum wiphy_flags {
1464 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1465 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1466 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1467 WIPHY_FLAG_NETNS_OK = BIT(3),
1468 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1469 WIPHY_FLAG_4ADDR_AP = BIT(5),
1470 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1471 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1472 WIPHY_FLAG_IBSS_RSN = BIT(8),
1473 WIPHY_FLAG_SUPPORTS_SEPARATE_DEFAULT_KEYS= BIT(9),
1474 WIPHY_FLAG_MESH_AUTH = BIT(10),
1475 };
1476
1477 struct mac_address {
1478 u8 addr[ETH_ALEN];
1479 };
1480
1481 struct ieee80211_txrx_stypes {
1482 u16 tx, rx;
1483 };
1484
1485 /**
1486 * struct wiphy - wireless hardware description
1487 * @reg_notifier: the driver's regulatory notification callback,
1488 * note that if your driver uses wiphy_apply_custom_regulatory()
1489 * the reg_notifier's request can be passed as NULL
1490 * @regd: the driver's regulatory domain, if one was requested via
1491 * the regulatory_hint() API. This can be used by the driver
1492 * on the reg_notifier() if it chooses to ignore future
1493 * regulatory domain changes caused by other drivers.
1494 * @signal_type: signal type reported in &struct cfg80211_bss.
1495 * @cipher_suites: supported cipher suites
1496 * @n_cipher_suites: number of supported cipher suites
1497 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1498 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1499 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1500 * -1 = fragmentation disabled, only odd values >= 256 used
1501 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1502 * @_net: the network namespace this wiphy currently lives in
1503 * @perm_addr: permanent MAC address of this device
1504 * @addr_mask: If the device supports multiple MAC addresses by masking,
1505 * set this to a mask with variable bits set to 1, e.g. if the last
1506 * four bits are variable then set it to 00:...:00:0f. The actual
1507 * variable bits shall be determined by the interfaces added, with
1508 * interfaces not matching the mask being rejected to be brought up.
1509 * @n_addresses: number of addresses in @addresses.
1510 * @addresses: If the device has more than one address, set this pointer
1511 * to a list of addresses (6 bytes each). The first one will be used
1512 * by default for perm_addr. In this case, the mask should be set to
1513 * all-zeroes. In this case it is assumed that the device can handle
1514 * the same number of arbitrary MAC addresses.
1515 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1516 * automatically on wiphy renames
1517 * @dev: (virtual) struct device for this wiphy
1518 * @wext: wireless extension handlers
1519 * @priv: driver private data (sized according to wiphy_new() parameter)
1520 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1521 * must be set by driver
1522 * @flags: wiphy flags, see &enum wiphy_flags
1523 * @bss_priv_size: each BSS struct has private data allocated with it,
1524 * this variable determines its size
1525 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1526 * any given scan
1527 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1528 * add to probe request frames transmitted during a scan, must not
1529 * include fixed IEs like supported rates
1530 * @coverage_class: current coverage class
1531 * @fw_version: firmware version for ethtool reporting
1532 * @hw_version: hardware version for ethtool reporting
1533 * @max_num_pmkids: maximum number of PMKIDs supported by device
1534 * @privid: a pointer that drivers can use to identify if an arbitrary
1535 * wiphy is theirs, e.g. in global notifiers
1536 * @bands: information about bands/channels supported by this device
1537 *
1538 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1539 * transmitted through nl80211, points to an array indexed by interface
1540 * type
1541 *
1542 * @available_antennas_tx: bitmap of antennas which are available to be
1543 * configured as TX antennas. Antenna configuration commands will be
1544 * rejected unless this or @available_antennas_rx is set.
1545 *
1546 * @available_antennas_rx: bitmap of antennas which are available to be
1547 * configured as RX antennas. Antenna configuration commands will be
1548 * rejected unless this or @available_antennas_tx is set.
1549 *
1550 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
1551 * may request, if implemented.
1552 */
1553 struct wiphy {
1554 /* assign these fields before you register the wiphy */
1555
1556 /* permanent MAC address(es) */
1557 u8 perm_addr[ETH_ALEN];
1558 u8 addr_mask[ETH_ALEN];
1559
1560 struct mac_address *addresses;
1561
1562 const struct ieee80211_txrx_stypes *mgmt_stypes;
1563
1564 u16 n_addresses;
1565
1566 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1567 u16 interface_modes;
1568
1569 u32 flags;
1570
1571 enum cfg80211_signal_type signal_type;
1572
1573 int bss_priv_size;
1574 u8 max_scan_ssids;
1575 u16 max_scan_ie_len;
1576
1577 int n_cipher_suites;
1578 const u32 *cipher_suites;
1579
1580 u8 retry_short;
1581 u8 retry_long;
1582 u32 frag_threshold;
1583 u32 rts_threshold;
1584 u8 coverage_class;
1585
1586 char fw_version[ETHTOOL_BUSINFO_LEN];
1587 u32 hw_version;
1588
1589 u16 max_remain_on_channel_duration;
1590
1591 u8 max_num_pmkids;
1592
1593 u32 available_antennas_tx;
1594 u32 available_antennas_rx;
1595
1596 /* If multiple wiphys are registered and you're handed e.g.
1597 * a regular netdev with assigned ieee80211_ptr, you won't
1598 * know whether it points to a wiphy your driver has registered
1599 * or not. Assign this to something global to your driver to
1600 * help determine whether you own this wiphy or not. */
1601 const void *privid;
1602
1603 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1604
1605 /* Lets us get back the wiphy on the callback */
1606 int (*reg_notifier)(struct wiphy *wiphy,
1607 struct regulatory_request *request);
1608
1609 /* fields below are read-only, assigned by cfg80211 */
1610
1611 const struct ieee80211_regdomain *regd;
1612
1613 /* the item in /sys/class/ieee80211/ points to this,
1614 * you need use set_wiphy_dev() (see below) */
1615 struct device dev;
1616
1617 /* dir in debugfs: ieee80211/<wiphyname> */
1618 struct dentry *debugfsdir;
1619
1620 #ifdef CONFIG_NET_NS
1621 /* the network namespace this phy lives in currently */
1622 struct net *_net;
1623 #endif
1624
1625 #ifdef CONFIG_CFG80211_WEXT
1626 const struct iw_handler_def *wext;
1627 #endif
1628
1629 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1630 };
1631
1632 static inline struct net *wiphy_net(struct wiphy *wiphy)
1633 {
1634 return read_pnet(&wiphy->_net);
1635 }
1636
1637 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
1638 {
1639 write_pnet(&wiphy->_net, net);
1640 }
1641
1642 /**
1643 * wiphy_priv - return priv from wiphy
1644 *
1645 * @wiphy: the wiphy whose priv pointer to return
1646 */
1647 static inline void *wiphy_priv(struct wiphy *wiphy)
1648 {
1649 BUG_ON(!wiphy);
1650 return &wiphy->priv;
1651 }
1652
1653 /**
1654 * priv_to_wiphy - return the wiphy containing the priv
1655 *
1656 * @priv: a pointer previously returned by wiphy_priv
1657 */
1658 static inline struct wiphy *priv_to_wiphy(void *priv)
1659 {
1660 BUG_ON(!priv);
1661 return container_of(priv, struct wiphy, priv);
1662 }
1663
1664 /**
1665 * set_wiphy_dev - set device pointer for wiphy
1666 *
1667 * @wiphy: The wiphy whose device to bind
1668 * @dev: The device to parent it to
1669 */
1670 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1671 {
1672 wiphy->dev.parent = dev;
1673 }
1674
1675 /**
1676 * wiphy_dev - get wiphy dev pointer
1677 *
1678 * @wiphy: The wiphy whose device struct to look up
1679 */
1680 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1681 {
1682 return wiphy->dev.parent;
1683 }
1684
1685 /**
1686 * wiphy_name - get wiphy name
1687 *
1688 * @wiphy: The wiphy whose name to return
1689 */
1690 static inline const char *wiphy_name(const struct wiphy *wiphy)
1691 {
1692 return dev_name(&wiphy->dev);
1693 }
1694
1695 /**
1696 * wiphy_new - create a new wiphy for use with cfg80211
1697 *
1698 * @ops: The configuration operations for this device
1699 * @sizeof_priv: The size of the private area to allocate
1700 *
1701 * Create a new wiphy and associate the given operations with it.
1702 * @sizeof_priv bytes are allocated for private use.
1703 *
1704 * The returned pointer must be assigned to each netdev's
1705 * ieee80211_ptr for proper operation.
1706 */
1707 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
1708
1709 /**
1710 * wiphy_register - register a wiphy with cfg80211
1711 *
1712 * @wiphy: The wiphy to register.
1713 *
1714 * Returns a non-negative wiphy index or a negative error code.
1715 */
1716 extern int wiphy_register(struct wiphy *wiphy);
1717
1718 /**
1719 * wiphy_unregister - deregister a wiphy from cfg80211
1720 *
1721 * @wiphy: The wiphy to unregister.
1722 *
1723 * After this call, no more requests can be made with this priv
1724 * pointer, but the call may sleep to wait for an outstanding
1725 * request that is being handled.
1726 */
1727 extern void wiphy_unregister(struct wiphy *wiphy);
1728
1729 /**
1730 * wiphy_free - free wiphy
1731 *
1732 * @wiphy: The wiphy to free
1733 */
1734 extern void wiphy_free(struct wiphy *wiphy);
1735
1736 /* internal structs */
1737 struct cfg80211_conn;
1738 struct cfg80211_internal_bss;
1739 struct cfg80211_cached_keys;
1740
1741 #define MAX_AUTH_BSSES 4
1742
1743 /**
1744 * struct wireless_dev - wireless per-netdev state
1745 *
1746 * This structure must be allocated by the driver/stack
1747 * that uses the ieee80211_ptr field in struct net_device
1748 * (this is intentional so it can be allocated along with
1749 * the netdev.)
1750 *
1751 * @wiphy: pointer to hardware description
1752 * @iftype: interface type
1753 * @list: (private) Used to collect the interfaces
1754 * @netdev: (private) Used to reference back to the netdev
1755 * @current_bss: (private) Used by the internal configuration code
1756 * @channel: (private) Used by the internal configuration code to track
1757 * user-set AP, monitor and WDS channels for wireless extensions
1758 * @bssid: (private) Used by the internal configuration code
1759 * @ssid: (private) Used by the internal configuration code
1760 * @ssid_len: (private) Used by the internal configuration code
1761 * @mesh_id_len: (private) Used by the internal configuration code
1762 * @mesh_id_up_len: (private) Used by the internal configuration code
1763 * @wext: (private) Used by the internal wireless extensions compat code
1764 * @use_4addr: indicates 4addr mode is used on this interface, must be
1765 * set by driver (if supported) on add_interface BEFORE registering the
1766 * netdev and may otherwise be used by driver read-only, will be update
1767 * by cfg80211 on change_interface
1768 * @mgmt_registrations: list of registrations for management frames
1769 * @mgmt_registrations_lock: lock for the list
1770 * @mtx: mutex used to lock data in this struct
1771 * @cleanup_work: work struct used for cleanup that can't be done directly
1772 */
1773 struct wireless_dev {
1774 struct wiphy *wiphy;
1775 enum nl80211_iftype iftype;
1776
1777 /* the remainder of this struct should be private to cfg80211 */
1778 struct list_head list;
1779 struct net_device *netdev;
1780
1781 struct list_head mgmt_registrations;
1782 spinlock_t mgmt_registrations_lock;
1783
1784 struct mutex mtx;
1785
1786 struct work_struct cleanup_work;
1787
1788 bool use_4addr;
1789
1790 /* currently used for IBSS and SME - might be rearranged later */
1791 u8 ssid[IEEE80211_MAX_SSID_LEN];
1792 u8 ssid_len, mesh_id_len, mesh_id_up_len;
1793 enum {
1794 CFG80211_SME_IDLE,
1795 CFG80211_SME_CONNECTING,
1796 CFG80211_SME_CONNECTED,
1797 } sme_state;
1798 struct cfg80211_conn *conn;
1799 struct cfg80211_cached_keys *connect_keys;
1800
1801 struct list_head event_list;
1802 spinlock_t event_lock;
1803
1804 struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
1805 struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
1806 struct cfg80211_internal_bss *current_bss; /* associated / joined */
1807 struct ieee80211_channel *channel;
1808
1809 bool ps;
1810 int ps_timeout;
1811
1812 #ifdef CONFIG_CFG80211_WEXT
1813 /* wext data */
1814 struct {
1815 struct cfg80211_ibss_params ibss;
1816 struct cfg80211_connect_params connect;
1817 struct cfg80211_cached_keys *keys;
1818 u8 *ie;
1819 size_t ie_len;
1820 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
1821 u8 ssid[IEEE80211_MAX_SSID_LEN];
1822 s8 default_key, default_mgmt_key;
1823 bool prev_bssid_valid;
1824 } wext;
1825 #endif
1826 };
1827
1828 /**
1829 * wdev_priv - return wiphy priv from wireless_dev
1830 *
1831 * @wdev: The wireless device whose wiphy's priv pointer to return
1832 */
1833 static inline void *wdev_priv(struct wireless_dev *wdev)
1834 {
1835 BUG_ON(!wdev);
1836 return wiphy_priv(wdev->wiphy);
1837 }
1838
1839 /**
1840 * DOC: Utility functions
1841 *
1842 * cfg80211 offers a number of utility functions that can be useful.
1843 */
1844
1845 /**
1846 * ieee80211_channel_to_frequency - convert channel number to frequency
1847 * @chan: channel number
1848 * @band: band, necessary due to channel number overlap
1849 */
1850 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
1851
1852 /**
1853 * ieee80211_frequency_to_channel - convert frequency to channel number
1854 * @freq: center frequency
1855 */
1856 extern int ieee80211_frequency_to_channel(int freq);
1857
1858 /*
1859 * Name indirection necessary because the ieee80211 code also has
1860 * a function named "ieee80211_get_channel", so if you include
1861 * cfg80211's header file you get cfg80211's version, if you try
1862 * to include both header files you'll (rightfully!) get a symbol
1863 * clash.
1864 */
1865 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1866 int freq);
1867 /**
1868 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
1869 * @wiphy: the struct wiphy to get the channel for
1870 * @freq: the center frequency of the channel
1871 */
1872 static inline struct ieee80211_channel *
1873 ieee80211_get_channel(struct wiphy *wiphy, int freq)
1874 {
1875 return __ieee80211_get_channel(wiphy, freq);
1876 }
1877
1878 /**
1879 * ieee80211_get_response_rate - get basic rate for a given rate
1880 *
1881 * @sband: the band to look for rates in
1882 * @basic_rates: bitmap of basic rates
1883 * @bitrate: the bitrate for which to find the basic rate
1884 *
1885 * This function returns the basic rate corresponding to a given
1886 * bitrate, that is the next lower bitrate contained in the basic
1887 * rate map, which is, for this function, given as a bitmap of
1888 * indices of rates in the band's bitrate table.
1889 */
1890 struct ieee80211_rate *
1891 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1892 u32 basic_rates, int bitrate);
1893
1894 /*
1895 * Radiotap parsing functions -- for controlled injection support
1896 *
1897 * Implemented in net/wireless/radiotap.c
1898 * Documentation in Documentation/networking/radiotap-headers.txt
1899 */
1900
1901 struct radiotap_align_size {
1902 uint8_t align:4, size:4;
1903 };
1904
1905 struct ieee80211_radiotap_namespace {
1906 const struct radiotap_align_size *align_size;
1907 int n_bits;
1908 uint32_t oui;
1909 uint8_t subns;
1910 };
1911
1912 struct ieee80211_radiotap_vendor_namespaces {
1913 const struct ieee80211_radiotap_namespace *ns;
1914 int n_ns;
1915 };
1916
1917 /**
1918 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
1919 * @this_arg_index: index of current arg, valid after each successful call
1920 * to ieee80211_radiotap_iterator_next()
1921 * @this_arg: pointer to current radiotap arg; it is valid after each
1922 * call to ieee80211_radiotap_iterator_next() but also after
1923 * ieee80211_radiotap_iterator_init() where it will point to
1924 * the beginning of the actual data portion
1925 * @this_arg_size: length of the current arg, for convenience
1926 * @current_namespace: pointer to the current namespace definition
1927 * (or internally %NULL if the current namespace is unknown)
1928 * @is_radiotap_ns: indicates whether the current namespace is the default
1929 * radiotap namespace or not
1930 *
1931 * @_rtheader: pointer to the radiotap header we are walking through
1932 * @_max_length: length of radiotap header in cpu byte ordering
1933 * @_arg_index: next argument index
1934 * @_arg: next argument pointer
1935 * @_next_bitmap: internal pointer to next present u32
1936 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1937 * @_vns: vendor namespace definitions
1938 * @_next_ns_data: beginning of the next namespace's data
1939 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
1940 * next bitmap word
1941 *
1942 * Describes the radiotap parser state. Fields prefixed with an underscore
1943 * must not be used by users of the parser, only by the parser internally.
1944 */
1945
1946 struct ieee80211_radiotap_iterator {
1947 struct ieee80211_radiotap_header *_rtheader;
1948 const struct ieee80211_radiotap_vendor_namespaces *_vns;
1949 const struct ieee80211_radiotap_namespace *current_namespace;
1950
1951 unsigned char *_arg, *_next_ns_data;
1952 __le32 *_next_bitmap;
1953
1954 unsigned char *this_arg;
1955 int this_arg_index;
1956 int this_arg_size;
1957
1958 int is_radiotap_ns;
1959
1960 int _max_length;
1961 int _arg_index;
1962 uint32_t _bitmap_shifter;
1963 int _reset_on_ext;
1964 };
1965
1966 extern int ieee80211_radiotap_iterator_init(
1967 struct ieee80211_radiotap_iterator *iterator,
1968 struct ieee80211_radiotap_header *radiotap_header,
1969 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
1970
1971 extern int ieee80211_radiotap_iterator_next(
1972 struct ieee80211_radiotap_iterator *iterator);
1973
1974
1975 extern const unsigned char rfc1042_header[6];
1976 extern const unsigned char bridge_tunnel_header[6];
1977
1978 /**
1979 * ieee80211_get_hdrlen_from_skb - get header length from data
1980 *
1981 * Given an skb with a raw 802.11 header at the data pointer this function
1982 * returns the 802.11 header length in bytes (not including encryption
1983 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1984 * header the function returns 0.
1985 *
1986 * @skb: the frame
1987 */
1988 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1989
1990 /**
1991 * ieee80211_hdrlen - get header length in bytes from frame control
1992 * @fc: frame control field in little-endian format
1993 */
1994 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
1995
1996 /**
1997 * DOC: Data path helpers
1998 *
1999 * In addition to generic utilities, cfg80211 also offers
2000 * functions that help implement the data path for devices
2001 * that do not do the 802.11/802.3 conversion on the device.
2002 */
2003
2004 /**
2005 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2006 * @skb: the 802.11 data frame
2007 * @addr: the device MAC address
2008 * @iftype: the virtual interface type
2009 */
2010 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2011 enum nl80211_iftype iftype);
2012
2013 /**
2014 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2015 * @skb: the 802.3 frame
2016 * @addr: the device MAC address
2017 * @iftype: the virtual interface type
2018 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2019 * @qos: build 802.11 QoS data frame
2020 */
2021 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2022 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2023
2024 /**
2025 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2026 *
2027 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2028 * 802.3 frames. The @list will be empty if the decode fails. The
2029 * @skb is consumed after the function returns.
2030 *
2031 * @skb: The input IEEE 802.11n A-MSDU frame.
2032 * @list: The output list of 802.3 frames. It must be allocated and
2033 * initialized by by the caller.
2034 * @addr: The device MAC address.
2035 * @iftype: The device interface type.
2036 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2037 */
2038 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2039 const u8 *addr, enum nl80211_iftype iftype,
2040 const unsigned int extra_headroom);
2041
2042 /**
2043 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2044 * @skb: the data frame
2045 */
2046 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2047
2048 /**
2049 * cfg80211_find_ie - find information element in data
2050 *
2051 * @eid: element ID
2052 * @ies: data consisting of IEs
2053 * @len: length of data
2054 *
2055 * This function will return %NULL if the element ID could
2056 * not be found or if the element is invalid (claims to be
2057 * longer than the given data), or a pointer to the first byte
2058 * of the requested element, that is the byte containing the
2059 * element ID. There are no checks on the element length
2060 * other than having to fit into the given data.
2061 */
2062 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2063
2064 /**
2065 * DOC: Regulatory enforcement infrastructure
2066 *
2067 * TODO
2068 */
2069
2070 /**
2071 * regulatory_hint - driver hint to the wireless core a regulatory domain
2072 * @wiphy: the wireless device giving the hint (used only for reporting
2073 * conflicts)
2074 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2075 * should be in. If @rd is set this should be NULL. Note that if you
2076 * set this to NULL you should still set rd->alpha2 to some accepted
2077 * alpha2.
2078 *
2079 * Wireless drivers can use this function to hint to the wireless core
2080 * what it believes should be the current regulatory domain by
2081 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2082 * domain should be in or by providing a completely build regulatory domain.
2083 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2084 * for a regulatory domain structure for the respective country.
2085 *
2086 * The wiphy must have been registered to cfg80211 prior to this call.
2087 * For cfg80211 drivers this means you must first use wiphy_register(),
2088 * for mac80211 drivers you must first use ieee80211_register_hw().
2089 *
2090 * Drivers should check the return value, its possible you can get
2091 * an -ENOMEM.
2092 */
2093 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2094
2095 /**
2096 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2097 * @wiphy: the wireless device we want to process the regulatory domain on
2098 * @regd: the custom regulatory domain to use for this wiphy
2099 *
2100 * Drivers can sometimes have custom regulatory domains which do not apply
2101 * to a specific country. Drivers can use this to apply such custom regulatory
2102 * domains. This routine must be called prior to wiphy registration. The
2103 * custom regulatory domain will be trusted completely and as such previous
2104 * default channel settings will be disregarded. If no rule is found for a
2105 * channel on the regulatory domain the channel will be disabled.
2106 */
2107 extern void wiphy_apply_custom_regulatory(
2108 struct wiphy *wiphy,
2109 const struct ieee80211_regdomain *regd);
2110
2111 /**
2112 * freq_reg_info - get regulatory information for the given frequency
2113 * @wiphy: the wiphy for which we want to process this rule for
2114 * @center_freq: Frequency in KHz for which we want regulatory information for
2115 * @desired_bw_khz: the desired max bandwidth you want to use per
2116 * channel. Note that this is still 20 MHz if you want to use HT40
2117 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2118 * If set to 0 we'll assume you want the standard 20 MHz.
2119 * @reg_rule: the regulatory rule which we have for this frequency
2120 *
2121 * Use this function to get the regulatory rule for a specific frequency on
2122 * a given wireless device. If the device has a specific regulatory domain
2123 * it wants to follow we respect that unless a country IE has been received
2124 * and processed already.
2125 *
2126 * Returns 0 if it was able to find a valid regulatory rule which does
2127 * apply to the given center_freq otherwise it returns non-zero. It will
2128 * also return -ERANGE if we determine the given center_freq does not even have
2129 * a regulatory rule for a frequency range in the center_freq's band. See
2130 * freq_in_rule_band() for our current definition of a band -- this is purely
2131 * subjective and right now its 802.11 specific.
2132 */
2133 extern int freq_reg_info(struct wiphy *wiphy,
2134 u32 center_freq,
2135 u32 desired_bw_khz,
2136 const struct ieee80211_reg_rule **reg_rule);
2137
2138 /*
2139 * Temporary wext handlers & helper functions
2140 *
2141 * In the future cfg80211 will simply assign the entire wext handler
2142 * structure to netdevs it manages, but we're not there yet.
2143 */
2144 int cfg80211_wext_giwname(struct net_device *dev,
2145 struct iw_request_info *info,
2146 char *name, char *extra);
2147 int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
2148 u32 *mode, char *extra);
2149 int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
2150 u32 *mode, char *extra);
2151 int cfg80211_wext_siwscan(struct net_device *dev,
2152 struct iw_request_info *info,
2153 union iwreq_data *wrqu, char *extra);
2154 int cfg80211_wext_giwscan(struct net_device *dev,
2155 struct iw_request_info *info,
2156 struct iw_point *data, char *extra);
2157 int cfg80211_wext_siwmlme(struct net_device *dev,
2158 struct iw_request_info *info,
2159 struct iw_point *data, char *extra);
2160 int cfg80211_wext_giwrange(struct net_device *dev,
2161 struct iw_request_info *info,
2162 struct iw_point *data, char *extra);
2163 int cfg80211_wext_siwgenie(struct net_device *dev,
2164 struct iw_request_info *info,
2165 struct iw_point *data, char *extra);
2166 int cfg80211_wext_siwauth(struct net_device *dev,
2167 struct iw_request_info *info,
2168 struct iw_param *data, char *extra);
2169 int cfg80211_wext_giwauth(struct net_device *dev,
2170 struct iw_request_info *info,
2171 struct iw_param *data, char *extra);
2172
2173 int cfg80211_wext_siwfreq(struct net_device *dev,
2174 struct iw_request_info *info,
2175 struct iw_freq *freq, char *extra);
2176 int cfg80211_wext_giwfreq(struct net_device *dev,
2177 struct iw_request_info *info,
2178 struct iw_freq *freq, char *extra);
2179 int cfg80211_wext_siwessid(struct net_device *dev,
2180 struct iw_request_info *info,
2181 struct iw_point *data, char *ssid);
2182 int cfg80211_wext_giwessid(struct net_device *dev,
2183 struct iw_request_info *info,
2184 struct iw_point *data, char *ssid);
2185 int cfg80211_wext_siwrate(struct net_device *dev,
2186 struct iw_request_info *info,
2187 struct iw_param *rate, char *extra);
2188 int cfg80211_wext_giwrate(struct net_device *dev,
2189 struct iw_request_info *info,
2190 struct iw_param *rate, char *extra);
2191
2192 int cfg80211_wext_siwrts(struct net_device *dev,
2193 struct iw_request_info *info,
2194 struct iw_param *rts, char *extra);
2195 int cfg80211_wext_giwrts(struct net_device *dev,
2196 struct iw_request_info *info,
2197 struct iw_param *rts, char *extra);
2198 int cfg80211_wext_siwfrag(struct net_device *dev,
2199 struct iw_request_info *info,
2200 struct iw_param *frag, char *extra);
2201 int cfg80211_wext_giwfrag(struct net_device *dev,
2202 struct iw_request_info *info,
2203 struct iw_param *frag, char *extra);
2204 int cfg80211_wext_siwretry(struct net_device *dev,
2205 struct iw_request_info *info,
2206 struct iw_param *retry, char *extra);
2207 int cfg80211_wext_giwretry(struct net_device *dev,
2208 struct iw_request_info *info,
2209 struct iw_param *retry, char *extra);
2210 int cfg80211_wext_siwencodeext(struct net_device *dev,
2211 struct iw_request_info *info,
2212 struct iw_point *erq, char *extra);
2213 int cfg80211_wext_siwencode(struct net_device *dev,
2214 struct iw_request_info *info,
2215 struct iw_point *erq, char *keybuf);
2216 int cfg80211_wext_giwencode(struct net_device *dev,
2217 struct iw_request_info *info,
2218 struct iw_point *erq, char *keybuf);
2219 int cfg80211_wext_siwtxpower(struct net_device *dev,
2220 struct iw_request_info *info,
2221 union iwreq_data *data, char *keybuf);
2222 int cfg80211_wext_giwtxpower(struct net_device *dev,
2223 struct iw_request_info *info,
2224 union iwreq_data *data, char *keybuf);
2225 struct iw_statistics *cfg80211_wireless_stats(struct net_device *dev);
2226
2227 int cfg80211_wext_siwpower(struct net_device *dev,
2228 struct iw_request_info *info,
2229 struct iw_param *wrq, char *extra);
2230 int cfg80211_wext_giwpower(struct net_device *dev,
2231 struct iw_request_info *info,
2232 struct iw_param *wrq, char *extra);
2233
2234 int cfg80211_wext_siwap(struct net_device *dev,
2235 struct iw_request_info *info,
2236 struct sockaddr *ap_addr, char *extra);
2237 int cfg80211_wext_giwap(struct net_device *dev,
2238 struct iw_request_info *info,
2239 struct sockaddr *ap_addr, char *extra);
2240
2241 int cfg80211_wext_siwpmksa(struct net_device *dev,
2242 struct iw_request_info *info,
2243 struct iw_point *data, char *extra);
2244
2245 /*
2246 * callbacks for asynchronous cfg80211 methods, notification
2247 * functions and BSS handling helpers
2248 */
2249
2250 /**
2251 * cfg80211_scan_done - notify that scan finished
2252 *
2253 * @request: the corresponding scan request
2254 * @aborted: set to true if the scan was aborted for any reason,
2255 * userspace will be notified of that
2256 */
2257 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2258
2259 /**
2260 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2261 *
2262 * @wiphy: the wiphy reporting the BSS
2263 * @channel: The channel the frame was received on
2264 * @mgmt: the management frame (probe response or beacon)
2265 * @len: length of the management frame
2266 * @signal: the signal strength, type depends on the wiphy's signal_type
2267 * @gfp: context flags
2268 *
2269 * This informs cfg80211 that BSS information was found and
2270 * the BSS should be updated/added.
2271 */
2272 struct cfg80211_bss*
2273 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2274 struct ieee80211_channel *channel,
2275 struct ieee80211_mgmt *mgmt, size_t len,
2276 s32 signal, gfp_t gfp);
2277
2278 /**
2279 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2280 *
2281 * @wiphy: the wiphy reporting the BSS
2282 * @channel: The channel the frame was received on
2283 * @bssid: the BSSID of the BSS
2284 * @timestamp: the TSF timestamp sent by the peer
2285 * @capability: the capability field sent by the peer
2286 * @beacon_interval: the beacon interval announced by the peer
2287 * @ie: additional IEs sent by the peer
2288 * @ielen: length of the additional IEs
2289 * @signal: the signal strength, type depends on the wiphy's signal_type
2290 * @gfp: context flags
2291 *
2292 * This informs cfg80211 that BSS information was found and
2293 * the BSS should be updated/added.
2294 */
2295 struct cfg80211_bss*
2296 cfg80211_inform_bss(struct wiphy *wiphy,
2297 struct ieee80211_channel *channel,
2298 const u8 *bssid,
2299 u64 timestamp, u16 capability, u16 beacon_interval,
2300 const u8 *ie, size_t ielen,
2301 s32 signal, gfp_t gfp);
2302
2303 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2304 struct ieee80211_channel *channel,
2305 const u8 *bssid,
2306 const u8 *ssid, size_t ssid_len,
2307 u16 capa_mask, u16 capa_val);
2308 static inline struct cfg80211_bss *
2309 cfg80211_get_ibss(struct wiphy *wiphy,
2310 struct ieee80211_channel *channel,
2311 const u8 *ssid, size_t ssid_len)
2312 {
2313 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2314 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2315 }
2316
2317 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2318 struct ieee80211_channel *channel,
2319 const u8 *meshid, size_t meshidlen,
2320 const u8 *meshcfg);
2321 void cfg80211_put_bss(struct cfg80211_bss *bss);
2322
2323 /**
2324 * cfg80211_unlink_bss - unlink BSS from internal data structures
2325 * @wiphy: the wiphy
2326 * @bss: the bss to remove
2327 *
2328 * This function removes the given BSS from the internal data structures
2329 * thereby making it no longer show up in scan results etc. Use this
2330 * function when you detect a BSS is gone. Normally BSSes will also time
2331 * out, so it is not necessary to use this function at all.
2332 */
2333 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2334
2335 /**
2336 * cfg80211_send_rx_auth - notification of processed authentication
2337 * @dev: network device
2338 * @buf: authentication frame (header + body)
2339 * @len: length of the frame data
2340 *
2341 * This function is called whenever an authentication has been processed in
2342 * station mode. The driver is required to call either this function or
2343 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2344 * call. This function may sleep.
2345 */
2346 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2347
2348 /**
2349 * cfg80211_send_auth_timeout - notification of timed out authentication
2350 * @dev: network device
2351 * @addr: The MAC address of the device with which the authentication timed out
2352 *
2353 * This function may sleep.
2354 */
2355 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2356
2357 /**
2358 * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
2359 * @dev: network device
2360 * @addr: The MAC address of the device with which the authentication timed out
2361 *
2362 * When a pending authentication had no action yet, the driver may decide
2363 * to not send a deauth frame, but in that case must calls this function
2364 * to tell cfg80211 about this decision. It is only valid to call this
2365 * function within the deauth() callback.
2366 */
2367 void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
2368
2369 /**
2370 * cfg80211_send_rx_assoc - notification of processed association
2371 * @dev: network device
2372 * @buf: (re)association response frame (header + body)
2373 * @len: length of the frame data
2374 *
2375 * This function is called whenever a (re)association response has been
2376 * processed in station mode. The driver is required to call either this
2377 * function or cfg80211_send_assoc_timeout() to indicate the result of
2378 * cfg80211_ops::assoc() call. This function may sleep.
2379 */
2380 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
2381
2382 /**
2383 * cfg80211_send_assoc_timeout - notification of timed out association
2384 * @dev: network device
2385 * @addr: The MAC address of the device with which the association timed out
2386 *
2387 * This function may sleep.
2388 */
2389 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2390
2391 /**
2392 * cfg80211_send_deauth - notification of processed deauthentication
2393 * @dev: network device
2394 * @buf: deauthentication frame (header + body)
2395 * @len: length of the frame data
2396 *
2397 * This function is called whenever deauthentication has been processed in
2398 * station mode. This includes both received deauthentication frames and
2399 * locally generated ones. This function may sleep.
2400 */
2401 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2402
2403 /**
2404 * __cfg80211_send_deauth - notification of processed deauthentication
2405 * @dev: network device
2406 * @buf: deauthentication frame (header + body)
2407 * @len: length of the frame data
2408 *
2409 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2410 */
2411 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2412
2413 /**
2414 * cfg80211_send_disassoc - notification of processed disassociation
2415 * @dev: network device
2416 * @buf: disassociation response frame (header + body)
2417 * @len: length of the frame data
2418 *
2419 * This function is called whenever disassociation has been processed in
2420 * station mode. This includes both received disassociation frames and locally
2421 * generated ones. This function may sleep.
2422 */
2423 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2424
2425 /**
2426 * __cfg80211_send_disassoc - notification of processed disassociation
2427 * @dev: network device
2428 * @buf: disassociation response frame (header + body)
2429 * @len: length of the frame data
2430 *
2431 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2432 */
2433 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2434 size_t len);
2435
2436 /**
2437 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2438 * @dev: network device
2439 * @buf: deauthentication frame (header + body)
2440 * @len: length of the frame data
2441 *
2442 * This function is called whenever a received Deauthentication frame has been
2443 * dropped in station mode because of MFP being used but the Deauthentication
2444 * frame was not protected. This function may sleep.
2445 */
2446 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
2447 size_t len);
2448
2449 /**
2450 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2451 * @dev: network device
2452 * @buf: disassociation frame (header + body)
2453 * @len: length of the frame data
2454 *
2455 * This function is called whenever a received Disassociation frame has been
2456 * dropped in station mode because of MFP being used but the Disassociation
2457 * frame was not protected. This function may sleep.
2458 */
2459 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
2460 size_t len);
2461
2462 /**
2463 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2464 * @dev: network device
2465 * @addr: The source MAC address of the frame
2466 * @key_type: The key type that the received frame used
2467 * @key_id: Key identifier (0..3)
2468 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2469 * @gfp: allocation flags
2470 *
2471 * This function is called whenever the local MAC detects a MIC failure in a
2472 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2473 * primitive.
2474 */
2475 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2476 enum nl80211_key_type key_type, int key_id,
2477 const u8 *tsc, gfp_t gfp);
2478
2479 /**
2480 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2481 *
2482 * @dev: network device
2483 * @bssid: the BSSID of the IBSS joined
2484 * @gfp: allocation flags
2485 *
2486 * This function notifies cfg80211 that the device joined an IBSS or
2487 * switched to a different BSSID. Before this function can be called,
2488 * either a beacon has to have been received from the IBSS, or one of
2489 * the cfg80211_inform_bss{,_frame} functions must have been called
2490 * with the locally generated beacon -- this guarantees that there is
2491 * always a scan result for this IBSS. cfg80211 will handle the rest.
2492 */
2493 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2494
2495 /**
2496 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
2497 *
2498 * @dev: network device
2499 * @macaddr: the MAC address of the new candidate
2500 * @ie: information elements advertised by the peer candidate
2501 * @ie_len: lenght of the information elements buffer
2502 * @gfp: allocation flags
2503 *
2504 * This function notifies cfg80211 that the mesh peer candidate has been
2505 * detected, most likely via a beacon or, less likely, via a probe response.
2506 * cfg80211 then sends a notification to userspace.
2507 */
2508 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
2509 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
2510
2511 /**
2512 * DOC: RFkill integration
2513 *
2514 * RFkill integration in cfg80211 is almost invisible to drivers,
2515 * as cfg80211 automatically registers an rfkill instance for each
2516 * wireless device it knows about. Soft kill is also translated
2517 * into disconnecting and turning all interfaces off, drivers are
2518 * expected to turn off the device when all interfaces are down.
2519 *
2520 * However, devices may have a hard RFkill line, in which case they
2521 * also need to interact with the rfkill subsystem, via cfg80211.
2522 * They can do this with a few helper functions documented here.
2523 */
2524
2525 /**
2526 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2527 * @wiphy: the wiphy
2528 * @blocked: block status
2529 */
2530 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2531
2532 /**
2533 * wiphy_rfkill_start_polling - start polling rfkill
2534 * @wiphy: the wiphy
2535 */
2536 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2537
2538 /**
2539 * wiphy_rfkill_stop_polling - stop polling rfkill
2540 * @wiphy: the wiphy
2541 */
2542 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2543
2544 #ifdef CONFIG_NL80211_TESTMODE
2545 /**
2546 * DOC: Test mode
2547 *
2548 * Test mode is a set of utility functions to allow drivers to
2549 * interact with driver-specific tools to aid, for instance,
2550 * factory programming.
2551 *
2552 * This chapter describes how drivers interact with it, for more
2553 * information see the nl80211 book's chapter on it.
2554 */
2555
2556 /**
2557 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2558 * @wiphy: the wiphy
2559 * @approxlen: an upper bound of the length of the data that will
2560 * be put into the skb
2561 *
2562 * This function allocates and pre-fills an skb for a reply to
2563 * the testmode command. Since it is intended for a reply, calling
2564 * it outside of the @testmode_cmd operation is invalid.
2565 *
2566 * The returned skb (or %NULL if any errors happen) is pre-filled
2567 * with the wiphy index and set up in a way that any data that is
2568 * put into the skb (with skb_put(), nla_put() or similar) will end
2569 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2570 * needs to be done with the skb is adding data for the corresponding
2571 * userspace tool which can then read that data out of the testdata
2572 * attribute. You must not modify the skb in any other way.
2573 *
2574 * When done, call cfg80211_testmode_reply() with the skb and return
2575 * its error code as the result of the @testmode_cmd operation.
2576 */
2577 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
2578 int approxlen);
2579
2580 /**
2581 * cfg80211_testmode_reply - send the reply skb
2582 * @skb: The skb, must have been allocated with
2583 * cfg80211_testmode_alloc_reply_skb()
2584 *
2585 * Returns an error code or 0 on success, since calling this
2586 * function will usually be the last thing before returning
2587 * from the @testmode_cmd you should return the error code.
2588 * Note that this function consumes the skb regardless of the
2589 * return value.
2590 */
2591 int cfg80211_testmode_reply(struct sk_buff *skb);
2592
2593 /**
2594 * cfg80211_testmode_alloc_event_skb - allocate testmode event
2595 * @wiphy: the wiphy
2596 * @approxlen: an upper bound of the length of the data that will
2597 * be put into the skb
2598 * @gfp: allocation flags
2599 *
2600 * This function allocates and pre-fills an skb for an event on the
2601 * testmode multicast group.
2602 *
2603 * The returned skb (or %NULL if any errors happen) is set up in the
2604 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2605 * for an event. As there, you should simply add data to it that will
2606 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2607 * not modify the skb in any other way.
2608 *
2609 * When done filling the skb, call cfg80211_testmode_event() with the
2610 * skb to send the event.
2611 */
2612 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
2613 int approxlen, gfp_t gfp);
2614
2615 /**
2616 * cfg80211_testmode_event - send the event
2617 * @skb: The skb, must have been allocated with
2618 * cfg80211_testmode_alloc_event_skb()
2619 * @gfp: allocation flags
2620 *
2621 * This function sends the given @skb, which must have been allocated
2622 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
2623 * consumes it.
2624 */
2625 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
2626
2627 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
2628 #else
2629 #define CFG80211_TESTMODE_CMD(cmd)
2630 #endif
2631
2632 /**
2633 * cfg80211_connect_result - notify cfg80211 of connection result
2634 *
2635 * @dev: network device
2636 * @bssid: the BSSID of the AP
2637 * @req_ie: association request IEs (maybe be %NULL)
2638 * @req_ie_len: association request IEs length
2639 * @resp_ie: association response IEs (may be %NULL)
2640 * @resp_ie_len: assoc response IEs length
2641 * @status: status code, 0 for successful connection, use
2642 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
2643 * the real status code for failures.
2644 * @gfp: allocation flags
2645 *
2646 * It should be called by the underlying driver whenever connect() has
2647 * succeeded.
2648 */
2649 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
2650 const u8 *req_ie, size_t req_ie_len,
2651 const u8 *resp_ie, size_t resp_ie_len,
2652 u16 status, gfp_t gfp);
2653
2654 /**
2655 * cfg80211_roamed - notify cfg80211 of roaming
2656 *
2657 * @dev: network device
2658 * @bssid: the BSSID of the new AP
2659 * @req_ie: association request IEs (maybe be %NULL)
2660 * @req_ie_len: association request IEs length
2661 * @resp_ie: association response IEs (may be %NULL)
2662 * @resp_ie_len: assoc response IEs length
2663 * @gfp: allocation flags
2664 *
2665 * It should be called by the underlying driver whenever it roamed
2666 * from one AP to another while connected.
2667 */
2668 void cfg80211_roamed(struct net_device *dev, const u8 *bssid,
2669 const u8 *req_ie, size_t req_ie_len,
2670 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
2671
2672 /**
2673 * cfg80211_disconnected - notify cfg80211 that connection was dropped
2674 *
2675 * @dev: network device
2676 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
2677 * @ie_len: length of IEs
2678 * @reason: reason code for the disconnection, set it to 0 if unknown
2679 * @gfp: allocation flags
2680 *
2681 * After it calls this function, the driver should enter an idle state
2682 * and not try to connect to any AP any more.
2683 */
2684 void cfg80211_disconnected(struct net_device *dev, u16 reason,
2685 u8 *ie, size_t ie_len, gfp_t gfp);
2686
2687 /**
2688 * cfg80211_ready_on_channel - notification of remain_on_channel start
2689 * @dev: network device
2690 * @cookie: the request cookie
2691 * @chan: The current channel (from remain_on_channel request)
2692 * @channel_type: Channel type
2693 * @duration: Duration in milliseconds that the driver intents to remain on the
2694 * channel
2695 * @gfp: allocation flags
2696 */
2697 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
2698 struct ieee80211_channel *chan,
2699 enum nl80211_channel_type channel_type,
2700 unsigned int duration, gfp_t gfp);
2701
2702 /**
2703 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
2704 * @dev: network device
2705 * @cookie: the request cookie
2706 * @chan: The current channel (from remain_on_channel request)
2707 * @channel_type: Channel type
2708 * @gfp: allocation flags
2709 */
2710 void cfg80211_remain_on_channel_expired(struct net_device *dev,
2711 u64 cookie,
2712 struct ieee80211_channel *chan,
2713 enum nl80211_channel_type channel_type,
2714 gfp_t gfp);
2715
2716
2717 /**
2718 * cfg80211_new_sta - notify userspace about station
2719 *
2720 * @dev: the netdev
2721 * @mac_addr: the station's address
2722 * @sinfo: the station information
2723 * @gfp: allocation flags
2724 */
2725 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
2726 struct station_info *sinfo, gfp_t gfp);
2727
2728 /**
2729 * cfg80211_del_sta - notify userspace about deletion of a station
2730 *
2731 * @dev: the netdev
2732 * @mac_addr: the station's address
2733 * @gfp: allocation flags
2734 */
2735 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
2736
2737 /**
2738 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
2739 * @dev: network device
2740 * @freq: Frequency on which the frame was received in MHz
2741 * @buf: Management frame (header + body)
2742 * @len: length of the frame data
2743 * @gfp: context flags
2744 *
2745 * Returns %true if a user space application has registered for this frame.
2746 * For action frames, that makes it responsible for rejecting unrecognized
2747 * action frames; %false otherwise, in which case for action frames the
2748 * driver is responsible for rejecting the frame.
2749 *
2750 * This function is called whenever an Action frame is received for a station
2751 * mode interface, but is not processed in kernel.
2752 */
2753 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, const u8 *buf,
2754 size_t len, gfp_t gfp);
2755
2756 /**
2757 * cfg80211_mgmt_tx_status - notification of TX status for management frame
2758 * @dev: network device
2759 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
2760 * @buf: Management frame (header + body)
2761 * @len: length of the frame data
2762 * @ack: Whether frame was acknowledged
2763 * @gfp: context flags
2764 *
2765 * This function is called whenever a management frame was requested to be
2766 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
2767 * transmission attempt.
2768 */
2769 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
2770 const u8 *buf, size_t len, bool ack, gfp_t gfp);
2771
2772
2773 /**
2774 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
2775 * @dev: network device
2776 * @rssi_event: the triggered RSSI event
2777 * @gfp: context flags
2778 *
2779 * This function is called when a configured connection quality monitoring
2780 * rssi threshold reached event occurs.
2781 */
2782 void cfg80211_cqm_rssi_notify(struct net_device *dev,
2783 enum nl80211_cqm_rssi_threshold_event rssi_event,
2784 gfp_t gfp);
2785
2786 /**
2787 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
2788 * @dev: network device
2789 * @peer: peer's MAC address
2790 * @num_packets: how many packets were lost -- should be a fixed threshold
2791 * but probably no less than maybe 50, or maybe a throughput dependent
2792 * threshold (to account for temporary interference)
2793 * @gfp: context flags
2794 */
2795 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
2796 const u8 *peer, u32 num_packets, gfp_t gfp);
2797
2798 /* Logging, debugging and troubleshooting/diagnostic helpers. */
2799
2800 /* wiphy_printk helpers, similar to dev_printk */
2801
2802 #define wiphy_printk(level, wiphy, format, args...) \
2803 dev_printk(level, &(wiphy)->dev, format, ##args)
2804 #define wiphy_emerg(wiphy, format, args...) \
2805 dev_emerg(&(wiphy)->dev, format, ##args)
2806 #define wiphy_alert(wiphy, format, args...) \
2807 dev_alert(&(wiphy)->dev, format, ##args)
2808 #define wiphy_crit(wiphy, format, args...) \
2809 dev_crit(&(wiphy)->dev, format, ##args)
2810 #define wiphy_err(wiphy, format, args...) \
2811 dev_err(&(wiphy)->dev, format, ##args)
2812 #define wiphy_warn(wiphy, format, args...) \
2813 dev_warn(&(wiphy)->dev, format, ##args)
2814 #define wiphy_notice(wiphy, format, args...) \
2815 dev_notice(&(wiphy)->dev, format, ##args)
2816 #define wiphy_info(wiphy, format, args...) \
2817 dev_info(&(wiphy)->dev, format, ##args)
2818
2819 #define wiphy_debug(wiphy, format, args...) \
2820 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
2821
2822 #define wiphy_dbg(wiphy, format, args...) \
2823 dev_dbg(&(wiphy)->dev, format, ##args)
2824
2825 #if defined(VERBOSE_DEBUG)
2826 #define wiphy_vdbg wiphy_dbg
2827 #else
2828 #define wiphy_vdbg(wiphy, format, args...) \
2829 ({ \
2830 if (0) \
2831 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
2832 0; \
2833 })
2834 #endif
2835
2836 /*
2837 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
2838 * of using a WARN/WARN_ON to get the message out, including the
2839 * file/line information and a backtrace.
2840 */
2841 #define wiphy_WARN(wiphy, format, args...) \
2842 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
2843
2844 #endif /* __NET_CFG80211_H */
This page took 0.126999 seconds and 5 git commands to generate.