1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
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/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <net/regulatory.h>
27 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
28 * userspace and drivers, and offers some utility functionality associated
29 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
30 * by all modern wireless drivers in Linux, so that they offer a consistent
31 * API through nl80211. For backward compatibility, cfg80211 also offers
32 * wireless extensions to userspace, but hides them from drivers completely.
34 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
40 * DOC: Device registration
42 * In order for a driver to use cfg80211, it must register the hardware device
43 * with cfg80211. This happens through a number of hardware capability structs
46 * The fundamental structure for each device is the 'wiphy', of which each
47 * instance describes a physical wireless device connected to the system. Each
48 * such wiphy can have zero, one, or many virtual interfaces associated with
49 * it, which need to be identified as such by pointing the network interface's
50 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
51 * the wireless part of the interface, normally this struct is embedded in the
52 * network interface's private data area. Drivers can optionally allow creating
53 * or destroying virtual interfaces on the fly, but without at least one or the
54 * ability to create some the wireless device isn't useful.
56 * Each wiphy structure contains device capability information, and also has
57 * a pointer to the various operations the driver offers. The definitions and
58 * structures here describe these capabilities in detail.
62 * wireless hardware capability structures
66 * enum ieee80211_band - supported frequency bands
68 * The bands are assigned this way because the supported
69 * bitrates differ in these bands.
71 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
72 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
73 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
74 * @IEEE80211_NUM_BANDS: number of defined bands
77 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
78 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
79 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
86 * enum ieee80211_channel_flags - channel flags
88 * Channel flags set by the regulatory control code.
90 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
91 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
93 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
94 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
95 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
97 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
99 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
101 enum ieee80211_channel_flags {
102 IEEE80211_CHAN_DISABLED = 1<<0,
103 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
104 IEEE80211_CHAN_NO_IBSS = 1<<2,
105 IEEE80211_CHAN_RADAR = 1<<3,
106 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
107 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
108 IEEE80211_CHAN_NO_OFDM = 1<<6,
111 #define IEEE80211_CHAN_NO_HT40 \
112 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
115 * struct ieee80211_channel - channel definition
117 * This structure describes a single channel for use
120 * @center_freq: center frequency in MHz
121 * @hw_value: hardware-specific value for the channel
122 * @flags: channel flags from &enum ieee80211_channel_flags.
123 * @orig_flags: channel flags at registration time, used by regulatory
124 * code to support devices with additional restrictions
125 * @band: band this channel belongs to.
126 * @max_antenna_gain: maximum antenna gain in dBi
127 * @max_power: maximum transmission power (in dBm)
128 * @max_reg_power: maximum regulatory transmission power (in dBm)
129 * @beacon_found: helper to regulatory code to indicate when a beacon
130 * has been found on this channel. Use regulatory_hint_found_beacon()
131 * to enable this, this is useful only on 5 GHz band.
132 * @orig_mag: internal use
133 * @orig_mpwr: internal use
135 struct ieee80211_channel {
136 enum ieee80211_band band;
140 int max_antenna_gain;
145 int orig_mag, orig_mpwr;
149 * enum ieee80211_rate_flags - rate flags
151 * Hardware/specification flags for rates. These are structured
152 * in a way that allows using the same bitrate structure for
153 * different bands/PHY modes.
155 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
156 * preamble on this bitrate; only relevant in 2.4GHz band and
158 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
159 * when used with 802.11a (on the 5 GHz band); filled by the
160 * core code when registering the wiphy.
161 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
162 * when used with 802.11b (on the 2.4 GHz band); filled by the
163 * core code when registering the wiphy.
164 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
165 * when used with 802.11g (on the 2.4 GHz band); filled by the
166 * core code when registering the wiphy.
167 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
169 enum ieee80211_rate_flags {
170 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
171 IEEE80211_RATE_MANDATORY_A = 1<<1,
172 IEEE80211_RATE_MANDATORY_B = 1<<2,
173 IEEE80211_RATE_MANDATORY_G = 1<<3,
174 IEEE80211_RATE_ERP_G = 1<<4,
178 * struct ieee80211_rate - bitrate definition
180 * This structure describes a bitrate that an 802.11 PHY can
181 * operate with. The two values @hw_value and @hw_value_short
182 * are only for driver use when pointers to this structure are
185 * @flags: rate-specific flags
186 * @bitrate: bitrate in units of 100 Kbps
187 * @hw_value: driver/hardware value for this rate
188 * @hw_value_short: driver/hardware value for this rate when
189 * short preamble is used
191 struct ieee80211_rate {
194 u16 hw_value, hw_value_short;
198 * struct ieee80211_sta_ht_cap - STA's HT capabilities
200 * This structure describes most essential parameters needed
201 * to describe 802.11n HT capabilities for an STA.
203 * @ht_supported: is HT supported by the STA
204 * @cap: HT capabilities map as described in 802.11n spec
205 * @ampdu_factor: Maximum A-MPDU length factor
206 * @ampdu_density: Minimum A-MPDU spacing
207 * @mcs: Supported MCS rates
209 struct ieee80211_sta_ht_cap {
210 u16 cap; /* use IEEE80211_HT_CAP_ */
214 struct ieee80211_mcs_info mcs;
218 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
220 * This structure describes most essential parameters needed
221 * to describe 802.11ac VHT capabilities for an STA.
223 * @vht_supported: is VHT supported by the STA
224 * @cap: VHT capabilities map as described in 802.11ac spec
225 * @vht_mcs: Supported VHT MCS rates
227 struct ieee80211_sta_vht_cap {
229 u32 cap; /* use IEEE80211_VHT_CAP_ */
230 struct ieee80211_vht_mcs_info vht_mcs;
234 * struct ieee80211_supported_band - frequency band definition
236 * This structure describes a frequency band a wiphy
237 * is able to operate in.
239 * @channels: Array of channels the hardware can operate in
241 * @band: the band this structure represents
242 * @n_channels: Number of channels in @channels
243 * @bitrates: Array of bitrates the hardware can operate with
244 * in this band. Must be sorted to give a valid "supported
245 * rates" IE, i.e. CCK rates first, then OFDM.
246 * @n_bitrates: Number of bitrates in @bitrates
247 * @ht_cap: HT capabilities in this band
248 * @vht_cap: VHT capabilities in this band
250 struct ieee80211_supported_band {
251 struct ieee80211_channel *channels;
252 struct ieee80211_rate *bitrates;
253 enum ieee80211_band band;
256 struct ieee80211_sta_ht_cap ht_cap;
257 struct ieee80211_sta_vht_cap vht_cap;
261 * Wireless hardware/device configuration structures and methods
265 * DOC: Actions and configuration
267 * Each wireless device and each virtual interface offer a set of configuration
268 * operations and other actions that are invoked by userspace. Each of these
269 * actions is described in the operations structure, and the parameters these
270 * operations use are described separately.
272 * Additionally, some operations are asynchronous and expect to get status
273 * information via some functions that drivers need to call.
275 * Scanning and BSS list handling with its associated functionality is described
276 * in a separate chapter.
280 * struct vif_params - describes virtual interface parameters
281 * @use_4addr: use 4-address frames
288 * struct key_params - key information
290 * Information about a key
293 * @key_len: length of key material
294 * @cipher: cipher suite selector
295 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
296 * with the get_key() callback, must be in little endian,
297 * length given by @seq_len.
298 * @seq_len: length of @seq.
309 * enum survey_info_flags - survey information flags
311 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
312 * @SURVEY_INFO_IN_USE: channel is currently being used
313 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
314 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
315 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
316 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
317 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
319 * Used by the driver to indicate which info in &struct survey_info
320 * it has filled in during the get_survey().
322 enum survey_info_flags {
323 SURVEY_INFO_NOISE_DBM = 1<<0,
324 SURVEY_INFO_IN_USE = 1<<1,
325 SURVEY_INFO_CHANNEL_TIME = 1<<2,
326 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
327 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
328 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
329 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
333 * struct survey_info - channel survey response
335 * @channel: the channel this survey record reports, mandatory
336 * @filled: bitflag of flags from &enum survey_info_flags
337 * @noise: channel noise in dBm. This and all following fields are
339 * @channel_time: amount of time in ms the radio spent on the channel
340 * @channel_time_busy: amount of time the primary channel was sensed busy
341 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
342 * @channel_time_rx: amount of time the radio spent receiving data
343 * @channel_time_tx: amount of time the radio spent transmitting data
345 * Used by dump_survey() to report back per-channel survey information.
347 * This structure can later be expanded with things like
348 * channel duty cycle etc.
351 struct ieee80211_channel *channel;
353 u64 channel_time_busy;
354 u64 channel_time_ext_busy;
362 * struct cfg80211_crypto_settings - Crypto settings
363 * @wpa_versions: indicates which, if any, WPA versions are enabled
364 * (from enum nl80211_wpa_versions)
365 * @cipher_group: group key cipher suite (or 0 if unset)
366 * @n_ciphers_pairwise: number of AP supported unicast ciphers
367 * @ciphers_pairwise: unicast key cipher suites
368 * @n_akm_suites: number of AKM suites
369 * @akm_suites: AKM suites
370 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
371 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
372 * required to assume that the port is unauthorized until authorized by
373 * user space. Otherwise, port is marked authorized by default.
374 * @control_port_ethertype: the control port protocol that should be
375 * allowed through even on unauthorized ports
376 * @control_port_no_encrypt: TRUE to prevent encryption of control port
379 struct cfg80211_crypto_settings {
382 int n_ciphers_pairwise;
383 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
385 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
387 __be16 control_port_ethertype;
388 bool control_port_no_encrypt;
392 * struct cfg80211_beacon_data - beacon data
393 * @head: head portion of beacon (before TIM IE)
394 * or %NULL if not changed
395 * @tail: tail portion of beacon (after TIM IE)
396 * or %NULL if not changed
397 * @head_len: length of @head
398 * @tail_len: length of @tail
399 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
400 * @beacon_ies_len: length of beacon_ies in octets
401 * @proberesp_ies: extra information element(s) to add into Probe Response
403 * @proberesp_ies_len: length of proberesp_ies in octets
404 * @assocresp_ies: extra information element(s) to add into (Re)Association
405 * Response frames or %NULL
406 * @assocresp_ies_len: length of assocresp_ies in octets
407 * @probe_resp_len: length of probe response template (@probe_resp)
408 * @probe_resp: probe response template (AP mode only)
410 struct cfg80211_beacon_data {
411 const u8 *head, *tail;
412 const u8 *beacon_ies;
413 const u8 *proberesp_ies;
414 const u8 *assocresp_ies;
415 const u8 *probe_resp;
417 size_t head_len, tail_len;
418 size_t beacon_ies_len;
419 size_t proberesp_ies_len;
420 size_t assocresp_ies_len;
421 size_t probe_resp_len;
425 * struct cfg80211_ap_settings - AP configuration
427 * Used to configure an AP interface.
429 * @channel: the channel to start the AP on
430 * @channel_type: the channel type to use
431 * @beacon: beacon data
432 * @beacon_interval: beacon interval
433 * @dtim_period: DTIM period
434 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
436 * @ssid_len: length of @ssid
437 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
438 * @crypto: crypto settings
439 * @privacy: the BSS uses privacy
440 * @auth_type: Authentication type (algorithm)
441 * @inactivity_timeout: time in seconds to determine station's inactivity.
443 struct cfg80211_ap_settings {
444 struct ieee80211_channel *channel;
445 enum nl80211_channel_type channel_type;
447 struct cfg80211_beacon_data beacon;
449 int beacon_interval, dtim_period;
452 enum nl80211_hidden_ssid hidden_ssid;
453 struct cfg80211_crypto_settings crypto;
455 enum nl80211_auth_type auth_type;
456 int inactivity_timeout;
460 * enum plink_action - actions to perform in mesh peers
462 * @PLINK_ACTION_INVALID: action 0 is reserved
463 * @PLINK_ACTION_OPEN: start mesh peer link establishment
464 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
467 PLINK_ACTION_INVALID,
473 * enum station_parameters_apply_mask - station parameter values to apply
474 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
476 * Not all station parameters have in-band "no change" signalling,
477 * for those that don't these flags will are used.
479 enum station_parameters_apply_mask {
480 STATION_PARAM_APPLY_UAPSD = BIT(0),
484 * struct station_parameters - station parameters
486 * Used to change and create a new station.
488 * @vlan: vlan interface station should belong to
489 * @supported_rates: supported rates in IEEE 802.11 format
490 * (or NULL for no change)
491 * @supported_rates_len: number of supported rates
492 * @sta_flags_mask: station flags that changed
493 * (bitmask of BIT(NL80211_STA_FLAG_...))
494 * @sta_flags_set: station flags values
495 * (bitmask of BIT(NL80211_STA_FLAG_...))
496 * @listen_interval: listen interval or -1 for no change
497 * @aid: AID or zero for no change
498 * @plink_action: plink action to take
499 * @plink_state: set the peer link state for a station
500 * @ht_capa: HT capabilities of station
501 * @uapsd_queues: bitmap of queues configured for uapsd. same format
502 * as the AC bitmap in the QoS info field
503 * @max_sp: max Service Period. same format as the MAX_SP in the
504 * QoS info field (but already shifted down)
505 * @sta_modify_mask: bitmap indicating which parameters changed
506 * (for those that don't have a natural "no change" value),
507 * see &enum station_parameters_apply_mask
509 struct station_parameters {
511 struct net_device *vlan;
512 u32 sta_flags_mask, sta_flags_set;
516 u8 supported_rates_len;
519 struct ieee80211_ht_cap *ht_capa;
525 * enum station_info_flags - station information flags
527 * Used by the driver to indicate which info in &struct station_info
528 * it has filled in during get_station() or dump_station().
530 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
531 * @STATION_INFO_RX_BYTES: @rx_bytes filled
532 * @STATION_INFO_TX_BYTES: @tx_bytes filled
533 * @STATION_INFO_LLID: @llid filled
534 * @STATION_INFO_PLID: @plid filled
535 * @STATION_INFO_PLINK_STATE: @plink_state filled
536 * @STATION_INFO_SIGNAL: @signal filled
537 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
538 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
539 * @STATION_INFO_RX_PACKETS: @rx_packets filled
540 * @STATION_INFO_TX_PACKETS: @tx_packets filled
541 * @STATION_INFO_TX_RETRIES: @tx_retries filled
542 * @STATION_INFO_TX_FAILED: @tx_failed filled
543 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
544 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
545 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
546 * @STATION_INFO_BSS_PARAM: @bss_param filled
547 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
548 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
549 * @STATION_INFO_STA_FLAGS: @sta_flags filled
550 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
551 * @STATION_INFO_T_OFFSET: @t_offset filled
553 enum station_info_flags {
554 STATION_INFO_INACTIVE_TIME = 1<<0,
555 STATION_INFO_RX_BYTES = 1<<1,
556 STATION_INFO_TX_BYTES = 1<<2,
557 STATION_INFO_LLID = 1<<3,
558 STATION_INFO_PLID = 1<<4,
559 STATION_INFO_PLINK_STATE = 1<<5,
560 STATION_INFO_SIGNAL = 1<<6,
561 STATION_INFO_TX_BITRATE = 1<<7,
562 STATION_INFO_RX_PACKETS = 1<<8,
563 STATION_INFO_TX_PACKETS = 1<<9,
564 STATION_INFO_TX_RETRIES = 1<<10,
565 STATION_INFO_TX_FAILED = 1<<11,
566 STATION_INFO_RX_DROP_MISC = 1<<12,
567 STATION_INFO_SIGNAL_AVG = 1<<13,
568 STATION_INFO_RX_BITRATE = 1<<14,
569 STATION_INFO_BSS_PARAM = 1<<15,
570 STATION_INFO_CONNECTED_TIME = 1<<16,
571 STATION_INFO_ASSOC_REQ_IES = 1<<17,
572 STATION_INFO_STA_FLAGS = 1<<18,
573 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
574 STATION_INFO_T_OFFSET = 1<<20,
578 * enum station_info_rate_flags - bitrate info flags
580 * Used by the driver to indicate the specific rate transmission
581 * type for 802.11n transmissions.
583 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
584 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
585 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
586 * @RATE_INFO_FLAGS_60G: 60gHz MCS
588 enum rate_info_flags {
589 RATE_INFO_FLAGS_MCS = 1<<0,
590 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
591 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
592 RATE_INFO_FLAGS_60G = 1<<3,
596 * struct rate_info - bitrate information
598 * Information about a receiving or transmitting bitrate
600 * @flags: bitflag of flags from &enum rate_info_flags
601 * @mcs: mcs index if struct describes a 802.11n bitrate
602 * @legacy: bitrate in 100kbit/s for 802.11abg
611 * enum station_info_rate_flags - bitrate info flags
613 * Used by the driver to indicate the specific rate transmission
614 * type for 802.11n transmissions.
616 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
617 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
618 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
620 enum bss_param_flags {
621 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
622 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
623 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
627 * struct sta_bss_parameters - BSS parameters for the attached station
629 * Information about the currently associated BSS
631 * @flags: bitflag of flags from &enum bss_param_flags
632 * @dtim_period: DTIM period for the BSS
633 * @beacon_interval: beacon interval
635 struct sta_bss_parameters {
642 * struct station_info - station information
644 * Station information filled by driver for get_station() and dump_station.
646 * @filled: bitflag of flags from &enum station_info_flags
647 * @connected_time: time(in secs) since a station is last connected
648 * @inactive_time: time since last station activity (tx/rx) in milliseconds
649 * @rx_bytes: bytes received from this station
650 * @tx_bytes: bytes transmitted to this station
651 * @llid: mesh local link id
652 * @plid: mesh peer link id
653 * @plink_state: mesh peer link state
654 * @signal: The signal strength, type depends on the wiphy's signal_type.
655 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
656 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
657 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
658 * @txrate: current unicast bitrate from this station
659 * @rxrate: current unicast bitrate to this station
660 * @rx_packets: packets received from this station
661 * @tx_packets: packets transmitted to this station
662 * @tx_retries: cumulative retry counts
663 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
664 * @rx_dropped_misc: Dropped for un-specified reason.
665 * @bss_param: current BSS parameters
666 * @generation: generation number for nl80211 dumps.
667 * This number should increase every time the list of stations
668 * changes, i.e. when a station is added or removed, so that
669 * userspace can tell whether it got a consistent snapshot.
670 * @assoc_req_ies: IEs from (Re)Association Request.
671 * This is used only when in AP mode with drivers that do not use
672 * user space MLME/SME implementation. The information is provided for
673 * the cfg80211_new_sta() calls to notify user space of the IEs.
674 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
675 * @sta_flags: station flags mask & values
676 * @beacon_loss_count: Number of times beacon loss event has triggered.
677 * @t_offset: Time offset of the station relative to this host.
679 struct station_info {
690 struct rate_info txrate;
691 struct rate_info rxrate;
697 struct sta_bss_parameters bss_param;
698 struct nl80211_sta_flag_update sta_flags;
702 const u8 *assoc_req_ies;
703 size_t assoc_req_ies_len;
705 u32 beacon_loss_count;
709 * Note: Add a new enum station_info_flags value for each new field and
710 * use it to check which fields are initialized.
715 * enum monitor_flags - monitor flags
717 * Monitor interface configuration flags. Note that these must be the bits
718 * according to the nl80211 flags.
720 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
721 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
722 * @MONITOR_FLAG_CONTROL: pass control frames
723 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
724 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
727 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
728 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
729 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
730 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
731 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
735 * enum mpath_info_flags - mesh path information flags
737 * Used by the driver to indicate which info in &struct mpath_info it has filled
738 * in during get_station() or dump_station().
740 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
741 * @MPATH_INFO_SN: @sn filled
742 * @MPATH_INFO_METRIC: @metric filled
743 * @MPATH_INFO_EXPTIME: @exptime filled
744 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
745 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
746 * @MPATH_INFO_FLAGS: @flags filled
748 enum mpath_info_flags {
749 MPATH_INFO_FRAME_QLEN = BIT(0),
750 MPATH_INFO_SN = BIT(1),
751 MPATH_INFO_METRIC = BIT(2),
752 MPATH_INFO_EXPTIME = BIT(3),
753 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
754 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
755 MPATH_INFO_FLAGS = BIT(6),
759 * struct mpath_info - mesh path information
761 * Mesh path information filled by driver for get_mpath() and dump_mpath().
763 * @filled: bitfield of flags from &enum mpath_info_flags
764 * @frame_qlen: number of queued frames for this destination
765 * @sn: target sequence number
766 * @metric: metric (cost) of this mesh path
767 * @exptime: expiration time for the mesh path from now, in msecs
768 * @flags: mesh path flags
769 * @discovery_timeout: total mesh path discovery timeout, in msecs
770 * @discovery_retries: mesh path discovery retries
771 * @generation: generation number for nl80211 dumps.
772 * This number should increase every time the list of mesh paths
773 * changes, i.e. when a station is added or removed, so that
774 * userspace can tell whether it got a consistent snapshot.
782 u32 discovery_timeout;
783 u8 discovery_retries;
790 * struct bss_parameters - BSS parameters
792 * Used to change BSS parameters (mainly for AP mode).
794 * @use_cts_prot: Whether to use CTS protection
795 * (0 = no, 1 = yes, -1 = do not change)
796 * @use_short_preamble: Whether the use of short preambles is allowed
797 * (0 = no, 1 = yes, -1 = do not change)
798 * @use_short_slot_time: Whether the use of short slot time is allowed
799 * (0 = no, 1 = yes, -1 = do not change)
800 * @basic_rates: basic rates in IEEE 802.11 format
801 * (or NULL for no change)
802 * @basic_rates_len: number of basic rates
803 * @ap_isolate: do not forward packets between connected stations
804 * @ht_opmode: HT Operation mode
805 * (u16 = opmode, -1 = do not change)
807 struct bss_parameters {
809 int use_short_preamble;
810 int use_short_slot_time;
818 * struct mesh_config - 802.11s mesh configuration
820 * These parameters can be changed while the mesh is active.
822 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
823 * by the Mesh Peering Open message
824 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
825 * used by the Mesh Peering Open message
826 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
827 * the mesh peering management to close a mesh peering
828 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
830 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
831 * be sent to establish a new peer link instance in a mesh
832 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
833 * @element_ttl: the value of TTL field set at a mesh STA for path selection
835 * @auto_open_plinks: whether we should automatically open peer links when we
836 * detect compatible mesh peers
837 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
838 * synchronize to for 11s default synchronization method
839 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
840 * that an originator mesh STA can send to a particular path target
841 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
842 * @min_discovery_timeout: the minimum length of time to wait until giving up on
843 * a path discovery in milliseconds
844 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
845 * receiving a PREQ shall consider the forwarding information from the
846 * root to be valid. (TU = time unit)
847 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
848 * which a mesh STA can send only one action frame containing a PREQ
850 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
851 * which a mesh STA can send only one Action frame containing a PERR
853 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
854 * it takes for an HWMP information element to propagate across the mesh
855 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
856 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
857 * announcements are transmitted
858 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
859 * station has access to a broader network beyond the MBSS. (This is
860 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
861 * only means that the station will announce others it's a mesh gate, but
862 * not necessarily using the gate announcement protocol. Still keeping the
863 * same nomenclature to be in sync with the spec)
864 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
865 * entity (default is TRUE - forwarding entity)
866 * @rssi_threshold: the threshold for average signal strength of candidate
867 * station to establish a peer link
868 * @ht_opmode: mesh HT protection mode
870 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
871 * receiving a proactive PREQ shall consider the forwarding information to
872 * the root mesh STA to be valid.
874 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
875 * PREQs are transmitted.
876 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
877 * during which a mesh STA can send only one Action frame containing
878 * a PREQ element for root path confirmation.
881 u16 dot11MeshRetryTimeout;
882 u16 dot11MeshConfirmTimeout;
883 u16 dot11MeshHoldingTimeout;
884 u16 dot11MeshMaxPeerLinks;
885 u8 dot11MeshMaxRetries;
888 bool auto_open_plinks;
889 u32 dot11MeshNbrOffsetMaxNeighbor;
890 u8 dot11MeshHWMPmaxPREQretries;
891 u32 path_refresh_time;
892 u16 min_discovery_timeout;
893 u32 dot11MeshHWMPactivePathTimeout;
894 u16 dot11MeshHWMPpreqMinInterval;
895 u16 dot11MeshHWMPperrMinInterval;
896 u16 dot11MeshHWMPnetDiameterTraversalTime;
897 u8 dot11MeshHWMPRootMode;
898 u16 dot11MeshHWMPRannInterval;
899 bool dot11MeshGateAnnouncementProtocol;
900 bool dot11MeshForwarding;
903 u32 dot11MeshHWMPactivePathToRootTimeout;
904 u16 dot11MeshHWMProotInterval;
905 u16 dot11MeshHWMPconfirmationInterval;
909 * struct mesh_setup - 802.11s mesh setup configuration
910 * @channel: the channel to start the mesh network on
911 * @channel_type: the channel type to use
912 * @mesh_id: the mesh ID
913 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
914 * @sync_method: which synchronization method to use
915 * @path_sel_proto: which path selection protocol to use
916 * @path_metric: which metric to use
917 * @ie: vendor information elements (optional)
918 * @ie_len: length of vendor information elements
919 * @is_authenticated: this mesh requires authentication
920 * @is_secure: this mesh uses security
921 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
923 * These parameters are fixed when the mesh is created.
926 struct ieee80211_channel *channel;
927 enum nl80211_channel_type channel_type;
935 bool is_authenticated;
937 int mcast_rate[IEEE80211_NUM_BANDS];
941 * struct ieee80211_txq_params - TX queue parameters
943 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
944 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
946 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
948 * @aifs: Arbitration interframe space [0..255]
950 struct ieee80211_txq_params {
958 /* from net/wireless.h */
962 * DOC: Scanning and BSS list handling
964 * The scanning process itself is fairly simple, but cfg80211 offers quite
965 * a bit of helper functionality. To start a scan, the scan operation will
966 * be invoked with a scan definition. This scan definition contains the
967 * channels to scan, and the SSIDs to send probe requests for (including the
968 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
969 * probe. Additionally, a scan request may contain extra information elements
970 * that should be added to the probe request. The IEs are guaranteed to be
971 * well-formed, and will not exceed the maximum length the driver advertised
972 * in the wiphy structure.
974 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
975 * it is responsible for maintaining the BSS list; the driver should not
976 * maintain a list itself. For this notification, various functions exist.
978 * Since drivers do not maintain a BSS list, there are also a number of
979 * functions to search for a BSS and obtain information about it from the
980 * BSS structure cfg80211 maintains. The BSS list is also made available
985 * struct cfg80211_ssid - SSID description
987 * @ssid_len: length of the ssid
989 struct cfg80211_ssid {
990 u8 ssid[IEEE80211_MAX_SSID_LEN];
995 * struct cfg80211_scan_request - scan request description
997 * @ssids: SSIDs to scan for (active scan only)
998 * @n_ssids: number of SSIDs
999 * @channels: channels to scan on.
1000 * @n_channels: total number of channels to scan
1001 * @ie: optional information element(s) to add into Probe Request or %NULL
1002 * @ie_len: length of ie in octets
1003 * @rates: bitmap of rates to advertise for each band
1004 * @wiphy: the wiphy this was for
1005 * @wdev: the wireless device to scan for
1006 * @aborted: (internal) scan request was notified as aborted
1007 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1009 struct cfg80211_scan_request {
1010 struct cfg80211_ssid *ssids;
1016 u32 rates[IEEE80211_NUM_BANDS];
1018 struct wireless_dev *wdev;
1021 struct wiphy *wiphy;
1026 struct ieee80211_channel *channels[0];
1030 * struct cfg80211_match_set - sets of attributes to match
1032 * @ssid: SSID to be matched
1034 struct cfg80211_match_set {
1035 struct cfg80211_ssid ssid;
1039 * struct cfg80211_sched_scan_request - scheduled scan request description
1041 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1042 * @n_ssids: number of SSIDs
1043 * @n_channels: total number of channels to scan
1044 * @interval: interval between each scheduled scan cycle
1045 * @ie: optional information element(s) to add into Probe Request or %NULL
1046 * @ie_len: length of ie in octets
1047 * @match_sets: sets of parameters to be matched for a scan result
1048 * entry to be considered valid and to be passed to the host
1049 * (others are filtered out).
1050 * If ommited, all results are passed.
1051 * @n_match_sets: number of match sets
1052 * @wiphy: the wiphy this was for
1053 * @dev: the interface
1054 * @channels: channels to scan
1055 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1057 struct cfg80211_sched_scan_request {
1058 struct cfg80211_ssid *ssids;
1064 struct cfg80211_match_set *match_sets;
1069 struct wiphy *wiphy;
1070 struct net_device *dev;
1073 struct ieee80211_channel *channels[0];
1077 * enum cfg80211_signal_type - signal type
1079 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1080 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1081 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1083 enum cfg80211_signal_type {
1084 CFG80211_SIGNAL_TYPE_NONE,
1085 CFG80211_SIGNAL_TYPE_MBM,
1086 CFG80211_SIGNAL_TYPE_UNSPEC,
1090 * struct cfg80211_bss - BSS description
1092 * This structure describes a BSS (which may also be a mesh network)
1093 * for use in scan results and similar.
1095 * @channel: channel this BSS is on
1096 * @bssid: BSSID of the BSS
1097 * @tsf: timestamp of last received update
1098 * @beacon_interval: the beacon interval as from the frame
1099 * @capability: the capability field in host byte order
1100 * @information_elements: the information elements (Note that there
1101 * is no guarantee that these are well-formed!); this is a pointer to
1102 * either the beacon_ies or proberesp_ies depending on whether Probe
1103 * Response frame has been received
1104 * @len_information_elements: total length of the information elements
1105 * @beacon_ies: the information elements from the last Beacon frame
1106 * @len_beacon_ies: total length of the beacon_ies
1107 * @proberesp_ies: the information elements from the last Probe Response frame
1108 * @len_proberesp_ies: total length of the proberesp_ies
1109 * @signal: signal strength value (type depends on the wiphy's signal_type)
1110 * @free_priv: function pointer to free private data
1111 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1113 struct cfg80211_bss {
1114 struct ieee80211_channel *channel;
1118 u16 beacon_interval;
1120 u8 *information_elements;
1121 size_t len_information_elements;
1123 size_t len_beacon_ies;
1125 size_t len_proberesp_ies;
1129 void (*free_priv)(struct cfg80211_bss *bss);
1130 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
1134 * ieee80211_bss_get_ie - find IE with given ID
1135 * @bss: the bss to search
1137 * Returns %NULL if not found.
1139 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1143 * struct cfg80211_auth_request - Authentication request data
1145 * This structure provides information needed to complete IEEE 802.11
1148 * @bss: The BSS to authenticate with.
1149 * @auth_type: Authentication type (algorithm)
1150 * @ie: Extra IEs to add to Authentication frame or %NULL
1151 * @ie_len: Length of ie buffer in octets
1152 * @key_len: length of WEP key for shared key authentication
1153 * @key_idx: index of WEP key for shared key authentication
1154 * @key: WEP key for shared key authentication
1156 struct cfg80211_auth_request {
1157 struct cfg80211_bss *bss;
1160 enum nl80211_auth_type auth_type;
1162 u8 key_len, key_idx;
1166 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1168 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1170 enum cfg80211_assoc_req_flags {
1171 ASSOC_REQ_DISABLE_HT = BIT(0),
1175 * struct cfg80211_assoc_request - (Re)Association request data
1177 * This structure provides information needed to complete IEEE 802.11
1179 * @bss: The BSS to associate with. If the call is successful the driver
1180 * is given a reference that it must release, normally via a call to
1181 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1182 * call to cfg80211_put_bss() (in addition to calling
1183 * cfg80211_send_assoc_timeout())
1184 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1185 * @ie_len: Length of ie buffer in octets
1186 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1187 * @crypto: crypto settings
1188 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1189 * @flags: See &enum cfg80211_assoc_req_flags
1190 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1191 * will be used in ht_capa. Un-supported values will be ignored.
1192 * @ht_capa_mask: The bits of ht_capa which are to be used.
1194 struct cfg80211_assoc_request {
1195 struct cfg80211_bss *bss;
1196 const u8 *ie, *prev_bssid;
1198 struct cfg80211_crypto_settings crypto;
1201 struct ieee80211_ht_cap ht_capa;
1202 struct ieee80211_ht_cap ht_capa_mask;
1206 * struct cfg80211_deauth_request - Deauthentication request data
1208 * This structure provides information needed to complete IEEE 802.11
1211 * @bssid: the BSSID of the BSS to deauthenticate from
1212 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1213 * @ie_len: Length of ie buffer in octets
1214 * @reason_code: The reason code for the deauthentication
1216 struct cfg80211_deauth_request {
1224 * struct cfg80211_disassoc_request - Disassociation request data
1226 * This structure provides information needed to complete IEEE 802.11
1229 * @bss: the BSS to disassociate from
1230 * @ie: Extra IEs to add to Disassociation frame or %NULL
1231 * @ie_len: Length of ie buffer in octets
1232 * @reason_code: The reason code for the disassociation
1233 * @local_state_change: This is a request for a local state only, i.e., no
1234 * Disassociation frame is to be transmitted.
1236 struct cfg80211_disassoc_request {
1237 struct cfg80211_bss *bss;
1241 bool local_state_change;
1245 * struct cfg80211_ibss_params - IBSS parameters
1247 * This structure defines the IBSS parameters for the join_ibss()
1250 * @ssid: The SSID, will always be non-null.
1251 * @ssid_len: The length of the SSID, will always be non-zero.
1252 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1253 * search for IBSSs with a different BSSID.
1254 * @channel: The channel to use if no IBSS can be found to join.
1255 * @channel_type: channel type (HT mode)
1256 * @channel_fixed: The channel should be fixed -- do not search for
1257 * IBSSs to join on other channels.
1258 * @ie: information element(s) to include in the beacon
1259 * @ie_len: length of that
1260 * @beacon_interval: beacon interval to use
1261 * @privacy: this is a protected network, keys will be configured
1263 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1264 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1265 * required to assume that the port is unauthorized until authorized by
1266 * user space. Otherwise, port is marked authorized by default.
1267 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1268 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1270 struct cfg80211_ibss_params {
1273 struct ieee80211_channel *channel;
1274 enum nl80211_channel_type channel_type;
1276 u8 ssid_len, ie_len;
1277 u16 beacon_interval;
1282 int mcast_rate[IEEE80211_NUM_BANDS];
1286 * struct cfg80211_connect_params - Connection parameters
1288 * This structure provides information needed to complete IEEE 802.11
1289 * authentication and association.
1291 * @channel: The channel to use or %NULL if not specified (auto-select based
1293 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1296 * @ssid_len: Length of ssid in octets
1297 * @auth_type: Authentication type (algorithm)
1298 * @ie: IEs for association request
1299 * @ie_len: Length of assoc_ie in octets
1300 * @privacy: indicates whether privacy-enabled APs should be used
1301 * @crypto: crypto settings
1302 * @key_len: length of WEP key for shared key authentication
1303 * @key_idx: index of WEP key for shared key authentication
1304 * @key: WEP key for shared key authentication
1305 * @flags: See &enum cfg80211_assoc_req_flags
1306 * @bg_scan_period: Background scan period in seconds
1307 * or -1 to indicate that default value is to be used.
1308 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1309 * will be used in ht_capa. Un-supported values will be ignored.
1310 * @ht_capa_mask: The bits of ht_capa which are to be used.
1312 struct cfg80211_connect_params {
1313 struct ieee80211_channel *channel;
1317 enum nl80211_auth_type auth_type;
1321 struct cfg80211_crypto_settings crypto;
1323 u8 key_len, key_idx;
1326 struct ieee80211_ht_cap ht_capa;
1327 struct ieee80211_ht_cap ht_capa_mask;
1331 * enum wiphy_params_flags - set_wiphy_params bitfield values
1332 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1333 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1334 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1335 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1336 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1338 enum wiphy_params_flags {
1339 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1340 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1341 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1342 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1343 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1347 * cfg80211_bitrate_mask - masks for bitrate control
1349 struct cfg80211_bitrate_mask {
1352 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1353 } control[IEEE80211_NUM_BANDS];
1356 * struct cfg80211_pmksa - PMK Security Association
1358 * This structure is passed to the set/del_pmksa() method for PMKSA
1361 * @bssid: The AP's BSSID.
1362 * @pmkid: The PMK material itself.
1364 struct cfg80211_pmksa {
1370 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1371 * @mask: bitmask where to match pattern and where to ignore bytes,
1372 * one bit per byte, in same format as nl80211
1373 * @pattern: bytes to match where bitmask is 1
1374 * @pattern_len: length of pattern (in bytes)
1376 * Internal note: @mask and @pattern are allocated in one chunk of
1377 * memory, free @mask only!
1379 struct cfg80211_wowlan_trig_pkt_pattern {
1385 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1387 * This structure defines the enabled WoWLAN triggers for the device.
1388 * @any: wake up on any activity -- special trigger if device continues
1389 * operating as normal during suspend
1390 * @disconnect: wake up if getting disconnected
1391 * @magic_pkt: wake up on receiving magic packet
1392 * @patterns: wake up on receiving packet matching a pattern
1393 * @n_patterns: number of patterns
1394 * @gtk_rekey_failure: wake up on GTK rekey failure
1395 * @eap_identity_req: wake up on EAP identity request packet
1396 * @four_way_handshake: wake up on 4-way handshake
1397 * @rfkill_release: wake up when rfkill is released
1399 struct cfg80211_wowlan {
1400 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1401 eap_identity_req, four_way_handshake,
1403 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1408 * struct cfg80211_gtk_rekey_data - rekey data
1409 * @kek: key encryption key
1410 * @kck: key confirmation key
1411 * @replay_ctr: replay counter
1413 struct cfg80211_gtk_rekey_data {
1414 u8 kek[NL80211_KEK_LEN];
1415 u8 kck[NL80211_KCK_LEN];
1416 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1420 * struct cfg80211_ops - backend description for wireless configuration
1422 * This struct is registered by fullmac card drivers and/or wireless stacks
1423 * in order to handle configuration requests on their interfaces.
1425 * All callbacks except where otherwise noted should return 0
1426 * on success or a negative error code.
1428 * All operations are currently invoked under rtnl for consistency with the
1429 * wireless extensions but this is subject to reevaluation as soon as this
1430 * code is used more widely and we have a first user without wext.
1432 * @suspend: wiphy device needs to be suspended. The variable @wow will
1433 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1434 * configured for the device.
1435 * @resume: wiphy device needs to be resumed
1436 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1437 * to call device_set_wakeup_enable() to enable/disable wakeup from
1440 * @add_virtual_intf: create a new virtual interface with the given name,
1441 * must set the struct wireless_dev's iftype. Beware: You must create
1442 * the new netdev in the wiphy's network namespace! Returns the struct
1443 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1444 * also set the address member in the wdev.
1446 * @del_virtual_intf: remove the virtual interface
1448 * @change_virtual_intf: change type/configuration of virtual interface,
1449 * keep the struct wireless_dev's iftype updated.
1451 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1452 * when adding a group key.
1454 * @get_key: get information about the key with the given parameters.
1455 * @mac_addr will be %NULL when requesting information for a group
1456 * key. All pointers given to the @callback function need not be valid
1457 * after it returns. This function should return an error if it is
1458 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1460 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1461 * and @key_index, return -ENOENT if the key doesn't exist.
1463 * @set_default_key: set the default key on an interface
1465 * @set_default_mgmt_key: set the default management frame key on an interface
1467 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1469 * @start_ap: Start acting in AP mode defined by the parameters.
1470 * @change_beacon: Change the beacon parameters for an access point mode
1471 * interface. This should reject the call when AP mode wasn't started.
1472 * @stop_ap: Stop being an AP, including stopping beaconing.
1474 * @add_station: Add a new station.
1475 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1476 * @change_station: Modify a given station. Note that flags changes are not much
1477 * validated in cfg80211, in particular the auth/assoc/authorized flags
1478 * might come to the driver in invalid combinations -- make sure to check
1479 * them, also against the existing state! Also, supported_rates changes are
1480 * not checked in station mode -- drivers need to reject (or ignore) them
1481 * for anything but TDLS peers.
1482 * @get_station: get station information for the station identified by @mac
1483 * @dump_station: dump station callback -- resume dump at index @idx
1485 * @add_mpath: add a fixed mesh path
1486 * @del_mpath: delete a given mesh path
1487 * @change_mpath: change a given mesh path
1488 * @get_mpath: get a mesh path for the given parameters
1489 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1490 * @join_mesh: join the mesh network with the specified parameters
1491 * @leave_mesh: leave the current mesh network
1493 * @get_mesh_config: Get the current mesh configuration
1495 * @update_mesh_config: Update mesh parameters on a running mesh.
1496 * The mask is a bitfield which tells us which parameters to
1497 * set, and which to leave alone.
1499 * @change_bss: Modify parameters for a given BSS.
1501 * @set_txq_params: Set TX queue parameters
1503 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1504 * as it doesn't implement join_mesh and needs to set the channel to
1505 * join the mesh instead.
1507 * @set_monitor_channel: Set the monitor mode channel for the device. If other
1508 * interfaces are active this callback should reject the configuration.
1509 * If no interfaces are active or the device is down, the channel should
1510 * be stored for when a monitor interface becomes active.
1512 * @scan: Request to do a scan. If returning zero, the scan request is given
1513 * the driver, and will be valid until passed to cfg80211_scan_done().
1514 * For scan results, call cfg80211_inform_bss(); you can call this outside
1515 * the scan/scan_done bracket too.
1517 * @auth: Request to authenticate with the specified peer
1518 * @assoc: Request to (re)associate with the specified peer
1519 * @deauth: Request to deauthenticate from the specified peer
1520 * @disassoc: Request to disassociate from the specified peer
1522 * @connect: Connect to the ESS with the specified parameters. When connected,
1523 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1524 * If the connection fails for some reason, call cfg80211_connect_result()
1525 * with the status from the AP.
1526 * @disconnect: Disconnect from the BSS/ESS.
1528 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1529 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1531 * @leave_ibss: Leave the IBSS.
1533 * @set_wiphy_params: Notify that wiphy parameters have changed;
1534 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1535 * have changed. The actual parameter values are available in
1536 * struct wiphy. If returning an error, no value should be changed.
1538 * @set_tx_power: set the transmit power according to the parameters,
1539 * the power passed is in mBm, to get dBm use MBM_TO_DBM().
1540 * @get_tx_power: store the current TX power into the dbm variable;
1541 * return 0 if successful
1543 * @set_wds_peer: set the WDS peer for a WDS interface
1545 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1546 * functions to adjust rfkill hw state
1548 * @dump_survey: get site survey information.
1550 * @remain_on_channel: Request the driver to remain awake on the specified
1551 * channel for the specified duration to complete an off-channel
1552 * operation (e.g., public action frame exchange). When the driver is
1553 * ready on the requested channel, it must indicate this with an event
1554 * notification by calling cfg80211_ready_on_channel().
1555 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1556 * This allows the operation to be terminated prior to timeout based on
1557 * the duration value.
1558 * @mgmt_tx: Transmit a management frame.
1559 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1560 * frame on another channel
1562 * @testmode_cmd: run a test mode command
1563 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1564 * used by the function, but 0 and 1 must not be touched. Additionally,
1565 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1566 * dump and return to userspace with an error, so be careful. If any data
1567 * was passed in from userspace then the data/len arguments will be present
1568 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1570 * @set_bitrate_mask: set the bitrate mask configuration
1572 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1573 * devices running firmwares capable of generating the (re) association
1574 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1575 * @del_pmksa: Delete a cached PMKID.
1576 * @flush_pmksa: Flush all cached PMKIDs.
1577 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1578 * allows the driver to adjust the dynamic ps timeout value.
1579 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1580 * @set_cqm_txe_config: Configure connection quality monitor TX error
1582 * @sched_scan_start: Tell the driver to start a scheduled scan.
1583 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
1584 * scan. The driver_initiated flag specifies whether the driver
1585 * itself has informed that the scan has stopped.
1587 * @mgmt_frame_register: Notify driver that a management frame type was
1588 * registered. Note that this callback may not sleep, and cannot run
1589 * concurrently with itself.
1591 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1592 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1593 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1594 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1596 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1598 * @set_ringparam: Set tx and rx ring sizes.
1600 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1602 * @tdls_mgmt: Transmit a TDLS management frame.
1603 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1605 * @probe_client: probe an associated client, must return a cookie that it
1606 * later passes to cfg80211_probe_status().
1608 * @set_noack_map: Set the NoAck Map for the TIDs.
1610 * @get_et_sset_count: Ethtool API to get string-set count.
1611 * See @ethtool_ops.get_sset_count
1613 * @get_et_stats: Ethtool API to get a set of u64 stats.
1614 * See @ethtool_ops.get_ethtool_stats
1616 * @get_et_strings: Ethtool API to get a set of strings to describe stats
1617 * and perhaps other supported types of ethtool data-sets.
1618 * See @ethtool_ops.get_strings
1620 * @get_channel: Get the current operating channel for the virtual interface.
1621 * For monitor interfaces, it should return %NULL unless there's a single
1622 * current monitoring channel.
1624 * @start_p2p_device: Start the given P2P device.
1625 * @stop_p2p_device: Stop the given P2P device.
1627 struct cfg80211_ops {
1628 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1629 int (*resume)(struct wiphy *wiphy);
1630 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
1632 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
1634 enum nl80211_iftype type,
1636 struct vif_params *params);
1637 int (*del_virtual_intf)(struct wiphy *wiphy,
1638 struct wireless_dev *wdev);
1639 int (*change_virtual_intf)(struct wiphy *wiphy,
1640 struct net_device *dev,
1641 enum nl80211_iftype type, u32 *flags,
1642 struct vif_params *params);
1644 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1645 u8 key_index, bool pairwise, const u8 *mac_addr,
1646 struct key_params *params);
1647 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1648 u8 key_index, bool pairwise, const u8 *mac_addr,
1650 void (*callback)(void *cookie, struct key_params*));
1651 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1652 u8 key_index, bool pairwise, const u8 *mac_addr);
1653 int (*set_default_key)(struct wiphy *wiphy,
1654 struct net_device *netdev,
1655 u8 key_index, bool unicast, bool multicast);
1656 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1657 struct net_device *netdev,
1660 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
1661 struct cfg80211_ap_settings *settings);
1662 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
1663 struct cfg80211_beacon_data *info);
1664 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
1667 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1668 u8 *mac, struct station_parameters *params);
1669 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1671 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1672 u8 *mac, struct station_parameters *params);
1673 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1674 u8 *mac, struct station_info *sinfo);
1675 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1676 int idx, u8 *mac, struct station_info *sinfo);
1678 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1679 u8 *dst, u8 *next_hop);
1680 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1682 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1683 u8 *dst, u8 *next_hop);
1684 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1685 u8 *dst, u8 *next_hop,
1686 struct mpath_info *pinfo);
1687 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1688 int idx, u8 *dst, u8 *next_hop,
1689 struct mpath_info *pinfo);
1690 int (*get_mesh_config)(struct wiphy *wiphy,
1691 struct net_device *dev,
1692 struct mesh_config *conf);
1693 int (*update_mesh_config)(struct wiphy *wiphy,
1694 struct net_device *dev, u32 mask,
1695 const struct mesh_config *nconf);
1696 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1697 const struct mesh_config *conf,
1698 const struct mesh_setup *setup);
1699 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1701 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1702 struct bss_parameters *params);
1704 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1705 struct ieee80211_txq_params *params);
1707 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
1708 struct net_device *dev,
1709 struct ieee80211_channel *chan);
1711 int (*set_monitor_channel)(struct wiphy *wiphy,
1712 struct ieee80211_channel *chan,
1713 enum nl80211_channel_type channel_type);
1715 int (*scan)(struct wiphy *wiphy,
1716 struct cfg80211_scan_request *request);
1718 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1719 struct cfg80211_auth_request *req);
1720 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1721 struct cfg80211_assoc_request *req);
1722 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1723 struct cfg80211_deauth_request *req);
1724 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1725 struct cfg80211_disassoc_request *req);
1727 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1728 struct cfg80211_connect_params *sme);
1729 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1732 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1733 struct cfg80211_ibss_params *params);
1734 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1736 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1738 int (*set_tx_power)(struct wiphy *wiphy,
1739 enum nl80211_tx_power_setting type, int mbm);
1740 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1742 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1745 void (*rfkill_poll)(struct wiphy *wiphy);
1747 #ifdef CONFIG_NL80211_TESTMODE
1748 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1749 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1750 struct netlink_callback *cb,
1751 void *data, int len);
1754 int (*set_bitrate_mask)(struct wiphy *wiphy,
1755 struct net_device *dev,
1757 const struct cfg80211_bitrate_mask *mask);
1759 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1760 int idx, struct survey_info *info);
1762 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1763 struct cfg80211_pmksa *pmksa);
1764 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1765 struct cfg80211_pmksa *pmksa);
1766 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1768 int (*remain_on_channel)(struct wiphy *wiphy,
1769 struct wireless_dev *wdev,
1770 struct ieee80211_channel *chan,
1771 enum nl80211_channel_type channel_type,
1772 unsigned int duration,
1774 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1775 struct wireless_dev *wdev,
1778 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
1779 struct ieee80211_channel *chan, bool offchan,
1780 enum nl80211_channel_type channel_type,
1781 bool channel_type_valid, unsigned int wait,
1782 const u8 *buf, size_t len, bool no_cck,
1783 bool dont_wait_for_ack, u64 *cookie);
1784 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1785 struct wireless_dev *wdev,
1788 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1789 bool enabled, int timeout);
1791 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1792 struct net_device *dev,
1793 s32 rssi_thold, u32 rssi_hyst);
1795 int (*set_cqm_txe_config)(struct wiphy *wiphy,
1796 struct net_device *dev,
1797 u32 rate, u32 pkts, u32 intvl);
1799 void (*mgmt_frame_register)(struct wiphy *wiphy,
1800 struct wireless_dev *wdev,
1801 u16 frame_type, bool reg);
1803 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1804 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1806 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1807 void (*get_ringparam)(struct wiphy *wiphy,
1808 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1810 int (*sched_scan_start)(struct wiphy *wiphy,
1811 struct net_device *dev,
1812 struct cfg80211_sched_scan_request *request);
1813 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1815 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
1816 struct cfg80211_gtk_rekey_data *data);
1818 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1819 u8 *peer, u8 action_code, u8 dialog_token,
1820 u16 status_code, const u8 *buf, size_t len);
1821 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
1822 u8 *peer, enum nl80211_tdls_operation oper);
1824 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
1825 const u8 *peer, u64 *cookie);
1827 int (*set_noack_map)(struct wiphy *wiphy,
1828 struct net_device *dev,
1831 int (*get_et_sset_count)(struct wiphy *wiphy,
1832 struct net_device *dev, int sset);
1833 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
1834 struct ethtool_stats *stats, u64 *data);
1835 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
1836 u32 sset, u8 *data);
1838 struct ieee80211_channel *
1839 (*get_channel)(struct wiphy *wiphy,
1840 struct wireless_dev *wdev,
1841 enum nl80211_channel_type *type);
1843 int (*start_p2p_device)(struct wiphy *wiphy,
1844 struct wireless_dev *wdev);
1845 void (*stop_p2p_device)(struct wiphy *wiphy,
1846 struct wireless_dev *wdev);
1850 * wireless hardware and networking interfaces structures
1851 * and registration/helper functions
1855 * enum wiphy_flags - wiphy capability flags
1857 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1858 * has its own custom regulatory domain and cannot identify the
1859 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1860 * we will disregard the first regulatory hint (when the
1861 * initiator is %REGDOM_SET_BY_CORE).
1862 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1863 * ignore regulatory domain settings until it gets its own regulatory
1864 * domain via its regulatory_hint() unless the regulatory hint is
1865 * from a country IE. After its gets its own regulatory domain it will
1866 * only allow further regulatory domain settings to further enhance
1867 * compliance. For example if channel 13 and 14 are disabled by this
1868 * regulatory domain no user regulatory domain can enable these channels
1869 * at a later time. This can be used for devices which do not have
1870 * calibration information guaranteed for frequencies or settings
1871 * outside of its regulatory domain. If used in combination with
1872 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
1874 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1875 * that passive scan flags and beaconing flags may not be lifted by
1876 * cfg80211 due to regulatory beacon hints. For more information on beacon
1877 * hints read the documenation for regulatory_hint_found_beacon()
1878 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1880 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1881 * by default -- this flag will be set depending on the kernel's default
1882 * on wiphy_new(), but can be changed by the driver if it has a good
1883 * reason to override the default
1884 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1885 * on a VLAN interface)
1886 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1887 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1888 * control port protocol ethertype. The device also honours the
1889 * control_port_no_encrypt flag.
1890 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1891 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1892 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1893 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1894 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
1896 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
1897 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
1898 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
1899 * link setup/discovery operations internally. Setup, discovery and
1900 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
1901 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
1902 * used for asking the driver/firmware to perform a TDLS operation.
1903 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
1904 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
1905 * when there are virtual interfaces in AP mode by calling
1906 * cfg80211_report_obss_beacon().
1907 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
1908 * responds to probe-requests in hardware.
1909 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
1910 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
1913 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1914 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1915 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1916 WIPHY_FLAG_NETNS_OK = BIT(3),
1917 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1918 WIPHY_FLAG_4ADDR_AP = BIT(5),
1919 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1920 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1921 WIPHY_FLAG_IBSS_RSN = BIT(8),
1922 WIPHY_FLAG_MESH_AUTH = BIT(10),
1923 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
1924 /* use hole at 12 */
1925 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
1926 WIPHY_FLAG_AP_UAPSD = BIT(14),
1927 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
1928 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
1929 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
1930 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
1931 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
1932 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
1933 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
1937 * struct ieee80211_iface_limit - limit on certain interface types
1938 * @max: maximum number of interfaces of these types
1939 * @types: interface types (bits)
1941 struct ieee80211_iface_limit {
1947 * struct ieee80211_iface_combination - possible interface combination
1948 * @limits: limits for the given interface types
1949 * @n_limits: number of limitations
1950 * @num_different_channels: can use up to this many different channels
1951 * @max_interfaces: maximum number of interfaces in total allowed in this
1953 * @beacon_int_infra_match: In this combination, the beacon intervals
1954 * between infrastructure and AP types must match. This is required
1955 * only in special cases.
1957 * These examples can be expressed as follows:
1959 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1961 * struct ieee80211_iface_limit limits1[] = {
1962 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1963 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1965 * struct ieee80211_iface_combination combination1 = {
1966 * .limits = limits1,
1967 * .n_limits = ARRAY_SIZE(limits1),
1968 * .max_interfaces = 2,
1969 * .beacon_int_infra_match = true,
1973 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1975 * struct ieee80211_iface_limit limits2[] = {
1976 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1977 * BIT(NL80211_IFTYPE_P2P_GO), },
1979 * struct ieee80211_iface_combination combination2 = {
1980 * .limits = limits2,
1981 * .n_limits = ARRAY_SIZE(limits2),
1982 * .max_interfaces = 8,
1983 * .num_different_channels = 1,
1987 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
1988 * This allows for an infrastructure connection and three P2P connections.
1990 * struct ieee80211_iface_limit limits3[] = {
1991 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1992 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
1993 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
1995 * struct ieee80211_iface_combination combination3 = {
1996 * .limits = limits3,
1997 * .n_limits = ARRAY_SIZE(limits3),
1998 * .max_interfaces = 4,
1999 * .num_different_channels = 2,
2002 struct ieee80211_iface_combination {
2003 const struct ieee80211_iface_limit *limits;
2004 u32 num_different_channels;
2007 bool beacon_int_infra_match;
2010 struct mac_address {
2014 struct ieee80211_txrx_stypes {
2019 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2020 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2021 * trigger that keeps the device operating as-is and
2022 * wakes up the host on any activity, for example a
2023 * received packet that passed filtering; note that the
2024 * packet should be preserved in that case
2025 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2027 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2028 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2029 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2030 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2031 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2032 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2034 enum wiphy_wowlan_support_flags {
2035 WIPHY_WOWLAN_ANY = BIT(0),
2036 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2037 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2038 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2039 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2040 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2041 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2042 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2046 * struct wiphy_wowlan_support - WoWLAN support data
2047 * @flags: see &enum wiphy_wowlan_support_flags
2048 * @n_patterns: number of supported wakeup patterns
2049 * (see nl80211.h for the pattern definition)
2050 * @pattern_max_len: maximum length of each pattern
2051 * @pattern_min_len: minimum length of each pattern
2053 struct wiphy_wowlan_support {
2056 int pattern_max_len;
2057 int pattern_min_len;
2061 * struct wiphy - wireless hardware description
2062 * @reg_notifier: the driver's regulatory notification callback,
2063 * note that if your driver uses wiphy_apply_custom_regulatory()
2064 * the reg_notifier's request can be passed as NULL
2065 * @regd: the driver's regulatory domain, if one was requested via
2066 * the regulatory_hint() API. This can be used by the driver
2067 * on the reg_notifier() if it chooses to ignore future
2068 * regulatory domain changes caused by other drivers.
2069 * @signal_type: signal type reported in &struct cfg80211_bss.
2070 * @cipher_suites: supported cipher suites
2071 * @n_cipher_suites: number of supported cipher suites
2072 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2073 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2074 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2075 * -1 = fragmentation disabled, only odd values >= 256 used
2076 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2077 * @_net: the network namespace this wiphy currently lives in
2078 * @perm_addr: permanent MAC address of this device
2079 * @addr_mask: If the device supports multiple MAC addresses by masking,
2080 * set this to a mask with variable bits set to 1, e.g. if the last
2081 * four bits are variable then set it to 00:...:00:0f. The actual
2082 * variable bits shall be determined by the interfaces added, with
2083 * interfaces not matching the mask being rejected to be brought up.
2084 * @n_addresses: number of addresses in @addresses.
2085 * @addresses: If the device has more than one address, set this pointer
2086 * to a list of addresses (6 bytes each). The first one will be used
2087 * by default for perm_addr. In this case, the mask should be set to
2088 * all-zeroes. In this case it is assumed that the device can handle
2089 * the same number of arbitrary MAC addresses.
2090 * @registered: protects ->resume and ->suspend sysfs callbacks against
2091 * unregister hardware
2092 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2093 * automatically on wiphy renames
2094 * @dev: (virtual) struct device for this wiphy
2095 * @registered: helps synchronize suspend/resume with wiphy unregister
2096 * @wext: wireless extension handlers
2097 * @priv: driver private data (sized according to wiphy_new() parameter)
2098 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2099 * must be set by driver
2100 * @iface_combinations: Valid interface combinations array, should not
2101 * list single interface types.
2102 * @n_iface_combinations: number of entries in @iface_combinations array.
2103 * @software_iftypes: bitmask of software interface types, these are not
2104 * subject to any restrictions since they are purely managed in SW.
2105 * @flags: wiphy flags, see &enum wiphy_flags
2106 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2107 * @bss_priv_size: each BSS struct has private data allocated with it,
2108 * this variable determines its size
2109 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2111 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2112 * for in any given scheduled scan
2113 * @max_match_sets: maximum number of match sets the device can handle
2114 * when performing a scheduled scan, 0 if filtering is not
2116 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2117 * add to probe request frames transmitted during a scan, must not
2118 * include fixed IEs like supported rates
2119 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2121 * @coverage_class: current coverage class
2122 * @fw_version: firmware version for ethtool reporting
2123 * @hw_version: hardware version for ethtool reporting
2124 * @max_num_pmkids: maximum number of PMKIDs supported by device
2125 * @privid: a pointer that drivers can use to identify if an arbitrary
2126 * wiphy is theirs, e.g. in global notifiers
2127 * @bands: information about bands/channels supported by this device
2129 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2130 * transmitted through nl80211, points to an array indexed by interface
2133 * @available_antennas_tx: bitmap of antennas which are available to be
2134 * configured as TX antennas. Antenna configuration commands will be
2135 * rejected unless this or @available_antennas_rx is set.
2137 * @available_antennas_rx: bitmap of antennas which are available to be
2138 * configured as RX antennas. Antenna configuration commands will be
2139 * rejected unless this or @available_antennas_tx is set.
2141 * @probe_resp_offload:
2142 * Bitmap of supported protocols for probe response offloading.
2143 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2144 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2146 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2147 * may request, if implemented.
2149 * @wowlan: WoWLAN support information
2151 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2152 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2153 * If null, then none can be over-ridden.
2156 /* assign these fields before you register the wiphy */
2158 /* permanent MAC address(es) */
2159 u8 perm_addr[ETH_ALEN];
2160 u8 addr_mask[ETH_ALEN];
2162 struct mac_address *addresses;
2164 const struct ieee80211_txrx_stypes *mgmt_stypes;
2166 const struct ieee80211_iface_combination *iface_combinations;
2167 int n_iface_combinations;
2168 u16 software_iftypes;
2172 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2173 u16 interface_modes;
2175 u32 flags, features;
2179 enum cfg80211_signal_type signal_type;
2183 u8 max_sched_scan_ssids;
2185 u16 max_scan_ie_len;
2186 u16 max_sched_scan_ie_len;
2188 int n_cipher_suites;
2189 const u32 *cipher_suites;
2197 char fw_version[ETHTOOL_BUSINFO_LEN];
2201 struct wiphy_wowlan_support wowlan;
2204 u16 max_remain_on_channel_duration;
2208 u32 available_antennas_tx;
2209 u32 available_antennas_rx;
2212 * Bitmap of supported protocols for probe response offloading
2213 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2214 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2216 u32 probe_resp_offload;
2218 /* If multiple wiphys are registered and you're handed e.g.
2219 * a regular netdev with assigned ieee80211_ptr, you won't
2220 * know whether it points to a wiphy your driver has registered
2221 * or not. Assign this to something global to your driver to
2222 * help determine whether you own this wiphy or not. */
2225 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2227 /* Lets us get back the wiphy on the callback */
2228 int (*reg_notifier)(struct wiphy *wiphy,
2229 struct regulatory_request *request);
2231 /* fields below are read-only, assigned by cfg80211 */
2233 const struct ieee80211_regdomain *regd;
2235 /* the item in /sys/class/ieee80211/ points to this,
2236 * you need use set_wiphy_dev() (see below) */
2239 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2242 /* dir in debugfs: ieee80211/<wiphyname> */
2243 struct dentry *debugfsdir;
2245 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2247 #ifdef CONFIG_NET_NS
2248 /* the network namespace this phy lives in currently */
2252 #ifdef CONFIG_CFG80211_WEXT
2253 const struct iw_handler_def *wext;
2256 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
2259 static inline struct net *wiphy_net(struct wiphy *wiphy)
2261 return read_pnet(&wiphy->_net);
2264 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2266 write_pnet(&wiphy->_net, net);
2270 * wiphy_priv - return priv from wiphy
2272 * @wiphy: the wiphy whose priv pointer to return
2274 static inline void *wiphy_priv(struct wiphy *wiphy)
2277 return &wiphy->priv;
2281 * priv_to_wiphy - return the wiphy containing the priv
2283 * @priv: a pointer previously returned by wiphy_priv
2285 static inline struct wiphy *priv_to_wiphy(void *priv)
2288 return container_of(priv, struct wiphy, priv);
2292 * set_wiphy_dev - set device pointer for wiphy
2294 * @wiphy: The wiphy whose device to bind
2295 * @dev: The device to parent it to
2297 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2299 wiphy->dev.parent = dev;
2303 * wiphy_dev - get wiphy dev pointer
2305 * @wiphy: The wiphy whose device struct to look up
2307 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2309 return wiphy->dev.parent;
2313 * wiphy_name - get wiphy name
2315 * @wiphy: The wiphy whose name to return
2317 static inline const char *wiphy_name(const struct wiphy *wiphy)
2319 return dev_name(&wiphy->dev);
2323 * wiphy_new - create a new wiphy for use with cfg80211
2325 * @ops: The configuration operations for this device
2326 * @sizeof_priv: The size of the private area to allocate
2328 * Create a new wiphy and associate the given operations with it.
2329 * @sizeof_priv bytes are allocated for private use.
2331 * The returned pointer must be assigned to each netdev's
2332 * ieee80211_ptr for proper operation.
2334 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2337 * wiphy_register - register a wiphy with cfg80211
2339 * @wiphy: The wiphy to register.
2341 * Returns a non-negative wiphy index or a negative error code.
2343 extern int wiphy_register(struct wiphy *wiphy);
2346 * wiphy_unregister - deregister a wiphy from cfg80211
2348 * @wiphy: The wiphy to unregister.
2350 * After this call, no more requests can be made with this priv
2351 * pointer, but the call may sleep to wait for an outstanding
2352 * request that is being handled.
2354 extern void wiphy_unregister(struct wiphy *wiphy);
2357 * wiphy_free - free wiphy
2359 * @wiphy: The wiphy to free
2361 extern void wiphy_free(struct wiphy *wiphy);
2363 /* internal structs */
2364 struct cfg80211_conn;
2365 struct cfg80211_internal_bss;
2366 struct cfg80211_cached_keys;
2369 * struct wireless_dev - wireless device state
2371 * For netdevs, this structure must be allocated by the driver
2372 * that uses the ieee80211_ptr field in struct net_device (this
2373 * is intentional so it can be allocated along with the netdev.)
2374 * It need not be registered then as netdev registration will
2375 * be intercepted by cfg80211 to see the new wireless device.
2377 * For non-netdev uses, it must also be allocated by the driver
2378 * in response to the cfg80211 callbacks that require it, as
2379 * there's no netdev registration in that case it may not be
2380 * allocated outside of callback operations that return it.
2382 * @wiphy: pointer to hardware description
2383 * @iftype: interface type
2384 * @list: (private) Used to collect the interfaces
2385 * @netdev: (private) Used to reference back to the netdev, may be %NULL
2386 * @identifier: (private) Identifier used in nl80211 to identify this
2387 * wireless device if it has no netdev
2388 * @current_bss: (private) Used by the internal configuration code
2389 * @channel: (private) Used by the internal configuration code to track
2390 * the user-set AP, monitor and WDS channel
2391 * @preset_chan: (private) Used by the internal configuration code to
2392 * track the channel to be used for AP later
2393 * @preset_chantype: (private) the corresponding channel type
2394 * @bssid: (private) Used by the internal configuration code
2395 * @ssid: (private) Used by the internal configuration code
2396 * @ssid_len: (private) Used by the internal configuration code
2397 * @mesh_id_len: (private) Used by the internal configuration code
2398 * @mesh_id_up_len: (private) Used by the internal configuration code
2399 * @wext: (private) Used by the internal wireless extensions compat code
2400 * @use_4addr: indicates 4addr mode is used on this interface, must be
2401 * set by driver (if supported) on add_interface BEFORE registering the
2402 * netdev and may otherwise be used by driver read-only, will be update
2403 * by cfg80211 on change_interface
2404 * @mgmt_registrations: list of registrations for management frames
2405 * @mgmt_registrations_lock: lock for the list
2406 * @mtx: mutex used to lock data in this struct
2407 * @cleanup_work: work struct used for cleanup that can't be done directly
2408 * @beacon_interval: beacon interval used on this device for transmitting
2409 * beacons, 0 when not valid
2410 * @address: The address for this device, valid only if @netdev is %NULL
2411 * @p2p_started: true if this is a P2P Device that has been started
2413 struct wireless_dev {
2414 struct wiphy *wiphy;
2415 enum nl80211_iftype iftype;
2417 /* the remainder of this struct should be private to cfg80211 */
2418 struct list_head list;
2419 struct net_device *netdev;
2423 struct list_head mgmt_registrations;
2424 spinlock_t mgmt_registrations_lock;
2428 struct work_struct cleanup_work;
2430 bool use_4addr, p2p_started;
2432 u8 address[ETH_ALEN] __aligned(sizeof(u16));
2434 /* currently used for IBSS and SME - might be rearranged later */
2435 u8 ssid[IEEE80211_MAX_SSID_LEN];
2436 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2439 CFG80211_SME_CONNECTING,
2440 CFG80211_SME_CONNECTED,
2442 struct cfg80211_conn *conn;
2443 struct cfg80211_cached_keys *connect_keys;
2445 struct list_head event_list;
2446 spinlock_t event_lock;
2448 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2449 struct ieee80211_channel *preset_chan;
2450 enum nl80211_channel_type preset_chantype;
2452 /* for AP and mesh channel tracking */
2453 struct ieee80211_channel *channel;
2460 int beacon_interval;
2462 u32 ap_unexpected_nlpid;
2464 #ifdef CONFIG_CFG80211_WEXT
2467 struct cfg80211_ibss_params ibss;
2468 struct cfg80211_connect_params connect;
2469 struct cfg80211_cached_keys *keys;
2472 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2473 u8 ssid[IEEE80211_MAX_SSID_LEN];
2474 s8 default_key, default_mgmt_key;
2475 bool prev_bssid_valid;
2480 static inline u8 *wdev_address(struct wireless_dev *wdev)
2483 return wdev->netdev->dev_addr;
2484 return wdev->address;
2488 * wdev_priv - return wiphy priv from wireless_dev
2490 * @wdev: The wireless device whose wiphy's priv pointer to return
2492 static inline void *wdev_priv(struct wireless_dev *wdev)
2495 return wiphy_priv(wdev->wiphy);
2499 * DOC: Utility functions
2501 * cfg80211 offers a number of utility functions that can be useful.
2505 * ieee80211_channel_to_frequency - convert channel number to frequency
2506 * @chan: channel number
2507 * @band: band, necessary due to channel number overlap
2509 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2512 * ieee80211_frequency_to_channel - convert frequency to channel number
2513 * @freq: center frequency
2515 extern int ieee80211_frequency_to_channel(int freq);
2518 * Name indirection necessary because the ieee80211 code also has
2519 * a function named "ieee80211_get_channel", so if you include
2520 * cfg80211's header file you get cfg80211's version, if you try
2521 * to include both header files you'll (rightfully!) get a symbol
2524 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2527 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2528 * @wiphy: the struct wiphy to get the channel for
2529 * @freq: the center frequency of the channel
2531 static inline struct ieee80211_channel *
2532 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2534 return __ieee80211_get_channel(wiphy, freq);
2538 * ieee80211_get_response_rate - get basic rate for a given rate
2540 * @sband: the band to look for rates in
2541 * @basic_rates: bitmap of basic rates
2542 * @bitrate: the bitrate for which to find the basic rate
2544 * This function returns the basic rate corresponding to a given
2545 * bitrate, that is the next lower bitrate contained in the basic
2546 * rate map, which is, for this function, given as a bitmap of
2547 * indices of rates in the band's bitrate table.
2549 struct ieee80211_rate *
2550 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2551 u32 basic_rates, int bitrate);
2554 * Radiotap parsing functions -- for controlled injection support
2556 * Implemented in net/wireless/radiotap.c
2557 * Documentation in Documentation/networking/radiotap-headers.txt
2560 struct radiotap_align_size {
2561 uint8_t align:4, size:4;
2564 struct ieee80211_radiotap_namespace {
2565 const struct radiotap_align_size *align_size;
2571 struct ieee80211_radiotap_vendor_namespaces {
2572 const struct ieee80211_radiotap_namespace *ns;
2577 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2578 * @this_arg_index: index of current arg, valid after each successful call
2579 * to ieee80211_radiotap_iterator_next()
2580 * @this_arg: pointer to current radiotap arg; it is valid after each
2581 * call to ieee80211_radiotap_iterator_next() but also after
2582 * ieee80211_radiotap_iterator_init() where it will point to
2583 * the beginning of the actual data portion
2584 * @this_arg_size: length of the current arg, for convenience
2585 * @current_namespace: pointer to the current namespace definition
2586 * (or internally %NULL if the current namespace is unknown)
2587 * @is_radiotap_ns: indicates whether the current namespace is the default
2588 * radiotap namespace or not
2590 * @_rtheader: pointer to the radiotap header we are walking through
2591 * @_max_length: length of radiotap header in cpu byte ordering
2592 * @_arg_index: next argument index
2593 * @_arg: next argument pointer
2594 * @_next_bitmap: internal pointer to next present u32
2595 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2596 * @_vns: vendor namespace definitions
2597 * @_next_ns_data: beginning of the next namespace's data
2598 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2601 * Describes the radiotap parser state. Fields prefixed with an underscore
2602 * must not be used by users of the parser, only by the parser internally.
2605 struct ieee80211_radiotap_iterator {
2606 struct ieee80211_radiotap_header *_rtheader;
2607 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2608 const struct ieee80211_radiotap_namespace *current_namespace;
2610 unsigned char *_arg, *_next_ns_data;
2611 __le32 *_next_bitmap;
2613 unsigned char *this_arg;
2621 uint32_t _bitmap_shifter;
2625 extern int ieee80211_radiotap_iterator_init(
2626 struct ieee80211_radiotap_iterator *iterator,
2627 struct ieee80211_radiotap_header *radiotap_header,
2628 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2630 extern int ieee80211_radiotap_iterator_next(
2631 struct ieee80211_radiotap_iterator *iterator);
2634 extern const unsigned char rfc1042_header[6];
2635 extern const unsigned char bridge_tunnel_header[6];
2638 * ieee80211_get_hdrlen_from_skb - get header length from data
2640 * Given an skb with a raw 802.11 header at the data pointer this function
2641 * returns the 802.11 header length in bytes (not including encryption
2642 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2643 * header the function returns 0.
2647 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2650 * ieee80211_hdrlen - get header length in bytes from frame control
2651 * @fc: frame control field in little-endian format
2653 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2656 * DOC: Data path helpers
2658 * In addition to generic utilities, cfg80211 also offers
2659 * functions that help implement the data path for devices
2660 * that do not do the 802.11/802.3 conversion on the device.
2664 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2665 * @skb: the 802.11 data frame
2666 * @addr: the device MAC address
2667 * @iftype: the virtual interface type
2669 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2670 enum nl80211_iftype iftype);
2673 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2674 * @skb: the 802.3 frame
2675 * @addr: the device MAC address
2676 * @iftype: the virtual interface type
2677 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2678 * @qos: build 802.11 QoS data frame
2680 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2681 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2684 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2686 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2687 * 802.3 frames. The @list will be empty if the decode fails. The
2688 * @skb is consumed after the function returns.
2690 * @skb: The input IEEE 802.11n A-MSDU frame.
2691 * @list: The output list of 802.3 frames. It must be allocated and
2692 * initialized by by the caller.
2693 * @addr: The device MAC address.
2694 * @iftype: The device interface type.
2695 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2696 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2698 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2699 const u8 *addr, enum nl80211_iftype iftype,
2700 const unsigned int extra_headroom,
2701 bool has_80211_header);
2704 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2705 * @skb: the data frame
2707 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2710 * cfg80211_find_ie - find information element in data
2713 * @ies: data consisting of IEs
2714 * @len: length of data
2716 * This function will return %NULL if the element ID could
2717 * not be found or if the element is invalid (claims to be
2718 * longer than the given data), or a pointer to the first byte
2719 * of the requested element, that is the byte containing the
2720 * element ID. There are no checks on the element length
2721 * other than having to fit into the given data.
2723 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2726 * cfg80211_find_vendor_ie - find vendor specific information element in data
2729 * @oui_type: vendor-specific OUI type
2730 * @ies: data consisting of IEs
2731 * @len: length of data
2733 * This function will return %NULL if the vendor specific element ID
2734 * could not be found or if the element is invalid (claims to be
2735 * longer than the given data), or a pointer to the first byte
2736 * of the requested element, that is the byte containing the
2737 * element ID. There are no checks on the element length
2738 * other than having to fit into the given data.
2740 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
2741 const u8 *ies, int len);
2744 * DOC: Regulatory enforcement infrastructure
2750 * regulatory_hint - driver hint to the wireless core a regulatory domain
2751 * @wiphy: the wireless device giving the hint (used only for reporting
2753 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2754 * should be in. If @rd is set this should be NULL. Note that if you
2755 * set this to NULL you should still set rd->alpha2 to some accepted
2758 * Wireless drivers can use this function to hint to the wireless core
2759 * what it believes should be the current regulatory domain by
2760 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2761 * domain should be in or by providing a completely build regulatory domain.
2762 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2763 * for a regulatory domain structure for the respective country.
2765 * The wiphy must have been registered to cfg80211 prior to this call.
2766 * For cfg80211 drivers this means you must first use wiphy_register(),
2767 * for mac80211 drivers you must first use ieee80211_register_hw().
2769 * Drivers should check the return value, its possible you can get
2772 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2775 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2776 * @wiphy: the wireless device we want to process the regulatory domain on
2777 * @regd: the custom regulatory domain to use for this wiphy
2779 * Drivers can sometimes have custom regulatory domains which do not apply
2780 * to a specific country. Drivers can use this to apply such custom regulatory
2781 * domains. This routine must be called prior to wiphy registration. The
2782 * custom regulatory domain will be trusted completely and as such previous
2783 * default channel settings will be disregarded. If no rule is found for a
2784 * channel on the regulatory domain the channel will be disabled.
2786 extern void wiphy_apply_custom_regulatory(
2787 struct wiphy *wiphy,
2788 const struct ieee80211_regdomain *regd);
2791 * freq_reg_info - get regulatory information for the given frequency
2792 * @wiphy: the wiphy for which we want to process this rule for
2793 * @center_freq: Frequency in KHz for which we want regulatory information for
2794 * @desired_bw_khz: the desired max bandwidth you want to use per
2795 * channel. Note that this is still 20 MHz if you want to use HT40
2796 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2797 * If set to 0 we'll assume you want the standard 20 MHz.
2798 * @reg_rule: the regulatory rule which we have for this frequency
2800 * Use this function to get the regulatory rule for a specific frequency on
2801 * a given wireless device. If the device has a specific regulatory domain
2802 * it wants to follow we respect that unless a country IE has been received
2803 * and processed already.
2805 * Returns 0 if it was able to find a valid regulatory rule which does
2806 * apply to the given center_freq otherwise it returns non-zero. It will
2807 * also return -ERANGE if we determine the given center_freq does not even have
2808 * a regulatory rule for a frequency range in the center_freq's band. See
2809 * freq_in_rule_band() for our current definition of a band -- this is purely
2810 * subjective and right now its 802.11 specific.
2812 extern int freq_reg_info(struct wiphy *wiphy,
2815 const struct ieee80211_reg_rule **reg_rule);
2818 * callbacks for asynchronous cfg80211 methods, notification
2819 * functions and BSS handling helpers
2823 * cfg80211_scan_done - notify that scan finished
2825 * @request: the corresponding scan request
2826 * @aborted: set to true if the scan was aborted for any reason,
2827 * userspace will be notified of that
2829 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2832 * cfg80211_sched_scan_results - notify that new scan results are available
2834 * @wiphy: the wiphy which got scheduled scan results
2836 void cfg80211_sched_scan_results(struct wiphy *wiphy);
2839 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2841 * @wiphy: the wiphy on which the scheduled scan stopped
2843 * The driver can call this function to inform cfg80211 that the
2844 * scheduled scan had to be stopped, for whatever reason. The driver
2845 * is then called back via the sched_scan_stop operation when done.
2847 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
2850 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2852 * @wiphy: the wiphy reporting the BSS
2853 * @channel: The channel the frame was received on
2854 * @mgmt: the management frame (probe response or beacon)
2855 * @len: length of the management frame
2856 * @signal: the signal strength, type depends on the wiphy's signal_type
2857 * @gfp: context flags
2859 * This informs cfg80211 that BSS information was found and
2860 * the BSS should be updated/added.
2862 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2864 struct cfg80211_bss * __must_check
2865 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2866 struct ieee80211_channel *channel,
2867 struct ieee80211_mgmt *mgmt, size_t len,
2868 s32 signal, gfp_t gfp);
2871 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2873 * @wiphy: the wiphy reporting the BSS
2874 * @channel: The channel the frame was received on
2875 * @bssid: the BSSID of the BSS
2876 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
2877 * @capability: the capability field sent by the peer
2878 * @beacon_interval: the beacon interval announced by the peer
2879 * @ie: additional IEs sent by the peer
2880 * @ielen: length of the additional IEs
2881 * @signal: the signal strength, type depends on the wiphy's signal_type
2882 * @gfp: context flags
2884 * This informs cfg80211 that BSS information was found and
2885 * the BSS should be updated/added.
2887 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2889 struct cfg80211_bss * __must_check
2890 cfg80211_inform_bss(struct wiphy *wiphy,
2891 struct ieee80211_channel *channel,
2892 const u8 *bssid, u64 tsf, u16 capability,
2893 u16 beacon_interval, const u8 *ie, size_t ielen,
2894 s32 signal, gfp_t gfp);
2896 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2897 struct ieee80211_channel *channel,
2899 const u8 *ssid, size_t ssid_len,
2900 u16 capa_mask, u16 capa_val);
2901 static inline struct cfg80211_bss *
2902 cfg80211_get_ibss(struct wiphy *wiphy,
2903 struct ieee80211_channel *channel,
2904 const u8 *ssid, size_t ssid_len)
2906 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2907 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2910 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2911 struct ieee80211_channel *channel,
2912 const u8 *meshid, size_t meshidlen,
2915 * cfg80211_ref_bss - reference BSS struct
2916 * @bss: the BSS struct to reference
2918 * Increments the refcount of the given BSS struct.
2920 void cfg80211_ref_bss(struct cfg80211_bss *bss);
2923 * cfg80211_put_bss - unref BSS struct
2924 * @bss: the BSS struct
2926 * Decrements the refcount of the given BSS struct.
2928 void cfg80211_put_bss(struct cfg80211_bss *bss);
2931 * cfg80211_unlink_bss - unlink BSS from internal data structures
2933 * @bss: the bss to remove
2935 * This function removes the given BSS from the internal data structures
2936 * thereby making it no longer show up in scan results etc. Use this
2937 * function when you detect a BSS is gone. Normally BSSes will also time
2938 * out, so it is not necessary to use this function at all.
2940 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2943 * cfg80211_send_rx_auth - notification of processed authentication
2944 * @dev: network device
2945 * @buf: authentication frame (header + body)
2946 * @len: length of the frame data
2948 * This function is called whenever an authentication has been processed in
2949 * station mode. The driver is required to call either this function or
2950 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2951 * call. This function may sleep.
2953 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2956 * cfg80211_send_auth_timeout - notification of timed out authentication
2957 * @dev: network device
2958 * @addr: The MAC address of the device with which the authentication timed out
2960 * This function may sleep.
2962 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2965 * cfg80211_send_rx_assoc - notification of processed association
2966 * @dev: network device
2967 * @bss: the BSS struct association was requested for, the struct reference
2968 * is owned by cfg80211 after this call
2969 * @buf: (re)association response frame (header + body)
2970 * @len: length of the frame data
2972 * This function is called whenever a (re)association response has been
2973 * processed in station mode. The driver is required to call either this
2974 * function or cfg80211_send_assoc_timeout() to indicate the result of
2975 * cfg80211_ops::assoc() call. This function may sleep.
2977 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
2978 const u8 *buf, size_t len);
2981 * cfg80211_send_assoc_timeout - notification of timed out association
2982 * @dev: network device
2983 * @addr: The MAC address of the device with which the association timed out
2985 * This function may sleep.
2987 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2990 * cfg80211_send_deauth - notification of processed deauthentication
2991 * @dev: network device
2992 * @buf: deauthentication frame (header + body)
2993 * @len: length of the frame data
2995 * This function is called whenever deauthentication has been processed in
2996 * station mode. This includes both received deauthentication frames and
2997 * locally generated ones. This function may sleep.
2999 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3002 * __cfg80211_send_deauth - notification of processed deauthentication
3003 * @dev: network device
3004 * @buf: deauthentication frame (header + body)
3005 * @len: length of the frame data
3007 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
3009 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3012 * cfg80211_send_disassoc - notification of processed disassociation
3013 * @dev: network device
3014 * @buf: disassociation response frame (header + body)
3015 * @len: length of the frame data
3017 * This function is called whenever disassociation has been processed in
3018 * station mode. This includes both received disassociation frames and locally
3019 * generated ones. This function may sleep.
3021 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
3024 * __cfg80211_send_disassoc - notification of processed disassociation
3025 * @dev: network device
3026 * @buf: disassociation response frame (header + body)
3027 * @len: length of the frame data
3029 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
3031 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
3035 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
3036 * @dev: network device
3037 * @buf: deauthentication frame (header + body)
3038 * @len: length of the frame data
3040 * This function is called whenever a received Deauthentication frame has been
3041 * dropped in station mode because of MFP being used but the Deauthentication
3042 * frame was not protected. This function may sleep.
3044 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
3048 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
3049 * @dev: network device
3050 * @buf: disassociation frame (header + body)
3051 * @len: length of the frame data
3053 * This function is called whenever a received Disassociation frame has been
3054 * dropped in station mode because of MFP being used but the Disassociation
3055 * frame was not protected. This function may sleep.
3057 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
3061 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3062 * @dev: network device
3063 * @addr: The source MAC address of the frame
3064 * @key_type: The key type that the received frame used
3065 * @key_id: Key identifier (0..3). Can be -1 if missing.
3066 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3067 * @gfp: allocation flags
3069 * This function is called whenever the local MAC detects a MIC failure in a
3070 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3073 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3074 enum nl80211_key_type key_type, int key_id,
3075 const u8 *tsc, gfp_t gfp);
3078 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3080 * @dev: network device
3081 * @bssid: the BSSID of the IBSS joined
3082 * @gfp: allocation flags
3084 * This function notifies cfg80211 that the device joined an IBSS or
3085 * switched to a different BSSID. Before this function can be called,
3086 * either a beacon has to have been received from the IBSS, or one of
3087 * the cfg80211_inform_bss{,_frame} functions must have been called
3088 * with the locally generated beacon -- this guarantees that there is
3089 * always a scan result for this IBSS. cfg80211 will handle the rest.
3091 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3094 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3096 * @dev: network device
3097 * @macaddr: the MAC address of the new candidate
3098 * @ie: information elements advertised by the peer candidate
3099 * @ie_len: lenght of the information elements buffer
3100 * @gfp: allocation flags
3102 * This function notifies cfg80211 that the mesh peer candidate has been
3103 * detected, most likely via a beacon or, less likely, via a probe response.
3104 * cfg80211 then sends a notification to userspace.
3106 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3107 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3110 * DOC: RFkill integration
3112 * RFkill integration in cfg80211 is almost invisible to drivers,
3113 * as cfg80211 automatically registers an rfkill instance for each
3114 * wireless device it knows about. Soft kill is also translated
3115 * into disconnecting and turning all interfaces off, drivers are
3116 * expected to turn off the device when all interfaces are down.
3118 * However, devices may have a hard RFkill line, in which case they
3119 * also need to interact with the rfkill subsystem, via cfg80211.
3120 * They can do this with a few helper functions documented here.
3124 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3126 * @blocked: block status
3128 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3131 * wiphy_rfkill_start_polling - start polling rfkill
3134 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3137 * wiphy_rfkill_stop_polling - stop polling rfkill
3140 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3142 #ifdef CONFIG_NL80211_TESTMODE
3146 * Test mode is a set of utility functions to allow drivers to
3147 * interact with driver-specific tools to aid, for instance,
3148 * factory programming.
3150 * This chapter describes how drivers interact with it, for more
3151 * information see the nl80211 book's chapter on it.
3155 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3157 * @approxlen: an upper bound of the length of the data that will
3158 * be put into the skb
3160 * This function allocates and pre-fills an skb for a reply to
3161 * the testmode command. Since it is intended for a reply, calling
3162 * it outside of the @testmode_cmd operation is invalid.
3164 * The returned skb (or %NULL if any errors happen) is pre-filled
3165 * with the wiphy index and set up in a way that any data that is
3166 * put into the skb (with skb_put(), nla_put() or similar) will end
3167 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
3168 * needs to be done with the skb is adding data for the corresponding
3169 * userspace tool which can then read that data out of the testdata
3170 * attribute. You must not modify the skb in any other way.
3172 * When done, call cfg80211_testmode_reply() with the skb and return
3173 * its error code as the result of the @testmode_cmd operation.
3175 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3179 * cfg80211_testmode_reply - send the reply skb
3180 * @skb: The skb, must have been allocated with
3181 * cfg80211_testmode_alloc_reply_skb()
3183 * Returns an error code or 0 on success, since calling this
3184 * function will usually be the last thing before returning
3185 * from the @testmode_cmd you should return the error code.
3186 * Note that this function consumes the skb regardless of the
3189 int cfg80211_testmode_reply(struct sk_buff *skb);
3192 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3194 * @approxlen: an upper bound of the length of the data that will
3195 * be put into the skb
3196 * @gfp: allocation flags
3198 * This function allocates and pre-fills an skb for an event on the
3199 * testmode multicast group.
3201 * The returned skb (or %NULL if any errors happen) is set up in the
3202 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
3203 * for an event. As there, you should simply add data to it that will
3204 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
3205 * not modify the skb in any other way.
3207 * When done filling the skb, call cfg80211_testmode_event() with the
3208 * skb to send the event.
3210 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3211 int approxlen, gfp_t gfp);
3214 * cfg80211_testmode_event - send the event
3215 * @skb: The skb, must have been allocated with
3216 * cfg80211_testmode_alloc_event_skb()
3217 * @gfp: allocation flags
3219 * This function sends the given @skb, which must have been allocated
3220 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3223 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3225 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3226 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3228 #define CFG80211_TESTMODE_CMD(cmd)
3229 #define CFG80211_TESTMODE_DUMP(cmd)
3233 * cfg80211_connect_result - notify cfg80211 of connection result
3235 * @dev: network device
3236 * @bssid: the BSSID of the AP
3237 * @req_ie: association request IEs (maybe be %NULL)
3238 * @req_ie_len: association request IEs length
3239 * @resp_ie: association response IEs (may be %NULL)
3240 * @resp_ie_len: assoc response IEs length
3241 * @status: status code, 0 for successful connection, use
3242 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3243 * the real status code for failures.
3244 * @gfp: allocation flags
3246 * It should be called by the underlying driver whenever connect() has
3249 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3250 const u8 *req_ie, size_t req_ie_len,
3251 const u8 *resp_ie, size_t resp_ie_len,
3252 u16 status, gfp_t gfp);
3255 * cfg80211_roamed - notify cfg80211 of roaming
3257 * @dev: network device
3258 * @channel: the channel of the new AP
3259 * @bssid: the BSSID of the new AP
3260 * @req_ie: association request IEs (maybe be %NULL)
3261 * @req_ie_len: association request IEs length
3262 * @resp_ie: association response IEs (may be %NULL)
3263 * @resp_ie_len: assoc response IEs length
3264 * @gfp: allocation flags
3266 * It should be called by the underlying driver whenever it roamed
3267 * from one AP to another while connected.
3269 void cfg80211_roamed(struct net_device *dev,
3270 struct ieee80211_channel *channel,
3272 const u8 *req_ie, size_t req_ie_len,
3273 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3276 * cfg80211_roamed_bss - notify cfg80211 of roaming
3278 * @dev: network device
3279 * @bss: entry of bss to which STA got roamed
3280 * @req_ie: association request IEs (maybe be %NULL)
3281 * @req_ie_len: association request IEs length
3282 * @resp_ie: association response IEs (may be %NULL)
3283 * @resp_ie_len: assoc response IEs length
3284 * @gfp: allocation flags
3286 * This is just a wrapper to notify cfg80211 of roaming event with driver
3287 * passing bss to avoid a race in timeout of the bss entry. It should be
3288 * called by the underlying driver whenever it roamed from one AP to another
3289 * while connected. Drivers which have roaming implemented in firmware
3290 * may use this function to avoid a race in bss entry timeout where the bss
3291 * entry of the new AP is seen in the driver, but gets timed out by the time
3292 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3293 * rdev->event_work. In case of any failures, the reference is released
3294 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3295 * it will be released while diconneting from the current bss.
3297 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3298 const u8 *req_ie, size_t req_ie_len,
3299 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3302 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3304 * @dev: network device
3305 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3306 * @ie_len: length of IEs
3307 * @reason: reason code for the disconnection, set it to 0 if unknown
3308 * @gfp: allocation flags
3310 * After it calls this function, the driver should enter an idle state
3311 * and not try to connect to any AP any more.
3313 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3314 u8 *ie, size_t ie_len, gfp_t gfp);
3317 * cfg80211_ready_on_channel - notification of remain_on_channel start
3318 * @wdev: wireless device
3319 * @cookie: the request cookie
3320 * @chan: The current channel (from remain_on_channel request)
3321 * @channel_type: Channel type
3322 * @duration: Duration in milliseconds that the driver intents to remain on the
3324 * @gfp: allocation flags
3326 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
3327 struct ieee80211_channel *chan,
3328 enum nl80211_channel_type channel_type,
3329 unsigned int duration, gfp_t gfp);
3332 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3333 * @wdev: wireless device
3334 * @cookie: the request cookie
3335 * @chan: The current channel (from remain_on_channel request)
3336 * @channel_type: Channel type
3337 * @gfp: allocation flags
3339 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
3340 struct ieee80211_channel *chan,
3341 enum nl80211_channel_type channel_type,
3346 * cfg80211_new_sta - notify userspace about station
3349 * @mac_addr: the station's address
3350 * @sinfo: the station information
3351 * @gfp: allocation flags
3353 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3354 struct station_info *sinfo, gfp_t gfp);
3357 * cfg80211_del_sta - notify userspace about deletion of a station
3360 * @mac_addr: the station's address
3361 * @gfp: allocation flags
3363 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3366 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3367 * @wdev: wireless device receiving the frame
3368 * @freq: Frequency on which the frame was received in MHz
3369 * @sig_dbm: signal strength in mBm, or 0 if unknown
3370 * @buf: Management frame (header + body)
3371 * @len: length of the frame data
3372 * @gfp: context flags
3374 * Returns %true if a user space application has registered for this frame.
3375 * For action frames, that makes it responsible for rejecting unrecognized
3376 * action frames; %false otherwise, in which case for action frames the
3377 * driver is responsible for rejecting the frame.
3379 * This function is called whenever an Action frame is received for a station
3380 * mode interface, but is not processed in kernel.
3382 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
3383 const u8 *buf, size_t len, gfp_t gfp);
3386 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3387 * @wdev: wireless device receiving the frame
3388 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3389 * @buf: Management frame (header + body)
3390 * @len: length of the frame data
3391 * @ack: Whether frame was acknowledged
3392 * @gfp: context flags
3394 * This function is called whenever a management frame was requested to be
3395 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3396 * transmission attempt.
3398 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
3399 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3403 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3404 * @dev: network device
3405 * @rssi_event: the triggered RSSI event
3406 * @gfp: context flags
3408 * This function is called when a configured connection quality monitoring
3409 * rssi threshold reached event occurs.
3411 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3412 enum nl80211_cqm_rssi_threshold_event rssi_event,
3416 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3417 * @dev: network device
3418 * @peer: peer's MAC address
3419 * @num_packets: how many packets were lost -- should be a fixed threshold
3420 * but probably no less than maybe 50, or maybe a throughput dependent
3421 * threshold (to account for temporary interference)
3422 * @gfp: context flags
3424 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3425 const u8 *peer, u32 num_packets, gfp_t gfp);
3428 * cfg80211_cqm_txe_notify - TX error rate event
3429 * @dev: network device
3430 * @peer: peer's MAC address
3431 * @num_packets: how many packets were lost
3432 * @rate: % of packets which failed transmission
3433 * @intvl: interval (in s) over which the TX failure threshold was breached.
3434 * @gfp: context flags
3436 * Notify userspace when configured % TX failures over number of packets in a
3437 * given interval is exceeded.
3439 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
3440 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
3443 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3444 * @dev: network device
3445 * @bssid: BSSID of AP (to avoid races)
3446 * @replay_ctr: new replay counter
3447 * @gfp: allocation flags
3449 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3450 const u8 *replay_ctr, gfp_t gfp);
3453 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3454 * @dev: network device
3455 * @index: candidate index (the smaller the index, the higher the priority)
3456 * @bssid: BSSID of AP
3457 * @preauth: Whether AP advertises support for RSN pre-authentication
3458 * @gfp: allocation flags
3460 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3461 const u8 *bssid, bool preauth, gfp_t gfp);
3464 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3465 * @dev: The device the frame matched to
3466 * @addr: the transmitter address
3467 * @gfp: context flags
3469 * This function is used in AP mode (only!) to inform userspace that
3470 * a spurious class 3 frame was received, to be able to deauth the
3472 * Returns %true if the frame was passed to userspace (or this failed
3473 * for a reason other than not having a subscription.)
3475 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3476 const u8 *addr, gfp_t gfp);
3479 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3480 * @dev: The device the frame matched to
3481 * @addr: the transmitter address
3482 * @gfp: context flags
3484 * This function is used in AP mode (only!) to inform userspace that
3485 * an associated station sent a 4addr frame but that wasn't expected.
3486 * It is allowed and desirable to send this event only once for each
3487 * station to avoid event flooding.
3488 * Returns %true if the frame was passed to userspace (or this failed
3489 * for a reason other than not having a subscription.)
3491 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3492 const u8 *addr, gfp_t gfp);
3495 * cfg80211_probe_status - notify userspace about probe status
3496 * @dev: the device the probe was sent on
3497 * @addr: the address of the peer
3498 * @cookie: the cookie filled in @probe_client previously
3499 * @acked: indicates whether probe was acked or not
3500 * @gfp: allocation flags
3502 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3503 u64 cookie, bool acked, gfp_t gfp);
3506 * cfg80211_report_obss_beacon - report beacon from other APs
3507 * @wiphy: The wiphy that received the beacon
3509 * @len: length of the frame
3510 * @freq: frequency the frame was received on
3511 * @sig_dbm: signal strength in mBm, or 0 if unknown
3512 * @gfp: allocation flags
3514 * Use this function to report to userspace when a beacon was
3515 * received. It is not useful to call this when there is no
3516 * netdev that is in AP/GO mode.
3518 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3519 const u8 *frame, size_t len,
3520 int freq, int sig_dbm, gfp_t gfp);
3523 * cfg80211_can_beacon_sec_chan - test if ht40 on extension channel can be used
3525 * @chan: main channel
3526 * @channel_type: HT mode
3528 * This function returns true if there is no secondary channel or the secondary
3529 * channel can be used for beaconing (i.e. is not a radar channel etc.)
3531 bool cfg80211_can_beacon_sec_chan(struct wiphy *wiphy,
3532 struct ieee80211_channel *chan,
3533 enum nl80211_channel_type channel_type);
3536 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
3537 * @dev: the device which switched channels
3538 * @freq: new channel frequency (in MHz)
3539 * @type: channel type
3541 * Acquires wdev_lock, so must only be called from sleepable driver context!
3543 void cfg80211_ch_switch_notify(struct net_device *dev, int freq,
3544 enum nl80211_channel_type type);
3547 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
3548 * @rate: given rate_info to calculate bitrate from
3550 * return 0 if MCS index >= 32
3552 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
3555 * cfg80211_unregister_wdev - remove the given wdev
3556 * @wdev: struct wireless_dev to remove
3558 * Call this function only for wdevs that have no netdev assigned,
3559 * e.g. P2P Devices. It removes the device from the list so that
3560 * it can no longer be used. It is necessary to call this function
3561 * even when cfg80211 requests the removal of the interface by
3562 * calling the del_virtual_intf() callback. The function must also
3563 * be called when the driver wishes to unregister the wdev, e.g.
3564 * when the device is unbound from the driver.
3566 * Requires the RTNL to be held.
3568 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
3570 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3572 /* wiphy_printk helpers, similar to dev_printk */
3574 #define wiphy_printk(level, wiphy, format, args...) \
3575 dev_printk(level, &(wiphy)->dev, format, ##args)
3576 #define wiphy_emerg(wiphy, format, args...) \
3577 dev_emerg(&(wiphy)->dev, format, ##args)
3578 #define wiphy_alert(wiphy, format, args...) \
3579 dev_alert(&(wiphy)->dev, format, ##args)
3580 #define wiphy_crit(wiphy, format, args...) \
3581 dev_crit(&(wiphy)->dev, format, ##args)
3582 #define wiphy_err(wiphy, format, args...) \
3583 dev_err(&(wiphy)->dev, format, ##args)
3584 #define wiphy_warn(wiphy, format, args...) \
3585 dev_warn(&(wiphy)->dev, format, ##args)
3586 #define wiphy_notice(wiphy, format, args...) \
3587 dev_notice(&(wiphy)->dev, format, ##args)
3588 #define wiphy_info(wiphy, format, args...) \
3589 dev_info(&(wiphy)->dev, format, ##args)
3591 #define wiphy_debug(wiphy, format, args...) \
3592 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3594 #define wiphy_dbg(wiphy, format, args...) \
3595 dev_dbg(&(wiphy)->dev, format, ##args)
3597 #if defined(VERBOSE_DEBUG)
3598 #define wiphy_vdbg wiphy_dbg
3600 #define wiphy_vdbg(wiphy, format, args...) \
3603 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3609 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3610 * of using a WARN/WARN_ON to get the message out, including the
3611 * file/line information and a backtrace.
3613 #define wiphy_WARN(wiphy, format, args...) \
3614 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3616 #endif /* __NET_CFG80211_H */