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.
101 enum ieee80211_channel_flags {
102 IEEE80211_CHAN_DISABLED = 1<<0,
103 IEEE80211_CHAN_NO_IR = 1<<1,
105 IEEE80211_CHAN_RADAR = 1<<3,
106 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
107 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
108 IEEE80211_CHAN_NO_OFDM = 1<<6,
109 IEEE80211_CHAN_NO_80MHZ = 1<<7,
110 IEEE80211_CHAN_NO_160MHZ = 1<<8,
111 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
112 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
113 IEEE80211_CHAN_NO_20MHZ = 1<<11,
114 IEEE80211_CHAN_NO_10MHZ = 1<<12,
115 IEEE80211_CHAN_NO_HE = 1<<13,
118 #define IEEE80211_CHAN_NO_HT40 \
119 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
121 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
122 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
125 * struct ieee80211_channel - channel definition
127 * This structure describes a single channel for use
130 * @center_freq: center frequency in MHz
131 * @freq_offset: offset from @center_freq, in KHz
132 * @hw_value: hardware-specific value for the channel
133 * @flags: channel flags from &enum ieee80211_channel_flags.
134 * @orig_flags: channel flags at registration time, used by regulatory
135 * code to support devices with additional restrictions
136 * @band: band this channel belongs to.
137 * @max_antenna_gain: maximum antenna gain in dBi
138 * @max_power: maximum transmission power (in dBm)
139 * @max_reg_power: maximum regulatory transmission power (in dBm)
140 * @beacon_found: helper to regulatory code to indicate when a beacon
141 * has been found on this channel. Use regulatory_hint_found_beacon()
142 * to enable this, this is useful only on 5 GHz band.
143 * @orig_mag: internal use
144 * @orig_mpwr: internal use
145 * @dfs_state: current state of this channel. Only relevant if radar is required
147 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
148 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
150 struct ieee80211_channel {
151 enum nl80211_band band;
156 int max_antenna_gain;
161 int orig_mag, orig_mpwr;
162 enum nl80211_dfs_state dfs_state;
163 unsigned long dfs_state_entered;
164 unsigned int dfs_cac_ms;
168 * enum ieee80211_rate_flags - rate flags
170 * Hardware/specification flags for rates. These are structured
171 * in a way that allows using the same bitrate structure for
172 * different bands/PHY modes.
174 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
175 * preamble on this bitrate; only relevant in 2.4GHz band and
177 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
178 * when used with 802.11a (on the 5 GHz band); filled by the
179 * core code when registering the wiphy.
180 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
181 * when used with 802.11b (on the 2.4 GHz band); filled by the
182 * core code when registering the wiphy.
183 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
184 * when used with 802.11g (on the 2.4 GHz band); filled by the
185 * core code when registering the wiphy.
186 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
187 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
188 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
190 enum ieee80211_rate_flags {
191 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
192 IEEE80211_RATE_MANDATORY_A = 1<<1,
193 IEEE80211_RATE_MANDATORY_B = 1<<2,
194 IEEE80211_RATE_MANDATORY_G = 1<<3,
195 IEEE80211_RATE_ERP_G = 1<<4,
196 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
197 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
201 * enum ieee80211_bss_type - BSS type filter
203 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
204 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
205 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
206 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
207 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
209 enum ieee80211_bss_type {
210 IEEE80211_BSS_TYPE_ESS,
211 IEEE80211_BSS_TYPE_PBSS,
212 IEEE80211_BSS_TYPE_IBSS,
213 IEEE80211_BSS_TYPE_MBSS,
214 IEEE80211_BSS_TYPE_ANY
218 * enum ieee80211_privacy - BSS privacy filter
220 * @IEEE80211_PRIVACY_ON: privacy bit set
221 * @IEEE80211_PRIVACY_OFF: privacy bit clear
222 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
224 enum ieee80211_privacy {
225 IEEE80211_PRIVACY_ON,
226 IEEE80211_PRIVACY_OFF,
227 IEEE80211_PRIVACY_ANY
230 #define IEEE80211_PRIVACY(x) \
231 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
234 * struct ieee80211_rate - bitrate definition
236 * This structure describes a bitrate that an 802.11 PHY can
237 * operate with. The two values @hw_value and @hw_value_short
238 * are only for driver use when pointers to this structure are
241 * @flags: rate-specific flags
242 * @bitrate: bitrate in units of 100 Kbps
243 * @hw_value: driver/hardware value for this rate
244 * @hw_value_short: driver/hardware value for this rate when
245 * short preamble is used
247 struct ieee80211_rate {
250 u16 hw_value, hw_value_short;
254 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
256 * @enable: is the feature enabled.
257 * @min_offset: minimal tx power offset an associated station shall use
258 * @max_offset: maximum tx power offset an associated station shall use
260 struct ieee80211_he_obss_pd {
267 * struct cfg80211_he_bss_color - AP settings for BSS coloring
269 * @color: the current color.
270 * @disabled: is the feature disabled.
271 * @partial: define the AID equation.
273 struct cfg80211_he_bss_color {
280 * struct ieee80211_he_bss_color - AP settings for BSS coloring
282 * @color: the current color.
283 * @disabled: is the feature disabled.
284 * @partial: define the AID equation.
286 struct ieee80211_he_bss_color {
293 * struct ieee80211_sta_ht_cap - STA's HT capabilities
295 * This structure describes most essential parameters needed
296 * to describe 802.11n HT capabilities for an STA.
298 * @ht_supported: is HT supported by the STA
299 * @cap: HT capabilities map as described in 802.11n spec
300 * @ampdu_factor: Maximum A-MPDU length factor
301 * @ampdu_density: Minimum A-MPDU spacing
302 * @mcs: Supported MCS rates
304 struct ieee80211_sta_ht_cap {
305 u16 cap; /* use IEEE80211_HT_CAP_ */
309 struct ieee80211_mcs_info mcs;
313 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
315 * This structure describes most essential parameters needed
316 * to describe 802.11ac VHT capabilities for an STA.
318 * @vht_supported: is VHT supported by the STA
319 * @cap: VHT capabilities map as described in 802.11ac spec
320 * @vht_mcs: Supported VHT MCS rates
322 struct ieee80211_sta_vht_cap {
324 u32 cap; /* use IEEE80211_VHT_CAP_ */
325 struct ieee80211_vht_mcs_info vht_mcs;
328 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
331 * struct ieee80211_sta_he_cap - STA's HE capabilities
333 * This structure describes most essential parameters needed
334 * to describe 802.11ax HE capabilities for a STA.
336 * @has_he: true iff HE data is valid.
337 * @he_cap_elem: Fixed portion of the HE capabilities element.
338 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
339 * @ppe_thres: Holds the PPE Thresholds data.
341 struct ieee80211_sta_he_cap {
343 struct ieee80211_he_cap_elem he_cap_elem;
344 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
345 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
349 * struct ieee80211_sband_iftype_data
351 * This structure encapsulates sband data that is relevant for the
352 * interface types defined in @types_mask. Each type in the
353 * @types_mask must be unique across all instances of iftype_data.
355 * @types_mask: interface types mask
356 * @he_cap: holds the HE capabilities
357 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
358 * 6 GHz band channel (and 0 may be valid value).
360 struct ieee80211_sband_iftype_data {
362 struct ieee80211_sta_he_cap he_cap;
363 struct ieee80211_he_6ghz_capa he_6ghz_capa;
367 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
369 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
370 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
371 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
372 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
373 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
374 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
375 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
376 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
378 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
380 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
382 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
383 * and 4.32GHz + 4.32GHz
384 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
385 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
387 enum ieee80211_edmg_bw_config {
388 IEEE80211_EDMG_BW_CONFIG_4 = 4,
389 IEEE80211_EDMG_BW_CONFIG_5 = 5,
390 IEEE80211_EDMG_BW_CONFIG_6 = 6,
391 IEEE80211_EDMG_BW_CONFIG_7 = 7,
392 IEEE80211_EDMG_BW_CONFIG_8 = 8,
393 IEEE80211_EDMG_BW_CONFIG_9 = 9,
394 IEEE80211_EDMG_BW_CONFIG_10 = 10,
395 IEEE80211_EDMG_BW_CONFIG_11 = 11,
396 IEEE80211_EDMG_BW_CONFIG_12 = 12,
397 IEEE80211_EDMG_BW_CONFIG_13 = 13,
398 IEEE80211_EDMG_BW_CONFIG_14 = 14,
399 IEEE80211_EDMG_BW_CONFIG_15 = 15,
403 * struct ieee80211_edmg - EDMG configuration
405 * This structure describes most essential parameters needed
406 * to describe 802.11ay EDMG configuration
408 * @channels: bitmap that indicates the 2.16 GHz channel(s)
409 * that are allowed to be used for transmissions.
410 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
411 * Set to 0 indicate EDMG not supported.
412 * @bw_config: Channel BW Configuration subfield encodes
413 * the allowed channel bandwidth configurations
415 struct ieee80211_edmg {
417 enum ieee80211_edmg_bw_config bw_config;
421 * struct ieee80211_supported_band - frequency band definition
423 * This structure describes a frequency band a wiphy
424 * is able to operate in.
426 * @channels: Array of channels the hardware can operate in
428 * @band: the band this structure represents
429 * @n_channels: Number of channels in @channels
430 * @bitrates: Array of bitrates the hardware can operate with
431 * in this band. Must be sorted to give a valid "supported
432 * rates" IE, i.e. CCK rates first, then OFDM.
433 * @n_bitrates: Number of bitrates in @bitrates
434 * @ht_cap: HT capabilities in this band
435 * @vht_cap: VHT capabilities in this band
436 * @edmg_cap: EDMG capabilities in this band
437 * @n_iftype_data: number of iftype data entries
438 * @iftype_data: interface type data entries. Note that the bits in
439 * @types_mask inside this structure cannot overlap (i.e. only
440 * one occurrence of each type is allowed across all instances of
443 struct ieee80211_supported_band {
444 struct ieee80211_channel *channels;
445 struct ieee80211_rate *bitrates;
446 enum nl80211_band band;
449 struct ieee80211_sta_ht_cap ht_cap;
450 struct ieee80211_sta_vht_cap vht_cap;
451 struct ieee80211_edmg edmg_cap;
453 const struct ieee80211_sband_iftype_data *iftype_data;
457 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
458 * @sband: the sband to search for the STA on
459 * @iftype: enum nl80211_iftype
461 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
463 static inline const struct ieee80211_sband_iftype_data *
464 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
469 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
472 for (i = 0; i < sband->n_iftype_data; i++) {
473 const struct ieee80211_sband_iftype_data *data =
474 &sband->iftype_data[i];
476 if (data->types_mask & BIT(iftype))
484 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
485 * @sband: the sband to search for the iftype on
486 * @iftype: enum nl80211_iftype
488 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
490 static inline const struct ieee80211_sta_he_cap *
491 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
494 const struct ieee80211_sband_iftype_data *data =
495 ieee80211_get_sband_iftype_data(sband, iftype);
497 if (data && data->he_cap.has_he)
498 return &data->he_cap;
504 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
505 * @sband: the sband to search for the STA on
507 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
509 static inline const struct ieee80211_sta_he_cap *
510 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
512 return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
516 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
517 * @sband: the sband to search for the STA on
518 * @iftype: the iftype to search for
520 * Return: the 6GHz capabilities
523 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
524 enum nl80211_iftype iftype)
526 const struct ieee80211_sband_iftype_data *data =
527 ieee80211_get_sband_iftype_data(sband, iftype);
529 if (WARN_ON(!data || !data->he_cap.has_he))
532 return data->he_6ghz_capa.capa;
536 * wiphy_read_of_freq_limits - read frequency limits from device tree
538 * @wiphy: the wireless device to get extra limits for
540 * Some devices may have extra limitations specified in DT. This may be useful
541 * for chipsets that normally support more bands but are limited due to board
542 * design (e.g. by antennas or external power amplifier).
544 * This function reads info from DT and uses it to *modify* channels (disable
545 * unavailable ones). It's usually a *bad* idea to use it in drivers with
546 * shared channel data as DT limitations are device specific. You should make
547 * sure to call it only if channels in wiphy are copied and can be modified
548 * without affecting other devices.
550 * As this function access device node it has to be called after set_wiphy_dev.
551 * It also modifies channels so they have to be set first.
552 * If using this helper, call it before wiphy_register().
555 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
556 #else /* CONFIG_OF */
557 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
560 #endif /* !CONFIG_OF */
564 * Wireless hardware/device configuration structures and methods
568 * DOC: Actions and configuration
570 * Each wireless device and each virtual interface offer a set of configuration
571 * operations and other actions that are invoked by userspace. Each of these
572 * actions is described in the operations structure, and the parameters these
573 * operations use are described separately.
575 * Additionally, some operations are asynchronous and expect to get status
576 * information via some functions that drivers need to call.
578 * Scanning and BSS list handling with its associated functionality is described
579 * in a separate chapter.
582 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
583 WLAN_USER_POSITION_LEN)
586 * struct vif_params - describes virtual interface parameters
587 * @flags: monitor interface flags, unchanged if 0, otherwise
588 * %MONITOR_FLAG_CHANGED will be set
589 * @use_4addr: use 4-address frames
590 * @macaddr: address to use for this virtual interface.
591 * If this parameter is set to zero address the driver may
592 * determine the address as needed.
593 * This feature is only fully supported by drivers that enable the
594 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
595 ** only p2p devices with specified MAC.
596 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
597 * belonging to that MU-MIMO groupID; %NULL if not changed
598 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
599 * MU-MIMO packets going to the specified station; %NULL if not changed
604 u8 macaddr[ETH_ALEN];
605 const u8 *vht_mumimo_groups;
606 const u8 *vht_mumimo_follow_addr;
610 * struct key_params - key information
612 * Information about a key
615 * @key_len: length of key material
616 * @cipher: cipher suite selector
617 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
618 * with the get_key() callback, must be in little endian,
619 * length given by @seq_len.
620 * @seq_len: length of @seq.
621 * @vlan_id: vlan_id for VLAN group key (if nonzero)
622 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
631 enum nl80211_key_mode mode;
635 * struct cfg80211_chan_def - channel definition
636 * @chan: the (control) channel
637 * @width: channel width
638 * @center_freq1: center frequency of first segment
639 * @center_freq2: center frequency of second segment
640 * (only with 80+80 MHz)
641 * @edmg: define the EDMG channels configuration.
642 * If edmg is requested (i.e. the .channels member is non-zero),
643 * chan will define the primary channel and all other
644 * parameters are ignored.
645 * @freq1_offset: offset from @center_freq1, in KHz
647 struct cfg80211_chan_def {
648 struct ieee80211_channel *chan;
649 enum nl80211_chan_width width;
652 struct ieee80211_edmg edmg;
657 * cfg80211_bitrate_mask - masks for bitrate control
659 struct cfg80211_bitrate_mask {
662 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
663 u16 vht_mcs[NL80211_VHT_NSS_MAX];
664 enum nl80211_txrate_gi gi;
665 } control[NUM_NL80211_BANDS];
670 * struct cfg80211_tid_cfg - TID specific configuration
671 * @config_override: Flag to notify driver to reset TID configuration
673 * @tids: bitmap of TIDs to modify
674 * @mask: bitmap of attributes indicating which parameter changed,
675 * similar to &nl80211_tid_config_supp.
676 * @noack: noack configuration value for the TID
677 * @retry_long: retry count value
678 * @retry_short: retry count value
679 * @ampdu: Enable/Disable MPDU aggregation
680 * @rtscts: Enable/Disable RTS/CTS
681 * @amsdu: Enable/Disable MSDU aggregation
682 * @txrate_type: Tx bitrate mask type
683 * @txrate_mask: Tx bitrate to be applied for the TID
685 struct cfg80211_tid_cfg {
686 bool config_override;
689 enum nl80211_tid_config noack;
690 u8 retry_long, retry_short;
691 enum nl80211_tid_config ampdu;
692 enum nl80211_tid_config rtscts;
693 enum nl80211_tid_config amsdu;
694 enum nl80211_tx_rate_setting txrate_type;
695 struct cfg80211_bitrate_mask txrate_mask;
699 * struct cfg80211_tid_config - TID configuration
700 * @peer: Station's MAC address
701 * @n_tid_conf: Number of TID specific configurations to be applied
702 * @tid_conf: Configuration change info
704 struct cfg80211_tid_config {
707 struct cfg80211_tid_cfg tid_conf[];
711 * cfg80211_get_chandef_type - return old channel type from chandef
712 * @chandef: the channel definition
714 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
715 * chandef, which must have a bandwidth allowing this conversion.
717 static inline enum nl80211_channel_type
718 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
720 switch (chandef->width) {
721 case NL80211_CHAN_WIDTH_20_NOHT:
722 return NL80211_CHAN_NO_HT;
723 case NL80211_CHAN_WIDTH_20:
724 return NL80211_CHAN_HT20;
725 case NL80211_CHAN_WIDTH_40:
726 if (chandef->center_freq1 > chandef->chan->center_freq)
727 return NL80211_CHAN_HT40PLUS;
728 return NL80211_CHAN_HT40MINUS;
731 return NL80211_CHAN_NO_HT;
736 * cfg80211_chandef_create - create channel definition using channel type
737 * @chandef: the channel definition struct to fill
738 * @channel: the control channel
739 * @chantype: the channel type
741 * Given a channel type, create a channel definition.
743 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
744 struct ieee80211_channel *channel,
745 enum nl80211_channel_type chantype);
748 * cfg80211_chandef_identical - check if two channel definitions are identical
749 * @chandef1: first channel definition
750 * @chandef2: second channel definition
752 * Return: %true if the channels defined by the channel definitions are
753 * identical, %false otherwise.
756 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
757 const struct cfg80211_chan_def *chandef2)
759 return (chandef1->chan == chandef2->chan &&
760 chandef1->width == chandef2->width &&
761 chandef1->center_freq1 == chandef2->center_freq1 &&
762 chandef1->freq1_offset == chandef2->freq1_offset &&
763 chandef1->center_freq2 == chandef2->center_freq2);
767 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
769 * @chandef: the channel definition
771 * Return: %true if EDMG defined, %false otherwise.
774 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
776 return chandef->edmg.channels || chandef->edmg.bw_config;
780 * cfg80211_chandef_compatible - check if two channel definitions are compatible
781 * @chandef1: first channel definition
782 * @chandef2: second channel definition
784 * Return: %NULL if the given channel definitions are incompatible,
785 * chandef1 or chandef2 otherwise.
787 const struct cfg80211_chan_def *
788 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
789 const struct cfg80211_chan_def *chandef2);
792 * cfg80211_chandef_valid - check if a channel definition is valid
793 * @chandef: the channel definition to check
794 * Return: %true if the channel definition is valid. %false otherwise.
796 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
799 * cfg80211_chandef_usable - check if secondary channels can be used
800 * @wiphy: the wiphy to validate against
801 * @chandef: the channel definition to check
802 * @prohibited_flags: the regulatory channel flags that must not be set
803 * Return: %true if secondary channels are usable. %false otherwise.
805 bool cfg80211_chandef_usable(struct wiphy *wiphy,
806 const struct cfg80211_chan_def *chandef,
807 u32 prohibited_flags);
810 * cfg80211_chandef_dfs_required - checks if radar detection is required
811 * @wiphy: the wiphy to validate against
812 * @chandef: the channel definition to check
813 * @iftype: the interface type as specified in &enum nl80211_iftype
815 * 1 if radar detection is required, 0 if it is not, < 0 on error
817 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
818 const struct cfg80211_chan_def *chandef,
819 enum nl80211_iftype iftype);
822 * ieee80211_chandef_rate_flags - returns rate flags for a channel
824 * In some channel types, not all rates may be used - for example CCK
825 * rates may not be used in 5/10 MHz channels.
827 * @chandef: channel definition for the channel
829 * Returns: rate flags which apply for this channel
831 static inline enum ieee80211_rate_flags
832 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
834 switch (chandef->width) {
835 case NL80211_CHAN_WIDTH_5:
836 return IEEE80211_RATE_SUPPORTS_5MHZ;
837 case NL80211_CHAN_WIDTH_10:
838 return IEEE80211_RATE_SUPPORTS_10MHZ;
846 * ieee80211_chandef_max_power - maximum transmission power for the chandef
848 * In some regulations, the transmit power may depend on the configured channel
849 * bandwidth which may be defined as dBm/MHz. This function returns the actual
850 * max_power for non-standard (20 MHz) channels.
852 * @chandef: channel definition for the channel
854 * Returns: maximum allowed transmission power in dBm for the chandef
857 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
859 switch (chandef->width) {
860 case NL80211_CHAN_WIDTH_5:
861 return min(chandef->chan->max_reg_power - 6,
862 chandef->chan->max_power);
863 case NL80211_CHAN_WIDTH_10:
864 return min(chandef->chan->max_reg_power - 3,
865 chandef->chan->max_power);
869 return chandef->chan->max_power;
873 * enum survey_info_flags - survey information flags
875 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
876 * @SURVEY_INFO_IN_USE: channel is currently being used
877 * @SURVEY_INFO_TIME: active time (in ms) was filled in
878 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
879 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
880 * @SURVEY_INFO_TIME_RX: receive time was filled in
881 * @SURVEY_INFO_TIME_TX: transmit time was filled in
882 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
883 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
885 * Used by the driver to indicate which info in &struct survey_info
886 * it has filled in during the get_survey().
888 enum survey_info_flags {
889 SURVEY_INFO_NOISE_DBM = BIT(0),
890 SURVEY_INFO_IN_USE = BIT(1),
891 SURVEY_INFO_TIME = BIT(2),
892 SURVEY_INFO_TIME_BUSY = BIT(3),
893 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
894 SURVEY_INFO_TIME_RX = BIT(5),
895 SURVEY_INFO_TIME_TX = BIT(6),
896 SURVEY_INFO_TIME_SCAN = BIT(7),
897 SURVEY_INFO_TIME_BSS_RX = BIT(8),
901 * struct survey_info - channel survey response
903 * @channel: the channel this survey record reports, may be %NULL for a single
904 * record to report global statistics
905 * @filled: bitflag of flags from &enum survey_info_flags
906 * @noise: channel noise in dBm. This and all following fields are
908 * @time: amount of time in ms the radio was turn on (on the channel)
909 * @time_busy: amount of time the primary channel was sensed busy
910 * @time_ext_busy: amount of time the extension channel was sensed busy
911 * @time_rx: amount of time the radio spent receiving data
912 * @time_tx: amount of time the radio spent transmitting data
913 * @time_scan: amount of time the radio spent for scanning
914 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
916 * Used by dump_survey() to report back per-channel survey information.
918 * This structure can later be expanded with things like
919 * channel duty cycle etc.
922 struct ieee80211_channel *channel;
934 #define CFG80211_MAX_WEP_KEYS 4
937 * struct cfg80211_crypto_settings - Crypto settings
938 * @wpa_versions: indicates which, if any, WPA versions are enabled
939 * (from enum nl80211_wpa_versions)
940 * @cipher_group: group key cipher suite (or 0 if unset)
941 * @n_ciphers_pairwise: number of AP supported unicast ciphers
942 * @ciphers_pairwise: unicast key cipher suites
943 * @n_akm_suites: number of AKM suites
944 * @akm_suites: AKM suites
945 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
946 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
947 * required to assume that the port is unauthorized until authorized by
948 * user space. Otherwise, port is marked authorized by default.
949 * @control_port_ethertype: the control port protocol that should be
950 * allowed through even on unauthorized ports
951 * @control_port_no_encrypt: TRUE to prevent encryption of control port
953 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
954 * port frames over NL80211 instead of the network interface.
955 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
957 * @wep_keys: static WEP keys, if not NULL points to an array of
958 * CFG80211_MAX_WEP_KEYS WEP keys
959 * @wep_tx_key: key index (0..3) of the default TX static WEP key
960 * @psk: PSK (for devices supporting 4-way-handshake offload)
961 * @sae_pwd: password for SAE authentication (for devices supporting SAE
963 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
965 struct cfg80211_crypto_settings {
968 int n_ciphers_pairwise;
969 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
971 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
973 __be16 control_port_ethertype;
974 bool control_port_no_encrypt;
975 bool control_port_over_nl80211;
976 bool control_port_no_preauth;
977 struct key_params *wep_keys;
985 * struct cfg80211_beacon_data - beacon data
986 * @head: head portion of beacon (before TIM IE)
987 * or %NULL if not changed
988 * @tail: tail portion of beacon (after TIM IE)
989 * or %NULL if not changed
990 * @head_len: length of @head
991 * @tail_len: length of @tail
992 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
993 * @beacon_ies_len: length of beacon_ies in octets
994 * @proberesp_ies: extra information element(s) to add into Probe Response
996 * @proberesp_ies_len: length of proberesp_ies in octets
997 * @assocresp_ies: extra information element(s) to add into (Re)Association
998 * Response frames or %NULL
999 * @assocresp_ies_len: length of assocresp_ies in octets
1000 * @probe_resp_len: length of probe response template (@probe_resp)
1001 * @probe_resp: probe response template (AP mode only)
1002 * @ftm_responder: enable FTM responder functionality; -1 for no change
1003 * (which also implies no change in LCI/civic location data)
1004 * @lci: Measurement Report element content, starting with Measurement Token
1005 * (measurement type 8)
1006 * @civicloc: Measurement Report element content, starting with Measurement
1007 * Token (measurement type 11)
1008 * @lci_len: LCI data length
1009 * @civicloc_len: Civic location data length
1011 struct cfg80211_beacon_data {
1012 const u8 *head, *tail;
1013 const u8 *beacon_ies;
1014 const u8 *proberesp_ies;
1015 const u8 *assocresp_ies;
1016 const u8 *probe_resp;
1021 size_t head_len, tail_len;
1022 size_t beacon_ies_len;
1023 size_t proberesp_ies_len;
1024 size_t assocresp_ies_len;
1025 size_t probe_resp_len;
1027 size_t civicloc_len;
1030 struct mac_address {
1035 * struct cfg80211_acl_data - Access control list data
1037 * @acl_policy: ACL policy to be applied on the station's
1038 * entry specified by mac_addr
1039 * @n_acl_entries: Number of MAC address entries passed
1040 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1042 struct cfg80211_acl_data {
1043 enum nl80211_acl_policy acl_policy;
1047 struct mac_address mac_addrs[];
1051 * enum cfg80211_ap_settings_flags - AP settings flags
1053 * Used by cfg80211_ap_settings
1055 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
1057 enum cfg80211_ap_settings_flags {
1058 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
1062 * struct cfg80211_ap_settings - AP configuration
1064 * Used to configure an AP interface.
1066 * @chandef: defines the channel to use
1067 * @beacon: beacon data
1068 * @beacon_interval: beacon interval
1069 * @dtim_period: DTIM period
1070 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1072 * @ssid_len: length of @ssid
1073 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1074 * @crypto: crypto settings
1075 * @privacy: the BSS uses privacy
1076 * @auth_type: Authentication type (algorithm)
1077 * @smps_mode: SMPS mode
1078 * @inactivity_timeout: time in seconds to determine station's inactivity.
1079 * @p2p_ctwindow: P2P CT Window
1080 * @p2p_opp_ps: P2P opportunistic PS
1081 * @acl: ACL configuration used by the drivers which has support for
1082 * MAC address based access control
1083 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1085 * @beacon_rate: bitrate to be used for beacons
1086 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1087 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1088 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1089 * @ht_required: stations must support HT
1090 * @vht_required: stations must support VHT
1091 * @twt_responder: Enable Target Wait Time
1092 * @he_required: stations must support HE
1093 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1094 * @he_obss_pd: OBSS Packet Detection settings
1095 * @he_bss_color: BSS Color settings
1096 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1098 struct cfg80211_ap_settings {
1099 struct cfg80211_chan_def chandef;
1101 struct cfg80211_beacon_data beacon;
1103 int beacon_interval, dtim_period;
1106 enum nl80211_hidden_ssid hidden_ssid;
1107 struct cfg80211_crypto_settings crypto;
1109 enum nl80211_auth_type auth_type;
1110 enum nl80211_smps_mode smps_mode;
1111 int inactivity_timeout;
1114 const struct cfg80211_acl_data *acl;
1116 struct cfg80211_bitrate_mask beacon_rate;
1118 const struct ieee80211_ht_cap *ht_cap;
1119 const struct ieee80211_vht_cap *vht_cap;
1120 const struct ieee80211_he_cap_elem *he_cap;
1121 const struct ieee80211_he_operation *he_oper;
1122 bool ht_required, vht_required, he_required;
1125 struct ieee80211_he_obss_pd he_obss_pd;
1126 struct cfg80211_he_bss_color he_bss_color;
1130 * struct cfg80211_csa_settings - channel switch settings
1132 * Used for channel switch
1134 * @chandef: defines the channel to use after the switch
1135 * @beacon_csa: beacon data while performing the switch
1136 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1137 * @counter_offsets_presp: offsets of the counters within the probe response
1138 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1139 * @n_counter_offsets_presp: number of csa counters in the probe response
1140 * @beacon_after: beacon data to be used on the new channel
1141 * @radar_required: whether radar detection is required on the new channel
1142 * @block_tx: whether transmissions should be blocked while changing
1143 * @count: number of beacons until switch
1145 struct cfg80211_csa_settings {
1146 struct cfg80211_chan_def chandef;
1147 struct cfg80211_beacon_data beacon_csa;
1148 const u16 *counter_offsets_beacon;
1149 const u16 *counter_offsets_presp;
1150 unsigned int n_counter_offsets_beacon;
1151 unsigned int n_counter_offsets_presp;
1152 struct cfg80211_beacon_data beacon_after;
1153 bool radar_required;
1158 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1161 * struct iface_combination_params - input parameters for interface combinations
1163 * Used to pass interface combination parameters
1165 * @num_different_channels: the number of different channels we want
1166 * to use for verification
1167 * @radar_detect: a bitmap where each bit corresponds to a channel
1168 * width where radar detection is needed, as in the definition of
1169 * &struct ieee80211_iface_combination.@radar_detect_widths
1170 * @iftype_num: array with the number of interfaces of each interface
1171 * type. The index is the interface type as specified in &enum
1173 * @new_beacon_int: set this to the beacon interval of a new interface
1174 * that's not operating yet, if such is to be checked as part of
1177 struct iface_combination_params {
1178 int num_different_channels;
1180 int iftype_num[NUM_NL80211_IFTYPES];
1185 * enum station_parameters_apply_mask - station parameter values to apply
1186 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1187 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1188 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1190 * Not all station parameters have in-band "no change" signalling,
1191 * for those that don't these flags will are used.
1193 enum station_parameters_apply_mask {
1194 STATION_PARAM_APPLY_UAPSD = BIT(0),
1195 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1196 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1197 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1201 * struct sta_txpwr - station txpower configuration
1203 * Used to configure txpower for station.
1205 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1206 * is not provided, the default per-interface tx power setting will be
1207 * overriding. Driver should be picking up the lowest tx power, either tx
1208 * power per-interface or per-station.
1209 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1210 * will be less than or equal to specified from userspace, whereas if TPC
1211 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1212 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1217 enum nl80211_tx_power_setting type;
1221 * struct station_parameters - station parameters
1223 * Used to change and create a new station.
1225 * @vlan: vlan interface station should belong to
1226 * @supported_rates: supported rates in IEEE 802.11 format
1227 * (or NULL for no change)
1228 * @supported_rates_len: number of supported rates
1229 * @sta_flags_mask: station flags that changed
1230 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1231 * @sta_flags_set: station flags values
1232 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1233 * @listen_interval: listen interval or -1 for no change
1234 * @aid: AID or zero for no change
1235 * @vlan_id: VLAN ID for station (if nonzero)
1236 * @peer_aid: mesh peer AID or zero for no change
1237 * @plink_action: plink action to take
1238 * @plink_state: set the peer link state for a station
1239 * @ht_capa: HT capabilities of station
1240 * @vht_capa: VHT capabilities of station
1241 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1242 * as the AC bitmap in the QoS info field
1243 * @max_sp: max Service Period. same format as the MAX_SP in the
1244 * QoS info field (but already shifted down)
1245 * @sta_modify_mask: bitmap indicating which parameters changed
1246 * (for those that don't have a natural "no change" value),
1247 * see &enum station_parameters_apply_mask
1248 * @local_pm: local link-specific mesh power save mode (no change when set
1250 * @capability: station capability
1251 * @ext_capab: extended capabilities of the station
1252 * @ext_capab_len: number of extended capabilities
1253 * @supported_channels: supported channels in IEEE 802.11 format
1254 * @supported_channels_len: number of supported channels
1255 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1256 * @supported_oper_classes_len: number of supported operating classes
1257 * @opmode_notif: operating mode field from Operating Mode Notification
1258 * @opmode_notif_used: information if operating mode field is used
1259 * @support_p2p_ps: information if station supports P2P PS mechanism
1260 * @he_capa: HE capabilities of station
1261 * @he_capa_len: the length of the HE capabilities
1262 * @airtime_weight: airtime scheduler weight for this station
1263 * @txpwr: transmit power for an associated station
1264 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1266 struct station_parameters {
1267 const u8 *supported_rates;
1268 struct net_device *vlan;
1269 u32 sta_flags_mask, sta_flags_set;
1270 u32 sta_modify_mask;
1271 int listen_interval;
1275 u8 supported_rates_len;
1278 const struct ieee80211_ht_cap *ht_capa;
1279 const struct ieee80211_vht_cap *vht_capa;
1282 enum nl80211_mesh_power_mode local_pm;
1284 const u8 *ext_capab;
1286 const u8 *supported_channels;
1287 u8 supported_channels_len;
1288 const u8 *supported_oper_classes;
1289 u8 supported_oper_classes_len;
1291 bool opmode_notif_used;
1293 const struct ieee80211_he_cap_elem *he_capa;
1296 struct sta_txpwr txpwr;
1297 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1301 * struct station_del_parameters - station deletion parameters
1303 * Used to delete a station entry (or all stations).
1305 * @mac: MAC address of the station to remove or NULL to remove all stations
1306 * @subtype: Management frame subtype to use for indicating removal
1307 * (10 = Disassociation, 12 = Deauthentication)
1308 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1310 struct station_del_parameters {
1317 * enum cfg80211_station_type - the type of station being modified
1318 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1319 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1320 * unassociated (update properties for this type of client is permitted)
1321 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1322 * the AP MLME in the device
1323 * @CFG80211_STA_AP_STA: AP station on managed interface
1324 * @CFG80211_STA_IBSS: IBSS station
1325 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1326 * while TDLS setup is in progress, it moves out of this state when
1327 * being marked authorized; use this only if TDLS with external setup is
1329 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1330 * entry that is operating, has been marked authorized by userspace)
1331 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1332 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1334 enum cfg80211_station_type {
1335 CFG80211_STA_AP_CLIENT,
1336 CFG80211_STA_AP_CLIENT_UNASSOC,
1337 CFG80211_STA_AP_MLME_CLIENT,
1338 CFG80211_STA_AP_STA,
1340 CFG80211_STA_TDLS_PEER_SETUP,
1341 CFG80211_STA_TDLS_PEER_ACTIVE,
1342 CFG80211_STA_MESH_PEER_KERNEL,
1343 CFG80211_STA_MESH_PEER_USER,
1347 * cfg80211_check_station_change - validate parameter changes
1348 * @wiphy: the wiphy this operates on
1349 * @params: the new parameters for a station
1350 * @statype: the type of station being modified
1352 * Utility function for the @change_station driver method. Call this function
1353 * with the appropriate station type looking up the station (and checking that
1354 * it exists). It will verify whether the station change is acceptable, and if
1355 * not will return an error code. Note that it may modify the parameters for
1356 * backward compatibility reasons, so don't use them before calling this.
1358 int cfg80211_check_station_change(struct wiphy *wiphy,
1359 struct station_parameters *params,
1360 enum cfg80211_station_type statype);
1363 * enum station_info_rate_flags - bitrate info flags
1365 * Used by the driver to indicate the specific rate transmission
1366 * type for 802.11n transmissions.
1368 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1369 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1370 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1371 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1372 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1373 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1375 enum rate_info_flags {
1376 RATE_INFO_FLAGS_MCS = BIT(0),
1377 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1378 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1379 RATE_INFO_FLAGS_DMG = BIT(3),
1380 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1381 RATE_INFO_FLAGS_EDMG = BIT(5),
1385 * enum rate_info_bw - rate bandwidth information
1387 * Used by the driver to indicate the rate bandwidth.
1389 * @RATE_INFO_BW_5: 5 MHz bandwidth
1390 * @RATE_INFO_BW_10: 10 MHz bandwidth
1391 * @RATE_INFO_BW_20: 20 MHz bandwidth
1392 * @RATE_INFO_BW_40: 40 MHz bandwidth
1393 * @RATE_INFO_BW_80: 80 MHz bandwidth
1394 * @RATE_INFO_BW_160: 160 MHz bandwidth
1395 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1398 RATE_INFO_BW_20 = 0,
1408 * struct rate_info - bitrate information
1410 * Information about a receiving or transmitting bitrate
1412 * @flags: bitflag of flags from &enum rate_info_flags
1413 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1414 * @legacy: bitrate in 100kbit/s for 802.11abg
1415 * @nss: number of streams (VHT & HE only)
1416 * @bw: bandwidth (from &enum rate_info_bw)
1417 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1418 * @he_dcm: HE DCM value
1419 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1420 * only valid if bw is %RATE_INFO_BW_HE_RU)
1421 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
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 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1442 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1443 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1445 enum bss_param_flags {
1446 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1447 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1448 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1452 * struct sta_bss_parameters - BSS parameters for the attached station
1454 * Information about the currently associated BSS
1456 * @flags: bitflag of flags from &enum bss_param_flags
1457 * @dtim_period: DTIM period for the BSS
1458 * @beacon_interval: beacon interval
1460 struct sta_bss_parameters {
1463 u16 beacon_interval;
1467 * struct cfg80211_txq_stats - TXQ statistics for this TID
1468 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1469 * indicate the relevant values in this struct are filled
1470 * @backlog_bytes: total number of bytes currently backlogged
1471 * @backlog_packets: total number of packets currently backlogged
1472 * @flows: number of new flows seen
1473 * @drops: total number of packets dropped
1474 * @ecn_marks: total number of packets marked with ECN CE
1475 * @overlimit: number of drops due to queue space overflow
1476 * @overmemory: number of drops due to memory limit overflow
1477 * @collisions: number of hash collisions
1478 * @tx_bytes: total number of bytes dequeued
1479 * @tx_packets: total number of packets dequeued
1480 * @max_flows: maximum number of flows supported
1482 struct cfg80211_txq_stats {
1485 u32 backlog_packets;
1498 * struct cfg80211_tid_stats - per-TID statistics
1499 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1500 * indicate the relevant values in this struct are filled
1501 * @rx_msdu: number of received MSDUs
1502 * @tx_msdu: number of (attempted) transmitted MSDUs
1503 * @tx_msdu_retries: number of retries (not counting the first) for
1505 * @tx_msdu_failed: number of failed transmitted MSDUs
1506 * @txq_stats: TXQ statistics
1508 struct cfg80211_tid_stats {
1512 u64 tx_msdu_retries;
1514 struct cfg80211_txq_stats txq_stats;
1517 #define IEEE80211_MAX_CHAINS 4
1520 * struct station_info - station information
1522 * Station information filled by driver for get_station() and dump_station.
1524 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1525 * indicate the relevant values in this struct for them
1526 * @connected_time: time(in secs) since a station is last connected
1527 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1528 * @assoc_at: bootime (ns) of the last association
1529 * @rx_bytes: bytes (size of MPDUs) received from this station
1530 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1531 * @llid: mesh local link id
1532 * @plid: mesh peer link id
1533 * @plink_state: mesh peer link state
1534 * @signal: The signal strength, type depends on the wiphy's signal_type.
1535 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1536 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1537 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1538 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1539 * @chain_signal: per-chain signal strength of last received packet in dBm
1540 * @chain_signal_avg: per-chain signal strength average in dBm
1541 * @txrate: current unicast bitrate from this station
1542 * @rxrate: current unicast bitrate to this station
1543 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1544 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1545 * @tx_retries: cumulative retry counts (MPDUs)
1546 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1547 * @rx_dropped_misc: Dropped for un-specified reason.
1548 * @bss_param: current BSS parameters
1549 * @generation: generation number for nl80211 dumps.
1550 * This number should increase every time the list of stations
1551 * changes, i.e. when a station is added or removed, so that
1552 * userspace can tell whether it got a consistent snapshot.
1553 * @assoc_req_ies: IEs from (Re)Association Request.
1554 * This is used only when in AP mode with drivers that do not use
1555 * user space MLME/SME implementation. The information is provided for
1556 * the cfg80211_new_sta() calls to notify user space of the IEs.
1557 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1558 * @sta_flags: station flags mask & values
1559 * @beacon_loss_count: Number of times beacon loss event has triggered.
1560 * @t_offset: Time offset of the station relative to this host.
1561 * @local_pm: local mesh STA power save mode
1562 * @peer_pm: peer mesh STA power save mode
1563 * @nonpeer_pm: non-peer mesh STA power save mode
1564 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1565 * towards this station.
1566 * @rx_beacon: number of beacons received from this peer
1567 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1569 * @connected_to_gate: true if mesh STA has a path to mesh gate
1570 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1571 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1572 * @airtime_weight: current airtime scheduling weight
1573 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1574 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1575 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1576 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1577 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1579 * @rx_mpdu_count: number of MPDUs received from this station
1580 * @fcs_err_count: number of packets (MPDUs) received from this station with
1581 * an FCS error. This counter should be incremented only when TA of the
1582 * received packet with an FCS error matches the peer MAC address.
1583 * @airtime_link_metric: mesh airtime link metric.
1585 struct station_info {
1599 s8 chain_signal[IEEE80211_MAX_CHAINS];
1600 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1602 struct rate_info txrate;
1603 struct rate_info rxrate;
1608 u32 rx_dropped_misc;
1609 struct sta_bss_parameters bss_param;
1610 struct nl80211_sta_flag_update sta_flags;
1614 const u8 *assoc_req_ies;
1615 size_t assoc_req_ies_len;
1617 u32 beacon_loss_count;
1619 enum nl80211_mesh_power_mode local_pm;
1620 enum nl80211_mesh_power_mode peer_pm;
1621 enum nl80211_mesh_power_mode nonpeer_pm;
1623 u32 expected_throughput;
1628 u8 rx_beacon_signal_avg;
1629 u8 connected_to_gate;
1631 struct cfg80211_tid_stats *pertid;
1640 u32 airtime_link_metric;
1643 #if IS_ENABLED(CONFIG_CFG80211)
1645 * cfg80211_get_station - retrieve information about a given station
1646 * @dev: the device where the station is supposed to be connected to
1647 * @mac_addr: the mac address of the station of interest
1648 * @sinfo: pointer to the structure to fill with the information
1650 * Returns 0 on success and sinfo is filled with the available information
1651 * otherwise returns a negative error code and the content of sinfo has to be
1652 * considered undefined.
1654 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1655 struct station_info *sinfo);
1657 static inline int cfg80211_get_station(struct net_device *dev,
1659 struct station_info *sinfo)
1666 * enum monitor_flags - monitor flags
1668 * Monitor interface configuration flags. Note that these must be the bits
1669 * according to the nl80211 flags.
1671 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1672 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1673 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1674 * @MONITOR_FLAG_CONTROL: pass control frames
1675 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1676 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1677 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1679 enum monitor_flags {
1680 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1681 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1682 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1683 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1684 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1685 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1686 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1690 * enum mpath_info_flags - mesh path information flags
1692 * Used by the driver to indicate which info in &struct mpath_info it has filled
1693 * in during get_station() or dump_station().
1695 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1696 * @MPATH_INFO_SN: @sn filled
1697 * @MPATH_INFO_METRIC: @metric filled
1698 * @MPATH_INFO_EXPTIME: @exptime filled
1699 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1700 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1701 * @MPATH_INFO_FLAGS: @flags filled
1702 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1703 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1705 enum mpath_info_flags {
1706 MPATH_INFO_FRAME_QLEN = BIT(0),
1707 MPATH_INFO_SN = BIT(1),
1708 MPATH_INFO_METRIC = BIT(2),
1709 MPATH_INFO_EXPTIME = BIT(3),
1710 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1711 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1712 MPATH_INFO_FLAGS = BIT(6),
1713 MPATH_INFO_HOP_COUNT = BIT(7),
1714 MPATH_INFO_PATH_CHANGE = BIT(8),
1718 * struct mpath_info - mesh path information
1720 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1722 * @filled: bitfield of flags from &enum mpath_info_flags
1723 * @frame_qlen: number of queued frames for this destination
1724 * @sn: target sequence number
1725 * @metric: metric (cost) of this mesh path
1726 * @exptime: expiration time for the mesh path from now, in msecs
1727 * @flags: mesh path flags
1728 * @discovery_timeout: total mesh path discovery timeout, in msecs
1729 * @discovery_retries: mesh path discovery retries
1730 * @generation: generation number for nl80211 dumps.
1731 * This number should increase every time the list of mesh paths
1732 * changes, i.e. when a station is added or removed, so that
1733 * userspace can tell whether it got a consistent snapshot.
1734 * @hop_count: hops to destination
1735 * @path_change_count: total number of path changes to destination
1743 u32 discovery_timeout;
1744 u8 discovery_retries;
1747 u32 path_change_count;
1753 * struct bss_parameters - BSS parameters
1755 * Used to change BSS parameters (mainly for AP mode).
1757 * @use_cts_prot: Whether to use CTS protection
1758 * (0 = no, 1 = yes, -1 = do not change)
1759 * @use_short_preamble: Whether the use of short preambles is allowed
1760 * (0 = no, 1 = yes, -1 = do not change)
1761 * @use_short_slot_time: Whether the use of short slot time is allowed
1762 * (0 = no, 1 = yes, -1 = do not change)
1763 * @basic_rates: basic rates in IEEE 802.11 format
1764 * (or NULL for no change)
1765 * @basic_rates_len: number of basic rates
1766 * @ap_isolate: do not forward packets between connected stations
1767 * @ht_opmode: HT Operation mode
1768 * (u16 = opmode, -1 = do not change)
1769 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1770 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1772 struct bss_parameters {
1774 int use_short_preamble;
1775 int use_short_slot_time;
1776 const u8 *basic_rates;
1780 s8 p2p_ctwindow, p2p_opp_ps;
1784 * struct mesh_config - 802.11s mesh configuration
1786 * These parameters can be changed while the mesh is active.
1788 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1789 * by the Mesh Peering Open message
1790 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1791 * used by the Mesh Peering Open message
1792 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1793 * the mesh peering management to close a mesh peering
1794 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1796 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1797 * be sent to establish a new peer link instance in a mesh
1798 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1799 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1801 * @auto_open_plinks: whether we should automatically open peer links when we
1802 * detect compatible mesh peers
1803 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1804 * synchronize to for 11s default synchronization method
1805 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1806 * that an originator mesh STA can send to a particular path target
1807 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1808 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1809 * a path discovery in milliseconds
1810 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1811 * receiving a PREQ shall consider the forwarding information from the
1812 * root to be valid. (TU = time unit)
1813 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1814 * which a mesh STA can send only one action frame containing a PREQ
1816 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1817 * which a mesh STA can send only one Action frame containing a PERR
1819 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1820 * it takes for an HWMP information element to propagate across the mesh
1821 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1822 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1823 * announcements are transmitted
1824 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1825 * station has access to a broader network beyond the MBSS. (This is
1826 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1827 * only means that the station will announce others it's a mesh gate, but
1828 * not necessarily using the gate announcement protocol. Still keeping the
1829 * same nomenclature to be in sync with the spec)
1830 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1831 * entity (default is TRUE - forwarding entity)
1832 * @rssi_threshold: the threshold for average signal strength of candidate
1833 * station to establish a peer link
1834 * @ht_opmode: mesh HT protection mode
1836 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1837 * receiving a proactive PREQ shall consider the forwarding information to
1838 * the root mesh STA to be valid.
1840 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1841 * PREQs are transmitted.
1842 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1843 * during which a mesh STA can send only one Action frame containing
1844 * a PREQ element for root path confirmation.
1845 * @power_mode: The default mesh power save mode which will be the initial
1846 * setting for new peer links.
1847 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1848 * after transmitting its beacon.
1849 * @plink_timeout: If no tx activity is seen from a STA we've established
1850 * peering with for longer than this time (in seconds), then remove it
1851 * from the STA's list of peers. Default is 30 minutes.
1852 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1853 * connected to a mesh gate in mesh formation info. If false, the
1854 * value in mesh formation is determined by the presence of root paths
1855 * in the mesh path table
1857 struct mesh_config {
1858 u16 dot11MeshRetryTimeout;
1859 u16 dot11MeshConfirmTimeout;
1860 u16 dot11MeshHoldingTimeout;
1861 u16 dot11MeshMaxPeerLinks;
1862 u8 dot11MeshMaxRetries;
1865 bool auto_open_plinks;
1866 u32 dot11MeshNbrOffsetMaxNeighbor;
1867 u8 dot11MeshHWMPmaxPREQretries;
1868 u32 path_refresh_time;
1869 u16 min_discovery_timeout;
1870 u32 dot11MeshHWMPactivePathTimeout;
1871 u16 dot11MeshHWMPpreqMinInterval;
1872 u16 dot11MeshHWMPperrMinInterval;
1873 u16 dot11MeshHWMPnetDiameterTraversalTime;
1874 u8 dot11MeshHWMPRootMode;
1875 bool dot11MeshConnectedToMeshGate;
1876 u16 dot11MeshHWMPRannInterval;
1877 bool dot11MeshGateAnnouncementProtocol;
1878 bool dot11MeshForwarding;
1881 u32 dot11MeshHWMPactivePathToRootTimeout;
1882 u16 dot11MeshHWMProotInterval;
1883 u16 dot11MeshHWMPconfirmationInterval;
1884 enum nl80211_mesh_power_mode power_mode;
1885 u16 dot11MeshAwakeWindowDuration;
1890 * struct mesh_setup - 802.11s mesh setup configuration
1891 * @chandef: defines the channel to use
1892 * @mesh_id: the mesh ID
1893 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1894 * @sync_method: which synchronization method to use
1895 * @path_sel_proto: which path selection protocol to use
1896 * @path_metric: which metric to use
1897 * @auth_id: which authentication method this mesh is using
1898 * @ie: vendor information elements (optional)
1899 * @ie_len: length of vendor information elements
1900 * @is_authenticated: this mesh requires authentication
1901 * @is_secure: this mesh uses security
1902 * @user_mpm: userspace handles all MPM functions
1903 * @dtim_period: DTIM period to use
1904 * @beacon_interval: beacon interval to use
1905 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1906 * @basic_rates: basic rates to use when creating the mesh
1907 * @beacon_rate: bitrate to be used for beacons
1908 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1909 * changes the channel when a radar is detected. This is required
1910 * to operate on DFS channels.
1911 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1912 * port frames over NL80211 instead of the network interface.
1914 * These parameters are fixed when the mesh is created.
1917 struct cfg80211_chan_def chandef;
1926 bool is_authenticated;
1930 u16 beacon_interval;
1931 int mcast_rate[NUM_NL80211_BANDS];
1933 struct cfg80211_bitrate_mask beacon_rate;
1934 bool userspace_handles_dfs;
1935 bool control_port_over_nl80211;
1939 * struct ocb_setup - 802.11p OCB mode setup configuration
1940 * @chandef: defines the channel to use
1942 * These parameters are fixed when connecting to the network
1945 struct cfg80211_chan_def chandef;
1949 * struct ieee80211_txq_params - TX queue parameters
1950 * @ac: AC identifier
1951 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1952 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1954 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1956 * @aifs: Arbitration interframe space [0..255]
1958 struct ieee80211_txq_params {
1967 * DOC: Scanning and BSS list handling
1969 * The scanning process itself is fairly simple, but cfg80211 offers quite
1970 * a bit of helper functionality. To start a scan, the scan operation will
1971 * be invoked with a scan definition. This scan definition contains the
1972 * channels to scan, and the SSIDs to send probe requests for (including the
1973 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1974 * probe. Additionally, a scan request may contain extra information elements
1975 * that should be added to the probe request. The IEs are guaranteed to be
1976 * well-formed, and will not exceed the maximum length the driver advertised
1977 * in the wiphy structure.
1979 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1980 * it is responsible for maintaining the BSS list; the driver should not
1981 * maintain a list itself. For this notification, various functions exist.
1983 * Since drivers do not maintain a BSS list, there are also a number of
1984 * functions to search for a BSS and obtain information about it from the
1985 * BSS structure cfg80211 maintains. The BSS list is also made available
1990 * struct cfg80211_ssid - SSID description
1992 * @ssid_len: length of the ssid
1994 struct cfg80211_ssid {
1995 u8 ssid[IEEE80211_MAX_SSID_LEN];
2000 * struct cfg80211_scan_info - information about completed scan
2001 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2002 * wireless device that requested the scan is connected to. If this
2003 * information is not available, this field is left zero.
2004 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2005 * @aborted: set to true if the scan was aborted for any reason,
2006 * userspace will be notified of that
2008 struct cfg80211_scan_info {
2010 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2015 * struct cfg80211_scan_request - scan request description
2017 * @ssids: SSIDs to scan for (active scan only)
2018 * @n_ssids: number of SSIDs
2019 * @channels: channels to scan on.
2020 * @n_channels: total number of channels to scan
2021 * @scan_width: channel width for scanning
2022 * @ie: optional information element(s) to add into Probe Request or %NULL
2023 * @ie_len: length of ie in octets
2024 * @duration: how long to listen on each channel, in TUs. If
2025 * %duration_mandatory is not set, this is the maximum dwell time and
2026 * the actual dwell time may be shorter.
2027 * @duration_mandatory: if set, the scan duration must be as specified by the
2029 * @flags: bit field of flags controlling operation
2030 * @rates: bitmap of rates to advertise for each band
2031 * @wiphy: the wiphy this was for
2032 * @scan_start: time (in jiffies) when the scan started
2033 * @wdev: the wireless device to scan for
2034 * @info: (internal) information about completed scan
2035 * @notified: (internal) scan request was notified as done or aborted
2036 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2037 * @mac_addr: MAC address used with randomisation
2038 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2039 * are 0 in the mask should be randomised, bits that are 1 should
2040 * be taken from the @mac_addr
2041 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2043 struct cfg80211_scan_request {
2044 struct cfg80211_ssid *ssids;
2047 enum nl80211_bss_scan_width scan_width;
2051 bool duration_mandatory;
2054 u32 rates[NUM_NL80211_BANDS];
2056 struct wireless_dev *wdev;
2058 u8 mac_addr[ETH_ALEN] __aligned(2);
2059 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2060 u8 bssid[ETH_ALEN] __aligned(2);
2063 struct wiphy *wiphy;
2064 unsigned long scan_start;
2065 struct cfg80211_scan_info info;
2070 struct ieee80211_channel *channels[];
2073 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2077 get_random_bytes(buf, ETH_ALEN);
2078 for (i = 0; i < ETH_ALEN; i++) {
2080 buf[i] |= addr[i] & mask[i];
2085 * struct cfg80211_match_set - sets of attributes to match
2087 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2088 * or no match (RSSI only)
2089 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2090 * or no match (RSSI only)
2091 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2092 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2093 * for filtering out scan results received. Drivers advertize this support
2094 * of band specific rssi based filtering through the feature capability
2095 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2096 * specific rssi thresholds take precedence over rssi_thold, if specified.
2097 * If not specified for any band, it will be assigned with rssi_thold of
2098 * corresponding matchset.
2100 struct cfg80211_match_set {
2101 struct cfg80211_ssid ssid;
2104 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2108 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2110 * @interval: interval between scheduled scan iterations. In seconds.
2111 * @iterations: number of scan iterations in this scan plan. Zero means
2113 * The last scan plan will always have this parameter set to zero,
2114 * all other scan plans will have a finite number of iterations.
2116 struct cfg80211_sched_scan_plan {
2122 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2124 * @band: band of BSS which should match for RSSI level adjustment.
2125 * @delta: value of RSSI level adjustment.
2127 struct cfg80211_bss_select_adjust {
2128 enum nl80211_band band;
2133 * struct cfg80211_sched_scan_request - scheduled scan request description
2135 * @reqid: identifies this request.
2136 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2137 * @n_ssids: number of SSIDs
2138 * @n_channels: total number of channels to scan
2139 * @scan_width: channel width for scanning
2140 * @ie: optional information element(s) to add into Probe Request or %NULL
2141 * @ie_len: length of ie in octets
2142 * @flags: bit field of flags controlling operation
2143 * @match_sets: sets of parameters to be matched for a scan result
2144 * entry to be considered valid and to be passed to the host
2145 * (others are filtered out).
2146 * If ommited, all results are passed.
2147 * @n_match_sets: number of match sets
2148 * @report_results: indicates that results were reported for this request
2149 * @wiphy: the wiphy this was for
2150 * @dev: the interface
2151 * @scan_start: start time of the scheduled scan
2152 * @channels: channels to scan
2153 * @min_rssi_thold: for drivers only supporting a single threshold, this
2154 * contains the minimum over all matchsets
2155 * @mac_addr: MAC address used with randomisation
2156 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2157 * are 0 in the mask should be randomised, bits that are 1 should
2158 * be taken from the @mac_addr
2159 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2160 * index must be executed first.
2161 * @n_scan_plans: number of scan plans, at least 1.
2162 * @rcu_head: RCU callback used to free the struct
2163 * @owner_nlportid: netlink portid of owner (if this should is a request
2164 * owned by a particular socket)
2165 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2166 * @list: for keeping list of requests.
2167 * @delay: delay in seconds to use before starting the first scan
2168 * cycle. The driver may ignore this parameter and start
2169 * immediately (or at any other time), if this feature is not
2171 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2172 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2173 * reporting in connected state to cases where a matching BSS is determined
2174 * to have better or slightly worse RSSI than the current connected BSS.
2175 * The relative RSSI threshold values are ignored in disconnected state.
2176 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2177 * to the specified band while deciding whether a better BSS is reported
2178 * using @relative_rssi. If delta is a negative number, the BSSs that
2179 * belong to the specified band will be penalized by delta dB in relative
2182 struct cfg80211_sched_scan_request {
2184 struct cfg80211_ssid *ssids;
2187 enum nl80211_bss_scan_width scan_width;
2191 struct cfg80211_match_set *match_sets;
2195 struct cfg80211_sched_scan_plan *scan_plans;
2198 u8 mac_addr[ETH_ALEN] __aligned(2);
2199 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2201 bool relative_rssi_set;
2203 struct cfg80211_bss_select_adjust rssi_adjust;
2206 struct wiphy *wiphy;
2207 struct net_device *dev;
2208 unsigned long scan_start;
2209 bool report_results;
2210 struct rcu_head rcu_head;
2213 struct list_head list;
2216 struct ieee80211_channel *channels[];
2220 * enum cfg80211_signal_type - signal type
2222 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2223 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2224 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2226 enum cfg80211_signal_type {
2227 CFG80211_SIGNAL_TYPE_NONE,
2228 CFG80211_SIGNAL_TYPE_MBM,
2229 CFG80211_SIGNAL_TYPE_UNSPEC,
2233 * struct cfg80211_inform_bss - BSS inform data
2234 * @chan: channel the frame was received on
2235 * @scan_width: scan width that was used
2236 * @signal: signal strength value, according to the wiphy's
2238 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2239 * received; should match the time when the frame was actually
2240 * received by the device (not just by the host, in case it was
2241 * buffered on the device) and be accurate to about 10ms.
2242 * If the frame isn't buffered, just passing the return value of
2243 * ktime_get_boottime_ns() is likely appropriate.
2244 * @parent_tsf: the time at the start of reception of the first octet of the
2245 * timestamp field of the frame. The time is the TSF of the BSS specified
2247 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2248 * the BSS that requested the scan in which the beacon/probe was received.
2249 * @chains: bitmask for filled values in @chain_signal.
2250 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2252 struct cfg80211_inform_bss {
2253 struct ieee80211_channel *chan;
2254 enum nl80211_bss_scan_width scan_width;
2258 u8 parent_bssid[ETH_ALEN] __aligned(2);
2260 s8 chain_signal[IEEE80211_MAX_CHAINS];
2264 * struct cfg80211_bss_ies - BSS entry IE data
2265 * @tsf: TSF contained in the frame that carried these IEs
2266 * @rcu_head: internal use, for freeing
2267 * @len: length of the IEs
2268 * @from_beacon: these IEs are known to come from a beacon
2271 struct cfg80211_bss_ies {
2273 struct rcu_head rcu_head;
2280 * struct cfg80211_bss - BSS description
2282 * This structure describes a BSS (which may also be a mesh network)
2283 * for use in scan results and similar.
2285 * @channel: channel this BSS is on
2286 * @scan_width: width of the control channel
2287 * @bssid: BSSID of the BSS
2288 * @beacon_interval: the beacon interval as from the frame
2289 * @capability: the capability field in host byte order
2290 * @ies: the information elements (Note that there is no guarantee that these
2291 * are well-formed!); this is a pointer to either the beacon_ies or
2292 * proberesp_ies depending on whether Probe Response frame has been
2293 * received. It is always non-%NULL.
2294 * @beacon_ies: the information elements from the last Beacon frame
2295 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2296 * own the beacon_ies, but they're just pointers to the ones from the
2297 * @hidden_beacon_bss struct)
2298 * @proberesp_ies: the information elements from the last Probe Response frame
2299 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2300 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2301 * that holds the beacon data. @beacon_ies is still valid, of course, and
2302 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2303 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2304 * non-transmitted one (multi-BSSID support)
2305 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2306 * (multi-BSSID support)
2307 * @signal: signal strength value (type depends on the wiphy's signal_type)
2308 * @chains: bitmask for filled values in @chain_signal.
2309 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2310 * @bssid_index: index in the multiple BSS set
2311 * @max_bssid_indicator: max number of members in the BSS set
2312 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2314 struct cfg80211_bss {
2315 struct ieee80211_channel *channel;
2316 enum nl80211_bss_scan_width scan_width;
2318 const struct cfg80211_bss_ies __rcu *ies;
2319 const struct cfg80211_bss_ies __rcu *beacon_ies;
2320 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2322 struct cfg80211_bss *hidden_beacon_bss;
2323 struct cfg80211_bss *transmitted_bss;
2324 struct list_head nontrans_list;
2328 u16 beacon_interval;
2333 s8 chain_signal[IEEE80211_MAX_CHAINS];
2336 u8 max_bssid_indicator;
2338 u8 priv[] __aligned(sizeof(void *));
2342 * ieee80211_bss_get_elem - find element with given ID
2343 * @bss: the bss to search
2344 * @id: the element ID
2346 * Note that the return value is an RCU-protected pointer, so
2347 * rcu_read_lock() must be held when calling this function.
2348 * Return: %NULL if not found.
2350 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2353 * ieee80211_bss_get_ie - find IE with given ID
2354 * @bss: the bss to search
2355 * @id: the element ID
2357 * Note that the return value is an RCU-protected pointer, so
2358 * rcu_read_lock() must be held when calling this function.
2359 * Return: %NULL if not found.
2361 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2363 return (void *)ieee80211_bss_get_elem(bss, id);
2368 * struct cfg80211_auth_request - Authentication request data
2370 * This structure provides information needed to complete IEEE 802.11
2373 * @bss: The BSS to authenticate with, the callee must obtain a reference
2374 * to it if it needs to keep it.
2375 * @auth_type: Authentication type (algorithm)
2376 * @ie: Extra IEs to add to Authentication frame or %NULL
2377 * @ie_len: Length of ie buffer in octets
2378 * @key_len: length of WEP key for shared key authentication
2379 * @key_idx: index of WEP key for shared key authentication
2380 * @key: WEP key for shared key authentication
2381 * @auth_data: Fields and elements in Authentication frames. This contains
2382 * the authentication frame body (non-IE and IE data), excluding the
2383 * Authentication algorithm number, i.e., starting at the Authentication
2384 * transaction sequence number field.
2385 * @auth_data_len: Length of auth_data buffer in octets
2387 struct cfg80211_auth_request {
2388 struct cfg80211_bss *bss;
2391 enum nl80211_auth_type auth_type;
2393 u8 key_len, key_idx;
2394 const u8 *auth_data;
2395 size_t auth_data_len;
2399 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2401 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2402 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2403 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2404 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2405 * authentication capability. Drivers can offload authentication to
2406 * userspace if this flag is set. Only applicable for cfg80211_connect()
2407 * request (connect callback).
2409 enum cfg80211_assoc_req_flags {
2410 ASSOC_REQ_DISABLE_HT = BIT(0),
2411 ASSOC_REQ_DISABLE_VHT = BIT(1),
2412 ASSOC_REQ_USE_RRM = BIT(2),
2413 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2417 * struct cfg80211_assoc_request - (Re)Association request data
2419 * This structure provides information needed to complete IEEE 802.11
2421 * @bss: The BSS to associate with. If the call is successful the driver is
2422 * given a reference that it must give back to cfg80211_send_rx_assoc()
2423 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2424 * association requests while already associating must be rejected.
2425 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2426 * @ie_len: Length of ie buffer in octets
2427 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2428 * @crypto: crypto settings
2429 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2430 * to indicate a request to reassociate within the ESS instead of a request
2431 * do the initial association with the ESS. When included, this is set to
2432 * the BSSID of the current association, i.e., to the value that is
2433 * included in the Current AP address field of the Reassociation Request
2435 * @flags: See &enum cfg80211_assoc_req_flags
2436 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2437 * will be used in ht_capa. Un-supported values will be ignored.
2438 * @ht_capa_mask: The bits of ht_capa which are to be used.
2439 * @vht_capa: VHT capability override
2440 * @vht_capa_mask: VHT capability mask indicating which fields to use
2441 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2442 * %NULL if FILS is not used.
2443 * @fils_kek_len: Length of fils_kek in octets
2444 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2445 * Request/Response frame or %NULL if FILS is not used. This field starts
2446 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2448 struct cfg80211_assoc_request {
2449 struct cfg80211_bss *bss;
2450 const u8 *ie, *prev_bssid;
2452 struct cfg80211_crypto_settings crypto;
2455 struct ieee80211_ht_cap ht_capa;
2456 struct ieee80211_ht_cap ht_capa_mask;
2457 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2459 size_t fils_kek_len;
2460 const u8 *fils_nonces;
2464 * struct cfg80211_deauth_request - Deauthentication request data
2466 * This structure provides information needed to complete IEEE 802.11
2469 * @bssid: the BSSID of the BSS to deauthenticate from
2470 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2471 * @ie_len: Length of ie buffer in octets
2472 * @reason_code: The reason code for the deauthentication
2473 * @local_state_change: if set, change local state only and
2474 * do not set a deauth frame
2476 struct cfg80211_deauth_request {
2481 bool local_state_change;
2485 * struct cfg80211_disassoc_request - Disassociation request data
2487 * This structure provides information needed to complete IEEE 802.11
2490 * @bss: the BSS to disassociate from
2491 * @ie: Extra IEs to add to Disassociation frame or %NULL
2492 * @ie_len: Length of ie buffer in octets
2493 * @reason_code: The reason code for the disassociation
2494 * @local_state_change: This is a request for a local state only, i.e., no
2495 * Disassociation frame is to be transmitted.
2497 struct cfg80211_disassoc_request {
2498 struct cfg80211_bss *bss;
2502 bool local_state_change;
2506 * struct cfg80211_ibss_params - IBSS parameters
2508 * This structure defines the IBSS parameters for the join_ibss()
2511 * @ssid: The SSID, will always be non-null.
2512 * @ssid_len: The length of the SSID, will always be non-zero.
2513 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2514 * search for IBSSs with a different BSSID.
2515 * @chandef: defines the channel to use if no other IBSS to join can be found
2516 * @channel_fixed: The channel should be fixed -- do not search for
2517 * IBSSs to join on other channels.
2518 * @ie: information element(s) to include in the beacon
2519 * @ie_len: length of that
2520 * @beacon_interval: beacon interval to use
2521 * @privacy: this is a protected network, keys will be configured
2523 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2524 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2525 * required to assume that the port is unauthorized until authorized by
2526 * user space. Otherwise, port is marked authorized by default.
2527 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2528 * port frames over NL80211 instead of the network interface.
2529 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2530 * changes the channel when a radar is detected. This is required
2531 * to operate on DFS channels.
2532 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2533 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2534 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2535 * will be used in ht_capa. Un-supported values will be ignored.
2536 * @ht_capa_mask: The bits of ht_capa which are to be used.
2537 * @wep_keys: static WEP keys, if not NULL points to an array of
2538 * CFG80211_MAX_WEP_KEYS WEP keys
2539 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2541 struct cfg80211_ibss_params {
2544 struct cfg80211_chan_def chandef;
2546 u8 ssid_len, ie_len;
2547 u16 beacon_interval;
2552 bool control_port_over_nl80211;
2553 bool userspace_handles_dfs;
2554 int mcast_rate[NUM_NL80211_BANDS];
2555 struct ieee80211_ht_cap ht_capa;
2556 struct ieee80211_ht_cap ht_capa_mask;
2557 struct key_params *wep_keys;
2562 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2564 * @behaviour: requested BSS selection behaviour.
2565 * @param: parameters for requestion behaviour.
2566 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2567 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2569 struct cfg80211_bss_selection {
2570 enum nl80211_bss_select_attr behaviour;
2572 enum nl80211_band band_pref;
2573 struct cfg80211_bss_select_adjust adjust;
2578 * struct cfg80211_connect_params - Connection parameters
2580 * This structure provides information needed to complete IEEE 802.11
2581 * authentication and association.
2583 * @channel: The channel to use or %NULL if not specified (auto-select based
2585 * @channel_hint: The channel of the recommended BSS for initial connection or
2586 * %NULL if not specified
2587 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2589 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2590 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2591 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2594 * @ssid_len: Length of ssid in octets
2595 * @auth_type: Authentication type (algorithm)
2596 * @ie: IEs for association request
2597 * @ie_len: Length of assoc_ie in octets
2598 * @privacy: indicates whether privacy-enabled APs should be used
2599 * @mfp: indicate whether management frame protection is used
2600 * @crypto: crypto settings
2601 * @key_len: length of WEP key for shared key authentication
2602 * @key_idx: index of WEP key for shared key authentication
2603 * @key: WEP key for shared key authentication
2604 * @flags: See &enum cfg80211_assoc_req_flags
2605 * @bg_scan_period: Background scan period in seconds
2606 * or -1 to indicate that default value is to be used.
2607 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2608 * will be used in ht_capa. Un-supported values will be ignored.
2609 * @ht_capa_mask: The bits of ht_capa which are to be used.
2610 * @vht_capa: VHT Capability overrides
2611 * @vht_capa_mask: The bits of vht_capa which are to be used.
2612 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2614 * @bss_select: criteria to be used for BSS selection.
2615 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2616 * to indicate a request to reassociate within the ESS instead of a request
2617 * do the initial association with the ESS. When included, this is set to
2618 * the BSSID of the current association, i.e., to the value that is
2619 * included in the Current AP address field of the Reassociation Request
2621 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2622 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2624 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2625 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2626 * %NULL if not specified. This specifies the domain name of ER server and
2627 * is used to construct FILS wrapped data IE.
2628 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2629 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2630 * messages. This is also used to construct FILS wrapped data IE.
2631 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2632 * keys in FILS or %NULL if not specified.
2633 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2634 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2635 * offload of 4-way handshake.
2636 * @edmg: define the EDMG channels.
2637 * This may specify multiple channels and bonding options for the driver
2638 * to choose from, based on BSS configuration.
2640 struct cfg80211_connect_params {
2641 struct ieee80211_channel *channel;
2642 struct ieee80211_channel *channel_hint;
2644 const u8 *bssid_hint;
2647 enum nl80211_auth_type auth_type;
2651 enum nl80211_mfp mfp;
2652 struct cfg80211_crypto_settings crypto;
2654 u8 key_len, key_idx;
2657 struct ieee80211_ht_cap ht_capa;
2658 struct ieee80211_ht_cap ht_capa_mask;
2659 struct ieee80211_vht_cap vht_capa;
2660 struct ieee80211_vht_cap vht_capa_mask;
2662 struct cfg80211_bss_selection bss_select;
2663 const u8 *prev_bssid;
2664 const u8 *fils_erp_username;
2665 size_t fils_erp_username_len;
2666 const u8 *fils_erp_realm;
2667 size_t fils_erp_realm_len;
2668 u16 fils_erp_next_seq_num;
2669 const u8 *fils_erp_rrk;
2670 size_t fils_erp_rrk_len;
2672 struct ieee80211_edmg edmg;
2676 * enum cfg80211_connect_params_changed - Connection parameters being updated
2678 * This enum provides information of all connect parameters that
2679 * have to be updated as part of update_connect_params() call.
2681 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2682 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2683 * username, erp sequence number and rrk) are updated
2684 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2686 enum cfg80211_connect_params_changed {
2687 UPDATE_ASSOC_IES = BIT(0),
2688 UPDATE_FILS_ERP_INFO = BIT(1),
2689 UPDATE_AUTH_TYPE = BIT(2),
2693 * enum wiphy_params_flags - set_wiphy_params bitfield values
2694 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2695 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2696 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2697 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2698 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2699 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2700 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2701 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2702 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2704 enum wiphy_params_flags {
2705 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2706 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2707 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2708 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2709 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2710 WIPHY_PARAM_DYN_ACK = 1 << 5,
2711 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2712 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2713 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2716 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2718 /* The per TXQ device queue limit in airtime */
2719 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2720 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2722 /* The per interface airtime threshold to switch to lower queue limit */
2723 #define IEEE80211_AQL_THRESHOLD 24000
2726 * struct cfg80211_pmksa - PMK Security Association
2728 * This structure is passed to the set/del_pmksa() method for PMKSA
2731 * @bssid: The AP's BSSID (may be %NULL).
2732 * @pmkid: The identifier to refer a PMKSA.
2733 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2734 * derivation by a FILS STA. Otherwise, %NULL.
2735 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2736 * the hash algorithm used to generate this.
2737 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2738 * cache identifier (may be %NULL).
2739 * @ssid_len: Length of the @ssid in octets.
2740 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2741 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2743 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
2744 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
2745 * The configured PMKSA must not be used for PMKSA caching after
2746 * expiration and any keys derived from this PMK become invalid on
2747 * expiration, i.e., the current association must be dropped if the PMK
2748 * used for it expires.
2749 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
2750 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
2751 * Drivers are expected to trigger a full authentication instead of using
2752 * this PMKSA for caching when reassociating to a new BSS after this
2753 * threshold to generate a new PMK before the current one expires.
2755 struct cfg80211_pmksa {
2764 u8 pmk_reauth_threshold;
2768 * struct cfg80211_pkt_pattern - packet pattern
2769 * @mask: bitmask where to match pattern and where to ignore bytes,
2770 * one bit per byte, in same format as nl80211
2771 * @pattern: bytes to match where bitmask is 1
2772 * @pattern_len: length of pattern (in bytes)
2773 * @pkt_offset: packet offset (in bytes)
2775 * Internal note: @mask and @pattern are allocated in one chunk of
2776 * memory, free @mask only!
2778 struct cfg80211_pkt_pattern {
2779 const u8 *mask, *pattern;
2785 * struct cfg80211_wowlan_tcp - TCP connection parameters
2787 * @sock: (internal) socket for source port allocation
2788 * @src: source IP address
2789 * @dst: destination IP address
2790 * @dst_mac: destination MAC address
2791 * @src_port: source port
2792 * @dst_port: destination port
2793 * @payload_len: data payload length
2794 * @payload: data payload buffer
2795 * @payload_seq: payload sequence stamping configuration
2796 * @data_interval: interval at which to send data packets
2797 * @wake_len: wakeup payload match length
2798 * @wake_data: wakeup payload match data
2799 * @wake_mask: wakeup payload match mask
2800 * @tokens_size: length of the tokens buffer
2801 * @payload_tok: payload token usage configuration
2803 struct cfg80211_wowlan_tcp {
2804 struct socket *sock;
2806 u16 src_port, dst_port;
2807 u8 dst_mac[ETH_ALEN];
2810 struct nl80211_wowlan_tcp_data_seq payload_seq;
2813 const u8 *wake_data, *wake_mask;
2815 /* must be last, variable member */
2816 struct nl80211_wowlan_tcp_data_token payload_tok;
2820 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2822 * This structure defines the enabled WoWLAN triggers for the device.
2823 * @any: wake up on any activity -- special trigger if device continues
2824 * operating as normal during suspend
2825 * @disconnect: wake up if getting disconnected
2826 * @magic_pkt: wake up on receiving magic packet
2827 * @patterns: wake up on receiving packet matching a pattern
2828 * @n_patterns: number of patterns
2829 * @gtk_rekey_failure: wake up on GTK rekey failure
2830 * @eap_identity_req: wake up on EAP identity request packet
2831 * @four_way_handshake: wake up on 4-way handshake
2832 * @rfkill_release: wake up when rfkill is released
2833 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2834 * NULL if not configured.
2835 * @nd_config: configuration for the scan to be used for net detect wake.
2837 struct cfg80211_wowlan {
2838 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2839 eap_identity_req, four_way_handshake,
2841 struct cfg80211_pkt_pattern *patterns;
2842 struct cfg80211_wowlan_tcp *tcp;
2844 struct cfg80211_sched_scan_request *nd_config;
2848 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2850 * This structure defines coalesce rule for the device.
2851 * @delay: maximum coalescing delay in msecs.
2852 * @condition: condition for packet coalescence.
2853 * see &enum nl80211_coalesce_condition.
2854 * @patterns: array of packet patterns
2855 * @n_patterns: number of patterns
2857 struct cfg80211_coalesce_rules {
2859 enum nl80211_coalesce_condition condition;
2860 struct cfg80211_pkt_pattern *patterns;
2865 * struct cfg80211_coalesce - Packet coalescing settings
2867 * This structure defines coalescing settings.
2868 * @rules: array of coalesce rules
2869 * @n_rules: number of rules
2871 struct cfg80211_coalesce {
2872 struct cfg80211_coalesce_rules *rules;
2877 * struct cfg80211_wowlan_nd_match - information about the match
2879 * @ssid: SSID of the match that triggered the wake up
2880 * @n_channels: Number of channels where the match occurred. This
2881 * value may be zero if the driver can't report the channels.
2882 * @channels: center frequencies of the channels where a match
2885 struct cfg80211_wowlan_nd_match {
2886 struct cfg80211_ssid ssid;
2892 * struct cfg80211_wowlan_nd_info - net detect wake up information
2894 * @n_matches: Number of match information instances provided in
2895 * @matches. This value may be zero if the driver can't provide
2896 * match information.
2897 * @matches: Array of pointers to matches containing information about
2898 * the matches that triggered the wake up.
2900 struct cfg80211_wowlan_nd_info {
2902 struct cfg80211_wowlan_nd_match *matches[];
2906 * struct cfg80211_wowlan_wakeup - wakeup report
2907 * @disconnect: woke up by getting disconnected
2908 * @magic_pkt: woke up by receiving magic packet
2909 * @gtk_rekey_failure: woke up by GTK rekey failure
2910 * @eap_identity_req: woke up by EAP identity request packet
2911 * @four_way_handshake: woke up by 4-way handshake
2912 * @rfkill_release: woke up by rfkill being released
2913 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2914 * @packet_present_len: copied wakeup packet data
2915 * @packet_len: original wakeup packet length
2916 * @packet: The packet causing the wakeup, if any.
2917 * @packet_80211: For pattern match, magic packet and other data
2918 * frame triggers an 802.3 frame should be reported, for
2919 * disconnect due to deauth 802.11 frame. This indicates which
2921 * @tcp_match: TCP wakeup packet received
2922 * @tcp_connlost: TCP connection lost or failed to establish
2923 * @tcp_nomoretokens: TCP data ran out of tokens
2924 * @net_detect: if not %NULL, woke up because of net detect
2926 struct cfg80211_wowlan_wakeup {
2927 bool disconnect, magic_pkt, gtk_rekey_failure,
2928 eap_identity_req, four_way_handshake,
2929 rfkill_release, packet_80211,
2930 tcp_match, tcp_connlost, tcp_nomoretokens;
2932 u32 packet_present_len, packet_len;
2934 struct cfg80211_wowlan_nd_info *net_detect;
2938 * struct cfg80211_gtk_rekey_data - rekey data
2939 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2940 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2941 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2943 struct cfg80211_gtk_rekey_data {
2944 const u8 *kek, *kck, *replay_ctr;
2948 * struct cfg80211_update_ft_ies_params - FT IE Information
2950 * This structure provides information needed to update the fast transition IE
2952 * @md: The Mobility Domain ID, 2 Octet value
2953 * @ie: Fast Transition IEs
2954 * @ie_len: Length of ft_ie in octets
2956 struct cfg80211_update_ft_ies_params {
2963 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2965 * This structure provides information needed to transmit a mgmt frame
2967 * @chan: channel to use
2968 * @offchan: indicates wether off channel operation is required
2969 * @wait: duration for ROC
2970 * @buf: buffer to transmit
2971 * @len: buffer length
2972 * @no_cck: don't use cck rates for this frame
2973 * @dont_wait_for_ack: tells the low level not to wait for an ack
2974 * @n_csa_offsets: length of csa_offsets array
2975 * @csa_offsets: array of all the csa offsets in the frame
2977 struct cfg80211_mgmt_tx_params {
2978 struct ieee80211_channel *chan;
2984 bool dont_wait_for_ack;
2986 const u16 *csa_offsets;
2990 * struct cfg80211_dscp_exception - DSCP exception
2992 * @dscp: DSCP value that does not adhere to the user priority range definition
2993 * @up: user priority value to which the corresponding DSCP value belongs
2995 struct cfg80211_dscp_exception {
3001 * struct cfg80211_dscp_range - DSCP range definition for user priority
3003 * @low: lowest DSCP value of this user priority range, inclusive
3004 * @high: highest DSCP value of this user priority range, inclusive
3006 struct cfg80211_dscp_range {
3011 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3012 #define IEEE80211_QOS_MAP_MAX_EX 21
3013 #define IEEE80211_QOS_MAP_LEN_MIN 16
3014 #define IEEE80211_QOS_MAP_LEN_MAX \
3015 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3018 * struct cfg80211_qos_map - QoS Map Information
3020 * This struct defines the Interworking QoS map setting for DSCP values
3022 * @num_des: number of DSCP exceptions (0..21)
3023 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3024 * the user priority DSCP range definition
3025 * @up: DSCP range definition for a particular user priority
3027 struct cfg80211_qos_map {
3029 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3030 struct cfg80211_dscp_range up[8];
3034 * struct cfg80211_nan_conf - NAN configuration
3036 * This struct defines NAN configuration parameters
3038 * @master_pref: master preference (1 - 255)
3039 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3040 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3041 * (i.e. BIT(NL80211_BAND_2GHZ)).
3043 struct cfg80211_nan_conf {
3049 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3052 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3053 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3055 enum cfg80211_nan_conf_changes {
3056 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3057 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3061 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3063 * @filter: the content of the filter
3064 * @len: the length of the filter
3066 struct cfg80211_nan_func_filter {
3072 * struct cfg80211_nan_func - a NAN function
3074 * @type: &enum nl80211_nan_function_type
3075 * @service_id: the service ID of the function
3076 * @publish_type: &nl80211_nan_publish_type
3077 * @close_range: if true, the range should be limited. Threshold is
3078 * implementation specific.
3079 * @publish_bcast: if true, the solicited publish should be broadcasted
3080 * @subscribe_active: if true, the subscribe is active
3081 * @followup_id: the instance ID for follow up
3082 * @followup_reqid: the requestor instance ID for follow up
3083 * @followup_dest: MAC address of the recipient of the follow up
3084 * @ttl: time to live counter in DW.
3085 * @serv_spec_info: Service Specific Info
3086 * @serv_spec_info_len: Service Specific Info length
3087 * @srf_include: if true, SRF is inclusive
3088 * @srf_bf: Bloom Filter
3089 * @srf_bf_len: Bloom Filter length
3090 * @srf_bf_idx: Bloom Filter index
3091 * @srf_macs: SRF MAC addresses
3092 * @srf_num_macs: number of MAC addresses in SRF
3093 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3094 * @tx_filters: filters that should be transmitted in the SDF.
3095 * @num_rx_filters: length of &rx_filters.
3096 * @num_tx_filters: length of &tx_filters.
3097 * @instance_id: driver allocated id of the function.
3098 * @cookie: unique NAN function identifier.
3100 struct cfg80211_nan_func {
3101 enum nl80211_nan_function_type type;
3102 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3106 bool subscribe_active;
3109 struct mac_address followup_dest;
3111 const u8 *serv_spec_info;
3112 u8 serv_spec_info_len;
3117 struct mac_address *srf_macs;
3119 struct cfg80211_nan_func_filter *rx_filters;
3120 struct cfg80211_nan_func_filter *tx_filters;
3128 * struct cfg80211_pmk_conf - PMK configuration
3130 * @aa: authenticator address
3131 * @pmk_len: PMK length in bytes.
3132 * @pmk: the PMK material
3133 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3134 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3137 struct cfg80211_pmk_conf {
3141 const u8 *pmk_r0_name;
3145 * struct cfg80211_external_auth_params - Trigger External authentication.
3147 * Commonly used across the external auth request and event interfaces.
3149 * @action: action type / trigger for external authentication. Only significant
3150 * for the authentication request event interface (driver to user space).
3151 * @bssid: BSSID of the peer with which the authentication has
3152 * to happen. Used by both the authentication request event and
3153 * authentication response command interface.
3154 * @ssid: SSID of the AP. Used by both the authentication request event and
3155 * authentication response command interface.
3156 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3157 * authentication request event interface.
3158 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3159 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3160 * the real status code for failures. Used only for the authentication
3161 * response command interface (user space to driver).
3162 * @pmkid: The identifier to refer a PMKSA.
3164 struct cfg80211_external_auth_params {
3165 enum nl80211_external_auth_action action;
3166 u8 bssid[ETH_ALEN] __aligned(2);
3167 struct cfg80211_ssid ssid;
3168 unsigned int key_mgmt_suite;
3174 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3176 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3177 * indicate the relevant values in this struct for them
3178 * @success_num: number of FTM sessions in which all frames were successfully
3180 * @partial_num: number of FTM sessions in which part of frames were
3181 * successfully answered
3182 * @failed_num: number of failed FTM sessions
3183 * @asap_num: number of ASAP FTM sessions
3184 * @non_asap_num: number of non-ASAP FTM sessions
3185 * @total_duration_ms: total sessions durations - gives an indication
3186 * of how much time the responder was busy
3187 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3188 * initiators that didn't finish successfully the negotiation phase with
3190 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3191 * for a new scheduling although it already has scheduled FTM slot
3192 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3194 struct cfg80211_ftm_responder_stats {
3201 u64 total_duration_ms;
3202 u32 unknown_triggers_num;
3203 u32 reschedule_requests_num;
3204 u32 out_of_window_triggers_num;
3208 * struct cfg80211_pmsr_ftm_result - FTM result
3209 * @failure_reason: if this measurement failed (PMSR status is
3210 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3211 * reason than just "failure"
3212 * @burst_index: if reporting partial results, this is the index
3213 * in [0 .. num_bursts-1] of the burst that's being reported
3214 * @num_ftmr_attempts: number of FTM request frames transmitted
3215 * @num_ftmr_successes: number of FTM request frames acked
3216 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3217 * fill this to indicate in how many seconds a retry is deemed possible
3219 * @num_bursts_exp: actual number of bursts exponent negotiated
3220 * @burst_duration: actual burst duration negotiated
3221 * @ftms_per_burst: actual FTMs per burst negotiated
3222 * @lci_len: length of LCI information (if present)
3223 * @civicloc_len: length of civic location information (if present)
3224 * @lci: LCI data (may be %NULL)
3225 * @civicloc: civic location data (may be %NULL)
3226 * @rssi_avg: average RSSI over FTM action frames reported
3227 * @rssi_spread: spread of the RSSI over FTM action frames reported
3228 * @tx_rate: bitrate for transmitted FTM action frame response
3229 * @rx_rate: bitrate of received FTM action frame
3230 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3231 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3232 * the square root of the variance)
3233 * @rtt_spread: spread of the RTTs measured
3234 * @dist_avg: average of distances (mm) measured
3235 * (must have either this or @rtt_avg)
3236 * @dist_variance: variance of distances measured (see also @rtt_variance)
3237 * @dist_spread: spread of distances measured (see also @rtt_spread)
3238 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3239 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3240 * @rssi_avg_valid: @rssi_avg is valid
3241 * @rssi_spread_valid: @rssi_spread is valid
3242 * @tx_rate_valid: @tx_rate is valid
3243 * @rx_rate_valid: @rx_rate is valid
3244 * @rtt_avg_valid: @rtt_avg is valid
3245 * @rtt_variance_valid: @rtt_variance is valid
3246 * @rtt_spread_valid: @rtt_spread is valid
3247 * @dist_avg_valid: @dist_avg is valid
3248 * @dist_variance_valid: @dist_variance is valid
3249 * @dist_spread_valid: @dist_spread is valid
3251 struct cfg80211_pmsr_ftm_result {
3254 unsigned int lci_len;
3255 unsigned int civicloc_len;
3256 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3257 u32 num_ftmr_attempts, num_ftmr_successes;
3265 struct rate_info tx_rate, rx_rate;
3273 u16 num_ftmr_attempts_valid:1,
3274 num_ftmr_successes_valid:1,
3276 rssi_spread_valid:1,
3280 rtt_variance_valid:1,
3283 dist_variance_valid:1,
3284 dist_spread_valid:1;
3288 * struct cfg80211_pmsr_result - peer measurement result
3289 * @addr: address of the peer
3290 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3291 * measurement was made)
3292 * @ap_tsf: AP's TSF at measurement time
3293 * @status: status of the measurement
3294 * @final: if reporting partial results, mark this as the last one; if not
3295 * reporting partial results always set this flag
3296 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3297 * @type: type of the measurement reported, note that we only support reporting
3298 * one type at a time, but you can report multiple results separately and
3299 * they're all aggregated for userspace.
3301 struct cfg80211_pmsr_result {
3302 u64 host_time, ap_tsf;
3303 enum nl80211_peer_measurement_status status;
3310 enum nl80211_peer_measurement_type type;
3313 struct cfg80211_pmsr_ftm_result ftm;
3318 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3319 * @requested: indicates FTM is requested
3320 * @preamble: frame preamble to use
3321 * @burst_period: burst period to use
3322 * @asap: indicates to use ASAP mode
3323 * @num_bursts_exp: number of bursts exponent
3324 * @burst_duration: burst duration
3325 * @ftms_per_burst: number of FTMs per burst
3326 * @ftmr_retries: number of retries for FTM request
3327 * @request_lci: request LCI information
3328 * @request_civicloc: request civic location information
3329 * @trigger_based: use trigger based ranging for the measurement
3330 * If neither @trigger_based nor @non_trigger_based is set,
3331 * EDCA based ranging will be used.
3332 * @non_trigger_based: use non trigger based ranging for the measurement
3333 * If neither @trigger_based nor @non_trigger_based is set,
3334 * EDCA based ranging will be used.
3336 * See also nl80211 for the respective attribute documentation.
3338 struct cfg80211_pmsr_ftm_request_peer {
3339 enum nl80211_preamble preamble;
3346 non_trigger_based:1;
3354 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3355 * @addr: MAC address
3356 * @chandef: channel to use
3357 * @report_ap_tsf: report the associated AP's TSF
3358 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3360 struct cfg80211_pmsr_request_peer {
3362 struct cfg80211_chan_def chandef;
3364 struct cfg80211_pmsr_ftm_request_peer ftm;
3368 * struct cfg80211_pmsr_request - peer measurement request
3369 * @cookie: cookie, set by cfg80211
3370 * @nl_portid: netlink portid - used by cfg80211
3371 * @drv_data: driver data for this request, if required for aborting,
3372 * not otherwise freed or anything by cfg80211
3373 * @mac_addr: MAC address used for (randomised) request
3374 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3375 * are 0 in the mask should be randomised, bits that are 1 should
3376 * be taken from the @mac_addr
3377 * @list: used by cfg80211 to hold on to the request
3378 * @timeout: timeout (in milliseconds) for the whole operation, if
3379 * zero it means there's no timeout
3380 * @n_peers: number of peers to do measurements with
3381 * @peers: per-peer measurement request data
3383 struct cfg80211_pmsr_request {
3391 u8 mac_addr[ETH_ALEN] __aligned(2);
3392 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3394 struct list_head list;
3396 struct cfg80211_pmsr_request_peer peers[];
3400 * struct cfg80211_update_owe_info - OWE Information
3402 * This structure provides information needed for the drivers to offload OWE
3403 * (Opportunistic Wireless Encryption) processing to the user space.
3405 * Commonly used across update_owe_info request and event interfaces.
3407 * @peer: MAC address of the peer device for which the OWE processing
3409 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3410 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3411 * cannot give you the real status code for failures. Used only for
3412 * OWE update request command interface (user space to driver).
3413 * @ie: IEs obtained from the peer or constructed by the user space. These are
3414 * the IEs of the remote peer in the event from the host driver and
3415 * the constructed IEs by the user space in the request interface.
3416 * @ie_len: Length of IEs in octets.
3418 struct cfg80211_update_owe_info {
3419 u8 peer[ETH_ALEN] __aligned(2);
3426 * struct mgmt_frame_regs - management frame registrations data
3427 * @global_stypes: bitmap of management frame subtypes registered
3428 * for the entire device
3429 * @interface_stypes: bitmap of management frame subtypes registered
3430 * for the given interface
3431 * @global_mcast_rx: mcast RX is needed globally for these subtypes
3432 * @interface_mcast_stypes: mcast RX is needed on this interface
3433 * for these subtypes
3435 struct mgmt_frame_regs {
3436 u32 global_stypes, interface_stypes;
3437 u32 global_mcast_stypes, interface_mcast_stypes;
3441 * struct cfg80211_ops - backend description for wireless configuration
3443 * This struct is registered by fullmac card drivers and/or wireless stacks
3444 * in order to handle configuration requests on their interfaces.
3446 * All callbacks except where otherwise noted should return 0
3447 * on success or a negative error code.
3449 * All operations are currently invoked under rtnl for consistency with the
3450 * wireless extensions but this is subject to reevaluation as soon as this
3451 * code is used more widely and we have a first user without wext.
3453 * @suspend: wiphy device needs to be suspended. The variable @wow will
3454 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3455 * configured for the device.
3456 * @resume: wiphy device needs to be resumed
3457 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3458 * to call device_set_wakeup_enable() to enable/disable wakeup from
3461 * @add_virtual_intf: create a new virtual interface with the given name,
3462 * must set the struct wireless_dev's iftype. Beware: You must create
3463 * the new netdev in the wiphy's network namespace! Returns the struct
3464 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3465 * also set the address member in the wdev.
3467 * @del_virtual_intf: remove the virtual interface
3469 * @change_virtual_intf: change type/configuration of virtual interface,
3470 * keep the struct wireless_dev's iftype updated.
3472 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3473 * when adding a group key.
3475 * @get_key: get information about the key with the given parameters.
3476 * @mac_addr will be %NULL when requesting information for a group
3477 * key. All pointers given to the @callback function need not be valid
3478 * after it returns. This function should return an error if it is
3479 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3481 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3482 * and @key_index, return -ENOENT if the key doesn't exist.
3484 * @set_default_key: set the default key on an interface
3486 * @set_default_mgmt_key: set the default management frame key on an interface
3488 * @set_default_beacon_key: set the default Beacon frame key on an interface
3490 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3492 * @start_ap: Start acting in AP mode defined by the parameters.
3493 * @change_beacon: Change the beacon parameters for an access point mode
3494 * interface. This should reject the call when AP mode wasn't started.
3495 * @stop_ap: Stop being an AP, including stopping beaconing.
3497 * @add_station: Add a new station.
3498 * @del_station: Remove a station
3499 * @change_station: Modify a given station. Note that flags changes are not much
3500 * validated in cfg80211, in particular the auth/assoc/authorized flags
3501 * might come to the driver in invalid combinations -- make sure to check
3502 * them, also against the existing state! Drivers must call
3503 * cfg80211_check_station_change() to validate the information.
3504 * @get_station: get station information for the station identified by @mac
3505 * @dump_station: dump station callback -- resume dump at index @idx
3507 * @add_mpath: add a fixed mesh path
3508 * @del_mpath: delete a given mesh path
3509 * @change_mpath: change a given mesh path
3510 * @get_mpath: get a mesh path for the given parameters
3511 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3512 * @get_mpp: get a mesh proxy path for the given parameters
3513 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3514 * @join_mesh: join the mesh network with the specified parameters
3515 * (invoked with the wireless_dev mutex held)
3516 * @leave_mesh: leave the current mesh network
3517 * (invoked with the wireless_dev mutex held)
3519 * @get_mesh_config: Get the current mesh configuration
3521 * @update_mesh_config: Update mesh parameters on a running mesh.
3522 * The mask is a bitfield which tells us which parameters to
3523 * set, and which to leave alone.
3525 * @change_bss: Modify parameters for a given BSS.
3527 * @set_txq_params: Set TX queue parameters
3529 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3530 * as it doesn't implement join_mesh and needs to set the channel to
3531 * join the mesh instead.
3533 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3534 * interfaces are active this callback should reject the configuration.
3535 * If no interfaces are active or the device is down, the channel should
3536 * be stored for when a monitor interface becomes active.
3538 * @scan: Request to do a scan. If returning zero, the scan request is given
3539 * the driver, and will be valid until passed to cfg80211_scan_done().
3540 * For scan results, call cfg80211_inform_bss(); you can call this outside
3541 * the scan/scan_done bracket too.
3542 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3543 * indicate the status of the scan through cfg80211_scan_done().
3545 * @auth: Request to authenticate with the specified peer
3546 * (invoked with the wireless_dev mutex held)
3547 * @assoc: Request to (re)associate with the specified peer
3548 * (invoked with the wireless_dev mutex held)
3549 * @deauth: Request to deauthenticate from the specified peer
3550 * (invoked with the wireless_dev mutex held)
3551 * @disassoc: Request to disassociate from the specified peer
3552 * (invoked with the wireless_dev mutex held)
3554 * @connect: Connect to the ESS with the specified parameters. When connected,
3555 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3556 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3557 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3558 * from the AP or cfg80211_connect_timeout() if no frame with status code
3560 * The driver is allowed to roam to other BSSes within the ESS when the
3561 * other BSS matches the connect parameters. When such roaming is initiated
3562 * by the driver, the driver is expected to verify that the target matches
3563 * the configured security parameters and to use Reassociation Request
3564 * frame instead of Association Request frame.
3565 * The connect function can also be used to request the driver to perform a
3566 * specific roam when connected to an ESS. In that case, the prev_bssid
3567 * parameter is set to the BSSID of the currently associated BSS as an
3568 * indication of requesting reassociation.
3569 * In both the driver-initiated and new connect() call initiated roaming
3570 * cases, the result of roaming is indicated with a call to
3571 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3572 * @update_connect_params: Update the connect parameters while connected to a
3573 * BSS. The updated parameters can be used by driver/firmware for
3574 * subsequent BSS selection (roaming) decisions and to form the
3575 * Authentication/(Re)Association Request frames. This call does not
3576 * request an immediate disassociation or reassociation with the current
3577 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3578 * changed are defined in &enum cfg80211_connect_params_changed.
3579 * (invoked with the wireless_dev mutex held)
3580 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3581 * connection is in progress. Once done, call cfg80211_disconnected() in
3582 * case connection was already established (invoked with the
3583 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3585 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3586 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3588 * (invoked with the wireless_dev mutex held)
3589 * @leave_ibss: Leave the IBSS.
3590 * (invoked with the wireless_dev mutex held)
3592 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3595 * @set_wiphy_params: Notify that wiphy parameters have changed;
3596 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3597 * have changed. The actual parameter values are available in
3598 * struct wiphy. If returning an error, no value should be changed.
3600 * @set_tx_power: set the transmit power according to the parameters,
3601 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3602 * wdev may be %NULL if power was set for the wiphy, and will
3603 * always be %NULL unless the driver supports per-vif TX power
3604 * (as advertised by the nl80211 feature flag.)
3605 * @get_tx_power: store the current TX power into the dbm variable;
3606 * return 0 if successful
3608 * @set_wds_peer: set the WDS peer for a WDS interface
3610 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3611 * functions to adjust rfkill hw state
3613 * @dump_survey: get site survey information.
3615 * @remain_on_channel: Request the driver to remain awake on the specified
3616 * channel for the specified duration to complete an off-channel
3617 * operation (e.g., public action frame exchange). When the driver is
3618 * ready on the requested channel, it must indicate this with an event
3619 * notification by calling cfg80211_ready_on_channel().
3620 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3621 * This allows the operation to be terminated prior to timeout based on
3622 * the duration value.
3623 * @mgmt_tx: Transmit a management frame.
3624 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3625 * frame on another channel
3627 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3628 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3629 * used by the function, but 0 and 1 must not be touched. Additionally,
3630 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3631 * dump and return to userspace with an error, so be careful. If any data
3632 * was passed in from userspace then the data/len arguments will be present
3633 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3635 * @set_bitrate_mask: set the bitrate mask configuration
3637 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3638 * devices running firmwares capable of generating the (re) association
3639 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3640 * @del_pmksa: Delete a cached PMKID.
3641 * @flush_pmksa: Flush all cached PMKIDs.
3642 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3643 * allows the driver to adjust the dynamic ps timeout value.
3644 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3645 * After configuration, the driver should (soon) send an event indicating
3646 * the current level is above/below the configured threshold; this may
3647 * need some care when the configuration is changed (without first being
3649 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3650 * connection quality monitor. An event is to be sent only when the
3651 * signal level is found to be outside the two values. The driver should
3652 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3653 * If it is provided then there's no point providing @set_cqm_rssi_config.
3654 * @set_cqm_txe_config: Configure connection quality monitor TX error
3656 * @sched_scan_start: Tell the driver to start a scheduled scan.
3657 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3658 * given request id. This call must stop the scheduled scan and be ready
3659 * for starting a new one before it returns, i.e. @sched_scan_start may be
3660 * called immediately after that again and should not fail in that case.
3661 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3662 * stop (when this method returns 0).
3664 * @update_mgmt_frame_registrations: Notify the driver that management frame
3665 * registrations were updated. The callback is allowed to sleep.
3667 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3668 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3669 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3670 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3672 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3674 * @tdls_mgmt: Transmit a TDLS management frame.
3675 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3677 * @probe_client: probe an associated client, must return a cookie that it
3678 * later passes to cfg80211_probe_status().
3680 * @set_noack_map: Set the NoAck Map for the TIDs.
3682 * @get_channel: Get the current operating channel for the virtual interface.
3683 * For monitor interfaces, it should return %NULL unless there's a single
3684 * current monitoring channel.
3686 * @start_p2p_device: Start the given P2P device.
3687 * @stop_p2p_device: Stop the given P2P device.
3689 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3690 * Parameters include ACL policy, an array of MAC address of stations
3691 * and the number of MAC addresses. If there is already a list in driver
3692 * this new list replaces the existing one. Driver has to clear its ACL
3693 * when number of MAC addresses entries is passed as 0. Drivers which
3694 * advertise the support for MAC based ACL have to implement this callback.
3696 * @start_radar_detection: Start radar detection in the driver.
3698 * @end_cac: End running CAC, probably because a related CAC
3699 * was finished on another phy.
3701 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3702 * driver. If the SME is in the driver/firmware, this information can be
3703 * used in building Authentication and Reassociation Request frames.
3705 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3706 * for a given duration (milliseconds). The protocol is provided so the
3707 * driver can take the most appropriate actions.
3708 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3709 * reliability. This operation can not fail.
3710 * @set_coalesce: Set coalesce parameters.
3712 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3713 * responsible for veryfing if the switch is possible. Since this is
3714 * inherently tricky driver may decide to disconnect an interface later
3715 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3716 * everything. It should do it's best to verify requests and reject them
3717 * as soon as possible.
3719 * @set_qos_map: Set QoS mapping information to the driver
3721 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3722 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3723 * changes during the lifetime of the BSS.
3725 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3726 * with the given parameters; action frame exchange has been handled by
3727 * userspace so this just has to modify the TX path to take the TS into
3729 * If the admitted time is 0 just validate the parameters to make sure
3730 * the session can be created at all; it is valid to just always return
3731 * success for that but that may result in inefficient behaviour (handshake
3732 * with the peer followed by immediate teardown when the addition is later
3734 * @del_tx_ts: remove an existing TX TS
3736 * @join_ocb: join the OCB network with the specified parameters
3737 * (invoked with the wireless_dev mutex held)
3738 * @leave_ocb: leave the current OCB network
3739 * (invoked with the wireless_dev mutex held)
3741 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3742 * is responsible for continually initiating channel-switching operations
3743 * and returning to the base channel for communication with the AP.
3744 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3745 * peers must be on the base channel when the call completes.
3746 * @start_nan: Start the NAN interface.
3747 * @stop_nan: Stop the NAN interface.
3748 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3749 * On success @nan_func ownership is transferred to the driver and
3750 * it may access it outside of the scope of this function. The driver
3751 * should free the @nan_func when no longer needed by calling
3752 * cfg80211_free_nan_func().
3753 * On success the driver should assign an instance_id in the
3754 * provided @nan_func.
3755 * @del_nan_func: Delete a NAN function.
3756 * @nan_change_conf: changes NAN configuration. The changed parameters must
3757 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3758 * All other parameters must be ignored.
3760 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3762 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3763 * function should return phy stats, and interface stats otherwise.
3765 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3766 * If not deleted through @del_pmk the PMK remains valid until disconnect
3767 * upon which the driver should clear it.
3768 * (invoked with the wireless_dev mutex held)
3769 * @del_pmk: delete the previously configured PMK for the given authenticator.
3770 * (invoked with the wireless_dev mutex held)
3772 * @external_auth: indicates result of offloaded authentication processing from
3775 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3776 * tells the driver that the frame should not be encrypted.
3778 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3779 * Statistics should be cumulative, currently no way to reset is provided.
3780 * @start_pmsr: start peer measurement (e.g. FTM)
3781 * @abort_pmsr: abort peer measurement
3783 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3784 * but offloading OWE processing to the user space will get the updated
3785 * DH IE through this interface.
3787 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3788 * and overrule HWMP path selection algorithm.
3789 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
3790 * This callback may sleep.
3791 * @reset_tid_config: Reset TID specific configuration for the peer, for the
3792 * given TIDs. This callback may sleep.
3794 struct cfg80211_ops {
3795 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3796 int (*resume)(struct wiphy *wiphy);
3797 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3799 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3801 unsigned char name_assign_type,
3802 enum nl80211_iftype type,
3803 struct vif_params *params);
3804 int (*del_virtual_intf)(struct wiphy *wiphy,
3805 struct wireless_dev *wdev);
3806 int (*change_virtual_intf)(struct wiphy *wiphy,
3807 struct net_device *dev,
3808 enum nl80211_iftype type,
3809 struct vif_params *params);
3811 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3812 u8 key_index, bool pairwise, const u8 *mac_addr,
3813 struct key_params *params);
3814 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3815 u8 key_index, bool pairwise, const u8 *mac_addr,
3817 void (*callback)(void *cookie, struct key_params*));
3818 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3819 u8 key_index, bool pairwise, const u8 *mac_addr);
3820 int (*set_default_key)(struct wiphy *wiphy,
3821 struct net_device *netdev,
3822 u8 key_index, bool unicast, bool multicast);
3823 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3824 struct net_device *netdev,
3826 int (*set_default_beacon_key)(struct wiphy *wiphy,
3827 struct net_device *netdev,
3830 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3831 struct cfg80211_ap_settings *settings);
3832 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3833 struct cfg80211_beacon_data *info);
3834 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3837 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3839 struct station_parameters *params);
3840 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3841 struct station_del_parameters *params);
3842 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3844 struct station_parameters *params);
3845 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3846 const u8 *mac, struct station_info *sinfo);
3847 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3848 int idx, u8 *mac, struct station_info *sinfo);
3850 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3851 const u8 *dst, const u8 *next_hop);
3852 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3854 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3855 const u8 *dst, const u8 *next_hop);
3856 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3857 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3858 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3859 int idx, u8 *dst, u8 *next_hop,
3860 struct mpath_info *pinfo);
3861 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3862 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3863 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3864 int idx, u8 *dst, u8 *mpp,
3865 struct mpath_info *pinfo);
3866 int (*get_mesh_config)(struct wiphy *wiphy,
3867 struct net_device *dev,
3868 struct mesh_config *conf);
3869 int (*update_mesh_config)(struct wiphy *wiphy,
3870 struct net_device *dev, u32 mask,
3871 const struct mesh_config *nconf);
3872 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3873 const struct mesh_config *conf,
3874 const struct mesh_setup *setup);
3875 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3877 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3878 struct ocb_setup *setup);
3879 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3881 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3882 struct bss_parameters *params);
3884 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3885 struct ieee80211_txq_params *params);
3887 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3888 struct net_device *dev,
3889 struct ieee80211_channel *chan);
3891 int (*set_monitor_channel)(struct wiphy *wiphy,
3892 struct cfg80211_chan_def *chandef);
3894 int (*scan)(struct wiphy *wiphy,
3895 struct cfg80211_scan_request *request);
3896 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3898 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
3899 struct cfg80211_auth_request *req);
3900 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3901 struct cfg80211_assoc_request *req);
3902 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3903 struct cfg80211_deauth_request *req);
3904 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3905 struct cfg80211_disassoc_request *req);
3907 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
3908 struct cfg80211_connect_params *sme);
3909 int (*update_connect_params)(struct wiphy *wiphy,
3910 struct net_device *dev,
3911 struct cfg80211_connect_params *sme,
3913 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3916 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3917 struct cfg80211_ibss_params *params);
3918 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3920 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3921 int rate[NUM_NL80211_BANDS]);
3923 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3925 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3926 enum nl80211_tx_power_setting type, int mbm);
3927 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3930 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3933 void (*rfkill_poll)(struct wiphy *wiphy);
3935 #ifdef CONFIG_NL80211_TESTMODE
3936 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3937 void *data, int len);
3938 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3939 struct netlink_callback *cb,
3940 void *data, int len);
3943 int (*set_bitrate_mask)(struct wiphy *wiphy,
3944 struct net_device *dev,
3946 const struct cfg80211_bitrate_mask *mask);
3948 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3949 int idx, struct survey_info *info);
3951 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3952 struct cfg80211_pmksa *pmksa);
3953 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3954 struct cfg80211_pmksa *pmksa);
3955 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3957 int (*remain_on_channel)(struct wiphy *wiphy,
3958 struct wireless_dev *wdev,
3959 struct ieee80211_channel *chan,
3960 unsigned int duration,
3962 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
3963 struct wireless_dev *wdev,
3966 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3967 struct cfg80211_mgmt_tx_params *params,
3969 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3970 struct wireless_dev *wdev,
3973 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3974 bool enabled, int timeout);
3976 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
3977 struct net_device *dev,
3978 s32 rssi_thold, u32 rssi_hyst);
3980 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3981 struct net_device *dev,
3982 s32 rssi_low, s32 rssi_high);
3984 int (*set_cqm_txe_config)(struct wiphy *wiphy,
3985 struct net_device *dev,
3986 u32 rate, u32 pkts, u32 intvl);
3988 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
3989 struct wireless_dev *wdev,
3990 struct mgmt_frame_regs *upd);
3992 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3993 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3995 int (*sched_scan_start)(struct wiphy *wiphy,
3996 struct net_device *dev,
3997 struct cfg80211_sched_scan_request *request);
3998 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4001 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4002 struct cfg80211_gtk_rekey_data *data);
4004 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4005 const u8 *peer, u8 action_code, u8 dialog_token,
4006 u16 status_code, u32 peer_capability,
4007 bool initiator, const u8 *buf, size_t len);
4008 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4009 const u8 *peer, enum nl80211_tdls_operation oper);
4011 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4012 const u8 *peer, u64 *cookie);
4014 int (*set_noack_map)(struct wiphy *wiphy,
4015 struct net_device *dev,
4018 int (*get_channel)(struct wiphy *wiphy,
4019 struct wireless_dev *wdev,
4020 struct cfg80211_chan_def *chandef);
4022 int (*start_p2p_device)(struct wiphy *wiphy,
4023 struct wireless_dev *wdev);
4024 void (*stop_p2p_device)(struct wiphy *wiphy,
4025 struct wireless_dev *wdev);
4027 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4028 const struct cfg80211_acl_data *params);
4030 int (*start_radar_detection)(struct wiphy *wiphy,
4031 struct net_device *dev,
4032 struct cfg80211_chan_def *chandef,
4034 void (*end_cac)(struct wiphy *wiphy,
4035 struct net_device *dev);
4036 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4037 struct cfg80211_update_ft_ies_params *ftie);
4038 int (*crit_proto_start)(struct wiphy *wiphy,
4039 struct wireless_dev *wdev,
4040 enum nl80211_crit_proto_id protocol,
4042 void (*crit_proto_stop)(struct wiphy *wiphy,
4043 struct wireless_dev *wdev);
4044 int (*set_coalesce)(struct wiphy *wiphy,
4045 struct cfg80211_coalesce *coalesce);
4047 int (*channel_switch)(struct wiphy *wiphy,
4048 struct net_device *dev,
4049 struct cfg80211_csa_settings *params);
4051 int (*set_qos_map)(struct wiphy *wiphy,
4052 struct net_device *dev,
4053 struct cfg80211_qos_map *qos_map);
4055 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4056 struct cfg80211_chan_def *chandef);
4058 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4059 u8 tsid, const u8 *peer, u8 user_prio,
4061 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4062 u8 tsid, const u8 *peer);
4064 int (*tdls_channel_switch)(struct wiphy *wiphy,
4065 struct net_device *dev,
4066 const u8 *addr, u8 oper_class,
4067 struct cfg80211_chan_def *chandef);
4068 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4069 struct net_device *dev,
4071 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4072 struct cfg80211_nan_conf *conf);
4073 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4074 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4075 struct cfg80211_nan_func *nan_func);
4076 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4078 int (*nan_change_conf)(struct wiphy *wiphy,
4079 struct wireless_dev *wdev,
4080 struct cfg80211_nan_conf *conf,
4083 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4084 struct net_device *dev,
4085 const bool enabled);
4087 int (*get_txq_stats)(struct wiphy *wiphy,
4088 struct wireless_dev *wdev,
4089 struct cfg80211_txq_stats *txqstats);
4091 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4092 const struct cfg80211_pmk_conf *conf);
4093 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4095 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4096 struct cfg80211_external_auth_params *params);
4098 int (*tx_control_port)(struct wiphy *wiphy,
4099 struct net_device *dev,
4100 const u8 *buf, size_t len,
4101 const u8 *dest, const __be16 proto,
4102 const bool noencrypt,
4105 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4106 struct net_device *dev,
4107 struct cfg80211_ftm_responder_stats *ftm_stats);
4109 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4110 struct cfg80211_pmsr_request *request);
4111 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4112 struct cfg80211_pmsr_request *request);
4113 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4114 struct cfg80211_update_owe_info *owe_info);
4115 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4116 const u8 *buf, size_t len);
4117 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4118 struct cfg80211_tid_config *tid_conf);
4119 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4120 const u8 *peer, u8 tids);
4124 * wireless hardware and networking interfaces structures
4125 * and registration/helper functions
4129 * enum wiphy_flags - wiphy capability flags
4131 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4133 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4134 * by default -- this flag will be set depending on the kernel's default
4135 * on wiphy_new(), but can be changed by the driver if it has a good
4136 * reason to override the default
4137 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4138 * on a VLAN interface). This flag also serves an extra purpose of
4139 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4140 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4141 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4142 * control port protocol ethertype. The device also honours the
4143 * control_port_no_encrypt flag.
4144 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4145 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4146 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4147 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4149 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4150 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4151 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4152 * link setup/discovery operations internally. Setup, discovery and
4153 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4154 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4155 * used for asking the driver/firmware to perform a TDLS operation.
4156 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4157 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4158 * when there are virtual interfaces in AP mode by calling
4159 * cfg80211_report_obss_beacon().
4160 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4161 * responds to probe-requests in hardware.
4162 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4163 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4164 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4165 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4166 * beaconing mode (AP, IBSS, Mesh, ...).
4167 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4168 * before connection.
4174 WIPHY_FLAG_NETNS_OK = BIT(3),
4175 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4176 WIPHY_FLAG_4ADDR_AP = BIT(5),
4177 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4178 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4179 WIPHY_FLAG_IBSS_RSN = BIT(8),
4180 WIPHY_FLAG_MESH_AUTH = BIT(10),
4181 /* use hole at 11 */
4182 /* use hole at 12 */
4183 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4184 WIPHY_FLAG_AP_UAPSD = BIT(14),
4185 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4186 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4187 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4188 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4189 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4190 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4191 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4192 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4193 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4194 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4198 * struct ieee80211_iface_limit - limit on certain interface types
4199 * @max: maximum number of interfaces of these types
4200 * @types: interface types (bits)
4202 struct ieee80211_iface_limit {
4208 * struct ieee80211_iface_combination - possible interface combination
4210 * With this structure the driver can describe which interface
4211 * combinations it supports concurrently.
4215 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4219 * struct ieee80211_iface_limit limits1[] = {
4220 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4221 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4223 * struct ieee80211_iface_combination combination1 = {
4224 * .limits = limits1,
4225 * .n_limits = ARRAY_SIZE(limits1),
4226 * .max_interfaces = 2,
4227 * .beacon_int_infra_match = true,
4231 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4235 * struct ieee80211_iface_limit limits2[] = {
4236 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4237 * BIT(NL80211_IFTYPE_P2P_GO), },
4239 * struct ieee80211_iface_combination combination2 = {
4240 * .limits = limits2,
4241 * .n_limits = ARRAY_SIZE(limits2),
4242 * .max_interfaces = 8,
4243 * .num_different_channels = 1,
4247 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4249 * This allows for an infrastructure connection and three P2P connections.
4253 * struct ieee80211_iface_limit limits3[] = {
4254 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4255 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4256 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4258 * struct ieee80211_iface_combination combination3 = {
4259 * .limits = limits3,
4260 * .n_limits = ARRAY_SIZE(limits3),
4261 * .max_interfaces = 4,
4262 * .num_different_channels = 2,
4266 struct ieee80211_iface_combination {
4269 * limits for the given interface types
4271 const struct ieee80211_iface_limit *limits;
4274 * @num_different_channels:
4275 * can use up to this many different channels
4277 u32 num_different_channels;
4281 * maximum number of interfaces in total allowed in this group
4287 * number of limitations
4292 * @beacon_int_infra_match:
4293 * In this combination, the beacon intervals between infrastructure
4294 * and AP types must match. This is required only in special cases.
4296 bool beacon_int_infra_match;
4299 * @radar_detect_widths:
4300 * bitmap of channel widths supported for radar detection
4302 u8 radar_detect_widths;
4305 * @radar_detect_regions:
4306 * bitmap of regions supported for radar detection
4308 u8 radar_detect_regions;
4311 * @beacon_int_min_gcd:
4312 * This interface combination supports different beacon intervals.
4315 * all beacon intervals for different interface must be same.
4317 * any beacon interval for the interface part of this combination AND
4318 * GCD of all beacon intervals from beaconing interfaces of this
4319 * combination must be greater or equal to this value.
4321 u32 beacon_int_min_gcd;
4324 struct ieee80211_txrx_stypes {
4329 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4330 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4331 * trigger that keeps the device operating as-is and
4332 * wakes up the host on any activity, for example a
4333 * received packet that passed filtering; note that the
4334 * packet should be preserved in that case
4335 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4337 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4338 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4339 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4340 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4341 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4342 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4343 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4345 enum wiphy_wowlan_support_flags {
4346 WIPHY_WOWLAN_ANY = BIT(0),
4347 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4348 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4349 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4350 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4351 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4352 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4353 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4354 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4357 struct wiphy_wowlan_tcp_support {
4358 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4359 u32 data_payload_max;
4360 u32 data_interval_max;
4361 u32 wake_payload_max;
4366 * struct wiphy_wowlan_support - WoWLAN support data
4367 * @flags: see &enum wiphy_wowlan_support_flags
4368 * @n_patterns: number of supported wakeup patterns
4369 * (see nl80211.h for the pattern definition)
4370 * @pattern_max_len: maximum length of each pattern
4371 * @pattern_min_len: minimum length of each pattern
4372 * @max_pkt_offset: maximum Rx packet offset
4373 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4374 * similar, but not necessarily identical, to max_match_sets for
4376 * See &struct cfg80211_sched_scan_request.@match_sets for more
4378 * @tcp: TCP wakeup support information
4380 struct wiphy_wowlan_support {
4383 int pattern_max_len;
4384 int pattern_min_len;
4386 int max_nd_match_sets;
4387 const struct wiphy_wowlan_tcp_support *tcp;
4391 * struct wiphy_coalesce_support - coalesce support data
4392 * @n_rules: maximum number of coalesce rules
4393 * @max_delay: maximum supported coalescing delay in msecs
4394 * @n_patterns: number of supported patterns in a rule
4395 * (see nl80211.h for the pattern definition)
4396 * @pattern_max_len: maximum length of each pattern
4397 * @pattern_min_len: minimum length of each pattern
4398 * @max_pkt_offset: maximum Rx packet offset
4400 struct wiphy_coalesce_support {
4404 int pattern_max_len;
4405 int pattern_min_len;
4410 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4411 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4412 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4413 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4414 * (must be combined with %_WDEV or %_NETDEV)
4416 enum wiphy_vendor_command_flags {
4417 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4418 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4419 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4423 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4425 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4426 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4427 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4430 enum wiphy_opmode_flag {
4431 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4432 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4433 STA_OPMODE_N_SS_CHANGED = BIT(2),
4437 * struct sta_opmode_info - Station's ht/vht operation mode information
4438 * @changed: contains value from &enum wiphy_opmode_flag
4439 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4440 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4441 * @rx_nss: new rx_nss value of a station
4444 struct sta_opmode_info {
4446 enum nl80211_smps_mode smps_mode;
4447 enum nl80211_chan_width bw;
4451 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4454 * struct wiphy_vendor_command - vendor command definition
4455 * @info: vendor command identifying information, as used in nl80211
4456 * @flags: flags, see &enum wiphy_vendor_command_flags
4457 * @doit: callback for the operation, note that wdev is %NULL if the
4458 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4459 * pointer may be %NULL if userspace provided no data at all
4460 * @dumpit: dump callback, for transferring bigger/multiple items. The
4461 * @storage points to cb->args[5], ie. is preserved over the multiple
4463 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4464 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4465 * attribute is just raw data (e.g. a firmware command).
4466 * @maxattr: highest attribute number in policy
4467 * It's recommended to not have the same sub command with both @doit and
4468 * @dumpit, so that userspace can assume certain ones are get and others
4469 * are used with dump requests.
4471 struct wiphy_vendor_command {
4472 struct nl80211_vendor_cmd_info info;
4474 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4475 const void *data, int data_len);
4476 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4477 struct sk_buff *skb, const void *data, int data_len,
4478 unsigned long *storage);
4479 const struct nla_policy *policy;
4480 unsigned int maxattr;
4484 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4485 * @iftype: interface type
4486 * @extended_capabilities: extended capabilities supported by the driver,
4487 * additional capabilities might be supported by userspace; these are the
4488 * 802.11 extended capabilities ("Extended Capabilities element") and are
4489 * in the same format as in the information element. See IEEE Std
4490 * 802.11-2012 8.4.2.29 for the defined fields.
4491 * @extended_capabilities_mask: mask of the valid values
4492 * @extended_capabilities_len: length of the extended capabilities
4494 struct wiphy_iftype_ext_capab {
4495 enum nl80211_iftype iftype;
4496 const u8 *extended_capabilities;
4497 const u8 *extended_capabilities_mask;
4498 u8 extended_capabilities_len;
4502 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4503 * @max_peers: maximum number of peers in a single measurement
4504 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4505 * @randomize_mac_addr: can randomize MAC address for measurement
4506 * @ftm.supported: FTM measurement is supported
4507 * @ftm.asap: ASAP-mode is supported
4508 * @ftm.non_asap: non-ASAP-mode is supported
4509 * @ftm.request_lci: can request LCI data
4510 * @ftm.request_civicloc: can request civic location data
4511 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4512 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4513 * @ftm.max_bursts_exponent: maximum burst exponent supported
4514 * (set to -1 if not limited; note that setting this will necessarily
4515 * forbid using the value 15 to let the responder pick)
4516 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4518 * @ftm.trigger_based: trigger based ranging measurement is supported
4519 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
4521 struct cfg80211_pmsr_capabilities {
4522 unsigned int max_peers;
4524 randomize_mac_addr:1;
4529 s8 max_bursts_exponent;
4530 u8 max_ftms_per_burst;
4537 non_trigger_based:1;
4542 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4543 * suites for interface types defined in @iftypes_mask. Each type in the
4544 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4546 * @iftypes_mask: bitmask of interfaces types
4547 * @akm_suites: points to an array of supported akm suites
4548 * @n_akm_suites: number of supported AKM suites
4550 struct wiphy_iftype_akm_suites {
4552 const u32 *akm_suites;
4557 * struct wiphy - wireless hardware description
4558 * @reg_notifier: the driver's regulatory notification callback,
4559 * note that if your driver uses wiphy_apply_custom_regulatory()
4560 * the reg_notifier's request can be passed as NULL
4561 * @regd: the driver's regulatory domain, if one was requested via
4562 * the regulatory_hint() API. This can be used by the driver
4563 * on the reg_notifier() if it chooses to ignore future
4564 * regulatory domain changes caused by other drivers.
4565 * @signal_type: signal type reported in &struct cfg80211_bss.
4566 * @cipher_suites: supported cipher suites
4567 * @n_cipher_suites: number of supported cipher suites
4568 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4569 * the supported AKMs not advertized for a specific interface type in
4570 * iftype_akm_suites.
4571 * @n_akm_suites: number of supported AKM suites
4572 * @iftype_akm_suites: array of supported akm suites info per interface type.
4573 * Note that the bits in @iftypes_mask inside this structure cannot
4574 * overlap (i.e. only one occurrence of each type is allowed across all
4575 * instances of iftype_akm_suites).
4576 * @num_iftype_akm_suites: number of interface types for which supported akm
4577 * suites are specified separately.
4578 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4579 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4580 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4581 * -1 = fragmentation disabled, only odd values >= 256 used
4582 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4583 * @_net: the network namespace this wiphy currently lives in
4584 * @perm_addr: permanent MAC address of this device
4585 * @addr_mask: If the device supports multiple MAC addresses by masking,
4586 * set this to a mask with variable bits set to 1, e.g. if the last
4587 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4588 * variable bits shall be determined by the interfaces added, with
4589 * interfaces not matching the mask being rejected to be brought up.
4590 * @n_addresses: number of addresses in @addresses.
4591 * @addresses: If the device has more than one address, set this pointer
4592 * to a list of addresses (6 bytes each). The first one will be used
4593 * by default for perm_addr. In this case, the mask should be set to
4594 * all-zeroes. In this case it is assumed that the device can handle
4595 * the same number of arbitrary MAC addresses.
4596 * @registered: protects ->resume and ->suspend sysfs callbacks against
4597 * unregister hardware
4598 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4599 * It will be renamed automatically on wiphy renames
4600 * @dev: (virtual) struct device for this wiphy. The item in
4601 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4603 * @wext: wireless extension handlers
4604 * @priv: driver private data (sized according to wiphy_new() parameter)
4605 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4606 * must be set by driver
4607 * @iface_combinations: Valid interface combinations array, should not
4608 * list single interface types.
4609 * @n_iface_combinations: number of entries in @iface_combinations array.
4610 * @software_iftypes: bitmask of software interface types, these are not
4611 * subject to any restrictions since they are purely managed in SW.
4612 * @flags: wiphy flags, see &enum wiphy_flags
4613 * @regulatory_flags: wiphy regulatory flags, see
4614 * &enum ieee80211_regulatory_flags
4615 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4616 * @ext_features: extended features advertised to nl80211, see
4617 * &enum nl80211_ext_feature_index.
4618 * @bss_priv_size: each BSS struct has private data allocated with it,
4619 * this variable determines its size
4620 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4622 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4623 * the device can run concurrently.
4624 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4625 * for in any given scheduled scan
4626 * @max_match_sets: maximum number of match sets the device can handle
4627 * when performing a scheduled scan, 0 if filtering is not
4629 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4630 * add to probe request frames transmitted during a scan, must not
4631 * include fixed IEs like supported rates
4632 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4634 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4635 * of iterations) for scheduled scan supported by the device.
4636 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4637 * single scan plan supported by the device.
4638 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4639 * scan plan supported by the device.
4640 * @coverage_class: current coverage class
4641 * @fw_version: firmware version for ethtool reporting
4642 * @hw_version: hardware version for ethtool reporting
4643 * @max_num_pmkids: maximum number of PMKIDs supported by device
4644 * @privid: a pointer that drivers can use to identify if an arbitrary
4645 * wiphy is theirs, e.g. in global notifiers
4646 * @bands: information about bands/channels supported by this device
4648 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4649 * transmitted through nl80211, points to an array indexed by interface
4652 * @available_antennas_tx: bitmap of antennas which are available to be
4653 * configured as TX antennas. Antenna configuration commands will be
4654 * rejected unless this or @available_antennas_rx is set.
4656 * @available_antennas_rx: bitmap of antennas which are available to be
4657 * configured as RX antennas. Antenna configuration commands will be
4658 * rejected unless this or @available_antennas_tx is set.
4660 * @probe_resp_offload:
4661 * Bitmap of supported protocols for probe response offloading.
4662 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4663 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4665 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4666 * may request, if implemented.
4668 * @wowlan: WoWLAN support information
4669 * @wowlan_config: current WoWLAN configuration; this should usually not be
4670 * used since access to it is necessarily racy, use the parameter passed
4671 * to the suspend() operation instead.
4673 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4674 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4675 * If null, then none can be over-ridden.
4676 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4677 * If null, then none can be over-ridden.
4679 * @wdev_list: the list of associated (virtual) interfaces; this list must
4680 * not be modified by the driver, but can be read with RTNL/RCU protection.
4682 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4685 * @extended_capabilities: extended capabilities supported by the driver,
4686 * additional capabilities might be supported by userspace; these are
4687 * the 802.11 extended capabilities ("Extended Capabilities element")
4688 * and are in the same format as in the information element. See
4689 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4690 * extended capabilities to be used if the capabilities are not specified
4691 * for a specific interface type in iftype_ext_capab.
4692 * @extended_capabilities_mask: mask of the valid values
4693 * @extended_capabilities_len: length of the extended capabilities
4694 * @iftype_ext_capab: array of extended capabilities per interface type
4695 * @num_iftype_ext_capab: number of interface types for which extended
4696 * capabilities are specified separately.
4697 * @coalesce: packet coalescing support information
4699 * @vendor_commands: array of vendor commands supported by the hardware
4700 * @n_vendor_commands: number of vendor commands
4701 * @vendor_events: array of vendor events supported by the hardware
4702 * @n_vendor_events: number of vendor events
4704 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4705 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4706 * driver is allowed to advertise a theoretical limit that it can reach in
4707 * some cases, but may not always reach.
4709 * @max_num_csa_counters: Number of supported csa_counters in beacons
4710 * and probe responses. This value should be set if the driver
4711 * wishes to limit the number of csa counters. Default (0) means
4713 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4714 * by the driver in the .connect() callback. The bit position maps to the
4715 * attribute indices defined in &enum nl80211_bss_select_attr.
4717 * @nan_supported_bands: bands supported by the device in NAN mode, a
4718 * bitmap of &enum nl80211_band values. For instance, for
4719 * NL80211_BAND_2GHZ, bit 0 would be set
4720 * (i.e. BIT(NL80211_BAND_2GHZ)).
4722 * @txq_limit: configuration of internal TX queue frame limit
4723 * @txq_memory_limit: configuration internal TX queue memory limit
4724 * @txq_quantum: configuration of internal TX queue scheduler quantum
4726 * @tx_queue_len: allow setting transmit queue len for drivers not using
4729 * @support_mbssid: can HW support association with nontransmitted AP
4730 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4731 * HE AP, in order to avoid compatibility issues.
4732 * @support_mbssid must be set for this to have any effect.
4734 * @pmsr_capa: peer measurement capabilities
4736 * @tid_config_support: describes the per-TID config support that the
4738 * @tid_config_support.vif: bitmap of attributes (configurations)
4739 * supported by the driver for each vif
4740 * @tid_config_support.peer: bitmap of attributes (configurations)
4741 * supported by the driver for each peer
4742 * @tid_config_support.max_retry: maximum supported retry count for
4743 * long/short retry configuration
4745 * @max_data_retry_count: maximum supported per TID retry count for
4746 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
4747 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
4750 /* assign these fields before you register the wiphy */
4752 u8 perm_addr[ETH_ALEN];
4753 u8 addr_mask[ETH_ALEN];
4755 struct mac_address *addresses;
4757 const struct ieee80211_txrx_stypes *mgmt_stypes;
4759 const struct ieee80211_iface_combination *iface_combinations;
4760 int n_iface_combinations;
4761 u16 software_iftypes;
4765 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4766 u16 interface_modes;
4768 u16 max_acl_mac_addrs;
4770 u32 flags, regulatory_flags, features;
4771 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4775 enum cfg80211_signal_type signal_type;
4779 u8 max_sched_scan_reqs;
4780 u8 max_sched_scan_ssids;
4782 u16 max_scan_ie_len;
4783 u16 max_sched_scan_ie_len;
4784 u32 max_sched_scan_plans;
4785 u32 max_sched_scan_plan_interval;
4786 u32 max_sched_scan_plan_iterations;
4788 int n_cipher_suites;
4789 const u32 *cipher_suites;
4792 const u32 *akm_suites;
4794 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
4795 unsigned int num_iftype_akm_suites;
4803 char fw_version[ETHTOOL_FWVERS_LEN];
4807 const struct wiphy_wowlan_support *wowlan;
4808 struct cfg80211_wowlan *wowlan_config;
4811 u16 max_remain_on_channel_duration;
4815 u32 available_antennas_tx;
4816 u32 available_antennas_rx;
4818 u32 probe_resp_offload;
4820 const u8 *extended_capabilities, *extended_capabilities_mask;
4821 u8 extended_capabilities_len;
4823 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4824 unsigned int num_iftype_ext_capab;
4828 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4830 void (*reg_notifier)(struct wiphy *wiphy,
4831 struct regulatory_request *request);
4833 /* fields below are read-only, assigned by cfg80211 */
4835 const struct ieee80211_regdomain __rcu *regd;
4841 struct dentry *debugfsdir;
4843 const struct ieee80211_ht_cap *ht_capa_mod_mask;
4844 const struct ieee80211_vht_cap *vht_capa_mod_mask;
4846 struct list_head wdev_list;
4848 possible_net_t _net;
4850 #ifdef CONFIG_CFG80211_WEXT
4851 const struct iw_handler_def *wext;
4854 const struct wiphy_coalesce_support *coalesce;
4856 const struct wiphy_vendor_command *vendor_commands;
4857 const struct nl80211_vendor_cmd_info *vendor_events;
4858 int n_vendor_commands, n_vendor_events;
4860 u16 max_ap_assoc_sta;
4862 u8 max_num_csa_counters;
4864 u32 bss_select_support;
4866 u8 nan_supported_bands;
4869 u32 txq_memory_limit;
4872 unsigned long tx_queue_len;
4874 u8 support_mbssid:1,
4875 support_only_he_mbssid:1;
4877 const struct cfg80211_pmsr_capabilities *pmsr_capa;
4882 } tid_config_support;
4884 u8 max_data_retry_count;
4886 char priv[] __aligned(NETDEV_ALIGN);
4889 static inline struct net *wiphy_net(struct wiphy *wiphy)
4891 return read_pnet(&wiphy->_net);
4894 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4896 write_pnet(&wiphy->_net, net);
4900 * wiphy_priv - return priv from wiphy
4902 * @wiphy: the wiphy whose priv pointer to return
4903 * Return: The priv of @wiphy.
4905 static inline void *wiphy_priv(struct wiphy *wiphy)
4908 return &wiphy->priv;
4912 * priv_to_wiphy - return the wiphy containing the priv
4914 * @priv: a pointer previously returned by wiphy_priv
4915 * Return: The wiphy of @priv.
4917 static inline struct wiphy *priv_to_wiphy(void *priv)
4920 return container_of(priv, struct wiphy, priv);
4924 * set_wiphy_dev - set device pointer for wiphy
4926 * @wiphy: The wiphy whose device to bind
4927 * @dev: The device to parent it to
4929 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4931 wiphy->dev.parent = dev;
4935 * wiphy_dev - get wiphy dev pointer
4937 * @wiphy: The wiphy whose device struct to look up
4938 * Return: The dev of @wiphy.
4940 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4942 return wiphy->dev.parent;
4946 * wiphy_name - get wiphy name
4948 * @wiphy: The wiphy whose name to return
4949 * Return: The name of @wiphy.
4951 static inline const char *wiphy_name(const struct wiphy *wiphy)
4953 return dev_name(&wiphy->dev);
4957 * wiphy_new_nm - create a new wiphy for use with cfg80211
4959 * @ops: The configuration operations for this device
4960 * @sizeof_priv: The size of the private area to allocate
4961 * @requested_name: Request a particular name.
4962 * NULL is valid value, and means use the default phy%d naming.
4964 * Create a new wiphy and associate the given operations with it.
4965 * @sizeof_priv bytes are allocated for private use.
4967 * Return: A pointer to the new wiphy. This pointer must be
4968 * assigned to each netdev's ieee80211_ptr for proper operation.
4970 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4971 const char *requested_name);
4974 * wiphy_new - create a new wiphy for use with cfg80211
4976 * @ops: The configuration operations for this device
4977 * @sizeof_priv: The size of the private area to allocate
4979 * Create a new wiphy and associate the given operations with it.
4980 * @sizeof_priv bytes are allocated for private use.
4982 * Return: A pointer to the new wiphy. This pointer must be
4983 * assigned to each netdev's ieee80211_ptr for proper operation.
4985 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4988 return wiphy_new_nm(ops, sizeof_priv, NULL);
4992 * wiphy_register - register a wiphy with cfg80211
4994 * @wiphy: The wiphy to register.
4996 * Return: A non-negative wiphy index or a negative error code.
4998 int wiphy_register(struct wiphy *wiphy);
5001 * wiphy_unregister - deregister a wiphy from cfg80211
5003 * @wiphy: The wiphy to unregister.
5005 * After this call, no more requests can be made with this priv
5006 * pointer, but the call may sleep to wait for an outstanding
5007 * request that is being handled.
5009 void wiphy_unregister(struct wiphy *wiphy);
5012 * wiphy_free - free wiphy
5014 * @wiphy: The wiphy to free
5016 void wiphy_free(struct wiphy *wiphy);
5018 /* internal structs */
5019 struct cfg80211_conn;
5020 struct cfg80211_internal_bss;
5021 struct cfg80211_cached_keys;
5022 struct cfg80211_cqm_config;
5025 * struct wireless_dev - wireless device state
5027 * For netdevs, this structure must be allocated by the driver
5028 * that uses the ieee80211_ptr field in struct net_device (this
5029 * is intentional so it can be allocated along with the netdev.)
5030 * It need not be registered then as netdev registration will
5031 * be intercepted by cfg80211 to see the new wireless device.
5033 * For non-netdev uses, it must also be allocated by the driver
5034 * in response to the cfg80211 callbacks that require it, as
5035 * there's no netdev registration in that case it may not be
5036 * allocated outside of callback operations that return it.
5038 * @wiphy: pointer to hardware description
5039 * @iftype: interface type
5040 * @list: (private) Used to collect the interfaces
5041 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5042 * @identifier: (private) Identifier used in nl80211 to identify this
5043 * wireless device if it has no netdev
5044 * @current_bss: (private) Used by the internal configuration code
5045 * @chandef: (private) Used by the internal configuration code to track
5046 * the user-set channel definition.
5047 * @preset_chandef: (private) Used by the internal configuration code to
5048 * track the channel to be used for AP later
5049 * @bssid: (private) Used by the internal configuration code
5050 * @ssid: (private) Used by the internal configuration code
5051 * @ssid_len: (private) Used by the internal configuration code
5052 * @mesh_id_len: (private) Used by the internal configuration code
5053 * @mesh_id_up_len: (private) Used by the internal configuration code
5054 * @wext: (private) Used by the internal wireless extensions compat code
5055 * @wext.ibss: (private) IBSS data part of wext handling
5056 * @wext.connect: (private) connection handling data
5057 * @wext.keys: (private) (WEP) key data
5058 * @wext.ie: (private) extra elements for association
5059 * @wext.ie_len: (private) length of extra elements
5060 * @wext.bssid: (private) selected network BSSID
5061 * @wext.ssid: (private) selected network SSID
5062 * @wext.default_key: (private) selected default key index
5063 * @wext.default_mgmt_key: (private) selected default management key index
5064 * @wext.prev_bssid: (private) previous BSSID for reassociation
5065 * @wext.prev_bssid_valid: (private) previous BSSID validity
5066 * @use_4addr: indicates 4addr mode is used on this interface, must be
5067 * set by driver (if supported) on add_interface BEFORE registering the
5068 * netdev and may otherwise be used by driver read-only, will be update
5069 * by cfg80211 on change_interface
5070 * @mgmt_registrations: list of registrations for management frames
5071 * @mgmt_registrations_lock: lock for the list
5072 * @mgmt_registrations_update_wk: update work to defer from atomic context
5073 * @mtx: mutex used to lock data in this struct, may be used by drivers
5074 * and some API functions require it held
5075 * @beacon_interval: beacon interval used on this device for transmitting
5076 * beacons, 0 when not valid
5077 * @address: The address for this device, valid only if @netdev is %NULL
5078 * @is_running: true if this is a non-netdev device that has been started, e.g.
5080 * @cac_started: true if DFS channel availability check has been started
5081 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5082 * @cac_time_ms: CAC time in ms
5083 * @ps: powersave mode is enabled
5084 * @ps_timeout: dynamic powersave timeout
5085 * @ap_unexpected_nlportid: (private) netlink port ID of application
5086 * registered for unexpected class 3 frames (AP mode)
5087 * @conn: (private) cfg80211 software SME connection state machine data
5088 * @connect_keys: (private) keys to set after connection is established
5089 * @conn_bss_type: connecting/connected BSS type
5090 * @conn_owner_nlportid: (private) connection owner socket port ID
5091 * @disconnect_wk: (private) auto-disconnect work
5092 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5093 * @ibss_fixed: (private) IBSS is using fixed BSSID
5094 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
5095 * @event_list: (private) list for internal event processing
5096 * @event_lock: (private) lock for event list
5097 * @owner_nlportid: (private) owner socket port ID
5098 * @nl_owner_dead: (private) owner socket went away
5099 * @cqm_config: (private) nl80211 RSSI monitor state
5100 * @pmsr_list: (private) peer measurement requests
5101 * @pmsr_lock: (private) peer measurements requests/results lock
5102 * @pmsr_free_wk: (private) peer measurements cleanup work
5103 * @unprot_beacon_reported: (private) timestamp of last
5104 * unprotected beacon report
5106 struct wireless_dev {
5107 struct wiphy *wiphy;
5108 enum nl80211_iftype iftype;
5110 /* the remainder of this struct should be private to cfg80211 */
5111 struct list_head list;
5112 struct net_device *netdev;
5116 struct list_head mgmt_registrations;
5117 spinlock_t mgmt_registrations_lock;
5118 struct work_struct mgmt_registrations_update_wk;
5122 bool use_4addr, is_running;
5124 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5126 /* currently used for IBSS and SME - might be rearranged later */
5127 u8 ssid[IEEE80211_MAX_SSID_LEN];
5128 u8 ssid_len, mesh_id_len, mesh_id_up_len;
5129 struct cfg80211_conn *conn;
5130 struct cfg80211_cached_keys *connect_keys;
5131 enum ieee80211_bss_type conn_bss_type;
5132 u32 conn_owner_nlportid;
5134 struct work_struct disconnect_wk;
5135 u8 disconnect_bssid[ETH_ALEN];
5137 struct list_head event_list;
5138 spinlock_t event_lock;
5140 struct cfg80211_internal_bss *current_bss; /* associated / joined */
5141 struct cfg80211_chan_def preset_chandef;
5142 struct cfg80211_chan_def chandef;
5145 bool ibss_dfs_possible;
5150 int beacon_interval;
5152 u32 ap_unexpected_nlportid;
5158 unsigned long cac_start_time;
5159 unsigned int cac_time_ms;
5161 #ifdef CONFIG_CFG80211_WEXT
5164 struct cfg80211_ibss_params ibss;
5165 struct cfg80211_connect_params connect;
5166 struct cfg80211_cached_keys *keys;
5170 u8 prev_bssid[ETH_ALEN];
5171 u8 ssid[IEEE80211_MAX_SSID_LEN];
5172 s8 default_key, default_mgmt_key;
5173 bool prev_bssid_valid;
5177 struct cfg80211_cqm_config *cqm_config;
5179 struct list_head pmsr_list;
5180 spinlock_t pmsr_lock;
5181 struct work_struct pmsr_free_wk;
5183 unsigned long unprot_beacon_reported;
5186 static inline u8 *wdev_address(struct wireless_dev *wdev)
5189 return wdev->netdev->dev_addr;
5190 return wdev->address;
5193 static inline bool wdev_running(struct wireless_dev *wdev)
5196 return netif_running(wdev->netdev);
5197 return wdev->is_running;
5201 * wdev_priv - return wiphy priv from wireless_dev
5203 * @wdev: The wireless device whose wiphy's priv pointer to return
5204 * Return: The wiphy priv of @wdev.
5206 static inline void *wdev_priv(struct wireless_dev *wdev)
5209 return wiphy_priv(wdev->wiphy);
5213 * DOC: Utility functions
5215 * cfg80211 offers a number of utility functions that can be useful.
5219 * ieee80211_channel_equal - compare two struct ieee80211_channel
5221 * @a: 1st struct ieee80211_channel
5222 * @b: 2nd struct ieee80211_channel
5223 * Return: true if center frequency of @a == @b
5226 ieee80211_channel_equal(struct ieee80211_channel *a,
5227 struct ieee80211_channel *b)
5229 return (a->center_freq == b->center_freq &&
5230 a->freq_offset == b->freq_offset);
5234 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5235 * @chan: struct ieee80211_channel to convert
5236 * Return: The corresponding frequency (in KHz)
5239 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5241 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5245 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5246 * @chan: channel number
5247 * @band: band, necessary due to channel number overlap
5248 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5250 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5253 * ieee80211_channel_to_frequency - convert channel number to frequency
5254 * @chan: channel number
5255 * @band: band, necessary due to channel number overlap
5256 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5259 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5261 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5265 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5266 * @freq: center frequency in KHz
5267 * Return: The corresponding channel, or 0 if the conversion failed.
5269 int ieee80211_freq_khz_to_channel(u32 freq);
5272 * ieee80211_frequency_to_channel - convert frequency to channel number
5273 * @freq: center frequency in MHz
5274 * Return: The corresponding channel, or 0 if the conversion failed.
5277 ieee80211_frequency_to_channel(int freq)
5279 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5283 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5285 * @wiphy: the struct wiphy to get the channel for
5286 * @freq: the center frequency (in KHz) of the channel
5287 * Return: The channel struct from @wiphy at @freq.
5289 struct ieee80211_channel *
5290 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5293 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5295 * @wiphy: the struct wiphy to get the channel for
5296 * @freq: the center frequency (in MHz) of the channel
5297 * Return: The channel struct from @wiphy at @freq.
5299 static inline struct ieee80211_channel *
5300 ieee80211_get_channel(struct wiphy *wiphy, int freq)
5302 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5306 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5307 * @chan: control channel to check
5309 * The Preferred Scanning Channels (PSC) are defined in
5310 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5312 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
5314 if (chan->band != NL80211_BAND_6GHZ)
5317 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
5321 * ieee80211_get_response_rate - get basic rate for a given rate
5323 * @sband: the band to look for rates in
5324 * @basic_rates: bitmap of basic rates
5325 * @bitrate: the bitrate for which to find the basic rate
5327 * Return: The basic rate corresponding to a given bitrate, that
5328 * is the next lower bitrate contained in the basic rate map,
5329 * which is, for this function, given as a bitmap of indices of
5330 * rates in the band's bitrate table.
5332 struct ieee80211_rate *
5333 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5334 u32 basic_rates, int bitrate);
5337 * ieee80211_mandatory_rates - get mandatory rates for a given band
5338 * @sband: the band to look for rates in
5339 * @scan_width: width of the control channel
5341 * This function returns a bitmap of the mandatory rates for the given
5342 * band, bits are set according to the rate position in the bitrates array.
5344 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5345 enum nl80211_bss_scan_width scan_width);
5348 * Radiotap parsing functions -- for controlled injection support
5350 * Implemented in net/wireless/radiotap.c
5351 * Documentation in Documentation/networking/radiotap-headers.rst
5354 struct radiotap_align_size {
5355 uint8_t align:4, size:4;
5358 struct ieee80211_radiotap_namespace {
5359 const struct radiotap_align_size *align_size;
5365 struct ieee80211_radiotap_vendor_namespaces {
5366 const struct ieee80211_radiotap_namespace *ns;
5371 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5372 * @this_arg_index: index of current arg, valid after each successful call
5373 * to ieee80211_radiotap_iterator_next()
5374 * @this_arg: pointer to current radiotap arg; it is valid after each
5375 * call to ieee80211_radiotap_iterator_next() but also after
5376 * ieee80211_radiotap_iterator_init() where it will point to
5377 * the beginning of the actual data portion
5378 * @this_arg_size: length of the current arg, for convenience
5379 * @current_namespace: pointer to the current namespace definition
5380 * (or internally %NULL if the current namespace is unknown)
5381 * @is_radiotap_ns: indicates whether the current namespace is the default
5382 * radiotap namespace or not
5384 * @_rtheader: pointer to the radiotap header we are walking through
5385 * @_max_length: length of radiotap header in cpu byte ordering
5386 * @_arg_index: next argument index
5387 * @_arg: next argument pointer
5388 * @_next_bitmap: internal pointer to next present u32
5389 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5390 * @_vns: vendor namespace definitions
5391 * @_next_ns_data: beginning of the next namespace's data
5392 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5395 * Describes the radiotap parser state. Fields prefixed with an underscore
5396 * must not be used by users of the parser, only by the parser internally.
5399 struct ieee80211_radiotap_iterator {
5400 struct ieee80211_radiotap_header *_rtheader;
5401 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5402 const struct ieee80211_radiotap_namespace *current_namespace;
5404 unsigned char *_arg, *_next_ns_data;
5405 __le32 *_next_bitmap;
5407 unsigned char *this_arg;
5415 uint32_t _bitmap_shifter;
5420 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5421 struct ieee80211_radiotap_header *radiotap_header,
5423 const struct ieee80211_radiotap_vendor_namespaces *vns);
5426 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5429 extern const unsigned char rfc1042_header[6];
5430 extern const unsigned char bridge_tunnel_header[6];
5433 * ieee80211_get_hdrlen_from_skb - get header length from data
5437 * Given an skb with a raw 802.11 header at the data pointer this function
5438 * returns the 802.11 header length.
5440 * Return: The 802.11 header length in bytes (not including encryption
5441 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5444 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5447 * ieee80211_hdrlen - get header length in bytes from frame control
5448 * @fc: frame control field in little-endian format
5449 * Return: The header length in bytes.
5451 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5454 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5455 * @meshhdr: the mesh extension header, only the flags field
5456 * (first byte) will be accessed
5457 * Return: The length of the extension header, which is always at
5458 * least 6 bytes and at most 18 if address 5 and 6 are present.
5460 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5463 * DOC: Data path helpers
5465 * In addition to generic utilities, cfg80211 also offers
5466 * functions that help implement the data path for devices
5467 * that do not do the 802.11/802.3 conversion on the device.
5471 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5472 * @skb: the 802.11 data frame
5473 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5474 * of it being pushed into the SKB
5475 * @addr: the device MAC address
5476 * @iftype: the virtual interface type
5477 * @data_offset: offset of payload after the 802.11 header
5478 * Return: 0 on success. Non-zero on error.
5480 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5481 const u8 *addr, enum nl80211_iftype iftype,
5485 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5486 * @skb: the 802.11 data frame
5487 * @addr: the device MAC address
5488 * @iftype: the virtual interface type
5489 * Return: 0 on success. Non-zero on error.
5491 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5492 enum nl80211_iftype iftype)
5494 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5498 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5500 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5501 * The @list will be empty if the decode fails. The @skb must be fully
5502 * header-less before being passed in here; it is freed in this function.
5504 * @skb: The input A-MSDU frame without any headers.
5505 * @list: The output list of 802.3 frames. It must be allocated and
5506 * initialized by by the caller.
5507 * @addr: The device MAC address.
5508 * @iftype: The device interface type.
5509 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5510 * @check_da: DA to check in the inner ethernet header, or NULL
5511 * @check_sa: SA to check in the inner ethernet header, or NULL
5513 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5514 const u8 *addr, enum nl80211_iftype iftype,
5515 const unsigned int extra_headroom,
5516 const u8 *check_da, const u8 *check_sa);
5519 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5520 * @skb: the data frame
5521 * @qos_map: Interworking QoS mapping or %NULL if not in use
5522 * Return: The 802.1p/1d tag.
5524 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5525 struct cfg80211_qos_map *qos_map);
5528 * cfg80211_find_elem_match - match information element and byte array in data
5531 * @ies: data consisting of IEs
5532 * @len: length of data
5533 * @match: byte array to match
5534 * @match_len: number of bytes in the match array
5535 * @match_offset: offset in the IE data where the byte array should match.
5536 * Note the difference to cfg80211_find_ie_match() which considers
5537 * the offset to start from the element ID byte, but here we take
5538 * the data portion instead.
5540 * Return: %NULL if the element ID could not be found or if
5541 * the element is invalid (claims to be longer than the given
5542 * data) or if the byte array doesn't match; otherwise return the
5543 * requested element struct.
5545 * Note: There are no checks on the element length other than
5546 * having to fit into the given data and being large enough for the
5547 * byte array to match.
5549 const struct element *
5550 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5551 const u8 *match, unsigned int match_len,
5552 unsigned int match_offset);
5555 * cfg80211_find_ie_match - match information element and byte array in data
5558 * @ies: data consisting of IEs
5559 * @len: length of data
5560 * @match: byte array to match
5561 * @match_len: number of bytes in the match array
5562 * @match_offset: offset in the IE where the byte array should match.
5563 * If match_len is zero, this must also be set to zero.
5564 * Otherwise this must be set to 2 or more, because the first
5565 * byte is the element id, which is already compared to eid, and
5566 * the second byte is the IE length.
5568 * Return: %NULL if the element ID could not be found or if
5569 * the element is invalid (claims to be longer than the given
5570 * data) or if the byte array doesn't match, or a pointer to the first
5571 * byte of the requested element, that is the byte containing the
5574 * Note: There are no checks on the element length other than
5575 * having to fit into the given data and being large enough for the
5576 * byte array to match.
5578 static inline const u8 *
5579 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5580 const u8 *match, unsigned int match_len,
5581 unsigned int match_offset)
5583 /* match_offset can't be smaller than 2, unless match_len is
5584 * zero, in which case match_offset must be zero as well.
5586 if (WARN_ON((match_len && match_offset < 2) ||
5587 (!match_len && match_offset)))
5590 return (void *)cfg80211_find_elem_match(eid, ies, len,
5593 match_offset - 2 : 0);
5597 * cfg80211_find_elem - find information element in data
5600 * @ies: data consisting of IEs
5601 * @len: length of data
5603 * Return: %NULL if the element ID could not be found or if
5604 * the element is invalid (claims to be longer than the given
5605 * data) or if the byte array doesn't match; otherwise return the
5606 * requested element struct.
5608 * Note: There are no checks on the element length other than
5609 * having to fit into the given data.
5611 static inline const struct element *
5612 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5614 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5618 * cfg80211_find_ie - find information element in data
5621 * @ies: data consisting of IEs
5622 * @len: length of data
5624 * Return: %NULL if the element ID could not be found or if
5625 * the element is invalid (claims to be longer than the given
5626 * data), or a pointer to the first byte of the requested
5627 * element, that is the byte containing the element ID.
5629 * Note: There are no checks on the element length other than
5630 * having to fit into the given data.
5632 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5634 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5638 * cfg80211_find_ext_elem - find information element with EID Extension in data
5640 * @ext_eid: element ID Extension
5641 * @ies: data consisting of IEs
5642 * @len: length of data
5644 * Return: %NULL if the etended element could not be found or if
5645 * the element is invalid (claims to be longer than the given
5646 * data) or if the byte array doesn't match; otherwise return the
5647 * requested element struct.
5649 * Note: There are no checks on the element length other than
5650 * having to fit into the given data.
5652 static inline const struct element *
5653 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5655 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5660 * cfg80211_find_ext_ie - find information element with EID Extension in data
5662 * @ext_eid: element ID Extension
5663 * @ies: data consisting of IEs
5664 * @len: length of data
5666 * Return: %NULL if the extended element ID could not be found or if
5667 * the element is invalid (claims to be longer than the given
5668 * data), or a pointer to the first byte of the requested
5669 * element, that is the byte containing the element ID.
5671 * Note: There are no checks on the element length other than
5672 * having to fit into the given data.
5674 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5676 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5681 * cfg80211_find_vendor_elem - find vendor specific information element in data
5684 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5685 * @ies: data consisting of IEs
5686 * @len: length of data
5688 * Return: %NULL if the vendor specific element ID could not be found or if the
5689 * element is invalid (claims to be longer than the given data); otherwise
5690 * return the element structure for the requested element.
5692 * Note: There are no checks on the element length other than having to fit into
5695 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5700 * cfg80211_find_vendor_ie - find vendor specific information element in data
5703 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5704 * @ies: data consisting of IEs
5705 * @len: length of data
5707 * Return: %NULL if the vendor specific element ID could not be found or if the
5708 * element is invalid (claims to be longer than the given data), or a pointer to
5709 * the first byte of the requested element, that is the byte containing the
5712 * Note: There are no checks on the element length other than having to fit into
5715 static inline const u8 *
5716 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5717 const u8 *ies, unsigned int len)
5719 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5723 * cfg80211_send_layer2_update - send layer 2 update frame
5725 * @dev: network device
5726 * @addr: STA MAC address
5728 * Wireless drivers can use this function to update forwarding tables in bridge
5729 * devices upon STA association.
5731 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5734 * DOC: Regulatory enforcement infrastructure
5740 * regulatory_hint - driver hint to the wireless core a regulatory domain
5741 * @wiphy: the wireless device giving the hint (used only for reporting
5743 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5744 * should be in. If @rd is set this should be NULL. Note that if you
5745 * set this to NULL you should still set rd->alpha2 to some accepted
5748 * Wireless drivers can use this function to hint to the wireless core
5749 * what it believes should be the current regulatory domain by
5750 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5751 * domain should be in or by providing a completely build regulatory domain.
5752 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5753 * for a regulatory domain structure for the respective country.
5755 * The wiphy must have been registered to cfg80211 prior to this call.
5756 * For cfg80211 drivers this means you must first use wiphy_register(),
5757 * for mac80211 drivers you must first use ieee80211_register_hw().
5759 * Drivers should check the return value, its possible you can get
5762 * Return: 0 on success. -ENOMEM.
5764 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5767 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5768 * @wiphy: the wireless device we want to process the regulatory domain on
5769 * @rd: the regulatory domain informatoin to use for this wiphy
5771 * Set the regulatory domain information for self-managed wiphys, only they
5772 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5775 * Return: 0 on success. -EINVAL, -EPERM
5777 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5778 struct ieee80211_regdomain *rd);
5781 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5782 * @wiphy: the wireless device we want to process the regulatory domain on
5783 * @rd: the regulatory domain information to use for this wiphy
5785 * This functions requires the RTNL to be held and applies the new regdomain
5786 * synchronously to this wiphy. For more details see
5787 * regulatory_set_wiphy_regd().
5789 * Return: 0 on success. -EINVAL, -EPERM
5791 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5792 struct ieee80211_regdomain *rd);
5795 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5796 * @wiphy: the wireless device we want to process the regulatory domain on
5797 * @regd: the custom regulatory domain to use for this wiphy
5799 * Drivers can sometimes have custom regulatory domains which do not apply
5800 * to a specific country. Drivers can use this to apply such custom regulatory
5801 * domains. This routine must be called prior to wiphy registration. The
5802 * custom regulatory domain will be trusted completely and as such previous
5803 * default channel settings will be disregarded. If no rule is found for a
5804 * channel on the regulatory domain the channel will be disabled.
5805 * Drivers using this for a wiphy should also set the wiphy flag
5806 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5807 * that called this helper.
5809 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5810 const struct ieee80211_regdomain *regd);
5813 * freq_reg_info - get regulatory information for the given frequency
5814 * @wiphy: the wiphy for which we want to process this rule for
5815 * @center_freq: Frequency in KHz for which we want regulatory information for
5817 * Use this function to get the regulatory rule for a specific frequency on
5818 * a given wireless device. If the device has a specific regulatory domain
5819 * it wants to follow we respect that unless a country IE has been received
5820 * and processed already.
5822 * Return: A valid pointer, or, when an error occurs, for example if no rule
5823 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5824 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5825 * value will be -ERANGE if we determine the given center_freq does not even
5826 * have a regulatory rule for a frequency range in the center_freq's band.
5827 * See freq_in_rule_band() for our current definition of a band -- this is
5828 * purely subjective and right now it's 802.11 specific.
5830 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5834 * reg_initiator_name - map regulatory request initiator enum to name
5835 * @initiator: the regulatory request initiator
5837 * You can use this to map the regulatory request initiator enum to a
5838 * proper string representation.
5840 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5843 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
5844 * @wiphy: wiphy for which pre-CAC capability is checked.
5846 * Pre-CAC is allowed only in some regdomains (notable ETSI).
5848 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
5851 * DOC: Internal regulatory db functions
5856 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
5857 * Regulatory self-managed driver can use it to proactively
5859 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5860 * @freq: the freqency(in MHz) to be queried.
5861 * @rule: pointer to store the wmm rule from the regulatory db.
5863 * Self-managed wireless drivers can use this function to query
5864 * the internal regulatory database to check whether the given
5865 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5867 * Drivers should check the return value, its possible you can get
5870 * Return: 0 on success. -ENODATA.
5872 int reg_query_regdb_wmm(char *alpha2, int freq,
5873 struct ieee80211_reg_rule *rule);
5876 * callbacks for asynchronous cfg80211 methods, notification
5877 * functions and BSS handling helpers
5881 * cfg80211_scan_done - notify that scan finished
5883 * @request: the corresponding scan request
5884 * @info: information about the completed scan
5886 void cfg80211_scan_done(struct cfg80211_scan_request *request,
5887 struct cfg80211_scan_info *info);
5890 * cfg80211_sched_scan_results - notify that new scan results are available
5892 * @wiphy: the wiphy which got scheduled scan results
5893 * @reqid: identifier for the related scheduled scan request
5895 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
5898 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5900 * @wiphy: the wiphy on which the scheduled scan stopped
5901 * @reqid: identifier for the related scheduled scan request
5903 * The driver can call this function to inform cfg80211 that the
5904 * scheduled scan had to be stopped, for whatever reason. The driver
5905 * is then called back via the sched_scan_stop operation when done.
5907 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
5910 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5912 * @wiphy: the wiphy on which the scheduled scan stopped
5913 * @reqid: identifier for the related scheduled scan request
5915 * The driver can call this function to inform cfg80211 that the
5916 * scheduled scan had to be stopped, for whatever reason. The driver
5917 * is then called back via the sched_scan_stop operation when done.
5918 * This function should be called with rtnl locked.
5920 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
5923 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5924 * @wiphy: the wiphy reporting the BSS
5925 * @data: the BSS metadata
5926 * @mgmt: the management frame (probe response or beacon)
5927 * @len: length of the management frame
5928 * @gfp: context flags
5930 * This informs cfg80211 that BSS information was found and
5931 * the BSS should be updated/added.
5933 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5934 * Or %NULL on error.
5936 struct cfg80211_bss * __must_check
5937 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
5938 struct cfg80211_inform_bss *data,
5939 struct ieee80211_mgmt *mgmt, size_t len,
5942 static inline struct cfg80211_bss * __must_check
5943 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
5944 struct ieee80211_channel *rx_channel,
5945 enum nl80211_bss_scan_width scan_width,
5946 struct ieee80211_mgmt *mgmt, size_t len,
5947 s32 signal, gfp_t gfp)
5949 struct cfg80211_inform_bss data = {
5951 .scan_width = scan_width,
5955 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5958 static inline struct cfg80211_bss * __must_check
5959 cfg80211_inform_bss_frame(struct wiphy *wiphy,
5960 struct ieee80211_channel *rx_channel,
5961 struct ieee80211_mgmt *mgmt, size_t len,
5962 s32 signal, gfp_t gfp)
5964 struct cfg80211_inform_bss data = {
5966 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5970 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5974 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5975 * @bssid: transmitter BSSID
5976 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5977 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5978 * @new_bssid: calculated nontransmitted BSSID
5980 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
5981 u8 mbssid_index, u8 *new_bssid)
5983 u64 bssid_u64 = ether_addr_to_u64(bssid);
5984 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
5987 new_bssid_u64 = bssid_u64 & ~mask;
5989 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
5991 u64_to_ether_addr(new_bssid_u64, new_bssid);
5995 * cfg80211_is_element_inherited - returns if element ID should be inherited
5996 * @element: element to check
5997 * @non_inherit_element: non inheritance element
5999 bool cfg80211_is_element_inherited(const struct element *element,
6000 const struct element *non_inherit_element);
6003 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6005 * @ielen: length of IEs
6006 * @mbssid_elem: current MBSSID element
6007 * @sub_elem: current MBSSID subelement (profile)
6008 * @merged_ie: location of the merged profile
6009 * @max_copy_len: max merged profile length
6011 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6012 const struct element *mbssid_elem,
6013 const struct element *sub_elem,
6014 u8 *merged_ie, size_t max_copy_len);
6017 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6018 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6019 * from a beacon or probe response
6020 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6021 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6023 enum cfg80211_bss_frame_type {
6024 CFG80211_BSS_FTYPE_UNKNOWN,
6025 CFG80211_BSS_FTYPE_BEACON,
6026 CFG80211_BSS_FTYPE_PRESP,
6030 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6032 * @wiphy: the wiphy reporting the BSS
6033 * @data: the BSS metadata
6034 * @ftype: frame type (if known)
6035 * @bssid: the BSSID of the BSS
6036 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6037 * @capability: the capability field sent by the peer
6038 * @beacon_interval: the beacon interval announced by the peer
6039 * @ie: additional IEs sent by the peer
6040 * @ielen: length of the additional IEs
6041 * @gfp: context flags
6043 * This informs cfg80211 that BSS information was found and
6044 * the BSS should be updated/added.
6046 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6047 * Or %NULL on error.
6049 struct cfg80211_bss * __must_check
6050 cfg80211_inform_bss_data(struct wiphy *wiphy,
6051 struct cfg80211_inform_bss *data,
6052 enum cfg80211_bss_frame_type ftype,
6053 const u8 *bssid, u64 tsf, u16 capability,
6054 u16 beacon_interval, const u8 *ie, size_t ielen,
6057 static inline struct cfg80211_bss * __must_check
6058 cfg80211_inform_bss_width(struct wiphy *wiphy,
6059 struct ieee80211_channel *rx_channel,
6060 enum nl80211_bss_scan_width scan_width,
6061 enum cfg80211_bss_frame_type ftype,
6062 const u8 *bssid, u64 tsf, u16 capability,
6063 u16 beacon_interval, const u8 *ie, size_t ielen,
6064 s32 signal, gfp_t gfp)
6066 struct cfg80211_inform_bss data = {
6068 .scan_width = scan_width,
6072 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6073 capability, beacon_interval, ie, ielen,
6077 static inline struct cfg80211_bss * __must_check
6078 cfg80211_inform_bss(struct wiphy *wiphy,
6079 struct ieee80211_channel *rx_channel,
6080 enum cfg80211_bss_frame_type ftype,
6081 const u8 *bssid, u64 tsf, u16 capability,
6082 u16 beacon_interval, const u8 *ie, size_t ielen,
6083 s32 signal, gfp_t gfp)
6085 struct cfg80211_inform_bss data = {
6087 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6091 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6092 capability, beacon_interval, ie, ielen,
6097 * cfg80211_get_bss - get a BSS reference
6098 * @wiphy: the wiphy this BSS struct belongs to
6099 * @channel: the channel to search on (or %NULL)
6100 * @bssid: the desired BSSID (or %NULL)
6101 * @ssid: the desired SSID (or %NULL)
6102 * @ssid_len: length of the SSID (or 0)
6103 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6104 * @privacy: privacy filter, see &enum ieee80211_privacy
6106 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6107 struct ieee80211_channel *channel,
6109 const u8 *ssid, size_t ssid_len,
6110 enum ieee80211_bss_type bss_type,
6111 enum ieee80211_privacy privacy);
6112 static inline struct cfg80211_bss *
6113 cfg80211_get_ibss(struct wiphy *wiphy,
6114 struct ieee80211_channel *channel,
6115 const u8 *ssid, size_t ssid_len)
6117 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6118 IEEE80211_BSS_TYPE_IBSS,
6119 IEEE80211_PRIVACY_ANY);
6123 * cfg80211_ref_bss - reference BSS struct
6124 * @wiphy: the wiphy this BSS struct belongs to
6125 * @bss: the BSS struct to reference
6127 * Increments the refcount of the given BSS struct.
6129 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6132 * cfg80211_put_bss - unref BSS struct
6133 * @wiphy: the wiphy this BSS struct belongs to
6134 * @bss: the BSS struct
6136 * Decrements the refcount of the given BSS struct.
6138 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6141 * cfg80211_unlink_bss - unlink BSS from internal data structures
6143 * @bss: the bss to remove
6145 * This function removes the given BSS from the internal data structures
6146 * thereby making it no longer show up in scan results etc. Use this
6147 * function when you detect a BSS is gone. Normally BSSes will also time
6148 * out, so it is not necessary to use this function at all.
6150 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6153 * cfg80211_bss_iter - iterate all BSS entries
6155 * This function iterates over the BSS entries associated with the given wiphy
6156 * and calls the callback for the iterated BSS. The iterator function is not
6157 * allowed to call functions that might modify the internal state of the BSS DB.
6160 * @chandef: if given, the iterator function will be called only if the channel
6161 * of the currently iterated BSS is a subset of the given channel.
6162 * @iter: the iterator function to call
6163 * @iter_data: an argument to the iterator function
6165 void cfg80211_bss_iter(struct wiphy *wiphy,
6166 struct cfg80211_chan_def *chandef,
6167 void (*iter)(struct wiphy *wiphy,
6168 struct cfg80211_bss *bss,
6172 static inline enum nl80211_bss_scan_width
6173 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6175 switch (chandef->width) {
6176 case NL80211_CHAN_WIDTH_5:
6177 return NL80211_BSS_CHAN_WIDTH_5;
6178 case NL80211_CHAN_WIDTH_10:
6179 return NL80211_BSS_CHAN_WIDTH_10;
6181 return NL80211_BSS_CHAN_WIDTH_20;
6186 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6187 * @dev: network device
6188 * @buf: authentication frame (header + body)
6189 * @len: length of the frame data
6191 * This function is called whenever an authentication, disassociation or
6192 * deauthentication frame has been received and processed in station mode.
6193 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6194 * call either this function or cfg80211_auth_timeout().
6195 * After being asked to associate via cfg80211_ops::assoc() the driver must
6196 * call either this function or cfg80211_auth_timeout().
6197 * While connected, the driver must calls this for received and processed
6198 * disassociation and deauthentication frames. If the frame couldn't be used
6199 * because it was unprotected, the driver must call the function
6200 * cfg80211_rx_unprot_mlme_mgmt() instead.
6202 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6204 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6207 * cfg80211_auth_timeout - notification of timed out authentication
6208 * @dev: network device
6209 * @addr: The MAC address of the device with which the authentication timed out
6211 * This function may sleep. The caller must hold the corresponding wdev's
6214 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6217 * cfg80211_rx_assoc_resp - notification of processed association response
6218 * @dev: network device
6219 * @bss: the BSS that association was requested with, ownership of the pointer
6220 * moves to cfg80211 in this call
6221 * @buf: (Re)Association Response frame (header + body)
6222 * @len: length of the frame data
6223 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6224 * as the AC bitmap in the QoS info field
6225 * @req_ies: information elements from the (Re)Association Request frame
6226 * @req_ies_len: length of req_ies data
6228 * After being asked to associate via cfg80211_ops::assoc() the driver must
6229 * call either this function or cfg80211_auth_timeout().
6231 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6233 void cfg80211_rx_assoc_resp(struct net_device *dev,
6234 struct cfg80211_bss *bss,
6235 const u8 *buf, size_t len,
6237 const u8 *req_ies, size_t req_ies_len);
6240 * cfg80211_assoc_timeout - notification of timed out association
6241 * @dev: network device
6242 * @bss: The BSS entry with which association timed out.
6244 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6246 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6249 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6250 * @dev: network device
6251 * @bss: The BSS entry with which association was abandoned.
6253 * Call this whenever - for reasons reported through other API, like deauth RX,
6254 * an association attempt was abandoned.
6255 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6257 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6260 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6261 * @dev: network device
6262 * @buf: 802.11 frame (header + body)
6263 * @len: length of the frame data
6265 * This function is called whenever deauthentication has been processed in
6266 * station mode. This includes both received deauthentication frames and
6267 * locally generated ones. This function may sleep. The caller must hold the
6268 * corresponding wdev's mutex.
6270 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6273 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6274 * @dev: network device
6275 * @buf: received management frame (header + body)
6276 * @len: length of the frame data
6278 * This function is called whenever a received deauthentication or dissassoc
6279 * frame has been dropped in station mode because of MFP being used but the
6280 * frame was not protected. This is also used to notify reception of a Beacon
6281 * frame that was dropped because it did not include a valid MME MIC while
6282 * beacon protection was enabled (BIGTK configured in station mode).
6284 * This function may sleep.
6286 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6287 const u8 *buf, size_t len);
6290 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6291 * @dev: network device
6292 * @addr: The source MAC address of the frame
6293 * @key_type: The key type that the received frame used
6294 * @key_id: Key identifier (0..3). Can be -1 if missing.
6295 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6296 * @gfp: allocation flags
6298 * This function is called whenever the local MAC detects a MIC failure in a
6299 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6302 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6303 enum nl80211_key_type key_type, int key_id,
6304 const u8 *tsc, gfp_t gfp);
6307 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6309 * @dev: network device
6310 * @bssid: the BSSID of the IBSS joined
6311 * @channel: the channel of the IBSS joined
6312 * @gfp: allocation flags
6314 * This function notifies cfg80211 that the device joined an IBSS or
6315 * switched to a different BSSID. Before this function can be called,
6316 * either a beacon has to have been received from the IBSS, or one of
6317 * the cfg80211_inform_bss{,_frame} functions must have been called
6318 * with the locally generated beacon -- this guarantees that there is
6319 * always a scan result for this IBSS. cfg80211 will handle the rest.
6321 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6322 struct ieee80211_channel *channel, gfp_t gfp);
6325 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
6327 * @dev: network device
6328 * @macaddr: the MAC address of the new candidate
6329 * @ie: information elements advertised by the peer candidate
6330 * @ie_len: length of the information elements buffer
6331 * @gfp: allocation flags
6333 * This function notifies cfg80211 that the mesh peer candidate has been
6334 * detected, most likely via a beacon or, less likely, via a probe response.
6335 * cfg80211 then sends a notification to userspace.
6337 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6338 const u8 *macaddr, const u8 *ie, u8 ie_len,
6339 int sig_dbm, gfp_t gfp);
6342 * DOC: RFkill integration
6344 * RFkill integration in cfg80211 is almost invisible to drivers,
6345 * as cfg80211 automatically registers an rfkill instance for each
6346 * wireless device it knows about. Soft kill is also translated
6347 * into disconnecting and turning all interfaces off, drivers are
6348 * expected to turn off the device when all interfaces are down.
6350 * However, devices may have a hard RFkill line, in which case they
6351 * also need to interact with the rfkill subsystem, via cfg80211.
6352 * They can do this with a few helper functions documented here.
6356 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6358 * @blocked: block status
6360 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
6363 * wiphy_rfkill_start_polling - start polling rfkill
6366 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6369 * wiphy_rfkill_stop_polling - stop polling rfkill
6372 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
6375 * DOC: Vendor commands
6377 * Occasionally, there are special protocol or firmware features that
6378 * can't be implemented very openly. For this and similar cases, the
6379 * vendor command functionality allows implementing the features with
6380 * (typically closed-source) userspace and firmware, using nl80211 as
6381 * the configuration mechanism.
6383 * A driver supporting vendor commands must register them as an array
6384 * in struct wiphy, with handlers for each one, each command has an
6385 * OUI and sub command ID to identify it.
6387 * Note that this feature should not be (ab)used to implement protocol
6388 * features that could openly be shared across drivers. In particular,
6389 * it must never be required to use vendor commands to implement any
6390 * "normal" functionality that higher-level userspace like connection
6391 * managers etc. need.
6394 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6395 enum nl80211_commands cmd,
6396 enum nl80211_attrs attr,
6399 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6400 struct wireless_dev *wdev,
6401 enum nl80211_commands cmd,
6402 enum nl80211_attrs attr,
6403 unsigned int portid,
6404 int vendor_event_idx,
6405 int approxlen, gfp_t gfp);
6407 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6410 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6412 * @approxlen: an upper bound of the length of the data that will
6413 * be put into the skb
6415 * This function allocates and pre-fills an skb for a reply to
6416 * a vendor command. Since it is intended for a reply, calling
6417 * it outside of a vendor command's doit() operation is invalid.
6419 * The returned skb is pre-filled with some identifying data in
6420 * a way that any data that is put into the skb (with skb_put(),
6421 * nla_put() or similar) will end up being within the
6422 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6423 * with the skb is adding data for the corresponding userspace tool
6424 * which can then read that data out of the vendor data attribute.
6425 * You must not modify the skb in any other way.
6427 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6428 * its error code as the result of the doit() operation.
6430 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6432 static inline struct sk_buff *
6433 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6435 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6436 NL80211_ATTR_VENDOR_DATA, approxlen);
6440 * cfg80211_vendor_cmd_reply - send the reply skb
6441 * @skb: The skb, must have been allocated with
6442 * cfg80211_vendor_cmd_alloc_reply_skb()
6444 * Since calling this function will usually be the last thing
6445 * before returning from the vendor command doit() you should
6446 * return the error code. Note that this function consumes the
6447 * skb regardless of the return value.
6449 * Return: An error code or 0 on success.
6451 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6454 * cfg80211_vendor_cmd_get_sender
6457 * Return the current netlink port ID in a vendor command handler.
6458 * Valid to call only there.
6460 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6463 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6465 * @wdev: the wireless device
6466 * @event_idx: index of the vendor event in the wiphy's vendor_events
6467 * @approxlen: an upper bound of the length of the data that will
6468 * be put into the skb
6469 * @gfp: allocation flags
6471 * This function allocates and pre-fills an skb for an event on the
6472 * vendor-specific multicast group.
6474 * If wdev != NULL, both the ifindex and identifier of the specified
6475 * wireless device are added to the event message before the vendor data
6478 * When done filling the skb, call cfg80211_vendor_event() with the
6479 * skb to send the event.
6481 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6483 static inline struct sk_buff *
6484 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6485 int approxlen, int event_idx, gfp_t gfp)
6487 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6488 NL80211_ATTR_VENDOR_DATA,
6489 0, event_idx, approxlen, gfp);
6493 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6495 * @wdev: the wireless device
6496 * @event_idx: index of the vendor event in the wiphy's vendor_events
6497 * @portid: port ID of the receiver
6498 * @approxlen: an upper bound of the length of the data that will
6499 * be put into the skb
6500 * @gfp: allocation flags
6502 * This function allocates and pre-fills an skb for an event to send to
6503 * a specific (userland) socket. This socket would previously have been
6504 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6505 * care to register a netlink notifier to see when the socket closes.
6507 * If wdev != NULL, both the ifindex and identifier of the specified
6508 * wireless device are added to the event message before the vendor data
6511 * When done filling the skb, call cfg80211_vendor_event() with the
6512 * skb to send the event.
6514 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6516 static inline struct sk_buff *
6517 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6518 struct wireless_dev *wdev,
6519 unsigned int portid, int approxlen,
6520 int event_idx, gfp_t gfp)
6522 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6523 NL80211_ATTR_VENDOR_DATA,
6524 portid, event_idx, approxlen, gfp);
6528 * cfg80211_vendor_event - send the event
6529 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6530 * @gfp: allocation flags
6532 * This function sends the given @skb, which must have been allocated
6533 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6535 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6537 __cfg80211_send_event_skb(skb, gfp);
6540 #ifdef CONFIG_NL80211_TESTMODE
6544 * Test mode is a set of utility functions to allow drivers to
6545 * interact with driver-specific tools to aid, for instance,
6546 * factory programming.
6548 * This chapter describes how drivers interact with it, for more
6549 * information see the nl80211 book's chapter on it.
6553 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6555 * @approxlen: an upper bound of the length of the data that will
6556 * be put into the skb
6558 * This function allocates and pre-fills an skb for a reply to
6559 * the testmode command. Since it is intended for a reply, calling
6560 * it outside of the @testmode_cmd operation is invalid.
6562 * The returned skb is pre-filled with the wiphy index and set up in
6563 * a way that any data that is put into the skb (with skb_put(),
6564 * nla_put() or similar) will end up being within the
6565 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6566 * with the skb is adding data for the corresponding userspace tool
6567 * which can then read that data out of the testdata attribute. You
6568 * must not modify the skb in any other way.
6570 * When done, call cfg80211_testmode_reply() with the skb and return
6571 * its error code as the result of the @testmode_cmd operation.
6573 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6575 static inline struct sk_buff *
6576 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6578 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6579 NL80211_ATTR_TESTDATA, approxlen);
6583 * cfg80211_testmode_reply - send the reply skb
6584 * @skb: The skb, must have been allocated with
6585 * cfg80211_testmode_alloc_reply_skb()
6587 * Since calling this function will usually be the last thing
6588 * before returning from the @testmode_cmd you should return
6589 * the error code. Note that this function consumes the skb
6590 * regardless of the return value.
6592 * Return: An error code or 0 on success.
6594 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6596 return cfg80211_vendor_cmd_reply(skb);
6600 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6602 * @approxlen: an upper bound of the length of the data that will
6603 * be put into the skb
6604 * @gfp: allocation flags
6606 * This function allocates and pre-fills an skb for an event on the
6607 * testmode multicast group.
6609 * The returned skb is set up in the same way as with
6610 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6611 * there, you should simply add data to it that will then end up in the
6612 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6615 * When done filling the skb, call cfg80211_testmode_event() with the
6616 * skb to send the event.
6618 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6620 static inline struct sk_buff *
6621 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6623 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6624 NL80211_ATTR_TESTDATA, 0, -1,
6629 * cfg80211_testmode_event - send the event
6630 * @skb: The skb, must have been allocated with
6631 * cfg80211_testmode_alloc_event_skb()
6632 * @gfp: allocation flags
6634 * This function sends the given @skb, which must have been allocated
6635 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6638 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6640 __cfg80211_send_event_skb(skb, gfp);
6643 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6644 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6646 #define CFG80211_TESTMODE_CMD(cmd)
6647 #define CFG80211_TESTMODE_DUMP(cmd)
6651 * struct cfg80211_fils_resp_params - FILS connection response params
6652 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6653 * @kek_len: Length of @fils_kek in octets
6654 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6655 * @erp_next_seq_num is valid.
6656 * @erp_next_seq_num: The next sequence number to use in ERP message in
6657 * FILS Authentication. This value should be specified irrespective of the
6658 * status for a FILS connection.
6659 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6660 * @pmk_len: Length of @pmk in octets
6661 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6662 * used for this FILS connection (may be %NULL).
6664 struct cfg80211_fils_resp_params {
6667 bool update_erp_next_seq_num;
6668 u16 erp_next_seq_num;
6675 * struct cfg80211_connect_resp_params - Connection response params
6676 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6677 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6678 * the real status code for failures. If this call is used to report a
6679 * failure due to a timeout (e.g., not receiving an Authentication frame
6680 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6681 * indicate that this is a failure, but without a status code.
6682 * @timeout_reason is used to report the reason for the timeout in that
6684 * @bssid: The BSSID of the AP (may be %NULL)
6685 * @bss: Entry of bss to which STA got connected to, can be obtained through
6686 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6687 * bss from the connect_request and hold a reference to it and return
6688 * through this param to avoid a warning if the bss is expired during the
6689 * connection, esp. for those drivers implementing connect op.
6690 * Only one parameter among @bssid and @bss needs to be specified.
6691 * @req_ie: Association request IEs (may be %NULL)
6692 * @req_ie_len: Association request IEs length
6693 * @resp_ie: Association response IEs (may be %NULL)
6694 * @resp_ie_len: Association response IEs length
6695 * @fils: FILS connection response parameters.
6696 * @timeout_reason: Reason for connection timeout. This is used when the
6697 * connection fails due to a timeout instead of an explicit rejection from
6698 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6699 * not known. This value is used only if @status < 0 to indicate that the
6700 * failure is due to a timeout and not due to explicit rejection by the AP.
6701 * This value is ignored in other cases (@status >= 0).
6703 struct cfg80211_connect_resp_params {
6706 struct cfg80211_bss *bss;
6711 struct cfg80211_fils_resp_params fils;
6712 enum nl80211_timeout_reason timeout_reason;
6716 * cfg80211_connect_done - notify cfg80211 of connection result
6718 * @dev: network device
6719 * @params: connection response parameters
6720 * @gfp: allocation flags
6722 * It should be called by the underlying driver once execution of the connection
6723 * request from connect() has been completed. This is similar to
6724 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6725 * parameters. Only one of the functions among cfg80211_connect_bss(),
6726 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6727 * and cfg80211_connect_done() should be called.
6729 void cfg80211_connect_done(struct net_device *dev,
6730 struct cfg80211_connect_resp_params *params,
6734 * cfg80211_connect_bss - notify cfg80211 of connection result
6736 * @dev: network device
6737 * @bssid: the BSSID of the AP
6738 * @bss: Entry of bss to which STA got connected to, can be obtained through
6739 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6740 * bss from the connect_request and hold a reference to it and return
6741 * through this param to avoid a warning if the bss is expired during the
6742 * connection, esp. for those drivers implementing connect op.
6743 * Only one parameter among @bssid and @bss needs to be specified.
6744 * @req_ie: association request IEs (maybe be %NULL)
6745 * @req_ie_len: association request IEs length
6746 * @resp_ie: association response IEs (may be %NULL)
6747 * @resp_ie_len: assoc response IEs length
6748 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6749 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6750 * the real status code for failures. If this call is used to report a
6751 * failure due to a timeout (e.g., not receiving an Authentication frame
6752 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6753 * indicate that this is a failure, but without a status code.
6754 * @timeout_reason is used to report the reason for the timeout in that
6756 * @gfp: allocation flags
6757 * @timeout_reason: reason for connection timeout. This is used when the
6758 * connection fails due to a timeout instead of an explicit rejection from
6759 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6760 * not known. This value is used only if @status < 0 to indicate that the
6761 * failure is due to a timeout and not due to explicit rejection by the AP.
6762 * This value is ignored in other cases (@status >= 0).
6764 * It should be called by the underlying driver once execution of the connection
6765 * request from connect() has been completed. This is similar to
6766 * cfg80211_connect_result(), but with the option of identifying the exact bss
6767 * entry for the connection. Only one of the functions among
6768 * cfg80211_connect_bss(), cfg80211_connect_result(),
6769 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6772 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6773 struct cfg80211_bss *bss, const u8 *req_ie,
6774 size_t req_ie_len, const u8 *resp_ie,
6775 size_t resp_ie_len, int status, gfp_t gfp,
6776 enum nl80211_timeout_reason timeout_reason)
6778 struct cfg80211_connect_resp_params params;
6780 memset(¶ms, 0, sizeof(params));
6781 params.status = status;
6782 params.bssid = bssid;
6784 params.req_ie = req_ie;
6785 params.req_ie_len = req_ie_len;
6786 params.resp_ie = resp_ie;
6787 params.resp_ie_len = resp_ie_len;
6788 params.timeout_reason = timeout_reason;
6790 cfg80211_connect_done(dev, ¶ms, gfp);
6794 * cfg80211_connect_result - notify cfg80211 of connection result
6796 * @dev: network device
6797 * @bssid: the BSSID of the AP
6798 * @req_ie: association request IEs (maybe be %NULL)
6799 * @req_ie_len: association request IEs length
6800 * @resp_ie: association response IEs (may be %NULL)
6801 * @resp_ie_len: assoc response IEs length
6802 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6803 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6804 * the real status code for failures.
6805 * @gfp: allocation flags
6807 * It should be called by the underlying driver once execution of the connection
6808 * request from connect() has been completed. This is similar to
6809 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6810 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6811 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6814 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6815 const u8 *req_ie, size_t req_ie_len,
6816 const u8 *resp_ie, size_t resp_ie_len,
6817 u16 status, gfp_t gfp)
6819 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6820 resp_ie_len, status, gfp,
6821 NL80211_TIMEOUT_UNSPECIFIED);
6825 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6827 * @dev: network device
6828 * @bssid: the BSSID of the AP
6829 * @req_ie: association request IEs (maybe be %NULL)
6830 * @req_ie_len: association request IEs length
6831 * @gfp: allocation flags
6832 * @timeout_reason: reason for connection timeout.
6834 * It should be called by the underlying driver whenever connect() has failed
6835 * in a sequence where no explicit authentication/association rejection was
6836 * received from the AP. This could happen, e.g., due to not being able to send
6837 * out the Authentication or Association Request frame or timing out while
6838 * waiting for the response. Only one of the functions among
6839 * cfg80211_connect_bss(), cfg80211_connect_result(),
6840 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6843 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6844 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6845 enum nl80211_timeout_reason timeout_reason)
6847 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6848 gfp, timeout_reason);
6852 * struct cfg80211_roam_info - driver initiated roaming information
6854 * @channel: the channel of the new AP
6855 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6856 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6857 * @req_ie: association request IEs (maybe be %NULL)
6858 * @req_ie_len: association request IEs length
6859 * @resp_ie: association response IEs (may be %NULL)
6860 * @resp_ie_len: assoc response IEs length
6861 * @fils: FILS related roaming information.
6863 struct cfg80211_roam_info {
6864 struct ieee80211_channel *channel;
6865 struct cfg80211_bss *bss;
6871 struct cfg80211_fils_resp_params fils;
6875 * cfg80211_roamed - notify cfg80211 of roaming
6877 * @dev: network device
6878 * @info: information about the new BSS. struct &cfg80211_roam_info.
6879 * @gfp: allocation flags
6881 * This function may be called with the driver passing either the BSSID of the
6882 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6883 * It should be called by the underlying driver whenever it roamed from one AP
6884 * to another while connected. Drivers which have roaming implemented in
6885 * firmware should pass the bss entry to avoid a race in bss entry timeout where
6886 * the bss entry of the new AP is seen in the driver, but gets timed out by the
6887 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6888 * rdev->event_work. In case of any failures, the reference is released
6889 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6890 * released while disconnecting from the current bss.
6892 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
6896 * cfg80211_port_authorized - notify cfg80211 of successful security association
6898 * @dev: network device
6899 * @bssid: the BSSID of the AP
6900 * @gfp: allocation flags
6902 * This function should be called by a driver that supports 4 way handshake
6903 * offload after a security association was successfully established (i.e.,
6904 * the 4 way handshake was completed successfully). The call to this function
6905 * should be preceded with a call to cfg80211_connect_result(),
6906 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6907 * indicate the 802.11 association.
6909 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
6913 * cfg80211_disconnected - notify cfg80211 that connection was dropped
6915 * @dev: network device
6916 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6917 * @ie_len: length of IEs
6918 * @reason: reason code for the disconnection, set it to 0 if unknown
6919 * @locally_generated: disconnection was requested locally
6920 * @gfp: allocation flags
6922 * After it calls this function, the driver should enter an idle state
6923 * and not try to connect to any AP any more.
6925 void cfg80211_disconnected(struct net_device *dev, u16 reason,
6926 const u8 *ie, size_t ie_len,
6927 bool locally_generated, gfp_t gfp);
6930 * cfg80211_ready_on_channel - notification of remain_on_channel start
6931 * @wdev: wireless device
6932 * @cookie: the request cookie
6933 * @chan: The current channel (from remain_on_channel request)
6934 * @duration: Duration in milliseconds that the driver intents to remain on the
6936 * @gfp: allocation flags
6938 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
6939 struct ieee80211_channel *chan,
6940 unsigned int duration, gfp_t gfp);
6943 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6944 * @wdev: wireless device
6945 * @cookie: the request cookie
6946 * @chan: The current channel (from remain_on_channel request)
6947 * @gfp: allocation flags
6949 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
6950 struct ieee80211_channel *chan,
6954 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
6955 * @wdev: wireless device
6956 * @cookie: the requested cookie
6957 * @chan: The current channel (from tx_mgmt request)
6958 * @gfp: allocation flags
6960 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
6961 struct ieee80211_channel *chan, gfp_t gfp);
6964 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6966 * @sinfo: the station information
6967 * @gfp: allocation flags
6969 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
6972 * cfg80211_sinfo_release_content - release contents of station info
6973 * @sinfo: the station information
6975 * Releases any potentially allocated sub-information of the station
6976 * information, but not the struct itself (since it's typically on
6979 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
6981 kfree(sinfo->pertid);
6985 * cfg80211_new_sta - notify userspace about station
6988 * @mac_addr: the station's address
6989 * @sinfo: the station information
6990 * @gfp: allocation flags
6992 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
6993 struct station_info *sinfo, gfp_t gfp);
6996 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6998 * @mac_addr: the station's address
6999 * @sinfo: the station information/statistics
7000 * @gfp: allocation flags
7002 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7003 struct station_info *sinfo, gfp_t gfp);
7006 * cfg80211_del_sta - notify userspace about deletion of a station
7009 * @mac_addr: the station's address
7010 * @gfp: allocation flags
7012 static inline void cfg80211_del_sta(struct net_device *dev,
7013 const u8 *mac_addr, gfp_t gfp)
7015 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7019 * cfg80211_conn_failed - connection request failed notification
7022 * @mac_addr: the station's address
7023 * @reason: the reason for connection failure
7024 * @gfp: allocation flags
7026 * Whenever a station tries to connect to an AP and if the station
7027 * could not connect to the AP as the AP has rejected the connection
7028 * for some reasons, this function is called.
7030 * The reason for connection failure can be any of the value from
7031 * nl80211_connect_failed_reason enum
7033 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7034 enum nl80211_connect_failed_reason reason,
7038 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7039 * @wdev: wireless device receiving the frame
7040 * @freq: Frequency on which the frame was received in KHz
7041 * @sig_dbm: signal strength in dBm, or 0 if unknown
7042 * @buf: Management frame (header + body)
7043 * @len: length of the frame data
7044 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7046 * This function is called whenever an Action frame is received for a station
7047 * mode interface, but is not processed in kernel.
7049 * Return: %true if a user space application has registered for this frame.
7050 * For action frames, that makes it responsible for rejecting unrecognized
7051 * action frames; %false otherwise, in which case for action frames the
7052 * driver is responsible for rejecting the frame.
7054 bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq, int sig_dbm,
7055 const u8 *buf, size_t len, u32 flags);
7058 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7059 * @wdev: wireless device receiving the frame
7060 * @freq: Frequency on which the frame was received in MHz
7061 * @sig_dbm: signal strength in dBm, or 0 if unknown
7062 * @buf: Management frame (header + body)
7063 * @len: length of the frame data
7064 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7066 * This function is called whenever an Action frame is received for a station
7067 * mode interface, but is not processed in kernel.
7069 * Return: %true if a user space application has registered for this frame.
7070 * For action frames, that makes it responsible for rejecting unrecognized
7071 * action frames; %false otherwise, in which case for action frames the
7072 * driver is responsible for rejecting the frame.
7074 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7075 int sig_dbm, const u8 *buf, size_t len,
7078 return cfg80211_rx_mgmt_khz(wdev, MHZ_TO_KHZ(freq), sig_dbm, buf, len,
7083 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7084 * @wdev: wireless device receiving the frame
7085 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7086 * @buf: Management frame (header + body)
7087 * @len: length of the frame data
7088 * @ack: Whether frame was acknowledged
7089 * @gfp: context flags
7091 * This function is called whenever a management frame was requested to be
7092 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7093 * transmission attempt.
7095 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
7096 const u8 *buf, size_t len, bool ack, gfp_t gfp);
7099 * cfg80211_control_port_tx_status - notification of TX status for control
7101 * @wdev: wireless device receiving the frame
7102 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7103 * @buf: Data frame (header + body)
7104 * @len: length of the frame data
7105 * @ack: Whether frame was acknowledged
7106 * @gfp: context flags
7108 * This function is called whenever a control port frame was requested to be
7109 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7110 * the transmission attempt.
7112 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
7113 const u8 *buf, size_t len, bool ack,
7117 * cfg80211_rx_control_port - notification about a received control port frame
7118 * @dev: The device the frame matched to
7119 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7120 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7121 * This function does not take ownership of the skb, so the caller is
7122 * responsible for any cleanup. The caller must also ensure that
7123 * skb->protocol is set appropriately.
7124 * @unencrypted: Whether the frame was received unencrypted
7126 * This function is used to inform userspace about a received control port
7127 * frame. It should only be used if userspace indicated it wants to receive
7128 * control port frames over nl80211.
7130 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7131 * network layer headers removed (e.g. the raw EAPoL frame).
7133 * Return: %true if the frame was passed to userspace
7135 bool cfg80211_rx_control_port(struct net_device *dev,
7136 struct sk_buff *skb, bool unencrypted);
7139 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
7140 * @dev: network device
7141 * @rssi_event: the triggered RSSI event
7142 * @rssi_level: new RSSI level value or 0 if not available
7143 * @gfp: context flags
7145 * This function is called when a configured connection quality monitoring
7146 * rssi threshold reached event occurs.
7148 void cfg80211_cqm_rssi_notify(struct net_device *dev,
7149 enum nl80211_cqm_rssi_threshold_event rssi_event,
7150 s32 rssi_level, gfp_t gfp);
7153 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
7154 * @dev: network device
7155 * @peer: peer's MAC address
7156 * @num_packets: how many packets were lost -- should be a fixed threshold
7157 * but probably no less than maybe 50, or maybe a throughput dependent
7158 * threshold (to account for temporary interference)
7159 * @gfp: context flags
7161 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
7162 const u8 *peer, u32 num_packets, gfp_t gfp);
7165 * cfg80211_cqm_txe_notify - TX error rate event
7166 * @dev: network device
7167 * @peer: peer's MAC address
7168 * @num_packets: how many packets were lost
7169 * @rate: % of packets which failed transmission
7170 * @intvl: interval (in s) over which the TX failure threshold was breached.
7171 * @gfp: context flags
7173 * Notify userspace when configured % TX failures over number of packets in a
7174 * given interval is exceeded.
7176 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
7177 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
7180 * cfg80211_cqm_beacon_loss_notify - beacon loss event
7181 * @dev: network device
7182 * @gfp: context flags
7184 * Notify userspace about beacon loss from the connected AP.
7186 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
7189 * cfg80211_radar_event - radar detection event
7191 * @chandef: chandef for the current channel
7192 * @gfp: context flags
7194 * This function is called when a radar is detected on the current chanenl.
7196 void cfg80211_radar_event(struct wiphy *wiphy,
7197 struct cfg80211_chan_def *chandef, gfp_t gfp);
7200 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
7201 * @dev: network device
7202 * @mac: MAC address of a station which opmode got modified
7203 * @sta_opmode: station's current opmode value
7204 * @gfp: context flags
7206 * Driver should call this function when station's opmode modified via action
7209 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
7210 struct sta_opmode_info *sta_opmode,
7214 * cfg80211_cac_event - Channel availability check (CAC) event
7215 * @netdev: network device
7216 * @chandef: chandef for the current channel
7217 * @event: type of event
7218 * @gfp: context flags
7220 * This function is called when a Channel availability check (CAC) is finished
7221 * or aborted. This must be called to notify the completion of a CAC process,
7222 * also by full-MAC drivers.
7224 void cfg80211_cac_event(struct net_device *netdev,
7225 const struct cfg80211_chan_def *chandef,
7226 enum nl80211_radar_event event, gfp_t gfp);
7230 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
7231 * @dev: network device
7232 * @bssid: BSSID of AP (to avoid races)
7233 * @replay_ctr: new replay counter
7234 * @gfp: allocation flags
7236 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
7237 const u8 *replay_ctr, gfp_t gfp);
7240 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7241 * @dev: network device
7242 * @index: candidate index (the smaller the index, the higher the priority)
7243 * @bssid: BSSID of AP
7244 * @preauth: Whether AP advertises support for RSN pre-authentication
7245 * @gfp: allocation flags
7247 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
7248 const u8 *bssid, bool preauth, gfp_t gfp);
7251 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7252 * @dev: The device the frame matched to
7253 * @addr: the transmitter address
7254 * @gfp: context flags
7256 * This function is used in AP mode (only!) to inform userspace that
7257 * a spurious class 3 frame was received, to be able to deauth the
7259 * Return: %true if the frame was passed to userspace (or this failed
7260 * for a reason other than not having a subscription.)
7262 bool cfg80211_rx_spurious_frame(struct net_device *dev,
7263 const u8 *addr, gfp_t gfp);
7266 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7267 * @dev: The device the frame matched to
7268 * @addr: the transmitter address
7269 * @gfp: context flags
7271 * This function is used in AP mode (only!) to inform userspace that
7272 * an associated station sent a 4addr frame but that wasn't expected.
7273 * It is allowed and desirable to send this event only once for each
7274 * station to avoid event flooding.
7275 * Return: %true if the frame was passed to userspace (or this failed
7276 * for a reason other than not having a subscription.)
7278 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
7279 const u8 *addr, gfp_t gfp);
7282 * cfg80211_probe_status - notify userspace about probe status
7283 * @dev: the device the probe was sent on
7284 * @addr: the address of the peer
7285 * @cookie: the cookie filled in @probe_client previously
7286 * @acked: indicates whether probe was acked or not
7287 * @ack_signal: signal strength (in dBm) of the ACK frame.
7288 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7289 * @gfp: allocation flags
7291 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
7292 u64 cookie, bool acked, s32 ack_signal,
7293 bool is_valid_ack_signal, gfp_t gfp);
7296 * cfg80211_report_obss_beacon_khz - report beacon from other APs
7297 * @wiphy: The wiphy that received the beacon
7299 * @len: length of the frame
7300 * @freq: frequency the frame was received on in KHz
7301 * @sig_dbm: signal strength in dBm, or 0 if unknown
7303 * Use this function to report to userspace when a beacon was
7304 * received. It is not useful to call this when there is no
7305 * netdev that is in AP/GO mode.
7307 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
7308 size_t len, int freq, int sig_dbm);
7311 * cfg80211_report_obss_beacon - report beacon from other APs
7312 * @wiphy: The wiphy that received the beacon
7314 * @len: length of the frame
7315 * @freq: frequency the frame was received on
7316 * @sig_dbm: signal strength in dBm, or 0 if unknown
7318 * Use this function to report to userspace when a beacon was
7319 * received. It is not useful to call this when there is no
7320 * netdev that is in AP/GO mode.
7322 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7323 const u8 *frame, size_t len,
7324 int freq, int sig_dbm)
7326 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
7331 * cfg80211_reg_can_beacon - check if beaconing is allowed
7333 * @chandef: the channel definition
7334 * @iftype: interface type
7336 * Return: %true if there is no secondary channel or the secondary channel(s)
7337 * can be used for beaconing (i.e. is not a radar channel etc.)
7339 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7340 struct cfg80211_chan_def *chandef,
7341 enum nl80211_iftype iftype);
7344 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7346 * @chandef: the channel definition
7347 * @iftype: interface type
7349 * Return: %true if there is no secondary channel or the secondary channel(s)
7350 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7351 * also checks if IR-relaxation conditions apply, to allow beaconing under
7352 * more permissive conditions.
7354 * Requires the RTNL to be held.
7356 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7357 struct cfg80211_chan_def *chandef,
7358 enum nl80211_iftype iftype);
7361 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7362 * @dev: the device which switched channels
7363 * @chandef: the new channel definition
7365 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7368 void cfg80211_ch_switch_notify(struct net_device *dev,
7369 struct cfg80211_chan_def *chandef);
7372 * cfg80211_ch_switch_started_notify - notify channel switch start
7373 * @dev: the device on which the channel switch started
7374 * @chandef: the future channel definition
7375 * @count: the number of TBTTs until the channel switch happens
7377 * Inform the userspace about the channel switch that has just
7378 * started, so that it can take appropriate actions (eg. starting
7379 * channel switch on other vifs), if necessary.
7381 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7382 struct cfg80211_chan_def *chandef,
7386 * ieee80211_operating_class_to_band - convert operating class to band
7388 * @operating_class: the operating class to convert
7389 * @band: band pointer to fill
7391 * Returns %true if the conversion was successful, %false otherwise.
7393 bool ieee80211_operating_class_to_band(u8 operating_class,
7394 enum nl80211_band *band);
7397 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7399 * @chandef: the chandef to convert
7400 * @op_class: a pointer to the resulting operating class
7402 * Returns %true if the conversion was successful, %false otherwise.
7404 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7408 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
7410 * @chandef: the chandef to convert
7412 * Returns the center frequency of chandef (1st segment) in KHz.
7415 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
7417 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
7421 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7422 * @dev: the device on which the operation is requested
7423 * @peer: the MAC address of the peer device
7424 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7425 * NL80211_TDLS_TEARDOWN)
7426 * @reason_code: the reason code for teardown request
7427 * @gfp: allocation flags
7429 * This function is used to request userspace to perform TDLS operation that
7430 * requires knowledge of keys, i.e., link setup or teardown when the AP
7431 * connection uses encryption. This is optional mechanism for the driver to use
7432 * if it can automatically determine when a TDLS link could be useful (e.g.,
7433 * based on traffic and signal strength for a peer).
7435 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7436 enum nl80211_tdls_operation oper,
7437 u16 reason_code, gfp_t gfp);
7440 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7441 * @rate: given rate_info to calculate bitrate from
7443 * return 0 if MCS index >= 32
7445 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7448 * cfg80211_unregister_wdev - remove the given wdev
7449 * @wdev: struct wireless_dev to remove
7451 * Call this function only for wdevs that have no netdev assigned,
7452 * e.g. P2P Devices. It removes the device from the list so that
7453 * it can no longer be used. It is necessary to call this function
7454 * even when cfg80211 requests the removal of the interface by
7455 * calling the del_virtual_intf() callback. The function must also
7456 * be called when the driver wishes to unregister the wdev, e.g.
7457 * when the device is unbound from the driver.
7459 * Requires the RTNL to be held.
7461 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7464 * struct cfg80211_ft_event - FT Information Elements
7466 * @ies_len: length of the FT IE in bytes
7467 * @target_ap: target AP's MAC address
7469 * @ric_ies_len: length of the RIC IE in bytes
7471 struct cfg80211_ft_event_params {
7474 const u8 *target_ap;
7480 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7481 * @netdev: network device
7482 * @ft_event: IE information
7484 void cfg80211_ft_event(struct net_device *netdev,
7485 struct cfg80211_ft_event_params *ft_event);
7488 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7489 * @ies: the input IE buffer
7490 * @len: the input length
7491 * @attr: the attribute ID to find
7492 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7493 * if the function is only called to get the needed buffer size
7494 * @bufsize: size of the output buffer
7496 * The function finds a given P2P attribute in the (vendor) IEs and
7497 * copies its contents to the given buffer.
7499 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7500 * malformed or the attribute can't be found (respectively), or the
7501 * length of the found attribute (which can be zero).
7503 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7504 enum ieee80211_p2p_attr_id attr,
7505 u8 *buf, unsigned int bufsize);
7508 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7509 * @ies: the IE buffer
7510 * @ielen: the length of the IE buffer
7511 * @ids: an array with element IDs that are allowed before
7512 * the split. A WLAN_EID_EXTENSION value means that the next
7513 * EID in the list is a sub-element of the EXTENSION IE.
7514 * @n_ids: the size of the element ID array
7515 * @after_ric: array IE types that come after the RIC element
7516 * @n_after_ric: size of the @after_ric array
7517 * @offset: offset where to start splitting in the buffer
7519 * This function splits an IE buffer by updating the @offset
7520 * variable to point to the location where the buffer should be
7523 * It assumes that the given IE buffer is well-formed, this
7524 * has to be guaranteed by the caller!
7526 * It also assumes that the IEs in the buffer are ordered
7527 * correctly, if not the result of using this function will not
7528 * be ordered correctly either, i.e. it does no reordering.
7530 * The function returns the offset where the next part of the
7531 * buffer starts, which may be @ielen if the entire (remainder)
7532 * of the buffer should be used.
7534 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7535 const u8 *ids, int n_ids,
7536 const u8 *after_ric, int n_after_ric,
7540 * ieee80211_ie_split - split an IE buffer according to ordering
7541 * @ies: the IE buffer
7542 * @ielen: the length of the IE buffer
7543 * @ids: an array with element IDs that are allowed before
7544 * the split. A WLAN_EID_EXTENSION value means that the next
7545 * EID in the list is a sub-element of the EXTENSION IE.
7546 * @n_ids: the size of the element ID array
7547 * @offset: offset where to start splitting in the buffer
7549 * This function splits an IE buffer by updating the @offset
7550 * variable to point to the location where the buffer should be
7553 * It assumes that the given IE buffer is well-formed, this
7554 * has to be guaranteed by the caller!
7556 * It also assumes that the IEs in the buffer are ordered
7557 * correctly, if not the result of using this function will not
7558 * be ordered correctly either, i.e. it does no reordering.
7560 * The function returns the offset where the next part of the
7561 * buffer starts, which may be @ielen if the entire (remainder)
7562 * of the buffer should be used.
7564 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7565 const u8 *ids, int n_ids, size_t offset)
7567 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7571 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7572 * @wdev: the wireless device reporting the wakeup
7573 * @wakeup: the wakeup report
7574 * @gfp: allocation flags
7576 * This function reports that the given device woke up. If it
7577 * caused the wakeup, report the reason(s), otherwise you may
7578 * pass %NULL as the @wakeup parameter to advertise that something
7579 * else caused the wakeup.
7581 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7582 struct cfg80211_wowlan_wakeup *wakeup,
7586 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7588 * @wdev: the wireless device for which critical protocol is stopped.
7589 * @gfp: allocation flags
7591 * This function can be called by the driver to indicate it has reverted
7592 * operation back to normal. One reason could be that the duration given
7593 * by .crit_proto_start() has expired.
7595 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7598 * ieee80211_get_num_supported_channels - get number of channels device has
7601 * Return: the number of channels supported by the device.
7603 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7606 * cfg80211_check_combinations - check interface combinations
7609 * @params: the interface combinations parameter
7611 * This function can be called by the driver to check whether a
7612 * combination of interfaces and their types are allowed according to
7613 * the interface combinations.
7615 int cfg80211_check_combinations(struct wiphy *wiphy,
7616 struct iface_combination_params *params);
7619 * cfg80211_iter_combinations - iterate over matching combinations
7622 * @params: the interface combinations parameter
7623 * @iter: function to call for each matching combination
7624 * @data: pointer to pass to iter function
7626 * This function can be called by the driver to check what possible
7627 * combinations it fits in at a given moment, e.g. for channel switching
7630 int cfg80211_iter_combinations(struct wiphy *wiphy,
7631 struct iface_combination_params *params,
7632 void (*iter)(const struct ieee80211_iface_combination *c,
7637 * cfg80211_stop_iface - trigger interface disconnection
7640 * @wdev: wireless device
7641 * @gfp: context flags
7643 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7646 * Note: This doesn't need any locks and is asynchronous.
7648 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7652 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7653 * @wiphy: the wiphy to shut down
7655 * This function shuts down all interfaces belonging to this wiphy by
7656 * calling dev_close() (and treating non-netdev interfaces as needed).
7657 * It shouldn't really be used unless there are some fatal device errors
7658 * that really can't be recovered in any other way.
7660 * Callers must hold the RTNL and be able to deal with callbacks into
7661 * the driver while the function is running.
7663 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7666 * wiphy_ext_feature_set - set the extended feature flag
7668 * @wiphy: the wiphy to modify.
7669 * @ftidx: extended feature bit index.
7671 * The extended features are flagged in multiple bytes (see
7672 * &struct wiphy.@ext_features)
7674 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7675 enum nl80211_ext_feature_index ftidx)
7679 ft_byte = &wiphy->ext_features[ftidx / 8];
7680 *ft_byte |= BIT(ftidx % 8);
7684 * wiphy_ext_feature_isset - check the extended feature flag
7686 * @wiphy: the wiphy to modify.
7687 * @ftidx: extended feature bit index.
7689 * The extended features are flagged in multiple bytes (see
7690 * &struct wiphy.@ext_features)
7693 wiphy_ext_feature_isset(struct wiphy *wiphy,
7694 enum nl80211_ext_feature_index ftidx)
7698 ft_byte = wiphy->ext_features[ftidx / 8];
7699 return (ft_byte & BIT(ftidx % 8)) != 0;
7703 * cfg80211_free_nan_func - free NAN function
7704 * @f: NAN function that should be freed
7706 * Frees all the NAN function and all it's allocated members.
7708 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7711 * struct cfg80211_nan_match_params - NAN match parameters
7712 * @type: the type of the function that triggered a match. If it is
7713 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7714 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7716 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7717 * @inst_id: the local instance id
7718 * @peer_inst_id: the instance id of the peer's function
7719 * @addr: the MAC address of the peer
7720 * @info_len: the length of the &info
7721 * @info: the Service Specific Info from the peer (if any)
7722 * @cookie: unique identifier of the corresponding function
7724 struct cfg80211_nan_match_params {
7725 enum nl80211_nan_function_type type;
7735 * cfg80211_nan_match - report a match for a NAN function.
7736 * @wdev: the wireless device reporting the match
7737 * @match: match notification parameters
7738 * @gfp: allocation flags
7740 * This function reports that the a NAN function had a match. This
7741 * can be a subscribe that had a match or a solicited publish that
7742 * was sent. It can also be a follow up that was received.
7744 void cfg80211_nan_match(struct wireless_dev *wdev,
7745 struct cfg80211_nan_match_params *match, gfp_t gfp);
7748 * cfg80211_nan_func_terminated - notify about NAN function termination.
7750 * @wdev: the wireless device reporting the match
7751 * @inst_id: the local instance id
7752 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7753 * @cookie: unique NAN function identifier
7754 * @gfp: allocation flags
7756 * This function reports that the a NAN function is terminated.
7758 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7760 enum nl80211_nan_func_term_reason reason,
7761 u64 cookie, gfp_t gfp);
7763 /* ethtool helper */
7764 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7767 * cfg80211_external_auth_request - userspace request for authentication
7768 * @netdev: network device
7769 * @params: External authentication parameters
7770 * @gfp: allocation flags
7771 * Returns: 0 on success, < 0 on error
7773 int cfg80211_external_auth_request(struct net_device *netdev,
7774 struct cfg80211_external_auth_params *params,
7778 * cfg80211_pmsr_report - report peer measurement result data
7779 * @wdev: the wireless device reporting the measurement
7780 * @req: the original measurement request
7781 * @result: the result data
7782 * @gfp: allocation flags
7784 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7785 struct cfg80211_pmsr_request *req,
7786 struct cfg80211_pmsr_result *result,
7790 * cfg80211_pmsr_complete - report peer measurement completed
7791 * @wdev: the wireless device reporting the measurement
7792 * @req: the original measurement request
7793 * @gfp: allocation flags
7795 * Report that the entire measurement completed, after this
7796 * the request pointer will no longer be valid.
7798 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7799 struct cfg80211_pmsr_request *req,
7803 * cfg80211_iftype_allowed - check whether the interface can be allowed
7805 * @iftype: interface type
7806 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7807 * @check_swif: check iftype against software interfaces
7809 * Check whether the interface is allowed to operate; additionally, this API
7810 * can be used to check iftype against the software interfaces when
7811 * check_swif is '1'.
7813 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
7814 bool is_4addr, u8 check_swif);
7817 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7819 /* wiphy_printk helpers, similar to dev_printk */
7821 #define wiphy_printk(level, wiphy, format, args...) \
7822 dev_printk(level, &(wiphy)->dev, format, ##args)
7823 #define wiphy_emerg(wiphy, format, args...) \
7824 dev_emerg(&(wiphy)->dev, format, ##args)
7825 #define wiphy_alert(wiphy, format, args...) \
7826 dev_alert(&(wiphy)->dev, format, ##args)
7827 #define wiphy_crit(wiphy, format, args...) \
7828 dev_crit(&(wiphy)->dev, format, ##args)
7829 #define wiphy_err(wiphy, format, args...) \
7830 dev_err(&(wiphy)->dev, format, ##args)
7831 #define wiphy_warn(wiphy, format, args...) \
7832 dev_warn(&(wiphy)->dev, format, ##args)
7833 #define wiphy_notice(wiphy, format, args...) \
7834 dev_notice(&(wiphy)->dev, format, ##args)
7835 #define wiphy_info(wiphy, format, args...) \
7836 dev_info(&(wiphy)->dev, format, ##args)
7838 #define wiphy_err_ratelimited(wiphy, format, args...) \
7839 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7840 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7841 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7843 #define wiphy_debug(wiphy, format, args...) \
7844 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7846 #define wiphy_dbg(wiphy, format, args...) \
7847 dev_dbg(&(wiphy)->dev, format, ##args)
7849 #if defined(VERBOSE_DEBUG)
7850 #define wiphy_vdbg wiphy_dbg
7852 #define wiphy_vdbg(wiphy, format, args...) \
7855 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
7861 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7862 * of using a WARN/WARN_ON to get the message out, including the
7863 * file/line information and a backtrace.
7865 #define wiphy_WARN(wiphy, format, args...) \
7866 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7869 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
7870 * @netdev: network device
7871 * @owe_info: peer's owe info
7872 * @gfp: allocation flags
7874 void cfg80211_update_owe_info_event(struct net_device *netdev,
7875 struct cfg80211_update_owe_info *owe_info,
7878 #endif /* __NET_CFG80211_H */