]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/cfg80211.h
cfg80211: docbook: fix small formatting error
[mirror_ubuntu-bionic-kernel.git] / include / net / cfg80211.h
CommitLineData
704232c2
JB
1#ifndef __NET_CFG80211_H
2#define __NET_CFG80211_H
d3236553
JB
3/*
4 * 802.11 device and configuration interface
5 *
026331c4 6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
d3236553
JB
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 */
704232c2 12
d3236553
JB
13#include <linux/netdevice.h>
14#include <linux/debugfs.h>
15#include <linux/list.h>
187f1882 16#include <linux/bug.h>
704232c2
JB
17#include <linux/netlink.h>
18#include <linux/skbuff.h>
55682965 19#include <linux/nl80211.h>
2a519311
JB
20#include <linux/if_ether.h>
21#include <linux/ieee80211.h>
2a0e047e 22#include <linux/net.h>
d3236553
JB
23#include <net/regulatory.h>
24
d70e9693
JB
25/**
26 * DOC: Introduction
27 *
28 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29 * userspace and drivers, and offers some utility functionality associated
30 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31 * by all modern wireless drivers in Linux, so that they offer a consistent
32 * API through nl80211. For backward compatibility, cfg80211 also offers
33 * wireless extensions to userspace, but hides them from drivers completely.
34 *
35 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
36 * use restrictions.
37 */
38
39
40/**
41 * DOC: Device registration
42 *
43 * In order for a driver to use cfg80211, it must register the hardware device
44 * with cfg80211. This happens through a number of hardware capability structs
45 * described below.
46 *
47 * The fundamental structure for each device is the 'wiphy', of which each
48 * instance describes a physical wireless device connected to the system. Each
49 * such wiphy can have zero, one, or many virtual interfaces associated with
50 * it, which need to be identified as such by pointing the network interface's
51 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52 * the wireless part of the interface, normally this struct is embedded in the
53 * network interface's private data area. Drivers can optionally allow creating
54 * or destroying virtual interfaces on the fly, but without at least one or the
55 * ability to create some the wireless device isn't useful.
56 *
57 * Each wiphy structure contains device capability information, and also has
58 * a pointer to the various operations the driver offers. The definitions and
59 * structures here describe these capabilities in detail.
60 */
61
9f5e8f6e
JB
62struct wiphy;
63
704232c2 64/*
d3236553
JB
65 * wireless hardware capability structures
66 */
67
68/**
69 * enum ieee80211_band - supported frequency bands
70 *
71 * The bands are assigned this way because the supported
72 * bitrates differ in these bands.
704232c2 73 *
d3236553
JB
74 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
75 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
3a0c52a6 76 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
abe37c4b 77 * @IEEE80211_NUM_BANDS: number of defined bands
704232c2 78 */
d3236553 79enum ieee80211_band {
13ae75b1
JM
80 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
3a0c52a6 82 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
d3236553
JB
83
84 /* keep last */
85 IEEE80211_NUM_BANDS
86};
704232c2 87
2ec600d6 88/**
d3236553
JB
89 * enum ieee80211_channel_flags - channel flags
90 *
91 * Channel flags set by the regulatory control code.
92 *
93 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
8fe02e16
LR
94 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
95 * sending probe requests or beaconing.
d3236553 96 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
689da1b3 97 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
d3236553 98 * is not permitted.
689da1b3 99 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
d3236553 100 * is not permitted.
03f6b084 101 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
c7a6ee27
JB
102 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
103 * this flag indicates that an 80 MHz channel cannot use this
104 * channel as the control or any of the secondary channels.
105 * This may be due to the driver or due to regulatory bandwidth
106 * restrictions.
107 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
108 * this flag indicates that an 160 MHz channel cannot use this
109 * channel as the control or any of the secondary channels.
110 * This may be due to the driver or due to regulatory bandwidth
111 * restrictions.
2ec600d6 112 */
d3236553
JB
113enum ieee80211_channel_flags {
114 IEEE80211_CHAN_DISABLED = 1<<0,
8fe02e16
LR
115 IEEE80211_CHAN_NO_IR = 1<<1,
116 /* hole at 1<<2 */
d3236553 117 IEEE80211_CHAN_RADAR = 1<<3,
689da1b3
LR
118 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
119 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
03f6b084 120 IEEE80211_CHAN_NO_OFDM = 1<<6,
c7a6ee27
JB
121 IEEE80211_CHAN_NO_80MHZ = 1<<7,
122 IEEE80211_CHAN_NO_160MHZ = 1<<8,
2ec600d6
LCC
123};
124
038659e7 125#define IEEE80211_CHAN_NO_HT40 \
689da1b3 126 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
038659e7 127
04f39047
SW
128#define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
129#define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
130
d3236553
JB
131/**
132 * struct ieee80211_channel - channel definition
133 *
134 * This structure describes a single channel for use
135 * with cfg80211.
136 *
137 * @center_freq: center frequency in MHz
d3236553
JB
138 * @hw_value: hardware-specific value for the channel
139 * @flags: channel flags from &enum ieee80211_channel_flags.
140 * @orig_flags: channel flags at registration time, used by regulatory
141 * code to support devices with additional restrictions
142 * @band: band this channel belongs to.
143 * @max_antenna_gain: maximum antenna gain in dBi
144 * @max_power: maximum transmission power (in dBm)
eccc068e 145 * @max_reg_power: maximum regulatory transmission power (in dBm)
d3236553
JB
146 * @beacon_found: helper to regulatory code to indicate when a beacon
147 * has been found on this channel. Use regulatory_hint_found_beacon()
77c2061d 148 * to enable this, this is useful only on 5 GHz band.
d3236553
JB
149 * @orig_mag: internal use
150 * @orig_mpwr: internal use
04f39047
SW
151 * @dfs_state: current state of this channel. Only relevant if radar is required
152 * on this channel.
153 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
179f831b 154 */
d3236553
JB
155struct ieee80211_channel {
156 enum ieee80211_band band;
157 u16 center_freq;
d3236553
JB
158 u16 hw_value;
159 u32 flags;
160 int max_antenna_gain;
161 int max_power;
eccc068e 162 int max_reg_power;
d3236553
JB
163 bool beacon_found;
164 u32 orig_flags;
165 int orig_mag, orig_mpwr;
04f39047
SW
166 enum nl80211_dfs_state dfs_state;
167 unsigned long dfs_state_entered;
d3236553
JB
168};
169
179f831b 170/**
d3236553
JB
171 * enum ieee80211_rate_flags - rate flags
172 *
173 * Hardware/specification flags for rates. These are structured
174 * in a way that allows using the same bitrate structure for
175 * different bands/PHY modes.
176 *
177 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
178 * preamble on this bitrate; only relevant in 2.4GHz band and
179 * with CCK rates.
180 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
181 * when used with 802.11a (on the 5 GHz band); filled by the
182 * core code when registering the wiphy.
183 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
184 * when used with 802.11b (on the 2.4 GHz band); filled by the
185 * core code when registering the wiphy.
186 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
187 * when used with 802.11g (on the 2.4 GHz band); filled by the
188 * core code when registering the wiphy.
189 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
30e74732
SW
190 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
191 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
179f831b 192 */
d3236553
JB
193enum ieee80211_rate_flags {
194 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
195 IEEE80211_RATE_MANDATORY_A = 1<<1,
196 IEEE80211_RATE_MANDATORY_B = 1<<2,
197 IEEE80211_RATE_MANDATORY_G = 1<<3,
198 IEEE80211_RATE_ERP_G = 1<<4,
30e74732
SW
199 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
200 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
d3236553 201};
179f831b 202
d3236553
JB
203/**
204 * struct ieee80211_rate - bitrate definition
205 *
206 * This structure describes a bitrate that an 802.11 PHY can
207 * operate with. The two values @hw_value and @hw_value_short
208 * are only for driver use when pointers to this structure are
209 * passed around.
210 *
211 * @flags: rate-specific flags
212 * @bitrate: bitrate in units of 100 Kbps
213 * @hw_value: driver/hardware value for this rate
214 * @hw_value_short: driver/hardware value for this rate when
215 * short preamble is used
216 */
217struct ieee80211_rate {
218 u32 flags;
219 u16 bitrate;
220 u16 hw_value, hw_value_short;
221};
179f831b 222
d3236553
JB
223/**
224 * struct ieee80211_sta_ht_cap - STA's HT capabilities
225 *
226 * This structure describes most essential parameters needed
227 * to describe 802.11n HT capabilities for an STA.
228 *
229 * @ht_supported: is HT supported by the STA
230 * @cap: HT capabilities map as described in 802.11n spec
231 * @ampdu_factor: Maximum A-MPDU length factor
232 * @ampdu_density: Minimum A-MPDU spacing
233 * @mcs: Supported MCS rates
234 */
235struct ieee80211_sta_ht_cap {
236 u16 cap; /* use IEEE80211_HT_CAP_ */
237 bool ht_supported;
238 u8 ampdu_factor;
239 u8 ampdu_density;
240 struct ieee80211_mcs_info mcs;
179f831b
AG
241};
242
bf0c111e
MP
243/**
244 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
245 *
246 * This structure describes most essential parameters needed
247 * to describe 802.11ac VHT capabilities for an STA.
248 *
249 * @vht_supported: is VHT supported by the STA
250 * @cap: VHT capabilities map as described in 802.11ac spec
251 * @vht_mcs: Supported VHT MCS rates
252 */
253struct ieee80211_sta_vht_cap {
254 bool vht_supported;
255 u32 cap; /* use IEEE80211_VHT_CAP_ */
256 struct ieee80211_vht_mcs_info vht_mcs;
257};
258
d3236553
JB
259/**
260 * struct ieee80211_supported_band - frequency band definition
261 *
262 * This structure describes a frequency band a wiphy
263 * is able to operate in.
264 *
265 * @channels: Array of channels the hardware can operate in
266 * in this band.
267 * @band: the band this structure represents
268 * @n_channels: Number of channels in @channels
269 * @bitrates: Array of bitrates the hardware can operate with
270 * in this band. Must be sorted to give a valid "supported
271 * rates" IE, i.e. CCK rates first, then OFDM.
272 * @n_bitrates: Number of bitrates in @bitrates
abe37c4b 273 * @ht_cap: HT capabilities in this band
c9a0a302 274 * @vht_cap: VHT capabilities in this band
d3236553
JB
275 */
276struct ieee80211_supported_band {
277 struct ieee80211_channel *channels;
278 struct ieee80211_rate *bitrates;
279 enum ieee80211_band band;
280 int n_channels;
281 int n_bitrates;
282 struct ieee80211_sta_ht_cap ht_cap;
bf0c111e 283 struct ieee80211_sta_vht_cap vht_cap;
d3236553 284};
179f831b 285
d3236553
JB
286/*
287 * Wireless hardware/device configuration structures and methods
288 */
179f831b 289
d70e9693
JB
290/**
291 * DOC: Actions and configuration
292 *
293 * Each wireless device and each virtual interface offer a set of configuration
294 * operations and other actions that are invoked by userspace. Each of these
295 * actions is described in the operations structure, and the parameters these
296 * operations use are described separately.
297 *
298 * Additionally, some operations are asynchronous and expect to get status
299 * information via some functions that drivers need to call.
300 *
301 * Scanning and BSS list handling with its associated functionality is described
302 * in a separate chapter.
303 */
304
d3236553
JB
305/**
306 * struct vif_params - describes virtual interface parameters
8b787643 307 * @use_4addr: use 4-address frames
1c18f145
AS
308 * @macaddr: address to use for this virtual interface. This will only
309 * be used for non-netdevice interfaces. If this parameter is set
310 * to zero address the driver may determine the address as needed.
d3236553
JB
311 */
312struct vif_params {
8b787643 313 int use_4addr;
1c18f145 314 u8 macaddr[ETH_ALEN];
d3236553 315};
179f831b 316
d3236553 317/**
41ade00f
JB
318 * struct key_params - key information
319 *
320 * Information about a key
321 *
322 * @key: key material
323 * @key_len: length of key material
324 * @cipher: cipher suite selector
325 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
326 * with the get_key() callback, must be in little endian,
327 * length given by @seq_len.
abe37c4b 328 * @seq_len: length of @seq.
41ade00f
JB
329 */
330struct key_params {
331 u8 *key;
332 u8 *seq;
333 int key_len;
334 int seq_len;
335 u32 cipher;
336};
337
683b6d3b
JB
338/**
339 * struct cfg80211_chan_def - channel definition
340 * @chan: the (control) channel
3d9d1d66
JB
341 * @width: channel width
342 * @center_freq1: center frequency of first segment
343 * @center_freq2: center frequency of second segment
344 * (only with 80+80 MHz)
683b6d3b
JB
345 */
346struct cfg80211_chan_def {
347 struct ieee80211_channel *chan;
3d9d1d66
JB
348 enum nl80211_chan_width width;
349 u32 center_freq1;
350 u32 center_freq2;
683b6d3b
JB
351};
352
3d9d1d66
JB
353/**
354 * cfg80211_get_chandef_type - return old channel type from chandef
355 * @chandef: the channel definition
356 *
0ae997dc 357 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
3d9d1d66
JB
358 * chandef, which must have a bandwidth allowing this conversion.
359 */
683b6d3b
JB
360static inline enum nl80211_channel_type
361cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
362{
3d9d1d66
JB
363 switch (chandef->width) {
364 case NL80211_CHAN_WIDTH_20_NOHT:
365 return NL80211_CHAN_NO_HT;
366 case NL80211_CHAN_WIDTH_20:
367 return NL80211_CHAN_HT20;
368 case NL80211_CHAN_WIDTH_40:
369 if (chandef->center_freq1 > chandef->chan->center_freq)
370 return NL80211_CHAN_HT40PLUS;
371 return NL80211_CHAN_HT40MINUS;
372 default:
373 WARN_ON(1);
374 return NL80211_CHAN_NO_HT;
375 }
683b6d3b
JB
376}
377
3d9d1d66
JB
378/**
379 * cfg80211_chandef_create - create channel definition using channel type
380 * @chandef: the channel definition struct to fill
381 * @channel: the control channel
382 * @chantype: the channel type
383 *
384 * Given a channel type, create a channel definition.
385 */
386void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
387 struct ieee80211_channel *channel,
388 enum nl80211_channel_type chantype);
389
390/**
391 * cfg80211_chandef_identical - check if two channel definitions are identical
392 * @chandef1: first channel definition
393 * @chandef2: second channel definition
394 *
0ae997dc 395 * Return: %true if the channels defined by the channel definitions are
3d9d1d66
JB
396 * identical, %false otherwise.
397 */
398static inline bool
399cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
400 const struct cfg80211_chan_def *chandef2)
401{
402 return (chandef1->chan == chandef2->chan &&
403 chandef1->width == chandef2->width &&
404 chandef1->center_freq1 == chandef2->center_freq1 &&
405 chandef1->center_freq2 == chandef2->center_freq2);
406}
407
408/**
409 * cfg80211_chandef_compatible - check if two channel definitions are compatible
410 * @chandef1: first channel definition
411 * @chandef2: second channel definition
412 *
0ae997dc 413 * Return: %NULL if the given channel definitions are incompatible,
3d9d1d66
JB
414 * chandef1 or chandef2 otherwise.
415 */
416const struct cfg80211_chan_def *
417cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
418 const struct cfg80211_chan_def *chandef2);
419
9f5e8f6e
JB
420/**
421 * cfg80211_chandef_valid - check if a channel definition is valid
422 * @chandef: the channel definition to check
0ae997dc 423 * Return: %true if the channel definition is valid. %false otherwise.
9f5e8f6e
JB
424 */
425bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
426
427/**
428 * cfg80211_chandef_usable - check if secondary channels can be used
429 * @wiphy: the wiphy to validate against
430 * @chandef: the channel definition to check
0ae997dc
YB
431 * @prohibited_flags: the regulatory channel flags that must not be set
432 * Return: %true if secondary channels are usable. %false otherwise.
9f5e8f6e
JB
433 */
434bool cfg80211_chandef_usable(struct wiphy *wiphy,
435 const struct cfg80211_chan_def *chandef,
436 u32 prohibited_flags);
437
774f0734
SW
438/**
439 * cfg80211_chandef_dfs_required - checks if radar detection is required
440 * @wiphy: the wiphy to validate against
441 * @chandef: the channel definition to check
442 * Return: 1 if radar detection is required, 0 if it is not, < 0 on error
443 */
444int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
445 const struct cfg80211_chan_def *chandef);
446
30e74732
SW
447/**
448 * ieee80211_chandef_rate_flags - returns rate flags for a channel
449 *
450 * In some channel types, not all rates may be used - for example CCK
451 * rates may not be used in 5/10 MHz channels.
452 *
453 * @chandef: channel definition for the channel
454 *
455 * Returns: rate flags which apply for this channel
456 */
457static inline enum ieee80211_rate_flags
458ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
459{
460 switch (chandef->width) {
461 case NL80211_CHAN_WIDTH_5:
462 return IEEE80211_RATE_SUPPORTS_5MHZ;
463 case NL80211_CHAN_WIDTH_10:
464 return IEEE80211_RATE_SUPPORTS_10MHZ;
465 default:
466 break;
467 }
468 return 0;
469}
470
0430c883
SW
471/**
472 * ieee80211_chandef_max_power - maximum transmission power for the chandef
473 *
474 * In some regulations, the transmit power may depend on the configured channel
475 * bandwidth which may be defined as dBm/MHz. This function returns the actual
476 * max_power for non-standard (20 MHz) channels.
477 *
478 * @chandef: channel definition for the channel
479 *
480 * Returns: maximum allowed transmission power in dBm for the chandef
481 */
482static inline int
483ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
484{
485 switch (chandef->width) {
486 case NL80211_CHAN_WIDTH_5:
487 return min(chandef->chan->max_reg_power - 6,
488 chandef->chan->max_power);
489 case NL80211_CHAN_WIDTH_10:
490 return min(chandef->chan->max_reg_power - 3,
491 chandef->chan->max_power);
492 default:
493 break;
494 }
495 return chandef->chan->max_power;
496}
497
61fa713c
HS
498/**
499 * enum survey_info_flags - survey information flags
500 *
abe37c4b 501 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
17e5a808 502 * @SURVEY_INFO_IN_USE: channel is currently being used
8610c29a
FF
503 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
504 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
505 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
506 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
507 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
abe37c4b 508 *
61fa713c
HS
509 * Used by the driver to indicate which info in &struct survey_info
510 * it has filled in during the get_survey().
511 */
512enum survey_info_flags {
513 SURVEY_INFO_NOISE_DBM = 1<<0,
17e5a808 514 SURVEY_INFO_IN_USE = 1<<1,
8610c29a
FF
515 SURVEY_INFO_CHANNEL_TIME = 1<<2,
516 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
517 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
518 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
519 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
61fa713c
HS
520};
521
522/**
523 * struct survey_info - channel survey response
524 *
61fa713c
HS
525 * @channel: the channel this survey record reports, mandatory
526 * @filled: bitflag of flags from &enum survey_info_flags
527 * @noise: channel noise in dBm. This and all following fields are
ad24b0da 528 * optional
8610c29a
FF
529 * @channel_time: amount of time in ms the radio spent on the channel
530 * @channel_time_busy: amount of time the primary channel was sensed busy
531 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
532 * @channel_time_rx: amount of time the radio spent receiving data
533 * @channel_time_tx: amount of time the radio spent transmitting data
61fa713c 534 *
abe37c4b
JB
535 * Used by dump_survey() to report back per-channel survey information.
536 *
61fa713c
HS
537 * This structure can later be expanded with things like
538 * channel duty cycle etc.
539 */
540struct survey_info {
541 struct ieee80211_channel *channel;
8610c29a
FF
542 u64 channel_time;
543 u64 channel_time_busy;
544 u64 channel_time_ext_busy;
545 u64 channel_time_rx;
546 u64 channel_time_tx;
61fa713c
HS
547 u32 filled;
548 s8 noise;
549};
550
5fb628e9
JM
551/**
552 * struct cfg80211_crypto_settings - Crypto settings
553 * @wpa_versions: indicates which, if any, WPA versions are enabled
554 * (from enum nl80211_wpa_versions)
555 * @cipher_group: group key cipher suite (or 0 if unset)
556 * @n_ciphers_pairwise: number of AP supported unicast ciphers
557 * @ciphers_pairwise: unicast key cipher suites
558 * @n_akm_suites: number of AKM suites
559 * @akm_suites: AKM suites
560 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
561 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
562 * required to assume that the port is unauthorized until authorized by
563 * user space. Otherwise, port is marked authorized by default.
564 * @control_port_ethertype: the control port protocol that should be
565 * allowed through even on unauthorized ports
566 * @control_port_no_encrypt: TRUE to prevent encryption of control port
567 * protocol frames.
568 */
569struct cfg80211_crypto_settings {
570 u32 wpa_versions;
571 u32 cipher_group;
572 int n_ciphers_pairwise;
573 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
574 int n_akm_suites;
575 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
576 bool control_port;
577 __be16 control_port_ethertype;
578 bool control_port_no_encrypt;
579};
580
ed1b6cc7 581/**
8860020e 582 * struct cfg80211_beacon_data - beacon data
ed1b6cc7 583 * @head: head portion of beacon (before TIM IE)
ad24b0da 584 * or %NULL if not changed
ed1b6cc7 585 * @tail: tail portion of beacon (after TIM IE)
ad24b0da 586 * or %NULL if not changed
ed1b6cc7
JB
587 * @head_len: length of @head
588 * @tail_len: length of @tail
9946ecfb
JM
589 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
590 * @beacon_ies_len: length of beacon_ies in octets
591 * @proberesp_ies: extra information element(s) to add into Probe Response
592 * frames or %NULL
593 * @proberesp_ies_len: length of proberesp_ies in octets
594 * @assocresp_ies: extra information element(s) to add into (Re)Association
595 * Response frames or %NULL
596 * @assocresp_ies_len: length of assocresp_ies in octets
00f740e1
AN
597 * @probe_resp_len: length of probe response template (@probe_resp)
598 * @probe_resp: probe response template (AP mode only)
ed1b6cc7 599 */
8860020e
JB
600struct cfg80211_beacon_data {
601 const u8 *head, *tail;
602 const u8 *beacon_ies;
603 const u8 *proberesp_ies;
604 const u8 *assocresp_ies;
605 const u8 *probe_resp;
606
607 size_t head_len, tail_len;
608 size_t beacon_ies_len;
609 size_t proberesp_ies_len;
610 size_t assocresp_ies_len;
611 size_t probe_resp_len;
612};
613
6d45a74b
VT
614struct mac_address {
615 u8 addr[ETH_ALEN];
616};
617
77765eaf
VT
618/**
619 * struct cfg80211_acl_data - Access control list data
620 *
621 * @acl_policy: ACL policy to be applied on the station's
077f897a 622 * entry specified by mac_addr
77765eaf
VT
623 * @n_acl_entries: Number of MAC address entries passed
624 * @mac_addrs: List of MAC addresses of stations to be used for ACL
625 */
626struct cfg80211_acl_data {
627 enum nl80211_acl_policy acl_policy;
628 int n_acl_entries;
629
630 /* Keep it last */
631 struct mac_address mac_addrs[];
632};
633
8860020e
JB
634/**
635 * struct cfg80211_ap_settings - AP configuration
636 *
637 * Used to configure an AP interface.
638 *
683b6d3b 639 * @chandef: defines the channel to use
8860020e
JB
640 * @beacon: beacon data
641 * @beacon_interval: beacon interval
642 * @dtim_period: DTIM period
643 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
644 * user space)
645 * @ssid_len: length of @ssid
646 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
647 * @crypto: crypto settings
648 * @privacy: the BSS uses privacy
649 * @auth_type: Authentication type (algorithm)
1b658f11 650 * @inactivity_timeout: time in seconds to determine station's inactivity.
53cabad7
JB
651 * @p2p_ctwindow: P2P CT Window
652 * @p2p_opp_ps: P2P opportunistic PS
77765eaf
VT
653 * @acl: ACL configuration used by the drivers which has support for
654 * MAC address based access control
04f39047 655 * @radar_required: set if radar detection is required
8860020e
JB
656 */
657struct cfg80211_ap_settings {
683b6d3b 658 struct cfg80211_chan_def chandef;
aa430da4 659
8860020e
JB
660 struct cfg80211_beacon_data beacon;
661
662 int beacon_interval, dtim_period;
32e9de84
JM
663 const u8 *ssid;
664 size_t ssid_len;
665 enum nl80211_hidden_ssid hidden_ssid;
5fb628e9
JM
666 struct cfg80211_crypto_settings crypto;
667 bool privacy;
668 enum nl80211_auth_type auth_type;
1b658f11 669 int inactivity_timeout;
53cabad7
JB
670 u8 p2p_ctwindow;
671 bool p2p_opp_ps;
77765eaf 672 const struct cfg80211_acl_data *acl;
04f39047 673 bool radar_required;
ed1b6cc7
JB
674};
675
16ef1fe2
SW
676/**
677 * struct cfg80211_csa_settings - channel switch settings
678 *
679 * Used for channel switch
680 *
681 * @chandef: defines the channel to use after the switch
682 * @beacon_csa: beacon data while performing the switch
683 * @counter_offset_beacon: offset for the counter within the beacon (tail)
684 * @counter_offset_presp: offset for the counter within the probe response
685 * @beacon_after: beacon data to be used on the new channel
686 * @radar_required: whether radar detection is required on the new channel
687 * @block_tx: whether transmissions should be blocked while changing
688 * @count: number of beacons until switch
689 */
690struct cfg80211_csa_settings {
691 struct cfg80211_chan_def chandef;
692 struct cfg80211_beacon_data beacon_csa;
693 u16 counter_offset_beacon, counter_offset_presp;
694 struct cfg80211_beacon_data beacon_after;
695 bool radar_required;
696 bool block_tx;
697 u8 count;
698};
699
3b9ce80c
JB
700/**
701 * enum station_parameters_apply_mask - station parameter values to apply
702 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
9d62a986 703 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
f8bacc21 704 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
3b9ce80c
JB
705 *
706 * Not all station parameters have in-band "no change" signalling,
707 * for those that don't these flags will are used.
708 */
709enum station_parameters_apply_mask {
710 STATION_PARAM_APPLY_UAPSD = BIT(0),
9d62a986 711 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
f8bacc21 712 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
3b9ce80c
JB
713};
714
5727ef1b
JB
715/**
716 * struct station_parameters - station parameters
717 *
718 * Used to change and create a new station.
719 *
720 * @vlan: vlan interface station should belong to
721 * @supported_rates: supported rates in IEEE 802.11 format
722 * (or NULL for no change)
723 * @supported_rates_len: number of supported rates
eccb8e8f
JB
724 * @sta_flags_mask: station flags that changed
725 * (bitmask of BIT(NL80211_STA_FLAG_...))
726 * @sta_flags_set: station flags values
727 * (bitmask of BIT(NL80211_STA_FLAG_...))
5727ef1b
JB
728 * @listen_interval: listen interval or -1 for no change
729 * @aid: AID or zero for no change
abe37c4b 730 * @plink_action: plink action to take
9c3990aa 731 * @plink_state: set the peer link state for a station
abe37c4b 732 * @ht_capa: HT capabilities of station
f461be3e 733 * @vht_capa: VHT capabilities of station
910868db
EP
734 * @uapsd_queues: bitmap of queues configured for uapsd. same format
735 * as the AC bitmap in the QoS info field
736 * @max_sp: max Service Period. same format as the MAX_SP in the
737 * QoS info field (but already shifted down)
c26887d2
JB
738 * @sta_modify_mask: bitmap indicating which parameters changed
739 * (for those that don't have a natural "no change" value),
740 * see &enum station_parameters_apply_mask
3b1c5a53
MP
741 * @local_pm: local link-specific mesh power save mode (no change when set
742 * to unknown)
9d62a986
JM
743 * @capability: station capability
744 * @ext_capab: extended capabilities of the station
745 * @ext_capab_len: number of extended capabilities
c01fc9ad
SD
746 * @supported_channels: supported channels in IEEE 802.11 format
747 * @supported_channels_len: number of supported channels
748 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
749 * @supported_oper_classes_len: number of supported operating classes
60f4a7b1
MK
750 * @opmode_notif: operating mode field from Operating Mode Notification
751 * @opmode_notif_used: information if operating mode field is used
5727ef1b
JB
752 */
753struct station_parameters {
2c1aabf3 754 const u8 *supported_rates;
5727ef1b 755 struct net_device *vlan;
eccb8e8f 756 u32 sta_flags_mask, sta_flags_set;
3b9ce80c 757 u32 sta_modify_mask;
5727ef1b
JB
758 int listen_interval;
759 u16 aid;
760 u8 supported_rates_len;
2ec600d6 761 u8 plink_action;
9c3990aa 762 u8 plink_state;
2c1aabf3
JB
763 const struct ieee80211_ht_cap *ht_capa;
764 const struct ieee80211_vht_cap *vht_capa;
c75786c9
EP
765 u8 uapsd_queues;
766 u8 max_sp;
3b1c5a53 767 enum nl80211_mesh_power_mode local_pm;
9d62a986 768 u16 capability;
2c1aabf3 769 const u8 *ext_capab;
9d62a986 770 u8 ext_capab_len;
c01fc9ad
SD
771 const u8 *supported_channels;
772 u8 supported_channels_len;
773 const u8 *supported_oper_classes;
774 u8 supported_oper_classes_len;
60f4a7b1
MK
775 u8 opmode_notif;
776 bool opmode_notif_used;
5727ef1b
JB
777};
778
77ee7c89
JB
779/**
780 * enum cfg80211_station_type - the type of station being modified
781 * @CFG80211_STA_AP_CLIENT: client of an AP interface
782 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
783 * the AP MLME in the device
784 * @CFG80211_STA_AP_STA: AP station on managed interface
785 * @CFG80211_STA_IBSS: IBSS station
786 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
787 * while TDLS setup is in progress, it moves out of this state when
788 * being marked authorized; use this only if TDLS with external setup is
789 * supported/used)
790 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
791 * entry that is operating, has been marked authorized by userspace)
eef941e6
TP
792 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
793 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
77ee7c89
JB
794 */
795enum cfg80211_station_type {
796 CFG80211_STA_AP_CLIENT,
797 CFG80211_STA_AP_MLME_CLIENT,
798 CFG80211_STA_AP_STA,
799 CFG80211_STA_IBSS,
800 CFG80211_STA_TDLS_PEER_SETUP,
801 CFG80211_STA_TDLS_PEER_ACTIVE,
eef941e6
TP
802 CFG80211_STA_MESH_PEER_KERNEL,
803 CFG80211_STA_MESH_PEER_USER,
77ee7c89
JB
804};
805
806/**
807 * cfg80211_check_station_change - validate parameter changes
808 * @wiphy: the wiphy this operates on
809 * @params: the new parameters for a station
810 * @statype: the type of station being modified
811 *
812 * Utility function for the @change_station driver method. Call this function
813 * with the appropriate station type looking up the station (and checking that
814 * it exists). It will verify whether the station change is acceptable, and if
815 * not will return an error code. Note that it may modify the parameters for
816 * backward compatibility reasons, so don't use them before calling this.
817 */
818int cfg80211_check_station_change(struct wiphy *wiphy,
819 struct station_parameters *params,
820 enum cfg80211_station_type statype);
821
fd5b74dc 822/**
2ec600d6 823 * enum station_info_flags - station information flags
fd5b74dc 824 *
2ec600d6
LCC
825 * Used by the driver to indicate which info in &struct station_info
826 * it has filled in during get_station() or dump_station().
fd5b74dc 827 *
2ec600d6
LCC
828 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
829 * @STATION_INFO_RX_BYTES: @rx_bytes filled
830 * @STATION_INFO_TX_BYTES: @tx_bytes filled
077f897a
JB
831 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
832 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
2ec600d6
LCC
833 * @STATION_INFO_LLID: @llid filled
834 * @STATION_INFO_PLID: @plid filled
835 * @STATION_INFO_PLINK_STATE: @plink_state filled
420e7fab 836 * @STATION_INFO_SIGNAL: @signal filled
c8dcfd8a 837 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
ad24b0da 838 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
42745e03
VK
839 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
840 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
b206b4ef
BR
841 * @STATION_INFO_TX_RETRIES: @tx_retries filled
842 * @STATION_INFO_TX_FAILED: @tx_failed filled
5a5c731a 843 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
541a45a1 844 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
c8dcfd8a 845 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
f4263c98 846 * @STATION_INFO_BSS_PARAM: @bss_param filled
ebe27c91 847 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
040bdf71 848 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
bb6e753e 849 * @STATION_INFO_STA_FLAGS: @sta_flags filled
a85e1d55 850 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
d299a1f2 851 * @STATION_INFO_T_OFFSET: @t_offset filled
3b1c5a53
MP
852 * @STATION_INFO_LOCAL_PM: @local_pm filled
853 * @STATION_INFO_PEER_PM: @peer_pm filled
854 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
119363c7
FF
855 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
856 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
fd5b74dc 857 */
2ec600d6
LCC
858enum station_info_flags {
859 STATION_INFO_INACTIVE_TIME = 1<<0,
860 STATION_INFO_RX_BYTES = 1<<1,
861 STATION_INFO_TX_BYTES = 1<<2,
862 STATION_INFO_LLID = 1<<3,
863 STATION_INFO_PLID = 1<<4,
864 STATION_INFO_PLINK_STATE = 1<<5,
420e7fab
HR
865 STATION_INFO_SIGNAL = 1<<6,
866 STATION_INFO_TX_BITRATE = 1<<7,
98c8a60a
JM
867 STATION_INFO_RX_PACKETS = 1<<8,
868 STATION_INFO_TX_PACKETS = 1<<9,
b206b4ef
BR
869 STATION_INFO_TX_RETRIES = 1<<10,
870 STATION_INFO_TX_FAILED = 1<<11,
5a5c731a 871 STATION_INFO_RX_DROP_MISC = 1<<12,
541a45a1 872 STATION_INFO_SIGNAL_AVG = 1<<13,
c8dcfd8a 873 STATION_INFO_RX_BITRATE = 1<<14,
f4263c98 874 STATION_INFO_BSS_PARAM = 1<<15,
040bdf71 875 STATION_INFO_CONNECTED_TIME = 1<<16,
bb6e753e 876 STATION_INFO_ASSOC_REQ_IES = 1<<17,
a85e1d55 877 STATION_INFO_STA_FLAGS = 1<<18,
d299a1f2
JC
878 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
879 STATION_INFO_T_OFFSET = 1<<20,
3b1c5a53
MP
880 STATION_INFO_LOCAL_PM = 1<<21,
881 STATION_INFO_PEER_PM = 1<<22,
882 STATION_INFO_NONPEER_PM = 1<<23,
42745e03
VK
883 STATION_INFO_RX_BYTES64 = 1<<24,
884 STATION_INFO_TX_BYTES64 = 1<<25,
119363c7
FF
885 STATION_INFO_CHAIN_SIGNAL = 1<<26,
886 STATION_INFO_CHAIN_SIGNAL_AVG = 1<<27,
420e7fab
HR
887};
888
889/**
890 * enum station_info_rate_flags - bitrate info flags
891 *
892 * Used by the driver to indicate the specific rate transmission
893 * type for 802.11n transmissions.
894 *
db9c64cf
JB
895 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
896 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
897 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
898 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
899 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
900 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
420e7fab 901 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
db9c64cf 902 * @RATE_INFO_FLAGS_60G: 60GHz MCS
420e7fab
HR
903 */
904enum rate_info_flags {
db9c64cf
JB
905 RATE_INFO_FLAGS_MCS = BIT(0),
906 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
907 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
908 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
909 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
910 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
911 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
912 RATE_INFO_FLAGS_60G = BIT(7),
420e7fab
HR
913};
914
915/**
916 * struct rate_info - bitrate information
917 *
918 * Information about a receiving or transmitting bitrate
919 *
920 * @flags: bitflag of flags from &enum rate_info_flags
921 * @mcs: mcs index if struct describes a 802.11n bitrate
922 * @legacy: bitrate in 100kbit/s for 802.11abg
db9c64cf 923 * @nss: number of streams (VHT only)
420e7fab
HR
924 */
925struct rate_info {
926 u8 flags;
927 u8 mcs;
928 u16 legacy;
db9c64cf 929 u8 nss;
fd5b74dc
JB
930};
931
f4263c98
PS
932/**
933 * enum station_info_rate_flags - bitrate info flags
934 *
935 * Used by the driver to indicate the specific rate transmission
936 * type for 802.11n transmissions.
937 *
938 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
939 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
940 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
941 */
942enum bss_param_flags {
943 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
944 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
945 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
946};
947
948/**
949 * struct sta_bss_parameters - BSS parameters for the attached station
950 *
951 * Information about the currently associated BSS
952 *
953 * @flags: bitflag of flags from &enum bss_param_flags
954 * @dtim_period: DTIM period for the BSS
955 * @beacon_interval: beacon interval
956 */
957struct sta_bss_parameters {
958 u8 flags;
959 u8 dtim_period;
960 u16 beacon_interval;
961};
962
119363c7
FF
963#define IEEE80211_MAX_CHAINS 4
964
fd5b74dc 965/**
2ec600d6 966 * struct station_info - station information
fd5b74dc 967 *
2ec600d6 968 * Station information filled by driver for get_station() and dump_station.
fd5b74dc 969 *
2ec600d6 970 * @filled: bitflag of flags from &enum station_info_flags
ebe27c91 971 * @connected_time: time(in secs) since a station is last connected
fd5b74dc
JB
972 * @inactive_time: time since last station activity (tx/rx) in milliseconds
973 * @rx_bytes: bytes received from this station
974 * @tx_bytes: bytes transmitted to this station
2ec600d6
LCC
975 * @llid: mesh local link id
976 * @plid: mesh peer link id
977 * @plink_state: mesh peer link state
73c3df3b
JB
978 * @signal: The signal strength, type depends on the wiphy's signal_type.
979 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
980 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
981 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
119363c7
FF
982 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
983 * @chain_signal: per-chain signal strength of last received packet in dBm
984 * @chain_signal_avg: per-chain signal strength average in dBm
858022aa
RD
985 * @txrate: current unicast bitrate from this station
986 * @rxrate: current unicast bitrate to this station
98c8a60a
JM
987 * @rx_packets: packets received from this station
988 * @tx_packets: packets transmitted to this station
b206b4ef
BR
989 * @tx_retries: cumulative retry counts
990 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
5a5c731a 991 * @rx_dropped_misc: Dropped for un-specified reason.
1ba01458 992 * @bss_param: current BSS parameters
f5ea9120
JB
993 * @generation: generation number for nl80211 dumps.
994 * This number should increase every time the list of stations
995 * changes, i.e. when a station is added or removed, so that
996 * userspace can tell whether it got a consistent snapshot.
50d3dfb7
JM
997 * @assoc_req_ies: IEs from (Re)Association Request.
998 * This is used only when in AP mode with drivers that do not use
999 * user space MLME/SME implementation. The information is provided for
1000 * the cfg80211_new_sta() calls to notify user space of the IEs.
1001 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
c26887d2 1002 * @sta_flags: station flags mask & values
a85e1d55 1003 * @beacon_loss_count: Number of times beacon loss event has triggered.
d299a1f2 1004 * @t_offset: Time offset of the station relative to this host.
3b1c5a53
MP
1005 * @local_pm: local mesh STA power save mode
1006 * @peer_pm: peer mesh STA power save mode
1007 * @nonpeer_pm: non-peer mesh STA power save mode
fd5b74dc 1008 */
2ec600d6 1009struct station_info {
fd5b74dc 1010 u32 filled;
ebe27c91 1011 u32 connected_time;
fd5b74dc 1012 u32 inactive_time;
42745e03
VK
1013 u64 rx_bytes;
1014 u64 tx_bytes;
2ec600d6
LCC
1015 u16 llid;
1016 u16 plid;
1017 u8 plink_state;
420e7fab 1018 s8 signal;
541a45a1 1019 s8 signal_avg;
119363c7
FF
1020
1021 u8 chains;
1022 s8 chain_signal[IEEE80211_MAX_CHAINS];
1023 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1024
420e7fab 1025 struct rate_info txrate;
c8dcfd8a 1026 struct rate_info rxrate;
98c8a60a
JM
1027 u32 rx_packets;
1028 u32 tx_packets;
b206b4ef
BR
1029 u32 tx_retries;
1030 u32 tx_failed;
5a5c731a 1031 u32 rx_dropped_misc;
f4263c98 1032 struct sta_bss_parameters bss_param;
bb6e753e 1033 struct nl80211_sta_flag_update sta_flags;
f5ea9120
JB
1034
1035 int generation;
50d3dfb7
JM
1036
1037 const u8 *assoc_req_ies;
1038 size_t assoc_req_ies_len;
f612cedf 1039
a85e1d55 1040 u32 beacon_loss_count;
d299a1f2 1041 s64 t_offset;
3b1c5a53
MP
1042 enum nl80211_mesh_power_mode local_pm;
1043 enum nl80211_mesh_power_mode peer_pm;
1044 enum nl80211_mesh_power_mode nonpeer_pm;
a85e1d55 1045
f612cedf
JM
1046 /*
1047 * Note: Add a new enum station_info_flags value for each new field and
1048 * use it to check which fields are initialized.
1049 */
fd5b74dc
JB
1050};
1051
66f7ac50
MW
1052/**
1053 * enum monitor_flags - monitor flags
1054 *
1055 * Monitor interface configuration flags. Note that these must be the bits
1056 * according to the nl80211 flags.
1057 *
1058 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1059 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1060 * @MONITOR_FLAG_CONTROL: pass control frames
1061 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1062 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
e057d3c3 1063 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
66f7ac50
MW
1064 */
1065enum monitor_flags {
1066 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1067 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1068 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1069 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1070 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
e057d3c3 1071 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
66f7ac50
MW
1072};
1073
2ec600d6
LCC
1074/**
1075 * enum mpath_info_flags - mesh path information flags
1076 *
1077 * Used by the driver to indicate which info in &struct mpath_info it has filled
1078 * in during get_station() or dump_station().
1079 *
abe37c4b
JB
1080 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1081 * @MPATH_INFO_SN: @sn filled
1082 * @MPATH_INFO_METRIC: @metric filled
1083 * @MPATH_INFO_EXPTIME: @exptime filled
1084 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1085 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1086 * @MPATH_INFO_FLAGS: @flags filled
2ec600d6
LCC
1087 */
1088enum mpath_info_flags {
1089 MPATH_INFO_FRAME_QLEN = BIT(0),
d19b3bf6 1090 MPATH_INFO_SN = BIT(1),
2ec600d6
LCC
1091 MPATH_INFO_METRIC = BIT(2),
1092 MPATH_INFO_EXPTIME = BIT(3),
1093 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1094 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1095 MPATH_INFO_FLAGS = BIT(6),
1096};
1097
1098/**
1099 * struct mpath_info - mesh path information
1100 *
1101 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1102 *
1103 * @filled: bitfield of flags from &enum mpath_info_flags
1104 * @frame_qlen: number of queued frames for this destination
d19b3bf6 1105 * @sn: target sequence number
2ec600d6
LCC
1106 * @metric: metric (cost) of this mesh path
1107 * @exptime: expiration time for the mesh path from now, in msecs
1108 * @flags: mesh path flags
1109 * @discovery_timeout: total mesh path discovery timeout, in msecs
1110 * @discovery_retries: mesh path discovery retries
f5ea9120
JB
1111 * @generation: generation number for nl80211 dumps.
1112 * This number should increase every time the list of mesh paths
1113 * changes, i.e. when a station is added or removed, so that
1114 * userspace can tell whether it got a consistent snapshot.
2ec600d6
LCC
1115 */
1116struct mpath_info {
1117 u32 filled;
1118 u32 frame_qlen;
d19b3bf6 1119 u32 sn;
2ec600d6
LCC
1120 u32 metric;
1121 u32 exptime;
1122 u32 discovery_timeout;
1123 u8 discovery_retries;
1124 u8 flags;
f5ea9120
JB
1125
1126 int generation;
2ec600d6
LCC
1127};
1128
9f1ba906
JM
1129/**
1130 * struct bss_parameters - BSS parameters
1131 *
1132 * Used to change BSS parameters (mainly for AP mode).
1133 *
1134 * @use_cts_prot: Whether to use CTS protection
1135 * (0 = no, 1 = yes, -1 = do not change)
1136 * @use_short_preamble: Whether the use of short preambles is allowed
1137 * (0 = no, 1 = yes, -1 = do not change)
1138 * @use_short_slot_time: Whether the use of short slot time is allowed
1139 * (0 = no, 1 = yes, -1 = do not change)
90c97a04
JM
1140 * @basic_rates: basic rates in IEEE 802.11 format
1141 * (or NULL for no change)
1142 * @basic_rates_len: number of basic rates
fd8aaaf3 1143 * @ap_isolate: do not forward packets between connected stations
50b12f59
HS
1144 * @ht_opmode: HT Operation mode
1145 * (u16 = opmode, -1 = do not change)
53cabad7
JB
1146 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1147 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
9f1ba906
JM
1148 */
1149struct bss_parameters {
1150 int use_cts_prot;
1151 int use_short_preamble;
1152 int use_short_slot_time;
90c97a04
JM
1153 u8 *basic_rates;
1154 u8 basic_rates_len;
fd8aaaf3 1155 int ap_isolate;
50b12f59 1156 int ht_opmode;
53cabad7 1157 s8 p2p_ctwindow, p2p_opp_ps;
9f1ba906 1158};
2ec600d6 1159
3ddd53f3 1160/**
29cbe68c
JB
1161 * struct mesh_config - 802.11s mesh configuration
1162 *
1163 * These parameters can be changed while the mesh is active.
3ddd53f3
CYY
1164 *
1165 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1166 * by the Mesh Peering Open message
1167 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1168 * used by the Mesh Peering Open message
1169 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1170 * the mesh peering management to close a mesh peering
1171 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1172 * mesh interface
1173 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1174 * be sent to establish a new peer link instance in a mesh
1175 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1176 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1177 * elements
1178 * @auto_open_plinks: whether we should automatically open peer links when we
1179 * detect compatible mesh peers
1180 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1181 * synchronize to for 11s default synchronization method
1182 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1183 * that an originator mesh STA can send to a particular path target
1184 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1185 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1186 * a path discovery in milliseconds
1187 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1188 * receiving a PREQ shall consider the forwarding information from the
1189 * root to be valid. (TU = time unit)
1190 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1191 * which a mesh STA can send only one action frame containing a PREQ
1192 * element
1193 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1194 * which a mesh STA can send only one Action frame containing a PERR
1195 * element
1196 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1197 * it takes for an HWMP information element to propagate across the mesh
1198 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1199 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1200 * announcements are transmitted
1201 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1202 * station has access to a broader network beyond the MBSS. (This is
1203 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1204 * only means that the station will announce others it's a mesh gate, but
1205 * not necessarily using the gate announcement protocol. Still keeping the
1206 * same nomenclature to be in sync with the spec)
1207 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1208 * entity (default is TRUE - forwarding entity)
1209 * @rssi_threshold: the threshold for average signal strength of candidate
1210 * station to establish a peer link
1211 * @ht_opmode: mesh HT protection mode
ac1073a6
CYY
1212 *
1213 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1214 * receiving a proactive PREQ shall consider the forwarding information to
1215 * the root mesh STA to be valid.
1216 *
1217 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1218 * PREQs are transmitted.
728b19e5
CYY
1219 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1220 * during which a mesh STA can send only one Action frame containing
1221 * a PREQ element for root path confirmation.
3b1c5a53
MP
1222 * @power_mode: The default mesh power save mode which will be the initial
1223 * setting for new peer links.
1224 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1225 * after transmitting its beacon.
8e7c0538
CT
1226 * @plink_timeout: If no tx activity is seen from a STA we've established
1227 * peering with for longer than this time (in seconds), then remove it
1228 * from the STA's list of peers. Default is 30 minutes.
29cbe68c 1229 */
93da9cc1 1230struct mesh_config {
93da9cc1 1231 u16 dot11MeshRetryTimeout;
1232 u16 dot11MeshConfirmTimeout;
1233 u16 dot11MeshHoldingTimeout;
1234 u16 dot11MeshMaxPeerLinks;
a4f606ea
CYY
1235 u8 dot11MeshMaxRetries;
1236 u8 dot11MeshTTL;
1237 u8 element_ttl;
93da9cc1 1238 bool auto_open_plinks;
d299a1f2 1239 u32 dot11MeshNbrOffsetMaxNeighbor;
a4f606ea 1240 u8 dot11MeshHWMPmaxPREQretries;
93da9cc1 1241 u32 path_refresh_time;
1242 u16 min_discovery_timeout;
1243 u32 dot11MeshHWMPactivePathTimeout;
1244 u16 dot11MeshHWMPpreqMinInterval;
dca7e943 1245 u16 dot11MeshHWMPperrMinInterval;
93da9cc1 1246 u16 dot11MeshHWMPnetDiameterTraversalTime;
a4f606ea 1247 u8 dot11MeshHWMPRootMode;
0507e159 1248 u16 dot11MeshHWMPRannInterval;
a4f606ea 1249 bool dot11MeshGateAnnouncementProtocol;
94f90656 1250 bool dot11MeshForwarding;
55335137 1251 s32 rssi_threshold;
70c33eaa 1252 u16 ht_opmode;
ac1073a6
CYY
1253 u32 dot11MeshHWMPactivePathToRootTimeout;
1254 u16 dot11MeshHWMProotInterval;
728b19e5 1255 u16 dot11MeshHWMPconfirmationInterval;
3b1c5a53
MP
1256 enum nl80211_mesh_power_mode power_mode;
1257 u16 dot11MeshAwakeWindowDuration;
8e7c0538 1258 u32 plink_timeout;
93da9cc1 1259};
1260
29cbe68c
JB
1261/**
1262 * struct mesh_setup - 802.11s mesh setup configuration
683b6d3b 1263 * @chandef: defines the channel to use
29cbe68c
JB
1264 * @mesh_id: the mesh ID
1265 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
d299a1f2 1266 * @sync_method: which synchronization method to use
c80d545d
JC
1267 * @path_sel_proto: which path selection protocol to use
1268 * @path_metric: which metric to use
6e16d90b 1269 * @auth_id: which authentication method this mesh is using
581a8b0f
JC
1270 * @ie: vendor information elements (optional)
1271 * @ie_len: length of vendor information elements
b130e5ce
JC
1272 * @is_authenticated: this mesh requires authentication
1273 * @is_secure: this mesh uses security
bb2798d4 1274 * @user_mpm: userspace handles all MPM functions
9bdbf04d
MP
1275 * @dtim_period: DTIM period to use
1276 * @beacon_interval: beacon interval to use
4bb62344 1277 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
ffb3cf30 1278 * @basic_rates: basic rates to use when creating the mesh
29cbe68c
JB
1279 *
1280 * These parameters are fixed when the mesh is created.
1281 */
1282struct mesh_setup {
683b6d3b 1283 struct cfg80211_chan_def chandef;
29cbe68c
JB
1284 const u8 *mesh_id;
1285 u8 mesh_id_len;
d299a1f2
JC
1286 u8 sync_method;
1287 u8 path_sel_proto;
1288 u8 path_metric;
6e16d90b 1289 u8 auth_id;
581a8b0f
JC
1290 const u8 *ie;
1291 u8 ie_len;
b130e5ce 1292 bool is_authenticated;
15d5dda6 1293 bool is_secure;
bb2798d4 1294 bool user_mpm;
9bdbf04d
MP
1295 u8 dtim_period;
1296 u16 beacon_interval;
4bb62344 1297 int mcast_rate[IEEE80211_NUM_BANDS];
ffb3cf30 1298 u32 basic_rates;
29cbe68c
JB
1299};
1300
31888487
JM
1301/**
1302 * struct ieee80211_txq_params - TX queue parameters
a3304b0a 1303 * @ac: AC identifier
31888487
JM
1304 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1305 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1306 * 1..32767]
1307 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1308 * 1..32767]
1309 * @aifs: Arbitration interframe space [0..255]
1310 */
1311struct ieee80211_txq_params {
a3304b0a 1312 enum nl80211_ac ac;
31888487
JM
1313 u16 txop;
1314 u16 cwmin;
1315 u16 cwmax;
1316 u8 aifs;
1317};
1318
d70e9693
JB
1319/**
1320 * DOC: Scanning and BSS list handling
1321 *
1322 * The scanning process itself is fairly simple, but cfg80211 offers quite
1323 * a bit of helper functionality. To start a scan, the scan operation will
1324 * be invoked with a scan definition. This scan definition contains the
1325 * channels to scan, and the SSIDs to send probe requests for (including the
1326 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1327 * probe. Additionally, a scan request may contain extra information elements
1328 * that should be added to the probe request. The IEs are guaranteed to be
1329 * well-formed, and will not exceed the maximum length the driver advertised
1330 * in the wiphy structure.
1331 *
1332 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1333 * it is responsible for maintaining the BSS list; the driver should not
1334 * maintain a list itself. For this notification, various functions exist.
1335 *
1336 * Since drivers do not maintain a BSS list, there are also a number of
1337 * functions to search for a BSS and obtain information about it from the
1338 * BSS structure cfg80211 maintains. The BSS list is also made available
1339 * to userspace.
1340 */
72bdcf34 1341
2a519311
JB
1342/**
1343 * struct cfg80211_ssid - SSID description
1344 * @ssid: the SSID
1345 * @ssid_len: length of the ssid
1346 */
1347struct cfg80211_ssid {
1348 u8 ssid[IEEE80211_MAX_SSID_LEN];
1349 u8 ssid_len;
1350};
1351
1352/**
1353 * struct cfg80211_scan_request - scan request description
1354 *
1355 * @ssids: SSIDs to scan for (active scan only)
1356 * @n_ssids: number of SSIDs
1357 * @channels: channels to scan on.
ca3dbc20 1358 * @n_channels: total number of channels to scan
dcd6eac1 1359 * @scan_width: channel width for scanning
70692ad2
JM
1360 * @ie: optional information element(s) to add into Probe Request or %NULL
1361 * @ie_len: length of ie in octets
ed473771 1362 * @flags: bit field of flags controlling operation
34850ab2 1363 * @rates: bitmap of rates to advertise for each band
2a519311 1364 * @wiphy: the wiphy this was for
15d6030b 1365 * @scan_start: time (in jiffies) when the scan started
fd014284 1366 * @wdev: the wireless device to scan for
abe37c4b 1367 * @aborted: (internal) scan request was notified as aborted
5fe231e8 1368 * @notified: (internal) scan request was notified as done or aborted
e9f935e3 1369 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2a519311
JB
1370 */
1371struct cfg80211_scan_request {
1372 struct cfg80211_ssid *ssids;
1373 int n_ssids;
2a519311 1374 u32 n_channels;
dcd6eac1 1375 enum nl80211_bss_scan_width scan_width;
de95a54b 1376 const u8 *ie;
70692ad2 1377 size_t ie_len;
ed473771 1378 u32 flags;
2a519311 1379
34850ab2
JB
1380 u32 rates[IEEE80211_NUM_BANDS];
1381
fd014284
JB
1382 struct wireless_dev *wdev;
1383
2a519311
JB
1384 /* internal */
1385 struct wiphy *wiphy;
15d6030b 1386 unsigned long scan_start;
5fe231e8 1387 bool aborted, notified;
e9f935e3 1388 bool no_cck;
5ba63533
JB
1389
1390 /* keep last */
1391 struct ieee80211_channel *channels[0];
2a519311
JB
1392};
1393
a1f1c21c
LC
1394/**
1395 * struct cfg80211_match_set - sets of attributes to match
1396 *
ea73cbce
JB
1397 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1398 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
a1f1c21c
LC
1399 */
1400struct cfg80211_match_set {
1401 struct cfg80211_ssid ssid;
ea73cbce 1402 s32 rssi_thold;
a1f1c21c
LC
1403};
1404
807f8a8c
LC
1405/**
1406 * struct cfg80211_sched_scan_request - scheduled scan request description
1407 *
1408 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1409 * @n_ssids: number of SSIDs
1410 * @n_channels: total number of channels to scan
dcd6eac1 1411 * @scan_width: channel width for scanning
bbe6ad6d 1412 * @interval: interval between each scheduled scan cycle
807f8a8c
LC
1413 * @ie: optional information element(s) to add into Probe Request or %NULL
1414 * @ie_len: length of ie in octets
ed473771 1415 * @flags: bit field of flags controlling operation
a1f1c21c
LC
1416 * @match_sets: sets of parameters to be matched for a scan result
1417 * entry to be considered valid and to be passed to the host
1418 * (others are filtered out).
1419 * If ommited, all results are passed.
1420 * @n_match_sets: number of match sets
807f8a8c
LC
1421 * @wiphy: the wiphy this was for
1422 * @dev: the interface
077f897a 1423 * @scan_start: start time of the scheduled scan
807f8a8c 1424 * @channels: channels to scan
ea73cbce
JB
1425 * @min_rssi_thold: for drivers only supporting a single threshold, this
1426 * contains the minimum over all matchsets
807f8a8c
LC
1427 */
1428struct cfg80211_sched_scan_request {
1429 struct cfg80211_ssid *ssids;
1430 int n_ssids;
1431 u32 n_channels;
dcd6eac1 1432 enum nl80211_bss_scan_width scan_width;
bbe6ad6d 1433 u32 interval;
807f8a8c
LC
1434 const u8 *ie;
1435 size_t ie_len;
ed473771 1436 u32 flags;
a1f1c21c
LC
1437 struct cfg80211_match_set *match_sets;
1438 int n_match_sets;
ea73cbce 1439 s32 min_rssi_thold;
807f8a8c
LC
1440
1441 /* internal */
1442 struct wiphy *wiphy;
1443 struct net_device *dev;
15d6030b 1444 unsigned long scan_start;
807f8a8c
LC
1445
1446 /* keep last */
1447 struct ieee80211_channel *channels[0];
1448};
1449
2a519311
JB
1450/**
1451 * enum cfg80211_signal_type - signal type
1452 *
1453 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1454 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1455 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1456 */
1457enum cfg80211_signal_type {
1458 CFG80211_SIGNAL_TYPE_NONE,
1459 CFG80211_SIGNAL_TYPE_MBM,
1460 CFG80211_SIGNAL_TYPE_UNSPEC,
1461};
1462
9caf0364
JB
1463/**
1464 * struct cfg80211_bss_ie_data - BSS entry IE data
8cef2c9d 1465 * @tsf: TSF contained in the frame that carried these IEs
9caf0364
JB
1466 * @rcu_head: internal use, for freeing
1467 * @len: length of the IEs
1468 * @data: IE data
1469 */
1470struct cfg80211_bss_ies {
8cef2c9d 1471 u64 tsf;
9caf0364
JB
1472 struct rcu_head rcu_head;
1473 int len;
1474 u8 data[];
1475};
1476
2a519311
JB
1477/**
1478 * struct cfg80211_bss - BSS description
1479 *
1480 * This structure describes a BSS (which may also be a mesh network)
1481 * for use in scan results and similar.
1482 *
abe37c4b 1483 * @channel: channel this BSS is on
dcd6eac1 1484 * @scan_width: width of the control channel
2a519311 1485 * @bssid: BSSID of the BSS
2a519311
JB
1486 * @beacon_interval: the beacon interval as from the frame
1487 * @capability: the capability field in host byte order
83c7aa1a
JB
1488 * @ies: the information elements (Note that there is no guarantee that these
1489 * are well-formed!); this is a pointer to either the beacon_ies or
1490 * proberesp_ies depending on whether Probe Response frame has been
1491 * received. It is always non-%NULL.
34a6eddb 1492 * @beacon_ies: the information elements from the last Beacon frame
776b3580
JB
1493 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1494 * own the beacon_ies, but they're just pointers to the ones from the
1495 * @hidden_beacon_bss struct)
34a6eddb 1496 * @proberesp_ies: the information elements from the last Probe Response frame
776b3580
JB
1497 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1498 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1499 * that holds the beacon data. @beacon_ies is still valid, of course, and
1500 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
77965c97 1501 * @signal: signal strength value (type depends on the wiphy's signal_type)
2a519311
JB
1502 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1503 */
1504struct cfg80211_bss {
1505 struct ieee80211_channel *channel;
dcd6eac1 1506 enum nl80211_bss_scan_width scan_width;
2a519311 1507
9caf0364
JB
1508 const struct cfg80211_bss_ies __rcu *ies;
1509 const struct cfg80211_bss_ies __rcu *beacon_ies;
1510 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1511
776b3580 1512 struct cfg80211_bss *hidden_beacon_bss;
9caf0364
JB
1513
1514 s32 signal;
1515
2a519311
JB
1516 u16 beacon_interval;
1517 u16 capability;
2a519311 1518
9caf0364 1519 u8 bssid[ETH_ALEN];
2a519311 1520
1c06ef98 1521 u8 priv[0] __aligned(sizeof(void *));
2a519311
JB
1522};
1523
517357c6
JB
1524/**
1525 * ieee80211_bss_get_ie - find IE with given ID
1526 * @bss: the bss to search
1527 * @ie: the IE ID
9caf0364
JB
1528 *
1529 * Note that the return value is an RCU-protected pointer, so
1530 * rcu_read_lock() must be held when calling this function.
0ae997dc 1531 * Return: %NULL if not found.
517357c6
JB
1532 */
1533const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1534
1535
636a5d36
JM
1536/**
1537 * struct cfg80211_auth_request - Authentication request data
1538 *
1539 * This structure provides information needed to complete IEEE 802.11
1540 * authentication.
19957bb3 1541 *
959867fa
JB
1542 * @bss: The BSS to authenticate with, the callee must obtain a reference
1543 * to it if it needs to keep it.
636a5d36
JM
1544 * @auth_type: Authentication type (algorithm)
1545 * @ie: Extra IEs to add to Authentication frame or %NULL
1546 * @ie_len: Length of ie buffer in octets
fffd0934
JB
1547 * @key_len: length of WEP key for shared key authentication
1548 * @key_idx: index of WEP key for shared key authentication
1549 * @key: WEP key for shared key authentication
e39e5b5e
JM
1550 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1551 * Authentication transaction sequence number field.
1552 * @sae_data_len: Length of sae_data buffer in octets
636a5d36
JM
1553 */
1554struct cfg80211_auth_request {
19957bb3 1555 struct cfg80211_bss *bss;
636a5d36
JM
1556 const u8 *ie;
1557 size_t ie_len;
19957bb3 1558 enum nl80211_auth_type auth_type;
fffd0934
JB
1559 const u8 *key;
1560 u8 key_len, key_idx;
e39e5b5e
JM
1561 const u8 *sae_data;
1562 size_t sae_data_len;
636a5d36
JM
1563};
1564
7e7c8926
BG
1565/**
1566 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1567 *
1568 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
ee2aca34 1569 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
7e7c8926
BG
1570 */
1571enum cfg80211_assoc_req_flags {
1572 ASSOC_REQ_DISABLE_HT = BIT(0),
ee2aca34 1573 ASSOC_REQ_DISABLE_VHT = BIT(1),
7e7c8926
BG
1574};
1575
636a5d36
JM
1576/**
1577 * struct cfg80211_assoc_request - (Re)Association request data
1578 *
1579 * This structure provides information needed to complete IEEE 802.11
1580 * (re)association.
959867fa
JB
1581 * @bss: The BSS to associate with. If the call is successful the driver is
1582 * given a reference that it must give back to cfg80211_send_rx_assoc()
1583 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1584 * association requests while already associating must be rejected.
636a5d36
JM
1585 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1586 * @ie_len: Length of ie buffer in octets
dc6382ce 1587 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
b23aa676 1588 * @crypto: crypto settings
3e5d7649 1589 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
7e7c8926
BG
1590 * @flags: See &enum cfg80211_assoc_req_flags
1591 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
ad24b0da 1592 * will be used in ht_capa. Un-supported values will be ignored.
7e7c8926 1593 * @ht_capa_mask: The bits of ht_capa which are to be used.
ee2aca34
JB
1594 * @vht_capa: VHT capability override
1595 * @vht_capa_mask: VHT capability mask indicating which fields to use
636a5d36
JM
1596 */
1597struct cfg80211_assoc_request {
19957bb3 1598 struct cfg80211_bss *bss;
3e5d7649 1599 const u8 *ie, *prev_bssid;
636a5d36 1600 size_t ie_len;
b23aa676 1601 struct cfg80211_crypto_settings crypto;
19957bb3 1602 bool use_mfp;
7e7c8926
BG
1603 u32 flags;
1604 struct ieee80211_ht_cap ht_capa;
1605 struct ieee80211_ht_cap ht_capa_mask;
ee2aca34 1606 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
636a5d36
JM
1607};
1608
1609/**
1610 * struct cfg80211_deauth_request - Deauthentication request data
1611 *
1612 * This structure provides information needed to complete IEEE 802.11
1613 * deauthentication.
1614 *
95de817b 1615 * @bssid: the BSSID of the BSS to deauthenticate from
636a5d36
JM
1616 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1617 * @ie_len: Length of ie buffer in octets
19957bb3 1618 * @reason_code: The reason code for the deauthentication
077f897a
JB
1619 * @local_state_change: if set, change local state only and
1620 * do not set a deauth frame
636a5d36
JM
1621 */
1622struct cfg80211_deauth_request {
95de817b 1623 const u8 *bssid;
636a5d36
JM
1624 const u8 *ie;
1625 size_t ie_len;
19957bb3 1626 u16 reason_code;
6863255b 1627 bool local_state_change;
636a5d36
JM
1628};
1629
1630/**
1631 * struct cfg80211_disassoc_request - Disassociation request data
1632 *
1633 * This structure provides information needed to complete IEEE 802.11
1634 * disassocation.
1635 *
19957bb3 1636 * @bss: the BSS to disassociate from
636a5d36
JM
1637 * @ie: Extra IEs to add to Disassociation frame or %NULL
1638 * @ie_len: Length of ie buffer in octets
19957bb3 1639 * @reason_code: The reason code for the disassociation
d5cdfacb
JM
1640 * @local_state_change: This is a request for a local state only, i.e., no
1641 * Disassociation frame is to be transmitted.
636a5d36
JM
1642 */
1643struct cfg80211_disassoc_request {
19957bb3 1644 struct cfg80211_bss *bss;
636a5d36
JM
1645 const u8 *ie;
1646 size_t ie_len;
19957bb3 1647 u16 reason_code;
d5cdfacb 1648 bool local_state_change;
636a5d36
JM
1649};
1650
04a773ad
JB
1651/**
1652 * struct cfg80211_ibss_params - IBSS parameters
1653 *
1654 * This structure defines the IBSS parameters for the join_ibss()
1655 * method.
1656 *
1657 * @ssid: The SSID, will always be non-null.
1658 * @ssid_len: The length of the SSID, will always be non-zero.
1659 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1660 * search for IBSSs with a different BSSID.
683b6d3b 1661 * @chandef: defines the channel to use if no other IBSS to join can be found
04a773ad
JB
1662 * @channel_fixed: The channel should be fixed -- do not search for
1663 * IBSSs to join on other channels.
1664 * @ie: information element(s) to include in the beacon
1665 * @ie_len: length of that
8e30bc55 1666 * @beacon_interval: beacon interval to use
fffd0934
JB
1667 * @privacy: this is a protected network, keys will be configured
1668 * after joining
267335d6
AQ
1669 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1670 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1671 * required to assume that the port is unauthorized until authorized by
1672 * user space. Otherwise, port is marked authorized by default.
5336fa88
SW
1673 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1674 * changes the channel when a radar is detected. This is required
1675 * to operate on DFS channels.
fbd2c8dc 1676 * @basic_rates: bitmap of basic rates to use when creating the IBSS
dd5b4cc7 1677 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
803768f5 1678 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
ad24b0da 1679 * will be used in ht_capa. Un-supported values will be ignored.
803768f5 1680 * @ht_capa_mask: The bits of ht_capa which are to be used.
04a773ad
JB
1681 */
1682struct cfg80211_ibss_params {
1683 u8 *ssid;
1684 u8 *bssid;
683b6d3b 1685 struct cfg80211_chan_def chandef;
04a773ad
JB
1686 u8 *ie;
1687 u8 ssid_len, ie_len;
8e30bc55 1688 u16 beacon_interval;
fbd2c8dc 1689 u32 basic_rates;
04a773ad 1690 bool channel_fixed;
fffd0934 1691 bool privacy;
267335d6 1692 bool control_port;
5336fa88 1693 bool userspace_handles_dfs;
dd5b4cc7 1694 int mcast_rate[IEEE80211_NUM_BANDS];
803768f5
SW
1695 struct ieee80211_ht_cap ht_capa;
1696 struct ieee80211_ht_cap ht_capa_mask;
04a773ad
JB
1697};
1698
b23aa676
SO
1699/**
1700 * struct cfg80211_connect_params - Connection parameters
1701 *
1702 * This structure provides information needed to complete IEEE 802.11
1703 * authentication and association.
1704 *
1705 * @channel: The channel to use or %NULL if not specified (auto-select based
1706 * on scan results)
1df4a510
JM
1707 * @channel_hint: The channel of the recommended BSS for initial connection or
1708 * %NULL if not specified
b23aa676
SO
1709 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1710 * results)
1df4a510
JM
1711 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1712 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1713 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1714 * to use.
b23aa676
SO
1715 * @ssid: SSID
1716 * @ssid_len: Length of ssid in octets
1717 * @auth_type: Authentication type (algorithm)
abe37c4b
JB
1718 * @ie: IEs for association request
1719 * @ie_len: Length of assoc_ie in octets
b23aa676 1720 * @privacy: indicates whether privacy-enabled APs should be used
cee00a95 1721 * @mfp: indicate whether management frame protection is used
b23aa676 1722 * @crypto: crypto settings
fffd0934
JB
1723 * @key_len: length of WEP key for shared key authentication
1724 * @key_idx: index of WEP key for shared key authentication
1725 * @key: WEP key for shared key authentication
7e7c8926 1726 * @flags: See &enum cfg80211_assoc_req_flags
4486ea98 1727 * @bg_scan_period: Background scan period in seconds
ad24b0da 1728 * or -1 to indicate that default value is to be used.
7e7c8926 1729 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
ad24b0da 1730 * will be used in ht_capa. Un-supported values will be ignored.
7e7c8926 1731 * @ht_capa_mask: The bits of ht_capa which are to be used.
ee2aca34
JB
1732 * @vht_capa: VHT Capability overrides
1733 * @vht_capa_mask: The bits of vht_capa which are to be used.
b23aa676
SO
1734 */
1735struct cfg80211_connect_params {
1736 struct ieee80211_channel *channel;
1df4a510 1737 struct ieee80211_channel *channel_hint;
664834de 1738 const u8 *bssid;
1df4a510 1739 const u8 *bssid_hint;
664834de 1740 const u8 *ssid;
b23aa676
SO
1741 size_t ssid_len;
1742 enum nl80211_auth_type auth_type;
4b5800fe 1743 const u8 *ie;
b23aa676
SO
1744 size_t ie_len;
1745 bool privacy;
cee00a95 1746 enum nl80211_mfp mfp;
b23aa676 1747 struct cfg80211_crypto_settings crypto;
fffd0934
JB
1748 const u8 *key;
1749 u8 key_len, key_idx;
7e7c8926 1750 u32 flags;
4486ea98 1751 int bg_scan_period;
7e7c8926
BG
1752 struct ieee80211_ht_cap ht_capa;
1753 struct ieee80211_ht_cap ht_capa_mask;
ee2aca34
JB
1754 struct ieee80211_vht_cap vht_capa;
1755 struct ieee80211_vht_cap vht_capa_mask;
b23aa676
SO
1756};
1757
b9a5f8ca
JM
1758/**
1759 * enum wiphy_params_flags - set_wiphy_params bitfield values
abe37c4b
JB
1760 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1761 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1762 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1763 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1764 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
b9a5f8ca
JM
1765 */
1766enum wiphy_params_flags {
1767 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1768 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1769 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1770 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
81077e82 1771 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
b9a5f8ca
JM
1772};
1773
9930380f
JB
1774/*
1775 * cfg80211_bitrate_mask - masks for bitrate control
1776 */
1777struct cfg80211_bitrate_mask {
9930380f
JB
1778 struct {
1779 u32 legacy;
d1e33e65 1780 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
204e35a9 1781 u16 vht_mcs[NL80211_VHT_NSS_MAX];
0b9323f6 1782 enum nl80211_txrate_gi gi;
9930380f 1783 } control[IEEE80211_NUM_BANDS];
9930380f 1784};
67fbb16b
SO
1785/**
1786 * struct cfg80211_pmksa - PMK Security Association
1787 *
1788 * This structure is passed to the set/del_pmksa() method for PMKSA
1789 * caching.
1790 *
1791 * @bssid: The AP's BSSID.
1792 * @pmkid: The PMK material itself.
1793 */
1794struct cfg80211_pmksa {
1795 u8 *bssid;
1796 u8 *pmkid;
1797};
9930380f 1798
ff1b6e69 1799/**
50ac6607 1800 * struct cfg80211_pkt_pattern - packet pattern
ff1b6e69
JB
1801 * @mask: bitmask where to match pattern and where to ignore bytes,
1802 * one bit per byte, in same format as nl80211
1803 * @pattern: bytes to match where bitmask is 1
1804 * @pattern_len: length of pattern (in bytes)
bb92d199 1805 * @pkt_offset: packet offset (in bytes)
ff1b6e69
JB
1806 *
1807 * Internal note: @mask and @pattern are allocated in one chunk of
1808 * memory, free @mask only!
1809 */
50ac6607 1810struct cfg80211_pkt_pattern {
ff1b6e69
JB
1811 u8 *mask, *pattern;
1812 int pattern_len;
bb92d199 1813 int pkt_offset;
ff1b6e69
JB
1814};
1815
2a0e047e
JB
1816/**
1817 * struct cfg80211_wowlan_tcp - TCP connection parameters
1818 *
1819 * @sock: (internal) socket for source port allocation
1820 * @src: source IP address
1821 * @dst: destination IP address
1822 * @dst_mac: destination MAC address
1823 * @src_port: source port
1824 * @dst_port: destination port
1825 * @payload_len: data payload length
1826 * @payload: data payload buffer
1827 * @payload_seq: payload sequence stamping configuration
1828 * @data_interval: interval at which to send data packets
1829 * @wake_len: wakeup payload match length
1830 * @wake_data: wakeup payload match data
1831 * @wake_mask: wakeup payload match mask
1832 * @tokens_size: length of the tokens buffer
1833 * @payload_tok: payload token usage configuration
1834 */
1835struct cfg80211_wowlan_tcp {
1836 struct socket *sock;
1837 __be32 src, dst;
1838 u16 src_port, dst_port;
1839 u8 dst_mac[ETH_ALEN];
1840 int payload_len;
1841 const u8 *payload;
1842 struct nl80211_wowlan_tcp_data_seq payload_seq;
1843 u32 data_interval;
1844 u32 wake_len;
1845 const u8 *wake_data, *wake_mask;
1846 u32 tokens_size;
1847 /* must be last, variable member */
1848 struct nl80211_wowlan_tcp_data_token payload_tok;
ff1b6e69
JB
1849};
1850
1851/**
1852 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1853 *
1854 * This structure defines the enabled WoWLAN triggers for the device.
1855 * @any: wake up on any activity -- special trigger if device continues
1856 * operating as normal during suspend
1857 * @disconnect: wake up if getting disconnected
1858 * @magic_pkt: wake up on receiving magic packet
1859 * @patterns: wake up on receiving packet matching a pattern
1860 * @n_patterns: number of patterns
77dbbb13
JB
1861 * @gtk_rekey_failure: wake up on GTK rekey failure
1862 * @eap_identity_req: wake up on EAP identity request packet
1863 * @four_way_handshake: wake up on 4-way handshake
1864 * @rfkill_release: wake up when rfkill is released
2a0e047e
JB
1865 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1866 * NULL if not configured.
ff1b6e69
JB
1867 */
1868struct cfg80211_wowlan {
77dbbb13
JB
1869 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1870 eap_identity_req, four_way_handshake,
1871 rfkill_release;
50ac6607 1872 struct cfg80211_pkt_pattern *patterns;
2a0e047e 1873 struct cfg80211_wowlan_tcp *tcp;
ff1b6e69
JB
1874 int n_patterns;
1875};
1876
be29b99a
AK
1877/**
1878 * struct cfg80211_coalesce_rules - Coalesce rule parameters
1879 *
1880 * This structure defines coalesce rule for the device.
1881 * @delay: maximum coalescing delay in msecs.
1882 * @condition: condition for packet coalescence.
1883 * see &enum nl80211_coalesce_condition.
1884 * @patterns: array of packet patterns
1885 * @n_patterns: number of patterns
1886 */
1887struct cfg80211_coalesce_rules {
1888 int delay;
1889 enum nl80211_coalesce_condition condition;
1890 struct cfg80211_pkt_pattern *patterns;
1891 int n_patterns;
1892};
1893
1894/**
1895 * struct cfg80211_coalesce - Packet coalescing settings
1896 *
1897 * This structure defines coalescing settings.
1898 * @rules: array of coalesce rules
1899 * @n_rules: number of rules
1900 */
1901struct cfg80211_coalesce {
1902 struct cfg80211_coalesce_rules *rules;
1903 int n_rules;
1904};
1905
cd8f7cb4
JB
1906/**
1907 * struct cfg80211_wowlan_wakeup - wakeup report
1908 * @disconnect: woke up by getting disconnected
1909 * @magic_pkt: woke up by receiving magic packet
1910 * @gtk_rekey_failure: woke up by GTK rekey failure
1911 * @eap_identity_req: woke up by EAP identity request packet
1912 * @four_way_handshake: woke up by 4-way handshake
1913 * @rfkill_release: woke up by rfkill being released
1914 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
1915 * @packet_present_len: copied wakeup packet data
1916 * @packet_len: original wakeup packet length
1917 * @packet: The packet causing the wakeup, if any.
1918 * @packet_80211: For pattern match, magic packet and other data
1919 * frame triggers an 802.3 frame should be reported, for
1920 * disconnect due to deauth 802.11 frame. This indicates which
1921 * it is.
2a0e047e
JB
1922 * @tcp_match: TCP wakeup packet received
1923 * @tcp_connlost: TCP connection lost or failed to establish
1924 * @tcp_nomoretokens: TCP data ran out of tokens
cd8f7cb4
JB
1925 */
1926struct cfg80211_wowlan_wakeup {
1927 bool disconnect, magic_pkt, gtk_rekey_failure,
1928 eap_identity_req, four_way_handshake,
2a0e047e
JB
1929 rfkill_release, packet_80211,
1930 tcp_match, tcp_connlost, tcp_nomoretokens;
cd8f7cb4
JB
1931 s32 pattern_idx;
1932 u32 packet_present_len, packet_len;
1933 const void *packet;
1934};
1935
e5497d76
JB
1936/**
1937 * struct cfg80211_gtk_rekey_data - rekey data
1938 * @kek: key encryption key
1939 * @kck: key confirmation key
1940 * @replay_ctr: replay counter
1941 */
1942struct cfg80211_gtk_rekey_data {
1943 u8 kek[NL80211_KEK_LEN];
1944 u8 kck[NL80211_KCK_LEN];
1945 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1946};
1947
355199e0
JM
1948/**
1949 * struct cfg80211_update_ft_ies_params - FT IE Information
1950 *
1951 * This structure provides information needed to update the fast transition IE
1952 *
1953 * @md: The Mobility Domain ID, 2 Octet value
1954 * @ie: Fast Transition IEs
1955 * @ie_len: Length of ft_ie in octets
1956 */
1957struct cfg80211_update_ft_ies_params {
1958 u16 md;
1959 const u8 *ie;
1960 size_t ie_len;
1961};
1962
b176e629
AO
1963/**
1964 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
1965 *
1966 * This structure provides information needed to transmit a mgmt frame
1967 *
1968 * @chan: channel to use
1969 * @offchan: indicates wether off channel operation is required
1970 * @wait: duration for ROC
1971 * @buf: buffer to transmit
1972 * @len: buffer length
1973 * @no_cck: don't use cck rates for this frame
1974 * @dont_wait_for_ack: tells the low level not to wait for an ack
1975 */
1976struct cfg80211_mgmt_tx_params {
1977 struct ieee80211_channel *chan;
1978 bool offchan;
1979 unsigned int wait;
1980 const u8 *buf;
1981 size_t len;
1982 bool no_cck;
1983 bool dont_wait_for_ack;
1984};
1985
fa9ffc74
KP
1986/**
1987 * struct cfg80211_dscp_exception - DSCP exception
1988 *
1989 * @dscp: DSCP value that does not adhere to the user priority range definition
1990 * @up: user priority value to which the corresponding DSCP value belongs
1991 */
1992struct cfg80211_dscp_exception {
1993 u8 dscp;
1994 u8 up;
1995};
1996
1997/**
1998 * struct cfg80211_dscp_range - DSCP range definition for user priority
1999 *
2000 * @low: lowest DSCP value of this user priority range, inclusive
2001 * @high: highest DSCP value of this user priority range, inclusive
2002 */
2003struct cfg80211_dscp_range {
2004 u8 low;
2005 u8 high;
2006};
2007
2008/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2009#define IEEE80211_QOS_MAP_MAX_EX 21
2010#define IEEE80211_QOS_MAP_LEN_MIN 16
2011#define IEEE80211_QOS_MAP_LEN_MAX \
2012 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2013
2014/**
2015 * struct cfg80211_qos_map - QoS Map Information
2016 *
2017 * This struct defines the Interworking QoS map setting for DSCP values
2018 *
2019 * @num_des: number of DSCP exceptions (0..21)
2020 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2021 * the user priority DSCP range definition
2022 * @up: DSCP range definition for a particular user priority
2023 */
2024struct cfg80211_qos_map {
2025 u8 num_des;
2026 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2027 struct cfg80211_dscp_range up[8];
2028};
2029
704232c2
JB
2030/**
2031 * struct cfg80211_ops - backend description for wireless configuration
2032 *
2033 * This struct is registered by fullmac card drivers and/or wireless stacks
2034 * in order to handle configuration requests on their interfaces.
2035 *
2036 * All callbacks except where otherwise noted should return 0
2037 * on success or a negative error code.
2038 *
43fb45cb
JB
2039 * All operations are currently invoked under rtnl for consistency with the
2040 * wireless extensions but this is subject to reevaluation as soon as this
2041 * code is used more widely and we have a first user without wext.
2042 *
ff1b6e69
JB
2043 * @suspend: wiphy device needs to be suspended. The variable @wow will
2044 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2045 * configured for the device.
0378b3f1 2046 * @resume: wiphy device needs to be resumed
6d52563f
JB
2047 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2048 * to call device_set_wakeup_enable() to enable/disable wakeup from
2049 * the device.
0378b3f1 2050 *
60719ffd 2051 * @add_virtual_intf: create a new virtual interface with the given name,
463d0183 2052 * must set the struct wireless_dev's iftype. Beware: You must create
84efbb84 2053 * the new netdev in the wiphy's network namespace! Returns the struct
98104fde
JB
2054 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2055 * also set the address member in the wdev.
704232c2 2056 *
84efbb84 2057 * @del_virtual_intf: remove the virtual interface
55682965 2058 *
60719ffd
JB
2059 * @change_virtual_intf: change type/configuration of virtual interface,
2060 * keep the struct wireless_dev's iftype updated.
55682965 2061 *
41ade00f
JB
2062 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2063 * when adding a group key.
2064 *
2065 * @get_key: get information about the key with the given parameters.
2066 * @mac_addr will be %NULL when requesting information for a group
2067 * key. All pointers given to the @callback function need not be valid
e3da574a
JB
2068 * after it returns. This function should return an error if it is
2069 * not possible to retrieve the key, -ENOENT if it doesn't exist.
41ade00f
JB
2070 *
2071 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
e3da574a 2072 * and @key_index, return -ENOENT if the key doesn't exist.
41ade00f
JB
2073 *
2074 * @set_default_key: set the default key on an interface
ed1b6cc7 2075 *
3cfcf6ac
JM
2076 * @set_default_mgmt_key: set the default management frame key on an interface
2077 *
e5497d76
JB
2078 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2079 *
c04a4ff7
JB
2080 * @start_ap: Start acting in AP mode defined by the parameters.
2081 * @change_beacon: Change the beacon parameters for an access point mode
2082 * interface. This should reject the call when AP mode wasn't started.
2083 * @stop_ap: Stop being an AP, including stopping beaconing.
5727ef1b
JB
2084 *
2085 * @add_station: Add a new station.
5727ef1b 2086 * @del_station: Remove a station; @mac may be NULL to remove all stations.
bdd90d5e
JB
2087 * @change_station: Modify a given station. Note that flags changes are not much
2088 * validated in cfg80211, in particular the auth/assoc/authorized flags
2089 * might come to the driver in invalid combinations -- make sure to check
77ee7c89
JB
2090 * them, also against the existing state! Drivers must call
2091 * cfg80211_check_station_change() to validate the information.
abe37c4b
JB
2092 * @get_station: get station information for the station identified by @mac
2093 * @dump_station: dump station callback -- resume dump at index @idx
2094 *
2095 * @add_mpath: add a fixed mesh path
2096 * @del_mpath: delete a given mesh path
2097 * @change_mpath: change a given mesh path
2098 * @get_mpath: get a mesh path for the given parameters
2099 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
f52555a4 2100 * @join_mesh: join the mesh network with the specified parameters
8d61ffa5 2101 * (invoked with the wireless_dev mutex held)
f52555a4 2102 * @leave_mesh: leave the current mesh network
8d61ffa5 2103 * (invoked with the wireless_dev mutex held)
2ec600d6 2104 *
24bdd9f4 2105 * @get_mesh_config: Get the current mesh configuration
93da9cc1 2106 *
24bdd9f4 2107 * @update_mesh_config: Update mesh parameters on a running mesh.
93da9cc1 2108 * The mask is a bitfield which tells us which parameters to
2109 * set, and which to leave alone.
2110 *
9f1ba906 2111 * @change_bss: Modify parameters for a given BSS.
31888487
JM
2112 *
2113 * @set_txq_params: Set TX queue parameters
72bdcf34 2114 *
e8c9bd5b
JB
2115 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2116 * as it doesn't implement join_mesh and needs to set the channel to
2117 * join the mesh instead.
2118 *
2119 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2120 * interfaces are active this callback should reject the configuration.
2121 * If no interfaces are active or the device is down, the channel should
2122 * be stored for when a monitor interface becomes active.
9aed3cc1 2123 *
2a519311
JB
2124 * @scan: Request to do a scan. If returning zero, the scan request is given
2125 * the driver, and will be valid until passed to cfg80211_scan_done().
2126 * For scan results, call cfg80211_inform_bss(); you can call this outside
2127 * the scan/scan_done bracket too.
636a5d36
JM
2128 *
2129 * @auth: Request to authenticate with the specified peer
8d61ffa5 2130 * (invoked with the wireless_dev mutex held)
636a5d36 2131 * @assoc: Request to (re)associate with the specified peer
8d61ffa5 2132 * (invoked with the wireless_dev mutex held)
636a5d36 2133 * @deauth: Request to deauthenticate from the specified peer
8d61ffa5 2134 * (invoked with the wireless_dev mutex held)
636a5d36 2135 * @disassoc: Request to disassociate from the specified peer
8d61ffa5 2136 * (invoked with the wireless_dev mutex held)
04a773ad 2137 *
b23aa676
SO
2138 * @connect: Connect to the ESS with the specified parameters. When connected,
2139 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2140 * If the connection fails for some reason, call cfg80211_connect_result()
2141 * with the status from the AP.
8d61ffa5 2142 * (invoked with the wireless_dev mutex held)
b23aa676 2143 * @disconnect: Disconnect from the BSS/ESS.
8d61ffa5 2144 * (invoked with the wireless_dev mutex held)
b23aa676 2145 *
04a773ad
JB
2146 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2147 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2148 * to a merge.
8d61ffa5 2149 * (invoked with the wireless_dev mutex held)
04a773ad 2150 * @leave_ibss: Leave the IBSS.
8d61ffa5 2151 * (invoked with the wireless_dev mutex held)
b9a5f8ca 2152 *
f4e583c8
AQ
2153 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2154 * MESH mode)
2155 *
b9a5f8ca
JM
2156 * @set_wiphy_params: Notify that wiphy parameters have changed;
2157 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2158 * have changed. The actual parameter values are available in
2159 * struct wiphy. If returning an error, no value should be changed.
7643a2c3 2160 *
1432de07 2161 * @set_tx_power: set the transmit power according to the parameters,
c8442118
JB
2162 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2163 * wdev may be %NULL if power was set for the wiphy, and will
2164 * always be %NULL unless the driver supports per-vif TX power
2165 * (as advertised by the nl80211 feature flag.)
7643a2c3 2166 * @get_tx_power: store the current TX power into the dbm variable;
1f87f7d3
JB
2167 * return 0 if successful
2168 *
abe37c4b
JB
2169 * @set_wds_peer: set the WDS peer for a WDS interface
2170 *
1f87f7d3
JB
2171 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2172 * functions to adjust rfkill hw state
aff89a9b 2173 *
61fa713c
HS
2174 * @dump_survey: get site survey information.
2175 *
9588bbd5
JM
2176 * @remain_on_channel: Request the driver to remain awake on the specified
2177 * channel for the specified duration to complete an off-channel
2178 * operation (e.g., public action frame exchange). When the driver is
2179 * ready on the requested channel, it must indicate this with an event
2180 * notification by calling cfg80211_ready_on_channel().
2181 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2182 * This allows the operation to be terminated prior to timeout based on
2183 * the duration value.
f7ca38df
JB
2184 * @mgmt_tx: Transmit a management frame.
2185 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2186 * frame on another channel
9588bbd5 2187 *
fc73f11f 2188 * @testmode_cmd: run a test mode command; @wdev may be %NULL
71063f0e
WYG
2189 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2190 * used by the function, but 0 and 1 must not be touched. Additionally,
2191 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2192 * dump and return to userspace with an error, so be careful. If any data
2193 * was passed in from userspace then the data/len arguments will be present
2194 * and point to the data contained in %NL80211_ATTR_TESTDATA.
67fbb16b 2195 *
abe37c4b
JB
2196 * @set_bitrate_mask: set the bitrate mask configuration
2197 *
67fbb16b
SO
2198 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2199 * devices running firmwares capable of generating the (re) association
2200 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2201 * @del_pmksa: Delete a cached PMKID.
2202 * @flush_pmksa: Flush all cached PMKIDs.
9043f3b8
JO
2203 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2204 * allows the driver to adjust the dynamic ps timeout value.
d6dc1a38 2205 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
84f10708
TP
2206 * @set_cqm_txe_config: Configure connection quality monitor TX error
2207 * thresholds.
807f8a8c 2208 * @sched_scan_start: Tell the driver to start a scheduled scan.
d9b8396a
JB
2209 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2210 * call must stop the scheduled scan and be ready for starting a new one
2211 * before it returns, i.e. @sched_scan_start may be called immediately
2212 * after that again and should not fail in that case. The driver should
2213 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2214 * method returns 0.)
67fbb16b 2215 *
271733cf
JB
2216 * @mgmt_frame_register: Notify driver that a management frame type was
2217 * registered. Note that this callback may not sleep, and cannot run
2218 * concurrently with itself.
547025d5
BR
2219 *
2220 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2221 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2222 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2223 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2224 *
2225 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3677713b
JL
2226 *
2227 * @set_ringparam: Set tx and rx ring sizes.
2228 *
2229 * @get_ringparam: Get tx and rx ring current and maximum sizes.
109086ce
AN
2230 *
2231 * @tdls_mgmt: Transmit a TDLS management frame.
2232 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
7f6cf311
JB
2233 *
2234 * @probe_client: probe an associated client, must return a cookie that it
2235 * later passes to cfg80211_probe_status().
1d9d9213
SW
2236 *
2237 * @set_noack_map: Set the NoAck Map for the TIDs.
d6199218
BG
2238 *
2239 * @get_et_sset_count: Ethtool API to get string-set count.
2240 * See @ethtool_ops.get_sset_count
2241 *
2242 * @get_et_stats: Ethtool API to get a set of u64 stats.
2243 * See @ethtool_ops.get_ethtool_stats
2244 *
2245 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2246 * and perhaps other supported types of ethtool data-sets.
2247 * See @ethtool_ops.get_strings
5b7ccaf3
JB
2248 *
2249 * @get_channel: Get the current operating channel for the virtual interface.
2250 * For monitor interfaces, it should return %NULL unless there's a single
2251 * current monitoring channel.
98104fde
JB
2252 *
2253 * @start_p2p_device: Start the given P2P device.
2254 * @stop_p2p_device: Stop the given P2P device.
77765eaf
VT
2255 *
2256 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2257 * Parameters include ACL policy, an array of MAC address of stations
2258 * and the number of MAC addresses. If there is already a list in driver
2259 * this new list replaces the existing one. Driver has to clear its ACL
2260 * when number of MAC addresses entries is passed as 0. Drivers which
2261 * advertise the support for MAC based ACL have to implement this callback.
04f39047
SW
2262 *
2263 * @start_radar_detection: Start radar detection in the driver.
8bf24293
JM
2264 *
2265 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2266 * driver. If the SME is in the driver/firmware, this information can be
2267 * used in building Authentication and Reassociation Request frames.
5de17984
AS
2268 *
2269 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2270 * for a given duration (milliseconds). The protocol is provided so the
2271 * driver can take the most appropriate actions.
2272 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2273 * reliability. This operation can not fail.
be29b99a 2274 * @set_coalesce: Set coalesce parameters.
16ef1fe2
SW
2275 *
2276 * @channel_switch: initiate channel-switch procedure (with CSA)
fa9ffc74
KP
2277 *
2278 * @set_qos_map: Set QoS mapping information to the driver
704232c2
JB
2279 */
2280struct cfg80211_ops {
ff1b6e69 2281 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
0378b3f1 2282 int (*resume)(struct wiphy *wiphy);
6d52563f 2283 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
0378b3f1 2284
84efbb84 2285 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
552bff0c 2286 const char *name,
84efbb84
JB
2287 enum nl80211_iftype type,
2288 u32 *flags,
2289 struct vif_params *params);
2290 int (*del_virtual_intf)(struct wiphy *wiphy,
2291 struct wireless_dev *wdev);
e36d56b6
JB
2292 int (*change_virtual_intf)(struct wiphy *wiphy,
2293 struct net_device *dev,
2ec600d6
LCC
2294 enum nl80211_iftype type, u32 *flags,
2295 struct vif_params *params);
41ade00f
JB
2296
2297 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
e31b8213 2298 u8 key_index, bool pairwise, const u8 *mac_addr,
41ade00f
JB
2299 struct key_params *params);
2300 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
e31b8213
JB
2301 u8 key_index, bool pairwise, const u8 *mac_addr,
2302 void *cookie,
41ade00f
JB
2303 void (*callback)(void *cookie, struct key_params*));
2304 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
e31b8213 2305 u8 key_index, bool pairwise, const u8 *mac_addr);
41ade00f
JB
2306 int (*set_default_key)(struct wiphy *wiphy,
2307 struct net_device *netdev,
dbd2fd65 2308 u8 key_index, bool unicast, bool multicast);
3cfcf6ac
JM
2309 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2310 struct net_device *netdev,
2311 u8 key_index);
ed1b6cc7 2312
8860020e
JB
2313 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2314 struct cfg80211_ap_settings *settings);
2315 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2316 struct cfg80211_beacon_data *info);
2317 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
5727ef1b
JB
2318
2319
2320 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2321 u8 *mac, struct station_parameters *params);
2322 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2323 u8 *mac);
2324 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2325 u8 *mac, struct station_parameters *params);
fd5b74dc 2326 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2ec600d6
LCC
2327 u8 *mac, struct station_info *sinfo);
2328 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2329 int idx, u8 *mac, struct station_info *sinfo);
2330
2331 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2332 u8 *dst, u8 *next_hop);
2333 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2334 u8 *dst);
2335 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2336 u8 *dst, u8 *next_hop);
2337 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2338 u8 *dst, u8 *next_hop,
2339 struct mpath_info *pinfo);
2340 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2341 int idx, u8 *dst, u8 *next_hop,
2342 struct mpath_info *pinfo);
24bdd9f4 2343 int (*get_mesh_config)(struct wiphy *wiphy,
93da9cc1 2344 struct net_device *dev,
2345 struct mesh_config *conf);
24bdd9f4 2346 int (*update_mesh_config)(struct wiphy *wiphy,
29cbe68c
JB
2347 struct net_device *dev, u32 mask,
2348 const struct mesh_config *nconf);
2349 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2350 const struct mesh_config *conf,
2351 const struct mesh_setup *setup);
2352 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2353
9f1ba906
JM
2354 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2355 struct bss_parameters *params);
31888487 2356
f70f01c2 2357 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
31888487 2358 struct ieee80211_txq_params *params);
72bdcf34 2359
e8c9bd5b
JB
2360 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2361 struct net_device *dev,
2362 struct ieee80211_channel *chan);
2363
2364 int (*set_monitor_channel)(struct wiphy *wiphy,
683b6d3b 2365 struct cfg80211_chan_def *chandef);
9aed3cc1 2366
fd014284 2367 int (*scan)(struct wiphy *wiphy,
2a519311 2368 struct cfg80211_scan_request *request);
636a5d36
JM
2369
2370 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2371 struct cfg80211_auth_request *req);
2372 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2373 struct cfg80211_assoc_request *req);
2374 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
63c9c5e7 2375 struct cfg80211_deauth_request *req);
636a5d36 2376 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
63c9c5e7 2377 struct cfg80211_disassoc_request *req);
04a773ad 2378
b23aa676
SO
2379 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2380 struct cfg80211_connect_params *sme);
2381 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2382 u16 reason_code);
2383
04a773ad
JB
2384 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2385 struct cfg80211_ibss_params *params);
2386 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
b9a5f8ca 2387
f4e583c8
AQ
2388 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2389 int rate[IEEE80211_NUM_BANDS]);
2390
b9a5f8ca 2391 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
7643a2c3 2392
c8442118 2393 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
fa61cf70 2394 enum nl80211_tx_power_setting type, int mbm);
c8442118
JB
2395 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2396 int *dbm);
1f87f7d3 2397
ab737a4f 2398 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
388ac775 2399 const u8 *addr);
ab737a4f 2400
1f87f7d3 2401 void (*rfkill_poll)(struct wiphy *wiphy);
aff89a9b
JB
2402
2403#ifdef CONFIG_NL80211_TESTMODE
fc73f11f
DS
2404 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2405 void *data, int len);
71063f0e
WYG
2406 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2407 struct netlink_callback *cb,
2408 void *data, int len);
aff89a9b 2409#endif
bc92afd9 2410
9930380f
JB
2411 int (*set_bitrate_mask)(struct wiphy *wiphy,
2412 struct net_device *dev,
2413 const u8 *peer,
2414 const struct cfg80211_bitrate_mask *mask);
2415
61fa713c
HS
2416 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2417 int idx, struct survey_info *info);
2418
67fbb16b
SO
2419 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2420 struct cfg80211_pmksa *pmksa);
2421 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2422 struct cfg80211_pmksa *pmksa);
2423 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2424
9588bbd5 2425 int (*remain_on_channel)(struct wiphy *wiphy,
71bbc994 2426 struct wireless_dev *wdev,
9588bbd5 2427 struct ieee80211_channel *chan,
9588bbd5
JM
2428 unsigned int duration,
2429 u64 *cookie);
2430 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
71bbc994 2431 struct wireless_dev *wdev,
9588bbd5
JM
2432 u64 cookie);
2433
71bbc994 2434 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
b176e629
AO
2435 struct cfg80211_mgmt_tx_params *params,
2436 u64 *cookie);
f7ca38df 2437 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
71bbc994 2438 struct wireless_dev *wdev,
f7ca38df 2439 u64 cookie);
026331c4 2440
bc92afd9
JB
2441 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2442 bool enabled, int timeout);
d6dc1a38
JO
2443
2444 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2445 struct net_device *dev,
2446 s32 rssi_thold, u32 rssi_hyst);
271733cf 2447
84f10708
TP
2448 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2449 struct net_device *dev,
2450 u32 rate, u32 pkts, u32 intvl);
2451
271733cf 2452 void (*mgmt_frame_register)(struct wiphy *wiphy,
71bbc994 2453 struct wireless_dev *wdev,
271733cf 2454 u16 frame_type, bool reg);
afe0cbf8
BR
2455
2456 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2457 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3677713b
JL
2458
2459 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
2460 void (*get_ringparam)(struct wiphy *wiphy,
2461 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
807f8a8c
LC
2462
2463 int (*sched_scan_start)(struct wiphy *wiphy,
2464 struct net_device *dev,
2465 struct cfg80211_sched_scan_request *request);
85a9994a 2466 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
e5497d76
JB
2467
2468 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2469 struct cfg80211_gtk_rekey_data *data);
109086ce
AN
2470
2471 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2472 u8 *peer, u8 action_code, u8 dialog_token,
df942e7b
SDU
2473 u16 status_code, u32 peer_capability,
2474 const u8 *buf, size_t len);
109086ce
AN
2475 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2476 u8 *peer, enum nl80211_tdls_operation oper);
7f6cf311
JB
2477
2478 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2479 const u8 *peer, u64 *cookie);
e999882a 2480
1d9d9213
SW
2481 int (*set_noack_map)(struct wiphy *wiphy,
2482 struct net_device *dev,
2483 u16 noack_map);
2484
d6199218
BG
2485 int (*get_et_sset_count)(struct wiphy *wiphy,
2486 struct net_device *dev, int sset);
2487 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
2488 struct ethtool_stats *stats, u64 *data);
2489 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
2490 u32 sset, u8 *data);
dbbae26a 2491
683b6d3b 2492 int (*get_channel)(struct wiphy *wiphy,
5b7ccaf3 2493 struct wireless_dev *wdev,
683b6d3b 2494 struct cfg80211_chan_def *chandef);
98104fde
JB
2495
2496 int (*start_p2p_device)(struct wiphy *wiphy,
2497 struct wireless_dev *wdev);
2498 void (*stop_p2p_device)(struct wiphy *wiphy,
2499 struct wireless_dev *wdev);
77765eaf
VT
2500
2501 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2502 const struct cfg80211_acl_data *params);
04f39047
SW
2503
2504 int (*start_radar_detection)(struct wiphy *wiphy,
2505 struct net_device *dev,
2506 struct cfg80211_chan_def *chandef);
355199e0
JM
2507 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2508 struct cfg80211_update_ft_ies_params *ftie);
5de17984
AS
2509 int (*crit_proto_start)(struct wiphy *wiphy,
2510 struct wireless_dev *wdev,
2511 enum nl80211_crit_proto_id protocol,
2512 u16 duration);
2513 void (*crit_proto_stop)(struct wiphy *wiphy,
2514 struct wireless_dev *wdev);
be29b99a
AK
2515 int (*set_coalesce)(struct wiphy *wiphy,
2516 struct cfg80211_coalesce *coalesce);
16ef1fe2
SW
2517
2518 int (*channel_switch)(struct wiphy *wiphy,
2519 struct net_device *dev,
2520 struct cfg80211_csa_settings *params);
fa9ffc74
KP
2521 int (*set_qos_map)(struct wiphy *wiphy,
2522 struct net_device *dev,
2523 struct cfg80211_qos_map *qos_map);
704232c2
JB
2524};
2525
d3236553
JB
2526/*
2527 * wireless hardware and networking interfaces structures
2528 * and registration/helper functions
2529 */
2530
2531/**
5be83de5
JB
2532 * enum wiphy_flags - wiphy capability flags
2533 *
5be83de5
JB
2534 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2535 * wiphy at all
2536 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2537 * by default -- this flag will be set depending on the kernel's default
2538 * on wiphy_new(), but can be changed by the driver if it has a good
2539 * reason to override the default
9bc383de
JB
2540 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2541 * on a VLAN interface)
2542 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
c0692b8f
JB
2543 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2544 * control port protocol ethertype. The device also honours the
2545 * control_port_no_encrypt flag.
e31b8213 2546 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
15d5dda6
JC
2547 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2548 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1ba01458 2549 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
f4b34b55
VN
2550 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2551 * firmware.
cedb5412 2552 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
109086ce
AN
2553 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2554 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2555 * link setup/discovery operations internally. Setup, discovery and
2556 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2557 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2558 * used for asking the driver/firmware to perform a TDLS operation.
562a7480 2559 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
5e760230
JB
2560 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2561 * when there are virtual interfaces in AP mode by calling
2562 * cfg80211_report_obss_beacon().
87bbbe22
AN
2563 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2564 * responds to probe-requests in hardware.
7c4ef712
JB
2565 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2566 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2f301ab2 2567 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
16ef1fe2
SW
2568 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2569 * beaconing mode (AP, IBSS, Mesh, ...).
5be83de5
JB
2570 */
2571enum wiphy_flags {
a2f73b6c
LR
2572 /* use hole at 0 */
2573 /* use hole at 1 */
2574 /* use hole at 2 */
c0692b8f
JB
2575 WIPHY_FLAG_NETNS_OK = BIT(3),
2576 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2577 WIPHY_FLAG_4ADDR_AP = BIT(5),
2578 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2579 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
309075cf 2580 WIPHY_FLAG_IBSS_RSN = BIT(8),
15d5dda6 2581 WIPHY_FLAG_MESH_AUTH = BIT(10),
807f8a8c 2582 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
8e8b41f9 2583 /* use hole at 12 */
f4b34b55 2584 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
cedb5412 2585 WIPHY_FLAG_AP_UAPSD = BIT(14),
109086ce
AN
2586 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2587 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
562a7480 2588 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
5e760230 2589 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
87bbbe22 2590 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
7c4ef712
JB
2591 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2592 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2f301ab2 2593 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
16ef1fe2 2594 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
7527a782
JB
2595};
2596
2597/**
2598 * struct ieee80211_iface_limit - limit on certain interface types
2599 * @max: maximum number of interfaces of these types
2600 * @types: interface types (bits)
2601 */
2602struct ieee80211_iface_limit {
2603 u16 max;
2604 u16 types;
2605};
2606
2607/**
2608 * struct ieee80211_iface_combination - possible interface combination
2609 * @limits: limits for the given interface types
2610 * @n_limits: number of limitations
2611 * @num_different_channels: can use up to this many different channels
2612 * @max_interfaces: maximum number of interfaces in total allowed in this
2613 * group
2614 * @beacon_int_infra_match: In this combination, the beacon intervals
2615 * between infrastructure and AP types must match. This is required
2616 * only in special cases.
11c4a075 2617 * @radar_detect_widths: bitmap of channel widths supported for radar detection
7527a782
JB
2618 *
2619 * These examples can be expressed as follows:
2620 *
2621 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2622 *
2623 * struct ieee80211_iface_limit limits1[] = {
2624 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2625 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2626 * };
2627 * struct ieee80211_iface_combination combination1 = {
2628 * .limits = limits1,
2629 * .n_limits = ARRAY_SIZE(limits1),
2630 * .max_interfaces = 2,
2631 * .beacon_int_infra_match = true,
2632 * };
2633 *
2634 *
2635 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2636 *
2637 * struct ieee80211_iface_limit limits2[] = {
2638 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2639 * BIT(NL80211_IFTYPE_P2P_GO), },
2640 * };
2641 * struct ieee80211_iface_combination combination2 = {
2642 * .limits = limits2,
2643 * .n_limits = ARRAY_SIZE(limits2),
2644 * .max_interfaces = 8,
2645 * .num_different_channels = 1,
2646 * };
2647 *
2648 *
2649 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2650 * This allows for an infrastructure connection and three P2P connections.
2651 *
2652 * struct ieee80211_iface_limit limits3[] = {
2653 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2654 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2655 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2656 * };
2657 * struct ieee80211_iface_combination combination3 = {
2658 * .limits = limits3,
2659 * .n_limits = ARRAY_SIZE(limits3),
2660 * .max_interfaces = 4,
2661 * .num_different_channels = 2,
2662 * };
2663 */
2664struct ieee80211_iface_combination {
2665 const struct ieee80211_iface_limit *limits;
2666 u32 num_different_channels;
2667 u16 max_interfaces;
2668 u8 n_limits;
2669 bool beacon_int_infra_match;
11c4a075 2670 u8 radar_detect_widths;
5be83de5
JB
2671};
2672
2e161f78
JB
2673struct ieee80211_txrx_stypes {
2674 u16 tx, rx;
2675};
2676
ff1b6e69
JB
2677/**
2678 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2679 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2680 * trigger that keeps the device operating as-is and
2681 * wakes up the host on any activity, for example a
2682 * received packet that passed filtering; note that the
2683 * packet should be preserved in that case
2684 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2685 * (see nl80211.h)
2686 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
77dbbb13
JB
2687 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2688 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2689 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2690 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2691 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
ff1b6e69
JB
2692 */
2693enum wiphy_wowlan_support_flags {
77dbbb13
JB
2694 WIPHY_WOWLAN_ANY = BIT(0),
2695 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2696 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2697 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2698 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2699 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2700 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2701 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
ff1b6e69
JB
2702};
2703
2a0e047e
JB
2704struct wiphy_wowlan_tcp_support {
2705 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2706 u32 data_payload_max;
2707 u32 data_interval_max;
2708 u32 wake_payload_max;
2709 bool seq;
2710};
2711
ff1b6e69
JB
2712/**
2713 * struct wiphy_wowlan_support - WoWLAN support data
2714 * @flags: see &enum wiphy_wowlan_support_flags
2715 * @n_patterns: number of supported wakeup patterns
2716 * (see nl80211.h for the pattern definition)
2717 * @pattern_max_len: maximum length of each pattern
2718 * @pattern_min_len: minimum length of each pattern
bb92d199 2719 * @max_pkt_offset: maximum Rx packet offset
2a0e047e 2720 * @tcp: TCP wakeup support information
ff1b6e69
JB
2721 */
2722struct wiphy_wowlan_support {
2723 u32 flags;
2724 int n_patterns;
2725 int pattern_max_len;
2726 int pattern_min_len;
bb92d199 2727 int max_pkt_offset;
2a0e047e 2728 const struct wiphy_wowlan_tcp_support *tcp;
ff1b6e69
JB
2729};
2730
be29b99a
AK
2731/**
2732 * struct wiphy_coalesce_support - coalesce support data
2733 * @n_rules: maximum number of coalesce rules
2734 * @max_delay: maximum supported coalescing delay in msecs
2735 * @n_patterns: number of supported patterns in a rule
2736 * (see nl80211.h for the pattern definition)
2737 * @pattern_max_len: maximum length of each pattern
2738 * @pattern_min_len: minimum length of each pattern
2739 * @max_pkt_offset: maximum Rx packet offset
2740 */
2741struct wiphy_coalesce_support {
2742 int n_rules;
2743 int max_delay;
2744 int n_patterns;
2745 int pattern_max_len;
2746 int pattern_min_len;
2747 int max_pkt_offset;
2748};
2749
ad7e718c
JB
2750/**
2751 * enum wiphy_vendor_command_flags - validation flags for vendor commands
2752 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
2753 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
2754 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
2755 * (must be combined with %_WDEV or %_NETDEV)
2756 */
2757enum wiphy_vendor_command_flags {
2758 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
2759 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
2760 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
2761};
2762
2763/**
2764 * struct wiphy_vendor_command - vendor command definition
2765 * @info: vendor command identifying information, as used in nl80211
2766 * @flags: flags, see &enum wiphy_vendor_command_flags
2767 * @doit: callback for the operation, note that wdev is %NULL if the
2768 * flags didn't ask for a wdev and non-%NULL otherwise; the data
2769 * pointer may be %NULL if userspace provided no data at all
2770 */
2771struct wiphy_vendor_command {
2772 struct nl80211_vendor_cmd_info info;
2773 u32 flags;
2774 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
2775 const void *data, int data_len);
2776};
2777
5be83de5
JB
2778/**
2779 * struct wiphy - wireless hardware description
2784fe91
LR
2780 * @reg_notifier: the driver's regulatory notification callback,
2781 * note that if your driver uses wiphy_apply_custom_regulatory()
2782 * the reg_notifier's request can be passed as NULL
d3236553
JB
2783 * @regd: the driver's regulatory domain, if one was requested via
2784 * the regulatory_hint() API. This can be used by the driver
2785 * on the reg_notifier() if it chooses to ignore future
2786 * regulatory domain changes caused by other drivers.
2787 * @signal_type: signal type reported in &struct cfg80211_bss.
2788 * @cipher_suites: supported cipher suites
2789 * @n_cipher_suites: number of supported cipher suites
b9a5f8ca
JM
2790 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2791 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2792 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2793 * -1 = fragmentation disabled, only odd values >= 256 used
2794 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
abe37c4b 2795 * @_net: the network namespace this wiphy currently lives in
ef15aac6
JB
2796 * @perm_addr: permanent MAC address of this device
2797 * @addr_mask: If the device supports multiple MAC addresses by masking,
2798 * set this to a mask with variable bits set to 1, e.g. if the last
0fcf8ac5 2799 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
ef15aac6
JB
2800 * variable bits shall be determined by the interfaces added, with
2801 * interfaces not matching the mask being rejected to be brought up.
2802 * @n_addresses: number of addresses in @addresses.
2803 * @addresses: If the device has more than one address, set this pointer
2804 * to a list of addresses (6 bytes each). The first one will be used
2805 * by default for perm_addr. In this case, the mask should be set to
2806 * all-zeroes. In this case it is assumed that the device can handle
2807 * the same number of arbitrary MAC addresses.
fd235913
RD
2808 * @registered: protects ->resume and ->suspend sysfs callbacks against
2809 * unregister hardware
abe37c4b
JB
2810 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2811 * automatically on wiphy renames
2812 * @dev: (virtual) struct device for this wiphy
4a711a85 2813 * @registered: helps synchronize suspend/resume with wiphy unregister
abe37c4b
JB
2814 * @wext: wireless extension handlers
2815 * @priv: driver private data (sized according to wiphy_new() parameter)
2816 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2817 * must be set by driver
7527a782
JB
2818 * @iface_combinations: Valid interface combinations array, should not
2819 * list single interface types.
2820 * @n_iface_combinations: number of entries in @iface_combinations array.
2821 * @software_iftypes: bitmask of software interface types, these are not
2822 * subject to any restrictions since they are purely managed in SW.
abe37c4b 2823 * @flags: wiphy flags, see &enum wiphy_flags
a2f73b6c
LR
2824 * @regulatory_flags: wiphy regulatory flags, see
2825 * &enum ieee80211_regulatory_flags
1f074bd8 2826 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
abe37c4b
JB
2827 * @bss_priv_size: each BSS struct has private data allocated with it,
2828 * this variable determines its size
2829 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2830 * any given scan
93b6aa69
LC
2831 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2832 * for in any given scheduled scan
a1f1c21c
LC
2833 * @max_match_sets: maximum number of match sets the device can handle
2834 * when performing a scheduled scan, 0 if filtering is not
2835 * supported.
abe37c4b
JB
2836 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2837 * add to probe request frames transmitted during a scan, must not
2838 * include fixed IEs like supported rates
5a865bad
LC
2839 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2840 * scans
abe37c4b
JB
2841 * @coverage_class: current coverage class
2842 * @fw_version: firmware version for ethtool reporting
2843 * @hw_version: hardware version for ethtool reporting
2844 * @max_num_pmkids: maximum number of PMKIDs supported by device
2845 * @privid: a pointer that drivers can use to identify if an arbitrary
2846 * wiphy is theirs, e.g. in global notifiers
2847 * @bands: information about bands/channels supported by this device
2e161f78
JB
2848 *
2849 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2850 * transmitted through nl80211, points to an array indexed by interface
2851 * type
a7ffac95 2852 *
7f531e03
BR
2853 * @available_antennas_tx: bitmap of antennas which are available to be
2854 * configured as TX antennas. Antenna configuration commands will be
2855 * rejected unless this or @available_antennas_rx is set.
2856 *
2857 * @available_antennas_rx: bitmap of antennas which are available to be
2858 * configured as RX antennas. Antenna configuration commands will be
2859 * rejected unless this or @available_antennas_tx is set.
a293911d 2860 *
15f0ebc2
RD
2861 * @probe_resp_offload:
2862 * Bitmap of supported protocols for probe response offloading.
2863 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2864 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2865 *
a293911d
JB
2866 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2867 * may request, if implemented.
ff1b6e69
JB
2868 *
2869 * @wowlan: WoWLAN support information
6abb9cb9
JB
2870 * @wowlan_config: current WoWLAN configuration; this should usually not be
2871 * used since access to it is necessarily racy, use the parameter passed
2872 * to the suspend() operation instead.
562a7480
JB
2873 *
2874 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
7e7c8926
BG
2875 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2876 * If null, then none can be over-ridden.
ee2aca34
JB
2877 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
2878 * If null, then none can be over-ridden.
77765eaf
VT
2879 *
2880 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
2881 * supports for ACL.
a50df0c4
JB
2882 *
2883 * @extended_capabilities: extended capabilities supported by the driver,
2884 * additional capabilities might be supported by userspace; these are
2885 * the 802.11 extended capabilities ("Extended Capabilities element")
2886 * and are in the same format as in the information element. See
2887 * 802.11-2012 8.4.2.29 for the defined fields.
2888 * @extended_capabilities_mask: mask of the valid values
2889 * @extended_capabilities_len: length of the extended capabilities
be29b99a 2890 * @coalesce: packet coalescing support information
ad7e718c
JB
2891 *
2892 * @vendor_commands: array of vendor commands supported by the hardware
2893 * @n_vendor_commands: number of vendor commands
567ffc35
JB
2894 * @vendor_events: array of vendor events supported by the hardware
2895 * @n_vendor_events: number of vendor events
b43504cf
JM
2896 *
2897 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
2898 * (including P2P GO) or 0 to indicate no such limit is advertised. The
2899 * driver is allowed to advertise a theoretical limit that it can reach in
2900 * some cases, but may not always reach.
d3236553
JB
2901 */
2902struct wiphy {
2903 /* assign these fields before you register the wiphy */
2904
ef15aac6 2905 /* permanent MAC address(es) */
d3236553 2906 u8 perm_addr[ETH_ALEN];
ef15aac6
JB
2907 u8 addr_mask[ETH_ALEN];
2908
ef15aac6 2909 struct mac_address *addresses;
d3236553 2910
2e161f78
JB
2911 const struct ieee80211_txrx_stypes *mgmt_stypes;
2912
7527a782
JB
2913 const struct ieee80211_iface_combination *iface_combinations;
2914 int n_iface_combinations;
2915 u16 software_iftypes;
2916
2e161f78
JB
2917 u16 n_addresses;
2918
d3236553
JB
2919 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2920 u16 interface_modes;
2921
77765eaf
VT
2922 u16 max_acl_mac_addrs;
2923
a2f73b6c 2924 u32 flags, regulatory_flags, features;
463d0183 2925
562a7480
JB
2926 u32 ap_sme_capa;
2927
d3236553
JB
2928 enum cfg80211_signal_type signal_type;
2929
2930 int bss_priv_size;
2931 u8 max_scan_ssids;
93b6aa69 2932 u8 max_sched_scan_ssids;
a1f1c21c 2933 u8 max_match_sets;
d3236553 2934 u16 max_scan_ie_len;
5a865bad 2935 u16 max_sched_scan_ie_len;
d3236553
JB
2936
2937 int n_cipher_suites;
2938 const u32 *cipher_suites;
2939
b9a5f8ca
JM
2940 u8 retry_short;
2941 u8 retry_long;
2942 u32 frag_threshold;
2943 u32 rts_threshold;
81077e82 2944 u8 coverage_class;
b9a5f8ca 2945
81135548 2946 char fw_version[ETHTOOL_FWVERS_LEN];
dfce95f5
KV
2947 u32 hw_version;
2948
dfb89c56 2949#ifdef CONFIG_PM
964dc9e2 2950 const struct wiphy_wowlan_support *wowlan;
6abb9cb9 2951 struct cfg80211_wowlan *wowlan_config;
dfb89c56 2952#endif
ff1b6e69 2953
a293911d
JB
2954 u16 max_remain_on_channel_duration;
2955
67fbb16b
SO
2956 u8 max_num_pmkids;
2957
7f531e03
BR
2958 u32 available_antennas_tx;
2959 u32 available_antennas_rx;
a7ffac95 2960
87bbbe22
AN
2961 /*
2962 * Bitmap of supported protocols for probe response offloading
2963 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2964 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2965 */
2966 u32 probe_resp_offload;
2967
a50df0c4
JB
2968 const u8 *extended_capabilities, *extended_capabilities_mask;
2969 u8 extended_capabilities_len;
2970
d3236553
JB
2971 /* If multiple wiphys are registered and you're handed e.g.
2972 * a regular netdev with assigned ieee80211_ptr, you won't
2973 * know whether it points to a wiphy your driver has registered
2974 * or not. Assign this to something global to your driver to
2975 * help determine whether you own this wiphy or not. */
cf5aa2f1 2976 const void *privid;
d3236553
JB
2977
2978 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2979
2980 /* Lets us get back the wiphy on the callback */
0c0280bd
LR
2981 void (*reg_notifier)(struct wiphy *wiphy,
2982 struct regulatory_request *request);
d3236553
JB
2983
2984 /* fields below are read-only, assigned by cfg80211 */
2985
458f4f9e 2986 const struct ieee80211_regdomain __rcu *regd;
d3236553
JB
2987
2988 /* the item in /sys/class/ieee80211/ points to this,
2989 * you need use set_wiphy_dev() (see below) */
2990 struct device dev;
2991
ecb44335
SG
2992 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2993 bool registered;
2994
d3236553
JB
2995 /* dir in debugfs: ieee80211/<wiphyname> */
2996 struct dentry *debugfsdir;
2997
7e7c8926 2998 const struct ieee80211_ht_cap *ht_capa_mod_mask;
ee2aca34 2999 const struct ieee80211_vht_cap *vht_capa_mod_mask;
7e7c8926 3000
463d0183
JB
3001#ifdef CONFIG_NET_NS
3002 /* the network namespace this phy lives in currently */
3003 struct net *_net;
3004#endif
3005
3d23e349
JB
3006#ifdef CONFIG_CFG80211_WEXT
3007 const struct iw_handler_def *wext;
3008#endif
3009
be29b99a
AK
3010 const struct wiphy_coalesce_support *coalesce;
3011
ad7e718c 3012 const struct wiphy_vendor_command *vendor_commands;
567ffc35
JB
3013 const struct nl80211_vendor_cmd_info *vendor_events;
3014 int n_vendor_commands, n_vendor_events;
ad7e718c 3015
b43504cf
JM
3016 u16 max_ap_assoc_sta;
3017
1c06ef98 3018 char priv[0] __aligned(NETDEV_ALIGN);
d3236553
JB
3019};
3020
463d0183
JB
3021static inline struct net *wiphy_net(struct wiphy *wiphy)
3022{
c2d9ba9b 3023 return read_pnet(&wiphy->_net);
463d0183
JB
3024}
3025
3026static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3027{
c2d9ba9b 3028 write_pnet(&wiphy->_net, net);
463d0183 3029}
463d0183 3030
d3236553
JB
3031/**
3032 * wiphy_priv - return priv from wiphy
3033 *
3034 * @wiphy: the wiphy whose priv pointer to return
0ae997dc 3035 * Return: The priv of @wiphy.
d3236553
JB
3036 */
3037static inline void *wiphy_priv(struct wiphy *wiphy)
3038{
3039 BUG_ON(!wiphy);
3040 return &wiphy->priv;
3041}
3042
f1f74825
DK
3043/**
3044 * priv_to_wiphy - return the wiphy containing the priv
3045 *
3046 * @priv: a pointer previously returned by wiphy_priv
0ae997dc 3047 * Return: The wiphy of @priv.
f1f74825
DK
3048 */
3049static inline struct wiphy *priv_to_wiphy(void *priv)
3050{
3051 BUG_ON(!priv);
3052 return container_of(priv, struct wiphy, priv);
3053}
3054
d3236553
JB
3055/**
3056 * set_wiphy_dev - set device pointer for wiphy
3057 *
3058 * @wiphy: The wiphy whose device to bind
3059 * @dev: The device to parent it to
3060 */
3061static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3062{
3063 wiphy->dev.parent = dev;
3064}
3065
3066/**
3067 * wiphy_dev - get wiphy dev pointer
3068 *
3069 * @wiphy: The wiphy whose device struct to look up
0ae997dc 3070 * Return: The dev of @wiphy.
d3236553
JB
3071 */
3072static inline struct device *wiphy_dev(struct wiphy *wiphy)
3073{
3074 return wiphy->dev.parent;
3075}
3076
3077/**
3078 * wiphy_name - get wiphy name
3079 *
3080 * @wiphy: The wiphy whose name to return
0ae997dc 3081 * Return: The name of @wiphy.
d3236553 3082 */
e1db74fc 3083static inline const char *wiphy_name(const struct wiphy *wiphy)
d3236553
JB
3084{
3085 return dev_name(&wiphy->dev);
3086}
3087
3088/**
3089 * wiphy_new - create a new wiphy for use with cfg80211
3090 *
3091 * @ops: The configuration operations for this device
3092 * @sizeof_priv: The size of the private area to allocate
3093 *
3094 * Create a new wiphy and associate the given operations with it.
3095 * @sizeof_priv bytes are allocated for private use.
3096 *
0ae997dc
YB
3097 * Return: A pointer to the new wiphy. This pointer must be
3098 * assigned to each netdev's ieee80211_ptr for proper operation.
d3236553 3099 */
3dcf670b 3100struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
d3236553
JB
3101
3102/**
3103 * wiphy_register - register a wiphy with cfg80211
3104 *
3105 * @wiphy: The wiphy to register.
3106 *
0ae997dc 3107 * Return: A non-negative wiphy index or a negative error code.
d3236553 3108 */
10dd9b7c 3109int wiphy_register(struct wiphy *wiphy);
d3236553
JB
3110
3111/**
3112 * wiphy_unregister - deregister a wiphy from cfg80211
3113 *
3114 * @wiphy: The wiphy to unregister.
3115 *
3116 * After this call, no more requests can be made with this priv
3117 * pointer, but the call may sleep to wait for an outstanding
3118 * request that is being handled.
3119 */
10dd9b7c 3120void wiphy_unregister(struct wiphy *wiphy);
d3236553
JB
3121
3122/**
3123 * wiphy_free - free wiphy
3124 *
3125 * @wiphy: The wiphy to free
3126 */
10dd9b7c 3127void wiphy_free(struct wiphy *wiphy);
d3236553 3128
fffd0934 3129/* internal structs */
6829c878 3130struct cfg80211_conn;
19957bb3 3131struct cfg80211_internal_bss;
fffd0934 3132struct cfg80211_cached_keys;
19957bb3 3133
d3236553 3134/**
89a54e48 3135 * struct wireless_dev - wireless device state
d3236553 3136 *
89a54e48
JB
3137 * For netdevs, this structure must be allocated by the driver
3138 * that uses the ieee80211_ptr field in struct net_device (this
3139 * is intentional so it can be allocated along with the netdev.)
3140 * It need not be registered then as netdev registration will
3141 * be intercepted by cfg80211 to see the new wireless device.
3142 *
3143 * For non-netdev uses, it must also be allocated by the driver
3144 * in response to the cfg80211 callbacks that require it, as
3145 * there's no netdev registration in that case it may not be
3146 * allocated outside of callback operations that return it.
d3236553
JB
3147 *
3148 * @wiphy: pointer to hardware description
3149 * @iftype: interface type
3150 * @list: (private) Used to collect the interfaces
89a54e48
JB
3151 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3152 * @identifier: (private) Identifier used in nl80211 to identify this
3153 * wireless device if it has no netdev
d3236553 3154 * @current_bss: (private) Used by the internal configuration code
9e0e2961
MK
3155 * @chandef: (private) Used by the internal configuration code to track
3156 * the user-set channel definition.
780b40df 3157 * @preset_chandef: (private) Used by the internal configuration code to
aa430da4 3158 * track the channel to be used for AP later
d3236553
JB
3159 * @bssid: (private) Used by the internal configuration code
3160 * @ssid: (private) Used by the internal configuration code
3161 * @ssid_len: (private) Used by the internal configuration code
29cbe68c
JB
3162 * @mesh_id_len: (private) Used by the internal configuration code
3163 * @mesh_id_up_len: (private) Used by the internal configuration code
d3236553 3164 * @wext: (private) Used by the internal wireless extensions compat code
9bc383de
JB
3165 * @use_4addr: indicates 4addr mode is used on this interface, must be
3166 * set by driver (if supported) on add_interface BEFORE registering the
3167 * netdev and may otherwise be used by driver read-only, will be update
3168 * by cfg80211 on change_interface
2e161f78
JB
3169 * @mgmt_registrations: list of registrations for management frames
3170 * @mgmt_registrations_lock: lock for the list
8d61ffa5
JB
3171 * @mtx: mutex used to lock data in this struct, may be used by drivers
3172 * and some API functions require it held
56d1893d
JB
3173 * @beacon_interval: beacon interval used on this device for transmitting
3174 * beacons, 0 when not valid
98104fde
JB
3175 * @address: The address for this device, valid only if @netdev is %NULL
3176 * @p2p_started: true if this is a P2P Device that has been started
04f39047
SW
3177 * @cac_started: true if DFS channel availability check has been started
3178 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
780b40df
JB
3179 * @ps: powersave mode is enabled
3180 * @ps_timeout: dynamic powersave timeout
3181 * @ap_unexpected_nlportid: (private) netlink port ID of application
3182 * registered for unexpected class 3 frames (AP mode)
3183 * @conn: (private) cfg80211 software SME connection state machine data
3184 * @connect_keys: (private) keys to set after connection is established
3185 * @ibss_fixed: (private) IBSS is using fixed BSSID
5336fa88 3186 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
780b40df
JB
3187 * @event_list: (private) list for internal event processing
3188 * @event_lock: (private) lock for event list
d3236553
JB
3189 */
3190struct wireless_dev {
3191 struct wiphy *wiphy;
3192 enum nl80211_iftype iftype;
3193
667503dd 3194 /* the remainder of this struct should be private to cfg80211 */
d3236553
JB
3195 struct list_head list;
3196 struct net_device *netdev;
3197
89a54e48
JB
3198 u32 identifier;
3199
2e161f78
JB
3200 struct list_head mgmt_registrations;
3201 spinlock_t mgmt_registrations_lock;
026331c4 3202
667503dd
JB
3203 struct mutex mtx;
3204
98104fde
JB
3205 bool use_4addr, p2p_started;
3206
3207 u8 address[ETH_ALEN] __aligned(sizeof(u16));
9bc383de 3208
b23aa676 3209 /* currently used for IBSS and SME - might be rearranged later */
d3236553 3210 u8 ssid[IEEE80211_MAX_SSID_LEN];
29cbe68c 3211 u8 ssid_len, mesh_id_len, mesh_id_up_len;
6829c878 3212 struct cfg80211_conn *conn;
fffd0934 3213 struct cfg80211_cached_keys *connect_keys;
d3236553 3214
667503dd
JB
3215 struct list_head event_list;
3216 spinlock_t event_lock;
3217
19957bb3 3218 struct cfg80211_internal_bss *current_bss; /* associated / joined */
683b6d3b 3219 struct cfg80211_chan_def preset_chandef;
9e0e2961 3220 struct cfg80211_chan_def chandef;
f4489ebe 3221
c30a3d38 3222 bool ibss_fixed;
5336fa88 3223 bool ibss_dfs_possible;
c30a3d38 3224
ffb9eb3d
KV
3225 bool ps;
3226 int ps_timeout;
3227
56d1893d
JB
3228 int beacon_interval;
3229
15e47304 3230 u32 ap_unexpected_nlportid;
28946da7 3231
04f39047
SW
3232 bool cac_started;
3233 unsigned long cac_start_time;
3234
3d23e349 3235#ifdef CONFIG_CFG80211_WEXT
d3236553 3236 /* wext data */
cbe8fa9c 3237 struct {
c238c8ac
JB
3238 struct cfg80211_ibss_params ibss;
3239 struct cfg80211_connect_params connect;
fffd0934 3240 struct cfg80211_cached_keys *keys;
f2129354
JB
3241 u8 *ie;
3242 size_t ie_len;
f401a6f7 3243 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
f2129354 3244 u8 ssid[IEEE80211_MAX_SSID_LEN];
08645126 3245 s8 default_key, default_mgmt_key;
ffb9eb3d 3246 bool prev_bssid_valid;
cbe8fa9c 3247 } wext;
d3236553
JB
3248#endif
3249};
3250
98104fde
JB
3251static inline u8 *wdev_address(struct wireless_dev *wdev)
3252{
3253 if (wdev->netdev)
3254 return wdev->netdev->dev_addr;
3255 return wdev->address;
3256}
3257
d3236553
JB
3258/**
3259 * wdev_priv - return wiphy priv from wireless_dev
3260 *
3261 * @wdev: The wireless device whose wiphy's priv pointer to return
0ae997dc 3262 * Return: The wiphy priv of @wdev.
d3236553
JB
3263 */
3264static inline void *wdev_priv(struct wireless_dev *wdev)
3265{
3266 BUG_ON(!wdev);
3267 return wiphy_priv(wdev->wiphy);
3268}
3269
d70e9693
JB
3270/**
3271 * DOC: Utility functions
3272 *
3273 * cfg80211 offers a number of utility functions that can be useful.
d3236553
JB
3274 */
3275
3276/**
3277 * ieee80211_channel_to_frequency - convert channel number to frequency
abe37c4b 3278 * @chan: channel number
59eb21a6 3279 * @band: band, necessary due to channel number overlap
0ae997dc 3280 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
d3236553 3281 */
10dd9b7c 3282int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
d3236553
JB
3283
3284/**
3285 * ieee80211_frequency_to_channel - convert frequency to channel number
abe37c4b 3286 * @freq: center frequency
0ae997dc 3287 * Return: The corresponding channel, or 0 if the conversion failed.
d3236553 3288 */
10dd9b7c 3289int ieee80211_frequency_to_channel(int freq);
d3236553
JB
3290
3291/*
3292 * Name indirection necessary because the ieee80211 code also has
3293 * a function named "ieee80211_get_channel", so if you include
3294 * cfg80211's header file you get cfg80211's version, if you try
3295 * to include both header files you'll (rightfully!) get a symbol
3296 * clash.
3297 */
10dd9b7c
JP
3298struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3299 int freq);
d3236553
JB
3300/**
3301 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
abe37c4b
JB
3302 * @wiphy: the struct wiphy to get the channel for
3303 * @freq: the center frequency of the channel
0ae997dc 3304 * Return: The channel struct from @wiphy at @freq.
d3236553
JB
3305 */
3306static inline struct ieee80211_channel *
3307ieee80211_get_channel(struct wiphy *wiphy, int freq)
3308{
3309 return __ieee80211_get_channel(wiphy, freq);
3310}
3311
3312/**
3313 * ieee80211_get_response_rate - get basic rate for a given rate
3314 *
3315 * @sband: the band to look for rates in
3316 * @basic_rates: bitmap of basic rates
3317 * @bitrate: the bitrate for which to find the basic rate
3318 *
0ae997dc
YB
3319 * Return: The basic rate corresponding to a given bitrate, that
3320 * is the next lower bitrate contained in the basic rate map,
3321 * which is, for this function, given as a bitmap of indices of
3322 * rates in the band's bitrate table.
d3236553
JB
3323 */
3324struct ieee80211_rate *
3325ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3326 u32 basic_rates, int bitrate);
3327
b422c6cd
AN
3328/**
3329 * ieee80211_mandatory_rates - get mandatory rates for a given band
3330 * @sband: the band to look for rates in
74608aca 3331 * @scan_width: width of the control channel
b422c6cd
AN
3332 *
3333 * This function returns a bitmap of the mandatory rates for the given
3334 * band, bits are set according to the rate position in the bitrates array.
3335 */
74608aca
SW
3336u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3337 enum nl80211_bss_scan_width scan_width);
b422c6cd 3338
d3236553
JB
3339/*
3340 * Radiotap parsing functions -- for controlled injection support
3341 *
3342 * Implemented in net/wireless/radiotap.c
3343 * Documentation in Documentation/networking/radiotap-headers.txt
3344 */
3345
33e5a2f7
JB
3346struct radiotap_align_size {
3347 uint8_t align:4, size:4;
3348};
3349
3350struct ieee80211_radiotap_namespace {
3351 const struct radiotap_align_size *align_size;
3352 int n_bits;
3353 uint32_t oui;
3354 uint8_t subns;
3355};
3356
3357struct ieee80211_radiotap_vendor_namespaces {
3358 const struct ieee80211_radiotap_namespace *ns;
3359 int n_ns;
3360};
3361
d3236553
JB
3362/**
3363 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
33e5a2f7
JB
3364 * @this_arg_index: index of current arg, valid after each successful call
3365 * to ieee80211_radiotap_iterator_next()
3366 * @this_arg: pointer to current radiotap arg; it is valid after each
3367 * call to ieee80211_radiotap_iterator_next() but also after
3368 * ieee80211_radiotap_iterator_init() where it will point to
3369 * the beginning of the actual data portion
3370 * @this_arg_size: length of the current arg, for convenience
3371 * @current_namespace: pointer to the current namespace definition
3372 * (or internally %NULL if the current namespace is unknown)
3373 * @is_radiotap_ns: indicates whether the current namespace is the default
3374 * radiotap namespace or not
3375 *
33e5a2f7
JB
3376 * @_rtheader: pointer to the radiotap header we are walking through
3377 * @_max_length: length of radiotap header in cpu byte ordering
3378 * @_arg_index: next argument index
3379 * @_arg: next argument pointer
3380 * @_next_bitmap: internal pointer to next present u32
3381 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3382 * @_vns: vendor namespace definitions
3383 * @_next_ns_data: beginning of the next namespace's data
3384 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3385 * next bitmap word
3386 *
3387 * Describes the radiotap parser state. Fields prefixed with an underscore
3388 * must not be used by users of the parser, only by the parser internally.
d3236553
JB
3389 */
3390
3391struct ieee80211_radiotap_iterator {
33e5a2f7
JB
3392 struct ieee80211_radiotap_header *_rtheader;
3393 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3394 const struct ieee80211_radiotap_namespace *current_namespace;
3395
3396 unsigned char *_arg, *_next_ns_data;
67272440 3397 __le32 *_next_bitmap;
33e5a2f7
JB
3398
3399 unsigned char *this_arg;
d3236553 3400 int this_arg_index;
33e5a2f7 3401 int this_arg_size;
d3236553 3402
33e5a2f7
JB
3403 int is_radiotap_ns;
3404
3405 int _max_length;
3406 int _arg_index;
3407 uint32_t _bitmap_shifter;
3408 int _reset_on_ext;
d3236553
JB
3409};
3410
10dd9b7c
JP
3411int
3412ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3413 struct ieee80211_radiotap_header *radiotap_header,
3414 int max_length,
3415 const struct ieee80211_radiotap_vendor_namespaces *vns);
d3236553 3416
10dd9b7c
JP
3417int
3418ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
33e5a2f7 3419
d3236553 3420
e31a16d6
ZY
3421extern const unsigned char rfc1042_header[6];
3422extern const unsigned char bridge_tunnel_header[6];
3423
3424/**
3425 * ieee80211_get_hdrlen_from_skb - get header length from data
3426 *
0ae997dc
YB
3427 * @skb: the frame
3428 *
e31a16d6 3429 * Given an skb with a raw 802.11 header at the data pointer this function
0ae997dc 3430 * returns the 802.11 header length.
e31a16d6 3431 *
0ae997dc
YB
3432 * Return: The 802.11 header length in bytes (not including encryption
3433 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3434 * 802.11 header.
e31a16d6
ZY
3435 */
3436unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3437
3438/**
3439 * ieee80211_hdrlen - get header length in bytes from frame control
3440 * @fc: frame control field in little-endian format
0ae997dc 3441 * Return: The header length in bytes.
e31a16d6 3442 */
633adf1a 3443unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
e31a16d6 3444
9b395bc3
JB
3445/**
3446 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3447 * @meshhdr: the mesh extension header, only the flags field
3448 * (first byte) will be accessed
0ae997dc 3449 * Return: The length of the extension header, which is always at
9b395bc3
JB
3450 * least 6 bytes and at most 18 if address 5 and 6 are present.
3451 */
3452unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3453
d70e9693
JB
3454/**
3455 * DOC: Data path helpers
3456 *
3457 * In addition to generic utilities, cfg80211 also offers
3458 * functions that help implement the data path for devices
3459 * that do not do the 802.11/802.3 conversion on the device.
3460 */
3461
e31a16d6
ZY
3462/**
3463 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3464 * @skb: the 802.11 data frame
3465 * @addr: the device MAC address
3466 * @iftype: the virtual interface type
0ae997dc 3467 * Return: 0 on success. Non-zero on error.
e31a16d6 3468 */
eaf85ca7 3469int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
e31a16d6
ZY
3470 enum nl80211_iftype iftype);
3471
3472/**
3473 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3474 * @skb: the 802.3 frame
3475 * @addr: the device MAC address
3476 * @iftype: the virtual interface type
3477 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3478 * @qos: build 802.11 QoS data frame
0ae997dc 3479 * Return: 0 on success, or a negative error code.
e31a16d6 3480 */
eaf85ca7 3481int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
e31a16d6
ZY
3482 enum nl80211_iftype iftype, u8 *bssid, bool qos);
3483
eaf85ca7
ZY
3484/**
3485 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3486 *
3487 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3488 * 802.3 frames. The @list will be empty if the decode fails. The
3489 * @skb is consumed after the function returns.
3490 *
3491 * @skb: The input IEEE 802.11n A-MSDU frame.
3492 * @list: The output list of 802.3 frames. It must be allocated and
3493 * initialized by by the caller.
3494 * @addr: The device MAC address.
3495 * @iftype: The device interface type.
3496 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
8b3becad 3497 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
eaf85ca7
ZY
3498 */
3499void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3500 const u8 *addr, enum nl80211_iftype iftype,
8b3becad
YAP
3501 const unsigned int extra_headroom,
3502 bool has_80211_header);
eaf85ca7 3503
e31a16d6
ZY
3504/**
3505 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3506 * @skb: the data frame
fa9ffc74 3507 * @qos_map: Interworking QoS mapping or %NULL if not in use
0ae997dc 3508 * Return: The 802.1p/1d tag.
e31a16d6 3509 */
fa9ffc74
KP
3510unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3511 struct cfg80211_qos_map *qos_map);
e31a16d6 3512
c21dbf92
JB
3513/**
3514 * cfg80211_find_ie - find information element in data
3515 *
3516 * @eid: element ID
3517 * @ies: data consisting of IEs
3518 * @len: length of data
3519 *
0ae997dc
YB
3520 * Return: %NULL if the element ID could not be found or if
3521 * the element is invalid (claims to be longer than the given
3522 * data), or a pointer to the first byte of the requested
3523 * element, that is the byte containing the element ID.
3524 *
3525 * Note: There are no checks on the element length other than
3526 * having to fit into the given data.
c21dbf92
JB
3527 */
3528const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3529
0c28ec58
EP
3530/**
3531 * cfg80211_find_vendor_ie - find vendor specific information element in data
3532 *
3533 * @oui: vendor OUI
3534 * @oui_type: vendor-specific OUI type
3535 * @ies: data consisting of IEs
3536 * @len: length of data
3537 *
0ae997dc
YB
3538 * Return: %NULL if the vendor specific element ID could not be found or if the
3539 * element is invalid (claims to be longer than the given data), or a pointer to
3540 * the first byte of the requested element, that is the byte containing the
3541 * element ID.
3542 *
3543 * Note: There are no checks on the element length other than having to fit into
3544 * the given data.
0c28ec58
EP
3545 */
3546const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3547 const u8 *ies, int len);
3548
d70e9693
JB
3549/**
3550 * DOC: Regulatory enforcement infrastructure
3551 *
3552 * TODO
d3236553
JB
3553 */
3554
3555/**
3556 * regulatory_hint - driver hint to the wireless core a regulatory domain
3557 * @wiphy: the wireless device giving the hint (used only for reporting
3558 * conflicts)
3559 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3560 * should be in. If @rd is set this should be NULL. Note that if you
3561 * set this to NULL you should still set rd->alpha2 to some accepted
3562 * alpha2.
3563 *
3564 * Wireless drivers can use this function to hint to the wireless core
3565 * what it believes should be the current regulatory domain by
3566 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3567 * domain should be in or by providing a completely build regulatory domain.
3568 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3569 * for a regulatory domain structure for the respective country.
3570 *
3571 * The wiphy must have been registered to cfg80211 prior to this call.
3572 * For cfg80211 drivers this means you must first use wiphy_register(),
3573 * for mac80211 drivers you must first use ieee80211_register_hw().
3574 *
3575 * Drivers should check the return value, its possible you can get
3576 * an -ENOMEM.
0ae997dc
YB
3577 *
3578 * Return: 0 on success. -ENOMEM.
d3236553 3579 */
10dd9b7c 3580int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
d3236553 3581
d3236553
JB
3582/**
3583 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3584 * @wiphy: the wireless device we want to process the regulatory domain on
3585 * @regd: the custom regulatory domain to use for this wiphy
3586 *
3587 * Drivers can sometimes have custom regulatory domains which do not apply
3588 * to a specific country. Drivers can use this to apply such custom regulatory
3589 * domains. This routine must be called prior to wiphy registration. The
3590 * custom regulatory domain will be trusted completely and as such previous
3591 * default channel settings will be disregarded. If no rule is found for a
3592 * channel on the regulatory domain the channel will be disabled.
222ea581
LR
3593 * Drivers using this for a wiphy should also set the wiphy flag
3594 * WIPHY_FLAG_CUSTOM_REGULATORY or cfg80211 will set it for the wiphy
3595 * that called this helper.
d3236553 3596 */
10dd9b7c
JP
3597void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3598 const struct ieee80211_regdomain *regd);
d3236553
JB
3599
3600/**
3601 * freq_reg_info - get regulatory information for the given frequency
3602 * @wiphy: the wiphy for which we want to process this rule for
3603 * @center_freq: Frequency in KHz for which we want regulatory information for
d3236553
JB
3604 *
3605 * Use this function to get the regulatory rule for a specific frequency on
3606 * a given wireless device. If the device has a specific regulatory domain
3607 * it wants to follow we respect that unless a country IE has been received
3608 * and processed already.
3609 *
0ae997dc
YB
3610 * Return: A valid pointer, or, when an error occurs, for example if no rule
3611 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3612 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3613 * value will be -ERANGE if we determine the given center_freq does not even
3614 * have a regulatory rule for a frequency range in the center_freq's band.
3615 * See freq_in_rule_band() for our current definition of a band -- this is
3616 * purely subjective and right now it's 802.11 specific.
d3236553 3617 */
361c9c8b
JB
3618const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3619 u32 center_freq);
d3236553 3620
034c6d6e
LR
3621/**
3622 * reg_initiator_name - map regulatory request initiator enum to name
3623 * @initiator: the regulatory request initiator
3624 *
3625 * You can use this to map the regulatory request initiator enum to a
3626 * proper string representation.
3627 */
3628const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3629
d3236553
JB
3630/*
3631 * callbacks for asynchronous cfg80211 methods, notification
3632 * functions and BSS handling helpers
3633 */
3634
2a519311
JB
3635/**
3636 * cfg80211_scan_done - notify that scan finished
3637 *
3638 * @request: the corresponding scan request
3639 * @aborted: set to true if the scan was aborted for any reason,
3640 * userspace will be notified of that
3641 */
3642void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3643
807f8a8c
LC
3644/**
3645 * cfg80211_sched_scan_results - notify that new scan results are available
3646 *
3647 * @wiphy: the wiphy which got scheduled scan results
3648 */
3649void cfg80211_sched_scan_results(struct wiphy *wiphy);
3650
3651/**
3652 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3653 *
3654 * @wiphy: the wiphy on which the scheduled scan stopped
3655 *
3656 * The driver can call this function to inform cfg80211 that the
3657 * scheduled scan had to be stopped, for whatever reason. The driver
3658 * is then called back via the sched_scan_stop operation when done.
3659 */
3660void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3661
2a519311 3662/**
dcd6eac1 3663 * cfg80211_inform_bss_width_frame - inform cfg80211 of a received BSS frame
2a519311
JB
3664 *
3665 * @wiphy: the wiphy reporting the BSS
abe37c4b 3666 * @channel: The channel the frame was received on
dcd6eac1 3667 * @scan_width: width of the control channel
abe37c4b
JB
3668 * @mgmt: the management frame (probe response or beacon)
3669 * @len: length of the management frame
77965c97 3670 * @signal: the signal strength, type depends on the wiphy's signal_type
2a519311
JB
3671 * @gfp: context flags
3672 *
3673 * This informs cfg80211 that BSS information was found and
3674 * the BSS should be updated/added.
ef100682 3675 *
0ae997dc
YB
3676 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3677 * Or %NULL on error.
2a519311 3678 */
ef100682 3679struct cfg80211_bss * __must_check
dcd6eac1
SW
3680cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
3681 struct ieee80211_channel *channel,
3682 enum nl80211_bss_scan_width scan_width,
3683 struct ieee80211_mgmt *mgmt, size_t len,
3684 s32 signal, gfp_t gfp);
3685
3686static inline struct cfg80211_bss * __must_check
2a519311
JB
3687cfg80211_inform_bss_frame(struct wiphy *wiphy,
3688 struct ieee80211_channel *channel,
3689 struct ieee80211_mgmt *mgmt, size_t len,
dcd6eac1
SW
3690 s32 signal, gfp_t gfp)
3691{
3692 return cfg80211_inform_bss_width_frame(wiphy, channel,
3693 NL80211_BSS_CHAN_WIDTH_20,
3694 mgmt, len, signal, gfp);
3695}
2a519311 3696
abe37c4b
JB
3697/**
3698 * cfg80211_inform_bss - inform cfg80211 of a new BSS
3699 *
3700 * @wiphy: the wiphy reporting the BSS
3701 * @channel: The channel the frame was received on
dcd6eac1 3702 * @scan_width: width of the control channel
abe37c4b 3703 * @bssid: the BSSID of the BSS
7b8bcff2 3704 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
abe37c4b
JB
3705 * @capability: the capability field sent by the peer
3706 * @beacon_interval: the beacon interval announced by the peer
3707 * @ie: additional IEs sent by the peer
3708 * @ielen: length of the additional IEs
3709 * @signal: the signal strength, type depends on the wiphy's signal_type
3710 * @gfp: context flags
3711 *
3712 * This informs cfg80211 that BSS information was found and
3713 * the BSS should be updated/added.
ef100682 3714 *
0ae997dc
YB
3715 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3716 * Or %NULL on error.
abe37c4b 3717 */
ef100682 3718struct cfg80211_bss * __must_check
dcd6eac1
SW
3719cfg80211_inform_bss_width(struct wiphy *wiphy,
3720 struct ieee80211_channel *channel,
3721 enum nl80211_bss_scan_width scan_width,
3722 const u8 *bssid, u64 tsf, u16 capability,
3723 u16 beacon_interval, const u8 *ie, size_t ielen,
3724 s32 signal, gfp_t gfp);
3725
3726static inline struct cfg80211_bss * __must_check
06aa7afa
JK
3727cfg80211_inform_bss(struct wiphy *wiphy,
3728 struct ieee80211_channel *channel,
7b8bcff2
JB
3729 const u8 *bssid, u64 tsf, u16 capability,
3730 u16 beacon_interval, const u8 *ie, size_t ielen,
dcd6eac1
SW
3731 s32 signal, gfp_t gfp)
3732{
3733 return cfg80211_inform_bss_width(wiphy, channel,
3734 NL80211_BSS_CHAN_WIDTH_20,
3735 bssid, tsf, capability,
3736 beacon_interval, ie, ielen, signal,
3737 gfp);
3738}
06aa7afa 3739
2a519311
JB
3740struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3741 struct ieee80211_channel *channel,
3742 const u8 *bssid,
79420f09
JB
3743 const u8 *ssid, size_t ssid_len,
3744 u16 capa_mask, u16 capa_val);
3745static inline struct cfg80211_bss *
3746cfg80211_get_ibss(struct wiphy *wiphy,
3747 struct ieee80211_channel *channel,
3748 const u8 *ssid, size_t ssid_len)
3749{
3750 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3751 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3752}
3753
4c0c0b75
JB
3754/**
3755 * cfg80211_ref_bss - reference BSS struct
5b112d3d 3756 * @wiphy: the wiphy this BSS struct belongs to
4c0c0b75
JB
3757 * @bss: the BSS struct to reference
3758 *
3759 * Increments the refcount of the given BSS struct.
3760 */
5b112d3d 3761void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4c0c0b75
JB
3762
3763/**
3764 * cfg80211_put_bss - unref BSS struct
5b112d3d 3765 * @wiphy: the wiphy this BSS struct belongs to
4c0c0b75
JB
3766 * @bss: the BSS struct
3767 *
3768 * Decrements the refcount of the given BSS struct.
3769 */
5b112d3d 3770void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
d3236553 3771
d491af19
JB
3772/**
3773 * cfg80211_unlink_bss - unlink BSS from internal data structures
3774 * @wiphy: the wiphy
3775 * @bss: the bss to remove
3776 *
3777 * This function removes the given BSS from the internal data structures
3778 * thereby making it no longer show up in scan results etc. Use this
3779 * function when you detect a BSS is gone. Normally BSSes will also time
3780 * out, so it is not necessary to use this function at all.
3781 */
3782void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
fee52678 3783
dcd6eac1
SW
3784static inline enum nl80211_bss_scan_width
3785cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
3786{
3787 switch (chandef->width) {
3788 case NL80211_CHAN_WIDTH_5:
3789 return NL80211_BSS_CHAN_WIDTH_5;
3790 case NL80211_CHAN_WIDTH_10:
3791 return NL80211_BSS_CHAN_WIDTH_10;
3792 default:
3793 return NL80211_BSS_CHAN_WIDTH_20;
3794 }
3795}
3796
6039f6d2 3797/**
6ff57cf8 3798 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6039f6d2
JM
3799 * @dev: network device
3800 * @buf: authentication frame (header + body)
3801 * @len: length of the frame data
3802 *
6ff57cf8
JB
3803 * This function is called whenever an authentication, disassociation or
3804 * deauthentication frame has been received and processed in station mode.
3805 * After being asked to authenticate via cfg80211_ops::auth() the driver must
3806 * call either this function or cfg80211_auth_timeout().
3807 * After being asked to associate via cfg80211_ops::assoc() the driver must
3808 * call either this function or cfg80211_auth_timeout().
3809 * While connected, the driver must calls this for received and processed
3810 * disassociation and deauthentication frames. If the frame couldn't be used
3811 * because it was unprotected, the driver must call the function
3812 * cfg80211_rx_unprot_mlme_mgmt() instead.
3813 *
3814 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6039f6d2 3815 */
6ff57cf8 3816void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6039f6d2 3817
1965c853 3818/**
6ff57cf8 3819 * cfg80211_auth_timeout - notification of timed out authentication
1965c853
JM
3820 * @dev: network device
3821 * @addr: The MAC address of the device with which the authentication timed out
cb0b4beb 3822 *
8d61ffa5
JB
3823 * This function may sleep. The caller must hold the corresponding wdev's
3824 * mutex.
1965c853 3825 */
6ff57cf8 3826void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
1965c853 3827
6039f6d2 3828/**
6ff57cf8 3829 * cfg80211_rx_assoc_resp - notification of processed association response
6039f6d2 3830 * @dev: network device
6ff57cf8
JB
3831 * @bss: the BSS that association was requested with, ownership of the pointer
3832 * moves to cfg80211 in this call
3833 * @buf: authentication frame (header + body)
6039f6d2
JM
3834 * @len: length of the frame data
3835 *
6ff57cf8
JB
3836 * After being asked to associate via cfg80211_ops::assoc() the driver must
3837 * call either this function or cfg80211_auth_timeout().
3838 *
3839 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6039f6d2 3840 */
6ff57cf8
JB
3841void cfg80211_rx_assoc_resp(struct net_device *dev,
3842 struct cfg80211_bss *bss,
95de817b 3843 const u8 *buf, size_t len);
6039f6d2 3844
1965c853 3845/**
6ff57cf8 3846 * cfg80211_assoc_timeout - notification of timed out association
1965c853 3847 * @dev: network device
959867fa 3848 * @bss: The BSS entry with which association timed out.
cb0b4beb 3849 *
8d61ffa5 3850 * This function may sleep. The caller must hold the corresponding wdev's mutex.
1965c853 3851 */
959867fa 3852void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
1965c853 3853
6039f6d2 3854/**
6ff57cf8 3855 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6039f6d2 3856 * @dev: network device
6ff57cf8 3857 * @buf: 802.11 frame (header + body)
6039f6d2
JM
3858 * @len: length of the frame data
3859 *
3860 * This function is called whenever deauthentication has been processed in
53b46b84 3861 * station mode. This includes both received deauthentication frames and
8d61ffa5
JB
3862 * locally generated ones. This function may sleep. The caller must hold the
3863 * corresponding wdev's mutex.
6039f6d2 3864 */
6ff57cf8 3865void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
ce470613 3866
6039f6d2 3867/**
6ff57cf8 3868 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
cf4e594e
JM
3869 * @dev: network device
3870 * @buf: deauthentication frame (header + body)
3871 * @len: length of the frame data
3872 *
6ff57cf8
JB
3873 * This function is called whenever a received deauthentication or dissassoc
3874 * frame has been dropped in station mode because of MFP being used but the
cf4e594e
JM
3875 * frame was not protected. This function may sleep.
3876 */
6ff57cf8
JB
3877void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
3878 const u8 *buf, size_t len);
cf4e594e 3879
a3b8b056
JM
3880/**
3881 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3882 * @dev: network device
3883 * @addr: The source MAC address of the frame
3884 * @key_type: The key type that the received frame used
a66b98db 3885 * @key_id: Key identifier (0..3). Can be -1 if missing.
a3b8b056 3886 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
e6d6e342 3887 * @gfp: allocation flags
a3b8b056
JM
3888 *
3889 * This function is called whenever the local MAC detects a MIC failure in a
3890 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3891 * primitive.
3892 */
3893void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3894 enum nl80211_key_type key_type, int key_id,
e6d6e342 3895 const u8 *tsc, gfp_t gfp);
a3b8b056 3896
04a773ad
JB
3897/**
3898 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3899 *
3900 * @dev: network device
3901 * @bssid: the BSSID of the IBSS joined
fe94f3a4 3902 * @channel: the channel of the IBSS joined
04a773ad
JB
3903 * @gfp: allocation flags
3904 *
3905 * This function notifies cfg80211 that the device joined an IBSS or
3906 * switched to a different BSSID. Before this function can be called,
3907 * either a beacon has to have been received from the IBSS, or one of
3908 * the cfg80211_inform_bss{,_frame} functions must have been called
3909 * with the locally generated beacon -- this guarantees that there is
3910 * always a scan result for this IBSS. cfg80211 will handle the rest.
3911 */
fe94f3a4
AQ
3912void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
3913 struct ieee80211_channel *channel, gfp_t gfp);
04a773ad 3914
c93b5e71
JC
3915/**
3916 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3917 *
3918 * @dev: network device
3919 * @macaddr: the MAC address of the new candidate
3920 * @ie: information elements advertised by the peer candidate
3921 * @ie_len: lenght of the information elements buffer
3922 * @gfp: allocation flags
3923 *
3924 * This function notifies cfg80211 that the mesh peer candidate has been
3925 * detected, most likely via a beacon or, less likely, via a probe response.
3926 * cfg80211 then sends a notification to userspace.
3927 */
3928void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3929 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3930
d70e9693
JB
3931/**
3932 * DOC: RFkill integration
3933 *
3934 * RFkill integration in cfg80211 is almost invisible to drivers,
3935 * as cfg80211 automatically registers an rfkill instance for each
3936 * wireless device it knows about. Soft kill is also translated
3937 * into disconnecting and turning all interfaces off, drivers are
3938 * expected to turn off the device when all interfaces are down.
3939 *
3940 * However, devices may have a hard RFkill line, in which case they
3941 * also need to interact with the rfkill subsystem, via cfg80211.
3942 * They can do this with a few helper functions documented here.
3943 */
3944
1f87f7d3
JB
3945/**
3946 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3947 * @wiphy: the wiphy
3948 * @blocked: block status
3949 */
3950void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3951
3952/**
3953 * wiphy_rfkill_start_polling - start polling rfkill
3954 * @wiphy: the wiphy
3955 */
3956void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3957
3958/**
3959 * wiphy_rfkill_stop_polling - stop polling rfkill
3960 * @wiphy: the wiphy
3961 */
3962void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3963
ad7e718c
JB
3964/**
3965 * DOC: Vendor commands
3966 *
3967 * Occasionally, there are special protocol or firmware features that
3968 * can't be implemented very openly. For this and similar cases, the
3969 * vendor command functionality allows implementing the features with
3970 * (typically closed-source) userspace and firmware, using nl80211 as
3971 * the configuration mechanism.
3972 *
3973 * A driver supporting vendor commands must register them as an array
3974 * in struct wiphy, with handlers for each one, each command has an
3975 * OUI and sub command ID to identify it.
3976 *
3977 * Note that this feature should not be (ab)used to implement protocol
3978 * features that could openly be shared across drivers. In particular,
3979 * it must never be required to use vendor commands to implement any
3980 * "normal" functionality that higher-level userspace like connection
3981 * managers etc. need.
3982 */
3983
3984struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
3985 enum nl80211_commands cmd,
3986 enum nl80211_attrs attr,
3987 int approxlen);
3988
567ffc35
JB
3989struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
3990 enum nl80211_commands cmd,
3991 enum nl80211_attrs attr,
3992 int vendor_event_idx,
3993 int approxlen, gfp_t gfp);
3994
3995void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
3996
ad7e718c
JB
3997/**
3998 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
3999 * @wiphy: the wiphy
4000 * @approxlen: an upper bound of the length of the data that will
4001 * be put into the skb
4002 *
4003 * This function allocates and pre-fills an skb for a reply to
4004 * a vendor command. Since it is intended for a reply, calling
4005 * it outside of a vendor command's doit() operation is invalid.
4006 *
4007 * The returned skb is pre-filled with some identifying data in
4008 * a way that any data that is put into the skb (with skb_put(),
4009 * nla_put() or similar) will end up being within the
4010 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4011 * with the skb is adding data for the corresponding userspace tool
4012 * which can then read that data out of the vendor data attribute.
4013 * You must not modify the skb in any other way.
4014 *
4015 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4016 * its error code as the result of the doit() operation.
4017 *
4018 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4019 */
4020static inline struct sk_buff *
4021cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4022{
4023 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4024 NL80211_ATTR_VENDOR_DATA, approxlen);
4025}
4026
4027/**
4028 * cfg80211_vendor_cmd_reply - send the reply skb
4029 * @skb: The skb, must have been allocated with
4030 * cfg80211_vendor_cmd_alloc_reply_skb()
4031 *
4032 * Since calling this function will usually be the last thing
4033 * before returning from the vendor command doit() you should
4034 * return the error code. Note that this function consumes the
4035 * skb regardless of the return value.
4036 *
4037 * Return: An error code or 0 on success.
4038 */
4039int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4040
567ffc35
JB
4041/**
4042 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4043 * @wiphy: the wiphy
4044 * @event_idx: index of the vendor event in the wiphy's vendor_events
4045 * @approxlen: an upper bound of the length of the data that will
4046 * be put into the skb
4047 * @gfp: allocation flags
4048 *
4049 * This function allocates and pre-fills an skb for an event on the
4050 * vendor-specific multicast group.
4051 *
4052 * When done filling the skb, call cfg80211_vendor_event() with the
4053 * skb to send the event.
4054 *
4055 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4056 */
4057static inline struct sk_buff *
4058cfg80211_vendor_event_alloc(struct wiphy *wiphy, int approxlen,
4059 int event_idx, gfp_t gfp)
4060{
4061 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_VENDOR,
4062 NL80211_ATTR_VENDOR_DATA,
4063 event_idx, approxlen, gfp);
4064}
4065
4066/**
4067 * cfg80211_vendor_event - send the event
4068 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4069 * @gfp: allocation flags
4070 *
4071 * This function sends the given @skb, which must have been allocated
4072 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4073 */
4074static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4075{
4076 __cfg80211_send_event_skb(skb, gfp);
4077}
4078
aff89a9b 4079#ifdef CONFIG_NL80211_TESTMODE
d70e9693
JB
4080/**
4081 * DOC: Test mode
4082 *
4083 * Test mode is a set of utility functions to allow drivers to
4084 * interact with driver-specific tools to aid, for instance,
4085 * factory programming.
4086 *
4087 * This chapter describes how drivers interact with it, for more
4088 * information see the nl80211 book's chapter on it.
4089 */
4090
aff89a9b
JB
4091/**
4092 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4093 * @wiphy: the wiphy
4094 * @approxlen: an upper bound of the length of the data that will
4095 * be put into the skb
4096 *
4097 * This function allocates and pre-fills an skb for a reply to
4098 * the testmode command. Since it is intended for a reply, calling
4099 * it outside of the @testmode_cmd operation is invalid.
4100 *
0ae997dc
YB
4101 * The returned skb is pre-filled with the wiphy index and set up in
4102 * a way that any data that is put into the skb (with skb_put(),
4103 * nla_put() or similar) will end up being within the
4104 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4105 * with the skb is adding data for the corresponding userspace tool
4106 * which can then read that data out of the testdata attribute. You
4107 * must not modify the skb in any other way.
aff89a9b
JB
4108 *
4109 * When done, call cfg80211_testmode_reply() with the skb and return
4110 * its error code as the result of the @testmode_cmd operation.
0ae997dc
YB
4111 *
4112 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
aff89a9b 4113 */
ad7e718c
JB
4114static inline struct sk_buff *
4115cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4116{
4117 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4118 NL80211_ATTR_TESTDATA, approxlen);
4119}
aff89a9b
JB
4120
4121/**
4122 * cfg80211_testmode_reply - send the reply skb
4123 * @skb: The skb, must have been allocated with
4124 * cfg80211_testmode_alloc_reply_skb()
4125 *
0ae997dc
YB
4126 * Since calling this function will usually be the last thing
4127 * before returning from the @testmode_cmd you should return
4128 * the error code. Note that this function consumes the skb
4129 * regardless of the return value.
4130 *
4131 * Return: An error code or 0 on success.
aff89a9b 4132 */
ad7e718c
JB
4133static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4134{
4135 return cfg80211_vendor_cmd_reply(skb);
4136}
aff89a9b
JB
4137
4138/**
4139 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4140 * @wiphy: the wiphy
4141 * @approxlen: an upper bound of the length of the data that will
4142 * be put into the skb
4143 * @gfp: allocation flags
4144 *
4145 * This function allocates and pre-fills an skb for an event on the
4146 * testmode multicast group.
4147 *
0ae997dc
YB
4148 * The returned skb is set up in the same way as with
4149 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4150 * there, you should simply add data to it that will then end up in the
4151 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4152 * in any other way.
aff89a9b
JB
4153 *
4154 * When done filling the skb, call cfg80211_testmode_event() with the
4155 * skb to send the event.
0ae997dc
YB
4156 *
4157 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
aff89a9b 4158 */
567ffc35
JB
4159static inline struct sk_buff *
4160cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4161{
4162 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_TESTMODE,
4163 NL80211_ATTR_TESTDATA, -1,
4164 approxlen, gfp);
4165}
aff89a9b
JB
4166
4167/**
4168 * cfg80211_testmode_event - send the event
4169 * @skb: The skb, must have been allocated with
4170 * cfg80211_testmode_alloc_event_skb()
4171 * @gfp: allocation flags
4172 *
4173 * This function sends the given @skb, which must have been allocated
4174 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4175 * consumes it.
4176 */
567ffc35
JB
4177static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4178{
4179 __cfg80211_send_event_skb(skb, gfp);
4180}
aff89a9b
JB
4181
4182#define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
71063f0e 4183#define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
aff89a9b
JB
4184#else
4185#define CFG80211_TESTMODE_CMD(cmd)
71063f0e 4186#define CFG80211_TESTMODE_DUMP(cmd)
aff89a9b
JB
4187#endif
4188
b23aa676
SO
4189/**
4190 * cfg80211_connect_result - notify cfg80211 of connection result
4191 *
4192 * @dev: network device
4193 * @bssid: the BSSID of the AP
4194 * @req_ie: association request IEs (maybe be %NULL)
4195 * @req_ie_len: association request IEs length
4196 * @resp_ie: association response IEs (may be %NULL)
4197 * @resp_ie_len: assoc response IEs length
4198 * @status: status code, 0 for successful connection, use
4199 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4200 * the real status code for failures.
4201 * @gfp: allocation flags
4202 *
4203 * It should be called by the underlying driver whenever connect() has
4204 * succeeded.
4205 */
4206void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4207 const u8 *req_ie, size_t req_ie_len,
4208 const u8 *resp_ie, size_t resp_ie_len,
4209 u16 status, gfp_t gfp);
4210
4211/**
4212 * cfg80211_roamed - notify cfg80211 of roaming
4213 *
4214 * @dev: network device
ed9d0102 4215 * @channel: the channel of the new AP
b23aa676
SO
4216 * @bssid: the BSSID of the new AP
4217 * @req_ie: association request IEs (maybe be %NULL)
4218 * @req_ie_len: association request IEs length
4219 * @resp_ie: association response IEs (may be %NULL)
4220 * @resp_ie_len: assoc response IEs length
4221 * @gfp: allocation flags
4222 *
4223 * It should be called by the underlying driver whenever it roamed
4224 * from one AP to another while connected.
4225 */
ed9d0102
JM
4226void cfg80211_roamed(struct net_device *dev,
4227 struct ieee80211_channel *channel,
4228 const u8 *bssid,
b23aa676
SO
4229 const u8 *req_ie, size_t req_ie_len,
4230 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4231
adbde344
VT
4232/**
4233 * cfg80211_roamed_bss - notify cfg80211 of roaming
4234 *
4235 * @dev: network device
4236 * @bss: entry of bss to which STA got roamed
4237 * @req_ie: association request IEs (maybe be %NULL)
4238 * @req_ie_len: association request IEs length
4239 * @resp_ie: association response IEs (may be %NULL)
4240 * @resp_ie_len: assoc response IEs length
4241 * @gfp: allocation flags
4242 *
4243 * This is just a wrapper to notify cfg80211 of roaming event with driver
4244 * passing bss to avoid a race in timeout of the bss entry. It should be
4245 * called by the underlying driver whenever it roamed from one AP to another
4246 * while connected. Drivers which have roaming implemented in firmware
4247 * may use this function to avoid a race in bss entry timeout where the bss
4248 * entry of the new AP is seen in the driver, but gets timed out by the time
4249 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4250 * rdev->event_work. In case of any failures, the reference is released
4251 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4252 * it will be released while diconneting from the current bss.
4253 */
4254void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4255 const u8 *req_ie, size_t req_ie_len,
4256 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4257
b23aa676
SO
4258/**
4259 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4260 *
4261 * @dev: network device
4262 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4263 * @ie_len: length of IEs
4264 * @reason: reason code for the disconnection, set it to 0 if unknown
4265 * @gfp: allocation flags
4266 *
4267 * After it calls this function, the driver should enter an idle state
4268 * and not try to connect to any AP any more.
4269 */
4270void cfg80211_disconnected(struct net_device *dev, u16 reason,
4271 u8 *ie, size_t ie_len, gfp_t gfp);
4272
9588bbd5
JM
4273/**
4274 * cfg80211_ready_on_channel - notification of remain_on_channel start
71bbc994 4275 * @wdev: wireless device
9588bbd5
JM
4276 * @cookie: the request cookie
4277 * @chan: The current channel (from remain_on_channel request)
9588bbd5
JM
4278 * @duration: Duration in milliseconds that the driver intents to remain on the
4279 * channel
4280 * @gfp: allocation flags
4281 */
71bbc994 4282void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
9588bbd5 4283 struct ieee80211_channel *chan,
9588bbd5
JM
4284 unsigned int duration, gfp_t gfp);
4285
4286/**
4287 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
71bbc994 4288 * @wdev: wireless device
9588bbd5
JM
4289 * @cookie: the request cookie
4290 * @chan: The current channel (from remain_on_channel request)
9588bbd5
JM
4291 * @gfp: allocation flags
4292 */
71bbc994 4293void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
9588bbd5 4294 struct ieee80211_channel *chan,
9588bbd5 4295 gfp_t gfp);
b23aa676 4296
98b62183
JB
4297
4298/**
4299 * cfg80211_new_sta - notify userspace about station
4300 *
4301 * @dev: the netdev
4302 * @mac_addr: the station's address
4303 * @sinfo: the station information
4304 * @gfp: allocation flags
4305 */
4306void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4307 struct station_info *sinfo, gfp_t gfp);
4308
ec15e68b
JM
4309/**
4310 * cfg80211_del_sta - notify userspace about deletion of a station
4311 *
4312 * @dev: the netdev
4313 * @mac_addr: the station's address
4314 * @gfp: allocation flags
4315 */
4316void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
4317
ed44a951
PP
4318/**
4319 * cfg80211_conn_failed - connection request failed notification
4320 *
4321 * @dev: the netdev
4322 * @mac_addr: the station's address
4323 * @reason: the reason for connection failure
4324 * @gfp: allocation flags
4325 *
4326 * Whenever a station tries to connect to an AP and if the station
4327 * could not connect to the AP as the AP has rejected the connection
4328 * for some reasons, this function is called.
4329 *
4330 * The reason for connection failure can be any of the value from
4331 * nl80211_connect_failed_reason enum
4332 */
4333void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4334 enum nl80211_connect_failed_reason reason,
4335 gfp_t gfp);
4336
026331c4 4337/**
2e161f78 4338 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
71bbc994 4339 * @wdev: wireless device receiving the frame
026331c4 4340 * @freq: Frequency on which the frame was received in MHz
804483e9 4341 * @sig_dbm: signal strength in mBm, or 0 if unknown
2e161f78 4342 * @buf: Management frame (header + body)
026331c4 4343 * @len: length of the frame data
19504cf5 4344 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
026331c4 4345 * @gfp: context flags
2e161f78 4346 *
0ae997dc
YB
4347 * This function is called whenever an Action frame is received for a station
4348 * mode interface, but is not processed in kernel.
4349 *
4350 * Return: %true if a user space application has registered for this frame.
2e161f78
JB
4351 * For action frames, that makes it responsible for rejecting unrecognized
4352 * action frames; %false otherwise, in which case for action frames the
4353 * driver is responsible for rejecting the frame.
026331c4 4354 */
71bbc994 4355bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
19504cf5 4356 const u8 *buf, size_t len, u32 flags, gfp_t gfp);
026331c4
JM
4357
4358/**
2e161f78 4359 * cfg80211_mgmt_tx_status - notification of TX status for management frame
71bbc994 4360 * @wdev: wireless device receiving the frame
2e161f78
JB
4361 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4362 * @buf: Management frame (header + body)
026331c4
JM
4363 * @len: length of the frame data
4364 * @ack: Whether frame was acknowledged
4365 * @gfp: context flags
4366 *
2e161f78
JB
4367 * This function is called whenever a management frame was requested to be
4368 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
026331c4
JM
4369 * transmission attempt.
4370 */
71bbc994 4371void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
2e161f78 4372 const u8 *buf, size_t len, bool ack, gfp_t gfp);
026331c4 4373
d6dc1a38
JO
4374
4375/**
4376 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4377 * @dev: network device
4378 * @rssi_event: the triggered RSSI event
4379 * @gfp: context flags
4380 *
4381 * This function is called when a configured connection quality monitoring
4382 * rssi threshold reached event occurs.
4383 */
4384void cfg80211_cqm_rssi_notify(struct net_device *dev,
4385 enum nl80211_cqm_rssi_threshold_event rssi_event,
4386 gfp_t gfp);
4387
04f39047
SW
4388/**
4389 * cfg80211_radar_event - radar detection event
4390 * @wiphy: the wiphy
4391 * @chandef: chandef for the current channel
4392 * @gfp: context flags
4393 *
4394 * This function is called when a radar is detected on the current chanenl.
4395 */
4396void cfg80211_radar_event(struct wiphy *wiphy,
4397 struct cfg80211_chan_def *chandef, gfp_t gfp);
4398
4399/**
4400 * cfg80211_cac_event - Channel availability check (CAC) event
4401 * @netdev: network device
d2859df5 4402 * @chandef: chandef for the current channel
04f39047
SW
4403 * @event: type of event
4404 * @gfp: context flags
4405 *
4406 * This function is called when a Channel availability check (CAC) is finished
4407 * or aborted. This must be called to notify the completion of a CAC process,
4408 * also by full-MAC drivers.
4409 */
4410void cfg80211_cac_event(struct net_device *netdev,
d2859df5 4411 const struct cfg80211_chan_def *chandef,
04f39047
SW
4412 enum nl80211_radar_event event, gfp_t gfp);
4413
4414
c063dbf5
JB
4415/**
4416 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4417 * @dev: network device
4418 * @peer: peer's MAC address
4419 * @num_packets: how many packets were lost -- should be a fixed threshold
4420 * but probably no less than maybe 50, or maybe a throughput dependent
4421 * threshold (to account for temporary interference)
4422 * @gfp: context flags
4423 */
4424void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4425 const u8 *peer, u32 num_packets, gfp_t gfp);
4426
84f10708
TP
4427/**
4428 * cfg80211_cqm_txe_notify - TX error rate event
4429 * @dev: network device
4430 * @peer: peer's MAC address
4431 * @num_packets: how many packets were lost
4432 * @rate: % of packets which failed transmission
4433 * @intvl: interval (in s) over which the TX failure threshold was breached.
4434 * @gfp: context flags
4435 *
4436 * Notify userspace when configured % TX failures over number of packets in a
4437 * given interval is exceeded.
4438 */
4439void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4440 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4441
e5497d76
JB
4442/**
4443 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4444 * @dev: network device
4445 * @bssid: BSSID of AP (to avoid races)
4446 * @replay_ctr: new replay counter
af71ff85 4447 * @gfp: allocation flags
e5497d76
JB
4448 */
4449void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4450 const u8 *replay_ctr, gfp_t gfp);
4451
c9df56b4
JM
4452/**
4453 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4454 * @dev: network device
4455 * @index: candidate index (the smaller the index, the higher the priority)
4456 * @bssid: BSSID of AP
4457 * @preauth: Whether AP advertises support for RSN pre-authentication
4458 * @gfp: allocation flags
4459 */
4460void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4461 const u8 *bssid, bool preauth, gfp_t gfp);
4462
28946da7
JB
4463/**
4464 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4465 * @dev: The device the frame matched to
4466 * @addr: the transmitter address
4467 * @gfp: context flags
4468 *
4469 * This function is used in AP mode (only!) to inform userspace that
4470 * a spurious class 3 frame was received, to be able to deauth the
4471 * sender.
0ae997dc 4472 * Return: %true if the frame was passed to userspace (or this failed
28946da7
JB
4473 * for a reason other than not having a subscription.)
4474 */
4475bool cfg80211_rx_spurious_frame(struct net_device *dev,
4476 const u8 *addr, gfp_t gfp);
4477
b92ab5d8
JB
4478/**
4479 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4480 * @dev: The device the frame matched to
4481 * @addr: the transmitter address
4482 * @gfp: context flags
4483 *
4484 * This function is used in AP mode (only!) to inform userspace that
4485 * an associated station sent a 4addr frame but that wasn't expected.
4486 * It is allowed and desirable to send this event only once for each
4487 * station to avoid event flooding.
0ae997dc 4488 * Return: %true if the frame was passed to userspace (or this failed
b92ab5d8
JB
4489 * for a reason other than not having a subscription.)
4490 */
4491bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4492 const u8 *addr, gfp_t gfp);
4493
7f6cf311
JB
4494/**
4495 * cfg80211_probe_status - notify userspace about probe status
4496 * @dev: the device the probe was sent on
4497 * @addr: the address of the peer
4498 * @cookie: the cookie filled in @probe_client previously
4499 * @acked: indicates whether probe was acked or not
4500 * @gfp: allocation flags
4501 */
4502void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4503 u64 cookie, bool acked, gfp_t gfp);
4504
5e760230
JB
4505/**
4506 * cfg80211_report_obss_beacon - report beacon from other APs
4507 * @wiphy: The wiphy that received the beacon
4508 * @frame: the frame
4509 * @len: length of the frame
4510 * @freq: frequency the frame was received on
804483e9 4511 * @sig_dbm: signal strength in mBm, or 0 if unknown
5e760230
JB
4512 *
4513 * Use this function to report to userspace when a beacon was
4514 * received. It is not useful to call this when there is no
4515 * netdev that is in AP/GO mode.
4516 */
4517void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4518 const u8 *frame, size_t len,
37c73b5f 4519 int freq, int sig_dbm);
5e760230 4520
d58e7e37 4521/**
683b6d3b 4522 * cfg80211_reg_can_beacon - check if beaconing is allowed
54858ee5 4523 * @wiphy: the wiphy
683b6d3b 4524 * @chandef: the channel definition
d58e7e37 4525 *
0ae997dc
YB
4526 * Return: %true if there is no secondary channel or the secondary channel(s)
4527 * can be used for beaconing (i.e. is not a radar channel etc.)
54858ee5 4528 */
683b6d3b
JB
4529bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4530 struct cfg80211_chan_def *chandef);
54858ee5 4531
5314526b
TP
4532/*
4533 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4534 * @dev: the device which switched channels
683b6d3b 4535 * @chandef: the new channel definition
5314526b 4536 *
e487eaeb
SW
4537 * Caller must acquire wdev_lock, therefore must only be called from sleepable
4538 * driver context!
5314526b 4539 */
683b6d3b
JB
4540void cfg80211_ch_switch_notify(struct net_device *dev,
4541 struct cfg80211_chan_def *chandef);
5314526b 4542
1ce3e82b
JB
4543/**
4544 * ieee80211_operating_class_to_band - convert operating class to band
4545 *
4546 * @operating_class: the operating class to convert
4547 * @band: band pointer to fill
4548 *
4549 * Returns %true if the conversion was successful, %false otherwise.
4550 */
4551bool ieee80211_operating_class_to_band(u8 operating_class,
4552 enum ieee80211_band *band);
4553
3475b094
JM
4554/*
4555 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4556 * @dev: the device on which the operation is requested
4557 * @peer: the MAC address of the peer device
4558 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4559 * NL80211_TDLS_TEARDOWN)
4560 * @reason_code: the reason code for teardown request
4561 * @gfp: allocation flags
4562 *
4563 * This function is used to request userspace to perform TDLS operation that
4564 * requires knowledge of keys, i.e., link setup or teardown when the AP
4565 * connection uses encryption. This is optional mechanism for the driver to use
4566 * if it can automatically determine when a TDLS link could be useful (e.g.,
4567 * based on traffic and signal strength for a peer).
4568 */
4569void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4570 enum nl80211_tdls_operation oper,
4571 u16 reason_code, gfp_t gfp);
4572
8097e149
TP
4573/*
4574 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4575 * @rate: given rate_info to calculate bitrate from
4576 *
4577 * return 0 if MCS index >= 32
4578 */
8eb41c8d 4579u32 cfg80211_calculate_bitrate(struct rate_info *rate);
8097e149 4580
98104fde
JB
4581/**
4582 * cfg80211_unregister_wdev - remove the given wdev
4583 * @wdev: struct wireless_dev to remove
4584 *
4585 * Call this function only for wdevs that have no netdev assigned,
4586 * e.g. P2P Devices. It removes the device from the list so that
4587 * it can no longer be used. It is necessary to call this function
4588 * even when cfg80211 requests the removal of the interface by
4589 * calling the del_virtual_intf() callback. The function must also
4590 * be called when the driver wishes to unregister the wdev, e.g.
4591 * when the device is unbound from the driver.
4592 *
4593 * Requires the RTNL to be held.
4594 */
4595void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4596
355199e0
JM
4597/**
4598 * struct cfg80211_ft_event - FT Information Elements
4599 * @ies: FT IEs
4600 * @ies_len: length of the FT IE in bytes
4601 * @target_ap: target AP's MAC address
4602 * @ric_ies: RIC IE
4603 * @ric_ies_len: length of the RIC IE in bytes
4604 */
4605struct cfg80211_ft_event_params {
4606 const u8 *ies;
4607 size_t ies_len;
4608 const u8 *target_ap;
4609 const u8 *ric_ies;
4610 size_t ric_ies_len;
4611};
4612
4613/**
4614 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
4615 * @netdev: network device
4616 * @ft_event: IE information
4617 */
4618void cfg80211_ft_event(struct net_device *netdev,
4619 struct cfg80211_ft_event_params *ft_event);
4620
0ee45355
JB
4621/**
4622 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4623 * @ies: the input IE buffer
4624 * @len: the input length
4625 * @attr: the attribute ID to find
4626 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4627 * if the function is only called to get the needed buffer size
4628 * @bufsize: size of the output buffer
4629 *
4630 * The function finds a given P2P attribute in the (vendor) IEs and
4631 * copies its contents to the given buffer.
4632 *
0ae997dc
YB
4633 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4634 * malformed or the attribute can't be found (respectively), or the
4635 * length of the found attribute (which can be zero).
0ee45355 4636 */
c216e641
AS
4637int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4638 enum ieee80211_p2p_attr_id attr,
4639 u8 *buf, unsigned int bufsize);
0ee45355 4640
cd8f7cb4
JB
4641/**
4642 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4643 * @wdev: the wireless device reporting the wakeup
4644 * @wakeup: the wakeup report
4645 * @gfp: allocation flags
4646 *
4647 * This function reports that the given device woke up. If it
4648 * caused the wakeup, report the reason(s), otherwise you may
4649 * pass %NULL as the @wakeup parameter to advertise that something
4650 * else caused the wakeup.
4651 */
4652void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4653 struct cfg80211_wowlan_wakeup *wakeup,
4654 gfp_t gfp);
4655
5de17984
AS
4656/**
4657 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
4658 *
4659 * @wdev: the wireless device for which critical protocol is stopped.
03f831a6 4660 * @gfp: allocation flags
5de17984
AS
4661 *
4662 * This function can be called by the driver to indicate it has reverted
4663 * operation back to normal. One reason could be that the duration given
4664 * by .crit_proto_start() has expired.
4665 */
4666void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
4667
bdfbec2d
IP
4668/**
4669 * ieee80211_get_num_supported_channels - get number of channels device has
4670 * @wiphy: the wiphy
4671 *
4672 * Return: the number of channels supported by the device.
4673 */
4674unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
4675
e1db74fc
JP
4676/* Logging, debugging and troubleshooting/diagnostic helpers. */
4677
4678/* wiphy_printk helpers, similar to dev_printk */
4679
4680#define wiphy_printk(level, wiphy, format, args...) \
9c376639 4681 dev_printk(level, &(wiphy)->dev, format, ##args)
e1db74fc 4682#define wiphy_emerg(wiphy, format, args...) \
9c376639 4683 dev_emerg(&(wiphy)->dev, format, ##args)
e1db74fc 4684#define wiphy_alert(wiphy, format, args...) \
9c376639 4685 dev_alert(&(wiphy)->dev, format, ##args)
e1db74fc 4686#define wiphy_crit(wiphy, format, args...) \
9c376639 4687 dev_crit(&(wiphy)->dev, format, ##args)
e1db74fc 4688#define wiphy_err(wiphy, format, args...) \
9c376639 4689 dev_err(&(wiphy)->dev, format, ##args)
e1db74fc 4690#define wiphy_warn(wiphy, format, args...) \
9c376639 4691 dev_warn(&(wiphy)->dev, format, ##args)
e1db74fc 4692#define wiphy_notice(wiphy, format, args...) \
9c376639 4693 dev_notice(&(wiphy)->dev, format, ##args)
e1db74fc 4694#define wiphy_info(wiphy, format, args...) \
9c376639 4695 dev_info(&(wiphy)->dev, format, ##args)
073730d7 4696
9c376639 4697#define wiphy_debug(wiphy, format, args...) \
e1db74fc 4698 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
9c376639 4699
e1db74fc 4700#define wiphy_dbg(wiphy, format, args...) \
9c376639 4701 dev_dbg(&(wiphy)->dev, format, ##args)
e1db74fc
JP
4702
4703#if defined(VERBOSE_DEBUG)
4704#define wiphy_vdbg wiphy_dbg
4705#else
e1db74fc
JP
4706#define wiphy_vdbg(wiphy, format, args...) \
4707({ \
4708 if (0) \
4709 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
9c376639 4710 0; \
e1db74fc
JP
4711})
4712#endif
4713
4714/*
4715 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
4716 * of using a WARN/WARN_ON to get the message out, including the
4717 * file/line information and a backtrace.
4718 */
4719#define wiphy_WARN(wiphy, format, args...) \
4720 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
4721
704232c2 4722#endif /* __NET_CFG80211_H */