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