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