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