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._80: MCS/NSS support for BW <= 80 MHz
378 * @bw._160: MCS/NSS support for BW = 160 MHz
379 * @bw._320: MCS/NSS support for BW = 320 MHz
381 struct ieee80211_eht_mcs_nss_supp {
383 struct ieee80211_eht_mcs_nss_supp_20mhz_only only_20mhz;
385 struct ieee80211_eht_mcs_nss_supp_bw _80;
386 struct ieee80211_eht_mcs_nss_supp_bw _160;
387 struct ieee80211_eht_mcs_nss_supp_bw _320;
392 #define IEEE80211_EHT_PPE_THRES_MAX_LEN 32
395 * struct ieee80211_sta_eht_cap - STA's EHT capabilities
397 * This structure describes most essential parameters needed
398 * to describe 802.11be EHT capabilities for a STA.
400 * @has_eht: true iff EHT data is valid.
401 * @eht_cap_elem: Fixed portion of the eht capabilities element.
402 * @eht_mcs_nss_supp: The supported NSS/MCS combinations.
403 * @eht_ppe_thres: Holds the PPE Thresholds data.
405 struct ieee80211_sta_eht_cap {
407 struct ieee80211_eht_cap_elem_fixed eht_cap_elem;
408 struct ieee80211_eht_mcs_nss_supp eht_mcs_nss_supp;
409 u8 eht_ppe_thres[IEEE80211_EHT_PPE_THRES_MAX_LEN];
413 * struct ieee80211_sband_iftype_data - sband data per interface type
415 * This structure encapsulates sband data that is relevant for the
416 * interface types defined in @types_mask. Each type in the
417 * @types_mask must be unique across all instances of iftype_data.
419 * @types_mask: interface types mask
420 * @he_cap: holds the HE capabilities
421 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
422 * 6 GHz band channel (and 0 may be valid value).
423 * @vendor_elems: vendor element(s) to advertise
424 * @vendor_elems.data: vendor element(s) data
425 * @vendor_elems.len: vendor element(s) length
427 struct ieee80211_sband_iftype_data {
429 struct ieee80211_sta_he_cap he_cap;
430 struct ieee80211_he_6ghz_capa he_6ghz_capa;
431 struct ieee80211_sta_eht_cap eht_cap;
439 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
441 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
442 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
443 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
444 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
445 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
446 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
447 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
448 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
450 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
452 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
454 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
455 * and 4.32GHz + 4.32GHz
456 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
457 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
459 enum ieee80211_edmg_bw_config {
460 IEEE80211_EDMG_BW_CONFIG_4 = 4,
461 IEEE80211_EDMG_BW_CONFIG_5 = 5,
462 IEEE80211_EDMG_BW_CONFIG_6 = 6,
463 IEEE80211_EDMG_BW_CONFIG_7 = 7,
464 IEEE80211_EDMG_BW_CONFIG_8 = 8,
465 IEEE80211_EDMG_BW_CONFIG_9 = 9,
466 IEEE80211_EDMG_BW_CONFIG_10 = 10,
467 IEEE80211_EDMG_BW_CONFIG_11 = 11,
468 IEEE80211_EDMG_BW_CONFIG_12 = 12,
469 IEEE80211_EDMG_BW_CONFIG_13 = 13,
470 IEEE80211_EDMG_BW_CONFIG_14 = 14,
471 IEEE80211_EDMG_BW_CONFIG_15 = 15,
475 * struct ieee80211_edmg - EDMG configuration
477 * This structure describes most essential parameters needed
478 * to describe 802.11ay EDMG configuration
480 * @channels: bitmap that indicates the 2.16 GHz channel(s)
481 * that are allowed to be used for transmissions.
482 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
483 * Set to 0 indicate EDMG not supported.
484 * @bw_config: Channel BW Configuration subfield encodes
485 * the allowed channel bandwidth configurations
487 struct ieee80211_edmg {
489 enum ieee80211_edmg_bw_config bw_config;
493 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
495 * This structure describes most essential parameters needed
496 * to describe 802.11ah S1G capabilities for a STA.
498 * @s1g_supported: is STA an S1G STA
499 * @cap: S1G capabilities information
500 * @nss_mcs: Supported NSS MCS set
502 struct ieee80211_sta_s1g_cap {
504 u8 cap[10]; /* use S1G_CAPAB_ */
509 * struct ieee80211_supported_band - frequency band definition
511 * This structure describes a frequency band a wiphy
512 * is able to operate in.
514 * @channels: Array of channels the hardware can operate with
516 * @band: the band this structure represents
517 * @n_channels: Number of channels in @channels
518 * @bitrates: Array of bitrates the hardware can operate with
519 * in this band. Must be sorted to give a valid "supported
520 * rates" IE, i.e. CCK rates first, then OFDM.
521 * @n_bitrates: Number of bitrates in @bitrates
522 * @ht_cap: HT capabilities in this band
523 * @vht_cap: VHT capabilities in this band
524 * @s1g_cap: S1G capabilities in this band
525 * @edmg_cap: EDMG capabilities in this band
526 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
527 * @n_iftype_data: number of iftype data entries
528 * @iftype_data: interface type data entries. Note that the bits in
529 * @types_mask inside this structure cannot overlap (i.e. only
530 * one occurrence of each type is allowed across all instances of
533 struct ieee80211_supported_band {
534 struct ieee80211_channel *channels;
535 struct ieee80211_rate *bitrates;
536 enum nl80211_band band;
539 struct ieee80211_sta_ht_cap ht_cap;
540 struct ieee80211_sta_vht_cap vht_cap;
541 struct ieee80211_sta_s1g_cap s1g_cap;
542 struct ieee80211_edmg edmg_cap;
544 const struct ieee80211_sband_iftype_data *iftype_data;
548 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
549 * @sband: the sband to search for the STA on
550 * @iftype: enum nl80211_iftype
552 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
554 static inline const struct ieee80211_sband_iftype_data *
555 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
560 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
563 for (i = 0; i < sband->n_iftype_data; i++) {
564 const struct ieee80211_sband_iftype_data *data =
565 &sband->iftype_data[i];
567 if (data->types_mask & BIT(iftype))
575 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
576 * @sband: the sband to search for the iftype on
577 * @iftype: enum nl80211_iftype
579 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
581 static inline const struct ieee80211_sta_he_cap *
582 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
585 const struct ieee80211_sband_iftype_data *data =
586 ieee80211_get_sband_iftype_data(sband, iftype);
588 if (data && data->he_cap.has_he)
589 return &data->he_cap;
595 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
596 * @sband: the sband to search for the STA on
597 * @iftype: the iftype to search for
599 * Return: the 6GHz capabilities
602 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
603 enum nl80211_iftype iftype)
605 const struct ieee80211_sband_iftype_data *data =
606 ieee80211_get_sband_iftype_data(sband, iftype);
608 if (WARN_ON(!data || !data->he_cap.has_he))
611 return data->he_6ghz_capa.capa;
615 * ieee80211_get_eht_iftype_cap - return ETH capabilities for an sband's iftype
616 * @sband: the sband to search for the iftype on
617 * @iftype: enum nl80211_iftype
619 * Return: pointer to the struct ieee80211_sta_eht_cap, or NULL is none found
621 static inline const struct ieee80211_sta_eht_cap *
622 ieee80211_get_eht_iftype_cap(const struct ieee80211_supported_band *sband,
623 enum nl80211_iftype iftype)
625 const struct ieee80211_sband_iftype_data *data =
626 ieee80211_get_sband_iftype_data(sband, iftype);
628 if (data && data->eht_cap.has_eht)
629 return &data->eht_cap;
635 * wiphy_read_of_freq_limits - read frequency limits from device tree
637 * @wiphy: the wireless device to get extra limits for
639 * Some devices may have extra limitations specified in DT. This may be useful
640 * for chipsets that normally support more bands but are limited due to board
641 * design (e.g. by antennas or external power amplifier).
643 * This function reads info from DT and uses it to *modify* channels (disable
644 * unavailable ones). It's usually a *bad* idea to use it in drivers with
645 * shared channel data as DT limitations are device specific. You should make
646 * sure to call it only if channels in wiphy are copied and can be modified
647 * without affecting other devices.
649 * As this function access device node it has to be called after set_wiphy_dev.
650 * It also modifies channels so they have to be set first.
651 * If using this helper, call it before wiphy_register().
654 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
655 #else /* CONFIG_OF */
656 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
659 #endif /* !CONFIG_OF */
663 * Wireless hardware/device configuration structures and methods
667 * DOC: Actions and configuration
669 * Each wireless device and each virtual interface offer a set of configuration
670 * operations and other actions that are invoked by userspace. Each of these
671 * actions is described in the operations structure, and the parameters these
672 * operations use are described separately.
674 * Additionally, some operations are asynchronous and expect to get status
675 * information via some functions that drivers need to call.
677 * Scanning and BSS list handling with its associated functionality is described
678 * in a separate chapter.
681 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
682 WLAN_USER_POSITION_LEN)
685 * struct vif_params - describes virtual interface parameters
686 * @flags: monitor interface flags, unchanged if 0, otherwise
687 * %MONITOR_FLAG_CHANGED will be set
688 * @use_4addr: use 4-address frames
689 * @macaddr: address to use for this virtual interface.
690 * If this parameter is set to zero address the driver may
691 * determine the address as needed.
692 * This feature is only fully supported by drivers that enable the
693 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
694 ** only p2p devices with specified MAC.
695 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
696 * belonging to that MU-MIMO groupID; %NULL if not changed
697 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
698 * MU-MIMO packets going to the specified station; %NULL if not changed
703 u8 macaddr[ETH_ALEN];
704 const u8 *vht_mumimo_groups;
705 const u8 *vht_mumimo_follow_addr;
709 * struct key_params - key information
711 * Information about a key
714 * @key_len: length of key material
715 * @cipher: cipher suite selector
716 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
717 * with the get_key() callback, must be in little endian,
718 * length given by @seq_len.
719 * @seq_len: length of @seq.
720 * @vlan_id: vlan_id for VLAN group key (if nonzero)
721 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
730 enum nl80211_key_mode mode;
734 * struct cfg80211_chan_def - channel definition
735 * @chan: the (control) channel
736 * @width: channel width
737 * @center_freq1: center frequency of first segment
738 * @center_freq2: center frequency of second segment
739 * (only with 80+80 MHz)
740 * @edmg: define the EDMG channels configuration.
741 * If edmg is requested (i.e. the .channels member is non-zero),
742 * chan will define the primary channel and all other
743 * parameters are ignored.
744 * @freq1_offset: offset from @center_freq1, in KHz
746 struct cfg80211_chan_def {
747 struct ieee80211_channel *chan;
748 enum nl80211_chan_width width;
751 struct ieee80211_edmg edmg;
756 * cfg80211_bitrate_mask - masks for bitrate control
758 struct cfg80211_bitrate_mask {
761 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
762 u16 vht_mcs[NL80211_VHT_NSS_MAX];
763 u16 he_mcs[NL80211_HE_NSS_MAX];
764 enum nl80211_txrate_gi gi;
765 enum nl80211_he_gi he_gi;
766 enum nl80211_he_ltf he_ltf;
767 } control[NUM_NL80211_BANDS];
772 * struct cfg80211_tid_cfg - TID specific configuration
773 * @config_override: Flag to notify driver to reset TID configuration
775 * @tids: bitmap of TIDs to modify
776 * @mask: bitmap of attributes indicating which parameter changed,
777 * similar to &nl80211_tid_config_supp.
778 * @noack: noack configuration value for the TID
779 * @retry_long: retry count value
780 * @retry_short: retry count value
781 * @ampdu: Enable/Disable MPDU aggregation
782 * @rtscts: Enable/Disable RTS/CTS
783 * @amsdu: Enable/Disable MSDU aggregation
784 * @txrate_type: Tx bitrate mask type
785 * @txrate_mask: Tx bitrate to be applied for the TID
787 struct cfg80211_tid_cfg {
788 bool config_override;
791 enum nl80211_tid_config noack;
792 u8 retry_long, retry_short;
793 enum nl80211_tid_config ampdu;
794 enum nl80211_tid_config rtscts;
795 enum nl80211_tid_config amsdu;
796 enum nl80211_tx_rate_setting txrate_type;
797 struct cfg80211_bitrate_mask txrate_mask;
801 * struct cfg80211_tid_config - TID configuration
802 * @peer: Station's MAC address
803 * @n_tid_conf: Number of TID specific configurations to be applied
804 * @tid_conf: Configuration change info
806 struct cfg80211_tid_config {
809 struct cfg80211_tid_cfg tid_conf[];
813 * struct cfg80211_fils_aad - FILS AAD data
814 * @macaddr: STA MAC address
816 * @kek_len: FILS KEK length
820 struct cfg80211_fils_aad {
829 * cfg80211_get_chandef_type - return old channel type from chandef
830 * @chandef: the channel definition
832 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
833 * chandef, which must have a bandwidth allowing this conversion.
835 static inline enum nl80211_channel_type
836 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
838 switch (chandef->width) {
839 case NL80211_CHAN_WIDTH_20_NOHT:
840 return NL80211_CHAN_NO_HT;
841 case NL80211_CHAN_WIDTH_20:
842 return NL80211_CHAN_HT20;
843 case NL80211_CHAN_WIDTH_40:
844 if (chandef->center_freq1 > chandef->chan->center_freq)
845 return NL80211_CHAN_HT40PLUS;
846 return NL80211_CHAN_HT40MINUS;
849 return NL80211_CHAN_NO_HT;
854 * cfg80211_chandef_create - create channel definition using channel type
855 * @chandef: the channel definition struct to fill
856 * @channel: the control channel
857 * @chantype: the channel type
859 * Given a channel type, create a channel definition.
861 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
862 struct ieee80211_channel *channel,
863 enum nl80211_channel_type chantype);
866 * cfg80211_chandef_identical - check if two channel definitions are identical
867 * @chandef1: first channel definition
868 * @chandef2: second channel definition
870 * Return: %true if the channels defined by the channel definitions are
871 * identical, %false otherwise.
874 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
875 const struct cfg80211_chan_def *chandef2)
877 return (chandef1->chan == chandef2->chan &&
878 chandef1->width == chandef2->width &&
879 chandef1->center_freq1 == chandef2->center_freq1 &&
880 chandef1->freq1_offset == chandef2->freq1_offset &&
881 chandef1->center_freq2 == chandef2->center_freq2);
885 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
887 * @chandef: the channel definition
889 * Return: %true if EDMG defined, %false otherwise.
892 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
894 return chandef->edmg.channels || chandef->edmg.bw_config;
898 * cfg80211_chandef_compatible - check if two channel definitions are compatible
899 * @chandef1: first channel definition
900 * @chandef2: second channel definition
902 * Return: %NULL if the given channel definitions are incompatible,
903 * chandef1 or chandef2 otherwise.
905 const struct cfg80211_chan_def *
906 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
907 const struct cfg80211_chan_def *chandef2);
910 * cfg80211_chandef_valid - check if a channel definition is valid
911 * @chandef: the channel definition to check
912 * Return: %true if the channel definition is valid. %false otherwise.
914 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
917 * cfg80211_chandef_usable - check if secondary channels can be used
918 * @wiphy: the wiphy to validate against
919 * @chandef: the channel definition to check
920 * @prohibited_flags: the regulatory channel flags that must not be set
921 * Return: %true if secondary channels are usable. %false otherwise.
923 bool cfg80211_chandef_usable(struct wiphy *wiphy,
924 const struct cfg80211_chan_def *chandef,
925 u32 prohibited_flags);
928 * cfg80211_chandef_dfs_required - checks if radar detection is required
929 * @wiphy: the wiphy to validate against
930 * @chandef: the channel definition to check
931 * @iftype: the interface type as specified in &enum nl80211_iftype
933 * 1 if radar detection is required, 0 if it is not, < 0 on error
935 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
936 const struct cfg80211_chan_def *chandef,
937 enum nl80211_iftype iftype);
940 * ieee80211_chandef_rate_flags - returns rate flags for a channel
942 * In some channel types, not all rates may be used - for example CCK
943 * rates may not be used in 5/10 MHz channels.
945 * @chandef: channel definition for the channel
947 * Returns: rate flags which apply for this channel
949 static inline enum ieee80211_rate_flags
950 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
952 switch (chandef->width) {
953 case NL80211_CHAN_WIDTH_5:
954 return IEEE80211_RATE_SUPPORTS_5MHZ;
955 case NL80211_CHAN_WIDTH_10:
956 return IEEE80211_RATE_SUPPORTS_10MHZ;
964 * ieee80211_chandef_max_power - maximum transmission power for the chandef
966 * In some regulations, the transmit power may depend on the configured channel
967 * bandwidth which may be defined as dBm/MHz. This function returns the actual
968 * max_power for non-standard (20 MHz) channels.
970 * @chandef: channel definition for the channel
972 * Returns: maximum allowed transmission power in dBm for the chandef
975 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
977 switch (chandef->width) {
978 case NL80211_CHAN_WIDTH_5:
979 return min(chandef->chan->max_reg_power - 6,
980 chandef->chan->max_power);
981 case NL80211_CHAN_WIDTH_10:
982 return min(chandef->chan->max_reg_power - 3,
983 chandef->chan->max_power);
987 return chandef->chan->max_power;
991 * cfg80211_any_usable_channels - check for usable channels
992 * @wiphy: the wiphy to check for
993 * @band_mask: which bands to check on
994 * @prohibited_flags: which channels to not consider usable,
995 * %IEEE80211_CHAN_DISABLED is always taken into account
997 bool cfg80211_any_usable_channels(struct wiphy *wiphy,
998 unsigned long band_mask,
999 u32 prohibited_flags);
1002 * enum survey_info_flags - survey information flags
1004 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
1005 * @SURVEY_INFO_IN_USE: channel is currently being used
1006 * @SURVEY_INFO_TIME: active time (in ms) was filled in
1007 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
1008 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
1009 * @SURVEY_INFO_TIME_RX: receive time was filled in
1010 * @SURVEY_INFO_TIME_TX: transmit time was filled in
1011 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
1012 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
1014 * Used by the driver to indicate which info in &struct survey_info
1015 * it has filled in during the get_survey().
1017 enum survey_info_flags {
1018 SURVEY_INFO_NOISE_DBM = BIT(0),
1019 SURVEY_INFO_IN_USE = BIT(1),
1020 SURVEY_INFO_TIME = BIT(2),
1021 SURVEY_INFO_TIME_BUSY = BIT(3),
1022 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
1023 SURVEY_INFO_TIME_RX = BIT(5),
1024 SURVEY_INFO_TIME_TX = BIT(6),
1025 SURVEY_INFO_TIME_SCAN = BIT(7),
1026 SURVEY_INFO_TIME_BSS_RX = BIT(8),
1030 * struct survey_info - channel survey response
1032 * @channel: the channel this survey record reports, may be %NULL for a single
1033 * record to report global statistics
1034 * @filled: bitflag of flags from &enum survey_info_flags
1035 * @noise: channel noise in dBm. This and all following fields are
1037 * @time: amount of time in ms the radio was turn on (on the channel)
1038 * @time_busy: amount of time the primary channel was sensed busy
1039 * @time_ext_busy: amount of time the extension channel was sensed busy
1040 * @time_rx: amount of time the radio spent receiving data
1041 * @time_tx: amount of time the radio spent transmitting data
1042 * @time_scan: amount of time the radio spent for scanning
1043 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
1045 * Used by dump_survey() to report back per-channel survey information.
1047 * This structure can later be expanded with things like
1048 * channel duty cycle etc.
1050 struct survey_info {
1051 struct ieee80211_channel *channel;
1063 #define CFG80211_MAX_WEP_KEYS 4
1066 * struct cfg80211_crypto_settings - Crypto settings
1067 * @wpa_versions: indicates which, if any, WPA versions are enabled
1068 * (from enum nl80211_wpa_versions)
1069 * @cipher_group: group key cipher suite (or 0 if unset)
1070 * @n_ciphers_pairwise: number of AP supported unicast ciphers
1071 * @ciphers_pairwise: unicast key cipher suites
1072 * @n_akm_suites: number of AKM suites
1073 * @akm_suites: AKM suites
1074 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
1075 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1076 * required to assume that the port is unauthorized until authorized by
1077 * user space. Otherwise, port is marked authorized by default.
1078 * @control_port_ethertype: the control port protocol that should be
1079 * allowed through even on unauthorized ports
1080 * @control_port_no_encrypt: TRUE to prevent encryption of control port
1082 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1083 * port frames over NL80211 instead of the network interface.
1084 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
1086 * @wep_keys: static WEP keys, if not NULL points to an array of
1087 * CFG80211_MAX_WEP_KEYS WEP keys
1088 * @wep_tx_key: key index (0..3) of the default TX static WEP key
1089 * @psk: PSK (for devices supporting 4-way-handshake offload)
1090 * @sae_pwd: password for SAE authentication (for devices supporting SAE
1092 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1093 * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
1095 * NL80211_SAE_PWE_UNSPECIFIED
1096 * Not-specified, used to indicate userspace did not specify any
1097 * preference. The driver should follow its internal policy in
1100 * NL80211_SAE_PWE_HUNT_AND_PECK
1101 * Allow hunting-and-pecking loop only
1103 * NL80211_SAE_PWE_HASH_TO_ELEMENT
1104 * Allow hash-to-element only
1106 * NL80211_SAE_PWE_BOTH
1107 * Allow either hunting-and-pecking loop or hash-to-element
1109 struct cfg80211_crypto_settings {
1112 int n_ciphers_pairwise;
1113 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1115 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
1117 __be16 control_port_ethertype;
1118 bool control_port_no_encrypt;
1119 bool control_port_over_nl80211;
1120 bool control_port_no_preauth;
1121 struct key_params *wep_keys;
1126 enum nl80211_sae_pwe_mechanism sae_pwe;
1130 * struct cfg80211_mbssid_config - AP settings for multi bssid
1132 * @tx_wdev: pointer to the transmitted interface in the MBSSID set
1133 * @index: index of this AP in the multi bssid group.
1134 * @ema: set to true if the beacons should be sent out in EMA mode.
1136 struct cfg80211_mbssid_config {
1137 struct wireless_dev *tx_wdev;
1143 * struct cfg80211_mbssid_elems - Multiple BSSID elements
1145 * @cnt: Number of elements in array %elems.
1147 * @elem: Array of multiple BSSID element(s) to be added into Beacon frames.
1148 * @elem.data: Data for multiple BSSID elements.
1149 * @elem.len: Length of data.
1151 struct cfg80211_mbssid_elems {
1160 * struct cfg80211_beacon_data - beacon data
1161 * @head: head portion of beacon (before TIM IE)
1162 * or %NULL if not changed
1163 * @tail: tail portion of beacon (after TIM IE)
1164 * or %NULL if not changed
1165 * @head_len: length of @head
1166 * @tail_len: length of @tail
1167 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1168 * @beacon_ies_len: length of beacon_ies in octets
1169 * @proberesp_ies: extra information element(s) to add into Probe Response
1171 * @proberesp_ies_len: length of proberesp_ies in octets
1172 * @assocresp_ies: extra information element(s) to add into (Re)Association
1173 * Response frames or %NULL
1174 * @assocresp_ies_len: length of assocresp_ies in octets
1175 * @probe_resp_len: length of probe response template (@probe_resp)
1176 * @probe_resp: probe response template (AP mode only)
1177 * @mbssid_ies: multiple BSSID elements
1178 * @ftm_responder: enable FTM responder functionality; -1 for no change
1179 * (which also implies no change in LCI/civic location data)
1180 * @lci: Measurement Report element content, starting with Measurement Token
1181 * (measurement type 8)
1182 * @civicloc: Measurement Report element content, starting with Measurement
1183 * Token (measurement type 11)
1184 * @lci_len: LCI data length
1185 * @civicloc_len: Civic location data length
1187 struct cfg80211_beacon_data {
1188 const u8 *head, *tail;
1189 const u8 *beacon_ies;
1190 const u8 *proberesp_ies;
1191 const u8 *assocresp_ies;
1192 const u8 *probe_resp;
1195 struct cfg80211_mbssid_elems *mbssid_ies;
1198 size_t head_len, tail_len;
1199 size_t beacon_ies_len;
1200 size_t proberesp_ies_len;
1201 size_t assocresp_ies_len;
1202 size_t probe_resp_len;
1204 size_t civicloc_len;
1207 struct mac_address {
1212 * struct cfg80211_acl_data - Access control list data
1214 * @acl_policy: ACL policy to be applied on the station's
1215 * entry specified by mac_addr
1216 * @n_acl_entries: Number of MAC address entries passed
1217 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1219 struct cfg80211_acl_data {
1220 enum nl80211_acl_policy acl_policy;
1224 struct mac_address mac_addrs[];
1228 * struct cfg80211_fils_discovery - FILS discovery parameters from
1229 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1231 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1232 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1233 * @tmpl_len: Template length
1234 * @tmpl: Template data for FILS discovery frame including the action
1237 struct cfg80211_fils_discovery {
1245 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1246 * response parameters in 6GHz.
1248 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1249 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1251 * @tmpl_len: Template length
1252 * @tmpl: Template data for probe response
1254 struct cfg80211_unsol_bcast_probe_resp {
1261 * struct cfg80211_ap_settings - AP configuration
1263 * Used to configure an AP interface.
1265 * @chandef: defines the channel to use
1266 * @beacon: beacon data
1267 * @beacon_interval: beacon interval
1268 * @dtim_period: DTIM period
1269 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1271 * @ssid_len: length of @ssid
1272 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1273 * @crypto: crypto settings
1274 * @privacy: the BSS uses privacy
1275 * @auth_type: Authentication type (algorithm)
1276 * @smps_mode: SMPS mode
1277 * @inactivity_timeout: time in seconds to determine station's inactivity.
1278 * @p2p_ctwindow: P2P CT Window
1279 * @p2p_opp_ps: P2P opportunistic PS
1280 * @acl: ACL configuration used by the drivers which has support for
1281 * MAC address based access control
1282 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1284 * @beacon_rate: bitrate to be used for beacons
1285 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1286 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1287 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1288 * @ht_required: stations must support HT
1289 * @vht_required: stations must support VHT
1290 * @twt_responder: Enable Target Wait Time
1291 * @he_required: stations must support HE
1292 * @sae_h2e_required: stations must support direct H2E technique in SAE
1293 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1294 * @he_obss_pd: OBSS Packet Detection settings
1295 * @he_bss_color: BSS Color settings
1296 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1297 * @fils_discovery: FILS discovery transmission parameters
1298 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1299 * @mbssid_config: AP settings for multiple bssid
1301 struct cfg80211_ap_settings {
1302 struct cfg80211_chan_def chandef;
1304 struct cfg80211_beacon_data beacon;
1306 int beacon_interval, dtim_period;
1309 enum nl80211_hidden_ssid hidden_ssid;
1310 struct cfg80211_crypto_settings crypto;
1312 enum nl80211_auth_type auth_type;
1313 enum nl80211_smps_mode smps_mode;
1314 int inactivity_timeout;
1317 const struct cfg80211_acl_data *acl;
1319 struct cfg80211_bitrate_mask beacon_rate;
1321 const struct ieee80211_ht_cap *ht_cap;
1322 const struct ieee80211_vht_cap *vht_cap;
1323 const struct ieee80211_he_cap_elem *he_cap;
1324 const struct ieee80211_he_operation *he_oper;
1325 bool ht_required, vht_required, he_required, sae_h2e_required;
1328 struct ieee80211_he_obss_pd he_obss_pd;
1329 struct cfg80211_he_bss_color he_bss_color;
1330 struct cfg80211_fils_discovery fils_discovery;
1331 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1332 struct cfg80211_mbssid_config mbssid_config;
1336 * struct cfg80211_csa_settings - channel switch settings
1338 * Used for channel switch
1340 * @chandef: defines the channel to use after the switch
1341 * @beacon_csa: beacon data while performing the switch
1342 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1343 * @counter_offsets_presp: offsets of the counters within the probe response
1344 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1345 * @n_counter_offsets_presp: number of csa counters in the probe response
1346 * @beacon_after: beacon data to be used on the new channel
1347 * @radar_required: whether radar detection is required on the new channel
1348 * @block_tx: whether transmissions should be blocked while changing
1349 * @count: number of beacons until switch
1351 struct cfg80211_csa_settings {
1352 struct cfg80211_chan_def chandef;
1353 struct cfg80211_beacon_data beacon_csa;
1354 const u16 *counter_offsets_beacon;
1355 const u16 *counter_offsets_presp;
1356 unsigned int n_counter_offsets_beacon;
1357 unsigned int n_counter_offsets_presp;
1358 struct cfg80211_beacon_data beacon_after;
1359 bool radar_required;
1365 * struct cfg80211_color_change_settings - color change settings
1367 * Used for bss color change
1369 * @beacon_color_change: beacon data while performing the color countdown
1370 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1371 * @counter_offsets_presp: offsets of the counters within the probe response
1372 * @beacon_next: beacon data to be used after the color change
1373 * @count: number of beacons until the color change
1374 * @color: the color used after the change
1376 struct cfg80211_color_change_settings {
1377 struct cfg80211_beacon_data beacon_color_change;
1378 u16 counter_offset_beacon;
1379 u16 counter_offset_presp;
1380 struct cfg80211_beacon_data beacon_next;
1386 * struct iface_combination_params - input parameters for interface combinations
1388 * Used to pass interface combination parameters
1390 * @num_different_channels: the number of different channels we want
1391 * to use for verification
1392 * @radar_detect: a bitmap where each bit corresponds to a channel
1393 * width where radar detection is needed, as in the definition of
1394 * &struct ieee80211_iface_combination.@radar_detect_widths
1395 * @iftype_num: array with the number of interfaces of each interface
1396 * type. The index is the interface type as specified in &enum
1398 * @new_beacon_int: set this to the beacon interval of a new interface
1399 * that's not operating yet, if such is to be checked as part of
1402 struct iface_combination_params {
1403 int num_different_channels;
1405 int iftype_num[NUM_NL80211_IFTYPES];
1410 * enum station_parameters_apply_mask - station parameter values to apply
1411 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1412 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1413 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1415 * Not all station parameters have in-band "no change" signalling,
1416 * for those that don't these flags will are used.
1418 enum station_parameters_apply_mask {
1419 STATION_PARAM_APPLY_UAPSD = BIT(0),
1420 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1421 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1422 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1426 * struct sta_txpwr - station txpower configuration
1428 * Used to configure txpower for station.
1430 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1431 * is not provided, the default per-interface tx power setting will be
1432 * overriding. Driver should be picking up the lowest tx power, either tx
1433 * power per-interface or per-station.
1434 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1435 * will be less than or equal to specified from userspace, whereas if TPC
1436 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1437 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1442 enum nl80211_tx_power_setting type;
1446 * struct station_parameters - station parameters
1448 * Used to change and create a new station.
1450 * @vlan: vlan interface station should belong to
1451 * @supported_rates: supported rates in IEEE 802.11 format
1452 * (or NULL for no change)
1453 * @supported_rates_len: number of supported rates
1454 * @sta_flags_mask: station flags that changed
1455 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1456 * @sta_flags_set: station flags values
1457 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1458 * @listen_interval: listen interval or -1 for no change
1459 * @aid: AID or zero for no change
1460 * @vlan_id: VLAN ID for station (if nonzero)
1461 * @peer_aid: mesh peer AID or zero for no change
1462 * @plink_action: plink action to take
1463 * @plink_state: set the peer link state for a station
1464 * @ht_capa: HT capabilities of station
1465 * @vht_capa: VHT capabilities of station
1466 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1467 * as the AC bitmap in the QoS info field
1468 * @max_sp: max Service Period. same format as the MAX_SP in the
1469 * QoS info field (but already shifted down)
1470 * @sta_modify_mask: bitmap indicating which parameters changed
1471 * (for those that don't have a natural "no change" value),
1472 * see &enum station_parameters_apply_mask
1473 * @local_pm: local link-specific mesh power save mode (no change when set
1475 * @capability: station capability
1476 * @ext_capab: extended capabilities of the station
1477 * @ext_capab_len: number of extended capabilities
1478 * @supported_channels: supported channels in IEEE 802.11 format
1479 * @supported_channels_len: number of supported channels
1480 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1481 * @supported_oper_classes_len: number of supported operating classes
1482 * @opmode_notif: operating mode field from Operating Mode Notification
1483 * @opmode_notif_used: information if operating mode field is used
1484 * @support_p2p_ps: information if station supports P2P PS mechanism
1485 * @he_capa: HE capabilities of station
1486 * @he_capa_len: the length of the HE capabilities
1487 * @airtime_weight: airtime scheduler weight for this station
1488 * @txpwr: transmit power for an associated station
1489 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1490 * @eht_capa: EHT capabilities of station
1491 * @eht_capa_len: the length of the EHT capabilities
1493 struct station_parameters {
1494 const u8 *supported_rates;
1495 struct net_device *vlan;
1496 u32 sta_flags_mask, sta_flags_set;
1497 u32 sta_modify_mask;
1498 int listen_interval;
1502 u8 supported_rates_len;
1505 const struct ieee80211_ht_cap *ht_capa;
1506 const struct ieee80211_vht_cap *vht_capa;
1509 enum nl80211_mesh_power_mode local_pm;
1511 const u8 *ext_capab;
1513 const u8 *supported_channels;
1514 u8 supported_channels_len;
1515 const u8 *supported_oper_classes;
1516 u8 supported_oper_classes_len;
1518 bool opmode_notif_used;
1520 const struct ieee80211_he_cap_elem *he_capa;
1523 struct sta_txpwr txpwr;
1524 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1525 const struct ieee80211_eht_cap_elem *eht_capa;
1530 * struct station_del_parameters - station deletion parameters
1532 * Used to delete a station entry (or all stations).
1534 * @mac: MAC address of the station to remove or NULL to remove all stations
1535 * @subtype: Management frame subtype to use for indicating removal
1536 * (10 = Disassociation, 12 = Deauthentication)
1537 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1539 struct station_del_parameters {
1546 * enum cfg80211_station_type - the type of station being modified
1547 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1548 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1549 * unassociated (update properties for this type of client is permitted)
1550 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1551 * the AP MLME in the device
1552 * @CFG80211_STA_AP_STA: AP station on managed interface
1553 * @CFG80211_STA_IBSS: IBSS station
1554 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1555 * while TDLS setup is in progress, it moves out of this state when
1556 * being marked authorized; use this only if TDLS with external setup is
1558 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1559 * entry that is operating, has been marked authorized by userspace)
1560 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1561 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1563 enum cfg80211_station_type {
1564 CFG80211_STA_AP_CLIENT,
1565 CFG80211_STA_AP_CLIENT_UNASSOC,
1566 CFG80211_STA_AP_MLME_CLIENT,
1567 CFG80211_STA_AP_STA,
1569 CFG80211_STA_TDLS_PEER_SETUP,
1570 CFG80211_STA_TDLS_PEER_ACTIVE,
1571 CFG80211_STA_MESH_PEER_KERNEL,
1572 CFG80211_STA_MESH_PEER_USER,
1576 * cfg80211_check_station_change - validate parameter changes
1577 * @wiphy: the wiphy this operates on
1578 * @params: the new parameters for a station
1579 * @statype: the type of station being modified
1581 * Utility function for the @change_station driver method. Call this function
1582 * with the appropriate station type looking up the station (and checking that
1583 * it exists). It will verify whether the station change is acceptable, and if
1584 * not will return an error code. Note that it may modify the parameters for
1585 * backward compatibility reasons, so don't use them before calling this.
1587 int cfg80211_check_station_change(struct wiphy *wiphy,
1588 struct station_parameters *params,
1589 enum cfg80211_station_type statype);
1592 * enum rate_info_flags - bitrate info flags
1594 * Used by the driver to indicate the specific rate transmission
1595 * type for 802.11n transmissions.
1597 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1598 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1599 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1600 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1601 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1602 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1603 * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS
1604 * @RATE_INFO_FLAGS_EHT_MCS: EHT MCS information
1606 enum rate_info_flags {
1607 RATE_INFO_FLAGS_MCS = BIT(0),
1608 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1609 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1610 RATE_INFO_FLAGS_DMG = BIT(3),
1611 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1612 RATE_INFO_FLAGS_EDMG = BIT(5),
1613 RATE_INFO_FLAGS_EXTENDED_SC_DMG = BIT(6),
1614 RATE_INFO_FLAGS_EHT_MCS = BIT(7),
1618 * enum rate_info_bw - rate bandwidth information
1620 * Used by the driver to indicate the rate bandwidth.
1622 * @RATE_INFO_BW_5: 5 MHz bandwidth
1623 * @RATE_INFO_BW_10: 10 MHz bandwidth
1624 * @RATE_INFO_BW_20: 20 MHz bandwidth
1625 * @RATE_INFO_BW_40: 40 MHz bandwidth
1626 * @RATE_INFO_BW_80: 80 MHz bandwidth
1627 * @RATE_INFO_BW_160: 160 MHz bandwidth
1628 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1629 * @RATE_INFO_BW_320: 320 MHz bandwidth
1630 * @RATE_INFO_BW_EHT_RU: bandwidth determined by EHT RU allocation
1633 RATE_INFO_BW_20 = 0,
1641 RATE_INFO_BW_EHT_RU,
1645 * struct rate_info - bitrate information
1647 * Information about a receiving or transmitting bitrate
1649 * @flags: bitflag of flags from &enum rate_info_flags
1650 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1651 * @legacy: bitrate in 100kbit/s for 802.11abg
1652 * @nss: number of streams (VHT & HE only)
1653 * @bw: bandwidth (from &enum rate_info_bw)
1654 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1655 * @he_dcm: HE DCM value
1656 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1657 * only valid if bw is %RATE_INFO_BW_HE_RU)
1658 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1659 * @eht_gi: EHT guard interval (from &enum nl80211_eht_gi)
1660 * @eht_ru_alloc: EHT RU allocation (from &enum nl80211_eht_ru_alloc,
1661 * only valid if bw is %RATE_INFO_BW_EHT_RU)
1678 * enum bss_param_flags - bitrate info flags
1680 * Used by the driver to indicate the specific rate transmission
1681 * type for 802.11n transmissions.
1683 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1684 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1685 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1687 enum bss_param_flags {
1688 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1689 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1690 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1694 * struct sta_bss_parameters - BSS parameters for the attached station
1696 * Information about the currently associated BSS
1698 * @flags: bitflag of flags from &enum bss_param_flags
1699 * @dtim_period: DTIM period for the BSS
1700 * @beacon_interval: beacon interval
1702 struct sta_bss_parameters {
1705 u16 beacon_interval;
1709 * struct cfg80211_txq_stats - TXQ statistics for this TID
1710 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1711 * indicate the relevant values in this struct are filled
1712 * @backlog_bytes: total number of bytes currently backlogged
1713 * @backlog_packets: total number of packets currently backlogged
1714 * @flows: number of new flows seen
1715 * @drops: total number of packets dropped
1716 * @ecn_marks: total number of packets marked with ECN CE
1717 * @overlimit: number of drops due to queue space overflow
1718 * @overmemory: number of drops due to memory limit overflow
1719 * @collisions: number of hash collisions
1720 * @tx_bytes: total number of bytes dequeued
1721 * @tx_packets: total number of packets dequeued
1722 * @max_flows: maximum number of flows supported
1724 struct cfg80211_txq_stats {
1727 u32 backlog_packets;
1740 * struct cfg80211_tid_stats - per-TID statistics
1741 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1742 * indicate the relevant values in this struct are filled
1743 * @rx_msdu: number of received MSDUs
1744 * @tx_msdu: number of (attempted) transmitted MSDUs
1745 * @tx_msdu_retries: number of retries (not counting the first) for
1747 * @tx_msdu_failed: number of failed transmitted MSDUs
1748 * @txq_stats: TXQ statistics
1750 struct cfg80211_tid_stats {
1754 u64 tx_msdu_retries;
1756 struct cfg80211_txq_stats txq_stats;
1759 #define IEEE80211_MAX_CHAINS 4
1762 * struct station_info - station information
1764 * Station information filled by driver for get_station() and dump_station.
1766 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1767 * indicate the relevant values in this struct for them
1768 * @connected_time: time(in secs) since a station is last connected
1769 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1770 * @assoc_at: bootime (ns) of the last association
1771 * @rx_bytes: bytes (size of MPDUs) received from this station
1772 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1773 * @llid: mesh local link id
1774 * @plid: mesh peer link id
1775 * @plink_state: mesh peer link state
1776 * @signal: The signal strength, type depends on the wiphy's signal_type.
1777 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1778 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1779 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1780 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1781 * @chain_signal: per-chain signal strength of last received packet in dBm
1782 * @chain_signal_avg: per-chain signal strength average in dBm
1783 * @txrate: current unicast bitrate from this station
1784 * @rxrate: current unicast bitrate to this station
1785 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1786 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1787 * @tx_retries: cumulative retry counts (MPDUs)
1788 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1789 * @rx_dropped_misc: Dropped for un-specified reason.
1790 * @bss_param: current BSS parameters
1791 * @generation: generation number for nl80211 dumps.
1792 * This number should increase every time the list of stations
1793 * changes, i.e. when a station is added or removed, so that
1794 * userspace can tell whether it got a consistent snapshot.
1795 * @assoc_req_ies: IEs from (Re)Association Request.
1796 * This is used only when in AP mode with drivers that do not use
1797 * user space MLME/SME implementation. The information is provided for
1798 * the cfg80211_new_sta() calls to notify user space of the IEs.
1799 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1800 * @sta_flags: station flags mask & values
1801 * @beacon_loss_count: Number of times beacon loss event has triggered.
1802 * @t_offset: Time offset of the station relative to this host.
1803 * @local_pm: local mesh STA power save mode
1804 * @peer_pm: peer mesh STA power save mode
1805 * @nonpeer_pm: non-peer mesh STA power save mode
1806 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1807 * towards this station.
1808 * @rx_beacon: number of beacons received from this peer
1809 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1811 * @connected_to_gate: true if mesh STA has a path to mesh gate
1812 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1813 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1814 * @airtime_weight: current airtime scheduling weight
1815 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1816 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1817 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1818 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1819 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1821 * @rx_mpdu_count: number of MPDUs received from this station
1822 * @fcs_err_count: number of packets (MPDUs) received from this station with
1823 * an FCS error. This counter should be incremented only when TA of the
1824 * received packet with an FCS error matches the peer MAC address.
1825 * @airtime_link_metric: mesh airtime link metric.
1826 * @connected_to_as: true if mesh STA has a path to authentication server
1828 struct station_info {
1842 s8 chain_signal[IEEE80211_MAX_CHAINS];
1843 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1845 struct rate_info txrate;
1846 struct rate_info rxrate;
1851 u32 rx_dropped_misc;
1852 struct sta_bss_parameters bss_param;
1853 struct nl80211_sta_flag_update sta_flags;
1857 const u8 *assoc_req_ies;
1858 size_t assoc_req_ies_len;
1860 u32 beacon_loss_count;
1862 enum nl80211_mesh_power_mode local_pm;
1863 enum nl80211_mesh_power_mode peer_pm;
1864 enum nl80211_mesh_power_mode nonpeer_pm;
1866 u32 expected_throughput;
1871 u8 rx_beacon_signal_avg;
1872 u8 connected_to_gate;
1874 struct cfg80211_tid_stats *pertid;
1883 u32 airtime_link_metric;
1889 * struct cfg80211_sar_sub_specs - sub specs limit
1890 * @power: power limitation in 0.25dbm
1891 * @freq_range_index: index the power limitation applies to
1893 struct cfg80211_sar_sub_specs {
1895 u32 freq_range_index;
1899 * struct cfg80211_sar_specs - sar limit specs
1900 * @type: it's set with power in 0.25dbm or other types
1901 * @num_sub_specs: number of sar sub specs
1902 * @sub_specs: memory to hold the sar sub specs
1904 struct cfg80211_sar_specs {
1905 enum nl80211_sar_type type;
1907 struct cfg80211_sar_sub_specs sub_specs[];
1912 * struct cfg80211_sar_freq_ranges - sar frequency ranges
1913 * @start_freq: start range edge frequency
1914 * @end_freq: end range edge frequency
1916 struct cfg80211_sar_freq_ranges {
1922 * struct cfg80211_sar_capa - sar limit capability
1923 * @type: it's set via power in 0.25dbm or other types
1924 * @num_freq_ranges: number of frequency ranges
1925 * @freq_ranges: memory to hold the freq ranges.
1927 * Note: WLAN driver may append new ranges or split an existing
1928 * range to small ones and then append them.
1930 struct cfg80211_sar_capa {
1931 enum nl80211_sar_type type;
1932 u32 num_freq_ranges;
1933 const struct cfg80211_sar_freq_ranges *freq_ranges;
1936 #if IS_ENABLED(CONFIG_CFG80211)
1938 * cfg80211_get_station - retrieve information about a given station
1939 * @dev: the device where the station is supposed to be connected to
1940 * @mac_addr: the mac address of the station of interest
1941 * @sinfo: pointer to the structure to fill with the information
1943 * Returns 0 on success and sinfo is filled with the available information
1944 * otherwise returns a negative error code and the content of sinfo has to be
1945 * considered undefined.
1947 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1948 struct station_info *sinfo);
1950 static inline int cfg80211_get_station(struct net_device *dev,
1952 struct station_info *sinfo)
1959 * enum monitor_flags - monitor flags
1961 * Monitor interface configuration flags. Note that these must be the bits
1962 * according to the nl80211 flags.
1964 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1965 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1966 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1967 * @MONITOR_FLAG_CONTROL: pass control frames
1968 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1969 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1970 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1972 enum monitor_flags {
1973 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1974 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1975 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1976 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1977 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1978 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1979 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1983 * enum mpath_info_flags - mesh path information flags
1985 * Used by the driver to indicate which info in &struct mpath_info it has filled
1986 * in during get_station() or dump_station().
1988 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1989 * @MPATH_INFO_SN: @sn filled
1990 * @MPATH_INFO_METRIC: @metric filled
1991 * @MPATH_INFO_EXPTIME: @exptime filled
1992 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1993 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1994 * @MPATH_INFO_FLAGS: @flags filled
1995 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1996 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1998 enum mpath_info_flags {
1999 MPATH_INFO_FRAME_QLEN = BIT(0),
2000 MPATH_INFO_SN = BIT(1),
2001 MPATH_INFO_METRIC = BIT(2),
2002 MPATH_INFO_EXPTIME = BIT(3),
2003 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
2004 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
2005 MPATH_INFO_FLAGS = BIT(6),
2006 MPATH_INFO_HOP_COUNT = BIT(7),
2007 MPATH_INFO_PATH_CHANGE = BIT(8),
2011 * struct mpath_info - mesh path information
2013 * Mesh path information filled by driver for get_mpath() and dump_mpath().
2015 * @filled: bitfield of flags from &enum mpath_info_flags
2016 * @frame_qlen: number of queued frames for this destination
2017 * @sn: target sequence number
2018 * @metric: metric (cost) of this mesh path
2019 * @exptime: expiration time for the mesh path from now, in msecs
2020 * @flags: mesh path flags
2021 * @discovery_timeout: total mesh path discovery timeout, in msecs
2022 * @discovery_retries: mesh path discovery retries
2023 * @generation: generation number for nl80211 dumps.
2024 * This number should increase every time the list of mesh paths
2025 * changes, i.e. when a station is added or removed, so that
2026 * userspace can tell whether it got a consistent snapshot.
2027 * @hop_count: hops to destination
2028 * @path_change_count: total number of path changes to destination
2036 u32 discovery_timeout;
2037 u8 discovery_retries;
2040 u32 path_change_count;
2046 * struct bss_parameters - BSS parameters
2048 * Used to change BSS parameters (mainly for AP mode).
2050 * @use_cts_prot: Whether to use CTS protection
2051 * (0 = no, 1 = yes, -1 = do not change)
2052 * @use_short_preamble: Whether the use of short preambles is allowed
2053 * (0 = no, 1 = yes, -1 = do not change)
2054 * @use_short_slot_time: Whether the use of short slot time is allowed
2055 * (0 = no, 1 = yes, -1 = do not change)
2056 * @basic_rates: basic rates in IEEE 802.11 format
2057 * (or NULL for no change)
2058 * @basic_rates_len: number of basic rates
2059 * @ap_isolate: do not forward packets between connected stations
2060 * (0 = no, 1 = yes, -1 = do not change)
2061 * @ht_opmode: HT Operation mode
2062 * (u16 = opmode, -1 = do not change)
2063 * @p2p_ctwindow: P2P CT Window (-1 = no change)
2064 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
2066 struct bss_parameters {
2068 int use_short_preamble;
2069 int use_short_slot_time;
2070 const u8 *basic_rates;
2074 s8 p2p_ctwindow, p2p_opp_ps;
2078 * struct mesh_config - 802.11s mesh configuration
2080 * These parameters can be changed while the mesh is active.
2082 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
2083 * by the Mesh Peering Open message
2084 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
2085 * used by the Mesh Peering Open message
2086 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
2087 * the mesh peering management to close a mesh peering
2088 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
2090 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
2091 * be sent to establish a new peer link instance in a mesh
2092 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
2093 * @element_ttl: the value of TTL field set at a mesh STA for path selection
2095 * @auto_open_plinks: whether we should automatically open peer links when we
2096 * detect compatible mesh peers
2097 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
2098 * synchronize to for 11s default synchronization method
2099 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
2100 * that an originator mesh STA can send to a particular path target
2101 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
2102 * @min_discovery_timeout: the minimum length of time to wait until giving up on
2103 * a path discovery in milliseconds
2104 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
2105 * receiving a PREQ shall consider the forwarding information from the
2106 * root to be valid. (TU = time unit)
2107 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
2108 * which a mesh STA can send only one action frame containing a PREQ
2110 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
2111 * which a mesh STA can send only one Action frame containing a PERR
2113 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
2114 * it takes for an HWMP information element to propagate across the mesh
2115 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
2116 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
2117 * announcements are transmitted
2118 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
2119 * station has access to a broader network beyond the MBSS. (This is
2120 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
2121 * only means that the station will announce others it's a mesh gate, but
2122 * not necessarily using the gate announcement protocol. Still keeping the
2123 * same nomenclature to be in sync with the spec)
2124 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
2125 * entity (default is TRUE - forwarding entity)
2126 * @rssi_threshold: the threshold for average signal strength of candidate
2127 * station to establish a peer link
2128 * @ht_opmode: mesh HT protection mode
2130 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
2131 * receiving a proactive PREQ shall consider the forwarding information to
2132 * the root mesh STA to be valid.
2134 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
2135 * PREQs are transmitted.
2136 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
2137 * during which a mesh STA can send only one Action frame containing
2138 * a PREQ element for root path confirmation.
2139 * @power_mode: The default mesh power save mode which will be the initial
2140 * setting for new peer links.
2141 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
2142 * after transmitting its beacon.
2143 * @plink_timeout: If no tx activity is seen from a STA we've established
2144 * peering with for longer than this time (in seconds), then remove it
2145 * from the STA's list of peers. Default is 30 minutes.
2146 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
2147 * connected to a mesh gate in mesh formation info. If false, the
2148 * value in mesh formation is determined by the presence of root paths
2149 * in the mesh path table
2150 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
2151 * for HWMP) if the destination is a direct neighbor. Note that this might
2152 * not be the optimal decision as a multi-hop route might be better. So
2153 * if using this setting you will likely also want to disable
2154 * dot11MeshForwarding and use another mesh routing protocol on top.
2156 struct mesh_config {
2157 u16 dot11MeshRetryTimeout;
2158 u16 dot11MeshConfirmTimeout;
2159 u16 dot11MeshHoldingTimeout;
2160 u16 dot11MeshMaxPeerLinks;
2161 u8 dot11MeshMaxRetries;
2164 bool auto_open_plinks;
2165 u32 dot11MeshNbrOffsetMaxNeighbor;
2166 u8 dot11MeshHWMPmaxPREQretries;
2167 u32 path_refresh_time;
2168 u16 min_discovery_timeout;
2169 u32 dot11MeshHWMPactivePathTimeout;
2170 u16 dot11MeshHWMPpreqMinInterval;
2171 u16 dot11MeshHWMPperrMinInterval;
2172 u16 dot11MeshHWMPnetDiameterTraversalTime;
2173 u8 dot11MeshHWMPRootMode;
2174 bool dot11MeshConnectedToMeshGate;
2175 bool dot11MeshConnectedToAuthServer;
2176 u16 dot11MeshHWMPRannInterval;
2177 bool dot11MeshGateAnnouncementProtocol;
2178 bool dot11MeshForwarding;
2181 u32 dot11MeshHWMPactivePathToRootTimeout;
2182 u16 dot11MeshHWMProotInterval;
2183 u16 dot11MeshHWMPconfirmationInterval;
2184 enum nl80211_mesh_power_mode power_mode;
2185 u16 dot11MeshAwakeWindowDuration;
2187 bool dot11MeshNolearn;
2191 * struct mesh_setup - 802.11s mesh setup configuration
2192 * @chandef: defines the channel to use
2193 * @mesh_id: the mesh ID
2194 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
2195 * @sync_method: which synchronization method to use
2196 * @path_sel_proto: which path selection protocol to use
2197 * @path_metric: which metric to use
2198 * @auth_id: which authentication method this mesh is using
2199 * @ie: vendor information elements (optional)
2200 * @ie_len: length of vendor information elements
2201 * @is_authenticated: this mesh requires authentication
2202 * @is_secure: this mesh uses security
2203 * @user_mpm: userspace handles all MPM functions
2204 * @dtim_period: DTIM period to use
2205 * @beacon_interval: beacon interval to use
2206 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2207 * @basic_rates: basic rates to use when creating the mesh
2208 * @beacon_rate: bitrate to be used for beacons
2209 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2210 * changes the channel when a radar is detected. This is required
2211 * to operate on DFS channels.
2212 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2213 * port frames over NL80211 instead of the network interface.
2215 * These parameters are fixed when the mesh is created.
2218 struct cfg80211_chan_def chandef;
2227 bool is_authenticated;
2231 u16 beacon_interval;
2232 int mcast_rate[NUM_NL80211_BANDS];
2234 struct cfg80211_bitrate_mask beacon_rate;
2235 bool userspace_handles_dfs;
2236 bool control_port_over_nl80211;
2240 * struct ocb_setup - 802.11p OCB mode setup configuration
2241 * @chandef: defines the channel to use
2243 * These parameters are fixed when connecting to the network
2246 struct cfg80211_chan_def chandef;
2250 * struct ieee80211_txq_params - TX queue parameters
2251 * @ac: AC identifier
2252 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2253 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2255 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2257 * @aifs: Arbitration interframe space [0..255]
2259 struct ieee80211_txq_params {
2268 * DOC: Scanning and BSS list handling
2270 * The scanning process itself is fairly simple, but cfg80211 offers quite
2271 * a bit of helper functionality. To start a scan, the scan operation will
2272 * be invoked with a scan definition. This scan definition contains the
2273 * channels to scan, and the SSIDs to send probe requests for (including the
2274 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2275 * probe. Additionally, a scan request may contain extra information elements
2276 * that should be added to the probe request. The IEs are guaranteed to be
2277 * well-formed, and will not exceed the maximum length the driver advertised
2278 * in the wiphy structure.
2280 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2281 * it is responsible for maintaining the BSS list; the driver should not
2282 * maintain a list itself. For this notification, various functions exist.
2284 * Since drivers do not maintain a BSS list, there are also a number of
2285 * functions to search for a BSS and obtain information about it from the
2286 * BSS structure cfg80211 maintains. The BSS list is also made available
2291 * struct cfg80211_ssid - SSID description
2293 * @ssid_len: length of the ssid
2295 struct cfg80211_ssid {
2296 u8 ssid[IEEE80211_MAX_SSID_LEN];
2301 * struct cfg80211_scan_info - information about completed scan
2302 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2303 * wireless device that requested the scan is connected to. If this
2304 * information is not available, this field is left zero.
2305 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2306 * @aborted: set to true if the scan was aborted for any reason,
2307 * userspace will be notified of that
2309 struct cfg80211_scan_info {
2311 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2316 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2318 * @short_bssid: short ssid to scan for
2319 * @bssid: bssid to scan for
2320 * @channel_idx: idx of the channel in the channel array in the scan request
2321 * which the above info relvant to
2322 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2323 * @short_ssid_valid: short_ssid is valid and can be used
2324 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2325 * 20 TUs before starting to send probe requests.
2327 struct cfg80211_scan_6ghz_params {
2331 bool unsolicited_probe;
2332 bool short_ssid_valid;
2337 * struct cfg80211_scan_request - scan request description
2339 * @ssids: SSIDs to scan for (active scan only)
2340 * @n_ssids: number of SSIDs
2341 * @channels: channels to scan on.
2342 * @n_channels: total number of channels to scan
2343 * @scan_width: channel width for scanning
2344 * @ie: optional information element(s) to add into Probe Request or %NULL
2345 * @ie_len: length of ie in octets
2346 * @duration: how long to listen on each channel, in TUs. If
2347 * %duration_mandatory is not set, this is the maximum dwell time and
2348 * the actual dwell time may be shorter.
2349 * @duration_mandatory: if set, the scan duration must be as specified by the
2351 * @flags: bit field of flags controlling operation
2352 * @rates: bitmap of rates to advertise for each band
2353 * @wiphy: the wiphy this was for
2354 * @scan_start: time (in jiffies) when the scan started
2355 * @wdev: the wireless device to scan for
2356 * @info: (internal) information about completed scan
2357 * @notified: (internal) scan request was notified as done or aborted
2358 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2359 * @mac_addr: MAC address used with randomisation
2360 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2361 * are 0 in the mask should be randomised, bits that are 1 should
2362 * be taken from the @mac_addr
2363 * @scan_6ghz: relevant for split scan request only,
2364 * true if this is the second scan request
2365 * @n_6ghz_params: number of 6 GHz params
2366 * @scan_6ghz_params: 6 GHz params
2367 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2369 struct cfg80211_scan_request {
2370 struct cfg80211_ssid *ssids;
2373 enum nl80211_bss_scan_width scan_width;
2377 bool duration_mandatory;
2380 u32 rates[NUM_NL80211_BANDS];
2382 struct wireless_dev *wdev;
2384 u8 mac_addr[ETH_ALEN] __aligned(2);
2385 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2386 u8 bssid[ETH_ALEN] __aligned(2);
2389 struct wiphy *wiphy;
2390 unsigned long scan_start;
2391 struct cfg80211_scan_info info;
2396 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2399 struct ieee80211_channel *channels[];
2402 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2406 get_random_bytes(buf, ETH_ALEN);
2407 for (i = 0; i < ETH_ALEN; i++) {
2409 buf[i] |= addr[i] & mask[i];
2414 * struct cfg80211_match_set - sets of attributes to match
2416 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2417 * or no match (RSSI only)
2418 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2419 * or no match (RSSI only)
2420 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2421 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2422 * for filtering out scan results received. Drivers advertize this support
2423 * of band specific rssi based filtering through the feature capability
2424 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2425 * specific rssi thresholds take precedence over rssi_thold, if specified.
2426 * If not specified for any band, it will be assigned with rssi_thold of
2427 * corresponding matchset.
2429 struct cfg80211_match_set {
2430 struct cfg80211_ssid ssid;
2433 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2437 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2439 * @interval: interval between scheduled scan iterations. In seconds.
2440 * @iterations: number of scan iterations in this scan plan. Zero means
2442 * The last scan plan will always have this parameter set to zero,
2443 * all other scan plans will have a finite number of iterations.
2445 struct cfg80211_sched_scan_plan {
2451 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2453 * @band: band of BSS which should match for RSSI level adjustment.
2454 * @delta: value of RSSI level adjustment.
2456 struct cfg80211_bss_select_adjust {
2457 enum nl80211_band band;
2462 * struct cfg80211_sched_scan_request - scheduled scan request description
2464 * @reqid: identifies this request.
2465 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2466 * @n_ssids: number of SSIDs
2467 * @n_channels: total number of channels to scan
2468 * @scan_width: channel width for scanning
2469 * @ie: optional information element(s) to add into Probe Request or %NULL
2470 * @ie_len: length of ie in octets
2471 * @flags: bit field of flags controlling operation
2472 * @match_sets: sets of parameters to be matched for a scan result
2473 * entry to be considered valid and to be passed to the host
2474 * (others are filtered out).
2475 * If ommited, all results are passed.
2476 * @n_match_sets: number of match sets
2477 * @report_results: indicates that results were reported for this request
2478 * @wiphy: the wiphy this was for
2479 * @dev: the interface
2480 * @scan_start: start time of the scheduled scan
2481 * @channels: channels to scan
2482 * @min_rssi_thold: for drivers only supporting a single threshold, this
2483 * contains the minimum over all matchsets
2484 * @mac_addr: MAC address used with randomisation
2485 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2486 * are 0 in the mask should be randomised, bits that are 1 should
2487 * be taken from the @mac_addr
2488 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2489 * index must be executed first.
2490 * @n_scan_plans: number of scan plans, at least 1.
2491 * @rcu_head: RCU callback used to free the struct
2492 * @owner_nlportid: netlink portid of owner (if this should is a request
2493 * owned by a particular socket)
2494 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2495 * @list: for keeping list of requests.
2496 * @delay: delay in seconds to use before starting the first scan
2497 * cycle. The driver may ignore this parameter and start
2498 * immediately (or at any other time), if this feature is not
2500 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2501 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2502 * reporting in connected state to cases where a matching BSS is determined
2503 * to have better or slightly worse RSSI than the current connected BSS.
2504 * The relative RSSI threshold values are ignored in disconnected state.
2505 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2506 * to the specified band while deciding whether a better BSS is reported
2507 * using @relative_rssi. If delta is a negative number, the BSSs that
2508 * belong to the specified band will be penalized by delta dB in relative
2511 struct cfg80211_sched_scan_request {
2513 struct cfg80211_ssid *ssids;
2516 enum nl80211_bss_scan_width scan_width;
2520 struct cfg80211_match_set *match_sets;
2524 struct cfg80211_sched_scan_plan *scan_plans;
2527 u8 mac_addr[ETH_ALEN] __aligned(2);
2528 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2530 bool relative_rssi_set;
2532 struct cfg80211_bss_select_adjust rssi_adjust;
2535 struct wiphy *wiphy;
2536 struct net_device *dev;
2537 unsigned long scan_start;
2538 bool report_results;
2539 struct rcu_head rcu_head;
2542 struct list_head list;
2545 struct ieee80211_channel *channels[];
2549 * enum cfg80211_signal_type - signal type
2551 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2552 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2553 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2555 enum cfg80211_signal_type {
2556 CFG80211_SIGNAL_TYPE_NONE,
2557 CFG80211_SIGNAL_TYPE_MBM,
2558 CFG80211_SIGNAL_TYPE_UNSPEC,
2562 * struct cfg80211_inform_bss - BSS inform data
2563 * @chan: channel the frame was received on
2564 * @scan_width: scan width that was used
2565 * @signal: signal strength value, according to the wiphy's
2567 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2568 * received; should match the time when the frame was actually
2569 * received by the device (not just by the host, in case it was
2570 * buffered on the device) and be accurate to about 10ms.
2571 * If the frame isn't buffered, just passing the return value of
2572 * ktime_get_boottime_ns() is likely appropriate.
2573 * @parent_tsf: the time at the start of reception of the first octet of the
2574 * timestamp field of the frame. The time is the TSF of the BSS specified
2576 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2577 * the BSS that requested the scan in which the beacon/probe was received.
2578 * @chains: bitmask for filled values in @chain_signal.
2579 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2581 struct cfg80211_inform_bss {
2582 struct ieee80211_channel *chan;
2583 enum nl80211_bss_scan_width scan_width;
2587 u8 parent_bssid[ETH_ALEN] __aligned(2);
2589 s8 chain_signal[IEEE80211_MAX_CHAINS];
2593 * struct cfg80211_bss_ies - BSS entry IE data
2594 * @tsf: TSF contained in the frame that carried these IEs
2595 * @rcu_head: internal use, for freeing
2596 * @len: length of the IEs
2597 * @from_beacon: these IEs are known to come from a beacon
2600 struct cfg80211_bss_ies {
2602 struct rcu_head rcu_head;
2609 * struct cfg80211_bss - BSS description
2611 * This structure describes a BSS (which may also be a mesh network)
2612 * for use in scan results and similar.
2614 * @channel: channel this BSS is on
2615 * @scan_width: width of the control channel
2616 * @bssid: BSSID of the BSS
2617 * @beacon_interval: the beacon interval as from the frame
2618 * @capability: the capability field in host byte order
2619 * @ies: the information elements (Note that there is no guarantee that these
2620 * are well-formed!); this is a pointer to either the beacon_ies or
2621 * proberesp_ies depending on whether Probe Response frame has been
2622 * received. It is always non-%NULL.
2623 * @beacon_ies: the information elements from the last Beacon frame
2624 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2625 * own the beacon_ies, but they're just pointers to the ones from the
2626 * @hidden_beacon_bss struct)
2627 * @proberesp_ies: the information elements from the last Probe Response frame
2628 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2629 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2630 * that holds the beacon data. @beacon_ies is still valid, of course, and
2631 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2632 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2633 * non-transmitted one (multi-BSSID support)
2634 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2635 * (multi-BSSID support)
2636 * @signal: signal strength value (type depends on the wiphy's signal_type)
2637 * @chains: bitmask for filled values in @chain_signal.
2638 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2639 * @bssid_index: index in the multiple BSS set
2640 * @max_bssid_indicator: max number of members in the BSS set
2641 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2643 struct cfg80211_bss {
2644 struct ieee80211_channel *channel;
2645 enum nl80211_bss_scan_width scan_width;
2647 const struct cfg80211_bss_ies __rcu *ies;
2648 const struct cfg80211_bss_ies __rcu *beacon_ies;
2649 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2651 struct cfg80211_bss *hidden_beacon_bss;
2652 struct cfg80211_bss *transmitted_bss;
2653 struct list_head nontrans_list;
2657 u16 beacon_interval;
2662 s8 chain_signal[IEEE80211_MAX_CHAINS];
2665 u8 max_bssid_indicator;
2667 u8 priv[] __aligned(sizeof(void *));
2671 * ieee80211_bss_get_elem - find element with given ID
2672 * @bss: the bss to search
2673 * @id: the element ID
2675 * Note that the return value is an RCU-protected pointer, so
2676 * rcu_read_lock() must be held when calling this function.
2677 * Return: %NULL if not found.
2679 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2682 * ieee80211_bss_get_ie - find IE with given ID
2683 * @bss: the bss to search
2684 * @id: the element ID
2686 * Note that the return value is an RCU-protected pointer, so
2687 * rcu_read_lock() must be held when calling this function.
2688 * Return: %NULL if not found.
2690 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2692 return (const void *)ieee80211_bss_get_elem(bss, id);
2697 * struct cfg80211_auth_request - Authentication request data
2699 * This structure provides information needed to complete IEEE 802.11
2702 * @bss: The BSS to authenticate with, the callee must obtain a reference
2703 * to it if it needs to keep it.
2704 * @auth_type: Authentication type (algorithm)
2705 * @ie: Extra IEs to add to Authentication frame or %NULL
2706 * @ie_len: Length of ie buffer in octets
2707 * @key_len: length of WEP key for shared key authentication
2708 * @key_idx: index of WEP key for shared key authentication
2709 * @key: WEP key for shared key authentication
2710 * @auth_data: Fields and elements in Authentication frames. This contains
2711 * the authentication frame body (non-IE and IE data), excluding the
2712 * Authentication algorithm number, i.e., starting at the Authentication
2713 * transaction sequence number field.
2714 * @auth_data_len: Length of auth_data buffer in octets
2716 struct cfg80211_auth_request {
2717 struct cfg80211_bss *bss;
2720 enum nl80211_auth_type auth_type;
2722 u8 key_len, key_idx;
2723 const u8 *auth_data;
2724 size_t auth_data_len;
2728 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2730 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2731 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2732 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2733 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2734 * authentication capability. Drivers can offload authentication to
2735 * userspace if this flag is set. Only applicable for cfg80211_connect()
2736 * request (connect callback).
2737 * @ASSOC_REQ_DISABLE_HE: Disable HE
2739 enum cfg80211_assoc_req_flags {
2740 ASSOC_REQ_DISABLE_HT = BIT(0),
2741 ASSOC_REQ_DISABLE_VHT = BIT(1),
2742 ASSOC_REQ_USE_RRM = BIT(2),
2743 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2744 ASSOC_REQ_DISABLE_HE = BIT(4),
2748 * struct cfg80211_assoc_request - (Re)Association request data
2750 * This structure provides information needed to complete IEEE 802.11
2752 * @bss: The BSS to associate with. If the call is successful the driver is
2753 * given a reference that it must give back to cfg80211_send_rx_assoc()
2754 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2755 * association requests while already associating must be rejected.
2756 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2757 * @ie_len: Length of ie buffer in octets
2758 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2759 * @crypto: crypto settings
2760 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2761 * to indicate a request to reassociate within the ESS instead of a request
2762 * do the initial association with the ESS. When included, this is set to
2763 * the BSSID of the current association, i.e., to the value that is
2764 * included in the Current AP address field of the Reassociation Request
2766 * @flags: See &enum cfg80211_assoc_req_flags
2767 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2768 * will be used in ht_capa. Un-supported values will be ignored.
2769 * @ht_capa_mask: The bits of ht_capa which are to be used.
2770 * @vht_capa: VHT capability override
2771 * @vht_capa_mask: VHT capability mask indicating which fields to use
2772 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2773 * %NULL if FILS is not used.
2774 * @fils_kek_len: Length of fils_kek in octets
2775 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2776 * Request/Response frame or %NULL if FILS is not used. This field starts
2777 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2778 * @s1g_capa: S1G capability override
2779 * @s1g_capa_mask: S1G capability override mask
2781 struct cfg80211_assoc_request {
2782 struct cfg80211_bss *bss;
2783 const u8 *ie, *prev_bssid;
2785 struct cfg80211_crypto_settings crypto;
2788 struct ieee80211_ht_cap ht_capa;
2789 struct ieee80211_ht_cap ht_capa_mask;
2790 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2792 size_t fils_kek_len;
2793 const u8 *fils_nonces;
2794 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2798 * struct cfg80211_deauth_request - Deauthentication request data
2800 * This structure provides information needed to complete IEEE 802.11
2803 * @bssid: the BSSID of the BSS to deauthenticate from
2804 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2805 * @ie_len: Length of ie buffer in octets
2806 * @reason_code: The reason code for the deauthentication
2807 * @local_state_change: if set, change local state only and
2808 * do not set a deauth frame
2810 struct cfg80211_deauth_request {
2815 bool local_state_change;
2819 * struct cfg80211_disassoc_request - Disassociation request data
2821 * This structure provides information needed to complete IEEE 802.11
2824 * @bss: the BSS to disassociate from
2825 * @ie: Extra IEs to add to Disassociation frame or %NULL
2826 * @ie_len: Length of ie buffer in octets
2827 * @reason_code: The reason code for the disassociation
2828 * @local_state_change: This is a request for a local state only, i.e., no
2829 * Disassociation frame is to be transmitted.
2831 struct cfg80211_disassoc_request {
2832 struct cfg80211_bss *bss;
2836 bool local_state_change;
2840 * struct cfg80211_ibss_params - IBSS parameters
2842 * This structure defines the IBSS parameters for the join_ibss()
2845 * @ssid: The SSID, will always be non-null.
2846 * @ssid_len: The length of the SSID, will always be non-zero.
2847 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2848 * search for IBSSs with a different BSSID.
2849 * @chandef: defines the channel to use if no other IBSS to join can be found
2850 * @channel_fixed: The channel should be fixed -- do not search for
2851 * IBSSs to join on other channels.
2852 * @ie: information element(s) to include in the beacon
2853 * @ie_len: length of that
2854 * @beacon_interval: beacon interval to use
2855 * @privacy: this is a protected network, keys will be configured
2857 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2858 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2859 * required to assume that the port is unauthorized until authorized by
2860 * user space. Otherwise, port is marked authorized by default.
2861 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2862 * port frames over NL80211 instead of the network interface.
2863 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2864 * changes the channel when a radar is detected. This is required
2865 * to operate on DFS channels.
2866 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2867 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2868 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2869 * will be used in ht_capa. Un-supported values will be ignored.
2870 * @ht_capa_mask: The bits of ht_capa which are to be used.
2871 * @wep_keys: static WEP keys, if not NULL points to an array of
2872 * CFG80211_MAX_WEP_KEYS WEP keys
2873 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2875 struct cfg80211_ibss_params {
2878 struct cfg80211_chan_def chandef;
2880 u8 ssid_len, ie_len;
2881 u16 beacon_interval;
2886 bool control_port_over_nl80211;
2887 bool userspace_handles_dfs;
2888 int mcast_rate[NUM_NL80211_BANDS];
2889 struct ieee80211_ht_cap ht_capa;
2890 struct ieee80211_ht_cap ht_capa_mask;
2891 struct key_params *wep_keys;
2896 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2898 * @behaviour: requested BSS selection behaviour.
2899 * @param: parameters for requestion behaviour.
2900 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2901 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2903 struct cfg80211_bss_selection {
2904 enum nl80211_bss_select_attr behaviour;
2906 enum nl80211_band band_pref;
2907 struct cfg80211_bss_select_adjust adjust;
2912 * struct cfg80211_connect_params - Connection parameters
2914 * This structure provides information needed to complete IEEE 802.11
2915 * authentication and association.
2917 * @channel: The channel to use or %NULL if not specified (auto-select based
2919 * @channel_hint: The channel of the recommended BSS for initial connection or
2920 * %NULL if not specified
2921 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2923 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2924 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2925 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2928 * @ssid_len: Length of ssid in octets
2929 * @auth_type: Authentication type (algorithm)
2930 * @ie: IEs for association request
2931 * @ie_len: Length of assoc_ie in octets
2932 * @privacy: indicates whether privacy-enabled APs should be used
2933 * @mfp: indicate whether management frame protection is used
2934 * @crypto: crypto settings
2935 * @key_len: length of WEP key for shared key authentication
2936 * @key_idx: index of WEP key for shared key authentication
2937 * @key: WEP key for shared key authentication
2938 * @flags: See &enum cfg80211_assoc_req_flags
2939 * @bg_scan_period: Background scan period in seconds
2940 * or -1 to indicate that default value is to be used.
2941 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2942 * will be used in ht_capa. Un-supported values will be ignored.
2943 * @ht_capa_mask: The bits of ht_capa which are to be used.
2944 * @vht_capa: VHT Capability overrides
2945 * @vht_capa_mask: The bits of vht_capa which are to be used.
2946 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2948 * @bss_select: criteria to be used for BSS selection.
2949 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2950 * to indicate a request to reassociate within the ESS instead of a request
2951 * do the initial association with the ESS. When included, this is set to
2952 * the BSSID of the current association, i.e., to the value that is
2953 * included in the Current AP address field of the Reassociation Request
2955 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2956 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2958 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2959 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2960 * %NULL if not specified. This specifies the domain name of ER server and
2961 * is used to construct FILS wrapped data IE.
2962 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2963 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2964 * messages. This is also used to construct FILS wrapped data IE.
2965 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2966 * keys in FILS or %NULL if not specified.
2967 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2968 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2969 * offload of 4-way handshake.
2970 * @edmg: define the EDMG channels.
2971 * This may specify multiple channels and bonding options for the driver
2972 * to choose from, based on BSS configuration.
2974 struct cfg80211_connect_params {
2975 struct ieee80211_channel *channel;
2976 struct ieee80211_channel *channel_hint;
2978 const u8 *bssid_hint;
2981 enum nl80211_auth_type auth_type;
2985 enum nl80211_mfp mfp;
2986 struct cfg80211_crypto_settings crypto;
2988 u8 key_len, key_idx;
2991 struct ieee80211_ht_cap ht_capa;
2992 struct ieee80211_ht_cap ht_capa_mask;
2993 struct ieee80211_vht_cap vht_capa;
2994 struct ieee80211_vht_cap vht_capa_mask;
2996 struct cfg80211_bss_selection bss_select;
2997 const u8 *prev_bssid;
2998 const u8 *fils_erp_username;
2999 size_t fils_erp_username_len;
3000 const u8 *fils_erp_realm;
3001 size_t fils_erp_realm_len;
3002 u16 fils_erp_next_seq_num;
3003 const u8 *fils_erp_rrk;
3004 size_t fils_erp_rrk_len;
3006 struct ieee80211_edmg edmg;
3010 * enum cfg80211_connect_params_changed - Connection parameters being updated
3012 * This enum provides information of all connect parameters that
3013 * have to be updated as part of update_connect_params() call.
3015 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
3016 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
3017 * username, erp sequence number and rrk) are updated
3018 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
3020 enum cfg80211_connect_params_changed {
3021 UPDATE_ASSOC_IES = BIT(0),
3022 UPDATE_FILS_ERP_INFO = BIT(1),
3023 UPDATE_AUTH_TYPE = BIT(2),
3027 * enum wiphy_params_flags - set_wiphy_params bitfield values
3028 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
3029 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
3030 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
3031 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
3032 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
3033 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
3034 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
3035 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
3036 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
3038 enum wiphy_params_flags {
3039 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
3040 WIPHY_PARAM_RETRY_LONG = 1 << 1,
3041 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
3042 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
3043 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
3044 WIPHY_PARAM_DYN_ACK = 1 << 5,
3045 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
3046 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
3047 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
3050 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
3052 /* The per TXQ device queue limit in airtime */
3053 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
3054 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
3056 /* The per interface airtime threshold to switch to lower queue limit */
3057 #define IEEE80211_AQL_THRESHOLD 24000
3060 * struct cfg80211_pmksa - PMK Security Association
3062 * This structure is passed to the set/del_pmksa() method for PMKSA
3065 * @bssid: The AP's BSSID (may be %NULL).
3066 * @pmkid: The identifier to refer a PMKSA.
3067 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
3068 * derivation by a FILS STA. Otherwise, %NULL.
3069 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
3070 * the hash algorithm used to generate this.
3071 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
3072 * cache identifier (may be %NULL).
3073 * @ssid_len: Length of the @ssid in octets.
3074 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
3075 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
3077 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
3078 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
3079 * The configured PMKSA must not be used for PMKSA caching after
3080 * expiration and any keys derived from this PMK become invalid on
3081 * expiration, i.e., the current association must be dropped if the PMK
3082 * used for it expires.
3083 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
3084 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
3085 * Drivers are expected to trigger a full authentication instead of using
3086 * this PMKSA for caching when reassociating to a new BSS after this
3087 * threshold to generate a new PMK before the current one expires.
3089 struct cfg80211_pmksa {
3098 u8 pmk_reauth_threshold;
3102 * struct cfg80211_pkt_pattern - packet pattern
3103 * @mask: bitmask where to match pattern and where to ignore bytes,
3104 * one bit per byte, in same format as nl80211
3105 * @pattern: bytes to match where bitmask is 1
3106 * @pattern_len: length of pattern (in bytes)
3107 * @pkt_offset: packet offset (in bytes)
3109 * Internal note: @mask and @pattern are allocated in one chunk of
3110 * memory, free @mask only!
3112 struct cfg80211_pkt_pattern {
3113 const u8 *mask, *pattern;
3119 * struct cfg80211_wowlan_tcp - TCP connection parameters
3121 * @sock: (internal) socket for source port allocation
3122 * @src: source IP address
3123 * @dst: destination IP address
3124 * @dst_mac: destination MAC address
3125 * @src_port: source port
3126 * @dst_port: destination port
3127 * @payload_len: data payload length
3128 * @payload: data payload buffer
3129 * @payload_seq: payload sequence stamping configuration
3130 * @data_interval: interval at which to send data packets
3131 * @wake_len: wakeup payload match length
3132 * @wake_data: wakeup payload match data
3133 * @wake_mask: wakeup payload match mask
3134 * @tokens_size: length of the tokens buffer
3135 * @payload_tok: payload token usage configuration
3137 struct cfg80211_wowlan_tcp {
3138 struct socket *sock;
3140 u16 src_port, dst_port;
3141 u8 dst_mac[ETH_ALEN];
3144 struct nl80211_wowlan_tcp_data_seq payload_seq;
3147 const u8 *wake_data, *wake_mask;
3149 /* must be last, variable member */
3150 struct nl80211_wowlan_tcp_data_token payload_tok;
3154 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3156 * This structure defines the enabled WoWLAN triggers for the device.
3157 * @any: wake up on any activity -- special trigger if device continues
3158 * operating as normal during suspend
3159 * @disconnect: wake up if getting disconnected
3160 * @magic_pkt: wake up on receiving magic packet
3161 * @patterns: wake up on receiving packet matching a pattern
3162 * @n_patterns: number of patterns
3163 * @gtk_rekey_failure: wake up on GTK rekey failure
3164 * @eap_identity_req: wake up on EAP identity request packet
3165 * @four_way_handshake: wake up on 4-way handshake
3166 * @rfkill_release: wake up when rfkill is released
3167 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3168 * NULL if not configured.
3169 * @nd_config: configuration for the scan to be used for net detect wake.
3171 struct cfg80211_wowlan {
3172 bool any, disconnect, magic_pkt, gtk_rekey_failure,
3173 eap_identity_req, four_way_handshake,
3175 struct cfg80211_pkt_pattern *patterns;
3176 struct cfg80211_wowlan_tcp *tcp;
3178 struct cfg80211_sched_scan_request *nd_config;
3182 * struct cfg80211_coalesce_rules - Coalesce rule parameters
3184 * This structure defines coalesce rule for the device.
3185 * @delay: maximum coalescing delay in msecs.
3186 * @condition: condition for packet coalescence.
3187 * see &enum nl80211_coalesce_condition.
3188 * @patterns: array of packet patterns
3189 * @n_patterns: number of patterns
3191 struct cfg80211_coalesce_rules {
3193 enum nl80211_coalesce_condition condition;
3194 struct cfg80211_pkt_pattern *patterns;
3199 * struct cfg80211_coalesce - Packet coalescing settings
3201 * This structure defines coalescing settings.
3202 * @rules: array of coalesce rules
3203 * @n_rules: number of rules
3205 struct cfg80211_coalesce {
3206 struct cfg80211_coalesce_rules *rules;
3211 * struct cfg80211_wowlan_nd_match - information about the match
3213 * @ssid: SSID of the match that triggered the wake up
3214 * @n_channels: Number of channels where the match occurred. This
3215 * value may be zero if the driver can't report the channels.
3216 * @channels: center frequencies of the channels where a match
3219 struct cfg80211_wowlan_nd_match {
3220 struct cfg80211_ssid ssid;
3226 * struct cfg80211_wowlan_nd_info - net detect wake up information
3228 * @n_matches: Number of match information instances provided in
3229 * @matches. This value may be zero if the driver can't provide
3230 * match information.
3231 * @matches: Array of pointers to matches containing information about
3232 * the matches that triggered the wake up.
3234 struct cfg80211_wowlan_nd_info {
3236 struct cfg80211_wowlan_nd_match *matches[];
3240 * struct cfg80211_wowlan_wakeup - wakeup report
3241 * @disconnect: woke up by getting disconnected
3242 * @magic_pkt: woke up by receiving magic packet
3243 * @gtk_rekey_failure: woke up by GTK rekey failure
3244 * @eap_identity_req: woke up by EAP identity request packet
3245 * @four_way_handshake: woke up by 4-way handshake
3246 * @rfkill_release: woke up by rfkill being released
3247 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3248 * @packet_present_len: copied wakeup packet data
3249 * @packet_len: original wakeup packet length
3250 * @packet: The packet causing the wakeup, if any.
3251 * @packet_80211: For pattern match, magic packet and other data
3252 * frame triggers an 802.3 frame should be reported, for
3253 * disconnect due to deauth 802.11 frame. This indicates which
3255 * @tcp_match: TCP wakeup packet received
3256 * @tcp_connlost: TCP connection lost or failed to establish
3257 * @tcp_nomoretokens: TCP data ran out of tokens
3258 * @net_detect: if not %NULL, woke up because of net detect
3260 struct cfg80211_wowlan_wakeup {
3261 bool disconnect, magic_pkt, gtk_rekey_failure,
3262 eap_identity_req, four_way_handshake,
3263 rfkill_release, packet_80211,
3264 tcp_match, tcp_connlost, tcp_nomoretokens;
3266 u32 packet_present_len, packet_len;
3268 struct cfg80211_wowlan_nd_info *net_detect;
3272 * struct cfg80211_gtk_rekey_data - rekey data
3273 * @kek: key encryption key (@kek_len bytes)
3274 * @kck: key confirmation key (@kck_len bytes)
3275 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3276 * @kek_len: length of kek
3277 * @kck_len length of kck
3278 * @akm: akm (oui, id)
3280 struct cfg80211_gtk_rekey_data {
3281 const u8 *kek, *kck, *replay_ctr;
3283 u8 kek_len, kck_len;
3287 * struct cfg80211_update_ft_ies_params - FT IE Information
3289 * This structure provides information needed to update the fast transition IE
3291 * @md: The Mobility Domain ID, 2 Octet value
3292 * @ie: Fast Transition IEs
3293 * @ie_len: Length of ft_ie in octets
3295 struct cfg80211_update_ft_ies_params {
3302 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3304 * This structure provides information needed to transmit a mgmt frame
3306 * @chan: channel to use
3307 * @offchan: indicates wether off channel operation is required
3308 * @wait: duration for ROC
3309 * @buf: buffer to transmit
3310 * @len: buffer length
3311 * @no_cck: don't use cck rates for this frame
3312 * @dont_wait_for_ack: tells the low level not to wait for an ack
3313 * @n_csa_offsets: length of csa_offsets array
3314 * @csa_offsets: array of all the csa offsets in the frame
3316 struct cfg80211_mgmt_tx_params {
3317 struct ieee80211_channel *chan;
3323 bool dont_wait_for_ack;
3325 const u16 *csa_offsets;
3329 * struct cfg80211_dscp_exception - DSCP exception
3331 * @dscp: DSCP value that does not adhere to the user priority range definition
3332 * @up: user priority value to which the corresponding DSCP value belongs
3334 struct cfg80211_dscp_exception {
3340 * struct cfg80211_dscp_range - DSCP range definition for user priority
3342 * @low: lowest DSCP value of this user priority range, inclusive
3343 * @high: highest DSCP value of this user priority range, inclusive
3345 struct cfg80211_dscp_range {
3350 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3351 #define IEEE80211_QOS_MAP_MAX_EX 21
3352 #define IEEE80211_QOS_MAP_LEN_MIN 16
3353 #define IEEE80211_QOS_MAP_LEN_MAX \
3354 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3357 * struct cfg80211_qos_map - QoS Map Information
3359 * This struct defines the Interworking QoS map setting for DSCP values
3361 * @num_des: number of DSCP exceptions (0..21)
3362 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3363 * the user priority DSCP range definition
3364 * @up: DSCP range definition for a particular user priority
3366 struct cfg80211_qos_map {
3368 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3369 struct cfg80211_dscp_range up[8];
3373 * struct cfg80211_nan_conf - NAN configuration
3375 * This struct defines NAN configuration parameters
3377 * @master_pref: master preference (1 - 255)
3378 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3379 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3380 * (i.e. BIT(NL80211_BAND_2GHZ)).
3382 struct cfg80211_nan_conf {
3388 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3391 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3392 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3394 enum cfg80211_nan_conf_changes {
3395 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3396 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3400 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3402 * @filter: the content of the filter
3403 * @len: the length of the filter
3405 struct cfg80211_nan_func_filter {
3411 * struct cfg80211_nan_func - a NAN function
3413 * @type: &enum nl80211_nan_function_type
3414 * @service_id: the service ID of the function
3415 * @publish_type: &nl80211_nan_publish_type
3416 * @close_range: if true, the range should be limited. Threshold is
3417 * implementation specific.
3418 * @publish_bcast: if true, the solicited publish should be broadcasted
3419 * @subscribe_active: if true, the subscribe is active
3420 * @followup_id: the instance ID for follow up
3421 * @followup_reqid: the requestor instance ID for follow up
3422 * @followup_dest: MAC address of the recipient of the follow up
3423 * @ttl: time to live counter in DW.
3424 * @serv_spec_info: Service Specific Info
3425 * @serv_spec_info_len: Service Specific Info length
3426 * @srf_include: if true, SRF is inclusive
3427 * @srf_bf: Bloom Filter
3428 * @srf_bf_len: Bloom Filter length
3429 * @srf_bf_idx: Bloom Filter index
3430 * @srf_macs: SRF MAC addresses
3431 * @srf_num_macs: number of MAC addresses in SRF
3432 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3433 * @tx_filters: filters that should be transmitted in the SDF.
3434 * @num_rx_filters: length of &rx_filters.
3435 * @num_tx_filters: length of &tx_filters.
3436 * @instance_id: driver allocated id of the function.
3437 * @cookie: unique NAN function identifier.
3439 struct cfg80211_nan_func {
3440 enum nl80211_nan_function_type type;
3441 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3445 bool subscribe_active;
3448 struct mac_address followup_dest;
3450 const u8 *serv_spec_info;
3451 u8 serv_spec_info_len;
3456 struct mac_address *srf_macs;
3458 struct cfg80211_nan_func_filter *rx_filters;
3459 struct cfg80211_nan_func_filter *tx_filters;
3467 * struct cfg80211_pmk_conf - PMK configuration
3469 * @aa: authenticator address
3470 * @pmk_len: PMK length in bytes.
3471 * @pmk: the PMK material
3472 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3473 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3476 struct cfg80211_pmk_conf {
3480 const u8 *pmk_r0_name;
3484 * struct cfg80211_external_auth_params - Trigger External authentication.
3486 * Commonly used across the external auth request and event interfaces.
3488 * @action: action type / trigger for external authentication. Only significant
3489 * for the authentication request event interface (driver to user space).
3490 * @bssid: BSSID of the peer with which the authentication has
3491 * to happen. Used by both the authentication request event and
3492 * authentication response command interface.
3493 * @ssid: SSID of the AP. Used by both the authentication request event and
3494 * authentication response command interface.
3495 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3496 * authentication request event interface.
3497 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3498 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3499 * the real status code for failures. Used only for the authentication
3500 * response command interface (user space to driver).
3501 * @pmkid: The identifier to refer a PMKSA.
3503 struct cfg80211_external_auth_params {
3504 enum nl80211_external_auth_action action;
3505 u8 bssid[ETH_ALEN] __aligned(2);
3506 struct cfg80211_ssid ssid;
3507 unsigned int key_mgmt_suite;
3513 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3515 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3516 * indicate the relevant values in this struct for them
3517 * @success_num: number of FTM sessions in which all frames were successfully
3519 * @partial_num: number of FTM sessions in which part of frames were
3520 * successfully answered
3521 * @failed_num: number of failed FTM sessions
3522 * @asap_num: number of ASAP FTM sessions
3523 * @non_asap_num: number of non-ASAP FTM sessions
3524 * @total_duration_ms: total sessions durations - gives an indication
3525 * of how much time the responder was busy
3526 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3527 * initiators that didn't finish successfully the negotiation phase with
3529 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3530 * for a new scheduling although it already has scheduled FTM slot
3531 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3533 struct cfg80211_ftm_responder_stats {
3540 u64 total_duration_ms;
3541 u32 unknown_triggers_num;
3542 u32 reschedule_requests_num;
3543 u32 out_of_window_triggers_num;
3547 * struct cfg80211_pmsr_ftm_result - FTM result
3548 * @failure_reason: if this measurement failed (PMSR status is
3549 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3550 * reason than just "failure"
3551 * @burst_index: if reporting partial results, this is the index
3552 * in [0 .. num_bursts-1] of the burst that's being reported
3553 * @num_ftmr_attempts: number of FTM request frames transmitted
3554 * @num_ftmr_successes: number of FTM request frames acked
3555 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3556 * fill this to indicate in how many seconds a retry is deemed possible
3558 * @num_bursts_exp: actual number of bursts exponent negotiated
3559 * @burst_duration: actual burst duration negotiated
3560 * @ftms_per_burst: actual FTMs per burst negotiated
3561 * @lci_len: length of LCI information (if present)
3562 * @civicloc_len: length of civic location information (if present)
3563 * @lci: LCI data (may be %NULL)
3564 * @civicloc: civic location data (may be %NULL)
3565 * @rssi_avg: average RSSI over FTM action frames reported
3566 * @rssi_spread: spread of the RSSI over FTM action frames reported
3567 * @tx_rate: bitrate for transmitted FTM action frame response
3568 * @rx_rate: bitrate of received FTM action frame
3569 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3570 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3571 * the square root of the variance)
3572 * @rtt_spread: spread of the RTTs measured
3573 * @dist_avg: average of distances (mm) measured
3574 * (must have either this or @rtt_avg)
3575 * @dist_variance: variance of distances measured (see also @rtt_variance)
3576 * @dist_spread: spread of distances measured (see also @rtt_spread)
3577 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3578 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3579 * @rssi_avg_valid: @rssi_avg is valid
3580 * @rssi_spread_valid: @rssi_spread is valid
3581 * @tx_rate_valid: @tx_rate is valid
3582 * @rx_rate_valid: @rx_rate is valid
3583 * @rtt_avg_valid: @rtt_avg is valid
3584 * @rtt_variance_valid: @rtt_variance is valid
3585 * @rtt_spread_valid: @rtt_spread is valid
3586 * @dist_avg_valid: @dist_avg is valid
3587 * @dist_variance_valid: @dist_variance is valid
3588 * @dist_spread_valid: @dist_spread is valid
3590 struct cfg80211_pmsr_ftm_result {
3593 unsigned int lci_len;
3594 unsigned int civicloc_len;
3595 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3596 u32 num_ftmr_attempts, num_ftmr_successes;
3604 struct rate_info tx_rate, rx_rate;
3612 u16 num_ftmr_attempts_valid:1,
3613 num_ftmr_successes_valid:1,
3615 rssi_spread_valid:1,
3619 rtt_variance_valid:1,
3622 dist_variance_valid:1,
3623 dist_spread_valid:1;
3627 * struct cfg80211_pmsr_result - peer measurement result
3628 * @addr: address of the peer
3629 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3630 * measurement was made)
3631 * @ap_tsf: AP's TSF at measurement time
3632 * @status: status of the measurement
3633 * @final: if reporting partial results, mark this as the last one; if not
3634 * reporting partial results always set this flag
3635 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3636 * @type: type of the measurement reported, note that we only support reporting
3637 * one type at a time, but you can report multiple results separately and
3638 * they're all aggregated for userspace.
3640 struct cfg80211_pmsr_result {
3641 u64 host_time, ap_tsf;
3642 enum nl80211_peer_measurement_status status;
3649 enum nl80211_peer_measurement_type type;
3652 struct cfg80211_pmsr_ftm_result ftm;
3657 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3658 * @requested: indicates FTM is requested
3659 * @preamble: frame preamble to use
3660 * @burst_period: burst period to use
3661 * @asap: indicates to use ASAP mode
3662 * @num_bursts_exp: number of bursts exponent
3663 * @burst_duration: burst duration
3664 * @ftms_per_burst: number of FTMs per burst
3665 * @ftmr_retries: number of retries for FTM request
3666 * @request_lci: request LCI information
3667 * @request_civicloc: request civic location information
3668 * @trigger_based: use trigger based ranging for the measurement
3669 * If neither @trigger_based nor @non_trigger_based is set,
3670 * EDCA based ranging will be used.
3671 * @non_trigger_based: use non trigger based ranging for the measurement
3672 * If neither @trigger_based nor @non_trigger_based is set,
3673 * EDCA based ranging will be used.
3674 * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
3675 * @trigger_based or @non_trigger_based is set.
3676 * @bss_color: the bss color of the responder. Optional. Set to zero to
3677 * indicate the driver should set the BSS color. Only valid if
3678 * @non_trigger_based or @trigger_based is set.
3680 * See also nl80211 for the respective attribute documentation.
3682 struct cfg80211_pmsr_ftm_request_peer {
3683 enum nl80211_preamble preamble;
3690 non_trigger_based:1,
3700 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3701 * @addr: MAC address
3702 * @chandef: channel to use
3703 * @report_ap_tsf: report the associated AP's TSF
3704 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3706 struct cfg80211_pmsr_request_peer {
3708 struct cfg80211_chan_def chandef;
3710 struct cfg80211_pmsr_ftm_request_peer ftm;
3714 * struct cfg80211_pmsr_request - peer measurement request
3715 * @cookie: cookie, set by cfg80211
3716 * @nl_portid: netlink portid - used by cfg80211
3717 * @drv_data: driver data for this request, if required for aborting,
3718 * not otherwise freed or anything by cfg80211
3719 * @mac_addr: MAC address used for (randomised) request
3720 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3721 * are 0 in the mask should be randomised, bits that are 1 should
3722 * be taken from the @mac_addr
3723 * @list: used by cfg80211 to hold on to the request
3724 * @timeout: timeout (in milliseconds) for the whole operation, if
3725 * zero it means there's no timeout
3726 * @n_peers: number of peers to do measurements with
3727 * @peers: per-peer measurement request data
3729 struct cfg80211_pmsr_request {
3737 u8 mac_addr[ETH_ALEN] __aligned(2);
3738 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3740 struct list_head list;
3742 struct cfg80211_pmsr_request_peer peers[];
3746 * struct cfg80211_update_owe_info - OWE Information
3748 * This structure provides information needed for the drivers to offload OWE
3749 * (Opportunistic Wireless Encryption) processing to the user space.
3751 * Commonly used across update_owe_info request and event interfaces.
3753 * @peer: MAC address of the peer device for which the OWE processing
3755 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3756 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3757 * cannot give you the real status code for failures. Used only for
3758 * OWE update request command interface (user space to driver).
3759 * @ie: IEs obtained from the peer or constructed by the user space. These are
3760 * the IEs of the remote peer in the event from the host driver and
3761 * the constructed IEs by the user space in the request interface.
3762 * @ie_len: Length of IEs in octets.
3764 struct cfg80211_update_owe_info {
3765 u8 peer[ETH_ALEN] __aligned(2);
3772 * struct mgmt_frame_regs - management frame registrations data
3773 * @global_stypes: bitmap of management frame subtypes registered
3774 * for the entire device
3775 * @interface_stypes: bitmap of management frame subtypes registered
3776 * for the given interface
3777 * @global_mcast_rx: mcast RX is needed globally for these subtypes
3778 * @interface_mcast_stypes: mcast RX is needed on this interface
3779 * for these subtypes
3781 struct mgmt_frame_regs {
3782 u32 global_stypes, interface_stypes;
3783 u32 global_mcast_stypes, interface_mcast_stypes;
3787 * struct cfg80211_ops - backend description for wireless configuration
3789 * This struct is registered by fullmac card drivers and/or wireless stacks
3790 * in order to handle configuration requests on their interfaces.
3792 * All callbacks except where otherwise noted should return 0
3793 * on success or a negative error code.
3795 * All operations are invoked with the wiphy mutex held. The RTNL may be
3796 * held in addition (due to wireless extensions) but this cannot be relied
3797 * upon except in cases where documented below. Note that due to ordering,
3798 * the RTNL also cannot be acquired in any handlers.
3800 * @suspend: wiphy device needs to be suspended. The variable @wow will
3801 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3802 * configured for the device.
3803 * @resume: wiphy device needs to be resumed
3804 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3805 * to call device_set_wakeup_enable() to enable/disable wakeup from
3808 * @add_virtual_intf: create a new virtual interface with the given name,
3809 * must set the struct wireless_dev's iftype. Beware: You must create
3810 * the new netdev in the wiphy's network namespace! Returns the struct
3811 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3812 * also set the address member in the wdev.
3813 * This additionally holds the RTNL to be able to do netdev changes.
3815 * @del_virtual_intf: remove the virtual interface
3816 * This additionally holds the RTNL to be able to do netdev changes.
3818 * @change_virtual_intf: change type/configuration of virtual interface,
3819 * keep the struct wireless_dev's iftype updated.
3820 * This additionally holds the RTNL to be able to do netdev changes.
3822 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3823 * when adding a group key.
3825 * @get_key: get information about the key with the given parameters.
3826 * @mac_addr will be %NULL when requesting information for a group
3827 * key. All pointers given to the @callback function need not be valid
3828 * after it returns. This function should return an error if it is
3829 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3831 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3832 * and @key_index, return -ENOENT if the key doesn't exist.
3834 * @set_default_key: set the default key on an interface
3836 * @set_default_mgmt_key: set the default management frame key on an interface
3838 * @set_default_beacon_key: set the default Beacon frame key on an interface
3840 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3842 * @start_ap: Start acting in AP mode defined by the parameters.
3843 * @change_beacon: Change the beacon parameters for an access point mode
3844 * interface. This should reject the call when AP mode wasn't started.
3845 * @stop_ap: Stop being an AP, including stopping beaconing.
3847 * @add_station: Add a new station.
3848 * @del_station: Remove a station
3849 * @change_station: Modify a given station. Note that flags changes are not much
3850 * validated in cfg80211, in particular the auth/assoc/authorized flags
3851 * might come to the driver in invalid combinations -- make sure to check
3852 * them, also against the existing state! Drivers must call
3853 * cfg80211_check_station_change() to validate the information.
3854 * @get_station: get station information for the station identified by @mac
3855 * @dump_station: dump station callback -- resume dump at index @idx
3857 * @add_mpath: add a fixed mesh path
3858 * @del_mpath: delete a given mesh path
3859 * @change_mpath: change a given mesh path
3860 * @get_mpath: get a mesh path for the given parameters
3861 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3862 * @get_mpp: get a mesh proxy path for the given parameters
3863 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3864 * @join_mesh: join the mesh network with the specified parameters
3865 * (invoked with the wireless_dev mutex held)
3866 * @leave_mesh: leave the current mesh network
3867 * (invoked with the wireless_dev mutex held)
3869 * @get_mesh_config: Get the current mesh configuration
3871 * @update_mesh_config: Update mesh parameters on a running mesh.
3872 * The mask is a bitfield which tells us which parameters to
3873 * set, and which to leave alone.
3875 * @change_bss: Modify parameters for a given BSS.
3877 * @set_txq_params: Set TX queue parameters
3879 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3880 * as it doesn't implement join_mesh and needs to set the channel to
3881 * join the mesh instead.
3883 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3884 * interfaces are active this callback should reject the configuration.
3885 * If no interfaces are active or the device is down, the channel should
3886 * be stored for when a monitor interface becomes active.
3888 * @scan: Request to do a scan. If returning zero, the scan request is given
3889 * the driver, and will be valid until passed to cfg80211_scan_done().
3890 * For scan results, call cfg80211_inform_bss(); you can call this outside
3891 * the scan/scan_done bracket too.
3892 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3893 * indicate the status of the scan through cfg80211_scan_done().
3895 * @auth: Request to authenticate with the specified peer
3896 * (invoked with the wireless_dev mutex held)
3897 * @assoc: Request to (re)associate with the specified peer
3898 * (invoked with the wireless_dev mutex held)
3899 * @deauth: Request to deauthenticate from the specified peer
3900 * (invoked with the wireless_dev mutex held)
3901 * @disassoc: Request to disassociate from the specified peer
3902 * (invoked with the wireless_dev mutex held)
3904 * @connect: Connect to the ESS with the specified parameters. When connected,
3905 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3906 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3907 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3908 * from the AP or cfg80211_connect_timeout() if no frame with status code
3910 * The driver is allowed to roam to other BSSes within the ESS when the
3911 * other BSS matches the connect parameters. When such roaming is initiated
3912 * by the driver, the driver is expected to verify that the target matches
3913 * the configured security parameters and to use Reassociation Request
3914 * frame instead of Association Request frame.
3915 * The connect function can also be used to request the driver to perform a
3916 * specific roam when connected to an ESS. In that case, the prev_bssid
3917 * parameter is set to the BSSID of the currently associated BSS as an
3918 * indication of requesting reassociation.
3919 * In both the driver-initiated and new connect() call initiated roaming
3920 * cases, the result of roaming is indicated with a call to
3921 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3922 * @update_connect_params: Update the connect parameters while connected to a
3923 * BSS. The updated parameters can be used by driver/firmware for
3924 * subsequent BSS selection (roaming) decisions and to form the
3925 * Authentication/(Re)Association Request frames. This call does not
3926 * request an immediate disassociation or reassociation with the current
3927 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3928 * changed are defined in &enum cfg80211_connect_params_changed.
3929 * (invoked with the wireless_dev mutex held)
3930 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3931 * connection is in progress. Once done, call cfg80211_disconnected() in
3932 * case connection was already established (invoked with the
3933 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3935 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3936 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3938 * (invoked with the wireless_dev mutex held)
3939 * @leave_ibss: Leave the IBSS.
3940 * (invoked with the wireless_dev mutex held)
3942 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3945 * @set_wiphy_params: Notify that wiphy parameters have changed;
3946 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3947 * have changed. The actual parameter values are available in
3948 * struct wiphy. If returning an error, no value should be changed.
3950 * @set_tx_power: set the transmit power according to the parameters,
3951 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3952 * wdev may be %NULL if power was set for the wiphy, and will
3953 * always be %NULL unless the driver supports per-vif TX power
3954 * (as advertised by the nl80211 feature flag.)
3955 * @get_tx_power: store the current TX power into the dbm variable;
3956 * return 0 if successful
3958 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3959 * functions to adjust rfkill hw state
3961 * @dump_survey: get site survey information.
3963 * @remain_on_channel: Request the driver to remain awake on the specified
3964 * channel for the specified duration to complete an off-channel
3965 * operation (e.g., public action frame exchange). When the driver is
3966 * ready on the requested channel, it must indicate this with an event
3967 * notification by calling cfg80211_ready_on_channel().
3968 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3969 * This allows the operation to be terminated prior to timeout based on
3970 * the duration value.
3971 * @mgmt_tx: Transmit a management frame.
3972 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3973 * frame on another channel
3975 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3976 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3977 * used by the function, but 0 and 1 must not be touched. Additionally,
3978 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3979 * dump and return to userspace with an error, so be careful. If any data
3980 * was passed in from userspace then the data/len arguments will be present
3981 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3983 * @set_bitrate_mask: set the bitrate mask configuration
3985 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3986 * devices running firmwares capable of generating the (re) association
3987 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3988 * @del_pmksa: Delete a cached PMKID.
3989 * @flush_pmksa: Flush all cached PMKIDs.
3990 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3991 * allows the driver to adjust the dynamic ps timeout value.
3992 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3993 * After configuration, the driver should (soon) send an event indicating
3994 * the current level is above/below the configured threshold; this may
3995 * need some care when the configuration is changed (without first being
3997 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3998 * connection quality monitor. An event is to be sent only when the
3999 * signal level is found to be outside the two values. The driver should
4000 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
4001 * If it is provided then there's no point providing @set_cqm_rssi_config.
4002 * @set_cqm_txe_config: Configure connection quality monitor TX error
4004 * @sched_scan_start: Tell the driver to start a scheduled scan.
4005 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
4006 * given request id. This call must stop the scheduled scan and be ready
4007 * for starting a new one before it returns, i.e. @sched_scan_start may be
4008 * called immediately after that again and should not fail in that case.
4009 * The driver should not call cfg80211_sched_scan_stopped() for a requested
4010 * stop (when this method returns 0).
4012 * @update_mgmt_frame_registrations: Notify the driver that management frame
4013 * registrations were updated. The callback is allowed to sleep.
4015 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
4016 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
4017 * reject TX/RX mask combinations they cannot support by returning -EINVAL
4018 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
4020 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4022 * @tdls_mgmt: Transmit a TDLS management frame.
4023 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
4025 * @probe_client: probe an associated client, must return a cookie that it
4026 * later passes to cfg80211_probe_status().
4028 * @set_noack_map: Set the NoAck Map for the TIDs.
4030 * @get_channel: Get the current operating channel for the virtual interface.
4031 * For monitor interfaces, it should return %NULL unless there's a single
4032 * current monitoring channel.
4034 * @start_p2p_device: Start the given P2P device.
4035 * @stop_p2p_device: Stop the given P2P device.
4037 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
4038 * Parameters include ACL policy, an array of MAC address of stations
4039 * and the number of MAC addresses. If there is already a list in driver
4040 * this new list replaces the existing one. Driver has to clear its ACL
4041 * when number of MAC addresses entries is passed as 0. Drivers which
4042 * advertise the support for MAC based ACL have to implement this callback.
4044 * @start_radar_detection: Start radar detection in the driver.
4046 * @end_cac: End running CAC, probably because a related CAC
4047 * was finished on another phy.
4049 * @update_ft_ies: Provide updated Fast BSS Transition information to the
4050 * driver. If the SME is in the driver/firmware, this information can be
4051 * used in building Authentication and Reassociation Request frames.
4053 * @crit_proto_start: Indicates a critical protocol needs more link reliability
4054 * for a given duration (milliseconds). The protocol is provided so the
4055 * driver can take the most appropriate actions.
4056 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
4057 * reliability. This operation can not fail.
4058 * @set_coalesce: Set coalesce parameters.
4060 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
4061 * responsible for veryfing if the switch is possible. Since this is
4062 * inherently tricky driver may decide to disconnect an interface later
4063 * with cfg80211_stop_iface(). This doesn't mean driver can accept
4064 * everything. It should do it's best to verify requests and reject them
4065 * as soon as possible.
4067 * @set_qos_map: Set QoS mapping information to the driver
4069 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
4070 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
4071 * changes during the lifetime of the BSS.
4073 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
4074 * with the given parameters; action frame exchange has been handled by
4075 * userspace so this just has to modify the TX path to take the TS into
4077 * If the admitted time is 0 just validate the parameters to make sure
4078 * the session can be created at all; it is valid to just always return
4079 * success for that but that may result in inefficient behaviour (handshake
4080 * with the peer followed by immediate teardown when the addition is later
4082 * @del_tx_ts: remove an existing TX TS
4084 * @join_ocb: join the OCB network with the specified parameters
4085 * (invoked with the wireless_dev mutex held)
4086 * @leave_ocb: leave the current OCB network
4087 * (invoked with the wireless_dev mutex held)
4089 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4090 * is responsible for continually initiating channel-switching operations
4091 * and returning to the base channel for communication with the AP.
4092 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4093 * peers must be on the base channel when the call completes.
4094 * @start_nan: Start the NAN interface.
4095 * @stop_nan: Stop the NAN interface.
4096 * @add_nan_func: Add a NAN function. Returns negative value on failure.
4097 * On success @nan_func ownership is transferred to the driver and
4098 * it may access it outside of the scope of this function. The driver
4099 * should free the @nan_func when no longer needed by calling
4100 * cfg80211_free_nan_func().
4101 * On success the driver should assign an instance_id in the
4102 * provided @nan_func.
4103 * @del_nan_func: Delete a NAN function.
4104 * @nan_change_conf: changes NAN configuration. The changed parameters must
4105 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
4106 * All other parameters must be ignored.
4108 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
4110 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
4111 * function should return phy stats, and interface stats otherwise.
4113 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
4114 * If not deleted through @del_pmk the PMK remains valid until disconnect
4115 * upon which the driver should clear it.
4116 * (invoked with the wireless_dev mutex held)
4117 * @del_pmk: delete the previously configured PMK for the given authenticator.
4118 * (invoked with the wireless_dev mutex held)
4120 * @external_auth: indicates result of offloaded authentication processing from
4123 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
4124 * tells the driver that the frame should not be encrypted.
4126 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4127 * Statistics should be cumulative, currently no way to reset is provided.
4128 * @start_pmsr: start peer measurement (e.g. FTM)
4129 * @abort_pmsr: abort peer measurement
4131 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
4132 * but offloading OWE processing to the user space will get the updated
4133 * DH IE through this interface.
4135 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
4136 * and overrule HWMP path selection algorithm.
4137 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
4138 * This callback may sleep.
4139 * @reset_tid_config: Reset TID specific configuration for the peer, for the
4140 * given TIDs. This callback may sleep.
4142 * @set_sar_specs: Update the SAR (TX power) settings.
4144 * @color_change: Initiate a color change.
4146 * @set_fils_aad: Set FILS AAD data to the AP driver so that the driver can use
4147 * those to decrypt (Re)Association Request and encrypt (Re)Association
4150 * @set_radar_background: Configure dedicated offchannel chain available for
4151 * radar/CAC detection on some hw. This chain can't be used to transmit
4152 * or receive frames and it is bounded to a running wdev.
4153 * Background radar/CAC detection allows to avoid the CAC downtime
4154 * switching to a different channel during CAC detection on the selected
4156 * The caller is expected to set chandef pointer to NULL in order to
4157 * disable background CAC/radar detection.
4159 struct cfg80211_ops {
4160 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
4161 int (*resume)(struct wiphy *wiphy);
4162 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
4164 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
4166 unsigned char name_assign_type,
4167 enum nl80211_iftype type,
4168 struct vif_params *params);
4169 int (*del_virtual_intf)(struct wiphy *wiphy,
4170 struct wireless_dev *wdev);
4171 int (*change_virtual_intf)(struct wiphy *wiphy,
4172 struct net_device *dev,
4173 enum nl80211_iftype type,
4174 struct vif_params *params);
4176 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4177 u8 key_index, bool pairwise, const u8 *mac_addr,
4178 struct key_params *params);
4179 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4180 u8 key_index, bool pairwise, const u8 *mac_addr,
4182 void (*callback)(void *cookie, struct key_params*));
4183 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4184 u8 key_index, bool pairwise, const u8 *mac_addr);
4185 int (*set_default_key)(struct wiphy *wiphy,
4186 struct net_device *netdev,
4187 u8 key_index, bool unicast, bool multicast);
4188 int (*set_default_mgmt_key)(struct wiphy *wiphy,
4189 struct net_device *netdev,
4191 int (*set_default_beacon_key)(struct wiphy *wiphy,
4192 struct net_device *netdev,
4195 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4196 struct cfg80211_ap_settings *settings);
4197 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4198 struct cfg80211_beacon_data *info);
4199 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
4202 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
4204 struct station_parameters *params);
4205 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
4206 struct station_del_parameters *params);
4207 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
4209 struct station_parameters *params);
4210 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
4211 const u8 *mac, struct station_info *sinfo);
4212 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4213 int idx, u8 *mac, struct station_info *sinfo);
4215 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4216 const u8 *dst, const u8 *next_hop);
4217 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4219 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4220 const u8 *dst, const u8 *next_hop);
4221 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4222 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4223 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4224 int idx, u8 *dst, u8 *next_hop,
4225 struct mpath_info *pinfo);
4226 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4227 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4228 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4229 int idx, u8 *dst, u8 *mpp,
4230 struct mpath_info *pinfo);
4231 int (*get_mesh_config)(struct wiphy *wiphy,
4232 struct net_device *dev,
4233 struct mesh_config *conf);
4234 int (*update_mesh_config)(struct wiphy *wiphy,
4235 struct net_device *dev, u32 mask,
4236 const struct mesh_config *nconf);
4237 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4238 const struct mesh_config *conf,
4239 const struct mesh_setup *setup);
4240 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4242 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4243 struct ocb_setup *setup);
4244 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4246 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4247 struct bss_parameters *params);
4249 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4250 struct ieee80211_txq_params *params);
4252 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4253 struct net_device *dev,
4254 struct ieee80211_channel *chan);
4256 int (*set_monitor_channel)(struct wiphy *wiphy,
4257 struct cfg80211_chan_def *chandef);
4259 int (*scan)(struct wiphy *wiphy,
4260 struct cfg80211_scan_request *request);
4261 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4263 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4264 struct cfg80211_auth_request *req);
4265 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4266 struct cfg80211_assoc_request *req);
4267 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4268 struct cfg80211_deauth_request *req);
4269 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4270 struct cfg80211_disassoc_request *req);
4272 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4273 struct cfg80211_connect_params *sme);
4274 int (*update_connect_params)(struct wiphy *wiphy,
4275 struct net_device *dev,
4276 struct cfg80211_connect_params *sme,
4278 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4281 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4282 struct cfg80211_ibss_params *params);
4283 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4285 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4286 int rate[NUM_NL80211_BANDS]);
4288 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4290 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4291 enum nl80211_tx_power_setting type, int mbm);
4292 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4295 void (*rfkill_poll)(struct wiphy *wiphy);
4297 #ifdef CONFIG_NL80211_TESTMODE
4298 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4299 void *data, int len);
4300 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4301 struct netlink_callback *cb,
4302 void *data, int len);
4305 int (*set_bitrate_mask)(struct wiphy *wiphy,
4306 struct net_device *dev,
4308 const struct cfg80211_bitrate_mask *mask);
4310 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4311 int idx, struct survey_info *info);
4313 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4314 struct cfg80211_pmksa *pmksa);
4315 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4316 struct cfg80211_pmksa *pmksa);
4317 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4319 int (*remain_on_channel)(struct wiphy *wiphy,
4320 struct wireless_dev *wdev,
4321 struct ieee80211_channel *chan,
4322 unsigned int duration,
4324 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4325 struct wireless_dev *wdev,
4328 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4329 struct cfg80211_mgmt_tx_params *params,
4331 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4332 struct wireless_dev *wdev,
4335 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4336 bool enabled, int timeout);
4338 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4339 struct net_device *dev,
4340 s32 rssi_thold, u32 rssi_hyst);
4342 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4343 struct net_device *dev,
4344 s32 rssi_low, s32 rssi_high);
4346 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4347 struct net_device *dev,
4348 u32 rate, u32 pkts, u32 intvl);
4350 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4351 struct wireless_dev *wdev,
4352 struct mgmt_frame_regs *upd);
4354 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4355 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4357 int (*sched_scan_start)(struct wiphy *wiphy,
4358 struct net_device *dev,
4359 struct cfg80211_sched_scan_request *request);
4360 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4363 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4364 struct cfg80211_gtk_rekey_data *data);
4366 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4367 const u8 *peer, u8 action_code, u8 dialog_token,
4368 u16 status_code, u32 peer_capability,
4369 bool initiator, const u8 *buf, size_t len);
4370 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4371 const u8 *peer, enum nl80211_tdls_operation oper);
4373 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4374 const u8 *peer, u64 *cookie);
4376 int (*set_noack_map)(struct wiphy *wiphy,
4377 struct net_device *dev,
4380 int (*get_channel)(struct wiphy *wiphy,
4381 struct wireless_dev *wdev,
4382 struct cfg80211_chan_def *chandef);
4384 int (*start_p2p_device)(struct wiphy *wiphy,
4385 struct wireless_dev *wdev);
4386 void (*stop_p2p_device)(struct wiphy *wiphy,
4387 struct wireless_dev *wdev);
4389 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4390 const struct cfg80211_acl_data *params);
4392 int (*start_radar_detection)(struct wiphy *wiphy,
4393 struct net_device *dev,
4394 struct cfg80211_chan_def *chandef,
4396 void (*end_cac)(struct wiphy *wiphy,
4397 struct net_device *dev);
4398 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4399 struct cfg80211_update_ft_ies_params *ftie);
4400 int (*crit_proto_start)(struct wiphy *wiphy,
4401 struct wireless_dev *wdev,
4402 enum nl80211_crit_proto_id protocol,
4404 void (*crit_proto_stop)(struct wiphy *wiphy,
4405 struct wireless_dev *wdev);
4406 int (*set_coalesce)(struct wiphy *wiphy,
4407 struct cfg80211_coalesce *coalesce);
4409 int (*channel_switch)(struct wiphy *wiphy,
4410 struct net_device *dev,
4411 struct cfg80211_csa_settings *params);
4413 int (*set_qos_map)(struct wiphy *wiphy,
4414 struct net_device *dev,
4415 struct cfg80211_qos_map *qos_map);
4417 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4418 struct cfg80211_chan_def *chandef);
4420 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4421 u8 tsid, const u8 *peer, u8 user_prio,
4423 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4424 u8 tsid, const u8 *peer);
4426 int (*tdls_channel_switch)(struct wiphy *wiphy,
4427 struct net_device *dev,
4428 const u8 *addr, u8 oper_class,
4429 struct cfg80211_chan_def *chandef);
4430 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4431 struct net_device *dev,
4433 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4434 struct cfg80211_nan_conf *conf);
4435 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4436 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4437 struct cfg80211_nan_func *nan_func);
4438 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4440 int (*nan_change_conf)(struct wiphy *wiphy,
4441 struct wireless_dev *wdev,
4442 struct cfg80211_nan_conf *conf,
4445 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4446 struct net_device *dev,
4447 const bool enabled);
4449 int (*get_txq_stats)(struct wiphy *wiphy,
4450 struct wireless_dev *wdev,
4451 struct cfg80211_txq_stats *txqstats);
4453 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4454 const struct cfg80211_pmk_conf *conf);
4455 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4457 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4458 struct cfg80211_external_auth_params *params);
4460 int (*tx_control_port)(struct wiphy *wiphy,
4461 struct net_device *dev,
4462 const u8 *buf, size_t len,
4463 const u8 *dest, const __be16 proto,
4464 const bool noencrypt,
4467 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4468 struct net_device *dev,
4469 struct cfg80211_ftm_responder_stats *ftm_stats);
4471 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4472 struct cfg80211_pmsr_request *request);
4473 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4474 struct cfg80211_pmsr_request *request);
4475 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4476 struct cfg80211_update_owe_info *owe_info);
4477 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4478 const u8 *buf, size_t len);
4479 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4480 struct cfg80211_tid_config *tid_conf);
4481 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4482 const u8 *peer, u8 tids);
4483 int (*set_sar_specs)(struct wiphy *wiphy,
4484 struct cfg80211_sar_specs *sar);
4485 int (*color_change)(struct wiphy *wiphy,
4486 struct net_device *dev,
4487 struct cfg80211_color_change_settings *params);
4488 int (*set_fils_aad)(struct wiphy *wiphy, struct net_device *dev,
4489 struct cfg80211_fils_aad *fils_aad);
4490 int (*set_radar_background)(struct wiphy *wiphy,
4491 struct cfg80211_chan_def *chandef);
4495 * wireless hardware and networking interfaces structures
4496 * and registration/helper functions
4500 * enum wiphy_flags - wiphy capability flags
4502 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4503 * into two, first for legacy bands and second for UHB.
4504 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4506 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4507 * by default -- this flag will be set depending on the kernel's default
4508 * on wiphy_new(), but can be changed by the driver if it has a good
4509 * reason to override the default
4510 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4511 * on a VLAN interface). This flag also serves an extra purpose of
4512 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4513 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4514 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4515 * control port protocol ethertype. The device also honours the
4516 * control_port_no_encrypt flag.
4517 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4518 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4519 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4520 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4522 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4523 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4524 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4525 * link setup/discovery operations internally. Setup, discovery and
4526 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4527 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4528 * used for asking the driver/firmware to perform a TDLS operation.
4529 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4530 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4531 * when there are virtual interfaces in AP mode by calling
4532 * cfg80211_report_obss_beacon().
4533 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4534 * responds to probe-requests in hardware.
4535 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4536 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4537 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4538 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4539 * beaconing mode (AP, IBSS, Mesh, ...).
4540 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4541 * before connection.
4542 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4545 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4547 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4548 WIPHY_FLAG_NETNS_OK = BIT(3),
4549 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4550 WIPHY_FLAG_4ADDR_AP = BIT(5),
4551 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4552 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4553 WIPHY_FLAG_IBSS_RSN = BIT(8),
4554 WIPHY_FLAG_MESH_AUTH = BIT(10),
4555 /* use hole at 11 */
4556 /* use hole at 12 */
4557 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4558 WIPHY_FLAG_AP_UAPSD = BIT(14),
4559 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4560 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4561 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4562 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4563 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4564 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4565 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4566 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4567 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4568 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4572 * struct ieee80211_iface_limit - limit on certain interface types
4573 * @max: maximum number of interfaces of these types
4574 * @types: interface types (bits)
4576 struct ieee80211_iface_limit {
4582 * struct ieee80211_iface_combination - possible interface combination
4584 * With this structure the driver can describe which interface
4585 * combinations it supports concurrently.
4589 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4593 * struct ieee80211_iface_limit limits1[] = {
4594 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4595 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4597 * struct ieee80211_iface_combination combination1 = {
4598 * .limits = limits1,
4599 * .n_limits = ARRAY_SIZE(limits1),
4600 * .max_interfaces = 2,
4601 * .beacon_int_infra_match = true,
4605 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4609 * struct ieee80211_iface_limit limits2[] = {
4610 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4611 * BIT(NL80211_IFTYPE_P2P_GO), },
4613 * struct ieee80211_iface_combination combination2 = {
4614 * .limits = limits2,
4615 * .n_limits = ARRAY_SIZE(limits2),
4616 * .max_interfaces = 8,
4617 * .num_different_channels = 1,
4621 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4623 * This allows for an infrastructure connection and three P2P connections.
4627 * struct ieee80211_iface_limit limits3[] = {
4628 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4629 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4630 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4632 * struct ieee80211_iface_combination combination3 = {
4633 * .limits = limits3,
4634 * .n_limits = ARRAY_SIZE(limits3),
4635 * .max_interfaces = 4,
4636 * .num_different_channels = 2,
4640 struct ieee80211_iface_combination {
4643 * limits for the given interface types
4645 const struct ieee80211_iface_limit *limits;
4648 * @num_different_channels:
4649 * can use up to this many different channels
4651 u32 num_different_channels;
4655 * maximum number of interfaces in total allowed in this group
4661 * number of limitations
4666 * @beacon_int_infra_match:
4667 * In this combination, the beacon intervals between infrastructure
4668 * and AP types must match. This is required only in special cases.
4670 bool beacon_int_infra_match;
4673 * @radar_detect_widths:
4674 * bitmap of channel widths supported for radar detection
4676 u8 radar_detect_widths;
4679 * @radar_detect_regions:
4680 * bitmap of regions supported for radar detection
4682 u8 radar_detect_regions;
4685 * @beacon_int_min_gcd:
4686 * This interface combination supports different beacon intervals.
4689 * all beacon intervals for different interface must be same.
4691 * any beacon interval for the interface part of this combination AND
4692 * GCD of all beacon intervals from beaconing interfaces of this
4693 * combination must be greater or equal to this value.
4695 u32 beacon_int_min_gcd;
4698 struct ieee80211_txrx_stypes {
4703 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4704 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4705 * trigger that keeps the device operating as-is and
4706 * wakes up the host on any activity, for example a
4707 * received packet that passed filtering; note that the
4708 * packet should be preserved in that case
4709 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4711 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4712 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4713 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4714 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4715 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4716 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4717 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4719 enum wiphy_wowlan_support_flags {
4720 WIPHY_WOWLAN_ANY = BIT(0),
4721 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4722 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4723 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4724 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4725 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4726 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4727 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4728 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4731 struct wiphy_wowlan_tcp_support {
4732 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4733 u32 data_payload_max;
4734 u32 data_interval_max;
4735 u32 wake_payload_max;
4740 * struct wiphy_wowlan_support - WoWLAN support data
4741 * @flags: see &enum wiphy_wowlan_support_flags
4742 * @n_patterns: number of supported wakeup patterns
4743 * (see nl80211.h for the pattern definition)
4744 * @pattern_max_len: maximum length of each pattern
4745 * @pattern_min_len: minimum length of each pattern
4746 * @max_pkt_offset: maximum Rx packet offset
4747 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4748 * similar, but not necessarily identical, to max_match_sets for
4750 * See &struct cfg80211_sched_scan_request.@match_sets for more
4752 * @tcp: TCP wakeup support information
4754 struct wiphy_wowlan_support {
4757 int pattern_max_len;
4758 int pattern_min_len;
4760 int max_nd_match_sets;
4761 const struct wiphy_wowlan_tcp_support *tcp;
4765 * struct wiphy_coalesce_support - coalesce support data
4766 * @n_rules: maximum number of coalesce rules
4767 * @max_delay: maximum supported coalescing delay in msecs
4768 * @n_patterns: number of supported patterns in a rule
4769 * (see nl80211.h for the pattern definition)
4770 * @pattern_max_len: maximum length of each pattern
4771 * @pattern_min_len: minimum length of each pattern
4772 * @max_pkt_offset: maximum Rx packet offset
4774 struct wiphy_coalesce_support {
4778 int pattern_max_len;
4779 int pattern_min_len;
4784 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4785 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4786 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4787 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4788 * (must be combined with %_WDEV or %_NETDEV)
4790 enum wiphy_vendor_command_flags {
4791 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4792 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4793 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4797 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4799 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4800 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4801 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4804 enum wiphy_opmode_flag {
4805 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4806 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4807 STA_OPMODE_N_SS_CHANGED = BIT(2),
4811 * struct sta_opmode_info - Station's ht/vht operation mode information
4812 * @changed: contains value from &enum wiphy_opmode_flag
4813 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4814 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4815 * @rx_nss: new rx_nss value of a station
4818 struct sta_opmode_info {
4820 enum nl80211_smps_mode smps_mode;
4821 enum nl80211_chan_width bw;
4825 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4828 * struct wiphy_vendor_command - vendor command definition
4829 * @info: vendor command identifying information, as used in nl80211
4830 * @flags: flags, see &enum wiphy_vendor_command_flags
4831 * @doit: callback for the operation, note that wdev is %NULL if the
4832 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4833 * pointer may be %NULL if userspace provided no data at all
4834 * @dumpit: dump callback, for transferring bigger/multiple items. The
4835 * @storage points to cb->args[5], ie. is preserved over the multiple
4837 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4838 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4839 * attribute is just raw data (e.g. a firmware command).
4840 * @maxattr: highest attribute number in policy
4841 * It's recommended to not have the same sub command with both @doit and
4842 * @dumpit, so that userspace can assume certain ones are get and others
4843 * are used with dump requests.
4845 struct wiphy_vendor_command {
4846 struct nl80211_vendor_cmd_info info;
4848 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4849 const void *data, int data_len);
4850 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4851 struct sk_buff *skb, const void *data, int data_len,
4852 unsigned long *storage);
4853 const struct nla_policy *policy;
4854 unsigned int maxattr;
4858 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4859 * @iftype: interface type
4860 * @extended_capabilities: extended capabilities supported by the driver,
4861 * additional capabilities might be supported by userspace; these are the
4862 * 802.11 extended capabilities ("Extended Capabilities element") and are
4863 * in the same format as in the information element. See IEEE Std
4864 * 802.11-2012 8.4.2.29 for the defined fields.
4865 * @extended_capabilities_mask: mask of the valid values
4866 * @extended_capabilities_len: length of the extended capabilities
4868 struct wiphy_iftype_ext_capab {
4869 enum nl80211_iftype iftype;
4870 const u8 *extended_capabilities;
4871 const u8 *extended_capabilities_mask;
4872 u8 extended_capabilities_len;
4876 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4877 * @max_peers: maximum number of peers in a single measurement
4878 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4879 * @randomize_mac_addr: can randomize MAC address for measurement
4880 * @ftm.supported: FTM measurement is supported
4881 * @ftm.asap: ASAP-mode is supported
4882 * @ftm.non_asap: non-ASAP-mode is supported
4883 * @ftm.request_lci: can request LCI data
4884 * @ftm.request_civicloc: can request civic location data
4885 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4886 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4887 * @ftm.max_bursts_exponent: maximum burst exponent supported
4888 * (set to -1 if not limited; note that setting this will necessarily
4889 * forbid using the value 15 to let the responder pick)
4890 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4892 * @ftm.trigger_based: trigger based ranging measurement is supported
4893 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
4895 struct cfg80211_pmsr_capabilities {
4896 unsigned int max_peers;
4898 randomize_mac_addr:1;
4903 s8 max_bursts_exponent;
4904 u8 max_ftms_per_burst;
4911 non_trigger_based:1;
4916 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4917 * suites for interface types defined in @iftypes_mask. Each type in the
4918 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4920 * @iftypes_mask: bitmask of interfaces types
4921 * @akm_suites: points to an array of supported akm suites
4922 * @n_akm_suites: number of supported AKM suites
4924 struct wiphy_iftype_akm_suites {
4926 const u32 *akm_suites;
4931 * struct wiphy - wireless hardware description
4932 * @mtx: mutex for the data (structures) of this device
4933 * @reg_notifier: the driver's regulatory notification callback,
4934 * note that if your driver uses wiphy_apply_custom_regulatory()
4935 * the reg_notifier's request can be passed as NULL
4936 * @regd: the driver's regulatory domain, if one was requested via
4937 * the regulatory_hint() API. This can be used by the driver
4938 * on the reg_notifier() if it chooses to ignore future
4939 * regulatory domain changes caused by other drivers.
4940 * @signal_type: signal type reported in &struct cfg80211_bss.
4941 * @cipher_suites: supported cipher suites
4942 * @n_cipher_suites: number of supported cipher suites
4943 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4944 * the supported AKMs not advertized for a specific interface type in
4945 * iftype_akm_suites.
4946 * @n_akm_suites: number of supported AKM suites
4947 * @iftype_akm_suites: array of supported akm suites info per interface type.
4948 * Note that the bits in @iftypes_mask inside this structure cannot
4949 * overlap (i.e. only one occurrence of each type is allowed across all
4950 * instances of iftype_akm_suites).
4951 * @num_iftype_akm_suites: number of interface types for which supported akm
4952 * suites are specified separately.
4953 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4954 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4955 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4956 * -1 = fragmentation disabled, only odd values >= 256 used
4957 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4958 * @_net: the network namespace this wiphy currently lives in
4959 * @perm_addr: permanent MAC address of this device
4960 * @addr_mask: If the device supports multiple MAC addresses by masking,
4961 * set this to a mask with variable bits set to 1, e.g. if the last
4962 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4963 * variable bits shall be determined by the interfaces added, with
4964 * interfaces not matching the mask being rejected to be brought up.
4965 * @n_addresses: number of addresses in @addresses.
4966 * @addresses: If the device has more than one address, set this pointer
4967 * to a list of addresses (6 bytes each). The first one will be used
4968 * by default for perm_addr. In this case, the mask should be set to
4969 * all-zeroes. In this case it is assumed that the device can handle
4970 * the same number of arbitrary MAC addresses.
4971 * @registered: protects ->resume and ->suspend sysfs callbacks against
4972 * unregister hardware
4973 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4974 * It will be renamed automatically on wiphy renames
4975 * @dev: (virtual) struct device for this wiphy. The item in
4976 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4978 * @wext: wireless extension handlers
4979 * @priv: driver private data (sized according to wiphy_new() parameter)
4980 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4981 * must be set by driver
4982 * @iface_combinations: Valid interface combinations array, should not
4983 * list single interface types.
4984 * @n_iface_combinations: number of entries in @iface_combinations array.
4985 * @software_iftypes: bitmask of software interface types, these are not
4986 * subject to any restrictions since they are purely managed in SW.
4987 * @flags: wiphy flags, see &enum wiphy_flags
4988 * @regulatory_flags: wiphy regulatory flags, see
4989 * &enum ieee80211_regulatory_flags
4990 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4991 * @ext_features: extended features advertised to nl80211, see
4992 * &enum nl80211_ext_feature_index.
4993 * @bss_priv_size: each BSS struct has private data allocated with it,
4994 * this variable determines its size
4995 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4997 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4998 * the device can run concurrently.
4999 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
5000 * for in any given scheduled scan
5001 * @max_match_sets: maximum number of match sets the device can handle
5002 * when performing a scheduled scan, 0 if filtering is not
5004 * @max_scan_ie_len: maximum length of user-controlled IEs device can
5005 * add to probe request frames transmitted during a scan, must not
5006 * include fixed IEs like supported rates
5007 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
5009 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
5010 * of iterations) for scheduled scan supported by the device.
5011 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
5012 * single scan plan supported by the device.
5013 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
5014 * scan plan supported by the device.
5015 * @coverage_class: current coverage class
5016 * @fw_version: firmware version for ethtool reporting
5017 * @hw_version: hardware version for ethtool reporting
5018 * @max_num_pmkids: maximum number of PMKIDs supported by device
5019 * @privid: a pointer that drivers can use to identify if an arbitrary
5020 * wiphy is theirs, e.g. in global notifiers
5021 * @bands: information about bands/channels supported by this device
5023 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
5024 * transmitted through nl80211, points to an array indexed by interface
5027 * @available_antennas_tx: bitmap of antennas which are available to be
5028 * configured as TX antennas. Antenna configuration commands will be
5029 * rejected unless this or @available_antennas_rx is set.
5031 * @available_antennas_rx: bitmap of antennas which are available to be
5032 * configured as RX antennas. Antenna configuration commands will be
5033 * rejected unless this or @available_antennas_tx is set.
5035 * @probe_resp_offload:
5036 * Bitmap of supported protocols for probe response offloading.
5037 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
5038 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
5040 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
5041 * may request, if implemented.
5043 * @wowlan: WoWLAN support information
5044 * @wowlan_config: current WoWLAN configuration; this should usually not be
5045 * used since access to it is necessarily racy, use the parameter passed
5046 * to the suspend() operation instead.
5048 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
5049 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
5050 * If null, then none can be over-ridden.
5051 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
5052 * If null, then none can be over-ridden.
5054 * @wdev_list: the list of associated (virtual) interfaces; this list must
5055 * not be modified by the driver, but can be read with RTNL/RCU protection.
5057 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
5060 * @extended_capabilities: extended capabilities supported by the driver,
5061 * additional capabilities might be supported by userspace; these are
5062 * the 802.11 extended capabilities ("Extended Capabilities element")
5063 * and are in the same format as in the information element. See
5064 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
5065 * extended capabilities to be used if the capabilities are not specified
5066 * for a specific interface type in iftype_ext_capab.
5067 * @extended_capabilities_mask: mask of the valid values
5068 * @extended_capabilities_len: length of the extended capabilities
5069 * @iftype_ext_capab: array of extended capabilities per interface type
5070 * @num_iftype_ext_capab: number of interface types for which extended
5071 * capabilities are specified separately.
5072 * @coalesce: packet coalescing support information
5074 * @vendor_commands: array of vendor commands supported by the hardware
5075 * @n_vendor_commands: number of vendor commands
5076 * @vendor_events: array of vendor events supported by the hardware
5077 * @n_vendor_events: number of vendor events
5079 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
5080 * (including P2P GO) or 0 to indicate no such limit is advertised. The
5081 * driver is allowed to advertise a theoretical limit that it can reach in
5082 * some cases, but may not always reach.
5084 * @max_num_csa_counters: Number of supported csa_counters in beacons
5085 * and probe responses. This value should be set if the driver
5086 * wishes to limit the number of csa counters. Default (0) means
5088 * @bss_select_support: bitmask indicating the BSS selection criteria supported
5089 * by the driver in the .connect() callback. The bit position maps to the
5090 * attribute indices defined in &enum nl80211_bss_select_attr.
5092 * @nan_supported_bands: bands supported by the device in NAN mode, a
5093 * bitmap of &enum nl80211_band values. For instance, for
5094 * NL80211_BAND_2GHZ, bit 0 would be set
5095 * (i.e. BIT(NL80211_BAND_2GHZ)).
5097 * @txq_limit: configuration of internal TX queue frame limit
5098 * @txq_memory_limit: configuration internal TX queue memory limit
5099 * @txq_quantum: configuration of internal TX queue scheduler quantum
5101 * @tx_queue_len: allow setting transmit queue len for drivers not using
5104 * @support_mbssid: can HW support association with nontransmitted AP
5105 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
5106 * HE AP, in order to avoid compatibility issues.
5107 * @support_mbssid must be set for this to have any effect.
5109 * @pmsr_capa: peer measurement capabilities
5111 * @tid_config_support: describes the per-TID config support that the
5113 * @tid_config_support.vif: bitmap of attributes (configurations)
5114 * supported by the driver for each vif
5115 * @tid_config_support.peer: bitmap of attributes (configurations)
5116 * supported by the driver for each peer
5117 * @tid_config_support.max_retry: maximum supported retry count for
5118 * long/short retry configuration
5120 * @max_data_retry_count: maximum supported per TID retry count for
5121 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
5122 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
5123 * @sar_capa: SAR control capabilities
5124 * @rfkill: a pointer to the rfkill structure
5126 * @mbssid_max_interfaces: maximum number of interfaces supported by the driver
5127 * in a multiple BSSID set. This field must be set to a non-zero value
5128 * by the driver to advertise MBSSID support.
5129 * @ema_max_profile_periodicity: maximum profile periodicity supported by
5130 * the driver. Setting this field to a non-zero value indicates that the
5131 * driver supports enhanced multi-BSSID advertisements (EMA AP).
5136 /* assign these fields before you register the wiphy */
5138 u8 perm_addr[ETH_ALEN];
5139 u8 addr_mask[ETH_ALEN];
5141 struct mac_address *addresses;
5143 const struct ieee80211_txrx_stypes *mgmt_stypes;
5145 const struct ieee80211_iface_combination *iface_combinations;
5146 int n_iface_combinations;
5147 u16 software_iftypes;
5151 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
5152 u16 interface_modes;
5154 u16 max_acl_mac_addrs;
5156 u32 flags, regulatory_flags, features;
5157 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
5161 enum cfg80211_signal_type signal_type;
5165 u8 max_sched_scan_reqs;
5166 u8 max_sched_scan_ssids;
5168 u16 max_scan_ie_len;
5169 u16 max_sched_scan_ie_len;
5170 u32 max_sched_scan_plans;
5171 u32 max_sched_scan_plan_interval;
5172 u32 max_sched_scan_plan_iterations;
5174 int n_cipher_suites;
5175 const u32 *cipher_suites;
5178 const u32 *akm_suites;
5180 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
5181 unsigned int num_iftype_akm_suites;
5189 char fw_version[ETHTOOL_FWVERS_LEN];
5193 const struct wiphy_wowlan_support *wowlan;
5194 struct cfg80211_wowlan *wowlan_config;
5197 u16 max_remain_on_channel_duration;
5201 u32 available_antennas_tx;
5202 u32 available_antennas_rx;
5204 u32 probe_resp_offload;
5206 const u8 *extended_capabilities, *extended_capabilities_mask;
5207 u8 extended_capabilities_len;
5209 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5210 unsigned int num_iftype_ext_capab;
5214 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5216 void (*reg_notifier)(struct wiphy *wiphy,
5217 struct regulatory_request *request);
5219 /* fields below are read-only, assigned by cfg80211 */
5221 const struct ieee80211_regdomain __rcu *regd;
5227 struct dentry *debugfsdir;
5229 const struct ieee80211_ht_cap *ht_capa_mod_mask;
5230 const struct ieee80211_vht_cap *vht_capa_mod_mask;
5232 struct list_head wdev_list;
5234 possible_net_t _net;
5236 #ifdef CONFIG_CFG80211_WEXT
5237 const struct iw_handler_def *wext;
5240 const struct wiphy_coalesce_support *coalesce;
5242 const struct wiphy_vendor_command *vendor_commands;
5243 const struct nl80211_vendor_cmd_info *vendor_events;
5244 int n_vendor_commands, n_vendor_events;
5246 u16 max_ap_assoc_sta;
5248 u8 max_num_csa_counters;
5250 u32 bss_select_support;
5252 u8 nan_supported_bands;
5255 u32 txq_memory_limit;
5258 unsigned long tx_queue_len;
5260 u8 support_mbssid:1,
5261 support_only_he_mbssid:1;
5263 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5268 } tid_config_support;
5270 u8 max_data_retry_count;
5272 const struct cfg80211_sar_capa *sar_capa;
5274 struct rfkill *rfkill;
5276 u8 mbssid_max_interfaces;
5277 u8 ema_max_profile_periodicity;
5279 char priv[] __aligned(NETDEV_ALIGN);
5282 static inline struct net *wiphy_net(struct wiphy *wiphy)
5284 return read_pnet(&wiphy->_net);
5287 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5289 write_pnet(&wiphy->_net, net);
5293 * wiphy_priv - return priv from wiphy
5295 * @wiphy: the wiphy whose priv pointer to return
5296 * Return: The priv of @wiphy.
5298 static inline void *wiphy_priv(struct wiphy *wiphy)
5301 return &wiphy->priv;
5305 * priv_to_wiphy - return the wiphy containing the priv
5307 * @priv: a pointer previously returned by wiphy_priv
5308 * Return: The wiphy of @priv.
5310 static inline struct wiphy *priv_to_wiphy(void *priv)
5313 return container_of(priv, struct wiphy, priv);
5317 * set_wiphy_dev - set device pointer for wiphy
5319 * @wiphy: The wiphy whose device to bind
5320 * @dev: The device to parent it to
5322 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5324 wiphy->dev.parent = dev;
5328 * wiphy_dev - get wiphy dev pointer
5330 * @wiphy: The wiphy whose device struct to look up
5331 * Return: The dev of @wiphy.
5333 static inline struct device *wiphy_dev(struct wiphy *wiphy)
5335 return wiphy->dev.parent;
5339 * wiphy_name - get wiphy name
5341 * @wiphy: The wiphy whose name to return
5342 * Return: The name of @wiphy.
5344 static inline const char *wiphy_name(const struct wiphy *wiphy)
5346 return dev_name(&wiphy->dev);
5350 * wiphy_new_nm - create a new wiphy for use with cfg80211
5352 * @ops: The configuration operations for this device
5353 * @sizeof_priv: The size of the private area to allocate
5354 * @requested_name: Request a particular name.
5355 * NULL is valid value, and means use the default phy%d naming.
5357 * Create a new wiphy and associate the given operations with it.
5358 * @sizeof_priv bytes are allocated for private use.
5360 * Return: A pointer to the new wiphy. This pointer must be
5361 * assigned to each netdev's ieee80211_ptr for proper operation.
5363 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5364 const char *requested_name);
5367 * wiphy_new - create a new wiphy for use with cfg80211
5369 * @ops: The configuration operations for this device
5370 * @sizeof_priv: The size of the private area to allocate
5372 * Create a new wiphy and associate the given operations with it.
5373 * @sizeof_priv bytes are allocated for private use.
5375 * Return: A pointer to the new wiphy. This pointer must be
5376 * assigned to each netdev's ieee80211_ptr for proper operation.
5378 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5381 return wiphy_new_nm(ops, sizeof_priv, NULL);
5385 * wiphy_register - register a wiphy with cfg80211
5387 * @wiphy: The wiphy to register.
5389 * Return: A non-negative wiphy index or a negative error code.
5391 int wiphy_register(struct wiphy *wiphy);
5393 /* this is a define for better error reporting (file/line) */
5394 #define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
5397 * rcu_dereference_wiphy - rcu_dereference with debug checking
5398 * @wiphy: the wiphy to check the locking on
5399 * @p: The pointer to read, prior to dereferencing
5401 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
5402 * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
5404 #define rcu_dereference_wiphy(wiphy, p) \
5405 rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
5408 * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
5409 * @wiphy: the wiphy to check the locking on
5410 * @p: The pointer to read, prior to dereferencing
5412 * Return the value of the specified RCU-protected pointer, but omit the
5413 * READ_ONCE(), because caller holds the wiphy mutex used for updates.
5415 #define wiphy_dereference(wiphy, p) \
5416 rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
5419 * get_wiphy_regdom - get custom regdomain for the given wiphy
5420 * @wiphy: the wiphy to get the regdomain from
5422 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
5425 * wiphy_unregister - deregister a wiphy from cfg80211
5427 * @wiphy: The wiphy to unregister.
5429 * After this call, no more requests can be made with this priv
5430 * pointer, but the call may sleep to wait for an outstanding
5431 * request that is being handled.
5433 void wiphy_unregister(struct wiphy *wiphy);
5436 * wiphy_free - free wiphy
5438 * @wiphy: The wiphy to free
5440 void wiphy_free(struct wiphy *wiphy);
5442 /* internal structs */
5443 struct cfg80211_conn;
5444 struct cfg80211_internal_bss;
5445 struct cfg80211_cached_keys;
5446 struct cfg80211_cqm_config;
5449 * wiphy_lock - lock the wiphy
5450 * @wiphy: the wiphy to lock
5452 * This is mostly exposed so it can be done around registering and
5453 * unregistering netdevs that aren't created through cfg80211 calls,
5454 * since that requires locking in cfg80211 when the notifiers is
5455 * called, but that cannot differentiate which way it's called.
5457 * When cfg80211 ops are called, the wiphy is already locked.
5459 static inline void wiphy_lock(struct wiphy *wiphy)
5460 __acquires(&wiphy->mtx)
5462 mutex_lock(&wiphy->mtx);
5463 __acquire(&wiphy->mtx);
5467 * wiphy_unlock - unlock the wiphy again
5468 * @wiphy: the wiphy to unlock
5470 static inline void wiphy_unlock(struct wiphy *wiphy)
5471 __releases(&wiphy->mtx)
5473 __release(&wiphy->mtx);
5474 mutex_unlock(&wiphy->mtx);
5478 * struct wireless_dev - wireless device state
5480 * For netdevs, this structure must be allocated by the driver
5481 * that uses the ieee80211_ptr field in struct net_device (this
5482 * is intentional so it can be allocated along with the netdev.)
5483 * It need not be registered then as netdev registration will
5484 * be intercepted by cfg80211 to see the new wireless device,
5485 * however, drivers must lock the wiphy before registering or
5486 * unregistering netdevs if they pre-create any netdevs (in ops
5487 * called from cfg80211, the wiphy is already locked.)
5489 * For non-netdev uses, it must also be allocated by the driver
5490 * in response to the cfg80211 callbacks that require it, as
5491 * there's no netdev registration in that case it may not be
5492 * allocated outside of callback operations that return it.
5494 * @wiphy: pointer to hardware description
5495 * @iftype: interface type
5496 * @registered: is this wdev already registered with cfg80211
5497 * @registering: indicates we're doing registration under wiphy lock
5499 * @list: (private) Used to collect the interfaces
5500 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5501 * @identifier: (private) Identifier used in nl80211 to identify this
5502 * wireless device if it has no netdev
5503 * @current_bss: (private) Used by the internal configuration code
5504 * @chandef: (private) Used by the internal configuration code to track
5505 * the user-set channel definition.
5506 * @preset_chandef: (private) Used by the internal configuration code to
5507 * track the channel to be used for AP later
5508 * @bssid: (private) Used by the internal configuration code
5509 * @ssid: (private) Used by the internal configuration code
5510 * @ssid_len: (private) Used by the internal configuration code
5511 * @mesh_id_len: (private) Used by the internal configuration code
5512 * @mesh_id_up_len: (private) Used by the internal configuration code
5513 * @wext: (private) Used by the internal wireless extensions compat code
5514 * @wext.ibss: (private) IBSS data part of wext handling
5515 * @wext.connect: (private) connection handling data
5516 * @wext.keys: (private) (WEP) key data
5517 * @wext.ie: (private) extra elements for association
5518 * @wext.ie_len: (private) length of extra elements
5519 * @wext.bssid: (private) selected network BSSID
5520 * @wext.ssid: (private) selected network SSID
5521 * @wext.default_key: (private) selected default key index
5522 * @wext.default_mgmt_key: (private) selected default management key index
5523 * @wext.prev_bssid: (private) previous BSSID for reassociation
5524 * @wext.prev_bssid_valid: (private) previous BSSID validity
5525 * @use_4addr: indicates 4addr mode is used on this interface, must be
5526 * set by driver (if supported) on add_interface BEFORE registering the
5527 * netdev and may otherwise be used by driver read-only, will be update
5528 * by cfg80211 on change_interface
5529 * @mgmt_registrations: list of registrations for management frames
5530 * @mgmt_registrations_need_update: mgmt registrations were updated,
5531 * need to propagate the update to the driver
5532 * @mtx: mutex used to lock data in this struct, may be used by drivers
5533 * and some API functions require it held
5534 * @beacon_interval: beacon interval used on this device for transmitting
5535 * beacons, 0 when not valid
5536 * @address: The address for this device, valid only if @netdev is %NULL
5537 * @is_running: true if this is a non-netdev device that has been started, e.g.
5539 * @cac_started: true if DFS channel availability check has been started
5540 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5541 * @cac_time_ms: CAC time in ms
5542 * @ps: powersave mode is enabled
5543 * @ps_timeout: dynamic powersave timeout
5544 * @ap_unexpected_nlportid: (private) netlink port ID of application
5545 * registered for unexpected class 3 frames (AP mode)
5546 * @conn: (private) cfg80211 software SME connection state machine data
5547 * @connect_keys: (private) keys to set after connection is established
5548 * @conn_bss_type: connecting/connected BSS type
5549 * @conn_owner_nlportid: (private) connection owner socket port ID
5550 * @disconnect_wk: (private) auto-disconnect work
5551 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5552 * @ibss_fixed: (private) IBSS is using fixed BSSID
5553 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
5554 * @event_list: (private) list for internal event processing
5555 * @event_lock: (private) lock for event list
5556 * @owner_nlportid: (private) owner socket port ID
5557 * @nl_owner_dead: (private) owner socket went away
5558 * @cqm_config: (private) nl80211 RSSI monitor state
5559 * @pmsr_list: (private) peer measurement requests
5560 * @pmsr_lock: (private) peer measurements requests/results lock
5561 * @pmsr_free_wk: (private) peer measurements cleanup work
5562 * @unprot_beacon_reported: (private) timestamp of last
5563 * unprotected beacon report
5565 struct wireless_dev {
5566 struct wiphy *wiphy;
5567 enum nl80211_iftype iftype;
5569 /* the remainder of this struct should be private to cfg80211 */
5570 struct list_head list;
5571 struct net_device *netdev;
5575 struct list_head mgmt_registrations;
5576 u8 mgmt_registrations_need_update:1;
5580 bool use_4addr, is_running, registered, registering;
5582 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5584 /* currently used for IBSS and SME - might be rearranged later */
5585 u8 ssid[IEEE80211_MAX_SSID_LEN];
5586 u8 ssid_len, mesh_id_len, mesh_id_up_len;
5587 struct cfg80211_conn *conn;
5588 struct cfg80211_cached_keys *connect_keys;
5589 enum ieee80211_bss_type conn_bss_type;
5590 u32 conn_owner_nlportid;
5592 struct work_struct disconnect_wk;
5593 u8 disconnect_bssid[ETH_ALEN];
5595 struct list_head event_list;
5596 spinlock_t event_lock;
5598 struct cfg80211_internal_bss *current_bss; /* associated / joined */
5599 struct cfg80211_chan_def preset_chandef;
5600 struct cfg80211_chan_def chandef;
5603 bool ibss_dfs_possible;
5608 int beacon_interval;
5610 u32 ap_unexpected_nlportid;
5616 unsigned long cac_start_time;
5617 unsigned int cac_time_ms;
5619 #ifdef CONFIG_CFG80211_WEXT
5622 struct cfg80211_ibss_params ibss;
5623 struct cfg80211_connect_params connect;
5624 struct cfg80211_cached_keys *keys;
5628 u8 prev_bssid[ETH_ALEN];
5629 u8 ssid[IEEE80211_MAX_SSID_LEN];
5630 s8 default_key, default_mgmt_key;
5631 bool prev_bssid_valid;
5635 struct cfg80211_cqm_config *cqm_config;
5637 struct list_head pmsr_list;
5638 spinlock_t pmsr_lock;
5639 struct work_struct pmsr_free_wk;
5641 unsigned long unprot_beacon_reported;
5644 static inline const u8 *wdev_address(struct wireless_dev *wdev)
5647 return wdev->netdev->dev_addr;
5648 return wdev->address;
5651 static inline bool wdev_running(struct wireless_dev *wdev)
5654 return netif_running(wdev->netdev);
5655 return wdev->is_running;
5659 * wdev_priv - return wiphy priv from wireless_dev
5661 * @wdev: The wireless device whose wiphy's priv pointer to return
5662 * Return: The wiphy priv of @wdev.
5664 static inline void *wdev_priv(struct wireless_dev *wdev)
5667 return wiphy_priv(wdev->wiphy);
5671 * DOC: Utility functions
5673 * cfg80211 offers a number of utility functions that can be useful.
5677 * ieee80211_channel_equal - compare two struct ieee80211_channel
5679 * @a: 1st struct ieee80211_channel
5680 * @b: 2nd struct ieee80211_channel
5681 * Return: true if center frequency of @a == @b
5684 ieee80211_channel_equal(struct ieee80211_channel *a,
5685 struct ieee80211_channel *b)
5687 return (a->center_freq == b->center_freq &&
5688 a->freq_offset == b->freq_offset);
5692 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5693 * @chan: struct ieee80211_channel to convert
5694 * Return: The corresponding frequency (in KHz)
5697 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5699 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5703 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5705 * Only allowed for band NL80211_BAND_S1GHZ
5707 * Return: The allowed channel width for this center_freq
5709 enum nl80211_chan_width
5710 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5713 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5714 * @chan: channel number
5715 * @band: band, necessary due to channel number overlap
5716 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5718 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5721 * ieee80211_channel_to_frequency - convert channel number to frequency
5722 * @chan: channel number
5723 * @band: band, necessary due to channel number overlap
5724 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5727 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5729 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5733 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5734 * @freq: center frequency in KHz
5735 * Return: The corresponding channel, or 0 if the conversion failed.
5737 int ieee80211_freq_khz_to_channel(u32 freq);
5740 * ieee80211_frequency_to_channel - convert frequency to channel number
5741 * @freq: center frequency in MHz
5742 * Return: The corresponding channel, or 0 if the conversion failed.
5745 ieee80211_frequency_to_channel(int freq)
5747 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5751 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5753 * @wiphy: the struct wiphy to get the channel for
5754 * @freq: the center frequency (in KHz) of the channel
5755 * Return: The channel struct from @wiphy at @freq.
5757 struct ieee80211_channel *
5758 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5761 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5763 * @wiphy: the struct wiphy to get the channel for
5764 * @freq: the center frequency (in MHz) of the channel
5765 * Return: The channel struct from @wiphy at @freq.
5767 static inline struct ieee80211_channel *
5768 ieee80211_get_channel(struct wiphy *wiphy, int freq)
5770 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5774 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5775 * @chan: control channel to check
5777 * The Preferred Scanning Channels (PSC) are defined in
5778 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5780 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
5782 if (chan->band != NL80211_BAND_6GHZ)
5785 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
5789 * ieee80211_get_response_rate - get basic rate for a given rate
5791 * @sband: the band to look for rates in
5792 * @basic_rates: bitmap of basic rates
5793 * @bitrate: the bitrate for which to find the basic rate
5795 * Return: The basic rate corresponding to a given bitrate, that
5796 * is the next lower bitrate contained in the basic rate map,
5797 * which is, for this function, given as a bitmap of indices of
5798 * rates in the band's bitrate table.
5800 const struct ieee80211_rate *
5801 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5802 u32 basic_rates, int bitrate);
5805 * ieee80211_mandatory_rates - get mandatory rates for a given band
5806 * @sband: the band to look for rates in
5807 * @scan_width: width of the control channel
5809 * This function returns a bitmap of the mandatory rates for the given
5810 * band, bits are set according to the rate position in the bitrates array.
5812 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5813 enum nl80211_bss_scan_width scan_width);
5816 * Radiotap parsing functions -- for controlled injection support
5818 * Implemented in net/wireless/radiotap.c
5819 * Documentation in Documentation/networking/radiotap-headers.rst
5822 struct radiotap_align_size {
5823 uint8_t align:4, size:4;
5826 struct ieee80211_radiotap_namespace {
5827 const struct radiotap_align_size *align_size;
5833 struct ieee80211_radiotap_vendor_namespaces {
5834 const struct ieee80211_radiotap_namespace *ns;
5839 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5840 * @this_arg_index: index of current arg, valid after each successful call
5841 * to ieee80211_radiotap_iterator_next()
5842 * @this_arg: pointer to current radiotap arg; it is valid after each
5843 * call to ieee80211_radiotap_iterator_next() but also after
5844 * ieee80211_radiotap_iterator_init() where it will point to
5845 * the beginning of the actual data portion
5846 * @this_arg_size: length of the current arg, for convenience
5847 * @current_namespace: pointer to the current namespace definition
5848 * (or internally %NULL if the current namespace is unknown)
5849 * @is_radiotap_ns: indicates whether the current namespace is the default
5850 * radiotap namespace or not
5852 * @_rtheader: pointer to the radiotap header we are walking through
5853 * @_max_length: length of radiotap header in cpu byte ordering
5854 * @_arg_index: next argument index
5855 * @_arg: next argument pointer
5856 * @_next_bitmap: internal pointer to next present u32
5857 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5858 * @_vns: vendor namespace definitions
5859 * @_next_ns_data: beginning of the next namespace's data
5860 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5863 * Describes the radiotap parser state. Fields prefixed with an underscore
5864 * must not be used by users of the parser, only by the parser internally.
5867 struct ieee80211_radiotap_iterator {
5868 struct ieee80211_radiotap_header *_rtheader;
5869 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5870 const struct ieee80211_radiotap_namespace *current_namespace;
5872 unsigned char *_arg, *_next_ns_data;
5873 __le32 *_next_bitmap;
5875 unsigned char *this_arg;
5883 uint32_t _bitmap_shifter;
5888 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5889 struct ieee80211_radiotap_header *radiotap_header,
5891 const struct ieee80211_radiotap_vendor_namespaces *vns);
5894 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5897 extern const unsigned char rfc1042_header[6];
5898 extern const unsigned char bridge_tunnel_header[6];
5901 * ieee80211_get_hdrlen_from_skb - get header length from data
5905 * Given an skb with a raw 802.11 header at the data pointer this function
5906 * returns the 802.11 header length.
5908 * Return: The 802.11 header length in bytes (not including encryption
5909 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5912 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5915 * ieee80211_hdrlen - get header length in bytes from frame control
5916 * @fc: frame control field in little-endian format
5917 * Return: The header length in bytes.
5919 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5922 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5923 * @meshhdr: the mesh extension header, only the flags field
5924 * (first byte) will be accessed
5925 * Return: The length of the extension header, which is always at
5926 * least 6 bytes and at most 18 if address 5 and 6 are present.
5928 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5931 * DOC: Data path helpers
5933 * In addition to generic utilities, cfg80211 also offers
5934 * functions that help implement the data path for devices
5935 * that do not do the 802.11/802.3 conversion on the device.
5939 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5940 * @skb: the 802.11 data frame
5941 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5942 * of it being pushed into the SKB
5943 * @addr: the device MAC address
5944 * @iftype: the virtual interface type
5945 * @data_offset: offset of payload after the 802.11 header
5946 * Return: 0 on success. Non-zero on error.
5948 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5949 const u8 *addr, enum nl80211_iftype iftype,
5950 u8 data_offset, bool is_amsdu);
5953 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5954 * @skb: the 802.11 data frame
5955 * @addr: the device MAC address
5956 * @iftype: the virtual interface type
5957 * Return: 0 on success. Non-zero on error.
5959 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5960 enum nl80211_iftype iftype)
5962 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
5966 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5968 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5969 * The @list will be empty if the decode fails. The @skb must be fully
5970 * header-less before being passed in here; it is freed in this function.
5972 * @skb: The input A-MSDU frame without any headers.
5973 * @list: The output list of 802.3 frames. It must be allocated and
5974 * initialized by the caller.
5975 * @addr: The device MAC address.
5976 * @iftype: The device interface type.
5977 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5978 * @check_da: DA to check in the inner ethernet header, or NULL
5979 * @check_sa: SA to check in the inner ethernet header, or NULL
5981 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5982 const u8 *addr, enum nl80211_iftype iftype,
5983 const unsigned int extra_headroom,
5984 const u8 *check_da, const u8 *check_sa);
5987 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5988 * @skb: the data frame
5989 * @qos_map: Interworking QoS mapping or %NULL if not in use
5990 * Return: The 802.1p/1d tag.
5992 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5993 struct cfg80211_qos_map *qos_map);
5996 * cfg80211_find_elem_match - match information element and byte array in data
5999 * @ies: data consisting of IEs
6000 * @len: length of data
6001 * @match: byte array to match
6002 * @match_len: number of bytes in the match array
6003 * @match_offset: offset in the IE data where the byte array should match.
6004 * Note the difference to cfg80211_find_ie_match() which considers
6005 * the offset to start from the element ID byte, but here we take
6006 * the data portion instead.
6008 * Return: %NULL if the element ID could not be found or if
6009 * the element is invalid (claims to be longer than the given
6010 * data) or if the byte array doesn't match; otherwise return the
6011 * requested element struct.
6013 * Note: There are no checks on the element length other than
6014 * having to fit into the given data and being large enough for the
6015 * byte array to match.
6017 const struct element *
6018 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
6019 const u8 *match, unsigned int match_len,
6020 unsigned int match_offset);
6023 * cfg80211_find_ie_match - match information element and byte array in data
6026 * @ies: data consisting of IEs
6027 * @len: length of data
6028 * @match: byte array to match
6029 * @match_len: number of bytes in the match array
6030 * @match_offset: offset in the IE where the byte array should match.
6031 * If match_len is zero, this must also be set to zero.
6032 * Otherwise this must be set to 2 or more, because the first
6033 * byte is the element id, which is already compared to eid, and
6034 * the second byte is the IE length.
6036 * Return: %NULL if the element ID could not be found or if
6037 * the element is invalid (claims to be longer than the given
6038 * data) or if the byte array doesn't match, or a pointer to the first
6039 * byte of the requested element, that is the byte containing the
6042 * Note: There are no checks on the element length other than
6043 * having to fit into the given data and being large enough for the
6044 * byte array to match.
6046 static inline const u8 *
6047 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
6048 const u8 *match, unsigned int match_len,
6049 unsigned int match_offset)
6051 /* match_offset can't be smaller than 2, unless match_len is
6052 * zero, in which case match_offset must be zero as well.
6054 if (WARN_ON((match_len && match_offset < 2) ||
6055 (!match_len && match_offset)))
6058 return (const void *)cfg80211_find_elem_match(eid, ies, len,
6061 match_offset - 2 : 0);
6065 * cfg80211_find_elem - find information element in data
6068 * @ies: data consisting of IEs
6069 * @len: length of data
6071 * Return: %NULL if the element ID could not be found or if
6072 * the element is invalid (claims to be longer than the given
6073 * data) or if the byte array doesn't match; otherwise return the
6074 * requested element struct.
6076 * Note: There are no checks on the element length other than
6077 * having to fit into the given data.
6079 static inline const struct element *
6080 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
6082 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
6086 * cfg80211_find_ie - find information element in data
6089 * @ies: data consisting of IEs
6090 * @len: length of data
6092 * Return: %NULL if the element ID could not be found or if
6093 * the element is invalid (claims to be longer than the given
6094 * data), or a pointer to the first byte of the requested
6095 * element, that is the byte containing the element ID.
6097 * Note: There are no checks on the element length other than
6098 * having to fit into the given data.
6100 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
6102 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
6106 * cfg80211_find_ext_elem - find information element with EID Extension in data
6108 * @ext_eid: element ID Extension
6109 * @ies: data consisting of IEs
6110 * @len: length of data
6112 * Return: %NULL if the etended element could not be found or if
6113 * the element is invalid (claims to be longer than the given
6114 * data) or if the byte array doesn't match; otherwise return the
6115 * requested element struct.
6117 * Note: There are no checks on the element length other than
6118 * having to fit into the given data.
6120 static inline const struct element *
6121 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
6123 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
6128 * cfg80211_find_ext_ie - find information element with EID Extension in data
6130 * @ext_eid: element ID Extension
6131 * @ies: data consisting of IEs
6132 * @len: length of data
6134 * Return: %NULL if the extended element ID could not be found or if
6135 * the element is invalid (claims to be longer than the given
6136 * data), or a pointer to the first byte of the requested
6137 * element, that is the byte containing the element ID.
6139 * Note: There are no checks on the element length other than
6140 * having to fit into the given data.
6142 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
6144 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
6149 * cfg80211_find_vendor_elem - find vendor specific information element in data
6152 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6153 * @ies: data consisting of IEs
6154 * @len: length of data
6156 * Return: %NULL if the vendor specific element ID could not be found or if the
6157 * element is invalid (claims to be longer than the given data); otherwise
6158 * return the element structure for the requested element.
6160 * Note: There are no checks on the element length other than having to fit into
6163 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
6168 * cfg80211_find_vendor_ie - find vendor specific information element in data
6171 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6172 * @ies: data consisting of IEs
6173 * @len: length of data
6175 * Return: %NULL if the vendor specific element ID could not be found or if the
6176 * element is invalid (claims to be longer than the given data), or a pointer to
6177 * the first byte of the requested element, that is the byte containing the
6180 * Note: There are no checks on the element length other than having to fit into
6183 static inline const u8 *
6184 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
6185 const u8 *ies, unsigned int len)
6187 return (const void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
6191 * cfg80211_send_layer2_update - send layer 2 update frame
6193 * @dev: network device
6194 * @addr: STA MAC address
6196 * Wireless drivers can use this function to update forwarding tables in bridge
6197 * devices upon STA association.
6199 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
6202 * DOC: Regulatory enforcement infrastructure
6208 * regulatory_hint - driver hint to the wireless core a regulatory domain
6209 * @wiphy: the wireless device giving the hint (used only for reporting
6211 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
6212 * should be in. If @rd is set this should be NULL. Note that if you
6213 * set this to NULL you should still set rd->alpha2 to some accepted
6216 * Wireless drivers can use this function to hint to the wireless core
6217 * what it believes should be the current regulatory domain by
6218 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
6219 * domain should be in or by providing a completely build regulatory domain.
6220 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
6221 * for a regulatory domain structure for the respective country.
6223 * The wiphy must have been registered to cfg80211 prior to this call.
6224 * For cfg80211 drivers this means you must first use wiphy_register(),
6225 * for mac80211 drivers you must first use ieee80211_register_hw().
6227 * Drivers should check the return value, its possible you can get
6230 * Return: 0 on success. -ENOMEM.
6232 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
6235 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
6236 * @wiphy: the wireless device we want to process the regulatory domain on
6237 * @rd: the regulatory domain informatoin to use for this wiphy
6239 * Set the regulatory domain information for self-managed wiphys, only they
6240 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
6243 * Return: 0 on success. -EINVAL, -EPERM
6245 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
6246 struct ieee80211_regdomain *rd);
6249 * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
6250 * @wiphy: the wireless device we want to process the regulatory domain on
6251 * @rd: the regulatory domain information to use for this wiphy
6253 * This functions requires the RTNL and the wiphy mutex to be held and
6254 * applies the new regdomain synchronously to this wiphy. For more details
6255 * see regulatory_set_wiphy_regd().
6257 * Return: 0 on success. -EINVAL, -EPERM
6259 int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
6260 struct ieee80211_regdomain *rd);
6263 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
6264 * @wiphy: the wireless device we want to process the regulatory domain on
6265 * @regd: the custom regulatory domain to use for this wiphy
6267 * Drivers can sometimes have custom regulatory domains which do not apply
6268 * to a specific country. Drivers can use this to apply such custom regulatory
6269 * domains. This routine must be called prior to wiphy registration. The
6270 * custom regulatory domain will be trusted completely and as such previous
6271 * default channel settings will be disregarded. If no rule is found for a
6272 * channel on the regulatory domain the channel will be disabled.
6273 * Drivers using this for a wiphy should also set the wiphy flag
6274 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
6275 * that called this helper.
6277 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
6278 const struct ieee80211_regdomain *regd);
6281 * freq_reg_info - get regulatory information for the given frequency
6282 * @wiphy: the wiphy for which we want to process this rule for
6283 * @center_freq: Frequency in KHz for which we want regulatory information for
6285 * Use this function to get the regulatory rule for a specific frequency on
6286 * a given wireless device. If the device has a specific regulatory domain
6287 * it wants to follow we respect that unless a country IE has been received
6288 * and processed already.
6290 * Return: A valid pointer, or, when an error occurs, for example if no rule
6291 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
6292 * check and PTR_ERR() to obtain the numeric return value. The numeric return
6293 * value will be -ERANGE if we determine the given center_freq does not even
6294 * have a regulatory rule for a frequency range in the center_freq's band.
6295 * See freq_in_rule_band() for our current definition of a band -- this is
6296 * purely subjective and right now it's 802.11 specific.
6298 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
6302 * reg_initiator_name - map regulatory request initiator enum to name
6303 * @initiator: the regulatory request initiator
6305 * You can use this to map the regulatory request initiator enum to a
6306 * proper string representation.
6308 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
6311 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
6312 * @wiphy: wiphy for which pre-CAC capability is checked.
6314 * Pre-CAC is allowed only in some regdomains (notable ETSI).
6316 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
6319 * DOC: Internal regulatory db functions
6324 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6325 * Regulatory self-managed driver can use it to proactively
6327 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6328 * @freq: the freqency(in MHz) to be queried.
6329 * @rule: pointer to store the wmm rule from the regulatory db.
6331 * Self-managed wireless drivers can use this function to query
6332 * the internal regulatory database to check whether the given
6333 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6335 * Drivers should check the return value, its possible you can get
6338 * Return: 0 on success. -ENODATA.
6340 int reg_query_regdb_wmm(char *alpha2, int freq,
6341 struct ieee80211_reg_rule *rule);
6344 * callbacks for asynchronous cfg80211 methods, notification
6345 * functions and BSS handling helpers
6349 * cfg80211_scan_done - notify that scan finished
6351 * @request: the corresponding scan request
6352 * @info: information about the completed scan
6354 void cfg80211_scan_done(struct cfg80211_scan_request *request,
6355 struct cfg80211_scan_info *info);
6358 * cfg80211_sched_scan_results - notify that new scan results are available
6360 * @wiphy: the wiphy which got scheduled scan results
6361 * @reqid: identifier for the related scheduled scan request
6363 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6366 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6368 * @wiphy: the wiphy on which the scheduled scan stopped
6369 * @reqid: identifier for the related scheduled scan request
6371 * The driver can call this function to inform cfg80211 that the
6372 * scheduled scan had to be stopped, for whatever reason. The driver
6373 * is then called back via the sched_scan_stop operation when done.
6375 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6378 * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
6380 * @wiphy: the wiphy on which the scheduled scan stopped
6381 * @reqid: identifier for the related scheduled scan request
6383 * The driver can call this function to inform cfg80211 that the
6384 * scheduled scan had to be stopped, for whatever reason. The driver
6385 * is then called back via the sched_scan_stop operation when done.
6386 * This function should be called with the wiphy mutex held.
6388 void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
6391 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6392 * @wiphy: the wiphy reporting the BSS
6393 * @data: the BSS metadata
6394 * @mgmt: the management frame (probe response or beacon)
6395 * @len: length of the management frame
6396 * @gfp: context flags
6398 * This informs cfg80211 that BSS information was found and
6399 * the BSS should be updated/added.
6401 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6402 * Or %NULL on error.
6404 struct cfg80211_bss * __must_check
6405 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
6406 struct cfg80211_inform_bss *data,
6407 struct ieee80211_mgmt *mgmt, size_t len,
6410 static inline struct cfg80211_bss * __must_check
6411 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6412 struct ieee80211_channel *rx_channel,
6413 enum nl80211_bss_scan_width scan_width,
6414 struct ieee80211_mgmt *mgmt, size_t len,
6415 s32 signal, gfp_t gfp)
6417 struct cfg80211_inform_bss data = {
6419 .scan_width = scan_width,
6423 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6426 static inline struct cfg80211_bss * __must_check
6427 cfg80211_inform_bss_frame(struct wiphy *wiphy,
6428 struct ieee80211_channel *rx_channel,
6429 struct ieee80211_mgmt *mgmt, size_t len,
6430 s32 signal, gfp_t gfp)
6432 struct cfg80211_inform_bss data = {
6434 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6438 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6442 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6443 * @bssid: transmitter BSSID
6444 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6445 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6446 * @new_bssid: calculated nontransmitted BSSID
6448 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6449 u8 mbssid_index, u8 *new_bssid)
6451 u64 bssid_u64 = ether_addr_to_u64(bssid);
6452 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6455 new_bssid_u64 = bssid_u64 & ~mask;
6457 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6459 u64_to_ether_addr(new_bssid_u64, new_bssid);
6463 * cfg80211_is_element_inherited - returns if element ID should be inherited
6464 * @element: element to check
6465 * @non_inherit_element: non inheritance element
6467 bool cfg80211_is_element_inherited(const struct element *element,
6468 const struct element *non_inherit_element);
6471 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6473 * @ielen: length of IEs
6474 * @mbssid_elem: current MBSSID element
6475 * @sub_elem: current MBSSID subelement (profile)
6476 * @merged_ie: location of the merged profile
6477 * @max_copy_len: max merged profile length
6479 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6480 const struct element *mbssid_elem,
6481 const struct element *sub_elem,
6482 u8 *merged_ie, size_t max_copy_len);
6485 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6486 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6487 * from a beacon or probe response
6488 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6489 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6491 enum cfg80211_bss_frame_type {
6492 CFG80211_BSS_FTYPE_UNKNOWN,
6493 CFG80211_BSS_FTYPE_BEACON,
6494 CFG80211_BSS_FTYPE_PRESP,
6498 * cfg80211_get_ies_channel_number - returns the channel number from ies
6500 * @ielen: length of IEs
6501 * @band: enum nl80211_band of the channel
6502 * @ftype: frame type
6504 * Returns the channel number, or -1 if none could be determined.
6506 int cfg80211_get_ies_channel_number(const u8 *ie, size_t ielen,
6507 enum nl80211_band band,
6508 enum cfg80211_bss_frame_type ftype);
6511 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6513 * @wiphy: the wiphy reporting the BSS
6514 * @data: the BSS metadata
6515 * @ftype: frame type (if known)
6516 * @bssid: the BSSID of the BSS
6517 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6518 * @capability: the capability field sent by the peer
6519 * @beacon_interval: the beacon interval announced by the peer
6520 * @ie: additional IEs sent by the peer
6521 * @ielen: length of the additional IEs
6522 * @gfp: context flags
6524 * This informs cfg80211 that BSS information was found and
6525 * the BSS should be updated/added.
6527 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6528 * Or %NULL on error.
6530 struct cfg80211_bss * __must_check
6531 cfg80211_inform_bss_data(struct wiphy *wiphy,
6532 struct cfg80211_inform_bss *data,
6533 enum cfg80211_bss_frame_type ftype,
6534 const u8 *bssid, u64 tsf, u16 capability,
6535 u16 beacon_interval, const u8 *ie, size_t ielen,
6538 static inline struct cfg80211_bss * __must_check
6539 cfg80211_inform_bss_width(struct wiphy *wiphy,
6540 struct ieee80211_channel *rx_channel,
6541 enum nl80211_bss_scan_width scan_width,
6542 enum cfg80211_bss_frame_type ftype,
6543 const u8 *bssid, u64 tsf, u16 capability,
6544 u16 beacon_interval, const u8 *ie, size_t ielen,
6545 s32 signal, gfp_t gfp)
6547 struct cfg80211_inform_bss data = {
6549 .scan_width = scan_width,
6553 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6554 capability, beacon_interval, ie, ielen,
6558 static inline struct cfg80211_bss * __must_check
6559 cfg80211_inform_bss(struct wiphy *wiphy,
6560 struct ieee80211_channel *rx_channel,
6561 enum cfg80211_bss_frame_type ftype,
6562 const u8 *bssid, u64 tsf, u16 capability,
6563 u16 beacon_interval, const u8 *ie, size_t ielen,
6564 s32 signal, gfp_t gfp)
6566 struct cfg80211_inform_bss data = {
6568 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6572 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6573 capability, beacon_interval, ie, ielen,
6578 * cfg80211_get_bss - get a BSS reference
6579 * @wiphy: the wiphy this BSS struct belongs to
6580 * @channel: the channel to search on (or %NULL)
6581 * @bssid: the desired BSSID (or %NULL)
6582 * @ssid: the desired SSID (or %NULL)
6583 * @ssid_len: length of the SSID (or 0)
6584 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6585 * @privacy: privacy filter, see &enum ieee80211_privacy
6587 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6588 struct ieee80211_channel *channel,
6590 const u8 *ssid, size_t ssid_len,
6591 enum ieee80211_bss_type bss_type,
6592 enum ieee80211_privacy privacy);
6593 static inline struct cfg80211_bss *
6594 cfg80211_get_ibss(struct wiphy *wiphy,
6595 struct ieee80211_channel *channel,
6596 const u8 *ssid, size_t ssid_len)
6598 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6599 IEEE80211_BSS_TYPE_IBSS,
6600 IEEE80211_PRIVACY_ANY);
6604 * cfg80211_ref_bss - reference BSS struct
6605 * @wiphy: the wiphy this BSS struct belongs to
6606 * @bss: the BSS struct to reference
6608 * Increments the refcount of the given BSS struct.
6610 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6613 * cfg80211_put_bss - unref BSS struct
6614 * @wiphy: the wiphy this BSS struct belongs to
6615 * @bss: the BSS struct
6617 * Decrements the refcount of the given BSS struct.
6619 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6622 * cfg80211_unlink_bss - unlink BSS from internal data structures
6624 * @bss: the bss to remove
6626 * This function removes the given BSS from the internal data structures
6627 * thereby making it no longer show up in scan results etc. Use this
6628 * function when you detect a BSS is gone. Normally BSSes will also time
6629 * out, so it is not necessary to use this function at all.
6631 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6634 * cfg80211_bss_iter - iterate all BSS entries
6636 * This function iterates over the BSS entries associated with the given wiphy
6637 * and calls the callback for the iterated BSS. The iterator function is not
6638 * allowed to call functions that might modify the internal state of the BSS DB.
6641 * @chandef: if given, the iterator function will be called only if the channel
6642 * of the currently iterated BSS is a subset of the given channel.
6643 * @iter: the iterator function to call
6644 * @iter_data: an argument to the iterator function
6646 void cfg80211_bss_iter(struct wiphy *wiphy,
6647 struct cfg80211_chan_def *chandef,
6648 void (*iter)(struct wiphy *wiphy,
6649 struct cfg80211_bss *bss,
6653 static inline enum nl80211_bss_scan_width
6654 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6656 switch (chandef->width) {
6657 case NL80211_CHAN_WIDTH_5:
6658 return NL80211_BSS_CHAN_WIDTH_5;
6659 case NL80211_CHAN_WIDTH_10:
6660 return NL80211_BSS_CHAN_WIDTH_10;
6662 return NL80211_BSS_CHAN_WIDTH_20;
6667 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6668 * @dev: network device
6669 * @buf: authentication frame (header + body)
6670 * @len: length of the frame data
6672 * This function is called whenever an authentication, disassociation or
6673 * deauthentication frame has been received and processed in station mode.
6674 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6675 * call either this function or cfg80211_auth_timeout().
6676 * After being asked to associate via cfg80211_ops::assoc() the driver must
6677 * call either this function or cfg80211_auth_timeout().
6678 * While connected, the driver must calls this for received and processed
6679 * disassociation and deauthentication frames. If the frame couldn't be used
6680 * because it was unprotected, the driver must call the function
6681 * cfg80211_rx_unprot_mlme_mgmt() instead.
6683 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6685 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6688 * cfg80211_auth_timeout - notification of timed out authentication
6689 * @dev: network device
6690 * @addr: The MAC address of the device with which the authentication timed out
6692 * This function may sleep. The caller must hold the corresponding wdev's
6695 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6698 * cfg80211_rx_assoc_resp - notification of processed association response
6699 * @dev: network device
6700 * @bss: the BSS that association was requested with, ownership of the pointer
6701 * moves to cfg80211 in this call
6702 * @buf: (Re)Association Response frame (header + body)
6703 * @len: length of the frame data
6704 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6705 * as the AC bitmap in the QoS info field
6706 * @req_ies: information elements from the (Re)Association Request frame
6707 * @req_ies_len: length of req_ies data
6709 * After being asked to associate via cfg80211_ops::assoc() the driver must
6710 * call either this function or cfg80211_auth_timeout().
6712 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6714 void cfg80211_rx_assoc_resp(struct net_device *dev,
6715 struct cfg80211_bss *bss,
6716 const u8 *buf, size_t len,
6718 const u8 *req_ies, size_t req_ies_len);
6721 * cfg80211_assoc_timeout - notification of timed out association
6722 * @dev: network device
6723 * @bss: The BSS entry with which association timed out.
6725 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6727 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6730 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6731 * @dev: network device
6732 * @bss: The BSS entry with which association was abandoned.
6734 * Call this whenever - for reasons reported through other API, like deauth RX,
6735 * an association attempt was abandoned.
6736 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6738 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6741 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6742 * @dev: network device
6743 * @buf: 802.11 frame (header + body)
6744 * @len: length of the frame data
6745 * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
6747 * This function is called whenever deauthentication has been processed in
6748 * station mode. This includes both received deauthentication frames and
6749 * locally generated ones. This function may sleep. The caller must hold the
6750 * corresponding wdev's mutex.
6752 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
6756 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6757 * @dev: network device
6758 * @buf: received management frame (header + body)
6759 * @len: length of the frame data
6761 * This function is called whenever a received deauthentication or dissassoc
6762 * frame has been dropped in station mode because of MFP being used but the
6763 * frame was not protected. This is also used to notify reception of a Beacon
6764 * frame that was dropped because it did not include a valid MME MIC while
6765 * beacon protection was enabled (BIGTK configured in station mode).
6767 * This function may sleep.
6769 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6770 const u8 *buf, size_t len);
6773 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6774 * @dev: network device
6775 * @addr: The source MAC address of the frame
6776 * @key_type: The key type that the received frame used
6777 * @key_id: Key identifier (0..3). Can be -1 if missing.
6778 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6779 * @gfp: allocation flags
6781 * This function is called whenever the local MAC detects a MIC failure in a
6782 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6785 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6786 enum nl80211_key_type key_type, int key_id,
6787 const u8 *tsc, gfp_t gfp);
6790 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6792 * @dev: network device
6793 * @bssid: the BSSID of the IBSS joined
6794 * @channel: the channel of the IBSS joined
6795 * @gfp: allocation flags
6797 * This function notifies cfg80211 that the device joined an IBSS or
6798 * switched to a different BSSID. Before this function can be called,
6799 * either a beacon has to have been received from the IBSS, or one of
6800 * the cfg80211_inform_bss{,_frame} functions must have been called
6801 * with the locally generated beacon -- this guarantees that there is
6802 * always a scan result for this IBSS. cfg80211 will handle the rest.
6804 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6805 struct ieee80211_channel *channel, gfp_t gfp);
6808 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
6811 * @dev: network device
6812 * @macaddr: the MAC address of the new candidate
6813 * @ie: information elements advertised by the peer candidate
6814 * @ie_len: length of the information elements buffer
6815 * @gfp: allocation flags
6817 * This function notifies cfg80211 that the mesh peer candidate has been
6818 * detected, most likely via a beacon or, less likely, via a probe response.
6819 * cfg80211 then sends a notification to userspace.
6821 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6822 const u8 *macaddr, const u8 *ie, u8 ie_len,
6823 int sig_dbm, gfp_t gfp);
6826 * DOC: RFkill integration
6828 * RFkill integration in cfg80211 is almost invisible to drivers,
6829 * as cfg80211 automatically registers an rfkill instance for each
6830 * wireless device it knows about. Soft kill is also translated
6831 * into disconnecting and turning all interfaces off, drivers are
6832 * expected to turn off the device when all interfaces are down.
6834 * However, devices may have a hard RFkill line, in which case they
6835 * also need to interact with the rfkill subsystem, via cfg80211.
6836 * They can do this with a few helper functions documented here.
6840 * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
6842 * @blocked: block status
6843 * @reason: one of reasons in &enum rfkill_hard_block_reasons
6845 void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
6846 enum rfkill_hard_block_reasons reason);
6848 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
6850 wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
6851 RFKILL_HARD_BLOCK_SIGNAL);
6855 * wiphy_rfkill_start_polling - start polling rfkill
6858 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6861 * wiphy_rfkill_stop_polling - stop polling rfkill
6864 static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy)
6866 rfkill_pause_polling(wiphy->rfkill);
6870 * DOC: Vendor commands
6872 * Occasionally, there are special protocol or firmware features that
6873 * can't be implemented very openly. For this and similar cases, the
6874 * vendor command functionality allows implementing the features with
6875 * (typically closed-source) userspace and firmware, using nl80211 as
6876 * the configuration mechanism.
6878 * A driver supporting vendor commands must register them as an array
6879 * in struct wiphy, with handlers for each one, each command has an
6880 * OUI and sub command ID to identify it.
6882 * Note that this feature should not be (ab)used to implement protocol
6883 * features that could openly be shared across drivers. In particular,
6884 * it must never be required to use vendor commands to implement any
6885 * "normal" functionality that higher-level userspace like connection
6886 * managers etc. need.
6889 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6890 enum nl80211_commands cmd,
6891 enum nl80211_attrs attr,
6894 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6895 struct wireless_dev *wdev,
6896 enum nl80211_commands cmd,
6897 enum nl80211_attrs attr,
6898 unsigned int portid,
6899 int vendor_event_idx,
6900 int approxlen, gfp_t gfp);
6902 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6905 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6907 * @approxlen: an upper bound of the length of the data that will
6908 * be put into the skb
6910 * This function allocates and pre-fills an skb for a reply to
6911 * a vendor command. Since it is intended for a reply, calling
6912 * it outside of a vendor command's doit() operation is invalid.
6914 * The returned skb is pre-filled with some identifying data in
6915 * a way that any data that is put into the skb (with skb_put(),
6916 * nla_put() or similar) will end up being within the
6917 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6918 * with the skb is adding data for the corresponding userspace tool
6919 * which can then read that data out of the vendor data attribute.
6920 * You must not modify the skb in any other way.
6922 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6923 * its error code as the result of the doit() operation.
6925 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6927 static inline struct sk_buff *
6928 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6930 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6931 NL80211_ATTR_VENDOR_DATA, approxlen);
6935 * cfg80211_vendor_cmd_reply - send the reply skb
6936 * @skb: The skb, must have been allocated with
6937 * cfg80211_vendor_cmd_alloc_reply_skb()
6939 * Since calling this function will usually be the last thing
6940 * before returning from the vendor command doit() you should
6941 * return the error code. Note that this function consumes the
6942 * skb regardless of the return value.
6944 * Return: An error code or 0 on success.
6946 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6949 * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
6952 * Return the current netlink port ID in a vendor command handler.
6953 * Valid to call only there.
6955 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6958 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6960 * @wdev: the wireless device
6961 * @event_idx: index of the vendor event in the wiphy's vendor_events
6962 * @approxlen: an upper bound of the length of the data that will
6963 * be put into the skb
6964 * @gfp: allocation flags
6966 * This function allocates and pre-fills an skb for an event on the
6967 * vendor-specific multicast group.
6969 * If wdev != NULL, both the ifindex and identifier of the specified
6970 * wireless device are added to the event message before the vendor data
6973 * When done filling the skb, call cfg80211_vendor_event() with the
6974 * skb to send the event.
6976 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6978 static inline struct sk_buff *
6979 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6980 int approxlen, int event_idx, gfp_t gfp)
6982 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6983 NL80211_ATTR_VENDOR_DATA,
6984 0, event_idx, approxlen, gfp);
6988 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6990 * @wdev: the wireless device
6991 * @event_idx: index of the vendor event in the wiphy's vendor_events
6992 * @portid: port ID of the receiver
6993 * @approxlen: an upper bound of the length of the data that will
6994 * be put into the skb
6995 * @gfp: allocation flags
6997 * This function allocates and pre-fills an skb for an event to send to
6998 * a specific (userland) socket. This socket would previously have been
6999 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
7000 * care to register a netlink notifier to see when the socket closes.
7002 * If wdev != NULL, both the ifindex and identifier of the specified
7003 * wireless device are added to the event message before the vendor data
7006 * When done filling the skb, call cfg80211_vendor_event() with the
7007 * skb to send the event.
7009 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7011 static inline struct sk_buff *
7012 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
7013 struct wireless_dev *wdev,
7014 unsigned int portid, int approxlen,
7015 int event_idx, gfp_t gfp)
7017 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
7018 NL80211_ATTR_VENDOR_DATA,
7019 portid, event_idx, approxlen, gfp);
7023 * cfg80211_vendor_event - send the event
7024 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
7025 * @gfp: allocation flags
7027 * This function sends the given @skb, which must have been allocated
7028 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
7030 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
7032 __cfg80211_send_event_skb(skb, gfp);
7035 #ifdef CONFIG_NL80211_TESTMODE
7039 * Test mode is a set of utility functions to allow drivers to
7040 * interact with driver-specific tools to aid, for instance,
7041 * factory programming.
7043 * This chapter describes how drivers interact with it, for more
7044 * information see the nl80211 book's chapter on it.
7048 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
7050 * @approxlen: an upper bound of the length of the data that will
7051 * be put into the skb
7053 * This function allocates and pre-fills an skb for a reply to
7054 * the testmode command. Since it is intended for a reply, calling
7055 * it outside of the @testmode_cmd operation is invalid.
7057 * The returned skb is pre-filled with the wiphy index and set up in
7058 * a way that any data that is put into the skb (with skb_put(),
7059 * nla_put() or similar) will end up being within the
7060 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
7061 * with the skb is adding data for the corresponding userspace tool
7062 * which can then read that data out of the testdata attribute. You
7063 * must not modify the skb in any other way.
7065 * When done, call cfg80211_testmode_reply() with the skb and return
7066 * its error code as the result of the @testmode_cmd operation.
7068 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7070 static inline struct sk_buff *
7071 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
7073 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
7074 NL80211_ATTR_TESTDATA, approxlen);
7078 * cfg80211_testmode_reply - send the reply skb
7079 * @skb: The skb, must have been allocated with
7080 * cfg80211_testmode_alloc_reply_skb()
7082 * Since calling this function will usually be the last thing
7083 * before returning from the @testmode_cmd you should return
7084 * the error code. Note that this function consumes the skb
7085 * regardless of the return value.
7087 * Return: An error code or 0 on success.
7089 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
7091 return cfg80211_vendor_cmd_reply(skb);
7095 * cfg80211_testmode_alloc_event_skb - allocate testmode event
7097 * @approxlen: an upper bound of the length of the data that will
7098 * be put into the skb
7099 * @gfp: allocation flags
7101 * This function allocates and pre-fills an skb for an event on the
7102 * testmode multicast group.
7104 * The returned skb is set up in the same way as with
7105 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
7106 * there, you should simply add data to it that will then end up in the
7107 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
7110 * When done filling the skb, call cfg80211_testmode_event() with the
7111 * skb to send the event.
7113 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7115 static inline struct sk_buff *
7116 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
7118 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
7119 NL80211_ATTR_TESTDATA, 0, -1,
7124 * cfg80211_testmode_event - send the event
7125 * @skb: The skb, must have been allocated with
7126 * cfg80211_testmode_alloc_event_skb()
7127 * @gfp: allocation flags
7129 * This function sends the given @skb, which must have been allocated
7130 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
7133 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
7135 __cfg80211_send_event_skb(skb, gfp);
7138 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
7139 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
7141 #define CFG80211_TESTMODE_CMD(cmd)
7142 #define CFG80211_TESTMODE_DUMP(cmd)
7146 * struct cfg80211_fils_resp_params - FILS connection response params
7147 * @kek: KEK derived from a successful FILS connection (may be %NULL)
7148 * @kek_len: Length of @fils_kek in octets
7149 * @update_erp_next_seq_num: Boolean value to specify whether the value in
7150 * @erp_next_seq_num is valid.
7151 * @erp_next_seq_num: The next sequence number to use in ERP message in
7152 * FILS Authentication. This value should be specified irrespective of the
7153 * status for a FILS connection.
7154 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
7155 * @pmk_len: Length of @pmk in octets
7156 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
7157 * used for this FILS connection (may be %NULL).
7159 struct cfg80211_fils_resp_params {
7162 bool update_erp_next_seq_num;
7163 u16 erp_next_seq_num;
7170 * struct cfg80211_connect_resp_params - Connection response params
7171 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
7172 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7173 * the real status code for failures. If this call is used to report a
7174 * failure due to a timeout (e.g., not receiving an Authentication frame
7175 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7176 * indicate that this is a failure, but without a status code.
7177 * @timeout_reason is used to report the reason for the timeout in that
7179 * @bssid: The BSSID of the AP (may be %NULL)
7180 * @bss: Entry of bss to which STA got connected to, can be obtained through
7181 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7182 * bss from the connect_request and hold a reference to it and return
7183 * through this param to avoid a warning if the bss is expired during the
7184 * connection, esp. for those drivers implementing connect op.
7185 * Only one parameter among @bssid and @bss needs to be specified.
7186 * @req_ie: Association request IEs (may be %NULL)
7187 * @req_ie_len: Association request IEs length
7188 * @resp_ie: Association response IEs (may be %NULL)
7189 * @resp_ie_len: Association response IEs length
7190 * @fils: FILS connection response parameters.
7191 * @timeout_reason: Reason for connection timeout. This is used when the
7192 * connection fails due to a timeout instead of an explicit rejection from
7193 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7194 * not known. This value is used only if @status < 0 to indicate that the
7195 * failure is due to a timeout and not due to explicit rejection by the AP.
7196 * This value is ignored in other cases (@status >= 0).
7198 struct cfg80211_connect_resp_params {
7201 struct cfg80211_bss *bss;
7206 struct cfg80211_fils_resp_params fils;
7207 enum nl80211_timeout_reason timeout_reason;
7211 * cfg80211_connect_done - notify cfg80211 of connection result
7213 * @dev: network device
7214 * @params: connection response parameters
7215 * @gfp: allocation flags
7217 * It should be called by the underlying driver once execution of the connection
7218 * request from connect() has been completed. This is similar to
7219 * cfg80211_connect_bss(), but takes a structure pointer for connection response
7220 * parameters. Only one of the functions among cfg80211_connect_bss(),
7221 * cfg80211_connect_result(), cfg80211_connect_timeout(),
7222 * and cfg80211_connect_done() should be called.
7224 void cfg80211_connect_done(struct net_device *dev,
7225 struct cfg80211_connect_resp_params *params,
7229 * cfg80211_connect_bss - notify cfg80211 of connection result
7231 * @dev: network device
7232 * @bssid: the BSSID of the AP
7233 * @bss: Entry of bss to which STA got connected to, can be obtained through
7234 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7235 * bss from the connect_request and hold a reference to it and return
7236 * through this param to avoid a warning if the bss is expired during the
7237 * connection, esp. for those drivers implementing connect op.
7238 * Only one parameter among @bssid and @bss needs to be specified.
7239 * @req_ie: association request IEs (maybe be %NULL)
7240 * @req_ie_len: association request IEs length
7241 * @resp_ie: association response IEs (may be %NULL)
7242 * @resp_ie_len: assoc response IEs length
7243 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7244 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7245 * the real status code for failures. If this call is used to report a
7246 * failure due to a timeout (e.g., not receiving an Authentication frame
7247 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7248 * indicate that this is a failure, but without a status code.
7249 * @timeout_reason is used to report the reason for the timeout in that
7251 * @gfp: allocation flags
7252 * @timeout_reason: reason for connection timeout. This is used when the
7253 * connection fails due to a timeout instead of an explicit rejection from
7254 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7255 * not known. This value is used only if @status < 0 to indicate that the
7256 * failure is due to a timeout and not due to explicit rejection by the AP.
7257 * This value is ignored in other cases (@status >= 0).
7259 * It should be called by the underlying driver once execution of the connection
7260 * request from connect() has been completed. This is similar to
7261 * cfg80211_connect_result(), but with the option of identifying the exact bss
7262 * entry for the connection. Only one of the functions among
7263 * cfg80211_connect_bss(), cfg80211_connect_result(),
7264 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7267 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
7268 struct cfg80211_bss *bss, const u8 *req_ie,
7269 size_t req_ie_len, const u8 *resp_ie,
7270 size_t resp_ie_len, int status, gfp_t gfp,
7271 enum nl80211_timeout_reason timeout_reason)
7273 struct cfg80211_connect_resp_params params;
7275 memset(¶ms, 0, sizeof(params));
7276 params.status = status;
7277 params.bssid = bssid;
7279 params.req_ie = req_ie;
7280 params.req_ie_len = req_ie_len;
7281 params.resp_ie = resp_ie;
7282 params.resp_ie_len = resp_ie_len;
7283 params.timeout_reason = timeout_reason;
7285 cfg80211_connect_done(dev, ¶ms, gfp);
7289 * cfg80211_connect_result - notify cfg80211 of connection result
7291 * @dev: network device
7292 * @bssid: the BSSID of the AP
7293 * @req_ie: association request IEs (maybe be %NULL)
7294 * @req_ie_len: association request IEs length
7295 * @resp_ie: association response IEs (may be %NULL)
7296 * @resp_ie_len: assoc response IEs length
7297 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7298 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7299 * the real status code for failures.
7300 * @gfp: allocation flags
7302 * It should be called by the underlying driver once execution of the connection
7303 * request from connect() has been completed. This is similar to
7304 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
7305 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
7306 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7309 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
7310 const u8 *req_ie, size_t req_ie_len,
7311 const u8 *resp_ie, size_t resp_ie_len,
7312 u16 status, gfp_t gfp)
7314 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
7315 resp_ie_len, status, gfp,
7316 NL80211_TIMEOUT_UNSPECIFIED);
7320 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
7322 * @dev: network device
7323 * @bssid: the BSSID of the AP
7324 * @req_ie: association request IEs (maybe be %NULL)
7325 * @req_ie_len: association request IEs length
7326 * @gfp: allocation flags
7327 * @timeout_reason: reason for connection timeout.
7329 * It should be called by the underlying driver whenever connect() has failed
7330 * in a sequence where no explicit authentication/association rejection was
7331 * received from the AP. This could happen, e.g., due to not being able to send
7332 * out the Authentication or Association Request frame or timing out while
7333 * waiting for the response. Only one of the functions among
7334 * cfg80211_connect_bss(), cfg80211_connect_result(),
7335 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7338 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
7339 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
7340 enum nl80211_timeout_reason timeout_reason)
7342 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
7343 gfp, timeout_reason);
7347 * struct cfg80211_roam_info - driver initiated roaming information
7349 * @channel: the channel of the new AP
7350 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
7351 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
7352 * @req_ie: association request IEs (maybe be %NULL)
7353 * @req_ie_len: association request IEs length
7354 * @resp_ie: association response IEs (may be %NULL)
7355 * @resp_ie_len: assoc response IEs length
7356 * @fils: FILS related roaming information.
7358 struct cfg80211_roam_info {
7359 struct ieee80211_channel *channel;
7360 struct cfg80211_bss *bss;
7366 struct cfg80211_fils_resp_params fils;
7370 * cfg80211_roamed - notify cfg80211 of roaming
7372 * @dev: network device
7373 * @info: information about the new BSS. struct &cfg80211_roam_info.
7374 * @gfp: allocation flags
7376 * This function may be called with the driver passing either the BSSID of the
7377 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7378 * It should be called by the underlying driver whenever it roamed from one AP
7379 * to another while connected. Drivers which have roaming implemented in
7380 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7381 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7382 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7383 * rdev->event_work. In case of any failures, the reference is released
7384 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7385 * released while disconnecting from the current bss.
7387 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7391 * cfg80211_port_authorized - notify cfg80211 of successful security association
7393 * @dev: network device
7394 * @bssid: the BSSID of the AP
7395 * @gfp: allocation flags
7397 * This function should be called by a driver that supports 4 way handshake
7398 * offload after a security association was successfully established (i.e.,
7399 * the 4 way handshake was completed successfully). The call to this function
7400 * should be preceded with a call to cfg80211_connect_result(),
7401 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7402 * indicate the 802.11 association.
7404 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7408 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7410 * @dev: network device
7411 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7412 * @ie_len: length of IEs
7413 * @reason: reason code for the disconnection, set it to 0 if unknown
7414 * @locally_generated: disconnection was requested locally
7415 * @gfp: allocation flags
7417 * After it calls this function, the driver should enter an idle state
7418 * and not try to connect to any AP any more.
7420 void cfg80211_disconnected(struct net_device *dev, u16 reason,
7421 const u8 *ie, size_t ie_len,
7422 bool locally_generated, gfp_t gfp);
7425 * cfg80211_ready_on_channel - notification of remain_on_channel start
7426 * @wdev: wireless device
7427 * @cookie: the request cookie
7428 * @chan: The current channel (from remain_on_channel request)
7429 * @duration: Duration in milliseconds that the driver intents to remain on the
7431 * @gfp: allocation flags
7433 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7434 struct ieee80211_channel *chan,
7435 unsigned int duration, gfp_t gfp);
7438 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7439 * @wdev: wireless device
7440 * @cookie: the request cookie
7441 * @chan: The current channel (from remain_on_channel request)
7442 * @gfp: allocation flags
7444 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7445 struct ieee80211_channel *chan,
7449 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7450 * @wdev: wireless device
7451 * @cookie: the requested cookie
7452 * @chan: The current channel (from tx_mgmt request)
7453 * @gfp: allocation flags
7455 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7456 struct ieee80211_channel *chan, gfp_t gfp);
7459 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7461 * @sinfo: the station information
7462 * @gfp: allocation flags
7464 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7467 * cfg80211_sinfo_release_content - release contents of station info
7468 * @sinfo: the station information
7470 * Releases any potentially allocated sub-information of the station
7471 * information, but not the struct itself (since it's typically on
7474 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7476 kfree(sinfo->pertid);
7480 * cfg80211_new_sta - notify userspace about station
7483 * @mac_addr: the station's address
7484 * @sinfo: the station information
7485 * @gfp: allocation flags
7487 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7488 struct station_info *sinfo, gfp_t gfp);
7491 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7493 * @mac_addr: the station's address
7494 * @sinfo: the station information/statistics
7495 * @gfp: allocation flags
7497 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7498 struct station_info *sinfo, gfp_t gfp);
7501 * cfg80211_del_sta - notify userspace about deletion of a station
7504 * @mac_addr: the station's address
7505 * @gfp: allocation flags
7507 static inline void cfg80211_del_sta(struct net_device *dev,
7508 const u8 *mac_addr, gfp_t gfp)
7510 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7514 * cfg80211_conn_failed - connection request failed notification
7517 * @mac_addr: the station's address
7518 * @reason: the reason for connection failure
7519 * @gfp: allocation flags
7521 * Whenever a station tries to connect to an AP and if the station
7522 * could not connect to the AP as the AP has rejected the connection
7523 * for some reasons, this function is called.
7525 * The reason for connection failure can be any of the value from
7526 * nl80211_connect_failed_reason enum
7528 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7529 enum nl80211_connect_failed_reason reason,
7533 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7534 * @wdev: wireless device receiving the frame
7535 * @freq: Frequency on which the frame was received in KHz
7536 * @sig_dbm: signal strength in dBm, or 0 if unknown
7537 * @buf: Management frame (header + body)
7538 * @len: length of the frame data
7539 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7541 * This function is called whenever an Action frame is received for a station
7542 * mode interface, but is not processed in kernel.
7544 * Return: %true if a user space application has registered for this frame.
7545 * For action frames, that makes it responsible for rejecting unrecognized
7546 * action frames; %false otherwise, in which case for action frames the
7547 * driver is responsible for rejecting the frame.
7549 bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq, int sig_dbm,
7550 const u8 *buf, size_t len, u32 flags);
7553 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7554 * @wdev: wireless device receiving the frame
7555 * @freq: Frequency on which the frame was received in MHz
7556 * @sig_dbm: signal strength in dBm, or 0 if unknown
7557 * @buf: Management frame (header + body)
7558 * @len: length of the frame data
7559 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7561 * This function is called whenever an Action frame is received for a station
7562 * mode interface, but is not processed in kernel.
7564 * Return: %true if a user space application has registered for this frame.
7565 * For action frames, that makes it responsible for rejecting unrecognized
7566 * action frames; %false otherwise, in which case for action frames the
7567 * driver is responsible for rejecting the frame.
7569 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7570 int sig_dbm, const u8 *buf, size_t len,
7573 return cfg80211_rx_mgmt_khz(wdev, MHZ_TO_KHZ(freq), sig_dbm, buf, len,
7578 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7579 * @wdev: wireless device receiving the frame
7580 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7581 * @buf: Management frame (header + body)
7582 * @len: length of the frame data
7583 * @ack: Whether frame was acknowledged
7584 * @gfp: context flags
7586 * This function is called whenever a management frame was requested to be
7587 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7588 * transmission attempt.
7590 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
7591 const u8 *buf, size_t len, bool ack, gfp_t gfp);
7594 * cfg80211_control_port_tx_status - notification of TX status for control
7596 * @wdev: wireless device receiving the frame
7597 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7598 * @buf: Data frame (header + body)
7599 * @len: length of the frame data
7600 * @ack: Whether frame was acknowledged
7601 * @gfp: context flags
7603 * This function is called whenever a control port frame was requested to be
7604 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7605 * the transmission attempt.
7607 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
7608 const u8 *buf, size_t len, bool ack,
7612 * cfg80211_rx_control_port - notification about a received control port frame
7613 * @dev: The device the frame matched to
7614 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7615 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7616 * This function does not take ownership of the skb, so the caller is
7617 * responsible for any cleanup. The caller must also ensure that
7618 * skb->protocol is set appropriately.
7619 * @unencrypted: Whether the frame was received unencrypted
7621 * This function is used to inform userspace about a received control port
7622 * frame. It should only be used if userspace indicated it wants to receive
7623 * control port frames over nl80211.
7625 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7626 * network layer headers removed (e.g. the raw EAPoL frame).
7628 * Return: %true if the frame was passed to userspace
7630 bool cfg80211_rx_control_port(struct net_device *dev,
7631 struct sk_buff *skb, bool unencrypted);
7634 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
7635 * @dev: network device
7636 * @rssi_event: the triggered RSSI event
7637 * @rssi_level: new RSSI level value or 0 if not available
7638 * @gfp: context flags
7640 * This function is called when a configured connection quality monitoring
7641 * rssi threshold reached event occurs.
7643 void cfg80211_cqm_rssi_notify(struct net_device *dev,
7644 enum nl80211_cqm_rssi_threshold_event rssi_event,
7645 s32 rssi_level, gfp_t gfp);
7648 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
7649 * @dev: network device
7650 * @peer: peer's MAC address
7651 * @num_packets: how many packets were lost -- should be a fixed threshold
7652 * but probably no less than maybe 50, or maybe a throughput dependent
7653 * threshold (to account for temporary interference)
7654 * @gfp: context flags
7656 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
7657 const u8 *peer, u32 num_packets, gfp_t gfp);
7660 * cfg80211_cqm_txe_notify - TX error rate event
7661 * @dev: network device
7662 * @peer: peer's MAC address
7663 * @num_packets: how many packets were lost
7664 * @rate: % of packets which failed transmission
7665 * @intvl: interval (in s) over which the TX failure threshold was breached.
7666 * @gfp: context flags
7668 * Notify userspace when configured % TX failures over number of packets in a
7669 * given interval is exceeded.
7671 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
7672 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
7675 * cfg80211_cqm_beacon_loss_notify - beacon loss event
7676 * @dev: network device
7677 * @gfp: context flags
7679 * Notify userspace about beacon loss from the connected AP.
7681 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
7684 * __cfg80211_radar_event - radar detection event
7686 * @chandef: chandef for the current channel
7687 * @offchan: the radar has been detected on the offchannel chain
7688 * @gfp: context flags
7690 * This function is called when a radar is detected on the current chanenl.
7692 void __cfg80211_radar_event(struct wiphy *wiphy,
7693 struct cfg80211_chan_def *chandef,
7694 bool offchan, gfp_t gfp);
7697 cfg80211_radar_event(struct wiphy *wiphy,
7698 struct cfg80211_chan_def *chandef,
7701 __cfg80211_radar_event(wiphy, chandef, false, gfp);
7705 cfg80211_background_radar_event(struct wiphy *wiphy,
7706 struct cfg80211_chan_def *chandef,
7709 __cfg80211_radar_event(wiphy, chandef, true, gfp);
7713 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
7714 * @dev: network device
7715 * @mac: MAC address of a station which opmode got modified
7716 * @sta_opmode: station's current opmode value
7717 * @gfp: context flags
7719 * Driver should call this function when station's opmode modified via action
7722 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
7723 struct sta_opmode_info *sta_opmode,
7727 * cfg80211_cac_event - Channel availability check (CAC) event
7728 * @netdev: network device
7729 * @chandef: chandef for the current channel
7730 * @event: type of event
7731 * @gfp: context flags
7733 * This function is called when a Channel availability check (CAC) is finished
7734 * or aborted. This must be called to notify the completion of a CAC process,
7735 * also by full-MAC drivers.
7737 void cfg80211_cac_event(struct net_device *netdev,
7738 const struct cfg80211_chan_def *chandef,
7739 enum nl80211_radar_event event, gfp_t gfp);
7742 * cfg80211_background_cac_abort - Channel Availability Check offchan abort event
7745 * This function is called by the driver when a Channel Availability Check
7746 * (CAC) is aborted by a offchannel dedicated chain.
7748 void cfg80211_background_cac_abort(struct wiphy *wiphy);
7751 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
7752 * @dev: network device
7753 * @bssid: BSSID of AP (to avoid races)
7754 * @replay_ctr: new replay counter
7755 * @gfp: allocation flags
7757 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
7758 const u8 *replay_ctr, gfp_t gfp);
7761 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7762 * @dev: network device
7763 * @index: candidate index (the smaller the index, the higher the priority)
7764 * @bssid: BSSID of AP
7765 * @preauth: Whether AP advertises support for RSN pre-authentication
7766 * @gfp: allocation flags
7768 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
7769 const u8 *bssid, bool preauth, gfp_t gfp);
7772 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7773 * @dev: The device the frame matched to
7774 * @addr: the transmitter address
7775 * @gfp: context flags
7777 * This function is used in AP mode (only!) to inform userspace that
7778 * a spurious class 3 frame was received, to be able to deauth the
7780 * Return: %true if the frame was passed to userspace (or this failed
7781 * for a reason other than not having a subscription.)
7783 bool cfg80211_rx_spurious_frame(struct net_device *dev,
7784 const u8 *addr, gfp_t gfp);
7787 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7788 * @dev: The device the frame matched to
7789 * @addr: the transmitter address
7790 * @gfp: context flags
7792 * This function is used in AP mode (only!) to inform userspace that
7793 * an associated station sent a 4addr frame but that wasn't expected.
7794 * It is allowed and desirable to send this event only once for each
7795 * station to avoid event flooding.
7796 * Return: %true if the frame was passed to userspace (or this failed
7797 * for a reason other than not having a subscription.)
7799 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
7800 const u8 *addr, gfp_t gfp);
7803 * cfg80211_probe_status - notify userspace about probe status
7804 * @dev: the device the probe was sent on
7805 * @addr: the address of the peer
7806 * @cookie: the cookie filled in @probe_client previously
7807 * @acked: indicates whether probe was acked or not
7808 * @ack_signal: signal strength (in dBm) of the ACK frame.
7809 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7810 * @gfp: allocation flags
7812 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
7813 u64 cookie, bool acked, s32 ack_signal,
7814 bool is_valid_ack_signal, gfp_t gfp);
7817 * cfg80211_report_obss_beacon_khz - report beacon from other APs
7818 * @wiphy: The wiphy that received the beacon
7820 * @len: length of the frame
7821 * @freq: frequency the frame was received on in KHz
7822 * @sig_dbm: signal strength in dBm, or 0 if unknown
7824 * Use this function to report to userspace when a beacon was
7825 * received. It is not useful to call this when there is no
7826 * netdev that is in AP/GO mode.
7828 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
7829 size_t len, int freq, int sig_dbm);
7832 * cfg80211_report_obss_beacon - report beacon from other APs
7833 * @wiphy: The wiphy that received the beacon
7835 * @len: length of the frame
7836 * @freq: frequency the frame was received on
7837 * @sig_dbm: signal strength in dBm, or 0 if unknown
7839 * Use this function to report to userspace when a beacon was
7840 * received. It is not useful to call this when there is no
7841 * netdev that is in AP/GO mode.
7843 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7844 const u8 *frame, size_t len,
7845 int freq, int sig_dbm)
7847 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
7852 * cfg80211_reg_can_beacon - check if beaconing is allowed
7854 * @chandef: the channel definition
7855 * @iftype: interface type
7857 * Return: %true if there is no secondary channel or the secondary channel(s)
7858 * can be used for beaconing (i.e. is not a radar channel etc.)
7860 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7861 struct cfg80211_chan_def *chandef,
7862 enum nl80211_iftype iftype);
7865 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7867 * @chandef: the channel definition
7868 * @iftype: interface type
7870 * Return: %true if there is no secondary channel or the secondary channel(s)
7871 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7872 * also checks if IR-relaxation conditions apply, to allow beaconing under
7873 * more permissive conditions.
7875 * Requires the wiphy mutex to be held.
7877 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7878 struct cfg80211_chan_def *chandef,
7879 enum nl80211_iftype iftype);
7882 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7883 * @dev: the device which switched channels
7884 * @chandef: the new channel definition
7886 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7889 void cfg80211_ch_switch_notify(struct net_device *dev,
7890 struct cfg80211_chan_def *chandef);
7893 * cfg80211_ch_switch_started_notify - notify channel switch start
7894 * @dev: the device on which the channel switch started
7895 * @chandef: the future channel definition
7896 * @count: the number of TBTTs until the channel switch happens
7897 * @quiet: whether or not immediate quiet was requested by the AP
7899 * Inform the userspace about the channel switch that has just
7900 * started, so that it can take appropriate actions (eg. starting
7901 * channel switch on other vifs), if necessary.
7903 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7904 struct cfg80211_chan_def *chandef,
7905 u8 count, bool quiet);
7908 * ieee80211_operating_class_to_band - convert operating class to band
7910 * @operating_class: the operating class to convert
7911 * @band: band pointer to fill
7913 * Returns %true if the conversion was successful, %false otherwise.
7915 bool ieee80211_operating_class_to_band(u8 operating_class,
7916 enum nl80211_band *band);
7919 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7921 * @chandef: the chandef to convert
7922 * @op_class: a pointer to the resulting operating class
7924 * Returns %true if the conversion was successful, %false otherwise.
7926 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7930 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
7932 * @chandef: the chandef to convert
7934 * Returns the center frequency of chandef (1st segment) in KHz.
7937 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
7939 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
7943 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7944 * @dev: the device on which the operation is requested
7945 * @peer: the MAC address of the peer device
7946 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7947 * NL80211_TDLS_TEARDOWN)
7948 * @reason_code: the reason code for teardown request
7949 * @gfp: allocation flags
7951 * This function is used to request userspace to perform TDLS operation that
7952 * requires knowledge of keys, i.e., link setup or teardown when the AP
7953 * connection uses encryption. This is optional mechanism for the driver to use
7954 * if it can automatically determine when a TDLS link could be useful (e.g.,
7955 * based on traffic and signal strength for a peer).
7957 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7958 enum nl80211_tdls_operation oper,
7959 u16 reason_code, gfp_t gfp);
7962 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7963 * @rate: given rate_info to calculate bitrate from
7965 * return 0 if MCS index >= 32
7967 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7970 * cfg80211_unregister_wdev - remove the given wdev
7971 * @wdev: struct wireless_dev to remove
7973 * This function removes the device so it can no longer be used. It is necessary
7974 * to call this function even when cfg80211 requests the removal of the device
7975 * by calling the del_virtual_intf() callback. The function must also be called
7976 * when the driver wishes to unregister the wdev, e.g. when the hardware device
7977 * is unbound from the driver.
7979 * Requires the RTNL and wiphy mutex to be held.
7981 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7984 * cfg80211_register_netdevice - register the given netdev
7985 * @dev: the netdev to register
7987 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
7988 * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
7989 * held. Otherwise, both register_netdevice() and register_netdev() are usable
7992 * Requires the RTNL and wiphy mutex to be held.
7994 int cfg80211_register_netdevice(struct net_device *dev);
7997 * cfg80211_unregister_netdevice - unregister the given netdev
7998 * @dev: the netdev to register
8000 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
8001 * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
8002 * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
8003 * usable instead as well.
8005 * Requires the RTNL and wiphy mutex to be held.
8007 static inline void cfg80211_unregister_netdevice(struct net_device *dev)
8009 cfg80211_unregister_wdev(dev->ieee80211_ptr);
8013 * struct cfg80211_ft_event_params - FT Information Elements
8015 * @ies_len: length of the FT IE in bytes
8016 * @target_ap: target AP's MAC address
8018 * @ric_ies_len: length of the RIC IE in bytes
8020 struct cfg80211_ft_event_params {
8023 const u8 *target_ap;
8029 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
8030 * @netdev: network device
8031 * @ft_event: IE information
8033 void cfg80211_ft_event(struct net_device *netdev,
8034 struct cfg80211_ft_event_params *ft_event);
8037 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
8038 * @ies: the input IE buffer
8039 * @len: the input length
8040 * @attr: the attribute ID to find
8041 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
8042 * if the function is only called to get the needed buffer size
8043 * @bufsize: size of the output buffer
8045 * The function finds a given P2P attribute in the (vendor) IEs and
8046 * copies its contents to the given buffer.
8048 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
8049 * malformed or the attribute can't be found (respectively), or the
8050 * length of the found attribute (which can be zero).
8052 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
8053 enum ieee80211_p2p_attr_id attr,
8054 u8 *buf, unsigned int bufsize);
8057 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
8058 * @ies: the IE buffer
8059 * @ielen: the length of the IE buffer
8060 * @ids: an array with element IDs that are allowed before
8061 * the split. A WLAN_EID_EXTENSION value means that the next
8062 * EID in the list is a sub-element of the EXTENSION IE.
8063 * @n_ids: the size of the element ID array
8064 * @after_ric: array IE types that come after the RIC element
8065 * @n_after_ric: size of the @after_ric array
8066 * @offset: offset where to start splitting in the buffer
8068 * This function splits an IE buffer by updating the @offset
8069 * variable to point to the location where the buffer should be
8072 * It assumes that the given IE buffer is well-formed, this
8073 * has to be guaranteed by the caller!
8075 * It also assumes that the IEs in the buffer are ordered
8076 * correctly, if not the result of using this function will not
8077 * be ordered correctly either, i.e. it does no reordering.
8079 * The function returns the offset where the next part of the
8080 * buffer starts, which may be @ielen if the entire (remainder)
8081 * of the buffer should be used.
8083 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
8084 const u8 *ids, int n_ids,
8085 const u8 *after_ric, int n_after_ric,
8089 * ieee80211_ie_split - split an IE buffer according to ordering
8090 * @ies: the IE buffer
8091 * @ielen: the length of the IE buffer
8092 * @ids: an array with element IDs that are allowed before
8093 * the split. A WLAN_EID_EXTENSION value means that the next
8094 * EID in the list is a sub-element of the EXTENSION IE.
8095 * @n_ids: the size of the element ID array
8096 * @offset: offset where to start splitting in the buffer
8098 * This function splits an IE buffer by updating the @offset
8099 * variable to point to the location where the buffer should be
8102 * It assumes that the given IE buffer is well-formed, this
8103 * has to be guaranteed by the caller!
8105 * It also assumes that the IEs in the buffer are ordered
8106 * correctly, if not the result of using this function will not
8107 * be ordered correctly either, i.e. it does no reordering.
8109 * The function returns the offset where the next part of the
8110 * buffer starts, which may be @ielen if the entire (remainder)
8111 * of the buffer should be used.
8113 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
8114 const u8 *ids, int n_ids, size_t offset)
8116 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
8120 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
8121 * @wdev: the wireless device reporting the wakeup
8122 * @wakeup: the wakeup report
8123 * @gfp: allocation flags
8125 * This function reports that the given device woke up. If it
8126 * caused the wakeup, report the reason(s), otherwise you may
8127 * pass %NULL as the @wakeup parameter to advertise that something
8128 * else caused the wakeup.
8130 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
8131 struct cfg80211_wowlan_wakeup *wakeup,
8135 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
8137 * @wdev: the wireless device for which critical protocol is stopped.
8138 * @gfp: allocation flags
8140 * This function can be called by the driver to indicate it has reverted
8141 * operation back to normal. One reason could be that the duration given
8142 * by .crit_proto_start() has expired.
8144 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
8147 * ieee80211_get_num_supported_channels - get number of channels device has
8150 * Return: the number of channels supported by the device.
8152 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
8155 * cfg80211_check_combinations - check interface combinations
8158 * @params: the interface combinations parameter
8160 * This function can be called by the driver to check whether a
8161 * combination of interfaces and their types are allowed according to
8162 * the interface combinations.
8164 int cfg80211_check_combinations(struct wiphy *wiphy,
8165 struct iface_combination_params *params);
8168 * cfg80211_iter_combinations - iterate over matching combinations
8171 * @params: the interface combinations parameter
8172 * @iter: function to call for each matching combination
8173 * @data: pointer to pass to iter function
8175 * This function can be called by the driver to check what possible
8176 * combinations it fits in at a given moment, e.g. for channel switching
8179 int cfg80211_iter_combinations(struct wiphy *wiphy,
8180 struct iface_combination_params *params,
8181 void (*iter)(const struct ieee80211_iface_combination *c,
8186 * cfg80211_stop_iface - trigger interface disconnection
8189 * @wdev: wireless device
8190 * @gfp: context flags
8192 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
8195 * Note: This doesn't need any locks and is asynchronous.
8197 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
8201 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
8202 * @wiphy: the wiphy to shut down
8204 * This function shuts down all interfaces belonging to this wiphy by
8205 * calling dev_close() (and treating non-netdev interfaces as needed).
8206 * It shouldn't really be used unless there are some fatal device errors
8207 * that really can't be recovered in any other way.
8209 * Callers must hold the RTNL and be able to deal with callbacks into
8210 * the driver while the function is running.
8212 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
8215 * wiphy_ext_feature_set - set the extended feature flag
8217 * @wiphy: the wiphy to modify.
8218 * @ftidx: extended feature bit index.
8220 * The extended features are flagged in multiple bytes (see
8221 * &struct wiphy.@ext_features)
8223 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
8224 enum nl80211_ext_feature_index ftidx)
8228 ft_byte = &wiphy->ext_features[ftidx / 8];
8229 *ft_byte |= BIT(ftidx % 8);
8233 * wiphy_ext_feature_isset - check the extended feature flag
8235 * @wiphy: the wiphy to modify.
8236 * @ftidx: extended feature bit index.
8238 * The extended features are flagged in multiple bytes (see
8239 * &struct wiphy.@ext_features)
8242 wiphy_ext_feature_isset(struct wiphy *wiphy,
8243 enum nl80211_ext_feature_index ftidx)
8247 ft_byte = wiphy->ext_features[ftidx / 8];
8248 return (ft_byte & BIT(ftidx % 8)) != 0;
8252 * cfg80211_free_nan_func - free NAN function
8253 * @f: NAN function that should be freed
8255 * Frees all the NAN function and all it's allocated members.
8257 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
8260 * struct cfg80211_nan_match_params - NAN match parameters
8261 * @type: the type of the function that triggered a match. If it is
8262 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
8263 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
8265 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
8266 * @inst_id: the local instance id
8267 * @peer_inst_id: the instance id of the peer's function
8268 * @addr: the MAC address of the peer
8269 * @info_len: the length of the &info
8270 * @info: the Service Specific Info from the peer (if any)
8271 * @cookie: unique identifier of the corresponding function
8273 struct cfg80211_nan_match_params {
8274 enum nl80211_nan_function_type type;
8284 * cfg80211_nan_match - report a match for a NAN function.
8285 * @wdev: the wireless device reporting the match
8286 * @match: match notification parameters
8287 * @gfp: allocation flags
8289 * This function reports that the a NAN function had a match. This
8290 * can be a subscribe that had a match or a solicited publish that
8291 * was sent. It can also be a follow up that was received.
8293 void cfg80211_nan_match(struct wireless_dev *wdev,
8294 struct cfg80211_nan_match_params *match, gfp_t gfp);
8297 * cfg80211_nan_func_terminated - notify about NAN function termination.
8299 * @wdev: the wireless device reporting the match
8300 * @inst_id: the local instance id
8301 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
8302 * @cookie: unique NAN function identifier
8303 * @gfp: allocation flags
8305 * This function reports that the a NAN function is terminated.
8307 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
8309 enum nl80211_nan_func_term_reason reason,
8310 u64 cookie, gfp_t gfp);
8312 /* ethtool helper */
8313 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
8316 * cfg80211_external_auth_request - userspace request for authentication
8317 * @netdev: network device
8318 * @params: External authentication parameters
8319 * @gfp: allocation flags
8320 * Returns: 0 on success, < 0 on error
8322 int cfg80211_external_auth_request(struct net_device *netdev,
8323 struct cfg80211_external_auth_params *params,
8327 * cfg80211_pmsr_report - report peer measurement result data
8328 * @wdev: the wireless device reporting the measurement
8329 * @req: the original measurement request
8330 * @result: the result data
8331 * @gfp: allocation flags
8333 void cfg80211_pmsr_report(struct wireless_dev *wdev,
8334 struct cfg80211_pmsr_request *req,
8335 struct cfg80211_pmsr_result *result,
8339 * cfg80211_pmsr_complete - report peer measurement completed
8340 * @wdev: the wireless device reporting the measurement
8341 * @req: the original measurement request
8342 * @gfp: allocation flags
8344 * Report that the entire measurement completed, after this
8345 * the request pointer will no longer be valid.
8347 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
8348 struct cfg80211_pmsr_request *req,
8352 * cfg80211_iftype_allowed - check whether the interface can be allowed
8354 * @iftype: interface type
8355 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
8356 * @check_swif: check iftype against software interfaces
8358 * Check whether the interface is allowed to operate; additionally, this API
8359 * can be used to check iftype against the software interfaces when
8360 * check_swif is '1'.
8362 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
8363 bool is_4addr, u8 check_swif);
8367 * cfg80211_assoc_comeback - notification of association that was
8368 * temporarly rejected with a comeback
8369 * @netdev: network device
8370 * @bss: the bss entry with which association is in progress.
8371 * @timeout: timeout interval value TUs.
8373 * this function may sleep. the caller must hold the corresponding wdev's mutex.
8375 void cfg80211_assoc_comeback(struct net_device *netdev,
8376 struct cfg80211_bss *bss, u32 timeout);
8378 /* Logging, debugging and troubleshooting/diagnostic helpers. */
8380 /* wiphy_printk helpers, similar to dev_printk */
8382 #define wiphy_printk(level, wiphy, format, args...) \
8383 dev_printk(level, &(wiphy)->dev, format, ##args)
8384 #define wiphy_emerg(wiphy, format, args...) \
8385 dev_emerg(&(wiphy)->dev, format, ##args)
8386 #define wiphy_alert(wiphy, format, args...) \
8387 dev_alert(&(wiphy)->dev, format, ##args)
8388 #define wiphy_crit(wiphy, format, args...) \
8389 dev_crit(&(wiphy)->dev, format, ##args)
8390 #define wiphy_err(wiphy, format, args...) \
8391 dev_err(&(wiphy)->dev, format, ##args)
8392 #define wiphy_warn(wiphy, format, args...) \
8393 dev_warn(&(wiphy)->dev, format, ##args)
8394 #define wiphy_notice(wiphy, format, args...) \
8395 dev_notice(&(wiphy)->dev, format, ##args)
8396 #define wiphy_info(wiphy, format, args...) \
8397 dev_info(&(wiphy)->dev, format, ##args)
8398 #define wiphy_info_once(wiphy, format, args...) \
8399 dev_info_once(&(wiphy)->dev, format, ##args)
8401 #define wiphy_err_ratelimited(wiphy, format, args...) \
8402 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
8403 #define wiphy_warn_ratelimited(wiphy, format, args...) \
8404 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
8406 #define wiphy_debug(wiphy, format, args...) \
8407 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
8409 #define wiphy_dbg(wiphy, format, args...) \
8410 dev_dbg(&(wiphy)->dev, format, ##args)
8412 #if defined(VERBOSE_DEBUG)
8413 #define wiphy_vdbg wiphy_dbg
8415 #define wiphy_vdbg(wiphy, format, args...) \
8418 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8424 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8425 * of using a WARN/WARN_ON to get the message out, including the
8426 * file/line information and a backtrace.
8428 #define wiphy_WARN(wiphy, format, args...) \
8429 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8432 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8433 * @netdev: network device
8434 * @owe_info: peer's owe info
8435 * @gfp: allocation flags
8437 void cfg80211_update_owe_info_event(struct net_device *netdev,
8438 struct cfg80211_update_owe_info *owe_info,
8442 * cfg80211_bss_flush - resets all the scan entries
8445 void cfg80211_bss_flush(struct wiphy *wiphy);
8448 * cfg80211_bss_color_notify - notify about bss color event
8449 * @dev: network device
8450 * @gfp: allocation flags
8451 * @cmd: the actual event we want to notify
8452 * @count: the number of TBTTs until the color change happens
8453 * @color_bitmap: representations of the colors that the local BSS is aware of
8455 int cfg80211_bss_color_notify(struct net_device *dev, gfp_t gfp,
8456 enum nl80211_commands cmd, u8 count,
8460 * cfg80211_obss_color_collision_notify - notify about bss color collision
8461 * @dev: network device
8462 * @color_bitmap: representations of the colors that the local BSS is aware of
8464 static inline int cfg80211_obss_color_collision_notify(struct net_device *dev,
8467 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8468 NL80211_CMD_OBSS_COLOR_COLLISION,
8473 * cfg80211_color_change_started_notify - notify color change start
8474 * @dev: the device on which the color is switched
8475 * @count: the number of TBTTs until the color change happens
8477 * Inform the userspace about the color change that has started.
8479 static inline int cfg80211_color_change_started_notify(struct net_device *dev,
8482 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8483 NL80211_CMD_COLOR_CHANGE_STARTED,
8488 * cfg80211_color_change_aborted_notify - notify color change abort
8489 * @dev: the device on which the color is switched
8491 * Inform the userspace about the color change that has aborted.
8493 static inline int cfg80211_color_change_aborted_notify(struct net_device *dev)
8495 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8496 NL80211_CMD_COLOR_CHANGE_ABORTED,
8501 * cfg80211_color_change_notify - notify color change completion
8502 * @dev: the device on which the color was switched
8504 * Inform the userspace about the color change that has completed.
8506 static inline int cfg80211_color_change_notify(struct net_device *dev)
8508 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8509 NL80211_CMD_COLOR_CHANGE_COMPLETED,
8513 #endif /* __NET_CFG80211_H */