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