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-2021 Intel Corporation
13 #include <linux/ethtool.h>
14 #include <uapi/linux/rfkill.h>
15 #include <linux/netdevice.h>
16 #include <linux/debugfs.h>
17 #include <linux/list.h>
18 #include <linux/bug.h>
19 #include <linux/netlink.h>
20 #include <linux/skbuff.h>
21 #include <linux/nl80211.h>
22 #include <linux/if_ether.h>
23 #include <linux/ieee80211.h>
24 #include <linux/net.h>
25 #include <linux/rfkill.h>
26 #include <net/regulatory.h>
31 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32 * userspace and drivers, and offers some utility functionality associated
33 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34 * by all modern wireless drivers in Linux, so that they offer a consistent
35 * API through nl80211. For backward compatibility, cfg80211 also offers
36 * wireless extensions to userspace, but hides them from drivers completely.
38 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
44 * DOC: Device registration
46 * In order for a driver to use cfg80211, it must register the hardware device
47 * with cfg80211. This happens through a number of hardware capability structs
50 * The fundamental structure for each device is the 'wiphy', of which each
51 * instance describes a physical wireless device connected to the system. Each
52 * such wiphy can have zero, one, or many virtual interfaces associated with
53 * it, which need to be identified as such by pointing the network interface's
54 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55 * the wireless part of the interface, normally this struct is embedded in the
56 * network interface's private data area. Drivers can optionally allow creating
57 * or destroying virtual interfaces on the fly, but without at least one or the
58 * ability to create some the wireless device isn't useful.
60 * Each wiphy structure contains device capability information, and also has
61 * a pointer to the various operations the driver offers. The definitions and
62 * structures here describe these capabilities in detail.
68 * wireless hardware capability structures
72 * enum ieee80211_channel_flags - channel flags
74 * Channel flags set by the regulatory control code.
76 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
77 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
78 * sending probe requests or beaconing.
79 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
80 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
82 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
84 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
85 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
86 * this flag indicates that an 80 MHz channel cannot use this
87 * channel as the control or any of the secondary channels.
88 * This may be due to the driver or due to regulatory bandwidth
90 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
91 * this flag indicates that an 160 MHz channel cannot use this
92 * channel as the control or any of the secondary channels.
93 * This may be due to the driver or due to regulatory bandwidth
95 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
96 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
97 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
99 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
101 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
102 * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted
104 * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted
106 * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted
108 * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted
110 * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted
112 * @IEEE80211_CHAN_NO_320MHZ: If the driver supports 320 MHz on the band,
113 * this flag indicates that a 320 MHz channel cannot use this
114 * channel as the control or any of the secondary channels.
115 * This may be due to the driver or due to regulatory bandwidth
117 * @IEEE80211_CHAN_NO_EHT: EHT operation is not permitted on this channel.
119 enum ieee80211_channel_flags {
120 IEEE80211_CHAN_DISABLED = 1<<0,
121 IEEE80211_CHAN_NO_IR = 1<<1,
123 IEEE80211_CHAN_RADAR = 1<<3,
124 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
125 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
126 IEEE80211_CHAN_NO_OFDM = 1<<6,
127 IEEE80211_CHAN_NO_80MHZ = 1<<7,
128 IEEE80211_CHAN_NO_160MHZ = 1<<8,
129 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
130 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
131 IEEE80211_CHAN_NO_20MHZ = 1<<11,
132 IEEE80211_CHAN_NO_10MHZ = 1<<12,
133 IEEE80211_CHAN_NO_HE = 1<<13,
134 IEEE80211_CHAN_1MHZ = 1<<14,
135 IEEE80211_CHAN_2MHZ = 1<<15,
136 IEEE80211_CHAN_4MHZ = 1<<16,
137 IEEE80211_CHAN_8MHZ = 1<<17,
138 IEEE80211_CHAN_16MHZ = 1<<18,
139 IEEE80211_CHAN_NO_320MHZ = 1<<19,
140 IEEE80211_CHAN_NO_EHT = 1<<20,
143 #define IEEE80211_CHAN_NO_HT40 \
144 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
146 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
147 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
150 * struct ieee80211_channel - channel definition
152 * This structure describes a single channel for use
155 * @center_freq: center frequency in MHz
156 * @freq_offset: offset from @center_freq, in KHz
157 * @hw_value: hardware-specific value for the channel
158 * @flags: channel flags from &enum ieee80211_channel_flags.
159 * @orig_flags: channel flags at registration time, used by regulatory
160 * code to support devices with additional restrictions
161 * @band: band this channel belongs to.
162 * @max_antenna_gain: maximum antenna gain in dBi
163 * @max_power: maximum transmission power (in dBm)
164 * @max_reg_power: maximum regulatory transmission power (in dBm)
165 * @beacon_found: helper to regulatory code to indicate when a beacon
166 * has been found on this channel. Use regulatory_hint_found_beacon()
167 * to enable this, this is useful only on 5 GHz band.
168 * @orig_mag: internal use
169 * @orig_mpwr: internal use
170 * @dfs_state: current state of this channel. Only relevant if radar is required
172 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
173 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
175 struct ieee80211_channel {
176 enum nl80211_band band;
181 int max_antenna_gain;
186 int orig_mag, orig_mpwr;
187 enum nl80211_dfs_state dfs_state;
188 unsigned long dfs_state_entered;
189 unsigned int dfs_cac_ms;
193 * enum ieee80211_rate_flags - rate flags
195 * Hardware/specification flags for rates. These are structured
196 * in a way that allows using the same bitrate structure for
197 * different bands/PHY modes.
199 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
200 * preamble on this bitrate; only relevant in 2.4GHz band and
202 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
203 * when used with 802.11a (on the 5 GHz band); filled by the
204 * core code when registering the wiphy.
205 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
206 * when used with 802.11b (on the 2.4 GHz band); filled by the
207 * core code when registering the wiphy.
208 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
209 * when used with 802.11g (on the 2.4 GHz band); filled by the
210 * core code when registering the wiphy.
211 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
212 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
213 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
215 enum ieee80211_rate_flags {
216 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
217 IEEE80211_RATE_MANDATORY_A = 1<<1,
218 IEEE80211_RATE_MANDATORY_B = 1<<2,
219 IEEE80211_RATE_MANDATORY_G = 1<<3,
220 IEEE80211_RATE_ERP_G = 1<<4,
221 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
222 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
226 * enum ieee80211_bss_type - BSS type filter
228 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
229 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
230 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
231 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
232 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
234 enum ieee80211_bss_type {
235 IEEE80211_BSS_TYPE_ESS,
236 IEEE80211_BSS_TYPE_PBSS,
237 IEEE80211_BSS_TYPE_IBSS,
238 IEEE80211_BSS_TYPE_MBSS,
239 IEEE80211_BSS_TYPE_ANY
243 * enum ieee80211_privacy - BSS privacy filter
245 * @IEEE80211_PRIVACY_ON: privacy bit set
246 * @IEEE80211_PRIVACY_OFF: privacy bit clear
247 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
249 enum ieee80211_privacy {
250 IEEE80211_PRIVACY_ON,
251 IEEE80211_PRIVACY_OFF,
252 IEEE80211_PRIVACY_ANY
255 #define IEEE80211_PRIVACY(x) \
256 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
259 * struct ieee80211_rate - bitrate definition
261 * This structure describes a bitrate that an 802.11 PHY can
262 * operate with. The two values @hw_value and @hw_value_short
263 * are only for driver use when pointers to this structure are
266 * @flags: rate-specific flags
267 * @bitrate: bitrate in units of 100 Kbps
268 * @hw_value: driver/hardware value for this rate
269 * @hw_value_short: driver/hardware value for this rate when
270 * short preamble is used
272 struct ieee80211_rate {
275 u16 hw_value, hw_value_short;
279 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
281 * @enable: is the feature enabled.
282 * @sr_ctrl: The SR Control field of SRP element.
283 * @non_srg_max_offset: non-SRG maximum tx power offset
284 * @min_offset: minimal tx power offset an associated station shall use
285 * @max_offset: maximum tx power offset an associated station shall use
286 * @bss_color_bitmap: bitmap that indicates the BSS color values used by
288 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
289 * used by members of the SRG
291 struct ieee80211_he_obss_pd {
294 u8 non_srg_max_offset;
297 u8 bss_color_bitmap[8];
298 u8 partial_bssid_bitmap[8];
302 * struct cfg80211_he_bss_color - AP settings for BSS coloring
304 * @color: the current color.
305 * @enabled: HE BSS color is used
306 * @partial: define the AID equation.
308 struct cfg80211_he_bss_color {
315 * struct ieee80211_sta_ht_cap - STA's HT capabilities
317 * This structure describes most essential parameters needed
318 * to describe 802.11n HT capabilities for an STA.
320 * @ht_supported: is HT supported by the STA
321 * @cap: HT capabilities map as described in 802.11n spec
322 * @ampdu_factor: Maximum A-MPDU length factor
323 * @ampdu_density: Minimum A-MPDU spacing
324 * @mcs: Supported MCS rates
326 struct ieee80211_sta_ht_cap {
327 u16 cap; /* use IEEE80211_HT_CAP_ */
331 struct ieee80211_mcs_info mcs;
335 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
337 * This structure describes most essential parameters needed
338 * to describe 802.11ac VHT capabilities for an STA.
340 * @vht_supported: is VHT supported by the STA
341 * @cap: VHT capabilities map as described in 802.11ac spec
342 * @vht_mcs: Supported VHT MCS rates
344 struct ieee80211_sta_vht_cap {
346 u32 cap; /* use IEEE80211_VHT_CAP_ */
347 struct ieee80211_vht_mcs_info vht_mcs;
350 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
353 * struct ieee80211_sta_he_cap - STA's HE capabilities
355 * This structure describes most essential parameters needed
356 * to describe 802.11ax HE capabilities for a STA.
358 * @has_he: true iff HE data is valid.
359 * @he_cap_elem: Fixed portion of the HE capabilities element.
360 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
361 * @ppe_thres: Holds the PPE Thresholds data.
363 struct ieee80211_sta_he_cap {
365 struct ieee80211_he_cap_elem he_cap_elem;
366 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
367 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
371 * struct ieee80211_eht_mcs_nss_supp - EHT max supported NSS per MCS
373 * See P802.11be_D1.3 Table 9-401k - "Subfields of the Supported EHT-MCS
376 * @only_20mhz: MCS/NSS support for 20 MHz-only STA.
377 * @bw: MCS/NSS support for 80, 160 and 320 MHz
378 * @bw._80: MCS/NSS support for BW <= 80 MHz
379 * @bw._160: MCS/NSS support for BW = 160 MHz
380 * @bw._320: MCS/NSS support for BW = 320 MHz
382 struct ieee80211_eht_mcs_nss_supp {
384 struct ieee80211_eht_mcs_nss_supp_20mhz_only only_20mhz;
386 struct ieee80211_eht_mcs_nss_supp_bw _80;
387 struct ieee80211_eht_mcs_nss_supp_bw _160;
388 struct ieee80211_eht_mcs_nss_supp_bw _320;
393 #define IEEE80211_EHT_PPE_THRES_MAX_LEN 32
396 * struct ieee80211_sta_eht_cap - STA's EHT capabilities
398 * This structure describes most essential parameters needed
399 * to describe 802.11be EHT capabilities for a STA.
401 * @has_eht: true iff EHT data is valid.
402 * @eht_cap_elem: Fixed portion of the eht capabilities element.
403 * @eht_mcs_nss_supp: The supported NSS/MCS combinations.
404 * @eht_ppe_thres: Holds the PPE Thresholds data.
406 struct ieee80211_sta_eht_cap {
408 struct ieee80211_eht_cap_elem_fixed eht_cap_elem;
409 struct ieee80211_eht_mcs_nss_supp eht_mcs_nss_supp;
410 u8 eht_ppe_thres[IEEE80211_EHT_PPE_THRES_MAX_LEN];
414 * struct ieee80211_sband_iftype_data - sband data per interface type
416 * This structure encapsulates sband data that is relevant for the
417 * interface types defined in @types_mask. Each type in the
418 * @types_mask must be unique across all instances of iftype_data.
420 * @types_mask: interface types mask
421 * @he_cap: holds the HE capabilities
422 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
423 * 6 GHz band channel (and 0 may be valid value).
424 * @eht_cap: STA's EHT capabilities
425 * @vendor_elems: vendor element(s) to advertise
426 * @vendor_elems.data: vendor element(s) data
427 * @vendor_elems.len: vendor element(s) length
429 struct ieee80211_sband_iftype_data {
431 struct ieee80211_sta_he_cap he_cap;
432 struct ieee80211_he_6ghz_capa he_6ghz_capa;
433 struct ieee80211_sta_eht_cap eht_cap;
441 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
443 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
444 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
445 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
446 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
447 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
448 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
449 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
450 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
452 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
454 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
456 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
457 * and 4.32GHz + 4.32GHz
458 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
459 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
461 enum ieee80211_edmg_bw_config {
462 IEEE80211_EDMG_BW_CONFIG_4 = 4,
463 IEEE80211_EDMG_BW_CONFIG_5 = 5,
464 IEEE80211_EDMG_BW_CONFIG_6 = 6,
465 IEEE80211_EDMG_BW_CONFIG_7 = 7,
466 IEEE80211_EDMG_BW_CONFIG_8 = 8,
467 IEEE80211_EDMG_BW_CONFIG_9 = 9,
468 IEEE80211_EDMG_BW_CONFIG_10 = 10,
469 IEEE80211_EDMG_BW_CONFIG_11 = 11,
470 IEEE80211_EDMG_BW_CONFIG_12 = 12,
471 IEEE80211_EDMG_BW_CONFIG_13 = 13,
472 IEEE80211_EDMG_BW_CONFIG_14 = 14,
473 IEEE80211_EDMG_BW_CONFIG_15 = 15,
477 * struct ieee80211_edmg - EDMG configuration
479 * This structure describes most essential parameters needed
480 * to describe 802.11ay EDMG configuration
482 * @channels: bitmap that indicates the 2.16 GHz channel(s)
483 * that are allowed to be used for transmissions.
484 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
485 * Set to 0 indicate EDMG not supported.
486 * @bw_config: Channel BW Configuration subfield encodes
487 * the allowed channel bandwidth configurations
489 struct ieee80211_edmg {
491 enum ieee80211_edmg_bw_config bw_config;
495 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
497 * This structure describes most essential parameters needed
498 * to describe 802.11ah S1G capabilities for a STA.
500 * @s1g: is STA an S1G STA
501 * @cap: S1G capabilities information
502 * @nss_mcs: Supported NSS MCS set
504 struct ieee80211_sta_s1g_cap {
506 u8 cap[10]; /* use S1G_CAPAB_ */
511 * struct ieee80211_supported_band - frequency band definition
513 * This structure describes a frequency band a wiphy
514 * is able to operate in.
516 * @channels: Array of channels the hardware can operate with
518 * @band: the band this structure represents
519 * @n_channels: Number of channels in @channels
520 * @bitrates: Array of bitrates the hardware can operate with
521 * in this band. Must be sorted to give a valid "supported
522 * rates" IE, i.e. CCK rates first, then OFDM.
523 * @n_bitrates: Number of bitrates in @bitrates
524 * @ht_cap: HT capabilities in this band
525 * @vht_cap: VHT capabilities in this band
526 * @s1g_cap: S1G capabilities in this band
527 * @edmg_cap: EDMG capabilities in this band
528 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
529 * @n_iftype_data: number of iftype data entries
530 * @iftype_data: interface type data entries. Note that the bits in
531 * @types_mask inside this structure cannot overlap (i.e. only
532 * one occurrence of each type is allowed across all instances of
535 struct ieee80211_supported_band {
536 struct ieee80211_channel *channels;
537 struct ieee80211_rate *bitrates;
538 enum nl80211_band band;
541 struct ieee80211_sta_ht_cap ht_cap;
542 struct ieee80211_sta_vht_cap vht_cap;
543 struct ieee80211_sta_s1g_cap s1g_cap;
544 struct ieee80211_edmg edmg_cap;
546 const struct ieee80211_sband_iftype_data *iftype_data;
550 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
551 * @sband: the sband to search for the STA on
552 * @iftype: enum nl80211_iftype
554 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
556 static inline const struct ieee80211_sband_iftype_data *
557 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
562 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
565 for (i = 0; i < sband->n_iftype_data; i++) {
566 const struct ieee80211_sband_iftype_data *data =
567 &sband->iftype_data[i];
569 if (data->types_mask & BIT(iftype))
577 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
578 * @sband: the sband to search for the iftype on
579 * @iftype: enum nl80211_iftype
581 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
583 static inline const struct ieee80211_sta_he_cap *
584 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
587 const struct ieee80211_sband_iftype_data *data =
588 ieee80211_get_sband_iftype_data(sband, iftype);
590 if (data && data->he_cap.has_he)
591 return &data->he_cap;
597 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
598 * @sband: the sband to search for the STA on
599 * @iftype: the iftype to search for
601 * Return: the 6GHz capabilities
604 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
605 enum nl80211_iftype iftype)
607 const struct ieee80211_sband_iftype_data *data =
608 ieee80211_get_sband_iftype_data(sband, iftype);
610 if (WARN_ON(!data || !data->he_cap.has_he))
613 return data->he_6ghz_capa.capa;
617 * ieee80211_get_eht_iftype_cap - return ETH capabilities for an sband's iftype
618 * @sband: the sband to search for the iftype on
619 * @iftype: enum nl80211_iftype
621 * Return: pointer to the struct ieee80211_sta_eht_cap, or NULL is none found
623 static inline const struct ieee80211_sta_eht_cap *
624 ieee80211_get_eht_iftype_cap(const struct ieee80211_supported_band *sband,
625 enum nl80211_iftype iftype)
627 const struct ieee80211_sband_iftype_data *data =
628 ieee80211_get_sband_iftype_data(sband, iftype);
630 if (data && data->eht_cap.has_eht)
631 return &data->eht_cap;
637 * wiphy_read_of_freq_limits - read frequency limits from device tree
639 * @wiphy: the wireless device to get extra limits for
641 * Some devices may have extra limitations specified in DT. This may be useful
642 * for chipsets that normally support more bands but are limited due to board
643 * design (e.g. by antennas or external power amplifier).
645 * This function reads info from DT and uses it to *modify* channels (disable
646 * unavailable ones). It's usually a *bad* idea to use it in drivers with
647 * shared channel data as DT limitations are device specific. You should make
648 * sure to call it only if channels in wiphy are copied and can be modified
649 * without affecting other devices.
651 * As this function access device node it has to be called after set_wiphy_dev.
652 * It also modifies channels so they have to be set first.
653 * If using this helper, call it before wiphy_register().
656 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
657 #else /* CONFIG_OF */
658 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
661 #endif /* !CONFIG_OF */
665 * Wireless hardware/device configuration structures and methods
669 * DOC: Actions and configuration
671 * Each wireless device and each virtual interface offer a set of configuration
672 * operations and other actions that are invoked by userspace. Each of these
673 * actions is described in the operations structure, and the parameters these
674 * operations use are described separately.
676 * Additionally, some operations are asynchronous and expect to get status
677 * information via some functions that drivers need to call.
679 * Scanning and BSS list handling with its associated functionality is described
680 * in a separate chapter.
683 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
684 WLAN_USER_POSITION_LEN)
687 * struct vif_params - describes virtual interface parameters
688 * @flags: monitor interface flags, unchanged if 0, otherwise
689 * %MONITOR_FLAG_CHANGED will be set
690 * @use_4addr: use 4-address frames
691 * @macaddr: address to use for this virtual interface.
692 * If this parameter is set to zero address the driver may
693 * determine the address as needed.
694 * This feature is only fully supported by drivers that enable the
695 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
696 ** only p2p devices with specified MAC.
697 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
698 * belonging to that MU-MIMO groupID; %NULL if not changed
699 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
700 * MU-MIMO packets going to the specified station; %NULL if not changed
705 u8 macaddr[ETH_ALEN];
706 const u8 *vht_mumimo_groups;
707 const u8 *vht_mumimo_follow_addr;
711 * struct key_params - key information
713 * Information about a key
716 * @key_len: length of key material
717 * @cipher: cipher suite selector
718 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
719 * with the get_key() callback, must be in little endian,
720 * length given by @seq_len.
721 * @seq_len: length of @seq.
722 * @vlan_id: vlan_id for VLAN group key (if nonzero)
723 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
732 enum nl80211_key_mode mode;
736 * struct cfg80211_chan_def - channel definition
737 * @chan: the (control) channel
738 * @width: channel width
739 * @center_freq1: center frequency of first segment
740 * @center_freq2: center frequency of second segment
741 * (only with 80+80 MHz)
742 * @edmg: define the EDMG channels configuration.
743 * If edmg is requested (i.e. the .channels member is non-zero),
744 * chan will define the primary channel and all other
745 * parameters are ignored.
746 * @freq1_offset: offset from @center_freq1, in KHz
748 struct cfg80211_chan_def {
749 struct ieee80211_channel *chan;
750 enum nl80211_chan_width width;
753 struct ieee80211_edmg edmg;
758 * cfg80211_bitrate_mask - masks for bitrate control
760 struct cfg80211_bitrate_mask {
763 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
764 u16 vht_mcs[NL80211_VHT_NSS_MAX];
765 u16 he_mcs[NL80211_HE_NSS_MAX];
766 enum nl80211_txrate_gi gi;
767 enum nl80211_he_gi he_gi;
768 enum nl80211_he_ltf he_ltf;
769 } control[NUM_NL80211_BANDS];
774 * struct cfg80211_tid_cfg - TID specific configuration
775 * @config_override: Flag to notify driver to reset TID configuration
777 * @tids: bitmap of TIDs to modify
778 * @mask: bitmap of attributes indicating which parameter changed,
779 * similar to &nl80211_tid_config_supp.
780 * @noack: noack configuration value for the TID
781 * @retry_long: retry count value
782 * @retry_short: retry count value
783 * @ampdu: Enable/Disable MPDU aggregation
784 * @rtscts: Enable/Disable RTS/CTS
785 * @amsdu: Enable/Disable MSDU aggregation
786 * @txrate_type: Tx bitrate mask type
787 * @txrate_mask: Tx bitrate to be applied for the TID
789 struct cfg80211_tid_cfg {
790 bool config_override;
793 enum nl80211_tid_config noack;
794 u8 retry_long, retry_short;
795 enum nl80211_tid_config ampdu;
796 enum nl80211_tid_config rtscts;
797 enum nl80211_tid_config amsdu;
798 enum nl80211_tx_rate_setting txrate_type;
799 struct cfg80211_bitrate_mask txrate_mask;
803 * struct cfg80211_tid_config - TID configuration
804 * @peer: Station's MAC address
805 * @n_tid_conf: Number of TID specific configurations to be applied
806 * @tid_conf: Configuration change info
808 struct cfg80211_tid_config {
811 struct cfg80211_tid_cfg tid_conf[];
815 * struct cfg80211_fils_aad - FILS AAD data
816 * @macaddr: STA MAC address
818 * @kek_len: FILS KEK length
822 struct cfg80211_fils_aad {
831 * cfg80211_get_chandef_type - return old channel type from chandef
832 * @chandef: the channel definition
834 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
835 * chandef, which must have a bandwidth allowing this conversion.
837 static inline enum nl80211_channel_type
838 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
840 switch (chandef->width) {
841 case NL80211_CHAN_WIDTH_20_NOHT:
842 return NL80211_CHAN_NO_HT;
843 case NL80211_CHAN_WIDTH_20:
844 return NL80211_CHAN_HT20;
845 case NL80211_CHAN_WIDTH_40:
846 if (chandef->center_freq1 > chandef->chan->center_freq)
847 return NL80211_CHAN_HT40PLUS;
848 return NL80211_CHAN_HT40MINUS;
851 return NL80211_CHAN_NO_HT;
856 * cfg80211_chandef_create - create channel definition using channel type
857 * @chandef: the channel definition struct to fill
858 * @channel: the control channel
859 * @chantype: the channel type
861 * Given a channel type, create a channel definition.
863 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
864 struct ieee80211_channel *channel,
865 enum nl80211_channel_type chantype);
868 * cfg80211_chandef_identical - check if two channel definitions are identical
869 * @chandef1: first channel definition
870 * @chandef2: second channel definition
872 * Return: %true if the channels defined by the channel definitions are
873 * identical, %false otherwise.
876 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
877 const struct cfg80211_chan_def *chandef2)
879 return (chandef1->chan == chandef2->chan &&
880 chandef1->width == chandef2->width &&
881 chandef1->center_freq1 == chandef2->center_freq1 &&
882 chandef1->freq1_offset == chandef2->freq1_offset &&
883 chandef1->center_freq2 == chandef2->center_freq2);
887 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
889 * @chandef: the channel definition
891 * Return: %true if EDMG defined, %false otherwise.
894 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
896 return chandef->edmg.channels || chandef->edmg.bw_config;
900 * cfg80211_chandef_compatible - check if two channel definitions are compatible
901 * @chandef1: first channel definition
902 * @chandef2: second channel definition
904 * Return: %NULL if the given channel definitions are incompatible,
905 * chandef1 or chandef2 otherwise.
907 const struct cfg80211_chan_def *
908 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
909 const struct cfg80211_chan_def *chandef2);
912 * cfg80211_chandef_valid - check if a channel definition is valid
913 * @chandef: the channel definition to check
914 * Return: %true if the channel definition is valid. %false otherwise.
916 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
919 * cfg80211_chandef_usable - check if secondary channels can be used
920 * @wiphy: the wiphy to validate against
921 * @chandef: the channel definition to check
922 * @prohibited_flags: the regulatory channel flags that must not be set
923 * Return: %true if secondary channels are usable. %false otherwise.
925 bool cfg80211_chandef_usable(struct wiphy *wiphy,
926 const struct cfg80211_chan_def *chandef,
927 u32 prohibited_flags);
930 * cfg80211_chandef_dfs_required - checks if radar detection is required
931 * @wiphy: the wiphy to validate against
932 * @chandef: the channel definition to check
933 * @iftype: the interface type as specified in &enum nl80211_iftype
935 * 1 if radar detection is required, 0 if it is not, < 0 on error
937 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
938 const struct cfg80211_chan_def *chandef,
939 enum nl80211_iftype iftype);
942 * ieee80211_chanwidth_rate_flags - return rate flags for channel width
943 * @width: the channel width of the channel
945 * In some channel types, not all rates may be used - for example CCK
946 * rates may not be used in 5/10 MHz channels.
948 * Returns: rate flags which apply for this channel width
950 static inline enum ieee80211_rate_flags
951 ieee80211_chanwidth_rate_flags(enum nl80211_chan_width width)
954 case NL80211_CHAN_WIDTH_5:
955 return IEEE80211_RATE_SUPPORTS_5MHZ;
956 case NL80211_CHAN_WIDTH_10:
957 return IEEE80211_RATE_SUPPORTS_10MHZ;
965 * ieee80211_chandef_rate_flags - returns rate flags for a channel
966 * @chandef: channel definition for the channel
968 * See ieee80211_chanwidth_rate_flags().
970 * Returns: rate flags which apply for this channel
972 static inline enum ieee80211_rate_flags
973 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
975 return ieee80211_chanwidth_rate_flags(chandef->width);
979 * ieee80211_chandef_max_power - maximum transmission power for the chandef
981 * In some regulations, the transmit power may depend on the configured channel
982 * bandwidth which may be defined as dBm/MHz. This function returns the actual
983 * max_power for non-standard (20 MHz) channels.
985 * @chandef: channel definition for the channel
987 * Returns: maximum allowed transmission power in dBm for the chandef
990 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
992 switch (chandef->width) {
993 case NL80211_CHAN_WIDTH_5:
994 return min(chandef->chan->max_reg_power - 6,
995 chandef->chan->max_power);
996 case NL80211_CHAN_WIDTH_10:
997 return min(chandef->chan->max_reg_power - 3,
998 chandef->chan->max_power);
1002 return chandef->chan->max_power;
1006 * cfg80211_any_usable_channels - check for usable channels
1007 * @wiphy: the wiphy to check for
1008 * @band_mask: which bands to check on
1009 * @prohibited_flags: which channels to not consider usable,
1010 * %IEEE80211_CHAN_DISABLED is always taken into account
1012 bool cfg80211_any_usable_channels(struct wiphy *wiphy,
1013 unsigned long band_mask,
1014 u32 prohibited_flags);
1017 * enum survey_info_flags - survey information flags
1019 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
1020 * @SURVEY_INFO_IN_USE: channel is currently being used
1021 * @SURVEY_INFO_TIME: active time (in ms) was filled in
1022 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
1023 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
1024 * @SURVEY_INFO_TIME_RX: receive time was filled in
1025 * @SURVEY_INFO_TIME_TX: transmit time was filled in
1026 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
1027 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
1029 * Used by the driver to indicate which info in &struct survey_info
1030 * it has filled in during the get_survey().
1032 enum survey_info_flags {
1033 SURVEY_INFO_NOISE_DBM = BIT(0),
1034 SURVEY_INFO_IN_USE = BIT(1),
1035 SURVEY_INFO_TIME = BIT(2),
1036 SURVEY_INFO_TIME_BUSY = BIT(3),
1037 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
1038 SURVEY_INFO_TIME_RX = BIT(5),
1039 SURVEY_INFO_TIME_TX = BIT(6),
1040 SURVEY_INFO_TIME_SCAN = BIT(7),
1041 SURVEY_INFO_TIME_BSS_RX = BIT(8),
1045 * struct survey_info - channel survey response
1047 * @channel: the channel this survey record reports, may be %NULL for a single
1048 * record to report global statistics
1049 * @filled: bitflag of flags from &enum survey_info_flags
1050 * @noise: channel noise in dBm. This and all following fields are
1052 * @time: amount of time in ms the radio was turn on (on the channel)
1053 * @time_busy: amount of time the primary channel was sensed busy
1054 * @time_ext_busy: amount of time the extension channel was sensed busy
1055 * @time_rx: amount of time the radio spent receiving data
1056 * @time_tx: amount of time the radio spent transmitting data
1057 * @time_scan: amount of time the radio spent for scanning
1058 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
1060 * Used by dump_survey() to report back per-channel survey information.
1062 * This structure can later be expanded with things like
1063 * channel duty cycle etc.
1065 struct survey_info {
1066 struct ieee80211_channel *channel;
1078 #define CFG80211_MAX_WEP_KEYS 4
1079 #define CFG80211_MAX_NUM_AKM_SUITES 10
1082 * struct cfg80211_crypto_settings - Crypto settings
1083 * @wpa_versions: indicates which, if any, WPA versions are enabled
1084 * (from enum nl80211_wpa_versions)
1085 * @cipher_group: group key cipher suite (or 0 if unset)
1086 * @n_ciphers_pairwise: number of AP supported unicast ciphers
1087 * @ciphers_pairwise: unicast key cipher suites
1088 * @n_akm_suites: number of AKM suites
1089 * @akm_suites: AKM suites
1090 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
1091 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1092 * required to assume that the port is unauthorized until authorized by
1093 * user space. Otherwise, port is marked authorized by default.
1094 * @control_port_ethertype: the control port protocol that should be
1095 * allowed through even on unauthorized ports
1096 * @control_port_no_encrypt: TRUE to prevent encryption of control port
1098 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1099 * port frames over NL80211 instead of the network interface.
1100 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
1102 * @wep_keys: static WEP keys, if not NULL points to an array of
1103 * CFG80211_MAX_WEP_KEYS WEP keys
1104 * @wep_tx_key: key index (0..3) of the default TX static WEP key
1105 * @psk: PSK (for devices supporting 4-way-handshake offload)
1106 * @sae_pwd: password for SAE authentication (for devices supporting SAE
1108 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1109 * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
1111 * NL80211_SAE_PWE_UNSPECIFIED
1112 * Not-specified, used to indicate userspace did not specify any
1113 * preference. The driver should follow its internal policy in
1116 * NL80211_SAE_PWE_HUNT_AND_PECK
1117 * Allow hunting-and-pecking loop only
1119 * NL80211_SAE_PWE_HASH_TO_ELEMENT
1120 * Allow hash-to-element only
1122 * NL80211_SAE_PWE_BOTH
1123 * Allow either hunting-and-pecking loop or hash-to-element
1125 struct cfg80211_crypto_settings {
1128 int n_ciphers_pairwise;
1129 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1131 u32 akm_suites[CFG80211_MAX_NUM_AKM_SUITES];
1133 __be16 control_port_ethertype;
1134 bool control_port_no_encrypt;
1135 bool control_port_over_nl80211;
1136 bool control_port_no_preauth;
1137 struct key_params *wep_keys;
1142 enum nl80211_sae_pwe_mechanism sae_pwe;
1146 * struct cfg80211_mbssid_config - AP settings for multi bssid
1148 * @tx_wdev: pointer to the transmitted interface in the MBSSID set
1149 * @index: index of this AP in the multi bssid group.
1150 * @ema: set to true if the beacons should be sent out in EMA mode.
1152 struct cfg80211_mbssid_config {
1153 struct wireless_dev *tx_wdev;
1159 * struct cfg80211_mbssid_elems - Multiple BSSID elements
1161 * @cnt: Number of elements in array %elems.
1163 * @elem: Array of multiple BSSID element(s) to be added into Beacon frames.
1164 * @elem.data: Data for multiple BSSID elements.
1165 * @elem.len: Length of data.
1167 struct cfg80211_mbssid_elems {
1176 * struct cfg80211_beacon_data - beacon data
1177 * @link_id: the link ID for the AP MLD link sending this beacon
1178 * @head: head portion of beacon (before TIM IE)
1179 * or %NULL if not changed
1180 * @tail: tail portion of beacon (after TIM IE)
1181 * or %NULL if not changed
1182 * @head_len: length of @head
1183 * @tail_len: length of @tail
1184 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1185 * @beacon_ies_len: length of beacon_ies in octets
1186 * @proberesp_ies: extra information element(s) to add into Probe Response
1188 * @proberesp_ies_len: length of proberesp_ies in octets
1189 * @assocresp_ies: extra information element(s) to add into (Re)Association
1190 * Response frames or %NULL
1191 * @assocresp_ies_len: length of assocresp_ies in octets
1192 * @probe_resp_len: length of probe response template (@probe_resp)
1193 * @probe_resp: probe response template (AP mode only)
1194 * @mbssid_ies: multiple BSSID elements
1195 * @ftm_responder: enable FTM responder functionality; -1 for no change
1196 * (which also implies no change in LCI/civic location data)
1197 * @lci: Measurement Report element content, starting with Measurement Token
1198 * (measurement type 8)
1199 * @civicloc: Measurement Report element content, starting with Measurement
1200 * Token (measurement type 11)
1201 * @lci_len: LCI data length
1202 * @civicloc_len: Civic location data length
1203 * @he_bss_color: BSS Color settings
1204 * @he_bss_color_valid: indicates whether bss color
1205 * attribute is present in beacon data or not.
1207 struct cfg80211_beacon_data {
1208 unsigned int link_id;
1210 const u8 *head, *tail;
1211 const u8 *beacon_ies;
1212 const u8 *proberesp_ies;
1213 const u8 *assocresp_ies;
1214 const u8 *probe_resp;
1217 struct cfg80211_mbssid_elems *mbssid_ies;
1220 size_t head_len, tail_len;
1221 size_t beacon_ies_len;
1222 size_t proberesp_ies_len;
1223 size_t assocresp_ies_len;
1224 size_t probe_resp_len;
1226 size_t civicloc_len;
1227 struct cfg80211_he_bss_color he_bss_color;
1228 bool he_bss_color_valid;
1231 struct mac_address {
1236 * struct cfg80211_acl_data - Access control list data
1238 * @acl_policy: ACL policy to be applied on the station's
1239 * entry specified by mac_addr
1240 * @n_acl_entries: Number of MAC address entries passed
1241 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1243 struct cfg80211_acl_data {
1244 enum nl80211_acl_policy acl_policy;
1248 struct mac_address mac_addrs[];
1252 * struct cfg80211_fils_discovery - FILS discovery parameters from
1253 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1255 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1256 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1257 * @tmpl_len: Template length
1258 * @tmpl: Template data for FILS discovery frame including the action
1261 struct cfg80211_fils_discovery {
1269 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1270 * response parameters in 6GHz.
1272 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1273 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1275 * @tmpl_len: Template length
1276 * @tmpl: Template data for probe response
1278 struct cfg80211_unsol_bcast_probe_resp {
1285 * struct cfg80211_ap_settings - AP configuration
1287 * Used to configure an AP interface.
1289 * @chandef: defines the channel to use
1290 * @beacon: beacon data
1291 * @beacon_interval: beacon interval
1292 * @dtim_period: DTIM period
1293 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1295 * @ssid_len: length of @ssid
1296 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1297 * @crypto: crypto settings
1298 * @privacy: the BSS uses privacy
1299 * @auth_type: Authentication type (algorithm)
1300 * @smps_mode: SMPS mode
1301 * @inactivity_timeout: time in seconds to determine station's inactivity.
1302 * @p2p_ctwindow: P2P CT Window
1303 * @p2p_opp_ps: P2P opportunistic PS
1304 * @acl: ACL configuration used by the drivers which has support for
1305 * MAC address based access control
1306 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1308 * @beacon_rate: bitrate to be used for beacons
1309 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1310 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1311 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1312 * @eht_cap: EHT capabilities (or %NULL if EHT isn't enabled)
1313 * @eht_oper: EHT operation IE (or %NULL if EHT isn't enabled)
1314 * @ht_required: stations must support HT
1315 * @vht_required: stations must support VHT
1316 * @twt_responder: Enable Target Wait Time
1317 * @he_required: stations must support HE
1318 * @sae_h2e_required: stations must support direct H2E technique in SAE
1319 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1320 * @he_obss_pd: OBSS Packet Detection settings
1321 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1322 * @fils_discovery: FILS discovery transmission parameters
1323 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1324 * @mbssid_config: AP settings for multiple bssid
1326 struct cfg80211_ap_settings {
1327 struct cfg80211_chan_def chandef;
1329 struct cfg80211_beacon_data beacon;
1331 int beacon_interval, dtim_period;
1334 enum nl80211_hidden_ssid hidden_ssid;
1335 struct cfg80211_crypto_settings crypto;
1337 enum nl80211_auth_type auth_type;
1338 enum nl80211_smps_mode smps_mode;
1339 int inactivity_timeout;
1342 const struct cfg80211_acl_data *acl;
1344 struct cfg80211_bitrate_mask beacon_rate;
1346 const struct ieee80211_ht_cap *ht_cap;
1347 const struct ieee80211_vht_cap *vht_cap;
1348 const struct ieee80211_he_cap_elem *he_cap;
1349 const struct ieee80211_he_operation *he_oper;
1350 const struct ieee80211_eht_cap_elem *eht_cap;
1351 const struct ieee80211_eht_operation *eht_oper;
1352 bool ht_required, vht_required, he_required, sae_h2e_required;
1355 struct ieee80211_he_obss_pd he_obss_pd;
1356 struct cfg80211_fils_discovery fils_discovery;
1357 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1358 struct cfg80211_mbssid_config mbssid_config;
1362 * struct cfg80211_csa_settings - channel switch settings
1364 * Used for channel switch
1366 * @chandef: defines the channel to use after the switch
1367 * @beacon_csa: beacon data while performing the switch
1368 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1369 * @counter_offsets_presp: offsets of the counters within the probe response
1370 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1371 * @n_counter_offsets_presp: number of csa counters in the probe response
1372 * @beacon_after: beacon data to be used on the new channel
1373 * @radar_required: whether radar detection is required on the new channel
1374 * @block_tx: whether transmissions should be blocked while changing
1375 * @count: number of beacons until switch
1377 struct cfg80211_csa_settings {
1378 struct cfg80211_chan_def chandef;
1379 struct cfg80211_beacon_data beacon_csa;
1380 const u16 *counter_offsets_beacon;
1381 const u16 *counter_offsets_presp;
1382 unsigned int n_counter_offsets_beacon;
1383 unsigned int n_counter_offsets_presp;
1384 struct cfg80211_beacon_data beacon_after;
1385 bool radar_required;
1391 * struct cfg80211_color_change_settings - color change settings
1393 * Used for bss color change
1395 * @beacon_color_change: beacon data while performing the color countdown
1396 * @counter_offset_beacon: offsets of the counters within the beacon (tail)
1397 * @counter_offset_presp: offsets of the counters within the probe response
1398 * @beacon_next: beacon data to be used after the color change
1399 * @count: number of beacons until the color change
1400 * @color: the color used after the change
1402 struct cfg80211_color_change_settings {
1403 struct cfg80211_beacon_data beacon_color_change;
1404 u16 counter_offset_beacon;
1405 u16 counter_offset_presp;
1406 struct cfg80211_beacon_data beacon_next;
1412 * struct iface_combination_params - input parameters for interface combinations
1414 * Used to pass interface combination parameters
1416 * @num_different_channels: the number of different channels we want
1417 * to use for verification
1418 * @radar_detect: a bitmap where each bit corresponds to a channel
1419 * width where radar detection is needed, as in the definition of
1420 * &struct ieee80211_iface_combination.@radar_detect_widths
1421 * @iftype_num: array with the number of interfaces of each interface
1422 * type. The index is the interface type as specified in &enum
1424 * @new_beacon_int: set this to the beacon interval of a new interface
1425 * that's not operating yet, if such is to be checked as part of
1428 struct iface_combination_params {
1429 int num_different_channels;
1431 int iftype_num[NUM_NL80211_IFTYPES];
1436 * enum station_parameters_apply_mask - station parameter values to apply
1437 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1438 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1439 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1440 * @STATION_PARAM_APPLY_STA_TXPOWER: apply tx power for STA
1442 * Not all station parameters have in-band "no change" signalling,
1443 * for those that don't these flags will are used.
1445 enum station_parameters_apply_mask {
1446 STATION_PARAM_APPLY_UAPSD = BIT(0),
1447 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1448 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1452 * struct sta_txpwr - station txpower configuration
1454 * Used to configure txpower for station.
1456 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1457 * is not provided, the default per-interface tx power setting will be
1458 * overriding. Driver should be picking up the lowest tx power, either tx
1459 * power per-interface or per-station.
1460 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1461 * will be less than or equal to specified from userspace, whereas if TPC
1462 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1463 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1468 enum nl80211_tx_power_setting type;
1472 * struct link_station_parameters - link station parameters
1474 * Used to change and create a new link station.
1476 * @mld_mac: MAC address of the station
1477 * @link_id: the link id (-1 for non-MLD station)
1478 * @link_mac: MAC address of the link
1479 * @supported_rates: supported rates in IEEE 802.11 format
1480 * (or NULL for no change)
1481 * @supported_rates_len: number of supported rates
1482 * @ht_capa: HT capabilities of station
1483 * @vht_capa: VHT capabilities of station
1484 * @opmode_notif: operating mode field from Operating Mode Notification
1485 * @opmode_notif_used: information if operating mode field is used
1486 * @he_capa: HE capabilities of station
1487 * @he_capa_len: the length of the HE capabilities
1488 * @txpwr: transmit power for an associated station
1489 * @txpwr_set: txpwr field is set
1490 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1491 * @eht_capa: EHT capabilities of station
1492 * @eht_capa_len: the length of the EHT capabilities
1494 struct link_station_parameters {
1498 const u8 *supported_rates;
1499 u8 supported_rates_len;
1500 const struct ieee80211_ht_cap *ht_capa;
1501 const struct ieee80211_vht_cap *vht_capa;
1503 bool opmode_notif_used;
1504 const struct ieee80211_he_cap_elem *he_capa;
1506 struct sta_txpwr txpwr;
1508 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1509 const struct ieee80211_eht_cap_elem *eht_capa;
1514 * struct link_station_del_parameters - link station deletion parameters
1516 * Used to delete a link station entry (or all stations).
1518 * @mld_mac: MAC address of the station
1519 * @link_id: the link id
1521 struct link_station_del_parameters {
1527 * struct station_parameters - station parameters
1529 * Used to change and create a new station.
1531 * @vlan: vlan interface station should belong to
1532 * @sta_flags_mask: station flags that changed
1533 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1534 * @sta_flags_set: station flags values
1535 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1536 * @listen_interval: listen interval or -1 for no change
1537 * @aid: AID or zero for no change
1538 * @vlan_id: VLAN ID for station (if nonzero)
1539 * @peer_aid: mesh peer AID or zero for no change
1540 * @plink_action: plink action to take
1541 * @plink_state: set the peer link state for a station
1542 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1543 * as the AC bitmap in the QoS info field
1544 * @max_sp: max Service Period. same format as the MAX_SP in the
1545 * QoS info field (but already shifted down)
1546 * @sta_modify_mask: bitmap indicating which parameters changed
1547 * (for those that don't have a natural "no change" value),
1548 * see &enum station_parameters_apply_mask
1549 * @local_pm: local link-specific mesh power save mode (no change when set
1551 * @capability: station capability
1552 * @ext_capab: extended capabilities of the station
1553 * @ext_capab_len: number of extended capabilities
1554 * @supported_channels: supported channels in IEEE 802.11 format
1555 * @supported_channels_len: number of supported channels
1556 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1557 * @supported_oper_classes_len: number of supported operating classes
1558 * @support_p2p_ps: information if station supports P2P PS mechanism
1559 * @airtime_weight: airtime scheduler weight for this station
1560 * @link_sta_params: link related params.
1562 struct station_parameters {
1563 struct net_device *vlan;
1564 u32 sta_flags_mask, sta_flags_set;
1565 u32 sta_modify_mask;
1566 int listen_interval;
1574 enum nl80211_mesh_power_mode local_pm;
1576 const u8 *ext_capab;
1578 const u8 *supported_channels;
1579 u8 supported_channels_len;
1580 const u8 *supported_oper_classes;
1581 u8 supported_oper_classes_len;
1584 struct link_station_parameters link_sta_params;
1588 * struct station_del_parameters - station deletion parameters
1590 * Used to delete a station entry (or all stations).
1592 * @mac: MAC address of the station to remove or NULL to remove all stations
1593 * @subtype: Management frame subtype to use for indicating removal
1594 * (10 = Disassociation, 12 = Deauthentication)
1595 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1597 struct station_del_parameters {
1604 * enum cfg80211_station_type - the type of station being modified
1605 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1606 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1607 * unassociated (update properties for this type of client is permitted)
1608 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1609 * the AP MLME in the device
1610 * @CFG80211_STA_AP_STA: AP station on managed interface
1611 * @CFG80211_STA_IBSS: IBSS station
1612 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1613 * while TDLS setup is in progress, it moves out of this state when
1614 * being marked authorized; use this only if TDLS with external setup is
1616 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1617 * entry that is operating, has been marked authorized by userspace)
1618 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1619 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1621 enum cfg80211_station_type {
1622 CFG80211_STA_AP_CLIENT,
1623 CFG80211_STA_AP_CLIENT_UNASSOC,
1624 CFG80211_STA_AP_MLME_CLIENT,
1625 CFG80211_STA_AP_STA,
1627 CFG80211_STA_TDLS_PEER_SETUP,
1628 CFG80211_STA_TDLS_PEER_ACTIVE,
1629 CFG80211_STA_MESH_PEER_KERNEL,
1630 CFG80211_STA_MESH_PEER_USER,
1634 * cfg80211_check_station_change - validate parameter changes
1635 * @wiphy: the wiphy this operates on
1636 * @params: the new parameters for a station
1637 * @statype: the type of station being modified
1639 * Utility function for the @change_station driver method. Call this function
1640 * with the appropriate station type looking up the station (and checking that
1641 * it exists). It will verify whether the station change is acceptable, and if
1642 * not will return an error code. Note that it may modify the parameters for
1643 * backward compatibility reasons, so don't use them before calling this.
1645 int cfg80211_check_station_change(struct wiphy *wiphy,
1646 struct station_parameters *params,
1647 enum cfg80211_station_type statype);
1650 * enum rate_info_flags - bitrate info flags
1652 * Used by the driver to indicate the specific rate transmission
1653 * type for 802.11n transmissions.
1655 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1656 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1657 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1658 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1659 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1660 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1661 * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS
1662 * @RATE_INFO_FLAGS_EHT_MCS: EHT MCS information
1664 enum rate_info_flags {
1665 RATE_INFO_FLAGS_MCS = BIT(0),
1666 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1667 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1668 RATE_INFO_FLAGS_DMG = BIT(3),
1669 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1670 RATE_INFO_FLAGS_EDMG = BIT(5),
1671 RATE_INFO_FLAGS_EXTENDED_SC_DMG = BIT(6),
1672 RATE_INFO_FLAGS_EHT_MCS = BIT(7),
1676 * enum rate_info_bw - rate bandwidth information
1678 * Used by the driver to indicate the rate bandwidth.
1680 * @RATE_INFO_BW_5: 5 MHz bandwidth
1681 * @RATE_INFO_BW_10: 10 MHz bandwidth
1682 * @RATE_INFO_BW_20: 20 MHz bandwidth
1683 * @RATE_INFO_BW_40: 40 MHz bandwidth
1684 * @RATE_INFO_BW_80: 80 MHz bandwidth
1685 * @RATE_INFO_BW_160: 160 MHz bandwidth
1686 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1687 * @RATE_INFO_BW_320: 320 MHz bandwidth
1688 * @RATE_INFO_BW_EHT_RU: bandwidth determined by EHT RU allocation
1691 RATE_INFO_BW_20 = 0,
1699 RATE_INFO_BW_EHT_RU,
1703 * struct rate_info - bitrate information
1705 * Information about a receiving or transmitting bitrate
1707 * @flags: bitflag of flags from &enum rate_info_flags
1708 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1709 * @legacy: bitrate in 100kbit/s for 802.11abg
1710 * @nss: number of streams (VHT & HE only)
1711 * @bw: bandwidth (from &enum rate_info_bw)
1712 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1713 * @he_dcm: HE DCM value
1714 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1715 * only valid if bw is %RATE_INFO_BW_HE_RU)
1716 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1717 * @eht_gi: EHT guard interval (from &enum nl80211_eht_gi)
1718 * @eht_ru_alloc: EHT RU allocation (from &enum nl80211_eht_ru_alloc,
1719 * only valid if bw is %RATE_INFO_BW_EHT_RU)
1736 * enum bss_param_flags - bitrate info flags
1738 * Used by the driver to indicate the specific rate transmission
1739 * type for 802.11n transmissions.
1741 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1742 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1743 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1745 enum bss_param_flags {
1746 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1747 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1748 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1752 * struct sta_bss_parameters - BSS parameters for the attached station
1754 * Information about the currently associated BSS
1756 * @flags: bitflag of flags from &enum bss_param_flags
1757 * @dtim_period: DTIM period for the BSS
1758 * @beacon_interval: beacon interval
1760 struct sta_bss_parameters {
1763 u16 beacon_interval;
1767 * struct cfg80211_txq_stats - TXQ statistics for this TID
1768 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1769 * indicate the relevant values in this struct are filled
1770 * @backlog_bytes: total number of bytes currently backlogged
1771 * @backlog_packets: total number of packets currently backlogged
1772 * @flows: number of new flows seen
1773 * @drops: total number of packets dropped
1774 * @ecn_marks: total number of packets marked with ECN CE
1775 * @overlimit: number of drops due to queue space overflow
1776 * @overmemory: number of drops due to memory limit overflow
1777 * @collisions: number of hash collisions
1778 * @tx_bytes: total number of bytes dequeued
1779 * @tx_packets: total number of packets dequeued
1780 * @max_flows: maximum number of flows supported
1782 struct cfg80211_txq_stats {
1785 u32 backlog_packets;
1798 * struct cfg80211_tid_stats - per-TID statistics
1799 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1800 * indicate the relevant values in this struct are filled
1801 * @rx_msdu: number of received MSDUs
1802 * @tx_msdu: number of (attempted) transmitted MSDUs
1803 * @tx_msdu_retries: number of retries (not counting the first) for
1805 * @tx_msdu_failed: number of failed transmitted MSDUs
1806 * @txq_stats: TXQ statistics
1808 struct cfg80211_tid_stats {
1812 u64 tx_msdu_retries;
1814 struct cfg80211_txq_stats txq_stats;
1817 #define IEEE80211_MAX_CHAINS 4
1820 * struct station_info - station information
1822 * Station information filled by driver for get_station() and dump_station.
1824 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1825 * indicate the relevant values in this struct for them
1826 * @connected_time: time(in secs) since a station is last connected
1827 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1828 * @assoc_at: bootime (ns) of the last association
1829 * @rx_bytes: bytes (size of MPDUs) received from this station
1830 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1831 * @llid: mesh local link id
1832 * @plid: mesh peer link id
1833 * @plink_state: mesh peer link state
1834 * @signal: The signal strength, type depends on the wiphy's signal_type.
1835 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1836 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1837 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1838 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1839 * @chain_signal: per-chain signal strength of last received packet in dBm
1840 * @chain_signal_avg: per-chain signal strength average in dBm
1841 * @txrate: current unicast bitrate from this station
1842 * @rxrate: current unicast bitrate to this station
1843 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1844 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1845 * @tx_retries: cumulative retry counts (MPDUs)
1846 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1847 * @rx_dropped_misc: Dropped for un-specified reason.
1848 * @bss_param: current BSS parameters
1849 * @generation: generation number for nl80211 dumps.
1850 * This number should increase every time the list of stations
1851 * changes, i.e. when a station is added or removed, so that
1852 * userspace can tell whether it got a consistent snapshot.
1853 * @assoc_req_ies: IEs from (Re)Association Request.
1854 * This is used only when in AP mode with drivers that do not use
1855 * user space MLME/SME implementation. The information is provided for
1856 * the cfg80211_new_sta() calls to notify user space of the IEs.
1857 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1858 * @sta_flags: station flags mask & values
1859 * @beacon_loss_count: Number of times beacon loss event has triggered.
1860 * @t_offset: Time offset of the station relative to this host.
1861 * @local_pm: local mesh STA power save mode
1862 * @peer_pm: peer mesh STA power save mode
1863 * @nonpeer_pm: non-peer mesh STA power save mode
1864 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1865 * towards this station.
1866 * @rx_beacon: number of beacons received from this peer
1867 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1869 * @connected_to_gate: true if mesh STA has a path to mesh gate
1870 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1871 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1872 * @airtime_weight: current airtime scheduling weight
1873 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1874 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1875 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1876 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1877 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1879 * @rx_mpdu_count: number of MPDUs received from this station
1880 * @fcs_err_count: number of packets (MPDUs) received from this station with
1881 * an FCS error. This counter should be incremented only when TA of the
1882 * received packet with an FCS error matches the peer MAC address.
1883 * @airtime_link_metric: mesh airtime link metric.
1884 * @connected_to_as: true if mesh STA has a path to authentication server
1886 struct station_info {
1900 s8 chain_signal[IEEE80211_MAX_CHAINS];
1901 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1903 struct rate_info txrate;
1904 struct rate_info rxrate;
1909 u32 rx_dropped_misc;
1910 struct sta_bss_parameters bss_param;
1911 struct nl80211_sta_flag_update sta_flags;
1915 const u8 *assoc_req_ies;
1916 size_t assoc_req_ies_len;
1918 u32 beacon_loss_count;
1920 enum nl80211_mesh_power_mode local_pm;
1921 enum nl80211_mesh_power_mode peer_pm;
1922 enum nl80211_mesh_power_mode nonpeer_pm;
1924 u32 expected_throughput;
1929 u8 rx_beacon_signal_avg;
1930 u8 connected_to_gate;
1932 struct cfg80211_tid_stats *pertid;
1941 u32 airtime_link_metric;
1947 * struct cfg80211_sar_sub_specs - sub specs limit
1948 * @power: power limitation in 0.25dbm
1949 * @freq_range_index: index the power limitation applies to
1951 struct cfg80211_sar_sub_specs {
1953 u32 freq_range_index;
1957 * struct cfg80211_sar_specs - sar limit specs
1958 * @type: it's set with power in 0.25dbm or other types
1959 * @num_sub_specs: number of sar sub specs
1960 * @sub_specs: memory to hold the sar sub specs
1962 struct cfg80211_sar_specs {
1963 enum nl80211_sar_type type;
1965 struct cfg80211_sar_sub_specs sub_specs[];
1970 * struct cfg80211_sar_freq_ranges - sar frequency ranges
1971 * @start_freq: start range edge frequency
1972 * @end_freq: end range edge frequency
1974 struct cfg80211_sar_freq_ranges {
1980 * struct cfg80211_sar_capa - sar limit capability
1981 * @type: it's set via power in 0.25dbm or other types
1982 * @num_freq_ranges: number of frequency ranges
1983 * @freq_ranges: memory to hold the freq ranges.
1985 * Note: WLAN driver may append new ranges or split an existing
1986 * range to small ones and then append them.
1988 struct cfg80211_sar_capa {
1989 enum nl80211_sar_type type;
1990 u32 num_freq_ranges;
1991 const struct cfg80211_sar_freq_ranges *freq_ranges;
1994 #if IS_ENABLED(CONFIG_CFG80211)
1996 * cfg80211_get_station - retrieve information about a given station
1997 * @dev: the device where the station is supposed to be connected to
1998 * @mac_addr: the mac address of the station of interest
1999 * @sinfo: pointer to the structure to fill with the information
2001 * Returns 0 on success and sinfo is filled with the available information
2002 * otherwise returns a negative error code and the content of sinfo has to be
2003 * considered undefined.
2005 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
2006 struct station_info *sinfo);
2008 static inline int cfg80211_get_station(struct net_device *dev,
2010 struct station_info *sinfo)
2017 * enum monitor_flags - monitor flags
2019 * Monitor interface configuration flags. Note that these must be the bits
2020 * according to the nl80211 flags.
2022 * @MONITOR_FLAG_CHANGED: set if the flags were changed
2023 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
2024 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
2025 * @MONITOR_FLAG_CONTROL: pass control frames
2026 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
2027 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
2028 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
2030 enum monitor_flags {
2031 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
2032 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
2033 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
2034 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
2035 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
2036 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
2037 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
2041 * enum mpath_info_flags - mesh path information flags
2043 * Used by the driver to indicate which info in &struct mpath_info it has filled
2044 * in during get_station() or dump_station().
2046 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
2047 * @MPATH_INFO_SN: @sn filled
2048 * @MPATH_INFO_METRIC: @metric filled
2049 * @MPATH_INFO_EXPTIME: @exptime filled
2050 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
2051 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
2052 * @MPATH_INFO_FLAGS: @flags filled
2053 * @MPATH_INFO_HOP_COUNT: @hop_count filled
2054 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
2056 enum mpath_info_flags {
2057 MPATH_INFO_FRAME_QLEN = BIT(0),
2058 MPATH_INFO_SN = BIT(1),
2059 MPATH_INFO_METRIC = BIT(2),
2060 MPATH_INFO_EXPTIME = BIT(3),
2061 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
2062 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
2063 MPATH_INFO_FLAGS = BIT(6),
2064 MPATH_INFO_HOP_COUNT = BIT(7),
2065 MPATH_INFO_PATH_CHANGE = BIT(8),
2069 * struct mpath_info - mesh path information
2071 * Mesh path information filled by driver for get_mpath() and dump_mpath().
2073 * @filled: bitfield of flags from &enum mpath_info_flags
2074 * @frame_qlen: number of queued frames for this destination
2075 * @sn: target sequence number
2076 * @metric: metric (cost) of this mesh path
2077 * @exptime: expiration time for the mesh path from now, in msecs
2078 * @flags: mesh path flags
2079 * @discovery_timeout: total mesh path discovery timeout, in msecs
2080 * @discovery_retries: mesh path discovery retries
2081 * @generation: generation number for nl80211 dumps.
2082 * This number should increase every time the list of mesh paths
2083 * changes, i.e. when a station is added or removed, so that
2084 * userspace can tell whether it got a consistent snapshot.
2085 * @hop_count: hops to destination
2086 * @path_change_count: total number of path changes to destination
2094 u32 discovery_timeout;
2095 u8 discovery_retries;
2098 u32 path_change_count;
2104 * struct bss_parameters - BSS parameters
2106 * Used to change BSS parameters (mainly for AP mode).
2108 * @use_cts_prot: Whether to use CTS protection
2109 * (0 = no, 1 = yes, -1 = do not change)
2110 * @use_short_preamble: Whether the use of short preambles is allowed
2111 * (0 = no, 1 = yes, -1 = do not change)
2112 * @use_short_slot_time: Whether the use of short slot time is allowed
2113 * (0 = no, 1 = yes, -1 = do not change)
2114 * @basic_rates: basic rates in IEEE 802.11 format
2115 * (or NULL for no change)
2116 * @basic_rates_len: number of basic rates
2117 * @ap_isolate: do not forward packets between connected stations
2118 * (0 = no, 1 = yes, -1 = do not change)
2119 * @ht_opmode: HT Operation mode
2120 * (u16 = opmode, -1 = do not change)
2121 * @p2p_ctwindow: P2P CT Window (-1 = no change)
2122 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
2124 struct bss_parameters {
2126 int use_short_preamble;
2127 int use_short_slot_time;
2128 const u8 *basic_rates;
2132 s8 p2p_ctwindow, p2p_opp_ps;
2136 * struct mesh_config - 802.11s mesh configuration
2138 * These parameters can be changed while the mesh is active.
2140 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
2141 * by the Mesh Peering Open message
2142 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
2143 * used by the Mesh Peering Open message
2144 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
2145 * the mesh peering management to close a mesh peering
2146 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
2148 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
2149 * be sent to establish a new peer link instance in a mesh
2150 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
2151 * @element_ttl: the value of TTL field set at a mesh STA for path selection
2153 * @auto_open_plinks: whether we should automatically open peer links when we
2154 * detect compatible mesh peers
2155 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
2156 * synchronize to for 11s default synchronization method
2157 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
2158 * that an originator mesh STA can send to a particular path target
2159 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
2160 * @min_discovery_timeout: the minimum length of time to wait until giving up on
2161 * a path discovery in milliseconds
2162 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
2163 * receiving a PREQ shall consider the forwarding information from the
2164 * root to be valid. (TU = time unit)
2165 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
2166 * which a mesh STA can send only one action frame containing a PREQ
2168 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
2169 * which a mesh STA can send only one Action frame containing a PERR
2171 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
2172 * it takes for an HWMP information element to propagate across the mesh
2173 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
2174 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
2175 * announcements are transmitted
2176 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
2177 * station has access to a broader network beyond the MBSS. (This is
2178 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
2179 * only means that the station will announce others it's a mesh gate, but
2180 * not necessarily using the gate announcement protocol. Still keeping the
2181 * same nomenclature to be in sync with the spec)
2182 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
2183 * entity (default is TRUE - forwarding entity)
2184 * @rssi_threshold: the threshold for average signal strength of candidate
2185 * station to establish a peer link
2186 * @ht_opmode: mesh HT protection mode
2188 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
2189 * receiving a proactive PREQ shall consider the forwarding information to
2190 * the root mesh STA to be valid.
2192 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
2193 * PREQs are transmitted.
2194 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
2195 * during which a mesh STA can send only one Action frame containing
2196 * a PREQ element for root path confirmation.
2197 * @power_mode: The default mesh power save mode which will be the initial
2198 * setting for new peer links.
2199 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
2200 * after transmitting its beacon.
2201 * @plink_timeout: If no tx activity is seen from a STA we've established
2202 * peering with for longer than this time (in seconds), then remove it
2203 * from the STA's list of peers. Default is 30 minutes.
2204 * @dot11MeshConnectedToAuthServer: if set to true then this mesh STA
2205 * will advertise that it is connected to a authentication server
2206 * in the mesh formation field.
2207 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
2208 * connected to a mesh gate in mesh formation info. If false, the
2209 * value in mesh formation is determined by the presence of root paths
2210 * in the mesh path table
2211 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
2212 * for HWMP) if the destination is a direct neighbor. Note that this might
2213 * not be the optimal decision as a multi-hop route might be better. So
2214 * if using this setting you will likely also want to disable
2215 * dot11MeshForwarding and use another mesh routing protocol on top.
2217 struct mesh_config {
2218 u16 dot11MeshRetryTimeout;
2219 u16 dot11MeshConfirmTimeout;
2220 u16 dot11MeshHoldingTimeout;
2221 u16 dot11MeshMaxPeerLinks;
2222 u8 dot11MeshMaxRetries;
2225 bool auto_open_plinks;
2226 u32 dot11MeshNbrOffsetMaxNeighbor;
2227 u8 dot11MeshHWMPmaxPREQretries;
2228 u32 path_refresh_time;
2229 u16 min_discovery_timeout;
2230 u32 dot11MeshHWMPactivePathTimeout;
2231 u16 dot11MeshHWMPpreqMinInterval;
2232 u16 dot11MeshHWMPperrMinInterval;
2233 u16 dot11MeshHWMPnetDiameterTraversalTime;
2234 u8 dot11MeshHWMPRootMode;
2235 bool dot11MeshConnectedToMeshGate;
2236 bool dot11MeshConnectedToAuthServer;
2237 u16 dot11MeshHWMPRannInterval;
2238 bool dot11MeshGateAnnouncementProtocol;
2239 bool dot11MeshForwarding;
2242 u32 dot11MeshHWMPactivePathToRootTimeout;
2243 u16 dot11MeshHWMProotInterval;
2244 u16 dot11MeshHWMPconfirmationInterval;
2245 enum nl80211_mesh_power_mode power_mode;
2246 u16 dot11MeshAwakeWindowDuration;
2248 bool dot11MeshNolearn;
2252 * struct mesh_setup - 802.11s mesh setup configuration
2253 * @chandef: defines the channel to use
2254 * @mesh_id: the mesh ID
2255 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
2256 * @sync_method: which synchronization method to use
2257 * @path_sel_proto: which path selection protocol to use
2258 * @path_metric: which metric to use
2259 * @auth_id: which authentication method this mesh is using
2260 * @ie: vendor information elements (optional)
2261 * @ie_len: length of vendor information elements
2262 * @is_authenticated: this mesh requires authentication
2263 * @is_secure: this mesh uses security
2264 * @user_mpm: userspace handles all MPM functions
2265 * @dtim_period: DTIM period to use
2266 * @beacon_interval: beacon interval to use
2267 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2268 * @basic_rates: basic rates to use when creating the mesh
2269 * @beacon_rate: bitrate to be used for beacons
2270 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2271 * changes the channel when a radar is detected. This is required
2272 * to operate on DFS channels.
2273 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2274 * port frames over NL80211 instead of the network interface.
2276 * These parameters are fixed when the mesh is created.
2279 struct cfg80211_chan_def chandef;
2288 bool is_authenticated;
2292 u16 beacon_interval;
2293 int mcast_rate[NUM_NL80211_BANDS];
2295 struct cfg80211_bitrate_mask beacon_rate;
2296 bool userspace_handles_dfs;
2297 bool control_port_over_nl80211;
2301 * struct ocb_setup - 802.11p OCB mode setup configuration
2302 * @chandef: defines the channel to use
2304 * These parameters are fixed when connecting to the network
2307 struct cfg80211_chan_def chandef;
2311 * struct ieee80211_txq_params - TX queue parameters
2312 * @ac: AC identifier
2313 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2314 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2316 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2318 * @aifs: Arbitration interframe space [0..255]
2320 struct ieee80211_txq_params {
2329 * DOC: Scanning and BSS list handling
2331 * The scanning process itself is fairly simple, but cfg80211 offers quite
2332 * a bit of helper functionality. To start a scan, the scan operation will
2333 * be invoked with a scan definition. This scan definition contains the
2334 * channels to scan, and the SSIDs to send probe requests for (including the
2335 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2336 * probe. Additionally, a scan request may contain extra information elements
2337 * that should be added to the probe request. The IEs are guaranteed to be
2338 * well-formed, and will not exceed the maximum length the driver advertised
2339 * in the wiphy structure.
2341 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2342 * it is responsible for maintaining the BSS list; the driver should not
2343 * maintain a list itself. For this notification, various functions exist.
2345 * Since drivers do not maintain a BSS list, there are also a number of
2346 * functions to search for a BSS and obtain information about it from the
2347 * BSS structure cfg80211 maintains. The BSS list is also made available
2352 * struct cfg80211_ssid - SSID description
2354 * @ssid_len: length of the ssid
2356 struct cfg80211_ssid {
2357 u8 ssid[IEEE80211_MAX_SSID_LEN];
2362 * struct cfg80211_scan_info - information about completed scan
2363 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2364 * wireless device that requested the scan is connected to. If this
2365 * information is not available, this field is left zero.
2366 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2367 * @aborted: set to true if the scan was aborted for any reason,
2368 * userspace will be notified of that
2370 struct cfg80211_scan_info {
2372 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2377 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2379 * @short_ssid: short ssid to scan for
2380 * @bssid: bssid to scan for
2381 * @channel_idx: idx of the channel in the channel array in the scan request
2382 * which the above info relvant to
2383 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2384 * @short_ssid_valid: @short_ssid is valid and can be used
2385 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2386 * 20 TUs before starting to send probe requests.
2388 struct cfg80211_scan_6ghz_params {
2392 bool unsolicited_probe;
2393 bool short_ssid_valid;
2398 * struct cfg80211_scan_request - scan request description
2400 * @ssids: SSIDs to scan for (active scan only)
2401 * @n_ssids: number of SSIDs
2402 * @channels: channels to scan on.
2403 * @n_channels: total number of channels to scan
2404 * @scan_width: channel width for scanning
2405 * @ie: optional information element(s) to add into Probe Request or %NULL
2406 * @ie_len: length of ie in octets
2407 * @duration: how long to listen on each channel, in TUs. If
2408 * %duration_mandatory is not set, this is the maximum dwell time and
2409 * the actual dwell time may be shorter.
2410 * @duration_mandatory: if set, the scan duration must be as specified by the
2412 * @flags: bit field of flags controlling operation
2413 * @rates: bitmap of rates to advertise for each band
2414 * @wiphy: the wiphy this was for
2415 * @scan_start: time (in jiffies) when the scan started
2416 * @wdev: the wireless device to scan for
2417 * @info: (internal) information about completed scan
2418 * @notified: (internal) scan request was notified as done or aborted
2419 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2420 * @mac_addr: MAC address used with randomisation
2421 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2422 * are 0 in the mask should be randomised, bits that are 1 should
2423 * be taken from the @mac_addr
2424 * @scan_6ghz: relevant for split scan request only,
2425 * true if this is the second scan request
2426 * @n_6ghz_params: number of 6 GHz params
2427 * @scan_6ghz_params: 6 GHz params
2428 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2430 struct cfg80211_scan_request {
2431 struct cfg80211_ssid *ssids;
2434 enum nl80211_bss_scan_width scan_width;
2438 bool duration_mandatory;
2441 u32 rates[NUM_NL80211_BANDS];
2443 struct wireless_dev *wdev;
2445 u8 mac_addr[ETH_ALEN] __aligned(2);
2446 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2447 u8 bssid[ETH_ALEN] __aligned(2);
2450 struct wiphy *wiphy;
2451 unsigned long scan_start;
2452 struct cfg80211_scan_info info;
2457 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2460 struct ieee80211_channel *channels[];
2463 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2467 get_random_bytes(buf, ETH_ALEN);
2468 for (i = 0; i < ETH_ALEN; i++) {
2470 buf[i] |= addr[i] & mask[i];
2475 * struct cfg80211_match_set - sets of attributes to match
2477 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2478 * or no match (RSSI only)
2479 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2480 * or no match (RSSI only)
2481 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2482 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2483 * for filtering out scan results received. Drivers advertize this support
2484 * of band specific rssi based filtering through the feature capability
2485 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2486 * specific rssi thresholds take precedence over rssi_thold, if specified.
2487 * If not specified for any band, it will be assigned with rssi_thold of
2488 * corresponding matchset.
2490 struct cfg80211_match_set {
2491 struct cfg80211_ssid ssid;
2494 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2498 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2500 * @interval: interval between scheduled scan iterations. In seconds.
2501 * @iterations: number of scan iterations in this scan plan. Zero means
2503 * The last scan plan will always have this parameter set to zero,
2504 * all other scan plans will have a finite number of iterations.
2506 struct cfg80211_sched_scan_plan {
2512 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2514 * @band: band of BSS which should match for RSSI level adjustment.
2515 * @delta: value of RSSI level adjustment.
2517 struct cfg80211_bss_select_adjust {
2518 enum nl80211_band band;
2523 * struct cfg80211_sched_scan_request - scheduled scan request description
2525 * @reqid: identifies this request.
2526 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2527 * @n_ssids: number of SSIDs
2528 * @n_channels: total number of channels to scan
2529 * @scan_width: channel width for scanning
2530 * @ie: optional information element(s) to add into Probe Request or %NULL
2531 * @ie_len: length of ie in octets
2532 * @flags: bit field of flags controlling operation
2533 * @match_sets: sets of parameters to be matched for a scan result
2534 * entry to be considered valid and to be passed to the host
2535 * (others are filtered out).
2536 * If ommited, all results are passed.
2537 * @n_match_sets: number of match sets
2538 * @report_results: indicates that results were reported for this request
2539 * @wiphy: the wiphy this was for
2540 * @dev: the interface
2541 * @scan_start: start time of the scheduled scan
2542 * @channels: channels to scan
2543 * @min_rssi_thold: for drivers only supporting a single threshold, this
2544 * contains the minimum over all matchsets
2545 * @mac_addr: MAC address used with randomisation
2546 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2547 * are 0 in the mask should be randomised, bits that are 1 should
2548 * be taken from the @mac_addr
2549 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2550 * index must be executed first.
2551 * @n_scan_plans: number of scan plans, at least 1.
2552 * @rcu_head: RCU callback used to free the struct
2553 * @owner_nlportid: netlink portid of owner (if this should is a request
2554 * owned by a particular socket)
2555 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2556 * @list: for keeping list of requests.
2557 * @delay: delay in seconds to use before starting the first scan
2558 * cycle. The driver may ignore this parameter and start
2559 * immediately (or at any other time), if this feature is not
2561 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2562 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2563 * reporting in connected state to cases where a matching BSS is determined
2564 * to have better or slightly worse RSSI than the current connected BSS.
2565 * The relative RSSI threshold values are ignored in disconnected state.
2566 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2567 * to the specified band while deciding whether a better BSS is reported
2568 * using @relative_rssi. If delta is a negative number, the BSSs that
2569 * belong to the specified band will be penalized by delta dB in relative
2572 struct cfg80211_sched_scan_request {
2574 struct cfg80211_ssid *ssids;
2577 enum nl80211_bss_scan_width scan_width;
2581 struct cfg80211_match_set *match_sets;
2585 struct cfg80211_sched_scan_plan *scan_plans;
2588 u8 mac_addr[ETH_ALEN] __aligned(2);
2589 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2591 bool relative_rssi_set;
2593 struct cfg80211_bss_select_adjust rssi_adjust;
2596 struct wiphy *wiphy;
2597 struct net_device *dev;
2598 unsigned long scan_start;
2599 bool report_results;
2600 struct rcu_head rcu_head;
2603 struct list_head list;
2606 struct ieee80211_channel *channels[];
2610 * enum cfg80211_signal_type - signal type
2612 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2613 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2614 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2616 enum cfg80211_signal_type {
2617 CFG80211_SIGNAL_TYPE_NONE,
2618 CFG80211_SIGNAL_TYPE_MBM,
2619 CFG80211_SIGNAL_TYPE_UNSPEC,
2623 * struct cfg80211_inform_bss - BSS inform data
2624 * @chan: channel the frame was received on
2625 * @scan_width: scan width that was used
2626 * @signal: signal strength value, according to the wiphy's
2628 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2629 * received; should match the time when the frame was actually
2630 * received by the device (not just by the host, in case it was
2631 * buffered on the device) and be accurate to about 10ms.
2632 * If the frame isn't buffered, just passing the return value of
2633 * ktime_get_boottime_ns() is likely appropriate.
2634 * @parent_tsf: the time at the start of reception of the first octet of the
2635 * timestamp field of the frame. The time is the TSF of the BSS specified
2637 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2638 * the BSS that requested the scan in which the beacon/probe was received.
2639 * @chains: bitmask for filled values in @chain_signal.
2640 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2642 struct cfg80211_inform_bss {
2643 struct ieee80211_channel *chan;
2644 enum nl80211_bss_scan_width scan_width;
2648 u8 parent_bssid[ETH_ALEN] __aligned(2);
2650 s8 chain_signal[IEEE80211_MAX_CHAINS];
2654 * struct cfg80211_bss_ies - BSS entry IE data
2655 * @tsf: TSF contained in the frame that carried these IEs
2656 * @rcu_head: internal use, for freeing
2657 * @len: length of the IEs
2658 * @from_beacon: these IEs are known to come from a beacon
2661 struct cfg80211_bss_ies {
2663 struct rcu_head rcu_head;
2670 * struct cfg80211_bss - BSS description
2672 * This structure describes a BSS (which may also be a mesh network)
2673 * for use in scan results and similar.
2675 * @channel: channel this BSS is on
2676 * @scan_width: width of the control channel
2677 * @bssid: BSSID of the BSS
2678 * @beacon_interval: the beacon interval as from the frame
2679 * @capability: the capability field in host byte order
2680 * @ies: the information elements (Note that there is no guarantee that these
2681 * are well-formed!); this is a pointer to either the beacon_ies or
2682 * proberesp_ies depending on whether Probe Response frame has been
2683 * received. It is always non-%NULL.
2684 * @beacon_ies: the information elements from the last Beacon frame
2685 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2686 * own the beacon_ies, but they're just pointers to the ones from the
2687 * @hidden_beacon_bss struct)
2688 * @proberesp_ies: the information elements from the last Probe Response frame
2689 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2690 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2691 * that holds the beacon data. @beacon_ies is still valid, of course, and
2692 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2693 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2694 * non-transmitted one (multi-BSSID support)
2695 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2696 * (multi-BSSID support)
2697 * @signal: signal strength value (type depends on the wiphy's signal_type)
2698 * @chains: bitmask for filled values in @chain_signal.
2699 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2700 * @bssid_index: index in the multiple BSS set
2701 * @max_bssid_indicator: max number of members in the BSS set
2702 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2704 struct cfg80211_bss {
2705 struct ieee80211_channel *channel;
2706 enum nl80211_bss_scan_width scan_width;
2708 const struct cfg80211_bss_ies __rcu *ies;
2709 const struct cfg80211_bss_ies __rcu *beacon_ies;
2710 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2712 struct cfg80211_bss *hidden_beacon_bss;
2713 struct cfg80211_bss *transmitted_bss;
2714 struct list_head nontrans_list;
2718 u16 beacon_interval;
2723 s8 chain_signal[IEEE80211_MAX_CHAINS];
2726 u8 max_bssid_indicator;
2728 u8 priv[] __aligned(sizeof(void *));
2732 * ieee80211_bss_get_elem - find element with given ID
2733 * @bss: the bss to search
2734 * @id: the element ID
2736 * Note that the return value is an RCU-protected pointer, so
2737 * rcu_read_lock() must be held when calling this function.
2738 * Return: %NULL if not found.
2740 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2743 * ieee80211_bss_get_ie - find IE with given ID
2744 * @bss: the bss to search
2745 * @id: the element ID
2747 * Note that the return value is an RCU-protected pointer, so
2748 * rcu_read_lock() must be held when calling this function.
2749 * Return: %NULL if not found.
2751 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2753 return (const void *)ieee80211_bss_get_elem(bss, id);
2758 * struct cfg80211_auth_request - Authentication request data
2760 * This structure provides information needed to complete IEEE 802.11
2763 * @bss: The BSS to authenticate with, the callee must obtain a reference
2764 * to it if it needs to keep it.
2765 * @auth_type: Authentication type (algorithm)
2766 * @ie: Extra IEs to add to Authentication frame or %NULL
2767 * @ie_len: Length of ie buffer in octets
2768 * @key_len: length of WEP key for shared key authentication
2769 * @key_idx: index of WEP key for shared key authentication
2770 * @key: WEP key for shared key authentication
2771 * @auth_data: Fields and elements in Authentication frames. This contains
2772 * the authentication frame body (non-IE and IE data), excluding the
2773 * Authentication algorithm number, i.e., starting at the Authentication
2774 * transaction sequence number field.
2775 * @auth_data_len: Length of auth_data buffer in octets
2776 * @link_id: if >= 0, indicates authentication should be done as an MLD,
2777 * the interface address is included as the MLD address and the
2778 * necessary link (with the given link_id) will be created (and
2779 * given an MLD address) by the driver
2780 * @ap_mld_addr: AP MLD address in case of authentication request with
2781 * an AP MLD, valid iff @link_id >= 0
2783 struct cfg80211_auth_request {
2784 struct cfg80211_bss *bss;
2787 enum nl80211_auth_type auth_type;
2791 const u8 *auth_data;
2792 size_t auth_data_len;
2794 const u8 *ap_mld_addr;
2798 * struct cfg80211_assoc_link - per-link information for MLO association
2799 * @bss: the BSS pointer, see also &struct cfg80211_assoc_request::bss;
2800 * if this is %NULL for a link, that link is not requested
2801 * @elems: extra elements for the per-STA profile for this link
2802 * @elems_len: length of the elements
2804 struct cfg80211_assoc_link {
2805 struct cfg80211_bss *bss;
2811 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2813 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2814 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2815 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2816 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2817 * authentication capability. Drivers can offload authentication to
2818 * userspace if this flag is set. Only applicable for cfg80211_connect()
2819 * request (connect callback).
2820 * @ASSOC_REQ_DISABLE_HE: Disable HE
2821 * @ASSOC_REQ_DISABLE_EHT: Disable EHT
2822 * @CONNECT_REQ_MLO_SUPPORT: Userspace indicates support for handling MLD links.
2823 * Drivers shall disable MLO features for the current association if this
2826 enum cfg80211_assoc_req_flags {
2827 ASSOC_REQ_DISABLE_HT = BIT(0),
2828 ASSOC_REQ_DISABLE_VHT = BIT(1),
2829 ASSOC_REQ_USE_RRM = BIT(2),
2830 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2831 ASSOC_REQ_DISABLE_HE = BIT(4),
2832 ASSOC_REQ_DISABLE_EHT = BIT(5),
2833 CONNECT_REQ_MLO_SUPPORT = BIT(6),
2837 * struct cfg80211_assoc_request - (Re)Association request data
2839 * This structure provides information needed to complete IEEE 802.11
2841 * @bss: The BSS to associate with. If the call is successful the driver is
2842 * given a reference that it must give back to cfg80211_send_rx_assoc()
2843 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2844 * association requests while already associating must be rejected.
2845 * This also applies to the @links.bss parameter, which is used instead
2846 * of this one (it is %NULL) for MLO associations.
2847 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2848 * @ie_len: Length of ie buffer in octets
2849 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2850 * @crypto: crypto settings
2851 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2852 * to indicate a request to reassociate within the ESS instead of a request
2853 * do the initial association with the ESS. When included, this is set to
2854 * the BSSID of the current association, i.e., to the value that is
2855 * included in the Current AP address field of the Reassociation Request
2857 * @flags: See &enum cfg80211_assoc_req_flags
2858 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2859 * will be used in ht_capa. Un-supported values will be ignored.
2860 * @ht_capa_mask: The bits of ht_capa which are to be used.
2861 * @vht_capa: VHT capability override
2862 * @vht_capa_mask: VHT capability mask indicating which fields to use
2863 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2864 * %NULL if FILS is not used.
2865 * @fils_kek_len: Length of fils_kek in octets
2866 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2867 * Request/Response frame or %NULL if FILS is not used. This field starts
2868 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2869 * @s1g_capa: S1G capability override
2870 * @s1g_capa_mask: S1G capability override mask
2871 * @links: per-link information for MLO connections
2872 * @link_id: >= 0 for MLO connections, where links are given, and indicates
2873 * the link on which the association request should be sent
2874 * @ap_mld_addr: AP MLD address in case of MLO association request,
2875 * valid iff @link_id >= 0
2877 struct cfg80211_assoc_request {
2878 struct cfg80211_bss *bss;
2879 const u8 *ie, *prev_bssid;
2881 struct cfg80211_crypto_settings crypto;
2884 struct ieee80211_ht_cap ht_capa;
2885 struct ieee80211_ht_cap ht_capa_mask;
2886 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2888 size_t fils_kek_len;
2889 const u8 *fils_nonces;
2890 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2891 struct cfg80211_assoc_link links[IEEE80211_MLD_MAX_NUM_LINKS];
2892 const u8 *ap_mld_addr;
2897 * struct cfg80211_deauth_request - Deauthentication request data
2899 * This structure provides information needed to complete IEEE 802.11
2902 * @bssid: the BSSID or AP MLD address to deauthenticate from
2903 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2904 * @ie_len: Length of ie buffer in octets
2905 * @reason_code: The reason code for the deauthentication
2906 * @local_state_change: if set, change local state only and
2907 * do not set a deauth frame
2909 struct cfg80211_deauth_request {
2914 bool local_state_change;
2918 * struct cfg80211_disassoc_request - Disassociation request data
2920 * This structure provides information needed to complete IEEE 802.11
2923 * @ap_addr: the BSSID or AP MLD address to disassociate from
2924 * @ie: Extra IEs to add to Disassociation frame or %NULL
2925 * @ie_len: Length of ie buffer in octets
2926 * @reason_code: The reason code for the disassociation
2927 * @local_state_change: This is a request for a local state only, i.e., no
2928 * Disassociation frame is to be transmitted.
2930 struct cfg80211_disassoc_request {
2935 bool local_state_change;
2939 * struct cfg80211_ibss_params - IBSS parameters
2941 * This structure defines the IBSS parameters for the join_ibss()
2944 * @ssid: The SSID, will always be non-null.
2945 * @ssid_len: The length of the SSID, will always be non-zero.
2946 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2947 * search for IBSSs with a different BSSID.
2948 * @chandef: defines the channel to use if no other IBSS to join can be found
2949 * @channel_fixed: The channel should be fixed -- do not search for
2950 * IBSSs to join on other channels.
2951 * @ie: information element(s) to include in the beacon
2952 * @ie_len: length of that
2953 * @beacon_interval: beacon interval to use
2954 * @privacy: this is a protected network, keys will be configured
2956 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2957 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2958 * required to assume that the port is unauthorized until authorized by
2959 * user space. Otherwise, port is marked authorized by default.
2960 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2961 * port frames over NL80211 instead of the network interface.
2962 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2963 * changes the channel when a radar is detected. This is required
2964 * to operate on DFS channels.
2965 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2966 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2967 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2968 * will be used in ht_capa. Un-supported values will be ignored.
2969 * @ht_capa_mask: The bits of ht_capa which are to be used.
2970 * @wep_keys: static WEP keys, if not NULL points to an array of
2971 * CFG80211_MAX_WEP_KEYS WEP keys
2972 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2974 struct cfg80211_ibss_params {
2977 struct cfg80211_chan_def chandef;
2979 u8 ssid_len, ie_len;
2980 u16 beacon_interval;
2985 bool control_port_over_nl80211;
2986 bool userspace_handles_dfs;
2987 int mcast_rate[NUM_NL80211_BANDS];
2988 struct ieee80211_ht_cap ht_capa;
2989 struct ieee80211_ht_cap ht_capa_mask;
2990 struct key_params *wep_keys;
2995 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2997 * @behaviour: requested BSS selection behaviour.
2998 * @param: parameters for requestion behaviour.
2999 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
3000 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
3002 struct cfg80211_bss_selection {
3003 enum nl80211_bss_select_attr behaviour;
3005 enum nl80211_band band_pref;
3006 struct cfg80211_bss_select_adjust adjust;
3011 * struct cfg80211_connect_params - Connection parameters
3013 * This structure provides information needed to complete IEEE 802.11
3014 * authentication and association.
3016 * @channel: The channel to use or %NULL if not specified (auto-select based
3018 * @channel_hint: The channel of the recommended BSS for initial connection or
3019 * %NULL if not specified
3020 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
3022 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
3023 * %NULL if not specified. Unlike the @bssid parameter, the driver is
3024 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
3027 * @ssid_len: Length of ssid in octets
3028 * @auth_type: Authentication type (algorithm)
3029 * @ie: IEs for association request
3030 * @ie_len: Length of assoc_ie in octets
3031 * @privacy: indicates whether privacy-enabled APs should be used
3032 * @mfp: indicate whether management frame protection is used
3033 * @crypto: crypto settings
3034 * @key_len: length of WEP key for shared key authentication
3035 * @key_idx: index of WEP key for shared key authentication
3036 * @key: WEP key for shared key authentication
3037 * @flags: See &enum cfg80211_assoc_req_flags
3038 * @bg_scan_period: Background scan period in seconds
3039 * or -1 to indicate that default value is to be used.
3040 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
3041 * will be used in ht_capa. Un-supported values will be ignored.
3042 * @ht_capa_mask: The bits of ht_capa which are to be used.
3043 * @vht_capa: VHT Capability overrides
3044 * @vht_capa_mask: The bits of vht_capa which are to be used.
3045 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
3047 * @bss_select: criteria to be used for BSS selection.
3048 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
3049 * to indicate a request to reassociate within the ESS instead of a request
3050 * do the initial association with the ESS. When included, this is set to
3051 * the BSSID of the current association, i.e., to the value that is
3052 * included in the Current AP address field of the Reassociation Request
3054 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
3055 * NAI or %NULL if not specified. This is used to construct FILS wrapped
3057 * @fils_erp_username_len: Length of @fils_erp_username in octets.
3058 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
3059 * %NULL if not specified. This specifies the domain name of ER server and
3060 * is used to construct FILS wrapped data IE.
3061 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
3062 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
3063 * messages. This is also used to construct FILS wrapped data IE.
3064 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
3065 * keys in FILS or %NULL if not specified.
3066 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
3067 * @want_1x: indicates user-space supports and wants to use 802.1X driver
3068 * offload of 4-way handshake.
3069 * @edmg: define the EDMG channels.
3070 * This may specify multiple channels and bonding options for the driver
3071 * to choose from, based on BSS configuration.
3073 struct cfg80211_connect_params {
3074 struct ieee80211_channel *channel;
3075 struct ieee80211_channel *channel_hint;
3077 const u8 *bssid_hint;
3080 enum nl80211_auth_type auth_type;
3084 enum nl80211_mfp mfp;
3085 struct cfg80211_crypto_settings crypto;
3087 u8 key_len, key_idx;
3090 struct ieee80211_ht_cap ht_capa;
3091 struct ieee80211_ht_cap ht_capa_mask;
3092 struct ieee80211_vht_cap vht_capa;
3093 struct ieee80211_vht_cap vht_capa_mask;
3095 struct cfg80211_bss_selection bss_select;
3096 const u8 *prev_bssid;
3097 const u8 *fils_erp_username;
3098 size_t fils_erp_username_len;
3099 const u8 *fils_erp_realm;
3100 size_t fils_erp_realm_len;
3101 u16 fils_erp_next_seq_num;
3102 const u8 *fils_erp_rrk;
3103 size_t fils_erp_rrk_len;
3105 struct ieee80211_edmg edmg;
3109 * enum cfg80211_connect_params_changed - Connection parameters being updated
3111 * This enum provides information of all connect parameters that
3112 * have to be updated as part of update_connect_params() call.
3114 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
3115 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
3116 * username, erp sequence number and rrk) are updated
3117 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
3119 enum cfg80211_connect_params_changed {
3120 UPDATE_ASSOC_IES = BIT(0),
3121 UPDATE_FILS_ERP_INFO = BIT(1),
3122 UPDATE_AUTH_TYPE = BIT(2),
3126 * enum wiphy_params_flags - set_wiphy_params bitfield values
3127 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
3128 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
3129 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
3130 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
3131 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
3132 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
3133 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
3134 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
3135 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
3137 enum wiphy_params_flags {
3138 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
3139 WIPHY_PARAM_RETRY_LONG = 1 << 1,
3140 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
3141 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
3142 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
3143 WIPHY_PARAM_DYN_ACK = 1 << 5,
3144 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
3145 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
3146 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
3149 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
3151 /* The per TXQ device queue limit in airtime */
3152 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
3153 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
3155 /* The per interface airtime threshold to switch to lower queue limit */
3156 #define IEEE80211_AQL_THRESHOLD 24000
3159 * struct cfg80211_pmksa - PMK Security Association
3161 * This structure is passed to the set/del_pmksa() method for PMKSA
3164 * @bssid: The AP's BSSID (may be %NULL).
3165 * @pmkid: The identifier to refer a PMKSA.
3166 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
3167 * derivation by a FILS STA. Otherwise, %NULL.
3168 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
3169 * the hash algorithm used to generate this.
3170 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
3171 * cache identifier (may be %NULL).
3172 * @ssid_len: Length of the @ssid in octets.
3173 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
3174 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
3176 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
3177 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
3178 * The configured PMKSA must not be used for PMKSA caching after
3179 * expiration and any keys derived from this PMK become invalid on
3180 * expiration, i.e., the current association must be dropped if the PMK
3181 * used for it expires.
3182 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
3183 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
3184 * Drivers are expected to trigger a full authentication instead of using
3185 * this PMKSA for caching when reassociating to a new BSS after this
3186 * threshold to generate a new PMK before the current one expires.
3188 struct cfg80211_pmksa {
3197 u8 pmk_reauth_threshold;
3201 * struct cfg80211_pkt_pattern - packet pattern
3202 * @mask: bitmask where to match pattern and where to ignore bytes,
3203 * one bit per byte, in same format as nl80211
3204 * @pattern: bytes to match where bitmask is 1
3205 * @pattern_len: length of pattern (in bytes)
3206 * @pkt_offset: packet offset (in bytes)
3208 * Internal note: @mask and @pattern are allocated in one chunk of
3209 * memory, free @mask only!
3211 struct cfg80211_pkt_pattern {
3212 const u8 *mask, *pattern;
3218 * struct cfg80211_wowlan_tcp - TCP connection parameters
3220 * @sock: (internal) socket for source port allocation
3221 * @src: source IP address
3222 * @dst: destination IP address
3223 * @dst_mac: destination MAC address
3224 * @src_port: source port
3225 * @dst_port: destination port
3226 * @payload_len: data payload length
3227 * @payload: data payload buffer
3228 * @payload_seq: payload sequence stamping configuration
3229 * @data_interval: interval at which to send data packets
3230 * @wake_len: wakeup payload match length
3231 * @wake_data: wakeup payload match data
3232 * @wake_mask: wakeup payload match mask
3233 * @tokens_size: length of the tokens buffer
3234 * @payload_tok: payload token usage configuration
3236 struct cfg80211_wowlan_tcp {
3237 struct socket *sock;
3239 u16 src_port, dst_port;
3240 u8 dst_mac[ETH_ALEN];
3243 struct nl80211_wowlan_tcp_data_seq payload_seq;
3246 const u8 *wake_data, *wake_mask;
3248 /* must be last, variable member */
3249 struct nl80211_wowlan_tcp_data_token payload_tok;
3253 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3255 * This structure defines the enabled WoWLAN triggers for the device.
3256 * @any: wake up on any activity -- special trigger if device continues
3257 * operating as normal during suspend
3258 * @disconnect: wake up if getting disconnected
3259 * @magic_pkt: wake up on receiving magic packet
3260 * @patterns: wake up on receiving packet matching a pattern
3261 * @n_patterns: number of patterns
3262 * @gtk_rekey_failure: wake up on GTK rekey failure
3263 * @eap_identity_req: wake up on EAP identity request packet
3264 * @four_way_handshake: wake up on 4-way handshake
3265 * @rfkill_release: wake up when rfkill is released
3266 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3267 * NULL if not configured.
3268 * @nd_config: configuration for the scan to be used for net detect wake.
3270 struct cfg80211_wowlan {
3271 bool any, disconnect, magic_pkt, gtk_rekey_failure,
3272 eap_identity_req, four_way_handshake,
3274 struct cfg80211_pkt_pattern *patterns;
3275 struct cfg80211_wowlan_tcp *tcp;
3277 struct cfg80211_sched_scan_request *nd_config;
3281 * struct cfg80211_coalesce_rules - Coalesce rule parameters
3283 * This structure defines coalesce rule for the device.
3284 * @delay: maximum coalescing delay in msecs.
3285 * @condition: condition for packet coalescence.
3286 * see &enum nl80211_coalesce_condition.
3287 * @patterns: array of packet patterns
3288 * @n_patterns: number of patterns
3290 struct cfg80211_coalesce_rules {
3292 enum nl80211_coalesce_condition condition;
3293 struct cfg80211_pkt_pattern *patterns;
3298 * struct cfg80211_coalesce - Packet coalescing settings
3300 * This structure defines coalescing settings.
3301 * @rules: array of coalesce rules
3302 * @n_rules: number of rules
3304 struct cfg80211_coalesce {
3305 struct cfg80211_coalesce_rules *rules;
3310 * struct cfg80211_wowlan_nd_match - information about the match
3312 * @ssid: SSID of the match that triggered the wake up
3313 * @n_channels: Number of channels where the match occurred. This
3314 * value may be zero if the driver can't report the channels.
3315 * @channels: center frequencies of the channels where a match
3318 struct cfg80211_wowlan_nd_match {
3319 struct cfg80211_ssid ssid;
3325 * struct cfg80211_wowlan_nd_info - net detect wake up information
3327 * @n_matches: Number of match information instances provided in
3328 * @matches. This value may be zero if the driver can't provide
3329 * match information.
3330 * @matches: Array of pointers to matches containing information about
3331 * the matches that triggered the wake up.
3333 struct cfg80211_wowlan_nd_info {
3335 struct cfg80211_wowlan_nd_match *matches[];
3339 * struct cfg80211_wowlan_wakeup - wakeup report
3340 * @disconnect: woke up by getting disconnected
3341 * @magic_pkt: woke up by receiving magic packet
3342 * @gtk_rekey_failure: woke up by GTK rekey failure
3343 * @eap_identity_req: woke up by EAP identity request packet
3344 * @four_way_handshake: woke up by 4-way handshake
3345 * @rfkill_release: woke up by rfkill being released
3346 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3347 * @packet_present_len: copied wakeup packet data
3348 * @packet_len: original wakeup packet length
3349 * @packet: The packet causing the wakeup, if any.
3350 * @packet_80211: For pattern match, magic packet and other data
3351 * frame triggers an 802.3 frame should be reported, for
3352 * disconnect due to deauth 802.11 frame. This indicates which
3354 * @tcp_match: TCP wakeup packet received
3355 * @tcp_connlost: TCP connection lost or failed to establish
3356 * @tcp_nomoretokens: TCP data ran out of tokens
3357 * @net_detect: if not %NULL, woke up because of net detect
3359 struct cfg80211_wowlan_wakeup {
3360 bool disconnect, magic_pkt, gtk_rekey_failure,
3361 eap_identity_req, four_way_handshake,
3362 rfkill_release, packet_80211,
3363 tcp_match, tcp_connlost, tcp_nomoretokens;
3365 u32 packet_present_len, packet_len;
3367 struct cfg80211_wowlan_nd_info *net_detect;
3371 * struct cfg80211_gtk_rekey_data - rekey data
3372 * @kek: key encryption key (@kek_len bytes)
3373 * @kck: key confirmation key (@kck_len bytes)
3374 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3375 * @kek_len: length of kek
3376 * @kck_len: length of kck
3377 * @akm: akm (oui, id)
3379 struct cfg80211_gtk_rekey_data {
3380 const u8 *kek, *kck, *replay_ctr;
3382 u8 kek_len, kck_len;
3386 * struct cfg80211_update_ft_ies_params - FT IE Information
3388 * This structure provides information needed to update the fast transition IE
3390 * @md: The Mobility Domain ID, 2 Octet value
3391 * @ie: Fast Transition IEs
3392 * @ie_len: Length of ft_ie in octets
3394 struct cfg80211_update_ft_ies_params {
3401 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3403 * This structure provides information needed to transmit a mgmt frame
3405 * @chan: channel to use
3406 * @offchan: indicates wether off channel operation is required
3407 * @wait: duration for ROC
3408 * @buf: buffer to transmit
3409 * @len: buffer length
3410 * @no_cck: don't use cck rates for this frame
3411 * @dont_wait_for_ack: tells the low level not to wait for an ack
3412 * @n_csa_offsets: length of csa_offsets array
3413 * @csa_offsets: array of all the csa offsets in the frame
3414 * @link_id: for MLO, the link ID to transmit on, -1 if not given; note
3415 * that the link ID isn't validated (much), it's in range but the
3416 * link might not exist (or be used by the receiver STA)
3418 struct cfg80211_mgmt_tx_params {
3419 struct ieee80211_channel *chan;
3425 bool dont_wait_for_ack;
3427 const u16 *csa_offsets;
3432 * struct cfg80211_dscp_exception - DSCP exception
3434 * @dscp: DSCP value that does not adhere to the user priority range definition
3435 * @up: user priority value to which the corresponding DSCP value belongs
3437 struct cfg80211_dscp_exception {
3443 * struct cfg80211_dscp_range - DSCP range definition for user priority
3445 * @low: lowest DSCP value of this user priority range, inclusive
3446 * @high: highest DSCP value of this user priority range, inclusive
3448 struct cfg80211_dscp_range {
3453 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3454 #define IEEE80211_QOS_MAP_MAX_EX 21
3455 #define IEEE80211_QOS_MAP_LEN_MIN 16
3456 #define IEEE80211_QOS_MAP_LEN_MAX \
3457 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3460 * struct cfg80211_qos_map - QoS Map Information
3462 * This struct defines the Interworking QoS map setting for DSCP values
3464 * @num_des: number of DSCP exceptions (0..21)
3465 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3466 * the user priority DSCP range definition
3467 * @up: DSCP range definition for a particular user priority
3469 struct cfg80211_qos_map {
3471 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3472 struct cfg80211_dscp_range up[8];
3476 * struct cfg80211_nan_conf - NAN configuration
3478 * This struct defines NAN configuration parameters
3480 * @master_pref: master preference (1 - 255)
3481 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3482 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3483 * (i.e. BIT(NL80211_BAND_2GHZ)).
3485 struct cfg80211_nan_conf {
3491 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3494 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3495 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3497 enum cfg80211_nan_conf_changes {
3498 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3499 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3503 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3505 * @filter: the content of the filter
3506 * @len: the length of the filter
3508 struct cfg80211_nan_func_filter {
3514 * struct cfg80211_nan_func - a NAN function
3516 * @type: &enum nl80211_nan_function_type
3517 * @service_id: the service ID of the function
3518 * @publish_type: &nl80211_nan_publish_type
3519 * @close_range: if true, the range should be limited. Threshold is
3520 * implementation specific.
3521 * @publish_bcast: if true, the solicited publish should be broadcasted
3522 * @subscribe_active: if true, the subscribe is active
3523 * @followup_id: the instance ID for follow up
3524 * @followup_reqid: the requestor instance ID for follow up
3525 * @followup_dest: MAC address of the recipient of the follow up
3526 * @ttl: time to live counter in DW.
3527 * @serv_spec_info: Service Specific Info
3528 * @serv_spec_info_len: Service Specific Info length
3529 * @srf_include: if true, SRF is inclusive
3530 * @srf_bf: Bloom Filter
3531 * @srf_bf_len: Bloom Filter length
3532 * @srf_bf_idx: Bloom Filter index
3533 * @srf_macs: SRF MAC addresses
3534 * @srf_num_macs: number of MAC addresses in SRF
3535 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3536 * @tx_filters: filters that should be transmitted in the SDF.
3537 * @num_rx_filters: length of &rx_filters.
3538 * @num_tx_filters: length of &tx_filters.
3539 * @instance_id: driver allocated id of the function.
3540 * @cookie: unique NAN function identifier.
3542 struct cfg80211_nan_func {
3543 enum nl80211_nan_function_type type;
3544 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3548 bool subscribe_active;
3551 struct mac_address followup_dest;
3553 const u8 *serv_spec_info;
3554 u8 serv_spec_info_len;
3559 struct mac_address *srf_macs;
3561 struct cfg80211_nan_func_filter *rx_filters;
3562 struct cfg80211_nan_func_filter *tx_filters;
3570 * struct cfg80211_pmk_conf - PMK configuration
3572 * @aa: authenticator address
3573 * @pmk_len: PMK length in bytes.
3574 * @pmk: the PMK material
3575 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3576 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3579 struct cfg80211_pmk_conf {
3583 const u8 *pmk_r0_name;
3587 * struct cfg80211_external_auth_params - Trigger External authentication.
3589 * Commonly used across the external auth request and event interfaces.
3591 * @action: action type / trigger for external authentication. Only significant
3592 * for the authentication request event interface (driver to user space).
3593 * @bssid: BSSID of the peer with which the authentication has
3594 * to happen. Used by both the authentication request event and
3595 * authentication response command interface.
3596 * @ssid: SSID of the AP. Used by both the authentication request event and
3597 * authentication response command interface.
3598 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3599 * authentication request event interface.
3600 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3601 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3602 * the real status code for failures. Used only for the authentication
3603 * response command interface (user space to driver).
3604 * @pmkid: The identifier to refer a PMKSA.
3606 struct cfg80211_external_auth_params {
3607 enum nl80211_external_auth_action action;
3608 u8 bssid[ETH_ALEN] __aligned(2);
3609 struct cfg80211_ssid ssid;
3610 unsigned int key_mgmt_suite;
3616 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3618 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3619 * indicate the relevant values in this struct for them
3620 * @success_num: number of FTM sessions in which all frames were successfully
3622 * @partial_num: number of FTM sessions in which part of frames were
3623 * successfully answered
3624 * @failed_num: number of failed FTM sessions
3625 * @asap_num: number of ASAP FTM sessions
3626 * @non_asap_num: number of non-ASAP FTM sessions
3627 * @total_duration_ms: total sessions durations - gives an indication
3628 * of how much time the responder was busy
3629 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3630 * initiators that didn't finish successfully the negotiation phase with
3632 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3633 * for a new scheduling although it already has scheduled FTM slot
3634 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3636 struct cfg80211_ftm_responder_stats {
3643 u64 total_duration_ms;
3644 u32 unknown_triggers_num;
3645 u32 reschedule_requests_num;
3646 u32 out_of_window_triggers_num;
3650 * struct cfg80211_pmsr_ftm_result - FTM result
3651 * @failure_reason: if this measurement failed (PMSR status is
3652 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3653 * reason than just "failure"
3654 * @burst_index: if reporting partial results, this is the index
3655 * in [0 .. num_bursts-1] of the burst that's being reported
3656 * @num_ftmr_attempts: number of FTM request frames transmitted
3657 * @num_ftmr_successes: number of FTM request frames acked
3658 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3659 * fill this to indicate in how many seconds a retry is deemed possible
3661 * @num_bursts_exp: actual number of bursts exponent negotiated
3662 * @burst_duration: actual burst duration negotiated
3663 * @ftms_per_burst: actual FTMs per burst negotiated
3664 * @lci_len: length of LCI information (if present)
3665 * @civicloc_len: length of civic location information (if present)
3666 * @lci: LCI data (may be %NULL)
3667 * @civicloc: civic location data (may be %NULL)
3668 * @rssi_avg: average RSSI over FTM action frames reported
3669 * @rssi_spread: spread of the RSSI over FTM action frames reported
3670 * @tx_rate: bitrate for transmitted FTM action frame response
3671 * @rx_rate: bitrate of received FTM action frame
3672 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3673 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3674 * the square root of the variance)
3675 * @rtt_spread: spread of the RTTs measured
3676 * @dist_avg: average of distances (mm) measured
3677 * (must have either this or @rtt_avg)
3678 * @dist_variance: variance of distances measured (see also @rtt_variance)
3679 * @dist_spread: spread of distances measured (see also @rtt_spread)
3680 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3681 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3682 * @rssi_avg_valid: @rssi_avg is valid
3683 * @rssi_spread_valid: @rssi_spread is valid
3684 * @tx_rate_valid: @tx_rate is valid
3685 * @rx_rate_valid: @rx_rate is valid
3686 * @rtt_avg_valid: @rtt_avg is valid
3687 * @rtt_variance_valid: @rtt_variance is valid
3688 * @rtt_spread_valid: @rtt_spread is valid
3689 * @dist_avg_valid: @dist_avg is valid
3690 * @dist_variance_valid: @dist_variance is valid
3691 * @dist_spread_valid: @dist_spread is valid
3693 struct cfg80211_pmsr_ftm_result {
3696 unsigned int lci_len;
3697 unsigned int civicloc_len;
3698 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3699 u32 num_ftmr_attempts, num_ftmr_successes;
3707 struct rate_info tx_rate, rx_rate;
3715 u16 num_ftmr_attempts_valid:1,
3716 num_ftmr_successes_valid:1,
3718 rssi_spread_valid:1,
3722 rtt_variance_valid:1,
3725 dist_variance_valid:1,
3726 dist_spread_valid:1;
3730 * struct cfg80211_pmsr_result - peer measurement result
3731 * @addr: address of the peer
3732 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3733 * measurement was made)
3734 * @ap_tsf: AP's TSF at measurement time
3735 * @status: status of the measurement
3736 * @final: if reporting partial results, mark this as the last one; if not
3737 * reporting partial results always set this flag
3738 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3739 * @type: type of the measurement reported, note that we only support reporting
3740 * one type at a time, but you can report multiple results separately and
3741 * they're all aggregated for userspace.
3744 struct cfg80211_pmsr_result {
3745 u64 host_time, ap_tsf;
3746 enum nl80211_peer_measurement_status status;
3753 enum nl80211_peer_measurement_type type;
3756 struct cfg80211_pmsr_ftm_result ftm;
3761 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3762 * @requested: indicates FTM is requested
3763 * @preamble: frame preamble to use
3764 * @burst_period: burst period to use
3765 * @asap: indicates to use ASAP mode
3766 * @num_bursts_exp: number of bursts exponent
3767 * @burst_duration: burst duration
3768 * @ftms_per_burst: number of FTMs per burst
3769 * @ftmr_retries: number of retries for FTM request
3770 * @request_lci: request LCI information
3771 * @request_civicloc: request civic location information
3772 * @trigger_based: use trigger based ranging for the measurement
3773 * If neither @trigger_based nor @non_trigger_based is set,
3774 * EDCA based ranging will be used.
3775 * @non_trigger_based: use non trigger based ranging for the measurement
3776 * If neither @trigger_based nor @non_trigger_based is set,
3777 * EDCA based ranging will be used.
3778 * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
3779 * @trigger_based or @non_trigger_based is set.
3780 * @bss_color: the bss color of the responder. Optional. Set to zero to
3781 * indicate the driver should set the BSS color. Only valid if
3782 * @non_trigger_based or @trigger_based is set.
3784 * See also nl80211 for the respective attribute documentation.
3786 struct cfg80211_pmsr_ftm_request_peer {
3787 enum nl80211_preamble preamble;
3794 non_trigger_based:1,
3804 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3805 * @addr: MAC address
3806 * @chandef: channel to use
3807 * @report_ap_tsf: report the associated AP's TSF
3808 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3810 struct cfg80211_pmsr_request_peer {
3812 struct cfg80211_chan_def chandef;
3814 struct cfg80211_pmsr_ftm_request_peer ftm;
3818 * struct cfg80211_pmsr_request - peer measurement request
3819 * @cookie: cookie, set by cfg80211
3820 * @nl_portid: netlink portid - used by cfg80211
3821 * @drv_data: driver data for this request, if required for aborting,
3822 * not otherwise freed or anything by cfg80211
3823 * @mac_addr: MAC address used for (randomised) request
3824 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3825 * are 0 in the mask should be randomised, bits that are 1 should
3826 * be taken from the @mac_addr
3827 * @list: used by cfg80211 to hold on to the request
3828 * @timeout: timeout (in milliseconds) for the whole operation, if
3829 * zero it means there's no timeout
3830 * @n_peers: number of peers to do measurements with
3831 * @peers: per-peer measurement request data
3833 struct cfg80211_pmsr_request {
3841 u8 mac_addr[ETH_ALEN] __aligned(2);
3842 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3844 struct list_head list;
3846 struct cfg80211_pmsr_request_peer peers[];
3850 * struct cfg80211_update_owe_info - OWE Information
3852 * This structure provides information needed for the drivers to offload OWE
3853 * (Opportunistic Wireless Encryption) processing to the user space.
3855 * Commonly used across update_owe_info request and event interfaces.
3857 * @peer: MAC address of the peer device for which the OWE processing
3859 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3860 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3861 * cannot give you the real status code for failures. Used only for
3862 * OWE update request command interface (user space to driver).
3863 * @ie: IEs obtained from the peer or constructed by the user space. These are
3864 * the IEs of the remote peer in the event from the host driver and
3865 * the constructed IEs by the user space in the request interface.
3866 * @ie_len: Length of IEs in octets.
3868 struct cfg80211_update_owe_info {
3869 u8 peer[ETH_ALEN] __aligned(2);
3876 * struct mgmt_frame_regs - management frame registrations data
3877 * @global_stypes: bitmap of management frame subtypes registered
3878 * for the entire device
3879 * @interface_stypes: bitmap of management frame subtypes registered
3880 * for the given interface
3881 * @global_mcast_stypes: mcast RX is needed globally for these subtypes
3882 * @interface_mcast_stypes: mcast RX is needed on this interface
3883 * for these subtypes
3885 struct mgmt_frame_regs {
3886 u32 global_stypes, interface_stypes;
3887 u32 global_mcast_stypes, interface_mcast_stypes;
3891 * struct cfg80211_ops - backend description for wireless configuration
3893 * This struct is registered by fullmac card drivers and/or wireless stacks
3894 * in order to handle configuration requests on their interfaces.
3896 * All callbacks except where otherwise noted should return 0
3897 * on success or a negative error code.
3899 * All operations are invoked with the wiphy mutex held. The RTNL may be
3900 * held in addition (due to wireless extensions) but this cannot be relied
3901 * upon except in cases where documented below. Note that due to ordering,
3902 * the RTNL also cannot be acquired in any handlers.
3904 * @suspend: wiphy device needs to be suspended. The variable @wow will
3905 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3906 * configured for the device.
3907 * @resume: wiphy device needs to be resumed
3908 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3909 * to call device_set_wakeup_enable() to enable/disable wakeup from
3912 * @add_virtual_intf: create a new virtual interface with the given name,
3913 * must set the struct wireless_dev's iftype. Beware: You must create
3914 * the new netdev in the wiphy's network namespace! Returns the struct
3915 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3916 * also set the address member in the wdev.
3917 * This additionally holds the RTNL to be able to do netdev changes.
3919 * @del_virtual_intf: remove the virtual interface
3920 * This additionally holds the RTNL to be able to do netdev changes.
3922 * @change_virtual_intf: change type/configuration of virtual interface,
3923 * keep the struct wireless_dev's iftype updated.
3924 * This additionally holds the RTNL to be able to do netdev changes.
3926 * @add_intf_link: Add a new MLO link to the given interface. Note that
3927 * the wdev->link[] data structure has been updated, so the new link
3928 * address is available.
3929 * @del_intf_link: Remove an MLO link from the given interface.
3931 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3932 * when adding a group key.
3934 * @get_key: get information about the key with the given parameters.
3935 * @mac_addr will be %NULL when requesting information for a group
3936 * key. All pointers given to the @callback function need not be valid
3937 * after it returns. This function should return an error if it is
3938 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3940 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3941 * and @key_index, return -ENOENT if the key doesn't exist.
3943 * @set_default_key: set the default key on an interface
3945 * @set_default_mgmt_key: set the default management frame key on an interface
3947 * @set_default_beacon_key: set the default Beacon frame key on an interface
3949 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3951 * @start_ap: Start acting in AP mode defined by the parameters.
3952 * @change_beacon: Change the beacon parameters for an access point mode
3953 * interface. This should reject the call when AP mode wasn't started.
3954 * @stop_ap: Stop being an AP, including stopping beaconing.
3956 * @add_station: Add a new station.
3957 * @del_station: Remove a station
3958 * @change_station: Modify a given station. Note that flags changes are not much
3959 * validated in cfg80211, in particular the auth/assoc/authorized flags
3960 * might come to the driver in invalid combinations -- make sure to check
3961 * them, also against the existing state! Drivers must call
3962 * cfg80211_check_station_change() to validate the information.
3963 * @get_station: get station information for the station identified by @mac
3964 * @dump_station: dump station callback -- resume dump at index @idx
3966 * @add_mpath: add a fixed mesh path
3967 * @del_mpath: delete a given mesh path
3968 * @change_mpath: change a given mesh path
3969 * @get_mpath: get a mesh path for the given parameters
3970 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3971 * @get_mpp: get a mesh proxy path for the given parameters
3972 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3973 * @join_mesh: join the mesh network with the specified parameters
3974 * (invoked with the wireless_dev mutex held)
3975 * @leave_mesh: leave the current mesh network
3976 * (invoked with the wireless_dev mutex held)
3978 * @get_mesh_config: Get the current mesh configuration
3980 * @update_mesh_config: Update mesh parameters on a running mesh.
3981 * The mask is a bitfield which tells us which parameters to
3982 * set, and which to leave alone.
3984 * @change_bss: Modify parameters for a given BSS.
3986 * @set_txq_params: Set TX queue parameters
3988 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3989 * as it doesn't implement join_mesh and needs to set the channel to
3990 * join the mesh instead.
3992 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3993 * interfaces are active this callback should reject the configuration.
3994 * If no interfaces are active or the device is down, the channel should
3995 * be stored for when a monitor interface becomes active.
3997 * @scan: Request to do a scan. If returning zero, the scan request is given
3998 * the driver, and will be valid until passed to cfg80211_scan_done().
3999 * For scan results, call cfg80211_inform_bss(); you can call this outside
4000 * the scan/scan_done bracket too.
4001 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
4002 * indicate the status of the scan through cfg80211_scan_done().
4004 * @auth: Request to authenticate with the specified peer
4005 * (invoked with the wireless_dev mutex held)
4006 * @assoc: Request to (re)associate with the specified peer
4007 * (invoked with the wireless_dev mutex held)
4008 * @deauth: Request to deauthenticate from the specified peer
4009 * (invoked with the wireless_dev mutex held)
4010 * @disassoc: Request to disassociate from the specified peer
4011 * (invoked with the wireless_dev mutex held)
4013 * @connect: Connect to the ESS with the specified parameters. When connected,
4014 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
4015 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
4016 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
4017 * from the AP or cfg80211_connect_timeout() if no frame with status code
4019 * The driver is allowed to roam to other BSSes within the ESS when the
4020 * other BSS matches the connect parameters. When such roaming is initiated
4021 * by the driver, the driver is expected to verify that the target matches
4022 * the configured security parameters and to use Reassociation Request
4023 * frame instead of Association Request frame.
4024 * The connect function can also be used to request the driver to perform a
4025 * specific roam when connected to an ESS. In that case, the prev_bssid
4026 * parameter is set to the BSSID of the currently associated BSS as an
4027 * indication of requesting reassociation.
4028 * In both the driver-initiated and new connect() call initiated roaming
4029 * cases, the result of roaming is indicated with a call to
4030 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
4031 * @update_connect_params: Update the connect parameters while connected to a
4032 * BSS. The updated parameters can be used by driver/firmware for
4033 * subsequent BSS selection (roaming) decisions and to form the
4034 * Authentication/(Re)Association Request frames. This call does not
4035 * request an immediate disassociation or reassociation with the current
4036 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
4037 * changed are defined in &enum cfg80211_connect_params_changed.
4038 * (invoked with the wireless_dev mutex held)
4039 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
4040 * connection is in progress. Once done, call cfg80211_disconnected() in
4041 * case connection was already established (invoked with the
4042 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
4044 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
4045 * cfg80211_ibss_joined(), also call that function when changing BSSID due
4047 * (invoked with the wireless_dev mutex held)
4048 * @leave_ibss: Leave the IBSS.
4049 * (invoked with the wireless_dev mutex held)
4051 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
4054 * @set_wiphy_params: Notify that wiphy parameters have changed;
4055 * @changed bitfield (see &enum wiphy_params_flags) describes which values
4056 * have changed. The actual parameter values are available in
4057 * struct wiphy. If returning an error, no value should be changed.
4059 * @set_tx_power: set the transmit power according to the parameters,
4060 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
4061 * wdev may be %NULL if power was set for the wiphy, and will
4062 * always be %NULL unless the driver supports per-vif TX power
4063 * (as advertised by the nl80211 feature flag.)
4064 * @get_tx_power: store the current TX power into the dbm variable;
4065 * return 0 if successful
4067 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
4068 * functions to adjust rfkill hw state
4070 * @dump_survey: get site survey information.
4072 * @remain_on_channel: Request the driver to remain awake on the specified
4073 * channel for the specified duration to complete an off-channel
4074 * operation (e.g., public action frame exchange). When the driver is
4075 * ready on the requested channel, it must indicate this with an event
4076 * notification by calling cfg80211_ready_on_channel().
4077 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
4078 * This allows the operation to be terminated prior to timeout based on
4079 * the duration value.
4080 * @mgmt_tx: Transmit a management frame.
4081 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
4082 * frame on another channel
4084 * @testmode_cmd: run a test mode command; @wdev may be %NULL
4085 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
4086 * used by the function, but 0 and 1 must not be touched. Additionally,
4087 * return error codes other than -ENOBUFS and -ENOENT will terminate the
4088 * dump and return to userspace with an error, so be careful. If any data
4089 * was passed in from userspace then the data/len arguments will be present
4090 * and point to the data contained in %NL80211_ATTR_TESTDATA.
4092 * @set_bitrate_mask: set the bitrate mask configuration
4094 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
4095 * devices running firmwares capable of generating the (re) association
4096 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
4097 * @del_pmksa: Delete a cached PMKID.
4098 * @flush_pmksa: Flush all cached PMKIDs.
4099 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
4100 * allows the driver to adjust the dynamic ps timeout value.
4101 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
4102 * After configuration, the driver should (soon) send an event indicating
4103 * the current level is above/below the configured threshold; this may
4104 * need some care when the configuration is changed (without first being
4106 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
4107 * connection quality monitor. An event is to be sent only when the
4108 * signal level is found to be outside the two values. The driver should
4109 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
4110 * If it is provided then there's no point providing @set_cqm_rssi_config.
4111 * @set_cqm_txe_config: Configure connection quality monitor TX error
4113 * @sched_scan_start: Tell the driver to start a scheduled scan.
4114 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
4115 * given request id. This call must stop the scheduled scan and be ready
4116 * for starting a new one before it returns, i.e. @sched_scan_start may be
4117 * called immediately after that again and should not fail in that case.
4118 * The driver should not call cfg80211_sched_scan_stopped() for a requested
4119 * stop (when this method returns 0).
4121 * @update_mgmt_frame_registrations: Notify the driver that management frame
4122 * registrations were updated. The callback is allowed to sleep.
4124 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
4125 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
4126 * reject TX/RX mask combinations they cannot support by returning -EINVAL
4127 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
4129 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4131 * @tdls_mgmt: Transmit a TDLS management frame.
4132 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
4134 * @probe_client: probe an associated client, must return a cookie that it
4135 * later passes to cfg80211_probe_status().
4137 * @set_noack_map: Set the NoAck Map for the TIDs.
4139 * @get_channel: Get the current operating channel for the virtual interface.
4140 * For monitor interfaces, it should return %NULL unless there's a single
4141 * current monitoring channel.
4143 * @start_p2p_device: Start the given P2P device.
4144 * @stop_p2p_device: Stop the given P2P device.
4146 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
4147 * Parameters include ACL policy, an array of MAC address of stations
4148 * and the number of MAC addresses. If there is already a list in driver
4149 * this new list replaces the existing one. Driver has to clear its ACL
4150 * when number of MAC addresses entries is passed as 0. Drivers which
4151 * advertise the support for MAC based ACL have to implement this callback.
4153 * @start_radar_detection: Start radar detection in the driver.
4155 * @end_cac: End running CAC, probably because a related CAC
4156 * was finished on another phy.
4158 * @update_ft_ies: Provide updated Fast BSS Transition information to the
4159 * driver. If the SME is in the driver/firmware, this information can be
4160 * used in building Authentication and Reassociation Request frames.
4162 * @crit_proto_start: Indicates a critical protocol needs more link reliability
4163 * for a given duration (milliseconds). The protocol is provided so the
4164 * driver can take the most appropriate actions.
4165 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
4166 * reliability. This operation can not fail.
4167 * @set_coalesce: Set coalesce parameters.
4169 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
4170 * responsible for veryfing if the switch is possible. Since this is
4171 * inherently tricky driver may decide to disconnect an interface later
4172 * with cfg80211_stop_iface(). This doesn't mean driver can accept
4173 * everything. It should do it's best to verify requests and reject them
4174 * as soon as possible.
4176 * @set_qos_map: Set QoS mapping information to the driver
4178 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
4179 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
4180 * changes during the lifetime of the BSS.
4182 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
4183 * with the given parameters; action frame exchange has been handled by
4184 * userspace so this just has to modify the TX path to take the TS into
4186 * If the admitted time is 0 just validate the parameters to make sure
4187 * the session can be created at all; it is valid to just always return
4188 * success for that but that may result in inefficient behaviour (handshake
4189 * with the peer followed by immediate teardown when the addition is later
4191 * @del_tx_ts: remove an existing TX TS
4193 * @join_ocb: join the OCB network with the specified parameters
4194 * (invoked with the wireless_dev mutex held)
4195 * @leave_ocb: leave the current OCB network
4196 * (invoked with the wireless_dev mutex held)
4198 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4199 * is responsible for continually initiating channel-switching operations
4200 * and returning to the base channel for communication with the AP.
4201 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4202 * peers must be on the base channel when the call completes.
4203 * @start_nan: Start the NAN interface.
4204 * @stop_nan: Stop the NAN interface.
4205 * @add_nan_func: Add a NAN function. Returns negative value on failure.
4206 * On success @nan_func ownership is transferred to the driver and
4207 * it may access it outside of the scope of this function. The driver
4208 * should free the @nan_func when no longer needed by calling
4209 * cfg80211_free_nan_func().
4210 * On success the driver should assign an instance_id in the
4211 * provided @nan_func.
4212 * @del_nan_func: Delete a NAN function.
4213 * @nan_change_conf: changes NAN configuration. The changed parameters must
4214 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
4215 * All other parameters must be ignored.
4217 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
4219 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
4220 * function should return phy stats, and interface stats otherwise.
4222 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
4223 * If not deleted through @del_pmk the PMK remains valid until disconnect
4224 * upon which the driver should clear it.
4225 * (invoked with the wireless_dev mutex held)
4226 * @del_pmk: delete the previously configured PMK for the given authenticator.
4227 * (invoked with the wireless_dev mutex held)
4229 * @external_auth: indicates result of offloaded authentication processing from
4232 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
4233 * tells the driver that the frame should not be encrypted.
4235 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4236 * Statistics should be cumulative, currently no way to reset is provided.
4237 * @start_pmsr: start peer measurement (e.g. FTM)
4238 * @abort_pmsr: abort peer measurement
4240 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
4241 * but offloading OWE processing to the user space will get the updated
4242 * DH IE through this interface.
4244 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
4245 * and overrule HWMP path selection algorithm.
4246 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
4247 * This callback may sleep.
4248 * @reset_tid_config: Reset TID specific configuration for the peer, for the
4249 * given TIDs. This callback may sleep.
4251 * @set_sar_specs: Update the SAR (TX power) settings.
4253 * @color_change: Initiate a color change.
4255 * @set_fils_aad: Set FILS AAD data to the AP driver so that the driver can use
4256 * those to decrypt (Re)Association Request and encrypt (Re)Association
4259 * @set_radar_background: Configure dedicated offchannel chain available for
4260 * radar/CAC detection on some hw. This chain can't be used to transmit
4261 * or receive frames and it is bounded to a running wdev.
4262 * Background radar/CAC detection allows to avoid the CAC downtime
4263 * switching to a different channel during CAC detection on the selected
4265 * The caller is expected to set chandef pointer to NULL in order to
4266 * disable background CAC/radar detection.
4267 * @add_link_station: Add a link to a station.
4268 * @mod_link_station: Modify a link of a station.
4269 * @del_link_station: Remove a link of a station.
4271 struct cfg80211_ops {
4272 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
4273 int (*resume)(struct wiphy *wiphy);
4274 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
4276 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
4278 unsigned char name_assign_type,
4279 enum nl80211_iftype type,
4280 struct vif_params *params);
4281 int (*del_virtual_intf)(struct wiphy *wiphy,
4282 struct wireless_dev *wdev);
4283 int (*change_virtual_intf)(struct wiphy *wiphy,
4284 struct net_device *dev,
4285 enum nl80211_iftype type,
4286 struct vif_params *params);
4288 int (*add_intf_link)(struct wiphy *wiphy,
4289 struct wireless_dev *wdev,
4290 unsigned int link_id);
4291 void (*del_intf_link)(struct wiphy *wiphy,
4292 struct wireless_dev *wdev,
4293 unsigned int link_id);
4295 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4296 u8 key_index, bool pairwise, const u8 *mac_addr,
4297 struct key_params *params);
4298 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4299 u8 key_index, bool pairwise, const u8 *mac_addr,
4301 void (*callback)(void *cookie, struct key_params*));
4302 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4303 u8 key_index, bool pairwise, const u8 *mac_addr);
4304 int (*set_default_key)(struct wiphy *wiphy,
4305 struct net_device *netdev,
4306 u8 key_index, bool unicast, bool multicast);
4307 int (*set_default_mgmt_key)(struct wiphy *wiphy,
4308 struct net_device *netdev,
4310 int (*set_default_beacon_key)(struct wiphy *wiphy,
4311 struct net_device *netdev,
4314 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4315 struct cfg80211_ap_settings *settings);
4316 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4317 struct cfg80211_beacon_data *info);
4318 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev,
4319 unsigned int link_id);
4322 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
4324 struct station_parameters *params);
4325 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
4326 struct station_del_parameters *params);
4327 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
4329 struct station_parameters *params);
4330 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
4331 const u8 *mac, struct station_info *sinfo);
4332 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4333 int idx, u8 *mac, struct station_info *sinfo);
4335 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4336 const u8 *dst, const u8 *next_hop);
4337 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4339 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4340 const u8 *dst, const u8 *next_hop);
4341 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4342 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4343 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4344 int idx, u8 *dst, u8 *next_hop,
4345 struct mpath_info *pinfo);
4346 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4347 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4348 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4349 int idx, u8 *dst, u8 *mpp,
4350 struct mpath_info *pinfo);
4351 int (*get_mesh_config)(struct wiphy *wiphy,
4352 struct net_device *dev,
4353 struct mesh_config *conf);
4354 int (*update_mesh_config)(struct wiphy *wiphy,
4355 struct net_device *dev, u32 mask,
4356 const struct mesh_config *nconf);
4357 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4358 const struct mesh_config *conf,
4359 const struct mesh_setup *setup);
4360 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4362 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4363 struct ocb_setup *setup);
4364 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4366 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4367 struct bss_parameters *params);
4369 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4370 struct ieee80211_txq_params *params);
4372 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4373 struct net_device *dev,
4374 struct ieee80211_channel *chan);
4376 int (*set_monitor_channel)(struct wiphy *wiphy,
4377 struct cfg80211_chan_def *chandef);
4379 int (*scan)(struct wiphy *wiphy,
4380 struct cfg80211_scan_request *request);
4381 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4383 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4384 struct cfg80211_auth_request *req);
4385 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4386 struct cfg80211_assoc_request *req);
4387 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4388 struct cfg80211_deauth_request *req);
4389 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4390 struct cfg80211_disassoc_request *req);
4392 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4393 struct cfg80211_connect_params *sme);
4394 int (*update_connect_params)(struct wiphy *wiphy,
4395 struct net_device *dev,
4396 struct cfg80211_connect_params *sme,
4398 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4401 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4402 struct cfg80211_ibss_params *params);
4403 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4405 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4406 int rate[NUM_NL80211_BANDS]);
4408 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4410 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4411 enum nl80211_tx_power_setting type, int mbm);
4412 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4415 void (*rfkill_poll)(struct wiphy *wiphy);
4417 #ifdef CONFIG_NL80211_TESTMODE
4418 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4419 void *data, int len);
4420 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4421 struct netlink_callback *cb,
4422 void *data, int len);
4425 int (*set_bitrate_mask)(struct wiphy *wiphy,
4426 struct net_device *dev,
4427 unsigned int link_id,
4429 const struct cfg80211_bitrate_mask *mask);
4431 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4432 int idx, struct survey_info *info);
4434 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4435 struct cfg80211_pmksa *pmksa);
4436 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4437 struct cfg80211_pmksa *pmksa);
4438 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4440 int (*remain_on_channel)(struct wiphy *wiphy,
4441 struct wireless_dev *wdev,
4442 struct ieee80211_channel *chan,
4443 unsigned int duration,
4445 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4446 struct wireless_dev *wdev,
4449 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4450 struct cfg80211_mgmt_tx_params *params,
4452 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4453 struct wireless_dev *wdev,
4456 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4457 bool enabled, int timeout);
4459 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4460 struct net_device *dev,
4461 s32 rssi_thold, u32 rssi_hyst);
4463 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4464 struct net_device *dev,
4465 s32 rssi_low, s32 rssi_high);
4467 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4468 struct net_device *dev,
4469 u32 rate, u32 pkts, u32 intvl);
4471 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4472 struct wireless_dev *wdev,
4473 struct mgmt_frame_regs *upd);
4475 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4476 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4478 int (*sched_scan_start)(struct wiphy *wiphy,
4479 struct net_device *dev,
4480 struct cfg80211_sched_scan_request *request);
4481 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4484 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4485 struct cfg80211_gtk_rekey_data *data);
4487 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4488 const u8 *peer, u8 action_code, u8 dialog_token,
4489 u16 status_code, u32 peer_capability,
4490 bool initiator, const u8 *buf, size_t len);
4491 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4492 const u8 *peer, enum nl80211_tdls_operation oper);
4494 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4495 const u8 *peer, u64 *cookie);
4497 int (*set_noack_map)(struct wiphy *wiphy,
4498 struct net_device *dev,
4501 int (*get_channel)(struct wiphy *wiphy,
4502 struct wireless_dev *wdev,
4503 unsigned int link_id,
4504 struct cfg80211_chan_def *chandef);
4506 int (*start_p2p_device)(struct wiphy *wiphy,
4507 struct wireless_dev *wdev);
4508 void (*stop_p2p_device)(struct wiphy *wiphy,
4509 struct wireless_dev *wdev);
4511 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4512 const struct cfg80211_acl_data *params);
4514 int (*start_radar_detection)(struct wiphy *wiphy,
4515 struct net_device *dev,
4516 struct cfg80211_chan_def *chandef,
4518 void (*end_cac)(struct wiphy *wiphy,
4519 struct net_device *dev);
4520 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4521 struct cfg80211_update_ft_ies_params *ftie);
4522 int (*crit_proto_start)(struct wiphy *wiphy,
4523 struct wireless_dev *wdev,
4524 enum nl80211_crit_proto_id protocol,
4526 void (*crit_proto_stop)(struct wiphy *wiphy,
4527 struct wireless_dev *wdev);
4528 int (*set_coalesce)(struct wiphy *wiphy,
4529 struct cfg80211_coalesce *coalesce);
4531 int (*channel_switch)(struct wiphy *wiphy,
4532 struct net_device *dev,
4533 struct cfg80211_csa_settings *params);
4535 int (*set_qos_map)(struct wiphy *wiphy,
4536 struct net_device *dev,
4537 struct cfg80211_qos_map *qos_map);
4539 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4540 unsigned int link_id,
4541 struct cfg80211_chan_def *chandef);
4543 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4544 u8 tsid, const u8 *peer, u8 user_prio,
4546 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4547 u8 tsid, const u8 *peer);
4549 int (*tdls_channel_switch)(struct wiphy *wiphy,
4550 struct net_device *dev,
4551 const u8 *addr, u8 oper_class,
4552 struct cfg80211_chan_def *chandef);
4553 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4554 struct net_device *dev,
4556 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4557 struct cfg80211_nan_conf *conf);
4558 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4559 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4560 struct cfg80211_nan_func *nan_func);
4561 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4563 int (*nan_change_conf)(struct wiphy *wiphy,
4564 struct wireless_dev *wdev,
4565 struct cfg80211_nan_conf *conf,
4568 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4569 struct net_device *dev,
4570 const bool enabled);
4572 int (*get_txq_stats)(struct wiphy *wiphy,
4573 struct wireless_dev *wdev,
4574 struct cfg80211_txq_stats *txqstats);
4576 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4577 const struct cfg80211_pmk_conf *conf);
4578 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4580 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4581 struct cfg80211_external_auth_params *params);
4583 int (*tx_control_port)(struct wiphy *wiphy,
4584 struct net_device *dev,
4585 const u8 *buf, size_t len,
4586 const u8 *dest, const __be16 proto,
4587 const bool noencrypt, int link_id,
4590 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4591 struct net_device *dev,
4592 struct cfg80211_ftm_responder_stats *ftm_stats);
4594 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4595 struct cfg80211_pmsr_request *request);
4596 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4597 struct cfg80211_pmsr_request *request);
4598 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4599 struct cfg80211_update_owe_info *owe_info);
4600 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4601 const u8 *buf, size_t len);
4602 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4603 struct cfg80211_tid_config *tid_conf);
4604 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4605 const u8 *peer, u8 tids);
4606 int (*set_sar_specs)(struct wiphy *wiphy,
4607 struct cfg80211_sar_specs *sar);
4608 int (*color_change)(struct wiphy *wiphy,
4609 struct net_device *dev,
4610 struct cfg80211_color_change_settings *params);
4611 int (*set_fils_aad)(struct wiphy *wiphy, struct net_device *dev,
4612 struct cfg80211_fils_aad *fils_aad);
4613 int (*set_radar_background)(struct wiphy *wiphy,
4614 struct cfg80211_chan_def *chandef);
4615 int (*add_link_station)(struct wiphy *wiphy, struct net_device *dev,
4616 struct link_station_parameters *params);
4617 int (*mod_link_station)(struct wiphy *wiphy, struct net_device *dev,
4618 struct link_station_parameters *params);
4619 int (*del_link_station)(struct wiphy *wiphy, struct net_device *dev,
4620 struct link_station_del_parameters *params);
4624 * wireless hardware and networking interfaces structures
4625 * and registration/helper functions
4629 * enum wiphy_flags - wiphy capability flags
4631 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4632 * into two, first for legacy bands and second for UHB.
4633 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4635 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4636 * by default -- this flag will be set depending on the kernel's default
4637 * on wiphy_new(), but can be changed by the driver if it has a good
4638 * reason to override the default
4639 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4640 * on a VLAN interface). This flag also serves an extra purpose of
4641 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4642 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4643 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4644 * control port protocol ethertype. The device also honours the
4645 * control_port_no_encrypt flag.
4646 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4647 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4648 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4649 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4651 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4652 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4653 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4654 * link setup/discovery operations internally. Setup, discovery and
4655 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4656 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4657 * used for asking the driver/firmware to perform a TDLS operation.
4658 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4659 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4660 * when there are virtual interfaces in AP mode by calling
4661 * cfg80211_report_obss_beacon().
4662 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4663 * responds to probe-requests in hardware.
4664 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4665 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4666 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4667 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4668 * beaconing mode (AP, IBSS, Mesh, ...).
4669 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4670 * before connection.
4671 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4672 * @WIPHY_FLAG_SUPPORTS_MLO: This is a temporary flag gating the MLO APIs,
4673 * in order to not have them reachable in normal drivers, until we have
4674 * complete feature/interface combinations/etc. advertisement. No driver
4675 * should set this flag for now.
4678 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4679 WIPHY_FLAG_SUPPORTS_MLO = BIT(1),
4680 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4681 WIPHY_FLAG_NETNS_OK = BIT(3),
4682 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4683 WIPHY_FLAG_4ADDR_AP = BIT(5),
4684 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4685 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4686 WIPHY_FLAG_IBSS_RSN = BIT(8),
4687 WIPHY_FLAG_MESH_AUTH = BIT(10),
4688 /* use hole at 11 */
4689 /* use hole at 12 */
4690 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4691 WIPHY_FLAG_AP_UAPSD = BIT(14),
4692 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4693 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4694 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4695 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4696 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4697 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4698 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4699 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4700 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4701 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4705 * struct ieee80211_iface_limit - limit on certain interface types
4706 * @max: maximum number of interfaces of these types
4707 * @types: interface types (bits)
4709 struct ieee80211_iface_limit {
4715 * struct ieee80211_iface_combination - possible interface combination
4717 * With this structure the driver can describe which interface
4718 * combinations it supports concurrently.
4722 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4726 * struct ieee80211_iface_limit limits1[] = {
4727 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4728 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4730 * struct ieee80211_iface_combination combination1 = {
4731 * .limits = limits1,
4732 * .n_limits = ARRAY_SIZE(limits1),
4733 * .max_interfaces = 2,
4734 * .beacon_int_infra_match = true,
4738 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4742 * struct ieee80211_iface_limit limits2[] = {
4743 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4744 * BIT(NL80211_IFTYPE_P2P_GO), },
4746 * struct ieee80211_iface_combination combination2 = {
4747 * .limits = limits2,
4748 * .n_limits = ARRAY_SIZE(limits2),
4749 * .max_interfaces = 8,
4750 * .num_different_channels = 1,
4754 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4756 * This allows for an infrastructure connection and three P2P connections.
4760 * struct ieee80211_iface_limit limits3[] = {
4761 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4762 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4763 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4765 * struct ieee80211_iface_combination combination3 = {
4766 * .limits = limits3,
4767 * .n_limits = ARRAY_SIZE(limits3),
4768 * .max_interfaces = 4,
4769 * .num_different_channels = 2,
4773 struct ieee80211_iface_combination {
4776 * limits for the given interface types
4778 const struct ieee80211_iface_limit *limits;
4781 * @num_different_channels:
4782 * can use up to this many different channels
4784 u32 num_different_channels;
4788 * maximum number of interfaces in total allowed in this group
4794 * number of limitations
4799 * @beacon_int_infra_match:
4800 * In this combination, the beacon intervals between infrastructure
4801 * and AP types must match. This is required only in special cases.
4803 bool beacon_int_infra_match;
4806 * @radar_detect_widths:
4807 * bitmap of channel widths supported for radar detection
4809 u8 radar_detect_widths;
4812 * @radar_detect_regions:
4813 * bitmap of regions supported for radar detection
4815 u8 radar_detect_regions;
4818 * @beacon_int_min_gcd:
4819 * This interface combination supports different beacon intervals.
4822 * all beacon intervals for different interface must be same.
4824 * any beacon interval for the interface part of this combination AND
4825 * GCD of all beacon intervals from beaconing interfaces of this
4826 * combination must be greater or equal to this value.
4828 u32 beacon_int_min_gcd;
4831 struct ieee80211_txrx_stypes {
4836 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4837 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4838 * trigger that keeps the device operating as-is and
4839 * wakes up the host on any activity, for example a
4840 * received packet that passed filtering; note that the
4841 * packet should be preserved in that case
4842 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4844 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4845 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4846 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4847 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4848 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4849 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4850 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4852 enum wiphy_wowlan_support_flags {
4853 WIPHY_WOWLAN_ANY = BIT(0),
4854 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4855 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4856 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4857 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4858 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4859 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4860 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4861 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4864 struct wiphy_wowlan_tcp_support {
4865 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4866 u32 data_payload_max;
4867 u32 data_interval_max;
4868 u32 wake_payload_max;
4873 * struct wiphy_wowlan_support - WoWLAN support data
4874 * @flags: see &enum wiphy_wowlan_support_flags
4875 * @n_patterns: number of supported wakeup patterns
4876 * (see nl80211.h for the pattern definition)
4877 * @pattern_max_len: maximum length of each pattern
4878 * @pattern_min_len: minimum length of each pattern
4879 * @max_pkt_offset: maximum Rx packet offset
4880 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4881 * similar, but not necessarily identical, to max_match_sets for
4883 * See &struct cfg80211_sched_scan_request.@match_sets for more
4885 * @tcp: TCP wakeup support information
4887 struct wiphy_wowlan_support {
4890 int pattern_max_len;
4891 int pattern_min_len;
4893 int max_nd_match_sets;
4894 const struct wiphy_wowlan_tcp_support *tcp;
4898 * struct wiphy_coalesce_support - coalesce support data
4899 * @n_rules: maximum number of coalesce rules
4900 * @max_delay: maximum supported coalescing delay in msecs
4901 * @n_patterns: number of supported patterns in a rule
4902 * (see nl80211.h for the pattern definition)
4903 * @pattern_max_len: maximum length of each pattern
4904 * @pattern_min_len: minimum length of each pattern
4905 * @max_pkt_offset: maximum Rx packet offset
4907 struct wiphy_coalesce_support {
4911 int pattern_max_len;
4912 int pattern_min_len;
4917 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4918 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4919 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4920 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4921 * (must be combined with %_WDEV or %_NETDEV)
4923 enum wiphy_vendor_command_flags {
4924 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4925 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4926 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4930 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4932 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4933 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4934 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4937 enum wiphy_opmode_flag {
4938 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4939 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4940 STA_OPMODE_N_SS_CHANGED = BIT(2),
4944 * struct sta_opmode_info - Station's ht/vht operation mode information
4945 * @changed: contains value from &enum wiphy_opmode_flag
4946 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4947 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4948 * @rx_nss: new rx_nss value of a station
4951 struct sta_opmode_info {
4953 enum nl80211_smps_mode smps_mode;
4954 enum nl80211_chan_width bw;
4958 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4961 * struct wiphy_vendor_command - vendor command definition
4962 * @info: vendor command identifying information, as used in nl80211
4963 * @flags: flags, see &enum wiphy_vendor_command_flags
4964 * @doit: callback for the operation, note that wdev is %NULL if the
4965 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4966 * pointer may be %NULL if userspace provided no data at all
4967 * @dumpit: dump callback, for transferring bigger/multiple items. The
4968 * @storage points to cb->args[5], ie. is preserved over the multiple
4970 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4971 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4972 * attribute is just raw data (e.g. a firmware command).
4973 * @maxattr: highest attribute number in policy
4974 * It's recommended to not have the same sub command with both @doit and
4975 * @dumpit, so that userspace can assume certain ones are get and others
4976 * are used with dump requests.
4978 struct wiphy_vendor_command {
4979 struct nl80211_vendor_cmd_info info;
4981 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4982 const void *data, int data_len);
4983 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4984 struct sk_buff *skb, const void *data, int data_len,
4985 unsigned long *storage);
4986 const struct nla_policy *policy;
4987 unsigned int maxattr;
4991 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4992 * @iftype: interface type
4993 * @extended_capabilities: extended capabilities supported by the driver,
4994 * additional capabilities might be supported by userspace; these are the
4995 * 802.11 extended capabilities ("Extended Capabilities element") and are
4996 * in the same format as in the information element. See IEEE Std
4997 * 802.11-2012 8.4.2.29 for the defined fields.
4998 * @extended_capabilities_mask: mask of the valid values
4999 * @extended_capabilities_len: length of the extended capabilities
5000 * @eml_capabilities: EML capabilities (for MLO)
5001 * @mld_capa_and_ops: MLD capabilities and operations (for MLO)
5003 struct wiphy_iftype_ext_capab {
5004 enum nl80211_iftype iftype;
5005 const u8 *extended_capabilities;
5006 const u8 *extended_capabilities_mask;
5007 u8 extended_capabilities_len;
5008 u16 eml_capabilities;
5009 u16 mld_capa_and_ops;
5013 * cfg80211_get_iftype_ext_capa - lookup interface type extended capability
5014 * @wiphy: the wiphy to look up from
5015 * @type: the interface type to look up
5017 const struct wiphy_iftype_ext_capab *
5018 cfg80211_get_iftype_ext_capa(struct wiphy *wiphy, enum nl80211_iftype type);
5021 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
5022 * @max_peers: maximum number of peers in a single measurement
5023 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
5024 * @randomize_mac_addr: can randomize MAC address for measurement
5025 * @ftm: FTM measurement data
5026 * @ftm.supported: FTM measurement is supported
5027 * @ftm.asap: ASAP-mode is supported
5028 * @ftm.non_asap: non-ASAP-mode is supported
5029 * @ftm.request_lci: can request LCI data
5030 * @ftm.request_civicloc: can request civic location data
5031 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
5032 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
5033 * @ftm.max_bursts_exponent: maximum burst exponent supported
5034 * (set to -1 if not limited; note that setting this will necessarily
5035 * forbid using the value 15 to let the responder pick)
5036 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
5038 * @ftm.trigger_based: trigger based ranging measurement is supported
5039 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
5041 struct cfg80211_pmsr_capabilities {
5042 unsigned int max_peers;
5044 randomize_mac_addr:1;
5049 s8 max_bursts_exponent;
5050 u8 max_ftms_per_burst;
5057 non_trigger_based:1;
5062 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
5063 * suites for interface types defined in @iftypes_mask. Each type in the
5064 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
5066 * @iftypes_mask: bitmask of interfaces types
5067 * @akm_suites: points to an array of supported akm suites
5068 * @n_akm_suites: number of supported AKM suites
5070 struct wiphy_iftype_akm_suites {
5072 const u32 *akm_suites;
5077 * struct wiphy - wireless hardware description
5078 * @mtx: mutex for the data (structures) of this device
5079 * @reg_notifier: the driver's regulatory notification callback,
5080 * note that if your driver uses wiphy_apply_custom_regulatory()
5081 * the reg_notifier's request can be passed as NULL
5082 * @regd: the driver's regulatory domain, if one was requested via
5083 * the regulatory_hint() API. This can be used by the driver
5084 * on the reg_notifier() if it chooses to ignore future
5085 * regulatory domain changes caused by other drivers.
5086 * @signal_type: signal type reported in &struct cfg80211_bss.
5087 * @cipher_suites: supported cipher suites
5088 * @n_cipher_suites: number of supported cipher suites
5089 * @akm_suites: supported AKM suites. These are the default AKMs supported if
5090 * the supported AKMs not advertized for a specific interface type in
5091 * iftype_akm_suites.
5092 * @n_akm_suites: number of supported AKM suites
5093 * @iftype_akm_suites: array of supported akm suites info per interface type.
5094 * Note that the bits in @iftypes_mask inside this structure cannot
5095 * overlap (i.e. only one occurrence of each type is allowed across all
5096 * instances of iftype_akm_suites).
5097 * @num_iftype_akm_suites: number of interface types for which supported akm
5098 * suites are specified separately.
5099 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
5100 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
5101 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
5102 * -1 = fragmentation disabled, only odd values >= 256 used
5103 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
5104 * @_net: the network namespace this wiphy currently lives in
5105 * @perm_addr: permanent MAC address of this device
5106 * @addr_mask: If the device supports multiple MAC addresses by masking,
5107 * set this to a mask with variable bits set to 1, e.g. if the last
5108 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
5109 * variable bits shall be determined by the interfaces added, with
5110 * interfaces not matching the mask being rejected to be brought up.
5111 * @n_addresses: number of addresses in @addresses.
5112 * @addresses: If the device has more than one address, set this pointer
5113 * to a list of addresses (6 bytes each). The first one will be used
5114 * by default for perm_addr. In this case, the mask should be set to
5115 * all-zeroes. In this case it is assumed that the device can handle
5116 * the same number of arbitrary MAC addresses.
5117 * @registered: protects ->resume and ->suspend sysfs callbacks against
5118 * unregister hardware
5119 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
5120 * It will be renamed automatically on wiphy renames
5121 * @dev: (virtual) struct device for this wiphy. The item in
5122 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
5124 * @wext: wireless extension handlers
5125 * @priv: driver private data (sized according to wiphy_new() parameter)
5126 * @interface_modes: bitmask of interfaces types valid for this wiphy,
5127 * must be set by driver
5128 * @iface_combinations: Valid interface combinations array, should not
5129 * list single interface types.
5130 * @n_iface_combinations: number of entries in @iface_combinations array.
5131 * @software_iftypes: bitmask of software interface types, these are not
5132 * subject to any restrictions since they are purely managed in SW.
5133 * @flags: wiphy flags, see &enum wiphy_flags
5134 * @regulatory_flags: wiphy regulatory flags, see
5135 * &enum ieee80211_regulatory_flags
5136 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
5137 * @ext_features: extended features advertised to nl80211, see
5138 * &enum nl80211_ext_feature_index.
5139 * @bss_priv_size: each BSS struct has private data allocated with it,
5140 * this variable determines its size
5141 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
5143 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
5144 * the device can run concurrently.
5145 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
5146 * for in any given scheduled scan
5147 * @max_match_sets: maximum number of match sets the device can handle
5148 * when performing a scheduled scan, 0 if filtering is not
5150 * @max_scan_ie_len: maximum length of user-controlled IEs device can
5151 * add to probe request frames transmitted during a scan, must not
5152 * include fixed IEs like supported rates
5153 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
5155 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
5156 * of iterations) for scheduled scan supported by the device.
5157 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
5158 * single scan plan supported by the device.
5159 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
5160 * scan plan supported by the device.
5161 * @coverage_class: current coverage class
5162 * @fw_version: firmware version for ethtool reporting
5163 * @hw_version: hardware version for ethtool reporting
5164 * @max_num_pmkids: maximum number of PMKIDs supported by device
5165 * @privid: a pointer that drivers can use to identify if an arbitrary
5166 * wiphy is theirs, e.g. in global notifiers
5167 * @bands: information about bands/channels supported by this device
5169 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
5170 * transmitted through nl80211, points to an array indexed by interface
5173 * @available_antennas_tx: bitmap of antennas which are available to be
5174 * configured as TX antennas. Antenna configuration commands will be
5175 * rejected unless this or @available_antennas_rx is set.
5177 * @available_antennas_rx: bitmap of antennas which are available to be
5178 * configured as RX antennas. Antenna configuration commands will be
5179 * rejected unless this or @available_antennas_tx is set.
5181 * @probe_resp_offload:
5182 * Bitmap of supported protocols for probe response offloading.
5183 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
5184 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
5186 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
5187 * may request, if implemented.
5189 * @wowlan: WoWLAN support information
5190 * @wowlan_config: current WoWLAN configuration; this should usually not be
5191 * used since access to it is necessarily racy, use the parameter passed
5192 * to the suspend() operation instead.
5194 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
5195 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
5196 * If null, then none can be over-ridden.
5197 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
5198 * If null, then none can be over-ridden.
5200 * @wdev_list: the list of associated (virtual) interfaces; this list must
5201 * not be modified by the driver, but can be read with RTNL/RCU protection.
5203 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
5206 * @extended_capabilities: extended capabilities supported by the driver,
5207 * additional capabilities might be supported by userspace; these are
5208 * the 802.11 extended capabilities ("Extended Capabilities element")
5209 * and are in the same format as in the information element. See
5210 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
5211 * extended capabilities to be used if the capabilities are not specified
5212 * for a specific interface type in iftype_ext_capab.
5213 * @extended_capabilities_mask: mask of the valid values
5214 * @extended_capabilities_len: length of the extended capabilities
5215 * @iftype_ext_capab: array of extended capabilities per interface type
5216 * @num_iftype_ext_capab: number of interface types for which extended
5217 * capabilities are specified separately.
5218 * @coalesce: packet coalescing support information
5220 * @vendor_commands: array of vendor commands supported by the hardware
5221 * @n_vendor_commands: number of vendor commands
5222 * @vendor_events: array of vendor events supported by the hardware
5223 * @n_vendor_events: number of vendor events
5225 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
5226 * (including P2P GO) or 0 to indicate no such limit is advertised. The
5227 * driver is allowed to advertise a theoretical limit that it can reach in
5228 * some cases, but may not always reach.
5230 * @max_num_csa_counters: Number of supported csa_counters in beacons
5231 * and probe responses. This value should be set if the driver
5232 * wishes to limit the number of csa counters. Default (0) means
5234 * @bss_select_support: bitmask indicating the BSS selection criteria supported
5235 * by the driver in the .connect() callback. The bit position maps to the
5236 * attribute indices defined in &enum nl80211_bss_select_attr.
5238 * @nan_supported_bands: bands supported by the device in NAN mode, a
5239 * bitmap of &enum nl80211_band values. For instance, for
5240 * NL80211_BAND_2GHZ, bit 0 would be set
5241 * (i.e. BIT(NL80211_BAND_2GHZ)).
5243 * @txq_limit: configuration of internal TX queue frame limit
5244 * @txq_memory_limit: configuration internal TX queue memory limit
5245 * @txq_quantum: configuration of internal TX queue scheduler quantum
5247 * @tx_queue_len: allow setting transmit queue len for drivers not using
5250 * @support_mbssid: can HW support association with nontransmitted AP
5251 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
5252 * HE AP, in order to avoid compatibility issues.
5253 * @support_mbssid must be set for this to have any effect.
5255 * @pmsr_capa: peer measurement capabilities
5257 * @tid_config_support: describes the per-TID config support that the
5259 * @tid_config_support.vif: bitmap of attributes (configurations)
5260 * supported by the driver for each vif
5261 * @tid_config_support.peer: bitmap of attributes (configurations)
5262 * supported by the driver for each peer
5263 * @tid_config_support.max_retry: maximum supported retry count for
5264 * long/short retry configuration
5266 * @max_data_retry_count: maximum supported per TID retry count for
5267 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
5268 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
5269 * @sar_capa: SAR control capabilities
5270 * @rfkill: a pointer to the rfkill structure
5272 * @mbssid_max_interfaces: maximum number of interfaces supported by the driver
5273 * in a multiple BSSID set. This field must be set to a non-zero value
5274 * by the driver to advertise MBSSID support.
5275 * @ema_max_profile_periodicity: maximum profile periodicity supported by
5276 * the driver. Setting this field to a non-zero value indicates that the
5277 * driver supports enhanced multi-BSSID advertisements (EMA AP).
5278 * @max_num_akm_suites: maximum number of AKM suites allowed for
5279 * configuration through %NL80211_CMD_CONNECT, %NL80211_CMD_ASSOCIATE and
5280 * %NL80211_CMD_START_AP. Set to NL80211_MAX_NR_AKM_SUITES if not set by
5281 * driver. If set by driver minimum allowed value is
5282 * NL80211_MAX_NR_AKM_SUITES in order to avoid compatibility issues with
5283 * legacy userspace and maximum allowed value is
5284 * CFG80211_MAX_NUM_AKM_SUITES.
5289 /* assign these fields before you register the wiphy */
5291 u8 perm_addr[ETH_ALEN];
5292 u8 addr_mask[ETH_ALEN];
5294 struct mac_address *addresses;
5296 const struct ieee80211_txrx_stypes *mgmt_stypes;
5298 const struct ieee80211_iface_combination *iface_combinations;
5299 int n_iface_combinations;
5300 u16 software_iftypes;
5304 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
5305 u16 interface_modes;
5307 u16 max_acl_mac_addrs;
5309 u32 flags, regulatory_flags, features;
5310 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
5314 enum cfg80211_signal_type signal_type;
5318 u8 max_sched_scan_reqs;
5319 u8 max_sched_scan_ssids;
5321 u16 max_scan_ie_len;
5322 u16 max_sched_scan_ie_len;
5323 u32 max_sched_scan_plans;
5324 u32 max_sched_scan_plan_interval;
5325 u32 max_sched_scan_plan_iterations;
5327 int n_cipher_suites;
5328 const u32 *cipher_suites;
5331 const u32 *akm_suites;
5333 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
5334 unsigned int num_iftype_akm_suites;
5342 char fw_version[ETHTOOL_FWVERS_LEN];
5346 const struct wiphy_wowlan_support *wowlan;
5347 struct cfg80211_wowlan *wowlan_config;
5350 u16 max_remain_on_channel_duration;
5354 u32 available_antennas_tx;
5355 u32 available_antennas_rx;
5357 u32 probe_resp_offload;
5359 const u8 *extended_capabilities, *extended_capabilities_mask;
5360 u8 extended_capabilities_len;
5362 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5363 unsigned int num_iftype_ext_capab;
5367 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5369 void (*reg_notifier)(struct wiphy *wiphy,
5370 struct regulatory_request *request);
5372 /* fields below are read-only, assigned by cfg80211 */
5374 const struct ieee80211_regdomain __rcu *regd;
5380 struct dentry *debugfsdir;
5382 const struct ieee80211_ht_cap *ht_capa_mod_mask;
5383 const struct ieee80211_vht_cap *vht_capa_mod_mask;
5385 struct list_head wdev_list;
5387 possible_net_t _net;
5389 #ifdef CONFIG_CFG80211_WEXT
5390 const struct iw_handler_def *wext;
5393 const struct wiphy_coalesce_support *coalesce;
5395 const struct wiphy_vendor_command *vendor_commands;
5396 const struct nl80211_vendor_cmd_info *vendor_events;
5397 int n_vendor_commands, n_vendor_events;
5399 u16 max_ap_assoc_sta;
5401 u8 max_num_csa_counters;
5403 u32 bss_select_support;
5405 u8 nan_supported_bands;
5408 u32 txq_memory_limit;
5411 unsigned long tx_queue_len;
5413 u8 support_mbssid:1,
5414 support_only_he_mbssid:1;
5416 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5421 } tid_config_support;
5423 u8 max_data_retry_count;
5425 const struct cfg80211_sar_capa *sar_capa;
5427 struct rfkill *rfkill;
5429 u8 mbssid_max_interfaces;
5430 u8 ema_max_profile_periodicity;
5431 u16 max_num_akm_suites;
5433 char priv[] __aligned(NETDEV_ALIGN);
5436 static inline struct net *wiphy_net(struct wiphy *wiphy)
5438 return read_pnet(&wiphy->_net);
5441 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5443 write_pnet(&wiphy->_net, net);
5447 * wiphy_priv - return priv from wiphy
5449 * @wiphy: the wiphy whose priv pointer to return
5450 * Return: The priv of @wiphy.
5452 static inline void *wiphy_priv(struct wiphy *wiphy)
5455 return &wiphy->priv;
5459 * priv_to_wiphy - return the wiphy containing the priv
5461 * @priv: a pointer previously returned by wiphy_priv
5462 * Return: The wiphy of @priv.
5464 static inline struct wiphy *priv_to_wiphy(void *priv)
5467 return container_of(priv, struct wiphy, priv);
5471 * set_wiphy_dev - set device pointer for wiphy
5473 * @wiphy: The wiphy whose device to bind
5474 * @dev: The device to parent it to
5476 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5478 wiphy->dev.parent = dev;
5482 * wiphy_dev - get wiphy dev pointer
5484 * @wiphy: The wiphy whose device struct to look up
5485 * Return: The dev of @wiphy.
5487 static inline struct device *wiphy_dev(struct wiphy *wiphy)
5489 return wiphy->dev.parent;
5493 * wiphy_name - get wiphy name
5495 * @wiphy: The wiphy whose name to return
5496 * Return: The name of @wiphy.
5498 static inline const char *wiphy_name(const struct wiphy *wiphy)
5500 return dev_name(&wiphy->dev);
5504 * wiphy_new_nm - create a new wiphy for use with cfg80211
5506 * @ops: The configuration operations for this device
5507 * @sizeof_priv: The size of the private area to allocate
5508 * @requested_name: Request a particular name.
5509 * NULL is valid value, and means use the default phy%d naming.
5511 * Create a new wiphy and associate the given operations with it.
5512 * @sizeof_priv bytes are allocated for private use.
5514 * Return: A pointer to the new wiphy. This pointer must be
5515 * assigned to each netdev's ieee80211_ptr for proper operation.
5517 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5518 const char *requested_name);
5521 * wiphy_new - create a new wiphy for use with cfg80211
5523 * @ops: The configuration operations for this device
5524 * @sizeof_priv: The size of the private area to allocate
5526 * Create a new wiphy and associate the given operations with it.
5527 * @sizeof_priv bytes are allocated for private use.
5529 * Return: A pointer to the new wiphy. This pointer must be
5530 * assigned to each netdev's ieee80211_ptr for proper operation.
5532 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5535 return wiphy_new_nm(ops, sizeof_priv, NULL);
5539 * wiphy_register - register a wiphy with cfg80211
5541 * @wiphy: The wiphy to register.
5543 * Return: A non-negative wiphy index or a negative error code.
5545 int wiphy_register(struct wiphy *wiphy);
5547 /* this is a define for better error reporting (file/line) */
5548 #define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
5551 * rcu_dereference_wiphy - rcu_dereference with debug checking
5552 * @wiphy: the wiphy to check the locking on
5553 * @p: The pointer to read, prior to dereferencing
5555 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
5556 * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
5558 #define rcu_dereference_wiphy(wiphy, p) \
5559 rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
5562 * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
5563 * @wiphy: the wiphy to check the locking on
5564 * @p: The pointer to read, prior to dereferencing
5566 * Return the value of the specified RCU-protected pointer, but omit the
5567 * READ_ONCE(), because caller holds the wiphy mutex used for updates.
5569 #define wiphy_dereference(wiphy, p) \
5570 rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
5573 * get_wiphy_regdom - get custom regdomain for the given wiphy
5574 * @wiphy: the wiphy to get the regdomain from
5576 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
5579 * wiphy_unregister - deregister a wiphy from cfg80211
5581 * @wiphy: The wiphy to unregister.
5583 * After this call, no more requests can be made with this priv
5584 * pointer, but the call may sleep to wait for an outstanding
5585 * request that is being handled.
5587 void wiphy_unregister(struct wiphy *wiphy);
5590 * wiphy_free - free wiphy
5592 * @wiphy: The wiphy to free
5594 void wiphy_free(struct wiphy *wiphy);
5596 /* internal structs */
5597 struct cfg80211_conn;
5598 struct cfg80211_internal_bss;
5599 struct cfg80211_cached_keys;
5600 struct cfg80211_cqm_config;
5603 * wiphy_lock - lock the wiphy
5604 * @wiphy: the wiphy to lock
5606 * This is mostly exposed so it can be done around registering and
5607 * unregistering netdevs that aren't created through cfg80211 calls,
5608 * since that requires locking in cfg80211 when the notifiers is
5609 * called, but that cannot differentiate which way it's called.
5611 * When cfg80211 ops are called, the wiphy is already locked.
5613 static inline void wiphy_lock(struct wiphy *wiphy)
5614 __acquires(&wiphy->mtx)
5616 mutex_lock(&wiphy->mtx);
5617 __acquire(&wiphy->mtx);
5621 * wiphy_unlock - unlock the wiphy again
5622 * @wiphy: the wiphy to unlock
5624 static inline void wiphy_unlock(struct wiphy *wiphy)
5625 __releases(&wiphy->mtx)
5627 __release(&wiphy->mtx);
5628 mutex_unlock(&wiphy->mtx);
5632 * struct wireless_dev - wireless device state
5634 * For netdevs, this structure must be allocated by the driver
5635 * that uses the ieee80211_ptr field in struct net_device (this
5636 * is intentional so it can be allocated along with the netdev.)
5637 * It need not be registered then as netdev registration will
5638 * be intercepted by cfg80211 to see the new wireless device,
5639 * however, drivers must lock the wiphy before registering or
5640 * unregistering netdevs if they pre-create any netdevs (in ops
5641 * called from cfg80211, the wiphy is already locked.)
5643 * For non-netdev uses, it must also be allocated by the driver
5644 * in response to the cfg80211 callbacks that require it, as
5645 * there's no netdev registration in that case it may not be
5646 * allocated outside of callback operations that return it.
5648 * @wiphy: pointer to hardware description
5649 * @iftype: interface type
5650 * @registered: is this wdev already registered with cfg80211
5651 * @registering: indicates we're doing registration under wiphy lock
5653 * @list: (private) Used to collect the interfaces
5654 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5655 * @identifier: (private) Identifier used in nl80211 to identify this
5656 * wireless device if it has no netdev
5657 * @u: union containing data specific to @iftype
5658 * @connected: indicates if connected or not (STA mode)
5659 * @bssid: (private) Used by the internal configuration code
5660 * @wext: (private) Used by the internal wireless extensions compat code
5661 * @wext.ibss: (private) IBSS data part of wext handling
5662 * @wext.connect: (private) connection handling data
5663 * @wext.keys: (private) (WEP) key data
5664 * @wext.ie: (private) extra elements for association
5665 * @wext.ie_len: (private) length of extra elements
5666 * @wext.bssid: (private) selected network BSSID
5667 * @wext.ssid: (private) selected network SSID
5668 * @wext.default_key: (private) selected default key index
5669 * @wext.default_mgmt_key: (private) selected default management key index
5670 * @wext.prev_bssid: (private) previous BSSID for reassociation
5671 * @wext.prev_bssid_valid: (private) previous BSSID validity
5672 * @use_4addr: indicates 4addr mode is used on this interface, must be
5673 * set by driver (if supported) on add_interface BEFORE registering the
5674 * netdev and may otherwise be used by driver read-only, will be update
5675 * by cfg80211 on change_interface
5676 * @mgmt_registrations: list of registrations for management frames
5677 * @mgmt_registrations_need_update: mgmt registrations were updated,
5678 * need to propagate the update to the driver
5679 * @mtx: mutex used to lock data in this struct, may be used by drivers
5680 * and some API functions require it held
5681 * @beacon_interval: beacon interval used on this device for transmitting
5682 * beacons, 0 when not valid
5683 * @address: The address for this device, valid only if @netdev is %NULL
5684 * @is_running: true if this is a non-netdev device that has been started, e.g.
5686 * @cac_started: true if DFS channel availability check has been started
5687 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5688 * @cac_time_ms: CAC time in ms
5689 * @ps: powersave mode is enabled
5690 * @ps_timeout: dynamic powersave timeout
5691 * @ap_unexpected_nlportid: (private) netlink port ID of application
5692 * registered for unexpected class 3 frames (AP mode)
5693 * @conn: (private) cfg80211 software SME connection state machine data
5694 * @connect_keys: (private) keys to set after connection is established
5695 * @conn_bss_type: connecting/connected BSS type
5696 * @conn_owner_nlportid: (private) connection owner socket port ID
5697 * @disconnect_wk: (private) auto-disconnect work
5698 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5699 * @event_list: (private) list for internal event processing
5700 * @event_lock: (private) lock for event list
5701 * @owner_nlportid: (private) owner socket port ID
5702 * @nl_owner_dead: (private) owner socket went away
5703 * @cqm_config: (private) nl80211 RSSI monitor state
5704 * @pmsr_list: (private) peer measurement requests
5705 * @pmsr_lock: (private) peer measurements requests/results lock
5706 * @pmsr_free_wk: (private) peer measurements cleanup work
5707 * @unprot_beacon_reported: (private) timestamp of last
5708 * unprotected beacon report
5709 * @links: array of %IEEE80211_MLD_MAX_NUM_LINKS elements containing @addr
5710 * @ap and @client for each link
5711 * @valid_links: bitmap describing what elements of @links are valid
5713 struct wireless_dev {
5714 struct wiphy *wiphy;
5715 enum nl80211_iftype iftype;
5717 /* the remainder of this struct should be private to cfg80211 */
5718 struct list_head list;
5719 struct net_device *netdev;
5723 struct list_head mgmt_registrations;
5724 u8 mgmt_registrations_need_update:1;
5728 bool use_4addr, is_running, registered, registering;
5730 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5732 /* currently used for IBSS and SME - might be rearranged later */
5733 struct cfg80211_conn *conn;
5734 struct cfg80211_cached_keys *connect_keys;
5735 enum ieee80211_bss_type conn_bss_type;
5736 u32 conn_owner_nlportid;
5738 struct work_struct disconnect_wk;
5739 u8 disconnect_bssid[ETH_ALEN];
5741 struct list_head event_list;
5742 spinlock_t event_lock;
5749 u32 ap_unexpected_nlportid;
5754 /* FIXME: need to rework radar detection for MLO */
5756 unsigned long cac_start_time;
5757 unsigned int cac_time_ms;
5759 #ifdef CONFIG_CFG80211_WEXT
5762 struct cfg80211_ibss_params ibss;
5763 struct cfg80211_connect_params connect;
5764 struct cfg80211_cached_keys *keys;
5768 u8 prev_bssid[ETH_ALEN];
5769 u8 ssid[IEEE80211_MAX_SSID_LEN];
5770 s8 default_key, default_mgmt_key;
5771 bool prev_bssid_valid;
5775 struct cfg80211_cqm_config *cqm_config;
5777 struct list_head pmsr_list;
5778 spinlock_t pmsr_lock;
5779 struct work_struct pmsr_free_wk;
5781 unsigned long unprot_beacon_reported;
5785 u8 connected_addr[ETH_ALEN] __aligned(2);
5786 u8 ssid[IEEE80211_MAX_SSID_LEN];
5790 int beacon_interval;
5791 struct cfg80211_chan_def preset_chandef;
5792 struct cfg80211_chan_def chandef;
5793 u8 id[IEEE80211_MAX_SSID_LEN];
5794 u8 id_len, id_up_len;
5797 struct cfg80211_chan_def preset_chandef;
5798 u8 ssid[IEEE80211_MAX_SSID_LEN];
5802 struct cfg80211_internal_bss *current_bss;
5803 struct cfg80211_chan_def chandef;
5804 int beacon_interval;
5805 u8 ssid[IEEE80211_MAX_SSID_LEN];
5809 struct cfg80211_chan_def chandef;
5814 u8 addr[ETH_ALEN] __aligned(2);
5817 unsigned int beacon_interval;
5818 struct cfg80211_chan_def chandef;
5821 struct cfg80211_internal_bss *current_bss;
5824 } links[IEEE80211_MLD_MAX_NUM_LINKS];
5828 static inline const u8 *wdev_address(struct wireless_dev *wdev)
5831 return wdev->netdev->dev_addr;
5832 return wdev->address;
5835 static inline bool wdev_running(struct wireless_dev *wdev)
5838 return netif_running(wdev->netdev);
5839 return wdev->is_running;
5843 * wdev_priv - return wiphy priv from wireless_dev
5845 * @wdev: The wireless device whose wiphy's priv pointer to return
5846 * Return: The wiphy priv of @wdev.
5848 static inline void *wdev_priv(struct wireless_dev *wdev)
5851 return wiphy_priv(wdev->wiphy);
5855 * wdev_chandef - return chandef pointer from wireless_dev
5857 * @link_id: the link ID for MLO
5859 * Return: The chandef depending on the mode, or %NULL.
5861 struct cfg80211_chan_def *wdev_chandef(struct wireless_dev *wdev,
5862 unsigned int link_id);
5864 static inline void WARN_INVALID_LINK_ID(struct wireless_dev *wdev,
5865 unsigned int link_id)
5867 WARN_ON(link_id && !wdev->valid_links);
5868 WARN_ON(wdev->valid_links &&
5869 !(wdev->valid_links & BIT(link_id)));
5872 #define for_each_valid_link(link_info, link_id) \
5874 link_id < ((link_info)->valid_links ? \
5875 ARRAY_SIZE((link_info)->links) : 1); \
5877 if (!(link_info)->valid_links || \
5878 ((link_info)->valid_links & BIT(link_id)))
5881 * DOC: Utility functions
5883 * cfg80211 offers a number of utility functions that can be useful.
5887 * ieee80211_channel_equal - compare two struct ieee80211_channel
5889 * @a: 1st struct ieee80211_channel
5890 * @b: 2nd struct ieee80211_channel
5891 * Return: true if center frequency of @a == @b
5894 ieee80211_channel_equal(struct ieee80211_channel *a,
5895 struct ieee80211_channel *b)
5897 return (a->center_freq == b->center_freq &&
5898 a->freq_offset == b->freq_offset);
5902 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5903 * @chan: struct ieee80211_channel to convert
5904 * Return: The corresponding frequency (in KHz)
5907 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5909 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5913 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5915 * Only allowed for band NL80211_BAND_S1GHZ
5917 * Return: The allowed channel width for this center_freq
5919 enum nl80211_chan_width
5920 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5923 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5924 * @chan: channel number
5925 * @band: band, necessary due to channel number overlap
5926 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5928 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5931 * ieee80211_channel_to_frequency - convert channel number to frequency
5932 * @chan: channel number
5933 * @band: band, necessary due to channel number overlap
5934 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5937 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5939 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5943 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5944 * @freq: center frequency in KHz
5945 * Return: The corresponding channel, or 0 if the conversion failed.
5947 int ieee80211_freq_khz_to_channel(u32 freq);
5950 * ieee80211_frequency_to_channel - convert frequency to channel number
5951 * @freq: center frequency in MHz
5952 * Return: The corresponding channel, or 0 if the conversion failed.
5955 ieee80211_frequency_to_channel(int freq)
5957 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5961 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5963 * @wiphy: the struct wiphy to get the channel for
5964 * @freq: the center frequency (in KHz) of the channel
5965 * Return: The channel struct from @wiphy at @freq.
5967 struct ieee80211_channel *
5968 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5971 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5973 * @wiphy: the struct wiphy to get the channel for
5974 * @freq: the center frequency (in MHz) of the channel
5975 * Return: The channel struct from @wiphy at @freq.
5977 static inline struct ieee80211_channel *
5978 ieee80211_get_channel(struct wiphy *wiphy, int freq)
5980 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5984 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5985 * @chan: control channel to check
5987 * The Preferred Scanning Channels (PSC) are defined in
5988 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5990 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
5992 if (chan->band != NL80211_BAND_6GHZ)
5995 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
5999 * ieee80211_get_response_rate - get basic rate for a given rate
6001 * @sband: the band to look for rates in
6002 * @basic_rates: bitmap of basic rates
6003 * @bitrate: the bitrate for which to find the basic rate
6005 * Return: The basic rate corresponding to a given bitrate, that
6006 * is the next lower bitrate contained in the basic rate map,
6007 * which is, for this function, given as a bitmap of indices of
6008 * rates in the band's bitrate table.
6010 const struct ieee80211_rate *
6011 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
6012 u32 basic_rates, int bitrate);
6015 * ieee80211_mandatory_rates - get mandatory rates for a given band
6016 * @sband: the band to look for rates in
6017 * @scan_width: width of the control channel
6019 * This function returns a bitmap of the mandatory rates for the given
6020 * band, bits are set according to the rate position in the bitrates array.
6022 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
6023 enum nl80211_bss_scan_width scan_width);
6026 * Radiotap parsing functions -- for controlled injection support
6028 * Implemented in net/wireless/radiotap.c
6029 * Documentation in Documentation/networking/radiotap-headers.rst
6032 struct radiotap_align_size {
6033 uint8_t align:4, size:4;
6036 struct ieee80211_radiotap_namespace {
6037 const struct radiotap_align_size *align_size;
6043 struct ieee80211_radiotap_vendor_namespaces {
6044 const struct ieee80211_radiotap_namespace *ns;
6049 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
6050 * @this_arg_index: index of current arg, valid after each successful call
6051 * to ieee80211_radiotap_iterator_next()
6052 * @this_arg: pointer to current radiotap arg; it is valid after each
6053 * call to ieee80211_radiotap_iterator_next() but also after
6054 * ieee80211_radiotap_iterator_init() where it will point to
6055 * the beginning of the actual data portion
6056 * @this_arg_size: length of the current arg, for convenience
6057 * @current_namespace: pointer to the current namespace definition
6058 * (or internally %NULL if the current namespace is unknown)
6059 * @is_radiotap_ns: indicates whether the current namespace is the default
6060 * radiotap namespace or not
6062 * @_rtheader: pointer to the radiotap header we are walking through
6063 * @_max_length: length of radiotap header in cpu byte ordering
6064 * @_arg_index: next argument index
6065 * @_arg: next argument pointer
6066 * @_next_bitmap: internal pointer to next present u32
6067 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
6068 * @_vns: vendor namespace definitions
6069 * @_next_ns_data: beginning of the next namespace's data
6070 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
6073 * Describes the radiotap parser state. Fields prefixed with an underscore
6074 * must not be used by users of the parser, only by the parser internally.
6077 struct ieee80211_radiotap_iterator {
6078 struct ieee80211_radiotap_header *_rtheader;
6079 const struct ieee80211_radiotap_vendor_namespaces *_vns;
6080 const struct ieee80211_radiotap_namespace *current_namespace;
6082 unsigned char *_arg, *_next_ns_data;
6083 __le32 *_next_bitmap;
6085 unsigned char *this_arg;
6093 uint32_t _bitmap_shifter;
6098 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
6099 struct ieee80211_radiotap_header *radiotap_header,
6101 const struct ieee80211_radiotap_vendor_namespaces *vns);
6104 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
6107 extern const unsigned char rfc1042_header[6];
6108 extern const unsigned char bridge_tunnel_header[6];
6111 * ieee80211_get_hdrlen_from_skb - get header length from data
6115 * Given an skb with a raw 802.11 header at the data pointer this function
6116 * returns the 802.11 header length.
6118 * Return: The 802.11 header length in bytes (not including encryption
6119 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
6122 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
6125 * ieee80211_hdrlen - get header length in bytes from frame control
6126 * @fc: frame control field in little-endian format
6127 * Return: The header length in bytes.
6129 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
6132 * ieee80211_get_mesh_hdrlen - get mesh extension header length
6133 * @meshhdr: the mesh extension header, only the flags field
6134 * (first byte) will be accessed
6135 * Return: The length of the extension header, which is always at
6136 * least 6 bytes and at most 18 if address 5 and 6 are present.
6138 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
6141 * DOC: Data path helpers
6143 * In addition to generic utilities, cfg80211 also offers
6144 * functions that help implement the data path for devices
6145 * that do not do the 802.11/802.3 conversion on the device.
6149 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
6150 * @skb: the 802.11 data frame
6151 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
6152 * of it being pushed into the SKB
6153 * @addr: the device MAC address
6154 * @iftype: the virtual interface type
6155 * @data_offset: offset of payload after the 802.11 header
6156 * @is_amsdu: true if the 802.11 header is A-MSDU
6157 * Return: 0 on success. Non-zero on error.
6159 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
6160 const u8 *addr, enum nl80211_iftype iftype,
6161 u8 data_offset, bool is_amsdu);
6164 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
6165 * @skb: the 802.11 data frame
6166 * @addr: the device MAC address
6167 * @iftype: the virtual interface type
6168 * Return: 0 on success. Non-zero on error.
6170 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
6171 enum nl80211_iftype iftype)
6173 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
6177 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
6179 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
6180 * The @list will be empty if the decode fails. The @skb must be fully
6181 * header-less before being passed in here; it is freed in this function.
6183 * @skb: The input A-MSDU frame without any headers.
6184 * @list: The output list of 802.3 frames. It must be allocated and
6185 * initialized by the caller.
6186 * @addr: The device MAC address.
6187 * @iftype: The device interface type.
6188 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
6189 * @check_da: DA to check in the inner ethernet header, or NULL
6190 * @check_sa: SA to check in the inner ethernet header, or NULL
6192 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
6193 const u8 *addr, enum nl80211_iftype iftype,
6194 const unsigned int extra_headroom,
6195 const u8 *check_da, const u8 *check_sa);
6198 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
6199 * @skb: the data frame
6200 * @qos_map: Interworking QoS mapping or %NULL if not in use
6201 * Return: The 802.1p/1d tag.
6203 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
6204 struct cfg80211_qos_map *qos_map);
6207 * cfg80211_find_elem_match - match information element and byte array in data
6210 * @ies: data consisting of IEs
6211 * @len: length of data
6212 * @match: byte array to match
6213 * @match_len: number of bytes in the match array
6214 * @match_offset: offset in the IE data where the byte array should match.
6215 * Note the difference to cfg80211_find_ie_match() which considers
6216 * the offset to start from the element ID byte, but here we take
6217 * the data portion instead.
6219 * Return: %NULL if the element ID could not be found or if
6220 * the element is invalid (claims to be longer than the given
6221 * data) or if the byte array doesn't match; otherwise return the
6222 * requested element struct.
6224 * Note: There are no checks on the element length other than
6225 * having to fit into the given data and being large enough for the
6226 * byte array to match.
6228 const struct element *
6229 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
6230 const u8 *match, unsigned int match_len,
6231 unsigned int match_offset);
6234 * cfg80211_find_ie_match - match information element and byte array in data
6237 * @ies: data consisting of IEs
6238 * @len: length of data
6239 * @match: byte array to match
6240 * @match_len: number of bytes in the match array
6241 * @match_offset: offset in the IE where the byte array should match.
6242 * If match_len is zero, this must also be set to zero.
6243 * Otherwise this must be set to 2 or more, because the first
6244 * byte is the element id, which is already compared to eid, and
6245 * the second byte is the IE length.
6247 * Return: %NULL if the element ID could not be found or if
6248 * the element is invalid (claims to be longer than the given
6249 * data) or if the byte array doesn't match, or a pointer to the first
6250 * byte of the requested element, that is the byte containing the
6253 * Note: There are no checks on the element length other than
6254 * having to fit into the given data and being large enough for the
6255 * byte array to match.
6257 static inline const u8 *
6258 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
6259 const u8 *match, unsigned int match_len,
6260 unsigned int match_offset)
6262 /* match_offset can't be smaller than 2, unless match_len is
6263 * zero, in which case match_offset must be zero as well.
6265 if (WARN_ON((match_len && match_offset < 2) ||
6266 (!match_len && match_offset)))
6269 return (const void *)cfg80211_find_elem_match(eid, ies, len,
6272 match_offset - 2 : 0);
6276 * cfg80211_find_elem - find information element in data
6279 * @ies: data consisting of IEs
6280 * @len: length of data
6282 * Return: %NULL if the element ID could not be found or if
6283 * the element is invalid (claims to be longer than the given
6284 * data) or if the byte array doesn't match; otherwise return the
6285 * requested element struct.
6287 * Note: There are no checks on the element length other than
6288 * having to fit into the given data.
6290 static inline const struct element *
6291 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
6293 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
6297 * cfg80211_find_ie - find information element in data
6300 * @ies: data consisting of IEs
6301 * @len: length of data
6303 * Return: %NULL if the element ID could not be found or if
6304 * the element is invalid (claims to be longer than the given
6305 * data), or a pointer to the first byte of the requested
6306 * element, that is the byte containing the element ID.
6308 * Note: There are no checks on the element length other than
6309 * having to fit into the given data.
6311 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
6313 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
6317 * cfg80211_find_ext_elem - find information element with EID Extension in data
6319 * @ext_eid: element ID Extension
6320 * @ies: data consisting of IEs
6321 * @len: length of data
6323 * Return: %NULL if the etended element could not be found or if
6324 * the element is invalid (claims to be longer than the given
6325 * data) or if the byte array doesn't match; otherwise return the
6326 * requested element struct.
6328 * Note: There are no checks on the element length other than
6329 * having to fit into the given data.
6331 static inline const struct element *
6332 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
6334 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
6339 * cfg80211_find_ext_ie - find information element with EID Extension in data
6341 * @ext_eid: element ID Extension
6342 * @ies: data consisting of IEs
6343 * @len: length of data
6345 * Return: %NULL if the extended element ID could not be found or if
6346 * the element is invalid (claims to be longer than the given
6347 * data), or a pointer to the first byte of the requested
6348 * element, that is the byte containing the element ID.
6350 * Note: There are no checks on the element length other than
6351 * having to fit into the given data.
6353 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
6355 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
6360 * cfg80211_find_vendor_elem - find vendor specific information element in data
6363 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6364 * @ies: data consisting of IEs
6365 * @len: length of data
6367 * Return: %NULL if the vendor specific element ID could not be found or if the
6368 * element is invalid (claims to be longer than the given data); otherwise
6369 * return the element structure for the requested element.
6371 * Note: There are no checks on the element length other than having to fit into
6374 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
6379 * cfg80211_find_vendor_ie - find vendor specific information element in data
6382 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6383 * @ies: data consisting of IEs
6384 * @len: length of data
6386 * Return: %NULL if the vendor specific element ID could not be found or if the
6387 * element is invalid (claims to be longer than the given data), or a pointer to
6388 * the first byte of the requested element, that is the byte containing the
6391 * Note: There are no checks on the element length other than having to fit into
6394 static inline const u8 *
6395 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
6396 const u8 *ies, unsigned int len)
6398 return (const void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
6402 * cfg80211_send_layer2_update - send layer 2 update frame
6404 * @dev: network device
6405 * @addr: STA MAC address
6407 * Wireless drivers can use this function to update forwarding tables in bridge
6408 * devices upon STA association.
6410 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
6413 * DOC: Regulatory enforcement infrastructure
6419 * regulatory_hint - driver hint to the wireless core a regulatory domain
6420 * @wiphy: the wireless device giving the hint (used only for reporting
6422 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
6423 * should be in. If @rd is set this should be NULL. Note that if you
6424 * set this to NULL you should still set rd->alpha2 to some accepted
6427 * Wireless drivers can use this function to hint to the wireless core
6428 * what it believes should be the current regulatory domain by
6429 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
6430 * domain should be in or by providing a completely build regulatory domain.
6431 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
6432 * for a regulatory domain structure for the respective country.
6434 * The wiphy must have been registered to cfg80211 prior to this call.
6435 * For cfg80211 drivers this means you must first use wiphy_register(),
6436 * for mac80211 drivers you must first use ieee80211_register_hw().
6438 * Drivers should check the return value, its possible you can get
6441 * Return: 0 on success. -ENOMEM.
6443 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
6446 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
6447 * @wiphy: the wireless device we want to process the regulatory domain on
6448 * @rd: the regulatory domain informatoin to use for this wiphy
6450 * Set the regulatory domain information for self-managed wiphys, only they
6451 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
6454 * Return: 0 on success. -EINVAL, -EPERM
6456 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
6457 struct ieee80211_regdomain *rd);
6460 * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
6461 * @wiphy: the wireless device we want to process the regulatory domain on
6462 * @rd: the regulatory domain information to use for this wiphy
6464 * This functions requires the RTNL and the wiphy mutex to be held and
6465 * applies the new regdomain synchronously to this wiphy. For more details
6466 * see regulatory_set_wiphy_regd().
6468 * Return: 0 on success. -EINVAL, -EPERM
6470 int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
6471 struct ieee80211_regdomain *rd);
6474 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
6475 * @wiphy: the wireless device we want to process the regulatory domain on
6476 * @regd: the custom regulatory domain to use for this wiphy
6478 * Drivers can sometimes have custom regulatory domains which do not apply
6479 * to a specific country. Drivers can use this to apply such custom regulatory
6480 * domains. This routine must be called prior to wiphy registration. The
6481 * custom regulatory domain will be trusted completely and as such previous
6482 * default channel settings will be disregarded. If no rule is found for a
6483 * channel on the regulatory domain the channel will be disabled.
6484 * Drivers using this for a wiphy should also set the wiphy flag
6485 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
6486 * that called this helper.
6488 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
6489 const struct ieee80211_regdomain *regd);
6492 * freq_reg_info - get regulatory information for the given frequency
6493 * @wiphy: the wiphy for which we want to process this rule for
6494 * @center_freq: Frequency in KHz for which we want regulatory information for
6496 * Use this function to get the regulatory rule for a specific frequency on
6497 * a given wireless device. If the device has a specific regulatory domain
6498 * it wants to follow we respect that unless a country IE has been received
6499 * and processed already.
6501 * Return: A valid pointer, or, when an error occurs, for example if no rule
6502 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
6503 * check and PTR_ERR() to obtain the numeric return value. The numeric return
6504 * value will be -ERANGE if we determine the given center_freq does not even
6505 * have a regulatory rule for a frequency range in the center_freq's band.
6506 * See freq_in_rule_band() for our current definition of a band -- this is
6507 * purely subjective and right now it's 802.11 specific.
6509 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
6513 * reg_initiator_name - map regulatory request initiator enum to name
6514 * @initiator: the regulatory request initiator
6516 * You can use this to map the regulatory request initiator enum to a
6517 * proper string representation.
6519 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
6522 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
6523 * @wiphy: wiphy for which pre-CAC capability is checked.
6525 * Pre-CAC is allowed only in some regdomains (notable ETSI).
6527 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
6530 * DOC: Internal regulatory db functions
6535 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6536 * Regulatory self-managed driver can use it to proactively
6538 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6539 * @freq: the freqency(in MHz) to be queried.
6540 * @rule: pointer to store the wmm rule from the regulatory db.
6542 * Self-managed wireless drivers can use this function to query
6543 * the internal regulatory database to check whether the given
6544 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6546 * Drivers should check the return value, its possible you can get
6549 * Return: 0 on success. -ENODATA.
6551 int reg_query_regdb_wmm(char *alpha2, int freq,
6552 struct ieee80211_reg_rule *rule);
6555 * callbacks for asynchronous cfg80211 methods, notification
6556 * functions and BSS handling helpers
6560 * cfg80211_scan_done - notify that scan finished
6562 * @request: the corresponding scan request
6563 * @info: information about the completed scan
6565 void cfg80211_scan_done(struct cfg80211_scan_request *request,
6566 struct cfg80211_scan_info *info);
6569 * cfg80211_sched_scan_results - notify that new scan results are available
6571 * @wiphy: the wiphy which got scheduled scan results
6572 * @reqid: identifier for the related scheduled scan request
6574 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6577 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6579 * @wiphy: the wiphy on which the scheduled scan stopped
6580 * @reqid: identifier for the related scheduled scan request
6582 * The driver can call this function to inform cfg80211 that the
6583 * scheduled scan had to be stopped, for whatever reason. The driver
6584 * is then called back via the sched_scan_stop operation when done.
6586 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6589 * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
6591 * @wiphy: the wiphy on which the scheduled scan stopped
6592 * @reqid: identifier for the related scheduled scan request
6594 * The driver can call this function to inform cfg80211 that the
6595 * scheduled scan had to be stopped, for whatever reason. The driver
6596 * is then called back via the sched_scan_stop operation when done.
6597 * This function should be called with the wiphy mutex held.
6599 void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
6602 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6603 * @wiphy: the wiphy reporting the BSS
6604 * @data: the BSS metadata
6605 * @mgmt: the management frame (probe response or beacon)
6606 * @len: length of the management frame
6607 * @gfp: context flags
6609 * This informs cfg80211 that BSS information was found and
6610 * the BSS should be updated/added.
6612 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6613 * Or %NULL on error.
6615 struct cfg80211_bss * __must_check
6616 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
6617 struct cfg80211_inform_bss *data,
6618 struct ieee80211_mgmt *mgmt, size_t len,
6621 static inline struct cfg80211_bss * __must_check
6622 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6623 struct ieee80211_channel *rx_channel,
6624 enum nl80211_bss_scan_width scan_width,
6625 struct ieee80211_mgmt *mgmt, size_t len,
6626 s32 signal, gfp_t gfp)
6628 struct cfg80211_inform_bss data = {
6630 .scan_width = scan_width,
6634 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6637 static inline struct cfg80211_bss * __must_check
6638 cfg80211_inform_bss_frame(struct wiphy *wiphy,
6639 struct ieee80211_channel *rx_channel,
6640 struct ieee80211_mgmt *mgmt, size_t len,
6641 s32 signal, gfp_t gfp)
6643 struct cfg80211_inform_bss data = {
6645 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6649 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6653 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6654 * @bssid: transmitter BSSID
6655 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6656 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6657 * @new_bssid: calculated nontransmitted BSSID
6659 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6660 u8 mbssid_index, u8 *new_bssid)
6662 u64 bssid_u64 = ether_addr_to_u64(bssid);
6663 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6666 new_bssid_u64 = bssid_u64 & ~mask;
6668 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6670 u64_to_ether_addr(new_bssid_u64, new_bssid);
6674 * cfg80211_is_element_inherited - returns if element ID should be inherited
6675 * @element: element to check
6676 * @non_inherit_element: non inheritance element
6678 bool cfg80211_is_element_inherited(const struct element *element,
6679 const struct element *non_inherit_element);
6682 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6684 * @ielen: length of IEs
6685 * @mbssid_elem: current MBSSID element
6686 * @sub_elem: current MBSSID subelement (profile)
6687 * @merged_ie: location of the merged profile
6688 * @max_copy_len: max merged profile length
6690 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6691 const struct element *mbssid_elem,
6692 const struct element *sub_elem,
6693 u8 *merged_ie, size_t max_copy_len);
6696 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6697 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6698 * from a beacon or probe response
6699 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6700 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6702 enum cfg80211_bss_frame_type {
6703 CFG80211_BSS_FTYPE_UNKNOWN,
6704 CFG80211_BSS_FTYPE_BEACON,
6705 CFG80211_BSS_FTYPE_PRESP,
6709 * cfg80211_get_ies_channel_number - returns the channel number from ies
6711 * @ielen: length of IEs
6712 * @band: enum nl80211_band of the channel
6713 * @ftype: frame type
6715 * Returns the channel number, or -1 if none could be determined.
6717 int cfg80211_get_ies_channel_number(const u8 *ie, size_t ielen,
6718 enum nl80211_band band,
6719 enum cfg80211_bss_frame_type ftype);
6722 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6724 * @wiphy: the wiphy reporting the BSS
6725 * @data: the BSS metadata
6726 * @ftype: frame type (if known)
6727 * @bssid: the BSSID of the BSS
6728 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6729 * @capability: the capability field sent by the peer
6730 * @beacon_interval: the beacon interval announced by the peer
6731 * @ie: additional IEs sent by the peer
6732 * @ielen: length of the additional IEs
6733 * @gfp: context flags
6735 * This informs cfg80211 that BSS information was found and
6736 * the BSS should be updated/added.
6738 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6739 * Or %NULL on error.
6741 struct cfg80211_bss * __must_check
6742 cfg80211_inform_bss_data(struct wiphy *wiphy,
6743 struct cfg80211_inform_bss *data,
6744 enum cfg80211_bss_frame_type ftype,
6745 const u8 *bssid, u64 tsf, u16 capability,
6746 u16 beacon_interval, const u8 *ie, size_t ielen,
6749 static inline struct cfg80211_bss * __must_check
6750 cfg80211_inform_bss_width(struct wiphy *wiphy,
6751 struct ieee80211_channel *rx_channel,
6752 enum nl80211_bss_scan_width scan_width,
6753 enum cfg80211_bss_frame_type ftype,
6754 const u8 *bssid, u64 tsf, u16 capability,
6755 u16 beacon_interval, const u8 *ie, size_t ielen,
6756 s32 signal, gfp_t gfp)
6758 struct cfg80211_inform_bss data = {
6760 .scan_width = scan_width,
6764 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6765 capability, beacon_interval, ie, ielen,
6769 static inline struct cfg80211_bss * __must_check
6770 cfg80211_inform_bss(struct wiphy *wiphy,
6771 struct ieee80211_channel *rx_channel,
6772 enum cfg80211_bss_frame_type ftype,
6773 const u8 *bssid, u64 tsf, u16 capability,
6774 u16 beacon_interval, const u8 *ie, size_t ielen,
6775 s32 signal, gfp_t gfp)
6777 struct cfg80211_inform_bss data = {
6779 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6783 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6784 capability, beacon_interval, ie, ielen,
6789 * cfg80211_get_bss - get a BSS reference
6790 * @wiphy: the wiphy this BSS struct belongs to
6791 * @channel: the channel to search on (or %NULL)
6792 * @bssid: the desired BSSID (or %NULL)
6793 * @ssid: the desired SSID (or %NULL)
6794 * @ssid_len: length of the SSID (or 0)
6795 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6796 * @privacy: privacy filter, see &enum ieee80211_privacy
6798 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6799 struct ieee80211_channel *channel,
6801 const u8 *ssid, size_t ssid_len,
6802 enum ieee80211_bss_type bss_type,
6803 enum ieee80211_privacy privacy);
6804 static inline struct cfg80211_bss *
6805 cfg80211_get_ibss(struct wiphy *wiphy,
6806 struct ieee80211_channel *channel,
6807 const u8 *ssid, size_t ssid_len)
6809 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6810 IEEE80211_BSS_TYPE_IBSS,
6811 IEEE80211_PRIVACY_ANY);
6815 * cfg80211_ref_bss - reference BSS struct
6816 * @wiphy: the wiphy this BSS struct belongs to
6817 * @bss: the BSS struct to reference
6819 * Increments the refcount of the given BSS struct.
6821 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6824 * cfg80211_put_bss - unref BSS struct
6825 * @wiphy: the wiphy this BSS struct belongs to
6826 * @bss: the BSS struct
6828 * Decrements the refcount of the given BSS struct.
6830 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6833 * cfg80211_unlink_bss - unlink BSS from internal data structures
6835 * @bss: the bss to remove
6837 * This function removes the given BSS from the internal data structures
6838 * thereby making it no longer show up in scan results etc. Use this
6839 * function when you detect a BSS is gone. Normally BSSes will also time
6840 * out, so it is not necessary to use this function at all.
6842 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6845 * cfg80211_bss_iter - iterate all BSS entries
6847 * This function iterates over the BSS entries associated with the given wiphy
6848 * and calls the callback for the iterated BSS. The iterator function is not
6849 * allowed to call functions that might modify the internal state of the BSS DB.
6852 * @chandef: if given, the iterator function will be called only if the channel
6853 * of the currently iterated BSS is a subset of the given channel.
6854 * @iter: the iterator function to call
6855 * @iter_data: an argument to the iterator function
6857 void cfg80211_bss_iter(struct wiphy *wiphy,
6858 struct cfg80211_chan_def *chandef,
6859 void (*iter)(struct wiphy *wiphy,
6860 struct cfg80211_bss *bss,
6864 static inline enum nl80211_bss_scan_width
6865 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6867 switch (chandef->width) {
6868 case NL80211_CHAN_WIDTH_5:
6869 return NL80211_BSS_CHAN_WIDTH_5;
6870 case NL80211_CHAN_WIDTH_10:
6871 return NL80211_BSS_CHAN_WIDTH_10;
6873 return NL80211_BSS_CHAN_WIDTH_20;
6878 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6879 * @dev: network device
6880 * @buf: authentication frame (header + body)
6881 * @len: length of the frame data
6883 * This function is called whenever an authentication, disassociation or
6884 * deauthentication frame has been received and processed in station mode.
6885 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6886 * call either this function or cfg80211_auth_timeout().
6887 * After being asked to associate via cfg80211_ops::assoc() the driver must
6888 * call either this function or cfg80211_auth_timeout().
6889 * While connected, the driver must calls this for received and processed
6890 * disassociation and deauthentication frames. If the frame couldn't be used
6891 * because it was unprotected, the driver must call the function
6892 * cfg80211_rx_unprot_mlme_mgmt() instead.
6894 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6896 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6899 * cfg80211_auth_timeout - notification of timed out authentication
6900 * @dev: network device
6901 * @addr: The MAC address of the device with which the authentication timed out
6903 * This function may sleep. The caller must hold the corresponding wdev's
6906 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6909 * struct cfg80211_rx_assoc_resp - association response data
6910 * @bss: the BSS that association was requested with, ownership of the pointer
6911 * moves to cfg80211 in the call to cfg80211_rx_assoc_resp()
6912 * @buf: (Re)Association Response frame (header + body)
6913 * @len: length of the frame data
6914 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6915 * as the AC bitmap in the QoS info field
6916 * @req_ies: information elements from the (Re)Association Request frame
6917 * @req_ies_len: length of req_ies data
6918 * @ap_mld_addr: AP MLD address (in case of MLO)
6919 * @links: per-link information indexed by link ID, use links[0] for
6920 * non-MLO connections
6922 struct cfg80211_rx_assoc_resp {
6928 const u8 *ap_mld_addr;
6931 struct cfg80211_bss *bss;
6932 } links[IEEE80211_MLD_MAX_NUM_LINKS];
6936 * cfg80211_rx_assoc_resp - notification of processed association response
6937 * @dev: network device
6938 * @data: association response data, &struct cfg80211_rx_assoc_resp
6940 * After being asked to associate via cfg80211_ops::assoc() the driver must
6941 * call either this function or cfg80211_auth_timeout().
6943 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6945 void cfg80211_rx_assoc_resp(struct net_device *dev,
6946 struct cfg80211_rx_assoc_resp *data);
6949 * struct cfg80211_assoc_failure - association failure data
6950 * @ap_mld_addr: AP MLD address, or %NULL
6951 * @bss: list of BSSes, must use entry 0 for non-MLO connections
6952 * (@ap_mld_addr is %NULL)
6953 * @timeout: indicates the association failed due to timeout, otherwise
6954 * the association was abandoned for a reason reported through some
6955 * other API (e.g. deauth RX)
6957 struct cfg80211_assoc_failure {
6958 const u8 *ap_mld_addr;
6959 struct cfg80211_bss *bss[IEEE80211_MLD_MAX_NUM_LINKS];
6964 * cfg80211_assoc_failure - notification of association failure
6965 * @dev: network device
6966 * @data: data describing the association failure
6968 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6970 void cfg80211_assoc_failure(struct net_device *dev,
6971 struct cfg80211_assoc_failure *data);
6974 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6975 * @dev: network device
6976 * @buf: 802.11 frame (header + body)
6977 * @len: length of the frame data
6978 * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
6980 * This function is called whenever deauthentication has been processed in
6981 * station mode. This includes both received deauthentication frames and
6982 * locally generated ones. This function may sleep. The caller must hold the
6983 * corresponding wdev's mutex.
6985 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
6989 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6990 * @dev: network device
6991 * @buf: received management frame (header + body)
6992 * @len: length of the frame data
6994 * This function is called whenever a received deauthentication or dissassoc
6995 * frame has been dropped in station mode because of MFP being used but the
6996 * frame was not protected. This is also used to notify reception of a Beacon
6997 * frame that was dropped because it did not include a valid MME MIC while
6998 * beacon protection was enabled (BIGTK configured in station mode).
7000 * This function may sleep.
7002 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
7003 const u8 *buf, size_t len);
7006 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
7007 * @dev: network device
7008 * @addr: The source MAC address of the frame
7009 * @key_type: The key type that the received frame used
7010 * @key_id: Key identifier (0..3). Can be -1 if missing.
7011 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
7012 * @gfp: allocation flags
7014 * This function is called whenever the local MAC detects a MIC failure in a
7015 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
7018 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
7019 enum nl80211_key_type key_type, int key_id,
7020 const u8 *tsc, gfp_t gfp);
7023 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
7025 * @dev: network device
7026 * @bssid: the BSSID of the IBSS joined
7027 * @channel: the channel of the IBSS joined
7028 * @gfp: allocation flags
7030 * This function notifies cfg80211 that the device joined an IBSS or
7031 * switched to a different BSSID. Before this function can be called,
7032 * either a beacon has to have been received from the IBSS, or one of
7033 * the cfg80211_inform_bss{,_frame} functions must have been called
7034 * with the locally generated beacon -- this guarantees that there is
7035 * always a scan result for this IBSS. cfg80211 will handle the rest.
7037 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
7038 struct ieee80211_channel *channel, gfp_t gfp);
7041 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
7044 * @dev: network device
7045 * @macaddr: the MAC address of the new candidate
7046 * @ie: information elements advertised by the peer candidate
7047 * @ie_len: length of the information elements buffer
7048 * @sig_dbm: signal level in dBm
7049 * @gfp: allocation flags
7051 * This function notifies cfg80211 that the mesh peer candidate has been
7052 * detected, most likely via a beacon or, less likely, via a probe response.
7053 * cfg80211 then sends a notification to userspace.
7055 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
7056 const u8 *macaddr, const u8 *ie, u8 ie_len,
7057 int sig_dbm, gfp_t gfp);
7060 * DOC: RFkill integration
7062 * RFkill integration in cfg80211 is almost invisible to drivers,
7063 * as cfg80211 automatically registers an rfkill instance for each
7064 * wireless device it knows about. Soft kill is also translated
7065 * into disconnecting and turning all interfaces off, drivers are
7066 * expected to turn off the device when all interfaces are down.
7068 * However, devices may have a hard RFkill line, in which case they
7069 * also need to interact with the rfkill subsystem, via cfg80211.
7070 * They can do this with a few helper functions documented here.
7074 * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
7076 * @blocked: block status
7077 * @reason: one of reasons in &enum rfkill_hard_block_reasons
7079 void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
7080 enum rfkill_hard_block_reasons reason);
7082 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
7084 wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
7085 RFKILL_HARD_BLOCK_SIGNAL);
7089 * wiphy_rfkill_start_polling - start polling rfkill
7092 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
7095 * wiphy_rfkill_stop_polling - stop polling rfkill
7098 static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy)
7100 rfkill_pause_polling(wiphy->rfkill);
7104 * DOC: Vendor commands
7106 * Occasionally, there are special protocol or firmware features that
7107 * can't be implemented very openly. For this and similar cases, the
7108 * vendor command functionality allows implementing the features with
7109 * (typically closed-source) userspace and firmware, using nl80211 as
7110 * the configuration mechanism.
7112 * A driver supporting vendor commands must register them as an array
7113 * in struct wiphy, with handlers for each one, each command has an
7114 * OUI and sub command ID to identify it.
7116 * Note that this feature should not be (ab)used to implement protocol
7117 * features that could openly be shared across drivers. In particular,
7118 * it must never be required to use vendor commands to implement any
7119 * "normal" functionality that higher-level userspace like connection
7120 * managers etc. need.
7123 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
7124 enum nl80211_commands cmd,
7125 enum nl80211_attrs attr,
7128 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
7129 struct wireless_dev *wdev,
7130 enum nl80211_commands cmd,
7131 enum nl80211_attrs attr,
7132 unsigned int portid,
7133 int vendor_event_idx,
7134 int approxlen, gfp_t gfp);
7136 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
7139 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
7141 * @approxlen: an upper bound of the length of the data that will
7142 * be put into the skb
7144 * This function allocates and pre-fills an skb for a reply to
7145 * a vendor command. Since it is intended for a reply, calling
7146 * it outside of a vendor command's doit() operation is invalid.
7148 * The returned skb is pre-filled with some identifying data in
7149 * a way that any data that is put into the skb (with skb_put(),
7150 * nla_put() or similar) will end up being within the
7151 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
7152 * with the skb is adding data for the corresponding userspace tool
7153 * which can then read that data out of the vendor data attribute.
7154 * You must not modify the skb in any other way.
7156 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
7157 * its error code as the result of the doit() operation.
7159 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7161 static inline struct sk_buff *
7162 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
7164 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
7165 NL80211_ATTR_VENDOR_DATA, approxlen);
7169 * cfg80211_vendor_cmd_reply - send the reply skb
7170 * @skb: The skb, must have been allocated with
7171 * cfg80211_vendor_cmd_alloc_reply_skb()
7173 * Since calling this function will usually be the last thing
7174 * before returning from the vendor command doit() you should
7175 * return the error code. Note that this function consumes the
7176 * skb regardless of the return value.
7178 * Return: An error code or 0 on success.
7180 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
7183 * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
7186 * Return the current netlink port ID in a vendor command handler.
7187 * Valid to call only there.
7189 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
7192 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
7194 * @wdev: the wireless device
7195 * @event_idx: index of the vendor event in the wiphy's vendor_events
7196 * @approxlen: an upper bound of the length of the data that will
7197 * be put into the skb
7198 * @gfp: allocation flags
7200 * This function allocates and pre-fills an skb for an event on the
7201 * vendor-specific multicast group.
7203 * If wdev != NULL, both the ifindex and identifier of the specified
7204 * wireless device are added to the event message before the vendor data
7207 * When done filling the skb, call cfg80211_vendor_event() with the
7208 * skb to send the event.
7210 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7212 static inline struct sk_buff *
7213 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
7214 int approxlen, int event_idx, gfp_t gfp)
7216 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
7217 NL80211_ATTR_VENDOR_DATA,
7218 0, event_idx, approxlen, gfp);
7222 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
7224 * @wdev: the wireless device
7225 * @event_idx: index of the vendor event in the wiphy's vendor_events
7226 * @portid: port ID of the receiver
7227 * @approxlen: an upper bound of the length of the data that will
7228 * be put into the skb
7229 * @gfp: allocation flags
7231 * This function allocates and pre-fills an skb for an event to send to
7232 * a specific (userland) socket. This socket would previously have been
7233 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
7234 * care to register a netlink notifier to see when the socket closes.
7236 * If wdev != NULL, both the ifindex and identifier of the specified
7237 * wireless device are added to the event message before the vendor data
7240 * When done filling the skb, call cfg80211_vendor_event() with the
7241 * skb to send the event.
7243 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7245 static inline struct sk_buff *
7246 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
7247 struct wireless_dev *wdev,
7248 unsigned int portid, int approxlen,
7249 int event_idx, gfp_t gfp)
7251 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
7252 NL80211_ATTR_VENDOR_DATA,
7253 portid, event_idx, approxlen, gfp);
7257 * cfg80211_vendor_event - send the event
7258 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
7259 * @gfp: allocation flags
7261 * This function sends the given @skb, which must have been allocated
7262 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
7264 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
7266 __cfg80211_send_event_skb(skb, gfp);
7269 #ifdef CONFIG_NL80211_TESTMODE
7273 * Test mode is a set of utility functions to allow drivers to
7274 * interact with driver-specific tools to aid, for instance,
7275 * factory programming.
7277 * This chapter describes how drivers interact with it, for more
7278 * information see the nl80211 book's chapter on it.
7282 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
7284 * @approxlen: an upper bound of the length of the data that will
7285 * be put into the skb
7287 * This function allocates and pre-fills an skb for a reply to
7288 * the testmode command. Since it is intended for a reply, calling
7289 * it outside of the @testmode_cmd operation is invalid.
7291 * The returned skb is pre-filled with the wiphy index and set up in
7292 * a way that any data that is put into the skb (with skb_put(),
7293 * nla_put() or similar) will end up being within the
7294 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
7295 * with the skb is adding data for the corresponding userspace tool
7296 * which can then read that data out of the testdata attribute. You
7297 * must not modify the skb in any other way.
7299 * When done, call cfg80211_testmode_reply() with the skb and return
7300 * its error code as the result of the @testmode_cmd operation.
7302 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7304 static inline struct sk_buff *
7305 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
7307 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
7308 NL80211_ATTR_TESTDATA, approxlen);
7312 * cfg80211_testmode_reply - send the reply skb
7313 * @skb: The skb, must have been allocated with
7314 * cfg80211_testmode_alloc_reply_skb()
7316 * Since calling this function will usually be the last thing
7317 * before returning from the @testmode_cmd you should return
7318 * the error code. Note that this function consumes the skb
7319 * regardless of the return value.
7321 * Return: An error code or 0 on success.
7323 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
7325 return cfg80211_vendor_cmd_reply(skb);
7329 * cfg80211_testmode_alloc_event_skb - allocate testmode event
7331 * @approxlen: an upper bound of the length of the data that will
7332 * be put into the skb
7333 * @gfp: allocation flags
7335 * This function allocates and pre-fills an skb for an event on the
7336 * testmode multicast group.
7338 * The returned skb is set up in the same way as with
7339 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
7340 * there, you should simply add data to it that will then end up in the
7341 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
7344 * When done filling the skb, call cfg80211_testmode_event() with the
7345 * skb to send the event.
7347 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7349 static inline struct sk_buff *
7350 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
7352 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
7353 NL80211_ATTR_TESTDATA, 0, -1,
7358 * cfg80211_testmode_event - send the event
7359 * @skb: The skb, must have been allocated with
7360 * cfg80211_testmode_alloc_event_skb()
7361 * @gfp: allocation flags
7363 * This function sends the given @skb, which must have been allocated
7364 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
7367 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
7369 __cfg80211_send_event_skb(skb, gfp);
7372 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
7373 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
7375 #define CFG80211_TESTMODE_CMD(cmd)
7376 #define CFG80211_TESTMODE_DUMP(cmd)
7380 * struct cfg80211_fils_resp_params - FILS connection response params
7381 * @kek: KEK derived from a successful FILS connection (may be %NULL)
7382 * @kek_len: Length of @fils_kek in octets
7383 * @update_erp_next_seq_num: Boolean value to specify whether the value in
7384 * @erp_next_seq_num is valid.
7385 * @erp_next_seq_num: The next sequence number to use in ERP message in
7386 * FILS Authentication. This value should be specified irrespective of the
7387 * status for a FILS connection.
7388 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
7389 * @pmk_len: Length of @pmk in octets
7390 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
7391 * used for this FILS connection (may be %NULL).
7393 struct cfg80211_fils_resp_params {
7396 bool update_erp_next_seq_num;
7397 u16 erp_next_seq_num;
7404 * struct cfg80211_connect_resp_params - Connection response params
7405 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
7406 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7407 * the real status code for failures. If this call is used to report a
7408 * failure due to a timeout (e.g., not receiving an Authentication frame
7409 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7410 * indicate that this is a failure, but without a status code.
7411 * @timeout_reason is used to report the reason for the timeout in that
7413 * @req_ie: Association request IEs (may be %NULL)
7414 * @req_ie_len: Association request IEs length
7415 * @resp_ie: Association response IEs (may be %NULL)
7416 * @resp_ie_len: Association response IEs length
7417 * @fils: FILS connection response parameters.
7418 * @timeout_reason: Reason for connection timeout. This is used when the
7419 * connection fails due to a timeout instead of an explicit rejection from
7420 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7421 * not known. This value is used only if @status < 0 to indicate that the
7422 * failure is due to a timeout and not due to explicit rejection by the AP.
7423 * This value is ignored in other cases (@status >= 0).
7424 * @valid_links: For MLO connection, BIT mask of the valid link ids. Otherwise
7426 * @ap_mld_addr: For MLO connection, MLD address of the AP. Otherwise %NULL.
7427 * @links : For MLO connection, contains link info for the valid links indicated
7428 * using @valid_links. For non-MLO connection, links[0] contains the
7429 * connected AP info.
7430 * @links.addr: For MLO connection, MAC address of the STA link. Otherwise
7432 * @links.bssid: For MLO connection, MAC address of the AP link. For non-MLO
7433 * connection, links[0].bssid points to the BSSID of the AP (may be %NULL).
7434 * @links.bss: For MLO connection, entry of bss to which STA link is connected.
7435 * For non-MLO connection, links[0].bss points to entry of bss to which STA
7436 * is connected. It can be obtained through cfg80211_get_bss() (may be
7437 * %NULL). It is recommended to store the bss from the connect_request and
7438 * hold a reference to it and return through this param to avoid a warning
7439 * if the bss is expired during the connection, esp. for those drivers
7440 * implementing connect op. Only one parameter among @bssid and @bss needs
7443 struct cfg80211_connect_resp_params {
7449 struct cfg80211_fils_resp_params fils;
7450 enum nl80211_timeout_reason timeout_reason;
7452 const u8 *ap_mld_addr;
7457 struct cfg80211_bss *bss;
7458 } links[IEEE80211_MLD_MAX_NUM_LINKS];
7462 * cfg80211_connect_done - notify cfg80211 of connection result
7464 * @dev: network device
7465 * @params: connection response parameters
7466 * @gfp: allocation flags
7468 * It should be called by the underlying driver once execution of the connection
7469 * request from connect() has been completed. This is similar to
7470 * cfg80211_connect_bss(), but takes a structure pointer for connection response
7471 * parameters. Only one of the functions among cfg80211_connect_bss(),
7472 * cfg80211_connect_result(), cfg80211_connect_timeout(),
7473 * and cfg80211_connect_done() should be called.
7475 void cfg80211_connect_done(struct net_device *dev,
7476 struct cfg80211_connect_resp_params *params,
7480 * cfg80211_connect_bss - notify cfg80211 of connection result
7482 * @dev: network device
7483 * @bssid: the BSSID of the AP
7484 * @bss: Entry of bss to which STA got connected to, can be obtained through
7485 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7486 * bss from the connect_request and hold a reference to it and return
7487 * through this param to avoid a warning if the bss is expired during the
7488 * connection, esp. for those drivers implementing connect op.
7489 * Only one parameter among @bssid and @bss needs to be specified.
7490 * @req_ie: association request IEs (maybe be %NULL)
7491 * @req_ie_len: association request IEs length
7492 * @resp_ie: association response IEs (may be %NULL)
7493 * @resp_ie_len: assoc response IEs length
7494 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7495 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7496 * the real status code for failures. If this call is used to report a
7497 * failure due to a timeout (e.g., not receiving an Authentication frame
7498 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7499 * indicate that this is a failure, but without a status code.
7500 * @timeout_reason is used to report the reason for the timeout in that
7502 * @gfp: allocation flags
7503 * @timeout_reason: reason for connection timeout. This is used when the
7504 * connection fails due to a timeout instead of an explicit rejection from
7505 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7506 * not known. This value is used only if @status < 0 to indicate that the
7507 * failure is due to a timeout and not due to explicit rejection by the AP.
7508 * This value is ignored in other cases (@status >= 0).
7510 * It should be called by the underlying driver once execution of the connection
7511 * request from connect() has been completed. This is similar to
7512 * cfg80211_connect_result(), but with the option of identifying the exact bss
7513 * entry for the connection. Only one of the functions among
7514 * cfg80211_connect_bss(), cfg80211_connect_result(),
7515 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7518 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
7519 struct cfg80211_bss *bss, const u8 *req_ie,
7520 size_t req_ie_len, const u8 *resp_ie,
7521 size_t resp_ie_len, int status, gfp_t gfp,
7522 enum nl80211_timeout_reason timeout_reason)
7524 struct cfg80211_connect_resp_params params;
7526 memset(¶ms, 0, sizeof(params));
7527 params.status = status;
7528 params.links[0].bssid = bssid;
7529 params.links[0].bss = bss;
7530 params.req_ie = req_ie;
7531 params.req_ie_len = req_ie_len;
7532 params.resp_ie = resp_ie;
7533 params.resp_ie_len = resp_ie_len;
7534 params.timeout_reason = timeout_reason;
7536 cfg80211_connect_done(dev, ¶ms, gfp);
7540 * cfg80211_connect_result - notify cfg80211 of connection result
7542 * @dev: network device
7543 * @bssid: the BSSID of the AP
7544 * @req_ie: association request IEs (maybe be %NULL)
7545 * @req_ie_len: association request IEs length
7546 * @resp_ie: association response IEs (may be %NULL)
7547 * @resp_ie_len: assoc response IEs length
7548 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7549 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7550 * the real status code for failures.
7551 * @gfp: allocation flags
7553 * It should be called by the underlying driver once execution of the connection
7554 * request from connect() has been completed. This is similar to
7555 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
7556 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
7557 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7560 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
7561 const u8 *req_ie, size_t req_ie_len,
7562 const u8 *resp_ie, size_t resp_ie_len,
7563 u16 status, gfp_t gfp)
7565 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
7566 resp_ie_len, status, gfp,
7567 NL80211_TIMEOUT_UNSPECIFIED);
7571 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
7573 * @dev: network device
7574 * @bssid: the BSSID of the AP
7575 * @req_ie: association request IEs (maybe be %NULL)
7576 * @req_ie_len: association request IEs length
7577 * @gfp: allocation flags
7578 * @timeout_reason: reason for connection timeout.
7580 * It should be called by the underlying driver whenever connect() has failed
7581 * in a sequence where no explicit authentication/association rejection was
7582 * received from the AP. This could happen, e.g., due to not being able to send
7583 * out the Authentication or Association Request frame or timing out while
7584 * waiting for the response. Only one of the functions among
7585 * cfg80211_connect_bss(), cfg80211_connect_result(),
7586 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7589 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
7590 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
7591 enum nl80211_timeout_reason timeout_reason)
7593 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
7594 gfp, timeout_reason);
7598 * struct cfg80211_roam_info - driver initiated roaming information
7600 * @req_ie: association request IEs (maybe be %NULL)
7601 * @req_ie_len: association request IEs length
7602 * @resp_ie: association response IEs (may be %NULL)
7603 * @resp_ie_len: assoc response IEs length
7604 * @fils: FILS related roaming information.
7605 * @valid_links: For MLO roaming, BIT mask of the new valid links is set.
7607 * @ap_mld_addr: For MLO roaming, MLD address of the new AP. Otherwise %NULL.
7608 * @links : For MLO roaming, contains new link info for the valid links set in
7609 * @valid_links. For non-MLO roaming, links[0] contains the new AP info.
7610 * @links.addr: For MLO roaming, MAC address of the STA link. Otherwise %NULL.
7611 * @links.bssid: For MLO roaming, MAC address of the new AP link. For non-MLO
7612 * roaming, links[0].bssid points to the BSSID of the new AP. May be
7613 * %NULL if %links.bss is set.
7614 * @links.channel: the channel of the new AP.
7615 * @links.bss: For MLO roaming, entry of new bss to which STA link got
7616 * roamed. For non-MLO roaming, links[0].bss points to entry of bss to
7617 * which STA got roamed (may be %NULL if %links.bssid is set)
7619 struct cfg80211_roam_info {
7624 struct cfg80211_fils_resp_params fils;
7626 const u8 *ap_mld_addr;
7631 struct ieee80211_channel *channel;
7632 struct cfg80211_bss *bss;
7633 } links[IEEE80211_MLD_MAX_NUM_LINKS];
7637 * cfg80211_roamed - notify cfg80211 of roaming
7639 * @dev: network device
7640 * @info: information about the new BSS. struct &cfg80211_roam_info.
7641 * @gfp: allocation flags
7643 * This function may be called with the driver passing either the BSSID of the
7644 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7645 * It should be called by the underlying driver whenever it roamed from one AP
7646 * to another while connected. Drivers which have roaming implemented in
7647 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7648 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7649 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7650 * rdev->event_work. In case of any failures, the reference is released
7651 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7652 * released while disconnecting from the current bss.
7654 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7658 * cfg80211_port_authorized - notify cfg80211 of successful security association
7660 * @dev: network device
7661 * @bssid: the BSSID of the AP
7662 * @gfp: allocation flags
7664 * This function should be called by a driver that supports 4 way handshake
7665 * offload after a security association was successfully established (i.e.,
7666 * the 4 way handshake was completed successfully). The call to this function
7667 * should be preceded with a call to cfg80211_connect_result(),
7668 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7669 * indicate the 802.11 association.
7671 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7675 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7677 * @dev: network device
7678 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7679 * @ie_len: length of IEs
7680 * @reason: reason code for the disconnection, set it to 0 if unknown
7681 * @locally_generated: disconnection was requested locally
7682 * @gfp: allocation flags
7684 * After it calls this function, the driver should enter an idle state
7685 * and not try to connect to any AP any more.
7687 void cfg80211_disconnected(struct net_device *dev, u16 reason,
7688 const u8 *ie, size_t ie_len,
7689 bool locally_generated, gfp_t gfp);
7692 * cfg80211_ready_on_channel - notification of remain_on_channel start
7693 * @wdev: wireless device
7694 * @cookie: the request cookie
7695 * @chan: The current channel (from remain_on_channel request)
7696 * @duration: Duration in milliseconds that the driver intents to remain on the
7698 * @gfp: allocation flags
7700 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7701 struct ieee80211_channel *chan,
7702 unsigned int duration, gfp_t gfp);
7705 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7706 * @wdev: wireless device
7707 * @cookie: the request cookie
7708 * @chan: The current channel (from remain_on_channel request)
7709 * @gfp: allocation flags
7711 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7712 struct ieee80211_channel *chan,
7716 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7717 * @wdev: wireless device
7718 * @cookie: the requested cookie
7719 * @chan: The current channel (from tx_mgmt request)
7720 * @gfp: allocation flags
7722 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7723 struct ieee80211_channel *chan, gfp_t gfp);
7726 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7728 * @sinfo: the station information
7729 * @gfp: allocation flags
7731 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7734 * cfg80211_sinfo_release_content - release contents of station info
7735 * @sinfo: the station information
7737 * Releases any potentially allocated sub-information of the station
7738 * information, but not the struct itself (since it's typically on
7741 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7743 kfree(sinfo->pertid);
7747 * cfg80211_new_sta - notify userspace about station
7750 * @mac_addr: the station's address
7751 * @sinfo: the station information
7752 * @gfp: allocation flags
7754 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7755 struct station_info *sinfo, gfp_t gfp);
7758 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7760 * @mac_addr: the station's address
7761 * @sinfo: the station information/statistics
7762 * @gfp: allocation flags
7764 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7765 struct station_info *sinfo, gfp_t gfp);
7768 * cfg80211_del_sta - notify userspace about deletion of a station
7771 * @mac_addr: the station's address
7772 * @gfp: allocation flags
7774 static inline void cfg80211_del_sta(struct net_device *dev,
7775 const u8 *mac_addr, gfp_t gfp)
7777 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7781 * cfg80211_conn_failed - connection request failed notification
7784 * @mac_addr: the station's address
7785 * @reason: the reason for connection failure
7786 * @gfp: allocation flags
7788 * Whenever a station tries to connect to an AP and if the station
7789 * could not connect to the AP as the AP has rejected the connection
7790 * for some reasons, this function is called.
7792 * The reason for connection failure can be any of the value from
7793 * nl80211_connect_failed_reason enum
7795 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7796 enum nl80211_connect_failed_reason reason,
7800 * struct cfg80211_rx_info - received management frame info
7802 * @freq: Frequency on which the frame was received in kHz
7803 * @sig_dbm: signal strength in dBm, or 0 if unknown
7804 * @have_link_id: indicates the frame was received on a link of
7805 * an MLD, i.e. the @link_id field is valid
7806 * @link_id: the ID of the link the frame was received on
7807 * @buf: Management frame (header + body)
7808 * @len: length of the frame data
7809 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7810 * @rx_tstamp: Hardware timestamp of frame RX in nanoseconds
7811 * @ack_tstamp: Hardware timestamp of ack TX in nanoseconds
7813 struct cfg80211_rx_info {
7826 * cfg80211_rx_mgmt_ext - management frame notification with extended info
7827 * @wdev: wireless device receiving the frame
7828 * @info: RX info as defined in struct cfg80211_rx_info
7830 * This function is called whenever an Action frame is received for a station
7831 * mode interface, but is not processed in kernel.
7833 * Return: %true if a user space application has registered for this frame.
7834 * For action frames, that makes it responsible for rejecting unrecognized
7835 * action frames; %false otherwise, in which case for action frames the
7836 * driver is responsible for rejecting the frame.
7838 bool cfg80211_rx_mgmt_ext(struct wireless_dev *wdev,
7839 struct cfg80211_rx_info *info);
7842 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7843 * @wdev: wireless device receiving the frame
7844 * @freq: Frequency on which the frame was received in KHz
7845 * @sig_dbm: signal strength in dBm, or 0 if unknown
7846 * @buf: Management frame (header + body)
7847 * @len: length of the frame data
7848 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7850 * This function is called whenever an Action frame is received for a station
7851 * mode interface, but is not processed in kernel.
7853 * Return: %true if a user space application has registered for this frame.
7854 * For action frames, that makes it responsible for rejecting unrecognized
7855 * action frames; %false otherwise, in which case for action frames the
7856 * driver is responsible for rejecting the frame.
7858 static inline bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq,
7859 int sig_dbm, const u8 *buf, size_t len,
7862 struct cfg80211_rx_info info = {
7870 return cfg80211_rx_mgmt_ext(wdev, &info);
7874 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7875 * @wdev: wireless device receiving the frame
7876 * @freq: Frequency on which the frame was received in MHz
7877 * @sig_dbm: signal strength in dBm, or 0 if unknown
7878 * @buf: Management frame (header + body)
7879 * @len: length of the frame data
7880 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7882 * This function is called whenever an Action frame is received for a station
7883 * mode interface, but is not processed in kernel.
7885 * Return: %true if a user space application has registered for this frame.
7886 * For action frames, that makes it responsible for rejecting unrecognized
7887 * action frames; %false otherwise, in which case for action frames the
7888 * driver is responsible for rejecting the frame.
7890 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7891 int sig_dbm, const u8 *buf, size_t len,
7894 struct cfg80211_rx_info info = {
7895 .freq = MHZ_TO_KHZ(freq),
7902 return cfg80211_rx_mgmt_ext(wdev, &info);
7906 * struct cfg80211_tx_status - TX status for management frame information
7908 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7909 * @tx_tstamp: hardware TX timestamp in nanoseconds
7910 * @ack_tstamp: hardware ack RX timestamp in nanoseconds
7911 * @buf: Management frame (header + body)
7912 * @len: length of the frame data
7913 * @ack: Whether frame was acknowledged
7915 struct cfg80211_tx_status {
7925 * cfg80211_mgmt_tx_status_ext - TX status notification with extended info
7926 * @wdev: wireless device receiving the frame
7927 * @status: TX status data
7928 * @gfp: context flags
7930 * This function is called whenever a management frame was requested to be
7931 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7932 * transmission attempt with extended info.
7934 void cfg80211_mgmt_tx_status_ext(struct wireless_dev *wdev,
7935 struct cfg80211_tx_status *status, gfp_t gfp);
7938 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7939 * @wdev: wireless device receiving the frame
7940 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7941 * @buf: Management frame (header + body)
7942 * @len: length of the frame data
7943 * @ack: Whether frame was acknowledged
7944 * @gfp: context flags
7946 * This function is called whenever a management frame was requested to be
7947 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7948 * transmission attempt.
7950 static inline void cfg80211_mgmt_tx_status(struct wireless_dev *wdev,
7951 u64 cookie, const u8 *buf,
7952 size_t len, bool ack, gfp_t gfp)
7954 struct cfg80211_tx_status status = {
7961 cfg80211_mgmt_tx_status_ext(wdev, &status, gfp);
7965 * cfg80211_control_port_tx_status - notification of TX status for control
7967 * @wdev: wireless device receiving the frame
7968 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7969 * @buf: Data frame (header + body)
7970 * @len: length of the frame data
7971 * @ack: Whether frame was acknowledged
7972 * @gfp: context flags
7974 * This function is called whenever a control port frame was requested to be
7975 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7976 * the transmission attempt.
7978 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
7979 const u8 *buf, size_t len, bool ack,
7983 * cfg80211_rx_control_port - notification about a received control port frame
7984 * @dev: The device the frame matched to
7985 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7986 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7987 * This function does not take ownership of the skb, so the caller is
7988 * responsible for any cleanup. The caller must also ensure that
7989 * skb->protocol is set appropriately.
7990 * @unencrypted: Whether the frame was received unencrypted
7992 * This function is used to inform userspace about a received control port
7993 * frame. It should only be used if userspace indicated it wants to receive
7994 * control port frames over nl80211.
7996 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7997 * network layer headers removed (e.g. the raw EAPoL frame).
7999 * Return: %true if the frame was passed to userspace
8001 bool cfg80211_rx_control_port(struct net_device *dev,
8002 struct sk_buff *skb, bool unencrypted);
8005 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
8006 * @dev: network device
8007 * @rssi_event: the triggered RSSI event
8008 * @rssi_level: new RSSI level value or 0 if not available
8009 * @gfp: context flags
8011 * This function is called when a configured connection quality monitoring
8012 * rssi threshold reached event occurs.
8014 void cfg80211_cqm_rssi_notify(struct net_device *dev,
8015 enum nl80211_cqm_rssi_threshold_event rssi_event,
8016 s32 rssi_level, gfp_t gfp);
8019 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
8020 * @dev: network device
8021 * @peer: peer's MAC address
8022 * @num_packets: how many packets were lost -- should be a fixed threshold
8023 * but probably no less than maybe 50, or maybe a throughput dependent
8024 * threshold (to account for temporary interference)
8025 * @gfp: context flags
8027 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
8028 const u8 *peer, u32 num_packets, gfp_t gfp);
8031 * cfg80211_cqm_txe_notify - TX error rate event
8032 * @dev: network device
8033 * @peer: peer's MAC address
8034 * @num_packets: how many packets were lost
8035 * @rate: % of packets which failed transmission
8036 * @intvl: interval (in s) over which the TX failure threshold was breached.
8037 * @gfp: context flags
8039 * Notify userspace when configured % TX failures over number of packets in a
8040 * given interval is exceeded.
8042 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
8043 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
8046 * cfg80211_cqm_beacon_loss_notify - beacon loss event
8047 * @dev: network device
8048 * @gfp: context flags
8050 * Notify userspace about beacon loss from the connected AP.
8052 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
8055 * __cfg80211_radar_event - radar detection event
8057 * @chandef: chandef for the current channel
8058 * @offchan: the radar has been detected on the offchannel chain
8059 * @gfp: context flags
8061 * This function is called when a radar is detected on the current chanenl.
8063 void __cfg80211_radar_event(struct wiphy *wiphy,
8064 struct cfg80211_chan_def *chandef,
8065 bool offchan, gfp_t gfp);
8068 cfg80211_radar_event(struct wiphy *wiphy,
8069 struct cfg80211_chan_def *chandef,
8072 __cfg80211_radar_event(wiphy, chandef, false, gfp);
8076 cfg80211_background_radar_event(struct wiphy *wiphy,
8077 struct cfg80211_chan_def *chandef,
8080 __cfg80211_radar_event(wiphy, chandef, true, gfp);
8084 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
8085 * @dev: network device
8086 * @mac: MAC address of a station which opmode got modified
8087 * @sta_opmode: station's current opmode value
8088 * @gfp: context flags
8090 * Driver should call this function when station's opmode modified via action
8093 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
8094 struct sta_opmode_info *sta_opmode,
8098 * cfg80211_cac_event - Channel availability check (CAC) event
8099 * @netdev: network device
8100 * @chandef: chandef for the current channel
8101 * @event: type of event
8102 * @gfp: context flags
8104 * This function is called when a Channel availability check (CAC) is finished
8105 * or aborted. This must be called to notify the completion of a CAC process,
8106 * also by full-MAC drivers.
8108 void cfg80211_cac_event(struct net_device *netdev,
8109 const struct cfg80211_chan_def *chandef,
8110 enum nl80211_radar_event event, gfp_t gfp);
8113 * cfg80211_background_cac_abort - Channel Availability Check offchan abort event
8116 * This function is called by the driver when a Channel Availability Check
8117 * (CAC) is aborted by a offchannel dedicated chain.
8119 void cfg80211_background_cac_abort(struct wiphy *wiphy);
8122 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
8123 * @dev: network device
8124 * @bssid: BSSID of AP (to avoid races)
8125 * @replay_ctr: new replay counter
8126 * @gfp: allocation flags
8128 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
8129 const u8 *replay_ctr, gfp_t gfp);
8132 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
8133 * @dev: network device
8134 * @index: candidate index (the smaller the index, the higher the priority)
8135 * @bssid: BSSID of AP
8136 * @preauth: Whether AP advertises support for RSN pre-authentication
8137 * @gfp: allocation flags
8139 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
8140 const u8 *bssid, bool preauth, gfp_t gfp);
8143 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
8144 * @dev: The device the frame matched to
8145 * @addr: the transmitter address
8146 * @gfp: context flags
8148 * This function is used in AP mode (only!) to inform userspace that
8149 * a spurious class 3 frame was received, to be able to deauth the
8151 * Return: %true if the frame was passed to userspace (or this failed
8152 * for a reason other than not having a subscription.)
8154 bool cfg80211_rx_spurious_frame(struct net_device *dev,
8155 const u8 *addr, gfp_t gfp);
8158 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
8159 * @dev: The device the frame matched to
8160 * @addr: the transmitter address
8161 * @gfp: context flags
8163 * This function is used in AP mode (only!) to inform userspace that
8164 * an associated station sent a 4addr frame but that wasn't expected.
8165 * It is allowed and desirable to send this event only once for each
8166 * station to avoid event flooding.
8167 * Return: %true if the frame was passed to userspace (or this failed
8168 * for a reason other than not having a subscription.)
8170 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
8171 const u8 *addr, gfp_t gfp);
8174 * cfg80211_probe_status - notify userspace about probe status
8175 * @dev: the device the probe was sent on
8176 * @addr: the address of the peer
8177 * @cookie: the cookie filled in @probe_client previously
8178 * @acked: indicates whether probe was acked or not
8179 * @ack_signal: signal strength (in dBm) of the ACK frame.
8180 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
8181 * @gfp: allocation flags
8183 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
8184 u64 cookie, bool acked, s32 ack_signal,
8185 bool is_valid_ack_signal, gfp_t gfp);
8188 * cfg80211_report_obss_beacon_khz - report beacon from other APs
8189 * @wiphy: The wiphy that received the beacon
8191 * @len: length of the frame
8192 * @freq: frequency the frame was received on in KHz
8193 * @sig_dbm: signal strength in dBm, or 0 if unknown
8195 * Use this function to report to userspace when a beacon was
8196 * received. It is not useful to call this when there is no
8197 * netdev that is in AP/GO mode.
8199 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
8200 size_t len, int freq, int sig_dbm);
8203 * cfg80211_report_obss_beacon - report beacon from other APs
8204 * @wiphy: The wiphy that received the beacon
8206 * @len: length of the frame
8207 * @freq: frequency the frame was received on
8208 * @sig_dbm: signal strength in dBm, or 0 if unknown
8210 * Use this function to report to userspace when a beacon was
8211 * received. It is not useful to call this when there is no
8212 * netdev that is in AP/GO mode.
8214 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
8215 const u8 *frame, size_t len,
8216 int freq, int sig_dbm)
8218 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
8223 * cfg80211_reg_can_beacon - check if beaconing is allowed
8225 * @chandef: the channel definition
8226 * @iftype: interface type
8228 * Return: %true if there is no secondary channel or the secondary channel(s)
8229 * can be used for beaconing (i.e. is not a radar channel etc.)
8231 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
8232 struct cfg80211_chan_def *chandef,
8233 enum nl80211_iftype iftype);
8236 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
8238 * @chandef: the channel definition
8239 * @iftype: interface type
8241 * Return: %true if there is no secondary channel or the secondary channel(s)
8242 * can be used for beaconing (i.e. is not a radar channel etc.). This version
8243 * also checks if IR-relaxation conditions apply, to allow beaconing under
8244 * more permissive conditions.
8246 * Requires the wiphy mutex to be held.
8248 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
8249 struct cfg80211_chan_def *chandef,
8250 enum nl80211_iftype iftype);
8253 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
8254 * @dev: the device which switched channels
8255 * @chandef: the new channel definition
8256 * @link_id: the link ID for MLO, must be 0 for non-MLO
8258 * Caller must acquire wdev_lock, therefore must only be called from sleepable
8261 void cfg80211_ch_switch_notify(struct net_device *dev,
8262 struct cfg80211_chan_def *chandef,
8263 unsigned int link_id);
8266 * cfg80211_ch_switch_started_notify - notify channel switch start
8267 * @dev: the device on which the channel switch started
8268 * @chandef: the future channel definition
8269 * @count: the number of TBTTs until the channel switch happens
8270 * @quiet: whether or not immediate quiet was requested by the AP
8272 * Inform the userspace about the channel switch that has just
8273 * started, so that it can take appropriate actions (eg. starting
8274 * channel switch on other vifs), if necessary.
8276 void cfg80211_ch_switch_started_notify(struct net_device *dev,
8277 struct cfg80211_chan_def *chandef,
8278 u8 count, bool quiet);
8281 * ieee80211_operating_class_to_band - convert operating class to band
8283 * @operating_class: the operating class to convert
8284 * @band: band pointer to fill
8286 * Returns %true if the conversion was successful, %false otherwise.
8288 bool ieee80211_operating_class_to_band(u8 operating_class,
8289 enum nl80211_band *band);
8292 * ieee80211_chandef_to_operating_class - convert chandef to operation class
8294 * @chandef: the chandef to convert
8295 * @op_class: a pointer to the resulting operating class
8297 * Returns %true if the conversion was successful, %false otherwise.
8299 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
8303 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
8305 * @chandef: the chandef to convert
8307 * Returns the center frequency of chandef (1st segment) in KHz.
8310 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
8312 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
8316 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
8317 * @dev: the device on which the operation is requested
8318 * @peer: the MAC address of the peer device
8319 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
8320 * NL80211_TDLS_TEARDOWN)
8321 * @reason_code: the reason code for teardown request
8322 * @gfp: allocation flags
8324 * This function is used to request userspace to perform TDLS operation that
8325 * requires knowledge of keys, i.e., link setup or teardown when the AP
8326 * connection uses encryption. This is optional mechanism for the driver to use
8327 * if it can automatically determine when a TDLS link could be useful (e.g.,
8328 * based on traffic and signal strength for a peer).
8330 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
8331 enum nl80211_tdls_operation oper,
8332 u16 reason_code, gfp_t gfp);
8335 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
8336 * @rate: given rate_info to calculate bitrate from
8338 * return 0 if MCS index >= 32
8340 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
8343 * cfg80211_unregister_wdev - remove the given wdev
8344 * @wdev: struct wireless_dev to remove
8346 * This function removes the device so it can no longer be used. It is necessary
8347 * to call this function even when cfg80211 requests the removal of the device
8348 * by calling the del_virtual_intf() callback. The function must also be called
8349 * when the driver wishes to unregister the wdev, e.g. when the hardware device
8350 * is unbound from the driver.
8352 * Requires the RTNL and wiphy mutex to be held.
8354 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
8357 * cfg80211_register_netdevice - register the given netdev
8358 * @dev: the netdev to register
8360 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
8361 * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
8362 * held. Otherwise, both register_netdevice() and register_netdev() are usable
8365 * Requires the RTNL and wiphy mutex to be held.
8367 int cfg80211_register_netdevice(struct net_device *dev);
8370 * cfg80211_unregister_netdevice - unregister the given netdev
8371 * @dev: the netdev to register
8373 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
8374 * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
8375 * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
8376 * usable instead as well.
8378 * Requires the RTNL and wiphy mutex to be held.
8380 static inline void cfg80211_unregister_netdevice(struct net_device *dev)
8382 #if IS_ENABLED(CONFIG_CFG80211)
8383 cfg80211_unregister_wdev(dev->ieee80211_ptr);
8388 * struct cfg80211_ft_event_params - FT Information Elements
8390 * @ies_len: length of the FT IE in bytes
8391 * @target_ap: target AP's MAC address
8393 * @ric_ies_len: length of the RIC IE in bytes
8395 struct cfg80211_ft_event_params {
8398 const u8 *target_ap;
8404 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
8405 * @netdev: network device
8406 * @ft_event: IE information
8408 void cfg80211_ft_event(struct net_device *netdev,
8409 struct cfg80211_ft_event_params *ft_event);
8412 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
8413 * @ies: the input IE buffer
8414 * @len: the input length
8415 * @attr: the attribute ID to find
8416 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
8417 * if the function is only called to get the needed buffer size
8418 * @bufsize: size of the output buffer
8420 * The function finds a given P2P attribute in the (vendor) IEs and
8421 * copies its contents to the given buffer.
8423 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
8424 * malformed or the attribute can't be found (respectively), or the
8425 * length of the found attribute (which can be zero).
8427 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
8428 enum ieee80211_p2p_attr_id attr,
8429 u8 *buf, unsigned int bufsize);
8432 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
8433 * @ies: the IE buffer
8434 * @ielen: the length of the IE buffer
8435 * @ids: an array with element IDs that are allowed before
8436 * the split. A WLAN_EID_EXTENSION value means that the next
8437 * EID in the list is a sub-element of the EXTENSION IE.
8438 * @n_ids: the size of the element ID array
8439 * @after_ric: array IE types that come after the RIC element
8440 * @n_after_ric: size of the @after_ric array
8441 * @offset: offset where to start splitting in the buffer
8443 * This function splits an IE buffer by updating the @offset
8444 * variable to point to the location where the buffer should be
8447 * It assumes that the given IE buffer is well-formed, this
8448 * has to be guaranteed by the caller!
8450 * It also assumes that the IEs in the buffer are ordered
8451 * correctly, if not the result of using this function will not
8452 * be ordered correctly either, i.e. it does no reordering.
8454 * The function returns the offset where the next part of the
8455 * buffer starts, which may be @ielen if the entire (remainder)
8456 * of the buffer should be used.
8458 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
8459 const u8 *ids, int n_ids,
8460 const u8 *after_ric, int n_after_ric,
8464 * ieee80211_ie_split - split an IE buffer according to ordering
8465 * @ies: the IE buffer
8466 * @ielen: the length of the IE buffer
8467 * @ids: an array with element IDs that are allowed before
8468 * the split. A WLAN_EID_EXTENSION value means that the next
8469 * EID in the list is a sub-element of the EXTENSION IE.
8470 * @n_ids: the size of the element ID array
8471 * @offset: offset where to start splitting in the buffer
8473 * This function splits an IE buffer by updating the @offset
8474 * variable to point to the location where the buffer should be
8477 * It assumes that the given IE buffer is well-formed, this
8478 * has to be guaranteed by the caller!
8480 * It also assumes that the IEs in the buffer are ordered
8481 * correctly, if not the result of using this function will not
8482 * be ordered correctly either, i.e. it does no reordering.
8484 * The function returns the offset where the next part of the
8485 * buffer starts, which may be @ielen if the entire (remainder)
8486 * of the buffer should be used.
8488 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
8489 const u8 *ids, int n_ids, size_t offset)
8491 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
8495 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
8496 * @wdev: the wireless device reporting the wakeup
8497 * @wakeup: the wakeup report
8498 * @gfp: allocation flags
8500 * This function reports that the given device woke up. If it
8501 * caused the wakeup, report the reason(s), otherwise you may
8502 * pass %NULL as the @wakeup parameter to advertise that something
8503 * else caused the wakeup.
8505 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
8506 struct cfg80211_wowlan_wakeup *wakeup,
8510 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
8512 * @wdev: the wireless device for which critical protocol is stopped.
8513 * @gfp: allocation flags
8515 * This function can be called by the driver to indicate it has reverted
8516 * operation back to normal. One reason could be that the duration given
8517 * by .crit_proto_start() has expired.
8519 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
8522 * ieee80211_get_num_supported_channels - get number of channels device has
8525 * Return: the number of channels supported by the device.
8527 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
8530 * cfg80211_check_combinations - check interface combinations
8533 * @params: the interface combinations parameter
8535 * This function can be called by the driver to check whether a
8536 * combination of interfaces and their types are allowed according to
8537 * the interface combinations.
8539 int cfg80211_check_combinations(struct wiphy *wiphy,
8540 struct iface_combination_params *params);
8543 * cfg80211_iter_combinations - iterate over matching combinations
8546 * @params: the interface combinations parameter
8547 * @iter: function to call for each matching combination
8548 * @data: pointer to pass to iter function
8550 * This function can be called by the driver to check what possible
8551 * combinations it fits in at a given moment, e.g. for channel switching
8554 int cfg80211_iter_combinations(struct wiphy *wiphy,
8555 struct iface_combination_params *params,
8556 void (*iter)(const struct ieee80211_iface_combination *c,
8561 * cfg80211_stop_iface - trigger interface disconnection
8564 * @wdev: wireless device
8565 * @gfp: context flags
8567 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
8570 * Note: This doesn't need any locks and is asynchronous.
8572 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
8576 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
8577 * @wiphy: the wiphy to shut down
8579 * This function shuts down all interfaces belonging to this wiphy by
8580 * calling dev_close() (and treating non-netdev interfaces as needed).
8581 * It shouldn't really be used unless there are some fatal device errors
8582 * that really can't be recovered in any other way.
8584 * Callers must hold the RTNL and be able to deal with callbacks into
8585 * the driver while the function is running.
8587 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
8590 * wiphy_ext_feature_set - set the extended feature flag
8592 * @wiphy: the wiphy to modify.
8593 * @ftidx: extended feature bit index.
8595 * The extended features are flagged in multiple bytes (see
8596 * &struct wiphy.@ext_features)
8598 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
8599 enum nl80211_ext_feature_index ftidx)
8603 ft_byte = &wiphy->ext_features[ftidx / 8];
8604 *ft_byte |= BIT(ftidx % 8);
8608 * wiphy_ext_feature_isset - check the extended feature flag
8610 * @wiphy: the wiphy to modify.
8611 * @ftidx: extended feature bit index.
8613 * The extended features are flagged in multiple bytes (see
8614 * &struct wiphy.@ext_features)
8617 wiphy_ext_feature_isset(struct wiphy *wiphy,
8618 enum nl80211_ext_feature_index ftidx)
8622 ft_byte = wiphy->ext_features[ftidx / 8];
8623 return (ft_byte & BIT(ftidx % 8)) != 0;
8627 * cfg80211_free_nan_func - free NAN function
8628 * @f: NAN function that should be freed
8630 * Frees all the NAN function and all it's allocated members.
8632 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
8635 * struct cfg80211_nan_match_params - NAN match parameters
8636 * @type: the type of the function that triggered a match. If it is
8637 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
8638 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
8640 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
8641 * @inst_id: the local instance id
8642 * @peer_inst_id: the instance id of the peer's function
8643 * @addr: the MAC address of the peer
8644 * @info_len: the length of the &info
8645 * @info: the Service Specific Info from the peer (if any)
8646 * @cookie: unique identifier of the corresponding function
8648 struct cfg80211_nan_match_params {
8649 enum nl80211_nan_function_type type;
8659 * cfg80211_nan_match - report a match for a NAN function.
8660 * @wdev: the wireless device reporting the match
8661 * @match: match notification parameters
8662 * @gfp: allocation flags
8664 * This function reports that the a NAN function had a match. This
8665 * can be a subscribe that had a match or a solicited publish that
8666 * was sent. It can also be a follow up that was received.
8668 void cfg80211_nan_match(struct wireless_dev *wdev,
8669 struct cfg80211_nan_match_params *match, gfp_t gfp);
8672 * cfg80211_nan_func_terminated - notify about NAN function termination.
8674 * @wdev: the wireless device reporting the match
8675 * @inst_id: the local instance id
8676 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
8677 * @cookie: unique NAN function identifier
8678 * @gfp: allocation flags
8680 * This function reports that the a NAN function is terminated.
8682 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
8684 enum nl80211_nan_func_term_reason reason,
8685 u64 cookie, gfp_t gfp);
8687 /* ethtool helper */
8688 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
8691 * cfg80211_external_auth_request - userspace request for authentication
8692 * @netdev: network device
8693 * @params: External authentication parameters
8694 * @gfp: allocation flags
8695 * Returns: 0 on success, < 0 on error
8697 int cfg80211_external_auth_request(struct net_device *netdev,
8698 struct cfg80211_external_auth_params *params,
8702 * cfg80211_pmsr_report - report peer measurement result data
8703 * @wdev: the wireless device reporting the measurement
8704 * @req: the original measurement request
8705 * @result: the result data
8706 * @gfp: allocation flags
8708 void cfg80211_pmsr_report(struct wireless_dev *wdev,
8709 struct cfg80211_pmsr_request *req,
8710 struct cfg80211_pmsr_result *result,
8714 * cfg80211_pmsr_complete - report peer measurement completed
8715 * @wdev: the wireless device reporting the measurement
8716 * @req: the original measurement request
8717 * @gfp: allocation flags
8719 * Report that the entire measurement completed, after this
8720 * the request pointer will no longer be valid.
8722 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
8723 struct cfg80211_pmsr_request *req,
8727 * cfg80211_iftype_allowed - check whether the interface can be allowed
8729 * @iftype: interface type
8730 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
8731 * @check_swif: check iftype against software interfaces
8733 * Check whether the interface is allowed to operate; additionally, this API
8734 * can be used to check iftype against the software interfaces when
8735 * check_swif is '1'.
8737 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
8738 bool is_4addr, u8 check_swif);
8742 * cfg80211_assoc_comeback - notification of association that was
8743 * temporarly rejected with a comeback
8744 * @netdev: network device
8745 * @ap_addr: AP (MLD) address that rejected the assocation
8746 * @timeout: timeout interval value TUs.
8748 * this function may sleep. the caller must hold the corresponding wdev's mutex.
8750 void cfg80211_assoc_comeback(struct net_device *netdev,
8751 const u8 *ap_addr, u32 timeout);
8753 /* Logging, debugging and troubleshooting/diagnostic helpers. */
8755 /* wiphy_printk helpers, similar to dev_printk */
8757 #define wiphy_printk(level, wiphy, format, args...) \
8758 dev_printk(level, &(wiphy)->dev, format, ##args)
8759 #define wiphy_emerg(wiphy, format, args...) \
8760 dev_emerg(&(wiphy)->dev, format, ##args)
8761 #define wiphy_alert(wiphy, format, args...) \
8762 dev_alert(&(wiphy)->dev, format, ##args)
8763 #define wiphy_crit(wiphy, format, args...) \
8764 dev_crit(&(wiphy)->dev, format, ##args)
8765 #define wiphy_err(wiphy, format, args...) \
8766 dev_err(&(wiphy)->dev, format, ##args)
8767 #define wiphy_warn(wiphy, format, args...) \
8768 dev_warn(&(wiphy)->dev, format, ##args)
8769 #define wiphy_notice(wiphy, format, args...) \
8770 dev_notice(&(wiphy)->dev, format, ##args)
8771 #define wiphy_info(wiphy, format, args...) \
8772 dev_info(&(wiphy)->dev, format, ##args)
8773 #define wiphy_info_once(wiphy, format, args...) \
8774 dev_info_once(&(wiphy)->dev, format, ##args)
8776 #define wiphy_err_ratelimited(wiphy, format, args...) \
8777 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
8778 #define wiphy_warn_ratelimited(wiphy, format, args...) \
8779 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
8781 #define wiphy_debug(wiphy, format, args...) \
8782 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
8784 #define wiphy_dbg(wiphy, format, args...) \
8785 dev_dbg(&(wiphy)->dev, format, ##args)
8787 #if defined(VERBOSE_DEBUG)
8788 #define wiphy_vdbg wiphy_dbg
8790 #define wiphy_vdbg(wiphy, format, args...) \
8793 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8799 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8800 * of using a WARN/WARN_ON to get the message out, including the
8801 * file/line information and a backtrace.
8803 #define wiphy_WARN(wiphy, format, args...) \
8804 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8807 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8808 * @netdev: network device
8809 * @owe_info: peer's owe info
8810 * @gfp: allocation flags
8812 void cfg80211_update_owe_info_event(struct net_device *netdev,
8813 struct cfg80211_update_owe_info *owe_info,
8817 * cfg80211_bss_flush - resets all the scan entries
8820 void cfg80211_bss_flush(struct wiphy *wiphy);
8823 * cfg80211_bss_color_notify - notify about bss color event
8824 * @dev: network device
8825 * @gfp: allocation flags
8826 * @cmd: the actual event we want to notify
8827 * @count: the number of TBTTs until the color change happens
8828 * @color_bitmap: representations of the colors that the local BSS is aware of
8830 int cfg80211_bss_color_notify(struct net_device *dev, gfp_t gfp,
8831 enum nl80211_commands cmd, u8 count,
8835 * cfg80211_obss_color_collision_notify - notify about bss color collision
8836 * @dev: network device
8837 * @color_bitmap: representations of the colors that the local BSS is aware of
8838 * @gfp: allocation flags
8840 static inline int cfg80211_obss_color_collision_notify(struct net_device *dev,
8841 u64 color_bitmap, gfp_t gfp)
8843 return cfg80211_bss_color_notify(dev, gfp,
8844 NL80211_CMD_OBSS_COLOR_COLLISION,
8849 * cfg80211_color_change_started_notify - notify color change start
8850 * @dev: the device on which the color is switched
8851 * @count: the number of TBTTs until the color change happens
8853 * Inform the userspace about the color change that has started.
8855 static inline int cfg80211_color_change_started_notify(struct net_device *dev,
8858 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8859 NL80211_CMD_COLOR_CHANGE_STARTED,
8864 * cfg80211_color_change_aborted_notify - notify color change abort
8865 * @dev: the device on which the color is switched
8867 * Inform the userspace about the color change that has aborted.
8869 static inline int cfg80211_color_change_aborted_notify(struct net_device *dev)
8871 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8872 NL80211_CMD_COLOR_CHANGE_ABORTED,
8877 * cfg80211_color_change_notify - notify color change completion
8878 * @dev: the device on which the color was switched
8880 * Inform the userspace about the color change that has completed.
8882 static inline int cfg80211_color_change_notify(struct net_device *dev)
8884 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8885 NL80211_CMD_COLOR_CHANGE_COMPLETED,
8889 #endif /* __NET_CFG80211_H */