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