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-2020 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 <net/regulatory.h>
30 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
31 * userspace and drivers, and offers some utility functionality associated
32 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
33 * by all modern wireless drivers in Linux, so that they offer a consistent
34 * API through nl80211. For backward compatibility, cfg80211 also offers
35 * wireless extensions to userspace, but hides them from drivers completely.
37 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
43 * DOC: Device registration
45 * In order for a driver to use cfg80211, it must register the hardware device
46 * with cfg80211. This happens through a number of hardware capability structs
49 * The fundamental structure for each device is the 'wiphy', of which each
50 * instance describes a physical wireless device connected to the system. Each
51 * such wiphy can have zero, one, or many virtual interfaces associated with
52 * it, which need to be identified as such by pointing the network interface's
53 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
54 * the wireless part of the interface, normally this struct is embedded in the
55 * network interface's private data area. Drivers can optionally allow creating
56 * or destroying virtual interfaces on the fly, but without at least one or the
57 * ability to create some the wireless device isn't useful.
59 * Each wiphy structure contains device capability information, and also has
60 * a pointer to the various operations the driver offers. The definitions and
61 * structures here describe these capabilities in detail.
67 * wireless hardware capability structures
71 * enum ieee80211_channel_flags - channel flags
73 * Channel flags set by the regulatory control code.
75 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
76 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
77 * sending probe requests or beaconing.
78 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
79 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
81 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
83 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
84 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
85 * this flag indicates that an 80 MHz channel cannot use this
86 * channel as the control or any of the secondary channels.
87 * This may be due to the driver or due to regulatory bandwidth
89 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
90 * this flag indicates that an 160 MHz channel cannot use this
91 * channel as the control or any of the secondary channels.
92 * This may be due to the driver or due to regulatory bandwidth
94 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
95 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
96 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
98 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
100 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
101 * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted
103 * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted
105 * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted
107 * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted
109 * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted
113 enum ieee80211_channel_flags {
114 IEEE80211_CHAN_DISABLED = 1<<0,
115 IEEE80211_CHAN_NO_IR = 1<<1,
117 IEEE80211_CHAN_RADAR = 1<<3,
118 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
119 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
120 IEEE80211_CHAN_NO_OFDM = 1<<6,
121 IEEE80211_CHAN_NO_80MHZ = 1<<7,
122 IEEE80211_CHAN_NO_160MHZ = 1<<8,
123 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
124 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
125 IEEE80211_CHAN_NO_20MHZ = 1<<11,
126 IEEE80211_CHAN_NO_10MHZ = 1<<12,
127 IEEE80211_CHAN_NO_HE = 1<<13,
128 IEEE80211_CHAN_1MHZ = 1<<14,
129 IEEE80211_CHAN_2MHZ = 1<<15,
130 IEEE80211_CHAN_4MHZ = 1<<16,
131 IEEE80211_CHAN_8MHZ = 1<<17,
132 IEEE80211_CHAN_16MHZ = 1<<18,
135 #define IEEE80211_CHAN_NO_HT40 \
136 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
138 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
139 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
142 * struct ieee80211_channel - channel definition
144 * This structure describes a single channel for use
147 * @center_freq: center frequency in MHz
148 * @freq_offset: offset from @center_freq, in KHz
149 * @hw_value: hardware-specific value for the channel
150 * @flags: channel flags from &enum ieee80211_channel_flags.
151 * @orig_flags: channel flags at registration time, used by regulatory
152 * code to support devices with additional restrictions
153 * @band: band this channel belongs to.
154 * @max_antenna_gain: maximum antenna gain in dBi
155 * @max_power: maximum transmission power (in dBm)
156 * @max_reg_power: maximum regulatory transmission power (in dBm)
157 * @beacon_found: helper to regulatory code to indicate when a beacon
158 * has been found on this channel. Use regulatory_hint_found_beacon()
159 * to enable this, this is useful only on 5 GHz band.
160 * @orig_mag: internal use
161 * @orig_mpwr: internal use
162 * @dfs_state: current state of this channel. Only relevant if radar is required
164 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
165 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
167 struct ieee80211_channel {
168 enum nl80211_band band;
173 int max_antenna_gain;
178 int orig_mag, orig_mpwr;
179 enum nl80211_dfs_state dfs_state;
180 unsigned long dfs_state_entered;
181 unsigned int dfs_cac_ms;
185 * enum ieee80211_rate_flags - rate flags
187 * Hardware/specification flags for rates. These are structured
188 * in a way that allows using the same bitrate structure for
189 * different bands/PHY modes.
191 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
192 * preamble on this bitrate; only relevant in 2.4GHz band and
194 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
195 * when used with 802.11a (on the 5 GHz band); filled by the
196 * core code when registering the wiphy.
197 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
198 * when used with 802.11b (on the 2.4 GHz band); filled by the
199 * core code when registering the wiphy.
200 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
201 * when used with 802.11g (on the 2.4 GHz band); filled by the
202 * core code when registering the wiphy.
203 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
204 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
205 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
207 enum ieee80211_rate_flags {
208 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
209 IEEE80211_RATE_MANDATORY_A = 1<<1,
210 IEEE80211_RATE_MANDATORY_B = 1<<2,
211 IEEE80211_RATE_MANDATORY_G = 1<<3,
212 IEEE80211_RATE_ERP_G = 1<<4,
213 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
214 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
218 * enum ieee80211_bss_type - BSS type filter
220 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
221 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
222 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
223 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
224 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
226 enum ieee80211_bss_type {
227 IEEE80211_BSS_TYPE_ESS,
228 IEEE80211_BSS_TYPE_PBSS,
229 IEEE80211_BSS_TYPE_IBSS,
230 IEEE80211_BSS_TYPE_MBSS,
231 IEEE80211_BSS_TYPE_ANY
235 * enum ieee80211_privacy - BSS privacy filter
237 * @IEEE80211_PRIVACY_ON: privacy bit set
238 * @IEEE80211_PRIVACY_OFF: privacy bit clear
239 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
241 enum ieee80211_privacy {
242 IEEE80211_PRIVACY_ON,
243 IEEE80211_PRIVACY_OFF,
244 IEEE80211_PRIVACY_ANY
247 #define IEEE80211_PRIVACY(x) \
248 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
251 * struct ieee80211_rate - bitrate definition
253 * This structure describes a bitrate that an 802.11 PHY can
254 * operate with. The two values @hw_value and @hw_value_short
255 * are only for driver use when pointers to this structure are
258 * @flags: rate-specific flags
259 * @bitrate: bitrate in units of 100 Kbps
260 * @hw_value: driver/hardware value for this rate
261 * @hw_value_short: driver/hardware value for this rate when
262 * short preamble is used
264 struct ieee80211_rate {
267 u16 hw_value, hw_value_short;
271 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
273 * @enable: is the feature enabled.
274 * @sr_ctrl: The SR Control field of SRP element.
275 * @non_srg_max_offset: non-SRG maximum tx power offset
276 * @min_offset: minimal tx power offset an associated station shall use
277 * @max_offset: maximum tx power offset an associated station shall use
278 * @bss_color_bitmap: bitmap that indicates the BSS color values used by
280 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
281 * used by members of the SRG
283 struct ieee80211_he_obss_pd {
286 u8 non_srg_max_offset;
289 u8 bss_color_bitmap[8];
290 u8 partial_bssid_bitmap[8];
294 * struct cfg80211_he_bss_color - AP settings for BSS coloring
296 * @color: the current color.
297 * @enabled: HE BSS color is used
298 * @partial: define the AID equation.
300 struct cfg80211_he_bss_color {
307 * struct ieee80211_sta_ht_cap - STA's HT capabilities
309 * This structure describes most essential parameters needed
310 * to describe 802.11n HT capabilities for an STA.
312 * @ht_supported: is HT supported by the STA
313 * @cap: HT capabilities map as described in 802.11n spec
314 * @ampdu_factor: Maximum A-MPDU length factor
315 * @ampdu_density: Minimum A-MPDU spacing
316 * @mcs: Supported MCS rates
318 struct ieee80211_sta_ht_cap {
319 u16 cap; /* use IEEE80211_HT_CAP_ */
323 struct ieee80211_mcs_info mcs;
327 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
329 * This structure describes most essential parameters needed
330 * to describe 802.11ac VHT capabilities for an STA.
332 * @vht_supported: is VHT supported by the STA
333 * @cap: VHT capabilities map as described in 802.11ac spec
334 * @vht_mcs: Supported VHT MCS rates
336 struct ieee80211_sta_vht_cap {
338 u32 cap; /* use IEEE80211_VHT_CAP_ */
339 struct ieee80211_vht_mcs_info vht_mcs;
342 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
345 * struct ieee80211_sta_he_cap - STA's HE capabilities
347 * This structure describes most essential parameters needed
348 * to describe 802.11ax HE capabilities for a STA.
350 * @has_he: true iff HE data is valid.
351 * @he_cap_elem: Fixed portion of the HE capabilities element.
352 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
353 * @ppe_thres: Holds the PPE Thresholds data.
355 struct ieee80211_sta_he_cap {
357 struct ieee80211_he_cap_elem he_cap_elem;
358 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
359 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
363 * struct ieee80211_sband_iftype_data - sband data per interface type
365 * This structure encapsulates sband data that is relevant for the
366 * interface types defined in @types_mask. Each type in the
367 * @types_mask must be unique across all instances of iftype_data.
369 * @types_mask: interface types mask
370 * @he_cap: holds the HE capabilities
371 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
372 * 6 GHz band channel (and 0 may be valid value).
374 struct ieee80211_sband_iftype_data {
376 struct ieee80211_sta_he_cap he_cap;
377 struct ieee80211_he_6ghz_capa he_6ghz_capa;
381 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
383 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
384 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
385 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
386 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
387 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
388 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
389 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
390 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
392 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
394 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
396 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
397 * and 4.32GHz + 4.32GHz
398 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
399 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
401 enum ieee80211_edmg_bw_config {
402 IEEE80211_EDMG_BW_CONFIG_4 = 4,
403 IEEE80211_EDMG_BW_CONFIG_5 = 5,
404 IEEE80211_EDMG_BW_CONFIG_6 = 6,
405 IEEE80211_EDMG_BW_CONFIG_7 = 7,
406 IEEE80211_EDMG_BW_CONFIG_8 = 8,
407 IEEE80211_EDMG_BW_CONFIG_9 = 9,
408 IEEE80211_EDMG_BW_CONFIG_10 = 10,
409 IEEE80211_EDMG_BW_CONFIG_11 = 11,
410 IEEE80211_EDMG_BW_CONFIG_12 = 12,
411 IEEE80211_EDMG_BW_CONFIG_13 = 13,
412 IEEE80211_EDMG_BW_CONFIG_14 = 14,
413 IEEE80211_EDMG_BW_CONFIG_15 = 15,
417 * struct ieee80211_edmg - EDMG configuration
419 * This structure describes most essential parameters needed
420 * to describe 802.11ay EDMG configuration
422 * @channels: bitmap that indicates the 2.16 GHz channel(s)
423 * that are allowed to be used for transmissions.
424 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
425 * Set to 0 indicate EDMG not supported.
426 * @bw_config: Channel BW Configuration subfield encodes
427 * the allowed channel bandwidth configurations
429 struct ieee80211_edmg {
431 enum ieee80211_edmg_bw_config bw_config;
435 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
437 * This structure describes most essential parameters needed
438 * to describe 802.11ah S1G capabilities for a STA.
440 * @s1g_supported: is STA an S1G STA
441 * @cap: S1G capabilities information
442 * @nss_mcs: Supported NSS MCS set
444 struct ieee80211_sta_s1g_cap {
446 u8 cap[10]; /* use S1G_CAPAB_ */
451 * struct ieee80211_supported_band - frequency band definition
453 * This structure describes a frequency band a wiphy
454 * is able to operate in.
456 * @channels: Array of channels the hardware can operate with
458 * @band: the band this structure represents
459 * @n_channels: Number of channels in @channels
460 * @bitrates: Array of bitrates the hardware can operate with
461 * in this band. Must be sorted to give a valid "supported
462 * rates" IE, i.e. CCK rates first, then OFDM.
463 * @n_bitrates: Number of bitrates in @bitrates
464 * @ht_cap: HT capabilities in this band
465 * @vht_cap: VHT capabilities in this band
466 * @s1g_cap: S1G capabilities in this band
467 * @edmg_cap: EDMG capabilities in this band
468 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
469 * @n_iftype_data: number of iftype data entries
470 * @iftype_data: interface type data entries. Note that the bits in
471 * @types_mask inside this structure cannot overlap (i.e. only
472 * one occurrence of each type is allowed across all instances of
475 struct ieee80211_supported_band {
476 struct ieee80211_channel *channels;
477 struct ieee80211_rate *bitrates;
478 enum nl80211_band band;
481 struct ieee80211_sta_ht_cap ht_cap;
482 struct ieee80211_sta_vht_cap vht_cap;
483 struct ieee80211_sta_s1g_cap s1g_cap;
484 struct ieee80211_edmg edmg_cap;
486 const struct ieee80211_sband_iftype_data *iftype_data;
490 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
491 * @sband: the sband to search for the STA on
492 * @iftype: enum nl80211_iftype
494 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
496 static inline const struct ieee80211_sband_iftype_data *
497 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
502 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
505 for (i = 0; i < sband->n_iftype_data; i++) {
506 const struct ieee80211_sband_iftype_data *data =
507 &sband->iftype_data[i];
509 if (data->types_mask & BIT(iftype))
517 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
518 * @sband: the sband to search for the iftype on
519 * @iftype: enum nl80211_iftype
521 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
523 static inline const struct ieee80211_sta_he_cap *
524 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
527 const struct ieee80211_sband_iftype_data *data =
528 ieee80211_get_sband_iftype_data(sband, iftype);
530 if (data && data->he_cap.has_he)
531 return &data->he_cap;
537 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
538 * @sband: the sband to search for the STA on
540 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
542 static inline const struct ieee80211_sta_he_cap *
543 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
545 return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
549 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
550 * @sband: the sband to search for the STA on
551 * @iftype: the iftype to search for
553 * Return: the 6GHz capabilities
556 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
557 enum nl80211_iftype iftype)
559 const struct ieee80211_sband_iftype_data *data =
560 ieee80211_get_sband_iftype_data(sband, iftype);
562 if (WARN_ON(!data || !data->he_cap.has_he))
565 return data->he_6ghz_capa.capa;
569 * wiphy_read_of_freq_limits - read frequency limits from device tree
571 * @wiphy: the wireless device to get extra limits for
573 * Some devices may have extra limitations specified in DT. This may be useful
574 * for chipsets that normally support more bands but are limited due to board
575 * design (e.g. by antennas or external power amplifier).
577 * This function reads info from DT and uses it to *modify* channels (disable
578 * unavailable ones). It's usually a *bad* idea to use it in drivers with
579 * shared channel data as DT limitations are device specific. You should make
580 * sure to call it only if channels in wiphy are copied and can be modified
581 * without affecting other devices.
583 * As this function access device node it has to be called after set_wiphy_dev.
584 * It also modifies channels so they have to be set first.
585 * If using this helper, call it before wiphy_register().
588 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
589 #else /* CONFIG_OF */
590 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
593 #endif /* !CONFIG_OF */
597 * Wireless hardware/device configuration structures and methods
601 * DOC: Actions and configuration
603 * Each wireless device and each virtual interface offer a set of configuration
604 * operations and other actions that are invoked by userspace. Each of these
605 * actions is described in the operations structure, and the parameters these
606 * operations use are described separately.
608 * Additionally, some operations are asynchronous and expect to get status
609 * information via some functions that drivers need to call.
611 * Scanning and BSS list handling with its associated functionality is described
612 * in a separate chapter.
615 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
616 WLAN_USER_POSITION_LEN)
619 * struct vif_params - describes virtual interface parameters
620 * @flags: monitor interface flags, unchanged if 0, otherwise
621 * %MONITOR_FLAG_CHANGED will be set
622 * @use_4addr: use 4-address frames
623 * @macaddr: address to use for this virtual interface.
624 * If this parameter is set to zero address the driver may
625 * determine the address as needed.
626 * This feature is only fully supported by drivers that enable the
627 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
628 ** only p2p devices with specified MAC.
629 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
630 * belonging to that MU-MIMO groupID; %NULL if not changed
631 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
632 * MU-MIMO packets going to the specified station; %NULL if not changed
637 u8 macaddr[ETH_ALEN];
638 const u8 *vht_mumimo_groups;
639 const u8 *vht_mumimo_follow_addr;
643 * struct key_params - key information
645 * Information about a key
648 * @key_len: length of key material
649 * @cipher: cipher suite selector
650 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
651 * with the get_key() callback, must be in little endian,
652 * length given by @seq_len.
653 * @seq_len: length of @seq.
654 * @vlan_id: vlan_id for VLAN group key (if nonzero)
655 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
664 enum nl80211_key_mode mode;
668 * struct cfg80211_chan_def - channel definition
669 * @chan: the (control) channel
670 * @width: channel width
671 * @center_freq1: center frequency of first segment
672 * @center_freq2: center frequency of second segment
673 * (only with 80+80 MHz)
674 * @edmg: define the EDMG channels configuration.
675 * If edmg is requested (i.e. the .channels member is non-zero),
676 * chan will define the primary channel and all other
677 * parameters are ignored.
678 * @freq1_offset: offset from @center_freq1, in KHz
680 struct cfg80211_chan_def {
681 struct ieee80211_channel *chan;
682 enum nl80211_chan_width width;
685 struct ieee80211_edmg edmg;
690 * cfg80211_bitrate_mask - masks for bitrate control
692 struct cfg80211_bitrate_mask {
695 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
696 u16 vht_mcs[NL80211_VHT_NSS_MAX];
697 u16 he_mcs[NL80211_HE_NSS_MAX];
698 enum nl80211_txrate_gi gi;
699 enum nl80211_he_gi he_gi;
700 enum nl80211_he_ltf he_ltf;
701 } control[NUM_NL80211_BANDS];
706 * struct cfg80211_tid_cfg - TID specific configuration
707 * @config_override: Flag to notify driver to reset TID configuration
709 * @tids: bitmap of TIDs to modify
710 * @mask: bitmap of attributes indicating which parameter changed,
711 * similar to &nl80211_tid_config_supp.
712 * @noack: noack configuration value for the TID
713 * @retry_long: retry count value
714 * @retry_short: retry count value
715 * @ampdu: Enable/Disable MPDU aggregation
716 * @rtscts: Enable/Disable RTS/CTS
717 * @amsdu: Enable/Disable MSDU aggregation
718 * @txrate_type: Tx bitrate mask type
719 * @txrate_mask: Tx bitrate to be applied for the TID
721 struct cfg80211_tid_cfg {
722 bool config_override;
725 enum nl80211_tid_config noack;
726 u8 retry_long, retry_short;
727 enum nl80211_tid_config ampdu;
728 enum nl80211_tid_config rtscts;
729 enum nl80211_tid_config amsdu;
730 enum nl80211_tx_rate_setting txrate_type;
731 struct cfg80211_bitrate_mask txrate_mask;
735 * struct cfg80211_tid_config - TID configuration
736 * @peer: Station's MAC address
737 * @n_tid_conf: Number of TID specific configurations to be applied
738 * @tid_conf: Configuration change info
740 struct cfg80211_tid_config {
743 struct cfg80211_tid_cfg tid_conf[];
747 * cfg80211_get_chandef_type - return old channel type from chandef
748 * @chandef: the channel definition
750 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
751 * chandef, which must have a bandwidth allowing this conversion.
753 static inline enum nl80211_channel_type
754 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
756 switch (chandef->width) {
757 case NL80211_CHAN_WIDTH_20_NOHT:
758 return NL80211_CHAN_NO_HT;
759 case NL80211_CHAN_WIDTH_20:
760 return NL80211_CHAN_HT20;
761 case NL80211_CHAN_WIDTH_40:
762 if (chandef->center_freq1 > chandef->chan->center_freq)
763 return NL80211_CHAN_HT40PLUS;
764 return NL80211_CHAN_HT40MINUS;
767 return NL80211_CHAN_NO_HT;
772 * cfg80211_chandef_create - create channel definition using channel type
773 * @chandef: the channel definition struct to fill
774 * @channel: the control channel
775 * @chantype: the channel type
777 * Given a channel type, create a channel definition.
779 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
780 struct ieee80211_channel *channel,
781 enum nl80211_channel_type chantype);
784 * cfg80211_chandef_identical - check if two channel definitions are identical
785 * @chandef1: first channel definition
786 * @chandef2: second channel definition
788 * Return: %true if the channels defined by the channel definitions are
789 * identical, %false otherwise.
792 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
793 const struct cfg80211_chan_def *chandef2)
795 return (chandef1->chan == chandef2->chan &&
796 chandef1->width == chandef2->width &&
797 chandef1->center_freq1 == chandef2->center_freq1 &&
798 chandef1->freq1_offset == chandef2->freq1_offset &&
799 chandef1->center_freq2 == chandef2->center_freq2);
803 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
805 * @chandef: the channel definition
807 * Return: %true if EDMG defined, %false otherwise.
810 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
812 return chandef->edmg.channels || chandef->edmg.bw_config;
816 * cfg80211_chandef_compatible - check if two channel definitions are compatible
817 * @chandef1: first channel definition
818 * @chandef2: second channel definition
820 * Return: %NULL if the given channel definitions are incompatible,
821 * chandef1 or chandef2 otherwise.
823 const struct cfg80211_chan_def *
824 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
825 const struct cfg80211_chan_def *chandef2);
828 * cfg80211_chandef_valid - check if a channel definition is valid
829 * @chandef: the channel definition to check
830 * Return: %true if the channel definition is valid. %false otherwise.
832 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
835 * cfg80211_chandef_usable - check if secondary channels can be used
836 * @wiphy: the wiphy to validate against
837 * @chandef: the channel definition to check
838 * @prohibited_flags: the regulatory channel flags that must not be set
839 * Return: %true if secondary channels are usable. %false otherwise.
841 bool cfg80211_chandef_usable(struct wiphy *wiphy,
842 const struct cfg80211_chan_def *chandef,
843 u32 prohibited_flags);
846 * cfg80211_chandef_dfs_required - checks if radar detection is required
847 * @wiphy: the wiphy to validate against
848 * @chandef: the channel definition to check
849 * @iftype: the interface type as specified in &enum nl80211_iftype
851 * 1 if radar detection is required, 0 if it is not, < 0 on error
853 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
854 const struct cfg80211_chan_def *chandef,
855 enum nl80211_iftype iftype);
858 * ieee80211_chandef_rate_flags - returns rate flags for a channel
860 * In some channel types, not all rates may be used - for example CCK
861 * rates may not be used in 5/10 MHz channels.
863 * @chandef: channel definition for the channel
865 * Returns: rate flags which apply for this channel
867 static inline enum ieee80211_rate_flags
868 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
870 switch (chandef->width) {
871 case NL80211_CHAN_WIDTH_5:
872 return IEEE80211_RATE_SUPPORTS_5MHZ;
873 case NL80211_CHAN_WIDTH_10:
874 return IEEE80211_RATE_SUPPORTS_10MHZ;
882 * ieee80211_chandef_max_power - maximum transmission power for the chandef
884 * In some regulations, the transmit power may depend on the configured channel
885 * bandwidth which may be defined as dBm/MHz. This function returns the actual
886 * max_power for non-standard (20 MHz) channels.
888 * @chandef: channel definition for the channel
890 * Returns: maximum allowed transmission power in dBm for the chandef
893 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
895 switch (chandef->width) {
896 case NL80211_CHAN_WIDTH_5:
897 return min(chandef->chan->max_reg_power - 6,
898 chandef->chan->max_power);
899 case NL80211_CHAN_WIDTH_10:
900 return min(chandef->chan->max_reg_power - 3,
901 chandef->chan->max_power);
905 return chandef->chan->max_power;
909 * enum survey_info_flags - survey information flags
911 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
912 * @SURVEY_INFO_IN_USE: channel is currently being used
913 * @SURVEY_INFO_TIME: active time (in ms) was filled in
914 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
915 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
916 * @SURVEY_INFO_TIME_RX: receive time was filled in
917 * @SURVEY_INFO_TIME_TX: transmit time was filled in
918 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
919 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
921 * Used by the driver to indicate which info in &struct survey_info
922 * it has filled in during the get_survey().
924 enum survey_info_flags {
925 SURVEY_INFO_NOISE_DBM = BIT(0),
926 SURVEY_INFO_IN_USE = BIT(1),
927 SURVEY_INFO_TIME = BIT(2),
928 SURVEY_INFO_TIME_BUSY = BIT(3),
929 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
930 SURVEY_INFO_TIME_RX = BIT(5),
931 SURVEY_INFO_TIME_TX = BIT(6),
932 SURVEY_INFO_TIME_SCAN = BIT(7),
933 SURVEY_INFO_TIME_BSS_RX = BIT(8),
937 * struct survey_info - channel survey response
939 * @channel: the channel this survey record reports, may be %NULL for a single
940 * record to report global statistics
941 * @filled: bitflag of flags from &enum survey_info_flags
942 * @noise: channel noise in dBm. This and all following fields are
944 * @time: amount of time in ms the radio was turn on (on the channel)
945 * @time_busy: amount of time the primary channel was sensed busy
946 * @time_ext_busy: amount of time the extension channel was sensed busy
947 * @time_rx: amount of time the radio spent receiving data
948 * @time_tx: amount of time the radio spent transmitting data
949 * @time_scan: amount of time the radio spent for scanning
950 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
952 * Used by dump_survey() to report back per-channel survey information.
954 * This structure can later be expanded with things like
955 * channel duty cycle etc.
958 struct ieee80211_channel *channel;
970 #define CFG80211_MAX_WEP_KEYS 4
973 * struct cfg80211_crypto_settings - Crypto settings
974 * @wpa_versions: indicates which, if any, WPA versions are enabled
975 * (from enum nl80211_wpa_versions)
976 * @cipher_group: group key cipher suite (or 0 if unset)
977 * @n_ciphers_pairwise: number of AP supported unicast ciphers
978 * @ciphers_pairwise: unicast key cipher suites
979 * @n_akm_suites: number of AKM suites
980 * @akm_suites: AKM suites
981 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
982 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
983 * required to assume that the port is unauthorized until authorized by
984 * user space. Otherwise, port is marked authorized by default.
985 * @control_port_ethertype: the control port protocol that should be
986 * allowed through even on unauthorized ports
987 * @control_port_no_encrypt: TRUE to prevent encryption of control port
989 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
990 * port frames over NL80211 instead of the network interface.
991 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
993 * @wep_keys: static WEP keys, if not NULL points to an array of
994 * CFG80211_MAX_WEP_KEYS WEP keys
995 * @wep_tx_key: key index (0..3) of the default TX static WEP key
996 * @psk: PSK (for devices supporting 4-way-handshake offload)
997 * @sae_pwd: password for SAE authentication (for devices supporting SAE
999 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1000 * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
1002 * NL80211_SAE_PWE_UNSPECIFIED
1003 * Not-specified, used to indicate userspace did not specify any
1004 * preference. The driver should follow its internal policy in
1007 * NL80211_SAE_PWE_HUNT_AND_PECK
1008 * Allow hunting-and-pecking loop only
1010 * NL80211_SAE_PWE_HASH_TO_ELEMENT
1011 * Allow hash-to-element only
1013 * NL80211_SAE_PWE_BOTH
1014 * Allow either hunting-and-pecking loop or hash-to-element
1016 struct cfg80211_crypto_settings {
1019 int n_ciphers_pairwise;
1020 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1022 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
1024 __be16 control_port_ethertype;
1025 bool control_port_no_encrypt;
1026 bool control_port_over_nl80211;
1027 bool control_port_no_preauth;
1028 struct key_params *wep_keys;
1033 enum nl80211_sae_pwe_mechanism sae_pwe;
1037 * struct cfg80211_beacon_data - beacon data
1038 * @head: head portion of beacon (before TIM IE)
1039 * or %NULL if not changed
1040 * @tail: tail portion of beacon (after TIM IE)
1041 * or %NULL if not changed
1042 * @head_len: length of @head
1043 * @tail_len: length of @tail
1044 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1045 * @beacon_ies_len: length of beacon_ies in octets
1046 * @proberesp_ies: extra information element(s) to add into Probe Response
1048 * @proberesp_ies_len: length of proberesp_ies in octets
1049 * @assocresp_ies: extra information element(s) to add into (Re)Association
1050 * Response frames or %NULL
1051 * @assocresp_ies_len: length of assocresp_ies in octets
1052 * @probe_resp_len: length of probe response template (@probe_resp)
1053 * @probe_resp: probe response template (AP mode only)
1054 * @ftm_responder: enable FTM responder functionality; -1 for no change
1055 * (which also implies no change in LCI/civic location data)
1056 * @lci: Measurement Report element content, starting with Measurement Token
1057 * (measurement type 8)
1058 * @civicloc: Measurement Report element content, starting with Measurement
1059 * Token (measurement type 11)
1060 * @lci_len: LCI data length
1061 * @civicloc_len: Civic location data length
1063 struct cfg80211_beacon_data {
1064 const u8 *head, *tail;
1065 const u8 *beacon_ies;
1066 const u8 *proberesp_ies;
1067 const u8 *assocresp_ies;
1068 const u8 *probe_resp;
1073 size_t head_len, tail_len;
1074 size_t beacon_ies_len;
1075 size_t proberesp_ies_len;
1076 size_t assocresp_ies_len;
1077 size_t probe_resp_len;
1079 size_t civicloc_len;
1082 struct mac_address {
1087 * struct cfg80211_acl_data - Access control list data
1089 * @acl_policy: ACL policy to be applied on the station's
1090 * entry specified by mac_addr
1091 * @n_acl_entries: Number of MAC address entries passed
1092 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1094 struct cfg80211_acl_data {
1095 enum nl80211_acl_policy acl_policy;
1099 struct mac_address mac_addrs[];
1103 * struct cfg80211_fils_discovery - FILS discovery parameters from
1104 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1106 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1107 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1108 * @tmpl_len: Template length
1109 * @tmpl: Template data for FILS discovery frame including the action
1112 struct cfg80211_fils_discovery {
1120 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1121 * response parameters in 6GHz.
1123 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1124 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1126 * @tmpl_len: Template length
1127 * @tmpl: Template data for probe response
1129 struct cfg80211_unsol_bcast_probe_resp {
1136 * enum cfg80211_ap_settings_flags - AP settings flags
1138 * Used by cfg80211_ap_settings
1140 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
1142 enum cfg80211_ap_settings_flags {
1143 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
1147 * struct cfg80211_ap_settings - AP configuration
1149 * Used to configure an AP interface.
1151 * @chandef: defines the channel to use
1152 * @beacon: beacon data
1153 * @beacon_interval: beacon interval
1154 * @dtim_period: DTIM period
1155 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1157 * @ssid_len: length of @ssid
1158 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1159 * @crypto: crypto settings
1160 * @privacy: the BSS uses privacy
1161 * @auth_type: Authentication type (algorithm)
1162 * @smps_mode: SMPS mode
1163 * @inactivity_timeout: time in seconds to determine station's inactivity.
1164 * @p2p_ctwindow: P2P CT Window
1165 * @p2p_opp_ps: P2P opportunistic PS
1166 * @acl: ACL configuration used by the drivers which has support for
1167 * MAC address based access control
1168 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1170 * @beacon_rate: bitrate to be used for beacons
1171 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1172 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1173 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1174 * @ht_required: stations must support HT
1175 * @vht_required: stations must support VHT
1176 * @twt_responder: Enable Target Wait Time
1177 * @he_required: stations must support HE
1178 * @sae_h2e_required: stations must support direct H2E technique in SAE
1179 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1180 * @he_obss_pd: OBSS Packet Detection settings
1181 * @he_bss_color: BSS Color settings
1182 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1183 * @fils_discovery: FILS discovery transmission parameters
1184 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1186 struct cfg80211_ap_settings {
1187 struct cfg80211_chan_def chandef;
1189 struct cfg80211_beacon_data beacon;
1191 int beacon_interval, dtim_period;
1194 enum nl80211_hidden_ssid hidden_ssid;
1195 struct cfg80211_crypto_settings crypto;
1197 enum nl80211_auth_type auth_type;
1198 enum nl80211_smps_mode smps_mode;
1199 int inactivity_timeout;
1202 const struct cfg80211_acl_data *acl;
1204 struct cfg80211_bitrate_mask beacon_rate;
1206 const struct ieee80211_ht_cap *ht_cap;
1207 const struct ieee80211_vht_cap *vht_cap;
1208 const struct ieee80211_he_cap_elem *he_cap;
1209 const struct ieee80211_he_operation *he_oper;
1210 bool ht_required, vht_required, he_required, sae_h2e_required;
1213 struct ieee80211_he_obss_pd he_obss_pd;
1214 struct cfg80211_he_bss_color he_bss_color;
1215 struct cfg80211_fils_discovery fils_discovery;
1216 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1220 * struct cfg80211_csa_settings - channel switch settings
1222 * Used for channel switch
1224 * @chandef: defines the channel to use after the switch
1225 * @beacon_csa: beacon data while performing the switch
1226 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1227 * @counter_offsets_presp: offsets of the counters within the probe response
1228 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1229 * @n_counter_offsets_presp: number of csa counters in the probe response
1230 * @beacon_after: beacon data to be used on the new channel
1231 * @radar_required: whether radar detection is required on the new channel
1232 * @block_tx: whether transmissions should be blocked while changing
1233 * @count: number of beacons until switch
1235 struct cfg80211_csa_settings {
1236 struct cfg80211_chan_def chandef;
1237 struct cfg80211_beacon_data beacon_csa;
1238 const u16 *counter_offsets_beacon;
1239 const u16 *counter_offsets_presp;
1240 unsigned int n_counter_offsets_beacon;
1241 unsigned int n_counter_offsets_presp;
1242 struct cfg80211_beacon_data beacon_after;
1243 bool radar_required;
1248 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1251 * struct iface_combination_params - input parameters for interface combinations
1253 * Used to pass interface combination parameters
1255 * @num_different_channels: the number of different channels we want
1256 * to use for verification
1257 * @radar_detect: a bitmap where each bit corresponds to a channel
1258 * width where radar detection is needed, as in the definition of
1259 * &struct ieee80211_iface_combination.@radar_detect_widths
1260 * @iftype_num: array with the number of interfaces of each interface
1261 * type. The index is the interface type as specified in &enum
1263 * @new_beacon_int: set this to the beacon interval of a new interface
1264 * that's not operating yet, if such is to be checked as part of
1267 struct iface_combination_params {
1268 int num_different_channels;
1270 int iftype_num[NUM_NL80211_IFTYPES];
1275 * enum station_parameters_apply_mask - station parameter values to apply
1276 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1277 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1278 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1280 * Not all station parameters have in-band "no change" signalling,
1281 * for those that don't these flags will are used.
1283 enum station_parameters_apply_mask {
1284 STATION_PARAM_APPLY_UAPSD = BIT(0),
1285 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1286 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1287 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1291 * struct sta_txpwr - station txpower configuration
1293 * Used to configure txpower for station.
1295 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1296 * is not provided, the default per-interface tx power setting will be
1297 * overriding. Driver should be picking up the lowest tx power, either tx
1298 * power per-interface or per-station.
1299 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1300 * will be less than or equal to specified from userspace, whereas if TPC
1301 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1302 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1307 enum nl80211_tx_power_setting type;
1311 * struct station_parameters - station parameters
1313 * Used to change and create a new station.
1315 * @vlan: vlan interface station should belong to
1316 * @supported_rates: supported rates in IEEE 802.11 format
1317 * (or NULL for no change)
1318 * @supported_rates_len: number of supported rates
1319 * @sta_flags_mask: station flags that changed
1320 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1321 * @sta_flags_set: station flags values
1322 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1323 * @listen_interval: listen interval or -1 for no change
1324 * @aid: AID or zero for no change
1325 * @vlan_id: VLAN ID for station (if nonzero)
1326 * @peer_aid: mesh peer AID or zero for no change
1327 * @plink_action: plink action to take
1328 * @plink_state: set the peer link state for a station
1329 * @ht_capa: HT capabilities of station
1330 * @vht_capa: VHT capabilities of station
1331 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1332 * as the AC bitmap in the QoS info field
1333 * @max_sp: max Service Period. same format as the MAX_SP in the
1334 * QoS info field (but already shifted down)
1335 * @sta_modify_mask: bitmap indicating which parameters changed
1336 * (for those that don't have a natural "no change" value),
1337 * see &enum station_parameters_apply_mask
1338 * @local_pm: local link-specific mesh power save mode (no change when set
1340 * @capability: station capability
1341 * @ext_capab: extended capabilities of the station
1342 * @ext_capab_len: number of extended capabilities
1343 * @supported_channels: supported channels in IEEE 802.11 format
1344 * @supported_channels_len: number of supported channels
1345 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1346 * @supported_oper_classes_len: number of supported operating classes
1347 * @opmode_notif: operating mode field from Operating Mode Notification
1348 * @opmode_notif_used: information if operating mode field is used
1349 * @support_p2p_ps: information if station supports P2P PS mechanism
1350 * @he_capa: HE capabilities of station
1351 * @he_capa_len: the length of the HE capabilities
1352 * @airtime_weight: airtime scheduler weight for this station
1353 * @txpwr: transmit power for an associated station
1354 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1356 struct station_parameters {
1357 const u8 *supported_rates;
1358 struct net_device *vlan;
1359 u32 sta_flags_mask, sta_flags_set;
1360 u32 sta_modify_mask;
1361 int listen_interval;
1365 u8 supported_rates_len;
1368 const struct ieee80211_ht_cap *ht_capa;
1369 const struct ieee80211_vht_cap *vht_capa;
1372 enum nl80211_mesh_power_mode local_pm;
1374 const u8 *ext_capab;
1376 const u8 *supported_channels;
1377 u8 supported_channels_len;
1378 const u8 *supported_oper_classes;
1379 u8 supported_oper_classes_len;
1381 bool opmode_notif_used;
1383 const struct ieee80211_he_cap_elem *he_capa;
1386 struct sta_txpwr txpwr;
1387 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1391 * struct station_del_parameters - station deletion parameters
1393 * Used to delete a station entry (or all stations).
1395 * @mac: MAC address of the station to remove or NULL to remove all stations
1396 * @subtype: Management frame subtype to use for indicating removal
1397 * (10 = Disassociation, 12 = Deauthentication)
1398 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1400 struct station_del_parameters {
1407 * enum cfg80211_station_type - the type of station being modified
1408 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1409 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1410 * unassociated (update properties for this type of client is permitted)
1411 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1412 * the AP MLME in the device
1413 * @CFG80211_STA_AP_STA: AP station on managed interface
1414 * @CFG80211_STA_IBSS: IBSS station
1415 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1416 * while TDLS setup is in progress, it moves out of this state when
1417 * being marked authorized; use this only if TDLS with external setup is
1419 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1420 * entry that is operating, has been marked authorized by userspace)
1421 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1422 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1424 enum cfg80211_station_type {
1425 CFG80211_STA_AP_CLIENT,
1426 CFG80211_STA_AP_CLIENT_UNASSOC,
1427 CFG80211_STA_AP_MLME_CLIENT,
1428 CFG80211_STA_AP_STA,
1430 CFG80211_STA_TDLS_PEER_SETUP,
1431 CFG80211_STA_TDLS_PEER_ACTIVE,
1432 CFG80211_STA_MESH_PEER_KERNEL,
1433 CFG80211_STA_MESH_PEER_USER,
1437 * cfg80211_check_station_change - validate parameter changes
1438 * @wiphy: the wiphy this operates on
1439 * @params: the new parameters for a station
1440 * @statype: the type of station being modified
1442 * Utility function for the @change_station driver method. Call this function
1443 * with the appropriate station type looking up the station (and checking that
1444 * it exists). It will verify whether the station change is acceptable, and if
1445 * not will return an error code. Note that it may modify the parameters for
1446 * backward compatibility reasons, so don't use them before calling this.
1448 int cfg80211_check_station_change(struct wiphy *wiphy,
1449 struct station_parameters *params,
1450 enum cfg80211_station_type statype);
1453 * enum rate_info_flags - bitrate info flags
1455 * Used by the driver to indicate the specific rate transmission
1456 * type for 802.11n transmissions.
1458 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1459 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1460 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1461 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1462 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1463 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1464 * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS
1466 enum rate_info_flags {
1467 RATE_INFO_FLAGS_MCS = BIT(0),
1468 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1469 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1470 RATE_INFO_FLAGS_DMG = BIT(3),
1471 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1472 RATE_INFO_FLAGS_EDMG = BIT(5),
1473 RATE_INFO_FLAGS_EXTENDED_SC_DMG = BIT(6),
1477 * enum rate_info_bw - rate bandwidth information
1479 * Used by the driver to indicate the rate bandwidth.
1481 * @RATE_INFO_BW_5: 5 MHz bandwidth
1482 * @RATE_INFO_BW_10: 10 MHz bandwidth
1483 * @RATE_INFO_BW_20: 20 MHz bandwidth
1484 * @RATE_INFO_BW_40: 40 MHz bandwidth
1485 * @RATE_INFO_BW_80: 80 MHz bandwidth
1486 * @RATE_INFO_BW_160: 160 MHz bandwidth
1487 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1490 RATE_INFO_BW_20 = 0,
1500 * struct rate_info - bitrate information
1502 * Information about a receiving or transmitting bitrate
1504 * @flags: bitflag of flags from &enum rate_info_flags
1505 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1506 * @legacy: bitrate in 100kbit/s for 802.11abg
1507 * @nss: number of streams (VHT & HE only)
1508 * @bw: bandwidth (from &enum rate_info_bw)
1509 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1510 * @he_dcm: HE DCM value
1511 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1512 * only valid if bw is %RATE_INFO_BW_HE_RU)
1513 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1528 * enum bss_param_flags - bitrate info flags
1530 * Used by the driver to indicate the specific rate transmission
1531 * type for 802.11n transmissions.
1533 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1534 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1535 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1537 enum bss_param_flags {
1538 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1539 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1540 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1544 * struct sta_bss_parameters - BSS parameters for the attached station
1546 * Information about the currently associated BSS
1548 * @flags: bitflag of flags from &enum bss_param_flags
1549 * @dtim_period: DTIM period for the BSS
1550 * @beacon_interval: beacon interval
1552 struct sta_bss_parameters {
1555 u16 beacon_interval;
1559 * struct cfg80211_txq_stats - TXQ statistics for this TID
1560 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1561 * indicate the relevant values in this struct are filled
1562 * @backlog_bytes: total number of bytes currently backlogged
1563 * @backlog_packets: total number of packets currently backlogged
1564 * @flows: number of new flows seen
1565 * @drops: total number of packets dropped
1566 * @ecn_marks: total number of packets marked with ECN CE
1567 * @overlimit: number of drops due to queue space overflow
1568 * @overmemory: number of drops due to memory limit overflow
1569 * @collisions: number of hash collisions
1570 * @tx_bytes: total number of bytes dequeued
1571 * @tx_packets: total number of packets dequeued
1572 * @max_flows: maximum number of flows supported
1574 struct cfg80211_txq_stats {
1577 u32 backlog_packets;
1590 * struct cfg80211_tid_stats - per-TID statistics
1591 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1592 * indicate the relevant values in this struct are filled
1593 * @rx_msdu: number of received MSDUs
1594 * @tx_msdu: number of (attempted) transmitted MSDUs
1595 * @tx_msdu_retries: number of retries (not counting the first) for
1597 * @tx_msdu_failed: number of failed transmitted MSDUs
1598 * @txq_stats: TXQ statistics
1600 struct cfg80211_tid_stats {
1604 u64 tx_msdu_retries;
1606 struct cfg80211_txq_stats txq_stats;
1609 #define IEEE80211_MAX_CHAINS 4
1612 * struct station_info - station information
1614 * Station information filled by driver for get_station() and dump_station.
1616 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1617 * indicate the relevant values in this struct for them
1618 * @connected_time: time(in secs) since a station is last connected
1619 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1620 * @assoc_at: bootime (ns) of the last association
1621 * @rx_bytes: bytes (size of MPDUs) received from this station
1622 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1623 * @llid: mesh local link id
1624 * @plid: mesh peer link id
1625 * @plink_state: mesh peer link state
1626 * @signal: The signal strength, type depends on the wiphy's signal_type.
1627 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1628 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1629 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1630 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1631 * @chain_signal: per-chain signal strength of last received packet in dBm
1632 * @chain_signal_avg: per-chain signal strength average in dBm
1633 * @txrate: current unicast bitrate from this station
1634 * @rxrate: current unicast bitrate to this station
1635 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1636 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1637 * @tx_retries: cumulative retry counts (MPDUs)
1638 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1639 * @rx_dropped_misc: Dropped for un-specified reason.
1640 * @bss_param: current BSS parameters
1641 * @generation: generation number for nl80211 dumps.
1642 * This number should increase every time the list of stations
1643 * changes, i.e. when a station is added or removed, so that
1644 * userspace can tell whether it got a consistent snapshot.
1645 * @assoc_req_ies: IEs from (Re)Association Request.
1646 * This is used only when in AP mode with drivers that do not use
1647 * user space MLME/SME implementation. The information is provided for
1648 * the cfg80211_new_sta() calls to notify user space of the IEs.
1649 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1650 * @sta_flags: station flags mask & values
1651 * @beacon_loss_count: Number of times beacon loss event has triggered.
1652 * @t_offset: Time offset of the station relative to this host.
1653 * @local_pm: local mesh STA power save mode
1654 * @peer_pm: peer mesh STA power save mode
1655 * @nonpeer_pm: non-peer mesh STA power save mode
1656 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1657 * towards this station.
1658 * @rx_beacon: number of beacons received from this peer
1659 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1661 * @connected_to_gate: true if mesh STA has a path to mesh gate
1662 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1663 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1664 * @airtime_weight: current airtime scheduling weight
1665 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1666 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1667 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1668 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1669 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1671 * @rx_mpdu_count: number of MPDUs received from this station
1672 * @fcs_err_count: number of packets (MPDUs) received from this station with
1673 * an FCS error. This counter should be incremented only when TA of the
1674 * received packet with an FCS error matches the peer MAC address.
1675 * @airtime_link_metric: mesh airtime link metric.
1676 * @connected_to_as: true if mesh STA has a path to authentication server
1678 struct station_info {
1692 s8 chain_signal[IEEE80211_MAX_CHAINS];
1693 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1695 struct rate_info txrate;
1696 struct rate_info rxrate;
1701 u32 rx_dropped_misc;
1702 struct sta_bss_parameters bss_param;
1703 struct nl80211_sta_flag_update sta_flags;
1707 const u8 *assoc_req_ies;
1708 size_t assoc_req_ies_len;
1710 u32 beacon_loss_count;
1712 enum nl80211_mesh_power_mode local_pm;
1713 enum nl80211_mesh_power_mode peer_pm;
1714 enum nl80211_mesh_power_mode nonpeer_pm;
1716 u32 expected_throughput;
1721 u8 rx_beacon_signal_avg;
1722 u8 connected_to_gate;
1724 struct cfg80211_tid_stats *pertid;
1733 u32 airtime_link_metric;
1739 * struct cfg80211_sar_sub_specs - sub specs limit
1740 * @power: power limitation in 0.25dbm
1741 * @freq_range_index: index the power limitation applies to
1743 struct cfg80211_sar_sub_specs {
1745 u32 freq_range_index;
1749 * struct cfg80211_sar_specs - sar limit specs
1750 * @type: it's set with power in 0.25dbm or other types
1751 * @num_sub_specs: number of sar sub specs
1752 * @sub_specs: memory to hold the sar sub specs
1754 struct cfg80211_sar_specs {
1755 enum nl80211_sar_type type;
1757 struct cfg80211_sar_sub_specs sub_specs[];
1762 * struct cfg80211_sar_freq_ranges - sar frequency ranges
1763 * @start_freq: start range edge frequency
1764 * @end_freq: end range edge frequency
1766 struct cfg80211_sar_freq_ranges {
1772 * struct cfg80211_sar_capa - sar limit capability
1773 * @type: it's set via power in 0.25dbm or other types
1774 * @num_freq_ranges: number of frequency ranges
1775 * @freq_ranges: memory to hold the freq ranges.
1777 * Note: WLAN driver may append new ranges or split an existing
1778 * range to small ones and then append them.
1780 struct cfg80211_sar_capa {
1781 enum nl80211_sar_type type;
1782 u32 num_freq_ranges;
1783 const struct cfg80211_sar_freq_ranges *freq_ranges;
1786 #if IS_ENABLED(CONFIG_CFG80211)
1788 * cfg80211_get_station - retrieve information about a given station
1789 * @dev: the device where the station is supposed to be connected to
1790 * @mac_addr: the mac address of the station of interest
1791 * @sinfo: pointer to the structure to fill with the information
1793 * Returns 0 on success and sinfo is filled with the available information
1794 * otherwise returns a negative error code and the content of sinfo has to be
1795 * considered undefined.
1797 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1798 struct station_info *sinfo);
1800 static inline int cfg80211_get_station(struct net_device *dev,
1802 struct station_info *sinfo)
1809 * enum monitor_flags - monitor flags
1811 * Monitor interface configuration flags. Note that these must be the bits
1812 * according to the nl80211 flags.
1814 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1815 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1816 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1817 * @MONITOR_FLAG_CONTROL: pass control frames
1818 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1819 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1820 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1822 enum monitor_flags {
1823 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1824 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1825 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1826 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1827 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1828 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1829 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1833 * enum mpath_info_flags - mesh path information flags
1835 * Used by the driver to indicate which info in &struct mpath_info it has filled
1836 * in during get_station() or dump_station().
1838 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1839 * @MPATH_INFO_SN: @sn filled
1840 * @MPATH_INFO_METRIC: @metric filled
1841 * @MPATH_INFO_EXPTIME: @exptime filled
1842 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1843 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1844 * @MPATH_INFO_FLAGS: @flags filled
1845 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1846 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1848 enum mpath_info_flags {
1849 MPATH_INFO_FRAME_QLEN = BIT(0),
1850 MPATH_INFO_SN = BIT(1),
1851 MPATH_INFO_METRIC = BIT(2),
1852 MPATH_INFO_EXPTIME = BIT(3),
1853 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1854 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1855 MPATH_INFO_FLAGS = BIT(6),
1856 MPATH_INFO_HOP_COUNT = BIT(7),
1857 MPATH_INFO_PATH_CHANGE = BIT(8),
1861 * struct mpath_info - mesh path information
1863 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1865 * @filled: bitfield of flags from &enum mpath_info_flags
1866 * @frame_qlen: number of queued frames for this destination
1867 * @sn: target sequence number
1868 * @metric: metric (cost) of this mesh path
1869 * @exptime: expiration time for the mesh path from now, in msecs
1870 * @flags: mesh path flags
1871 * @discovery_timeout: total mesh path discovery timeout, in msecs
1872 * @discovery_retries: mesh path discovery retries
1873 * @generation: generation number for nl80211 dumps.
1874 * This number should increase every time the list of mesh paths
1875 * changes, i.e. when a station is added or removed, so that
1876 * userspace can tell whether it got a consistent snapshot.
1877 * @hop_count: hops to destination
1878 * @path_change_count: total number of path changes to destination
1886 u32 discovery_timeout;
1887 u8 discovery_retries;
1890 u32 path_change_count;
1896 * struct bss_parameters - BSS parameters
1898 * Used to change BSS parameters (mainly for AP mode).
1900 * @use_cts_prot: Whether to use CTS protection
1901 * (0 = no, 1 = yes, -1 = do not change)
1902 * @use_short_preamble: Whether the use of short preambles is allowed
1903 * (0 = no, 1 = yes, -1 = do not change)
1904 * @use_short_slot_time: Whether the use of short slot time is allowed
1905 * (0 = no, 1 = yes, -1 = do not change)
1906 * @basic_rates: basic rates in IEEE 802.11 format
1907 * (or NULL for no change)
1908 * @basic_rates_len: number of basic rates
1909 * @ap_isolate: do not forward packets between connected stations
1910 * (0 = no, 1 = yes, -1 = do not change)
1911 * @ht_opmode: HT Operation mode
1912 * (u16 = opmode, -1 = do not change)
1913 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1914 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1916 struct bss_parameters {
1918 int use_short_preamble;
1919 int use_short_slot_time;
1920 const u8 *basic_rates;
1924 s8 p2p_ctwindow, p2p_opp_ps;
1928 * struct mesh_config - 802.11s mesh configuration
1930 * These parameters can be changed while the mesh is active.
1932 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1933 * by the Mesh Peering Open message
1934 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1935 * used by the Mesh Peering Open message
1936 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1937 * the mesh peering management to close a mesh peering
1938 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1940 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1941 * be sent to establish a new peer link instance in a mesh
1942 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1943 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1945 * @auto_open_plinks: whether we should automatically open peer links when we
1946 * detect compatible mesh peers
1947 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1948 * synchronize to for 11s default synchronization method
1949 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1950 * that an originator mesh STA can send to a particular path target
1951 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1952 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1953 * a path discovery in milliseconds
1954 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1955 * receiving a PREQ shall consider the forwarding information from the
1956 * root to be valid. (TU = time unit)
1957 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1958 * which a mesh STA can send only one action frame containing a PREQ
1960 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1961 * which a mesh STA can send only one Action frame containing a PERR
1963 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1964 * it takes for an HWMP information element to propagate across the mesh
1965 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1966 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1967 * announcements are transmitted
1968 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1969 * station has access to a broader network beyond the MBSS. (This is
1970 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1971 * only means that the station will announce others it's a mesh gate, but
1972 * not necessarily using the gate announcement protocol. Still keeping the
1973 * same nomenclature to be in sync with the spec)
1974 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1975 * entity (default is TRUE - forwarding entity)
1976 * @rssi_threshold: the threshold for average signal strength of candidate
1977 * station to establish a peer link
1978 * @ht_opmode: mesh HT protection mode
1980 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1981 * receiving a proactive PREQ shall consider the forwarding information to
1982 * the root mesh STA to be valid.
1984 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1985 * PREQs are transmitted.
1986 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1987 * during which a mesh STA can send only one Action frame containing
1988 * a PREQ element for root path confirmation.
1989 * @power_mode: The default mesh power save mode which will be the initial
1990 * setting for new peer links.
1991 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1992 * after transmitting its beacon.
1993 * @plink_timeout: If no tx activity is seen from a STA we've established
1994 * peering with for longer than this time (in seconds), then remove it
1995 * from the STA's list of peers. Default is 30 minutes.
1996 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1997 * connected to a mesh gate in mesh formation info. If false, the
1998 * value in mesh formation is determined by the presence of root paths
1999 * in the mesh path table
2000 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
2001 * for HWMP) if the destination is a direct neighbor. Note that this might
2002 * not be the optimal decision as a multi-hop route might be better. So
2003 * if using this setting you will likely also want to disable
2004 * dot11MeshForwarding and use another mesh routing protocol on top.
2006 struct mesh_config {
2007 u16 dot11MeshRetryTimeout;
2008 u16 dot11MeshConfirmTimeout;
2009 u16 dot11MeshHoldingTimeout;
2010 u16 dot11MeshMaxPeerLinks;
2011 u8 dot11MeshMaxRetries;
2014 bool auto_open_plinks;
2015 u32 dot11MeshNbrOffsetMaxNeighbor;
2016 u8 dot11MeshHWMPmaxPREQretries;
2017 u32 path_refresh_time;
2018 u16 min_discovery_timeout;
2019 u32 dot11MeshHWMPactivePathTimeout;
2020 u16 dot11MeshHWMPpreqMinInterval;
2021 u16 dot11MeshHWMPperrMinInterval;
2022 u16 dot11MeshHWMPnetDiameterTraversalTime;
2023 u8 dot11MeshHWMPRootMode;
2024 bool dot11MeshConnectedToMeshGate;
2025 bool dot11MeshConnectedToAuthServer;
2026 u16 dot11MeshHWMPRannInterval;
2027 bool dot11MeshGateAnnouncementProtocol;
2028 bool dot11MeshForwarding;
2031 u32 dot11MeshHWMPactivePathToRootTimeout;
2032 u16 dot11MeshHWMProotInterval;
2033 u16 dot11MeshHWMPconfirmationInterval;
2034 enum nl80211_mesh_power_mode power_mode;
2035 u16 dot11MeshAwakeWindowDuration;
2037 bool dot11MeshNolearn;
2041 * struct mesh_setup - 802.11s mesh setup configuration
2042 * @chandef: defines the channel to use
2043 * @mesh_id: the mesh ID
2044 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
2045 * @sync_method: which synchronization method to use
2046 * @path_sel_proto: which path selection protocol to use
2047 * @path_metric: which metric to use
2048 * @auth_id: which authentication method this mesh is using
2049 * @ie: vendor information elements (optional)
2050 * @ie_len: length of vendor information elements
2051 * @is_authenticated: this mesh requires authentication
2052 * @is_secure: this mesh uses security
2053 * @user_mpm: userspace handles all MPM functions
2054 * @dtim_period: DTIM period to use
2055 * @beacon_interval: beacon interval to use
2056 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2057 * @basic_rates: basic rates to use when creating the mesh
2058 * @beacon_rate: bitrate to be used for beacons
2059 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2060 * changes the channel when a radar is detected. This is required
2061 * to operate on DFS channels.
2062 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2063 * port frames over NL80211 instead of the network interface.
2065 * These parameters are fixed when the mesh is created.
2068 struct cfg80211_chan_def chandef;
2077 bool is_authenticated;
2081 u16 beacon_interval;
2082 int mcast_rate[NUM_NL80211_BANDS];
2084 struct cfg80211_bitrate_mask beacon_rate;
2085 bool userspace_handles_dfs;
2086 bool control_port_over_nl80211;
2090 * struct ocb_setup - 802.11p OCB mode setup configuration
2091 * @chandef: defines the channel to use
2093 * These parameters are fixed when connecting to the network
2096 struct cfg80211_chan_def chandef;
2100 * struct ieee80211_txq_params - TX queue parameters
2101 * @ac: AC identifier
2102 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2103 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2105 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2107 * @aifs: Arbitration interframe space [0..255]
2109 struct ieee80211_txq_params {
2118 * DOC: Scanning and BSS list handling
2120 * The scanning process itself is fairly simple, but cfg80211 offers quite
2121 * a bit of helper functionality. To start a scan, the scan operation will
2122 * be invoked with a scan definition. This scan definition contains the
2123 * channels to scan, and the SSIDs to send probe requests for (including the
2124 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2125 * probe. Additionally, a scan request may contain extra information elements
2126 * that should be added to the probe request. The IEs are guaranteed to be
2127 * well-formed, and will not exceed the maximum length the driver advertised
2128 * in the wiphy structure.
2130 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2131 * it is responsible for maintaining the BSS list; the driver should not
2132 * maintain a list itself. For this notification, various functions exist.
2134 * Since drivers do not maintain a BSS list, there are also a number of
2135 * functions to search for a BSS and obtain information about it from the
2136 * BSS structure cfg80211 maintains. The BSS list is also made available
2141 * struct cfg80211_ssid - SSID description
2143 * @ssid_len: length of the ssid
2145 struct cfg80211_ssid {
2146 u8 ssid[IEEE80211_MAX_SSID_LEN];
2151 * struct cfg80211_scan_info - information about completed scan
2152 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2153 * wireless device that requested the scan is connected to. If this
2154 * information is not available, this field is left zero.
2155 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2156 * @aborted: set to true if the scan was aborted for any reason,
2157 * userspace will be notified of that
2159 struct cfg80211_scan_info {
2161 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2166 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2168 * @short_bssid: short ssid to scan for
2169 * @bssid: bssid to scan for
2170 * @channel_idx: idx of the channel in the channel array in the scan request
2171 * which the above info relvant to
2172 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2173 * @short_ssid_valid: short_ssid is valid and can be used
2174 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2175 * 20 TUs before starting to send probe requests.
2177 struct cfg80211_scan_6ghz_params {
2181 bool unsolicited_probe;
2182 bool short_ssid_valid;
2187 * struct cfg80211_scan_request - scan request description
2189 * @ssids: SSIDs to scan for (active scan only)
2190 * @n_ssids: number of SSIDs
2191 * @channels: channels to scan on.
2192 * @n_channels: total number of channels to scan
2193 * @scan_width: channel width for scanning
2194 * @ie: optional information element(s) to add into Probe Request or %NULL
2195 * @ie_len: length of ie in octets
2196 * @duration: how long to listen on each channel, in TUs. If
2197 * %duration_mandatory is not set, this is the maximum dwell time and
2198 * the actual dwell time may be shorter.
2199 * @duration_mandatory: if set, the scan duration must be as specified by the
2201 * @flags: bit field of flags controlling operation
2202 * @rates: bitmap of rates to advertise for each band
2203 * @wiphy: the wiphy this was for
2204 * @scan_start: time (in jiffies) when the scan started
2205 * @wdev: the wireless device to scan for
2206 * @info: (internal) information about completed scan
2207 * @notified: (internal) scan request was notified as done or aborted
2208 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2209 * @mac_addr: MAC address used with randomisation
2210 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2211 * are 0 in the mask should be randomised, bits that are 1 should
2212 * be taken from the @mac_addr
2213 * @scan_6ghz: relevant for split scan request only,
2214 * true if this is the second scan request
2215 * @n_6ghz_params: number of 6 GHz params
2216 * @scan_6ghz_params: 6 GHz params
2217 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2219 struct cfg80211_scan_request {
2220 struct cfg80211_ssid *ssids;
2223 enum nl80211_bss_scan_width scan_width;
2227 bool duration_mandatory;
2230 u32 rates[NUM_NL80211_BANDS];
2232 struct wireless_dev *wdev;
2234 u8 mac_addr[ETH_ALEN] __aligned(2);
2235 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2236 u8 bssid[ETH_ALEN] __aligned(2);
2239 struct wiphy *wiphy;
2240 unsigned long scan_start;
2241 struct cfg80211_scan_info info;
2246 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2249 struct ieee80211_channel *channels[];
2252 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2256 get_random_bytes(buf, ETH_ALEN);
2257 for (i = 0; i < ETH_ALEN; i++) {
2259 buf[i] |= addr[i] & mask[i];
2264 * struct cfg80211_match_set - sets of attributes to match
2266 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2267 * or no match (RSSI only)
2268 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2269 * or no match (RSSI only)
2270 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2271 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2272 * for filtering out scan results received. Drivers advertize this support
2273 * of band specific rssi based filtering through the feature capability
2274 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2275 * specific rssi thresholds take precedence over rssi_thold, if specified.
2276 * If not specified for any band, it will be assigned with rssi_thold of
2277 * corresponding matchset.
2279 struct cfg80211_match_set {
2280 struct cfg80211_ssid ssid;
2283 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2287 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2289 * @interval: interval between scheduled scan iterations. In seconds.
2290 * @iterations: number of scan iterations in this scan plan. Zero means
2292 * The last scan plan will always have this parameter set to zero,
2293 * all other scan plans will have a finite number of iterations.
2295 struct cfg80211_sched_scan_plan {
2301 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2303 * @band: band of BSS which should match for RSSI level adjustment.
2304 * @delta: value of RSSI level adjustment.
2306 struct cfg80211_bss_select_adjust {
2307 enum nl80211_band band;
2312 * struct cfg80211_sched_scan_request - scheduled scan request description
2314 * @reqid: identifies this request.
2315 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2316 * @n_ssids: number of SSIDs
2317 * @n_channels: total number of channels to scan
2318 * @scan_width: channel width for scanning
2319 * @ie: optional information element(s) to add into Probe Request or %NULL
2320 * @ie_len: length of ie in octets
2321 * @flags: bit field of flags controlling operation
2322 * @match_sets: sets of parameters to be matched for a scan result
2323 * entry to be considered valid and to be passed to the host
2324 * (others are filtered out).
2325 * If ommited, all results are passed.
2326 * @n_match_sets: number of match sets
2327 * @report_results: indicates that results were reported for this request
2328 * @wiphy: the wiphy this was for
2329 * @dev: the interface
2330 * @scan_start: start time of the scheduled scan
2331 * @channels: channels to scan
2332 * @min_rssi_thold: for drivers only supporting a single threshold, this
2333 * contains the minimum over all matchsets
2334 * @mac_addr: MAC address used with randomisation
2335 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2336 * are 0 in the mask should be randomised, bits that are 1 should
2337 * be taken from the @mac_addr
2338 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2339 * index must be executed first.
2340 * @n_scan_plans: number of scan plans, at least 1.
2341 * @rcu_head: RCU callback used to free the struct
2342 * @owner_nlportid: netlink portid of owner (if this should is a request
2343 * owned by a particular socket)
2344 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2345 * @list: for keeping list of requests.
2346 * @delay: delay in seconds to use before starting the first scan
2347 * cycle. The driver may ignore this parameter and start
2348 * immediately (or at any other time), if this feature is not
2350 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2351 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2352 * reporting in connected state to cases where a matching BSS is determined
2353 * to have better or slightly worse RSSI than the current connected BSS.
2354 * The relative RSSI threshold values are ignored in disconnected state.
2355 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2356 * to the specified band while deciding whether a better BSS is reported
2357 * using @relative_rssi. If delta is a negative number, the BSSs that
2358 * belong to the specified band will be penalized by delta dB in relative
2361 struct cfg80211_sched_scan_request {
2363 struct cfg80211_ssid *ssids;
2366 enum nl80211_bss_scan_width scan_width;
2370 struct cfg80211_match_set *match_sets;
2374 struct cfg80211_sched_scan_plan *scan_plans;
2377 u8 mac_addr[ETH_ALEN] __aligned(2);
2378 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2380 bool relative_rssi_set;
2382 struct cfg80211_bss_select_adjust rssi_adjust;
2385 struct wiphy *wiphy;
2386 struct net_device *dev;
2387 unsigned long scan_start;
2388 bool report_results;
2389 struct rcu_head rcu_head;
2392 struct list_head list;
2395 struct ieee80211_channel *channels[];
2399 * enum cfg80211_signal_type - signal type
2401 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2402 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2403 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2405 enum cfg80211_signal_type {
2406 CFG80211_SIGNAL_TYPE_NONE,
2407 CFG80211_SIGNAL_TYPE_MBM,
2408 CFG80211_SIGNAL_TYPE_UNSPEC,
2412 * struct cfg80211_inform_bss - BSS inform data
2413 * @chan: channel the frame was received on
2414 * @scan_width: scan width that was used
2415 * @signal: signal strength value, according to the wiphy's
2417 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2418 * received; should match the time when the frame was actually
2419 * received by the device (not just by the host, in case it was
2420 * buffered on the device) and be accurate to about 10ms.
2421 * If the frame isn't buffered, just passing the return value of
2422 * ktime_get_boottime_ns() is likely appropriate.
2423 * @parent_tsf: the time at the start of reception of the first octet of the
2424 * timestamp field of the frame. The time is the TSF of the BSS specified
2426 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2427 * the BSS that requested the scan in which the beacon/probe was received.
2428 * @chains: bitmask for filled values in @chain_signal.
2429 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2431 struct cfg80211_inform_bss {
2432 struct ieee80211_channel *chan;
2433 enum nl80211_bss_scan_width scan_width;
2437 u8 parent_bssid[ETH_ALEN] __aligned(2);
2439 s8 chain_signal[IEEE80211_MAX_CHAINS];
2443 * struct cfg80211_bss_ies - BSS entry IE data
2444 * @tsf: TSF contained in the frame that carried these IEs
2445 * @rcu_head: internal use, for freeing
2446 * @len: length of the IEs
2447 * @from_beacon: these IEs are known to come from a beacon
2450 struct cfg80211_bss_ies {
2452 struct rcu_head rcu_head;
2459 * struct cfg80211_bss - BSS description
2461 * This structure describes a BSS (which may also be a mesh network)
2462 * for use in scan results and similar.
2464 * @channel: channel this BSS is on
2465 * @scan_width: width of the control channel
2466 * @bssid: BSSID of the BSS
2467 * @beacon_interval: the beacon interval as from the frame
2468 * @capability: the capability field in host byte order
2469 * @ies: the information elements (Note that there is no guarantee that these
2470 * are well-formed!); this is a pointer to either the beacon_ies or
2471 * proberesp_ies depending on whether Probe Response frame has been
2472 * received. It is always non-%NULL.
2473 * @beacon_ies: the information elements from the last Beacon frame
2474 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2475 * own the beacon_ies, but they're just pointers to the ones from the
2476 * @hidden_beacon_bss struct)
2477 * @proberesp_ies: the information elements from the last Probe Response frame
2478 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2479 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2480 * that holds the beacon data. @beacon_ies is still valid, of course, and
2481 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2482 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2483 * non-transmitted one (multi-BSSID support)
2484 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2485 * (multi-BSSID support)
2486 * @signal: signal strength value (type depends on the wiphy's signal_type)
2487 * @chains: bitmask for filled values in @chain_signal.
2488 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2489 * @bssid_index: index in the multiple BSS set
2490 * @max_bssid_indicator: max number of members in the BSS set
2491 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2493 struct cfg80211_bss {
2494 struct ieee80211_channel *channel;
2495 enum nl80211_bss_scan_width scan_width;
2497 const struct cfg80211_bss_ies __rcu *ies;
2498 const struct cfg80211_bss_ies __rcu *beacon_ies;
2499 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2501 struct cfg80211_bss *hidden_beacon_bss;
2502 struct cfg80211_bss *transmitted_bss;
2503 struct list_head nontrans_list;
2507 u16 beacon_interval;
2512 s8 chain_signal[IEEE80211_MAX_CHAINS];
2515 u8 max_bssid_indicator;
2517 u8 priv[] __aligned(sizeof(void *));
2521 * ieee80211_bss_get_elem - find element with given ID
2522 * @bss: the bss to search
2523 * @id: the element ID
2525 * Note that the return value is an RCU-protected pointer, so
2526 * rcu_read_lock() must be held when calling this function.
2527 * Return: %NULL if not found.
2529 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2532 * ieee80211_bss_get_ie - find IE with given ID
2533 * @bss: the bss to search
2534 * @id: the element ID
2536 * Note that the return value is an RCU-protected pointer, so
2537 * rcu_read_lock() must be held when calling this function.
2538 * Return: %NULL if not found.
2540 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2542 return (void *)ieee80211_bss_get_elem(bss, id);
2547 * struct cfg80211_auth_request - Authentication request data
2549 * This structure provides information needed to complete IEEE 802.11
2552 * @bss: The BSS to authenticate with, the callee must obtain a reference
2553 * to it if it needs to keep it.
2554 * @auth_type: Authentication type (algorithm)
2555 * @ie: Extra IEs to add to Authentication frame or %NULL
2556 * @ie_len: Length of ie buffer in octets
2557 * @key_len: length of WEP key for shared key authentication
2558 * @key_idx: index of WEP key for shared key authentication
2559 * @key: WEP key for shared key authentication
2560 * @auth_data: Fields and elements in Authentication frames. This contains
2561 * the authentication frame body (non-IE and IE data), excluding the
2562 * Authentication algorithm number, i.e., starting at the Authentication
2563 * transaction sequence number field.
2564 * @auth_data_len: Length of auth_data buffer in octets
2566 struct cfg80211_auth_request {
2567 struct cfg80211_bss *bss;
2570 enum nl80211_auth_type auth_type;
2572 u8 key_len, key_idx;
2573 const u8 *auth_data;
2574 size_t auth_data_len;
2578 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2580 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2581 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2582 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2583 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2584 * authentication capability. Drivers can offload authentication to
2585 * userspace if this flag is set. Only applicable for cfg80211_connect()
2586 * request (connect callback).
2587 * @ASSOC_REQ_DISABLE_HE: Disable HE
2589 enum cfg80211_assoc_req_flags {
2590 ASSOC_REQ_DISABLE_HT = BIT(0),
2591 ASSOC_REQ_DISABLE_VHT = BIT(1),
2592 ASSOC_REQ_USE_RRM = BIT(2),
2593 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2594 ASSOC_REQ_DISABLE_HE = BIT(4),
2598 * struct cfg80211_assoc_request - (Re)Association request data
2600 * This structure provides information needed to complete IEEE 802.11
2602 * @bss: The BSS to associate with. If the call is successful the driver is
2603 * given a reference that it must give back to cfg80211_send_rx_assoc()
2604 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2605 * association requests while already associating must be rejected.
2606 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2607 * @ie_len: Length of ie buffer in octets
2608 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2609 * @crypto: crypto settings
2610 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2611 * to indicate a request to reassociate within the ESS instead of a request
2612 * do the initial association with the ESS. When included, this is set to
2613 * the BSSID of the current association, i.e., to the value that is
2614 * included in the Current AP address field of the Reassociation Request
2616 * @flags: See &enum cfg80211_assoc_req_flags
2617 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2618 * will be used in ht_capa. Un-supported values will be ignored.
2619 * @ht_capa_mask: The bits of ht_capa which are to be used.
2620 * @vht_capa: VHT capability override
2621 * @vht_capa_mask: VHT capability mask indicating which fields to use
2622 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2623 * %NULL if FILS is not used.
2624 * @fils_kek_len: Length of fils_kek in octets
2625 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2626 * Request/Response frame or %NULL if FILS is not used. This field starts
2627 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2628 * @s1g_capa: S1G capability override
2629 * @s1g_capa_mask: S1G capability override mask
2631 struct cfg80211_assoc_request {
2632 struct cfg80211_bss *bss;
2633 const u8 *ie, *prev_bssid;
2635 struct cfg80211_crypto_settings crypto;
2638 struct ieee80211_ht_cap ht_capa;
2639 struct ieee80211_ht_cap ht_capa_mask;
2640 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2642 size_t fils_kek_len;
2643 const u8 *fils_nonces;
2644 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2648 * struct cfg80211_deauth_request - Deauthentication request data
2650 * This structure provides information needed to complete IEEE 802.11
2653 * @bssid: the BSSID of the BSS to deauthenticate from
2654 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2655 * @ie_len: Length of ie buffer in octets
2656 * @reason_code: The reason code for the deauthentication
2657 * @local_state_change: if set, change local state only and
2658 * do not set a deauth frame
2660 struct cfg80211_deauth_request {
2665 bool local_state_change;
2669 * struct cfg80211_disassoc_request - Disassociation request data
2671 * This structure provides information needed to complete IEEE 802.11
2674 * @bss: the BSS to disassociate from
2675 * @ie: Extra IEs to add to Disassociation frame or %NULL
2676 * @ie_len: Length of ie buffer in octets
2677 * @reason_code: The reason code for the disassociation
2678 * @local_state_change: This is a request for a local state only, i.e., no
2679 * Disassociation frame is to be transmitted.
2681 struct cfg80211_disassoc_request {
2682 struct cfg80211_bss *bss;
2686 bool local_state_change;
2690 * struct cfg80211_ibss_params - IBSS parameters
2692 * This structure defines the IBSS parameters for the join_ibss()
2695 * @ssid: The SSID, will always be non-null.
2696 * @ssid_len: The length of the SSID, will always be non-zero.
2697 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2698 * search for IBSSs with a different BSSID.
2699 * @chandef: defines the channel to use if no other IBSS to join can be found
2700 * @channel_fixed: The channel should be fixed -- do not search for
2701 * IBSSs to join on other channels.
2702 * @ie: information element(s) to include in the beacon
2703 * @ie_len: length of that
2704 * @beacon_interval: beacon interval to use
2705 * @privacy: this is a protected network, keys will be configured
2707 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2708 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2709 * required to assume that the port is unauthorized until authorized by
2710 * user space. Otherwise, port is marked authorized by default.
2711 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2712 * port frames over NL80211 instead of the network interface.
2713 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2714 * changes the channel when a radar is detected. This is required
2715 * to operate on DFS channels.
2716 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2717 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2718 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2719 * will be used in ht_capa. Un-supported values will be ignored.
2720 * @ht_capa_mask: The bits of ht_capa which are to be used.
2721 * @wep_keys: static WEP keys, if not NULL points to an array of
2722 * CFG80211_MAX_WEP_KEYS WEP keys
2723 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2725 struct cfg80211_ibss_params {
2728 struct cfg80211_chan_def chandef;
2730 u8 ssid_len, ie_len;
2731 u16 beacon_interval;
2736 bool control_port_over_nl80211;
2737 bool userspace_handles_dfs;
2738 int mcast_rate[NUM_NL80211_BANDS];
2739 struct ieee80211_ht_cap ht_capa;
2740 struct ieee80211_ht_cap ht_capa_mask;
2741 struct key_params *wep_keys;
2746 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2748 * @behaviour: requested BSS selection behaviour.
2749 * @param: parameters for requestion behaviour.
2750 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2751 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2753 struct cfg80211_bss_selection {
2754 enum nl80211_bss_select_attr behaviour;
2756 enum nl80211_band band_pref;
2757 struct cfg80211_bss_select_adjust adjust;
2762 * struct cfg80211_connect_params - Connection parameters
2764 * This structure provides information needed to complete IEEE 802.11
2765 * authentication and association.
2767 * @channel: The channel to use or %NULL if not specified (auto-select based
2769 * @channel_hint: The channel of the recommended BSS for initial connection or
2770 * %NULL if not specified
2771 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2773 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2774 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2775 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2778 * @ssid_len: Length of ssid in octets
2779 * @auth_type: Authentication type (algorithm)
2780 * @ie: IEs for association request
2781 * @ie_len: Length of assoc_ie in octets
2782 * @privacy: indicates whether privacy-enabled APs should be used
2783 * @mfp: indicate whether management frame protection is used
2784 * @crypto: crypto settings
2785 * @key_len: length of WEP key for shared key authentication
2786 * @key_idx: index of WEP key for shared key authentication
2787 * @key: WEP key for shared key authentication
2788 * @flags: See &enum cfg80211_assoc_req_flags
2789 * @bg_scan_period: Background scan period in seconds
2790 * or -1 to indicate that default value is to be used.
2791 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2792 * will be used in ht_capa. Un-supported values will be ignored.
2793 * @ht_capa_mask: The bits of ht_capa which are to be used.
2794 * @vht_capa: VHT Capability overrides
2795 * @vht_capa_mask: The bits of vht_capa which are to be used.
2796 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2798 * @bss_select: criteria to be used for BSS selection.
2799 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2800 * to indicate a request to reassociate within the ESS instead of a request
2801 * do the initial association with the ESS. When included, this is set to
2802 * the BSSID of the current association, i.e., to the value that is
2803 * included in the Current AP address field of the Reassociation Request
2805 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2806 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2808 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2809 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2810 * %NULL if not specified. This specifies the domain name of ER server and
2811 * is used to construct FILS wrapped data IE.
2812 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2813 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2814 * messages. This is also used to construct FILS wrapped data IE.
2815 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2816 * keys in FILS or %NULL if not specified.
2817 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2818 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2819 * offload of 4-way handshake.
2820 * @edmg: define the EDMG channels.
2821 * This may specify multiple channels and bonding options for the driver
2822 * to choose from, based on BSS configuration.
2824 struct cfg80211_connect_params {
2825 struct ieee80211_channel *channel;
2826 struct ieee80211_channel *channel_hint;
2828 const u8 *bssid_hint;
2831 enum nl80211_auth_type auth_type;
2835 enum nl80211_mfp mfp;
2836 struct cfg80211_crypto_settings crypto;
2838 u8 key_len, key_idx;
2841 struct ieee80211_ht_cap ht_capa;
2842 struct ieee80211_ht_cap ht_capa_mask;
2843 struct ieee80211_vht_cap vht_capa;
2844 struct ieee80211_vht_cap vht_capa_mask;
2846 struct cfg80211_bss_selection bss_select;
2847 const u8 *prev_bssid;
2848 const u8 *fils_erp_username;
2849 size_t fils_erp_username_len;
2850 const u8 *fils_erp_realm;
2851 size_t fils_erp_realm_len;
2852 u16 fils_erp_next_seq_num;
2853 const u8 *fils_erp_rrk;
2854 size_t fils_erp_rrk_len;
2856 struct ieee80211_edmg edmg;
2860 * enum cfg80211_connect_params_changed - Connection parameters being updated
2862 * This enum provides information of all connect parameters that
2863 * have to be updated as part of update_connect_params() call.
2865 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2866 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2867 * username, erp sequence number and rrk) are updated
2868 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2870 enum cfg80211_connect_params_changed {
2871 UPDATE_ASSOC_IES = BIT(0),
2872 UPDATE_FILS_ERP_INFO = BIT(1),
2873 UPDATE_AUTH_TYPE = BIT(2),
2877 * enum wiphy_params_flags - set_wiphy_params bitfield values
2878 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2879 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2880 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2881 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2882 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2883 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2884 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2885 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2886 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2888 enum wiphy_params_flags {
2889 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2890 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2891 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2892 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2893 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2894 WIPHY_PARAM_DYN_ACK = 1 << 5,
2895 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2896 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2897 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2900 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2902 /* The per TXQ device queue limit in airtime */
2903 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2904 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2906 /* The per interface airtime threshold to switch to lower queue limit */
2907 #define IEEE80211_AQL_THRESHOLD 24000
2910 * struct cfg80211_pmksa - PMK Security Association
2912 * This structure is passed to the set/del_pmksa() method for PMKSA
2915 * @bssid: The AP's BSSID (may be %NULL).
2916 * @pmkid: The identifier to refer a PMKSA.
2917 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2918 * derivation by a FILS STA. Otherwise, %NULL.
2919 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2920 * the hash algorithm used to generate this.
2921 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2922 * cache identifier (may be %NULL).
2923 * @ssid_len: Length of the @ssid in octets.
2924 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2925 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2927 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
2928 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
2929 * The configured PMKSA must not be used for PMKSA caching after
2930 * expiration and any keys derived from this PMK become invalid on
2931 * expiration, i.e., the current association must be dropped if the PMK
2932 * used for it expires.
2933 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
2934 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
2935 * Drivers are expected to trigger a full authentication instead of using
2936 * this PMKSA for caching when reassociating to a new BSS after this
2937 * threshold to generate a new PMK before the current one expires.
2939 struct cfg80211_pmksa {
2948 u8 pmk_reauth_threshold;
2952 * struct cfg80211_pkt_pattern - packet pattern
2953 * @mask: bitmask where to match pattern and where to ignore bytes,
2954 * one bit per byte, in same format as nl80211
2955 * @pattern: bytes to match where bitmask is 1
2956 * @pattern_len: length of pattern (in bytes)
2957 * @pkt_offset: packet offset (in bytes)
2959 * Internal note: @mask and @pattern are allocated in one chunk of
2960 * memory, free @mask only!
2962 struct cfg80211_pkt_pattern {
2963 const u8 *mask, *pattern;
2969 * struct cfg80211_wowlan_tcp - TCP connection parameters
2971 * @sock: (internal) socket for source port allocation
2972 * @src: source IP address
2973 * @dst: destination IP address
2974 * @dst_mac: destination MAC address
2975 * @src_port: source port
2976 * @dst_port: destination port
2977 * @payload_len: data payload length
2978 * @payload: data payload buffer
2979 * @payload_seq: payload sequence stamping configuration
2980 * @data_interval: interval at which to send data packets
2981 * @wake_len: wakeup payload match length
2982 * @wake_data: wakeup payload match data
2983 * @wake_mask: wakeup payload match mask
2984 * @tokens_size: length of the tokens buffer
2985 * @payload_tok: payload token usage configuration
2987 struct cfg80211_wowlan_tcp {
2988 struct socket *sock;
2990 u16 src_port, dst_port;
2991 u8 dst_mac[ETH_ALEN];
2994 struct nl80211_wowlan_tcp_data_seq payload_seq;
2997 const u8 *wake_data, *wake_mask;
2999 /* must be last, variable member */
3000 struct nl80211_wowlan_tcp_data_token payload_tok;
3004 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3006 * This structure defines the enabled WoWLAN triggers for the device.
3007 * @any: wake up on any activity -- special trigger if device continues
3008 * operating as normal during suspend
3009 * @disconnect: wake up if getting disconnected
3010 * @magic_pkt: wake up on receiving magic packet
3011 * @patterns: wake up on receiving packet matching a pattern
3012 * @n_patterns: number of patterns
3013 * @gtk_rekey_failure: wake up on GTK rekey failure
3014 * @eap_identity_req: wake up on EAP identity request packet
3015 * @four_way_handshake: wake up on 4-way handshake
3016 * @rfkill_release: wake up when rfkill is released
3017 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3018 * NULL if not configured.
3019 * @nd_config: configuration for the scan to be used for net detect wake.
3021 struct cfg80211_wowlan {
3022 bool any, disconnect, magic_pkt, gtk_rekey_failure,
3023 eap_identity_req, four_way_handshake,
3025 struct cfg80211_pkt_pattern *patterns;
3026 struct cfg80211_wowlan_tcp *tcp;
3028 struct cfg80211_sched_scan_request *nd_config;
3032 * struct cfg80211_coalesce_rules - Coalesce rule parameters
3034 * This structure defines coalesce rule for the device.
3035 * @delay: maximum coalescing delay in msecs.
3036 * @condition: condition for packet coalescence.
3037 * see &enum nl80211_coalesce_condition.
3038 * @patterns: array of packet patterns
3039 * @n_patterns: number of patterns
3041 struct cfg80211_coalesce_rules {
3043 enum nl80211_coalesce_condition condition;
3044 struct cfg80211_pkt_pattern *patterns;
3049 * struct cfg80211_coalesce - Packet coalescing settings
3051 * This structure defines coalescing settings.
3052 * @rules: array of coalesce rules
3053 * @n_rules: number of rules
3055 struct cfg80211_coalesce {
3056 struct cfg80211_coalesce_rules *rules;
3061 * struct cfg80211_wowlan_nd_match - information about the match
3063 * @ssid: SSID of the match that triggered the wake up
3064 * @n_channels: Number of channels where the match occurred. This
3065 * value may be zero if the driver can't report the channels.
3066 * @channels: center frequencies of the channels where a match
3069 struct cfg80211_wowlan_nd_match {
3070 struct cfg80211_ssid ssid;
3076 * struct cfg80211_wowlan_nd_info - net detect wake up information
3078 * @n_matches: Number of match information instances provided in
3079 * @matches. This value may be zero if the driver can't provide
3080 * match information.
3081 * @matches: Array of pointers to matches containing information about
3082 * the matches that triggered the wake up.
3084 struct cfg80211_wowlan_nd_info {
3086 struct cfg80211_wowlan_nd_match *matches[];
3090 * struct cfg80211_wowlan_wakeup - wakeup report
3091 * @disconnect: woke up by getting disconnected
3092 * @magic_pkt: woke up by receiving magic packet
3093 * @gtk_rekey_failure: woke up by GTK rekey failure
3094 * @eap_identity_req: woke up by EAP identity request packet
3095 * @four_way_handshake: woke up by 4-way handshake
3096 * @rfkill_release: woke up by rfkill being released
3097 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3098 * @packet_present_len: copied wakeup packet data
3099 * @packet_len: original wakeup packet length
3100 * @packet: The packet causing the wakeup, if any.
3101 * @packet_80211: For pattern match, magic packet and other data
3102 * frame triggers an 802.3 frame should be reported, for
3103 * disconnect due to deauth 802.11 frame. This indicates which
3105 * @tcp_match: TCP wakeup packet received
3106 * @tcp_connlost: TCP connection lost or failed to establish
3107 * @tcp_nomoretokens: TCP data ran out of tokens
3108 * @net_detect: if not %NULL, woke up because of net detect
3110 struct cfg80211_wowlan_wakeup {
3111 bool disconnect, magic_pkt, gtk_rekey_failure,
3112 eap_identity_req, four_way_handshake,
3113 rfkill_release, packet_80211,
3114 tcp_match, tcp_connlost, tcp_nomoretokens;
3116 u32 packet_present_len, packet_len;
3118 struct cfg80211_wowlan_nd_info *net_detect;
3122 * struct cfg80211_gtk_rekey_data - rekey data
3123 * @kek: key encryption key (@kek_len bytes)
3124 * @kck: key confirmation key (@kck_len bytes)
3125 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3126 * @kek_len: length of kek
3127 * @kck_len length of kck
3128 * @akm: akm (oui, id)
3130 struct cfg80211_gtk_rekey_data {
3131 const u8 *kek, *kck, *replay_ctr;
3133 u8 kek_len, kck_len;
3137 * struct cfg80211_update_ft_ies_params - FT IE Information
3139 * This structure provides information needed to update the fast transition IE
3141 * @md: The Mobility Domain ID, 2 Octet value
3142 * @ie: Fast Transition IEs
3143 * @ie_len: Length of ft_ie in octets
3145 struct cfg80211_update_ft_ies_params {
3152 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3154 * This structure provides information needed to transmit a mgmt frame
3156 * @chan: channel to use
3157 * @offchan: indicates wether off channel operation is required
3158 * @wait: duration for ROC
3159 * @buf: buffer to transmit
3160 * @len: buffer length
3161 * @no_cck: don't use cck rates for this frame
3162 * @dont_wait_for_ack: tells the low level not to wait for an ack
3163 * @n_csa_offsets: length of csa_offsets array
3164 * @csa_offsets: array of all the csa offsets in the frame
3166 struct cfg80211_mgmt_tx_params {
3167 struct ieee80211_channel *chan;
3173 bool dont_wait_for_ack;
3175 const u16 *csa_offsets;
3179 * struct cfg80211_dscp_exception - DSCP exception
3181 * @dscp: DSCP value that does not adhere to the user priority range definition
3182 * @up: user priority value to which the corresponding DSCP value belongs
3184 struct cfg80211_dscp_exception {
3190 * struct cfg80211_dscp_range - DSCP range definition for user priority
3192 * @low: lowest DSCP value of this user priority range, inclusive
3193 * @high: highest DSCP value of this user priority range, inclusive
3195 struct cfg80211_dscp_range {
3200 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3201 #define IEEE80211_QOS_MAP_MAX_EX 21
3202 #define IEEE80211_QOS_MAP_LEN_MIN 16
3203 #define IEEE80211_QOS_MAP_LEN_MAX \
3204 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3207 * struct cfg80211_qos_map - QoS Map Information
3209 * This struct defines the Interworking QoS map setting for DSCP values
3211 * @num_des: number of DSCP exceptions (0..21)
3212 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3213 * the user priority DSCP range definition
3214 * @up: DSCP range definition for a particular user priority
3216 struct cfg80211_qos_map {
3218 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3219 struct cfg80211_dscp_range up[8];
3223 * struct cfg80211_nan_conf - NAN configuration
3225 * This struct defines NAN configuration parameters
3227 * @master_pref: master preference (1 - 255)
3228 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3229 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3230 * (i.e. BIT(NL80211_BAND_2GHZ)).
3232 struct cfg80211_nan_conf {
3238 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3241 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3242 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3244 enum cfg80211_nan_conf_changes {
3245 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3246 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3250 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3252 * @filter: the content of the filter
3253 * @len: the length of the filter
3255 struct cfg80211_nan_func_filter {
3261 * struct cfg80211_nan_func - a NAN function
3263 * @type: &enum nl80211_nan_function_type
3264 * @service_id: the service ID of the function
3265 * @publish_type: &nl80211_nan_publish_type
3266 * @close_range: if true, the range should be limited. Threshold is
3267 * implementation specific.
3268 * @publish_bcast: if true, the solicited publish should be broadcasted
3269 * @subscribe_active: if true, the subscribe is active
3270 * @followup_id: the instance ID for follow up
3271 * @followup_reqid: the requestor instance ID for follow up
3272 * @followup_dest: MAC address of the recipient of the follow up
3273 * @ttl: time to live counter in DW.
3274 * @serv_spec_info: Service Specific Info
3275 * @serv_spec_info_len: Service Specific Info length
3276 * @srf_include: if true, SRF is inclusive
3277 * @srf_bf: Bloom Filter
3278 * @srf_bf_len: Bloom Filter length
3279 * @srf_bf_idx: Bloom Filter index
3280 * @srf_macs: SRF MAC addresses
3281 * @srf_num_macs: number of MAC addresses in SRF
3282 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3283 * @tx_filters: filters that should be transmitted in the SDF.
3284 * @num_rx_filters: length of &rx_filters.
3285 * @num_tx_filters: length of &tx_filters.
3286 * @instance_id: driver allocated id of the function.
3287 * @cookie: unique NAN function identifier.
3289 struct cfg80211_nan_func {
3290 enum nl80211_nan_function_type type;
3291 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3295 bool subscribe_active;
3298 struct mac_address followup_dest;
3300 const u8 *serv_spec_info;
3301 u8 serv_spec_info_len;
3306 struct mac_address *srf_macs;
3308 struct cfg80211_nan_func_filter *rx_filters;
3309 struct cfg80211_nan_func_filter *tx_filters;
3317 * struct cfg80211_pmk_conf - PMK configuration
3319 * @aa: authenticator address
3320 * @pmk_len: PMK length in bytes.
3321 * @pmk: the PMK material
3322 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3323 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3326 struct cfg80211_pmk_conf {
3330 const u8 *pmk_r0_name;
3334 * struct cfg80211_external_auth_params - Trigger External authentication.
3336 * Commonly used across the external auth request and event interfaces.
3338 * @action: action type / trigger for external authentication. Only significant
3339 * for the authentication request event interface (driver to user space).
3340 * @bssid: BSSID of the peer with which the authentication has
3341 * to happen. Used by both the authentication request event and
3342 * authentication response command interface.
3343 * @ssid: SSID of the AP. Used by both the authentication request event and
3344 * authentication response command interface.
3345 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3346 * authentication request event interface.
3347 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3348 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3349 * the real status code for failures. Used only for the authentication
3350 * response command interface (user space to driver).
3351 * @pmkid: The identifier to refer a PMKSA.
3353 struct cfg80211_external_auth_params {
3354 enum nl80211_external_auth_action action;
3355 u8 bssid[ETH_ALEN] __aligned(2);
3356 struct cfg80211_ssid ssid;
3357 unsigned int key_mgmt_suite;
3363 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3365 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3366 * indicate the relevant values in this struct for them
3367 * @success_num: number of FTM sessions in which all frames were successfully
3369 * @partial_num: number of FTM sessions in which part of frames were
3370 * successfully answered
3371 * @failed_num: number of failed FTM sessions
3372 * @asap_num: number of ASAP FTM sessions
3373 * @non_asap_num: number of non-ASAP FTM sessions
3374 * @total_duration_ms: total sessions durations - gives an indication
3375 * of how much time the responder was busy
3376 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3377 * initiators that didn't finish successfully the negotiation phase with
3379 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3380 * for a new scheduling although it already has scheduled FTM slot
3381 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3383 struct cfg80211_ftm_responder_stats {
3390 u64 total_duration_ms;
3391 u32 unknown_triggers_num;
3392 u32 reschedule_requests_num;
3393 u32 out_of_window_triggers_num;
3397 * struct cfg80211_pmsr_ftm_result - FTM result
3398 * @failure_reason: if this measurement failed (PMSR status is
3399 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3400 * reason than just "failure"
3401 * @burst_index: if reporting partial results, this is the index
3402 * in [0 .. num_bursts-1] of the burst that's being reported
3403 * @num_ftmr_attempts: number of FTM request frames transmitted
3404 * @num_ftmr_successes: number of FTM request frames acked
3405 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3406 * fill this to indicate in how many seconds a retry is deemed possible
3408 * @num_bursts_exp: actual number of bursts exponent negotiated
3409 * @burst_duration: actual burst duration negotiated
3410 * @ftms_per_burst: actual FTMs per burst negotiated
3411 * @lci_len: length of LCI information (if present)
3412 * @civicloc_len: length of civic location information (if present)
3413 * @lci: LCI data (may be %NULL)
3414 * @civicloc: civic location data (may be %NULL)
3415 * @rssi_avg: average RSSI over FTM action frames reported
3416 * @rssi_spread: spread of the RSSI over FTM action frames reported
3417 * @tx_rate: bitrate for transmitted FTM action frame response
3418 * @rx_rate: bitrate of received FTM action frame
3419 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3420 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3421 * the square root of the variance)
3422 * @rtt_spread: spread of the RTTs measured
3423 * @dist_avg: average of distances (mm) measured
3424 * (must have either this or @rtt_avg)
3425 * @dist_variance: variance of distances measured (see also @rtt_variance)
3426 * @dist_spread: spread of distances measured (see also @rtt_spread)
3427 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3428 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3429 * @rssi_avg_valid: @rssi_avg is valid
3430 * @rssi_spread_valid: @rssi_spread is valid
3431 * @tx_rate_valid: @tx_rate is valid
3432 * @rx_rate_valid: @rx_rate is valid
3433 * @rtt_avg_valid: @rtt_avg is valid
3434 * @rtt_variance_valid: @rtt_variance is valid
3435 * @rtt_spread_valid: @rtt_spread is valid
3436 * @dist_avg_valid: @dist_avg is valid
3437 * @dist_variance_valid: @dist_variance is valid
3438 * @dist_spread_valid: @dist_spread is valid
3440 struct cfg80211_pmsr_ftm_result {
3443 unsigned int lci_len;
3444 unsigned int civicloc_len;
3445 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3446 u32 num_ftmr_attempts, num_ftmr_successes;
3454 struct rate_info tx_rate, rx_rate;
3462 u16 num_ftmr_attempts_valid:1,
3463 num_ftmr_successes_valid:1,
3465 rssi_spread_valid:1,
3469 rtt_variance_valid:1,
3472 dist_variance_valid:1,
3473 dist_spread_valid:1;
3477 * struct cfg80211_pmsr_result - peer measurement result
3478 * @addr: address of the peer
3479 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3480 * measurement was made)
3481 * @ap_tsf: AP's TSF at measurement time
3482 * @status: status of the measurement
3483 * @final: if reporting partial results, mark this as the last one; if not
3484 * reporting partial results always set this flag
3485 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3486 * @type: type of the measurement reported, note that we only support reporting
3487 * one type at a time, but you can report multiple results separately and
3488 * they're all aggregated for userspace.
3490 struct cfg80211_pmsr_result {
3491 u64 host_time, ap_tsf;
3492 enum nl80211_peer_measurement_status status;
3499 enum nl80211_peer_measurement_type type;
3502 struct cfg80211_pmsr_ftm_result ftm;
3507 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3508 * @requested: indicates FTM is requested
3509 * @preamble: frame preamble to use
3510 * @burst_period: burst period to use
3511 * @asap: indicates to use ASAP mode
3512 * @num_bursts_exp: number of bursts exponent
3513 * @burst_duration: burst duration
3514 * @ftms_per_burst: number of FTMs per burst
3515 * @ftmr_retries: number of retries for FTM request
3516 * @request_lci: request LCI information
3517 * @request_civicloc: request civic location information
3518 * @trigger_based: use trigger based ranging for the measurement
3519 * If neither @trigger_based nor @non_trigger_based is set,
3520 * EDCA based ranging will be used.
3521 * @non_trigger_based: use non trigger based ranging for the measurement
3522 * If neither @trigger_based nor @non_trigger_based is set,
3523 * EDCA based ranging will be used.
3524 * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
3525 * @trigger_based or @non_trigger_based is set.
3527 * See also nl80211 for the respective attribute documentation.
3529 struct cfg80211_pmsr_ftm_request_peer {
3530 enum nl80211_preamble preamble;
3537 non_trigger_based:1,
3546 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3547 * @addr: MAC address
3548 * @chandef: channel to use
3549 * @report_ap_tsf: report the associated AP's TSF
3550 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3552 struct cfg80211_pmsr_request_peer {
3554 struct cfg80211_chan_def chandef;
3556 struct cfg80211_pmsr_ftm_request_peer ftm;
3560 * struct cfg80211_pmsr_request - peer measurement request
3561 * @cookie: cookie, set by cfg80211
3562 * @nl_portid: netlink portid - used by cfg80211
3563 * @drv_data: driver data for this request, if required for aborting,
3564 * not otherwise freed or anything by cfg80211
3565 * @mac_addr: MAC address used for (randomised) request
3566 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3567 * are 0 in the mask should be randomised, bits that are 1 should
3568 * be taken from the @mac_addr
3569 * @list: used by cfg80211 to hold on to the request
3570 * @timeout: timeout (in milliseconds) for the whole operation, if
3571 * zero it means there's no timeout
3572 * @n_peers: number of peers to do measurements with
3573 * @peers: per-peer measurement request data
3575 struct cfg80211_pmsr_request {
3583 u8 mac_addr[ETH_ALEN] __aligned(2);
3584 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3586 struct list_head list;
3588 struct cfg80211_pmsr_request_peer peers[];
3592 * struct cfg80211_update_owe_info - OWE Information
3594 * This structure provides information needed for the drivers to offload OWE
3595 * (Opportunistic Wireless Encryption) processing to the user space.
3597 * Commonly used across update_owe_info request and event interfaces.
3599 * @peer: MAC address of the peer device for which the OWE processing
3601 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3602 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3603 * cannot give you the real status code for failures. Used only for
3604 * OWE update request command interface (user space to driver).
3605 * @ie: IEs obtained from the peer or constructed by the user space. These are
3606 * the IEs of the remote peer in the event from the host driver and
3607 * the constructed IEs by the user space in the request interface.
3608 * @ie_len: Length of IEs in octets.
3610 struct cfg80211_update_owe_info {
3611 u8 peer[ETH_ALEN] __aligned(2);
3618 * struct mgmt_frame_regs - management frame registrations data
3619 * @global_stypes: bitmap of management frame subtypes registered
3620 * for the entire device
3621 * @interface_stypes: bitmap of management frame subtypes registered
3622 * for the given interface
3623 * @global_mcast_rx: mcast RX is needed globally for these subtypes
3624 * @interface_mcast_stypes: mcast RX is needed on this interface
3625 * for these subtypes
3627 struct mgmt_frame_regs {
3628 u32 global_stypes, interface_stypes;
3629 u32 global_mcast_stypes, interface_mcast_stypes;
3633 * struct cfg80211_ops - backend description for wireless configuration
3635 * This struct is registered by fullmac card drivers and/or wireless stacks
3636 * in order to handle configuration requests on their interfaces.
3638 * All callbacks except where otherwise noted should return 0
3639 * on success or a negative error code.
3641 * All operations are invoked with the wiphy mutex held. The RTNL may be
3642 * held in addition (due to wireless extensions) but this cannot be relied
3643 * upon except in cases where documented below. Note that due to ordering,
3644 * the RTNL also cannot be acquired in any handlers.
3646 * @suspend: wiphy device needs to be suspended. The variable @wow will
3647 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3648 * configured for the device.
3649 * @resume: wiphy device needs to be resumed
3650 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3651 * to call device_set_wakeup_enable() to enable/disable wakeup from
3654 * @add_virtual_intf: create a new virtual interface with the given name,
3655 * must set the struct wireless_dev's iftype. Beware: You must create
3656 * the new netdev in the wiphy's network namespace! Returns the struct
3657 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3658 * also set the address member in the wdev.
3659 * This additionally holds the RTNL to be able to do netdev changes.
3661 * @del_virtual_intf: remove the virtual interface
3662 * This additionally holds the RTNL to be able to do netdev changes.
3664 * @change_virtual_intf: change type/configuration of virtual interface,
3665 * keep the struct wireless_dev's iftype updated.
3666 * This additionally holds the RTNL to be able to do netdev changes.
3668 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3669 * when adding a group key.
3671 * @get_key: get information about the key with the given parameters.
3672 * @mac_addr will be %NULL when requesting information for a group
3673 * key. All pointers given to the @callback function need not be valid
3674 * after it returns. This function should return an error if it is
3675 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3677 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3678 * and @key_index, return -ENOENT if the key doesn't exist.
3680 * @set_default_key: set the default key on an interface
3682 * @set_default_mgmt_key: set the default management frame key on an interface
3684 * @set_default_beacon_key: set the default Beacon frame key on an interface
3686 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3688 * @start_ap: Start acting in AP mode defined by the parameters.
3689 * @change_beacon: Change the beacon parameters for an access point mode
3690 * interface. This should reject the call when AP mode wasn't started.
3691 * @stop_ap: Stop being an AP, including stopping beaconing.
3693 * @add_station: Add a new station.
3694 * @del_station: Remove a station
3695 * @change_station: Modify a given station. Note that flags changes are not much
3696 * validated in cfg80211, in particular the auth/assoc/authorized flags
3697 * might come to the driver in invalid combinations -- make sure to check
3698 * them, also against the existing state! Drivers must call
3699 * cfg80211_check_station_change() to validate the information.
3700 * @get_station: get station information for the station identified by @mac
3701 * @dump_station: dump station callback -- resume dump at index @idx
3703 * @add_mpath: add a fixed mesh path
3704 * @del_mpath: delete a given mesh path
3705 * @change_mpath: change a given mesh path
3706 * @get_mpath: get a mesh path for the given parameters
3707 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3708 * @get_mpp: get a mesh proxy path for the given parameters
3709 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3710 * @join_mesh: join the mesh network with the specified parameters
3711 * (invoked with the wireless_dev mutex held)
3712 * @leave_mesh: leave the current mesh network
3713 * (invoked with the wireless_dev mutex held)
3715 * @get_mesh_config: Get the current mesh configuration
3717 * @update_mesh_config: Update mesh parameters on a running mesh.
3718 * The mask is a bitfield which tells us which parameters to
3719 * set, and which to leave alone.
3721 * @change_bss: Modify parameters for a given BSS.
3723 * @set_txq_params: Set TX queue parameters
3725 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3726 * as it doesn't implement join_mesh and needs to set the channel to
3727 * join the mesh instead.
3729 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3730 * interfaces are active this callback should reject the configuration.
3731 * If no interfaces are active or the device is down, the channel should
3732 * be stored for when a monitor interface becomes active.
3734 * @scan: Request to do a scan. If returning zero, the scan request is given
3735 * the driver, and will be valid until passed to cfg80211_scan_done().
3736 * For scan results, call cfg80211_inform_bss(); you can call this outside
3737 * the scan/scan_done bracket too.
3738 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3739 * indicate the status of the scan through cfg80211_scan_done().
3741 * @auth: Request to authenticate with the specified peer
3742 * (invoked with the wireless_dev mutex held)
3743 * @assoc: Request to (re)associate with the specified peer
3744 * (invoked with the wireless_dev mutex held)
3745 * @deauth: Request to deauthenticate from the specified peer
3746 * (invoked with the wireless_dev mutex held)
3747 * @disassoc: Request to disassociate from the specified peer
3748 * (invoked with the wireless_dev mutex held)
3750 * @connect: Connect to the ESS with the specified parameters. When connected,
3751 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3752 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3753 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3754 * from the AP or cfg80211_connect_timeout() if no frame with status code
3756 * The driver is allowed to roam to other BSSes within the ESS when the
3757 * other BSS matches the connect parameters. When such roaming is initiated
3758 * by the driver, the driver is expected to verify that the target matches
3759 * the configured security parameters and to use Reassociation Request
3760 * frame instead of Association Request frame.
3761 * The connect function can also be used to request the driver to perform a
3762 * specific roam when connected to an ESS. In that case, the prev_bssid
3763 * parameter is set to the BSSID of the currently associated BSS as an
3764 * indication of requesting reassociation.
3765 * In both the driver-initiated and new connect() call initiated roaming
3766 * cases, the result of roaming is indicated with a call to
3767 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3768 * @update_connect_params: Update the connect parameters while connected to a
3769 * BSS. The updated parameters can be used by driver/firmware for
3770 * subsequent BSS selection (roaming) decisions and to form the
3771 * Authentication/(Re)Association Request frames. This call does not
3772 * request an immediate disassociation or reassociation with the current
3773 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3774 * changed are defined in &enum cfg80211_connect_params_changed.
3775 * (invoked with the wireless_dev mutex held)
3776 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3777 * connection is in progress. Once done, call cfg80211_disconnected() in
3778 * case connection was already established (invoked with the
3779 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3781 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3782 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3784 * (invoked with the wireless_dev mutex held)
3785 * @leave_ibss: Leave the IBSS.
3786 * (invoked with the wireless_dev mutex held)
3788 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3791 * @set_wiphy_params: Notify that wiphy parameters have changed;
3792 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3793 * have changed. The actual parameter values are available in
3794 * struct wiphy. If returning an error, no value should be changed.
3796 * @set_tx_power: set the transmit power according to the parameters,
3797 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3798 * wdev may be %NULL if power was set for the wiphy, and will
3799 * always be %NULL unless the driver supports per-vif TX power
3800 * (as advertised by the nl80211 feature flag.)
3801 * @get_tx_power: store the current TX power into the dbm variable;
3802 * return 0 if successful
3804 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3805 * functions to adjust rfkill hw state
3807 * @dump_survey: get site survey information.
3809 * @remain_on_channel: Request the driver to remain awake on the specified
3810 * channel for the specified duration to complete an off-channel
3811 * operation (e.g., public action frame exchange). When the driver is
3812 * ready on the requested channel, it must indicate this with an event
3813 * notification by calling cfg80211_ready_on_channel().
3814 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3815 * This allows the operation to be terminated prior to timeout based on
3816 * the duration value.
3817 * @mgmt_tx: Transmit a management frame.
3818 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3819 * frame on another channel
3821 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3822 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3823 * used by the function, but 0 and 1 must not be touched. Additionally,
3824 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3825 * dump and return to userspace with an error, so be careful. If any data
3826 * was passed in from userspace then the data/len arguments will be present
3827 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3829 * @set_bitrate_mask: set the bitrate mask configuration
3831 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3832 * devices running firmwares capable of generating the (re) association
3833 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3834 * @del_pmksa: Delete a cached PMKID.
3835 * @flush_pmksa: Flush all cached PMKIDs.
3836 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3837 * allows the driver to adjust the dynamic ps timeout value.
3838 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3839 * After configuration, the driver should (soon) send an event indicating
3840 * the current level is above/below the configured threshold; this may
3841 * need some care when the configuration is changed (without first being
3843 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3844 * connection quality monitor. An event is to be sent only when the
3845 * signal level is found to be outside the two values. The driver should
3846 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3847 * If it is provided then there's no point providing @set_cqm_rssi_config.
3848 * @set_cqm_txe_config: Configure connection quality monitor TX error
3850 * @sched_scan_start: Tell the driver to start a scheduled scan.
3851 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3852 * given request id. This call must stop the scheduled scan and be ready
3853 * for starting a new one before it returns, i.e. @sched_scan_start may be
3854 * called immediately after that again and should not fail in that case.
3855 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3856 * stop (when this method returns 0).
3858 * @update_mgmt_frame_registrations: Notify the driver that management frame
3859 * registrations were updated. The callback is allowed to sleep.
3861 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3862 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3863 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3864 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3866 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3868 * @tdls_mgmt: Transmit a TDLS management frame.
3869 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3871 * @probe_client: probe an associated client, must return a cookie that it
3872 * later passes to cfg80211_probe_status().
3874 * @set_noack_map: Set the NoAck Map for the TIDs.
3876 * @get_channel: Get the current operating channel for the virtual interface.
3877 * For monitor interfaces, it should return %NULL unless there's a single
3878 * current monitoring channel.
3880 * @start_p2p_device: Start the given P2P device.
3881 * @stop_p2p_device: Stop the given P2P device.
3883 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3884 * Parameters include ACL policy, an array of MAC address of stations
3885 * and the number of MAC addresses. If there is already a list in driver
3886 * this new list replaces the existing one. Driver has to clear its ACL
3887 * when number of MAC addresses entries is passed as 0. Drivers which
3888 * advertise the support for MAC based ACL have to implement this callback.
3890 * @start_radar_detection: Start radar detection in the driver.
3892 * @end_cac: End running CAC, probably because a related CAC
3893 * was finished on another phy.
3895 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3896 * driver. If the SME is in the driver/firmware, this information can be
3897 * used in building Authentication and Reassociation Request frames.
3899 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3900 * for a given duration (milliseconds). The protocol is provided so the
3901 * driver can take the most appropriate actions.
3902 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3903 * reliability. This operation can not fail.
3904 * @set_coalesce: Set coalesce parameters.
3906 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3907 * responsible for veryfing if the switch is possible. Since this is
3908 * inherently tricky driver may decide to disconnect an interface later
3909 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3910 * everything. It should do it's best to verify requests and reject them
3911 * as soon as possible.
3913 * @set_qos_map: Set QoS mapping information to the driver
3915 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3916 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3917 * changes during the lifetime of the BSS.
3919 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3920 * with the given parameters; action frame exchange has been handled by
3921 * userspace so this just has to modify the TX path to take the TS into
3923 * If the admitted time is 0 just validate the parameters to make sure
3924 * the session can be created at all; it is valid to just always return
3925 * success for that but that may result in inefficient behaviour (handshake
3926 * with the peer followed by immediate teardown when the addition is later
3928 * @del_tx_ts: remove an existing TX TS
3930 * @join_ocb: join the OCB network with the specified parameters
3931 * (invoked with the wireless_dev mutex held)
3932 * @leave_ocb: leave the current OCB network
3933 * (invoked with the wireless_dev mutex held)
3935 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3936 * is responsible for continually initiating channel-switching operations
3937 * and returning to the base channel for communication with the AP.
3938 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3939 * peers must be on the base channel when the call completes.
3940 * @start_nan: Start the NAN interface.
3941 * @stop_nan: Stop the NAN interface.
3942 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3943 * On success @nan_func ownership is transferred to the driver and
3944 * it may access it outside of the scope of this function. The driver
3945 * should free the @nan_func when no longer needed by calling
3946 * cfg80211_free_nan_func().
3947 * On success the driver should assign an instance_id in the
3948 * provided @nan_func.
3949 * @del_nan_func: Delete a NAN function.
3950 * @nan_change_conf: changes NAN configuration. The changed parameters must
3951 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3952 * All other parameters must be ignored.
3954 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3956 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3957 * function should return phy stats, and interface stats otherwise.
3959 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3960 * If not deleted through @del_pmk the PMK remains valid until disconnect
3961 * upon which the driver should clear it.
3962 * (invoked with the wireless_dev mutex held)
3963 * @del_pmk: delete the previously configured PMK for the given authenticator.
3964 * (invoked with the wireless_dev mutex held)
3966 * @external_auth: indicates result of offloaded authentication processing from
3969 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3970 * tells the driver that the frame should not be encrypted.
3972 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3973 * Statistics should be cumulative, currently no way to reset is provided.
3974 * @start_pmsr: start peer measurement (e.g. FTM)
3975 * @abort_pmsr: abort peer measurement
3977 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3978 * but offloading OWE processing to the user space will get the updated
3979 * DH IE through this interface.
3981 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3982 * and overrule HWMP path selection algorithm.
3983 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
3984 * This callback may sleep.
3985 * @reset_tid_config: Reset TID specific configuration for the peer, for the
3986 * given TIDs. This callback may sleep.
3988 * @set_sar_specs: Update the SAR (TX power) settings.
3990 struct cfg80211_ops {
3991 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3992 int (*resume)(struct wiphy *wiphy);
3993 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3995 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3997 unsigned char name_assign_type,
3998 enum nl80211_iftype type,
3999 struct vif_params *params);
4000 int (*del_virtual_intf)(struct wiphy *wiphy,
4001 struct wireless_dev *wdev);
4002 int (*change_virtual_intf)(struct wiphy *wiphy,
4003 struct net_device *dev,
4004 enum nl80211_iftype type,
4005 struct vif_params *params);
4007 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4008 u8 key_index, bool pairwise, const u8 *mac_addr,
4009 struct key_params *params);
4010 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4011 u8 key_index, bool pairwise, const u8 *mac_addr,
4013 void (*callback)(void *cookie, struct key_params*));
4014 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4015 u8 key_index, bool pairwise, const u8 *mac_addr);
4016 int (*set_default_key)(struct wiphy *wiphy,
4017 struct net_device *netdev,
4018 u8 key_index, bool unicast, bool multicast);
4019 int (*set_default_mgmt_key)(struct wiphy *wiphy,
4020 struct net_device *netdev,
4022 int (*set_default_beacon_key)(struct wiphy *wiphy,
4023 struct net_device *netdev,
4026 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4027 struct cfg80211_ap_settings *settings);
4028 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4029 struct cfg80211_beacon_data *info);
4030 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
4033 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
4035 struct station_parameters *params);
4036 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
4037 struct station_del_parameters *params);
4038 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
4040 struct station_parameters *params);
4041 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
4042 const u8 *mac, struct station_info *sinfo);
4043 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4044 int idx, u8 *mac, struct station_info *sinfo);
4046 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4047 const u8 *dst, const u8 *next_hop);
4048 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4050 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4051 const u8 *dst, const u8 *next_hop);
4052 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4053 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4054 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4055 int idx, u8 *dst, u8 *next_hop,
4056 struct mpath_info *pinfo);
4057 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4058 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4059 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4060 int idx, u8 *dst, u8 *mpp,
4061 struct mpath_info *pinfo);
4062 int (*get_mesh_config)(struct wiphy *wiphy,
4063 struct net_device *dev,
4064 struct mesh_config *conf);
4065 int (*update_mesh_config)(struct wiphy *wiphy,
4066 struct net_device *dev, u32 mask,
4067 const struct mesh_config *nconf);
4068 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4069 const struct mesh_config *conf,
4070 const struct mesh_setup *setup);
4071 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4073 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4074 struct ocb_setup *setup);
4075 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4077 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4078 struct bss_parameters *params);
4080 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4081 struct ieee80211_txq_params *params);
4083 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4084 struct net_device *dev,
4085 struct ieee80211_channel *chan);
4087 int (*set_monitor_channel)(struct wiphy *wiphy,
4088 struct cfg80211_chan_def *chandef);
4090 int (*scan)(struct wiphy *wiphy,
4091 struct cfg80211_scan_request *request);
4092 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4094 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4095 struct cfg80211_auth_request *req);
4096 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4097 struct cfg80211_assoc_request *req);
4098 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4099 struct cfg80211_deauth_request *req);
4100 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4101 struct cfg80211_disassoc_request *req);
4103 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4104 struct cfg80211_connect_params *sme);
4105 int (*update_connect_params)(struct wiphy *wiphy,
4106 struct net_device *dev,
4107 struct cfg80211_connect_params *sme,
4109 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4112 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4113 struct cfg80211_ibss_params *params);
4114 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4116 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4117 int rate[NUM_NL80211_BANDS]);
4119 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4121 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4122 enum nl80211_tx_power_setting type, int mbm);
4123 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4126 void (*rfkill_poll)(struct wiphy *wiphy);
4128 #ifdef CONFIG_NL80211_TESTMODE
4129 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4130 void *data, int len);
4131 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4132 struct netlink_callback *cb,
4133 void *data, int len);
4136 int (*set_bitrate_mask)(struct wiphy *wiphy,
4137 struct net_device *dev,
4139 const struct cfg80211_bitrate_mask *mask);
4141 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4142 int idx, struct survey_info *info);
4144 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4145 struct cfg80211_pmksa *pmksa);
4146 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4147 struct cfg80211_pmksa *pmksa);
4148 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4150 int (*remain_on_channel)(struct wiphy *wiphy,
4151 struct wireless_dev *wdev,
4152 struct ieee80211_channel *chan,
4153 unsigned int duration,
4155 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4156 struct wireless_dev *wdev,
4159 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4160 struct cfg80211_mgmt_tx_params *params,
4162 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4163 struct wireless_dev *wdev,
4166 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4167 bool enabled, int timeout);
4169 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4170 struct net_device *dev,
4171 s32 rssi_thold, u32 rssi_hyst);
4173 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4174 struct net_device *dev,
4175 s32 rssi_low, s32 rssi_high);
4177 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4178 struct net_device *dev,
4179 u32 rate, u32 pkts, u32 intvl);
4181 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4182 struct wireless_dev *wdev,
4183 struct mgmt_frame_regs *upd);
4185 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4186 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4188 int (*sched_scan_start)(struct wiphy *wiphy,
4189 struct net_device *dev,
4190 struct cfg80211_sched_scan_request *request);
4191 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4194 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4195 struct cfg80211_gtk_rekey_data *data);
4197 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4198 const u8 *peer, u8 action_code, u8 dialog_token,
4199 u16 status_code, u32 peer_capability,
4200 bool initiator, const u8 *buf, size_t len);
4201 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4202 const u8 *peer, enum nl80211_tdls_operation oper);
4204 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4205 const u8 *peer, u64 *cookie);
4207 int (*set_noack_map)(struct wiphy *wiphy,
4208 struct net_device *dev,
4211 int (*get_channel)(struct wiphy *wiphy,
4212 struct wireless_dev *wdev,
4213 struct cfg80211_chan_def *chandef);
4215 int (*start_p2p_device)(struct wiphy *wiphy,
4216 struct wireless_dev *wdev);
4217 void (*stop_p2p_device)(struct wiphy *wiphy,
4218 struct wireless_dev *wdev);
4220 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4221 const struct cfg80211_acl_data *params);
4223 int (*start_radar_detection)(struct wiphy *wiphy,
4224 struct net_device *dev,
4225 struct cfg80211_chan_def *chandef,
4227 void (*end_cac)(struct wiphy *wiphy,
4228 struct net_device *dev);
4229 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4230 struct cfg80211_update_ft_ies_params *ftie);
4231 int (*crit_proto_start)(struct wiphy *wiphy,
4232 struct wireless_dev *wdev,
4233 enum nl80211_crit_proto_id protocol,
4235 void (*crit_proto_stop)(struct wiphy *wiphy,
4236 struct wireless_dev *wdev);
4237 int (*set_coalesce)(struct wiphy *wiphy,
4238 struct cfg80211_coalesce *coalesce);
4240 int (*channel_switch)(struct wiphy *wiphy,
4241 struct net_device *dev,
4242 struct cfg80211_csa_settings *params);
4244 int (*set_qos_map)(struct wiphy *wiphy,
4245 struct net_device *dev,
4246 struct cfg80211_qos_map *qos_map);
4248 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4249 struct cfg80211_chan_def *chandef);
4251 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4252 u8 tsid, const u8 *peer, u8 user_prio,
4254 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4255 u8 tsid, const u8 *peer);
4257 int (*tdls_channel_switch)(struct wiphy *wiphy,
4258 struct net_device *dev,
4259 const u8 *addr, u8 oper_class,
4260 struct cfg80211_chan_def *chandef);
4261 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4262 struct net_device *dev,
4264 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4265 struct cfg80211_nan_conf *conf);
4266 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4267 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4268 struct cfg80211_nan_func *nan_func);
4269 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4271 int (*nan_change_conf)(struct wiphy *wiphy,
4272 struct wireless_dev *wdev,
4273 struct cfg80211_nan_conf *conf,
4276 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4277 struct net_device *dev,
4278 const bool enabled);
4280 int (*get_txq_stats)(struct wiphy *wiphy,
4281 struct wireless_dev *wdev,
4282 struct cfg80211_txq_stats *txqstats);
4284 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4285 const struct cfg80211_pmk_conf *conf);
4286 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4288 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4289 struct cfg80211_external_auth_params *params);
4291 int (*tx_control_port)(struct wiphy *wiphy,
4292 struct net_device *dev,
4293 const u8 *buf, size_t len,
4294 const u8 *dest, const __be16 proto,
4295 const bool noencrypt,
4298 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4299 struct net_device *dev,
4300 struct cfg80211_ftm_responder_stats *ftm_stats);
4302 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4303 struct cfg80211_pmsr_request *request);
4304 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4305 struct cfg80211_pmsr_request *request);
4306 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4307 struct cfg80211_update_owe_info *owe_info);
4308 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4309 const u8 *buf, size_t len);
4310 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4311 struct cfg80211_tid_config *tid_conf);
4312 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4313 const u8 *peer, u8 tids);
4314 int (*set_sar_specs)(struct wiphy *wiphy,
4315 struct cfg80211_sar_specs *sar);
4319 * wireless hardware and networking interfaces structures
4320 * and registration/helper functions
4324 * enum wiphy_flags - wiphy capability flags
4326 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4327 * into two, first for legacy bands and second for UHB.
4328 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4330 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4331 * by default -- this flag will be set depending on the kernel's default
4332 * on wiphy_new(), but can be changed by the driver if it has a good
4333 * reason to override the default
4334 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4335 * on a VLAN interface). This flag also serves an extra purpose of
4336 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4337 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4338 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4339 * control port protocol ethertype. The device also honours the
4340 * control_port_no_encrypt flag.
4341 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4342 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4343 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4344 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4346 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4347 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4348 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4349 * link setup/discovery operations internally. Setup, discovery and
4350 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4351 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4352 * used for asking the driver/firmware to perform a TDLS operation.
4353 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4354 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4355 * when there are virtual interfaces in AP mode by calling
4356 * cfg80211_report_obss_beacon().
4357 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4358 * responds to probe-requests in hardware.
4359 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4360 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4361 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4362 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4363 * beaconing mode (AP, IBSS, Mesh, ...).
4364 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4365 * before connection.
4366 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4369 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4371 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4372 WIPHY_FLAG_NETNS_OK = BIT(3),
4373 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4374 WIPHY_FLAG_4ADDR_AP = BIT(5),
4375 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4376 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4377 WIPHY_FLAG_IBSS_RSN = BIT(8),
4378 WIPHY_FLAG_MESH_AUTH = BIT(10),
4379 /* use hole at 11 */
4380 /* use hole at 12 */
4381 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4382 WIPHY_FLAG_AP_UAPSD = BIT(14),
4383 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4384 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4385 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4386 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4387 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4388 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4389 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4390 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4391 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4392 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4396 * struct ieee80211_iface_limit - limit on certain interface types
4397 * @max: maximum number of interfaces of these types
4398 * @types: interface types (bits)
4400 struct ieee80211_iface_limit {
4406 * struct ieee80211_iface_combination - possible interface combination
4408 * With this structure the driver can describe which interface
4409 * combinations it supports concurrently.
4413 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4417 * struct ieee80211_iface_limit limits1[] = {
4418 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4419 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4421 * struct ieee80211_iface_combination combination1 = {
4422 * .limits = limits1,
4423 * .n_limits = ARRAY_SIZE(limits1),
4424 * .max_interfaces = 2,
4425 * .beacon_int_infra_match = true,
4429 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4433 * struct ieee80211_iface_limit limits2[] = {
4434 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4435 * BIT(NL80211_IFTYPE_P2P_GO), },
4437 * struct ieee80211_iface_combination combination2 = {
4438 * .limits = limits2,
4439 * .n_limits = ARRAY_SIZE(limits2),
4440 * .max_interfaces = 8,
4441 * .num_different_channels = 1,
4445 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4447 * This allows for an infrastructure connection and three P2P connections.
4451 * struct ieee80211_iface_limit limits3[] = {
4452 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4453 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4454 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4456 * struct ieee80211_iface_combination combination3 = {
4457 * .limits = limits3,
4458 * .n_limits = ARRAY_SIZE(limits3),
4459 * .max_interfaces = 4,
4460 * .num_different_channels = 2,
4464 struct ieee80211_iface_combination {
4467 * limits for the given interface types
4469 const struct ieee80211_iface_limit *limits;
4472 * @num_different_channels:
4473 * can use up to this many different channels
4475 u32 num_different_channels;
4479 * maximum number of interfaces in total allowed in this group
4485 * number of limitations
4490 * @beacon_int_infra_match:
4491 * In this combination, the beacon intervals between infrastructure
4492 * and AP types must match. This is required only in special cases.
4494 bool beacon_int_infra_match;
4497 * @radar_detect_widths:
4498 * bitmap of channel widths supported for radar detection
4500 u8 radar_detect_widths;
4503 * @radar_detect_regions:
4504 * bitmap of regions supported for radar detection
4506 u8 radar_detect_regions;
4509 * @beacon_int_min_gcd:
4510 * This interface combination supports different beacon intervals.
4513 * all beacon intervals for different interface must be same.
4515 * any beacon interval for the interface part of this combination AND
4516 * GCD of all beacon intervals from beaconing interfaces of this
4517 * combination must be greater or equal to this value.
4519 u32 beacon_int_min_gcd;
4522 struct ieee80211_txrx_stypes {
4527 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4528 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4529 * trigger that keeps the device operating as-is and
4530 * wakes up the host on any activity, for example a
4531 * received packet that passed filtering; note that the
4532 * packet should be preserved in that case
4533 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4535 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4536 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4537 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4538 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4539 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4540 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4541 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4543 enum wiphy_wowlan_support_flags {
4544 WIPHY_WOWLAN_ANY = BIT(0),
4545 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4546 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4547 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4548 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4549 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4550 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4551 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4552 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4555 struct wiphy_wowlan_tcp_support {
4556 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4557 u32 data_payload_max;
4558 u32 data_interval_max;
4559 u32 wake_payload_max;
4564 * struct wiphy_wowlan_support - WoWLAN support data
4565 * @flags: see &enum wiphy_wowlan_support_flags
4566 * @n_patterns: number of supported wakeup patterns
4567 * (see nl80211.h for the pattern definition)
4568 * @pattern_max_len: maximum length of each pattern
4569 * @pattern_min_len: minimum length of each pattern
4570 * @max_pkt_offset: maximum Rx packet offset
4571 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4572 * similar, but not necessarily identical, to max_match_sets for
4574 * See &struct cfg80211_sched_scan_request.@match_sets for more
4576 * @tcp: TCP wakeup support information
4578 struct wiphy_wowlan_support {
4581 int pattern_max_len;
4582 int pattern_min_len;
4584 int max_nd_match_sets;
4585 const struct wiphy_wowlan_tcp_support *tcp;
4589 * struct wiphy_coalesce_support - coalesce support data
4590 * @n_rules: maximum number of coalesce rules
4591 * @max_delay: maximum supported coalescing delay in msecs
4592 * @n_patterns: number of supported patterns in a rule
4593 * (see nl80211.h for the pattern definition)
4594 * @pattern_max_len: maximum length of each pattern
4595 * @pattern_min_len: minimum length of each pattern
4596 * @max_pkt_offset: maximum Rx packet offset
4598 struct wiphy_coalesce_support {
4602 int pattern_max_len;
4603 int pattern_min_len;
4608 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4609 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4610 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4611 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4612 * (must be combined with %_WDEV or %_NETDEV)
4614 enum wiphy_vendor_command_flags {
4615 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4616 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4617 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4621 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4623 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4624 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4625 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4628 enum wiphy_opmode_flag {
4629 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4630 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4631 STA_OPMODE_N_SS_CHANGED = BIT(2),
4635 * struct sta_opmode_info - Station's ht/vht operation mode information
4636 * @changed: contains value from &enum wiphy_opmode_flag
4637 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4638 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4639 * @rx_nss: new rx_nss value of a station
4642 struct sta_opmode_info {
4644 enum nl80211_smps_mode smps_mode;
4645 enum nl80211_chan_width bw;
4649 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4652 * struct wiphy_vendor_command - vendor command definition
4653 * @info: vendor command identifying information, as used in nl80211
4654 * @flags: flags, see &enum wiphy_vendor_command_flags
4655 * @doit: callback for the operation, note that wdev is %NULL if the
4656 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4657 * pointer may be %NULL if userspace provided no data at all
4658 * @dumpit: dump callback, for transferring bigger/multiple items. The
4659 * @storage points to cb->args[5], ie. is preserved over the multiple
4661 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4662 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4663 * attribute is just raw data (e.g. a firmware command).
4664 * @maxattr: highest attribute number in policy
4665 * It's recommended to not have the same sub command with both @doit and
4666 * @dumpit, so that userspace can assume certain ones are get and others
4667 * are used with dump requests.
4669 struct wiphy_vendor_command {
4670 struct nl80211_vendor_cmd_info info;
4672 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4673 const void *data, int data_len);
4674 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4675 struct sk_buff *skb, const void *data, int data_len,
4676 unsigned long *storage);
4677 const struct nla_policy *policy;
4678 unsigned int maxattr;
4682 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4683 * @iftype: interface type
4684 * @extended_capabilities: extended capabilities supported by the driver,
4685 * additional capabilities might be supported by userspace; these are the
4686 * 802.11 extended capabilities ("Extended Capabilities element") and are
4687 * in the same format as in the information element. See IEEE Std
4688 * 802.11-2012 8.4.2.29 for the defined fields.
4689 * @extended_capabilities_mask: mask of the valid values
4690 * @extended_capabilities_len: length of the extended capabilities
4692 struct wiphy_iftype_ext_capab {
4693 enum nl80211_iftype iftype;
4694 const u8 *extended_capabilities;
4695 const u8 *extended_capabilities_mask;
4696 u8 extended_capabilities_len;
4700 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4701 * @max_peers: maximum number of peers in a single measurement
4702 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4703 * @randomize_mac_addr: can randomize MAC address for measurement
4704 * @ftm.supported: FTM measurement is supported
4705 * @ftm.asap: ASAP-mode is supported
4706 * @ftm.non_asap: non-ASAP-mode is supported
4707 * @ftm.request_lci: can request LCI data
4708 * @ftm.request_civicloc: can request civic location data
4709 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4710 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4711 * @ftm.max_bursts_exponent: maximum burst exponent supported
4712 * (set to -1 if not limited; note that setting this will necessarily
4713 * forbid using the value 15 to let the responder pick)
4714 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4716 * @ftm.trigger_based: trigger based ranging measurement is supported
4717 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
4719 struct cfg80211_pmsr_capabilities {
4720 unsigned int max_peers;
4722 randomize_mac_addr:1;
4727 s8 max_bursts_exponent;
4728 u8 max_ftms_per_burst;
4735 non_trigger_based:1;
4740 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4741 * suites for interface types defined in @iftypes_mask. Each type in the
4742 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4744 * @iftypes_mask: bitmask of interfaces types
4745 * @akm_suites: points to an array of supported akm suites
4746 * @n_akm_suites: number of supported AKM suites
4748 struct wiphy_iftype_akm_suites {
4750 const u32 *akm_suites;
4755 * struct wiphy - wireless hardware description
4756 * @mtx: mutex for the data (structures) of this device
4757 * @reg_notifier: the driver's regulatory notification callback,
4758 * note that if your driver uses wiphy_apply_custom_regulatory()
4759 * the reg_notifier's request can be passed as NULL
4760 * @regd: the driver's regulatory domain, if one was requested via
4761 * the regulatory_hint() API. This can be used by the driver
4762 * on the reg_notifier() if it chooses to ignore future
4763 * regulatory domain changes caused by other drivers.
4764 * @signal_type: signal type reported in &struct cfg80211_bss.
4765 * @cipher_suites: supported cipher suites
4766 * @n_cipher_suites: number of supported cipher suites
4767 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4768 * the supported AKMs not advertized for a specific interface type in
4769 * iftype_akm_suites.
4770 * @n_akm_suites: number of supported AKM suites
4771 * @iftype_akm_suites: array of supported akm suites info per interface type.
4772 * Note that the bits in @iftypes_mask inside this structure cannot
4773 * overlap (i.e. only one occurrence of each type is allowed across all
4774 * instances of iftype_akm_suites).
4775 * @num_iftype_akm_suites: number of interface types for which supported akm
4776 * suites are specified separately.
4777 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4778 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4779 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4780 * -1 = fragmentation disabled, only odd values >= 256 used
4781 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4782 * @_net: the network namespace this wiphy currently lives in
4783 * @perm_addr: permanent MAC address of this device
4784 * @addr_mask: If the device supports multiple MAC addresses by masking,
4785 * set this to a mask with variable bits set to 1, e.g. if the last
4786 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4787 * variable bits shall be determined by the interfaces added, with
4788 * interfaces not matching the mask being rejected to be brought up.
4789 * @n_addresses: number of addresses in @addresses.
4790 * @addresses: If the device has more than one address, set this pointer
4791 * to a list of addresses (6 bytes each). The first one will be used
4792 * by default for perm_addr. In this case, the mask should be set to
4793 * all-zeroes. In this case it is assumed that the device can handle
4794 * the same number of arbitrary MAC addresses.
4795 * @registered: protects ->resume and ->suspend sysfs callbacks against
4796 * unregister hardware
4797 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4798 * It will be renamed automatically on wiphy renames
4799 * @dev: (virtual) struct device for this wiphy. The item in
4800 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4802 * @wext: wireless extension handlers
4803 * @priv: driver private data (sized according to wiphy_new() parameter)
4804 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4805 * must be set by driver
4806 * @iface_combinations: Valid interface combinations array, should not
4807 * list single interface types.
4808 * @n_iface_combinations: number of entries in @iface_combinations array.
4809 * @software_iftypes: bitmask of software interface types, these are not
4810 * subject to any restrictions since they are purely managed in SW.
4811 * @flags: wiphy flags, see &enum wiphy_flags
4812 * @regulatory_flags: wiphy regulatory flags, see
4813 * &enum ieee80211_regulatory_flags
4814 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4815 * @ext_features: extended features advertised to nl80211, see
4816 * &enum nl80211_ext_feature_index.
4817 * @bss_priv_size: each BSS struct has private data allocated with it,
4818 * this variable determines its size
4819 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4821 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4822 * the device can run concurrently.
4823 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4824 * for in any given scheduled scan
4825 * @max_match_sets: maximum number of match sets the device can handle
4826 * when performing a scheduled scan, 0 if filtering is not
4828 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4829 * add to probe request frames transmitted during a scan, must not
4830 * include fixed IEs like supported rates
4831 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4833 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4834 * of iterations) for scheduled scan supported by the device.
4835 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4836 * single scan plan supported by the device.
4837 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4838 * scan plan supported by the device.
4839 * @coverage_class: current coverage class
4840 * @fw_version: firmware version for ethtool reporting
4841 * @hw_version: hardware version for ethtool reporting
4842 * @max_num_pmkids: maximum number of PMKIDs supported by device
4843 * @privid: a pointer that drivers can use to identify if an arbitrary
4844 * wiphy is theirs, e.g. in global notifiers
4845 * @bands: information about bands/channels supported by this device
4847 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4848 * transmitted through nl80211, points to an array indexed by interface
4851 * @available_antennas_tx: bitmap of antennas which are available to be
4852 * configured as TX antennas. Antenna configuration commands will be
4853 * rejected unless this or @available_antennas_rx is set.
4855 * @available_antennas_rx: bitmap of antennas which are available to be
4856 * configured as RX antennas. Antenna configuration commands will be
4857 * rejected unless this or @available_antennas_tx is set.
4859 * @probe_resp_offload:
4860 * Bitmap of supported protocols for probe response offloading.
4861 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4862 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4864 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4865 * may request, if implemented.
4867 * @wowlan: WoWLAN support information
4868 * @wowlan_config: current WoWLAN configuration; this should usually not be
4869 * used since access to it is necessarily racy, use the parameter passed
4870 * to the suspend() operation instead.
4872 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4873 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4874 * If null, then none can be over-ridden.
4875 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4876 * If null, then none can be over-ridden.
4878 * @wdev_list: the list of associated (virtual) interfaces; this list must
4879 * not be modified by the driver, but can be read with RTNL/RCU protection.
4881 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4884 * @extended_capabilities: extended capabilities supported by the driver,
4885 * additional capabilities might be supported by userspace; these are
4886 * the 802.11 extended capabilities ("Extended Capabilities element")
4887 * and are in the same format as in the information element. See
4888 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4889 * extended capabilities to be used if the capabilities are not specified
4890 * for a specific interface type in iftype_ext_capab.
4891 * @extended_capabilities_mask: mask of the valid values
4892 * @extended_capabilities_len: length of the extended capabilities
4893 * @iftype_ext_capab: array of extended capabilities per interface type
4894 * @num_iftype_ext_capab: number of interface types for which extended
4895 * capabilities are specified separately.
4896 * @coalesce: packet coalescing support information
4898 * @vendor_commands: array of vendor commands supported by the hardware
4899 * @n_vendor_commands: number of vendor commands
4900 * @vendor_events: array of vendor events supported by the hardware
4901 * @n_vendor_events: number of vendor events
4903 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4904 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4905 * driver is allowed to advertise a theoretical limit that it can reach in
4906 * some cases, but may not always reach.
4908 * @max_num_csa_counters: Number of supported csa_counters in beacons
4909 * and probe responses. This value should be set if the driver
4910 * wishes to limit the number of csa counters. Default (0) means
4912 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4913 * by the driver in the .connect() callback. The bit position maps to the
4914 * attribute indices defined in &enum nl80211_bss_select_attr.
4916 * @nan_supported_bands: bands supported by the device in NAN mode, a
4917 * bitmap of &enum nl80211_band values. For instance, for
4918 * NL80211_BAND_2GHZ, bit 0 would be set
4919 * (i.e. BIT(NL80211_BAND_2GHZ)).
4921 * @txq_limit: configuration of internal TX queue frame limit
4922 * @txq_memory_limit: configuration internal TX queue memory limit
4923 * @txq_quantum: configuration of internal TX queue scheduler quantum
4925 * @tx_queue_len: allow setting transmit queue len for drivers not using
4928 * @support_mbssid: can HW support association with nontransmitted AP
4929 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4930 * HE AP, in order to avoid compatibility issues.
4931 * @support_mbssid must be set for this to have any effect.
4933 * @pmsr_capa: peer measurement capabilities
4935 * @tid_config_support: describes the per-TID config support that the
4937 * @tid_config_support.vif: bitmap of attributes (configurations)
4938 * supported by the driver for each vif
4939 * @tid_config_support.peer: bitmap of attributes (configurations)
4940 * supported by the driver for each peer
4941 * @tid_config_support.max_retry: maximum supported retry count for
4942 * long/short retry configuration
4944 * @max_data_retry_count: maximum supported per TID retry count for
4945 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
4946 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
4947 * @sar_capa: SAR control capabilities
4952 /* assign these fields before you register the wiphy */
4954 u8 perm_addr[ETH_ALEN];
4955 u8 addr_mask[ETH_ALEN];
4957 struct mac_address *addresses;
4959 const struct ieee80211_txrx_stypes *mgmt_stypes;
4961 const struct ieee80211_iface_combination *iface_combinations;
4962 int n_iface_combinations;
4963 u16 software_iftypes;
4967 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4968 u16 interface_modes;
4970 u16 max_acl_mac_addrs;
4972 u32 flags, regulatory_flags, features;
4973 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4977 enum cfg80211_signal_type signal_type;
4981 u8 max_sched_scan_reqs;
4982 u8 max_sched_scan_ssids;
4984 u16 max_scan_ie_len;
4985 u16 max_sched_scan_ie_len;
4986 u32 max_sched_scan_plans;
4987 u32 max_sched_scan_plan_interval;
4988 u32 max_sched_scan_plan_iterations;
4990 int n_cipher_suites;
4991 const u32 *cipher_suites;
4994 const u32 *akm_suites;
4996 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
4997 unsigned int num_iftype_akm_suites;
5005 char fw_version[ETHTOOL_FWVERS_LEN];
5009 const struct wiphy_wowlan_support *wowlan;
5010 struct cfg80211_wowlan *wowlan_config;
5013 u16 max_remain_on_channel_duration;
5017 u32 available_antennas_tx;
5018 u32 available_antennas_rx;
5020 u32 probe_resp_offload;
5022 const u8 *extended_capabilities, *extended_capabilities_mask;
5023 u8 extended_capabilities_len;
5025 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5026 unsigned int num_iftype_ext_capab;
5030 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5032 void (*reg_notifier)(struct wiphy *wiphy,
5033 struct regulatory_request *request);
5035 /* fields below are read-only, assigned by cfg80211 */
5037 const struct ieee80211_regdomain __rcu *regd;
5043 struct dentry *debugfsdir;
5045 const struct ieee80211_ht_cap *ht_capa_mod_mask;
5046 const struct ieee80211_vht_cap *vht_capa_mod_mask;
5048 struct list_head wdev_list;
5050 possible_net_t _net;
5052 #ifdef CONFIG_CFG80211_WEXT
5053 const struct iw_handler_def *wext;
5056 const struct wiphy_coalesce_support *coalesce;
5058 const struct wiphy_vendor_command *vendor_commands;
5059 const struct nl80211_vendor_cmd_info *vendor_events;
5060 int n_vendor_commands, n_vendor_events;
5062 u16 max_ap_assoc_sta;
5064 u8 max_num_csa_counters;
5066 u32 bss_select_support;
5068 u8 nan_supported_bands;
5071 u32 txq_memory_limit;
5074 unsigned long tx_queue_len;
5076 u8 support_mbssid:1,
5077 support_only_he_mbssid:1;
5079 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5084 } tid_config_support;
5086 u8 max_data_retry_count;
5088 const struct cfg80211_sar_capa *sar_capa;
5090 char priv[] __aligned(NETDEV_ALIGN);
5093 static inline struct net *wiphy_net(struct wiphy *wiphy)
5095 return read_pnet(&wiphy->_net);
5098 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5100 write_pnet(&wiphy->_net, net);
5104 * wiphy_priv - return priv from wiphy
5106 * @wiphy: the wiphy whose priv pointer to return
5107 * Return: The priv of @wiphy.
5109 static inline void *wiphy_priv(struct wiphy *wiphy)
5112 return &wiphy->priv;
5116 * priv_to_wiphy - return the wiphy containing the priv
5118 * @priv: a pointer previously returned by wiphy_priv
5119 * Return: The wiphy of @priv.
5121 static inline struct wiphy *priv_to_wiphy(void *priv)
5124 return container_of(priv, struct wiphy, priv);
5128 * set_wiphy_dev - set device pointer for wiphy
5130 * @wiphy: The wiphy whose device to bind
5131 * @dev: The device to parent it to
5133 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5135 wiphy->dev.parent = dev;
5139 * wiphy_dev - get wiphy dev pointer
5141 * @wiphy: The wiphy whose device struct to look up
5142 * Return: The dev of @wiphy.
5144 static inline struct device *wiphy_dev(struct wiphy *wiphy)
5146 return wiphy->dev.parent;
5150 * wiphy_name - get wiphy name
5152 * @wiphy: The wiphy whose name to return
5153 * Return: The name of @wiphy.
5155 static inline const char *wiphy_name(const struct wiphy *wiphy)
5157 return dev_name(&wiphy->dev);
5161 * wiphy_new_nm - create a new wiphy for use with cfg80211
5163 * @ops: The configuration operations for this device
5164 * @sizeof_priv: The size of the private area to allocate
5165 * @requested_name: Request a particular name.
5166 * NULL is valid value, and means use the default phy%d naming.
5168 * Create a new wiphy and associate the given operations with it.
5169 * @sizeof_priv bytes are allocated for private use.
5171 * Return: A pointer to the new wiphy. This pointer must be
5172 * assigned to each netdev's ieee80211_ptr for proper operation.
5174 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5175 const char *requested_name);
5178 * wiphy_new - create a new wiphy for use with cfg80211
5180 * @ops: The configuration operations for this device
5181 * @sizeof_priv: The size of the private area to allocate
5183 * Create a new wiphy and associate the given operations with it.
5184 * @sizeof_priv bytes are allocated for private use.
5186 * Return: A pointer to the new wiphy. This pointer must be
5187 * assigned to each netdev's ieee80211_ptr for proper operation.
5189 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5192 return wiphy_new_nm(ops, sizeof_priv, NULL);
5196 * wiphy_register - register a wiphy with cfg80211
5198 * @wiphy: The wiphy to register.
5200 * Return: A non-negative wiphy index or a negative error code.
5202 int wiphy_register(struct wiphy *wiphy);
5204 /* this is a define for better error reporting (file/line) */
5205 #define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
5208 * rcu_dereference_wiphy - rcu_dereference with debug checking
5209 * @wiphy: the wiphy to check the locking on
5210 * @p: The pointer to read, prior to dereferencing
5212 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
5213 * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
5215 #define rcu_dereference_wiphy(wiphy, p) \
5216 rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
5219 * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
5220 * @wiphy: the wiphy to check the locking on
5221 * @p: The pointer to read, prior to dereferencing
5223 * Return the value of the specified RCU-protected pointer, but omit the
5224 * READ_ONCE(), because caller holds the wiphy mutex used for updates.
5226 #define wiphy_dereference(wiphy, p) \
5227 rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
5230 * get_wiphy_regdom - get custom regdomain for the given wiphy
5231 * @wiphy: the wiphy to get the regdomain from
5233 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
5236 * wiphy_unregister - deregister a wiphy from cfg80211
5238 * @wiphy: The wiphy to unregister.
5240 * After this call, no more requests can be made with this priv
5241 * pointer, but the call may sleep to wait for an outstanding
5242 * request that is being handled.
5244 void wiphy_unregister(struct wiphy *wiphy);
5247 * wiphy_free - free wiphy
5249 * @wiphy: The wiphy to free
5251 void wiphy_free(struct wiphy *wiphy);
5253 /* internal structs */
5254 struct cfg80211_conn;
5255 struct cfg80211_internal_bss;
5256 struct cfg80211_cached_keys;
5257 struct cfg80211_cqm_config;
5260 * wiphy_lock - lock the wiphy
5261 * @wiphy: the wiphy to lock
5263 * This is mostly exposed so it can be done around registering and
5264 * unregistering netdevs that aren't created through cfg80211 calls,
5265 * since that requires locking in cfg80211 when the notifiers is
5266 * called, but that cannot differentiate which way it's called.
5268 * When cfg80211 ops are called, the wiphy is already locked.
5270 static inline void wiphy_lock(struct wiphy *wiphy)
5271 __acquires(&wiphy->mtx)
5273 mutex_lock(&wiphy->mtx);
5274 __acquire(&wiphy->mtx);
5278 * wiphy_unlock - unlock the wiphy again
5279 * @wiphy: the wiphy to unlock
5281 static inline void wiphy_unlock(struct wiphy *wiphy)
5282 __releases(&wiphy->mtx)
5284 __release(&wiphy->mtx);
5285 mutex_unlock(&wiphy->mtx);
5289 * struct wireless_dev - wireless device state
5291 * For netdevs, this structure must be allocated by the driver
5292 * that uses the ieee80211_ptr field in struct net_device (this
5293 * is intentional so it can be allocated along with the netdev.)
5294 * It need not be registered then as netdev registration will
5295 * be intercepted by cfg80211 to see the new wireless device,
5296 * however, drivers must lock the wiphy before registering or
5297 * unregistering netdevs if they pre-create any netdevs (in ops
5298 * called from cfg80211, the wiphy is already locked.)
5300 * For non-netdev uses, it must also be allocated by the driver
5301 * in response to the cfg80211 callbacks that require it, as
5302 * there's no netdev registration in that case it may not be
5303 * allocated outside of callback operations that return it.
5305 * @wiphy: pointer to hardware description
5306 * @iftype: interface type
5307 * @registered: is this wdev already registered with cfg80211
5308 * @registering: indicates we're doing registration under wiphy lock
5310 * @list: (private) Used to collect the interfaces
5311 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5312 * @identifier: (private) Identifier used in nl80211 to identify this
5313 * wireless device if it has no netdev
5314 * @current_bss: (private) Used by the internal configuration code
5315 * @chandef: (private) Used by the internal configuration code to track
5316 * the user-set channel definition.
5317 * @preset_chandef: (private) Used by the internal configuration code to
5318 * track the channel to be used for AP later
5319 * @bssid: (private) Used by the internal configuration code
5320 * @ssid: (private) Used by the internal configuration code
5321 * @ssid_len: (private) Used by the internal configuration code
5322 * @mesh_id_len: (private) Used by the internal configuration code
5323 * @mesh_id_up_len: (private) Used by the internal configuration code
5324 * @wext: (private) Used by the internal wireless extensions compat code
5325 * @wext.ibss: (private) IBSS data part of wext handling
5326 * @wext.connect: (private) connection handling data
5327 * @wext.keys: (private) (WEP) key data
5328 * @wext.ie: (private) extra elements for association
5329 * @wext.ie_len: (private) length of extra elements
5330 * @wext.bssid: (private) selected network BSSID
5331 * @wext.ssid: (private) selected network SSID
5332 * @wext.default_key: (private) selected default key index
5333 * @wext.default_mgmt_key: (private) selected default management key index
5334 * @wext.prev_bssid: (private) previous BSSID for reassociation
5335 * @wext.prev_bssid_valid: (private) previous BSSID validity
5336 * @use_4addr: indicates 4addr mode is used on this interface, must be
5337 * set by driver (if supported) on add_interface BEFORE registering the
5338 * netdev and may otherwise be used by driver read-only, will be update
5339 * by cfg80211 on change_interface
5340 * @mgmt_registrations: list of registrations for management frames
5341 * @mgmt_registrations_lock: lock for the list
5342 * @mgmt_registrations_need_update: mgmt registrations were updated,
5343 * need to propagate the update to the driver
5344 * @mtx: mutex used to lock data in this struct, may be used by drivers
5345 * and some API functions require it held
5346 * @beacon_interval: beacon interval used on this device for transmitting
5347 * beacons, 0 when not valid
5348 * @address: The address for this device, valid only if @netdev is %NULL
5349 * @is_running: true if this is a non-netdev device that has been started, e.g.
5351 * @cac_started: true if DFS channel availability check has been started
5352 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5353 * @cac_time_ms: CAC time in ms
5354 * @ps: powersave mode is enabled
5355 * @ps_timeout: dynamic powersave timeout
5356 * @ap_unexpected_nlportid: (private) netlink port ID of application
5357 * registered for unexpected class 3 frames (AP mode)
5358 * @conn: (private) cfg80211 software SME connection state machine data
5359 * @connect_keys: (private) keys to set after connection is established
5360 * @conn_bss_type: connecting/connected BSS type
5361 * @conn_owner_nlportid: (private) connection owner socket port ID
5362 * @disconnect_wk: (private) auto-disconnect work
5363 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5364 * @ibss_fixed: (private) IBSS is using fixed BSSID
5365 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
5366 * @event_list: (private) list for internal event processing
5367 * @event_lock: (private) lock for event list
5368 * @owner_nlportid: (private) owner socket port ID
5369 * @nl_owner_dead: (private) owner socket went away
5370 * @cqm_config: (private) nl80211 RSSI monitor state
5371 * @pmsr_list: (private) peer measurement requests
5372 * @pmsr_lock: (private) peer measurements requests/results lock
5373 * @pmsr_free_wk: (private) peer measurements cleanup work
5374 * @unprot_beacon_reported: (private) timestamp of last
5375 * unprotected beacon report
5377 struct wireless_dev {
5378 struct wiphy *wiphy;
5379 enum nl80211_iftype iftype;
5381 /* the remainder of this struct should be private to cfg80211 */
5382 struct list_head list;
5383 struct net_device *netdev;
5387 struct list_head mgmt_registrations;
5388 spinlock_t mgmt_registrations_lock;
5389 u8 mgmt_registrations_need_update:1;
5393 bool use_4addr, is_running, registered, registering;
5395 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5397 /* currently used for IBSS and SME - might be rearranged later */
5398 u8 ssid[IEEE80211_MAX_SSID_LEN];
5399 u8 ssid_len, mesh_id_len, mesh_id_up_len;
5400 struct cfg80211_conn *conn;
5401 struct cfg80211_cached_keys *connect_keys;
5402 enum ieee80211_bss_type conn_bss_type;
5403 u32 conn_owner_nlportid;
5405 struct work_struct disconnect_wk;
5406 u8 disconnect_bssid[ETH_ALEN];
5408 struct list_head event_list;
5409 spinlock_t event_lock;
5411 struct cfg80211_internal_bss *current_bss; /* associated / joined */
5412 struct cfg80211_chan_def preset_chandef;
5413 struct cfg80211_chan_def chandef;
5416 bool ibss_dfs_possible;
5421 int beacon_interval;
5423 u32 ap_unexpected_nlportid;
5429 unsigned long cac_start_time;
5430 unsigned int cac_time_ms;
5432 #ifdef CONFIG_CFG80211_WEXT
5435 struct cfg80211_ibss_params ibss;
5436 struct cfg80211_connect_params connect;
5437 struct cfg80211_cached_keys *keys;
5441 u8 prev_bssid[ETH_ALEN];
5442 u8 ssid[IEEE80211_MAX_SSID_LEN];
5443 s8 default_key, default_mgmt_key;
5444 bool prev_bssid_valid;
5448 struct cfg80211_cqm_config *cqm_config;
5450 struct list_head pmsr_list;
5451 spinlock_t pmsr_lock;
5452 struct work_struct pmsr_free_wk;
5454 unsigned long unprot_beacon_reported;
5457 static inline u8 *wdev_address(struct wireless_dev *wdev)
5460 return wdev->netdev->dev_addr;
5461 return wdev->address;
5464 static inline bool wdev_running(struct wireless_dev *wdev)
5467 return netif_running(wdev->netdev);
5468 return wdev->is_running;
5472 * wdev_priv - return wiphy priv from wireless_dev
5474 * @wdev: The wireless device whose wiphy's priv pointer to return
5475 * Return: The wiphy priv of @wdev.
5477 static inline void *wdev_priv(struct wireless_dev *wdev)
5480 return wiphy_priv(wdev->wiphy);
5484 * DOC: Utility functions
5486 * cfg80211 offers a number of utility functions that can be useful.
5490 * ieee80211_channel_equal - compare two struct ieee80211_channel
5492 * @a: 1st struct ieee80211_channel
5493 * @b: 2nd struct ieee80211_channel
5494 * Return: true if center frequency of @a == @b
5497 ieee80211_channel_equal(struct ieee80211_channel *a,
5498 struct ieee80211_channel *b)
5500 return (a->center_freq == b->center_freq &&
5501 a->freq_offset == b->freq_offset);
5505 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5506 * @chan: struct ieee80211_channel to convert
5507 * Return: The corresponding frequency (in KHz)
5510 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5512 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5516 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5518 * Only allowed for band NL80211_BAND_S1GHZ
5520 * Return: The allowed channel width for this center_freq
5522 enum nl80211_chan_width
5523 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5526 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5527 * @chan: channel number
5528 * @band: band, necessary due to channel number overlap
5529 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5531 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5534 * ieee80211_channel_to_frequency - convert channel number to frequency
5535 * @chan: channel number
5536 * @band: band, necessary due to channel number overlap
5537 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5540 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5542 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5546 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5547 * @freq: center frequency in KHz
5548 * Return: The corresponding channel, or 0 if the conversion failed.
5550 int ieee80211_freq_khz_to_channel(u32 freq);
5553 * ieee80211_frequency_to_channel - convert frequency to channel number
5554 * @freq: center frequency in MHz
5555 * Return: The corresponding channel, or 0 if the conversion failed.
5558 ieee80211_frequency_to_channel(int freq)
5560 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5564 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5566 * @wiphy: the struct wiphy to get the channel for
5567 * @freq: the center frequency (in KHz) of the channel
5568 * Return: The channel struct from @wiphy at @freq.
5570 struct ieee80211_channel *
5571 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5574 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5576 * @wiphy: the struct wiphy to get the channel for
5577 * @freq: the center frequency (in MHz) of the channel
5578 * Return: The channel struct from @wiphy at @freq.
5580 static inline struct ieee80211_channel *
5581 ieee80211_get_channel(struct wiphy *wiphy, int freq)
5583 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5587 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5588 * @chan: control channel to check
5590 * The Preferred Scanning Channels (PSC) are defined in
5591 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5593 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
5595 if (chan->band != NL80211_BAND_6GHZ)
5598 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
5602 * ieee80211_get_response_rate - get basic rate for a given rate
5604 * @sband: the band to look for rates in
5605 * @basic_rates: bitmap of basic rates
5606 * @bitrate: the bitrate for which to find the basic rate
5608 * Return: The basic rate corresponding to a given bitrate, that
5609 * is the next lower bitrate contained in the basic rate map,
5610 * which is, for this function, given as a bitmap of indices of
5611 * rates in the band's bitrate table.
5613 const struct ieee80211_rate *
5614 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5615 u32 basic_rates, int bitrate);
5618 * ieee80211_mandatory_rates - get mandatory rates for a given band
5619 * @sband: the band to look for rates in
5620 * @scan_width: width of the control channel
5622 * This function returns a bitmap of the mandatory rates for the given
5623 * band, bits are set according to the rate position in the bitrates array.
5625 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5626 enum nl80211_bss_scan_width scan_width);
5629 * Radiotap parsing functions -- for controlled injection support
5631 * Implemented in net/wireless/radiotap.c
5632 * Documentation in Documentation/networking/radiotap-headers.rst
5635 struct radiotap_align_size {
5636 uint8_t align:4, size:4;
5639 struct ieee80211_radiotap_namespace {
5640 const struct radiotap_align_size *align_size;
5646 struct ieee80211_radiotap_vendor_namespaces {
5647 const struct ieee80211_radiotap_namespace *ns;
5652 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5653 * @this_arg_index: index of current arg, valid after each successful call
5654 * to ieee80211_radiotap_iterator_next()
5655 * @this_arg: pointer to current radiotap arg; it is valid after each
5656 * call to ieee80211_radiotap_iterator_next() but also after
5657 * ieee80211_radiotap_iterator_init() where it will point to
5658 * the beginning of the actual data portion
5659 * @this_arg_size: length of the current arg, for convenience
5660 * @current_namespace: pointer to the current namespace definition
5661 * (or internally %NULL if the current namespace is unknown)
5662 * @is_radiotap_ns: indicates whether the current namespace is the default
5663 * radiotap namespace or not
5665 * @_rtheader: pointer to the radiotap header we are walking through
5666 * @_max_length: length of radiotap header in cpu byte ordering
5667 * @_arg_index: next argument index
5668 * @_arg: next argument pointer
5669 * @_next_bitmap: internal pointer to next present u32
5670 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5671 * @_vns: vendor namespace definitions
5672 * @_next_ns_data: beginning of the next namespace's data
5673 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5676 * Describes the radiotap parser state. Fields prefixed with an underscore
5677 * must not be used by users of the parser, only by the parser internally.
5680 struct ieee80211_radiotap_iterator {
5681 struct ieee80211_radiotap_header *_rtheader;
5682 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5683 const struct ieee80211_radiotap_namespace *current_namespace;
5685 unsigned char *_arg, *_next_ns_data;
5686 __le32 *_next_bitmap;
5688 unsigned char *this_arg;
5696 uint32_t _bitmap_shifter;
5701 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5702 struct ieee80211_radiotap_header *radiotap_header,
5704 const struct ieee80211_radiotap_vendor_namespaces *vns);
5707 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5710 extern const unsigned char rfc1042_header[6];
5711 extern const unsigned char bridge_tunnel_header[6];
5714 * ieee80211_get_hdrlen_from_skb - get header length from data
5718 * Given an skb with a raw 802.11 header at the data pointer this function
5719 * returns the 802.11 header length.
5721 * Return: The 802.11 header length in bytes (not including encryption
5722 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5725 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5728 * ieee80211_hdrlen - get header length in bytes from frame control
5729 * @fc: frame control field in little-endian format
5730 * Return: The header length in bytes.
5732 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5735 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5736 * @meshhdr: the mesh extension header, only the flags field
5737 * (first byte) will be accessed
5738 * Return: The length of the extension header, which is always at
5739 * least 6 bytes and at most 18 if address 5 and 6 are present.
5741 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5744 * DOC: Data path helpers
5746 * In addition to generic utilities, cfg80211 also offers
5747 * functions that help implement the data path for devices
5748 * that do not do the 802.11/802.3 conversion on the device.
5752 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5753 * @skb: the 802.11 data frame
5754 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5755 * of it being pushed into the SKB
5756 * @addr: the device MAC address
5757 * @iftype: the virtual interface type
5758 * @data_offset: offset of payload after the 802.11 header
5759 * Return: 0 on success. Non-zero on error.
5761 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5762 const u8 *addr, enum nl80211_iftype iftype,
5766 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5767 * @skb: the 802.11 data frame
5768 * @addr: the device MAC address
5769 * @iftype: the virtual interface type
5770 * Return: 0 on success. Non-zero on error.
5772 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5773 enum nl80211_iftype iftype)
5775 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5779 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5781 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5782 * The @list will be empty if the decode fails. The @skb must be fully
5783 * header-less before being passed in here; it is freed in this function.
5785 * @skb: The input A-MSDU frame without any headers.
5786 * @list: The output list of 802.3 frames. It must be allocated and
5787 * initialized by the caller.
5788 * @addr: The device MAC address.
5789 * @iftype: The device interface type.
5790 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5791 * @check_da: DA to check in the inner ethernet header, or NULL
5792 * @check_sa: SA to check in the inner ethernet header, or NULL
5794 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5795 const u8 *addr, enum nl80211_iftype iftype,
5796 const unsigned int extra_headroom,
5797 const u8 *check_da, const u8 *check_sa);
5800 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5801 * @skb: the data frame
5802 * @qos_map: Interworking QoS mapping or %NULL if not in use
5803 * Return: The 802.1p/1d tag.
5805 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5806 struct cfg80211_qos_map *qos_map);
5809 * cfg80211_find_elem_match - match information element and byte array in data
5812 * @ies: data consisting of IEs
5813 * @len: length of data
5814 * @match: byte array to match
5815 * @match_len: number of bytes in the match array
5816 * @match_offset: offset in the IE data where the byte array should match.
5817 * Note the difference to cfg80211_find_ie_match() which considers
5818 * the offset to start from the element ID byte, but here we take
5819 * the data portion instead.
5821 * Return: %NULL if the element ID could not be found or if
5822 * the element is invalid (claims to be longer than the given
5823 * data) or if the byte array doesn't match; otherwise return the
5824 * requested element struct.
5826 * Note: There are no checks on the element length other than
5827 * having to fit into the given data and being large enough for the
5828 * byte array to match.
5830 const struct element *
5831 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5832 const u8 *match, unsigned int match_len,
5833 unsigned int match_offset);
5836 * cfg80211_find_ie_match - match information element and byte array in data
5839 * @ies: data consisting of IEs
5840 * @len: length of data
5841 * @match: byte array to match
5842 * @match_len: number of bytes in the match array
5843 * @match_offset: offset in the IE where the byte array should match.
5844 * If match_len is zero, this must also be set to zero.
5845 * Otherwise this must be set to 2 or more, because the first
5846 * byte is the element id, which is already compared to eid, and
5847 * the second byte is the IE length.
5849 * Return: %NULL if the element ID could not be found or if
5850 * the element is invalid (claims to be longer than the given
5851 * data) or if the byte array doesn't match, or a pointer to the first
5852 * byte of the requested element, that is the byte containing the
5855 * Note: There are no checks on the element length other than
5856 * having to fit into the given data and being large enough for the
5857 * byte array to match.
5859 static inline const u8 *
5860 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5861 const u8 *match, unsigned int match_len,
5862 unsigned int match_offset)
5864 /* match_offset can't be smaller than 2, unless match_len is
5865 * zero, in which case match_offset must be zero as well.
5867 if (WARN_ON((match_len && match_offset < 2) ||
5868 (!match_len && match_offset)))
5871 return (void *)cfg80211_find_elem_match(eid, ies, len,
5874 match_offset - 2 : 0);
5878 * cfg80211_find_elem - find information element in data
5881 * @ies: data consisting of IEs
5882 * @len: length of data
5884 * Return: %NULL if the element ID could not be found or if
5885 * the element is invalid (claims to be longer than the given
5886 * data) or if the byte array doesn't match; otherwise return the
5887 * requested element struct.
5889 * Note: There are no checks on the element length other than
5890 * having to fit into the given data.
5892 static inline const struct element *
5893 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5895 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5899 * cfg80211_find_ie - find information element in data
5902 * @ies: data consisting of IEs
5903 * @len: length of data
5905 * Return: %NULL if the element ID could not be found or if
5906 * the element is invalid (claims to be longer than the given
5907 * data), or a pointer to the first byte of the requested
5908 * element, that is the byte containing the element ID.
5910 * Note: There are no checks on the element length other than
5911 * having to fit into the given data.
5913 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5915 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5919 * cfg80211_find_ext_elem - find information element with EID Extension in data
5921 * @ext_eid: element ID Extension
5922 * @ies: data consisting of IEs
5923 * @len: length of data
5925 * Return: %NULL if the etended element could not be found or if
5926 * the element is invalid (claims to be longer than the given
5927 * data) or if the byte array doesn't match; otherwise return the
5928 * requested element struct.
5930 * Note: There are no checks on the element length other than
5931 * having to fit into the given data.
5933 static inline const struct element *
5934 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5936 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5941 * cfg80211_find_ext_ie - find information element with EID Extension in data
5943 * @ext_eid: element ID Extension
5944 * @ies: data consisting of IEs
5945 * @len: length of data
5947 * Return: %NULL if the extended element ID could not be found or if
5948 * the element is invalid (claims to be longer than the given
5949 * data), or a pointer to the first byte of the requested
5950 * element, that is the byte containing the element ID.
5952 * Note: There are no checks on the element length other than
5953 * having to fit into the given data.
5955 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5957 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5962 * cfg80211_find_vendor_elem - find vendor specific information element in data
5965 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5966 * @ies: data consisting of IEs
5967 * @len: length of data
5969 * Return: %NULL if the vendor specific element ID could not be found or if the
5970 * element is invalid (claims to be longer than the given data); otherwise
5971 * return the element structure for the requested element.
5973 * Note: There are no checks on the element length other than having to fit into
5976 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5981 * cfg80211_find_vendor_ie - find vendor specific information element in data
5984 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5985 * @ies: data consisting of IEs
5986 * @len: length of data
5988 * Return: %NULL if the vendor specific element ID could not be found or if the
5989 * element is invalid (claims to be longer than the given data), or a pointer to
5990 * the first byte of the requested element, that is the byte containing the
5993 * Note: There are no checks on the element length other than having to fit into
5996 static inline const u8 *
5997 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5998 const u8 *ies, unsigned int len)
6000 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
6004 * cfg80211_send_layer2_update - send layer 2 update frame
6006 * @dev: network device
6007 * @addr: STA MAC address
6009 * Wireless drivers can use this function to update forwarding tables in bridge
6010 * devices upon STA association.
6012 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
6015 * DOC: Regulatory enforcement infrastructure
6021 * regulatory_hint - driver hint to the wireless core a regulatory domain
6022 * @wiphy: the wireless device giving the hint (used only for reporting
6024 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
6025 * should be in. If @rd is set this should be NULL. Note that if you
6026 * set this to NULL you should still set rd->alpha2 to some accepted
6029 * Wireless drivers can use this function to hint to the wireless core
6030 * what it believes should be the current regulatory domain by
6031 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
6032 * domain should be in or by providing a completely build regulatory domain.
6033 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
6034 * for a regulatory domain structure for the respective country.
6036 * The wiphy must have been registered to cfg80211 prior to this call.
6037 * For cfg80211 drivers this means you must first use wiphy_register(),
6038 * for mac80211 drivers you must first use ieee80211_register_hw().
6040 * Drivers should check the return value, its possible you can get
6043 * Return: 0 on success. -ENOMEM.
6045 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
6048 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
6049 * @wiphy: the wireless device we want to process the regulatory domain on
6050 * @rd: the regulatory domain informatoin to use for this wiphy
6052 * Set the regulatory domain information for self-managed wiphys, only they
6053 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
6056 * Return: 0 on success. -EINVAL, -EPERM
6058 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
6059 struct ieee80211_regdomain *rd);
6062 * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
6063 * @wiphy: the wireless device we want to process the regulatory domain on
6064 * @rd: the regulatory domain information to use for this wiphy
6066 * This functions requires the RTNL and the wiphy mutex to be held and
6067 * applies the new regdomain synchronously to this wiphy. For more details
6068 * see regulatory_set_wiphy_regd().
6070 * Return: 0 on success. -EINVAL, -EPERM
6072 int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
6073 struct ieee80211_regdomain *rd);
6076 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
6077 * @wiphy: the wireless device we want to process the regulatory domain on
6078 * @regd: the custom regulatory domain to use for this wiphy
6080 * Drivers can sometimes have custom regulatory domains which do not apply
6081 * to a specific country. Drivers can use this to apply such custom regulatory
6082 * domains. This routine must be called prior to wiphy registration. The
6083 * custom regulatory domain will be trusted completely and as such previous
6084 * default channel settings will be disregarded. If no rule is found for a
6085 * channel on the regulatory domain the channel will be disabled.
6086 * Drivers using this for a wiphy should also set the wiphy flag
6087 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
6088 * that called this helper.
6090 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
6091 const struct ieee80211_regdomain *regd);
6094 * freq_reg_info - get regulatory information for the given frequency
6095 * @wiphy: the wiphy for which we want to process this rule for
6096 * @center_freq: Frequency in KHz for which we want regulatory information for
6098 * Use this function to get the regulatory rule for a specific frequency on
6099 * a given wireless device. If the device has a specific regulatory domain
6100 * it wants to follow we respect that unless a country IE has been received
6101 * and processed already.
6103 * Return: A valid pointer, or, when an error occurs, for example if no rule
6104 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
6105 * check and PTR_ERR() to obtain the numeric return value. The numeric return
6106 * value will be -ERANGE if we determine the given center_freq does not even
6107 * have a regulatory rule for a frequency range in the center_freq's band.
6108 * See freq_in_rule_band() for our current definition of a band -- this is
6109 * purely subjective and right now it's 802.11 specific.
6111 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
6115 * reg_initiator_name - map regulatory request initiator enum to name
6116 * @initiator: the regulatory request initiator
6118 * You can use this to map the regulatory request initiator enum to a
6119 * proper string representation.
6121 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
6124 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
6125 * @wiphy: wiphy for which pre-CAC capability is checked.
6127 * Pre-CAC is allowed only in some regdomains (notable ETSI).
6129 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
6132 * DOC: Internal regulatory db functions
6137 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6138 * Regulatory self-managed driver can use it to proactively
6140 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6141 * @freq: the freqency(in MHz) to be queried.
6142 * @rule: pointer to store the wmm rule from the regulatory db.
6144 * Self-managed wireless drivers can use this function to query
6145 * the internal regulatory database to check whether the given
6146 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6148 * Drivers should check the return value, its possible you can get
6151 * Return: 0 on success. -ENODATA.
6153 int reg_query_regdb_wmm(char *alpha2, int freq,
6154 struct ieee80211_reg_rule *rule);
6157 * callbacks for asynchronous cfg80211 methods, notification
6158 * functions and BSS handling helpers
6162 * cfg80211_scan_done - notify that scan finished
6164 * @request: the corresponding scan request
6165 * @info: information about the completed scan
6167 void cfg80211_scan_done(struct cfg80211_scan_request *request,
6168 struct cfg80211_scan_info *info);
6171 * cfg80211_sched_scan_results - notify that new scan results are available
6173 * @wiphy: the wiphy which got scheduled scan results
6174 * @reqid: identifier for the related scheduled scan request
6176 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6179 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6181 * @wiphy: the wiphy on which the scheduled scan stopped
6182 * @reqid: identifier for the related scheduled scan request
6184 * The driver can call this function to inform cfg80211 that the
6185 * scheduled scan had to be stopped, for whatever reason. The driver
6186 * is then called back via the sched_scan_stop operation when done.
6188 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6191 * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
6193 * @wiphy: the wiphy on which the scheduled scan stopped
6194 * @reqid: identifier for the related scheduled scan request
6196 * The driver can call this function to inform cfg80211 that the
6197 * scheduled scan had to be stopped, for whatever reason. The driver
6198 * is then called back via the sched_scan_stop operation when done.
6199 * This function should be called with the wiphy mutex held.
6201 void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
6204 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6205 * @wiphy: the wiphy reporting the BSS
6206 * @data: the BSS metadata
6207 * @mgmt: the management frame (probe response or beacon)
6208 * @len: length of the management frame
6209 * @gfp: context flags
6211 * This informs cfg80211 that BSS information was found and
6212 * the BSS should be updated/added.
6214 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6215 * Or %NULL on error.
6217 struct cfg80211_bss * __must_check
6218 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
6219 struct cfg80211_inform_bss *data,
6220 struct ieee80211_mgmt *mgmt, size_t len,
6223 static inline struct cfg80211_bss * __must_check
6224 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6225 struct ieee80211_channel *rx_channel,
6226 enum nl80211_bss_scan_width scan_width,
6227 struct ieee80211_mgmt *mgmt, size_t len,
6228 s32 signal, gfp_t gfp)
6230 struct cfg80211_inform_bss data = {
6232 .scan_width = scan_width,
6236 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6239 static inline struct cfg80211_bss * __must_check
6240 cfg80211_inform_bss_frame(struct wiphy *wiphy,
6241 struct ieee80211_channel *rx_channel,
6242 struct ieee80211_mgmt *mgmt, size_t len,
6243 s32 signal, gfp_t gfp)
6245 struct cfg80211_inform_bss data = {
6247 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6251 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6255 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6256 * @bssid: transmitter BSSID
6257 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6258 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6259 * @new_bssid: calculated nontransmitted BSSID
6261 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6262 u8 mbssid_index, u8 *new_bssid)
6264 u64 bssid_u64 = ether_addr_to_u64(bssid);
6265 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6268 new_bssid_u64 = bssid_u64 & ~mask;
6270 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6272 u64_to_ether_addr(new_bssid_u64, new_bssid);
6276 * cfg80211_is_element_inherited - returns if element ID should be inherited
6277 * @element: element to check
6278 * @non_inherit_element: non inheritance element
6280 bool cfg80211_is_element_inherited(const struct element *element,
6281 const struct element *non_inherit_element);
6284 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6286 * @ielen: length of IEs
6287 * @mbssid_elem: current MBSSID element
6288 * @sub_elem: current MBSSID subelement (profile)
6289 * @merged_ie: location of the merged profile
6290 * @max_copy_len: max merged profile length
6292 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6293 const struct element *mbssid_elem,
6294 const struct element *sub_elem,
6295 u8 *merged_ie, size_t max_copy_len);
6298 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6299 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6300 * from a beacon or probe response
6301 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6302 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6304 enum cfg80211_bss_frame_type {
6305 CFG80211_BSS_FTYPE_UNKNOWN,
6306 CFG80211_BSS_FTYPE_BEACON,
6307 CFG80211_BSS_FTYPE_PRESP,
6311 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6313 * @wiphy: the wiphy reporting the BSS
6314 * @data: the BSS metadata
6315 * @ftype: frame type (if known)
6316 * @bssid: the BSSID of the BSS
6317 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6318 * @capability: the capability field sent by the peer
6319 * @beacon_interval: the beacon interval announced by the peer
6320 * @ie: additional IEs sent by the peer
6321 * @ielen: length of the additional IEs
6322 * @gfp: context flags
6324 * This informs cfg80211 that BSS information was found and
6325 * the BSS should be updated/added.
6327 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6328 * Or %NULL on error.
6330 struct cfg80211_bss * __must_check
6331 cfg80211_inform_bss_data(struct wiphy *wiphy,
6332 struct cfg80211_inform_bss *data,
6333 enum cfg80211_bss_frame_type ftype,
6334 const u8 *bssid, u64 tsf, u16 capability,
6335 u16 beacon_interval, const u8 *ie, size_t ielen,
6338 static inline struct cfg80211_bss * __must_check
6339 cfg80211_inform_bss_width(struct wiphy *wiphy,
6340 struct ieee80211_channel *rx_channel,
6341 enum nl80211_bss_scan_width scan_width,
6342 enum cfg80211_bss_frame_type ftype,
6343 const u8 *bssid, u64 tsf, u16 capability,
6344 u16 beacon_interval, const u8 *ie, size_t ielen,
6345 s32 signal, gfp_t gfp)
6347 struct cfg80211_inform_bss data = {
6349 .scan_width = scan_width,
6353 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6354 capability, beacon_interval, ie, ielen,
6358 static inline struct cfg80211_bss * __must_check
6359 cfg80211_inform_bss(struct wiphy *wiphy,
6360 struct ieee80211_channel *rx_channel,
6361 enum cfg80211_bss_frame_type ftype,
6362 const u8 *bssid, u64 tsf, u16 capability,
6363 u16 beacon_interval, const u8 *ie, size_t ielen,
6364 s32 signal, gfp_t gfp)
6366 struct cfg80211_inform_bss data = {
6368 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6372 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6373 capability, beacon_interval, ie, ielen,
6378 * cfg80211_get_bss - get a BSS reference
6379 * @wiphy: the wiphy this BSS struct belongs to
6380 * @channel: the channel to search on (or %NULL)
6381 * @bssid: the desired BSSID (or %NULL)
6382 * @ssid: the desired SSID (or %NULL)
6383 * @ssid_len: length of the SSID (or 0)
6384 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6385 * @privacy: privacy filter, see &enum ieee80211_privacy
6387 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6388 struct ieee80211_channel *channel,
6390 const u8 *ssid, size_t ssid_len,
6391 enum ieee80211_bss_type bss_type,
6392 enum ieee80211_privacy privacy);
6393 static inline struct cfg80211_bss *
6394 cfg80211_get_ibss(struct wiphy *wiphy,
6395 struct ieee80211_channel *channel,
6396 const u8 *ssid, size_t ssid_len)
6398 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6399 IEEE80211_BSS_TYPE_IBSS,
6400 IEEE80211_PRIVACY_ANY);
6404 * cfg80211_ref_bss - reference BSS struct
6405 * @wiphy: the wiphy this BSS struct belongs to
6406 * @bss: the BSS struct to reference
6408 * Increments the refcount of the given BSS struct.
6410 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6413 * cfg80211_put_bss - unref BSS struct
6414 * @wiphy: the wiphy this BSS struct belongs to
6415 * @bss: the BSS struct
6417 * Decrements the refcount of the given BSS struct.
6419 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6422 * cfg80211_unlink_bss - unlink BSS from internal data structures
6424 * @bss: the bss to remove
6426 * This function removes the given BSS from the internal data structures
6427 * thereby making it no longer show up in scan results etc. Use this
6428 * function when you detect a BSS is gone. Normally BSSes will also time
6429 * out, so it is not necessary to use this function at all.
6431 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6434 * cfg80211_bss_iter - iterate all BSS entries
6436 * This function iterates over the BSS entries associated with the given wiphy
6437 * and calls the callback for the iterated BSS. The iterator function is not
6438 * allowed to call functions that might modify the internal state of the BSS DB.
6441 * @chandef: if given, the iterator function will be called only if the channel
6442 * of the currently iterated BSS is a subset of the given channel.
6443 * @iter: the iterator function to call
6444 * @iter_data: an argument to the iterator function
6446 void cfg80211_bss_iter(struct wiphy *wiphy,
6447 struct cfg80211_chan_def *chandef,
6448 void (*iter)(struct wiphy *wiphy,
6449 struct cfg80211_bss *bss,
6453 static inline enum nl80211_bss_scan_width
6454 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6456 switch (chandef->width) {
6457 case NL80211_CHAN_WIDTH_5:
6458 return NL80211_BSS_CHAN_WIDTH_5;
6459 case NL80211_CHAN_WIDTH_10:
6460 return NL80211_BSS_CHAN_WIDTH_10;
6462 return NL80211_BSS_CHAN_WIDTH_20;
6467 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6468 * @dev: network device
6469 * @buf: authentication frame (header + body)
6470 * @len: length of the frame data
6472 * This function is called whenever an authentication, disassociation or
6473 * deauthentication frame has been received and processed in station mode.
6474 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6475 * call either this function or cfg80211_auth_timeout().
6476 * After being asked to associate via cfg80211_ops::assoc() the driver must
6477 * call either this function or cfg80211_auth_timeout().
6478 * While connected, the driver must calls this for received and processed
6479 * disassociation and deauthentication frames. If the frame couldn't be used
6480 * because it was unprotected, the driver must call the function
6481 * cfg80211_rx_unprot_mlme_mgmt() instead.
6483 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6485 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6488 * cfg80211_auth_timeout - notification of timed out authentication
6489 * @dev: network device
6490 * @addr: The MAC address of the device with which the authentication timed out
6492 * This function may sleep. The caller must hold the corresponding wdev's
6495 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6498 * cfg80211_rx_assoc_resp - notification of processed association response
6499 * @dev: network device
6500 * @bss: the BSS that association was requested with, ownership of the pointer
6501 * moves to cfg80211 in this call
6502 * @buf: (Re)Association Response frame (header + body)
6503 * @len: length of the frame data
6504 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6505 * as the AC bitmap in the QoS info field
6506 * @req_ies: information elements from the (Re)Association Request frame
6507 * @req_ies_len: length of req_ies data
6509 * After being asked to associate via cfg80211_ops::assoc() the driver must
6510 * call either this function or cfg80211_auth_timeout().
6512 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6514 void cfg80211_rx_assoc_resp(struct net_device *dev,
6515 struct cfg80211_bss *bss,
6516 const u8 *buf, size_t len,
6518 const u8 *req_ies, size_t req_ies_len);
6521 * cfg80211_assoc_timeout - notification of timed out association
6522 * @dev: network device
6523 * @bss: The BSS entry with which association timed out.
6525 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6527 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6530 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6531 * @dev: network device
6532 * @bss: The BSS entry with which association was abandoned.
6534 * Call this whenever - for reasons reported through other API, like deauth RX,
6535 * an association attempt was abandoned.
6536 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6538 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6541 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6542 * @dev: network device
6543 * @buf: 802.11 frame (header + body)
6544 * @len: length of the frame data
6545 * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
6547 * This function is called whenever deauthentication has been processed in
6548 * station mode. This includes both received deauthentication frames and
6549 * locally generated ones. This function may sleep. The caller must hold the
6550 * corresponding wdev's mutex.
6552 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
6556 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6557 * @dev: network device
6558 * @buf: received management frame (header + body)
6559 * @len: length of the frame data
6561 * This function is called whenever a received deauthentication or dissassoc
6562 * frame has been dropped in station mode because of MFP being used but the
6563 * frame was not protected. This is also used to notify reception of a Beacon
6564 * frame that was dropped because it did not include a valid MME MIC while
6565 * beacon protection was enabled (BIGTK configured in station mode).
6567 * This function may sleep.
6569 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6570 const u8 *buf, size_t len);
6573 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6574 * @dev: network device
6575 * @addr: The source MAC address of the frame
6576 * @key_type: The key type that the received frame used
6577 * @key_id: Key identifier (0..3). Can be -1 if missing.
6578 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6579 * @gfp: allocation flags
6581 * This function is called whenever the local MAC detects a MIC failure in a
6582 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6585 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6586 enum nl80211_key_type key_type, int key_id,
6587 const u8 *tsc, gfp_t gfp);
6590 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6592 * @dev: network device
6593 * @bssid: the BSSID of the IBSS joined
6594 * @channel: the channel of the IBSS joined
6595 * @gfp: allocation flags
6597 * This function notifies cfg80211 that the device joined an IBSS or
6598 * switched to a different BSSID. Before this function can be called,
6599 * either a beacon has to have been received from the IBSS, or one of
6600 * the cfg80211_inform_bss{,_frame} functions must have been called
6601 * with the locally generated beacon -- this guarantees that there is
6602 * always a scan result for this IBSS. cfg80211 will handle the rest.
6604 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6605 struct ieee80211_channel *channel, gfp_t gfp);
6608 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
6611 * @dev: network device
6612 * @macaddr: the MAC address of the new candidate
6613 * @ie: information elements advertised by the peer candidate
6614 * @ie_len: length of the information elements buffer
6615 * @gfp: allocation flags
6617 * This function notifies cfg80211 that the mesh peer candidate has been
6618 * detected, most likely via a beacon or, less likely, via a probe response.
6619 * cfg80211 then sends a notification to userspace.
6621 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6622 const u8 *macaddr, const u8 *ie, u8 ie_len,
6623 int sig_dbm, gfp_t gfp);
6626 * DOC: RFkill integration
6628 * RFkill integration in cfg80211 is almost invisible to drivers,
6629 * as cfg80211 automatically registers an rfkill instance for each
6630 * wireless device it knows about. Soft kill is also translated
6631 * into disconnecting and turning all interfaces off, drivers are
6632 * expected to turn off the device when all interfaces are down.
6634 * However, devices may have a hard RFkill line, in which case they
6635 * also need to interact with the rfkill subsystem, via cfg80211.
6636 * They can do this with a few helper functions documented here.
6640 * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
6642 * @blocked: block status
6643 * @reason: one of reasons in &enum rfkill_hard_block_reasons
6645 void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
6646 enum rfkill_hard_block_reasons reason);
6648 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
6650 wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
6651 RFKILL_HARD_BLOCK_SIGNAL);
6655 * wiphy_rfkill_start_polling - start polling rfkill
6658 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6661 * wiphy_rfkill_stop_polling - stop polling rfkill
6664 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
6667 * DOC: Vendor commands
6669 * Occasionally, there are special protocol or firmware features that
6670 * can't be implemented very openly. For this and similar cases, the
6671 * vendor command functionality allows implementing the features with
6672 * (typically closed-source) userspace and firmware, using nl80211 as
6673 * the configuration mechanism.
6675 * A driver supporting vendor commands must register them as an array
6676 * in struct wiphy, with handlers for each one, each command has an
6677 * OUI and sub command ID to identify it.
6679 * Note that this feature should not be (ab)used to implement protocol
6680 * features that could openly be shared across drivers. In particular,
6681 * it must never be required to use vendor commands to implement any
6682 * "normal" functionality that higher-level userspace like connection
6683 * managers etc. need.
6686 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6687 enum nl80211_commands cmd,
6688 enum nl80211_attrs attr,
6691 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6692 struct wireless_dev *wdev,
6693 enum nl80211_commands cmd,
6694 enum nl80211_attrs attr,
6695 unsigned int portid,
6696 int vendor_event_idx,
6697 int approxlen, gfp_t gfp);
6699 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6702 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6704 * @approxlen: an upper bound of the length of the data that will
6705 * be put into the skb
6707 * This function allocates and pre-fills an skb for a reply to
6708 * a vendor command. Since it is intended for a reply, calling
6709 * it outside of a vendor command's doit() operation is invalid.
6711 * The returned skb is pre-filled with some identifying data in
6712 * a way that any data that is put into the skb (with skb_put(),
6713 * nla_put() or similar) will end up being within the
6714 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6715 * with the skb is adding data for the corresponding userspace tool
6716 * which can then read that data out of the vendor data attribute.
6717 * You must not modify the skb in any other way.
6719 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6720 * its error code as the result of the doit() operation.
6722 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6724 static inline struct sk_buff *
6725 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6727 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6728 NL80211_ATTR_VENDOR_DATA, approxlen);
6732 * cfg80211_vendor_cmd_reply - send the reply skb
6733 * @skb: The skb, must have been allocated with
6734 * cfg80211_vendor_cmd_alloc_reply_skb()
6736 * Since calling this function will usually be the last thing
6737 * before returning from the vendor command doit() you should
6738 * return the error code. Note that this function consumes the
6739 * skb regardless of the return value.
6741 * Return: An error code or 0 on success.
6743 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6746 * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
6749 * Return the current netlink port ID in a vendor command handler.
6750 * Valid to call only there.
6752 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6755 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6757 * @wdev: the wireless device
6758 * @event_idx: index of the vendor event in the wiphy's vendor_events
6759 * @approxlen: an upper bound of the length of the data that will
6760 * be put into the skb
6761 * @gfp: allocation flags
6763 * This function allocates and pre-fills an skb for an event on the
6764 * vendor-specific multicast group.
6766 * If wdev != NULL, both the ifindex and identifier of the specified
6767 * wireless device are added to the event message before the vendor data
6770 * When done filling the skb, call cfg80211_vendor_event() with the
6771 * skb to send the event.
6773 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6775 static inline struct sk_buff *
6776 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6777 int approxlen, int event_idx, gfp_t gfp)
6779 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6780 NL80211_ATTR_VENDOR_DATA,
6781 0, event_idx, approxlen, gfp);
6785 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6787 * @wdev: the wireless device
6788 * @event_idx: index of the vendor event in the wiphy's vendor_events
6789 * @portid: port ID of the receiver
6790 * @approxlen: an upper bound of the length of the data that will
6791 * be put into the skb
6792 * @gfp: allocation flags
6794 * This function allocates and pre-fills an skb for an event to send to
6795 * a specific (userland) socket. This socket would previously have been
6796 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6797 * care to register a netlink notifier to see when the socket closes.
6799 * If wdev != NULL, both the ifindex and identifier of the specified
6800 * wireless device are added to the event message before the vendor data
6803 * When done filling the skb, call cfg80211_vendor_event() with the
6804 * skb to send the event.
6806 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6808 static inline struct sk_buff *
6809 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6810 struct wireless_dev *wdev,
6811 unsigned int portid, int approxlen,
6812 int event_idx, gfp_t gfp)
6814 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6815 NL80211_ATTR_VENDOR_DATA,
6816 portid, event_idx, approxlen, gfp);
6820 * cfg80211_vendor_event - send the event
6821 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6822 * @gfp: allocation flags
6824 * This function sends the given @skb, which must have been allocated
6825 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6827 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6829 __cfg80211_send_event_skb(skb, gfp);
6832 #ifdef CONFIG_NL80211_TESTMODE
6836 * Test mode is a set of utility functions to allow drivers to
6837 * interact with driver-specific tools to aid, for instance,
6838 * factory programming.
6840 * This chapter describes how drivers interact with it, for more
6841 * information see the nl80211 book's chapter on it.
6845 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6847 * @approxlen: an upper bound of the length of the data that will
6848 * be put into the skb
6850 * This function allocates and pre-fills an skb for a reply to
6851 * the testmode command. Since it is intended for a reply, calling
6852 * it outside of the @testmode_cmd operation is invalid.
6854 * The returned skb is pre-filled with the wiphy index and set up in
6855 * a way that any data that is put into the skb (with skb_put(),
6856 * nla_put() or similar) will end up being within the
6857 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6858 * with the skb is adding data for the corresponding userspace tool
6859 * which can then read that data out of the testdata attribute. You
6860 * must not modify the skb in any other way.
6862 * When done, call cfg80211_testmode_reply() with the skb and return
6863 * its error code as the result of the @testmode_cmd operation.
6865 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6867 static inline struct sk_buff *
6868 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6870 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6871 NL80211_ATTR_TESTDATA, approxlen);
6875 * cfg80211_testmode_reply - send the reply skb
6876 * @skb: The skb, must have been allocated with
6877 * cfg80211_testmode_alloc_reply_skb()
6879 * Since calling this function will usually be the last thing
6880 * before returning from the @testmode_cmd you should return
6881 * the error code. Note that this function consumes the skb
6882 * regardless of the return value.
6884 * Return: An error code or 0 on success.
6886 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6888 return cfg80211_vendor_cmd_reply(skb);
6892 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6894 * @approxlen: an upper bound of the length of the data that will
6895 * be put into the skb
6896 * @gfp: allocation flags
6898 * This function allocates and pre-fills an skb for an event on the
6899 * testmode multicast group.
6901 * The returned skb is set up in the same way as with
6902 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6903 * there, you should simply add data to it that will then end up in the
6904 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6907 * When done filling the skb, call cfg80211_testmode_event() with the
6908 * skb to send the event.
6910 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6912 static inline struct sk_buff *
6913 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6915 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6916 NL80211_ATTR_TESTDATA, 0, -1,
6921 * cfg80211_testmode_event - send the event
6922 * @skb: The skb, must have been allocated with
6923 * cfg80211_testmode_alloc_event_skb()
6924 * @gfp: allocation flags
6926 * This function sends the given @skb, which must have been allocated
6927 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6930 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6932 __cfg80211_send_event_skb(skb, gfp);
6935 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6936 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6938 #define CFG80211_TESTMODE_CMD(cmd)
6939 #define CFG80211_TESTMODE_DUMP(cmd)
6943 * struct cfg80211_fils_resp_params - FILS connection response params
6944 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6945 * @kek_len: Length of @fils_kek in octets
6946 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6947 * @erp_next_seq_num is valid.
6948 * @erp_next_seq_num: The next sequence number to use in ERP message in
6949 * FILS Authentication. This value should be specified irrespective of the
6950 * status for a FILS connection.
6951 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6952 * @pmk_len: Length of @pmk in octets
6953 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6954 * used for this FILS connection (may be %NULL).
6956 struct cfg80211_fils_resp_params {
6959 bool update_erp_next_seq_num;
6960 u16 erp_next_seq_num;
6967 * struct cfg80211_connect_resp_params - Connection response params
6968 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6969 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6970 * the real status code for failures. If this call is used to report a
6971 * failure due to a timeout (e.g., not receiving an Authentication frame
6972 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6973 * indicate that this is a failure, but without a status code.
6974 * @timeout_reason is used to report the reason for the timeout in that
6976 * @bssid: The BSSID of the AP (may be %NULL)
6977 * @bss: Entry of bss to which STA got connected to, can be obtained through
6978 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6979 * bss from the connect_request and hold a reference to it and return
6980 * through this param to avoid a warning if the bss is expired during the
6981 * connection, esp. for those drivers implementing connect op.
6982 * Only one parameter among @bssid and @bss needs to be specified.
6983 * @req_ie: Association request IEs (may be %NULL)
6984 * @req_ie_len: Association request IEs length
6985 * @resp_ie: Association response IEs (may be %NULL)
6986 * @resp_ie_len: Association response IEs length
6987 * @fils: FILS connection response parameters.
6988 * @timeout_reason: Reason for connection timeout. This is used when the
6989 * connection fails due to a timeout instead of an explicit rejection from
6990 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6991 * not known. This value is used only if @status < 0 to indicate that the
6992 * failure is due to a timeout and not due to explicit rejection by the AP.
6993 * This value is ignored in other cases (@status >= 0).
6995 struct cfg80211_connect_resp_params {
6998 struct cfg80211_bss *bss;
7003 struct cfg80211_fils_resp_params fils;
7004 enum nl80211_timeout_reason timeout_reason;
7008 * cfg80211_connect_done - notify cfg80211 of connection result
7010 * @dev: network device
7011 * @params: connection response parameters
7012 * @gfp: allocation flags
7014 * It should be called by the underlying driver once execution of the connection
7015 * request from connect() has been completed. This is similar to
7016 * cfg80211_connect_bss(), but takes a structure pointer for connection response
7017 * parameters. Only one of the functions among cfg80211_connect_bss(),
7018 * cfg80211_connect_result(), cfg80211_connect_timeout(),
7019 * and cfg80211_connect_done() should be called.
7021 void cfg80211_connect_done(struct net_device *dev,
7022 struct cfg80211_connect_resp_params *params,
7026 * cfg80211_connect_bss - notify cfg80211 of connection result
7028 * @dev: network device
7029 * @bssid: the BSSID of the AP
7030 * @bss: Entry of bss to which STA got connected to, can be obtained through
7031 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7032 * bss from the connect_request and hold a reference to it and return
7033 * through this param to avoid a warning if the bss is expired during the
7034 * connection, esp. for those drivers implementing connect op.
7035 * Only one parameter among @bssid and @bss needs to be specified.
7036 * @req_ie: association request IEs (maybe be %NULL)
7037 * @req_ie_len: association request IEs length
7038 * @resp_ie: association response IEs (may be %NULL)
7039 * @resp_ie_len: assoc response IEs length
7040 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7041 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7042 * the real status code for failures. If this call is used to report a
7043 * failure due to a timeout (e.g., not receiving an Authentication frame
7044 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7045 * indicate that this is a failure, but without a status code.
7046 * @timeout_reason is used to report the reason for the timeout in that
7048 * @gfp: allocation flags
7049 * @timeout_reason: reason for connection timeout. This is used when the
7050 * connection fails due to a timeout instead of an explicit rejection from
7051 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7052 * not known. This value is used only if @status < 0 to indicate that the
7053 * failure is due to a timeout and not due to explicit rejection by the AP.
7054 * This value is ignored in other cases (@status >= 0).
7056 * It should be called by the underlying driver once execution of the connection
7057 * request from connect() has been completed. This is similar to
7058 * cfg80211_connect_result(), but with the option of identifying the exact bss
7059 * entry for the connection. Only one of the functions among
7060 * cfg80211_connect_bss(), cfg80211_connect_result(),
7061 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7064 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
7065 struct cfg80211_bss *bss, const u8 *req_ie,
7066 size_t req_ie_len, const u8 *resp_ie,
7067 size_t resp_ie_len, int status, gfp_t gfp,
7068 enum nl80211_timeout_reason timeout_reason)
7070 struct cfg80211_connect_resp_params params;
7072 memset(¶ms, 0, sizeof(params));
7073 params.status = status;
7074 params.bssid = bssid;
7076 params.req_ie = req_ie;
7077 params.req_ie_len = req_ie_len;
7078 params.resp_ie = resp_ie;
7079 params.resp_ie_len = resp_ie_len;
7080 params.timeout_reason = timeout_reason;
7082 cfg80211_connect_done(dev, ¶ms, gfp);
7086 * cfg80211_connect_result - notify cfg80211 of connection result
7088 * @dev: network device
7089 * @bssid: the BSSID of the AP
7090 * @req_ie: association request IEs (maybe be %NULL)
7091 * @req_ie_len: association request IEs length
7092 * @resp_ie: association response IEs (may be %NULL)
7093 * @resp_ie_len: assoc response IEs length
7094 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7095 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7096 * the real status code for failures.
7097 * @gfp: allocation flags
7099 * It should be called by the underlying driver once execution of the connection
7100 * request from connect() has been completed. This is similar to
7101 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
7102 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
7103 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7106 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
7107 const u8 *req_ie, size_t req_ie_len,
7108 const u8 *resp_ie, size_t resp_ie_len,
7109 u16 status, gfp_t gfp)
7111 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
7112 resp_ie_len, status, gfp,
7113 NL80211_TIMEOUT_UNSPECIFIED);
7117 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
7119 * @dev: network device
7120 * @bssid: the BSSID of the AP
7121 * @req_ie: association request IEs (maybe be %NULL)
7122 * @req_ie_len: association request IEs length
7123 * @gfp: allocation flags
7124 * @timeout_reason: reason for connection timeout.
7126 * It should be called by the underlying driver whenever connect() has failed
7127 * in a sequence where no explicit authentication/association rejection was
7128 * received from the AP. This could happen, e.g., due to not being able to send
7129 * out the Authentication or Association Request frame or timing out while
7130 * waiting for the response. Only one of the functions among
7131 * cfg80211_connect_bss(), cfg80211_connect_result(),
7132 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7135 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
7136 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
7137 enum nl80211_timeout_reason timeout_reason)
7139 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
7140 gfp, timeout_reason);
7144 * struct cfg80211_roam_info - driver initiated roaming information
7146 * @channel: the channel of the new AP
7147 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
7148 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
7149 * @req_ie: association request IEs (maybe be %NULL)
7150 * @req_ie_len: association request IEs length
7151 * @resp_ie: association response IEs (may be %NULL)
7152 * @resp_ie_len: assoc response IEs length
7153 * @fils: FILS related roaming information.
7155 struct cfg80211_roam_info {
7156 struct ieee80211_channel *channel;
7157 struct cfg80211_bss *bss;
7163 struct cfg80211_fils_resp_params fils;
7167 * cfg80211_roamed - notify cfg80211 of roaming
7169 * @dev: network device
7170 * @info: information about the new BSS. struct &cfg80211_roam_info.
7171 * @gfp: allocation flags
7173 * This function may be called with the driver passing either the BSSID of the
7174 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7175 * It should be called by the underlying driver whenever it roamed from one AP
7176 * to another while connected. Drivers which have roaming implemented in
7177 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7178 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7179 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7180 * rdev->event_work. In case of any failures, the reference is released
7181 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7182 * released while disconnecting from the current bss.
7184 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7188 * cfg80211_port_authorized - notify cfg80211 of successful security association
7190 * @dev: network device
7191 * @bssid: the BSSID of the AP
7192 * @gfp: allocation flags
7194 * This function should be called by a driver that supports 4 way handshake
7195 * offload after a security association was successfully established (i.e.,
7196 * the 4 way handshake was completed successfully). The call to this function
7197 * should be preceded with a call to cfg80211_connect_result(),
7198 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7199 * indicate the 802.11 association.
7201 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7205 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7207 * @dev: network device
7208 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7209 * @ie_len: length of IEs
7210 * @reason: reason code for the disconnection, set it to 0 if unknown
7211 * @locally_generated: disconnection was requested locally
7212 * @gfp: allocation flags
7214 * After it calls this function, the driver should enter an idle state
7215 * and not try to connect to any AP any more.
7217 void cfg80211_disconnected(struct net_device *dev, u16 reason,
7218 const u8 *ie, size_t ie_len,
7219 bool locally_generated, gfp_t gfp);
7222 * cfg80211_ready_on_channel - notification of remain_on_channel start
7223 * @wdev: wireless device
7224 * @cookie: the request cookie
7225 * @chan: The current channel (from remain_on_channel request)
7226 * @duration: Duration in milliseconds that the driver intents to remain on the
7228 * @gfp: allocation flags
7230 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7231 struct ieee80211_channel *chan,
7232 unsigned int duration, gfp_t gfp);
7235 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7236 * @wdev: wireless device
7237 * @cookie: the request cookie
7238 * @chan: The current channel (from remain_on_channel request)
7239 * @gfp: allocation flags
7241 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7242 struct ieee80211_channel *chan,
7246 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7247 * @wdev: wireless device
7248 * @cookie: the requested cookie
7249 * @chan: The current channel (from tx_mgmt request)
7250 * @gfp: allocation flags
7252 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7253 struct ieee80211_channel *chan, gfp_t gfp);
7256 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7258 * @sinfo: the station information
7259 * @gfp: allocation flags
7261 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7264 * cfg80211_sinfo_release_content - release contents of station info
7265 * @sinfo: the station information
7267 * Releases any potentially allocated sub-information of the station
7268 * information, but not the struct itself (since it's typically on
7271 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7273 kfree(sinfo->pertid);
7277 * cfg80211_new_sta - notify userspace about station
7280 * @mac_addr: the station's address
7281 * @sinfo: the station information
7282 * @gfp: allocation flags
7284 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7285 struct station_info *sinfo, gfp_t gfp);
7288 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7290 * @mac_addr: the station's address
7291 * @sinfo: the station information/statistics
7292 * @gfp: allocation flags
7294 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7295 struct station_info *sinfo, gfp_t gfp);
7298 * cfg80211_del_sta - notify userspace about deletion of a station
7301 * @mac_addr: the station's address
7302 * @gfp: allocation flags
7304 static inline void cfg80211_del_sta(struct net_device *dev,
7305 const u8 *mac_addr, gfp_t gfp)
7307 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7311 * cfg80211_conn_failed - connection request failed notification
7314 * @mac_addr: the station's address
7315 * @reason: the reason for connection failure
7316 * @gfp: allocation flags
7318 * Whenever a station tries to connect to an AP and if the station
7319 * could not connect to the AP as the AP has rejected the connection
7320 * for some reasons, this function is called.
7322 * The reason for connection failure can be any of the value from
7323 * nl80211_connect_failed_reason enum
7325 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7326 enum nl80211_connect_failed_reason reason,
7330 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7331 * @wdev: wireless device receiving the frame
7332 * @freq: Frequency on which the frame was received in KHz
7333 * @sig_dbm: signal strength in dBm, or 0 if unknown
7334 * @buf: Management frame (header + body)
7335 * @len: length of the frame data
7336 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7338 * This function is called whenever an Action frame is received for a station
7339 * mode interface, but is not processed in kernel.
7341 * Return: %true if a user space application has registered for this frame.
7342 * For action frames, that makes it responsible for rejecting unrecognized
7343 * action frames; %false otherwise, in which case for action frames the
7344 * driver is responsible for rejecting the frame.
7346 bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq, int sig_dbm,
7347 const u8 *buf, size_t len, u32 flags);
7350 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7351 * @wdev: wireless device receiving the frame
7352 * @freq: Frequency on which the frame was received in MHz
7353 * @sig_dbm: signal strength in dBm, or 0 if unknown
7354 * @buf: Management frame (header + body)
7355 * @len: length of the frame data
7356 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7358 * This function is called whenever an Action frame is received for a station
7359 * mode interface, but is not processed in kernel.
7361 * Return: %true if a user space application has registered for this frame.
7362 * For action frames, that makes it responsible for rejecting unrecognized
7363 * action frames; %false otherwise, in which case for action frames the
7364 * driver is responsible for rejecting the frame.
7366 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7367 int sig_dbm, const u8 *buf, size_t len,
7370 return cfg80211_rx_mgmt_khz(wdev, MHZ_TO_KHZ(freq), sig_dbm, buf, len,
7375 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7376 * @wdev: wireless device receiving the frame
7377 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7378 * @buf: Management frame (header + body)
7379 * @len: length of the frame data
7380 * @ack: Whether frame was acknowledged
7381 * @gfp: context flags
7383 * This function is called whenever a management frame was requested to be
7384 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7385 * transmission attempt.
7387 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
7388 const u8 *buf, size_t len, bool ack, gfp_t gfp);
7391 * cfg80211_control_port_tx_status - notification of TX status for control
7393 * @wdev: wireless device receiving the frame
7394 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7395 * @buf: Data frame (header + body)
7396 * @len: length of the frame data
7397 * @ack: Whether frame was acknowledged
7398 * @gfp: context flags
7400 * This function is called whenever a control port frame was requested to be
7401 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7402 * the transmission attempt.
7404 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
7405 const u8 *buf, size_t len, bool ack,
7409 * cfg80211_rx_control_port - notification about a received control port frame
7410 * @dev: The device the frame matched to
7411 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7412 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7413 * This function does not take ownership of the skb, so the caller is
7414 * responsible for any cleanup. The caller must also ensure that
7415 * skb->protocol is set appropriately.
7416 * @unencrypted: Whether the frame was received unencrypted
7418 * This function is used to inform userspace about a received control port
7419 * frame. It should only be used if userspace indicated it wants to receive
7420 * control port frames over nl80211.
7422 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7423 * network layer headers removed (e.g. the raw EAPoL frame).
7425 * Return: %true if the frame was passed to userspace
7427 bool cfg80211_rx_control_port(struct net_device *dev,
7428 struct sk_buff *skb, bool unencrypted);
7431 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
7432 * @dev: network device
7433 * @rssi_event: the triggered RSSI event
7434 * @rssi_level: new RSSI level value or 0 if not available
7435 * @gfp: context flags
7437 * This function is called when a configured connection quality monitoring
7438 * rssi threshold reached event occurs.
7440 void cfg80211_cqm_rssi_notify(struct net_device *dev,
7441 enum nl80211_cqm_rssi_threshold_event rssi_event,
7442 s32 rssi_level, gfp_t gfp);
7445 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
7446 * @dev: network device
7447 * @peer: peer's MAC address
7448 * @num_packets: how many packets were lost -- should be a fixed threshold
7449 * but probably no less than maybe 50, or maybe a throughput dependent
7450 * threshold (to account for temporary interference)
7451 * @gfp: context flags
7453 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
7454 const u8 *peer, u32 num_packets, gfp_t gfp);
7457 * cfg80211_cqm_txe_notify - TX error rate event
7458 * @dev: network device
7459 * @peer: peer's MAC address
7460 * @num_packets: how many packets were lost
7461 * @rate: % of packets which failed transmission
7462 * @intvl: interval (in s) over which the TX failure threshold was breached.
7463 * @gfp: context flags
7465 * Notify userspace when configured % TX failures over number of packets in a
7466 * given interval is exceeded.
7468 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
7469 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
7472 * cfg80211_cqm_beacon_loss_notify - beacon loss event
7473 * @dev: network device
7474 * @gfp: context flags
7476 * Notify userspace about beacon loss from the connected AP.
7478 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
7481 * cfg80211_radar_event - radar detection event
7483 * @chandef: chandef for the current channel
7484 * @gfp: context flags
7486 * This function is called when a radar is detected on the current chanenl.
7488 void cfg80211_radar_event(struct wiphy *wiphy,
7489 struct cfg80211_chan_def *chandef, gfp_t gfp);
7492 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
7493 * @dev: network device
7494 * @mac: MAC address of a station which opmode got modified
7495 * @sta_opmode: station's current opmode value
7496 * @gfp: context flags
7498 * Driver should call this function when station's opmode modified via action
7501 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
7502 struct sta_opmode_info *sta_opmode,
7506 * cfg80211_cac_event - Channel availability check (CAC) event
7507 * @netdev: network device
7508 * @chandef: chandef for the current channel
7509 * @event: type of event
7510 * @gfp: context flags
7512 * This function is called when a Channel availability check (CAC) is finished
7513 * or aborted. This must be called to notify the completion of a CAC process,
7514 * also by full-MAC drivers.
7516 void cfg80211_cac_event(struct net_device *netdev,
7517 const struct cfg80211_chan_def *chandef,
7518 enum nl80211_radar_event event, gfp_t gfp);
7522 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
7523 * @dev: network device
7524 * @bssid: BSSID of AP (to avoid races)
7525 * @replay_ctr: new replay counter
7526 * @gfp: allocation flags
7528 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
7529 const u8 *replay_ctr, gfp_t gfp);
7532 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7533 * @dev: network device
7534 * @index: candidate index (the smaller the index, the higher the priority)
7535 * @bssid: BSSID of AP
7536 * @preauth: Whether AP advertises support for RSN pre-authentication
7537 * @gfp: allocation flags
7539 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
7540 const u8 *bssid, bool preauth, gfp_t gfp);
7543 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7544 * @dev: The device the frame matched to
7545 * @addr: the transmitter address
7546 * @gfp: context flags
7548 * This function is used in AP mode (only!) to inform userspace that
7549 * a spurious class 3 frame was received, to be able to deauth the
7551 * Return: %true if the frame was passed to userspace (or this failed
7552 * for a reason other than not having a subscription.)
7554 bool cfg80211_rx_spurious_frame(struct net_device *dev,
7555 const u8 *addr, gfp_t gfp);
7558 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7559 * @dev: The device the frame matched to
7560 * @addr: the transmitter address
7561 * @gfp: context flags
7563 * This function is used in AP mode (only!) to inform userspace that
7564 * an associated station sent a 4addr frame but that wasn't expected.
7565 * It is allowed and desirable to send this event only once for each
7566 * station to avoid event flooding.
7567 * Return: %true if the frame was passed to userspace (or this failed
7568 * for a reason other than not having a subscription.)
7570 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
7571 const u8 *addr, gfp_t gfp);
7574 * cfg80211_probe_status - notify userspace about probe status
7575 * @dev: the device the probe was sent on
7576 * @addr: the address of the peer
7577 * @cookie: the cookie filled in @probe_client previously
7578 * @acked: indicates whether probe was acked or not
7579 * @ack_signal: signal strength (in dBm) of the ACK frame.
7580 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7581 * @gfp: allocation flags
7583 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
7584 u64 cookie, bool acked, s32 ack_signal,
7585 bool is_valid_ack_signal, gfp_t gfp);
7588 * cfg80211_report_obss_beacon_khz - report beacon from other APs
7589 * @wiphy: The wiphy that received the beacon
7591 * @len: length of the frame
7592 * @freq: frequency the frame was received on in KHz
7593 * @sig_dbm: signal strength in dBm, or 0 if unknown
7595 * Use this function to report to userspace when a beacon was
7596 * received. It is not useful to call this when there is no
7597 * netdev that is in AP/GO mode.
7599 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
7600 size_t len, int freq, int sig_dbm);
7603 * cfg80211_report_obss_beacon - report beacon from other APs
7604 * @wiphy: The wiphy that received the beacon
7606 * @len: length of the frame
7607 * @freq: frequency the frame was received on
7608 * @sig_dbm: signal strength in dBm, or 0 if unknown
7610 * Use this function to report to userspace when a beacon was
7611 * received. It is not useful to call this when there is no
7612 * netdev that is in AP/GO mode.
7614 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7615 const u8 *frame, size_t len,
7616 int freq, int sig_dbm)
7618 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
7623 * cfg80211_reg_can_beacon - check if beaconing is allowed
7625 * @chandef: the channel definition
7626 * @iftype: interface type
7628 * Return: %true if there is no secondary channel or the secondary channel(s)
7629 * can be used for beaconing (i.e. is not a radar channel etc.)
7631 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7632 struct cfg80211_chan_def *chandef,
7633 enum nl80211_iftype iftype);
7636 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7638 * @chandef: the channel definition
7639 * @iftype: interface type
7641 * Return: %true if there is no secondary channel or the secondary channel(s)
7642 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7643 * also checks if IR-relaxation conditions apply, to allow beaconing under
7644 * more permissive conditions.
7646 * Requires the wiphy mutex to be held.
7648 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7649 struct cfg80211_chan_def *chandef,
7650 enum nl80211_iftype iftype);
7653 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7654 * @dev: the device which switched channels
7655 * @chandef: the new channel definition
7657 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7660 void cfg80211_ch_switch_notify(struct net_device *dev,
7661 struct cfg80211_chan_def *chandef);
7664 * cfg80211_ch_switch_started_notify - notify channel switch start
7665 * @dev: the device on which the channel switch started
7666 * @chandef: the future channel definition
7667 * @count: the number of TBTTs until the channel switch happens
7668 * @quiet: whether or not immediate quiet was requested by the AP
7670 * Inform the userspace about the channel switch that has just
7671 * started, so that it can take appropriate actions (eg. starting
7672 * channel switch on other vifs), if necessary.
7674 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7675 struct cfg80211_chan_def *chandef,
7676 u8 count, bool quiet);
7679 * ieee80211_operating_class_to_band - convert operating class to band
7681 * @operating_class: the operating class to convert
7682 * @band: band pointer to fill
7684 * Returns %true if the conversion was successful, %false otherwise.
7686 bool ieee80211_operating_class_to_band(u8 operating_class,
7687 enum nl80211_band *band);
7690 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7692 * @chandef: the chandef to convert
7693 * @op_class: a pointer to the resulting operating class
7695 * Returns %true if the conversion was successful, %false otherwise.
7697 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7701 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
7703 * @chandef: the chandef to convert
7705 * Returns the center frequency of chandef (1st segment) in KHz.
7708 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
7710 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
7714 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7715 * @dev: the device on which the operation is requested
7716 * @peer: the MAC address of the peer device
7717 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7718 * NL80211_TDLS_TEARDOWN)
7719 * @reason_code: the reason code for teardown request
7720 * @gfp: allocation flags
7722 * This function is used to request userspace to perform TDLS operation that
7723 * requires knowledge of keys, i.e., link setup or teardown when the AP
7724 * connection uses encryption. This is optional mechanism for the driver to use
7725 * if it can automatically determine when a TDLS link could be useful (e.g.,
7726 * based on traffic and signal strength for a peer).
7728 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7729 enum nl80211_tdls_operation oper,
7730 u16 reason_code, gfp_t gfp);
7733 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7734 * @rate: given rate_info to calculate bitrate from
7736 * return 0 if MCS index >= 32
7738 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7741 * cfg80211_unregister_wdev - remove the given wdev
7742 * @wdev: struct wireless_dev to remove
7744 * This function removes the device so it can no longer be used. It is necessary
7745 * to call this function even when cfg80211 requests the removal of the device
7746 * by calling the del_virtual_intf() callback. The function must also be called
7747 * when the driver wishes to unregister the wdev, e.g. when the hardware device
7748 * is unbound from the driver.
7750 * Requires the RTNL and wiphy mutex to be held.
7752 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7755 * cfg80211_register_netdevice - register the given netdev
7756 * @dev: the netdev to register
7758 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
7759 * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
7760 * held. Otherwise, both register_netdevice() and register_netdev() are usable
7763 * Requires the RTNL and wiphy mutex to be held.
7765 int cfg80211_register_netdevice(struct net_device *dev);
7768 * cfg80211_unregister_netdevice - unregister the given netdev
7769 * @dev: the netdev to register
7771 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
7772 * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
7773 * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
7774 * usable instead as well.
7776 * Requires the RTNL and wiphy mutex to be held.
7778 static inline void cfg80211_unregister_netdevice(struct net_device *dev)
7780 cfg80211_unregister_wdev(dev->ieee80211_ptr);
7784 * struct cfg80211_ft_event_params - FT Information Elements
7786 * @ies_len: length of the FT IE in bytes
7787 * @target_ap: target AP's MAC address
7789 * @ric_ies_len: length of the RIC IE in bytes
7791 struct cfg80211_ft_event_params {
7794 const u8 *target_ap;
7800 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7801 * @netdev: network device
7802 * @ft_event: IE information
7804 void cfg80211_ft_event(struct net_device *netdev,
7805 struct cfg80211_ft_event_params *ft_event);
7808 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7809 * @ies: the input IE buffer
7810 * @len: the input length
7811 * @attr: the attribute ID to find
7812 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7813 * if the function is only called to get the needed buffer size
7814 * @bufsize: size of the output buffer
7816 * The function finds a given P2P attribute in the (vendor) IEs and
7817 * copies its contents to the given buffer.
7819 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7820 * malformed or the attribute can't be found (respectively), or the
7821 * length of the found attribute (which can be zero).
7823 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7824 enum ieee80211_p2p_attr_id attr,
7825 u8 *buf, unsigned int bufsize);
7828 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7829 * @ies: the IE buffer
7830 * @ielen: the length of the IE buffer
7831 * @ids: an array with element IDs that are allowed before
7832 * the split. A WLAN_EID_EXTENSION value means that the next
7833 * EID in the list is a sub-element of the EXTENSION IE.
7834 * @n_ids: the size of the element ID array
7835 * @after_ric: array IE types that come after the RIC element
7836 * @n_after_ric: size of the @after_ric array
7837 * @offset: offset where to start splitting in the buffer
7839 * This function splits an IE buffer by updating the @offset
7840 * variable to point to the location where the buffer should be
7843 * It assumes that the given IE buffer is well-formed, this
7844 * has to be guaranteed by the caller!
7846 * It also assumes that the IEs in the buffer are ordered
7847 * correctly, if not the result of using this function will not
7848 * be ordered correctly either, i.e. it does no reordering.
7850 * The function returns the offset where the next part of the
7851 * buffer starts, which may be @ielen if the entire (remainder)
7852 * of the buffer should be used.
7854 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7855 const u8 *ids, int n_ids,
7856 const u8 *after_ric, int n_after_ric,
7860 * ieee80211_ie_split - split an IE buffer according to ordering
7861 * @ies: the IE buffer
7862 * @ielen: the length of the IE buffer
7863 * @ids: an array with element IDs that are allowed before
7864 * the split. A WLAN_EID_EXTENSION value means that the next
7865 * EID in the list is a sub-element of the EXTENSION IE.
7866 * @n_ids: the size of the element ID array
7867 * @offset: offset where to start splitting in the buffer
7869 * This function splits an IE buffer by updating the @offset
7870 * variable to point to the location where the buffer should be
7873 * It assumes that the given IE buffer is well-formed, this
7874 * has to be guaranteed by the caller!
7876 * It also assumes that the IEs in the buffer are ordered
7877 * correctly, if not the result of using this function will not
7878 * be ordered correctly either, i.e. it does no reordering.
7880 * The function returns the offset where the next part of the
7881 * buffer starts, which may be @ielen if the entire (remainder)
7882 * of the buffer should be used.
7884 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7885 const u8 *ids, int n_ids, size_t offset)
7887 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7891 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7892 * @wdev: the wireless device reporting the wakeup
7893 * @wakeup: the wakeup report
7894 * @gfp: allocation flags
7896 * This function reports that the given device woke up. If it
7897 * caused the wakeup, report the reason(s), otherwise you may
7898 * pass %NULL as the @wakeup parameter to advertise that something
7899 * else caused the wakeup.
7901 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7902 struct cfg80211_wowlan_wakeup *wakeup,
7906 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7908 * @wdev: the wireless device for which critical protocol is stopped.
7909 * @gfp: allocation flags
7911 * This function can be called by the driver to indicate it has reverted
7912 * operation back to normal. One reason could be that the duration given
7913 * by .crit_proto_start() has expired.
7915 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7918 * ieee80211_get_num_supported_channels - get number of channels device has
7921 * Return: the number of channels supported by the device.
7923 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7926 * cfg80211_check_combinations - check interface combinations
7929 * @params: the interface combinations parameter
7931 * This function can be called by the driver to check whether a
7932 * combination of interfaces and their types are allowed according to
7933 * the interface combinations.
7935 int cfg80211_check_combinations(struct wiphy *wiphy,
7936 struct iface_combination_params *params);
7939 * cfg80211_iter_combinations - iterate over matching combinations
7942 * @params: the interface combinations parameter
7943 * @iter: function to call for each matching combination
7944 * @data: pointer to pass to iter function
7946 * This function can be called by the driver to check what possible
7947 * combinations it fits in at a given moment, e.g. for channel switching
7950 int cfg80211_iter_combinations(struct wiphy *wiphy,
7951 struct iface_combination_params *params,
7952 void (*iter)(const struct ieee80211_iface_combination *c,
7957 * cfg80211_stop_iface - trigger interface disconnection
7960 * @wdev: wireless device
7961 * @gfp: context flags
7963 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7966 * Note: This doesn't need any locks and is asynchronous.
7968 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7972 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7973 * @wiphy: the wiphy to shut down
7975 * This function shuts down all interfaces belonging to this wiphy by
7976 * calling dev_close() (and treating non-netdev interfaces as needed).
7977 * It shouldn't really be used unless there are some fatal device errors
7978 * that really can't be recovered in any other way.
7980 * Callers must hold the RTNL and be able to deal with callbacks into
7981 * the driver while the function is running.
7983 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7986 * wiphy_ext_feature_set - set the extended feature flag
7988 * @wiphy: the wiphy to modify.
7989 * @ftidx: extended feature bit index.
7991 * The extended features are flagged in multiple bytes (see
7992 * &struct wiphy.@ext_features)
7994 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7995 enum nl80211_ext_feature_index ftidx)
7999 ft_byte = &wiphy->ext_features[ftidx / 8];
8000 *ft_byte |= BIT(ftidx % 8);
8004 * wiphy_ext_feature_isset - check the extended feature flag
8006 * @wiphy: the wiphy to modify.
8007 * @ftidx: extended feature bit index.
8009 * The extended features are flagged in multiple bytes (see
8010 * &struct wiphy.@ext_features)
8013 wiphy_ext_feature_isset(struct wiphy *wiphy,
8014 enum nl80211_ext_feature_index ftidx)
8018 ft_byte = wiphy->ext_features[ftidx / 8];
8019 return (ft_byte & BIT(ftidx % 8)) != 0;
8023 * cfg80211_free_nan_func - free NAN function
8024 * @f: NAN function that should be freed
8026 * Frees all the NAN function and all it's allocated members.
8028 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
8031 * struct cfg80211_nan_match_params - NAN match parameters
8032 * @type: the type of the function that triggered a match. If it is
8033 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
8034 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
8036 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
8037 * @inst_id: the local instance id
8038 * @peer_inst_id: the instance id of the peer's function
8039 * @addr: the MAC address of the peer
8040 * @info_len: the length of the &info
8041 * @info: the Service Specific Info from the peer (if any)
8042 * @cookie: unique identifier of the corresponding function
8044 struct cfg80211_nan_match_params {
8045 enum nl80211_nan_function_type type;
8055 * cfg80211_nan_match - report a match for a NAN function.
8056 * @wdev: the wireless device reporting the match
8057 * @match: match notification parameters
8058 * @gfp: allocation flags
8060 * This function reports that the a NAN function had a match. This
8061 * can be a subscribe that had a match or a solicited publish that
8062 * was sent. It can also be a follow up that was received.
8064 void cfg80211_nan_match(struct wireless_dev *wdev,
8065 struct cfg80211_nan_match_params *match, gfp_t gfp);
8068 * cfg80211_nan_func_terminated - notify about NAN function termination.
8070 * @wdev: the wireless device reporting the match
8071 * @inst_id: the local instance id
8072 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
8073 * @cookie: unique NAN function identifier
8074 * @gfp: allocation flags
8076 * This function reports that the a NAN function is terminated.
8078 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
8080 enum nl80211_nan_func_term_reason reason,
8081 u64 cookie, gfp_t gfp);
8083 /* ethtool helper */
8084 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
8087 * cfg80211_external_auth_request - userspace request for authentication
8088 * @netdev: network device
8089 * @params: External authentication parameters
8090 * @gfp: allocation flags
8091 * Returns: 0 on success, < 0 on error
8093 int cfg80211_external_auth_request(struct net_device *netdev,
8094 struct cfg80211_external_auth_params *params,
8098 * cfg80211_pmsr_report - report peer measurement result data
8099 * @wdev: the wireless device reporting the measurement
8100 * @req: the original measurement request
8101 * @result: the result data
8102 * @gfp: allocation flags
8104 void cfg80211_pmsr_report(struct wireless_dev *wdev,
8105 struct cfg80211_pmsr_request *req,
8106 struct cfg80211_pmsr_result *result,
8110 * cfg80211_pmsr_complete - report peer measurement completed
8111 * @wdev: the wireless device reporting the measurement
8112 * @req: the original measurement request
8113 * @gfp: allocation flags
8115 * Report that the entire measurement completed, after this
8116 * the request pointer will no longer be valid.
8118 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
8119 struct cfg80211_pmsr_request *req,
8123 * cfg80211_iftype_allowed - check whether the interface can be allowed
8125 * @iftype: interface type
8126 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
8127 * @check_swif: check iftype against software interfaces
8129 * Check whether the interface is allowed to operate; additionally, this API
8130 * can be used to check iftype against the software interfaces when
8131 * check_swif is '1'.
8133 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
8134 bool is_4addr, u8 check_swif);
8137 /* Logging, debugging and troubleshooting/diagnostic helpers. */
8139 /* wiphy_printk helpers, similar to dev_printk */
8141 #define wiphy_printk(level, wiphy, format, args...) \
8142 dev_printk(level, &(wiphy)->dev, format, ##args)
8143 #define wiphy_emerg(wiphy, format, args...) \
8144 dev_emerg(&(wiphy)->dev, format, ##args)
8145 #define wiphy_alert(wiphy, format, args...) \
8146 dev_alert(&(wiphy)->dev, format, ##args)
8147 #define wiphy_crit(wiphy, format, args...) \
8148 dev_crit(&(wiphy)->dev, format, ##args)
8149 #define wiphy_err(wiphy, format, args...) \
8150 dev_err(&(wiphy)->dev, format, ##args)
8151 #define wiphy_warn(wiphy, format, args...) \
8152 dev_warn(&(wiphy)->dev, format, ##args)
8153 #define wiphy_notice(wiphy, format, args...) \
8154 dev_notice(&(wiphy)->dev, format, ##args)
8155 #define wiphy_info(wiphy, format, args...) \
8156 dev_info(&(wiphy)->dev, format, ##args)
8158 #define wiphy_err_ratelimited(wiphy, format, args...) \
8159 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
8160 #define wiphy_warn_ratelimited(wiphy, format, args...) \
8161 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
8163 #define wiphy_debug(wiphy, format, args...) \
8164 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
8166 #define wiphy_dbg(wiphy, format, args...) \
8167 dev_dbg(&(wiphy)->dev, format, ##args)
8169 #if defined(VERBOSE_DEBUG)
8170 #define wiphy_vdbg wiphy_dbg
8172 #define wiphy_vdbg(wiphy, format, args...) \
8175 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8181 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8182 * of using a WARN/WARN_ON to get the message out, including the
8183 * file/line information and a backtrace.
8185 #define wiphy_WARN(wiphy, format, args...) \
8186 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8189 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8190 * @netdev: network device
8191 * @owe_info: peer's owe info
8192 * @gfp: allocation flags
8194 void cfg80211_update_owe_info_event(struct net_device *netdev,
8195 struct cfg80211_update_owe_info *owe_info,
8199 * cfg80211_bss_flush - resets all the scan entries
8202 void cfg80211_bss_flush(struct wiphy *wiphy);
8204 #endif /* __NET_CFG80211_H */