1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __NET_CFG80211_H
3 #define __NET_CFG80211_H
5 * 802.11 device and configuration interface
7 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright 2015-2017 Intel Deutschland GmbH
10 * Copyright (C) 2018-2019 Intel Corporation
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_channel_flags - channel flags
71 * Channel flags set by the regulatory control code.
73 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
74 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
75 * sending probe requests or beaconing.
76 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
77 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
79 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
81 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
82 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
83 * this flag indicates that an 80 MHz channel cannot use this
84 * channel as the control or any of the secondary channels.
85 * This may be due to the driver or due to regulatory bandwidth
87 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
88 * this flag indicates that an 160 MHz channel cannot use this
89 * channel as the control or any of the secondary channels.
90 * This may be due to the driver or due to regulatory bandwidth
92 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
93 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
94 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
96 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
98 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
101 enum ieee80211_channel_flags {
102 IEEE80211_CHAN_DISABLED = 1<<0,
103 IEEE80211_CHAN_NO_IR = 1<<1,
105 IEEE80211_CHAN_RADAR = 1<<3,
106 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
107 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
108 IEEE80211_CHAN_NO_OFDM = 1<<6,
109 IEEE80211_CHAN_NO_80MHZ = 1<<7,
110 IEEE80211_CHAN_NO_160MHZ = 1<<8,
111 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
112 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
113 IEEE80211_CHAN_NO_20MHZ = 1<<11,
114 IEEE80211_CHAN_NO_10MHZ = 1<<12,
115 IEEE80211_CHAN_NO_HE = 1<<13,
118 #define IEEE80211_CHAN_NO_HT40 \
119 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
121 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
122 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
125 * struct ieee80211_channel - channel definition
127 * This structure describes a single channel for use
130 * @center_freq: center frequency in MHz
131 * @hw_value: hardware-specific value for the channel
132 * @flags: channel flags from &enum ieee80211_channel_flags.
133 * @orig_flags: channel flags at registration time, used by regulatory
134 * code to support devices with additional restrictions
135 * @band: band this channel belongs to.
136 * @max_antenna_gain: maximum antenna gain in dBi
137 * @max_power: maximum transmission power (in dBm)
138 * @max_reg_power: maximum regulatory transmission power (in dBm)
139 * @beacon_found: helper to regulatory code to indicate when a beacon
140 * has been found on this channel. Use regulatory_hint_found_beacon()
141 * to enable this, this is useful only on 5 GHz band.
142 * @orig_mag: internal use
143 * @orig_mpwr: internal use
144 * @dfs_state: current state of this channel. Only relevant if radar is required
146 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
147 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
149 struct ieee80211_channel {
150 enum nl80211_band band;
154 int max_antenna_gain;
159 int orig_mag, orig_mpwr;
160 enum nl80211_dfs_state dfs_state;
161 unsigned long dfs_state_entered;
162 unsigned int dfs_cac_ms;
166 * enum ieee80211_rate_flags - rate flags
168 * Hardware/specification flags for rates. These are structured
169 * in a way that allows using the same bitrate structure for
170 * different bands/PHY modes.
172 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
173 * preamble on this bitrate; only relevant in 2.4GHz band and
175 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
176 * when used with 802.11a (on the 5 GHz band); filled by the
177 * core code when registering the wiphy.
178 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
179 * when used with 802.11b (on the 2.4 GHz band); filled by the
180 * core code when registering the wiphy.
181 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
182 * when used with 802.11g (on the 2.4 GHz band); filled by the
183 * core code when registering the wiphy.
184 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
185 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
186 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
188 enum ieee80211_rate_flags {
189 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
190 IEEE80211_RATE_MANDATORY_A = 1<<1,
191 IEEE80211_RATE_MANDATORY_B = 1<<2,
192 IEEE80211_RATE_MANDATORY_G = 1<<3,
193 IEEE80211_RATE_ERP_G = 1<<4,
194 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
195 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
199 * enum ieee80211_bss_type - BSS type filter
201 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
202 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
203 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
204 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
205 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
207 enum ieee80211_bss_type {
208 IEEE80211_BSS_TYPE_ESS,
209 IEEE80211_BSS_TYPE_PBSS,
210 IEEE80211_BSS_TYPE_IBSS,
211 IEEE80211_BSS_TYPE_MBSS,
212 IEEE80211_BSS_TYPE_ANY
216 * enum ieee80211_privacy - BSS privacy filter
218 * @IEEE80211_PRIVACY_ON: privacy bit set
219 * @IEEE80211_PRIVACY_OFF: privacy bit clear
220 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
222 enum ieee80211_privacy {
223 IEEE80211_PRIVACY_ON,
224 IEEE80211_PRIVACY_OFF,
225 IEEE80211_PRIVACY_ANY
228 #define IEEE80211_PRIVACY(x) \
229 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
232 * struct ieee80211_rate - bitrate definition
234 * This structure describes a bitrate that an 802.11 PHY can
235 * operate with. The two values @hw_value and @hw_value_short
236 * are only for driver use when pointers to this structure are
239 * @flags: rate-specific flags
240 * @bitrate: bitrate in units of 100 Kbps
241 * @hw_value: driver/hardware value for this rate
242 * @hw_value_short: driver/hardware value for this rate when
243 * short preamble is used
245 struct ieee80211_rate {
248 u16 hw_value, hw_value_short;
252 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
254 * @enable: is the feature enabled.
255 * @min_offset: minimal tx power offset an associated station shall use
256 * @max_offset: maximum tx power offset an associated station shall use
258 struct ieee80211_he_obss_pd {
265 * struct cfg80211_he_bss_color - AP settings for BSS coloring
267 * @color: the current color.
268 * @disabled: is the feature disabled.
269 * @partial: define the AID equation.
271 struct cfg80211_he_bss_color {
278 * struct ieee80211_he_bss_color - AP settings for BSS coloring
280 * @color: the current color.
281 * @disabled: is the feature disabled.
282 * @partial: define the AID equation.
284 struct ieee80211_he_bss_color {
291 * struct ieee80211_sta_ht_cap - STA's HT capabilities
293 * This structure describes most essential parameters needed
294 * to describe 802.11n HT capabilities for an STA.
296 * @ht_supported: is HT supported by the STA
297 * @cap: HT capabilities map as described in 802.11n spec
298 * @ampdu_factor: Maximum A-MPDU length factor
299 * @ampdu_density: Minimum A-MPDU spacing
300 * @mcs: Supported MCS rates
302 struct ieee80211_sta_ht_cap {
303 u16 cap; /* use IEEE80211_HT_CAP_ */
307 struct ieee80211_mcs_info mcs;
311 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
313 * This structure describes most essential parameters needed
314 * to describe 802.11ac VHT capabilities for an STA.
316 * @vht_supported: is VHT supported by the STA
317 * @cap: VHT capabilities map as described in 802.11ac spec
318 * @vht_mcs: Supported VHT MCS rates
320 struct ieee80211_sta_vht_cap {
322 u32 cap; /* use IEEE80211_VHT_CAP_ */
323 struct ieee80211_vht_mcs_info vht_mcs;
326 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
329 * struct ieee80211_sta_he_cap - STA's HE capabilities
331 * This structure describes most essential parameters needed
332 * to describe 802.11ax HE capabilities for a STA.
334 * @has_he: true iff HE data is valid.
335 * @he_cap_elem: Fixed portion of the HE capabilities element.
336 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
337 * @ppe_thres: Holds the PPE Thresholds data.
339 struct ieee80211_sta_he_cap {
341 struct ieee80211_he_cap_elem he_cap_elem;
342 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
343 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
347 * struct ieee80211_sband_iftype_data
349 * This structure encapsulates sband data that is relevant for the
350 * interface types defined in @types_mask. Each type in the
351 * @types_mask must be unique across all instances of iftype_data.
353 * @types_mask: interface types mask
354 * @he_cap: holds the HE capabilities
356 struct ieee80211_sband_iftype_data {
358 struct ieee80211_sta_he_cap he_cap;
362 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
364 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
365 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
366 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
367 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
368 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
369 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
370 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
371 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
373 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
375 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
377 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
378 * and 4.32GHz + 4.32GHz
379 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
380 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
382 enum ieee80211_edmg_bw_config {
383 IEEE80211_EDMG_BW_CONFIG_4 = 4,
384 IEEE80211_EDMG_BW_CONFIG_5 = 5,
385 IEEE80211_EDMG_BW_CONFIG_6 = 6,
386 IEEE80211_EDMG_BW_CONFIG_7 = 7,
387 IEEE80211_EDMG_BW_CONFIG_8 = 8,
388 IEEE80211_EDMG_BW_CONFIG_9 = 9,
389 IEEE80211_EDMG_BW_CONFIG_10 = 10,
390 IEEE80211_EDMG_BW_CONFIG_11 = 11,
391 IEEE80211_EDMG_BW_CONFIG_12 = 12,
392 IEEE80211_EDMG_BW_CONFIG_13 = 13,
393 IEEE80211_EDMG_BW_CONFIG_14 = 14,
394 IEEE80211_EDMG_BW_CONFIG_15 = 15,
398 * struct ieee80211_edmg - EDMG configuration
400 * This structure describes most essential parameters needed
401 * to describe 802.11ay EDMG configuration
403 * @channels: bitmap that indicates the 2.16 GHz channel(s)
404 * that are allowed to be used for transmissions.
405 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
406 * Set to 0 indicate EDMG not supported.
407 * @bw_config: Channel BW Configuration subfield encodes
408 * the allowed channel bandwidth configurations
410 struct ieee80211_edmg {
412 enum ieee80211_edmg_bw_config bw_config;
416 * struct ieee80211_supported_band - frequency band definition
418 * This structure describes a frequency band a wiphy
419 * is able to operate in.
421 * @channels: Array of channels the hardware can operate in
423 * @band: the band this structure represents
424 * @n_channels: Number of channels in @channels
425 * @bitrates: Array of bitrates the hardware can operate with
426 * in this band. Must be sorted to give a valid "supported
427 * rates" IE, i.e. CCK rates first, then OFDM.
428 * @n_bitrates: Number of bitrates in @bitrates
429 * @ht_cap: HT capabilities in this band
430 * @vht_cap: VHT capabilities in this band
431 * @edmg_cap: EDMG capabilities in this band
432 * @n_iftype_data: number of iftype data entries
433 * @iftype_data: interface type data entries. Note that the bits in
434 * @types_mask inside this structure cannot overlap (i.e. only
435 * one occurrence of each type is allowed across all instances of
438 struct ieee80211_supported_band {
439 struct ieee80211_channel *channels;
440 struct ieee80211_rate *bitrates;
441 enum nl80211_band band;
444 struct ieee80211_sta_ht_cap ht_cap;
445 struct ieee80211_sta_vht_cap vht_cap;
446 struct ieee80211_edmg edmg_cap;
448 const struct ieee80211_sband_iftype_data *iftype_data;
452 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
453 * @sband: the sband to search for the STA on
454 * @iftype: enum nl80211_iftype
456 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
458 static inline const struct ieee80211_sband_iftype_data *
459 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
464 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
467 for (i = 0; i < sband->n_iftype_data; i++) {
468 const struct ieee80211_sband_iftype_data *data =
469 &sband->iftype_data[i];
471 if (data->types_mask & BIT(iftype))
479 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
480 * @sband: the sband to search for the iftype on
481 * @iftype: enum nl80211_iftype
483 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
485 static inline const struct ieee80211_sta_he_cap *
486 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
489 const struct ieee80211_sband_iftype_data *data =
490 ieee80211_get_sband_iftype_data(sband, iftype);
492 if (data && data->he_cap.has_he)
493 return &data->he_cap;
499 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
500 * @sband: the sband to search for the STA on
502 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
504 static inline const struct ieee80211_sta_he_cap *
505 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
507 return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
511 * wiphy_read_of_freq_limits - read frequency limits from device tree
513 * @wiphy: the wireless device to get extra limits for
515 * Some devices may have extra limitations specified in DT. This may be useful
516 * for chipsets that normally support more bands but are limited due to board
517 * design (e.g. by antennas or external power amplifier).
519 * This function reads info from DT and uses it to *modify* channels (disable
520 * unavailable ones). It's usually a *bad* idea to use it in drivers with
521 * shared channel data as DT limitations are device specific. You should make
522 * sure to call it only if channels in wiphy are copied and can be modified
523 * without affecting other devices.
525 * As this function access device node it has to be called after set_wiphy_dev.
526 * It also modifies channels so they have to be set first.
527 * If using this helper, call it before wiphy_register().
530 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
531 #else /* CONFIG_OF */
532 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
535 #endif /* !CONFIG_OF */
539 * Wireless hardware/device configuration structures and methods
543 * DOC: Actions and configuration
545 * Each wireless device and each virtual interface offer a set of configuration
546 * operations and other actions that are invoked by userspace. Each of these
547 * actions is described in the operations structure, and the parameters these
548 * operations use are described separately.
550 * Additionally, some operations are asynchronous and expect to get status
551 * information via some functions that drivers need to call.
553 * Scanning and BSS list handling with its associated functionality is described
554 * in a separate chapter.
557 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
558 WLAN_USER_POSITION_LEN)
561 * struct vif_params - describes virtual interface parameters
562 * @flags: monitor interface flags, unchanged if 0, otherwise
563 * %MONITOR_FLAG_CHANGED will be set
564 * @use_4addr: use 4-address frames
565 * @macaddr: address to use for this virtual interface.
566 * If this parameter is set to zero address the driver may
567 * determine the address as needed.
568 * This feature is only fully supported by drivers that enable the
569 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
570 ** only p2p devices with specified MAC.
571 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
572 * belonging to that MU-MIMO groupID; %NULL if not changed
573 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
574 * MU-MIMO packets going to the specified station; %NULL if not changed
579 u8 macaddr[ETH_ALEN];
580 const u8 *vht_mumimo_groups;
581 const u8 *vht_mumimo_follow_addr;
585 * struct key_params - key information
587 * Information about a key
590 * @key_len: length of key material
591 * @cipher: cipher suite selector
592 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
593 * with the get_key() callback, must be in little endian,
594 * length given by @seq_len.
595 * @seq_len: length of @seq.
596 * @vlan_id: vlan_id for VLAN group key (if nonzero)
597 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
606 enum nl80211_key_mode mode;
610 * struct cfg80211_chan_def - channel definition
611 * @chan: the (control) channel
612 * @width: channel width
613 * @center_freq1: center frequency of first segment
614 * @center_freq2: center frequency of second segment
615 * (only with 80+80 MHz)
616 * @edmg: define the EDMG channels configuration.
617 * If edmg is requested (i.e. the .channels member is non-zero),
618 * chan will define the primary channel and all other
619 * parameters are ignored.
621 struct cfg80211_chan_def {
622 struct ieee80211_channel *chan;
623 enum nl80211_chan_width width;
626 struct ieee80211_edmg edmg;
629 enum ieee80211_tid_conf_mask {
630 IEEE80211_TID_CONF_NOACK = BIT(NL80211_TID_CONFIG_ATTR_NOACK),
634 * struct ieee80211_tid_cfg - TID specific configuration
635 * @config_override: Flag to notify driver to reset TID configuration
638 * @tid_conf_mask: bitmap indicating which parameter changed
639 * see &enum ieee80211_tid_conf_mask
640 * @noack: noack configuration value for the TID
642 struct ieee80211_tid_cfg {
643 bool config_override;
646 enum nl80211_tid_config noack;
650 * struct ieee80211_tid_config - TID configuration
651 * @peer: Station's MAC address
652 * @n_tid_conf: Number of TID specific configurations to be applied
653 * @tid_conf: Configuration change info
655 struct ieee80211_tid_config {
658 struct ieee80211_tid_cfg tid_conf[];
662 * cfg80211_get_chandef_type - return old channel type from chandef
663 * @chandef: the channel definition
665 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
666 * chandef, which must have a bandwidth allowing this conversion.
668 static inline enum nl80211_channel_type
669 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
671 switch (chandef->width) {
672 case NL80211_CHAN_WIDTH_20_NOHT:
673 return NL80211_CHAN_NO_HT;
674 case NL80211_CHAN_WIDTH_20:
675 return NL80211_CHAN_HT20;
676 case NL80211_CHAN_WIDTH_40:
677 if (chandef->center_freq1 > chandef->chan->center_freq)
678 return NL80211_CHAN_HT40PLUS;
679 return NL80211_CHAN_HT40MINUS;
682 return NL80211_CHAN_NO_HT;
687 * cfg80211_chandef_create - create channel definition using channel type
688 * @chandef: the channel definition struct to fill
689 * @channel: the control channel
690 * @chantype: the channel type
692 * Given a channel type, create a channel definition.
694 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
695 struct ieee80211_channel *channel,
696 enum nl80211_channel_type chantype);
699 * cfg80211_chandef_identical - check if two channel definitions are identical
700 * @chandef1: first channel definition
701 * @chandef2: second channel definition
703 * Return: %true if the channels defined by the channel definitions are
704 * identical, %false otherwise.
707 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
708 const struct cfg80211_chan_def *chandef2)
710 return (chandef1->chan == chandef2->chan &&
711 chandef1->width == chandef2->width &&
712 chandef1->center_freq1 == chandef2->center_freq1 &&
713 chandef1->center_freq2 == chandef2->center_freq2);
717 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
719 * @chandef: the channel definition
721 * Return: %true if EDMG defined, %false otherwise.
724 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
726 return chandef->edmg.channels || chandef->edmg.bw_config;
730 * cfg80211_chandef_compatible - check if two channel definitions are compatible
731 * @chandef1: first channel definition
732 * @chandef2: second channel definition
734 * Return: %NULL if the given channel definitions are incompatible,
735 * chandef1 or chandef2 otherwise.
737 const struct cfg80211_chan_def *
738 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
739 const struct cfg80211_chan_def *chandef2);
742 * cfg80211_chandef_valid - check if a channel definition is valid
743 * @chandef: the channel definition to check
744 * Return: %true if the channel definition is valid. %false otherwise.
746 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
749 * cfg80211_chandef_usable - check if secondary channels can be used
750 * @wiphy: the wiphy to validate against
751 * @chandef: the channel definition to check
752 * @prohibited_flags: the regulatory channel flags that must not be set
753 * Return: %true if secondary channels are usable. %false otherwise.
755 bool cfg80211_chandef_usable(struct wiphy *wiphy,
756 const struct cfg80211_chan_def *chandef,
757 u32 prohibited_flags);
760 * cfg80211_chandef_dfs_required - checks if radar detection is required
761 * @wiphy: the wiphy to validate against
762 * @chandef: the channel definition to check
763 * @iftype: the interface type as specified in &enum nl80211_iftype
765 * 1 if radar detection is required, 0 if it is not, < 0 on error
767 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
768 const struct cfg80211_chan_def *chandef,
769 enum nl80211_iftype iftype);
772 * ieee80211_chandef_rate_flags - returns rate flags for a channel
774 * In some channel types, not all rates may be used - for example CCK
775 * rates may not be used in 5/10 MHz channels.
777 * @chandef: channel definition for the channel
779 * Returns: rate flags which apply for this channel
781 static inline enum ieee80211_rate_flags
782 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
784 switch (chandef->width) {
785 case NL80211_CHAN_WIDTH_5:
786 return IEEE80211_RATE_SUPPORTS_5MHZ;
787 case NL80211_CHAN_WIDTH_10:
788 return IEEE80211_RATE_SUPPORTS_10MHZ;
796 * ieee80211_chandef_max_power - maximum transmission power for the chandef
798 * In some regulations, the transmit power may depend on the configured channel
799 * bandwidth which may be defined as dBm/MHz. This function returns the actual
800 * max_power for non-standard (20 MHz) channels.
802 * @chandef: channel definition for the channel
804 * Returns: maximum allowed transmission power in dBm for the chandef
807 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
809 switch (chandef->width) {
810 case NL80211_CHAN_WIDTH_5:
811 return min(chandef->chan->max_reg_power - 6,
812 chandef->chan->max_power);
813 case NL80211_CHAN_WIDTH_10:
814 return min(chandef->chan->max_reg_power - 3,
815 chandef->chan->max_power);
819 return chandef->chan->max_power;
823 * enum survey_info_flags - survey information flags
825 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
826 * @SURVEY_INFO_IN_USE: channel is currently being used
827 * @SURVEY_INFO_TIME: active time (in ms) was filled in
828 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
829 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
830 * @SURVEY_INFO_TIME_RX: receive time was filled in
831 * @SURVEY_INFO_TIME_TX: transmit time was filled in
832 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
833 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
835 * Used by the driver to indicate which info in &struct survey_info
836 * it has filled in during the get_survey().
838 enum survey_info_flags {
839 SURVEY_INFO_NOISE_DBM = BIT(0),
840 SURVEY_INFO_IN_USE = BIT(1),
841 SURVEY_INFO_TIME = BIT(2),
842 SURVEY_INFO_TIME_BUSY = BIT(3),
843 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
844 SURVEY_INFO_TIME_RX = BIT(5),
845 SURVEY_INFO_TIME_TX = BIT(6),
846 SURVEY_INFO_TIME_SCAN = BIT(7),
847 SURVEY_INFO_TIME_BSS_RX = BIT(8),
851 * struct survey_info - channel survey response
853 * @channel: the channel this survey record reports, may be %NULL for a single
854 * record to report global statistics
855 * @filled: bitflag of flags from &enum survey_info_flags
856 * @noise: channel noise in dBm. This and all following fields are
858 * @time: amount of time in ms the radio was turn on (on the channel)
859 * @time_busy: amount of time the primary channel was sensed busy
860 * @time_ext_busy: amount of time the extension channel was sensed busy
861 * @time_rx: amount of time the radio spent receiving data
862 * @time_tx: amount of time the radio spent transmitting data
863 * @time_scan: amount of time the radio spent for scanning
864 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
866 * Used by dump_survey() to report back per-channel survey information.
868 * This structure can later be expanded with things like
869 * channel duty cycle etc.
872 struct ieee80211_channel *channel;
884 #define CFG80211_MAX_WEP_KEYS 4
887 * struct cfg80211_crypto_settings - Crypto settings
888 * @wpa_versions: indicates which, if any, WPA versions are enabled
889 * (from enum nl80211_wpa_versions)
890 * @cipher_group: group key cipher suite (or 0 if unset)
891 * @n_ciphers_pairwise: number of AP supported unicast ciphers
892 * @ciphers_pairwise: unicast key cipher suites
893 * @n_akm_suites: number of AKM suites
894 * @akm_suites: AKM suites
895 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
896 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
897 * required to assume that the port is unauthorized until authorized by
898 * user space. Otherwise, port is marked authorized by default.
899 * @control_port_ethertype: the control port protocol that should be
900 * allowed through even on unauthorized ports
901 * @control_port_no_encrypt: TRUE to prevent encryption of control port
903 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
904 * port frames over NL80211 instead of the network interface.
905 * @wep_keys: static WEP keys, if not NULL points to an array of
906 * CFG80211_MAX_WEP_KEYS WEP keys
907 * @wep_tx_key: key index (0..3) of the default TX static WEP key
908 * @psk: PSK (for devices supporting 4-way-handshake offload)
909 * @sae_pwd: password for SAE authentication (for devices supporting SAE
911 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
913 struct cfg80211_crypto_settings {
916 int n_ciphers_pairwise;
917 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
919 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
921 __be16 control_port_ethertype;
922 bool control_port_no_encrypt;
923 bool control_port_over_nl80211;
924 struct key_params *wep_keys;
932 * struct cfg80211_beacon_data - beacon data
933 * @head: head portion of beacon (before TIM IE)
934 * or %NULL if not changed
935 * @tail: tail portion of beacon (after TIM IE)
936 * or %NULL if not changed
937 * @head_len: length of @head
938 * @tail_len: length of @tail
939 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
940 * @beacon_ies_len: length of beacon_ies in octets
941 * @proberesp_ies: extra information element(s) to add into Probe Response
943 * @proberesp_ies_len: length of proberesp_ies in octets
944 * @assocresp_ies: extra information element(s) to add into (Re)Association
945 * Response frames or %NULL
946 * @assocresp_ies_len: length of assocresp_ies in octets
947 * @probe_resp_len: length of probe response template (@probe_resp)
948 * @probe_resp: probe response template (AP mode only)
949 * @ftm_responder: enable FTM responder functionality; -1 for no change
950 * (which also implies no change in LCI/civic location data)
951 * @lci: Measurement Report element content, starting with Measurement Token
952 * (measurement type 8)
953 * @civicloc: Measurement Report element content, starting with Measurement
954 * Token (measurement type 11)
955 * @lci_len: LCI data length
956 * @civicloc_len: Civic location data length
958 struct cfg80211_beacon_data {
959 const u8 *head, *tail;
960 const u8 *beacon_ies;
961 const u8 *proberesp_ies;
962 const u8 *assocresp_ies;
963 const u8 *probe_resp;
968 size_t head_len, tail_len;
969 size_t beacon_ies_len;
970 size_t proberesp_ies_len;
971 size_t assocresp_ies_len;
972 size_t probe_resp_len;
982 * struct cfg80211_acl_data - Access control list data
984 * @acl_policy: ACL policy to be applied on the station's
985 * entry specified by mac_addr
986 * @n_acl_entries: Number of MAC address entries passed
987 * @mac_addrs: List of MAC addresses of stations to be used for ACL
989 struct cfg80211_acl_data {
990 enum nl80211_acl_policy acl_policy;
994 struct mac_address mac_addrs[];
998 * cfg80211_bitrate_mask - masks for bitrate control
1000 struct cfg80211_bitrate_mask {
1003 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1004 u16 vht_mcs[NL80211_VHT_NSS_MAX];
1005 enum nl80211_txrate_gi gi;
1006 } control[NUM_NL80211_BANDS];
1010 * enum cfg80211_ap_settings_flags - AP settings flags
1012 * Used by cfg80211_ap_settings
1014 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
1016 enum cfg80211_ap_settings_flags {
1017 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
1021 * struct cfg80211_ap_settings - AP configuration
1023 * Used to configure an AP interface.
1025 * @chandef: defines the channel to use
1026 * @beacon: beacon data
1027 * @beacon_interval: beacon interval
1028 * @dtim_period: DTIM period
1029 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1031 * @ssid_len: length of @ssid
1032 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1033 * @crypto: crypto settings
1034 * @privacy: the BSS uses privacy
1035 * @auth_type: Authentication type (algorithm)
1036 * @smps_mode: SMPS mode
1037 * @inactivity_timeout: time in seconds to determine station's inactivity.
1038 * @p2p_ctwindow: P2P CT Window
1039 * @p2p_opp_ps: P2P opportunistic PS
1040 * @acl: ACL configuration used by the drivers which has support for
1041 * MAC address based access control
1042 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1044 * @beacon_rate: bitrate to be used for beacons
1045 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1046 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1047 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1048 * @ht_required: stations must support HT
1049 * @vht_required: stations must support VHT
1050 * @twt_responder: Enable Target Wait Time
1051 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1052 * @he_obss_pd: OBSS Packet Detection settings
1053 * @he_bss_color: BSS Color settings
1055 struct cfg80211_ap_settings {
1056 struct cfg80211_chan_def chandef;
1058 struct cfg80211_beacon_data beacon;
1060 int beacon_interval, dtim_period;
1063 enum nl80211_hidden_ssid hidden_ssid;
1064 struct cfg80211_crypto_settings crypto;
1066 enum nl80211_auth_type auth_type;
1067 enum nl80211_smps_mode smps_mode;
1068 int inactivity_timeout;
1071 const struct cfg80211_acl_data *acl;
1073 struct cfg80211_bitrate_mask beacon_rate;
1075 const struct ieee80211_ht_cap *ht_cap;
1076 const struct ieee80211_vht_cap *vht_cap;
1077 const struct ieee80211_he_cap_elem *he_cap;
1078 bool ht_required, vht_required;
1081 struct ieee80211_he_obss_pd he_obss_pd;
1082 struct cfg80211_he_bss_color he_bss_color;
1086 * struct cfg80211_csa_settings - channel switch settings
1088 * Used for channel switch
1090 * @chandef: defines the channel to use after the switch
1091 * @beacon_csa: beacon data while performing the switch
1092 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1093 * @counter_offsets_presp: offsets of the counters within the probe response
1094 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1095 * @n_counter_offsets_presp: number of csa counters in the probe response
1096 * @beacon_after: beacon data to be used on the new channel
1097 * @radar_required: whether radar detection is required on the new channel
1098 * @block_tx: whether transmissions should be blocked while changing
1099 * @count: number of beacons until switch
1101 struct cfg80211_csa_settings {
1102 struct cfg80211_chan_def chandef;
1103 struct cfg80211_beacon_data beacon_csa;
1104 const u16 *counter_offsets_beacon;
1105 const u16 *counter_offsets_presp;
1106 unsigned int n_counter_offsets_beacon;
1107 unsigned int n_counter_offsets_presp;
1108 struct cfg80211_beacon_data beacon_after;
1109 bool radar_required;
1114 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1117 * struct iface_combination_params - input parameters for interface combinations
1119 * Used to pass interface combination parameters
1121 * @num_different_channels: the number of different channels we want
1122 * to use for verification
1123 * @radar_detect: a bitmap where each bit corresponds to a channel
1124 * width where radar detection is needed, as in the definition of
1125 * &struct ieee80211_iface_combination.@radar_detect_widths
1126 * @iftype_num: array with the number of interfaces of each interface
1127 * type. The index is the interface type as specified in &enum
1129 * @new_beacon_int: set this to the beacon interval of a new interface
1130 * that's not operating yet, if such is to be checked as part of
1133 struct iface_combination_params {
1134 int num_different_channels;
1136 int iftype_num[NUM_NL80211_IFTYPES];
1141 * enum station_parameters_apply_mask - station parameter values to apply
1142 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1143 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1144 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1146 * Not all station parameters have in-band "no change" signalling,
1147 * for those that don't these flags will are used.
1149 enum station_parameters_apply_mask {
1150 STATION_PARAM_APPLY_UAPSD = BIT(0),
1151 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1152 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1153 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1157 * struct sta_txpwr - station txpower configuration
1159 * Used to configure txpower for station.
1161 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1162 * is not provided, the default per-interface tx power setting will be
1163 * overriding. Driver should be picking up the lowest tx power, either tx
1164 * power per-interface or per-station.
1165 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1166 * will be less than or equal to specified from userspace, whereas if TPC
1167 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1168 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1173 enum nl80211_tx_power_setting type;
1177 * struct station_parameters - station parameters
1179 * Used to change and create a new station.
1181 * @vlan: vlan interface station should belong to
1182 * @supported_rates: supported rates in IEEE 802.11 format
1183 * (or NULL for no change)
1184 * @supported_rates_len: number of supported rates
1185 * @sta_flags_mask: station flags that changed
1186 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1187 * @sta_flags_set: station flags values
1188 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1189 * @listen_interval: listen interval or -1 for no change
1190 * @aid: AID or zero for no change
1191 * @vlan_id: VLAN ID for station (if nonzero)
1192 * @peer_aid: mesh peer AID or zero for no change
1193 * @plink_action: plink action to take
1194 * @plink_state: set the peer link state for a station
1195 * @ht_capa: HT capabilities of station
1196 * @vht_capa: VHT capabilities of station
1197 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1198 * as the AC bitmap in the QoS info field
1199 * @max_sp: max Service Period. same format as the MAX_SP in the
1200 * QoS info field (but already shifted down)
1201 * @sta_modify_mask: bitmap indicating which parameters changed
1202 * (for those that don't have a natural "no change" value),
1203 * see &enum station_parameters_apply_mask
1204 * @local_pm: local link-specific mesh power save mode (no change when set
1206 * @capability: station capability
1207 * @ext_capab: extended capabilities of the station
1208 * @ext_capab_len: number of extended capabilities
1209 * @supported_channels: supported channels in IEEE 802.11 format
1210 * @supported_channels_len: number of supported channels
1211 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1212 * @supported_oper_classes_len: number of supported operating classes
1213 * @opmode_notif: operating mode field from Operating Mode Notification
1214 * @opmode_notif_used: information if operating mode field is used
1215 * @support_p2p_ps: information if station supports P2P PS mechanism
1216 * @he_capa: HE capabilities of station
1217 * @he_capa_len: the length of the HE capabilities
1218 * @airtime_weight: airtime scheduler weight for this station
1220 struct station_parameters {
1221 const u8 *supported_rates;
1222 struct net_device *vlan;
1223 u32 sta_flags_mask, sta_flags_set;
1224 u32 sta_modify_mask;
1225 int listen_interval;
1229 u8 supported_rates_len;
1232 const struct ieee80211_ht_cap *ht_capa;
1233 const struct ieee80211_vht_cap *vht_capa;
1236 enum nl80211_mesh_power_mode local_pm;
1238 const u8 *ext_capab;
1240 const u8 *supported_channels;
1241 u8 supported_channels_len;
1242 const u8 *supported_oper_classes;
1243 u8 supported_oper_classes_len;
1245 bool opmode_notif_used;
1247 const struct ieee80211_he_cap_elem *he_capa;
1250 struct sta_txpwr txpwr;
1254 * struct station_del_parameters - station deletion parameters
1256 * Used to delete a station entry (or all stations).
1258 * @mac: MAC address of the station to remove or NULL to remove all stations
1259 * @subtype: Management frame subtype to use for indicating removal
1260 * (10 = Disassociation, 12 = Deauthentication)
1261 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1263 struct station_del_parameters {
1270 * enum cfg80211_station_type - the type of station being modified
1271 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1272 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1273 * unassociated (update properties for this type of client is permitted)
1274 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1275 * the AP MLME in the device
1276 * @CFG80211_STA_AP_STA: AP station on managed interface
1277 * @CFG80211_STA_IBSS: IBSS station
1278 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1279 * while TDLS setup is in progress, it moves out of this state when
1280 * being marked authorized; use this only if TDLS with external setup is
1282 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1283 * entry that is operating, has been marked authorized by userspace)
1284 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1285 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1287 enum cfg80211_station_type {
1288 CFG80211_STA_AP_CLIENT,
1289 CFG80211_STA_AP_CLIENT_UNASSOC,
1290 CFG80211_STA_AP_MLME_CLIENT,
1291 CFG80211_STA_AP_STA,
1293 CFG80211_STA_TDLS_PEER_SETUP,
1294 CFG80211_STA_TDLS_PEER_ACTIVE,
1295 CFG80211_STA_MESH_PEER_KERNEL,
1296 CFG80211_STA_MESH_PEER_USER,
1300 * cfg80211_check_station_change - validate parameter changes
1301 * @wiphy: the wiphy this operates on
1302 * @params: the new parameters for a station
1303 * @statype: the type of station being modified
1305 * Utility function for the @change_station driver method. Call this function
1306 * with the appropriate station type looking up the station (and checking that
1307 * it exists). It will verify whether the station change is acceptable, and if
1308 * not will return an error code. Note that it may modify the parameters for
1309 * backward compatibility reasons, so don't use them before calling this.
1311 int cfg80211_check_station_change(struct wiphy *wiphy,
1312 struct station_parameters *params,
1313 enum cfg80211_station_type statype);
1316 * enum station_info_rate_flags - bitrate info flags
1318 * Used by the driver to indicate the specific rate transmission
1319 * type for 802.11n transmissions.
1321 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1322 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1323 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1324 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1325 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1326 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1328 enum rate_info_flags {
1329 RATE_INFO_FLAGS_MCS = BIT(0),
1330 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1331 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1332 RATE_INFO_FLAGS_DMG = BIT(3),
1333 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1334 RATE_INFO_FLAGS_EDMG = BIT(5),
1338 * enum rate_info_bw - rate bandwidth information
1340 * Used by the driver to indicate the rate bandwidth.
1342 * @RATE_INFO_BW_5: 5 MHz bandwidth
1343 * @RATE_INFO_BW_10: 10 MHz bandwidth
1344 * @RATE_INFO_BW_20: 20 MHz bandwidth
1345 * @RATE_INFO_BW_40: 40 MHz bandwidth
1346 * @RATE_INFO_BW_80: 80 MHz bandwidth
1347 * @RATE_INFO_BW_160: 160 MHz bandwidth
1348 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1351 RATE_INFO_BW_20 = 0,
1361 * struct rate_info - bitrate information
1363 * Information about a receiving or transmitting bitrate
1365 * @flags: bitflag of flags from &enum rate_info_flags
1366 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1367 * @legacy: bitrate in 100kbit/s for 802.11abg
1368 * @nss: number of streams (VHT & HE only)
1369 * @bw: bandwidth (from &enum rate_info_bw)
1370 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1371 * @he_dcm: HE DCM value
1372 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1373 * only valid if bw is %RATE_INFO_BW_HE_RU)
1374 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1389 * enum station_info_rate_flags - bitrate info flags
1391 * Used by the driver to indicate the specific rate transmission
1392 * type for 802.11n transmissions.
1394 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1395 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1396 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1398 enum bss_param_flags {
1399 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1400 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1401 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1405 * struct sta_bss_parameters - BSS parameters for the attached station
1407 * Information about the currently associated BSS
1409 * @flags: bitflag of flags from &enum bss_param_flags
1410 * @dtim_period: DTIM period for the BSS
1411 * @beacon_interval: beacon interval
1413 struct sta_bss_parameters {
1416 u16 beacon_interval;
1420 * struct cfg80211_txq_stats - TXQ statistics for this TID
1421 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1422 * indicate the relevant values in this struct are filled
1423 * @backlog_bytes: total number of bytes currently backlogged
1424 * @backlog_packets: total number of packets currently backlogged
1425 * @flows: number of new flows seen
1426 * @drops: total number of packets dropped
1427 * @ecn_marks: total number of packets marked with ECN CE
1428 * @overlimit: number of drops due to queue space overflow
1429 * @overmemory: number of drops due to memory limit overflow
1430 * @collisions: number of hash collisions
1431 * @tx_bytes: total number of bytes dequeued
1432 * @tx_packets: total number of packets dequeued
1433 * @max_flows: maximum number of flows supported
1435 struct cfg80211_txq_stats {
1438 u32 backlog_packets;
1451 * struct cfg80211_tid_stats - per-TID statistics
1452 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1453 * indicate the relevant values in this struct are filled
1454 * @rx_msdu: number of received MSDUs
1455 * @tx_msdu: number of (attempted) transmitted MSDUs
1456 * @tx_msdu_retries: number of retries (not counting the first) for
1458 * @tx_msdu_failed: number of failed transmitted MSDUs
1459 * @txq_stats: TXQ statistics
1461 struct cfg80211_tid_stats {
1465 u64 tx_msdu_retries;
1467 struct cfg80211_txq_stats txq_stats;
1470 #define IEEE80211_MAX_CHAINS 4
1473 * struct station_info - station information
1475 * Station information filled by driver for get_station() and dump_station.
1477 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1478 * indicate the relevant values in this struct for them
1479 * @connected_time: time(in secs) since a station is last connected
1480 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1481 * @assoc_at: bootime (ns) of the last association
1482 * @rx_bytes: bytes (size of MPDUs) received from this station
1483 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1484 * @llid: mesh local link id
1485 * @plid: mesh peer link id
1486 * @plink_state: mesh peer link state
1487 * @signal: The signal strength, type depends on the wiphy's signal_type.
1488 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1489 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1490 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1491 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1492 * @chain_signal: per-chain signal strength of last received packet in dBm
1493 * @chain_signal_avg: per-chain signal strength average in dBm
1494 * @txrate: current unicast bitrate from this station
1495 * @rxrate: current unicast bitrate to this station
1496 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1497 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1498 * @tx_retries: cumulative retry counts (MPDUs)
1499 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1500 * @rx_dropped_misc: Dropped for un-specified reason.
1501 * @bss_param: current BSS parameters
1502 * @generation: generation number for nl80211 dumps.
1503 * This number should increase every time the list of stations
1504 * changes, i.e. when a station is added or removed, so that
1505 * userspace can tell whether it got a consistent snapshot.
1506 * @assoc_req_ies: IEs from (Re)Association Request.
1507 * This is used only when in AP mode with drivers that do not use
1508 * user space MLME/SME implementation. The information is provided for
1509 * the cfg80211_new_sta() calls to notify user space of the IEs.
1510 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1511 * @sta_flags: station flags mask & values
1512 * @beacon_loss_count: Number of times beacon loss event has triggered.
1513 * @t_offset: Time offset of the station relative to this host.
1514 * @local_pm: local mesh STA power save mode
1515 * @peer_pm: peer mesh STA power save mode
1516 * @nonpeer_pm: non-peer mesh STA power save mode
1517 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1518 * towards this station.
1519 * @rx_beacon: number of beacons received from this peer
1520 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1522 * @connected_to_gate: true if mesh STA has a path to mesh gate
1523 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1524 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1525 * @airtime_weight: current airtime scheduling weight
1526 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1527 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1528 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1529 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1530 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1532 * @rx_mpdu_count: number of MPDUs received from this station
1533 * @fcs_err_count: number of packets (MPDUs) received from this station with
1534 * an FCS error. This counter should be incremented only when TA of the
1535 * received packet with an FCS error matches the peer MAC address.
1536 * @airtime_link_metric: mesh airtime link metric.
1538 struct station_info {
1552 s8 chain_signal[IEEE80211_MAX_CHAINS];
1553 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1555 struct rate_info txrate;
1556 struct rate_info rxrate;
1561 u32 rx_dropped_misc;
1562 struct sta_bss_parameters bss_param;
1563 struct nl80211_sta_flag_update sta_flags;
1567 const u8 *assoc_req_ies;
1568 size_t assoc_req_ies_len;
1570 u32 beacon_loss_count;
1572 enum nl80211_mesh_power_mode local_pm;
1573 enum nl80211_mesh_power_mode peer_pm;
1574 enum nl80211_mesh_power_mode nonpeer_pm;
1576 u32 expected_throughput;
1581 u8 rx_beacon_signal_avg;
1582 u8 connected_to_gate;
1584 struct cfg80211_tid_stats *pertid;
1593 u32 airtime_link_metric;
1596 #if IS_ENABLED(CONFIG_CFG80211)
1598 * cfg80211_get_station - retrieve information about a given station
1599 * @dev: the device where the station is supposed to be connected to
1600 * @mac_addr: the mac address of the station of interest
1601 * @sinfo: pointer to the structure to fill with the information
1603 * Returns 0 on success and sinfo is filled with the available information
1604 * otherwise returns a negative error code and the content of sinfo has to be
1605 * considered undefined.
1607 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1608 struct station_info *sinfo);
1610 static inline int cfg80211_get_station(struct net_device *dev,
1612 struct station_info *sinfo)
1619 * enum monitor_flags - monitor flags
1621 * Monitor interface configuration flags. Note that these must be the bits
1622 * according to the nl80211 flags.
1624 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1625 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1626 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1627 * @MONITOR_FLAG_CONTROL: pass control frames
1628 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1629 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1630 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1632 enum monitor_flags {
1633 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1634 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1635 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1636 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1637 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1638 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1639 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1643 * enum mpath_info_flags - mesh path information flags
1645 * Used by the driver to indicate which info in &struct mpath_info it has filled
1646 * in during get_station() or dump_station().
1648 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1649 * @MPATH_INFO_SN: @sn filled
1650 * @MPATH_INFO_METRIC: @metric filled
1651 * @MPATH_INFO_EXPTIME: @exptime filled
1652 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1653 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1654 * @MPATH_INFO_FLAGS: @flags filled
1655 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1656 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1658 enum mpath_info_flags {
1659 MPATH_INFO_FRAME_QLEN = BIT(0),
1660 MPATH_INFO_SN = BIT(1),
1661 MPATH_INFO_METRIC = BIT(2),
1662 MPATH_INFO_EXPTIME = BIT(3),
1663 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1664 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1665 MPATH_INFO_FLAGS = BIT(6),
1666 MPATH_INFO_HOP_COUNT = BIT(7),
1667 MPATH_INFO_PATH_CHANGE = BIT(8),
1671 * struct mpath_info - mesh path information
1673 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1675 * @filled: bitfield of flags from &enum mpath_info_flags
1676 * @frame_qlen: number of queued frames for this destination
1677 * @sn: target sequence number
1678 * @metric: metric (cost) of this mesh path
1679 * @exptime: expiration time for the mesh path from now, in msecs
1680 * @flags: mesh path flags
1681 * @discovery_timeout: total mesh path discovery timeout, in msecs
1682 * @discovery_retries: mesh path discovery retries
1683 * @generation: generation number for nl80211 dumps.
1684 * This number should increase every time the list of mesh paths
1685 * changes, i.e. when a station is added or removed, so that
1686 * userspace can tell whether it got a consistent snapshot.
1687 * @hop_count: hops to destination
1688 * @path_change_count: total number of path changes to destination
1696 u32 discovery_timeout;
1697 u8 discovery_retries;
1700 u32 path_change_count;
1706 * struct bss_parameters - BSS parameters
1708 * Used to change BSS parameters (mainly for AP mode).
1710 * @use_cts_prot: Whether to use CTS protection
1711 * (0 = no, 1 = yes, -1 = do not change)
1712 * @use_short_preamble: Whether the use of short preambles is allowed
1713 * (0 = no, 1 = yes, -1 = do not change)
1714 * @use_short_slot_time: Whether the use of short slot time is allowed
1715 * (0 = no, 1 = yes, -1 = do not change)
1716 * @basic_rates: basic rates in IEEE 802.11 format
1717 * (or NULL for no change)
1718 * @basic_rates_len: number of basic rates
1719 * @ap_isolate: do not forward packets between connected stations
1720 * @ht_opmode: HT Operation mode
1721 * (u16 = opmode, -1 = do not change)
1722 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1723 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1725 struct bss_parameters {
1727 int use_short_preamble;
1728 int use_short_slot_time;
1729 const u8 *basic_rates;
1733 s8 p2p_ctwindow, p2p_opp_ps;
1737 * struct mesh_config - 802.11s mesh configuration
1739 * These parameters can be changed while the mesh is active.
1741 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1742 * by the Mesh Peering Open message
1743 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1744 * used by the Mesh Peering Open message
1745 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1746 * the mesh peering management to close a mesh peering
1747 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1749 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1750 * be sent to establish a new peer link instance in a mesh
1751 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1752 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1754 * @auto_open_plinks: whether we should automatically open peer links when we
1755 * detect compatible mesh peers
1756 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1757 * synchronize to for 11s default synchronization method
1758 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1759 * that an originator mesh STA can send to a particular path target
1760 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1761 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1762 * a path discovery in milliseconds
1763 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1764 * receiving a PREQ shall consider the forwarding information from the
1765 * root to be valid. (TU = time unit)
1766 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1767 * which a mesh STA can send only one action frame containing a PREQ
1769 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1770 * which a mesh STA can send only one Action frame containing a PERR
1772 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1773 * it takes for an HWMP information element to propagate across the mesh
1774 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1775 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1776 * announcements are transmitted
1777 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1778 * station has access to a broader network beyond the MBSS. (This is
1779 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1780 * only means that the station will announce others it's a mesh gate, but
1781 * not necessarily using the gate announcement protocol. Still keeping the
1782 * same nomenclature to be in sync with the spec)
1783 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1784 * entity (default is TRUE - forwarding entity)
1785 * @rssi_threshold: the threshold for average signal strength of candidate
1786 * station to establish a peer link
1787 * @ht_opmode: mesh HT protection mode
1789 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1790 * receiving a proactive PREQ shall consider the forwarding information to
1791 * the root mesh STA to be valid.
1793 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1794 * PREQs are transmitted.
1795 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1796 * during which a mesh STA can send only one Action frame containing
1797 * a PREQ element for root path confirmation.
1798 * @power_mode: The default mesh power save mode which will be the initial
1799 * setting for new peer links.
1800 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1801 * after transmitting its beacon.
1802 * @plink_timeout: If no tx activity is seen from a STA we've established
1803 * peering with for longer than this time (in seconds), then remove it
1804 * from the STA's list of peers. Default is 30 minutes.
1805 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1806 * connected to a mesh gate in mesh formation info. If false, the
1807 * value in mesh formation is determined by the presence of root paths
1808 * in the mesh path table
1810 struct mesh_config {
1811 u16 dot11MeshRetryTimeout;
1812 u16 dot11MeshConfirmTimeout;
1813 u16 dot11MeshHoldingTimeout;
1814 u16 dot11MeshMaxPeerLinks;
1815 u8 dot11MeshMaxRetries;
1818 bool auto_open_plinks;
1819 u32 dot11MeshNbrOffsetMaxNeighbor;
1820 u8 dot11MeshHWMPmaxPREQretries;
1821 u32 path_refresh_time;
1822 u16 min_discovery_timeout;
1823 u32 dot11MeshHWMPactivePathTimeout;
1824 u16 dot11MeshHWMPpreqMinInterval;
1825 u16 dot11MeshHWMPperrMinInterval;
1826 u16 dot11MeshHWMPnetDiameterTraversalTime;
1827 u8 dot11MeshHWMPRootMode;
1828 bool dot11MeshConnectedToMeshGate;
1829 u16 dot11MeshHWMPRannInterval;
1830 bool dot11MeshGateAnnouncementProtocol;
1831 bool dot11MeshForwarding;
1834 u32 dot11MeshHWMPactivePathToRootTimeout;
1835 u16 dot11MeshHWMProotInterval;
1836 u16 dot11MeshHWMPconfirmationInterval;
1837 enum nl80211_mesh_power_mode power_mode;
1838 u16 dot11MeshAwakeWindowDuration;
1843 * struct mesh_setup - 802.11s mesh setup configuration
1844 * @chandef: defines the channel to use
1845 * @mesh_id: the mesh ID
1846 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1847 * @sync_method: which synchronization method to use
1848 * @path_sel_proto: which path selection protocol to use
1849 * @path_metric: which metric to use
1850 * @auth_id: which authentication method this mesh is using
1851 * @ie: vendor information elements (optional)
1852 * @ie_len: length of vendor information elements
1853 * @is_authenticated: this mesh requires authentication
1854 * @is_secure: this mesh uses security
1855 * @user_mpm: userspace handles all MPM functions
1856 * @dtim_period: DTIM period to use
1857 * @beacon_interval: beacon interval to use
1858 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1859 * @basic_rates: basic rates to use when creating the mesh
1860 * @beacon_rate: bitrate to be used for beacons
1861 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1862 * changes the channel when a radar is detected. This is required
1863 * to operate on DFS channels.
1864 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1865 * port frames over NL80211 instead of the network interface.
1867 * These parameters are fixed when the mesh is created.
1870 struct cfg80211_chan_def chandef;
1879 bool is_authenticated;
1883 u16 beacon_interval;
1884 int mcast_rate[NUM_NL80211_BANDS];
1886 struct cfg80211_bitrate_mask beacon_rate;
1887 bool userspace_handles_dfs;
1888 bool control_port_over_nl80211;
1892 * struct ocb_setup - 802.11p OCB mode setup configuration
1893 * @chandef: defines the channel to use
1895 * These parameters are fixed when connecting to the network
1898 struct cfg80211_chan_def chandef;
1902 * struct ieee80211_txq_params - TX queue parameters
1903 * @ac: AC identifier
1904 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1905 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1907 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1909 * @aifs: Arbitration interframe space [0..255]
1911 struct ieee80211_txq_params {
1920 * DOC: Scanning and BSS list handling
1922 * The scanning process itself is fairly simple, but cfg80211 offers quite
1923 * a bit of helper functionality. To start a scan, the scan operation will
1924 * be invoked with a scan definition. This scan definition contains the
1925 * channels to scan, and the SSIDs to send probe requests for (including the
1926 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1927 * probe. Additionally, a scan request may contain extra information elements
1928 * that should be added to the probe request. The IEs are guaranteed to be
1929 * well-formed, and will not exceed the maximum length the driver advertised
1930 * in the wiphy structure.
1932 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1933 * it is responsible for maintaining the BSS list; the driver should not
1934 * maintain a list itself. For this notification, various functions exist.
1936 * Since drivers do not maintain a BSS list, there are also a number of
1937 * functions to search for a BSS and obtain information about it from the
1938 * BSS structure cfg80211 maintains. The BSS list is also made available
1943 * struct cfg80211_ssid - SSID description
1945 * @ssid_len: length of the ssid
1947 struct cfg80211_ssid {
1948 u8 ssid[IEEE80211_MAX_SSID_LEN];
1953 * struct cfg80211_scan_info - information about completed scan
1954 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1955 * wireless device that requested the scan is connected to. If this
1956 * information is not available, this field is left zero.
1957 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1958 * @aborted: set to true if the scan was aborted for any reason,
1959 * userspace will be notified of that
1961 struct cfg80211_scan_info {
1963 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1968 * struct cfg80211_scan_request - scan request description
1970 * @ssids: SSIDs to scan for (active scan only)
1971 * @n_ssids: number of SSIDs
1972 * @channels: channels to scan on.
1973 * @n_channels: total number of channels to scan
1974 * @scan_width: channel width for scanning
1975 * @ie: optional information element(s) to add into Probe Request or %NULL
1976 * @ie_len: length of ie in octets
1977 * @duration: how long to listen on each channel, in TUs. If
1978 * %duration_mandatory is not set, this is the maximum dwell time and
1979 * the actual dwell time may be shorter.
1980 * @duration_mandatory: if set, the scan duration must be as specified by the
1982 * @flags: bit field of flags controlling operation
1983 * @rates: bitmap of rates to advertise for each band
1984 * @wiphy: the wiphy this was for
1985 * @scan_start: time (in jiffies) when the scan started
1986 * @wdev: the wireless device to scan for
1987 * @info: (internal) information about completed scan
1988 * @notified: (internal) scan request was notified as done or aborted
1989 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1990 * @mac_addr: MAC address used with randomisation
1991 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1992 * are 0 in the mask should be randomised, bits that are 1 should
1993 * be taken from the @mac_addr
1994 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1996 struct cfg80211_scan_request {
1997 struct cfg80211_ssid *ssids;
2000 enum nl80211_bss_scan_width scan_width;
2004 bool duration_mandatory;
2007 u32 rates[NUM_NL80211_BANDS];
2009 struct wireless_dev *wdev;
2011 u8 mac_addr[ETH_ALEN] __aligned(2);
2012 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2013 u8 bssid[ETH_ALEN] __aligned(2);
2016 struct wiphy *wiphy;
2017 unsigned long scan_start;
2018 struct cfg80211_scan_info info;
2023 struct ieee80211_channel *channels[0];
2026 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2030 get_random_bytes(buf, ETH_ALEN);
2031 for (i = 0; i < ETH_ALEN; i++) {
2033 buf[i] |= addr[i] & mask[i];
2038 * struct cfg80211_match_set - sets of attributes to match
2040 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2041 * or no match (RSSI only)
2042 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2043 * or no match (RSSI only)
2044 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2045 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2046 * for filtering out scan results received. Drivers advertize this support
2047 * of band specific rssi based filtering through the feature capability
2048 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2049 * specific rssi thresholds take precedence over rssi_thold, if specified.
2050 * If not specified for any band, it will be assigned with rssi_thold of
2051 * corresponding matchset.
2053 struct cfg80211_match_set {
2054 struct cfg80211_ssid ssid;
2057 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2061 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2063 * @interval: interval between scheduled scan iterations. In seconds.
2064 * @iterations: number of scan iterations in this scan plan. Zero means
2066 * The last scan plan will always have this parameter set to zero,
2067 * all other scan plans will have a finite number of iterations.
2069 struct cfg80211_sched_scan_plan {
2075 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2077 * @band: band of BSS which should match for RSSI level adjustment.
2078 * @delta: value of RSSI level adjustment.
2080 struct cfg80211_bss_select_adjust {
2081 enum nl80211_band band;
2086 * struct cfg80211_sched_scan_request - scheduled scan request description
2088 * @reqid: identifies this request.
2089 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2090 * @n_ssids: number of SSIDs
2091 * @n_channels: total number of channels to scan
2092 * @scan_width: channel width for scanning
2093 * @ie: optional information element(s) to add into Probe Request or %NULL
2094 * @ie_len: length of ie in octets
2095 * @flags: bit field of flags controlling operation
2096 * @match_sets: sets of parameters to be matched for a scan result
2097 * entry to be considered valid and to be passed to the host
2098 * (others are filtered out).
2099 * If ommited, all results are passed.
2100 * @n_match_sets: number of match sets
2101 * @report_results: indicates that results were reported for this request
2102 * @wiphy: the wiphy this was for
2103 * @dev: the interface
2104 * @scan_start: start time of the scheduled scan
2105 * @channels: channels to scan
2106 * @min_rssi_thold: for drivers only supporting a single threshold, this
2107 * contains the minimum over all matchsets
2108 * @mac_addr: MAC address used with randomisation
2109 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2110 * are 0 in the mask should be randomised, bits that are 1 should
2111 * be taken from the @mac_addr
2112 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2113 * index must be executed first.
2114 * @n_scan_plans: number of scan plans, at least 1.
2115 * @rcu_head: RCU callback used to free the struct
2116 * @owner_nlportid: netlink portid of owner (if this should is a request
2117 * owned by a particular socket)
2118 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2119 * @list: for keeping list of requests.
2120 * @delay: delay in seconds to use before starting the first scan
2121 * cycle. The driver may ignore this parameter and start
2122 * immediately (or at any other time), if this feature is not
2124 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2125 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2126 * reporting in connected state to cases where a matching BSS is determined
2127 * to have better or slightly worse RSSI than the current connected BSS.
2128 * The relative RSSI threshold values are ignored in disconnected state.
2129 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2130 * to the specified band while deciding whether a better BSS is reported
2131 * using @relative_rssi. If delta is a negative number, the BSSs that
2132 * belong to the specified band will be penalized by delta dB in relative
2135 struct cfg80211_sched_scan_request {
2137 struct cfg80211_ssid *ssids;
2140 enum nl80211_bss_scan_width scan_width;
2144 struct cfg80211_match_set *match_sets;
2148 struct cfg80211_sched_scan_plan *scan_plans;
2151 u8 mac_addr[ETH_ALEN] __aligned(2);
2152 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2154 bool relative_rssi_set;
2156 struct cfg80211_bss_select_adjust rssi_adjust;
2159 struct wiphy *wiphy;
2160 struct net_device *dev;
2161 unsigned long scan_start;
2162 bool report_results;
2163 struct rcu_head rcu_head;
2166 struct list_head list;
2169 struct ieee80211_channel *channels[0];
2173 * enum cfg80211_signal_type - signal type
2175 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2176 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2177 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2179 enum cfg80211_signal_type {
2180 CFG80211_SIGNAL_TYPE_NONE,
2181 CFG80211_SIGNAL_TYPE_MBM,
2182 CFG80211_SIGNAL_TYPE_UNSPEC,
2186 * struct cfg80211_inform_bss - BSS inform data
2187 * @chan: channel the frame was received on
2188 * @scan_width: scan width that was used
2189 * @signal: signal strength value, according to the wiphy's
2191 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2192 * received; should match the time when the frame was actually
2193 * received by the device (not just by the host, in case it was
2194 * buffered on the device) and be accurate to about 10ms.
2195 * If the frame isn't buffered, just passing the return value of
2196 * ktime_get_boottime_ns() is likely appropriate.
2197 * @parent_tsf: the time at the start of reception of the first octet of the
2198 * timestamp field of the frame. The time is the TSF of the BSS specified
2200 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2201 * the BSS that requested the scan in which the beacon/probe was received.
2202 * @chains: bitmask for filled values in @chain_signal.
2203 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2205 struct cfg80211_inform_bss {
2206 struct ieee80211_channel *chan;
2207 enum nl80211_bss_scan_width scan_width;
2211 u8 parent_bssid[ETH_ALEN] __aligned(2);
2213 s8 chain_signal[IEEE80211_MAX_CHAINS];
2217 * struct cfg80211_bss_ies - BSS entry IE data
2218 * @tsf: TSF contained in the frame that carried these IEs
2219 * @rcu_head: internal use, for freeing
2220 * @len: length of the IEs
2221 * @from_beacon: these IEs are known to come from a beacon
2224 struct cfg80211_bss_ies {
2226 struct rcu_head rcu_head;
2233 * struct cfg80211_bss - BSS description
2235 * This structure describes a BSS (which may also be a mesh network)
2236 * for use in scan results and similar.
2238 * @channel: channel this BSS is on
2239 * @scan_width: width of the control channel
2240 * @bssid: BSSID of the BSS
2241 * @beacon_interval: the beacon interval as from the frame
2242 * @capability: the capability field in host byte order
2243 * @ies: the information elements (Note that there is no guarantee that these
2244 * are well-formed!); this is a pointer to either the beacon_ies or
2245 * proberesp_ies depending on whether Probe Response frame has been
2246 * received. It is always non-%NULL.
2247 * @beacon_ies: the information elements from the last Beacon frame
2248 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2249 * own the beacon_ies, but they're just pointers to the ones from the
2250 * @hidden_beacon_bss struct)
2251 * @proberesp_ies: the information elements from the last Probe Response frame
2252 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2253 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2254 * that holds the beacon data. @beacon_ies is still valid, of course, and
2255 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2256 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2257 * non-transmitted one (multi-BSSID support)
2258 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2259 * (multi-BSSID support)
2260 * @signal: signal strength value (type depends on the wiphy's signal_type)
2261 * @chains: bitmask for filled values in @chain_signal.
2262 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2263 * @bssid_index: index in the multiple BSS set
2264 * @max_bssid_indicator: max number of members in the BSS set
2265 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2267 struct cfg80211_bss {
2268 struct ieee80211_channel *channel;
2269 enum nl80211_bss_scan_width scan_width;
2271 const struct cfg80211_bss_ies __rcu *ies;
2272 const struct cfg80211_bss_ies __rcu *beacon_ies;
2273 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2275 struct cfg80211_bss *hidden_beacon_bss;
2276 struct cfg80211_bss *transmitted_bss;
2277 struct list_head nontrans_list;
2281 u16 beacon_interval;
2286 s8 chain_signal[IEEE80211_MAX_CHAINS];
2289 u8 max_bssid_indicator;
2291 u8 priv[0] __aligned(sizeof(void *));
2295 * ieee80211_bss_get_elem - find element with given ID
2296 * @bss: the bss to search
2297 * @id: the element ID
2299 * Note that the return value is an RCU-protected pointer, so
2300 * rcu_read_lock() must be held when calling this function.
2301 * Return: %NULL if not found.
2303 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2306 * ieee80211_bss_get_ie - find IE with given ID
2307 * @bss: the bss to search
2308 * @id: the element ID
2310 * Note that the return value is an RCU-protected pointer, so
2311 * rcu_read_lock() must be held when calling this function.
2312 * Return: %NULL if not found.
2314 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2316 return (void *)ieee80211_bss_get_elem(bss, id);
2321 * struct cfg80211_auth_request - Authentication request data
2323 * This structure provides information needed to complete IEEE 802.11
2326 * @bss: The BSS to authenticate with, the callee must obtain a reference
2327 * to it if it needs to keep it.
2328 * @auth_type: Authentication type (algorithm)
2329 * @ie: Extra IEs to add to Authentication frame or %NULL
2330 * @ie_len: Length of ie buffer in octets
2331 * @key_len: length of WEP key for shared key authentication
2332 * @key_idx: index of WEP key for shared key authentication
2333 * @key: WEP key for shared key authentication
2334 * @auth_data: Fields and elements in Authentication frames. This contains
2335 * the authentication frame body (non-IE and IE data), excluding the
2336 * Authentication algorithm number, i.e., starting at the Authentication
2337 * transaction sequence number field.
2338 * @auth_data_len: Length of auth_data buffer in octets
2340 struct cfg80211_auth_request {
2341 struct cfg80211_bss *bss;
2344 enum nl80211_auth_type auth_type;
2346 u8 key_len, key_idx;
2347 const u8 *auth_data;
2348 size_t auth_data_len;
2352 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2354 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2355 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2356 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2357 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2358 * authentication capability. Drivers can offload authentication to
2359 * userspace if this flag is set. Only applicable for cfg80211_connect()
2360 * request (connect callback).
2362 enum cfg80211_assoc_req_flags {
2363 ASSOC_REQ_DISABLE_HT = BIT(0),
2364 ASSOC_REQ_DISABLE_VHT = BIT(1),
2365 ASSOC_REQ_USE_RRM = BIT(2),
2366 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2370 * struct cfg80211_assoc_request - (Re)Association request data
2372 * This structure provides information needed to complete IEEE 802.11
2374 * @bss: The BSS to associate with. If the call is successful the driver is
2375 * given a reference that it must give back to cfg80211_send_rx_assoc()
2376 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2377 * association requests while already associating must be rejected.
2378 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2379 * @ie_len: Length of ie buffer in octets
2380 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2381 * @crypto: crypto settings
2382 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2383 * to indicate a request to reassociate within the ESS instead of a request
2384 * do the initial association with the ESS. When included, this is set to
2385 * the BSSID of the current association, i.e., to the value that is
2386 * included in the Current AP address field of the Reassociation Request
2388 * @flags: See &enum cfg80211_assoc_req_flags
2389 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2390 * will be used in ht_capa. Un-supported values will be ignored.
2391 * @ht_capa_mask: The bits of ht_capa which are to be used.
2392 * @vht_capa: VHT capability override
2393 * @vht_capa_mask: VHT capability mask indicating which fields to use
2394 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2395 * %NULL if FILS is not used.
2396 * @fils_kek_len: Length of fils_kek in octets
2397 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2398 * Request/Response frame or %NULL if FILS is not used. This field starts
2399 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2401 struct cfg80211_assoc_request {
2402 struct cfg80211_bss *bss;
2403 const u8 *ie, *prev_bssid;
2405 struct cfg80211_crypto_settings crypto;
2408 struct ieee80211_ht_cap ht_capa;
2409 struct ieee80211_ht_cap ht_capa_mask;
2410 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2412 size_t fils_kek_len;
2413 const u8 *fils_nonces;
2417 * struct cfg80211_deauth_request - Deauthentication request data
2419 * This structure provides information needed to complete IEEE 802.11
2422 * @bssid: the BSSID of the BSS to deauthenticate from
2423 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2424 * @ie_len: Length of ie buffer in octets
2425 * @reason_code: The reason code for the deauthentication
2426 * @local_state_change: if set, change local state only and
2427 * do not set a deauth frame
2429 struct cfg80211_deauth_request {
2434 bool local_state_change;
2438 * struct cfg80211_disassoc_request - Disassociation request data
2440 * This structure provides information needed to complete IEEE 802.11
2443 * @bss: the BSS to disassociate from
2444 * @ie: Extra IEs to add to Disassociation frame or %NULL
2445 * @ie_len: Length of ie buffer in octets
2446 * @reason_code: The reason code for the disassociation
2447 * @local_state_change: This is a request for a local state only, i.e., no
2448 * Disassociation frame is to be transmitted.
2450 struct cfg80211_disassoc_request {
2451 struct cfg80211_bss *bss;
2455 bool local_state_change;
2459 * struct cfg80211_ibss_params - IBSS parameters
2461 * This structure defines the IBSS parameters for the join_ibss()
2464 * @ssid: The SSID, will always be non-null.
2465 * @ssid_len: The length of the SSID, will always be non-zero.
2466 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2467 * search for IBSSs with a different BSSID.
2468 * @chandef: defines the channel to use if no other IBSS to join can be found
2469 * @channel_fixed: The channel should be fixed -- do not search for
2470 * IBSSs to join on other channels.
2471 * @ie: information element(s) to include in the beacon
2472 * @ie_len: length of that
2473 * @beacon_interval: beacon interval to use
2474 * @privacy: this is a protected network, keys will be configured
2476 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2477 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2478 * required to assume that the port is unauthorized until authorized by
2479 * user space. Otherwise, port is marked authorized by default.
2480 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2481 * port frames over NL80211 instead of the network interface.
2482 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2483 * changes the channel when a radar is detected. This is required
2484 * to operate on DFS channels.
2485 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2486 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2487 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2488 * will be used in ht_capa. Un-supported values will be ignored.
2489 * @ht_capa_mask: The bits of ht_capa which are to be used.
2490 * @wep_keys: static WEP keys, if not NULL points to an array of
2491 * CFG80211_MAX_WEP_KEYS WEP keys
2492 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2494 struct cfg80211_ibss_params {
2497 struct cfg80211_chan_def chandef;
2499 u8 ssid_len, ie_len;
2500 u16 beacon_interval;
2505 bool control_port_over_nl80211;
2506 bool userspace_handles_dfs;
2507 int mcast_rate[NUM_NL80211_BANDS];
2508 struct ieee80211_ht_cap ht_capa;
2509 struct ieee80211_ht_cap ht_capa_mask;
2510 struct key_params *wep_keys;
2515 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2517 * @behaviour: requested BSS selection behaviour.
2518 * @param: parameters for requestion behaviour.
2519 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2520 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2522 struct cfg80211_bss_selection {
2523 enum nl80211_bss_select_attr behaviour;
2525 enum nl80211_band band_pref;
2526 struct cfg80211_bss_select_adjust adjust;
2531 * struct cfg80211_connect_params - Connection parameters
2533 * This structure provides information needed to complete IEEE 802.11
2534 * authentication and association.
2536 * @channel: The channel to use or %NULL if not specified (auto-select based
2538 * @channel_hint: The channel of the recommended BSS for initial connection or
2539 * %NULL if not specified
2540 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2542 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2543 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2544 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2547 * @ssid_len: Length of ssid in octets
2548 * @auth_type: Authentication type (algorithm)
2549 * @ie: IEs for association request
2550 * @ie_len: Length of assoc_ie in octets
2551 * @privacy: indicates whether privacy-enabled APs should be used
2552 * @mfp: indicate whether management frame protection is used
2553 * @crypto: crypto settings
2554 * @key_len: length of WEP key for shared key authentication
2555 * @key_idx: index of WEP key for shared key authentication
2556 * @key: WEP key for shared key authentication
2557 * @flags: See &enum cfg80211_assoc_req_flags
2558 * @bg_scan_period: Background scan period in seconds
2559 * or -1 to indicate that default value is to be used.
2560 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2561 * will be used in ht_capa. Un-supported values will be ignored.
2562 * @ht_capa_mask: The bits of ht_capa which are to be used.
2563 * @vht_capa: VHT Capability overrides
2564 * @vht_capa_mask: The bits of vht_capa which are to be used.
2565 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2567 * @bss_select: criteria to be used for BSS selection.
2568 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2569 * to indicate a request to reassociate within the ESS instead of a request
2570 * do the initial association with the ESS. When included, this is set to
2571 * the BSSID of the current association, i.e., to the value that is
2572 * included in the Current AP address field of the Reassociation Request
2574 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2575 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2577 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2578 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2579 * %NULL if not specified. This specifies the domain name of ER server and
2580 * is used to construct FILS wrapped data IE.
2581 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2582 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2583 * messages. This is also used to construct FILS wrapped data IE.
2584 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2585 * keys in FILS or %NULL if not specified.
2586 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2587 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2588 * offload of 4-way handshake.
2589 * @edmg: define the EDMG channels.
2590 * This may specify multiple channels and bonding options for the driver
2591 * to choose from, based on BSS configuration.
2593 struct cfg80211_connect_params {
2594 struct ieee80211_channel *channel;
2595 struct ieee80211_channel *channel_hint;
2597 const u8 *bssid_hint;
2600 enum nl80211_auth_type auth_type;
2604 enum nl80211_mfp mfp;
2605 struct cfg80211_crypto_settings crypto;
2607 u8 key_len, key_idx;
2610 struct ieee80211_ht_cap ht_capa;
2611 struct ieee80211_ht_cap ht_capa_mask;
2612 struct ieee80211_vht_cap vht_capa;
2613 struct ieee80211_vht_cap vht_capa_mask;
2615 struct cfg80211_bss_selection bss_select;
2616 const u8 *prev_bssid;
2617 const u8 *fils_erp_username;
2618 size_t fils_erp_username_len;
2619 const u8 *fils_erp_realm;
2620 size_t fils_erp_realm_len;
2621 u16 fils_erp_next_seq_num;
2622 const u8 *fils_erp_rrk;
2623 size_t fils_erp_rrk_len;
2625 struct ieee80211_edmg edmg;
2629 * enum cfg80211_connect_params_changed - Connection parameters being updated
2631 * This enum provides information of all connect parameters that
2632 * have to be updated as part of update_connect_params() call.
2634 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2635 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2636 * username, erp sequence number and rrk) are updated
2637 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2639 enum cfg80211_connect_params_changed {
2640 UPDATE_ASSOC_IES = BIT(0),
2641 UPDATE_FILS_ERP_INFO = BIT(1),
2642 UPDATE_AUTH_TYPE = BIT(2),
2646 * enum wiphy_params_flags - set_wiphy_params bitfield values
2647 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2648 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2649 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2650 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2651 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2652 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2653 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2654 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2655 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2657 enum wiphy_params_flags {
2658 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2659 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2660 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2661 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2662 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2663 WIPHY_PARAM_DYN_ACK = 1 << 5,
2664 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2665 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2666 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2669 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2671 /* The per TXQ device queue limit in airtime */
2672 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2673 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2675 /* The per interface airtime threshold to switch to lower queue limit */
2676 #define IEEE80211_AQL_THRESHOLD 24000
2679 * struct cfg80211_pmksa - PMK Security Association
2681 * This structure is passed to the set/del_pmksa() method for PMKSA
2684 * @bssid: The AP's BSSID (may be %NULL).
2685 * @pmkid: The identifier to refer a PMKSA.
2686 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2687 * derivation by a FILS STA. Otherwise, %NULL.
2688 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2689 * the hash algorithm used to generate this.
2690 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2691 * cache identifier (may be %NULL).
2692 * @ssid_len: Length of the @ssid in octets.
2693 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2694 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2697 struct cfg80211_pmksa {
2708 * struct cfg80211_pkt_pattern - packet pattern
2709 * @mask: bitmask where to match pattern and where to ignore bytes,
2710 * one bit per byte, in same format as nl80211
2711 * @pattern: bytes to match where bitmask is 1
2712 * @pattern_len: length of pattern (in bytes)
2713 * @pkt_offset: packet offset (in bytes)
2715 * Internal note: @mask and @pattern are allocated in one chunk of
2716 * memory, free @mask only!
2718 struct cfg80211_pkt_pattern {
2719 const u8 *mask, *pattern;
2725 * struct cfg80211_wowlan_tcp - TCP connection parameters
2727 * @sock: (internal) socket for source port allocation
2728 * @src: source IP address
2729 * @dst: destination IP address
2730 * @dst_mac: destination MAC address
2731 * @src_port: source port
2732 * @dst_port: destination port
2733 * @payload_len: data payload length
2734 * @payload: data payload buffer
2735 * @payload_seq: payload sequence stamping configuration
2736 * @data_interval: interval at which to send data packets
2737 * @wake_len: wakeup payload match length
2738 * @wake_data: wakeup payload match data
2739 * @wake_mask: wakeup payload match mask
2740 * @tokens_size: length of the tokens buffer
2741 * @payload_tok: payload token usage configuration
2743 struct cfg80211_wowlan_tcp {
2744 struct socket *sock;
2746 u16 src_port, dst_port;
2747 u8 dst_mac[ETH_ALEN];
2750 struct nl80211_wowlan_tcp_data_seq payload_seq;
2753 const u8 *wake_data, *wake_mask;
2755 /* must be last, variable member */
2756 struct nl80211_wowlan_tcp_data_token payload_tok;
2760 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2762 * This structure defines the enabled WoWLAN triggers for the device.
2763 * @any: wake up on any activity -- special trigger if device continues
2764 * operating as normal during suspend
2765 * @disconnect: wake up if getting disconnected
2766 * @magic_pkt: wake up on receiving magic packet
2767 * @patterns: wake up on receiving packet matching a pattern
2768 * @n_patterns: number of patterns
2769 * @gtk_rekey_failure: wake up on GTK rekey failure
2770 * @eap_identity_req: wake up on EAP identity request packet
2771 * @four_way_handshake: wake up on 4-way handshake
2772 * @rfkill_release: wake up when rfkill is released
2773 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2774 * NULL if not configured.
2775 * @nd_config: configuration for the scan to be used for net detect wake.
2777 struct cfg80211_wowlan {
2778 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2779 eap_identity_req, four_way_handshake,
2781 struct cfg80211_pkt_pattern *patterns;
2782 struct cfg80211_wowlan_tcp *tcp;
2784 struct cfg80211_sched_scan_request *nd_config;
2788 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2790 * This structure defines coalesce rule for the device.
2791 * @delay: maximum coalescing delay in msecs.
2792 * @condition: condition for packet coalescence.
2793 * see &enum nl80211_coalesce_condition.
2794 * @patterns: array of packet patterns
2795 * @n_patterns: number of patterns
2797 struct cfg80211_coalesce_rules {
2799 enum nl80211_coalesce_condition condition;
2800 struct cfg80211_pkt_pattern *patterns;
2805 * struct cfg80211_coalesce - Packet coalescing settings
2807 * This structure defines coalescing settings.
2808 * @rules: array of coalesce rules
2809 * @n_rules: number of rules
2811 struct cfg80211_coalesce {
2812 struct cfg80211_coalesce_rules *rules;
2817 * struct cfg80211_wowlan_nd_match - information about the match
2819 * @ssid: SSID of the match that triggered the wake up
2820 * @n_channels: Number of channels where the match occurred. This
2821 * value may be zero if the driver can't report the channels.
2822 * @channels: center frequencies of the channels where a match
2825 struct cfg80211_wowlan_nd_match {
2826 struct cfg80211_ssid ssid;
2832 * struct cfg80211_wowlan_nd_info - net detect wake up information
2834 * @n_matches: Number of match information instances provided in
2835 * @matches. This value may be zero if the driver can't provide
2836 * match information.
2837 * @matches: Array of pointers to matches containing information about
2838 * the matches that triggered the wake up.
2840 struct cfg80211_wowlan_nd_info {
2842 struct cfg80211_wowlan_nd_match *matches[];
2846 * struct cfg80211_wowlan_wakeup - wakeup report
2847 * @disconnect: woke up by getting disconnected
2848 * @magic_pkt: woke up by receiving magic packet
2849 * @gtk_rekey_failure: woke up by GTK rekey failure
2850 * @eap_identity_req: woke up by EAP identity request packet
2851 * @four_way_handshake: woke up by 4-way handshake
2852 * @rfkill_release: woke up by rfkill being released
2853 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2854 * @packet_present_len: copied wakeup packet data
2855 * @packet_len: original wakeup packet length
2856 * @packet: The packet causing the wakeup, if any.
2857 * @packet_80211: For pattern match, magic packet and other data
2858 * frame triggers an 802.3 frame should be reported, for
2859 * disconnect due to deauth 802.11 frame. This indicates which
2861 * @tcp_match: TCP wakeup packet received
2862 * @tcp_connlost: TCP connection lost or failed to establish
2863 * @tcp_nomoretokens: TCP data ran out of tokens
2864 * @net_detect: if not %NULL, woke up because of net detect
2866 struct cfg80211_wowlan_wakeup {
2867 bool disconnect, magic_pkt, gtk_rekey_failure,
2868 eap_identity_req, four_way_handshake,
2869 rfkill_release, packet_80211,
2870 tcp_match, tcp_connlost, tcp_nomoretokens;
2872 u32 packet_present_len, packet_len;
2874 struct cfg80211_wowlan_nd_info *net_detect;
2878 * struct cfg80211_gtk_rekey_data - rekey data
2879 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2880 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2881 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2883 struct cfg80211_gtk_rekey_data {
2884 const u8 *kek, *kck, *replay_ctr;
2888 * struct cfg80211_update_ft_ies_params - FT IE Information
2890 * This structure provides information needed to update the fast transition IE
2892 * @md: The Mobility Domain ID, 2 Octet value
2893 * @ie: Fast Transition IEs
2894 * @ie_len: Length of ft_ie in octets
2896 struct cfg80211_update_ft_ies_params {
2903 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2905 * This structure provides information needed to transmit a mgmt frame
2907 * @chan: channel to use
2908 * @offchan: indicates wether off channel operation is required
2909 * @wait: duration for ROC
2910 * @buf: buffer to transmit
2911 * @len: buffer length
2912 * @no_cck: don't use cck rates for this frame
2913 * @dont_wait_for_ack: tells the low level not to wait for an ack
2914 * @n_csa_offsets: length of csa_offsets array
2915 * @csa_offsets: array of all the csa offsets in the frame
2917 struct cfg80211_mgmt_tx_params {
2918 struct ieee80211_channel *chan;
2924 bool dont_wait_for_ack;
2926 const u16 *csa_offsets;
2930 * struct cfg80211_dscp_exception - DSCP exception
2932 * @dscp: DSCP value that does not adhere to the user priority range definition
2933 * @up: user priority value to which the corresponding DSCP value belongs
2935 struct cfg80211_dscp_exception {
2941 * struct cfg80211_dscp_range - DSCP range definition for user priority
2943 * @low: lowest DSCP value of this user priority range, inclusive
2944 * @high: highest DSCP value of this user priority range, inclusive
2946 struct cfg80211_dscp_range {
2951 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2952 #define IEEE80211_QOS_MAP_MAX_EX 21
2953 #define IEEE80211_QOS_MAP_LEN_MIN 16
2954 #define IEEE80211_QOS_MAP_LEN_MAX \
2955 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2958 * struct cfg80211_qos_map - QoS Map Information
2960 * This struct defines the Interworking QoS map setting for DSCP values
2962 * @num_des: number of DSCP exceptions (0..21)
2963 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2964 * the user priority DSCP range definition
2965 * @up: DSCP range definition for a particular user priority
2967 struct cfg80211_qos_map {
2969 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2970 struct cfg80211_dscp_range up[8];
2974 * struct cfg80211_nan_conf - NAN configuration
2976 * This struct defines NAN configuration parameters
2978 * @master_pref: master preference (1 - 255)
2979 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2980 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2981 * (i.e. BIT(NL80211_BAND_2GHZ)).
2983 struct cfg80211_nan_conf {
2989 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2992 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2993 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2995 enum cfg80211_nan_conf_changes {
2996 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2997 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3001 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3003 * @filter: the content of the filter
3004 * @len: the length of the filter
3006 struct cfg80211_nan_func_filter {
3012 * struct cfg80211_nan_func - a NAN function
3014 * @type: &enum nl80211_nan_function_type
3015 * @service_id: the service ID of the function
3016 * @publish_type: &nl80211_nan_publish_type
3017 * @close_range: if true, the range should be limited. Threshold is
3018 * implementation specific.
3019 * @publish_bcast: if true, the solicited publish should be broadcasted
3020 * @subscribe_active: if true, the subscribe is active
3021 * @followup_id: the instance ID for follow up
3022 * @followup_reqid: the requestor instance ID for follow up
3023 * @followup_dest: MAC address of the recipient of the follow up
3024 * @ttl: time to live counter in DW.
3025 * @serv_spec_info: Service Specific Info
3026 * @serv_spec_info_len: Service Specific Info length
3027 * @srf_include: if true, SRF is inclusive
3028 * @srf_bf: Bloom Filter
3029 * @srf_bf_len: Bloom Filter length
3030 * @srf_bf_idx: Bloom Filter index
3031 * @srf_macs: SRF MAC addresses
3032 * @srf_num_macs: number of MAC addresses in SRF
3033 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3034 * @tx_filters: filters that should be transmitted in the SDF.
3035 * @num_rx_filters: length of &rx_filters.
3036 * @num_tx_filters: length of &tx_filters.
3037 * @instance_id: driver allocated id of the function.
3038 * @cookie: unique NAN function identifier.
3040 struct cfg80211_nan_func {
3041 enum nl80211_nan_function_type type;
3042 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3046 bool subscribe_active;
3049 struct mac_address followup_dest;
3051 const u8 *serv_spec_info;
3052 u8 serv_spec_info_len;
3057 struct mac_address *srf_macs;
3059 struct cfg80211_nan_func_filter *rx_filters;
3060 struct cfg80211_nan_func_filter *tx_filters;
3068 * struct cfg80211_pmk_conf - PMK configuration
3070 * @aa: authenticator address
3071 * @pmk_len: PMK length in bytes.
3072 * @pmk: the PMK material
3073 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3074 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3077 struct cfg80211_pmk_conf {
3081 const u8 *pmk_r0_name;
3085 * struct cfg80211_external_auth_params - Trigger External authentication.
3087 * Commonly used across the external auth request and event interfaces.
3089 * @action: action type / trigger for external authentication. Only significant
3090 * for the authentication request event interface (driver to user space).
3091 * @bssid: BSSID of the peer with which the authentication has
3092 * to happen. Used by both the authentication request event and
3093 * authentication response command interface.
3094 * @ssid: SSID of the AP. Used by both the authentication request event and
3095 * authentication response command interface.
3096 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3097 * authentication request event interface.
3098 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3099 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3100 * the real status code for failures. Used only for the authentication
3101 * response command interface (user space to driver).
3102 * @pmkid: The identifier to refer a PMKSA.
3104 struct cfg80211_external_auth_params {
3105 enum nl80211_external_auth_action action;
3106 u8 bssid[ETH_ALEN] __aligned(2);
3107 struct cfg80211_ssid ssid;
3108 unsigned int key_mgmt_suite;
3114 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3116 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3117 * indicate the relevant values in this struct for them
3118 * @success_num: number of FTM sessions in which all frames were successfully
3120 * @partial_num: number of FTM sessions in which part of frames were
3121 * successfully answered
3122 * @failed_num: number of failed FTM sessions
3123 * @asap_num: number of ASAP FTM sessions
3124 * @non_asap_num: number of non-ASAP FTM sessions
3125 * @total_duration_ms: total sessions durations - gives an indication
3126 * of how much time the responder was busy
3127 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3128 * initiators that didn't finish successfully the negotiation phase with
3130 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3131 * for a new scheduling although it already has scheduled FTM slot
3132 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3134 struct cfg80211_ftm_responder_stats {
3141 u64 total_duration_ms;
3142 u32 unknown_triggers_num;
3143 u32 reschedule_requests_num;
3144 u32 out_of_window_triggers_num;
3148 * struct cfg80211_pmsr_ftm_result - FTM result
3149 * @failure_reason: if this measurement failed (PMSR status is
3150 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3151 * reason than just "failure"
3152 * @burst_index: if reporting partial results, this is the index
3153 * in [0 .. num_bursts-1] of the burst that's being reported
3154 * @num_ftmr_attempts: number of FTM request frames transmitted
3155 * @num_ftmr_successes: number of FTM request frames acked
3156 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3157 * fill this to indicate in how many seconds a retry is deemed possible
3159 * @num_bursts_exp: actual number of bursts exponent negotiated
3160 * @burst_duration: actual burst duration negotiated
3161 * @ftms_per_burst: actual FTMs per burst negotiated
3162 * @lci_len: length of LCI information (if present)
3163 * @civicloc_len: length of civic location information (if present)
3164 * @lci: LCI data (may be %NULL)
3165 * @civicloc: civic location data (may be %NULL)
3166 * @rssi_avg: average RSSI over FTM action frames reported
3167 * @rssi_spread: spread of the RSSI over FTM action frames reported
3168 * @tx_rate: bitrate for transmitted FTM action frame response
3169 * @rx_rate: bitrate of received FTM action frame
3170 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3171 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3172 * the square root of the variance)
3173 * @rtt_spread: spread of the RTTs measured
3174 * @dist_avg: average of distances (mm) measured
3175 * (must have either this or @rtt_avg)
3176 * @dist_variance: variance of distances measured (see also @rtt_variance)
3177 * @dist_spread: spread of distances measured (see also @rtt_spread)
3178 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3179 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3180 * @rssi_avg_valid: @rssi_avg is valid
3181 * @rssi_spread_valid: @rssi_spread is valid
3182 * @tx_rate_valid: @tx_rate is valid
3183 * @rx_rate_valid: @rx_rate is valid
3184 * @rtt_avg_valid: @rtt_avg is valid
3185 * @rtt_variance_valid: @rtt_variance is valid
3186 * @rtt_spread_valid: @rtt_spread is valid
3187 * @dist_avg_valid: @dist_avg is valid
3188 * @dist_variance_valid: @dist_variance is valid
3189 * @dist_spread_valid: @dist_spread is valid
3191 struct cfg80211_pmsr_ftm_result {
3194 unsigned int lci_len;
3195 unsigned int civicloc_len;
3196 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3197 u32 num_ftmr_attempts, num_ftmr_successes;
3205 struct rate_info tx_rate, rx_rate;
3213 u16 num_ftmr_attempts_valid:1,
3214 num_ftmr_successes_valid:1,
3216 rssi_spread_valid:1,
3220 rtt_variance_valid:1,
3223 dist_variance_valid:1,
3224 dist_spread_valid:1;
3228 * struct cfg80211_pmsr_result - peer measurement result
3229 * @addr: address of the peer
3230 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3231 * measurement was made)
3232 * @ap_tsf: AP's TSF at measurement time
3233 * @status: status of the measurement
3234 * @final: if reporting partial results, mark this as the last one; if not
3235 * reporting partial results always set this flag
3236 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3237 * @type: type of the measurement reported, note that we only support reporting
3238 * one type at a time, but you can report multiple results separately and
3239 * they're all aggregated for userspace.
3241 struct cfg80211_pmsr_result {
3242 u64 host_time, ap_tsf;
3243 enum nl80211_peer_measurement_status status;
3250 enum nl80211_peer_measurement_type type;
3253 struct cfg80211_pmsr_ftm_result ftm;
3258 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3259 * @requested: indicates FTM is requested
3260 * @preamble: frame preamble to use
3261 * @burst_period: burst period to use
3262 * @asap: indicates to use ASAP mode
3263 * @num_bursts_exp: number of bursts exponent
3264 * @burst_duration: burst duration
3265 * @ftms_per_burst: number of FTMs per burst
3266 * @ftmr_retries: number of retries for FTM request
3267 * @request_lci: request LCI information
3268 * @request_civicloc: request civic location information
3270 * See also nl80211 for the respective attribute documentation.
3272 struct cfg80211_pmsr_ftm_request_peer {
3273 enum nl80211_preamble preamble;
3286 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3287 * @addr: MAC address
3288 * @chandef: channel to use
3289 * @report_ap_tsf: report the associated AP's TSF
3290 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3292 struct cfg80211_pmsr_request_peer {
3294 struct cfg80211_chan_def chandef;
3296 struct cfg80211_pmsr_ftm_request_peer ftm;
3300 * struct cfg80211_pmsr_request - peer measurement request
3301 * @cookie: cookie, set by cfg80211
3302 * @nl_portid: netlink portid - used by cfg80211
3303 * @drv_data: driver data for this request, if required for aborting,
3304 * not otherwise freed or anything by cfg80211
3305 * @mac_addr: MAC address used for (randomised) request
3306 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3307 * are 0 in the mask should be randomised, bits that are 1 should
3308 * be taken from the @mac_addr
3309 * @list: used by cfg80211 to hold on to the request
3310 * @timeout: timeout (in milliseconds) for the whole operation, if
3311 * zero it means there's no timeout
3312 * @n_peers: number of peers to do measurements with
3313 * @peers: per-peer measurement request data
3315 struct cfg80211_pmsr_request {
3323 u8 mac_addr[ETH_ALEN] __aligned(2);
3324 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3326 struct list_head list;
3328 struct cfg80211_pmsr_request_peer peers[];
3332 * struct cfg80211_update_owe_info - OWE Information
3334 * This structure provides information needed for the drivers to offload OWE
3335 * (Opportunistic Wireless Encryption) processing to the user space.
3337 * Commonly used across update_owe_info request and event interfaces.
3339 * @peer: MAC address of the peer device for which the OWE processing
3341 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3342 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3343 * cannot give you the real status code for failures. Used only for
3344 * OWE update request command interface (user space to driver).
3345 * @ie: IEs obtained from the peer or constructed by the user space. These are
3346 * the IEs of the remote peer in the event from the host driver and
3347 * the constructed IEs by the user space in the request interface.
3348 * @ie_len: Length of IEs in octets.
3350 struct cfg80211_update_owe_info {
3351 u8 peer[ETH_ALEN] __aligned(2);
3358 * struct cfg80211_ops - backend description for wireless configuration
3360 * This struct is registered by fullmac card drivers and/or wireless stacks
3361 * in order to handle configuration requests on their interfaces.
3363 * All callbacks except where otherwise noted should return 0
3364 * on success or a negative error code.
3366 * All operations are currently invoked under rtnl for consistency with the
3367 * wireless extensions but this is subject to reevaluation as soon as this
3368 * code is used more widely and we have a first user without wext.
3370 * @suspend: wiphy device needs to be suspended. The variable @wow will
3371 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3372 * configured for the device.
3373 * @resume: wiphy device needs to be resumed
3374 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3375 * to call device_set_wakeup_enable() to enable/disable wakeup from
3378 * @add_virtual_intf: create a new virtual interface with the given name,
3379 * must set the struct wireless_dev's iftype. Beware: You must create
3380 * the new netdev in the wiphy's network namespace! Returns the struct
3381 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3382 * also set the address member in the wdev.
3384 * @del_virtual_intf: remove the virtual interface
3386 * @change_virtual_intf: change type/configuration of virtual interface,
3387 * keep the struct wireless_dev's iftype updated.
3389 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3390 * when adding a group key.
3392 * @get_key: get information about the key with the given parameters.
3393 * @mac_addr will be %NULL when requesting information for a group
3394 * key. All pointers given to the @callback function need not be valid
3395 * after it returns. This function should return an error if it is
3396 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3398 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3399 * and @key_index, return -ENOENT if the key doesn't exist.
3401 * @set_default_key: set the default key on an interface
3403 * @set_default_mgmt_key: set the default management frame key on an interface
3405 * @set_default_beacon_key: set the default Beacon frame key on an interface
3407 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3409 * @start_ap: Start acting in AP mode defined by the parameters.
3410 * @change_beacon: Change the beacon parameters for an access point mode
3411 * interface. This should reject the call when AP mode wasn't started.
3412 * @stop_ap: Stop being an AP, including stopping beaconing.
3414 * @add_station: Add a new station.
3415 * @del_station: Remove a station
3416 * @change_station: Modify a given station. Note that flags changes are not much
3417 * validated in cfg80211, in particular the auth/assoc/authorized flags
3418 * might come to the driver in invalid combinations -- make sure to check
3419 * them, also against the existing state! Drivers must call
3420 * cfg80211_check_station_change() to validate the information.
3421 * @get_station: get station information for the station identified by @mac
3422 * @dump_station: dump station callback -- resume dump at index @idx
3424 * @add_mpath: add a fixed mesh path
3425 * @del_mpath: delete a given mesh path
3426 * @change_mpath: change a given mesh path
3427 * @get_mpath: get a mesh path for the given parameters
3428 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3429 * @get_mpp: get a mesh proxy path for the given parameters
3430 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3431 * @join_mesh: join the mesh network with the specified parameters
3432 * (invoked with the wireless_dev mutex held)
3433 * @leave_mesh: leave the current mesh network
3434 * (invoked with the wireless_dev mutex held)
3436 * @get_mesh_config: Get the current mesh configuration
3438 * @update_mesh_config: Update mesh parameters on a running mesh.
3439 * The mask is a bitfield which tells us which parameters to
3440 * set, and which to leave alone.
3442 * @change_bss: Modify parameters for a given BSS.
3444 * @set_txq_params: Set TX queue parameters
3446 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3447 * as it doesn't implement join_mesh and needs to set the channel to
3448 * join the mesh instead.
3450 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3451 * interfaces are active this callback should reject the configuration.
3452 * If no interfaces are active or the device is down, the channel should
3453 * be stored for when a monitor interface becomes active.
3455 * @scan: Request to do a scan. If returning zero, the scan request is given
3456 * the driver, and will be valid until passed to cfg80211_scan_done().
3457 * For scan results, call cfg80211_inform_bss(); you can call this outside
3458 * the scan/scan_done bracket too.
3459 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3460 * indicate the status of the scan through cfg80211_scan_done().
3462 * @auth: Request to authenticate with the specified peer
3463 * (invoked with the wireless_dev mutex held)
3464 * @assoc: Request to (re)associate with the specified peer
3465 * (invoked with the wireless_dev mutex held)
3466 * @deauth: Request to deauthenticate from the specified peer
3467 * (invoked with the wireless_dev mutex held)
3468 * @disassoc: Request to disassociate from the specified peer
3469 * (invoked with the wireless_dev mutex held)
3471 * @connect: Connect to the ESS with the specified parameters. When connected,
3472 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3473 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3474 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3475 * from the AP or cfg80211_connect_timeout() if no frame with status code
3477 * The driver is allowed to roam to other BSSes within the ESS when the
3478 * other BSS matches the connect parameters. When such roaming is initiated
3479 * by the driver, the driver is expected to verify that the target matches
3480 * the configured security parameters and to use Reassociation Request
3481 * frame instead of Association Request frame.
3482 * The connect function can also be used to request the driver to perform a
3483 * specific roam when connected to an ESS. In that case, the prev_bssid
3484 * parameter is set to the BSSID of the currently associated BSS as an
3485 * indication of requesting reassociation.
3486 * In both the driver-initiated and new connect() call initiated roaming
3487 * cases, the result of roaming is indicated with a call to
3488 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3489 * @update_connect_params: Update the connect parameters while connected to a
3490 * BSS. The updated parameters can be used by driver/firmware for
3491 * subsequent BSS selection (roaming) decisions and to form the
3492 * Authentication/(Re)Association Request frames. This call does not
3493 * request an immediate disassociation or reassociation with the current
3494 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3495 * changed are defined in &enum cfg80211_connect_params_changed.
3496 * (invoked with the wireless_dev mutex held)
3497 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3498 * connection is in progress. Once done, call cfg80211_disconnected() in
3499 * case connection was already established (invoked with the
3500 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3502 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3503 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3505 * (invoked with the wireless_dev mutex held)
3506 * @leave_ibss: Leave the IBSS.
3507 * (invoked with the wireless_dev mutex held)
3509 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3512 * @set_wiphy_params: Notify that wiphy parameters have changed;
3513 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3514 * have changed. The actual parameter values are available in
3515 * struct wiphy. If returning an error, no value should be changed.
3517 * @set_tx_power: set the transmit power according to the parameters,
3518 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3519 * wdev may be %NULL if power was set for the wiphy, and will
3520 * always be %NULL unless the driver supports per-vif TX power
3521 * (as advertised by the nl80211 feature flag.)
3522 * @get_tx_power: store the current TX power into the dbm variable;
3523 * return 0 if successful
3525 * @set_wds_peer: set the WDS peer for a WDS interface
3527 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3528 * functions to adjust rfkill hw state
3530 * @dump_survey: get site survey information.
3532 * @remain_on_channel: Request the driver to remain awake on the specified
3533 * channel for the specified duration to complete an off-channel
3534 * operation (e.g., public action frame exchange). When the driver is
3535 * ready on the requested channel, it must indicate this with an event
3536 * notification by calling cfg80211_ready_on_channel().
3537 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3538 * This allows the operation to be terminated prior to timeout based on
3539 * the duration value.
3540 * @mgmt_tx: Transmit a management frame.
3541 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3542 * frame on another channel
3544 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3545 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3546 * used by the function, but 0 and 1 must not be touched. Additionally,
3547 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3548 * dump and return to userspace with an error, so be careful. If any data
3549 * was passed in from userspace then the data/len arguments will be present
3550 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3552 * @set_bitrate_mask: set the bitrate mask configuration
3554 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3555 * devices running firmwares capable of generating the (re) association
3556 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3557 * @del_pmksa: Delete a cached PMKID.
3558 * @flush_pmksa: Flush all cached PMKIDs.
3559 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3560 * allows the driver to adjust the dynamic ps timeout value.
3561 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3562 * After configuration, the driver should (soon) send an event indicating
3563 * the current level is above/below the configured threshold; this may
3564 * need some care when the configuration is changed (without first being
3566 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3567 * connection quality monitor. An event is to be sent only when the
3568 * signal level is found to be outside the two values. The driver should
3569 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3570 * If it is provided then there's no point providing @set_cqm_rssi_config.
3571 * @set_cqm_txe_config: Configure connection quality monitor TX error
3573 * @sched_scan_start: Tell the driver to start a scheduled scan.
3574 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3575 * given request id. This call must stop the scheduled scan and be ready
3576 * for starting a new one before it returns, i.e. @sched_scan_start may be
3577 * called immediately after that again and should not fail in that case.
3578 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3579 * stop (when this method returns 0).
3581 * @mgmt_frame_register: Notify driver that a management frame type was
3582 * registered. The callback is allowed to sleep.
3584 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3585 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3586 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3587 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3589 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3591 * @tdls_mgmt: Transmit a TDLS management frame.
3592 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3594 * @probe_client: probe an associated client, must return a cookie that it
3595 * later passes to cfg80211_probe_status().
3597 * @set_noack_map: Set the NoAck Map for the TIDs.
3599 * @get_channel: Get the current operating channel for the virtual interface.
3600 * For monitor interfaces, it should return %NULL unless there's a single
3601 * current monitoring channel.
3603 * @start_p2p_device: Start the given P2P device.
3604 * @stop_p2p_device: Stop the given P2P device.
3606 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3607 * Parameters include ACL policy, an array of MAC address of stations
3608 * and the number of MAC addresses. If there is already a list in driver
3609 * this new list replaces the existing one. Driver has to clear its ACL
3610 * when number of MAC addresses entries is passed as 0. Drivers which
3611 * advertise the support for MAC based ACL have to implement this callback.
3613 * @start_radar_detection: Start radar detection in the driver.
3615 * @end_cac: End running CAC, probably because a related CAC
3616 * was finished on another phy.
3618 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3619 * driver. If the SME is in the driver/firmware, this information can be
3620 * used in building Authentication and Reassociation Request frames.
3622 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3623 * for a given duration (milliseconds). The protocol is provided so the
3624 * driver can take the most appropriate actions.
3625 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3626 * reliability. This operation can not fail.
3627 * @set_coalesce: Set coalesce parameters.
3629 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3630 * responsible for veryfing if the switch is possible. Since this is
3631 * inherently tricky driver may decide to disconnect an interface later
3632 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3633 * everything. It should do it's best to verify requests and reject them
3634 * as soon as possible.
3636 * @set_qos_map: Set QoS mapping information to the driver
3638 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3639 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3640 * changes during the lifetime of the BSS.
3642 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3643 * with the given parameters; action frame exchange has been handled by
3644 * userspace so this just has to modify the TX path to take the TS into
3646 * If the admitted time is 0 just validate the parameters to make sure
3647 * the session can be created at all; it is valid to just always return
3648 * success for that but that may result in inefficient behaviour (handshake
3649 * with the peer followed by immediate teardown when the addition is later
3651 * @del_tx_ts: remove an existing TX TS
3653 * @join_ocb: join the OCB network with the specified parameters
3654 * (invoked with the wireless_dev mutex held)
3655 * @leave_ocb: leave the current OCB network
3656 * (invoked with the wireless_dev mutex held)
3658 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3659 * is responsible for continually initiating channel-switching operations
3660 * and returning to the base channel for communication with the AP.
3661 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3662 * peers must be on the base channel when the call completes.
3663 * @start_nan: Start the NAN interface.
3664 * @stop_nan: Stop the NAN interface.
3665 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3666 * On success @nan_func ownership is transferred to the driver and
3667 * it may access it outside of the scope of this function. The driver
3668 * should free the @nan_func when no longer needed by calling
3669 * cfg80211_free_nan_func().
3670 * On success the driver should assign an instance_id in the
3671 * provided @nan_func.
3672 * @del_nan_func: Delete a NAN function.
3673 * @nan_change_conf: changes NAN configuration. The changed parameters must
3674 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3675 * All other parameters must be ignored.
3677 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3679 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3680 * function should return phy stats, and interface stats otherwise.
3682 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3683 * If not deleted through @del_pmk the PMK remains valid until disconnect
3684 * upon which the driver should clear it.
3685 * (invoked with the wireless_dev mutex held)
3686 * @del_pmk: delete the previously configured PMK for the given authenticator.
3687 * (invoked with the wireless_dev mutex held)
3689 * @external_auth: indicates result of offloaded authentication processing from
3692 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3693 * tells the driver that the frame should not be encrypted.
3695 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3696 * Statistics should be cumulative, currently no way to reset is provided.
3697 * @start_pmsr: start peer measurement (e.g. FTM)
3698 * @abort_pmsr: abort peer measurement
3700 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3701 * but offloading OWE processing to the user space will get the updated
3702 * DH IE through this interface.
3704 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3705 * and overrule HWMP path selection algorithm.
3706 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
3707 * This callback may sleep.
3708 * @reset_tid_config: Reset TID specific configuration for the peer.
3709 * This callback may sleep.
3711 struct cfg80211_ops {
3712 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3713 int (*resume)(struct wiphy *wiphy);
3714 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3716 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3718 unsigned char name_assign_type,
3719 enum nl80211_iftype type,
3720 struct vif_params *params);
3721 int (*del_virtual_intf)(struct wiphy *wiphy,
3722 struct wireless_dev *wdev);
3723 int (*change_virtual_intf)(struct wiphy *wiphy,
3724 struct net_device *dev,
3725 enum nl80211_iftype type,
3726 struct vif_params *params);
3728 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3729 u8 key_index, bool pairwise, const u8 *mac_addr,
3730 struct key_params *params);
3731 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3732 u8 key_index, bool pairwise, const u8 *mac_addr,
3734 void (*callback)(void *cookie, struct key_params*));
3735 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3736 u8 key_index, bool pairwise, const u8 *mac_addr);
3737 int (*set_default_key)(struct wiphy *wiphy,
3738 struct net_device *netdev,
3739 u8 key_index, bool unicast, bool multicast);
3740 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3741 struct net_device *netdev,
3743 int (*set_default_beacon_key)(struct wiphy *wiphy,
3744 struct net_device *netdev,
3747 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3748 struct cfg80211_ap_settings *settings);
3749 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3750 struct cfg80211_beacon_data *info);
3751 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3754 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3756 struct station_parameters *params);
3757 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3758 struct station_del_parameters *params);
3759 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3761 struct station_parameters *params);
3762 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3763 const u8 *mac, struct station_info *sinfo);
3764 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3765 int idx, u8 *mac, struct station_info *sinfo);
3767 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3768 const u8 *dst, const u8 *next_hop);
3769 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3771 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3772 const u8 *dst, const u8 *next_hop);
3773 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3774 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3775 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3776 int idx, u8 *dst, u8 *next_hop,
3777 struct mpath_info *pinfo);
3778 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3779 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3780 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3781 int idx, u8 *dst, u8 *mpp,
3782 struct mpath_info *pinfo);
3783 int (*get_mesh_config)(struct wiphy *wiphy,
3784 struct net_device *dev,
3785 struct mesh_config *conf);
3786 int (*update_mesh_config)(struct wiphy *wiphy,
3787 struct net_device *dev, u32 mask,
3788 const struct mesh_config *nconf);
3789 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3790 const struct mesh_config *conf,
3791 const struct mesh_setup *setup);
3792 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3794 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3795 struct ocb_setup *setup);
3796 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3798 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3799 struct bss_parameters *params);
3801 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3802 struct ieee80211_txq_params *params);
3804 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3805 struct net_device *dev,
3806 struct ieee80211_channel *chan);
3808 int (*set_monitor_channel)(struct wiphy *wiphy,
3809 struct cfg80211_chan_def *chandef);
3811 int (*scan)(struct wiphy *wiphy,
3812 struct cfg80211_scan_request *request);
3813 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3815 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
3816 struct cfg80211_auth_request *req);
3817 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3818 struct cfg80211_assoc_request *req);
3819 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3820 struct cfg80211_deauth_request *req);
3821 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3822 struct cfg80211_disassoc_request *req);
3824 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
3825 struct cfg80211_connect_params *sme);
3826 int (*update_connect_params)(struct wiphy *wiphy,
3827 struct net_device *dev,
3828 struct cfg80211_connect_params *sme,
3830 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3833 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3834 struct cfg80211_ibss_params *params);
3835 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3837 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3838 int rate[NUM_NL80211_BANDS]);
3840 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3842 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3843 enum nl80211_tx_power_setting type, int mbm);
3844 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3847 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3850 void (*rfkill_poll)(struct wiphy *wiphy);
3852 #ifdef CONFIG_NL80211_TESTMODE
3853 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3854 void *data, int len);
3855 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3856 struct netlink_callback *cb,
3857 void *data, int len);
3860 int (*set_bitrate_mask)(struct wiphy *wiphy,
3861 struct net_device *dev,
3863 const struct cfg80211_bitrate_mask *mask);
3865 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3866 int idx, struct survey_info *info);
3868 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3869 struct cfg80211_pmksa *pmksa);
3870 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3871 struct cfg80211_pmksa *pmksa);
3872 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3874 int (*remain_on_channel)(struct wiphy *wiphy,
3875 struct wireless_dev *wdev,
3876 struct ieee80211_channel *chan,
3877 unsigned int duration,
3879 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
3880 struct wireless_dev *wdev,
3883 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3884 struct cfg80211_mgmt_tx_params *params,
3886 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3887 struct wireless_dev *wdev,
3890 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3891 bool enabled, int timeout);
3893 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
3894 struct net_device *dev,
3895 s32 rssi_thold, u32 rssi_hyst);
3897 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3898 struct net_device *dev,
3899 s32 rssi_low, s32 rssi_high);
3901 int (*set_cqm_txe_config)(struct wiphy *wiphy,
3902 struct net_device *dev,
3903 u32 rate, u32 pkts, u32 intvl);
3905 void (*mgmt_frame_register)(struct wiphy *wiphy,
3906 struct wireless_dev *wdev,
3907 u16 frame_type, bool reg);
3909 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3910 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3912 int (*sched_scan_start)(struct wiphy *wiphy,
3913 struct net_device *dev,
3914 struct cfg80211_sched_scan_request *request);
3915 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3918 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3919 struct cfg80211_gtk_rekey_data *data);
3921 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3922 const u8 *peer, u8 action_code, u8 dialog_token,
3923 u16 status_code, u32 peer_capability,
3924 bool initiator, const u8 *buf, size_t len);
3925 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3926 const u8 *peer, enum nl80211_tdls_operation oper);
3928 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3929 const u8 *peer, u64 *cookie);
3931 int (*set_noack_map)(struct wiphy *wiphy,
3932 struct net_device *dev,
3935 int (*get_channel)(struct wiphy *wiphy,
3936 struct wireless_dev *wdev,
3937 struct cfg80211_chan_def *chandef);
3939 int (*start_p2p_device)(struct wiphy *wiphy,
3940 struct wireless_dev *wdev);
3941 void (*stop_p2p_device)(struct wiphy *wiphy,
3942 struct wireless_dev *wdev);
3944 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3945 const struct cfg80211_acl_data *params);
3947 int (*start_radar_detection)(struct wiphy *wiphy,
3948 struct net_device *dev,
3949 struct cfg80211_chan_def *chandef,
3951 void (*end_cac)(struct wiphy *wiphy,
3952 struct net_device *dev);
3953 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3954 struct cfg80211_update_ft_ies_params *ftie);
3955 int (*crit_proto_start)(struct wiphy *wiphy,
3956 struct wireless_dev *wdev,
3957 enum nl80211_crit_proto_id protocol,
3959 void (*crit_proto_stop)(struct wiphy *wiphy,
3960 struct wireless_dev *wdev);
3961 int (*set_coalesce)(struct wiphy *wiphy,
3962 struct cfg80211_coalesce *coalesce);
3964 int (*channel_switch)(struct wiphy *wiphy,
3965 struct net_device *dev,
3966 struct cfg80211_csa_settings *params);
3968 int (*set_qos_map)(struct wiphy *wiphy,
3969 struct net_device *dev,
3970 struct cfg80211_qos_map *qos_map);
3972 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3973 struct cfg80211_chan_def *chandef);
3975 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3976 u8 tsid, const u8 *peer, u8 user_prio,
3978 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3979 u8 tsid, const u8 *peer);
3981 int (*tdls_channel_switch)(struct wiphy *wiphy,
3982 struct net_device *dev,
3983 const u8 *addr, u8 oper_class,
3984 struct cfg80211_chan_def *chandef);
3985 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3986 struct net_device *dev,
3988 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3989 struct cfg80211_nan_conf *conf);
3990 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3991 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3992 struct cfg80211_nan_func *nan_func);
3993 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3995 int (*nan_change_conf)(struct wiphy *wiphy,
3996 struct wireless_dev *wdev,
3997 struct cfg80211_nan_conf *conf,
4000 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4001 struct net_device *dev,
4002 const bool enabled);
4004 int (*get_txq_stats)(struct wiphy *wiphy,
4005 struct wireless_dev *wdev,
4006 struct cfg80211_txq_stats *txqstats);
4008 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4009 const struct cfg80211_pmk_conf *conf);
4010 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4012 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4013 struct cfg80211_external_auth_params *params);
4015 int (*tx_control_port)(struct wiphy *wiphy,
4016 struct net_device *dev,
4017 const u8 *buf, size_t len,
4018 const u8 *dest, const __be16 proto,
4019 const bool noencrypt);
4021 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4022 struct net_device *dev,
4023 struct cfg80211_ftm_responder_stats *ftm_stats);
4025 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4026 struct cfg80211_pmsr_request *request);
4027 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4028 struct cfg80211_pmsr_request *request);
4029 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4030 struct cfg80211_update_owe_info *owe_info);
4031 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4032 const u8 *buf, size_t len);
4033 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4034 struct ieee80211_tid_config *tid_conf);
4035 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4036 const u8 *peer, u8 tid);
4040 * wireless hardware and networking interfaces structures
4041 * and registration/helper functions
4045 * enum wiphy_flags - wiphy capability flags
4047 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4049 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4050 * by default -- this flag will be set depending on the kernel's default
4051 * on wiphy_new(), but can be changed by the driver if it has a good
4052 * reason to override the default
4053 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4054 * on a VLAN interface). This flag also serves an extra purpose of
4055 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4056 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4057 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4058 * control port protocol ethertype. The device also honours the
4059 * control_port_no_encrypt flag.
4060 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4061 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4062 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4063 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4065 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4066 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4067 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4068 * link setup/discovery operations internally. Setup, discovery and
4069 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4070 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4071 * used for asking the driver/firmware to perform a TDLS operation.
4072 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4073 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4074 * when there are virtual interfaces in AP mode by calling
4075 * cfg80211_report_obss_beacon().
4076 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4077 * responds to probe-requests in hardware.
4078 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4079 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4080 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4081 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4082 * beaconing mode (AP, IBSS, Mesh, ...).
4083 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4084 * before connection.
4090 WIPHY_FLAG_NETNS_OK = BIT(3),
4091 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4092 WIPHY_FLAG_4ADDR_AP = BIT(5),
4093 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4094 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4095 WIPHY_FLAG_IBSS_RSN = BIT(8),
4096 WIPHY_FLAG_MESH_AUTH = BIT(10),
4097 /* use hole at 11 */
4098 /* use hole at 12 */
4099 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4100 WIPHY_FLAG_AP_UAPSD = BIT(14),
4101 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4102 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4103 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4104 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4105 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4106 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4107 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4108 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4109 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4110 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4114 * struct ieee80211_iface_limit - limit on certain interface types
4115 * @max: maximum number of interfaces of these types
4116 * @types: interface types (bits)
4118 struct ieee80211_iface_limit {
4124 * struct ieee80211_iface_combination - possible interface combination
4126 * With this structure the driver can describe which interface
4127 * combinations it supports concurrently.
4131 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4135 * struct ieee80211_iface_limit limits1[] = {
4136 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4137 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4139 * struct ieee80211_iface_combination combination1 = {
4140 * .limits = limits1,
4141 * .n_limits = ARRAY_SIZE(limits1),
4142 * .max_interfaces = 2,
4143 * .beacon_int_infra_match = true,
4147 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4151 * struct ieee80211_iface_limit limits2[] = {
4152 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4153 * BIT(NL80211_IFTYPE_P2P_GO), },
4155 * struct ieee80211_iface_combination combination2 = {
4156 * .limits = limits2,
4157 * .n_limits = ARRAY_SIZE(limits2),
4158 * .max_interfaces = 8,
4159 * .num_different_channels = 1,
4163 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4165 * This allows for an infrastructure connection and three P2P connections.
4169 * struct ieee80211_iface_limit limits3[] = {
4170 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4171 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4172 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4174 * struct ieee80211_iface_combination combination3 = {
4175 * .limits = limits3,
4176 * .n_limits = ARRAY_SIZE(limits3),
4177 * .max_interfaces = 4,
4178 * .num_different_channels = 2,
4182 struct ieee80211_iface_combination {
4185 * limits for the given interface types
4187 const struct ieee80211_iface_limit *limits;
4190 * @num_different_channels:
4191 * can use up to this many different channels
4193 u32 num_different_channels;
4197 * maximum number of interfaces in total allowed in this group
4203 * number of limitations
4208 * @beacon_int_infra_match:
4209 * In this combination, the beacon intervals between infrastructure
4210 * and AP types must match. This is required only in special cases.
4212 bool beacon_int_infra_match;
4215 * @radar_detect_widths:
4216 * bitmap of channel widths supported for radar detection
4218 u8 radar_detect_widths;
4221 * @radar_detect_regions:
4222 * bitmap of regions supported for radar detection
4224 u8 radar_detect_regions;
4227 * @beacon_int_min_gcd:
4228 * This interface combination supports different beacon intervals.
4231 * all beacon intervals for different interface must be same.
4233 * any beacon interval for the interface part of this combination AND
4234 * GCD of all beacon intervals from beaconing interfaces of this
4235 * combination must be greater or equal to this value.
4237 u32 beacon_int_min_gcd;
4240 struct ieee80211_txrx_stypes {
4245 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4246 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4247 * trigger that keeps the device operating as-is and
4248 * wakes up the host on any activity, for example a
4249 * received packet that passed filtering; note that the
4250 * packet should be preserved in that case
4251 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4253 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4254 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4255 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4256 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4257 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4258 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4259 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4261 enum wiphy_wowlan_support_flags {
4262 WIPHY_WOWLAN_ANY = BIT(0),
4263 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4264 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4265 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4266 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4267 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4268 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4269 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4270 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4273 struct wiphy_wowlan_tcp_support {
4274 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4275 u32 data_payload_max;
4276 u32 data_interval_max;
4277 u32 wake_payload_max;
4282 * struct wiphy_wowlan_support - WoWLAN support data
4283 * @flags: see &enum wiphy_wowlan_support_flags
4284 * @n_patterns: number of supported wakeup patterns
4285 * (see nl80211.h for the pattern definition)
4286 * @pattern_max_len: maximum length of each pattern
4287 * @pattern_min_len: minimum length of each pattern
4288 * @max_pkt_offset: maximum Rx packet offset
4289 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4290 * similar, but not necessarily identical, to max_match_sets for
4292 * See &struct cfg80211_sched_scan_request.@match_sets for more
4294 * @tcp: TCP wakeup support information
4296 struct wiphy_wowlan_support {
4299 int pattern_max_len;
4300 int pattern_min_len;
4302 int max_nd_match_sets;
4303 const struct wiphy_wowlan_tcp_support *tcp;
4307 * struct wiphy_coalesce_support - coalesce support data
4308 * @n_rules: maximum number of coalesce rules
4309 * @max_delay: maximum supported coalescing delay in msecs
4310 * @n_patterns: number of supported patterns in a rule
4311 * (see nl80211.h for the pattern definition)
4312 * @pattern_max_len: maximum length of each pattern
4313 * @pattern_min_len: minimum length of each pattern
4314 * @max_pkt_offset: maximum Rx packet offset
4316 struct wiphy_coalesce_support {
4320 int pattern_max_len;
4321 int pattern_min_len;
4326 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4327 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4328 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4329 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4330 * (must be combined with %_WDEV or %_NETDEV)
4332 enum wiphy_vendor_command_flags {
4333 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4334 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4335 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4339 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4341 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4342 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4343 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4346 enum wiphy_opmode_flag {
4347 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4348 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4349 STA_OPMODE_N_SS_CHANGED = BIT(2),
4353 * struct sta_opmode_info - Station's ht/vht operation mode information
4354 * @changed: contains value from &enum wiphy_opmode_flag
4355 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4356 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4357 * @rx_nss: new rx_nss value of a station
4360 struct sta_opmode_info {
4362 enum nl80211_smps_mode smps_mode;
4363 enum nl80211_chan_width bw;
4367 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4370 * struct wiphy_vendor_command - vendor command definition
4371 * @info: vendor command identifying information, as used in nl80211
4372 * @flags: flags, see &enum wiphy_vendor_command_flags
4373 * @doit: callback for the operation, note that wdev is %NULL if the
4374 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4375 * pointer may be %NULL if userspace provided no data at all
4376 * @dumpit: dump callback, for transferring bigger/multiple items. The
4377 * @storage points to cb->args[5], ie. is preserved over the multiple
4379 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4380 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4381 * attribute is just raw data (e.g. a firmware command).
4382 * @maxattr: highest attribute number in policy
4383 * It's recommended to not have the same sub command with both @doit and
4384 * @dumpit, so that userspace can assume certain ones are get and others
4385 * are used with dump requests.
4387 struct wiphy_vendor_command {
4388 struct nl80211_vendor_cmd_info info;
4390 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4391 const void *data, int data_len);
4392 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4393 struct sk_buff *skb, const void *data, int data_len,
4394 unsigned long *storage);
4395 const struct nla_policy *policy;
4396 unsigned int maxattr;
4400 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4401 * @iftype: interface type
4402 * @extended_capabilities: extended capabilities supported by the driver,
4403 * additional capabilities might be supported by userspace; these are the
4404 * 802.11 extended capabilities ("Extended Capabilities element") and are
4405 * in the same format as in the information element. See IEEE Std
4406 * 802.11-2012 8.4.2.29 for the defined fields.
4407 * @extended_capabilities_mask: mask of the valid values
4408 * @extended_capabilities_len: length of the extended capabilities
4410 struct wiphy_iftype_ext_capab {
4411 enum nl80211_iftype iftype;
4412 const u8 *extended_capabilities;
4413 const u8 *extended_capabilities_mask;
4414 u8 extended_capabilities_len;
4418 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4419 * @max_peers: maximum number of peers in a single measurement
4420 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4421 * @randomize_mac_addr: can randomize MAC address for measurement
4422 * @ftm.supported: FTM measurement is supported
4423 * @ftm.asap: ASAP-mode is supported
4424 * @ftm.non_asap: non-ASAP-mode is supported
4425 * @ftm.request_lci: can request LCI data
4426 * @ftm.request_civicloc: can request civic location data
4427 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4428 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4429 * @ftm.max_bursts_exponent: maximum burst exponent supported
4430 * (set to -1 if not limited; note that setting this will necessarily
4431 * forbid using the value 15 to let the responder pick)
4432 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4435 struct cfg80211_pmsr_capabilities {
4436 unsigned int max_peers;
4438 randomize_mac_addr:1;
4443 s8 max_bursts_exponent;
4444 u8 max_ftms_per_burst;
4454 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4455 * suites for interface types defined in @iftypes_mask. Each type in the
4456 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4458 * @iftypes_mask: bitmask of interfaces types
4459 * @akm_suites: points to an array of supported akm suites
4460 * @n_akm_suites: number of supported AKM suites
4462 struct wiphy_iftype_akm_suites {
4464 const u32 *akm_suites;
4469 * struct wiphy - wireless hardware description
4470 * @reg_notifier: the driver's regulatory notification callback,
4471 * note that if your driver uses wiphy_apply_custom_regulatory()
4472 * the reg_notifier's request can be passed as NULL
4473 * @regd: the driver's regulatory domain, if one was requested via
4474 * the regulatory_hint() API. This can be used by the driver
4475 * on the reg_notifier() if it chooses to ignore future
4476 * regulatory domain changes caused by other drivers.
4477 * @signal_type: signal type reported in &struct cfg80211_bss.
4478 * @cipher_suites: supported cipher suites
4479 * @n_cipher_suites: number of supported cipher suites
4480 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4481 * the supported AKMs not advertized for a specific interface type in
4482 * iftype_akm_suites.
4483 * @n_akm_suites: number of supported AKM suites
4484 * @iftype_akm_suites: array of supported akm suites info per interface type.
4485 * Note that the bits in @iftypes_mask inside this structure cannot
4486 * overlap (i.e. only one occurrence of each type is allowed across all
4487 * instances of iftype_akm_suites).
4488 * @num_iftype_akm_suites: number of interface types for which supported akm
4489 * suites are specified separately.
4490 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4491 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4492 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4493 * -1 = fragmentation disabled, only odd values >= 256 used
4494 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4495 * @_net: the network namespace this wiphy currently lives in
4496 * @perm_addr: permanent MAC address of this device
4497 * @addr_mask: If the device supports multiple MAC addresses by masking,
4498 * set this to a mask with variable bits set to 1, e.g. if the last
4499 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4500 * variable bits shall be determined by the interfaces added, with
4501 * interfaces not matching the mask being rejected to be brought up.
4502 * @n_addresses: number of addresses in @addresses.
4503 * @addresses: If the device has more than one address, set this pointer
4504 * to a list of addresses (6 bytes each). The first one will be used
4505 * by default for perm_addr. In this case, the mask should be set to
4506 * all-zeroes. In this case it is assumed that the device can handle
4507 * the same number of arbitrary MAC addresses.
4508 * @registered: protects ->resume and ->suspend sysfs callbacks against
4509 * unregister hardware
4510 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4511 * It will be renamed automatically on wiphy renames
4512 * @dev: (virtual) struct device for this wiphy. The item in
4513 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4515 * @wext: wireless extension handlers
4516 * @priv: driver private data (sized according to wiphy_new() parameter)
4517 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4518 * must be set by driver
4519 * @iface_combinations: Valid interface combinations array, should not
4520 * list single interface types.
4521 * @n_iface_combinations: number of entries in @iface_combinations array.
4522 * @software_iftypes: bitmask of software interface types, these are not
4523 * subject to any restrictions since they are purely managed in SW.
4524 * @flags: wiphy flags, see &enum wiphy_flags
4525 * @regulatory_flags: wiphy regulatory flags, see
4526 * &enum ieee80211_regulatory_flags
4527 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4528 * @ext_features: extended features advertised to nl80211, see
4529 * &enum nl80211_ext_feature_index.
4530 * @bss_priv_size: each BSS struct has private data allocated with it,
4531 * this variable determines its size
4532 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4534 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4535 * the device can run concurrently.
4536 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4537 * for in any given scheduled scan
4538 * @max_match_sets: maximum number of match sets the device can handle
4539 * when performing a scheduled scan, 0 if filtering is not
4541 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4542 * add to probe request frames transmitted during a scan, must not
4543 * include fixed IEs like supported rates
4544 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4546 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4547 * of iterations) for scheduled scan supported by the device.
4548 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4549 * single scan plan supported by the device.
4550 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4551 * scan plan supported by the device.
4552 * @coverage_class: current coverage class
4553 * @fw_version: firmware version for ethtool reporting
4554 * @hw_version: hardware version for ethtool reporting
4555 * @max_num_pmkids: maximum number of PMKIDs supported by device
4556 * @privid: a pointer that drivers can use to identify if an arbitrary
4557 * wiphy is theirs, e.g. in global notifiers
4558 * @bands: information about bands/channels supported by this device
4560 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4561 * transmitted through nl80211, points to an array indexed by interface
4564 * @available_antennas_tx: bitmap of antennas which are available to be
4565 * configured as TX antennas. Antenna configuration commands will be
4566 * rejected unless this or @available_antennas_rx is set.
4568 * @available_antennas_rx: bitmap of antennas which are available to be
4569 * configured as RX antennas. Antenna configuration commands will be
4570 * rejected unless this or @available_antennas_tx is set.
4572 * @probe_resp_offload:
4573 * Bitmap of supported protocols for probe response offloading.
4574 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4575 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4577 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4578 * may request, if implemented.
4580 * @wowlan: WoWLAN support information
4581 * @wowlan_config: current WoWLAN configuration; this should usually not be
4582 * used since access to it is necessarily racy, use the parameter passed
4583 * to the suspend() operation instead.
4585 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4586 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4587 * If null, then none can be over-ridden.
4588 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4589 * If null, then none can be over-ridden.
4591 * @wdev_list: the list of associated (virtual) interfaces; this list must
4592 * not be modified by the driver, but can be read with RTNL/RCU protection.
4594 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4597 * @extended_capabilities: extended capabilities supported by the driver,
4598 * additional capabilities might be supported by userspace; these are
4599 * the 802.11 extended capabilities ("Extended Capabilities element")
4600 * and are in the same format as in the information element. See
4601 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4602 * extended capabilities to be used if the capabilities are not specified
4603 * for a specific interface type in iftype_ext_capab.
4604 * @extended_capabilities_mask: mask of the valid values
4605 * @extended_capabilities_len: length of the extended capabilities
4606 * @iftype_ext_capab: array of extended capabilities per interface type
4607 * @num_iftype_ext_capab: number of interface types for which extended
4608 * capabilities are specified separately.
4609 * @coalesce: packet coalescing support information
4611 * @vendor_commands: array of vendor commands supported by the hardware
4612 * @n_vendor_commands: number of vendor commands
4613 * @vendor_events: array of vendor events supported by the hardware
4614 * @n_vendor_events: number of vendor events
4616 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4617 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4618 * driver is allowed to advertise a theoretical limit that it can reach in
4619 * some cases, but may not always reach.
4621 * @max_num_csa_counters: Number of supported csa_counters in beacons
4622 * and probe responses. This value should be set if the driver
4623 * wishes to limit the number of csa counters. Default (0) means
4625 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4626 * by the driver in the .connect() callback. The bit position maps to the
4627 * attribute indices defined in &enum nl80211_bss_select_attr.
4629 * @nan_supported_bands: bands supported by the device in NAN mode, a
4630 * bitmap of &enum nl80211_band values. For instance, for
4631 * NL80211_BAND_2GHZ, bit 0 would be set
4632 * (i.e. BIT(NL80211_BAND_2GHZ)).
4634 * @txq_limit: configuration of internal TX queue frame limit
4635 * @txq_memory_limit: configuration internal TX queue memory limit
4636 * @txq_quantum: configuration of internal TX queue scheduler quantum
4638 * @support_mbssid: can HW support association with nontransmitted AP
4639 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4640 * HE AP, in order to avoid compatibility issues.
4641 * @support_mbssid must be set for this to have any effect.
4643 * @pmsr_capa: peer measurement capabilities
4646 /* assign these fields before you register the wiphy */
4648 u8 perm_addr[ETH_ALEN];
4649 u8 addr_mask[ETH_ALEN];
4651 struct mac_address *addresses;
4653 const struct ieee80211_txrx_stypes *mgmt_stypes;
4655 const struct ieee80211_iface_combination *iface_combinations;
4656 int n_iface_combinations;
4657 u16 software_iftypes;
4661 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4662 u16 interface_modes;
4664 u16 max_acl_mac_addrs;
4666 u32 flags, regulatory_flags, features;
4667 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4671 enum cfg80211_signal_type signal_type;
4675 u8 max_sched_scan_reqs;
4676 u8 max_sched_scan_ssids;
4678 u16 max_scan_ie_len;
4679 u16 max_sched_scan_ie_len;
4680 u32 max_sched_scan_plans;
4681 u32 max_sched_scan_plan_interval;
4682 u32 max_sched_scan_plan_iterations;
4684 int n_cipher_suites;
4685 const u32 *cipher_suites;
4688 const u32 *akm_suites;
4690 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
4691 unsigned int num_iftype_akm_suites;
4699 char fw_version[ETHTOOL_FWVERS_LEN];
4703 const struct wiphy_wowlan_support *wowlan;
4704 struct cfg80211_wowlan *wowlan_config;
4707 u16 max_remain_on_channel_duration;
4711 u32 available_antennas_tx;
4712 u32 available_antennas_rx;
4714 u32 probe_resp_offload;
4716 const u8 *extended_capabilities, *extended_capabilities_mask;
4717 u8 extended_capabilities_len;
4719 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4720 unsigned int num_iftype_ext_capab;
4724 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4726 void (*reg_notifier)(struct wiphy *wiphy,
4727 struct regulatory_request *request);
4729 /* fields below are read-only, assigned by cfg80211 */
4731 const struct ieee80211_regdomain __rcu *regd;
4737 struct dentry *debugfsdir;
4739 const struct ieee80211_ht_cap *ht_capa_mod_mask;
4740 const struct ieee80211_vht_cap *vht_capa_mod_mask;
4742 struct list_head wdev_list;
4744 possible_net_t _net;
4746 #ifdef CONFIG_CFG80211_WEXT
4747 const struct iw_handler_def *wext;
4750 const struct wiphy_coalesce_support *coalesce;
4752 const struct wiphy_vendor_command *vendor_commands;
4753 const struct nl80211_vendor_cmd_info *vendor_events;
4754 int n_vendor_commands, n_vendor_events;
4756 u16 max_ap_assoc_sta;
4758 u8 max_num_csa_counters;
4760 u32 bss_select_support;
4762 u8 nan_supported_bands;
4765 u32 txq_memory_limit;
4768 unsigned long tx_queue_len;
4770 u8 support_mbssid:1,
4771 support_only_he_mbssid:1;
4773 const struct cfg80211_pmsr_capabilities *pmsr_capa;
4775 char priv[0] __aligned(NETDEV_ALIGN);
4778 static inline struct net *wiphy_net(struct wiphy *wiphy)
4780 return read_pnet(&wiphy->_net);
4783 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4785 write_pnet(&wiphy->_net, net);
4789 * wiphy_priv - return priv from wiphy
4791 * @wiphy: the wiphy whose priv pointer to return
4792 * Return: The priv of @wiphy.
4794 static inline void *wiphy_priv(struct wiphy *wiphy)
4797 return &wiphy->priv;
4801 * priv_to_wiphy - return the wiphy containing the priv
4803 * @priv: a pointer previously returned by wiphy_priv
4804 * Return: The wiphy of @priv.
4806 static inline struct wiphy *priv_to_wiphy(void *priv)
4809 return container_of(priv, struct wiphy, priv);
4813 * set_wiphy_dev - set device pointer for wiphy
4815 * @wiphy: The wiphy whose device to bind
4816 * @dev: The device to parent it to
4818 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4820 wiphy->dev.parent = dev;
4824 * wiphy_dev - get wiphy dev pointer
4826 * @wiphy: The wiphy whose device struct to look up
4827 * Return: The dev of @wiphy.
4829 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4831 return wiphy->dev.parent;
4835 * wiphy_name - get wiphy name
4837 * @wiphy: The wiphy whose name to return
4838 * Return: The name of @wiphy.
4840 static inline const char *wiphy_name(const struct wiphy *wiphy)
4842 return dev_name(&wiphy->dev);
4846 * wiphy_new_nm - create a new wiphy for use with cfg80211
4848 * @ops: The configuration operations for this device
4849 * @sizeof_priv: The size of the private area to allocate
4850 * @requested_name: Request a particular name.
4851 * NULL is valid value, and means use the default phy%d naming.
4853 * Create a new wiphy and associate the given operations with it.
4854 * @sizeof_priv bytes are allocated for private use.
4856 * Return: A pointer to the new wiphy. This pointer must be
4857 * assigned to each netdev's ieee80211_ptr for proper operation.
4859 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4860 const char *requested_name);
4863 * wiphy_new - create a new wiphy for use with cfg80211
4865 * @ops: The configuration operations for this device
4866 * @sizeof_priv: The size of the private area to allocate
4868 * Create a new wiphy and associate the given operations with it.
4869 * @sizeof_priv bytes are allocated for private use.
4871 * Return: A pointer to the new wiphy. This pointer must be
4872 * assigned to each netdev's ieee80211_ptr for proper operation.
4874 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4877 return wiphy_new_nm(ops, sizeof_priv, NULL);
4881 * wiphy_register - register a wiphy with cfg80211
4883 * @wiphy: The wiphy to register.
4885 * Return: A non-negative wiphy index or a negative error code.
4887 int wiphy_register(struct wiphy *wiphy);
4890 * wiphy_unregister - deregister a wiphy from cfg80211
4892 * @wiphy: The wiphy to unregister.
4894 * After this call, no more requests can be made with this priv
4895 * pointer, but the call may sleep to wait for an outstanding
4896 * request that is being handled.
4898 void wiphy_unregister(struct wiphy *wiphy);
4901 * wiphy_free - free wiphy
4903 * @wiphy: The wiphy to free
4905 void wiphy_free(struct wiphy *wiphy);
4907 /* internal structs */
4908 struct cfg80211_conn;
4909 struct cfg80211_internal_bss;
4910 struct cfg80211_cached_keys;
4911 struct cfg80211_cqm_config;
4914 * struct wireless_dev - wireless device state
4916 * For netdevs, this structure must be allocated by the driver
4917 * that uses the ieee80211_ptr field in struct net_device (this
4918 * is intentional so it can be allocated along with the netdev.)
4919 * It need not be registered then as netdev registration will
4920 * be intercepted by cfg80211 to see the new wireless device.
4922 * For non-netdev uses, it must also be allocated by the driver
4923 * in response to the cfg80211 callbacks that require it, as
4924 * there's no netdev registration in that case it may not be
4925 * allocated outside of callback operations that return it.
4927 * @wiphy: pointer to hardware description
4928 * @iftype: interface type
4929 * @list: (private) Used to collect the interfaces
4930 * @netdev: (private) Used to reference back to the netdev, may be %NULL
4931 * @identifier: (private) Identifier used in nl80211 to identify this
4932 * wireless device if it has no netdev
4933 * @current_bss: (private) Used by the internal configuration code
4934 * @chandef: (private) Used by the internal configuration code to track
4935 * the user-set channel definition.
4936 * @preset_chandef: (private) Used by the internal configuration code to
4937 * track the channel to be used for AP later
4938 * @bssid: (private) Used by the internal configuration code
4939 * @ssid: (private) Used by the internal configuration code
4940 * @ssid_len: (private) Used by the internal configuration code
4941 * @mesh_id_len: (private) Used by the internal configuration code
4942 * @mesh_id_up_len: (private) Used by the internal configuration code
4943 * @wext: (private) Used by the internal wireless extensions compat code
4944 * @wext.ibss: (private) IBSS data part of wext handling
4945 * @wext.connect: (private) connection handling data
4946 * @wext.keys: (private) (WEP) key data
4947 * @wext.ie: (private) extra elements for association
4948 * @wext.ie_len: (private) length of extra elements
4949 * @wext.bssid: (private) selected network BSSID
4950 * @wext.ssid: (private) selected network SSID
4951 * @wext.default_key: (private) selected default key index
4952 * @wext.default_mgmt_key: (private) selected default management key index
4953 * @wext.prev_bssid: (private) previous BSSID for reassociation
4954 * @wext.prev_bssid_valid: (private) previous BSSID validity
4955 * @use_4addr: indicates 4addr mode is used on this interface, must be
4956 * set by driver (if supported) on add_interface BEFORE registering the
4957 * netdev and may otherwise be used by driver read-only, will be update
4958 * by cfg80211 on change_interface
4959 * @mgmt_registrations: list of registrations for management frames
4960 * @mgmt_registrations_lock: lock for the list
4961 * @mtx: mutex used to lock data in this struct, may be used by drivers
4962 * and some API functions require it held
4963 * @beacon_interval: beacon interval used on this device for transmitting
4964 * beacons, 0 when not valid
4965 * @address: The address for this device, valid only if @netdev is %NULL
4966 * @is_running: true if this is a non-netdev device that has been started, e.g.
4968 * @cac_started: true if DFS channel availability check has been started
4969 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4970 * @cac_time_ms: CAC time in ms
4971 * @ps: powersave mode is enabled
4972 * @ps_timeout: dynamic powersave timeout
4973 * @ap_unexpected_nlportid: (private) netlink port ID of application
4974 * registered for unexpected class 3 frames (AP mode)
4975 * @conn: (private) cfg80211 software SME connection state machine data
4976 * @connect_keys: (private) keys to set after connection is established
4977 * @conn_bss_type: connecting/connected BSS type
4978 * @conn_owner_nlportid: (private) connection owner socket port ID
4979 * @disconnect_wk: (private) auto-disconnect work
4980 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4981 * @ibss_fixed: (private) IBSS is using fixed BSSID
4982 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4983 * @event_list: (private) list for internal event processing
4984 * @event_lock: (private) lock for event list
4985 * @owner_nlportid: (private) owner socket port ID
4986 * @nl_owner_dead: (private) owner socket went away
4987 * @cqm_config: (private) nl80211 RSSI monitor state
4988 * @pmsr_list: (private) peer measurement requests
4989 * @pmsr_lock: (private) peer measurements requests/results lock
4990 * @pmsr_free_wk: (private) peer measurements cleanup work
4992 struct wireless_dev {
4993 struct wiphy *wiphy;
4994 enum nl80211_iftype iftype;
4996 /* the remainder of this struct should be private to cfg80211 */
4997 struct list_head list;
4998 struct net_device *netdev;
5002 struct list_head mgmt_registrations;
5003 spinlock_t mgmt_registrations_lock;
5007 bool use_4addr, is_running;
5009 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5011 /* currently used for IBSS and SME - might be rearranged later */
5012 u8 ssid[IEEE80211_MAX_SSID_LEN];
5013 u8 ssid_len, mesh_id_len, mesh_id_up_len;
5014 struct cfg80211_conn *conn;
5015 struct cfg80211_cached_keys *connect_keys;
5016 enum ieee80211_bss_type conn_bss_type;
5017 u32 conn_owner_nlportid;
5019 struct work_struct disconnect_wk;
5020 u8 disconnect_bssid[ETH_ALEN];
5022 struct list_head event_list;
5023 spinlock_t event_lock;
5025 struct cfg80211_internal_bss *current_bss; /* associated / joined */
5026 struct cfg80211_chan_def preset_chandef;
5027 struct cfg80211_chan_def chandef;
5030 bool ibss_dfs_possible;
5035 int beacon_interval;
5037 u32 ap_unexpected_nlportid;
5043 unsigned long cac_start_time;
5044 unsigned int cac_time_ms;
5046 #ifdef CONFIG_CFG80211_WEXT
5049 struct cfg80211_ibss_params ibss;
5050 struct cfg80211_connect_params connect;
5051 struct cfg80211_cached_keys *keys;
5055 u8 prev_bssid[ETH_ALEN];
5056 u8 ssid[IEEE80211_MAX_SSID_LEN];
5057 s8 default_key, default_mgmt_key;
5058 bool prev_bssid_valid;
5062 struct cfg80211_cqm_config *cqm_config;
5064 struct list_head pmsr_list;
5065 spinlock_t pmsr_lock;
5066 struct work_struct pmsr_free_wk;
5069 static inline u8 *wdev_address(struct wireless_dev *wdev)
5072 return wdev->netdev->dev_addr;
5073 return wdev->address;
5076 static inline bool wdev_running(struct wireless_dev *wdev)
5079 return netif_running(wdev->netdev);
5080 return wdev->is_running;
5084 * wdev_priv - return wiphy priv from wireless_dev
5086 * @wdev: The wireless device whose wiphy's priv pointer to return
5087 * Return: The wiphy priv of @wdev.
5089 static inline void *wdev_priv(struct wireless_dev *wdev)
5092 return wiphy_priv(wdev->wiphy);
5096 * DOC: Utility functions
5098 * cfg80211 offers a number of utility functions that can be useful.
5102 * ieee80211_channel_to_frequency - convert channel number to frequency
5103 * @chan: channel number
5104 * @band: band, necessary due to channel number overlap
5105 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5107 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
5110 * ieee80211_frequency_to_channel - convert frequency to channel number
5111 * @freq: center frequency
5112 * Return: The corresponding channel, or 0 if the conversion failed.
5114 int ieee80211_frequency_to_channel(int freq);
5117 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5119 * @wiphy: the struct wiphy to get the channel for
5120 * @freq: the center frequency of the channel
5122 * Return: The channel struct from @wiphy at @freq.
5124 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
5127 * ieee80211_get_response_rate - get basic rate for a given rate
5129 * @sband: the band to look for rates in
5130 * @basic_rates: bitmap of basic rates
5131 * @bitrate: the bitrate for which to find the basic rate
5133 * Return: The basic rate corresponding to a given bitrate, that
5134 * is the next lower bitrate contained in the basic rate map,
5135 * which is, for this function, given as a bitmap of indices of
5136 * rates in the band's bitrate table.
5138 struct ieee80211_rate *
5139 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5140 u32 basic_rates, int bitrate);
5143 * ieee80211_mandatory_rates - get mandatory rates for a given band
5144 * @sband: the band to look for rates in
5145 * @scan_width: width of the control channel
5147 * This function returns a bitmap of the mandatory rates for the given
5148 * band, bits are set according to the rate position in the bitrates array.
5150 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5151 enum nl80211_bss_scan_width scan_width);
5154 * Radiotap parsing functions -- for controlled injection support
5156 * Implemented in net/wireless/radiotap.c
5157 * Documentation in Documentation/networking/radiotap-headers.txt
5160 struct radiotap_align_size {
5161 uint8_t align:4, size:4;
5164 struct ieee80211_radiotap_namespace {
5165 const struct radiotap_align_size *align_size;
5171 struct ieee80211_radiotap_vendor_namespaces {
5172 const struct ieee80211_radiotap_namespace *ns;
5177 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5178 * @this_arg_index: index of current arg, valid after each successful call
5179 * to ieee80211_radiotap_iterator_next()
5180 * @this_arg: pointer to current radiotap arg; it is valid after each
5181 * call to ieee80211_radiotap_iterator_next() but also after
5182 * ieee80211_radiotap_iterator_init() where it will point to
5183 * the beginning of the actual data portion
5184 * @this_arg_size: length of the current arg, for convenience
5185 * @current_namespace: pointer to the current namespace definition
5186 * (or internally %NULL if the current namespace is unknown)
5187 * @is_radiotap_ns: indicates whether the current namespace is the default
5188 * radiotap namespace or not
5190 * @_rtheader: pointer to the radiotap header we are walking through
5191 * @_max_length: length of radiotap header in cpu byte ordering
5192 * @_arg_index: next argument index
5193 * @_arg: next argument pointer
5194 * @_next_bitmap: internal pointer to next present u32
5195 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5196 * @_vns: vendor namespace definitions
5197 * @_next_ns_data: beginning of the next namespace's data
5198 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5201 * Describes the radiotap parser state. Fields prefixed with an underscore
5202 * must not be used by users of the parser, only by the parser internally.
5205 struct ieee80211_radiotap_iterator {
5206 struct ieee80211_radiotap_header *_rtheader;
5207 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5208 const struct ieee80211_radiotap_namespace *current_namespace;
5210 unsigned char *_arg, *_next_ns_data;
5211 __le32 *_next_bitmap;
5213 unsigned char *this_arg;
5221 uint32_t _bitmap_shifter;
5226 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5227 struct ieee80211_radiotap_header *radiotap_header,
5229 const struct ieee80211_radiotap_vendor_namespaces *vns);
5232 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5235 extern const unsigned char rfc1042_header[6];
5236 extern const unsigned char bridge_tunnel_header[6];
5239 * ieee80211_get_hdrlen_from_skb - get header length from data
5243 * Given an skb with a raw 802.11 header at the data pointer this function
5244 * returns the 802.11 header length.
5246 * Return: The 802.11 header length in bytes (not including encryption
5247 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5250 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5253 * ieee80211_hdrlen - get header length in bytes from frame control
5254 * @fc: frame control field in little-endian format
5255 * Return: The header length in bytes.
5257 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5260 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5261 * @meshhdr: the mesh extension header, only the flags field
5262 * (first byte) will be accessed
5263 * Return: The length of the extension header, which is always at
5264 * least 6 bytes and at most 18 if address 5 and 6 are present.
5266 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5269 * DOC: Data path helpers
5271 * In addition to generic utilities, cfg80211 also offers
5272 * functions that help implement the data path for devices
5273 * that do not do the 802.11/802.3 conversion on the device.
5277 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5278 * @skb: the 802.11 data frame
5279 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5280 * of it being pushed into the SKB
5281 * @addr: the device MAC address
5282 * @iftype: the virtual interface type
5283 * @data_offset: offset of payload after the 802.11 header
5284 * Return: 0 on success. Non-zero on error.
5286 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5287 const u8 *addr, enum nl80211_iftype iftype,
5291 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5292 * @skb: the 802.11 data frame
5293 * @addr: the device MAC address
5294 * @iftype: the virtual interface type
5295 * Return: 0 on success. Non-zero on error.
5297 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5298 enum nl80211_iftype iftype)
5300 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5304 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5306 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5307 * The @list will be empty if the decode fails. The @skb must be fully
5308 * header-less before being passed in here; it is freed in this function.
5310 * @skb: The input A-MSDU frame without any headers.
5311 * @list: The output list of 802.3 frames. It must be allocated and
5312 * initialized by by the caller.
5313 * @addr: The device MAC address.
5314 * @iftype: The device interface type.
5315 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5316 * @check_da: DA to check in the inner ethernet header, or NULL
5317 * @check_sa: SA to check in the inner ethernet header, or NULL
5319 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5320 const u8 *addr, enum nl80211_iftype iftype,
5321 const unsigned int extra_headroom,
5322 const u8 *check_da, const u8 *check_sa);
5325 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5326 * @skb: the data frame
5327 * @qos_map: Interworking QoS mapping or %NULL if not in use
5328 * Return: The 802.1p/1d tag.
5330 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5331 struct cfg80211_qos_map *qos_map);
5334 * cfg80211_find_elem_match - match information element and byte array in data
5337 * @ies: data consisting of IEs
5338 * @len: length of data
5339 * @match: byte array to match
5340 * @match_len: number of bytes in the match array
5341 * @match_offset: offset in the IE data where the byte array should match.
5342 * Note the difference to cfg80211_find_ie_match() which considers
5343 * the offset to start from the element ID byte, but here we take
5344 * the data portion instead.
5346 * Return: %NULL if the element ID could not be found or if
5347 * the element is invalid (claims to be longer than the given
5348 * data) or if the byte array doesn't match; otherwise return the
5349 * requested element struct.
5351 * Note: There are no checks on the element length other than
5352 * having to fit into the given data and being large enough for the
5353 * byte array to match.
5355 const struct element *
5356 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5357 const u8 *match, unsigned int match_len,
5358 unsigned int match_offset);
5361 * cfg80211_find_ie_match - match information element and byte array in data
5364 * @ies: data consisting of IEs
5365 * @len: length of data
5366 * @match: byte array to match
5367 * @match_len: number of bytes in the match array
5368 * @match_offset: offset in the IE where the byte array should match.
5369 * If match_len is zero, this must also be set to zero.
5370 * Otherwise this must be set to 2 or more, because the first
5371 * byte is the element id, which is already compared to eid, and
5372 * the second byte is the IE length.
5374 * Return: %NULL if the element ID could not be found or if
5375 * the element is invalid (claims to be longer than the given
5376 * data) or if the byte array doesn't match, or a pointer to the first
5377 * byte of the requested element, that is the byte containing the
5380 * Note: There are no checks on the element length other than
5381 * having to fit into the given data and being large enough for the
5382 * byte array to match.
5384 static inline const u8 *
5385 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5386 const u8 *match, unsigned int match_len,
5387 unsigned int match_offset)
5389 /* match_offset can't be smaller than 2, unless match_len is
5390 * zero, in which case match_offset must be zero as well.
5392 if (WARN_ON((match_len && match_offset < 2) ||
5393 (!match_len && match_offset)))
5396 return (void *)cfg80211_find_elem_match(eid, ies, len,
5399 match_offset - 2 : 0);
5403 * cfg80211_find_elem - find information element in data
5406 * @ies: data consisting of IEs
5407 * @len: length of data
5409 * Return: %NULL if the element ID could not be found or if
5410 * the element is invalid (claims to be longer than the given
5411 * data) or if the byte array doesn't match; otherwise return the
5412 * requested element struct.
5414 * Note: There are no checks on the element length other than
5415 * having to fit into the given data.
5417 static inline const struct element *
5418 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5420 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5424 * cfg80211_find_ie - find information element in data
5427 * @ies: data consisting of IEs
5428 * @len: length of data
5430 * Return: %NULL if the element ID could not be found or if
5431 * the element is invalid (claims to be longer than the given
5432 * data), or a pointer to the first byte of the requested
5433 * element, that is the byte containing the element ID.
5435 * Note: There are no checks on the element length other than
5436 * having to fit into the given data.
5438 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5440 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5444 * cfg80211_find_ext_elem - find information element with EID Extension in data
5446 * @ext_eid: element ID Extension
5447 * @ies: data consisting of IEs
5448 * @len: length of data
5450 * Return: %NULL if the etended element could not be found or if
5451 * the element is invalid (claims to be longer than the given
5452 * data) or if the byte array doesn't match; otherwise return the
5453 * requested element struct.
5455 * Note: There are no checks on the element length other than
5456 * having to fit into the given data.
5458 static inline const struct element *
5459 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5461 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5466 * cfg80211_find_ext_ie - find information element with EID Extension in data
5468 * @ext_eid: element ID Extension
5469 * @ies: data consisting of IEs
5470 * @len: length of data
5472 * Return: %NULL if the extended element ID could not be found or if
5473 * the element is invalid (claims to be longer than the given
5474 * data), or a pointer to the first byte of the requested
5475 * element, that is the byte containing the element ID.
5477 * Note: There are no checks on the element length other than
5478 * having to fit into the given data.
5480 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5482 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5487 * cfg80211_find_vendor_elem - find vendor specific information element in data
5490 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5491 * @ies: data consisting of IEs
5492 * @len: length of data
5494 * Return: %NULL if the vendor specific element ID could not be found or if the
5495 * element is invalid (claims to be longer than the given data); otherwise
5496 * return the element structure for the requested element.
5498 * Note: There are no checks on the element length other than having to fit into
5501 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5506 * cfg80211_find_vendor_ie - find vendor specific information element in data
5509 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5510 * @ies: data consisting of IEs
5511 * @len: length of data
5513 * Return: %NULL if the vendor specific element ID could not be found or if the
5514 * element is invalid (claims to be longer than the given data), or a pointer to
5515 * the first byte of the requested element, that is the byte containing the
5518 * Note: There are no checks on the element length other than having to fit into
5521 static inline const u8 *
5522 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5523 const u8 *ies, unsigned int len)
5525 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5529 * cfg80211_send_layer2_update - send layer 2 update frame
5531 * @dev: network device
5532 * @addr: STA MAC address
5534 * Wireless drivers can use this function to update forwarding tables in bridge
5535 * devices upon STA association.
5537 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5540 * DOC: Regulatory enforcement infrastructure
5546 * regulatory_hint - driver hint to the wireless core a regulatory domain
5547 * @wiphy: the wireless device giving the hint (used only for reporting
5549 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5550 * should be in. If @rd is set this should be NULL. Note that if you
5551 * set this to NULL you should still set rd->alpha2 to some accepted
5554 * Wireless drivers can use this function to hint to the wireless core
5555 * what it believes should be the current regulatory domain by
5556 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5557 * domain should be in or by providing a completely build regulatory domain.
5558 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5559 * for a regulatory domain structure for the respective country.
5561 * The wiphy must have been registered to cfg80211 prior to this call.
5562 * For cfg80211 drivers this means you must first use wiphy_register(),
5563 * for mac80211 drivers you must first use ieee80211_register_hw().
5565 * Drivers should check the return value, its possible you can get
5568 * Return: 0 on success. -ENOMEM.
5570 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5573 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5574 * @wiphy: the wireless device we want to process the regulatory domain on
5575 * @rd: the regulatory domain informatoin to use for this wiphy
5577 * Set the regulatory domain information for self-managed wiphys, only they
5578 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5581 * Return: 0 on success. -EINVAL, -EPERM
5583 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5584 struct ieee80211_regdomain *rd);
5587 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5588 * @wiphy: the wireless device we want to process the regulatory domain on
5589 * @rd: the regulatory domain information to use for this wiphy
5591 * This functions requires the RTNL to be held and applies the new regdomain
5592 * synchronously to this wiphy. For more details see
5593 * regulatory_set_wiphy_regd().
5595 * Return: 0 on success. -EINVAL, -EPERM
5597 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5598 struct ieee80211_regdomain *rd);
5601 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5602 * @wiphy: the wireless device we want to process the regulatory domain on
5603 * @regd: the custom regulatory domain to use for this wiphy
5605 * Drivers can sometimes have custom regulatory domains which do not apply
5606 * to a specific country. Drivers can use this to apply such custom regulatory
5607 * domains. This routine must be called prior to wiphy registration. The
5608 * custom regulatory domain will be trusted completely and as such previous
5609 * default channel settings will be disregarded. If no rule is found for a
5610 * channel on the regulatory domain the channel will be disabled.
5611 * Drivers using this for a wiphy should also set the wiphy flag
5612 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5613 * that called this helper.
5615 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5616 const struct ieee80211_regdomain *regd);
5619 * freq_reg_info - get regulatory information for the given frequency
5620 * @wiphy: the wiphy for which we want to process this rule for
5621 * @center_freq: Frequency in KHz for which we want regulatory information for
5623 * Use this function to get the regulatory rule for a specific frequency on
5624 * a given wireless device. If the device has a specific regulatory domain
5625 * it wants to follow we respect that unless a country IE has been received
5626 * and processed already.
5628 * Return: A valid pointer, or, when an error occurs, for example if no rule
5629 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5630 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5631 * value will be -ERANGE if we determine the given center_freq does not even
5632 * have a regulatory rule for a frequency range in the center_freq's band.
5633 * See freq_in_rule_band() for our current definition of a band -- this is
5634 * purely subjective and right now it's 802.11 specific.
5636 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5640 * reg_initiator_name - map regulatory request initiator enum to name
5641 * @initiator: the regulatory request initiator
5643 * You can use this to map the regulatory request initiator enum to a
5644 * proper string representation.
5646 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5649 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
5650 * @wiphy: wiphy for which pre-CAC capability is checked.
5652 * Pre-CAC is allowed only in some regdomains (notable ETSI).
5654 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
5657 * DOC: Internal regulatory db functions
5662 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
5663 * Regulatory self-managed driver can use it to proactively
5665 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5666 * @freq: the freqency(in MHz) to be queried.
5667 * @rule: pointer to store the wmm rule from the regulatory db.
5669 * Self-managed wireless drivers can use this function to query
5670 * the internal regulatory database to check whether the given
5671 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5673 * Drivers should check the return value, its possible you can get
5676 * Return: 0 on success. -ENODATA.
5678 int reg_query_regdb_wmm(char *alpha2, int freq,
5679 struct ieee80211_reg_rule *rule);
5682 * callbacks for asynchronous cfg80211 methods, notification
5683 * functions and BSS handling helpers
5687 * cfg80211_scan_done - notify that scan finished
5689 * @request: the corresponding scan request
5690 * @info: information about the completed scan
5692 void cfg80211_scan_done(struct cfg80211_scan_request *request,
5693 struct cfg80211_scan_info *info);
5696 * cfg80211_sched_scan_results - notify that new scan results are available
5698 * @wiphy: the wiphy which got scheduled scan results
5699 * @reqid: identifier for the related scheduled scan request
5701 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
5704 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5706 * @wiphy: the wiphy on which the scheduled scan stopped
5707 * @reqid: identifier for the related scheduled scan request
5709 * The driver can call this function to inform cfg80211 that the
5710 * scheduled scan had to be stopped, for whatever reason. The driver
5711 * is then called back via the sched_scan_stop operation when done.
5713 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
5716 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5718 * @wiphy: the wiphy on which the scheduled scan stopped
5719 * @reqid: identifier for the related scheduled scan request
5721 * The driver can call this function to inform cfg80211 that the
5722 * scheduled scan had to be stopped, for whatever reason. The driver
5723 * is then called back via the sched_scan_stop operation when done.
5724 * This function should be called with rtnl locked.
5726 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
5729 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5730 * @wiphy: the wiphy reporting the BSS
5731 * @data: the BSS metadata
5732 * @mgmt: the management frame (probe response or beacon)
5733 * @len: length of the management frame
5734 * @gfp: context flags
5736 * This informs cfg80211 that BSS information was found and
5737 * the BSS should be updated/added.
5739 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5740 * Or %NULL on error.
5742 struct cfg80211_bss * __must_check
5743 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
5744 struct cfg80211_inform_bss *data,
5745 struct ieee80211_mgmt *mgmt, size_t len,
5748 static inline struct cfg80211_bss * __must_check
5749 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
5750 struct ieee80211_channel *rx_channel,
5751 enum nl80211_bss_scan_width scan_width,
5752 struct ieee80211_mgmt *mgmt, size_t len,
5753 s32 signal, gfp_t gfp)
5755 struct cfg80211_inform_bss data = {
5757 .scan_width = scan_width,
5761 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5764 static inline struct cfg80211_bss * __must_check
5765 cfg80211_inform_bss_frame(struct wiphy *wiphy,
5766 struct ieee80211_channel *rx_channel,
5767 struct ieee80211_mgmt *mgmt, size_t len,
5768 s32 signal, gfp_t gfp)
5770 struct cfg80211_inform_bss data = {
5772 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5776 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5780 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5781 * @bssid: transmitter BSSID
5782 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5783 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5784 * @new_bssid: calculated nontransmitted BSSID
5786 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
5787 u8 mbssid_index, u8 *new_bssid)
5789 u64 bssid_u64 = ether_addr_to_u64(bssid);
5790 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
5793 new_bssid_u64 = bssid_u64 & ~mask;
5795 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
5797 u64_to_ether_addr(new_bssid_u64, new_bssid);
5801 * cfg80211_is_element_inherited - returns if element ID should be inherited
5802 * @element: element to check
5803 * @non_inherit_element: non inheritance element
5805 bool cfg80211_is_element_inherited(const struct element *element,
5806 const struct element *non_inherit_element);
5809 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
5811 * @ielen: length of IEs
5812 * @mbssid_elem: current MBSSID element
5813 * @sub_elem: current MBSSID subelement (profile)
5814 * @merged_ie: location of the merged profile
5815 * @max_copy_len: max merged profile length
5817 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
5818 const struct element *mbssid_elem,
5819 const struct element *sub_elem,
5820 u8 *merged_ie, size_t max_copy_len);
5823 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
5824 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
5825 * from a beacon or probe response
5826 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
5827 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
5829 enum cfg80211_bss_frame_type {
5830 CFG80211_BSS_FTYPE_UNKNOWN,
5831 CFG80211_BSS_FTYPE_BEACON,
5832 CFG80211_BSS_FTYPE_PRESP,
5836 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
5838 * @wiphy: the wiphy reporting the BSS
5839 * @data: the BSS metadata
5840 * @ftype: frame type (if known)
5841 * @bssid: the BSSID of the BSS
5842 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5843 * @capability: the capability field sent by the peer
5844 * @beacon_interval: the beacon interval announced by the peer
5845 * @ie: additional IEs sent by the peer
5846 * @ielen: length of the additional IEs
5847 * @gfp: context flags
5849 * This informs cfg80211 that BSS information was found and
5850 * the BSS should be updated/added.
5852 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5853 * Or %NULL on error.
5855 struct cfg80211_bss * __must_check
5856 cfg80211_inform_bss_data(struct wiphy *wiphy,
5857 struct cfg80211_inform_bss *data,
5858 enum cfg80211_bss_frame_type ftype,
5859 const u8 *bssid, u64 tsf, u16 capability,
5860 u16 beacon_interval, const u8 *ie, size_t ielen,
5863 static inline struct cfg80211_bss * __must_check
5864 cfg80211_inform_bss_width(struct wiphy *wiphy,
5865 struct ieee80211_channel *rx_channel,
5866 enum nl80211_bss_scan_width scan_width,
5867 enum cfg80211_bss_frame_type ftype,
5868 const u8 *bssid, u64 tsf, u16 capability,
5869 u16 beacon_interval, const u8 *ie, size_t ielen,
5870 s32 signal, gfp_t gfp)
5872 struct cfg80211_inform_bss data = {
5874 .scan_width = scan_width,
5878 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5879 capability, beacon_interval, ie, ielen,
5883 static inline struct cfg80211_bss * __must_check
5884 cfg80211_inform_bss(struct wiphy *wiphy,
5885 struct ieee80211_channel *rx_channel,
5886 enum cfg80211_bss_frame_type ftype,
5887 const u8 *bssid, u64 tsf, u16 capability,
5888 u16 beacon_interval, const u8 *ie, size_t ielen,
5889 s32 signal, gfp_t gfp)
5891 struct cfg80211_inform_bss data = {
5893 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5897 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5898 capability, beacon_interval, ie, ielen,
5903 * cfg80211_get_bss - get a BSS reference
5904 * @wiphy: the wiphy this BSS struct belongs to
5905 * @channel: the channel to search on (or %NULL)
5906 * @bssid: the desired BSSID (or %NULL)
5907 * @ssid: the desired SSID (or %NULL)
5908 * @ssid_len: length of the SSID (or 0)
5909 * @bss_type: type of BSS, see &enum ieee80211_bss_type
5910 * @privacy: privacy filter, see &enum ieee80211_privacy
5912 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
5913 struct ieee80211_channel *channel,
5915 const u8 *ssid, size_t ssid_len,
5916 enum ieee80211_bss_type bss_type,
5917 enum ieee80211_privacy privacy);
5918 static inline struct cfg80211_bss *
5919 cfg80211_get_ibss(struct wiphy *wiphy,
5920 struct ieee80211_channel *channel,
5921 const u8 *ssid, size_t ssid_len)
5923 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
5924 IEEE80211_BSS_TYPE_IBSS,
5925 IEEE80211_PRIVACY_ANY);
5929 * cfg80211_ref_bss - reference BSS struct
5930 * @wiphy: the wiphy this BSS struct belongs to
5931 * @bss: the BSS struct to reference
5933 * Increments the refcount of the given BSS struct.
5935 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5938 * cfg80211_put_bss - unref BSS struct
5939 * @wiphy: the wiphy this BSS struct belongs to
5940 * @bss: the BSS struct
5942 * Decrements the refcount of the given BSS struct.
5944 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5947 * cfg80211_unlink_bss - unlink BSS from internal data structures
5949 * @bss: the bss to remove
5951 * This function removes the given BSS from the internal data structures
5952 * thereby making it no longer show up in scan results etc. Use this
5953 * function when you detect a BSS is gone. Normally BSSes will also time
5954 * out, so it is not necessary to use this function at all.
5956 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5959 * cfg80211_bss_iter - iterate all BSS entries
5961 * This function iterates over the BSS entries associated with the given wiphy
5962 * and calls the callback for the iterated BSS. The iterator function is not
5963 * allowed to call functions that might modify the internal state of the BSS DB.
5966 * @chandef: if given, the iterator function will be called only if the channel
5967 * of the currently iterated BSS is a subset of the given channel.
5968 * @iter: the iterator function to call
5969 * @iter_data: an argument to the iterator function
5971 void cfg80211_bss_iter(struct wiphy *wiphy,
5972 struct cfg80211_chan_def *chandef,
5973 void (*iter)(struct wiphy *wiphy,
5974 struct cfg80211_bss *bss,
5978 static inline enum nl80211_bss_scan_width
5979 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5981 switch (chandef->width) {
5982 case NL80211_CHAN_WIDTH_5:
5983 return NL80211_BSS_CHAN_WIDTH_5;
5984 case NL80211_CHAN_WIDTH_10:
5985 return NL80211_BSS_CHAN_WIDTH_10;
5987 return NL80211_BSS_CHAN_WIDTH_20;
5992 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5993 * @dev: network device
5994 * @buf: authentication frame (header + body)
5995 * @len: length of the frame data
5997 * This function is called whenever an authentication, disassociation or
5998 * deauthentication frame has been received and processed in station mode.
5999 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6000 * call either this function or cfg80211_auth_timeout().
6001 * After being asked to associate via cfg80211_ops::assoc() the driver must
6002 * call either this function or cfg80211_auth_timeout().
6003 * While connected, the driver must calls this for received and processed
6004 * disassociation and deauthentication frames. If the frame couldn't be used
6005 * because it was unprotected, the driver must call the function
6006 * cfg80211_rx_unprot_mlme_mgmt() instead.
6008 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6010 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6013 * cfg80211_auth_timeout - notification of timed out authentication
6014 * @dev: network device
6015 * @addr: The MAC address of the device with which the authentication timed out
6017 * This function may sleep. The caller must hold the corresponding wdev's
6020 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6023 * cfg80211_rx_assoc_resp - notification of processed association response
6024 * @dev: network device
6025 * @bss: the BSS that association was requested with, ownership of the pointer
6026 * moves to cfg80211 in this call
6027 * @buf: (Re)Association Response frame (header + body)
6028 * @len: length of the frame data
6029 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6030 * as the AC bitmap in the QoS info field
6031 * @req_ies: information elements from the (Re)Association Request frame
6032 * @req_ies_len: length of req_ies data
6034 * After being asked to associate via cfg80211_ops::assoc() the driver must
6035 * call either this function or cfg80211_auth_timeout().
6037 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6039 void cfg80211_rx_assoc_resp(struct net_device *dev,
6040 struct cfg80211_bss *bss,
6041 const u8 *buf, size_t len,
6043 const u8 *req_ies, size_t req_ies_len);
6046 * cfg80211_assoc_timeout - notification of timed out association
6047 * @dev: network device
6048 * @bss: The BSS entry with which association timed out.
6050 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6052 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6055 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6056 * @dev: network device
6057 * @bss: The BSS entry with which association was abandoned.
6059 * Call this whenever - for reasons reported through other API, like deauth RX,
6060 * an association attempt was abandoned.
6061 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6063 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6066 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6067 * @dev: network device
6068 * @buf: 802.11 frame (header + body)
6069 * @len: length of the frame data
6071 * This function is called whenever deauthentication has been processed in
6072 * station mode. This includes both received deauthentication frames and
6073 * locally generated ones. This function may sleep. The caller must hold the
6074 * corresponding wdev's mutex.
6076 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6079 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6080 * @dev: network device
6081 * @buf: deauthentication frame (header + body)
6082 * @len: length of the frame data
6084 * This function is called whenever a received deauthentication or dissassoc
6085 * frame has been dropped in station mode because of MFP being used but the
6086 * frame was not protected. This function may sleep.
6088 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6089 const u8 *buf, size_t len);
6092 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6093 * @dev: network device
6094 * @addr: The source MAC address of the frame
6095 * @key_type: The key type that the received frame used
6096 * @key_id: Key identifier (0..3). Can be -1 if missing.
6097 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6098 * @gfp: allocation flags
6100 * This function is called whenever the local MAC detects a MIC failure in a
6101 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6104 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6105 enum nl80211_key_type key_type, int key_id,
6106 const u8 *tsc, gfp_t gfp);
6109 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6111 * @dev: network device
6112 * @bssid: the BSSID of the IBSS joined
6113 * @channel: the channel of the IBSS joined
6114 * @gfp: allocation flags
6116 * This function notifies cfg80211 that the device joined an IBSS or
6117 * switched to a different BSSID. Before this function can be called,
6118 * either a beacon has to have been received from the IBSS, or one of
6119 * the cfg80211_inform_bss{,_frame} functions must have been called
6120 * with the locally generated beacon -- this guarantees that there is
6121 * always a scan result for this IBSS. cfg80211 will handle the rest.
6123 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6124 struct ieee80211_channel *channel, gfp_t gfp);
6127 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
6129 * @dev: network device
6130 * @macaddr: the MAC address of the new candidate
6131 * @ie: information elements advertised by the peer candidate
6132 * @ie_len: length of the information elements buffer
6133 * @gfp: allocation flags
6135 * This function notifies cfg80211 that the mesh peer candidate has been
6136 * detected, most likely via a beacon or, less likely, via a probe response.
6137 * cfg80211 then sends a notification to userspace.
6139 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6140 const u8 *macaddr, const u8 *ie, u8 ie_len,
6141 int sig_dbm, gfp_t gfp);
6144 * DOC: RFkill integration
6146 * RFkill integration in cfg80211 is almost invisible to drivers,
6147 * as cfg80211 automatically registers an rfkill instance for each
6148 * wireless device it knows about. Soft kill is also translated
6149 * into disconnecting and turning all interfaces off, drivers are
6150 * expected to turn off the device when all interfaces are down.
6152 * However, devices may have a hard RFkill line, in which case they
6153 * also need to interact with the rfkill subsystem, via cfg80211.
6154 * They can do this with a few helper functions documented here.
6158 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6160 * @blocked: block status
6162 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
6165 * wiphy_rfkill_start_polling - start polling rfkill
6168 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6171 * wiphy_rfkill_stop_polling - stop polling rfkill
6174 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
6177 * DOC: Vendor commands
6179 * Occasionally, there are special protocol or firmware features that
6180 * can't be implemented very openly. For this and similar cases, the
6181 * vendor command functionality allows implementing the features with
6182 * (typically closed-source) userspace and firmware, using nl80211 as
6183 * the configuration mechanism.
6185 * A driver supporting vendor commands must register them as an array
6186 * in struct wiphy, with handlers for each one, each command has an
6187 * OUI and sub command ID to identify it.
6189 * Note that this feature should not be (ab)used to implement protocol
6190 * features that could openly be shared across drivers. In particular,
6191 * it must never be required to use vendor commands to implement any
6192 * "normal" functionality that higher-level userspace like connection
6193 * managers etc. need.
6196 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6197 enum nl80211_commands cmd,
6198 enum nl80211_attrs attr,
6201 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6202 struct wireless_dev *wdev,
6203 enum nl80211_commands cmd,
6204 enum nl80211_attrs attr,
6205 unsigned int portid,
6206 int vendor_event_idx,
6207 int approxlen, gfp_t gfp);
6209 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6212 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6214 * @approxlen: an upper bound of the length of the data that will
6215 * be put into the skb
6217 * This function allocates and pre-fills an skb for a reply to
6218 * a vendor command. Since it is intended for a reply, calling
6219 * it outside of a vendor command's doit() operation is invalid.
6221 * The returned skb is pre-filled with some identifying data in
6222 * a way that any data that is put into the skb (with skb_put(),
6223 * nla_put() or similar) will end up being within the
6224 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6225 * with the skb is adding data for the corresponding userspace tool
6226 * which can then read that data out of the vendor data attribute.
6227 * You must not modify the skb in any other way.
6229 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6230 * its error code as the result of the doit() operation.
6232 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6234 static inline struct sk_buff *
6235 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6237 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6238 NL80211_ATTR_VENDOR_DATA, approxlen);
6242 * cfg80211_vendor_cmd_reply - send the reply skb
6243 * @skb: The skb, must have been allocated with
6244 * cfg80211_vendor_cmd_alloc_reply_skb()
6246 * Since calling this function will usually be the last thing
6247 * before returning from the vendor command doit() you should
6248 * return the error code. Note that this function consumes the
6249 * skb regardless of the return value.
6251 * Return: An error code or 0 on success.
6253 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6256 * cfg80211_vendor_cmd_get_sender
6259 * Return the current netlink port ID in a vendor command handler.
6260 * Valid to call only there.
6262 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6265 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6267 * @wdev: the wireless device
6268 * @event_idx: index of the vendor event in the wiphy's vendor_events
6269 * @approxlen: an upper bound of the length of the data that will
6270 * be put into the skb
6271 * @gfp: allocation flags
6273 * This function allocates and pre-fills an skb for an event on the
6274 * vendor-specific multicast group.
6276 * If wdev != NULL, both the ifindex and identifier of the specified
6277 * wireless device are added to the event message before the vendor data
6280 * When done filling the skb, call cfg80211_vendor_event() with the
6281 * skb to send the event.
6283 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6285 static inline struct sk_buff *
6286 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6287 int approxlen, int event_idx, gfp_t gfp)
6289 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6290 NL80211_ATTR_VENDOR_DATA,
6291 0, event_idx, approxlen, gfp);
6295 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6297 * @wdev: the wireless device
6298 * @event_idx: index of the vendor event in the wiphy's vendor_events
6299 * @portid: port ID of the receiver
6300 * @approxlen: an upper bound of the length of the data that will
6301 * be put into the skb
6302 * @gfp: allocation flags
6304 * This function allocates and pre-fills an skb for an event to send to
6305 * a specific (userland) socket. This socket would previously have been
6306 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6307 * care to register a netlink notifier to see when the socket closes.
6309 * If wdev != NULL, both the ifindex and identifier of the specified
6310 * wireless device are added to the event message before the vendor data
6313 * When done filling the skb, call cfg80211_vendor_event() with the
6314 * skb to send the event.
6316 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6318 static inline struct sk_buff *
6319 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6320 struct wireless_dev *wdev,
6321 unsigned int portid, int approxlen,
6322 int event_idx, gfp_t gfp)
6324 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6325 NL80211_ATTR_VENDOR_DATA,
6326 portid, event_idx, approxlen, gfp);
6330 * cfg80211_vendor_event - send the event
6331 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6332 * @gfp: allocation flags
6334 * This function sends the given @skb, which must have been allocated
6335 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6337 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6339 __cfg80211_send_event_skb(skb, gfp);
6342 #ifdef CONFIG_NL80211_TESTMODE
6346 * Test mode is a set of utility functions to allow drivers to
6347 * interact with driver-specific tools to aid, for instance,
6348 * factory programming.
6350 * This chapter describes how drivers interact with it, for more
6351 * information see the nl80211 book's chapter on it.
6355 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6357 * @approxlen: an upper bound of the length of the data that will
6358 * be put into the skb
6360 * This function allocates and pre-fills an skb for a reply to
6361 * the testmode command. Since it is intended for a reply, calling
6362 * it outside of the @testmode_cmd operation is invalid.
6364 * The returned skb is pre-filled with the wiphy index and set up in
6365 * a way that any data that is put into the skb (with skb_put(),
6366 * nla_put() or similar) will end up being within the
6367 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6368 * with the skb is adding data for the corresponding userspace tool
6369 * which can then read that data out of the testdata attribute. You
6370 * must not modify the skb in any other way.
6372 * When done, call cfg80211_testmode_reply() with the skb and return
6373 * its error code as the result of the @testmode_cmd operation.
6375 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6377 static inline struct sk_buff *
6378 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6380 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6381 NL80211_ATTR_TESTDATA, approxlen);
6385 * cfg80211_testmode_reply - send the reply skb
6386 * @skb: The skb, must have been allocated with
6387 * cfg80211_testmode_alloc_reply_skb()
6389 * Since calling this function will usually be the last thing
6390 * before returning from the @testmode_cmd you should return
6391 * the error code. Note that this function consumes the skb
6392 * regardless of the return value.
6394 * Return: An error code or 0 on success.
6396 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6398 return cfg80211_vendor_cmd_reply(skb);
6402 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6404 * @approxlen: an upper bound of the length of the data that will
6405 * be put into the skb
6406 * @gfp: allocation flags
6408 * This function allocates and pre-fills an skb for an event on the
6409 * testmode multicast group.
6411 * The returned skb is set up in the same way as with
6412 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6413 * there, you should simply add data to it that will then end up in the
6414 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6417 * When done filling the skb, call cfg80211_testmode_event() with the
6418 * skb to send the event.
6420 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6422 static inline struct sk_buff *
6423 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6425 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6426 NL80211_ATTR_TESTDATA, 0, -1,
6431 * cfg80211_testmode_event - send the event
6432 * @skb: The skb, must have been allocated with
6433 * cfg80211_testmode_alloc_event_skb()
6434 * @gfp: allocation flags
6436 * This function sends the given @skb, which must have been allocated
6437 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6440 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6442 __cfg80211_send_event_skb(skb, gfp);
6445 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6446 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6448 #define CFG80211_TESTMODE_CMD(cmd)
6449 #define CFG80211_TESTMODE_DUMP(cmd)
6453 * struct cfg80211_fils_resp_params - FILS connection response params
6454 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6455 * @kek_len: Length of @fils_kek in octets
6456 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6457 * @erp_next_seq_num is valid.
6458 * @erp_next_seq_num: The next sequence number to use in ERP message in
6459 * FILS Authentication. This value should be specified irrespective of the
6460 * status for a FILS connection.
6461 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6462 * @pmk_len: Length of @pmk in octets
6463 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6464 * used for this FILS connection (may be %NULL).
6466 struct cfg80211_fils_resp_params {
6469 bool update_erp_next_seq_num;
6470 u16 erp_next_seq_num;
6477 * struct cfg80211_connect_resp_params - Connection response params
6478 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6479 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6480 * the real status code for failures. If this call is used to report a
6481 * failure due to a timeout (e.g., not receiving an Authentication frame
6482 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6483 * indicate that this is a failure, but without a status code.
6484 * @timeout_reason is used to report the reason for the timeout in that
6486 * @bssid: The BSSID of the AP (may be %NULL)
6487 * @bss: Entry of bss to which STA got connected to, can be obtained through
6488 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6489 * bss from the connect_request and hold a reference to it and return
6490 * through this param to avoid a warning if the bss is expired during the
6491 * connection, esp. for those drivers implementing connect op.
6492 * Only one parameter among @bssid and @bss needs to be specified.
6493 * @req_ie: Association request IEs (may be %NULL)
6494 * @req_ie_len: Association request IEs length
6495 * @resp_ie: Association response IEs (may be %NULL)
6496 * @resp_ie_len: Association response IEs length
6497 * @fils: FILS connection response parameters.
6498 * @timeout_reason: Reason for connection timeout. This is used when the
6499 * connection fails due to a timeout instead of an explicit rejection from
6500 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6501 * not known. This value is used only if @status < 0 to indicate that the
6502 * failure is due to a timeout and not due to explicit rejection by the AP.
6503 * This value is ignored in other cases (@status >= 0).
6505 struct cfg80211_connect_resp_params {
6508 struct cfg80211_bss *bss;
6513 struct cfg80211_fils_resp_params fils;
6514 enum nl80211_timeout_reason timeout_reason;
6518 * cfg80211_connect_done - notify cfg80211 of connection result
6520 * @dev: network device
6521 * @params: connection response parameters
6522 * @gfp: allocation flags
6524 * It should be called by the underlying driver once execution of the connection
6525 * request from connect() has been completed. This is similar to
6526 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6527 * parameters. Only one of the functions among cfg80211_connect_bss(),
6528 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6529 * and cfg80211_connect_done() should be called.
6531 void cfg80211_connect_done(struct net_device *dev,
6532 struct cfg80211_connect_resp_params *params,
6536 * cfg80211_connect_bss - notify cfg80211 of connection result
6538 * @dev: network device
6539 * @bssid: the BSSID of the AP
6540 * @bss: Entry of bss to which STA got connected to, can be obtained through
6541 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6542 * bss from the connect_request and hold a reference to it and return
6543 * through this param to avoid a warning if the bss is expired during the
6544 * connection, esp. for those drivers implementing connect op.
6545 * Only one parameter among @bssid and @bss needs to be specified.
6546 * @req_ie: association request IEs (maybe be %NULL)
6547 * @req_ie_len: association request IEs length
6548 * @resp_ie: association response IEs (may be %NULL)
6549 * @resp_ie_len: assoc response IEs length
6550 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6551 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6552 * the real status code for failures. If this call is used to report a
6553 * failure due to a timeout (e.g., not receiving an Authentication frame
6554 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6555 * indicate that this is a failure, but without a status code.
6556 * @timeout_reason is used to report the reason for the timeout in that
6558 * @gfp: allocation flags
6559 * @timeout_reason: reason for connection timeout. This is used when the
6560 * connection fails due to a timeout instead of an explicit rejection from
6561 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6562 * not known. This value is used only if @status < 0 to indicate that the
6563 * failure is due to a timeout and not due to explicit rejection by the AP.
6564 * This value is ignored in other cases (@status >= 0).
6566 * It should be called by the underlying driver once execution of the connection
6567 * request from connect() has been completed. This is similar to
6568 * cfg80211_connect_result(), but with the option of identifying the exact bss
6569 * entry for the connection. Only one of the functions among
6570 * cfg80211_connect_bss(), cfg80211_connect_result(),
6571 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6574 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6575 struct cfg80211_bss *bss, const u8 *req_ie,
6576 size_t req_ie_len, const u8 *resp_ie,
6577 size_t resp_ie_len, int status, gfp_t gfp,
6578 enum nl80211_timeout_reason timeout_reason)
6580 struct cfg80211_connect_resp_params params;
6582 memset(¶ms, 0, sizeof(params));
6583 params.status = status;
6584 params.bssid = bssid;
6586 params.req_ie = req_ie;
6587 params.req_ie_len = req_ie_len;
6588 params.resp_ie = resp_ie;
6589 params.resp_ie_len = resp_ie_len;
6590 params.timeout_reason = timeout_reason;
6592 cfg80211_connect_done(dev, ¶ms, gfp);
6596 * cfg80211_connect_result - notify cfg80211 of connection result
6598 * @dev: network device
6599 * @bssid: the BSSID of the AP
6600 * @req_ie: association request IEs (maybe be %NULL)
6601 * @req_ie_len: association request IEs length
6602 * @resp_ie: association response IEs (may be %NULL)
6603 * @resp_ie_len: assoc response IEs length
6604 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6605 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6606 * the real status code for failures.
6607 * @gfp: allocation flags
6609 * It should be called by the underlying driver once execution of the connection
6610 * request from connect() has been completed. This is similar to
6611 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6612 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6613 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6616 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6617 const u8 *req_ie, size_t req_ie_len,
6618 const u8 *resp_ie, size_t resp_ie_len,
6619 u16 status, gfp_t gfp)
6621 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6622 resp_ie_len, status, gfp,
6623 NL80211_TIMEOUT_UNSPECIFIED);
6627 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6629 * @dev: network device
6630 * @bssid: the BSSID of the AP
6631 * @req_ie: association request IEs (maybe be %NULL)
6632 * @req_ie_len: association request IEs length
6633 * @gfp: allocation flags
6634 * @timeout_reason: reason for connection timeout.
6636 * It should be called by the underlying driver whenever connect() has failed
6637 * in a sequence where no explicit authentication/association rejection was
6638 * received from the AP. This could happen, e.g., due to not being able to send
6639 * out the Authentication or Association Request frame or timing out while
6640 * waiting for the response. Only one of the functions among
6641 * cfg80211_connect_bss(), cfg80211_connect_result(),
6642 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6645 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6646 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6647 enum nl80211_timeout_reason timeout_reason)
6649 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6650 gfp, timeout_reason);
6654 * struct cfg80211_roam_info - driver initiated roaming information
6656 * @channel: the channel of the new AP
6657 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6658 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6659 * @req_ie: association request IEs (maybe be %NULL)
6660 * @req_ie_len: association request IEs length
6661 * @resp_ie: association response IEs (may be %NULL)
6662 * @resp_ie_len: assoc response IEs length
6663 * @fils: FILS related roaming information.
6665 struct cfg80211_roam_info {
6666 struct ieee80211_channel *channel;
6667 struct cfg80211_bss *bss;
6673 struct cfg80211_fils_resp_params fils;
6677 * cfg80211_roamed - notify cfg80211 of roaming
6679 * @dev: network device
6680 * @info: information about the new BSS. struct &cfg80211_roam_info.
6681 * @gfp: allocation flags
6683 * This function may be called with the driver passing either the BSSID of the
6684 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6685 * It should be called by the underlying driver whenever it roamed from one AP
6686 * to another while connected. Drivers which have roaming implemented in
6687 * firmware should pass the bss entry to avoid a race in bss entry timeout where
6688 * the bss entry of the new AP is seen in the driver, but gets timed out by the
6689 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6690 * rdev->event_work. In case of any failures, the reference is released
6691 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6692 * released while disconnecting from the current bss.
6694 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
6698 * cfg80211_port_authorized - notify cfg80211 of successful security association
6700 * @dev: network device
6701 * @bssid: the BSSID of the AP
6702 * @gfp: allocation flags
6704 * This function should be called by a driver that supports 4 way handshake
6705 * offload after a security association was successfully established (i.e.,
6706 * the 4 way handshake was completed successfully). The call to this function
6707 * should be preceded with a call to cfg80211_connect_result(),
6708 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6709 * indicate the 802.11 association.
6711 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
6715 * cfg80211_disconnected - notify cfg80211 that connection was dropped
6717 * @dev: network device
6718 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6719 * @ie_len: length of IEs
6720 * @reason: reason code for the disconnection, set it to 0 if unknown
6721 * @locally_generated: disconnection was requested locally
6722 * @gfp: allocation flags
6724 * After it calls this function, the driver should enter an idle state
6725 * and not try to connect to any AP any more.
6727 void cfg80211_disconnected(struct net_device *dev, u16 reason,
6728 const u8 *ie, size_t ie_len,
6729 bool locally_generated, gfp_t gfp);
6732 * cfg80211_ready_on_channel - notification of remain_on_channel start
6733 * @wdev: wireless device
6734 * @cookie: the request cookie
6735 * @chan: The current channel (from remain_on_channel request)
6736 * @duration: Duration in milliseconds that the driver intents to remain on the
6738 * @gfp: allocation flags
6740 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
6741 struct ieee80211_channel *chan,
6742 unsigned int duration, gfp_t gfp);
6745 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6746 * @wdev: wireless device
6747 * @cookie: the request cookie
6748 * @chan: The current channel (from remain_on_channel request)
6749 * @gfp: allocation flags
6751 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
6752 struct ieee80211_channel *chan,
6756 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
6757 * @wdev: wireless device
6758 * @cookie: the requested cookie
6759 * @chan: The current channel (from tx_mgmt request)
6760 * @gfp: allocation flags
6762 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
6763 struct ieee80211_channel *chan, gfp_t gfp);
6766 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6768 * @sinfo: the station information
6769 * @gfp: allocation flags
6771 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
6774 * cfg80211_sinfo_release_content - release contents of station info
6775 * @sinfo: the station information
6777 * Releases any potentially allocated sub-information of the station
6778 * information, but not the struct itself (since it's typically on
6781 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
6783 kfree(sinfo->pertid);
6787 * cfg80211_new_sta - notify userspace about station
6790 * @mac_addr: the station's address
6791 * @sinfo: the station information
6792 * @gfp: allocation flags
6794 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
6795 struct station_info *sinfo, gfp_t gfp);
6798 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6800 * @mac_addr: the station's address
6801 * @sinfo: the station information/statistics
6802 * @gfp: allocation flags
6804 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
6805 struct station_info *sinfo, gfp_t gfp);
6808 * cfg80211_del_sta - notify userspace about deletion of a station
6811 * @mac_addr: the station's address
6812 * @gfp: allocation flags
6814 static inline void cfg80211_del_sta(struct net_device *dev,
6815 const u8 *mac_addr, gfp_t gfp)
6817 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
6821 * cfg80211_conn_failed - connection request failed notification
6824 * @mac_addr: the station's address
6825 * @reason: the reason for connection failure
6826 * @gfp: allocation flags
6828 * Whenever a station tries to connect to an AP and if the station
6829 * could not connect to the AP as the AP has rejected the connection
6830 * for some reasons, this function is called.
6832 * The reason for connection failure can be any of the value from
6833 * nl80211_connect_failed_reason enum
6835 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
6836 enum nl80211_connect_failed_reason reason,
6840 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
6841 * @wdev: wireless device receiving the frame
6842 * @freq: Frequency on which the frame was received in MHz
6843 * @sig_dbm: signal strength in dBm, or 0 if unknown
6844 * @buf: Management frame (header + body)
6845 * @len: length of the frame data
6846 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
6848 * This function is called whenever an Action frame is received for a station
6849 * mode interface, but is not processed in kernel.
6851 * Return: %true if a user space application has registered for this frame.
6852 * For action frames, that makes it responsible for rejecting unrecognized
6853 * action frames; %false otherwise, in which case for action frames the
6854 * driver is responsible for rejecting the frame.
6856 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
6857 const u8 *buf, size_t len, u32 flags);
6860 * cfg80211_mgmt_tx_status - notification of TX status for management frame
6861 * @wdev: wireless device receiving the frame
6862 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
6863 * @buf: Management frame (header + body)
6864 * @len: length of the frame data
6865 * @ack: Whether frame was acknowledged
6866 * @gfp: context flags
6868 * This function is called whenever a management frame was requested to be
6869 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
6870 * transmission attempt.
6872 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
6873 const u8 *buf, size_t len, bool ack, gfp_t gfp);
6877 * cfg80211_rx_control_port - notification about a received control port frame
6878 * @dev: The device the frame matched to
6879 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
6880 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
6881 * This function does not take ownership of the skb, so the caller is
6882 * responsible for any cleanup. The caller must also ensure that
6883 * skb->protocol is set appropriately.
6884 * @unencrypted: Whether the frame was received unencrypted
6886 * This function is used to inform userspace about a received control port
6887 * frame. It should only be used if userspace indicated it wants to receive
6888 * control port frames over nl80211.
6890 * The frame is the data portion of the 802.3 or 802.11 data frame with all
6891 * network layer headers removed (e.g. the raw EAPoL frame).
6893 * Return: %true if the frame was passed to userspace
6895 bool cfg80211_rx_control_port(struct net_device *dev,
6896 struct sk_buff *skb, bool unencrypted);
6899 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
6900 * @dev: network device
6901 * @rssi_event: the triggered RSSI event
6902 * @rssi_level: new RSSI level value or 0 if not available
6903 * @gfp: context flags
6905 * This function is called when a configured connection quality monitoring
6906 * rssi threshold reached event occurs.
6908 void cfg80211_cqm_rssi_notify(struct net_device *dev,
6909 enum nl80211_cqm_rssi_threshold_event rssi_event,
6910 s32 rssi_level, gfp_t gfp);
6913 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
6914 * @dev: network device
6915 * @peer: peer's MAC address
6916 * @num_packets: how many packets were lost -- should be a fixed threshold
6917 * but probably no less than maybe 50, or maybe a throughput dependent
6918 * threshold (to account for temporary interference)
6919 * @gfp: context flags
6921 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
6922 const u8 *peer, u32 num_packets, gfp_t gfp);
6925 * cfg80211_cqm_txe_notify - TX error rate event
6926 * @dev: network device
6927 * @peer: peer's MAC address
6928 * @num_packets: how many packets were lost
6929 * @rate: % of packets which failed transmission
6930 * @intvl: interval (in s) over which the TX failure threshold was breached.
6931 * @gfp: context flags
6933 * Notify userspace when configured % TX failures over number of packets in a
6934 * given interval is exceeded.
6936 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
6937 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
6940 * cfg80211_cqm_beacon_loss_notify - beacon loss event
6941 * @dev: network device
6942 * @gfp: context flags
6944 * Notify userspace about beacon loss from the connected AP.
6946 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
6949 * cfg80211_radar_event - radar detection event
6951 * @chandef: chandef for the current channel
6952 * @gfp: context flags
6954 * This function is called when a radar is detected on the current chanenl.
6956 void cfg80211_radar_event(struct wiphy *wiphy,
6957 struct cfg80211_chan_def *chandef, gfp_t gfp);
6960 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6961 * @dev: network device
6962 * @mac: MAC address of a station which opmode got modified
6963 * @sta_opmode: station's current opmode value
6964 * @gfp: context flags
6966 * Driver should call this function when station's opmode modified via action
6969 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
6970 struct sta_opmode_info *sta_opmode,
6974 * cfg80211_cac_event - Channel availability check (CAC) event
6975 * @netdev: network device
6976 * @chandef: chandef for the current channel
6977 * @event: type of event
6978 * @gfp: context flags
6980 * This function is called when a Channel availability check (CAC) is finished
6981 * or aborted. This must be called to notify the completion of a CAC process,
6982 * also by full-MAC drivers.
6984 void cfg80211_cac_event(struct net_device *netdev,
6985 const struct cfg80211_chan_def *chandef,
6986 enum nl80211_radar_event event, gfp_t gfp);
6990 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6991 * @dev: network device
6992 * @bssid: BSSID of AP (to avoid races)
6993 * @replay_ctr: new replay counter
6994 * @gfp: allocation flags
6996 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
6997 const u8 *replay_ctr, gfp_t gfp);
7000 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7001 * @dev: network device
7002 * @index: candidate index (the smaller the index, the higher the priority)
7003 * @bssid: BSSID of AP
7004 * @preauth: Whether AP advertises support for RSN pre-authentication
7005 * @gfp: allocation flags
7007 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
7008 const u8 *bssid, bool preauth, gfp_t gfp);
7011 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7012 * @dev: The device the frame matched to
7013 * @addr: the transmitter address
7014 * @gfp: context flags
7016 * This function is used in AP mode (only!) to inform userspace that
7017 * a spurious class 3 frame was received, to be able to deauth the
7019 * Return: %true if the frame was passed to userspace (or this failed
7020 * for a reason other than not having a subscription.)
7022 bool cfg80211_rx_spurious_frame(struct net_device *dev,
7023 const u8 *addr, gfp_t gfp);
7026 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7027 * @dev: The device the frame matched to
7028 * @addr: the transmitter address
7029 * @gfp: context flags
7031 * This function is used in AP mode (only!) to inform userspace that
7032 * an associated station sent a 4addr frame but that wasn't expected.
7033 * It is allowed and desirable to send this event only once for each
7034 * station to avoid event flooding.
7035 * Return: %true if the frame was passed to userspace (or this failed
7036 * for a reason other than not having a subscription.)
7038 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
7039 const u8 *addr, gfp_t gfp);
7042 * cfg80211_probe_status - notify userspace about probe status
7043 * @dev: the device the probe was sent on
7044 * @addr: the address of the peer
7045 * @cookie: the cookie filled in @probe_client previously
7046 * @acked: indicates whether probe was acked or not
7047 * @ack_signal: signal strength (in dBm) of the ACK frame.
7048 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7049 * @gfp: allocation flags
7051 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
7052 u64 cookie, bool acked, s32 ack_signal,
7053 bool is_valid_ack_signal, gfp_t gfp);
7056 * cfg80211_report_obss_beacon - report beacon from other APs
7057 * @wiphy: The wiphy that received the beacon
7059 * @len: length of the frame
7060 * @freq: frequency the frame was received on
7061 * @sig_dbm: signal strength in dBm, or 0 if unknown
7063 * Use this function to report to userspace when a beacon was
7064 * received. It is not useful to call this when there is no
7065 * netdev that is in AP/GO mode.
7067 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7068 const u8 *frame, size_t len,
7069 int freq, int sig_dbm);
7072 * cfg80211_reg_can_beacon - check if beaconing is allowed
7074 * @chandef: the channel definition
7075 * @iftype: interface type
7077 * Return: %true if there is no secondary channel or the secondary channel(s)
7078 * can be used for beaconing (i.e. is not a radar channel etc.)
7080 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7081 struct cfg80211_chan_def *chandef,
7082 enum nl80211_iftype iftype);
7085 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7087 * @chandef: the channel definition
7088 * @iftype: interface type
7090 * Return: %true if there is no secondary channel or the secondary channel(s)
7091 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7092 * also checks if IR-relaxation conditions apply, to allow beaconing under
7093 * more permissive conditions.
7095 * Requires the RTNL to be held.
7097 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7098 struct cfg80211_chan_def *chandef,
7099 enum nl80211_iftype iftype);
7102 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7103 * @dev: the device which switched channels
7104 * @chandef: the new channel definition
7106 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7109 void cfg80211_ch_switch_notify(struct net_device *dev,
7110 struct cfg80211_chan_def *chandef);
7113 * cfg80211_ch_switch_started_notify - notify channel switch start
7114 * @dev: the device on which the channel switch started
7115 * @chandef: the future channel definition
7116 * @count: the number of TBTTs until the channel switch happens
7118 * Inform the userspace about the channel switch that has just
7119 * started, so that it can take appropriate actions (eg. starting
7120 * channel switch on other vifs), if necessary.
7122 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7123 struct cfg80211_chan_def *chandef,
7127 * ieee80211_operating_class_to_band - convert operating class to band
7129 * @operating_class: the operating class to convert
7130 * @band: band pointer to fill
7132 * Returns %true if the conversion was successful, %false otherwise.
7134 bool ieee80211_operating_class_to_band(u8 operating_class,
7135 enum nl80211_band *band);
7138 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7140 * @chandef: the chandef to convert
7141 * @op_class: a pointer to the resulting operating class
7143 * Returns %true if the conversion was successful, %false otherwise.
7145 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7149 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7150 * @dev: the device on which the operation is requested
7151 * @peer: the MAC address of the peer device
7152 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7153 * NL80211_TDLS_TEARDOWN)
7154 * @reason_code: the reason code for teardown request
7155 * @gfp: allocation flags
7157 * This function is used to request userspace to perform TDLS operation that
7158 * requires knowledge of keys, i.e., link setup or teardown when the AP
7159 * connection uses encryption. This is optional mechanism for the driver to use
7160 * if it can automatically determine when a TDLS link could be useful (e.g.,
7161 * based on traffic and signal strength for a peer).
7163 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7164 enum nl80211_tdls_operation oper,
7165 u16 reason_code, gfp_t gfp);
7168 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7169 * @rate: given rate_info to calculate bitrate from
7171 * return 0 if MCS index >= 32
7173 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7176 * cfg80211_unregister_wdev - remove the given wdev
7177 * @wdev: struct wireless_dev to remove
7179 * Call this function only for wdevs that have no netdev assigned,
7180 * e.g. P2P Devices. It removes the device from the list so that
7181 * it can no longer be used. It is necessary to call this function
7182 * even when cfg80211 requests the removal of the interface by
7183 * calling the del_virtual_intf() callback. The function must also
7184 * be called when the driver wishes to unregister the wdev, e.g.
7185 * when the device is unbound from the driver.
7187 * Requires the RTNL to be held.
7189 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7192 * struct cfg80211_ft_event - FT Information Elements
7194 * @ies_len: length of the FT IE in bytes
7195 * @target_ap: target AP's MAC address
7197 * @ric_ies_len: length of the RIC IE in bytes
7199 struct cfg80211_ft_event_params {
7202 const u8 *target_ap;
7208 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7209 * @netdev: network device
7210 * @ft_event: IE information
7212 void cfg80211_ft_event(struct net_device *netdev,
7213 struct cfg80211_ft_event_params *ft_event);
7216 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7217 * @ies: the input IE buffer
7218 * @len: the input length
7219 * @attr: the attribute ID to find
7220 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7221 * if the function is only called to get the needed buffer size
7222 * @bufsize: size of the output buffer
7224 * The function finds a given P2P attribute in the (vendor) IEs and
7225 * copies its contents to the given buffer.
7227 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7228 * malformed or the attribute can't be found (respectively), or the
7229 * length of the found attribute (which can be zero).
7231 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7232 enum ieee80211_p2p_attr_id attr,
7233 u8 *buf, unsigned int bufsize);
7236 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7237 * @ies: the IE buffer
7238 * @ielen: the length of the IE buffer
7239 * @ids: an array with element IDs that are allowed before
7240 * the split. A WLAN_EID_EXTENSION value means that the next
7241 * EID in the list is a sub-element of the EXTENSION IE.
7242 * @n_ids: the size of the element ID array
7243 * @after_ric: array IE types that come after the RIC element
7244 * @n_after_ric: size of the @after_ric array
7245 * @offset: offset where to start splitting in the buffer
7247 * This function splits an IE buffer by updating the @offset
7248 * variable to point to the location where the buffer should be
7251 * It assumes that the given IE buffer is well-formed, this
7252 * has to be guaranteed by the caller!
7254 * It also assumes that the IEs in the buffer are ordered
7255 * correctly, if not the result of using this function will not
7256 * be ordered correctly either, i.e. it does no reordering.
7258 * The function returns the offset where the next part of the
7259 * buffer starts, which may be @ielen if the entire (remainder)
7260 * of the buffer should be used.
7262 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7263 const u8 *ids, int n_ids,
7264 const u8 *after_ric, int n_after_ric,
7268 * ieee80211_ie_split - split an IE buffer according to ordering
7269 * @ies: the IE buffer
7270 * @ielen: the length of the IE buffer
7271 * @ids: an array with element IDs that are allowed before
7272 * the split. A WLAN_EID_EXTENSION value means that the next
7273 * EID in the list is a sub-element of the EXTENSION IE.
7274 * @n_ids: the size of the element ID array
7275 * @offset: offset where to start splitting in the buffer
7277 * This function splits an IE buffer by updating the @offset
7278 * variable to point to the location where the buffer should be
7281 * It assumes that the given IE buffer is well-formed, this
7282 * has to be guaranteed by the caller!
7284 * It also assumes that the IEs in the buffer are ordered
7285 * correctly, if not the result of using this function will not
7286 * be ordered correctly either, i.e. it does no reordering.
7288 * The function returns the offset where the next part of the
7289 * buffer starts, which may be @ielen if the entire (remainder)
7290 * of the buffer should be used.
7292 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7293 const u8 *ids, int n_ids, size_t offset)
7295 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7299 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7300 * @wdev: the wireless device reporting the wakeup
7301 * @wakeup: the wakeup report
7302 * @gfp: allocation flags
7304 * This function reports that the given device woke up. If it
7305 * caused the wakeup, report the reason(s), otherwise you may
7306 * pass %NULL as the @wakeup parameter to advertise that something
7307 * else caused the wakeup.
7309 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7310 struct cfg80211_wowlan_wakeup *wakeup,
7314 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7316 * @wdev: the wireless device for which critical protocol is stopped.
7317 * @gfp: allocation flags
7319 * This function can be called by the driver to indicate it has reverted
7320 * operation back to normal. One reason could be that the duration given
7321 * by .crit_proto_start() has expired.
7323 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7326 * ieee80211_get_num_supported_channels - get number of channels device has
7329 * Return: the number of channels supported by the device.
7331 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7334 * cfg80211_check_combinations - check interface combinations
7337 * @params: the interface combinations parameter
7339 * This function can be called by the driver to check whether a
7340 * combination of interfaces and their types are allowed according to
7341 * the interface combinations.
7343 int cfg80211_check_combinations(struct wiphy *wiphy,
7344 struct iface_combination_params *params);
7347 * cfg80211_iter_combinations - iterate over matching combinations
7350 * @params: the interface combinations parameter
7351 * @iter: function to call for each matching combination
7352 * @data: pointer to pass to iter function
7354 * This function can be called by the driver to check what possible
7355 * combinations it fits in at a given moment, e.g. for channel switching
7358 int cfg80211_iter_combinations(struct wiphy *wiphy,
7359 struct iface_combination_params *params,
7360 void (*iter)(const struct ieee80211_iface_combination *c,
7365 * cfg80211_stop_iface - trigger interface disconnection
7368 * @wdev: wireless device
7369 * @gfp: context flags
7371 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7374 * Note: This doesn't need any locks and is asynchronous.
7376 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7380 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7381 * @wiphy: the wiphy to shut down
7383 * This function shuts down all interfaces belonging to this wiphy by
7384 * calling dev_close() (and treating non-netdev interfaces as needed).
7385 * It shouldn't really be used unless there are some fatal device errors
7386 * that really can't be recovered in any other way.
7388 * Callers must hold the RTNL and be able to deal with callbacks into
7389 * the driver while the function is running.
7391 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7394 * wiphy_ext_feature_set - set the extended feature flag
7396 * @wiphy: the wiphy to modify.
7397 * @ftidx: extended feature bit index.
7399 * The extended features are flagged in multiple bytes (see
7400 * &struct wiphy.@ext_features)
7402 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7403 enum nl80211_ext_feature_index ftidx)
7407 ft_byte = &wiphy->ext_features[ftidx / 8];
7408 *ft_byte |= BIT(ftidx % 8);
7412 * wiphy_ext_feature_isset - check the extended feature flag
7414 * @wiphy: the wiphy to modify.
7415 * @ftidx: extended feature bit index.
7417 * The extended features are flagged in multiple bytes (see
7418 * &struct wiphy.@ext_features)
7421 wiphy_ext_feature_isset(struct wiphy *wiphy,
7422 enum nl80211_ext_feature_index ftidx)
7426 ft_byte = wiphy->ext_features[ftidx / 8];
7427 return (ft_byte & BIT(ftidx % 8)) != 0;
7431 * cfg80211_free_nan_func - free NAN function
7432 * @f: NAN function that should be freed
7434 * Frees all the NAN function and all it's allocated members.
7436 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7439 * struct cfg80211_nan_match_params - NAN match parameters
7440 * @type: the type of the function that triggered a match. If it is
7441 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7442 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7444 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7445 * @inst_id: the local instance id
7446 * @peer_inst_id: the instance id of the peer's function
7447 * @addr: the MAC address of the peer
7448 * @info_len: the length of the &info
7449 * @info: the Service Specific Info from the peer (if any)
7450 * @cookie: unique identifier of the corresponding function
7452 struct cfg80211_nan_match_params {
7453 enum nl80211_nan_function_type type;
7463 * cfg80211_nan_match - report a match for a NAN function.
7464 * @wdev: the wireless device reporting the match
7465 * @match: match notification parameters
7466 * @gfp: allocation flags
7468 * This function reports that the a NAN function had a match. This
7469 * can be a subscribe that had a match or a solicited publish that
7470 * was sent. It can also be a follow up that was received.
7472 void cfg80211_nan_match(struct wireless_dev *wdev,
7473 struct cfg80211_nan_match_params *match, gfp_t gfp);
7476 * cfg80211_nan_func_terminated - notify about NAN function termination.
7478 * @wdev: the wireless device reporting the match
7479 * @inst_id: the local instance id
7480 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7481 * @cookie: unique NAN function identifier
7482 * @gfp: allocation flags
7484 * This function reports that the a NAN function is terminated.
7486 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7488 enum nl80211_nan_func_term_reason reason,
7489 u64 cookie, gfp_t gfp);
7491 /* ethtool helper */
7492 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7495 * cfg80211_external_auth_request - userspace request for authentication
7496 * @netdev: network device
7497 * @params: External authentication parameters
7498 * @gfp: allocation flags
7499 * Returns: 0 on success, < 0 on error
7501 int cfg80211_external_auth_request(struct net_device *netdev,
7502 struct cfg80211_external_auth_params *params,
7506 * cfg80211_pmsr_report - report peer measurement result data
7507 * @wdev: the wireless device reporting the measurement
7508 * @req: the original measurement request
7509 * @result: the result data
7510 * @gfp: allocation flags
7512 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7513 struct cfg80211_pmsr_request *req,
7514 struct cfg80211_pmsr_result *result,
7518 * cfg80211_pmsr_complete - report peer measurement completed
7519 * @wdev: the wireless device reporting the measurement
7520 * @req: the original measurement request
7521 * @gfp: allocation flags
7523 * Report that the entire measurement completed, after this
7524 * the request pointer will no longer be valid.
7526 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7527 struct cfg80211_pmsr_request *req,
7531 * cfg80211_iftype_allowed - check whether the interface can be allowed
7533 * @iftype: interface type
7534 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7535 * @check_swif: check iftype against software interfaces
7537 * Check whether the interface is allowed to operate; additionally, this API
7538 * can be used to check iftype against the software interfaces when
7539 * check_swif is '1'.
7541 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
7542 bool is_4addr, u8 check_swif);
7545 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7547 /* wiphy_printk helpers, similar to dev_printk */
7549 #define wiphy_printk(level, wiphy, format, args...) \
7550 dev_printk(level, &(wiphy)->dev, format, ##args)
7551 #define wiphy_emerg(wiphy, format, args...) \
7552 dev_emerg(&(wiphy)->dev, format, ##args)
7553 #define wiphy_alert(wiphy, format, args...) \
7554 dev_alert(&(wiphy)->dev, format, ##args)
7555 #define wiphy_crit(wiphy, format, args...) \
7556 dev_crit(&(wiphy)->dev, format, ##args)
7557 #define wiphy_err(wiphy, format, args...) \
7558 dev_err(&(wiphy)->dev, format, ##args)
7559 #define wiphy_warn(wiphy, format, args...) \
7560 dev_warn(&(wiphy)->dev, format, ##args)
7561 #define wiphy_notice(wiphy, format, args...) \
7562 dev_notice(&(wiphy)->dev, format, ##args)
7563 #define wiphy_info(wiphy, format, args...) \
7564 dev_info(&(wiphy)->dev, format, ##args)
7566 #define wiphy_err_ratelimited(wiphy, format, args...) \
7567 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7568 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7569 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7571 #define wiphy_debug(wiphy, format, args...) \
7572 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7574 #define wiphy_dbg(wiphy, format, args...) \
7575 dev_dbg(&(wiphy)->dev, format, ##args)
7577 #if defined(VERBOSE_DEBUG)
7578 #define wiphy_vdbg wiphy_dbg
7580 #define wiphy_vdbg(wiphy, format, args...) \
7583 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
7589 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7590 * of using a WARN/WARN_ON to get the message out, including the
7591 * file/line information and a backtrace.
7593 #define wiphy_WARN(wiphy, format, args...) \
7594 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7597 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
7598 * @netdev: network device
7599 * @owe_info: peer's owe info
7600 * @gfp: allocation flags
7602 void cfg80211_update_owe_info_event(struct net_device *netdev,
7603 struct cfg80211_update_owe_info *owe_info,
7606 #endif /* __NET_CFG80211_H */