wireless: Add NoAck per tid support
[linux-2.6/btrfs-unstable.git] / include / net / cfg80211.h
blob38ce452da20f6768aaa88e8968a543049cee7c96
1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
3 /*
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
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.
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/netlink.h>
17 #include <linux/skbuff.h>
18 #include <linux/nl80211.h>
19 #include <linux/if_ether.h>
20 #include <linux/ieee80211.h>
21 #include <net/regulatory.h>
23 /**
24 * DOC: Introduction
26 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
27 * userspace and drivers, and offers some utility functionality associated
28 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
29 * by all modern wireless drivers in Linux, so that they offer a consistent
30 * API through nl80211. For backward compatibility, cfg80211 also offers
31 * wireless extensions to userspace, but hides them from drivers completely.
33 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
34 * use restrictions.
38 /**
39 * DOC: Device registration
41 * In order for a driver to use cfg80211, it must register the hardware device
42 * with cfg80211. This happens through a number of hardware capability structs
43 * described below.
45 * The fundamental structure for each device is the 'wiphy', of which each
46 * instance describes a physical wireless device connected to the system. Each
47 * such wiphy can have zero, one, or many virtual interfaces associated with
48 * it, which need to be identified as such by pointing the network interface's
49 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
50 * the wireless part of the interface, normally this struct is embedded in the
51 * network interface's private data area. Drivers can optionally allow creating
52 * or destroying virtual interfaces on the fly, but without at least one or the
53 * ability to create some the wireless device isn't useful.
55 * Each wiphy structure contains device capability information, and also has
56 * a pointer to the various operations the driver offers. The definitions and
57 * structures here describe these capabilities in detail.
61 * wireless hardware capability structures
64 /**
65 * enum ieee80211_band - supported frequency bands
67 * The bands are assigned this way because the supported
68 * bitrates differ in these bands.
70 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
71 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
72 * @IEEE80211_NUM_BANDS: number of defined bands
74 enum ieee80211_band {
75 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
76 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
78 /* keep last */
79 IEEE80211_NUM_BANDS
82 /**
83 * enum ieee80211_channel_flags - channel flags
85 * Channel flags set by the regulatory control code.
87 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
88 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
89 * on this channel.
90 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
91 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
92 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
93 * is not permitted.
94 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
95 * is not permitted.
97 enum ieee80211_channel_flags {
98 IEEE80211_CHAN_DISABLED = 1<<0,
99 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
100 IEEE80211_CHAN_NO_IBSS = 1<<2,
101 IEEE80211_CHAN_RADAR = 1<<3,
102 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
103 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
106 #define IEEE80211_CHAN_NO_HT40 \
107 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
110 * struct ieee80211_channel - channel definition
112 * This structure describes a single channel for use
113 * with cfg80211.
115 * @center_freq: center frequency in MHz
116 * @hw_value: hardware-specific value for the channel
117 * @flags: channel flags from &enum ieee80211_channel_flags.
118 * @orig_flags: channel flags at registration time, used by regulatory
119 * code to support devices with additional restrictions
120 * @band: band this channel belongs to.
121 * @max_antenna_gain: maximum antenna gain in dBi
122 * @max_power: maximum transmission power (in dBm)
123 * @beacon_found: helper to regulatory code to indicate when a beacon
124 * has been found on this channel. Use regulatory_hint_found_beacon()
125 * to enable this, this is useful only on 5 GHz band.
126 * @orig_mag: internal use
127 * @orig_mpwr: internal use
129 struct ieee80211_channel {
130 enum ieee80211_band band;
131 u16 center_freq;
132 u16 hw_value;
133 u32 flags;
134 int max_antenna_gain;
135 int max_power;
136 bool beacon_found;
137 u32 orig_flags;
138 int orig_mag, orig_mpwr;
142 * enum ieee80211_rate_flags - rate flags
144 * Hardware/specification flags for rates. These are structured
145 * in a way that allows using the same bitrate structure for
146 * different bands/PHY modes.
148 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
149 * preamble on this bitrate; only relevant in 2.4GHz band and
150 * with CCK rates.
151 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
152 * when used with 802.11a (on the 5 GHz band); filled by the
153 * core code when registering the wiphy.
154 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
155 * when used with 802.11b (on the 2.4 GHz band); filled by the
156 * core code when registering the wiphy.
157 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
158 * when used with 802.11g (on the 2.4 GHz band); filled by the
159 * core code when registering the wiphy.
160 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
162 enum ieee80211_rate_flags {
163 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
164 IEEE80211_RATE_MANDATORY_A = 1<<1,
165 IEEE80211_RATE_MANDATORY_B = 1<<2,
166 IEEE80211_RATE_MANDATORY_G = 1<<3,
167 IEEE80211_RATE_ERP_G = 1<<4,
171 * struct ieee80211_rate - bitrate definition
173 * This structure describes a bitrate that an 802.11 PHY can
174 * operate with. The two values @hw_value and @hw_value_short
175 * are only for driver use when pointers to this structure are
176 * passed around.
178 * @flags: rate-specific flags
179 * @bitrate: bitrate in units of 100 Kbps
180 * @hw_value: driver/hardware value for this rate
181 * @hw_value_short: driver/hardware value for this rate when
182 * short preamble is used
184 struct ieee80211_rate {
185 u32 flags;
186 u16 bitrate;
187 u16 hw_value, hw_value_short;
191 * struct ieee80211_sta_ht_cap - STA's HT capabilities
193 * This structure describes most essential parameters needed
194 * to describe 802.11n HT capabilities for an STA.
196 * @ht_supported: is HT supported by the STA
197 * @cap: HT capabilities map as described in 802.11n spec
198 * @ampdu_factor: Maximum A-MPDU length factor
199 * @ampdu_density: Minimum A-MPDU spacing
200 * @mcs: Supported MCS rates
202 struct ieee80211_sta_ht_cap {
203 u16 cap; /* use IEEE80211_HT_CAP_ */
204 bool ht_supported;
205 u8 ampdu_factor;
206 u8 ampdu_density;
207 struct ieee80211_mcs_info mcs;
211 * struct ieee80211_supported_band - frequency band definition
213 * This structure describes a frequency band a wiphy
214 * is able to operate in.
216 * @channels: Array of channels the hardware can operate in
217 * in this band.
218 * @band: the band this structure represents
219 * @n_channels: Number of channels in @channels
220 * @bitrates: Array of bitrates the hardware can operate with
221 * in this band. Must be sorted to give a valid "supported
222 * rates" IE, i.e. CCK rates first, then OFDM.
223 * @n_bitrates: Number of bitrates in @bitrates
224 * @ht_cap: HT capabilities in this band
226 struct ieee80211_supported_band {
227 struct ieee80211_channel *channels;
228 struct ieee80211_rate *bitrates;
229 enum ieee80211_band band;
230 int n_channels;
231 int n_bitrates;
232 struct ieee80211_sta_ht_cap ht_cap;
236 * Wireless hardware/device configuration structures and methods
240 * DOC: Actions and configuration
242 * Each wireless device and each virtual interface offer a set of configuration
243 * operations and other actions that are invoked by userspace. Each of these
244 * actions is described in the operations structure, and the parameters these
245 * operations use are described separately.
247 * Additionally, some operations are asynchronous and expect to get status
248 * information via some functions that drivers need to call.
250 * Scanning and BSS list handling with its associated functionality is described
251 * in a separate chapter.
255 * struct vif_params - describes virtual interface parameters
256 * @use_4addr: use 4-address frames
258 struct vif_params {
259 int use_4addr;
263 * struct key_params - key information
265 * Information about a key
267 * @key: key material
268 * @key_len: length of key material
269 * @cipher: cipher suite selector
270 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
271 * with the get_key() callback, must be in little endian,
272 * length given by @seq_len.
273 * @seq_len: length of @seq.
275 struct key_params {
276 u8 *key;
277 u8 *seq;
278 int key_len;
279 int seq_len;
280 u32 cipher;
284 * enum survey_info_flags - survey information flags
286 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
287 * @SURVEY_INFO_IN_USE: channel is currently being used
288 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
289 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
290 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
291 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
292 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
294 * Used by the driver to indicate which info in &struct survey_info
295 * it has filled in during the get_survey().
297 enum survey_info_flags {
298 SURVEY_INFO_NOISE_DBM = 1<<0,
299 SURVEY_INFO_IN_USE = 1<<1,
300 SURVEY_INFO_CHANNEL_TIME = 1<<2,
301 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
302 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
303 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
304 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
308 * struct survey_info - channel survey response
310 * @channel: the channel this survey record reports, mandatory
311 * @filled: bitflag of flags from &enum survey_info_flags
312 * @noise: channel noise in dBm. This and all following fields are
313 * optional
314 * @channel_time: amount of time in ms the radio spent on the channel
315 * @channel_time_busy: amount of time the primary channel was sensed busy
316 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
317 * @channel_time_rx: amount of time the radio spent receiving data
318 * @channel_time_tx: amount of time the radio spent transmitting data
320 * Used by dump_survey() to report back per-channel survey information.
322 * This structure can later be expanded with things like
323 * channel duty cycle etc.
325 struct survey_info {
326 struct ieee80211_channel *channel;
327 u64 channel_time;
328 u64 channel_time_busy;
329 u64 channel_time_ext_busy;
330 u64 channel_time_rx;
331 u64 channel_time_tx;
332 u32 filled;
333 s8 noise;
337 * struct cfg80211_crypto_settings - Crypto settings
338 * @wpa_versions: indicates which, if any, WPA versions are enabled
339 * (from enum nl80211_wpa_versions)
340 * @cipher_group: group key cipher suite (or 0 if unset)
341 * @n_ciphers_pairwise: number of AP supported unicast ciphers
342 * @ciphers_pairwise: unicast key cipher suites
343 * @n_akm_suites: number of AKM suites
344 * @akm_suites: AKM suites
345 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
346 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
347 * required to assume that the port is unauthorized until authorized by
348 * user space. Otherwise, port is marked authorized by default.
349 * @control_port_ethertype: the control port protocol that should be
350 * allowed through even on unauthorized ports
351 * @control_port_no_encrypt: TRUE to prevent encryption of control port
352 * protocol frames.
354 struct cfg80211_crypto_settings {
355 u32 wpa_versions;
356 u32 cipher_group;
357 int n_ciphers_pairwise;
358 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
359 int n_akm_suites;
360 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
361 bool control_port;
362 __be16 control_port_ethertype;
363 bool control_port_no_encrypt;
367 * struct beacon_parameters - beacon parameters
369 * Used to configure the beacon for an interface.
371 * @head: head portion of beacon (before TIM IE)
372 * or %NULL if not changed
373 * @tail: tail portion of beacon (after TIM IE)
374 * or %NULL if not changed
375 * @interval: beacon interval or zero if not changed
376 * @dtim_period: DTIM period or zero if not changed
377 * @head_len: length of @head
378 * @tail_len: length of @tail
379 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
380 * user space)
381 * @ssid_len: length of @ssid
382 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
383 * @crypto: crypto settings
384 * @privacy: the BSS uses privacy
385 * @auth_type: Authentication type (algorithm)
386 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
387 * @beacon_ies_len: length of beacon_ies in octets
388 * @proberesp_ies: extra information element(s) to add into Probe Response
389 * frames or %NULL
390 * @proberesp_ies_len: length of proberesp_ies in octets
391 * @assocresp_ies: extra information element(s) to add into (Re)Association
392 * Response frames or %NULL
393 * @assocresp_ies_len: length of assocresp_ies in octets
394 * @probe_resp_len: length of probe response template (@probe_resp)
395 * @probe_resp: probe response template (AP mode only)
397 struct beacon_parameters {
398 u8 *head, *tail;
399 int interval, dtim_period;
400 int head_len, tail_len;
401 const u8 *ssid;
402 size_t ssid_len;
403 enum nl80211_hidden_ssid hidden_ssid;
404 struct cfg80211_crypto_settings crypto;
405 bool privacy;
406 enum nl80211_auth_type auth_type;
407 const u8 *beacon_ies;
408 size_t beacon_ies_len;
409 const u8 *proberesp_ies;
410 size_t proberesp_ies_len;
411 const u8 *assocresp_ies;
412 size_t assocresp_ies_len;
413 int probe_resp_len;
414 u8 *probe_resp;
418 * enum plink_action - actions to perform in mesh peers
420 * @PLINK_ACTION_INVALID: action 0 is reserved
421 * @PLINK_ACTION_OPEN: start mesh peer link establishment
422 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
424 enum plink_actions {
425 PLINK_ACTION_INVALID,
426 PLINK_ACTION_OPEN,
427 PLINK_ACTION_BLOCK,
431 * enum station_parameters_apply_mask - station parameter values to apply
432 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
434 * Not all station parameters have in-band "no change" signalling,
435 * for those that don't these flags will are used.
437 enum station_parameters_apply_mask {
438 STATION_PARAM_APPLY_UAPSD = BIT(0),
442 * struct station_parameters - station parameters
444 * Used to change and create a new station.
446 * @vlan: vlan interface station should belong to
447 * @supported_rates: supported rates in IEEE 802.11 format
448 * (or NULL for no change)
449 * @supported_rates_len: number of supported rates
450 * @sta_flags_mask: station flags that changed
451 * (bitmask of BIT(NL80211_STA_FLAG_...))
452 * @sta_flags_set: station flags values
453 * (bitmask of BIT(NL80211_STA_FLAG_...))
454 * @listen_interval: listen interval or -1 for no change
455 * @aid: AID or zero for no change
456 * @plink_action: plink action to take
457 * @plink_state: set the peer link state for a station
458 * @ht_capa: HT capabilities of station
459 * @uapsd_queues: bitmap of queues configured for uapsd. same format
460 * as the AC bitmap in the QoS info field
461 * @max_sp: max Service Period. same format as the MAX_SP in the
462 * QoS info field (but already shifted down)
463 * @sta_modify_mask: bitmap indicating which parameters changed
464 * (for those that don't have a natural "no change" value),
465 * see &enum station_parameters_apply_mask
467 struct station_parameters {
468 u8 *supported_rates;
469 struct net_device *vlan;
470 u32 sta_flags_mask, sta_flags_set;
471 u32 sta_modify_mask;
472 int listen_interval;
473 u16 aid;
474 u8 supported_rates_len;
475 u8 plink_action;
476 u8 plink_state;
477 struct ieee80211_ht_cap *ht_capa;
478 u8 uapsd_queues;
479 u8 max_sp;
483 * enum station_info_flags - station information flags
485 * Used by the driver to indicate which info in &struct station_info
486 * it has filled in during get_station() or dump_station().
488 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
489 * @STATION_INFO_RX_BYTES: @rx_bytes filled
490 * @STATION_INFO_TX_BYTES: @tx_bytes filled
491 * @STATION_INFO_LLID: @llid filled
492 * @STATION_INFO_PLID: @plid filled
493 * @STATION_INFO_PLINK_STATE: @plink_state filled
494 * @STATION_INFO_SIGNAL: @signal filled
495 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
496 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
497 * @STATION_INFO_RX_PACKETS: @rx_packets filled
498 * @STATION_INFO_TX_PACKETS: @tx_packets filled
499 * @STATION_INFO_TX_RETRIES: @tx_retries filled
500 * @STATION_INFO_TX_FAILED: @tx_failed filled
501 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
502 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
503 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
504 * @STATION_INFO_BSS_PARAM: @bss_param filled
505 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
506 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
507 * @STATION_INFO_STA_FLAGS: @sta_flags filled
509 enum station_info_flags {
510 STATION_INFO_INACTIVE_TIME = 1<<0,
511 STATION_INFO_RX_BYTES = 1<<1,
512 STATION_INFO_TX_BYTES = 1<<2,
513 STATION_INFO_LLID = 1<<3,
514 STATION_INFO_PLID = 1<<4,
515 STATION_INFO_PLINK_STATE = 1<<5,
516 STATION_INFO_SIGNAL = 1<<6,
517 STATION_INFO_TX_BITRATE = 1<<7,
518 STATION_INFO_RX_PACKETS = 1<<8,
519 STATION_INFO_TX_PACKETS = 1<<9,
520 STATION_INFO_TX_RETRIES = 1<<10,
521 STATION_INFO_TX_FAILED = 1<<11,
522 STATION_INFO_RX_DROP_MISC = 1<<12,
523 STATION_INFO_SIGNAL_AVG = 1<<13,
524 STATION_INFO_RX_BITRATE = 1<<14,
525 STATION_INFO_BSS_PARAM = 1<<15,
526 STATION_INFO_CONNECTED_TIME = 1<<16,
527 STATION_INFO_ASSOC_REQ_IES = 1<<17,
528 STATION_INFO_STA_FLAGS = 1<<18
532 * enum station_info_rate_flags - bitrate info flags
534 * Used by the driver to indicate the specific rate transmission
535 * type for 802.11n transmissions.
537 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
538 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
539 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
541 enum rate_info_flags {
542 RATE_INFO_FLAGS_MCS = 1<<0,
543 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
544 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
548 * struct rate_info - bitrate information
550 * Information about a receiving or transmitting bitrate
552 * @flags: bitflag of flags from &enum rate_info_flags
553 * @mcs: mcs index if struct describes a 802.11n bitrate
554 * @legacy: bitrate in 100kbit/s for 802.11abg
556 struct rate_info {
557 u8 flags;
558 u8 mcs;
559 u16 legacy;
563 * enum station_info_rate_flags - bitrate info flags
565 * Used by the driver to indicate the specific rate transmission
566 * type for 802.11n transmissions.
568 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
569 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
570 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
572 enum bss_param_flags {
573 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
574 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
575 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
579 * struct sta_bss_parameters - BSS parameters for the attached station
581 * Information about the currently associated BSS
583 * @flags: bitflag of flags from &enum bss_param_flags
584 * @dtim_period: DTIM period for the BSS
585 * @beacon_interval: beacon interval
587 struct sta_bss_parameters {
588 u8 flags;
589 u8 dtim_period;
590 u16 beacon_interval;
594 * struct station_info - station information
596 * Station information filled by driver for get_station() and dump_station.
598 * @filled: bitflag of flags from &enum station_info_flags
599 * @connected_time: time(in secs) since a station is last connected
600 * @inactive_time: time since last station activity (tx/rx) in milliseconds
601 * @rx_bytes: bytes received from this station
602 * @tx_bytes: bytes transmitted to this station
603 * @llid: mesh local link id
604 * @plid: mesh peer link id
605 * @plink_state: mesh peer link state
606 * @signal: signal strength of last received packet in dBm
607 * @signal_avg: signal strength average in dBm
608 * @txrate: current unicast bitrate from this station
609 * @rxrate: current unicast bitrate to this station
610 * @rx_packets: packets received from this station
611 * @tx_packets: packets transmitted to this station
612 * @tx_retries: cumulative retry counts
613 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
614 * @rx_dropped_misc: Dropped for un-specified reason.
615 * @bss_param: current BSS parameters
616 * @generation: generation number for nl80211 dumps.
617 * This number should increase every time the list of stations
618 * changes, i.e. when a station is added or removed, so that
619 * userspace can tell whether it got a consistent snapshot.
620 * @assoc_req_ies: IEs from (Re)Association Request.
621 * This is used only when in AP mode with drivers that do not use
622 * user space MLME/SME implementation. The information is provided for
623 * the cfg80211_new_sta() calls to notify user space of the IEs.
624 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
625 * @sta_flags: station flags mask & values
627 struct station_info {
628 u32 filled;
629 u32 connected_time;
630 u32 inactive_time;
631 u32 rx_bytes;
632 u32 tx_bytes;
633 u16 llid;
634 u16 plid;
635 u8 plink_state;
636 s8 signal;
637 s8 signal_avg;
638 struct rate_info txrate;
639 struct rate_info rxrate;
640 u32 rx_packets;
641 u32 tx_packets;
642 u32 tx_retries;
643 u32 tx_failed;
644 u32 rx_dropped_misc;
645 struct sta_bss_parameters bss_param;
646 struct nl80211_sta_flag_update sta_flags;
648 int generation;
650 const u8 *assoc_req_ies;
651 size_t assoc_req_ies_len;
654 * Note: Add a new enum station_info_flags value for each new field and
655 * use it to check which fields are initialized.
660 * enum monitor_flags - monitor flags
662 * Monitor interface configuration flags. Note that these must be the bits
663 * according to the nl80211 flags.
665 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
666 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
667 * @MONITOR_FLAG_CONTROL: pass control frames
668 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
669 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
671 enum monitor_flags {
672 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
673 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
674 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
675 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
676 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
680 * enum mpath_info_flags - mesh path information flags
682 * Used by the driver to indicate which info in &struct mpath_info it has filled
683 * in during get_station() or dump_station().
685 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
686 * @MPATH_INFO_SN: @sn filled
687 * @MPATH_INFO_METRIC: @metric filled
688 * @MPATH_INFO_EXPTIME: @exptime filled
689 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
690 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
691 * @MPATH_INFO_FLAGS: @flags filled
693 enum mpath_info_flags {
694 MPATH_INFO_FRAME_QLEN = BIT(0),
695 MPATH_INFO_SN = BIT(1),
696 MPATH_INFO_METRIC = BIT(2),
697 MPATH_INFO_EXPTIME = BIT(3),
698 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
699 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
700 MPATH_INFO_FLAGS = BIT(6),
704 * struct mpath_info - mesh path information
706 * Mesh path information filled by driver for get_mpath() and dump_mpath().
708 * @filled: bitfield of flags from &enum mpath_info_flags
709 * @frame_qlen: number of queued frames for this destination
710 * @sn: target sequence number
711 * @metric: metric (cost) of this mesh path
712 * @exptime: expiration time for the mesh path from now, in msecs
713 * @flags: mesh path flags
714 * @discovery_timeout: total mesh path discovery timeout, in msecs
715 * @discovery_retries: mesh path discovery retries
716 * @generation: generation number for nl80211 dumps.
717 * This number should increase every time the list of mesh paths
718 * changes, i.e. when a station is added or removed, so that
719 * userspace can tell whether it got a consistent snapshot.
721 struct mpath_info {
722 u32 filled;
723 u32 frame_qlen;
724 u32 sn;
725 u32 metric;
726 u32 exptime;
727 u32 discovery_timeout;
728 u8 discovery_retries;
729 u8 flags;
731 int generation;
735 * struct bss_parameters - BSS parameters
737 * Used to change BSS parameters (mainly for AP mode).
739 * @use_cts_prot: Whether to use CTS protection
740 * (0 = no, 1 = yes, -1 = do not change)
741 * @use_short_preamble: Whether the use of short preambles is allowed
742 * (0 = no, 1 = yes, -1 = do not change)
743 * @use_short_slot_time: Whether the use of short slot time is allowed
744 * (0 = no, 1 = yes, -1 = do not change)
745 * @basic_rates: basic rates in IEEE 802.11 format
746 * (or NULL for no change)
747 * @basic_rates_len: number of basic rates
748 * @ap_isolate: do not forward packets between connected stations
749 * @ht_opmode: HT Operation mode
750 * (u16 = opmode, -1 = do not change)
752 struct bss_parameters {
753 int use_cts_prot;
754 int use_short_preamble;
755 int use_short_slot_time;
756 u8 *basic_rates;
757 u8 basic_rates_len;
758 int ap_isolate;
759 int ht_opmode;
763 * struct mesh_config - 802.11s mesh configuration
765 * These parameters can be changed while the mesh is active.
767 struct mesh_config {
768 /* Timeouts in ms */
769 /* Mesh plink management parameters */
770 u16 dot11MeshRetryTimeout;
771 u16 dot11MeshConfirmTimeout;
772 u16 dot11MeshHoldingTimeout;
773 u16 dot11MeshMaxPeerLinks;
774 u8 dot11MeshMaxRetries;
775 u8 dot11MeshTTL;
776 /* ttl used in path selection information elements */
777 u8 element_ttl;
778 bool auto_open_plinks;
779 /* HWMP parameters */
780 u8 dot11MeshHWMPmaxPREQretries;
781 u32 path_refresh_time;
782 u16 min_discovery_timeout;
783 u32 dot11MeshHWMPactivePathTimeout;
784 u16 dot11MeshHWMPpreqMinInterval;
785 u16 dot11MeshHWMPnetDiameterTraversalTime;
786 u8 dot11MeshHWMPRootMode;
787 u16 dot11MeshHWMPRannInterval;
788 /* This is missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol
789 * set to true only means that the station will announce others it's a
790 * mesh gate, but not necessarily using the gate announcement protocol.
791 * Still keeping the same nomenclature to be in sync with the spec. */
792 bool dot11MeshGateAnnouncementProtocol;
796 * struct mesh_setup - 802.11s mesh setup configuration
797 * @mesh_id: the mesh ID
798 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
799 * @path_sel_proto: which path selection protocol to use
800 * @path_metric: which metric to use
801 * @ie: vendor information elements (optional)
802 * @ie_len: length of vendor information elements
803 * @is_authenticated: this mesh requires authentication
804 * @is_secure: this mesh uses security
806 * These parameters are fixed when the mesh is created.
808 struct mesh_setup {
809 const u8 *mesh_id;
810 u8 mesh_id_len;
811 u8 path_sel_proto;
812 u8 path_metric;
813 const u8 *ie;
814 u8 ie_len;
815 bool is_authenticated;
816 bool is_secure;
820 * struct ieee80211_txq_params - TX queue parameters
821 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
822 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
823 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
824 * 1..32767]
825 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
826 * 1..32767]
827 * @aifs: Arbitration interframe space [0..255]
829 struct ieee80211_txq_params {
830 enum nl80211_txq_q queue;
831 u16 txop;
832 u16 cwmin;
833 u16 cwmax;
834 u8 aifs;
837 /* from net/wireless.h */
838 struct wiphy;
841 * DOC: Scanning and BSS list handling
843 * The scanning process itself is fairly simple, but cfg80211 offers quite
844 * a bit of helper functionality. To start a scan, the scan operation will
845 * be invoked with a scan definition. This scan definition contains the
846 * channels to scan, and the SSIDs to send probe requests for (including the
847 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
848 * probe. Additionally, a scan request may contain extra information elements
849 * that should be added to the probe request. The IEs are guaranteed to be
850 * well-formed, and will not exceed the maximum length the driver advertised
851 * in the wiphy structure.
853 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
854 * it is responsible for maintaining the BSS list; the driver should not
855 * maintain a list itself. For this notification, various functions exist.
857 * Since drivers do not maintain a BSS list, there are also a number of
858 * functions to search for a BSS and obtain information about it from the
859 * BSS structure cfg80211 maintains. The BSS list is also made available
860 * to userspace.
864 * struct cfg80211_ssid - SSID description
865 * @ssid: the SSID
866 * @ssid_len: length of the ssid
868 struct cfg80211_ssid {
869 u8 ssid[IEEE80211_MAX_SSID_LEN];
870 u8 ssid_len;
874 * struct cfg80211_scan_request - scan request description
876 * @ssids: SSIDs to scan for (active scan only)
877 * @n_ssids: number of SSIDs
878 * @channels: channels to scan on.
879 * @n_channels: total number of channels to scan
880 * @ie: optional information element(s) to add into Probe Request or %NULL
881 * @ie_len: length of ie in octets
882 * @rates: bitmap of rates to advertise for each band
883 * @wiphy: the wiphy this was for
884 * @dev: the interface
885 * @aborted: (internal) scan request was notified as aborted
886 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
888 struct cfg80211_scan_request {
889 struct cfg80211_ssid *ssids;
890 int n_ssids;
891 u32 n_channels;
892 const u8 *ie;
893 size_t ie_len;
895 u32 rates[IEEE80211_NUM_BANDS];
897 /* internal */
898 struct wiphy *wiphy;
899 struct net_device *dev;
900 bool aborted;
901 bool no_cck;
903 /* keep last */
904 struct ieee80211_channel *channels[0];
908 * struct cfg80211_match_set - sets of attributes to match
910 * @ssid: SSID to be matched
912 struct cfg80211_match_set {
913 struct cfg80211_ssid ssid;
917 * struct cfg80211_sched_scan_request - scheduled scan request description
919 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
920 * @n_ssids: number of SSIDs
921 * @n_channels: total number of channels to scan
922 * @interval: interval between each scheduled scan cycle
923 * @ie: optional information element(s) to add into Probe Request or %NULL
924 * @ie_len: length of ie in octets
925 * @match_sets: sets of parameters to be matched for a scan result
926 * entry to be considered valid and to be passed to the host
927 * (others are filtered out).
928 * If ommited, all results are passed.
929 * @n_match_sets: number of match sets
930 * @wiphy: the wiphy this was for
931 * @dev: the interface
932 * @channels: channels to scan
934 struct cfg80211_sched_scan_request {
935 struct cfg80211_ssid *ssids;
936 int n_ssids;
937 u32 n_channels;
938 u32 interval;
939 const u8 *ie;
940 size_t ie_len;
941 struct cfg80211_match_set *match_sets;
942 int n_match_sets;
944 /* internal */
945 struct wiphy *wiphy;
946 struct net_device *dev;
948 /* keep last */
949 struct ieee80211_channel *channels[0];
953 * enum cfg80211_signal_type - signal type
955 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
956 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
957 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
959 enum cfg80211_signal_type {
960 CFG80211_SIGNAL_TYPE_NONE,
961 CFG80211_SIGNAL_TYPE_MBM,
962 CFG80211_SIGNAL_TYPE_UNSPEC,
966 * struct cfg80211_bss - BSS description
968 * This structure describes a BSS (which may also be a mesh network)
969 * for use in scan results and similar.
971 * @channel: channel this BSS is on
972 * @bssid: BSSID of the BSS
973 * @tsf: timestamp of last received update
974 * @beacon_interval: the beacon interval as from the frame
975 * @capability: the capability field in host byte order
976 * @information_elements: the information elements (Note that there
977 * is no guarantee that these are well-formed!); this is a pointer to
978 * either the beacon_ies or proberesp_ies depending on whether Probe
979 * Response frame has been received
980 * @len_information_elements: total length of the information elements
981 * @beacon_ies: the information elements from the last Beacon frame
982 * @len_beacon_ies: total length of the beacon_ies
983 * @proberesp_ies: the information elements from the last Probe Response frame
984 * @len_proberesp_ies: total length of the proberesp_ies
985 * @signal: signal strength value (type depends on the wiphy's signal_type)
986 * @free_priv: function pointer to free private data
987 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
989 struct cfg80211_bss {
990 struct ieee80211_channel *channel;
992 u8 bssid[ETH_ALEN];
993 u64 tsf;
994 u16 beacon_interval;
995 u16 capability;
996 u8 *information_elements;
997 size_t len_information_elements;
998 u8 *beacon_ies;
999 size_t len_beacon_ies;
1000 u8 *proberesp_ies;
1001 size_t len_proberesp_ies;
1003 s32 signal;
1005 void (*free_priv)(struct cfg80211_bss *bss);
1006 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
1010 * ieee80211_bss_get_ie - find IE with given ID
1011 * @bss: the bss to search
1012 * @ie: the IE ID
1013 * Returns %NULL if not found.
1015 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1019 * struct cfg80211_auth_request - Authentication request data
1021 * This structure provides information needed to complete IEEE 802.11
1022 * authentication.
1024 * @bss: The BSS to authenticate with.
1025 * @auth_type: Authentication type (algorithm)
1026 * @ie: Extra IEs to add to Authentication frame or %NULL
1027 * @ie_len: Length of ie buffer in octets
1028 * @key_len: length of WEP key for shared key authentication
1029 * @key_idx: index of WEP key for shared key authentication
1030 * @key: WEP key for shared key authentication
1031 * @local_state_change: This is a request for a local state only, i.e., no
1032 * Authentication frame is to be transmitted and authentication state is
1033 * to be changed without having to wait for a response from the peer STA
1034 * (AP).
1036 struct cfg80211_auth_request {
1037 struct cfg80211_bss *bss;
1038 const u8 *ie;
1039 size_t ie_len;
1040 enum nl80211_auth_type auth_type;
1041 const u8 *key;
1042 u8 key_len, key_idx;
1043 bool local_state_change;
1047 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1049 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1051 enum cfg80211_assoc_req_flags {
1052 ASSOC_REQ_DISABLE_HT = BIT(0),
1056 * struct cfg80211_assoc_request - (Re)Association request data
1058 * This structure provides information needed to complete IEEE 802.11
1059 * (re)association.
1060 * @bss: The BSS to associate with.
1061 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1062 * @ie_len: Length of ie buffer in octets
1063 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1064 * @crypto: crypto settings
1065 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1066 * @flags: See &enum cfg80211_assoc_req_flags
1067 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1068 * will be used in ht_capa. Un-supported values will be ignored.
1069 * @ht_capa_mask: The bits of ht_capa which are to be used.
1071 struct cfg80211_assoc_request {
1072 struct cfg80211_bss *bss;
1073 const u8 *ie, *prev_bssid;
1074 size_t ie_len;
1075 struct cfg80211_crypto_settings crypto;
1076 bool use_mfp;
1077 u32 flags;
1078 struct ieee80211_ht_cap ht_capa;
1079 struct ieee80211_ht_cap ht_capa_mask;
1083 * struct cfg80211_deauth_request - Deauthentication request data
1085 * This structure provides information needed to complete IEEE 802.11
1086 * deauthentication.
1088 * @bss: the BSS to deauthenticate from
1089 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1090 * @ie_len: Length of ie buffer in octets
1091 * @reason_code: The reason code for the deauthentication
1092 * @local_state_change: This is a request for a local state only, i.e., no
1093 * Deauthentication frame is to be transmitted.
1095 struct cfg80211_deauth_request {
1096 struct cfg80211_bss *bss;
1097 const u8 *ie;
1098 size_t ie_len;
1099 u16 reason_code;
1100 bool local_state_change;
1104 * struct cfg80211_disassoc_request - Disassociation request data
1106 * This structure provides information needed to complete IEEE 802.11
1107 * disassocation.
1109 * @bss: the BSS to disassociate from
1110 * @ie: Extra IEs to add to Disassociation frame or %NULL
1111 * @ie_len: Length of ie buffer in octets
1112 * @reason_code: The reason code for the disassociation
1113 * @local_state_change: This is a request for a local state only, i.e., no
1114 * Disassociation frame is to be transmitted.
1116 struct cfg80211_disassoc_request {
1117 struct cfg80211_bss *bss;
1118 const u8 *ie;
1119 size_t ie_len;
1120 u16 reason_code;
1121 bool local_state_change;
1125 * struct cfg80211_ibss_params - IBSS parameters
1127 * This structure defines the IBSS parameters for the join_ibss()
1128 * method.
1130 * @ssid: The SSID, will always be non-null.
1131 * @ssid_len: The length of the SSID, will always be non-zero.
1132 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1133 * search for IBSSs with a different BSSID.
1134 * @channel: The channel to use if no IBSS can be found to join.
1135 * @channel_fixed: The channel should be fixed -- do not search for
1136 * IBSSs to join on other channels.
1137 * @ie: information element(s) to include in the beacon
1138 * @ie_len: length of that
1139 * @beacon_interval: beacon interval to use
1140 * @privacy: this is a protected network, keys will be configured
1141 * after joining
1142 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1143 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1145 struct cfg80211_ibss_params {
1146 u8 *ssid;
1147 u8 *bssid;
1148 struct ieee80211_channel *channel;
1149 u8 *ie;
1150 u8 ssid_len, ie_len;
1151 u16 beacon_interval;
1152 u32 basic_rates;
1153 bool channel_fixed;
1154 bool privacy;
1155 int mcast_rate[IEEE80211_NUM_BANDS];
1159 * struct cfg80211_connect_params - Connection parameters
1161 * This structure provides information needed to complete IEEE 802.11
1162 * authentication and association.
1164 * @channel: The channel to use or %NULL if not specified (auto-select based
1165 * on scan results)
1166 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1167 * results)
1168 * @ssid: SSID
1169 * @ssid_len: Length of ssid in octets
1170 * @auth_type: Authentication type (algorithm)
1171 * @ie: IEs for association request
1172 * @ie_len: Length of assoc_ie in octets
1173 * @privacy: indicates whether privacy-enabled APs should be used
1174 * @crypto: crypto settings
1175 * @key_len: length of WEP key for shared key authentication
1176 * @key_idx: index of WEP key for shared key authentication
1177 * @key: WEP key for shared key authentication
1178 * @flags: See &enum cfg80211_assoc_req_flags
1179 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1180 * will be used in ht_capa. Un-supported values will be ignored.
1181 * @ht_capa_mask: The bits of ht_capa which are to be used.
1183 struct cfg80211_connect_params {
1184 struct ieee80211_channel *channel;
1185 u8 *bssid;
1186 u8 *ssid;
1187 size_t ssid_len;
1188 enum nl80211_auth_type auth_type;
1189 u8 *ie;
1190 size_t ie_len;
1191 bool privacy;
1192 struct cfg80211_crypto_settings crypto;
1193 const u8 *key;
1194 u8 key_len, key_idx;
1195 u32 flags;
1196 struct ieee80211_ht_cap ht_capa;
1197 struct ieee80211_ht_cap ht_capa_mask;
1201 * enum wiphy_params_flags - set_wiphy_params bitfield values
1202 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1203 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1204 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1205 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1206 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1208 enum wiphy_params_flags {
1209 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1210 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1211 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1212 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1213 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1217 * cfg80211_bitrate_mask - masks for bitrate control
1219 struct cfg80211_bitrate_mask {
1220 struct {
1221 u32 legacy;
1222 /* TODO: add support for masking MCS rates; e.g.: */
1223 /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
1224 } control[IEEE80211_NUM_BANDS];
1227 * struct cfg80211_pmksa - PMK Security Association
1229 * This structure is passed to the set/del_pmksa() method for PMKSA
1230 * caching.
1232 * @bssid: The AP's BSSID.
1233 * @pmkid: The PMK material itself.
1235 struct cfg80211_pmksa {
1236 u8 *bssid;
1237 u8 *pmkid;
1241 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1242 * @mask: bitmask where to match pattern and where to ignore bytes,
1243 * one bit per byte, in same format as nl80211
1244 * @pattern: bytes to match where bitmask is 1
1245 * @pattern_len: length of pattern (in bytes)
1247 * Internal note: @mask and @pattern are allocated in one chunk of
1248 * memory, free @mask only!
1250 struct cfg80211_wowlan_trig_pkt_pattern {
1251 u8 *mask, *pattern;
1252 int pattern_len;
1256 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1258 * This structure defines the enabled WoWLAN triggers for the device.
1259 * @any: wake up on any activity -- special trigger if device continues
1260 * operating as normal during suspend
1261 * @disconnect: wake up if getting disconnected
1262 * @magic_pkt: wake up on receiving magic packet
1263 * @patterns: wake up on receiving packet matching a pattern
1264 * @n_patterns: number of patterns
1265 * @gtk_rekey_failure: wake up on GTK rekey failure
1266 * @eap_identity_req: wake up on EAP identity request packet
1267 * @four_way_handshake: wake up on 4-way handshake
1268 * @rfkill_release: wake up when rfkill is released
1270 struct cfg80211_wowlan {
1271 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1272 eap_identity_req, four_way_handshake,
1273 rfkill_release;
1274 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1275 int n_patterns;
1279 * struct cfg80211_gtk_rekey_data - rekey data
1280 * @kek: key encryption key
1281 * @kck: key confirmation key
1282 * @replay_ctr: replay counter
1284 struct cfg80211_gtk_rekey_data {
1285 u8 kek[NL80211_KEK_LEN];
1286 u8 kck[NL80211_KCK_LEN];
1287 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1291 * struct cfg80211_ops - backend description for wireless configuration
1293 * This struct is registered by fullmac card drivers and/or wireless stacks
1294 * in order to handle configuration requests on their interfaces.
1296 * All callbacks except where otherwise noted should return 0
1297 * on success or a negative error code.
1299 * All operations are currently invoked under rtnl for consistency with the
1300 * wireless extensions but this is subject to reevaluation as soon as this
1301 * code is used more widely and we have a first user without wext.
1303 * @suspend: wiphy device needs to be suspended. The variable @wow will
1304 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1305 * configured for the device.
1306 * @resume: wiphy device needs to be resumed
1308 * @add_virtual_intf: create a new virtual interface with the given name,
1309 * must set the struct wireless_dev's iftype. Beware: You must create
1310 * the new netdev in the wiphy's network namespace! Returns the netdev,
1311 * or an ERR_PTR.
1313 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1315 * @change_virtual_intf: change type/configuration of virtual interface,
1316 * keep the struct wireless_dev's iftype updated.
1318 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1319 * when adding a group key.
1321 * @get_key: get information about the key with the given parameters.
1322 * @mac_addr will be %NULL when requesting information for a group
1323 * key. All pointers given to the @callback function need not be valid
1324 * after it returns. This function should return an error if it is
1325 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1327 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1328 * and @key_index, return -ENOENT if the key doesn't exist.
1330 * @set_default_key: set the default key on an interface
1332 * @set_default_mgmt_key: set the default management frame key on an interface
1334 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1336 * @add_beacon: Add a beacon with given parameters, @head, @interval
1337 * and @dtim_period will be valid, @tail is optional.
1338 * @set_beacon: Change the beacon parameters for an access point mode
1339 * interface. This should reject the call when no beacon has been
1340 * configured.
1341 * @del_beacon: Remove beacon configuration and stop sending the beacon.
1343 * @add_station: Add a new station.
1344 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1345 * @change_station: Modify a given station.
1346 * @get_station: get station information for the station identified by @mac
1347 * @dump_station: dump station callback -- resume dump at index @idx
1349 * @add_mpath: add a fixed mesh path
1350 * @del_mpath: delete a given mesh path
1351 * @change_mpath: change a given mesh path
1352 * @get_mpath: get a mesh path for the given parameters
1353 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1354 * @join_mesh: join the mesh network with the specified parameters
1355 * @leave_mesh: leave the current mesh network
1357 * @get_mesh_config: Get the current mesh configuration
1359 * @update_mesh_config: Update mesh parameters on a running mesh.
1360 * The mask is a bitfield which tells us which parameters to
1361 * set, and which to leave alone.
1363 * @change_bss: Modify parameters for a given BSS.
1365 * @set_txq_params: Set TX queue parameters
1367 * @set_channel: Set channel for a given wireless interface. Some devices
1368 * may support multi-channel operation (by channel hopping) so cfg80211
1369 * doesn't verify much. Note, however, that the passed netdev may be
1370 * %NULL as well if the user requested changing the channel for the
1371 * device itself, or for a monitor interface.
1372 * @get_channel: Get the current operating channel, should return %NULL if
1373 * there's no single defined operating channel if for example the
1374 * device implements channel hopping for multi-channel virtual interfaces.
1376 * @scan: Request to do a scan. If returning zero, the scan request is given
1377 * the driver, and will be valid until passed to cfg80211_scan_done().
1378 * For scan results, call cfg80211_inform_bss(); you can call this outside
1379 * the scan/scan_done bracket too.
1381 * @auth: Request to authenticate with the specified peer
1382 * @assoc: Request to (re)associate with the specified peer
1383 * @deauth: Request to deauthenticate from the specified peer
1384 * @disassoc: Request to disassociate from the specified peer
1386 * @connect: Connect to the ESS with the specified parameters. When connected,
1387 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1388 * If the connection fails for some reason, call cfg80211_connect_result()
1389 * with the status from the AP.
1390 * @disconnect: Disconnect from the BSS/ESS.
1392 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1393 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1394 * to a merge.
1395 * @leave_ibss: Leave the IBSS.
1397 * @set_wiphy_params: Notify that wiphy parameters have changed;
1398 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1399 * have changed. The actual parameter values are available in
1400 * struct wiphy. If returning an error, no value should be changed.
1402 * @set_tx_power: set the transmit power according to the parameters
1403 * @get_tx_power: store the current TX power into the dbm variable;
1404 * return 0 if successful
1406 * @set_wds_peer: set the WDS peer for a WDS interface
1408 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1409 * functions to adjust rfkill hw state
1411 * @dump_survey: get site survey information.
1413 * @remain_on_channel: Request the driver to remain awake on the specified
1414 * channel for the specified duration to complete an off-channel
1415 * operation (e.g., public action frame exchange). When the driver is
1416 * ready on the requested channel, it must indicate this with an event
1417 * notification by calling cfg80211_ready_on_channel().
1418 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1419 * This allows the operation to be terminated prior to timeout based on
1420 * the duration value.
1421 * @mgmt_tx: Transmit a management frame.
1422 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1423 * frame on another channel
1425 * @testmode_cmd: run a test mode command
1426 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1427 * used by the function, but 0 and 1 must not be touched. Additionally,
1428 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1429 * dump and return to userspace with an error, so be careful. If any data
1430 * was passed in from userspace then the data/len arguments will be present
1431 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1433 * @set_bitrate_mask: set the bitrate mask configuration
1435 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1436 * devices running firmwares capable of generating the (re) association
1437 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1438 * @del_pmksa: Delete a cached PMKID.
1439 * @flush_pmksa: Flush all cached PMKIDs.
1440 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1441 * allows the driver to adjust the dynamic ps timeout value.
1442 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1443 * @sched_scan_start: Tell the driver to start a scheduled scan.
1444 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
1445 * scan. The driver_initiated flag specifies whether the driver
1446 * itself has informed that the scan has stopped.
1448 * @mgmt_frame_register: Notify driver that a management frame type was
1449 * registered. Note that this callback may not sleep, and cannot run
1450 * concurrently with itself.
1452 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1453 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1454 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1455 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1457 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1459 * @set_ringparam: Set tx and rx ring sizes.
1461 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1463 * @tdls_mgmt: Transmit a TDLS management frame.
1464 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1466 * @probe_client: probe an associated client, must return a cookie that it
1467 * later passes to cfg80211_probe_status().
1469 * @set_noack_map: Set the NoAck Map for the TIDs.
1471 struct cfg80211_ops {
1472 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1473 int (*resume)(struct wiphy *wiphy);
1475 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
1476 char *name,
1477 enum nl80211_iftype type,
1478 u32 *flags,
1479 struct vif_params *params);
1480 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1481 int (*change_virtual_intf)(struct wiphy *wiphy,
1482 struct net_device *dev,
1483 enum nl80211_iftype type, u32 *flags,
1484 struct vif_params *params);
1486 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1487 u8 key_index, bool pairwise, const u8 *mac_addr,
1488 struct key_params *params);
1489 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1490 u8 key_index, bool pairwise, const u8 *mac_addr,
1491 void *cookie,
1492 void (*callback)(void *cookie, struct key_params*));
1493 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1494 u8 key_index, bool pairwise, const u8 *mac_addr);
1495 int (*set_default_key)(struct wiphy *wiphy,
1496 struct net_device *netdev,
1497 u8 key_index, bool unicast, bool multicast);
1498 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1499 struct net_device *netdev,
1500 u8 key_index);
1502 int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
1503 struct beacon_parameters *info);
1504 int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
1505 struct beacon_parameters *info);
1506 int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
1509 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1510 u8 *mac, struct station_parameters *params);
1511 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1512 u8 *mac);
1513 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1514 u8 *mac, struct station_parameters *params);
1515 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1516 u8 *mac, struct station_info *sinfo);
1517 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1518 int idx, u8 *mac, struct station_info *sinfo);
1520 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1521 u8 *dst, u8 *next_hop);
1522 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1523 u8 *dst);
1524 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1525 u8 *dst, u8 *next_hop);
1526 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1527 u8 *dst, u8 *next_hop,
1528 struct mpath_info *pinfo);
1529 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1530 int idx, u8 *dst, u8 *next_hop,
1531 struct mpath_info *pinfo);
1532 int (*get_mesh_config)(struct wiphy *wiphy,
1533 struct net_device *dev,
1534 struct mesh_config *conf);
1535 int (*update_mesh_config)(struct wiphy *wiphy,
1536 struct net_device *dev, u32 mask,
1537 const struct mesh_config *nconf);
1538 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1539 const struct mesh_config *conf,
1540 const struct mesh_setup *setup);
1541 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1543 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1544 struct bss_parameters *params);
1546 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1547 struct ieee80211_txq_params *params);
1549 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
1550 struct ieee80211_channel *chan,
1551 enum nl80211_channel_type channel_type);
1553 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1554 struct cfg80211_scan_request *request);
1556 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1557 struct cfg80211_auth_request *req);
1558 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1559 struct cfg80211_assoc_request *req);
1560 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1561 struct cfg80211_deauth_request *req,
1562 void *cookie);
1563 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1564 struct cfg80211_disassoc_request *req,
1565 void *cookie);
1567 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1568 struct cfg80211_connect_params *sme);
1569 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1570 u16 reason_code);
1572 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1573 struct cfg80211_ibss_params *params);
1574 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1576 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1578 int (*set_tx_power)(struct wiphy *wiphy,
1579 enum nl80211_tx_power_setting type, int mbm);
1580 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1582 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1583 const u8 *addr);
1585 void (*rfkill_poll)(struct wiphy *wiphy);
1587 #ifdef CONFIG_NL80211_TESTMODE
1588 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1589 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1590 struct netlink_callback *cb,
1591 void *data, int len);
1592 #endif
1594 int (*set_bitrate_mask)(struct wiphy *wiphy,
1595 struct net_device *dev,
1596 const u8 *peer,
1597 const struct cfg80211_bitrate_mask *mask);
1599 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1600 int idx, struct survey_info *info);
1602 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1603 struct cfg80211_pmksa *pmksa);
1604 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1605 struct cfg80211_pmksa *pmksa);
1606 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1608 int (*remain_on_channel)(struct wiphy *wiphy,
1609 struct net_device *dev,
1610 struct ieee80211_channel *chan,
1611 enum nl80211_channel_type channel_type,
1612 unsigned int duration,
1613 u64 *cookie);
1614 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1615 struct net_device *dev,
1616 u64 cookie);
1618 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1619 struct ieee80211_channel *chan, bool offchan,
1620 enum nl80211_channel_type channel_type,
1621 bool channel_type_valid, unsigned int wait,
1622 const u8 *buf, size_t len, bool no_cck,
1623 bool dont_wait_for_ack, u64 *cookie);
1624 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1625 struct net_device *dev,
1626 u64 cookie);
1628 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1629 bool enabled, int timeout);
1631 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1632 struct net_device *dev,
1633 s32 rssi_thold, u32 rssi_hyst);
1635 void (*mgmt_frame_register)(struct wiphy *wiphy,
1636 struct net_device *dev,
1637 u16 frame_type, bool reg);
1639 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1640 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1642 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1643 void (*get_ringparam)(struct wiphy *wiphy,
1644 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1646 int (*sched_scan_start)(struct wiphy *wiphy,
1647 struct net_device *dev,
1648 struct cfg80211_sched_scan_request *request);
1649 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1651 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
1652 struct cfg80211_gtk_rekey_data *data);
1654 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1655 u8 *peer, u8 action_code, u8 dialog_token,
1656 u16 status_code, const u8 *buf, size_t len);
1657 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
1658 u8 *peer, enum nl80211_tdls_operation oper);
1660 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
1661 const u8 *peer, u64 *cookie);
1663 int (*set_noack_map)(struct wiphy *wiphy,
1664 struct net_device *dev,
1665 u16 noack_map);
1667 struct ieee80211_channel *(*get_channel)(struct wiphy *wiphy);
1671 * wireless hardware and networking interfaces structures
1672 * and registration/helper functions
1676 * enum wiphy_flags - wiphy capability flags
1678 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1679 * has its own custom regulatory domain and cannot identify the
1680 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1681 * we will disregard the first regulatory hint (when the
1682 * initiator is %REGDOM_SET_BY_CORE).
1683 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1684 * ignore regulatory domain settings until it gets its own regulatory
1685 * domain via its regulatory_hint() unless the regulatory hint is
1686 * from a country IE. After its gets its own regulatory domain it will
1687 * only allow further regulatory domain settings to further enhance
1688 * compliance. For example if channel 13 and 14 are disabled by this
1689 * regulatory domain no user regulatory domain can enable these channels
1690 * at a later time. This can be used for devices which do not have
1691 * calibration information guaranteed for frequencies or settings
1692 * outside of its regulatory domain.
1693 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1694 * that passive scan flags and beaconing flags may not be lifted by
1695 * cfg80211 due to regulatory beacon hints. For more information on beacon
1696 * hints read the documenation for regulatory_hint_found_beacon()
1697 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1698 * wiphy at all
1699 * @WIPHY_FLAG_ENFORCE_COMBINATIONS: Set this flag to enforce interface
1700 * combinations for this device. This flag is used for backward
1701 * compatibility only until all drivers advertise combinations and
1702 * they will always be enforced.
1703 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1704 * by default -- this flag will be set depending on the kernel's default
1705 * on wiphy_new(), but can be changed by the driver if it has a good
1706 * reason to override the default
1707 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1708 * on a VLAN interface)
1709 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1710 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1711 * control port protocol ethertype. The device also honours the
1712 * control_port_no_encrypt flag.
1713 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1714 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1715 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1716 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1717 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
1718 * firmware.
1719 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
1720 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
1721 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
1722 * link setup/discovery operations internally. Setup, discovery and
1723 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
1724 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
1725 * used for asking the driver/firmware to perform a TDLS operation.
1726 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
1727 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
1728 * when there are virtual interfaces in AP mode by calling
1729 * cfg80211_report_obss_beacon().
1730 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
1731 * responds to probe-requests in hardware.
1732 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
1733 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
1735 enum wiphy_flags {
1736 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1737 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1738 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1739 WIPHY_FLAG_NETNS_OK = BIT(3),
1740 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1741 WIPHY_FLAG_4ADDR_AP = BIT(5),
1742 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1743 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1744 WIPHY_FLAG_IBSS_RSN = BIT(8),
1745 WIPHY_FLAG_MESH_AUTH = BIT(10),
1746 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
1747 WIPHY_FLAG_ENFORCE_COMBINATIONS = BIT(12),
1748 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
1749 WIPHY_FLAG_AP_UAPSD = BIT(14),
1750 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
1751 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
1752 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
1753 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
1754 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
1755 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
1756 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
1760 * struct ieee80211_iface_limit - limit on certain interface types
1761 * @max: maximum number of interfaces of these types
1762 * @types: interface types (bits)
1764 struct ieee80211_iface_limit {
1765 u16 max;
1766 u16 types;
1770 * struct ieee80211_iface_combination - possible interface combination
1771 * @limits: limits for the given interface types
1772 * @n_limits: number of limitations
1773 * @num_different_channels: can use up to this many different channels
1774 * @max_interfaces: maximum number of interfaces in total allowed in this
1775 * group
1776 * @beacon_int_infra_match: In this combination, the beacon intervals
1777 * between infrastructure and AP types must match. This is required
1778 * only in special cases.
1780 * These examples can be expressed as follows:
1782 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1784 * struct ieee80211_iface_limit limits1[] = {
1785 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1786 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1787 * };
1788 * struct ieee80211_iface_combination combination1 = {
1789 * .limits = limits1,
1790 * .n_limits = ARRAY_SIZE(limits1),
1791 * .max_interfaces = 2,
1792 * .beacon_int_infra_match = true,
1793 * };
1796 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1798 * struct ieee80211_iface_limit limits2[] = {
1799 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1800 * BIT(NL80211_IFTYPE_P2P_GO), },
1801 * };
1802 * struct ieee80211_iface_combination combination2 = {
1803 * .limits = limits2,
1804 * .n_limits = ARRAY_SIZE(limits2),
1805 * .max_interfaces = 8,
1806 * .num_different_channels = 1,
1807 * };
1810 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
1811 * This allows for an infrastructure connection and three P2P connections.
1813 * struct ieee80211_iface_limit limits3[] = {
1814 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1815 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
1816 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
1817 * };
1818 * struct ieee80211_iface_combination combination3 = {
1819 * .limits = limits3,
1820 * .n_limits = ARRAY_SIZE(limits3),
1821 * .max_interfaces = 4,
1822 * .num_different_channels = 2,
1823 * };
1825 struct ieee80211_iface_combination {
1826 const struct ieee80211_iface_limit *limits;
1827 u32 num_different_channels;
1828 u16 max_interfaces;
1829 u8 n_limits;
1830 bool beacon_int_infra_match;
1833 struct mac_address {
1834 u8 addr[ETH_ALEN];
1837 struct ieee80211_txrx_stypes {
1838 u16 tx, rx;
1842 * enum wiphy_wowlan_support_flags - WoWLAN support flags
1843 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
1844 * trigger that keeps the device operating as-is and
1845 * wakes up the host on any activity, for example a
1846 * received packet that passed filtering; note that the
1847 * packet should be preserved in that case
1848 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
1849 * (see nl80211.h)
1850 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
1851 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
1852 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
1853 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
1854 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
1855 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
1857 enum wiphy_wowlan_support_flags {
1858 WIPHY_WOWLAN_ANY = BIT(0),
1859 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
1860 WIPHY_WOWLAN_DISCONNECT = BIT(2),
1861 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
1862 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
1863 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
1864 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
1865 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
1869 * struct wiphy_wowlan_support - WoWLAN support data
1870 * @flags: see &enum wiphy_wowlan_support_flags
1871 * @n_patterns: number of supported wakeup patterns
1872 * (see nl80211.h for the pattern definition)
1873 * @pattern_max_len: maximum length of each pattern
1874 * @pattern_min_len: minimum length of each pattern
1876 struct wiphy_wowlan_support {
1877 u32 flags;
1878 int n_patterns;
1879 int pattern_max_len;
1880 int pattern_min_len;
1884 * struct wiphy - wireless hardware description
1885 * @reg_notifier: the driver's regulatory notification callback,
1886 * note that if your driver uses wiphy_apply_custom_regulatory()
1887 * the reg_notifier's request can be passed as NULL
1888 * @regd: the driver's regulatory domain, if one was requested via
1889 * the regulatory_hint() API. This can be used by the driver
1890 * on the reg_notifier() if it chooses to ignore future
1891 * regulatory domain changes caused by other drivers.
1892 * @signal_type: signal type reported in &struct cfg80211_bss.
1893 * @cipher_suites: supported cipher suites
1894 * @n_cipher_suites: number of supported cipher suites
1895 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1896 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1897 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1898 * -1 = fragmentation disabled, only odd values >= 256 used
1899 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1900 * @_net: the network namespace this wiphy currently lives in
1901 * @perm_addr: permanent MAC address of this device
1902 * @addr_mask: If the device supports multiple MAC addresses by masking,
1903 * set this to a mask with variable bits set to 1, e.g. if the last
1904 * four bits are variable then set it to 00:...:00:0f. The actual
1905 * variable bits shall be determined by the interfaces added, with
1906 * interfaces not matching the mask being rejected to be brought up.
1907 * @n_addresses: number of addresses in @addresses.
1908 * @addresses: If the device has more than one address, set this pointer
1909 * to a list of addresses (6 bytes each). The first one will be used
1910 * by default for perm_addr. In this case, the mask should be set to
1911 * all-zeroes. In this case it is assumed that the device can handle
1912 * the same number of arbitrary MAC addresses.
1913 * @registered: protects ->resume and ->suspend sysfs callbacks against
1914 * unregister hardware
1915 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1916 * automatically on wiphy renames
1917 * @dev: (virtual) struct device for this wiphy
1918 * @registered: helps synchronize suspend/resume with wiphy unregister
1919 * @wext: wireless extension handlers
1920 * @priv: driver private data (sized according to wiphy_new() parameter)
1921 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1922 * must be set by driver
1923 * @iface_combinations: Valid interface combinations array, should not
1924 * list single interface types.
1925 * @n_iface_combinations: number of entries in @iface_combinations array.
1926 * @software_iftypes: bitmask of software interface types, these are not
1927 * subject to any restrictions since they are purely managed in SW.
1928 * @flags: wiphy flags, see &enum wiphy_flags
1929 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
1930 * @bss_priv_size: each BSS struct has private data allocated with it,
1931 * this variable determines its size
1932 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1933 * any given scan
1934 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
1935 * for in any given scheduled scan
1936 * @max_match_sets: maximum number of match sets the device can handle
1937 * when performing a scheduled scan, 0 if filtering is not
1938 * supported.
1939 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1940 * add to probe request frames transmitted during a scan, must not
1941 * include fixed IEs like supported rates
1942 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
1943 * scans
1944 * @coverage_class: current coverage class
1945 * @fw_version: firmware version for ethtool reporting
1946 * @hw_version: hardware version for ethtool reporting
1947 * @max_num_pmkids: maximum number of PMKIDs supported by device
1948 * @privid: a pointer that drivers can use to identify if an arbitrary
1949 * wiphy is theirs, e.g. in global notifiers
1950 * @bands: information about bands/channels supported by this device
1952 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1953 * transmitted through nl80211, points to an array indexed by interface
1954 * type
1956 * @available_antennas_tx: bitmap of antennas which are available to be
1957 * configured as TX antennas. Antenna configuration commands will be
1958 * rejected unless this or @available_antennas_rx is set.
1960 * @available_antennas_rx: bitmap of antennas which are available to be
1961 * configured as RX antennas. Antenna configuration commands will be
1962 * rejected unless this or @available_antennas_tx is set.
1964 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
1965 * may request, if implemented.
1967 * @wowlan: WoWLAN support information
1969 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
1970 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
1971 * If null, then none can be over-ridden.
1973 struct wiphy {
1974 /* assign these fields before you register the wiphy */
1976 /* permanent MAC address(es) */
1977 u8 perm_addr[ETH_ALEN];
1978 u8 addr_mask[ETH_ALEN];
1980 struct mac_address *addresses;
1982 const struct ieee80211_txrx_stypes *mgmt_stypes;
1984 const struct ieee80211_iface_combination *iface_combinations;
1985 int n_iface_combinations;
1986 u16 software_iftypes;
1988 u16 n_addresses;
1990 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1991 u16 interface_modes;
1993 u32 flags, features;
1995 u32 ap_sme_capa;
1997 enum cfg80211_signal_type signal_type;
1999 int bss_priv_size;
2000 u8 max_scan_ssids;
2001 u8 max_sched_scan_ssids;
2002 u8 max_match_sets;
2003 u16 max_scan_ie_len;
2004 u16 max_sched_scan_ie_len;
2006 int n_cipher_suites;
2007 const u32 *cipher_suites;
2009 u8 retry_short;
2010 u8 retry_long;
2011 u32 frag_threshold;
2012 u32 rts_threshold;
2013 u8 coverage_class;
2015 char fw_version[ETHTOOL_BUSINFO_LEN];
2016 u32 hw_version;
2018 struct wiphy_wowlan_support wowlan;
2020 u16 max_remain_on_channel_duration;
2022 u8 max_num_pmkids;
2024 u32 available_antennas_tx;
2025 u32 available_antennas_rx;
2028 * Bitmap of supported protocols for probe response offloading
2029 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2030 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2032 u32 probe_resp_offload;
2034 /* If multiple wiphys are registered and you're handed e.g.
2035 * a regular netdev with assigned ieee80211_ptr, you won't
2036 * know whether it points to a wiphy your driver has registered
2037 * or not. Assign this to something global to your driver to
2038 * help determine whether you own this wiphy or not. */
2039 const void *privid;
2041 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2043 /* Lets us get back the wiphy on the callback */
2044 int (*reg_notifier)(struct wiphy *wiphy,
2045 struct regulatory_request *request);
2047 /* fields below are read-only, assigned by cfg80211 */
2049 const struct ieee80211_regdomain *regd;
2051 /* the item in /sys/class/ieee80211/ points to this,
2052 * you need use set_wiphy_dev() (see below) */
2053 struct device dev;
2055 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2056 bool registered;
2058 /* dir in debugfs: ieee80211/<wiphyname> */
2059 struct dentry *debugfsdir;
2061 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2063 #ifdef CONFIG_NET_NS
2064 /* the network namespace this phy lives in currently */
2065 struct net *_net;
2066 #endif
2068 #ifdef CONFIG_CFG80211_WEXT
2069 const struct iw_handler_def *wext;
2070 #endif
2072 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
2075 static inline struct net *wiphy_net(struct wiphy *wiphy)
2077 return read_pnet(&wiphy->_net);
2080 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2082 write_pnet(&wiphy->_net, net);
2086 * wiphy_priv - return priv from wiphy
2088 * @wiphy: the wiphy whose priv pointer to return
2090 static inline void *wiphy_priv(struct wiphy *wiphy)
2092 BUG_ON(!wiphy);
2093 return &wiphy->priv;
2097 * priv_to_wiphy - return the wiphy containing the priv
2099 * @priv: a pointer previously returned by wiphy_priv
2101 static inline struct wiphy *priv_to_wiphy(void *priv)
2103 BUG_ON(!priv);
2104 return container_of(priv, struct wiphy, priv);
2108 * set_wiphy_dev - set device pointer for wiphy
2110 * @wiphy: The wiphy whose device to bind
2111 * @dev: The device to parent it to
2113 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2115 wiphy->dev.parent = dev;
2119 * wiphy_dev - get wiphy dev pointer
2121 * @wiphy: The wiphy whose device struct to look up
2123 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2125 return wiphy->dev.parent;
2129 * wiphy_name - get wiphy name
2131 * @wiphy: The wiphy whose name to return
2133 static inline const char *wiphy_name(const struct wiphy *wiphy)
2135 return dev_name(&wiphy->dev);
2139 * wiphy_new - create a new wiphy for use with cfg80211
2141 * @ops: The configuration operations for this device
2142 * @sizeof_priv: The size of the private area to allocate
2144 * Create a new wiphy and associate the given operations with it.
2145 * @sizeof_priv bytes are allocated for private use.
2147 * The returned pointer must be assigned to each netdev's
2148 * ieee80211_ptr for proper operation.
2150 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2153 * wiphy_register - register a wiphy with cfg80211
2155 * @wiphy: The wiphy to register.
2157 * Returns a non-negative wiphy index or a negative error code.
2159 extern int wiphy_register(struct wiphy *wiphy);
2162 * wiphy_unregister - deregister a wiphy from cfg80211
2164 * @wiphy: The wiphy to unregister.
2166 * After this call, no more requests can be made with this priv
2167 * pointer, but the call may sleep to wait for an outstanding
2168 * request that is being handled.
2170 extern void wiphy_unregister(struct wiphy *wiphy);
2173 * wiphy_free - free wiphy
2175 * @wiphy: The wiphy to free
2177 extern void wiphy_free(struct wiphy *wiphy);
2179 /* internal structs */
2180 struct cfg80211_conn;
2181 struct cfg80211_internal_bss;
2182 struct cfg80211_cached_keys;
2184 #define MAX_AUTH_BSSES 4
2187 * struct wireless_dev - wireless per-netdev state
2189 * This structure must be allocated by the driver/stack
2190 * that uses the ieee80211_ptr field in struct net_device
2191 * (this is intentional so it can be allocated along with
2192 * the netdev.)
2194 * @wiphy: pointer to hardware description
2195 * @iftype: interface type
2196 * @list: (private) Used to collect the interfaces
2197 * @netdev: (private) Used to reference back to the netdev
2198 * @current_bss: (private) Used by the internal configuration code
2199 * @channel: (private) Used by the internal configuration code to track
2200 * user-set AP, monitor and WDS channels for wireless extensions
2201 * @bssid: (private) Used by the internal configuration code
2202 * @ssid: (private) Used by the internal configuration code
2203 * @ssid_len: (private) Used by the internal configuration code
2204 * @mesh_id_len: (private) Used by the internal configuration code
2205 * @mesh_id_up_len: (private) Used by the internal configuration code
2206 * @wext: (private) Used by the internal wireless extensions compat code
2207 * @use_4addr: indicates 4addr mode is used on this interface, must be
2208 * set by driver (if supported) on add_interface BEFORE registering the
2209 * netdev and may otherwise be used by driver read-only, will be update
2210 * by cfg80211 on change_interface
2211 * @mgmt_registrations: list of registrations for management frames
2212 * @mgmt_registrations_lock: lock for the list
2213 * @mtx: mutex used to lock data in this struct
2214 * @cleanup_work: work struct used for cleanup that can't be done directly
2215 * @beacon_interval: beacon interval used on this device for transmitting
2216 * beacons, 0 when not valid
2218 struct wireless_dev {
2219 struct wiphy *wiphy;
2220 enum nl80211_iftype iftype;
2222 /* the remainder of this struct should be private to cfg80211 */
2223 struct list_head list;
2224 struct net_device *netdev;
2226 struct list_head mgmt_registrations;
2227 spinlock_t mgmt_registrations_lock;
2229 struct mutex mtx;
2231 struct work_struct cleanup_work;
2233 bool use_4addr;
2235 /* currently used for IBSS and SME - might be rearranged later */
2236 u8 ssid[IEEE80211_MAX_SSID_LEN];
2237 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2238 enum {
2239 CFG80211_SME_IDLE,
2240 CFG80211_SME_CONNECTING,
2241 CFG80211_SME_CONNECTED,
2242 } sme_state;
2243 struct cfg80211_conn *conn;
2244 struct cfg80211_cached_keys *connect_keys;
2246 struct list_head event_list;
2247 spinlock_t event_lock;
2249 struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
2250 struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
2251 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2252 struct ieee80211_channel *channel;
2254 bool ps;
2255 int ps_timeout;
2257 int beacon_interval;
2259 u32 ap_unexpected_nlpid;
2261 #ifdef CONFIG_CFG80211_WEXT
2262 /* wext data */
2263 struct {
2264 struct cfg80211_ibss_params ibss;
2265 struct cfg80211_connect_params connect;
2266 struct cfg80211_cached_keys *keys;
2267 u8 *ie;
2268 size_t ie_len;
2269 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2270 u8 ssid[IEEE80211_MAX_SSID_LEN];
2271 s8 default_key, default_mgmt_key;
2272 bool prev_bssid_valid;
2273 } wext;
2274 #endif
2278 * wdev_priv - return wiphy priv from wireless_dev
2280 * @wdev: The wireless device whose wiphy's priv pointer to return
2282 static inline void *wdev_priv(struct wireless_dev *wdev)
2284 BUG_ON(!wdev);
2285 return wiphy_priv(wdev->wiphy);
2289 * DOC: Utility functions
2291 * cfg80211 offers a number of utility functions that can be useful.
2295 * ieee80211_channel_to_frequency - convert channel number to frequency
2296 * @chan: channel number
2297 * @band: band, necessary due to channel number overlap
2299 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2302 * ieee80211_frequency_to_channel - convert frequency to channel number
2303 * @freq: center frequency
2305 extern int ieee80211_frequency_to_channel(int freq);
2308 * Name indirection necessary because the ieee80211 code also has
2309 * a function named "ieee80211_get_channel", so if you include
2310 * cfg80211's header file you get cfg80211's version, if you try
2311 * to include both header files you'll (rightfully!) get a symbol
2312 * clash.
2314 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2315 int freq);
2317 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2318 * @wiphy: the struct wiphy to get the channel for
2319 * @freq: the center frequency of the channel
2321 static inline struct ieee80211_channel *
2322 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2324 return __ieee80211_get_channel(wiphy, freq);
2328 * ieee80211_get_response_rate - get basic rate for a given rate
2330 * @sband: the band to look for rates in
2331 * @basic_rates: bitmap of basic rates
2332 * @bitrate: the bitrate for which to find the basic rate
2334 * This function returns the basic rate corresponding to a given
2335 * bitrate, that is the next lower bitrate contained in the basic
2336 * rate map, which is, for this function, given as a bitmap of
2337 * indices of rates in the band's bitrate table.
2339 struct ieee80211_rate *
2340 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2341 u32 basic_rates, int bitrate);
2344 * Radiotap parsing functions -- for controlled injection support
2346 * Implemented in net/wireless/radiotap.c
2347 * Documentation in Documentation/networking/radiotap-headers.txt
2350 struct radiotap_align_size {
2351 uint8_t align:4, size:4;
2354 struct ieee80211_radiotap_namespace {
2355 const struct radiotap_align_size *align_size;
2356 int n_bits;
2357 uint32_t oui;
2358 uint8_t subns;
2361 struct ieee80211_radiotap_vendor_namespaces {
2362 const struct ieee80211_radiotap_namespace *ns;
2363 int n_ns;
2367 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2368 * @this_arg_index: index of current arg, valid after each successful call
2369 * to ieee80211_radiotap_iterator_next()
2370 * @this_arg: pointer to current radiotap arg; it is valid after each
2371 * call to ieee80211_radiotap_iterator_next() but also after
2372 * ieee80211_radiotap_iterator_init() where it will point to
2373 * the beginning of the actual data portion
2374 * @this_arg_size: length of the current arg, for convenience
2375 * @current_namespace: pointer to the current namespace definition
2376 * (or internally %NULL if the current namespace is unknown)
2377 * @is_radiotap_ns: indicates whether the current namespace is the default
2378 * radiotap namespace or not
2380 * @_rtheader: pointer to the radiotap header we are walking through
2381 * @_max_length: length of radiotap header in cpu byte ordering
2382 * @_arg_index: next argument index
2383 * @_arg: next argument pointer
2384 * @_next_bitmap: internal pointer to next present u32
2385 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2386 * @_vns: vendor namespace definitions
2387 * @_next_ns_data: beginning of the next namespace's data
2388 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2389 * next bitmap word
2391 * Describes the radiotap parser state. Fields prefixed with an underscore
2392 * must not be used by users of the parser, only by the parser internally.
2395 struct ieee80211_radiotap_iterator {
2396 struct ieee80211_radiotap_header *_rtheader;
2397 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2398 const struct ieee80211_radiotap_namespace *current_namespace;
2400 unsigned char *_arg, *_next_ns_data;
2401 __le32 *_next_bitmap;
2403 unsigned char *this_arg;
2404 int this_arg_index;
2405 int this_arg_size;
2407 int is_radiotap_ns;
2409 int _max_length;
2410 int _arg_index;
2411 uint32_t _bitmap_shifter;
2412 int _reset_on_ext;
2415 extern int ieee80211_radiotap_iterator_init(
2416 struct ieee80211_radiotap_iterator *iterator,
2417 struct ieee80211_radiotap_header *radiotap_header,
2418 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2420 extern int ieee80211_radiotap_iterator_next(
2421 struct ieee80211_radiotap_iterator *iterator);
2424 extern const unsigned char rfc1042_header[6];
2425 extern const unsigned char bridge_tunnel_header[6];
2428 * ieee80211_get_hdrlen_from_skb - get header length from data
2430 * Given an skb with a raw 802.11 header at the data pointer this function
2431 * returns the 802.11 header length in bytes (not including encryption
2432 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2433 * header the function returns 0.
2435 * @skb: the frame
2437 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2440 * ieee80211_hdrlen - get header length in bytes from frame control
2441 * @fc: frame control field in little-endian format
2443 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2446 * DOC: Data path helpers
2448 * In addition to generic utilities, cfg80211 also offers
2449 * functions that help implement the data path for devices
2450 * that do not do the 802.11/802.3 conversion on the device.
2454 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2455 * @skb: the 802.11 data frame
2456 * @addr: the device MAC address
2457 * @iftype: the virtual interface type
2459 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2460 enum nl80211_iftype iftype);
2463 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2464 * @skb: the 802.3 frame
2465 * @addr: the device MAC address
2466 * @iftype: the virtual interface type
2467 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2468 * @qos: build 802.11 QoS data frame
2470 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2471 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2474 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2476 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2477 * 802.3 frames. The @list will be empty if the decode fails. The
2478 * @skb is consumed after the function returns.
2480 * @skb: The input IEEE 802.11n A-MSDU frame.
2481 * @list: The output list of 802.3 frames. It must be allocated and
2482 * initialized by by the caller.
2483 * @addr: The device MAC address.
2484 * @iftype: The device interface type.
2485 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2486 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2488 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2489 const u8 *addr, enum nl80211_iftype iftype,
2490 const unsigned int extra_headroom,
2491 bool has_80211_header);
2494 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2495 * @skb: the data frame
2497 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2500 * cfg80211_find_ie - find information element in data
2502 * @eid: element ID
2503 * @ies: data consisting of IEs
2504 * @len: length of data
2506 * This function will return %NULL if the element ID could
2507 * not be found or if the element is invalid (claims to be
2508 * longer than the given data), or a pointer to the first byte
2509 * of the requested element, that is the byte containing the
2510 * element ID. There are no checks on the element length
2511 * other than having to fit into the given data.
2513 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2516 * cfg80211_find_vendor_ie - find vendor specific information element in data
2518 * @oui: vendor OUI
2519 * @oui_type: vendor-specific OUI type
2520 * @ies: data consisting of IEs
2521 * @len: length of data
2523 * This function will return %NULL if the vendor specific element ID
2524 * could not be found or if the element is invalid (claims to be
2525 * longer than the given data), or a pointer to the first byte
2526 * of the requested element, that is the byte containing the
2527 * element ID. There are no checks on the element length
2528 * other than having to fit into the given data.
2530 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
2531 const u8 *ies, int len);
2534 * DOC: Regulatory enforcement infrastructure
2536 * TODO
2540 * regulatory_hint - driver hint to the wireless core a regulatory domain
2541 * @wiphy: the wireless device giving the hint (used only for reporting
2542 * conflicts)
2543 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2544 * should be in. If @rd is set this should be NULL. Note that if you
2545 * set this to NULL you should still set rd->alpha2 to some accepted
2546 * alpha2.
2548 * Wireless drivers can use this function to hint to the wireless core
2549 * what it believes should be the current regulatory domain by
2550 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2551 * domain should be in or by providing a completely build regulatory domain.
2552 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2553 * for a regulatory domain structure for the respective country.
2555 * The wiphy must have been registered to cfg80211 prior to this call.
2556 * For cfg80211 drivers this means you must first use wiphy_register(),
2557 * for mac80211 drivers you must first use ieee80211_register_hw().
2559 * Drivers should check the return value, its possible you can get
2560 * an -ENOMEM.
2562 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2565 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2566 * @wiphy: the wireless device we want to process the regulatory domain on
2567 * @regd: the custom regulatory domain to use for this wiphy
2569 * Drivers can sometimes have custom regulatory domains which do not apply
2570 * to a specific country. Drivers can use this to apply such custom regulatory
2571 * domains. This routine must be called prior to wiphy registration. The
2572 * custom regulatory domain will be trusted completely and as such previous
2573 * default channel settings will be disregarded. If no rule is found for a
2574 * channel on the regulatory domain the channel will be disabled.
2576 extern void wiphy_apply_custom_regulatory(
2577 struct wiphy *wiphy,
2578 const struct ieee80211_regdomain *regd);
2581 * freq_reg_info - get regulatory information for the given frequency
2582 * @wiphy: the wiphy for which we want to process this rule for
2583 * @center_freq: Frequency in KHz for which we want regulatory information for
2584 * @desired_bw_khz: the desired max bandwidth you want to use per
2585 * channel. Note that this is still 20 MHz if you want to use HT40
2586 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2587 * If set to 0 we'll assume you want the standard 20 MHz.
2588 * @reg_rule: the regulatory rule which we have for this frequency
2590 * Use this function to get the regulatory rule for a specific frequency on
2591 * a given wireless device. If the device has a specific regulatory domain
2592 * it wants to follow we respect that unless a country IE has been received
2593 * and processed already.
2595 * Returns 0 if it was able to find a valid regulatory rule which does
2596 * apply to the given center_freq otherwise it returns non-zero. It will
2597 * also return -ERANGE if we determine the given center_freq does not even have
2598 * a regulatory rule for a frequency range in the center_freq's band. See
2599 * freq_in_rule_band() for our current definition of a band -- this is purely
2600 * subjective and right now its 802.11 specific.
2602 extern int freq_reg_info(struct wiphy *wiphy,
2603 u32 center_freq,
2604 u32 desired_bw_khz,
2605 const struct ieee80211_reg_rule **reg_rule);
2608 * callbacks for asynchronous cfg80211 methods, notification
2609 * functions and BSS handling helpers
2613 * cfg80211_scan_done - notify that scan finished
2615 * @request: the corresponding scan request
2616 * @aborted: set to true if the scan was aborted for any reason,
2617 * userspace will be notified of that
2619 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2622 * cfg80211_sched_scan_results - notify that new scan results are available
2624 * @wiphy: the wiphy which got scheduled scan results
2626 void cfg80211_sched_scan_results(struct wiphy *wiphy);
2629 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2631 * @wiphy: the wiphy on which the scheduled scan stopped
2633 * The driver can call this function to inform cfg80211 that the
2634 * scheduled scan had to be stopped, for whatever reason. The driver
2635 * is then called back via the sched_scan_stop operation when done.
2637 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
2640 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2642 * @wiphy: the wiphy reporting the BSS
2643 * @channel: The channel the frame was received on
2644 * @mgmt: the management frame (probe response or beacon)
2645 * @len: length of the management frame
2646 * @signal: the signal strength, type depends on the wiphy's signal_type
2647 * @gfp: context flags
2649 * This informs cfg80211 that BSS information was found and
2650 * the BSS should be updated/added.
2652 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2654 struct cfg80211_bss * __must_check
2655 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2656 struct ieee80211_channel *channel,
2657 struct ieee80211_mgmt *mgmt, size_t len,
2658 s32 signal, gfp_t gfp);
2661 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2663 * @wiphy: the wiphy reporting the BSS
2664 * @channel: The channel the frame was received on
2665 * @bssid: the BSSID of the BSS
2666 * @timestamp: the TSF timestamp sent by the peer
2667 * @capability: the capability field sent by the peer
2668 * @beacon_interval: the beacon interval announced by the peer
2669 * @ie: additional IEs sent by the peer
2670 * @ielen: length of the additional IEs
2671 * @signal: the signal strength, type depends on the wiphy's signal_type
2672 * @gfp: context flags
2674 * This informs cfg80211 that BSS information was found and
2675 * the BSS should be updated/added.
2677 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2679 struct cfg80211_bss * __must_check
2680 cfg80211_inform_bss(struct wiphy *wiphy,
2681 struct ieee80211_channel *channel,
2682 const u8 *bssid,
2683 u64 timestamp, u16 capability, u16 beacon_interval,
2684 const u8 *ie, size_t ielen,
2685 s32 signal, gfp_t gfp);
2687 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2688 struct ieee80211_channel *channel,
2689 const u8 *bssid,
2690 const u8 *ssid, size_t ssid_len,
2691 u16 capa_mask, u16 capa_val);
2692 static inline struct cfg80211_bss *
2693 cfg80211_get_ibss(struct wiphy *wiphy,
2694 struct ieee80211_channel *channel,
2695 const u8 *ssid, size_t ssid_len)
2697 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2698 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2701 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2702 struct ieee80211_channel *channel,
2703 const u8 *meshid, size_t meshidlen,
2704 const u8 *meshcfg);
2705 void cfg80211_put_bss(struct cfg80211_bss *bss);
2708 * cfg80211_unlink_bss - unlink BSS from internal data structures
2709 * @wiphy: the wiphy
2710 * @bss: the bss to remove
2712 * This function removes the given BSS from the internal data structures
2713 * thereby making it no longer show up in scan results etc. Use this
2714 * function when you detect a BSS is gone. Normally BSSes will also time
2715 * out, so it is not necessary to use this function at all.
2717 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2720 * cfg80211_send_rx_auth - notification of processed authentication
2721 * @dev: network device
2722 * @buf: authentication frame (header + body)
2723 * @len: length of the frame data
2725 * This function is called whenever an authentication has been processed in
2726 * station mode. The driver is required to call either this function or
2727 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2728 * call. This function may sleep.
2730 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2733 * cfg80211_send_auth_timeout - notification of timed out authentication
2734 * @dev: network device
2735 * @addr: The MAC address of the device with which the authentication timed out
2737 * This function may sleep.
2739 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2742 * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
2743 * @dev: network device
2744 * @addr: The MAC address of the device with which the authentication timed out
2746 * When a pending authentication had no action yet, the driver may decide
2747 * to not send a deauth frame, but in that case must calls this function
2748 * to tell cfg80211 about this decision. It is only valid to call this
2749 * function within the deauth() callback.
2751 void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
2754 * cfg80211_send_rx_assoc - notification of processed association
2755 * @dev: network device
2756 * @buf: (re)association response frame (header + body)
2757 * @len: length of the frame data
2759 * This function is called whenever a (re)association response has been
2760 * processed in station mode. The driver is required to call either this
2761 * function or cfg80211_send_assoc_timeout() to indicate the result of
2762 * cfg80211_ops::assoc() call. This function may sleep.
2764 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
2767 * cfg80211_send_assoc_timeout - notification of timed out association
2768 * @dev: network device
2769 * @addr: The MAC address of the device with which the association timed out
2771 * This function may sleep.
2773 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2776 * cfg80211_send_deauth - notification of processed deauthentication
2777 * @dev: network device
2778 * @buf: deauthentication frame (header + body)
2779 * @len: length of the frame data
2781 * This function is called whenever deauthentication has been processed in
2782 * station mode. This includes both received deauthentication frames and
2783 * locally generated ones. This function may sleep.
2785 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2788 * __cfg80211_send_deauth - notification of processed deauthentication
2789 * @dev: network device
2790 * @buf: deauthentication frame (header + body)
2791 * @len: length of the frame data
2793 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2795 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2798 * cfg80211_send_disassoc - notification of processed disassociation
2799 * @dev: network device
2800 * @buf: disassociation response frame (header + body)
2801 * @len: length of the frame data
2803 * This function is called whenever disassociation has been processed in
2804 * station mode. This includes both received disassociation frames and locally
2805 * generated ones. This function may sleep.
2807 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2810 * __cfg80211_send_disassoc - notification of processed disassociation
2811 * @dev: network device
2812 * @buf: disassociation response frame (header + body)
2813 * @len: length of the frame data
2815 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2817 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2818 size_t len);
2821 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2822 * @dev: network device
2823 * @buf: deauthentication frame (header + body)
2824 * @len: length of the frame data
2826 * This function is called whenever a received Deauthentication frame has been
2827 * dropped in station mode because of MFP being used but the Deauthentication
2828 * frame was not protected. This function may sleep.
2830 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
2831 size_t len);
2834 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2835 * @dev: network device
2836 * @buf: disassociation frame (header + body)
2837 * @len: length of the frame data
2839 * This function is called whenever a received Disassociation frame has been
2840 * dropped in station mode because of MFP being used but the Disassociation
2841 * frame was not protected. This function may sleep.
2843 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
2844 size_t len);
2847 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2848 * @dev: network device
2849 * @addr: The source MAC address of the frame
2850 * @key_type: The key type that the received frame used
2851 * @key_id: Key identifier (0..3). Can be -1 if missing.
2852 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2853 * @gfp: allocation flags
2855 * This function is called whenever the local MAC detects a MIC failure in a
2856 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2857 * primitive.
2859 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2860 enum nl80211_key_type key_type, int key_id,
2861 const u8 *tsc, gfp_t gfp);
2864 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2866 * @dev: network device
2867 * @bssid: the BSSID of the IBSS joined
2868 * @gfp: allocation flags
2870 * This function notifies cfg80211 that the device joined an IBSS or
2871 * switched to a different BSSID. Before this function can be called,
2872 * either a beacon has to have been received from the IBSS, or one of
2873 * the cfg80211_inform_bss{,_frame} functions must have been called
2874 * with the locally generated beacon -- this guarantees that there is
2875 * always a scan result for this IBSS. cfg80211 will handle the rest.
2877 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2880 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
2882 * @dev: network device
2883 * @macaddr: the MAC address of the new candidate
2884 * @ie: information elements advertised by the peer candidate
2885 * @ie_len: lenght of the information elements buffer
2886 * @gfp: allocation flags
2888 * This function notifies cfg80211 that the mesh peer candidate has been
2889 * detected, most likely via a beacon or, less likely, via a probe response.
2890 * cfg80211 then sends a notification to userspace.
2892 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
2893 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
2896 * DOC: RFkill integration
2898 * RFkill integration in cfg80211 is almost invisible to drivers,
2899 * as cfg80211 automatically registers an rfkill instance for each
2900 * wireless device it knows about. Soft kill is also translated
2901 * into disconnecting and turning all interfaces off, drivers are
2902 * expected to turn off the device when all interfaces are down.
2904 * However, devices may have a hard RFkill line, in which case they
2905 * also need to interact with the rfkill subsystem, via cfg80211.
2906 * They can do this with a few helper functions documented here.
2910 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2911 * @wiphy: the wiphy
2912 * @blocked: block status
2914 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2917 * wiphy_rfkill_start_polling - start polling rfkill
2918 * @wiphy: the wiphy
2920 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2923 * wiphy_rfkill_stop_polling - stop polling rfkill
2924 * @wiphy: the wiphy
2926 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2928 #ifdef CONFIG_NL80211_TESTMODE
2930 * DOC: Test mode
2932 * Test mode is a set of utility functions to allow drivers to
2933 * interact with driver-specific tools to aid, for instance,
2934 * factory programming.
2936 * This chapter describes how drivers interact with it, for more
2937 * information see the nl80211 book's chapter on it.
2941 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2942 * @wiphy: the wiphy
2943 * @approxlen: an upper bound of the length of the data that will
2944 * be put into the skb
2946 * This function allocates and pre-fills an skb for a reply to
2947 * the testmode command. Since it is intended for a reply, calling
2948 * it outside of the @testmode_cmd operation is invalid.
2950 * The returned skb (or %NULL if any errors happen) is pre-filled
2951 * with the wiphy index and set up in a way that any data that is
2952 * put into the skb (with skb_put(), nla_put() or similar) will end
2953 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2954 * needs to be done with the skb is adding data for the corresponding
2955 * userspace tool which can then read that data out of the testdata
2956 * attribute. You must not modify the skb in any other way.
2958 * When done, call cfg80211_testmode_reply() with the skb and return
2959 * its error code as the result of the @testmode_cmd operation.
2961 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
2962 int approxlen);
2965 * cfg80211_testmode_reply - send the reply skb
2966 * @skb: The skb, must have been allocated with
2967 * cfg80211_testmode_alloc_reply_skb()
2969 * Returns an error code or 0 on success, since calling this
2970 * function will usually be the last thing before returning
2971 * from the @testmode_cmd you should return the error code.
2972 * Note that this function consumes the skb regardless of the
2973 * return value.
2975 int cfg80211_testmode_reply(struct sk_buff *skb);
2978 * cfg80211_testmode_alloc_event_skb - allocate testmode event
2979 * @wiphy: the wiphy
2980 * @approxlen: an upper bound of the length of the data that will
2981 * be put into the skb
2982 * @gfp: allocation flags
2984 * This function allocates and pre-fills an skb for an event on the
2985 * testmode multicast group.
2987 * The returned skb (or %NULL if any errors happen) is set up in the
2988 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2989 * for an event. As there, you should simply add data to it that will
2990 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2991 * not modify the skb in any other way.
2993 * When done filling the skb, call cfg80211_testmode_event() with the
2994 * skb to send the event.
2996 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
2997 int approxlen, gfp_t gfp);
3000 * cfg80211_testmode_event - send the event
3001 * @skb: The skb, must have been allocated with
3002 * cfg80211_testmode_alloc_event_skb()
3003 * @gfp: allocation flags
3005 * This function sends the given @skb, which must have been allocated
3006 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3007 * consumes it.
3009 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3011 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3012 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3013 #else
3014 #define CFG80211_TESTMODE_CMD(cmd)
3015 #define CFG80211_TESTMODE_DUMP(cmd)
3016 #endif
3019 * cfg80211_connect_result - notify cfg80211 of connection result
3021 * @dev: network device
3022 * @bssid: the BSSID of the AP
3023 * @req_ie: association request IEs (maybe be %NULL)
3024 * @req_ie_len: association request IEs length
3025 * @resp_ie: association response IEs (may be %NULL)
3026 * @resp_ie_len: assoc response IEs length
3027 * @status: status code, 0 for successful connection, use
3028 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3029 * the real status code for failures.
3030 * @gfp: allocation flags
3032 * It should be called by the underlying driver whenever connect() has
3033 * succeeded.
3035 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3036 const u8 *req_ie, size_t req_ie_len,
3037 const u8 *resp_ie, size_t resp_ie_len,
3038 u16 status, gfp_t gfp);
3041 * cfg80211_roamed - notify cfg80211 of roaming
3043 * @dev: network device
3044 * @channel: the channel of the new AP
3045 * @bssid: the BSSID of the new AP
3046 * @req_ie: association request IEs (maybe be %NULL)
3047 * @req_ie_len: association request IEs length
3048 * @resp_ie: association response IEs (may be %NULL)
3049 * @resp_ie_len: assoc response IEs length
3050 * @gfp: allocation flags
3052 * It should be called by the underlying driver whenever it roamed
3053 * from one AP to another while connected.
3055 void cfg80211_roamed(struct net_device *dev,
3056 struct ieee80211_channel *channel,
3057 const u8 *bssid,
3058 const u8 *req_ie, size_t req_ie_len,
3059 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3062 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3064 * @dev: network device
3065 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3066 * @ie_len: length of IEs
3067 * @reason: reason code for the disconnection, set it to 0 if unknown
3068 * @gfp: allocation flags
3070 * After it calls this function, the driver should enter an idle state
3071 * and not try to connect to any AP any more.
3073 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3074 u8 *ie, size_t ie_len, gfp_t gfp);
3077 * cfg80211_ready_on_channel - notification of remain_on_channel start
3078 * @dev: network device
3079 * @cookie: the request cookie
3080 * @chan: The current channel (from remain_on_channel request)
3081 * @channel_type: Channel type
3082 * @duration: Duration in milliseconds that the driver intents to remain on the
3083 * channel
3084 * @gfp: allocation flags
3086 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
3087 struct ieee80211_channel *chan,
3088 enum nl80211_channel_type channel_type,
3089 unsigned int duration, gfp_t gfp);
3092 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3093 * @dev: network device
3094 * @cookie: the request cookie
3095 * @chan: The current channel (from remain_on_channel request)
3096 * @channel_type: Channel type
3097 * @gfp: allocation flags
3099 void cfg80211_remain_on_channel_expired(struct net_device *dev,
3100 u64 cookie,
3101 struct ieee80211_channel *chan,
3102 enum nl80211_channel_type channel_type,
3103 gfp_t gfp);
3107 * cfg80211_new_sta - notify userspace about station
3109 * @dev: the netdev
3110 * @mac_addr: the station's address
3111 * @sinfo: the station information
3112 * @gfp: allocation flags
3114 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3115 struct station_info *sinfo, gfp_t gfp);
3118 * cfg80211_del_sta - notify userspace about deletion of a station
3120 * @dev: the netdev
3121 * @mac_addr: the station's address
3122 * @gfp: allocation flags
3124 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3127 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3128 * @dev: network device
3129 * @freq: Frequency on which the frame was received in MHz
3130 * @buf: Management frame (header + body)
3131 * @len: length of the frame data
3132 * @gfp: context flags
3134 * Returns %true if a user space application has registered for this frame.
3135 * For action frames, that makes it responsible for rejecting unrecognized
3136 * action frames; %false otherwise, in which case for action frames the
3137 * driver is responsible for rejecting the frame.
3139 * This function is called whenever an Action frame is received for a station
3140 * mode interface, but is not processed in kernel.
3142 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, const u8 *buf,
3143 size_t len, gfp_t gfp);
3146 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3147 * @dev: network device
3148 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3149 * @buf: Management frame (header + body)
3150 * @len: length of the frame data
3151 * @ack: Whether frame was acknowledged
3152 * @gfp: context flags
3154 * This function is called whenever a management frame was requested to be
3155 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3156 * transmission attempt.
3158 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
3159 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3163 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3164 * @dev: network device
3165 * @rssi_event: the triggered RSSI event
3166 * @gfp: context flags
3168 * This function is called when a configured connection quality monitoring
3169 * rssi threshold reached event occurs.
3171 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3172 enum nl80211_cqm_rssi_threshold_event rssi_event,
3173 gfp_t gfp);
3176 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3177 * @dev: network device
3178 * @peer: peer's MAC address
3179 * @num_packets: how many packets were lost -- should be a fixed threshold
3180 * but probably no less than maybe 50, or maybe a throughput dependent
3181 * threshold (to account for temporary interference)
3182 * @gfp: context flags
3184 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3185 const u8 *peer, u32 num_packets, gfp_t gfp);
3188 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3189 * @dev: network device
3190 * @bssid: BSSID of AP (to avoid races)
3191 * @replay_ctr: new replay counter
3192 * @gfp: allocation flags
3194 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3195 const u8 *replay_ctr, gfp_t gfp);
3198 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3199 * @dev: network device
3200 * @index: candidate index (the smaller the index, the higher the priority)
3201 * @bssid: BSSID of AP
3202 * @preauth: Whether AP advertises support for RSN pre-authentication
3203 * @gfp: allocation flags
3205 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3206 const u8 *bssid, bool preauth, gfp_t gfp);
3209 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3210 * @dev: The device the frame matched to
3211 * @addr: the transmitter address
3212 * @gfp: context flags
3214 * This function is used in AP mode (only!) to inform userspace that
3215 * a spurious class 3 frame was received, to be able to deauth the
3216 * sender.
3217 * Returns %true if the frame was passed to userspace (or this failed
3218 * for a reason other than not having a subscription.)
3220 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3221 const u8 *addr, gfp_t gfp);
3224 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3225 * @dev: The device the frame matched to
3226 * @addr: the transmitter address
3227 * @gfp: context flags
3229 * This function is used in AP mode (only!) to inform userspace that
3230 * an associated station sent a 4addr frame but that wasn't expected.
3231 * It is allowed and desirable to send this event only once for each
3232 * station to avoid event flooding.
3233 * Returns %true if the frame was passed to userspace (or this failed
3234 * for a reason other than not having a subscription.)
3236 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3237 const u8 *addr, gfp_t gfp);
3240 * cfg80211_probe_status - notify userspace about probe status
3241 * @dev: the device the probe was sent on
3242 * @addr: the address of the peer
3243 * @cookie: the cookie filled in @probe_client previously
3244 * @acked: indicates whether probe was acked or not
3245 * @gfp: allocation flags
3247 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3248 u64 cookie, bool acked, gfp_t gfp);
3251 * cfg80211_report_obss_beacon - report beacon from other APs
3252 * @wiphy: The wiphy that received the beacon
3253 * @frame: the frame
3254 * @len: length of the frame
3255 * @freq: frequency the frame was received on
3256 * @gfp: allocation flags
3258 * Use this function to report to userspace when a beacon was
3259 * received. It is not useful to call this when there is no
3260 * netdev that is in AP/GO mode.
3262 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3263 const u8 *frame, size_t len,
3264 int freq, gfp_t gfp);
3266 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3268 /* wiphy_printk helpers, similar to dev_printk */
3270 #define wiphy_printk(level, wiphy, format, args...) \
3271 dev_printk(level, &(wiphy)->dev, format, ##args)
3272 #define wiphy_emerg(wiphy, format, args...) \
3273 dev_emerg(&(wiphy)->dev, format, ##args)
3274 #define wiphy_alert(wiphy, format, args...) \
3275 dev_alert(&(wiphy)->dev, format, ##args)
3276 #define wiphy_crit(wiphy, format, args...) \
3277 dev_crit(&(wiphy)->dev, format, ##args)
3278 #define wiphy_err(wiphy, format, args...) \
3279 dev_err(&(wiphy)->dev, format, ##args)
3280 #define wiphy_warn(wiphy, format, args...) \
3281 dev_warn(&(wiphy)->dev, format, ##args)
3282 #define wiphy_notice(wiphy, format, args...) \
3283 dev_notice(&(wiphy)->dev, format, ##args)
3284 #define wiphy_info(wiphy, format, args...) \
3285 dev_info(&(wiphy)->dev, format, ##args)
3287 #define wiphy_debug(wiphy, format, args...) \
3288 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3290 #define wiphy_dbg(wiphy, format, args...) \
3291 dev_dbg(&(wiphy)->dev, format, ##args)
3293 #if defined(VERBOSE_DEBUG)
3294 #define wiphy_vdbg wiphy_dbg
3295 #else
3296 #define wiphy_vdbg(wiphy, format, args...) \
3297 ({ \
3298 if (0) \
3299 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3300 0; \
3302 #endif
3305 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3306 * of using a WARN/WARN_ON to get the message out, including the
3307 * file/line information and a backtrace.
3309 #define wiphy_WARN(wiphy, format, args...) \
3310 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3312 #endif /* __NET_CFG80211_H */