1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __NET_CFG80211_H
3 #define __NET_CFG80211_H
5 * 802.11 device and configuration interface
7 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright 2015-2017 Intel Deutschland GmbH
10 * Copyright (C) 2018-2021 Intel Corporation
13 #include <linux/ethtool.h>
14 #include <uapi/linux/rfkill.h>
15 #include <linux/netdevice.h>
16 #include <linux/debugfs.h>
17 #include <linux/list.h>
18 #include <linux/bug.h>
19 #include <linux/netlink.h>
20 #include <linux/skbuff.h>
21 #include <linux/nl80211.h>
22 #include <linux/if_ether.h>
23 #include <linux/ieee80211.h>
24 #include <linux/net.h>
25 #include <linux/rfkill.h>
26 #include <net/regulatory.h>
31 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32 * userspace and drivers, and offers some utility functionality associated
33 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34 * by all modern wireless drivers in Linux, so that they offer a consistent
35 * API through nl80211. For backward compatibility, cfg80211 also offers
36 * wireless extensions to userspace, but hides them from drivers completely.
38 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
44 * DOC: Device registration
46 * In order for a driver to use cfg80211, it must register the hardware device
47 * with cfg80211. This happens through a number of hardware capability structs
50 * The fundamental structure for each device is the 'wiphy', of which each
51 * instance describes a physical wireless device connected to the system. Each
52 * such wiphy can have zero, one, or many virtual interfaces associated with
53 * it, which need to be identified as such by pointing the network interface's
54 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55 * the wireless part of the interface, normally this struct is embedded in the
56 * network interface's private data area. Drivers can optionally allow creating
57 * or destroying virtual interfaces on the fly, but without at least one or the
58 * ability to create some the wireless device isn't useful.
60 * Each wiphy structure contains device capability information, and also has
61 * a pointer to the various operations the driver offers. The definitions and
62 * structures here describe these capabilities in detail.
68 * wireless hardware capability structures
72 * enum ieee80211_channel_flags - channel flags
74 * Channel flags set by the regulatory control code.
76 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
77 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
78 * sending probe requests or beaconing.
79 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
80 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
82 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
84 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
85 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
86 * this flag indicates that an 80 MHz channel cannot use this
87 * channel as the control or any of the secondary channels.
88 * This may be due to the driver or due to regulatory bandwidth
90 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
91 * this flag indicates that an 160 MHz channel cannot use this
92 * channel as the control or any of the secondary channels.
93 * This may be due to the driver or due to regulatory bandwidth
95 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
96 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
97 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
99 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
101 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
102 * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted
104 * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted
106 * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted
108 * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted
110 * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted
114 enum ieee80211_channel_flags {
115 IEEE80211_CHAN_DISABLED = 1<<0,
116 IEEE80211_CHAN_NO_IR = 1<<1,
118 IEEE80211_CHAN_RADAR = 1<<3,
119 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
120 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
121 IEEE80211_CHAN_NO_OFDM = 1<<6,
122 IEEE80211_CHAN_NO_80MHZ = 1<<7,
123 IEEE80211_CHAN_NO_160MHZ = 1<<8,
124 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
125 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
126 IEEE80211_CHAN_NO_20MHZ = 1<<11,
127 IEEE80211_CHAN_NO_10MHZ = 1<<12,
128 IEEE80211_CHAN_NO_HE = 1<<13,
129 IEEE80211_CHAN_1MHZ = 1<<14,
130 IEEE80211_CHAN_2MHZ = 1<<15,
131 IEEE80211_CHAN_4MHZ = 1<<16,
132 IEEE80211_CHAN_8MHZ = 1<<17,
133 IEEE80211_CHAN_16MHZ = 1<<18,
136 #define IEEE80211_CHAN_NO_HT40 \
137 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
139 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
140 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
143 * struct ieee80211_channel - channel definition
145 * This structure describes a single channel for use
148 * @center_freq: center frequency in MHz
149 * @freq_offset: offset from @center_freq, in KHz
150 * @hw_value: hardware-specific value for the channel
151 * @flags: channel flags from &enum ieee80211_channel_flags.
152 * @orig_flags: channel flags at registration time, used by regulatory
153 * code to support devices with additional restrictions
154 * @band: band this channel belongs to.
155 * @max_antenna_gain: maximum antenna gain in dBi
156 * @max_power: maximum transmission power (in dBm)
157 * @max_reg_power: maximum regulatory transmission power (in dBm)
158 * @beacon_found: helper to regulatory code to indicate when a beacon
159 * has been found on this channel. Use regulatory_hint_found_beacon()
160 * to enable this, this is useful only on 5 GHz band.
161 * @orig_mag: internal use
162 * @orig_mpwr: internal use
163 * @dfs_state: current state of this channel. Only relevant if radar is required
165 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
166 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
168 struct ieee80211_channel {
169 enum nl80211_band band;
174 int max_antenna_gain;
179 int orig_mag, orig_mpwr;
180 enum nl80211_dfs_state dfs_state;
181 unsigned long dfs_state_entered;
182 unsigned int dfs_cac_ms;
186 * enum ieee80211_rate_flags - rate flags
188 * Hardware/specification flags for rates. These are structured
189 * in a way that allows using the same bitrate structure for
190 * different bands/PHY modes.
192 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
193 * preamble on this bitrate; only relevant in 2.4GHz band and
195 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
196 * when used with 802.11a (on the 5 GHz band); filled by the
197 * core code when registering the wiphy.
198 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
199 * when used with 802.11b (on the 2.4 GHz band); filled by the
200 * core code when registering the wiphy.
201 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
202 * when used with 802.11g (on the 2.4 GHz band); filled by the
203 * core code when registering the wiphy.
204 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
205 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
206 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
208 enum ieee80211_rate_flags {
209 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
210 IEEE80211_RATE_MANDATORY_A = 1<<1,
211 IEEE80211_RATE_MANDATORY_B = 1<<2,
212 IEEE80211_RATE_MANDATORY_G = 1<<3,
213 IEEE80211_RATE_ERP_G = 1<<4,
214 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
215 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
219 * enum ieee80211_bss_type - BSS type filter
221 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
222 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
223 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
224 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
225 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
227 enum ieee80211_bss_type {
228 IEEE80211_BSS_TYPE_ESS,
229 IEEE80211_BSS_TYPE_PBSS,
230 IEEE80211_BSS_TYPE_IBSS,
231 IEEE80211_BSS_TYPE_MBSS,
232 IEEE80211_BSS_TYPE_ANY
236 * enum ieee80211_privacy - BSS privacy filter
238 * @IEEE80211_PRIVACY_ON: privacy bit set
239 * @IEEE80211_PRIVACY_OFF: privacy bit clear
240 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
242 enum ieee80211_privacy {
243 IEEE80211_PRIVACY_ON,
244 IEEE80211_PRIVACY_OFF,
245 IEEE80211_PRIVACY_ANY
248 #define IEEE80211_PRIVACY(x) \
249 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
252 * struct ieee80211_rate - bitrate definition
254 * This structure describes a bitrate that an 802.11 PHY can
255 * operate with. The two values @hw_value and @hw_value_short
256 * are only for driver use when pointers to this structure are
259 * @flags: rate-specific flags
260 * @bitrate: bitrate in units of 100 Kbps
261 * @hw_value: driver/hardware value for this rate
262 * @hw_value_short: driver/hardware value for this rate when
263 * short preamble is used
265 struct ieee80211_rate {
268 u16 hw_value, hw_value_short;
272 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
274 * @enable: is the feature enabled.
275 * @sr_ctrl: The SR Control field of SRP element.
276 * @non_srg_max_offset: non-SRG maximum tx power offset
277 * @min_offset: minimal tx power offset an associated station shall use
278 * @max_offset: maximum tx power offset an associated station shall use
279 * @bss_color_bitmap: bitmap that indicates the BSS color values used by
281 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
282 * used by members of the SRG
284 struct ieee80211_he_obss_pd {
287 u8 non_srg_max_offset;
290 u8 bss_color_bitmap[8];
291 u8 partial_bssid_bitmap[8];
295 * struct cfg80211_he_bss_color - AP settings for BSS coloring
297 * @color: the current color.
298 * @enabled: HE BSS color is used
299 * @partial: define the AID equation.
301 struct cfg80211_he_bss_color {
308 * struct ieee80211_sta_ht_cap - STA's HT capabilities
310 * This structure describes most essential parameters needed
311 * to describe 802.11n HT capabilities for an STA.
313 * @ht_supported: is HT supported by the STA
314 * @cap: HT capabilities map as described in 802.11n spec
315 * @ampdu_factor: Maximum A-MPDU length factor
316 * @ampdu_density: Minimum A-MPDU spacing
317 * @mcs: Supported MCS rates
319 struct ieee80211_sta_ht_cap {
320 u16 cap; /* use IEEE80211_HT_CAP_ */
324 struct ieee80211_mcs_info mcs;
328 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
330 * This structure describes most essential parameters needed
331 * to describe 802.11ac VHT capabilities for an STA.
333 * @vht_supported: is VHT supported by the STA
334 * @cap: VHT capabilities map as described in 802.11ac spec
335 * @vht_mcs: Supported VHT MCS rates
337 struct ieee80211_sta_vht_cap {
339 u32 cap; /* use IEEE80211_VHT_CAP_ */
340 struct ieee80211_vht_mcs_info vht_mcs;
343 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
346 * struct ieee80211_sta_he_cap - STA's HE capabilities
348 * This structure describes most essential parameters needed
349 * to describe 802.11ax HE capabilities for a STA.
351 * @has_he: true iff HE data is valid.
352 * @he_cap_elem: Fixed portion of the HE capabilities element.
353 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
354 * @ppe_thres: Holds the PPE Thresholds data.
356 struct ieee80211_sta_he_cap {
358 struct ieee80211_he_cap_elem he_cap_elem;
359 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
360 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
364 * struct ieee80211_sband_iftype_data - sband data per interface type
366 * This structure encapsulates sband data that is relevant for the
367 * interface types defined in @types_mask. Each type in the
368 * @types_mask must be unique across all instances of iftype_data.
370 * @types_mask: interface types mask
371 * @he_cap: holds the HE capabilities
372 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
373 * 6 GHz band channel (and 0 may be valid value).
374 * @vendor_elems: vendor element(s) to advertise
375 * @vendor_elems.data: vendor element(s) data
376 * @vendor_elems.len: vendor element(s) length
378 struct ieee80211_sband_iftype_data {
380 struct ieee80211_sta_he_cap he_cap;
381 struct ieee80211_he_6ghz_capa he_6ghz_capa;
389 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
391 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
392 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
393 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
394 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
395 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
396 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
397 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
398 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
400 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
402 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
404 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
405 * and 4.32GHz + 4.32GHz
406 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
407 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
409 enum ieee80211_edmg_bw_config {
410 IEEE80211_EDMG_BW_CONFIG_4 = 4,
411 IEEE80211_EDMG_BW_CONFIG_5 = 5,
412 IEEE80211_EDMG_BW_CONFIG_6 = 6,
413 IEEE80211_EDMG_BW_CONFIG_7 = 7,
414 IEEE80211_EDMG_BW_CONFIG_8 = 8,
415 IEEE80211_EDMG_BW_CONFIG_9 = 9,
416 IEEE80211_EDMG_BW_CONFIG_10 = 10,
417 IEEE80211_EDMG_BW_CONFIG_11 = 11,
418 IEEE80211_EDMG_BW_CONFIG_12 = 12,
419 IEEE80211_EDMG_BW_CONFIG_13 = 13,
420 IEEE80211_EDMG_BW_CONFIG_14 = 14,
421 IEEE80211_EDMG_BW_CONFIG_15 = 15,
425 * struct ieee80211_edmg - EDMG configuration
427 * This structure describes most essential parameters needed
428 * to describe 802.11ay EDMG configuration
430 * @channels: bitmap that indicates the 2.16 GHz channel(s)
431 * that are allowed to be used for transmissions.
432 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
433 * Set to 0 indicate EDMG not supported.
434 * @bw_config: Channel BW Configuration subfield encodes
435 * the allowed channel bandwidth configurations
437 struct ieee80211_edmg {
439 enum ieee80211_edmg_bw_config bw_config;
443 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
445 * This structure describes most essential parameters needed
446 * to describe 802.11ah S1G capabilities for a STA.
448 * @s1g_supported: is STA an S1G STA
449 * @cap: S1G capabilities information
450 * @nss_mcs: Supported NSS MCS set
452 struct ieee80211_sta_s1g_cap {
454 u8 cap[10]; /* use S1G_CAPAB_ */
459 * struct ieee80211_supported_band - frequency band definition
461 * This structure describes a frequency band a wiphy
462 * is able to operate in.
464 * @channels: Array of channels the hardware can operate with
466 * @band: the band this structure represents
467 * @n_channels: Number of channels in @channels
468 * @bitrates: Array of bitrates the hardware can operate with
469 * in this band. Must be sorted to give a valid "supported
470 * rates" IE, i.e. CCK rates first, then OFDM.
471 * @n_bitrates: Number of bitrates in @bitrates
472 * @ht_cap: HT capabilities in this band
473 * @vht_cap: VHT capabilities in this band
474 * @s1g_cap: S1G capabilities in this band
475 * @edmg_cap: EDMG capabilities in this band
476 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
477 * @n_iftype_data: number of iftype data entries
478 * @iftype_data: interface type data entries. Note that the bits in
479 * @types_mask inside this structure cannot overlap (i.e. only
480 * one occurrence of each type is allowed across all instances of
483 struct ieee80211_supported_band {
484 struct ieee80211_channel *channels;
485 struct ieee80211_rate *bitrates;
486 enum nl80211_band band;
489 struct ieee80211_sta_ht_cap ht_cap;
490 struct ieee80211_sta_vht_cap vht_cap;
491 struct ieee80211_sta_s1g_cap s1g_cap;
492 struct ieee80211_edmg edmg_cap;
494 const struct ieee80211_sband_iftype_data *iftype_data;
498 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
499 * @sband: the sband to search for the STA on
500 * @iftype: enum nl80211_iftype
502 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
504 static inline const struct ieee80211_sband_iftype_data *
505 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
510 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
513 for (i = 0; i < sband->n_iftype_data; i++) {
514 const struct ieee80211_sband_iftype_data *data =
515 &sband->iftype_data[i];
517 if (data->types_mask & BIT(iftype))
525 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
526 * @sband: the sband to search for the iftype on
527 * @iftype: enum nl80211_iftype
529 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
531 static inline const struct ieee80211_sta_he_cap *
532 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
535 const struct ieee80211_sband_iftype_data *data =
536 ieee80211_get_sband_iftype_data(sband, iftype);
538 if (data && data->he_cap.has_he)
539 return &data->he_cap;
545 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
546 * @sband: the sband to search for the STA on
547 * @iftype: the iftype to search for
549 * Return: the 6GHz capabilities
552 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
553 enum nl80211_iftype iftype)
555 const struct ieee80211_sband_iftype_data *data =
556 ieee80211_get_sband_iftype_data(sband, iftype);
558 if (WARN_ON(!data || !data->he_cap.has_he))
561 return data->he_6ghz_capa.capa;
565 * wiphy_read_of_freq_limits - read frequency limits from device tree
567 * @wiphy: the wireless device to get extra limits for
569 * Some devices may have extra limitations specified in DT. This may be useful
570 * for chipsets that normally support more bands but are limited due to board
571 * design (e.g. by antennas or external power amplifier).
573 * This function reads info from DT and uses it to *modify* channels (disable
574 * unavailable ones). It's usually a *bad* idea to use it in drivers with
575 * shared channel data as DT limitations are device specific. You should make
576 * sure to call it only if channels in wiphy are copied and can be modified
577 * without affecting other devices.
579 * As this function access device node it has to be called after set_wiphy_dev.
580 * It also modifies channels so they have to be set first.
581 * If using this helper, call it before wiphy_register().
584 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
585 #else /* CONFIG_OF */
586 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
589 #endif /* !CONFIG_OF */
593 * Wireless hardware/device configuration structures and methods
597 * DOC: Actions and configuration
599 * Each wireless device and each virtual interface offer a set of configuration
600 * operations and other actions that are invoked by userspace. Each of these
601 * actions is described in the operations structure, and the parameters these
602 * operations use are described separately.
604 * Additionally, some operations are asynchronous and expect to get status
605 * information via some functions that drivers need to call.
607 * Scanning and BSS list handling with its associated functionality is described
608 * in a separate chapter.
611 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
612 WLAN_USER_POSITION_LEN)
615 * struct vif_params - describes virtual interface parameters
616 * @flags: monitor interface flags, unchanged if 0, otherwise
617 * %MONITOR_FLAG_CHANGED will be set
618 * @use_4addr: use 4-address frames
619 * @macaddr: address to use for this virtual interface.
620 * If this parameter is set to zero address the driver may
621 * determine the address as needed.
622 * This feature is only fully supported by drivers that enable the
623 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
624 ** only p2p devices with specified MAC.
625 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
626 * belonging to that MU-MIMO groupID; %NULL if not changed
627 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
628 * MU-MIMO packets going to the specified station; %NULL if not changed
633 u8 macaddr[ETH_ALEN];
634 const u8 *vht_mumimo_groups;
635 const u8 *vht_mumimo_follow_addr;
639 * struct key_params - key information
641 * Information about a key
644 * @key_len: length of key material
645 * @cipher: cipher suite selector
646 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
647 * with the get_key() callback, must be in little endian,
648 * length given by @seq_len.
649 * @seq_len: length of @seq.
650 * @vlan_id: vlan_id for VLAN group key (if nonzero)
651 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
660 enum nl80211_key_mode mode;
664 * struct cfg80211_chan_def - channel definition
665 * @chan: the (control) channel
666 * @width: channel width
667 * @center_freq1: center frequency of first segment
668 * @center_freq2: center frequency of second segment
669 * (only with 80+80 MHz)
670 * @edmg: define the EDMG channels configuration.
671 * If edmg is requested (i.e. the .channels member is non-zero),
672 * chan will define the primary channel and all other
673 * parameters are ignored.
674 * @freq1_offset: offset from @center_freq1, in KHz
676 struct cfg80211_chan_def {
677 struct ieee80211_channel *chan;
678 enum nl80211_chan_width width;
681 struct ieee80211_edmg edmg;
686 * cfg80211_bitrate_mask - masks for bitrate control
688 struct cfg80211_bitrate_mask {
691 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
692 u16 vht_mcs[NL80211_VHT_NSS_MAX];
693 u16 he_mcs[NL80211_HE_NSS_MAX];
694 enum nl80211_txrate_gi gi;
695 enum nl80211_he_gi he_gi;
696 enum nl80211_he_ltf he_ltf;
697 } control[NUM_NL80211_BANDS];
702 * struct cfg80211_tid_cfg - TID specific configuration
703 * @config_override: Flag to notify driver to reset TID configuration
705 * @tids: bitmap of TIDs to modify
706 * @mask: bitmap of attributes indicating which parameter changed,
707 * similar to &nl80211_tid_config_supp.
708 * @noack: noack configuration value for the TID
709 * @retry_long: retry count value
710 * @retry_short: retry count value
711 * @ampdu: Enable/Disable MPDU aggregation
712 * @rtscts: Enable/Disable RTS/CTS
713 * @amsdu: Enable/Disable MSDU aggregation
714 * @txrate_type: Tx bitrate mask type
715 * @txrate_mask: Tx bitrate to be applied for the TID
717 struct cfg80211_tid_cfg {
718 bool config_override;
721 enum nl80211_tid_config noack;
722 u8 retry_long, retry_short;
723 enum nl80211_tid_config ampdu;
724 enum nl80211_tid_config rtscts;
725 enum nl80211_tid_config amsdu;
726 enum nl80211_tx_rate_setting txrate_type;
727 struct cfg80211_bitrate_mask txrate_mask;
731 * struct cfg80211_tid_config - TID configuration
732 * @peer: Station's MAC address
733 * @n_tid_conf: Number of TID specific configurations to be applied
734 * @tid_conf: Configuration change info
736 struct cfg80211_tid_config {
739 struct cfg80211_tid_cfg tid_conf[];
743 * struct cfg80211_fils_aad - FILS AAD data
744 * @macaddr: STA MAC address
746 * @kek_len: FILS KEK length
750 struct cfg80211_fils_aad {
759 * cfg80211_get_chandef_type - return old channel type from chandef
760 * @chandef: the channel definition
762 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
763 * chandef, which must have a bandwidth allowing this conversion.
765 static inline enum nl80211_channel_type
766 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
768 switch (chandef->width) {
769 case NL80211_CHAN_WIDTH_20_NOHT:
770 return NL80211_CHAN_NO_HT;
771 case NL80211_CHAN_WIDTH_20:
772 return NL80211_CHAN_HT20;
773 case NL80211_CHAN_WIDTH_40:
774 if (chandef->center_freq1 > chandef->chan->center_freq)
775 return NL80211_CHAN_HT40PLUS;
776 return NL80211_CHAN_HT40MINUS;
779 return NL80211_CHAN_NO_HT;
784 * cfg80211_chandef_create - create channel definition using channel type
785 * @chandef: the channel definition struct to fill
786 * @channel: the control channel
787 * @chantype: the channel type
789 * Given a channel type, create a channel definition.
791 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
792 struct ieee80211_channel *channel,
793 enum nl80211_channel_type chantype);
796 * cfg80211_chandef_identical - check if two channel definitions are identical
797 * @chandef1: first channel definition
798 * @chandef2: second channel definition
800 * Return: %true if the channels defined by the channel definitions are
801 * identical, %false otherwise.
804 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
805 const struct cfg80211_chan_def *chandef2)
807 return (chandef1->chan == chandef2->chan &&
808 chandef1->width == chandef2->width &&
809 chandef1->center_freq1 == chandef2->center_freq1 &&
810 chandef1->freq1_offset == chandef2->freq1_offset &&
811 chandef1->center_freq2 == chandef2->center_freq2);
815 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
817 * @chandef: the channel definition
819 * Return: %true if EDMG defined, %false otherwise.
822 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
824 return chandef->edmg.channels || chandef->edmg.bw_config;
828 * cfg80211_chandef_compatible - check if two channel definitions are compatible
829 * @chandef1: first channel definition
830 * @chandef2: second channel definition
832 * Return: %NULL if the given channel definitions are incompatible,
833 * chandef1 or chandef2 otherwise.
835 const struct cfg80211_chan_def *
836 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
837 const struct cfg80211_chan_def *chandef2);
840 * cfg80211_chandef_valid - check if a channel definition is valid
841 * @chandef: the channel definition to check
842 * Return: %true if the channel definition is valid. %false otherwise.
844 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
847 * cfg80211_chandef_usable - check if secondary channels can be used
848 * @wiphy: the wiphy to validate against
849 * @chandef: the channel definition to check
850 * @prohibited_flags: the regulatory channel flags that must not be set
851 * Return: %true if secondary channels are usable. %false otherwise.
853 bool cfg80211_chandef_usable(struct wiphy *wiphy,
854 const struct cfg80211_chan_def *chandef,
855 u32 prohibited_flags);
858 * cfg80211_chandef_dfs_required - checks if radar detection is required
859 * @wiphy: the wiphy to validate against
860 * @chandef: the channel definition to check
861 * @iftype: the interface type as specified in &enum nl80211_iftype
863 * 1 if radar detection is required, 0 if it is not, < 0 on error
865 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
866 const struct cfg80211_chan_def *chandef,
867 enum nl80211_iftype iftype);
870 * ieee80211_chandef_rate_flags - returns rate flags for a channel
872 * In some channel types, not all rates may be used - for example CCK
873 * rates may not be used in 5/10 MHz channels.
875 * @chandef: channel definition for the channel
877 * Returns: rate flags which apply for this channel
879 static inline enum ieee80211_rate_flags
880 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
882 switch (chandef->width) {
883 case NL80211_CHAN_WIDTH_5:
884 return IEEE80211_RATE_SUPPORTS_5MHZ;
885 case NL80211_CHAN_WIDTH_10:
886 return IEEE80211_RATE_SUPPORTS_10MHZ;
894 * ieee80211_chandef_max_power - maximum transmission power for the chandef
896 * In some regulations, the transmit power may depend on the configured channel
897 * bandwidth which may be defined as dBm/MHz. This function returns the actual
898 * max_power for non-standard (20 MHz) channels.
900 * @chandef: channel definition for the channel
902 * Returns: maximum allowed transmission power in dBm for the chandef
905 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
907 switch (chandef->width) {
908 case NL80211_CHAN_WIDTH_5:
909 return min(chandef->chan->max_reg_power - 6,
910 chandef->chan->max_power);
911 case NL80211_CHAN_WIDTH_10:
912 return min(chandef->chan->max_reg_power - 3,
913 chandef->chan->max_power);
917 return chandef->chan->max_power;
921 * cfg80211_any_usable_channels - check for usable channels
922 * @wiphy: the wiphy to check for
923 * @band_mask: which bands to check on
924 * @prohibited_flags: which channels to not consider usable,
925 * %IEEE80211_CHAN_DISABLED is always taken into account
927 bool cfg80211_any_usable_channels(struct wiphy *wiphy,
928 unsigned long band_mask,
929 u32 prohibited_flags);
932 * enum survey_info_flags - survey information flags
934 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
935 * @SURVEY_INFO_IN_USE: channel is currently being used
936 * @SURVEY_INFO_TIME: active time (in ms) was filled in
937 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
938 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
939 * @SURVEY_INFO_TIME_RX: receive time was filled in
940 * @SURVEY_INFO_TIME_TX: transmit time was filled in
941 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
942 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
944 * Used by the driver to indicate which info in &struct survey_info
945 * it has filled in during the get_survey().
947 enum survey_info_flags {
948 SURVEY_INFO_NOISE_DBM = BIT(0),
949 SURVEY_INFO_IN_USE = BIT(1),
950 SURVEY_INFO_TIME = BIT(2),
951 SURVEY_INFO_TIME_BUSY = BIT(3),
952 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
953 SURVEY_INFO_TIME_RX = BIT(5),
954 SURVEY_INFO_TIME_TX = BIT(6),
955 SURVEY_INFO_TIME_SCAN = BIT(7),
956 SURVEY_INFO_TIME_BSS_RX = BIT(8),
960 * struct survey_info - channel survey response
962 * @channel: the channel this survey record reports, may be %NULL for a single
963 * record to report global statistics
964 * @filled: bitflag of flags from &enum survey_info_flags
965 * @noise: channel noise in dBm. This and all following fields are
967 * @time: amount of time in ms the radio was turn on (on the channel)
968 * @time_busy: amount of time the primary channel was sensed busy
969 * @time_ext_busy: amount of time the extension channel was sensed busy
970 * @time_rx: amount of time the radio spent receiving data
971 * @time_tx: amount of time the radio spent transmitting data
972 * @time_scan: amount of time the radio spent for scanning
973 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
975 * Used by dump_survey() to report back per-channel survey information.
977 * This structure can later be expanded with things like
978 * channel duty cycle etc.
981 struct ieee80211_channel *channel;
993 #define CFG80211_MAX_WEP_KEYS 4
996 * struct cfg80211_crypto_settings - Crypto settings
997 * @wpa_versions: indicates which, if any, WPA versions are enabled
998 * (from enum nl80211_wpa_versions)
999 * @cipher_group: group key cipher suite (or 0 if unset)
1000 * @n_ciphers_pairwise: number of AP supported unicast ciphers
1001 * @ciphers_pairwise: unicast key cipher suites
1002 * @n_akm_suites: number of AKM suites
1003 * @akm_suites: AKM suites
1004 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
1005 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1006 * required to assume that the port is unauthorized until authorized by
1007 * user space. Otherwise, port is marked authorized by default.
1008 * @control_port_ethertype: the control port protocol that should be
1009 * allowed through even on unauthorized ports
1010 * @control_port_no_encrypt: TRUE to prevent encryption of control port
1012 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1013 * port frames over NL80211 instead of the network interface.
1014 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
1016 * @wep_keys: static WEP keys, if not NULL points to an array of
1017 * CFG80211_MAX_WEP_KEYS WEP keys
1018 * @wep_tx_key: key index (0..3) of the default TX static WEP key
1019 * @psk: PSK (for devices supporting 4-way-handshake offload)
1020 * @sae_pwd: password for SAE authentication (for devices supporting SAE
1022 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1023 * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
1025 * NL80211_SAE_PWE_UNSPECIFIED
1026 * Not-specified, used to indicate userspace did not specify any
1027 * preference. The driver should follow its internal policy in
1030 * NL80211_SAE_PWE_HUNT_AND_PECK
1031 * Allow hunting-and-pecking loop only
1033 * NL80211_SAE_PWE_HASH_TO_ELEMENT
1034 * Allow hash-to-element only
1036 * NL80211_SAE_PWE_BOTH
1037 * Allow either hunting-and-pecking loop or hash-to-element
1039 struct cfg80211_crypto_settings {
1042 int n_ciphers_pairwise;
1043 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1045 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
1047 __be16 control_port_ethertype;
1048 bool control_port_no_encrypt;
1049 bool control_port_over_nl80211;
1050 bool control_port_no_preauth;
1051 struct key_params *wep_keys;
1056 enum nl80211_sae_pwe_mechanism sae_pwe;
1060 * struct cfg80211_mbssid_config - AP settings for multi bssid
1062 * @tx_wdev: pointer to the transmitted interface in the MBSSID set
1063 * @index: index of this AP in the multi bssid group.
1064 * @ema: set to true if the beacons should be sent out in EMA mode.
1066 struct cfg80211_mbssid_config {
1067 struct wireless_dev *tx_wdev;
1073 * struct cfg80211_mbssid_elems - Multiple BSSID elements
1075 * @cnt: Number of elements in array %elems.
1077 * @elem: Array of multiple BSSID element(s) to be added into Beacon frames.
1078 * @elem.data: Data for multiple BSSID elements.
1079 * @elem.len: Length of data.
1081 struct cfg80211_mbssid_elems {
1090 * struct cfg80211_beacon_data - beacon data
1091 * @head: head portion of beacon (before TIM IE)
1092 * or %NULL if not changed
1093 * @tail: tail portion of beacon (after TIM IE)
1094 * or %NULL if not changed
1095 * @head_len: length of @head
1096 * @tail_len: length of @tail
1097 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1098 * @beacon_ies_len: length of beacon_ies in octets
1099 * @proberesp_ies: extra information element(s) to add into Probe Response
1101 * @proberesp_ies_len: length of proberesp_ies in octets
1102 * @assocresp_ies: extra information element(s) to add into (Re)Association
1103 * Response frames or %NULL
1104 * @assocresp_ies_len: length of assocresp_ies in octets
1105 * @probe_resp_len: length of probe response template (@probe_resp)
1106 * @probe_resp: probe response template (AP mode only)
1107 * @mbssid_ies: multiple BSSID elements
1108 * @ftm_responder: enable FTM responder functionality; -1 for no change
1109 * (which also implies no change in LCI/civic location data)
1110 * @lci: Measurement Report element content, starting with Measurement Token
1111 * (measurement type 8)
1112 * @civicloc: Measurement Report element content, starting with Measurement
1113 * Token (measurement type 11)
1114 * @lci_len: LCI data length
1115 * @civicloc_len: Civic location data length
1117 struct cfg80211_beacon_data {
1118 const u8 *head, *tail;
1119 const u8 *beacon_ies;
1120 const u8 *proberesp_ies;
1121 const u8 *assocresp_ies;
1122 const u8 *probe_resp;
1125 struct cfg80211_mbssid_elems *mbssid_ies;
1128 size_t head_len, tail_len;
1129 size_t beacon_ies_len;
1130 size_t proberesp_ies_len;
1131 size_t assocresp_ies_len;
1132 size_t probe_resp_len;
1134 size_t civicloc_len;
1137 struct mac_address {
1142 * struct cfg80211_acl_data - Access control list data
1144 * @acl_policy: ACL policy to be applied on the station's
1145 * entry specified by mac_addr
1146 * @n_acl_entries: Number of MAC address entries passed
1147 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1149 struct cfg80211_acl_data {
1150 enum nl80211_acl_policy acl_policy;
1154 struct mac_address mac_addrs[];
1158 * struct cfg80211_fils_discovery - FILS discovery parameters from
1159 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1161 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1162 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1163 * @tmpl_len: Template length
1164 * @tmpl: Template data for FILS discovery frame including the action
1167 struct cfg80211_fils_discovery {
1175 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1176 * response parameters in 6GHz.
1178 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1179 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1181 * @tmpl_len: Template length
1182 * @tmpl: Template data for probe response
1184 struct cfg80211_unsol_bcast_probe_resp {
1191 * enum cfg80211_ap_settings_flags - AP settings flags
1193 * Used by cfg80211_ap_settings
1195 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
1197 enum cfg80211_ap_settings_flags {
1198 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
1202 * struct cfg80211_ap_settings - AP configuration
1204 * Used to configure an AP interface.
1206 * @chandef: defines the channel to use
1207 * @beacon: beacon data
1208 * @beacon_interval: beacon interval
1209 * @dtim_period: DTIM period
1210 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1212 * @ssid_len: length of @ssid
1213 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1214 * @crypto: crypto settings
1215 * @privacy: the BSS uses privacy
1216 * @auth_type: Authentication type (algorithm)
1217 * @smps_mode: SMPS mode
1218 * @inactivity_timeout: time in seconds to determine station's inactivity.
1219 * @p2p_ctwindow: P2P CT Window
1220 * @p2p_opp_ps: P2P opportunistic PS
1221 * @acl: ACL configuration used by the drivers which has support for
1222 * MAC address based access control
1223 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1225 * @beacon_rate: bitrate to be used for beacons
1226 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1227 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1228 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1229 * @ht_required: stations must support HT
1230 * @vht_required: stations must support VHT
1231 * @twt_responder: Enable Target Wait Time
1232 * @he_required: stations must support HE
1233 * @sae_h2e_required: stations must support direct H2E technique in SAE
1234 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1235 * @he_obss_pd: OBSS Packet Detection settings
1236 * @he_bss_color: BSS Color settings
1237 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1238 * @fils_discovery: FILS discovery transmission parameters
1239 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1240 * @mbssid_config: AP settings for multiple bssid
1242 struct cfg80211_ap_settings {
1243 struct cfg80211_chan_def chandef;
1245 struct cfg80211_beacon_data beacon;
1247 int beacon_interval, dtim_period;
1250 enum nl80211_hidden_ssid hidden_ssid;
1251 struct cfg80211_crypto_settings crypto;
1253 enum nl80211_auth_type auth_type;
1254 enum nl80211_smps_mode smps_mode;
1255 int inactivity_timeout;
1258 const struct cfg80211_acl_data *acl;
1260 struct cfg80211_bitrate_mask beacon_rate;
1262 const struct ieee80211_ht_cap *ht_cap;
1263 const struct ieee80211_vht_cap *vht_cap;
1264 const struct ieee80211_he_cap_elem *he_cap;
1265 const struct ieee80211_he_operation *he_oper;
1266 bool ht_required, vht_required, he_required, sae_h2e_required;
1269 struct ieee80211_he_obss_pd he_obss_pd;
1270 struct cfg80211_he_bss_color he_bss_color;
1271 struct cfg80211_fils_discovery fils_discovery;
1272 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1273 struct cfg80211_mbssid_config mbssid_config;
1277 * struct cfg80211_csa_settings - channel switch settings
1279 * Used for channel switch
1281 * @chandef: defines the channel to use after the switch
1282 * @beacon_csa: beacon data while performing the switch
1283 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1284 * @counter_offsets_presp: offsets of the counters within the probe response
1285 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1286 * @n_counter_offsets_presp: number of csa counters in the probe response
1287 * @beacon_after: beacon data to be used on the new channel
1288 * @radar_required: whether radar detection is required on the new channel
1289 * @block_tx: whether transmissions should be blocked while changing
1290 * @count: number of beacons until switch
1292 struct cfg80211_csa_settings {
1293 struct cfg80211_chan_def chandef;
1294 struct cfg80211_beacon_data beacon_csa;
1295 const u16 *counter_offsets_beacon;
1296 const u16 *counter_offsets_presp;
1297 unsigned int n_counter_offsets_beacon;
1298 unsigned int n_counter_offsets_presp;
1299 struct cfg80211_beacon_data beacon_after;
1300 bool radar_required;
1306 * struct cfg80211_color_change_settings - color change settings
1308 * Used for bss color change
1310 * @beacon_color_change: beacon data while performing the color countdown
1311 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1312 * @counter_offsets_presp: offsets of the counters within the probe response
1313 * @beacon_next: beacon data to be used after the color change
1314 * @count: number of beacons until the color change
1315 * @color: the color used after the change
1317 struct cfg80211_color_change_settings {
1318 struct cfg80211_beacon_data beacon_color_change;
1319 u16 counter_offset_beacon;
1320 u16 counter_offset_presp;
1321 struct cfg80211_beacon_data beacon_next;
1327 * struct iface_combination_params - input parameters for interface combinations
1329 * Used to pass interface combination parameters
1331 * @num_different_channels: the number of different channels we want
1332 * to use for verification
1333 * @radar_detect: a bitmap where each bit corresponds to a channel
1334 * width where radar detection is needed, as in the definition of
1335 * &struct ieee80211_iface_combination.@radar_detect_widths
1336 * @iftype_num: array with the number of interfaces of each interface
1337 * type. The index is the interface type as specified in &enum
1339 * @new_beacon_int: set this to the beacon interval of a new interface
1340 * that's not operating yet, if such is to be checked as part of
1343 struct iface_combination_params {
1344 int num_different_channels;
1346 int iftype_num[NUM_NL80211_IFTYPES];
1351 * enum station_parameters_apply_mask - station parameter values to apply
1352 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1353 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1354 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1356 * Not all station parameters have in-band "no change" signalling,
1357 * for those that don't these flags will are used.
1359 enum station_parameters_apply_mask {
1360 STATION_PARAM_APPLY_UAPSD = BIT(0),
1361 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1362 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1363 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1367 * struct sta_txpwr - station txpower configuration
1369 * Used to configure txpower for station.
1371 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1372 * is not provided, the default per-interface tx power setting will be
1373 * overriding. Driver should be picking up the lowest tx power, either tx
1374 * power per-interface or per-station.
1375 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1376 * will be less than or equal to specified from userspace, whereas if TPC
1377 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1378 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1383 enum nl80211_tx_power_setting type;
1387 * struct station_parameters - station parameters
1389 * Used to change and create a new station.
1391 * @vlan: vlan interface station should belong to
1392 * @supported_rates: supported rates in IEEE 802.11 format
1393 * (or NULL for no change)
1394 * @supported_rates_len: number of supported rates
1395 * @sta_flags_mask: station flags that changed
1396 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1397 * @sta_flags_set: station flags values
1398 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1399 * @listen_interval: listen interval or -1 for no change
1400 * @aid: AID or zero for no change
1401 * @vlan_id: VLAN ID for station (if nonzero)
1402 * @peer_aid: mesh peer AID or zero for no change
1403 * @plink_action: plink action to take
1404 * @plink_state: set the peer link state for a station
1405 * @ht_capa: HT capabilities of station
1406 * @vht_capa: VHT capabilities of station
1407 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1408 * as the AC bitmap in the QoS info field
1409 * @max_sp: max Service Period. same format as the MAX_SP in the
1410 * QoS info field (but already shifted down)
1411 * @sta_modify_mask: bitmap indicating which parameters changed
1412 * (for those that don't have a natural "no change" value),
1413 * see &enum station_parameters_apply_mask
1414 * @local_pm: local link-specific mesh power save mode (no change when set
1416 * @capability: station capability
1417 * @ext_capab: extended capabilities of the station
1418 * @ext_capab_len: number of extended capabilities
1419 * @supported_channels: supported channels in IEEE 802.11 format
1420 * @supported_channels_len: number of supported channels
1421 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1422 * @supported_oper_classes_len: number of supported operating classes
1423 * @opmode_notif: operating mode field from Operating Mode Notification
1424 * @opmode_notif_used: information if operating mode field is used
1425 * @support_p2p_ps: information if station supports P2P PS mechanism
1426 * @he_capa: HE capabilities of station
1427 * @he_capa_len: the length of the HE capabilities
1428 * @airtime_weight: airtime scheduler weight for this station
1429 * @txpwr: transmit power for an associated station
1430 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1432 struct station_parameters {
1433 const u8 *supported_rates;
1434 struct net_device *vlan;
1435 u32 sta_flags_mask, sta_flags_set;
1436 u32 sta_modify_mask;
1437 int listen_interval;
1441 u8 supported_rates_len;
1444 const struct ieee80211_ht_cap *ht_capa;
1445 const struct ieee80211_vht_cap *vht_capa;
1448 enum nl80211_mesh_power_mode local_pm;
1450 const u8 *ext_capab;
1452 const u8 *supported_channels;
1453 u8 supported_channels_len;
1454 const u8 *supported_oper_classes;
1455 u8 supported_oper_classes_len;
1457 bool opmode_notif_used;
1459 const struct ieee80211_he_cap_elem *he_capa;
1462 struct sta_txpwr txpwr;
1463 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1467 * struct station_del_parameters - station deletion parameters
1469 * Used to delete a station entry (or all stations).
1471 * @mac: MAC address of the station to remove or NULL to remove all stations
1472 * @subtype: Management frame subtype to use for indicating removal
1473 * (10 = Disassociation, 12 = Deauthentication)
1474 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1476 struct station_del_parameters {
1483 * enum cfg80211_station_type - the type of station being modified
1484 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1485 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1486 * unassociated (update properties for this type of client is permitted)
1487 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1488 * the AP MLME in the device
1489 * @CFG80211_STA_AP_STA: AP station on managed interface
1490 * @CFG80211_STA_IBSS: IBSS station
1491 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1492 * while TDLS setup is in progress, it moves out of this state when
1493 * being marked authorized; use this only if TDLS with external setup is
1495 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1496 * entry that is operating, has been marked authorized by userspace)
1497 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1498 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1500 enum cfg80211_station_type {
1501 CFG80211_STA_AP_CLIENT,
1502 CFG80211_STA_AP_CLIENT_UNASSOC,
1503 CFG80211_STA_AP_MLME_CLIENT,
1504 CFG80211_STA_AP_STA,
1506 CFG80211_STA_TDLS_PEER_SETUP,
1507 CFG80211_STA_TDLS_PEER_ACTIVE,
1508 CFG80211_STA_MESH_PEER_KERNEL,
1509 CFG80211_STA_MESH_PEER_USER,
1513 * cfg80211_check_station_change - validate parameter changes
1514 * @wiphy: the wiphy this operates on
1515 * @params: the new parameters for a station
1516 * @statype: the type of station being modified
1518 * Utility function for the @change_station driver method. Call this function
1519 * with the appropriate station type looking up the station (and checking that
1520 * it exists). It will verify whether the station change is acceptable, and if
1521 * not will return an error code. Note that it may modify the parameters for
1522 * backward compatibility reasons, so don't use them before calling this.
1524 int cfg80211_check_station_change(struct wiphy *wiphy,
1525 struct station_parameters *params,
1526 enum cfg80211_station_type statype);
1529 * enum rate_info_flags - bitrate info flags
1531 * Used by the driver to indicate the specific rate transmission
1532 * type for 802.11n transmissions.
1534 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1535 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1536 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1537 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1538 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1539 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1540 * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS
1542 enum rate_info_flags {
1543 RATE_INFO_FLAGS_MCS = BIT(0),
1544 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1545 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1546 RATE_INFO_FLAGS_DMG = BIT(3),
1547 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1548 RATE_INFO_FLAGS_EDMG = BIT(5),
1549 RATE_INFO_FLAGS_EXTENDED_SC_DMG = BIT(6),
1553 * enum rate_info_bw - rate bandwidth information
1555 * Used by the driver to indicate the rate bandwidth.
1557 * @RATE_INFO_BW_5: 5 MHz bandwidth
1558 * @RATE_INFO_BW_10: 10 MHz bandwidth
1559 * @RATE_INFO_BW_20: 20 MHz bandwidth
1560 * @RATE_INFO_BW_40: 40 MHz bandwidth
1561 * @RATE_INFO_BW_80: 80 MHz bandwidth
1562 * @RATE_INFO_BW_160: 160 MHz bandwidth
1563 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1566 RATE_INFO_BW_20 = 0,
1576 * struct rate_info - bitrate information
1578 * Information about a receiving or transmitting bitrate
1580 * @flags: bitflag of flags from &enum rate_info_flags
1581 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1582 * @legacy: bitrate in 100kbit/s for 802.11abg
1583 * @nss: number of streams (VHT & HE only)
1584 * @bw: bandwidth (from &enum rate_info_bw)
1585 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1586 * @he_dcm: HE DCM value
1587 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1588 * only valid if bw is %RATE_INFO_BW_HE_RU)
1589 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1604 * enum bss_param_flags - bitrate info flags
1606 * Used by the driver to indicate the specific rate transmission
1607 * type for 802.11n transmissions.
1609 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1610 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1611 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1613 enum bss_param_flags {
1614 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1615 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1616 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1620 * struct sta_bss_parameters - BSS parameters for the attached station
1622 * Information about the currently associated BSS
1624 * @flags: bitflag of flags from &enum bss_param_flags
1625 * @dtim_period: DTIM period for the BSS
1626 * @beacon_interval: beacon interval
1628 struct sta_bss_parameters {
1631 u16 beacon_interval;
1635 * struct cfg80211_txq_stats - TXQ statistics for this TID
1636 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1637 * indicate the relevant values in this struct are filled
1638 * @backlog_bytes: total number of bytes currently backlogged
1639 * @backlog_packets: total number of packets currently backlogged
1640 * @flows: number of new flows seen
1641 * @drops: total number of packets dropped
1642 * @ecn_marks: total number of packets marked with ECN CE
1643 * @overlimit: number of drops due to queue space overflow
1644 * @overmemory: number of drops due to memory limit overflow
1645 * @collisions: number of hash collisions
1646 * @tx_bytes: total number of bytes dequeued
1647 * @tx_packets: total number of packets dequeued
1648 * @max_flows: maximum number of flows supported
1650 struct cfg80211_txq_stats {
1653 u32 backlog_packets;
1666 * struct cfg80211_tid_stats - per-TID statistics
1667 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1668 * indicate the relevant values in this struct are filled
1669 * @rx_msdu: number of received MSDUs
1670 * @tx_msdu: number of (attempted) transmitted MSDUs
1671 * @tx_msdu_retries: number of retries (not counting the first) for
1673 * @tx_msdu_failed: number of failed transmitted MSDUs
1674 * @txq_stats: TXQ statistics
1676 struct cfg80211_tid_stats {
1680 u64 tx_msdu_retries;
1682 struct cfg80211_txq_stats txq_stats;
1685 #define IEEE80211_MAX_CHAINS 4
1688 * struct station_info - station information
1690 * Station information filled by driver for get_station() and dump_station.
1692 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1693 * indicate the relevant values in this struct for them
1694 * @connected_time: time(in secs) since a station is last connected
1695 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1696 * @assoc_at: bootime (ns) of the last association
1697 * @rx_bytes: bytes (size of MPDUs) received from this station
1698 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1699 * @llid: mesh local link id
1700 * @plid: mesh peer link id
1701 * @plink_state: mesh peer link state
1702 * @signal: The signal strength, type depends on the wiphy's signal_type.
1703 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1704 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1705 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1706 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1707 * @chain_signal: per-chain signal strength of last received packet in dBm
1708 * @chain_signal_avg: per-chain signal strength average in dBm
1709 * @txrate: current unicast bitrate from this station
1710 * @rxrate: current unicast bitrate to this station
1711 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1712 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1713 * @tx_retries: cumulative retry counts (MPDUs)
1714 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1715 * @rx_dropped_misc: Dropped for un-specified reason.
1716 * @bss_param: current BSS parameters
1717 * @generation: generation number for nl80211 dumps.
1718 * This number should increase every time the list of stations
1719 * changes, i.e. when a station is added or removed, so that
1720 * userspace can tell whether it got a consistent snapshot.
1721 * @assoc_req_ies: IEs from (Re)Association Request.
1722 * This is used only when in AP mode with drivers that do not use
1723 * user space MLME/SME implementation. The information is provided for
1724 * the cfg80211_new_sta() calls to notify user space of the IEs.
1725 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1726 * @sta_flags: station flags mask & values
1727 * @beacon_loss_count: Number of times beacon loss event has triggered.
1728 * @t_offset: Time offset of the station relative to this host.
1729 * @local_pm: local mesh STA power save mode
1730 * @peer_pm: peer mesh STA power save mode
1731 * @nonpeer_pm: non-peer mesh STA power save mode
1732 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1733 * towards this station.
1734 * @rx_beacon: number of beacons received from this peer
1735 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1737 * @connected_to_gate: true if mesh STA has a path to mesh gate
1738 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1739 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1740 * @airtime_weight: current airtime scheduling weight
1741 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1742 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1743 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1744 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1745 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1747 * @rx_mpdu_count: number of MPDUs received from this station
1748 * @fcs_err_count: number of packets (MPDUs) received from this station with
1749 * an FCS error. This counter should be incremented only when TA of the
1750 * received packet with an FCS error matches the peer MAC address.
1751 * @airtime_link_metric: mesh airtime link metric.
1752 * @connected_to_as: true if mesh STA has a path to authentication server
1754 struct station_info {
1768 s8 chain_signal[IEEE80211_MAX_CHAINS];
1769 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1771 struct rate_info txrate;
1772 struct rate_info rxrate;
1777 u32 rx_dropped_misc;
1778 struct sta_bss_parameters bss_param;
1779 struct nl80211_sta_flag_update sta_flags;
1783 const u8 *assoc_req_ies;
1784 size_t assoc_req_ies_len;
1786 u32 beacon_loss_count;
1788 enum nl80211_mesh_power_mode local_pm;
1789 enum nl80211_mesh_power_mode peer_pm;
1790 enum nl80211_mesh_power_mode nonpeer_pm;
1792 u32 expected_throughput;
1797 u8 rx_beacon_signal_avg;
1798 u8 connected_to_gate;
1800 struct cfg80211_tid_stats *pertid;
1809 u32 airtime_link_metric;
1815 * struct cfg80211_sar_sub_specs - sub specs limit
1816 * @power: power limitation in 0.25dbm
1817 * @freq_range_index: index the power limitation applies to
1819 struct cfg80211_sar_sub_specs {
1821 u32 freq_range_index;
1825 * struct cfg80211_sar_specs - sar limit specs
1826 * @type: it's set with power in 0.25dbm or other types
1827 * @num_sub_specs: number of sar sub specs
1828 * @sub_specs: memory to hold the sar sub specs
1830 struct cfg80211_sar_specs {
1831 enum nl80211_sar_type type;
1833 struct cfg80211_sar_sub_specs sub_specs[];
1838 * struct cfg80211_sar_freq_ranges - sar frequency ranges
1839 * @start_freq: start range edge frequency
1840 * @end_freq: end range edge frequency
1842 struct cfg80211_sar_freq_ranges {
1848 * struct cfg80211_sar_capa - sar limit capability
1849 * @type: it's set via power in 0.25dbm or other types
1850 * @num_freq_ranges: number of frequency ranges
1851 * @freq_ranges: memory to hold the freq ranges.
1853 * Note: WLAN driver may append new ranges or split an existing
1854 * range to small ones and then append them.
1856 struct cfg80211_sar_capa {
1857 enum nl80211_sar_type type;
1858 u32 num_freq_ranges;
1859 const struct cfg80211_sar_freq_ranges *freq_ranges;
1862 #if IS_ENABLED(CONFIG_CFG80211)
1864 * cfg80211_get_station - retrieve information about a given station
1865 * @dev: the device where the station is supposed to be connected to
1866 * @mac_addr: the mac address of the station of interest
1867 * @sinfo: pointer to the structure to fill with the information
1869 * Returns 0 on success and sinfo is filled with the available information
1870 * otherwise returns a negative error code and the content of sinfo has to be
1871 * considered undefined.
1873 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1874 struct station_info *sinfo);
1876 static inline int cfg80211_get_station(struct net_device *dev,
1878 struct station_info *sinfo)
1885 * enum monitor_flags - monitor flags
1887 * Monitor interface configuration flags. Note that these must be the bits
1888 * according to the nl80211 flags.
1890 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1891 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1892 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1893 * @MONITOR_FLAG_CONTROL: pass control frames
1894 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1895 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1896 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1898 enum monitor_flags {
1899 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1900 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1901 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1902 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1903 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1904 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1905 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1909 * enum mpath_info_flags - mesh path information flags
1911 * Used by the driver to indicate which info in &struct mpath_info it has filled
1912 * in during get_station() or dump_station().
1914 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1915 * @MPATH_INFO_SN: @sn filled
1916 * @MPATH_INFO_METRIC: @metric filled
1917 * @MPATH_INFO_EXPTIME: @exptime filled
1918 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1919 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1920 * @MPATH_INFO_FLAGS: @flags filled
1921 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1922 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1924 enum mpath_info_flags {
1925 MPATH_INFO_FRAME_QLEN = BIT(0),
1926 MPATH_INFO_SN = BIT(1),
1927 MPATH_INFO_METRIC = BIT(2),
1928 MPATH_INFO_EXPTIME = BIT(3),
1929 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1930 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1931 MPATH_INFO_FLAGS = BIT(6),
1932 MPATH_INFO_HOP_COUNT = BIT(7),
1933 MPATH_INFO_PATH_CHANGE = BIT(8),
1937 * struct mpath_info - mesh path information
1939 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1941 * @filled: bitfield of flags from &enum mpath_info_flags
1942 * @frame_qlen: number of queued frames for this destination
1943 * @sn: target sequence number
1944 * @metric: metric (cost) of this mesh path
1945 * @exptime: expiration time for the mesh path from now, in msecs
1946 * @flags: mesh path flags
1947 * @discovery_timeout: total mesh path discovery timeout, in msecs
1948 * @discovery_retries: mesh path discovery retries
1949 * @generation: generation number for nl80211 dumps.
1950 * This number should increase every time the list of mesh paths
1951 * changes, i.e. when a station is added or removed, so that
1952 * userspace can tell whether it got a consistent snapshot.
1953 * @hop_count: hops to destination
1954 * @path_change_count: total number of path changes to destination
1962 u32 discovery_timeout;
1963 u8 discovery_retries;
1966 u32 path_change_count;
1972 * struct bss_parameters - BSS parameters
1974 * Used to change BSS parameters (mainly for AP mode).
1976 * @use_cts_prot: Whether to use CTS protection
1977 * (0 = no, 1 = yes, -1 = do not change)
1978 * @use_short_preamble: Whether the use of short preambles is allowed
1979 * (0 = no, 1 = yes, -1 = do not change)
1980 * @use_short_slot_time: Whether the use of short slot time is allowed
1981 * (0 = no, 1 = yes, -1 = do not change)
1982 * @basic_rates: basic rates in IEEE 802.11 format
1983 * (or NULL for no change)
1984 * @basic_rates_len: number of basic rates
1985 * @ap_isolate: do not forward packets between connected stations
1986 * (0 = no, 1 = yes, -1 = do not change)
1987 * @ht_opmode: HT Operation mode
1988 * (u16 = opmode, -1 = do not change)
1989 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1990 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1992 struct bss_parameters {
1994 int use_short_preamble;
1995 int use_short_slot_time;
1996 const u8 *basic_rates;
2000 s8 p2p_ctwindow, p2p_opp_ps;
2004 * struct mesh_config - 802.11s mesh configuration
2006 * These parameters can be changed while the mesh is active.
2008 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
2009 * by the Mesh Peering Open message
2010 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
2011 * used by the Mesh Peering Open message
2012 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
2013 * the mesh peering management to close a mesh peering
2014 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
2016 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
2017 * be sent to establish a new peer link instance in a mesh
2018 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
2019 * @element_ttl: the value of TTL field set at a mesh STA for path selection
2021 * @auto_open_plinks: whether we should automatically open peer links when we
2022 * detect compatible mesh peers
2023 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
2024 * synchronize to for 11s default synchronization method
2025 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
2026 * that an originator mesh STA can send to a particular path target
2027 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
2028 * @min_discovery_timeout: the minimum length of time to wait until giving up on
2029 * a path discovery in milliseconds
2030 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
2031 * receiving a PREQ shall consider the forwarding information from the
2032 * root to be valid. (TU = time unit)
2033 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
2034 * which a mesh STA can send only one action frame containing a PREQ
2036 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
2037 * which a mesh STA can send only one Action frame containing a PERR
2039 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
2040 * it takes for an HWMP information element to propagate across the mesh
2041 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
2042 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
2043 * announcements are transmitted
2044 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
2045 * station has access to a broader network beyond the MBSS. (This is
2046 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
2047 * only means that the station will announce others it's a mesh gate, but
2048 * not necessarily using the gate announcement protocol. Still keeping the
2049 * same nomenclature to be in sync with the spec)
2050 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
2051 * entity (default is TRUE - forwarding entity)
2052 * @rssi_threshold: the threshold for average signal strength of candidate
2053 * station to establish a peer link
2054 * @ht_opmode: mesh HT protection mode
2056 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
2057 * receiving a proactive PREQ shall consider the forwarding information to
2058 * the root mesh STA to be valid.
2060 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
2061 * PREQs are transmitted.
2062 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
2063 * during which a mesh STA can send only one Action frame containing
2064 * a PREQ element for root path confirmation.
2065 * @power_mode: The default mesh power save mode which will be the initial
2066 * setting for new peer links.
2067 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
2068 * after transmitting its beacon.
2069 * @plink_timeout: If no tx activity is seen from a STA we've established
2070 * peering with for longer than this time (in seconds), then remove it
2071 * from the STA's list of peers. Default is 30 minutes.
2072 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
2073 * connected to a mesh gate in mesh formation info. If false, the
2074 * value in mesh formation is determined by the presence of root paths
2075 * in the mesh path table
2076 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
2077 * for HWMP) if the destination is a direct neighbor. Note that this might
2078 * not be the optimal decision as a multi-hop route might be better. So
2079 * if using this setting you will likely also want to disable
2080 * dot11MeshForwarding and use another mesh routing protocol on top.
2082 struct mesh_config {
2083 u16 dot11MeshRetryTimeout;
2084 u16 dot11MeshConfirmTimeout;
2085 u16 dot11MeshHoldingTimeout;
2086 u16 dot11MeshMaxPeerLinks;
2087 u8 dot11MeshMaxRetries;
2090 bool auto_open_plinks;
2091 u32 dot11MeshNbrOffsetMaxNeighbor;
2092 u8 dot11MeshHWMPmaxPREQretries;
2093 u32 path_refresh_time;
2094 u16 min_discovery_timeout;
2095 u32 dot11MeshHWMPactivePathTimeout;
2096 u16 dot11MeshHWMPpreqMinInterval;
2097 u16 dot11MeshHWMPperrMinInterval;
2098 u16 dot11MeshHWMPnetDiameterTraversalTime;
2099 u8 dot11MeshHWMPRootMode;
2100 bool dot11MeshConnectedToMeshGate;
2101 bool dot11MeshConnectedToAuthServer;
2102 u16 dot11MeshHWMPRannInterval;
2103 bool dot11MeshGateAnnouncementProtocol;
2104 bool dot11MeshForwarding;
2107 u32 dot11MeshHWMPactivePathToRootTimeout;
2108 u16 dot11MeshHWMProotInterval;
2109 u16 dot11MeshHWMPconfirmationInterval;
2110 enum nl80211_mesh_power_mode power_mode;
2111 u16 dot11MeshAwakeWindowDuration;
2113 bool dot11MeshNolearn;
2117 * struct mesh_setup - 802.11s mesh setup configuration
2118 * @chandef: defines the channel to use
2119 * @mesh_id: the mesh ID
2120 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
2121 * @sync_method: which synchronization method to use
2122 * @path_sel_proto: which path selection protocol to use
2123 * @path_metric: which metric to use
2124 * @auth_id: which authentication method this mesh is using
2125 * @ie: vendor information elements (optional)
2126 * @ie_len: length of vendor information elements
2127 * @is_authenticated: this mesh requires authentication
2128 * @is_secure: this mesh uses security
2129 * @user_mpm: userspace handles all MPM functions
2130 * @dtim_period: DTIM period to use
2131 * @beacon_interval: beacon interval to use
2132 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2133 * @basic_rates: basic rates to use when creating the mesh
2134 * @beacon_rate: bitrate to be used for beacons
2135 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2136 * changes the channel when a radar is detected. This is required
2137 * to operate on DFS channels.
2138 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2139 * port frames over NL80211 instead of the network interface.
2141 * These parameters are fixed when the mesh is created.
2144 struct cfg80211_chan_def chandef;
2153 bool is_authenticated;
2157 u16 beacon_interval;
2158 int mcast_rate[NUM_NL80211_BANDS];
2160 struct cfg80211_bitrate_mask beacon_rate;
2161 bool userspace_handles_dfs;
2162 bool control_port_over_nl80211;
2166 * struct ocb_setup - 802.11p OCB mode setup configuration
2167 * @chandef: defines the channel to use
2169 * These parameters are fixed when connecting to the network
2172 struct cfg80211_chan_def chandef;
2176 * struct ieee80211_txq_params - TX queue parameters
2177 * @ac: AC identifier
2178 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2179 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2181 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2183 * @aifs: Arbitration interframe space [0..255]
2185 struct ieee80211_txq_params {
2194 * DOC: Scanning and BSS list handling
2196 * The scanning process itself is fairly simple, but cfg80211 offers quite
2197 * a bit of helper functionality. To start a scan, the scan operation will
2198 * be invoked with a scan definition. This scan definition contains the
2199 * channels to scan, and the SSIDs to send probe requests for (including the
2200 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2201 * probe. Additionally, a scan request may contain extra information elements
2202 * that should be added to the probe request. The IEs are guaranteed to be
2203 * well-formed, and will not exceed the maximum length the driver advertised
2204 * in the wiphy structure.
2206 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2207 * it is responsible for maintaining the BSS list; the driver should not
2208 * maintain a list itself. For this notification, various functions exist.
2210 * Since drivers do not maintain a BSS list, there are also a number of
2211 * functions to search for a BSS and obtain information about it from the
2212 * BSS structure cfg80211 maintains. The BSS list is also made available
2217 * struct cfg80211_ssid - SSID description
2219 * @ssid_len: length of the ssid
2221 struct cfg80211_ssid {
2222 u8 ssid[IEEE80211_MAX_SSID_LEN];
2227 * struct cfg80211_scan_info - information about completed scan
2228 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2229 * wireless device that requested the scan is connected to. If this
2230 * information is not available, this field is left zero.
2231 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2232 * @aborted: set to true if the scan was aborted for any reason,
2233 * userspace will be notified of that
2235 struct cfg80211_scan_info {
2237 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2242 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2244 * @short_bssid: short ssid to scan for
2245 * @bssid: bssid to scan for
2246 * @channel_idx: idx of the channel in the channel array in the scan request
2247 * which the above info relvant to
2248 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2249 * @short_ssid_valid: short_ssid is valid and can be used
2250 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2251 * 20 TUs before starting to send probe requests.
2253 struct cfg80211_scan_6ghz_params {
2257 bool unsolicited_probe;
2258 bool short_ssid_valid;
2263 * struct cfg80211_scan_request - scan request description
2265 * @ssids: SSIDs to scan for (active scan only)
2266 * @n_ssids: number of SSIDs
2267 * @channels: channels to scan on.
2268 * @n_channels: total number of channels to scan
2269 * @scan_width: channel width for scanning
2270 * @ie: optional information element(s) to add into Probe Request or %NULL
2271 * @ie_len: length of ie in octets
2272 * @duration: how long to listen on each channel, in TUs. If
2273 * %duration_mandatory is not set, this is the maximum dwell time and
2274 * the actual dwell time may be shorter.
2275 * @duration_mandatory: if set, the scan duration must be as specified by the
2277 * @flags: bit field of flags controlling operation
2278 * @rates: bitmap of rates to advertise for each band
2279 * @wiphy: the wiphy this was for
2280 * @scan_start: time (in jiffies) when the scan started
2281 * @wdev: the wireless device to scan for
2282 * @info: (internal) information about completed scan
2283 * @notified: (internal) scan request was notified as done or aborted
2284 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2285 * @mac_addr: MAC address used with randomisation
2286 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2287 * are 0 in the mask should be randomised, bits that are 1 should
2288 * be taken from the @mac_addr
2289 * @scan_6ghz: relevant for split scan request only,
2290 * true if this is the second scan request
2291 * @n_6ghz_params: number of 6 GHz params
2292 * @scan_6ghz_params: 6 GHz params
2293 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2295 struct cfg80211_scan_request {
2296 struct cfg80211_ssid *ssids;
2299 enum nl80211_bss_scan_width scan_width;
2303 bool duration_mandatory;
2306 u32 rates[NUM_NL80211_BANDS];
2308 struct wireless_dev *wdev;
2310 u8 mac_addr[ETH_ALEN] __aligned(2);
2311 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2312 u8 bssid[ETH_ALEN] __aligned(2);
2315 struct wiphy *wiphy;
2316 unsigned long scan_start;
2317 struct cfg80211_scan_info info;
2322 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2325 struct ieee80211_channel *channels[];
2328 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2332 get_random_bytes(buf, ETH_ALEN);
2333 for (i = 0; i < ETH_ALEN; i++) {
2335 buf[i] |= addr[i] & mask[i];
2340 * struct cfg80211_match_set - sets of attributes to match
2342 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2343 * or no match (RSSI only)
2344 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2345 * or no match (RSSI only)
2346 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2347 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2348 * for filtering out scan results received. Drivers advertize this support
2349 * of band specific rssi based filtering through the feature capability
2350 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2351 * specific rssi thresholds take precedence over rssi_thold, if specified.
2352 * If not specified for any band, it will be assigned with rssi_thold of
2353 * corresponding matchset.
2355 struct cfg80211_match_set {
2356 struct cfg80211_ssid ssid;
2359 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2363 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2365 * @interval: interval between scheduled scan iterations. In seconds.
2366 * @iterations: number of scan iterations in this scan plan. Zero means
2368 * The last scan plan will always have this parameter set to zero,
2369 * all other scan plans will have a finite number of iterations.
2371 struct cfg80211_sched_scan_plan {
2377 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2379 * @band: band of BSS which should match for RSSI level adjustment.
2380 * @delta: value of RSSI level adjustment.
2382 struct cfg80211_bss_select_adjust {
2383 enum nl80211_band band;
2388 * struct cfg80211_sched_scan_request - scheduled scan request description
2390 * @reqid: identifies this request.
2391 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2392 * @n_ssids: number of SSIDs
2393 * @n_channels: total number of channels to scan
2394 * @scan_width: channel width for scanning
2395 * @ie: optional information element(s) to add into Probe Request or %NULL
2396 * @ie_len: length of ie in octets
2397 * @flags: bit field of flags controlling operation
2398 * @match_sets: sets of parameters to be matched for a scan result
2399 * entry to be considered valid and to be passed to the host
2400 * (others are filtered out).
2401 * If ommited, all results are passed.
2402 * @n_match_sets: number of match sets
2403 * @report_results: indicates that results were reported for this request
2404 * @wiphy: the wiphy this was for
2405 * @dev: the interface
2406 * @scan_start: start time of the scheduled scan
2407 * @channels: channels to scan
2408 * @min_rssi_thold: for drivers only supporting a single threshold, this
2409 * contains the minimum over all matchsets
2410 * @mac_addr: MAC address used with randomisation
2411 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2412 * are 0 in the mask should be randomised, bits that are 1 should
2413 * be taken from the @mac_addr
2414 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2415 * index must be executed first.
2416 * @n_scan_plans: number of scan plans, at least 1.
2417 * @rcu_head: RCU callback used to free the struct
2418 * @owner_nlportid: netlink portid of owner (if this should is a request
2419 * owned by a particular socket)
2420 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2421 * @list: for keeping list of requests.
2422 * @delay: delay in seconds to use before starting the first scan
2423 * cycle. The driver may ignore this parameter and start
2424 * immediately (or at any other time), if this feature is not
2426 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2427 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2428 * reporting in connected state to cases where a matching BSS is determined
2429 * to have better or slightly worse RSSI than the current connected BSS.
2430 * The relative RSSI threshold values are ignored in disconnected state.
2431 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2432 * to the specified band while deciding whether a better BSS is reported
2433 * using @relative_rssi. If delta is a negative number, the BSSs that
2434 * belong to the specified band will be penalized by delta dB in relative
2437 struct cfg80211_sched_scan_request {
2439 struct cfg80211_ssid *ssids;
2442 enum nl80211_bss_scan_width scan_width;
2446 struct cfg80211_match_set *match_sets;
2450 struct cfg80211_sched_scan_plan *scan_plans;
2453 u8 mac_addr[ETH_ALEN] __aligned(2);
2454 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2456 bool relative_rssi_set;
2458 struct cfg80211_bss_select_adjust rssi_adjust;
2461 struct wiphy *wiphy;
2462 struct net_device *dev;
2463 unsigned long scan_start;
2464 bool report_results;
2465 struct rcu_head rcu_head;
2468 struct list_head list;
2471 struct ieee80211_channel *channels[];
2475 * enum cfg80211_signal_type - signal type
2477 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2478 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2479 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2481 enum cfg80211_signal_type {
2482 CFG80211_SIGNAL_TYPE_NONE,
2483 CFG80211_SIGNAL_TYPE_MBM,
2484 CFG80211_SIGNAL_TYPE_UNSPEC,
2488 * struct cfg80211_inform_bss - BSS inform data
2489 * @chan: channel the frame was received on
2490 * @scan_width: scan width that was used
2491 * @signal: signal strength value, according to the wiphy's
2493 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2494 * received; should match the time when the frame was actually
2495 * received by the device (not just by the host, in case it was
2496 * buffered on the device) and be accurate to about 10ms.
2497 * If the frame isn't buffered, just passing the return value of
2498 * ktime_get_boottime_ns() is likely appropriate.
2499 * @parent_tsf: the time at the start of reception of the first octet of the
2500 * timestamp field of the frame. The time is the TSF of the BSS specified
2502 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2503 * the BSS that requested the scan in which the beacon/probe was received.
2504 * @chains: bitmask for filled values in @chain_signal.
2505 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2507 struct cfg80211_inform_bss {
2508 struct ieee80211_channel *chan;
2509 enum nl80211_bss_scan_width scan_width;
2513 u8 parent_bssid[ETH_ALEN] __aligned(2);
2515 s8 chain_signal[IEEE80211_MAX_CHAINS];
2519 * struct cfg80211_bss_ies - BSS entry IE data
2520 * @tsf: TSF contained in the frame that carried these IEs
2521 * @rcu_head: internal use, for freeing
2522 * @len: length of the IEs
2523 * @from_beacon: these IEs are known to come from a beacon
2526 struct cfg80211_bss_ies {
2528 struct rcu_head rcu_head;
2535 * struct cfg80211_bss - BSS description
2537 * This structure describes a BSS (which may also be a mesh network)
2538 * for use in scan results and similar.
2540 * @channel: channel this BSS is on
2541 * @scan_width: width of the control channel
2542 * @bssid: BSSID of the BSS
2543 * @beacon_interval: the beacon interval as from the frame
2544 * @capability: the capability field in host byte order
2545 * @ies: the information elements (Note that there is no guarantee that these
2546 * are well-formed!); this is a pointer to either the beacon_ies or
2547 * proberesp_ies depending on whether Probe Response frame has been
2548 * received. It is always non-%NULL.
2549 * @beacon_ies: the information elements from the last Beacon frame
2550 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2551 * own the beacon_ies, but they're just pointers to the ones from the
2552 * @hidden_beacon_bss struct)
2553 * @proberesp_ies: the information elements from the last Probe Response frame
2554 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2555 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2556 * that holds the beacon data. @beacon_ies is still valid, of course, and
2557 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2558 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2559 * non-transmitted one (multi-BSSID support)
2560 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2561 * (multi-BSSID support)
2562 * @signal: signal strength value (type depends on the wiphy's signal_type)
2563 * @chains: bitmask for filled values in @chain_signal.
2564 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2565 * @bssid_index: index in the multiple BSS set
2566 * @max_bssid_indicator: max number of members in the BSS set
2567 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2569 struct cfg80211_bss {
2570 struct ieee80211_channel *channel;
2571 enum nl80211_bss_scan_width scan_width;
2573 const struct cfg80211_bss_ies __rcu *ies;
2574 const struct cfg80211_bss_ies __rcu *beacon_ies;
2575 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2577 struct cfg80211_bss *hidden_beacon_bss;
2578 struct cfg80211_bss *transmitted_bss;
2579 struct list_head nontrans_list;
2583 u16 beacon_interval;
2588 s8 chain_signal[IEEE80211_MAX_CHAINS];
2591 u8 max_bssid_indicator;
2593 u8 priv[] __aligned(sizeof(void *));
2597 * ieee80211_bss_get_elem - find element with given ID
2598 * @bss: the bss to search
2599 * @id: the element ID
2601 * Note that the return value is an RCU-protected pointer, so
2602 * rcu_read_lock() must be held when calling this function.
2603 * Return: %NULL if not found.
2605 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2608 * ieee80211_bss_get_ie - find IE with given ID
2609 * @bss: the bss to search
2610 * @id: the element ID
2612 * Note that the return value is an RCU-protected pointer, so
2613 * rcu_read_lock() must be held when calling this function.
2614 * Return: %NULL if not found.
2616 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2618 return (void *)ieee80211_bss_get_elem(bss, id);
2623 * struct cfg80211_auth_request - Authentication request data
2625 * This structure provides information needed to complete IEEE 802.11
2628 * @bss: The BSS to authenticate with, the callee must obtain a reference
2629 * to it if it needs to keep it.
2630 * @auth_type: Authentication type (algorithm)
2631 * @ie: Extra IEs to add to Authentication frame or %NULL
2632 * @ie_len: Length of ie buffer in octets
2633 * @key_len: length of WEP key for shared key authentication
2634 * @key_idx: index of WEP key for shared key authentication
2635 * @key: WEP key for shared key authentication
2636 * @auth_data: Fields and elements in Authentication frames. This contains
2637 * the authentication frame body (non-IE and IE data), excluding the
2638 * Authentication algorithm number, i.e., starting at the Authentication
2639 * transaction sequence number field.
2640 * @auth_data_len: Length of auth_data buffer in octets
2642 struct cfg80211_auth_request {
2643 struct cfg80211_bss *bss;
2646 enum nl80211_auth_type auth_type;
2648 u8 key_len, key_idx;
2649 const u8 *auth_data;
2650 size_t auth_data_len;
2654 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2656 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2657 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2658 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2659 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2660 * authentication capability. Drivers can offload authentication to
2661 * userspace if this flag is set. Only applicable for cfg80211_connect()
2662 * request (connect callback).
2663 * @ASSOC_REQ_DISABLE_HE: Disable HE
2665 enum cfg80211_assoc_req_flags {
2666 ASSOC_REQ_DISABLE_HT = BIT(0),
2667 ASSOC_REQ_DISABLE_VHT = BIT(1),
2668 ASSOC_REQ_USE_RRM = BIT(2),
2669 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2670 ASSOC_REQ_DISABLE_HE = BIT(4),
2674 * struct cfg80211_assoc_request - (Re)Association request data
2676 * This structure provides information needed to complete IEEE 802.11
2678 * @bss: The BSS to associate with. If the call is successful the driver is
2679 * given a reference that it must give back to cfg80211_send_rx_assoc()
2680 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2681 * association requests while already associating must be rejected.
2682 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2683 * @ie_len: Length of ie buffer in octets
2684 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2685 * @crypto: crypto settings
2686 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2687 * to indicate a request to reassociate within the ESS instead of a request
2688 * do the initial association with the ESS. When included, this is set to
2689 * the BSSID of the current association, i.e., to the value that is
2690 * included in the Current AP address field of the Reassociation Request
2692 * @flags: See &enum cfg80211_assoc_req_flags
2693 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2694 * will be used in ht_capa. Un-supported values will be ignored.
2695 * @ht_capa_mask: The bits of ht_capa which are to be used.
2696 * @vht_capa: VHT capability override
2697 * @vht_capa_mask: VHT capability mask indicating which fields to use
2698 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2699 * %NULL if FILS is not used.
2700 * @fils_kek_len: Length of fils_kek in octets
2701 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2702 * Request/Response frame or %NULL if FILS is not used. This field starts
2703 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2704 * @s1g_capa: S1G capability override
2705 * @s1g_capa_mask: S1G capability override mask
2707 struct cfg80211_assoc_request {
2708 struct cfg80211_bss *bss;
2709 const u8 *ie, *prev_bssid;
2711 struct cfg80211_crypto_settings crypto;
2714 struct ieee80211_ht_cap ht_capa;
2715 struct ieee80211_ht_cap ht_capa_mask;
2716 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2718 size_t fils_kek_len;
2719 const u8 *fils_nonces;
2720 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2724 * struct cfg80211_deauth_request - Deauthentication request data
2726 * This structure provides information needed to complete IEEE 802.11
2729 * @bssid: the BSSID of the BSS to deauthenticate from
2730 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2731 * @ie_len: Length of ie buffer in octets
2732 * @reason_code: The reason code for the deauthentication
2733 * @local_state_change: if set, change local state only and
2734 * do not set a deauth frame
2736 struct cfg80211_deauth_request {
2741 bool local_state_change;
2745 * struct cfg80211_disassoc_request - Disassociation request data
2747 * This structure provides information needed to complete IEEE 802.11
2750 * @bss: the BSS to disassociate from
2751 * @ie: Extra IEs to add to Disassociation frame or %NULL
2752 * @ie_len: Length of ie buffer in octets
2753 * @reason_code: The reason code for the disassociation
2754 * @local_state_change: This is a request for a local state only, i.e., no
2755 * Disassociation frame is to be transmitted.
2757 struct cfg80211_disassoc_request {
2758 struct cfg80211_bss *bss;
2762 bool local_state_change;
2766 * struct cfg80211_ibss_params - IBSS parameters
2768 * This structure defines the IBSS parameters for the join_ibss()
2771 * @ssid: The SSID, will always be non-null.
2772 * @ssid_len: The length of the SSID, will always be non-zero.
2773 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2774 * search for IBSSs with a different BSSID.
2775 * @chandef: defines the channel to use if no other IBSS to join can be found
2776 * @channel_fixed: The channel should be fixed -- do not search for
2777 * IBSSs to join on other channels.
2778 * @ie: information element(s) to include in the beacon
2779 * @ie_len: length of that
2780 * @beacon_interval: beacon interval to use
2781 * @privacy: this is a protected network, keys will be configured
2783 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2784 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2785 * required to assume that the port is unauthorized until authorized by
2786 * user space. Otherwise, port is marked authorized by default.
2787 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2788 * port frames over NL80211 instead of the network interface.
2789 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2790 * changes the channel when a radar is detected. This is required
2791 * to operate on DFS channels.
2792 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2793 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2794 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2795 * will be used in ht_capa. Un-supported values will be ignored.
2796 * @ht_capa_mask: The bits of ht_capa which are to be used.
2797 * @wep_keys: static WEP keys, if not NULL points to an array of
2798 * CFG80211_MAX_WEP_KEYS WEP keys
2799 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2801 struct cfg80211_ibss_params {
2804 struct cfg80211_chan_def chandef;
2806 u8 ssid_len, ie_len;
2807 u16 beacon_interval;
2812 bool control_port_over_nl80211;
2813 bool userspace_handles_dfs;
2814 int mcast_rate[NUM_NL80211_BANDS];
2815 struct ieee80211_ht_cap ht_capa;
2816 struct ieee80211_ht_cap ht_capa_mask;
2817 struct key_params *wep_keys;
2822 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2824 * @behaviour: requested BSS selection behaviour.
2825 * @param: parameters for requestion behaviour.
2826 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2827 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2829 struct cfg80211_bss_selection {
2830 enum nl80211_bss_select_attr behaviour;
2832 enum nl80211_band band_pref;
2833 struct cfg80211_bss_select_adjust adjust;
2838 * struct cfg80211_connect_params - Connection parameters
2840 * This structure provides information needed to complete IEEE 802.11
2841 * authentication and association.
2843 * @channel: The channel to use or %NULL if not specified (auto-select based
2845 * @channel_hint: The channel of the recommended BSS for initial connection or
2846 * %NULL if not specified
2847 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2849 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2850 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2851 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2854 * @ssid_len: Length of ssid in octets
2855 * @auth_type: Authentication type (algorithm)
2856 * @ie: IEs for association request
2857 * @ie_len: Length of assoc_ie in octets
2858 * @privacy: indicates whether privacy-enabled APs should be used
2859 * @mfp: indicate whether management frame protection is used
2860 * @crypto: crypto settings
2861 * @key_len: length of WEP key for shared key authentication
2862 * @key_idx: index of WEP key for shared key authentication
2863 * @key: WEP key for shared key authentication
2864 * @flags: See &enum cfg80211_assoc_req_flags
2865 * @bg_scan_period: Background scan period in seconds
2866 * or -1 to indicate that default value is to be used.
2867 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2868 * will be used in ht_capa. Un-supported values will be ignored.
2869 * @ht_capa_mask: The bits of ht_capa which are to be used.
2870 * @vht_capa: VHT Capability overrides
2871 * @vht_capa_mask: The bits of vht_capa which are to be used.
2872 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2874 * @bss_select: criteria to be used for BSS selection.
2875 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2876 * to indicate a request to reassociate within the ESS instead of a request
2877 * do the initial association with the ESS. When included, this is set to
2878 * the BSSID of the current association, i.e., to the value that is
2879 * included in the Current AP address field of the Reassociation Request
2881 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2882 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2884 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2885 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2886 * %NULL if not specified. This specifies the domain name of ER server and
2887 * is used to construct FILS wrapped data IE.
2888 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2889 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2890 * messages. This is also used to construct FILS wrapped data IE.
2891 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2892 * keys in FILS or %NULL if not specified.
2893 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2894 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2895 * offload of 4-way handshake.
2896 * @edmg: define the EDMG channels.
2897 * This may specify multiple channels and bonding options for the driver
2898 * to choose from, based on BSS configuration.
2900 struct cfg80211_connect_params {
2901 struct ieee80211_channel *channel;
2902 struct ieee80211_channel *channel_hint;
2904 const u8 *bssid_hint;
2907 enum nl80211_auth_type auth_type;
2911 enum nl80211_mfp mfp;
2912 struct cfg80211_crypto_settings crypto;
2914 u8 key_len, key_idx;
2917 struct ieee80211_ht_cap ht_capa;
2918 struct ieee80211_ht_cap ht_capa_mask;
2919 struct ieee80211_vht_cap vht_capa;
2920 struct ieee80211_vht_cap vht_capa_mask;
2922 struct cfg80211_bss_selection bss_select;
2923 const u8 *prev_bssid;
2924 const u8 *fils_erp_username;
2925 size_t fils_erp_username_len;
2926 const u8 *fils_erp_realm;
2927 size_t fils_erp_realm_len;
2928 u16 fils_erp_next_seq_num;
2929 const u8 *fils_erp_rrk;
2930 size_t fils_erp_rrk_len;
2932 struct ieee80211_edmg edmg;
2936 * enum cfg80211_connect_params_changed - Connection parameters being updated
2938 * This enum provides information of all connect parameters that
2939 * have to be updated as part of update_connect_params() call.
2941 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2942 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2943 * username, erp sequence number and rrk) are updated
2944 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2946 enum cfg80211_connect_params_changed {
2947 UPDATE_ASSOC_IES = BIT(0),
2948 UPDATE_FILS_ERP_INFO = BIT(1),
2949 UPDATE_AUTH_TYPE = BIT(2),
2953 * enum wiphy_params_flags - set_wiphy_params bitfield values
2954 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2955 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2956 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2957 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2958 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2959 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2960 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2961 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2962 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2964 enum wiphy_params_flags {
2965 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2966 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2967 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2968 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2969 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2970 WIPHY_PARAM_DYN_ACK = 1 << 5,
2971 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2972 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2973 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2976 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2978 /* The per TXQ device queue limit in airtime */
2979 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2980 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2982 /* The per interface airtime threshold to switch to lower queue limit */
2983 #define IEEE80211_AQL_THRESHOLD 24000
2986 * struct cfg80211_pmksa - PMK Security Association
2988 * This structure is passed to the set/del_pmksa() method for PMKSA
2991 * @bssid: The AP's BSSID (may be %NULL).
2992 * @pmkid: The identifier to refer a PMKSA.
2993 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2994 * derivation by a FILS STA. Otherwise, %NULL.
2995 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2996 * the hash algorithm used to generate this.
2997 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2998 * cache identifier (may be %NULL).
2999 * @ssid_len: Length of the @ssid in octets.
3000 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
3001 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
3003 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
3004 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
3005 * The configured PMKSA must not be used for PMKSA caching after
3006 * expiration and any keys derived from this PMK become invalid on
3007 * expiration, i.e., the current association must be dropped if the PMK
3008 * used for it expires.
3009 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
3010 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
3011 * Drivers are expected to trigger a full authentication instead of using
3012 * this PMKSA for caching when reassociating to a new BSS after this
3013 * threshold to generate a new PMK before the current one expires.
3015 struct cfg80211_pmksa {
3024 u8 pmk_reauth_threshold;
3028 * struct cfg80211_pkt_pattern - packet pattern
3029 * @mask: bitmask where to match pattern and where to ignore bytes,
3030 * one bit per byte, in same format as nl80211
3031 * @pattern: bytes to match where bitmask is 1
3032 * @pattern_len: length of pattern (in bytes)
3033 * @pkt_offset: packet offset (in bytes)
3035 * Internal note: @mask and @pattern are allocated in one chunk of
3036 * memory, free @mask only!
3038 struct cfg80211_pkt_pattern {
3039 const u8 *mask, *pattern;
3045 * struct cfg80211_wowlan_tcp - TCP connection parameters
3047 * @sock: (internal) socket for source port allocation
3048 * @src: source IP address
3049 * @dst: destination IP address
3050 * @dst_mac: destination MAC address
3051 * @src_port: source port
3052 * @dst_port: destination port
3053 * @payload_len: data payload length
3054 * @payload: data payload buffer
3055 * @payload_seq: payload sequence stamping configuration
3056 * @data_interval: interval at which to send data packets
3057 * @wake_len: wakeup payload match length
3058 * @wake_data: wakeup payload match data
3059 * @wake_mask: wakeup payload match mask
3060 * @tokens_size: length of the tokens buffer
3061 * @payload_tok: payload token usage configuration
3063 struct cfg80211_wowlan_tcp {
3064 struct socket *sock;
3066 u16 src_port, dst_port;
3067 u8 dst_mac[ETH_ALEN];
3070 struct nl80211_wowlan_tcp_data_seq payload_seq;
3073 const u8 *wake_data, *wake_mask;
3075 /* must be last, variable member */
3076 struct nl80211_wowlan_tcp_data_token payload_tok;
3080 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3082 * This structure defines the enabled WoWLAN triggers for the device.
3083 * @any: wake up on any activity -- special trigger if device continues
3084 * operating as normal during suspend
3085 * @disconnect: wake up if getting disconnected
3086 * @magic_pkt: wake up on receiving magic packet
3087 * @patterns: wake up on receiving packet matching a pattern
3088 * @n_patterns: number of patterns
3089 * @gtk_rekey_failure: wake up on GTK rekey failure
3090 * @eap_identity_req: wake up on EAP identity request packet
3091 * @four_way_handshake: wake up on 4-way handshake
3092 * @rfkill_release: wake up when rfkill is released
3093 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3094 * NULL if not configured.
3095 * @nd_config: configuration for the scan to be used for net detect wake.
3097 struct cfg80211_wowlan {
3098 bool any, disconnect, magic_pkt, gtk_rekey_failure,
3099 eap_identity_req, four_way_handshake,
3101 struct cfg80211_pkt_pattern *patterns;
3102 struct cfg80211_wowlan_tcp *tcp;
3104 struct cfg80211_sched_scan_request *nd_config;
3108 * struct cfg80211_coalesce_rules - Coalesce rule parameters
3110 * This structure defines coalesce rule for the device.
3111 * @delay: maximum coalescing delay in msecs.
3112 * @condition: condition for packet coalescence.
3113 * see &enum nl80211_coalesce_condition.
3114 * @patterns: array of packet patterns
3115 * @n_patterns: number of patterns
3117 struct cfg80211_coalesce_rules {
3119 enum nl80211_coalesce_condition condition;
3120 struct cfg80211_pkt_pattern *patterns;
3125 * struct cfg80211_coalesce - Packet coalescing settings
3127 * This structure defines coalescing settings.
3128 * @rules: array of coalesce rules
3129 * @n_rules: number of rules
3131 struct cfg80211_coalesce {
3132 struct cfg80211_coalesce_rules *rules;
3137 * struct cfg80211_wowlan_nd_match - information about the match
3139 * @ssid: SSID of the match that triggered the wake up
3140 * @n_channels: Number of channels where the match occurred. This
3141 * value may be zero if the driver can't report the channels.
3142 * @channels: center frequencies of the channels where a match
3145 struct cfg80211_wowlan_nd_match {
3146 struct cfg80211_ssid ssid;
3152 * struct cfg80211_wowlan_nd_info - net detect wake up information
3154 * @n_matches: Number of match information instances provided in
3155 * @matches. This value may be zero if the driver can't provide
3156 * match information.
3157 * @matches: Array of pointers to matches containing information about
3158 * the matches that triggered the wake up.
3160 struct cfg80211_wowlan_nd_info {
3162 struct cfg80211_wowlan_nd_match *matches[];
3166 * struct cfg80211_wowlan_wakeup - wakeup report
3167 * @disconnect: woke up by getting disconnected
3168 * @magic_pkt: woke up by receiving magic packet
3169 * @gtk_rekey_failure: woke up by GTK rekey failure
3170 * @eap_identity_req: woke up by EAP identity request packet
3171 * @four_way_handshake: woke up by 4-way handshake
3172 * @rfkill_release: woke up by rfkill being released
3173 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3174 * @packet_present_len: copied wakeup packet data
3175 * @packet_len: original wakeup packet length
3176 * @packet: The packet causing the wakeup, if any.
3177 * @packet_80211: For pattern match, magic packet and other data
3178 * frame triggers an 802.3 frame should be reported, for
3179 * disconnect due to deauth 802.11 frame. This indicates which
3181 * @tcp_match: TCP wakeup packet received
3182 * @tcp_connlost: TCP connection lost or failed to establish
3183 * @tcp_nomoretokens: TCP data ran out of tokens
3184 * @net_detect: if not %NULL, woke up because of net detect
3186 struct cfg80211_wowlan_wakeup {
3187 bool disconnect, magic_pkt, gtk_rekey_failure,
3188 eap_identity_req, four_way_handshake,
3189 rfkill_release, packet_80211,
3190 tcp_match, tcp_connlost, tcp_nomoretokens;
3192 u32 packet_present_len, packet_len;
3194 struct cfg80211_wowlan_nd_info *net_detect;
3198 * struct cfg80211_gtk_rekey_data - rekey data
3199 * @kek: key encryption key (@kek_len bytes)
3200 * @kck: key confirmation key (@kck_len bytes)
3201 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3202 * @kek_len: length of kek
3203 * @kck_len length of kck
3204 * @akm: akm (oui, id)
3206 struct cfg80211_gtk_rekey_data {
3207 const u8 *kek, *kck, *replay_ctr;
3209 u8 kek_len, kck_len;
3213 * struct cfg80211_update_ft_ies_params - FT IE Information
3215 * This structure provides information needed to update the fast transition IE
3217 * @md: The Mobility Domain ID, 2 Octet value
3218 * @ie: Fast Transition IEs
3219 * @ie_len: Length of ft_ie in octets
3221 struct cfg80211_update_ft_ies_params {
3228 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3230 * This structure provides information needed to transmit a mgmt frame
3232 * @chan: channel to use
3233 * @offchan: indicates wether off channel operation is required
3234 * @wait: duration for ROC
3235 * @buf: buffer to transmit
3236 * @len: buffer length
3237 * @no_cck: don't use cck rates for this frame
3238 * @dont_wait_for_ack: tells the low level not to wait for an ack
3239 * @n_csa_offsets: length of csa_offsets array
3240 * @csa_offsets: array of all the csa offsets in the frame
3242 struct cfg80211_mgmt_tx_params {
3243 struct ieee80211_channel *chan;
3249 bool dont_wait_for_ack;
3251 const u16 *csa_offsets;
3255 * struct cfg80211_dscp_exception - DSCP exception
3257 * @dscp: DSCP value that does not adhere to the user priority range definition
3258 * @up: user priority value to which the corresponding DSCP value belongs
3260 struct cfg80211_dscp_exception {
3266 * struct cfg80211_dscp_range - DSCP range definition for user priority
3268 * @low: lowest DSCP value of this user priority range, inclusive
3269 * @high: highest DSCP value of this user priority range, inclusive
3271 struct cfg80211_dscp_range {
3276 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3277 #define IEEE80211_QOS_MAP_MAX_EX 21
3278 #define IEEE80211_QOS_MAP_LEN_MIN 16
3279 #define IEEE80211_QOS_MAP_LEN_MAX \
3280 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3283 * struct cfg80211_qos_map - QoS Map Information
3285 * This struct defines the Interworking QoS map setting for DSCP values
3287 * @num_des: number of DSCP exceptions (0..21)
3288 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3289 * the user priority DSCP range definition
3290 * @up: DSCP range definition for a particular user priority
3292 struct cfg80211_qos_map {
3294 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3295 struct cfg80211_dscp_range up[8];
3299 * struct cfg80211_nan_conf - NAN configuration
3301 * This struct defines NAN configuration parameters
3303 * @master_pref: master preference (1 - 255)
3304 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3305 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3306 * (i.e. BIT(NL80211_BAND_2GHZ)).
3308 struct cfg80211_nan_conf {
3314 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3317 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3318 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3320 enum cfg80211_nan_conf_changes {
3321 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3322 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3326 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3328 * @filter: the content of the filter
3329 * @len: the length of the filter
3331 struct cfg80211_nan_func_filter {
3337 * struct cfg80211_nan_func - a NAN function
3339 * @type: &enum nl80211_nan_function_type
3340 * @service_id: the service ID of the function
3341 * @publish_type: &nl80211_nan_publish_type
3342 * @close_range: if true, the range should be limited. Threshold is
3343 * implementation specific.
3344 * @publish_bcast: if true, the solicited publish should be broadcasted
3345 * @subscribe_active: if true, the subscribe is active
3346 * @followup_id: the instance ID for follow up
3347 * @followup_reqid: the requestor instance ID for follow up
3348 * @followup_dest: MAC address of the recipient of the follow up
3349 * @ttl: time to live counter in DW.
3350 * @serv_spec_info: Service Specific Info
3351 * @serv_spec_info_len: Service Specific Info length
3352 * @srf_include: if true, SRF is inclusive
3353 * @srf_bf: Bloom Filter
3354 * @srf_bf_len: Bloom Filter length
3355 * @srf_bf_idx: Bloom Filter index
3356 * @srf_macs: SRF MAC addresses
3357 * @srf_num_macs: number of MAC addresses in SRF
3358 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3359 * @tx_filters: filters that should be transmitted in the SDF.
3360 * @num_rx_filters: length of &rx_filters.
3361 * @num_tx_filters: length of &tx_filters.
3362 * @instance_id: driver allocated id of the function.
3363 * @cookie: unique NAN function identifier.
3365 struct cfg80211_nan_func {
3366 enum nl80211_nan_function_type type;
3367 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3371 bool subscribe_active;
3374 struct mac_address followup_dest;
3376 const u8 *serv_spec_info;
3377 u8 serv_spec_info_len;
3382 struct mac_address *srf_macs;
3384 struct cfg80211_nan_func_filter *rx_filters;
3385 struct cfg80211_nan_func_filter *tx_filters;
3393 * struct cfg80211_pmk_conf - PMK configuration
3395 * @aa: authenticator address
3396 * @pmk_len: PMK length in bytes.
3397 * @pmk: the PMK material
3398 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3399 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3402 struct cfg80211_pmk_conf {
3406 const u8 *pmk_r0_name;
3410 * struct cfg80211_external_auth_params - Trigger External authentication.
3412 * Commonly used across the external auth request and event interfaces.
3414 * @action: action type / trigger for external authentication. Only significant
3415 * for the authentication request event interface (driver to user space).
3416 * @bssid: BSSID of the peer with which the authentication has
3417 * to happen. Used by both the authentication request event and
3418 * authentication response command interface.
3419 * @ssid: SSID of the AP. Used by both the authentication request event and
3420 * authentication response command interface.
3421 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3422 * authentication request event interface.
3423 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3424 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3425 * the real status code for failures. Used only for the authentication
3426 * response command interface (user space to driver).
3427 * @pmkid: The identifier to refer a PMKSA.
3429 struct cfg80211_external_auth_params {
3430 enum nl80211_external_auth_action action;
3431 u8 bssid[ETH_ALEN] __aligned(2);
3432 struct cfg80211_ssid ssid;
3433 unsigned int key_mgmt_suite;
3439 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3441 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3442 * indicate the relevant values in this struct for them
3443 * @success_num: number of FTM sessions in which all frames were successfully
3445 * @partial_num: number of FTM sessions in which part of frames were
3446 * successfully answered
3447 * @failed_num: number of failed FTM sessions
3448 * @asap_num: number of ASAP FTM sessions
3449 * @non_asap_num: number of non-ASAP FTM sessions
3450 * @total_duration_ms: total sessions durations - gives an indication
3451 * of how much time the responder was busy
3452 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3453 * initiators that didn't finish successfully the negotiation phase with
3455 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3456 * for a new scheduling although it already has scheduled FTM slot
3457 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3459 struct cfg80211_ftm_responder_stats {
3466 u64 total_duration_ms;
3467 u32 unknown_triggers_num;
3468 u32 reschedule_requests_num;
3469 u32 out_of_window_triggers_num;
3473 * struct cfg80211_pmsr_ftm_result - FTM result
3474 * @failure_reason: if this measurement failed (PMSR status is
3475 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3476 * reason than just "failure"
3477 * @burst_index: if reporting partial results, this is the index
3478 * in [0 .. num_bursts-1] of the burst that's being reported
3479 * @num_ftmr_attempts: number of FTM request frames transmitted
3480 * @num_ftmr_successes: number of FTM request frames acked
3481 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3482 * fill this to indicate in how many seconds a retry is deemed possible
3484 * @num_bursts_exp: actual number of bursts exponent negotiated
3485 * @burst_duration: actual burst duration negotiated
3486 * @ftms_per_burst: actual FTMs per burst negotiated
3487 * @lci_len: length of LCI information (if present)
3488 * @civicloc_len: length of civic location information (if present)
3489 * @lci: LCI data (may be %NULL)
3490 * @civicloc: civic location data (may be %NULL)
3491 * @rssi_avg: average RSSI over FTM action frames reported
3492 * @rssi_spread: spread of the RSSI over FTM action frames reported
3493 * @tx_rate: bitrate for transmitted FTM action frame response
3494 * @rx_rate: bitrate of received FTM action frame
3495 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3496 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3497 * the square root of the variance)
3498 * @rtt_spread: spread of the RTTs measured
3499 * @dist_avg: average of distances (mm) measured
3500 * (must have either this or @rtt_avg)
3501 * @dist_variance: variance of distances measured (see also @rtt_variance)
3502 * @dist_spread: spread of distances measured (see also @rtt_spread)
3503 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3504 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3505 * @rssi_avg_valid: @rssi_avg is valid
3506 * @rssi_spread_valid: @rssi_spread is valid
3507 * @tx_rate_valid: @tx_rate is valid
3508 * @rx_rate_valid: @rx_rate is valid
3509 * @rtt_avg_valid: @rtt_avg is valid
3510 * @rtt_variance_valid: @rtt_variance is valid
3511 * @rtt_spread_valid: @rtt_spread is valid
3512 * @dist_avg_valid: @dist_avg is valid
3513 * @dist_variance_valid: @dist_variance is valid
3514 * @dist_spread_valid: @dist_spread is valid
3516 struct cfg80211_pmsr_ftm_result {
3519 unsigned int lci_len;
3520 unsigned int civicloc_len;
3521 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3522 u32 num_ftmr_attempts, num_ftmr_successes;
3530 struct rate_info tx_rate, rx_rate;
3538 u16 num_ftmr_attempts_valid:1,
3539 num_ftmr_successes_valid:1,
3541 rssi_spread_valid:1,
3545 rtt_variance_valid:1,
3548 dist_variance_valid:1,
3549 dist_spread_valid:1;
3553 * struct cfg80211_pmsr_result - peer measurement result
3554 * @addr: address of the peer
3555 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3556 * measurement was made)
3557 * @ap_tsf: AP's TSF at measurement time
3558 * @status: status of the measurement
3559 * @final: if reporting partial results, mark this as the last one; if not
3560 * reporting partial results always set this flag
3561 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3562 * @type: type of the measurement reported, note that we only support reporting
3563 * one type at a time, but you can report multiple results separately and
3564 * they're all aggregated for userspace.
3566 struct cfg80211_pmsr_result {
3567 u64 host_time, ap_tsf;
3568 enum nl80211_peer_measurement_status status;
3575 enum nl80211_peer_measurement_type type;
3578 struct cfg80211_pmsr_ftm_result ftm;
3583 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3584 * @requested: indicates FTM is requested
3585 * @preamble: frame preamble to use
3586 * @burst_period: burst period to use
3587 * @asap: indicates to use ASAP mode
3588 * @num_bursts_exp: number of bursts exponent
3589 * @burst_duration: burst duration
3590 * @ftms_per_burst: number of FTMs per burst
3591 * @ftmr_retries: number of retries for FTM request
3592 * @request_lci: request LCI information
3593 * @request_civicloc: request civic location information
3594 * @trigger_based: use trigger based ranging for the measurement
3595 * If neither @trigger_based nor @non_trigger_based is set,
3596 * EDCA based ranging will be used.
3597 * @non_trigger_based: use non trigger based ranging for the measurement
3598 * If neither @trigger_based nor @non_trigger_based is set,
3599 * EDCA based ranging will be used.
3600 * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
3601 * @trigger_based or @non_trigger_based is set.
3602 * @bss_color: the bss color of the responder. Optional. Set to zero to
3603 * indicate the driver should set the BSS color. Only valid if
3604 * @non_trigger_based or @trigger_based is set.
3606 * See also nl80211 for the respective attribute documentation.
3608 struct cfg80211_pmsr_ftm_request_peer {
3609 enum nl80211_preamble preamble;
3616 non_trigger_based:1,
3626 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3627 * @addr: MAC address
3628 * @chandef: channel to use
3629 * @report_ap_tsf: report the associated AP's TSF
3630 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3632 struct cfg80211_pmsr_request_peer {
3634 struct cfg80211_chan_def chandef;
3636 struct cfg80211_pmsr_ftm_request_peer ftm;
3640 * struct cfg80211_pmsr_request - peer measurement request
3641 * @cookie: cookie, set by cfg80211
3642 * @nl_portid: netlink portid - used by cfg80211
3643 * @drv_data: driver data for this request, if required for aborting,
3644 * not otherwise freed or anything by cfg80211
3645 * @mac_addr: MAC address used for (randomised) request
3646 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3647 * are 0 in the mask should be randomised, bits that are 1 should
3648 * be taken from the @mac_addr
3649 * @list: used by cfg80211 to hold on to the request
3650 * @timeout: timeout (in milliseconds) for the whole operation, if
3651 * zero it means there's no timeout
3652 * @n_peers: number of peers to do measurements with
3653 * @peers: per-peer measurement request data
3655 struct cfg80211_pmsr_request {
3663 u8 mac_addr[ETH_ALEN] __aligned(2);
3664 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3666 struct list_head list;
3668 struct cfg80211_pmsr_request_peer peers[];
3672 * struct cfg80211_update_owe_info - OWE Information
3674 * This structure provides information needed for the drivers to offload OWE
3675 * (Opportunistic Wireless Encryption) processing to the user space.
3677 * Commonly used across update_owe_info request and event interfaces.
3679 * @peer: MAC address of the peer device for which the OWE processing
3681 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3682 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3683 * cannot give you the real status code for failures. Used only for
3684 * OWE update request command interface (user space to driver).
3685 * @ie: IEs obtained from the peer or constructed by the user space. These are
3686 * the IEs of the remote peer in the event from the host driver and
3687 * the constructed IEs by the user space in the request interface.
3688 * @ie_len: Length of IEs in octets.
3690 struct cfg80211_update_owe_info {
3691 u8 peer[ETH_ALEN] __aligned(2);
3698 * struct mgmt_frame_regs - management frame registrations data
3699 * @global_stypes: bitmap of management frame subtypes registered
3700 * for the entire device
3701 * @interface_stypes: bitmap of management frame subtypes registered
3702 * for the given interface
3703 * @global_mcast_rx: mcast RX is needed globally for these subtypes
3704 * @interface_mcast_stypes: mcast RX is needed on this interface
3705 * for these subtypes
3707 struct mgmt_frame_regs {
3708 u32 global_stypes, interface_stypes;
3709 u32 global_mcast_stypes, interface_mcast_stypes;
3713 * struct cfg80211_ops - backend description for wireless configuration
3715 * This struct is registered by fullmac card drivers and/or wireless stacks
3716 * in order to handle configuration requests on their interfaces.
3718 * All callbacks except where otherwise noted should return 0
3719 * on success or a negative error code.
3721 * All operations are invoked with the wiphy mutex held. The RTNL may be
3722 * held in addition (due to wireless extensions) but this cannot be relied
3723 * upon except in cases where documented below. Note that due to ordering,
3724 * the RTNL also cannot be acquired in any handlers.
3726 * @suspend: wiphy device needs to be suspended. The variable @wow will
3727 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3728 * configured for the device.
3729 * @resume: wiphy device needs to be resumed
3730 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3731 * to call device_set_wakeup_enable() to enable/disable wakeup from
3734 * @add_virtual_intf: create a new virtual interface with the given name,
3735 * must set the struct wireless_dev's iftype. Beware: You must create
3736 * the new netdev in the wiphy's network namespace! Returns the struct
3737 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3738 * also set the address member in the wdev.
3739 * This additionally holds the RTNL to be able to do netdev changes.
3741 * @del_virtual_intf: remove the virtual interface
3742 * This additionally holds the RTNL to be able to do netdev changes.
3744 * @change_virtual_intf: change type/configuration of virtual interface,
3745 * keep the struct wireless_dev's iftype updated.
3746 * This additionally holds the RTNL to be able to do netdev changes.
3748 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3749 * when adding a group key.
3751 * @get_key: get information about the key with the given parameters.
3752 * @mac_addr will be %NULL when requesting information for a group
3753 * key. All pointers given to the @callback function need not be valid
3754 * after it returns. This function should return an error if it is
3755 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3757 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3758 * and @key_index, return -ENOENT if the key doesn't exist.
3760 * @set_default_key: set the default key on an interface
3762 * @set_default_mgmt_key: set the default management frame key on an interface
3764 * @set_default_beacon_key: set the default Beacon frame key on an interface
3766 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3768 * @start_ap: Start acting in AP mode defined by the parameters.
3769 * @change_beacon: Change the beacon parameters for an access point mode
3770 * interface. This should reject the call when AP mode wasn't started.
3771 * @stop_ap: Stop being an AP, including stopping beaconing.
3773 * @add_station: Add a new station.
3774 * @del_station: Remove a station
3775 * @change_station: Modify a given station. Note that flags changes are not much
3776 * validated in cfg80211, in particular the auth/assoc/authorized flags
3777 * might come to the driver in invalid combinations -- make sure to check
3778 * them, also against the existing state! Drivers must call
3779 * cfg80211_check_station_change() to validate the information.
3780 * @get_station: get station information for the station identified by @mac
3781 * @dump_station: dump station callback -- resume dump at index @idx
3783 * @add_mpath: add a fixed mesh path
3784 * @del_mpath: delete a given mesh path
3785 * @change_mpath: change a given mesh path
3786 * @get_mpath: get a mesh path for the given parameters
3787 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3788 * @get_mpp: get a mesh proxy path for the given parameters
3789 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3790 * @join_mesh: join the mesh network with the specified parameters
3791 * (invoked with the wireless_dev mutex held)
3792 * @leave_mesh: leave the current mesh network
3793 * (invoked with the wireless_dev mutex held)
3795 * @get_mesh_config: Get the current mesh configuration
3797 * @update_mesh_config: Update mesh parameters on a running mesh.
3798 * The mask is a bitfield which tells us which parameters to
3799 * set, and which to leave alone.
3801 * @change_bss: Modify parameters for a given BSS.
3803 * @set_txq_params: Set TX queue parameters
3805 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3806 * as it doesn't implement join_mesh and needs to set the channel to
3807 * join the mesh instead.
3809 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3810 * interfaces are active this callback should reject the configuration.
3811 * If no interfaces are active or the device is down, the channel should
3812 * be stored for when a monitor interface becomes active.
3814 * @scan: Request to do a scan. If returning zero, the scan request is given
3815 * the driver, and will be valid until passed to cfg80211_scan_done().
3816 * For scan results, call cfg80211_inform_bss(); you can call this outside
3817 * the scan/scan_done bracket too.
3818 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3819 * indicate the status of the scan through cfg80211_scan_done().
3821 * @auth: Request to authenticate with the specified peer
3822 * (invoked with the wireless_dev mutex held)
3823 * @assoc: Request to (re)associate with the specified peer
3824 * (invoked with the wireless_dev mutex held)
3825 * @deauth: Request to deauthenticate from the specified peer
3826 * (invoked with the wireless_dev mutex held)
3827 * @disassoc: Request to disassociate from the specified peer
3828 * (invoked with the wireless_dev mutex held)
3830 * @connect: Connect to the ESS with the specified parameters. When connected,
3831 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3832 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3833 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3834 * from the AP or cfg80211_connect_timeout() if no frame with status code
3836 * The driver is allowed to roam to other BSSes within the ESS when the
3837 * other BSS matches the connect parameters. When such roaming is initiated
3838 * by the driver, the driver is expected to verify that the target matches
3839 * the configured security parameters and to use Reassociation Request
3840 * frame instead of Association Request frame.
3841 * The connect function can also be used to request the driver to perform a
3842 * specific roam when connected to an ESS. In that case, the prev_bssid
3843 * parameter is set to the BSSID of the currently associated BSS as an
3844 * indication of requesting reassociation.
3845 * In both the driver-initiated and new connect() call initiated roaming
3846 * cases, the result of roaming is indicated with a call to
3847 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3848 * @update_connect_params: Update the connect parameters while connected to a
3849 * BSS. The updated parameters can be used by driver/firmware for
3850 * subsequent BSS selection (roaming) decisions and to form the
3851 * Authentication/(Re)Association Request frames. This call does not
3852 * request an immediate disassociation or reassociation with the current
3853 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3854 * changed are defined in &enum cfg80211_connect_params_changed.
3855 * (invoked with the wireless_dev mutex held)
3856 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3857 * connection is in progress. Once done, call cfg80211_disconnected() in
3858 * case connection was already established (invoked with the
3859 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3861 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3862 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3864 * (invoked with the wireless_dev mutex held)
3865 * @leave_ibss: Leave the IBSS.
3866 * (invoked with the wireless_dev mutex held)
3868 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3871 * @set_wiphy_params: Notify that wiphy parameters have changed;
3872 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3873 * have changed. The actual parameter values are available in
3874 * struct wiphy. If returning an error, no value should be changed.
3876 * @set_tx_power: set the transmit power according to the parameters,
3877 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3878 * wdev may be %NULL if power was set for the wiphy, and will
3879 * always be %NULL unless the driver supports per-vif TX power
3880 * (as advertised by the nl80211 feature flag.)
3881 * @get_tx_power: store the current TX power into the dbm variable;
3882 * return 0 if successful
3884 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3885 * functions to adjust rfkill hw state
3887 * @dump_survey: get site survey information.
3889 * @remain_on_channel: Request the driver to remain awake on the specified
3890 * channel for the specified duration to complete an off-channel
3891 * operation (e.g., public action frame exchange). When the driver is
3892 * ready on the requested channel, it must indicate this with an event
3893 * notification by calling cfg80211_ready_on_channel().
3894 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3895 * This allows the operation to be terminated prior to timeout based on
3896 * the duration value.
3897 * @mgmt_tx: Transmit a management frame.
3898 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3899 * frame on another channel
3901 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3902 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3903 * used by the function, but 0 and 1 must not be touched. Additionally,
3904 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3905 * dump and return to userspace with an error, so be careful. If any data
3906 * was passed in from userspace then the data/len arguments will be present
3907 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3909 * @set_bitrate_mask: set the bitrate mask configuration
3911 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3912 * devices running firmwares capable of generating the (re) association
3913 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3914 * @del_pmksa: Delete a cached PMKID.
3915 * @flush_pmksa: Flush all cached PMKIDs.
3916 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3917 * allows the driver to adjust the dynamic ps timeout value.
3918 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3919 * After configuration, the driver should (soon) send an event indicating
3920 * the current level is above/below the configured threshold; this may
3921 * need some care when the configuration is changed (without first being
3923 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3924 * connection quality monitor. An event is to be sent only when the
3925 * signal level is found to be outside the two values. The driver should
3926 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3927 * If it is provided then there's no point providing @set_cqm_rssi_config.
3928 * @set_cqm_txe_config: Configure connection quality monitor TX error
3930 * @sched_scan_start: Tell the driver to start a scheduled scan.
3931 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3932 * given request id. This call must stop the scheduled scan and be ready
3933 * for starting a new one before it returns, i.e. @sched_scan_start may be
3934 * called immediately after that again and should not fail in that case.
3935 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3936 * stop (when this method returns 0).
3938 * @update_mgmt_frame_registrations: Notify the driver that management frame
3939 * registrations were updated. The callback is allowed to sleep.
3941 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3942 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3943 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3944 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3946 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3948 * @tdls_mgmt: Transmit a TDLS management frame.
3949 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3951 * @probe_client: probe an associated client, must return a cookie that it
3952 * later passes to cfg80211_probe_status().
3954 * @set_noack_map: Set the NoAck Map for the TIDs.
3956 * @get_channel: Get the current operating channel for the virtual interface.
3957 * For monitor interfaces, it should return %NULL unless there's a single
3958 * current monitoring channel.
3960 * @start_p2p_device: Start the given P2P device.
3961 * @stop_p2p_device: Stop the given P2P device.
3963 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3964 * Parameters include ACL policy, an array of MAC address of stations
3965 * and the number of MAC addresses. If there is already a list in driver
3966 * this new list replaces the existing one. Driver has to clear its ACL
3967 * when number of MAC addresses entries is passed as 0. Drivers which
3968 * advertise the support for MAC based ACL have to implement this callback.
3970 * @start_radar_detection: Start radar detection in the driver.
3972 * @end_cac: End running CAC, probably because a related CAC
3973 * was finished on another phy.
3975 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3976 * driver. If the SME is in the driver/firmware, this information can be
3977 * used in building Authentication and Reassociation Request frames.
3979 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3980 * for a given duration (milliseconds). The protocol is provided so the
3981 * driver can take the most appropriate actions.
3982 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3983 * reliability. This operation can not fail.
3984 * @set_coalesce: Set coalesce parameters.
3986 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3987 * responsible for veryfing if the switch is possible. Since this is
3988 * inherently tricky driver may decide to disconnect an interface later
3989 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3990 * everything. It should do it's best to verify requests and reject them
3991 * as soon as possible.
3993 * @set_qos_map: Set QoS mapping information to the driver
3995 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3996 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3997 * changes during the lifetime of the BSS.
3999 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
4000 * with the given parameters; action frame exchange has been handled by
4001 * userspace so this just has to modify the TX path to take the TS into
4003 * If the admitted time is 0 just validate the parameters to make sure
4004 * the session can be created at all; it is valid to just always return
4005 * success for that but that may result in inefficient behaviour (handshake
4006 * with the peer followed by immediate teardown when the addition is later
4008 * @del_tx_ts: remove an existing TX TS
4010 * @join_ocb: join the OCB network with the specified parameters
4011 * (invoked with the wireless_dev mutex held)
4012 * @leave_ocb: leave the current OCB network
4013 * (invoked with the wireless_dev mutex held)
4015 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4016 * is responsible for continually initiating channel-switching operations
4017 * and returning to the base channel for communication with the AP.
4018 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4019 * peers must be on the base channel when the call completes.
4020 * @start_nan: Start the NAN interface.
4021 * @stop_nan: Stop the NAN interface.
4022 * @add_nan_func: Add a NAN function. Returns negative value on failure.
4023 * On success @nan_func ownership is transferred to the driver and
4024 * it may access it outside of the scope of this function. The driver
4025 * should free the @nan_func when no longer needed by calling
4026 * cfg80211_free_nan_func().
4027 * On success the driver should assign an instance_id in the
4028 * provided @nan_func.
4029 * @del_nan_func: Delete a NAN function.
4030 * @nan_change_conf: changes NAN configuration. The changed parameters must
4031 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
4032 * All other parameters must be ignored.
4034 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
4036 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
4037 * function should return phy stats, and interface stats otherwise.
4039 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
4040 * If not deleted through @del_pmk the PMK remains valid until disconnect
4041 * upon which the driver should clear it.
4042 * (invoked with the wireless_dev mutex held)
4043 * @del_pmk: delete the previously configured PMK for the given authenticator.
4044 * (invoked with the wireless_dev mutex held)
4046 * @external_auth: indicates result of offloaded authentication processing from
4049 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
4050 * tells the driver that the frame should not be encrypted.
4052 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4053 * Statistics should be cumulative, currently no way to reset is provided.
4054 * @start_pmsr: start peer measurement (e.g. FTM)
4055 * @abort_pmsr: abort peer measurement
4057 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
4058 * but offloading OWE processing to the user space will get the updated
4059 * DH IE through this interface.
4061 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
4062 * and overrule HWMP path selection algorithm.
4063 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
4064 * This callback may sleep.
4065 * @reset_tid_config: Reset TID specific configuration for the peer, for the
4066 * given TIDs. This callback may sleep.
4068 * @set_sar_specs: Update the SAR (TX power) settings.
4070 * @color_change: Initiate a color change.
4072 * @set_fils_aad: Set FILS AAD data to the AP driver so that the driver can use
4073 * those to decrypt (Re)Association Request and encrypt (Re)Association
4076 * @set_radar_offchan: Configure dedicated offchannel chain available for
4077 * radar/CAC detection on some hw. This chain can't be used to transmit
4078 * or receive frames and it is bounded to a running wdev.
4079 * Offchannel radar/CAC detection allows to avoid the CAC downtime
4080 * switching to a different channel during CAC detection on the selected
4082 * The caller is expected to set chandef pointer to NULL in order to
4083 * disable offchannel CAC/radar detection.
4085 struct cfg80211_ops {
4086 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
4087 int (*resume)(struct wiphy *wiphy);
4088 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
4090 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
4092 unsigned char name_assign_type,
4093 enum nl80211_iftype type,
4094 struct vif_params *params);
4095 int (*del_virtual_intf)(struct wiphy *wiphy,
4096 struct wireless_dev *wdev);
4097 int (*change_virtual_intf)(struct wiphy *wiphy,
4098 struct net_device *dev,
4099 enum nl80211_iftype type,
4100 struct vif_params *params);
4102 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4103 u8 key_index, bool pairwise, const u8 *mac_addr,
4104 struct key_params *params);
4105 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4106 u8 key_index, bool pairwise, const u8 *mac_addr,
4108 void (*callback)(void *cookie, struct key_params*));
4109 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4110 u8 key_index, bool pairwise, const u8 *mac_addr);
4111 int (*set_default_key)(struct wiphy *wiphy,
4112 struct net_device *netdev,
4113 u8 key_index, bool unicast, bool multicast);
4114 int (*set_default_mgmt_key)(struct wiphy *wiphy,
4115 struct net_device *netdev,
4117 int (*set_default_beacon_key)(struct wiphy *wiphy,
4118 struct net_device *netdev,
4121 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4122 struct cfg80211_ap_settings *settings);
4123 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4124 struct cfg80211_beacon_data *info);
4125 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
4128 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
4130 struct station_parameters *params);
4131 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
4132 struct station_del_parameters *params);
4133 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
4135 struct station_parameters *params);
4136 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
4137 const u8 *mac, struct station_info *sinfo);
4138 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4139 int idx, u8 *mac, struct station_info *sinfo);
4141 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4142 const u8 *dst, const u8 *next_hop);
4143 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4145 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4146 const u8 *dst, const u8 *next_hop);
4147 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4148 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4149 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4150 int idx, u8 *dst, u8 *next_hop,
4151 struct mpath_info *pinfo);
4152 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4153 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4154 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4155 int idx, u8 *dst, u8 *mpp,
4156 struct mpath_info *pinfo);
4157 int (*get_mesh_config)(struct wiphy *wiphy,
4158 struct net_device *dev,
4159 struct mesh_config *conf);
4160 int (*update_mesh_config)(struct wiphy *wiphy,
4161 struct net_device *dev, u32 mask,
4162 const struct mesh_config *nconf);
4163 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4164 const struct mesh_config *conf,
4165 const struct mesh_setup *setup);
4166 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4168 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4169 struct ocb_setup *setup);
4170 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4172 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4173 struct bss_parameters *params);
4175 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4176 struct ieee80211_txq_params *params);
4178 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4179 struct net_device *dev,
4180 struct ieee80211_channel *chan);
4182 int (*set_monitor_channel)(struct wiphy *wiphy,
4183 struct cfg80211_chan_def *chandef);
4185 int (*scan)(struct wiphy *wiphy,
4186 struct cfg80211_scan_request *request);
4187 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4189 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4190 struct cfg80211_auth_request *req);
4191 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4192 struct cfg80211_assoc_request *req);
4193 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4194 struct cfg80211_deauth_request *req);
4195 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4196 struct cfg80211_disassoc_request *req);
4198 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4199 struct cfg80211_connect_params *sme);
4200 int (*update_connect_params)(struct wiphy *wiphy,
4201 struct net_device *dev,
4202 struct cfg80211_connect_params *sme,
4204 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4207 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4208 struct cfg80211_ibss_params *params);
4209 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4211 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4212 int rate[NUM_NL80211_BANDS]);
4214 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4216 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4217 enum nl80211_tx_power_setting type, int mbm);
4218 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4221 void (*rfkill_poll)(struct wiphy *wiphy);
4223 #ifdef CONFIG_NL80211_TESTMODE
4224 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4225 void *data, int len);
4226 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4227 struct netlink_callback *cb,
4228 void *data, int len);
4231 int (*set_bitrate_mask)(struct wiphy *wiphy,
4232 struct net_device *dev,
4234 const struct cfg80211_bitrate_mask *mask);
4236 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4237 int idx, struct survey_info *info);
4239 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4240 struct cfg80211_pmksa *pmksa);
4241 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4242 struct cfg80211_pmksa *pmksa);
4243 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4245 int (*remain_on_channel)(struct wiphy *wiphy,
4246 struct wireless_dev *wdev,
4247 struct ieee80211_channel *chan,
4248 unsigned int duration,
4250 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4251 struct wireless_dev *wdev,
4254 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4255 struct cfg80211_mgmt_tx_params *params,
4257 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4258 struct wireless_dev *wdev,
4261 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4262 bool enabled, int timeout);
4264 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4265 struct net_device *dev,
4266 s32 rssi_thold, u32 rssi_hyst);
4268 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4269 struct net_device *dev,
4270 s32 rssi_low, s32 rssi_high);
4272 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4273 struct net_device *dev,
4274 u32 rate, u32 pkts, u32 intvl);
4276 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4277 struct wireless_dev *wdev,
4278 struct mgmt_frame_regs *upd);
4280 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4281 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4283 int (*sched_scan_start)(struct wiphy *wiphy,
4284 struct net_device *dev,
4285 struct cfg80211_sched_scan_request *request);
4286 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4289 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4290 struct cfg80211_gtk_rekey_data *data);
4292 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4293 const u8 *peer, u8 action_code, u8 dialog_token,
4294 u16 status_code, u32 peer_capability,
4295 bool initiator, const u8 *buf, size_t len);
4296 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4297 const u8 *peer, enum nl80211_tdls_operation oper);
4299 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4300 const u8 *peer, u64 *cookie);
4302 int (*set_noack_map)(struct wiphy *wiphy,
4303 struct net_device *dev,
4306 int (*get_channel)(struct wiphy *wiphy,
4307 struct wireless_dev *wdev,
4308 struct cfg80211_chan_def *chandef);
4310 int (*start_p2p_device)(struct wiphy *wiphy,
4311 struct wireless_dev *wdev);
4312 void (*stop_p2p_device)(struct wiphy *wiphy,
4313 struct wireless_dev *wdev);
4315 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4316 const struct cfg80211_acl_data *params);
4318 int (*start_radar_detection)(struct wiphy *wiphy,
4319 struct net_device *dev,
4320 struct cfg80211_chan_def *chandef,
4322 void (*end_cac)(struct wiphy *wiphy,
4323 struct net_device *dev);
4324 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4325 struct cfg80211_update_ft_ies_params *ftie);
4326 int (*crit_proto_start)(struct wiphy *wiphy,
4327 struct wireless_dev *wdev,
4328 enum nl80211_crit_proto_id protocol,
4330 void (*crit_proto_stop)(struct wiphy *wiphy,
4331 struct wireless_dev *wdev);
4332 int (*set_coalesce)(struct wiphy *wiphy,
4333 struct cfg80211_coalesce *coalesce);
4335 int (*channel_switch)(struct wiphy *wiphy,
4336 struct net_device *dev,
4337 struct cfg80211_csa_settings *params);
4339 int (*set_qos_map)(struct wiphy *wiphy,
4340 struct net_device *dev,
4341 struct cfg80211_qos_map *qos_map);
4343 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4344 struct cfg80211_chan_def *chandef);
4346 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4347 u8 tsid, const u8 *peer, u8 user_prio,
4349 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4350 u8 tsid, const u8 *peer);
4352 int (*tdls_channel_switch)(struct wiphy *wiphy,
4353 struct net_device *dev,
4354 const u8 *addr, u8 oper_class,
4355 struct cfg80211_chan_def *chandef);
4356 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4357 struct net_device *dev,
4359 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4360 struct cfg80211_nan_conf *conf);
4361 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4362 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4363 struct cfg80211_nan_func *nan_func);
4364 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4366 int (*nan_change_conf)(struct wiphy *wiphy,
4367 struct wireless_dev *wdev,
4368 struct cfg80211_nan_conf *conf,
4371 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4372 struct net_device *dev,
4373 const bool enabled);
4375 int (*get_txq_stats)(struct wiphy *wiphy,
4376 struct wireless_dev *wdev,
4377 struct cfg80211_txq_stats *txqstats);
4379 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4380 const struct cfg80211_pmk_conf *conf);
4381 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4383 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4384 struct cfg80211_external_auth_params *params);
4386 int (*tx_control_port)(struct wiphy *wiphy,
4387 struct net_device *dev,
4388 const u8 *buf, size_t len,
4389 const u8 *dest, const __be16 proto,
4390 const bool noencrypt,
4393 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4394 struct net_device *dev,
4395 struct cfg80211_ftm_responder_stats *ftm_stats);
4397 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4398 struct cfg80211_pmsr_request *request);
4399 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4400 struct cfg80211_pmsr_request *request);
4401 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4402 struct cfg80211_update_owe_info *owe_info);
4403 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4404 const u8 *buf, size_t len);
4405 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4406 struct cfg80211_tid_config *tid_conf);
4407 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4408 const u8 *peer, u8 tids);
4409 int (*set_sar_specs)(struct wiphy *wiphy,
4410 struct cfg80211_sar_specs *sar);
4411 int (*color_change)(struct wiphy *wiphy,
4412 struct net_device *dev,
4413 struct cfg80211_color_change_settings *params);
4414 int (*set_fils_aad)(struct wiphy *wiphy, struct net_device *dev,
4415 struct cfg80211_fils_aad *fils_aad);
4416 int (*set_radar_offchan)(struct wiphy *wiphy,
4417 struct cfg80211_chan_def *chandef);
4421 * wireless hardware and networking interfaces structures
4422 * and registration/helper functions
4426 * enum wiphy_flags - wiphy capability flags
4428 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4429 * into two, first for legacy bands and second for UHB.
4430 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4432 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4433 * by default -- this flag will be set depending on the kernel's default
4434 * on wiphy_new(), but can be changed by the driver if it has a good
4435 * reason to override the default
4436 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4437 * on a VLAN interface). This flag also serves an extra purpose of
4438 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4439 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4440 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4441 * control port protocol ethertype. The device also honours the
4442 * control_port_no_encrypt flag.
4443 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4444 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4445 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4446 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4448 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4449 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4450 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4451 * link setup/discovery operations internally. Setup, discovery and
4452 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4453 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4454 * used for asking the driver/firmware to perform a TDLS operation.
4455 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4456 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4457 * when there are virtual interfaces in AP mode by calling
4458 * cfg80211_report_obss_beacon().
4459 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4460 * responds to probe-requests in hardware.
4461 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4462 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4463 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4464 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4465 * beaconing mode (AP, IBSS, Mesh, ...).
4466 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4467 * before connection.
4468 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4471 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4473 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4474 WIPHY_FLAG_NETNS_OK = BIT(3),
4475 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4476 WIPHY_FLAG_4ADDR_AP = BIT(5),
4477 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4478 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4479 WIPHY_FLAG_IBSS_RSN = BIT(8),
4480 WIPHY_FLAG_MESH_AUTH = BIT(10),
4481 /* use hole at 11 */
4482 /* use hole at 12 */
4483 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4484 WIPHY_FLAG_AP_UAPSD = BIT(14),
4485 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4486 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4487 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4488 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4489 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4490 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4491 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4492 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4493 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4494 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4498 * struct ieee80211_iface_limit - limit on certain interface types
4499 * @max: maximum number of interfaces of these types
4500 * @types: interface types (bits)
4502 struct ieee80211_iface_limit {
4508 * struct ieee80211_iface_combination - possible interface combination
4510 * With this structure the driver can describe which interface
4511 * combinations it supports concurrently.
4515 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4519 * struct ieee80211_iface_limit limits1[] = {
4520 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4521 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4523 * struct ieee80211_iface_combination combination1 = {
4524 * .limits = limits1,
4525 * .n_limits = ARRAY_SIZE(limits1),
4526 * .max_interfaces = 2,
4527 * .beacon_int_infra_match = true,
4531 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4535 * struct ieee80211_iface_limit limits2[] = {
4536 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4537 * BIT(NL80211_IFTYPE_P2P_GO), },
4539 * struct ieee80211_iface_combination combination2 = {
4540 * .limits = limits2,
4541 * .n_limits = ARRAY_SIZE(limits2),
4542 * .max_interfaces = 8,
4543 * .num_different_channels = 1,
4547 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4549 * This allows for an infrastructure connection and three P2P connections.
4553 * struct ieee80211_iface_limit limits3[] = {
4554 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4555 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4556 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4558 * struct ieee80211_iface_combination combination3 = {
4559 * .limits = limits3,
4560 * .n_limits = ARRAY_SIZE(limits3),
4561 * .max_interfaces = 4,
4562 * .num_different_channels = 2,
4566 struct ieee80211_iface_combination {
4569 * limits for the given interface types
4571 const struct ieee80211_iface_limit *limits;
4574 * @num_different_channels:
4575 * can use up to this many different channels
4577 u32 num_different_channels;
4581 * maximum number of interfaces in total allowed in this group
4587 * number of limitations
4592 * @beacon_int_infra_match:
4593 * In this combination, the beacon intervals between infrastructure
4594 * and AP types must match. This is required only in special cases.
4596 bool beacon_int_infra_match;
4599 * @radar_detect_widths:
4600 * bitmap of channel widths supported for radar detection
4602 u8 radar_detect_widths;
4605 * @radar_detect_regions:
4606 * bitmap of regions supported for radar detection
4608 u8 radar_detect_regions;
4611 * @beacon_int_min_gcd:
4612 * This interface combination supports different beacon intervals.
4615 * all beacon intervals for different interface must be same.
4617 * any beacon interval for the interface part of this combination AND
4618 * GCD of all beacon intervals from beaconing interfaces of this
4619 * combination must be greater or equal to this value.
4621 u32 beacon_int_min_gcd;
4624 struct ieee80211_txrx_stypes {
4629 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4630 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4631 * trigger that keeps the device operating as-is and
4632 * wakes up the host on any activity, for example a
4633 * received packet that passed filtering; note that the
4634 * packet should be preserved in that case
4635 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4637 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4638 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4639 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4640 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4641 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4642 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4643 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4645 enum wiphy_wowlan_support_flags {
4646 WIPHY_WOWLAN_ANY = BIT(0),
4647 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4648 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4649 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4650 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4651 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4652 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4653 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4654 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4657 struct wiphy_wowlan_tcp_support {
4658 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4659 u32 data_payload_max;
4660 u32 data_interval_max;
4661 u32 wake_payload_max;
4666 * struct wiphy_wowlan_support - WoWLAN support data
4667 * @flags: see &enum wiphy_wowlan_support_flags
4668 * @n_patterns: number of supported wakeup patterns
4669 * (see nl80211.h for the pattern definition)
4670 * @pattern_max_len: maximum length of each pattern
4671 * @pattern_min_len: minimum length of each pattern
4672 * @max_pkt_offset: maximum Rx packet offset
4673 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4674 * similar, but not necessarily identical, to max_match_sets for
4676 * See &struct cfg80211_sched_scan_request.@match_sets for more
4678 * @tcp: TCP wakeup support information
4680 struct wiphy_wowlan_support {
4683 int pattern_max_len;
4684 int pattern_min_len;
4686 int max_nd_match_sets;
4687 const struct wiphy_wowlan_tcp_support *tcp;
4691 * struct wiphy_coalesce_support - coalesce support data
4692 * @n_rules: maximum number of coalesce rules
4693 * @max_delay: maximum supported coalescing delay in msecs
4694 * @n_patterns: number of supported patterns in a rule
4695 * (see nl80211.h for the pattern definition)
4696 * @pattern_max_len: maximum length of each pattern
4697 * @pattern_min_len: minimum length of each pattern
4698 * @max_pkt_offset: maximum Rx packet offset
4700 struct wiphy_coalesce_support {
4704 int pattern_max_len;
4705 int pattern_min_len;
4710 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4711 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4712 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4713 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4714 * (must be combined with %_WDEV or %_NETDEV)
4716 enum wiphy_vendor_command_flags {
4717 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4718 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4719 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4723 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4725 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4726 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4727 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4730 enum wiphy_opmode_flag {
4731 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4732 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4733 STA_OPMODE_N_SS_CHANGED = BIT(2),
4737 * struct sta_opmode_info - Station's ht/vht operation mode information
4738 * @changed: contains value from &enum wiphy_opmode_flag
4739 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4740 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4741 * @rx_nss: new rx_nss value of a station
4744 struct sta_opmode_info {
4746 enum nl80211_smps_mode smps_mode;
4747 enum nl80211_chan_width bw;
4751 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4754 * struct wiphy_vendor_command - vendor command definition
4755 * @info: vendor command identifying information, as used in nl80211
4756 * @flags: flags, see &enum wiphy_vendor_command_flags
4757 * @doit: callback for the operation, note that wdev is %NULL if the
4758 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4759 * pointer may be %NULL if userspace provided no data at all
4760 * @dumpit: dump callback, for transferring bigger/multiple items. The
4761 * @storage points to cb->args[5], ie. is preserved over the multiple
4763 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4764 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4765 * attribute is just raw data (e.g. a firmware command).
4766 * @maxattr: highest attribute number in policy
4767 * It's recommended to not have the same sub command with both @doit and
4768 * @dumpit, so that userspace can assume certain ones are get and others
4769 * are used with dump requests.
4771 struct wiphy_vendor_command {
4772 struct nl80211_vendor_cmd_info info;
4774 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4775 const void *data, int data_len);
4776 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4777 struct sk_buff *skb, const void *data, int data_len,
4778 unsigned long *storage);
4779 const struct nla_policy *policy;
4780 unsigned int maxattr;
4784 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4785 * @iftype: interface type
4786 * @extended_capabilities: extended capabilities supported by the driver,
4787 * additional capabilities might be supported by userspace; these are the
4788 * 802.11 extended capabilities ("Extended Capabilities element") and are
4789 * in the same format as in the information element. See IEEE Std
4790 * 802.11-2012 8.4.2.29 for the defined fields.
4791 * @extended_capabilities_mask: mask of the valid values
4792 * @extended_capabilities_len: length of the extended capabilities
4794 struct wiphy_iftype_ext_capab {
4795 enum nl80211_iftype iftype;
4796 const u8 *extended_capabilities;
4797 const u8 *extended_capabilities_mask;
4798 u8 extended_capabilities_len;
4802 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4803 * @max_peers: maximum number of peers in a single measurement
4804 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4805 * @randomize_mac_addr: can randomize MAC address for measurement
4806 * @ftm.supported: FTM measurement is supported
4807 * @ftm.asap: ASAP-mode is supported
4808 * @ftm.non_asap: non-ASAP-mode is supported
4809 * @ftm.request_lci: can request LCI data
4810 * @ftm.request_civicloc: can request civic location data
4811 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4812 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4813 * @ftm.max_bursts_exponent: maximum burst exponent supported
4814 * (set to -1 if not limited; note that setting this will necessarily
4815 * forbid using the value 15 to let the responder pick)
4816 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4818 * @ftm.trigger_based: trigger based ranging measurement is supported
4819 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
4821 struct cfg80211_pmsr_capabilities {
4822 unsigned int max_peers;
4824 randomize_mac_addr:1;
4829 s8 max_bursts_exponent;
4830 u8 max_ftms_per_burst;
4837 non_trigger_based:1;
4842 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4843 * suites for interface types defined in @iftypes_mask. Each type in the
4844 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4846 * @iftypes_mask: bitmask of interfaces types
4847 * @akm_suites: points to an array of supported akm suites
4848 * @n_akm_suites: number of supported AKM suites
4850 struct wiphy_iftype_akm_suites {
4852 const u32 *akm_suites;
4857 * struct wiphy - wireless hardware description
4858 * @mtx: mutex for the data (structures) of this device
4859 * @reg_notifier: the driver's regulatory notification callback,
4860 * note that if your driver uses wiphy_apply_custom_regulatory()
4861 * the reg_notifier's request can be passed as NULL
4862 * @regd: the driver's regulatory domain, if one was requested via
4863 * the regulatory_hint() API. This can be used by the driver
4864 * on the reg_notifier() if it chooses to ignore future
4865 * regulatory domain changes caused by other drivers.
4866 * @signal_type: signal type reported in &struct cfg80211_bss.
4867 * @cipher_suites: supported cipher suites
4868 * @n_cipher_suites: number of supported cipher suites
4869 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4870 * the supported AKMs not advertized for a specific interface type in
4871 * iftype_akm_suites.
4872 * @n_akm_suites: number of supported AKM suites
4873 * @iftype_akm_suites: array of supported akm suites info per interface type.
4874 * Note that the bits in @iftypes_mask inside this structure cannot
4875 * overlap (i.e. only one occurrence of each type is allowed across all
4876 * instances of iftype_akm_suites).
4877 * @num_iftype_akm_suites: number of interface types for which supported akm
4878 * suites are specified separately.
4879 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4880 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4881 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4882 * -1 = fragmentation disabled, only odd values >= 256 used
4883 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4884 * @_net: the network namespace this wiphy currently lives in
4885 * @perm_addr: permanent MAC address of this device
4886 * @addr_mask: If the device supports multiple MAC addresses by masking,
4887 * set this to a mask with variable bits set to 1, e.g. if the last
4888 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4889 * variable bits shall be determined by the interfaces added, with
4890 * interfaces not matching the mask being rejected to be brought up.
4891 * @n_addresses: number of addresses in @addresses.
4892 * @addresses: If the device has more than one address, set this pointer
4893 * to a list of addresses (6 bytes each). The first one will be used
4894 * by default for perm_addr. In this case, the mask should be set to
4895 * all-zeroes. In this case it is assumed that the device can handle
4896 * the same number of arbitrary MAC addresses.
4897 * @registered: protects ->resume and ->suspend sysfs callbacks against
4898 * unregister hardware
4899 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4900 * It will be renamed automatically on wiphy renames
4901 * @dev: (virtual) struct device for this wiphy. The item in
4902 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4904 * @wext: wireless extension handlers
4905 * @priv: driver private data (sized according to wiphy_new() parameter)
4906 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4907 * must be set by driver
4908 * @iface_combinations: Valid interface combinations array, should not
4909 * list single interface types.
4910 * @n_iface_combinations: number of entries in @iface_combinations array.
4911 * @software_iftypes: bitmask of software interface types, these are not
4912 * subject to any restrictions since they are purely managed in SW.
4913 * @flags: wiphy flags, see &enum wiphy_flags
4914 * @regulatory_flags: wiphy regulatory flags, see
4915 * &enum ieee80211_regulatory_flags
4916 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4917 * @ext_features: extended features advertised to nl80211, see
4918 * &enum nl80211_ext_feature_index.
4919 * @bss_priv_size: each BSS struct has private data allocated with it,
4920 * this variable determines its size
4921 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4923 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4924 * the device can run concurrently.
4925 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4926 * for in any given scheduled scan
4927 * @max_match_sets: maximum number of match sets the device can handle
4928 * when performing a scheduled scan, 0 if filtering is not
4930 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4931 * add to probe request frames transmitted during a scan, must not
4932 * include fixed IEs like supported rates
4933 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4935 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4936 * of iterations) for scheduled scan supported by the device.
4937 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4938 * single scan plan supported by the device.
4939 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4940 * scan plan supported by the device.
4941 * @coverage_class: current coverage class
4942 * @fw_version: firmware version for ethtool reporting
4943 * @hw_version: hardware version for ethtool reporting
4944 * @max_num_pmkids: maximum number of PMKIDs supported by device
4945 * @privid: a pointer that drivers can use to identify if an arbitrary
4946 * wiphy is theirs, e.g. in global notifiers
4947 * @bands: information about bands/channels supported by this device
4949 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4950 * transmitted through nl80211, points to an array indexed by interface
4953 * @available_antennas_tx: bitmap of antennas which are available to be
4954 * configured as TX antennas. Antenna configuration commands will be
4955 * rejected unless this or @available_antennas_rx is set.
4957 * @available_antennas_rx: bitmap of antennas which are available to be
4958 * configured as RX antennas. Antenna configuration commands will be
4959 * rejected unless this or @available_antennas_tx is set.
4961 * @probe_resp_offload:
4962 * Bitmap of supported protocols for probe response offloading.
4963 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4964 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4966 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4967 * may request, if implemented.
4969 * @wowlan: WoWLAN support information
4970 * @wowlan_config: current WoWLAN configuration; this should usually not be
4971 * used since access to it is necessarily racy, use the parameter passed
4972 * to the suspend() operation instead.
4974 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4975 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4976 * If null, then none can be over-ridden.
4977 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4978 * If null, then none can be over-ridden.
4980 * @wdev_list: the list of associated (virtual) interfaces; this list must
4981 * not be modified by the driver, but can be read with RTNL/RCU protection.
4983 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4986 * @extended_capabilities: extended capabilities supported by the driver,
4987 * additional capabilities might be supported by userspace; these are
4988 * the 802.11 extended capabilities ("Extended Capabilities element")
4989 * and are in the same format as in the information element. See
4990 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4991 * extended capabilities to be used if the capabilities are not specified
4992 * for a specific interface type in iftype_ext_capab.
4993 * @extended_capabilities_mask: mask of the valid values
4994 * @extended_capabilities_len: length of the extended capabilities
4995 * @iftype_ext_capab: array of extended capabilities per interface type
4996 * @num_iftype_ext_capab: number of interface types for which extended
4997 * capabilities are specified separately.
4998 * @coalesce: packet coalescing support information
5000 * @vendor_commands: array of vendor commands supported by the hardware
5001 * @n_vendor_commands: number of vendor commands
5002 * @vendor_events: array of vendor events supported by the hardware
5003 * @n_vendor_events: number of vendor events
5005 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
5006 * (including P2P GO) or 0 to indicate no such limit is advertised. The
5007 * driver is allowed to advertise a theoretical limit that it can reach in
5008 * some cases, but may not always reach.
5010 * @max_num_csa_counters: Number of supported csa_counters in beacons
5011 * and probe responses. This value should be set if the driver
5012 * wishes to limit the number of csa counters. Default (0) means
5014 * @bss_select_support: bitmask indicating the BSS selection criteria supported
5015 * by the driver in the .connect() callback. The bit position maps to the
5016 * attribute indices defined in &enum nl80211_bss_select_attr.
5018 * @nan_supported_bands: bands supported by the device in NAN mode, a
5019 * bitmap of &enum nl80211_band values. For instance, for
5020 * NL80211_BAND_2GHZ, bit 0 would be set
5021 * (i.e. BIT(NL80211_BAND_2GHZ)).
5023 * @txq_limit: configuration of internal TX queue frame limit
5024 * @txq_memory_limit: configuration internal TX queue memory limit
5025 * @txq_quantum: configuration of internal TX queue scheduler quantum
5027 * @tx_queue_len: allow setting transmit queue len for drivers not using
5030 * @support_mbssid: can HW support association with nontransmitted AP
5031 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
5032 * HE AP, in order to avoid compatibility issues.
5033 * @support_mbssid must be set for this to have any effect.
5035 * @pmsr_capa: peer measurement capabilities
5037 * @tid_config_support: describes the per-TID config support that the
5039 * @tid_config_support.vif: bitmap of attributes (configurations)
5040 * supported by the driver for each vif
5041 * @tid_config_support.peer: bitmap of attributes (configurations)
5042 * supported by the driver for each peer
5043 * @tid_config_support.max_retry: maximum supported retry count for
5044 * long/short retry configuration
5046 * @max_data_retry_count: maximum supported per TID retry count for
5047 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
5048 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
5049 * @sar_capa: SAR control capabilities
5050 * @rfkill: a pointer to the rfkill structure
5052 * @mbssid_max_interfaces: maximum number of interfaces supported by the driver
5053 * in a multiple BSSID set. This field must be set to a non-zero value
5054 * by the driver to advertise MBSSID support.
5055 * @ema_max_profile_periodicity: maximum profile periodicity supported by
5056 * the driver. Setting this field to a non-zero value indicates that the
5057 * driver supports enhanced multi-BSSID advertisements (EMA AP).
5062 /* assign these fields before you register the wiphy */
5064 u8 perm_addr[ETH_ALEN];
5065 u8 addr_mask[ETH_ALEN];
5067 struct mac_address *addresses;
5069 const struct ieee80211_txrx_stypes *mgmt_stypes;
5071 const struct ieee80211_iface_combination *iface_combinations;
5072 int n_iface_combinations;
5073 u16 software_iftypes;
5077 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
5078 u16 interface_modes;
5080 u16 max_acl_mac_addrs;
5082 u32 flags, regulatory_flags, features;
5083 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
5087 enum cfg80211_signal_type signal_type;
5091 u8 max_sched_scan_reqs;
5092 u8 max_sched_scan_ssids;
5094 u16 max_scan_ie_len;
5095 u16 max_sched_scan_ie_len;
5096 u32 max_sched_scan_plans;
5097 u32 max_sched_scan_plan_interval;
5098 u32 max_sched_scan_plan_iterations;
5100 int n_cipher_suites;
5101 const u32 *cipher_suites;
5104 const u32 *akm_suites;
5106 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
5107 unsigned int num_iftype_akm_suites;
5115 char fw_version[ETHTOOL_FWVERS_LEN];
5119 const struct wiphy_wowlan_support *wowlan;
5120 struct cfg80211_wowlan *wowlan_config;
5123 u16 max_remain_on_channel_duration;
5127 u32 available_antennas_tx;
5128 u32 available_antennas_rx;
5130 u32 probe_resp_offload;
5132 const u8 *extended_capabilities, *extended_capabilities_mask;
5133 u8 extended_capabilities_len;
5135 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5136 unsigned int num_iftype_ext_capab;
5140 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5142 void (*reg_notifier)(struct wiphy *wiphy,
5143 struct regulatory_request *request);
5145 /* fields below are read-only, assigned by cfg80211 */
5147 const struct ieee80211_regdomain __rcu *regd;
5153 struct dentry *debugfsdir;
5155 const struct ieee80211_ht_cap *ht_capa_mod_mask;
5156 const struct ieee80211_vht_cap *vht_capa_mod_mask;
5158 struct list_head wdev_list;
5160 possible_net_t _net;
5162 #ifdef CONFIG_CFG80211_WEXT
5163 const struct iw_handler_def *wext;
5166 const struct wiphy_coalesce_support *coalesce;
5168 const struct wiphy_vendor_command *vendor_commands;
5169 const struct nl80211_vendor_cmd_info *vendor_events;
5170 int n_vendor_commands, n_vendor_events;
5172 u16 max_ap_assoc_sta;
5174 u8 max_num_csa_counters;
5176 u32 bss_select_support;
5178 u8 nan_supported_bands;
5181 u32 txq_memory_limit;
5184 unsigned long tx_queue_len;
5186 u8 support_mbssid:1,
5187 support_only_he_mbssid:1;
5189 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5194 } tid_config_support;
5196 u8 max_data_retry_count;
5198 const struct cfg80211_sar_capa *sar_capa;
5200 struct rfkill *rfkill;
5202 u8 mbssid_max_interfaces;
5203 u8 ema_max_profile_periodicity;
5205 char priv[] __aligned(NETDEV_ALIGN);
5208 static inline struct net *wiphy_net(struct wiphy *wiphy)
5210 return read_pnet(&wiphy->_net);
5213 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5215 write_pnet(&wiphy->_net, net);
5219 * wiphy_priv - return priv from wiphy
5221 * @wiphy: the wiphy whose priv pointer to return
5222 * Return: The priv of @wiphy.
5224 static inline void *wiphy_priv(struct wiphy *wiphy)
5227 return &wiphy->priv;
5231 * priv_to_wiphy - return the wiphy containing the priv
5233 * @priv: a pointer previously returned by wiphy_priv
5234 * Return: The wiphy of @priv.
5236 static inline struct wiphy *priv_to_wiphy(void *priv)
5239 return container_of(priv, struct wiphy, priv);
5243 * set_wiphy_dev - set device pointer for wiphy
5245 * @wiphy: The wiphy whose device to bind
5246 * @dev: The device to parent it to
5248 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5250 wiphy->dev.parent = dev;
5254 * wiphy_dev - get wiphy dev pointer
5256 * @wiphy: The wiphy whose device struct to look up
5257 * Return: The dev of @wiphy.
5259 static inline struct device *wiphy_dev(struct wiphy *wiphy)
5261 return wiphy->dev.parent;
5265 * wiphy_name - get wiphy name
5267 * @wiphy: The wiphy whose name to return
5268 * Return: The name of @wiphy.
5270 static inline const char *wiphy_name(const struct wiphy *wiphy)
5272 return dev_name(&wiphy->dev);
5276 * wiphy_new_nm - create a new wiphy for use with cfg80211
5278 * @ops: The configuration operations for this device
5279 * @sizeof_priv: The size of the private area to allocate
5280 * @requested_name: Request a particular name.
5281 * NULL is valid value, and means use the default phy%d naming.
5283 * Create a new wiphy and associate the given operations with it.
5284 * @sizeof_priv bytes are allocated for private use.
5286 * Return: A pointer to the new wiphy. This pointer must be
5287 * assigned to each netdev's ieee80211_ptr for proper operation.
5289 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5290 const char *requested_name);
5293 * wiphy_new - create a new wiphy for use with cfg80211
5295 * @ops: The configuration operations for this device
5296 * @sizeof_priv: The size of the private area to allocate
5298 * Create a new wiphy and associate the given operations with it.
5299 * @sizeof_priv bytes are allocated for private use.
5301 * Return: A pointer to the new wiphy. This pointer must be
5302 * assigned to each netdev's ieee80211_ptr for proper operation.
5304 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5307 return wiphy_new_nm(ops, sizeof_priv, NULL);
5311 * wiphy_register - register a wiphy with cfg80211
5313 * @wiphy: The wiphy to register.
5315 * Return: A non-negative wiphy index or a negative error code.
5317 int wiphy_register(struct wiphy *wiphy);
5319 /* this is a define for better error reporting (file/line) */
5320 #define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
5323 * rcu_dereference_wiphy - rcu_dereference with debug checking
5324 * @wiphy: the wiphy to check the locking on
5325 * @p: The pointer to read, prior to dereferencing
5327 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
5328 * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
5330 #define rcu_dereference_wiphy(wiphy, p) \
5331 rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
5334 * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
5335 * @wiphy: the wiphy to check the locking on
5336 * @p: The pointer to read, prior to dereferencing
5338 * Return the value of the specified RCU-protected pointer, but omit the
5339 * READ_ONCE(), because caller holds the wiphy mutex used for updates.
5341 #define wiphy_dereference(wiphy, p) \
5342 rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
5345 * get_wiphy_regdom - get custom regdomain for the given wiphy
5346 * @wiphy: the wiphy to get the regdomain from
5348 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
5351 * wiphy_unregister - deregister a wiphy from cfg80211
5353 * @wiphy: The wiphy to unregister.
5355 * After this call, no more requests can be made with this priv
5356 * pointer, but the call may sleep to wait for an outstanding
5357 * request that is being handled.
5359 void wiphy_unregister(struct wiphy *wiphy);
5362 * wiphy_free - free wiphy
5364 * @wiphy: The wiphy to free
5366 void wiphy_free(struct wiphy *wiphy);
5368 /* internal structs */
5369 struct cfg80211_conn;
5370 struct cfg80211_internal_bss;
5371 struct cfg80211_cached_keys;
5372 struct cfg80211_cqm_config;
5375 * wiphy_lock - lock the wiphy
5376 * @wiphy: the wiphy to lock
5378 * This is mostly exposed so it can be done around registering and
5379 * unregistering netdevs that aren't created through cfg80211 calls,
5380 * since that requires locking in cfg80211 when the notifiers is
5381 * called, but that cannot differentiate which way it's called.
5383 * When cfg80211 ops are called, the wiphy is already locked.
5385 static inline void wiphy_lock(struct wiphy *wiphy)
5386 __acquires(&wiphy->mtx)
5388 mutex_lock(&wiphy->mtx);
5389 __acquire(&wiphy->mtx);
5393 * wiphy_unlock - unlock the wiphy again
5394 * @wiphy: the wiphy to unlock
5396 static inline void wiphy_unlock(struct wiphy *wiphy)
5397 __releases(&wiphy->mtx)
5399 __release(&wiphy->mtx);
5400 mutex_unlock(&wiphy->mtx);
5404 * struct wireless_dev - wireless device state
5406 * For netdevs, this structure must be allocated by the driver
5407 * that uses the ieee80211_ptr field in struct net_device (this
5408 * is intentional so it can be allocated along with the netdev.)
5409 * It need not be registered then as netdev registration will
5410 * be intercepted by cfg80211 to see the new wireless device,
5411 * however, drivers must lock the wiphy before registering or
5412 * unregistering netdevs if they pre-create any netdevs (in ops
5413 * called from cfg80211, the wiphy is already locked.)
5415 * For non-netdev uses, it must also be allocated by the driver
5416 * in response to the cfg80211 callbacks that require it, as
5417 * there's no netdev registration in that case it may not be
5418 * allocated outside of callback operations that return it.
5420 * @wiphy: pointer to hardware description
5421 * @iftype: interface type
5422 * @registered: is this wdev already registered with cfg80211
5423 * @registering: indicates we're doing registration under wiphy lock
5425 * @list: (private) Used to collect the interfaces
5426 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5427 * @identifier: (private) Identifier used in nl80211 to identify this
5428 * wireless device if it has no netdev
5429 * @current_bss: (private) Used by the internal configuration code
5430 * @chandef: (private) Used by the internal configuration code to track
5431 * the user-set channel definition.
5432 * @preset_chandef: (private) Used by the internal configuration code to
5433 * track the channel to be used for AP later
5434 * @bssid: (private) Used by the internal configuration code
5435 * @ssid: (private) Used by the internal configuration code
5436 * @ssid_len: (private) Used by the internal configuration code
5437 * @mesh_id_len: (private) Used by the internal configuration code
5438 * @mesh_id_up_len: (private) Used by the internal configuration code
5439 * @wext: (private) Used by the internal wireless extensions compat code
5440 * @wext.ibss: (private) IBSS data part of wext handling
5441 * @wext.connect: (private) connection handling data
5442 * @wext.keys: (private) (WEP) key data
5443 * @wext.ie: (private) extra elements for association
5444 * @wext.ie_len: (private) length of extra elements
5445 * @wext.bssid: (private) selected network BSSID
5446 * @wext.ssid: (private) selected network SSID
5447 * @wext.default_key: (private) selected default key index
5448 * @wext.default_mgmt_key: (private) selected default management key index
5449 * @wext.prev_bssid: (private) previous BSSID for reassociation
5450 * @wext.prev_bssid_valid: (private) previous BSSID validity
5451 * @use_4addr: indicates 4addr mode is used on this interface, must be
5452 * set by driver (if supported) on add_interface BEFORE registering the
5453 * netdev and may otherwise be used by driver read-only, will be update
5454 * by cfg80211 on change_interface
5455 * @mgmt_registrations: list of registrations for management frames
5456 * @mgmt_registrations_need_update: mgmt registrations were updated,
5457 * need to propagate the update to the driver
5458 * @mtx: mutex used to lock data in this struct, may be used by drivers
5459 * and some API functions require it held
5460 * @beacon_interval: beacon interval used on this device for transmitting
5461 * beacons, 0 when not valid
5462 * @address: The address for this device, valid only if @netdev is %NULL
5463 * @is_running: true if this is a non-netdev device that has been started, e.g.
5465 * @cac_started: true if DFS channel availability check has been started
5466 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5467 * @cac_time_ms: CAC time in ms
5468 * @ps: powersave mode is enabled
5469 * @ps_timeout: dynamic powersave timeout
5470 * @ap_unexpected_nlportid: (private) netlink port ID of application
5471 * registered for unexpected class 3 frames (AP mode)
5472 * @conn: (private) cfg80211 software SME connection state machine data
5473 * @connect_keys: (private) keys to set after connection is established
5474 * @conn_bss_type: connecting/connected BSS type
5475 * @conn_owner_nlportid: (private) connection owner socket port ID
5476 * @disconnect_wk: (private) auto-disconnect work
5477 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5478 * @ibss_fixed: (private) IBSS is using fixed BSSID
5479 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
5480 * @event_list: (private) list for internal event processing
5481 * @event_lock: (private) lock for event list
5482 * @owner_nlportid: (private) owner socket port ID
5483 * @nl_owner_dead: (private) owner socket went away
5484 * @cqm_config: (private) nl80211 RSSI monitor state
5485 * @pmsr_list: (private) peer measurement requests
5486 * @pmsr_lock: (private) peer measurements requests/results lock
5487 * @pmsr_free_wk: (private) peer measurements cleanup work
5488 * @unprot_beacon_reported: (private) timestamp of last
5489 * unprotected beacon report
5491 struct wireless_dev {
5492 struct wiphy *wiphy;
5493 enum nl80211_iftype iftype;
5495 /* the remainder of this struct should be private to cfg80211 */
5496 struct list_head list;
5497 struct net_device *netdev;
5501 struct list_head mgmt_registrations;
5502 u8 mgmt_registrations_need_update:1;
5506 bool use_4addr, is_running, registered, registering;
5508 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5510 /* currently used for IBSS and SME - might be rearranged later */
5511 u8 ssid[IEEE80211_MAX_SSID_LEN];
5512 u8 ssid_len, mesh_id_len, mesh_id_up_len;
5513 struct cfg80211_conn *conn;
5514 struct cfg80211_cached_keys *connect_keys;
5515 enum ieee80211_bss_type conn_bss_type;
5516 u32 conn_owner_nlportid;
5518 struct work_struct disconnect_wk;
5519 u8 disconnect_bssid[ETH_ALEN];
5521 struct list_head event_list;
5522 spinlock_t event_lock;
5524 struct cfg80211_internal_bss *current_bss; /* associated / joined */
5525 struct cfg80211_chan_def preset_chandef;
5526 struct cfg80211_chan_def chandef;
5529 bool ibss_dfs_possible;
5534 int beacon_interval;
5536 u32 ap_unexpected_nlportid;
5542 unsigned long cac_start_time;
5543 unsigned int cac_time_ms;
5545 #ifdef CONFIG_CFG80211_WEXT
5548 struct cfg80211_ibss_params ibss;
5549 struct cfg80211_connect_params connect;
5550 struct cfg80211_cached_keys *keys;
5554 u8 prev_bssid[ETH_ALEN];
5555 u8 ssid[IEEE80211_MAX_SSID_LEN];
5556 s8 default_key, default_mgmt_key;
5557 bool prev_bssid_valid;
5561 struct cfg80211_cqm_config *cqm_config;
5563 struct list_head pmsr_list;
5564 spinlock_t pmsr_lock;
5565 struct work_struct pmsr_free_wk;
5567 unsigned long unprot_beacon_reported;
5570 static inline const u8 *wdev_address(struct wireless_dev *wdev)
5573 return wdev->netdev->dev_addr;
5574 return wdev->address;
5577 static inline bool wdev_running(struct wireless_dev *wdev)
5580 return netif_running(wdev->netdev);
5581 return wdev->is_running;
5585 * wdev_priv - return wiphy priv from wireless_dev
5587 * @wdev: The wireless device whose wiphy's priv pointer to return
5588 * Return: The wiphy priv of @wdev.
5590 static inline void *wdev_priv(struct wireless_dev *wdev)
5593 return wiphy_priv(wdev->wiphy);
5597 * DOC: Utility functions
5599 * cfg80211 offers a number of utility functions that can be useful.
5603 * ieee80211_channel_equal - compare two struct ieee80211_channel
5605 * @a: 1st struct ieee80211_channel
5606 * @b: 2nd struct ieee80211_channel
5607 * Return: true if center frequency of @a == @b
5610 ieee80211_channel_equal(struct ieee80211_channel *a,
5611 struct ieee80211_channel *b)
5613 return (a->center_freq == b->center_freq &&
5614 a->freq_offset == b->freq_offset);
5618 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5619 * @chan: struct ieee80211_channel to convert
5620 * Return: The corresponding frequency (in KHz)
5623 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5625 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5629 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5631 * Only allowed for band NL80211_BAND_S1GHZ
5633 * Return: The allowed channel width for this center_freq
5635 enum nl80211_chan_width
5636 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5639 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5640 * @chan: channel number
5641 * @band: band, necessary due to channel number overlap
5642 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5644 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5647 * ieee80211_channel_to_frequency - convert channel number to frequency
5648 * @chan: channel number
5649 * @band: band, necessary due to channel number overlap
5650 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5653 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5655 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5659 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5660 * @freq: center frequency in KHz
5661 * Return: The corresponding channel, or 0 if the conversion failed.
5663 int ieee80211_freq_khz_to_channel(u32 freq);
5666 * ieee80211_frequency_to_channel - convert frequency to channel number
5667 * @freq: center frequency in MHz
5668 * Return: The corresponding channel, or 0 if the conversion failed.
5671 ieee80211_frequency_to_channel(int freq)
5673 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5677 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5679 * @wiphy: the struct wiphy to get the channel for
5680 * @freq: the center frequency (in KHz) of the channel
5681 * Return: The channel struct from @wiphy at @freq.
5683 struct ieee80211_channel *
5684 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5687 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5689 * @wiphy: the struct wiphy to get the channel for
5690 * @freq: the center frequency (in MHz) of the channel
5691 * Return: The channel struct from @wiphy at @freq.
5693 static inline struct ieee80211_channel *
5694 ieee80211_get_channel(struct wiphy *wiphy, int freq)
5696 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5700 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5701 * @chan: control channel to check
5703 * The Preferred Scanning Channels (PSC) are defined in
5704 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5706 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
5708 if (chan->band != NL80211_BAND_6GHZ)
5711 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
5715 * ieee80211_get_response_rate - get basic rate for a given rate
5717 * @sband: the band to look for rates in
5718 * @basic_rates: bitmap of basic rates
5719 * @bitrate: the bitrate for which to find the basic rate
5721 * Return: The basic rate corresponding to a given bitrate, that
5722 * is the next lower bitrate contained in the basic rate map,
5723 * which is, for this function, given as a bitmap of indices of
5724 * rates in the band's bitrate table.
5726 const struct ieee80211_rate *
5727 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5728 u32 basic_rates, int bitrate);
5731 * ieee80211_mandatory_rates - get mandatory rates for a given band
5732 * @sband: the band to look for rates in
5733 * @scan_width: width of the control channel
5735 * This function returns a bitmap of the mandatory rates for the given
5736 * band, bits are set according to the rate position in the bitrates array.
5738 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5739 enum nl80211_bss_scan_width scan_width);
5742 * Radiotap parsing functions -- for controlled injection support
5744 * Implemented in net/wireless/radiotap.c
5745 * Documentation in Documentation/networking/radiotap-headers.rst
5748 struct radiotap_align_size {
5749 uint8_t align:4, size:4;
5752 struct ieee80211_radiotap_namespace {
5753 const struct radiotap_align_size *align_size;
5759 struct ieee80211_radiotap_vendor_namespaces {
5760 const struct ieee80211_radiotap_namespace *ns;
5765 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5766 * @this_arg_index: index of current arg, valid after each successful call
5767 * to ieee80211_radiotap_iterator_next()
5768 * @this_arg: pointer to current radiotap arg; it is valid after each
5769 * call to ieee80211_radiotap_iterator_next() but also after
5770 * ieee80211_radiotap_iterator_init() where it will point to
5771 * the beginning of the actual data portion
5772 * @this_arg_size: length of the current arg, for convenience
5773 * @current_namespace: pointer to the current namespace definition
5774 * (or internally %NULL if the current namespace is unknown)
5775 * @is_radiotap_ns: indicates whether the current namespace is the default
5776 * radiotap namespace or not
5778 * @_rtheader: pointer to the radiotap header we are walking through
5779 * @_max_length: length of radiotap header in cpu byte ordering
5780 * @_arg_index: next argument index
5781 * @_arg: next argument pointer
5782 * @_next_bitmap: internal pointer to next present u32
5783 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5784 * @_vns: vendor namespace definitions
5785 * @_next_ns_data: beginning of the next namespace's data
5786 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5789 * Describes the radiotap parser state. Fields prefixed with an underscore
5790 * must not be used by users of the parser, only by the parser internally.
5793 struct ieee80211_radiotap_iterator {
5794 struct ieee80211_radiotap_header *_rtheader;
5795 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5796 const struct ieee80211_radiotap_namespace *current_namespace;
5798 unsigned char *_arg, *_next_ns_data;
5799 __le32 *_next_bitmap;
5801 unsigned char *this_arg;
5809 uint32_t _bitmap_shifter;
5814 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5815 struct ieee80211_radiotap_header *radiotap_header,
5817 const struct ieee80211_radiotap_vendor_namespaces *vns);
5820 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5823 extern const unsigned char rfc1042_header[6];
5824 extern const unsigned char bridge_tunnel_header[6];
5827 * ieee80211_get_hdrlen_from_skb - get header length from data
5831 * Given an skb with a raw 802.11 header at the data pointer this function
5832 * returns the 802.11 header length.
5834 * Return: The 802.11 header length in bytes (not including encryption
5835 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5838 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5841 * ieee80211_hdrlen - get header length in bytes from frame control
5842 * @fc: frame control field in little-endian format
5843 * Return: The header length in bytes.
5845 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5848 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5849 * @meshhdr: the mesh extension header, only the flags field
5850 * (first byte) will be accessed
5851 * Return: The length of the extension header, which is always at
5852 * least 6 bytes and at most 18 if address 5 and 6 are present.
5854 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5857 * DOC: Data path helpers
5859 * In addition to generic utilities, cfg80211 also offers
5860 * functions that help implement the data path for devices
5861 * that do not do the 802.11/802.3 conversion on the device.
5865 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5866 * @skb: the 802.11 data frame
5867 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5868 * of it being pushed into the SKB
5869 * @addr: the device MAC address
5870 * @iftype: the virtual interface type
5871 * @data_offset: offset of payload after the 802.11 header
5872 * Return: 0 on success. Non-zero on error.
5874 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5875 const u8 *addr, enum nl80211_iftype iftype,
5876 u8 data_offset, bool is_amsdu);
5879 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5880 * @skb: the 802.11 data frame
5881 * @addr: the device MAC address
5882 * @iftype: the virtual interface type
5883 * Return: 0 on success. Non-zero on error.
5885 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5886 enum nl80211_iftype iftype)
5888 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
5892 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5894 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5895 * The @list will be empty if the decode fails. The @skb must be fully
5896 * header-less before being passed in here; it is freed in this function.
5898 * @skb: The input A-MSDU frame without any headers.
5899 * @list: The output list of 802.3 frames. It must be allocated and
5900 * initialized by the caller.
5901 * @addr: The device MAC address.
5902 * @iftype: The device interface type.
5903 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5904 * @check_da: DA to check in the inner ethernet header, or NULL
5905 * @check_sa: SA to check in the inner ethernet header, or NULL
5907 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5908 const u8 *addr, enum nl80211_iftype iftype,
5909 const unsigned int extra_headroom,
5910 const u8 *check_da, const u8 *check_sa);
5913 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5914 * @skb: the data frame
5915 * @qos_map: Interworking QoS mapping or %NULL if not in use
5916 * Return: The 802.1p/1d tag.
5918 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5919 struct cfg80211_qos_map *qos_map);
5922 * cfg80211_find_elem_match - match information element and byte array in data
5925 * @ies: data consisting of IEs
5926 * @len: length of data
5927 * @match: byte array to match
5928 * @match_len: number of bytes in the match array
5929 * @match_offset: offset in the IE data where the byte array should match.
5930 * Note the difference to cfg80211_find_ie_match() which considers
5931 * the offset to start from the element ID byte, but here we take
5932 * the data portion instead.
5934 * Return: %NULL if the element ID could not be found or if
5935 * the element is invalid (claims to be longer than the given
5936 * data) or if the byte array doesn't match; otherwise return the
5937 * requested element struct.
5939 * Note: There are no checks on the element length other than
5940 * having to fit into the given data and being large enough for the
5941 * byte array to match.
5943 const struct element *
5944 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5945 const u8 *match, unsigned int match_len,
5946 unsigned int match_offset);
5949 * cfg80211_find_ie_match - match information element and byte array in data
5952 * @ies: data consisting of IEs
5953 * @len: length of data
5954 * @match: byte array to match
5955 * @match_len: number of bytes in the match array
5956 * @match_offset: offset in the IE where the byte array should match.
5957 * If match_len is zero, this must also be set to zero.
5958 * Otherwise this must be set to 2 or more, because the first
5959 * byte is the element id, which is already compared to eid, and
5960 * the second byte is the IE length.
5962 * Return: %NULL if the element ID could not be found or if
5963 * the element is invalid (claims to be longer than the given
5964 * data) or if the byte array doesn't match, or a pointer to the first
5965 * byte of the requested element, that is the byte containing the
5968 * Note: There are no checks on the element length other than
5969 * having to fit into the given data and being large enough for the
5970 * byte array to match.
5972 static inline const u8 *
5973 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5974 const u8 *match, unsigned int match_len,
5975 unsigned int match_offset)
5977 /* match_offset can't be smaller than 2, unless match_len is
5978 * zero, in which case match_offset must be zero as well.
5980 if (WARN_ON((match_len && match_offset < 2) ||
5981 (!match_len && match_offset)))
5984 return (void *)cfg80211_find_elem_match(eid, ies, len,
5987 match_offset - 2 : 0);
5991 * cfg80211_find_elem - find information element in data
5994 * @ies: data consisting of IEs
5995 * @len: length of data
5997 * Return: %NULL if the element ID could not be found or if
5998 * the element is invalid (claims to be longer than the given
5999 * data) or if the byte array doesn't match; otherwise return the
6000 * requested element struct.
6002 * Note: There are no checks on the element length other than
6003 * having to fit into the given data.
6005 static inline const struct element *
6006 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
6008 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
6012 * cfg80211_find_ie - find information element in data
6015 * @ies: data consisting of IEs
6016 * @len: length of data
6018 * Return: %NULL if the element ID could not be found or if
6019 * the element is invalid (claims to be longer than the given
6020 * data), or a pointer to the first byte of the requested
6021 * element, that is the byte containing the element ID.
6023 * Note: There are no checks on the element length other than
6024 * having to fit into the given data.
6026 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
6028 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
6032 * cfg80211_find_ext_elem - find information element with EID Extension in data
6034 * @ext_eid: element ID Extension
6035 * @ies: data consisting of IEs
6036 * @len: length of data
6038 * Return: %NULL if the etended element could not be found or if
6039 * the element is invalid (claims to be longer than the given
6040 * data) or if the byte array doesn't match; otherwise return the
6041 * requested element struct.
6043 * Note: There are no checks on the element length other than
6044 * having to fit into the given data.
6046 static inline const struct element *
6047 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
6049 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
6054 * cfg80211_find_ext_ie - find information element with EID Extension in data
6056 * @ext_eid: element ID Extension
6057 * @ies: data consisting of IEs
6058 * @len: length of data
6060 * Return: %NULL if the extended element ID could not be found or if
6061 * the element is invalid (claims to be longer than the given
6062 * data), or a pointer to the first byte of the requested
6063 * element, that is the byte containing the element ID.
6065 * Note: There are no checks on the element length other than
6066 * having to fit into the given data.
6068 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
6070 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
6075 * cfg80211_find_vendor_elem - find vendor specific information element in data
6078 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6079 * @ies: data consisting of IEs
6080 * @len: length of data
6082 * Return: %NULL if the vendor specific element ID could not be found or if the
6083 * element is invalid (claims to be longer than the given data); otherwise
6084 * return the element structure for the requested element.
6086 * Note: There are no checks on the element length other than having to fit into
6089 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
6094 * cfg80211_find_vendor_ie - find vendor specific information element in data
6097 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6098 * @ies: data consisting of IEs
6099 * @len: length of data
6101 * Return: %NULL if the vendor specific element ID could not be found or if the
6102 * element is invalid (claims to be longer than the given data), or a pointer to
6103 * the first byte of the requested element, that is the byte containing the
6106 * Note: There are no checks on the element length other than having to fit into
6109 static inline const u8 *
6110 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
6111 const u8 *ies, unsigned int len)
6113 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
6117 * cfg80211_send_layer2_update - send layer 2 update frame
6119 * @dev: network device
6120 * @addr: STA MAC address
6122 * Wireless drivers can use this function to update forwarding tables in bridge
6123 * devices upon STA association.
6125 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
6128 * DOC: Regulatory enforcement infrastructure
6134 * regulatory_hint - driver hint to the wireless core a regulatory domain
6135 * @wiphy: the wireless device giving the hint (used only for reporting
6137 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
6138 * should be in. If @rd is set this should be NULL. Note that if you
6139 * set this to NULL you should still set rd->alpha2 to some accepted
6142 * Wireless drivers can use this function to hint to the wireless core
6143 * what it believes should be the current regulatory domain by
6144 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
6145 * domain should be in or by providing a completely build regulatory domain.
6146 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
6147 * for a regulatory domain structure for the respective country.
6149 * The wiphy must have been registered to cfg80211 prior to this call.
6150 * For cfg80211 drivers this means you must first use wiphy_register(),
6151 * for mac80211 drivers you must first use ieee80211_register_hw().
6153 * Drivers should check the return value, its possible you can get
6156 * Return: 0 on success. -ENOMEM.
6158 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
6161 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
6162 * @wiphy: the wireless device we want to process the regulatory domain on
6163 * @rd: the regulatory domain informatoin to use for this wiphy
6165 * Set the regulatory domain information for self-managed wiphys, only they
6166 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
6169 * Return: 0 on success. -EINVAL, -EPERM
6171 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
6172 struct ieee80211_regdomain *rd);
6175 * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
6176 * @wiphy: the wireless device we want to process the regulatory domain on
6177 * @rd: the regulatory domain information to use for this wiphy
6179 * This functions requires the RTNL and the wiphy mutex to be held and
6180 * applies the new regdomain synchronously to this wiphy. For more details
6181 * see regulatory_set_wiphy_regd().
6183 * Return: 0 on success. -EINVAL, -EPERM
6185 int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
6186 struct ieee80211_regdomain *rd);
6189 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
6190 * @wiphy: the wireless device we want to process the regulatory domain on
6191 * @regd: the custom regulatory domain to use for this wiphy
6193 * Drivers can sometimes have custom regulatory domains which do not apply
6194 * to a specific country. Drivers can use this to apply such custom regulatory
6195 * domains. This routine must be called prior to wiphy registration. The
6196 * custom regulatory domain will be trusted completely and as such previous
6197 * default channel settings will be disregarded. If no rule is found for a
6198 * channel on the regulatory domain the channel will be disabled.
6199 * Drivers using this for a wiphy should also set the wiphy flag
6200 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
6201 * that called this helper.
6203 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
6204 const struct ieee80211_regdomain *regd);
6207 * freq_reg_info - get regulatory information for the given frequency
6208 * @wiphy: the wiphy for which we want to process this rule for
6209 * @center_freq: Frequency in KHz for which we want regulatory information for
6211 * Use this function to get the regulatory rule for a specific frequency on
6212 * a given wireless device. If the device has a specific regulatory domain
6213 * it wants to follow we respect that unless a country IE has been received
6214 * and processed already.
6216 * Return: A valid pointer, or, when an error occurs, for example if no rule
6217 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
6218 * check and PTR_ERR() to obtain the numeric return value. The numeric return
6219 * value will be -ERANGE if we determine the given center_freq does not even
6220 * have a regulatory rule for a frequency range in the center_freq's band.
6221 * See freq_in_rule_band() for our current definition of a band -- this is
6222 * purely subjective and right now it's 802.11 specific.
6224 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
6228 * reg_initiator_name - map regulatory request initiator enum to name
6229 * @initiator: the regulatory request initiator
6231 * You can use this to map the regulatory request initiator enum to a
6232 * proper string representation.
6234 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
6237 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
6238 * @wiphy: wiphy for which pre-CAC capability is checked.
6240 * Pre-CAC is allowed only in some regdomains (notable ETSI).
6242 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
6245 * DOC: Internal regulatory db functions
6250 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6251 * Regulatory self-managed driver can use it to proactively
6253 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6254 * @freq: the freqency(in MHz) to be queried.
6255 * @rule: pointer to store the wmm rule from the regulatory db.
6257 * Self-managed wireless drivers can use this function to query
6258 * the internal regulatory database to check whether the given
6259 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6261 * Drivers should check the return value, its possible you can get
6264 * Return: 0 on success. -ENODATA.
6266 int reg_query_regdb_wmm(char *alpha2, int freq,
6267 struct ieee80211_reg_rule *rule);
6270 * callbacks for asynchronous cfg80211 methods, notification
6271 * functions and BSS handling helpers
6275 * cfg80211_scan_done - notify that scan finished
6277 * @request: the corresponding scan request
6278 * @info: information about the completed scan
6280 void cfg80211_scan_done(struct cfg80211_scan_request *request,
6281 struct cfg80211_scan_info *info);
6284 * cfg80211_sched_scan_results - notify that new scan results are available
6286 * @wiphy: the wiphy which got scheduled scan results
6287 * @reqid: identifier for the related scheduled scan request
6289 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6292 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6294 * @wiphy: the wiphy on which the scheduled scan stopped
6295 * @reqid: identifier for the related scheduled scan request
6297 * The driver can call this function to inform cfg80211 that the
6298 * scheduled scan had to be stopped, for whatever reason. The driver
6299 * is then called back via the sched_scan_stop operation when done.
6301 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6304 * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
6306 * @wiphy: the wiphy on which the scheduled scan stopped
6307 * @reqid: identifier for the related scheduled scan request
6309 * The driver can call this function to inform cfg80211 that the
6310 * scheduled scan had to be stopped, for whatever reason. The driver
6311 * is then called back via the sched_scan_stop operation when done.
6312 * This function should be called with the wiphy mutex held.
6314 void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
6317 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6318 * @wiphy: the wiphy reporting the BSS
6319 * @data: the BSS metadata
6320 * @mgmt: the management frame (probe response or beacon)
6321 * @len: length of the management frame
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_frame_data(struct wiphy *wiphy,
6332 struct cfg80211_inform_bss *data,
6333 struct ieee80211_mgmt *mgmt, size_t len,
6336 static inline struct cfg80211_bss * __must_check
6337 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6338 struct ieee80211_channel *rx_channel,
6339 enum nl80211_bss_scan_width scan_width,
6340 struct ieee80211_mgmt *mgmt, size_t len,
6341 s32 signal, gfp_t gfp)
6343 struct cfg80211_inform_bss data = {
6345 .scan_width = scan_width,
6349 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6352 static inline struct cfg80211_bss * __must_check
6353 cfg80211_inform_bss_frame(struct wiphy *wiphy,
6354 struct ieee80211_channel *rx_channel,
6355 struct ieee80211_mgmt *mgmt, size_t len,
6356 s32 signal, gfp_t gfp)
6358 struct cfg80211_inform_bss data = {
6360 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6364 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6368 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6369 * @bssid: transmitter BSSID
6370 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6371 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6372 * @new_bssid: calculated nontransmitted BSSID
6374 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6375 u8 mbssid_index, u8 *new_bssid)
6377 u64 bssid_u64 = ether_addr_to_u64(bssid);
6378 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6381 new_bssid_u64 = bssid_u64 & ~mask;
6383 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6385 u64_to_ether_addr(new_bssid_u64, new_bssid);
6389 * cfg80211_get_ies_channel_number - returns the channel number from ies
6391 * @ielen: length of IEs
6392 * @band: enum nl80211_band of the channel
6394 * Returns the channel number, or -1 if none could be determined.
6396 int cfg80211_get_ies_channel_number(const u8 *ie, size_t ielen,
6397 enum nl80211_band band);
6400 * cfg80211_is_element_inherited - returns if element ID should be inherited
6401 * @element: element to check
6402 * @non_inherit_element: non inheritance element
6404 bool cfg80211_is_element_inherited(const struct element *element,
6405 const struct element *non_inherit_element);
6408 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6410 * @ielen: length of IEs
6411 * @mbssid_elem: current MBSSID element
6412 * @sub_elem: current MBSSID subelement (profile)
6413 * @merged_ie: location of the merged profile
6414 * @max_copy_len: max merged profile length
6416 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6417 const struct element *mbssid_elem,
6418 const struct element *sub_elem,
6419 u8 *merged_ie, size_t max_copy_len);
6422 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6423 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6424 * from a beacon or probe response
6425 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6426 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6428 enum cfg80211_bss_frame_type {
6429 CFG80211_BSS_FTYPE_UNKNOWN,
6430 CFG80211_BSS_FTYPE_BEACON,
6431 CFG80211_BSS_FTYPE_PRESP,
6435 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6437 * @wiphy: the wiphy reporting the BSS
6438 * @data: the BSS metadata
6439 * @ftype: frame type (if known)
6440 * @bssid: the BSSID of the BSS
6441 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6442 * @capability: the capability field sent by the peer
6443 * @beacon_interval: the beacon interval announced by the peer
6444 * @ie: additional IEs sent by the peer
6445 * @ielen: length of the additional IEs
6446 * @gfp: context flags
6448 * This informs cfg80211 that BSS information was found and
6449 * the BSS should be updated/added.
6451 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6452 * Or %NULL on error.
6454 struct cfg80211_bss * __must_check
6455 cfg80211_inform_bss_data(struct wiphy *wiphy,
6456 struct cfg80211_inform_bss *data,
6457 enum cfg80211_bss_frame_type ftype,
6458 const u8 *bssid, u64 tsf, u16 capability,
6459 u16 beacon_interval, const u8 *ie, size_t ielen,
6462 static inline struct cfg80211_bss * __must_check
6463 cfg80211_inform_bss_width(struct wiphy *wiphy,
6464 struct ieee80211_channel *rx_channel,
6465 enum nl80211_bss_scan_width scan_width,
6466 enum cfg80211_bss_frame_type ftype,
6467 const u8 *bssid, u64 tsf, u16 capability,
6468 u16 beacon_interval, const u8 *ie, size_t ielen,
6469 s32 signal, gfp_t gfp)
6471 struct cfg80211_inform_bss data = {
6473 .scan_width = scan_width,
6477 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6478 capability, beacon_interval, ie, ielen,
6482 static inline struct cfg80211_bss * __must_check
6483 cfg80211_inform_bss(struct wiphy *wiphy,
6484 struct ieee80211_channel *rx_channel,
6485 enum cfg80211_bss_frame_type ftype,
6486 const u8 *bssid, u64 tsf, u16 capability,
6487 u16 beacon_interval, const u8 *ie, size_t ielen,
6488 s32 signal, gfp_t gfp)
6490 struct cfg80211_inform_bss data = {
6492 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6496 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6497 capability, beacon_interval, ie, ielen,
6502 * cfg80211_get_bss - get a BSS reference
6503 * @wiphy: the wiphy this BSS struct belongs to
6504 * @channel: the channel to search on (or %NULL)
6505 * @bssid: the desired BSSID (or %NULL)
6506 * @ssid: the desired SSID (or %NULL)
6507 * @ssid_len: length of the SSID (or 0)
6508 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6509 * @privacy: privacy filter, see &enum ieee80211_privacy
6511 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6512 struct ieee80211_channel *channel,
6514 const u8 *ssid, size_t ssid_len,
6515 enum ieee80211_bss_type bss_type,
6516 enum ieee80211_privacy privacy);
6517 static inline struct cfg80211_bss *
6518 cfg80211_get_ibss(struct wiphy *wiphy,
6519 struct ieee80211_channel *channel,
6520 const u8 *ssid, size_t ssid_len)
6522 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6523 IEEE80211_BSS_TYPE_IBSS,
6524 IEEE80211_PRIVACY_ANY);
6528 * cfg80211_ref_bss - reference BSS struct
6529 * @wiphy: the wiphy this BSS struct belongs to
6530 * @bss: the BSS struct to reference
6532 * Increments the refcount of the given BSS struct.
6534 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6537 * cfg80211_put_bss - unref BSS struct
6538 * @wiphy: the wiphy this BSS struct belongs to
6539 * @bss: the BSS struct
6541 * Decrements the refcount of the given BSS struct.
6543 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6546 * cfg80211_unlink_bss - unlink BSS from internal data structures
6548 * @bss: the bss to remove
6550 * This function removes the given BSS from the internal data structures
6551 * thereby making it no longer show up in scan results etc. Use this
6552 * function when you detect a BSS is gone. Normally BSSes will also time
6553 * out, so it is not necessary to use this function at all.
6555 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6558 * cfg80211_bss_iter - iterate all BSS entries
6560 * This function iterates over the BSS entries associated with the given wiphy
6561 * and calls the callback for the iterated BSS. The iterator function is not
6562 * allowed to call functions that might modify the internal state of the BSS DB.
6565 * @chandef: if given, the iterator function will be called only if the channel
6566 * of the currently iterated BSS is a subset of the given channel.
6567 * @iter: the iterator function to call
6568 * @iter_data: an argument to the iterator function
6570 void cfg80211_bss_iter(struct wiphy *wiphy,
6571 struct cfg80211_chan_def *chandef,
6572 void (*iter)(struct wiphy *wiphy,
6573 struct cfg80211_bss *bss,
6577 static inline enum nl80211_bss_scan_width
6578 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6580 switch (chandef->width) {
6581 case NL80211_CHAN_WIDTH_5:
6582 return NL80211_BSS_CHAN_WIDTH_5;
6583 case NL80211_CHAN_WIDTH_10:
6584 return NL80211_BSS_CHAN_WIDTH_10;
6586 return NL80211_BSS_CHAN_WIDTH_20;
6591 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6592 * @dev: network device
6593 * @buf: authentication frame (header + body)
6594 * @len: length of the frame data
6596 * This function is called whenever an authentication, disassociation or
6597 * deauthentication frame has been received and processed in station mode.
6598 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6599 * call either this function or cfg80211_auth_timeout().
6600 * After being asked to associate via cfg80211_ops::assoc() the driver must
6601 * call either this function or cfg80211_auth_timeout().
6602 * While connected, the driver must calls this for received and processed
6603 * disassociation and deauthentication frames. If the frame couldn't be used
6604 * because it was unprotected, the driver must call the function
6605 * cfg80211_rx_unprot_mlme_mgmt() instead.
6607 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6609 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6612 * cfg80211_auth_timeout - notification of timed out authentication
6613 * @dev: network device
6614 * @addr: The MAC address of the device with which the authentication timed out
6616 * This function may sleep. The caller must hold the corresponding wdev's
6619 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6622 * cfg80211_rx_assoc_resp - notification of processed association response
6623 * @dev: network device
6624 * @bss: the BSS that association was requested with, ownership of the pointer
6625 * moves to cfg80211 in this call
6626 * @buf: (Re)Association Response frame (header + body)
6627 * @len: length of the frame data
6628 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6629 * as the AC bitmap in the QoS info field
6630 * @req_ies: information elements from the (Re)Association Request frame
6631 * @req_ies_len: length of req_ies data
6633 * After being asked to associate via cfg80211_ops::assoc() the driver must
6634 * call either this function or cfg80211_auth_timeout().
6636 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6638 void cfg80211_rx_assoc_resp(struct net_device *dev,
6639 struct cfg80211_bss *bss,
6640 const u8 *buf, size_t len,
6642 const u8 *req_ies, size_t req_ies_len);
6645 * cfg80211_assoc_timeout - notification of timed out association
6646 * @dev: network device
6647 * @bss: The BSS entry with which association timed out.
6649 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6651 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6654 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6655 * @dev: network device
6656 * @bss: The BSS entry with which association was abandoned.
6658 * Call this whenever - for reasons reported through other API, like deauth RX,
6659 * an association attempt was abandoned.
6660 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6662 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6665 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6666 * @dev: network device
6667 * @buf: 802.11 frame (header + body)
6668 * @len: length of the frame data
6669 * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
6671 * This function is called whenever deauthentication has been processed in
6672 * station mode. This includes both received deauthentication frames and
6673 * locally generated ones. This function may sleep. The caller must hold the
6674 * corresponding wdev's mutex.
6676 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
6680 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6681 * @dev: network device
6682 * @buf: received management frame (header + body)
6683 * @len: length of the frame data
6685 * This function is called whenever a received deauthentication or dissassoc
6686 * frame has been dropped in station mode because of MFP being used but the
6687 * frame was not protected. This is also used to notify reception of a Beacon
6688 * frame that was dropped because it did not include a valid MME MIC while
6689 * beacon protection was enabled (BIGTK configured in station mode).
6691 * This function may sleep.
6693 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6694 const u8 *buf, size_t len);
6697 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6698 * @dev: network device
6699 * @addr: The source MAC address of the frame
6700 * @key_type: The key type that the received frame used
6701 * @key_id: Key identifier (0..3). Can be -1 if missing.
6702 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6703 * @gfp: allocation flags
6705 * This function is called whenever the local MAC detects a MIC failure in a
6706 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6709 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6710 enum nl80211_key_type key_type, int key_id,
6711 const u8 *tsc, gfp_t gfp);
6714 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6716 * @dev: network device
6717 * @bssid: the BSSID of the IBSS joined
6718 * @channel: the channel of the IBSS joined
6719 * @gfp: allocation flags
6721 * This function notifies cfg80211 that the device joined an IBSS or
6722 * switched to a different BSSID. Before this function can be called,
6723 * either a beacon has to have been received from the IBSS, or one of
6724 * the cfg80211_inform_bss{,_frame} functions must have been called
6725 * with the locally generated beacon -- this guarantees that there is
6726 * always a scan result for this IBSS. cfg80211 will handle the rest.
6728 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6729 struct ieee80211_channel *channel, gfp_t gfp);
6732 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
6735 * @dev: network device
6736 * @macaddr: the MAC address of the new candidate
6737 * @ie: information elements advertised by the peer candidate
6738 * @ie_len: length of the information elements buffer
6739 * @gfp: allocation flags
6741 * This function notifies cfg80211 that the mesh peer candidate has been
6742 * detected, most likely via a beacon or, less likely, via a probe response.
6743 * cfg80211 then sends a notification to userspace.
6745 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6746 const u8 *macaddr, const u8 *ie, u8 ie_len,
6747 int sig_dbm, gfp_t gfp);
6750 * DOC: RFkill integration
6752 * RFkill integration in cfg80211 is almost invisible to drivers,
6753 * as cfg80211 automatically registers an rfkill instance for each
6754 * wireless device it knows about. Soft kill is also translated
6755 * into disconnecting and turning all interfaces off, drivers are
6756 * expected to turn off the device when all interfaces are down.
6758 * However, devices may have a hard RFkill line, in which case they
6759 * also need to interact with the rfkill subsystem, via cfg80211.
6760 * They can do this with a few helper functions documented here.
6764 * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
6766 * @blocked: block status
6767 * @reason: one of reasons in &enum rfkill_hard_block_reasons
6769 void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
6770 enum rfkill_hard_block_reasons reason);
6772 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
6774 wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
6775 RFKILL_HARD_BLOCK_SIGNAL);
6779 * wiphy_rfkill_start_polling - start polling rfkill
6782 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6785 * wiphy_rfkill_stop_polling - stop polling rfkill
6788 static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy)
6790 rfkill_pause_polling(wiphy->rfkill);
6794 * DOC: Vendor commands
6796 * Occasionally, there are special protocol or firmware features that
6797 * can't be implemented very openly. For this and similar cases, the
6798 * vendor command functionality allows implementing the features with
6799 * (typically closed-source) userspace and firmware, using nl80211 as
6800 * the configuration mechanism.
6802 * A driver supporting vendor commands must register them as an array
6803 * in struct wiphy, with handlers for each one, each command has an
6804 * OUI and sub command ID to identify it.
6806 * Note that this feature should not be (ab)used to implement protocol
6807 * features that could openly be shared across drivers. In particular,
6808 * it must never be required to use vendor commands to implement any
6809 * "normal" functionality that higher-level userspace like connection
6810 * managers etc. need.
6813 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6814 enum nl80211_commands cmd,
6815 enum nl80211_attrs attr,
6818 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6819 struct wireless_dev *wdev,
6820 enum nl80211_commands cmd,
6821 enum nl80211_attrs attr,
6822 unsigned int portid,
6823 int vendor_event_idx,
6824 int approxlen, gfp_t gfp);
6826 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6829 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6831 * @approxlen: an upper bound of the length of the data that will
6832 * be put into the skb
6834 * This function allocates and pre-fills an skb for a reply to
6835 * a vendor command. Since it is intended for a reply, calling
6836 * it outside of a vendor command's doit() operation is invalid.
6838 * The returned skb is pre-filled with some identifying data in
6839 * a way that any data that is put into the skb (with skb_put(),
6840 * nla_put() or similar) will end up being within the
6841 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6842 * with the skb is adding data for the corresponding userspace tool
6843 * which can then read that data out of the vendor data attribute.
6844 * You must not modify the skb in any other way.
6846 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6847 * its error code as the result of the doit() operation.
6849 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6851 static inline struct sk_buff *
6852 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6854 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6855 NL80211_ATTR_VENDOR_DATA, approxlen);
6859 * cfg80211_vendor_cmd_reply - send the reply skb
6860 * @skb: The skb, must have been allocated with
6861 * cfg80211_vendor_cmd_alloc_reply_skb()
6863 * Since calling this function will usually be the last thing
6864 * before returning from the vendor command doit() you should
6865 * return the error code. Note that this function consumes the
6866 * skb regardless of the return value.
6868 * Return: An error code or 0 on success.
6870 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6873 * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
6876 * Return the current netlink port ID in a vendor command handler.
6877 * Valid to call only there.
6879 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6882 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6884 * @wdev: the wireless device
6885 * @event_idx: index of the vendor event in the wiphy's vendor_events
6886 * @approxlen: an upper bound of the length of the data that will
6887 * be put into the skb
6888 * @gfp: allocation flags
6890 * This function allocates and pre-fills an skb for an event on the
6891 * vendor-specific multicast group.
6893 * If wdev != NULL, both the ifindex and identifier of the specified
6894 * wireless device are added to the event message before the vendor data
6897 * When done filling the skb, call cfg80211_vendor_event() with the
6898 * skb to send the event.
6900 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6902 static inline struct sk_buff *
6903 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6904 int approxlen, int event_idx, gfp_t gfp)
6906 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6907 NL80211_ATTR_VENDOR_DATA,
6908 0, event_idx, approxlen, gfp);
6912 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6914 * @wdev: the wireless device
6915 * @event_idx: index of the vendor event in the wiphy's vendor_events
6916 * @portid: port ID of the receiver
6917 * @approxlen: an upper bound of the length of the data that will
6918 * be put into the skb
6919 * @gfp: allocation flags
6921 * This function allocates and pre-fills an skb for an event to send to
6922 * a specific (userland) socket. This socket would previously have been
6923 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6924 * care to register a netlink notifier to see when the socket closes.
6926 * If wdev != NULL, both the ifindex and identifier of the specified
6927 * wireless device are added to the event message before the vendor data
6930 * When done filling the skb, call cfg80211_vendor_event() with the
6931 * skb to send the event.
6933 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6935 static inline struct sk_buff *
6936 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6937 struct wireless_dev *wdev,
6938 unsigned int portid, int approxlen,
6939 int event_idx, gfp_t gfp)
6941 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6942 NL80211_ATTR_VENDOR_DATA,
6943 portid, event_idx, approxlen, gfp);
6947 * cfg80211_vendor_event - send the event
6948 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6949 * @gfp: allocation flags
6951 * This function sends the given @skb, which must have been allocated
6952 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6954 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6956 __cfg80211_send_event_skb(skb, gfp);
6959 #ifdef CONFIG_NL80211_TESTMODE
6963 * Test mode is a set of utility functions to allow drivers to
6964 * interact with driver-specific tools to aid, for instance,
6965 * factory programming.
6967 * This chapter describes how drivers interact with it, for more
6968 * information see the nl80211 book's chapter on it.
6972 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6974 * @approxlen: an upper bound of the length of the data that will
6975 * be put into the skb
6977 * This function allocates and pre-fills an skb for a reply to
6978 * the testmode command. Since it is intended for a reply, calling
6979 * it outside of the @testmode_cmd operation is invalid.
6981 * The returned skb is pre-filled with the wiphy index and set up in
6982 * a way that any data that is put into the skb (with skb_put(),
6983 * nla_put() or similar) will end up being within the
6984 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6985 * with the skb is adding data for the corresponding userspace tool
6986 * which can then read that data out of the testdata attribute. You
6987 * must not modify the skb in any other way.
6989 * When done, call cfg80211_testmode_reply() with the skb and return
6990 * its error code as the result of the @testmode_cmd operation.
6992 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6994 static inline struct sk_buff *
6995 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6997 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6998 NL80211_ATTR_TESTDATA, approxlen);
7002 * cfg80211_testmode_reply - send the reply skb
7003 * @skb: The skb, must have been allocated with
7004 * cfg80211_testmode_alloc_reply_skb()
7006 * Since calling this function will usually be the last thing
7007 * before returning from the @testmode_cmd you should return
7008 * the error code. Note that this function consumes the skb
7009 * regardless of the return value.
7011 * Return: An error code or 0 on success.
7013 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
7015 return cfg80211_vendor_cmd_reply(skb);
7019 * cfg80211_testmode_alloc_event_skb - allocate testmode event
7021 * @approxlen: an upper bound of the length of the data that will
7022 * be put into the skb
7023 * @gfp: allocation flags
7025 * This function allocates and pre-fills an skb for an event on the
7026 * testmode multicast group.
7028 * The returned skb is set up in the same way as with
7029 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
7030 * there, you should simply add data to it that will then end up in the
7031 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
7034 * When done filling the skb, call cfg80211_testmode_event() with the
7035 * skb to send the event.
7037 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7039 static inline struct sk_buff *
7040 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
7042 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
7043 NL80211_ATTR_TESTDATA, 0, -1,
7048 * cfg80211_testmode_event - send the event
7049 * @skb: The skb, must have been allocated with
7050 * cfg80211_testmode_alloc_event_skb()
7051 * @gfp: allocation flags
7053 * This function sends the given @skb, which must have been allocated
7054 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
7057 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
7059 __cfg80211_send_event_skb(skb, gfp);
7062 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
7063 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
7065 #define CFG80211_TESTMODE_CMD(cmd)
7066 #define CFG80211_TESTMODE_DUMP(cmd)
7070 * struct cfg80211_fils_resp_params - FILS connection response params
7071 * @kek: KEK derived from a successful FILS connection (may be %NULL)
7072 * @kek_len: Length of @fils_kek in octets
7073 * @update_erp_next_seq_num: Boolean value to specify whether the value in
7074 * @erp_next_seq_num is valid.
7075 * @erp_next_seq_num: The next sequence number to use in ERP message in
7076 * FILS Authentication. This value should be specified irrespective of the
7077 * status for a FILS connection.
7078 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
7079 * @pmk_len: Length of @pmk in octets
7080 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
7081 * used for this FILS connection (may be %NULL).
7083 struct cfg80211_fils_resp_params {
7086 bool update_erp_next_seq_num;
7087 u16 erp_next_seq_num;
7094 * struct cfg80211_connect_resp_params - Connection response params
7095 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
7096 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7097 * the real status code for failures. If this call is used to report a
7098 * failure due to a timeout (e.g., not receiving an Authentication frame
7099 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7100 * indicate that this is a failure, but without a status code.
7101 * @timeout_reason is used to report the reason for the timeout in that
7103 * @bssid: The BSSID of the AP (may be %NULL)
7104 * @bss: Entry of bss to which STA got connected to, can be obtained through
7105 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7106 * bss from the connect_request and hold a reference to it and return
7107 * through this param to avoid a warning if the bss is expired during the
7108 * connection, esp. for those drivers implementing connect op.
7109 * Only one parameter among @bssid and @bss needs to be specified.
7110 * @req_ie: Association request IEs (may be %NULL)
7111 * @req_ie_len: Association request IEs length
7112 * @resp_ie: Association response IEs (may be %NULL)
7113 * @resp_ie_len: Association response IEs length
7114 * @fils: FILS connection response parameters.
7115 * @timeout_reason: Reason for connection timeout. This is used when the
7116 * connection fails due to a timeout instead of an explicit rejection from
7117 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7118 * not known. This value is used only if @status < 0 to indicate that the
7119 * failure is due to a timeout and not due to explicit rejection by the AP.
7120 * This value is ignored in other cases (@status >= 0).
7122 struct cfg80211_connect_resp_params {
7125 struct cfg80211_bss *bss;
7130 struct cfg80211_fils_resp_params fils;
7131 enum nl80211_timeout_reason timeout_reason;
7135 * cfg80211_connect_done - notify cfg80211 of connection result
7137 * @dev: network device
7138 * @params: connection response parameters
7139 * @gfp: allocation flags
7141 * It should be called by the underlying driver once execution of the connection
7142 * request from connect() has been completed. This is similar to
7143 * cfg80211_connect_bss(), but takes a structure pointer for connection response
7144 * parameters. Only one of the functions among cfg80211_connect_bss(),
7145 * cfg80211_connect_result(), cfg80211_connect_timeout(),
7146 * and cfg80211_connect_done() should be called.
7148 void cfg80211_connect_done(struct net_device *dev,
7149 struct cfg80211_connect_resp_params *params,
7153 * cfg80211_connect_bss - notify cfg80211 of connection result
7155 * @dev: network device
7156 * @bssid: the BSSID of the AP
7157 * @bss: Entry of bss to which STA got connected to, can be obtained through
7158 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7159 * bss from the connect_request and hold a reference to it and return
7160 * through this param to avoid a warning if the bss is expired during the
7161 * connection, esp. for those drivers implementing connect op.
7162 * Only one parameter among @bssid and @bss needs to be specified.
7163 * @req_ie: association request IEs (maybe be %NULL)
7164 * @req_ie_len: association request IEs length
7165 * @resp_ie: association response IEs (may be %NULL)
7166 * @resp_ie_len: assoc response IEs length
7167 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7168 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7169 * the real status code for failures. If this call is used to report a
7170 * failure due to a timeout (e.g., not receiving an Authentication frame
7171 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7172 * indicate that this is a failure, but without a status code.
7173 * @timeout_reason is used to report the reason for the timeout in that
7175 * @gfp: allocation flags
7176 * @timeout_reason: reason for connection timeout. This is used when the
7177 * connection fails due to a timeout instead of an explicit rejection from
7178 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7179 * not known. This value is used only if @status < 0 to indicate that the
7180 * failure is due to a timeout and not due to explicit rejection by the AP.
7181 * This value is ignored in other cases (@status >= 0).
7183 * It should be called by the underlying driver once execution of the connection
7184 * request from connect() has been completed. This is similar to
7185 * cfg80211_connect_result(), but with the option of identifying the exact bss
7186 * entry for the connection. Only one of the functions among
7187 * cfg80211_connect_bss(), cfg80211_connect_result(),
7188 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7191 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
7192 struct cfg80211_bss *bss, const u8 *req_ie,
7193 size_t req_ie_len, const u8 *resp_ie,
7194 size_t resp_ie_len, int status, gfp_t gfp,
7195 enum nl80211_timeout_reason timeout_reason)
7197 struct cfg80211_connect_resp_params params;
7199 memset(¶ms, 0, sizeof(params));
7200 params.status = status;
7201 params.bssid = bssid;
7203 params.req_ie = req_ie;
7204 params.req_ie_len = req_ie_len;
7205 params.resp_ie = resp_ie;
7206 params.resp_ie_len = resp_ie_len;
7207 params.timeout_reason = timeout_reason;
7209 cfg80211_connect_done(dev, ¶ms, gfp);
7213 * cfg80211_connect_result - notify cfg80211 of connection result
7215 * @dev: network device
7216 * @bssid: the BSSID of the AP
7217 * @req_ie: association request IEs (maybe be %NULL)
7218 * @req_ie_len: association request IEs length
7219 * @resp_ie: association response IEs (may be %NULL)
7220 * @resp_ie_len: assoc response IEs length
7221 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7222 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7223 * the real status code for failures.
7224 * @gfp: allocation flags
7226 * It should be called by the underlying driver once execution of the connection
7227 * request from connect() has been completed. This is similar to
7228 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
7229 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
7230 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7233 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
7234 const u8 *req_ie, size_t req_ie_len,
7235 const u8 *resp_ie, size_t resp_ie_len,
7236 u16 status, gfp_t gfp)
7238 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
7239 resp_ie_len, status, gfp,
7240 NL80211_TIMEOUT_UNSPECIFIED);
7244 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
7246 * @dev: network device
7247 * @bssid: the BSSID of the AP
7248 * @req_ie: association request IEs (maybe be %NULL)
7249 * @req_ie_len: association request IEs length
7250 * @gfp: allocation flags
7251 * @timeout_reason: reason for connection timeout.
7253 * It should be called by the underlying driver whenever connect() has failed
7254 * in a sequence where no explicit authentication/association rejection was
7255 * received from the AP. This could happen, e.g., due to not being able to send
7256 * out the Authentication or Association Request frame or timing out while
7257 * waiting for the response. Only one of the functions among
7258 * cfg80211_connect_bss(), cfg80211_connect_result(),
7259 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7262 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
7263 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
7264 enum nl80211_timeout_reason timeout_reason)
7266 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
7267 gfp, timeout_reason);
7271 * struct cfg80211_roam_info - driver initiated roaming information
7273 * @channel: the channel of the new AP
7274 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
7275 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
7276 * @req_ie: association request IEs (maybe be %NULL)
7277 * @req_ie_len: association request IEs length
7278 * @resp_ie: association response IEs (may be %NULL)
7279 * @resp_ie_len: assoc response IEs length
7280 * @fils: FILS related roaming information.
7282 struct cfg80211_roam_info {
7283 struct ieee80211_channel *channel;
7284 struct cfg80211_bss *bss;
7290 struct cfg80211_fils_resp_params fils;
7294 * cfg80211_roamed - notify cfg80211 of roaming
7296 * @dev: network device
7297 * @info: information about the new BSS. struct &cfg80211_roam_info.
7298 * @gfp: allocation flags
7300 * This function may be called with the driver passing either the BSSID of the
7301 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7302 * It should be called by the underlying driver whenever it roamed from one AP
7303 * to another while connected. Drivers which have roaming implemented in
7304 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7305 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7306 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7307 * rdev->event_work. In case of any failures, the reference is released
7308 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7309 * released while disconnecting from the current bss.
7311 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7315 * cfg80211_port_authorized - notify cfg80211 of successful security association
7317 * @dev: network device
7318 * @bssid: the BSSID of the AP
7319 * @gfp: allocation flags
7321 * This function should be called by a driver that supports 4 way handshake
7322 * offload after a security association was successfully established (i.e.,
7323 * the 4 way handshake was completed successfully). The call to this function
7324 * should be preceded with a call to cfg80211_connect_result(),
7325 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7326 * indicate the 802.11 association.
7328 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7332 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7334 * @dev: network device
7335 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7336 * @ie_len: length of IEs
7337 * @reason: reason code for the disconnection, set it to 0 if unknown
7338 * @locally_generated: disconnection was requested locally
7339 * @gfp: allocation flags
7341 * After it calls this function, the driver should enter an idle state
7342 * and not try to connect to any AP any more.
7344 void cfg80211_disconnected(struct net_device *dev, u16 reason,
7345 const u8 *ie, size_t ie_len,
7346 bool locally_generated, gfp_t gfp);
7349 * cfg80211_ready_on_channel - notification of remain_on_channel start
7350 * @wdev: wireless device
7351 * @cookie: the request cookie
7352 * @chan: The current channel (from remain_on_channel request)
7353 * @duration: Duration in milliseconds that the driver intents to remain on the
7355 * @gfp: allocation flags
7357 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7358 struct ieee80211_channel *chan,
7359 unsigned int duration, gfp_t gfp);
7362 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7363 * @wdev: wireless device
7364 * @cookie: the request cookie
7365 * @chan: The current channel (from remain_on_channel request)
7366 * @gfp: allocation flags
7368 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7369 struct ieee80211_channel *chan,
7373 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7374 * @wdev: wireless device
7375 * @cookie: the requested cookie
7376 * @chan: The current channel (from tx_mgmt request)
7377 * @gfp: allocation flags
7379 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7380 struct ieee80211_channel *chan, gfp_t gfp);
7383 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7385 * @sinfo: the station information
7386 * @gfp: allocation flags
7388 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7391 * cfg80211_sinfo_release_content - release contents of station info
7392 * @sinfo: the station information
7394 * Releases any potentially allocated sub-information of the station
7395 * information, but not the struct itself (since it's typically on
7398 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7400 kfree(sinfo->pertid);
7404 * cfg80211_new_sta - notify userspace about station
7407 * @mac_addr: the station's address
7408 * @sinfo: the station information
7409 * @gfp: allocation flags
7411 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7412 struct station_info *sinfo, gfp_t gfp);
7415 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7417 * @mac_addr: the station's address
7418 * @sinfo: the station information/statistics
7419 * @gfp: allocation flags
7421 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7422 struct station_info *sinfo, gfp_t gfp);
7425 * cfg80211_del_sta - notify userspace about deletion of a station
7428 * @mac_addr: the station's address
7429 * @gfp: allocation flags
7431 static inline void cfg80211_del_sta(struct net_device *dev,
7432 const u8 *mac_addr, gfp_t gfp)
7434 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7438 * cfg80211_conn_failed - connection request failed notification
7441 * @mac_addr: the station's address
7442 * @reason: the reason for connection failure
7443 * @gfp: allocation flags
7445 * Whenever a station tries to connect to an AP and if the station
7446 * could not connect to the AP as the AP has rejected the connection
7447 * for some reasons, this function is called.
7449 * The reason for connection failure can be any of the value from
7450 * nl80211_connect_failed_reason enum
7452 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7453 enum nl80211_connect_failed_reason reason,
7457 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7458 * @wdev: wireless device receiving the frame
7459 * @freq: Frequency on which the frame was received in KHz
7460 * @sig_dbm: signal strength in dBm, or 0 if unknown
7461 * @buf: Management frame (header + body)
7462 * @len: length of the frame data
7463 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7465 * This function is called whenever an Action frame is received for a station
7466 * mode interface, but is not processed in kernel.
7468 * Return: %true if a user space application has registered for this frame.
7469 * For action frames, that makes it responsible for rejecting unrecognized
7470 * action frames; %false otherwise, in which case for action frames the
7471 * driver is responsible for rejecting the frame.
7473 bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq, int sig_dbm,
7474 const u8 *buf, size_t len, u32 flags);
7477 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7478 * @wdev: wireless device receiving the frame
7479 * @freq: Frequency on which the frame was received in MHz
7480 * @sig_dbm: signal strength in dBm, or 0 if unknown
7481 * @buf: Management frame (header + body)
7482 * @len: length of the frame data
7483 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7485 * This function is called whenever an Action frame is received for a station
7486 * mode interface, but is not processed in kernel.
7488 * Return: %true if a user space application has registered for this frame.
7489 * For action frames, that makes it responsible for rejecting unrecognized
7490 * action frames; %false otherwise, in which case for action frames the
7491 * driver is responsible for rejecting the frame.
7493 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7494 int sig_dbm, const u8 *buf, size_t len,
7497 return cfg80211_rx_mgmt_khz(wdev, MHZ_TO_KHZ(freq), sig_dbm, buf, len,
7502 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7503 * @wdev: wireless device receiving the frame
7504 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7505 * @buf: Management frame (header + body)
7506 * @len: length of the frame data
7507 * @ack: Whether frame was acknowledged
7508 * @gfp: context flags
7510 * This function is called whenever a management frame was requested to be
7511 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7512 * transmission attempt.
7514 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
7515 const u8 *buf, size_t len, bool ack, gfp_t gfp);
7518 * cfg80211_control_port_tx_status - notification of TX status for control
7520 * @wdev: wireless device receiving the frame
7521 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7522 * @buf: Data frame (header + body)
7523 * @len: length of the frame data
7524 * @ack: Whether frame was acknowledged
7525 * @gfp: context flags
7527 * This function is called whenever a control port frame was requested to be
7528 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7529 * the transmission attempt.
7531 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
7532 const u8 *buf, size_t len, bool ack,
7536 * cfg80211_rx_control_port - notification about a received control port frame
7537 * @dev: The device the frame matched to
7538 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7539 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7540 * This function does not take ownership of the skb, so the caller is
7541 * responsible for any cleanup. The caller must also ensure that
7542 * skb->protocol is set appropriately.
7543 * @unencrypted: Whether the frame was received unencrypted
7545 * This function is used to inform userspace about a received control port
7546 * frame. It should only be used if userspace indicated it wants to receive
7547 * control port frames over nl80211.
7549 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7550 * network layer headers removed (e.g. the raw EAPoL frame).
7552 * Return: %true if the frame was passed to userspace
7554 bool cfg80211_rx_control_port(struct net_device *dev,
7555 struct sk_buff *skb, bool unencrypted);
7558 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
7559 * @dev: network device
7560 * @rssi_event: the triggered RSSI event
7561 * @rssi_level: new RSSI level value or 0 if not available
7562 * @gfp: context flags
7564 * This function is called when a configured connection quality monitoring
7565 * rssi threshold reached event occurs.
7567 void cfg80211_cqm_rssi_notify(struct net_device *dev,
7568 enum nl80211_cqm_rssi_threshold_event rssi_event,
7569 s32 rssi_level, gfp_t gfp);
7572 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
7573 * @dev: network device
7574 * @peer: peer's MAC address
7575 * @num_packets: how many packets were lost -- should be a fixed threshold
7576 * but probably no less than maybe 50, or maybe a throughput dependent
7577 * threshold (to account for temporary interference)
7578 * @gfp: context flags
7580 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
7581 const u8 *peer, u32 num_packets, gfp_t gfp);
7584 * cfg80211_cqm_txe_notify - TX error rate event
7585 * @dev: network device
7586 * @peer: peer's MAC address
7587 * @num_packets: how many packets were lost
7588 * @rate: % of packets which failed transmission
7589 * @intvl: interval (in s) over which the TX failure threshold was breached.
7590 * @gfp: context flags
7592 * Notify userspace when configured % TX failures over number of packets in a
7593 * given interval is exceeded.
7595 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
7596 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
7599 * cfg80211_cqm_beacon_loss_notify - beacon loss event
7600 * @dev: network device
7601 * @gfp: context flags
7603 * Notify userspace about beacon loss from the connected AP.
7605 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
7608 * __cfg80211_radar_event - radar detection event
7610 * @chandef: chandef for the current channel
7611 * @offchan: the radar has been detected on the offchannel chain
7612 * @gfp: context flags
7614 * This function is called when a radar is detected on the current chanenl.
7616 void __cfg80211_radar_event(struct wiphy *wiphy,
7617 struct cfg80211_chan_def *chandef,
7618 bool offchan, gfp_t gfp);
7621 cfg80211_radar_event(struct wiphy *wiphy,
7622 struct cfg80211_chan_def *chandef,
7625 __cfg80211_radar_event(wiphy, chandef, false, gfp);
7629 cfg80211_offchan_radar_event(struct wiphy *wiphy,
7630 struct cfg80211_chan_def *chandef,
7633 __cfg80211_radar_event(wiphy, chandef, true, gfp);
7637 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
7638 * @dev: network device
7639 * @mac: MAC address of a station which opmode got modified
7640 * @sta_opmode: station's current opmode value
7641 * @gfp: context flags
7643 * Driver should call this function when station's opmode modified via action
7646 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
7647 struct sta_opmode_info *sta_opmode,
7651 * cfg80211_cac_event - Channel availability check (CAC) event
7652 * @netdev: network device
7653 * @chandef: chandef for the current channel
7654 * @event: type of event
7655 * @gfp: context flags
7657 * This function is called when a Channel availability check (CAC) is finished
7658 * or aborted. This must be called to notify the completion of a CAC process,
7659 * also by full-MAC drivers.
7661 void cfg80211_cac_event(struct net_device *netdev,
7662 const struct cfg80211_chan_def *chandef,
7663 enum nl80211_radar_event event, gfp_t gfp);
7666 * cfg80211_offchan_cac_abort - Channel Availability Check offchan abort event
7669 * This function is called by the driver when a Channel Availability Check
7670 * (CAC) is aborted by a offchannel dedicated chain.
7672 void cfg80211_offchan_cac_abort(struct wiphy *wiphy);
7675 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
7676 * @dev: network device
7677 * @bssid: BSSID of AP (to avoid races)
7678 * @replay_ctr: new replay counter
7679 * @gfp: allocation flags
7681 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
7682 const u8 *replay_ctr, gfp_t gfp);
7685 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7686 * @dev: network device
7687 * @index: candidate index (the smaller the index, the higher the priority)
7688 * @bssid: BSSID of AP
7689 * @preauth: Whether AP advertises support for RSN pre-authentication
7690 * @gfp: allocation flags
7692 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
7693 const u8 *bssid, bool preauth, gfp_t gfp);
7696 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7697 * @dev: The device the frame matched to
7698 * @addr: the transmitter address
7699 * @gfp: context flags
7701 * This function is used in AP mode (only!) to inform userspace that
7702 * a spurious class 3 frame was received, to be able to deauth the
7704 * Return: %true if the frame was passed to userspace (or this failed
7705 * for a reason other than not having a subscription.)
7707 bool cfg80211_rx_spurious_frame(struct net_device *dev,
7708 const u8 *addr, gfp_t gfp);
7711 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7712 * @dev: The device the frame matched to
7713 * @addr: the transmitter address
7714 * @gfp: context flags
7716 * This function is used in AP mode (only!) to inform userspace that
7717 * an associated station sent a 4addr frame but that wasn't expected.
7718 * It is allowed and desirable to send this event only once for each
7719 * station to avoid event flooding.
7720 * Return: %true if the frame was passed to userspace (or this failed
7721 * for a reason other than not having a subscription.)
7723 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
7724 const u8 *addr, gfp_t gfp);
7727 * cfg80211_probe_status - notify userspace about probe status
7728 * @dev: the device the probe was sent on
7729 * @addr: the address of the peer
7730 * @cookie: the cookie filled in @probe_client previously
7731 * @acked: indicates whether probe was acked or not
7732 * @ack_signal: signal strength (in dBm) of the ACK frame.
7733 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7734 * @gfp: allocation flags
7736 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
7737 u64 cookie, bool acked, s32 ack_signal,
7738 bool is_valid_ack_signal, gfp_t gfp);
7741 * cfg80211_report_obss_beacon_khz - report beacon from other APs
7742 * @wiphy: The wiphy that received the beacon
7744 * @len: length of the frame
7745 * @freq: frequency the frame was received on in KHz
7746 * @sig_dbm: signal strength in dBm, or 0 if unknown
7748 * Use this function to report to userspace when a beacon was
7749 * received. It is not useful to call this when there is no
7750 * netdev that is in AP/GO mode.
7752 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
7753 size_t len, int freq, int sig_dbm);
7756 * cfg80211_report_obss_beacon - report beacon from other APs
7757 * @wiphy: The wiphy that received the beacon
7759 * @len: length of the frame
7760 * @freq: frequency the frame was received on
7761 * @sig_dbm: signal strength in dBm, or 0 if unknown
7763 * Use this function to report to userspace when a beacon was
7764 * received. It is not useful to call this when there is no
7765 * netdev that is in AP/GO mode.
7767 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7768 const u8 *frame, size_t len,
7769 int freq, int sig_dbm)
7771 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
7776 * cfg80211_reg_can_beacon - check if beaconing is allowed
7778 * @chandef: the channel definition
7779 * @iftype: interface type
7781 * Return: %true if there is no secondary channel or the secondary channel(s)
7782 * can be used for beaconing (i.e. is not a radar channel etc.)
7784 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7785 struct cfg80211_chan_def *chandef,
7786 enum nl80211_iftype iftype);
7789 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7791 * @chandef: the channel definition
7792 * @iftype: interface type
7794 * Return: %true if there is no secondary channel or the secondary channel(s)
7795 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7796 * also checks if IR-relaxation conditions apply, to allow beaconing under
7797 * more permissive conditions.
7799 * Requires the wiphy mutex to be held.
7801 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7802 struct cfg80211_chan_def *chandef,
7803 enum nl80211_iftype iftype);
7806 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7807 * @dev: the device which switched channels
7808 * @chandef: the new channel definition
7810 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7813 void cfg80211_ch_switch_notify(struct net_device *dev,
7814 struct cfg80211_chan_def *chandef);
7817 * cfg80211_ch_switch_started_notify - notify channel switch start
7818 * @dev: the device on which the channel switch started
7819 * @chandef: the future channel definition
7820 * @count: the number of TBTTs until the channel switch happens
7821 * @quiet: whether or not immediate quiet was requested by the AP
7823 * Inform the userspace about the channel switch that has just
7824 * started, so that it can take appropriate actions (eg. starting
7825 * channel switch on other vifs), if necessary.
7827 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7828 struct cfg80211_chan_def *chandef,
7829 u8 count, bool quiet);
7832 * ieee80211_operating_class_to_band - convert operating class to band
7834 * @operating_class: the operating class to convert
7835 * @band: band pointer to fill
7837 * Returns %true if the conversion was successful, %false otherwise.
7839 bool ieee80211_operating_class_to_band(u8 operating_class,
7840 enum nl80211_band *band);
7843 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7845 * @chandef: the chandef to convert
7846 * @op_class: a pointer to the resulting operating class
7848 * Returns %true if the conversion was successful, %false otherwise.
7850 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7854 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
7856 * @chandef: the chandef to convert
7858 * Returns the center frequency of chandef (1st segment) in KHz.
7861 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
7863 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
7867 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7868 * @dev: the device on which the operation is requested
7869 * @peer: the MAC address of the peer device
7870 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7871 * NL80211_TDLS_TEARDOWN)
7872 * @reason_code: the reason code for teardown request
7873 * @gfp: allocation flags
7875 * This function is used to request userspace to perform TDLS operation that
7876 * requires knowledge of keys, i.e., link setup or teardown when the AP
7877 * connection uses encryption. This is optional mechanism for the driver to use
7878 * if it can automatically determine when a TDLS link could be useful (e.g.,
7879 * based on traffic and signal strength for a peer).
7881 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7882 enum nl80211_tdls_operation oper,
7883 u16 reason_code, gfp_t gfp);
7886 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7887 * @rate: given rate_info to calculate bitrate from
7889 * return 0 if MCS index >= 32
7891 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7894 * cfg80211_unregister_wdev - remove the given wdev
7895 * @wdev: struct wireless_dev to remove
7897 * This function removes the device so it can no longer be used. It is necessary
7898 * to call this function even when cfg80211 requests the removal of the device
7899 * by calling the del_virtual_intf() callback. The function must also be called
7900 * when the driver wishes to unregister the wdev, e.g. when the hardware device
7901 * is unbound from the driver.
7903 * Requires the RTNL and wiphy mutex to be held.
7905 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7908 * cfg80211_register_netdevice - register the given netdev
7909 * @dev: the netdev to register
7911 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
7912 * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
7913 * held. Otherwise, both register_netdevice() and register_netdev() are usable
7916 * Requires the RTNL and wiphy mutex to be held.
7918 int cfg80211_register_netdevice(struct net_device *dev);
7921 * cfg80211_unregister_netdevice - unregister the given netdev
7922 * @dev: the netdev to register
7924 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
7925 * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
7926 * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
7927 * usable instead as well.
7929 * Requires the RTNL and wiphy mutex to be held.
7931 static inline void cfg80211_unregister_netdevice(struct net_device *dev)
7933 cfg80211_unregister_wdev(dev->ieee80211_ptr);
7937 * struct cfg80211_ft_event_params - FT Information Elements
7939 * @ies_len: length of the FT IE in bytes
7940 * @target_ap: target AP's MAC address
7942 * @ric_ies_len: length of the RIC IE in bytes
7944 struct cfg80211_ft_event_params {
7947 const u8 *target_ap;
7953 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7954 * @netdev: network device
7955 * @ft_event: IE information
7957 void cfg80211_ft_event(struct net_device *netdev,
7958 struct cfg80211_ft_event_params *ft_event);
7961 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7962 * @ies: the input IE buffer
7963 * @len: the input length
7964 * @attr: the attribute ID to find
7965 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7966 * if the function is only called to get the needed buffer size
7967 * @bufsize: size of the output buffer
7969 * The function finds a given P2P attribute in the (vendor) IEs and
7970 * copies its contents to the given buffer.
7972 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7973 * malformed or the attribute can't be found (respectively), or the
7974 * length of the found attribute (which can be zero).
7976 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7977 enum ieee80211_p2p_attr_id attr,
7978 u8 *buf, unsigned int bufsize);
7981 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7982 * @ies: the IE buffer
7983 * @ielen: the length of the IE buffer
7984 * @ids: an array with element IDs that are allowed before
7985 * the split. A WLAN_EID_EXTENSION value means that the next
7986 * EID in the list is a sub-element of the EXTENSION IE.
7987 * @n_ids: the size of the element ID array
7988 * @after_ric: array IE types that come after the RIC element
7989 * @n_after_ric: size of the @after_ric array
7990 * @offset: offset where to start splitting in the buffer
7992 * This function splits an IE buffer by updating the @offset
7993 * variable to point to the location where the buffer should be
7996 * It assumes that the given IE buffer is well-formed, this
7997 * has to be guaranteed by the caller!
7999 * It also assumes that the IEs in the buffer are ordered
8000 * correctly, if not the result of using this function will not
8001 * be ordered correctly either, i.e. it does no reordering.
8003 * The function returns the offset where the next part of the
8004 * buffer starts, which may be @ielen if the entire (remainder)
8005 * of the buffer should be used.
8007 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
8008 const u8 *ids, int n_ids,
8009 const u8 *after_ric, int n_after_ric,
8013 * ieee80211_ie_split - split an IE buffer according to ordering
8014 * @ies: the IE buffer
8015 * @ielen: the length of the IE buffer
8016 * @ids: an array with element IDs that are allowed before
8017 * the split. A WLAN_EID_EXTENSION value means that the next
8018 * EID in the list is a sub-element of the EXTENSION IE.
8019 * @n_ids: the size of the element ID array
8020 * @offset: offset where to start splitting in the buffer
8022 * This function splits an IE buffer by updating the @offset
8023 * variable to point to the location where the buffer should be
8026 * It assumes that the given IE buffer is well-formed, this
8027 * has to be guaranteed by the caller!
8029 * It also assumes that the IEs in the buffer are ordered
8030 * correctly, if not the result of using this function will not
8031 * be ordered correctly either, i.e. it does no reordering.
8033 * The function returns the offset where the next part of the
8034 * buffer starts, which may be @ielen if the entire (remainder)
8035 * of the buffer should be used.
8037 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
8038 const u8 *ids, int n_ids, size_t offset)
8040 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
8044 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
8045 * @wdev: the wireless device reporting the wakeup
8046 * @wakeup: the wakeup report
8047 * @gfp: allocation flags
8049 * This function reports that the given device woke up. If it
8050 * caused the wakeup, report the reason(s), otherwise you may
8051 * pass %NULL as the @wakeup parameter to advertise that something
8052 * else caused the wakeup.
8054 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
8055 struct cfg80211_wowlan_wakeup *wakeup,
8059 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
8061 * @wdev: the wireless device for which critical protocol is stopped.
8062 * @gfp: allocation flags
8064 * This function can be called by the driver to indicate it has reverted
8065 * operation back to normal. One reason could be that the duration given
8066 * by .crit_proto_start() has expired.
8068 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
8071 * ieee80211_get_num_supported_channels - get number of channels device has
8074 * Return: the number of channels supported by the device.
8076 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
8079 * cfg80211_check_combinations - check interface combinations
8082 * @params: the interface combinations parameter
8084 * This function can be called by the driver to check whether a
8085 * combination of interfaces and their types are allowed according to
8086 * the interface combinations.
8088 int cfg80211_check_combinations(struct wiphy *wiphy,
8089 struct iface_combination_params *params);
8092 * cfg80211_iter_combinations - iterate over matching combinations
8095 * @params: the interface combinations parameter
8096 * @iter: function to call for each matching combination
8097 * @data: pointer to pass to iter function
8099 * This function can be called by the driver to check what possible
8100 * combinations it fits in at a given moment, e.g. for channel switching
8103 int cfg80211_iter_combinations(struct wiphy *wiphy,
8104 struct iface_combination_params *params,
8105 void (*iter)(const struct ieee80211_iface_combination *c,
8110 * cfg80211_stop_iface - trigger interface disconnection
8113 * @wdev: wireless device
8114 * @gfp: context flags
8116 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
8119 * Note: This doesn't need any locks and is asynchronous.
8121 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
8125 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
8126 * @wiphy: the wiphy to shut down
8128 * This function shuts down all interfaces belonging to this wiphy by
8129 * calling dev_close() (and treating non-netdev interfaces as needed).
8130 * It shouldn't really be used unless there are some fatal device errors
8131 * that really can't be recovered in any other way.
8133 * Callers must hold the RTNL and be able to deal with callbacks into
8134 * the driver while the function is running.
8136 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
8139 * wiphy_ext_feature_set - set the extended feature flag
8141 * @wiphy: the wiphy to modify.
8142 * @ftidx: extended feature bit index.
8144 * The extended features are flagged in multiple bytes (see
8145 * &struct wiphy.@ext_features)
8147 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
8148 enum nl80211_ext_feature_index ftidx)
8152 ft_byte = &wiphy->ext_features[ftidx / 8];
8153 *ft_byte |= BIT(ftidx % 8);
8157 * wiphy_ext_feature_isset - check the extended feature flag
8159 * @wiphy: the wiphy to modify.
8160 * @ftidx: extended feature bit index.
8162 * The extended features are flagged in multiple bytes (see
8163 * &struct wiphy.@ext_features)
8166 wiphy_ext_feature_isset(struct wiphy *wiphy,
8167 enum nl80211_ext_feature_index ftidx)
8171 ft_byte = wiphy->ext_features[ftidx / 8];
8172 return (ft_byte & BIT(ftidx % 8)) != 0;
8176 * cfg80211_free_nan_func - free NAN function
8177 * @f: NAN function that should be freed
8179 * Frees all the NAN function and all it's allocated members.
8181 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
8184 * struct cfg80211_nan_match_params - NAN match parameters
8185 * @type: the type of the function that triggered a match. If it is
8186 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
8187 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
8189 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
8190 * @inst_id: the local instance id
8191 * @peer_inst_id: the instance id of the peer's function
8192 * @addr: the MAC address of the peer
8193 * @info_len: the length of the &info
8194 * @info: the Service Specific Info from the peer (if any)
8195 * @cookie: unique identifier of the corresponding function
8197 struct cfg80211_nan_match_params {
8198 enum nl80211_nan_function_type type;
8208 * cfg80211_nan_match - report a match for a NAN function.
8209 * @wdev: the wireless device reporting the match
8210 * @match: match notification parameters
8211 * @gfp: allocation flags
8213 * This function reports that the a NAN function had a match. This
8214 * can be a subscribe that had a match or a solicited publish that
8215 * was sent. It can also be a follow up that was received.
8217 void cfg80211_nan_match(struct wireless_dev *wdev,
8218 struct cfg80211_nan_match_params *match, gfp_t gfp);
8221 * cfg80211_nan_func_terminated - notify about NAN function termination.
8223 * @wdev: the wireless device reporting the match
8224 * @inst_id: the local instance id
8225 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
8226 * @cookie: unique NAN function identifier
8227 * @gfp: allocation flags
8229 * This function reports that the a NAN function is terminated.
8231 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
8233 enum nl80211_nan_func_term_reason reason,
8234 u64 cookie, gfp_t gfp);
8236 /* ethtool helper */
8237 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
8240 * cfg80211_external_auth_request - userspace request for authentication
8241 * @netdev: network device
8242 * @params: External authentication parameters
8243 * @gfp: allocation flags
8244 * Returns: 0 on success, < 0 on error
8246 int cfg80211_external_auth_request(struct net_device *netdev,
8247 struct cfg80211_external_auth_params *params,
8251 * cfg80211_pmsr_report - report peer measurement result data
8252 * @wdev: the wireless device reporting the measurement
8253 * @req: the original measurement request
8254 * @result: the result data
8255 * @gfp: allocation flags
8257 void cfg80211_pmsr_report(struct wireless_dev *wdev,
8258 struct cfg80211_pmsr_request *req,
8259 struct cfg80211_pmsr_result *result,
8263 * cfg80211_pmsr_complete - report peer measurement completed
8264 * @wdev: the wireless device reporting the measurement
8265 * @req: the original measurement request
8266 * @gfp: allocation flags
8268 * Report that the entire measurement completed, after this
8269 * the request pointer will no longer be valid.
8271 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
8272 struct cfg80211_pmsr_request *req,
8276 * cfg80211_iftype_allowed - check whether the interface can be allowed
8278 * @iftype: interface type
8279 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
8280 * @check_swif: check iftype against software interfaces
8282 * Check whether the interface is allowed to operate; additionally, this API
8283 * can be used to check iftype against the software interfaces when
8284 * check_swif is '1'.
8286 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
8287 bool is_4addr, u8 check_swif);
8291 * cfg80211_assoc_comeback - notification of association that was
8292 * temporarly rejected with a comeback
8293 * @netdev: network device
8294 * @bss: the bss entry with which association is in progress.
8295 * @timeout: timeout interval value TUs.
8297 * this function may sleep. the caller must hold the corresponding wdev's mutex.
8299 void cfg80211_assoc_comeback(struct net_device *netdev,
8300 struct cfg80211_bss *bss, u32 timeout);
8302 /* Logging, debugging and troubleshooting/diagnostic helpers. */
8304 /* wiphy_printk helpers, similar to dev_printk */
8306 #define wiphy_printk(level, wiphy, format, args...) \
8307 dev_printk(level, &(wiphy)->dev, format, ##args)
8308 #define wiphy_emerg(wiphy, format, args...) \
8309 dev_emerg(&(wiphy)->dev, format, ##args)
8310 #define wiphy_alert(wiphy, format, args...) \
8311 dev_alert(&(wiphy)->dev, format, ##args)
8312 #define wiphy_crit(wiphy, format, args...) \
8313 dev_crit(&(wiphy)->dev, format, ##args)
8314 #define wiphy_err(wiphy, format, args...) \
8315 dev_err(&(wiphy)->dev, format, ##args)
8316 #define wiphy_warn(wiphy, format, args...) \
8317 dev_warn(&(wiphy)->dev, format, ##args)
8318 #define wiphy_notice(wiphy, format, args...) \
8319 dev_notice(&(wiphy)->dev, format, ##args)
8320 #define wiphy_info(wiphy, format, args...) \
8321 dev_info(&(wiphy)->dev, format, ##args)
8322 #define wiphy_info_once(wiphy, format, args...) \
8323 dev_info_once(&(wiphy)->dev, format, ##args)
8325 #define wiphy_err_ratelimited(wiphy, format, args...) \
8326 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
8327 #define wiphy_warn_ratelimited(wiphy, format, args...) \
8328 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
8330 #define wiphy_debug(wiphy, format, args...) \
8331 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
8333 #define wiphy_dbg(wiphy, format, args...) \
8334 dev_dbg(&(wiphy)->dev, format, ##args)
8336 #if defined(VERBOSE_DEBUG)
8337 #define wiphy_vdbg wiphy_dbg
8339 #define wiphy_vdbg(wiphy, format, args...) \
8342 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8348 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8349 * of using a WARN/WARN_ON to get the message out, including the
8350 * file/line information and a backtrace.
8352 #define wiphy_WARN(wiphy, format, args...) \
8353 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8356 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8357 * @netdev: network device
8358 * @owe_info: peer's owe info
8359 * @gfp: allocation flags
8361 void cfg80211_update_owe_info_event(struct net_device *netdev,
8362 struct cfg80211_update_owe_info *owe_info,
8366 * cfg80211_bss_flush - resets all the scan entries
8369 void cfg80211_bss_flush(struct wiphy *wiphy);
8372 * cfg80211_bss_color_notify - notify about bss color event
8373 * @dev: network device
8374 * @gfp: allocation flags
8375 * @cmd: the actual event we want to notify
8376 * @count: the number of TBTTs until the color change happens
8377 * @color_bitmap: representations of the colors that the local BSS is aware of
8379 int cfg80211_bss_color_notify(struct net_device *dev, gfp_t gfp,
8380 enum nl80211_commands cmd, u8 count,
8384 * cfg80211_obss_color_collision_notify - notify about bss color collision
8385 * @dev: network device
8386 * @color_bitmap: representations of the colors that the local BSS is aware of
8388 static inline int cfg80211_obss_color_collision_notify(struct net_device *dev,
8391 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8392 NL80211_CMD_OBSS_COLOR_COLLISION,
8397 * cfg80211_color_change_started_notify - notify color change start
8398 * @dev: the device on which the color is switched
8399 * @count: the number of TBTTs until the color change happens
8401 * Inform the userspace about the color change that has started.
8403 static inline int cfg80211_color_change_started_notify(struct net_device *dev,
8406 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8407 NL80211_CMD_COLOR_CHANGE_STARTED,
8412 * cfg80211_color_change_aborted_notify - notify color change abort
8413 * @dev: the device on which the color is switched
8415 * Inform the userspace about the color change that has aborted.
8417 static inline int cfg80211_color_change_aborted_notify(struct net_device *dev)
8419 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8420 NL80211_CMD_COLOR_CHANGE_ABORTED,
8425 * cfg80211_color_change_notify - notify color change completion
8426 * @dev: the device on which the color was switched
8428 * Inform the userspace about the color change that has completed.
8430 static inline int cfg80211_color_change_notify(struct net_device *dev)
8432 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8433 NL80211_CMD_COLOR_CHANGE_COMPLETED,
8437 #endif /* __NET_CFG80211_H */