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