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