]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/net/cfg80211.h
{cfg,nl}80211: mesh power mode primitives and userspace access
[mirror_ubuntu-artful-kernel.git] / include / net / cfg80211.h
1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
3 /*
4 * 802.11 device and configuration interface
5 *
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <net/regulatory.h>
23
24 /**
25 * DOC: Introduction
26 *
27 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
28 * userspace and drivers, and offers some utility functionality associated
29 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
30 * by all modern wireless drivers in Linux, so that they offer a consistent
31 * API through nl80211. For backward compatibility, cfg80211 also offers
32 * wireless extensions to userspace, but hides them from drivers completely.
33 *
34 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
35 * use restrictions.
36 */
37
38
39 /**
40 * DOC: Device registration
41 *
42 * In order for a driver to use cfg80211, it must register the hardware device
43 * with cfg80211. This happens through a number of hardware capability structs
44 * described below.
45 *
46 * The fundamental structure for each device is the 'wiphy', of which each
47 * instance describes a physical wireless device connected to the system. Each
48 * such wiphy can have zero, one, or many virtual interfaces associated with
49 * it, which need to be identified as such by pointing the network interface's
50 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
51 * the wireless part of the interface, normally this struct is embedded in the
52 * network interface's private data area. Drivers can optionally allow creating
53 * or destroying virtual interfaces on the fly, but without at least one or the
54 * ability to create some the wireless device isn't useful.
55 *
56 * Each wiphy structure contains device capability information, and also has
57 * a pointer to the various operations the driver offers. The definitions and
58 * structures here describe these capabilities in detail.
59 */
60
61 struct wiphy;
62
63 /*
64 * wireless hardware capability structures
65 */
66
67 /**
68 * enum ieee80211_band - supported frequency bands
69 *
70 * The bands are assigned this way because the supported
71 * bitrates differ in these bands.
72 *
73 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
74 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
75 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
76 * @IEEE80211_NUM_BANDS: number of defined bands
77 */
78 enum ieee80211_band {
79 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
80 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
81 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
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 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
102 */
103 enum ieee80211_channel_flags {
104 IEEE80211_CHAN_DISABLED = 1<<0,
105 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
106 IEEE80211_CHAN_NO_IBSS = 1<<2,
107 IEEE80211_CHAN_RADAR = 1<<3,
108 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
109 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
110 IEEE80211_CHAN_NO_OFDM = 1<<6,
111 };
112
113 #define IEEE80211_CHAN_NO_HT40 \
114 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
115
116 /**
117 * struct ieee80211_channel - channel definition
118 *
119 * This structure describes a single channel for use
120 * with cfg80211.
121 *
122 * @center_freq: center frequency in MHz
123 * @hw_value: hardware-specific value for the channel
124 * @flags: channel flags from &enum ieee80211_channel_flags.
125 * @orig_flags: channel flags at registration time, used by regulatory
126 * code to support devices with additional restrictions
127 * @band: band this channel belongs to.
128 * @max_antenna_gain: maximum antenna gain in dBi
129 * @max_power: maximum transmission power (in dBm)
130 * @max_reg_power: maximum regulatory transmission power (in dBm)
131 * @beacon_found: helper to regulatory code to indicate when a beacon
132 * has been found on this channel. Use regulatory_hint_found_beacon()
133 * to enable this, this is useful only on 5 GHz band.
134 * @orig_mag: internal use
135 * @orig_mpwr: internal use
136 */
137 struct ieee80211_channel {
138 enum ieee80211_band band;
139 u16 center_freq;
140 u16 hw_value;
141 u32 flags;
142 int max_antenna_gain;
143 int max_power;
144 int max_reg_power;
145 bool beacon_found;
146 u32 orig_flags;
147 int orig_mag, orig_mpwr;
148 };
149
150 /**
151 * enum ieee80211_rate_flags - rate flags
152 *
153 * Hardware/specification flags for rates. These are structured
154 * in a way that allows using the same bitrate structure for
155 * different bands/PHY modes.
156 *
157 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
158 * preamble on this bitrate; only relevant in 2.4GHz band and
159 * with CCK rates.
160 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
161 * when used with 802.11a (on the 5 GHz band); filled by the
162 * core code when registering the wiphy.
163 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
164 * when used with 802.11b (on the 2.4 GHz band); filled by the
165 * core code when registering the wiphy.
166 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
167 * when used with 802.11g (on the 2.4 GHz band); filled by the
168 * core code when registering the wiphy.
169 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
170 */
171 enum ieee80211_rate_flags {
172 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
173 IEEE80211_RATE_MANDATORY_A = 1<<1,
174 IEEE80211_RATE_MANDATORY_B = 1<<2,
175 IEEE80211_RATE_MANDATORY_G = 1<<3,
176 IEEE80211_RATE_ERP_G = 1<<4,
177 };
178
179 /**
180 * struct ieee80211_rate - bitrate definition
181 *
182 * This structure describes a bitrate that an 802.11 PHY can
183 * operate with. The two values @hw_value and @hw_value_short
184 * are only for driver use when pointers to this structure are
185 * passed around.
186 *
187 * @flags: rate-specific flags
188 * @bitrate: bitrate in units of 100 Kbps
189 * @hw_value: driver/hardware value for this rate
190 * @hw_value_short: driver/hardware value for this rate when
191 * short preamble is used
192 */
193 struct ieee80211_rate {
194 u32 flags;
195 u16 bitrate;
196 u16 hw_value, hw_value_short;
197 };
198
199 /**
200 * struct ieee80211_sta_ht_cap - STA's HT capabilities
201 *
202 * This structure describes most essential parameters needed
203 * to describe 802.11n HT capabilities for an STA.
204 *
205 * @ht_supported: is HT supported by the STA
206 * @cap: HT capabilities map as described in 802.11n spec
207 * @ampdu_factor: Maximum A-MPDU length factor
208 * @ampdu_density: Minimum A-MPDU spacing
209 * @mcs: Supported MCS rates
210 */
211 struct ieee80211_sta_ht_cap {
212 u16 cap; /* use IEEE80211_HT_CAP_ */
213 bool ht_supported;
214 u8 ampdu_factor;
215 u8 ampdu_density;
216 struct ieee80211_mcs_info mcs;
217 };
218
219 /**
220 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
221 *
222 * This structure describes most essential parameters needed
223 * to describe 802.11ac VHT capabilities for an STA.
224 *
225 * @vht_supported: is VHT supported by the STA
226 * @cap: VHT capabilities map as described in 802.11ac spec
227 * @vht_mcs: Supported VHT MCS rates
228 */
229 struct ieee80211_sta_vht_cap {
230 bool vht_supported;
231 u32 cap; /* use IEEE80211_VHT_CAP_ */
232 struct ieee80211_vht_mcs_info vht_mcs;
233 };
234
235 /**
236 * struct ieee80211_supported_band - frequency band definition
237 *
238 * This structure describes a frequency band a wiphy
239 * is able to operate in.
240 *
241 * @channels: Array of channels the hardware can operate in
242 * in this band.
243 * @band: the band this structure represents
244 * @n_channels: Number of channels in @channels
245 * @bitrates: Array of bitrates the hardware can operate with
246 * in this band. Must be sorted to give a valid "supported
247 * rates" IE, i.e. CCK rates first, then OFDM.
248 * @n_bitrates: Number of bitrates in @bitrates
249 * @ht_cap: HT capabilities in this band
250 * @vht_cap: VHT capabilities in this band
251 */
252 struct ieee80211_supported_band {
253 struct ieee80211_channel *channels;
254 struct ieee80211_rate *bitrates;
255 enum ieee80211_band band;
256 int n_channels;
257 int n_bitrates;
258 struct ieee80211_sta_ht_cap ht_cap;
259 struct ieee80211_sta_vht_cap vht_cap;
260 };
261
262 /*
263 * Wireless hardware/device configuration structures and methods
264 */
265
266 /**
267 * DOC: Actions and configuration
268 *
269 * Each wireless device and each virtual interface offer a set of configuration
270 * operations and other actions that are invoked by userspace. Each of these
271 * actions is described in the operations structure, and the parameters these
272 * operations use are described separately.
273 *
274 * Additionally, some operations are asynchronous and expect to get status
275 * information via some functions that drivers need to call.
276 *
277 * Scanning and BSS list handling with its associated functionality is described
278 * in a separate chapter.
279 */
280
281 /**
282 * struct vif_params - describes virtual interface parameters
283 * @use_4addr: use 4-address frames
284 */
285 struct vif_params {
286 int use_4addr;
287 };
288
289 /**
290 * struct key_params - key information
291 *
292 * Information about a key
293 *
294 * @key: key material
295 * @key_len: length of key material
296 * @cipher: cipher suite selector
297 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
298 * with the get_key() callback, must be in little endian,
299 * length given by @seq_len.
300 * @seq_len: length of @seq.
301 */
302 struct key_params {
303 u8 *key;
304 u8 *seq;
305 int key_len;
306 int seq_len;
307 u32 cipher;
308 };
309
310 /**
311 * struct cfg80211_chan_def - channel definition
312 * @chan: the (control) channel
313 * @width: channel width
314 * @center_freq1: center frequency of first segment
315 * @center_freq2: center frequency of second segment
316 * (only with 80+80 MHz)
317 */
318 struct cfg80211_chan_def {
319 struct ieee80211_channel *chan;
320 enum nl80211_chan_width width;
321 u32 center_freq1;
322 u32 center_freq2;
323 };
324
325 /**
326 * cfg80211_get_chandef_type - return old channel type from chandef
327 * @chandef: the channel definition
328 *
329 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
330 * chandef, which must have a bandwidth allowing this conversion.
331 */
332 static inline enum nl80211_channel_type
333 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
334 {
335 switch (chandef->width) {
336 case NL80211_CHAN_WIDTH_20_NOHT:
337 return NL80211_CHAN_NO_HT;
338 case NL80211_CHAN_WIDTH_20:
339 return NL80211_CHAN_HT20;
340 case NL80211_CHAN_WIDTH_40:
341 if (chandef->center_freq1 > chandef->chan->center_freq)
342 return NL80211_CHAN_HT40PLUS;
343 return NL80211_CHAN_HT40MINUS;
344 default:
345 WARN_ON(1);
346 return NL80211_CHAN_NO_HT;
347 }
348 }
349
350 /**
351 * cfg80211_chandef_create - create channel definition using channel type
352 * @chandef: the channel definition struct to fill
353 * @channel: the control channel
354 * @chantype: the channel type
355 *
356 * Given a channel type, create a channel definition.
357 */
358 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
359 struct ieee80211_channel *channel,
360 enum nl80211_channel_type chantype);
361
362 /**
363 * cfg80211_chandef_identical - check if two channel definitions are identical
364 * @chandef1: first channel definition
365 * @chandef2: second channel definition
366 *
367 * Return: %true if the channels defined by the channel definitions are
368 * identical, %false otherwise.
369 */
370 static inline bool
371 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
372 const struct cfg80211_chan_def *chandef2)
373 {
374 return (chandef1->chan == chandef2->chan &&
375 chandef1->width == chandef2->width &&
376 chandef1->center_freq1 == chandef2->center_freq1 &&
377 chandef1->center_freq2 == chandef2->center_freq2);
378 }
379
380 /**
381 * cfg80211_chandef_compatible - check if two channel definitions are compatible
382 * @chandef1: first channel definition
383 * @chandef2: second channel definition
384 *
385 * Return: %NULL if the given channel definitions are incompatible,
386 * chandef1 or chandef2 otherwise.
387 */
388 const struct cfg80211_chan_def *
389 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
390 const struct cfg80211_chan_def *chandef2);
391
392 /**
393 * cfg80211_chandef_valid - check if a channel definition is valid
394 * @chandef: the channel definition to check
395 * Return: %true if the channel definition is valid. %false otherwise.
396 */
397 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
398
399 /**
400 * cfg80211_chandef_usable - check if secondary channels can be used
401 * @wiphy: the wiphy to validate against
402 * @chandef: the channel definition to check
403 * @prohibited_flags: the regulatory channel flags that must not be set
404 * Return: %true if secondary channels are usable. %false otherwise.
405 */
406 bool cfg80211_chandef_usable(struct wiphy *wiphy,
407 const struct cfg80211_chan_def *chandef,
408 u32 prohibited_flags);
409
410 /**
411 * enum survey_info_flags - survey information flags
412 *
413 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
414 * @SURVEY_INFO_IN_USE: channel is currently being used
415 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
416 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
417 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
418 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
419 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
420 *
421 * Used by the driver to indicate which info in &struct survey_info
422 * it has filled in during the get_survey().
423 */
424 enum survey_info_flags {
425 SURVEY_INFO_NOISE_DBM = 1<<0,
426 SURVEY_INFO_IN_USE = 1<<1,
427 SURVEY_INFO_CHANNEL_TIME = 1<<2,
428 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
429 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
430 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
431 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
432 };
433
434 /**
435 * struct survey_info - channel survey response
436 *
437 * @channel: the channel this survey record reports, mandatory
438 * @filled: bitflag of flags from &enum survey_info_flags
439 * @noise: channel noise in dBm. This and all following fields are
440 * optional
441 * @channel_time: amount of time in ms the radio spent on the channel
442 * @channel_time_busy: amount of time the primary channel was sensed busy
443 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
444 * @channel_time_rx: amount of time the radio spent receiving data
445 * @channel_time_tx: amount of time the radio spent transmitting data
446 *
447 * Used by dump_survey() to report back per-channel survey information.
448 *
449 * This structure can later be expanded with things like
450 * channel duty cycle etc.
451 */
452 struct survey_info {
453 struct ieee80211_channel *channel;
454 u64 channel_time;
455 u64 channel_time_busy;
456 u64 channel_time_ext_busy;
457 u64 channel_time_rx;
458 u64 channel_time_tx;
459 u32 filled;
460 s8 noise;
461 };
462
463 /**
464 * struct cfg80211_crypto_settings - Crypto settings
465 * @wpa_versions: indicates which, if any, WPA versions are enabled
466 * (from enum nl80211_wpa_versions)
467 * @cipher_group: group key cipher suite (or 0 if unset)
468 * @n_ciphers_pairwise: number of AP supported unicast ciphers
469 * @ciphers_pairwise: unicast key cipher suites
470 * @n_akm_suites: number of AKM suites
471 * @akm_suites: AKM suites
472 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
473 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
474 * required to assume that the port is unauthorized until authorized by
475 * user space. Otherwise, port is marked authorized by default.
476 * @control_port_ethertype: the control port protocol that should be
477 * allowed through even on unauthorized ports
478 * @control_port_no_encrypt: TRUE to prevent encryption of control port
479 * protocol frames.
480 */
481 struct cfg80211_crypto_settings {
482 u32 wpa_versions;
483 u32 cipher_group;
484 int n_ciphers_pairwise;
485 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
486 int n_akm_suites;
487 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
488 bool control_port;
489 __be16 control_port_ethertype;
490 bool control_port_no_encrypt;
491 };
492
493 /**
494 * struct cfg80211_beacon_data - beacon data
495 * @head: head portion of beacon (before TIM IE)
496 * or %NULL if not changed
497 * @tail: tail portion of beacon (after TIM IE)
498 * or %NULL if not changed
499 * @head_len: length of @head
500 * @tail_len: length of @tail
501 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
502 * @beacon_ies_len: length of beacon_ies in octets
503 * @proberesp_ies: extra information element(s) to add into Probe Response
504 * frames or %NULL
505 * @proberesp_ies_len: length of proberesp_ies in octets
506 * @assocresp_ies: extra information element(s) to add into (Re)Association
507 * Response frames or %NULL
508 * @assocresp_ies_len: length of assocresp_ies in octets
509 * @probe_resp_len: length of probe response template (@probe_resp)
510 * @probe_resp: probe response template (AP mode only)
511 */
512 struct cfg80211_beacon_data {
513 const u8 *head, *tail;
514 const u8 *beacon_ies;
515 const u8 *proberesp_ies;
516 const u8 *assocresp_ies;
517 const u8 *probe_resp;
518
519 size_t head_len, tail_len;
520 size_t beacon_ies_len;
521 size_t proberesp_ies_len;
522 size_t assocresp_ies_len;
523 size_t probe_resp_len;
524 };
525
526 /**
527 * struct cfg80211_ap_settings - AP configuration
528 *
529 * Used to configure an AP interface.
530 *
531 * @chandef: defines the channel to use
532 * @beacon: beacon data
533 * @beacon_interval: beacon interval
534 * @dtim_period: DTIM period
535 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
536 * user space)
537 * @ssid_len: length of @ssid
538 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
539 * @crypto: crypto settings
540 * @privacy: the BSS uses privacy
541 * @auth_type: Authentication type (algorithm)
542 * @inactivity_timeout: time in seconds to determine station's inactivity.
543 * @p2p_ctwindow: P2P CT Window
544 * @p2p_opp_ps: P2P opportunistic PS
545 */
546 struct cfg80211_ap_settings {
547 struct cfg80211_chan_def chandef;
548
549 struct cfg80211_beacon_data beacon;
550
551 int beacon_interval, dtim_period;
552 const u8 *ssid;
553 size_t ssid_len;
554 enum nl80211_hidden_ssid hidden_ssid;
555 struct cfg80211_crypto_settings crypto;
556 bool privacy;
557 enum nl80211_auth_type auth_type;
558 int inactivity_timeout;
559 u8 p2p_ctwindow;
560 bool p2p_opp_ps;
561 };
562
563 /**
564 * enum plink_action - actions to perform in mesh peers
565 *
566 * @PLINK_ACTION_INVALID: action 0 is reserved
567 * @PLINK_ACTION_OPEN: start mesh peer link establishment
568 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
569 */
570 enum plink_actions {
571 PLINK_ACTION_INVALID,
572 PLINK_ACTION_OPEN,
573 PLINK_ACTION_BLOCK,
574 };
575
576 /**
577 * enum station_parameters_apply_mask - station parameter values to apply
578 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
579 *
580 * Not all station parameters have in-band "no change" signalling,
581 * for those that don't these flags will are used.
582 */
583 enum station_parameters_apply_mask {
584 STATION_PARAM_APPLY_UAPSD = BIT(0),
585 };
586
587 /**
588 * struct station_parameters - station parameters
589 *
590 * Used to change and create a new station.
591 *
592 * @vlan: vlan interface station should belong to
593 * @supported_rates: supported rates in IEEE 802.11 format
594 * (or NULL for no change)
595 * @supported_rates_len: number of supported rates
596 * @sta_flags_mask: station flags that changed
597 * (bitmask of BIT(NL80211_STA_FLAG_...))
598 * @sta_flags_set: station flags values
599 * (bitmask of BIT(NL80211_STA_FLAG_...))
600 * @listen_interval: listen interval or -1 for no change
601 * @aid: AID or zero for no change
602 * @plink_action: plink action to take
603 * @plink_state: set the peer link state for a station
604 * @ht_capa: HT capabilities of station
605 * @vht_capa: VHT capabilities of station
606 * @uapsd_queues: bitmap of queues configured for uapsd. same format
607 * as the AC bitmap in the QoS info field
608 * @max_sp: max Service Period. same format as the MAX_SP in the
609 * QoS info field (but already shifted down)
610 * @sta_modify_mask: bitmap indicating which parameters changed
611 * (for those that don't have a natural "no change" value),
612 * see &enum station_parameters_apply_mask
613 * @local_pm: local link-specific mesh power save mode (no change when set
614 * to unknown)
615 */
616 struct station_parameters {
617 u8 *supported_rates;
618 struct net_device *vlan;
619 u32 sta_flags_mask, sta_flags_set;
620 u32 sta_modify_mask;
621 int listen_interval;
622 u16 aid;
623 u8 supported_rates_len;
624 u8 plink_action;
625 u8 plink_state;
626 struct ieee80211_ht_cap *ht_capa;
627 struct ieee80211_vht_cap *vht_capa;
628 u8 uapsd_queues;
629 u8 max_sp;
630 enum nl80211_mesh_power_mode local_pm;
631 };
632
633 /**
634 * enum station_info_flags - station information flags
635 *
636 * Used by the driver to indicate which info in &struct station_info
637 * it has filled in during get_station() or dump_station().
638 *
639 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
640 * @STATION_INFO_RX_BYTES: @rx_bytes filled
641 * @STATION_INFO_TX_BYTES: @tx_bytes filled
642 * @STATION_INFO_LLID: @llid filled
643 * @STATION_INFO_PLID: @plid filled
644 * @STATION_INFO_PLINK_STATE: @plink_state filled
645 * @STATION_INFO_SIGNAL: @signal filled
646 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
647 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
648 * @STATION_INFO_RX_PACKETS: @rx_packets filled
649 * @STATION_INFO_TX_PACKETS: @tx_packets filled
650 * @STATION_INFO_TX_RETRIES: @tx_retries filled
651 * @STATION_INFO_TX_FAILED: @tx_failed filled
652 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
653 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
654 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
655 * @STATION_INFO_BSS_PARAM: @bss_param filled
656 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
657 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
658 * @STATION_INFO_STA_FLAGS: @sta_flags filled
659 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
660 * @STATION_INFO_T_OFFSET: @t_offset filled
661 * @STATION_INFO_LOCAL_PM: @local_pm filled
662 * @STATION_INFO_PEER_PM: @peer_pm filled
663 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
664 */
665 enum station_info_flags {
666 STATION_INFO_INACTIVE_TIME = 1<<0,
667 STATION_INFO_RX_BYTES = 1<<1,
668 STATION_INFO_TX_BYTES = 1<<2,
669 STATION_INFO_LLID = 1<<3,
670 STATION_INFO_PLID = 1<<4,
671 STATION_INFO_PLINK_STATE = 1<<5,
672 STATION_INFO_SIGNAL = 1<<6,
673 STATION_INFO_TX_BITRATE = 1<<7,
674 STATION_INFO_RX_PACKETS = 1<<8,
675 STATION_INFO_TX_PACKETS = 1<<9,
676 STATION_INFO_TX_RETRIES = 1<<10,
677 STATION_INFO_TX_FAILED = 1<<11,
678 STATION_INFO_RX_DROP_MISC = 1<<12,
679 STATION_INFO_SIGNAL_AVG = 1<<13,
680 STATION_INFO_RX_BITRATE = 1<<14,
681 STATION_INFO_BSS_PARAM = 1<<15,
682 STATION_INFO_CONNECTED_TIME = 1<<16,
683 STATION_INFO_ASSOC_REQ_IES = 1<<17,
684 STATION_INFO_STA_FLAGS = 1<<18,
685 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
686 STATION_INFO_T_OFFSET = 1<<20,
687 STATION_INFO_LOCAL_PM = 1<<21,
688 STATION_INFO_PEER_PM = 1<<22,
689 STATION_INFO_NONPEER_PM = 1<<23,
690 };
691
692 /**
693 * enum station_info_rate_flags - bitrate info flags
694 *
695 * Used by the driver to indicate the specific rate transmission
696 * type for 802.11n transmissions.
697 *
698 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
699 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
700 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
701 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
702 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
703 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
704 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
705 * @RATE_INFO_FLAGS_60G: 60GHz MCS
706 */
707 enum rate_info_flags {
708 RATE_INFO_FLAGS_MCS = BIT(0),
709 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
710 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
711 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
712 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
713 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
714 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
715 RATE_INFO_FLAGS_60G = BIT(7),
716 };
717
718 /**
719 * struct rate_info - bitrate information
720 *
721 * Information about a receiving or transmitting bitrate
722 *
723 * @flags: bitflag of flags from &enum rate_info_flags
724 * @mcs: mcs index if struct describes a 802.11n bitrate
725 * @legacy: bitrate in 100kbit/s for 802.11abg
726 * @nss: number of streams (VHT only)
727 */
728 struct rate_info {
729 u8 flags;
730 u8 mcs;
731 u16 legacy;
732 u8 nss;
733 };
734
735 /**
736 * enum station_info_rate_flags - bitrate info flags
737 *
738 * Used by the driver to indicate the specific rate transmission
739 * type for 802.11n transmissions.
740 *
741 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
742 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
743 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
744 */
745 enum bss_param_flags {
746 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
747 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
748 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
749 };
750
751 /**
752 * struct sta_bss_parameters - BSS parameters for the attached station
753 *
754 * Information about the currently associated BSS
755 *
756 * @flags: bitflag of flags from &enum bss_param_flags
757 * @dtim_period: DTIM period for the BSS
758 * @beacon_interval: beacon interval
759 */
760 struct sta_bss_parameters {
761 u8 flags;
762 u8 dtim_period;
763 u16 beacon_interval;
764 };
765
766 /**
767 * struct station_info - station information
768 *
769 * Station information filled by driver for get_station() and dump_station.
770 *
771 * @filled: bitflag of flags from &enum station_info_flags
772 * @connected_time: time(in secs) since a station is last connected
773 * @inactive_time: time since last station activity (tx/rx) in milliseconds
774 * @rx_bytes: bytes received from this station
775 * @tx_bytes: bytes transmitted to this station
776 * @llid: mesh local link id
777 * @plid: mesh peer link id
778 * @plink_state: mesh peer link state
779 * @signal: The signal strength, type depends on the wiphy's signal_type.
780 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
781 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
782 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
783 * @txrate: current unicast bitrate from this station
784 * @rxrate: current unicast bitrate to this station
785 * @rx_packets: packets received from this station
786 * @tx_packets: packets transmitted to this station
787 * @tx_retries: cumulative retry counts
788 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
789 * @rx_dropped_misc: Dropped for un-specified reason.
790 * @bss_param: current BSS parameters
791 * @generation: generation number for nl80211 dumps.
792 * This number should increase every time the list of stations
793 * changes, i.e. when a station is added or removed, so that
794 * userspace can tell whether it got a consistent snapshot.
795 * @assoc_req_ies: IEs from (Re)Association Request.
796 * This is used only when in AP mode with drivers that do not use
797 * user space MLME/SME implementation. The information is provided for
798 * the cfg80211_new_sta() calls to notify user space of the IEs.
799 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
800 * @sta_flags: station flags mask & values
801 * @beacon_loss_count: Number of times beacon loss event has triggered.
802 * @t_offset: Time offset of the station relative to this host.
803 * @local_pm: local mesh STA power save mode
804 * @peer_pm: peer mesh STA power save mode
805 * @nonpeer_pm: non-peer mesh STA power save mode
806 */
807 struct station_info {
808 u32 filled;
809 u32 connected_time;
810 u32 inactive_time;
811 u32 rx_bytes;
812 u32 tx_bytes;
813 u16 llid;
814 u16 plid;
815 u8 plink_state;
816 s8 signal;
817 s8 signal_avg;
818 struct rate_info txrate;
819 struct rate_info rxrate;
820 u32 rx_packets;
821 u32 tx_packets;
822 u32 tx_retries;
823 u32 tx_failed;
824 u32 rx_dropped_misc;
825 struct sta_bss_parameters bss_param;
826 struct nl80211_sta_flag_update sta_flags;
827
828 int generation;
829
830 const u8 *assoc_req_ies;
831 size_t assoc_req_ies_len;
832
833 u32 beacon_loss_count;
834 s64 t_offset;
835 enum nl80211_mesh_power_mode local_pm;
836 enum nl80211_mesh_power_mode peer_pm;
837 enum nl80211_mesh_power_mode nonpeer_pm;
838
839 /*
840 * Note: Add a new enum station_info_flags value for each new field and
841 * use it to check which fields are initialized.
842 */
843 };
844
845 /**
846 * enum monitor_flags - monitor flags
847 *
848 * Monitor interface configuration flags. Note that these must be the bits
849 * according to the nl80211 flags.
850 *
851 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
852 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
853 * @MONITOR_FLAG_CONTROL: pass control frames
854 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
855 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
856 */
857 enum monitor_flags {
858 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
859 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
860 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
861 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
862 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
863 };
864
865 /**
866 * enum mpath_info_flags - mesh path information flags
867 *
868 * Used by the driver to indicate which info in &struct mpath_info it has filled
869 * in during get_station() or dump_station().
870 *
871 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
872 * @MPATH_INFO_SN: @sn filled
873 * @MPATH_INFO_METRIC: @metric filled
874 * @MPATH_INFO_EXPTIME: @exptime filled
875 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
876 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
877 * @MPATH_INFO_FLAGS: @flags filled
878 */
879 enum mpath_info_flags {
880 MPATH_INFO_FRAME_QLEN = BIT(0),
881 MPATH_INFO_SN = BIT(1),
882 MPATH_INFO_METRIC = BIT(2),
883 MPATH_INFO_EXPTIME = BIT(3),
884 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
885 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
886 MPATH_INFO_FLAGS = BIT(6),
887 };
888
889 /**
890 * struct mpath_info - mesh path information
891 *
892 * Mesh path information filled by driver for get_mpath() and dump_mpath().
893 *
894 * @filled: bitfield of flags from &enum mpath_info_flags
895 * @frame_qlen: number of queued frames for this destination
896 * @sn: target sequence number
897 * @metric: metric (cost) of this mesh path
898 * @exptime: expiration time for the mesh path from now, in msecs
899 * @flags: mesh path flags
900 * @discovery_timeout: total mesh path discovery timeout, in msecs
901 * @discovery_retries: mesh path discovery retries
902 * @generation: generation number for nl80211 dumps.
903 * This number should increase every time the list of mesh paths
904 * changes, i.e. when a station is added or removed, so that
905 * userspace can tell whether it got a consistent snapshot.
906 */
907 struct mpath_info {
908 u32 filled;
909 u32 frame_qlen;
910 u32 sn;
911 u32 metric;
912 u32 exptime;
913 u32 discovery_timeout;
914 u8 discovery_retries;
915 u8 flags;
916
917 int generation;
918 };
919
920 /**
921 * struct bss_parameters - BSS parameters
922 *
923 * Used to change BSS parameters (mainly for AP mode).
924 *
925 * @use_cts_prot: Whether to use CTS protection
926 * (0 = no, 1 = yes, -1 = do not change)
927 * @use_short_preamble: Whether the use of short preambles is allowed
928 * (0 = no, 1 = yes, -1 = do not change)
929 * @use_short_slot_time: Whether the use of short slot time is allowed
930 * (0 = no, 1 = yes, -1 = do not change)
931 * @basic_rates: basic rates in IEEE 802.11 format
932 * (or NULL for no change)
933 * @basic_rates_len: number of basic rates
934 * @ap_isolate: do not forward packets between connected stations
935 * @ht_opmode: HT Operation mode
936 * (u16 = opmode, -1 = do not change)
937 * @p2p_ctwindow: P2P CT Window (-1 = no change)
938 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
939 */
940 struct bss_parameters {
941 int use_cts_prot;
942 int use_short_preamble;
943 int use_short_slot_time;
944 u8 *basic_rates;
945 u8 basic_rates_len;
946 int ap_isolate;
947 int ht_opmode;
948 s8 p2p_ctwindow, p2p_opp_ps;
949 };
950
951 /**
952 * struct mesh_config - 802.11s mesh configuration
953 *
954 * These parameters can be changed while the mesh is active.
955 *
956 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
957 * by the Mesh Peering Open message
958 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
959 * used by the Mesh Peering Open message
960 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
961 * the mesh peering management to close a mesh peering
962 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
963 * mesh interface
964 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
965 * be sent to establish a new peer link instance in a mesh
966 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
967 * @element_ttl: the value of TTL field set at a mesh STA for path selection
968 * elements
969 * @auto_open_plinks: whether we should automatically open peer links when we
970 * detect compatible mesh peers
971 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
972 * synchronize to for 11s default synchronization method
973 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
974 * that an originator mesh STA can send to a particular path target
975 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
976 * @min_discovery_timeout: the minimum length of time to wait until giving up on
977 * a path discovery in milliseconds
978 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
979 * receiving a PREQ shall consider the forwarding information from the
980 * root to be valid. (TU = time unit)
981 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
982 * which a mesh STA can send only one action frame containing a PREQ
983 * element
984 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
985 * which a mesh STA can send only one Action frame containing a PERR
986 * element
987 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
988 * it takes for an HWMP information element to propagate across the mesh
989 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
990 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
991 * announcements are transmitted
992 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
993 * station has access to a broader network beyond the MBSS. (This is
994 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
995 * only means that the station will announce others it's a mesh gate, but
996 * not necessarily using the gate announcement protocol. Still keeping the
997 * same nomenclature to be in sync with the spec)
998 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
999 * entity (default is TRUE - forwarding entity)
1000 * @rssi_threshold: the threshold for average signal strength of candidate
1001 * station to establish a peer link
1002 * @ht_opmode: mesh HT protection mode
1003 *
1004 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1005 * receiving a proactive PREQ shall consider the forwarding information to
1006 * the root mesh STA to be valid.
1007 *
1008 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1009 * PREQs are transmitted.
1010 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1011 * during which a mesh STA can send only one Action frame containing
1012 * a PREQ element for root path confirmation.
1013 * @power_mode: The default mesh power save mode which will be the initial
1014 * setting for new peer links.
1015 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1016 * after transmitting its beacon.
1017 */
1018 struct mesh_config {
1019 u16 dot11MeshRetryTimeout;
1020 u16 dot11MeshConfirmTimeout;
1021 u16 dot11MeshHoldingTimeout;
1022 u16 dot11MeshMaxPeerLinks;
1023 u8 dot11MeshMaxRetries;
1024 u8 dot11MeshTTL;
1025 u8 element_ttl;
1026 bool auto_open_plinks;
1027 u32 dot11MeshNbrOffsetMaxNeighbor;
1028 u8 dot11MeshHWMPmaxPREQretries;
1029 u32 path_refresh_time;
1030 u16 min_discovery_timeout;
1031 u32 dot11MeshHWMPactivePathTimeout;
1032 u16 dot11MeshHWMPpreqMinInterval;
1033 u16 dot11MeshHWMPperrMinInterval;
1034 u16 dot11MeshHWMPnetDiameterTraversalTime;
1035 u8 dot11MeshHWMPRootMode;
1036 u16 dot11MeshHWMPRannInterval;
1037 bool dot11MeshGateAnnouncementProtocol;
1038 bool dot11MeshForwarding;
1039 s32 rssi_threshold;
1040 u16 ht_opmode;
1041 u32 dot11MeshHWMPactivePathToRootTimeout;
1042 u16 dot11MeshHWMProotInterval;
1043 u16 dot11MeshHWMPconfirmationInterval;
1044 enum nl80211_mesh_power_mode power_mode;
1045 u16 dot11MeshAwakeWindowDuration;
1046 };
1047
1048 /**
1049 * struct mesh_setup - 802.11s mesh setup configuration
1050 * @chandef: defines the channel to use
1051 * @mesh_id: the mesh ID
1052 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1053 * @sync_method: which synchronization method to use
1054 * @path_sel_proto: which path selection protocol to use
1055 * @path_metric: which metric to use
1056 * @ie: vendor information elements (optional)
1057 * @ie_len: length of vendor information elements
1058 * @is_authenticated: this mesh requires authentication
1059 * @is_secure: this mesh uses security
1060 * @dtim_period: DTIM period to use
1061 * @beacon_interval: beacon interval to use
1062 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1063 *
1064 * These parameters are fixed when the mesh is created.
1065 */
1066 struct mesh_setup {
1067 struct cfg80211_chan_def chandef;
1068 const u8 *mesh_id;
1069 u8 mesh_id_len;
1070 u8 sync_method;
1071 u8 path_sel_proto;
1072 u8 path_metric;
1073 const u8 *ie;
1074 u8 ie_len;
1075 bool is_authenticated;
1076 bool is_secure;
1077 u8 dtim_period;
1078 u16 beacon_interval;
1079 int mcast_rate[IEEE80211_NUM_BANDS];
1080 };
1081
1082 /**
1083 * struct ieee80211_txq_params - TX queue parameters
1084 * @ac: AC identifier
1085 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1086 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1087 * 1..32767]
1088 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1089 * 1..32767]
1090 * @aifs: Arbitration interframe space [0..255]
1091 */
1092 struct ieee80211_txq_params {
1093 enum nl80211_ac ac;
1094 u16 txop;
1095 u16 cwmin;
1096 u16 cwmax;
1097 u8 aifs;
1098 };
1099
1100 /**
1101 * DOC: Scanning and BSS list handling
1102 *
1103 * The scanning process itself is fairly simple, but cfg80211 offers quite
1104 * a bit of helper functionality. To start a scan, the scan operation will
1105 * be invoked with a scan definition. This scan definition contains the
1106 * channels to scan, and the SSIDs to send probe requests for (including the
1107 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1108 * probe. Additionally, a scan request may contain extra information elements
1109 * that should be added to the probe request. The IEs are guaranteed to be
1110 * well-formed, and will not exceed the maximum length the driver advertised
1111 * in the wiphy structure.
1112 *
1113 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1114 * it is responsible for maintaining the BSS list; the driver should not
1115 * maintain a list itself. For this notification, various functions exist.
1116 *
1117 * Since drivers do not maintain a BSS list, there are also a number of
1118 * functions to search for a BSS and obtain information about it from the
1119 * BSS structure cfg80211 maintains. The BSS list is also made available
1120 * to userspace.
1121 */
1122
1123 /**
1124 * struct cfg80211_ssid - SSID description
1125 * @ssid: the SSID
1126 * @ssid_len: length of the ssid
1127 */
1128 struct cfg80211_ssid {
1129 u8 ssid[IEEE80211_MAX_SSID_LEN];
1130 u8 ssid_len;
1131 };
1132
1133 /**
1134 * struct cfg80211_scan_request - scan request description
1135 *
1136 * @ssids: SSIDs to scan for (active scan only)
1137 * @n_ssids: number of SSIDs
1138 * @channels: channels to scan on.
1139 * @n_channels: total number of channels to scan
1140 * @ie: optional information element(s) to add into Probe Request or %NULL
1141 * @ie_len: length of ie in octets
1142 * @flags: bit field of flags controlling operation
1143 * @rates: bitmap of rates to advertise for each band
1144 * @wiphy: the wiphy this was for
1145 * @scan_start: time (in jiffies) when the scan started
1146 * @wdev: the wireless device to scan for
1147 * @aborted: (internal) scan request was notified as aborted
1148 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1149 */
1150 struct cfg80211_scan_request {
1151 struct cfg80211_ssid *ssids;
1152 int n_ssids;
1153 u32 n_channels;
1154 const u8 *ie;
1155 size_t ie_len;
1156 u32 flags;
1157
1158 u32 rates[IEEE80211_NUM_BANDS];
1159
1160 struct wireless_dev *wdev;
1161
1162 /* internal */
1163 struct wiphy *wiphy;
1164 unsigned long scan_start;
1165 bool aborted;
1166 bool no_cck;
1167
1168 /* keep last */
1169 struct ieee80211_channel *channels[0];
1170 };
1171
1172 /**
1173 * struct cfg80211_match_set - sets of attributes to match
1174 *
1175 * @ssid: SSID to be matched
1176 */
1177 struct cfg80211_match_set {
1178 struct cfg80211_ssid ssid;
1179 };
1180
1181 /**
1182 * struct cfg80211_sched_scan_request - scheduled scan request description
1183 *
1184 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1185 * @n_ssids: number of SSIDs
1186 * @n_channels: total number of channels to scan
1187 * @interval: interval between each scheduled scan cycle
1188 * @ie: optional information element(s) to add into Probe Request or %NULL
1189 * @ie_len: length of ie in octets
1190 * @flags: bit field of flags controlling operation
1191 * @match_sets: sets of parameters to be matched for a scan result
1192 * entry to be considered valid and to be passed to the host
1193 * (others are filtered out).
1194 * If ommited, all results are passed.
1195 * @n_match_sets: number of match sets
1196 * @wiphy: the wiphy this was for
1197 * @dev: the interface
1198 * @channels: channels to scan
1199 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1200 */
1201 struct cfg80211_sched_scan_request {
1202 struct cfg80211_ssid *ssids;
1203 int n_ssids;
1204 u32 n_channels;
1205 u32 interval;
1206 const u8 *ie;
1207 size_t ie_len;
1208 u32 flags;
1209 struct cfg80211_match_set *match_sets;
1210 int n_match_sets;
1211 s32 rssi_thold;
1212
1213 /* internal */
1214 struct wiphy *wiphy;
1215 struct net_device *dev;
1216 unsigned long scan_start;
1217
1218 /* keep last */
1219 struct ieee80211_channel *channels[0];
1220 };
1221
1222 /**
1223 * enum cfg80211_signal_type - signal type
1224 *
1225 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1226 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1227 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1228 */
1229 enum cfg80211_signal_type {
1230 CFG80211_SIGNAL_TYPE_NONE,
1231 CFG80211_SIGNAL_TYPE_MBM,
1232 CFG80211_SIGNAL_TYPE_UNSPEC,
1233 };
1234
1235 /**
1236 * struct cfg80211_bss_ie_data - BSS entry IE data
1237 * @rcu_head: internal use, for freeing
1238 * @len: length of the IEs
1239 * @data: IE data
1240 */
1241 struct cfg80211_bss_ies {
1242 struct rcu_head rcu_head;
1243 int len;
1244 u8 data[];
1245 };
1246
1247 /**
1248 * struct cfg80211_bss - BSS description
1249 *
1250 * This structure describes a BSS (which may also be a mesh network)
1251 * for use in scan results and similar.
1252 *
1253 * @channel: channel this BSS is on
1254 * @bssid: BSSID of the BSS
1255 * @tsf: timestamp of last received update
1256 * @beacon_interval: the beacon interval as from the frame
1257 * @capability: the capability field in host byte order
1258 * @ies: the information elements (Note that there
1259 * is no guarantee that these are well-formed!); this is a pointer to
1260 * either the beacon_ies or proberesp_ies depending on whether Probe
1261 * Response frame has been received
1262 * @beacon_ies: the information elements from the last Beacon frame
1263 * @proberesp_ies: the information elements from the last Probe Response frame
1264 * @signal: signal strength value (type depends on the wiphy's signal_type)
1265 * @free_priv: function pointer to free private data
1266 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1267 */
1268 struct cfg80211_bss {
1269 u64 tsf;
1270
1271 struct ieee80211_channel *channel;
1272
1273 const struct cfg80211_bss_ies __rcu *ies;
1274 const struct cfg80211_bss_ies __rcu *beacon_ies;
1275 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1276
1277 void (*free_priv)(struct cfg80211_bss *bss);
1278
1279 s32 signal;
1280
1281 u16 beacon_interval;
1282 u16 capability;
1283
1284 u8 bssid[ETH_ALEN];
1285
1286 u8 priv[0] __aligned(sizeof(void *));
1287 };
1288
1289 /**
1290 * ieee80211_bss_get_ie - find IE with given ID
1291 * @bss: the bss to search
1292 * @ie: the IE ID
1293 *
1294 * Note that the return value is an RCU-protected pointer, so
1295 * rcu_read_lock() must be held when calling this function.
1296 * Return: %NULL if not found.
1297 */
1298 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1299
1300
1301 /**
1302 * struct cfg80211_auth_request - Authentication request data
1303 *
1304 * This structure provides information needed to complete IEEE 802.11
1305 * authentication.
1306 *
1307 * @bss: The BSS to authenticate with.
1308 * @auth_type: Authentication type (algorithm)
1309 * @ie: Extra IEs to add to Authentication frame or %NULL
1310 * @ie_len: Length of ie buffer in octets
1311 * @key_len: length of WEP key for shared key authentication
1312 * @key_idx: index of WEP key for shared key authentication
1313 * @key: WEP key for shared key authentication
1314 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1315 * Authentication transaction sequence number field.
1316 * @sae_data_len: Length of sae_data buffer in octets
1317 */
1318 struct cfg80211_auth_request {
1319 struct cfg80211_bss *bss;
1320 const u8 *ie;
1321 size_t ie_len;
1322 enum nl80211_auth_type auth_type;
1323 const u8 *key;
1324 u8 key_len, key_idx;
1325 const u8 *sae_data;
1326 size_t sae_data_len;
1327 };
1328
1329 /**
1330 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1331 *
1332 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1333 */
1334 enum cfg80211_assoc_req_flags {
1335 ASSOC_REQ_DISABLE_HT = BIT(0),
1336 };
1337
1338 /**
1339 * struct cfg80211_assoc_request - (Re)Association request data
1340 *
1341 * This structure provides information needed to complete IEEE 802.11
1342 * (re)association.
1343 * @bss: The BSS to associate with. If the call is successful the driver
1344 * is given a reference that it must release, normally via a call to
1345 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1346 * call to cfg80211_put_bss() (in addition to calling
1347 * cfg80211_send_assoc_timeout())
1348 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1349 * @ie_len: Length of ie buffer in octets
1350 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1351 * @crypto: crypto settings
1352 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1353 * @flags: See &enum cfg80211_assoc_req_flags
1354 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1355 * will be used in ht_capa. Un-supported values will be ignored.
1356 * @ht_capa_mask: The bits of ht_capa which are to be used.
1357 */
1358 struct cfg80211_assoc_request {
1359 struct cfg80211_bss *bss;
1360 const u8 *ie, *prev_bssid;
1361 size_t ie_len;
1362 struct cfg80211_crypto_settings crypto;
1363 bool use_mfp;
1364 u32 flags;
1365 struct ieee80211_ht_cap ht_capa;
1366 struct ieee80211_ht_cap ht_capa_mask;
1367 };
1368
1369 /**
1370 * struct cfg80211_deauth_request - Deauthentication request data
1371 *
1372 * This structure provides information needed to complete IEEE 802.11
1373 * deauthentication.
1374 *
1375 * @bssid: the BSSID of the BSS to deauthenticate from
1376 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1377 * @ie_len: Length of ie buffer in octets
1378 * @reason_code: The reason code for the deauthentication
1379 */
1380 struct cfg80211_deauth_request {
1381 const u8 *bssid;
1382 const u8 *ie;
1383 size_t ie_len;
1384 u16 reason_code;
1385 bool local_state_change;
1386 };
1387
1388 /**
1389 * struct cfg80211_disassoc_request - Disassociation request data
1390 *
1391 * This structure provides information needed to complete IEEE 802.11
1392 * disassocation.
1393 *
1394 * @bss: the BSS to disassociate from
1395 * @ie: Extra IEs to add to Disassociation frame or %NULL
1396 * @ie_len: Length of ie buffer in octets
1397 * @reason_code: The reason code for the disassociation
1398 * @local_state_change: This is a request for a local state only, i.e., no
1399 * Disassociation frame is to be transmitted.
1400 */
1401 struct cfg80211_disassoc_request {
1402 struct cfg80211_bss *bss;
1403 const u8 *ie;
1404 size_t ie_len;
1405 u16 reason_code;
1406 bool local_state_change;
1407 };
1408
1409 /**
1410 * struct cfg80211_ibss_params - IBSS parameters
1411 *
1412 * This structure defines the IBSS parameters for the join_ibss()
1413 * method.
1414 *
1415 * @ssid: The SSID, will always be non-null.
1416 * @ssid_len: The length of the SSID, will always be non-zero.
1417 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1418 * search for IBSSs with a different BSSID.
1419 * @chandef: defines the channel to use if no other IBSS to join can be found
1420 * @channel_fixed: The channel should be fixed -- do not search for
1421 * IBSSs to join on other channels.
1422 * @ie: information element(s) to include in the beacon
1423 * @ie_len: length of that
1424 * @beacon_interval: beacon interval to use
1425 * @privacy: this is a protected network, keys will be configured
1426 * after joining
1427 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1428 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1429 * required to assume that the port is unauthorized until authorized by
1430 * user space. Otherwise, port is marked authorized by default.
1431 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1432 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1433 */
1434 struct cfg80211_ibss_params {
1435 u8 *ssid;
1436 u8 *bssid;
1437 struct cfg80211_chan_def chandef;
1438 u8 *ie;
1439 u8 ssid_len, ie_len;
1440 u16 beacon_interval;
1441 u32 basic_rates;
1442 bool channel_fixed;
1443 bool privacy;
1444 bool control_port;
1445 int mcast_rate[IEEE80211_NUM_BANDS];
1446 };
1447
1448 /**
1449 * struct cfg80211_connect_params - Connection parameters
1450 *
1451 * This structure provides information needed to complete IEEE 802.11
1452 * authentication and association.
1453 *
1454 * @channel: The channel to use or %NULL if not specified (auto-select based
1455 * on scan results)
1456 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1457 * results)
1458 * @ssid: SSID
1459 * @ssid_len: Length of ssid in octets
1460 * @auth_type: Authentication type (algorithm)
1461 * @ie: IEs for association request
1462 * @ie_len: Length of assoc_ie in octets
1463 * @privacy: indicates whether privacy-enabled APs should be used
1464 * @crypto: crypto settings
1465 * @key_len: length of WEP key for shared key authentication
1466 * @key_idx: index of WEP key for shared key authentication
1467 * @key: WEP key for shared key authentication
1468 * @flags: See &enum cfg80211_assoc_req_flags
1469 * @bg_scan_period: Background scan period in seconds
1470 * or -1 to indicate that default value is to be used.
1471 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1472 * will be used in ht_capa. Un-supported values will be ignored.
1473 * @ht_capa_mask: The bits of ht_capa which are to be used.
1474 */
1475 struct cfg80211_connect_params {
1476 struct ieee80211_channel *channel;
1477 u8 *bssid;
1478 u8 *ssid;
1479 size_t ssid_len;
1480 enum nl80211_auth_type auth_type;
1481 u8 *ie;
1482 size_t ie_len;
1483 bool privacy;
1484 struct cfg80211_crypto_settings crypto;
1485 const u8 *key;
1486 u8 key_len, key_idx;
1487 u32 flags;
1488 int bg_scan_period;
1489 struct ieee80211_ht_cap ht_capa;
1490 struct ieee80211_ht_cap ht_capa_mask;
1491 };
1492
1493 /**
1494 * enum wiphy_params_flags - set_wiphy_params bitfield values
1495 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1496 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1497 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1498 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1499 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1500 */
1501 enum wiphy_params_flags {
1502 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1503 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1504 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1505 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1506 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1507 };
1508
1509 /*
1510 * cfg80211_bitrate_mask - masks for bitrate control
1511 */
1512 struct cfg80211_bitrate_mask {
1513 struct {
1514 u32 legacy;
1515 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1516 } control[IEEE80211_NUM_BANDS];
1517 };
1518 /**
1519 * struct cfg80211_pmksa - PMK Security Association
1520 *
1521 * This structure is passed to the set/del_pmksa() method for PMKSA
1522 * caching.
1523 *
1524 * @bssid: The AP's BSSID.
1525 * @pmkid: The PMK material itself.
1526 */
1527 struct cfg80211_pmksa {
1528 u8 *bssid;
1529 u8 *pmkid;
1530 };
1531
1532 /**
1533 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1534 * @mask: bitmask where to match pattern and where to ignore bytes,
1535 * one bit per byte, in same format as nl80211
1536 * @pattern: bytes to match where bitmask is 1
1537 * @pattern_len: length of pattern (in bytes)
1538 *
1539 * Internal note: @mask and @pattern are allocated in one chunk of
1540 * memory, free @mask only!
1541 */
1542 struct cfg80211_wowlan_trig_pkt_pattern {
1543 u8 *mask, *pattern;
1544 int pattern_len;
1545 };
1546
1547 /**
1548 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1549 *
1550 * This structure defines the enabled WoWLAN triggers for the device.
1551 * @any: wake up on any activity -- special trigger if device continues
1552 * operating as normal during suspend
1553 * @disconnect: wake up if getting disconnected
1554 * @magic_pkt: wake up on receiving magic packet
1555 * @patterns: wake up on receiving packet matching a pattern
1556 * @n_patterns: number of patterns
1557 * @gtk_rekey_failure: wake up on GTK rekey failure
1558 * @eap_identity_req: wake up on EAP identity request packet
1559 * @four_way_handshake: wake up on 4-way handshake
1560 * @rfkill_release: wake up when rfkill is released
1561 */
1562 struct cfg80211_wowlan {
1563 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1564 eap_identity_req, four_way_handshake,
1565 rfkill_release;
1566 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1567 int n_patterns;
1568 };
1569
1570 /**
1571 * struct cfg80211_gtk_rekey_data - rekey data
1572 * @kek: key encryption key
1573 * @kck: key confirmation key
1574 * @replay_ctr: replay counter
1575 */
1576 struct cfg80211_gtk_rekey_data {
1577 u8 kek[NL80211_KEK_LEN];
1578 u8 kck[NL80211_KCK_LEN];
1579 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1580 };
1581
1582 /**
1583 * struct cfg80211_ops - backend description for wireless configuration
1584 *
1585 * This struct is registered by fullmac card drivers and/or wireless stacks
1586 * in order to handle configuration requests on their interfaces.
1587 *
1588 * All callbacks except where otherwise noted should return 0
1589 * on success or a negative error code.
1590 *
1591 * All operations are currently invoked under rtnl for consistency with the
1592 * wireless extensions but this is subject to reevaluation as soon as this
1593 * code is used more widely and we have a first user without wext.
1594 *
1595 * @suspend: wiphy device needs to be suspended. The variable @wow will
1596 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1597 * configured for the device.
1598 * @resume: wiphy device needs to be resumed
1599 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1600 * to call device_set_wakeup_enable() to enable/disable wakeup from
1601 * the device.
1602 *
1603 * @add_virtual_intf: create a new virtual interface with the given name,
1604 * must set the struct wireless_dev's iftype. Beware: You must create
1605 * the new netdev in the wiphy's network namespace! Returns the struct
1606 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1607 * also set the address member in the wdev.
1608 *
1609 * @del_virtual_intf: remove the virtual interface
1610 *
1611 * @change_virtual_intf: change type/configuration of virtual interface,
1612 * keep the struct wireless_dev's iftype updated.
1613 *
1614 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1615 * when adding a group key.
1616 *
1617 * @get_key: get information about the key with the given parameters.
1618 * @mac_addr will be %NULL when requesting information for a group
1619 * key. All pointers given to the @callback function need not be valid
1620 * after it returns. This function should return an error if it is
1621 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1622 *
1623 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1624 * and @key_index, return -ENOENT if the key doesn't exist.
1625 *
1626 * @set_default_key: set the default key on an interface
1627 *
1628 * @set_default_mgmt_key: set the default management frame key on an interface
1629 *
1630 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1631 *
1632 * @start_ap: Start acting in AP mode defined by the parameters.
1633 * @change_beacon: Change the beacon parameters for an access point mode
1634 * interface. This should reject the call when AP mode wasn't started.
1635 * @stop_ap: Stop being an AP, including stopping beaconing.
1636 *
1637 * @add_station: Add a new station.
1638 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1639 * @change_station: Modify a given station. Note that flags changes are not much
1640 * validated in cfg80211, in particular the auth/assoc/authorized flags
1641 * might come to the driver in invalid combinations -- make sure to check
1642 * them, also against the existing state! Also, supported_rates changes are
1643 * not checked in station mode -- drivers need to reject (or ignore) them
1644 * for anything but TDLS peers.
1645 * @get_station: get station information for the station identified by @mac
1646 * @dump_station: dump station callback -- resume dump at index @idx
1647 *
1648 * @add_mpath: add a fixed mesh path
1649 * @del_mpath: delete a given mesh path
1650 * @change_mpath: change a given mesh path
1651 * @get_mpath: get a mesh path for the given parameters
1652 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1653 * @join_mesh: join the mesh network with the specified parameters
1654 * @leave_mesh: leave the current mesh network
1655 *
1656 * @get_mesh_config: Get the current mesh configuration
1657 *
1658 * @update_mesh_config: Update mesh parameters on a running mesh.
1659 * The mask is a bitfield which tells us which parameters to
1660 * set, and which to leave alone.
1661 *
1662 * @change_bss: Modify parameters for a given BSS.
1663 *
1664 * @set_txq_params: Set TX queue parameters
1665 *
1666 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1667 * as it doesn't implement join_mesh and needs to set the channel to
1668 * join the mesh instead.
1669 *
1670 * @set_monitor_channel: Set the monitor mode channel for the device. If other
1671 * interfaces are active this callback should reject the configuration.
1672 * If no interfaces are active or the device is down, the channel should
1673 * be stored for when a monitor interface becomes active.
1674 *
1675 * @scan: Request to do a scan. If returning zero, the scan request is given
1676 * the driver, and will be valid until passed to cfg80211_scan_done().
1677 * For scan results, call cfg80211_inform_bss(); you can call this outside
1678 * the scan/scan_done bracket too.
1679 *
1680 * @auth: Request to authenticate with the specified peer
1681 * @assoc: Request to (re)associate with the specified peer
1682 * @deauth: Request to deauthenticate from the specified peer
1683 * @disassoc: Request to disassociate from the specified peer
1684 *
1685 * @connect: Connect to the ESS with the specified parameters. When connected,
1686 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1687 * If the connection fails for some reason, call cfg80211_connect_result()
1688 * with the status from the AP.
1689 * @disconnect: Disconnect from the BSS/ESS.
1690 *
1691 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1692 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1693 * to a merge.
1694 * @leave_ibss: Leave the IBSS.
1695 *
1696 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
1697 * MESH mode)
1698 *
1699 * @set_wiphy_params: Notify that wiphy parameters have changed;
1700 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1701 * have changed. The actual parameter values are available in
1702 * struct wiphy. If returning an error, no value should be changed.
1703 *
1704 * @set_tx_power: set the transmit power according to the parameters,
1705 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
1706 * wdev may be %NULL if power was set for the wiphy, and will
1707 * always be %NULL unless the driver supports per-vif TX power
1708 * (as advertised by the nl80211 feature flag.)
1709 * @get_tx_power: store the current TX power into the dbm variable;
1710 * return 0 if successful
1711 *
1712 * @set_wds_peer: set the WDS peer for a WDS interface
1713 *
1714 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1715 * functions to adjust rfkill hw state
1716 *
1717 * @dump_survey: get site survey information.
1718 *
1719 * @remain_on_channel: Request the driver to remain awake on the specified
1720 * channel for the specified duration to complete an off-channel
1721 * operation (e.g., public action frame exchange). When the driver is
1722 * ready on the requested channel, it must indicate this with an event
1723 * notification by calling cfg80211_ready_on_channel().
1724 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1725 * This allows the operation to be terminated prior to timeout based on
1726 * the duration value.
1727 * @mgmt_tx: Transmit a management frame.
1728 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1729 * frame on another channel
1730 *
1731 * @testmode_cmd: run a test mode command
1732 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1733 * used by the function, but 0 and 1 must not be touched. Additionally,
1734 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1735 * dump and return to userspace with an error, so be careful. If any data
1736 * was passed in from userspace then the data/len arguments will be present
1737 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1738 *
1739 * @set_bitrate_mask: set the bitrate mask configuration
1740 *
1741 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1742 * devices running firmwares capable of generating the (re) association
1743 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1744 * @del_pmksa: Delete a cached PMKID.
1745 * @flush_pmksa: Flush all cached PMKIDs.
1746 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1747 * allows the driver to adjust the dynamic ps timeout value.
1748 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1749 * @set_cqm_txe_config: Configure connection quality monitor TX error
1750 * thresholds.
1751 * @sched_scan_start: Tell the driver to start a scheduled scan.
1752 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
1753 *
1754 * @mgmt_frame_register: Notify driver that a management frame type was
1755 * registered. Note that this callback may not sleep, and cannot run
1756 * concurrently with itself.
1757 *
1758 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1759 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1760 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1761 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1762 *
1763 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1764 *
1765 * @set_ringparam: Set tx and rx ring sizes.
1766 *
1767 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1768 *
1769 * @tdls_mgmt: Transmit a TDLS management frame.
1770 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1771 *
1772 * @probe_client: probe an associated client, must return a cookie that it
1773 * later passes to cfg80211_probe_status().
1774 *
1775 * @set_noack_map: Set the NoAck Map for the TIDs.
1776 *
1777 * @get_et_sset_count: Ethtool API to get string-set count.
1778 * See @ethtool_ops.get_sset_count
1779 *
1780 * @get_et_stats: Ethtool API to get a set of u64 stats.
1781 * See @ethtool_ops.get_ethtool_stats
1782 *
1783 * @get_et_strings: Ethtool API to get a set of strings to describe stats
1784 * and perhaps other supported types of ethtool data-sets.
1785 * See @ethtool_ops.get_strings
1786 *
1787 * @get_channel: Get the current operating channel for the virtual interface.
1788 * For monitor interfaces, it should return %NULL unless there's a single
1789 * current monitoring channel.
1790 *
1791 * @start_p2p_device: Start the given P2P device.
1792 * @stop_p2p_device: Stop the given P2P device.
1793 */
1794 struct cfg80211_ops {
1795 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1796 int (*resume)(struct wiphy *wiphy);
1797 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
1798
1799 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
1800 const char *name,
1801 enum nl80211_iftype type,
1802 u32 *flags,
1803 struct vif_params *params);
1804 int (*del_virtual_intf)(struct wiphy *wiphy,
1805 struct wireless_dev *wdev);
1806 int (*change_virtual_intf)(struct wiphy *wiphy,
1807 struct net_device *dev,
1808 enum nl80211_iftype type, u32 *flags,
1809 struct vif_params *params);
1810
1811 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1812 u8 key_index, bool pairwise, const u8 *mac_addr,
1813 struct key_params *params);
1814 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1815 u8 key_index, bool pairwise, const u8 *mac_addr,
1816 void *cookie,
1817 void (*callback)(void *cookie, struct key_params*));
1818 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1819 u8 key_index, bool pairwise, const u8 *mac_addr);
1820 int (*set_default_key)(struct wiphy *wiphy,
1821 struct net_device *netdev,
1822 u8 key_index, bool unicast, bool multicast);
1823 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1824 struct net_device *netdev,
1825 u8 key_index);
1826
1827 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
1828 struct cfg80211_ap_settings *settings);
1829 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
1830 struct cfg80211_beacon_data *info);
1831 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
1832
1833
1834 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1835 u8 *mac, struct station_parameters *params);
1836 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1837 u8 *mac);
1838 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1839 u8 *mac, struct station_parameters *params);
1840 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1841 u8 *mac, struct station_info *sinfo);
1842 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1843 int idx, u8 *mac, struct station_info *sinfo);
1844
1845 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1846 u8 *dst, u8 *next_hop);
1847 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1848 u8 *dst);
1849 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1850 u8 *dst, u8 *next_hop);
1851 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1852 u8 *dst, u8 *next_hop,
1853 struct mpath_info *pinfo);
1854 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1855 int idx, u8 *dst, u8 *next_hop,
1856 struct mpath_info *pinfo);
1857 int (*get_mesh_config)(struct wiphy *wiphy,
1858 struct net_device *dev,
1859 struct mesh_config *conf);
1860 int (*update_mesh_config)(struct wiphy *wiphy,
1861 struct net_device *dev, u32 mask,
1862 const struct mesh_config *nconf);
1863 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1864 const struct mesh_config *conf,
1865 const struct mesh_setup *setup);
1866 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1867
1868 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1869 struct bss_parameters *params);
1870
1871 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1872 struct ieee80211_txq_params *params);
1873
1874 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
1875 struct net_device *dev,
1876 struct ieee80211_channel *chan);
1877
1878 int (*set_monitor_channel)(struct wiphy *wiphy,
1879 struct cfg80211_chan_def *chandef);
1880
1881 int (*scan)(struct wiphy *wiphy,
1882 struct cfg80211_scan_request *request);
1883
1884 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1885 struct cfg80211_auth_request *req);
1886 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1887 struct cfg80211_assoc_request *req);
1888 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1889 struct cfg80211_deauth_request *req);
1890 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1891 struct cfg80211_disassoc_request *req);
1892
1893 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1894 struct cfg80211_connect_params *sme);
1895 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1896 u16 reason_code);
1897
1898 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1899 struct cfg80211_ibss_params *params);
1900 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1901
1902 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
1903 int rate[IEEE80211_NUM_BANDS]);
1904
1905 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1906
1907 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
1908 enum nl80211_tx_power_setting type, int mbm);
1909 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
1910 int *dbm);
1911
1912 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1913 const u8 *addr);
1914
1915 void (*rfkill_poll)(struct wiphy *wiphy);
1916
1917 #ifdef CONFIG_NL80211_TESTMODE
1918 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1919 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1920 struct netlink_callback *cb,
1921 void *data, int len);
1922 #endif
1923
1924 int (*set_bitrate_mask)(struct wiphy *wiphy,
1925 struct net_device *dev,
1926 const u8 *peer,
1927 const struct cfg80211_bitrate_mask *mask);
1928
1929 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1930 int idx, struct survey_info *info);
1931
1932 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1933 struct cfg80211_pmksa *pmksa);
1934 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1935 struct cfg80211_pmksa *pmksa);
1936 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1937
1938 int (*remain_on_channel)(struct wiphy *wiphy,
1939 struct wireless_dev *wdev,
1940 struct ieee80211_channel *chan,
1941 unsigned int duration,
1942 u64 *cookie);
1943 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1944 struct wireless_dev *wdev,
1945 u64 cookie);
1946
1947 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
1948 struct ieee80211_channel *chan, bool offchan,
1949 unsigned int wait, const u8 *buf, size_t len,
1950 bool no_cck, bool dont_wait_for_ack, u64 *cookie);
1951 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1952 struct wireless_dev *wdev,
1953 u64 cookie);
1954
1955 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1956 bool enabled, int timeout);
1957
1958 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1959 struct net_device *dev,
1960 s32 rssi_thold, u32 rssi_hyst);
1961
1962 int (*set_cqm_txe_config)(struct wiphy *wiphy,
1963 struct net_device *dev,
1964 u32 rate, u32 pkts, u32 intvl);
1965
1966 void (*mgmt_frame_register)(struct wiphy *wiphy,
1967 struct wireless_dev *wdev,
1968 u16 frame_type, bool reg);
1969
1970 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1971 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1972
1973 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1974 void (*get_ringparam)(struct wiphy *wiphy,
1975 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1976
1977 int (*sched_scan_start)(struct wiphy *wiphy,
1978 struct net_device *dev,
1979 struct cfg80211_sched_scan_request *request);
1980 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1981
1982 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
1983 struct cfg80211_gtk_rekey_data *data);
1984
1985 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1986 u8 *peer, u8 action_code, u8 dialog_token,
1987 u16 status_code, const u8 *buf, size_t len);
1988 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
1989 u8 *peer, enum nl80211_tdls_operation oper);
1990
1991 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
1992 const u8 *peer, u64 *cookie);
1993
1994 int (*set_noack_map)(struct wiphy *wiphy,
1995 struct net_device *dev,
1996 u16 noack_map);
1997
1998 int (*get_et_sset_count)(struct wiphy *wiphy,
1999 struct net_device *dev, int sset);
2000 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
2001 struct ethtool_stats *stats, u64 *data);
2002 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
2003 u32 sset, u8 *data);
2004
2005 int (*get_channel)(struct wiphy *wiphy,
2006 struct wireless_dev *wdev,
2007 struct cfg80211_chan_def *chandef);
2008
2009 int (*start_p2p_device)(struct wiphy *wiphy,
2010 struct wireless_dev *wdev);
2011 void (*stop_p2p_device)(struct wiphy *wiphy,
2012 struct wireless_dev *wdev);
2013 };
2014
2015 /*
2016 * wireless hardware and networking interfaces structures
2017 * and registration/helper functions
2018 */
2019
2020 /**
2021 * enum wiphy_flags - wiphy capability flags
2022 *
2023 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
2024 * has its own custom regulatory domain and cannot identify the
2025 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
2026 * we will disregard the first regulatory hint (when the
2027 * initiator is %REGDOM_SET_BY_CORE).
2028 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
2029 * ignore regulatory domain settings until it gets its own regulatory
2030 * domain via its regulatory_hint() unless the regulatory hint is
2031 * from a country IE. After its gets its own regulatory domain it will
2032 * only allow further regulatory domain settings to further enhance
2033 * compliance. For example if channel 13 and 14 are disabled by this
2034 * regulatory domain no user regulatory domain can enable these channels
2035 * at a later time. This can be used for devices which do not have
2036 * calibration information guaranteed for frequencies or settings
2037 * outside of its regulatory domain. If used in combination with
2038 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
2039 * will be followed.
2040 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
2041 * that passive scan flags and beaconing flags may not be lifted by
2042 * cfg80211 due to regulatory beacon hints. For more information on beacon
2043 * hints read the documenation for regulatory_hint_found_beacon()
2044 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2045 * wiphy at all
2046 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2047 * by default -- this flag will be set depending on the kernel's default
2048 * on wiphy_new(), but can be changed by the driver if it has a good
2049 * reason to override the default
2050 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2051 * on a VLAN interface)
2052 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2053 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2054 * control port protocol ethertype. The device also honours the
2055 * control_port_no_encrypt flag.
2056 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2057 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2058 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2059 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2060 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2061 * firmware.
2062 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2063 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2064 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2065 * link setup/discovery operations internally. Setup, discovery and
2066 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2067 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2068 * used for asking the driver/firmware to perform a TDLS operation.
2069 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2070 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2071 * when there are virtual interfaces in AP mode by calling
2072 * cfg80211_report_obss_beacon().
2073 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2074 * responds to probe-requests in hardware.
2075 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2076 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2077 */
2078 enum wiphy_flags {
2079 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
2080 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
2081 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
2082 WIPHY_FLAG_NETNS_OK = BIT(3),
2083 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2084 WIPHY_FLAG_4ADDR_AP = BIT(5),
2085 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2086 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2087 WIPHY_FLAG_IBSS_RSN = BIT(8),
2088 WIPHY_FLAG_MESH_AUTH = BIT(10),
2089 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2090 /* use hole at 12 */
2091 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2092 WIPHY_FLAG_AP_UAPSD = BIT(14),
2093 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2094 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2095 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2096 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2097 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2098 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2099 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2100 };
2101
2102 /**
2103 * struct ieee80211_iface_limit - limit on certain interface types
2104 * @max: maximum number of interfaces of these types
2105 * @types: interface types (bits)
2106 */
2107 struct ieee80211_iface_limit {
2108 u16 max;
2109 u16 types;
2110 };
2111
2112 /**
2113 * struct ieee80211_iface_combination - possible interface combination
2114 * @limits: limits for the given interface types
2115 * @n_limits: number of limitations
2116 * @num_different_channels: can use up to this many different channels
2117 * @max_interfaces: maximum number of interfaces in total allowed in this
2118 * group
2119 * @beacon_int_infra_match: In this combination, the beacon intervals
2120 * between infrastructure and AP types must match. This is required
2121 * only in special cases.
2122 *
2123 * These examples can be expressed as follows:
2124 *
2125 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2126 *
2127 * struct ieee80211_iface_limit limits1[] = {
2128 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2129 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2130 * };
2131 * struct ieee80211_iface_combination combination1 = {
2132 * .limits = limits1,
2133 * .n_limits = ARRAY_SIZE(limits1),
2134 * .max_interfaces = 2,
2135 * .beacon_int_infra_match = true,
2136 * };
2137 *
2138 *
2139 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2140 *
2141 * struct ieee80211_iface_limit limits2[] = {
2142 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2143 * BIT(NL80211_IFTYPE_P2P_GO), },
2144 * };
2145 * struct ieee80211_iface_combination combination2 = {
2146 * .limits = limits2,
2147 * .n_limits = ARRAY_SIZE(limits2),
2148 * .max_interfaces = 8,
2149 * .num_different_channels = 1,
2150 * };
2151 *
2152 *
2153 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2154 * This allows for an infrastructure connection and three P2P connections.
2155 *
2156 * struct ieee80211_iface_limit limits3[] = {
2157 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2158 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2159 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2160 * };
2161 * struct ieee80211_iface_combination combination3 = {
2162 * .limits = limits3,
2163 * .n_limits = ARRAY_SIZE(limits3),
2164 * .max_interfaces = 4,
2165 * .num_different_channels = 2,
2166 * };
2167 */
2168 struct ieee80211_iface_combination {
2169 const struct ieee80211_iface_limit *limits;
2170 u32 num_different_channels;
2171 u16 max_interfaces;
2172 u8 n_limits;
2173 bool beacon_int_infra_match;
2174 };
2175
2176 struct mac_address {
2177 u8 addr[ETH_ALEN];
2178 };
2179
2180 struct ieee80211_txrx_stypes {
2181 u16 tx, rx;
2182 };
2183
2184 /**
2185 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2186 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2187 * trigger that keeps the device operating as-is and
2188 * wakes up the host on any activity, for example a
2189 * received packet that passed filtering; note that the
2190 * packet should be preserved in that case
2191 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2192 * (see nl80211.h)
2193 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2194 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2195 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2196 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2197 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2198 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2199 */
2200 enum wiphy_wowlan_support_flags {
2201 WIPHY_WOWLAN_ANY = BIT(0),
2202 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2203 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2204 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2205 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2206 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2207 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2208 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2209 };
2210
2211 /**
2212 * struct wiphy_wowlan_support - WoWLAN support data
2213 * @flags: see &enum wiphy_wowlan_support_flags
2214 * @n_patterns: number of supported wakeup patterns
2215 * (see nl80211.h for the pattern definition)
2216 * @pattern_max_len: maximum length of each pattern
2217 * @pattern_min_len: minimum length of each pattern
2218 */
2219 struct wiphy_wowlan_support {
2220 u32 flags;
2221 int n_patterns;
2222 int pattern_max_len;
2223 int pattern_min_len;
2224 };
2225
2226 /**
2227 * struct wiphy - wireless hardware description
2228 * @reg_notifier: the driver's regulatory notification callback,
2229 * note that if your driver uses wiphy_apply_custom_regulatory()
2230 * the reg_notifier's request can be passed as NULL
2231 * @regd: the driver's regulatory domain, if one was requested via
2232 * the regulatory_hint() API. This can be used by the driver
2233 * on the reg_notifier() if it chooses to ignore future
2234 * regulatory domain changes caused by other drivers.
2235 * @signal_type: signal type reported in &struct cfg80211_bss.
2236 * @cipher_suites: supported cipher suites
2237 * @n_cipher_suites: number of supported cipher suites
2238 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2239 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2240 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2241 * -1 = fragmentation disabled, only odd values >= 256 used
2242 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2243 * @_net: the network namespace this wiphy currently lives in
2244 * @perm_addr: permanent MAC address of this device
2245 * @addr_mask: If the device supports multiple MAC addresses by masking,
2246 * set this to a mask with variable bits set to 1, e.g. if the last
2247 * four bits are variable then set it to 00:...:00:0f. The actual
2248 * variable bits shall be determined by the interfaces added, with
2249 * interfaces not matching the mask being rejected to be brought up.
2250 * @n_addresses: number of addresses in @addresses.
2251 * @addresses: If the device has more than one address, set this pointer
2252 * to a list of addresses (6 bytes each). The first one will be used
2253 * by default for perm_addr. In this case, the mask should be set to
2254 * all-zeroes. In this case it is assumed that the device can handle
2255 * the same number of arbitrary MAC addresses.
2256 * @registered: protects ->resume and ->suspend sysfs callbacks against
2257 * unregister hardware
2258 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2259 * automatically on wiphy renames
2260 * @dev: (virtual) struct device for this wiphy
2261 * @registered: helps synchronize suspend/resume with wiphy unregister
2262 * @wext: wireless extension handlers
2263 * @priv: driver private data (sized according to wiphy_new() parameter)
2264 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2265 * must be set by driver
2266 * @iface_combinations: Valid interface combinations array, should not
2267 * list single interface types.
2268 * @n_iface_combinations: number of entries in @iface_combinations array.
2269 * @software_iftypes: bitmask of software interface types, these are not
2270 * subject to any restrictions since they are purely managed in SW.
2271 * @flags: wiphy flags, see &enum wiphy_flags
2272 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2273 * @bss_priv_size: each BSS struct has private data allocated with it,
2274 * this variable determines its size
2275 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2276 * any given scan
2277 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2278 * for in any given scheduled scan
2279 * @max_match_sets: maximum number of match sets the device can handle
2280 * when performing a scheduled scan, 0 if filtering is not
2281 * supported.
2282 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2283 * add to probe request frames transmitted during a scan, must not
2284 * include fixed IEs like supported rates
2285 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2286 * scans
2287 * @coverage_class: current coverage class
2288 * @fw_version: firmware version for ethtool reporting
2289 * @hw_version: hardware version for ethtool reporting
2290 * @max_num_pmkids: maximum number of PMKIDs supported by device
2291 * @privid: a pointer that drivers can use to identify if an arbitrary
2292 * wiphy is theirs, e.g. in global notifiers
2293 * @bands: information about bands/channels supported by this device
2294 *
2295 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2296 * transmitted through nl80211, points to an array indexed by interface
2297 * type
2298 *
2299 * @available_antennas_tx: bitmap of antennas which are available to be
2300 * configured as TX antennas. Antenna configuration commands will be
2301 * rejected unless this or @available_antennas_rx is set.
2302 *
2303 * @available_antennas_rx: bitmap of antennas which are available to be
2304 * configured as RX antennas. Antenna configuration commands will be
2305 * rejected unless this or @available_antennas_tx is set.
2306 *
2307 * @probe_resp_offload:
2308 * Bitmap of supported protocols for probe response offloading.
2309 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2310 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2311 *
2312 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2313 * may request, if implemented.
2314 *
2315 * @wowlan: WoWLAN support information
2316 *
2317 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2318 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2319 * If null, then none can be over-ridden.
2320 */
2321 struct wiphy {
2322 /* assign these fields before you register the wiphy */
2323
2324 /* permanent MAC address(es) */
2325 u8 perm_addr[ETH_ALEN];
2326 u8 addr_mask[ETH_ALEN];
2327
2328 struct mac_address *addresses;
2329
2330 const struct ieee80211_txrx_stypes *mgmt_stypes;
2331
2332 const struct ieee80211_iface_combination *iface_combinations;
2333 int n_iface_combinations;
2334 u16 software_iftypes;
2335
2336 u16 n_addresses;
2337
2338 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2339 u16 interface_modes;
2340
2341 u32 flags, features;
2342
2343 u32 ap_sme_capa;
2344
2345 enum cfg80211_signal_type signal_type;
2346
2347 int bss_priv_size;
2348 u8 max_scan_ssids;
2349 u8 max_sched_scan_ssids;
2350 u8 max_match_sets;
2351 u16 max_scan_ie_len;
2352 u16 max_sched_scan_ie_len;
2353
2354 int n_cipher_suites;
2355 const u32 *cipher_suites;
2356
2357 u8 retry_short;
2358 u8 retry_long;
2359 u32 frag_threshold;
2360 u32 rts_threshold;
2361 u8 coverage_class;
2362
2363 char fw_version[ETHTOOL_BUSINFO_LEN];
2364 u32 hw_version;
2365
2366 #ifdef CONFIG_PM
2367 struct wiphy_wowlan_support wowlan;
2368 #endif
2369
2370 u16 max_remain_on_channel_duration;
2371
2372 u8 max_num_pmkids;
2373
2374 u32 available_antennas_tx;
2375 u32 available_antennas_rx;
2376
2377 /*
2378 * Bitmap of supported protocols for probe response offloading
2379 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2380 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2381 */
2382 u32 probe_resp_offload;
2383
2384 /* If multiple wiphys are registered and you're handed e.g.
2385 * a regular netdev with assigned ieee80211_ptr, you won't
2386 * know whether it points to a wiphy your driver has registered
2387 * or not. Assign this to something global to your driver to
2388 * help determine whether you own this wiphy or not. */
2389 const void *privid;
2390
2391 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2392
2393 /* Lets us get back the wiphy on the callback */
2394 void (*reg_notifier)(struct wiphy *wiphy,
2395 struct regulatory_request *request);
2396
2397 /* fields below are read-only, assigned by cfg80211 */
2398
2399 const struct ieee80211_regdomain __rcu *regd;
2400
2401 /* the item in /sys/class/ieee80211/ points to this,
2402 * you need use set_wiphy_dev() (see below) */
2403 struct device dev;
2404
2405 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2406 bool registered;
2407
2408 /* dir in debugfs: ieee80211/<wiphyname> */
2409 struct dentry *debugfsdir;
2410
2411 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2412
2413 #ifdef CONFIG_NET_NS
2414 /* the network namespace this phy lives in currently */
2415 struct net *_net;
2416 #endif
2417
2418 #ifdef CONFIG_CFG80211_WEXT
2419 const struct iw_handler_def *wext;
2420 #endif
2421
2422 char priv[0] __aligned(NETDEV_ALIGN);
2423 };
2424
2425 static inline struct net *wiphy_net(struct wiphy *wiphy)
2426 {
2427 return read_pnet(&wiphy->_net);
2428 }
2429
2430 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2431 {
2432 write_pnet(&wiphy->_net, net);
2433 }
2434
2435 /**
2436 * wiphy_priv - return priv from wiphy
2437 *
2438 * @wiphy: the wiphy whose priv pointer to return
2439 * Return: The priv of @wiphy.
2440 */
2441 static inline void *wiphy_priv(struct wiphy *wiphy)
2442 {
2443 BUG_ON(!wiphy);
2444 return &wiphy->priv;
2445 }
2446
2447 /**
2448 * priv_to_wiphy - return the wiphy containing the priv
2449 *
2450 * @priv: a pointer previously returned by wiphy_priv
2451 * Return: The wiphy of @priv.
2452 */
2453 static inline struct wiphy *priv_to_wiphy(void *priv)
2454 {
2455 BUG_ON(!priv);
2456 return container_of(priv, struct wiphy, priv);
2457 }
2458
2459 /**
2460 * set_wiphy_dev - set device pointer for wiphy
2461 *
2462 * @wiphy: The wiphy whose device to bind
2463 * @dev: The device to parent it to
2464 */
2465 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2466 {
2467 wiphy->dev.parent = dev;
2468 }
2469
2470 /**
2471 * wiphy_dev - get wiphy dev pointer
2472 *
2473 * @wiphy: The wiphy whose device struct to look up
2474 * Return: The dev of @wiphy.
2475 */
2476 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2477 {
2478 return wiphy->dev.parent;
2479 }
2480
2481 /**
2482 * wiphy_name - get wiphy name
2483 *
2484 * @wiphy: The wiphy whose name to return
2485 * Return: The name of @wiphy.
2486 */
2487 static inline const char *wiphy_name(const struct wiphy *wiphy)
2488 {
2489 return dev_name(&wiphy->dev);
2490 }
2491
2492 /**
2493 * wiphy_new - create a new wiphy for use with cfg80211
2494 *
2495 * @ops: The configuration operations for this device
2496 * @sizeof_priv: The size of the private area to allocate
2497 *
2498 * Create a new wiphy and associate the given operations with it.
2499 * @sizeof_priv bytes are allocated for private use.
2500 *
2501 * Return: A pointer to the new wiphy. This pointer must be
2502 * assigned to each netdev's ieee80211_ptr for proper operation.
2503 */
2504 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2505
2506 /**
2507 * wiphy_register - register a wiphy with cfg80211
2508 *
2509 * @wiphy: The wiphy to register.
2510 *
2511 * Return: A non-negative wiphy index or a negative error code.
2512 */
2513 extern int wiphy_register(struct wiphy *wiphy);
2514
2515 /**
2516 * wiphy_unregister - deregister a wiphy from cfg80211
2517 *
2518 * @wiphy: The wiphy to unregister.
2519 *
2520 * After this call, no more requests can be made with this priv
2521 * pointer, but the call may sleep to wait for an outstanding
2522 * request that is being handled.
2523 */
2524 extern void wiphy_unregister(struct wiphy *wiphy);
2525
2526 /**
2527 * wiphy_free - free wiphy
2528 *
2529 * @wiphy: The wiphy to free
2530 */
2531 extern void wiphy_free(struct wiphy *wiphy);
2532
2533 /* internal structs */
2534 struct cfg80211_conn;
2535 struct cfg80211_internal_bss;
2536 struct cfg80211_cached_keys;
2537
2538 /**
2539 * struct wireless_dev - wireless device state
2540 *
2541 * For netdevs, this structure must be allocated by the driver
2542 * that uses the ieee80211_ptr field in struct net_device (this
2543 * is intentional so it can be allocated along with the netdev.)
2544 * It need not be registered then as netdev registration will
2545 * be intercepted by cfg80211 to see the new wireless device.
2546 *
2547 * For non-netdev uses, it must also be allocated by the driver
2548 * in response to the cfg80211 callbacks that require it, as
2549 * there's no netdev registration in that case it may not be
2550 * allocated outside of callback operations that return it.
2551 *
2552 * @wiphy: pointer to hardware description
2553 * @iftype: interface type
2554 * @list: (private) Used to collect the interfaces
2555 * @netdev: (private) Used to reference back to the netdev, may be %NULL
2556 * @identifier: (private) Identifier used in nl80211 to identify this
2557 * wireless device if it has no netdev
2558 * @current_bss: (private) Used by the internal configuration code
2559 * @channel: (private) Used by the internal configuration code to track
2560 * the user-set AP, monitor and WDS channel
2561 * @preset_chan: (private) Used by the internal configuration code to
2562 * track the channel to be used for AP later
2563 * @preset_chantype: (private) the corresponding channel type
2564 * @bssid: (private) Used by the internal configuration code
2565 * @ssid: (private) Used by the internal configuration code
2566 * @ssid_len: (private) Used by the internal configuration code
2567 * @mesh_id_len: (private) Used by the internal configuration code
2568 * @mesh_id_up_len: (private) Used by the internal configuration code
2569 * @wext: (private) Used by the internal wireless extensions compat code
2570 * @use_4addr: indicates 4addr mode is used on this interface, must be
2571 * set by driver (if supported) on add_interface BEFORE registering the
2572 * netdev and may otherwise be used by driver read-only, will be update
2573 * by cfg80211 on change_interface
2574 * @mgmt_registrations: list of registrations for management frames
2575 * @mgmt_registrations_lock: lock for the list
2576 * @mtx: mutex used to lock data in this struct
2577 * @cleanup_work: work struct used for cleanup that can't be done directly
2578 * @beacon_interval: beacon interval used on this device for transmitting
2579 * beacons, 0 when not valid
2580 * @address: The address for this device, valid only if @netdev is %NULL
2581 * @p2p_started: true if this is a P2P Device that has been started
2582 */
2583 struct wireless_dev {
2584 struct wiphy *wiphy;
2585 enum nl80211_iftype iftype;
2586
2587 /* the remainder of this struct should be private to cfg80211 */
2588 struct list_head list;
2589 struct net_device *netdev;
2590
2591 u32 identifier;
2592
2593 struct list_head mgmt_registrations;
2594 spinlock_t mgmt_registrations_lock;
2595
2596 struct mutex mtx;
2597
2598 struct work_struct cleanup_work;
2599
2600 bool use_4addr, p2p_started;
2601
2602 u8 address[ETH_ALEN] __aligned(sizeof(u16));
2603
2604 /* currently used for IBSS and SME - might be rearranged later */
2605 u8 ssid[IEEE80211_MAX_SSID_LEN];
2606 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2607 enum {
2608 CFG80211_SME_IDLE,
2609 CFG80211_SME_CONNECTING,
2610 CFG80211_SME_CONNECTED,
2611 } sme_state;
2612 struct cfg80211_conn *conn;
2613 struct cfg80211_cached_keys *connect_keys;
2614
2615 struct list_head event_list;
2616 spinlock_t event_lock;
2617
2618 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2619 struct cfg80211_chan_def preset_chandef;
2620
2621 /* for AP and mesh channel tracking */
2622 struct ieee80211_channel *channel;
2623
2624 bool ibss_fixed;
2625
2626 bool ps;
2627 int ps_timeout;
2628
2629 int beacon_interval;
2630
2631 u32 ap_unexpected_nlportid;
2632
2633 #ifdef CONFIG_CFG80211_WEXT
2634 /* wext data */
2635 struct {
2636 struct cfg80211_ibss_params ibss;
2637 struct cfg80211_connect_params connect;
2638 struct cfg80211_cached_keys *keys;
2639 u8 *ie;
2640 size_t ie_len;
2641 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2642 u8 ssid[IEEE80211_MAX_SSID_LEN];
2643 s8 default_key, default_mgmt_key;
2644 bool prev_bssid_valid;
2645 } wext;
2646 #endif
2647 };
2648
2649 static inline u8 *wdev_address(struct wireless_dev *wdev)
2650 {
2651 if (wdev->netdev)
2652 return wdev->netdev->dev_addr;
2653 return wdev->address;
2654 }
2655
2656 /**
2657 * wdev_priv - return wiphy priv from wireless_dev
2658 *
2659 * @wdev: The wireless device whose wiphy's priv pointer to return
2660 * Return: The wiphy priv of @wdev.
2661 */
2662 static inline void *wdev_priv(struct wireless_dev *wdev)
2663 {
2664 BUG_ON(!wdev);
2665 return wiphy_priv(wdev->wiphy);
2666 }
2667
2668 /**
2669 * DOC: Utility functions
2670 *
2671 * cfg80211 offers a number of utility functions that can be useful.
2672 */
2673
2674 /**
2675 * ieee80211_channel_to_frequency - convert channel number to frequency
2676 * @chan: channel number
2677 * @band: band, necessary due to channel number overlap
2678 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
2679 */
2680 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2681
2682 /**
2683 * ieee80211_frequency_to_channel - convert frequency to channel number
2684 * @freq: center frequency
2685 * Return: The corresponding channel, or 0 if the conversion failed.
2686 */
2687 extern int ieee80211_frequency_to_channel(int freq);
2688
2689 /*
2690 * Name indirection necessary because the ieee80211 code also has
2691 * a function named "ieee80211_get_channel", so if you include
2692 * cfg80211's header file you get cfg80211's version, if you try
2693 * to include both header files you'll (rightfully!) get a symbol
2694 * clash.
2695 */
2696 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2697 int freq);
2698 /**
2699 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2700 * @wiphy: the struct wiphy to get the channel for
2701 * @freq: the center frequency of the channel
2702 * Return: The channel struct from @wiphy at @freq.
2703 */
2704 static inline struct ieee80211_channel *
2705 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2706 {
2707 return __ieee80211_get_channel(wiphy, freq);
2708 }
2709
2710 /**
2711 * ieee80211_get_response_rate - get basic rate for a given rate
2712 *
2713 * @sband: the band to look for rates in
2714 * @basic_rates: bitmap of basic rates
2715 * @bitrate: the bitrate for which to find the basic rate
2716 *
2717 * Return: The basic rate corresponding to a given bitrate, that
2718 * is the next lower bitrate contained in the basic rate map,
2719 * which is, for this function, given as a bitmap of indices of
2720 * rates in the band's bitrate table.
2721 */
2722 struct ieee80211_rate *
2723 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2724 u32 basic_rates, int bitrate);
2725
2726 /*
2727 * Radiotap parsing functions -- for controlled injection support
2728 *
2729 * Implemented in net/wireless/radiotap.c
2730 * Documentation in Documentation/networking/radiotap-headers.txt
2731 */
2732
2733 struct radiotap_align_size {
2734 uint8_t align:4, size:4;
2735 };
2736
2737 struct ieee80211_radiotap_namespace {
2738 const struct radiotap_align_size *align_size;
2739 int n_bits;
2740 uint32_t oui;
2741 uint8_t subns;
2742 };
2743
2744 struct ieee80211_radiotap_vendor_namespaces {
2745 const struct ieee80211_radiotap_namespace *ns;
2746 int n_ns;
2747 };
2748
2749 /**
2750 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2751 * @this_arg_index: index of current arg, valid after each successful call
2752 * to ieee80211_radiotap_iterator_next()
2753 * @this_arg: pointer to current radiotap arg; it is valid after each
2754 * call to ieee80211_radiotap_iterator_next() but also after
2755 * ieee80211_radiotap_iterator_init() where it will point to
2756 * the beginning of the actual data portion
2757 * @this_arg_size: length of the current arg, for convenience
2758 * @current_namespace: pointer to the current namespace definition
2759 * (or internally %NULL if the current namespace is unknown)
2760 * @is_radiotap_ns: indicates whether the current namespace is the default
2761 * radiotap namespace or not
2762 *
2763 * @_rtheader: pointer to the radiotap header we are walking through
2764 * @_max_length: length of radiotap header in cpu byte ordering
2765 * @_arg_index: next argument index
2766 * @_arg: next argument pointer
2767 * @_next_bitmap: internal pointer to next present u32
2768 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2769 * @_vns: vendor namespace definitions
2770 * @_next_ns_data: beginning of the next namespace's data
2771 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2772 * next bitmap word
2773 *
2774 * Describes the radiotap parser state. Fields prefixed with an underscore
2775 * must not be used by users of the parser, only by the parser internally.
2776 */
2777
2778 struct ieee80211_radiotap_iterator {
2779 struct ieee80211_radiotap_header *_rtheader;
2780 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2781 const struct ieee80211_radiotap_namespace *current_namespace;
2782
2783 unsigned char *_arg, *_next_ns_data;
2784 __le32 *_next_bitmap;
2785
2786 unsigned char *this_arg;
2787 int this_arg_index;
2788 int this_arg_size;
2789
2790 int is_radiotap_ns;
2791
2792 int _max_length;
2793 int _arg_index;
2794 uint32_t _bitmap_shifter;
2795 int _reset_on_ext;
2796 };
2797
2798 extern int ieee80211_radiotap_iterator_init(
2799 struct ieee80211_radiotap_iterator *iterator,
2800 struct ieee80211_radiotap_header *radiotap_header,
2801 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2802
2803 extern int ieee80211_radiotap_iterator_next(
2804 struct ieee80211_radiotap_iterator *iterator);
2805
2806
2807 extern const unsigned char rfc1042_header[6];
2808 extern const unsigned char bridge_tunnel_header[6];
2809
2810 /**
2811 * ieee80211_get_hdrlen_from_skb - get header length from data
2812 *
2813 * @skb: the frame
2814 *
2815 * Given an skb with a raw 802.11 header at the data pointer this function
2816 * returns the 802.11 header length.
2817 *
2818 * Return: The 802.11 header length in bytes (not including encryption
2819 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
2820 * 802.11 header.
2821 */
2822 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2823
2824 /**
2825 * ieee80211_hdrlen - get header length in bytes from frame control
2826 * @fc: frame control field in little-endian format
2827 * Return: The header length in bytes.
2828 */
2829 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2830
2831 /**
2832 * ieee80211_get_mesh_hdrlen - get mesh extension header length
2833 * @meshhdr: the mesh extension header, only the flags field
2834 * (first byte) will be accessed
2835 * Return: The length of the extension header, which is always at
2836 * least 6 bytes and at most 18 if address 5 and 6 are present.
2837 */
2838 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
2839
2840 /**
2841 * DOC: Data path helpers
2842 *
2843 * In addition to generic utilities, cfg80211 also offers
2844 * functions that help implement the data path for devices
2845 * that do not do the 802.11/802.3 conversion on the device.
2846 */
2847
2848 /**
2849 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2850 * @skb: the 802.11 data frame
2851 * @addr: the device MAC address
2852 * @iftype: the virtual interface type
2853 * Return: 0 on success. Non-zero on error.
2854 */
2855 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2856 enum nl80211_iftype iftype);
2857
2858 /**
2859 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2860 * @skb: the 802.3 frame
2861 * @addr: the device MAC address
2862 * @iftype: the virtual interface type
2863 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2864 * @qos: build 802.11 QoS data frame
2865 * Return: 0 on success, or a negative error code.
2866 */
2867 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2868 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2869
2870 /**
2871 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2872 *
2873 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2874 * 802.3 frames. The @list will be empty if the decode fails. The
2875 * @skb is consumed after the function returns.
2876 *
2877 * @skb: The input IEEE 802.11n A-MSDU frame.
2878 * @list: The output list of 802.3 frames. It must be allocated and
2879 * initialized by by the caller.
2880 * @addr: The device MAC address.
2881 * @iftype: The device interface type.
2882 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2883 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2884 */
2885 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2886 const u8 *addr, enum nl80211_iftype iftype,
2887 const unsigned int extra_headroom,
2888 bool has_80211_header);
2889
2890 /**
2891 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2892 * @skb: the data frame
2893 * Return: The 802.1p/1d tag.
2894 */
2895 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2896
2897 /**
2898 * cfg80211_find_ie - find information element in data
2899 *
2900 * @eid: element ID
2901 * @ies: data consisting of IEs
2902 * @len: length of data
2903 *
2904 * Return: %NULL if the element ID could not be found or if
2905 * the element is invalid (claims to be longer than the given
2906 * data), or a pointer to the first byte of the requested
2907 * element, that is the byte containing the element ID.
2908 *
2909 * Note: There are no checks on the element length other than
2910 * having to fit into the given data.
2911 */
2912 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2913
2914 /**
2915 * cfg80211_find_vendor_ie - find vendor specific information element in data
2916 *
2917 * @oui: vendor OUI
2918 * @oui_type: vendor-specific OUI type
2919 * @ies: data consisting of IEs
2920 * @len: length of data
2921 *
2922 * Return: %NULL if the vendor specific element ID could not be found or if the
2923 * element is invalid (claims to be longer than the given data), or a pointer to
2924 * the first byte of the requested element, that is the byte containing the
2925 * element ID.
2926 *
2927 * Note: There are no checks on the element length other than having to fit into
2928 * the given data.
2929 */
2930 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
2931 const u8 *ies, int len);
2932
2933 /**
2934 * DOC: Regulatory enforcement infrastructure
2935 *
2936 * TODO
2937 */
2938
2939 /**
2940 * regulatory_hint - driver hint to the wireless core a regulatory domain
2941 * @wiphy: the wireless device giving the hint (used only for reporting
2942 * conflicts)
2943 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2944 * should be in. If @rd is set this should be NULL. Note that if you
2945 * set this to NULL you should still set rd->alpha2 to some accepted
2946 * alpha2.
2947 *
2948 * Wireless drivers can use this function to hint to the wireless core
2949 * what it believes should be the current regulatory domain by
2950 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2951 * domain should be in or by providing a completely build regulatory domain.
2952 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2953 * for a regulatory domain structure for the respective country.
2954 *
2955 * The wiphy must have been registered to cfg80211 prior to this call.
2956 * For cfg80211 drivers this means you must first use wiphy_register(),
2957 * for mac80211 drivers you must first use ieee80211_register_hw().
2958 *
2959 * Drivers should check the return value, its possible you can get
2960 * an -ENOMEM.
2961 *
2962 * Return: 0 on success. -ENOMEM.
2963 */
2964 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2965
2966 /**
2967 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2968 * @wiphy: the wireless device we want to process the regulatory domain on
2969 * @regd: the custom regulatory domain to use for this wiphy
2970 *
2971 * Drivers can sometimes have custom regulatory domains which do not apply
2972 * to a specific country. Drivers can use this to apply such custom regulatory
2973 * domains. This routine must be called prior to wiphy registration. The
2974 * custom regulatory domain will be trusted completely and as such previous
2975 * default channel settings will be disregarded. If no rule is found for a
2976 * channel on the regulatory domain the channel will be disabled.
2977 */
2978 extern void wiphy_apply_custom_regulatory(
2979 struct wiphy *wiphy,
2980 const struct ieee80211_regdomain *regd);
2981
2982 /**
2983 * freq_reg_info - get regulatory information for the given frequency
2984 * @wiphy: the wiphy for which we want to process this rule for
2985 * @center_freq: Frequency in KHz for which we want regulatory information for
2986 *
2987 * Use this function to get the regulatory rule for a specific frequency on
2988 * a given wireless device. If the device has a specific regulatory domain
2989 * it wants to follow we respect that unless a country IE has been received
2990 * and processed already.
2991 *
2992 * Return: A valid pointer, or, when an error occurs, for example if no rule
2993 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
2994 * check and PTR_ERR() to obtain the numeric return value. The numeric return
2995 * value will be -ERANGE if we determine the given center_freq does not even
2996 * have a regulatory rule for a frequency range in the center_freq's band.
2997 * See freq_in_rule_band() for our current definition of a band -- this is
2998 * purely subjective and right now it's 802.11 specific.
2999 */
3000 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3001 u32 center_freq);
3002
3003 /*
3004 * callbacks for asynchronous cfg80211 methods, notification
3005 * functions and BSS handling helpers
3006 */
3007
3008 /**
3009 * cfg80211_scan_done - notify that scan finished
3010 *
3011 * @request: the corresponding scan request
3012 * @aborted: set to true if the scan was aborted for any reason,
3013 * userspace will be notified of that
3014 */
3015 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3016
3017 /**
3018 * cfg80211_sched_scan_results - notify that new scan results are available
3019 *
3020 * @wiphy: the wiphy which got scheduled scan results
3021 */
3022 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3023
3024 /**
3025 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3026 *
3027 * @wiphy: the wiphy on which the scheduled scan stopped
3028 *
3029 * The driver can call this function to inform cfg80211 that the
3030 * scheduled scan had to be stopped, for whatever reason. The driver
3031 * is then called back via the sched_scan_stop operation when done.
3032 */
3033 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3034
3035 /**
3036 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
3037 *
3038 * @wiphy: the wiphy reporting the BSS
3039 * @channel: The channel the frame was received on
3040 * @mgmt: the management frame (probe response or beacon)
3041 * @len: length of the management frame
3042 * @signal: the signal strength, type depends on the wiphy's signal_type
3043 * @gfp: context flags
3044 *
3045 * This informs cfg80211 that BSS information was found and
3046 * the BSS should be updated/added.
3047 *
3048 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3049 * Or %NULL on error.
3050 */
3051 struct cfg80211_bss * __must_check
3052 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3053 struct ieee80211_channel *channel,
3054 struct ieee80211_mgmt *mgmt, size_t len,
3055 s32 signal, gfp_t gfp);
3056
3057 /**
3058 * cfg80211_inform_bss - inform cfg80211 of a new BSS
3059 *
3060 * @wiphy: the wiphy reporting the BSS
3061 * @channel: The channel the frame was received on
3062 * @bssid: the BSSID of the BSS
3063 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3064 * @capability: the capability field sent by the peer
3065 * @beacon_interval: the beacon interval announced by the peer
3066 * @ie: additional IEs sent by the peer
3067 * @ielen: length of the additional IEs
3068 * @signal: the signal strength, type depends on the wiphy's signal_type
3069 * @gfp: context flags
3070 *
3071 * This informs cfg80211 that BSS information was found and
3072 * the BSS should be updated/added.
3073 *
3074 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3075 * Or %NULL on error.
3076 */
3077 struct cfg80211_bss * __must_check
3078 cfg80211_inform_bss(struct wiphy *wiphy,
3079 struct ieee80211_channel *channel,
3080 const u8 *bssid, u64 tsf, u16 capability,
3081 u16 beacon_interval, const u8 *ie, size_t ielen,
3082 s32 signal, gfp_t gfp);
3083
3084 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3085 struct ieee80211_channel *channel,
3086 const u8 *bssid,
3087 const u8 *ssid, size_t ssid_len,
3088 u16 capa_mask, u16 capa_val);
3089 static inline struct cfg80211_bss *
3090 cfg80211_get_ibss(struct wiphy *wiphy,
3091 struct ieee80211_channel *channel,
3092 const u8 *ssid, size_t ssid_len)
3093 {
3094 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3095 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3096 }
3097
3098 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
3099 struct ieee80211_channel *channel,
3100 const u8 *meshid, size_t meshidlen,
3101 const u8 *meshcfg);
3102 /**
3103 * cfg80211_ref_bss - reference BSS struct
3104 * @bss: the BSS struct to reference
3105 *
3106 * Increments the refcount of the given BSS struct.
3107 */
3108 void cfg80211_ref_bss(struct cfg80211_bss *bss);
3109
3110 /**
3111 * cfg80211_put_bss - unref BSS struct
3112 * @bss: the BSS struct
3113 *
3114 * Decrements the refcount of the given BSS struct.
3115 */
3116 void cfg80211_put_bss(struct cfg80211_bss *bss);
3117
3118 /**
3119 * cfg80211_unlink_bss - unlink BSS from internal data structures
3120 * @wiphy: the wiphy
3121 * @bss: the bss to remove
3122 *
3123 * This function removes the given BSS from the internal data structures
3124 * thereby making it no longer show up in scan results etc. Use this
3125 * function when you detect a BSS is gone. Normally BSSes will also time
3126 * out, so it is not necessary to use this function at all.
3127 */
3128 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3129
3130 /**
3131 * cfg80211_send_rx_auth - notification of processed authentication
3132 * @dev: network device
3133 * @buf: authentication frame (header + body)
3134 * @len: length of the frame data
3135 *
3136 * This function is called whenever an authentication has been processed in
3137 * station mode. The driver is required to call either this function or
3138 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
3139 * call. This function may sleep.
3140 */
3141 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
3142
3143 /**
3144 * cfg80211_send_auth_timeout - notification of timed out authentication
3145 * @dev: network device
3146 * @addr: The MAC address of the device with which the authentication timed out
3147 *
3148 * This function may sleep.
3149 */
3150 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
3151
3152 /**
3153 * cfg80211_send_rx_assoc - notification of processed association
3154 * @dev: network device
3155 * @bss: the BSS struct association was requested for, the struct reference
3156 * is owned by cfg80211 after this call
3157 * @buf: (re)association response frame (header + body)
3158 * @len: length of the frame data
3159 *
3160 * This function is called whenever a (re)association response has been
3161 * processed in station mode. The driver is required to call either this
3162 * function or cfg80211_send_assoc_timeout() to indicate the result of
3163 * cfg80211_ops::assoc() call. This function may sleep.
3164 */
3165 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
3166 const u8 *buf, size_t len);
3167
3168 /**
3169 * cfg80211_send_assoc_timeout - notification of timed out association
3170 * @dev: network device
3171 * @addr: The MAC address of the device with which the association timed out
3172 *
3173 * This function may sleep.
3174 */
3175 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
3176
3177 /**
3178 * cfg80211_send_deauth - notification of processed deauthentication
3179 * @dev: network device
3180 * @buf: deauthentication frame (header + body)
3181 * @len: length of the frame data
3182 *
3183 * This function is called whenever deauthentication has been processed in
3184 * station mode. This includes both received deauthentication frames and
3185 * locally generated ones. This function may sleep.
3186 */
3187 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3188
3189 /**
3190 * __cfg80211_send_deauth - notification of processed deauthentication
3191 * @dev: network device
3192 * @buf: deauthentication frame (header + body)
3193 * @len: length of the frame data
3194 *
3195 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
3196 */
3197 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3198
3199 /**
3200 * cfg80211_send_disassoc - notification of processed disassociation
3201 * @dev: network device
3202 * @buf: disassociation response frame (header + body)
3203 * @len: length of the frame data
3204 *
3205 * This function is called whenever disassociation has been processed in
3206 * station mode. This includes both received disassociation frames and locally
3207 * generated ones. This function may sleep.
3208 */
3209 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
3210
3211 /**
3212 * __cfg80211_send_disassoc - notification of processed disassociation
3213 * @dev: network device
3214 * @buf: disassociation response frame (header + body)
3215 * @len: length of the frame data
3216 *
3217 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
3218 */
3219 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
3220 size_t len);
3221
3222 /**
3223 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
3224 * @dev: network device
3225 * @buf: deauthentication frame (header + body)
3226 * @len: length of the frame data
3227 *
3228 * This function is called whenever a received Deauthentication frame has been
3229 * dropped in station mode because of MFP being used but the Deauthentication
3230 * frame was not protected. This function may sleep.
3231 */
3232 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
3233 size_t len);
3234
3235 /**
3236 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
3237 * @dev: network device
3238 * @buf: disassociation frame (header + body)
3239 * @len: length of the frame data
3240 *
3241 * This function is called whenever a received Disassociation frame has been
3242 * dropped in station mode because of MFP being used but the Disassociation
3243 * frame was not protected. This function may sleep.
3244 */
3245 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
3246 size_t len);
3247
3248 /**
3249 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3250 * @dev: network device
3251 * @addr: The source MAC address of the frame
3252 * @key_type: The key type that the received frame used
3253 * @key_id: Key identifier (0..3). Can be -1 if missing.
3254 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3255 * @gfp: allocation flags
3256 *
3257 * This function is called whenever the local MAC detects a MIC failure in a
3258 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3259 * primitive.
3260 */
3261 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3262 enum nl80211_key_type key_type, int key_id,
3263 const u8 *tsc, gfp_t gfp);
3264
3265 /**
3266 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3267 *
3268 * @dev: network device
3269 * @bssid: the BSSID of the IBSS joined
3270 * @gfp: allocation flags
3271 *
3272 * This function notifies cfg80211 that the device joined an IBSS or
3273 * switched to a different BSSID. Before this function can be called,
3274 * either a beacon has to have been received from the IBSS, or one of
3275 * the cfg80211_inform_bss{,_frame} functions must have been called
3276 * with the locally generated beacon -- this guarantees that there is
3277 * always a scan result for this IBSS. cfg80211 will handle the rest.
3278 */
3279 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3280
3281 /**
3282 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3283 *
3284 * @dev: network device
3285 * @macaddr: the MAC address of the new candidate
3286 * @ie: information elements advertised by the peer candidate
3287 * @ie_len: lenght of the information elements buffer
3288 * @gfp: allocation flags
3289 *
3290 * This function notifies cfg80211 that the mesh peer candidate has been
3291 * detected, most likely via a beacon or, less likely, via a probe response.
3292 * cfg80211 then sends a notification to userspace.
3293 */
3294 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3295 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3296
3297 /**
3298 * DOC: RFkill integration
3299 *
3300 * RFkill integration in cfg80211 is almost invisible to drivers,
3301 * as cfg80211 automatically registers an rfkill instance for each
3302 * wireless device it knows about. Soft kill is also translated
3303 * into disconnecting and turning all interfaces off, drivers are
3304 * expected to turn off the device when all interfaces are down.
3305 *
3306 * However, devices may have a hard RFkill line, in which case they
3307 * also need to interact with the rfkill subsystem, via cfg80211.
3308 * They can do this with a few helper functions documented here.
3309 */
3310
3311 /**
3312 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3313 * @wiphy: the wiphy
3314 * @blocked: block status
3315 */
3316 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3317
3318 /**
3319 * wiphy_rfkill_start_polling - start polling rfkill
3320 * @wiphy: the wiphy
3321 */
3322 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3323
3324 /**
3325 * wiphy_rfkill_stop_polling - stop polling rfkill
3326 * @wiphy: the wiphy
3327 */
3328 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3329
3330 #ifdef CONFIG_NL80211_TESTMODE
3331 /**
3332 * DOC: Test mode
3333 *
3334 * Test mode is a set of utility functions to allow drivers to
3335 * interact with driver-specific tools to aid, for instance,
3336 * factory programming.
3337 *
3338 * This chapter describes how drivers interact with it, for more
3339 * information see the nl80211 book's chapter on it.
3340 */
3341
3342 /**
3343 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3344 * @wiphy: the wiphy
3345 * @approxlen: an upper bound of the length of the data that will
3346 * be put into the skb
3347 *
3348 * This function allocates and pre-fills an skb for a reply to
3349 * the testmode command. Since it is intended for a reply, calling
3350 * it outside of the @testmode_cmd operation is invalid.
3351 *
3352 * The returned skb is pre-filled with the wiphy index and set up in
3353 * a way that any data that is put into the skb (with skb_put(),
3354 * nla_put() or similar) will end up being within the
3355 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
3356 * with the skb is adding data for the corresponding userspace tool
3357 * which can then read that data out of the testdata attribute. You
3358 * must not modify the skb in any other way.
3359 *
3360 * When done, call cfg80211_testmode_reply() with the skb and return
3361 * its error code as the result of the @testmode_cmd operation.
3362 *
3363 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3364 */
3365 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3366 int approxlen);
3367
3368 /**
3369 * cfg80211_testmode_reply - send the reply skb
3370 * @skb: The skb, must have been allocated with
3371 * cfg80211_testmode_alloc_reply_skb()
3372 *
3373 * Since calling this function will usually be the last thing
3374 * before returning from the @testmode_cmd you should return
3375 * the error code. Note that this function consumes the skb
3376 * regardless of the return value.
3377 *
3378 * Return: An error code or 0 on success.
3379 */
3380 int cfg80211_testmode_reply(struct sk_buff *skb);
3381
3382 /**
3383 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3384 * @wiphy: the wiphy
3385 * @approxlen: an upper bound of the length of the data that will
3386 * be put into the skb
3387 * @gfp: allocation flags
3388 *
3389 * This function allocates and pre-fills an skb for an event on the
3390 * testmode multicast group.
3391 *
3392 * The returned skb is set up in the same way as with
3393 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
3394 * there, you should simply add data to it that will then end up in the
3395 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
3396 * in any other way.
3397 *
3398 * When done filling the skb, call cfg80211_testmode_event() with the
3399 * skb to send the event.
3400 *
3401 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3402 */
3403 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3404 int approxlen, gfp_t gfp);
3405
3406 /**
3407 * cfg80211_testmode_event - send the event
3408 * @skb: The skb, must have been allocated with
3409 * cfg80211_testmode_alloc_event_skb()
3410 * @gfp: allocation flags
3411 *
3412 * This function sends the given @skb, which must have been allocated
3413 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3414 * consumes it.
3415 */
3416 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3417
3418 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3419 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3420 #else
3421 #define CFG80211_TESTMODE_CMD(cmd)
3422 #define CFG80211_TESTMODE_DUMP(cmd)
3423 #endif
3424
3425 /**
3426 * cfg80211_connect_result - notify cfg80211 of connection result
3427 *
3428 * @dev: network device
3429 * @bssid: the BSSID of the AP
3430 * @req_ie: association request IEs (maybe be %NULL)
3431 * @req_ie_len: association request IEs length
3432 * @resp_ie: association response IEs (may be %NULL)
3433 * @resp_ie_len: assoc response IEs length
3434 * @status: status code, 0 for successful connection, use
3435 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3436 * the real status code for failures.
3437 * @gfp: allocation flags
3438 *
3439 * It should be called by the underlying driver whenever connect() has
3440 * succeeded.
3441 */
3442 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3443 const u8 *req_ie, size_t req_ie_len,
3444 const u8 *resp_ie, size_t resp_ie_len,
3445 u16 status, gfp_t gfp);
3446
3447 /**
3448 * cfg80211_roamed - notify cfg80211 of roaming
3449 *
3450 * @dev: network device
3451 * @channel: the channel of the new AP
3452 * @bssid: the BSSID of the new AP
3453 * @req_ie: association request IEs (maybe be %NULL)
3454 * @req_ie_len: association request IEs length
3455 * @resp_ie: association response IEs (may be %NULL)
3456 * @resp_ie_len: assoc response IEs length
3457 * @gfp: allocation flags
3458 *
3459 * It should be called by the underlying driver whenever it roamed
3460 * from one AP to another while connected.
3461 */
3462 void cfg80211_roamed(struct net_device *dev,
3463 struct ieee80211_channel *channel,
3464 const u8 *bssid,
3465 const u8 *req_ie, size_t req_ie_len,
3466 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3467
3468 /**
3469 * cfg80211_roamed_bss - notify cfg80211 of roaming
3470 *
3471 * @dev: network device
3472 * @bss: entry of bss to which STA got roamed
3473 * @req_ie: association request IEs (maybe be %NULL)
3474 * @req_ie_len: association request IEs length
3475 * @resp_ie: association response IEs (may be %NULL)
3476 * @resp_ie_len: assoc response IEs length
3477 * @gfp: allocation flags
3478 *
3479 * This is just a wrapper to notify cfg80211 of roaming event with driver
3480 * passing bss to avoid a race in timeout of the bss entry. It should be
3481 * called by the underlying driver whenever it roamed from one AP to another
3482 * while connected. Drivers which have roaming implemented in firmware
3483 * may use this function to avoid a race in bss entry timeout where the bss
3484 * entry of the new AP is seen in the driver, but gets timed out by the time
3485 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3486 * rdev->event_work. In case of any failures, the reference is released
3487 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3488 * it will be released while diconneting from the current bss.
3489 */
3490 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3491 const u8 *req_ie, size_t req_ie_len,
3492 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3493
3494 /**
3495 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3496 *
3497 * @dev: network device
3498 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3499 * @ie_len: length of IEs
3500 * @reason: reason code for the disconnection, set it to 0 if unknown
3501 * @gfp: allocation flags
3502 *
3503 * After it calls this function, the driver should enter an idle state
3504 * and not try to connect to any AP any more.
3505 */
3506 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3507 u8 *ie, size_t ie_len, gfp_t gfp);
3508
3509 /**
3510 * cfg80211_ready_on_channel - notification of remain_on_channel start
3511 * @wdev: wireless device
3512 * @cookie: the request cookie
3513 * @chan: The current channel (from remain_on_channel request)
3514 * @duration: Duration in milliseconds that the driver intents to remain on the
3515 * channel
3516 * @gfp: allocation flags
3517 */
3518 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
3519 struct ieee80211_channel *chan,
3520 unsigned int duration, gfp_t gfp);
3521
3522 /**
3523 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3524 * @wdev: wireless device
3525 * @cookie: the request cookie
3526 * @chan: The current channel (from remain_on_channel request)
3527 * @gfp: allocation flags
3528 */
3529 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
3530 struct ieee80211_channel *chan,
3531 gfp_t gfp);
3532
3533
3534 /**
3535 * cfg80211_new_sta - notify userspace about station
3536 *
3537 * @dev: the netdev
3538 * @mac_addr: the station's address
3539 * @sinfo: the station information
3540 * @gfp: allocation flags
3541 */
3542 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3543 struct station_info *sinfo, gfp_t gfp);
3544
3545 /**
3546 * cfg80211_del_sta - notify userspace about deletion of a station
3547 *
3548 * @dev: the netdev
3549 * @mac_addr: the station's address
3550 * @gfp: allocation flags
3551 */
3552 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3553
3554 /**
3555 * cfg80211_conn_failed - connection request failed notification
3556 *
3557 * @dev: the netdev
3558 * @mac_addr: the station's address
3559 * @reason: the reason for connection failure
3560 * @gfp: allocation flags
3561 *
3562 * Whenever a station tries to connect to an AP and if the station
3563 * could not connect to the AP as the AP has rejected the connection
3564 * for some reasons, this function is called.
3565 *
3566 * The reason for connection failure can be any of the value from
3567 * nl80211_connect_failed_reason enum
3568 */
3569 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
3570 enum nl80211_connect_failed_reason reason,
3571 gfp_t gfp);
3572
3573 /**
3574 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3575 * @wdev: wireless device receiving the frame
3576 * @freq: Frequency on which the frame was received in MHz
3577 * @sig_dbm: signal strength in mBm, or 0 if unknown
3578 * @buf: Management frame (header + body)
3579 * @len: length of the frame data
3580 * @gfp: context flags
3581 *
3582 * This function is called whenever an Action frame is received for a station
3583 * mode interface, but is not processed in kernel.
3584 *
3585 * Return: %true if a user space application has registered for this frame.
3586 * For action frames, that makes it responsible for rejecting unrecognized
3587 * action frames; %false otherwise, in which case for action frames the
3588 * driver is responsible for rejecting the frame.
3589 */
3590 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
3591 const u8 *buf, size_t len, gfp_t gfp);
3592
3593 /**
3594 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3595 * @wdev: wireless device receiving the frame
3596 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3597 * @buf: Management frame (header + body)
3598 * @len: length of the frame data
3599 * @ack: Whether frame was acknowledged
3600 * @gfp: context flags
3601 *
3602 * This function is called whenever a management frame was requested to be
3603 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3604 * transmission attempt.
3605 */
3606 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
3607 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3608
3609
3610 /**
3611 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3612 * @dev: network device
3613 * @rssi_event: the triggered RSSI event
3614 * @gfp: context flags
3615 *
3616 * This function is called when a configured connection quality monitoring
3617 * rssi threshold reached event occurs.
3618 */
3619 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3620 enum nl80211_cqm_rssi_threshold_event rssi_event,
3621 gfp_t gfp);
3622
3623 /**
3624 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3625 * @dev: network device
3626 * @peer: peer's MAC address
3627 * @num_packets: how many packets were lost -- should be a fixed threshold
3628 * but probably no less than maybe 50, or maybe a throughput dependent
3629 * threshold (to account for temporary interference)
3630 * @gfp: context flags
3631 */
3632 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3633 const u8 *peer, u32 num_packets, gfp_t gfp);
3634
3635 /**
3636 * cfg80211_cqm_txe_notify - TX error rate event
3637 * @dev: network device
3638 * @peer: peer's MAC address
3639 * @num_packets: how many packets were lost
3640 * @rate: % of packets which failed transmission
3641 * @intvl: interval (in s) over which the TX failure threshold was breached.
3642 * @gfp: context flags
3643 *
3644 * Notify userspace when configured % TX failures over number of packets in a
3645 * given interval is exceeded.
3646 */
3647 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
3648 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
3649
3650 /**
3651 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3652 * @dev: network device
3653 * @bssid: BSSID of AP (to avoid races)
3654 * @replay_ctr: new replay counter
3655 * @gfp: allocation flags
3656 */
3657 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3658 const u8 *replay_ctr, gfp_t gfp);
3659
3660 /**
3661 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3662 * @dev: network device
3663 * @index: candidate index (the smaller the index, the higher the priority)
3664 * @bssid: BSSID of AP
3665 * @preauth: Whether AP advertises support for RSN pre-authentication
3666 * @gfp: allocation flags
3667 */
3668 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3669 const u8 *bssid, bool preauth, gfp_t gfp);
3670
3671 /**
3672 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3673 * @dev: The device the frame matched to
3674 * @addr: the transmitter address
3675 * @gfp: context flags
3676 *
3677 * This function is used in AP mode (only!) to inform userspace that
3678 * a spurious class 3 frame was received, to be able to deauth the
3679 * sender.
3680 * Return: %true if the frame was passed to userspace (or this failed
3681 * for a reason other than not having a subscription.)
3682 */
3683 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3684 const u8 *addr, gfp_t gfp);
3685
3686 /**
3687 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3688 * @dev: The device the frame matched to
3689 * @addr: the transmitter address
3690 * @gfp: context flags
3691 *
3692 * This function is used in AP mode (only!) to inform userspace that
3693 * an associated station sent a 4addr frame but that wasn't expected.
3694 * It is allowed and desirable to send this event only once for each
3695 * station to avoid event flooding.
3696 * Return: %true if the frame was passed to userspace (or this failed
3697 * for a reason other than not having a subscription.)
3698 */
3699 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3700 const u8 *addr, gfp_t gfp);
3701
3702 /**
3703 * cfg80211_probe_status - notify userspace about probe status
3704 * @dev: the device the probe was sent on
3705 * @addr: the address of the peer
3706 * @cookie: the cookie filled in @probe_client previously
3707 * @acked: indicates whether probe was acked or not
3708 * @gfp: allocation flags
3709 */
3710 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3711 u64 cookie, bool acked, gfp_t gfp);
3712
3713 /**
3714 * cfg80211_report_obss_beacon - report beacon from other APs
3715 * @wiphy: The wiphy that received the beacon
3716 * @frame: the frame
3717 * @len: length of the frame
3718 * @freq: frequency the frame was received on
3719 * @sig_dbm: signal strength in mBm, or 0 if unknown
3720 *
3721 * Use this function to report to userspace when a beacon was
3722 * received. It is not useful to call this when there is no
3723 * netdev that is in AP/GO mode.
3724 */
3725 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3726 const u8 *frame, size_t len,
3727 int freq, int sig_dbm);
3728
3729 /**
3730 * cfg80211_reg_can_beacon - check if beaconing is allowed
3731 * @wiphy: the wiphy
3732 * @chandef: the channel definition
3733 *
3734 * Return: %true if there is no secondary channel or the secondary channel(s)
3735 * can be used for beaconing (i.e. is not a radar channel etc.)
3736 */
3737 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
3738 struct cfg80211_chan_def *chandef);
3739
3740 /*
3741 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
3742 * @dev: the device which switched channels
3743 * @chandef: the new channel definition
3744 *
3745 * Acquires wdev_lock, so must only be called from sleepable driver context!
3746 */
3747 void cfg80211_ch_switch_notify(struct net_device *dev,
3748 struct cfg80211_chan_def *chandef);
3749
3750 /*
3751 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
3752 * @dev: the device on which the operation is requested
3753 * @peer: the MAC address of the peer device
3754 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
3755 * NL80211_TDLS_TEARDOWN)
3756 * @reason_code: the reason code for teardown request
3757 * @gfp: allocation flags
3758 *
3759 * This function is used to request userspace to perform TDLS operation that
3760 * requires knowledge of keys, i.e., link setup or teardown when the AP
3761 * connection uses encryption. This is optional mechanism for the driver to use
3762 * if it can automatically determine when a TDLS link could be useful (e.g.,
3763 * based on traffic and signal strength for a peer).
3764 */
3765 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
3766 enum nl80211_tdls_operation oper,
3767 u16 reason_code, gfp_t gfp);
3768
3769 /*
3770 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
3771 * @rate: given rate_info to calculate bitrate from
3772 *
3773 * return 0 if MCS index >= 32
3774 */
3775 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
3776
3777 /**
3778 * cfg80211_unregister_wdev - remove the given wdev
3779 * @wdev: struct wireless_dev to remove
3780 *
3781 * Call this function only for wdevs that have no netdev assigned,
3782 * e.g. P2P Devices. It removes the device from the list so that
3783 * it can no longer be used. It is necessary to call this function
3784 * even when cfg80211 requests the removal of the interface by
3785 * calling the del_virtual_intf() callback. The function must also
3786 * be called when the driver wishes to unregister the wdev, e.g.
3787 * when the device is unbound from the driver.
3788 *
3789 * Requires the RTNL to be held.
3790 */
3791 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
3792
3793 /**
3794 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
3795 * @ies: the input IE buffer
3796 * @len: the input length
3797 * @attr: the attribute ID to find
3798 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
3799 * if the function is only called to get the needed buffer size
3800 * @bufsize: size of the output buffer
3801 *
3802 * The function finds a given P2P attribute in the (vendor) IEs and
3803 * copies its contents to the given buffer.
3804 *
3805 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
3806 * malformed or the attribute can't be found (respectively), or the
3807 * length of the found attribute (which can be zero).
3808 */
3809 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
3810 enum ieee80211_p2p_attr_id attr,
3811 u8 *buf, unsigned int bufsize);
3812
3813 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3814
3815 /* wiphy_printk helpers, similar to dev_printk */
3816
3817 #define wiphy_printk(level, wiphy, format, args...) \
3818 dev_printk(level, &(wiphy)->dev, format, ##args)
3819 #define wiphy_emerg(wiphy, format, args...) \
3820 dev_emerg(&(wiphy)->dev, format, ##args)
3821 #define wiphy_alert(wiphy, format, args...) \
3822 dev_alert(&(wiphy)->dev, format, ##args)
3823 #define wiphy_crit(wiphy, format, args...) \
3824 dev_crit(&(wiphy)->dev, format, ##args)
3825 #define wiphy_err(wiphy, format, args...) \
3826 dev_err(&(wiphy)->dev, format, ##args)
3827 #define wiphy_warn(wiphy, format, args...) \
3828 dev_warn(&(wiphy)->dev, format, ##args)
3829 #define wiphy_notice(wiphy, format, args...) \
3830 dev_notice(&(wiphy)->dev, format, ##args)
3831 #define wiphy_info(wiphy, format, args...) \
3832 dev_info(&(wiphy)->dev, format, ##args)
3833
3834 #define wiphy_debug(wiphy, format, args...) \
3835 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3836
3837 #define wiphy_dbg(wiphy, format, args...) \
3838 dev_dbg(&(wiphy)->dev, format, ##args)
3839
3840 #if defined(VERBOSE_DEBUG)
3841 #define wiphy_vdbg wiphy_dbg
3842 #else
3843 #define wiphy_vdbg(wiphy, format, args...) \
3844 ({ \
3845 if (0) \
3846 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3847 0; \
3848 })
3849 #endif
3850
3851 /*
3852 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3853 * of using a WARN/WARN_ON to get the message out, including the
3854 * file/line information and a backtrace.
3855 */
3856 #define wiphy_WARN(wiphy, format, args...) \
3857 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3858
3859 #endif /* __NET_CFG80211_H */