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