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