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 <linux/net.h>
23 #include <net/regulatory.h>
28 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29 * userspace and drivers, and offers some utility functionality associated
30 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31 * by all modern wireless drivers in Linux, so that they offer a consistent
32 * API through nl80211. For backward compatibility, cfg80211 also offers
33 * wireless extensions to userspace, but hides them from drivers completely.
35 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
41 * DOC: Device registration
43 * In order for a driver to use cfg80211, it must register the hardware device
44 * with cfg80211. This happens through a number of hardware capability structs
47 * The fundamental structure for each device is the 'wiphy', of which each
48 * instance describes a physical wireless device connected to the system. Each
49 * such wiphy can have zero, one, or many virtual interfaces associated with
50 * it, which need to be identified as such by pointing the network interface's
51 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52 * the wireless part of the interface, normally this struct is embedded in the
53 * network interface's private data area. Drivers can optionally allow creating
54 * or destroying virtual interfaces on the fly, but without at least one or the
55 * ability to create some the wireless device isn't useful.
57 * Each wiphy structure contains device capability information, and also has
58 * a pointer to the various operations the driver offers. The definitions and
59 * structures here describe these capabilities in detail.
65 * wireless hardware capability structures
69 * enum ieee80211_band - supported frequency bands
71 * The bands are assigned this way because the supported
72 * bitrates differ in these bands.
74 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
75 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
76 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
77 * @IEEE80211_NUM_BANDS: number of defined bands
80 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
82 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
89 * enum ieee80211_channel_flags - channel flags
91 * Channel flags set by the regulatory control code.
93 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
94 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
96 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
97 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
98 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
100 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
102 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
103 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
104 * this flag indicates that an 80 MHz channel cannot use this
105 * channel as the control or any of the secondary channels.
106 * This may be due to the driver or due to regulatory bandwidth
108 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
109 * this flag indicates that an 160 MHz channel cannot use this
110 * channel as the control or any of the secondary channels.
111 * This may be due to the driver or due to regulatory bandwidth
114 enum ieee80211_channel_flags {
115 IEEE80211_CHAN_DISABLED = 1<<0,
116 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
117 IEEE80211_CHAN_NO_IBSS = 1<<2,
118 IEEE80211_CHAN_RADAR = 1<<3,
119 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
120 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
121 IEEE80211_CHAN_NO_OFDM = 1<<6,
122 IEEE80211_CHAN_NO_80MHZ = 1<<7,
123 IEEE80211_CHAN_NO_160MHZ = 1<<8,
126 #define IEEE80211_CHAN_NO_HT40 \
127 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
129 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
130 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
133 * struct ieee80211_channel - channel definition
135 * This structure describes a single channel for use
138 * @center_freq: center frequency in MHz
139 * @hw_value: hardware-specific value for the channel
140 * @flags: channel flags from &enum ieee80211_channel_flags.
141 * @orig_flags: channel flags at registration time, used by regulatory
142 * code to support devices with additional restrictions
143 * @band: band this channel belongs to.
144 * @max_antenna_gain: maximum antenna gain in dBi
145 * @max_power: maximum transmission power (in dBm)
146 * @max_reg_power: maximum regulatory transmission power (in dBm)
147 * @beacon_found: helper to regulatory code to indicate when a beacon
148 * has been found on this channel. Use regulatory_hint_found_beacon()
149 * to enable this, this is useful only on 5 GHz band.
150 * @orig_mag: internal use
151 * @orig_mpwr: internal use
152 * @dfs_state: current state of this channel. Only relevant if radar is required
154 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
156 struct ieee80211_channel {
157 enum ieee80211_band band;
161 int max_antenna_gain;
166 int orig_mag, orig_mpwr;
167 enum nl80211_dfs_state dfs_state;
168 unsigned long dfs_state_entered;
172 * enum ieee80211_rate_flags - rate flags
174 * Hardware/specification flags for rates. These are structured
175 * in a way that allows using the same bitrate structure for
176 * different bands/PHY modes.
178 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
179 * preamble on this bitrate; only relevant in 2.4GHz band and
181 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
182 * when used with 802.11a (on the 5 GHz band); filled by the
183 * core code when registering the wiphy.
184 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
185 * when used with 802.11b (on the 2.4 GHz band); filled by the
186 * core code when registering the wiphy.
187 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
188 * when used with 802.11g (on the 2.4 GHz band); filled by the
189 * core code when registering the wiphy.
190 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
192 enum ieee80211_rate_flags {
193 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
194 IEEE80211_RATE_MANDATORY_A = 1<<1,
195 IEEE80211_RATE_MANDATORY_B = 1<<2,
196 IEEE80211_RATE_MANDATORY_G = 1<<3,
197 IEEE80211_RATE_ERP_G = 1<<4,
201 * struct ieee80211_rate - bitrate definition
203 * This structure describes a bitrate that an 802.11 PHY can
204 * operate with. The two values @hw_value and @hw_value_short
205 * are only for driver use when pointers to this structure are
208 * @flags: rate-specific flags
209 * @bitrate: bitrate in units of 100 Kbps
210 * @hw_value: driver/hardware value for this rate
211 * @hw_value_short: driver/hardware value for this rate when
212 * short preamble is used
214 struct ieee80211_rate {
217 u16 hw_value, hw_value_short;
221 * struct ieee80211_sta_ht_cap - STA's HT capabilities
223 * This structure describes most essential parameters needed
224 * to describe 802.11n HT capabilities for an STA.
226 * @ht_supported: is HT supported by the STA
227 * @cap: HT capabilities map as described in 802.11n spec
228 * @ampdu_factor: Maximum A-MPDU length factor
229 * @ampdu_density: Minimum A-MPDU spacing
230 * @mcs: Supported MCS rates
232 struct ieee80211_sta_ht_cap {
233 u16 cap; /* use IEEE80211_HT_CAP_ */
237 struct ieee80211_mcs_info mcs;
241 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
243 * This structure describes most essential parameters needed
244 * to describe 802.11ac VHT capabilities for an STA.
246 * @vht_supported: is VHT supported by the STA
247 * @cap: VHT capabilities map as described in 802.11ac spec
248 * @vht_mcs: Supported VHT MCS rates
250 struct ieee80211_sta_vht_cap {
252 u32 cap; /* use IEEE80211_VHT_CAP_ */
253 struct ieee80211_vht_mcs_info vht_mcs;
257 * struct ieee80211_supported_band - frequency band definition
259 * This structure describes a frequency band a wiphy
260 * is able to operate in.
262 * @channels: Array of channels the hardware can operate in
264 * @band: the band this structure represents
265 * @n_channels: Number of channels in @channels
266 * @bitrates: Array of bitrates the hardware can operate with
267 * in this band. Must be sorted to give a valid "supported
268 * rates" IE, i.e. CCK rates first, then OFDM.
269 * @n_bitrates: Number of bitrates in @bitrates
270 * @ht_cap: HT capabilities in this band
271 * @vht_cap: VHT capabilities in this band
273 struct ieee80211_supported_band {
274 struct ieee80211_channel *channels;
275 struct ieee80211_rate *bitrates;
276 enum ieee80211_band band;
279 struct ieee80211_sta_ht_cap ht_cap;
280 struct ieee80211_sta_vht_cap vht_cap;
284 * Wireless hardware/device configuration structures and methods
288 * DOC: Actions and configuration
290 * Each wireless device and each virtual interface offer a set of configuration
291 * operations and other actions that are invoked by userspace. Each of these
292 * actions is described in the operations structure, and the parameters these
293 * operations use are described separately.
295 * Additionally, some operations are asynchronous and expect to get status
296 * information via some functions that drivers need to call.
298 * Scanning and BSS list handling with its associated functionality is described
299 * in a separate chapter.
303 * struct vif_params - describes virtual interface parameters
304 * @use_4addr: use 4-address frames
305 * @macaddr: address to use for this virtual interface. This will only
306 * be used for non-netdevice interfaces. If this parameter is set
307 * to zero address the driver may determine the address as needed.
311 u8 macaddr[ETH_ALEN];
315 * struct key_params - key information
317 * Information about a key
320 * @key_len: length of key material
321 * @cipher: cipher suite selector
322 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
323 * with the get_key() callback, must be in little endian,
324 * length given by @seq_len.
325 * @seq_len: length of @seq.
336 * struct cfg80211_chan_def - channel definition
337 * @chan: the (control) channel
338 * @width: channel width
339 * @center_freq1: center frequency of first segment
340 * @center_freq2: center frequency of second segment
341 * (only with 80+80 MHz)
343 struct cfg80211_chan_def {
344 struct ieee80211_channel *chan;
345 enum nl80211_chan_width width;
351 * cfg80211_get_chandef_type - return old channel type from chandef
352 * @chandef: the channel definition
354 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
355 * chandef, which must have a bandwidth allowing this conversion.
357 static inline enum nl80211_channel_type
358 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
360 switch (chandef->width) {
361 case NL80211_CHAN_WIDTH_20_NOHT:
362 return NL80211_CHAN_NO_HT;
363 case NL80211_CHAN_WIDTH_20:
364 return NL80211_CHAN_HT20;
365 case NL80211_CHAN_WIDTH_40:
366 if (chandef->center_freq1 > chandef->chan->center_freq)
367 return NL80211_CHAN_HT40PLUS;
368 return NL80211_CHAN_HT40MINUS;
371 return NL80211_CHAN_NO_HT;
376 * cfg80211_chandef_create - create channel definition using channel type
377 * @chandef: the channel definition struct to fill
378 * @channel: the control channel
379 * @chantype: the channel type
381 * Given a channel type, create a channel definition.
383 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
384 struct ieee80211_channel *channel,
385 enum nl80211_channel_type chantype);
388 * cfg80211_chandef_identical - check if two channel definitions are identical
389 * @chandef1: first channel definition
390 * @chandef2: second channel definition
392 * Return: %true if the channels defined by the channel definitions are
393 * identical, %false otherwise.
396 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
397 const struct cfg80211_chan_def *chandef2)
399 return (chandef1->chan == chandef2->chan &&
400 chandef1->width == chandef2->width &&
401 chandef1->center_freq1 == chandef2->center_freq1 &&
402 chandef1->center_freq2 == chandef2->center_freq2);
406 * cfg80211_chandef_compatible - check if two channel definitions are compatible
407 * @chandef1: first channel definition
408 * @chandef2: second channel definition
410 * Return: %NULL if the given channel definitions are incompatible,
411 * chandef1 or chandef2 otherwise.
413 const struct cfg80211_chan_def *
414 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
415 const struct cfg80211_chan_def *chandef2);
418 * cfg80211_chandef_valid - check if a channel definition is valid
419 * @chandef: the channel definition to check
420 * Return: %true if the channel definition is valid. %false otherwise.
422 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
425 * cfg80211_chandef_usable - check if secondary channels can be used
426 * @wiphy: the wiphy to validate against
427 * @chandef: the channel definition to check
428 * @prohibited_flags: the regulatory channel flags that must not be set
429 * Return: %true if secondary channels are usable. %false otherwise.
431 bool cfg80211_chandef_usable(struct wiphy *wiphy,
432 const struct cfg80211_chan_def *chandef,
433 u32 prohibited_flags);
436 * enum survey_info_flags - survey information flags
438 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
439 * @SURVEY_INFO_IN_USE: channel is currently being used
440 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
441 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
442 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
443 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
444 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
446 * Used by the driver to indicate which info in &struct survey_info
447 * it has filled in during the get_survey().
449 enum survey_info_flags {
450 SURVEY_INFO_NOISE_DBM = 1<<0,
451 SURVEY_INFO_IN_USE = 1<<1,
452 SURVEY_INFO_CHANNEL_TIME = 1<<2,
453 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
454 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
455 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
456 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
460 * struct survey_info - channel survey response
462 * @channel: the channel this survey record reports, mandatory
463 * @filled: bitflag of flags from &enum survey_info_flags
464 * @noise: channel noise in dBm. This and all following fields are
466 * @channel_time: amount of time in ms the radio spent on the channel
467 * @channel_time_busy: amount of time the primary channel was sensed busy
468 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
469 * @channel_time_rx: amount of time the radio spent receiving data
470 * @channel_time_tx: amount of time the radio spent transmitting data
472 * Used by dump_survey() to report back per-channel survey information.
474 * This structure can later be expanded with things like
475 * channel duty cycle etc.
478 struct ieee80211_channel *channel;
480 u64 channel_time_busy;
481 u64 channel_time_ext_busy;
489 * struct cfg80211_crypto_settings - Crypto settings
490 * @wpa_versions: indicates which, if any, WPA versions are enabled
491 * (from enum nl80211_wpa_versions)
492 * @cipher_group: group key cipher suite (or 0 if unset)
493 * @n_ciphers_pairwise: number of AP supported unicast ciphers
494 * @ciphers_pairwise: unicast key cipher suites
495 * @n_akm_suites: number of AKM suites
496 * @akm_suites: AKM suites
497 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
498 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
499 * required to assume that the port is unauthorized until authorized by
500 * user space. Otherwise, port is marked authorized by default.
501 * @control_port_ethertype: the control port protocol that should be
502 * allowed through even on unauthorized ports
503 * @control_port_no_encrypt: TRUE to prevent encryption of control port
506 struct cfg80211_crypto_settings {
509 int n_ciphers_pairwise;
510 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
512 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
514 __be16 control_port_ethertype;
515 bool control_port_no_encrypt;
519 * struct cfg80211_beacon_data - beacon data
520 * @head: head portion of beacon (before TIM IE)
521 * or %NULL if not changed
522 * @tail: tail portion of beacon (after TIM IE)
523 * or %NULL if not changed
524 * @head_len: length of @head
525 * @tail_len: length of @tail
526 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
527 * @beacon_ies_len: length of beacon_ies in octets
528 * @proberesp_ies: extra information element(s) to add into Probe Response
530 * @proberesp_ies_len: length of proberesp_ies in octets
531 * @assocresp_ies: extra information element(s) to add into (Re)Association
532 * Response frames or %NULL
533 * @assocresp_ies_len: length of assocresp_ies in octets
534 * @probe_resp_len: length of probe response template (@probe_resp)
535 * @probe_resp: probe response template (AP mode only)
537 struct cfg80211_beacon_data {
538 const u8 *head, *tail;
539 const u8 *beacon_ies;
540 const u8 *proberesp_ies;
541 const u8 *assocresp_ies;
542 const u8 *probe_resp;
544 size_t head_len, tail_len;
545 size_t beacon_ies_len;
546 size_t proberesp_ies_len;
547 size_t assocresp_ies_len;
548 size_t probe_resp_len;
556 * struct cfg80211_acl_data - Access control list data
558 * @acl_policy: ACL policy to be applied on the station's
559 * entry specified by mac_addr
560 * @n_acl_entries: Number of MAC address entries passed
561 * @mac_addrs: List of MAC addresses of stations to be used for ACL
563 struct cfg80211_acl_data {
564 enum nl80211_acl_policy acl_policy;
568 struct mac_address mac_addrs[];
572 * struct cfg80211_ap_settings - AP configuration
574 * Used to configure an AP interface.
576 * @chandef: defines the channel to use
577 * @beacon: beacon data
578 * @beacon_interval: beacon interval
579 * @dtim_period: DTIM period
580 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
582 * @ssid_len: length of @ssid
583 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
584 * @crypto: crypto settings
585 * @privacy: the BSS uses privacy
586 * @auth_type: Authentication type (algorithm)
587 * @inactivity_timeout: time in seconds to determine station's inactivity.
588 * @p2p_ctwindow: P2P CT Window
589 * @p2p_opp_ps: P2P opportunistic PS
590 * @acl: ACL configuration used by the drivers which has support for
591 * MAC address based access control
592 * @radar_required: set if radar detection is required
594 struct cfg80211_ap_settings {
595 struct cfg80211_chan_def chandef;
597 struct cfg80211_beacon_data beacon;
599 int beacon_interval, dtim_period;
602 enum nl80211_hidden_ssid hidden_ssid;
603 struct cfg80211_crypto_settings crypto;
605 enum nl80211_auth_type auth_type;
606 int inactivity_timeout;
609 const struct cfg80211_acl_data *acl;
614 * enum station_parameters_apply_mask - station parameter values to apply
615 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
616 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
617 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
619 * Not all station parameters have in-band "no change" signalling,
620 * for those that don't these flags will are used.
622 enum station_parameters_apply_mask {
623 STATION_PARAM_APPLY_UAPSD = BIT(0),
624 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
625 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
629 * struct station_parameters - station parameters
631 * Used to change and create a new station.
633 * @vlan: vlan interface station should belong to
634 * @supported_rates: supported rates in IEEE 802.11 format
635 * (or NULL for no change)
636 * @supported_rates_len: number of supported rates
637 * @sta_flags_mask: station flags that changed
638 * (bitmask of BIT(NL80211_STA_FLAG_...))
639 * @sta_flags_set: station flags values
640 * (bitmask of BIT(NL80211_STA_FLAG_...))
641 * @listen_interval: listen interval or -1 for no change
642 * @aid: AID or zero for no change
643 * @plink_action: plink action to take
644 * @plink_state: set the peer link state for a station
645 * @ht_capa: HT capabilities of station
646 * @vht_capa: VHT capabilities of station
647 * @uapsd_queues: bitmap of queues configured for uapsd. same format
648 * as the AC bitmap in the QoS info field
649 * @max_sp: max Service Period. same format as the MAX_SP in the
650 * QoS info field (but already shifted down)
651 * @sta_modify_mask: bitmap indicating which parameters changed
652 * (for those that don't have a natural "no change" value),
653 * see &enum station_parameters_apply_mask
654 * @local_pm: local link-specific mesh power save mode (no change when set
656 * @capability: station capability
657 * @ext_capab: extended capabilities of the station
658 * @ext_capab_len: number of extended capabilities
660 struct station_parameters {
661 const u8 *supported_rates;
662 struct net_device *vlan;
663 u32 sta_flags_mask, sta_flags_set;
667 u8 supported_rates_len;
670 const struct ieee80211_ht_cap *ht_capa;
671 const struct ieee80211_vht_cap *vht_capa;
674 enum nl80211_mesh_power_mode local_pm;
681 * enum cfg80211_station_type - the type of station being modified
682 * @CFG80211_STA_AP_CLIENT: client of an AP interface
683 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
684 * the AP MLME in the device
685 * @CFG80211_STA_AP_STA: AP station on managed interface
686 * @CFG80211_STA_IBSS: IBSS station
687 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
688 * while TDLS setup is in progress, it moves out of this state when
689 * being marked authorized; use this only if TDLS with external setup is
691 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
692 * entry that is operating, has been marked authorized by userspace)
693 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
694 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
696 enum cfg80211_station_type {
697 CFG80211_STA_AP_CLIENT,
698 CFG80211_STA_AP_MLME_CLIENT,
701 CFG80211_STA_TDLS_PEER_SETUP,
702 CFG80211_STA_TDLS_PEER_ACTIVE,
703 CFG80211_STA_MESH_PEER_KERNEL,
704 CFG80211_STA_MESH_PEER_USER,
708 * cfg80211_check_station_change - validate parameter changes
709 * @wiphy: the wiphy this operates on
710 * @params: the new parameters for a station
711 * @statype: the type of station being modified
713 * Utility function for the @change_station driver method. Call this function
714 * with the appropriate station type looking up the station (and checking that
715 * it exists). It will verify whether the station change is acceptable, and if
716 * not will return an error code. Note that it may modify the parameters for
717 * backward compatibility reasons, so don't use them before calling this.
719 int cfg80211_check_station_change(struct wiphy *wiphy,
720 struct station_parameters *params,
721 enum cfg80211_station_type statype);
724 * enum station_info_flags - station information flags
726 * Used by the driver to indicate which info in &struct station_info
727 * it has filled in during get_station() or dump_station().
729 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
730 * @STATION_INFO_RX_BYTES: @rx_bytes filled
731 * @STATION_INFO_TX_BYTES: @tx_bytes filled
732 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
733 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
734 * @STATION_INFO_LLID: @llid filled
735 * @STATION_INFO_PLID: @plid filled
736 * @STATION_INFO_PLINK_STATE: @plink_state filled
737 * @STATION_INFO_SIGNAL: @signal filled
738 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
739 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
740 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
741 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
742 * @STATION_INFO_TX_RETRIES: @tx_retries filled
743 * @STATION_INFO_TX_FAILED: @tx_failed filled
744 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
745 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
746 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
747 * @STATION_INFO_BSS_PARAM: @bss_param filled
748 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
749 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
750 * @STATION_INFO_STA_FLAGS: @sta_flags filled
751 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
752 * @STATION_INFO_T_OFFSET: @t_offset filled
753 * @STATION_INFO_LOCAL_PM: @local_pm filled
754 * @STATION_INFO_PEER_PM: @peer_pm filled
755 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
756 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
757 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
759 enum station_info_flags {
760 STATION_INFO_INACTIVE_TIME = 1<<0,
761 STATION_INFO_RX_BYTES = 1<<1,
762 STATION_INFO_TX_BYTES = 1<<2,
763 STATION_INFO_LLID = 1<<3,
764 STATION_INFO_PLID = 1<<4,
765 STATION_INFO_PLINK_STATE = 1<<5,
766 STATION_INFO_SIGNAL = 1<<6,
767 STATION_INFO_TX_BITRATE = 1<<7,
768 STATION_INFO_RX_PACKETS = 1<<8,
769 STATION_INFO_TX_PACKETS = 1<<9,
770 STATION_INFO_TX_RETRIES = 1<<10,
771 STATION_INFO_TX_FAILED = 1<<11,
772 STATION_INFO_RX_DROP_MISC = 1<<12,
773 STATION_INFO_SIGNAL_AVG = 1<<13,
774 STATION_INFO_RX_BITRATE = 1<<14,
775 STATION_INFO_BSS_PARAM = 1<<15,
776 STATION_INFO_CONNECTED_TIME = 1<<16,
777 STATION_INFO_ASSOC_REQ_IES = 1<<17,
778 STATION_INFO_STA_FLAGS = 1<<18,
779 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
780 STATION_INFO_T_OFFSET = 1<<20,
781 STATION_INFO_LOCAL_PM = 1<<21,
782 STATION_INFO_PEER_PM = 1<<22,
783 STATION_INFO_NONPEER_PM = 1<<23,
784 STATION_INFO_RX_BYTES64 = 1<<24,
785 STATION_INFO_TX_BYTES64 = 1<<25,
786 STATION_INFO_CHAIN_SIGNAL = 1<<26,
787 STATION_INFO_CHAIN_SIGNAL_AVG = 1<<27,
791 * enum station_info_rate_flags - bitrate info flags
793 * Used by the driver to indicate the specific rate transmission
794 * type for 802.11n transmissions.
796 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
797 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
798 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
799 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
800 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
801 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
802 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
803 * @RATE_INFO_FLAGS_60G: 60GHz MCS
805 enum rate_info_flags {
806 RATE_INFO_FLAGS_MCS = BIT(0),
807 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
808 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
809 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
810 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
811 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
812 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
813 RATE_INFO_FLAGS_60G = BIT(7),
817 * struct rate_info - bitrate information
819 * Information about a receiving or transmitting bitrate
821 * @flags: bitflag of flags from &enum rate_info_flags
822 * @mcs: mcs index if struct describes a 802.11n bitrate
823 * @legacy: bitrate in 100kbit/s for 802.11abg
824 * @nss: number of streams (VHT only)
834 * enum station_info_rate_flags - bitrate info flags
836 * Used by the driver to indicate the specific rate transmission
837 * type for 802.11n transmissions.
839 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
840 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
841 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
843 enum bss_param_flags {
844 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
845 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
846 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
850 * struct sta_bss_parameters - BSS parameters for the attached station
852 * Information about the currently associated BSS
854 * @flags: bitflag of flags from &enum bss_param_flags
855 * @dtim_period: DTIM period for the BSS
856 * @beacon_interval: beacon interval
858 struct sta_bss_parameters {
864 #define IEEE80211_MAX_CHAINS 4
867 * struct station_info - station information
869 * Station information filled by driver for get_station() and dump_station.
871 * @filled: bitflag of flags from &enum station_info_flags
872 * @connected_time: time(in secs) since a station is last connected
873 * @inactive_time: time since last station activity (tx/rx) in milliseconds
874 * @rx_bytes: bytes received from this station
875 * @tx_bytes: bytes transmitted to this station
876 * @llid: mesh local link id
877 * @plid: mesh peer link id
878 * @plink_state: mesh peer link state
879 * @signal: The signal strength, type depends on the wiphy's signal_type.
880 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
881 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
882 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
883 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
884 * @chain_signal: per-chain signal strength of last received packet in dBm
885 * @chain_signal_avg: per-chain signal strength average in dBm
886 * @txrate: current unicast bitrate from this station
887 * @rxrate: current unicast bitrate to this station
888 * @rx_packets: packets received from this station
889 * @tx_packets: packets transmitted to this station
890 * @tx_retries: cumulative retry counts
891 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
892 * @rx_dropped_misc: Dropped for un-specified reason.
893 * @bss_param: current BSS parameters
894 * @generation: generation number for nl80211 dumps.
895 * This number should increase every time the list of stations
896 * changes, i.e. when a station is added or removed, so that
897 * userspace can tell whether it got a consistent snapshot.
898 * @assoc_req_ies: IEs from (Re)Association Request.
899 * This is used only when in AP mode with drivers that do not use
900 * user space MLME/SME implementation. The information is provided for
901 * the cfg80211_new_sta() calls to notify user space of the IEs.
902 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
903 * @sta_flags: station flags mask & values
904 * @beacon_loss_count: Number of times beacon loss event has triggered.
905 * @t_offset: Time offset of the station relative to this host.
906 * @local_pm: local mesh STA power save mode
907 * @peer_pm: peer mesh STA power save mode
908 * @nonpeer_pm: non-peer mesh STA power save mode
910 struct station_info {
923 s8 chain_signal[IEEE80211_MAX_CHAINS];
924 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
926 struct rate_info txrate;
927 struct rate_info rxrate;
933 struct sta_bss_parameters bss_param;
934 struct nl80211_sta_flag_update sta_flags;
938 const u8 *assoc_req_ies;
939 size_t assoc_req_ies_len;
941 u32 beacon_loss_count;
943 enum nl80211_mesh_power_mode local_pm;
944 enum nl80211_mesh_power_mode peer_pm;
945 enum nl80211_mesh_power_mode nonpeer_pm;
948 * Note: Add a new enum station_info_flags value for each new field and
949 * use it to check which fields are initialized.
954 * enum monitor_flags - monitor flags
956 * Monitor interface configuration flags. Note that these must be the bits
957 * according to the nl80211 flags.
959 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
960 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
961 * @MONITOR_FLAG_CONTROL: pass control frames
962 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
963 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
966 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
967 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
968 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
969 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
970 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
974 * enum mpath_info_flags - mesh path information flags
976 * Used by the driver to indicate which info in &struct mpath_info it has filled
977 * in during get_station() or dump_station().
979 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
980 * @MPATH_INFO_SN: @sn filled
981 * @MPATH_INFO_METRIC: @metric filled
982 * @MPATH_INFO_EXPTIME: @exptime filled
983 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
984 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
985 * @MPATH_INFO_FLAGS: @flags filled
987 enum mpath_info_flags {
988 MPATH_INFO_FRAME_QLEN = BIT(0),
989 MPATH_INFO_SN = BIT(1),
990 MPATH_INFO_METRIC = BIT(2),
991 MPATH_INFO_EXPTIME = BIT(3),
992 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
993 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
994 MPATH_INFO_FLAGS = BIT(6),
998 * struct mpath_info - mesh path information
1000 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1002 * @filled: bitfield of flags from &enum mpath_info_flags
1003 * @frame_qlen: number of queued frames for this destination
1004 * @sn: target sequence number
1005 * @metric: metric (cost) of this mesh path
1006 * @exptime: expiration time for the mesh path from now, in msecs
1007 * @flags: mesh path flags
1008 * @discovery_timeout: total mesh path discovery timeout, in msecs
1009 * @discovery_retries: mesh path discovery retries
1010 * @generation: generation number for nl80211 dumps.
1011 * This number should increase every time the list of mesh paths
1012 * changes, i.e. when a station is added or removed, so that
1013 * userspace can tell whether it got a consistent snapshot.
1021 u32 discovery_timeout;
1022 u8 discovery_retries;
1029 * struct bss_parameters - BSS parameters
1031 * Used to change BSS parameters (mainly for AP mode).
1033 * @use_cts_prot: Whether to use CTS protection
1034 * (0 = no, 1 = yes, -1 = do not change)
1035 * @use_short_preamble: Whether the use of short preambles is allowed
1036 * (0 = no, 1 = yes, -1 = do not change)
1037 * @use_short_slot_time: Whether the use of short slot time is allowed
1038 * (0 = no, 1 = yes, -1 = do not change)
1039 * @basic_rates: basic rates in IEEE 802.11 format
1040 * (or NULL for no change)
1041 * @basic_rates_len: number of basic rates
1042 * @ap_isolate: do not forward packets between connected stations
1043 * @ht_opmode: HT Operation mode
1044 * (u16 = opmode, -1 = do not change)
1045 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1046 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1048 struct bss_parameters {
1050 int use_short_preamble;
1051 int use_short_slot_time;
1056 s8 p2p_ctwindow, p2p_opp_ps;
1060 * struct mesh_config - 802.11s mesh configuration
1062 * These parameters can be changed while the mesh is active.
1064 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1065 * by the Mesh Peering Open message
1066 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1067 * used by the Mesh Peering Open message
1068 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1069 * the mesh peering management to close a mesh peering
1070 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1072 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1073 * be sent to establish a new peer link instance in a mesh
1074 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1075 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1077 * @auto_open_plinks: whether we should automatically open peer links when we
1078 * detect compatible mesh peers
1079 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1080 * synchronize to for 11s default synchronization method
1081 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1082 * that an originator mesh STA can send to a particular path target
1083 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1084 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1085 * a path discovery in milliseconds
1086 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1087 * receiving a PREQ shall consider the forwarding information from the
1088 * root to be valid. (TU = time unit)
1089 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1090 * which a mesh STA can send only one action frame containing a PREQ
1092 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1093 * which a mesh STA can send only one Action frame containing a PERR
1095 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1096 * it takes for an HWMP information element to propagate across the mesh
1097 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1098 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1099 * announcements are transmitted
1100 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1101 * station has access to a broader network beyond the MBSS. (This is
1102 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1103 * only means that the station will announce others it's a mesh gate, but
1104 * not necessarily using the gate announcement protocol. Still keeping the
1105 * same nomenclature to be in sync with the spec)
1106 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1107 * entity (default is TRUE - forwarding entity)
1108 * @rssi_threshold: the threshold for average signal strength of candidate
1109 * station to establish a peer link
1110 * @ht_opmode: mesh HT protection mode
1112 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1113 * receiving a proactive PREQ shall consider the forwarding information to
1114 * the root mesh STA to be valid.
1116 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1117 * PREQs are transmitted.
1118 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1119 * during which a mesh STA can send only one Action frame containing
1120 * a PREQ element for root path confirmation.
1121 * @power_mode: The default mesh power save mode which will be the initial
1122 * setting for new peer links.
1123 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1124 * after transmitting its beacon.
1126 struct mesh_config {
1127 u16 dot11MeshRetryTimeout;
1128 u16 dot11MeshConfirmTimeout;
1129 u16 dot11MeshHoldingTimeout;
1130 u16 dot11MeshMaxPeerLinks;
1131 u8 dot11MeshMaxRetries;
1134 bool auto_open_plinks;
1135 u32 dot11MeshNbrOffsetMaxNeighbor;
1136 u8 dot11MeshHWMPmaxPREQretries;
1137 u32 path_refresh_time;
1138 u16 min_discovery_timeout;
1139 u32 dot11MeshHWMPactivePathTimeout;
1140 u16 dot11MeshHWMPpreqMinInterval;
1141 u16 dot11MeshHWMPperrMinInterval;
1142 u16 dot11MeshHWMPnetDiameterTraversalTime;
1143 u8 dot11MeshHWMPRootMode;
1144 u16 dot11MeshHWMPRannInterval;
1145 bool dot11MeshGateAnnouncementProtocol;
1146 bool dot11MeshForwarding;
1149 u32 dot11MeshHWMPactivePathToRootTimeout;
1150 u16 dot11MeshHWMProotInterval;
1151 u16 dot11MeshHWMPconfirmationInterval;
1152 enum nl80211_mesh_power_mode power_mode;
1153 u16 dot11MeshAwakeWindowDuration;
1157 * struct mesh_setup - 802.11s mesh setup configuration
1158 * @chandef: defines the channel to use
1159 * @mesh_id: the mesh ID
1160 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1161 * @sync_method: which synchronization method to use
1162 * @path_sel_proto: which path selection protocol to use
1163 * @path_metric: which metric to use
1164 * @ie: vendor information elements (optional)
1165 * @ie_len: length of vendor information elements
1166 * @is_authenticated: this mesh requires authentication
1167 * @is_secure: this mesh uses security
1168 * @user_mpm: userspace handles all MPM functions
1169 * @dtim_period: DTIM period to use
1170 * @beacon_interval: beacon interval to use
1171 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1173 * These parameters are fixed when the mesh is created.
1176 struct cfg80211_chan_def chandef;
1184 bool is_authenticated;
1188 u16 beacon_interval;
1189 int mcast_rate[IEEE80211_NUM_BANDS];
1193 * struct ieee80211_txq_params - TX queue parameters
1194 * @ac: AC identifier
1195 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1196 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1198 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1200 * @aifs: Arbitration interframe space [0..255]
1202 struct ieee80211_txq_params {
1211 * DOC: Scanning and BSS list handling
1213 * The scanning process itself is fairly simple, but cfg80211 offers quite
1214 * a bit of helper functionality. To start a scan, the scan operation will
1215 * be invoked with a scan definition. This scan definition contains the
1216 * channels to scan, and the SSIDs to send probe requests for (including the
1217 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1218 * probe. Additionally, a scan request may contain extra information elements
1219 * that should be added to the probe request. The IEs are guaranteed to be
1220 * well-formed, and will not exceed the maximum length the driver advertised
1221 * in the wiphy structure.
1223 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1224 * it is responsible for maintaining the BSS list; the driver should not
1225 * maintain a list itself. For this notification, various functions exist.
1227 * Since drivers do not maintain a BSS list, there are also a number of
1228 * functions to search for a BSS and obtain information about it from the
1229 * BSS structure cfg80211 maintains. The BSS list is also made available
1234 * struct cfg80211_ssid - SSID description
1236 * @ssid_len: length of the ssid
1238 struct cfg80211_ssid {
1239 u8 ssid[IEEE80211_MAX_SSID_LEN];
1244 * struct cfg80211_scan_request - scan request description
1246 * @ssids: SSIDs to scan for (active scan only)
1247 * @n_ssids: number of SSIDs
1248 * @channels: channels to scan on.
1249 * @n_channels: total number of channels to scan
1250 * @ie: optional information element(s) to add into Probe Request or %NULL
1251 * @ie_len: length of ie in octets
1252 * @flags: bit field of flags controlling operation
1253 * @rates: bitmap of rates to advertise for each band
1254 * @wiphy: the wiphy this was for
1255 * @scan_start: time (in jiffies) when the scan started
1256 * @wdev: the wireless device to scan for
1257 * @aborted: (internal) scan request was notified as aborted
1258 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1260 struct cfg80211_scan_request {
1261 struct cfg80211_ssid *ssids;
1268 u32 rates[IEEE80211_NUM_BANDS];
1270 struct wireless_dev *wdev;
1273 struct wiphy *wiphy;
1274 unsigned long scan_start;
1279 struct ieee80211_channel *channels[0];
1283 * struct cfg80211_match_set - sets of attributes to match
1285 * @ssid: SSID to be matched
1287 struct cfg80211_match_set {
1288 struct cfg80211_ssid ssid;
1292 * struct cfg80211_sched_scan_request - scheduled scan request description
1294 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1295 * @n_ssids: number of SSIDs
1296 * @n_channels: total number of channels to scan
1297 * @interval: interval between each scheduled scan cycle
1298 * @ie: optional information element(s) to add into Probe Request or %NULL
1299 * @ie_len: length of ie in octets
1300 * @flags: bit field of flags controlling operation
1301 * @match_sets: sets of parameters to be matched for a scan result
1302 * entry to be considered valid and to be passed to the host
1303 * (others are filtered out).
1304 * If ommited, all results are passed.
1305 * @n_match_sets: number of match sets
1306 * @wiphy: the wiphy this was for
1307 * @dev: the interface
1308 * @scan_start: start time of the scheduled scan
1309 * @channels: channels to scan
1310 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1312 struct cfg80211_sched_scan_request {
1313 struct cfg80211_ssid *ssids;
1320 struct cfg80211_match_set *match_sets;
1325 struct wiphy *wiphy;
1326 struct net_device *dev;
1327 unsigned long scan_start;
1330 struct ieee80211_channel *channels[0];
1334 * enum cfg80211_signal_type - signal type
1336 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1337 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1338 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1340 enum cfg80211_signal_type {
1341 CFG80211_SIGNAL_TYPE_NONE,
1342 CFG80211_SIGNAL_TYPE_MBM,
1343 CFG80211_SIGNAL_TYPE_UNSPEC,
1347 * struct cfg80211_bss_ie_data - BSS entry IE data
1348 * @tsf: TSF contained in the frame that carried these IEs
1349 * @rcu_head: internal use, for freeing
1350 * @len: length of the IEs
1353 struct cfg80211_bss_ies {
1355 struct rcu_head rcu_head;
1361 * struct cfg80211_bss - BSS description
1363 * This structure describes a BSS (which may also be a mesh network)
1364 * for use in scan results and similar.
1366 * @channel: channel this BSS is on
1367 * @bssid: BSSID of the BSS
1368 * @beacon_interval: the beacon interval as from the frame
1369 * @capability: the capability field in host byte order
1370 * @ies: the information elements (Note that there is no guarantee that these
1371 * are well-formed!); this is a pointer to either the beacon_ies or
1372 * proberesp_ies depending on whether Probe Response frame has been
1373 * received. It is always non-%NULL.
1374 * @beacon_ies: the information elements from the last Beacon frame
1375 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1376 * own the beacon_ies, but they're just pointers to the ones from the
1377 * @hidden_beacon_bss struct)
1378 * @proberesp_ies: the information elements from the last Probe Response frame
1379 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1380 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1381 * that holds the beacon data. @beacon_ies is still valid, of course, and
1382 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1383 * @signal: signal strength value (type depends on the wiphy's signal_type)
1384 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1386 struct cfg80211_bss {
1387 struct ieee80211_channel *channel;
1389 const struct cfg80211_bss_ies __rcu *ies;
1390 const struct cfg80211_bss_ies __rcu *beacon_ies;
1391 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1393 struct cfg80211_bss *hidden_beacon_bss;
1397 u16 beacon_interval;
1402 u8 priv[0] __aligned(sizeof(void *));
1406 * ieee80211_bss_get_ie - find IE with given ID
1407 * @bss: the bss to search
1410 * Note that the return value is an RCU-protected pointer, so
1411 * rcu_read_lock() must be held when calling this function.
1412 * Return: %NULL if not found.
1414 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1418 * struct cfg80211_auth_request - Authentication request data
1420 * This structure provides information needed to complete IEEE 802.11
1423 * @bss: The BSS to authenticate with.
1424 * @auth_type: Authentication type (algorithm)
1425 * @ie: Extra IEs to add to Authentication frame or %NULL
1426 * @ie_len: Length of ie buffer in octets
1427 * @key_len: length of WEP key for shared key authentication
1428 * @key_idx: index of WEP key for shared key authentication
1429 * @key: WEP key for shared key authentication
1430 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1431 * Authentication transaction sequence number field.
1432 * @sae_data_len: Length of sae_data buffer in octets
1434 struct cfg80211_auth_request {
1435 struct cfg80211_bss *bss;
1438 enum nl80211_auth_type auth_type;
1440 u8 key_len, key_idx;
1442 size_t sae_data_len;
1446 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1448 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1449 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1451 enum cfg80211_assoc_req_flags {
1452 ASSOC_REQ_DISABLE_HT = BIT(0),
1453 ASSOC_REQ_DISABLE_VHT = BIT(1),
1457 * struct cfg80211_assoc_request - (Re)Association request data
1459 * This structure provides information needed to complete IEEE 802.11
1461 * @bss: The BSS to associate with. If the call is successful the driver
1462 * is given a reference that it must release, normally via a call to
1463 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1464 * call to cfg80211_put_bss() (in addition to calling
1465 * cfg80211_send_assoc_timeout())
1466 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1467 * @ie_len: Length of ie buffer in octets
1468 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1469 * @crypto: crypto settings
1470 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1471 * @flags: See &enum cfg80211_assoc_req_flags
1472 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1473 * will be used in ht_capa. Un-supported values will be ignored.
1474 * @ht_capa_mask: The bits of ht_capa which are to be used.
1475 * @vht_capa: VHT capability override
1476 * @vht_capa_mask: VHT capability mask indicating which fields to use
1478 struct cfg80211_assoc_request {
1479 struct cfg80211_bss *bss;
1480 const u8 *ie, *prev_bssid;
1482 struct cfg80211_crypto_settings crypto;
1485 struct ieee80211_ht_cap ht_capa;
1486 struct ieee80211_ht_cap ht_capa_mask;
1487 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1491 * struct cfg80211_deauth_request - Deauthentication request data
1493 * This structure provides information needed to complete IEEE 802.11
1496 * @bssid: the BSSID of the BSS to deauthenticate from
1497 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1498 * @ie_len: Length of ie buffer in octets
1499 * @reason_code: The reason code for the deauthentication
1500 * @local_state_change: if set, change local state only and
1501 * do not set a deauth frame
1503 struct cfg80211_deauth_request {
1508 bool local_state_change;
1512 * struct cfg80211_disassoc_request - Disassociation request data
1514 * This structure provides information needed to complete IEEE 802.11
1517 * @bss: the BSS to disassociate from
1518 * @ie: Extra IEs to add to Disassociation frame or %NULL
1519 * @ie_len: Length of ie buffer in octets
1520 * @reason_code: The reason code for the disassociation
1521 * @local_state_change: This is a request for a local state only, i.e., no
1522 * Disassociation frame is to be transmitted.
1524 struct cfg80211_disassoc_request {
1525 struct cfg80211_bss *bss;
1529 bool local_state_change;
1533 * struct cfg80211_ibss_params - IBSS parameters
1535 * This structure defines the IBSS parameters for the join_ibss()
1538 * @ssid: The SSID, will always be non-null.
1539 * @ssid_len: The length of the SSID, will always be non-zero.
1540 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1541 * search for IBSSs with a different BSSID.
1542 * @chandef: defines the channel to use if no other IBSS to join can be found
1543 * @channel_fixed: The channel should be fixed -- do not search for
1544 * IBSSs to join on other channels.
1545 * @ie: information element(s) to include in the beacon
1546 * @ie_len: length of that
1547 * @beacon_interval: beacon interval to use
1548 * @privacy: this is a protected network, keys will be configured
1550 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1551 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1552 * required to assume that the port is unauthorized until authorized by
1553 * user space. Otherwise, port is marked authorized by default.
1554 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1555 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1557 struct cfg80211_ibss_params {
1560 struct cfg80211_chan_def chandef;
1562 u8 ssid_len, ie_len;
1563 u16 beacon_interval;
1568 int mcast_rate[IEEE80211_NUM_BANDS];
1572 * struct cfg80211_connect_params - Connection parameters
1574 * This structure provides information needed to complete IEEE 802.11
1575 * authentication and association.
1577 * @channel: The channel to use or %NULL if not specified (auto-select based
1579 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1582 * @ssid_len: Length of ssid in octets
1583 * @auth_type: Authentication type (algorithm)
1584 * @ie: IEs for association request
1585 * @ie_len: Length of assoc_ie in octets
1586 * @privacy: indicates whether privacy-enabled APs should be used
1587 * @mfp: indicate whether management frame protection is used
1588 * @crypto: crypto settings
1589 * @key_len: length of WEP key for shared key authentication
1590 * @key_idx: index of WEP key for shared key authentication
1591 * @key: WEP key for shared key authentication
1592 * @flags: See &enum cfg80211_assoc_req_flags
1593 * @bg_scan_period: Background scan period in seconds
1594 * or -1 to indicate that default value is to be used.
1595 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1596 * will be used in ht_capa. Un-supported values will be ignored.
1597 * @ht_capa_mask: The bits of ht_capa which are to be used.
1598 * @vht_capa: VHT Capability overrides
1599 * @vht_capa_mask: The bits of vht_capa which are to be used.
1601 struct cfg80211_connect_params {
1602 struct ieee80211_channel *channel;
1606 enum nl80211_auth_type auth_type;
1610 enum nl80211_mfp mfp;
1611 struct cfg80211_crypto_settings crypto;
1613 u8 key_len, key_idx;
1616 struct ieee80211_ht_cap ht_capa;
1617 struct ieee80211_ht_cap ht_capa_mask;
1618 struct ieee80211_vht_cap vht_capa;
1619 struct ieee80211_vht_cap vht_capa_mask;
1623 * enum wiphy_params_flags - set_wiphy_params bitfield values
1624 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1625 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1626 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1627 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1628 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1630 enum wiphy_params_flags {
1631 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1632 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1633 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1634 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1635 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1639 * cfg80211_bitrate_mask - masks for bitrate control
1641 struct cfg80211_bitrate_mask {
1644 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1645 } control[IEEE80211_NUM_BANDS];
1648 * struct cfg80211_pmksa - PMK Security Association
1650 * This structure is passed to the set/del_pmksa() method for PMKSA
1653 * @bssid: The AP's BSSID.
1654 * @pmkid: The PMK material itself.
1656 struct cfg80211_pmksa {
1662 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1663 * @mask: bitmask where to match pattern and where to ignore bytes,
1664 * one bit per byte, in same format as nl80211
1665 * @pattern: bytes to match where bitmask is 1
1666 * @pattern_len: length of pattern (in bytes)
1667 * @pkt_offset: packet offset (in bytes)
1669 * Internal note: @mask and @pattern are allocated in one chunk of
1670 * memory, free @mask only!
1672 struct cfg80211_wowlan_trig_pkt_pattern {
1679 * struct cfg80211_wowlan_tcp - TCP connection parameters
1681 * @sock: (internal) socket for source port allocation
1682 * @src: source IP address
1683 * @dst: destination IP address
1684 * @dst_mac: destination MAC address
1685 * @src_port: source port
1686 * @dst_port: destination port
1687 * @payload_len: data payload length
1688 * @payload: data payload buffer
1689 * @payload_seq: payload sequence stamping configuration
1690 * @data_interval: interval at which to send data packets
1691 * @wake_len: wakeup payload match length
1692 * @wake_data: wakeup payload match data
1693 * @wake_mask: wakeup payload match mask
1694 * @tokens_size: length of the tokens buffer
1695 * @payload_tok: payload token usage configuration
1697 struct cfg80211_wowlan_tcp {
1698 struct socket *sock;
1700 u16 src_port, dst_port;
1701 u8 dst_mac[ETH_ALEN];
1704 struct nl80211_wowlan_tcp_data_seq payload_seq;
1707 const u8 *wake_data, *wake_mask;
1709 /* must be last, variable member */
1710 struct nl80211_wowlan_tcp_data_token payload_tok;
1714 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1716 * This structure defines the enabled WoWLAN triggers for the device.
1717 * @any: wake up on any activity -- special trigger if device continues
1718 * operating as normal during suspend
1719 * @disconnect: wake up if getting disconnected
1720 * @magic_pkt: wake up on receiving magic packet
1721 * @patterns: wake up on receiving packet matching a pattern
1722 * @n_patterns: number of patterns
1723 * @gtk_rekey_failure: wake up on GTK rekey failure
1724 * @eap_identity_req: wake up on EAP identity request packet
1725 * @four_way_handshake: wake up on 4-way handshake
1726 * @rfkill_release: wake up when rfkill is released
1727 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1728 * NULL if not configured.
1730 struct cfg80211_wowlan {
1731 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1732 eap_identity_req, four_way_handshake,
1734 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1735 struct cfg80211_wowlan_tcp *tcp;
1740 * struct cfg80211_wowlan_wakeup - wakeup report
1741 * @disconnect: woke up by getting disconnected
1742 * @magic_pkt: woke up by receiving magic packet
1743 * @gtk_rekey_failure: woke up by GTK rekey failure
1744 * @eap_identity_req: woke up by EAP identity request packet
1745 * @four_way_handshake: woke up by 4-way handshake
1746 * @rfkill_release: woke up by rfkill being released
1747 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
1748 * @packet_present_len: copied wakeup packet data
1749 * @packet_len: original wakeup packet length
1750 * @packet: The packet causing the wakeup, if any.
1751 * @packet_80211: For pattern match, magic packet and other data
1752 * frame triggers an 802.3 frame should be reported, for
1753 * disconnect due to deauth 802.11 frame. This indicates which
1755 * @tcp_match: TCP wakeup packet received
1756 * @tcp_connlost: TCP connection lost or failed to establish
1757 * @tcp_nomoretokens: TCP data ran out of tokens
1759 struct cfg80211_wowlan_wakeup {
1760 bool disconnect, magic_pkt, gtk_rekey_failure,
1761 eap_identity_req, four_way_handshake,
1762 rfkill_release, packet_80211,
1763 tcp_match, tcp_connlost, tcp_nomoretokens;
1765 u32 packet_present_len, packet_len;
1770 * struct cfg80211_gtk_rekey_data - rekey data
1771 * @kek: key encryption key
1772 * @kck: key confirmation key
1773 * @replay_ctr: replay counter
1775 struct cfg80211_gtk_rekey_data {
1776 u8 kek[NL80211_KEK_LEN];
1777 u8 kck[NL80211_KCK_LEN];
1778 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1782 * struct cfg80211_update_ft_ies_params - FT IE Information
1784 * This structure provides information needed to update the fast transition IE
1786 * @md: The Mobility Domain ID, 2 Octet value
1787 * @ie: Fast Transition IEs
1788 * @ie_len: Length of ft_ie in octets
1790 struct cfg80211_update_ft_ies_params {
1797 * struct cfg80211_ops - backend description for wireless configuration
1799 * This struct is registered by fullmac card drivers and/or wireless stacks
1800 * in order to handle configuration requests on their interfaces.
1802 * All callbacks except where otherwise noted should return 0
1803 * on success or a negative error code.
1805 * All operations are currently invoked under rtnl for consistency with the
1806 * wireless extensions but this is subject to reevaluation as soon as this
1807 * code is used more widely and we have a first user without wext.
1809 * @suspend: wiphy device needs to be suspended. The variable @wow will
1810 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1811 * configured for the device.
1812 * @resume: wiphy device needs to be resumed
1813 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1814 * to call device_set_wakeup_enable() to enable/disable wakeup from
1817 * @add_virtual_intf: create a new virtual interface with the given name,
1818 * must set the struct wireless_dev's iftype. Beware: You must create
1819 * the new netdev in the wiphy's network namespace! Returns the struct
1820 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1821 * also set the address member in the wdev.
1823 * @del_virtual_intf: remove the virtual interface
1825 * @change_virtual_intf: change type/configuration of virtual interface,
1826 * keep the struct wireless_dev's iftype updated.
1828 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1829 * when adding a group key.
1831 * @get_key: get information about the key with the given parameters.
1832 * @mac_addr will be %NULL when requesting information for a group
1833 * key. All pointers given to the @callback function need not be valid
1834 * after it returns. This function should return an error if it is
1835 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1837 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1838 * and @key_index, return -ENOENT if the key doesn't exist.
1840 * @set_default_key: set the default key on an interface
1842 * @set_default_mgmt_key: set the default management frame key on an interface
1844 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1846 * @start_ap: Start acting in AP mode defined by the parameters.
1847 * @change_beacon: Change the beacon parameters for an access point mode
1848 * interface. This should reject the call when AP mode wasn't started.
1849 * @stop_ap: Stop being an AP, including stopping beaconing.
1851 * @add_station: Add a new station.
1852 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1853 * @change_station: Modify a given station. Note that flags changes are not much
1854 * validated in cfg80211, in particular the auth/assoc/authorized flags
1855 * might come to the driver in invalid combinations -- make sure to check
1856 * them, also against the existing state! Drivers must call
1857 * cfg80211_check_station_change() to validate the information.
1858 * @get_station: get station information for the station identified by @mac
1859 * @dump_station: dump station callback -- resume dump at index @idx
1861 * @add_mpath: add a fixed mesh path
1862 * @del_mpath: delete a given mesh path
1863 * @change_mpath: change a given mesh path
1864 * @get_mpath: get a mesh path for the given parameters
1865 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1866 * @join_mesh: join the mesh network with the specified parameters
1867 * @leave_mesh: leave the current mesh network
1869 * @get_mesh_config: Get the current mesh configuration
1871 * @update_mesh_config: Update mesh parameters on a running mesh.
1872 * The mask is a bitfield which tells us which parameters to
1873 * set, and which to leave alone.
1875 * @change_bss: Modify parameters for a given BSS.
1877 * @set_txq_params: Set TX queue parameters
1879 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1880 * as it doesn't implement join_mesh and needs to set the channel to
1881 * join the mesh instead.
1883 * @set_monitor_channel: Set the monitor mode channel for the device. If other
1884 * interfaces are active this callback should reject the configuration.
1885 * If no interfaces are active or the device is down, the channel should
1886 * be stored for when a monitor interface becomes active.
1888 * @scan: Request to do a scan. If returning zero, the scan request is given
1889 * the driver, and will be valid until passed to cfg80211_scan_done().
1890 * For scan results, call cfg80211_inform_bss(); you can call this outside
1891 * the scan/scan_done bracket too.
1893 * @auth: Request to authenticate with the specified peer
1894 * @assoc: Request to (re)associate with the specified peer
1895 * @deauth: Request to deauthenticate from the specified peer
1896 * @disassoc: Request to disassociate from the specified peer
1898 * @connect: Connect to the ESS with the specified parameters. When connected,
1899 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1900 * If the connection fails for some reason, call cfg80211_connect_result()
1901 * with the status from the AP.
1902 * @disconnect: Disconnect from the BSS/ESS.
1904 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1905 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1907 * @leave_ibss: Leave the IBSS.
1909 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
1912 * @set_wiphy_params: Notify that wiphy parameters have changed;
1913 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1914 * have changed. The actual parameter values are available in
1915 * struct wiphy. If returning an error, no value should be changed.
1917 * @set_tx_power: set the transmit power according to the parameters,
1918 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
1919 * wdev may be %NULL if power was set for the wiphy, and will
1920 * always be %NULL unless the driver supports per-vif TX power
1921 * (as advertised by the nl80211 feature flag.)
1922 * @get_tx_power: store the current TX power into the dbm variable;
1923 * return 0 if successful
1925 * @set_wds_peer: set the WDS peer for a WDS interface
1927 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1928 * functions to adjust rfkill hw state
1930 * @dump_survey: get site survey information.
1932 * @remain_on_channel: Request the driver to remain awake on the specified
1933 * channel for the specified duration to complete an off-channel
1934 * operation (e.g., public action frame exchange). When the driver is
1935 * ready on the requested channel, it must indicate this with an event
1936 * notification by calling cfg80211_ready_on_channel().
1937 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1938 * This allows the operation to be terminated prior to timeout based on
1939 * the duration value.
1940 * @mgmt_tx: Transmit a management frame.
1941 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1942 * frame on another channel
1944 * @testmode_cmd: run a test mode command
1945 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1946 * used by the function, but 0 and 1 must not be touched. Additionally,
1947 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1948 * dump and return to userspace with an error, so be careful. If any data
1949 * was passed in from userspace then the data/len arguments will be present
1950 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1952 * @set_bitrate_mask: set the bitrate mask configuration
1954 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1955 * devices running firmwares capable of generating the (re) association
1956 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1957 * @del_pmksa: Delete a cached PMKID.
1958 * @flush_pmksa: Flush all cached PMKIDs.
1959 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1960 * allows the driver to adjust the dynamic ps timeout value.
1961 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1962 * @set_cqm_txe_config: Configure connection quality monitor TX error
1964 * @sched_scan_start: Tell the driver to start a scheduled scan.
1965 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
1967 * @mgmt_frame_register: Notify driver that a management frame type was
1968 * registered. Note that this callback may not sleep, and cannot run
1969 * concurrently with itself.
1971 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1972 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1973 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1974 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1976 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1978 * @set_ringparam: Set tx and rx ring sizes.
1980 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1982 * @tdls_mgmt: Transmit a TDLS management frame.
1983 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1985 * @probe_client: probe an associated client, must return a cookie that it
1986 * later passes to cfg80211_probe_status().
1988 * @set_noack_map: Set the NoAck Map for the TIDs.
1990 * @get_et_sset_count: Ethtool API to get string-set count.
1991 * See @ethtool_ops.get_sset_count
1993 * @get_et_stats: Ethtool API to get a set of u64 stats.
1994 * See @ethtool_ops.get_ethtool_stats
1996 * @get_et_strings: Ethtool API to get a set of strings to describe stats
1997 * and perhaps other supported types of ethtool data-sets.
1998 * See @ethtool_ops.get_strings
2000 * @get_channel: Get the current operating channel for the virtual interface.
2001 * For monitor interfaces, it should return %NULL unless there's a single
2002 * current monitoring channel.
2004 * @start_p2p_device: Start the given P2P device.
2005 * @stop_p2p_device: Stop the given P2P device.
2007 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2008 * Parameters include ACL policy, an array of MAC address of stations
2009 * and the number of MAC addresses. If there is already a list in driver
2010 * this new list replaces the existing one. Driver has to clear its ACL
2011 * when number of MAC addresses entries is passed as 0. Drivers which
2012 * advertise the support for MAC based ACL have to implement this callback.
2014 * @start_radar_detection: Start radar detection in the driver.
2016 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2017 * driver. If the SME is in the driver/firmware, this information can be
2018 * used in building Authentication and Reassociation Request frames.
2020 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2021 * for a given duration (milliseconds). The protocol is provided so the
2022 * driver can take the most appropriate actions.
2023 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2024 * reliability. This operation can not fail.
2026 struct cfg80211_ops {
2027 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2028 int (*resume)(struct wiphy *wiphy);
2029 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2031 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2033 enum nl80211_iftype type,
2035 struct vif_params *params);
2036 int (*del_virtual_intf)(struct wiphy *wiphy,
2037 struct wireless_dev *wdev);
2038 int (*change_virtual_intf)(struct wiphy *wiphy,
2039 struct net_device *dev,
2040 enum nl80211_iftype type, u32 *flags,
2041 struct vif_params *params);
2043 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2044 u8 key_index, bool pairwise, const u8 *mac_addr,
2045 struct key_params *params);
2046 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2047 u8 key_index, bool pairwise, const u8 *mac_addr,
2049 void (*callback)(void *cookie, struct key_params*));
2050 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2051 u8 key_index, bool pairwise, const u8 *mac_addr);
2052 int (*set_default_key)(struct wiphy *wiphy,
2053 struct net_device *netdev,
2054 u8 key_index, bool unicast, bool multicast);
2055 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2056 struct net_device *netdev,
2059 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2060 struct cfg80211_ap_settings *settings);
2061 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2062 struct cfg80211_beacon_data *info);
2063 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2066 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2067 u8 *mac, struct station_parameters *params);
2068 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2070 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2071 u8 *mac, struct station_parameters *params);
2072 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2073 u8 *mac, struct station_info *sinfo);
2074 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2075 int idx, u8 *mac, struct station_info *sinfo);
2077 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2078 u8 *dst, u8 *next_hop);
2079 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2081 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2082 u8 *dst, u8 *next_hop);
2083 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2084 u8 *dst, u8 *next_hop,
2085 struct mpath_info *pinfo);
2086 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2087 int idx, u8 *dst, u8 *next_hop,
2088 struct mpath_info *pinfo);
2089 int (*get_mesh_config)(struct wiphy *wiphy,
2090 struct net_device *dev,
2091 struct mesh_config *conf);
2092 int (*update_mesh_config)(struct wiphy *wiphy,
2093 struct net_device *dev, u32 mask,
2094 const struct mesh_config *nconf);
2095 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2096 const struct mesh_config *conf,
2097 const struct mesh_setup *setup);
2098 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2100 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2101 struct bss_parameters *params);
2103 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2104 struct ieee80211_txq_params *params);
2106 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2107 struct net_device *dev,
2108 struct ieee80211_channel *chan);
2110 int (*set_monitor_channel)(struct wiphy *wiphy,
2111 struct cfg80211_chan_def *chandef);
2113 int (*scan)(struct wiphy *wiphy,
2114 struct cfg80211_scan_request *request);
2116 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2117 struct cfg80211_auth_request *req);
2118 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2119 struct cfg80211_assoc_request *req);
2120 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2121 struct cfg80211_deauth_request *req);
2122 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2123 struct cfg80211_disassoc_request *req);
2125 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2126 struct cfg80211_connect_params *sme);
2127 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2130 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2131 struct cfg80211_ibss_params *params);
2132 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2134 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2135 int rate[IEEE80211_NUM_BANDS]);
2137 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2139 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2140 enum nl80211_tx_power_setting type, int mbm);
2141 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2144 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2147 void (*rfkill_poll)(struct wiphy *wiphy);
2149 #ifdef CONFIG_NL80211_TESTMODE
2150 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
2151 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2152 struct netlink_callback *cb,
2153 void *data, int len);
2156 int (*set_bitrate_mask)(struct wiphy *wiphy,
2157 struct net_device *dev,
2159 const struct cfg80211_bitrate_mask *mask);
2161 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2162 int idx, struct survey_info *info);
2164 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2165 struct cfg80211_pmksa *pmksa);
2166 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2167 struct cfg80211_pmksa *pmksa);
2168 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2170 int (*remain_on_channel)(struct wiphy *wiphy,
2171 struct wireless_dev *wdev,
2172 struct ieee80211_channel *chan,
2173 unsigned int duration,
2175 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2176 struct wireless_dev *wdev,
2179 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2180 struct ieee80211_channel *chan, bool offchan,
2181 unsigned int wait, const u8 *buf, size_t len,
2182 bool no_cck, bool dont_wait_for_ack, u64 *cookie);
2183 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2184 struct wireless_dev *wdev,
2187 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2188 bool enabled, int timeout);
2190 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2191 struct net_device *dev,
2192 s32 rssi_thold, u32 rssi_hyst);
2194 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2195 struct net_device *dev,
2196 u32 rate, u32 pkts, u32 intvl);
2198 void (*mgmt_frame_register)(struct wiphy *wiphy,
2199 struct wireless_dev *wdev,
2200 u16 frame_type, bool reg);
2202 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2203 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2205 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
2206 void (*get_ringparam)(struct wiphy *wiphy,
2207 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2209 int (*sched_scan_start)(struct wiphy *wiphy,
2210 struct net_device *dev,
2211 struct cfg80211_sched_scan_request *request);
2212 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2214 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2215 struct cfg80211_gtk_rekey_data *data);
2217 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2218 u8 *peer, u8 action_code, u8 dialog_token,
2219 u16 status_code, const u8 *buf, size_t len);
2220 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2221 u8 *peer, enum nl80211_tdls_operation oper);
2223 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2224 const u8 *peer, u64 *cookie);
2226 int (*set_noack_map)(struct wiphy *wiphy,
2227 struct net_device *dev,
2230 int (*get_et_sset_count)(struct wiphy *wiphy,
2231 struct net_device *dev, int sset);
2232 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
2233 struct ethtool_stats *stats, u64 *data);
2234 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
2235 u32 sset, u8 *data);
2237 int (*get_channel)(struct wiphy *wiphy,
2238 struct wireless_dev *wdev,
2239 struct cfg80211_chan_def *chandef);
2241 int (*start_p2p_device)(struct wiphy *wiphy,
2242 struct wireless_dev *wdev);
2243 void (*stop_p2p_device)(struct wiphy *wiphy,
2244 struct wireless_dev *wdev);
2246 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2247 const struct cfg80211_acl_data *params);
2249 int (*start_radar_detection)(struct wiphy *wiphy,
2250 struct net_device *dev,
2251 struct cfg80211_chan_def *chandef);
2252 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2253 struct cfg80211_update_ft_ies_params *ftie);
2254 int (*crit_proto_start)(struct wiphy *wiphy,
2255 struct wireless_dev *wdev,
2256 enum nl80211_crit_proto_id protocol,
2258 void (*crit_proto_stop)(struct wiphy *wiphy,
2259 struct wireless_dev *wdev);
2263 * wireless hardware and networking interfaces structures
2264 * and registration/helper functions
2268 * enum wiphy_flags - wiphy capability flags
2270 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
2271 * has its own custom regulatory domain and cannot identify the
2272 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
2273 * we will disregard the first regulatory hint (when the
2274 * initiator is %REGDOM_SET_BY_CORE).
2275 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
2276 * ignore regulatory domain settings until it gets its own regulatory
2277 * domain via its regulatory_hint() unless the regulatory hint is
2278 * from a country IE. After its gets its own regulatory domain it will
2279 * only allow further regulatory domain settings to further enhance
2280 * compliance. For example if channel 13 and 14 are disabled by this
2281 * regulatory domain no user regulatory domain can enable these channels
2282 * at a later time. This can be used for devices which do not have
2283 * calibration information guaranteed for frequencies or settings
2284 * outside of its regulatory domain. If used in combination with
2285 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
2287 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
2288 * that passive scan flags and beaconing flags may not be lifted by
2289 * cfg80211 due to regulatory beacon hints. For more information on beacon
2290 * hints read the documenation for regulatory_hint_found_beacon()
2291 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2293 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2294 * by default -- this flag will be set depending on the kernel's default
2295 * on wiphy_new(), but can be changed by the driver if it has a good
2296 * reason to override the default
2297 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2298 * on a VLAN interface)
2299 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2300 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2301 * control port protocol ethertype. The device also honours the
2302 * control_port_no_encrypt flag.
2303 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2304 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2305 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2306 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2307 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2309 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2310 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2311 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2312 * link setup/discovery operations internally. Setup, discovery and
2313 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2314 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2315 * used for asking the driver/firmware to perform a TDLS operation.
2316 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2317 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2318 * when there are virtual interfaces in AP mode by calling
2319 * cfg80211_report_obss_beacon().
2320 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2321 * responds to probe-requests in hardware.
2322 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2323 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2326 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
2327 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
2328 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
2329 WIPHY_FLAG_NETNS_OK = BIT(3),
2330 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2331 WIPHY_FLAG_4ADDR_AP = BIT(5),
2332 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2333 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2334 WIPHY_FLAG_IBSS_RSN = BIT(8),
2335 WIPHY_FLAG_MESH_AUTH = BIT(10),
2336 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2337 /* use hole at 12 */
2338 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2339 WIPHY_FLAG_AP_UAPSD = BIT(14),
2340 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2341 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2342 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2343 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2344 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2345 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2346 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2350 * struct ieee80211_iface_limit - limit on certain interface types
2351 * @max: maximum number of interfaces of these types
2352 * @types: interface types (bits)
2354 struct ieee80211_iface_limit {
2360 * struct ieee80211_iface_combination - possible interface combination
2361 * @limits: limits for the given interface types
2362 * @n_limits: number of limitations
2363 * @num_different_channels: can use up to this many different channels
2364 * @max_interfaces: maximum number of interfaces in total allowed in this
2366 * @beacon_int_infra_match: In this combination, the beacon intervals
2367 * between infrastructure and AP types must match. This is required
2368 * only in special cases.
2369 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2371 * These examples can be expressed as follows:
2373 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2375 * struct ieee80211_iface_limit limits1[] = {
2376 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2377 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2379 * struct ieee80211_iface_combination combination1 = {
2380 * .limits = limits1,
2381 * .n_limits = ARRAY_SIZE(limits1),
2382 * .max_interfaces = 2,
2383 * .beacon_int_infra_match = true,
2387 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2389 * struct ieee80211_iface_limit limits2[] = {
2390 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2391 * BIT(NL80211_IFTYPE_P2P_GO), },
2393 * struct ieee80211_iface_combination combination2 = {
2394 * .limits = limits2,
2395 * .n_limits = ARRAY_SIZE(limits2),
2396 * .max_interfaces = 8,
2397 * .num_different_channels = 1,
2401 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2402 * This allows for an infrastructure connection and three P2P connections.
2404 * struct ieee80211_iface_limit limits3[] = {
2405 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2406 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2407 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2409 * struct ieee80211_iface_combination combination3 = {
2410 * .limits = limits3,
2411 * .n_limits = ARRAY_SIZE(limits3),
2412 * .max_interfaces = 4,
2413 * .num_different_channels = 2,
2416 struct ieee80211_iface_combination {
2417 const struct ieee80211_iface_limit *limits;
2418 u32 num_different_channels;
2421 bool beacon_int_infra_match;
2422 u8 radar_detect_widths;
2425 struct ieee80211_txrx_stypes {
2430 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2431 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2432 * trigger that keeps the device operating as-is and
2433 * wakes up the host on any activity, for example a
2434 * received packet that passed filtering; note that the
2435 * packet should be preserved in that case
2436 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2438 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2439 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2440 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2441 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2442 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2443 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2445 enum wiphy_wowlan_support_flags {
2446 WIPHY_WOWLAN_ANY = BIT(0),
2447 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2448 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2449 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2450 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2451 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2452 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2453 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2456 struct wiphy_wowlan_tcp_support {
2457 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2458 u32 data_payload_max;
2459 u32 data_interval_max;
2460 u32 wake_payload_max;
2465 * struct wiphy_wowlan_support - WoWLAN support data
2466 * @flags: see &enum wiphy_wowlan_support_flags
2467 * @n_patterns: number of supported wakeup patterns
2468 * (see nl80211.h for the pattern definition)
2469 * @pattern_max_len: maximum length of each pattern
2470 * @pattern_min_len: minimum length of each pattern
2471 * @max_pkt_offset: maximum Rx packet offset
2472 * @tcp: TCP wakeup support information
2474 struct wiphy_wowlan_support {
2477 int pattern_max_len;
2478 int pattern_min_len;
2480 const struct wiphy_wowlan_tcp_support *tcp;
2484 * struct wiphy - wireless hardware description
2485 * @reg_notifier: the driver's regulatory notification callback,
2486 * note that if your driver uses wiphy_apply_custom_regulatory()
2487 * the reg_notifier's request can be passed as NULL
2488 * @regd: the driver's regulatory domain, if one was requested via
2489 * the regulatory_hint() API. This can be used by the driver
2490 * on the reg_notifier() if it chooses to ignore future
2491 * regulatory domain changes caused by other drivers.
2492 * @signal_type: signal type reported in &struct cfg80211_bss.
2493 * @cipher_suites: supported cipher suites
2494 * @n_cipher_suites: number of supported cipher suites
2495 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2496 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2497 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2498 * -1 = fragmentation disabled, only odd values >= 256 used
2499 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2500 * @_net: the network namespace this wiphy currently lives in
2501 * @perm_addr: permanent MAC address of this device
2502 * @addr_mask: If the device supports multiple MAC addresses by masking,
2503 * set this to a mask with variable bits set to 1, e.g. if the last
2504 * four bits are variable then set it to 00:...:00:0f. The actual
2505 * variable bits shall be determined by the interfaces added, with
2506 * interfaces not matching the mask being rejected to be brought up.
2507 * @n_addresses: number of addresses in @addresses.
2508 * @addresses: If the device has more than one address, set this pointer
2509 * to a list of addresses (6 bytes each). The first one will be used
2510 * by default for perm_addr. In this case, the mask should be set to
2511 * all-zeroes. In this case it is assumed that the device can handle
2512 * the same number of arbitrary MAC addresses.
2513 * @registered: protects ->resume and ->suspend sysfs callbacks against
2514 * unregister hardware
2515 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2516 * automatically on wiphy renames
2517 * @dev: (virtual) struct device for this wiphy
2518 * @registered: helps synchronize suspend/resume with wiphy unregister
2519 * @wext: wireless extension handlers
2520 * @priv: driver private data (sized according to wiphy_new() parameter)
2521 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2522 * must be set by driver
2523 * @iface_combinations: Valid interface combinations array, should not
2524 * list single interface types.
2525 * @n_iface_combinations: number of entries in @iface_combinations array.
2526 * @software_iftypes: bitmask of software interface types, these are not
2527 * subject to any restrictions since they are purely managed in SW.
2528 * @flags: wiphy flags, see &enum wiphy_flags
2529 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2530 * @bss_priv_size: each BSS struct has private data allocated with it,
2531 * this variable determines its size
2532 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2534 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2535 * for in any given scheduled scan
2536 * @max_match_sets: maximum number of match sets the device can handle
2537 * when performing a scheduled scan, 0 if filtering is not
2539 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2540 * add to probe request frames transmitted during a scan, must not
2541 * include fixed IEs like supported rates
2542 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2544 * @coverage_class: current coverage class
2545 * @fw_version: firmware version for ethtool reporting
2546 * @hw_version: hardware version for ethtool reporting
2547 * @max_num_pmkids: maximum number of PMKIDs supported by device
2548 * @privid: a pointer that drivers can use to identify if an arbitrary
2549 * wiphy is theirs, e.g. in global notifiers
2550 * @bands: information about bands/channels supported by this device
2552 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2553 * transmitted through nl80211, points to an array indexed by interface
2556 * @available_antennas_tx: bitmap of antennas which are available to be
2557 * configured as TX antennas. Antenna configuration commands will be
2558 * rejected unless this or @available_antennas_rx is set.
2560 * @available_antennas_rx: bitmap of antennas which are available to be
2561 * configured as RX antennas. Antenna configuration commands will be
2562 * rejected unless this or @available_antennas_tx is set.
2564 * @probe_resp_offload:
2565 * Bitmap of supported protocols for probe response offloading.
2566 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2567 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2569 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2570 * may request, if implemented.
2572 * @wowlan: WoWLAN support information
2574 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2575 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2576 * If null, then none can be over-ridden.
2577 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
2578 * If null, then none can be over-ridden.
2580 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
2583 * @extended_capabilities: extended capabilities supported by the driver,
2584 * additional capabilities might be supported by userspace; these are
2585 * the 802.11 extended capabilities ("Extended Capabilities element")
2586 * and are in the same format as in the information element. See
2587 * 802.11-2012 8.4.2.29 for the defined fields.
2588 * @extended_capabilities_mask: mask of the valid values
2589 * @extended_capabilities_len: length of the extended capabilities
2592 /* assign these fields before you register the wiphy */
2594 /* permanent MAC address(es) */
2595 u8 perm_addr[ETH_ALEN];
2596 u8 addr_mask[ETH_ALEN];
2598 struct mac_address *addresses;
2600 const struct ieee80211_txrx_stypes *mgmt_stypes;
2602 const struct ieee80211_iface_combination *iface_combinations;
2603 int n_iface_combinations;
2604 u16 software_iftypes;
2608 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2609 u16 interface_modes;
2611 u16 max_acl_mac_addrs;
2613 u32 flags, features;
2617 enum cfg80211_signal_type signal_type;
2621 u8 max_sched_scan_ssids;
2623 u16 max_scan_ie_len;
2624 u16 max_sched_scan_ie_len;
2626 int n_cipher_suites;
2627 const u32 *cipher_suites;
2635 char fw_version[ETHTOOL_FWVERS_LEN];
2639 struct wiphy_wowlan_support wowlan;
2642 u16 max_remain_on_channel_duration;
2646 u32 available_antennas_tx;
2647 u32 available_antennas_rx;
2650 * Bitmap of supported protocols for probe response offloading
2651 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2652 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2654 u32 probe_resp_offload;
2656 const u8 *extended_capabilities, *extended_capabilities_mask;
2657 u8 extended_capabilities_len;
2659 /* If multiple wiphys are registered and you're handed e.g.
2660 * a regular netdev with assigned ieee80211_ptr, you won't
2661 * know whether it points to a wiphy your driver has registered
2662 * or not. Assign this to something global to your driver to
2663 * help determine whether you own this wiphy or not. */
2666 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2668 /* Lets us get back the wiphy on the callback */
2669 void (*reg_notifier)(struct wiphy *wiphy,
2670 struct regulatory_request *request);
2672 /* fields below are read-only, assigned by cfg80211 */
2674 const struct ieee80211_regdomain __rcu *regd;
2676 /* the item in /sys/class/ieee80211/ points to this,
2677 * you need use set_wiphy_dev() (see below) */
2680 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2683 /* dir in debugfs: ieee80211/<wiphyname> */
2684 struct dentry *debugfsdir;
2686 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2687 const struct ieee80211_vht_cap *vht_capa_mod_mask;
2689 #ifdef CONFIG_NET_NS
2690 /* the network namespace this phy lives in currently */
2694 #ifdef CONFIG_CFG80211_WEXT
2695 const struct iw_handler_def *wext;
2698 char priv[0] __aligned(NETDEV_ALIGN);
2701 static inline struct net *wiphy_net(struct wiphy *wiphy)
2703 return read_pnet(&wiphy->_net);
2706 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2708 write_pnet(&wiphy->_net, net);
2712 * wiphy_priv - return priv from wiphy
2714 * @wiphy: the wiphy whose priv pointer to return
2715 * Return: The priv of @wiphy.
2717 static inline void *wiphy_priv(struct wiphy *wiphy)
2720 return &wiphy->priv;
2724 * priv_to_wiphy - return the wiphy containing the priv
2726 * @priv: a pointer previously returned by wiphy_priv
2727 * Return: The wiphy of @priv.
2729 static inline struct wiphy *priv_to_wiphy(void *priv)
2732 return container_of(priv, struct wiphy, priv);
2736 * set_wiphy_dev - set device pointer for wiphy
2738 * @wiphy: The wiphy whose device to bind
2739 * @dev: The device to parent it to
2741 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2743 wiphy->dev.parent = dev;
2747 * wiphy_dev - get wiphy dev pointer
2749 * @wiphy: The wiphy whose device struct to look up
2750 * Return: The dev of @wiphy.
2752 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2754 return wiphy->dev.parent;
2758 * wiphy_name - get wiphy name
2760 * @wiphy: The wiphy whose name to return
2761 * Return: The name of @wiphy.
2763 static inline const char *wiphy_name(const struct wiphy *wiphy)
2765 return dev_name(&wiphy->dev);
2769 * wiphy_new - create a new wiphy for use with cfg80211
2771 * @ops: The configuration operations for this device
2772 * @sizeof_priv: The size of the private area to allocate
2774 * Create a new wiphy and associate the given operations with it.
2775 * @sizeof_priv bytes are allocated for private use.
2777 * Return: A pointer to the new wiphy. This pointer must be
2778 * assigned to each netdev's ieee80211_ptr for proper operation.
2780 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2783 * wiphy_register - register a wiphy with cfg80211
2785 * @wiphy: The wiphy to register.
2787 * Return: A non-negative wiphy index or a negative error code.
2789 extern int wiphy_register(struct wiphy *wiphy);
2792 * wiphy_unregister - deregister a wiphy from cfg80211
2794 * @wiphy: The wiphy to unregister.
2796 * After this call, no more requests can be made with this priv
2797 * pointer, but the call may sleep to wait for an outstanding
2798 * request that is being handled.
2800 extern void wiphy_unregister(struct wiphy *wiphy);
2803 * wiphy_free - free wiphy
2805 * @wiphy: The wiphy to free
2807 extern void wiphy_free(struct wiphy *wiphy);
2809 /* internal structs */
2810 struct cfg80211_conn;
2811 struct cfg80211_internal_bss;
2812 struct cfg80211_cached_keys;
2815 * struct wireless_dev - wireless device state
2817 * For netdevs, this structure must be allocated by the driver
2818 * that uses the ieee80211_ptr field in struct net_device (this
2819 * is intentional so it can be allocated along with the netdev.)
2820 * It need not be registered then as netdev registration will
2821 * be intercepted by cfg80211 to see the new wireless device.
2823 * For non-netdev uses, it must also be allocated by the driver
2824 * in response to the cfg80211 callbacks that require it, as
2825 * there's no netdev registration in that case it may not be
2826 * allocated outside of callback operations that return it.
2828 * @wiphy: pointer to hardware description
2829 * @iftype: interface type
2830 * @list: (private) Used to collect the interfaces
2831 * @netdev: (private) Used to reference back to the netdev, may be %NULL
2832 * @identifier: (private) Identifier used in nl80211 to identify this
2833 * wireless device if it has no netdev
2834 * @current_bss: (private) Used by the internal configuration code
2835 * @channel: (private) Used by the internal configuration code to track
2836 * the user-set AP, monitor and WDS channel
2837 * @preset_chan: (private) Used by the internal configuration code to
2838 * track the channel to be used for AP later
2839 * @bssid: (private) Used by the internal configuration code
2840 * @ssid: (private) Used by the internal configuration code
2841 * @ssid_len: (private) Used by the internal configuration code
2842 * @mesh_id_len: (private) Used by the internal configuration code
2843 * @mesh_id_up_len: (private) Used by the internal configuration code
2844 * @wext: (private) Used by the internal wireless extensions compat code
2845 * @use_4addr: indicates 4addr mode is used on this interface, must be
2846 * set by driver (if supported) on add_interface BEFORE registering the
2847 * netdev and may otherwise be used by driver read-only, will be update
2848 * by cfg80211 on change_interface
2849 * @mgmt_registrations: list of registrations for management frames
2850 * @mgmt_registrations_lock: lock for the list
2851 * @mtx: mutex used to lock data in this struct
2852 * @cleanup_work: work struct used for cleanup that can't be done directly
2853 * @beacon_interval: beacon interval used on this device for transmitting
2854 * beacons, 0 when not valid
2855 * @address: The address for this device, valid only if @netdev is %NULL
2856 * @p2p_started: true if this is a P2P Device that has been started
2857 * @cac_started: true if DFS channel availability check has been started
2858 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
2860 struct wireless_dev {
2861 struct wiphy *wiphy;
2862 enum nl80211_iftype iftype;
2864 /* the remainder of this struct should be private to cfg80211 */
2865 struct list_head list;
2866 struct net_device *netdev;
2870 struct list_head mgmt_registrations;
2871 spinlock_t mgmt_registrations_lock;
2875 struct work_struct cleanup_work;
2877 bool use_4addr, p2p_started;
2879 u8 address[ETH_ALEN] __aligned(sizeof(u16));
2881 /* currently used for IBSS and SME - might be rearranged later */
2882 u8 ssid[IEEE80211_MAX_SSID_LEN];
2883 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2886 CFG80211_SME_CONNECTING,
2887 CFG80211_SME_CONNECTED,
2889 struct cfg80211_conn *conn;
2890 struct cfg80211_cached_keys *connect_keys;
2892 struct list_head event_list;
2893 spinlock_t event_lock;
2895 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2896 struct cfg80211_chan_def preset_chandef;
2898 /* for AP and mesh channel tracking */
2899 struct ieee80211_channel *channel;
2906 int beacon_interval;
2908 u32 ap_unexpected_nlportid;
2911 unsigned long cac_start_time;
2913 #ifdef CONFIG_CFG80211_WEXT
2916 struct cfg80211_ibss_params ibss;
2917 struct cfg80211_connect_params connect;
2918 struct cfg80211_cached_keys *keys;
2921 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2922 u8 ssid[IEEE80211_MAX_SSID_LEN];
2923 s8 default_key, default_mgmt_key;
2924 bool prev_bssid_valid;
2929 static inline u8 *wdev_address(struct wireless_dev *wdev)
2932 return wdev->netdev->dev_addr;
2933 return wdev->address;
2937 * wdev_priv - return wiphy priv from wireless_dev
2939 * @wdev: The wireless device whose wiphy's priv pointer to return
2940 * Return: The wiphy priv of @wdev.
2942 static inline void *wdev_priv(struct wireless_dev *wdev)
2945 return wiphy_priv(wdev->wiphy);
2949 * DOC: Utility functions
2951 * cfg80211 offers a number of utility functions that can be useful.
2955 * ieee80211_channel_to_frequency - convert channel number to frequency
2956 * @chan: channel number
2957 * @band: band, necessary due to channel number overlap
2958 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
2960 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2963 * ieee80211_frequency_to_channel - convert frequency to channel number
2964 * @freq: center frequency
2965 * Return: The corresponding channel, or 0 if the conversion failed.
2967 extern int ieee80211_frequency_to_channel(int freq);
2970 * Name indirection necessary because the ieee80211 code also has
2971 * a function named "ieee80211_get_channel", so if you include
2972 * cfg80211's header file you get cfg80211's version, if you try
2973 * to include both header files you'll (rightfully!) get a symbol
2976 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2979 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2980 * @wiphy: the struct wiphy to get the channel for
2981 * @freq: the center frequency of the channel
2982 * Return: The channel struct from @wiphy at @freq.
2984 static inline struct ieee80211_channel *
2985 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2987 return __ieee80211_get_channel(wiphy, freq);
2991 * ieee80211_get_response_rate - get basic rate for a given rate
2993 * @sband: the band to look for rates in
2994 * @basic_rates: bitmap of basic rates
2995 * @bitrate: the bitrate for which to find the basic rate
2997 * Return: The basic rate corresponding to a given bitrate, that
2998 * is the next lower bitrate contained in the basic rate map,
2999 * which is, for this function, given as a bitmap of indices of
3000 * rates in the band's bitrate table.
3002 struct ieee80211_rate *
3003 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3004 u32 basic_rates, int bitrate);
3007 * Radiotap parsing functions -- for controlled injection support
3009 * Implemented in net/wireless/radiotap.c
3010 * Documentation in Documentation/networking/radiotap-headers.txt
3013 struct radiotap_align_size {
3014 uint8_t align:4, size:4;
3017 struct ieee80211_radiotap_namespace {
3018 const struct radiotap_align_size *align_size;
3024 struct ieee80211_radiotap_vendor_namespaces {
3025 const struct ieee80211_radiotap_namespace *ns;
3030 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3031 * @this_arg_index: index of current arg, valid after each successful call
3032 * to ieee80211_radiotap_iterator_next()
3033 * @this_arg: pointer to current radiotap arg; it is valid after each
3034 * call to ieee80211_radiotap_iterator_next() but also after
3035 * ieee80211_radiotap_iterator_init() where it will point to
3036 * the beginning of the actual data portion
3037 * @this_arg_size: length of the current arg, for convenience
3038 * @current_namespace: pointer to the current namespace definition
3039 * (or internally %NULL if the current namespace is unknown)
3040 * @is_radiotap_ns: indicates whether the current namespace is the default
3041 * radiotap namespace or not
3043 * @_rtheader: pointer to the radiotap header we are walking through
3044 * @_max_length: length of radiotap header in cpu byte ordering
3045 * @_arg_index: next argument index
3046 * @_arg: next argument pointer
3047 * @_next_bitmap: internal pointer to next present u32
3048 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3049 * @_vns: vendor namespace definitions
3050 * @_next_ns_data: beginning of the next namespace's data
3051 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3054 * Describes the radiotap parser state. Fields prefixed with an underscore
3055 * must not be used by users of the parser, only by the parser internally.
3058 struct ieee80211_radiotap_iterator {
3059 struct ieee80211_radiotap_header *_rtheader;
3060 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3061 const struct ieee80211_radiotap_namespace *current_namespace;
3063 unsigned char *_arg, *_next_ns_data;
3064 __le32 *_next_bitmap;
3066 unsigned char *this_arg;
3074 uint32_t _bitmap_shifter;
3078 extern int ieee80211_radiotap_iterator_init(
3079 struct ieee80211_radiotap_iterator *iterator,
3080 struct ieee80211_radiotap_header *radiotap_header,
3081 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
3083 extern int ieee80211_radiotap_iterator_next(
3084 struct ieee80211_radiotap_iterator *iterator);
3087 extern const unsigned char rfc1042_header[6];
3088 extern const unsigned char bridge_tunnel_header[6];
3091 * ieee80211_get_hdrlen_from_skb - get header length from data
3095 * Given an skb with a raw 802.11 header at the data pointer this function
3096 * returns the 802.11 header length.
3098 * Return: The 802.11 header length in bytes (not including encryption
3099 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3102 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3105 * ieee80211_hdrlen - get header length in bytes from frame control
3106 * @fc: frame control field in little-endian format
3107 * Return: The header length in bytes.
3109 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3112 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3113 * @meshhdr: the mesh extension header, only the flags field
3114 * (first byte) will be accessed
3115 * Return: The length of the extension header, which is always at
3116 * least 6 bytes and at most 18 if address 5 and 6 are present.
3118 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3121 * DOC: Data path helpers
3123 * In addition to generic utilities, cfg80211 also offers
3124 * functions that help implement the data path for devices
3125 * that do not do the 802.11/802.3 conversion on the device.
3129 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3130 * @skb: the 802.11 data frame
3131 * @addr: the device MAC address
3132 * @iftype: the virtual interface type
3133 * Return: 0 on success. Non-zero on error.
3135 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3136 enum nl80211_iftype iftype);
3139 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3140 * @skb: the 802.3 frame
3141 * @addr: the device MAC address
3142 * @iftype: the virtual interface type
3143 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3144 * @qos: build 802.11 QoS data frame
3145 * Return: 0 on success, or a negative error code.
3147 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3148 enum nl80211_iftype iftype, u8 *bssid, bool qos);
3151 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3153 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3154 * 802.3 frames. The @list will be empty if the decode fails. The
3155 * @skb is consumed after the function returns.
3157 * @skb: The input IEEE 802.11n A-MSDU frame.
3158 * @list: The output list of 802.3 frames. It must be allocated and
3159 * initialized by by the caller.
3160 * @addr: The device MAC address.
3161 * @iftype: The device interface type.
3162 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3163 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3165 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3166 const u8 *addr, enum nl80211_iftype iftype,
3167 const unsigned int extra_headroom,
3168 bool has_80211_header);
3171 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3172 * @skb: the data frame
3173 * Return: The 802.1p/1d tag.
3175 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
3178 * cfg80211_find_ie - find information element in data
3181 * @ies: data consisting of IEs
3182 * @len: length of data
3184 * Return: %NULL if the element ID could not be found or if
3185 * the element is invalid (claims to be longer than the given
3186 * data), or a pointer to the first byte of the requested
3187 * element, that is the byte containing the element ID.
3189 * Note: There are no checks on the element length other than
3190 * having to fit into the given data.
3192 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3195 * cfg80211_find_vendor_ie - find vendor specific information element in data
3198 * @oui_type: vendor-specific OUI type
3199 * @ies: data consisting of IEs
3200 * @len: length of data
3202 * Return: %NULL if the vendor specific element ID could not be found or if the
3203 * element is invalid (claims to be longer than the given data), or a pointer to
3204 * the first byte of the requested element, that is the byte containing the
3207 * Note: There are no checks on the element length other than having to fit into
3210 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3211 const u8 *ies, int len);
3214 * DOC: Regulatory enforcement infrastructure
3220 * regulatory_hint - driver hint to the wireless core a regulatory domain
3221 * @wiphy: the wireless device giving the hint (used only for reporting
3223 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3224 * should be in. If @rd is set this should be NULL. Note that if you
3225 * set this to NULL you should still set rd->alpha2 to some accepted
3228 * Wireless drivers can use this function to hint to the wireless core
3229 * what it believes should be the current regulatory domain by
3230 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3231 * domain should be in or by providing a completely build regulatory domain.
3232 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3233 * for a regulatory domain structure for the respective country.
3235 * The wiphy must have been registered to cfg80211 prior to this call.
3236 * For cfg80211 drivers this means you must first use wiphy_register(),
3237 * for mac80211 drivers you must first use ieee80211_register_hw().
3239 * Drivers should check the return value, its possible you can get
3242 * Return: 0 on success. -ENOMEM.
3244 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3247 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3248 * @wiphy: the wireless device we want to process the regulatory domain on
3249 * @regd: the custom regulatory domain to use for this wiphy
3251 * Drivers can sometimes have custom regulatory domains which do not apply
3252 * to a specific country. Drivers can use this to apply such custom regulatory
3253 * domains. This routine must be called prior to wiphy registration. The
3254 * custom regulatory domain will be trusted completely and as such previous
3255 * default channel settings will be disregarded. If no rule is found for a
3256 * channel on the regulatory domain the channel will be disabled.
3258 extern void wiphy_apply_custom_regulatory(
3259 struct wiphy *wiphy,
3260 const struct ieee80211_regdomain *regd);
3263 * freq_reg_info - get regulatory information for the given frequency
3264 * @wiphy: the wiphy for which we want to process this rule for
3265 * @center_freq: Frequency in KHz for which we want regulatory information for
3267 * Use this function to get the regulatory rule for a specific frequency on
3268 * a given wireless device. If the device has a specific regulatory domain
3269 * it wants to follow we respect that unless a country IE has been received
3270 * and processed already.
3272 * Return: A valid pointer, or, when an error occurs, for example if no rule
3273 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3274 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3275 * value will be -ERANGE if we determine the given center_freq does not even
3276 * have a regulatory rule for a frequency range in the center_freq's band.
3277 * See freq_in_rule_band() for our current definition of a band -- this is
3278 * purely subjective and right now it's 802.11 specific.
3280 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3284 * callbacks for asynchronous cfg80211 methods, notification
3285 * functions and BSS handling helpers
3289 * cfg80211_scan_done - notify that scan finished
3291 * @request: the corresponding scan request
3292 * @aborted: set to true if the scan was aborted for any reason,
3293 * userspace will be notified of that
3295 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3298 * cfg80211_sched_scan_results - notify that new scan results are available
3300 * @wiphy: the wiphy which got scheduled scan results
3302 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3305 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3307 * @wiphy: the wiphy on which the scheduled scan stopped
3309 * The driver can call this function to inform cfg80211 that the
3310 * scheduled scan had to be stopped, for whatever reason. The driver
3311 * is then called back via the sched_scan_stop operation when done.
3313 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3316 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
3318 * @wiphy: the wiphy reporting the BSS
3319 * @channel: The channel the frame was received on
3320 * @mgmt: the management frame (probe response or beacon)
3321 * @len: length of the management frame
3322 * @signal: the signal strength, type depends on the wiphy's signal_type
3323 * @gfp: context flags
3325 * This informs cfg80211 that BSS information was found and
3326 * the BSS should be updated/added.
3328 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3329 * Or %NULL on error.
3331 struct cfg80211_bss * __must_check
3332 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3333 struct ieee80211_channel *channel,
3334 struct ieee80211_mgmt *mgmt, size_t len,
3335 s32 signal, gfp_t gfp);
3338 * cfg80211_inform_bss - inform cfg80211 of a new BSS
3340 * @wiphy: the wiphy reporting the BSS
3341 * @channel: The channel the frame was received on
3342 * @bssid: the BSSID of the BSS
3343 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3344 * @capability: the capability field sent by the peer
3345 * @beacon_interval: the beacon interval announced by the peer
3346 * @ie: additional IEs sent by the peer
3347 * @ielen: length of the additional IEs
3348 * @signal: the signal strength, type depends on the wiphy's signal_type
3349 * @gfp: context flags
3351 * This informs cfg80211 that BSS information was found and
3352 * the BSS should be updated/added.
3354 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3355 * Or %NULL on error.
3357 struct cfg80211_bss * __must_check
3358 cfg80211_inform_bss(struct wiphy *wiphy,
3359 struct ieee80211_channel *channel,
3360 const u8 *bssid, u64 tsf, u16 capability,
3361 u16 beacon_interval, const u8 *ie, size_t ielen,
3362 s32 signal, gfp_t gfp);
3364 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3365 struct ieee80211_channel *channel,
3367 const u8 *ssid, size_t ssid_len,
3368 u16 capa_mask, u16 capa_val);
3369 static inline struct cfg80211_bss *
3370 cfg80211_get_ibss(struct wiphy *wiphy,
3371 struct ieee80211_channel *channel,
3372 const u8 *ssid, size_t ssid_len)
3374 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3375 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3379 * cfg80211_ref_bss - reference BSS struct
3380 * @wiphy: the wiphy this BSS struct belongs to
3381 * @bss: the BSS struct to reference
3383 * Increments the refcount of the given BSS struct.
3385 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3388 * cfg80211_put_bss - unref BSS struct
3389 * @wiphy: the wiphy this BSS struct belongs to
3390 * @bss: the BSS struct
3392 * Decrements the refcount of the given BSS struct.
3394 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3397 * cfg80211_unlink_bss - unlink BSS from internal data structures
3399 * @bss: the bss to remove
3401 * This function removes the given BSS from the internal data structures
3402 * thereby making it no longer show up in scan results etc. Use this
3403 * function when you detect a BSS is gone. Normally BSSes will also time
3404 * out, so it is not necessary to use this function at all.
3406 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3409 * cfg80211_send_rx_auth - notification of processed authentication
3410 * @dev: network device
3411 * @buf: authentication frame (header + body)
3412 * @len: length of the frame data
3414 * This function is called whenever an authentication has been processed in
3415 * station mode. The driver is required to call either this function or
3416 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
3417 * call. This function may sleep.
3419 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
3422 * cfg80211_send_auth_timeout - notification of timed out authentication
3423 * @dev: network device
3424 * @addr: The MAC address of the device with which the authentication timed out
3426 * This function may sleep.
3428 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
3431 * cfg80211_send_rx_assoc - notification of processed association
3432 * @dev: network device
3433 * @bss: the BSS struct association was requested for, the struct reference
3434 * is owned by cfg80211 after this call
3435 * @buf: (re)association response frame (header + body)
3436 * @len: length of the frame data
3438 * This function is called whenever a (re)association response has been
3439 * processed in station mode. The driver is required to call either this
3440 * function or cfg80211_send_assoc_timeout() to indicate the result of
3441 * cfg80211_ops::assoc() call. This function may sleep.
3443 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
3444 const u8 *buf, size_t len);
3447 * cfg80211_send_assoc_timeout - notification of timed out association
3448 * @dev: network device
3449 * @addr: The MAC address of the device with which the association timed out
3451 * This function may sleep.
3453 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
3456 * cfg80211_send_deauth - notification of processed deauthentication
3457 * @dev: network device
3458 * @buf: deauthentication frame (header + body)
3459 * @len: length of the frame data
3461 * This function is called whenever deauthentication has been processed in
3462 * station mode. This includes both received deauthentication frames and
3463 * locally generated ones. This function may sleep.
3465 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3468 * __cfg80211_send_deauth - notification of processed deauthentication
3469 * @dev: network device
3470 * @buf: deauthentication frame (header + body)
3471 * @len: length of the frame data
3473 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
3475 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3478 * cfg80211_send_disassoc - notification of processed disassociation
3479 * @dev: network device
3480 * @buf: disassociation response frame (header + body)
3481 * @len: length of the frame data
3483 * This function is called whenever disassociation has been processed in
3484 * station mode. This includes both received disassociation frames and locally
3485 * generated ones. This function may sleep.
3487 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
3490 * __cfg80211_send_disassoc - notification of processed disassociation
3491 * @dev: network device
3492 * @buf: disassociation response frame (header + body)
3493 * @len: length of the frame data
3495 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
3497 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
3501 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
3502 * @dev: network device
3503 * @buf: deauthentication frame (header + body)
3504 * @len: length of the frame data
3506 * This function is called whenever a received Deauthentication frame has been
3507 * dropped in station mode because of MFP being used but the Deauthentication
3508 * frame was not protected. This function may sleep.
3510 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
3514 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
3515 * @dev: network device
3516 * @buf: disassociation frame (header + body)
3517 * @len: length of the frame data
3519 * This function is called whenever a received Disassociation frame has been
3520 * dropped in station mode because of MFP being used but the Disassociation
3521 * frame was not protected. This function may sleep.
3523 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
3527 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3528 * @dev: network device
3529 * @addr: The source MAC address of the frame
3530 * @key_type: The key type that the received frame used
3531 * @key_id: Key identifier (0..3). Can be -1 if missing.
3532 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3533 * @gfp: allocation flags
3535 * This function is called whenever the local MAC detects a MIC failure in a
3536 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3539 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3540 enum nl80211_key_type key_type, int key_id,
3541 const u8 *tsc, gfp_t gfp);
3544 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3546 * @dev: network device
3547 * @bssid: the BSSID of the IBSS joined
3548 * @gfp: allocation flags
3550 * This function notifies cfg80211 that the device joined an IBSS or
3551 * switched to a different BSSID. Before this function can be called,
3552 * either a beacon has to have been received from the IBSS, or one of
3553 * the cfg80211_inform_bss{,_frame} functions must have been called
3554 * with the locally generated beacon -- this guarantees that there is
3555 * always a scan result for this IBSS. cfg80211 will handle the rest.
3557 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3560 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3562 * @dev: network device
3563 * @macaddr: the MAC address of the new candidate
3564 * @ie: information elements advertised by the peer candidate
3565 * @ie_len: lenght of the information elements buffer
3566 * @gfp: allocation flags
3568 * This function notifies cfg80211 that the mesh peer candidate has been
3569 * detected, most likely via a beacon or, less likely, via a probe response.
3570 * cfg80211 then sends a notification to userspace.
3572 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3573 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3576 * DOC: RFkill integration
3578 * RFkill integration in cfg80211 is almost invisible to drivers,
3579 * as cfg80211 automatically registers an rfkill instance for each
3580 * wireless device it knows about. Soft kill is also translated
3581 * into disconnecting and turning all interfaces off, drivers are
3582 * expected to turn off the device when all interfaces are down.
3584 * However, devices may have a hard RFkill line, in which case they
3585 * also need to interact with the rfkill subsystem, via cfg80211.
3586 * They can do this with a few helper functions documented here.
3590 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3592 * @blocked: block status
3594 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3597 * wiphy_rfkill_start_polling - start polling rfkill
3600 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3603 * wiphy_rfkill_stop_polling - stop polling rfkill
3606 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3608 #ifdef CONFIG_NL80211_TESTMODE
3612 * Test mode is a set of utility functions to allow drivers to
3613 * interact with driver-specific tools to aid, for instance,
3614 * factory programming.
3616 * This chapter describes how drivers interact with it, for more
3617 * information see the nl80211 book's chapter on it.
3621 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3623 * @approxlen: an upper bound of the length of the data that will
3624 * be put into the skb
3626 * This function allocates and pre-fills an skb for a reply to
3627 * the testmode command. Since it is intended for a reply, calling
3628 * it outside of the @testmode_cmd operation is invalid.
3630 * The returned skb is pre-filled with the wiphy index and set up in
3631 * a way that any data that is put into the skb (with skb_put(),
3632 * nla_put() or similar) will end up being within the
3633 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
3634 * with the skb is adding data for the corresponding userspace tool
3635 * which can then read that data out of the testdata attribute. You
3636 * must not modify the skb in any other way.
3638 * When done, call cfg80211_testmode_reply() with the skb and return
3639 * its error code as the result of the @testmode_cmd operation.
3641 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3643 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3647 * cfg80211_testmode_reply - send the reply skb
3648 * @skb: The skb, must have been allocated with
3649 * cfg80211_testmode_alloc_reply_skb()
3651 * Since calling this function will usually be the last thing
3652 * before returning from the @testmode_cmd you should return
3653 * the error code. Note that this function consumes the skb
3654 * regardless of the return value.
3656 * Return: An error code or 0 on success.
3658 int cfg80211_testmode_reply(struct sk_buff *skb);
3661 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3663 * @approxlen: an upper bound of the length of the data that will
3664 * be put into the skb
3665 * @gfp: allocation flags
3667 * This function allocates and pre-fills an skb for an event on the
3668 * testmode multicast group.
3670 * The returned skb is set up in the same way as with
3671 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
3672 * there, you should simply add data to it that will then end up in the
3673 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
3676 * When done filling the skb, call cfg80211_testmode_event() with the
3677 * skb to send the event.
3679 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3681 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3682 int approxlen, gfp_t gfp);
3685 * cfg80211_testmode_event - send the event
3686 * @skb: The skb, must have been allocated with
3687 * cfg80211_testmode_alloc_event_skb()
3688 * @gfp: allocation flags
3690 * This function sends the given @skb, which must have been allocated
3691 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3694 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3696 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3697 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3699 #define CFG80211_TESTMODE_CMD(cmd)
3700 #define CFG80211_TESTMODE_DUMP(cmd)
3704 * cfg80211_connect_result - notify cfg80211 of connection result
3706 * @dev: network device
3707 * @bssid: the BSSID of the AP
3708 * @req_ie: association request IEs (maybe be %NULL)
3709 * @req_ie_len: association request IEs length
3710 * @resp_ie: association response IEs (may be %NULL)
3711 * @resp_ie_len: assoc response IEs length
3712 * @status: status code, 0 for successful connection, use
3713 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3714 * the real status code for failures.
3715 * @gfp: allocation flags
3717 * It should be called by the underlying driver whenever connect() has
3720 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3721 const u8 *req_ie, size_t req_ie_len,
3722 const u8 *resp_ie, size_t resp_ie_len,
3723 u16 status, gfp_t gfp);
3726 * cfg80211_roamed - notify cfg80211 of roaming
3728 * @dev: network device
3729 * @channel: the channel of the new AP
3730 * @bssid: the BSSID of the new AP
3731 * @req_ie: association request IEs (maybe be %NULL)
3732 * @req_ie_len: association request IEs length
3733 * @resp_ie: association response IEs (may be %NULL)
3734 * @resp_ie_len: assoc response IEs length
3735 * @gfp: allocation flags
3737 * It should be called by the underlying driver whenever it roamed
3738 * from one AP to another while connected.
3740 void cfg80211_roamed(struct net_device *dev,
3741 struct ieee80211_channel *channel,
3743 const u8 *req_ie, size_t req_ie_len,
3744 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3747 * cfg80211_roamed_bss - notify cfg80211 of roaming
3749 * @dev: network device
3750 * @bss: entry of bss to which STA got roamed
3751 * @req_ie: association request IEs (maybe be %NULL)
3752 * @req_ie_len: association request IEs length
3753 * @resp_ie: association response IEs (may be %NULL)
3754 * @resp_ie_len: assoc response IEs length
3755 * @gfp: allocation flags
3757 * This is just a wrapper to notify cfg80211 of roaming event with driver
3758 * passing bss to avoid a race in timeout of the bss entry. It should be
3759 * called by the underlying driver whenever it roamed from one AP to another
3760 * while connected. Drivers which have roaming implemented in firmware
3761 * may use this function to avoid a race in bss entry timeout where the bss
3762 * entry of the new AP is seen in the driver, but gets timed out by the time
3763 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3764 * rdev->event_work. In case of any failures, the reference is released
3765 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3766 * it will be released while diconneting from the current bss.
3768 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3769 const u8 *req_ie, size_t req_ie_len,
3770 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3773 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3775 * @dev: network device
3776 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3777 * @ie_len: length of IEs
3778 * @reason: reason code for the disconnection, set it to 0 if unknown
3779 * @gfp: allocation flags
3781 * After it calls this function, the driver should enter an idle state
3782 * and not try to connect to any AP any more.
3784 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3785 u8 *ie, size_t ie_len, gfp_t gfp);
3788 * cfg80211_ready_on_channel - notification of remain_on_channel start
3789 * @wdev: wireless device
3790 * @cookie: the request cookie
3791 * @chan: The current channel (from remain_on_channel request)
3792 * @duration: Duration in milliseconds that the driver intents to remain on the
3794 * @gfp: allocation flags
3796 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
3797 struct ieee80211_channel *chan,
3798 unsigned int duration, gfp_t gfp);
3801 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3802 * @wdev: wireless device
3803 * @cookie: the request cookie
3804 * @chan: The current channel (from remain_on_channel request)
3805 * @gfp: allocation flags
3807 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
3808 struct ieee80211_channel *chan,
3813 * cfg80211_new_sta - notify userspace about station
3816 * @mac_addr: the station's address
3817 * @sinfo: the station information
3818 * @gfp: allocation flags
3820 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3821 struct station_info *sinfo, gfp_t gfp);
3824 * cfg80211_del_sta - notify userspace about deletion of a station
3827 * @mac_addr: the station's address
3828 * @gfp: allocation flags
3830 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3833 * cfg80211_conn_failed - connection request failed notification
3836 * @mac_addr: the station's address
3837 * @reason: the reason for connection failure
3838 * @gfp: allocation flags
3840 * Whenever a station tries to connect to an AP and if the station
3841 * could not connect to the AP as the AP has rejected the connection
3842 * for some reasons, this function is called.
3844 * The reason for connection failure can be any of the value from
3845 * nl80211_connect_failed_reason enum
3847 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
3848 enum nl80211_connect_failed_reason reason,
3852 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3853 * @wdev: wireless device receiving the frame
3854 * @freq: Frequency on which the frame was received in MHz
3855 * @sig_dbm: signal strength in mBm, or 0 if unknown
3856 * @buf: Management frame (header + body)
3857 * @len: length of the frame data
3858 * @gfp: context flags
3860 * This function is called whenever an Action frame is received for a station
3861 * mode interface, but is not processed in kernel.
3863 * Return: %true if a user space application has registered for this frame.
3864 * For action frames, that makes it responsible for rejecting unrecognized
3865 * action frames; %false otherwise, in which case for action frames the
3866 * driver is responsible for rejecting the frame.
3868 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
3869 const u8 *buf, size_t len, gfp_t gfp);
3872 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3873 * @wdev: wireless device receiving the frame
3874 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3875 * @buf: Management frame (header + body)
3876 * @len: length of the frame data
3877 * @ack: Whether frame was acknowledged
3878 * @gfp: context flags
3880 * This function is called whenever a management frame was requested to be
3881 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3882 * transmission attempt.
3884 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
3885 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3889 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3890 * @dev: network device
3891 * @rssi_event: the triggered RSSI event
3892 * @gfp: context flags
3894 * This function is called when a configured connection quality monitoring
3895 * rssi threshold reached event occurs.
3897 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3898 enum nl80211_cqm_rssi_threshold_event rssi_event,
3902 * cfg80211_radar_event - radar detection event
3904 * @chandef: chandef for the current channel
3905 * @gfp: context flags
3907 * This function is called when a radar is detected on the current chanenl.
3909 void cfg80211_radar_event(struct wiphy *wiphy,
3910 struct cfg80211_chan_def *chandef, gfp_t gfp);
3913 * cfg80211_cac_event - Channel availability check (CAC) event
3914 * @netdev: network device
3915 * @event: type of event
3916 * @gfp: context flags
3918 * This function is called when a Channel availability check (CAC) is finished
3919 * or aborted. This must be called to notify the completion of a CAC process,
3920 * also by full-MAC drivers.
3922 void cfg80211_cac_event(struct net_device *netdev,
3923 enum nl80211_radar_event event, gfp_t gfp);
3927 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3928 * @dev: network device
3929 * @peer: peer's MAC address
3930 * @num_packets: how many packets were lost -- should be a fixed threshold
3931 * but probably no less than maybe 50, or maybe a throughput dependent
3932 * threshold (to account for temporary interference)
3933 * @gfp: context flags
3935 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3936 const u8 *peer, u32 num_packets, gfp_t gfp);
3939 * cfg80211_cqm_txe_notify - TX error rate event
3940 * @dev: network device
3941 * @peer: peer's MAC address
3942 * @num_packets: how many packets were lost
3943 * @rate: % of packets which failed transmission
3944 * @intvl: interval (in s) over which the TX failure threshold was breached.
3945 * @gfp: context flags
3947 * Notify userspace when configured % TX failures over number of packets in a
3948 * given interval is exceeded.
3950 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
3951 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
3954 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3955 * @dev: network device
3956 * @bssid: BSSID of AP (to avoid races)
3957 * @replay_ctr: new replay counter
3958 * @gfp: allocation flags
3960 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3961 const u8 *replay_ctr, gfp_t gfp);
3964 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3965 * @dev: network device
3966 * @index: candidate index (the smaller the index, the higher the priority)
3967 * @bssid: BSSID of AP
3968 * @preauth: Whether AP advertises support for RSN pre-authentication
3969 * @gfp: allocation flags
3971 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3972 const u8 *bssid, bool preauth, gfp_t gfp);
3975 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3976 * @dev: The device the frame matched to
3977 * @addr: the transmitter address
3978 * @gfp: context flags
3980 * This function is used in AP mode (only!) to inform userspace that
3981 * a spurious class 3 frame was received, to be able to deauth the
3983 * Return: %true if the frame was passed to userspace (or this failed
3984 * for a reason other than not having a subscription.)
3986 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3987 const u8 *addr, gfp_t gfp);
3990 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3991 * @dev: The device the frame matched to
3992 * @addr: the transmitter address
3993 * @gfp: context flags
3995 * This function is used in AP mode (only!) to inform userspace that
3996 * an associated station sent a 4addr frame but that wasn't expected.
3997 * It is allowed and desirable to send this event only once for each
3998 * station to avoid event flooding.
3999 * Return: %true if the frame was passed to userspace (or this failed
4000 * for a reason other than not having a subscription.)
4002 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4003 const u8 *addr, gfp_t gfp);
4006 * cfg80211_probe_status - notify userspace about probe status
4007 * @dev: the device the probe was sent on
4008 * @addr: the address of the peer
4009 * @cookie: the cookie filled in @probe_client previously
4010 * @acked: indicates whether probe was acked or not
4011 * @gfp: allocation flags
4013 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4014 u64 cookie, bool acked, gfp_t gfp);
4017 * cfg80211_report_obss_beacon - report beacon from other APs
4018 * @wiphy: The wiphy that received the beacon
4020 * @len: length of the frame
4021 * @freq: frequency the frame was received on
4022 * @sig_dbm: signal strength in mBm, or 0 if unknown
4024 * Use this function to report to userspace when a beacon was
4025 * received. It is not useful to call this when there is no
4026 * netdev that is in AP/GO mode.
4028 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4029 const u8 *frame, size_t len,
4030 int freq, int sig_dbm);
4033 * cfg80211_reg_can_beacon - check if beaconing is allowed
4035 * @chandef: the channel definition
4037 * Return: %true if there is no secondary channel or the secondary channel(s)
4038 * can be used for beaconing (i.e. is not a radar channel etc.)
4040 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4041 struct cfg80211_chan_def *chandef);
4044 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4045 * @dev: the device which switched channels
4046 * @chandef: the new channel definition
4048 * Acquires wdev_lock, so must only be called from sleepable driver context!
4050 void cfg80211_ch_switch_notify(struct net_device *dev,
4051 struct cfg80211_chan_def *chandef);
4054 * ieee80211_operating_class_to_band - convert operating class to band
4056 * @operating_class: the operating class to convert
4057 * @band: band pointer to fill
4059 * Returns %true if the conversion was successful, %false otherwise.
4061 bool ieee80211_operating_class_to_band(u8 operating_class,
4062 enum ieee80211_band *band);
4065 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4066 * @dev: the device on which the operation is requested
4067 * @peer: the MAC address of the peer device
4068 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4069 * NL80211_TDLS_TEARDOWN)
4070 * @reason_code: the reason code for teardown request
4071 * @gfp: allocation flags
4073 * This function is used to request userspace to perform TDLS operation that
4074 * requires knowledge of keys, i.e., link setup or teardown when the AP
4075 * connection uses encryption. This is optional mechanism for the driver to use
4076 * if it can automatically determine when a TDLS link could be useful (e.g.,
4077 * based on traffic and signal strength for a peer).
4079 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4080 enum nl80211_tdls_operation oper,
4081 u16 reason_code, gfp_t gfp);
4084 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4085 * @rate: given rate_info to calculate bitrate from
4087 * return 0 if MCS index >= 32
4089 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4092 * cfg80211_unregister_wdev - remove the given wdev
4093 * @wdev: struct wireless_dev to remove
4095 * Call this function only for wdevs that have no netdev assigned,
4096 * e.g. P2P Devices. It removes the device from the list so that
4097 * it can no longer be used. It is necessary to call this function
4098 * even when cfg80211 requests the removal of the interface by
4099 * calling the del_virtual_intf() callback. The function must also
4100 * be called when the driver wishes to unregister the wdev, e.g.
4101 * when the device is unbound from the driver.
4103 * Requires the RTNL to be held.
4105 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4108 * struct cfg80211_ft_event - FT Information Elements
4110 * @ies_len: length of the FT IE in bytes
4111 * @target_ap: target AP's MAC address
4113 * @ric_ies_len: length of the RIC IE in bytes
4115 struct cfg80211_ft_event_params {
4118 const u8 *target_ap;
4124 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
4125 * @netdev: network device
4126 * @ft_event: IE information
4128 void cfg80211_ft_event(struct net_device *netdev,
4129 struct cfg80211_ft_event_params *ft_event);
4132 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4133 * @ies: the input IE buffer
4134 * @len: the input length
4135 * @attr: the attribute ID to find
4136 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4137 * if the function is only called to get the needed buffer size
4138 * @bufsize: size of the output buffer
4140 * The function finds a given P2P attribute in the (vendor) IEs and
4141 * copies its contents to the given buffer.
4143 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4144 * malformed or the attribute can't be found (respectively), or the
4145 * length of the found attribute (which can be zero).
4147 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4148 enum ieee80211_p2p_attr_id attr,
4149 u8 *buf, unsigned int bufsize);
4152 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4153 * @wdev: the wireless device reporting the wakeup
4154 * @wakeup: the wakeup report
4155 * @gfp: allocation flags
4157 * This function reports that the given device woke up. If it
4158 * caused the wakeup, report the reason(s), otherwise you may
4159 * pass %NULL as the @wakeup parameter to advertise that something
4160 * else caused the wakeup.
4162 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4163 struct cfg80211_wowlan_wakeup *wakeup,
4167 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
4169 * @wdev: the wireless device for which critical protocol is stopped.
4171 * This function can be called by the driver to indicate it has reverted
4172 * operation back to normal. One reason could be that the duration given
4173 * by .crit_proto_start() has expired.
4175 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
4177 /* Logging, debugging and troubleshooting/diagnostic helpers. */
4179 /* wiphy_printk helpers, similar to dev_printk */
4181 #define wiphy_printk(level, wiphy, format, args...) \
4182 dev_printk(level, &(wiphy)->dev, format, ##args)
4183 #define wiphy_emerg(wiphy, format, args...) \
4184 dev_emerg(&(wiphy)->dev, format, ##args)
4185 #define wiphy_alert(wiphy, format, args...) \
4186 dev_alert(&(wiphy)->dev, format, ##args)
4187 #define wiphy_crit(wiphy, format, args...) \
4188 dev_crit(&(wiphy)->dev, format, ##args)
4189 #define wiphy_err(wiphy, format, args...) \
4190 dev_err(&(wiphy)->dev, format, ##args)
4191 #define wiphy_warn(wiphy, format, args...) \
4192 dev_warn(&(wiphy)->dev, format, ##args)
4193 #define wiphy_notice(wiphy, format, args...) \
4194 dev_notice(&(wiphy)->dev, format, ##args)
4195 #define wiphy_info(wiphy, format, args...) \
4196 dev_info(&(wiphy)->dev, format, ##args)
4198 #define wiphy_debug(wiphy, format, args...) \
4199 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
4201 #define wiphy_dbg(wiphy, format, args...) \
4202 dev_dbg(&(wiphy)->dev, format, ##args)
4204 #if defined(VERBOSE_DEBUG)
4205 #define wiphy_vdbg wiphy_dbg
4207 #define wiphy_vdbg(wiphy, format, args...) \
4210 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
4216 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
4217 * of using a WARN/WARN_ON to get the message out, including the
4218 * file/line information and a backtrace.
4220 #define wiphy_WARN(wiphy, format, args...) \
4221 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
4223 #endif /* __NET_CFG80211_H */