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 * @min_offset: minimal tx power offset an associated station shall use
273 * @max_offset: maximum tx power offset an associated station shall use
275 struct ieee80211_he_obss_pd {
282 * struct cfg80211_he_bss_color - AP settings for BSS coloring
284 * @color: the current color.
285 * @enabled: HE BSS color is used
286 * @partial: define the AID equation.
288 struct cfg80211_he_bss_color {
295 * struct ieee80211_he_bss_color - AP settings for BSS coloring
297 * @color: the current color.
298 * @disabled: is the feature disabled.
299 * @partial: define the AID equation.
301 struct ieee80211_he_bss_color {
308 * struct ieee80211_sta_ht_cap - STA's HT capabilities
310 * This structure describes most essential parameters needed
311 * to describe 802.11n HT capabilities for an STA.
313 * @ht_supported: is HT supported by the STA
314 * @cap: HT capabilities map as described in 802.11n spec
315 * @ampdu_factor: Maximum A-MPDU length factor
316 * @ampdu_density: Minimum A-MPDU spacing
317 * @mcs: Supported MCS rates
319 struct ieee80211_sta_ht_cap {
320 u16 cap; /* use IEEE80211_HT_CAP_ */
324 struct ieee80211_mcs_info mcs;
328 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
330 * This structure describes most essential parameters needed
331 * to describe 802.11ac VHT capabilities for an STA.
333 * @vht_supported: is VHT supported by the STA
334 * @cap: VHT capabilities map as described in 802.11ac spec
335 * @vht_mcs: Supported VHT MCS rates
337 struct ieee80211_sta_vht_cap {
339 u32 cap; /* use IEEE80211_VHT_CAP_ */
340 struct ieee80211_vht_mcs_info vht_mcs;
343 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
346 * struct ieee80211_sta_he_cap - STA's HE capabilities
348 * This structure describes most essential parameters needed
349 * to describe 802.11ax HE capabilities for a STA.
351 * @has_he: true iff HE data is valid.
352 * @he_cap_elem: Fixed portion of the HE capabilities element.
353 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
354 * @ppe_thres: Holds the PPE Thresholds data.
356 struct ieee80211_sta_he_cap {
358 struct ieee80211_he_cap_elem he_cap_elem;
359 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
360 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
364 * struct ieee80211_sband_iftype_data
366 * This structure encapsulates sband data that is relevant for the
367 * interface types defined in @types_mask. Each type in the
368 * @types_mask must be unique across all instances of iftype_data.
370 * @types_mask: interface types mask
371 * @he_cap: holds the HE capabilities
372 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
373 * 6 GHz band channel (and 0 may be valid value).
375 struct ieee80211_sband_iftype_data {
377 struct ieee80211_sta_he_cap he_cap;
378 struct ieee80211_he_6ghz_capa he_6ghz_capa;
382 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
384 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
385 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
386 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
387 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
388 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
389 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
390 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
391 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
393 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
395 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
397 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
398 * and 4.32GHz + 4.32GHz
399 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
400 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
402 enum ieee80211_edmg_bw_config {
403 IEEE80211_EDMG_BW_CONFIG_4 = 4,
404 IEEE80211_EDMG_BW_CONFIG_5 = 5,
405 IEEE80211_EDMG_BW_CONFIG_6 = 6,
406 IEEE80211_EDMG_BW_CONFIG_7 = 7,
407 IEEE80211_EDMG_BW_CONFIG_8 = 8,
408 IEEE80211_EDMG_BW_CONFIG_9 = 9,
409 IEEE80211_EDMG_BW_CONFIG_10 = 10,
410 IEEE80211_EDMG_BW_CONFIG_11 = 11,
411 IEEE80211_EDMG_BW_CONFIG_12 = 12,
412 IEEE80211_EDMG_BW_CONFIG_13 = 13,
413 IEEE80211_EDMG_BW_CONFIG_14 = 14,
414 IEEE80211_EDMG_BW_CONFIG_15 = 15,
418 * struct ieee80211_edmg - EDMG configuration
420 * This structure describes most essential parameters needed
421 * to describe 802.11ay EDMG configuration
423 * @channels: bitmap that indicates the 2.16 GHz channel(s)
424 * that are allowed to be used for transmissions.
425 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
426 * Set to 0 indicate EDMG not supported.
427 * @bw_config: Channel BW Configuration subfield encodes
428 * the allowed channel bandwidth configurations
430 struct ieee80211_edmg {
432 enum ieee80211_edmg_bw_config bw_config;
436 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
438 * This structure describes most essential parameters needed
439 * to describe 802.11ah S1G capabilities for a STA.
441 * @s1g_supported: is STA an S1G STA
442 * @cap: S1G capabilities information
443 * @nss_mcs: Supported NSS MCS set
445 struct ieee80211_sta_s1g_cap {
447 u8 cap[10]; /* use S1G_CAPAB_ */
452 * struct ieee80211_supported_band - frequency band definition
454 * This structure describes a frequency band a wiphy
455 * is able to operate in.
457 * @channels: Array of channels the hardware can operate with
459 * @band: the band this structure represents
460 * @n_channels: Number of channels in @channels
461 * @bitrates: Array of bitrates the hardware can operate with
462 * in this band. Must be sorted to give a valid "supported
463 * rates" IE, i.e. CCK rates first, then OFDM.
464 * @n_bitrates: Number of bitrates in @bitrates
465 * @ht_cap: HT capabilities in this band
466 * @vht_cap: VHT capabilities in this band
467 * @edmg_cap: EDMG capabilities in this band
468 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
469 * @n_iftype_data: number of iftype data entries
470 * @iftype_data: interface type data entries. Note that the bits in
471 * @types_mask inside this structure cannot overlap (i.e. only
472 * one occurrence of each type is allowed across all instances of
475 struct ieee80211_supported_band {
476 struct ieee80211_channel *channels;
477 struct ieee80211_rate *bitrates;
478 enum nl80211_band band;
481 struct ieee80211_sta_ht_cap ht_cap;
482 struct ieee80211_sta_vht_cap vht_cap;
483 struct ieee80211_sta_s1g_cap s1g_cap;
484 struct ieee80211_edmg edmg_cap;
486 const struct ieee80211_sband_iftype_data *iftype_data;
490 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
491 * @sband: the sband to search for the STA on
492 * @iftype: enum nl80211_iftype
494 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
496 static inline const struct ieee80211_sband_iftype_data *
497 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
502 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
505 for (i = 0; i < sband->n_iftype_data; i++) {
506 const struct ieee80211_sband_iftype_data *data =
507 &sband->iftype_data[i];
509 if (data->types_mask & BIT(iftype))
517 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
518 * @sband: the sband to search for the iftype on
519 * @iftype: enum nl80211_iftype
521 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
523 static inline const struct ieee80211_sta_he_cap *
524 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
527 const struct ieee80211_sband_iftype_data *data =
528 ieee80211_get_sband_iftype_data(sband, iftype);
530 if (data && data->he_cap.has_he)
531 return &data->he_cap;
537 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
538 * @sband: the sband to search for the STA on
540 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
542 static inline const struct ieee80211_sta_he_cap *
543 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
545 return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
549 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
550 * @sband: the sband to search for the STA on
551 * @iftype: the iftype to search for
553 * Return: the 6GHz capabilities
556 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
557 enum nl80211_iftype iftype)
559 const struct ieee80211_sband_iftype_data *data =
560 ieee80211_get_sband_iftype_data(sband, iftype);
562 if (WARN_ON(!data || !data->he_cap.has_he))
565 return data->he_6ghz_capa.capa;
569 * wiphy_read_of_freq_limits - read frequency limits from device tree
571 * @wiphy: the wireless device to get extra limits for
573 * Some devices may have extra limitations specified in DT. This may be useful
574 * for chipsets that normally support more bands but are limited due to board
575 * design (e.g. by antennas or external power amplifier).
577 * This function reads info from DT and uses it to *modify* channels (disable
578 * unavailable ones). It's usually a *bad* idea to use it in drivers with
579 * shared channel data as DT limitations are device specific. You should make
580 * sure to call it only if channels in wiphy are copied and can be modified
581 * without affecting other devices.
583 * As this function access device node it has to be called after set_wiphy_dev.
584 * It also modifies channels so they have to be set first.
585 * If using this helper, call it before wiphy_register().
588 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
589 #else /* CONFIG_OF */
590 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
593 #endif /* !CONFIG_OF */
597 * Wireless hardware/device configuration structures and methods
601 * DOC: Actions and configuration
603 * Each wireless device and each virtual interface offer a set of configuration
604 * operations and other actions that are invoked by userspace. Each of these
605 * actions is described in the operations structure, and the parameters these
606 * operations use are described separately.
608 * Additionally, some operations are asynchronous and expect to get status
609 * information via some functions that drivers need to call.
611 * Scanning and BSS list handling with its associated functionality is described
612 * in a separate chapter.
615 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
616 WLAN_USER_POSITION_LEN)
619 * struct vif_params - describes virtual interface parameters
620 * @flags: monitor interface flags, unchanged if 0, otherwise
621 * %MONITOR_FLAG_CHANGED will be set
622 * @use_4addr: use 4-address frames
623 * @macaddr: address to use for this virtual interface.
624 * If this parameter is set to zero address the driver may
625 * determine the address as needed.
626 * This feature is only fully supported by drivers that enable the
627 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
628 ** only p2p devices with specified MAC.
629 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
630 * belonging to that MU-MIMO groupID; %NULL if not changed
631 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
632 * MU-MIMO packets going to the specified station; %NULL if not changed
637 u8 macaddr[ETH_ALEN];
638 const u8 *vht_mumimo_groups;
639 const u8 *vht_mumimo_follow_addr;
643 * struct key_params - key information
645 * Information about a key
648 * @key_len: length of key material
649 * @cipher: cipher suite selector
650 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
651 * with the get_key() callback, must be in little endian,
652 * length given by @seq_len.
653 * @seq_len: length of @seq.
654 * @vlan_id: vlan_id for VLAN group key (if nonzero)
655 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
664 enum nl80211_key_mode mode;
668 * struct cfg80211_chan_def - channel definition
669 * @chan: the (control) channel
670 * @width: channel width
671 * @center_freq1: center frequency of first segment
672 * @center_freq2: center frequency of second segment
673 * (only with 80+80 MHz)
674 * @edmg: define the EDMG channels configuration.
675 * If edmg is requested (i.e. the .channels member is non-zero),
676 * chan will define the primary channel and all other
677 * parameters are ignored.
678 * @freq1_offset: offset from @center_freq1, in KHz
680 struct cfg80211_chan_def {
681 struct ieee80211_channel *chan;
682 enum nl80211_chan_width width;
685 struct ieee80211_edmg edmg;
690 * cfg80211_bitrate_mask - masks for bitrate control
692 struct cfg80211_bitrate_mask {
695 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
696 u16 vht_mcs[NL80211_VHT_NSS_MAX];
697 u16 he_mcs[NL80211_HE_NSS_MAX];
698 enum nl80211_txrate_gi gi;
699 enum nl80211_he_gi he_gi;
700 enum nl80211_he_ltf he_ltf;
701 } control[NUM_NL80211_BANDS];
706 * struct cfg80211_tid_cfg - TID specific configuration
707 * @config_override: Flag to notify driver to reset TID configuration
709 * @tids: bitmap of TIDs to modify
710 * @mask: bitmap of attributes indicating which parameter changed,
711 * similar to &nl80211_tid_config_supp.
712 * @noack: noack configuration value for the TID
713 * @retry_long: retry count value
714 * @retry_short: retry count value
715 * @ampdu: Enable/Disable MPDU aggregation
716 * @rtscts: Enable/Disable RTS/CTS
717 * @amsdu: Enable/Disable MSDU aggregation
718 * @txrate_type: Tx bitrate mask type
719 * @txrate_mask: Tx bitrate to be applied for the TID
721 struct cfg80211_tid_cfg {
722 bool config_override;
725 enum nl80211_tid_config noack;
726 u8 retry_long, retry_short;
727 enum nl80211_tid_config ampdu;
728 enum nl80211_tid_config rtscts;
729 enum nl80211_tid_config amsdu;
730 enum nl80211_tx_rate_setting txrate_type;
731 struct cfg80211_bitrate_mask txrate_mask;
735 * struct cfg80211_tid_config - TID configuration
736 * @peer: Station's MAC address
737 * @n_tid_conf: Number of TID specific configurations to be applied
738 * @tid_conf: Configuration change info
740 struct cfg80211_tid_config {
743 struct cfg80211_tid_cfg tid_conf[];
747 * cfg80211_get_chandef_type - return old channel type from chandef
748 * @chandef: the channel definition
750 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
751 * chandef, which must have a bandwidth allowing this conversion.
753 static inline enum nl80211_channel_type
754 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
756 switch (chandef->width) {
757 case NL80211_CHAN_WIDTH_20_NOHT:
758 return NL80211_CHAN_NO_HT;
759 case NL80211_CHAN_WIDTH_20:
760 return NL80211_CHAN_HT20;
761 case NL80211_CHAN_WIDTH_40:
762 if (chandef->center_freq1 > chandef->chan->center_freq)
763 return NL80211_CHAN_HT40PLUS;
764 return NL80211_CHAN_HT40MINUS;
767 return NL80211_CHAN_NO_HT;
772 * cfg80211_chandef_create - create channel definition using channel type
773 * @chandef: the channel definition struct to fill
774 * @channel: the control channel
775 * @chantype: the channel type
777 * Given a channel type, create a channel definition.
779 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
780 struct ieee80211_channel *channel,
781 enum nl80211_channel_type chantype);
784 * cfg80211_chandef_identical - check if two channel definitions are identical
785 * @chandef1: first channel definition
786 * @chandef2: second channel definition
788 * Return: %true if the channels defined by the channel definitions are
789 * identical, %false otherwise.
792 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
793 const struct cfg80211_chan_def *chandef2)
795 return (chandef1->chan == chandef2->chan &&
796 chandef1->width == chandef2->width &&
797 chandef1->center_freq1 == chandef2->center_freq1 &&
798 chandef1->freq1_offset == chandef2->freq1_offset &&
799 chandef1->center_freq2 == chandef2->center_freq2);
803 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
805 * @chandef: the channel definition
807 * Return: %true if EDMG defined, %false otherwise.
810 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
812 return chandef->edmg.channels || chandef->edmg.bw_config;
816 * cfg80211_chandef_compatible - check if two channel definitions are compatible
817 * @chandef1: first channel definition
818 * @chandef2: second channel definition
820 * Return: %NULL if the given channel definitions are incompatible,
821 * chandef1 or chandef2 otherwise.
823 const struct cfg80211_chan_def *
824 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
825 const struct cfg80211_chan_def *chandef2);
828 * cfg80211_chandef_valid - check if a channel definition is valid
829 * @chandef: the channel definition to check
830 * Return: %true if the channel definition is valid. %false otherwise.
832 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
835 * cfg80211_chandef_usable - check if secondary channels can be used
836 * @wiphy: the wiphy to validate against
837 * @chandef: the channel definition to check
838 * @prohibited_flags: the regulatory channel flags that must not be set
839 * Return: %true if secondary channels are usable. %false otherwise.
841 bool cfg80211_chandef_usable(struct wiphy *wiphy,
842 const struct cfg80211_chan_def *chandef,
843 u32 prohibited_flags);
846 * cfg80211_chandef_dfs_required - checks if radar detection is required
847 * @wiphy: the wiphy to validate against
848 * @chandef: the channel definition to check
849 * @iftype: the interface type as specified in &enum nl80211_iftype
851 * 1 if radar detection is required, 0 if it is not, < 0 on error
853 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
854 const struct cfg80211_chan_def *chandef,
855 enum nl80211_iftype iftype);
858 * ieee80211_chandef_rate_flags - returns rate flags for a channel
860 * In some channel types, not all rates may be used - for example CCK
861 * rates may not be used in 5/10 MHz channels.
863 * @chandef: channel definition for the channel
865 * Returns: rate flags which apply for this channel
867 static inline enum ieee80211_rate_flags
868 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
870 switch (chandef->width) {
871 case NL80211_CHAN_WIDTH_5:
872 return IEEE80211_RATE_SUPPORTS_5MHZ;
873 case NL80211_CHAN_WIDTH_10:
874 return IEEE80211_RATE_SUPPORTS_10MHZ;
882 * ieee80211_chandef_max_power - maximum transmission power for the chandef
884 * In some regulations, the transmit power may depend on the configured channel
885 * bandwidth which may be defined as dBm/MHz. This function returns the actual
886 * max_power for non-standard (20 MHz) channels.
888 * @chandef: channel definition for the channel
890 * Returns: maximum allowed transmission power in dBm for the chandef
893 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
895 switch (chandef->width) {
896 case NL80211_CHAN_WIDTH_5:
897 return min(chandef->chan->max_reg_power - 6,
898 chandef->chan->max_power);
899 case NL80211_CHAN_WIDTH_10:
900 return min(chandef->chan->max_reg_power - 3,
901 chandef->chan->max_power);
905 return chandef->chan->max_power;
909 * enum survey_info_flags - survey information flags
911 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
912 * @SURVEY_INFO_IN_USE: channel is currently being used
913 * @SURVEY_INFO_TIME: active time (in ms) was filled in
914 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
915 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
916 * @SURVEY_INFO_TIME_RX: receive time was filled in
917 * @SURVEY_INFO_TIME_TX: transmit time was filled in
918 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
919 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
921 * Used by the driver to indicate which info in &struct survey_info
922 * it has filled in during the get_survey().
924 enum survey_info_flags {
925 SURVEY_INFO_NOISE_DBM = BIT(0),
926 SURVEY_INFO_IN_USE = BIT(1),
927 SURVEY_INFO_TIME = BIT(2),
928 SURVEY_INFO_TIME_BUSY = BIT(3),
929 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
930 SURVEY_INFO_TIME_RX = BIT(5),
931 SURVEY_INFO_TIME_TX = BIT(6),
932 SURVEY_INFO_TIME_SCAN = BIT(7),
933 SURVEY_INFO_TIME_BSS_RX = BIT(8),
937 * struct survey_info - channel survey response
939 * @channel: the channel this survey record reports, may be %NULL for a single
940 * record to report global statistics
941 * @filled: bitflag of flags from &enum survey_info_flags
942 * @noise: channel noise in dBm. This and all following fields are
944 * @time: amount of time in ms the radio was turn on (on the channel)
945 * @time_busy: amount of time the primary channel was sensed busy
946 * @time_ext_busy: amount of time the extension channel was sensed busy
947 * @time_rx: amount of time the radio spent receiving data
948 * @time_tx: amount of time the radio spent transmitting data
949 * @time_scan: amount of time the radio spent for scanning
950 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
952 * Used by dump_survey() to report back per-channel survey information.
954 * This structure can later be expanded with things like
955 * channel duty cycle etc.
958 struct ieee80211_channel *channel;
970 #define CFG80211_MAX_WEP_KEYS 4
973 * struct cfg80211_crypto_settings - Crypto settings
974 * @wpa_versions: indicates which, if any, WPA versions are enabled
975 * (from enum nl80211_wpa_versions)
976 * @cipher_group: group key cipher suite (or 0 if unset)
977 * @n_ciphers_pairwise: number of AP supported unicast ciphers
978 * @ciphers_pairwise: unicast key cipher suites
979 * @n_akm_suites: number of AKM suites
980 * @akm_suites: AKM suites
981 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
982 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
983 * required to assume that the port is unauthorized until authorized by
984 * user space. Otherwise, port is marked authorized by default.
985 * @control_port_ethertype: the control port protocol that should be
986 * allowed through even on unauthorized ports
987 * @control_port_no_encrypt: TRUE to prevent encryption of control port
989 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
990 * port frames over NL80211 instead of the network interface.
991 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
993 * @wep_keys: static WEP keys, if not NULL points to an array of
994 * CFG80211_MAX_WEP_KEYS WEP keys
995 * @wep_tx_key: key index (0..3) of the default TX static WEP key
996 * @psk: PSK (for devices supporting 4-way-handshake offload)
997 * @sae_pwd: password for SAE authentication (for devices supporting SAE
999 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1001 struct cfg80211_crypto_settings {
1004 int n_ciphers_pairwise;
1005 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1007 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
1009 __be16 control_port_ethertype;
1010 bool control_port_no_encrypt;
1011 bool control_port_over_nl80211;
1012 bool control_port_no_preauth;
1013 struct key_params *wep_keys;
1021 * struct cfg80211_beacon_data - beacon data
1022 * @head: head portion of beacon (before TIM IE)
1023 * or %NULL if not changed
1024 * @tail: tail portion of beacon (after TIM IE)
1025 * or %NULL if not changed
1026 * @head_len: length of @head
1027 * @tail_len: length of @tail
1028 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1029 * @beacon_ies_len: length of beacon_ies in octets
1030 * @proberesp_ies: extra information element(s) to add into Probe Response
1032 * @proberesp_ies_len: length of proberesp_ies in octets
1033 * @assocresp_ies: extra information element(s) to add into (Re)Association
1034 * Response frames or %NULL
1035 * @assocresp_ies_len: length of assocresp_ies in octets
1036 * @probe_resp_len: length of probe response template (@probe_resp)
1037 * @probe_resp: probe response template (AP mode only)
1038 * @ftm_responder: enable FTM responder functionality; -1 for no change
1039 * (which also implies no change in LCI/civic location data)
1040 * @lci: Measurement Report element content, starting with Measurement Token
1041 * (measurement type 8)
1042 * @civicloc: Measurement Report element content, starting with Measurement
1043 * Token (measurement type 11)
1044 * @lci_len: LCI data length
1045 * @civicloc_len: Civic location data length
1047 struct cfg80211_beacon_data {
1048 const u8 *head, *tail;
1049 const u8 *beacon_ies;
1050 const u8 *proberesp_ies;
1051 const u8 *assocresp_ies;
1052 const u8 *probe_resp;
1057 size_t head_len, tail_len;
1058 size_t beacon_ies_len;
1059 size_t proberesp_ies_len;
1060 size_t assocresp_ies_len;
1061 size_t probe_resp_len;
1063 size_t civicloc_len;
1066 struct mac_address {
1071 * struct cfg80211_acl_data - Access control list data
1073 * @acl_policy: ACL policy to be applied on the station's
1074 * entry specified by mac_addr
1075 * @n_acl_entries: Number of MAC address entries passed
1076 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1078 struct cfg80211_acl_data {
1079 enum nl80211_acl_policy acl_policy;
1083 struct mac_address mac_addrs[];
1087 * struct cfg80211_fils_discovery - FILS discovery parameters from
1088 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1090 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1091 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1092 * @tmpl_len: Template length
1093 * @tmpl: Template data for FILS discovery frame including the action
1096 struct cfg80211_fils_discovery {
1104 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1105 * response parameters in 6GHz.
1107 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1108 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1110 * @tmpl_len: Template length
1111 * @tmpl: Template data for probe response
1113 struct cfg80211_unsol_bcast_probe_resp {
1120 * enum cfg80211_ap_settings_flags - AP settings flags
1122 * Used by cfg80211_ap_settings
1124 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
1126 enum cfg80211_ap_settings_flags {
1127 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
1131 * struct cfg80211_ap_settings - AP configuration
1133 * Used to configure an AP interface.
1135 * @chandef: defines the channel to use
1136 * @beacon: beacon data
1137 * @beacon_interval: beacon interval
1138 * @dtim_period: DTIM period
1139 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1141 * @ssid_len: length of @ssid
1142 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1143 * @crypto: crypto settings
1144 * @privacy: the BSS uses privacy
1145 * @auth_type: Authentication type (algorithm)
1146 * @smps_mode: SMPS mode
1147 * @inactivity_timeout: time in seconds to determine station's inactivity.
1148 * @p2p_ctwindow: P2P CT Window
1149 * @p2p_opp_ps: P2P opportunistic PS
1150 * @acl: ACL configuration used by the drivers which has support for
1151 * MAC address based access control
1152 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1154 * @beacon_rate: bitrate to be used for beacons
1155 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1156 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1157 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1158 * @ht_required: stations must support HT
1159 * @vht_required: stations must support VHT
1160 * @twt_responder: Enable Target Wait Time
1161 * @he_required: stations must support HE
1162 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1163 * @he_obss_pd: OBSS Packet Detection settings
1164 * @he_bss_color: BSS Color settings
1165 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1166 * @fils_discovery: FILS discovery transmission parameters
1167 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1169 struct cfg80211_ap_settings {
1170 struct cfg80211_chan_def chandef;
1172 struct cfg80211_beacon_data beacon;
1174 int beacon_interval, dtim_period;
1177 enum nl80211_hidden_ssid hidden_ssid;
1178 struct cfg80211_crypto_settings crypto;
1180 enum nl80211_auth_type auth_type;
1181 enum nl80211_smps_mode smps_mode;
1182 int inactivity_timeout;
1185 const struct cfg80211_acl_data *acl;
1187 struct cfg80211_bitrate_mask beacon_rate;
1189 const struct ieee80211_ht_cap *ht_cap;
1190 const struct ieee80211_vht_cap *vht_cap;
1191 const struct ieee80211_he_cap_elem *he_cap;
1192 const struct ieee80211_he_operation *he_oper;
1193 bool ht_required, vht_required, he_required;
1196 struct ieee80211_he_obss_pd he_obss_pd;
1197 struct cfg80211_he_bss_color he_bss_color;
1198 struct cfg80211_fils_discovery fils_discovery;
1199 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1203 * struct cfg80211_csa_settings - channel switch settings
1205 * Used for channel switch
1207 * @chandef: defines the channel to use after the switch
1208 * @beacon_csa: beacon data while performing the switch
1209 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1210 * @counter_offsets_presp: offsets of the counters within the probe response
1211 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1212 * @n_counter_offsets_presp: number of csa counters in the probe response
1213 * @beacon_after: beacon data to be used on the new channel
1214 * @radar_required: whether radar detection is required on the new channel
1215 * @block_tx: whether transmissions should be blocked while changing
1216 * @count: number of beacons until switch
1218 struct cfg80211_csa_settings {
1219 struct cfg80211_chan_def chandef;
1220 struct cfg80211_beacon_data beacon_csa;
1221 const u16 *counter_offsets_beacon;
1222 const u16 *counter_offsets_presp;
1223 unsigned int n_counter_offsets_beacon;
1224 unsigned int n_counter_offsets_presp;
1225 struct cfg80211_beacon_data beacon_after;
1226 bool radar_required;
1231 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1234 * struct iface_combination_params - input parameters for interface combinations
1236 * Used to pass interface combination parameters
1238 * @num_different_channels: the number of different channels we want
1239 * to use for verification
1240 * @radar_detect: a bitmap where each bit corresponds to a channel
1241 * width where radar detection is needed, as in the definition of
1242 * &struct ieee80211_iface_combination.@radar_detect_widths
1243 * @iftype_num: array with the number of interfaces of each interface
1244 * type. The index is the interface type as specified in &enum
1246 * @new_beacon_int: set this to the beacon interval of a new interface
1247 * that's not operating yet, if such is to be checked as part of
1250 struct iface_combination_params {
1251 int num_different_channels;
1253 int iftype_num[NUM_NL80211_IFTYPES];
1258 * enum station_parameters_apply_mask - station parameter values to apply
1259 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1260 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1261 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1263 * Not all station parameters have in-band "no change" signalling,
1264 * for those that don't these flags will are used.
1266 enum station_parameters_apply_mask {
1267 STATION_PARAM_APPLY_UAPSD = BIT(0),
1268 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1269 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1270 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1274 * struct sta_txpwr - station txpower configuration
1276 * Used to configure txpower for station.
1278 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1279 * is not provided, the default per-interface tx power setting will be
1280 * overriding. Driver should be picking up the lowest tx power, either tx
1281 * power per-interface or per-station.
1282 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1283 * will be less than or equal to specified from userspace, whereas if TPC
1284 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1285 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1290 enum nl80211_tx_power_setting type;
1294 * struct station_parameters - station parameters
1296 * Used to change and create a new station.
1298 * @vlan: vlan interface station should belong to
1299 * @supported_rates: supported rates in IEEE 802.11 format
1300 * (or NULL for no change)
1301 * @supported_rates_len: number of supported rates
1302 * @sta_flags_mask: station flags that changed
1303 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1304 * @sta_flags_set: station flags values
1305 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1306 * @listen_interval: listen interval or -1 for no change
1307 * @aid: AID or zero for no change
1308 * @vlan_id: VLAN ID for station (if nonzero)
1309 * @peer_aid: mesh peer AID or zero for no change
1310 * @plink_action: plink action to take
1311 * @plink_state: set the peer link state for a station
1312 * @ht_capa: HT capabilities of station
1313 * @vht_capa: VHT capabilities of station
1314 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1315 * as the AC bitmap in the QoS info field
1316 * @max_sp: max Service Period. same format as the MAX_SP in the
1317 * QoS info field (but already shifted down)
1318 * @sta_modify_mask: bitmap indicating which parameters changed
1319 * (for those that don't have a natural "no change" value),
1320 * see &enum station_parameters_apply_mask
1321 * @local_pm: local link-specific mesh power save mode (no change when set
1323 * @capability: station capability
1324 * @ext_capab: extended capabilities of the station
1325 * @ext_capab_len: number of extended capabilities
1326 * @supported_channels: supported channels in IEEE 802.11 format
1327 * @supported_channels_len: number of supported channels
1328 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1329 * @supported_oper_classes_len: number of supported operating classes
1330 * @opmode_notif: operating mode field from Operating Mode Notification
1331 * @opmode_notif_used: information if operating mode field is used
1332 * @support_p2p_ps: information if station supports P2P PS mechanism
1333 * @he_capa: HE capabilities of station
1334 * @he_capa_len: the length of the HE capabilities
1335 * @airtime_weight: airtime scheduler weight for this station
1336 * @txpwr: transmit power for an associated station
1337 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1339 struct station_parameters {
1340 const u8 *supported_rates;
1341 struct net_device *vlan;
1342 u32 sta_flags_mask, sta_flags_set;
1343 u32 sta_modify_mask;
1344 int listen_interval;
1348 u8 supported_rates_len;
1351 const struct ieee80211_ht_cap *ht_capa;
1352 const struct ieee80211_vht_cap *vht_capa;
1355 enum nl80211_mesh_power_mode local_pm;
1357 const u8 *ext_capab;
1359 const u8 *supported_channels;
1360 u8 supported_channels_len;
1361 const u8 *supported_oper_classes;
1362 u8 supported_oper_classes_len;
1364 bool opmode_notif_used;
1366 const struct ieee80211_he_cap_elem *he_capa;
1369 struct sta_txpwr txpwr;
1370 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1374 * struct station_del_parameters - station deletion parameters
1376 * Used to delete a station entry (or all stations).
1378 * @mac: MAC address of the station to remove or NULL to remove all stations
1379 * @subtype: Management frame subtype to use for indicating removal
1380 * (10 = Disassociation, 12 = Deauthentication)
1381 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1383 struct station_del_parameters {
1390 * enum cfg80211_station_type - the type of station being modified
1391 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1392 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1393 * unassociated (update properties for this type of client is permitted)
1394 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1395 * the AP MLME in the device
1396 * @CFG80211_STA_AP_STA: AP station on managed interface
1397 * @CFG80211_STA_IBSS: IBSS station
1398 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1399 * while TDLS setup is in progress, it moves out of this state when
1400 * being marked authorized; use this only if TDLS with external setup is
1402 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1403 * entry that is operating, has been marked authorized by userspace)
1404 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1405 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1407 enum cfg80211_station_type {
1408 CFG80211_STA_AP_CLIENT,
1409 CFG80211_STA_AP_CLIENT_UNASSOC,
1410 CFG80211_STA_AP_MLME_CLIENT,
1411 CFG80211_STA_AP_STA,
1413 CFG80211_STA_TDLS_PEER_SETUP,
1414 CFG80211_STA_TDLS_PEER_ACTIVE,
1415 CFG80211_STA_MESH_PEER_KERNEL,
1416 CFG80211_STA_MESH_PEER_USER,
1420 * cfg80211_check_station_change - validate parameter changes
1421 * @wiphy: the wiphy this operates on
1422 * @params: the new parameters for a station
1423 * @statype: the type of station being modified
1425 * Utility function for the @change_station driver method. Call this function
1426 * with the appropriate station type looking up the station (and checking that
1427 * it exists). It will verify whether the station change is acceptable, and if
1428 * not will return an error code. Note that it may modify the parameters for
1429 * backward compatibility reasons, so don't use them before calling this.
1431 int cfg80211_check_station_change(struct wiphy *wiphy,
1432 struct station_parameters *params,
1433 enum cfg80211_station_type statype);
1436 * enum station_info_rate_flags - bitrate info flags
1438 * Used by the driver to indicate the specific rate transmission
1439 * type for 802.11n transmissions.
1441 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1442 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1443 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1444 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1445 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1446 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1448 enum rate_info_flags {
1449 RATE_INFO_FLAGS_MCS = BIT(0),
1450 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1451 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1452 RATE_INFO_FLAGS_DMG = BIT(3),
1453 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1454 RATE_INFO_FLAGS_EDMG = BIT(5),
1458 * enum rate_info_bw - rate bandwidth information
1460 * Used by the driver to indicate the rate bandwidth.
1462 * @RATE_INFO_BW_5: 5 MHz bandwidth
1463 * @RATE_INFO_BW_10: 10 MHz bandwidth
1464 * @RATE_INFO_BW_20: 20 MHz bandwidth
1465 * @RATE_INFO_BW_40: 40 MHz bandwidth
1466 * @RATE_INFO_BW_80: 80 MHz bandwidth
1467 * @RATE_INFO_BW_160: 160 MHz bandwidth
1468 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1471 RATE_INFO_BW_20 = 0,
1481 * struct rate_info - bitrate information
1483 * Information about a receiving or transmitting bitrate
1485 * @flags: bitflag of flags from &enum rate_info_flags
1486 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1487 * @legacy: bitrate in 100kbit/s for 802.11abg
1488 * @nss: number of streams (VHT & HE only)
1489 * @bw: bandwidth (from &enum rate_info_bw)
1490 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1491 * @he_dcm: HE DCM value
1492 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1493 * only valid if bw is %RATE_INFO_BW_HE_RU)
1494 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1509 * enum station_info_rate_flags - bitrate info flags
1511 * Used by the driver to indicate the specific rate transmission
1512 * type for 802.11n transmissions.
1514 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1515 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1516 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1518 enum bss_param_flags {
1519 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1520 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1521 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1525 * struct sta_bss_parameters - BSS parameters for the attached station
1527 * Information about the currently associated BSS
1529 * @flags: bitflag of flags from &enum bss_param_flags
1530 * @dtim_period: DTIM period for the BSS
1531 * @beacon_interval: beacon interval
1533 struct sta_bss_parameters {
1536 u16 beacon_interval;
1540 * struct cfg80211_txq_stats - TXQ statistics for this TID
1541 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1542 * indicate the relevant values in this struct are filled
1543 * @backlog_bytes: total number of bytes currently backlogged
1544 * @backlog_packets: total number of packets currently backlogged
1545 * @flows: number of new flows seen
1546 * @drops: total number of packets dropped
1547 * @ecn_marks: total number of packets marked with ECN CE
1548 * @overlimit: number of drops due to queue space overflow
1549 * @overmemory: number of drops due to memory limit overflow
1550 * @collisions: number of hash collisions
1551 * @tx_bytes: total number of bytes dequeued
1552 * @tx_packets: total number of packets dequeued
1553 * @max_flows: maximum number of flows supported
1555 struct cfg80211_txq_stats {
1558 u32 backlog_packets;
1571 * struct cfg80211_tid_stats - per-TID statistics
1572 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1573 * indicate the relevant values in this struct are filled
1574 * @rx_msdu: number of received MSDUs
1575 * @tx_msdu: number of (attempted) transmitted MSDUs
1576 * @tx_msdu_retries: number of retries (not counting the first) for
1578 * @tx_msdu_failed: number of failed transmitted MSDUs
1579 * @txq_stats: TXQ statistics
1581 struct cfg80211_tid_stats {
1585 u64 tx_msdu_retries;
1587 struct cfg80211_txq_stats txq_stats;
1590 #define IEEE80211_MAX_CHAINS 4
1593 * struct station_info - station information
1595 * Station information filled by driver for get_station() and dump_station.
1597 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1598 * indicate the relevant values in this struct for them
1599 * @connected_time: time(in secs) since a station is last connected
1600 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1601 * @assoc_at: bootime (ns) of the last association
1602 * @rx_bytes: bytes (size of MPDUs) received from this station
1603 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1604 * @llid: mesh local link id
1605 * @plid: mesh peer link id
1606 * @plink_state: mesh peer link state
1607 * @signal: The signal strength, type depends on the wiphy's signal_type.
1608 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1609 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1610 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1611 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1612 * @chain_signal: per-chain signal strength of last received packet in dBm
1613 * @chain_signal_avg: per-chain signal strength average in dBm
1614 * @txrate: current unicast bitrate from this station
1615 * @rxrate: current unicast bitrate to this station
1616 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1617 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1618 * @tx_retries: cumulative retry counts (MPDUs)
1619 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1620 * @rx_dropped_misc: Dropped for un-specified reason.
1621 * @bss_param: current BSS parameters
1622 * @generation: generation number for nl80211 dumps.
1623 * This number should increase every time the list of stations
1624 * changes, i.e. when a station is added or removed, so that
1625 * userspace can tell whether it got a consistent snapshot.
1626 * @assoc_req_ies: IEs from (Re)Association Request.
1627 * This is used only when in AP mode with drivers that do not use
1628 * user space MLME/SME implementation. The information is provided for
1629 * the cfg80211_new_sta() calls to notify user space of the IEs.
1630 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1631 * @sta_flags: station flags mask & values
1632 * @beacon_loss_count: Number of times beacon loss event has triggered.
1633 * @t_offset: Time offset of the station relative to this host.
1634 * @local_pm: local mesh STA power save mode
1635 * @peer_pm: peer mesh STA power save mode
1636 * @nonpeer_pm: non-peer mesh STA power save mode
1637 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1638 * towards this station.
1639 * @rx_beacon: number of beacons received from this peer
1640 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1642 * @connected_to_gate: true if mesh STA has a path to mesh gate
1643 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1644 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1645 * @airtime_weight: current airtime scheduling weight
1646 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1647 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1648 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1649 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1650 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1652 * @rx_mpdu_count: number of MPDUs received from this station
1653 * @fcs_err_count: number of packets (MPDUs) received from this station with
1654 * an FCS error. This counter should be incremented only when TA of the
1655 * received packet with an FCS error matches the peer MAC address.
1656 * @airtime_link_metric: mesh airtime link metric.
1657 * @connected_to_as: true if mesh STA has a path to authentication server
1659 struct station_info {
1673 s8 chain_signal[IEEE80211_MAX_CHAINS];
1674 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1676 struct rate_info txrate;
1677 struct rate_info rxrate;
1682 u32 rx_dropped_misc;
1683 struct sta_bss_parameters bss_param;
1684 struct nl80211_sta_flag_update sta_flags;
1688 const u8 *assoc_req_ies;
1689 size_t assoc_req_ies_len;
1691 u32 beacon_loss_count;
1693 enum nl80211_mesh_power_mode local_pm;
1694 enum nl80211_mesh_power_mode peer_pm;
1695 enum nl80211_mesh_power_mode nonpeer_pm;
1697 u32 expected_throughput;
1702 u8 rx_beacon_signal_avg;
1703 u8 connected_to_gate;
1705 struct cfg80211_tid_stats *pertid;
1714 u32 airtime_link_metric;
1719 #if IS_ENABLED(CONFIG_CFG80211)
1721 * cfg80211_get_station - retrieve information about a given station
1722 * @dev: the device where the station is supposed to be connected to
1723 * @mac_addr: the mac address of the station of interest
1724 * @sinfo: pointer to the structure to fill with the information
1726 * Returns 0 on success and sinfo is filled with the available information
1727 * otherwise returns a negative error code and the content of sinfo has to be
1728 * considered undefined.
1730 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1731 struct station_info *sinfo);
1733 static inline int cfg80211_get_station(struct net_device *dev,
1735 struct station_info *sinfo)
1742 * enum monitor_flags - monitor flags
1744 * Monitor interface configuration flags. Note that these must be the bits
1745 * according to the nl80211 flags.
1747 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1748 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1749 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1750 * @MONITOR_FLAG_CONTROL: pass control frames
1751 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1752 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1753 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1755 enum monitor_flags {
1756 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1757 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1758 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1759 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1760 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1761 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1762 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1766 * enum mpath_info_flags - mesh path information flags
1768 * Used by the driver to indicate which info in &struct mpath_info it has filled
1769 * in during get_station() or dump_station().
1771 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1772 * @MPATH_INFO_SN: @sn filled
1773 * @MPATH_INFO_METRIC: @metric filled
1774 * @MPATH_INFO_EXPTIME: @exptime filled
1775 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1776 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1777 * @MPATH_INFO_FLAGS: @flags filled
1778 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1779 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1781 enum mpath_info_flags {
1782 MPATH_INFO_FRAME_QLEN = BIT(0),
1783 MPATH_INFO_SN = BIT(1),
1784 MPATH_INFO_METRIC = BIT(2),
1785 MPATH_INFO_EXPTIME = BIT(3),
1786 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1787 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1788 MPATH_INFO_FLAGS = BIT(6),
1789 MPATH_INFO_HOP_COUNT = BIT(7),
1790 MPATH_INFO_PATH_CHANGE = BIT(8),
1794 * struct mpath_info - mesh path information
1796 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1798 * @filled: bitfield of flags from &enum mpath_info_flags
1799 * @frame_qlen: number of queued frames for this destination
1800 * @sn: target sequence number
1801 * @metric: metric (cost) of this mesh path
1802 * @exptime: expiration time for the mesh path from now, in msecs
1803 * @flags: mesh path flags
1804 * @discovery_timeout: total mesh path discovery timeout, in msecs
1805 * @discovery_retries: mesh path discovery retries
1806 * @generation: generation number for nl80211 dumps.
1807 * This number should increase every time the list of mesh paths
1808 * changes, i.e. when a station is added or removed, so that
1809 * userspace can tell whether it got a consistent snapshot.
1810 * @hop_count: hops to destination
1811 * @path_change_count: total number of path changes to destination
1819 u32 discovery_timeout;
1820 u8 discovery_retries;
1823 u32 path_change_count;
1829 * struct bss_parameters - BSS parameters
1831 * Used to change BSS parameters (mainly for AP mode).
1833 * @use_cts_prot: Whether to use CTS protection
1834 * (0 = no, 1 = yes, -1 = do not change)
1835 * @use_short_preamble: Whether the use of short preambles is allowed
1836 * (0 = no, 1 = yes, -1 = do not change)
1837 * @use_short_slot_time: Whether the use of short slot time is allowed
1838 * (0 = no, 1 = yes, -1 = do not change)
1839 * @basic_rates: basic rates in IEEE 802.11 format
1840 * (or NULL for no change)
1841 * @basic_rates_len: number of basic rates
1842 * @ap_isolate: do not forward packets between connected stations
1843 * (0 = no, 1 = yes, -1 = do not change)
1844 * @ht_opmode: HT Operation mode
1845 * (u16 = opmode, -1 = do not change)
1846 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1847 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1849 struct bss_parameters {
1851 int use_short_preamble;
1852 int use_short_slot_time;
1853 const u8 *basic_rates;
1857 s8 p2p_ctwindow, p2p_opp_ps;
1861 * struct mesh_config - 802.11s mesh configuration
1863 * These parameters can be changed while the mesh is active.
1865 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1866 * by the Mesh Peering Open message
1867 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1868 * used by the Mesh Peering Open message
1869 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1870 * the mesh peering management to close a mesh peering
1871 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1873 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1874 * be sent to establish a new peer link instance in a mesh
1875 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1876 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1878 * @auto_open_plinks: whether we should automatically open peer links when we
1879 * detect compatible mesh peers
1880 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1881 * synchronize to for 11s default synchronization method
1882 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1883 * that an originator mesh STA can send to a particular path target
1884 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1885 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1886 * a path discovery in milliseconds
1887 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1888 * receiving a PREQ shall consider the forwarding information from the
1889 * root to be valid. (TU = time unit)
1890 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1891 * which a mesh STA can send only one action frame containing a PREQ
1893 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1894 * which a mesh STA can send only one Action frame containing a PERR
1896 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1897 * it takes for an HWMP information element to propagate across the mesh
1898 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1899 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1900 * announcements are transmitted
1901 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1902 * station has access to a broader network beyond the MBSS. (This is
1903 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1904 * only means that the station will announce others it's a mesh gate, but
1905 * not necessarily using the gate announcement protocol. Still keeping the
1906 * same nomenclature to be in sync with the spec)
1907 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1908 * entity (default is TRUE - forwarding entity)
1909 * @rssi_threshold: the threshold for average signal strength of candidate
1910 * station to establish a peer link
1911 * @ht_opmode: mesh HT protection mode
1913 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1914 * receiving a proactive PREQ shall consider the forwarding information to
1915 * the root mesh STA to be valid.
1917 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1918 * PREQs are transmitted.
1919 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1920 * during which a mesh STA can send only one Action frame containing
1921 * a PREQ element for root path confirmation.
1922 * @power_mode: The default mesh power save mode which will be the initial
1923 * setting for new peer links.
1924 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1925 * after transmitting its beacon.
1926 * @plink_timeout: If no tx activity is seen from a STA we've established
1927 * peering with for longer than this time (in seconds), then remove it
1928 * from the STA's list of peers. Default is 30 minutes.
1929 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1930 * connected to a mesh gate in mesh formation info. If false, the
1931 * value in mesh formation is determined by the presence of root paths
1932 * in the mesh path table
1933 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
1934 * for HWMP) if the destination is a direct neighbor. Note that this might
1935 * not be the optimal decision as a multi-hop route might be better. So
1936 * if using this setting you will likely also want to disable
1937 * dot11MeshForwarding and use another mesh routing protocol on top.
1939 struct mesh_config {
1940 u16 dot11MeshRetryTimeout;
1941 u16 dot11MeshConfirmTimeout;
1942 u16 dot11MeshHoldingTimeout;
1943 u16 dot11MeshMaxPeerLinks;
1944 u8 dot11MeshMaxRetries;
1947 bool auto_open_plinks;
1948 u32 dot11MeshNbrOffsetMaxNeighbor;
1949 u8 dot11MeshHWMPmaxPREQretries;
1950 u32 path_refresh_time;
1951 u16 min_discovery_timeout;
1952 u32 dot11MeshHWMPactivePathTimeout;
1953 u16 dot11MeshHWMPpreqMinInterval;
1954 u16 dot11MeshHWMPperrMinInterval;
1955 u16 dot11MeshHWMPnetDiameterTraversalTime;
1956 u8 dot11MeshHWMPRootMode;
1957 bool dot11MeshConnectedToMeshGate;
1958 bool dot11MeshConnectedToAuthServer;
1959 u16 dot11MeshHWMPRannInterval;
1960 bool dot11MeshGateAnnouncementProtocol;
1961 bool dot11MeshForwarding;
1964 u32 dot11MeshHWMPactivePathToRootTimeout;
1965 u16 dot11MeshHWMProotInterval;
1966 u16 dot11MeshHWMPconfirmationInterval;
1967 enum nl80211_mesh_power_mode power_mode;
1968 u16 dot11MeshAwakeWindowDuration;
1970 bool dot11MeshNolearn;
1974 * struct mesh_setup - 802.11s mesh setup configuration
1975 * @chandef: defines the channel to use
1976 * @mesh_id: the mesh ID
1977 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1978 * @sync_method: which synchronization method to use
1979 * @path_sel_proto: which path selection protocol to use
1980 * @path_metric: which metric to use
1981 * @auth_id: which authentication method this mesh is using
1982 * @ie: vendor information elements (optional)
1983 * @ie_len: length of vendor information elements
1984 * @is_authenticated: this mesh requires authentication
1985 * @is_secure: this mesh uses security
1986 * @user_mpm: userspace handles all MPM functions
1987 * @dtim_period: DTIM period to use
1988 * @beacon_interval: beacon interval to use
1989 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1990 * @basic_rates: basic rates to use when creating the mesh
1991 * @beacon_rate: bitrate to be used for beacons
1992 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1993 * changes the channel when a radar is detected. This is required
1994 * to operate on DFS channels.
1995 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1996 * port frames over NL80211 instead of the network interface.
1998 * These parameters are fixed when the mesh is created.
2001 struct cfg80211_chan_def chandef;
2010 bool is_authenticated;
2014 u16 beacon_interval;
2015 int mcast_rate[NUM_NL80211_BANDS];
2017 struct cfg80211_bitrate_mask beacon_rate;
2018 bool userspace_handles_dfs;
2019 bool control_port_over_nl80211;
2023 * struct ocb_setup - 802.11p OCB mode setup configuration
2024 * @chandef: defines the channel to use
2026 * These parameters are fixed when connecting to the network
2029 struct cfg80211_chan_def chandef;
2033 * struct ieee80211_txq_params - TX queue parameters
2034 * @ac: AC identifier
2035 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2036 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2038 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2040 * @aifs: Arbitration interframe space [0..255]
2042 struct ieee80211_txq_params {
2051 * DOC: Scanning and BSS list handling
2053 * The scanning process itself is fairly simple, but cfg80211 offers quite
2054 * a bit of helper functionality. To start a scan, the scan operation will
2055 * be invoked with a scan definition. This scan definition contains the
2056 * channels to scan, and the SSIDs to send probe requests for (including the
2057 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2058 * probe. Additionally, a scan request may contain extra information elements
2059 * that should be added to the probe request. The IEs are guaranteed to be
2060 * well-formed, and will not exceed the maximum length the driver advertised
2061 * in the wiphy structure.
2063 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2064 * it is responsible for maintaining the BSS list; the driver should not
2065 * maintain a list itself. For this notification, various functions exist.
2067 * Since drivers do not maintain a BSS list, there are also a number of
2068 * functions to search for a BSS and obtain information about it from the
2069 * BSS structure cfg80211 maintains. The BSS list is also made available
2074 * struct cfg80211_ssid - SSID description
2076 * @ssid_len: length of the ssid
2078 struct cfg80211_ssid {
2079 u8 ssid[IEEE80211_MAX_SSID_LEN];
2084 * struct cfg80211_scan_info - information about completed scan
2085 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2086 * wireless device that requested the scan is connected to. If this
2087 * information is not available, this field is left zero.
2088 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2089 * @aborted: set to true if the scan was aborted for any reason,
2090 * userspace will be notified of that
2092 struct cfg80211_scan_info {
2094 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2099 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2101 * @short_bssid: short ssid to scan for
2102 * @bssid: bssid to scan for
2103 * @channel_idx: idx of the channel in the channel array in the scan request
2104 * which the above info relvant to
2105 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2106 * @short_ssid_valid: short_ssid is valid and can be used
2107 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2108 * 20 TUs before starting to send probe requests.
2110 struct cfg80211_scan_6ghz_params {
2114 bool unsolicited_probe;
2115 bool short_ssid_valid;
2120 * struct cfg80211_scan_request - scan request description
2122 * @ssids: SSIDs to scan for (active scan only)
2123 * @n_ssids: number of SSIDs
2124 * @channels: channels to scan on.
2125 * @n_channels: total number of channels to scan
2126 * @scan_width: channel width for scanning
2127 * @ie: optional information element(s) to add into Probe Request or %NULL
2128 * @ie_len: length of ie in octets
2129 * @duration: how long to listen on each channel, in TUs. If
2130 * %duration_mandatory is not set, this is the maximum dwell time and
2131 * the actual dwell time may be shorter.
2132 * @duration_mandatory: if set, the scan duration must be as specified by the
2134 * @flags: bit field of flags controlling operation
2135 * @rates: bitmap of rates to advertise for each band
2136 * @wiphy: the wiphy this was for
2137 * @scan_start: time (in jiffies) when the scan started
2138 * @wdev: the wireless device to scan for
2139 * @info: (internal) information about completed scan
2140 * @notified: (internal) scan request was notified as done or aborted
2141 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2142 * @mac_addr: MAC address used with randomisation
2143 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2144 * are 0 in the mask should be randomised, bits that are 1 should
2145 * be taken from the @mac_addr
2146 * @scan_6ghz: relevant for split scan request only,
2147 * true if this is the second scan request
2148 * @n_6ghz_params: number of 6 GHz params
2149 * @scan_6ghz_params: 6 GHz params
2150 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2152 struct cfg80211_scan_request {
2153 struct cfg80211_ssid *ssids;
2156 enum nl80211_bss_scan_width scan_width;
2160 bool duration_mandatory;
2163 u32 rates[NUM_NL80211_BANDS];
2165 struct wireless_dev *wdev;
2167 u8 mac_addr[ETH_ALEN] __aligned(2);
2168 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2169 u8 bssid[ETH_ALEN] __aligned(2);
2172 struct wiphy *wiphy;
2173 unsigned long scan_start;
2174 struct cfg80211_scan_info info;
2179 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2182 struct ieee80211_channel *channels[];
2185 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2189 get_random_bytes(buf, ETH_ALEN);
2190 for (i = 0; i < ETH_ALEN; i++) {
2192 buf[i] |= addr[i] & mask[i];
2197 * struct cfg80211_match_set - sets of attributes to match
2199 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2200 * or no match (RSSI only)
2201 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2202 * or no match (RSSI only)
2203 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2204 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2205 * for filtering out scan results received. Drivers advertize this support
2206 * of band specific rssi based filtering through the feature capability
2207 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2208 * specific rssi thresholds take precedence over rssi_thold, if specified.
2209 * If not specified for any band, it will be assigned with rssi_thold of
2210 * corresponding matchset.
2212 struct cfg80211_match_set {
2213 struct cfg80211_ssid ssid;
2216 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2220 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2222 * @interval: interval between scheduled scan iterations. In seconds.
2223 * @iterations: number of scan iterations in this scan plan. Zero means
2225 * The last scan plan will always have this parameter set to zero,
2226 * all other scan plans will have a finite number of iterations.
2228 struct cfg80211_sched_scan_plan {
2234 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2236 * @band: band of BSS which should match for RSSI level adjustment.
2237 * @delta: value of RSSI level adjustment.
2239 struct cfg80211_bss_select_adjust {
2240 enum nl80211_band band;
2245 * struct cfg80211_sched_scan_request - scheduled scan request description
2247 * @reqid: identifies this request.
2248 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2249 * @n_ssids: number of SSIDs
2250 * @n_channels: total number of channels to scan
2251 * @scan_width: channel width for scanning
2252 * @ie: optional information element(s) to add into Probe Request or %NULL
2253 * @ie_len: length of ie in octets
2254 * @flags: bit field of flags controlling operation
2255 * @match_sets: sets of parameters to be matched for a scan result
2256 * entry to be considered valid and to be passed to the host
2257 * (others are filtered out).
2258 * If ommited, all results are passed.
2259 * @n_match_sets: number of match sets
2260 * @report_results: indicates that results were reported for this request
2261 * @wiphy: the wiphy this was for
2262 * @dev: the interface
2263 * @scan_start: start time of the scheduled scan
2264 * @channels: channels to scan
2265 * @min_rssi_thold: for drivers only supporting a single threshold, this
2266 * contains the minimum over all matchsets
2267 * @mac_addr: MAC address used with randomisation
2268 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2269 * are 0 in the mask should be randomised, bits that are 1 should
2270 * be taken from the @mac_addr
2271 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2272 * index must be executed first.
2273 * @n_scan_plans: number of scan plans, at least 1.
2274 * @rcu_head: RCU callback used to free the struct
2275 * @owner_nlportid: netlink portid of owner (if this should is a request
2276 * owned by a particular socket)
2277 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2278 * @list: for keeping list of requests.
2279 * @delay: delay in seconds to use before starting the first scan
2280 * cycle. The driver may ignore this parameter and start
2281 * immediately (or at any other time), if this feature is not
2283 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2284 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2285 * reporting in connected state to cases where a matching BSS is determined
2286 * to have better or slightly worse RSSI than the current connected BSS.
2287 * The relative RSSI threshold values are ignored in disconnected state.
2288 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2289 * to the specified band while deciding whether a better BSS is reported
2290 * using @relative_rssi. If delta is a negative number, the BSSs that
2291 * belong to the specified band will be penalized by delta dB in relative
2294 struct cfg80211_sched_scan_request {
2296 struct cfg80211_ssid *ssids;
2299 enum nl80211_bss_scan_width scan_width;
2303 struct cfg80211_match_set *match_sets;
2307 struct cfg80211_sched_scan_plan *scan_plans;
2310 u8 mac_addr[ETH_ALEN] __aligned(2);
2311 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2313 bool relative_rssi_set;
2315 struct cfg80211_bss_select_adjust rssi_adjust;
2318 struct wiphy *wiphy;
2319 struct net_device *dev;
2320 unsigned long scan_start;
2321 bool report_results;
2322 struct rcu_head rcu_head;
2325 struct list_head list;
2328 struct ieee80211_channel *channels[];
2332 * enum cfg80211_signal_type - signal type
2334 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2335 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2336 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2338 enum cfg80211_signal_type {
2339 CFG80211_SIGNAL_TYPE_NONE,
2340 CFG80211_SIGNAL_TYPE_MBM,
2341 CFG80211_SIGNAL_TYPE_UNSPEC,
2345 * struct cfg80211_inform_bss - BSS inform data
2346 * @chan: channel the frame was received on
2347 * @scan_width: scan width that was used
2348 * @signal: signal strength value, according to the wiphy's
2350 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2351 * received; should match the time when the frame was actually
2352 * received by the device (not just by the host, in case it was
2353 * buffered on the device) and be accurate to about 10ms.
2354 * If the frame isn't buffered, just passing the return value of
2355 * ktime_get_boottime_ns() is likely appropriate.
2356 * @parent_tsf: the time at the start of reception of the first octet of the
2357 * timestamp field of the frame. The time is the TSF of the BSS specified
2359 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2360 * the BSS that requested the scan in which the beacon/probe was received.
2361 * @chains: bitmask for filled values in @chain_signal.
2362 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2364 struct cfg80211_inform_bss {
2365 struct ieee80211_channel *chan;
2366 enum nl80211_bss_scan_width scan_width;
2370 u8 parent_bssid[ETH_ALEN] __aligned(2);
2372 s8 chain_signal[IEEE80211_MAX_CHAINS];
2376 * struct cfg80211_bss_ies - BSS entry IE data
2377 * @tsf: TSF contained in the frame that carried these IEs
2378 * @rcu_head: internal use, for freeing
2379 * @len: length of the IEs
2380 * @from_beacon: these IEs are known to come from a beacon
2383 struct cfg80211_bss_ies {
2385 struct rcu_head rcu_head;
2392 * struct cfg80211_bss - BSS description
2394 * This structure describes a BSS (which may also be a mesh network)
2395 * for use in scan results and similar.
2397 * @channel: channel this BSS is on
2398 * @scan_width: width of the control channel
2399 * @bssid: BSSID of the BSS
2400 * @beacon_interval: the beacon interval as from the frame
2401 * @capability: the capability field in host byte order
2402 * @ies: the information elements (Note that there is no guarantee that these
2403 * are well-formed!); this is a pointer to either the beacon_ies or
2404 * proberesp_ies depending on whether Probe Response frame has been
2405 * received. It is always non-%NULL.
2406 * @beacon_ies: the information elements from the last Beacon frame
2407 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2408 * own the beacon_ies, but they're just pointers to the ones from the
2409 * @hidden_beacon_bss struct)
2410 * @proberesp_ies: the information elements from the last Probe Response frame
2411 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2412 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2413 * that holds the beacon data. @beacon_ies is still valid, of course, and
2414 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2415 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2416 * non-transmitted one (multi-BSSID support)
2417 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2418 * (multi-BSSID support)
2419 * @signal: signal strength value (type depends on the wiphy's signal_type)
2420 * @chains: bitmask for filled values in @chain_signal.
2421 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2422 * @bssid_index: index in the multiple BSS set
2423 * @max_bssid_indicator: max number of members in the BSS set
2424 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2426 struct cfg80211_bss {
2427 struct ieee80211_channel *channel;
2428 enum nl80211_bss_scan_width scan_width;
2430 const struct cfg80211_bss_ies __rcu *ies;
2431 const struct cfg80211_bss_ies __rcu *beacon_ies;
2432 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2434 struct cfg80211_bss *hidden_beacon_bss;
2435 struct cfg80211_bss *transmitted_bss;
2436 struct list_head nontrans_list;
2440 u16 beacon_interval;
2445 s8 chain_signal[IEEE80211_MAX_CHAINS];
2448 u8 max_bssid_indicator;
2450 u8 priv[] __aligned(sizeof(void *));
2454 * ieee80211_bss_get_elem - find element with given ID
2455 * @bss: the bss to search
2456 * @id: the element ID
2458 * Note that the return value is an RCU-protected pointer, so
2459 * rcu_read_lock() must be held when calling this function.
2460 * Return: %NULL if not found.
2462 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2465 * ieee80211_bss_get_ie - find IE with given ID
2466 * @bss: the bss to search
2467 * @id: the element ID
2469 * Note that the return value is an RCU-protected pointer, so
2470 * rcu_read_lock() must be held when calling this function.
2471 * Return: %NULL if not found.
2473 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2475 return (void *)ieee80211_bss_get_elem(bss, id);
2480 * struct cfg80211_auth_request - Authentication request data
2482 * This structure provides information needed to complete IEEE 802.11
2485 * @bss: The BSS to authenticate with, the callee must obtain a reference
2486 * to it if it needs to keep it.
2487 * @auth_type: Authentication type (algorithm)
2488 * @ie: Extra IEs to add to Authentication frame or %NULL
2489 * @ie_len: Length of ie buffer in octets
2490 * @key_len: length of WEP key for shared key authentication
2491 * @key_idx: index of WEP key for shared key authentication
2492 * @key: WEP key for shared key authentication
2493 * @auth_data: Fields and elements in Authentication frames. This contains
2494 * the authentication frame body (non-IE and IE data), excluding the
2495 * Authentication algorithm number, i.e., starting at the Authentication
2496 * transaction sequence number field.
2497 * @auth_data_len: Length of auth_data buffer in octets
2499 struct cfg80211_auth_request {
2500 struct cfg80211_bss *bss;
2503 enum nl80211_auth_type auth_type;
2505 u8 key_len, key_idx;
2506 const u8 *auth_data;
2507 size_t auth_data_len;
2511 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2513 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2514 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2515 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2516 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2517 * authentication capability. Drivers can offload authentication to
2518 * userspace if this flag is set. Only applicable for cfg80211_connect()
2519 * request (connect callback).
2521 enum cfg80211_assoc_req_flags {
2522 ASSOC_REQ_DISABLE_HT = BIT(0),
2523 ASSOC_REQ_DISABLE_VHT = BIT(1),
2524 ASSOC_REQ_USE_RRM = BIT(2),
2525 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2529 * struct cfg80211_assoc_request - (Re)Association request data
2531 * This structure provides information needed to complete IEEE 802.11
2533 * @bss: The BSS to associate with. If the call is successful the driver is
2534 * given a reference that it must give back to cfg80211_send_rx_assoc()
2535 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2536 * association requests while already associating must be rejected.
2537 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2538 * @ie_len: Length of ie buffer in octets
2539 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2540 * @crypto: crypto settings
2541 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2542 * to indicate a request to reassociate within the ESS instead of a request
2543 * do the initial association with the ESS. When included, this is set to
2544 * the BSSID of the current association, i.e., to the value that is
2545 * included in the Current AP address field of the Reassociation Request
2547 * @flags: See &enum cfg80211_assoc_req_flags
2548 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2549 * will be used in ht_capa. Un-supported values will be ignored.
2550 * @ht_capa_mask: The bits of ht_capa which are to be used.
2551 * @vht_capa: VHT capability override
2552 * @vht_capa_mask: VHT capability mask indicating which fields to use
2553 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2554 * %NULL if FILS is not used.
2555 * @fils_kek_len: Length of fils_kek in octets
2556 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2557 * Request/Response frame or %NULL if FILS is not used. This field starts
2558 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2559 * @s1g_capa: S1G capability override
2560 * @s1g_capa_mask: S1G capability override mask
2562 struct cfg80211_assoc_request {
2563 struct cfg80211_bss *bss;
2564 const u8 *ie, *prev_bssid;
2566 struct cfg80211_crypto_settings crypto;
2569 struct ieee80211_ht_cap ht_capa;
2570 struct ieee80211_ht_cap ht_capa_mask;
2571 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2573 size_t fils_kek_len;
2574 const u8 *fils_nonces;
2575 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2579 * struct cfg80211_deauth_request - Deauthentication request data
2581 * This structure provides information needed to complete IEEE 802.11
2584 * @bssid: the BSSID of the BSS to deauthenticate from
2585 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2586 * @ie_len: Length of ie buffer in octets
2587 * @reason_code: The reason code for the deauthentication
2588 * @local_state_change: if set, change local state only and
2589 * do not set a deauth frame
2591 struct cfg80211_deauth_request {
2596 bool local_state_change;
2600 * struct cfg80211_disassoc_request - Disassociation request data
2602 * This structure provides information needed to complete IEEE 802.11
2605 * @bss: the BSS to disassociate from
2606 * @ie: Extra IEs to add to Disassociation frame or %NULL
2607 * @ie_len: Length of ie buffer in octets
2608 * @reason_code: The reason code for the disassociation
2609 * @local_state_change: This is a request for a local state only, i.e., no
2610 * Disassociation frame is to be transmitted.
2612 struct cfg80211_disassoc_request {
2613 struct cfg80211_bss *bss;
2617 bool local_state_change;
2621 * struct cfg80211_ibss_params - IBSS parameters
2623 * This structure defines the IBSS parameters for the join_ibss()
2626 * @ssid: The SSID, will always be non-null.
2627 * @ssid_len: The length of the SSID, will always be non-zero.
2628 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2629 * search for IBSSs with a different BSSID.
2630 * @chandef: defines the channel to use if no other IBSS to join can be found
2631 * @channel_fixed: The channel should be fixed -- do not search for
2632 * IBSSs to join on other channels.
2633 * @ie: information element(s) to include in the beacon
2634 * @ie_len: length of that
2635 * @beacon_interval: beacon interval to use
2636 * @privacy: this is a protected network, keys will be configured
2638 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2639 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2640 * required to assume that the port is unauthorized until authorized by
2641 * user space. Otherwise, port is marked authorized by default.
2642 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2643 * port frames over NL80211 instead of the network interface.
2644 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2645 * changes the channel when a radar is detected. This is required
2646 * to operate on DFS channels.
2647 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2648 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2649 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2650 * will be used in ht_capa. Un-supported values will be ignored.
2651 * @ht_capa_mask: The bits of ht_capa which are to be used.
2652 * @wep_keys: static WEP keys, if not NULL points to an array of
2653 * CFG80211_MAX_WEP_KEYS WEP keys
2654 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2656 struct cfg80211_ibss_params {
2659 struct cfg80211_chan_def chandef;
2661 u8 ssid_len, ie_len;
2662 u16 beacon_interval;
2667 bool control_port_over_nl80211;
2668 bool userspace_handles_dfs;
2669 int mcast_rate[NUM_NL80211_BANDS];
2670 struct ieee80211_ht_cap ht_capa;
2671 struct ieee80211_ht_cap ht_capa_mask;
2672 struct key_params *wep_keys;
2677 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2679 * @behaviour: requested BSS selection behaviour.
2680 * @param: parameters for requestion behaviour.
2681 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2682 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2684 struct cfg80211_bss_selection {
2685 enum nl80211_bss_select_attr behaviour;
2687 enum nl80211_band band_pref;
2688 struct cfg80211_bss_select_adjust adjust;
2693 * struct cfg80211_connect_params - Connection parameters
2695 * This structure provides information needed to complete IEEE 802.11
2696 * authentication and association.
2698 * @channel: The channel to use or %NULL if not specified (auto-select based
2700 * @channel_hint: The channel of the recommended BSS for initial connection or
2701 * %NULL if not specified
2702 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2704 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2705 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2706 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2709 * @ssid_len: Length of ssid in octets
2710 * @auth_type: Authentication type (algorithm)
2711 * @ie: IEs for association request
2712 * @ie_len: Length of assoc_ie in octets
2713 * @privacy: indicates whether privacy-enabled APs should be used
2714 * @mfp: indicate whether management frame protection is used
2715 * @crypto: crypto settings
2716 * @key_len: length of WEP key for shared key authentication
2717 * @key_idx: index of WEP key for shared key authentication
2718 * @key: WEP key for shared key authentication
2719 * @flags: See &enum cfg80211_assoc_req_flags
2720 * @bg_scan_period: Background scan period in seconds
2721 * or -1 to indicate that default value is to be used.
2722 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2723 * will be used in ht_capa. Un-supported values will be ignored.
2724 * @ht_capa_mask: The bits of ht_capa which are to be used.
2725 * @vht_capa: VHT Capability overrides
2726 * @vht_capa_mask: The bits of vht_capa which are to be used.
2727 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2729 * @bss_select: criteria to be used for BSS selection.
2730 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2731 * to indicate a request to reassociate within the ESS instead of a request
2732 * do the initial association with the ESS. When included, this is set to
2733 * the BSSID of the current association, i.e., to the value that is
2734 * included in the Current AP address field of the Reassociation Request
2736 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2737 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2739 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2740 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2741 * %NULL if not specified. This specifies the domain name of ER server and
2742 * is used to construct FILS wrapped data IE.
2743 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2744 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2745 * messages. This is also used to construct FILS wrapped data IE.
2746 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2747 * keys in FILS or %NULL if not specified.
2748 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2749 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2750 * offload of 4-way handshake.
2751 * @edmg: define the EDMG channels.
2752 * This may specify multiple channels and bonding options for the driver
2753 * to choose from, based on BSS configuration.
2755 struct cfg80211_connect_params {
2756 struct ieee80211_channel *channel;
2757 struct ieee80211_channel *channel_hint;
2759 const u8 *bssid_hint;
2762 enum nl80211_auth_type auth_type;
2766 enum nl80211_mfp mfp;
2767 struct cfg80211_crypto_settings crypto;
2769 u8 key_len, key_idx;
2772 struct ieee80211_ht_cap ht_capa;
2773 struct ieee80211_ht_cap ht_capa_mask;
2774 struct ieee80211_vht_cap vht_capa;
2775 struct ieee80211_vht_cap vht_capa_mask;
2777 struct cfg80211_bss_selection bss_select;
2778 const u8 *prev_bssid;
2779 const u8 *fils_erp_username;
2780 size_t fils_erp_username_len;
2781 const u8 *fils_erp_realm;
2782 size_t fils_erp_realm_len;
2783 u16 fils_erp_next_seq_num;
2784 const u8 *fils_erp_rrk;
2785 size_t fils_erp_rrk_len;
2787 struct ieee80211_edmg edmg;
2791 * enum cfg80211_connect_params_changed - Connection parameters being updated
2793 * This enum provides information of all connect parameters that
2794 * have to be updated as part of update_connect_params() call.
2796 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2797 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2798 * username, erp sequence number and rrk) are updated
2799 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2801 enum cfg80211_connect_params_changed {
2802 UPDATE_ASSOC_IES = BIT(0),
2803 UPDATE_FILS_ERP_INFO = BIT(1),
2804 UPDATE_AUTH_TYPE = BIT(2),
2808 * enum wiphy_params_flags - set_wiphy_params bitfield values
2809 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2810 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2811 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2812 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2813 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2814 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2815 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2816 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2817 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2819 enum wiphy_params_flags {
2820 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2821 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2822 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2823 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2824 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2825 WIPHY_PARAM_DYN_ACK = 1 << 5,
2826 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2827 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2828 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2831 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2833 /* The per TXQ device queue limit in airtime */
2834 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2835 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2837 /* The per interface airtime threshold to switch to lower queue limit */
2838 #define IEEE80211_AQL_THRESHOLD 24000
2841 * struct cfg80211_pmksa - PMK Security Association
2843 * This structure is passed to the set/del_pmksa() method for PMKSA
2846 * @bssid: The AP's BSSID (may be %NULL).
2847 * @pmkid: The identifier to refer a PMKSA.
2848 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2849 * derivation by a FILS STA. Otherwise, %NULL.
2850 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2851 * the hash algorithm used to generate this.
2852 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2853 * cache identifier (may be %NULL).
2854 * @ssid_len: Length of the @ssid in octets.
2855 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2856 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2858 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
2859 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
2860 * The configured PMKSA must not be used for PMKSA caching after
2861 * expiration and any keys derived from this PMK become invalid on
2862 * expiration, i.e., the current association must be dropped if the PMK
2863 * used for it expires.
2864 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
2865 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
2866 * Drivers are expected to trigger a full authentication instead of using
2867 * this PMKSA for caching when reassociating to a new BSS after this
2868 * threshold to generate a new PMK before the current one expires.
2870 struct cfg80211_pmksa {
2879 u8 pmk_reauth_threshold;
2883 * struct cfg80211_pkt_pattern - packet pattern
2884 * @mask: bitmask where to match pattern and where to ignore bytes,
2885 * one bit per byte, in same format as nl80211
2886 * @pattern: bytes to match where bitmask is 1
2887 * @pattern_len: length of pattern (in bytes)
2888 * @pkt_offset: packet offset (in bytes)
2890 * Internal note: @mask and @pattern are allocated in one chunk of
2891 * memory, free @mask only!
2893 struct cfg80211_pkt_pattern {
2894 const u8 *mask, *pattern;
2900 * struct cfg80211_wowlan_tcp - TCP connection parameters
2902 * @sock: (internal) socket for source port allocation
2903 * @src: source IP address
2904 * @dst: destination IP address
2905 * @dst_mac: destination MAC address
2906 * @src_port: source port
2907 * @dst_port: destination port
2908 * @payload_len: data payload length
2909 * @payload: data payload buffer
2910 * @payload_seq: payload sequence stamping configuration
2911 * @data_interval: interval at which to send data packets
2912 * @wake_len: wakeup payload match length
2913 * @wake_data: wakeup payload match data
2914 * @wake_mask: wakeup payload match mask
2915 * @tokens_size: length of the tokens buffer
2916 * @payload_tok: payload token usage configuration
2918 struct cfg80211_wowlan_tcp {
2919 struct socket *sock;
2921 u16 src_port, dst_port;
2922 u8 dst_mac[ETH_ALEN];
2925 struct nl80211_wowlan_tcp_data_seq payload_seq;
2928 const u8 *wake_data, *wake_mask;
2930 /* must be last, variable member */
2931 struct nl80211_wowlan_tcp_data_token payload_tok;
2935 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2937 * This structure defines the enabled WoWLAN triggers for the device.
2938 * @any: wake up on any activity -- special trigger if device continues
2939 * operating as normal during suspend
2940 * @disconnect: wake up if getting disconnected
2941 * @magic_pkt: wake up on receiving magic packet
2942 * @patterns: wake up on receiving packet matching a pattern
2943 * @n_patterns: number of patterns
2944 * @gtk_rekey_failure: wake up on GTK rekey failure
2945 * @eap_identity_req: wake up on EAP identity request packet
2946 * @four_way_handshake: wake up on 4-way handshake
2947 * @rfkill_release: wake up when rfkill is released
2948 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2949 * NULL if not configured.
2950 * @nd_config: configuration for the scan to be used for net detect wake.
2952 struct cfg80211_wowlan {
2953 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2954 eap_identity_req, four_way_handshake,
2956 struct cfg80211_pkt_pattern *patterns;
2957 struct cfg80211_wowlan_tcp *tcp;
2959 struct cfg80211_sched_scan_request *nd_config;
2963 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2965 * This structure defines coalesce rule for the device.
2966 * @delay: maximum coalescing delay in msecs.
2967 * @condition: condition for packet coalescence.
2968 * see &enum nl80211_coalesce_condition.
2969 * @patterns: array of packet patterns
2970 * @n_patterns: number of patterns
2972 struct cfg80211_coalesce_rules {
2974 enum nl80211_coalesce_condition condition;
2975 struct cfg80211_pkt_pattern *patterns;
2980 * struct cfg80211_coalesce - Packet coalescing settings
2982 * This structure defines coalescing settings.
2983 * @rules: array of coalesce rules
2984 * @n_rules: number of rules
2986 struct cfg80211_coalesce {
2987 struct cfg80211_coalesce_rules *rules;
2992 * struct cfg80211_wowlan_nd_match - information about the match
2994 * @ssid: SSID of the match that triggered the wake up
2995 * @n_channels: Number of channels where the match occurred. This
2996 * value may be zero if the driver can't report the channels.
2997 * @channels: center frequencies of the channels where a match
3000 struct cfg80211_wowlan_nd_match {
3001 struct cfg80211_ssid ssid;
3007 * struct cfg80211_wowlan_nd_info - net detect wake up information
3009 * @n_matches: Number of match information instances provided in
3010 * @matches. This value may be zero if the driver can't provide
3011 * match information.
3012 * @matches: Array of pointers to matches containing information about
3013 * the matches that triggered the wake up.
3015 struct cfg80211_wowlan_nd_info {
3017 struct cfg80211_wowlan_nd_match *matches[];
3021 * struct cfg80211_wowlan_wakeup - wakeup report
3022 * @disconnect: woke up by getting disconnected
3023 * @magic_pkt: woke up by receiving magic packet
3024 * @gtk_rekey_failure: woke up by GTK rekey failure
3025 * @eap_identity_req: woke up by EAP identity request packet
3026 * @four_way_handshake: woke up by 4-way handshake
3027 * @rfkill_release: woke up by rfkill being released
3028 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3029 * @packet_present_len: copied wakeup packet data
3030 * @packet_len: original wakeup packet length
3031 * @packet: The packet causing the wakeup, if any.
3032 * @packet_80211: For pattern match, magic packet and other data
3033 * frame triggers an 802.3 frame should be reported, for
3034 * disconnect due to deauth 802.11 frame. This indicates which
3036 * @tcp_match: TCP wakeup packet received
3037 * @tcp_connlost: TCP connection lost or failed to establish
3038 * @tcp_nomoretokens: TCP data ran out of tokens
3039 * @net_detect: if not %NULL, woke up because of net detect
3041 struct cfg80211_wowlan_wakeup {
3042 bool disconnect, magic_pkt, gtk_rekey_failure,
3043 eap_identity_req, four_way_handshake,
3044 rfkill_release, packet_80211,
3045 tcp_match, tcp_connlost, tcp_nomoretokens;
3047 u32 packet_present_len, packet_len;
3049 struct cfg80211_wowlan_nd_info *net_detect;
3053 * struct cfg80211_gtk_rekey_data - rekey data
3054 * @kek: key encryption key (@kek_len bytes)
3055 * @kck: key confirmation key (@kck_len bytes)
3056 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3057 * @kek_len: length of kek
3058 * @kck_len length of kck
3059 * @akm: akm (oui, id)
3061 struct cfg80211_gtk_rekey_data {
3062 const u8 *kek, *kck, *replay_ctr;
3064 u8 kek_len, kck_len;
3068 * struct cfg80211_update_ft_ies_params - FT IE Information
3070 * This structure provides information needed to update the fast transition IE
3072 * @md: The Mobility Domain ID, 2 Octet value
3073 * @ie: Fast Transition IEs
3074 * @ie_len: Length of ft_ie in octets
3076 struct cfg80211_update_ft_ies_params {
3083 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3085 * This structure provides information needed to transmit a mgmt frame
3087 * @chan: channel to use
3088 * @offchan: indicates wether off channel operation is required
3089 * @wait: duration for ROC
3090 * @buf: buffer to transmit
3091 * @len: buffer length
3092 * @no_cck: don't use cck rates for this frame
3093 * @dont_wait_for_ack: tells the low level not to wait for an ack
3094 * @n_csa_offsets: length of csa_offsets array
3095 * @csa_offsets: array of all the csa offsets in the frame
3097 struct cfg80211_mgmt_tx_params {
3098 struct ieee80211_channel *chan;
3104 bool dont_wait_for_ack;
3106 const u16 *csa_offsets;
3110 * struct cfg80211_dscp_exception - DSCP exception
3112 * @dscp: DSCP value that does not adhere to the user priority range definition
3113 * @up: user priority value to which the corresponding DSCP value belongs
3115 struct cfg80211_dscp_exception {
3121 * struct cfg80211_dscp_range - DSCP range definition for user priority
3123 * @low: lowest DSCP value of this user priority range, inclusive
3124 * @high: highest DSCP value of this user priority range, inclusive
3126 struct cfg80211_dscp_range {
3131 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3132 #define IEEE80211_QOS_MAP_MAX_EX 21
3133 #define IEEE80211_QOS_MAP_LEN_MIN 16
3134 #define IEEE80211_QOS_MAP_LEN_MAX \
3135 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3138 * struct cfg80211_qos_map - QoS Map Information
3140 * This struct defines the Interworking QoS map setting for DSCP values
3142 * @num_des: number of DSCP exceptions (0..21)
3143 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3144 * the user priority DSCP range definition
3145 * @up: DSCP range definition for a particular user priority
3147 struct cfg80211_qos_map {
3149 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3150 struct cfg80211_dscp_range up[8];
3154 * struct cfg80211_nan_conf - NAN configuration
3156 * This struct defines NAN configuration parameters
3158 * @master_pref: master preference (1 - 255)
3159 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3160 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3161 * (i.e. BIT(NL80211_BAND_2GHZ)).
3163 struct cfg80211_nan_conf {
3169 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3172 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3173 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3175 enum cfg80211_nan_conf_changes {
3176 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3177 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3181 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3183 * @filter: the content of the filter
3184 * @len: the length of the filter
3186 struct cfg80211_nan_func_filter {
3192 * struct cfg80211_nan_func - a NAN function
3194 * @type: &enum nl80211_nan_function_type
3195 * @service_id: the service ID of the function
3196 * @publish_type: &nl80211_nan_publish_type
3197 * @close_range: if true, the range should be limited. Threshold is
3198 * implementation specific.
3199 * @publish_bcast: if true, the solicited publish should be broadcasted
3200 * @subscribe_active: if true, the subscribe is active
3201 * @followup_id: the instance ID for follow up
3202 * @followup_reqid: the requestor instance ID for follow up
3203 * @followup_dest: MAC address of the recipient of the follow up
3204 * @ttl: time to live counter in DW.
3205 * @serv_spec_info: Service Specific Info
3206 * @serv_spec_info_len: Service Specific Info length
3207 * @srf_include: if true, SRF is inclusive
3208 * @srf_bf: Bloom Filter
3209 * @srf_bf_len: Bloom Filter length
3210 * @srf_bf_idx: Bloom Filter index
3211 * @srf_macs: SRF MAC addresses
3212 * @srf_num_macs: number of MAC addresses in SRF
3213 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3214 * @tx_filters: filters that should be transmitted in the SDF.
3215 * @num_rx_filters: length of &rx_filters.
3216 * @num_tx_filters: length of &tx_filters.
3217 * @instance_id: driver allocated id of the function.
3218 * @cookie: unique NAN function identifier.
3220 struct cfg80211_nan_func {
3221 enum nl80211_nan_function_type type;
3222 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3226 bool subscribe_active;
3229 struct mac_address followup_dest;
3231 const u8 *serv_spec_info;
3232 u8 serv_spec_info_len;
3237 struct mac_address *srf_macs;
3239 struct cfg80211_nan_func_filter *rx_filters;
3240 struct cfg80211_nan_func_filter *tx_filters;
3248 * struct cfg80211_pmk_conf - PMK configuration
3250 * @aa: authenticator address
3251 * @pmk_len: PMK length in bytes.
3252 * @pmk: the PMK material
3253 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3254 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3257 struct cfg80211_pmk_conf {
3261 const u8 *pmk_r0_name;
3265 * struct cfg80211_external_auth_params - Trigger External authentication.
3267 * Commonly used across the external auth request and event interfaces.
3269 * @action: action type / trigger for external authentication. Only significant
3270 * for the authentication request event interface (driver to user space).
3271 * @bssid: BSSID of the peer with which the authentication has
3272 * to happen. Used by both the authentication request event and
3273 * authentication response command interface.
3274 * @ssid: SSID of the AP. Used by both the authentication request event and
3275 * authentication response command interface.
3276 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3277 * authentication request event interface.
3278 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3279 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3280 * the real status code for failures. Used only for the authentication
3281 * response command interface (user space to driver).
3282 * @pmkid: The identifier to refer a PMKSA.
3284 struct cfg80211_external_auth_params {
3285 enum nl80211_external_auth_action action;
3286 u8 bssid[ETH_ALEN] __aligned(2);
3287 struct cfg80211_ssid ssid;
3288 unsigned int key_mgmt_suite;
3294 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3296 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3297 * indicate the relevant values in this struct for them
3298 * @success_num: number of FTM sessions in which all frames were successfully
3300 * @partial_num: number of FTM sessions in which part of frames were
3301 * successfully answered
3302 * @failed_num: number of failed FTM sessions
3303 * @asap_num: number of ASAP FTM sessions
3304 * @non_asap_num: number of non-ASAP FTM sessions
3305 * @total_duration_ms: total sessions durations - gives an indication
3306 * of how much time the responder was busy
3307 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3308 * initiators that didn't finish successfully the negotiation phase with
3310 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3311 * for a new scheduling although it already has scheduled FTM slot
3312 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3314 struct cfg80211_ftm_responder_stats {
3321 u64 total_duration_ms;
3322 u32 unknown_triggers_num;
3323 u32 reschedule_requests_num;
3324 u32 out_of_window_triggers_num;
3328 * struct cfg80211_pmsr_ftm_result - FTM result
3329 * @failure_reason: if this measurement failed (PMSR status is
3330 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3331 * reason than just "failure"
3332 * @burst_index: if reporting partial results, this is the index
3333 * in [0 .. num_bursts-1] of the burst that's being reported
3334 * @num_ftmr_attempts: number of FTM request frames transmitted
3335 * @num_ftmr_successes: number of FTM request frames acked
3336 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3337 * fill this to indicate in how many seconds a retry is deemed possible
3339 * @num_bursts_exp: actual number of bursts exponent negotiated
3340 * @burst_duration: actual burst duration negotiated
3341 * @ftms_per_burst: actual FTMs per burst negotiated
3342 * @lci_len: length of LCI information (if present)
3343 * @civicloc_len: length of civic location information (if present)
3344 * @lci: LCI data (may be %NULL)
3345 * @civicloc: civic location data (may be %NULL)
3346 * @rssi_avg: average RSSI over FTM action frames reported
3347 * @rssi_spread: spread of the RSSI over FTM action frames reported
3348 * @tx_rate: bitrate for transmitted FTM action frame response
3349 * @rx_rate: bitrate of received FTM action frame
3350 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3351 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3352 * the square root of the variance)
3353 * @rtt_spread: spread of the RTTs measured
3354 * @dist_avg: average of distances (mm) measured
3355 * (must have either this or @rtt_avg)
3356 * @dist_variance: variance of distances measured (see also @rtt_variance)
3357 * @dist_spread: spread of distances measured (see also @rtt_spread)
3358 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3359 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3360 * @rssi_avg_valid: @rssi_avg is valid
3361 * @rssi_spread_valid: @rssi_spread is valid
3362 * @tx_rate_valid: @tx_rate is valid
3363 * @rx_rate_valid: @rx_rate is valid
3364 * @rtt_avg_valid: @rtt_avg is valid
3365 * @rtt_variance_valid: @rtt_variance is valid
3366 * @rtt_spread_valid: @rtt_spread is valid
3367 * @dist_avg_valid: @dist_avg is valid
3368 * @dist_variance_valid: @dist_variance is valid
3369 * @dist_spread_valid: @dist_spread is valid
3371 struct cfg80211_pmsr_ftm_result {
3374 unsigned int lci_len;
3375 unsigned int civicloc_len;
3376 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3377 u32 num_ftmr_attempts, num_ftmr_successes;
3385 struct rate_info tx_rate, rx_rate;
3393 u16 num_ftmr_attempts_valid:1,
3394 num_ftmr_successes_valid:1,
3396 rssi_spread_valid:1,
3400 rtt_variance_valid:1,
3403 dist_variance_valid:1,
3404 dist_spread_valid:1;
3408 * struct cfg80211_pmsr_result - peer measurement result
3409 * @addr: address of the peer
3410 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3411 * measurement was made)
3412 * @ap_tsf: AP's TSF at measurement time
3413 * @status: status of the measurement
3414 * @final: if reporting partial results, mark this as the last one; if not
3415 * reporting partial results always set this flag
3416 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3417 * @type: type of the measurement reported, note that we only support reporting
3418 * one type at a time, but you can report multiple results separately and
3419 * they're all aggregated for userspace.
3421 struct cfg80211_pmsr_result {
3422 u64 host_time, ap_tsf;
3423 enum nl80211_peer_measurement_status status;
3430 enum nl80211_peer_measurement_type type;
3433 struct cfg80211_pmsr_ftm_result ftm;
3438 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3439 * @requested: indicates FTM is requested
3440 * @preamble: frame preamble to use
3441 * @burst_period: burst period to use
3442 * @asap: indicates to use ASAP mode
3443 * @num_bursts_exp: number of bursts exponent
3444 * @burst_duration: burst duration
3445 * @ftms_per_burst: number of FTMs per burst
3446 * @ftmr_retries: number of retries for FTM request
3447 * @request_lci: request LCI information
3448 * @request_civicloc: request civic location information
3449 * @trigger_based: use trigger based ranging for the measurement
3450 * If neither @trigger_based nor @non_trigger_based is set,
3451 * EDCA based ranging will be used.
3452 * @non_trigger_based: use non trigger based ranging for the measurement
3453 * If neither @trigger_based nor @non_trigger_based is set,
3454 * EDCA based ranging will be used.
3456 * See also nl80211 for the respective attribute documentation.
3458 struct cfg80211_pmsr_ftm_request_peer {
3459 enum nl80211_preamble preamble;
3466 non_trigger_based:1;
3474 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3475 * @addr: MAC address
3476 * @chandef: channel to use
3477 * @report_ap_tsf: report the associated AP's TSF
3478 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3480 struct cfg80211_pmsr_request_peer {
3482 struct cfg80211_chan_def chandef;
3484 struct cfg80211_pmsr_ftm_request_peer ftm;
3488 * struct cfg80211_pmsr_request - peer measurement request
3489 * @cookie: cookie, set by cfg80211
3490 * @nl_portid: netlink portid - used by cfg80211
3491 * @drv_data: driver data for this request, if required for aborting,
3492 * not otherwise freed or anything by cfg80211
3493 * @mac_addr: MAC address used for (randomised) request
3494 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3495 * are 0 in the mask should be randomised, bits that are 1 should
3496 * be taken from the @mac_addr
3497 * @list: used by cfg80211 to hold on to the request
3498 * @timeout: timeout (in milliseconds) for the whole operation, if
3499 * zero it means there's no timeout
3500 * @n_peers: number of peers to do measurements with
3501 * @peers: per-peer measurement request data
3503 struct cfg80211_pmsr_request {
3511 u8 mac_addr[ETH_ALEN] __aligned(2);
3512 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3514 struct list_head list;
3516 struct cfg80211_pmsr_request_peer peers[];
3520 * struct cfg80211_update_owe_info - OWE Information
3522 * This structure provides information needed for the drivers to offload OWE
3523 * (Opportunistic Wireless Encryption) processing to the user space.
3525 * Commonly used across update_owe_info request and event interfaces.
3527 * @peer: MAC address of the peer device for which the OWE processing
3529 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3530 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3531 * cannot give you the real status code for failures. Used only for
3532 * OWE update request command interface (user space to driver).
3533 * @ie: IEs obtained from the peer or constructed by the user space. These are
3534 * the IEs of the remote peer in the event from the host driver and
3535 * the constructed IEs by the user space in the request interface.
3536 * @ie_len: Length of IEs in octets.
3538 struct cfg80211_update_owe_info {
3539 u8 peer[ETH_ALEN] __aligned(2);
3546 * struct mgmt_frame_regs - management frame registrations data
3547 * @global_stypes: bitmap of management frame subtypes registered
3548 * for the entire device
3549 * @interface_stypes: bitmap of management frame subtypes registered
3550 * for the given interface
3551 * @global_mcast_rx: mcast RX is needed globally for these subtypes
3552 * @interface_mcast_stypes: mcast RX is needed on this interface
3553 * for these subtypes
3555 struct mgmt_frame_regs {
3556 u32 global_stypes, interface_stypes;
3557 u32 global_mcast_stypes, interface_mcast_stypes;
3561 * struct cfg80211_ops - backend description for wireless configuration
3563 * This struct is registered by fullmac card drivers and/or wireless stacks
3564 * in order to handle configuration requests on their interfaces.
3566 * All callbacks except where otherwise noted should return 0
3567 * on success or a negative error code.
3569 * All operations are currently invoked under rtnl for consistency with the
3570 * wireless extensions but this is subject to reevaluation as soon as this
3571 * code is used more widely and we have a first user without wext.
3573 * @suspend: wiphy device needs to be suspended. The variable @wow will
3574 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3575 * configured for the device.
3576 * @resume: wiphy device needs to be resumed
3577 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3578 * to call device_set_wakeup_enable() to enable/disable wakeup from
3581 * @add_virtual_intf: create a new virtual interface with the given name,
3582 * must set the struct wireless_dev's iftype. Beware: You must create
3583 * the new netdev in the wiphy's network namespace! Returns the struct
3584 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3585 * also set the address member in the wdev.
3587 * @del_virtual_intf: remove the virtual interface
3589 * @change_virtual_intf: change type/configuration of virtual interface,
3590 * keep the struct wireless_dev's iftype updated.
3592 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3593 * when adding a group key.
3595 * @get_key: get information about the key with the given parameters.
3596 * @mac_addr will be %NULL when requesting information for a group
3597 * key. All pointers given to the @callback function need not be valid
3598 * after it returns. This function should return an error if it is
3599 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3601 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3602 * and @key_index, return -ENOENT if the key doesn't exist.
3604 * @set_default_key: set the default key on an interface
3606 * @set_default_mgmt_key: set the default management frame key on an interface
3608 * @set_default_beacon_key: set the default Beacon frame key on an interface
3610 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3612 * @start_ap: Start acting in AP mode defined by the parameters.
3613 * @change_beacon: Change the beacon parameters for an access point mode
3614 * interface. This should reject the call when AP mode wasn't started.
3615 * @stop_ap: Stop being an AP, including stopping beaconing.
3617 * @add_station: Add a new station.
3618 * @del_station: Remove a station
3619 * @change_station: Modify a given station. Note that flags changes are not much
3620 * validated in cfg80211, in particular the auth/assoc/authorized flags
3621 * might come to the driver in invalid combinations -- make sure to check
3622 * them, also against the existing state! Drivers must call
3623 * cfg80211_check_station_change() to validate the information.
3624 * @get_station: get station information for the station identified by @mac
3625 * @dump_station: dump station callback -- resume dump at index @idx
3627 * @add_mpath: add a fixed mesh path
3628 * @del_mpath: delete a given mesh path
3629 * @change_mpath: change a given mesh path
3630 * @get_mpath: get a mesh path for the given parameters
3631 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3632 * @get_mpp: get a mesh proxy path for the given parameters
3633 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3634 * @join_mesh: join the mesh network with the specified parameters
3635 * (invoked with the wireless_dev mutex held)
3636 * @leave_mesh: leave the current mesh network
3637 * (invoked with the wireless_dev mutex held)
3639 * @get_mesh_config: Get the current mesh configuration
3641 * @update_mesh_config: Update mesh parameters on a running mesh.
3642 * The mask is a bitfield which tells us which parameters to
3643 * set, and which to leave alone.
3645 * @change_bss: Modify parameters for a given BSS.
3647 * @set_txq_params: Set TX queue parameters
3649 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3650 * as it doesn't implement join_mesh and needs to set the channel to
3651 * join the mesh instead.
3653 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3654 * interfaces are active this callback should reject the configuration.
3655 * If no interfaces are active or the device is down, the channel should
3656 * be stored for when a monitor interface becomes active.
3658 * @scan: Request to do a scan. If returning zero, the scan request is given
3659 * the driver, and will be valid until passed to cfg80211_scan_done().
3660 * For scan results, call cfg80211_inform_bss(); you can call this outside
3661 * the scan/scan_done bracket too.
3662 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3663 * indicate the status of the scan through cfg80211_scan_done().
3665 * @auth: Request to authenticate with the specified peer
3666 * (invoked with the wireless_dev mutex held)
3667 * @assoc: Request to (re)associate with the specified peer
3668 * (invoked with the wireless_dev mutex held)
3669 * @deauth: Request to deauthenticate from the specified peer
3670 * (invoked with the wireless_dev mutex held)
3671 * @disassoc: Request to disassociate from the specified peer
3672 * (invoked with the wireless_dev mutex held)
3674 * @connect: Connect to the ESS with the specified parameters. When connected,
3675 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3676 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3677 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3678 * from the AP or cfg80211_connect_timeout() if no frame with status code
3680 * The driver is allowed to roam to other BSSes within the ESS when the
3681 * other BSS matches the connect parameters. When such roaming is initiated
3682 * by the driver, the driver is expected to verify that the target matches
3683 * the configured security parameters and to use Reassociation Request
3684 * frame instead of Association Request frame.
3685 * The connect function can also be used to request the driver to perform a
3686 * specific roam when connected to an ESS. In that case, the prev_bssid
3687 * parameter is set to the BSSID of the currently associated BSS as an
3688 * indication of requesting reassociation.
3689 * In both the driver-initiated and new connect() call initiated roaming
3690 * cases, the result of roaming is indicated with a call to
3691 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3692 * @update_connect_params: Update the connect parameters while connected to a
3693 * BSS. The updated parameters can be used by driver/firmware for
3694 * subsequent BSS selection (roaming) decisions and to form the
3695 * Authentication/(Re)Association Request frames. This call does not
3696 * request an immediate disassociation or reassociation with the current
3697 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3698 * changed are defined in &enum cfg80211_connect_params_changed.
3699 * (invoked with the wireless_dev mutex held)
3700 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3701 * connection is in progress. Once done, call cfg80211_disconnected() in
3702 * case connection was already established (invoked with the
3703 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3705 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3706 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3708 * (invoked with the wireless_dev mutex held)
3709 * @leave_ibss: Leave the IBSS.
3710 * (invoked with the wireless_dev mutex held)
3712 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3715 * @set_wiphy_params: Notify that wiphy parameters have changed;
3716 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3717 * have changed. The actual parameter values are available in
3718 * struct wiphy. If returning an error, no value should be changed.
3720 * @set_tx_power: set the transmit power according to the parameters,
3721 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3722 * wdev may be %NULL if power was set for the wiphy, and will
3723 * always be %NULL unless the driver supports per-vif TX power
3724 * (as advertised by the nl80211 feature flag.)
3725 * @get_tx_power: store the current TX power into the dbm variable;
3726 * return 0 if successful
3728 * @set_wds_peer: set the WDS peer for a WDS interface
3730 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3731 * functions to adjust rfkill hw state
3733 * @dump_survey: get site survey information.
3735 * @remain_on_channel: Request the driver to remain awake on the specified
3736 * channel for the specified duration to complete an off-channel
3737 * operation (e.g., public action frame exchange). When the driver is
3738 * ready on the requested channel, it must indicate this with an event
3739 * notification by calling cfg80211_ready_on_channel().
3740 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3741 * This allows the operation to be terminated prior to timeout based on
3742 * the duration value.
3743 * @mgmt_tx: Transmit a management frame.
3744 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3745 * frame on another channel
3747 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3748 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3749 * used by the function, but 0 and 1 must not be touched. Additionally,
3750 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3751 * dump and return to userspace with an error, so be careful. If any data
3752 * was passed in from userspace then the data/len arguments will be present
3753 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3755 * @set_bitrate_mask: set the bitrate mask configuration
3757 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3758 * devices running firmwares capable of generating the (re) association
3759 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3760 * @del_pmksa: Delete a cached PMKID.
3761 * @flush_pmksa: Flush all cached PMKIDs.
3762 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3763 * allows the driver to adjust the dynamic ps timeout value.
3764 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3765 * After configuration, the driver should (soon) send an event indicating
3766 * the current level is above/below the configured threshold; this may
3767 * need some care when the configuration is changed (without first being
3769 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3770 * connection quality monitor. An event is to be sent only when the
3771 * signal level is found to be outside the two values. The driver should
3772 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3773 * If it is provided then there's no point providing @set_cqm_rssi_config.
3774 * @set_cqm_txe_config: Configure connection quality monitor TX error
3776 * @sched_scan_start: Tell the driver to start a scheduled scan.
3777 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3778 * given request id. This call must stop the scheduled scan and be ready
3779 * for starting a new one before it returns, i.e. @sched_scan_start may be
3780 * called immediately after that again and should not fail in that case.
3781 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3782 * stop (when this method returns 0).
3784 * @update_mgmt_frame_registrations: Notify the driver that management frame
3785 * registrations were updated. The callback is allowed to sleep.
3787 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3788 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3789 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3790 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3792 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3794 * @tdls_mgmt: Transmit a TDLS management frame.
3795 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3797 * @probe_client: probe an associated client, must return a cookie that it
3798 * later passes to cfg80211_probe_status().
3800 * @set_noack_map: Set the NoAck Map for the TIDs.
3802 * @get_channel: Get the current operating channel for the virtual interface.
3803 * For monitor interfaces, it should return %NULL unless there's a single
3804 * current monitoring channel.
3806 * @start_p2p_device: Start the given P2P device.
3807 * @stop_p2p_device: Stop the given P2P device.
3809 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3810 * Parameters include ACL policy, an array of MAC address of stations
3811 * and the number of MAC addresses. If there is already a list in driver
3812 * this new list replaces the existing one. Driver has to clear its ACL
3813 * when number of MAC addresses entries is passed as 0. Drivers which
3814 * advertise the support for MAC based ACL have to implement this callback.
3816 * @start_radar_detection: Start radar detection in the driver.
3818 * @end_cac: End running CAC, probably because a related CAC
3819 * was finished on another phy.
3821 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3822 * driver. If the SME is in the driver/firmware, this information can be
3823 * used in building Authentication and Reassociation Request frames.
3825 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3826 * for a given duration (milliseconds). The protocol is provided so the
3827 * driver can take the most appropriate actions.
3828 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3829 * reliability. This operation can not fail.
3830 * @set_coalesce: Set coalesce parameters.
3832 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3833 * responsible for veryfing if the switch is possible. Since this is
3834 * inherently tricky driver may decide to disconnect an interface later
3835 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3836 * everything. It should do it's best to verify requests and reject them
3837 * as soon as possible.
3839 * @set_qos_map: Set QoS mapping information to the driver
3841 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3842 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3843 * changes during the lifetime of the BSS.
3845 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3846 * with the given parameters; action frame exchange has been handled by
3847 * userspace so this just has to modify the TX path to take the TS into
3849 * If the admitted time is 0 just validate the parameters to make sure
3850 * the session can be created at all; it is valid to just always return
3851 * success for that but that may result in inefficient behaviour (handshake
3852 * with the peer followed by immediate teardown when the addition is later
3854 * @del_tx_ts: remove an existing TX TS
3856 * @join_ocb: join the OCB network with the specified parameters
3857 * (invoked with the wireless_dev mutex held)
3858 * @leave_ocb: leave the current OCB network
3859 * (invoked with the wireless_dev mutex held)
3861 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3862 * is responsible for continually initiating channel-switching operations
3863 * and returning to the base channel for communication with the AP.
3864 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3865 * peers must be on the base channel when the call completes.
3866 * @start_nan: Start the NAN interface.
3867 * @stop_nan: Stop the NAN interface.
3868 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3869 * On success @nan_func ownership is transferred to the driver and
3870 * it may access it outside of the scope of this function. The driver
3871 * should free the @nan_func when no longer needed by calling
3872 * cfg80211_free_nan_func().
3873 * On success the driver should assign an instance_id in the
3874 * provided @nan_func.
3875 * @del_nan_func: Delete a NAN function.
3876 * @nan_change_conf: changes NAN configuration. The changed parameters must
3877 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3878 * All other parameters must be ignored.
3880 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3882 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3883 * function should return phy stats, and interface stats otherwise.
3885 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3886 * If not deleted through @del_pmk the PMK remains valid until disconnect
3887 * upon which the driver should clear it.
3888 * (invoked with the wireless_dev mutex held)
3889 * @del_pmk: delete the previously configured PMK for the given authenticator.
3890 * (invoked with the wireless_dev mutex held)
3892 * @external_auth: indicates result of offloaded authentication processing from
3895 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3896 * tells the driver that the frame should not be encrypted.
3898 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3899 * Statistics should be cumulative, currently no way to reset is provided.
3900 * @start_pmsr: start peer measurement (e.g. FTM)
3901 * @abort_pmsr: abort peer measurement
3903 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3904 * but offloading OWE processing to the user space will get the updated
3905 * DH IE through this interface.
3907 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3908 * and overrule HWMP path selection algorithm.
3909 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
3910 * This callback may sleep.
3911 * @reset_tid_config: Reset TID specific configuration for the peer, for the
3912 * given TIDs. This callback may sleep.
3914 struct cfg80211_ops {
3915 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3916 int (*resume)(struct wiphy *wiphy);
3917 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3919 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3921 unsigned char name_assign_type,
3922 enum nl80211_iftype type,
3923 struct vif_params *params);
3924 int (*del_virtual_intf)(struct wiphy *wiphy,
3925 struct wireless_dev *wdev);
3926 int (*change_virtual_intf)(struct wiphy *wiphy,
3927 struct net_device *dev,
3928 enum nl80211_iftype type,
3929 struct vif_params *params);
3931 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3932 u8 key_index, bool pairwise, const u8 *mac_addr,
3933 struct key_params *params);
3934 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3935 u8 key_index, bool pairwise, const u8 *mac_addr,
3937 void (*callback)(void *cookie, struct key_params*));
3938 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3939 u8 key_index, bool pairwise, const u8 *mac_addr);
3940 int (*set_default_key)(struct wiphy *wiphy,
3941 struct net_device *netdev,
3942 u8 key_index, bool unicast, bool multicast);
3943 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3944 struct net_device *netdev,
3946 int (*set_default_beacon_key)(struct wiphy *wiphy,
3947 struct net_device *netdev,
3950 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3951 struct cfg80211_ap_settings *settings);
3952 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3953 struct cfg80211_beacon_data *info);
3954 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3957 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3959 struct station_parameters *params);
3960 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3961 struct station_del_parameters *params);
3962 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3964 struct station_parameters *params);
3965 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3966 const u8 *mac, struct station_info *sinfo);
3967 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3968 int idx, u8 *mac, struct station_info *sinfo);
3970 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3971 const u8 *dst, const u8 *next_hop);
3972 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3974 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3975 const u8 *dst, const u8 *next_hop);
3976 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3977 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3978 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3979 int idx, u8 *dst, u8 *next_hop,
3980 struct mpath_info *pinfo);
3981 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3982 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3983 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3984 int idx, u8 *dst, u8 *mpp,
3985 struct mpath_info *pinfo);
3986 int (*get_mesh_config)(struct wiphy *wiphy,
3987 struct net_device *dev,
3988 struct mesh_config *conf);
3989 int (*update_mesh_config)(struct wiphy *wiphy,
3990 struct net_device *dev, u32 mask,
3991 const struct mesh_config *nconf);
3992 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3993 const struct mesh_config *conf,
3994 const struct mesh_setup *setup);
3995 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3997 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3998 struct ocb_setup *setup);
3999 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4001 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4002 struct bss_parameters *params);
4004 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4005 struct ieee80211_txq_params *params);
4007 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4008 struct net_device *dev,
4009 struct ieee80211_channel *chan);
4011 int (*set_monitor_channel)(struct wiphy *wiphy,
4012 struct cfg80211_chan_def *chandef);
4014 int (*scan)(struct wiphy *wiphy,
4015 struct cfg80211_scan_request *request);
4016 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4018 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4019 struct cfg80211_auth_request *req);
4020 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4021 struct cfg80211_assoc_request *req);
4022 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4023 struct cfg80211_deauth_request *req);
4024 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4025 struct cfg80211_disassoc_request *req);
4027 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4028 struct cfg80211_connect_params *sme);
4029 int (*update_connect_params)(struct wiphy *wiphy,
4030 struct net_device *dev,
4031 struct cfg80211_connect_params *sme,
4033 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4036 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4037 struct cfg80211_ibss_params *params);
4038 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4040 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4041 int rate[NUM_NL80211_BANDS]);
4043 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4045 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4046 enum nl80211_tx_power_setting type, int mbm);
4047 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4050 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
4053 void (*rfkill_poll)(struct wiphy *wiphy);
4055 #ifdef CONFIG_NL80211_TESTMODE
4056 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4057 void *data, int len);
4058 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4059 struct netlink_callback *cb,
4060 void *data, int len);
4063 int (*set_bitrate_mask)(struct wiphy *wiphy,
4064 struct net_device *dev,
4066 const struct cfg80211_bitrate_mask *mask);
4068 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4069 int idx, struct survey_info *info);
4071 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4072 struct cfg80211_pmksa *pmksa);
4073 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4074 struct cfg80211_pmksa *pmksa);
4075 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4077 int (*remain_on_channel)(struct wiphy *wiphy,
4078 struct wireless_dev *wdev,
4079 struct ieee80211_channel *chan,
4080 unsigned int duration,
4082 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4083 struct wireless_dev *wdev,
4086 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4087 struct cfg80211_mgmt_tx_params *params,
4089 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4090 struct wireless_dev *wdev,
4093 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4094 bool enabled, int timeout);
4096 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4097 struct net_device *dev,
4098 s32 rssi_thold, u32 rssi_hyst);
4100 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4101 struct net_device *dev,
4102 s32 rssi_low, s32 rssi_high);
4104 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4105 struct net_device *dev,
4106 u32 rate, u32 pkts, u32 intvl);
4108 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4109 struct wireless_dev *wdev,
4110 struct mgmt_frame_regs *upd);
4112 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4113 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4115 int (*sched_scan_start)(struct wiphy *wiphy,
4116 struct net_device *dev,
4117 struct cfg80211_sched_scan_request *request);
4118 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4121 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4122 struct cfg80211_gtk_rekey_data *data);
4124 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4125 const u8 *peer, u8 action_code, u8 dialog_token,
4126 u16 status_code, u32 peer_capability,
4127 bool initiator, const u8 *buf, size_t len);
4128 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4129 const u8 *peer, enum nl80211_tdls_operation oper);
4131 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4132 const u8 *peer, u64 *cookie);
4134 int (*set_noack_map)(struct wiphy *wiphy,
4135 struct net_device *dev,
4138 int (*get_channel)(struct wiphy *wiphy,
4139 struct wireless_dev *wdev,
4140 struct cfg80211_chan_def *chandef);
4142 int (*start_p2p_device)(struct wiphy *wiphy,
4143 struct wireless_dev *wdev);
4144 void (*stop_p2p_device)(struct wiphy *wiphy,
4145 struct wireless_dev *wdev);
4147 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4148 const struct cfg80211_acl_data *params);
4150 int (*start_radar_detection)(struct wiphy *wiphy,
4151 struct net_device *dev,
4152 struct cfg80211_chan_def *chandef,
4154 void (*end_cac)(struct wiphy *wiphy,
4155 struct net_device *dev);
4156 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4157 struct cfg80211_update_ft_ies_params *ftie);
4158 int (*crit_proto_start)(struct wiphy *wiphy,
4159 struct wireless_dev *wdev,
4160 enum nl80211_crit_proto_id protocol,
4162 void (*crit_proto_stop)(struct wiphy *wiphy,
4163 struct wireless_dev *wdev);
4164 int (*set_coalesce)(struct wiphy *wiphy,
4165 struct cfg80211_coalesce *coalesce);
4167 int (*channel_switch)(struct wiphy *wiphy,
4168 struct net_device *dev,
4169 struct cfg80211_csa_settings *params);
4171 int (*set_qos_map)(struct wiphy *wiphy,
4172 struct net_device *dev,
4173 struct cfg80211_qos_map *qos_map);
4175 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4176 struct cfg80211_chan_def *chandef);
4178 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4179 u8 tsid, const u8 *peer, u8 user_prio,
4181 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4182 u8 tsid, const u8 *peer);
4184 int (*tdls_channel_switch)(struct wiphy *wiphy,
4185 struct net_device *dev,
4186 const u8 *addr, u8 oper_class,
4187 struct cfg80211_chan_def *chandef);
4188 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4189 struct net_device *dev,
4191 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4192 struct cfg80211_nan_conf *conf);
4193 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4194 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4195 struct cfg80211_nan_func *nan_func);
4196 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4198 int (*nan_change_conf)(struct wiphy *wiphy,
4199 struct wireless_dev *wdev,
4200 struct cfg80211_nan_conf *conf,
4203 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4204 struct net_device *dev,
4205 const bool enabled);
4207 int (*get_txq_stats)(struct wiphy *wiphy,
4208 struct wireless_dev *wdev,
4209 struct cfg80211_txq_stats *txqstats);
4211 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4212 const struct cfg80211_pmk_conf *conf);
4213 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4215 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4216 struct cfg80211_external_auth_params *params);
4218 int (*tx_control_port)(struct wiphy *wiphy,
4219 struct net_device *dev,
4220 const u8 *buf, size_t len,
4221 const u8 *dest, const __be16 proto,
4222 const bool noencrypt,
4225 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4226 struct net_device *dev,
4227 struct cfg80211_ftm_responder_stats *ftm_stats);
4229 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4230 struct cfg80211_pmsr_request *request);
4231 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4232 struct cfg80211_pmsr_request *request);
4233 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4234 struct cfg80211_update_owe_info *owe_info);
4235 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4236 const u8 *buf, size_t len);
4237 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4238 struct cfg80211_tid_config *tid_conf);
4239 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4240 const u8 *peer, u8 tids);
4244 * wireless hardware and networking interfaces structures
4245 * and registration/helper functions
4249 * enum wiphy_flags - wiphy capability flags
4251 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4252 * into two, first for legacy bands and second for UHB.
4253 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4255 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4256 * by default -- this flag will be set depending on the kernel's default
4257 * on wiphy_new(), but can be changed by the driver if it has a good
4258 * reason to override the default
4259 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4260 * on a VLAN interface). This flag also serves an extra purpose of
4261 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4262 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4263 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4264 * control port protocol ethertype. The device also honours the
4265 * control_port_no_encrypt flag.
4266 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4267 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4268 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4269 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4271 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4272 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4273 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4274 * link setup/discovery operations internally. Setup, discovery and
4275 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4276 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4277 * used for asking the driver/firmware to perform a TDLS operation.
4278 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4279 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4280 * when there are virtual interfaces in AP mode by calling
4281 * cfg80211_report_obss_beacon().
4282 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4283 * responds to probe-requests in hardware.
4284 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4285 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4286 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4287 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4288 * beaconing mode (AP, IBSS, Mesh, ...).
4289 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4290 * before connection.
4291 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4294 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4296 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4297 WIPHY_FLAG_NETNS_OK = BIT(3),
4298 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4299 WIPHY_FLAG_4ADDR_AP = BIT(5),
4300 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4301 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4302 WIPHY_FLAG_IBSS_RSN = BIT(8),
4303 WIPHY_FLAG_MESH_AUTH = BIT(10),
4304 /* use hole at 11 */
4305 /* use hole at 12 */
4306 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4307 WIPHY_FLAG_AP_UAPSD = BIT(14),
4308 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4309 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4310 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4311 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4312 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4313 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4314 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4315 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4316 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4317 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4321 * struct ieee80211_iface_limit - limit on certain interface types
4322 * @max: maximum number of interfaces of these types
4323 * @types: interface types (bits)
4325 struct ieee80211_iface_limit {
4331 * struct ieee80211_iface_combination - possible interface combination
4333 * With this structure the driver can describe which interface
4334 * combinations it supports concurrently.
4338 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4342 * struct ieee80211_iface_limit limits1[] = {
4343 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4344 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4346 * struct ieee80211_iface_combination combination1 = {
4347 * .limits = limits1,
4348 * .n_limits = ARRAY_SIZE(limits1),
4349 * .max_interfaces = 2,
4350 * .beacon_int_infra_match = true,
4354 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4358 * struct ieee80211_iface_limit limits2[] = {
4359 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4360 * BIT(NL80211_IFTYPE_P2P_GO), },
4362 * struct ieee80211_iface_combination combination2 = {
4363 * .limits = limits2,
4364 * .n_limits = ARRAY_SIZE(limits2),
4365 * .max_interfaces = 8,
4366 * .num_different_channels = 1,
4370 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4372 * This allows for an infrastructure connection and three P2P connections.
4376 * struct ieee80211_iface_limit limits3[] = {
4377 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4378 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4379 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4381 * struct ieee80211_iface_combination combination3 = {
4382 * .limits = limits3,
4383 * .n_limits = ARRAY_SIZE(limits3),
4384 * .max_interfaces = 4,
4385 * .num_different_channels = 2,
4389 struct ieee80211_iface_combination {
4392 * limits for the given interface types
4394 const struct ieee80211_iface_limit *limits;
4397 * @num_different_channels:
4398 * can use up to this many different channels
4400 u32 num_different_channels;
4404 * maximum number of interfaces in total allowed in this group
4410 * number of limitations
4415 * @beacon_int_infra_match:
4416 * In this combination, the beacon intervals between infrastructure
4417 * and AP types must match. This is required only in special cases.
4419 bool beacon_int_infra_match;
4422 * @radar_detect_widths:
4423 * bitmap of channel widths supported for radar detection
4425 u8 radar_detect_widths;
4428 * @radar_detect_regions:
4429 * bitmap of regions supported for radar detection
4431 u8 radar_detect_regions;
4434 * @beacon_int_min_gcd:
4435 * This interface combination supports different beacon intervals.
4438 * all beacon intervals for different interface must be same.
4440 * any beacon interval for the interface part of this combination AND
4441 * GCD of all beacon intervals from beaconing interfaces of this
4442 * combination must be greater or equal to this value.
4444 u32 beacon_int_min_gcd;
4447 struct ieee80211_txrx_stypes {
4452 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4453 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4454 * trigger that keeps the device operating as-is and
4455 * wakes up the host on any activity, for example a
4456 * received packet that passed filtering; note that the
4457 * packet should be preserved in that case
4458 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4460 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4461 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4462 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4463 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4464 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4465 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4466 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4468 enum wiphy_wowlan_support_flags {
4469 WIPHY_WOWLAN_ANY = BIT(0),
4470 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4471 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4472 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4473 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4474 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4475 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4476 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4477 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4480 struct wiphy_wowlan_tcp_support {
4481 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4482 u32 data_payload_max;
4483 u32 data_interval_max;
4484 u32 wake_payload_max;
4489 * struct wiphy_wowlan_support - WoWLAN support data
4490 * @flags: see &enum wiphy_wowlan_support_flags
4491 * @n_patterns: number of supported wakeup patterns
4492 * (see nl80211.h for the pattern definition)
4493 * @pattern_max_len: maximum length of each pattern
4494 * @pattern_min_len: minimum length of each pattern
4495 * @max_pkt_offset: maximum Rx packet offset
4496 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4497 * similar, but not necessarily identical, to max_match_sets for
4499 * See &struct cfg80211_sched_scan_request.@match_sets for more
4501 * @tcp: TCP wakeup support information
4503 struct wiphy_wowlan_support {
4506 int pattern_max_len;
4507 int pattern_min_len;
4509 int max_nd_match_sets;
4510 const struct wiphy_wowlan_tcp_support *tcp;
4514 * struct wiphy_coalesce_support - coalesce support data
4515 * @n_rules: maximum number of coalesce rules
4516 * @max_delay: maximum supported coalescing delay in msecs
4517 * @n_patterns: number of supported patterns in a rule
4518 * (see nl80211.h for the pattern definition)
4519 * @pattern_max_len: maximum length of each pattern
4520 * @pattern_min_len: minimum length of each pattern
4521 * @max_pkt_offset: maximum Rx packet offset
4523 struct wiphy_coalesce_support {
4527 int pattern_max_len;
4528 int pattern_min_len;
4533 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4534 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4535 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4536 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4537 * (must be combined with %_WDEV or %_NETDEV)
4539 enum wiphy_vendor_command_flags {
4540 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4541 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4542 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4546 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4548 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4549 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4550 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4553 enum wiphy_opmode_flag {
4554 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4555 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4556 STA_OPMODE_N_SS_CHANGED = BIT(2),
4560 * struct sta_opmode_info - Station's ht/vht operation mode information
4561 * @changed: contains value from &enum wiphy_opmode_flag
4562 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4563 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4564 * @rx_nss: new rx_nss value of a station
4567 struct sta_opmode_info {
4569 enum nl80211_smps_mode smps_mode;
4570 enum nl80211_chan_width bw;
4574 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4577 * struct wiphy_vendor_command - vendor command definition
4578 * @info: vendor command identifying information, as used in nl80211
4579 * @flags: flags, see &enum wiphy_vendor_command_flags
4580 * @doit: callback for the operation, note that wdev is %NULL if the
4581 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4582 * pointer may be %NULL if userspace provided no data at all
4583 * @dumpit: dump callback, for transferring bigger/multiple items. The
4584 * @storage points to cb->args[5], ie. is preserved over the multiple
4586 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4587 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4588 * attribute is just raw data (e.g. a firmware command).
4589 * @maxattr: highest attribute number in policy
4590 * It's recommended to not have the same sub command with both @doit and
4591 * @dumpit, so that userspace can assume certain ones are get and others
4592 * are used with dump requests.
4594 struct wiphy_vendor_command {
4595 struct nl80211_vendor_cmd_info info;
4597 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4598 const void *data, int data_len);
4599 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4600 struct sk_buff *skb, const void *data, int data_len,
4601 unsigned long *storage);
4602 const struct nla_policy *policy;
4603 unsigned int maxattr;
4607 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4608 * @iftype: interface type
4609 * @extended_capabilities: extended capabilities supported by the driver,
4610 * additional capabilities might be supported by userspace; these are the
4611 * 802.11 extended capabilities ("Extended Capabilities element") and are
4612 * in the same format as in the information element. See IEEE Std
4613 * 802.11-2012 8.4.2.29 for the defined fields.
4614 * @extended_capabilities_mask: mask of the valid values
4615 * @extended_capabilities_len: length of the extended capabilities
4617 struct wiphy_iftype_ext_capab {
4618 enum nl80211_iftype iftype;
4619 const u8 *extended_capabilities;
4620 const u8 *extended_capabilities_mask;
4621 u8 extended_capabilities_len;
4625 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4626 * @max_peers: maximum number of peers in a single measurement
4627 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4628 * @randomize_mac_addr: can randomize MAC address for measurement
4629 * @ftm.supported: FTM measurement is supported
4630 * @ftm.asap: ASAP-mode is supported
4631 * @ftm.non_asap: non-ASAP-mode is supported
4632 * @ftm.request_lci: can request LCI data
4633 * @ftm.request_civicloc: can request civic location data
4634 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4635 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4636 * @ftm.max_bursts_exponent: maximum burst exponent supported
4637 * (set to -1 if not limited; note that setting this will necessarily
4638 * forbid using the value 15 to let the responder pick)
4639 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4641 * @ftm.trigger_based: trigger based ranging measurement is supported
4642 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
4644 struct cfg80211_pmsr_capabilities {
4645 unsigned int max_peers;
4647 randomize_mac_addr:1;
4652 s8 max_bursts_exponent;
4653 u8 max_ftms_per_burst;
4660 non_trigger_based:1;
4665 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4666 * suites for interface types defined in @iftypes_mask. Each type in the
4667 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4669 * @iftypes_mask: bitmask of interfaces types
4670 * @akm_suites: points to an array of supported akm suites
4671 * @n_akm_suites: number of supported AKM suites
4673 struct wiphy_iftype_akm_suites {
4675 const u32 *akm_suites;
4680 * struct wiphy - wireless hardware description
4681 * @reg_notifier: the driver's regulatory notification callback,
4682 * note that if your driver uses wiphy_apply_custom_regulatory()
4683 * the reg_notifier's request can be passed as NULL
4684 * @regd: the driver's regulatory domain, if one was requested via
4685 * the regulatory_hint() API. This can be used by the driver
4686 * on the reg_notifier() if it chooses to ignore future
4687 * regulatory domain changes caused by other drivers.
4688 * @signal_type: signal type reported in &struct cfg80211_bss.
4689 * @cipher_suites: supported cipher suites
4690 * @n_cipher_suites: number of supported cipher suites
4691 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4692 * the supported AKMs not advertized for a specific interface type in
4693 * iftype_akm_suites.
4694 * @n_akm_suites: number of supported AKM suites
4695 * @iftype_akm_suites: array of supported akm suites info per interface type.
4696 * Note that the bits in @iftypes_mask inside this structure cannot
4697 * overlap (i.e. only one occurrence of each type is allowed across all
4698 * instances of iftype_akm_suites).
4699 * @num_iftype_akm_suites: number of interface types for which supported akm
4700 * suites are specified separately.
4701 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4702 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4703 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4704 * -1 = fragmentation disabled, only odd values >= 256 used
4705 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4706 * @_net: the network namespace this wiphy currently lives in
4707 * @perm_addr: permanent MAC address of this device
4708 * @addr_mask: If the device supports multiple MAC addresses by masking,
4709 * set this to a mask with variable bits set to 1, e.g. if the last
4710 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4711 * variable bits shall be determined by the interfaces added, with
4712 * interfaces not matching the mask being rejected to be brought up.
4713 * @n_addresses: number of addresses in @addresses.
4714 * @addresses: If the device has more than one address, set this pointer
4715 * to a list of addresses (6 bytes each). The first one will be used
4716 * by default for perm_addr. In this case, the mask should be set to
4717 * all-zeroes. In this case it is assumed that the device can handle
4718 * the same number of arbitrary MAC addresses.
4719 * @registered: protects ->resume and ->suspend sysfs callbacks against
4720 * unregister hardware
4721 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4722 * It will be renamed automatically on wiphy renames
4723 * @dev: (virtual) struct device for this wiphy. The item in
4724 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4726 * @wext: wireless extension handlers
4727 * @priv: driver private data (sized according to wiphy_new() parameter)
4728 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4729 * must be set by driver
4730 * @iface_combinations: Valid interface combinations array, should not
4731 * list single interface types.
4732 * @n_iface_combinations: number of entries in @iface_combinations array.
4733 * @software_iftypes: bitmask of software interface types, these are not
4734 * subject to any restrictions since they are purely managed in SW.
4735 * @flags: wiphy flags, see &enum wiphy_flags
4736 * @regulatory_flags: wiphy regulatory flags, see
4737 * &enum ieee80211_regulatory_flags
4738 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4739 * @ext_features: extended features advertised to nl80211, see
4740 * &enum nl80211_ext_feature_index.
4741 * @bss_priv_size: each BSS struct has private data allocated with it,
4742 * this variable determines its size
4743 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4745 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4746 * the device can run concurrently.
4747 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4748 * for in any given scheduled scan
4749 * @max_match_sets: maximum number of match sets the device can handle
4750 * when performing a scheduled scan, 0 if filtering is not
4752 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4753 * add to probe request frames transmitted during a scan, must not
4754 * include fixed IEs like supported rates
4755 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4757 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4758 * of iterations) for scheduled scan supported by the device.
4759 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4760 * single scan plan supported by the device.
4761 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4762 * scan plan supported by the device.
4763 * @coverage_class: current coverage class
4764 * @fw_version: firmware version for ethtool reporting
4765 * @hw_version: hardware version for ethtool reporting
4766 * @max_num_pmkids: maximum number of PMKIDs supported by device
4767 * @privid: a pointer that drivers can use to identify if an arbitrary
4768 * wiphy is theirs, e.g. in global notifiers
4769 * @bands: information about bands/channels supported by this device
4771 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4772 * transmitted through nl80211, points to an array indexed by interface
4775 * @available_antennas_tx: bitmap of antennas which are available to be
4776 * configured as TX antennas. Antenna configuration commands will be
4777 * rejected unless this or @available_antennas_rx is set.
4779 * @available_antennas_rx: bitmap of antennas which are available to be
4780 * configured as RX antennas. Antenna configuration commands will be
4781 * rejected unless this or @available_antennas_tx is set.
4783 * @probe_resp_offload:
4784 * Bitmap of supported protocols for probe response offloading.
4785 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4786 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4788 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4789 * may request, if implemented.
4791 * @wowlan: WoWLAN support information
4792 * @wowlan_config: current WoWLAN configuration; this should usually not be
4793 * used since access to it is necessarily racy, use the parameter passed
4794 * to the suspend() operation instead.
4796 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4797 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4798 * If null, then none can be over-ridden.
4799 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4800 * If null, then none can be over-ridden.
4802 * @wdev_list: the list of associated (virtual) interfaces; this list must
4803 * not be modified by the driver, but can be read with RTNL/RCU protection.
4805 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4808 * @extended_capabilities: extended capabilities supported by the driver,
4809 * additional capabilities might be supported by userspace; these are
4810 * the 802.11 extended capabilities ("Extended Capabilities element")
4811 * and are in the same format as in the information element. See
4812 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4813 * extended capabilities to be used if the capabilities are not specified
4814 * for a specific interface type in iftype_ext_capab.
4815 * @extended_capabilities_mask: mask of the valid values
4816 * @extended_capabilities_len: length of the extended capabilities
4817 * @iftype_ext_capab: array of extended capabilities per interface type
4818 * @num_iftype_ext_capab: number of interface types for which extended
4819 * capabilities are specified separately.
4820 * @coalesce: packet coalescing support information
4822 * @vendor_commands: array of vendor commands supported by the hardware
4823 * @n_vendor_commands: number of vendor commands
4824 * @vendor_events: array of vendor events supported by the hardware
4825 * @n_vendor_events: number of vendor events
4827 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4828 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4829 * driver is allowed to advertise a theoretical limit that it can reach in
4830 * some cases, but may not always reach.
4832 * @max_num_csa_counters: Number of supported csa_counters in beacons
4833 * and probe responses. This value should be set if the driver
4834 * wishes to limit the number of csa counters. Default (0) means
4836 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4837 * by the driver in the .connect() callback. The bit position maps to the
4838 * attribute indices defined in &enum nl80211_bss_select_attr.
4840 * @nan_supported_bands: bands supported by the device in NAN mode, a
4841 * bitmap of &enum nl80211_band values. For instance, for
4842 * NL80211_BAND_2GHZ, bit 0 would be set
4843 * (i.e. BIT(NL80211_BAND_2GHZ)).
4845 * @txq_limit: configuration of internal TX queue frame limit
4846 * @txq_memory_limit: configuration internal TX queue memory limit
4847 * @txq_quantum: configuration of internal TX queue scheduler quantum
4849 * @tx_queue_len: allow setting transmit queue len for drivers not using
4852 * @support_mbssid: can HW support association with nontransmitted AP
4853 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4854 * HE AP, in order to avoid compatibility issues.
4855 * @support_mbssid must be set for this to have any effect.
4857 * @pmsr_capa: peer measurement capabilities
4859 * @tid_config_support: describes the per-TID config support that the
4861 * @tid_config_support.vif: bitmap of attributes (configurations)
4862 * supported by the driver for each vif
4863 * @tid_config_support.peer: bitmap of attributes (configurations)
4864 * supported by the driver for each peer
4865 * @tid_config_support.max_retry: maximum supported retry count for
4866 * long/short retry configuration
4868 * @max_data_retry_count: maximum supported per TID retry count for
4869 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
4870 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
4873 /* assign these fields before you register the wiphy */
4875 u8 perm_addr[ETH_ALEN];
4876 u8 addr_mask[ETH_ALEN];
4878 struct mac_address *addresses;
4880 const struct ieee80211_txrx_stypes *mgmt_stypes;
4882 const struct ieee80211_iface_combination *iface_combinations;
4883 int n_iface_combinations;
4884 u16 software_iftypes;
4888 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4889 u16 interface_modes;
4891 u16 max_acl_mac_addrs;
4893 u32 flags, regulatory_flags, features;
4894 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4898 enum cfg80211_signal_type signal_type;
4902 u8 max_sched_scan_reqs;
4903 u8 max_sched_scan_ssids;
4905 u16 max_scan_ie_len;
4906 u16 max_sched_scan_ie_len;
4907 u32 max_sched_scan_plans;
4908 u32 max_sched_scan_plan_interval;
4909 u32 max_sched_scan_plan_iterations;
4911 int n_cipher_suites;
4912 const u32 *cipher_suites;
4915 const u32 *akm_suites;
4917 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
4918 unsigned int num_iftype_akm_suites;
4926 char fw_version[ETHTOOL_FWVERS_LEN];
4930 const struct wiphy_wowlan_support *wowlan;
4931 struct cfg80211_wowlan *wowlan_config;
4934 u16 max_remain_on_channel_duration;
4938 u32 available_antennas_tx;
4939 u32 available_antennas_rx;
4941 u32 probe_resp_offload;
4943 const u8 *extended_capabilities, *extended_capabilities_mask;
4944 u8 extended_capabilities_len;
4946 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4947 unsigned int num_iftype_ext_capab;
4951 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4953 void (*reg_notifier)(struct wiphy *wiphy,
4954 struct regulatory_request *request);
4956 /* fields below are read-only, assigned by cfg80211 */
4958 const struct ieee80211_regdomain __rcu *regd;
4964 struct dentry *debugfsdir;
4966 const struct ieee80211_ht_cap *ht_capa_mod_mask;
4967 const struct ieee80211_vht_cap *vht_capa_mod_mask;
4969 struct list_head wdev_list;
4971 possible_net_t _net;
4973 #ifdef CONFIG_CFG80211_WEXT
4974 const struct iw_handler_def *wext;
4977 const struct wiphy_coalesce_support *coalesce;
4979 const struct wiphy_vendor_command *vendor_commands;
4980 const struct nl80211_vendor_cmd_info *vendor_events;
4981 int n_vendor_commands, n_vendor_events;
4983 u16 max_ap_assoc_sta;
4985 u8 max_num_csa_counters;
4987 u32 bss_select_support;
4989 u8 nan_supported_bands;
4992 u32 txq_memory_limit;
4995 unsigned long tx_queue_len;
4997 u8 support_mbssid:1,
4998 support_only_he_mbssid:1;
5000 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5005 } tid_config_support;
5007 u8 max_data_retry_count;
5009 char priv[] __aligned(NETDEV_ALIGN);
5012 static inline struct net *wiphy_net(struct wiphy *wiphy)
5014 return read_pnet(&wiphy->_net);
5017 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5019 write_pnet(&wiphy->_net, net);
5023 * wiphy_priv - return priv from wiphy
5025 * @wiphy: the wiphy whose priv pointer to return
5026 * Return: The priv of @wiphy.
5028 static inline void *wiphy_priv(struct wiphy *wiphy)
5031 return &wiphy->priv;
5035 * priv_to_wiphy - return the wiphy containing the priv
5037 * @priv: a pointer previously returned by wiphy_priv
5038 * Return: The wiphy of @priv.
5040 static inline struct wiphy *priv_to_wiphy(void *priv)
5043 return container_of(priv, struct wiphy, priv);
5047 * set_wiphy_dev - set device pointer for wiphy
5049 * @wiphy: The wiphy whose device to bind
5050 * @dev: The device to parent it to
5052 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5054 wiphy->dev.parent = dev;
5058 * wiphy_dev - get wiphy dev pointer
5060 * @wiphy: The wiphy whose device struct to look up
5061 * Return: The dev of @wiphy.
5063 static inline struct device *wiphy_dev(struct wiphy *wiphy)
5065 return wiphy->dev.parent;
5069 * wiphy_name - get wiphy name
5071 * @wiphy: The wiphy whose name to return
5072 * Return: The name of @wiphy.
5074 static inline const char *wiphy_name(const struct wiphy *wiphy)
5076 return dev_name(&wiphy->dev);
5080 * wiphy_new_nm - create a new wiphy for use with cfg80211
5082 * @ops: The configuration operations for this device
5083 * @sizeof_priv: The size of the private area to allocate
5084 * @requested_name: Request a particular name.
5085 * NULL is valid value, and means use the default phy%d naming.
5087 * Create a new wiphy and associate the given operations with it.
5088 * @sizeof_priv bytes are allocated for private use.
5090 * Return: A pointer to the new wiphy. This pointer must be
5091 * assigned to each netdev's ieee80211_ptr for proper operation.
5093 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5094 const char *requested_name);
5097 * wiphy_new - create a new wiphy for use with cfg80211
5099 * @ops: The configuration operations for this device
5100 * @sizeof_priv: The size of the private area to allocate
5102 * Create a new wiphy and associate the given operations with it.
5103 * @sizeof_priv bytes are allocated for private use.
5105 * Return: A pointer to the new wiphy. This pointer must be
5106 * assigned to each netdev's ieee80211_ptr for proper operation.
5108 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5111 return wiphy_new_nm(ops, sizeof_priv, NULL);
5115 * wiphy_register - register a wiphy with cfg80211
5117 * @wiphy: The wiphy to register.
5119 * Return: A non-negative wiphy index or a negative error code.
5121 int wiphy_register(struct wiphy *wiphy);
5124 * wiphy_unregister - deregister a wiphy from cfg80211
5126 * @wiphy: The wiphy to unregister.
5128 * After this call, no more requests can be made with this priv
5129 * pointer, but the call may sleep to wait for an outstanding
5130 * request that is being handled.
5132 void wiphy_unregister(struct wiphy *wiphy);
5135 * wiphy_free - free wiphy
5137 * @wiphy: The wiphy to free
5139 void wiphy_free(struct wiphy *wiphy);
5141 /* internal structs */
5142 struct cfg80211_conn;
5143 struct cfg80211_internal_bss;
5144 struct cfg80211_cached_keys;
5145 struct cfg80211_cqm_config;
5148 * struct wireless_dev - wireless device state
5150 * For netdevs, this structure must be allocated by the driver
5151 * that uses the ieee80211_ptr field in struct net_device (this
5152 * is intentional so it can be allocated along with the netdev.)
5153 * It need not be registered then as netdev registration will
5154 * be intercepted by cfg80211 to see the new wireless device.
5156 * For non-netdev uses, it must also be allocated by the driver
5157 * in response to the cfg80211 callbacks that require it, as
5158 * there's no netdev registration in that case it may not be
5159 * allocated outside of callback operations that return it.
5161 * @wiphy: pointer to hardware description
5162 * @iftype: interface type
5163 * @list: (private) Used to collect the interfaces
5164 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5165 * @identifier: (private) Identifier used in nl80211 to identify this
5166 * wireless device if it has no netdev
5167 * @current_bss: (private) Used by the internal configuration code
5168 * @chandef: (private) Used by the internal configuration code to track
5169 * the user-set channel definition.
5170 * @preset_chandef: (private) Used by the internal configuration code to
5171 * track the channel to be used for AP later
5172 * @bssid: (private) Used by the internal configuration code
5173 * @ssid: (private) Used by the internal configuration code
5174 * @ssid_len: (private) Used by the internal configuration code
5175 * @mesh_id_len: (private) Used by the internal configuration code
5176 * @mesh_id_up_len: (private) Used by the internal configuration code
5177 * @wext: (private) Used by the internal wireless extensions compat code
5178 * @wext.ibss: (private) IBSS data part of wext handling
5179 * @wext.connect: (private) connection handling data
5180 * @wext.keys: (private) (WEP) key data
5181 * @wext.ie: (private) extra elements for association
5182 * @wext.ie_len: (private) length of extra elements
5183 * @wext.bssid: (private) selected network BSSID
5184 * @wext.ssid: (private) selected network SSID
5185 * @wext.default_key: (private) selected default key index
5186 * @wext.default_mgmt_key: (private) selected default management key index
5187 * @wext.prev_bssid: (private) previous BSSID for reassociation
5188 * @wext.prev_bssid_valid: (private) previous BSSID validity
5189 * @use_4addr: indicates 4addr mode is used on this interface, must be
5190 * set by driver (if supported) on add_interface BEFORE registering the
5191 * netdev and may otherwise be used by driver read-only, will be update
5192 * by cfg80211 on change_interface
5193 * @mgmt_registrations: list of registrations for management frames
5194 * @mgmt_registrations_lock: lock for the list
5195 * @mgmt_registrations_need_update: mgmt registrations were updated,
5196 * need to propagate the update to the driver
5197 * @mtx: mutex used to lock data in this struct, may be used by drivers
5198 * and some API functions require it held
5199 * @beacon_interval: beacon interval used on this device for transmitting
5200 * beacons, 0 when not valid
5201 * @address: The address for this device, valid only if @netdev is %NULL
5202 * @is_running: true if this is a non-netdev device that has been started, e.g.
5204 * @cac_started: true if DFS channel availability check has been started
5205 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5206 * @cac_time_ms: CAC time in ms
5207 * @ps: powersave mode is enabled
5208 * @ps_timeout: dynamic powersave timeout
5209 * @ap_unexpected_nlportid: (private) netlink port ID of application
5210 * registered for unexpected class 3 frames (AP mode)
5211 * @conn: (private) cfg80211 software SME connection state machine data
5212 * @connect_keys: (private) keys to set after connection is established
5213 * @conn_bss_type: connecting/connected BSS type
5214 * @conn_owner_nlportid: (private) connection owner socket port ID
5215 * @disconnect_wk: (private) auto-disconnect work
5216 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5217 * @ibss_fixed: (private) IBSS is using fixed BSSID
5218 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
5219 * @event_list: (private) list for internal event processing
5220 * @event_lock: (private) lock for event list
5221 * @owner_nlportid: (private) owner socket port ID
5222 * @nl_owner_dead: (private) owner socket went away
5223 * @cqm_config: (private) nl80211 RSSI monitor state
5224 * @pmsr_list: (private) peer measurement requests
5225 * @pmsr_lock: (private) peer measurements requests/results lock
5226 * @pmsr_free_wk: (private) peer measurements cleanup work
5227 * @unprot_beacon_reported: (private) timestamp of last
5228 * unprotected beacon report
5230 struct wireless_dev {
5231 struct wiphy *wiphy;
5232 enum nl80211_iftype iftype;
5234 /* the remainder of this struct should be private to cfg80211 */
5235 struct list_head list;
5236 struct net_device *netdev;
5240 struct list_head mgmt_registrations;
5241 spinlock_t mgmt_registrations_lock;
5242 u8 mgmt_registrations_need_update:1;
5246 bool use_4addr, is_running;
5248 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5250 /* currently used for IBSS and SME - might be rearranged later */
5251 u8 ssid[IEEE80211_MAX_SSID_LEN];
5252 u8 ssid_len, mesh_id_len, mesh_id_up_len;
5253 struct cfg80211_conn *conn;
5254 struct cfg80211_cached_keys *connect_keys;
5255 enum ieee80211_bss_type conn_bss_type;
5256 u32 conn_owner_nlportid;
5258 struct work_struct disconnect_wk;
5259 u8 disconnect_bssid[ETH_ALEN];
5261 struct list_head event_list;
5262 spinlock_t event_lock;
5264 struct cfg80211_internal_bss *current_bss; /* associated / joined */
5265 struct cfg80211_chan_def preset_chandef;
5266 struct cfg80211_chan_def chandef;
5269 bool ibss_dfs_possible;
5274 int beacon_interval;
5276 u32 ap_unexpected_nlportid;
5282 unsigned long cac_start_time;
5283 unsigned int cac_time_ms;
5285 #ifdef CONFIG_CFG80211_WEXT
5288 struct cfg80211_ibss_params ibss;
5289 struct cfg80211_connect_params connect;
5290 struct cfg80211_cached_keys *keys;
5294 u8 prev_bssid[ETH_ALEN];
5295 u8 ssid[IEEE80211_MAX_SSID_LEN];
5296 s8 default_key, default_mgmt_key;
5297 bool prev_bssid_valid;
5301 struct cfg80211_cqm_config *cqm_config;
5303 struct list_head pmsr_list;
5304 spinlock_t pmsr_lock;
5305 struct work_struct pmsr_free_wk;
5307 unsigned long unprot_beacon_reported;
5310 static inline u8 *wdev_address(struct wireless_dev *wdev)
5313 return wdev->netdev->dev_addr;
5314 return wdev->address;
5317 static inline bool wdev_running(struct wireless_dev *wdev)
5320 return netif_running(wdev->netdev);
5321 return wdev->is_running;
5325 * wdev_priv - return wiphy priv from wireless_dev
5327 * @wdev: The wireless device whose wiphy's priv pointer to return
5328 * Return: The wiphy priv of @wdev.
5330 static inline void *wdev_priv(struct wireless_dev *wdev)
5333 return wiphy_priv(wdev->wiphy);
5337 * DOC: Utility functions
5339 * cfg80211 offers a number of utility functions that can be useful.
5343 * ieee80211_channel_equal - compare two struct ieee80211_channel
5345 * @a: 1st struct ieee80211_channel
5346 * @b: 2nd struct ieee80211_channel
5347 * Return: true if center frequency of @a == @b
5350 ieee80211_channel_equal(struct ieee80211_channel *a,
5351 struct ieee80211_channel *b)
5353 return (a->center_freq == b->center_freq &&
5354 a->freq_offset == b->freq_offset);
5358 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5359 * @chan: struct ieee80211_channel to convert
5360 * Return: The corresponding frequency (in KHz)
5363 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5365 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5369 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5371 * Only allowed for band NL80211_BAND_S1GHZ
5373 * Return: The allowed channel width for this center_freq
5375 enum nl80211_chan_width
5376 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5379 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5380 * @chan: channel number
5381 * @band: band, necessary due to channel number overlap
5382 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5384 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5387 * ieee80211_channel_to_frequency - convert channel number to frequency
5388 * @chan: channel number
5389 * @band: band, necessary due to channel number overlap
5390 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5393 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5395 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5399 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5400 * @freq: center frequency in KHz
5401 * Return: The corresponding channel, or 0 if the conversion failed.
5403 int ieee80211_freq_khz_to_channel(u32 freq);
5406 * ieee80211_frequency_to_channel - convert frequency to channel number
5407 * @freq: center frequency in MHz
5408 * Return: The corresponding channel, or 0 if the conversion failed.
5411 ieee80211_frequency_to_channel(int freq)
5413 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5417 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5419 * @wiphy: the struct wiphy to get the channel for
5420 * @freq: the center frequency (in KHz) of the channel
5421 * Return: The channel struct from @wiphy at @freq.
5423 struct ieee80211_channel *
5424 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5427 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5429 * @wiphy: the struct wiphy to get the channel for
5430 * @freq: the center frequency (in MHz) of the channel
5431 * Return: The channel struct from @wiphy at @freq.
5433 static inline struct ieee80211_channel *
5434 ieee80211_get_channel(struct wiphy *wiphy, int freq)
5436 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5440 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5441 * @chan: control channel to check
5443 * The Preferred Scanning Channels (PSC) are defined in
5444 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5446 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
5448 if (chan->band != NL80211_BAND_6GHZ)
5451 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
5455 * ieee80211_get_response_rate - get basic rate for a given rate
5457 * @sband: the band to look for rates in
5458 * @basic_rates: bitmap of basic rates
5459 * @bitrate: the bitrate for which to find the basic rate
5461 * Return: The basic rate corresponding to a given bitrate, that
5462 * is the next lower bitrate contained in the basic rate map,
5463 * which is, for this function, given as a bitmap of indices of
5464 * rates in the band's bitrate table.
5466 struct ieee80211_rate *
5467 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5468 u32 basic_rates, int bitrate);
5471 * ieee80211_mandatory_rates - get mandatory rates for a given band
5472 * @sband: the band to look for rates in
5473 * @scan_width: width of the control channel
5475 * This function returns a bitmap of the mandatory rates for the given
5476 * band, bits are set according to the rate position in the bitrates array.
5478 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5479 enum nl80211_bss_scan_width scan_width);
5482 * Radiotap parsing functions -- for controlled injection support
5484 * Implemented in net/wireless/radiotap.c
5485 * Documentation in Documentation/networking/radiotap-headers.rst
5488 struct radiotap_align_size {
5489 uint8_t align:4, size:4;
5492 struct ieee80211_radiotap_namespace {
5493 const struct radiotap_align_size *align_size;
5499 struct ieee80211_radiotap_vendor_namespaces {
5500 const struct ieee80211_radiotap_namespace *ns;
5505 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5506 * @this_arg_index: index of current arg, valid after each successful call
5507 * to ieee80211_radiotap_iterator_next()
5508 * @this_arg: pointer to current radiotap arg; it is valid after each
5509 * call to ieee80211_radiotap_iterator_next() but also after
5510 * ieee80211_radiotap_iterator_init() where it will point to
5511 * the beginning of the actual data portion
5512 * @this_arg_size: length of the current arg, for convenience
5513 * @current_namespace: pointer to the current namespace definition
5514 * (or internally %NULL if the current namespace is unknown)
5515 * @is_radiotap_ns: indicates whether the current namespace is the default
5516 * radiotap namespace or not
5518 * @_rtheader: pointer to the radiotap header we are walking through
5519 * @_max_length: length of radiotap header in cpu byte ordering
5520 * @_arg_index: next argument index
5521 * @_arg: next argument pointer
5522 * @_next_bitmap: internal pointer to next present u32
5523 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5524 * @_vns: vendor namespace definitions
5525 * @_next_ns_data: beginning of the next namespace's data
5526 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5529 * Describes the radiotap parser state. Fields prefixed with an underscore
5530 * must not be used by users of the parser, only by the parser internally.
5533 struct ieee80211_radiotap_iterator {
5534 struct ieee80211_radiotap_header *_rtheader;
5535 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5536 const struct ieee80211_radiotap_namespace *current_namespace;
5538 unsigned char *_arg, *_next_ns_data;
5539 __le32 *_next_bitmap;
5541 unsigned char *this_arg;
5549 uint32_t _bitmap_shifter;
5554 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5555 struct ieee80211_radiotap_header *radiotap_header,
5557 const struct ieee80211_radiotap_vendor_namespaces *vns);
5560 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5563 extern const unsigned char rfc1042_header[6];
5564 extern const unsigned char bridge_tunnel_header[6];
5567 * ieee80211_get_hdrlen_from_skb - get header length from data
5571 * Given an skb with a raw 802.11 header at the data pointer this function
5572 * returns the 802.11 header length.
5574 * Return: The 802.11 header length in bytes (not including encryption
5575 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5578 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5581 * ieee80211_hdrlen - get header length in bytes from frame control
5582 * @fc: frame control field in little-endian format
5583 * Return: The header length in bytes.
5585 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5588 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5589 * @meshhdr: the mesh extension header, only the flags field
5590 * (first byte) will be accessed
5591 * Return: The length of the extension header, which is always at
5592 * least 6 bytes and at most 18 if address 5 and 6 are present.
5594 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5597 * DOC: Data path helpers
5599 * In addition to generic utilities, cfg80211 also offers
5600 * functions that help implement the data path for devices
5601 * that do not do the 802.11/802.3 conversion on the device.
5605 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5606 * @skb: the 802.11 data frame
5607 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5608 * of it being pushed into the SKB
5609 * @addr: the device MAC address
5610 * @iftype: the virtual interface type
5611 * @data_offset: offset of payload after the 802.11 header
5612 * Return: 0 on success. Non-zero on error.
5614 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5615 const u8 *addr, enum nl80211_iftype iftype,
5619 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5620 * @skb: the 802.11 data frame
5621 * @addr: the device MAC address
5622 * @iftype: the virtual interface type
5623 * Return: 0 on success. Non-zero on error.
5625 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5626 enum nl80211_iftype iftype)
5628 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5632 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5634 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5635 * The @list will be empty if the decode fails. The @skb must be fully
5636 * header-less before being passed in here; it is freed in this function.
5638 * @skb: The input A-MSDU frame without any headers.
5639 * @list: The output list of 802.3 frames. It must be allocated and
5640 * initialized by the caller.
5641 * @addr: The device MAC address.
5642 * @iftype: The device interface type.
5643 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5644 * @check_da: DA to check in the inner ethernet header, or NULL
5645 * @check_sa: SA to check in the inner ethernet header, or NULL
5647 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5648 const u8 *addr, enum nl80211_iftype iftype,
5649 const unsigned int extra_headroom,
5650 const u8 *check_da, const u8 *check_sa);
5653 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5654 * @skb: the data frame
5655 * @qos_map: Interworking QoS mapping or %NULL if not in use
5656 * Return: The 802.1p/1d tag.
5658 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5659 struct cfg80211_qos_map *qos_map);
5662 * cfg80211_find_elem_match - match information element and byte array in data
5665 * @ies: data consisting of IEs
5666 * @len: length of data
5667 * @match: byte array to match
5668 * @match_len: number of bytes in the match array
5669 * @match_offset: offset in the IE data where the byte array should match.
5670 * Note the difference to cfg80211_find_ie_match() which considers
5671 * the offset to start from the element ID byte, but here we take
5672 * the data portion instead.
5674 * Return: %NULL if the element ID could not be found or if
5675 * the element is invalid (claims to be longer than the given
5676 * data) or if the byte array doesn't match; otherwise return the
5677 * requested element struct.
5679 * Note: There are no checks on the element length other than
5680 * having to fit into the given data and being large enough for the
5681 * byte array to match.
5683 const struct element *
5684 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5685 const u8 *match, unsigned int match_len,
5686 unsigned int match_offset);
5689 * cfg80211_find_ie_match - match information element and byte array in data
5692 * @ies: data consisting of IEs
5693 * @len: length of data
5694 * @match: byte array to match
5695 * @match_len: number of bytes in the match array
5696 * @match_offset: offset in the IE where the byte array should match.
5697 * If match_len is zero, this must also be set to zero.
5698 * Otherwise this must be set to 2 or more, because the first
5699 * byte is the element id, which is already compared to eid, and
5700 * the second byte is the IE length.
5702 * Return: %NULL if the element ID could not be found or if
5703 * the element is invalid (claims to be longer than the given
5704 * data) or if the byte array doesn't match, or a pointer to the first
5705 * byte of the requested element, that is the byte containing the
5708 * Note: There are no checks on the element length other than
5709 * having to fit into the given data and being large enough for the
5710 * byte array to match.
5712 static inline const u8 *
5713 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5714 const u8 *match, unsigned int match_len,
5715 unsigned int match_offset)
5717 /* match_offset can't be smaller than 2, unless match_len is
5718 * zero, in which case match_offset must be zero as well.
5720 if (WARN_ON((match_len && match_offset < 2) ||
5721 (!match_len && match_offset)))
5724 return (void *)cfg80211_find_elem_match(eid, ies, len,
5727 match_offset - 2 : 0);
5731 * cfg80211_find_elem - find information element in data
5734 * @ies: data consisting of IEs
5735 * @len: length of data
5737 * Return: %NULL if the element ID could not be found or if
5738 * the element is invalid (claims to be longer than the given
5739 * data) or if the byte array doesn't match; otherwise return the
5740 * requested element struct.
5742 * Note: There are no checks on the element length other than
5743 * having to fit into the given data.
5745 static inline const struct element *
5746 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5748 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5752 * cfg80211_find_ie - find information element in data
5755 * @ies: data consisting of IEs
5756 * @len: length of data
5758 * Return: %NULL if the element ID could not be found or if
5759 * the element is invalid (claims to be longer than the given
5760 * data), or a pointer to the first byte of the requested
5761 * element, that is the byte containing the element ID.
5763 * Note: There are no checks on the element length other than
5764 * having to fit into the given data.
5766 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5768 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5772 * cfg80211_find_ext_elem - find information element with EID Extension in data
5774 * @ext_eid: element ID Extension
5775 * @ies: data consisting of IEs
5776 * @len: length of data
5778 * Return: %NULL if the etended element could not be found or if
5779 * the element is invalid (claims to be longer than the given
5780 * data) or if the byte array doesn't match; otherwise return the
5781 * requested element struct.
5783 * Note: There are no checks on the element length other than
5784 * having to fit into the given data.
5786 static inline const struct element *
5787 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5789 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5794 * cfg80211_find_ext_ie - find information element with EID Extension in data
5796 * @ext_eid: element ID Extension
5797 * @ies: data consisting of IEs
5798 * @len: length of data
5800 * Return: %NULL if the extended element ID could not be found or if
5801 * the element is invalid (claims to be longer than the given
5802 * data), or a pointer to the first byte of the requested
5803 * element, that is the byte containing the element ID.
5805 * Note: There are no checks on the element length other than
5806 * having to fit into the given data.
5808 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5810 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5815 * cfg80211_find_vendor_elem - find vendor specific information element in data
5818 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5819 * @ies: data consisting of IEs
5820 * @len: length of data
5822 * Return: %NULL if the vendor specific element ID could not be found or if the
5823 * element is invalid (claims to be longer than the given data); otherwise
5824 * return the element structure for the requested element.
5826 * Note: There are no checks on the element length other than having to fit into
5829 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5834 * cfg80211_find_vendor_ie - find vendor specific information element in data
5837 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5838 * @ies: data consisting of IEs
5839 * @len: length of data
5841 * Return: %NULL if the vendor specific element ID could not be found or if the
5842 * element is invalid (claims to be longer than the given data), or a pointer to
5843 * the first byte of the requested element, that is the byte containing the
5846 * Note: There are no checks on the element length other than having to fit into
5849 static inline const u8 *
5850 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5851 const u8 *ies, unsigned int len)
5853 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5857 * cfg80211_send_layer2_update - send layer 2 update frame
5859 * @dev: network device
5860 * @addr: STA MAC address
5862 * Wireless drivers can use this function to update forwarding tables in bridge
5863 * devices upon STA association.
5865 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5868 * DOC: Regulatory enforcement infrastructure
5874 * regulatory_hint - driver hint to the wireless core a regulatory domain
5875 * @wiphy: the wireless device giving the hint (used only for reporting
5877 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5878 * should be in. If @rd is set this should be NULL. Note that if you
5879 * set this to NULL you should still set rd->alpha2 to some accepted
5882 * Wireless drivers can use this function to hint to the wireless core
5883 * what it believes should be the current regulatory domain by
5884 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5885 * domain should be in or by providing a completely build regulatory domain.
5886 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5887 * for a regulatory domain structure for the respective country.
5889 * The wiphy must have been registered to cfg80211 prior to this call.
5890 * For cfg80211 drivers this means you must first use wiphy_register(),
5891 * for mac80211 drivers you must first use ieee80211_register_hw().
5893 * Drivers should check the return value, its possible you can get
5896 * Return: 0 on success. -ENOMEM.
5898 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5901 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5902 * @wiphy: the wireless device we want to process the regulatory domain on
5903 * @rd: the regulatory domain informatoin to use for this wiphy
5905 * Set the regulatory domain information for self-managed wiphys, only they
5906 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5909 * Return: 0 on success. -EINVAL, -EPERM
5911 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5912 struct ieee80211_regdomain *rd);
5915 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5916 * @wiphy: the wireless device we want to process the regulatory domain on
5917 * @rd: the regulatory domain information to use for this wiphy
5919 * This functions requires the RTNL to be held and applies the new regdomain
5920 * synchronously to this wiphy. For more details see
5921 * regulatory_set_wiphy_regd().
5923 * Return: 0 on success. -EINVAL, -EPERM
5925 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5926 struct ieee80211_regdomain *rd);
5929 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5930 * @wiphy: the wireless device we want to process the regulatory domain on
5931 * @regd: the custom regulatory domain to use for this wiphy
5933 * Drivers can sometimes have custom regulatory domains which do not apply
5934 * to a specific country. Drivers can use this to apply such custom regulatory
5935 * domains. This routine must be called prior to wiphy registration. The
5936 * custom regulatory domain will be trusted completely and as such previous
5937 * default channel settings will be disregarded. If no rule is found for a
5938 * channel on the regulatory domain the channel will be disabled.
5939 * Drivers using this for a wiphy should also set the wiphy flag
5940 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5941 * that called this helper.
5943 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5944 const struct ieee80211_regdomain *regd);
5947 * freq_reg_info - get regulatory information for the given frequency
5948 * @wiphy: the wiphy for which we want to process this rule for
5949 * @center_freq: Frequency in KHz for which we want regulatory information for
5951 * Use this function to get the regulatory rule for a specific frequency on
5952 * a given wireless device. If the device has a specific regulatory domain
5953 * it wants to follow we respect that unless a country IE has been received
5954 * and processed already.
5956 * Return: A valid pointer, or, when an error occurs, for example if no rule
5957 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5958 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5959 * value will be -ERANGE if we determine the given center_freq does not even
5960 * have a regulatory rule for a frequency range in the center_freq's band.
5961 * See freq_in_rule_band() for our current definition of a band -- this is
5962 * purely subjective and right now it's 802.11 specific.
5964 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5968 * reg_initiator_name - map regulatory request initiator enum to name
5969 * @initiator: the regulatory request initiator
5971 * You can use this to map the regulatory request initiator enum to a
5972 * proper string representation.
5974 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5977 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
5978 * @wiphy: wiphy for which pre-CAC capability is checked.
5980 * Pre-CAC is allowed only in some regdomains (notable ETSI).
5982 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
5985 * DOC: Internal regulatory db functions
5990 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
5991 * Regulatory self-managed driver can use it to proactively
5993 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5994 * @freq: the freqency(in MHz) to be queried.
5995 * @rule: pointer to store the wmm rule from the regulatory db.
5997 * Self-managed wireless drivers can use this function to query
5998 * the internal regulatory database to check whether the given
5999 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6001 * Drivers should check the return value, its possible you can get
6004 * Return: 0 on success. -ENODATA.
6006 int reg_query_regdb_wmm(char *alpha2, int freq,
6007 struct ieee80211_reg_rule *rule);
6010 * callbacks for asynchronous cfg80211 methods, notification
6011 * functions and BSS handling helpers
6015 * cfg80211_scan_done - notify that scan finished
6017 * @request: the corresponding scan request
6018 * @info: information about the completed scan
6020 void cfg80211_scan_done(struct cfg80211_scan_request *request,
6021 struct cfg80211_scan_info *info);
6024 * cfg80211_sched_scan_results - notify that new scan results are available
6026 * @wiphy: the wiphy which got scheduled scan results
6027 * @reqid: identifier for the related scheduled scan request
6029 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6032 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6034 * @wiphy: the wiphy on which the scheduled scan stopped
6035 * @reqid: identifier for the related scheduled scan request
6037 * The driver can call this function to inform cfg80211 that the
6038 * scheduled scan had to be stopped, for whatever reason. The driver
6039 * is then called back via the sched_scan_stop operation when done.
6041 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6044 * cfg80211_sched_scan_stopped_rtnl - 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.
6052 * This function should be called with rtnl locked.
6054 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
6057 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6058 * @wiphy: the wiphy reporting the BSS
6059 * @data: the BSS metadata
6060 * @mgmt: the management frame (probe response or beacon)
6061 * @len: length of the management frame
6062 * @gfp: context flags
6064 * This informs cfg80211 that BSS information was found and
6065 * the BSS should be updated/added.
6067 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6068 * Or %NULL on error.
6070 struct cfg80211_bss * __must_check
6071 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
6072 struct cfg80211_inform_bss *data,
6073 struct ieee80211_mgmt *mgmt, size_t len,
6076 static inline struct cfg80211_bss * __must_check
6077 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6078 struct ieee80211_channel *rx_channel,
6079 enum nl80211_bss_scan_width scan_width,
6080 struct ieee80211_mgmt *mgmt, size_t len,
6081 s32 signal, gfp_t gfp)
6083 struct cfg80211_inform_bss data = {
6085 .scan_width = scan_width,
6089 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6092 static inline struct cfg80211_bss * __must_check
6093 cfg80211_inform_bss_frame(struct wiphy *wiphy,
6094 struct ieee80211_channel *rx_channel,
6095 struct ieee80211_mgmt *mgmt, size_t len,
6096 s32 signal, gfp_t gfp)
6098 struct cfg80211_inform_bss data = {
6100 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6104 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6108 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6109 * @bssid: transmitter BSSID
6110 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6111 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6112 * @new_bssid: calculated nontransmitted BSSID
6114 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6115 u8 mbssid_index, u8 *new_bssid)
6117 u64 bssid_u64 = ether_addr_to_u64(bssid);
6118 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6121 new_bssid_u64 = bssid_u64 & ~mask;
6123 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6125 u64_to_ether_addr(new_bssid_u64, new_bssid);
6129 * cfg80211_is_element_inherited - returns if element ID should be inherited
6130 * @element: element to check
6131 * @non_inherit_element: non inheritance element
6133 bool cfg80211_is_element_inherited(const struct element *element,
6134 const struct element *non_inherit_element);
6137 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6139 * @ielen: length of IEs
6140 * @mbssid_elem: current MBSSID element
6141 * @sub_elem: current MBSSID subelement (profile)
6142 * @merged_ie: location of the merged profile
6143 * @max_copy_len: max merged profile length
6145 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6146 const struct element *mbssid_elem,
6147 const struct element *sub_elem,
6148 u8 *merged_ie, size_t max_copy_len);
6151 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6152 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6153 * from a beacon or probe response
6154 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6155 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6157 enum cfg80211_bss_frame_type {
6158 CFG80211_BSS_FTYPE_UNKNOWN,
6159 CFG80211_BSS_FTYPE_BEACON,
6160 CFG80211_BSS_FTYPE_PRESP,
6164 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6166 * @wiphy: the wiphy reporting the BSS
6167 * @data: the BSS metadata
6168 * @ftype: frame type (if known)
6169 * @bssid: the BSSID of the BSS
6170 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6171 * @capability: the capability field sent by the peer
6172 * @beacon_interval: the beacon interval announced by the peer
6173 * @ie: additional IEs sent by the peer
6174 * @ielen: length of the additional IEs
6175 * @gfp: context flags
6177 * This informs cfg80211 that BSS information was found and
6178 * the BSS should be updated/added.
6180 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6181 * Or %NULL on error.
6183 struct cfg80211_bss * __must_check
6184 cfg80211_inform_bss_data(struct wiphy *wiphy,
6185 struct cfg80211_inform_bss *data,
6186 enum cfg80211_bss_frame_type ftype,
6187 const u8 *bssid, u64 tsf, u16 capability,
6188 u16 beacon_interval, const u8 *ie, size_t ielen,
6191 static inline struct cfg80211_bss * __must_check
6192 cfg80211_inform_bss_width(struct wiphy *wiphy,
6193 struct ieee80211_channel *rx_channel,
6194 enum nl80211_bss_scan_width scan_width,
6195 enum cfg80211_bss_frame_type ftype,
6196 const u8 *bssid, u64 tsf, u16 capability,
6197 u16 beacon_interval, const u8 *ie, size_t ielen,
6198 s32 signal, gfp_t gfp)
6200 struct cfg80211_inform_bss data = {
6202 .scan_width = scan_width,
6206 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6207 capability, beacon_interval, ie, ielen,
6211 static inline struct cfg80211_bss * __must_check
6212 cfg80211_inform_bss(struct wiphy *wiphy,
6213 struct ieee80211_channel *rx_channel,
6214 enum cfg80211_bss_frame_type ftype,
6215 const u8 *bssid, u64 tsf, u16 capability,
6216 u16 beacon_interval, const u8 *ie, size_t ielen,
6217 s32 signal, gfp_t gfp)
6219 struct cfg80211_inform_bss data = {
6221 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6225 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6226 capability, beacon_interval, ie, ielen,
6231 * cfg80211_get_bss - get a BSS reference
6232 * @wiphy: the wiphy this BSS struct belongs to
6233 * @channel: the channel to search on (or %NULL)
6234 * @bssid: the desired BSSID (or %NULL)
6235 * @ssid: the desired SSID (or %NULL)
6236 * @ssid_len: length of the SSID (or 0)
6237 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6238 * @privacy: privacy filter, see &enum ieee80211_privacy
6240 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6241 struct ieee80211_channel *channel,
6243 const u8 *ssid, size_t ssid_len,
6244 enum ieee80211_bss_type bss_type,
6245 enum ieee80211_privacy privacy);
6246 static inline struct cfg80211_bss *
6247 cfg80211_get_ibss(struct wiphy *wiphy,
6248 struct ieee80211_channel *channel,
6249 const u8 *ssid, size_t ssid_len)
6251 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6252 IEEE80211_BSS_TYPE_IBSS,
6253 IEEE80211_PRIVACY_ANY);
6257 * cfg80211_ref_bss - reference BSS struct
6258 * @wiphy: the wiphy this BSS struct belongs to
6259 * @bss: the BSS struct to reference
6261 * Increments the refcount of the given BSS struct.
6263 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6266 * cfg80211_put_bss - unref BSS struct
6267 * @wiphy: the wiphy this BSS struct belongs to
6268 * @bss: the BSS struct
6270 * Decrements the refcount of the given BSS struct.
6272 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6275 * cfg80211_unlink_bss - unlink BSS from internal data structures
6277 * @bss: the bss to remove
6279 * This function removes the given BSS from the internal data structures
6280 * thereby making it no longer show up in scan results etc. Use this
6281 * function when you detect a BSS is gone. Normally BSSes will also time
6282 * out, so it is not necessary to use this function at all.
6284 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6287 * cfg80211_bss_iter - iterate all BSS entries
6289 * This function iterates over the BSS entries associated with the given wiphy
6290 * and calls the callback for the iterated BSS. The iterator function is not
6291 * allowed to call functions that might modify the internal state of the BSS DB.
6294 * @chandef: if given, the iterator function will be called only if the channel
6295 * of the currently iterated BSS is a subset of the given channel.
6296 * @iter: the iterator function to call
6297 * @iter_data: an argument to the iterator function
6299 void cfg80211_bss_iter(struct wiphy *wiphy,
6300 struct cfg80211_chan_def *chandef,
6301 void (*iter)(struct wiphy *wiphy,
6302 struct cfg80211_bss *bss,
6306 static inline enum nl80211_bss_scan_width
6307 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6309 switch (chandef->width) {
6310 case NL80211_CHAN_WIDTH_5:
6311 return NL80211_BSS_CHAN_WIDTH_5;
6312 case NL80211_CHAN_WIDTH_10:
6313 return NL80211_BSS_CHAN_WIDTH_10;
6315 return NL80211_BSS_CHAN_WIDTH_20;
6320 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6321 * @dev: network device
6322 * @buf: authentication frame (header + body)
6323 * @len: length of the frame data
6325 * This function is called whenever an authentication, disassociation or
6326 * deauthentication frame has been received and processed in station mode.
6327 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6328 * call either this function or cfg80211_auth_timeout().
6329 * After being asked to associate via cfg80211_ops::assoc() the driver must
6330 * call either this function or cfg80211_auth_timeout().
6331 * While connected, the driver must calls this for received and processed
6332 * disassociation and deauthentication frames. If the frame couldn't be used
6333 * because it was unprotected, the driver must call the function
6334 * cfg80211_rx_unprot_mlme_mgmt() instead.
6336 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6338 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6341 * cfg80211_auth_timeout - notification of timed out authentication
6342 * @dev: network device
6343 * @addr: The MAC address of the device with which the authentication timed out
6345 * This function may sleep. The caller must hold the corresponding wdev's
6348 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6351 * cfg80211_rx_assoc_resp - notification of processed association response
6352 * @dev: network device
6353 * @bss: the BSS that association was requested with, ownership of the pointer
6354 * moves to cfg80211 in this call
6355 * @buf: (Re)Association Response frame (header + body)
6356 * @len: length of the frame data
6357 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6358 * as the AC bitmap in the QoS info field
6359 * @req_ies: information elements from the (Re)Association Request frame
6360 * @req_ies_len: length of req_ies data
6362 * After being asked to associate via cfg80211_ops::assoc() the driver must
6363 * call either this function or cfg80211_auth_timeout().
6365 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6367 void cfg80211_rx_assoc_resp(struct net_device *dev,
6368 struct cfg80211_bss *bss,
6369 const u8 *buf, size_t len,
6371 const u8 *req_ies, size_t req_ies_len);
6374 * cfg80211_assoc_timeout - notification of timed out association
6375 * @dev: network device
6376 * @bss: The BSS entry with which association timed out.
6378 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6380 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6383 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6384 * @dev: network device
6385 * @bss: The BSS entry with which association was abandoned.
6387 * Call this whenever - for reasons reported through other API, like deauth RX,
6388 * an association attempt was abandoned.
6389 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6391 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6394 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6395 * @dev: network device
6396 * @buf: 802.11 frame (header + body)
6397 * @len: length of the frame data
6399 * This function is called whenever deauthentication has been processed in
6400 * station mode. This includes both received deauthentication frames and
6401 * locally generated ones. This function may sleep. The caller must hold the
6402 * corresponding wdev's mutex.
6404 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6407 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6408 * @dev: network device
6409 * @buf: received management frame (header + body)
6410 * @len: length of the frame data
6412 * This function is called whenever a received deauthentication or dissassoc
6413 * frame has been dropped in station mode because of MFP being used but the
6414 * frame was not protected. This is also used to notify reception of a Beacon
6415 * frame that was dropped because it did not include a valid MME MIC while
6416 * beacon protection was enabled (BIGTK configured in station mode).
6418 * This function may sleep.
6420 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6421 const u8 *buf, size_t len);
6424 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6425 * @dev: network device
6426 * @addr: The source MAC address of the frame
6427 * @key_type: The key type that the received frame used
6428 * @key_id: Key identifier (0..3). Can be -1 if missing.
6429 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6430 * @gfp: allocation flags
6432 * This function is called whenever the local MAC detects a MIC failure in a
6433 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6436 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6437 enum nl80211_key_type key_type, int key_id,
6438 const u8 *tsc, gfp_t gfp);
6441 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6443 * @dev: network device
6444 * @bssid: the BSSID of the IBSS joined
6445 * @channel: the channel of the IBSS joined
6446 * @gfp: allocation flags
6448 * This function notifies cfg80211 that the device joined an IBSS or
6449 * switched to a different BSSID. Before this function can be called,
6450 * either a beacon has to have been received from the IBSS, or one of
6451 * the cfg80211_inform_bss{,_frame} functions must have been called
6452 * with the locally generated beacon -- this guarantees that there is
6453 * always a scan result for this IBSS. cfg80211 will handle the rest.
6455 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6456 struct ieee80211_channel *channel, gfp_t gfp);
6459 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
6461 * @dev: network device
6462 * @macaddr: the MAC address of the new candidate
6463 * @ie: information elements advertised by the peer candidate
6464 * @ie_len: length of the information elements buffer
6465 * @gfp: allocation flags
6467 * This function notifies cfg80211 that the mesh peer candidate has been
6468 * detected, most likely via a beacon or, less likely, via a probe response.
6469 * cfg80211 then sends a notification to userspace.
6471 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6472 const u8 *macaddr, const u8 *ie, u8 ie_len,
6473 int sig_dbm, gfp_t gfp);
6476 * DOC: RFkill integration
6478 * RFkill integration in cfg80211 is almost invisible to drivers,
6479 * as cfg80211 automatically registers an rfkill instance for each
6480 * wireless device it knows about. Soft kill is also translated
6481 * into disconnecting and turning all interfaces off, drivers are
6482 * expected to turn off the device when all interfaces are down.
6484 * However, devices may have a hard RFkill line, in which case they
6485 * also need to interact with the rfkill subsystem, via cfg80211.
6486 * They can do this with a few helper functions documented here.
6490 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6492 * @blocked: block status
6494 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
6497 * wiphy_rfkill_start_polling - start polling rfkill
6500 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6503 * wiphy_rfkill_stop_polling - stop polling rfkill
6506 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
6509 * DOC: Vendor commands
6511 * Occasionally, there are special protocol or firmware features that
6512 * can't be implemented very openly. For this and similar cases, the
6513 * vendor command functionality allows implementing the features with
6514 * (typically closed-source) userspace and firmware, using nl80211 as
6515 * the configuration mechanism.
6517 * A driver supporting vendor commands must register them as an array
6518 * in struct wiphy, with handlers for each one, each command has an
6519 * OUI and sub command ID to identify it.
6521 * Note that this feature should not be (ab)used to implement protocol
6522 * features that could openly be shared across drivers. In particular,
6523 * it must never be required to use vendor commands to implement any
6524 * "normal" functionality that higher-level userspace like connection
6525 * managers etc. need.
6528 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6529 enum nl80211_commands cmd,
6530 enum nl80211_attrs attr,
6533 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6534 struct wireless_dev *wdev,
6535 enum nl80211_commands cmd,
6536 enum nl80211_attrs attr,
6537 unsigned int portid,
6538 int vendor_event_idx,
6539 int approxlen, gfp_t gfp);
6541 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6544 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6546 * @approxlen: an upper bound of the length of the data that will
6547 * be put into the skb
6549 * This function allocates and pre-fills an skb for a reply to
6550 * a vendor command. Since it is intended for a reply, calling
6551 * it outside of a vendor command's doit() operation is invalid.
6553 * The returned skb is pre-filled with some identifying data in
6554 * a way that any data that is put into the skb (with skb_put(),
6555 * nla_put() or similar) will end up being within the
6556 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6557 * with the skb is adding data for the corresponding userspace tool
6558 * which can then read that data out of the vendor data attribute.
6559 * You must not modify the skb in any other way.
6561 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6562 * its error code as the result of the doit() operation.
6564 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6566 static inline struct sk_buff *
6567 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6569 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6570 NL80211_ATTR_VENDOR_DATA, approxlen);
6574 * cfg80211_vendor_cmd_reply - send the reply skb
6575 * @skb: The skb, must have been allocated with
6576 * cfg80211_vendor_cmd_alloc_reply_skb()
6578 * Since calling this function will usually be the last thing
6579 * before returning from the vendor command doit() you should
6580 * return the error code. Note that this function consumes the
6581 * skb regardless of the return value.
6583 * Return: An error code or 0 on success.
6585 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6588 * cfg80211_vendor_cmd_get_sender
6591 * Return the current netlink port ID in a vendor command handler.
6592 * Valid to call only there.
6594 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6597 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6599 * @wdev: the wireless device
6600 * @event_idx: index of the vendor event in the wiphy's vendor_events
6601 * @approxlen: an upper bound of the length of the data that will
6602 * be put into the skb
6603 * @gfp: allocation flags
6605 * This function allocates and pre-fills an skb for an event on the
6606 * vendor-specific multicast group.
6608 * If wdev != NULL, both the ifindex and identifier of the specified
6609 * wireless device are added to the event message before the vendor data
6612 * When done filling the skb, call cfg80211_vendor_event() with the
6613 * skb to send the event.
6615 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6617 static inline struct sk_buff *
6618 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6619 int approxlen, int event_idx, gfp_t gfp)
6621 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6622 NL80211_ATTR_VENDOR_DATA,
6623 0, event_idx, approxlen, gfp);
6627 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6629 * @wdev: the wireless device
6630 * @event_idx: index of the vendor event in the wiphy's vendor_events
6631 * @portid: port ID of the receiver
6632 * @approxlen: an upper bound of the length of the data that will
6633 * be put into the skb
6634 * @gfp: allocation flags
6636 * This function allocates and pre-fills an skb for an event to send to
6637 * a specific (userland) socket. This socket would previously have been
6638 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6639 * care to register a netlink notifier to see when the socket closes.
6641 * If wdev != NULL, both the ifindex and identifier of the specified
6642 * wireless device are added to the event message before the vendor data
6645 * When done filling the skb, call cfg80211_vendor_event() with the
6646 * skb to send the event.
6648 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6650 static inline struct sk_buff *
6651 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6652 struct wireless_dev *wdev,
6653 unsigned int portid, int approxlen,
6654 int event_idx, gfp_t gfp)
6656 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6657 NL80211_ATTR_VENDOR_DATA,
6658 portid, event_idx, approxlen, gfp);
6662 * cfg80211_vendor_event - send the event
6663 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6664 * @gfp: allocation flags
6666 * This function sends the given @skb, which must have been allocated
6667 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6669 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6671 __cfg80211_send_event_skb(skb, gfp);
6674 #ifdef CONFIG_NL80211_TESTMODE
6678 * Test mode is a set of utility functions to allow drivers to
6679 * interact with driver-specific tools to aid, for instance,
6680 * factory programming.
6682 * This chapter describes how drivers interact with it, for more
6683 * information see the nl80211 book's chapter on it.
6687 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6689 * @approxlen: an upper bound of the length of the data that will
6690 * be put into the skb
6692 * This function allocates and pre-fills an skb for a reply to
6693 * the testmode command. Since it is intended for a reply, calling
6694 * it outside of the @testmode_cmd operation is invalid.
6696 * The returned skb is pre-filled with the wiphy index and set up in
6697 * a way that any data that is put into the skb (with skb_put(),
6698 * nla_put() or similar) will end up being within the
6699 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6700 * with the skb is adding data for the corresponding userspace tool
6701 * which can then read that data out of the testdata attribute. You
6702 * must not modify the skb in any other way.
6704 * When done, call cfg80211_testmode_reply() with the skb and return
6705 * its error code as the result of the @testmode_cmd operation.
6707 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6709 static inline struct sk_buff *
6710 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6712 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6713 NL80211_ATTR_TESTDATA, approxlen);
6717 * cfg80211_testmode_reply - send the reply skb
6718 * @skb: The skb, must have been allocated with
6719 * cfg80211_testmode_alloc_reply_skb()
6721 * Since calling this function will usually be the last thing
6722 * before returning from the @testmode_cmd you should return
6723 * the error code. Note that this function consumes the skb
6724 * regardless of the return value.
6726 * Return: An error code or 0 on success.
6728 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6730 return cfg80211_vendor_cmd_reply(skb);
6734 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6736 * @approxlen: an upper bound of the length of the data that will
6737 * be put into the skb
6738 * @gfp: allocation flags
6740 * This function allocates and pre-fills an skb for an event on the
6741 * testmode multicast group.
6743 * The returned skb is set up in the same way as with
6744 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6745 * there, you should simply add data to it that will then end up in the
6746 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6749 * When done filling the skb, call cfg80211_testmode_event() with the
6750 * skb to send the event.
6752 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6754 static inline struct sk_buff *
6755 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6757 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6758 NL80211_ATTR_TESTDATA, 0, -1,
6763 * cfg80211_testmode_event - send the event
6764 * @skb: The skb, must have been allocated with
6765 * cfg80211_testmode_alloc_event_skb()
6766 * @gfp: allocation flags
6768 * This function sends the given @skb, which must have been allocated
6769 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6772 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6774 __cfg80211_send_event_skb(skb, gfp);
6777 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6778 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6780 #define CFG80211_TESTMODE_CMD(cmd)
6781 #define CFG80211_TESTMODE_DUMP(cmd)
6785 * struct cfg80211_fils_resp_params - FILS connection response params
6786 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6787 * @kek_len: Length of @fils_kek in octets
6788 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6789 * @erp_next_seq_num is valid.
6790 * @erp_next_seq_num: The next sequence number to use in ERP message in
6791 * FILS Authentication. This value should be specified irrespective of the
6792 * status for a FILS connection.
6793 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6794 * @pmk_len: Length of @pmk in octets
6795 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6796 * used for this FILS connection (may be %NULL).
6798 struct cfg80211_fils_resp_params {
6801 bool update_erp_next_seq_num;
6802 u16 erp_next_seq_num;
6809 * struct cfg80211_connect_resp_params - Connection response params
6810 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6811 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6812 * the real status code for failures. If this call is used to report a
6813 * failure due to a timeout (e.g., not receiving an Authentication frame
6814 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6815 * indicate that this is a failure, but without a status code.
6816 * @timeout_reason is used to report the reason for the timeout in that
6818 * @bssid: The BSSID of the AP (may be %NULL)
6819 * @bss: Entry of bss to which STA got connected to, can be obtained through
6820 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6821 * bss from the connect_request and hold a reference to it and return
6822 * through this param to avoid a warning if the bss is expired during the
6823 * connection, esp. for those drivers implementing connect op.
6824 * Only one parameter among @bssid and @bss needs to be specified.
6825 * @req_ie: Association request IEs (may be %NULL)
6826 * @req_ie_len: Association request IEs length
6827 * @resp_ie: Association response IEs (may be %NULL)
6828 * @resp_ie_len: Association response IEs length
6829 * @fils: FILS connection response parameters.
6830 * @timeout_reason: Reason for connection timeout. This is used when the
6831 * connection fails due to a timeout instead of an explicit rejection from
6832 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6833 * not known. This value is used only if @status < 0 to indicate that the
6834 * failure is due to a timeout and not due to explicit rejection by the AP.
6835 * This value is ignored in other cases (@status >= 0).
6837 struct cfg80211_connect_resp_params {
6840 struct cfg80211_bss *bss;
6845 struct cfg80211_fils_resp_params fils;
6846 enum nl80211_timeout_reason timeout_reason;
6850 * cfg80211_connect_done - notify cfg80211 of connection result
6852 * @dev: network device
6853 * @params: connection response parameters
6854 * @gfp: allocation flags
6856 * It should be called by the underlying driver once execution of the connection
6857 * request from connect() has been completed. This is similar to
6858 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6859 * parameters. Only one of the functions among cfg80211_connect_bss(),
6860 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6861 * and cfg80211_connect_done() should be called.
6863 void cfg80211_connect_done(struct net_device *dev,
6864 struct cfg80211_connect_resp_params *params,
6868 * cfg80211_connect_bss - notify cfg80211 of connection result
6870 * @dev: network device
6871 * @bssid: the BSSID of the AP
6872 * @bss: Entry of bss to which STA got connected to, can be obtained through
6873 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6874 * bss from the connect_request and hold a reference to it and return
6875 * through this param to avoid a warning if the bss is expired during the
6876 * connection, esp. for those drivers implementing connect op.
6877 * Only one parameter among @bssid and @bss needs to be specified.
6878 * @req_ie: association request IEs (maybe be %NULL)
6879 * @req_ie_len: association request IEs length
6880 * @resp_ie: association response IEs (may be %NULL)
6881 * @resp_ie_len: assoc response IEs length
6882 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6883 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6884 * the real status code for failures. If this call is used to report a
6885 * failure due to a timeout (e.g., not receiving an Authentication frame
6886 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6887 * indicate that this is a failure, but without a status code.
6888 * @timeout_reason is used to report the reason for the timeout in that
6890 * @gfp: allocation flags
6891 * @timeout_reason: reason for connection timeout. This is used when the
6892 * connection fails due to a timeout instead of an explicit rejection from
6893 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6894 * not known. This value is used only if @status < 0 to indicate that the
6895 * failure is due to a timeout and not due to explicit rejection by the AP.
6896 * This value is ignored in other cases (@status >= 0).
6898 * It should be called by the underlying driver once execution of the connection
6899 * request from connect() has been completed. This is similar to
6900 * cfg80211_connect_result(), but with the option of identifying the exact bss
6901 * entry for the connection. Only one of the functions among
6902 * cfg80211_connect_bss(), cfg80211_connect_result(),
6903 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6906 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6907 struct cfg80211_bss *bss, const u8 *req_ie,
6908 size_t req_ie_len, const u8 *resp_ie,
6909 size_t resp_ie_len, int status, gfp_t gfp,
6910 enum nl80211_timeout_reason timeout_reason)
6912 struct cfg80211_connect_resp_params params;
6914 memset(¶ms, 0, sizeof(params));
6915 params.status = status;
6916 params.bssid = bssid;
6918 params.req_ie = req_ie;
6919 params.req_ie_len = req_ie_len;
6920 params.resp_ie = resp_ie;
6921 params.resp_ie_len = resp_ie_len;
6922 params.timeout_reason = timeout_reason;
6924 cfg80211_connect_done(dev, ¶ms, gfp);
6928 * cfg80211_connect_result - notify cfg80211 of connection result
6930 * @dev: network device
6931 * @bssid: the BSSID of the AP
6932 * @req_ie: association request IEs (maybe be %NULL)
6933 * @req_ie_len: association request IEs length
6934 * @resp_ie: association response IEs (may be %NULL)
6935 * @resp_ie_len: assoc response IEs length
6936 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6937 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6938 * the real status code for failures.
6939 * @gfp: allocation flags
6941 * It should be called by the underlying driver once execution of the connection
6942 * request from connect() has been completed. This is similar to
6943 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6944 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6945 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6948 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6949 const u8 *req_ie, size_t req_ie_len,
6950 const u8 *resp_ie, size_t resp_ie_len,
6951 u16 status, gfp_t gfp)
6953 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6954 resp_ie_len, status, gfp,
6955 NL80211_TIMEOUT_UNSPECIFIED);
6959 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6961 * @dev: network device
6962 * @bssid: the BSSID of the AP
6963 * @req_ie: association request IEs (maybe be %NULL)
6964 * @req_ie_len: association request IEs length
6965 * @gfp: allocation flags
6966 * @timeout_reason: reason for connection timeout.
6968 * It should be called by the underlying driver whenever connect() has failed
6969 * in a sequence where no explicit authentication/association rejection was
6970 * received from the AP. This could happen, e.g., due to not being able to send
6971 * out the Authentication or Association Request frame or timing out while
6972 * waiting for the response. Only one of the functions among
6973 * cfg80211_connect_bss(), cfg80211_connect_result(),
6974 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6977 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6978 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6979 enum nl80211_timeout_reason timeout_reason)
6981 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6982 gfp, timeout_reason);
6986 * struct cfg80211_roam_info - driver initiated roaming information
6988 * @channel: the channel of the new AP
6989 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6990 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6991 * @req_ie: association request IEs (maybe be %NULL)
6992 * @req_ie_len: association request IEs length
6993 * @resp_ie: association response IEs (may be %NULL)
6994 * @resp_ie_len: assoc response IEs length
6995 * @fils: FILS related roaming information.
6997 struct cfg80211_roam_info {
6998 struct ieee80211_channel *channel;
6999 struct cfg80211_bss *bss;
7005 struct cfg80211_fils_resp_params fils;
7009 * cfg80211_roamed - notify cfg80211 of roaming
7011 * @dev: network device
7012 * @info: information about the new BSS. struct &cfg80211_roam_info.
7013 * @gfp: allocation flags
7015 * This function may be called with the driver passing either the BSSID of the
7016 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7017 * It should be called by the underlying driver whenever it roamed from one AP
7018 * to another while connected. Drivers which have roaming implemented in
7019 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7020 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7021 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7022 * rdev->event_work. In case of any failures, the reference is released
7023 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7024 * released while disconnecting from the current bss.
7026 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7030 * cfg80211_port_authorized - notify cfg80211 of successful security association
7032 * @dev: network device
7033 * @bssid: the BSSID of the AP
7034 * @gfp: allocation flags
7036 * This function should be called by a driver that supports 4 way handshake
7037 * offload after a security association was successfully established (i.e.,
7038 * the 4 way handshake was completed successfully). The call to this function
7039 * should be preceded with a call to cfg80211_connect_result(),
7040 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7041 * indicate the 802.11 association.
7043 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7047 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7049 * @dev: network device
7050 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7051 * @ie_len: length of IEs
7052 * @reason: reason code for the disconnection, set it to 0 if unknown
7053 * @locally_generated: disconnection was requested locally
7054 * @gfp: allocation flags
7056 * After it calls this function, the driver should enter an idle state
7057 * and not try to connect to any AP any more.
7059 void cfg80211_disconnected(struct net_device *dev, u16 reason,
7060 const u8 *ie, size_t ie_len,
7061 bool locally_generated, gfp_t gfp);
7064 * cfg80211_ready_on_channel - notification of remain_on_channel start
7065 * @wdev: wireless device
7066 * @cookie: the request cookie
7067 * @chan: The current channel (from remain_on_channel request)
7068 * @duration: Duration in milliseconds that the driver intents to remain on the
7070 * @gfp: allocation flags
7072 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7073 struct ieee80211_channel *chan,
7074 unsigned int duration, gfp_t gfp);
7077 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7078 * @wdev: wireless device
7079 * @cookie: the request cookie
7080 * @chan: The current channel (from remain_on_channel request)
7081 * @gfp: allocation flags
7083 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7084 struct ieee80211_channel *chan,
7088 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7089 * @wdev: wireless device
7090 * @cookie: the requested cookie
7091 * @chan: The current channel (from tx_mgmt request)
7092 * @gfp: allocation flags
7094 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7095 struct ieee80211_channel *chan, gfp_t gfp);
7098 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7100 * @sinfo: the station information
7101 * @gfp: allocation flags
7103 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7106 * cfg80211_sinfo_release_content - release contents of station info
7107 * @sinfo: the station information
7109 * Releases any potentially allocated sub-information of the station
7110 * information, but not the struct itself (since it's typically on
7113 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7115 kfree(sinfo->pertid);
7119 * cfg80211_new_sta - notify userspace about station
7122 * @mac_addr: the station's address
7123 * @sinfo: the station information
7124 * @gfp: allocation flags
7126 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7127 struct station_info *sinfo, gfp_t gfp);
7130 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7132 * @mac_addr: the station's address
7133 * @sinfo: the station information/statistics
7134 * @gfp: allocation flags
7136 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7137 struct station_info *sinfo, gfp_t gfp);
7140 * cfg80211_del_sta - notify userspace about deletion of a station
7143 * @mac_addr: the station's address
7144 * @gfp: allocation flags
7146 static inline void cfg80211_del_sta(struct net_device *dev,
7147 const u8 *mac_addr, gfp_t gfp)
7149 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7153 * cfg80211_conn_failed - connection request failed notification
7156 * @mac_addr: the station's address
7157 * @reason: the reason for connection failure
7158 * @gfp: allocation flags
7160 * Whenever a station tries to connect to an AP and if the station
7161 * could not connect to the AP as the AP has rejected the connection
7162 * for some reasons, this function is called.
7164 * The reason for connection failure can be any of the value from
7165 * nl80211_connect_failed_reason enum
7167 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7168 enum nl80211_connect_failed_reason reason,
7172 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7173 * @wdev: wireless device receiving the frame
7174 * @freq: Frequency on which the frame was received in KHz
7175 * @sig_dbm: signal strength in dBm, or 0 if unknown
7176 * @buf: Management frame (header + body)
7177 * @len: length of the frame data
7178 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7180 * This function is called whenever an Action frame is received for a station
7181 * mode interface, but is not processed in kernel.
7183 * Return: %true if a user space application has registered for this frame.
7184 * For action frames, that makes it responsible for rejecting unrecognized
7185 * action frames; %false otherwise, in which case for action frames the
7186 * driver is responsible for rejecting the frame.
7188 bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq, int sig_dbm,
7189 const u8 *buf, size_t len, u32 flags);
7192 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7193 * @wdev: wireless device receiving the frame
7194 * @freq: Frequency on which the frame was received in MHz
7195 * @sig_dbm: signal strength in dBm, or 0 if unknown
7196 * @buf: Management frame (header + body)
7197 * @len: length of the frame data
7198 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7200 * This function is called whenever an Action frame is received for a station
7201 * mode interface, but is not processed in kernel.
7203 * Return: %true if a user space application has registered for this frame.
7204 * For action frames, that makes it responsible for rejecting unrecognized
7205 * action frames; %false otherwise, in which case for action frames the
7206 * driver is responsible for rejecting the frame.
7208 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7209 int sig_dbm, const u8 *buf, size_t len,
7212 return cfg80211_rx_mgmt_khz(wdev, MHZ_TO_KHZ(freq), sig_dbm, buf, len,
7217 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7218 * @wdev: wireless device receiving the frame
7219 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7220 * @buf: Management frame (header + body)
7221 * @len: length of the frame data
7222 * @ack: Whether frame was acknowledged
7223 * @gfp: context flags
7225 * This function is called whenever a management frame was requested to be
7226 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7227 * transmission attempt.
7229 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
7230 const u8 *buf, size_t len, bool ack, gfp_t gfp);
7233 * cfg80211_control_port_tx_status - notification of TX status for control
7235 * @wdev: wireless device receiving the frame
7236 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7237 * @buf: Data frame (header + body)
7238 * @len: length of the frame data
7239 * @ack: Whether frame was acknowledged
7240 * @gfp: context flags
7242 * This function is called whenever a control port frame was requested to be
7243 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7244 * the transmission attempt.
7246 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
7247 const u8 *buf, size_t len, bool ack,
7251 * cfg80211_rx_control_port - notification about a received control port frame
7252 * @dev: The device the frame matched to
7253 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7254 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7255 * This function does not take ownership of the skb, so the caller is
7256 * responsible for any cleanup. The caller must also ensure that
7257 * skb->protocol is set appropriately.
7258 * @unencrypted: Whether the frame was received unencrypted
7260 * This function is used to inform userspace about a received control port
7261 * frame. It should only be used if userspace indicated it wants to receive
7262 * control port frames over nl80211.
7264 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7265 * network layer headers removed (e.g. the raw EAPoL frame).
7267 * Return: %true if the frame was passed to userspace
7269 bool cfg80211_rx_control_port(struct net_device *dev,
7270 struct sk_buff *skb, bool unencrypted);
7273 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
7274 * @dev: network device
7275 * @rssi_event: the triggered RSSI event
7276 * @rssi_level: new RSSI level value or 0 if not available
7277 * @gfp: context flags
7279 * This function is called when a configured connection quality monitoring
7280 * rssi threshold reached event occurs.
7282 void cfg80211_cqm_rssi_notify(struct net_device *dev,
7283 enum nl80211_cqm_rssi_threshold_event rssi_event,
7284 s32 rssi_level, gfp_t gfp);
7287 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
7288 * @dev: network device
7289 * @peer: peer's MAC address
7290 * @num_packets: how many packets were lost -- should be a fixed threshold
7291 * but probably no less than maybe 50, or maybe a throughput dependent
7292 * threshold (to account for temporary interference)
7293 * @gfp: context flags
7295 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
7296 const u8 *peer, u32 num_packets, gfp_t gfp);
7299 * cfg80211_cqm_txe_notify - TX error rate event
7300 * @dev: network device
7301 * @peer: peer's MAC address
7302 * @num_packets: how many packets were lost
7303 * @rate: % of packets which failed transmission
7304 * @intvl: interval (in s) over which the TX failure threshold was breached.
7305 * @gfp: context flags
7307 * Notify userspace when configured % TX failures over number of packets in a
7308 * given interval is exceeded.
7310 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
7311 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
7314 * cfg80211_cqm_beacon_loss_notify - beacon loss event
7315 * @dev: network device
7316 * @gfp: context flags
7318 * Notify userspace about beacon loss from the connected AP.
7320 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
7323 * cfg80211_radar_event - radar detection event
7325 * @chandef: chandef for the current channel
7326 * @gfp: context flags
7328 * This function is called when a radar is detected on the current chanenl.
7330 void cfg80211_radar_event(struct wiphy *wiphy,
7331 struct cfg80211_chan_def *chandef, gfp_t gfp);
7334 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
7335 * @dev: network device
7336 * @mac: MAC address of a station which opmode got modified
7337 * @sta_opmode: station's current opmode value
7338 * @gfp: context flags
7340 * Driver should call this function when station's opmode modified via action
7343 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
7344 struct sta_opmode_info *sta_opmode,
7348 * cfg80211_cac_event - Channel availability check (CAC) event
7349 * @netdev: network device
7350 * @chandef: chandef for the current channel
7351 * @event: type of event
7352 * @gfp: context flags
7354 * This function is called when a Channel availability check (CAC) is finished
7355 * or aborted. This must be called to notify the completion of a CAC process,
7356 * also by full-MAC drivers.
7358 void cfg80211_cac_event(struct net_device *netdev,
7359 const struct cfg80211_chan_def *chandef,
7360 enum nl80211_radar_event event, gfp_t gfp);
7364 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
7365 * @dev: network device
7366 * @bssid: BSSID of AP (to avoid races)
7367 * @replay_ctr: new replay counter
7368 * @gfp: allocation flags
7370 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
7371 const u8 *replay_ctr, gfp_t gfp);
7374 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7375 * @dev: network device
7376 * @index: candidate index (the smaller the index, the higher the priority)
7377 * @bssid: BSSID of AP
7378 * @preauth: Whether AP advertises support for RSN pre-authentication
7379 * @gfp: allocation flags
7381 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
7382 const u8 *bssid, bool preauth, gfp_t gfp);
7385 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7386 * @dev: The device the frame matched to
7387 * @addr: the transmitter address
7388 * @gfp: context flags
7390 * This function is used in AP mode (only!) to inform userspace that
7391 * a spurious class 3 frame was received, to be able to deauth the
7393 * Return: %true if the frame was passed to userspace (or this failed
7394 * for a reason other than not having a subscription.)
7396 bool cfg80211_rx_spurious_frame(struct net_device *dev,
7397 const u8 *addr, gfp_t gfp);
7400 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7401 * @dev: The device the frame matched to
7402 * @addr: the transmitter address
7403 * @gfp: context flags
7405 * This function is used in AP mode (only!) to inform userspace that
7406 * an associated station sent a 4addr frame but that wasn't expected.
7407 * It is allowed and desirable to send this event only once for each
7408 * station to avoid event flooding.
7409 * Return: %true if the frame was passed to userspace (or this failed
7410 * for a reason other than not having a subscription.)
7412 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
7413 const u8 *addr, gfp_t gfp);
7416 * cfg80211_probe_status - notify userspace about probe status
7417 * @dev: the device the probe was sent on
7418 * @addr: the address of the peer
7419 * @cookie: the cookie filled in @probe_client previously
7420 * @acked: indicates whether probe was acked or not
7421 * @ack_signal: signal strength (in dBm) of the ACK frame.
7422 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7423 * @gfp: allocation flags
7425 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
7426 u64 cookie, bool acked, s32 ack_signal,
7427 bool is_valid_ack_signal, gfp_t gfp);
7430 * cfg80211_report_obss_beacon_khz - report beacon from other APs
7431 * @wiphy: The wiphy that received the beacon
7433 * @len: length of the frame
7434 * @freq: frequency the frame was received on in KHz
7435 * @sig_dbm: signal strength in dBm, or 0 if unknown
7437 * Use this function to report to userspace when a beacon was
7438 * received. It is not useful to call this when there is no
7439 * netdev that is in AP/GO mode.
7441 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
7442 size_t len, int freq, int sig_dbm);
7445 * cfg80211_report_obss_beacon - report beacon from other APs
7446 * @wiphy: The wiphy that received the beacon
7448 * @len: length of the frame
7449 * @freq: frequency the frame was received on
7450 * @sig_dbm: signal strength in dBm, or 0 if unknown
7452 * Use this function to report to userspace when a beacon was
7453 * received. It is not useful to call this when there is no
7454 * netdev that is in AP/GO mode.
7456 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7457 const u8 *frame, size_t len,
7458 int freq, int sig_dbm)
7460 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
7465 * cfg80211_reg_can_beacon - check if beaconing is allowed
7467 * @chandef: the channel definition
7468 * @iftype: interface type
7470 * Return: %true if there is no secondary channel or the secondary channel(s)
7471 * can be used for beaconing (i.e. is not a radar channel etc.)
7473 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7474 struct cfg80211_chan_def *chandef,
7475 enum nl80211_iftype iftype);
7478 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
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.). This version
7485 * also checks if IR-relaxation conditions apply, to allow beaconing under
7486 * more permissive conditions.
7488 * Requires the RTNL to be held.
7490 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7491 struct cfg80211_chan_def *chandef,
7492 enum nl80211_iftype iftype);
7495 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7496 * @dev: the device which switched channels
7497 * @chandef: the new channel definition
7499 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7502 void cfg80211_ch_switch_notify(struct net_device *dev,
7503 struct cfg80211_chan_def *chandef);
7506 * cfg80211_ch_switch_started_notify - notify channel switch start
7507 * @dev: the device on which the channel switch started
7508 * @chandef: the future channel definition
7509 * @count: the number of TBTTs until the channel switch happens
7511 * Inform the userspace about the channel switch that has just
7512 * started, so that it can take appropriate actions (eg. starting
7513 * channel switch on other vifs), if necessary.
7515 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7516 struct cfg80211_chan_def *chandef,
7520 * ieee80211_operating_class_to_band - convert operating class to band
7522 * @operating_class: the operating class to convert
7523 * @band: band pointer to fill
7525 * Returns %true if the conversion was successful, %false otherwise.
7527 bool ieee80211_operating_class_to_band(u8 operating_class,
7528 enum nl80211_band *band);
7531 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7533 * @chandef: the chandef to convert
7534 * @op_class: a pointer to the resulting operating class
7536 * Returns %true if the conversion was successful, %false otherwise.
7538 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7542 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
7544 * @chandef: the chandef to convert
7546 * Returns the center frequency of chandef (1st segment) in KHz.
7549 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
7551 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
7555 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7556 * @dev: the device on which the operation is requested
7557 * @peer: the MAC address of the peer device
7558 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7559 * NL80211_TDLS_TEARDOWN)
7560 * @reason_code: the reason code for teardown request
7561 * @gfp: allocation flags
7563 * This function is used to request userspace to perform TDLS operation that
7564 * requires knowledge of keys, i.e., link setup or teardown when the AP
7565 * connection uses encryption. This is optional mechanism for the driver to use
7566 * if it can automatically determine when a TDLS link could be useful (e.g.,
7567 * based on traffic and signal strength for a peer).
7569 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7570 enum nl80211_tdls_operation oper,
7571 u16 reason_code, gfp_t gfp);
7574 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7575 * @rate: given rate_info to calculate bitrate from
7577 * return 0 if MCS index >= 32
7579 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7582 * cfg80211_unregister_wdev - remove the given wdev
7583 * @wdev: struct wireless_dev to remove
7585 * Call this function only for wdevs that have no netdev assigned,
7586 * e.g. P2P Devices. It removes the device from the list so that
7587 * it can no longer be used. It is necessary to call this function
7588 * even when cfg80211 requests the removal of the interface by
7589 * calling the del_virtual_intf() callback. The function must also
7590 * be called when the driver wishes to unregister the wdev, e.g.
7591 * when the device is unbound from the driver.
7593 * Requires the RTNL to be held.
7595 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7598 * struct cfg80211_ft_event - FT Information Elements
7600 * @ies_len: length of the FT IE in bytes
7601 * @target_ap: target AP's MAC address
7603 * @ric_ies_len: length of the RIC IE in bytes
7605 struct cfg80211_ft_event_params {
7608 const u8 *target_ap;
7614 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7615 * @netdev: network device
7616 * @ft_event: IE information
7618 void cfg80211_ft_event(struct net_device *netdev,
7619 struct cfg80211_ft_event_params *ft_event);
7622 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7623 * @ies: the input IE buffer
7624 * @len: the input length
7625 * @attr: the attribute ID to find
7626 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7627 * if the function is only called to get the needed buffer size
7628 * @bufsize: size of the output buffer
7630 * The function finds a given P2P attribute in the (vendor) IEs and
7631 * copies its contents to the given buffer.
7633 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7634 * malformed or the attribute can't be found (respectively), or the
7635 * length of the found attribute (which can be zero).
7637 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7638 enum ieee80211_p2p_attr_id attr,
7639 u8 *buf, unsigned int bufsize);
7642 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7643 * @ies: the IE buffer
7644 * @ielen: the length of the IE buffer
7645 * @ids: an array with element IDs that are allowed before
7646 * the split. A WLAN_EID_EXTENSION value means that the next
7647 * EID in the list is a sub-element of the EXTENSION IE.
7648 * @n_ids: the size of the element ID array
7649 * @after_ric: array IE types that come after the RIC element
7650 * @n_after_ric: size of the @after_ric array
7651 * @offset: offset where to start splitting in the buffer
7653 * This function splits an IE buffer by updating the @offset
7654 * variable to point to the location where the buffer should be
7657 * It assumes that the given IE buffer is well-formed, this
7658 * has to be guaranteed by the caller!
7660 * It also assumes that the IEs in the buffer are ordered
7661 * correctly, if not the result of using this function will not
7662 * be ordered correctly either, i.e. it does no reordering.
7664 * The function returns the offset where the next part of the
7665 * buffer starts, which may be @ielen if the entire (remainder)
7666 * of the buffer should be used.
7668 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7669 const u8 *ids, int n_ids,
7670 const u8 *after_ric, int n_after_ric,
7674 * ieee80211_ie_split - split an IE buffer according to ordering
7675 * @ies: the IE buffer
7676 * @ielen: the length of the IE buffer
7677 * @ids: an array with element IDs that are allowed before
7678 * the split. A WLAN_EID_EXTENSION value means that the next
7679 * EID in the list is a sub-element of the EXTENSION IE.
7680 * @n_ids: the size of the element ID array
7681 * @offset: offset where to start splitting in the buffer
7683 * This function splits an IE buffer by updating the @offset
7684 * variable to point to the location where the buffer should be
7687 * It assumes that the given IE buffer is well-formed, this
7688 * has to be guaranteed by the caller!
7690 * It also assumes that the IEs in the buffer are ordered
7691 * correctly, if not the result of using this function will not
7692 * be ordered correctly either, i.e. it does no reordering.
7694 * The function returns the offset where the next part of the
7695 * buffer starts, which may be @ielen if the entire (remainder)
7696 * of the buffer should be used.
7698 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7699 const u8 *ids, int n_ids, size_t offset)
7701 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7705 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7706 * @wdev: the wireless device reporting the wakeup
7707 * @wakeup: the wakeup report
7708 * @gfp: allocation flags
7710 * This function reports that the given device woke up. If it
7711 * caused the wakeup, report the reason(s), otherwise you may
7712 * pass %NULL as the @wakeup parameter to advertise that something
7713 * else caused the wakeup.
7715 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7716 struct cfg80211_wowlan_wakeup *wakeup,
7720 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7722 * @wdev: the wireless device for which critical protocol is stopped.
7723 * @gfp: allocation flags
7725 * This function can be called by the driver to indicate it has reverted
7726 * operation back to normal. One reason could be that the duration given
7727 * by .crit_proto_start() has expired.
7729 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7732 * ieee80211_get_num_supported_channels - get number of channels device has
7735 * Return: the number of channels supported by the device.
7737 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7740 * cfg80211_check_combinations - check interface combinations
7743 * @params: the interface combinations parameter
7745 * This function can be called by the driver to check whether a
7746 * combination of interfaces and their types are allowed according to
7747 * the interface combinations.
7749 int cfg80211_check_combinations(struct wiphy *wiphy,
7750 struct iface_combination_params *params);
7753 * cfg80211_iter_combinations - iterate over matching combinations
7756 * @params: the interface combinations parameter
7757 * @iter: function to call for each matching combination
7758 * @data: pointer to pass to iter function
7760 * This function can be called by the driver to check what possible
7761 * combinations it fits in at a given moment, e.g. for channel switching
7764 int cfg80211_iter_combinations(struct wiphy *wiphy,
7765 struct iface_combination_params *params,
7766 void (*iter)(const struct ieee80211_iface_combination *c,
7771 * cfg80211_stop_iface - trigger interface disconnection
7774 * @wdev: wireless device
7775 * @gfp: context flags
7777 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7780 * Note: This doesn't need any locks and is asynchronous.
7782 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7786 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7787 * @wiphy: the wiphy to shut down
7789 * This function shuts down all interfaces belonging to this wiphy by
7790 * calling dev_close() (and treating non-netdev interfaces as needed).
7791 * It shouldn't really be used unless there are some fatal device errors
7792 * that really can't be recovered in any other way.
7794 * Callers must hold the RTNL and be able to deal with callbacks into
7795 * the driver while the function is running.
7797 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7800 * wiphy_ext_feature_set - set the extended feature flag
7802 * @wiphy: the wiphy to modify.
7803 * @ftidx: extended feature bit index.
7805 * The extended features are flagged in multiple bytes (see
7806 * &struct wiphy.@ext_features)
7808 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7809 enum nl80211_ext_feature_index ftidx)
7813 ft_byte = &wiphy->ext_features[ftidx / 8];
7814 *ft_byte |= BIT(ftidx % 8);
7818 * wiphy_ext_feature_isset - check the extended feature flag
7820 * @wiphy: the wiphy to modify.
7821 * @ftidx: extended feature bit index.
7823 * The extended features are flagged in multiple bytes (see
7824 * &struct wiphy.@ext_features)
7827 wiphy_ext_feature_isset(struct wiphy *wiphy,
7828 enum nl80211_ext_feature_index ftidx)
7832 ft_byte = wiphy->ext_features[ftidx / 8];
7833 return (ft_byte & BIT(ftidx % 8)) != 0;
7837 * cfg80211_free_nan_func - free NAN function
7838 * @f: NAN function that should be freed
7840 * Frees all the NAN function and all it's allocated members.
7842 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7845 * struct cfg80211_nan_match_params - NAN match parameters
7846 * @type: the type of the function that triggered a match. If it is
7847 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7848 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7850 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7851 * @inst_id: the local instance id
7852 * @peer_inst_id: the instance id of the peer's function
7853 * @addr: the MAC address of the peer
7854 * @info_len: the length of the &info
7855 * @info: the Service Specific Info from the peer (if any)
7856 * @cookie: unique identifier of the corresponding function
7858 struct cfg80211_nan_match_params {
7859 enum nl80211_nan_function_type type;
7869 * cfg80211_nan_match - report a match for a NAN function.
7870 * @wdev: the wireless device reporting the match
7871 * @match: match notification parameters
7872 * @gfp: allocation flags
7874 * This function reports that the a NAN function had a match. This
7875 * can be a subscribe that had a match or a solicited publish that
7876 * was sent. It can also be a follow up that was received.
7878 void cfg80211_nan_match(struct wireless_dev *wdev,
7879 struct cfg80211_nan_match_params *match, gfp_t gfp);
7882 * cfg80211_nan_func_terminated - notify about NAN function termination.
7884 * @wdev: the wireless device reporting the match
7885 * @inst_id: the local instance id
7886 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7887 * @cookie: unique NAN function identifier
7888 * @gfp: allocation flags
7890 * This function reports that the a NAN function is terminated.
7892 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7894 enum nl80211_nan_func_term_reason reason,
7895 u64 cookie, gfp_t gfp);
7897 /* ethtool helper */
7898 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7901 * cfg80211_external_auth_request - userspace request for authentication
7902 * @netdev: network device
7903 * @params: External authentication parameters
7904 * @gfp: allocation flags
7905 * Returns: 0 on success, < 0 on error
7907 int cfg80211_external_auth_request(struct net_device *netdev,
7908 struct cfg80211_external_auth_params *params,
7912 * cfg80211_pmsr_report - report peer measurement result data
7913 * @wdev: the wireless device reporting the measurement
7914 * @req: the original measurement request
7915 * @result: the result data
7916 * @gfp: allocation flags
7918 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7919 struct cfg80211_pmsr_request *req,
7920 struct cfg80211_pmsr_result *result,
7924 * cfg80211_pmsr_complete - report peer measurement completed
7925 * @wdev: the wireless device reporting the measurement
7926 * @req: the original measurement request
7927 * @gfp: allocation flags
7929 * Report that the entire measurement completed, after this
7930 * the request pointer will no longer be valid.
7932 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7933 struct cfg80211_pmsr_request *req,
7937 * cfg80211_iftype_allowed - check whether the interface can be allowed
7939 * @iftype: interface type
7940 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7941 * @check_swif: check iftype against software interfaces
7943 * Check whether the interface is allowed to operate; additionally, this API
7944 * can be used to check iftype against the software interfaces when
7945 * check_swif is '1'.
7947 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
7948 bool is_4addr, u8 check_swif);
7951 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7953 /* wiphy_printk helpers, similar to dev_printk */
7955 #define wiphy_printk(level, wiphy, format, args...) \
7956 dev_printk(level, &(wiphy)->dev, format, ##args)
7957 #define wiphy_emerg(wiphy, format, args...) \
7958 dev_emerg(&(wiphy)->dev, format, ##args)
7959 #define wiphy_alert(wiphy, format, args...) \
7960 dev_alert(&(wiphy)->dev, format, ##args)
7961 #define wiphy_crit(wiphy, format, args...) \
7962 dev_crit(&(wiphy)->dev, format, ##args)
7963 #define wiphy_err(wiphy, format, args...) \
7964 dev_err(&(wiphy)->dev, format, ##args)
7965 #define wiphy_warn(wiphy, format, args...) \
7966 dev_warn(&(wiphy)->dev, format, ##args)
7967 #define wiphy_notice(wiphy, format, args...) \
7968 dev_notice(&(wiphy)->dev, format, ##args)
7969 #define wiphy_info(wiphy, format, args...) \
7970 dev_info(&(wiphy)->dev, format, ##args)
7972 #define wiphy_err_ratelimited(wiphy, format, args...) \
7973 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7974 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7975 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7977 #define wiphy_debug(wiphy, format, args...) \
7978 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7980 #define wiphy_dbg(wiphy, format, args...) \
7981 dev_dbg(&(wiphy)->dev, format, ##args)
7983 #if defined(VERBOSE_DEBUG)
7984 #define wiphy_vdbg wiphy_dbg
7986 #define wiphy_vdbg(wiphy, format, args...) \
7989 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
7995 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7996 * of using a WARN/WARN_ON to get the message out, including the
7997 * file/line information and a backtrace.
7999 #define wiphy_WARN(wiphy, format, args...) \
8000 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8003 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8004 * @netdev: network device
8005 * @owe_info: peer's owe info
8006 * @gfp: allocation flags
8008 void cfg80211_update_owe_info_event(struct net_device *netdev,
8009 struct cfg80211_update_owe_info *owe_info,
8013 * cfg80211_bss_flush - resets all the scan entries
8016 void cfg80211_bss_flush(struct wiphy *wiphy);
8018 #endif /* __NET_CFG80211_H */