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-2019 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 * @hw_value: hardware-specific value for the channel
132 * @flags: channel flags from &enum ieee80211_channel_flags.
133 * @orig_flags: channel flags at registration time, used by regulatory
134 * code to support devices with additional restrictions
135 * @band: band this channel belongs to.
136 * @max_antenna_gain: maximum antenna gain in dBi
137 * @max_power: maximum transmission power (in dBm)
138 * @max_reg_power: maximum regulatory transmission power (in dBm)
139 * @beacon_found: helper to regulatory code to indicate when a beacon
140 * has been found on this channel. Use regulatory_hint_found_beacon()
141 * to enable this, this is useful only on 5 GHz band.
142 * @orig_mag: internal use
143 * @orig_mpwr: internal use
144 * @dfs_state: current state of this channel. Only relevant if radar is required
146 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
147 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
149 struct ieee80211_channel {
150 enum nl80211_band band;
154 int max_antenna_gain;
159 int orig_mag, orig_mpwr;
160 enum nl80211_dfs_state dfs_state;
161 unsigned long dfs_state_entered;
162 unsigned int dfs_cac_ms;
166 * enum ieee80211_rate_flags - rate flags
168 * Hardware/specification flags for rates. These are structured
169 * in a way that allows using the same bitrate structure for
170 * different bands/PHY modes.
172 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
173 * preamble on this bitrate; only relevant in 2.4GHz band and
175 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
176 * when used with 802.11a (on the 5 GHz band); filled by the
177 * core code when registering the wiphy.
178 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
179 * when used with 802.11b (on the 2.4 GHz band); filled by the
180 * core code when registering the wiphy.
181 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
182 * when used with 802.11g (on the 2.4 GHz band); filled by the
183 * core code when registering the wiphy.
184 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
185 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
186 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
188 enum ieee80211_rate_flags {
189 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
190 IEEE80211_RATE_MANDATORY_A = 1<<1,
191 IEEE80211_RATE_MANDATORY_B = 1<<2,
192 IEEE80211_RATE_MANDATORY_G = 1<<3,
193 IEEE80211_RATE_ERP_G = 1<<4,
194 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
195 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
199 * enum ieee80211_bss_type - BSS type filter
201 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
202 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
203 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
204 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
205 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
207 enum ieee80211_bss_type {
208 IEEE80211_BSS_TYPE_ESS,
209 IEEE80211_BSS_TYPE_PBSS,
210 IEEE80211_BSS_TYPE_IBSS,
211 IEEE80211_BSS_TYPE_MBSS,
212 IEEE80211_BSS_TYPE_ANY
216 * enum ieee80211_privacy - BSS privacy filter
218 * @IEEE80211_PRIVACY_ON: privacy bit set
219 * @IEEE80211_PRIVACY_OFF: privacy bit clear
220 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
222 enum ieee80211_privacy {
223 IEEE80211_PRIVACY_ON,
224 IEEE80211_PRIVACY_OFF,
225 IEEE80211_PRIVACY_ANY
228 #define IEEE80211_PRIVACY(x) \
229 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
232 * struct ieee80211_rate - bitrate definition
234 * This structure describes a bitrate that an 802.11 PHY can
235 * operate with. The two values @hw_value and @hw_value_short
236 * are only for driver use when pointers to this structure are
239 * @flags: rate-specific flags
240 * @bitrate: bitrate in units of 100 Kbps
241 * @hw_value: driver/hardware value for this rate
242 * @hw_value_short: driver/hardware value for this rate when
243 * short preamble is used
245 struct ieee80211_rate {
248 u16 hw_value, hw_value_short;
252 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
254 * @enable: is the feature enabled.
255 * @min_offset: minimal tx power offset an associated station shall use
256 * @max_offset: maximum tx power offset an associated station shall use
258 struct ieee80211_he_obss_pd {
265 * struct cfg80211_he_bss_color - AP settings for BSS coloring
267 * @color: the current color.
268 * @disabled: is the feature disabled.
269 * @partial: define the AID equation.
271 struct cfg80211_he_bss_color {
278 * struct ieee80211_he_bss_color - AP settings for BSS coloring
280 * @color: the current color.
281 * @disabled: is the feature disabled.
282 * @partial: define the AID equation.
284 struct ieee80211_he_bss_color {
291 * struct ieee80211_sta_ht_cap - STA's HT capabilities
293 * This structure describes most essential parameters needed
294 * to describe 802.11n HT capabilities for an STA.
296 * @ht_supported: is HT supported by the STA
297 * @cap: HT capabilities map as described in 802.11n spec
298 * @ampdu_factor: Maximum A-MPDU length factor
299 * @ampdu_density: Minimum A-MPDU spacing
300 * @mcs: Supported MCS rates
302 struct ieee80211_sta_ht_cap {
303 u16 cap; /* use IEEE80211_HT_CAP_ */
307 struct ieee80211_mcs_info mcs;
311 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
313 * This structure describes most essential parameters needed
314 * to describe 802.11ac VHT capabilities for an STA.
316 * @vht_supported: is VHT supported by the STA
317 * @cap: VHT capabilities map as described in 802.11ac spec
318 * @vht_mcs: Supported VHT MCS rates
320 struct ieee80211_sta_vht_cap {
322 u32 cap; /* use IEEE80211_VHT_CAP_ */
323 struct ieee80211_vht_mcs_info vht_mcs;
326 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
329 * struct ieee80211_sta_he_cap - STA's HE capabilities
331 * This structure describes most essential parameters needed
332 * to describe 802.11ax HE capabilities for a STA.
334 * @has_he: true iff HE data is valid.
335 * @he_cap_elem: Fixed portion of the HE capabilities element.
336 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
337 * @ppe_thres: Holds the PPE Thresholds data.
339 struct ieee80211_sta_he_cap {
341 struct ieee80211_he_cap_elem he_cap_elem;
342 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
343 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
347 * struct ieee80211_sband_iftype_data
349 * This structure encapsulates sband data that is relevant for the
350 * interface types defined in @types_mask. Each type in the
351 * @types_mask must be unique across all instances of iftype_data.
353 * @types_mask: interface types mask
354 * @he_cap: holds the HE capabilities
356 struct ieee80211_sband_iftype_data {
358 struct ieee80211_sta_he_cap he_cap;
362 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
364 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
365 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
366 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
367 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
368 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
369 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
370 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
371 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
373 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
375 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
377 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
378 * and 4.32GHz + 4.32GHz
379 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
380 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
382 enum ieee80211_edmg_bw_config {
383 IEEE80211_EDMG_BW_CONFIG_4 = 4,
384 IEEE80211_EDMG_BW_CONFIG_5 = 5,
385 IEEE80211_EDMG_BW_CONFIG_6 = 6,
386 IEEE80211_EDMG_BW_CONFIG_7 = 7,
387 IEEE80211_EDMG_BW_CONFIG_8 = 8,
388 IEEE80211_EDMG_BW_CONFIG_9 = 9,
389 IEEE80211_EDMG_BW_CONFIG_10 = 10,
390 IEEE80211_EDMG_BW_CONFIG_11 = 11,
391 IEEE80211_EDMG_BW_CONFIG_12 = 12,
392 IEEE80211_EDMG_BW_CONFIG_13 = 13,
393 IEEE80211_EDMG_BW_CONFIG_14 = 14,
394 IEEE80211_EDMG_BW_CONFIG_15 = 15,
398 * struct ieee80211_edmg - EDMG configuration
400 * This structure describes most essential parameters needed
401 * to describe 802.11ay EDMG configuration
403 * @channels: bitmap that indicates the 2.16 GHz channel(s)
404 * that are allowed to be used for transmissions.
405 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
406 * Set to 0 indicate EDMG not supported.
407 * @bw_config: Channel BW Configuration subfield encodes
408 * the allowed channel bandwidth configurations
410 struct ieee80211_edmg {
412 enum ieee80211_edmg_bw_config bw_config;
416 * struct ieee80211_supported_band - frequency band definition
418 * This structure describes a frequency band a wiphy
419 * is able to operate in.
421 * @channels: Array of channels the hardware can operate in
423 * @band: the band this structure represents
424 * @n_channels: Number of channels in @channels
425 * @bitrates: Array of bitrates the hardware can operate with
426 * in this band. Must be sorted to give a valid "supported
427 * rates" IE, i.e. CCK rates first, then OFDM.
428 * @n_bitrates: Number of bitrates in @bitrates
429 * @ht_cap: HT capabilities in this band
430 * @vht_cap: VHT capabilities in this band
431 * @edmg_cap: EDMG capabilities in this band
432 * @n_iftype_data: number of iftype data entries
433 * @iftype_data: interface type data entries. Note that the bits in
434 * @types_mask inside this structure cannot overlap (i.e. only
435 * one occurrence of each type is allowed across all instances of
438 struct ieee80211_supported_band {
439 struct ieee80211_channel *channels;
440 struct ieee80211_rate *bitrates;
441 enum nl80211_band band;
444 struct ieee80211_sta_ht_cap ht_cap;
445 struct ieee80211_sta_vht_cap vht_cap;
446 struct ieee80211_edmg edmg_cap;
448 const struct ieee80211_sband_iftype_data *iftype_data;
452 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
453 * @sband: the sband to search for the STA on
454 * @iftype: enum nl80211_iftype
456 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
458 static inline const struct ieee80211_sband_iftype_data *
459 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
464 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
467 for (i = 0; i < sband->n_iftype_data; i++) {
468 const struct ieee80211_sband_iftype_data *data =
469 &sband->iftype_data[i];
471 if (data->types_mask & BIT(iftype))
479 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
480 * @sband: the sband to search for the iftype on
481 * @iftype: enum nl80211_iftype
483 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
485 static inline const struct ieee80211_sta_he_cap *
486 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
489 const struct ieee80211_sband_iftype_data *data =
490 ieee80211_get_sband_iftype_data(sband, iftype);
492 if (data && data->he_cap.has_he)
493 return &data->he_cap;
499 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
500 * @sband: the sband to search for the STA on
502 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
504 static inline const struct ieee80211_sta_he_cap *
505 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
507 return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
511 * wiphy_read_of_freq_limits - read frequency limits from device tree
513 * @wiphy: the wireless device to get extra limits for
515 * Some devices may have extra limitations specified in DT. This may be useful
516 * for chipsets that normally support more bands but are limited due to board
517 * design (e.g. by antennas or external power amplifier).
519 * This function reads info from DT and uses it to *modify* channels (disable
520 * unavailable ones). It's usually a *bad* idea to use it in drivers with
521 * shared channel data as DT limitations are device specific. You should make
522 * sure to call it only if channels in wiphy are copied and can be modified
523 * without affecting other devices.
525 * As this function access device node it has to be called after set_wiphy_dev.
526 * It also modifies channels so they have to be set first.
527 * If using this helper, call it before wiphy_register().
530 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
531 #else /* CONFIG_OF */
532 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
535 #endif /* !CONFIG_OF */
539 * Wireless hardware/device configuration structures and methods
543 * DOC: Actions and configuration
545 * Each wireless device and each virtual interface offer a set of configuration
546 * operations and other actions that are invoked by userspace. Each of these
547 * actions is described in the operations structure, and the parameters these
548 * operations use are described separately.
550 * Additionally, some operations are asynchronous and expect to get status
551 * information via some functions that drivers need to call.
553 * Scanning and BSS list handling with its associated functionality is described
554 * in a separate chapter.
557 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
558 WLAN_USER_POSITION_LEN)
561 * struct vif_params - describes virtual interface parameters
562 * @flags: monitor interface flags, unchanged if 0, otherwise
563 * %MONITOR_FLAG_CHANGED will be set
564 * @use_4addr: use 4-address frames
565 * @macaddr: address to use for this virtual interface.
566 * If this parameter is set to zero address the driver may
567 * determine the address as needed.
568 * This feature is only fully supported by drivers that enable the
569 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
570 ** only p2p devices with specified MAC.
571 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
572 * belonging to that MU-MIMO groupID; %NULL if not changed
573 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
574 * MU-MIMO packets going to the specified station; %NULL if not changed
579 u8 macaddr[ETH_ALEN];
580 const u8 *vht_mumimo_groups;
581 const u8 *vht_mumimo_follow_addr;
585 * struct key_params - key information
587 * Information about a key
590 * @key_len: length of key material
591 * @cipher: cipher suite selector
592 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
593 * with the get_key() callback, must be in little endian,
594 * length given by @seq_len.
595 * @seq_len: length of @seq.
596 * @vlan_id: vlan_id for VLAN group key (if nonzero)
597 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
606 enum nl80211_key_mode mode;
610 * struct cfg80211_chan_def - channel definition
611 * @chan: the (control) channel
612 * @width: channel width
613 * @center_freq1: center frequency of first segment
614 * @center_freq2: center frequency of second segment
615 * (only with 80+80 MHz)
616 * @edmg: define the EDMG channels configuration.
617 * If edmg is requested (i.e. the .channels member is non-zero),
618 * chan will define the primary channel and all other
619 * parameters are ignored.
621 struct cfg80211_chan_def {
622 struct ieee80211_channel *chan;
623 enum nl80211_chan_width width;
626 struct ieee80211_edmg edmg;
630 * cfg80211_get_chandef_type - return old channel type from chandef
631 * @chandef: the channel definition
633 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
634 * chandef, which must have a bandwidth allowing this conversion.
636 static inline enum nl80211_channel_type
637 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
639 switch (chandef->width) {
640 case NL80211_CHAN_WIDTH_20_NOHT:
641 return NL80211_CHAN_NO_HT;
642 case NL80211_CHAN_WIDTH_20:
643 return NL80211_CHAN_HT20;
644 case NL80211_CHAN_WIDTH_40:
645 if (chandef->center_freq1 > chandef->chan->center_freq)
646 return NL80211_CHAN_HT40PLUS;
647 return NL80211_CHAN_HT40MINUS;
650 return NL80211_CHAN_NO_HT;
655 * cfg80211_chandef_create - create channel definition using channel type
656 * @chandef: the channel definition struct to fill
657 * @channel: the control channel
658 * @chantype: the channel type
660 * Given a channel type, create a channel definition.
662 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
663 struct ieee80211_channel *channel,
664 enum nl80211_channel_type chantype);
667 * cfg80211_chandef_identical - check if two channel definitions are identical
668 * @chandef1: first channel definition
669 * @chandef2: second channel definition
671 * Return: %true if the channels defined by the channel definitions are
672 * identical, %false otherwise.
675 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
676 const struct cfg80211_chan_def *chandef2)
678 return (chandef1->chan == chandef2->chan &&
679 chandef1->width == chandef2->width &&
680 chandef1->center_freq1 == chandef2->center_freq1 &&
681 chandef1->center_freq2 == chandef2->center_freq2);
685 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
687 * @chandef: the channel definition
689 * Return: %true if EDMG defined, %false otherwise.
692 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
694 return chandef->edmg.channels || chandef->edmg.bw_config;
698 * cfg80211_chandef_compatible - check if two channel definitions are compatible
699 * @chandef1: first channel definition
700 * @chandef2: second channel definition
702 * Return: %NULL if the given channel definitions are incompatible,
703 * chandef1 or chandef2 otherwise.
705 const struct cfg80211_chan_def *
706 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
707 const struct cfg80211_chan_def *chandef2);
710 * cfg80211_chandef_valid - check if a channel definition is valid
711 * @chandef: the channel definition to check
712 * Return: %true if the channel definition is valid. %false otherwise.
714 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
717 * cfg80211_chandef_usable - check if secondary channels can be used
718 * @wiphy: the wiphy to validate against
719 * @chandef: the channel definition to check
720 * @prohibited_flags: the regulatory channel flags that must not be set
721 * Return: %true if secondary channels are usable. %false otherwise.
723 bool cfg80211_chandef_usable(struct wiphy *wiphy,
724 const struct cfg80211_chan_def *chandef,
725 u32 prohibited_flags);
728 * cfg80211_chandef_dfs_required - checks if radar detection is required
729 * @wiphy: the wiphy to validate against
730 * @chandef: the channel definition to check
731 * @iftype: the interface type as specified in &enum nl80211_iftype
733 * 1 if radar detection is required, 0 if it is not, < 0 on error
735 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
736 const struct cfg80211_chan_def *chandef,
737 enum nl80211_iftype iftype);
740 * ieee80211_chandef_rate_flags - returns rate flags for a channel
742 * In some channel types, not all rates may be used - for example CCK
743 * rates may not be used in 5/10 MHz channels.
745 * @chandef: channel definition for the channel
747 * Returns: rate flags which apply for this channel
749 static inline enum ieee80211_rate_flags
750 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
752 switch (chandef->width) {
753 case NL80211_CHAN_WIDTH_5:
754 return IEEE80211_RATE_SUPPORTS_5MHZ;
755 case NL80211_CHAN_WIDTH_10:
756 return IEEE80211_RATE_SUPPORTS_10MHZ;
764 * ieee80211_chandef_max_power - maximum transmission power for the chandef
766 * In some regulations, the transmit power may depend on the configured channel
767 * bandwidth which may be defined as dBm/MHz. This function returns the actual
768 * max_power for non-standard (20 MHz) channels.
770 * @chandef: channel definition for the channel
772 * Returns: maximum allowed transmission power in dBm for the chandef
775 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
777 switch (chandef->width) {
778 case NL80211_CHAN_WIDTH_5:
779 return min(chandef->chan->max_reg_power - 6,
780 chandef->chan->max_power);
781 case NL80211_CHAN_WIDTH_10:
782 return min(chandef->chan->max_reg_power - 3,
783 chandef->chan->max_power);
787 return chandef->chan->max_power;
791 * enum survey_info_flags - survey information flags
793 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
794 * @SURVEY_INFO_IN_USE: channel is currently being used
795 * @SURVEY_INFO_TIME: active time (in ms) was filled in
796 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
797 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
798 * @SURVEY_INFO_TIME_RX: receive time was filled in
799 * @SURVEY_INFO_TIME_TX: transmit time was filled in
800 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
801 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
803 * Used by the driver to indicate which info in &struct survey_info
804 * it has filled in during the get_survey().
806 enum survey_info_flags {
807 SURVEY_INFO_NOISE_DBM = BIT(0),
808 SURVEY_INFO_IN_USE = BIT(1),
809 SURVEY_INFO_TIME = BIT(2),
810 SURVEY_INFO_TIME_BUSY = BIT(3),
811 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
812 SURVEY_INFO_TIME_RX = BIT(5),
813 SURVEY_INFO_TIME_TX = BIT(6),
814 SURVEY_INFO_TIME_SCAN = BIT(7),
815 SURVEY_INFO_TIME_BSS_RX = BIT(8),
819 * struct survey_info - channel survey response
821 * @channel: the channel this survey record reports, may be %NULL for a single
822 * record to report global statistics
823 * @filled: bitflag of flags from &enum survey_info_flags
824 * @noise: channel noise in dBm. This and all following fields are
826 * @time: amount of time in ms the radio was turn on (on the channel)
827 * @time_busy: amount of time the primary channel was sensed busy
828 * @time_ext_busy: amount of time the extension channel was sensed busy
829 * @time_rx: amount of time the radio spent receiving data
830 * @time_tx: amount of time the radio spent transmitting data
831 * @time_scan: amount of time the radio spent for scanning
832 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
834 * Used by dump_survey() to report back per-channel survey information.
836 * This structure can later be expanded with things like
837 * channel duty cycle etc.
840 struct ieee80211_channel *channel;
852 #define CFG80211_MAX_WEP_KEYS 4
855 * struct cfg80211_crypto_settings - Crypto settings
856 * @wpa_versions: indicates which, if any, WPA versions are enabled
857 * (from enum nl80211_wpa_versions)
858 * @cipher_group: group key cipher suite (or 0 if unset)
859 * @n_ciphers_pairwise: number of AP supported unicast ciphers
860 * @ciphers_pairwise: unicast key cipher suites
861 * @n_akm_suites: number of AKM suites
862 * @akm_suites: AKM suites
863 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
864 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
865 * required to assume that the port is unauthorized until authorized by
866 * user space. Otherwise, port is marked authorized by default.
867 * @control_port_ethertype: the control port protocol that should be
868 * allowed through even on unauthorized ports
869 * @control_port_no_encrypt: TRUE to prevent encryption of control port
871 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
872 * port frames over NL80211 instead of the network interface.
873 * @wep_keys: static WEP keys, if not NULL points to an array of
874 * CFG80211_MAX_WEP_KEYS WEP keys
875 * @wep_tx_key: key index (0..3) of the default TX static WEP key
876 * @psk: PSK (for devices supporting 4-way-handshake offload)
877 * @sae_pwd: password for SAE authentication (for devices supporting SAE
879 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
881 struct cfg80211_crypto_settings {
884 int n_ciphers_pairwise;
885 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
887 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
889 __be16 control_port_ethertype;
890 bool control_port_no_encrypt;
891 bool control_port_over_nl80211;
892 struct key_params *wep_keys;
900 * struct cfg80211_beacon_data - beacon data
901 * @head: head portion of beacon (before TIM IE)
902 * or %NULL if not changed
903 * @tail: tail portion of beacon (after TIM IE)
904 * or %NULL if not changed
905 * @head_len: length of @head
906 * @tail_len: length of @tail
907 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
908 * @beacon_ies_len: length of beacon_ies in octets
909 * @proberesp_ies: extra information element(s) to add into Probe Response
911 * @proberesp_ies_len: length of proberesp_ies in octets
912 * @assocresp_ies: extra information element(s) to add into (Re)Association
913 * Response frames or %NULL
914 * @assocresp_ies_len: length of assocresp_ies in octets
915 * @probe_resp_len: length of probe response template (@probe_resp)
916 * @probe_resp: probe response template (AP mode only)
917 * @ftm_responder: enable FTM responder functionality; -1 for no change
918 * (which also implies no change in LCI/civic location data)
919 * @lci: Measurement Report element content, starting with Measurement Token
920 * (measurement type 8)
921 * @civicloc: Measurement Report element content, starting with Measurement
922 * Token (measurement type 11)
923 * @lci_len: LCI data length
924 * @civicloc_len: Civic location data length
926 struct cfg80211_beacon_data {
927 const u8 *head, *tail;
928 const u8 *beacon_ies;
929 const u8 *proberesp_ies;
930 const u8 *assocresp_ies;
931 const u8 *probe_resp;
936 size_t head_len, tail_len;
937 size_t beacon_ies_len;
938 size_t proberesp_ies_len;
939 size_t assocresp_ies_len;
940 size_t probe_resp_len;
950 * struct cfg80211_acl_data - Access control list data
952 * @acl_policy: ACL policy to be applied on the station's
953 * entry specified by mac_addr
954 * @n_acl_entries: Number of MAC address entries passed
955 * @mac_addrs: List of MAC addresses of stations to be used for ACL
957 struct cfg80211_acl_data {
958 enum nl80211_acl_policy acl_policy;
962 struct mac_address mac_addrs[];
966 * cfg80211_bitrate_mask - masks for bitrate control
968 struct cfg80211_bitrate_mask {
971 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
972 u16 vht_mcs[NL80211_VHT_NSS_MAX];
973 enum nl80211_txrate_gi gi;
974 } control[NUM_NL80211_BANDS];
978 * enum cfg80211_ap_settings_flags - AP settings flags
980 * Used by cfg80211_ap_settings
982 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
984 enum cfg80211_ap_settings_flags {
985 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
989 * struct cfg80211_ap_settings - AP configuration
991 * Used to configure an AP interface.
993 * @chandef: defines the channel to use
994 * @beacon: beacon data
995 * @beacon_interval: beacon interval
996 * @dtim_period: DTIM period
997 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
999 * @ssid_len: length of @ssid
1000 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1001 * @crypto: crypto settings
1002 * @privacy: the BSS uses privacy
1003 * @auth_type: Authentication type (algorithm)
1004 * @smps_mode: SMPS mode
1005 * @inactivity_timeout: time in seconds to determine station's inactivity.
1006 * @p2p_ctwindow: P2P CT Window
1007 * @p2p_opp_ps: P2P opportunistic PS
1008 * @acl: ACL configuration used by the drivers which has support for
1009 * MAC address based access control
1010 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1012 * @beacon_rate: bitrate to be used for beacons
1013 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1014 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1015 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1016 * @ht_required: stations must support HT
1017 * @vht_required: stations must support VHT
1018 * @twt_responder: Enable Target Wait Time
1019 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1020 * @he_obss_pd: OBSS Packet Detection settings
1021 * @he_bss_color: BSS Color settings
1023 struct cfg80211_ap_settings {
1024 struct cfg80211_chan_def chandef;
1026 struct cfg80211_beacon_data beacon;
1028 int beacon_interval, dtim_period;
1031 enum nl80211_hidden_ssid hidden_ssid;
1032 struct cfg80211_crypto_settings crypto;
1034 enum nl80211_auth_type auth_type;
1035 enum nl80211_smps_mode smps_mode;
1036 int inactivity_timeout;
1039 const struct cfg80211_acl_data *acl;
1041 struct cfg80211_bitrate_mask beacon_rate;
1043 const struct ieee80211_ht_cap *ht_cap;
1044 const struct ieee80211_vht_cap *vht_cap;
1045 const struct ieee80211_he_cap_elem *he_cap;
1046 bool ht_required, vht_required;
1049 struct ieee80211_he_obss_pd he_obss_pd;
1050 struct cfg80211_he_bss_color he_bss_color;
1054 * struct cfg80211_csa_settings - channel switch settings
1056 * Used for channel switch
1058 * @chandef: defines the channel to use after the switch
1059 * @beacon_csa: beacon data while performing the switch
1060 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1061 * @counter_offsets_presp: offsets of the counters within the probe response
1062 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1063 * @n_counter_offsets_presp: number of csa counters in the probe response
1064 * @beacon_after: beacon data to be used on the new channel
1065 * @radar_required: whether radar detection is required on the new channel
1066 * @block_tx: whether transmissions should be blocked while changing
1067 * @count: number of beacons until switch
1069 struct cfg80211_csa_settings {
1070 struct cfg80211_chan_def chandef;
1071 struct cfg80211_beacon_data beacon_csa;
1072 const u16 *counter_offsets_beacon;
1073 const u16 *counter_offsets_presp;
1074 unsigned int n_counter_offsets_beacon;
1075 unsigned int n_counter_offsets_presp;
1076 struct cfg80211_beacon_data beacon_after;
1077 bool radar_required;
1082 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1085 * struct iface_combination_params - input parameters for interface combinations
1087 * Used to pass interface combination parameters
1089 * @num_different_channels: the number of different channels we want
1090 * to use for verification
1091 * @radar_detect: a bitmap where each bit corresponds to a channel
1092 * width where radar detection is needed, as in the definition of
1093 * &struct ieee80211_iface_combination.@radar_detect_widths
1094 * @iftype_num: array with the number of interfaces of each interface
1095 * type. The index is the interface type as specified in &enum
1097 * @new_beacon_int: set this to the beacon interval of a new interface
1098 * that's not operating yet, if such is to be checked as part of
1101 struct iface_combination_params {
1102 int num_different_channels;
1104 int iftype_num[NUM_NL80211_IFTYPES];
1109 * enum station_parameters_apply_mask - station parameter values to apply
1110 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1111 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1112 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1114 * Not all station parameters have in-band "no change" signalling,
1115 * for those that don't these flags will are used.
1117 enum station_parameters_apply_mask {
1118 STATION_PARAM_APPLY_UAPSD = BIT(0),
1119 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1120 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1121 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1125 * struct sta_txpwr - station txpower configuration
1127 * Used to configure txpower for station.
1129 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1130 * is not provided, the default per-interface tx power setting will be
1131 * overriding. Driver should be picking up the lowest tx power, either tx
1132 * power per-interface or per-station.
1133 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1134 * will be less than or equal to specified from userspace, whereas if TPC
1135 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1136 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1141 enum nl80211_tx_power_setting type;
1145 * struct station_parameters - station parameters
1147 * Used to change and create a new station.
1149 * @vlan: vlan interface station should belong to
1150 * @supported_rates: supported rates in IEEE 802.11 format
1151 * (or NULL for no change)
1152 * @supported_rates_len: number of supported rates
1153 * @sta_flags_mask: station flags that changed
1154 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1155 * @sta_flags_set: station flags values
1156 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1157 * @listen_interval: listen interval or -1 for no change
1158 * @aid: AID or zero for no change
1159 * @vlan_id: VLAN ID for station (if nonzero)
1160 * @peer_aid: mesh peer AID or zero for no change
1161 * @plink_action: plink action to take
1162 * @plink_state: set the peer link state for a station
1163 * @ht_capa: HT capabilities of station
1164 * @vht_capa: VHT capabilities of station
1165 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1166 * as the AC bitmap in the QoS info field
1167 * @max_sp: max Service Period. same format as the MAX_SP in the
1168 * QoS info field (but already shifted down)
1169 * @sta_modify_mask: bitmap indicating which parameters changed
1170 * (for those that don't have a natural "no change" value),
1171 * see &enum station_parameters_apply_mask
1172 * @local_pm: local link-specific mesh power save mode (no change when set
1174 * @capability: station capability
1175 * @ext_capab: extended capabilities of the station
1176 * @ext_capab_len: number of extended capabilities
1177 * @supported_channels: supported channels in IEEE 802.11 format
1178 * @supported_channels_len: number of supported channels
1179 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1180 * @supported_oper_classes_len: number of supported operating classes
1181 * @opmode_notif: operating mode field from Operating Mode Notification
1182 * @opmode_notif_used: information if operating mode field is used
1183 * @support_p2p_ps: information if station supports P2P PS mechanism
1184 * @he_capa: HE capabilities of station
1185 * @he_capa_len: the length of the HE capabilities
1186 * @airtime_weight: airtime scheduler weight for this station
1188 struct station_parameters {
1189 const u8 *supported_rates;
1190 struct net_device *vlan;
1191 u32 sta_flags_mask, sta_flags_set;
1192 u32 sta_modify_mask;
1193 int listen_interval;
1197 u8 supported_rates_len;
1200 const struct ieee80211_ht_cap *ht_capa;
1201 const struct ieee80211_vht_cap *vht_capa;
1204 enum nl80211_mesh_power_mode local_pm;
1206 const u8 *ext_capab;
1208 const u8 *supported_channels;
1209 u8 supported_channels_len;
1210 const u8 *supported_oper_classes;
1211 u8 supported_oper_classes_len;
1213 bool opmode_notif_used;
1215 const struct ieee80211_he_cap_elem *he_capa;
1218 struct sta_txpwr txpwr;
1222 * struct station_del_parameters - station deletion parameters
1224 * Used to delete a station entry (or all stations).
1226 * @mac: MAC address of the station to remove or NULL to remove all stations
1227 * @subtype: Management frame subtype to use for indicating removal
1228 * (10 = Disassociation, 12 = Deauthentication)
1229 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1231 struct station_del_parameters {
1238 * enum cfg80211_station_type - the type of station being modified
1239 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1240 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1241 * unassociated (update properties for this type of client is permitted)
1242 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1243 * the AP MLME in the device
1244 * @CFG80211_STA_AP_STA: AP station on managed interface
1245 * @CFG80211_STA_IBSS: IBSS station
1246 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1247 * while TDLS setup is in progress, it moves out of this state when
1248 * being marked authorized; use this only if TDLS with external setup is
1250 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1251 * entry that is operating, has been marked authorized by userspace)
1252 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1253 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1255 enum cfg80211_station_type {
1256 CFG80211_STA_AP_CLIENT,
1257 CFG80211_STA_AP_CLIENT_UNASSOC,
1258 CFG80211_STA_AP_MLME_CLIENT,
1259 CFG80211_STA_AP_STA,
1261 CFG80211_STA_TDLS_PEER_SETUP,
1262 CFG80211_STA_TDLS_PEER_ACTIVE,
1263 CFG80211_STA_MESH_PEER_KERNEL,
1264 CFG80211_STA_MESH_PEER_USER,
1268 * cfg80211_check_station_change - validate parameter changes
1269 * @wiphy: the wiphy this operates on
1270 * @params: the new parameters for a station
1271 * @statype: the type of station being modified
1273 * Utility function for the @change_station driver method. Call this function
1274 * with the appropriate station type looking up the station (and checking that
1275 * it exists). It will verify whether the station change is acceptable, and if
1276 * not will return an error code. Note that it may modify the parameters for
1277 * backward compatibility reasons, so don't use them before calling this.
1279 int cfg80211_check_station_change(struct wiphy *wiphy,
1280 struct station_parameters *params,
1281 enum cfg80211_station_type statype);
1284 * enum station_info_rate_flags - bitrate info flags
1286 * Used by the driver to indicate the specific rate transmission
1287 * type for 802.11n transmissions.
1289 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1290 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1291 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1292 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1293 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1294 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1296 enum rate_info_flags {
1297 RATE_INFO_FLAGS_MCS = BIT(0),
1298 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1299 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1300 RATE_INFO_FLAGS_DMG = BIT(3),
1301 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1302 RATE_INFO_FLAGS_EDMG = BIT(5),
1306 * enum rate_info_bw - rate bandwidth information
1308 * Used by the driver to indicate the rate bandwidth.
1310 * @RATE_INFO_BW_5: 5 MHz bandwidth
1311 * @RATE_INFO_BW_10: 10 MHz bandwidth
1312 * @RATE_INFO_BW_20: 20 MHz bandwidth
1313 * @RATE_INFO_BW_40: 40 MHz bandwidth
1314 * @RATE_INFO_BW_80: 80 MHz bandwidth
1315 * @RATE_INFO_BW_160: 160 MHz bandwidth
1316 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1319 RATE_INFO_BW_20 = 0,
1329 * struct rate_info - bitrate information
1331 * Information about a receiving or transmitting bitrate
1333 * @flags: bitflag of flags from &enum rate_info_flags
1334 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1335 * @legacy: bitrate in 100kbit/s for 802.11abg
1336 * @nss: number of streams (VHT & HE only)
1337 * @bw: bandwidth (from &enum rate_info_bw)
1338 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1339 * @he_dcm: HE DCM value
1340 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1341 * only valid if bw is %RATE_INFO_BW_HE_RU)
1342 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1357 * enum station_info_rate_flags - bitrate info flags
1359 * Used by the driver to indicate the specific rate transmission
1360 * type for 802.11n transmissions.
1362 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1363 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1364 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1366 enum bss_param_flags {
1367 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1368 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1369 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1373 * struct sta_bss_parameters - BSS parameters for the attached station
1375 * Information about the currently associated BSS
1377 * @flags: bitflag of flags from &enum bss_param_flags
1378 * @dtim_period: DTIM period for the BSS
1379 * @beacon_interval: beacon interval
1381 struct sta_bss_parameters {
1384 u16 beacon_interval;
1388 * struct cfg80211_txq_stats - TXQ statistics for this TID
1389 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1390 * indicate the relevant values in this struct are filled
1391 * @backlog_bytes: total number of bytes currently backlogged
1392 * @backlog_packets: total number of packets currently backlogged
1393 * @flows: number of new flows seen
1394 * @drops: total number of packets dropped
1395 * @ecn_marks: total number of packets marked with ECN CE
1396 * @overlimit: number of drops due to queue space overflow
1397 * @overmemory: number of drops due to memory limit overflow
1398 * @collisions: number of hash collisions
1399 * @tx_bytes: total number of bytes dequeued
1400 * @tx_packets: total number of packets dequeued
1401 * @max_flows: maximum number of flows supported
1403 struct cfg80211_txq_stats {
1406 u32 backlog_packets;
1419 * struct cfg80211_tid_stats - per-TID statistics
1420 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1421 * indicate the relevant values in this struct are filled
1422 * @rx_msdu: number of received MSDUs
1423 * @tx_msdu: number of (attempted) transmitted MSDUs
1424 * @tx_msdu_retries: number of retries (not counting the first) for
1426 * @tx_msdu_failed: number of failed transmitted MSDUs
1427 * @txq_stats: TXQ statistics
1429 struct cfg80211_tid_stats {
1433 u64 tx_msdu_retries;
1435 struct cfg80211_txq_stats txq_stats;
1438 #define IEEE80211_MAX_CHAINS 4
1441 * struct station_info - station information
1443 * Station information filled by driver for get_station() and dump_station.
1445 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1446 * indicate the relevant values in this struct for them
1447 * @connected_time: time(in secs) since a station is last connected
1448 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1449 * @assoc_at: bootime (ns) of the last association
1450 * @rx_bytes: bytes (size of MPDUs) received from this station
1451 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1452 * @llid: mesh local link id
1453 * @plid: mesh peer link id
1454 * @plink_state: mesh peer link state
1455 * @signal: The signal strength, type depends on the wiphy's signal_type.
1456 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1457 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1458 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1459 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1460 * @chain_signal: per-chain signal strength of last received packet in dBm
1461 * @chain_signal_avg: per-chain signal strength average in dBm
1462 * @txrate: current unicast bitrate from this station
1463 * @rxrate: current unicast bitrate to this station
1464 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1465 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1466 * @tx_retries: cumulative retry counts (MPDUs)
1467 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1468 * @rx_dropped_misc: Dropped for un-specified reason.
1469 * @bss_param: current BSS parameters
1470 * @generation: generation number for nl80211 dumps.
1471 * This number should increase every time the list of stations
1472 * changes, i.e. when a station is added or removed, so that
1473 * userspace can tell whether it got a consistent snapshot.
1474 * @assoc_req_ies: IEs from (Re)Association Request.
1475 * This is used only when in AP mode with drivers that do not use
1476 * user space MLME/SME implementation. The information is provided for
1477 * the cfg80211_new_sta() calls to notify user space of the IEs.
1478 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1479 * @sta_flags: station flags mask & values
1480 * @beacon_loss_count: Number of times beacon loss event has triggered.
1481 * @t_offset: Time offset of the station relative to this host.
1482 * @local_pm: local mesh STA power save mode
1483 * @peer_pm: peer mesh STA power save mode
1484 * @nonpeer_pm: non-peer mesh STA power save mode
1485 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1486 * towards this station.
1487 * @rx_beacon: number of beacons received from this peer
1488 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1490 * @connected_to_gate: true if mesh STA has a path to mesh gate
1491 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1492 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1493 * @airtime_weight: current airtime scheduling weight
1494 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1495 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1496 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1497 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1498 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1500 * @rx_mpdu_count: number of MPDUs received from this station
1501 * @fcs_err_count: number of packets (MPDUs) received from this station with
1502 * an FCS error. This counter should be incremented only when TA of the
1503 * received packet with an FCS error matches the peer MAC address.
1504 * @airtime_link_metric: mesh airtime link metric.
1506 struct station_info {
1520 s8 chain_signal[IEEE80211_MAX_CHAINS];
1521 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1523 struct rate_info txrate;
1524 struct rate_info rxrate;
1529 u32 rx_dropped_misc;
1530 struct sta_bss_parameters bss_param;
1531 struct nl80211_sta_flag_update sta_flags;
1535 const u8 *assoc_req_ies;
1536 size_t assoc_req_ies_len;
1538 u32 beacon_loss_count;
1540 enum nl80211_mesh_power_mode local_pm;
1541 enum nl80211_mesh_power_mode peer_pm;
1542 enum nl80211_mesh_power_mode nonpeer_pm;
1544 u32 expected_throughput;
1549 u8 rx_beacon_signal_avg;
1550 u8 connected_to_gate;
1552 struct cfg80211_tid_stats *pertid;
1561 u32 airtime_link_metric;
1564 #if IS_ENABLED(CONFIG_CFG80211)
1566 * cfg80211_get_station - retrieve information about a given station
1567 * @dev: the device where the station is supposed to be connected to
1568 * @mac_addr: the mac address of the station of interest
1569 * @sinfo: pointer to the structure to fill with the information
1571 * Returns 0 on success and sinfo is filled with the available information
1572 * otherwise returns a negative error code and the content of sinfo has to be
1573 * considered undefined.
1575 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1576 struct station_info *sinfo);
1578 static inline int cfg80211_get_station(struct net_device *dev,
1580 struct station_info *sinfo)
1587 * enum monitor_flags - monitor flags
1589 * Monitor interface configuration flags. Note that these must be the bits
1590 * according to the nl80211 flags.
1592 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1593 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1594 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1595 * @MONITOR_FLAG_CONTROL: pass control frames
1596 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1597 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1598 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1600 enum monitor_flags {
1601 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1602 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1603 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1604 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1605 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1606 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1607 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1611 * enum mpath_info_flags - mesh path information flags
1613 * Used by the driver to indicate which info in &struct mpath_info it has filled
1614 * in during get_station() or dump_station().
1616 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1617 * @MPATH_INFO_SN: @sn filled
1618 * @MPATH_INFO_METRIC: @metric filled
1619 * @MPATH_INFO_EXPTIME: @exptime filled
1620 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1621 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1622 * @MPATH_INFO_FLAGS: @flags filled
1623 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1624 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1626 enum mpath_info_flags {
1627 MPATH_INFO_FRAME_QLEN = BIT(0),
1628 MPATH_INFO_SN = BIT(1),
1629 MPATH_INFO_METRIC = BIT(2),
1630 MPATH_INFO_EXPTIME = BIT(3),
1631 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1632 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1633 MPATH_INFO_FLAGS = BIT(6),
1634 MPATH_INFO_HOP_COUNT = BIT(7),
1635 MPATH_INFO_PATH_CHANGE = BIT(8),
1639 * struct mpath_info - mesh path information
1641 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1643 * @filled: bitfield of flags from &enum mpath_info_flags
1644 * @frame_qlen: number of queued frames for this destination
1645 * @sn: target sequence number
1646 * @metric: metric (cost) of this mesh path
1647 * @exptime: expiration time for the mesh path from now, in msecs
1648 * @flags: mesh path flags
1649 * @discovery_timeout: total mesh path discovery timeout, in msecs
1650 * @discovery_retries: mesh path discovery retries
1651 * @generation: generation number for nl80211 dumps.
1652 * This number should increase every time the list of mesh paths
1653 * changes, i.e. when a station is added or removed, so that
1654 * userspace can tell whether it got a consistent snapshot.
1655 * @hop_count: hops to destination
1656 * @path_change_count: total number of path changes to destination
1664 u32 discovery_timeout;
1665 u8 discovery_retries;
1668 u32 path_change_count;
1674 * struct bss_parameters - BSS parameters
1676 * Used to change BSS parameters (mainly for AP mode).
1678 * @use_cts_prot: Whether to use CTS protection
1679 * (0 = no, 1 = yes, -1 = do not change)
1680 * @use_short_preamble: Whether the use of short preambles is allowed
1681 * (0 = no, 1 = yes, -1 = do not change)
1682 * @use_short_slot_time: Whether the use of short slot time is allowed
1683 * (0 = no, 1 = yes, -1 = do not change)
1684 * @basic_rates: basic rates in IEEE 802.11 format
1685 * (or NULL for no change)
1686 * @basic_rates_len: number of basic rates
1687 * @ap_isolate: do not forward packets between connected stations
1688 * @ht_opmode: HT Operation mode
1689 * (u16 = opmode, -1 = do not change)
1690 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1691 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1693 struct bss_parameters {
1695 int use_short_preamble;
1696 int use_short_slot_time;
1697 const u8 *basic_rates;
1701 s8 p2p_ctwindow, p2p_opp_ps;
1705 * struct mesh_config - 802.11s mesh configuration
1707 * These parameters can be changed while the mesh is active.
1709 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1710 * by the Mesh Peering Open message
1711 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1712 * used by the Mesh Peering Open message
1713 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1714 * the mesh peering management to close a mesh peering
1715 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1717 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1718 * be sent to establish a new peer link instance in a mesh
1719 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1720 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1722 * @auto_open_plinks: whether we should automatically open peer links when we
1723 * detect compatible mesh peers
1724 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1725 * synchronize to for 11s default synchronization method
1726 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1727 * that an originator mesh STA can send to a particular path target
1728 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1729 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1730 * a path discovery in milliseconds
1731 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1732 * receiving a PREQ shall consider the forwarding information from the
1733 * root to be valid. (TU = time unit)
1734 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1735 * which a mesh STA can send only one action frame containing a PREQ
1737 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1738 * which a mesh STA can send only one Action frame containing a PERR
1740 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1741 * it takes for an HWMP information element to propagate across the mesh
1742 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1743 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1744 * announcements are transmitted
1745 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1746 * station has access to a broader network beyond the MBSS. (This is
1747 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1748 * only means that the station will announce others it's a mesh gate, but
1749 * not necessarily using the gate announcement protocol. Still keeping the
1750 * same nomenclature to be in sync with the spec)
1751 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1752 * entity (default is TRUE - forwarding entity)
1753 * @rssi_threshold: the threshold for average signal strength of candidate
1754 * station to establish a peer link
1755 * @ht_opmode: mesh HT protection mode
1757 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1758 * receiving a proactive PREQ shall consider the forwarding information to
1759 * the root mesh STA to be valid.
1761 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1762 * PREQs are transmitted.
1763 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1764 * during which a mesh STA can send only one Action frame containing
1765 * a PREQ element for root path confirmation.
1766 * @power_mode: The default mesh power save mode which will be the initial
1767 * setting for new peer links.
1768 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1769 * after transmitting its beacon.
1770 * @plink_timeout: If no tx activity is seen from a STA we've established
1771 * peering with for longer than this time (in seconds), then remove it
1772 * from the STA's list of peers. Default is 30 minutes.
1773 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1774 * connected to a mesh gate in mesh formation info. If false, the
1775 * value in mesh formation is determined by the presence of root paths
1776 * in the mesh path table
1778 struct mesh_config {
1779 u16 dot11MeshRetryTimeout;
1780 u16 dot11MeshConfirmTimeout;
1781 u16 dot11MeshHoldingTimeout;
1782 u16 dot11MeshMaxPeerLinks;
1783 u8 dot11MeshMaxRetries;
1786 bool auto_open_plinks;
1787 u32 dot11MeshNbrOffsetMaxNeighbor;
1788 u8 dot11MeshHWMPmaxPREQretries;
1789 u32 path_refresh_time;
1790 u16 min_discovery_timeout;
1791 u32 dot11MeshHWMPactivePathTimeout;
1792 u16 dot11MeshHWMPpreqMinInterval;
1793 u16 dot11MeshHWMPperrMinInterval;
1794 u16 dot11MeshHWMPnetDiameterTraversalTime;
1795 u8 dot11MeshHWMPRootMode;
1796 bool dot11MeshConnectedToMeshGate;
1797 u16 dot11MeshHWMPRannInterval;
1798 bool dot11MeshGateAnnouncementProtocol;
1799 bool dot11MeshForwarding;
1802 u32 dot11MeshHWMPactivePathToRootTimeout;
1803 u16 dot11MeshHWMProotInterval;
1804 u16 dot11MeshHWMPconfirmationInterval;
1805 enum nl80211_mesh_power_mode power_mode;
1806 u16 dot11MeshAwakeWindowDuration;
1811 * struct mesh_setup - 802.11s mesh setup configuration
1812 * @chandef: defines the channel to use
1813 * @mesh_id: the mesh ID
1814 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1815 * @sync_method: which synchronization method to use
1816 * @path_sel_proto: which path selection protocol to use
1817 * @path_metric: which metric to use
1818 * @auth_id: which authentication method this mesh is using
1819 * @ie: vendor information elements (optional)
1820 * @ie_len: length of vendor information elements
1821 * @is_authenticated: this mesh requires authentication
1822 * @is_secure: this mesh uses security
1823 * @user_mpm: userspace handles all MPM functions
1824 * @dtim_period: DTIM period to use
1825 * @beacon_interval: beacon interval to use
1826 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1827 * @basic_rates: basic rates to use when creating the mesh
1828 * @beacon_rate: bitrate to be used for beacons
1829 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1830 * changes the channel when a radar is detected. This is required
1831 * to operate on DFS channels.
1832 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1833 * port frames over NL80211 instead of the network interface.
1835 * These parameters are fixed when the mesh is created.
1838 struct cfg80211_chan_def chandef;
1847 bool is_authenticated;
1851 u16 beacon_interval;
1852 int mcast_rate[NUM_NL80211_BANDS];
1854 struct cfg80211_bitrate_mask beacon_rate;
1855 bool userspace_handles_dfs;
1856 bool control_port_over_nl80211;
1860 * struct ocb_setup - 802.11p OCB mode setup configuration
1861 * @chandef: defines the channel to use
1863 * These parameters are fixed when connecting to the network
1866 struct cfg80211_chan_def chandef;
1870 * struct ieee80211_txq_params - TX queue parameters
1871 * @ac: AC identifier
1872 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1873 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1875 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1877 * @aifs: Arbitration interframe space [0..255]
1879 struct ieee80211_txq_params {
1888 * DOC: Scanning and BSS list handling
1890 * The scanning process itself is fairly simple, but cfg80211 offers quite
1891 * a bit of helper functionality. To start a scan, the scan operation will
1892 * be invoked with a scan definition. This scan definition contains the
1893 * channels to scan, and the SSIDs to send probe requests for (including the
1894 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1895 * probe. Additionally, a scan request may contain extra information elements
1896 * that should be added to the probe request. The IEs are guaranteed to be
1897 * well-formed, and will not exceed the maximum length the driver advertised
1898 * in the wiphy structure.
1900 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1901 * it is responsible for maintaining the BSS list; the driver should not
1902 * maintain a list itself. For this notification, various functions exist.
1904 * Since drivers do not maintain a BSS list, there are also a number of
1905 * functions to search for a BSS and obtain information about it from the
1906 * BSS structure cfg80211 maintains. The BSS list is also made available
1911 * struct cfg80211_ssid - SSID description
1913 * @ssid_len: length of the ssid
1915 struct cfg80211_ssid {
1916 u8 ssid[IEEE80211_MAX_SSID_LEN];
1921 * struct cfg80211_scan_info - information about completed scan
1922 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1923 * wireless device that requested the scan is connected to. If this
1924 * information is not available, this field is left zero.
1925 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1926 * @aborted: set to true if the scan was aborted for any reason,
1927 * userspace will be notified of that
1929 struct cfg80211_scan_info {
1931 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1936 * struct cfg80211_scan_request - scan request description
1938 * @ssids: SSIDs to scan for (active scan only)
1939 * @n_ssids: number of SSIDs
1940 * @channels: channels to scan on.
1941 * @n_channels: total number of channels to scan
1942 * @scan_width: channel width for scanning
1943 * @ie: optional information element(s) to add into Probe Request or %NULL
1944 * @ie_len: length of ie in octets
1945 * @duration: how long to listen on each channel, in TUs. If
1946 * %duration_mandatory is not set, this is the maximum dwell time and
1947 * the actual dwell time may be shorter.
1948 * @duration_mandatory: if set, the scan duration must be as specified by the
1950 * @flags: bit field of flags controlling operation
1951 * @rates: bitmap of rates to advertise for each band
1952 * @wiphy: the wiphy this was for
1953 * @scan_start: time (in jiffies) when the scan started
1954 * @wdev: the wireless device to scan for
1955 * @info: (internal) information about completed scan
1956 * @notified: (internal) scan request was notified as done or aborted
1957 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1958 * @mac_addr: MAC address used with randomisation
1959 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1960 * are 0 in the mask should be randomised, bits that are 1 should
1961 * be taken from the @mac_addr
1962 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1964 struct cfg80211_scan_request {
1965 struct cfg80211_ssid *ssids;
1968 enum nl80211_bss_scan_width scan_width;
1972 bool duration_mandatory;
1975 u32 rates[NUM_NL80211_BANDS];
1977 struct wireless_dev *wdev;
1979 u8 mac_addr[ETH_ALEN] __aligned(2);
1980 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1981 u8 bssid[ETH_ALEN] __aligned(2);
1984 struct wiphy *wiphy;
1985 unsigned long scan_start;
1986 struct cfg80211_scan_info info;
1991 struct ieee80211_channel *channels[0];
1994 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1998 get_random_bytes(buf, ETH_ALEN);
1999 for (i = 0; i < ETH_ALEN; i++) {
2001 buf[i] |= addr[i] & mask[i];
2006 * struct cfg80211_match_set - sets of attributes to match
2008 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2009 * or no match (RSSI only)
2010 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2011 * or no match (RSSI only)
2012 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2013 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2014 * for filtering out scan results received. Drivers advertize this support
2015 * of band specific rssi based filtering through the feature capability
2016 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2017 * specific rssi thresholds take precedence over rssi_thold, if specified.
2018 * If not specified for any band, it will be assigned with rssi_thold of
2019 * corresponding matchset.
2021 struct cfg80211_match_set {
2022 struct cfg80211_ssid ssid;
2025 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2029 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2031 * @interval: interval between scheduled scan iterations. In seconds.
2032 * @iterations: number of scan iterations in this scan plan. Zero means
2034 * The last scan plan will always have this parameter set to zero,
2035 * all other scan plans will have a finite number of iterations.
2037 struct cfg80211_sched_scan_plan {
2043 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2045 * @band: band of BSS which should match for RSSI level adjustment.
2046 * @delta: value of RSSI level adjustment.
2048 struct cfg80211_bss_select_adjust {
2049 enum nl80211_band band;
2054 * struct cfg80211_sched_scan_request - scheduled scan request description
2056 * @reqid: identifies this request.
2057 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2058 * @n_ssids: number of SSIDs
2059 * @n_channels: total number of channels to scan
2060 * @scan_width: channel width for scanning
2061 * @ie: optional information element(s) to add into Probe Request or %NULL
2062 * @ie_len: length of ie in octets
2063 * @flags: bit field of flags controlling operation
2064 * @match_sets: sets of parameters to be matched for a scan result
2065 * entry to be considered valid and to be passed to the host
2066 * (others are filtered out).
2067 * If ommited, all results are passed.
2068 * @n_match_sets: number of match sets
2069 * @report_results: indicates that results were reported for this request
2070 * @wiphy: the wiphy this was for
2071 * @dev: the interface
2072 * @scan_start: start time of the scheduled scan
2073 * @channels: channels to scan
2074 * @min_rssi_thold: for drivers only supporting a single threshold, this
2075 * contains the minimum over all matchsets
2076 * @mac_addr: MAC address used with randomisation
2077 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2078 * are 0 in the mask should be randomised, bits that are 1 should
2079 * be taken from the @mac_addr
2080 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2081 * index must be executed first.
2082 * @n_scan_plans: number of scan plans, at least 1.
2083 * @rcu_head: RCU callback used to free the struct
2084 * @owner_nlportid: netlink portid of owner (if this should is a request
2085 * owned by a particular socket)
2086 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2087 * @list: for keeping list of requests.
2088 * @delay: delay in seconds to use before starting the first scan
2089 * cycle. The driver may ignore this parameter and start
2090 * immediately (or at any other time), if this feature is not
2092 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2093 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2094 * reporting in connected state to cases where a matching BSS is determined
2095 * to have better or slightly worse RSSI than the current connected BSS.
2096 * The relative RSSI threshold values are ignored in disconnected state.
2097 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2098 * to the specified band while deciding whether a better BSS is reported
2099 * using @relative_rssi. If delta is a negative number, the BSSs that
2100 * belong to the specified band will be penalized by delta dB in relative
2103 struct cfg80211_sched_scan_request {
2105 struct cfg80211_ssid *ssids;
2108 enum nl80211_bss_scan_width scan_width;
2112 struct cfg80211_match_set *match_sets;
2116 struct cfg80211_sched_scan_plan *scan_plans;
2119 u8 mac_addr[ETH_ALEN] __aligned(2);
2120 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2122 bool relative_rssi_set;
2124 struct cfg80211_bss_select_adjust rssi_adjust;
2127 struct wiphy *wiphy;
2128 struct net_device *dev;
2129 unsigned long scan_start;
2130 bool report_results;
2131 struct rcu_head rcu_head;
2134 struct list_head list;
2137 struct ieee80211_channel *channels[0];
2141 * enum cfg80211_signal_type - signal type
2143 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2144 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2145 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2147 enum cfg80211_signal_type {
2148 CFG80211_SIGNAL_TYPE_NONE,
2149 CFG80211_SIGNAL_TYPE_MBM,
2150 CFG80211_SIGNAL_TYPE_UNSPEC,
2154 * struct cfg80211_inform_bss - BSS inform data
2155 * @chan: channel the frame was received on
2156 * @scan_width: scan width that was used
2157 * @signal: signal strength value, according to the wiphy's
2159 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2160 * received; should match the time when the frame was actually
2161 * received by the device (not just by the host, in case it was
2162 * buffered on the device) and be accurate to about 10ms.
2163 * If the frame isn't buffered, just passing the return value of
2164 * ktime_get_boottime_ns() is likely appropriate.
2165 * @parent_tsf: the time at the start of reception of the first octet of the
2166 * timestamp field of the frame. The time is the TSF of the BSS specified
2168 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2169 * the BSS that requested the scan in which the beacon/probe was received.
2170 * @chains: bitmask for filled values in @chain_signal.
2171 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2173 struct cfg80211_inform_bss {
2174 struct ieee80211_channel *chan;
2175 enum nl80211_bss_scan_width scan_width;
2179 u8 parent_bssid[ETH_ALEN] __aligned(2);
2181 s8 chain_signal[IEEE80211_MAX_CHAINS];
2185 * struct cfg80211_bss_ies - BSS entry IE data
2186 * @tsf: TSF contained in the frame that carried these IEs
2187 * @rcu_head: internal use, for freeing
2188 * @len: length of the IEs
2189 * @from_beacon: these IEs are known to come from a beacon
2192 struct cfg80211_bss_ies {
2194 struct rcu_head rcu_head;
2201 * struct cfg80211_bss - BSS description
2203 * This structure describes a BSS (which may also be a mesh network)
2204 * for use in scan results and similar.
2206 * @channel: channel this BSS is on
2207 * @scan_width: width of the control channel
2208 * @bssid: BSSID of the BSS
2209 * @beacon_interval: the beacon interval as from the frame
2210 * @capability: the capability field in host byte order
2211 * @ies: the information elements (Note that there is no guarantee that these
2212 * are well-formed!); this is a pointer to either the beacon_ies or
2213 * proberesp_ies depending on whether Probe Response frame has been
2214 * received. It is always non-%NULL.
2215 * @beacon_ies: the information elements from the last Beacon frame
2216 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2217 * own the beacon_ies, but they're just pointers to the ones from the
2218 * @hidden_beacon_bss struct)
2219 * @proberesp_ies: the information elements from the last Probe Response frame
2220 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2221 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2222 * that holds the beacon data. @beacon_ies is still valid, of course, and
2223 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2224 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2225 * non-transmitted one (multi-BSSID support)
2226 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2227 * (multi-BSSID support)
2228 * @signal: signal strength value (type depends on the wiphy's signal_type)
2229 * @chains: bitmask for filled values in @chain_signal.
2230 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2231 * @bssid_index: index in the multiple BSS set
2232 * @max_bssid_indicator: max number of members in the BSS set
2233 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2235 struct cfg80211_bss {
2236 struct ieee80211_channel *channel;
2237 enum nl80211_bss_scan_width scan_width;
2239 const struct cfg80211_bss_ies __rcu *ies;
2240 const struct cfg80211_bss_ies __rcu *beacon_ies;
2241 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2243 struct cfg80211_bss *hidden_beacon_bss;
2244 struct cfg80211_bss *transmitted_bss;
2245 struct list_head nontrans_list;
2249 u16 beacon_interval;
2254 s8 chain_signal[IEEE80211_MAX_CHAINS];
2257 u8 max_bssid_indicator;
2259 u8 priv[0] __aligned(sizeof(void *));
2263 * ieee80211_bss_get_elem - find element with given ID
2264 * @bss: the bss to search
2265 * @id: the element ID
2267 * Note that the return value is an RCU-protected pointer, so
2268 * rcu_read_lock() must be held when calling this function.
2269 * Return: %NULL if not found.
2271 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2274 * ieee80211_bss_get_ie - find IE with given ID
2275 * @bss: the bss to search
2276 * @id: the element ID
2278 * Note that the return value is an RCU-protected pointer, so
2279 * rcu_read_lock() must be held when calling this function.
2280 * Return: %NULL if not found.
2282 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2284 return (void *)ieee80211_bss_get_elem(bss, id);
2289 * struct cfg80211_auth_request - Authentication request data
2291 * This structure provides information needed to complete IEEE 802.11
2294 * @bss: The BSS to authenticate with, the callee must obtain a reference
2295 * to it if it needs to keep it.
2296 * @auth_type: Authentication type (algorithm)
2297 * @ie: Extra IEs to add to Authentication frame or %NULL
2298 * @ie_len: Length of ie buffer in octets
2299 * @key_len: length of WEP key for shared key authentication
2300 * @key_idx: index of WEP key for shared key authentication
2301 * @key: WEP key for shared key authentication
2302 * @auth_data: Fields and elements in Authentication frames. This contains
2303 * the authentication frame body (non-IE and IE data), excluding the
2304 * Authentication algorithm number, i.e., starting at the Authentication
2305 * transaction sequence number field.
2306 * @auth_data_len: Length of auth_data buffer in octets
2308 struct cfg80211_auth_request {
2309 struct cfg80211_bss *bss;
2312 enum nl80211_auth_type auth_type;
2314 u8 key_len, key_idx;
2315 const u8 *auth_data;
2316 size_t auth_data_len;
2320 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2322 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2323 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2324 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2325 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2326 * authentication capability. Drivers can offload authentication to
2327 * userspace if this flag is set. Only applicable for cfg80211_connect()
2328 * request (connect callback).
2330 enum cfg80211_assoc_req_flags {
2331 ASSOC_REQ_DISABLE_HT = BIT(0),
2332 ASSOC_REQ_DISABLE_VHT = BIT(1),
2333 ASSOC_REQ_USE_RRM = BIT(2),
2334 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2338 * struct cfg80211_assoc_request - (Re)Association request data
2340 * This structure provides information needed to complete IEEE 802.11
2342 * @bss: The BSS to associate with. If the call is successful the driver is
2343 * given a reference that it must give back to cfg80211_send_rx_assoc()
2344 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2345 * association requests while already associating must be rejected.
2346 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2347 * @ie_len: Length of ie buffer in octets
2348 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2349 * @crypto: crypto settings
2350 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2351 * to indicate a request to reassociate within the ESS instead of a request
2352 * do the initial association with the ESS. When included, this is set to
2353 * the BSSID of the current association, i.e., to the value that is
2354 * included in the Current AP address field of the Reassociation Request
2356 * @flags: See &enum cfg80211_assoc_req_flags
2357 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2358 * will be used in ht_capa. Un-supported values will be ignored.
2359 * @ht_capa_mask: The bits of ht_capa which are to be used.
2360 * @vht_capa: VHT capability override
2361 * @vht_capa_mask: VHT capability mask indicating which fields to use
2362 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2363 * %NULL if FILS is not used.
2364 * @fils_kek_len: Length of fils_kek in octets
2365 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2366 * Request/Response frame or %NULL if FILS is not used. This field starts
2367 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2369 struct cfg80211_assoc_request {
2370 struct cfg80211_bss *bss;
2371 const u8 *ie, *prev_bssid;
2373 struct cfg80211_crypto_settings crypto;
2376 struct ieee80211_ht_cap ht_capa;
2377 struct ieee80211_ht_cap ht_capa_mask;
2378 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2380 size_t fils_kek_len;
2381 const u8 *fils_nonces;
2385 * struct cfg80211_deauth_request - Deauthentication request data
2387 * This structure provides information needed to complete IEEE 802.11
2390 * @bssid: the BSSID of the BSS to deauthenticate from
2391 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2392 * @ie_len: Length of ie buffer in octets
2393 * @reason_code: The reason code for the deauthentication
2394 * @local_state_change: if set, change local state only and
2395 * do not set a deauth frame
2397 struct cfg80211_deauth_request {
2402 bool local_state_change;
2406 * struct cfg80211_disassoc_request - Disassociation request data
2408 * This structure provides information needed to complete IEEE 802.11
2411 * @bss: the BSS to disassociate from
2412 * @ie: Extra IEs to add to Disassociation frame or %NULL
2413 * @ie_len: Length of ie buffer in octets
2414 * @reason_code: The reason code for the disassociation
2415 * @local_state_change: This is a request for a local state only, i.e., no
2416 * Disassociation frame is to be transmitted.
2418 struct cfg80211_disassoc_request {
2419 struct cfg80211_bss *bss;
2423 bool local_state_change;
2427 * struct cfg80211_ibss_params - IBSS parameters
2429 * This structure defines the IBSS parameters for the join_ibss()
2432 * @ssid: The SSID, will always be non-null.
2433 * @ssid_len: The length of the SSID, will always be non-zero.
2434 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2435 * search for IBSSs with a different BSSID.
2436 * @chandef: defines the channel to use if no other IBSS to join can be found
2437 * @channel_fixed: The channel should be fixed -- do not search for
2438 * IBSSs to join on other channels.
2439 * @ie: information element(s) to include in the beacon
2440 * @ie_len: length of that
2441 * @beacon_interval: beacon interval to use
2442 * @privacy: this is a protected network, keys will be configured
2444 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2445 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2446 * required to assume that the port is unauthorized until authorized by
2447 * user space. Otherwise, port is marked authorized by default.
2448 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2449 * port frames over NL80211 instead of the network interface.
2450 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2451 * changes the channel when a radar is detected. This is required
2452 * to operate on DFS channels.
2453 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2454 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2455 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2456 * will be used in ht_capa. Un-supported values will be ignored.
2457 * @ht_capa_mask: The bits of ht_capa which are to be used.
2458 * @wep_keys: static WEP keys, if not NULL points to an array of
2459 * CFG80211_MAX_WEP_KEYS WEP keys
2460 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2462 struct cfg80211_ibss_params {
2465 struct cfg80211_chan_def chandef;
2467 u8 ssid_len, ie_len;
2468 u16 beacon_interval;
2473 bool control_port_over_nl80211;
2474 bool userspace_handles_dfs;
2475 int mcast_rate[NUM_NL80211_BANDS];
2476 struct ieee80211_ht_cap ht_capa;
2477 struct ieee80211_ht_cap ht_capa_mask;
2478 struct key_params *wep_keys;
2483 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2485 * @behaviour: requested BSS selection behaviour.
2486 * @param: parameters for requestion behaviour.
2487 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2488 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2490 struct cfg80211_bss_selection {
2491 enum nl80211_bss_select_attr behaviour;
2493 enum nl80211_band band_pref;
2494 struct cfg80211_bss_select_adjust adjust;
2499 * struct cfg80211_connect_params - Connection parameters
2501 * This structure provides information needed to complete IEEE 802.11
2502 * authentication and association.
2504 * @channel: The channel to use or %NULL if not specified (auto-select based
2506 * @channel_hint: The channel of the recommended BSS for initial connection or
2507 * %NULL if not specified
2508 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2510 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2511 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2512 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2515 * @ssid_len: Length of ssid in octets
2516 * @auth_type: Authentication type (algorithm)
2517 * @ie: IEs for association request
2518 * @ie_len: Length of assoc_ie in octets
2519 * @privacy: indicates whether privacy-enabled APs should be used
2520 * @mfp: indicate whether management frame protection is used
2521 * @crypto: crypto settings
2522 * @key_len: length of WEP key for shared key authentication
2523 * @key_idx: index of WEP key for shared key authentication
2524 * @key: WEP key for shared key authentication
2525 * @flags: See &enum cfg80211_assoc_req_flags
2526 * @bg_scan_period: Background scan period in seconds
2527 * or -1 to indicate that default value is to be used.
2528 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2529 * will be used in ht_capa. Un-supported values will be ignored.
2530 * @ht_capa_mask: The bits of ht_capa which are to be used.
2531 * @vht_capa: VHT Capability overrides
2532 * @vht_capa_mask: The bits of vht_capa which are to be used.
2533 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2535 * @bss_select: criteria to be used for BSS selection.
2536 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2537 * to indicate a request to reassociate within the ESS instead of a request
2538 * do the initial association with the ESS. When included, this is set to
2539 * the BSSID of the current association, i.e., to the value that is
2540 * included in the Current AP address field of the Reassociation Request
2542 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2543 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2545 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2546 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2547 * %NULL if not specified. This specifies the domain name of ER server and
2548 * is used to construct FILS wrapped data IE.
2549 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2550 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2551 * messages. This is also used to construct FILS wrapped data IE.
2552 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2553 * keys in FILS or %NULL if not specified.
2554 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2555 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2556 * offload of 4-way handshake.
2557 * @edmg: define the EDMG channels.
2558 * This may specify multiple channels and bonding options for the driver
2559 * to choose from, based on BSS configuration.
2561 struct cfg80211_connect_params {
2562 struct ieee80211_channel *channel;
2563 struct ieee80211_channel *channel_hint;
2565 const u8 *bssid_hint;
2568 enum nl80211_auth_type auth_type;
2572 enum nl80211_mfp mfp;
2573 struct cfg80211_crypto_settings crypto;
2575 u8 key_len, key_idx;
2578 struct ieee80211_ht_cap ht_capa;
2579 struct ieee80211_ht_cap ht_capa_mask;
2580 struct ieee80211_vht_cap vht_capa;
2581 struct ieee80211_vht_cap vht_capa_mask;
2583 struct cfg80211_bss_selection bss_select;
2584 const u8 *prev_bssid;
2585 const u8 *fils_erp_username;
2586 size_t fils_erp_username_len;
2587 const u8 *fils_erp_realm;
2588 size_t fils_erp_realm_len;
2589 u16 fils_erp_next_seq_num;
2590 const u8 *fils_erp_rrk;
2591 size_t fils_erp_rrk_len;
2593 struct ieee80211_edmg edmg;
2597 * enum cfg80211_connect_params_changed - Connection parameters being updated
2599 * This enum provides information of all connect parameters that
2600 * have to be updated as part of update_connect_params() call.
2602 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2603 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2604 * username, erp sequence number and rrk) are updated
2605 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2607 enum cfg80211_connect_params_changed {
2608 UPDATE_ASSOC_IES = BIT(0),
2609 UPDATE_FILS_ERP_INFO = BIT(1),
2610 UPDATE_AUTH_TYPE = BIT(2),
2614 * enum wiphy_params_flags - set_wiphy_params bitfield values
2615 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2616 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2617 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2618 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2619 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2620 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2621 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2622 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2623 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2625 enum wiphy_params_flags {
2626 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2627 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2628 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2629 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2630 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2631 WIPHY_PARAM_DYN_ACK = 1 << 5,
2632 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2633 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2634 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2637 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2639 /* The per TXQ device queue limit in airtime */
2640 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2641 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2643 /* The per interface airtime threshold to switch to lower queue limit */
2644 #define IEEE80211_AQL_THRESHOLD 24000
2647 * struct cfg80211_pmksa - PMK Security Association
2649 * This structure is passed to the set/del_pmksa() method for PMKSA
2652 * @bssid: The AP's BSSID (may be %NULL).
2653 * @pmkid: The identifier to refer a PMKSA.
2654 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2655 * derivation by a FILS STA. Otherwise, %NULL.
2656 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2657 * the hash algorithm used to generate this.
2658 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2659 * cache identifier (may be %NULL).
2660 * @ssid_len: Length of the @ssid in octets.
2661 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2662 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2665 struct cfg80211_pmksa {
2676 * struct cfg80211_pkt_pattern - packet pattern
2677 * @mask: bitmask where to match pattern and where to ignore bytes,
2678 * one bit per byte, in same format as nl80211
2679 * @pattern: bytes to match where bitmask is 1
2680 * @pattern_len: length of pattern (in bytes)
2681 * @pkt_offset: packet offset (in bytes)
2683 * Internal note: @mask and @pattern are allocated in one chunk of
2684 * memory, free @mask only!
2686 struct cfg80211_pkt_pattern {
2687 const u8 *mask, *pattern;
2693 * struct cfg80211_wowlan_tcp - TCP connection parameters
2695 * @sock: (internal) socket for source port allocation
2696 * @src: source IP address
2697 * @dst: destination IP address
2698 * @dst_mac: destination MAC address
2699 * @src_port: source port
2700 * @dst_port: destination port
2701 * @payload_len: data payload length
2702 * @payload: data payload buffer
2703 * @payload_seq: payload sequence stamping configuration
2704 * @data_interval: interval at which to send data packets
2705 * @wake_len: wakeup payload match length
2706 * @wake_data: wakeup payload match data
2707 * @wake_mask: wakeup payload match mask
2708 * @tokens_size: length of the tokens buffer
2709 * @payload_tok: payload token usage configuration
2711 struct cfg80211_wowlan_tcp {
2712 struct socket *sock;
2714 u16 src_port, dst_port;
2715 u8 dst_mac[ETH_ALEN];
2718 struct nl80211_wowlan_tcp_data_seq payload_seq;
2721 const u8 *wake_data, *wake_mask;
2723 /* must be last, variable member */
2724 struct nl80211_wowlan_tcp_data_token payload_tok;
2728 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2730 * This structure defines the enabled WoWLAN triggers for the device.
2731 * @any: wake up on any activity -- special trigger if device continues
2732 * operating as normal during suspend
2733 * @disconnect: wake up if getting disconnected
2734 * @magic_pkt: wake up on receiving magic packet
2735 * @patterns: wake up on receiving packet matching a pattern
2736 * @n_patterns: number of patterns
2737 * @gtk_rekey_failure: wake up on GTK rekey failure
2738 * @eap_identity_req: wake up on EAP identity request packet
2739 * @four_way_handshake: wake up on 4-way handshake
2740 * @rfkill_release: wake up when rfkill is released
2741 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2742 * NULL if not configured.
2743 * @nd_config: configuration for the scan to be used for net detect wake.
2745 struct cfg80211_wowlan {
2746 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2747 eap_identity_req, four_way_handshake,
2749 struct cfg80211_pkt_pattern *patterns;
2750 struct cfg80211_wowlan_tcp *tcp;
2752 struct cfg80211_sched_scan_request *nd_config;
2756 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2758 * This structure defines coalesce rule for the device.
2759 * @delay: maximum coalescing delay in msecs.
2760 * @condition: condition for packet coalescence.
2761 * see &enum nl80211_coalesce_condition.
2762 * @patterns: array of packet patterns
2763 * @n_patterns: number of patterns
2765 struct cfg80211_coalesce_rules {
2767 enum nl80211_coalesce_condition condition;
2768 struct cfg80211_pkt_pattern *patterns;
2773 * struct cfg80211_coalesce - Packet coalescing settings
2775 * This structure defines coalescing settings.
2776 * @rules: array of coalesce rules
2777 * @n_rules: number of rules
2779 struct cfg80211_coalesce {
2780 struct cfg80211_coalesce_rules *rules;
2785 * struct cfg80211_wowlan_nd_match - information about the match
2787 * @ssid: SSID of the match that triggered the wake up
2788 * @n_channels: Number of channels where the match occurred. This
2789 * value may be zero if the driver can't report the channels.
2790 * @channels: center frequencies of the channels where a match
2793 struct cfg80211_wowlan_nd_match {
2794 struct cfg80211_ssid ssid;
2800 * struct cfg80211_wowlan_nd_info - net detect wake up information
2802 * @n_matches: Number of match information instances provided in
2803 * @matches. This value may be zero if the driver can't provide
2804 * match information.
2805 * @matches: Array of pointers to matches containing information about
2806 * the matches that triggered the wake up.
2808 struct cfg80211_wowlan_nd_info {
2810 struct cfg80211_wowlan_nd_match *matches[];
2814 * struct cfg80211_wowlan_wakeup - wakeup report
2815 * @disconnect: woke up by getting disconnected
2816 * @magic_pkt: woke up by receiving magic packet
2817 * @gtk_rekey_failure: woke up by GTK rekey failure
2818 * @eap_identity_req: woke up by EAP identity request packet
2819 * @four_way_handshake: woke up by 4-way handshake
2820 * @rfkill_release: woke up by rfkill being released
2821 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2822 * @packet_present_len: copied wakeup packet data
2823 * @packet_len: original wakeup packet length
2824 * @packet: The packet causing the wakeup, if any.
2825 * @packet_80211: For pattern match, magic packet and other data
2826 * frame triggers an 802.3 frame should be reported, for
2827 * disconnect due to deauth 802.11 frame. This indicates which
2829 * @tcp_match: TCP wakeup packet received
2830 * @tcp_connlost: TCP connection lost or failed to establish
2831 * @tcp_nomoretokens: TCP data ran out of tokens
2832 * @net_detect: if not %NULL, woke up because of net detect
2834 struct cfg80211_wowlan_wakeup {
2835 bool disconnect, magic_pkt, gtk_rekey_failure,
2836 eap_identity_req, four_way_handshake,
2837 rfkill_release, packet_80211,
2838 tcp_match, tcp_connlost, tcp_nomoretokens;
2840 u32 packet_present_len, packet_len;
2842 struct cfg80211_wowlan_nd_info *net_detect;
2846 * struct cfg80211_gtk_rekey_data - rekey data
2847 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2848 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2849 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2851 struct cfg80211_gtk_rekey_data {
2852 const u8 *kek, *kck, *replay_ctr;
2856 * struct cfg80211_update_ft_ies_params - FT IE Information
2858 * This structure provides information needed to update the fast transition IE
2860 * @md: The Mobility Domain ID, 2 Octet value
2861 * @ie: Fast Transition IEs
2862 * @ie_len: Length of ft_ie in octets
2864 struct cfg80211_update_ft_ies_params {
2871 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2873 * This structure provides information needed to transmit a mgmt frame
2875 * @chan: channel to use
2876 * @offchan: indicates wether off channel operation is required
2877 * @wait: duration for ROC
2878 * @buf: buffer to transmit
2879 * @len: buffer length
2880 * @no_cck: don't use cck rates for this frame
2881 * @dont_wait_for_ack: tells the low level not to wait for an ack
2882 * @n_csa_offsets: length of csa_offsets array
2883 * @csa_offsets: array of all the csa offsets in the frame
2885 struct cfg80211_mgmt_tx_params {
2886 struct ieee80211_channel *chan;
2892 bool dont_wait_for_ack;
2894 const u16 *csa_offsets;
2898 * struct cfg80211_dscp_exception - DSCP exception
2900 * @dscp: DSCP value that does not adhere to the user priority range definition
2901 * @up: user priority value to which the corresponding DSCP value belongs
2903 struct cfg80211_dscp_exception {
2909 * struct cfg80211_dscp_range - DSCP range definition for user priority
2911 * @low: lowest DSCP value of this user priority range, inclusive
2912 * @high: highest DSCP value of this user priority range, inclusive
2914 struct cfg80211_dscp_range {
2919 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2920 #define IEEE80211_QOS_MAP_MAX_EX 21
2921 #define IEEE80211_QOS_MAP_LEN_MIN 16
2922 #define IEEE80211_QOS_MAP_LEN_MAX \
2923 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2926 * struct cfg80211_qos_map - QoS Map Information
2928 * This struct defines the Interworking QoS map setting for DSCP values
2930 * @num_des: number of DSCP exceptions (0..21)
2931 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2932 * the user priority DSCP range definition
2933 * @up: DSCP range definition for a particular user priority
2935 struct cfg80211_qos_map {
2937 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2938 struct cfg80211_dscp_range up[8];
2942 * struct cfg80211_nan_conf - NAN configuration
2944 * This struct defines NAN configuration parameters
2946 * @master_pref: master preference (1 - 255)
2947 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2948 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2949 * (i.e. BIT(NL80211_BAND_2GHZ)).
2951 struct cfg80211_nan_conf {
2957 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2960 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2961 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2963 enum cfg80211_nan_conf_changes {
2964 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2965 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2969 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2971 * @filter: the content of the filter
2972 * @len: the length of the filter
2974 struct cfg80211_nan_func_filter {
2980 * struct cfg80211_nan_func - a NAN function
2982 * @type: &enum nl80211_nan_function_type
2983 * @service_id: the service ID of the function
2984 * @publish_type: &nl80211_nan_publish_type
2985 * @close_range: if true, the range should be limited. Threshold is
2986 * implementation specific.
2987 * @publish_bcast: if true, the solicited publish should be broadcasted
2988 * @subscribe_active: if true, the subscribe is active
2989 * @followup_id: the instance ID for follow up
2990 * @followup_reqid: the requestor instance ID for follow up
2991 * @followup_dest: MAC address of the recipient of the follow up
2992 * @ttl: time to live counter in DW.
2993 * @serv_spec_info: Service Specific Info
2994 * @serv_spec_info_len: Service Specific Info length
2995 * @srf_include: if true, SRF is inclusive
2996 * @srf_bf: Bloom Filter
2997 * @srf_bf_len: Bloom Filter length
2998 * @srf_bf_idx: Bloom Filter index
2999 * @srf_macs: SRF MAC addresses
3000 * @srf_num_macs: number of MAC addresses in SRF
3001 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3002 * @tx_filters: filters that should be transmitted in the SDF.
3003 * @num_rx_filters: length of &rx_filters.
3004 * @num_tx_filters: length of &tx_filters.
3005 * @instance_id: driver allocated id of the function.
3006 * @cookie: unique NAN function identifier.
3008 struct cfg80211_nan_func {
3009 enum nl80211_nan_function_type type;
3010 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3014 bool subscribe_active;
3017 struct mac_address followup_dest;
3019 const u8 *serv_spec_info;
3020 u8 serv_spec_info_len;
3025 struct mac_address *srf_macs;
3027 struct cfg80211_nan_func_filter *rx_filters;
3028 struct cfg80211_nan_func_filter *tx_filters;
3036 * struct cfg80211_pmk_conf - PMK configuration
3038 * @aa: authenticator address
3039 * @pmk_len: PMK length in bytes.
3040 * @pmk: the PMK material
3041 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3042 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3045 struct cfg80211_pmk_conf {
3049 const u8 *pmk_r0_name;
3053 * struct cfg80211_external_auth_params - Trigger External authentication.
3055 * Commonly used across the external auth request and event interfaces.
3057 * @action: action type / trigger for external authentication. Only significant
3058 * for the authentication request event interface (driver to user space).
3059 * @bssid: BSSID of the peer with which the authentication has
3060 * to happen. Used by both the authentication request event and
3061 * authentication response command interface.
3062 * @ssid: SSID of the AP. Used by both the authentication request event and
3063 * authentication response command interface.
3064 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3065 * authentication request event interface.
3066 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3067 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3068 * the real status code for failures. Used only for the authentication
3069 * response command interface (user space to driver).
3070 * @pmkid: The identifier to refer a PMKSA.
3072 struct cfg80211_external_auth_params {
3073 enum nl80211_external_auth_action action;
3074 u8 bssid[ETH_ALEN] __aligned(2);
3075 struct cfg80211_ssid ssid;
3076 unsigned int key_mgmt_suite;
3082 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3084 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3085 * indicate the relevant values in this struct for them
3086 * @success_num: number of FTM sessions in which all frames were successfully
3088 * @partial_num: number of FTM sessions in which part of frames were
3089 * successfully answered
3090 * @failed_num: number of failed FTM sessions
3091 * @asap_num: number of ASAP FTM sessions
3092 * @non_asap_num: number of non-ASAP FTM sessions
3093 * @total_duration_ms: total sessions durations - gives an indication
3094 * of how much time the responder was busy
3095 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3096 * initiators that didn't finish successfully the negotiation phase with
3098 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3099 * for a new scheduling although it already has scheduled FTM slot
3100 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3102 struct cfg80211_ftm_responder_stats {
3109 u64 total_duration_ms;
3110 u32 unknown_triggers_num;
3111 u32 reschedule_requests_num;
3112 u32 out_of_window_triggers_num;
3116 * struct cfg80211_pmsr_ftm_result - FTM result
3117 * @failure_reason: if this measurement failed (PMSR status is
3118 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3119 * reason than just "failure"
3120 * @burst_index: if reporting partial results, this is the index
3121 * in [0 .. num_bursts-1] of the burst that's being reported
3122 * @num_ftmr_attempts: number of FTM request frames transmitted
3123 * @num_ftmr_successes: number of FTM request frames acked
3124 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3125 * fill this to indicate in how many seconds a retry is deemed possible
3127 * @num_bursts_exp: actual number of bursts exponent negotiated
3128 * @burst_duration: actual burst duration negotiated
3129 * @ftms_per_burst: actual FTMs per burst negotiated
3130 * @lci_len: length of LCI information (if present)
3131 * @civicloc_len: length of civic location information (if present)
3132 * @lci: LCI data (may be %NULL)
3133 * @civicloc: civic location data (may be %NULL)
3134 * @rssi_avg: average RSSI over FTM action frames reported
3135 * @rssi_spread: spread of the RSSI over FTM action frames reported
3136 * @tx_rate: bitrate for transmitted FTM action frame response
3137 * @rx_rate: bitrate of received FTM action frame
3138 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3139 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3140 * the square root of the variance)
3141 * @rtt_spread: spread of the RTTs measured
3142 * @dist_avg: average of distances (mm) measured
3143 * (must have either this or @rtt_avg)
3144 * @dist_variance: variance of distances measured (see also @rtt_variance)
3145 * @dist_spread: spread of distances measured (see also @rtt_spread)
3146 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3147 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3148 * @rssi_avg_valid: @rssi_avg is valid
3149 * @rssi_spread_valid: @rssi_spread is valid
3150 * @tx_rate_valid: @tx_rate is valid
3151 * @rx_rate_valid: @rx_rate is valid
3152 * @rtt_avg_valid: @rtt_avg is valid
3153 * @rtt_variance_valid: @rtt_variance is valid
3154 * @rtt_spread_valid: @rtt_spread is valid
3155 * @dist_avg_valid: @dist_avg is valid
3156 * @dist_variance_valid: @dist_variance is valid
3157 * @dist_spread_valid: @dist_spread is valid
3159 struct cfg80211_pmsr_ftm_result {
3162 unsigned int lci_len;
3163 unsigned int civicloc_len;
3164 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3165 u32 num_ftmr_attempts, num_ftmr_successes;
3173 struct rate_info tx_rate, rx_rate;
3181 u16 num_ftmr_attempts_valid:1,
3182 num_ftmr_successes_valid:1,
3184 rssi_spread_valid:1,
3188 rtt_variance_valid:1,
3191 dist_variance_valid:1,
3192 dist_spread_valid:1;
3196 * struct cfg80211_pmsr_result - peer measurement result
3197 * @addr: address of the peer
3198 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3199 * measurement was made)
3200 * @ap_tsf: AP's TSF at measurement time
3201 * @status: status of the measurement
3202 * @final: if reporting partial results, mark this as the last one; if not
3203 * reporting partial results always set this flag
3204 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3205 * @type: type of the measurement reported, note that we only support reporting
3206 * one type at a time, but you can report multiple results separately and
3207 * they're all aggregated for userspace.
3209 struct cfg80211_pmsr_result {
3210 u64 host_time, ap_tsf;
3211 enum nl80211_peer_measurement_status status;
3218 enum nl80211_peer_measurement_type type;
3221 struct cfg80211_pmsr_ftm_result ftm;
3226 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3227 * @requested: indicates FTM is requested
3228 * @preamble: frame preamble to use
3229 * @burst_period: burst period to use
3230 * @asap: indicates to use ASAP mode
3231 * @num_bursts_exp: number of bursts exponent
3232 * @burst_duration: burst duration
3233 * @ftms_per_burst: number of FTMs per burst
3234 * @ftmr_retries: number of retries for FTM request
3235 * @request_lci: request LCI information
3236 * @request_civicloc: request civic location information
3238 * See also nl80211 for the respective attribute documentation.
3240 struct cfg80211_pmsr_ftm_request_peer {
3241 enum nl80211_preamble preamble;
3254 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3255 * @addr: MAC address
3256 * @chandef: channel to use
3257 * @report_ap_tsf: report the associated AP's TSF
3258 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3260 struct cfg80211_pmsr_request_peer {
3262 struct cfg80211_chan_def chandef;
3264 struct cfg80211_pmsr_ftm_request_peer ftm;
3268 * struct cfg80211_pmsr_request - peer measurement request
3269 * @cookie: cookie, set by cfg80211
3270 * @nl_portid: netlink portid - used by cfg80211
3271 * @drv_data: driver data for this request, if required for aborting,
3272 * not otherwise freed or anything by cfg80211
3273 * @mac_addr: MAC address used for (randomised) request
3274 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3275 * are 0 in the mask should be randomised, bits that are 1 should
3276 * be taken from the @mac_addr
3277 * @list: used by cfg80211 to hold on to the request
3278 * @timeout: timeout (in milliseconds) for the whole operation, if
3279 * zero it means there's no timeout
3280 * @n_peers: number of peers to do measurements with
3281 * @peers: per-peer measurement request data
3283 struct cfg80211_pmsr_request {
3291 u8 mac_addr[ETH_ALEN] __aligned(2);
3292 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3294 struct list_head list;
3296 struct cfg80211_pmsr_request_peer peers[];
3300 * struct cfg80211_update_owe_info - OWE Information
3302 * This structure provides information needed for the drivers to offload OWE
3303 * (Opportunistic Wireless Encryption) processing to the user space.
3305 * Commonly used across update_owe_info request and event interfaces.
3307 * @peer: MAC address of the peer device for which the OWE processing
3309 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3310 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3311 * cannot give you the real status code for failures. Used only for
3312 * OWE update request command interface (user space to driver).
3313 * @ie: IEs obtained from the peer or constructed by the user space. These are
3314 * the IEs of the remote peer in the event from the host driver and
3315 * the constructed IEs by the user space in the request interface.
3316 * @ie_len: Length of IEs in octets.
3318 struct cfg80211_update_owe_info {
3319 u8 peer[ETH_ALEN] __aligned(2);
3326 * struct cfg80211_ops - backend description for wireless configuration
3328 * This struct is registered by fullmac card drivers and/or wireless stacks
3329 * in order to handle configuration requests on their interfaces.
3331 * All callbacks except where otherwise noted should return 0
3332 * on success or a negative error code.
3334 * All operations are currently invoked under rtnl for consistency with the
3335 * wireless extensions but this is subject to reevaluation as soon as this
3336 * code is used more widely and we have a first user without wext.
3338 * @suspend: wiphy device needs to be suspended. The variable @wow will
3339 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3340 * configured for the device.
3341 * @resume: wiphy device needs to be resumed
3342 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3343 * to call device_set_wakeup_enable() to enable/disable wakeup from
3346 * @add_virtual_intf: create a new virtual interface with the given name,
3347 * must set the struct wireless_dev's iftype. Beware: You must create
3348 * the new netdev in the wiphy's network namespace! Returns the struct
3349 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3350 * also set the address member in the wdev.
3352 * @del_virtual_intf: remove the virtual interface
3354 * @change_virtual_intf: change type/configuration of virtual interface,
3355 * keep the struct wireless_dev's iftype updated.
3357 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3358 * when adding a group key.
3360 * @get_key: get information about the key with the given parameters.
3361 * @mac_addr will be %NULL when requesting information for a group
3362 * key. All pointers given to the @callback function need not be valid
3363 * after it returns. This function should return an error if it is
3364 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3366 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3367 * and @key_index, return -ENOENT if the key doesn't exist.
3369 * @set_default_key: set the default key on an interface
3371 * @set_default_mgmt_key: set the default management frame key on an interface
3373 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3375 * @start_ap: Start acting in AP mode defined by the parameters.
3376 * @change_beacon: Change the beacon parameters for an access point mode
3377 * interface. This should reject the call when AP mode wasn't started.
3378 * @stop_ap: Stop being an AP, including stopping beaconing.
3380 * @add_station: Add a new station.
3381 * @del_station: Remove a station
3382 * @change_station: Modify a given station. Note that flags changes are not much
3383 * validated in cfg80211, in particular the auth/assoc/authorized flags
3384 * might come to the driver in invalid combinations -- make sure to check
3385 * them, also against the existing state! Drivers must call
3386 * cfg80211_check_station_change() to validate the information.
3387 * @get_station: get station information for the station identified by @mac
3388 * @dump_station: dump station callback -- resume dump at index @idx
3390 * @add_mpath: add a fixed mesh path
3391 * @del_mpath: delete a given mesh path
3392 * @change_mpath: change a given mesh path
3393 * @get_mpath: get a mesh path for the given parameters
3394 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3395 * @get_mpp: get a mesh proxy path for the given parameters
3396 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3397 * @join_mesh: join the mesh network with the specified parameters
3398 * (invoked with the wireless_dev mutex held)
3399 * @leave_mesh: leave the current mesh network
3400 * (invoked with the wireless_dev mutex held)
3402 * @get_mesh_config: Get the current mesh configuration
3404 * @update_mesh_config: Update mesh parameters on a running mesh.
3405 * The mask is a bitfield which tells us which parameters to
3406 * set, and which to leave alone.
3408 * @change_bss: Modify parameters for a given BSS.
3410 * @set_txq_params: Set TX queue parameters
3412 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3413 * as it doesn't implement join_mesh and needs to set the channel to
3414 * join the mesh instead.
3416 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3417 * interfaces are active this callback should reject the configuration.
3418 * If no interfaces are active or the device is down, the channel should
3419 * be stored for when a monitor interface becomes active.
3421 * @scan: Request to do a scan. If returning zero, the scan request is given
3422 * the driver, and will be valid until passed to cfg80211_scan_done().
3423 * For scan results, call cfg80211_inform_bss(); you can call this outside
3424 * the scan/scan_done bracket too.
3425 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3426 * indicate the status of the scan through cfg80211_scan_done().
3428 * @auth: Request to authenticate with the specified peer
3429 * (invoked with the wireless_dev mutex held)
3430 * @assoc: Request to (re)associate with the specified peer
3431 * (invoked with the wireless_dev mutex held)
3432 * @deauth: Request to deauthenticate from the specified peer
3433 * (invoked with the wireless_dev mutex held)
3434 * @disassoc: Request to disassociate from the specified peer
3435 * (invoked with the wireless_dev mutex held)
3437 * @connect: Connect to the ESS with the specified parameters. When connected,
3438 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3439 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3440 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3441 * from the AP or cfg80211_connect_timeout() if no frame with status code
3443 * The driver is allowed to roam to other BSSes within the ESS when the
3444 * other BSS matches the connect parameters. When such roaming is initiated
3445 * by the driver, the driver is expected to verify that the target matches
3446 * the configured security parameters and to use Reassociation Request
3447 * frame instead of Association Request frame.
3448 * The connect function can also be used to request the driver to perform a
3449 * specific roam when connected to an ESS. In that case, the prev_bssid
3450 * parameter is set to the BSSID of the currently associated BSS as an
3451 * indication of requesting reassociation.
3452 * In both the driver-initiated and new connect() call initiated roaming
3453 * cases, the result of roaming is indicated with a call to
3454 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3455 * @update_connect_params: Update the connect parameters while connected to a
3456 * BSS. The updated parameters can be used by driver/firmware for
3457 * subsequent BSS selection (roaming) decisions and to form the
3458 * Authentication/(Re)Association Request frames. This call does not
3459 * request an immediate disassociation or reassociation with the current
3460 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3461 * changed are defined in &enum cfg80211_connect_params_changed.
3462 * (invoked with the wireless_dev mutex held)
3463 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3464 * connection is in progress. Once done, call cfg80211_disconnected() in
3465 * case connection was already established (invoked with the
3466 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3468 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3469 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3471 * (invoked with the wireless_dev mutex held)
3472 * @leave_ibss: Leave the IBSS.
3473 * (invoked with the wireless_dev mutex held)
3475 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3478 * @set_wiphy_params: Notify that wiphy parameters have changed;
3479 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3480 * have changed. The actual parameter values are available in
3481 * struct wiphy. If returning an error, no value should be changed.
3483 * @set_tx_power: set the transmit power according to the parameters,
3484 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3485 * wdev may be %NULL if power was set for the wiphy, and will
3486 * always be %NULL unless the driver supports per-vif TX power
3487 * (as advertised by the nl80211 feature flag.)
3488 * @get_tx_power: store the current TX power into the dbm variable;
3489 * return 0 if successful
3491 * @set_wds_peer: set the WDS peer for a WDS interface
3493 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3494 * functions to adjust rfkill hw state
3496 * @dump_survey: get site survey information.
3498 * @remain_on_channel: Request the driver to remain awake on the specified
3499 * channel for the specified duration to complete an off-channel
3500 * operation (e.g., public action frame exchange). When the driver is
3501 * ready on the requested channel, it must indicate this with an event
3502 * notification by calling cfg80211_ready_on_channel().
3503 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3504 * This allows the operation to be terminated prior to timeout based on
3505 * the duration value.
3506 * @mgmt_tx: Transmit a management frame.
3507 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3508 * frame on another channel
3510 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3511 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3512 * used by the function, but 0 and 1 must not be touched. Additionally,
3513 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3514 * dump and return to userspace with an error, so be careful. If any data
3515 * was passed in from userspace then the data/len arguments will be present
3516 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3518 * @set_bitrate_mask: set the bitrate mask configuration
3520 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3521 * devices running firmwares capable of generating the (re) association
3522 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3523 * @del_pmksa: Delete a cached PMKID.
3524 * @flush_pmksa: Flush all cached PMKIDs.
3525 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3526 * allows the driver to adjust the dynamic ps timeout value.
3527 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3528 * After configuration, the driver should (soon) send an event indicating
3529 * the current level is above/below the configured threshold; this may
3530 * need some care when the configuration is changed (without first being
3532 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3533 * connection quality monitor. An event is to be sent only when the
3534 * signal level is found to be outside the two values. The driver should
3535 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3536 * If it is provided then there's no point providing @set_cqm_rssi_config.
3537 * @set_cqm_txe_config: Configure connection quality monitor TX error
3539 * @sched_scan_start: Tell the driver to start a scheduled scan.
3540 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3541 * given request id. This call must stop the scheduled scan and be ready
3542 * for starting a new one before it returns, i.e. @sched_scan_start may be
3543 * called immediately after that again and should not fail in that case.
3544 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3545 * stop (when this method returns 0).
3547 * @mgmt_frame_register: Notify driver that a management frame type was
3548 * registered. The callback is allowed to sleep.
3550 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3551 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3552 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3553 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3555 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3557 * @tdls_mgmt: Transmit a TDLS management frame.
3558 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3560 * @probe_client: probe an associated client, must return a cookie that it
3561 * later passes to cfg80211_probe_status().
3563 * @set_noack_map: Set the NoAck Map for the TIDs.
3565 * @get_channel: Get the current operating channel for the virtual interface.
3566 * For monitor interfaces, it should return %NULL unless there's a single
3567 * current monitoring channel.
3569 * @start_p2p_device: Start the given P2P device.
3570 * @stop_p2p_device: Stop the given P2P device.
3572 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3573 * Parameters include ACL policy, an array of MAC address of stations
3574 * and the number of MAC addresses. If there is already a list in driver
3575 * this new list replaces the existing one. Driver has to clear its ACL
3576 * when number of MAC addresses entries is passed as 0. Drivers which
3577 * advertise the support for MAC based ACL have to implement this callback.
3579 * @start_radar_detection: Start radar detection in the driver.
3581 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3582 * driver. If the SME is in the driver/firmware, this information can be
3583 * used in building Authentication and Reassociation Request frames.
3585 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3586 * for a given duration (milliseconds). The protocol is provided so the
3587 * driver can take the most appropriate actions.
3588 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3589 * reliability. This operation can not fail.
3590 * @set_coalesce: Set coalesce parameters.
3592 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3593 * responsible for veryfing if the switch is possible. Since this is
3594 * inherently tricky driver may decide to disconnect an interface later
3595 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3596 * everything. It should do it's best to verify requests and reject them
3597 * as soon as possible.
3599 * @set_qos_map: Set QoS mapping information to the driver
3601 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3602 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3603 * changes during the lifetime of the BSS.
3605 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3606 * with the given parameters; action frame exchange has been handled by
3607 * userspace so this just has to modify the TX path to take the TS into
3609 * If the admitted time is 0 just validate the parameters to make sure
3610 * the session can be created at all; it is valid to just always return
3611 * success for that but that may result in inefficient behaviour (handshake
3612 * with the peer followed by immediate teardown when the addition is later
3614 * @del_tx_ts: remove an existing TX TS
3616 * @join_ocb: join the OCB network with the specified parameters
3617 * (invoked with the wireless_dev mutex held)
3618 * @leave_ocb: leave the current OCB network
3619 * (invoked with the wireless_dev mutex held)
3621 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3622 * is responsible for continually initiating channel-switching operations
3623 * and returning to the base channel for communication with the AP.
3624 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3625 * peers must be on the base channel when the call completes.
3626 * @start_nan: Start the NAN interface.
3627 * @stop_nan: Stop the NAN interface.
3628 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3629 * On success @nan_func ownership is transferred to the driver and
3630 * it may access it outside of the scope of this function. The driver
3631 * should free the @nan_func when no longer needed by calling
3632 * cfg80211_free_nan_func().
3633 * On success the driver should assign an instance_id in the
3634 * provided @nan_func.
3635 * @del_nan_func: Delete a NAN function.
3636 * @nan_change_conf: changes NAN configuration. The changed parameters must
3637 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3638 * All other parameters must be ignored.
3640 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3642 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3643 * function should return phy stats, and interface stats otherwise.
3645 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3646 * If not deleted through @del_pmk the PMK remains valid until disconnect
3647 * upon which the driver should clear it.
3648 * (invoked with the wireless_dev mutex held)
3649 * @del_pmk: delete the previously configured PMK for the given authenticator.
3650 * (invoked with the wireless_dev mutex held)
3652 * @external_auth: indicates result of offloaded authentication processing from
3655 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3656 * tells the driver that the frame should not be encrypted.
3658 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3659 * Statistics should be cumulative, currently no way to reset is provided.
3660 * @start_pmsr: start peer measurement (e.g. FTM)
3661 * @abort_pmsr: abort peer measurement
3663 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3664 * but offloading OWE processing to the user space will get the updated
3665 * DH IE through this interface.
3667 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3668 * and overrule HWMP path selection algorithm.
3670 struct cfg80211_ops {
3671 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3672 int (*resume)(struct wiphy *wiphy);
3673 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3675 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3677 unsigned char name_assign_type,
3678 enum nl80211_iftype type,
3679 struct vif_params *params);
3680 int (*del_virtual_intf)(struct wiphy *wiphy,
3681 struct wireless_dev *wdev);
3682 int (*change_virtual_intf)(struct wiphy *wiphy,
3683 struct net_device *dev,
3684 enum nl80211_iftype type,
3685 struct vif_params *params);
3687 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3688 u8 key_index, bool pairwise, const u8 *mac_addr,
3689 struct key_params *params);
3690 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3691 u8 key_index, bool pairwise, const u8 *mac_addr,
3693 void (*callback)(void *cookie, struct key_params*));
3694 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3695 u8 key_index, bool pairwise, const u8 *mac_addr);
3696 int (*set_default_key)(struct wiphy *wiphy,
3697 struct net_device *netdev,
3698 u8 key_index, bool unicast, bool multicast);
3699 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3700 struct net_device *netdev,
3703 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3704 struct cfg80211_ap_settings *settings);
3705 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3706 struct cfg80211_beacon_data *info);
3707 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3710 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3712 struct station_parameters *params);
3713 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3714 struct station_del_parameters *params);
3715 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3717 struct station_parameters *params);
3718 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3719 const u8 *mac, struct station_info *sinfo);
3720 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3721 int idx, u8 *mac, struct station_info *sinfo);
3723 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3724 const u8 *dst, const u8 *next_hop);
3725 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3727 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3728 const u8 *dst, const u8 *next_hop);
3729 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3730 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3731 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3732 int idx, u8 *dst, u8 *next_hop,
3733 struct mpath_info *pinfo);
3734 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3735 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3736 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3737 int idx, u8 *dst, u8 *mpp,
3738 struct mpath_info *pinfo);
3739 int (*get_mesh_config)(struct wiphy *wiphy,
3740 struct net_device *dev,
3741 struct mesh_config *conf);
3742 int (*update_mesh_config)(struct wiphy *wiphy,
3743 struct net_device *dev, u32 mask,
3744 const struct mesh_config *nconf);
3745 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3746 const struct mesh_config *conf,
3747 const struct mesh_setup *setup);
3748 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3750 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3751 struct ocb_setup *setup);
3752 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3754 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3755 struct bss_parameters *params);
3757 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3758 struct ieee80211_txq_params *params);
3760 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3761 struct net_device *dev,
3762 struct ieee80211_channel *chan);
3764 int (*set_monitor_channel)(struct wiphy *wiphy,
3765 struct cfg80211_chan_def *chandef);
3767 int (*scan)(struct wiphy *wiphy,
3768 struct cfg80211_scan_request *request);
3769 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3771 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
3772 struct cfg80211_auth_request *req);
3773 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3774 struct cfg80211_assoc_request *req);
3775 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3776 struct cfg80211_deauth_request *req);
3777 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3778 struct cfg80211_disassoc_request *req);
3780 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
3781 struct cfg80211_connect_params *sme);
3782 int (*update_connect_params)(struct wiphy *wiphy,
3783 struct net_device *dev,
3784 struct cfg80211_connect_params *sme,
3786 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3789 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3790 struct cfg80211_ibss_params *params);
3791 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3793 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3794 int rate[NUM_NL80211_BANDS]);
3796 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3798 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3799 enum nl80211_tx_power_setting type, int mbm);
3800 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3803 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3806 void (*rfkill_poll)(struct wiphy *wiphy);
3808 #ifdef CONFIG_NL80211_TESTMODE
3809 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3810 void *data, int len);
3811 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3812 struct netlink_callback *cb,
3813 void *data, int len);
3816 int (*set_bitrate_mask)(struct wiphy *wiphy,
3817 struct net_device *dev,
3819 const struct cfg80211_bitrate_mask *mask);
3821 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3822 int idx, struct survey_info *info);
3824 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3825 struct cfg80211_pmksa *pmksa);
3826 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3827 struct cfg80211_pmksa *pmksa);
3828 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3830 int (*remain_on_channel)(struct wiphy *wiphy,
3831 struct wireless_dev *wdev,
3832 struct ieee80211_channel *chan,
3833 unsigned int duration,
3835 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
3836 struct wireless_dev *wdev,
3839 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3840 struct cfg80211_mgmt_tx_params *params,
3842 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3843 struct wireless_dev *wdev,
3846 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3847 bool enabled, int timeout);
3849 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
3850 struct net_device *dev,
3851 s32 rssi_thold, u32 rssi_hyst);
3853 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3854 struct net_device *dev,
3855 s32 rssi_low, s32 rssi_high);
3857 int (*set_cqm_txe_config)(struct wiphy *wiphy,
3858 struct net_device *dev,
3859 u32 rate, u32 pkts, u32 intvl);
3861 void (*mgmt_frame_register)(struct wiphy *wiphy,
3862 struct wireless_dev *wdev,
3863 u16 frame_type, bool reg);
3865 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3866 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3868 int (*sched_scan_start)(struct wiphy *wiphy,
3869 struct net_device *dev,
3870 struct cfg80211_sched_scan_request *request);
3871 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3874 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3875 struct cfg80211_gtk_rekey_data *data);
3877 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3878 const u8 *peer, u8 action_code, u8 dialog_token,
3879 u16 status_code, u32 peer_capability,
3880 bool initiator, const u8 *buf, size_t len);
3881 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3882 const u8 *peer, enum nl80211_tdls_operation oper);
3884 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3885 const u8 *peer, u64 *cookie);
3887 int (*set_noack_map)(struct wiphy *wiphy,
3888 struct net_device *dev,
3891 int (*get_channel)(struct wiphy *wiphy,
3892 struct wireless_dev *wdev,
3893 struct cfg80211_chan_def *chandef);
3895 int (*start_p2p_device)(struct wiphy *wiphy,
3896 struct wireless_dev *wdev);
3897 void (*stop_p2p_device)(struct wiphy *wiphy,
3898 struct wireless_dev *wdev);
3900 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3901 const struct cfg80211_acl_data *params);
3903 int (*start_radar_detection)(struct wiphy *wiphy,
3904 struct net_device *dev,
3905 struct cfg80211_chan_def *chandef,
3907 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3908 struct cfg80211_update_ft_ies_params *ftie);
3909 int (*crit_proto_start)(struct wiphy *wiphy,
3910 struct wireless_dev *wdev,
3911 enum nl80211_crit_proto_id protocol,
3913 void (*crit_proto_stop)(struct wiphy *wiphy,
3914 struct wireless_dev *wdev);
3915 int (*set_coalesce)(struct wiphy *wiphy,
3916 struct cfg80211_coalesce *coalesce);
3918 int (*channel_switch)(struct wiphy *wiphy,
3919 struct net_device *dev,
3920 struct cfg80211_csa_settings *params);
3922 int (*set_qos_map)(struct wiphy *wiphy,
3923 struct net_device *dev,
3924 struct cfg80211_qos_map *qos_map);
3926 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3927 struct cfg80211_chan_def *chandef);
3929 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3930 u8 tsid, const u8 *peer, u8 user_prio,
3932 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3933 u8 tsid, const u8 *peer);
3935 int (*tdls_channel_switch)(struct wiphy *wiphy,
3936 struct net_device *dev,
3937 const u8 *addr, u8 oper_class,
3938 struct cfg80211_chan_def *chandef);
3939 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3940 struct net_device *dev,
3942 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3943 struct cfg80211_nan_conf *conf);
3944 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3945 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3946 struct cfg80211_nan_func *nan_func);
3947 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3949 int (*nan_change_conf)(struct wiphy *wiphy,
3950 struct wireless_dev *wdev,
3951 struct cfg80211_nan_conf *conf,
3954 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
3955 struct net_device *dev,
3956 const bool enabled);
3958 int (*get_txq_stats)(struct wiphy *wiphy,
3959 struct wireless_dev *wdev,
3960 struct cfg80211_txq_stats *txqstats);
3962 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3963 const struct cfg80211_pmk_conf *conf);
3964 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3966 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3967 struct cfg80211_external_auth_params *params);
3969 int (*tx_control_port)(struct wiphy *wiphy,
3970 struct net_device *dev,
3971 const u8 *buf, size_t len,
3972 const u8 *dest, const __be16 proto,
3973 const bool noencrypt);
3975 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
3976 struct net_device *dev,
3977 struct cfg80211_ftm_responder_stats *ftm_stats);
3979 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3980 struct cfg80211_pmsr_request *request);
3981 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3982 struct cfg80211_pmsr_request *request);
3983 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
3984 struct cfg80211_update_owe_info *owe_info);
3985 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
3986 const u8 *buf, size_t len);
3990 * wireless hardware and networking interfaces structures
3991 * and registration/helper functions
3995 * enum wiphy_flags - wiphy capability flags
3997 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3999 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4000 * by default -- this flag will be set depending on the kernel's default
4001 * on wiphy_new(), but can be changed by the driver if it has a good
4002 * reason to override the default
4003 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4004 * on a VLAN interface). This flag also serves an extra purpose of
4005 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4006 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4007 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4008 * control port protocol ethertype. The device also honours the
4009 * control_port_no_encrypt flag.
4010 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4011 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4012 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4013 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4015 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4016 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4017 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4018 * link setup/discovery operations internally. Setup, discovery and
4019 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4020 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4021 * used for asking the driver/firmware to perform a TDLS operation.
4022 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4023 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4024 * when there are virtual interfaces in AP mode by calling
4025 * cfg80211_report_obss_beacon().
4026 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4027 * responds to probe-requests in hardware.
4028 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4029 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4030 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4031 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4032 * beaconing mode (AP, IBSS, Mesh, ...).
4033 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4034 * before connection.
4040 WIPHY_FLAG_NETNS_OK = BIT(3),
4041 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4042 WIPHY_FLAG_4ADDR_AP = BIT(5),
4043 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4044 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4045 WIPHY_FLAG_IBSS_RSN = BIT(8),
4046 WIPHY_FLAG_MESH_AUTH = BIT(10),
4047 /* use hole at 11 */
4048 /* use hole at 12 */
4049 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4050 WIPHY_FLAG_AP_UAPSD = BIT(14),
4051 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4052 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4053 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4054 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4055 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4056 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4057 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4058 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4059 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4060 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4064 * struct ieee80211_iface_limit - limit on certain interface types
4065 * @max: maximum number of interfaces of these types
4066 * @types: interface types (bits)
4068 struct ieee80211_iface_limit {
4074 * struct ieee80211_iface_combination - possible interface combination
4076 * With this structure the driver can describe which interface
4077 * combinations it supports concurrently.
4081 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4085 * struct ieee80211_iface_limit limits1[] = {
4086 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4087 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4089 * struct ieee80211_iface_combination combination1 = {
4090 * .limits = limits1,
4091 * .n_limits = ARRAY_SIZE(limits1),
4092 * .max_interfaces = 2,
4093 * .beacon_int_infra_match = true,
4097 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4101 * struct ieee80211_iface_limit limits2[] = {
4102 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4103 * BIT(NL80211_IFTYPE_P2P_GO), },
4105 * struct ieee80211_iface_combination combination2 = {
4106 * .limits = limits2,
4107 * .n_limits = ARRAY_SIZE(limits2),
4108 * .max_interfaces = 8,
4109 * .num_different_channels = 1,
4113 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4115 * This allows for an infrastructure connection and three P2P connections.
4119 * struct ieee80211_iface_limit limits3[] = {
4120 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4121 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4122 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4124 * struct ieee80211_iface_combination combination3 = {
4125 * .limits = limits3,
4126 * .n_limits = ARRAY_SIZE(limits3),
4127 * .max_interfaces = 4,
4128 * .num_different_channels = 2,
4132 struct ieee80211_iface_combination {
4135 * limits for the given interface types
4137 const struct ieee80211_iface_limit *limits;
4140 * @num_different_channels:
4141 * can use up to this many different channels
4143 u32 num_different_channels;
4147 * maximum number of interfaces in total allowed in this group
4153 * number of limitations
4158 * @beacon_int_infra_match:
4159 * In this combination, the beacon intervals between infrastructure
4160 * and AP types must match. This is required only in special cases.
4162 bool beacon_int_infra_match;
4165 * @radar_detect_widths:
4166 * bitmap of channel widths supported for radar detection
4168 u8 radar_detect_widths;
4171 * @radar_detect_regions:
4172 * bitmap of regions supported for radar detection
4174 u8 radar_detect_regions;
4177 * @beacon_int_min_gcd:
4178 * This interface combination supports different beacon intervals.
4181 * all beacon intervals for different interface must be same.
4183 * any beacon interval for the interface part of this combination AND
4184 * GCD of all beacon intervals from beaconing interfaces of this
4185 * combination must be greater or equal to this value.
4187 u32 beacon_int_min_gcd;
4190 struct ieee80211_txrx_stypes {
4195 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4196 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4197 * trigger that keeps the device operating as-is and
4198 * wakes up the host on any activity, for example a
4199 * received packet that passed filtering; note that the
4200 * packet should be preserved in that case
4201 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4203 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4204 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4205 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4206 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4207 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4208 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4209 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4211 enum wiphy_wowlan_support_flags {
4212 WIPHY_WOWLAN_ANY = BIT(0),
4213 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4214 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4215 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4216 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4217 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4218 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4219 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4220 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4223 struct wiphy_wowlan_tcp_support {
4224 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4225 u32 data_payload_max;
4226 u32 data_interval_max;
4227 u32 wake_payload_max;
4232 * struct wiphy_wowlan_support - WoWLAN support data
4233 * @flags: see &enum wiphy_wowlan_support_flags
4234 * @n_patterns: number of supported wakeup patterns
4235 * (see nl80211.h for the pattern definition)
4236 * @pattern_max_len: maximum length of each pattern
4237 * @pattern_min_len: minimum length of each pattern
4238 * @max_pkt_offset: maximum Rx packet offset
4239 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4240 * similar, but not necessarily identical, to max_match_sets for
4242 * See &struct cfg80211_sched_scan_request.@match_sets for more
4244 * @tcp: TCP wakeup support information
4246 struct wiphy_wowlan_support {
4249 int pattern_max_len;
4250 int pattern_min_len;
4252 int max_nd_match_sets;
4253 const struct wiphy_wowlan_tcp_support *tcp;
4257 * struct wiphy_coalesce_support - coalesce support data
4258 * @n_rules: maximum number of coalesce rules
4259 * @max_delay: maximum supported coalescing delay in msecs
4260 * @n_patterns: number of supported patterns in a rule
4261 * (see nl80211.h for the pattern definition)
4262 * @pattern_max_len: maximum length of each pattern
4263 * @pattern_min_len: minimum length of each pattern
4264 * @max_pkt_offset: maximum Rx packet offset
4266 struct wiphy_coalesce_support {
4270 int pattern_max_len;
4271 int pattern_min_len;
4276 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4277 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4278 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4279 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4280 * (must be combined with %_WDEV or %_NETDEV)
4282 enum wiphy_vendor_command_flags {
4283 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4284 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4285 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4289 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4291 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4292 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4293 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4296 enum wiphy_opmode_flag {
4297 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4298 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4299 STA_OPMODE_N_SS_CHANGED = BIT(2),
4303 * struct sta_opmode_info - Station's ht/vht operation mode information
4304 * @changed: contains value from &enum wiphy_opmode_flag
4305 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4306 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4307 * @rx_nss: new rx_nss value of a station
4310 struct sta_opmode_info {
4312 enum nl80211_smps_mode smps_mode;
4313 enum nl80211_chan_width bw;
4317 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4320 * struct wiphy_vendor_command - vendor command definition
4321 * @info: vendor command identifying information, as used in nl80211
4322 * @flags: flags, see &enum wiphy_vendor_command_flags
4323 * @doit: callback for the operation, note that wdev is %NULL if the
4324 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4325 * pointer may be %NULL if userspace provided no data at all
4326 * @dumpit: dump callback, for transferring bigger/multiple items. The
4327 * @storage points to cb->args[5], ie. is preserved over the multiple
4329 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4330 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4331 * attribute is just raw data (e.g. a firmware command).
4332 * @maxattr: highest attribute number in policy
4333 * It's recommended to not have the same sub command with both @doit and
4334 * @dumpit, so that userspace can assume certain ones are get and others
4335 * are used with dump requests.
4337 struct wiphy_vendor_command {
4338 struct nl80211_vendor_cmd_info info;
4340 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4341 const void *data, int data_len);
4342 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4343 struct sk_buff *skb, const void *data, int data_len,
4344 unsigned long *storage);
4345 const struct nla_policy *policy;
4346 unsigned int maxattr;
4350 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4351 * @iftype: interface type
4352 * @extended_capabilities: extended capabilities supported by the driver,
4353 * additional capabilities might be supported by userspace; these are the
4354 * 802.11 extended capabilities ("Extended Capabilities element") and are
4355 * in the same format as in the information element. See IEEE Std
4356 * 802.11-2012 8.4.2.29 for the defined fields.
4357 * @extended_capabilities_mask: mask of the valid values
4358 * @extended_capabilities_len: length of the extended capabilities
4360 struct wiphy_iftype_ext_capab {
4361 enum nl80211_iftype iftype;
4362 const u8 *extended_capabilities;
4363 const u8 *extended_capabilities_mask;
4364 u8 extended_capabilities_len;
4368 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4369 * @max_peers: maximum number of peers in a single measurement
4370 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4371 * @randomize_mac_addr: can randomize MAC address for measurement
4372 * @ftm.supported: FTM measurement is supported
4373 * @ftm.asap: ASAP-mode is supported
4374 * @ftm.non_asap: non-ASAP-mode is supported
4375 * @ftm.request_lci: can request LCI data
4376 * @ftm.request_civicloc: can request civic location data
4377 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4378 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4379 * @ftm.max_bursts_exponent: maximum burst exponent supported
4380 * (set to -1 if not limited; note that setting this will necessarily
4381 * forbid using the value 15 to let the responder pick)
4382 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4385 struct cfg80211_pmsr_capabilities {
4386 unsigned int max_peers;
4388 randomize_mac_addr:1;
4393 s8 max_bursts_exponent;
4394 u8 max_ftms_per_burst;
4404 * struct wiphy - wireless hardware description
4405 * @reg_notifier: the driver's regulatory notification callback,
4406 * note that if your driver uses wiphy_apply_custom_regulatory()
4407 * the reg_notifier's request can be passed as NULL
4408 * @regd: the driver's regulatory domain, if one was requested via
4409 * the regulatory_hint() API. This can be used by the driver
4410 * on the reg_notifier() if it chooses to ignore future
4411 * regulatory domain changes caused by other drivers.
4412 * @signal_type: signal type reported in &struct cfg80211_bss.
4413 * @cipher_suites: supported cipher suites
4414 * @n_cipher_suites: number of supported cipher suites
4415 * @akm_suites: supported AKM suites
4416 * @n_akm_suites: number of supported AKM suites
4417 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4418 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4419 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4420 * -1 = fragmentation disabled, only odd values >= 256 used
4421 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4422 * @_net: the network namespace this wiphy currently lives in
4423 * @perm_addr: permanent MAC address of this device
4424 * @addr_mask: If the device supports multiple MAC addresses by masking,
4425 * set this to a mask with variable bits set to 1, e.g. if the last
4426 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4427 * variable bits shall be determined by the interfaces added, with
4428 * interfaces not matching the mask being rejected to be brought up.
4429 * @n_addresses: number of addresses in @addresses.
4430 * @addresses: If the device has more than one address, set this pointer
4431 * to a list of addresses (6 bytes each). The first one will be used
4432 * by default for perm_addr. In this case, the mask should be set to
4433 * all-zeroes. In this case it is assumed that the device can handle
4434 * the same number of arbitrary MAC addresses.
4435 * @registered: protects ->resume and ->suspend sysfs callbacks against
4436 * unregister hardware
4437 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
4438 * automatically on wiphy renames
4439 * @dev: (virtual) struct device for this wiphy
4440 * @registered: helps synchronize suspend/resume with wiphy unregister
4441 * @wext: wireless extension handlers
4442 * @priv: driver private data (sized according to wiphy_new() parameter)
4443 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4444 * must be set by driver
4445 * @iface_combinations: Valid interface combinations array, should not
4446 * list single interface types.
4447 * @n_iface_combinations: number of entries in @iface_combinations array.
4448 * @software_iftypes: bitmask of software interface types, these are not
4449 * subject to any restrictions since they are purely managed in SW.
4450 * @flags: wiphy flags, see &enum wiphy_flags
4451 * @regulatory_flags: wiphy regulatory flags, see
4452 * &enum ieee80211_regulatory_flags
4453 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4454 * @ext_features: extended features advertised to nl80211, see
4455 * &enum nl80211_ext_feature_index.
4456 * @bss_priv_size: each BSS struct has private data allocated with it,
4457 * this variable determines its size
4458 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4460 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4461 * the device can run concurrently.
4462 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4463 * for in any given scheduled scan
4464 * @max_match_sets: maximum number of match sets the device can handle
4465 * when performing a scheduled scan, 0 if filtering is not
4467 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4468 * add to probe request frames transmitted during a scan, must not
4469 * include fixed IEs like supported rates
4470 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4472 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4473 * of iterations) for scheduled scan supported by the device.
4474 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4475 * single scan plan supported by the device.
4476 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4477 * scan plan supported by the device.
4478 * @coverage_class: current coverage class
4479 * @fw_version: firmware version for ethtool reporting
4480 * @hw_version: hardware version for ethtool reporting
4481 * @max_num_pmkids: maximum number of PMKIDs supported by device
4482 * @privid: a pointer that drivers can use to identify if an arbitrary
4483 * wiphy is theirs, e.g. in global notifiers
4484 * @bands: information about bands/channels supported by this device
4486 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4487 * transmitted through nl80211, points to an array indexed by interface
4490 * @available_antennas_tx: bitmap of antennas which are available to be
4491 * configured as TX antennas. Antenna configuration commands will be
4492 * rejected unless this or @available_antennas_rx is set.
4494 * @available_antennas_rx: bitmap of antennas which are available to be
4495 * configured as RX antennas. Antenna configuration commands will be
4496 * rejected unless this or @available_antennas_tx is set.
4498 * @probe_resp_offload:
4499 * Bitmap of supported protocols for probe response offloading.
4500 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4501 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4503 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4504 * may request, if implemented.
4506 * @wowlan: WoWLAN support information
4507 * @wowlan_config: current WoWLAN configuration; this should usually not be
4508 * used since access to it is necessarily racy, use the parameter passed
4509 * to the suspend() operation instead.
4511 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4512 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4513 * If null, then none can be over-ridden.
4514 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4515 * If null, then none can be over-ridden.
4517 * @wdev_list: the list of associated (virtual) interfaces; this list must
4518 * not be modified by the driver, but can be read with RTNL/RCU protection.
4520 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4523 * @extended_capabilities: extended capabilities supported by the driver,
4524 * additional capabilities might be supported by userspace; these are
4525 * the 802.11 extended capabilities ("Extended Capabilities element")
4526 * and are in the same format as in the information element. See
4527 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4528 * extended capabilities to be used if the capabilities are not specified
4529 * for a specific interface type in iftype_ext_capab.
4530 * @extended_capabilities_mask: mask of the valid values
4531 * @extended_capabilities_len: length of the extended capabilities
4532 * @iftype_ext_capab: array of extended capabilities per interface type
4533 * @num_iftype_ext_capab: number of interface types for which extended
4534 * capabilities are specified separately.
4535 * @coalesce: packet coalescing support information
4537 * @vendor_commands: array of vendor commands supported by the hardware
4538 * @n_vendor_commands: number of vendor commands
4539 * @vendor_events: array of vendor events supported by the hardware
4540 * @n_vendor_events: number of vendor events
4542 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4543 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4544 * driver is allowed to advertise a theoretical limit that it can reach in
4545 * some cases, but may not always reach.
4547 * @max_num_csa_counters: Number of supported csa_counters in beacons
4548 * and probe responses. This value should be set if the driver
4549 * wishes to limit the number of csa counters. Default (0) means
4551 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
4552 * frame was sent and the channel on which the frame was heard for which
4553 * the reported rssi is still valid. If a driver is able to compensate the
4554 * low rssi when a frame is heard on different channel, then it should set
4555 * this variable to the maximal offset for which it can compensate.
4556 * This value should be set in MHz.
4557 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4558 * by the driver in the .connect() callback. The bit position maps to the
4559 * attribute indices defined in &enum nl80211_bss_select_attr.
4561 * @nan_supported_bands: bands supported by the device in NAN mode, a
4562 * bitmap of &enum nl80211_band values. For instance, for
4563 * NL80211_BAND_2GHZ, bit 0 would be set
4564 * (i.e. BIT(NL80211_BAND_2GHZ)).
4566 * @txq_limit: configuration of internal TX queue frame limit
4567 * @txq_memory_limit: configuration internal TX queue memory limit
4568 * @txq_quantum: configuration of internal TX queue scheduler quantum
4570 * @support_mbssid: can HW support association with nontransmitted AP
4571 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4572 * HE AP, in order to avoid compatibility issues.
4573 * @support_mbssid must be set for this to have any effect.
4575 * @pmsr_capa: peer measurement capabilities
4578 /* assign these fields before you register the wiphy */
4580 /* permanent MAC address(es) */
4581 u8 perm_addr[ETH_ALEN];
4582 u8 addr_mask[ETH_ALEN];
4584 struct mac_address *addresses;
4586 const struct ieee80211_txrx_stypes *mgmt_stypes;
4588 const struct ieee80211_iface_combination *iface_combinations;
4589 int n_iface_combinations;
4590 u16 software_iftypes;
4594 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4595 u16 interface_modes;
4597 u16 max_acl_mac_addrs;
4599 u32 flags, regulatory_flags, features;
4600 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4604 enum cfg80211_signal_type signal_type;
4608 u8 max_sched_scan_reqs;
4609 u8 max_sched_scan_ssids;
4611 u16 max_scan_ie_len;
4612 u16 max_sched_scan_ie_len;
4613 u32 max_sched_scan_plans;
4614 u32 max_sched_scan_plan_interval;
4615 u32 max_sched_scan_plan_iterations;
4617 int n_cipher_suites;
4618 const u32 *cipher_suites;
4621 const u32 *akm_suites;
4629 char fw_version[ETHTOOL_FWVERS_LEN];
4633 const struct wiphy_wowlan_support *wowlan;
4634 struct cfg80211_wowlan *wowlan_config;
4637 u16 max_remain_on_channel_duration;
4641 u32 available_antennas_tx;
4642 u32 available_antennas_rx;
4645 * Bitmap of supported protocols for probe response offloading
4646 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
4647 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4649 u32 probe_resp_offload;
4651 const u8 *extended_capabilities, *extended_capabilities_mask;
4652 u8 extended_capabilities_len;
4654 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4655 unsigned int num_iftype_ext_capab;
4657 /* If multiple wiphys are registered and you're handed e.g.
4658 * a regular netdev with assigned ieee80211_ptr, you won't
4659 * know whether it points to a wiphy your driver has registered
4660 * or not. Assign this to something global to your driver to
4661 * help determine whether you own this wiphy or not. */
4664 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4666 /* Lets us get back the wiphy on the callback */
4667 void (*reg_notifier)(struct wiphy *wiphy,
4668 struct regulatory_request *request);
4670 /* fields below are read-only, assigned by cfg80211 */
4672 const struct ieee80211_regdomain __rcu *regd;
4674 /* the item in /sys/class/ieee80211/ points to this,
4675 * you need use set_wiphy_dev() (see below) */
4678 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
4681 /* dir in debugfs: ieee80211/<wiphyname> */
4682 struct dentry *debugfsdir;
4684 const struct ieee80211_ht_cap *ht_capa_mod_mask;
4685 const struct ieee80211_vht_cap *vht_capa_mod_mask;
4687 struct list_head wdev_list;
4689 /* the network namespace this phy lives in currently */
4690 possible_net_t _net;
4692 #ifdef CONFIG_CFG80211_WEXT
4693 const struct iw_handler_def *wext;
4696 const struct wiphy_coalesce_support *coalesce;
4698 const struct wiphy_vendor_command *vendor_commands;
4699 const struct nl80211_vendor_cmd_info *vendor_events;
4700 int n_vendor_commands, n_vendor_events;
4702 u16 max_ap_assoc_sta;
4704 u8 max_num_csa_counters;
4705 u8 max_adj_channel_rssi_comp;
4707 u32 bss_select_support;
4709 u8 nan_supported_bands;
4712 u32 txq_memory_limit;
4715 u8 support_mbssid:1,
4716 support_only_he_mbssid:1;
4718 const struct cfg80211_pmsr_capabilities *pmsr_capa;
4720 char priv[0] __aligned(NETDEV_ALIGN);
4723 static inline struct net *wiphy_net(struct wiphy *wiphy)
4725 return read_pnet(&wiphy->_net);
4728 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4730 write_pnet(&wiphy->_net, net);
4734 * wiphy_priv - return priv from wiphy
4736 * @wiphy: the wiphy whose priv pointer to return
4737 * Return: The priv of @wiphy.
4739 static inline void *wiphy_priv(struct wiphy *wiphy)
4742 return &wiphy->priv;
4746 * priv_to_wiphy - return the wiphy containing the priv
4748 * @priv: a pointer previously returned by wiphy_priv
4749 * Return: The wiphy of @priv.
4751 static inline struct wiphy *priv_to_wiphy(void *priv)
4754 return container_of(priv, struct wiphy, priv);
4758 * set_wiphy_dev - set device pointer for wiphy
4760 * @wiphy: The wiphy whose device to bind
4761 * @dev: The device to parent it to
4763 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4765 wiphy->dev.parent = dev;
4769 * wiphy_dev - get wiphy dev pointer
4771 * @wiphy: The wiphy whose device struct to look up
4772 * Return: The dev of @wiphy.
4774 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4776 return wiphy->dev.parent;
4780 * wiphy_name - get wiphy name
4782 * @wiphy: The wiphy whose name to return
4783 * Return: The name of @wiphy.
4785 static inline const char *wiphy_name(const struct wiphy *wiphy)
4787 return dev_name(&wiphy->dev);
4791 * wiphy_new_nm - create a new wiphy for use with cfg80211
4793 * @ops: The configuration operations for this device
4794 * @sizeof_priv: The size of the private area to allocate
4795 * @requested_name: Request a particular name.
4796 * NULL is valid value, and means use the default phy%d naming.
4798 * Create a new wiphy and associate the given operations with it.
4799 * @sizeof_priv bytes are allocated for private use.
4801 * Return: A pointer to the new wiphy. This pointer must be
4802 * assigned to each netdev's ieee80211_ptr for proper operation.
4804 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4805 const char *requested_name);
4808 * wiphy_new - create a new wiphy for use with cfg80211
4810 * @ops: The configuration operations for this device
4811 * @sizeof_priv: The size of the private area to allocate
4813 * Create a new wiphy and associate the given operations with it.
4814 * @sizeof_priv bytes are allocated for private use.
4816 * Return: A pointer to the new wiphy. This pointer must be
4817 * assigned to each netdev's ieee80211_ptr for proper operation.
4819 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4822 return wiphy_new_nm(ops, sizeof_priv, NULL);
4826 * wiphy_register - register a wiphy with cfg80211
4828 * @wiphy: The wiphy to register.
4830 * Return: A non-negative wiphy index or a negative error code.
4832 int wiphy_register(struct wiphy *wiphy);
4835 * wiphy_unregister - deregister a wiphy from cfg80211
4837 * @wiphy: The wiphy to unregister.
4839 * After this call, no more requests can be made with this priv
4840 * pointer, but the call may sleep to wait for an outstanding
4841 * request that is being handled.
4843 void wiphy_unregister(struct wiphy *wiphy);
4846 * wiphy_free - free wiphy
4848 * @wiphy: The wiphy to free
4850 void wiphy_free(struct wiphy *wiphy);
4852 /* internal structs */
4853 struct cfg80211_conn;
4854 struct cfg80211_internal_bss;
4855 struct cfg80211_cached_keys;
4856 struct cfg80211_cqm_config;
4859 * struct wireless_dev - wireless device state
4861 * For netdevs, this structure must be allocated by the driver
4862 * that uses the ieee80211_ptr field in struct net_device (this
4863 * is intentional so it can be allocated along with the netdev.)
4864 * It need not be registered then as netdev registration will
4865 * be intercepted by cfg80211 to see the new wireless device.
4867 * For non-netdev uses, it must also be allocated by the driver
4868 * in response to the cfg80211 callbacks that require it, as
4869 * there's no netdev registration in that case it may not be
4870 * allocated outside of callback operations that return it.
4872 * @wiphy: pointer to hardware description
4873 * @iftype: interface type
4874 * @list: (private) Used to collect the interfaces
4875 * @netdev: (private) Used to reference back to the netdev, may be %NULL
4876 * @identifier: (private) Identifier used in nl80211 to identify this
4877 * wireless device if it has no netdev
4878 * @current_bss: (private) Used by the internal configuration code
4879 * @chandef: (private) Used by the internal configuration code to track
4880 * the user-set channel definition.
4881 * @preset_chandef: (private) Used by the internal configuration code to
4882 * track the channel to be used for AP later
4883 * @bssid: (private) Used by the internal configuration code
4884 * @ssid: (private) Used by the internal configuration code
4885 * @ssid_len: (private) Used by the internal configuration code
4886 * @mesh_id_len: (private) Used by the internal configuration code
4887 * @mesh_id_up_len: (private) Used by the internal configuration code
4888 * @wext: (private) Used by the internal wireless extensions compat code
4889 * @wext.ibss: (private) IBSS data part of wext handling
4890 * @wext.connect: (private) connection handling data
4891 * @wext.keys: (private) (WEP) key data
4892 * @wext.ie: (private) extra elements for association
4893 * @wext.ie_len: (private) length of extra elements
4894 * @wext.bssid: (private) selected network BSSID
4895 * @wext.ssid: (private) selected network SSID
4896 * @wext.default_key: (private) selected default key index
4897 * @wext.default_mgmt_key: (private) selected default management key index
4898 * @wext.prev_bssid: (private) previous BSSID for reassociation
4899 * @wext.prev_bssid_valid: (private) previous BSSID validity
4900 * @use_4addr: indicates 4addr mode is used on this interface, must be
4901 * set by driver (if supported) on add_interface BEFORE registering the
4902 * netdev and may otherwise be used by driver read-only, will be update
4903 * by cfg80211 on change_interface
4904 * @mgmt_registrations: list of registrations for management frames
4905 * @mgmt_registrations_lock: lock for the list
4906 * @mtx: mutex used to lock data in this struct, may be used by drivers
4907 * and some API functions require it held
4908 * @beacon_interval: beacon interval used on this device for transmitting
4909 * beacons, 0 when not valid
4910 * @address: The address for this device, valid only if @netdev is %NULL
4911 * @is_running: true if this is a non-netdev device that has been started, e.g.
4913 * @cac_started: true if DFS channel availability check has been started
4914 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4915 * @cac_time_ms: CAC time in ms
4916 * @ps: powersave mode is enabled
4917 * @ps_timeout: dynamic powersave timeout
4918 * @ap_unexpected_nlportid: (private) netlink port ID of application
4919 * registered for unexpected class 3 frames (AP mode)
4920 * @conn: (private) cfg80211 software SME connection state machine data
4921 * @connect_keys: (private) keys to set after connection is established
4922 * @conn_bss_type: connecting/connected BSS type
4923 * @conn_owner_nlportid: (private) connection owner socket port ID
4924 * @disconnect_wk: (private) auto-disconnect work
4925 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4926 * @ibss_fixed: (private) IBSS is using fixed BSSID
4927 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4928 * @event_list: (private) list for internal event processing
4929 * @event_lock: (private) lock for event list
4930 * @owner_nlportid: (private) owner socket port ID
4931 * @nl_owner_dead: (private) owner socket went away
4932 * @cqm_config: (private) nl80211 RSSI monitor state
4933 * @pmsr_list: (private) peer measurement requests
4934 * @pmsr_lock: (private) peer measurements requests/results lock
4935 * @pmsr_free_wk: (private) peer measurements cleanup work
4937 struct wireless_dev {
4938 struct wiphy *wiphy;
4939 enum nl80211_iftype iftype;
4941 /* the remainder of this struct should be private to cfg80211 */
4942 struct list_head list;
4943 struct net_device *netdev;
4947 struct list_head mgmt_registrations;
4948 spinlock_t mgmt_registrations_lock;
4952 bool use_4addr, is_running;
4954 u8 address[ETH_ALEN] __aligned(sizeof(u16));
4956 /* currently used for IBSS and SME - might be rearranged later */
4957 u8 ssid[IEEE80211_MAX_SSID_LEN];
4958 u8 ssid_len, mesh_id_len, mesh_id_up_len;
4959 struct cfg80211_conn *conn;
4960 struct cfg80211_cached_keys *connect_keys;
4961 enum ieee80211_bss_type conn_bss_type;
4962 u32 conn_owner_nlportid;
4964 struct work_struct disconnect_wk;
4965 u8 disconnect_bssid[ETH_ALEN];
4967 struct list_head event_list;
4968 spinlock_t event_lock;
4970 struct cfg80211_internal_bss *current_bss; /* associated / joined */
4971 struct cfg80211_chan_def preset_chandef;
4972 struct cfg80211_chan_def chandef;
4975 bool ibss_dfs_possible;
4980 int beacon_interval;
4982 u32 ap_unexpected_nlportid;
4988 unsigned long cac_start_time;
4989 unsigned int cac_time_ms;
4991 #ifdef CONFIG_CFG80211_WEXT
4994 struct cfg80211_ibss_params ibss;
4995 struct cfg80211_connect_params connect;
4996 struct cfg80211_cached_keys *keys;
5000 u8 prev_bssid[ETH_ALEN];
5001 u8 ssid[IEEE80211_MAX_SSID_LEN];
5002 s8 default_key, default_mgmt_key;
5003 bool prev_bssid_valid;
5007 struct cfg80211_cqm_config *cqm_config;
5009 struct list_head pmsr_list;
5010 spinlock_t pmsr_lock;
5011 struct work_struct pmsr_free_wk;
5014 static inline u8 *wdev_address(struct wireless_dev *wdev)
5017 return wdev->netdev->dev_addr;
5018 return wdev->address;
5021 static inline bool wdev_running(struct wireless_dev *wdev)
5024 return netif_running(wdev->netdev);
5025 return wdev->is_running;
5029 * wdev_priv - return wiphy priv from wireless_dev
5031 * @wdev: The wireless device whose wiphy's priv pointer to return
5032 * Return: The wiphy priv of @wdev.
5034 static inline void *wdev_priv(struct wireless_dev *wdev)
5037 return wiphy_priv(wdev->wiphy);
5041 * DOC: Utility functions
5043 * cfg80211 offers a number of utility functions that can be useful.
5047 * ieee80211_channel_to_frequency - convert channel number to frequency
5048 * @chan: channel number
5049 * @band: band, necessary due to channel number overlap
5050 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5052 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
5055 * ieee80211_frequency_to_channel - convert frequency to channel number
5056 * @freq: center frequency
5057 * Return: The corresponding channel, or 0 if the conversion failed.
5059 int ieee80211_frequency_to_channel(int freq);
5062 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5064 * @wiphy: the struct wiphy to get the channel for
5065 * @freq: the center frequency of the channel
5067 * Return: The channel struct from @wiphy at @freq.
5069 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
5072 * ieee80211_get_response_rate - get basic rate for a given rate
5074 * @sband: the band to look for rates in
5075 * @basic_rates: bitmap of basic rates
5076 * @bitrate: the bitrate for which to find the basic rate
5078 * Return: The basic rate corresponding to a given bitrate, that
5079 * is the next lower bitrate contained in the basic rate map,
5080 * which is, for this function, given as a bitmap of indices of
5081 * rates in the band's bitrate table.
5083 struct ieee80211_rate *
5084 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5085 u32 basic_rates, int bitrate);
5088 * ieee80211_mandatory_rates - get mandatory rates for a given band
5089 * @sband: the band to look for rates in
5090 * @scan_width: width of the control channel
5092 * This function returns a bitmap of the mandatory rates for the given
5093 * band, bits are set according to the rate position in the bitrates array.
5095 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5096 enum nl80211_bss_scan_width scan_width);
5099 * Radiotap parsing functions -- for controlled injection support
5101 * Implemented in net/wireless/radiotap.c
5102 * Documentation in Documentation/networking/radiotap-headers.txt
5105 struct radiotap_align_size {
5106 uint8_t align:4, size:4;
5109 struct ieee80211_radiotap_namespace {
5110 const struct radiotap_align_size *align_size;
5116 struct ieee80211_radiotap_vendor_namespaces {
5117 const struct ieee80211_radiotap_namespace *ns;
5122 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5123 * @this_arg_index: index of current arg, valid after each successful call
5124 * to ieee80211_radiotap_iterator_next()
5125 * @this_arg: pointer to current radiotap arg; it is valid after each
5126 * call to ieee80211_radiotap_iterator_next() but also after
5127 * ieee80211_radiotap_iterator_init() where it will point to
5128 * the beginning of the actual data portion
5129 * @this_arg_size: length of the current arg, for convenience
5130 * @current_namespace: pointer to the current namespace definition
5131 * (or internally %NULL if the current namespace is unknown)
5132 * @is_radiotap_ns: indicates whether the current namespace is the default
5133 * radiotap namespace or not
5135 * @_rtheader: pointer to the radiotap header we are walking through
5136 * @_max_length: length of radiotap header in cpu byte ordering
5137 * @_arg_index: next argument index
5138 * @_arg: next argument pointer
5139 * @_next_bitmap: internal pointer to next present u32
5140 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5141 * @_vns: vendor namespace definitions
5142 * @_next_ns_data: beginning of the next namespace's data
5143 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5146 * Describes the radiotap parser state. Fields prefixed with an underscore
5147 * must not be used by users of the parser, only by the parser internally.
5150 struct ieee80211_radiotap_iterator {
5151 struct ieee80211_radiotap_header *_rtheader;
5152 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5153 const struct ieee80211_radiotap_namespace *current_namespace;
5155 unsigned char *_arg, *_next_ns_data;
5156 __le32 *_next_bitmap;
5158 unsigned char *this_arg;
5166 uint32_t _bitmap_shifter;
5171 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5172 struct ieee80211_radiotap_header *radiotap_header,
5174 const struct ieee80211_radiotap_vendor_namespaces *vns);
5177 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5180 extern const unsigned char rfc1042_header[6];
5181 extern const unsigned char bridge_tunnel_header[6];
5184 * ieee80211_get_hdrlen_from_skb - get header length from data
5188 * Given an skb with a raw 802.11 header at the data pointer this function
5189 * returns the 802.11 header length.
5191 * Return: The 802.11 header length in bytes (not including encryption
5192 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5195 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5198 * ieee80211_hdrlen - get header length in bytes from frame control
5199 * @fc: frame control field in little-endian format
5200 * Return: The header length in bytes.
5202 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5205 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5206 * @meshhdr: the mesh extension header, only the flags field
5207 * (first byte) will be accessed
5208 * Return: The length of the extension header, which is always at
5209 * least 6 bytes and at most 18 if address 5 and 6 are present.
5211 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5214 * DOC: Data path helpers
5216 * In addition to generic utilities, cfg80211 also offers
5217 * functions that help implement the data path for devices
5218 * that do not do the 802.11/802.3 conversion on the device.
5222 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5223 * @skb: the 802.11 data frame
5224 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5225 * of it being pushed into the SKB
5226 * @addr: the device MAC address
5227 * @iftype: the virtual interface type
5228 * @data_offset: offset of payload after the 802.11 header
5229 * Return: 0 on success. Non-zero on error.
5231 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5232 const u8 *addr, enum nl80211_iftype iftype,
5236 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5237 * @skb: the 802.11 data frame
5238 * @addr: the device MAC address
5239 * @iftype: the virtual interface type
5240 * Return: 0 on success. Non-zero on error.
5242 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5243 enum nl80211_iftype iftype)
5245 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5249 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5251 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5252 * The @list will be empty if the decode fails. The @skb must be fully
5253 * header-less before being passed in here; it is freed in this function.
5255 * @skb: The input A-MSDU frame without any headers.
5256 * @list: The output list of 802.3 frames. It must be allocated and
5257 * initialized by by the caller.
5258 * @addr: The device MAC address.
5259 * @iftype: The device interface type.
5260 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5261 * @check_da: DA to check in the inner ethernet header, or NULL
5262 * @check_sa: SA to check in the inner ethernet header, or NULL
5264 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5265 const u8 *addr, enum nl80211_iftype iftype,
5266 const unsigned int extra_headroom,
5267 const u8 *check_da, const u8 *check_sa);
5270 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5271 * @skb: the data frame
5272 * @qos_map: Interworking QoS mapping or %NULL if not in use
5273 * Return: The 802.1p/1d tag.
5275 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5276 struct cfg80211_qos_map *qos_map);
5279 * cfg80211_find_elem_match - match information element and byte array in data
5282 * @ies: data consisting of IEs
5283 * @len: length of data
5284 * @match: byte array to match
5285 * @match_len: number of bytes in the match array
5286 * @match_offset: offset in the IE data where the byte array should match.
5287 * Note the difference to cfg80211_find_ie_match() which considers
5288 * the offset to start from the element ID byte, but here we take
5289 * the data portion instead.
5291 * Return: %NULL if the element ID could not be found or if
5292 * the element is invalid (claims to be longer than the given
5293 * data) or if the byte array doesn't match; otherwise return the
5294 * requested element struct.
5296 * Note: There are no checks on the element length other than
5297 * having to fit into the given data and being large enough for the
5298 * byte array to match.
5300 const struct element *
5301 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5302 const u8 *match, unsigned int match_len,
5303 unsigned int match_offset);
5306 * cfg80211_find_ie_match - match information element and byte array in data
5309 * @ies: data consisting of IEs
5310 * @len: length of data
5311 * @match: byte array to match
5312 * @match_len: number of bytes in the match array
5313 * @match_offset: offset in the IE where the byte array should match.
5314 * If match_len is zero, this must also be set to zero.
5315 * Otherwise this must be set to 2 or more, because the first
5316 * byte is the element id, which is already compared to eid, and
5317 * the second byte is the IE length.
5319 * Return: %NULL if the element ID could not be found or if
5320 * the element is invalid (claims to be longer than the given
5321 * data) or if the byte array doesn't match, or a pointer to the first
5322 * byte of the requested element, that is the byte containing the
5325 * Note: There are no checks on the element length other than
5326 * having to fit into the given data and being large enough for the
5327 * byte array to match.
5329 static inline const u8 *
5330 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5331 const u8 *match, unsigned int match_len,
5332 unsigned int match_offset)
5334 /* match_offset can't be smaller than 2, unless match_len is
5335 * zero, in which case match_offset must be zero as well.
5337 if (WARN_ON((match_len && match_offset < 2) ||
5338 (!match_len && match_offset)))
5341 return (void *)cfg80211_find_elem_match(eid, ies, len,
5344 match_offset - 2 : 0);
5348 * cfg80211_find_elem - find information element in data
5351 * @ies: data consisting of IEs
5352 * @len: length of data
5354 * Return: %NULL if the element ID could not be found or if
5355 * the element is invalid (claims to be longer than the given
5356 * data) or if the byte array doesn't match; otherwise return the
5357 * requested element struct.
5359 * Note: There are no checks on the element length other than
5360 * having to fit into the given data.
5362 static inline const struct element *
5363 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5365 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5369 * cfg80211_find_ie - find information element in data
5372 * @ies: data consisting of IEs
5373 * @len: length of data
5375 * Return: %NULL if the element ID could not be found or if
5376 * the element is invalid (claims to be longer than the given
5377 * data), or a pointer to the first byte of the requested
5378 * element, that is the byte containing the element ID.
5380 * Note: There are no checks on the element length other than
5381 * having to fit into the given data.
5383 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5385 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5389 * cfg80211_find_ext_elem - find information element with EID Extension in data
5391 * @ext_eid: element ID Extension
5392 * @ies: data consisting of IEs
5393 * @len: length of data
5395 * Return: %NULL if the etended element could not be found or if
5396 * the element is invalid (claims to be longer than the given
5397 * data) or if the byte array doesn't match; otherwise return the
5398 * requested element struct.
5400 * Note: There are no checks on the element length other than
5401 * having to fit into the given data.
5403 static inline const struct element *
5404 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5406 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5411 * cfg80211_find_ext_ie - find information element with EID Extension in data
5413 * @ext_eid: element ID Extension
5414 * @ies: data consisting of IEs
5415 * @len: length of data
5417 * Return: %NULL if the extended element ID could not be found or if
5418 * the element is invalid (claims to be longer than the given
5419 * data), or a pointer to the first byte of the requested
5420 * element, that is the byte containing the element ID.
5422 * Note: There are no checks on the element length other than
5423 * having to fit into the given data.
5425 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5427 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5432 * cfg80211_find_vendor_elem - find vendor specific information element in data
5435 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5436 * @ies: data consisting of IEs
5437 * @len: length of data
5439 * Return: %NULL if the vendor specific element ID could not be found or if the
5440 * element is invalid (claims to be longer than the given data); otherwise
5441 * return the element structure for the requested element.
5443 * Note: There are no checks on the element length other than having to fit into
5446 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5451 * cfg80211_find_vendor_ie - find vendor specific information element in data
5454 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5455 * @ies: data consisting of IEs
5456 * @len: length of data
5458 * Return: %NULL if the vendor specific element ID could not be found or if the
5459 * element is invalid (claims to be longer than the given data), or a pointer to
5460 * the first byte of the requested element, that is the byte containing the
5463 * Note: There are no checks on the element length other than having to fit into
5466 static inline const u8 *
5467 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5468 const u8 *ies, unsigned int len)
5470 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5474 * cfg80211_send_layer2_update - send layer 2 update frame
5476 * @dev: network device
5477 * @addr: STA MAC address
5479 * Wireless drivers can use this function to update forwarding tables in bridge
5480 * devices upon STA association.
5482 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5485 * DOC: Regulatory enforcement infrastructure
5491 * regulatory_hint - driver hint to the wireless core a regulatory domain
5492 * @wiphy: the wireless device giving the hint (used only for reporting
5494 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5495 * should be in. If @rd is set this should be NULL. Note that if you
5496 * set this to NULL you should still set rd->alpha2 to some accepted
5499 * Wireless drivers can use this function to hint to the wireless core
5500 * what it believes should be the current regulatory domain by
5501 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5502 * domain should be in or by providing a completely build regulatory domain.
5503 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5504 * for a regulatory domain structure for the respective country.
5506 * The wiphy must have been registered to cfg80211 prior to this call.
5507 * For cfg80211 drivers this means you must first use wiphy_register(),
5508 * for mac80211 drivers you must first use ieee80211_register_hw().
5510 * Drivers should check the return value, its possible you can get
5513 * Return: 0 on success. -ENOMEM.
5515 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5518 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5519 * @wiphy: the wireless device we want to process the regulatory domain on
5520 * @rd: the regulatory domain informatoin to use for this wiphy
5522 * Set the regulatory domain information for self-managed wiphys, only they
5523 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5526 * Return: 0 on success. -EINVAL, -EPERM
5528 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5529 struct ieee80211_regdomain *rd);
5532 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5533 * @wiphy: the wireless device we want to process the regulatory domain on
5534 * @rd: the regulatory domain information to use for this wiphy
5536 * This functions requires the RTNL to be held and applies the new regdomain
5537 * synchronously to this wiphy. For more details see
5538 * regulatory_set_wiphy_regd().
5540 * Return: 0 on success. -EINVAL, -EPERM
5542 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5543 struct ieee80211_regdomain *rd);
5546 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5547 * @wiphy: the wireless device we want to process the regulatory domain on
5548 * @regd: the custom regulatory domain to use for this wiphy
5550 * Drivers can sometimes have custom regulatory domains which do not apply
5551 * to a specific country. Drivers can use this to apply such custom regulatory
5552 * domains. This routine must be called prior to wiphy registration. The
5553 * custom regulatory domain will be trusted completely and as such previous
5554 * default channel settings will be disregarded. If no rule is found for a
5555 * channel on the regulatory domain the channel will be disabled.
5556 * Drivers using this for a wiphy should also set the wiphy flag
5557 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5558 * that called this helper.
5560 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5561 const struct ieee80211_regdomain *regd);
5564 * freq_reg_info - get regulatory information for the given frequency
5565 * @wiphy: the wiphy for which we want to process this rule for
5566 * @center_freq: Frequency in KHz for which we want regulatory information for
5568 * Use this function to get the regulatory rule for a specific frequency on
5569 * a given wireless device. If the device has a specific regulatory domain
5570 * it wants to follow we respect that unless a country IE has been received
5571 * and processed already.
5573 * Return: A valid pointer, or, when an error occurs, for example if no rule
5574 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5575 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5576 * value will be -ERANGE if we determine the given center_freq does not even
5577 * have a regulatory rule for a frequency range in the center_freq's band.
5578 * See freq_in_rule_band() for our current definition of a band -- this is
5579 * purely subjective and right now it's 802.11 specific.
5581 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5585 * reg_initiator_name - map regulatory request initiator enum to name
5586 * @initiator: the regulatory request initiator
5588 * You can use this to map the regulatory request initiator enum to a
5589 * proper string representation.
5591 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5594 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
5595 * @wiphy: wiphy for which pre-CAC capability is checked.
5597 * Pre-CAC is allowed only in some regdomains (notable ETSI).
5599 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
5602 * DOC: Internal regulatory db functions
5607 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
5608 * Regulatory self-managed driver can use it to proactively
5610 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5611 * @freq: the freqency(in MHz) to be queried.
5612 * @rule: pointer to store the wmm rule from the regulatory db.
5614 * Self-managed wireless drivers can use this function to query
5615 * the internal regulatory database to check whether the given
5616 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5618 * Drivers should check the return value, its possible you can get
5621 * Return: 0 on success. -ENODATA.
5623 int reg_query_regdb_wmm(char *alpha2, int freq,
5624 struct ieee80211_reg_rule *rule);
5627 * callbacks for asynchronous cfg80211 methods, notification
5628 * functions and BSS handling helpers
5632 * cfg80211_scan_done - notify that scan finished
5634 * @request: the corresponding scan request
5635 * @info: information about the completed scan
5637 void cfg80211_scan_done(struct cfg80211_scan_request *request,
5638 struct cfg80211_scan_info *info);
5641 * cfg80211_sched_scan_results - notify that new scan results are available
5643 * @wiphy: the wiphy which got scheduled scan results
5644 * @reqid: identifier for the related scheduled scan request
5646 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
5649 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5651 * @wiphy: the wiphy on which the scheduled scan stopped
5652 * @reqid: identifier for the related scheduled scan request
5654 * The driver can call this function to inform cfg80211 that the
5655 * scheduled scan had to be stopped, for whatever reason. The driver
5656 * is then called back via the sched_scan_stop operation when done.
5658 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
5661 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5663 * @wiphy: the wiphy on which the scheduled scan stopped
5664 * @reqid: identifier for the related scheduled scan request
5666 * The driver can call this function to inform cfg80211 that the
5667 * scheduled scan had to be stopped, for whatever reason. The driver
5668 * is then called back via the sched_scan_stop operation when done.
5669 * This function should be called with rtnl locked.
5671 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
5674 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5675 * @wiphy: the wiphy reporting the BSS
5676 * @data: the BSS metadata
5677 * @mgmt: the management frame (probe response or beacon)
5678 * @len: length of the management frame
5679 * @gfp: context flags
5681 * This informs cfg80211 that BSS information was found and
5682 * the BSS should be updated/added.
5684 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5685 * Or %NULL on error.
5687 struct cfg80211_bss * __must_check
5688 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
5689 struct cfg80211_inform_bss *data,
5690 struct ieee80211_mgmt *mgmt, size_t len,
5693 static inline struct cfg80211_bss * __must_check
5694 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
5695 struct ieee80211_channel *rx_channel,
5696 enum nl80211_bss_scan_width scan_width,
5697 struct ieee80211_mgmt *mgmt, size_t len,
5698 s32 signal, gfp_t gfp)
5700 struct cfg80211_inform_bss data = {
5702 .scan_width = scan_width,
5706 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5709 static inline struct cfg80211_bss * __must_check
5710 cfg80211_inform_bss_frame(struct wiphy *wiphy,
5711 struct ieee80211_channel *rx_channel,
5712 struct ieee80211_mgmt *mgmt, size_t len,
5713 s32 signal, gfp_t gfp)
5715 struct cfg80211_inform_bss data = {
5717 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5721 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5725 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5726 * @bssid: transmitter BSSID
5727 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5728 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5729 * @new_bssid: calculated nontransmitted BSSID
5731 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
5732 u8 mbssid_index, u8 *new_bssid)
5734 u64 bssid_u64 = ether_addr_to_u64(bssid);
5735 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
5738 new_bssid_u64 = bssid_u64 & ~mask;
5740 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
5742 u64_to_ether_addr(new_bssid_u64, new_bssid);
5746 * cfg80211_is_element_inherited - returns if element ID should be inherited
5747 * @element: element to check
5748 * @non_inherit_element: non inheritance element
5750 bool cfg80211_is_element_inherited(const struct element *element,
5751 const struct element *non_inherit_element);
5754 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
5756 * @ielen: length of IEs
5757 * @mbssid_elem: current MBSSID element
5758 * @sub_elem: current MBSSID subelement (profile)
5759 * @merged_ie: location of the merged profile
5760 * @max_copy_len: max merged profile length
5762 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
5763 const struct element *mbssid_elem,
5764 const struct element *sub_elem,
5765 u8 *merged_ie, size_t max_copy_len);
5768 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
5769 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
5770 * from a beacon or probe response
5771 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
5772 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
5774 enum cfg80211_bss_frame_type {
5775 CFG80211_BSS_FTYPE_UNKNOWN,
5776 CFG80211_BSS_FTYPE_BEACON,
5777 CFG80211_BSS_FTYPE_PRESP,
5781 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
5783 * @wiphy: the wiphy reporting the BSS
5784 * @data: the BSS metadata
5785 * @ftype: frame type (if known)
5786 * @bssid: the BSSID of the BSS
5787 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5788 * @capability: the capability field sent by the peer
5789 * @beacon_interval: the beacon interval announced by the peer
5790 * @ie: additional IEs sent by the peer
5791 * @ielen: length of the additional IEs
5792 * @gfp: context flags
5794 * This informs cfg80211 that BSS information was found and
5795 * the BSS should be updated/added.
5797 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5798 * Or %NULL on error.
5800 struct cfg80211_bss * __must_check
5801 cfg80211_inform_bss_data(struct wiphy *wiphy,
5802 struct cfg80211_inform_bss *data,
5803 enum cfg80211_bss_frame_type ftype,
5804 const u8 *bssid, u64 tsf, u16 capability,
5805 u16 beacon_interval, const u8 *ie, size_t ielen,
5808 static inline struct cfg80211_bss * __must_check
5809 cfg80211_inform_bss_width(struct wiphy *wiphy,
5810 struct ieee80211_channel *rx_channel,
5811 enum nl80211_bss_scan_width scan_width,
5812 enum cfg80211_bss_frame_type ftype,
5813 const u8 *bssid, u64 tsf, u16 capability,
5814 u16 beacon_interval, const u8 *ie, size_t ielen,
5815 s32 signal, gfp_t gfp)
5817 struct cfg80211_inform_bss data = {
5819 .scan_width = scan_width,
5823 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5824 capability, beacon_interval, ie, ielen,
5828 static inline struct cfg80211_bss * __must_check
5829 cfg80211_inform_bss(struct wiphy *wiphy,
5830 struct ieee80211_channel *rx_channel,
5831 enum cfg80211_bss_frame_type ftype,
5832 const u8 *bssid, u64 tsf, u16 capability,
5833 u16 beacon_interval, const u8 *ie, size_t ielen,
5834 s32 signal, gfp_t gfp)
5836 struct cfg80211_inform_bss data = {
5838 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5842 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5843 capability, beacon_interval, ie, ielen,
5848 * cfg80211_get_bss - get a BSS reference
5849 * @wiphy: the wiphy this BSS struct belongs to
5850 * @channel: the channel to search on (or %NULL)
5851 * @bssid: the desired BSSID (or %NULL)
5852 * @ssid: the desired SSID (or %NULL)
5853 * @ssid_len: length of the SSID (or 0)
5854 * @bss_type: type of BSS, see &enum ieee80211_bss_type
5855 * @privacy: privacy filter, see &enum ieee80211_privacy
5857 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
5858 struct ieee80211_channel *channel,
5860 const u8 *ssid, size_t ssid_len,
5861 enum ieee80211_bss_type bss_type,
5862 enum ieee80211_privacy privacy);
5863 static inline struct cfg80211_bss *
5864 cfg80211_get_ibss(struct wiphy *wiphy,
5865 struct ieee80211_channel *channel,
5866 const u8 *ssid, size_t ssid_len)
5868 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
5869 IEEE80211_BSS_TYPE_IBSS,
5870 IEEE80211_PRIVACY_ANY);
5874 * cfg80211_ref_bss - reference BSS struct
5875 * @wiphy: the wiphy this BSS struct belongs to
5876 * @bss: the BSS struct to reference
5878 * Increments the refcount of the given BSS struct.
5880 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5883 * cfg80211_put_bss - unref BSS struct
5884 * @wiphy: the wiphy this BSS struct belongs to
5885 * @bss: the BSS struct
5887 * Decrements the refcount of the given BSS struct.
5889 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5892 * cfg80211_unlink_bss - unlink BSS from internal data structures
5894 * @bss: the bss to remove
5896 * This function removes the given BSS from the internal data structures
5897 * thereby making it no longer show up in scan results etc. Use this
5898 * function when you detect a BSS is gone. Normally BSSes will also time
5899 * out, so it is not necessary to use this function at all.
5901 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5904 * cfg80211_bss_iter - iterate all BSS entries
5906 * This function iterates over the BSS entries associated with the given wiphy
5907 * and calls the callback for the iterated BSS. The iterator function is not
5908 * allowed to call functions that might modify the internal state of the BSS DB.
5911 * @chandef: if given, the iterator function will be called only if the channel
5912 * of the currently iterated BSS is a subset of the given channel.
5913 * @iter: the iterator function to call
5914 * @iter_data: an argument to the iterator function
5916 void cfg80211_bss_iter(struct wiphy *wiphy,
5917 struct cfg80211_chan_def *chandef,
5918 void (*iter)(struct wiphy *wiphy,
5919 struct cfg80211_bss *bss,
5923 static inline enum nl80211_bss_scan_width
5924 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5926 switch (chandef->width) {
5927 case NL80211_CHAN_WIDTH_5:
5928 return NL80211_BSS_CHAN_WIDTH_5;
5929 case NL80211_CHAN_WIDTH_10:
5930 return NL80211_BSS_CHAN_WIDTH_10;
5932 return NL80211_BSS_CHAN_WIDTH_20;
5937 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5938 * @dev: network device
5939 * @buf: authentication frame (header + body)
5940 * @len: length of the frame data
5942 * This function is called whenever an authentication, disassociation or
5943 * deauthentication frame has been received and processed in station mode.
5944 * After being asked to authenticate via cfg80211_ops::auth() the driver must
5945 * call either this function or cfg80211_auth_timeout().
5946 * After being asked to associate via cfg80211_ops::assoc() the driver must
5947 * call either this function or cfg80211_auth_timeout().
5948 * While connected, the driver must calls this for received and processed
5949 * disassociation and deauthentication frames. If the frame couldn't be used
5950 * because it was unprotected, the driver must call the function
5951 * cfg80211_rx_unprot_mlme_mgmt() instead.
5953 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5955 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5958 * cfg80211_auth_timeout - notification of timed out authentication
5959 * @dev: network device
5960 * @addr: The MAC address of the device with which the authentication timed out
5962 * This function may sleep. The caller must hold the corresponding wdev's
5965 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
5968 * cfg80211_rx_assoc_resp - notification of processed association response
5969 * @dev: network device
5970 * @bss: the BSS that association was requested with, ownership of the pointer
5971 * moves to cfg80211 in this call
5972 * @buf: (Re)Association Response frame (header + body)
5973 * @len: length of the frame data
5974 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5975 * as the AC bitmap in the QoS info field
5976 * @req_ies: information elements from the (Re)Association Request frame
5977 * @req_ies_len: length of req_ies data
5979 * After being asked to associate via cfg80211_ops::assoc() the driver must
5980 * call either this function or cfg80211_auth_timeout().
5982 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5984 void cfg80211_rx_assoc_resp(struct net_device *dev,
5985 struct cfg80211_bss *bss,
5986 const u8 *buf, size_t len,
5988 const u8 *req_ies, size_t req_ies_len);
5991 * cfg80211_assoc_timeout - notification of timed out association
5992 * @dev: network device
5993 * @bss: The BSS entry with which association timed out.
5995 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5997 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6000 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6001 * @dev: network device
6002 * @bss: The BSS entry with which association was abandoned.
6004 * Call this whenever - for reasons reported through other API, like deauth RX,
6005 * an association attempt was abandoned.
6006 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6008 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6011 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6012 * @dev: network device
6013 * @buf: 802.11 frame (header + body)
6014 * @len: length of the frame data
6016 * This function is called whenever deauthentication has been processed in
6017 * station mode. This includes both received deauthentication frames and
6018 * locally generated ones. This function may sleep. The caller must hold the
6019 * corresponding wdev's mutex.
6021 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6024 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6025 * @dev: network device
6026 * @buf: deauthentication frame (header + body)
6027 * @len: length of the frame data
6029 * This function is called whenever a received deauthentication or dissassoc
6030 * frame has been dropped in station mode because of MFP being used but the
6031 * frame was not protected. This function may sleep.
6033 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6034 const u8 *buf, size_t len);
6037 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6038 * @dev: network device
6039 * @addr: The source MAC address of the frame
6040 * @key_type: The key type that the received frame used
6041 * @key_id: Key identifier (0..3). Can be -1 if missing.
6042 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6043 * @gfp: allocation flags
6045 * This function is called whenever the local MAC detects a MIC failure in a
6046 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6049 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6050 enum nl80211_key_type key_type, int key_id,
6051 const u8 *tsc, gfp_t gfp);
6054 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6056 * @dev: network device
6057 * @bssid: the BSSID of the IBSS joined
6058 * @channel: the channel of the IBSS joined
6059 * @gfp: allocation flags
6061 * This function notifies cfg80211 that the device joined an IBSS or
6062 * switched to a different BSSID. Before this function can be called,
6063 * either a beacon has to have been received from the IBSS, or one of
6064 * the cfg80211_inform_bss{,_frame} functions must have been called
6065 * with the locally generated beacon -- this guarantees that there is
6066 * always a scan result for this IBSS. cfg80211 will handle the rest.
6068 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6069 struct ieee80211_channel *channel, gfp_t gfp);
6072 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
6074 * @dev: network device
6075 * @macaddr: the MAC address of the new candidate
6076 * @ie: information elements advertised by the peer candidate
6077 * @ie_len: length of the information elements buffer
6078 * @gfp: allocation flags
6080 * This function notifies cfg80211 that the mesh peer candidate has been
6081 * detected, most likely via a beacon or, less likely, via a probe response.
6082 * cfg80211 then sends a notification to userspace.
6084 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6085 const u8 *macaddr, const u8 *ie, u8 ie_len,
6086 int sig_dbm, gfp_t gfp);
6089 * DOC: RFkill integration
6091 * RFkill integration in cfg80211 is almost invisible to drivers,
6092 * as cfg80211 automatically registers an rfkill instance for each
6093 * wireless device it knows about. Soft kill is also translated
6094 * into disconnecting and turning all interfaces off, drivers are
6095 * expected to turn off the device when all interfaces are down.
6097 * However, devices may have a hard RFkill line, in which case they
6098 * also need to interact with the rfkill subsystem, via cfg80211.
6099 * They can do this with a few helper functions documented here.
6103 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6105 * @blocked: block status
6107 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
6110 * wiphy_rfkill_start_polling - start polling rfkill
6113 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6116 * wiphy_rfkill_stop_polling - stop polling rfkill
6119 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
6122 * DOC: Vendor commands
6124 * Occasionally, there are special protocol or firmware features that
6125 * can't be implemented very openly. For this and similar cases, the
6126 * vendor command functionality allows implementing the features with
6127 * (typically closed-source) userspace and firmware, using nl80211 as
6128 * the configuration mechanism.
6130 * A driver supporting vendor commands must register them as an array
6131 * in struct wiphy, with handlers for each one, each command has an
6132 * OUI and sub command ID to identify it.
6134 * Note that this feature should not be (ab)used to implement protocol
6135 * features that could openly be shared across drivers. In particular,
6136 * it must never be required to use vendor commands to implement any
6137 * "normal" functionality that higher-level userspace like connection
6138 * managers etc. need.
6141 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6142 enum nl80211_commands cmd,
6143 enum nl80211_attrs attr,
6146 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6147 struct wireless_dev *wdev,
6148 enum nl80211_commands cmd,
6149 enum nl80211_attrs attr,
6150 unsigned int portid,
6151 int vendor_event_idx,
6152 int approxlen, gfp_t gfp);
6154 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6157 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6159 * @approxlen: an upper bound of the length of the data that will
6160 * be put into the skb
6162 * This function allocates and pre-fills an skb for a reply to
6163 * a vendor command. Since it is intended for a reply, calling
6164 * it outside of a vendor command's doit() operation is invalid.
6166 * The returned skb is pre-filled with some identifying data in
6167 * a way that any data that is put into the skb (with skb_put(),
6168 * nla_put() or similar) will end up being within the
6169 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6170 * with the skb is adding data for the corresponding userspace tool
6171 * which can then read that data out of the vendor data attribute.
6172 * You must not modify the skb in any other way.
6174 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6175 * its error code as the result of the doit() operation.
6177 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6179 static inline struct sk_buff *
6180 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6182 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6183 NL80211_ATTR_VENDOR_DATA, approxlen);
6187 * cfg80211_vendor_cmd_reply - send the reply skb
6188 * @skb: The skb, must have been allocated with
6189 * cfg80211_vendor_cmd_alloc_reply_skb()
6191 * Since calling this function will usually be the last thing
6192 * before returning from the vendor command doit() you should
6193 * return the error code. Note that this function consumes the
6194 * skb regardless of the return value.
6196 * Return: An error code or 0 on success.
6198 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6201 * cfg80211_vendor_cmd_get_sender
6204 * Return the current netlink port ID in a vendor command handler.
6205 * Valid to call only there.
6207 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6210 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6212 * @wdev: the wireless device
6213 * @event_idx: index of the vendor event in the wiphy's vendor_events
6214 * @approxlen: an upper bound of the length of the data that will
6215 * be put into the skb
6216 * @gfp: allocation flags
6218 * This function allocates and pre-fills an skb for an event on the
6219 * vendor-specific multicast group.
6221 * If wdev != NULL, both the ifindex and identifier of the specified
6222 * wireless device are added to the event message before the vendor data
6225 * When done filling the skb, call cfg80211_vendor_event() with the
6226 * skb to send the event.
6228 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6230 static inline struct sk_buff *
6231 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6232 int approxlen, int event_idx, gfp_t gfp)
6234 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6235 NL80211_ATTR_VENDOR_DATA,
6236 0, event_idx, approxlen, gfp);
6240 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6242 * @wdev: the wireless device
6243 * @event_idx: index of the vendor event in the wiphy's vendor_events
6244 * @portid: port ID of the receiver
6245 * @approxlen: an upper bound of the length of the data that will
6246 * be put into the skb
6247 * @gfp: allocation flags
6249 * This function allocates and pre-fills an skb for an event to send to
6250 * a specific (userland) socket. This socket would previously have been
6251 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6252 * care to register a netlink notifier to see when the socket closes.
6254 * If wdev != NULL, both the ifindex and identifier of the specified
6255 * wireless device are added to the event message before the vendor data
6258 * When done filling the skb, call cfg80211_vendor_event() with the
6259 * skb to send the event.
6261 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6263 static inline struct sk_buff *
6264 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6265 struct wireless_dev *wdev,
6266 unsigned int portid, int approxlen,
6267 int event_idx, gfp_t gfp)
6269 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6270 NL80211_ATTR_VENDOR_DATA,
6271 portid, event_idx, approxlen, gfp);
6275 * cfg80211_vendor_event - send the event
6276 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6277 * @gfp: allocation flags
6279 * This function sends the given @skb, which must have been allocated
6280 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6282 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6284 __cfg80211_send_event_skb(skb, gfp);
6287 #ifdef CONFIG_NL80211_TESTMODE
6291 * Test mode is a set of utility functions to allow drivers to
6292 * interact with driver-specific tools to aid, for instance,
6293 * factory programming.
6295 * This chapter describes how drivers interact with it, for more
6296 * information see the nl80211 book's chapter on it.
6300 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6302 * @approxlen: an upper bound of the length of the data that will
6303 * be put into the skb
6305 * This function allocates and pre-fills an skb for a reply to
6306 * the testmode command. Since it is intended for a reply, calling
6307 * it outside of the @testmode_cmd operation is invalid.
6309 * The returned skb is pre-filled with the wiphy index and set up in
6310 * a way that any data that is put into the skb (with skb_put(),
6311 * nla_put() or similar) will end up being within the
6312 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6313 * with the skb is adding data for the corresponding userspace tool
6314 * which can then read that data out of the testdata attribute. You
6315 * must not modify the skb in any other way.
6317 * When done, call cfg80211_testmode_reply() with the skb and return
6318 * its error code as the result of the @testmode_cmd operation.
6320 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6322 static inline struct sk_buff *
6323 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6325 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6326 NL80211_ATTR_TESTDATA, approxlen);
6330 * cfg80211_testmode_reply - send the reply skb
6331 * @skb: The skb, must have been allocated with
6332 * cfg80211_testmode_alloc_reply_skb()
6334 * Since calling this function will usually be the last thing
6335 * before returning from the @testmode_cmd you should return
6336 * the error code. Note that this function consumes the skb
6337 * regardless of the return value.
6339 * Return: An error code or 0 on success.
6341 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6343 return cfg80211_vendor_cmd_reply(skb);
6347 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6349 * @approxlen: an upper bound of the length of the data that will
6350 * be put into the skb
6351 * @gfp: allocation flags
6353 * This function allocates and pre-fills an skb for an event on the
6354 * testmode multicast group.
6356 * The returned skb is set up in the same way as with
6357 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6358 * there, you should simply add data to it that will then end up in the
6359 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6362 * When done filling the skb, call cfg80211_testmode_event() with the
6363 * skb to send the event.
6365 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6367 static inline struct sk_buff *
6368 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6370 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6371 NL80211_ATTR_TESTDATA, 0, -1,
6376 * cfg80211_testmode_event - send the event
6377 * @skb: The skb, must have been allocated with
6378 * cfg80211_testmode_alloc_event_skb()
6379 * @gfp: allocation flags
6381 * This function sends the given @skb, which must have been allocated
6382 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6385 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6387 __cfg80211_send_event_skb(skb, gfp);
6390 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6391 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6393 #define CFG80211_TESTMODE_CMD(cmd)
6394 #define CFG80211_TESTMODE_DUMP(cmd)
6398 * struct cfg80211_fils_resp_params - FILS connection response params
6399 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6400 * @kek_len: Length of @fils_kek in octets
6401 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6402 * @erp_next_seq_num is valid.
6403 * @erp_next_seq_num: The next sequence number to use in ERP message in
6404 * FILS Authentication. This value should be specified irrespective of the
6405 * status for a FILS connection.
6406 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6407 * @pmk_len: Length of @pmk in octets
6408 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6409 * used for this FILS connection (may be %NULL).
6411 struct cfg80211_fils_resp_params {
6414 bool update_erp_next_seq_num;
6415 u16 erp_next_seq_num;
6422 * struct cfg80211_connect_resp_params - Connection response params
6423 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6424 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6425 * the real status code for failures. If this call is used to report a
6426 * failure due to a timeout (e.g., not receiving an Authentication frame
6427 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6428 * indicate that this is a failure, but without a status code.
6429 * @timeout_reason is used to report the reason for the timeout in that
6431 * @bssid: The BSSID of the AP (may be %NULL)
6432 * @bss: Entry of bss to which STA got connected to, can be obtained through
6433 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6434 * bss from the connect_request and hold a reference to it and return
6435 * through this param to avoid a warning if the bss is expired during the
6436 * connection, esp. for those drivers implementing connect op.
6437 * Only one parameter among @bssid and @bss needs to be specified.
6438 * @req_ie: Association request IEs (may be %NULL)
6439 * @req_ie_len: Association request IEs length
6440 * @resp_ie: Association response IEs (may be %NULL)
6441 * @resp_ie_len: Association response IEs length
6442 * @fils: FILS connection response parameters.
6443 * @timeout_reason: Reason for connection timeout. This is used when the
6444 * connection fails due to a timeout instead of an explicit rejection from
6445 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6446 * not known. This value is used only if @status < 0 to indicate that the
6447 * failure is due to a timeout and not due to explicit rejection by the AP.
6448 * This value is ignored in other cases (@status >= 0).
6450 struct cfg80211_connect_resp_params {
6453 struct cfg80211_bss *bss;
6458 struct cfg80211_fils_resp_params fils;
6459 enum nl80211_timeout_reason timeout_reason;
6463 * cfg80211_connect_done - notify cfg80211 of connection result
6465 * @dev: network device
6466 * @params: connection response parameters
6467 * @gfp: allocation flags
6469 * It should be called by the underlying driver once execution of the connection
6470 * request from connect() has been completed. This is similar to
6471 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6472 * parameters. Only one of the functions among cfg80211_connect_bss(),
6473 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6474 * and cfg80211_connect_done() should be called.
6476 void cfg80211_connect_done(struct net_device *dev,
6477 struct cfg80211_connect_resp_params *params,
6481 * cfg80211_connect_bss - notify cfg80211 of connection result
6483 * @dev: network device
6484 * @bssid: the BSSID of the AP
6485 * @bss: Entry of bss to which STA got connected to, can be obtained through
6486 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6487 * bss from the connect_request and hold a reference to it and return
6488 * through this param to avoid a warning if the bss is expired during the
6489 * connection, esp. for those drivers implementing connect op.
6490 * Only one parameter among @bssid and @bss needs to be specified.
6491 * @req_ie: association request IEs (maybe be %NULL)
6492 * @req_ie_len: association request IEs length
6493 * @resp_ie: association response IEs (may be %NULL)
6494 * @resp_ie_len: assoc response IEs length
6495 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6496 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6497 * the real status code for failures. If this call is used to report a
6498 * failure due to a timeout (e.g., not receiving an Authentication frame
6499 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6500 * indicate that this is a failure, but without a status code.
6501 * @timeout_reason is used to report the reason for the timeout in that
6503 * @gfp: allocation flags
6504 * @timeout_reason: reason for connection timeout. This is used when the
6505 * connection fails due to a timeout instead of an explicit rejection from
6506 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6507 * not known. This value is used only if @status < 0 to indicate that the
6508 * failure is due to a timeout and not due to explicit rejection by the AP.
6509 * This value is ignored in other cases (@status >= 0).
6511 * It should be called by the underlying driver once execution of the connection
6512 * request from connect() has been completed. This is similar to
6513 * cfg80211_connect_result(), but with the option of identifying the exact bss
6514 * entry for the connection. Only one of the functions among
6515 * cfg80211_connect_bss(), cfg80211_connect_result(),
6516 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6519 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6520 struct cfg80211_bss *bss, const u8 *req_ie,
6521 size_t req_ie_len, const u8 *resp_ie,
6522 size_t resp_ie_len, int status, gfp_t gfp,
6523 enum nl80211_timeout_reason timeout_reason)
6525 struct cfg80211_connect_resp_params params;
6527 memset(¶ms, 0, sizeof(params));
6528 params.status = status;
6529 params.bssid = bssid;
6531 params.req_ie = req_ie;
6532 params.req_ie_len = req_ie_len;
6533 params.resp_ie = resp_ie;
6534 params.resp_ie_len = resp_ie_len;
6535 params.timeout_reason = timeout_reason;
6537 cfg80211_connect_done(dev, ¶ms, gfp);
6541 * cfg80211_connect_result - notify cfg80211 of connection result
6543 * @dev: network device
6544 * @bssid: the BSSID of the AP
6545 * @req_ie: association request IEs (maybe be %NULL)
6546 * @req_ie_len: association request IEs length
6547 * @resp_ie: association response IEs (may be %NULL)
6548 * @resp_ie_len: assoc response IEs length
6549 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6550 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6551 * the real status code for failures.
6552 * @gfp: allocation flags
6554 * It should be called by the underlying driver once execution of the connection
6555 * request from connect() has been completed. This is similar to
6556 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6557 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6558 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6561 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6562 const u8 *req_ie, size_t req_ie_len,
6563 const u8 *resp_ie, size_t resp_ie_len,
6564 u16 status, gfp_t gfp)
6566 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6567 resp_ie_len, status, gfp,
6568 NL80211_TIMEOUT_UNSPECIFIED);
6572 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6574 * @dev: network device
6575 * @bssid: the BSSID of the AP
6576 * @req_ie: association request IEs (maybe be %NULL)
6577 * @req_ie_len: association request IEs length
6578 * @gfp: allocation flags
6579 * @timeout_reason: reason for connection timeout.
6581 * It should be called by the underlying driver whenever connect() has failed
6582 * in a sequence where no explicit authentication/association rejection was
6583 * received from the AP. This could happen, e.g., due to not being able to send
6584 * out the Authentication or Association Request frame or timing out while
6585 * waiting for the response. Only one of the functions among
6586 * cfg80211_connect_bss(), cfg80211_connect_result(),
6587 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6590 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6591 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6592 enum nl80211_timeout_reason timeout_reason)
6594 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6595 gfp, timeout_reason);
6599 * struct cfg80211_roam_info - driver initiated roaming information
6601 * @channel: the channel of the new AP
6602 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6603 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6604 * @req_ie: association request IEs (maybe be %NULL)
6605 * @req_ie_len: association request IEs length
6606 * @resp_ie: association response IEs (may be %NULL)
6607 * @resp_ie_len: assoc response IEs length
6608 * @fils: FILS related roaming information.
6610 struct cfg80211_roam_info {
6611 struct ieee80211_channel *channel;
6612 struct cfg80211_bss *bss;
6618 struct cfg80211_fils_resp_params fils;
6622 * cfg80211_roamed - notify cfg80211 of roaming
6624 * @dev: network device
6625 * @info: information about the new BSS. struct &cfg80211_roam_info.
6626 * @gfp: allocation flags
6628 * This function may be called with the driver passing either the BSSID of the
6629 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6630 * It should be called by the underlying driver whenever it roamed from one AP
6631 * to another while connected. Drivers which have roaming implemented in
6632 * firmware should pass the bss entry to avoid a race in bss entry timeout where
6633 * the bss entry of the new AP is seen in the driver, but gets timed out by the
6634 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6635 * rdev->event_work. In case of any failures, the reference is released
6636 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6637 * released while disconnecting from the current bss.
6639 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
6643 * cfg80211_port_authorized - notify cfg80211 of successful security association
6645 * @dev: network device
6646 * @bssid: the BSSID of the AP
6647 * @gfp: allocation flags
6649 * This function should be called by a driver that supports 4 way handshake
6650 * offload after a security association was successfully established (i.e.,
6651 * the 4 way handshake was completed successfully). The call to this function
6652 * should be preceded with a call to cfg80211_connect_result(),
6653 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6654 * indicate the 802.11 association.
6656 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
6660 * cfg80211_disconnected - notify cfg80211 that connection was dropped
6662 * @dev: network device
6663 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6664 * @ie_len: length of IEs
6665 * @reason: reason code for the disconnection, set it to 0 if unknown
6666 * @locally_generated: disconnection was requested locally
6667 * @gfp: allocation flags
6669 * After it calls this function, the driver should enter an idle state
6670 * and not try to connect to any AP any more.
6672 void cfg80211_disconnected(struct net_device *dev, u16 reason,
6673 const u8 *ie, size_t ie_len,
6674 bool locally_generated, gfp_t gfp);
6677 * cfg80211_ready_on_channel - notification of remain_on_channel start
6678 * @wdev: wireless device
6679 * @cookie: the request cookie
6680 * @chan: The current channel (from remain_on_channel request)
6681 * @duration: Duration in milliseconds that the driver intents to remain on the
6683 * @gfp: allocation flags
6685 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
6686 struct ieee80211_channel *chan,
6687 unsigned int duration, gfp_t gfp);
6690 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6691 * @wdev: wireless device
6692 * @cookie: the request cookie
6693 * @chan: The current channel (from remain_on_channel request)
6694 * @gfp: allocation flags
6696 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
6697 struct ieee80211_channel *chan,
6701 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
6702 * @wdev: wireless device
6703 * @cookie: the requested cookie
6704 * @chan: The current channel (from tx_mgmt request)
6705 * @gfp: allocation flags
6707 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
6708 struct ieee80211_channel *chan, gfp_t gfp);
6711 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6713 * @sinfo: the station information
6714 * @gfp: allocation flags
6716 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
6719 * cfg80211_sinfo_release_content - release contents of station info
6720 * @sinfo: the station information
6722 * Releases any potentially allocated sub-information of the station
6723 * information, but not the struct itself (since it's typically on
6726 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
6728 kfree(sinfo->pertid);
6732 * cfg80211_new_sta - notify userspace about station
6735 * @mac_addr: the station's address
6736 * @sinfo: the station information
6737 * @gfp: allocation flags
6739 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
6740 struct station_info *sinfo, gfp_t gfp);
6743 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6745 * @mac_addr: the station's address
6746 * @sinfo: the station information/statistics
6747 * @gfp: allocation flags
6749 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
6750 struct station_info *sinfo, gfp_t gfp);
6753 * cfg80211_del_sta - notify userspace about deletion of a station
6756 * @mac_addr: the station's address
6757 * @gfp: allocation flags
6759 static inline void cfg80211_del_sta(struct net_device *dev,
6760 const u8 *mac_addr, gfp_t gfp)
6762 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
6766 * cfg80211_conn_failed - connection request failed notification
6769 * @mac_addr: the station's address
6770 * @reason: the reason for connection failure
6771 * @gfp: allocation flags
6773 * Whenever a station tries to connect to an AP and if the station
6774 * could not connect to the AP as the AP has rejected the connection
6775 * for some reasons, this function is called.
6777 * The reason for connection failure can be any of the value from
6778 * nl80211_connect_failed_reason enum
6780 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
6781 enum nl80211_connect_failed_reason reason,
6785 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
6786 * @wdev: wireless device receiving the frame
6787 * @freq: Frequency on which the frame was received in MHz
6788 * @sig_dbm: signal strength in dBm, or 0 if unknown
6789 * @buf: Management frame (header + body)
6790 * @len: length of the frame data
6791 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
6793 * This function is called whenever an Action frame is received for a station
6794 * mode interface, but is not processed in kernel.
6796 * Return: %true if a user space application has registered for this frame.
6797 * For action frames, that makes it responsible for rejecting unrecognized
6798 * action frames; %false otherwise, in which case for action frames the
6799 * driver is responsible for rejecting the frame.
6801 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
6802 const u8 *buf, size_t len, u32 flags);
6805 * cfg80211_mgmt_tx_status - notification of TX status for management frame
6806 * @wdev: wireless device receiving the frame
6807 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
6808 * @buf: Management frame (header + body)
6809 * @len: length of the frame data
6810 * @ack: Whether frame was acknowledged
6811 * @gfp: context flags
6813 * This function is called whenever a management frame was requested to be
6814 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
6815 * transmission attempt.
6817 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
6818 const u8 *buf, size_t len, bool ack, gfp_t gfp);
6822 * cfg80211_rx_control_port - notification about a received control port frame
6823 * @dev: The device the frame matched to
6824 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
6825 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
6826 * This function does not take ownership of the skb, so the caller is
6827 * responsible for any cleanup. The caller must also ensure that
6828 * skb->protocol is set appropriately.
6829 * @unencrypted: Whether the frame was received unencrypted
6831 * This function is used to inform userspace about a received control port
6832 * frame. It should only be used if userspace indicated it wants to receive
6833 * control port frames over nl80211.
6835 * The frame is the data portion of the 802.3 or 802.11 data frame with all
6836 * network layer headers removed (e.g. the raw EAPoL frame).
6838 * Return: %true if the frame was passed to userspace
6840 bool cfg80211_rx_control_port(struct net_device *dev,
6841 struct sk_buff *skb, bool unencrypted);
6844 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
6845 * @dev: network device
6846 * @rssi_event: the triggered RSSI event
6847 * @rssi_level: new RSSI level value or 0 if not available
6848 * @gfp: context flags
6850 * This function is called when a configured connection quality monitoring
6851 * rssi threshold reached event occurs.
6853 void cfg80211_cqm_rssi_notify(struct net_device *dev,
6854 enum nl80211_cqm_rssi_threshold_event rssi_event,
6855 s32 rssi_level, gfp_t gfp);
6858 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
6859 * @dev: network device
6860 * @peer: peer's MAC address
6861 * @num_packets: how many packets were lost -- should be a fixed threshold
6862 * but probably no less than maybe 50, or maybe a throughput dependent
6863 * threshold (to account for temporary interference)
6864 * @gfp: context flags
6866 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
6867 const u8 *peer, u32 num_packets, gfp_t gfp);
6870 * cfg80211_cqm_txe_notify - TX error rate event
6871 * @dev: network device
6872 * @peer: peer's MAC address
6873 * @num_packets: how many packets were lost
6874 * @rate: % of packets which failed transmission
6875 * @intvl: interval (in s) over which the TX failure threshold was breached.
6876 * @gfp: context flags
6878 * Notify userspace when configured % TX failures over number of packets in a
6879 * given interval is exceeded.
6881 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
6882 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
6885 * cfg80211_cqm_beacon_loss_notify - beacon loss event
6886 * @dev: network device
6887 * @gfp: context flags
6889 * Notify userspace about beacon loss from the connected AP.
6891 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
6894 * cfg80211_radar_event - radar detection event
6896 * @chandef: chandef for the current channel
6897 * @gfp: context flags
6899 * This function is called when a radar is detected on the current chanenl.
6901 void cfg80211_radar_event(struct wiphy *wiphy,
6902 struct cfg80211_chan_def *chandef, gfp_t gfp);
6905 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6906 * @dev: network device
6907 * @mac: MAC address of a station which opmode got modified
6908 * @sta_opmode: station's current opmode value
6909 * @gfp: context flags
6911 * Driver should call this function when station's opmode modified via action
6914 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
6915 struct sta_opmode_info *sta_opmode,
6919 * cfg80211_cac_event - Channel availability check (CAC) event
6920 * @netdev: network device
6921 * @chandef: chandef for the current channel
6922 * @event: type of event
6923 * @gfp: context flags
6925 * This function is called when a Channel availability check (CAC) is finished
6926 * or aborted. This must be called to notify the completion of a CAC process,
6927 * also by full-MAC drivers.
6929 void cfg80211_cac_event(struct net_device *netdev,
6930 const struct cfg80211_chan_def *chandef,
6931 enum nl80211_radar_event event, gfp_t gfp);
6935 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6936 * @dev: network device
6937 * @bssid: BSSID of AP (to avoid races)
6938 * @replay_ctr: new replay counter
6939 * @gfp: allocation flags
6941 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
6942 const u8 *replay_ctr, gfp_t gfp);
6945 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
6946 * @dev: network device
6947 * @index: candidate index (the smaller the index, the higher the priority)
6948 * @bssid: BSSID of AP
6949 * @preauth: Whether AP advertises support for RSN pre-authentication
6950 * @gfp: allocation flags
6952 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
6953 const u8 *bssid, bool preauth, gfp_t gfp);
6956 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
6957 * @dev: The device the frame matched to
6958 * @addr: the transmitter address
6959 * @gfp: context flags
6961 * This function is used in AP mode (only!) to inform userspace that
6962 * a spurious class 3 frame was received, to be able to deauth the
6964 * Return: %true if the frame was passed to userspace (or this failed
6965 * for a reason other than not having a subscription.)
6967 bool cfg80211_rx_spurious_frame(struct net_device *dev,
6968 const u8 *addr, gfp_t gfp);
6971 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
6972 * @dev: The device the frame matched to
6973 * @addr: the transmitter address
6974 * @gfp: context flags
6976 * This function is used in AP mode (only!) to inform userspace that
6977 * an associated station sent a 4addr frame but that wasn't expected.
6978 * It is allowed and desirable to send this event only once for each
6979 * station to avoid event flooding.
6980 * Return: %true if the frame was passed to userspace (or this failed
6981 * for a reason other than not having a subscription.)
6983 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
6984 const u8 *addr, gfp_t gfp);
6987 * cfg80211_probe_status - notify userspace about probe status
6988 * @dev: the device the probe was sent on
6989 * @addr: the address of the peer
6990 * @cookie: the cookie filled in @probe_client previously
6991 * @acked: indicates whether probe was acked or not
6992 * @ack_signal: signal strength (in dBm) of the ACK frame.
6993 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6994 * @gfp: allocation flags
6996 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
6997 u64 cookie, bool acked, s32 ack_signal,
6998 bool is_valid_ack_signal, gfp_t gfp);
7001 * cfg80211_report_obss_beacon - report beacon from other APs
7002 * @wiphy: The wiphy that received the beacon
7004 * @len: length of the frame
7005 * @freq: frequency the frame was received on
7006 * @sig_dbm: signal strength in dBm, or 0 if unknown
7008 * Use this function to report to userspace when a beacon was
7009 * received. It is not useful to call this when there is no
7010 * netdev that is in AP/GO mode.
7012 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7013 const u8 *frame, size_t len,
7014 int freq, int sig_dbm);
7017 * cfg80211_reg_can_beacon - check if beaconing is allowed
7019 * @chandef: the channel definition
7020 * @iftype: interface type
7022 * Return: %true if there is no secondary channel or the secondary channel(s)
7023 * can be used for beaconing (i.e. is not a radar channel etc.)
7025 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7026 struct cfg80211_chan_def *chandef,
7027 enum nl80211_iftype iftype);
7030 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7032 * @chandef: the channel definition
7033 * @iftype: interface type
7035 * Return: %true if there is no secondary channel or the secondary channel(s)
7036 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7037 * also checks if IR-relaxation conditions apply, to allow beaconing under
7038 * more permissive conditions.
7040 * Requires the RTNL to be held.
7042 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7043 struct cfg80211_chan_def *chandef,
7044 enum nl80211_iftype iftype);
7047 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7048 * @dev: the device which switched channels
7049 * @chandef: the new channel definition
7051 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7054 void cfg80211_ch_switch_notify(struct net_device *dev,
7055 struct cfg80211_chan_def *chandef);
7058 * cfg80211_ch_switch_started_notify - notify channel switch start
7059 * @dev: the device on which the channel switch started
7060 * @chandef: the future channel definition
7061 * @count: the number of TBTTs until the channel switch happens
7063 * Inform the userspace about the channel switch that has just
7064 * started, so that it can take appropriate actions (eg. starting
7065 * channel switch on other vifs), if necessary.
7067 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7068 struct cfg80211_chan_def *chandef,
7072 * ieee80211_operating_class_to_band - convert operating class to band
7074 * @operating_class: the operating class to convert
7075 * @band: band pointer to fill
7077 * Returns %true if the conversion was successful, %false otherwise.
7079 bool ieee80211_operating_class_to_band(u8 operating_class,
7080 enum nl80211_band *band);
7083 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7085 * @chandef: the chandef to convert
7086 * @op_class: a pointer to the resulting operating class
7088 * Returns %true if the conversion was successful, %false otherwise.
7090 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7094 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7095 * @dev: the device on which the operation is requested
7096 * @peer: the MAC address of the peer device
7097 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7098 * NL80211_TDLS_TEARDOWN)
7099 * @reason_code: the reason code for teardown request
7100 * @gfp: allocation flags
7102 * This function is used to request userspace to perform TDLS operation that
7103 * requires knowledge of keys, i.e., link setup or teardown when the AP
7104 * connection uses encryption. This is optional mechanism for the driver to use
7105 * if it can automatically determine when a TDLS link could be useful (e.g.,
7106 * based on traffic and signal strength for a peer).
7108 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7109 enum nl80211_tdls_operation oper,
7110 u16 reason_code, gfp_t gfp);
7113 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7114 * @rate: given rate_info to calculate bitrate from
7116 * return 0 if MCS index >= 32
7118 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7121 * cfg80211_unregister_wdev - remove the given wdev
7122 * @wdev: struct wireless_dev to remove
7124 * Call this function only for wdevs that have no netdev assigned,
7125 * e.g. P2P Devices. It removes the device from the list so that
7126 * it can no longer be used. It is necessary to call this function
7127 * even when cfg80211 requests the removal of the interface by
7128 * calling the del_virtual_intf() callback. The function must also
7129 * be called when the driver wishes to unregister the wdev, e.g.
7130 * when the device is unbound from the driver.
7132 * Requires the RTNL to be held.
7134 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7137 * struct cfg80211_ft_event - FT Information Elements
7139 * @ies_len: length of the FT IE in bytes
7140 * @target_ap: target AP's MAC address
7142 * @ric_ies_len: length of the RIC IE in bytes
7144 struct cfg80211_ft_event_params {
7147 const u8 *target_ap;
7153 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7154 * @netdev: network device
7155 * @ft_event: IE information
7157 void cfg80211_ft_event(struct net_device *netdev,
7158 struct cfg80211_ft_event_params *ft_event);
7161 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7162 * @ies: the input IE buffer
7163 * @len: the input length
7164 * @attr: the attribute ID to find
7165 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7166 * if the function is only called to get the needed buffer size
7167 * @bufsize: size of the output buffer
7169 * The function finds a given P2P attribute in the (vendor) IEs and
7170 * copies its contents to the given buffer.
7172 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7173 * malformed or the attribute can't be found (respectively), or the
7174 * length of the found attribute (which can be zero).
7176 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7177 enum ieee80211_p2p_attr_id attr,
7178 u8 *buf, unsigned int bufsize);
7181 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7182 * @ies: the IE buffer
7183 * @ielen: the length of the IE buffer
7184 * @ids: an array with element IDs that are allowed before
7185 * the split. A WLAN_EID_EXTENSION value means that the next
7186 * EID in the list is a sub-element of the EXTENSION IE.
7187 * @n_ids: the size of the element ID array
7188 * @after_ric: array IE types that come after the RIC element
7189 * @n_after_ric: size of the @after_ric array
7190 * @offset: offset where to start splitting in the buffer
7192 * This function splits an IE buffer by updating the @offset
7193 * variable to point to the location where the buffer should be
7196 * It assumes that the given IE buffer is well-formed, this
7197 * has to be guaranteed by the caller!
7199 * It also assumes that the IEs in the buffer are ordered
7200 * correctly, if not the result of using this function will not
7201 * be ordered correctly either, i.e. it does no reordering.
7203 * The function returns the offset where the next part of the
7204 * buffer starts, which may be @ielen if the entire (remainder)
7205 * of the buffer should be used.
7207 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7208 const u8 *ids, int n_ids,
7209 const u8 *after_ric, int n_after_ric,
7213 * ieee80211_ie_split - split an IE buffer according to ordering
7214 * @ies: the IE buffer
7215 * @ielen: the length of the IE buffer
7216 * @ids: an array with element IDs that are allowed before
7217 * the split. A WLAN_EID_EXTENSION value means that the next
7218 * EID in the list is a sub-element of the EXTENSION IE.
7219 * @n_ids: the size of the element ID array
7220 * @offset: offset where to start splitting in the buffer
7222 * This function splits an IE buffer by updating the @offset
7223 * variable to point to the location where the buffer should be
7226 * It assumes that the given IE buffer is well-formed, this
7227 * has to be guaranteed by the caller!
7229 * It also assumes that the IEs in the buffer are ordered
7230 * correctly, if not the result of using this function will not
7231 * be ordered correctly either, i.e. it does no reordering.
7233 * The function returns the offset where the next part of the
7234 * buffer starts, which may be @ielen if the entire (remainder)
7235 * of the buffer should be used.
7237 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7238 const u8 *ids, int n_ids, size_t offset)
7240 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7244 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7245 * @wdev: the wireless device reporting the wakeup
7246 * @wakeup: the wakeup report
7247 * @gfp: allocation flags
7249 * This function reports that the given device woke up. If it
7250 * caused the wakeup, report the reason(s), otherwise you may
7251 * pass %NULL as the @wakeup parameter to advertise that something
7252 * else caused the wakeup.
7254 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7255 struct cfg80211_wowlan_wakeup *wakeup,
7259 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7261 * @wdev: the wireless device for which critical protocol is stopped.
7262 * @gfp: allocation flags
7264 * This function can be called by the driver to indicate it has reverted
7265 * operation back to normal. One reason could be that the duration given
7266 * by .crit_proto_start() has expired.
7268 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7271 * ieee80211_get_num_supported_channels - get number of channels device has
7274 * Return: the number of channels supported by the device.
7276 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7279 * cfg80211_check_combinations - check interface combinations
7282 * @params: the interface combinations parameter
7284 * This function can be called by the driver to check whether a
7285 * combination of interfaces and their types are allowed according to
7286 * the interface combinations.
7288 int cfg80211_check_combinations(struct wiphy *wiphy,
7289 struct iface_combination_params *params);
7292 * cfg80211_iter_combinations - iterate over matching combinations
7295 * @params: the interface combinations parameter
7296 * @iter: function to call for each matching combination
7297 * @data: pointer to pass to iter function
7299 * This function can be called by the driver to check what possible
7300 * combinations it fits in at a given moment, e.g. for channel switching
7303 int cfg80211_iter_combinations(struct wiphy *wiphy,
7304 struct iface_combination_params *params,
7305 void (*iter)(const struct ieee80211_iface_combination *c,
7310 * cfg80211_stop_iface - trigger interface disconnection
7313 * @wdev: wireless device
7314 * @gfp: context flags
7316 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7319 * Note: This doesn't need any locks and is asynchronous.
7321 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7325 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7326 * @wiphy: the wiphy to shut down
7328 * This function shuts down all interfaces belonging to this wiphy by
7329 * calling dev_close() (and treating non-netdev interfaces as needed).
7330 * It shouldn't really be used unless there are some fatal device errors
7331 * that really can't be recovered in any other way.
7333 * Callers must hold the RTNL and be able to deal with callbacks into
7334 * the driver while the function is running.
7336 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7339 * wiphy_ext_feature_set - set the extended feature flag
7341 * @wiphy: the wiphy to modify.
7342 * @ftidx: extended feature bit index.
7344 * The extended features are flagged in multiple bytes (see
7345 * &struct wiphy.@ext_features)
7347 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7348 enum nl80211_ext_feature_index ftidx)
7352 ft_byte = &wiphy->ext_features[ftidx / 8];
7353 *ft_byte |= BIT(ftidx % 8);
7357 * wiphy_ext_feature_isset - check the extended feature flag
7359 * @wiphy: the wiphy to modify.
7360 * @ftidx: extended feature bit index.
7362 * The extended features are flagged in multiple bytes (see
7363 * &struct wiphy.@ext_features)
7366 wiphy_ext_feature_isset(struct wiphy *wiphy,
7367 enum nl80211_ext_feature_index ftidx)
7371 ft_byte = wiphy->ext_features[ftidx / 8];
7372 return (ft_byte & BIT(ftidx % 8)) != 0;
7376 * cfg80211_free_nan_func - free NAN function
7377 * @f: NAN function that should be freed
7379 * Frees all the NAN function and all it's allocated members.
7381 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7384 * struct cfg80211_nan_match_params - NAN match parameters
7385 * @type: the type of the function that triggered a match. If it is
7386 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7387 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7389 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7390 * @inst_id: the local instance id
7391 * @peer_inst_id: the instance id of the peer's function
7392 * @addr: the MAC address of the peer
7393 * @info_len: the length of the &info
7394 * @info: the Service Specific Info from the peer (if any)
7395 * @cookie: unique identifier of the corresponding function
7397 struct cfg80211_nan_match_params {
7398 enum nl80211_nan_function_type type;
7408 * cfg80211_nan_match - report a match for a NAN function.
7409 * @wdev: the wireless device reporting the match
7410 * @match: match notification parameters
7411 * @gfp: allocation flags
7413 * This function reports that the a NAN function had a match. This
7414 * can be a subscribe that had a match or a solicited publish that
7415 * was sent. It can also be a follow up that was received.
7417 void cfg80211_nan_match(struct wireless_dev *wdev,
7418 struct cfg80211_nan_match_params *match, gfp_t gfp);
7421 * cfg80211_nan_func_terminated - notify about NAN function termination.
7423 * @wdev: the wireless device reporting the match
7424 * @inst_id: the local instance id
7425 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7426 * @cookie: unique NAN function identifier
7427 * @gfp: allocation flags
7429 * This function reports that the a NAN function is terminated.
7431 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7433 enum nl80211_nan_func_term_reason reason,
7434 u64 cookie, gfp_t gfp);
7436 /* ethtool helper */
7437 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7440 * cfg80211_external_auth_request - userspace request for authentication
7441 * @netdev: network device
7442 * @params: External authentication parameters
7443 * @gfp: allocation flags
7444 * Returns: 0 on success, < 0 on error
7446 int cfg80211_external_auth_request(struct net_device *netdev,
7447 struct cfg80211_external_auth_params *params,
7451 * cfg80211_pmsr_report - report peer measurement result data
7452 * @wdev: the wireless device reporting the measurement
7453 * @req: the original measurement request
7454 * @result: the result data
7455 * @gfp: allocation flags
7457 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7458 struct cfg80211_pmsr_request *req,
7459 struct cfg80211_pmsr_result *result,
7463 * cfg80211_pmsr_complete - report peer measurement completed
7464 * @wdev: the wireless device reporting the measurement
7465 * @req: the original measurement request
7466 * @gfp: allocation flags
7468 * Report that the entire measurement completed, after this
7469 * the request pointer will no longer be valid.
7471 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7472 struct cfg80211_pmsr_request *req,
7476 * cfg80211_iftype_allowed - check whether the interface can be allowed
7478 * @iftype: interface type
7479 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7480 * @check_swif: check iftype against software interfaces
7482 * Check whether the interface is allowed to operate; additionally, this API
7483 * can be used to check iftype against the software interfaces when
7484 * check_swif is '1'.
7486 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
7487 bool is_4addr, u8 check_swif);
7490 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7492 /* wiphy_printk helpers, similar to dev_printk */
7494 #define wiphy_printk(level, wiphy, format, args...) \
7495 dev_printk(level, &(wiphy)->dev, format, ##args)
7496 #define wiphy_emerg(wiphy, format, args...) \
7497 dev_emerg(&(wiphy)->dev, format, ##args)
7498 #define wiphy_alert(wiphy, format, args...) \
7499 dev_alert(&(wiphy)->dev, format, ##args)
7500 #define wiphy_crit(wiphy, format, args...) \
7501 dev_crit(&(wiphy)->dev, format, ##args)
7502 #define wiphy_err(wiphy, format, args...) \
7503 dev_err(&(wiphy)->dev, format, ##args)
7504 #define wiphy_warn(wiphy, format, args...) \
7505 dev_warn(&(wiphy)->dev, format, ##args)
7506 #define wiphy_notice(wiphy, format, args...) \
7507 dev_notice(&(wiphy)->dev, format, ##args)
7508 #define wiphy_info(wiphy, format, args...) \
7509 dev_info(&(wiphy)->dev, format, ##args)
7511 #define wiphy_err_ratelimited(wiphy, format, args...) \
7512 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7513 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7514 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7516 #define wiphy_debug(wiphy, format, args...) \
7517 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7519 #define wiphy_dbg(wiphy, format, args...) \
7520 dev_dbg(&(wiphy)->dev, format, ##args)
7522 #if defined(VERBOSE_DEBUG)
7523 #define wiphy_vdbg wiphy_dbg
7525 #define wiphy_vdbg(wiphy, format, args...) \
7528 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
7534 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7535 * of using a WARN/WARN_ON to get the message out, including the
7536 * file/line information and a backtrace.
7538 #define wiphy_WARN(wiphy, format, args...) \
7539 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7542 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
7543 * @netdev: network device
7544 * @owe_info: peer's owe info
7545 * @gfp: allocation flags
7547 void cfg80211_update_owe_info_event(struct net_device *netdev,
7548 struct cfg80211_update_owe_info *owe_info,
7551 #endif /* __NET_CFG80211_H */