1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __NET_CFG80211_H
3 #define __NET_CFG80211_H
5 * 802.11 device and configuration interface
7 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright 2015-2017 Intel Deutschland GmbH
10 * Copyright (C) 2018-2020 Intel Corporation
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <linux/net.h>
23 #include <net/regulatory.h>
28 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29 * userspace and drivers, and offers some utility functionality associated
30 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31 * by all modern wireless drivers in Linux, so that they offer a consistent
32 * API through nl80211. For backward compatibility, cfg80211 also offers
33 * wireless extensions to userspace, but hides them from drivers completely.
35 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
41 * DOC: Device registration
43 * In order for a driver to use cfg80211, it must register the hardware device
44 * with cfg80211. This happens through a number of hardware capability structs
47 * The fundamental structure for each device is the 'wiphy', of which each
48 * instance describes a physical wireless device connected to the system. Each
49 * such wiphy can have zero, one, or many virtual interfaces associated with
50 * it, which need to be identified as such by pointing the network interface's
51 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52 * the wireless part of the interface, normally this struct is embedded in the
53 * network interface's private data area. Drivers can optionally allow creating
54 * or destroying virtual interfaces on the fly, but without at least one or the
55 * ability to create some the wireless device isn't useful.
57 * Each wiphy structure contains device capability information, and also has
58 * a pointer to the various operations the driver offers. The definitions and
59 * structures here describe these capabilities in detail.
65 * wireless hardware capability structures
69 * enum ieee80211_channel_flags - channel flags
71 * Channel flags set by the regulatory control code.
73 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
74 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
75 * sending probe requests or beaconing.
76 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
77 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
79 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
81 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
82 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
83 * this flag indicates that an 80 MHz channel cannot use this
84 * channel as the control or any of the secondary channels.
85 * This may be due to the driver or due to regulatory bandwidth
87 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
88 * this flag indicates that an 160 MHz channel cannot use this
89 * channel as the control or any of the secondary channels.
90 * This may be due to the driver or due to regulatory bandwidth
92 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
93 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
94 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
96 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
98 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
99 * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted
101 * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted
103 * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted
105 * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted
107 * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted
111 enum ieee80211_channel_flags {
112 IEEE80211_CHAN_DISABLED = 1<<0,
113 IEEE80211_CHAN_NO_IR = 1<<1,
115 IEEE80211_CHAN_RADAR = 1<<3,
116 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
117 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
118 IEEE80211_CHAN_NO_OFDM = 1<<6,
119 IEEE80211_CHAN_NO_80MHZ = 1<<7,
120 IEEE80211_CHAN_NO_160MHZ = 1<<8,
121 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
122 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
123 IEEE80211_CHAN_NO_20MHZ = 1<<11,
124 IEEE80211_CHAN_NO_10MHZ = 1<<12,
125 IEEE80211_CHAN_NO_HE = 1<<13,
126 IEEE80211_CHAN_1MHZ = 1<<14,
127 IEEE80211_CHAN_2MHZ = 1<<15,
128 IEEE80211_CHAN_4MHZ = 1<<16,
129 IEEE80211_CHAN_8MHZ = 1<<17,
130 IEEE80211_CHAN_16MHZ = 1<<18,
133 #define IEEE80211_CHAN_NO_HT40 \
134 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
136 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
137 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
140 * struct ieee80211_channel - channel definition
142 * This structure describes a single channel for use
145 * @center_freq: center frequency in MHz
146 * @freq_offset: offset from @center_freq, in KHz
147 * @hw_value: hardware-specific value for the channel
148 * @flags: channel flags from &enum ieee80211_channel_flags.
149 * @orig_flags: channel flags at registration time, used by regulatory
150 * code to support devices with additional restrictions
151 * @band: band this channel belongs to.
152 * @max_antenna_gain: maximum antenna gain in dBi
153 * @max_power: maximum transmission power (in dBm)
154 * @max_reg_power: maximum regulatory transmission power (in dBm)
155 * @beacon_found: helper to regulatory code to indicate when a beacon
156 * has been found on this channel. Use regulatory_hint_found_beacon()
157 * to enable this, this is useful only on 5 GHz band.
158 * @orig_mag: internal use
159 * @orig_mpwr: internal use
160 * @dfs_state: current state of this channel. Only relevant if radar is required
162 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
163 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
165 struct ieee80211_channel {
166 enum nl80211_band band;
171 int max_antenna_gain;
176 int orig_mag, orig_mpwr;
177 enum nl80211_dfs_state dfs_state;
178 unsigned long dfs_state_entered;
179 unsigned int dfs_cac_ms;
183 * enum ieee80211_rate_flags - rate flags
185 * Hardware/specification flags for rates. These are structured
186 * in a way that allows using the same bitrate structure for
187 * different bands/PHY modes.
189 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
190 * preamble on this bitrate; only relevant in 2.4GHz band and
192 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
193 * when used with 802.11a (on the 5 GHz band); filled by the
194 * core code when registering the wiphy.
195 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
196 * when used with 802.11b (on the 2.4 GHz band); filled by the
197 * core code when registering the wiphy.
198 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
199 * when used with 802.11g (on the 2.4 GHz band); filled by the
200 * core code when registering the wiphy.
201 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
202 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
203 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
205 enum ieee80211_rate_flags {
206 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
207 IEEE80211_RATE_MANDATORY_A = 1<<1,
208 IEEE80211_RATE_MANDATORY_B = 1<<2,
209 IEEE80211_RATE_MANDATORY_G = 1<<3,
210 IEEE80211_RATE_ERP_G = 1<<4,
211 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
212 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
216 * enum ieee80211_bss_type - BSS type filter
218 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
219 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
220 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
221 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
222 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
224 enum ieee80211_bss_type {
225 IEEE80211_BSS_TYPE_ESS,
226 IEEE80211_BSS_TYPE_PBSS,
227 IEEE80211_BSS_TYPE_IBSS,
228 IEEE80211_BSS_TYPE_MBSS,
229 IEEE80211_BSS_TYPE_ANY
233 * enum ieee80211_privacy - BSS privacy filter
235 * @IEEE80211_PRIVACY_ON: privacy bit set
236 * @IEEE80211_PRIVACY_OFF: privacy bit clear
237 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
239 enum ieee80211_privacy {
240 IEEE80211_PRIVACY_ON,
241 IEEE80211_PRIVACY_OFF,
242 IEEE80211_PRIVACY_ANY
245 #define IEEE80211_PRIVACY(x) \
246 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
249 * struct ieee80211_rate - bitrate definition
251 * This structure describes a bitrate that an 802.11 PHY can
252 * operate with. The two values @hw_value and @hw_value_short
253 * are only for driver use when pointers to this structure are
256 * @flags: rate-specific flags
257 * @bitrate: bitrate in units of 100 Kbps
258 * @hw_value: driver/hardware value for this rate
259 * @hw_value_short: driver/hardware value for this rate when
260 * short preamble is used
262 struct ieee80211_rate {
265 u16 hw_value, hw_value_short;
269 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
271 * @enable: is the feature enabled.
272 * @sr_ctrl: The SR Control field of SRP element.
273 * @non_srg_max_offset: non-SRG maximum tx power offset
274 * @min_offset: minimal tx power offset an associated station shall use
275 * @max_offset: maximum tx power offset an associated station shall use
276 * @bss_color_bitmap: bitmap that indicates the BSS color values used by
278 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
279 * used by members of the SRG
281 struct ieee80211_he_obss_pd {
284 u8 non_srg_max_offset;
287 u8 bss_color_bitmap[8];
288 u8 partial_bssid_bitmap[8];
292 * struct cfg80211_he_bss_color - AP settings for BSS coloring
294 * @color: the current color.
295 * @enabled: HE BSS color is used
296 * @partial: define the AID equation.
298 struct cfg80211_he_bss_color {
305 * struct ieee80211_he_bss_color - AP settings for BSS coloring
307 * @color: the current color.
308 * @disabled: is the feature disabled.
309 * @partial: define the AID equation.
311 struct ieee80211_he_bss_color {
318 * struct ieee80211_sta_ht_cap - STA's HT capabilities
320 * This structure describes most essential parameters needed
321 * to describe 802.11n HT capabilities for an STA.
323 * @ht_supported: is HT supported by the STA
324 * @cap: HT capabilities map as described in 802.11n spec
325 * @ampdu_factor: Maximum A-MPDU length factor
326 * @ampdu_density: Minimum A-MPDU spacing
327 * @mcs: Supported MCS rates
329 struct ieee80211_sta_ht_cap {
330 u16 cap; /* use IEEE80211_HT_CAP_ */
334 struct ieee80211_mcs_info mcs;
338 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
340 * This structure describes most essential parameters needed
341 * to describe 802.11ac VHT capabilities for an STA.
343 * @vht_supported: is VHT supported by the STA
344 * @cap: VHT capabilities map as described in 802.11ac spec
345 * @vht_mcs: Supported VHT MCS rates
347 struct ieee80211_sta_vht_cap {
349 u32 cap; /* use IEEE80211_VHT_CAP_ */
350 struct ieee80211_vht_mcs_info vht_mcs;
353 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
356 * struct ieee80211_sta_he_cap - STA's HE capabilities
358 * This structure describes most essential parameters needed
359 * to describe 802.11ax HE capabilities for a STA.
361 * @has_he: true iff HE data is valid.
362 * @he_cap_elem: Fixed portion of the HE capabilities element.
363 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
364 * @ppe_thres: Holds the PPE Thresholds data.
366 struct ieee80211_sta_he_cap {
368 struct ieee80211_he_cap_elem he_cap_elem;
369 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
370 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
374 * struct ieee80211_sband_iftype_data
376 * This structure encapsulates sband data that is relevant for the
377 * interface types defined in @types_mask. Each type in the
378 * @types_mask must be unique across all instances of iftype_data.
380 * @types_mask: interface types mask
381 * @he_cap: holds the HE capabilities
382 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
383 * 6 GHz band channel (and 0 may be valid value).
385 struct ieee80211_sband_iftype_data {
387 struct ieee80211_sta_he_cap he_cap;
388 struct ieee80211_he_6ghz_capa he_6ghz_capa;
392 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
394 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
395 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
396 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
397 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
398 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
399 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
400 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
401 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
403 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
405 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
407 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
408 * and 4.32GHz + 4.32GHz
409 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
410 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
412 enum ieee80211_edmg_bw_config {
413 IEEE80211_EDMG_BW_CONFIG_4 = 4,
414 IEEE80211_EDMG_BW_CONFIG_5 = 5,
415 IEEE80211_EDMG_BW_CONFIG_6 = 6,
416 IEEE80211_EDMG_BW_CONFIG_7 = 7,
417 IEEE80211_EDMG_BW_CONFIG_8 = 8,
418 IEEE80211_EDMG_BW_CONFIG_9 = 9,
419 IEEE80211_EDMG_BW_CONFIG_10 = 10,
420 IEEE80211_EDMG_BW_CONFIG_11 = 11,
421 IEEE80211_EDMG_BW_CONFIG_12 = 12,
422 IEEE80211_EDMG_BW_CONFIG_13 = 13,
423 IEEE80211_EDMG_BW_CONFIG_14 = 14,
424 IEEE80211_EDMG_BW_CONFIG_15 = 15,
428 * struct ieee80211_edmg - EDMG configuration
430 * This structure describes most essential parameters needed
431 * to describe 802.11ay EDMG configuration
433 * @channels: bitmap that indicates the 2.16 GHz channel(s)
434 * that are allowed to be used for transmissions.
435 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
436 * Set to 0 indicate EDMG not supported.
437 * @bw_config: Channel BW Configuration subfield encodes
438 * the allowed channel bandwidth configurations
440 struct ieee80211_edmg {
442 enum ieee80211_edmg_bw_config bw_config;
446 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
448 * This structure describes most essential parameters needed
449 * to describe 802.11ah S1G capabilities for a STA.
451 * @s1g_supported: is STA an S1G STA
452 * @cap: S1G capabilities information
453 * @nss_mcs: Supported NSS MCS set
455 struct ieee80211_sta_s1g_cap {
457 u8 cap[10]; /* use S1G_CAPAB_ */
462 * struct ieee80211_supported_band - frequency band definition
464 * This structure describes a frequency band a wiphy
465 * is able to operate in.
467 * @channels: Array of channels the hardware can operate with
469 * @band: the band this structure represents
470 * @n_channels: Number of channels in @channels
471 * @bitrates: Array of bitrates the hardware can operate with
472 * in this band. Must be sorted to give a valid "supported
473 * rates" IE, i.e. CCK rates first, then OFDM.
474 * @n_bitrates: Number of bitrates in @bitrates
475 * @ht_cap: HT capabilities in this band
476 * @vht_cap: VHT capabilities in this band
477 * @s1g_cap: S1G capabilities in this band
478 * @edmg_cap: EDMG capabilities in this band
479 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
480 * @n_iftype_data: number of iftype data entries
481 * @iftype_data: interface type data entries. Note that the bits in
482 * @types_mask inside this structure cannot overlap (i.e. only
483 * one occurrence of each type is allowed across all instances of
486 struct ieee80211_supported_band {
487 struct ieee80211_channel *channels;
488 struct ieee80211_rate *bitrates;
489 enum nl80211_band band;
492 struct ieee80211_sta_ht_cap ht_cap;
493 struct ieee80211_sta_vht_cap vht_cap;
494 struct ieee80211_sta_s1g_cap s1g_cap;
495 struct ieee80211_edmg edmg_cap;
497 const struct ieee80211_sband_iftype_data *iftype_data;
501 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
502 * @sband: the sband to search for the STA on
503 * @iftype: enum nl80211_iftype
505 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
507 static inline const struct ieee80211_sband_iftype_data *
508 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
513 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
516 if (iftype == NL80211_IFTYPE_AP_VLAN)
517 iftype = NL80211_IFTYPE_AP;
519 for (i = 0; i < sband->n_iftype_data; i++) {
520 const struct ieee80211_sband_iftype_data *data =
521 &sband->iftype_data[i];
523 if (data->types_mask & BIT(iftype))
531 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
532 * @sband: the sband to search for the iftype on
533 * @iftype: enum nl80211_iftype
535 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
537 static inline const struct ieee80211_sta_he_cap *
538 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
541 const struct ieee80211_sband_iftype_data *data =
542 ieee80211_get_sband_iftype_data(sband, iftype);
544 if (data && data->he_cap.has_he)
545 return &data->he_cap;
551 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
552 * @sband: the sband to search for the STA on
554 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
556 static inline const struct ieee80211_sta_he_cap *
557 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
559 return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
563 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
564 * @sband: the sband to search for the STA on
565 * @iftype: the iftype to search for
567 * Return: the 6GHz capabilities
570 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
571 enum nl80211_iftype iftype)
573 const struct ieee80211_sband_iftype_data *data =
574 ieee80211_get_sband_iftype_data(sband, iftype);
576 if (WARN_ON(!data || !data->he_cap.has_he))
579 return data->he_6ghz_capa.capa;
583 * wiphy_read_of_freq_limits - read frequency limits from device tree
585 * @wiphy: the wireless device to get extra limits for
587 * Some devices may have extra limitations specified in DT. This may be useful
588 * for chipsets that normally support more bands but are limited due to board
589 * design (e.g. by antennas or external power amplifier).
591 * This function reads info from DT and uses it to *modify* channels (disable
592 * unavailable ones). It's usually a *bad* idea to use it in drivers with
593 * shared channel data as DT limitations are device specific. You should make
594 * sure to call it only if channels in wiphy are copied and can be modified
595 * without affecting other devices.
597 * As this function access device node it has to be called after set_wiphy_dev.
598 * It also modifies channels so they have to be set first.
599 * If using this helper, call it before wiphy_register().
602 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
603 #else /* CONFIG_OF */
604 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
607 #endif /* !CONFIG_OF */
611 * Wireless hardware/device configuration structures and methods
615 * DOC: Actions and configuration
617 * Each wireless device and each virtual interface offer a set of configuration
618 * operations and other actions that are invoked by userspace. Each of these
619 * actions is described in the operations structure, and the parameters these
620 * operations use are described separately.
622 * Additionally, some operations are asynchronous and expect to get status
623 * information via some functions that drivers need to call.
625 * Scanning and BSS list handling with its associated functionality is described
626 * in a separate chapter.
629 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
630 WLAN_USER_POSITION_LEN)
633 * struct vif_params - describes virtual interface parameters
634 * @flags: monitor interface flags, unchanged if 0, otherwise
635 * %MONITOR_FLAG_CHANGED will be set
636 * @use_4addr: use 4-address frames
637 * @macaddr: address to use for this virtual interface.
638 * If this parameter is set to zero address the driver may
639 * determine the address as needed.
640 * This feature is only fully supported by drivers that enable the
641 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
642 ** only p2p devices with specified MAC.
643 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
644 * belonging to that MU-MIMO groupID; %NULL if not changed
645 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
646 * MU-MIMO packets going to the specified station; %NULL if not changed
651 u8 macaddr[ETH_ALEN];
652 const u8 *vht_mumimo_groups;
653 const u8 *vht_mumimo_follow_addr;
657 * struct key_params - key information
659 * Information about a key
662 * @key_len: length of key material
663 * @cipher: cipher suite selector
664 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
665 * with the get_key() callback, must be in little endian,
666 * length given by @seq_len.
667 * @seq_len: length of @seq.
668 * @vlan_id: vlan_id for VLAN group key (if nonzero)
669 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
678 enum nl80211_key_mode mode;
682 * struct cfg80211_chan_def - channel definition
683 * @chan: the (control) channel
684 * @width: channel width
685 * @center_freq1: center frequency of first segment
686 * @center_freq2: center frequency of second segment
687 * (only with 80+80 MHz)
688 * @edmg: define the EDMG channels configuration.
689 * If edmg is requested (i.e. the .channels member is non-zero),
690 * chan will define the primary channel and all other
691 * parameters are ignored.
692 * @freq1_offset: offset from @center_freq1, in KHz
694 struct cfg80211_chan_def {
695 struct ieee80211_channel *chan;
696 enum nl80211_chan_width width;
699 struct ieee80211_edmg edmg;
704 * cfg80211_bitrate_mask - masks for bitrate control
706 struct cfg80211_bitrate_mask {
709 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
710 u16 vht_mcs[NL80211_VHT_NSS_MAX];
711 u16 he_mcs[NL80211_HE_NSS_MAX];
712 enum nl80211_txrate_gi gi;
713 enum nl80211_he_gi he_gi;
714 enum nl80211_he_ltf he_ltf;
715 } control[NUM_NL80211_BANDS];
720 * struct cfg80211_tid_cfg - TID specific configuration
721 * @config_override: Flag to notify driver to reset TID configuration
723 * @tids: bitmap of TIDs to modify
724 * @mask: bitmap of attributes indicating which parameter changed,
725 * similar to &nl80211_tid_config_supp.
726 * @noack: noack configuration value for the TID
727 * @retry_long: retry count value
728 * @retry_short: retry count value
729 * @ampdu: Enable/Disable MPDU aggregation
730 * @rtscts: Enable/Disable RTS/CTS
731 * @amsdu: Enable/Disable MSDU aggregation
732 * @txrate_type: Tx bitrate mask type
733 * @txrate_mask: Tx bitrate to be applied for the TID
735 struct cfg80211_tid_cfg {
736 bool config_override;
739 enum nl80211_tid_config noack;
740 u8 retry_long, retry_short;
741 enum nl80211_tid_config ampdu;
742 enum nl80211_tid_config rtscts;
743 enum nl80211_tid_config amsdu;
744 enum nl80211_tx_rate_setting txrate_type;
745 struct cfg80211_bitrate_mask txrate_mask;
749 * struct cfg80211_tid_config - TID configuration
750 * @peer: Station's MAC address
751 * @n_tid_conf: Number of TID specific configurations to be applied
752 * @tid_conf: Configuration change info
754 struct cfg80211_tid_config {
757 struct cfg80211_tid_cfg tid_conf[];
761 * cfg80211_get_chandef_type - return old channel type from chandef
762 * @chandef: the channel definition
764 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
765 * chandef, which must have a bandwidth allowing this conversion.
767 static inline enum nl80211_channel_type
768 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
770 switch (chandef->width) {
771 case NL80211_CHAN_WIDTH_20_NOHT:
772 return NL80211_CHAN_NO_HT;
773 case NL80211_CHAN_WIDTH_20:
774 return NL80211_CHAN_HT20;
775 case NL80211_CHAN_WIDTH_40:
776 if (chandef->center_freq1 > chandef->chan->center_freq)
777 return NL80211_CHAN_HT40PLUS;
778 return NL80211_CHAN_HT40MINUS;
781 return NL80211_CHAN_NO_HT;
786 * cfg80211_chandef_create - create channel definition using channel type
787 * @chandef: the channel definition struct to fill
788 * @channel: the control channel
789 * @chantype: the channel type
791 * Given a channel type, create a channel definition.
793 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
794 struct ieee80211_channel *channel,
795 enum nl80211_channel_type chantype);
798 * cfg80211_chandef_identical - check if two channel definitions are identical
799 * @chandef1: first channel definition
800 * @chandef2: second channel definition
802 * Return: %true if the channels defined by the channel definitions are
803 * identical, %false otherwise.
806 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
807 const struct cfg80211_chan_def *chandef2)
809 return (chandef1->chan == chandef2->chan &&
810 chandef1->width == chandef2->width &&
811 chandef1->center_freq1 == chandef2->center_freq1 &&
812 chandef1->freq1_offset == chandef2->freq1_offset &&
813 chandef1->center_freq2 == chandef2->center_freq2);
817 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
819 * @chandef: the channel definition
821 * Return: %true if EDMG defined, %false otherwise.
824 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
826 return chandef->edmg.channels || chandef->edmg.bw_config;
830 * cfg80211_chandef_compatible - check if two channel definitions are compatible
831 * @chandef1: first channel definition
832 * @chandef2: second channel definition
834 * Return: %NULL if the given channel definitions are incompatible,
835 * chandef1 or chandef2 otherwise.
837 const struct cfg80211_chan_def *
838 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
839 const struct cfg80211_chan_def *chandef2);
842 * cfg80211_chandef_valid - check if a channel definition is valid
843 * @chandef: the channel definition to check
844 * Return: %true if the channel definition is valid. %false otherwise.
846 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
849 * cfg80211_chandef_usable - check if secondary channels can be used
850 * @wiphy: the wiphy to validate against
851 * @chandef: the channel definition to check
852 * @prohibited_flags: the regulatory channel flags that must not be set
853 * Return: %true if secondary channels are usable. %false otherwise.
855 bool cfg80211_chandef_usable(struct wiphy *wiphy,
856 const struct cfg80211_chan_def *chandef,
857 u32 prohibited_flags);
860 * cfg80211_chandef_dfs_required - checks if radar detection is required
861 * @wiphy: the wiphy to validate against
862 * @chandef: the channel definition to check
863 * @iftype: the interface type as specified in &enum nl80211_iftype
865 * 1 if radar detection is required, 0 if it is not, < 0 on error
867 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
868 const struct cfg80211_chan_def *chandef,
869 enum nl80211_iftype iftype);
872 * ieee80211_chandef_rate_flags - returns rate flags for a channel
874 * In some channel types, not all rates may be used - for example CCK
875 * rates may not be used in 5/10 MHz channels.
877 * @chandef: channel definition for the channel
879 * Returns: rate flags which apply for this channel
881 static inline enum ieee80211_rate_flags
882 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
884 switch (chandef->width) {
885 case NL80211_CHAN_WIDTH_5:
886 return IEEE80211_RATE_SUPPORTS_5MHZ;
887 case NL80211_CHAN_WIDTH_10:
888 return IEEE80211_RATE_SUPPORTS_10MHZ;
896 * ieee80211_chandef_max_power - maximum transmission power for the chandef
898 * In some regulations, the transmit power may depend on the configured channel
899 * bandwidth which may be defined as dBm/MHz. This function returns the actual
900 * max_power for non-standard (20 MHz) channels.
902 * @chandef: channel definition for the channel
904 * Returns: maximum allowed transmission power in dBm for the chandef
907 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
909 switch (chandef->width) {
910 case NL80211_CHAN_WIDTH_5:
911 return min(chandef->chan->max_reg_power - 6,
912 chandef->chan->max_power);
913 case NL80211_CHAN_WIDTH_10:
914 return min(chandef->chan->max_reg_power - 3,
915 chandef->chan->max_power);
919 return chandef->chan->max_power;
923 * enum survey_info_flags - survey information flags
925 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
926 * @SURVEY_INFO_IN_USE: channel is currently being used
927 * @SURVEY_INFO_TIME: active time (in ms) was filled in
928 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
929 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
930 * @SURVEY_INFO_TIME_RX: receive time was filled in
931 * @SURVEY_INFO_TIME_TX: transmit time was filled in
932 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
933 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
935 * Used by the driver to indicate which info in &struct survey_info
936 * it has filled in during the get_survey().
938 enum survey_info_flags {
939 SURVEY_INFO_NOISE_DBM = BIT(0),
940 SURVEY_INFO_IN_USE = BIT(1),
941 SURVEY_INFO_TIME = BIT(2),
942 SURVEY_INFO_TIME_BUSY = BIT(3),
943 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
944 SURVEY_INFO_TIME_RX = BIT(5),
945 SURVEY_INFO_TIME_TX = BIT(6),
946 SURVEY_INFO_TIME_SCAN = BIT(7),
947 SURVEY_INFO_TIME_BSS_RX = BIT(8),
951 * struct survey_info - channel survey response
953 * @channel: the channel this survey record reports, may be %NULL for a single
954 * record to report global statistics
955 * @filled: bitflag of flags from &enum survey_info_flags
956 * @noise: channel noise in dBm. This and all following fields are
958 * @time: amount of time in ms the radio was turn on (on the channel)
959 * @time_busy: amount of time the primary channel was sensed busy
960 * @time_ext_busy: amount of time the extension channel was sensed busy
961 * @time_rx: amount of time the radio spent receiving data
962 * @time_tx: amount of time the radio spent transmitting data
963 * @time_scan: amount of time the radio spent for scanning
964 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
966 * Used by dump_survey() to report back per-channel survey information.
968 * This structure can later be expanded with things like
969 * channel duty cycle etc.
972 struct ieee80211_channel *channel;
984 #define CFG80211_MAX_WEP_KEYS 4
987 * struct cfg80211_crypto_settings - Crypto settings
988 * @wpa_versions: indicates which, if any, WPA versions are enabled
989 * (from enum nl80211_wpa_versions)
990 * @cipher_group: group key cipher suite (or 0 if unset)
991 * @n_ciphers_pairwise: number of AP supported unicast ciphers
992 * @ciphers_pairwise: unicast key cipher suites
993 * @n_akm_suites: number of AKM suites
994 * @akm_suites: AKM suites
995 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
996 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
997 * required to assume that the port is unauthorized until authorized by
998 * user space. Otherwise, port is marked authorized by default.
999 * @control_port_ethertype: the control port protocol that should be
1000 * allowed through even on unauthorized ports
1001 * @control_port_no_encrypt: TRUE to prevent encryption of control port
1003 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1004 * port frames over NL80211 instead of the network interface.
1005 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
1007 * @wep_keys: static WEP keys, if not NULL points to an array of
1008 * CFG80211_MAX_WEP_KEYS WEP keys
1009 * @wep_tx_key: key index (0..3) of the default TX static WEP key
1010 * @psk: PSK (for devices supporting 4-way-handshake offload)
1011 * @sae_pwd: password for SAE authentication (for devices supporting SAE
1013 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1015 struct cfg80211_crypto_settings {
1018 int n_ciphers_pairwise;
1019 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1021 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
1023 __be16 control_port_ethertype;
1024 bool control_port_no_encrypt;
1025 bool control_port_over_nl80211;
1026 bool control_port_no_preauth;
1027 struct key_params *wep_keys;
1035 * struct cfg80211_beacon_data - beacon data
1036 * @head: head portion of beacon (before TIM IE)
1037 * or %NULL if not changed
1038 * @tail: tail portion of beacon (after TIM IE)
1039 * or %NULL if not changed
1040 * @head_len: length of @head
1041 * @tail_len: length of @tail
1042 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1043 * @beacon_ies_len: length of beacon_ies in octets
1044 * @proberesp_ies: extra information element(s) to add into Probe Response
1046 * @proberesp_ies_len: length of proberesp_ies in octets
1047 * @assocresp_ies: extra information element(s) to add into (Re)Association
1048 * Response frames or %NULL
1049 * @assocresp_ies_len: length of assocresp_ies in octets
1050 * @probe_resp_len: length of probe response template (@probe_resp)
1051 * @probe_resp: probe response template (AP mode only)
1052 * @ftm_responder: enable FTM responder functionality; -1 for no change
1053 * (which also implies no change in LCI/civic location data)
1054 * @lci: Measurement Report element content, starting with Measurement Token
1055 * (measurement type 8)
1056 * @civicloc: Measurement Report element content, starting with Measurement
1057 * Token (measurement type 11)
1058 * @lci_len: LCI data length
1059 * @civicloc_len: Civic location data length
1061 struct cfg80211_beacon_data {
1062 const u8 *head, *tail;
1063 const u8 *beacon_ies;
1064 const u8 *proberesp_ies;
1065 const u8 *assocresp_ies;
1066 const u8 *probe_resp;
1071 size_t head_len, tail_len;
1072 size_t beacon_ies_len;
1073 size_t proberesp_ies_len;
1074 size_t assocresp_ies_len;
1075 size_t probe_resp_len;
1077 size_t civicloc_len;
1080 struct mac_address {
1085 * struct cfg80211_acl_data - Access control list data
1087 * @acl_policy: ACL policy to be applied on the station's
1088 * entry specified by mac_addr
1089 * @n_acl_entries: Number of MAC address entries passed
1090 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1092 struct cfg80211_acl_data {
1093 enum nl80211_acl_policy acl_policy;
1097 struct mac_address mac_addrs[];
1101 * struct cfg80211_fils_discovery - FILS discovery parameters from
1102 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1104 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1105 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1106 * @tmpl_len: Template length
1107 * @tmpl: Template data for FILS discovery frame including the action
1110 struct cfg80211_fils_discovery {
1118 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1119 * response parameters in 6GHz.
1121 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1122 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1124 * @tmpl_len: Template length
1125 * @tmpl: Template data for probe response
1127 struct cfg80211_unsol_bcast_probe_resp {
1134 * enum cfg80211_ap_settings_flags - AP settings flags
1136 * Used by cfg80211_ap_settings
1138 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
1140 enum cfg80211_ap_settings_flags {
1141 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
1145 * struct cfg80211_ap_settings - AP configuration
1147 * Used to configure an AP interface.
1149 * @chandef: defines the channel to use
1150 * @beacon: beacon data
1151 * @beacon_interval: beacon interval
1152 * @dtim_period: DTIM period
1153 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1155 * @ssid_len: length of @ssid
1156 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1157 * @crypto: crypto settings
1158 * @privacy: the BSS uses privacy
1159 * @auth_type: Authentication type (algorithm)
1160 * @smps_mode: SMPS mode
1161 * @inactivity_timeout: time in seconds to determine station's inactivity.
1162 * @p2p_ctwindow: P2P CT Window
1163 * @p2p_opp_ps: P2P opportunistic PS
1164 * @acl: ACL configuration used by the drivers which has support for
1165 * MAC address based access control
1166 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1168 * @beacon_rate: bitrate to be used for beacons
1169 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1170 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1171 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1172 * @ht_required: stations must support HT
1173 * @vht_required: stations must support VHT
1174 * @twt_responder: Enable Target Wait Time
1175 * @he_required: stations must support HE
1176 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1177 * @he_obss_pd: OBSS Packet Detection settings
1178 * @he_bss_color: BSS Color settings
1179 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1180 * @fils_discovery: FILS discovery transmission parameters
1181 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1183 struct cfg80211_ap_settings {
1184 struct cfg80211_chan_def chandef;
1186 struct cfg80211_beacon_data beacon;
1188 int beacon_interval, dtim_period;
1191 enum nl80211_hidden_ssid hidden_ssid;
1192 struct cfg80211_crypto_settings crypto;
1194 enum nl80211_auth_type auth_type;
1195 enum nl80211_smps_mode smps_mode;
1196 int inactivity_timeout;
1199 const struct cfg80211_acl_data *acl;
1201 struct cfg80211_bitrate_mask beacon_rate;
1203 const struct ieee80211_ht_cap *ht_cap;
1204 const struct ieee80211_vht_cap *vht_cap;
1205 const struct ieee80211_he_cap_elem *he_cap;
1206 const struct ieee80211_he_operation *he_oper;
1207 bool ht_required, vht_required, he_required;
1210 struct ieee80211_he_obss_pd he_obss_pd;
1211 struct cfg80211_he_bss_color he_bss_color;
1212 struct cfg80211_fils_discovery fils_discovery;
1213 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1217 * struct cfg80211_csa_settings - channel switch settings
1219 * Used for channel switch
1221 * @chandef: defines the channel to use after the switch
1222 * @beacon_csa: beacon data while performing the switch
1223 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1224 * @counter_offsets_presp: offsets of the counters within the probe response
1225 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1226 * @n_counter_offsets_presp: number of csa counters in the probe response
1227 * @beacon_after: beacon data to be used on the new channel
1228 * @radar_required: whether radar detection is required on the new channel
1229 * @block_tx: whether transmissions should be blocked while changing
1230 * @count: number of beacons until switch
1232 struct cfg80211_csa_settings {
1233 struct cfg80211_chan_def chandef;
1234 struct cfg80211_beacon_data beacon_csa;
1235 const u16 *counter_offsets_beacon;
1236 const u16 *counter_offsets_presp;
1237 unsigned int n_counter_offsets_beacon;
1238 unsigned int n_counter_offsets_presp;
1239 struct cfg80211_beacon_data beacon_after;
1240 bool radar_required;
1245 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1248 * struct iface_combination_params - input parameters for interface combinations
1250 * Used to pass interface combination parameters
1252 * @num_different_channels: the number of different channels we want
1253 * to use for verification
1254 * @radar_detect: a bitmap where each bit corresponds to a channel
1255 * width where radar detection is needed, as in the definition of
1256 * &struct ieee80211_iface_combination.@radar_detect_widths
1257 * @iftype_num: array with the number of interfaces of each interface
1258 * type. The index is the interface type as specified in &enum
1260 * @new_beacon_int: set this to the beacon interval of a new interface
1261 * that's not operating yet, if such is to be checked as part of
1264 struct iface_combination_params {
1265 int num_different_channels;
1267 int iftype_num[NUM_NL80211_IFTYPES];
1272 * enum station_parameters_apply_mask - station parameter values to apply
1273 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1274 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1275 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1277 * Not all station parameters have in-band "no change" signalling,
1278 * for those that don't these flags will are used.
1280 enum station_parameters_apply_mask {
1281 STATION_PARAM_APPLY_UAPSD = BIT(0),
1282 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1283 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1284 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1288 * struct sta_txpwr - station txpower configuration
1290 * Used to configure txpower for station.
1292 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1293 * is not provided, the default per-interface tx power setting will be
1294 * overriding. Driver should be picking up the lowest tx power, either tx
1295 * power per-interface or per-station.
1296 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1297 * will be less than or equal to specified from userspace, whereas if TPC
1298 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1299 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1304 enum nl80211_tx_power_setting type;
1308 * struct station_parameters - station parameters
1310 * Used to change and create a new station.
1312 * @vlan: vlan interface station should belong to
1313 * @supported_rates: supported rates in IEEE 802.11 format
1314 * (or NULL for no change)
1315 * @supported_rates_len: number of supported rates
1316 * @sta_flags_mask: station flags that changed
1317 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1318 * @sta_flags_set: station flags values
1319 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1320 * @listen_interval: listen interval or -1 for no change
1321 * @aid: AID or zero for no change
1322 * @vlan_id: VLAN ID for station (if nonzero)
1323 * @peer_aid: mesh peer AID or zero for no change
1324 * @plink_action: plink action to take
1325 * @plink_state: set the peer link state for a station
1326 * @ht_capa: HT capabilities of station
1327 * @vht_capa: VHT capabilities of station
1328 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1329 * as the AC bitmap in the QoS info field
1330 * @max_sp: max Service Period. same format as the MAX_SP in the
1331 * QoS info field (but already shifted down)
1332 * @sta_modify_mask: bitmap indicating which parameters changed
1333 * (for those that don't have a natural "no change" value),
1334 * see &enum station_parameters_apply_mask
1335 * @local_pm: local link-specific mesh power save mode (no change when set
1337 * @capability: station capability
1338 * @ext_capab: extended capabilities of the station
1339 * @ext_capab_len: number of extended capabilities
1340 * @supported_channels: supported channels in IEEE 802.11 format
1341 * @supported_channels_len: number of supported channels
1342 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1343 * @supported_oper_classes_len: number of supported operating classes
1344 * @opmode_notif: operating mode field from Operating Mode Notification
1345 * @opmode_notif_used: information if operating mode field is used
1346 * @support_p2p_ps: information if station supports P2P PS mechanism
1347 * @he_capa: HE capabilities of station
1348 * @he_capa_len: the length of the HE capabilities
1349 * @airtime_weight: airtime scheduler weight for this station
1350 * @txpwr: transmit power for an associated station
1351 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1353 struct station_parameters {
1354 const u8 *supported_rates;
1355 struct net_device *vlan;
1356 u32 sta_flags_mask, sta_flags_set;
1357 u32 sta_modify_mask;
1358 int listen_interval;
1362 u8 supported_rates_len;
1365 const struct ieee80211_ht_cap *ht_capa;
1366 const struct ieee80211_vht_cap *vht_capa;
1369 enum nl80211_mesh_power_mode local_pm;
1371 const u8 *ext_capab;
1373 const u8 *supported_channels;
1374 u8 supported_channels_len;
1375 const u8 *supported_oper_classes;
1376 u8 supported_oper_classes_len;
1378 bool opmode_notif_used;
1380 const struct ieee80211_he_cap_elem *he_capa;
1383 struct sta_txpwr txpwr;
1384 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1388 * struct station_del_parameters - station deletion parameters
1390 * Used to delete a station entry (or all stations).
1392 * @mac: MAC address of the station to remove or NULL to remove all stations
1393 * @subtype: Management frame subtype to use for indicating removal
1394 * (10 = Disassociation, 12 = Deauthentication)
1395 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1397 struct station_del_parameters {
1404 * enum cfg80211_station_type - the type of station being modified
1405 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1406 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1407 * unassociated (update properties for this type of client is permitted)
1408 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1409 * the AP MLME in the device
1410 * @CFG80211_STA_AP_STA: AP station on managed interface
1411 * @CFG80211_STA_IBSS: IBSS station
1412 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1413 * while TDLS setup is in progress, it moves out of this state when
1414 * being marked authorized; use this only if TDLS with external setup is
1416 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1417 * entry that is operating, has been marked authorized by userspace)
1418 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1419 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1421 enum cfg80211_station_type {
1422 CFG80211_STA_AP_CLIENT,
1423 CFG80211_STA_AP_CLIENT_UNASSOC,
1424 CFG80211_STA_AP_MLME_CLIENT,
1425 CFG80211_STA_AP_STA,
1427 CFG80211_STA_TDLS_PEER_SETUP,
1428 CFG80211_STA_TDLS_PEER_ACTIVE,
1429 CFG80211_STA_MESH_PEER_KERNEL,
1430 CFG80211_STA_MESH_PEER_USER,
1434 * cfg80211_check_station_change - validate parameter changes
1435 * @wiphy: the wiphy this operates on
1436 * @params: the new parameters for a station
1437 * @statype: the type of station being modified
1439 * Utility function for the @change_station driver method. Call this function
1440 * with the appropriate station type looking up the station (and checking that
1441 * it exists). It will verify whether the station change is acceptable, and if
1442 * not will return an error code. Note that it may modify the parameters for
1443 * backward compatibility reasons, so don't use them before calling this.
1445 int cfg80211_check_station_change(struct wiphy *wiphy,
1446 struct station_parameters *params,
1447 enum cfg80211_station_type statype);
1450 * enum rate_info_flags - bitrate info flags
1452 * Used by the driver to indicate the specific rate transmission
1453 * type for 802.11n transmissions.
1455 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1456 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1457 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1458 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1459 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1460 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1462 enum rate_info_flags {
1463 RATE_INFO_FLAGS_MCS = BIT(0),
1464 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1465 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1466 RATE_INFO_FLAGS_DMG = BIT(3),
1467 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1468 RATE_INFO_FLAGS_EDMG = BIT(5),
1472 * enum rate_info_bw - rate bandwidth information
1474 * Used by the driver to indicate the rate bandwidth.
1476 * @RATE_INFO_BW_5: 5 MHz bandwidth
1477 * @RATE_INFO_BW_10: 10 MHz bandwidth
1478 * @RATE_INFO_BW_20: 20 MHz bandwidth
1479 * @RATE_INFO_BW_40: 40 MHz bandwidth
1480 * @RATE_INFO_BW_80: 80 MHz bandwidth
1481 * @RATE_INFO_BW_160: 160 MHz bandwidth
1482 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1485 RATE_INFO_BW_20 = 0,
1495 * struct rate_info - bitrate information
1497 * Information about a receiving or transmitting bitrate
1499 * @flags: bitflag of flags from &enum rate_info_flags
1500 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1501 * @legacy: bitrate in 100kbit/s for 802.11abg
1502 * @nss: number of streams (VHT & HE only)
1503 * @bw: bandwidth (from &enum rate_info_bw)
1504 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1505 * @he_dcm: HE DCM value
1506 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1507 * only valid if bw is %RATE_INFO_BW_HE_RU)
1508 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1523 * enum bss_param_flags - bitrate info flags
1525 * Used by the driver to indicate the specific rate transmission
1526 * type for 802.11n transmissions.
1528 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1529 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1530 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1532 enum bss_param_flags {
1533 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1534 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1535 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1539 * struct sta_bss_parameters - BSS parameters for the attached station
1541 * Information about the currently associated BSS
1543 * @flags: bitflag of flags from &enum bss_param_flags
1544 * @dtim_period: DTIM period for the BSS
1545 * @beacon_interval: beacon interval
1547 struct sta_bss_parameters {
1550 u16 beacon_interval;
1554 * struct cfg80211_txq_stats - TXQ statistics for this TID
1555 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1556 * indicate the relevant values in this struct are filled
1557 * @backlog_bytes: total number of bytes currently backlogged
1558 * @backlog_packets: total number of packets currently backlogged
1559 * @flows: number of new flows seen
1560 * @drops: total number of packets dropped
1561 * @ecn_marks: total number of packets marked with ECN CE
1562 * @overlimit: number of drops due to queue space overflow
1563 * @overmemory: number of drops due to memory limit overflow
1564 * @collisions: number of hash collisions
1565 * @tx_bytes: total number of bytes dequeued
1566 * @tx_packets: total number of packets dequeued
1567 * @max_flows: maximum number of flows supported
1569 struct cfg80211_txq_stats {
1572 u32 backlog_packets;
1585 * struct cfg80211_tid_stats - per-TID statistics
1586 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1587 * indicate the relevant values in this struct are filled
1588 * @rx_msdu: number of received MSDUs
1589 * @tx_msdu: number of (attempted) transmitted MSDUs
1590 * @tx_msdu_retries: number of retries (not counting the first) for
1592 * @tx_msdu_failed: number of failed transmitted MSDUs
1593 * @txq_stats: TXQ statistics
1595 struct cfg80211_tid_stats {
1599 u64 tx_msdu_retries;
1601 struct cfg80211_txq_stats txq_stats;
1604 #define IEEE80211_MAX_CHAINS 4
1607 * struct station_info - station information
1609 * Station information filled by driver for get_station() and dump_station.
1611 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1612 * indicate the relevant values in this struct for them
1613 * @connected_time: time(in secs) since a station is last connected
1614 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1615 * @assoc_at: bootime (ns) of the last association
1616 * @rx_bytes: bytes (size of MPDUs) received from this station
1617 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1618 * @llid: mesh local link id
1619 * @plid: mesh peer link id
1620 * @plink_state: mesh peer link state
1621 * @signal: The signal strength, type depends on the wiphy's signal_type.
1622 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1623 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1624 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1625 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1626 * @chain_signal: per-chain signal strength of last received packet in dBm
1627 * @chain_signal_avg: per-chain signal strength average in dBm
1628 * @txrate: current unicast bitrate from this station
1629 * @rxrate: current unicast bitrate to this station
1630 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1631 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1632 * @tx_retries: cumulative retry counts (MPDUs)
1633 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1634 * @rx_dropped_misc: Dropped for un-specified reason.
1635 * @bss_param: current BSS parameters
1636 * @generation: generation number for nl80211 dumps.
1637 * This number should increase every time the list of stations
1638 * changes, i.e. when a station is added or removed, so that
1639 * userspace can tell whether it got a consistent snapshot.
1640 * @assoc_req_ies: IEs from (Re)Association Request.
1641 * This is used only when in AP mode with drivers that do not use
1642 * user space MLME/SME implementation. The information is provided for
1643 * the cfg80211_new_sta() calls to notify user space of the IEs.
1644 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1645 * @sta_flags: station flags mask & values
1646 * @beacon_loss_count: Number of times beacon loss event has triggered.
1647 * @t_offset: Time offset of the station relative to this host.
1648 * @local_pm: local mesh STA power save mode
1649 * @peer_pm: peer mesh STA power save mode
1650 * @nonpeer_pm: non-peer mesh STA power save mode
1651 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1652 * towards this station.
1653 * @rx_beacon: number of beacons received from this peer
1654 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1656 * @connected_to_gate: true if mesh STA has a path to mesh gate
1657 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1658 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1659 * @airtime_weight: current airtime scheduling weight
1660 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1661 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1662 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1663 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1664 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1666 * @rx_mpdu_count: number of MPDUs received from this station
1667 * @fcs_err_count: number of packets (MPDUs) received from this station with
1668 * an FCS error. This counter should be incremented only when TA of the
1669 * received packet with an FCS error matches the peer MAC address.
1670 * @airtime_link_metric: mesh airtime link metric.
1671 * @connected_to_as: true if mesh STA has a path to authentication server
1673 struct station_info {
1687 s8 chain_signal[IEEE80211_MAX_CHAINS];
1688 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1690 struct rate_info txrate;
1691 struct rate_info rxrate;
1696 u32 rx_dropped_misc;
1697 struct sta_bss_parameters bss_param;
1698 struct nl80211_sta_flag_update sta_flags;
1702 const u8 *assoc_req_ies;
1703 size_t assoc_req_ies_len;
1705 u32 beacon_loss_count;
1707 enum nl80211_mesh_power_mode local_pm;
1708 enum nl80211_mesh_power_mode peer_pm;
1709 enum nl80211_mesh_power_mode nonpeer_pm;
1711 u32 expected_throughput;
1716 u8 rx_beacon_signal_avg;
1717 u8 connected_to_gate;
1719 struct cfg80211_tid_stats *pertid;
1728 u32 airtime_link_metric;
1733 #if IS_ENABLED(CONFIG_CFG80211)
1735 * cfg80211_get_station - retrieve information about a given station
1736 * @dev: the device where the station is supposed to be connected to
1737 * @mac_addr: the mac address of the station of interest
1738 * @sinfo: pointer to the structure to fill with the information
1740 * Returns 0 on success and sinfo is filled with the available information
1741 * otherwise returns a negative error code and the content of sinfo has to be
1742 * considered undefined.
1744 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1745 struct station_info *sinfo);
1747 static inline int cfg80211_get_station(struct net_device *dev,
1749 struct station_info *sinfo)
1756 * enum monitor_flags - monitor flags
1758 * Monitor interface configuration flags. Note that these must be the bits
1759 * according to the nl80211 flags.
1761 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1762 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1763 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1764 * @MONITOR_FLAG_CONTROL: pass control frames
1765 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1766 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1767 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1769 enum monitor_flags {
1770 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1771 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1772 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1773 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1774 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1775 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1776 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1780 * enum mpath_info_flags - mesh path information flags
1782 * Used by the driver to indicate which info in &struct mpath_info it has filled
1783 * in during get_station() or dump_station().
1785 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1786 * @MPATH_INFO_SN: @sn filled
1787 * @MPATH_INFO_METRIC: @metric filled
1788 * @MPATH_INFO_EXPTIME: @exptime filled
1789 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1790 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1791 * @MPATH_INFO_FLAGS: @flags filled
1792 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1793 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1795 enum mpath_info_flags {
1796 MPATH_INFO_FRAME_QLEN = BIT(0),
1797 MPATH_INFO_SN = BIT(1),
1798 MPATH_INFO_METRIC = BIT(2),
1799 MPATH_INFO_EXPTIME = BIT(3),
1800 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1801 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1802 MPATH_INFO_FLAGS = BIT(6),
1803 MPATH_INFO_HOP_COUNT = BIT(7),
1804 MPATH_INFO_PATH_CHANGE = BIT(8),
1808 * struct mpath_info - mesh path information
1810 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1812 * @filled: bitfield of flags from &enum mpath_info_flags
1813 * @frame_qlen: number of queued frames for this destination
1814 * @sn: target sequence number
1815 * @metric: metric (cost) of this mesh path
1816 * @exptime: expiration time for the mesh path from now, in msecs
1817 * @flags: mesh path flags
1818 * @discovery_timeout: total mesh path discovery timeout, in msecs
1819 * @discovery_retries: mesh path discovery retries
1820 * @generation: generation number for nl80211 dumps.
1821 * This number should increase every time the list of mesh paths
1822 * changes, i.e. when a station is added or removed, so that
1823 * userspace can tell whether it got a consistent snapshot.
1824 * @hop_count: hops to destination
1825 * @path_change_count: total number of path changes to destination
1833 u32 discovery_timeout;
1834 u8 discovery_retries;
1837 u32 path_change_count;
1843 * struct bss_parameters - BSS parameters
1845 * Used to change BSS parameters (mainly for AP mode).
1847 * @use_cts_prot: Whether to use CTS protection
1848 * (0 = no, 1 = yes, -1 = do not change)
1849 * @use_short_preamble: Whether the use of short preambles is allowed
1850 * (0 = no, 1 = yes, -1 = do not change)
1851 * @use_short_slot_time: Whether the use of short slot time is allowed
1852 * (0 = no, 1 = yes, -1 = do not change)
1853 * @basic_rates: basic rates in IEEE 802.11 format
1854 * (or NULL for no change)
1855 * @basic_rates_len: number of basic rates
1856 * @ap_isolate: do not forward packets between connected stations
1857 * (0 = no, 1 = yes, -1 = do not change)
1858 * @ht_opmode: HT Operation mode
1859 * (u16 = opmode, -1 = do not change)
1860 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1861 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1863 struct bss_parameters {
1865 int use_short_preamble;
1866 int use_short_slot_time;
1867 const u8 *basic_rates;
1871 s8 p2p_ctwindow, p2p_opp_ps;
1875 * struct mesh_config - 802.11s mesh configuration
1877 * These parameters can be changed while the mesh is active.
1879 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1880 * by the Mesh Peering Open message
1881 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1882 * used by the Mesh Peering Open message
1883 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1884 * the mesh peering management to close a mesh peering
1885 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1887 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1888 * be sent to establish a new peer link instance in a mesh
1889 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1890 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1892 * @auto_open_plinks: whether we should automatically open peer links when we
1893 * detect compatible mesh peers
1894 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1895 * synchronize to for 11s default synchronization method
1896 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1897 * that an originator mesh STA can send to a particular path target
1898 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1899 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1900 * a path discovery in milliseconds
1901 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1902 * receiving a PREQ shall consider the forwarding information from the
1903 * root to be valid. (TU = time unit)
1904 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1905 * which a mesh STA can send only one action frame containing a PREQ
1907 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1908 * which a mesh STA can send only one Action frame containing a PERR
1910 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1911 * it takes for an HWMP information element to propagate across the mesh
1912 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1913 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1914 * announcements are transmitted
1915 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1916 * station has access to a broader network beyond the MBSS. (This is
1917 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1918 * only means that the station will announce others it's a mesh gate, but
1919 * not necessarily using the gate announcement protocol. Still keeping the
1920 * same nomenclature to be in sync with the spec)
1921 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1922 * entity (default is TRUE - forwarding entity)
1923 * @rssi_threshold: the threshold for average signal strength of candidate
1924 * station to establish a peer link
1925 * @ht_opmode: mesh HT protection mode
1927 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1928 * receiving a proactive PREQ shall consider the forwarding information to
1929 * the root mesh STA to be valid.
1931 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1932 * PREQs are transmitted.
1933 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1934 * during which a mesh STA can send only one Action frame containing
1935 * a PREQ element for root path confirmation.
1936 * @power_mode: The default mesh power save mode which will be the initial
1937 * setting for new peer links.
1938 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1939 * after transmitting its beacon.
1940 * @plink_timeout: If no tx activity is seen from a STA we've established
1941 * peering with for longer than this time (in seconds), then remove it
1942 * from the STA's list of peers. Default is 30 minutes.
1943 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1944 * connected to a mesh gate in mesh formation info. If false, the
1945 * value in mesh formation is determined by the presence of root paths
1946 * in the mesh path table
1947 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
1948 * for HWMP) if the destination is a direct neighbor. Note that this might
1949 * not be the optimal decision as a multi-hop route might be better. So
1950 * if using this setting you will likely also want to disable
1951 * dot11MeshForwarding and use another mesh routing protocol on top.
1953 struct mesh_config {
1954 u16 dot11MeshRetryTimeout;
1955 u16 dot11MeshConfirmTimeout;
1956 u16 dot11MeshHoldingTimeout;
1957 u16 dot11MeshMaxPeerLinks;
1958 u8 dot11MeshMaxRetries;
1961 bool auto_open_plinks;
1962 u32 dot11MeshNbrOffsetMaxNeighbor;
1963 u8 dot11MeshHWMPmaxPREQretries;
1964 u32 path_refresh_time;
1965 u16 min_discovery_timeout;
1966 u32 dot11MeshHWMPactivePathTimeout;
1967 u16 dot11MeshHWMPpreqMinInterval;
1968 u16 dot11MeshHWMPperrMinInterval;
1969 u16 dot11MeshHWMPnetDiameterTraversalTime;
1970 u8 dot11MeshHWMPRootMode;
1971 bool dot11MeshConnectedToMeshGate;
1972 bool dot11MeshConnectedToAuthServer;
1973 u16 dot11MeshHWMPRannInterval;
1974 bool dot11MeshGateAnnouncementProtocol;
1975 bool dot11MeshForwarding;
1978 u32 dot11MeshHWMPactivePathToRootTimeout;
1979 u16 dot11MeshHWMProotInterval;
1980 u16 dot11MeshHWMPconfirmationInterval;
1981 enum nl80211_mesh_power_mode power_mode;
1982 u16 dot11MeshAwakeWindowDuration;
1984 bool dot11MeshNolearn;
1988 * struct mesh_setup - 802.11s mesh setup configuration
1989 * @chandef: defines the channel to use
1990 * @mesh_id: the mesh ID
1991 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1992 * @sync_method: which synchronization method to use
1993 * @path_sel_proto: which path selection protocol to use
1994 * @path_metric: which metric to use
1995 * @auth_id: which authentication method this mesh is using
1996 * @ie: vendor information elements (optional)
1997 * @ie_len: length of vendor information elements
1998 * @is_authenticated: this mesh requires authentication
1999 * @is_secure: this mesh uses security
2000 * @user_mpm: userspace handles all MPM functions
2001 * @dtim_period: DTIM period to use
2002 * @beacon_interval: beacon interval to use
2003 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2004 * @basic_rates: basic rates to use when creating the mesh
2005 * @beacon_rate: bitrate to be used for beacons
2006 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2007 * changes the channel when a radar is detected. This is required
2008 * to operate on DFS channels.
2009 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2010 * port frames over NL80211 instead of the network interface.
2012 * These parameters are fixed when the mesh is created.
2015 struct cfg80211_chan_def chandef;
2024 bool is_authenticated;
2028 u16 beacon_interval;
2029 int mcast_rate[NUM_NL80211_BANDS];
2031 struct cfg80211_bitrate_mask beacon_rate;
2032 bool userspace_handles_dfs;
2033 bool control_port_over_nl80211;
2037 * struct ocb_setup - 802.11p OCB mode setup configuration
2038 * @chandef: defines the channel to use
2040 * These parameters are fixed when connecting to the network
2043 struct cfg80211_chan_def chandef;
2047 * struct ieee80211_txq_params - TX queue parameters
2048 * @ac: AC identifier
2049 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2050 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2052 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2054 * @aifs: Arbitration interframe space [0..255]
2056 struct ieee80211_txq_params {
2065 * DOC: Scanning and BSS list handling
2067 * The scanning process itself is fairly simple, but cfg80211 offers quite
2068 * a bit of helper functionality. To start a scan, the scan operation will
2069 * be invoked with a scan definition. This scan definition contains the
2070 * channels to scan, and the SSIDs to send probe requests for (including the
2071 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2072 * probe. Additionally, a scan request may contain extra information elements
2073 * that should be added to the probe request. The IEs are guaranteed to be
2074 * well-formed, and will not exceed the maximum length the driver advertised
2075 * in the wiphy structure.
2077 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2078 * it is responsible for maintaining the BSS list; the driver should not
2079 * maintain a list itself. For this notification, various functions exist.
2081 * Since drivers do not maintain a BSS list, there are also a number of
2082 * functions to search for a BSS and obtain information about it from the
2083 * BSS structure cfg80211 maintains. The BSS list is also made available
2088 * struct cfg80211_ssid - SSID description
2090 * @ssid_len: length of the ssid
2092 struct cfg80211_ssid {
2093 u8 ssid[IEEE80211_MAX_SSID_LEN];
2098 * struct cfg80211_scan_info - information about completed scan
2099 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2100 * wireless device that requested the scan is connected to. If this
2101 * information is not available, this field is left zero.
2102 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2103 * @aborted: set to true if the scan was aborted for any reason,
2104 * userspace will be notified of that
2106 struct cfg80211_scan_info {
2108 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2113 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2115 * @short_bssid: short ssid to scan for
2116 * @bssid: bssid to scan for
2117 * @channel_idx: idx of the channel in the channel array in the scan request
2118 * which the above info relvant to
2119 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2120 * @short_ssid_valid: short_ssid is valid and can be used
2121 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2122 * 20 TUs before starting to send probe requests.
2124 struct cfg80211_scan_6ghz_params {
2128 bool unsolicited_probe;
2129 bool short_ssid_valid;
2134 * struct cfg80211_scan_request - scan request description
2136 * @ssids: SSIDs to scan for (active scan only)
2137 * @n_ssids: number of SSIDs
2138 * @channels: channels to scan on.
2139 * @n_channels: total number of channels to scan
2140 * @scan_width: channel width for scanning
2141 * @ie: optional information element(s) to add into Probe Request or %NULL
2142 * @ie_len: length of ie in octets
2143 * @duration: how long to listen on each channel, in TUs. If
2144 * %duration_mandatory is not set, this is the maximum dwell time and
2145 * the actual dwell time may be shorter.
2146 * @duration_mandatory: if set, the scan duration must be as specified by the
2148 * @flags: bit field of flags controlling operation
2149 * @rates: bitmap of rates to advertise for each band
2150 * @wiphy: the wiphy this was for
2151 * @scan_start: time (in jiffies) when the scan started
2152 * @wdev: the wireless device to scan for
2153 * @info: (internal) information about completed scan
2154 * @notified: (internal) scan request was notified as done or aborted
2155 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2156 * @mac_addr: MAC address used with randomisation
2157 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2158 * are 0 in the mask should be randomised, bits that are 1 should
2159 * be taken from the @mac_addr
2160 * @scan_6ghz: relevant for split scan request only,
2161 * true if this is the second scan request
2162 * @n_6ghz_params: number of 6 GHz params
2163 * @scan_6ghz_params: 6 GHz params
2164 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2166 struct cfg80211_scan_request {
2167 struct cfg80211_ssid *ssids;
2170 enum nl80211_bss_scan_width scan_width;
2174 bool duration_mandatory;
2177 u32 rates[NUM_NL80211_BANDS];
2179 struct wireless_dev *wdev;
2181 u8 mac_addr[ETH_ALEN] __aligned(2);
2182 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2183 u8 bssid[ETH_ALEN] __aligned(2);
2186 struct wiphy *wiphy;
2187 unsigned long scan_start;
2188 struct cfg80211_scan_info info;
2193 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2196 struct ieee80211_channel *channels[];
2199 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2203 get_random_bytes(buf, ETH_ALEN);
2204 for (i = 0; i < ETH_ALEN; i++) {
2206 buf[i] |= addr[i] & mask[i];
2211 * struct cfg80211_match_set - sets of attributes to match
2213 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2214 * or no match (RSSI only)
2215 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2216 * or no match (RSSI only)
2217 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2218 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2219 * for filtering out scan results received. Drivers advertize this support
2220 * of band specific rssi based filtering through the feature capability
2221 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2222 * specific rssi thresholds take precedence over rssi_thold, if specified.
2223 * If not specified for any band, it will be assigned with rssi_thold of
2224 * corresponding matchset.
2226 struct cfg80211_match_set {
2227 struct cfg80211_ssid ssid;
2230 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2234 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2236 * @interval: interval between scheduled scan iterations. In seconds.
2237 * @iterations: number of scan iterations in this scan plan. Zero means
2239 * The last scan plan will always have this parameter set to zero,
2240 * all other scan plans will have a finite number of iterations.
2242 struct cfg80211_sched_scan_plan {
2248 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2250 * @band: band of BSS which should match for RSSI level adjustment.
2251 * @delta: value of RSSI level adjustment.
2253 struct cfg80211_bss_select_adjust {
2254 enum nl80211_band band;
2259 * struct cfg80211_sched_scan_request - scheduled scan request description
2261 * @reqid: identifies this request.
2262 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2263 * @n_ssids: number of SSIDs
2264 * @n_channels: total number of channels to scan
2265 * @scan_width: channel width for scanning
2266 * @ie: optional information element(s) to add into Probe Request or %NULL
2267 * @ie_len: length of ie in octets
2268 * @flags: bit field of flags controlling operation
2269 * @match_sets: sets of parameters to be matched for a scan result
2270 * entry to be considered valid and to be passed to the host
2271 * (others are filtered out).
2272 * If ommited, all results are passed.
2273 * @n_match_sets: number of match sets
2274 * @report_results: indicates that results were reported for this request
2275 * @wiphy: the wiphy this was for
2276 * @dev: the interface
2277 * @scan_start: start time of the scheduled scan
2278 * @channels: channels to scan
2279 * @min_rssi_thold: for drivers only supporting a single threshold, this
2280 * contains the minimum over all matchsets
2281 * @mac_addr: MAC address used with randomisation
2282 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2283 * are 0 in the mask should be randomised, bits that are 1 should
2284 * be taken from the @mac_addr
2285 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2286 * index must be executed first.
2287 * @n_scan_plans: number of scan plans, at least 1.
2288 * @rcu_head: RCU callback used to free the struct
2289 * @owner_nlportid: netlink portid of owner (if this should is a request
2290 * owned by a particular socket)
2291 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2292 * @list: for keeping list of requests.
2293 * @delay: delay in seconds to use before starting the first scan
2294 * cycle. The driver may ignore this parameter and start
2295 * immediately (or at any other time), if this feature is not
2297 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2298 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2299 * reporting in connected state to cases where a matching BSS is determined
2300 * to have better or slightly worse RSSI than the current connected BSS.
2301 * The relative RSSI threshold values are ignored in disconnected state.
2302 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2303 * to the specified band while deciding whether a better BSS is reported
2304 * using @relative_rssi. If delta is a negative number, the BSSs that
2305 * belong to the specified band will be penalized by delta dB in relative
2308 struct cfg80211_sched_scan_request {
2310 struct cfg80211_ssid *ssids;
2313 enum nl80211_bss_scan_width scan_width;
2317 struct cfg80211_match_set *match_sets;
2321 struct cfg80211_sched_scan_plan *scan_plans;
2324 u8 mac_addr[ETH_ALEN] __aligned(2);
2325 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2327 bool relative_rssi_set;
2329 struct cfg80211_bss_select_adjust rssi_adjust;
2332 struct wiphy *wiphy;
2333 struct net_device *dev;
2334 unsigned long scan_start;
2335 bool report_results;
2336 struct rcu_head rcu_head;
2339 struct list_head list;
2342 struct ieee80211_channel *channels[];
2346 * enum cfg80211_signal_type - signal type
2348 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2349 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2350 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2352 enum cfg80211_signal_type {
2353 CFG80211_SIGNAL_TYPE_NONE,
2354 CFG80211_SIGNAL_TYPE_MBM,
2355 CFG80211_SIGNAL_TYPE_UNSPEC,
2359 * struct cfg80211_inform_bss - BSS inform data
2360 * @chan: channel the frame was received on
2361 * @scan_width: scan width that was used
2362 * @signal: signal strength value, according to the wiphy's
2364 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2365 * received; should match the time when the frame was actually
2366 * received by the device (not just by the host, in case it was
2367 * buffered on the device) and be accurate to about 10ms.
2368 * If the frame isn't buffered, just passing the return value of
2369 * ktime_get_boottime_ns() is likely appropriate.
2370 * @parent_tsf: the time at the start of reception of the first octet of the
2371 * timestamp field of the frame. The time is the TSF of the BSS specified
2373 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2374 * the BSS that requested the scan in which the beacon/probe was received.
2375 * @chains: bitmask for filled values in @chain_signal.
2376 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2378 struct cfg80211_inform_bss {
2379 struct ieee80211_channel *chan;
2380 enum nl80211_bss_scan_width scan_width;
2384 u8 parent_bssid[ETH_ALEN] __aligned(2);
2386 s8 chain_signal[IEEE80211_MAX_CHAINS];
2390 * struct cfg80211_bss_ies - BSS entry IE data
2391 * @tsf: TSF contained in the frame that carried these IEs
2392 * @rcu_head: internal use, for freeing
2393 * @len: length of the IEs
2394 * @from_beacon: these IEs are known to come from a beacon
2397 struct cfg80211_bss_ies {
2399 struct rcu_head rcu_head;
2406 * struct cfg80211_bss - BSS description
2408 * This structure describes a BSS (which may also be a mesh network)
2409 * for use in scan results and similar.
2411 * @channel: channel this BSS is on
2412 * @scan_width: width of the control channel
2413 * @bssid: BSSID of the BSS
2414 * @beacon_interval: the beacon interval as from the frame
2415 * @capability: the capability field in host byte order
2416 * @ies: the information elements (Note that there is no guarantee that these
2417 * are well-formed!); this is a pointer to either the beacon_ies or
2418 * proberesp_ies depending on whether Probe Response frame has been
2419 * received. It is always non-%NULL.
2420 * @beacon_ies: the information elements from the last Beacon frame
2421 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2422 * own the beacon_ies, but they're just pointers to the ones from the
2423 * @hidden_beacon_bss struct)
2424 * @proberesp_ies: the information elements from the last Probe Response frame
2425 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2426 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2427 * that holds the beacon data. @beacon_ies is still valid, of course, and
2428 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2429 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2430 * non-transmitted one (multi-BSSID support)
2431 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2432 * (multi-BSSID support)
2433 * @signal: signal strength value (type depends on the wiphy's signal_type)
2434 * @chains: bitmask for filled values in @chain_signal.
2435 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2436 * @bssid_index: index in the multiple BSS set
2437 * @max_bssid_indicator: max number of members in the BSS set
2438 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2440 struct cfg80211_bss {
2441 struct ieee80211_channel *channel;
2442 enum nl80211_bss_scan_width scan_width;
2444 const struct cfg80211_bss_ies __rcu *ies;
2445 const struct cfg80211_bss_ies __rcu *beacon_ies;
2446 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2448 struct cfg80211_bss *hidden_beacon_bss;
2449 struct cfg80211_bss *transmitted_bss;
2450 struct list_head nontrans_list;
2454 u16 beacon_interval;
2459 s8 chain_signal[IEEE80211_MAX_CHAINS];
2462 u8 max_bssid_indicator;
2464 u8 priv[] __aligned(sizeof(void *));
2468 * ieee80211_bss_get_elem - find element with given ID
2469 * @bss: the bss to search
2470 * @id: the element ID
2472 * Note that the return value is an RCU-protected pointer, so
2473 * rcu_read_lock() must be held when calling this function.
2474 * Return: %NULL if not found.
2476 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2479 * ieee80211_bss_get_ie - find IE with given ID
2480 * @bss: the bss to search
2481 * @id: the element ID
2483 * Note that the return value is an RCU-protected pointer, so
2484 * rcu_read_lock() must be held when calling this function.
2485 * Return: %NULL if not found.
2487 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2489 return (void *)ieee80211_bss_get_elem(bss, id);
2494 * struct cfg80211_auth_request - Authentication request data
2496 * This structure provides information needed to complete IEEE 802.11
2499 * @bss: The BSS to authenticate with, the callee must obtain a reference
2500 * to it if it needs to keep it.
2501 * @auth_type: Authentication type (algorithm)
2502 * @ie: Extra IEs to add to Authentication frame or %NULL
2503 * @ie_len: Length of ie buffer in octets
2504 * @key_len: length of WEP key for shared key authentication
2505 * @key_idx: index of WEP key for shared key authentication
2506 * @key: WEP key for shared key authentication
2507 * @auth_data: Fields and elements in Authentication frames. This contains
2508 * the authentication frame body (non-IE and IE data), excluding the
2509 * Authentication algorithm number, i.e., starting at the Authentication
2510 * transaction sequence number field.
2511 * @auth_data_len: Length of auth_data buffer in octets
2513 struct cfg80211_auth_request {
2514 struct cfg80211_bss *bss;
2517 enum nl80211_auth_type auth_type;
2519 u8 key_len, key_idx;
2520 const u8 *auth_data;
2521 size_t auth_data_len;
2525 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2527 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2528 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2529 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2530 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2531 * authentication capability. Drivers can offload authentication to
2532 * userspace if this flag is set. Only applicable for cfg80211_connect()
2533 * request (connect callback).
2535 enum cfg80211_assoc_req_flags {
2536 ASSOC_REQ_DISABLE_HT = BIT(0),
2537 ASSOC_REQ_DISABLE_VHT = BIT(1),
2538 ASSOC_REQ_USE_RRM = BIT(2),
2539 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2543 * struct cfg80211_assoc_request - (Re)Association request data
2545 * This structure provides information needed to complete IEEE 802.11
2547 * @bss: The BSS to associate with. If the call is successful the driver is
2548 * given a reference that it must give back to cfg80211_send_rx_assoc()
2549 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2550 * association requests while already associating must be rejected.
2551 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2552 * @ie_len: Length of ie buffer in octets
2553 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2554 * @crypto: crypto settings
2555 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2556 * to indicate a request to reassociate within the ESS instead of a request
2557 * do the initial association with the ESS. When included, this is set to
2558 * the BSSID of the current association, i.e., to the value that is
2559 * included in the Current AP address field of the Reassociation Request
2561 * @flags: See &enum cfg80211_assoc_req_flags
2562 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2563 * will be used in ht_capa. Un-supported values will be ignored.
2564 * @ht_capa_mask: The bits of ht_capa which are to be used.
2565 * @vht_capa: VHT capability override
2566 * @vht_capa_mask: VHT capability mask indicating which fields to use
2567 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2568 * %NULL if FILS is not used.
2569 * @fils_kek_len: Length of fils_kek in octets
2570 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2571 * Request/Response frame or %NULL if FILS is not used. This field starts
2572 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2573 * @s1g_capa: S1G capability override
2574 * @s1g_capa_mask: S1G capability override mask
2576 struct cfg80211_assoc_request {
2577 struct cfg80211_bss *bss;
2578 const u8 *ie, *prev_bssid;
2580 struct cfg80211_crypto_settings crypto;
2583 struct ieee80211_ht_cap ht_capa;
2584 struct ieee80211_ht_cap ht_capa_mask;
2585 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2587 size_t fils_kek_len;
2588 const u8 *fils_nonces;
2589 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2593 * struct cfg80211_deauth_request - Deauthentication request data
2595 * This structure provides information needed to complete IEEE 802.11
2598 * @bssid: the BSSID of the BSS to deauthenticate from
2599 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2600 * @ie_len: Length of ie buffer in octets
2601 * @reason_code: The reason code for the deauthentication
2602 * @local_state_change: if set, change local state only and
2603 * do not set a deauth frame
2605 struct cfg80211_deauth_request {
2610 bool local_state_change;
2614 * struct cfg80211_disassoc_request - Disassociation request data
2616 * This structure provides information needed to complete IEEE 802.11
2619 * @bss: the BSS to disassociate from
2620 * @ie: Extra IEs to add to Disassociation frame or %NULL
2621 * @ie_len: Length of ie buffer in octets
2622 * @reason_code: The reason code for the disassociation
2623 * @local_state_change: This is a request for a local state only, i.e., no
2624 * Disassociation frame is to be transmitted.
2626 struct cfg80211_disassoc_request {
2627 struct cfg80211_bss *bss;
2631 bool local_state_change;
2635 * struct cfg80211_ibss_params - IBSS parameters
2637 * This structure defines the IBSS parameters for the join_ibss()
2640 * @ssid: The SSID, will always be non-null.
2641 * @ssid_len: The length of the SSID, will always be non-zero.
2642 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2643 * search for IBSSs with a different BSSID.
2644 * @chandef: defines the channel to use if no other IBSS to join can be found
2645 * @channel_fixed: The channel should be fixed -- do not search for
2646 * IBSSs to join on other channels.
2647 * @ie: information element(s) to include in the beacon
2648 * @ie_len: length of that
2649 * @beacon_interval: beacon interval to use
2650 * @privacy: this is a protected network, keys will be configured
2652 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2653 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2654 * required to assume that the port is unauthorized until authorized by
2655 * user space. Otherwise, port is marked authorized by default.
2656 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2657 * port frames over NL80211 instead of the network interface.
2658 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2659 * changes the channel when a radar is detected. This is required
2660 * to operate on DFS channels.
2661 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2662 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2663 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2664 * will be used in ht_capa. Un-supported values will be ignored.
2665 * @ht_capa_mask: The bits of ht_capa which are to be used.
2666 * @wep_keys: static WEP keys, if not NULL points to an array of
2667 * CFG80211_MAX_WEP_KEYS WEP keys
2668 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2670 struct cfg80211_ibss_params {
2673 struct cfg80211_chan_def chandef;
2675 u8 ssid_len, ie_len;
2676 u16 beacon_interval;
2681 bool control_port_over_nl80211;
2682 bool userspace_handles_dfs;
2683 int mcast_rate[NUM_NL80211_BANDS];
2684 struct ieee80211_ht_cap ht_capa;
2685 struct ieee80211_ht_cap ht_capa_mask;
2686 struct key_params *wep_keys;
2691 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2693 * @behaviour: requested BSS selection behaviour.
2694 * @param: parameters for requestion behaviour.
2695 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2696 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2698 struct cfg80211_bss_selection {
2699 enum nl80211_bss_select_attr behaviour;
2701 enum nl80211_band band_pref;
2702 struct cfg80211_bss_select_adjust adjust;
2707 * struct cfg80211_connect_params - Connection parameters
2709 * This structure provides information needed to complete IEEE 802.11
2710 * authentication and association.
2712 * @channel: The channel to use or %NULL if not specified (auto-select based
2714 * @channel_hint: The channel of the recommended BSS for initial connection or
2715 * %NULL if not specified
2716 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2718 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2719 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2720 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2723 * @ssid_len: Length of ssid in octets
2724 * @auth_type: Authentication type (algorithm)
2725 * @ie: IEs for association request
2726 * @ie_len: Length of assoc_ie in octets
2727 * @privacy: indicates whether privacy-enabled APs should be used
2728 * @mfp: indicate whether management frame protection is used
2729 * @crypto: crypto settings
2730 * @key_len: length of WEP key for shared key authentication
2731 * @key_idx: index of WEP key for shared key authentication
2732 * @key: WEP key for shared key authentication
2733 * @flags: See &enum cfg80211_assoc_req_flags
2734 * @bg_scan_period: Background scan period in seconds
2735 * or -1 to indicate that default value is to be used.
2736 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2737 * will be used in ht_capa. Un-supported values will be ignored.
2738 * @ht_capa_mask: The bits of ht_capa which are to be used.
2739 * @vht_capa: VHT Capability overrides
2740 * @vht_capa_mask: The bits of vht_capa which are to be used.
2741 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2743 * @bss_select: criteria to be used for BSS selection.
2744 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2745 * to indicate a request to reassociate within the ESS instead of a request
2746 * do the initial association with the ESS. When included, this is set to
2747 * the BSSID of the current association, i.e., to the value that is
2748 * included in the Current AP address field of the Reassociation Request
2750 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2751 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2753 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2754 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2755 * %NULL if not specified. This specifies the domain name of ER server and
2756 * is used to construct FILS wrapped data IE.
2757 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2758 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2759 * messages. This is also used to construct FILS wrapped data IE.
2760 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2761 * keys in FILS or %NULL if not specified.
2762 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2763 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2764 * offload of 4-way handshake.
2765 * @edmg: define the EDMG channels.
2766 * This may specify multiple channels and bonding options for the driver
2767 * to choose from, based on BSS configuration.
2769 struct cfg80211_connect_params {
2770 struct ieee80211_channel *channel;
2771 struct ieee80211_channel *channel_hint;
2773 const u8 *bssid_hint;
2776 enum nl80211_auth_type auth_type;
2780 enum nl80211_mfp mfp;
2781 struct cfg80211_crypto_settings crypto;
2783 u8 key_len, key_idx;
2786 struct ieee80211_ht_cap ht_capa;
2787 struct ieee80211_ht_cap ht_capa_mask;
2788 struct ieee80211_vht_cap vht_capa;
2789 struct ieee80211_vht_cap vht_capa_mask;
2791 struct cfg80211_bss_selection bss_select;
2792 const u8 *prev_bssid;
2793 const u8 *fils_erp_username;
2794 size_t fils_erp_username_len;
2795 const u8 *fils_erp_realm;
2796 size_t fils_erp_realm_len;
2797 u16 fils_erp_next_seq_num;
2798 const u8 *fils_erp_rrk;
2799 size_t fils_erp_rrk_len;
2801 struct ieee80211_edmg edmg;
2805 * enum cfg80211_connect_params_changed - Connection parameters being updated
2807 * This enum provides information of all connect parameters that
2808 * have to be updated as part of update_connect_params() call.
2810 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2811 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2812 * username, erp sequence number and rrk) are updated
2813 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2815 enum cfg80211_connect_params_changed {
2816 UPDATE_ASSOC_IES = BIT(0),
2817 UPDATE_FILS_ERP_INFO = BIT(1),
2818 UPDATE_AUTH_TYPE = BIT(2),
2822 * enum wiphy_params_flags - set_wiphy_params bitfield values
2823 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2824 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2825 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2826 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2827 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2828 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2829 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2830 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2831 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2833 enum wiphy_params_flags {
2834 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2835 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2836 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2837 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2838 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2839 WIPHY_PARAM_DYN_ACK = 1 << 5,
2840 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2841 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2842 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2845 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2847 /* The per TXQ device queue limit in airtime */
2848 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2849 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2851 /* The per interface airtime threshold to switch to lower queue limit */
2852 #define IEEE80211_AQL_THRESHOLD 24000
2855 * struct cfg80211_pmksa - PMK Security Association
2857 * This structure is passed to the set/del_pmksa() method for PMKSA
2860 * @bssid: The AP's BSSID (may be %NULL).
2861 * @pmkid: The identifier to refer a PMKSA.
2862 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2863 * derivation by a FILS STA. Otherwise, %NULL.
2864 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2865 * the hash algorithm used to generate this.
2866 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2867 * cache identifier (may be %NULL).
2868 * @ssid_len: Length of the @ssid in octets.
2869 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2870 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2872 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
2873 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
2874 * The configured PMKSA must not be used for PMKSA caching after
2875 * expiration and any keys derived from this PMK become invalid on
2876 * expiration, i.e., the current association must be dropped if the PMK
2877 * used for it expires.
2878 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
2879 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
2880 * Drivers are expected to trigger a full authentication instead of using
2881 * this PMKSA for caching when reassociating to a new BSS after this
2882 * threshold to generate a new PMK before the current one expires.
2884 struct cfg80211_pmksa {
2893 u8 pmk_reauth_threshold;
2897 * struct cfg80211_pkt_pattern - packet pattern
2898 * @mask: bitmask where to match pattern and where to ignore bytes,
2899 * one bit per byte, in same format as nl80211
2900 * @pattern: bytes to match where bitmask is 1
2901 * @pattern_len: length of pattern (in bytes)
2902 * @pkt_offset: packet offset (in bytes)
2904 * Internal note: @mask and @pattern are allocated in one chunk of
2905 * memory, free @mask only!
2907 struct cfg80211_pkt_pattern {
2908 const u8 *mask, *pattern;
2914 * struct cfg80211_wowlan_tcp - TCP connection parameters
2916 * @sock: (internal) socket for source port allocation
2917 * @src: source IP address
2918 * @dst: destination IP address
2919 * @dst_mac: destination MAC address
2920 * @src_port: source port
2921 * @dst_port: destination port
2922 * @payload_len: data payload length
2923 * @payload: data payload buffer
2924 * @payload_seq: payload sequence stamping configuration
2925 * @data_interval: interval at which to send data packets
2926 * @wake_len: wakeup payload match length
2927 * @wake_data: wakeup payload match data
2928 * @wake_mask: wakeup payload match mask
2929 * @tokens_size: length of the tokens buffer
2930 * @payload_tok: payload token usage configuration
2932 struct cfg80211_wowlan_tcp {
2933 struct socket *sock;
2935 u16 src_port, dst_port;
2936 u8 dst_mac[ETH_ALEN];
2939 struct nl80211_wowlan_tcp_data_seq payload_seq;
2942 const u8 *wake_data, *wake_mask;
2944 /* must be last, variable member */
2945 struct nl80211_wowlan_tcp_data_token payload_tok;
2949 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2951 * This structure defines the enabled WoWLAN triggers for the device.
2952 * @any: wake up on any activity -- special trigger if device continues
2953 * operating as normal during suspend
2954 * @disconnect: wake up if getting disconnected
2955 * @magic_pkt: wake up on receiving magic packet
2956 * @patterns: wake up on receiving packet matching a pattern
2957 * @n_patterns: number of patterns
2958 * @gtk_rekey_failure: wake up on GTK rekey failure
2959 * @eap_identity_req: wake up on EAP identity request packet
2960 * @four_way_handshake: wake up on 4-way handshake
2961 * @rfkill_release: wake up when rfkill is released
2962 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2963 * NULL if not configured.
2964 * @nd_config: configuration for the scan to be used for net detect wake.
2966 struct cfg80211_wowlan {
2967 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2968 eap_identity_req, four_way_handshake,
2970 struct cfg80211_pkt_pattern *patterns;
2971 struct cfg80211_wowlan_tcp *tcp;
2973 struct cfg80211_sched_scan_request *nd_config;
2977 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2979 * This structure defines coalesce rule for the device.
2980 * @delay: maximum coalescing delay in msecs.
2981 * @condition: condition for packet coalescence.
2982 * see &enum nl80211_coalesce_condition.
2983 * @patterns: array of packet patterns
2984 * @n_patterns: number of patterns
2986 struct cfg80211_coalesce_rules {
2988 enum nl80211_coalesce_condition condition;
2989 struct cfg80211_pkt_pattern *patterns;
2994 * struct cfg80211_coalesce - Packet coalescing settings
2996 * This structure defines coalescing settings.
2997 * @rules: array of coalesce rules
2998 * @n_rules: number of rules
3000 struct cfg80211_coalesce {
3001 struct cfg80211_coalesce_rules *rules;
3006 * struct cfg80211_wowlan_nd_match - information about the match
3008 * @ssid: SSID of the match that triggered the wake up
3009 * @n_channels: Number of channels where the match occurred. This
3010 * value may be zero if the driver can't report the channels.
3011 * @channels: center frequencies of the channels where a match
3014 struct cfg80211_wowlan_nd_match {
3015 struct cfg80211_ssid ssid;
3021 * struct cfg80211_wowlan_nd_info - net detect wake up information
3023 * @n_matches: Number of match information instances provided in
3024 * @matches. This value may be zero if the driver can't provide
3025 * match information.
3026 * @matches: Array of pointers to matches containing information about
3027 * the matches that triggered the wake up.
3029 struct cfg80211_wowlan_nd_info {
3031 struct cfg80211_wowlan_nd_match *matches[];
3035 * struct cfg80211_wowlan_wakeup - wakeup report
3036 * @disconnect: woke up by getting disconnected
3037 * @magic_pkt: woke up by receiving magic packet
3038 * @gtk_rekey_failure: woke up by GTK rekey failure
3039 * @eap_identity_req: woke up by EAP identity request packet
3040 * @four_way_handshake: woke up by 4-way handshake
3041 * @rfkill_release: woke up by rfkill being released
3042 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3043 * @packet_present_len: copied wakeup packet data
3044 * @packet_len: original wakeup packet length
3045 * @packet: The packet causing the wakeup, if any.
3046 * @packet_80211: For pattern match, magic packet and other data
3047 * frame triggers an 802.3 frame should be reported, for
3048 * disconnect due to deauth 802.11 frame. This indicates which
3050 * @tcp_match: TCP wakeup packet received
3051 * @tcp_connlost: TCP connection lost or failed to establish
3052 * @tcp_nomoretokens: TCP data ran out of tokens
3053 * @net_detect: if not %NULL, woke up because of net detect
3055 struct cfg80211_wowlan_wakeup {
3056 bool disconnect, magic_pkt, gtk_rekey_failure,
3057 eap_identity_req, four_way_handshake,
3058 rfkill_release, packet_80211,
3059 tcp_match, tcp_connlost, tcp_nomoretokens;
3061 u32 packet_present_len, packet_len;
3063 struct cfg80211_wowlan_nd_info *net_detect;
3067 * struct cfg80211_gtk_rekey_data - rekey data
3068 * @kek: key encryption key (@kek_len bytes)
3069 * @kck: key confirmation key (@kck_len bytes)
3070 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3071 * @kek_len: length of kek
3072 * @kck_len length of kck
3073 * @akm: akm (oui, id)
3075 struct cfg80211_gtk_rekey_data {
3076 const u8 *kek, *kck, *replay_ctr;
3078 u8 kek_len, kck_len;
3082 * struct cfg80211_update_ft_ies_params - FT IE Information
3084 * This structure provides information needed to update the fast transition IE
3086 * @md: The Mobility Domain ID, 2 Octet value
3087 * @ie: Fast Transition IEs
3088 * @ie_len: Length of ft_ie in octets
3090 struct cfg80211_update_ft_ies_params {
3097 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3099 * This structure provides information needed to transmit a mgmt frame
3101 * @chan: channel to use
3102 * @offchan: indicates wether off channel operation is required
3103 * @wait: duration for ROC
3104 * @buf: buffer to transmit
3105 * @len: buffer length
3106 * @no_cck: don't use cck rates for this frame
3107 * @dont_wait_for_ack: tells the low level not to wait for an ack
3108 * @n_csa_offsets: length of csa_offsets array
3109 * @csa_offsets: array of all the csa offsets in the frame
3111 struct cfg80211_mgmt_tx_params {
3112 struct ieee80211_channel *chan;
3118 bool dont_wait_for_ack;
3120 const u16 *csa_offsets;
3124 * struct cfg80211_dscp_exception - DSCP exception
3126 * @dscp: DSCP value that does not adhere to the user priority range definition
3127 * @up: user priority value to which the corresponding DSCP value belongs
3129 struct cfg80211_dscp_exception {
3135 * struct cfg80211_dscp_range - DSCP range definition for user priority
3137 * @low: lowest DSCP value of this user priority range, inclusive
3138 * @high: highest DSCP value of this user priority range, inclusive
3140 struct cfg80211_dscp_range {
3145 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3146 #define IEEE80211_QOS_MAP_MAX_EX 21
3147 #define IEEE80211_QOS_MAP_LEN_MIN 16
3148 #define IEEE80211_QOS_MAP_LEN_MAX \
3149 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3152 * struct cfg80211_qos_map - QoS Map Information
3154 * This struct defines the Interworking QoS map setting for DSCP values
3156 * @num_des: number of DSCP exceptions (0..21)
3157 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3158 * the user priority DSCP range definition
3159 * @up: DSCP range definition for a particular user priority
3161 struct cfg80211_qos_map {
3163 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3164 struct cfg80211_dscp_range up[8];
3168 * struct cfg80211_nan_conf - NAN configuration
3170 * This struct defines NAN configuration parameters
3172 * @master_pref: master preference (1 - 255)
3173 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3174 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3175 * (i.e. BIT(NL80211_BAND_2GHZ)).
3177 struct cfg80211_nan_conf {
3183 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3186 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3187 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3189 enum cfg80211_nan_conf_changes {
3190 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3191 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3195 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3197 * @filter: the content of the filter
3198 * @len: the length of the filter
3200 struct cfg80211_nan_func_filter {
3206 * struct cfg80211_nan_func - a NAN function
3208 * @type: &enum nl80211_nan_function_type
3209 * @service_id: the service ID of the function
3210 * @publish_type: &nl80211_nan_publish_type
3211 * @close_range: if true, the range should be limited. Threshold is
3212 * implementation specific.
3213 * @publish_bcast: if true, the solicited publish should be broadcasted
3214 * @subscribe_active: if true, the subscribe is active
3215 * @followup_id: the instance ID for follow up
3216 * @followup_reqid: the requestor instance ID for follow up
3217 * @followup_dest: MAC address of the recipient of the follow up
3218 * @ttl: time to live counter in DW.
3219 * @serv_spec_info: Service Specific Info
3220 * @serv_spec_info_len: Service Specific Info length
3221 * @srf_include: if true, SRF is inclusive
3222 * @srf_bf: Bloom Filter
3223 * @srf_bf_len: Bloom Filter length
3224 * @srf_bf_idx: Bloom Filter index
3225 * @srf_macs: SRF MAC addresses
3226 * @srf_num_macs: number of MAC addresses in SRF
3227 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3228 * @tx_filters: filters that should be transmitted in the SDF.
3229 * @num_rx_filters: length of &rx_filters.
3230 * @num_tx_filters: length of &tx_filters.
3231 * @instance_id: driver allocated id of the function.
3232 * @cookie: unique NAN function identifier.
3234 struct cfg80211_nan_func {
3235 enum nl80211_nan_function_type type;
3236 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3240 bool subscribe_active;
3243 struct mac_address followup_dest;
3245 const u8 *serv_spec_info;
3246 u8 serv_spec_info_len;
3251 struct mac_address *srf_macs;
3253 struct cfg80211_nan_func_filter *rx_filters;
3254 struct cfg80211_nan_func_filter *tx_filters;
3262 * struct cfg80211_pmk_conf - PMK configuration
3264 * @aa: authenticator address
3265 * @pmk_len: PMK length in bytes.
3266 * @pmk: the PMK material
3267 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3268 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3271 struct cfg80211_pmk_conf {
3275 const u8 *pmk_r0_name;
3279 * struct cfg80211_external_auth_params - Trigger External authentication.
3281 * Commonly used across the external auth request and event interfaces.
3283 * @action: action type / trigger for external authentication. Only significant
3284 * for the authentication request event interface (driver to user space).
3285 * @bssid: BSSID of the peer with which the authentication has
3286 * to happen. Used by both the authentication request event and
3287 * authentication response command interface.
3288 * @ssid: SSID of the AP. Used by both the authentication request event and
3289 * authentication response command interface.
3290 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3291 * authentication request event interface.
3292 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3293 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3294 * the real status code for failures. Used only for the authentication
3295 * response command interface (user space to driver).
3296 * @pmkid: The identifier to refer a PMKSA.
3298 struct cfg80211_external_auth_params {
3299 enum nl80211_external_auth_action action;
3300 u8 bssid[ETH_ALEN] __aligned(2);
3301 struct cfg80211_ssid ssid;
3302 unsigned int key_mgmt_suite;
3308 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3310 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3311 * indicate the relevant values in this struct for them
3312 * @success_num: number of FTM sessions in which all frames were successfully
3314 * @partial_num: number of FTM sessions in which part of frames were
3315 * successfully answered
3316 * @failed_num: number of failed FTM sessions
3317 * @asap_num: number of ASAP FTM sessions
3318 * @non_asap_num: number of non-ASAP FTM sessions
3319 * @total_duration_ms: total sessions durations - gives an indication
3320 * of how much time the responder was busy
3321 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3322 * initiators that didn't finish successfully the negotiation phase with
3324 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3325 * for a new scheduling although it already has scheduled FTM slot
3326 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3328 struct cfg80211_ftm_responder_stats {
3335 u64 total_duration_ms;
3336 u32 unknown_triggers_num;
3337 u32 reschedule_requests_num;
3338 u32 out_of_window_triggers_num;
3342 * struct cfg80211_pmsr_ftm_result - FTM result
3343 * @failure_reason: if this measurement failed (PMSR status is
3344 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3345 * reason than just "failure"
3346 * @burst_index: if reporting partial results, this is the index
3347 * in [0 .. num_bursts-1] of the burst that's being reported
3348 * @num_ftmr_attempts: number of FTM request frames transmitted
3349 * @num_ftmr_successes: number of FTM request frames acked
3350 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3351 * fill this to indicate in how many seconds a retry is deemed possible
3353 * @num_bursts_exp: actual number of bursts exponent negotiated
3354 * @burst_duration: actual burst duration negotiated
3355 * @ftms_per_burst: actual FTMs per burst negotiated
3356 * @lci_len: length of LCI information (if present)
3357 * @civicloc_len: length of civic location information (if present)
3358 * @lci: LCI data (may be %NULL)
3359 * @civicloc: civic location data (may be %NULL)
3360 * @rssi_avg: average RSSI over FTM action frames reported
3361 * @rssi_spread: spread of the RSSI over FTM action frames reported
3362 * @tx_rate: bitrate for transmitted FTM action frame response
3363 * @rx_rate: bitrate of received FTM action frame
3364 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3365 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3366 * the square root of the variance)
3367 * @rtt_spread: spread of the RTTs measured
3368 * @dist_avg: average of distances (mm) measured
3369 * (must have either this or @rtt_avg)
3370 * @dist_variance: variance of distances measured (see also @rtt_variance)
3371 * @dist_spread: spread of distances measured (see also @rtt_spread)
3372 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3373 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3374 * @rssi_avg_valid: @rssi_avg is valid
3375 * @rssi_spread_valid: @rssi_spread is valid
3376 * @tx_rate_valid: @tx_rate is valid
3377 * @rx_rate_valid: @rx_rate is valid
3378 * @rtt_avg_valid: @rtt_avg is valid
3379 * @rtt_variance_valid: @rtt_variance is valid
3380 * @rtt_spread_valid: @rtt_spread is valid
3381 * @dist_avg_valid: @dist_avg is valid
3382 * @dist_variance_valid: @dist_variance is valid
3383 * @dist_spread_valid: @dist_spread is valid
3385 struct cfg80211_pmsr_ftm_result {
3388 unsigned int lci_len;
3389 unsigned int civicloc_len;
3390 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3391 u32 num_ftmr_attempts, num_ftmr_successes;
3399 struct rate_info tx_rate, rx_rate;
3407 u16 num_ftmr_attempts_valid:1,
3408 num_ftmr_successes_valid:1,
3410 rssi_spread_valid:1,
3414 rtt_variance_valid:1,
3417 dist_variance_valid:1,
3418 dist_spread_valid:1;
3422 * struct cfg80211_pmsr_result - peer measurement result
3423 * @addr: address of the peer
3424 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3425 * measurement was made)
3426 * @ap_tsf: AP's TSF at measurement time
3427 * @status: status of the measurement
3428 * @final: if reporting partial results, mark this as the last one; if not
3429 * reporting partial results always set this flag
3430 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3431 * @type: type of the measurement reported, note that we only support reporting
3432 * one type at a time, but you can report multiple results separately and
3433 * they're all aggregated for userspace.
3435 struct cfg80211_pmsr_result {
3436 u64 host_time, ap_tsf;
3437 enum nl80211_peer_measurement_status status;
3444 enum nl80211_peer_measurement_type type;
3447 struct cfg80211_pmsr_ftm_result ftm;
3452 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3453 * @requested: indicates FTM is requested
3454 * @preamble: frame preamble to use
3455 * @burst_period: burst period to use
3456 * @asap: indicates to use ASAP mode
3457 * @num_bursts_exp: number of bursts exponent
3458 * @burst_duration: burst duration
3459 * @ftms_per_burst: number of FTMs per burst
3460 * @ftmr_retries: number of retries for FTM request
3461 * @request_lci: request LCI information
3462 * @request_civicloc: request civic location information
3463 * @trigger_based: use trigger based ranging for the measurement
3464 * If neither @trigger_based nor @non_trigger_based is set,
3465 * EDCA based ranging will be used.
3466 * @non_trigger_based: use non trigger based ranging for the measurement
3467 * If neither @trigger_based nor @non_trigger_based is set,
3468 * EDCA based ranging will be used.
3470 * See also nl80211 for the respective attribute documentation.
3472 struct cfg80211_pmsr_ftm_request_peer {
3473 enum nl80211_preamble preamble;
3480 non_trigger_based:1;
3488 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3489 * @addr: MAC address
3490 * @chandef: channel to use
3491 * @report_ap_tsf: report the associated AP's TSF
3492 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3494 struct cfg80211_pmsr_request_peer {
3496 struct cfg80211_chan_def chandef;
3498 struct cfg80211_pmsr_ftm_request_peer ftm;
3502 * struct cfg80211_pmsr_request - peer measurement request
3503 * @cookie: cookie, set by cfg80211
3504 * @nl_portid: netlink portid - used by cfg80211
3505 * @drv_data: driver data for this request, if required for aborting,
3506 * not otherwise freed or anything by cfg80211
3507 * @mac_addr: MAC address used for (randomised) request
3508 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3509 * are 0 in the mask should be randomised, bits that are 1 should
3510 * be taken from the @mac_addr
3511 * @list: used by cfg80211 to hold on to the request
3512 * @timeout: timeout (in milliseconds) for the whole operation, if
3513 * zero it means there's no timeout
3514 * @n_peers: number of peers to do measurements with
3515 * @peers: per-peer measurement request data
3517 struct cfg80211_pmsr_request {
3525 u8 mac_addr[ETH_ALEN] __aligned(2);
3526 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3528 struct list_head list;
3530 struct cfg80211_pmsr_request_peer peers[];
3534 * struct cfg80211_update_owe_info - OWE Information
3536 * This structure provides information needed for the drivers to offload OWE
3537 * (Opportunistic Wireless Encryption) processing to the user space.
3539 * Commonly used across update_owe_info request and event interfaces.
3541 * @peer: MAC address of the peer device for which the OWE processing
3543 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3544 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3545 * cannot give you the real status code for failures. Used only for
3546 * OWE update request command interface (user space to driver).
3547 * @ie: IEs obtained from the peer or constructed by the user space. These are
3548 * the IEs of the remote peer in the event from the host driver and
3549 * the constructed IEs by the user space in the request interface.
3550 * @ie_len: Length of IEs in octets.
3552 struct cfg80211_update_owe_info {
3553 u8 peer[ETH_ALEN] __aligned(2);
3560 * struct mgmt_frame_regs - management frame registrations data
3561 * @global_stypes: bitmap of management frame subtypes registered
3562 * for the entire device
3563 * @interface_stypes: bitmap of management frame subtypes registered
3564 * for the given interface
3565 * @global_mcast_rx: mcast RX is needed globally for these subtypes
3566 * @interface_mcast_stypes: mcast RX is needed on this interface
3567 * for these subtypes
3569 struct mgmt_frame_regs {
3570 u32 global_stypes, interface_stypes;
3571 u32 global_mcast_stypes, interface_mcast_stypes;
3575 * struct cfg80211_ops - backend description for wireless configuration
3577 * This struct is registered by fullmac card drivers and/or wireless stacks
3578 * in order to handle configuration requests on their interfaces.
3580 * All callbacks except where otherwise noted should return 0
3581 * on success or a negative error code.
3583 * All operations are currently invoked under rtnl for consistency with the
3584 * wireless extensions but this is subject to reevaluation as soon as this
3585 * code is used more widely and we have a first user without wext.
3587 * @suspend: wiphy device needs to be suspended. The variable @wow will
3588 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3589 * configured for the device.
3590 * @resume: wiphy device needs to be resumed
3591 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3592 * to call device_set_wakeup_enable() to enable/disable wakeup from
3595 * @add_virtual_intf: create a new virtual interface with the given name,
3596 * must set the struct wireless_dev's iftype. Beware: You must create
3597 * the new netdev in the wiphy's network namespace! Returns the struct
3598 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3599 * also set the address member in the wdev.
3601 * @del_virtual_intf: remove the virtual interface
3603 * @change_virtual_intf: change type/configuration of virtual interface,
3604 * keep the struct wireless_dev's iftype updated.
3606 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3607 * when adding a group key.
3609 * @get_key: get information about the key with the given parameters.
3610 * @mac_addr will be %NULL when requesting information for a group
3611 * key. All pointers given to the @callback function need not be valid
3612 * after it returns. This function should return an error if it is
3613 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3615 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3616 * and @key_index, return -ENOENT if the key doesn't exist.
3618 * @set_default_key: set the default key on an interface
3620 * @set_default_mgmt_key: set the default management frame key on an interface
3622 * @set_default_beacon_key: set the default Beacon frame key on an interface
3624 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3626 * @start_ap: Start acting in AP mode defined by the parameters.
3627 * @change_beacon: Change the beacon parameters for an access point mode
3628 * interface. This should reject the call when AP mode wasn't started.
3629 * @stop_ap: Stop being an AP, including stopping beaconing.
3631 * @add_station: Add a new station.
3632 * @del_station: Remove a station
3633 * @change_station: Modify a given station. Note that flags changes are not much
3634 * validated in cfg80211, in particular the auth/assoc/authorized flags
3635 * might come to the driver in invalid combinations -- make sure to check
3636 * them, also against the existing state! Drivers must call
3637 * cfg80211_check_station_change() to validate the information.
3638 * @get_station: get station information for the station identified by @mac
3639 * @dump_station: dump station callback -- resume dump at index @idx
3641 * @add_mpath: add a fixed mesh path
3642 * @del_mpath: delete a given mesh path
3643 * @change_mpath: change a given mesh path
3644 * @get_mpath: get a mesh path for the given parameters
3645 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3646 * @get_mpp: get a mesh proxy path for the given parameters
3647 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3648 * @join_mesh: join the mesh network with the specified parameters
3649 * (invoked with the wireless_dev mutex held)
3650 * @leave_mesh: leave the current mesh network
3651 * (invoked with the wireless_dev mutex held)
3653 * @get_mesh_config: Get the current mesh configuration
3655 * @update_mesh_config: Update mesh parameters on a running mesh.
3656 * The mask is a bitfield which tells us which parameters to
3657 * set, and which to leave alone.
3659 * @change_bss: Modify parameters for a given BSS.
3661 * @set_txq_params: Set TX queue parameters
3663 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3664 * as it doesn't implement join_mesh and needs to set the channel to
3665 * join the mesh instead.
3667 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3668 * interfaces are active this callback should reject the configuration.
3669 * If no interfaces are active or the device is down, the channel should
3670 * be stored for when a monitor interface becomes active.
3672 * @scan: Request to do a scan. If returning zero, the scan request is given
3673 * the driver, and will be valid until passed to cfg80211_scan_done().
3674 * For scan results, call cfg80211_inform_bss(); you can call this outside
3675 * the scan/scan_done bracket too.
3676 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3677 * indicate the status of the scan through cfg80211_scan_done().
3679 * @auth: Request to authenticate with the specified peer
3680 * (invoked with the wireless_dev mutex held)
3681 * @assoc: Request to (re)associate with the specified peer
3682 * (invoked with the wireless_dev mutex held)
3683 * @deauth: Request to deauthenticate from the specified peer
3684 * (invoked with the wireless_dev mutex held)
3685 * @disassoc: Request to disassociate from the specified peer
3686 * (invoked with the wireless_dev mutex held)
3688 * @connect: Connect to the ESS with the specified parameters. When connected,
3689 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3690 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3691 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3692 * from the AP or cfg80211_connect_timeout() if no frame with status code
3694 * The driver is allowed to roam to other BSSes within the ESS when the
3695 * other BSS matches the connect parameters. When such roaming is initiated
3696 * by the driver, the driver is expected to verify that the target matches
3697 * the configured security parameters and to use Reassociation Request
3698 * frame instead of Association Request frame.
3699 * The connect function can also be used to request the driver to perform a
3700 * specific roam when connected to an ESS. In that case, the prev_bssid
3701 * parameter is set to the BSSID of the currently associated BSS as an
3702 * indication of requesting reassociation.
3703 * In both the driver-initiated and new connect() call initiated roaming
3704 * cases, the result of roaming is indicated with a call to
3705 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3706 * @update_connect_params: Update the connect parameters while connected to a
3707 * BSS. The updated parameters can be used by driver/firmware for
3708 * subsequent BSS selection (roaming) decisions and to form the
3709 * Authentication/(Re)Association Request frames. This call does not
3710 * request an immediate disassociation or reassociation with the current
3711 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3712 * changed are defined in &enum cfg80211_connect_params_changed.
3713 * (invoked with the wireless_dev mutex held)
3714 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3715 * connection is in progress. Once done, call cfg80211_disconnected() in
3716 * case connection was already established (invoked with the
3717 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3719 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3720 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3722 * (invoked with the wireless_dev mutex held)
3723 * @leave_ibss: Leave the IBSS.
3724 * (invoked with the wireless_dev mutex held)
3726 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3729 * @set_wiphy_params: Notify that wiphy parameters have changed;
3730 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3731 * have changed. The actual parameter values are available in
3732 * struct wiphy. If returning an error, no value should be changed.
3734 * @set_tx_power: set the transmit power according to the parameters,
3735 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3736 * wdev may be %NULL if power was set for the wiphy, and will
3737 * always be %NULL unless the driver supports per-vif TX power
3738 * (as advertised by the nl80211 feature flag.)
3739 * @get_tx_power: store the current TX power into the dbm variable;
3740 * return 0 if successful
3742 * @set_wds_peer: set the WDS peer for a WDS interface
3744 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3745 * functions to adjust rfkill hw state
3747 * @dump_survey: get site survey information.
3749 * @remain_on_channel: Request the driver to remain awake on the specified
3750 * channel for the specified duration to complete an off-channel
3751 * operation (e.g., public action frame exchange). When the driver is
3752 * ready on the requested channel, it must indicate this with an event
3753 * notification by calling cfg80211_ready_on_channel().
3754 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3755 * This allows the operation to be terminated prior to timeout based on
3756 * the duration value.
3757 * @mgmt_tx: Transmit a management frame.
3758 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3759 * frame on another channel
3761 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3762 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3763 * used by the function, but 0 and 1 must not be touched. Additionally,
3764 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3765 * dump and return to userspace with an error, so be careful. If any data
3766 * was passed in from userspace then the data/len arguments will be present
3767 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3769 * @set_bitrate_mask: set the bitrate mask configuration
3771 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3772 * devices running firmwares capable of generating the (re) association
3773 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3774 * @del_pmksa: Delete a cached PMKID.
3775 * @flush_pmksa: Flush all cached PMKIDs.
3776 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3777 * allows the driver to adjust the dynamic ps timeout value.
3778 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3779 * After configuration, the driver should (soon) send an event indicating
3780 * the current level is above/below the configured threshold; this may
3781 * need some care when the configuration is changed (without first being
3783 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3784 * connection quality monitor. An event is to be sent only when the
3785 * signal level is found to be outside the two values. The driver should
3786 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3787 * If it is provided then there's no point providing @set_cqm_rssi_config.
3788 * @set_cqm_txe_config: Configure connection quality monitor TX error
3790 * @sched_scan_start: Tell the driver to start a scheduled scan.
3791 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3792 * given request id. This call must stop the scheduled scan and be ready
3793 * for starting a new one before it returns, i.e. @sched_scan_start may be
3794 * called immediately after that again and should not fail in that case.
3795 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3796 * stop (when this method returns 0).
3798 * @update_mgmt_frame_registrations: Notify the driver that management frame
3799 * registrations were updated. The callback is allowed to sleep.
3801 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3802 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3803 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3804 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3806 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3808 * @tdls_mgmt: Transmit a TDLS management frame.
3809 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3811 * @probe_client: probe an associated client, must return a cookie that it
3812 * later passes to cfg80211_probe_status().
3814 * @set_noack_map: Set the NoAck Map for the TIDs.
3816 * @get_channel: Get the current operating channel for the virtual interface.
3817 * For monitor interfaces, it should return %NULL unless there's a single
3818 * current monitoring channel.
3820 * @start_p2p_device: Start the given P2P device.
3821 * @stop_p2p_device: Stop the given P2P device.
3823 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3824 * Parameters include ACL policy, an array of MAC address of stations
3825 * and the number of MAC addresses. If there is already a list in driver
3826 * this new list replaces the existing one. Driver has to clear its ACL
3827 * when number of MAC addresses entries is passed as 0. Drivers which
3828 * advertise the support for MAC based ACL have to implement this callback.
3830 * @start_radar_detection: Start radar detection in the driver.
3832 * @end_cac: End running CAC, probably because a related CAC
3833 * was finished on another phy.
3835 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3836 * driver. If the SME is in the driver/firmware, this information can be
3837 * used in building Authentication and Reassociation Request frames.
3839 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3840 * for a given duration (milliseconds). The protocol is provided so the
3841 * driver can take the most appropriate actions.
3842 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3843 * reliability. This operation can not fail.
3844 * @set_coalesce: Set coalesce parameters.
3846 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3847 * responsible for veryfing if the switch is possible. Since this is
3848 * inherently tricky driver may decide to disconnect an interface later
3849 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3850 * everything. It should do it's best to verify requests and reject them
3851 * as soon as possible.
3853 * @set_qos_map: Set QoS mapping information to the driver
3855 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3856 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3857 * changes during the lifetime of the BSS.
3859 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3860 * with the given parameters; action frame exchange has been handled by
3861 * userspace so this just has to modify the TX path to take the TS into
3863 * If the admitted time is 0 just validate the parameters to make sure
3864 * the session can be created at all; it is valid to just always return
3865 * success for that but that may result in inefficient behaviour (handshake
3866 * with the peer followed by immediate teardown when the addition is later
3868 * @del_tx_ts: remove an existing TX TS
3870 * @join_ocb: join the OCB network with the specified parameters
3871 * (invoked with the wireless_dev mutex held)
3872 * @leave_ocb: leave the current OCB network
3873 * (invoked with the wireless_dev mutex held)
3875 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3876 * is responsible for continually initiating channel-switching operations
3877 * and returning to the base channel for communication with the AP.
3878 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3879 * peers must be on the base channel when the call completes.
3880 * @start_nan: Start the NAN interface.
3881 * @stop_nan: Stop the NAN interface.
3882 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3883 * On success @nan_func ownership is transferred to the driver and
3884 * it may access it outside of the scope of this function. The driver
3885 * should free the @nan_func when no longer needed by calling
3886 * cfg80211_free_nan_func().
3887 * On success the driver should assign an instance_id in the
3888 * provided @nan_func.
3889 * @del_nan_func: Delete a NAN function.
3890 * @nan_change_conf: changes NAN configuration. The changed parameters must
3891 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3892 * All other parameters must be ignored.
3894 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3896 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3897 * function should return phy stats, and interface stats otherwise.
3899 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3900 * If not deleted through @del_pmk the PMK remains valid until disconnect
3901 * upon which the driver should clear it.
3902 * (invoked with the wireless_dev mutex held)
3903 * @del_pmk: delete the previously configured PMK for the given authenticator.
3904 * (invoked with the wireless_dev mutex held)
3906 * @external_auth: indicates result of offloaded authentication processing from
3909 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3910 * tells the driver that the frame should not be encrypted.
3912 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3913 * Statistics should be cumulative, currently no way to reset is provided.
3914 * @start_pmsr: start peer measurement (e.g. FTM)
3915 * @abort_pmsr: abort peer measurement
3917 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3918 * but offloading OWE processing to the user space will get the updated
3919 * DH IE through this interface.
3921 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3922 * and overrule HWMP path selection algorithm.
3923 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
3924 * This callback may sleep.
3925 * @reset_tid_config: Reset TID specific configuration for the peer, for the
3926 * given TIDs. This callback may sleep.
3928 struct cfg80211_ops {
3929 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3930 int (*resume)(struct wiphy *wiphy);
3931 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3933 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3935 unsigned char name_assign_type,
3936 enum nl80211_iftype type,
3937 struct vif_params *params);
3938 int (*del_virtual_intf)(struct wiphy *wiphy,
3939 struct wireless_dev *wdev);
3940 int (*change_virtual_intf)(struct wiphy *wiphy,
3941 struct net_device *dev,
3942 enum nl80211_iftype type,
3943 struct vif_params *params);
3945 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3946 u8 key_index, bool pairwise, const u8 *mac_addr,
3947 struct key_params *params);
3948 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3949 u8 key_index, bool pairwise, const u8 *mac_addr,
3951 void (*callback)(void *cookie, struct key_params*));
3952 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3953 u8 key_index, bool pairwise, const u8 *mac_addr);
3954 int (*set_default_key)(struct wiphy *wiphy,
3955 struct net_device *netdev,
3956 u8 key_index, bool unicast, bool multicast);
3957 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3958 struct net_device *netdev,
3960 int (*set_default_beacon_key)(struct wiphy *wiphy,
3961 struct net_device *netdev,
3964 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3965 struct cfg80211_ap_settings *settings);
3966 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3967 struct cfg80211_beacon_data *info);
3968 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3971 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3973 struct station_parameters *params);
3974 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3975 struct station_del_parameters *params);
3976 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3978 struct station_parameters *params);
3979 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3980 const u8 *mac, struct station_info *sinfo);
3981 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3982 int idx, u8 *mac, struct station_info *sinfo);
3984 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3985 const u8 *dst, const u8 *next_hop);
3986 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3988 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3989 const u8 *dst, const u8 *next_hop);
3990 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3991 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3992 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3993 int idx, u8 *dst, u8 *next_hop,
3994 struct mpath_info *pinfo);
3995 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3996 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3997 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3998 int idx, u8 *dst, u8 *mpp,
3999 struct mpath_info *pinfo);
4000 int (*get_mesh_config)(struct wiphy *wiphy,
4001 struct net_device *dev,
4002 struct mesh_config *conf);
4003 int (*update_mesh_config)(struct wiphy *wiphy,
4004 struct net_device *dev, u32 mask,
4005 const struct mesh_config *nconf);
4006 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4007 const struct mesh_config *conf,
4008 const struct mesh_setup *setup);
4009 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4011 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4012 struct ocb_setup *setup);
4013 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4015 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4016 struct bss_parameters *params);
4018 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4019 struct ieee80211_txq_params *params);
4021 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4022 struct net_device *dev,
4023 struct ieee80211_channel *chan);
4025 int (*set_monitor_channel)(struct wiphy *wiphy,
4026 struct cfg80211_chan_def *chandef);
4028 int (*scan)(struct wiphy *wiphy,
4029 struct cfg80211_scan_request *request);
4030 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4032 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4033 struct cfg80211_auth_request *req);
4034 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4035 struct cfg80211_assoc_request *req);
4036 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4037 struct cfg80211_deauth_request *req);
4038 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4039 struct cfg80211_disassoc_request *req);
4041 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4042 struct cfg80211_connect_params *sme);
4043 int (*update_connect_params)(struct wiphy *wiphy,
4044 struct net_device *dev,
4045 struct cfg80211_connect_params *sme,
4047 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4050 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4051 struct cfg80211_ibss_params *params);
4052 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4054 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4055 int rate[NUM_NL80211_BANDS]);
4057 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4059 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4060 enum nl80211_tx_power_setting type, int mbm);
4061 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4064 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
4067 void (*rfkill_poll)(struct wiphy *wiphy);
4069 #ifdef CONFIG_NL80211_TESTMODE
4070 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4071 void *data, int len);
4072 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4073 struct netlink_callback *cb,
4074 void *data, int len);
4077 int (*set_bitrate_mask)(struct wiphy *wiphy,
4078 struct net_device *dev,
4080 const struct cfg80211_bitrate_mask *mask);
4082 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4083 int idx, struct survey_info *info);
4085 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4086 struct cfg80211_pmksa *pmksa);
4087 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4088 struct cfg80211_pmksa *pmksa);
4089 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4091 int (*remain_on_channel)(struct wiphy *wiphy,
4092 struct wireless_dev *wdev,
4093 struct ieee80211_channel *chan,
4094 unsigned int duration,
4096 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4097 struct wireless_dev *wdev,
4100 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4101 struct cfg80211_mgmt_tx_params *params,
4103 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4104 struct wireless_dev *wdev,
4107 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4108 bool enabled, int timeout);
4110 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4111 struct net_device *dev,
4112 s32 rssi_thold, u32 rssi_hyst);
4114 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4115 struct net_device *dev,
4116 s32 rssi_low, s32 rssi_high);
4118 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4119 struct net_device *dev,
4120 u32 rate, u32 pkts, u32 intvl);
4122 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4123 struct wireless_dev *wdev,
4124 struct mgmt_frame_regs *upd);
4126 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4127 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4129 int (*sched_scan_start)(struct wiphy *wiphy,
4130 struct net_device *dev,
4131 struct cfg80211_sched_scan_request *request);
4132 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4135 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4136 struct cfg80211_gtk_rekey_data *data);
4138 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4139 const u8 *peer, u8 action_code, u8 dialog_token,
4140 u16 status_code, u32 peer_capability,
4141 bool initiator, const u8 *buf, size_t len);
4142 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4143 const u8 *peer, enum nl80211_tdls_operation oper);
4145 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4146 const u8 *peer, u64 *cookie);
4148 int (*set_noack_map)(struct wiphy *wiphy,
4149 struct net_device *dev,
4152 int (*get_channel)(struct wiphy *wiphy,
4153 struct wireless_dev *wdev,
4154 struct cfg80211_chan_def *chandef);
4156 int (*start_p2p_device)(struct wiphy *wiphy,
4157 struct wireless_dev *wdev);
4158 void (*stop_p2p_device)(struct wiphy *wiphy,
4159 struct wireless_dev *wdev);
4161 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4162 const struct cfg80211_acl_data *params);
4164 int (*start_radar_detection)(struct wiphy *wiphy,
4165 struct net_device *dev,
4166 struct cfg80211_chan_def *chandef,
4168 void (*end_cac)(struct wiphy *wiphy,
4169 struct net_device *dev);
4170 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4171 struct cfg80211_update_ft_ies_params *ftie);
4172 int (*crit_proto_start)(struct wiphy *wiphy,
4173 struct wireless_dev *wdev,
4174 enum nl80211_crit_proto_id protocol,
4176 void (*crit_proto_stop)(struct wiphy *wiphy,
4177 struct wireless_dev *wdev);
4178 int (*set_coalesce)(struct wiphy *wiphy,
4179 struct cfg80211_coalesce *coalesce);
4181 int (*channel_switch)(struct wiphy *wiphy,
4182 struct net_device *dev,
4183 struct cfg80211_csa_settings *params);
4185 int (*set_qos_map)(struct wiphy *wiphy,
4186 struct net_device *dev,
4187 struct cfg80211_qos_map *qos_map);
4189 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4190 struct cfg80211_chan_def *chandef);
4192 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4193 u8 tsid, const u8 *peer, u8 user_prio,
4195 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4196 u8 tsid, const u8 *peer);
4198 int (*tdls_channel_switch)(struct wiphy *wiphy,
4199 struct net_device *dev,
4200 const u8 *addr, u8 oper_class,
4201 struct cfg80211_chan_def *chandef);
4202 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4203 struct net_device *dev,
4205 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4206 struct cfg80211_nan_conf *conf);
4207 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4208 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4209 struct cfg80211_nan_func *nan_func);
4210 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4212 int (*nan_change_conf)(struct wiphy *wiphy,
4213 struct wireless_dev *wdev,
4214 struct cfg80211_nan_conf *conf,
4217 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4218 struct net_device *dev,
4219 const bool enabled);
4221 int (*get_txq_stats)(struct wiphy *wiphy,
4222 struct wireless_dev *wdev,
4223 struct cfg80211_txq_stats *txqstats);
4225 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4226 const struct cfg80211_pmk_conf *conf);
4227 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4229 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4230 struct cfg80211_external_auth_params *params);
4232 int (*tx_control_port)(struct wiphy *wiphy,
4233 struct net_device *dev,
4234 const u8 *buf, size_t len,
4235 const u8 *dest, const __be16 proto,
4236 const bool noencrypt,
4239 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4240 struct net_device *dev,
4241 struct cfg80211_ftm_responder_stats *ftm_stats);
4243 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4244 struct cfg80211_pmsr_request *request);
4245 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4246 struct cfg80211_pmsr_request *request);
4247 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4248 struct cfg80211_update_owe_info *owe_info);
4249 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4250 const u8 *buf, size_t len);
4251 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4252 struct cfg80211_tid_config *tid_conf);
4253 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4254 const u8 *peer, u8 tids);
4258 * wireless hardware and networking interfaces structures
4259 * and registration/helper functions
4263 * enum wiphy_flags - wiphy capability flags
4265 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4266 * into two, first for legacy bands and second for UHB.
4267 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4269 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4270 * by default -- this flag will be set depending on the kernel's default
4271 * on wiphy_new(), but can be changed by the driver if it has a good
4272 * reason to override the default
4273 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4274 * on a VLAN interface). This flag also serves an extra purpose of
4275 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4276 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4277 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4278 * control port protocol ethertype. The device also honours the
4279 * control_port_no_encrypt flag.
4280 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4281 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4282 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4283 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4285 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4286 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4287 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4288 * link setup/discovery operations internally. Setup, discovery and
4289 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4290 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4291 * used for asking the driver/firmware to perform a TDLS operation.
4292 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4293 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4294 * when there are virtual interfaces in AP mode by calling
4295 * cfg80211_report_obss_beacon().
4296 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4297 * responds to probe-requests in hardware.
4298 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4299 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4300 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4301 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4302 * beaconing mode (AP, IBSS, Mesh, ...).
4303 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4304 * before connection.
4305 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4308 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4310 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4311 WIPHY_FLAG_NETNS_OK = BIT(3),
4312 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4313 WIPHY_FLAG_4ADDR_AP = BIT(5),
4314 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4315 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4316 WIPHY_FLAG_IBSS_RSN = BIT(8),
4317 WIPHY_FLAG_MESH_AUTH = BIT(10),
4318 /* use hole at 11 */
4319 /* use hole at 12 */
4320 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4321 WIPHY_FLAG_AP_UAPSD = BIT(14),
4322 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4323 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4324 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4325 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4326 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4327 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4328 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4329 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4330 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4331 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4335 * struct ieee80211_iface_limit - limit on certain interface types
4336 * @max: maximum number of interfaces of these types
4337 * @types: interface types (bits)
4339 struct ieee80211_iface_limit {
4345 * struct ieee80211_iface_combination - possible interface combination
4347 * With this structure the driver can describe which interface
4348 * combinations it supports concurrently.
4352 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4356 * struct ieee80211_iface_limit limits1[] = {
4357 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4358 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4360 * struct ieee80211_iface_combination combination1 = {
4361 * .limits = limits1,
4362 * .n_limits = ARRAY_SIZE(limits1),
4363 * .max_interfaces = 2,
4364 * .beacon_int_infra_match = true,
4368 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4372 * struct ieee80211_iface_limit limits2[] = {
4373 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4374 * BIT(NL80211_IFTYPE_P2P_GO), },
4376 * struct ieee80211_iface_combination combination2 = {
4377 * .limits = limits2,
4378 * .n_limits = ARRAY_SIZE(limits2),
4379 * .max_interfaces = 8,
4380 * .num_different_channels = 1,
4384 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4386 * This allows for an infrastructure connection and three P2P connections.
4390 * struct ieee80211_iface_limit limits3[] = {
4391 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4392 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4393 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4395 * struct ieee80211_iface_combination combination3 = {
4396 * .limits = limits3,
4397 * .n_limits = ARRAY_SIZE(limits3),
4398 * .max_interfaces = 4,
4399 * .num_different_channels = 2,
4403 struct ieee80211_iface_combination {
4406 * limits for the given interface types
4408 const struct ieee80211_iface_limit *limits;
4411 * @num_different_channels:
4412 * can use up to this many different channels
4414 u32 num_different_channels;
4418 * maximum number of interfaces in total allowed in this group
4424 * number of limitations
4429 * @beacon_int_infra_match:
4430 * In this combination, the beacon intervals between infrastructure
4431 * and AP types must match. This is required only in special cases.
4433 bool beacon_int_infra_match;
4436 * @radar_detect_widths:
4437 * bitmap of channel widths supported for radar detection
4439 u8 radar_detect_widths;
4442 * @radar_detect_regions:
4443 * bitmap of regions supported for radar detection
4445 u8 radar_detect_regions;
4448 * @beacon_int_min_gcd:
4449 * This interface combination supports different beacon intervals.
4452 * all beacon intervals for different interface must be same.
4454 * any beacon interval for the interface part of this combination AND
4455 * GCD of all beacon intervals from beaconing interfaces of this
4456 * combination must be greater or equal to this value.
4458 u32 beacon_int_min_gcd;
4461 struct ieee80211_txrx_stypes {
4466 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4467 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4468 * trigger that keeps the device operating as-is and
4469 * wakes up the host on any activity, for example a
4470 * received packet that passed filtering; note that the
4471 * packet should be preserved in that case
4472 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4474 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4475 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4476 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4477 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4478 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4479 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4480 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4482 enum wiphy_wowlan_support_flags {
4483 WIPHY_WOWLAN_ANY = BIT(0),
4484 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4485 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4486 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4487 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4488 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4489 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4490 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4491 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4494 struct wiphy_wowlan_tcp_support {
4495 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4496 u32 data_payload_max;
4497 u32 data_interval_max;
4498 u32 wake_payload_max;
4503 * struct wiphy_wowlan_support - WoWLAN support data
4504 * @flags: see &enum wiphy_wowlan_support_flags
4505 * @n_patterns: number of supported wakeup patterns
4506 * (see nl80211.h for the pattern definition)
4507 * @pattern_max_len: maximum length of each pattern
4508 * @pattern_min_len: minimum length of each pattern
4509 * @max_pkt_offset: maximum Rx packet offset
4510 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4511 * similar, but not necessarily identical, to max_match_sets for
4513 * See &struct cfg80211_sched_scan_request.@match_sets for more
4515 * @tcp: TCP wakeup support information
4517 struct wiphy_wowlan_support {
4520 int pattern_max_len;
4521 int pattern_min_len;
4523 int max_nd_match_sets;
4524 const struct wiphy_wowlan_tcp_support *tcp;
4528 * struct wiphy_coalesce_support - coalesce support data
4529 * @n_rules: maximum number of coalesce rules
4530 * @max_delay: maximum supported coalescing delay in msecs
4531 * @n_patterns: number of supported patterns in a rule
4532 * (see nl80211.h for the pattern definition)
4533 * @pattern_max_len: maximum length of each pattern
4534 * @pattern_min_len: minimum length of each pattern
4535 * @max_pkt_offset: maximum Rx packet offset
4537 struct wiphy_coalesce_support {
4541 int pattern_max_len;
4542 int pattern_min_len;
4547 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4548 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4549 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4550 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4551 * (must be combined with %_WDEV or %_NETDEV)
4553 enum wiphy_vendor_command_flags {
4554 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4555 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4556 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4560 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4562 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4563 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4564 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4567 enum wiphy_opmode_flag {
4568 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4569 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4570 STA_OPMODE_N_SS_CHANGED = BIT(2),
4574 * struct sta_opmode_info - Station's ht/vht operation mode information
4575 * @changed: contains value from &enum wiphy_opmode_flag
4576 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4577 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4578 * @rx_nss: new rx_nss value of a station
4581 struct sta_opmode_info {
4583 enum nl80211_smps_mode smps_mode;
4584 enum nl80211_chan_width bw;
4588 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4591 * struct wiphy_vendor_command - vendor command definition
4592 * @info: vendor command identifying information, as used in nl80211
4593 * @flags: flags, see &enum wiphy_vendor_command_flags
4594 * @doit: callback for the operation, note that wdev is %NULL if the
4595 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4596 * pointer may be %NULL if userspace provided no data at all
4597 * @dumpit: dump callback, for transferring bigger/multiple items. The
4598 * @storage points to cb->args[5], ie. is preserved over the multiple
4600 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4601 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4602 * attribute is just raw data (e.g. a firmware command).
4603 * @maxattr: highest attribute number in policy
4604 * It's recommended to not have the same sub command with both @doit and
4605 * @dumpit, so that userspace can assume certain ones are get and others
4606 * are used with dump requests.
4608 struct wiphy_vendor_command {
4609 struct nl80211_vendor_cmd_info info;
4611 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4612 const void *data, int data_len);
4613 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4614 struct sk_buff *skb, const void *data, int data_len,
4615 unsigned long *storage);
4616 const struct nla_policy *policy;
4617 unsigned int maxattr;
4621 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4622 * @iftype: interface type
4623 * @extended_capabilities: extended capabilities supported by the driver,
4624 * additional capabilities might be supported by userspace; these are the
4625 * 802.11 extended capabilities ("Extended Capabilities element") and are
4626 * in the same format as in the information element. See IEEE Std
4627 * 802.11-2012 8.4.2.29 for the defined fields.
4628 * @extended_capabilities_mask: mask of the valid values
4629 * @extended_capabilities_len: length of the extended capabilities
4631 struct wiphy_iftype_ext_capab {
4632 enum nl80211_iftype iftype;
4633 const u8 *extended_capabilities;
4634 const u8 *extended_capabilities_mask;
4635 u8 extended_capabilities_len;
4639 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4640 * @max_peers: maximum number of peers in a single measurement
4641 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4642 * @randomize_mac_addr: can randomize MAC address for measurement
4643 * @ftm.supported: FTM measurement is supported
4644 * @ftm.asap: ASAP-mode is supported
4645 * @ftm.non_asap: non-ASAP-mode is supported
4646 * @ftm.request_lci: can request LCI data
4647 * @ftm.request_civicloc: can request civic location data
4648 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4649 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4650 * @ftm.max_bursts_exponent: maximum burst exponent supported
4651 * (set to -1 if not limited; note that setting this will necessarily
4652 * forbid using the value 15 to let the responder pick)
4653 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4655 * @ftm.trigger_based: trigger based ranging measurement is supported
4656 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
4658 struct cfg80211_pmsr_capabilities {
4659 unsigned int max_peers;
4661 randomize_mac_addr:1;
4666 s8 max_bursts_exponent;
4667 u8 max_ftms_per_burst;
4674 non_trigger_based:1;
4679 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4680 * suites for interface types defined in @iftypes_mask. Each type in the
4681 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4683 * @iftypes_mask: bitmask of interfaces types
4684 * @akm_suites: points to an array of supported akm suites
4685 * @n_akm_suites: number of supported AKM suites
4687 struct wiphy_iftype_akm_suites {
4689 const u32 *akm_suites;
4694 * struct wiphy - wireless hardware description
4695 * @reg_notifier: the driver's regulatory notification callback,
4696 * note that if your driver uses wiphy_apply_custom_regulatory()
4697 * the reg_notifier's request can be passed as NULL
4698 * @regd: the driver's regulatory domain, if one was requested via
4699 * the regulatory_hint() API. This can be used by the driver
4700 * on the reg_notifier() if it chooses to ignore future
4701 * regulatory domain changes caused by other drivers.
4702 * @signal_type: signal type reported in &struct cfg80211_bss.
4703 * @cipher_suites: supported cipher suites
4704 * @n_cipher_suites: number of supported cipher suites
4705 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4706 * the supported AKMs not advertized for a specific interface type in
4707 * iftype_akm_suites.
4708 * @n_akm_suites: number of supported AKM suites
4709 * @iftype_akm_suites: array of supported akm suites info per interface type.
4710 * Note that the bits in @iftypes_mask inside this structure cannot
4711 * overlap (i.e. only one occurrence of each type is allowed across all
4712 * instances of iftype_akm_suites).
4713 * @num_iftype_akm_suites: number of interface types for which supported akm
4714 * suites are specified separately.
4715 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4716 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4717 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4718 * -1 = fragmentation disabled, only odd values >= 256 used
4719 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4720 * @_net: the network namespace this wiphy currently lives in
4721 * @perm_addr: permanent MAC address of this device
4722 * @addr_mask: If the device supports multiple MAC addresses by masking,
4723 * set this to a mask with variable bits set to 1, e.g. if the last
4724 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4725 * variable bits shall be determined by the interfaces added, with
4726 * interfaces not matching the mask being rejected to be brought up.
4727 * @n_addresses: number of addresses in @addresses.
4728 * @addresses: If the device has more than one address, set this pointer
4729 * to a list of addresses (6 bytes each). The first one will be used
4730 * by default for perm_addr. In this case, the mask should be set to
4731 * all-zeroes. In this case it is assumed that the device can handle
4732 * the same number of arbitrary MAC addresses.
4733 * @registered: protects ->resume and ->suspend sysfs callbacks against
4734 * unregister hardware
4735 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4736 * It will be renamed automatically on wiphy renames
4737 * @dev: (virtual) struct device for this wiphy. The item in
4738 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4740 * @wext: wireless extension handlers
4741 * @priv: driver private data (sized according to wiphy_new() parameter)
4742 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4743 * must be set by driver
4744 * @iface_combinations: Valid interface combinations array, should not
4745 * list single interface types.
4746 * @n_iface_combinations: number of entries in @iface_combinations array.
4747 * @software_iftypes: bitmask of software interface types, these are not
4748 * subject to any restrictions since they are purely managed in SW.
4749 * @flags: wiphy flags, see &enum wiphy_flags
4750 * @regulatory_flags: wiphy regulatory flags, see
4751 * &enum ieee80211_regulatory_flags
4752 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4753 * @ext_features: extended features advertised to nl80211, see
4754 * &enum nl80211_ext_feature_index.
4755 * @bss_priv_size: each BSS struct has private data allocated with it,
4756 * this variable determines its size
4757 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4759 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4760 * the device can run concurrently.
4761 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4762 * for in any given scheduled scan
4763 * @max_match_sets: maximum number of match sets the device can handle
4764 * when performing a scheduled scan, 0 if filtering is not
4766 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4767 * add to probe request frames transmitted during a scan, must not
4768 * include fixed IEs like supported rates
4769 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4771 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4772 * of iterations) for scheduled scan supported by the device.
4773 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4774 * single scan plan supported by the device.
4775 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4776 * scan plan supported by the device.
4777 * @coverage_class: current coverage class
4778 * @fw_version: firmware version for ethtool reporting
4779 * @hw_version: hardware version for ethtool reporting
4780 * @max_num_pmkids: maximum number of PMKIDs supported by device
4781 * @privid: a pointer that drivers can use to identify if an arbitrary
4782 * wiphy is theirs, e.g. in global notifiers
4783 * @bands: information about bands/channels supported by this device
4785 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4786 * transmitted through nl80211, points to an array indexed by interface
4789 * @available_antennas_tx: bitmap of antennas which are available to be
4790 * configured as TX antennas. Antenna configuration commands will be
4791 * rejected unless this or @available_antennas_rx is set.
4793 * @available_antennas_rx: bitmap of antennas which are available to be
4794 * configured as RX antennas. Antenna configuration commands will be
4795 * rejected unless this or @available_antennas_tx is set.
4797 * @probe_resp_offload:
4798 * Bitmap of supported protocols for probe response offloading.
4799 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4800 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4802 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4803 * may request, if implemented.
4805 * @wowlan: WoWLAN support information
4806 * @wowlan_config: current WoWLAN configuration; this should usually not be
4807 * used since access to it is necessarily racy, use the parameter passed
4808 * to the suspend() operation instead.
4810 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4811 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4812 * If null, then none can be over-ridden.
4813 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4814 * If null, then none can be over-ridden.
4816 * @wdev_list: the list of associated (virtual) interfaces; this list must
4817 * not be modified by the driver, but can be read with RTNL/RCU protection.
4819 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4822 * @extended_capabilities: extended capabilities supported by the driver,
4823 * additional capabilities might be supported by userspace; these are
4824 * the 802.11 extended capabilities ("Extended Capabilities element")
4825 * and are in the same format as in the information element. See
4826 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4827 * extended capabilities to be used if the capabilities are not specified
4828 * for a specific interface type in iftype_ext_capab.
4829 * @extended_capabilities_mask: mask of the valid values
4830 * @extended_capabilities_len: length of the extended capabilities
4831 * @iftype_ext_capab: array of extended capabilities per interface type
4832 * @num_iftype_ext_capab: number of interface types for which extended
4833 * capabilities are specified separately.
4834 * @coalesce: packet coalescing support information
4836 * @vendor_commands: array of vendor commands supported by the hardware
4837 * @n_vendor_commands: number of vendor commands
4838 * @vendor_events: array of vendor events supported by the hardware
4839 * @n_vendor_events: number of vendor events
4841 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4842 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4843 * driver is allowed to advertise a theoretical limit that it can reach in
4844 * some cases, but may not always reach.
4846 * @max_num_csa_counters: Number of supported csa_counters in beacons
4847 * and probe responses. This value should be set if the driver
4848 * wishes to limit the number of csa counters. Default (0) means
4850 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4851 * by the driver in the .connect() callback. The bit position maps to the
4852 * attribute indices defined in &enum nl80211_bss_select_attr.
4854 * @nan_supported_bands: bands supported by the device in NAN mode, a
4855 * bitmap of &enum nl80211_band values. For instance, for
4856 * NL80211_BAND_2GHZ, bit 0 would be set
4857 * (i.e. BIT(NL80211_BAND_2GHZ)).
4859 * @txq_limit: configuration of internal TX queue frame limit
4860 * @txq_memory_limit: configuration internal TX queue memory limit
4861 * @txq_quantum: configuration of internal TX queue scheduler quantum
4863 * @tx_queue_len: allow setting transmit queue len for drivers not using
4866 * @support_mbssid: can HW support association with nontransmitted AP
4867 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4868 * HE AP, in order to avoid compatibility issues.
4869 * @support_mbssid must be set for this to have any effect.
4871 * @pmsr_capa: peer measurement capabilities
4873 * @tid_config_support: describes the per-TID config support that the
4875 * @tid_config_support.vif: bitmap of attributes (configurations)
4876 * supported by the driver for each vif
4877 * @tid_config_support.peer: bitmap of attributes (configurations)
4878 * supported by the driver for each peer
4879 * @tid_config_support.max_retry: maximum supported retry count for
4880 * long/short retry configuration
4882 * @max_data_retry_count: maximum supported per TID retry count for
4883 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
4884 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
4887 /* assign these fields before you register the wiphy */
4889 u8 perm_addr[ETH_ALEN];
4890 u8 addr_mask[ETH_ALEN];
4892 struct mac_address *addresses;
4894 const struct ieee80211_txrx_stypes *mgmt_stypes;
4896 const struct ieee80211_iface_combination *iface_combinations;
4897 int n_iface_combinations;
4898 u16 software_iftypes;
4902 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4903 u16 interface_modes;
4905 u16 max_acl_mac_addrs;
4907 u32 flags, regulatory_flags, features;
4908 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4912 enum cfg80211_signal_type signal_type;
4916 u8 max_sched_scan_reqs;
4917 u8 max_sched_scan_ssids;
4919 u16 max_scan_ie_len;
4920 u16 max_sched_scan_ie_len;
4921 u32 max_sched_scan_plans;
4922 u32 max_sched_scan_plan_interval;
4923 u32 max_sched_scan_plan_iterations;
4925 int n_cipher_suites;
4926 const u32 *cipher_suites;
4929 const u32 *akm_suites;
4931 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
4932 unsigned int num_iftype_akm_suites;
4940 char fw_version[ETHTOOL_FWVERS_LEN];
4944 const struct wiphy_wowlan_support *wowlan;
4945 struct cfg80211_wowlan *wowlan_config;
4948 u16 max_remain_on_channel_duration;
4952 u32 available_antennas_tx;
4953 u32 available_antennas_rx;
4955 u32 probe_resp_offload;
4957 const u8 *extended_capabilities, *extended_capabilities_mask;
4958 u8 extended_capabilities_len;
4960 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4961 unsigned int num_iftype_ext_capab;
4965 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4967 void (*reg_notifier)(struct wiphy *wiphy,
4968 struct regulatory_request *request);
4970 /* fields below are read-only, assigned by cfg80211 */
4972 const struct ieee80211_regdomain __rcu *regd;
4978 struct dentry *debugfsdir;
4980 const struct ieee80211_ht_cap *ht_capa_mod_mask;
4981 const struct ieee80211_vht_cap *vht_capa_mod_mask;
4983 struct list_head wdev_list;
4985 possible_net_t _net;
4987 #ifdef CONFIG_CFG80211_WEXT
4988 const struct iw_handler_def *wext;
4991 const struct wiphy_coalesce_support *coalesce;
4993 const struct wiphy_vendor_command *vendor_commands;
4994 const struct nl80211_vendor_cmd_info *vendor_events;
4995 int n_vendor_commands, n_vendor_events;
4997 u16 max_ap_assoc_sta;
4999 u8 max_num_csa_counters;
5001 u32 bss_select_support;
5003 u8 nan_supported_bands;
5006 u32 txq_memory_limit;
5009 unsigned long tx_queue_len;
5011 u8 support_mbssid:1,
5012 support_only_he_mbssid:1;
5014 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5019 } tid_config_support;
5021 u8 max_data_retry_count;
5023 char priv[] __aligned(NETDEV_ALIGN);
5026 static inline struct net *wiphy_net(struct wiphy *wiphy)
5028 return read_pnet(&wiphy->_net);
5031 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5033 write_pnet(&wiphy->_net, net);
5037 * wiphy_priv - return priv from wiphy
5039 * @wiphy: the wiphy whose priv pointer to return
5040 * Return: The priv of @wiphy.
5042 static inline void *wiphy_priv(struct wiphy *wiphy)
5045 return &wiphy->priv;
5049 * priv_to_wiphy - return the wiphy containing the priv
5051 * @priv: a pointer previously returned by wiphy_priv
5052 * Return: The wiphy of @priv.
5054 static inline struct wiphy *priv_to_wiphy(void *priv)
5057 return container_of(priv, struct wiphy, priv);
5061 * set_wiphy_dev - set device pointer for wiphy
5063 * @wiphy: The wiphy whose device to bind
5064 * @dev: The device to parent it to
5066 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5068 wiphy->dev.parent = dev;
5072 * wiphy_dev - get wiphy dev pointer
5074 * @wiphy: The wiphy whose device struct to look up
5075 * Return: The dev of @wiphy.
5077 static inline struct device *wiphy_dev(struct wiphy *wiphy)
5079 return wiphy->dev.parent;
5083 * wiphy_name - get wiphy name
5085 * @wiphy: The wiphy whose name to return
5086 * Return: The name of @wiphy.
5088 static inline const char *wiphy_name(const struct wiphy *wiphy)
5090 return dev_name(&wiphy->dev);
5094 * wiphy_new_nm - create a new wiphy for use with cfg80211
5096 * @ops: The configuration operations for this device
5097 * @sizeof_priv: The size of the private area to allocate
5098 * @requested_name: Request a particular name.
5099 * NULL is valid value, and means use the default phy%d naming.
5101 * Create a new wiphy and associate the given operations with it.
5102 * @sizeof_priv bytes are allocated for private use.
5104 * Return: A pointer to the new wiphy. This pointer must be
5105 * assigned to each netdev's ieee80211_ptr for proper operation.
5107 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5108 const char *requested_name);
5111 * wiphy_new - create a new wiphy for use with cfg80211
5113 * @ops: The configuration operations for this device
5114 * @sizeof_priv: The size of the private area to allocate
5116 * Create a new wiphy and associate the given operations with it.
5117 * @sizeof_priv bytes are allocated for private use.
5119 * Return: A pointer to the new wiphy. This pointer must be
5120 * assigned to each netdev's ieee80211_ptr for proper operation.
5122 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5125 return wiphy_new_nm(ops, sizeof_priv, NULL);
5129 * wiphy_register - register a wiphy with cfg80211
5131 * @wiphy: The wiphy to register.
5133 * Return: A non-negative wiphy index or a negative error code.
5135 int wiphy_register(struct wiphy *wiphy);
5138 * wiphy_unregister - deregister a wiphy from cfg80211
5140 * @wiphy: The wiphy to unregister.
5142 * After this call, no more requests can be made with this priv
5143 * pointer, but the call may sleep to wait for an outstanding
5144 * request that is being handled.
5146 void wiphy_unregister(struct wiphy *wiphy);
5149 * wiphy_free - free wiphy
5151 * @wiphy: The wiphy to free
5153 void wiphy_free(struct wiphy *wiphy);
5155 /* internal structs */
5156 struct cfg80211_conn;
5157 struct cfg80211_internal_bss;
5158 struct cfg80211_cached_keys;
5159 struct cfg80211_cqm_config;
5162 * struct wireless_dev - wireless device state
5164 * For netdevs, this structure must be allocated by the driver
5165 * that uses the ieee80211_ptr field in struct net_device (this
5166 * is intentional so it can be allocated along with the netdev.)
5167 * It need not be registered then as netdev registration will
5168 * be intercepted by cfg80211 to see the new wireless device.
5170 * For non-netdev uses, it must also be allocated by the driver
5171 * in response to the cfg80211 callbacks that require it, as
5172 * there's no netdev registration in that case it may not be
5173 * allocated outside of callback operations that return it.
5175 * @wiphy: pointer to hardware description
5176 * @iftype: interface type
5177 * @list: (private) Used to collect the interfaces
5178 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5179 * @identifier: (private) Identifier used in nl80211 to identify this
5180 * wireless device if it has no netdev
5181 * @current_bss: (private) Used by the internal configuration code
5182 * @chandef: (private) Used by the internal configuration code to track
5183 * the user-set channel definition.
5184 * @preset_chandef: (private) Used by the internal configuration code to
5185 * track the channel to be used for AP later
5186 * @bssid: (private) Used by the internal configuration code
5187 * @ssid: (private) Used by the internal configuration code
5188 * @ssid_len: (private) Used by the internal configuration code
5189 * @mesh_id_len: (private) Used by the internal configuration code
5190 * @mesh_id_up_len: (private) Used by the internal configuration code
5191 * @wext: (private) Used by the internal wireless extensions compat code
5192 * @wext.ibss: (private) IBSS data part of wext handling
5193 * @wext.connect: (private) connection handling data
5194 * @wext.keys: (private) (WEP) key data
5195 * @wext.ie: (private) extra elements for association
5196 * @wext.ie_len: (private) length of extra elements
5197 * @wext.bssid: (private) selected network BSSID
5198 * @wext.ssid: (private) selected network SSID
5199 * @wext.default_key: (private) selected default key index
5200 * @wext.default_mgmt_key: (private) selected default management key index
5201 * @wext.prev_bssid: (private) previous BSSID for reassociation
5202 * @wext.prev_bssid_valid: (private) previous BSSID validity
5203 * @use_4addr: indicates 4addr mode is used on this interface, must be
5204 * set by driver (if supported) on add_interface BEFORE registering the
5205 * netdev and may otherwise be used by driver read-only, will be update
5206 * by cfg80211 on change_interface
5207 * @mgmt_registrations: list of registrations for management frames
5208 * @mgmt_registrations_need_update: mgmt registrations were updated,
5209 * need to propagate the update to the driver
5210 * @mtx: mutex used to lock data in this struct, may be used by drivers
5211 * and some API functions require it held
5212 * @beacon_interval: beacon interval used on this device for transmitting
5213 * beacons, 0 when not valid
5214 * @address: The address for this device, valid only if @netdev is %NULL
5215 * @is_running: true if this is a non-netdev device that has been started, e.g.
5217 * @cac_started: true if DFS channel availability check has been started
5218 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5219 * @cac_time_ms: CAC time in ms
5220 * @ps: powersave mode is enabled
5221 * @ps_timeout: dynamic powersave timeout
5222 * @ap_unexpected_nlportid: (private) netlink port ID of application
5223 * registered for unexpected class 3 frames (AP mode)
5224 * @conn: (private) cfg80211 software SME connection state machine data
5225 * @connect_keys: (private) keys to set after connection is established
5226 * @conn_bss_type: connecting/connected BSS type
5227 * @conn_owner_nlportid: (private) connection owner socket port ID
5228 * @disconnect_wk: (private) auto-disconnect work
5229 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5230 * @ibss_fixed: (private) IBSS is using fixed BSSID
5231 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
5232 * @event_list: (private) list for internal event processing
5233 * @event_lock: (private) lock for event list
5234 * @owner_nlportid: (private) owner socket port ID
5235 * @nl_owner_dead: (private) owner socket went away
5236 * @cqm_config: (private) nl80211 RSSI monitor state
5237 * @pmsr_list: (private) peer measurement requests
5238 * @pmsr_lock: (private) peer measurements requests/results lock
5239 * @pmsr_free_wk: (private) peer measurements cleanup work
5240 * @unprot_beacon_reported: (private) timestamp of last
5241 * unprotected beacon report
5243 struct wireless_dev {
5244 struct wiphy *wiphy;
5245 enum nl80211_iftype iftype;
5247 /* the remainder of this struct should be private to cfg80211 */
5248 struct list_head list;
5249 struct net_device *netdev;
5253 struct list_head mgmt_registrations;
5254 u8 mgmt_registrations_need_update:1;
5258 bool use_4addr, is_running;
5260 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5262 /* currently used for IBSS and SME - might be rearranged later */
5263 u8 ssid[IEEE80211_MAX_SSID_LEN];
5264 u8 ssid_len, mesh_id_len, mesh_id_up_len;
5265 struct cfg80211_conn *conn;
5266 struct cfg80211_cached_keys *connect_keys;
5267 enum ieee80211_bss_type conn_bss_type;
5268 u32 conn_owner_nlportid;
5270 struct work_struct disconnect_wk;
5271 u8 disconnect_bssid[ETH_ALEN];
5273 struct list_head event_list;
5274 spinlock_t event_lock;
5276 struct cfg80211_internal_bss *current_bss; /* associated / joined */
5277 struct cfg80211_chan_def preset_chandef;
5278 struct cfg80211_chan_def chandef;
5281 bool ibss_dfs_possible;
5286 int beacon_interval;
5288 u32 ap_unexpected_nlportid;
5294 unsigned long cac_start_time;
5295 unsigned int cac_time_ms;
5297 #ifdef CONFIG_CFG80211_WEXT
5300 struct cfg80211_ibss_params ibss;
5301 struct cfg80211_connect_params connect;
5302 struct cfg80211_cached_keys *keys;
5306 u8 prev_bssid[ETH_ALEN];
5307 u8 ssid[IEEE80211_MAX_SSID_LEN];
5308 s8 default_key, default_mgmt_key;
5309 bool prev_bssid_valid;
5313 struct cfg80211_cqm_config *cqm_config;
5315 struct list_head pmsr_list;
5316 spinlock_t pmsr_lock;
5317 struct work_struct pmsr_free_wk;
5319 unsigned long unprot_beacon_reported;
5322 static inline u8 *wdev_address(struct wireless_dev *wdev)
5325 return wdev->netdev->dev_addr;
5326 return wdev->address;
5329 static inline bool wdev_running(struct wireless_dev *wdev)
5332 return netif_running(wdev->netdev);
5333 return wdev->is_running;
5337 * wdev_priv - return wiphy priv from wireless_dev
5339 * @wdev: The wireless device whose wiphy's priv pointer to return
5340 * Return: The wiphy priv of @wdev.
5342 static inline void *wdev_priv(struct wireless_dev *wdev)
5345 return wiphy_priv(wdev->wiphy);
5349 * DOC: Utility functions
5351 * cfg80211 offers a number of utility functions that can be useful.
5355 * ieee80211_channel_equal - compare two struct ieee80211_channel
5357 * @a: 1st struct ieee80211_channel
5358 * @b: 2nd struct ieee80211_channel
5359 * Return: true if center frequency of @a == @b
5362 ieee80211_channel_equal(struct ieee80211_channel *a,
5363 struct ieee80211_channel *b)
5365 return (a->center_freq == b->center_freq &&
5366 a->freq_offset == b->freq_offset);
5370 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5371 * @chan: struct ieee80211_channel to convert
5372 * Return: The corresponding frequency (in KHz)
5375 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5377 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5381 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5383 * Only allowed for band NL80211_BAND_S1GHZ
5385 * Return: The allowed channel width for this center_freq
5387 enum nl80211_chan_width
5388 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5391 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5392 * @chan: channel number
5393 * @band: band, necessary due to channel number overlap
5394 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5396 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5399 * ieee80211_channel_to_frequency - convert channel number to frequency
5400 * @chan: channel number
5401 * @band: band, necessary due to channel number overlap
5402 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5405 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5407 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5411 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5412 * @freq: center frequency in KHz
5413 * Return: The corresponding channel, or 0 if the conversion failed.
5415 int ieee80211_freq_khz_to_channel(u32 freq);
5418 * ieee80211_frequency_to_channel - convert frequency to channel number
5419 * @freq: center frequency in MHz
5420 * Return: The corresponding channel, or 0 if the conversion failed.
5423 ieee80211_frequency_to_channel(int freq)
5425 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5429 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5431 * @wiphy: the struct wiphy to get the channel for
5432 * @freq: the center frequency (in KHz) of the channel
5433 * Return: The channel struct from @wiphy at @freq.
5435 struct ieee80211_channel *
5436 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5439 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5441 * @wiphy: the struct wiphy to get the channel for
5442 * @freq: the center frequency (in MHz) of the channel
5443 * Return: The channel struct from @wiphy at @freq.
5445 static inline struct ieee80211_channel *
5446 ieee80211_get_channel(struct wiphy *wiphy, int freq)
5448 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5452 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5453 * @chan: control channel to check
5455 * The Preferred Scanning Channels (PSC) are defined in
5456 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5458 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
5460 if (chan->band != NL80211_BAND_6GHZ)
5463 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
5467 * ieee80211_get_response_rate - get basic rate for a given rate
5469 * @sband: the band to look for rates in
5470 * @basic_rates: bitmap of basic rates
5471 * @bitrate: the bitrate for which to find the basic rate
5473 * Return: The basic rate corresponding to a given bitrate, that
5474 * is the next lower bitrate contained in the basic rate map,
5475 * which is, for this function, given as a bitmap of indices of
5476 * rates in the band's bitrate table.
5478 struct ieee80211_rate *
5479 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5480 u32 basic_rates, int bitrate);
5483 * ieee80211_mandatory_rates - get mandatory rates for a given band
5484 * @sband: the band to look for rates in
5485 * @scan_width: width of the control channel
5487 * This function returns a bitmap of the mandatory rates for the given
5488 * band, bits are set according to the rate position in the bitrates array.
5490 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5491 enum nl80211_bss_scan_width scan_width);
5494 * Radiotap parsing functions -- for controlled injection support
5496 * Implemented in net/wireless/radiotap.c
5497 * Documentation in Documentation/networking/radiotap-headers.rst
5500 struct radiotap_align_size {
5501 uint8_t align:4, size:4;
5504 struct ieee80211_radiotap_namespace {
5505 const struct radiotap_align_size *align_size;
5511 struct ieee80211_radiotap_vendor_namespaces {
5512 const struct ieee80211_radiotap_namespace *ns;
5517 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5518 * @this_arg_index: index of current arg, valid after each successful call
5519 * to ieee80211_radiotap_iterator_next()
5520 * @this_arg: pointer to current radiotap arg; it is valid after each
5521 * call to ieee80211_radiotap_iterator_next() but also after
5522 * ieee80211_radiotap_iterator_init() where it will point to
5523 * the beginning of the actual data portion
5524 * @this_arg_size: length of the current arg, for convenience
5525 * @current_namespace: pointer to the current namespace definition
5526 * (or internally %NULL if the current namespace is unknown)
5527 * @is_radiotap_ns: indicates whether the current namespace is the default
5528 * radiotap namespace or not
5530 * @_rtheader: pointer to the radiotap header we are walking through
5531 * @_max_length: length of radiotap header in cpu byte ordering
5532 * @_arg_index: next argument index
5533 * @_arg: next argument pointer
5534 * @_next_bitmap: internal pointer to next present u32
5535 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5536 * @_vns: vendor namespace definitions
5537 * @_next_ns_data: beginning of the next namespace's data
5538 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5541 * Describes the radiotap parser state. Fields prefixed with an underscore
5542 * must not be used by users of the parser, only by the parser internally.
5545 struct ieee80211_radiotap_iterator {
5546 struct ieee80211_radiotap_header *_rtheader;
5547 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5548 const struct ieee80211_radiotap_namespace *current_namespace;
5550 unsigned char *_arg, *_next_ns_data;
5551 __le32 *_next_bitmap;
5553 unsigned char *this_arg;
5561 uint32_t _bitmap_shifter;
5566 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5567 struct ieee80211_radiotap_header *radiotap_header,
5569 const struct ieee80211_radiotap_vendor_namespaces *vns);
5572 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5575 extern const unsigned char rfc1042_header[6];
5576 extern const unsigned char bridge_tunnel_header[6];
5579 * ieee80211_get_hdrlen_from_skb - get header length from data
5583 * Given an skb with a raw 802.11 header at the data pointer this function
5584 * returns the 802.11 header length.
5586 * Return: The 802.11 header length in bytes (not including encryption
5587 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5590 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5593 * ieee80211_hdrlen - get header length in bytes from frame control
5594 * @fc: frame control field in little-endian format
5595 * Return: The header length in bytes.
5597 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5600 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5601 * @meshhdr: the mesh extension header, only the flags field
5602 * (first byte) will be accessed
5603 * Return: The length of the extension header, which is always at
5604 * least 6 bytes and at most 18 if address 5 and 6 are present.
5606 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5609 * DOC: Data path helpers
5611 * In addition to generic utilities, cfg80211 also offers
5612 * functions that help implement the data path for devices
5613 * that do not do the 802.11/802.3 conversion on the device.
5617 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5618 * @skb: the 802.11 data frame
5619 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5620 * of it being pushed into the SKB
5621 * @addr: the device MAC address
5622 * @iftype: the virtual interface type
5623 * @data_offset: offset of payload after the 802.11 header
5624 * Return: 0 on success. Non-zero on error.
5626 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5627 const u8 *addr, enum nl80211_iftype iftype,
5628 u8 data_offset, bool is_amsdu);
5631 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5632 * @skb: the 802.11 data frame
5633 * @addr: the device MAC address
5634 * @iftype: the virtual interface type
5635 * Return: 0 on success. Non-zero on error.
5637 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5638 enum nl80211_iftype iftype)
5640 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
5644 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5646 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5647 * The @list will be empty if the decode fails. The @skb must be fully
5648 * header-less before being passed in here; it is freed in this function.
5650 * @skb: The input A-MSDU frame without any headers.
5651 * @list: The output list of 802.3 frames. It must be allocated and
5652 * initialized by the caller.
5653 * @addr: The device MAC address.
5654 * @iftype: The device interface type.
5655 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5656 * @check_da: DA to check in the inner ethernet header, or NULL
5657 * @check_sa: SA to check in the inner ethernet header, or NULL
5659 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5660 const u8 *addr, enum nl80211_iftype iftype,
5661 const unsigned int extra_headroom,
5662 const u8 *check_da, const u8 *check_sa);
5665 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5666 * @skb: the data frame
5667 * @qos_map: Interworking QoS mapping or %NULL if not in use
5668 * Return: The 802.1p/1d tag.
5670 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5671 struct cfg80211_qos_map *qos_map);
5674 * cfg80211_find_elem_match - match information element and byte array in data
5677 * @ies: data consisting of IEs
5678 * @len: length of data
5679 * @match: byte array to match
5680 * @match_len: number of bytes in the match array
5681 * @match_offset: offset in the IE data where the byte array should match.
5682 * Note the difference to cfg80211_find_ie_match() which considers
5683 * the offset to start from the element ID byte, but here we take
5684 * the data portion instead.
5686 * Return: %NULL if the element ID could not be found or if
5687 * the element is invalid (claims to be longer than the given
5688 * data) or if the byte array doesn't match; otherwise return the
5689 * requested element struct.
5691 * Note: There are no checks on the element length other than
5692 * having to fit into the given data and being large enough for the
5693 * byte array to match.
5695 const struct element *
5696 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5697 const u8 *match, unsigned int match_len,
5698 unsigned int match_offset);
5701 * cfg80211_find_ie_match - match information element and byte array in data
5704 * @ies: data consisting of IEs
5705 * @len: length of data
5706 * @match: byte array to match
5707 * @match_len: number of bytes in the match array
5708 * @match_offset: offset in the IE where the byte array should match.
5709 * If match_len is zero, this must also be set to zero.
5710 * Otherwise this must be set to 2 or more, because the first
5711 * byte is the element id, which is already compared to eid, and
5712 * the second byte is the IE length.
5714 * Return: %NULL if the element ID could not be found or if
5715 * the element is invalid (claims to be longer than the given
5716 * data) or if the byte array doesn't match, or a pointer to the first
5717 * byte of the requested element, that is the byte containing the
5720 * Note: There are no checks on the element length other than
5721 * having to fit into the given data and being large enough for the
5722 * byte array to match.
5724 static inline const u8 *
5725 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5726 const u8 *match, unsigned int match_len,
5727 unsigned int match_offset)
5729 /* match_offset can't be smaller than 2, unless match_len is
5730 * zero, in which case match_offset must be zero as well.
5732 if (WARN_ON((match_len && match_offset < 2) ||
5733 (!match_len && match_offset)))
5736 return (void *)cfg80211_find_elem_match(eid, ies, len,
5739 match_offset - 2 : 0);
5743 * cfg80211_find_elem - find information element in data
5746 * @ies: data consisting of IEs
5747 * @len: length of data
5749 * Return: %NULL if the element ID could not be found or if
5750 * the element is invalid (claims to be longer than the given
5751 * data) or if the byte array doesn't match; otherwise return the
5752 * requested element struct.
5754 * Note: There are no checks on the element length other than
5755 * having to fit into the given data.
5757 static inline const struct element *
5758 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5760 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5764 * cfg80211_find_ie - find information element in data
5767 * @ies: data consisting of IEs
5768 * @len: length of data
5770 * Return: %NULL if the element ID could not be found or if
5771 * the element is invalid (claims to be longer than the given
5772 * data), or a pointer to the first byte of the requested
5773 * element, that is the byte containing the element ID.
5775 * Note: There are no checks on the element length other than
5776 * having to fit into the given data.
5778 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5780 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5784 * cfg80211_find_ext_elem - find information element with EID Extension in data
5786 * @ext_eid: element ID Extension
5787 * @ies: data consisting of IEs
5788 * @len: length of data
5790 * Return: %NULL if the etended element could not be found or if
5791 * the element is invalid (claims to be longer than the given
5792 * data) or if the byte array doesn't match; otherwise return the
5793 * requested element struct.
5795 * Note: There are no checks on the element length other than
5796 * having to fit into the given data.
5798 static inline const struct element *
5799 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5801 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5806 * cfg80211_find_ext_ie - find information element with EID Extension in data
5808 * @ext_eid: element ID Extension
5809 * @ies: data consisting of IEs
5810 * @len: length of data
5812 * Return: %NULL if the extended element ID could not be found or if
5813 * the element is invalid (claims to be longer than the given
5814 * data), or a pointer to the first byte of the requested
5815 * element, that is the byte containing the element ID.
5817 * Note: There are no checks on the element length other than
5818 * having to fit into the given data.
5820 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5822 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5827 * cfg80211_find_vendor_elem - find vendor specific information element in data
5830 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5831 * @ies: data consisting of IEs
5832 * @len: length of data
5834 * Return: %NULL if the vendor specific element ID could not be found or if the
5835 * element is invalid (claims to be longer than the given data); otherwise
5836 * return the element structure for the requested element.
5838 * Note: There are no checks on the element length other than having to fit into
5841 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5846 * cfg80211_find_vendor_ie - find vendor specific information element in data
5849 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5850 * @ies: data consisting of IEs
5851 * @len: length of data
5853 * Return: %NULL if the vendor specific element ID could not be found or if the
5854 * element is invalid (claims to be longer than the given data), or a pointer to
5855 * the first byte of the requested element, that is the byte containing the
5858 * Note: There are no checks on the element length other than having to fit into
5861 static inline const u8 *
5862 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5863 const u8 *ies, unsigned int len)
5865 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5869 * cfg80211_send_layer2_update - send layer 2 update frame
5871 * @dev: network device
5872 * @addr: STA MAC address
5874 * Wireless drivers can use this function to update forwarding tables in bridge
5875 * devices upon STA association.
5877 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5880 * DOC: Regulatory enforcement infrastructure
5886 * regulatory_hint - driver hint to the wireless core a regulatory domain
5887 * @wiphy: the wireless device giving the hint (used only for reporting
5889 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5890 * should be in. If @rd is set this should be NULL. Note that if you
5891 * set this to NULL you should still set rd->alpha2 to some accepted
5894 * Wireless drivers can use this function to hint to the wireless core
5895 * what it believes should be the current regulatory domain by
5896 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5897 * domain should be in or by providing a completely build regulatory domain.
5898 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5899 * for a regulatory domain structure for the respective country.
5901 * The wiphy must have been registered to cfg80211 prior to this call.
5902 * For cfg80211 drivers this means you must first use wiphy_register(),
5903 * for mac80211 drivers you must first use ieee80211_register_hw().
5905 * Drivers should check the return value, its possible you can get
5908 * Return: 0 on success. -ENOMEM.
5910 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5913 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5914 * @wiphy: the wireless device we want to process the regulatory domain on
5915 * @rd: the regulatory domain informatoin to use for this wiphy
5917 * Set the regulatory domain information for self-managed wiphys, only they
5918 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5921 * Return: 0 on success. -EINVAL, -EPERM
5923 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5924 struct ieee80211_regdomain *rd);
5927 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5928 * @wiphy: the wireless device we want to process the regulatory domain on
5929 * @rd: the regulatory domain information to use for this wiphy
5931 * This functions requires the RTNL to be held and applies the new regdomain
5932 * synchronously to this wiphy. For more details see
5933 * regulatory_set_wiphy_regd().
5935 * Return: 0 on success. -EINVAL, -EPERM
5937 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5938 struct ieee80211_regdomain *rd);
5941 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5942 * @wiphy: the wireless device we want to process the regulatory domain on
5943 * @regd: the custom regulatory domain to use for this wiphy
5945 * Drivers can sometimes have custom regulatory domains which do not apply
5946 * to a specific country. Drivers can use this to apply such custom regulatory
5947 * domains. This routine must be called prior to wiphy registration. The
5948 * custom regulatory domain will be trusted completely and as such previous
5949 * default channel settings will be disregarded. If no rule is found for a
5950 * channel on the regulatory domain the channel will be disabled.
5951 * Drivers using this for a wiphy should also set the wiphy flag
5952 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5953 * that called this helper.
5955 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5956 const struct ieee80211_regdomain *regd);
5959 * freq_reg_info - get regulatory information for the given frequency
5960 * @wiphy: the wiphy for which we want to process this rule for
5961 * @center_freq: Frequency in KHz for which we want regulatory information for
5963 * Use this function to get the regulatory rule for a specific frequency on
5964 * a given wireless device. If the device has a specific regulatory domain
5965 * it wants to follow we respect that unless a country IE has been received
5966 * and processed already.
5968 * Return: A valid pointer, or, when an error occurs, for example if no rule
5969 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5970 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5971 * value will be -ERANGE if we determine the given center_freq does not even
5972 * have a regulatory rule for a frequency range in the center_freq's band.
5973 * See freq_in_rule_band() for our current definition of a band -- this is
5974 * purely subjective and right now it's 802.11 specific.
5976 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5980 * reg_initiator_name - map regulatory request initiator enum to name
5981 * @initiator: the regulatory request initiator
5983 * You can use this to map the regulatory request initiator enum to a
5984 * proper string representation.
5986 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5989 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
5990 * @wiphy: wiphy for which pre-CAC capability is checked.
5992 * Pre-CAC is allowed only in some regdomains (notable ETSI).
5994 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
5997 * DOC: Internal regulatory db functions
6002 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6003 * Regulatory self-managed driver can use it to proactively
6005 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6006 * @freq: the freqency(in MHz) to be queried.
6007 * @rule: pointer to store the wmm rule from the regulatory db.
6009 * Self-managed wireless drivers can use this function to query
6010 * the internal regulatory database to check whether the given
6011 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6013 * Drivers should check the return value, its possible you can get
6016 * Return: 0 on success. -ENODATA.
6018 int reg_query_regdb_wmm(char *alpha2, int freq,
6019 struct ieee80211_reg_rule *rule);
6022 * callbacks for asynchronous cfg80211 methods, notification
6023 * functions and BSS handling helpers
6027 * cfg80211_scan_done - notify that scan finished
6029 * @request: the corresponding scan request
6030 * @info: information about the completed scan
6032 void cfg80211_scan_done(struct cfg80211_scan_request *request,
6033 struct cfg80211_scan_info *info);
6036 * cfg80211_sched_scan_results - notify that new scan results are available
6038 * @wiphy: the wiphy which got scheduled scan results
6039 * @reqid: identifier for the related scheduled scan request
6041 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6044 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6046 * @wiphy: the wiphy on which the scheduled scan stopped
6047 * @reqid: identifier for the related scheduled scan request
6049 * The driver can call this function to inform cfg80211 that the
6050 * scheduled scan had to be stopped, for whatever reason. The driver
6051 * is then called back via the sched_scan_stop operation when done.
6053 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6056 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
6058 * @wiphy: the wiphy on which the scheduled scan stopped
6059 * @reqid: identifier for the related scheduled scan request
6061 * The driver can call this function to inform cfg80211 that the
6062 * scheduled scan had to be stopped, for whatever reason. The driver
6063 * is then called back via the sched_scan_stop operation when done.
6064 * This function should be called with rtnl locked.
6066 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
6069 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6070 * @wiphy: the wiphy reporting the BSS
6071 * @data: the BSS metadata
6072 * @mgmt: the management frame (probe response or beacon)
6073 * @len: length of the management frame
6074 * @gfp: context flags
6076 * This informs cfg80211 that BSS information was found and
6077 * the BSS should be updated/added.
6079 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6080 * Or %NULL on error.
6082 struct cfg80211_bss * __must_check
6083 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
6084 struct cfg80211_inform_bss *data,
6085 struct ieee80211_mgmt *mgmt, size_t len,
6088 static inline struct cfg80211_bss * __must_check
6089 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6090 struct ieee80211_channel *rx_channel,
6091 enum nl80211_bss_scan_width scan_width,
6092 struct ieee80211_mgmt *mgmt, size_t len,
6093 s32 signal, gfp_t gfp)
6095 struct cfg80211_inform_bss data = {
6097 .scan_width = scan_width,
6101 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6104 static inline struct cfg80211_bss * __must_check
6105 cfg80211_inform_bss_frame(struct wiphy *wiphy,
6106 struct ieee80211_channel *rx_channel,
6107 struct ieee80211_mgmt *mgmt, size_t len,
6108 s32 signal, gfp_t gfp)
6110 struct cfg80211_inform_bss data = {
6112 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6116 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6120 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6121 * @bssid: transmitter BSSID
6122 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6123 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6124 * @new_bssid: calculated nontransmitted BSSID
6126 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6127 u8 mbssid_index, u8 *new_bssid)
6129 u64 bssid_u64 = ether_addr_to_u64(bssid);
6130 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6133 new_bssid_u64 = bssid_u64 & ~mask;
6135 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6137 u64_to_ether_addr(new_bssid_u64, new_bssid);
6141 * cfg80211_is_element_inherited - returns if element ID should be inherited
6142 * @element: element to check
6143 * @non_inherit_element: non inheritance element
6145 bool cfg80211_is_element_inherited(const struct element *element,
6146 const struct element *non_inherit_element);
6149 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6151 * @ielen: length of IEs
6152 * @mbssid_elem: current MBSSID element
6153 * @sub_elem: current MBSSID subelement (profile)
6154 * @merged_ie: location of the merged profile
6155 * @max_copy_len: max merged profile length
6157 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6158 const struct element *mbssid_elem,
6159 const struct element *sub_elem,
6160 u8 *merged_ie, size_t max_copy_len);
6163 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6164 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6165 * from a beacon or probe response
6166 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6167 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6169 enum cfg80211_bss_frame_type {
6170 CFG80211_BSS_FTYPE_UNKNOWN,
6171 CFG80211_BSS_FTYPE_BEACON,
6172 CFG80211_BSS_FTYPE_PRESP,
6176 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6178 * @wiphy: the wiphy reporting the BSS
6179 * @data: the BSS metadata
6180 * @ftype: frame type (if known)
6181 * @bssid: the BSSID of the BSS
6182 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6183 * @capability: the capability field sent by the peer
6184 * @beacon_interval: the beacon interval announced by the peer
6185 * @ie: additional IEs sent by the peer
6186 * @ielen: length of the additional IEs
6187 * @gfp: context flags
6189 * This informs cfg80211 that BSS information was found and
6190 * the BSS should be updated/added.
6192 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6193 * Or %NULL on error.
6195 struct cfg80211_bss * __must_check
6196 cfg80211_inform_bss_data(struct wiphy *wiphy,
6197 struct cfg80211_inform_bss *data,
6198 enum cfg80211_bss_frame_type ftype,
6199 const u8 *bssid, u64 tsf, u16 capability,
6200 u16 beacon_interval, const u8 *ie, size_t ielen,
6203 static inline struct cfg80211_bss * __must_check
6204 cfg80211_inform_bss_width(struct wiphy *wiphy,
6205 struct ieee80211_channel *rx_channel,
6206 enum nl80211_bss_scan_width scan_width,
6207 enum cfg80211_bss_frame_type ftype,
6208 const u8 *bssid, u64 tsf, u16 capability,
6209 u16 beacon_interval, const u8 *ie, size_t ielen,
6210 s32 signal, gfp_t gfp)
6212 struct cfg80211_inform_bss data = {
6214 .scan_width = scan_width,
6218 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6219 capability, beacon_interval, ie, ielen,
6223 static inline struct cfg80211_bss * __must_check
6224 cfg80211_inform_bss(struct wiphy *wiphy,
6225 struct ieee80211_channel *rx_channel,
6226 enum cfg80211_bss_frame_type ftype,
6227 const u8 *bssid, u64 tsf, u16 capability,
6228 u16 beacon_interval, const u8 *ie, size_t ielen,
6229 s32 signal, gfp_t gfp)
6231 struct cfg80211_inform_bss data = {
6233 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6237 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6238 capability, beacon_interval, ie, ielen,
6243 * cfg80211_get_bss - get a BSS reference
6244 * @wiphy: the wiphy this BSS struct belongs to
6245 * @channel: the channel to search on (or %NULL)
6246 * @bssid: the desired BSSID (or %NULL)
6247 * @ssid: the desired SSID (or %NULL)
6248 * @ssid_len: length of the SSID (or 0)
6249 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6250 * @privacy: privacy filter, see &enum ieee80211_privacy
6252 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6253 struct ieee80211_channel *channel,
6255 const u8 *ssid, size_t ssid_len,
6256 enum ieee80211_bss_type bss_type,
6257 enum ieee80211_privacy privacy);
6258 static inline struct cfg80211_bss *
6259 cfg80211_get_ibss(struct wiphy *wiphy,
6260 struct ieee80211_channel *channel,
6261 const u8 *ssid, size_t ssid_len)
6263 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6264 IEEE80211_BSS_TYPE_IBSS,
6265 IEEE80211_PRIVACY_ANY);
6269 * cfg80211_ref_bss - reference BSS struct
6270 * @wiphy: the wiphy this BSS struct belongs to
6271 * @bss: the BSS struct to reference
6273 * Increments the refcount of the given BSS struct.
6275 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6278 * cfg80211_put_bss - unref BSS struct
6279 * @wiphy: the wiphy this BSS struct belongs to
6280 * @bss: the BSS struct
6282 * Decrements the refcount of the given BSS struct.
6284 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6287 * cfg80211_unlink_bss - unlink BSS from internal data structures
6289 * @bss: the bss to remove
6291 * This function removes the given BSS from the internal data structures
6292 * thereby making it no longer show up in scan results etc. Use this
6293 * function when you detect a BSS is gone. Normally BSSes will also time
6294 * out, so it is not necessary to use this function at all.
6296 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6299 * cfg80211_bss_iter - iterate all BSS entries
6301 * This function iterates over the BSS entries associated with the given wiphy
6302 * and calls the callback for the iterated BSS. The iterator function is not
6303 * allowed to call functions that might modify the internal state of the BSS DB.
6306 * @chandef: if given, the iterator function will be called only if the channel
6307 * of the currently iterated BSS is a subset of the given channel.
6308 * @iter: the iterator function to call
6309 * @iter_data: an argument to the iterator function
6311 void cfg80211_bss_iter(struct wiphy *wiphy,
6312 struct cfg80211_chan_def *chandef,
6313 void (*iter)(struct wiphy *wiphy,
6314 struct cfg80211_bss *bss,
6318 static inline enum nl80211_bss_scan_width
6319 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6321 switch (chandef->width) {
6322 case NL80211_CHAN_WIDTH_5:
6323 return NL80211_BSS_CHAN_WIDTH_5;
6324 case NL80211_CHAN_WIDTH_10:
6325 return NL80211_BSS_CHAN_WIDTH_10;
6327 return NL80211_BSS_CHAN_WIDTH_20;
6332 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6333 * @dev: network device
6334 * @buf: authentication frame (header + body)
6335 * @len: length of the frame data
6337 * This function is called whenever an authentication, disassociation or
6338 * deauthentication frame has been received and processed in station mode.
6339 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6340 * call either this function or cfg80211_auth_timeout().
6341 * After being asked to associate via cfg80211_ops::assoc() the driver must
6342 * call either this function or cfg80211_auth_timeout().
6343 * While connected, the driver must calls this for received and processed
6344 * disassociation and deauthentication frames. If the frame couldn't be used
6345 * because it was unprotected, the driver must call the function
6346 * cfg80211_rx_unprot_mlme_mgmt() instead.
6348 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6350 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6353 * cfg80211_auth_timeout - notification of timed out authentication
6354 * @dev: network device
6355 * @addr: The MAC address of the device with which the authentication timed out
6357 * This function may sleep. The caller must hold the corresponding wdev's
6360 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6363 * cfg80211_rx_assoc_resp - notification of processed association response
6364 * @dev: network device
6365 * @bss: the BSS that association was requested with, ownership of the pointer
6366 * moves to cfg80211 in this call
6367 * @buf: (Re)Association Response frame (header + body)
6368 * @len: length of the frame data
6369 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6370 * as the AC bitmap in the QoS info field
6371 * @req_ies: information elements from the (Re)Association Request frame
6372 * @req_ies_len: length of req_ies data
6374 * After being asked to associate via cfg80211_ops::assoc() the driver must
6375 * call either this function or cfg80211_auth_timeout().
6377 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6379 void cfg80211_rx_assoc_resp(struct net_device *dev,
6380 struct cfg80211_bss *bss,
6381 const u8 *buf, size_t len,
6383 const u8 *req_ies, size_t req_ies_len);
6386 * cfg80211_assoc_timeout - notification of timed out association
6387 * @dev: network device
6388 * @bss: The BSS entry with which association timed out.
6390 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6392 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6395 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6396 * @dev: network device
6397 * @bss: The BSS entry with which association was abandoned.
6399 * Call this whenever - for reasons reported through other API, like deauth RX,
6400 * an association attempt was abandoned.
6401 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6403 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6406 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6407 * @dev: network device
6408 * @buf: 802.11 frame (header + body)
6409 * @len: length of the frame data
6411 * This function is called whenever deauthentication has been processed in
6412 * station mode. This includes both received deauthentication frames and
6413 * locally generated ones. This function may sleep. The caller must hold the
6414 * corresponding wdev's mutex.
6416 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6419 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6420 * @dev: network device
6421 * @buf: received management frame (header + body)
6422 * @len: length of the frame data
6424 * This function is called whenever a received deauthentication or dissassoc
6425 * frame has been dropped in station mode because of MFP being used but the
6426 * frame was not protected. This is also used to notify reception of a Beacon
6427 * frame that was dropped because it did not include a valid MME MIC while
6428 * beacon protection was enabled (BIGTK configured in station mode).
6430 * This function may sleep.
6432 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6433 const u8 *buf, size_t len);
6436 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6437 * @dev: network device
6438 * @addr: The source MAC address of the frame
6439 * @key_type: The key type that the received frame used
6440 * @key_id: Key identifier (0..3). Can be -1 if missing.
6441 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6442 * @gfp: allocation flags
6444 * This function is called whenever the local MAC detects a MIC failure in a
6445 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6448 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6449 enum nl80211_key_type key_type, int key_id,
6450 const u8 *tsc, gfp_t gfp);
6453 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6455 * @dev: network device
6456 * @bssid: the BSSID of the IBSS joined
6457 * @channel: the channel of the IBSS joined
6458 * @gfp: allocation flags
6460 * This function notifies cfg80211 that the device joined an IBSS or
6461 * switched to a different BSSID. Before this function can be called,
6462 * either a beacon has to have been received from the IBSS, or one of
6463 * the cfg80211_inform_bss{,_frame} functions must have been called
6464 * with the locally generated beacon -- this guarantees that there is
6465 * always a scan result for this IBSS. cfg80211 will handle the rest.
6467 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6468 struct ieee80211_channel *channel, gfp_t gfp);
6471 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
6474 * @dev: network device
6475 * @macaddr: the MAC address of the new candidate
6476 * @ie: information elements advertised by the peer candidate
6477 * @ie_len: length of the information elements buffer
6478 * @gfp: allocation flags
6480 * This function notifies cfg80211 that the mesh peer candidate has been
6481 * detected, most likely via a beacon or, less likely, via a probe response.
6482 * cfg80211 then sends a notification to userspace.
6484 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6485 const u8 *macaddr, const u8 *ie, u8 ie_len,
6486 int sig_dbm, gfp_t gfp);
6489 * DOC: RFkill integration
6491 * RFkill integration in cfg80211 is almost invisible to drivers,
6492 * as cfg80211 automatically registers an rfkill instance for each
6493 * wireless device it knows about. Soft kill is also translated
6494 * into disconnecting and turning all interfaces off, drivers are
6495 * expected to turn off the device when all interfaces are down.
6497 * However, devices may have a hard RFkill line, in which case they
6498 * also need to interact with the rfkill subsystem, via cfg80211.
6499 * They can do this with a few helper functions documented here.
6503 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6505 * @blocked: block status
6507 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
6510 * wiphy_rfkill_start_polling - start polling rfkill
6513 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6516 * wiphy_rfkill_stop_polling - stop polling rfkill
6519 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
6522 * DOC: Vendor commands
6524 * Occasionally, there are special protocol or firmware features that
6525 * can't be implemented very openly. For this and similar cases, the
6526 * vendor command functionality allows implementing the features with
6527 * (typically closed-source) userspace and firmware, using nl80211 as
6528 * the configuration mechanism.
6530 * A driver supporting vendor commands must register them as an array
6531 * in struct wiphy, with handlers for each one, each command has an
6532 * OUI and sub command ID to identify it.
6534 * Note that this feature should not be (ab)used to implement protocol
6535 * features that could openly be shared across drivers. In particular,
6536 * it must never be required to use vendor commands to implement any
6537 * "normal" functionality that higher-level userspace like connection
6538 * managers etc. need.
6541 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6542 enum nl80211_commands cmd,
6543 enum nl80211_attrs attr,
6546 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6547 struct wireless_dev *wdev,
6548 enum nl80211_commands cmd,
6549 enum nl80211_attrs attr,
6550 unsigned int portid,
6551 int vendor_event_idx,
6552 int approxlen, gfp_t gfp);
6554 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6557 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6559 * @approxlen: an upper bound of the length of the data that will
6560 * be put into the skb
6562 * This function allocates and pre-fills an skb for a reply to
6563 * a vendor command. Since it is intended for a reply, calling
6564 * it outside of a vendor command's doit() operation is invalid.
6566 * The returned skb is pre-filled with some identifying data in
6567 * a way that any data that is put into the skb (with skb_put(),
6568 * nla_put() or similar) will end up being within the
6569 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6570 * with the skb is adding data for the corresponding userspace tool
6571 * which can then read that data out of the vendor data attribute.
6572 * You must not modify the skb in any other way.
6574 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6575 * its error code as the result of the doit() operation.
6577 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6579 static inline struct sk_buff *
6580 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6582 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6583 NL80211_ATTR_VENDOR_DATA, approxlen);
6587 * cfg80211_vendor_cmd_reply - send the reply skb
6588 * @skb: The skb, must have been allocated with
6589 * cfg80211_vendor_cmd_alloc_reply_skb()
6591 * Since calling this function will usually be the last thing
6592 * before returning from the vendor command doit() you should
6593 * return the error code. Note that this function consumes the
6594 * skb regardless of the return value.
6596 * Return: An error code or 0 on success.
6598 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6601 * cfg80211_vendor_cmd_get_sender
6604 * Return the current netlink port ID in a vendor command handler.
6605 * Valid to call only there.
6607 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6610 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6612 * @wdev: the wireless device
6613 * @event_idx: index of the vendor event in the wiphy's vendor_events
6614 * @approxlen: an upper bound of the length of the data that will
6615 * be put into the skb
6616 * @gfp: allocation flags
6618 * This function allocates and pre-fills an skb for an event on the
6619 * vendor-specific multicast group.
6621 * If wdev != NULL, both the ifindex and identifier of the specified
6622 * wireless device are added to the event message before the vendor data
6625 * When done filling the skb, call cfg80211_vendor_event() with the
6626 * skb to send the event.
6628 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6630 static inline struct sk_buff *
6631 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6632 int approxlen, int event_idx, gfp_t gfp)
6634 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6635 NL80211_ATTR_VENDOR_DATA,
6636 0, event_idx, approxlen, gfp);
6640 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6642 * @wdev: the wireless device
6643 * @event_idx: index of the vendor event in the wiphy's vendor_events
6644 * @portid: port ID of the receiver
6645 * @approxlen: an upper bound of the length of the data that will
6646 * be put into the skb
6647 * @gfp: allocation flags
6649 * This function allocates and pre-fills an skb for an event to send to
6650 * a specific (userland) socket. This socket would previously have been
6651 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6652 * care to register a netlink notifier to see when the socket closes.
6654 * If wdev != NULL, both the ifindex and identifier of the specified
6655 * wireless device are added to the event message before the vendor data
6658 * When done filling the skb, call cfg80211_vendor_event() with the
6659 * skb to send the event.
6661 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6663 static inline struct sk_buff *
6664 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6665 struct wireless_dev *wdev,
6666 unsigned int portid, int approxlen,
6667 int event_idx, gfp_t gfp)
6669 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6670 NL80211_ATTR_VENDOR_DATA,
6671 portid, event_idx, approxlen, gfp);
6675 * cfg80211_vendor_event - send the event
6676 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6677 * @gfp: allocation flags
6679 * This function sends the given @skb, which must have been allocated
6680 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6682 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6684 __cfg80211_send_event_skb(skb, gfp);
6687 #ifdef CONFIG_NL80211_TESTMODE
6691 * Test mode is a set of utility functions to allow drivers to
6692 * interact with driver-specific tools to aid, for instance,
6693 * factory programming.
6695 * This chapter describes how drivers interact with it, for more
6696 * information see the nl80211 book's chapter on it.
6700 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6702 * @approxlen: an upper bound of the length of the data that will
6703 * be put into the skb
6705 * This function allocates and pre-fills an skb for a reply to
6706 * the testmode command. Since it is intended for a reply, calling
6707 * it outside of the @testmode_cmd operation is invalid.
6709 * The returned skb is pre-filled with the wiphy index and set up in
6710 * a way that any data that is put into the skb (with skb_put(),
6711 * nla_put() or similar) will end up being within the
6712 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6713 * with the skb is adding data for the corresponding userspace tool
6714 * which can then read that data out of the testdata attribute. You
6715 * must not modify the skb in any other way.
6717 * When done, call cfg80211_testmode_reply() with the skb and return
6718 * its error code as the result of the @testmode_cmd operation.
6720 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6722 static inline struct sk_buff *
6723 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6725 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6726 NL80211_ATTR_TESTDATA, approxlen);
6730 * cfg80211_testmode_reply - send the reply skb
6731 * @skb: The skb, must have been allocated with
6732 * cfg80211_testmode_alloc_reply_skb()
6734 * Since calling this function will usually be the last thing
6735 * before returning from the @testmode_cmd you should return
6736 * the error code. Note that this function consumes the skb
6737 * regardless of the return value.
6739 * Return: An error code or 0 on success.
6741 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6743 return cfg80211_vendor_cmd_reply(skb);
6747 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6749 * @approxlen: an upper bound of the length of the data that will
6750 * be put into the skb
6751 * @gfp: allocation flags
6753 * This function allocates and pre-fills an skb for an event on the
6754 * testmode multicast group.
6756 * The returned skb is set up in the same way as with
6757 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6758 * there, you should simply add data to it that will then end up in the
6759 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6762 * When done filling the skb, call cfg80211_testmode_event() with the
6763 * skb to send the event.
6765 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6767 static inline struct sk_buff *
6768 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6770 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6771 NL80211_ATTR_TESTDATA, 0, -1,
6776 * cfg80211_testmode_event - send the event
6777 * @skb: The skb, must have been allocated with
6778 * cfg80211_testmode_alloc_event_skb()
6779 * @gfp: allocation flags
6781 * This function sends the given @skb, which must have been allocated
6782 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6785 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6787 __cfg80211_send_event_skb(skb, gfp);
6790 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6791 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6793 #define CFG80211_TESTMODE_CMD(cmd)
6794 #define CFG80211_TESTMODE_DUMP(cmd)
6798 * struct cfg80211_fils_resp_params - FILS connection response params
6799 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6800 * @kek_len: Length of @fils_kek in octets
6801 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6802 * @erp_next_seq_num is valid.
6803 * @erp_next_seq_num: The next sequence number to use in ERP message in
6804 * FILS Authentication. This value should be specified irrespective of the
6805 * status for a FILS connection.
6806 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6807 * @pmk_len: Length of @pmk in octets
6808 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6809 * used for this FILS connection (may be %NULL).
6811 struct cfg80211_fils_resp_params {
6814 bool update_erp_next_seq_num;
6815 u16 erp_next_seq_num;
6822 * struct cfg80211_connect_resp_params - Connection response params
6823 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6824 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6825 * the real status code for failures. If this call is used to report a
6826 * failure due to a timeout (e.g., not receiving an Authentication frame
6827 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6828 * indicate that this is a failure, but without a status code.
6829 * @timeout_reason is used to report the reason for the timeout in that
6831 * @bssid: The BSSID of the AP (may be %NULL)
6832 * @bss: Entry of bss to which STA got connected to, can be obtained through
6833 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6834 * bss from the connect_request and hold a reference to it and return
6835 * through this param to avoid a warning if the bss is expired during the
6836 * connection, esp. for those drivers implementing connect op.
6837 * Only one parameter among @bssid and @bss needs to be specified.
6838 * @req_ie: Association request IEs (may be %NULL)
6839 * @req_ie_len: Association request IEs length
6840 * @resp_ie: Association response IEs (may be %NULL)
6841 * @resp_ie_len: Association response IEs length
6842 * @fils: FILS connection response parameters.
6843 * @timeout_reason: Reason for connection timeout. This is used when the
6844 * connection fails due to a timeout instead of an explicit rejection from
6845 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6846 * not known. This value is used only if @status < 0 to indicate that the
6847 * failure is due to a timeout and not due to explicit rejection by the AP.
6848 * This value is ignored in other cases (@status >= 0).
6850 struct cfg80211_connect_resp_params {
6853 struct cfg80211_bss *bss;
6858 struct cfg80211_fils_resp_params fils;
6859 enum nl80211_timeout_reason timeout_reason;
6863 * cfg80211_connect_done - notify cfg80211 of connection result
6865 * @dev: network device
6866 * @params: connection response parameters
6867 * @gfp: allocation flags
6869 * It should be called by the underlying driver once execution of the connection
6870 * request from connect() has been completed. This is similar to
6871 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6872 * parameters. Only one of the functions among cfg80211_connect_bss(),
6873 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6874 * and cfg80211_connect_done() should be called.
6876 void cfg80211_connect_done(struct net_device *dev,
6877 struct cfg80211_connect_resp_params *params,
6881 * cfg80211_connect_bss - notify cfg80211 of connection result
6883 * @dev: network device
6884 * @bssid: the BSSID of the AP
6885 * @bss: Entry of bss to which STA got connected to, can be obtained through
6886 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6887 * bss from the connect_request and hold a reference to it and return
6888 * through this param to avoid a warning if the bss is expired during the
6889 * connection, esp. for those drivers implementing connect op.
6890 * Only one parameter among @bssid and @bss needs to be specified.
6891 * @req_ie: association request IEs (maybe be %NULL)
6892 * @req_ie_len: association request IEs length
6893 * @resp_ie: association response IEs (may be %NULL)
6894 * @resp_ie_len: assoc response IEs length
6895 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6896 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6897 * the real status code for failures. If this call is used to report a
6898 * failure due to a timeout (e.g., not receiving an Authentication frame
6899 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6900 * indicate that this is a failure, but without a status code.
6901 * @timeout_reason is used to report the reason for the timeout in that
6903 * @gfp: allocation flags
6904 * @timeout_reason: reason for connection timeout. This is used when the
6905 * connection fails due to a timeout instead of an explicit rejection from
6906 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6907 * not known. This value is used only if @status < 0 to indicate that the
6908 * failure is due to a timeout and not due to explicit rejection by the AP.
6909 * This value is ignored in other cases (@status >= 0).
6911 * It should be called by the underlying driver once execution of the connection
6912 * request from connect() has been completed. This is similar to
6913 * cfg80211_connect_result(), but with the option of identifying the exact bss
6914 * entry for the connection. Only one of the functions among
6915 * cfg80211_connect_bss(), cfg80211_connect_result(),
6916 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6919 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6920 struct cfg80211_bss *bss, const u8 *req_ie,
6921 size_t req_ie_len, const u8 *resp_ie,
6922 size_t resp_ie_len, int status, gfp_t gfp,
6923 enum nl80211_timeout_reason timeout_reason)
6925 struct cfg80211_connect_resp_params params;
6927 memset(¶ms, 0, sizeof(params));
6928 params.status = status;
6929 params.bssid = bssid;
6931 params.req_ie = req_ie;
6932 params.req_ie_len = req_ie_len;
6933 params.resp_ie = resp_ie;
6934 params.resp_ie_len = resp_ie_len;
6935 params.timeout_reason = timeout_reason;
6937 cfg80211_connect_done(dev, ¶ms, gfp);
6941 * cfg80211_connect_result - notify cfg80211 of connection result
6943 * @dev: network device
6944 * @bssid: the BSSID of the AP
6945 * @req_ie: association request IEs (maybe be %NULL)
6946 * @req_ie_len: association request IEs length
6947 * @resp_ie: association response IEs (may be %NULL)
6948 * @resp_ie_len: assoc response IEs length
6949 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6950 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6951 * the real status code for failures.
6952 * @gfp: allocation flags
6954 * It should be called by the underlying driver once execution of the connection
6955 * request from connect() has been completed. This is similar to
6956 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6957 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6958 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6961 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6962 const u8 *req_ie, size_t req_ie_len,
6963 const u8 *resp_ie, size_t resp_ie_len,
6964 u16 status, gfp_t gfp)
6966 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6967 resp_ie_len, status, gfp,
6968 NL80211_TIMEOUT_UNSPECIFIED);
6972 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6974 * @dev: network device
6975 * @bssid: the BSSID of the AP
6976 * @req_ie: association request IEs (maybe be %NULL)
6977 * @req_ie_len: association request IEs length
6978 * @gfp: allocation flags
6979 * @timeout_reason: reason for connection timeout.
6981 * It should be called by the underlying driver whenever connect() has failed
6982 * in a sequence where no explicit authentication/association rejection was
6983 * received from the AP. This could happen, e.g., due to not being able to send
6984 * out the Authentication or Association Request frame or timing out while
6985 * waiting for the response. Only one of the functions among
6986 * cfg80211_connect_bss(), cfg80211_connect_result(),
6987 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6990 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6991 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6992 enum nl80211_timeout_reason timeout_reason)
6994 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6995 gfp, timeout_reason);
6999 * struct cfg80211_roam_info - driver initiated roaming information
7001 * @channel: the channel of the new AP
7002 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
7003 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
7004 * @req_ie: association request IEs (maybe be %NULL)
7005 * @req_ie_len: association request IEs length
7006 * @resp_ie: association response IEs (may be %NULL)
7007 * @resp_ie_len: assoc response IEs length
7008 * @fils: FILS related roaming information.
7010 struct cfg80211_roam_info {
7011 struct ieee80211_channel *channel;
7012 struct cfg80211_bss *bss;
7018 struct cfg80211_fils_resp_params fils;
7022 * cfg80211_roamed - notify cfg80211 of roaming
7024 * @dev: network device
7025 * @info: information about the new BSS. struct &cfg80211_roam_info.
7026 * @gfp: allocation flags
7028 * This function may be called with the driver passing either the BSSID of the
7029 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7030 * It should be called by the underlying driver whenever it roamed from one AP
7031 * to another while connected. Drivers which have roaming implemented in
7032 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7033 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7034 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7035 * rdev->event_work. In case of any failures, the reference is released
7036 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7037 * released while disconnecting from the current bss.
7039 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7043 * cfg80211_port_authorized - notify cfg80211 of successful security association
7045 * @dev: network device
7046 * @bssid: the BSSID of the AP
7047 * @gfp: allocation flags
7049 * This function should be called by a driver that supports 4 way handshake
7050 * offload after a security association was successfully established (i.e.,
7051 * the 4 way handshake was completed successfully). The call to this function
7052 * should be preceded with a call to cfg80211_connect_result(),
7053 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7054 * indicate the 802.11 association.
7056 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7060 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7062 * @dev: network device
7063 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7064 * @ie_len: length of IEs
7065 * @reason: reason code for the disconnection, set it to 0 if unknown
7066 * @locally_generated: disconnection was requested locally
7067 * @gfp: allocation flags
7069 * After it calls this function, the driver should enter an idle state
7070 * and not try to connect to any AP any more.
7072 void cfg80211_disconnected(struct net_device *dev, u16 reason,
7073 const u8 *ie, size_t ie_len,
7074 bool locally_generated, gfp_t gfp);
7077 * cfg80211_ready_on_channel - notification of remain_on_channel start
7078 * @wdev: wireless device
7079 * @cookie: the request cookie
7080 * @chan: The current channel (from remain_on_channel request)
7081 * @duration: Duration in milliseconds that the driver intents to remain on the
7083 * @gfp: allocation flags
7085 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7086 struct ieee80211_channel *chan,
7087 unsigned int duration, gfp_t gfp);
7090 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7091 * @wdev: wireless device
7092 * @cookie: the request cookie
7093 * @chan: The current channel (from remain_on_channel request)
7094 * @gfp: allocation flags
7096 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7097 struct ieee80211_channel *chan,
7101 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7102 * @wdev: wireless device
7103 * @cookie: the requested cookie
7104 * @chan: The current channel (from tx_mgmt request)
7105 * @gfp: allocation flags
7107 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7108 struct ieee80211_channel *chan, gfp_t gfp);
7111 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7113 * @sinfo: the station information
7114 * @gfp: allocation flags
7116 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7119 * cfg80211_sinfo_release_content - release contents of station info
7120 * @sinfo: the station information
7122 * Releases any potentially allocated sub-information of the station
7123 * information, but not the struct itself (since it's typically on
7126 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7128 kfree(sinfo->pertid);
7132 * cfg80211_new_sta - notify userspace about station
7135 * @mac_addr: the station's address
7136 * @sinfo: the station information
7137 * @gfp: allocation flags
7139 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7140 struct station_info *sinfo, gfp_t gfp);
7143 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7145 * @mac_addr: the station's address
7146 * @sinfo: the station information/statistics
7147 * @gfp: allocation flags
7149 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7150 struct station_info *sinfo, gfp_t gfp);
7153 * cfg80211_del_sta - notify userspace about deletion of a station
7156 * @mac_addr: the station's address
7157 * @gfp: allocation flags
7159 static inline void cfg80211_del_sta(struct net_device *dev,
7160 const u8 *mac_addr, gfp_t gfp)
7162 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7166 * cfg80211_conn_failed - connection request failed notification
7169 * @mac_addr: the station's address
7170 * @reason: the reason for connection failure
7171 * @gfp: allocation flags
7173 * Whenever a station tries to connect to an AP and if the station
7174 * could not connect to the AP as the AP has rejected the connection
7175 * for some reasons, this function is called.
7177 * The reason for connection failure can be any of the value from
7178 * nl80211_connect_failed_reason enum
7180 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7181 enum nl80211_connect_failed_reason reason,
7185 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7186 * @wdev: wireless device receiving the frame
7187 * @freq: Frequency on which the frame was received in KHz
7188 * @sig_dbm: signal strength in dBm, or 0 if unknown
7189 * @buf: Management frame (header + body)
7190 * @len: length of the frame data
7191 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7193 * This function is called whenever an Action frame is received for a station
7194 * mode interface, but is not processed in kernel.
7196 * Return: %true if a user space application has registered for this frame.
7197 * For action frames, that makes it responsible for rejecting unrecognized
7198 * action frames; %false otherwise, in which case for action frames the
7199 * driver is responsible for rejecting the frame.
7201 bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq, int sig_dbm,
7202 const u8 *buf, size_t len, u32 flags);
7205 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7206 * @wdev: wireless device receiving the frame
7207 * @freq: Frequency on which the frame was received in MHz
7208 * @sig_dbm: signal strength in dBm, or 0 if unknown
7209 * @buf: Management frame (header + body)
7210 * @len: length of the frame data
7211 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7213 * This function is called whenever an Action frame is received for a station
7214 * mode interface, but is not processed in kernel.
7216 * Return: %true if a user space application has registered for this frame.
7217 * For action frames, that makes it responsible for rejecting unrecognized
7218 * action frames; %false otherwise, in which case for action frames the
7219 * driver is responsible for rejecting the frame.
7221 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7222 int sig_dbm, const u8 *buf, size_t len,
7225 return cfg80211_rx_mgmt_khz(wdev, MHZ_TO_KHZ(freq), sig_dbm, buf, len,
7230 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7231 * @wdev: wireless device receiving the frame
7232 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7233 * @buf: Management frame (header + body)
7234 * @len: length of the frame data
7235 * @ack: Whether frame was acknowledged
7236 * @gfp: context flags
7238 * This function is called whenever a management frame was requested to be
7239 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7240 * transmission attempt.
7242 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
7243 const u8 *buf, size_t len, bool ack, gfp_t gfp);
7246 * cfg80211_control_port_tx_status - notification of TX status for control
7248 * @wdev: wireless device receiving the frame
7249 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7250 * @buf: Data frame (header + body)
7251 * @len: length of the frame data
7252 * @ack: Whether frame was acknowledged
7253 * @gfp: context flags
7255 * This function is called whenever a control port frame was requested to be
7256 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7257 * the transmission attempt.
7259 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
7260 const u8 *buf, size_t len, bool ack,
7264 * cfg80211_rx_control_port - notification about a received control port frame
7265 * @dev: The device the frame matched to
7266 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7267 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7268 * This function does not take ownership of the skb, so the caller is
7269 * responsible for any cleanup. The caller must also ensure that
7270 * skb->protocol is set appropriately.
7271 * @unencrypted: Whether the frame was received unencrypted
7273 * This function is used to inform userspace about a received control port
7274 * frame. It should only be used if userspace indicated it wants to receive
7275 * control port frames over nl80211.
7277 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7278 * network layer headers removed (e.g. the raw EAPoL frame).
7280 * Return: %true if the frame was passed to userspace
7282 bool cfg80211_rx_control_port(struct net_device *dev,
7283 struct sk_buff *skb, bool unencrypted);
7286 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
7287 * @dev: network device
7288 * @rssi_event: the triggered RSSI event
7289 * @rssi_level: new RSSI level value or 0 if not available
7290 * @gfp: context flags
7292 * This function is called when a configured connection quality monitoring
7293 * rssi threshold reached event occurs.
7295 void cfg80211_cqm_rssi_notify(struct net_device *dev,
7296 enum nl80211_cqm_rssi_threshold_event rssi_event,
7297 s32 rssi_level, gfp_t gfp);
7300 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
7301 * @dev: network device
7302 * @peer: peer's MAC address
7303 * @num_packets: how many packets were lost -- should be a fixed threshold
7304 * but probably no less than maybe 50, or maybe a throughput dependent
7305 * threshold (to account for temporary interference)
7306 * @gfp: context flags
7308 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
7309 const u8 *peer, u32 num_packets, gfp_t gfp);
7312 * cfg80211_cqm_txe_notify - TX error rate event
7313 * @dev: network device
7314 * @peer: peer's MAC address
7315 * @num_packets: how many packets were lost
7316 * @rate: % of packets which failed transmission
7317 * @intvl: interval (in s) over which the TX failure threshold was breached.
7318 * @gfp: context flags
7320 * Notify userspace when configured % TX failures over number of packets in a
7321 * given interval is exceeded.
7323 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
7324 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
7327 * cfg80211_cqm_beacon_loss_notify - beacon loss event
7328 * @dev: network device
7329 * @gfp: context flags
7331 * Notify userspace about beacon loss from the connected AP.
7333 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
7336 * cfg80211_radar_event - radar detection event
7338 * @chandef: chandef for the current channel
7339 * @gfp: context flags
7341 * This function is called when a radar is detected on the current chanenl.
7343 void cfg80211_radar_event(struct wiphy *wiphy,
7344 struct cfg80211_chan_def *chandef, gfp_t gfp);
7347 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
7348 * @dev: network device
7349 * @mac: MAC address of a station which opmode got modified
7350 * @sta_opmode: station's current opmode value
7351 * @gfp: context flags
7353 * Driver should call this function when station's opmode modified via action
7356 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
7357 struct sta_opmode_info *sta_opmode,
7361 * cfg80211_cac_event - Channel availability check (CAC) event
7362 * @netdev: network device
7363 * @chandef: chandef for the current channel
7364 * @event: type of event
7365 * @gfp: context flags
7367 * This function is called when a Channel availability check (CAC) is finished
7368 * or aborted. This must be called to notify the completion of a CAC process,
7369 * also by full-MAC drivers.
7371 void cfg80211_cac_event(struct net_device *netdev,
7372 const struct cfg80211_chan_def *chandef,
7373 enum nl80211_radar_event event, gfp_t gfp);
7377 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
7378 * @dev: network device
7379 * @bssid: BSSID of AP (to avoid races)
7380 * @replay_ctr: new replay counter
7381 * @gfp: allocation flags
7383 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
7384 const u8 *replay_ctr, gfp_t gfp);
7387 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7388 * @dev: network device
7389 * @index: candidate index (the smaller the index, the higher the priority)
7390 * @bssid: BSSID of AP
7391 * @preauth: Whether AP advertises support for RSN pre-authentication
7392 * @gfp: allocation flags
7394 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
7395 const u8 *bssid, bool preauth, gfp_t gfp);
7398 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7399 * @dev: The device the frame matched to
7400 * @addr: the transmitter address
7401 * @gfp: context flags
7403 * This function is used in AP mode (only!) to inform userspace that
7404 * a spurious class 3 frame was received, to be able to deauth the
7406 * Return: %true if the frame was passed to userspace (or this failed
7407 * for a reason other than not having a subscription.)
7409 bool cfg80211_rx_spurious_frame(struct net_device *dev,
7410 const u8 *addr, gfp_t gfp);
7413 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7414 * @dev: The device the frame matched to
7415 * @addr: the transmitter address
7416 * @gfp: context flags
7418 * This function is used in AP mode (only!) to inform userspace that
7419 * an associated station sent a 4addr frame but that wasn't expected.
7420 * It is allowed and desirable to send this event only once for each
7421 * station to avoid event flooding.
7422 * Return: %true if the frame was passed to userspace (or this failed
7423 * for a reason other than not having a subscription.)
7425 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
7426 const u8 *addr, gfp_t gfp);
7429 * cfg80211_probe_status - notify userspace about probe status
7430 * @dev: the device the probe was sent on
7431 * @addr: the address of the peer
7432 * @cookie: the cookie filled in @probe_client previously
7433 * @acked: indicates whether probe was acked or not
7434 * @ack_signal: signal strength (in dBm) of the ACK frame.
7435 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7436 * @gfp: allocation flags
7438 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
7439 u64 cookie, bool acked, s32 ack_signal,
7440 bool is_valid_ack_signal, gfp_t gfp);
7443 * cfg80211_report_obss_beacon_khz - report beacon from other APs
7444 * @wiphy: The wiphy that received the beacon
7446 * @len: length of the frame
7447 * @freq: frequency the frame was received on in KHz
7448 * @sig_dbm: signal strength in dBm, or 0 if unknown
7450 * Use this function to report to userspace when a beacon was
7451 * received. It is not useful to call this when there is no
7452 * netdev that is in AP/GO mode.
7454 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
7455 size_t len, int freq, int sig_dbm);
7458 * cfg80211_report_obss_beacon - report beacon from other APs
7459 * @wiphy: The wiphy that received the beacon
7461 * @len: length of the frame
7462 * @freq: frequency the frame was received on
7463 * @sig_dbm: signal strength in dBm, or 0 if unknown
7465 * Use this function to report to userspace when a beacon was
7466 * received. It is not useful to call this when there is no
7467 * netdev that is in AP/GO mode.
7469 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7470 const u8 *frame, size_t len,
7471 int freq, int sig_dbm)
7473 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
7478 * cfg80211_reg_can_beacon - check if beaconing is allowed
7480 * @chandef: the channel definition
7481 * @iftype: interface type
7483 * Return: %true if there is no secondary channel or the secondary channel(s)
7484 * can be used for beaconing (i.e. is not a radar channel etc.)
7486 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7487 struct cfg80211_chan_def *chandef,
7488 enum nl80211_iftype iftype);
7491 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7493 * @chandef: the channel definition
7494 * @iftype: interface type
7496 * Return: %true if there is no secondary channel or the secondary channel(s)
7497 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7498 * also checks if IR-relaxation conditions apply, to allow beaconing under
7499 * more permissive conditions.
7501 * Requires the RTNL to be held.
7503 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7504 struct cfg80211_chan_def *chandef,
7505 enum nl80211_iftype iftype);
7508 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7509 * @dev: the device which switched channels
7510 * @chandef: the new channel definition
7512 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7515 void cfg80211_ch_switch_notify(struct net_device *dev,
7516 struct cfg80211_chan_def *chandef);
7519 * cfg80211_ch_switch_started_notify - notify channel switch start
7520 * @dev: the device on which the channel switch started
7521 * @chandef: the future channel definition
7522 * @count: the number of TBTTs until the channel switch happens
7524 * Inform the userspace about the channel switch that has just
7525 * started, so that it can take appropriate actions (eg. starting
7526 * channel switch on other vifs), if necessary.
7528 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7529 struct cfg80211_chan_def *chandef,
7533 * ieee80211_operating_class_to_band - convert operating class to band
7535 * @operating_class: the operating class to convert
7536 * @band: band pointer to fill
7538 * Returns %true if the conversion was successful, %false otherwise.
7540 bool ieee80211_operating_class_to_band(u8 operating_class,
7541 enum nl80211_band *band);
7544 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7546 * @chandef: the chandef to convert
7547 * @op_class: a pointer to the resulting operating class
7549 * Returns %true if the conversion was successful, %false otherwise.
7551 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7555 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
7557 * @chandef: the chandef to convert
7559 * Returns the center frequency of chandef (1st segment) in KHz.
7562 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
7564 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
7568 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7569 * @dev: the device on which the operation is requested
7570 * @peer: the MAC address of the peer device
7571 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7572 * NL80211_TDLS_TEARDOWN)
7573 * @reason_code: the reason code for teardown request
7574 * @gfp: allocation flags
7576 * This function is used to request userspace to perform TDLS operation that
7577 * requires knowledge of keys, i.e., link setup or teardown when the AP
7578 * connection uses encryption. This is optional mechanism for the driver to use
7579 * if it can automatically determine when a TDLS link could be useful (e.g.,
7580 * based on traffic and signal strength for a peer).
7582 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7583 enum nl80211_tdls_operation oper,
7584 u16 reason_code, gfp_t gfp);
7587 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7588 * @rate: given rate_info to calculate bitrate from
7590 * return 0 if MCS index >= 32
7592 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7595 * cfg80211_unregister_wdev - remove the given wdev
7596 * @wdev: struct wireless_dev to remove
7598 * Call this function only for wdevs that have no netdev assigned,
7599 * e.g. P2P Devices. It removes the device from the list so that
7600 * it can no longer be used. It is necessary to call this function
7601 * even when cfg80211 requests the removal of the interface by
7602 * calling the del_virtual_intf() callback. The function must also
7603 * be called when the driver wishes to unregister the wdev, e.g.
7604 * when the device is unbound from the driver.
7606 * Requires the RTNL to be held.
7608 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7611 * struct cfg80211_ft_event_params - FT Information Elements
7613 * @ies_len: length of the FT IE in bytes
7614 * @target_ap: target AP's MAC address
7616 * @ric_ies_len: length of the RIC IE in bytes
7618 struct cfg80211_ft_event_params {
7621 const u8 *target_ap;
7627 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7628 * @netdev: network device
7629 * @ft_event: IE information
7631 void cfg80211_ft_event(struct net_device *netdev,
7632 struct cfg80211_ft_event_params *ft_event);
7635 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7636 * @ies: the input IE buffer
7637 * @len: the input length
7638 * @attr: the attribute ID to find
7639 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7640 * if the function is only called to get the needed buffer size
7641 * @bufsize: size of the output buffer
7643 * The function finds a given P2P attribute in the (vendor) IEs and
7644 * copies its contents to the given buffer.
7646 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7647 * malformed or the attribute can't be found (respectively), or the
7648 * length of the found attribute (which can be zero).
7650 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7651 enum ieee80211_p2p_attr_id attr,
7652 u8 *buf, unsigned int bufsize);
7655 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7656 * @ies: the IE buffer
7657 * @ielen: the length of the IE buffer
7658 * @ids: an array with element IDs that are allowed before
7659 * the split. A WLAN_EID_EXTENSION value means that the next
7660 * EID in the list is a sub-element of the EXTENSION IE.
7661 * @n_ids: the size of the element ID array
7662 * @after_ric: array IE types that come after the RIC element
7663 * @n_after_ric: size of the @after_ric array
7664 * @offset: offset where to start splitting in the buffer
7666 * This function splits an IE buffer by updating the @offset
7667 * variable to point to the location where the buffer should be
7670 * It assumes that the given IE buffer is well-formed, this
7671 * has to be guaranteed by the caller!
7673 * It also assumes that the IEs in the buffer are ordered
7674 * correctly, if not the result of using this function will not
7675 * be ordered correctly either, i.e. it does no reordering.
7677 * The function returns the offset where the next part of the
7678 * buffer starts, which may be @ielen if the entire (remainder)
7679 * of the buffer should be used.
7681 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7682 const u8 *ids, int n_ids,
7683 const u8 *after_ric, int n_after_ric,
7687 * ieee80211_ie_split - split an IE buffer according to ordering
7688 * @ies: the IE buffer
7689 * @ielen: the length of the IE buffer
7690 * @ids: an array with element IDs that are allowed before
7691 * the split. A WLAN_EID_EXTENSION value means that the next
7692 * EID in the list is a sub-element of the EXTENSION IE.
7693 * @n_ids: the size of the element ID array
7694 * @offset: offset where to start splitting in the buffer
7696 * This function splits an IE buffer by updating the @offset
7697 * variable to point to the location where the buffer should be
7700 * It assumes that the given IE buffer is well-formed, this
7701 * has to be guaranteed by the caller!
7703 * It also assumes that the IEs in the buffer are ordered
7704 * correctly, if not the result of using this function will not
7705 * be ordered correctly either, i.e. it does no reordering.
7707 * The function returns the offset where the next part of the
7708 * buffer starts, which may be @ielen if the entire (remainder)
7709 * of the buffer should be used.
7711 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7712 const u8 *ids, int n_ids, size_t offset)
7714 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7718 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7719 * @wdev: the wireless device reporting the wakeup
7720 * @wakeup: the wakeup report
7721 * @gfp: allocation flags
7723 * This function reports that the given device woke up. If it
7724 * caused the wakeup, report the reason(s), otherwise you may
7725 * pass %NULL as the @wakeup parameter to advertise that something
7726 * else caused the wakeup.
7728 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7729 struct cfg80211_wowlan_wakeup *wakeup,
7733 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7735 * @wdev: the wireless device for which critical protocol is stopped.
7736 * @gfp: allocation flags
7738 * This function can be called by the driver to indicate it has reverted
7739 * operation back to normal. One reason could be that the duration given
7740 * by .crit_proto_start() has expired.
7742 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7745 * ieee80211_get_num_supported_channels - get number of channels device has
7748 * Return: the number of channels supported by the device.
7750 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7753 * cfg80211_check_combinations - check interface combinations
7756 * @params: the interface combinations parameter
7758 * This function can be called by the driver to check whether a
7759 * combination of interfaces and their types are allowed according to
7760 * the interface combinations.
7762 int cfg80211_check_combinations(struct wiphy *wiphy,
7763 struct iface_combination_params *params);
7766 * cfg80211_iter_combinations - iterate over matching combinations
7769 * @params: the interface combinations parameter
7770 * @iter: function to call for each matching combination
7771 * @data: pointer to pass to iter function
7773 * This function can be called by the driver to check what possible
7774 * combinations it fits in at a given moment, e.g. for channel switching
7777 int cfg80211_iter_combinations(struct wiphy *wiphy,
7778 struct iface_combination_params *params,
7779 void (*iter)(const struct ieee80211_iface_combination *c,
7784 * cfg80211_stop_iface - trigger interface disconnection
7787 * @wdev: wireless device
7788 * @gfp: context flags
7790 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7793 * Note: This doesn't need any locks and is asynchronous.
7795 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7799 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7800 * @wiphy: the wiphy to shut down
7802 * This function shuts down all interfaces belonging to this wiphy by
7803 * calling dev_close() (and treating non-netdev interfaces as needed).
7804 * It shouldn't really be used unless there are some fatal device errors
7805 * that really can't be recovered in any other way.
7807 * Callers must hold the RTNL and be able to deal with callbacks into
7808 * the driver while the function is running.
7810 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7813 * wiphy_ext_feature_set - set the extended feature flag
7815 * @wiphy: the wiphy to modify.
7816 * @ftidx: extended feature bit index.
7818 * The extended features are flagged in multiple bytes (see
7819 * &struct wiphy.@ext_features)
7821 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7822 enum nl80211_ext_feature_index ftidx)
7826 ft_byte = &wiphy->ext_features[ftidx / 8];
7827 *ft_byte |= BIT(ftidx % 8);
7831 * wiphy_ext_feature_isset - check the extended feature flag
7833 * @wiphy: the wiphy to modify.
7834 * @ftidx: extended feature bit index.
7836 * The extended features are flagged in multiple bytes (see
7837 * &struct wiphy.@ext_features)
7840 wiphy_ext_feature_isset(struct wiphy *wiphy,
7841 enum nl80211_ext_feature_index ftidx)
7845 ft_byte = wiphy->ext_features[ftidx / 8];
7846 return (ft_byte & BIT(ftidx % 8)) != 0;
7850 * cfg80211_free_nan_func - free NAN function
7851 * @f: NAN function that should be freed
7853 * Frees all the NAN function and all it's allocated members.
7855 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7858 * struct cfg80211_nan_match_params - NAN match parameters
7859 * @type: the type of the function that triggered a match. If it is
7860 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7861 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7863 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7864 * @inst_id: the local instance id
7865 * @peer_inst_id: the instance id of the peer's function
7866 * @addr: the MAC address of the peer
7867 * @info_len: the length of the &info
7868 * @info: the Service Specific Info from the peer (if any)
7869 * @cookie: unique identifier of the corresponding function
7871 struct cfg80211_nan_match_params {
7872 enum nl80211_nan_function_type type;
7882 * cfg80211_nan_match - report a match for a NAN function.
7883 * @wdev: the wireless device reporting the match
7884 * @match: match notification parameters
7885 * @gfp: allocation flags
7887 * This function reports that the a NAN function had a match. This
7888 * can be a subscribe that had a match or a solicited publish that
7889 * was sent. It can also be a follow up that was received.
7891 void cfg80211_nan_match(struct wireless_dev *wdev,
7892 struct cfg80211_nan_match_params *match, gfp_t gfp);
7895 * cfg80211_nan_func_terminated - notify about NAN function termination.
7897 * @wdev: the wireless device reporting the match
7898 * @inst_id: the local instance id
7899 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7900 * @cookie: unique NAN function identifier
7901 * @gfp: allocation flags
7903 * This function reports that the a NAN function is terminated.
7905 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7907 enum nl80211_nan_func_term_reason reason,
7908 u64 cookie, gfp_t gfp);
7910 /* ethtool helper */
7911 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7914 * cfg80211_external_auth_request - userspace request for authentication
7915 * @netdev: network device
7916 * @params: External authentication parameters
7917 * @gfp: allocation flags
7918 * Returns: 0 on success, < 0 on error
7920 int cfg80211_external_auth_request(struct net_device *netdev,
7921 struct cfg80211_external_auth_params *params,
7925 * cfg80211_pmsr_report - report peer measurement result data
7926 * @wdev: the wireless device reporting the measurement
7927 * @req: the original measurement request
7928 * @result: the result data
7929 * @gfp: allocation flags
7931 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7932 struct cfg80211_pmsr_request *req,
7933 struct cfg80211_pmsr_result *result,
7937 * cfg80211_pmsr_complete - report peer measurement completed
7938 * @wdev: the wireless device reporting the measurement
7939 * @req: the original measurement request
7940 * @gfp: allocation flags
7942 * Report that the entire measurement completed, after this
7943 * the request pointer will no longer be valid.
7945 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7946 struct cfg80211_pmsr_request *req,
7950 * cfg80211_iftype_allowed - check whether the interface can be allowed
7952 * @iftype: interface type
7953 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7954 * @check_swif: check iftype against software interfaces
7956 * Check whether the interface is allowed to operate; additionally, this API
7957 * can be used to check iftype against the software interfaces when
7958 * check_swif is '1'.
7960 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
7961 bool is_4addr, u8 check_swif);
7964 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7966 /* wiphy_printk helpers, similar to dev_printk */
7968 #define wiphy_printk(level, wiphy, format, args...) \
7969 dev_printk(level, &(wiphy)->dev, format, ##args)
7970 #define wiphy_emerg(wiphy, format, args...) \
7971 dev_emerg(&(wiphy)->dev, format, ##args)
7972 #define wiphy_alert(wiphy, format, args...) \
7973 dev_alert(&(wiphy)->dev, format, ##args)
7974 #define wiphy_crit(wiphy, format, args...) \
7975 dev_crit(&(wiphy)->dev, format, ##args)
7976 #define wiphy_err(wiphy, format, args...) \
7977 dev_err(&(wiphy)->dev, format, ##args)
7978 #define wiphy_warn(wiphy, format, args...) \
7979 dev_warn(&(wiphy)->dev, format, ##args)
7980 #define wiphy_notice(wiphy, format, args...) \
7981 dev_notice(&(wiphy)->dev, format, ##args)
7982 #define wiphy_info(wiphy, format, args...) \
7983 dev_info(&(wiphy)->dev, format, ##args)
7985 #define wiphy_err_ratelimited(wiphy, format, args...) \
7986 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7987 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7988 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7990 #define wiphy_debug(wiphy, format, args...) \
7991 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7993 #define wiphy_dbg(wiphy, format, args...) \
7994 dev_dbg(&(wiphy)->dev, format, ##args)
7996 #if defined(VERBOSE_DEBUG)
7997 #define wiphy_vdbg wiphy_dbg
7999 #define wiphy_vdbg(wiphy, format, args...) \
8002 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8008 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8009 * of using a WARN/WARN_ON to get the message out, including the
8010 * file/line information and a backtrace.
8012 #define wiphy_WARN(wiphy, format, args...) \
8013 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8016 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8017 * @netdev: network device
8018 * @owe_info: peer's owe info
8019 * @gfp: allocation flags
8021 void cfg80211_update_owe_info_event(struct net_device *netdev,
8022 struct cfg80211_update_owe_info *owe_info,
8026 * cfg80211_bss_flush - resets all the scan entries
8029 void cfg80211_bss_flush(struct wiphy *wiphy);
8031 #endif /* __NET_CFG80211_H */