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