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