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