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