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