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