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