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
100 enum ieee80211_channel_flags {
101 IEEE80211_CHAN_DISABLED = 1<<0,
102 IEEE80211_CHAN_NO_IR = 1<<1,
104 IEEE80211_CHAN_RADAR = 1<<3,
105 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
106 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
107 IEEE80211_CHAN_NO_OFDM = 1<<6,
108 IEEE80211_CHAN_NO_80MHZ = 1<<7,
109 IEEE80211_CHAN_NO_160MHZ = 1<<8,
110 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
111 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
112 IEEE80211_CHAN_NO_20MHZ = 1<<11,
113 IEEE80211_CHAN_NO_10MHZ = 1<<12,
116 #define IEEE80211_CHAN_NO_HT40 \
117 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
119 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
120 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
123 * struct ieee80211_channel - channel definition
125 * This structure describes a single channel for use
128 * @center_freq: center frequency in MHz
129 * @hw_value: hardware-specific value for the channel
130 * @flags: channel flags from &enum ieee80211_channel_flags.
131 * @orig_flags: channel flags at registration time, used by regulatory
132 * code to support devices with additional restrictions
133 * @band: band this channel belongs to.
134 * @max_antenna_gain: maximum antenna gain in dBi
135 * @max_power: maximum transmission power (in dBm)
136 * @max_reg_power: maximum regulatory transmission power (in dBm)
137 * @beacon_found: helper to regulatory code to indicate when a beacon
138 * has been found on this channel. Use regulatory_hint_found_beacon()
139 * to enable this, this is useful only on 5 GHz band.
140 * @orig_mag: internal use
141 * @orig_mpwr: internal use
142 * @dfs_state: current state of this channel. Only relevant if radar is required
144 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
145 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
147 struct ieee80211_channel {
148 enum nl80211_band band;
152 int max_antenna_gain;
157 int orig_mag, orig_mpwr;
158 enum nl80211_dfs_state dfs_state;
159 unsigned long dfs_state_entered;
160 unsigned int dfs_cac_ms;
164 * enum ieee80211_rate_flags - rate flags
166 * Hardware/specification flags for rates. These are structured
167 * in a way that allows using the same bitrate structure for
168 * different bands/PHY modes.
170 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
171 * preamble on this bitrate; only relevant in 2.4GHz band and
173 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
174 * when used with 802.11a (on the 5 GHz band); filled by the
175 * core code when registering the wiphy.
176 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
177 * when used with 802.11b (on the 2.4 GHz band); filled by the
178 * core code when registering the wiphy.
179 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
180 * when used with 802.11g (on the 2.4 GHz band); filled by the
181 * core code when registering the wiphy.
182 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
183 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
184 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
186 enum ieee80211_rate_flags {
187 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
188 IEEE80211_RATE_MANDATORY_A = 1<<1,
189 IEEE80211_RATE_MANDATORY_B = 1<<2,
190 IEEE80211_RATE_MANDATORY_G = 1<<3,
191 IEEE80211_RATE_ERP_G = 1<<4,
192 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
193 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
197 * enum ieee80211_bss_type - BSS type filter
199 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
200 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
201 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
202 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
203 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
205 enum ieee80211_bss_type {
206 IEEE80211_BSS_TYPE_ESS,
207 IEEE80211_BSS_TYPE_PBSS,
208 IEEE80211_BSS_TYPE_IBSS,
209 IEEE80211_BSS_TYPE_MBSS,
210 IEEE80211_BSS_TYPE_ANY
214 * enum ieee80211_privacy - BSS privacy filter
216 * @IEEE80211_PRIVACY_ON: privacy bit set
217 * @IEEE80211_PRIVACY_OFF: privacy bit clear
218 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
220 enum ieee80211_privacy {
221 IEEE80211_PRIVACY_ON,
222 IEEE80211_PRIVACY_OFF,
223 IEEE80211_PRIVACY_ANY
226 #define IEEE80211_PRIVACY(x) \
227 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
230 * struct ieee80211_rate - bitrate definition
232 * This structure describes a bitrate that an 802.11 PHY can
233 * operate with. The two values @hw_value and @hw_value_short
234 * are only for driver use when pointers to this structure are
237 * @flags: rate-specific flags
238 * @bitrate: bitrate in units of 100 Kbps
239 * @hw_value: driver/hardware value for this rate
240 * @hw_value_short: driver/hardware value for this rate when
241 * short preamble is used
243 struct ieee80211_rate {
246 u16 hw_value, hw_value_short;
250 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
252 * @enable: is the feature enabled.
253 * @min_offset: minimal tx power offset an associated station shall use
254 * @max_offset: maximum tx power offset an associated station shall use
256 struct ieee80211_he_obss_pd {
263 * struct ieee80211_sta_ht_cap - STA's HT capabilities
265 * This structure describes most essential parameters needed
266 * to describe 802.11n HT capabilities for an STA.
268 * @ht_supported: is HT supported by the STA
269 * @cap: HT capabilities map as described in 802.11n spec
270 * @ampdu_factor: Maximum A-MPDU length factor
271 * @ampdu_density: Minimum A-MPDU spacing
272 * @mcs: Supported MCS rates
274 struct ieee80211_sta_ht_cap {
275 u16 cap; /* use IEEE80211_HT_CAP_ */
279 struct ieee80211_mcs_info mcs;
283 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
285 * This structure describes most essential parameters needed
286 * to describe 802.11ac VHT capabilities for an STA.
288 * @vht_supported: is VHT supported by the STA
289 * @cap: VHT capabilities map as described in 802.11ac spec
290 * @vht_mcs: Supported VHT MCS rates
292 struct ieee80211_sta_vht_cap {
294 u32 cap; /* use IEEE80211_VHT_CAP_ */
295 struct ieee80211_vht_mcs_info vht_mcs;
298 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
301 * struct ieee80211_sta_he_cap - STA's HE capabilities
303 * This structure describes most essential parameters needed
304 * to describe 802.11ax HE capabilities for a STA.
306 * @has_he: true iff HE data is valid.
307 * @he_cap_elem: Fixed portion of the HE capabilities element.
308 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
309 * @ppe_thres: Holds the PPE Thresholds data.
311 struct ieee80211_sta_he_cap {
313 struct ieee80211_he_cap_elem he_cap_elem;
314 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
315 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
319 * struct ieee80211_sband_iftype_data
321 * This structure encapsulates sband data that is relevant for the
322 * interface types defined in @types_mask. Each type in the
323 * @types_mask must be unique across all instances of iftype_data.
325 * @types_mask: interface types mask
326 * @he_cap: holds the HE capabilities
328 struct ieee80211_sband_iftype_data {
330 struct ieee80211_sta_he_cap he_cap;
334 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
336 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
337 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
338 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
339 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
340 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
341 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
342 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
343 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
345 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
347 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
349 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
350 * and 4.32GHz + 4.32GHz
351 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
352 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
354 enum ieee80211_edmg_bw_config {
355 IEEE80211_EDMG_BW_CONFIG_4 = 4,
356 IEEE80211_EDMG_BW_CONFIG_5 = 5,
357 IEEE80211_EDMG_BW_CONFIG_6 = 6,
358 IEEE80211_EDMG_BW_CONFIG_7 = 7,
359 IEEE80211_EDMG_BW_CONFIG_8 = 8,
360 IEEE80211_EDMG_BW_CONFIG_9 = 9,
361 IEEE80211_EDMG_BW_CONFIG_10 = 10,
362 IEEE80211_EDMG_BW_CONFIG_11 = 11,
363 IEEE80211_EDMG_BW_CONFIG_12 = 12,
364 IEEE80211_EDMG_BW_CONFIG_13 = 13,
365 IEEE80211_EDMG_BW_CONFIG_14 = 14,
366 IEEE80211_EDMG_BW_CONFIG_15 = 15,
370 * struct ieee80211_edmg - EDMG configuration
372 * This structure describes most essential parameters needed
373 * to describe 802.11ay EDMG configuration
375 * @channels: bitmap that indicates the 2.16 GHz channel(s)
376 * that are allowed to be used for transmissions.
377 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
378 * Set to 0 indicate EDMG not supported.
379 * @bw_config: Channel BW Configuration subfield encodes
380 * the allowed channel bandwidth configurations
382 struct ieee80211_edmg {
384 enum ieee80211_edmg_bw_config bw_config;
388 * struct ieee80211_supported_band - frequency band definition
390 * This structure describes a frequency band a wiphy
391 * is able to operate in.
393 * @channels: Array of channels the hardware can operate in
395 * @band: the band this structure represents
396 * @n_channels: Number of channels in @channels
397 * @bitrates: Array of bitrates the hardware can operate with
398 * in this band. Must be sorted to give a valid "supported
399 * rates" IE, i.e. CCK rates first, then OFDM.
400 * @n_bitrates: Number of bitrates in @bitrates
401 * @ht_cap: HT capabilities in this band
402 * @vht_cap: VHT capabilities in this band
403 * @edmg_cap: EDMG capabilities in this band
404 * @n_iftype_data: number of iftype data entries
405 * @iftype_data: interface type data entries. Note that the bits in
406 * @types_mask inside this structure cannot overlap (i.e. only
407 * one occurrence of each type is allowed across all instances of
410 struct ieee80211_supported_band {
411 struct ieee80211_channel *channels;
412 struct ieee80211_rate *bitrates;
413 enum nl80211_band band;
416 struct ieee80211_sta_ht_cap ht_cap;
417 struct ieee80211_sta_vht_cap vht_cap;
418 struct ieee80211_edmg edmg_cap;
420 const struct ieee80211_sband_iftype_data *iftype_data;
424 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
425 * @sband: the sband to search for the STA on
426 * @iftype: enum nl80211_iftype
428 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
430 static inline const struct ieee80211_sband_iftype_data *
431 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
436 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
439 for (i = 0; i < sband->n_iftype_data; i++) {
440 const struct ieee80211_sband_iftype_data *data =
441 &sband->iftype_data[i];
443 if (data->types_mask & BIT(iftype))
451 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
452 * @sband: the sband to search for the iftype on
453 * @iftype: enum nl80211_iftype
455 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
457 static inline const struct ieee80211_sta_he_cap *
458 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
461 const struct ieee80211_sband_iftype_data *data =
462 ieee80211_get_sband_iftype_data(sband, iftype);
464 if (data && data->he_cap.has_he)
465 return &data->he_cap;
471 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
472 * @sband: the sband to search for the STA on
474 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
476 static inline const struct ieee80211_sta_he_cap *
477 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
479 return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
483 * wiphy_read_of_freq_limits - read frequency limits from device tree
485 * @wiphy: the wireless device to get extra limits for
487 * Some devices may have extra limitations specified in DT. This may be useful
488 * for chipsets that normally support more bands but are limited due to board
489 * design (e.g. by antennas or external power amplifier).
491 * This function reads info from DT and uses it to *modify* channels (disable
492 * unavailable ones). It's usually a *bad* idea to use it in drivers with
493 * shared channel data as DT limitations are device specific. You should make
494 * sure to call it only if channels in wiphy are copied and can be modified
495 * without affecting other devices.
497 * As this function access device node it has to be called after set_wiphy_dev.
498 * It also modifies channels so they have to be set first.
499 * If using this helper, call it before wiphy_register().
502 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
503 #else /* CONFIG_OF */
504 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
507 #endif /* !CONFIG_OF */
511 * Wireless hardware/device configuration structures and methods
515 * DOC: Actions and configuration
517 * Each wireless device and each virtual interface offer a set of configuration
518 * operations and other actions that are invoked by userspace. Each of these
519 * actions is described in the operations structure, and the parameters these
520 * operations use are described separately.
522 * Additionally, some operations are asynchronous and expect to get status
523 * information via some functions that drivers need to call.
525 * Scanning and BSS list handling with its associated functionality is described
526 * in a separate chapter.
529 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
530 WLAN_USER_POSITION_LEN)
533 * struct vif_params - describes virtual interface parameters
534 * @flags: monitor interface flags, unchanged if 0, otherwise
535 * %MONITOR_FLAG_CHANGED will be set
536 * @use_4addr: use 4-address frames
537 * @macaddr: address to use for this virtual interface.
538 * If this parameter is set to zero address the driver may
539 * determine the address as needed.
540 * This feature is only fully supported by drivers that enable the
541 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
542 ** only p2p devices with specified MAC.
543 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
544 * belonging to that MU-MIMO groupID; %NULL if not changed
545 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
546 * MU-MIMO packets going to the specified station; %NULL if not changed
551 u8 macaddr[ETH_ALEN];
552 const u8 *vht_mumimo_groups;
553 const u8 *vht_mumimo_follow_addr;
557 * struct key_params - key information
559 * Information about a key
562 * @key_len: length of key material
563 * @cipher: cipher suite selector
564 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
565 * with the get_key() callback, must be in little endian,
566 * length given by @seq_len.
567 * @seq_len: length of @seq.
568 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
576 enum nl80211_key_mode mode;
580 * struct cfg80211_chan_def - channel definition
581 * @chan: the (control) channel
582 * @width: channel width
583 * @center_freq1: center frequency of first segment
584 * @center_freq2: center frequency of second segment
585 * (only with 80+80 MHz)
586 * @edmg: define the EDMG channels configuration.
587 * If edmg is requested (i.e. the .channels member is non-zero),
588 * chan will define the primary channel and all other
589 * parameters are ignored.
591 struct cfg80211_chan_def {
592 struct ieee80211_channel *chan;
593 enum nl80211_chan_width width;
596 struct ieee80211_edmg edmg;
600 * cfg80211_get_chandef_type - return old channel type from chandef
601 * @chandef: the channel definition
603 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
604 * chandef, which must have a bandwidth allowing this conversion.
606 static inline enum nl80211_channel_type
607 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
609 switch (chandef->width) {
610 case NL80211_CHAN_WIDTH_20_NOHT:
611 return NL80211_CHAN_NO_HT;
612 case NL80211_CHAN_WIDTH_20:
613 return NL80211_CHAN_HT20;
614 case NL80211_CHAN_WIDTH_40:
615 if (chandef->center_freq1 > chandef->chan->center_freq)
616 return NL80211_CHAN_HT40PLUS;
617 return NL80211_CHAN_HT40MINUS;
620 return NL80211_CHAN_NO_HT;
625 * cfg80211_chandef_create - create channel definition using channel type
626 * @chandef: the channel definition struct to fill
627 * @channel: the control channel
628 * @chantype: the channel type
630 * Given a channel type, create a channel definition.
632 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
633 struct ieee80211_channel *channel,
634 enum nl80211_channel_type chantype);
637 * cfg80211_chandef_identical - check if two channel definitions are identical
638 * @chandef1: first channel definition
639 * @chandef2: second channel definition
641 * Return: %true if the channels defined by the channel definitions are
642 * identical, %false otherwise.
645 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
646 const struct cfg80211_chan_def *chandef2)
648 return (chandef1->chan == chandef2->chan &&
649 chandef1->width == chandef2->width &&
650 chandef1->center_freq1 == chandef2->center_freq1 &&
651 chandef1->center_freq2 == chandef2->center_freq2);
655 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
657 * @chandef: the channel definition
659 * Return: %true if EDMG defined, %false otherwise.
662 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
664 return chandef->edmg.channels || chandef->edmg.bw_config;
668 * cfg80211_chandef_compatible - check if two channel definitions are compatible
669 * @chandef1: first channel definition
670 * @chandef2: second channel definition
672 * Return: %NULL if the given channel definitions are incompatible,
673 * chandef1 or chandef2 otherwise.
675 const struct cfg80211_chan_def *
676 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
677 const struct cfg80211_chan_def *chandef2);
680 * cfg80211_chandef_valid - check if a channel definition is valid
681 * @chandef: the channel definition to check
682 * Return: %true if the channel definition is valid. %false otherwise.
684 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
687 * cfg80211_chandef_usable - check if secondary channels can be used
688 * @wiphy: the wiphy to validate against
689 * @chandef: the channel definition to check
690 * @prohibited_flags: the regulatory channel flags that must not be set
691 * Return: %true if secondary channels are usable. %false otherwise.
693 bool cfg80211_chandef_usable(struct wiphy *wiphy,
694 const struct cfg80211_chan_def *chandef,
695 u32 prohibited_flags);
698 * cfg80211_chandef_dfs_required - checks if radar detection is required
699 * @wiphy: the wiphy to validate against
700 * @chandef: the channel definition to check
701 * @iftype: the interface type as specified in &enum nl80211_iftype
703 * 1 if radar detection is required, 0 if it is not, < 0 on error
705 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
706 const struct cfg80211_chan_def *chandef,
707 enum nl80211_iftype iftype);
710 * ieee80211_chandef_rate_flags - returns rate flags for a channel
712 * In some channel types, not all rates may be used - for example CCK
713 * rates may not be used in 5/10 MHz channels.
715 * @chandef: channel definition for the channel
717 * Returns: rate flags which apply for this channel
719 static inline enum ieee80211_rate_flags
720 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
722 switch (chandef->width) {
723 case NL80211_CHAN_WIDTH_5:
724 return IEEE80211_RATE_SUPPORTS_5MHZ;
725 case NL80211_CHAN_WIDTH_10:
726 return IEEE80211_RATE_SUPPORTS_10MHZ;
734 * ieee80211_chandef_max_power - maximum transmission power for the chandef
736 * In some regulations, the transmit power may depend on the configured channel
737 * bandwidth which may be defined as dBm/MHz. This function returns the actual
738 * max_power for non-standard (20 MHz) channels.
740 * @chandef: channel definition for the channel
742 * Returns: maximum allowed transmission power in dBm for the chandef
745 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
747 switch (chandef->width) {
748 case NL80211_CHAN_WIDTH_5:
749 return min(chandef->chan->max_reg_power - 6,
750 chandef->chan->max_power);
751 case NL80211_CHAN_WIDTH_10:
752 return min(chandef->chan->max_reg_power - 3,
753 chandef->chan->max_power);
757 return chandef->chan->max_power;
761 * enum survey_info_flags - survey information flags
763 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
764 * @SURVEY_INFO_IN_USE: channel is currently being used
765 * @SURVEY_INFO_TIME: active time (in ms) was filled in
766 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
767 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
768 * @SURVEY_INFO_TIME_RX: receive time was filled in
769 * @SURVEY_INFO_TIME_TX: transmit time was filled in
770 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
772 * Used by the driver to indicate which info in &struct survey_info
773 * it has filled in during the get_survey().
775 enum survey_info_flags {
776 SURVEY_INFO_NOISE_DBM = BIT(0),
777 SURVEY_INFO_IN_USE = BIT(1),
778 SURVEY_INFO_TIME = BIT(2),
779 SURVEY_INFO_TIME_BUSY = BIT(3),
780 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
781 SURVEY_INFO_TIME_RX = BIT(5),
782 SURVEY_INFO_TIME_TX = BIT(6),
783 SURVEY_INFO_TIME_SCAN = BIT(7),
787 * struct survey_info - channel survey response
789 * @channel: the channel this survey record reports, may be %NULL for a single
790 * record to report global statistics
791 * @filled: bitflag of flags from &enum survey_info_flags
792 * @noise: channel noise in dBm. This and all following fields are
794 * @time: amount of time in ms the radio was turn on (on the channel)
795 * @time_busy: amount of time the primary channel was sensed busy
796 * @time_ext_busy: amount of time the extension channel was sensed busy
797 * @time_rx: amount of time the radio spent receiving data
798 * @time_tx: amount of time the radio spent transmitting data
799 * @time_scan: amount of time the radio spent for scanning
801 * Used by dump_survey() to report back per-channel survey information.
803 * This structure can later be expanded with things like
804 * channel duty cycle etc.
807 struct ieee80211_channel *channel;
818 #define CFG80211_MAX_WEP_KEYS 4
821 * struct cfg80211_crypto_settings - Crypto settings
822 * @wpa_versions: indicates which, if any, WPA versions are enabled
823 * (from enum nl80211_wpa_versions)
824 * @cipher_group: group key cipher suite (or 0 if unset)
825 * @n_ciphers_pairwise: number of AP supported unicast ciphers
826 * @ciphers_pairwise: unicast key cipher suites
827 * @n_akm_suites: number of AKM suites
828 * @akm_suites: AKM suites
829 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
830 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
831 * required to assume that the port is unauthorized until authorized by
832 * user space. Otherwise, port is marked authorized by default.
833 * @control_port_ethertype: the control port protocol that should be
834 * allowed through even on unauthorized ports
835 * @control_port_no_encrypt: TRUE to prevent encryption of control port
837 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
838 * port frames over NL80211 instead of the network interface.
839 * @wep_keys: static WEP keys, if not NULL points to an array of
840 * CFG80211_MAX_WEP_KEYS WEP keys
841 * @wep_tx_key: key index (0..3) of the default TX static WEP key
842 * @psk: PSK (for devices supporting 4-way-handshake offload)
843 * @sae_pwd: password for SAE authentication (for devices supporting SAE
845 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
847 struct cfg80211_crypto_settings {
850 int n_ciphers_pairwise;
851 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
853 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
855 __be16 control_port_ethertype;
856 bool control_port_no_encrypt;
857 bool control_port_over_nl80211;
858 struct key_params *wep_keys;
866 * struct cfg80211_beacon_data - beacon data
867 * @head: head portion of beacon (before TIM IE)
868 * or %NULL if not changed
869 * @tail: tail portion of beacon (after TIM IE)
870 * or %NULL if not changed
871 * @head_len: length of @head
872 * @tail_len: length of @tail
873 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
874 * @beacon_ies_len: length of beacon_ies in octets
875 * @proberesp_ies: extra information element(s) to add into Probe Response
877 * @proberesp_ies_len: length of proberesp_ies in octets
878 * @assocresp_ies: extra information element(s) to add into (Re)Association
879 * Response frames or %NULL
880 * @assocresp_ies_len: length of assocresp_ies in octets
881 * @probe_resp_len: length of probe response template (@probe_resp)
882 * @probe_resp: probe response template (AP mode only)
883 * @ftm_responder: enable FTM responder functionality; -1 for no change
884 * (which also implies no change in LCI/civic location data)
885 * @lci: Measurement Report element content, starting with Measurement Token
886 * (measurement type 8)
887 * @civicloc: Measurement Report element content, starting with Measurement
888 * Token (measurement type 11)
889 * @lci_len: LCI data length
890 * @civicloc_len: Civic location data length
892 struct cfg80211_beacon_data {
893 const u8 *head, *tail;
894 const u8 *beacon_ies;
895 const u8 *proberesp_ies;
896 const u8 *assocresp_ies;
897 const u8 *probe_resp;
902 size_t head_len, tail_len;
903 size_t beacon_ies_len;
904 size_t proberesp_ies_len;
905 size_t assocresp_ies_len;
906 size_t probe_resp_len;
916 * struct cfg80211_acl_data - Access control list data
918 * @acl_policy: ACL policy to be applied on the station's
919 * entry specified by mac_addr
920 * @n_acl_entries: Number of MAC address entries passed
921 * @mac_addrs: List of MAC addresses of stations to be used for ACL
923 struct cfg80211_acl_data {
924 enum nl80211_acl_policy acl_policy;
928 struct mac_address mac_addrs[];
932 * cfg80211_bitrate_mask - masks for bitrate control
934 struct cfg80211_bitrate_mask {
937 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
938 u16 vht_mcs[NL80211_VHT_NSS_MAX];
939 enum nl80211_txrate_gi gi;
940 } control[NUM_NL80211_BANDS];
944 * enum cfg80211_ap_settings_flags - AP settings flags
946 * Used by cfg80211_ap_settings
948 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
950 enum cfg80211_ap_settings_flags {
951 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
955 * struct cfg80211_ap_settings - AP configuration
957 * Used to configure an AP interface.
959 * @chandef: defines the channel to use
960 * @beacon: beacon data
961 * @beacon_interval: beacon interval
962 * @dtim_period: DTIM period
963 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
965 * @ssid_len: length of @ssid
966 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
967 * @crypto: crypto settings
968 * @privacy: the BSS uses privacy
969 * @auth_type: Authentication type (algorithm)
970 * @smps_mode: SMPS mode
971 * @inactivity_timeout: time in seconds to determine station's inactivity.
972 * @p2p_ctwindow: P2P CT Window
973 * @p2p_opp_ps: P2P opportunistic PS
974 * @acl: ACL configuration used by the drivers which has support for
975 * MAC address based access control
976 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
978 * @beacon_rate: bitrate to be used for beacons
979 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
980 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
981 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
982 * @ht_required: stations must support HT
983 * @vht_required: stations must support VHT
984 * @twt_responder: Enable Target Wait Time
985 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
986 * @he_obss_pd: OBSS Packet Detection settings
988 struct cfg80211_ap_settings {
989 struct cfg80211_chan_def chandef;
991 struct cfg80211_beacon_data beacon;
993 int beacon_interval, dtim_period;
996 enum nl80211_hidden_ssid hidden_ssid;
997 struct cfg80211_crypto_settings crypto;
999 enum nl80211_auth_type auth_type;
1000 enum nl80211_smps_mode smps_mode;
1001 int inactivity_timeout;
1004 const struct cfg80211_acl_data *acl;
1006 struct cfg80211_bitrate_mask beacon_rate;
1008 const struct ieee80211_ht_cap *ht_cap;
1009 const struct ieee80211_vht_cap *vht_cap;
1010 const struct ieee80211_he_cap_elem *he_cap;
1011 bool ht_required, vht_required;
1014 struct ieee80211_he_obss_pd he_obss_pd;
1018 * struct cfg80211_csa_settings - channel switch settings
1020 * Used for channel switch
1022 * @chandef: defines the channel to use after the switch
1023 * @beacon_csa: beacon data while performing the switch
1024 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1025 * @counter_offsets_presp: offsets of the counters within the probe response
1026 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1027 * @n_counter_offsets_presp: number of csa counters in the probe response
1028 * @beacon_after: beacon data to be used on the new channel
1029 * @radar_required: whether radar detection is required on the new channel
1030 * @block_tx: whether transmissions should be blocked while changing
1031 * @count: number of beacons until switch
1033 struct cfg80211_csa_settings {
1034 struct cfg80211_chan_def chandef;
1035 struct cfg80211_beacon_data beacon_csa;
1036 const u16 *counter_offsets_beacon;
1037 const u16 *counter_offsets_presp;
1038 unsigned int n_counter_offsets_beacon;
1039 unsigned int n_counter_offsets_presp;
1040 struct cfg80211_beacon_data beacon_after;
1041 bool radar_required;
1046 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1049 * struct iface_combination_params - input parameters for interface combinations
1051 * Used to pass interface combination parameters
1053 * @num_different_channels: the number of different channels we want
1054 * to use for verification
1055 * @radar_detect: a bitmap where each bit corresponds to a channel
1056 * width where radar detection is needed, as in the definition of
1057 * &struct ieee80211_iface_combination.@radar_detect_widths
1058 * @iftype_num: array with the number of interfaces of each interface
1059 * type. The index is the interface type as specified in &enum
1061 * @new_beacon_int: set this to the beacon interval of a new interface
1062 * that's not operating yet, if such is to be checked as part of
1065 struct iface_combination_params {
1066 int num_different_channels;
1068 int iftype_num[NUM_NL80211_IFTYPES];
1073 * enum station_parameters_apply_mask - station parameter values to apply
1074 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1075 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1076 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1078 * Not all station parameters have in-band "no change" signalling,
1079 * for those that don't these flags will are used.
1081 enum station_parameters_apply_mask {
1082 STATION_PARAM_APPLY_UAPSD = BIT(0),
1083 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1084 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1085 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1089 * struct sta_txpwr - station txpower configuration
1091 * Used to configure txpower for station.
1093 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1094 * is not provided, the default per-interface tx power setting will be
1095 * overriding. Driver should be picking up the lowest tx power, either tx
1096 * power per-interface or per-station.
1097 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1098 * will be less than or equal to specified from userspace, whereas if TPC
1099 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1100 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1105 enum nl80211_tx_power_setting type;
1109 * struct station_parameters - station parameters
1111 * Used to change and create a new station.
1113 * @vlan: vlan interface station should belong to
1114 * @supported_rates: supported rates in IEEE 802.11 format
1115 * (or NULL for no change)
1116 * @supported_rates_len: number of supported rates
1117 * @sta_flags_mask: station flags that changed
1118 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1119 * @sta_flags_set: station flags values
1120 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1121 * @listen_interval: listen interval or -1 for no change
1122 * @aid: AID or zero for no change
1123 * @peer_aid: mesh peer AID or zero for no change
1124 * @plink_action: plink action to take
1125 * @plink_state: set the peer link state for a station
1126 * @ht_capa: HT capabilities of station
1127 * @vht_capa: VHT capabilities of station
1128 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1129 * as the AC bitmap in the QoS info field
1130 * @max_sp: max Service Period. same format as the MAX_SP in the
1131 * QoS info field (but already shifted down)
1132 * @sta_modify_mask: bitmap indicating which parameters changed
1133 * (for those that don't have a natural "no change" value),
1134 * see &enum station_parameters_apply_mask
1135 * @local_pm: local link-specific mesh power save mode (no change when set
1137 * @capability: station capability
1138 * @ext_capab: extended capabilities of the station
1139 * @ext_capab_len: number of extended capabilities
1140 * @supported_channels: supported channels in IEEE 802.11 format
1141 * @supported_channels_len: number of supported channels
1142 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1143 * @supported_oper_classes_len: number of supported operating classes
1144 * @opmode_notif: operating mode field from Operating Mode Notification
1145 * @opmode_notif_used: information if operating mode field is used
1146 * @support_p2p_ps: information if station supports P2P PS mechanism
1147 * @he_capa: HE capabilities of station
1148 * @he_capa_len: the length of the HE capabilities
1149 * @airtime_weight: airtime scheduler weight for this station
1151 struct station_parameters {
1152 const u8 *supported_rates;
1153 struct net_device *vlan;
1154 u32 sta_flags_mask, sta_flags_set;
1155 u32 sta_modify_mask;
1156 int listen_interval;
1159 u8 supported_rates_len;
1162 const struct ieee80211_ht_cap *ht_capa;
1163 const struct ieee80211_vht_cap *vht_capa;
1166 enum nl80211_mesh_power_mode local_pm;
1168 const u8 *ext_capab;
1170 const u8 *supported_channels;
1171 u8 supported_channels_len;
1172 const u8 *supported_oper_classes;
1173 u8 supported_oper_classes_len;
1175 bool opmode_notif_used;
1177 const struct ieee80211_he_cap_elem *he_capa;
1180 struct sta_txpwr txpwr;
1184 * struct station_del_parameters - station deletion parameters
1186 * Used to delete a station entry (or all stations).
1188 * @mac: MAC address of the station to remove or NULL to remove all stations
1189 * @subtype: Management frame subtype to use for indicating removal
1190 * (10 = Disassociation, 12 = Deauthentication)
1191 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1193 struct station_del_parameters {
1200 * enum cfg80211_station_type - the type of station being modified
1201 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1202 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1203 * unassociated (update properties for this type of client is permitted)
1204 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1205 * the AP MLME in the device
1206 * @CFG80211_STA_AP_STA: AP station on managed interface
1207 * @CFG80211_STA_IBSS: IBSS station
1208 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1209 * while TDLS setup is in progress, it moves out of this state when
1210 * being marked authorized; use this only if TDLS with external setup is
1212 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1213 * entry that is operating, has been marked authorized by userspace)
1214 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1215 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1217 enum cfg80211_station_type {
1218 CFG80211_STA_AP_CLIENT,
1219 CFG80211_STA_AP_CLIENT_UNASSOC,
1220 CFG80211_STA_AP_MLME_CLIENT,
1221 CFG80211_STA_AP_STA,
1223 CFG80211_STA_TDLS_PEER_SETUP,
1224 CFG80211_STA_TDLS_PEER_ACTIVE,
1225 CFG80211_STA_MESH_PEER_KERNEL,
1226 CFG80211_STA_MESH_PEER_USER,
1230 * cfg80211_check_station_change - validate parameter changes
1231 * @wiphy: the wiphy this operates on
1232 * @params: the new parameters for a station
1233 * @statype: the type of station being modified
1235 * Utility function for the @change_station driver method. Call this function
1236 * with the appropriate station type looking up the station (and checking that
1237 * it exists). It will verify whether the station change is acceptable, and if
1238 * not will return an error code. Note that it may modify the parameters for
1239 * backward compatibility reasons, so don't use them before calling this.
1241 int cfg80211_check_station_change(struct wiphy *wiphy,
1242 struct station_parameters *params,
1243 enum cfg80211_station_type statype);
1246 * enum station_info_rate_flags - bitrate info flags
1248 * Used by the driver to indicate the specific rate transmission
1249 * type for 802.11n transmissions.
1251 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1252 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1253 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1254 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1255 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1256 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1258 enum rate_info_flags {
1259 RATE_INFO_FLAGS_MCS = BIT(0),
1260 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1261 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1262 RATE_INFO_FLAGS_DMG = BIT(3),
1263 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1264 RATE_INFO_FLAGS_EDMG = BIT(5),
1268 * enum rate_info_bw - rate bandwidth information
1270 * Used by the driver to indicate the rate bandwidth.
1272 * @RATE_INFO_BW_5: 5 MHz bandwidth
1273 * @RATE_INFO_BW_10: 10 MHz bandwidth
1274 * @RATE_INFO_BW_20: 20 MHz bandwidth
1275 * @RATE_INFO_BW_40: 40 MHz bandwidth
1276 * @RATE_INFO_BW_80: 80 MHz bandwidth
1277 * @RATE_INFO_BW_160: 160 MHz bandwidth
1278 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1281 RATE_INFO_BW_20 = 0,
1291 * struct rate_info - bitrate information
1293 * Information about a receiving or transmitting bitrate
1295 * @flags: bitflag of flags from &enum rate_info_flags
1296 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1297 * @legacy: bitrate in 100kbit/s for 802.11abg
1298 * @nss: number of streams (VHT & HE only)
1299 * @bw: bandwidth (from &enum rate_info_bw)
1300 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1301 * @he_dcm: HE DCM value
1302 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1303 * only valid if bw is %RATE_INFO_BW_HE_RU)
1304 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1319 * enum station_info_rate_flags - bitrate info flags
1321 * Used by the driver to indicate the specific rate transmission
1322 * type for 802.11n transmissions.
1324 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1325 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1326 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1328 enum bss_param_flags {
1329 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1330 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1331 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1335 * struct sta_bss_parameters - BSS parameters for the attached station
1337 * Information about the currently associated BSS
1339 * @flags: bitflag of flags from &enum bss_param_flags
1340 * @dtim_period: DTIM period for the BSS
1341 * @beacon_interval: beacon interval
1343 struct sta_bss_parameters {
1346 u16 beacon_interval;
1350 * struct cfg80211_txq_stats - TXQ statistics for this TID
1351 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1352 * indicate the relevant values in this struct are filled
1353 * @backlog_bytes: total number of bytes currently backlogged
1354 * @backlog_packets: total number of packets currently backlogged
1355 * @flows: number of new flows seen
1356 * @drops: total number of packets dropped
1357 * @ecn_marks: total number of packets marked with ECN CE
1358 * @overlimit: number of drops due to queue space overflow
1359 * @overmemory: number of drops due to memory limit overflow
1360 * @collisions: number of hash collisions
1361 * @tx_bytes: total number of bytes dequeued
1362 * @tx_packets: total number of packets dequeued
1363 * @max_flows: maximum number of flows supported
1365 struct cfg80211_txq_stats {
1368 u32 backlog_packets;
1381 * struct cfg80211_tid_stats - per-TID statistics
1382 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1383 * indicate the relevant values in this struct are filled
1384 * @rx_msdu: number of received MSDUs
1385 * @tx_msdu: number of (attempted) transmitted MSDUs
1386 * @tx_msdu_retries: number of retries (not counting the first) for
1388 * @tx_msdu_failed: number of failed transmitted MSDUs
1389 * @txq_stats: TXQ statistics
1391 struct cfg80211_tid_stats {
1395 u64 tx_msdu_retries;
1397 struct cfg80211_txq_stats txq_stats;
1400 #define IEEE80211_MAX_CHAINS 4
1403 * struct station_info - station information
1405 * Station information filled by driver for get_station() and dump_station.
1407 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1408 * indicate the relevant values in this struct for them
1409 * @connected_time: time(in secs) since a station is last connected
1410 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1411 * @assoc_at: bootime (ns) of the last association
1412 * @rx_bytes: bytes (size of MPDUs) received from this station
1413 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1414 * @llid: mesh local link id
1415 * @plid: mesh peer link id
1416 * @plink_state: mesh peer link state
1417 * @signal: The signal strength, type depends on the wiphy's signal_type.
1418 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1419 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1420 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1421 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1422 * @chain_signal: per-chain signal strength of last received packet in dBm
1423 * @chain_signal_avg: per-chain signal strength average in dBm
1424 * @txrate: current unicast bitrate from this station
1425 * @rxrate: current unicast bitrate to this station
1426 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1427 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1428 * @tx_retries: cumulative retry counts (MPDUs)
1429 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1430 * @rx_dropped_misc: Dropped for un-specified reason.
1431 * @bss_param: current BSS parameters
1432 * @generation: generation number for nl80211 dumps.
1433 * This number should increase every time the list of stations
1434 * changes, i.e. when a station is added or removed, so that
1435 * userspace can tell whether it got a consistent snapshot.
1436 * @assoc_req_ies: IEs from (Re)Association Request.
1437 * This is used only when in AP mode with drivers that do not use
1438 * user space MLME/SME implementation. The information is provided for
1439 * the cfg80211_new_sta() calls to notify user space of the IEs.
1440 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1441 * @sta_flags: station flags mask & values
1442 * @beacon_loss_count: Number of times beacon loss event has triggered.
1443 * @t_offset: Time offset of the station relative to this host.
1444 * @local_pm: local mesh STA power save mode
1445 * @peer_pm: peer mesh STA power save mode
1446 * @nonpeer_pm: non-peer mesh STA power save mode
1447 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1448 * towards this station.
1449 * @rx_beacon: number of beacons received from this peer
1450 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1452 * @connected_to_gate: true if mesh STA has a path to mesh gate
1453 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1454 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1455 * @airtime_weight: current airtime scheduling weight
1456 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1457 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1458 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1459 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1460 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1462 * @rx_mpdu_count: number of MPDUs received from this station
1463 * @fcs_err_count: number of packets (MPDUs) received from this station with
1464 * an FCS error. This counter should be incremented only when TA of the
1465 * received packet with an FCS error matches the peer MAC address.
1466 * @airtime_link_metric: mesh airtime link metric.
1468 struct station_info {
1482 s8 chain_signal[IEEE80211_MAX_CHAINS];
1483 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1485 struct rate_info txrate;
1486 struct rate_info rxrate;
1491 u32 rx_dropped_misc;
1492 struct sta_bss_parameters bss_param;
1493 struct nl80211_sta_flag_update sta_flags;
1497 const u8 *assoc_req_ies;
1498 size_t assoc_req_ies_len;
1500 u32 beacon_loss_count;
1502 enum nl80211_mesh_power_mode local_pm;
1503 enum nl80211_mesh_power_mode peer_pm;
1504 enum nl80211_mesh_power_mode nonpeer_pm;
1506 u32 expected_throughput;
1511 u8 rx_beacon_signal_avg;
1512 u8 connected_to_gate;
1514 struct cfg80211_tid_stats *pertid;
1523 u32 airtime_link_metric;
1526 #if IS_ENABLED(CONFIG_CFG80211)
1528 * cfg80211_get_station - retrieve information about a given station
1529 * @dev: the device where the station is supposed to be connected to
1530 * @mac_addr: the mac address of the station of interest
1531 * @sinfo: pointer to the structure to fill with the information
1533 * Returns 0 on success and sinfo is filled with the available information
1534 * otherwise returns a negative error code and the content of sinfo has to be
1535 * considered undefined.
1537 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1538 struct station_info *sinfo);
1540 static inline int cfg80211_get_station(struct net_device *dev,
1542 struct station_info *sinfo)
1549 * enum monitor_flags - monitor flags
1551 * Monitor interface configuration flags. Note that these must be the bits
1552 * according to the nl80211 flags.
1554 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1555 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1556 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1557 * @MONITOR_FLAG_CONTROL: pass control frames
1558 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1559 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1560 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1562 enum monitor_flags {
1563 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1564 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1565 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1566 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1567 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1568 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1569 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1573 * enum mpath_info_flags - mesh path information flags
1575 * Used by the driver to indicate which info in &struct mpath_info it has filled
1576 * in during get_station() or dump_station().
1578 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1579 * @MPATH_INFO_SN: @sn filled
1580 * @MPATH_INFO_METRIC: @metric filled
1581 * @MPATH_INFO_EXPTIME: @exptime filled
1582 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1583 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1584 * @MPATH_INFO_FLAGS: @flags filled
1585 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1586 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1588 enum mpath_info_flags {
1589 MPATH_INFO_FRAME_QLEN = BIT(0),
1590 MPATH_INFO_SN = BIT(1),
1591 MPATH_INFO_METRIC = BIT(2),
1592 MPATH_INFO_EXPTIME = BIT(3),
1593 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1594 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1595 MPATH_INFO_FLAGS = BIT(6),
1596 MPATH_INFO_HOP_COUNT = BIT(7),
1597 MPATH_INFO_PATH_CHANGE = BIT(8),
1601 * struct mpath_info - mesh path information
1603 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1605 * @filled: bitfield of flags from &enum mpath_info_flags
1606 * @frame_qlen: number of queued frames for this destination
1607 * @sn: target sequence number
1608 * @metric: metric (cost) of this mesh path
1609 * @exptime: expiration time for the mesh path from now, in msecs
1610 * @flags: mesh path flags
1611 * @discovery_timeout: total mesh path discovery timeout, in msecs
1612 * @discovery_retries: mesh path discovery retries
1613 * @generation: generation number for nl80211 dumps.
1614 * This number should increase every time the list of mesh paths
1615 * changes, i.e. when a station is added or removed, so that
1616 * userspace can tell whether it got a consistent snapshot.
1617 * @hop_count: hops to destination
1618 * @path_change_count: total number of path changes to destination
1626 u32 discovery_timeout;
1627 u8 discovery_retries;
1630 u32 path_change_count;
1636 * struct bss_parameters - BSS parameters
1638 * Used to change BSS parameters (mainly for AP mode).
1640 * @use_cts_prot: Whether to use CTS protection
1641 * (0 = no, 1 = yes, -1 = do not change)
1642 * @use_short_preamble: Whether the use of short preambles is allowed
1643 * (0 = no, 1 = yes, -1 = do not change)
1644 * @use_short_slot_time: Whether the use of short slot time is allowed
1645 * (0 = no, 1 = yes, -1 = do not change)
1646 * @basic_rates: basic rates in IEEE 802.11 format
1647 * (or NULL for no change)
1648 * @basic_rates_len: number of basic rates
1649 * @ap_isolate: do not forward packets between connected stations
1650 * @ht_opmode: HT Operation mode
1651 * (u16 = opmode, -1 = do not change)
1652 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1653 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1655 struct bss_parameters {
1657 int use_short_preamble;
1658 int use_short_slot_time;
1659 const u8 *basic_rates;
1663 s8 p2p_ctwindow, p2p_opp_ps;
1667 * struct mesh_config - 802.11s mesh configuration
1669 * These parameters can be changed while the mesh is active.
1671 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1672 * by the Mesh Peering Open message
1673 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1674 * used by the Mesh Peering Open message
1675 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1676 * the mesh peering management to close a mesh peering
1677 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1679 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1680 * be sent to establish a new peer link instance in a mesh
1681 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1682 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1684 * @auto_open_plinks: whether we should automatically open peer links when we
1685 * detect compatible mesh peers
1686 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1687 * synchronize to for 11s default synchronization method
1688 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1689 * that an originator mesh STA can send to a particular path target
1690 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1691 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1692 * a path discovery in milliseconds
1693 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1694 * receiving a PREQ shall consider the forwarding information from the
1695 * root to be valid. (TU = time unit)
1696 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1697 * which a mesh STA can send only one action frame containing a PREQ
1699 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1700 * which a mesh STA can send only one Action frame containing a PERR
1702 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1703 * it takes for an HWMP information element to propagate across the mesh
1704 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1705 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1706 * announcements are transmitted
1707 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1708 * station has access to a broader network beyond the MBSS. (This is
1709 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1710 * only means that the station will announce others it's a mesh gate, but
1711 * not necessarily using the gate announcement protocol. Still keeping the
1712 * same nomenclature to be in sync with the spec)
1713 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1714 * entity (default is TRUE - forwarding entity)
1715 * @rssi_threshold: the threshold for average signal strength of candidate
1716 * station to establish a peer link
1717 * @ht_opmode: mesh HT protection mode
1719 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1720 * receiving a proactive PREQ shall consider the forwarding information to
1721 * the root mesh STA to be valid.
1723 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1724 * PREQs are transmitted.
1725 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1726 * during which a mesh STA can send only one Action frame containing
1727 * a PREQ element for root path confirmation.
1728 * @power_mode: The default mesh power save mode which will be the initial
1729 * setting for new peer links.
1730 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1731 * after transmitting its beacon.
1732 * @plink_timeout: If no tx activity is seen from a STA we've established
1733 * peering with for longer than this time (in seconds), then remove it
1734 * from the STA's list of peers. Default is 30 minutes.
1735 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1736 * connected to a mesh gate in mesh formation info. If false, the
1737 * value in mesh formation is determined by the presence of root paths
1738 * in the mesh path table
1740 struct mesh_config {
1741 u16 dot11MeshRetryTimeout;
1742 u16 dot11MeshConfirmTimeout;
1743 u16 dot11MeshHoldingTimeout;
1744 u16 dot11MeshMaxPeerLinks;
1745 u8 dot11MeshMaxRetries;
1748 bool auto_open_plinks;
1749 u32 dot11MeshNbrOffsetMaxNeighbor;
1750 u8 dot11MeshHWMPmaxPREQretries;
1751 u32 path_refresh_time;
1752 u16 min_discovery_timeout;
1753 u32 dot11MeshHWMPactivePathTimeout;
1754 u16 dot11MeshHWMPpreqMinInterval;
1755 u16 dot11MeshHWMPperrMinInterval;
1756 u16 dot11MeshHWMPnetDiameterTraversalTime;
1757 u8 dot11MeshHWMPRootMode;
1758 bool dot11MeshConnectedToMeshGate;
1759 u16 dot11MeshHWMPRannInterval;
1760 bool dot11MeshGateAnnouncementProtocol;
1761 bool dot11MeshForwarding;
1764 u32 dot11MeshHWMPactivePathToRootTimeout;
1765 u16 dot11MeshHWMProotInterval;
1766 u16 dot11MeshHWMPconfirmationInterval;
1767 enum nl80211_mesh_power_mode power_mode;
1768 u16 dot11MeshAwakeWindowDuration;
1773 * struct mesh_setup - 802.11s mesh setup configuration
1774 * @chandef: defines the channel to use
1775 * @mesh_id: the mesh ID
1776 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1777 * @sync_method: which synchronization method to use
1778 * @path_sel_proto: which path selection protocol to use
1779 * @path_metric: which metric to use
1780 * @auth_id: which authentication method this mesh is using
1781 * @ie: vendor information elements (optional)
1782 * @ie_len: length of vendor information elements
1783 * @is_authenticated: this mesh requires authentication
1784 * @is_secure: this mesh uses security
1785 * @user_mpm: userspace handles all MPM functions
1786 * @dtim_period: DTIM period to use
1787 * @beacon_interval: beacon interval to use
1788 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1789 * @basic_rates: basic rates to use when creating the mesh
1790 * @beacon_rate: bitrate to be used for beacons
1791 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1792 * changes the channel when a radar is detected. This is required
1793 * to operate on DFS channels.
1794 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1795 * port frames over NL80211 instead of the network interface.
1797 * These parameters are fixed when the mesh is created.
1800 struct cfg80211_chan_def chandef;
1809 bool is_authenticated;
1813 u16 beacon_interval;
1814 int mcast_rate[NUM_NL80211_BANDS];
1816 struct cfg80211_bitrate_mask beacon_rate;
1817 bool userspace_handles_dfs;
1818 bool control_port_over_nl80211;
1822 * struct ocb_setup - 802.11p OCB mode setup configuration
1823 * @chandef: defines the channel to use
1825 * These parameters are fixed when connecting to the network
1828 struct cfg80211_chan_def chandef;
1832 * struct ieee80211_txq_params - TX queue parameters
1833 * @ac: AC identifier
1834 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1835 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1837 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1839 * @aifs: Arbitration interframe space [0..255]
1841 struct ieee80211_txq_params {
1850 * DOC: Scanning and BSS list handling
1852 * The scanning process itself is fairly simple, but cfg80211 offers quite
1853 * a bit of helper functionality. To start a scan, the scan operation will
1854 * be invoked with a scan definition. This scan definition contains the
1855 * channels to scan, and the SSIDs to send probe requests for (including the
1856 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1857 * probe. Additionally, a scan request may contain extra information elements
1858 * that should be added to the probe request. The IEs are guaranteed to be
1859 * well-formed, and will not exceed the maximum length the driver advertised
1860 * in the wiphy structure.
1862 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1863 * it is responsible for maintaining the BSS list; the driver should not
1864 * maintain a list itself. For this notification, various functions exist.
1866 * Since drivers do not maintain a BSS list, there are also a number of
1867 * functions to search for a BSS and obtain information about it from the
1868 * BSS structure cfg80211 maintains. The BSS list is also made available
1873 * struct cfg80211_ssid - SSID description
1875 * @ssid_len: length of the ssid
1877 struct cfg80211_ssid {
1878 u8 ssid[IEEE80211_MAX_SSID_LEN];
1883 * struct cfg80211_scan_info - information about completed scan
1884 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1885 * wireless device that requested the scan is connected to. If this
1886 * information is not available, this field is left zero.
1887 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1888 * @aborted: set to true if the scan was aborted for any reason,
1889 * userspace will be notified of that
1891 struct cfg80211_scan_info {
1893 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1898 * struct cfg80211_scan_request - scan request description
1900 * @ssids: SSIDs to scan for (active scan only)
1901 * @n_ssids: number of SSIDs
1902 * @channels: channels to scan on.
1903 * @n_channels: total number of channels to scan
1904 * @scan_width: channel width for scanning
1905 * @ie: optional information element(s) to add into Probe Request or %NULL
1906 * @ie_len: length of ie in octets
1907 * @duration: how long to listen on each channel, in TUs. If
1908 * %duration_mandatory is not set, this is the maximum dwell time and
1909 * the actual dwell time may be shorter.
1910 * @duration_mandatory: if set, the scan duration must be as specified by the
1912 * @flags: bit field of flags controlling operation
1913 * @rates: bitmap of rates to advertise for each band
1914 * @wiphy: the wiphy this was for
1915 * @scan_start: time (in jiffies) when the scan started
1916 * @wdev: the wireless device to scan for
1917 * @info: (internal) information about completed scan
1918 * @notified: (internal) scan request was notified as done or aborted
1919 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1920 * @mac_addr: MAC address used with randomisation
1921 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1922 * are 0 in the mask should be randomised, bits that are 1 should
1923 * be taken from the @mac_addr
1924 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1926 struct cfg80211_scan_request {
1927 struct cfg80211_ssid *ssids;
1930 enum nl80211_bss_scan_width scan_width;
1934 bool duration_mandatory;
1937 u32 rates[NUM_NL80211_BANDS];
1939 struct wireless_dev *wdev;
1941 u8 mac_addr[ETH_ALEN] __aligned(2);
1942 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1943 u8 bssid[ETH_ALEN] __aligned(2);
1946 struct wiphy *wiphy;
1947 unsigned long scan_start;
1948 struct cfg80211_scan_info info;
1953 struct ieee80211_channel *channels[0];
1956 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1960 get_random_bytes(buf, ETH_ALEN);
1961 for (i = 0; i < ETH_ALEN; i++) {
1963 buf[i] |= addr[i] & mask[i];
1968 * struct cfg80211_match_set - sets of attributes to match
1970 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1971 * or no match (RSSI only)
1972 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1973 * or no match (RSSI only)
1974 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1975 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
1976 * for filtering out scan results received. Drivers advertize this support
1977 * of band specific rssi based filtering through the feature capability
1978 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
1979 * specific rssi thresholds take precedence over rssi_thold, if specified.
1980 * If not specified for any band, it will be assigned with rssi_thold of
1981 * corresponding matchset.
1983 struct cfg80211_match_set {
1984 struct cfg80211_ssid ssid;
1987 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
1991 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1993 * @interval: interval between scheduled scan iterations. In seconds.
1994 * @iterations: number of scan iterations in this scan plan. Zero means
1996 * The last scan plan will always have this parameter set to zero,
1997 * all other scan plans will have a finite number of iterations.
1999 struct cfg80211_sched_scan_plan {
2005 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2007 * @band: band of BSS which should match for RSSI level adjustment.
2008 * @delta: value of RSSI level adjustment.
2010 struct cfg80211_bss_select_adjust {
2011 enum nl80211_band band;
2016 * struct cfg80211_sched_scan_request - scheduled scan request description
2018 * @reqid: identifies this request.
2019 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2020 * @n_ssids: number of SSIDs
2021 * @n_channels: total number of channels to scan
2022 * @scan_width: channel width for scanning
2023 * @ie: optional information element(s) to add into Probe Request or %NULL
2024 * @ie_len: length of ie in octets
2025 * @flags: bit field of flags controlling operation
2026 * @match_sets: sets of parameters to be matched for a scan result
2027 * entry to be considered valid and to be passed to the host
2028 * (others are filtered out).
2029 * If ommited, all results are passed.
2030 * @n_match_sets: number of match sets
2031 * @report_results: indicates that results were reported for this request
2032 * @wiphy: the wiphy this was for
2033 * @dev: the interface
2034 * @scan_start: start time of the scheduled scan
2035 * @channels: channels to scan
2036 * @min_rssi_thold: for drivers only supporting a single threshold, this
2037 * contains the minimum over all matchsets
2038 * @mac_addr: MAC address used with randomisation
2039 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2040 * are 0 in the mask should be randomised, bits that are 1 should
2041 * be taken from the @mac_addr
2042 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2043 * index must be executed first.
2044 * @n_scan_plans: number of scan plans, at least 1.
2045 * @rcu_head: RCU callback used to free the struct
2046 * @owner_nlportid: netlink portid of owner (if this should is a request
2047 * owned by a particular socket)
2048 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2049 * @list: for keeping list of requests.
2050 * @delay: delay in seconds to use before starting the first scan
2051 * cycle. The driver may ignore this parameter and start
2052 * immediately (or at any other time), if this feature is not
2054 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2055 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2056 * reporting in connected state to cases where a matching BSS is determined
2057 * to have better or slightly worse RSSI than the current connected BSS.
2058 * The relative RSSI threshold values are ignored in disconnected state.
2059 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2060 * to the specified band while deciding whether a better BSS is reported
2061 * using @relative_rssi. If delta is a negative number, the BSSs that
2062 * belong to the specified band will be penalized by delta dB in relative
2065 struct cfg80211_sched_scan_request {
2067 struct cfg80211_ssid *ssids;
2070 enum nl80211_bss_scan_width scan_width;
2074 struct cfg80211_match_set *match_sets;
2078 struct cfg80211_sched_scan_plan *scan_plans;
2081 u8 mac_addr[ETH_ALEN] __aligned(2);
2082 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2084 bool relative_rssi_set;
2086 struct cfg80211_bss_select_adjust rssi_adjust;
2089 struct wiphy *wiphy;
2090 struct net_device *dev;
2091 unsigned long scan_start;
2092 bool report_results;
2093 struct rcu_head rcu_head;
2096 struct list_head list;
2099 struct ieee80211_channel *channels[0];
2103 * enum cfg80211_signal_type - signal type
2105 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2106 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2107 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2109 enum cfg80211_signal_type {
2110 CFG80211_SIGNAL_TYPE_NONE,
2111 CFG80211_SIGNAL_TYPE_MBM,
2112 CFG80211_SIGNAL_TYPE_UNSPEC,
2116 * struct cfg80211_inform_bss - BSS inform data
2117 * @chan: channel the frame was received on
2118 * @scan_width: scan width that was used
2119 * @signal: signal strength value, according to the wiphy's
2121 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2122 * received; should match the time when the frame was actually
2123 * received by the device (not just by the host, in case it was
2124 * buffered on the device) and be accurate to about 10ms.
2125 * If the frame isn't buffered, just passing the return value of
2126 * ktime_get_boottime_ns() is likely appropriate.
2127 * @parent_tsf: the time at the start of reception of the first octet of the
2128 * timestamp field of the frame. The time is the TSF of the BSS specified
2130 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2131 * the BSS that requested the scan in which the beacon/probe was received.
2132 * @chains: bitmask for filled values in @chain_signal.
2133 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2135 struct cfg80211_inform_bss {
2136 struct ieee80211_channel *chan;
2137 enum nl80211_bss_scan_width scan_width;
2141 u8 parent_bssid[ETH_ALEN] __aligned(2);
2143 s8 chain_signal[IEEE80211_MAX_CHAINS];
2147 * struct cfg80211_bss_ies - BSS entry IE data
2148 * @tsf: TSF contained in the frame that carried these IEs
2149 * @rcu_head: internal use, for freeing
2150 * @len: length of the IEs
2151 * @from_beacon: these IEs are known to come from a beacon
2154 struct cfg80211_bss_ies {
2156 struct rcu_head rcu_head;
2163 * struct cfg80211_bss - BSS description
2165 * This structure describes a BSS (which may also be a mesh network)
2166 * for use in scan results and similar.
2168 * @channel: channel this BSS is on
2169 * @scan_width: width of the control channel
2170 * @bssid: BSSID of the BSS
2171 * @beacon_interval: the beacon interval as from the frame
2172 * @capability: the capability field in host byte order
2173 * @ies: the information elements (Note that there is no guarantee that these
2174 * are well-formed!); this is a pointer to either the beacon_ies or
2175 * proberesp_ies depending on whether Probe Response frame has been
2176 * received. It is always non-%NULL.
2177 * @beacon_ies: the information elements from the last Beacon frame
2178 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2179 * own the beacon_ies, but they're just pointers to the ones from the
2180 * @hidden_beacon_bss struct)
2181 * @proberesp_ies: the information elements from the last Probe Response frame
2182 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2183 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2184 * that holds the beacon data. @beacon_ies is still valid, of course, and
2185 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2186 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2187 * non-transmitted one (multi-BSSID support)
2188 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2189 * (multi-BSSID support)
2190 * @signal: signal strength value (type depends on the wiphy's signal_type)
2191 * @chains: bitmask for filled values in @chain_signal.
2192 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2193 * @bssid_index: index in the multiple BSS set
2194 * @max_bssid_indicator: max number of members in the BSS set
2195 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2197 struct cfg80211_bss {
2198 struct ieee80211_channel *channel;
2199 enum nl80211_bss_scan_width scan_width;
2201 const struct cfg80211_bss_ies __rcu *ies;
2202 const struct cfg80211_bss_ies __rcu *beacon_ies;
2203 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2205 struct cfg80211_bss *hidden_beacon_bss;
2206 struct cfg80211_bss *transmitted_bss;
2207 struct list_head nontrans_list;
2211 u16 beacon_interval;
2216 s8 chain_signal[IEEE80211_MAX_CHAINS];
2219 u8 max_bssid_indicator;
2221 u8 priv[0] __aligned(sizeof(void *));
2225 * ieee80211_bss_get_elem - find element with given ID
2226 * @bss: the bss to search
2227 * @id: the element ID
2229 * Note that the return value is an RCU-protected pointer, so
2230 * rcu_read_lock() must be held when calling this function.
2231 * Return: %NULL if not found.
2233 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2236 * ieee80211_bss_get_ie - find IE with given ID
2237 * @bss: the bss to search
2238 * @id: the element ID
2240 * Note that the return value is an RCU-protected pointer, so
2241 * rcu_read_lock() must be held when calling this function.
2242 * Return: %NULL if not found.
2244 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2246 return (void *)ieee80211_bss_get_elem(bss, id);
2251 * struct cfg80211_auth_request - Authentication request data
2253 * This structure provides information needed to complete IEEE 802.11
2256 * @bss: The BSS to authenticate with, the callee must obtain a reference
2257 * to it if it needs to keep it.
2258 * @auth_type: Authentication type (algorithm)
2259 * @ie: Extra IEs to add to Authentication frame or %NULL
2260 * @ie_len: Length of ie buffer in octets
2261 * @key_len: length of WEP key for shared key authentication
2262 * @key_idx: index of WEP key for shared key authentication
2263 * @key: WEP key for shared key authentication
2264 * @auth_data: Fields and elements in Authentication frames. This contains
2265 * the authentication frame body (non-IE and IE data), excluding the
2266 * Authentication algorithm number, i.e., starting at the Authentication
2267 * transaction sequence number field.
2268 * @auth_data_len: Length of auth_data buffer in octets
2270 struct cfg80211_auth_request {
2271 struct cfg80211_bss *bss;
2274 enum nl80211_auth_type auth_type;
2276 u8 key_len, key_idx;
2277 const u8 *auth_data;
2278 size_t auth_data_len;
2282 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2284 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2285 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2286 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2287 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2288 * authentication capability. Drivers can offload authentication to
2289 * userspace if this flag is set. Only applicable for cfg80211_connect()
2290 * request (connect callback).
2292 enum cfg80211_assoc_req_flags {
2293 ASSOC_REQ_DISABLE_HT = BIT(0),
2294 ASSOC_REQ_DISABLE_VHT = BIT(1),
2295 ASSOC_REQ_USE_RRM = BIT(2),
2296 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2300 * struct cfg80211_assoc_request - (Re)Association request data
2302 * This structure provides information needed to complete IEEE 802.11
2304 * @bss: The BSS to associate with. If the call is successful the driver is
2305 * given a reference that it must give back to cfg80211_send_rx_assoc()
2306 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2307 * association requests while already associating must be rejected.
2308 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2309 * @ie_len: Length of ie buffer in octets
2310 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2311 * @crypto: crypto settings
2312 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2313 * to indicate a request to reassociate within the ESS instead of a request
2314 * do the initial association with the ESS. When included, this is set to
2315 * the BSSID of the current association, i.e., to the value that is
2316 * included in the Current AP address field of the Reassociation Request
2318 * @flags: See &enum cfg80211_assoc_req_flags
2319 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2320 * will be used in ht_capa. Un-supported values will be ignored.
2321 * @ht_capa_mask: The bits of ht_capa which are to be used.
2322 * @vht_capa: VHT capability override
2323 * @vht_capa_mask: VHT capability mask indicating which fields to use
2324 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2325 * %NULL if FILS is not used.
2326 * @fils_kek_len: Length of fils_kek in octets
2327 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2328 * Request/Response frame or %NULL if FILS is not used. This field starts
2329 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2331 struct cfg80211_assoc_request {
2332 struct cfg80211_bss *bss;
2333 const u8 *ie, *prev_bssid;
2335 struct cfg80211_crypto_settings crypto;
2338 struct ieee80211_ht_cap ht_capa;
2339 struct ieee80211_ht_cap ht_capa_mask;
2340 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2342 size_t fils_kek_len;
2343 const u8 *fils_nonces;
2347 * struct cfg80211_deauth_request - Deauthentication request data
2349 * This structure provides information needed to complete IEEE 802.11
2352 * @bssid: the BSSID of the BSS to deauthenticate from
2353 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2354 * @ie_len: Length of ie buffer in octets
2355 * @reason_code: The reason code for the deauthentication
2356 * @local_state_change: if set, change local state only and
2357 * do not set a deauth frame
2359 struct cfg80211_deauth_request {
2364 bool local_state_change;
2368 * struct cfg80211_disassoc_request - Disassociation request data
2370 * This structure provides information needed to complete IEEE 802.11
2373 * @bss: the BSS to disassociate from
2374 * @ie: Extra IEs to add to Disassociation frame or %NULL
2375 * @ie_len: Length of ie buffer in octets
2376 * @reason_code: The reason code for the disassociation
2377 * @local_state_change: This is a request for a local state only, i.e., no
2378 * Disassociation frame is to be transmitted.
2380 struct cfg80211_disassoc_request {
2381 struct cfg80211_bss *bss;
2385 bool local_state_change;
2389 * struct cfg80211_ibss_params - IBSS parameters
2391 * This structure defines the IBSS parameters for the join_ibss()
2394 * @ssid: The SSID, will always be non-null.
2395 * @ssid_len: The length of the SSID, will always be non-zero.
2396 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2397 * search for IBSSs with a different BSSID.
2398 * @chandef: defines the channel to use if no other IBSS to join can be found
2399 * @channel_fixed: The channel should be fixed -- do not search for
2400 * IBSSs to join on other channels.
2401 * @ie: information element(s) to include in the beacon
2402 * @ie_len: length of that
2403 * @beacon_interval: beacon interval to use
2404 * @privacy: this is a protected network, keys will be configured
2406 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2407 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2408 * required to assume that the port is unauthorized until authorized by
2409 * user space. Otherwise, port is marked authorized by default.
2410 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2411 * port frames over NL80211 instead of the network interface.
2412 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2413 * changes the channel when a radar is detected. This is required
2414 * to operate on DFS channels.
2415 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2416 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2417 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2418 * will be used in ht_capa. Un-supported values will be ignored.
2419 * @ht_capa_mask: The bits of ht_capa which are to be used.
2420 * @wep_keys: static WEP keys, if not NULL points to an array of
2421 * CFG80211_MAX_WEP_KEYS WEP keys
2422 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2424 struct cfg80211_ibss_params {
2427 struct cfg80211_chan_def chandef;
2429 u8 ssid_len, ie_len;
2430 u16 beacon_interval;
2435 bool control_port_over_nl80211;
2436 bool userspace_handles_dfs;
2437 int mcast_rate[NUM_NL80211_BANDS];
2438 struct ieee80211_ht_cap ht_capa;
2439 struct ieee80211_ht_cap ht_capa_mask;
2440 struct key_params *wep_keys;
2445 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2447 * @behaviour: requested BSS selection behaviour.
2448 * @param: parameters for requestion behaviour.
2449 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2450 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2452 struct cfg80211_bss_selection {
2453 enum nl80211_bss_select_attr behaviour;
2455 enum nl80211_band band_pref;
2456 struct cfg80211_bss_select_adjust adjust;
2461 * struct cfg80211_connect_params - Connection parameters
2463 * This structure provides information needed to complete IEEE 802.11
2464 * authentication and association.
2466 * @channel: The channel to use or %NULL if not specified (auto-select based
2468 * @channel_hint: The channel of the recommended BSS for initial connection or
2469 * %NULL if not specified
2470 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2472 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2473 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2474 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2477 * @ssid_len: Length of ssid in octets
2478 * @auth_type: Authentication type (algorithm)
2479 * @ie: IEs for association request
2480 * @ie_len: Length of assoc_ie in octets
2481 * @privacy: indicates whether privacy-enabled APs should be used
2482 * @mfp: indicate whether management frame protection is used
2483 * @crypto: crypto settings
2484 * @key_len: length of WEP key for shared key authentication
2485 * @key_idx: index of WEP key for shared key authentication
2486 * @key: WEP key for shared key authentication
2487 * @flags: See &enum cfg80211_assoc_req_flags
2488 * @bg_scan_period: Background scan period in seconds
2489 * or -1 to indicate that default value is to be used.
2490 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2491 * will be used in ht_capa. Un-supported values will be ignored.
2492 * @ht_capa_mask: The bits of ht_capa which are to be used.
2493 * @vht_capa: VHT Capability overrides
2494 * @vht_capa_mask: The bits of vht_capa which are to be used.
2495 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2497 * @bss_select: criteria to be used for BSS selection.
2498 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2499 * to indicate a request to reassociate within the ESS instead of a request
2500 * do the initial association with the ESS. When included, this is set to
2501 * the BSSID of the current association, i.e., to the value that is
2502 * included in the Current AP address field of the Reassociation Request
2504 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2505 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2507 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2508 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2509 * %NULL if not specified. This specifies the domain name of ER server and
2510 * is used to construct FILS wrapped data IE.
2511 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2512 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2513 * messages. This is also used to construct FILS wrapped data IE.
2514 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2515 * keys in FILS or %NULL if not specified.
2516 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2517 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2518 * offload of 4-way handshake.
2519 * @edmg: define the EDMG channels.
2520 * This may specify multiple channels and bonding options for the driver
2521 * to choose from, based on BSS configuration.
2523 struct cfg80211_connect_params {
2524 struct ieee80211_channel *channel;
2525 struct ieee80211_channel *channel_hint;
2527 const u8 *bssid_hint;
2530 enum nl80211_auth_type auth_type;
2534 enum nl80211_mfp mfp;
2535 struct cfg80211_crypto_settings crypto;
2537 u8 key_len, key_idx;
2540 struct ieee80211_ht_cap ht_capa;
2541 struct ieee80211_ht_cap ht_capa_mask;
2542 struct ieee80211_vht_cap vht_capa;
2543 struct ieee80211_vht_cap vht_capa_mask;
2545 struct cfg80211_bss_selection bss_select;
2546 const u8 *prev_bssid;
2547 const u8 *fils_erp_username;
2548 size_t fils_erp_username_len;
2549 const u8 *fils_erp_realm;
2550 size_t fils_erp_realm_len;
2551 u16 fils_erp_next_seq_num;
2552 const u8 *fils_erp_rrk;
2553 size_t fils_erp_rrk_len;
2555 struct ieee80211_edmg edmg;
2559 * enum cfg80211_connect_params_changed - Connection parameters being updated
2561 * This enum provides information of all connect parameters that
2562 * have to be updated as part of update_connect_params() call.
2564 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2565 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2566 * username, erp sequence number and rrk) are updated
2567 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2569 enum cfg80211_connect_params_changed {
2570 UPDATE_ASSOC_IES = BIT(0),
2571 UPDATE_FILS_ERP_INFO = BIT(1),
2572 UPDATE_AUTH_TYPE = BIT(2),
2576 * enum wiphy_params_flags - set_wiphy_params bitfield values
2577 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2578 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2579 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2580 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2581 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2582 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2583 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2584 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2585 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2587 enum wiphy_params_flags {
2588 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2589 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2590 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2591 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2592 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2593 WIPHY_PARAM_DYN_ACK = 1 << 5,
2594 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2595 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2596 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2599 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2602 * struct cfg80211_pmksa - PMK Security Association
2604 * This structure is passed to the set/del_pmksa() method for PMKSA
2607 * @bssid: The AP's BSSID (may be %NULL).
2608 * @pmkid: The identifier to refer a PMKSA.
2609 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2610 * derivation by a FILS STA. Otherwise, %NULL.
2611 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2612 * the hash algorithm used to generate this.
2613 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2614 * cache identifier (may be %NULL).
2615 * @ssid_len: Length of the @ssid in octets.
2616 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2617 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2620 struct cfg80211_pmksa {
2631 * struct cfg80211_pkt_pattern - packet pattern
2632 * @mask: bitmask where to match pattern and where to ignore bytes,
2633 * one bit per byte, in same format as nl80211
2634 * @pattern: bytes to match where bitmask is 1
2635 * @pattern_len: length of pattern (in bytes)
2636 * @pkt_offset: packet offset (in bytes)
2638 * Internal note: @mask and @pattern are allocated in one chunk of
2639 * memory, free @mask only!
2641 struct cfg80211_pkt_pattern {
2642 const u8 *mask, *pattern;
2648 * struct cfg80211_wowlan_tcp - TCP connection parameters
2650 * @sock: (internal) socket for source port allocation
2651 * @src: source IP address
2652 * @dst: destination IP address
2653 * @dst_mac: destination MAC address
2654 * @src_port: source port
2655 * @dst_port: destination port
2656 * @payload_len: data payload length
2657 * @payload: data payload buffer
2658 * @payload_seq: payload sequence stamping configuration
2659 * @data_interval: interval at which to send data packets
2660 * @wake_len: wakeup payload match length
2661 * @wake_data: wakeup payload match data
2662 * @wake_mask: wakeup payload match mask
2663 * @tokens_size: length of the tokens buffer
2664 * @payload_tok: payload token usage configuration
2666 struct cfg80211_wowlan_tcp {
2667 struct socket *sock;
2669 u16 src_port, dst_port;
2670 u8 dst_mac[ETH_ALEN];
2673 struct nl80211_wowlan_tcp_data_seq payload_seq;
2676 const u8 *wake_data, *wake_mask;
2678 /* must be last, variable member */
2679 struct nl80211_wowlan_tcp_data_token payload_tok;
2683 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2685 * This structure defines the enabled WoWLAN triggers for the device.
2686 * @any: wake up on any activity -- special trigger if device continues
2687 * operating as normal during suspend
2688 * @disconnect: wake up if getting disconnected
2689 * @magic_pkt: wake up on receiving magic packet
2690 * @patterns: wake up on receiving packet matching a pattern
2691 * @n_patterns: number of patterns
2692 * @gtk_rekey_failure: wake up on GTK rekey failure
2693 * @eap_identity_req: wake up on EAP identity request packet
2694 * @four_way_handshake: wake up on 4-way handshake
2695 * @rfkill_release: wake up when rfkill is released
2696 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2697 * NULL if not configured.
2698 * @nd_config: configuration for the scan to be used for net detect wake.
2700 struct cfg80211_wowlan {
2701 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2702 eap_identity_req, four_way_handshake,
2704 struct cfg80211_pkt_pattern *patterns;
2705 struct cfg80211_wowlan_tcp *tcp;
2707 struct cfg80211_sched_scan_request *nd_config;
2711 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2713 * This structure defines coalesce rule for the device.
2714 * @delay: maximum coalescing delay in msecs.
2715 * @condition: condition for packet coalescence.
2716 * see &enum nl80211_coalesce_condition.
2717 * @patterns: array of packet patterns
2718 * @n_patterns: number of patterns
2720 struct cfg80211_coalesce_rules {
2722 enum nl80211_coalesce_condition condition;
2723 struct cfg80211_pkt_pattern *patterns;
2728 * struct cfg80211_coalesce - Packet coalescing settings
2730 * This structure defines coalescing settings.
2731 * @rules: array of coalesce rules
2732 * @n_rules: number of rules
2734 struct cfg80211_coalesce {
2735 struct cfg80211_coalesce_rules *rules;
2740 * struct cfg80211_wowlan_nd_match - information about the match
2742 * @ssid: SSID of the match that triggered the wake up
2743 * @n_channels: Number of channels where the match occurred. This
2744 * value may be zero if the driver can't report the channels.
2745 * @channels: center frequencies of the channels where a match
2748 struct cfg80211_wowlan_nd_match {
2749 struct cfg80211_ssid ssid;
2755 * struct cfg80211_wowlan_nd_info - net detect wake up information
2757 * @n_matches: Number of match information instances provided in
2758 * @matches. This value may be zero if the driver can't provide
2759 * match information.
2760 * @matches: Array of pointers to matches containing information about
2761 * the matches that triggered the wake up.
2763 struct cfg80211_wowlan_nd_info {
2765 struct cfg80211_wowlan_nd_match *matches[];
2769 * struct cfg80211_wowlan_wakeup - wakeup report
2770 * @disconnect: woke up by getting disconnected
2771 * @magic_pkt: woke up by receiving magic packet
2772 * @gtk_rekey_failure: woke up by GTK rekey failure
2773 * @eap_identity_req: woke up by EAP identity request packet
2774 * @four_way_handshake: woke up by 4-way handshake
2775 * @rfkill_release: woke up by rfkill being released
2776 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2777 * @packet_present_len: copied wakeup packet data
2778 * @packet_len: original wakeup packet length
2779 * @packet: The packet causing the wakeup, if any.
2780 * @packet_80211: For pattern match, magic packet and other data
2781 * frame triggers an 802.3 frame should be reported, for
2782 * disconnect due to deauth 802.11 frame. This indicates which
2784 * @tcp_match: TCP wakeup packet received
2785 * @tcp_connlost: TCP connection lost or failed to establish
2786 * @tcp_nomoretokens: TCP data ran out of tokens
2787 * @net_detect: if not %NULL, woke up because of net detect
2789 struct cfg80211_wowlan_wakeup {
2790 bool disconnect, magic_pkt, gtk_rekey_failure,
2791 eap_identity_req, four_way_handshake,
2792 rfkill_release, packet_80211,
2793 tcp_match, tcp_connlost, tcp_nomoretokens;
2795 u32 packet_present_len, packet_len;
2797 struct cfg80211_wowlan_nd_info *net_detect;
2801 * struct cfg80211_gtk_rekey_data - rekey data
2802 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2803 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2804 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2806 struct cfg80211_gtk_rekey_data {
2807 const u8 *kek, *kck, *replay_ctr;
2811 * struct cfg80211_update_ft_ies_params - FT IE Information
2813 * This structure provides information needed to update the fast transition IE
2815 * @md: The Mobility Domain ID, 2 Octet value
2816 * @ie: Fast Transition IEs
2817 * @ie_len: Length of ft_ie in octets
2819 struct cfg80211_update_ft_ies_params {
2826 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2828 * This structure provides information needed to transmit a mgmt frame
2830 * @chan: channel to use
2831 * @offchan: indicates wether off channel operation is required
2832 * @wait: duration for ROC
2833 * @buf: buffer to transmit
2834 * @len: buffer length
2835 * @no_cck: don't use cck rates for this frame
2836 * @dont_wait_for_ack: tells the low level not to wait for an ack
2837 * @n_csa_offsets: length of csa_offsets array
2838 * @csa_offsets: array of all the csa offsets in the frame
2840 struct cfg80211_mgmt_tx_params {
2841 struct ieee80211_channel *chan;
2847 bool dont_wait_for_ack;
2849 const u16 *csa_offsets;
2853 * struct cfg80211_dscp_exception - DSCP exception
2855 * @dscp: DSCP value that does not adhere to the user priority range definition
2856 * @up: user priority value to which the corresponding DSCP value belongs
2858 struct cfg80211_dscp_exception {
2864 * struct cfg80211_dscp_range - DSCP range definition for user priority
2866 * @low: lowest DSCP value of this user priority range, inclusive
2867 * @high: highest DSCP value of this user priority range, inclusive
2869 struct cfg80211_dscp_range {
2874 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2875 #define IEEE80211_QOS_MAP_MAX_EX 21
2876 #define IEEE80211_QOS_MAP_LEN_MIN 16
2877 #define IEEE80211_QOS_MAP_LEN_MAX \
2878 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2881 * struct cfg80211_qos_map - QoS Map Information
2883 * This struct defines the Interworking QoS map setting for DSCP values
2885 * @num_des: number of DSCP exceptions (0..21)
2886 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2887 * the user priority DSCP range definition
2888 * @up: DSCP range definition for a particular user priority
2890 struct cfg80211_qos_map {
2892 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2893 struct cfg80211_dscp_range up[8];
2897 * struct cfg80211_nan_conf - NAN configuration
2899 * This struct defines NAN configuration parameters
2901 * @master_pref: master preference (1 - 255)
2902 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2903 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2904 * (i.e. BIT(NL80211_BAND_2GHZ)).
2906 struct cfg80211_nan_conf {
2912 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2915 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2916 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2918 enum cfg80211_nan_conf_changes {
2919 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2920 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2924 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2926 * @filter: the content of the filter
2927 * @len: the length of the filter
2929 struct cfg80211_nan_func_filter {
2935 * struct cfg80211_nan_func - a NAN function
2937 * @type: &enum nl80211_nan_function_type
2938 * @service_id: the service ID of the function
2939 * @publish_type: &nl80211_nan_publish_type
2940 * @close_range: if true, the range should be limited. Threshold is
2941 * implementation specific.
2942 * @publish_bcast: if true, the solicited publish should be broadcasted
2943 * @subscribe_active: if true, the subscribe is active
2944 * @followup_id: the instance ID for follow up
2945 * @followup_reqid: the requestor instance ID for follow up
2946 * @followup_dest: MAC address of the recipient of the follow up
2947 * @ttl: time to live counter in DW.
2948 * @serv_spec_info: Service Specific Info
2949 * @serv_spec_info_len: Service Specific Info length
2950 * @srf_include: if true, SRF is inclusive
2951 * @srf_bf: Bloom Filter
2952 * @srf_bf_len: Bloom Filter length
2953 * @srf_bf_idx: Bloom Filter index
2954 * @srf_macs: SRF MAC addresses
2955 * @srf_num_macs: number of MAC addresses in SRF
2956 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2957 * @tx_filters: filters that should be transmitted in the SDF.
2958 * @num_rx_filters: length of &rx_filters.
2959 * @num_tx_filters: length of &tx_filters.
2960 * @instance_id: driver allocated id of the function.
2961 * @cookie: unique NAN function identifier.
2963 struct cfg80211_nan_func {
2964 enum nl80211_nan_function_type type;
2965 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2969 bool subscribe_active;
2972 struct mac_address followup_dest;
2974 const u8 *serv_spec_info;
2975 u8 serv_spec_info_len;
2980 struct mac_address *srf_macs;
2982 struct cfg80211_nan_func_filter *rx_filters;
2983 struct cfg80211_nan_func_filter *tx_filters;
2991 * struct cfg80211_pmk_conf - PMK configuration
2993 * @aa: authenticator address
2994 * @pmk_len: PMK length in bytes.
2995 * @pmk: the PMK material
2996 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2997 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3000 struct cfg80211_pmk_conf {
3004 const u8 *pmk_r0_name;
3008 * struct cfg80211_external_auth_params - Trigger External authentication.
3010 * Commonly used across the external auth request and event interfaces.
3012 * @action: action type / trigger for external authentication. Only significant
3013 * for the authentication request event interface (driver to user space).
3014 * @bssid: BSSID of the peer with which the authentication has
3015 * to happen. Used by both the authentication request event and
3016 * authentication response command interface.
3017 * @ssid: SSID of the AP. Used by both the authentication request event and
3018 * authentication response command interface.
3019 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3020 * authentication request event interface.
3021 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3022 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3023 * the real status code for failures. Used only for the authentication
3024 * response command interface (user space to driver).
3025 * @pmkid: The identifier to refer a PMKSA.
3027 struct cfg80211_external_auth_params {
3028 enum nl80211_external_auth_action action;
3029 u8 bssid[ETH_ALEN] __aligned(2);
3030 struct cfg80211_ssid ssid;
3031 unsigned int key_mgmt_suite;
3037 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3039 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3040 * indicate the relevant values in this struct for them
3041 * @success_num: number of FTM sessions in which all frames were successfully
3043 * @partial_num: number of FTM sessions in which part of frames were
3044 * successfully answered
3045 * @failed_num: number of failed FTM sessions
3046 * @asap_num: number of ASAP FTM sessions
3047 * @non_asap_num: number of non-ASAP FTM sessions
3048 * @total_duration_ms: total sessions durations - gives an indication
3049 * of how much time the responder was busy
3050 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3051 * initiators that didn't finish successfully the negotiation phase with
3053 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3054 * for a new scheduling although it already has scheduled FTM slot
3055 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3057 struct cfg80211_ftm_responder_stats {
3064 u64 total_duration_ms;
3065 u32 unknown_triggers_num;
3066 u32 reschedule_requests_num;
3067 u32 out_of_window_triggers_num;
3071 * struct cfg80211_pmsr_ftm_result - FTM result
3072 * @failure_reason: if this measurement failed (PMSR status is
3073 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3074 * reason than just "failure"
3075 * @burst_index: if reporting partial results, this is the index
3076 * in [0 .. num_bursts-1] of the burst that's being reported
3077 * @num_ftmr_attempts: number of FTM request frames transmitted
3078 * @num_ftmr_successes: number of FTM request frames acked
3079 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3080 * fill this to indicate in how many seconds a retry is deemed possible
3082 * @num_bursts_exp: actual number of bursts exponent negotiated
3083 * @burst_duration: actual burst duration negotiated
3084 * @ftms_per_burst: actual FTMs per burst negotiated
3085 * @lci_len: length of LCI information (if present)
3086 * @civicloc_len: length of civic location information (if present)
3087 * @lci: LCI data (may be %NULL)
3088 * @civicloc: civic location data (may be %NULL)
3089 * @rssi_avg: average RSSI over FTM action frames reported
3090 * @rssi_spread: spread of the RSSI over FTM action frames reported
3091 * @tx_rate: bitrate for transmitted FTM action frame response
3092 * @rx_rate: bitrate of received FTM action frame
3093 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3094 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3095 * the square root of the variance)
3096 * @rtt_spread: spread of the RTTs measured
3097 * @dist_avg: average of distances (mm) measured
3098 * (must have either this or @rtt_avg)
3099 * @dist_variance: variance of distances measured (see also @rtt_variance)
3100 * @dist_spread: spread of distances measured (see also @rtt_spread)
3101 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3102 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3103 * @rssi_avg_valid: @rssi_avg is valid
3104 * @rssi_spread_valid: @rssi_spread is valid
3105 * @tx_rate_valid: @tx_rate is valid
3106 * @rx_rate_valid: @rx_rate is valid
3107 * @rtt_avg_valid: @rtt_avg is valid
3108 * @rtt_variance_valid: @rtt_variance is valid
3109 * @rtt_spread_valid: @rtt_spread is valid
3110 * @dist_avg_valid: @dist_avg is valid
3111 * @dist_variance_valid: @dist_variance is valid
3112 * @dist_spread_valid: @dist_spread is valid
3114 struct cfg80211_pmsr_ftm_result {
3117 unsigned int lci_len;
3118 unsigned int civicloc_len;
3119 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3120 u32 num_ftmr_attempts, num_ftmr_successes;
3128 struct rate_info tx_rate, rx_rate;
3136 u16 num_ftmr_attempts_valid:1,
3137 num_ftmr_successes_valid:1,
3139 rssi_spread_valid:1,
3143 rtt_variance_valid:1,
3146 dist_variance_valid:1,
3147 dist_spread_valid:1;
3151 * struct cfg80211_pmsr_result - peer measurement result
3152 * @addr: address of the peer
3153 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3154 * measurement was made)
3155 * @ap_tsf: AP's TSF at measurement time
3156 * @status: status of the measurement
3157 * @final: if reporting partial results, mark this as the last one; if not
3158 * reporting partial results always set this flag
3159 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3160 * @type: type of the measurement reported, note that we only support reporting
3161 * one type at a time, but you can report multiple results separately and
3162 * they're all aggregated for userspace.
3164 struct cfg80211_pmsr_result {
3165 u64 host_time, ap_tsf;
3166 enum nl80211_peer_measurement_status status;
3173 enum nl80211_peer_measurement_type type;
3176 struct cfg80211_pmsr_ftm_result ftm;
3181 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3182 * @requested: indicates FTM is requested
3183 * @preamble: frame preamble to use
3184 * @burst_period: burst period to use
3185 * @asap: indicates to use ASAP mode
3186 * @num_bursts_exp: number of bursts exponent
3187 * @burst_duration: burst duration
3188 * @ftms_per_burst: number of FTMs per burst
3189 * @ftmr_retries: number of retries for FTM request
3190 * @request_lci: request LCI information
3191 * @request_civicloc: request civic location information
3193 * See also nl80211 for the respective attribute documentation.
3195 struct cfg80211_pmsr_ftm_request_peer {
3196 enum nl80211_preamble preamble;
3209 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3210 * @addr: MAC address
3211 * @chandef: channel to use
3212 * @report_ap_tsf: report the associated AP's TSF
3213 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3215 struct cfg80211_pmsr_request_peer {
3217 struct cfg80211_chan_def chandef;
3219 struct cfg80211_pmsr_ftm_request_peer ftm;
3223 * struct cfg80211_pmsr_request - peer measurement request
3224 * @cookie: cookie, set by cfg80211
3225 * @nl_portid: netlink portid - used by cfg80211
3226 * @drv_data: driver data for this request, if required for aborting,
3227 * not otherwise freed or anything by cfg80211
3228 * @mac_addr: MAC address used for (randomised) request
3229 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3230 * are 0 in the mask should be randomised, bits that are 1 should
3231 * be taken from the @mac_addr
3232 * @list: used by cfg80211 to hold on to the request
3233 * @timeout: timeout (in milliseconds) for the whole operation, if
3234 * zero it means there's no timeout
3235 * @n_peers: number of peers to do measurements with
3236 * @peers: per-peer measurement request data
3238 struct cfg80211_pmsr_request {
3246 u8 mac_addr[ETH_ALEN] __aligned(2);
3247 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3249 struct list_head list;
3251 struct cfg80211_pmsr_request_peer peers[];
3255 * struct cfg80211_update_owe_info - OWE Information
3257 * This structure provides information needed for the drivers to offload OWE
3258 * (Opportunistic Wireless Encryption) processing to the user space.
3260 * Commonly used across update_owe_info request and event interfaces.
3262 * @peer: MAC address of the peer device for which the OWE processing
3264 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3265 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3266 * cannot give you the real status code for failures. Used only for
3267 * OWE update request command interface (user space to driver).
3268 * @ie: IEs obtained from the peer or constructed by the user space. These are
3269 * the IEs of the remote peer in the event from the host driver and
3270 * the constructed IEs by the user space in the request interface.
3271 * @ie_len: Length of IEs in octets.
3273 struct cfg80211_update_owe_info {
3274 u8 peer[ETH_ALEN] __aligned(2);
3281 * struct cfg80211_ops - backend description for wireless configuration
3283 * This struct is registered by fullmac card drivers and/or wireless stacks
3284 * in order to handle configuration requests on their interfaces.
3286 * All callbacks except where otherwise noted should return 0
3287 * on success or a negative error code.
3289 * All operations are currently invoked under rtnl for consistency with the
3290 * wireless extensions but this is subject to reevaluation as soon as this
3291 * code is used more widely and we have a first user without wext.
3293 * @suspend: wiphy device needs to be suspended. The variable @wow will
3294 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3295 * configured for the device.
3296 * @resume: wiphy device needs to be resumed
3297 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3298 * to call device_set_wakeup_enable() to enable/disable wakeup from
3301 * @add_virtual_intf: create a new virtual interface with the given name,
3302 * must set the struct wireless_dev's iftype. Beware: You must create
3303 * the new netdev in the wiphy's network namespace! Returns the struct
3304 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3305 * also set the address member in the wdev.
3307 * @del_virtual_intf: remove the virtual interface
3309 * @change_virtual_intf: change type/configuration of virtual interface,
3310 * keep the struct wireless_dev's iftype updated.
3312 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3313 * when adding a group key.
3315 * @get_key: get information about the key with the given parameters.
3316 * @mac_addr will be %NULL when requesting information for a group
3317 * key. All pointers given to the @callback function need not be valid
3318 * after it returns. This function should return an error if it is
3319 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3321 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3322 * and @key_index, return -ENOENT if the key doesn't exist.
3324 * @set_default_key: set the default key on an interface
3326 * @set_default_mgmt_key: set the default management frame key on an interface
3328 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3330 * @start_ap: Start acting in AP mode defined by the parameters.
3331 * @change_beacon: Change the beacon parameters for an access point mode
3332 * interface. This should reject the call when AP mode wasn't started.
3333 * @stop_ap: Stop being an AP, including stopping beaconing.
3335 * @add_station: Add a new station.
3336 * @del_station: Remove a station
3337 * @change_station: Modify a given station. Note that flags changes are not much
3338 * validated in cfg80211, in particular the auth/assoc/authorized flags
3339 * might come to the driver in invalid combinations -- make sure to check
3340 * them, also against the existing state! Drivers must call
3341 * cfg80211_check_station_change() to validate the information.
3342 * @get_station: get station information for the station identified by @mac
3343 * @dump_station: dump station callback -- resume dump at index @idx
3345 * @add_mpath: add a fixed mesh path
3346 * @del_mpath: delete a given mesh path
3347 * @change_mpath: change a given mesh path
3348 * @get_mpath: get a mesh path for the given parameters
3349 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3350 * @get_mpp: get a mesh proxy path for the given parameters
3351 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3352 * @join_mesh: join the mesh network with the specified parameters
3353 * (invoked with the wireless_dev mutex held)
3354 * @leave_mesh: leave the current mesh network
3355 * (invoked with the wireless_dev mutex held)
3357 * @get_mesh_config: Get the current mesh configuration
3359 * @update_mesh_config: Update mesh parameters on a running mesh.
3360 * The mask is a bitfield which tells us which parameters to
3361 * set, and which to leave alone.
3363 * @change_bss: Modify parameters for a given BSS.
3365 * @set_txq_params: Set TX queue parameters
3367 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3368 * as it doesn't implement join_mesh and needs to set the channel to
3369 * join the mesh instead.
3371 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3372 * interfaces are active this callback should reject the configuration.
3373 * If no interfaces are active or the device is down, the channel should
3374 * be stored for when a monitor interface becomes active.
3376 * @scan: Request to do a scan. If returning zero, the scan request is given
3377 * the driver, and will be valid until passed to cfg80211_scan_done().
3378 * For scan results, call cfg80211_inform_bss(); you can call this outside
3379 * the scan/scan_done bracket too.
3380 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3381 * indicate the status of the scan through cfg80211_scan_done().
3383 * @auth: Request to authenticate with the specified peer
3384 * (invoked with the wireless_dev mutex held)
3385 * @assoc: Request to (re)associate with the specified peer
3386 * (invoked with the wireless_dev mutex held)
3387 * @deauth: Request to deauthenticate from the specified peer
3388 * (invoked with the wireless_dev mutex held)
3389 * @disassoc: Request to disassociate from the specified peer
3390 * (invoked with the wireless_dev mutex held)
3392 * @connect: Connect to the ESS with the specified parameters. When connected,
3393 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3394 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3395 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3396 * from the AP or cfg80211_connect_timeout() if no frame with status code
3398 * The driver is allowed to roam to other BSSes within the ESS when the
3399 * other BSS matches the connect parameters. When such roaming is initiated
3400 * by the driver, the driver is expected to verify that the target matches
3401 * the configured security parameters and to use Reassociation Request
3402 * frame instead of Association Request frame.
3403 * The connect function can also be used to request the driver to perform a
3404 * specific roam when connected to an ESS. In that case, the prev_bssid
3405 * parameter is set to the BSSID of the currently associated BSS as an
3406 * indication of requesting reassociation.
3407 * In both the driver-initiated and new connect() call initiated roaming
3408 * cases, the result of roaming is indicated with a call to
3409 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3410 * @update_connect_params: Update the connect parameters while connected to a
3411 * BSS. The updated parameters can be used by driver/firmware for
3412 * subsequent BSS selection (roaming) decisions and to form the
3413 * Authentication/(Re)Association Request frames. This call does not
3414 * request an immediate disassociation or reassociation with the current
3415 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3416 * changed are defined in &enum cfg80211_connect_params_changed.
3417 * (invoked with the wireless_dev mutex held)
3418 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3419 * connection is in progress. Once done, call cfg80211_disconnected() in
3420 * case connection was already established (invoked with the
3421 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3423 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3424 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3426 * (invoked with the wireless_dev mutex held)
3427 * @leave_ibss: Leave the IBSS.
3428 * (invoked with the wireless_dev mutex held)
3430 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3433 * @set_wiphy_params: Notify that wiphy parameters have changed;
3434 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3435 * have changed. The actual parameter values are available in
3436 * struct wiphy. If returning an error, no value should be changed.
3438 * @set_tx_power: set the transmit power according to the parameters,
3439 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3440 * wdev may be %NULL if power was set for the wiphy, and will
3441 * always be %NULL unless the driver supports per-vif TX power
3442 * (as advertised by the nl80211 feature flag.)
3443 * @get_tx_power: store the current TX power into the dbm variable;
3444 * return 0 if successful
3446 * @set_wds_peer: set the WDS peer for a WDS interface
3448 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3449 * functions to adjust rfkill hw state
3451 * @dump_survey: get site survey information.
3453 * @remain_on_channel: Request the driver to remain awake on the specified
3454 * channel for the specified duration to complete an off-channel
3455 * operation (e.g., public action frame exchange). When the driver is
3456 * ready on the requested channel, it must indicate this with an event
3457 * notification by calling cfg80211_ready_on_channel().
3458 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3459 * This allows the operation to be terminated prior to timeout based on
3460 * the duration value.
3461 * @mgmt_tx: Transmit a management frame.
3462 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3463 * frame on another channel
3465 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3466 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3467 * used by the function, but 0 and 1 must not be touched. Additionally,
3468 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3469 * dump and return to userspace with an error, so be careful. If any data
3470 * was passed in from userspace then the data/len arguments will be present
3471 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3473 * @set_bitrate_mask: set the bitrate mask configuration
3475 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3476 * devices running firmwares capable of generating the (re) association
3477 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3478 * @del_pmksa: Delete a cached PMKID.
3479 * @flush_pmksa: Flush all cached PMKIDs.
3480 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3481 * allows the driver to adjust the dynamic ps timeout value.
3482 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3483 * After configuration, the driver should (soon) send an event indicating
3484 * the current level is above/below the configured threshold; this may
3485 * need some care when the configuration is changed (without first being
3487 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3488 * connection quality monitor. An event is to be sent only when the
3489 * signal level is found to be outside the two values. The driver should
3490 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3491 * If it is provided then there's no point providing @set_cqm_rssi_config.
3492 * @set_cqm_txe_config: Configure connection quality monitor TX error
3494 * @sched_scan_start: Tell the driver to start a scheduled scan.
3495 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3496 * given request id. This call must stop the scheduled scan and be ready
3497 * for starting a new one before it returns, i.e. @sched_scan_start may be
3498 * called immediately after that again and should not fail in that case.
3499 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3500 * stop (when this method returns 0).
3502 * @mgmt_frame_register: Notify driver that a management frame type was
3503 * registered. The callback is allowed to sleep.
3505 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3506 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3507 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3508 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3510 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3512 * @tdls_mgmt: Transmit a TDLS management frame.
3513 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3515 * @probe_client: probe an associated client, must return a cookie that it
3516 * later passes to cfg80211_probe_status().
3518 * @set_noack_map: Set the NoAck Map for the TIDs.
3520 * @get_channel: Get the current operating channel for the virtual interface.
3521 * For monitor interfaces, it should return %NULL unless there's a single
3522 * current monitoring channel.
3524 * @start_p2p_device: Start the given P2P device.
3525 * @stop_p2p_device: Stop the given P2P device.
3527 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3528 * Parameters include ACL policy, an array of MAC address of stations
3529 * and the number of MAC addresses. If there is already a list in driver
3530 * this new list replaces the existing one. Driver has to clear its ACL
3531 * when number of MAC addresses entries is passed as 0. Drivers which
3532 * advertise the support for MAC based ACL have to implement this callback.
3534 * @start_radar_detection: Start radar detection in the driver.
3536 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3537 * driver. If the SME is in the driver/firmware, this information can be
3538 * used in building Authentication and Reassociation Request frames.
3540 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3541 * for a given duration (milliseconds). The protocol is provided so the
3542 * driver can take the most appropriate actions.
3543 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3544 * reliability. This operation can not fail.
3545 * @set_coalesce: Set coalesce parameters.
3547 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3548 * responsible for veryfing if the switch is possible. Since this is
3549 * inherently tricky driver may decide to disconnect an interface later
3550 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3551 * everything. It should do it's best to verify requests and reject them
3552 * as soon as possible.
3554 * @set_qos_map: Set QoS mapping information to the driver
3556 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3557 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3558 * changes during the lifetime of the BSS.
3560 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3561 * with the given parameters; action frame exchange has been handled by
3562 * userspace so this just has to modify the TX path to take the TS into
3564 * If the admitted time is 0 just validate the parameters to make sure
3565 * the session can be created at all; it is valid to just always return
3566 * success for that but that may result in inefficient behaviour (handshake
3567 * with the peer followed by immediate teardown when the addition is later
3569 * @del_tx_ts: remove an existing TX TS
3571 * @join_ocb: join the OCB network with the specified parameters
3572 * (invoked with the wireless_dev mutex held)
3573 * @leave_ocb: leave the current OCB network
3574 * (invoked with the wireless_dev mutex held)
3576 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3577 * is responsible for continually initiating channel-switching operations
3578 * and returning to the base channel for communication with the AP.
3579 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3580 * peers must be on the base channel when the call completes.
3581 * @start_nan: Start the NAN interface.
3582 * @stop_nan: Stop the NAN interface.
3583 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3584 * On success @nan_func ownership is transferred to the driver and
3585 * it may access it outside of the scope of this function. The driver
3586 * should free the @nan_func when no longer needed by calling
3587 * cfg80211_free_nan_func().
3588 * On success the driver should assign an instance_id in the
3589 * provided @nan_func.
3590 * @del_nan_func: Delete a NAN function.
3591 * @nan_change_conf: changes NAN configuration. The changed parameters must
3592 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3593 * All other parameters must be ignored.
3595 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3597 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3598 * function should return phy stats, and interface stats otherwise.
3600 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3601 * If not deleted through @del_pmk the PMK remains valid until disconnect
3602 * upon which the driver should clear it.
3603 * (invoked with the wireless_dev mutex held)
3604 * @del_pmk: delete the previously configured PMK for the given authenticator.
3605 * (invoked with the wireless_dev mutex held)
3607 * @external_auth: indicates result of offloaded authentication processing from
3610 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3611 * tells the driver that the frame should not be encrypted.
3613 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3614 * Statistics should be cumulative, currently no way to reset is provided.
3615 * @start_pmsr: start peer measurement (e.g. FTM)
3616 * @abort_pmsr: abort peer measurement
3618 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3619 * but offloading OWE processing to the user space will get the updated
3620 * DH IE through this interface.
3622 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3623 * and overrule HWMP path selection algorithm.
3625 struct cfg80211_ops {
3626 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3627 int (*resume)(struct wiphy *wiphy);
3628 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3630 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3632 unsigned char name_assign_type,
3633 enum nl80211_iftype type,
3634 struct vif_params *params);
3635 int (*del_virtual_intf)(struct wiphy *wiphy,
3636 struct wireless_dev *wdev);
3637 int (*change_virtual_intf)(struct wiphy *wiphy,
3638 struct net_device *dev,
3639 enum nl80211_iftype type,
3640 struct vif_params *params);
3642 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3643 u8 key_index, bool pairwise, const u8 *mac_addr,
3644 struct key_params *params);
3645 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3646 u8 key_index, bool pairwise, const u8 *mac_addr,
3648 void (*callback)(void *cookie, struct key_params*));
3649 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3650 u8 key_index, bool pairwise, const u8 *mac_addr);
3651 int (*set_default_key)(struct wiphy *wiphy,
3652 struct net_device *netdev,
3653 u8 key_index, bool unicast, bool multicast);
3654 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3655 struct net_device *netdev,
3658 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3659 struct cfg80211_ap_settings *settings);
3660 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3661 struct cfg80211_beacon_data *info);
3662 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3665 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3667 struct station_parameters *params);
3668 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3669 struct station_del_parameters *params);
3670 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3672 struct station_parameters *params);
3673 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3674 const u8 *mac, struct station_info *sinfo);
3675 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3676 int idx, u8 *mac, struct station_info *sinfo);
3678 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3679 const u8 *dst, const u8 *next_hop);
3680 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3682 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3683 const u8 *dst, const u8 *next_hop);
3684 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3685 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3686 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3687 int idx, u8 *dst, u8 *next_hop,
3688 struct mpath_info *pinfo);
3689 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3690 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3691 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3692 int idx, u8 *dst, u8 *mpp,
3693 struct mpath_info *pinfo);
3694 int (*get_mesh_config)(struct wiphy *wiphy,
3695 struct net_device *dev,
3696 struct mesh_config *conf);
3697 int (*update_mesh_config)(struct wiphy *wiphy,
3698 struct net_device *dev, u32 mask,
3699 const struct mesh_config *nconf);
3700 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3701 const struct mesh_config *conf,
3702 const struct mesh_setup *setup);
3703 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3705 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3706 struct ocb_setup *setup);
3707 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3709 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3710 struct bss_parameters *params);
3712 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3713 struct ieee80211_txq_params *params);
3715 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3716 struct net_device *dev,
3717 struct ieee80211_channel *chan);
3719 int (*set_monitor_channel)(struct wiphy *wiphy,
3720 struct cfg80211_chan_def *chandef);
3722 int (*scan)(struct wiphy *wiphy,
3723 struct cfg80211_scan_request *request);
3724 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3726 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
3727 struct cfg80211_auth_request *req);
3728 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3729 struct cfg80211_assoc_request *req);
3730 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3731 struct cfg80211_deauth_request *req);
3732 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3733 struct cfg80211_disassoc_request *req);
3735 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
3736 struct cfg80211_connect_params *sme);
3737 int (*update_connect_params)(struct wiphy *wiphy,
3738 struct net_device *dev,
3739 struct cfg80211_connect_params *sme,
3741 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3744 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3745 struct cfg80211_ibss_params *params);
3746 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3748 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3749 int rate[NUM_NL80211_BANDS]);
3751 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3753 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3754 enum nl80211_tx_power_setting type, int mbm);
3755 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3758 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3761 void (*rfkill_poll)(struct wiphy *wiphy);
3763 #ifdef CONFIG_NL80211_TESTMODE
3764 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3765 void *data, int len);
3766 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3767 struct netlink_callback *cb,
3768 void *data, int len);
3771 int (*set_bitrate_mask)(struct wiphy *wiphy,
3772 struct net_device *dev,
3774 const struct cfg80211_bitrate_mask *mask);
3776 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3777 int idx, struct survey_info *info);
3779 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3780 struct cfg80211_pmksa *pmksa);
3781 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3782 struct cfg80211_pmksa *pmksa);
3783 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3785 int (*remain_on_channel)(struct wiphy *wiphy,
3786 struct wireless_dev *wdev,
3787 struct ieee80211_channel *chan,
3788 unsigned int duration,
3790 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
3791 struct wireless_dev *wdev,
3794 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3795 struct cfg80211_mgmt_tx_params *params,
3797 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3798 struct wireless_dev *wdev,
3801 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3802 bool enabled, int timeout);
3804 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
3805 struct net_device *dev,
3806 s32 rssi_thold, u32 rssi_hyst);
3808 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3809 struct net_device *dev,
3810 s32 rssi_low, s32 rssi_high);
3812 int (*set_cqm_txe_config)(struct wiphy *wiphy,
3813 struct net_device *dev,
3814 u32 rate, u32 pkts, u32 intvl);
3816 void (*mgmt_frame_register)(struct wiphy *wiphy,
3817 struct wireless_dev *wdev,
3818 u16 frame_type, bool reg);
3820 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3821 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3823 int (*sched_scan_start)(struct wiphy *wiphy,
3824 struct net_device *dev,
3825 struct cfg80211_sched_scan_request *request);
3826 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3829 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3830 struct cfg80211_gtk_rekey_data *data);
3832 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3833 const u8 *peer, u8 action_code, u8 dialog_token,
3834 u16 status_code, u32 peer_capability,
3835 bool initiator, const u8 *buf, size_t len);
3836 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3837 const u8 *peer, enum nl80211_tdls_operation oper);
3839 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3840 const u8 *peer, u64 *cookie);
3842 int (*set_noack_map)(struct wiphy *wiphy,
3843 struct net_device *dev,
3846 int (*get_channel)(struct wiphy *wiphy,
3847 struct wireless_dev *wdev,
3848 struct cfg80211_chan_def *chandef);
3850 int (*start_p2p_device)(struct wiphy *wiphy,
3851 struct wireless_dev *wdev);
3852 void (*stop_p2p_device)(struct wiphy *wiphy,
3853 struct wireless_dev *wdev);
3855 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3856 const struct cfg80211_acl_data *params);
3858 int (*start_radar_detection)(struct wiphy *wiphy,
3859 struct net_device *dev,
3860 struct cfg80211_chan_def *chandef,
3862 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3863 struct cfg80211_update_ft_ies_params *ftie);
3864 int (*crit_proto_start)(struct wiphy *wiphy,
3865 struct wireless_dev *wdev,
3866 enum nl80211_crit_proto_id protocol,
3868 void (*crit_proto_stop)(struct wiphy *wiphy,
3869 struct wireless_dev *wdev);
3870 int (*set_coalesce)(struct wiphy *wiphy,
3871 struct cfg80211_coalesce *coalesce);
3873 int (*channel_switch)(struct wiphy *wiphy,
3874 struct net_device *dev,
3875 struct cfg80211_csa_settings *params);
3877 int (*set_qos_map)(struct wiphy *wiphy,
3878 struct net_device *dev,
3879 struct cfg80211_qos_map *qos_map);
3881 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3882 struct cfg80211_chan_def *chandef);
3884 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3885 u8 tsid, const u8 *peer, u8 user_prio,
3887 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3888 u8 tsid, const u8 *peer);
3890 int (*tdls_channel_switch)(struct wiphy *wiphy,
3891 struct net_device *dev,
3892 const u8 *addr, u8 oper_class,
3893 struct cfg80211_chan_def *chandef);
3894 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3895 struct net_device *dev,
3897 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3898 struct cfg80211_nan_conf *conf);
3899 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3900 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3901 struct cfg80211_nan_func *nan_func);
3902 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3904 int (*nan_change_conf)(struct wiphy *wiphy,
3905 struct wireless_dev *wdev,
3906 struct cfg80211_nan_conf *conf,
3909 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
3910 struct net_device *dev,
3911 const bool enabled);
3913 int (*get_txq_stats)(struct wiphy *wiphy,
3914 struct wireless_dev *wdev,
3915 struct cfg80211_txq_stats *txqstats);
3917 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3918 const struct cfg80211_pmk_conf *conf);
3919 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3921 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3922 struct cfg80211_external_auth_params *params);
3924 int (*tx_control_port)(struct wiphy *wiphy,
3925 struct net_device *dev,
3926 const u8 *buf, size_t len,
3927 const u8 *dest, const __be16 proto,
3928 const bool noencrypt);
3930 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
3931 struct net_device *dev,
3932 struct cfg80211_ftm_responder_stats *ftm_stats);
3934 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3935 struct cfg80211_pmsr_request *request);
3936 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3937 struct cfg80211_pmsr_request *request);
3938 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
3939 struct cfg80211_update_owe_info *owe_info);
3940 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
3941 const u8 *buf, size_t len);
3945 * wireless hardware and networking interfaces structures
3946 * and registration/helper functions
3950 * enum wiphy_flags - wiphy capability flags
3952 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3954 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3955 * by default -- this flag will be set depending on the kernel's default
3956 * on wiphy_new(), but can be changed by the driver if it has a good
3957 * reason to override the default
3958 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3959 * on a VLAN interface). This flag also serves an extra purpose of
3960 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
3961 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3962 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3963 * control port protocol ethertype. The device also honours the
3964 * control_port_no_encrypt flag.
3965 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3966 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3967 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3968 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3970 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3971 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3972 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3973 * link setup/discovery operations internally. Setup, discovery and
3974 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3975 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3976 * used for asking the driver/firmware to perform a TDLS operation.
3977 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3978 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3979 * when there are virtual interfaces in AP mode by calling
3980 * cfg80211_report_obss_beacon().
3981 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3982 * responds to probe-requests in hardware.
3983 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3984 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3985 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3986 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3987 * beaconing mode (AP, IBSS, Mesh, ...).
3988 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3989 * before connection.
3995 WIPHY_FLAG_NETNS_OK = BIT(3),
3996 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
3997 WIPHY_FLAG_4ADDR_AP = BIT(5),
3998 WIPHY_FLAG_4ADDR_STATION = BIT(6),
3999 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4000 WIPHY_FLAG_IBSS_RSN = BIT(8),
4001 WIPHY_FLAG_MESH_AUTH = BIT(10),
4002 /* use hole at 11 */
4003 /* use hole at 12 */
4004 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4005 WIPHY_FLAG_AP_UAPSD = BIT(14),
4006 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4007 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4008 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4009 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4010 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4011 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4012 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4013 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4014 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4015 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4019 * struct ieee80211_iface_limit - limit on certain interface types
4020 * @max: maximum number of interfaces of these types
4021 * @types: interface types (bits)
4023 struct ieee80211_iface_limit {
4029 * struct ieee80211_iface_combination - possible interface combination
4031 * With this structure the driver can describe which interface
4032 * combinations it supports concurrently.
4036 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4040 * struct ieee80211_iface_limit limits1[] = {
4041 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4042 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4044 * struct ieee80211_iface_combination combination1 = {
4045 * .limits = limits1,
4046 * .n_limits = ARRAY_SIZE(limits1),
4047 * .max_interfaces = 2,
4048 * .beacon_int_infra_match = true,
4052 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4056 * struct ieee80211_iface_limit limits2[] = {
4057 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4058 * BIT(NL80211_IFTYPE_P2P_GO), },
4060 * struct ieee80211_iface_combination combination2 = {
4061 * .limits = limits2,
4062 * .n_limits = ARRAY_SIZE(limits2),
4063 * .max_interfaces = 8,
4064 * .num_different_channels = 1,
4068 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4070 * This allows for an infrastructure connection and three P2P connections.
4074 * struct ieee80211_iface_limit limits3[] = {
4075 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4076 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4077 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4079 * struct ieee80211_iface_combination combination3 = {
4080 * .limits = limits3,
4081 * .n_limits = ARRAY_SIZE(limits3),
4082 * .max_interfaces = 4,
4083 * .num_different_channels = 2,
4087 struct ieee80211_iface_combination {
4090 * limits for the given interface types
4092 const struct ieee80211_iface_limit *limits;
4095 * @num_different_channels:
4096 * can use up to this many different channels
4098 u32 num_different_channels;
4102 * maximum number of interfaces in total allowed in this group
4108 * number of limitations
4113 * @beacon_int_infra_match:
4114 * In this combination, the beacon intervals between infrastructure
4115 * and AP types must match. This is required only in special cases.
4117 bool beacon_int_infra_match;
4120 * @radar_detect_widths:
4121 * bitmap of channel widths supported for radar detection
4123 u8 radar_detect_widths;
4126 * @radar_detect_regions:
4127 * bitmap of regions supported for radar detection
4129 u8 radar_detect_regions;
4132 * @beacon_int_min_gcd:
4133 * This interface combination supports different beacon intervals.
4136 * all beacon intervals for different interface must be same.
4138 * any beacon interval for the interface part of this combination AND
4139 * GCD of all beacon intervals from beaconing interfaces of this
4140 * combination must be greater or equal to this value.
4142 u32 beacon_int_min_gcd;
4145 struct ieee80211_txrx_stypes {
4150 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4151 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4152 * trigger that keeps the device operating as-is and
4153 * wakes up the host on any activity, for example a
4154 * received packet that passed filtering; note that the
4155 * packet should be preserved in that case
4156 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4158 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4159 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4160 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4161 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4162 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4163 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4164 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4166 enum wiphy_wowlan_support_flags {
4167 WIPHY_WOWLAN_ANY = BIT(0),
4168 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4169 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4170 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4171 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4172 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4173 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4174 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4175 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4178 struct wiphy_wowlan_tcp_support {
4179 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4180 u32 data_payload_max;
4181 u32 data_interval_max;
4182 u32 wake_payload_max;
4187 * struct wiphy_wowlan_support - WoWLAN support data
4188 * @flags: see &enum wiphy_wowlan_support_flags
4189 * @n_patterns: number of supported wakeup patterns
4190 * (see nl80211.h for the pattern definition)
4191 * @pattern_max_len: maximum length of each pattern
4192 * @pattern_min_len: minimum length of each pattern
4193 * @max_pkt_offset: maximum Rx packet offset
4194 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4195 * similar, but not necessarily identical, to max_match_sets for
4197 * See &struct cfg80211_sched_scan_request.@match_sets for more
4199 * @tcp: TCP wakeup support information
4201 struct wiphy_wowlan_support {
4204 int pattern_max_len;
4205 int pattern_min_len;
4207 int max_nd_match_sets;
4208 const struct wiphy_wowlan_tcp_support *tcp;
4212 * struct wiphy_coalesce_support - coalesce support data
4213 * @n_rules: maximum number of coalesce rules
4214 * @max_delay: maximum supported coalescing delay in msecs
4215 * @n_patterns: number of supported patterns in a rule
4216 * (see nl80211.h for the pattern definition)
4217 * @pattern_max_len: maximum length of each pattern
4218 * @pattern_min_len: minimum length of each pattern
4219 * @max_pkt_offset: maximum Rx packet offset
4221 struct wiphy_coalesce_support {
4225 int pattern_max_len;
4226 int pattern_min_len;
4231 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4232 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4233 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4234 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4235 * (must be combined with %_WDEV or %_NETDEV)
4237 enum wiphy_vendor_command_flags {
4238 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4239 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4240 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4244 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4246 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4247 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4248 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4251 enum wiphy_opmode_flag {
4252 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4253 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4254 STA_OPMODE_N_SS_CHANGED = BIT(2),
4258 * struct sta_opmode_info - Station's ht/vht operation mode information
4259 * @changed: contains value from &enum wiphy_opmode_flag
4260 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4261 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4262 * @rx_nss: new rx_nss value of a station
4265 struct sta_opmode_info {
4267 enum nl80211_smps_mode smps_mode;
4268 enum nl80211_chan_width bw;
4272 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4275 * struct wiphy_vendor_command - vendor command definition
4276 * @info: vendor command identifying information, as used in nl80211
4277 * @flags: flags, see &enum wiphy_vendor_command_flags
4278 * @doit: callback for the operation, note that wdev is %NULL if the
4279 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4280 * pointer may be %NULL if userspace provided no data at all
4281 * @dumpit: dump callback, for transferring bigger/multiple items. The
4282 * @storage points to cb->args[5], ie. is preserved over the multiple
4284 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4285 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4286 * attribute is just raw data (e.g. a firmware command).
4287 * @maxattr: highest attribute number in policy
4288 * It's recommended to not have the same sub command with both @doit and
4289 * @dumpit, so that userspace can assume certain ones are get and others
4290 * are used with dump requests.
4292 struct wiphy_vendor_command {
4293 struct nl80211_vendor_cmd_info info;
4295 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4296 const void *data, int data_len);
4297 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4298 struct sk_buff *skb, const void *data, int data_len,
4299 unsigned long *storage);
4300 const struct nla_policy *policy;
4301 unsigned int maxattr;
4305 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4306 * @iftype: interface type
4307 * @extended_capabilities: extended capabilities supported by the driver,
4308 * additional capabilities might be supported by userspace; these are the
4309 * 802.11 extended capabilities ("Extended Capabilities element") and are
4310 * in the same format as in the information element. See IEEE Std
4311 * 802.11-2012 8.4.2.29 for the defined fields.
4312 * @extended_capabilities_mask: mask of the valid values
4313 * @extended_capabilities_len: length of the extended capabilities
4315 struct wiphy_iftype_ext_capab {
4316 enum nl80211_iftype iftype;
4317 const u8 *extended_capabilities;
4318 const u8 *extended_capabilities_mask;
4319 u8 extended_capabilities_len;
4323 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4324 * @max_peers: maximum number of peers in a single measurement
4325 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4326 * @randomize_mac_addr: can randomize MAC address for measurement
4327 * @ftm.supported: FTM measurement is supported
4328 * @ftm.asap: ASAP-mode is supported
4329 * @ftm.non_asap: non-ASAP-mode is supported
4330 * @ftm.request_lci: can request LCI data
4331 * @ftm.request_civicloc: can request civic location data
4332 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4333 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4334 * @ftm.max_bursts_exponent: maximum burst exponent supported
4335 * (set to -1 if not limited; note that setting this will necessarily
4336 * forbid using the value 15 to let the responder pick)
4337 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4340 struct cfg80211_pmsr_capabilities {
4341 unsigned int max_peers;
4343 randomize_mac_addr:1;
4348 s8 max_bursts_exponent;
4349 u8 max_ftms_per_burst;
4359 * struct wiphy - wireless hardware description
4360 * @reg_notifier: the driver's regulatory notification callback,
4361 * note that if your driver uses wiphy_apply_custom_regulatory()
4362 * the reg_notifier's request can be passed as NULL
4363 * @regd: the driver's regulatory domain, if one was requested via
4364 * the regulatory_hint() API. This can be used by the driver
4365 * on the reg_notifier() if it chooses to ignore future
4366 * regulatory domain changes caused by other drivers.
4367 * @signal_type: signal type reported in &struct cfg80211_bss.
4368 * @cipher_suites: supported cipher suites
4369 * @n_cipher_suites: number of supported cipher suites
4370 * @akm_suites: supported AKM suites
4371 * @n_akm_suites: number of supported AKM suites
4372 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4373 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4374 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4375 * -1 = fragmentation disabled, only odd values >= 256 used
4376 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4377 * @_net: the network namespace this wiphy currently lives in
4378 * @perm_addr: permanent MAC address of this device
4379 * @addr_mask: If the device supports multiple MAC addresses by masking,
4380 * set this to a mask with variable bits set to 1, e.g. if the last
4381 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4382 * variable bits shall be determined by the interfaces added, with
4383 * interfaces not matching the mask being rejected to be brought up.
4384 * @n_addresses: number of addresses in @addresses.
4385 * @addresses: If the device has more than one address, set this pointer
4386 * to a list of addresses (6 bytes each). The first one will be used
4387 * by default for perm_addr. In this case, the mask should be set to
4388 * all-zeroes. In this case it is assumed that the device can handle
4389 * the same number of arbitrary MAC addresses.
4390 * @registered: protects ->resume and ->suspend sysfs callbacks against
4391 * unregister hardware
4392 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
4393 * automatically on wiphy renames
4394 * @dev: (virtual) struct device for this wiphy
4395 * @registered: helps synchronize suspend/resume with wiphy unregister
4396 * @wext: wireless extension handlers
4397 * @priv: driver private data (sized according to wiphy_new() parameter)
4398 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4399 * must be set by driver
4400 * @iface_combinations: Valid interface combinations array, should not
4401 * list single interface types.
4402 * @n_iface_combinations: number of entries in @iface_combinations array.
4403 * @software_iftypes: bitmask of software interface types, these are not
4404 * subject to any restrictions since they are purely managed in SW.
4405 * @flags: wiphy flags, see &enum wiphy_flags
4406 * @regulatory_flags: wiphy regulatory flags, see
4407 * &enum ieee80211_regulatory_flags
4408 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4409 * @ext_features: extended features advertised to nl80211, see
4410 * &enum nl80211_ext_feature_index.
4411 * @bss_priv_size: each BSS struct has private data allocated with it,
4412 * this variable determines its size
4413 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4415 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4416 * the device can run concurrently.
4417 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4418 * for in any given scheduled scan
4419 * @max_match_sets: maximum number of match sets the device can handle
4420 * when performing a scheduled scan, 0 if filtering is not
4422 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4423 * add to probe request frames transmitted during a scan, must not
4424 * include fixed IEs like supported rates
4425 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4427 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4428 * of iterations) for scheduled scan supported by the device.
4429 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4430 * single scan plan supported by the device.
4431 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4432 * scan plan supported by the device.
4433 * @coverage_class: current coverage class
4434 * @fw_version: firmware version for ethtool reporting
4435 * @hw_version: hardware version for ethtool reporting
4436 * @max_num_pmkids: maximum number of PMKIDs supported by device
4437 * @privid: a pointer that drivers can use to identify if an arbitrary
4438 * wiphy is theirs, e.g. in global notifiers
4439 * @bands: information about bands/channels supported by this device
4441 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4442 * transmitted through nl80211, points to an array indexed by interface
4445 * @available_antennas_tx: bitmap of antennas which are available to be
4446 * configured as TX antennas. Antenna configuration commands will be
4447 * rejected unless this or @available_antennas_rx is set.
4449 * @available_antennas_rx: bitmap of antennas which are available to be
4450 * configured as RX antennas. Antenna configuration commands will be
4451 * rejected unless this or @available_antennas_tx is set.
4453 * @probe_resp_offload:
4454 * Bitmap of supported protocols for probe response offloading.
4455 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4456 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4458 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4459 * may request, if implemented.
4461 * @wowlan: WoWLAN support information
4462 * @wowlan_config: current WoWLAN configuration; this should usually not be
4463 * used since access to it is necessarily racy, use the parameter passed
4464 * to the suspend() operation instead.
4466 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4467 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4468 * If null, then none can be over-ridden.
4469 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4470 * If null, then none can be over-ridden.
4472 * @wdev_list: the list of associated (virtual) interfaces; this list must
4473 * not be modified by the driver, but can be read with RTNL/RCU protection.
4475 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4478 * @extended_capabilities: extended capabilities supported by the driver,
4479 * additional capabilities might be supported by userspace; these are
4480 * the 802.11 extended capabilities ("Extended Capabilities element")
4481 * and are in the same format as in the information element. See
4482 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4483 * extended capabilities to be used if the capabilities are not specified
4484 * for a specific interface type in iftype_ext_capab.
4485 * @extended_capabilities_mask: mask of the valid values
4486 * @extended_capabilities_len: length of the extended capabilities
4487 * @iftype_ext_capab: array of extended capabilities per interface type
4488 * @num_iftype_ext_capab: number of interface types for which extended
4489 * capabilities are specified separately.
4490 * @coalesce: packet coalescing support information
4492 * @vendor_commands: array of vendor commands supported by the hardware
4493 * @n_vendor_commands: number of vendor commands
4494 * @vendor_events: array of vendor events supported by the hardware
4495 * @n_vendor_events: number of vendor events
4497 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4498 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4499 * driver is allowed to advertise a theoretical limit that it can reach in
4500 * some cases, but may not always reach.
4502 * @max_num_csa_counters: Number of supported csa_counters in beacons
4503 * and probe responses. This value should be set if the driver
4504 * wishes to limit the number of csa counters. Default (0) means
4506 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
4507 * frame was sent and the channel on which the frame was heard for which
4508 * the reported rssi is still valid. If a driver is able to compensate the
4509 * low rssi when a frame is heard on different channel, then it should set
4510 * this variable to the maximal offset for which it can compensate.
4511 * This value should be set in MHz.
4512 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4513 * by the driver in the .connect() callback. The bit position maps to the
4514 * attribute indices defined in &enum nl80211_bss_select_attr.
4516 * @nan_supported_bands: bands supported by the device in NAN mode, a
4517 * bitmap of &enum nl80211_band values. For instance, for
4518 * NL80211_BAND_2GHZ, bit 0 would be set
4519 * (i.e. BIT(NL80211_BAND_2GHZ)).
4521 * @txq_limit: configuration of internal TX queue frame limit
4522 * @txq_memory_limit: configuration internal TX queue memory limit
4523 * @txq_quantum: configuration of internal TX queue scheduler quantum
4525 * @support_mbssid: can HW support association with nontransmitted AP
4526 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4527 * HE AP, in order to avoid compatibility issues.
4528 * @support_mbssid must be set for this to have any effect.
4530 * @pmsr_capa: peer measurement capabilities
4533 /* assign these fields before you register the wiphy */
4535 /* permanent MAC address(es) */
4536 u8 perm_addr[ETH_ALEN];
4537 u8 addr_mask[ETH_ALEN];
4539 struct mac_address *addresses;
4541 const struct ieee80211_txrx_stypes *mgmt_stypes;
4543 const struct ieee80211_iface_combination *iface_combinations;
4544 int n_iface_combinations;
4545 u16 software_iftypes;
4549 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4550 u16 interface_modes;
4552 u16 max_acl_mac_addrs;
4554 u32 flags, regulatory_flags, features;
4555 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4559 enum cfg80211_signal_type signal_type;
4563 u8 max_sched_scan_reqs;
4564 u8 max_sched_scan_ssids;
4566 u16 max_scan_ie_len;
4567 u16 max_sched_scan_ie_len;
4568 u32 max_sched_scan_plans;
4569 u32 max_sched_scan_plan_interval;
4570 u32 max_sched_scan_plan_iterations;
4572 int n_cipher_suites;
4573 const u32 *cipher_suites;
4576 const u32 *akm_suites;
4584 char fw_version[ETHTOOL_FWVERS_LEN];
4588 const struct wiphy_wowlan_support *wowlan;
4589 struct cfg80211_wowlan *wowlan_config;
4592 u16 max_remain_on_channel_duration;
4596 u32 available_antennas_tx;
4597 u32 available_antennas_rx;
4600 * Bitmap of supported protocols for probe response offloading
4601 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
4602 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4604 u32 probe_resp_offload;
4606 const u8 *extended_capabilities, *extended_capabilities_mask;
4607 u8 extended_capabilities_len;
4609 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4610 unsigned int num_iftype_ext_capab;
4612 /* If multiple wiphys are registered and you're handed e.g.
4613 * a regular netdev with assigned ieee80211_ptr, you won't
4614 * know whether it points to a wiphy your driver has registered
4615 * or not. Assign this to something global to your driver to
4616 * help determine whether you own this wiphy or not. */
4619 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4621 /* Lets us get back the wiphy on the callback */
4622 void (*reg_notifier)(struct wiphy *wiphy,
4623 struct regulatory_request *request);
4625 /* fields below are read-only, assigned by cfg80211 */
4627 const struct ieee80211_regdomain __rcu *regd;
4629 /* the item in /sys/class/ieee80211/ points to this,
4630 * you need use set_wiphy_dev() (see below) */
4633 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
4636 /* dir in debugfs: ieee80211/<wiphyname> */
4637 struct dentry *debugfsdir;
4639 const struct ieee80211_ht_cap *ht_capa_mod_mask;
4640 const struct ieee80211_vht_cap *vht_capa_mod_mask;
4642 struct list_head wdev_list;
4644 /* the network namespace this phy lives in currently */
4645 possible_net_t _net;
4647 #ifdef CONFIG_CFG80211_WEXT
4648 const struct iw_handler_def *wext;
4651 const struct wiphy_coalesce_support *coalesce;
4653 const struct wiphy_vendor_command *vendor_commands;
4654 const struct nl80211_vendor_cmd_info *vendor_events;
4655 int n_vendor_commands, n_vendor_events;
4657 u16 max_ap_assoc_sta;
4659 u8 max_num_csa_counters;
4660 u8 max_adj_channel_rssi_comp;
4662 u32 bss_select_support;
4664 u8 nan_supported_bands;
4667 u32 txq_memory_limit;
4670 u8 support_mbssid:1,
4671 support_only_he_mbssid:1;
4673 const struct cfg80211_pmsr_capabilities *pmsr_capa;
4675 char priv[0] __aligned(NETDEV_ALIGN);
4678 static inline struct net *wiphy_net(struct wiphy *wiphy)
4680 return read_pnet(&wiphy->_net);
4683 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4685 write_pnet(&wiphy->_net, net);
4689 * wiphy_priv - return priv from wiphy
4691 * @wiphy: the wiphy whose priv pointer to return
4692 * Return: The priv of @wiphy.
4694 static inline void *wiphy_priv(struct wiphy *wiphy)
4697 return &wiphy->priv;
4701 * priv_to_wiphy - return the wiphy containing the priv
4703 * @priv: a pointer previously returned by wiphy_priv
4704 * Return: The wiphy of @priv.
4706 static inline struct wiphy *priv_to_wiphy(void *priv)
4709 return container_of(priv, struct wiphy, priv);
4713 * set_wiphy_dev - set device pointer for wiphy
4715 * @wiphy: The wiphy whose device to bind
4716 * @dev: The device to parent it to
4718 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4720 wiphy->dev.parent = dev;
4724 * wiphy_dev - get wiphy dev pointer
4726 * @wiphy: The wiphy whose device struct to look up
4727 * Return: The dev of @wiphy.
4729 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4731 return wiphy->dev.parent;
4735 * wiphy_name - get wiphy name
4737 * @wiphy: The wiphy whose name to return
4738 * Return: The name of @wiphy.
4740 static inline const char *wiphy_name(const struct wiphy *wiphy)
4742 return dev_name(&wiphy->dev);
4746 * wiphy_new_nm - create a new wiphy for use with cfg80211
4748 * @ops: The configuration operations for this device
4749 * @sizeof_priv: The size of the private area to allocate
4750 * @requested_name: Request a particular name.
4751 * NULL is valid value, and means use the default phy%d naming.
4753 * Create a new wiphy and associate the given operations with it.
4754 * @sizeof_priv bytes are allocated for private use.
4756 * Return: A pointer to the new wiphy. This pointer must be
4757 * assigned to each netdev's ieee80211_ptr for proper operation.
4759 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4760 const char *requested_name);
4763 * wiphy_new - create a new wiphy for use with cfg80211
4765 * @ops: The configuration operations for this device
4766 * @sizeof_priv: The size of the private area to allocate
4768 * Create a new wiphy and associate the given operations with it.
4769 * @sizeof_priv bytes are allocated for private use.
4771 * Return: A pointer to the new wiphy. This pointer must be
4772 * assigned to each netdev's ieee80211_ptr for proper operation.
4774 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4777 return wiphy_new_nm(ops, sizeof_priv, NULL);
4781 * wiphy_register - register a wiphy with cfg80211
4783 * @wiphy: The wiphy to register.
4785 * Return: A non-negative wiphy index or a negative error code.
4787 int wiphy_register(struct wiphy *wiphy);
4790 * wiphy_unregister - deregister a wiphy from cfg80211
4792 * @wiphy: The wiphy to unregister.
4794 * After this call, no more requests can be made with this priv
4795 * pointer, but the call may sleep to wait for an outstanding
4796 * request that is being handled.
4798 void wiphy_unregister(struct wiphy *wiphy);
4801 * wiphy_free - free wiphy
4803 * @wiphy: The wiphy to free
4805 void wiphy_free(struct wiphy *wiphy);
4807 /* internal structs */
4808 struct cfg80211_conn;
4809 struct cfg80211_internal_bss;
4810 struct cfg80211_cached_keys;
4811 struct cfg80211_cqm_config;
4814 * struct wireless_dev - wireless device state
4816 * For netdevs, this structure must be allocated by the driver
4817 * that uses the ieee80211_ptr field in struct net_device (this
4818 * is intentional so it can be allocated along with the netdev.)
4819 * It need not be registered then as netdev registration will
4820 * be intercepted by cfg80211 to see the new wireless device.
4822 * For non-netdev uses, it must also be allocated by the driver
4823 * in response to the cfg80211 callbacks that require it, as
4824 * there's no netdev registration in that case it may not be
4825 * allocated outside of callback operations that return it.
4827 * @wiphy: pointer to hardware description
4828 * @iftype: interface type
4829 * @list: (private) Used to collect the interfaces
4830 * @netdev: (private) Used to reference back to the netdev, may be %NULL
4831 * @identifier: (private) Identifier used in nl80211 to identify this
4832 * wireless device if it has no netdev
4833 * @current_bss: (private) Used by the internal configuration code
4834 * @chandef: (private) Used by the internal configuration code to track
4835 * the user-set channel definition.
4836 * @preset_chandef: (private) Used by the internal configuration code to
4837 * track the channel to be used for AP later
4838 * @bssid: (private) Used by the internal configuration code
4839 * @ssid: (private) Used by the internal configuration code
4840 * @ssid_len: (private) Used by the internal configuration code
4841 * @mesh_id_len: (private) Used by the internal configuration code
4842 * @mesh_id_up_len: (private) Used by the internal configuration code
4843 * @wext: (private) Used by the internal wireless extensions compat code
4844 * @wext.ibss: (private) IBSS data part of wext handling
4845 * @wext.connect: (private) connection handling data
4846 * @wext.keys: (private) (WEP) key data
4847 * @wext.ie: (private) extra elements for association
4848 * @wext.ie_len: (private) length of extra elements
4849 * @wext.bssid: (private) selected network BSSID
4850 * @wext.ssid: (private) selected network SSID
4851 * @wext.default_key: (private) selected default key index
4852 * @wext.default_mgmt_key: (private) selected default management key index
4853 * @wext.prev_bssid: (private) previous BSSID for reassociation
4854 * @wext.prev_bssid_valid: (private) previous BSSID validity
4855 * @use_4addr: indicates 4addr mode is used on this interface, must be
4856 * set by driver (if supported) on add_interface BEFORE registering the
4857 * netdev and may otherwise be used by driver read-only, will be update
4858 * by cfg80211 on change_interface
4859 * @mgmt_registrations: list of registrations for management frames
4860 * @mgmt_registrations_lock: lock for the list
4861 * @mtx: mutex used to lock data in this struct, may be used by drivers
4862 * and some API functions require it held
4863 * @beacon_interval: beacon interval used on this device for transmitting
4864 * beacons, 0 when not valid
4865 * @address: The address for this device, valid only if @netdev is %NULL
4866 * @is_running: true if this is a non-netdev device that has been started, e.g.
4868 * @cac_started: true if DFS channel availability check has been started
4869 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4870 * @cac_time_ms: CAC time in ms
4871 * @ps: powersave mode is enabled
4872 * @ps_timeout: dynamic powersave timeout
4873 * @ap_unexpected_nlportid: (private) netlink port ID of application
4874 * registered for unexpected class 3 frames (AP mode)
4875 * @conn: (private) cfg80211 software SME connection state machine data
4876 * @connect_keys: (private) keys to set after connection is established
4877 * @conn_bss_type: connecting/connected BSS type
4878 * @conn_owner_nlportid: (private) connection owner socket port ID
4879 * @disconnect_wk: (private) auto-disconnect work
4880 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4881 * @ibss_fixed: (private) IBSS is using fixed BSSID
4882 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4883 * @event_list: (private) list for internal event processing
4884 * @event_lock: (private) lock for event list
4885 * @owner_nlportid: (private) owner socket port ID
4886 * @nl_owner_dead: (private) owner socket went away
4887 * @cqm_config: (private) nl80211 RSSI monitor state
4888 * @pmsr_list: (private) peer measurement requests
4889 * @pmsr_lock: (private) peer measurements requests/results lock
4890 * @pmsr_free_wk: (private) peer measurements cleanup work
4892 struct wireless_dev {
4893 struct wiphy *wiphy;
4894 enum nl80211_iftype iftype;
4896 /* the remainder of this struct should be private to cfg80211 */
4897 struct list_head list;
4898 struct net_device *netdev;
4902 struct list_head mgmt_registrations;
4903 spinlock_t mgmt_registrations_lock;
4907 bool use_4addr, is_running;
4909 u8 address[ETH_ALEN] __aligned(sizeof(u16));
4911 /* currently used for IBSS and SME - might be rearranged later */
4912 u8 ssid[IEEE80211_MAX_SSID_LEN];
4913 u8 ssid_len, mesh_id_len, mesh_id_up_len;
4914 struct cfg80211_conn *conn;
4915 struct cfg80211_cached_keys *connect_keys;
4916 enum ieee80211_bss_type conn_bss_type;
4917 u32 conn_owner_nlportid;
4919 struct work_struct disconnect_wk;
4920 u8 disconnect_bssid[ETH_ALEN];
4922 struct list_head event_list;
4923 spinlock_t event_lock;
4925 struct cfg80211_internal_bss *current_bss; /* associated / joined */
4926 struct cfg80211_chan_def preset_chandef;
4927 struct cfg80211_chan_def chandef;
4930 bool ibss_dfs_possible;
4935 int beacon_interval;
4937 u32 ap_unexpected_nlportid;
4943 unsigned long cac_start_time;
4944 unsigned int cac_time_ms;
4946 #ifdef CONFIG_CFG80211_WEXT
4949 struct cfg80211_ibss_params ibss;
4950 struct cfg80211_connect_params connect;
4951 struct cfg80211_cached_keys *keys;
4955 u8 prev_bssid[ETH_ALEN];
4956 u8 ssid[IEEE80211_MAX_SSID_LEN];
4957 s8 default_key, default_mgmt_key;
4958 bool prev_bssid_valid;
4962 struct cfg80211_cqm_config *cqm_config;
4964 struct list_head pmsr_list;
4965 spinlock_t pmsr_lock;
4966 struct work_struct pmsr_free_wk;
4969 static inline u8 *wdev_address(struct wireless_dev *wdev)
4972 return wdev->netdev->dev_addr;
4973 return wdev->address;
4976 static inline bool wdev_running(struct wireless_dev *wdev)
4979 return netif_running(wdev->netdev);
4980 return wdev->is_running;
4984 * wdev_priv - return wiphy priv from wireless_dev
4986 * @wdev: The wireless device whose wiphy's priv pointer to return
4987 * Return: The wiphy priv of @wdev.
4989 static inline void *wdev_priv(struct wireless_dev *wdev)
4992 return wiphy_priv(wdev->wiphy);
4996 * DOC: Utility functions
4998 * cfg80211 offers a number of utility functions that can be useful.
5002 * ieee80211_channel_to_frequency - convert channel number to frequency
5003 * @chan: channel number
5004 * @band: band, necessary due to channel number overlap
5005 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5007 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
5010 * ieee80211_frequency_to_channel - convert frequency to channel number
5011 * @freq: center frequency
5012 * Return: The corresponding channel, or 0 if the conversion failed.
5014 int ieee80211_frequency_to_channel(int freq);
5017 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5019 * @wiphy: the struct wiphy to get the channel for
5020 * @freq: the center frequency of the channel
5022 * Return: The channel struct from @wiphy at @freq.
5024 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
5027 * ieee80211_get_response_rate - get basic rate for a given rate
5029 * @sband: the band to look for rates in
5030 * @basic_rates: bitmap of basic rates
5031 * @bitrate: the bitrate for which to find the basic rate
5033 * Return: The basic rate corresponding to a given bitrate, that
5034 * is the next lower bitrate contained in the basic rate map,
5035 * which is, for this function, given as a bitmap of indices of
5036 * rates in the band's bitrate table.
5038 struct ieee80211_rate *
5039 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5040 u32 basic_rates, int bitrate);
5043 * ieee80211_mandatory_rates - get mandatory rates for a given band
5044 * @sband: the band to look for rates in
5045 * @scan_width: width of the control channel
5047 * This function returns a bitmap of the mandatory rates for the given
5048 * band, bits are set according to the rate position in the bitrates array.
5050 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5051 enum nl80211_bss_scan_width scan_width);
5054 * Radiotap parsing functions -- for controlled injection support
5056 * Implemented in net/wireless/radiotap.c
5057 * Documentation in Documentation/networking/radiotap-headers.txt
5060 struct radiotap_align_size {
5061 uint8_t align:4, size:4;
5064 struct ieee80211_radiotap_namespace {
5065 const struct radiotap_align_size *align_size;
5071 struct ieee80211_radiotap_vendor_namespaces {
5072 const struct ieee80211_radiotap_namespace *ns;
5077 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5078 * @this_arg_index: index of current arg, valid after each successful call
5079 * to ieee80211_radiotap_iterator_next()
5080 * @this_arg: pointer to current radiotap arg; it is valid after each
5081 * call to ieee80211_radiotap_iterator_next() but also after
5082 * ieee80211_radiotap_iterator_init() where it will point to
5083 * the beginning of the actual data portion
5084 * @this_arg_size: length of the current arg, for convenience
5085 * @current_namespace: pointer to the current namespace definition
5086 * (or internally %NULL if the current namespace is unknown)
5087 * @is_radiotap_ns: indicates whether the current namespace is the default
5088 * radiotap namespace or not
5090 * @_rtheader: pointer to the radiotap header we are walking through
5091 * @_max_length: length of radiotap header in cpu byte ordering
5092 * @_arg_index: next argument index
5093 * @_arg: next argument pointer
5094 * @_next_bitmap: internal pointer to next present u32
5095 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5096 * @_vns: vendor namespace definitions
5097 * @_next_ns_data: beginning of the next namespace's data
5098 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5101 * Describes the radiotap parser state. Fields prefixed with an underscore
5102 * must not be used by users of the parser, only by the parser internally.
5105 struct ieee80211_radiotap_iterator {
5106 struct ieee80211_radiotap_header *_rtheader;
5107 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5108 const struct ieee80211_radiotap_namespace *current_namespace;
5110 unsigned char *_arg, *_next_ns_data;
5111 __le32 *_next_bitmap;
5113 unsigned char *this_arg;
5121 uint32_t _bitmap_shifter;
5126 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5127 struct ieee80211_radiotap_header *radiotap_header,
5129 const struct ieee80211_radiotap_vendor_namespaces *vns);
5132 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5135 extern const unsigned char rfc1042_header[6];
5136 extern const unsigned char bridge_tunnel_header[6];
5139 * ieee80211_get_hdrlen_from_skb - get header length from data
5143 * Given an skb with a raw 802.11 header at the data pointer this function
5144 * returns the 802.11 header length.
5146 * Return: The 802.11 header length in bytes (not including encryption
5147 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5150 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5153 * ieee80211_hdrlen - get header length in bytes from frame control
5154 * @fc: frame control field in little-endian format
5155 * Return: The header length in bytes.
5157 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5160 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5161 * @meshhdr: the mesh extension header, only the flags field
5162 * (first byte) will be accessed
5163 * Return: The length of the extension header, which is always at
5164 * least 6 bytes and at most 18 if address 5 and 6 are present.
5166 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5169 * DOC: Data path helpers
5171 * In addition to generic utilities, cfg80211 also offers
5172 * functions that help implement the data path for devices
5173 * that do not do the 802.11/802.3 conversion on the device.
5177 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5178 * @skb: the 802.11 data frame
5179 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5180 * of it being pushed into the SKB
5181 * @addr: the device MAC address
5182 * @iftype: the virtual interface type
5183 * @data_offset: offset of payload after the 802.11 header
5184 * Return: 0 on success. Non-zero on error.
5186 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5187 const u8 *addr, enum nl80211_iftype iftype,
5191 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5192 * @skb: the 802.11 data frame
5193 * @addr: the device MAC address
5194 * @iftype: the virtual interface type
5195 * Return: 0 on success. Non-zero on error.
5197 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5198 enum nl80211_iftype iftype)
5200 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5204 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5206 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5207 * The @list will be empty if the decode fails. The @skb must be fully
5208 * header-less before being passed in here; it is freed in this function.
5210 * @skb: The input A-MSDU frame without any headers.
5211 * @list: The output list of 802.3 frames. It must be allocated and
5212 * initialized by by the caller.
5213 * @addr: The device MAC address.
5214 * @iftype: The device interface type.
5215 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5216 * @check_da: DA to check in the inner ethernet header, or NULL
5217 * @check_sa: SA to check in the inner ethernet header, or NULL
5219 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5220 const u8 *addr, enum nl80211_iftype iftype,
5221 const unsigned int extra_headroom,
5222 const u8 *check_da, const u8 *check_sa);
5225 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5226 * @skb: the data frame
5227 * @qos_map: Interworking QoS mapping or %NULL if not in use
5228 * Return: The 802.1p/1d tag.
5230 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5231 struct cfg80211_qos_map *qos_map);
5234 * cfg80211_find_elem_match - match information element and byte array in data
5237 * @ies: data consisting of IEs
5238 * @len: length of data
5239 * @match: byte array to match
5240 * @match_len: number of bytes in the match array
5241 * @match_offset: offset in the IE data where the byte array should match.
5242 * Note the difference to cfg80211_find_ie_match() which considers
5243 * the offset to start from the element ID byte, but here we take
5244 * the data portion instead.
5246 * Return: %NULL if the element ID could not be found or if
5247 * the element is invalid (claims to be longer than the given
5248 * data) or if the byte array doesn't match; otherwise return the
5249 * requested element struct.
5251 * Note: There are no checks on the element length other than
5252 * having to fit into the given data and being large enough for the
5253 * byte array to match.
5255 const struct element *
5256 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5257 const u8 *match, unsigned int match_len,
5258 unsigned int match_offset);
5261 * cfg80211_find_ie_match - match information element and byte array in data
5264 * @ies: data consisting of IEs
5265 * @len: length of data
5266 * @match: byte array to match
5267 * @match_len: number of bytes in the match array
5268 * @match_offset: offset in the IE where the byte array should match.
5269 * If match_len is zero, this must also be set to zero.
5270 * Otherwise this must be set to 2 or more, because the first
5271 * byte is the element id, which is already compared to eid, and
5272 * the second byte is the IE length.
5274 * Return: %NULL if the element ID could not be found or if
5275 * the element is invalid (claims to be longer than the given
5276 * data) or if the byte array doesn't match, or a pointer to the first
5277 * byte of the requested element, that is the byte containing the
5280 * Note: There are no checks on the element length other than
5281 * having to fit into the given data and being large enough for the
5282 * byte array to match.
5284 static inline const u8 *
5285 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5286 const u8 *match, unsigned int match_len,
5287 unsigned int match_offset)
5289 /* match_offset can't be smaller than 2, unless match_len is
5290 * zero, in which case match_offset must be zero as well.
5292 if (WARN_ON((match_len && match_offset < 2) ||
5293 (!match_len && match_offset)))
5296 return (void *)cfg80211_find_elem_match(eid, ies, len,
5299 match_offset - 2 : 0);
5303 * cfg80211_find_elem - find information element in data
5306 * @ies: data consisting of IEs
5307 * @len: length of data
5309 * Return: %NULL if the element ID could not be found or if
5310 * the element is invalid (claims to be longer than the given
5311 * data) or if the byte array doesn't match; otherwise return the
5312 * requested element struct.
5314 * Note: There are no checks on the element length other than
5315 * having to fit into the given data.
5317 static inline const struct element *
5318 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5320 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5324 * cfg80211_find_ie - find information element in data
5327 * @ies: data consisting of IEs
5328 * @len: length of data
5330 * Return: %NULL if the element ID could not be found or if
5331 * the element is invalid (claims to be longer than the given
5332 * data), or a pointer to the first byte of the requested
5333 * element, that is the byte containing the element ID.
5335 * Note: There are no checks on the element length other than
5336 * having to fit into the given data.
5338 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5340 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5344 * cfg80211_find_ext_elem - find information element with EID Extension in data
5346 * @ext_eid: element ID Extension
5347 * @ies: data consisting of IEs
5348 * @len: length of data
5350 * Return: %NULL if the etended element could not be found or if
5351 * the element is invalid (claims to be longer than the given
5352 * data) or if the byte array doesn't match; otherwise return the
5353 * requested element struct.
5355 * Note: There are no checks on the element length other than
5356 * having to fit into the given data.
5358 static inline const struct element *
5359 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5361 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5366 * cfg80211_find_ext_ie - find information element with EID Extension in data
5368 * @ext_eid: element ID Extension
5369 * @ies: data consisting of IEs
5370 * @len: length of data
5372 * Return: %NULL if the extended element ID could not be found or if
5373 * the element is invalid (claims to be longer than the given
5374 * data), or a pointer to the first byte of the requested
5375 * element, that is the byte containing the element ID.
5377 * Note: There are no checks on the element length other than
5378 * having to fit into the given data.
5380 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5382 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5387 * cfg80211_find_vendor_elem - find vendor specific information element in data
5390 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5391 * @ies: data consisting of IEs
5392 * @len: length of data
5394 * Return: %NULL if the vendor specific element ID could not be found or if the
5395 * element is invalid (claims to be longer than the given data); otherwise
5396 * return the element structure for the requested element.
5398 * Note: There are no checks on the element length other than having to fit into
5401 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5406 * cfg80211_find_vendor_ie - find vendor specific information element in data
5409 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5410 * @ies: data consisting of IEs
5411 * @len: length of data
5413 * Return: %NULL if the vendor specific element ID could not be found or if the
5414 * element is invalid (claims to be longer than the given data), or a pointer to
5415 * the first byte of the requested element, that is the byte containing the
5418 * Note: There are no checks on the element length other than having to fit into
5421 static inline const u8 *
5422 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5423 const u8 *ies, unsigned int len)
5425 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5429 * cfg80211_send_layer2_update - send layer 2 update frame
5431 * @dev: network device
5432 * @addr: STA MAC address
5434 * Wireless drivers can use this function to update forwarding tables in bridge
5435 * devices upon STA association.
5437 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5440 * DOC: Regulatory enforcement infrastructure
5446 * regulatory_hint - driver hint to the wireless core a regulatory domain
5447 * @wiphy: the wireless device giving the hint (used only for reporting
5449 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5450 * should be in. If @rd is set this should be NULL. Note that if you
5451 * set this to NULL you should still set rd->alpha2 to some accepted
5454 * Wireless drivers can use this function to hint to the wireless core
5455 * what it believes should be the current regulatory domain by
5456 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5457 * domain should be in or by providing a completely build regulatory domain.
5458 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5459 * for a regulatory domain structure for the respective country.
5461 * The wiphy must have been registered to cfg80211 prior to this call.
5462 * For cfg80211 drivers this means you must first use wiphy_register(),
5463 * for mac80211 drivers you must first use ieee80211_register_hw().
5465 * Drivers should check the return value, its possible you can get
5468 * Return: 0 on success. -ENOMEM.
5470 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5473 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5474 * @wiphy: the wireless device we want to process the regulatory domain on
5475 * @rd: the regulatory domain informatoin to use for this wiphy
5477 * Set the regulatory domain information for self-managed wiphys, only they
5478 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5481 * Return: 0 on success. -EINVAL, -EPERM
5483 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5484 struct ieee80211_regdomain *rd);
5487 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5488 * @wiphy: the wireless device we want to process the regulatory domain on
5489 * @rd: the regulatory domain information to use for this wiphy
5491 * This functions requires the RTNL to be held and applies the new regdomain
5492 * synchronously to this wiphy. For more details see
5493 * regulatory_set_wiphy_regd().
5495 * Return: 0 on success. -EINVAL, -EPERM
5497 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5498 struct ieee80211_regdomain *rd);
5501 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5502 * @wiphy: the wireless device we want to process the regulatory domain on
5503 * @regd: the custom regulatory domain to use for this wiphy
5505 * Drivers can sometimes have custom regulatory domains which do not apply
5506 * to a specific country. Drivers can use this to apply such custom regulatory
5507 * domains. This routine must be called prior to wiphy registration. The
5508 * custom regulatory domain will be trusted completely and as such previous
5509 * default channel settings will be disregarded. If no rule is found for a
5510 * channel on the regulatory domain the channel will be disabled.
5511 * Drivers using this for a wiphy should also set the wiphy flag
5512 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5513 * that called this helper.
5515 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5516 const struct ieee80211_regdomain *regd);
5519 * freq_reg_info - get regulatory information for the given frequency
5520 * @wiphy: the wiphy for which we want to process this rule for
5521 * @center_freq: Frequency in KHz for which we want regulatory information for
5523 * Use this function to get the regulatory rule for a specific frequency on
5524 * a given wireless device. If the device has a specific regulatory domain
5525 * it wants to follow we respect that unless a country IE has been received
5526 * and processed already.
5528 * Return: A valid pointer, or, when an error occurs, for example if no rule
5529 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5530 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5531 * value will be -ERANGE if we determine the given center_freq does not even
5532 * have a regulatory rule for a frequency range in the center_freq's band.
5533 * See freq_in_rule_band() for our current definition of a band -- this is
5534 * purely subjective and right now it's 802.11 specific.
5536 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5540 * reg_initiator_name - map regulatory request initiator enum to name
5541 * @initiator: the regulatory request initiator
5543 * You can use this to map the regulatory request initiator enum to a
5544 * proper string representation.
5546 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5549 * DOC: Internal regulatory db functions
5554 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
5555 * Regulatory self-managed driver can use it to proactively
5557 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5558 * @freq: the freqency(in MHz) to be queried.
5559 * @rule: pointer to store the wmm rule from the regulatory db.
5561 * Self-managed wireless drivers can use this function to query
5562 * the internal regulatory database to check whether the given
5563 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5565 * Drivers should check the return value, its possible you can get
5568 * Return: 0 on success. -ENODATA.
5570 int reg_query_regdb_wmm(char *alpha2, int freq,
5571 struct ieee80211_reg_rule *rule);
5574 * callbacks for asynchronous cfg80211 methods, notification
5575 * functions and BSS handling helpers
5579 * cfg80211_scan_done - notify that scan finished
5581 * @request: the corresponding scan request
5582 * @info: information about the completed scan
5584 void cfg80211_scan_done(struct cfg80211_scan_request *request,
5585 struct cfg80211_scan_info *info);
5588 * cfg80211_sched_scan_results - notify that new scan results are available
5590 * @wiphy: the wiphy which got scheduled scan results
5591 * @reqid: identifier for the related scheduled scan request
5593 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
5596 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5598 * @wiphy: the wiphy on which the scheduled scan stopped
5599 * @reqid: identifier for the related scheduled scan request
5601 * The driver can call this function to inform cfg80211 that the
5602 * scheduled scan had to be stopped, for whatever reason. The driver
5603 * is then called back via the sched_scan_stop operation when done.
5605 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
5608 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5610 * @wiphy: the wiphy on which the scheduled scan stopped
5611 * @reqid: identifier for the related scheduled scan request
5613 * The driver can call this function to inform cfg80211 that the
5614 * scheduled scan had to be stopped, for whatever reason. The driver
5615 * is then called back via the sched_scan_stop operation when done.
5616 * This function should be called with rtnl locked.
5618 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
5621 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5622 * @wiphy: the wiphy reporting the BSS
5623 * @data: the BSS metadata
5624 * @mgmt: the management frame (probe response or beacon)
5625 * @len: length of the management frame
5626 * @gfp: context flags
5628 * This informs cfg80211 that BSS information was found and
5629 * the BSS should be updated/added.
5631 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5632 * Or %NULL on error.
5634 struct cfg80211_bss * __must_check
5635 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
5636 struct cfg80211_inform_bss *data,
5637 struct ieee80211_mgmt *mgmt, size_t len,
5640 static inline struct cfg80211_bss * __must_check
5641 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
5642 struct ieee80211_channel *rx_channel,
5643 enum nl80211_bss_scan_width scan_width,
5644 struct ieee80211_mgmt *mgmt, size_t len,
5645 s32 signal, gfp_t gfp)
5647 struct cfg80211_inform_bss data = {
5649 .scan_width = scan_width,
5653 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5656 static inline struct cfg80211_bss * __must_check
5657 cfg80211_inform_bss_frame(struct wiphy *wiphy,
5658 struct ieee80211_channel *rx_channel,
5659 struct ieee80211_mgmt *mgmt, size_t len,
5660 s32 signal, gfp_t gfp)
5662 struct cfg80211_inform_bss data = {
5664 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5668 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5672 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5673 * @bssid: transmitter BSSID
5674 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5675 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5676 * @new_bssid: calculated nontransmitted BSSID
5678 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
5679 u8 mbssid_index, u8 *new_bssid)
5681 u64 bssid_u64 = ether_addr_to_u64(bssid);
5682 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
5685 new_bssid_u64 = bssid_u64 & ~mask;
5687 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
5689 u64_to_ether_addr(new_bssid_u64, new_bssid);
5693 * cfg80211_is_element_inherited - returns if element ID should be inherited
5694 * @element: element to check
5695 * @non_inherit_element: non inheritance element
5697 bool cfg80211_is_element_inherited(const struct element *element,
5698 const struct element *non_inherit_element);
5701 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
5703 * @ielen: length of IEs
5704 * @mbssid_elem: current MBSSID element
5705 * @sub_elem: current MBSSID subelement (profile)
5706 * @merged_ie: location of the merged profile
5707 * @max_copy_len: max merged profile length
5709 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
5710 const struct element *mbssid_elem,
5711 const struct element *sub_elem,
5712 u8 *merged_ie, size_t max_copy_len);
5715 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
5716 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
5717 * from a beacon or probe response
5718 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
5719 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
5721 enum cfg80211_bss_frame_type {
5722 CFG80211_BSS_FTYPE_UNKNOWN,
5723 CFG80211_BSS_FTYPE_BEACON,
5724 CFG80211_BSS_FTYPE_PRESP,
5728 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
5730 * @wiphy: the wiphy reporting the BSS
5731 * @data: the BSS metadata
5732 * @ftype: frame type (if known)
5733 * @bssid: the BSSID of the BSS
5734 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5735 * @capability: the capability field sent by the peer
5736 * @beacon_interval: the beacon interval announced by the peer
5737 * @ie: additional IEs sent by the peer
5738 * @ielen: length of the additional IEs
5739 * @gfp: context flags
5741 * This informs cfg80211 that BSS information was found and
5742 * the BSS should be updated/added.
5744 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5745 * Or %NULL on error.
5747 struct cfg80211_bss * __must_check
5748 cfg80211_inform_bss_data(struct wiphy *wiphy,
5749 struct cfg80211_inform_bss *data,
5750 enum cfg80211_bss_frame_type ftype,
5751 const u8 *bssid, u64 tsf, u16 capability,
5752 u16 beacon_interval, const u8 *ie, size_t ielen,
5755 static inline struct cfg80211_bss * __must_check
5756 cfg80211_inform_bss_width(struct wiphy *wiphy,
5757 struct ieee80211_channel *rx_channel,
5758 enum nl80211_bss_scan_width scan_width,
5759 enum cfg80211_bss_frame_type ftype,
5760 const u8 *bssid, u64 tsf, u16 capability,
5761 u16 beacon_interval, const u8 *ie, size_t ielen,
5762 s32 signal, gfp_t gfp)
5764 struct cfg80211_inform_bss data = {
5766 .scan_width = scan_width,
5770 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5771 capability, beacon_interval, ie, ielen,
5775 static inline struct cfg80211_bss * __must_check
5776 cfg80211_inform_bss(struct wiphy *wiphy,
5777 struct ieee80211_channel *rx_channel,
5778 enum cfg80211_bss_frame_type ftype,
5779 const u8 *bssid, u64 tsf, u16 capability,
5780 u16 beacon_interval, const u8 *ie, size_t ielen,
5781 s32 signal, gfp_t gfp)
5783 struct cfg80211_inform_bss data = {
5785 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5789 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5790 capability, beacon_interval, ie, ielen,
5795 * cfg80211_get_bss - get a BSS reference
5796 * @wiphy: the wiphy this BSS struct belongs to
5797 * @channel: the channel to search on (or %NULL)
5798 * @bssid: the desired BSSID (or %NULL)
5799 * @ssid: the desired SSID (or %NULL)
5800 * @ssid_len: length of the SSID (or 0)
5801 * @bss_type: type of BSS, see &enum ieee80211_bss_type
5802 * @privacy: privacy filter, see &enum ieee80211_privacy
5804 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
5805 struct ieee80211_channel *channel,
5807 const u8 *ssid, size_t ssid_len,
5808 enum ieee80211_bss_type bss_type,
5809 enum ieee80211_privacy privacy);
5810 static inline struct cfg80211_bss *
5811 cfg80211_get_ibss(struct wiphy *wiphy,
5812 struct ieee80211_channel *channel,
5813 const u8 *ssid, size_t ssid_len)
5815 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
5816 IEEE80211_BSS_TYPE_IBSS,
5817 IEEE80211_PRIVACY_ANY);
5821 * cfg80211_ref_bss - reference BSS struct
5822 * @wiphy: the wiphy this BSS struct belongs to
5823 * @bss: the BSS struct to reference
5825 * Increments the refcount of the given BSS struct.
5827 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5830 * cfg80211_put_bss - unref BSS struct
5831 * @wiphy: the wiphy this BSS struct belongs to
5832 * @bss: the BSS struct
5834 * Decrements the refcount of the given BSS struct.
5836 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5839 * cfg80211_unlink_bss - unlink BSS from internal data structures
5841 * @bss: the bss to remove
5843 * This function removes the given BSS from the internal data structures
5844 * thereby making it no longer show up in scan results etc. Use this
5845 * function when you detect a BSS is gone. Normally BSSes will also time
5846 * out, so it is not necessary to use this function at all.
5848 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5851 * cfg80211_bss_iter - iterate all BSS entries
5853 * This function iterates over the BSS entries associated with the given wiphy
5854 * and calls the callback for the iterated BSS. The iterator function is not
5855 * allowed to call functions that might modify the internal state of the BSS DB.
5858 * @chandef: if given, the iterator function will be called only if the channel
5859 * of the currently iterated BSS is a subset of the given channel.
5860 * @iter: the iterator function to call
5861 * @iter_data: an argument to the iterator function
5863 void cfg80211_bss_iter(struct wiphy *wiphy,
5864 struct cfg80211_chan_def *chandef,
5865 void (*iter)(struct wiphy *wiphy,
5866 struct cfg80211_bss *bss,
5870 static inline enum nl80211_bss_scan_width
5871 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5873 switch (chandef->width) {
5874 case NL80211_CHAN_WIDTH_5:
5875 return NL80211_BSS_CHAN_WIDTH_5;
5876 case NL80211_CHAN_WIDTH_10:
5877 return NL80211_BSS_CHAN_WIDTH_10;
5879 return NL80211_BSS_CHAN_WIDTH_20;
5884 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5885 * @dev: network device
5886 * @buf: authentication frame (header + body)
5887 * @len: length of the frame data
5889 * This function is called whenever an authentication, disassociation or
5890 * deauthentication frame has been received and processed in station mode.
5891 * After being asked to authenticate via cfg80211_ops::auth() the driver must
5892 * call either this function or cfg80211_auth_timeout().
5893 * After being asked to associate via cfg80211_ops::assoc() the driver must
5894 * call either this function or cfg80211_auth_timeout().
5895 * While connected, the driver must calls this for received and processed
5896 * disassociation and deauthentication frames. If the frame couldn't be used
5897 * because it was unprotected, the driver must call the function
5898 * cfg80211_rx_unprot_mlme_mgmt() instead.
5900 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5902 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5905 * cfg80211_auth_timeout - notification of timed out authentication
5906 * @dev: network device
5907 * @addr: The MAC address of the device with which the authentication timed out
5909 * This function may sleep. The caller must hold the corresponding wdev's
5912 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
5915 * cfg80211_rx_assoc_resp - notification of processed association response
5916 * @dev: network device
5917 * @bss: the BSS that association was requested with, ownership of the pointer
5918 * moves to cfg80211 in this call
5919 * @buf: (Re)Association Response frame (header + body)
5920 * @len: length of the frame data
5921 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5922 * as the AC bitmap in the QoS info field
5923 * @req_ies: information elements from the (Re)Association Request frame
5924 * @req_ies_len: length of req_ies data
5926 * After being asked to associate via cfg80211_ops::assoc() the driver must
5927 * call either this function or cfg80211_auth_timeout().
5929 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5931 void cfg80211_rx_assoc_resp(struct net_device *dev,
5932 struct cfg80211_bss *bss,
5933 const u8 *buf, size_t len,
5935 const u8 *req_ies, size_t req_ies_len);
5938 * cfg80211_assoc_timeout - notification of timed out association
5939 * @dev: network device
5940 * @bss: The BSS entry with which association timed out.
5942 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5944 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
5947 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5948 * @dev: network device
5949 * @bss: The BSS entry with which association was abandoned.
5951 * Call this whenever - for reasons reported through other API, like deauth RX,
5952 * an association attempt was abandoned.
5953 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5955 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
5958 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
5959 * @dev: network device
5960 * @buf: 802.11 frame (header + body)
5961 * @len: length of the frame data
5963 * This function is called whenever deauthentication has been processed in
5964 * station mode. This includes both received deauthentication frames and
5965 * locally generated ones. This function may sleep. The caller must hold the
5966 * corresponding wdev's mutex.
5968 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5971 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
5972 * @dev: network device
5973 * @buf: deauthentication frame (header + body)
5974 * @len: length of the frame data
5976 * This function is called whenever a received deauthentication or dissassoc
5977 * frame has been dropped in station mode because of MFP being used but the
5978 * frame was not protected. This function may sleep.
5980 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5981 const u8 *buf, size_t len);
5984 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
5985 * @dev: network device
5986 * @addr: The source MAC address of the frame
5987 * @key_type: The key type that the received frame used
5988 * @key_id: Key identifier (0..3). Can be -1 if missing.
5989 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
5990 * @gfp: allocation flags
5992 * This function is called whenever the local MAC detects a MIC failure in a
5993 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
5996 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
5997 enum nl80211_key_type key_type, int key_id,
5998 const u8 *tsc, gfp_t gfp);
6001 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6003 * @dev: network device
6004 * @bssid: the BSSID of the IBSS joined
6005 * @channel: the channel of the IBSS joined
6006 * @gfp: allocation flags
6008 * This function notifies cfg80211 that the device joined an IBSS or
6009 * switched to a different BSSID. Before this function can be called,
6010 * either a beacon has to have been received from the IBSS, or one of
6011 * the cfg80211_inform_bss{,_frame} functions must have been called
6012 * with the locally generated beacon -- this guarantees that there is
6013 * always a scan result for this IBSS. cfg80211 will handle the rest.
6015 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6016 struct ieee80211_channel *channel, gfp_t gfp);
6019 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
6021 * @dev: network device
6022 * @macaddr: the MAC address of the new candidate
6023 * @ie: information elements advertised by the peer candidate
6024 * @ie_len: length of the information elements buffer
6025 * @gfp: allocation flags
6027 * This function notifies cfg80211 that the mesh peer candidate has been
6028 * detected, most likely via a beacon or, less likely, via a probe response.
6029 * cfg80211 then sends a notification to userspace.
6031 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6032 const u8 *macaddr, const u8 *ie, u8 ie_len,
6033 int sig_dbm, gfp_t gfp);
6036 * DOC: RFkill integration
6038 * RFkill integration in cfg80211 is almost invisible to drivers,
6039 * as cfg80211 automatically registers an rfkill instance for each
6040 * wireless device it knows about. Soft kill is also translated
6041 * into disconnecting and turning all interfaces off, drivers are
6042 * expected to turn off the device when all interfaces are down.
6044 * However, devices may have a hard RFkill line, in which case they
6045 * also need to interact with the rfkill subsystem, via cfg80211.
6046 * They can do this with a few helper functions documented here.
6050 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6052 * @blocked: block status
6054 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
6057 * wiphy_rfkill_start_polling - start polling rfkill
6060 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6063 * wiphy_rfkill_stop_polling - stop polling rfkill
6066 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
6069 * DOC: Vendor commands
6071 * Occasionally, there are special protocol or firmware features that
6072 * can't be implemented very openly. For this and similar cases, the
6073 * vendor command functionality allows implementing the features with
6074 * (typically closed-source) userspace and firmware, using nl80211 as
6075 * the configuration mechanism.
6077 * A driver supporting vendor commands must register them as an array
6078 * in struct wiphy, with handlers for each one, each command has an
6079 * OUI and sub command ID to identify it.
6081 * Note that this feature should not be (ab)used to implement protocol
6082 * features that could openly be shared across drivers. In particular,
6083 * it must never be required to use vendor commands to implement any
6084 * "normal" functionality that higher-level userspace like connection
6085 * managers etc. need.
6088 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6089 enum nl80211_commands cmd,
6090 enum nl80211_attrs attr,
6093 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6094 struct wireless_dev *wdev,
6095 enum nl80211_commands cmd,
6096 enum nl80211_attrs attr,
6097 unsigned int portid,
6098 int vendor_event_idx,
6099 int approxlen, gfp_t gfp);
6101 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6104 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6106 * @approxlen: an upper bound of the length of the data that will
6107 * be put into the skb
6109 * This function allocates and pre-fills an skb for a reply to
6110 * a vendor command. Since it is intended for a reply, calling
6111 * it outside of a vendor command's doit() operation is invalid.
6113 * The returned skb is pre-filled with some identifying data in
6114 * a way that any data that is put into the skb (with skb_put(),
6115 * nla_put() or similar) will end up being within the
6116 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6117 * with the skb is adding data for the corresponding userspace tool
6118 * which can then read that data out of the vendor data attribute.
6119 * You must not modify the skb in any other way.
6121 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6122 * its error code as the result of the doit() operation.
6124 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6126 static inline struct sk_buff *
6127 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6129 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6130 NL80211_ATTR_VENDOR_DATA, approxlen);
6134 * cfg80211_vendor_cmd_reply - send the reply skb
6135 * @skb: The skb, must have been allocated with
6136 * cfg80211_vendor_cmd_alloc_reply_skb()
6138 * Since calling this function will usually be the last thing
6139 * before returning from the vendor command doit() you should
6140 * return the error code. Note that this function consumes the
6141 * skb regardless of the return value.
6143 * Return: An error code or 0 on success.
6145 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6148 * cfg80211_vendor_cmd_get_sender
6151 * Return the current netlink port ID in a vendor command handler.
6152 * Valid to call only there.
6154 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6157 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6159 * @wdev: the wireless device
6160 * @event_idx: index of the vendor event in the wiphy's vendor_events
6161 * @approxlen: an upper bound of the length of the data that will
6162 * be put into the skb
6163 * @gfp: allocation flags
6165 * This function allocates and pre-fills an skb for an event on the
6166 * vendor-specific multicast group.
6168 * If wdev != NULL, both the ifindex and identifier of the specified
6169 * wireless device are added to the event message before the vendor data
6172 * When done filling the skb, call cfg80211_vendor_event() with the
6173 * skb to send the event.
6175 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6177 static inline struct sk_buff *
6178 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6179 int approxlen, int event_idx, gfp_t gfp)
6181 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6182 NL80211_ATTR_VENDOR_DATA,
6183 0, event_idx, approxlen, gfp);
6187 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6189 * @wdev: the wireless device
6190 * @event_idx: index of the vendor event in the wiphy's vendor_events
6191 * @portid: port ID of the receiver
6192 * @approxlen: an upper bound of the length of the data that will
6193 * be put into the skb
6194 * @gfp: allocation flags
6196 * This function allocates and pre-fills an skb for an event to send to
6197 * a specific (userland) socket. This socket would previously have been
6198 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6199 * care to register a netlink notifier to see when the socket closes.
6201 * If wdev != NULL, both the ifindex and identifier of the specified
6202 * wireless device are added to the event message before the vendor data
6205 * When done filling the skb, call cfg80211_vendor_event() with the
6206 * skb to send the event.
6208 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6210 static inline struct sk_buff *
6211 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6212 struct wireless_dev *wdev,
6213 unsigned int portid, int approxlen,
6214 int event_idx, gfp_t gfp)
6216 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6217 NL80211_ATTR_VENDOR_DATA,
6218 portid, event_idx, approxlen, gfp);
6222 * cfg80211_vendor_event - send the event
6223 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6224 * @gfp: allocation flags
6226 * This function sends the given @skb, which must have been allocated
6227 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6229 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6231 __cfg80211_send_event_skb(skb, gfp);
6234 #ifdef CONFIG_NL80211_TESTMODE
6238 * Test mode is a set of utility functions to allow drivers to
6239 * interact with driver-specific tools to aid, for instance,
6240 * factory programming.
6242 * This chapter describes how drivers interact with it, for more
6243 * information see the nl80211 book's chapter on it.
6247 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6249 * @approxlen: an upper bound of the length of the data that will
6250 * be put into the skb
6252 * This function allocates and pre-fills an skb for a reply to
6253 * the testmode command. Since it is intended for a reply, calling
6254 * it outside of the @testmode_cmd operation is invalid.
6256 * The returned skb is pre-filled with the wiphy index and set up in
6257 * a way that any data that is put into the skb (with skb_put(),
6258 * nla_put() or similar) will end up being within the
6259 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6260 * with the skb is adding data for the corresponding userspace tool
6261 * which can then read that data out of the testdata attribute. You
6262 * must not modify the skb in any other way.
6264 * When done, call cfg80211_testmode_reply() with the skb and return
6265 * its error code as the result of the @testmode_cmd operation.
6267 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6269 static inline struct sk_buff *
6270 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6272 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6273 NL80211_ATTR_TESTDATA, approxlen);
6277 * cfg80211_testmode_reply - send the reply skb
6278 * @skb: The skb, must have been allocated with
6279 * cfg80211_testmode_alloc_reply_skb()
6281 * Since calling this function will usually be the last thing
6282 * before returning from the @testmode_cmd you should return
6283 * the error code. Note that this function consumes the skb
6284 * regardless of the return value.
6286 * Return: An error code or 0 on success.
6288 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6290 return cfg80211_vendor_cmd_reply(skb);
6294 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6296 * @approxlen: an upper bound of the length of the data that will
6297 * be put into the skb
6298 * @gfp: allocation flags
6300 * This function allocates and pre-fills an skb for an event on the
6301 * testmode multicast group.
6303 * The returned skb is set up in the same way as with
6304 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6305 * there, you should simply add data to it that will then end up in the
6306 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6309 * When done filling the skb, call cfg80211_testmode_event() with the
6310 * skb to send the event.
6312 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6314 static inline struct sk_buff *
6315 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6317 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6318 NL80211_ATTR_TESTDATA, 0, -1,
6323 * cfg80211_testmode_event - send the event
6324 * @skb: The skb, must have been allocated with
6325 * cfg80211_testmode_alloc_event_skb()
6326 * @gfp: allocation flags
6328 * This function sends the given @skb, which must have been allocated
6329 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6332 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6334 __cfg80211_send_event_skb(skb, gfp);
6337 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6338 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6340 #define CFG80211_TESTMODE_CMD(cmd)
6341 #define CFG80211_TESTMODE_DUMP(cmd)
6345 * struct cfg80211_fils_resp_params - FILS connection response params
6346 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6347 * @kek_len: Length of @fils_kek in octets
6348 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6349 * @erp_next_seq_num is valid.
6350 * @erp_next_seq_num: The next sequence number to use in ERP message in
6351 * FILS Authentication. This value should be specified irrespective of the
6352 * status for a FILS connection.
6353 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6354 * @pmk_len: Length of @pmk in octets
6355 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6356 * used for this FILS connection (may be %NULL).
6358 struct cfg80211_fils_resp_params {
6361 bool update_erp_next_seq_num;
6362 u16 erp_next_seq_num;
6369 * struct cfg80211_connect_resp_params - Connection response params
6370 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6371 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6372 * the real status code for failures. If this call is used to report a
6373 * failure due to a timeout (e.g., not receiving an Authentication frame
6374 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6375 * indicate that this is a failure, but without a status code.
6376 * @timeout_reason is used to report the reason for the timeout in that
6378 * @bssid: The BSSID of the AP (may be %NULL)
6379 * @bss: Entry of bss to which STA got connected to, can be obtained through
6380 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6381 * bss from the connect_request and hold a reference to it and return
6382 * through this param to avoid a warning if the bss is expired during the
6383 * connection, esp. for those drivers implementing connect op.
6384 * Only one parameter among @bssid and @bss needs to be specified.
6385 * @req_ie: Association request IEs (may be %NULL)
6386 * @req_ie_len: Association request IEs length
6387 * @resp_ie: Association response IEs (may be %NULL)
6388 * @resp_ie_len: Association response IEs length
6389 * @fils: FILS connection response parameters.
6390 * @timeout_reason: Reason for connection timeout. This is used when the
6391 * connection fails due to a timeout instead of an explicit rejection from
6392 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6393 * not known. This value is used only if @status < 0 to indicate that the
6394 * failure is due to a timeout and not due to explicit rejection by the AP.
6395 * This value is ignored in other cases (@status >= 0).
6397 struct cfg80211_connect_resp_params {
6400 struct cfg80211_bss *bss;
6405 struct cfg80211_fils_resp_params fils;
6406 enum nl80211_timeout_reason timeout_reason;
6410 * cfg80211_connect_done - notify cfg80211 of connection result
6412 * @dev: network device
6413 * @params: connection response parameters
6414 * @gfp: allocation flags
6416 * It should be called by the underlying driver once execution of the connection
6417 * request from connect() has been completed. This is similar to
6418 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6419 * parameters. Only one of the functions among cfg80211_connect_bss(),
6420 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6421 * and cfg80211_connect_done() should be called.
6423 void cfg80211_connect_done(struct net_device *dev,
6424 struct cfg80211_connect_resp_params *params,
6428 * cfg80211_connect_bss - notify cfg80211 of connection result
6430 * @dev: network device
6431 * @bssid: the BSSID of the AP
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 (maybe be %NULL)
6439 * @req_ie_len: association request IEs length
6440 * @resp_ie: association response IEs (may be %NULL)
6441 * @resp_ie_len: assoc response IEs length
6442 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6443 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6444 * the real status code for failures. If this call is used to report a
6445 * failure due to a timeout (e.g., not receiving an Authentication frame
6446 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6447 * indicate that this is a failure, but without a status code.
6448 * @timeout_reason is used to report the reason for the timeout in that
6450 * @gfp: allocation flags
6451 * @timeout_reason: reason for connection timeout. This is used when the
6452 * connection fails due to a timeout instead of an explicit rejection from
6453 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6454 * not known. This value is used only if @status < 0 to indicate that the
6455 * failure is due to a timeout and not due to explicit rejection by the AP.
6456 * This value is ignored in other cases (@status >= 0).
6458 * It should be called by the underlying driver once execution of the connection
6459 * request from connect() has been completed. This is similar to
6460 * cfg80211_connect_result(), but with the option of identifying the exact bss
6461 * entry for the connection. Only one of the functions among
6462 * cfg80211_connect_bss(), cfg80211_connect_result(),
6463 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6466 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6467 struct cfg80211_bss *bss, const u8 *req_ie,
6468 size_t req_ie_len, const u8 *resp_ie,
6469 size_t resp_ie_len, int status, gfp_t gfp,
6470 enum nl80211_timeout_reason timeout_reason)
6472 struct cfg80211_connect_resp_params params;
6474 memset(¶ms, 0, sizeof(params));
6475 params.status = status;
6476 params.bssid = bssid;
6478 params.req_ie = req_ie;
6479 params.req_ie_len = req_ie_len;
6480 params.resp_ie = resp_ie;
6481 params.resp_ie_len = resp_ie_len;
6482 params.timeout_reason = timeout_reason;
6484 cfg80211_connect_done(dev, ¶ms, gfp);
6488 * cfg80211_connect_result - notify cfg80211 of connection result
6490 * @dev: network device
6491 * @bssid: the BSSID of the AP
6492 * @req_ie: association request IEs (maybe be %NULL)
6493 * @req_ie_len: association request IEs length
6494 * @resp_ie: association response IEs (may be %NULL)
6495 * @resp_ie_len: assoc response IEs length
6496 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6497 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6498 * the real status code for failures.
6499 * @gfp: allocation flags
6501 * It should be called by the underlying driver once execution of the connection
6502 * request from connect() has been completed. This is similar to
6503 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6504 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6505 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6508 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6509 const u8 *req_ie, size_t req_ie_len,
6510 const u8 *resp_ie, size_t resp_ie_len,
6511 u16 status, gfp_t gfp)
6513 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6514 resp_ie_len, status, gfp,
6515 NL80211_TIMEOUT_UNSPECIFIED);
6519 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6521 * @dev: network device
6522 * @bssid: the BSSID of the AP
6523 * @req_ie: association request IEs (maybe be %NULL)
6524 * @req_ie_len: association request IEs length
6525 * @gfp: allocation flags
6526 * @timeout_reason: reason for connection timeout.
6528 * It should be called by the underlying driver whenever connect() has failed
6529 * in a sequence where no explicit authentication/association rejection was
6530 * received from the AP. This could happen, e.g., due to not being able to send
6531 * out the Authentication or Association Request frame or timing out while
6532 * waiting for the response. Only one of the functions among
6533 * cfg80211_connect_bss(), cfg80211_connect_result(),
6534 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6537 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6538 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6539 enum nl80211_timeout_reason timeout_reason)
6541 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6542 gfp, timeout_reason);
6546 * struct cfg80211_roam_info - driver initiated roaming information
6548 * @channel: the channel of the new AP
6549 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6550 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6551 * @req_ie: association request IEs (maybe be %NULL)
6552 * @req_ie_len: association request IEs length
6553 * @resp_ie: association response IEs (may be %NULL)
6554 * @resp_ie_len: assoc response IEs length
6555 * @fils: FILS related roaming information.
6557 struct cfg80211_roam_info {
6558 struct ieee80211_channel *channel;
6559 struct cfg80211_bss *bss;
6565 struct cfg80211_fils_resp_params fils;
6569 * cfg80211_roamed - notify cfg80211 of roaming
6571 * @dev: network device
6572 * @info: information about the new BSS. struct &cfg80211_roam_info.
6573 * @gfp: allocation flags
6575 * This function may be called with the driver passing either the BSSID of the
6576 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6577 * It should be called by the underlying driver whenever it roamed from one AP
6578 * to another while connected. Drivers which have roaming implemented in
6579 * firmware should pass the bss entry to avoid a race in bss entry timeout where
6580 * the bss entry of the new AP is seen in the driver, but gets timed out by the
6581 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6582 * rdev->event_work. In case of any failures, the reference is released
6583 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6584 * released while diconneting from the current bss.
6586 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
6590 * cfg80211_port_authorized - notify cfg80211 of successful security association
6592 * @dev: network device
6593 * @bssid: the BSSID of the AP
6594 * @gfp: allocation flags
6596 * This function should be called by a driver that supports 4 way handshake
6597 * offload after a security association was successfully established (i.e.,
6598 * the 4 way handshake was completed successfully). The call to this function
6599 * should be preceded with a call to cfg80211_connect_result(),
6600 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6601 * indicate the 802.11 association.
6603 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
6607 * cfg80211_disconnected - notify cfg80211 that connection was dropped
6609 * @dev: network device
6610 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6611 * @ie_len: length of IEs
6612 * @reason: reason code for the disconnection, set it to 0 if unknown
6613 * @locally_generated: disconnection was requested locally
6614 * @gfp: allocation flags
6616 * After it calls this function, the driver should enter an idle state
6617 * and not try to connect to any AP any more.
6619 void cfg80211_disconnected(struct net_device *dev, u16 reason,
6620 const u8 *ie, size_t ie_len,
6621 bool locally_generated, gfp_t gfp);
6624 * cfg80211_ready_on_channel - notification of remain_on_channel start
6625 * @wdev: wireless device
6626 * @cookie: the request cookie
6627 * @chan: The current channel (from remain_on_channel request)
6628 * @duration: Duration in milliseconds that the driver intents to remain on the
6630 * @gfp: allocation flags
6632 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
6633 struct ieee80211_channel *chan,
6634 unsigned int duration, gfp_t gfp);
6637 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6638 * @wdev: wireless device
6639 * @cookie: the request cookie
6640 * @chan: The current channel (from remain_on_channel request)
6641 * @gfp: allocation flags
6643 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
6644 struct ieee80211_channel *chan,
6648 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
6649 * @wdev: wireless device
6650 * @cookie: the requested cookie
6651 * @chan: The current channel (from tx_mgmt request)
6652 * @gfp: allocation flags
6654 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
6655 struct ieee80211_channel *chan, gfp_t gfp);
6658 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6660 * @sinfo: the station information
6661 * @gfp: allocation flags
6663 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
6666 * cfg80211_sinfo_release_content - release contents of station info
6667 * @sinfo: the station information
6669 * Releases any potentially allocated sub-information of the station
6670 * information, but not the struct itself (since it's typically on
6673 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
6675 kfree(sinfo->pertid);
6679 * cfg80211_new_sta - notify userspace about station
6682 * @mac_addr: the station's address
6683 * @sinfo: the station information
6684 * @gfp: allocation flags
6686 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
6687 struct station_info *sinfo, gfp_t gfp);
6690 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6692 * @mac_addr: the station's address
6693 * @sinfo: the station information/statistics
6694 * @gfp: allocation flags
6696 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
6697 struct station_info *sinfo, gfp_t gfp);
6700 * cfg80211_del_sta - notify userspace about deletion of a station
6703 * @mac_addr: the station's address
6704 * @gfp: allocation flags
6706 static inline void cfg80211_del_sta(struct net_device *dev,
6707 const u8 *mac_addr, gfp_t gfp)
6709 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
6713 * cfg80211_conn_failed - connection request failed notification
6716 * @mac_addr: the station's address
6717 * @reason: the reason for connection failure
6718 * @gfp: allocation flags
6720 * Whenever a station tries to connect to an AP and if the station
6721 * could not connect to the AP as the AP has rejected the connection
6722 * for some reasons, this function is called.
6724 * The reason for connection failure can be any of the value from
6725 * nl80211_connect_failed_reason enum
6727 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
6728 enum nl80211_connect_failed_reason reason,
6732 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
6733 * @wdev: wireless device receiving the frame
6734 * @freq: Frequency on which the frame was received in MHz
6735 * @sig_dbm: signal strength in dBm, or 0 if unknown
6736 * @buf: Management frame (header + body)
6737 * @len: length of the frame data
6738 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
6740 * This function is called whenever an Action frame is received for a station
6741 * mode interface, but is not processed in kernel.
6743 * Return: %true if a user space application has registered for this frame.
6744 * For action frames, that makes it responsible for rejecting unrecognized
6745 * action frames; %false otherwise, in which case for action frames the
6746 * driver is responsible for rejecting the frame.
6748 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
6749 const u8 *buf, size_t len, u32 flags);
6752 * cfg80211_mgmt_tx_status - notification of TX status for management frame
6753 * @wdev: wireless device receiving the frame
6754 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
6755 * @buf: Management frame (header + body)
6756 * @len: length of the frame data
6757 * @ack: Whether frame was acknowledged
6758 * @gfp: context flags
6760 * This function is called whenever a management frame was requested to be
6761 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
6762 * transmission attempt.
6764 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
6765 const u8 *buf, size_t len, bool ack, gfp_t gfp);
6769 * cfg80211_rx_control_port - notification about a received control port frame
6770 * @dev: The device the frame matched to
6771 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
6772 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
6773 * This function does not take ownership of the skb, so the caller is
6774 * responsible for any cleanup. The caller must also ensure that
6775 * skb->protocol is set appropriately.
6776 * @unencrypted: Whether the frame was received unencrypted
6778 * This function is used to inform userspace about a received control port
6779 * frame. It should only be used if userspace indicated it wants to receive
6780 * control port frames over nl80211.
6782 * The frame is the data portion of the 802.3 or 802.11 data frame with all
6783 * network layer headers removed (e.g. the raw EAPoL frame).
6785 * Return: %true if the frame was passed to userspace
6787 bool cfg80211_rx_control_port(struct net_device *dev,
6788 struct sk_buff *skb, bool unencrypted);
6791 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
6792 * @dev: network device
6793 * @rssi_event: the triggered RSSI event
6794 * @rssi_level: new RSSI level value or 0 if not available
6795 * @gfp: context flags
6797 * This function is called when a configured connection quality monitoring
6798 * rssi threshold reached event occurs.
6800 void cfg80211_cqm_rssi_notify(struct net_device *dev,
6801 enum nl80211_cqm_rssi_threshold_event rssi_event,
6802 s32 rssi_level, gfp_t gfp);
6805 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
6806 * @dev: network device
6807 * @peer: peer's MAC address
6808 * @num_packets: how many packets were lost -- should be a fixed threshold
6809 * but probably no less than maybe 50, or maybe a throughput dependent
6810 * threshold (to account for temporary interference)
6811 * @gfp: context flags
6813 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
6814 const u8 *peer, u32 num_packets, gfp_t gfp);
6817 * cfg80211_cqm_txe_notify - TX error rate event
6818 * @dev: network device
6819 * @peer: peer's MAC address
6820 * @num_packets: how many packets were lost
6821 * @rate: % of packets which failed transmission
6822 * @intvl: interval (in s) over which the TX failure threshold was breached.
6823 * @gfp: context flags
6825 * Notify userspace when configured % TX failures over number of packets in a
6826 * given interval is exceeded.
6828 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
6829 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
6832 * cfg80211_cqm_beacon_loss_notify - beacon loss event
6833 * @dev: network device
6834 * @gfp: context flags
6836 * Notify userspace about beacon loss from the connected AP.
6838 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
6841 * cfg80211_radar_event - radar detection event
6843 * @chandef: chandef for the current channel
6844 * @gfp: context flags
6846 * This function is called when a radar is detected on the current chanenl.
6848 void cfg80211_radar_event(struct wiphy *wiphy,
6849 struct cfg80211_chan_def *chandef, gfp_t gfp);
6852 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6853 * @dev: network device
6854 * @mac: MAC address of a station which opmode got modified
6855 * @sta_opmode: station's current opmode value
6856 * @gfp: context flags
6858 * Driver should call this function when station's opmode modified via action
6861 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
6862 struct sta_opmode_info *sta_opmode,
6866 * cfg80211_cac_event - Channel availability check (CAC) event
6867 * @netdev: network device
6868 * @chandef: chandef for the current channel
6869 * @event: type of event
6870 * @gfp: context flags
6872 * This function is called when a Channel availability check (CAC) is finished
6873 * or aborted. This must be called to notify the completion of a CAC process,
6874 * also by full-MAC drivers.
6876 void cfg80211_cac_event(struct net_device *netdev,
6877 const struct cfg80211_chan_def *chandef,
6878 enum nl80211_radar_event event, gfp_t gfp);
6882 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6883 * @dev: network device
6884 * @bssid: BSSID of AP (to avoid races)
6885 * @replay_ctr: new replay counter
6886 * @gfp: allocation flags
6888 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
6889 const u8 *replay_ctr, gfp_t gfp);
6892 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
6893 * @dev: network device
6894 * @index: candidate index (the smaller the index, the higher the priority)
6895 * @bssid: BSSID of AP
6896 * @preauth: Whether AP advertises support for RSN pre-authentication
6897 * @gfp: allocation flags
6899 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
6900 const u8 *bssid, bool preauth, gfp_t gfp);
6903 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
6904 * @dev: The device the frame matched to
6905 * @addr: the transmitter address
6906 * @gfp: context flags
6908 * This function is used in AP mode (only!) to inform userspace that
6909 * a spurious class 3 frame was received, to be able to deauth the
6911 * Return: %true if the frame was passed to userspace (or this failed
6912 * for a reason other than not having a subscription.)
6914 bool cfg80211_rx_spurious_frame(struct net_device *dev,
6915 const u8 *addr, gfp_t gfp);
6918 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
6919 * @dev: The device the frame matched to
6920 * @addr: the transmitter address
6921 * @gfp: context flags
6923 * This function is used in AP mode (only!) to inform userspace that
6924 * an associated station sent a 4addr frame but that wasn't expected.
6925 * It is allowed and desirable to send this event only once for each
6926 * station to avoid event flooding.
6927 * Return: %true if the frame was passed to userspace (or this failed
6928 * for a reason other than not having a subscription.)
6930 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
6931 const u8 *addr, gfp_t gfp);
6934 * cfg80211_probe_status - notify userspace about probe status
6935 * @dev: the device the probe was sent on
6936 * @addr: the address of the peer
6937 * @cookie: the cookie filled in @probe_client previously
6938 * @acked: indicates whether probe was acked or not
6939 * @ack_signal: signal strength (in dBm) of the ACK frame.
6940 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6941 * @gfp: allocation flags
6943 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
6944 u64 cookie, bool acked, s32 ack_signal,
6945 bool is_valid_ack_signal, gfp_t gfp);
6948 * cfg80211_report_obss_beacon - report beacon from other APs
6949 * @wiphy: The wiphy that received the beacon
6951 * @len: length of the frame
6952 * @freq: frequency the frame was received on
6953 * @sig_dbm: signal strength in dBm, or 0 if unknown
6955 * Use this function to report to userspace when a beacon was
6956 * received. It is not useful to call this when there is no
6957 * netdev that is in AP/GO mode.
6959 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
6960 const u8 *frame, size_t len,
6961 int freq, int sig_dbm);
6964 * cfg80211_reg_can_beacon - check if beaconing is allowed
6966 * @chandef: the channel definition
6967 * @iftype: interface type
6969 * Return: %true if there is no secondary channel or the secondary channel(s)
6970 * can be used for beaconing (i.e. is not a radar channel etc.)
6972 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
6973 struct cfg80211_chan_def *chandef,
6974 enum nl80211_iftype iftype);
6977 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
6979 * @chandef: the channel definition
6980 * @iftype: interface type
6982 * Return: %true if there is no secondary channel or the secondary channel(s)
6983 * can be used for beaconing (i.e. is not a radar channel etc.). This version
6984 * also checks if IR-relaxation conditions apply, to allow beaconing under
6985 * more permissive conditions.
6987 * Requires the RTNL to be held.
6989 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
6990 struct cfg80211_chan_def *chandef,
6991 enum nl80211_iftype iftype);
6994 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
6995 * @dev: the device which switched channels
6996 * @chandef: the new channel definition
6998 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7001 void cfg80211_ch_switch_notify(struct net_device *dev,
7002 struct cfg80211_chan_def *chandef);
7005 * cfg80211_ch_switch_started_notify - notify channel switch start
7006 * @dev: the device on which the channel switch started
7007 * @chandef: the future channel definition
7008 * @count: the number of TBTTs until the channel switch happens
7010 * Inform the userspace about the channel switch that has just
7011 * started, so that it can take appropriate actions (eg. starting
7012 * channel switch on other vifs), if necessary.
7014 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7015 struct cfg80211_chan_def *chandef,
7019 * ieee80211_operating_class_to_band - convert operating class to band
7021 * @operating_class: the operating class to convert
7022 * @band: band pointer to fill
7024 * Returns %true if the conversion was successful, %false otherwise.
7026 bool ieee80211_operating_class_to_band(u8 operating_class,
7027 enum nl80211_band *band);
7030 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7032 * @chandef: the chandef to convert
7033 * @op_class: a pointer to the resulting operating class
7035 * Returns %true if the conversion was successful, %false otherwise.
7037 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7041 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7042 * @dev: the device on which the operation is requested
7043 * @peer: the MAC address of the peer device
7044 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7045 * NL80211_TDLS_TEARDOWN)
7046 * @reason_code: the reason code for teardown request
7047 * @gfp: allocation flags
7049 * This function is used to request userspace to perform TDLS operation that
7050 * requires knowledge of keys, i.e., link setup or teardown when the AP
7051 * connection uses encryption. This is optional mechanism for the driver to use
7052 * if it can automatically determine when a TDLS link could be useful (e.g.,
7053 * based on traffic and signal strength for a peer).
7055 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7056 enum nl80211_tdls_operation oper,
7057 u16 reason_code, gfp_t gfp);
7060 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7061 * @rate: given rate_info to calculate bitrate from
7063 * return 0 if MCS index >= 32
7065 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7068 * cfg80211_unregister_wdev - remove the given wdev
7069 * @wdev: struct wireless_dev to remove
7071 * Call this function only for wdevs that have no netdev assigned,
7072 * e.g. P2P Devices. It removes the device from the list so that
7073 * it can no longer be used. It is necessary to call this function
7074 * even when cfg80211 requests the removal of the interface by
7075 * calling the del_virtual_intf() callback. The function must also
7076 * be called when the driver wishes to unregister the wdev, e.g.
7077 * when the device is unbound from the driver.
7079 * Requires the RTNL to be held.
7081 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7084 * struct cfg80211_ft_event - FT Information Elements
7086 * @ies_len: length of the FT IE in bytes
7087 * @target_ap: target AP's MAC address
7089 * @ric_ies_len: length of the RIC IE in bytes
7091 struct cfg80211_ft_event_params {
7094 const u8 *target_ap;
7100 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7101 * @netdev: network device
7102 * @ft_event: IE information
7104 void cfg80211_ft_event(struct net_device *netdev,
7105 struct cfg80211_ft_event_params *ft_event);
7108 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7109 * @ies: the input IE buffer
7110 * @len: the input length
7111 * @attr: the attribute ID to find
7112 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7113 * if the function is only called to get the needed buffer size
7114 * @bufsize: size of the output buffer
7116 * The function finds a given P2P attribute in the (vendor) IEs and
7117 * copies its contents to the given buffer.
7119 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7120 * malformed or the attribute can't be found (respectively), or the
7121 * length of the found attribute (which can be zero).
7123 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7124 enum ieee80211_p2p_attr_id attr,
7125 u8 *buf, unsigned int bufsize);
7128 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7129 * @ies: the IE buffer
7130 * @ielen: the length of the IE buffer
7131 * @ids: an array with element IDs that are allowed before
7132 * the split. A WLAN_EID_EXTENSION value means that the next
7133 * EID in the list is a sub-element of the EXTENSION IE.
7134 * @n_ids: the size of the element ID array
7135 * @after_ric: array IE types that come after the RIC element
7136 * @n_after_ric: size of the @after_ric array
7137 * @offset: offset where to start splitting in the buffer
7139 * This function splits an IE buffer by updating the @offset
7140 * variable to point to the location where the buffer should be
7143 * It assumes that the given IE buffer is well-formed, this
7144 * has to be guaranteed by the caller!
7146 * It also assumes that the IEs in the buffer are ordered
7147 * correctly, if not the result of using this function will not
7148 * be ordered correctly either, i.e. it does no reordering.
7150 * The function returns the offset where the next part of the
7151 * buffer starts, which may be @ielen if the entire (remainder)
7152 * of the buffer should be used.
7154 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7155 const u8 *ids, int n_ids,
7156 const u8 *after_ric, int n_after_ric,
7160 * ieee80211_ie_split - split an IE buffer according to ordering
7161 * @ies: the IE buffer
7162 * @ielen: the length of the IE buffer
7163 * @ids: an array with element IDs that are allowed before
7164 * the split. A WLAN_EID_EXTENSION value means that the next
7165 * EID in the list is a sub-element of the EXTENSION IE.
7166 * @n_ids: the size of the element ID array
7167 * @offset: offset where to start splitting in the buffer
7169 * This function splits an IE buffer by updating the @offset
7170 * variable to point to the location where the buffer should be
7173 * It assumes that the given IE buffer is well-formed, this
7174 * has to be guaranteed by the caller!
7176 * It also assumes that the IEs in the buffer are ordered
7177 * correctly, if not the result of using this function will not
7178 * be ordered correctly either, i.e. it does no reordering.
7180 * The function returns the offset where the next part of the
7181 * buffer starts, which may be @ielen if the entire (remainder)
7182 * of the buffer should be used.
7184 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7185 const u8 *ids, int n_ids, size_t offset)
7187 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7191 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7192 * @wdev: the wireless device reporting the wakeup
7193 * @wakeup: the wakeup report
7194 * @gfp: allocation flags
7196 * This function reports that the given device woke up. If it
7197 * caused the wakeup, report the reason(s), otherwise you may
7198 * pass %NULL as the @wakeup parameter to advertise that something
7199 * else caused the wakeup.
7201 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7202 struct cfg80211_wowlan_wakeup *wakeup,
7206 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7208 * @wdev: the wireless device for which critical protocol is stopped.
7209 * @gfp: allocation flags
7211 * This function can be called by the driver to indicate it has reverted
7212 * operation back to normal. One reason could be that the duration given
7213 * by .crit_proto_start() has expired.
7215 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7218 * ieee80211_get_num_supported_channels - get number of channels device has
7221 * Return: the number of channels supported by the device.
7223 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7226 * cfg80211_check_combinations - check interface combinations
7229 * @params: the interface combinations parameter
7231 * This function can be called by the driver to check whether a
7232 * combination of interfaces and their types are allowed according to
7233 * the interface combinations.
7235 int cfg80211_check_combinations(struct wiphy *wiphy,
7236 struct iface_combination_params *params);
7239 * cfg80211_iter_combinations - iterate over matching combinations
7242 * @params: the interface combinations parameter
7243 * @iter: function to call for each matching combination
7244 * @data: pointer to pass to iter function
7246 * This function can be called by the driver to check what possible
7247 * combinations it fits in at a given moment, e.g. for channel switching
7250 int cfg80211_iter_combinations(struct wiphy *wiphy,
7251 struct iface_combination_params *params,
7252 void (*iter)(const struct ieee80211_iface_combination *c,
7257 * cfg80211_stop_iface - trigger interface disconnection
7260 * @wdev: wireless device
7261 * @gfp: context flags
7263 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7266 * Note: This doesn't need any locks and is asynchronous.
7268 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7272 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7273 * @wiphy: the wiphy to shut down
7275 * This function shuts down all interfaces belonging to this wiphy by
7276 * calling dev_close() (and treating non-netdev interfaces as needed).
7277 * It shouldn't really be used unless there are some fatal device errors
7278 * that really can't be recovered in any other way.
7280 * Callers must hold the RTNL and be able to deal with callbacks into
7281 * the driver while the function is running.
7283 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7286 * wiphy_ext_feature_set - set the extended feature flag
7288 * @wiphy: the wiphy to modify.
7289 * @ftidx: extended feature bit index.
7291 * The extended features are flagged in multiple bytes (see
7292 * &struct wiphy.@ext_features)
7294 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7295 enum nl80211_ext_feature_index ftidx)
7299 ft_byte = &wiphy->ext_features[ftidx / 8];
7300 *ft_byte |= BIT(ftidx % 8);
7304 * wiphy_ext_feature_isset - check the extended feature flag
7306 * @wiphy: the wiphy to modify.
7307 * @ftidx: extended feature bit index.
7309 * The extended features are flagged in multiple bytes (see
7310 * &struct wiphy.@ext_features)
7313 wiphy_ext_feature_isset(struct wiphy *wiphy,
7314 enum nl80211_ext_feature_index ftidx)
7318 ft_byte = wiphy->ext_features[ftidx / 8];
7319 return (ft_byte & BIT(ftidx % 8)) != 0;
7323 * cfg80211_free_nan_func - free NAN function
7324 * @f: NAN function that should be freed
7326 * Frees all the NAN function and all it's allocated members.
7328 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7331 * struct cfg80211_nan_match_params - NAN match parameters
7332 * @type: the type of the function that triggered a match. If it is
7333 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7334 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7336 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7337 * @inst_id: the local instance id
7338 * @peer_inst_id: the instance id of the peer's function
7339 * @addr: the MAC address of the peer
7340 * @info_len: the length of the &info
7341 * @info: the Service Specific Info from the peer (if any)
7342 * @cookie: unique identifier of the corresponding function
7344 struct cfg80211_nan_match_params {
7345 enum nl80211_nan_function_type type;
7355 * cfg80211_nan_match - report a match for a NAN function.
7356 * @wdev: the wireless device reporting the match
7357 * @match: match notification parameters
7358 * @gfp: allocation flags
7360 * This function reports that the a NAN function had a match. This
7361 * can be a subscribe that had a match or a solicited publish that
7362 * was sent. It can also be a follow up that was received.
7364 void cfg80211_nan_match(struct wireless_dev *wdev,
7365 struct cfg80211_nan_match_params *match, gfp_t gfp);
7368 * cfg80211_nan_func_terminated - notify about NAN function termination.
7370 * @wdev: the wireless device reporting the match
7371 * @inst_id: the local instance id
7372 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7373 * @cookie: unique NAN function identifier
7374 * @gfp: allocation flags
7376 * This function reports that the a NAN function is terminated.
7378 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7380 enum nl80211_nan_func_term_reason reason,
7381 u64 cookie, gfp_t gfp);
7383 /* ethtool helper */
7384 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7387 * cfg80211_external_auth_request - userspace request for authentication
7388 * @netdev: network device
7389 * @params: External authentication parameters
7390 * @gfp: allocation flags
7391 * Returns: 0 on success, < 0 on error
7393 int cfg80211_external_auth_request(struct net_device *netdev,
7394 struct cfg80211_external_auth_params *params,
7398 * cfg80211_pmsr_report - report peer measurement result data
7399 * @wdev: the wireless device reporting the measurement
7400 * @req: the original measurement request
7401 * @result: the result data
7402 * @gfp: allocation flags
7404 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7405 struct cfg80211_pmsr_request *req,
7406 struct cfg80211_pmsr_result *result,
7410 * cfg80211_pmsr_complete - report peer measurement completed
7411 * @wdev: the wireless device reporting the measurement
7412 * @req: the original measurement request
7413 * @gfp: allocation flags
7415 * Report that the entire measurement completed, after this
7416 * the request pointer will no longer be valid.
7418 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7419 struct cfg80211_pmsr_request *req,
7423 * cfg80211_iftype_allowed - check whether the interface can be allowed
7425 * @iftype: interface type
7426 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7427 * @check_swif: check iftype against software interfaces
7429 * Check whether the interface is allowed to operate; additionally, this API
7430 * can be used to check iftype against the software interfaces when
7431 * check_swif is '1'.
7433 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
7434 bool is_4addr, u8 check_swif);
7437 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7439 /* wiphy_printk helpers, similar to dev_printk */
7441 #define wiphy_printk(level, wiphy, format, args...) \
7442 dev_printk(level, &(wiphy)->dev, format, ##args)
7443 #define wiphy_emerg(wiphy, format, args...) \
7444 dev_emerg(&(wiphy)->dev, format, ##args)
7445 #define wiphy_alert(wiphy, format, args...) \
7446 dev_alert(&(wiphy)->dev, format, ##args)
7447 #define wiphy_crit(wiphy, format, args...) \
7448 dev_crit(&(wiphy)->dev, format, ##args)
7449 #define wiphy_err(wiphy, format, args...) \
7450 dev_err(&(wiphy)->dev, format, ##args)
7451 #define wiphy_warn(wiphy, format, args...) \
7452 dev_warn(&(wiphy)->dev, format, ##args)
7453 #define wiphy_notice(wiphy, format, args...) \
7454 dev_notice(&(wiphy)->dev, format, ##args)
7455 #define wiphy_info(wiphy, format, args...) \
7456 dev_info(&(wiphy)->dev, format, ##args)
7458 #define wiphy_err_ratelimited(wiphy, format, args...) \
7459 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7460 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7461 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7463 #define wiphy_debug(wiphy, format, args...) \
7464 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7466 #define wiphy_dbg(wiphy, format, args...) \
7467 dev_dbg(&(wiphy)->dev, format, ##args)
7469 #if defined(VERBOSE_DEBUG)
7470 #define wiphy_vdbg wiphy_dbg
7472 #define wiphy_vdbg(wiphy, format, args...) \
7475 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
7481 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7482 * of using a WARN/WARN_ON to get the message out, including the
7483 * file/line information and a backtrace.
7485 #define wiphy_WARN(wiphy, format, args...) \
7486 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7489 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
7490 * @netdev: network device
7491 * @owe_info: peer's owe info
7492 * @gfp: allocation flags
7494 void cfg80211_update_owe_info_event(struct net_device *netdev,
7495 struct cfg80211_update_owe_info *owe_info,
7498 #endif /* __NET_CFG80211_H */