]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - include/net/cfg80211.h
carl9170: fix allmulticast mode
[mirror_ubuntu-hirsute-kernel.git] / include / net / cfg80211.h
CommitLineData
704232c2
JB
1#ifndef __NET_CFG80211_H
2#define __NET_CFG80211_H
d3236553
JB
3/*
4 * 802.11 device and configuration interface
5 *
026331c4 6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
d3236553
JB
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
704232c2 12
d3236553
JB
13#include <linux/netdevice.h>
14#include <linux/debugfs.h>
15#include <linux/list.h>
704232c2
JB
16#include <linux/netlink.h>
17#include <linux/skbuff.h>
55682965 18#include <linux/nl80211.h>
2a519311
JB
19#include <linux/if_ether.h>
20#include <linux/ieee80211.h>
d3236553
JB
21#include <net/regulatory.h>
22
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
15d5dda6 698 * @is_secure: or not
29cbe68c
JB
699 *
700 * These parameters are fixed when the mesh is created.
701 */
702struct mesh_setup {
703 const u8 *mesh_id;
704 u8 mesh_id_len;
c80d545d
JC
705 u8 path_sel_proto;
706 u8 path_metric;
581a8b0f
JC
707 const u8 *ie;
708 u8 ie_len;
15d5dda6 709 bool is_secure;
29cbe68c
JB
710};
711
31888487
JM
712/**
713 * struct ieee80211_txq_params - TX queue parameters
714 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
715 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
716 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
717 * 1..32767]
718 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
719 * 1..32767]
720 * @aifs: Arbitration interframe space [0..255]
721 */
722struct ieee80211_txq_params {
723 enum nl80211_txq_q queue;
724 u16 txop;
725 u16 cwmin;
726 u16 cwmax;
727 u8 aifs;
728};
729
704232c2
JB
730/* from net/wireless.h */
731struct wiphy;
732
d70e9693
JB
733/**
734 * DOC: Scanning and BSS list handling
735 *
736 * The scanning process itself is fairly simple, but cfg80211 offers quite
737 * a bit of helper functionality. To start a scan, the scan operation will
738 * be invoked with a scan definition. This scan definition contains the
739 * channels to scan, and the SSIDs to send probe requests for (including the
740 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
741 * probe. Additionally, a scan request may contain extra information elements
742 * that should be added to the probe request. The IEs are guaranteed to be
743 * well-formed, and will not exceed the maximum length the driver advertised
744 * in the wiphy structure.
745 *
746 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
747 * it is responsible for maintaining the BSS list; the driver should not
748 * maintain a list itself. For this notification, various functions exist.
749 *
750 * Since drivers do not maintain a BSS list, there are also a number of
751 * functions to search for a BSS and obtain information about it from the
752 * BSS structure cfg80211 maintains. The BSS list is also made available
753 * to userspace.
754 */
72bdcf34 755
2a519311
JB
756/**
757 * struct cfg80211_ssid - SSID description
758 * @ssid: the SSID
759 * @ssid_len: length of the ssid
760 */
761struct cfg80211_ssid {
762 u8 ssid[IEEE80211_MAX_SSID_LEN];
763 u8 ssid_len;
764};
765
766/**
767 * struct cfg80211_scan_request - scan request description
768 *
769 * @ssids: SSIDs to scan for (active scan only)
770 * @n_ssids: number of SSIDs
771 * @channels: channels to scan on.
ca3dbc20 772 * @n_channels: total number of channels to scan
70692ad2
JM
773 * @ie: optional information element(s) to add into Probe Request or %NULL
774 * @ie_len: length of ie in octets
2a519311 775 * @wiphy: the wiphy this was for
463d0183 776 * @dev: the interface
abe37c4b 777 * @aborted: (internal) scan request was notified as aborted
2a519311
JB
778 */
779struct cfg80211_scan_request {
780 struct cfg80211_ssid *ssids;
781 int n_ssids;
2a519311 782 u32 n_channels;
de95a54b 783 const u8 *ie;
70692ad2 784 size_t ie_len;
2a519311
JB
785
786 /* internal */
787 struct wiphy *wiphy;
463d0183 788 struct net_device *dev;
667503dd 789 bool aborted;
5ba63533
JB
790
791 /* keep last */
792 struct ieee80211_channel *channels[0];
2a519311
JB
793};
794
795/**
796 * enum cfg80211_signal_type - signal type
797 *
798 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
799 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
800 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
801 */
802enum cfg80211_signal_type {
803 CFG80211_SIGNAL_TYPE_NONE,
804 CFG80211_SIGNAL_TYPE_MBM,
805 CFG80211_SIGNAL_TYPE_UNSPEC,
806};
807
808/**
809 * struct cfg80211_bss - BSS description
810 *
811 * This structure describes a BSS (which may also be a mesh network)
812 * for use in scan results and similar.
813 *
abe37c4b 814 * @channel: channel this BSS is on
2a519311
JB
815 * @bssid: BSSID of the BSS
816 * @tsf: timestamp of last received update
817 * @beacon_interval: the beacon interval as from the frame
818 * @capability: the capability field in host byte order
819 * @information_elements: the information elements (Note that there
34a6eddb
JM
820 * is no guarantee that these are well-formed!); this is a pointer to
821 * either the beacon_ies or proberesp_ies depending on whether Probe
822 * Response frame has been received
2a519311 823 * @len_information_elements: total length of the information elements
34a6eddb
JM
824 * @beacon_ies: the information elements from the last Beacon frame
825 * @len_beacon_ies: total length of the beacon_ies
826 * @proberesp_ies: the information elements from the last Probe Response frame
827 * @len_proberesp_ies: total length of the proberesp_ies
77965c97 828 * @signal: signal strength value (type depends on the wiphy's signal_type)
78c1c7e1 829 * @free_priv: function pointer to free private data
2a519311
JB
830 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
831 */
832struct cfg80211_bss {
833 struct ieee80211_channel *channel;
834
835 u8 bssid[ETH_ALEN];
836 u64 tsf;
837 u16 beacon_interval;
838 u16 capability;
839 u8 *information_elements;
840 size_t len_information_elements;
34a6eddb
JM
841 u8 *beacon_ies;
842 size_t len_beacon_ies;
843 u8 *proberesp_ies;
844 size_t len_proberesp_ies;
2a519311
JB
845
846 s32 signal;
2a519311 847
78c1c7e1 848 void (*free_priv)(struct cfg80211_bss *bss);
2a519311
JB
849 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
850};
851
517357c6
JB
852/**
853 * ieee80211_bss_get_ie - find IE with given ID
854 * @bss: the bss to search
855 * @ie: the IE ID
856 * Returns %NULL if not found.
857 */
858const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
859
860
b23aa676
SO
861/**
862 * struct cfg80211_crypto_settings - Crypto settings
863 * @wpa_versions: indicates which, if any, WPA versions are enabled
864 * (from enum nl80211_wpa_versions)
865 * @cipher_group: group key cipher suite (or 0 if unset)
866 * @n_ciphers_pairwise: number of AP supported unicast ciphers
867 * @ciphers_pairwise: unicast key cipher suites
868 * @n_akm_suites: number of AKM suites
869 * @akm_suites: AKM suites
870 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
871 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
872 * required to assume that the port is unauthorized until authorized by
873 * user space. Otherwise, port is marked authorized by default.
c0692b8f
JB
874 * @control_port_ethertype: the control port protocol that should be
875 * allowed through even on unauthorized ports
876 * @control_port_no_encrypt: TRUE to prevent encryption of control port
877 * protocol frames.
b23aa676
SO
878 */
879struct cfg80211_crypto_settings {
880 u32 wpa_versions;
881 u32 cipher_group;
882 int n_ciphers_pairwise;
883 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
884 int n_akm_suites;
885 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
886 bool control_port;
c0692b8f
JB
887 __be16 control_port_ethertype;
888 bool control_port_no_encrypt;
b23aa676
SO
889};
890
636a5d36
JM
891/**
892 * struct cfg80211_auth_request - Authentication request data
893 *
894 * This structure provides information needed to complete IEEE 802.11
895 * authentication.
19957bb3
JB
896 *
897 * @bss: The BSS to authenticate with.
636a5d36
JM
898 * @auth_type: Authentication type (algorithm)
899 * @ie: Extra IEs to add to Authentication frame or %NULL
900 * @ie_len: Length of ie buffer in octets
fffd0934
JB
901 * @key_len: length of WEP key for shared key authentication
902 * @key_idx: index of WEP key for shared key authentication
903 * @key: WEP key for shared key authentication
d5cdfacb
JM
904 * @local_state_change: This is a request for a local state only, i.e., no
905 * Authentication frame is to be transmitted and authentication state is
906 * to be changed without having to wait for a response from the peer STA
907 * (AP).
636a5d36
JM
908 */
909struct cfg80211_auth_request {
19957bb3 910 struct cfg80211_bss *bss;
636a5d36
JM
911 const u8 *ie;
912 size_t ie_len;
19957bb3 913 enum nl80211_auth_type auth_type;
fffd0934
JB
914 const u8 *key;
915 u8 key_len, key_idx;
d5cdfacb 916 bool local_state_change;
636a5d36
JM
917};
918
919/**
920 * struct cfg80211_assoc_request - (Re)Association request data
921 *
922 * This structure provides information needed to complete IEEE 802.11
923 * (re)association.
19957bb3 924 * @bss: The BSS to associate with.
636a5d36
JM
925 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
926 * @ie_len: Length of ie buffer in octets
dc6382ce 927 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
b23aa676 928 * @crypto: crypto settings
3e5d7649 929 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
636a5d36
JM
930 */
931struct cfg80211_assoc_request {
19957bb3 932 struct cfg80211_bss *bss;
3e5d7649 933 const u8 *ie, *prev_bssid;
636a5d36 934 size_t ie_len;
b23aa676 935 struct cfg80211_crypto_settings crypto;
19957bb3 936 bool use_mfp;
636a5d36
JM
937};
938
939/**
940 * struct cfg80211_deauth_request - Deauthentication request data
941 *
942 * This structure provides information needed to complete IEEE 802.11
943 * deauthentication.
944 *
19957bb3 945 * @bss: the BSS to deauthenticate from
636a5d36
JM
946 * @ie: Extra IEs to add to Deauthentication frame or %NULL
947 * @ie_len: Length of ie buffer in octets
19957bb3 948 * @reason_code: The reason code for the deauthentication
d5cdfacb
JM
949 * @local_state_change: This is a request for a local state only, i.e., no
950 * Deauthentication frame is to be transmitted.
636a5d36
JM
951 */
952struct cfg80211_deauth_request {
19957bb3 953 struct cfg80211_bss *bss;
636a5d36
JM
954 const u8 *ie;
955 size_t ie_len;
19957bb3 956 u16 reason_code;
d5cdfacb 957 bool local_state_change;
636a5d36
JM
958};
959
960/**
961 * struct cfg80211_disassoc_request - Disassociation request data
962 *
963 * This structure provides information needed to complete IEEE 802.11
964 * disassocation.
965 *
19957bb3 966 * @bss: the BSS to disassociate from
636a5d36
JM
967 * @ie: Extra IEs to add to Disassociation frame or %NULL
968 * @ie_len: Length of ie buffer in octets
19957bb3 969 * @reason_code: The reason code for the disassociation
d5cdfacb
JM
970 * @local_state_change: This is a request for a local state only, i.e., no
971 * Disassociation frame is to be transmitted.
636a5d36
JM
972 */
973struct cfg80211_disassoc_request {
19957bb3 974 struct cfg80211_bss *bss;
636a5d36
JM
975 const u8 *ie;
976 size_t ie_len;
19957bb3 977 u16 reason_code;
d5cdfacb 978 bool local_state_change;
636a5d36
JM
979};
980
04a773ad
JB
981/**
982 * struct cfg80211_ibss_params - IBSS parameters
983 *
984 * This structure defines the IBSS parameters for the join_ibss()
985 * method.
986 *
987 * @ssid: The SSID, will always be non-null.
988 * @ssid_len: The length of the SSID, will always be non-zero.
989 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
990 * search for IBSSs with a different BSSID.
991 * @channel: The channel to use if no IBSS can be found to join.
992 * @channel_fixed: The channel should be fixed -- do not search for
993 * IBSSs to join on other channels.
994 * @ie: information element(s) to include in the beacon
995 * @ie_len: length of that
8e30bc55 996 * @beacon_interval: beacon interval to use
fffd0934
JB
997 * @privacy: this is a protected network, keys will be configured
998 * after joining
fbd2c8dc 999 * @basic_rates: bitmap of basic rates to use when creating the IBSS
dd5b4cc7 1000 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
04a773ad
JB
1001 */
1002struct cfg80211_ibss_params {
1003 u8 *ssid;
1004 u8 *bssid;
1005 struct ieee80211_channel *channel;
1006 u8 *ie;
1007 u8 ssid_len, ie_len;
8e30bc55 1008 u16 beacon_interval;
fbd2c8dc 1009 u32 basic_rates;
04a773ad 1010 bool channel_fixed;
fffd0934 1011 bool privacy;
dd5b4cc7 1012 int mcast_rate[IEEE80211_NUM_BANDS];
04a773ad
JB
1013};
1014
b23aa676
SO
1015/**
1016 * struct cfg80211_connect_params - Connection parameters
1017 *
1018 * This structure provides information needed to complete IEEE 802.11
1019 * authentication and association.
1020 *
1021 * @channel: The channel to use or %NULL if not specified (auto-select based
1022 * on scan results)
1023 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1024 * results)
1025 * @ssid: SSID
1026 * @ssid_len: Length of ssid in octets
1027 * @auth_type: Authentication type (algorithm)
abe37c4b
JB
1028 * @ie: IEs for association request
1029 * @ie_len: Length of assoc_ie in octets
b23aa676
SO
1030 * @privacy: indicates whether privacy-enabled APs should be used
1031 * @crypto: crypto settings
fffd0934
JB
1032 * @key_len: length of WEP key for shared key authentication
1033 * @key_idx: index of WEP key for shared key authentication
1034 * @key: WEP key for shared key authentication
b23aa676
SO
1035 */
1036struct cfg80211_connect_params {
1037 struct ieee80211_channel *channel;
1038 u8 *bssid;
1039 u8 *ssid;
1040 size_t ssid_len;
1041 enum nl80211_auth_type auth_type;
1042 u8 *ie;
1043 size_t ie_len;
1044 bool privacy;
1045 struct cfg80211_crypto_settings crypto;
fffd0934
JB
1046 const u8 *key;
1047 u8 key_len, key_idx;
b23aa676
SO
1048};
1049
b9a5f8ca
JM
1050/**
1051 * enum wiphy_params_flags - set_wiphy_params bitfield values
abe37c4b
JB
1052 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1053 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1054 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1055 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1056 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
b9a5f8ca
JM
1057 */
1058enum wiphy_params_flags {
1059 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1060 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1061 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1062 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
81077e82 1063 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
b9a5f8ca
JM
1064};
1065
9930380f
JB
1066/*
1067 * cfg80211_bitrate_mask - masks for bitrate control
1068 */
1069struct cfg80211_bitrate_mask {
9930380f
JB
1070 struct {
1071 u32 legacy;
37eb0b16
JM
1072 /* TODO: add support for masking MCS rates; e.g.: */
1073 /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
9930380f 1074 } control[IEEE80211_NUM_BANDS];
9930380f 1075};
67fbb16b
SO
1076/**
1077 * struct cfg80211_pmksa - PMK Security Association
1078 *
1079 * This structure is passed to the set/del_pmksa() method for PMKSA
1080 * caching.
1081 *
1082 * @bssid: The AP's BSSID.
1083 * @pmkid: The PMK material itself.
1084 */
1085struct cfg80211_pmksa {
1086 u8 *bssid;
1087 u8 *pmkid;
1088};
9930380f 1089
704232c2
JB
1090/**
1091 * struct cfg80211_ops - backend description for wireless configuration
1092 *
1093 * This struct is registered by fullmac card drivers and/or wireless stacks
1094 * in order to handle configuration requests on their interfaces.
1095 *
1096 * All callbacks except where otherwise noted should return 0
1097 * on success or a negative error code.
1098 *
43fb45cb
JB
1099 * All operations are currently invoked under rtnl for consistency with the
1100 * wireless extensions but this is subject to reevaluation as soon as this
1101 * code is used more widely and we have a first user without wext.
1102 *
0378b3f1
JB
1103 * @suspend: wiphy device needs to be suspended
1104 * @resume: wiphy device needs to be resumed
1105 *
60719ffd 1106 * @add_virtual_intf: create a new virtual interface with the given name,
463d0183 1107 * must set the struct wireless_dev's iftype. Beware: You must create
f9e10ce4
JB
1108 * the new netdev in the wiphy's network namespace! Returns the netdev,
1109 * or an ERR_PTR.
704232c2
JB
1110 *
1111 * @del_virtual_intf: remove the virtual interface determined by ifindex.
55682965 1112 *
60719ffd
JB
1113 * @change_virtual_intf: change type/configuration of virtual interface,
1114 * keep the struct wireless_dev's iftype updated.
55682965 1115 *
41ade00f
JB
1116 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1117 * when adding a group key.
1118 *
1119 * @get_key: get information about the key with the given parameters.
1120 * @mac_addr will be %NULL when requesting information for a group
1121 * key. All pointers given to the @callback function need not be valid
e3da574a
JB
1122 * after it returns. This function should return an error if it is
1123 * not possible to retrieve the key, -ENOENT if it doesn't exist.
41ade00f
JB
1124 *
1125 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
e3da574a 1126 * and @key_index, return -ENOENT if the key doesn't exist.
41ade00f
JB
1127 *
1128 * @set_default_key: set the default key on an interface
ed1b6cc7 1129 *
3cfcf6ac
JM
1130 * @set_default_mgmt_key: set the default management frame key on an interface
1131 *
ed1b6cc7
JB
1132 * @add_beacon: Add a beacon with given parameters, @head, @interval
1133 * and @dtim_period will be valid, @tail is optional.
1134 * @set_beacon: Change the beacon parameters for an access point mode
1135 * interface. This should reject the call when no beacon has been
1136 * configured.
1137 * @del_beacon: Remove beacon configuration and stop sending the beacon.
5727ef1b
JB
1138 *
1139 * @add_station: Add a new station.
5727ef1b 1140 * @del_station: Remove a station; @mac may be NULL to remove all stations.
5727ef1b 1141 * @change_station: Modify a given station.
abe37c4b
JB
1142 * @get_station: get station information for the station identified by @mac
1143 * @dump_station: dump station callback -- resume dump at index @idx
1144 *
1145 * @add_mpath: add a fixed mesh path
1146 * @del_mpath: delete a given mesh path
1147 * @change_mpath: change a given mesh path
1148 * @get_mpath: get a mesh path for the given parameters
1149 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
f52555a4
JB
1150 * @join_mesh: join the mesh network with the specified parameters
1151 * @leave_mesh: leave the current mesh network
2ec600d6 1152 *
24bdd9f4 1153 * @get_mesh_config: Get the current mesh configuration
93da9cc1 1154 *
24bdd9f4 1155 * @update_mesh_config: Update mesh parameters on a running mesh.
93da9cc1 1156 * The mask is a bitfield which tells us which parameters to
1157 * set, and which to leave alone.
1158 *
9f1ba906 1159 * @change_bss: Modify parameters for a given BSS.
31888487
JM
1160 *
1161 * @set_txq_params: Set TX queue parameters
72bdcf34 1162 *
f444de05
JB
1163 * @set_channel: Set channel for a given wireless interface. Some devices
1164 * may support multi-channel operation (by channel hopping) so cfg80211
1165 * doesn't verify much. Note, however, that the passed netdev may be
1166 * %NULL as well if the user requested changing the channel for the
1167 * device itself, or for a monitor interface.
9aed3cc1 1168 *
2a519311
JB
1169 * @scan: Request to do a scan. If returning zero, the scan request is given
1170 * the driver, and will be valid until passed to cfg80211_scan_done().
1171 * For scan results, call cfg80211_inform_bss(); you can call this outside
1172 * the scan/scan_done bracket too.
636a5d36
JM
1173 *
1174 * @auth: Request to authenticate with the specified peer
1175 * @assoc: Request to (re)associate with the specified peer
1176 * @deauth: Request to deauthenticate from the specified peer
1177 * @disassoc: Request to disassociate from the specified peer
04a773ad 1178 *
b23aa676
SO
1179 * @connect: Connect to the ESS with the specified parameters. When connected,
1180 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1181 * If the connection fails for some reason, call cfg80211_connect_result()
1182 * with the status from the AP.
1183 * @disconnect: Disconnect from the BSS/ESS.
1184 *
04a773ad
JB
1185 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1186 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1187 * to a merge.
1188 * @leave_ibss: Leave the IBSS.
b9a5f8ca
JM
1189 *
1190 * @set_wiphy_params: Notify that wiphy parameters have changed;
1191 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1192 * have changed. The actual parameter values are available in
1193 * struct wiphy. If returning an error, no value should be changed.
7643a2c3
JB
1194 *
1195 * @set_tx_power: set the transmit power according to the parameters
1196 * @get_tx_power: store the current TX power into the dbm variable;
1f87f7d3
JB
1197 * return 0 if successful
1198 *
abe37c4b
JB
1199 * @set_wds_peer: set the WDS peer for a WDS interface
1200 *
1f87f7d3
JB
1201 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1202 * functions to adjust rfkill hw state
aff89a9b 1203 *
61fa713c
HS
1204 * @dump_survey: get site survey information.
1205 *
9588bbd5
JM
1206 * @remain_on_channel: Request the driver to remain awake on the specified
1207 * channel for the specified duration to complete an off-channel
1208 * operation (e.g., public action frame exchange). When the driver is
1209 * ready on the requested channel, it must indicate this with an event
1210 * notification by calling cfg80211_ready_on_channel().
1211 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1212 * This allows the operation to be terminated prior to timeout based on
1213 * the duration value.
f7ca38df
JB
1214 * @mgmt_tx: Transmit a management frame.
1215 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1216 * frame on another channel
9588bbd5 1217 *
aff89a9b 1218 * @testmode_cmd: run a test mode command
67fbb16b 1219 *
abe37c4b
JB
1220 * @set_bitrate_mask: set the bitrate mask configuration
1221 *
67fbb16b
SO
1222 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1223 * devices running firmwares capable of generating the (re) association
1224 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1225 * @del_pmksa: Delete a cached PMKID.
1226 * @flush_pmksa: Flush all cached PMKIDs.
9043f3b8
JO
1227 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1228 * allows the driver to adjust the dynamic ps timeout value.
d6dc1a38 1229 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
67fbb16b 1230 *
271733cf
JB
1231 * @mgmt_frame_register: Notify driver that a management frame type was
1232 * registered. Note that this callback may not sleep, and cannot run
1233 * concurrently with itself.
547025d5
BR
1234 *
1235 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1236 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1237 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1238 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1239 *
1240 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3677713b
JL
1241 *
1242 * @set_ringparam: Set tx and rx ring sizes.
1243 *
1244 * @get_ringparam: Get tx and rx ring current and maximum sizes.
704232c2
JB
1245 */
1246struct cfg80211_ops {
0378b3f1
JB
1247 int (*suspend)(struct wiphy *wiphy);
1248 int (*resume)(struct wiphy *wiphy);
1249
f9e10ce4
JB
1250 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
1251 char *name,
1252 enum nl80211_iftype type,
1253 u32 *flags,
1254 struct vif_params *params);
463d0183 1255 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
e36d56b6
JB
1256 int (*change_virtual_intf)(struct wiphy *wiphy,
1257 struct net_device *dev,
2ec600d6
LCC
1258 enum nl80211_iftype type, u32 *flags,
1259 struct vif_params *params);
41ade00f
JB
1260
1261 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
e31b8213 1262 u8 key_index, bool pairwise, const u8 *mac_addr,
41ade00f
JB
1263 struct key_params *params);
1264 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
e31b8213
JB
1265 u8 key_index, bool pairwise, const u8 *mac_addr,
1266 void *cookie,
41ade00f
JB
1267 void (*callback)(void *cookie, struct key_params*));
1268 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
e31b8213 1269 u8 key_index, bool pairwise, const u8 *mac_addr);
41ade00f
JB
1270 int (*set_default_key)(struct wiphy *wiphy,
1271 struct net_device *netdev,
dbd2fd65 1272 u8 key_index, bool unicast, bool multicast);
3cfcf6ac
JM
1273 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1274 struct net_device *netdev,
1275 u8 key_index);
ed1b6cc7
JB
1276
1277 int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
1278 struct beacon_parameters *info);
1279 int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
1280 struct beacon_parameters *info);
1281 int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
5727ef1b
JB
1282
1283
1284 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1285 u8 *mac, struct station_parameters *params);
1286 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1287 u8 *mac);
1288 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1289 u8 *mac, struct station_parameters *params);
fd5b74dc 1290 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2ec600d6
LCC
1291 u8 *mac, struct station_info *sinfo);
1292 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1293 int idx, u8 *mac, struct station_info *sinfo);
1294
1295 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1296 u8 *dst, u8 *next_hop);
1297 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1298 u8 *dst);
1299 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1300 u8 *dst, u8 *next_hop);
1301 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1302 u8 *dst, u8 *next_hop,
1303 struct mpath_info *pinfo);
1304 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1305 int idx, u8 *dst, u8 *next_hop,
1306 struct mpath_info *pinfo);
24bdd9f4 1307 int (*get_mesh_config)(struct wiphy *wiphy,
93da9cc1 1308 struct net_device *dev,
1309 struct mesh_config *conf);
24bdd9f4 1310 int (*update_mesh_config)(struct wiphy *wiphy,
29cbe68c
JB
1311 struct net_device *dev, u32 mask,
1312 const struct mesh_config *nconf);
1313 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1314 const struct mesh_config *conf,
1315 const struct mesh_setup *setup);
1316 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1317
9f1ba906
JM
1318 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1319 struct bss_parameters *params);
31888487
JM
1320
1321 int (*set_txq_params)(struct wiphy *wiphy,
1322 struct ieee80211_txq_params *params);
72bdcf34 1323
f444de05 1324 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
72bdcf34 1325 struct ieee80211_channel *chan,
094d05dc 1326 enum nl80211_channel_type channel_type);
9aed3cc1 1327
2a519311
JB
1328 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1329 struct cfg80211_scan_request *request);
636a5d36
JM
1330
1331 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1332 struct cfg80211_auth_request *req);
1333 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1334 struct cfg80211_assoc_request *req);
1335 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
667503dd
JB
1336 struct cfg80211_deauth_request *req,
1337 void *cookie);
636a5d36 1338 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
667503dd
JB
1339 struct cfg80211_disassoc_request *req,
1340 void *cookie);
04a773ad 1341
b23aa676
SO
1342 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1343 struct cfg80211_connect_params *sme);
1344 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1345 u16 reason_code);
1346
04a773ad
JB
1347 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1348 struct cfg80211_ibss_params *params);
1349 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
b9a5f8ca
JM
1350
1351 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
7643a2c3
JB
1352
1353 int (*set_tx_power)(struct wiphy *wiphy,
fa61cf70 1354 enum nl80211_tx_power_setting type, int mbm);
7643a2c3 1355 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1f87f7d3 1356
ab737a4f 1357 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
388ac775 1358 const u8 *addr);
ab737a4f 1359
1f87f7d3 1360 void (*rfkill_poll)(struct wiphy *wiphy);
aff89a9b
JB
1361
1362#ifdef CONFIG_NL80211_TESTMODE
1363 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1364#endif
bc92afd9 1365
9930380f
JB
1366 int (*set_bitrate_mask)(struct wiphy *wiphy,
1367 struct net_device *dev,
1368 const u8 *peer,
1369 const struct cfg80211_bitrate_mask *mask);
1370
61fa713c
HS
1371 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1372 int idx, struct survey_info *info);
1373
67fbb16b
SO
1374 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1375 struct cfg80211_pmksa *pmksa);
1376 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1377 struct cfg80211_pmksa *pmksa);
1378 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1379
9588bbd5
JM
1380 int (*remain_on_channel)(struct wiphy *wiphy,
1381 struct net_device *dev,
1382 struct ieee80211_channel *chan,
1383 enum nl80211_channel_type channel_type,
1384 unsigned int duration,
1385 u64 *cookie);
1386 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1387 struct net_device *dev,
1388 u64 cookie);
1389
2e161f78 1390 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
f7ca38df 1391 struct ieee80211_channel *chan, bool offchan,
026331c4 1392 enum nl80211_channel_type channel_type,
f7ca38df 1393 bool channel_type_valid, unsigned int wait,
026331c4 1394 const u8 *buf, size_t len, u64 *cookie);
f7ca38df
JB
1395 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1396 struct net_device *dev,
1397 u64 cookie);
026331c4 1398
bc92afd9
JB
1399 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1400 bool enabled, int timeout);
d6dc1a38
JO
1401
1402 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1403 struct net_device *dev,
1404 s32 rssi_thold, u32 rssi_hyst);
271733cf
JB
1405
1406 void (*mgmt_frame_register)(struct wiphy *wiphy,
1407 struct net_device *dev,
1408 u16 frame_type, bool reg);
afe0cbf8
BR
1409
1410 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1411 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3677713b
JL
1412
1413 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1414 void (*get_ringparam)(struct wiphy *wiphy,
1415 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
704232c2
JB
1416};
1417
d3236553
JB
1418/*
1419 * wireless hardware and networking interfaces structures
1420 * and registration/helper functions
1421 */
1422
1423/**
5be83de5
JB
1424 * enum wiphy_flags - wiphy capability flags
1425 *
1426 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
d3236553
JB
1427 * has its own custom regulatory domain and cannot identify the
1428 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1429 * we will disregard the first regulatory hint (when the
1430 * initiator is %REGDOM_SET_BY_CORE).
5be83de5
JB
1431 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1432 * ignore regulatory domain settings until it gets its own regulatory
749b527b
LR
1433 * domain via its regulatory_hint() unless the regulatory hint is
1434 * from a country IE. After its gets its own regulatory domain it will
1435 * only allow further regulatory domain settings to further enhance
1436 * compliance. For example if channel 13 and 14 are disabled by this
1437 * regulatory domain no user regulatory domain can enable these channels
1438 * at a later time. This can be used for devices which do not have
1439 * calibration information guaranteed for frequencies or settings
1440 * outside of its regulatory domain.
5be83de5
JB
1441 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1442 * that passive scan flags and beaconing flags may not be lifted by
1443 * cfg80211 due to regulatory beacon hints. For more information on beacon
37184244 1444 * hints read the documenation for regulatory_hint_found_beacon()
5be83de5
JB
1445 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1446 * wiphy at all
1447 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1448 * by default -- this flag will be set depending on the kernel's default
1449 * on wiphy_new(), but can be changed by the driver if it has a good
1450 * reason to override the default
9bc383de
JB
1451 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1452 * on a VLAN interface)
1453 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
c0692b8f
JB
1454 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1455 * control port protocol ethertype. The device also honours the
1456 * control_port_no_encrypt flag.
e31b8213 1457 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
15d5dda6
JC
1458 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1459 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
5be83de5
JB
1460 */
1461enum wiphy_flags {
c0692b8f
JB
1462 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1463 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1464 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1465 WIPHY_FLAG_NETNS_OK = BIT(3),
1466 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1467 WIPHY_FLAG_4ADDR_AP = BIT(5),
1468 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1469 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
309075cf 1470 WIPHY_FLAG_IBSS_RSN = BIT(8),
15d5dda6 1471 WIPHY_FLAG_MESH_AUTH = BIT(10),
5be83de5
JB
1472};
1473
ef15aac6
JB
1474struct mac_address {
1475 u8 addr[ETH_ALEN];
1476};
1477
2e161f78
JB
1478struct ieee80211_txrx_stypes {
1479 u16 tx, rx;
1480};
1481
5be83de5
JB
1482/**
1483 * struct wiphy - wireless hardware description
2784fe91
LR
1484 * @reg_notifier: the driver's regulatory notification callback,
1485 * note that if your driver uses wiphy_apply_custom_regulatory()
1486 * the reg_notifier's request can be passed as NULL
d3236553
JB
1487 * @regd: the driver's regulatory domain, if one was requested via
1488 * the regulatory_hint() API. This can be used by the driver
1489 * on the reg_notifier() if it chooses to ignore future
1490 * regulatory domain changes caused by other drivers.
1491 * @signal_type: signal type reported in &struct cfg80211_bss.
1492 * @cipher_suites: supported cipher suites
1493 * @n_cipher_suites: number of supported cipher suites
b9a5f8ca
JM
1494 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1495 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1496 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1497 * -1 = fragmentation disabled, only odd values >= 256 used
1498 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
abe37c4b 1499 * @_net: the network namespace this wiphy currently lives in
ef15aac6
JB
1500 * @perm_addr: permanent MAC address of this device
1501 * @addr_mask: If the device supports multiple MAC addresses by masking,
1502 * set this to a mask with variable bits set to 1, e.g. if the last
1503 * four bits are variable then set it to 00:...:00:0f. The actual
1504 * variable bits shall be determined by the interfaces added, with
1505 * interfaces not matching the mask being rejected to be brought up.
1506 * @n_addresses: number of addresses in @addresses.
1507 * @addresses: If the device has more than one address, set this pointer
1508 * to a list of addresses (6 bytes each). The first one will be used
1509 * by default for perm_addr. In this case, the mask should be set to
1510 * all-zeroes. In this case it is assumed that the device can handle
1511 * the same number of arbitrary MAC addresses.
abe37c4b
JB
1512 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1513 * automatically on wiphy renames
1514 * @dev: (virtual) struct device for this wiphy
1515 * @wext: wireless extension handlers
1516 * @priv: driver private data (sized according to wiphy_new() parameter)
1517 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1518 * must be set by driver
1519 * @flags: wiphy flags, see &enum wiphy_flags
1520 * @bss_priv_size: each BSS struct has private data allocated with it,
1521 * this variable determines its size
1522 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1523 * any given scan
1524 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1525 * add to probe request frames transmitted during a scan, must not
1526 * include fixed IEs like supported rates
1527 * @coverage_class: current coverage class
1528 * @fw_version: firmware version for ethtool reporting
1529 * @hw_version: hardware version for ethtool reporting
1530 * @max_num_pmkids: maximum number of PMKIDs supported by device
1531 * @privid: a pointer that drivers can use to identify if an arbitrary
1532 * wiphy is theirs, e.g. in global notifiers
1533 * @bands: information about bands/channels supported by this device
2e161f78
JB
1534 *
1535 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1536 * transmitted through nl80211, points to an array indexed by interface
1537 * type
a7ffac95 1538 *
7f531e03
BR
1539 * @available_antennas_tx: bitmap of antennas which are available to be
1540 * configured as TX antennas. Antenna configuration commands will be
1541 * rejected unless this or @available_antennas_rx is set.
1542 *
1543 * @available_antennas_rx: bitmap of antennas which are available to be
1544 * configured as RX antennas. Antenna configuration commands will be
1545 * rejected unless this or @available_antennas_tx is set.
a293911d
JB
1546 *
1547 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
1548 * may request, if implemented.
d3236553
JB
1549 */
1550struct wiphy {
1551 /* assign these fields before you register the wiphy */
1552
ef15aac6 1553 /* permanent MAC address(es) */
d3236553 1554 u8 perm_addr[ETH_ALEN];
ef15aac6
JB
1555 u8 addr_mask[ETH_ALEN];
1556
ef15aac6 1557 struct mac_address *addresses;
d3236553 1558
2e161f78
JB
1559 const struct ieee80211_txrx_stypes *mgmt_stypes;
1560
1561 u16 n_addresses;
1562
d3236553
JB
1563 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1564 u16 interface_modes;
1565
5be83de5 1566 u32 flags;
463d0183 1567
d3236553
JB
1568 enum cfg80211_signal_type signal_type;
1569
1570 int bss_priv_size;
1571 u8 max_scan_ssids;
1572 u16 max_scan_ie_len;
1573
1574 int n_cipher_suites;
1575 const u32 *cipher_suites;
1576
b9a5f8ca
JM
1577 u8 retry_short;
1578 u8 retry_long;
1579 u32 frag_threshold;
1580 u32 rts_threshold;
81077e82 1581 u8 coverage_class;
b9a5f8ca 1582
dfce95f5
KV
1583 char fw_version[ETHTOOL_BUSINFO_LEN];
1584 u32 hw_version;
1585
a293911d
JB
1586 u16 max_remain_on_channel_duration;
1587
67fbb16b
SO
1588 u8 max_num_pmkids;
1589
7f531e03
BR
1590 u32 available_antennas_tx;
1591 u32 available_antennas_rx;
a7ffac95 1592
d3236553
JB
1593 /* If multiple wiphys are registered and you're handed e.g.
1594 * a regular netdev with assigned ieee80211_ptr, you won't
1595 * know whether it points to a wiphy your driver has registered
1596 * or not. Assign this to something global to your driver to
1597 * help determine whether you own this wiphy or not. */
cf5aa2f1 1598 const void *privid;
d3236553
JB
1599
1600 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1601
1602 /* Lets us get back the wiphy on the callback */
1603 int (*reg_notifier)(struct wiphy *wiphy,
1604 struct regulatory_request *request);
1605
1606 /* fields below are read-only, assigned by cfg80211 */
1607
1608 const struct ieee80211_regdomain *regd;
1609
1610 /* the item in /sys/class/ieee80211/ points to this,
1611 * you need use set_wiphy_dev() (see below) */
1612 struct device dev;
1613
1614 /* dir in debugfs: ieee80211/<wiphyname> */
1615 struct dentry *debugfsdir;
1616
463d0183
JB
1617#ifdef CONFIG_NET_NS
1618 /* the network namespace this phy lives in currently */
1619 struct net *_net;
1620#endif
1621
3d23e349
JB
1622#ifdef CONFIG_CFG80211_WEXT
1623 const struct iw_handler_def *wext;
1624#endif
1625
d3236553
JB
1626 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1627};
1628
463d0183
JB
1629static inline struct net *wiphy_net(struct wiphy *wiphy)
1630{
c2d9ba9b 1631 return read_pnet(&wiphy->_net);
463d0183
JB
1632}
1633
1634static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
1635{
c2d9ba9b 1636 write_pnet(&wiphy->_net, net);
463d0183 1637}
463d0183 1638
d3236553
JB
1639/**
1640 * wiphy_priv - return priv from wiphy
1641 *
1642 * @wiphy: the wiphy whose priv pointer to return
1643 */
1644static inline void *wiphy_priv(struct wiphy *wiphy)
1645{
1646 BUG_ON(!wiphy);
1647 return &wiphy->priv;
1648}
1649
f1f74825
DK
1650/**
1651 * priv_to_wiphy - return the wiphy containing the priv
1652 *
1653 * @priv: a pointer previously returned by wiphy_priv
1654 */
1655static inline struct wiphy *priv_to_wiphy(void *priv)
1656{
1657 BUG_ON(!priv);
1658 return container_of(priv, struct wiphy, priv);
1659}
1660
d3236553
JB
1661/**
1662 * set_wiphy_dev - set device pointer for wiphy
1663 *
1664 * @wiphy: The wiphy whose device to bind
1665 * @dev: The device to parent it to
1666 */
1667static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1668{
1669 wiphy->dev.parent = dev;
1670}
1671
1672/**
1673 * wiphy_dev - get wiphy dev pointer
1674 *
1675 * @wiphy: The wiphy whose device struct to look up
1676 */
1677static inline struct device *wiphy_dev(struct wiphy *wiphy)
1678{
1679 return wiphy->dev.parent;
1680}
1681
1682/**
1683 * wiphy_name - get wiphy name
1684 *
1685 * @wiphy: The wiphy whose name to return
1686 */
e1db74fc 1687static inline const char *wiphy_name(const struct wiphy *wiphy)
d3236553
JB
1688{
1689 return dev_name(&wiphy->dev);
1690}
1691
1692/**
1693 * wiphy_new - create a new wiphy for use with cfg80211
1694 *
1695 * @ops: The configuration operations for this device
1696 * @sizeof_priv: The size of the private area to allocate
1697 *
1698 * Create a new wiphy and associate the given operations with it.
1699 * @sizeof_priv bytes are allocated for private use.
1700 *
1701 * The returned pointer must be assigned to each netdev's
1702 * ieee80211_ptr for proper operation.
1703 */
3dcf670b 1704struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
d3236553
JB
1705
1706/**
1707 * wiphy_register - register a wiphy with cfg80211
1708 *
1709 * @wiphy: The wiphy to register.
1710 *
1711 * Returns a non-negative wiphy index or a negative error code.
1712 */
1713extern int wiphy_register(struct wiphy *wiphy);
1714
1715/**
1716 * wiphy_unregister - deregister a wiphy from cfg80211
1717 *
1718 * @wiphy: The wiphy to unregister.
1719 *
1720 * After this call, no more requests can be made with this priv
1721 * pointer, but the call may sleep to wait for an outstanding
1722 * request that is being handled.
1723 */
1724extern void wiphy_unregister(struct wiphy *wiphy);
1725
1726/**
1727 * wiphy_free - free wiphy
1728 *
1729 * @wiphy: The wiphy to free
1730 */
1731extern void wiphy_free(struct wiphy *wiphy);
1732
fffd0934 1733/* internal structs */
6829c878 1734struct cfg80211_conn;
19957bb3 1735struct cfg80211_internal_bss;
fffd0934 1736struct cfg80211_cached_keys;
19957bb3
JB
1737
1738#define MAX_AUTH_BSSES 4
6829c878 1739
d3236553
JB
1740/**
1741 * struct wireless_dev - wireless per-netdev state
1742 *
1743 * This structure must be allocated by the driver/stack
1744 * that uses the ieee80211_ptr field in struct net_device
1745 * (this is intentional so it can be allocated along with
1746 * the netdev.)
1747 *
1748 * @wiphy: pointer to hardware description
1749 * @iftype: interface type
1750 * @list: (private) Used to collect the interfaces
1751 * @netdev: (private) Used to reference back to the netdev
1752 * @current_bss: (private) Used by the internal configuration code
f444de05
JB
1753 * @channel: (private) Used by the internal configuration code to track
1754 * user-set AP, monitor and WDS channels for wireless extensions
d3236553
JB
1755 * @bssid: (private) Used by the internal configuration code
1756 * @ssid: (private) Used by the internal configuration code
1757 * @ssid_len: (private) Used by the internal configuration code
29cbe68c
JB
1758 * @mesh_id_len: (private) Used by the internal configuration code
1759 * @mesh_id_up_len: (private) Used by the internal configuration code
d3236553 1760 * @wext: (private) Used by the internal wireless extensions compat code
9bc383de
JB
1761 * @use_4addr: indicates 4addr mode is used on this interface, must be
1762 * set by driver (if supported) on add_interface BEFORE registering the
1763 * netdev and may otherwise be used by driver read-only, will be update
1764 * by cfg80211 on change_interface
2e161f78
JB
1765 * @mgmt_registrations: list of registrations for management frames
1766 * @mgmt_registrations_lock: lock for the list
abe37c4b
JB
1767 * @mtx: mutex used to lock data in this struct
1768 * @cleanup_work: work struct used for cleanup that can't be done directly
d3236553
JB
1769 */
1770struct wireless_dev {
1771 struct wiphy *wiphy;
1772 enum nl80211_iftype iftype;
1773
667503dd 1774 /* the remainder of this struct should be private to cfg80211 */
d3236553
JB
1775 struct list_head list;
1776 struct net_device *netdev;
1777
2e161f78
JB
1778 struct list_head mgmt_registrations;
1779 spinlock_t mgmt_registrations_lock;
026331c4 1780
667503dd
JB
1781 struct mutex mtx;
1782
ad002395
JB
1783 struct work_struct cleanup_work;
1784
9bc383de
JB
1785 bool use_4addr;
1786
b23aa676 1787 /* currently used for IBSS and SME - might be rearranged later */
d3236553 1788 u8 ssid[IEEE80211_MAX_SSID_LEN];
29cbe68c 1789 u8 ssid_len, mesh_id_len, mesh_id_up_len;
b23aa676
SO
1790 enum {
1791 CFG80211_SME_IDLE,
6829c878 1792 CFG80211_SME_CONNECTING,
b23aa676
SO
1793 CFG80211_SME_CONNECTED,
1794 } sme_state;
6829c878 1795 struct cfg80211_conn *conn;
fffd0934 1796 struct cfg80211_cached_keys *connect_keys;
d3236553 1797
667503dd
JB
1798 struct list_head event_list;
1799 spinlock_t event_lock;
1800
19957bb3
JB
1801 struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
1802 struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
1803 struct cfg80211_internal_bss *current_bss; /* associated / joined */
f444de05 1804 struct ieee80211_channel *channel;
19957bb3 1805
ffb9eb3d
KV
1806 bool ps;
1807 int ps_timeout;
1808
3d23e349 1809#ifdef CONFIG_CFG80211_WEXT
d3236553 1810 /* wext data */
cbe8fa9c 1811 struct {
c238c8ac
JB
1812 struct cfg80211_ibss_params ibss;
1813 struct cfg80211_connect_params connect;
fffd0934 1814 struct cfg80211_cached_keys *keys;
f2129354
JB
1815 u8 *ie;
1816 size_t ie_len;
f401a6f7 1817 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
f2129354 1818 u8 ssid[IEEE80211_MAX_SSID_LEN];
08645126 1819 s8 default_key, default_mgmt_key;
ffb9eb3d 1820 bool prev_bssid_valid;
cbe8fa9c 1821 } wext;
d3236553
JB
1822#endif
1823};
1824
1825/**
1826 * wdev_priv - return wiphy priv from wireless_dev
1827 *
1828 * @wdev: The wireless device whose wiphy's priv pointer to return
1829 */
1830static inline void *wdev_priv(struct wireless_dev *wdev)
1831{
1832 BUG_ON(!wdev);
1833 return wiphy_priv(wdev->wiphy);
1834}
1835
d70e9693
JB
1836/**
1837 * DOC: Utility functions
1838 *
1839 * cfg80211 offers a number of utility functions that can be useful.
d3236553
JB
1840 */
1841
1842/**
1843 * ieee80211_channel_to_frequency - convert channel number to frequency
abe37c4b 1844 * @chan: channel number
59eb21a6 1845 * @band: band, necessary due to channel number overlap
d3236553 1846 */
59eb21a6 1847extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
d3236553
JB
1848
1849/**
1850 * ieee80211_frequency_to_channel - convert frequency to channel number
abe37c4b 1851 * @freq: center frequency
d3236553
JB
1852 */
1853extern int ieee80211_frequency_to_channel(int freq);
1854
1855/*
1856 * Name indirection necessary because the ieee80211 code also has
1857 * a function named "ieee80211_get_channel", so if you include
1858 * cfg80211's header file you get cfg80211's version, if you try
1859 * to include both header files you'll (rightfully!) get a symbol
1860 * clash.
1861 */
1862extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1863 int freq);
1864/**
1865 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
abe37c4b
JB
1866 * @wiphy: the struct wiphy to get the channel for
1867 * @freq: the center frequency of the channel
d3236553
JB
1868 */
1869static inline struct ieee80211_channel *
1870ieee80211_get_channel(struct wiphy *wiphy, int freq)
1871{
1872 return __ieee80211_get_channel(wiphy, freq);
1873}
1874
1875/**
1876 * ieee80211_get_response_rate - get basic rate for a given rate
1877 *
1878 * @sband: the band to look for rates in
1879 * @basic_rates: bitmap of basic rates
1880 * @bitrate: the bitrate for which to find the basic rate
1881 *
1882 * This function returns the basic rate corresponding to a given
1883 * bitrate, that is the next lower bitrate contained in the basic
1884 * rate map, which is, for this function, given as a bitmap of
1885 * indices of rates in the band's bitrate table.
1886 */
1887struct ieee80211_rate *
1888ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1889 u32 basic_rates, int bitrate);
1890
1891/*
1892 * Radiotap parsing functions -- for controlled injection support
1893 *
1894 * Implemented in net/wireless/radiotap.c
1895 * Documentation in Documentation/networking/radiotap-headers.txt
1896 */
1897
33e5a2f7
JB
1898struct radiotap_align_size {
1899 uint8_t align:4, size:4;
1900};
1901
1902struct ieee80211_radiotap_namespace {
1903 const struct radiotap_align_size *align_size;
1904 int n_bits;
1905 uint32_t oui;
1906 uint8_t subns;
1907};
1908
1909struct ieee80211_radiotap_vendor_namespaces {
1910 const struct ieee80211_radiotap_namespace *ns;
1911 int n_ns;
1912};
1913
d3236553
JB
1914/**
1915 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
33e5a2f7
JB
1916 * @this_arg_index: index of current arg, valid after each successful call
1917 * to ieee80211_radiotap_iterator_next()
1918 * @this_arg: pointer to current radiotap arg; it is valid after each
1919 * call to ieee80211_radiotap_iterator_next() but also after
1920 * ieee80211_radiotap_iterator_init() where it will point to
1921 * the beginning of the actual data portion
1922 * @this_arg_size: length of the current arg, for convenience
1923 * @current_namespace: pointer to the current namespace definition
1924 * (or internally %NULL if the current namespace is unknown)
1925 * @is_radiotap_ns: indicates whether the current namespace is the default
1926 * radiotap namespace or not
1927 *
33e5a2f7
JB
1928 * @_rtheader: pointer to the radiotap header we are walking through
1929 * @_max_length: length of radiotap header in cpu byte ordering
1930 * @_arg_index: next argument index
1931 * @_arg: next argument pointer
1932 * @_next_bitmap: internal pointer to next present u32
1933 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1934 * @_vns: vendor namespace definitions
1935 * @_next_ns_data: beginning of the next namespace's data
1936 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
1937 * next bitmap word
1938 *
1939 * Describes the radiotap parser state. Fields prefixed with an underscore
1940 * must not be used by users of the parser, only by the parser internally.
d3236553
JB
1941 */
1942
1943struct ieee80211_radiotap_iterator {
33e5a2f7
JB
1944 struct ieee80211_radiotap_header *_rtheader;
1945 const struct ieee80211_radiotap_vendor_namespaces *_vns;
1946 const struct ieee80211_radiotap_namespace *current_namespace;
1947
1948 unsigned char *_arg, *_next_ns_data;
67272440 1949 __le32 *_next_bitmap;
33e5a2f7
JB
1950
1951 unsigned char *this_arg;
d3236553 1952 int this_arg_index;
33e5a2f7 1953 int this_arg_size;
d3236553 1954
33e5a2f7
JB
1955 int is_radiotap_ns;
1956
1957 int _max_length;
1958 int _arg_index;
1959 uint32_t _bitmap_shifter;
1960 int _reset_on_ext;
d3236553
JB
1961};
1962
1963extern int ieee80211_radiotap_iterator_init(
33e5a2f7
JB
1964 struct ieee80211_radiotap_iterator *iterator,
1965 struct ieee80211_radiotap_header *radiotap_header,
1966 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
d3236553
JB
1967
1968extern int ieee80211_radiotap_iterator_next(
33e5a2f7
JB
1969 struct ieee80211_radiotap_iterator *iterator);
1970
d3236553 1971
e31a16d6
ZY
1972extern const unsigned char rfc1042_header[6];
1973extern const unsigned char bridge_tunnel_header[6];
1974
1975/**
1976 * ieee80211_get_hdrlen_from_skb - get header length from data
1977 *
1978 * Given an skb with a raw 802.11 header at the data pointer this function
1979 * returns the 802.11 header length in bytes (not including encryption
1980 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1981 * header the function returns 0.
1982 *
1983 * @skb: the frame
1984 */
1985unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1986
1987/**
1988 * ieee80211_hdrlen - get header length in bytes from frame control
1989 * @fc: frame control field in little-endian format
1990 */
633adf1a 1991unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
e31a16d6 1992
d70e9693
JB
1993/**
1994 * DOC: Data path helpers
1995 *
1996 * In addition to generic utilities, cfg80211 also offers
1997 * functions that help implement the data path for devices
1998 * that do not do the 802.11/802.3 conversion on the device.
1999 */
2000
e31a16d6
ZY
2001/**
2002 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2003 * @skb: the 802.11 data frame
2004 * @addr: the device MAC address
2005 * @iftype: the virtual interface type
2006 */
eaf85ca7 2007int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
e31a16d6
ZY
2008 enum nl80211_iftype iftype);
2009
2010/**
2011 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2012 * @skb: the 802.3 frame
2013 * @addr: the device MAC address
2014 * @iftype: the virtual interface type
2015 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2016 * @qos: build 802.11 QoS data frame
2017 */
eaf85ca7 2018int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
e31a16d6
ZY
2019 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2020
eaf85ca7
ZY
2021/**
2022 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2023 *
2024 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2025 * 802.3 frames. The @list will be empty if the decode fails. The
2026 * @skb is consumed after the function returns.
2027 *
2028 * @skb: The input IEEE 802.11n A-MSDU frame.
2029 * @list: The output list of 802.3 frames. It must be allocated and
2030 * initialized by by the caller.
2031 * @addr: The device MAC address.
2032 * @iftype: The device interface type.
2033 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2034 */
2035void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2036 const u8 *addr, enum nl80211_iftype iftype,
2037 const unsigned int extra_headroom);
2038
e31a16d6
ZY
2039/**
2040 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2041 * @skb: the data frame
2042 */
2043unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2044
c21dbf92
JB
2045/**
2046 * cfg80211_find_ie - find information element in data
2047 *
2048 * @eid: element ID
2049 * @ies: data consisting of IEs
2050 * @len: length of data
2051 *
2052 * This function will return %NULL if the element ID could
2053 * not be found or if the element is invalid (claims to be
2054 * longer than the given data), or a pointer to the first byte
2055 * of the requested element, that is the byte containing the
2056 * element ID. There are no checks on the element length
2057 * other than having to fit into the given data.
2058 */
2059const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2060
d70e9693
JB
2061/**
2062 * DOC: Regulatory enforcement infrastructure
2063 *
2064 * TODO
d3236553
JB
2065 */
2066
2067/**
2068 * regulatory_hint - driver hint to the wireless core a regulatory domain
2069 * @wiphy: the wireless device giving the hint (used only for reporting
2070 * conflicts)
2071 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2072 * should be in. If @rd is set this should be NULL. Note that if you
2073 * set this to NULL you should still set rd->alpha2 to some accepted
2074 * alpha2.
2075 *
2076 * Wireless drivers can use this function to hint to the wireless core
2077 * what it believes should be the current regulatory domain by
2078 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2079 * domain should be in or by providing a completely build regulatory domain.
2080 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2081 * for a regulatory domain structure for the respective country.
2082 *
2083 * The wiphy must have been registered to cfg80211 prior to this call.
2084 * For cfg80211 drivers this means you must first use wiphy_register(),
2085 * for mac80211 drivers you must first use ieee80211_register_hw().
2086 *
2087 * Drivers should check the return value, its possible you can get
2088 * an -ENOMEM.
2089 */
2090extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2091
d3236553
JB
2092/**
2093 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2094 * @wiphy: the wireless device we want to process the regulatory domain on
2095 * @regd: the custom regulatory domain to use for this wiphy
2096 *
2097 * Drivers can sometimes have custom regulatory domains which do not apply
2098 * to a specific country. Drivers can use this to apply such custom regulatory
2099 * domains. This routine must be called prior to wiphy registration. The
2100 * custom regulatory domain will be trusted completely and as such previous
2101 * default channel settings will be disregarded. If no rule is found for a
2102 * channel on the regulatory domain the channel will be disabled.
2103 */
2104extern void wiphy_apply_custom_regulatory(
2105 struct wiphy *wiphy,
2106 const struct ieee80211_regdomain *regd);
2107
2108/**
2109 * freq_reg_info - get regulatory information for the given frequency
2110 * @wiphy: the wiphy for which we want to process this rule for
2111 * @center_freq: Frequency in KHz for which we want regulatory information for
038659e7
LR
2112 * @desired_bw_khz: the desired max bandwidth you want to use per
2113 * channel. Note that this is still 20 MHz if you want to use HT40
2114 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2115 * If set to 0 we'll assume you want the standard 20 MHz.
d3236553
JB
2116 * @reg_rule: the regulatory rule which we have for this frequency
2117 *
2118 * Use this function to get the regulatory rule for a specific frequency on
2119 * a given wireless device. If the device has a specific regulatory domain
2120 * it wants to follow we respect that unless a country IE has been received
2121 * and processed already.
2122 *
2123 * Returns 0 if it was able to find a valid regulatory rule which does
2124 * apply to the given center_freq otherwise it returns non-zero. It will
2125 * also return -ERANGE if we determine the given center_freq does not even have
2126 * a regulatory rule for a frequency range in the center_freq's band. See
2127 * freq_in_rule_band() for our current definition of a band -- this is purely
2128 * subjective and right now its 802.11 specific.
2129 */
038659e7
LR
2130extern int freq_reg_info(struct wiphy *wiphy,
2131 u32 center_freq,
2132 u32 desired_bw_khz,
d3236553
JB
2133 const struct ieee80211_reg_rule **reg_rule);
2134
2135/*
2136 * Temporary wext handlers & helper functions
2137 *
2138 * In the future cfg80211 will simply assign the entire wext handler
2139 * structure to netdevs it manages, but we're not there yet.
2140 */
fee52678
JB
2141int cfg80211_wext_giwname(struct net_device *dev,
2142 struct iw_request_info *info,
2143 char *name, char *extra);
e60c7744
JB
2144int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
2145 u32 *mode, char *extra);
2146int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
2147 u32 *mode, char *extra);
2a519311
JB
2148int cfg80211_wext_siwscan(struct net_device *dev,
2149 struct iw_request_info *info,
2150 union iwreq_data *wrqu, char *extra);
2151int cfg80211_wext_giwscan(struct net_device *dev,
2152 struct iw_request_info *info,
2153 struct iw_point *data, char *extra);
691597cb
JB
2154int cfg80211_wext_siwmlme(struct net_device *dev,
2155 struct iw_request_info *info,
2156 struct iw_point *data, char *extra);
4aa188e1
JB
2157int cfg80211_wext_giwrange(struct net_device *dev,
2158 struct iw_request_info *info,
2159 struct iw_point *data, char *extra);
f2129354
JB
2160int cfg80211_wext_siwgenie(struct net_device *dev,
2161 struct iw_request_info *info,
2162 struct iw_point *data, char *extra);
2163int cfg80211_wext_siwauth(struct net_device *dev,
2164 struct iw_request_info *info,
2165 struct iw_param *data, char *extra);
2166int cfg80211_wext_giwauth(struct net_device *dev,
2167 struct iw_request_info *info,
2168 struct iw_param *data, char *extra);
2169
0e82ffe3
JB
2170int cfg80211_wext_siwfreq(struct net_device *dev,
2171 struct iw_request_info *info,
2172 struct iw_freq *freq, char *extra);
2173int cfg80211_wext_giwfreq(struct net_device *dev,
2174 struct iw_request_info *info,
2175 struct iw_freq *freq, char *extra);
1f9298f9
JB
2176int cfg80211_wext_siwessid(struct net_device *dev,
2177 struct iw_request_info *info,
2178 struct iw_point *data, char *ssid);
2179int cfg80211_wext_giwessid(struct net_device *dev,
2180 struct iw_request_info *info,
2181 struct iw_point *data, char *ssid);
9930380f
JB
2182int cfg80211_wext_siwrate(struct net_device *dev,
2183 struct iw_request_info *info,
2184 struct iw_param *rate, char *extra);
2185int cfg80211_wext_giwrate(struct net_device *dev,
2186 struct iw_request_info *info,
2187 struct iw_param *rate, char *extra);
2188
b9a5f8ca
JM
2189int cfg80211_wext_siwrts(struct net_device *dev,
2190 struct iw_request_info *info,
2191 struct iw_param *rts, char *extra);
2192int cfg80211_wext_giwrts(struct net_device *dev,
2193 struct iw_request_info *info,
2194 struct iw_param *rts, char *extra);
2195int cfg80211_wext_siwfrag(struct net_device *dev,
2196 struct iw_request_info *info,
2197 struct iw_param *frag, char *extra);
2198int cfg80211_wext_giwfrag(struct net_device *dev,
2199 struct iw_request_info *info,
2200 struct iw_param *frag, char *extra);
2201int cfg80211_wext_siwretry(struct net_device *dev,
2202 struct iw_request_info *info,
2203 struct iw_param *retry, char *extra);
2204int cfg80211_wext_giwretry(struct net_device *dev,
2205 struct iw_request_info *info,
2206 struct iw_param *retry, char *extra);
08645126
JB
2207int cfg80211_wext_siwencodeext(struct net_device *dev,
2208 struct iw_request_info *info,
2209 struct iw_point *erq, char *extra);
2210int cfg80211_wext_siwencode(struct net_device *dev,
2211 struct iw_request_info *info,
2212 struct iw_point *erq, char *keybuf);
2213int cfg80211_wext_giwencode(struct net_device *dev,
2214 struct iw_request_info *info,
2215 struct iw_point *erq, char *keybuf);
7643a2c3
JB
2216int cfg80211_wext_siwtxpower(struct net_device *dev,
2217 struct iw_request_info *info,
2218 union iwreq_data *data, char *keybuf);
2219int cfg80211_wext_giwtxpower(struct net_device *dev,
2220 struct iw_request_info *info,
2221 union iwreq_data *data, char *keybuf);
8990646d 2222struct iw_statistics *cfg80211_wireless_stats(struct net_device *dev);
b9a5f8ca 2223
bc92afd9
JB
2224int cfg80211_wext_siwpower(struct net_device *dev,
2225 struct iw_request_info *info,
2226 struct iw_param *wrq, char *extra);
2227int cfg80211_wext_giwpower(struct net_device *dev,
2228 struct iw_request_info *info,
2229 struct iw_param *wrq, char *extra);
2230
562e4822
JB
2231int cfg80211_wext_siwap(struct net_device *dev,
2232 struct iw_request_info *info,
2233 struct sockaddr *ap_addr, char *extra);
2234int cfg80211_wext_giwap(struct net_device *dev,
2235 struct iw_request_info *info,
2236 struct sockaddr *ap_addr, char *extra);
ab737a4f 2237
c28991a0
JL
2238int cfg80211_wext_siwpmksa(struct net_device *dev,
2239 struct iw_request_info *info,
2240 struct iw_point *data, char *extra);
2241
d3236553
JB
2242/*
2243 * callbacks for asynchronous cfg80211 methods, notification
2244 * functions and BSS handling helpers
2245 */
2246
2a519311
JB
2247/**
2248 * cfg80211_scan_done - notify that scan finished
2249 *
2250 * @request: the corresponding scan request
2251 * @aborted: set to true if the scan was aborted for any reason,
2252 * userspace will be notified of that
2253 */
2254void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2255
2256/**
abe37c4b 2257 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2a519311
JB
2258 *
2259 * @wiphy: the wiphy reporting the BSS
abe37c4b
JB
2260 * @channel: The channel the frame was received on
2261 * @mgmt: the management frame (probe response or beacon)
2262 * @len: length of the management frame
77965c97 2263 * @signal: the signal strength, type depends on the wiphy's signal_type
2a519311
JB
2264 * @gfp: context flags
2265 *
2266 * This informs cfg80211 that BSS information was found and
2267 * the BSS should be updated/added.
2268 */
2269struct cfg80211_bss*
2270cfg80211_inform_bss_frame(struct wiphy *wiphy,
2271 struct ieee80211_channel *channel,
2272 struct ieee80211_mgmt *mgmt, size_t len,
77965c97 2273 s32 signal, gfp_t gfp);
2a519311 2274
abe37c4b
JB
2275/**
2276 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2277 *
2278 * @wiphy: the wiphy reporting the BSS
2279 * @channel: The channel the frame was received on
2280 * @bssid: the BSSID of the BSS
2281 * @timestamp: the TSF timestamp sent by the peer
2282 * @capability: the capability field sent by the peer
2283 * @beacon_interval: the beacon interval announced by the peer
2284 * @ie: additional IEs sent by the peer
2285 * @ielen: length of the additional IEs
2286 * @signal: the signal strength, type depends on the wiphy's signal_type
2287 * @gfp: context flags
2288 *
2289 * This informs cfg80211 that BSS information was found and
2290 * the BSS should be updated/added.
2291 */
06aa7afa
JK
2292struct cfg80211_bss*
2293cfg80211_inform_bss(struct wiphy *wiphy,
2294 struct ieee80211_channel *channel,
2295 const u8 *bssid,
2296 u64 timestamp, u16 capability, u16 beacon_interval,
2297 const u8 *ie, size_t ielen,
2298 s32 signal, gfp_t gfp);
2299
2a519311
JB
2300struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2301 struct ieee80211_channel *channel,
2302 const u8 *bssid,
79420f09
JB
2303 const u8 *ssid, size_t ssid_len,
2304 u16 capa_mask, u16 capa_val);
2305static inline struct cfg80211_bss *
2306cfg80211_get_ibss(struct wiphy *wiphy,
2307 struct ieee80211_channel *channel,
2308 const u8 *ssid, size_t ssid_len)
2309{
2310 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2311 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2312}
2313
2a519311
JB
2314struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2315 struct ieee80211_channel *channel,
2316 const u8 *meshid, size_t meshidlen,
2317 const u8 *meshcfg);
2318void cfg80211_put_bss(struct cfg80211_bss *bss);
d3236553 2319
d491af19
JB
2320/**
2321 * cfg80211_unlink_bss - unlink BSS from internal data structures
2322 * @wiphy: the wiphy
2323 * @bss: the bss to remove
2324 *
2325 * This function removes the given BSS from the internal data structures
2326 * thereby making it no longer show up in scan results etc. Use this
2327 * function when you detect a BSS is gone. Normally BSSes will also time
2328 * out, so it is not necessary to use this function at all.
2329 */
2330void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
fee52678 2331
6039f6d2
JM
2332/**
2333 * cfg80211_send_rx_auth - notification of processed authentication
2334 * @dev: network device
2335 * @buf: authentication frame (header + body)
2336 * @len: length of the frame data
2337 *
2338 * This function is called whenever an authentication has been processed in
1965c853
JM
2339 * station mode. The driver is required to call either this function or
2340 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
cb0b4beb 2341 * call. This function may sleep.
6039f6d2 2342 */
cb0b4beb 2343void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
6039f6d2 2344
1965c853
JM
2345/**
2346 * cfg80211_send_auth_timeout - notification of timed out authentication
2347 * @dev: network device
2348 * @addr: The MAC address of the device with which the authentication timed out
cb0b4beb
JB
2349 *
2350 * This function may sleep.
1965c853 2351 */
cb0b4beb 2352void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
1965c853 2353
a58ce43f
JB
2354/**
2355 * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
2356 * @dev: network device
2357 * @addr: The MAC address of the device with which the authentication timed out
2358 *
2359 * When a pending authentication had no action yet, the driver may decide
2360 * to not send a deauth frame, but in that case must calls this function
2361 * to tell cfg80211 about this decision. It is only valid to call this
2362 * function within the deauth() callback.
2363 */
2364void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
2365
6039f6d2
JM
2366/**
2367 * cfg80211_send_rx_assoc - notification of processed association
2368 * @dev: network device
2369 * @buf: (re)association response frame (header + body)
2370 * @len: length of the frame data
2371 *
2372 * This function is called whenever a (re)association response has been
1965c853
JM
2373 * processed in station mode. The driver is required to call either this
2374 * function or cfg80211_send_assoc_timeout() to indicate the result of
cb0b4beb 2375 * cfg80211_ops::assoc() call. This function may sleep.
6039f6d2 2376 */
cb0b4beb 2377void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
6039f6d2 2378
1965c853
JM
2379/**
2380 * cfg80211_send_assoc_timeout - notification of timed out association
2381 * @dev: network device
2382 * @addr: The MAC address of the device with which the association timed out
cb0b4beb
JB
2383 *
2384 * This function may sleep.
1965c853 2385 */
cb0b4beb 2386void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
1965c853 2387
6039f6d2 2388/**
53b46b84 2389 * cfg80211_send_deauth - notification of processed deauthentication
6039f6d2
JM
2390 * @dev: network device
2391 * @buf: deauthentication frame (header + body)
2392 * @len: length of the frame data
2393 *
2394 * This function is called whenever deauthentication has been processed in
53b46b84 2395 * station mode. This includes both received deauthentication frames and
cb0b4beb 2396 * locally generated ones. This function may sleep.
6039f6d2 2397 */
ce470613
HS
2398void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2399
2400/**
2401 * __cfg80211_send_deauth - notification of processed deauthentication
2402 * @dev: network device
2403 * @buf: deauthentication frame (header + body)
2404 * @len: length of the frame data
2405 *
2406 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2407 */
2408void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
6039f6d2
JM
2409
2410/**
53b46b84 2411 * cfg80211_send_disassoc - notification of processed disassociation
6039f6d2
JM
2412 * @dev: network device
2413 * @buf: disassociation response frame (header + body)
2414 * @len: length of the frame data
2415 *
2416 * This function is called whenever disassociation has been processed in
53b46b84 2417 * station mode. This includes both received disassociation frames and locally
cb0b4beb 2418 * generated ones. This function may sleep.
6039f6d2 2419 */
ce470613
HS
2420void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2421
2422/**
2423 * __cfg80211_send_disassoc - notification of processed disassociation
2424 * @dev: network device
2425 * @buf: disassociation response frame (header + body)
2426 * @len: length of the frame data
2427 *
2428 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2429 */
2430void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2431 size_t len);
6039f6d2 2432
cf4e594e
JM
2433/**
2434 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2435 * @dev: network device
2436 * @buf: deauthentication frame (header + body)
2437 * @len: length of the frame data
2438 *
2439 * This function is called whenever a received Deauthentication frame has been
2440 * dropped in station mode because of MFP being used but the Deauthentication
2441 * frame was not protected. This function may sleep.
2442 */
2443void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
2444 size_t len);
2445
2446/**
2447 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2448 * @dev: network device
2449 * @buf: disassociation frame (header + body)
2450 * @len: length of the frame data
2451 *
2452 * This function is called whenever a received Disassociation frame has been
2453 * dropped in station mode because of MFP being used but the Disassociation
2454 * frame was not protected. This function may sleep.
2455 */
2456void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
2457 size_t len);
2458
a3b8b056
JM
2459/**
2460 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2461 * @dev: network device
2462 * @addr: The source MAC address of the frame
2463 * @key_type: The key type that the received frame used
2464 * @key_id: Key identifier (0..3)
2465 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
e6d6e342 2466 * @gfp: allocation flags
a3b8b056
JM
2467 *
2468 * This function is called whenever the local MAC detects a MIC failure in a
2469 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2470 * primitive.
2471 */
2472void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2473 enum nl80211_key_type key_type, int key_id,
e6d6e342 2474 const u8 *tsc, gfp_t gfp);
a3b8b056 2475
04a773ad
JB
2476/**
2477 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2478 *
2479 * @dev: network device
2480 * @bssid: the BSSID of the IBSS joined
2481 * @gfp: allocation flags
2482 *
2483 * This function notifies cfg80211 that the device joined an IBSS or
2484 * switched to a different BSSID. Before this function can be called,
2485 * either a beacon has to have been received from the IBSS, or one of
2486 * the cfg80211_inform_bss{,_frame} functions must have been called
2487 * with the locally generated beacon -- this guarantees that there is
2488 * always a scan result for this IBSS. cfg80211 will handle the rest.
2489 */
2490void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2491
c93b5e71
JC
2492/**
2493 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
2494 *
2495 * @dev: network device
2496 * @macaddr: the MAC address of the new candidate
2497 * @ie: information elements advertised by the peer candidate
2498 * @ie_len: lenght of the information elements buffer
2499 * @gfp: allocation flags
2500 *
2501 * This function notifies cfg80211 that the mesh peer candidate has been
2502 * detected, most likely via a beacon or, less likely, via a probe response.
2503 * cfg80211 then sends a notification to userspace.
2504 */
2505void cfg80211_notify_new_peer_candidate(struct net_device *dev,
2506 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
2507
d70e9693
JB
2508/**
2509 * DOC: RFkill integration
2510 *
2511 * RFkill integration in cfg80211 is almost invisible to drivers,
2512 * as cfg80211 automatically registers an rfkill instance for each
2513 * wireless device it knows about. Soft kill is also translated
2514 * into disconnecting and turning all interfaces off, drivers are
2515 * expected to turn off the device when all interfaces are down.
2516 *
2517 * However, devices may have a hard RFkill line, in which case they
2518 * also need to interact with the rfkill subsystem, via cfg80211.
2519 * They can do this with a few helper functions documented here.
2520 */
2521
1f87f7d3
JB
2522/**
2523 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2524 * @wiphy: the wiphy
2525 * @blocked: block status
2526 */
2527void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2528
2529/**
2530 * wiphy_rfkill_start_polling - start polling rfkill
2531 * @wiphy: the wiphy
2532 */
2533void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2534
2535/**
2536 * wiphy_rfkill_stop_polling - stop polling rfkill
2537 * @wiphy: the wiphy
2538 */
2539void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2540
aff89a9b 2541#ifdef CONFIG_NL80211_TESTMODE
d70e9693
JB
2542/**
2543 * DOC: Test mode
2544 *
2545 * Test mode is a set of utility functions to allow drivers to
2546 * interact with driver-specific tools to aid, for instance,
2547 * factory programming.
2548 *
2549 * This chapter describes how drivers interact with it, for more
2550 * information see the nl80211 book's chapter on it.
2551 */
2552
aff89a9b
JB
2553/**
2554 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2555 * @wiphy: the wiphy
2556 * @approxlen: an upper bound of the length of the data that will
2557 * be put into the skb
2558 *
2559 * This function allocates and pre-fills an skb for a reply to
2560 * the testmode command. Since it is intended for a reply, calling
2561 * it outside of the @testmode_cmd operation is invalid.
2562 *
2563 * The returned skb (or %NULL if any errors happen) is pre-filled
2564 * with the wiphy index and set up in a way that any data that is
2565 * put into the skb (with skb_put(), nla_put() or similar) will end
2566 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2567 * needs to be done with the skb is adding data for the corresponding
2568 * userspace tool which can then read that data out of the testdata
2569 * attribute. You must not modify the skb in any other way.
2570 *
2571 * When done, call cfg80211_testmode_reply() with the skb and return
2572 * its error code as the result of the @testmode_cmd operation.
2573 */
2574struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
2575 int approxlen);
2576
2577/**
2578 * cfg80211_testmode_reply - send the reply skb
2579 * @skb: The skb, must have been allocated with
2580 * cfg80211_testmode_alloc_reply_skb()
2581 *
2582 * Returns an error code or 0 on success, since calling this
2583 * function will usually be the last thing before returning
2584 * from the @testmode_cmd you should return the error code.
2585 * Note that this function consumes the skb regardless of the
2586 * return value.
2587 */
2588int cfg80211_testmode_reply(struct sk_buff *skb);
2589
2590/**
2591 * cfg80211_testmode_alloc_event_skb - allocate testmode event
2592 * @wiphy: the wiphy
2593 * @approxlen: an upper bound of the length of the data that will
2594 * be put into the skb
2595 * @gfp: allocation flags
2596 *
2597 * This function allocates and pre-fills an skb for an event on the
2598 * testmode multicast group.
2599 *
2600 * The returned skb (or %NULL if any errors happen) is set up in the
2601 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2602 * for an event. As there, you should simply add data to it that will
2603 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2604 * not modify the skb in any other way.
2605 *
2606 * When done filling the skb, call cfg80211_testmode_event() with the
2607 * skb to send the event.
2608 */
2609struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
2610 int approxlen, gfp_t gfp);
2611
2612/**
2613 * cfg80211_testmode_event - send the event
2614 * @skb: The skb, must have been allocated with
2615 * cfg80211_testmode_alloc_event_skb()
2616 * @gfp: allocation flags
2617 *
2618 * This function sends the given @skb, which must have been allocated
2619 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
2620 * consumes it.
2621 */
2622void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
2623
2624#define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
2625#else
2626#define CFG80211_TESTMODE_CMD(cmd)
2627#endif
2628
b23aa676
SO
2629/**
2630 * cfg80211_connect_result - notify cfg80211 of connection result
2631 *
2632 * @dev: network device
2633 * @bssid: the BSSID of the AP
2634 * @req_ie: association request IEs (maybe be %NULL)
2635 * @req_ie_len: association request IEs length
2636 * @resp_ie: association response IEs (may be %NULL)
2637 * @resp_ie_len: assoc response IEs length
2638 * @status: status code, 0 for successful connection, use
2639 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
2640 * the real status code for failures.
2641 * @gfp: allocation flags
2642 *
2643 * It should be called by the underlying driver whenever connect() has
2644 * succeeded.
2645 */
2646void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
2647 const u8 *req_ie, size_t req_ie_len,
2648 const u8 *resp_ie, size_t resp_ie_len,
2649 u16 status, gfp_t gfp);
2650
2651/**
2652 * cfg80211_roamed - notify cfg80211 of roaming
2653 *
2654 * @dev: network device
2655 * @bssid: the BSSID of the new AP
2656 * @req_ie: association request IEs (maybe be %NULL)
2657 * @req_ie_len: association request IEs length
2658 * @resp_ie: association response IEs (may be %NULL)
2659 * @resp_ie_len: assoc response IEs length
2660 * @gfp: allocation flags
2661 *
2662 * It should be called by the underlying driver whenever it roamed
2663 * from one AP to another while connected.
2664 */
2665void cfg80211_roamed(struct net_device *dev, const u8 *bssid,
2666 const u8 *req_ie, size_t req_ie_len,
2667 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
2668
2669/**
2670 * cfg80211_disconnected - notify cfg80211 that connection was dropped
2671 *
2672 * @dev: network device
2673 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
2674 * @ie_len: length of IEs
2675 * @reason: reason code for the disconnection, set it to 0 if unknown
2676 * @gfp: allocation flags
2677 *
2678 * After it calls this function, the driver should enter an idle state
2679 * and not try to connect to any AP any more.
2680 */
2681void cfg80211_disconnected(struct net_device *dev, u16 reason,
2682 u8 *ie, size_t ie_len, gfp_t gfp);
2683
9588bbd5
JM
2684/**
2685 * cfg80211_ready_on_channel - notification of remain_on_channel start
2686 * @dev: network device
2687 * @cookie: the request cookie
2688 * @chan: The current channel (from remain_on_channel request)
2689 * @channel_type: Channel type
2690 * @duration: Duration in milliseconds that the driver intents to remain on the
2691 * channel
2692 * @gfp: allocation flags
2693 */
2694void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
2695 struct ieee80211_channel *chan,
2696 enum nl80211_channel_type channel_type,
2697 unsigned int duration, gfp_t gfp);
2698
2699/**
2700 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
2701 * @dev: network device
2702 * @cookie: the request cookie
2703 * @chan: The current channel (from remain_on_channel request)
2704 * @channel_type: Channel type
2705 * @gfp: allocation flags
2706 */
2707void cfg80211_remain_on_channel_expired(struct net_device *dev,
2708 u64 cookie,
2709 struct ieee80211_channel *chan,
2710 enum nl80211_channel_type channel_type,
2711 gfp_t gfp);
b23aa676 2712
98b62183
JB
2713
2714/**
2715 * cfg80211_new_sta - notify userspace about station
2716 *
2717 * @dev: the netdev
2718 * @mac_addr: the station's address
2719 * @sinfo: the station information
2720 * @gfp: allocation flags
2721 */
2722void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
2723 struct station_info *sinfo, gfp_t gfp);
2724
ec15e68b
JM
2725/**
2726 * cfg80211_del_sta - notify userspace about deletion of a station
2727 *
2728 * @dev: the netdev
2729 * @mac_addr: the station's address
2730 * @gfp: allocation flags
2731 */
2732void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
2733
026331c4 2734/**
2e161f78 2735 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
026331c4
JM
2736 * @dev: network device
2737 * @freq: Frequency on which the frame was received in MHz
2e161f78 2738 * @buf: Management frame (header + body)
026331c4
JM
2739 * @len: length of the frame data
2740 * @gfp: context flags
2e161f78
JB
2741 *
2742 * Returns %true if a user space application has registered for this frame.
2743 * For action frames, that makes it responsible for rejecting unrecognized
2744 * action frames; %false otherwise, in which case for action frames the
2745 * driver is responsible for rejecting the frame.
026331c4
JM
2746 *
2747 * This function is called whenever an Action frame is received for a station
2748 * mode interface, but is not processed in kernel.
2749 */
2e161f78
JB
2750bool cfg80211_rx_mgmt(struct net_device *dev, int freq, const u8 *buf,
2751 size_t len, gfp_t gfp);
026331c4
JM
2752
2753/**
2e161f78 2754 * cfg80211_mgmt_tx_status - notification of TX status for management frame
026331c4 2755 * @dev: network device
2e161f78
JB
2756 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
2757 * @buf: Management frame (header + body)
026331c4
JM
2758 * @len: length of the frame data
2759 * @ack: Whether frame was acknowledged
2760 * @gfp: context flags
2761 *
2e161f78
JB
2762 * This function is called whenever a management frame was requested to be
2763 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
026331c4
JM
2764 * transmission attempt.
2765 */
2e161f78
JB
2766void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
2767 const u8 *buf, size_t len, bool ack, gfp_t gfp);
026331c4 2768
d6dc1a38
JO
2769
2770/**
2771 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
2772 * @dev: network device
2773 * @rssi_event: the triggered RSSI event
2774 * @gfp: context flags
2775 *
2776 * This function is called when a configured connection quality monitoring
2777 * rssi threshold reached event occurs.
2778 */
2779void cfg80211_cqm_rssi_notify(struct net_device *dev,
2780 enum nl80211_cqm_rssi_threshold_event rssi_event,
2781 gfp_t gfp);
2782
c063dbf5
JB
2783/**
2784 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
2785 * @dev: network device
2786 * @peer: peer's MAC address
2787 * @num_packets: how many packets were lost -- should be a fixed threshold
2788 * but probably no less than maybe 50, or maybe a throughput dependent
2789 * threshold (to account for temporary interference)
2790 * @gfp: context flags
2791 */
2792void cfg80211_cqm_pktloss_notify(struct net_device *dev,
2793 const u8 *peer, u32 num_packets, gfp_t gfp);
2794
e1db74fc
JP
2795/* Logging, debugging and troubleshooting/diagnostic helpers. */
2796
2797/* wiphy_printk helpers, similar to dev_printk */
2798
2799#define wiphy_printk(level, wiphy, format, args...) \
9c376639 2800 dev_printk(level, &(wiphy)->dev, format, ##args)
e1db74fc 2801#define wiphy_emerg(wiphy, format, args...) \
9c376639 2802 dev_emerg(&(wiphy)->dev, format, ##args)
e1db74fc 2803#define wiphy_alert(wiphy, format, args...) \
9c376639 2804 dev_alert(&(wiphy)->dev, format, ##args)
e1db74fc 2805#define wiphy_crit(wiphy, format, args...) \
9c376639 2806 dev_crit(&(wiphy)->dev, format, ##args)
e1db74fc 2807#define wiphy_err(wiphy, format, args...) \
9c376639 2808 dev_err(&(wiphy)->dev, format, ##args)
e1db74fc 2809#define wiphy_warn(wiphy, format, args...) \
9c376639 2810 dev_warn(&(wiphy)->dev, format, ##args)
e1db74fc 2811#define wiphy_notice(wiphy, format, args...) \
9c376639 2812 dev_notice(&(wiphy)->dev, format, ##args)
e1db74fc 2813#define wiphy_info(wiphy, format, args...) \
9c376639 2814 dev_info(&(wiphy)->dev, format, ##args)
073730d7 2815
9c376639 2816#define wiphy_debug(wiphy, format, args...) \
e1db74fc 2817 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
9c376639 2818
e1db74fc 2819#define wiphy_dbg(wiphy, format, args...) \
9c376639 2820 dev_dbg(&(wiphy)->dev, format, ##args)
e1db74fc
JP
2821
2822#if defined(VERBOSE_DEBUG)
2823#define wiphy_vdbg wiphy_dbg
2824#else
e1db74fc
JP
2825#define wiphy_vdbg(wiphy, format, args...) \
2826({ \
2827 if (0) \
2828 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
9c376639 2829 0; \
e1db74fc
JP
2830})
2831#endif
2832
2833/*
2834 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
2835 * of using a WARN/WARN_ON to get the message out, including the
2836 * file/line information and a backtrace.
2837 */
2838#define wiphy_WARN(wiphy, format, args...) \
2839 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
2840
704232c2 2841#endif /* __NET_CFG80211_H */