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