1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright 2015-2017 Intel Deutschland GmbH
9 * Copyright (C) 2018-2019 Intel Corporation
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
16 #include <linux/netdevice.h>
17 #include <linux/debugfs.h>
18 #include <linux/list.h>
19 #include <linux/bug.h>
20 #include <linux/netlink.h>
21 #include <linux/skbuff.h>
22 #include <linux/nl80211.h>
23 #include <linux/if_ether.h>
24 #include <linux/ieee80211.h>
25 #include <linux/net.h>
26 #include <net/regulatory.h>
31 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32 * userspace and drivers, and offers some utility functionality associated
33 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34 * by all modern wireless drivers in Linux, so that they offer a consistent
35 * API through nl80211. For backward compatibility, cfg80211 also offers
36 * wireless extensions to userspace, but hides them from drivers completely.
38 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
44 * DOC: Device registration
46 * In order for a driver to use cfg80211, it must register the hardware device
47 * with cfg80211. This happens through a number of hardware capability structs
50 * The fundamental structure for each device is the 'wiphy', of which each
51 * instance describes a physical wireless device connected to the system. Each
52 * such wiphy can have zero, one, or many virtual interfaces associated with
53 * it, which need to be identified as such by pointing the network interface's
54 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55 * the wireless part of the interface, normally this struct is embedded in the
56 * network interface's private data area. Drivers can optionally allow creating
57 * or destroying virtual interfaces on the fly, but without at least one or the
58 * ability to create some the wireless device isn't useful.
60 * Each wiphy structure contains device capability information, and also has
61 * a pointer to the various operations the driver offers. The definitions and
62 * structures here describe these capabilities in detail.
68 * wireless hardware capability structures
72 * enum ieee80211_channel_flags - channel flags
74 * Channel flags set by the regulatory control code.
76 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
77 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
78 * sending probe requests or beaconing.
79 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
80 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
82 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
84 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
85 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
86 * this flag indicates that an 80 MHz channel cannot use this
87 * channel as the control or any of the secondary channels.
88 * This may be due to the driver or due to regulatory bandwidth
90 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
91 * this flag indicates that an 160 MHz channel cannot use this
92 * channel as the control or any of the secondary channels.
93 * This may be due to the driver or due to regulatory bandwidth
95 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
96 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
97 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
99 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
103 enum ieee80211_channel_flags {
104 IEEE80211_CHAN_DISABLED = 1<<0,
105 IEEE80211_CHAN_NO_IR = 1<<1,
107 IEEE80211_CHAN_RADAR = 1<<3,
108 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
109 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
110 IEEE80211_CHAN_NO_OFDM = 1<<6,
111 IEEE80211_CHAN_NO_80MHZ = 1<<7,
112 IEEE80211_CHAN_NO_160MHZ = 1<<8,
113 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
114 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
115 IEEE80211_CHAN_NO_20MHZ = 1<<11,
116 IEEE80211_CHAN_NO_10MHZ = 1<<12,
119 #define IEEE80211_CHAN_NO_HT40 \
120 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
122 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
123 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
126 * struct ieee80211_channel - channel definition
128 * This structure describes a single channel for use
131 * @center_freq: center frequency in MHz
132 * @hw_value: hardware-specific value for the channel
133 * @flags: channel flags from &enum ieee80211_channel_flags.
134 * @orig_flags: channel flags at registration time, used by regulatory
135 * code to support devices with additional restrictions
136 * @band: band this channel belongs to.
137 * @max_antenna_gain: maximum antenna gain in dBi
138 * @max_power: maximum transmission power (in dBm)
139 * @max_reg_power: maximum regulatory transmission power (in dBm)
140 * @beacon_found: helper to regulatory code to indicate when a beacon
141 * has been found on this channel. Use regulatory_hint_found_beacon()
142 * to enable this, this is useful only on 5 GHz band.
143 * @orig_mag: internal use
144 * @orig_mpwr: internal use
145 * @dfs_state: current state of this channel. Only relevant if radar is required
147 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
148 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
150 struct ieee80211_channel {
151 enum nl80211_band band;
155 int max_antenna_gain;
160 int orig_mag, orig_mpwr;
161 enum nl80211_dfs_state dfs_state;
162 unsigned long dfs_state_entered;
163 unsigned int dfs_cac_ms;
167 * enum ieee80211_rate_flags - rate flags
169 * Hardware/specification flags for rates. These are structured
170 * in a way that allows using the same bitrate structure for
171 * different bands/PHY modes.
173 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
174 * preamble on this bitrate; only relevant in 2.4GHz band and
176 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
177 * when used with 802.11a (on the 5 GHz band); filled by the
178 * core code when registering the wiphy.
179 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
180 * when used with 802.11b (on the 2.4 GHz band); filled by the
181 * core code when registering the wiphy.
182 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
183 * when used with 802.11g (on the 2.4 GHz band); filled by the
184 * core code when registering the wiphy.
185 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
186 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
187 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
189 enum ieee80211_rate_flags {
190 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
191 IEEE80211_RATE_MANDATORY_A = 1<<1,
192 IEEE80211_RATE_MANDATORY_B = 1<<2,
193 IEEE80211_RATE_MANDATORY_G = 1<<3,
194 IEEE80211_RATE_ERP_G = 1<<4,
195 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
196 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
200 * enum ieee80211_bss_type - BSS type filter
202 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
203 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
204 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
205 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
206 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
208 enum ieee80211_bss_type {
209 IEEE80211_BSS_TYPE_ESS,
210 IEEE80211_BSS_TYPE_PBSS,
211 IEEE80211_BSS_TYPE_IBSS,
212 IEEE80211_BSS_TYPE_MBSS,
213 IEEE80211_BSS_TYPE_ANY
217 * enum ieee80211_privacy - BSS privacy filter
219 * @IEEE80211_PRIVACY_ON: privacy bit set
220 * @IEEE80211_PRIVACY_OFF: privacy bit clear
221 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
223 enum ieee80211_privacy {
224 IEEE80211_PRIVACY_ON,
225 IEEE80211_PRIVACY_OFF,
226 IEEE80211_PRIVACY_ANY
229 #define IEEE80211_PRIVACY(x) \
230 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
233 * struct ieee80211_rate - bitrate definition
235 * This structure describes a bitrate that an 802.11 PHY can
236 * operate with. The two values @hw_value and @hw_value_short
237 * are only for driver use when pointers to this structure are
240 * @flags: rate-specific flags
241 * @bitrate: bitrate in units of 100 Kbps
242 * @hw_value: driver/hardware value for this rate
243 * @hw_value_short: driver/hardware value for this rate when
244 * short preamble is used
246 struct ieee80211_rate {
249 u16 hw_value, hw_value_short;
253 * struct ieee80211_sta_ht_cap - STA's HT capabilities
255 * This structure describes most essential parameters needed
256 * to describe 802.11n HT capabilities for an STA.
258 * @ht_supported: is HT supported by the STA
259 * @cap: HT capabilities map as described in 802.11n spec
260 * @ampdu_factor: Maximum A-MPDU length factor
261 * @ampdu_density: Minimum A-MPDU spacing
262 * @mcs: Supported MCS rates
264 struct ieee80211_sta_ht_cap {
265 u16 cap; /* use IEEE80211_HT_CAP_ */
269 struct ieee80211_mcs_info mcs;
273 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
275 * This structure describes most essential parameters needed
276 * to describe 802.11ac VHT capabilities for an STA.
278 * @vht_supported: is VHT supported by the STA
279 * @cap: VHT capabilities map as described in 802.11ac spec
280 * @vht_mcs: Supported VHT MCS rates
282 struct ieee80211_sta_vht_cap {
284 u32 cap; /* use IEEE80211_VHT_CAP_ */
285 struct ieee80211_vht_mcs_info vht_mcs;
288 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
291 * struct ieee80211_sta_he_cap - STA's HE capabilities
293 * This structure describes most essential parameters needed
294 * to describe 802.11ax HE capabilities for a STA.
296 * @has_he: true iff HE data is valid.
297 * @he_cap_elem: Fixed portion of the HE capabilities element.
298 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
299 * @ppe_thres: Holds the PPE Thresholds data.
301 struct ieee80211_sta_he_cap {
303 struct ieee80211_he_cap_elem he_cap_elem;
304 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
305 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
309 * struct ieee80211_sband_iftype_data
311 * This structure encapsulates sband data that is relevant for the
312 * interface types defined in @types_mask. Each type in the
313 * @types_mask must be unique across all instances of iftype_data.
315 * @types_mask: interface types mask
316 * @he_cap: holds the HE capabilities
318 struct ieee80211_sband_iftype_data {
320 struct ieee80211_sta_he_cap he_cap;
324 * struct ieee80211_supported_band - frequency band definition
326 * This structure describes a frequency band a wiphy
327 * is able to operate in.
329 * @channels: Array of channels the hardware can operate in
331 * @band: the band this structure represents
332 * @n_channels: Number of channels in @channels
333 * @bitrates: Array of bitrates the hardware can operate with
334 * in this band. Must be sorted to give a valid "supported
335 * rates" IE, i.e. CCK rates first, then OFDM.
336 * @n_bitrates: Number of bitrates in @bitrates
337 * @ht_cap: HT capabilities in this band
338 * @vht_cap: VHT capabilities in this band
339 * @n_iftype_data: number of iftype data entries
340 * @iftype_data: interface type data entries. Note that the bits in
341 * @types_mask inside this structure cannot overlap (i.e. only
342 * one occurrence of each type is allowed across all instances of
345 struct ieee80211_supported_band {
346 struct ieee80211_channel *channels;
347 struct ieee80211_rate *bitrates;
348 enum nl80211_band band;
351 struct ieee80211_sta_ht_cap ht_cap;
352 struct ieee80211_sta_vht_cap vht_cap;
354 const struct ieee80211_sband_iftype_data *iftype_data;
358 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
359 * @sband: the sband to search for the STA on
360 * @iftype: enum nl80211_iftype
362 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
364 static inline const struct ieee80211_sband_iftype_data *
365 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
370 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
373 for (i = 0; i < sband->n_iftype_data; i++) {
374 const struct ieee80211_sband_iftype_data *data =
375 &sband->iftype_data[i];
377 if (data->types_mask & BIT(iftype))
385 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
386 * @sband: the sband to search for the STA on
388 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
390 static inline const struct ieee80211_sta_he_cap *
391 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
393 const struct ieee80211_sband_iftype_data *data =
394 ieee80211_get_sband_iftype_data(sband, NL80211_IFTYPE_STATION);
396 if (data && data->he_cap.has_he)
397 return &data->he_cap;
403 * wiphy_read_of_freq_limits - read frequency limits from device tree
405 * @wiphy: the wireless device to get extra limits for
407 * Some devices may have extra limitations specified in DT. This may be useful
408 * for chipsets that normally support more bands but are limited due to board
409 * design (e.g. by antennas or external power amplifier).
411 * This function reads info from DT and uses it to *modify* channels (disable
412 * unavailable ones). It's usually a *bad* idea to use it in drivers with
413 * shared channel data as DT limitations are device specific. You should make
414 * sure to call it only if channels in wiphy are copied and can be modified
415 * without affecting other devices.
417 * As this function access device node it has to be called after set_wiphy_dev.
418 * It also modifies channels so they have to be set first.
419 * If using this helper, call it before wiphy_register().
422 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
423 #else /* CONFIG_OF */
424 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
427 #endif /* !CONFIG_OF */
431 * Wireless hardware/device configuration structures and methods
435 * DOC: Actions and configuration
437 * Each wireless device and each virtual interface offer a set of configuration
438 * operations and other actions that are invoked by userspace. Each of these
439 * actions is described in the operations structure, and the parameters these
440 * operations use are described separately.
442 * Additionally, some operations are asynchronous and expect to get status
443 * information via some functions that drivers need to call.
445 * Scanning and BSS list handling with its associated functionality is described
446 * in a separate chapter.
449 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
450 WLAN_USER_POSITION_LEN)
453 * struct vif_params - describes virtual interface parameters
454 * @flags: monitor interface flags, unchanged if 0, otherwise
455 * %MONITOR_FLAG_CHANGED will be set
456 * @use_4addr: use 4-address frames
457 * @macaddr: address to use for this virtual interface.
458 * If this parameter is set to zero address the driver may
459 * determine the address as needed.
460 * This feature is only fully supported by drivers that enable the
461 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
462 ** only p2p devices with specified MAC.
463 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
464 * belonging to that MU-MIMO groupID; %NULL if not changed
465 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
466 * MU-MIMO packets going to the specified station; %NULL if not changed
471 u8 macaddr[ETH_ALEN];
472 const u8 *vht_mumimo_groups;
473 const u8 *vht_mumimo_follow_addr;
477 * struct key_params - key information
479 * Information about a key
482 * @key_len: length of key material
483 * @cipher: cipher suite selector
484 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
485 * with the get_key() callback, must be in little endian,
486 * length given by @seq_len.
487 * @seq_len: length of @seq.
488 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
496 enum nl80211_key_mode mode;
500 * struct cfg80211_chan_def - channel definition
501 * @chan: the (control) channel
502 * @width: channel width
503 * @center_freq1: center frequency of first segment
504 * @center_freq2: center frequency of second segment
505 * (only with 80+80 MHz)
507 struct cfg80211_chan_def {
508 struct ieee80211_channel *chan;
509 enum nl80211_chan_width width;
515 * cfg80211_get_chandef_type - return old channel type from chandef
516 * @chandef: the channel definition
518 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
519 * chandef, which must have a bandwidth allowing this conversion.
521 static inline enum nl80211_channel_type
522 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
524 switch (chandef->width) {
525 case NL80211_CHAN_WIDTH_20_NOHT:
526 return NL80211_CHAN_NO_HT;
527 case NL80211_CHAN_WIDTH_20:
528 return NL80211_CHAN_HT20;
529 case NL80211_CHAN_WIDTH_40:
530 if (chandef->center_freq1 > chandef->chan->center_freq)
531 return NL80211_CHAN_HT40PLUS;
532 return NL80211_CHAN_HT40MINUS;
535 return NL80211_CHAN_NO_HT;
540 * cfg80211_chandef_create - create channel definition using channel type
541 * @chandef: the channel definition struct to fill
542 * @channel: the control channel
543 * @chantype: the channel type
545 * Given a channel type, create a channel definition.
547 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
548 struct ieee80211_channel *channel,
549 enum nl80211_channel_type chantype);
552 * cfg80211_chandef_identical - check if two channel definitions are identical
553 * @chandef1: first channel definition
554 * @chandef2: second channel definition
556 * Return: %true if the channels defined by the channel definitions are
557 * identical, %false otherwise.
560 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
561 const struct cfg80211_chan_def *chandef2)
563 return (chandef1->chan == chandef2->chan &&
564 chandef1->width == chandef2->width &&
565 chandef1->center_freq1 == chandef2->center_freq1 &&
566 chandef1->center_freq2 == chandef2->center_freq2);
570 * cfg80211_chandef_compatible - check if two channel definitions are compatible
571 * @chandef1: first channel definition
572 * @chandef2: second channel definition
574 * Return: %NULL if the given channel definitions are incompatible,
575 * chandef1 or chandef2 otherwise.
577 const struct cfg80211_chan_def *
578 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
579 const struct cfg80211_chan_def *chandef2);
582 * cfg80211_chandef_valid - check if a channel definition is valid
583 * @chandef: the channel definition to check
584 * Return: %true if the channel definition is valid. %false otherwise.
586 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
589 * cfg80211_chandef_usable - check if secondary channels can be used
590 * @wiphy: the wiphy to validate against
591 * @chandef: the channel definition to check
592 * @prohibited_flags: the regulatory channel flags that must not be set
593 * Return: %true if secondary channels are usable. %false otherwise.
595 bool cfg80211_chandef_usable(struct wiphy *wiphy,
596 const struct cfg80211_chan_def *chandef,
597 u32 prohibited_flags);
600 * cfg80211_chandef_dfs_required - checks if radar detection is required
601 * @wiphy: the wiphy to validate against
602 * @chandef: the channel definition to check
603 * @iftype: the interface type as specified in &enum nl80211_iftype
605 * 1 if radar detection is required, 0 if it is not, < 0 on error
607 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
608 const struct cfg80211_chan_def *chandef,
609 enum nl80211_iftype iftype);
612 * ieee80211_chandef_rate_flags - returns rate flags for a channel
614 * In some channel types, not all rates may be used - for example CCK
615 * rates may not be used in 5/10 MHz channels.
617 * @chandef: channel definition for the channel
619 * Returns: rate flags which apply for this channel
621 static inline enum ieee80211_rate_flags
622 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
624 switch (chandef->width) {
625 case NL80211_CHAN_WIDTH_5:
626 return IEEE80211_RATE_SUPPORTS_5MHZ;
627 case NL80211_CHAN_WIDTH_10:
628 return IEEE80211_RATE_SUPPORTS_10MHZ;
636 * ieee80211_chandef_max_power - maximum transmission power for the chandef
638 * In some regulations, the transmit power may depend on the configured channel
639 * bandwidth which may be defined as dBm/MHz. This function returns the actual
640 * max_power for non-standard (20 MHz) channels.
642 * @chandef: channel definition for the channel
644 * Returns: maximum allowed transmission power in dBm for the chandef
647 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
649 switch (chandef->width) {
650 case NL80211_CHAN_WIDTH_5:
651 return min(chandef->chan->max_reg_power - 6,
652 chandef->chan->max_power);
653 case NL80211_CHAN_WIDTH_10:
654 return min(chandef->chan->max_reg_power - 3,
655 chandef->chan->max_power);
659 return chandef->chan->max_power;
663 * enum survey_info_flags - survey information flags
665 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
666 * @SURVEY_INFO_IN_USE: channel is currently being used
667 * @SURVEY_INFO_TIME: active time (in ms) was filled in
668 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
669 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
670 * @SURVEY_INFO_TIME_RX: receive time was filled in
671 * @SURVEY_INFO_TIME_TX: transmit time was filled in
672 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
674 * Used by the driver to indicate which info in &struct survey_info
675 * it has filled in during the get_survey().
677 enum survey_info_flags {
678 SURVEY_INFO_NOISE_DBM = BIT(0),
679 SURVEY_INFO_IN_USE = BIT(1),
680 SURVEY_INFO_TIME = BIT(2),
681 SURVEY_INFO_TIME_BUSY = BIT(3),
682 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
683 SURVEY_INFO_TIME_RX = BIT(5),
684 SURVEY_INFO_TIME_TX = BIT(6),
685 SURVEY_INFO_TIME_SCAN = BIT(7),
689 * struct survey_info - channel survey response
691 * @channel: the channel this survey record reports, may be %NULL for a single
692 * record to report global statistics
693 * @filled: bitflag of flags from &enum survey_info_flags
694 * @noise: channel noise in dBm. This and all following fields are
696 * @time: amount of time in ms the radio was turn on (on the channel)
697 * @time_busy: amount of time the primary channel was sensed busy
698 * @time_ext_busy: amount of time the extension channel was sensed busy
699 * @time_rx: amount of time the radio spent receiving data
700 * @time_tx: amount of time the radio spent transmitting data
701 * @time_scan: amount of time the radio spent for scanning
703 * Used by dump_survey() to report back per-channel survey information.
705 * This structure can later be expanded with things like
706 * channel duty cycle etc.
709 struct ieee80211_channel *channel;
720 #define CFG80211_MAX_WEP_KEYS 4
723 * struct cfg80211_crypto_settings - Crypto settings
724 * @wpa_versions: indicates which, if any, WPA versions are enabled
725 * (from enum nl80211_wpa_versions)
726 * @cipher_group: group key cipher suite (or 0 if unset)
727 * @n_ciphers_pairwise: number of AP supported unicast ciphers
728 * @ciphers_pairwise: unicast key cipher suites
729 * @n_akm_suites: number of AKM suites
730 * @akm_suites: AKM suites
731 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
732 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
733 * required to assume that the port is unauthorized until authorized by
734 * user space. Otherwise, port is marked authorized by default.
735 * @control_port_ethertype: the control port protocol that should be
736 * allowed through even on unauthorized ports
737 * @control_port_no_encrypt: TRUE to prevent encryption of control port
739 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
740 * port frames over NL80211 instead of the network interface.
741 * @wep_keys: static WEP keys, if not NULL points to an array of
742 * CFG80211_MAX_WEP_KEYS WEP keys
743 * @wep_tx_key: key index (0..3) of the default TX static WEP key
744 * @psk: PSK (for devices supporting 4-way-handshake offload)
746 struct cfg80211_crypto_settings {
749 int n_ciphers_pairwise;
750 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
752 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
754 __be16 control_port_ethertype;
755 bool control_port_no_encrypt;
756 bool control_port_over_nl80211;
757 struct key_params *wep_keys;
763 * struct cfg80211_beacon_data - beacon data
764 * @head: head portion of beacon (before TIM IE)
765 * or %NULL if not changed
766 * @tail: tail portion of beacon (after TIM IE)
767 * or %NULL if not changed
768 * @head_len: length of @head
769 * @tail_len: length of @tail
770 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
771 * @beacon_ies_len: length of beacon_ies in octets
772 * @proberesp_ies: extra information element(s) to add into Probe Response
774 * @proberesp_ies_len: length of proberesp_ies in octets
775 * @assocresp_ies: extra information element(s) to add into (Re)Association
776 * Response frames or %NULL
777 * @assocresp_ies_len: length of assocresp_ies in octets
778 * @probe_resp_len: length of probe response template (@probe_resp)
779 * @probe_resp: probe response template (AP mode only)
780 * @ftm_responder: enable FTM responder functionality; -1 for no change
781 * (which also implies no change in LCI/civic location data)
782 * @lci: Measurement Report element content, starting with Measurement Token
783 * (measurement type 8)
784 * @civicloc: Measurement Report element content, starting with Measurement
785 * Token (measurement type 11)
786 * @lci_len: LCI data length
787 * @civicloc_len: Civic location data length
789 struct cfg80211_beacon_data {
790 const u8 *head, *tail;
791 const u8 *beacon_ies;
792 const u8 *proberesp_ies;
793 const u8 *assocresp_ies;
794 const u8 *probe_resp;
799 size_t head_len, tail_len;
800 size_t beacon_ies_len;
801 size_t proberesp_ies_len;
802 size_t assocresp_ies_len;
803 size_t probe_resp_len;
813 * struct cfg80211_acl_data - Access control list data
815 * @acl_policy: ACL policy to be applied on the station's
816 * entry specified by mac_addr
817 * @n_acl_entries: Number of MAC address entries passed
818 * @mac_addrs: List of MAC addresses of stations to be used for ACL
820 struct cfg80211_acl_data {
821 enum nl80211_acl_policy acl_policy;
825 struct mac_address mac_addrs[];
829 * cfg80211_bitrate_mask - masks for bitrate control
831 struct cfg80211_bitrate_mask {
834 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
835 u16 vht_mcs[NL80211_VHT_NSS_MAX];
836 enum nl80211_txrate_gi gi;
837 } control[NUM_NL80211_BANDS];
841 * enum cfg80211_ap_settings_flags - AP settings flags
843 * Used by cfg80211_ap_settings
845 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
847 enum cfg80211_ap_settings_flags {
848 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
852 * struct cfg80211_ap_settings - AP configuration
854 * Used to configure an AP interface.
856 * @chandef: defines the channel to use
857 * @beacon: beacon data
858 * @beacon_interval: beacon interval
859 * @dtim_period: DTIM period
860 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
862 * @ssid_len: length of @ssid
863 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
864 * @crypto: crypto settings
865 * @privacy: the BSS uses privacy
866 * @auth_type: Authentication type (algorithm)
867 * @smps_mode: SMPS mode
868 * @inactivity_timeout: time in seconds to determine station's inactivity.
869 * @p2p_ctwindow: P2P CT Window
870 * @p2p_opp_ps: P2P opportunistic PS
871 * @acl: ACL configuration used by the drivers which has support for
872 * MAC address based access control
873 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
875 * @beacon_rate: bitrate to be used for beacons
876 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
877 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
878 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
879 * @ht_required: stations must support HT
880 * @vht_required: stations must support VHT
881 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
883 struct cfg80211_ap_settings {
884 struct cfg80211_chan_def chandef;
886 struct cfg80211_beacon_data beacon;
888 int beacon_interval, dtim_period;
891 enum nl80211_hidden_ssid hidden_ssid;
892 struct cfg80211_crypto_settings crypto;
894 enum nl80211_auth_type auth_type;
895 enum nl80211_smps_mode smps_mode;
896 int inactivity_timeout;
899 const struct cfg80211_acl_data *acl;
901 struct cfg80211_bitrate_mask beacon_rate;
903 const struct ieee80211_ht_cap *ht_cap;
904 const struct ieee80211_vht_cap *vht_cap;
905 const struct ieee80211_he_cap_elem *he_cap;
906 bool ht_required, vht_required;
911 * struct cfg80211_csa_settings - channel switch settings
913 * Used for channel switch
915 * @chandef: defines the channel to use after the switch
916 * @beacon_csa: beacon data while performing the switch
917 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
918 * @counter_offsets_presp: offsets of the counters within the probe response
919 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
920 * @n_counter_offsets_presp: number of csa counters in the probe response
921 * @beacon_after: beacon data to be used on the new channel
922 * @radar_required: whether radar detection is required on the new channel
923 * @block_tx: whether transmissions should be blocked while changing
924 * @count: number of beacons until switch
926 struct cfg80211_csa_settings {
927 struct cfg80211_chan_def chandef;
928 struct cfg80211_beacon_data beacon_csa;
929 const u16 *counter_offsets_beacon;
930 const u16 *counter_offsets_presp;
931 unsigned int n_counter_offsets_beacon;
932 unsigned int n_counter_offsets_presp;
933 struct cfg80211_beacon_data beacon_after;
939 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
942 * struct iface_combination_params - input parameters for interface combinations
944 * Used to pass interface combination parameters
946 * @num_different_channels: the number of different channels we want
947 * to use for verification
948 * @radar_detect: a bitmap where each bit corresponds to a channel
949 * width where radar detection is needed, as in the definition of
950 * &struct ieee80211_iface_combination.@radar_detect_widths
951 * @iftype_num: array with the number of interfaces of each interface
952 * type. The index is the interface type as specified in &enum
954 * @new_beacon_int: set this to the beacon interval of a new interface
955 * that's not operating yet, if such is to be checked as part of
958 struct iface_combination_params {
959 int num_different_channels;
961 int iftype_num[NUM_NL80211_IFTYPES];
966 * enum station_parameters_apply_mask - station parameter values to apply
967 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
968 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
969 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
971 * Not all station parameters have in-band "no change" signalling,
972 * for those that don't these flags will are used.
974 enum station_parameters_apply_mask {
975 STATION_PARAM_APPLY_UAPSD = BIT(0),
976 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
977 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
978 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
982 * struct sta_txpwr - station txpower configuration
984 * Used to configure txpower for station.
986 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
987 * is not provided, the default per-interface tx power setting will be
988 * overriding. Driver should be picking up the lowest tx power, either tx
989 * power per-interface or per-station.
990 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
991 * will be less than or equal to specified from userspace, whereas if TPC
992 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
993 * NL80211_TX_POWER_FIXED is not a valid configuration option for
998 enum nl80211_tx_power_setting type;
1002 * struct station_parameters - station parameters
1004 * Used to change and create a new station.
1006 * @vlan: vlan interface station should belong to
1007 * @supported_rates: supported rates in IEEE 802.11 format
1008 * (or NULL for no change)
1009 * @supported_rates_len: number of supported rates
1010 * @sta_flags_mask: station flags that changed
1011 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1012 * @sta_flags_set: station flags values
1013 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1014 * @listen_interval: listen interval or -1 for no change
1015 * @aid: AID or zero for no change
1016 * @peer_aid: mesh peer AID or zero for no change
1017 * @plink_action: plink action to take
1018 * @plink_state: set the peer link state for a station
1019 * @ht_capa: HT capabilities of station
1020 * @vht_capa: VHT capabilities of station
1021 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1022 * as the AC bitmap in the QoS info field
1023 * @max_sp: max Service Period. same format as the MAX_SP in the
1024 * QoS info field (but already shifted down)
1025 * @sta_modify_mask: bitmap indicating which parameters changed
1026 * (for those that don't have a natural "no change" value),
1027 * see &enum station_parameters_apply_mask
1028 * @local_pm: local link-specific mesh power save mode (no change when set
1030 * @capability: station capability
1031 * @ext_capab: extended capabilities of the station
1032 * @ext_capab_len: number of extended capabilities
1033 * @supported_channels: supported channels in IEEE 802.11 format
1034 * @supported_channels_len: number of supported channels
1035 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1036 * @supported_oper_classes_len: number of supported operating classes
1037 * @opmode_notif: operating mode field from Operating Mode Notification
1038 * @opmode_notif_used: information if operating mode field is used
1039 * @support_p2p_ps: information if station supports P2P PS mechanism
1040 * @he_capa: HE capabilities of station
1041 * @he_capa_len: the length of the HE capabilities
1042 * @airtime_weight: airtime scheduler weight for this station
1044 struct station_parameters {
1045 const u8 *supported_rates;
1046 struct net_device *vlan;
1047 u32 sta_flags_mask, sta_flags_set;
1048 u32 sta_modify_mask;
1049 int listen_interval;
1052 u8 supported_rates_len;
1055 const struct ieee80211_ht_cap *ht_capa;
1056 const struct ieee80211_vht_cap *vht_capa;
1059 enum nl80211_mesh_power_mode local_pm;
1061 const u8 *ext_capab;
1063 const u8 *supported_channels;
1064 u8 supported_channels_len;
1065 const u8 *supported_oper_classes;
1066 u8 supported_oper_classes_len;
1068 bool opmode_notif_used;
1070 const struct ieee80211_he_cap_elem *he_capa;
1073 struct sta_txpwr txpwr;
1077 * struct station_del_parameters - station deletion parameters
1079 * Used to delete a station entry (or all stations).
1081 * @mac: MAC address of the station to remove or NULL to remove all stations
1082 * @subtype: Management frame subtype to use for indicating removal
1083 * (10 = Disassociation, 12 = Deauthentication)
1084 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1086 struct station_del_parameters {
1093 * enum cfg80211_station_type - the type of station being modified
1094 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1095 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1096 * unassociated (update properties for this type of client is permitted)
1097 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1098 * the AP MLME in the device
1099 * @CFG80211_STA_AP_STA: AP station on managed interface
1100 * @CFG80211_STA_IBSS: IBSS station
1101 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1102 * while TDLS setup is in progress, it moves out of this state when
1103 * being marked authorized; use this only if TDLS with external setup is
1105 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1106 * entry that is operating, has been marked authorized by userspace)
1107 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1108 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1110 enum cfg80211_station_type {
1111 CFG80211_STA_AP_CLIENT,
1112 CFG80211_STA_AP_CLIENT_UNASSOC,
1113 CFG80211_STA_AP_MLME_CLIENT,
1114 CFG80211_STA_AP_STA,
1116 CFG80211_STA_TDLS_PEER_SETUP,
1117 CFG80211_STA_TDLS_PEER_ACTIVE,
1118 CFG80211_STA_MESH_PEER_KERNEL,
1119 CFG80211_STA_MESH_PEER_USER,
1123 * cfg80211_check_station_change - validate parameter changes
1124 * @wiphy: the wiphy this operates on
1125 * @params: the new parameters for a station
1126 * @statype: the type of station being modified
1128 * Utility function for the @change_station driver method. Call this function
1129 * with the appropriate station type looking up the station (and checking that
1130 * it exists). It will verify whether the station change is acceptable, and if
1131 * not will return an error code. Note that it may modify the parameters for
1132 * backward compatibility reasons, so don't use them before calling this.
1134 int cfg80211_check_station_change(struct wiphy *wiphy,
1135 struct station_parameters *params,
1136 enum cfg80211_station_type statype);
1139 * enum station_info_rate_flags - bitrate info flags
1141 * Used by the driver to indicate the specific rate transmission
1142 * type for 802.11n transmissions.
1144 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1145 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1146 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1147 * @RATE_INFO_FLAGS_60G: 60GHz MCS
1148 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1150 enum rate_info_flags {
1151 RATE_INFO_FLAGS_MCS = BIT(0),
1152 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1153 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1154 RATE_INFO_FLAGS_60G = BIT(3),
1155 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1159 * enum rate_info_bw - rate bandwidth information
1161 * Used by the driver to indicate the rate bandwidth.
1163 * @RATE_INFO_BW_5: 5 MHz bandwidth
1164 * @RATE_INFO_BW_10: 10 MHz bandwidth
1165 * @RATE_INFO_BW_20: 20 MHz bandwidth
1166 * @RATE_INFO_BW_40: 40 MHz bandwidth
1167 * @RATE_INFO_BW_80: 80 MHz bandwidth
1168 * @RATE_INFO_BW_160: 160 MHz bandwidth
1169 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1172 RATE_INFO_BW_20 = 0,
1182 * struct rate_info - bitrate information
1184 * Information about a receiving or transmitting bitrate
1186 * @flags: bitflag of flags from &enum rate_info_flags
1187 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1188 * @legacy: bitrate in 100kbit/s for 802.11abg
1189 * @nss: number of streams (VHT & HE only)
1190 * @bw: bandwidth (from &enum rate_info_bw)
1191 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1192 * @he_dcm: HE DCM value
1193 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1194 * only valid if bw is %RATE_INFO_BW_HE_RU)
1208 * enum station_info_rate_flags - bitrate info flags
1210 * Used by the driver to indicate the specific rate transmission
1211 * type for 802.11n transmissions.
1213 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1214 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1215 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1217 enum bss_param_flags {
1218 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1219 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1220 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1224 * struct sta_bss_parameters - BSS parameters for the attached station
1226 * Information about the currently associated BSS
1228 * @flags: bitflag of flags from &enum bss_param_flags
1229 * @dtim_period: DTIM period for the BSS
1230 * @beacon_interval: beacon interval
1232 struct sta_bss_parameters {
1235 u16 beacon_interval;
1239 * struct cfg80211_txq_stats - TXQ statistics for this TID
1240 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1241 * indicate the relevant values in this struct are filled
1242 * @backlog_bytes: total number of bytes currently backlogged
1243 * @backlog_packets: total number of packets currently backlogged
1244 * @flows: number of new flows seen
1245 * @drops: total number of packets dropped
1246 * @ecn_marks: total number of packets marked with ECN CE
1247 * @overlimit: number of drops due to queue space overflow
1248 * @overmemory: number of drops due to memory limit overflow
1249 * @collisions: number of hash collisions
1250 * @tx_bytes: total number of bytes dequeued
1251 * @tx_packets: total number of packets dequeued
1252 * @max_flows: maximum number of flows supported
1254 struct cfg80211_txq_stats {
1257 u32 backlog_packets;
1270 * struct cfg80211_tid_stats - per-TID statistics
1271 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1272 * indicate the relevant values in this struct are filled
1273 * @rx_msdu: number of received MSDUs
1274 * @tx_msdu: number of (attempted) transmitted MSDUs
1275 * @tx_msdu_retries: number of retries (not counting the first) for
1277 * @tx_msdu_failed: number of failed transmitted MSDUs
1278 * @txq_stats: TXQ statistics
1280 struct cfg80211_tid_stats {
1284 u64 tx_msdu_retries;
1286 struct cfg80211_txq_stats txq_stats;
1289 #define IEEE80211_MAX_CHAINS 4
1292 * struct station_info - station information
1294 * Station information filled by driver for get_station() and dump_station.
1296 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1297 * indicate the relevant values in this struct for them
1298 * @connected_time: time(in secs) since a station is last connected
1299 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1300 * @rx_bytes: bytes (size of MPDUs) received from this station
1301 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1302 * @llid: mesh local link id
1303 * @plid: mesh peer link id
1304 * @plink_state: mesh peer link state
1305 * @signal: The signal strength, type depends on the wiphy's signal_type.
1306 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1307 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1308 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1309 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1310 * @chain_signal: per-chain signal strength of last received packet in dBm
1311 * @chain_signal_avg: per-chain signal strength average in dBm
1312 * @txrate: current unicast bitrate from this station
1313 * @rxrate: current unicast bitrate to this station
1314 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1315 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1316 * @tx_retries: cumulative retry counts (MPDUs)
1317 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1318 * @rx_dropped_misc: Dropped for un-specified reason.
1319 * @bss_param: current BSS parameters
1320 * @generation: generation number for nl80211 dumps.
1321 * This number should increase every time the list of stations
1322 * changes, i.e. when a station is added or removed, so that
1323 * userspace can tell whether it got a consistent snapshot.
1324 * @assoc_req_ies: IEs from (Re)Association Request.
1325 * This is used only when in AP mode with drivers that do not use
1326 * user space MLME/SME implementation. The information is provided for
1327 * the cfg80211_new_sta() calls to notify user space of the IEs.
1328 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1329 * @sta_flags: station flags mask & values
1330 * @beacon_loss_count: Number of times beacon loss event has triggered.
1331 * @t_offset: Time offset of the station relative to this host.
1332 * @local_pm: local mesh STA power save mode
1333 * @peer_pm: peer mesh STA power save mode
1334 * @nonpeer_pm: non-peer mesh STA power save mode
1335 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1336 * towards this station.
1337 * @rx_beacon: number of beacons received from this peer
1338 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1340 * @connected_to_gate: true if mesh STA has a path to mesh gate
1341 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1342 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1343 * @airtime_weight: current airtime scheduling weight
1344 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1345 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1346 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1347 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1348 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1350 * @rx_mpdu_count: number of MPDUs received from this station
1351 * @fcs_err_count: number of packets (MPDUs) received from this station with
1352 * an FCS error. This counter should be incremented only when TA of the
1353 * received packet with an FCS error matches the peer MAC address.
1354 * @airtime_link_metric: mesh airtime link metric.
1356 struct station_info {
1369 s8 chain_signal[IEEE80211_MAX_CHAINS];
1370 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1372 struct rate_info txrate;
1373 struct rate_info rxrate;
1378 u32 rx_dropped_misc;
1379 struct sta_bss_parameters bss_param;
1380 struct nl80211_sta_flag_update sta_flags;
1384 const u8 *assoc_req_ies;
1385 size_t assoc_req_ies_len;
1387 u32 beacon_loss_count;
1389 enum nl80211_mesh_power_mode local_pm;
1390 enum nl80211_mesh_power_mode peer_pm;
1391 enum nl80211_mesh_power_mode nonpeer_pm;
1393 u32 expected_throughput;
1398 u8 rx_beacon_signal_avg;
1399 u8 connected_to_gate;
1401 struct cfg80211_tid_stats *pertid;
1410 u32 airtime_link_metric;
1413 #if IS_ENABLED(CONFIG_CFG80211)
1415 * cfg80211_get_station - retrieve information about a given station
1416 * @dev: the device where the station is supposed to be connected to
1417 * @mac_addr: the mac address of the station of interest
1418 * @sinfo: pointer to the structure to fill with the information
1420 * Returns 0 on success and sinfo is filled with the available information
1421 * otherwise returns a negative error code and the content of sinfo has to be
1422 * considered undefined.
1424 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1425 struct station_info *sinfo);
1427 static inline int cfg80211_get_station(struct net_device *dev,
1429 struct station_info *sinfo)
1436 * enum monitor_flags - monitor flags
1438 * Monitor interface configuration flags. Note that these must be the bits
1439 * according to the nl80211 flags.
1441 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1442 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1443 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1444 * @MONITOR_FLAG_CONTROL: pass control frames
1445 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1446 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1447 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1449 enum monitor_flags {
1450 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1451 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1452 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1453 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1454 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1455 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1456 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1460 * enum mpath_info_flags - mesh path information flags
1462 * Used by the driver to indicate which info in &struct mpath_info it has filled
1463 * in during get_station() or dump_station().
1465 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1466 * @MPATH_INFO_SN: @sn filled
1467 * @MPATH_INFO_METRIC: @metric filled
1468 * @MPATH_INFO_EXPTIME: @exptime filled
1469 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1470 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1471 * @MPATH_INFO_FLAGS: @flags filled
1472 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1473 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1475 enum mpath_info_flags {
1476 MPATH_INFO_FRAME_QLEN = BIT(0),
1477 MPATH_INFO_SN = BIT(1),
1478 MPATH_INFO_METRIC = BIT(2),
1479 MPATH_INFO_EXPTIME = BIT(3),
1480 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1481 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1482 MPATH_INFO_FLAGS = BIT(6),
1483 MPATH_INFO_HOP_COUNT = BIT(7),
1484 MPATH_INFO_PATH_CHANGE = BIT(8),
1488 * struct mpath_info - mesh path information
1490 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1492 * @filled: bitfield of flags from &enum mpath_info_flags
1493 * @frame_qlen: number of queued frames for this destination
1494 * @sn: target sequence number
1495 * @metric: metric (cost) of this mesh path
1496 * @exptime: expiration time for the mesh path from now, in msecs
1497 * @flags: mesh path flags
1498 * @discovery_timeout: total mesh path discovery timeout, in msecs
1499 * @discovery_retries: mesh path discovery retries
1500 * @generation: generation number for nl80211 dumps.
1501 * This number should increase every time the list of mesh paths
1502 * changes, i.e. when a station is added or removed, so that
1503 * userspace can tell whether it got a consistent snapshot.
1504 * @hop_count: hops to destination
1505 * @path_change_count: total number of path changes to destination
1513 u32 discovery_timeout;
1514 u8 discovery_retries;
1517 u32 path_change_count;
1523 * struct bss_parameters - BSS parameters
1525 * Used to change BSS parameters (mainly for AP mode).
1527 * @use_cts_prot: Whether to use CTS protection
1528 * (0 = no, 1 = yes, -1 = do not change)
1529 * @use_short_preamble: Whether the use of short preambles is allowed
1530 * (0 = no, 1 = yes, -1 = do not change)
1531 * @use_short_slot_time: Whether the use of short slot time is allowed
1532 * (0 = no, 1 = yes, -1 = do not change)
1533 * @basic_rates: basic rates in IEEE 802.11 format
1534 * (or NULL for no change)
1535 * @basic_rates_len: number of basic rates
1536 * @ap_isolate: do not forward packets between connected stations
1537 * @ht_opmode: HT Operation mode
1538 * (u16 = opmode, -1 = do not change)
1539 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1540 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1542 struct bss_parameters {
1544 int use_short_preamble;
1545 int use_short_slot_time;
1546 const u8 *basic_rates;
1550 s8 p2p_ctwindow, p2p_opp_ps;
1554 * struct mesh_config - 802.11s mesh configuration
1556 * These parameters can be changed while the mesh is active.
1558 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1559 * by the Mesh Peering Open message
1560 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1561 * used by the Mesh Peering Open message
1562 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1563 * the mesh peering management to close a mesh peering
1564 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1566 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1567 * be sent to establish a new peer link instance in a mesh
1568 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1569 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1571 * @auto_open_plinks: whether we should automatically open peer links when we
1572 * detect compatible mesh peers
1573 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1574 * synchronize to for 11s default synchronization method
1575 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1576 * that an originator mesh STA can send to a particular path target
1577 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1578 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1579 * a path discovery in milliseconds
1580 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1581 * receiving a PREQ shall consider the forwarding information from the
1582 * root to be valid. (TU = time unit)
1583 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1584 * which a mesh STA can send only one action frame containing a PREQ
1586 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1587 * which a mesh STA can send only one Action frame containing a PERR
1589 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1590 * it takes for an HWMP information element to propagate across the mesh
1591 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1592 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1593 * announcements are transmitted
1594 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1595 * station has access to a broader network beyond the MBSS. (This is
1596 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1597 * only means that the station will announce others it's a mesh gate, but
1598 * not necessarily using the gate announcement protocol. Still keeping the
1599 * same nomenclature to be in sync with the spec)
1600 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1601 * entity (default is TRUE - forwarding entity)
1602 * @rssi_threshold: the threshold for average signal strength of candidate
1603 * station to establish a peer link
1604 * @ht_opmode: mesh HT protection mode
1606 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1607 * receiving a proactive PREQ shall consider the forwarding information to
1608 * the root mesh STA to be valid.
1610 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1611 * PREQs are transmitted.
1612 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1613 * during which a mesh STA can send only one Action frame containing
1614 * a PREQ element for root path confirmation.
1615 * @power_mode: The default mesh power save mode which will be the initial
1616 * setting for new peer links.
1617 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1618 * after transmitting its beacon.
1619 * @plink_timeout: If no tx activity is seen from a STA we've established
1620 * peering with for longer than this time (in seconds), then remove it
1621 * from the STA's list of peers. Default is 30 minutes.
1622 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1623 * connected to a mesh gate in mesh formation info. If false, the
1624 * value in mesh formation is determined by the presence of root paths
1625 * in the mesh path table
1627 struct mesh_config {
1628 u16 dot11MeshRetryTimeout;
1629 u16 dot11MeshConfirmTimeout;
1630 u16 dot11MeshHoldingTimeout;
1631 u16 dot11MeshMaxPeerLinks;
1632 u8 dot11MeshMaxRetries;
1635 bool auto_open_plinks;
1636 u32 dot11MeshNbrOffsetMaxNeighbor;
1637 u8 dot11MeshHWMPmaxPREQretries;
1638 u32 path_refresh_time;
1639 u16 min_discovery_timeout;
1640 u32 dot11MeshHWMPactivePathTimeout;
1641 u16 dot11MeshHWMPpreqMinInterval;
1642 u16 dot11MeshHWMPperrMinInterval;
1643 u16 dot11MeshHWMPnetDiameterTraversalTime;
1644 u8 dot11MeshHWMPRootMode;
1645 bool dot11MeshConnectedToMeshGate;
1646 u16 dot11MeshHWMPRannInterval;
1647 bool dot11MeshGateAnnouncementProtocol;
1648 bool dot11MeshForwarding;
1651 u32 dot11MeshHWMPactivePathToRootTimeout;
1652 u16 dot11MeshHWMProotInterval;
1653 u16 dot11MeshHWMPconfirmationInterval;
1654 enum nl80211_mesh_power_mode power_mode;
1655 u16 dot11MeshAwakeWindowDuration;
1660 * struct mesh_setup - 802.11s mesh setup configuration
1661 * @chandef: defines the channel to use
1662 * @mesh_id: the mesh ID
1663 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1664 * @sync_method: which synchronization method to use
1665 * @path_sel_proto: which path selection protocol to use
1666 * @path_metric: which metric to use
1667 * @auth_id: which authentication method this mesh is using
1668 * @ie: vendor information elements (optional)
1669 * @ie_len: length of vendor information elements
1670 * @is_authenticated: this mesh requires authentication
1671 * @is_secure: this mesh uses security
1672 * @user_mpm: userspace handles all MPM functions
1673 * @dtim_period: DTIM period to use
1674 * @beacon_interval: beacon interval to use
1675 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1676 * @basic_rates: basic rates to use when creating the mesh
1677 * @beacon_rate: bitrate to be used for beacons
1678 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1679 * changes the channel when a radar is detected. This is required
1680 * to operate on DFS channels.
1681 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1682 * port frames over NL80211 instead of the network interface.
1684 * These parameters are fixed when the mesh is created.
1687 struct cfg80211_chan_def chandef;
1696 bool is_authenticated;
1700 u16 beacon_interval;
1701 int mcast_rate[NUM_NL80211_BANDS];
1703 struct cfg80211_bitrate_mask beacon_rate;
1704 bool userspace_handles_dfs;
1705 bool control_port_over_nl80211;
1709 * struct ocb_setup - 802.11p OCB mode setup configuration
1710 * @chandef: defines the channel to use
1712 * These parameters are fixed when connecting to the network
1715 struct cfg80211_chan_def chandef;
1719 * struct ieee80211_txq_params - TX queue parameters
1720 * @ac: AC identifier
1721 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1722 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1724 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1726 * @aifs: Arbitration interframe space [0..255]
1728 struct ieee80211_txq_params {
1737 * DOC: Scanning and BSS list handling
1739 * The scanning process itself is fairly simple, but cfg80211 offers quite
1740 * a bit of helper functionality. To start a scan, the scan operation will
1741 * be invoked with a scan definition. This scan definition contains the
1742 * channels to scan, and the SSIDs to send probe requests for (including the
1743 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1744 * probe. Additionally, a scan request may contain extra information elements
1745 * that should be added to the probe request. The IEs are guaranteed to be
1746 * well-formed, and will not exceed the maximum length the driver advertised
1747 * in the wiphy structure.
1749 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1750 * it is responsible for maintaining the BSS list; the driver should not
1751 * maintain a list itself. For this notification, various functions exist.
1753 * Since drivers do not maintain a BSS list, there are also a number of
1754 * functions to search for a BSS and obtain information about it from the
1755 * BSS structure cfg80211 maintains. The BSS list is also made available
1760 * struct cfg80211_ssid - SSID description
1762 * @ssid_len: length of the ssid
1764 struct cfg80211_ssid {
1765 u8 ssid[IEEE80211_MAX_SSID_LEN];
1770 * struct cfg80211_scan_info - information about completed scan
1771 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1772 * wireless device that requested the scan is connected to. If this
1773 * information is not available, this field is left zero.
1774 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1775 * @aborted: set to true if the scan was aborted for any reason,
1776 * userspace will be notified of that
1778 struct cfg80211_scan_info {
1780 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1785 * struct cfg80211_scan_request - scan request description
1787 * @ssids: SSIDs to scan for (active scan only)
1788 * @n_ssids: number of SSIDs
1789 * @channels: channels to scan on.
1790 * @n_channels: total number of channels to scan
1791 * @scan_width: channel width for scanning
1792 * @ie: optional information element(s) to add into Probe Request or %NULL
1793 * @ie_len: length of ie in octets
1794 * @duration: how long to listen on each channel, in TUs. If
1795 * %duration_mandatory is not set, this is the maximum dwell time and
1796 * the actual dwell time may be shorter.
1797 * @duration_mandatory: if set, the scan duration must be as specified by the
1799 * @flags: bit field of flags controlling operation
1800 * @rates: bitmap of rates to advertise for each band
1801 * @wiphy: the wiphy this was for
1802 * @scan_start: time (in jiffies) when the scan started
1803 * @wdev: the wireless device to scan for
1804 * @info: (internal) information about completed scan
1805 * @notified: (internal) scan request was notified as done or aborted
1806 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1807 * @mac_addr: MAC address used with randomisation
1808 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1809 * are 0 in the mask should be randomised, bits that are 1 should
1810 * be taken from the @mac_addr
1811 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1813 struct cfg80211_scan_request {
1814 struct cfg80211_ssid *ssids;
1817 enum nl80211_bss_scan_width scan_width;
1821 bool duration_mandatory;
1824 u32 rates[NUM_NL80211_BANDS];
1826 struct wireless_dev *wdev;
1828 u8 mac_addr[ETH_ALEN] __aligned(2);
1829 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1830 u8 bssid[ETH_ALEN] __aligned(2);
1833 struct wiphy *wiphy;
1834 unsigned long scan_start;
1835 struct cfg80211_scan_info info;
1840 struct ieee80211_channel *channels[0];
1843 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1847 get_random_bytes(buf, ETH_ALEN);
1848 for (i = 0; i < ETH_ALEN; i++) {
1850 buf[i] |= addr[i] & mask[i];
1855 * struct cfg80211_match_set - sets of attributes to match
1857 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1858 * or no match (RSSI only)
1859 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1860 * or no match (RSSI only)
1861 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1862 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
1863 * for filtering out scan results received. Drivers advertize this support
1864 * of band specific rssi based filtering through the feature capability
1865 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
1866 * specific rssi thresholds take precedence over rssi_thold, if specified.
1867 * If not specified for any band, it will be assigned with rssi_thold of
1868 * corresponding matchset.
1870 struct cfg80211_match_set {
1871 struct cfg80211_ssid ssid;
1874 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
1878 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1880 * @interval: interval between scheduled scan iterations. In seconds.
1881 * @iterations: number of scan iterations in this scan plan. Zero means
1883 * The last scan plan will always have this parameter set to zero,
1884 * all other scan plans will have a finite number of iterations.
1886 struct cfg80211_sched_scan_plan {
1892 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1894 * @band: band of BSS which should match for RSSI level adjustment.
1895 * @delta: value of RSSI level adjustment.
1897 struct cfg80211_bss_select_adjust {
1898 enum nl80211_band band;
1903 * struct cfg80211_sched_scan_request - scheduled scan request description
1905 * @reqid: identifies this request.
1906 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1907 * @n_ssids: number of SSIDs
1908 * @n_channels: total number of channels to scan
1909 * @scan_width: channel width for scanning
1910 * @ie: optional information element(s) to add into Probe Request or %NULL
1911 * @ie_len: length of ie in octets
1912 * @flags: bit field of flags controlling operation
1913 * @match_sets: sets of parameters to be matched for a scan result
1914 * entry to be considered valid and to be passed to the host
1915 * (others are filtered out).
1916 * If ommited, all results are passed.
1917 * @n_match_sets: number of match sets
1918 * @report_results: indicates that results were reported for this request
1919 * @wiphy: the wiphy this was for
1920 * @dev: the interface
1921 * @scan_start: start time of the scheduled scan
1922 * @channels: channels to scan
1923 * @min_rssi_thold: for drivers only supporting a single threshold, this
1924 * contains the minimum over all matchsets
1925 * @mac_addr: MAC address used with randomisation
1926 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1927 * are 0 in the mask should be randomised, bits that are 1 should
1928 * be taken from the @mac_addr
1929 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1930 * index must be executed first.
1931 * @n_scan_plans: number of scan plans, at least 1.
1932 * @rcu_head: RCU callback used to free the struct
1933 * @owner_nlportid: netlink portid of owner (if this should is a request
1934 * owned by a particular socket)
1935 * @nl_owner_dead: netlink owner socket was closed - this request be freed
1936 * @list: for keeping list of requests.
1937 * @delay: delay in seconds to use before starting the first scan
1938 * cycle. The driver may ignore this parameter and start
1939 * immediately (or at any other time), if this feature is not
1941 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
1942 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
1943 * reporting in connected state to cases where a matching BSS is determined
1944 * to have better or slightly worse RSSI than the current connected BSS.
1945 * The relative RSSI threshold values are ignored in disconnected state.
1946 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
1947 * to the specified band while deciding whether a better BSS is reported
1948 * using @relative_rssi. If delta is a negative number, the BSSs that
1949 * belong to the specified band will be penalized by delta dB in relative
1952 struct cfg80211_sched_scan_request {
1954 struct cfg80211_ssid *ssids;
1957 enum nl80211_bss_scan_width scan_width;
1961 struct cfg80211_match_set *match_sets;
1965 struct cfg80211_sched_scan_plan *scan_plans;
1968 u8 mac_addr[ETH_ALEN] __aligned(2);
1969 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1971 bool relative_rssi_set;
1973 struct cfg80211_bss_select_adjust rssi_adjust;
1976 struct wiphy *wiphy;
1977 struct net_device *dev;
1978 unsigned long scan_start;
1979 bool report_results;
1980 struct rcu_head rcu_head;
1983 struct list_head list;
1986 struct ieee80211_channel *channels[0];
1990 * enum cfg80211_signal_type - signal type
1992 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1993 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1994 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1996 enum cfg80211_signal_type {
1997 CFG80211_SIGNAL_TYPE_NONE,
1998 CFG80211_SIGNAL_TYPE_MBM,
1999 CFG80211_SIGNAL_TYPE_UNSPEC,
2003 * struct cfg80211_inform_bss - BSS inform data
2004 * @chan: channel the frame was received on
2005 * @scan_width: scan width that was used
2006 * @signal: signal strength value, according to the wiphy's
2008 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2009 * received; should match the time when the frame was actually
2010 * received by the device (not just by the host, in case it was
2011 * buffered on the device) and be accurate to about 10ms.
2012 * If the frame isn't buffered, just passing the return value of
2013 * ktime_get_boot_ns() is likely appropriate.
2014 * @parent_tsf: the time at the start of reception of the first octet of the
2015 * timestamp field of the frame. The time is the TSF of the BSS specified
2017 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2018 * the BSS that requested the scan in which the beacon/probe was received.
2019 * @chains: bitmask for filled values in @chain_signal.
2020 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2022 struct cfg80211_inform_bss {
2023 struct ieee80211_channel *chan;
2024 enum nl80211_bss_scan_width scan_width;
2028 u8 parent_bssid[ETH_ALEN] __aligned(2);
2030 s8 chain_signal[IEEE80211_MAX_CHAINS];
2034 * struct cfg80211_bss_ies - BSS entry IE data
2035 * @tsf: TSF contained in the frame that carried these IEs
2036 * @rcu_head: internal use, for freeing
2037 * @len: length of the IEs
2038 * @from_beacon: these IEs are known to come from a beacon
2041 struct cfg80211_bss_ies {
2043 struct rcu_head rcu_head;
2050 * struct cfg80211_bss - BSS description
2052 * This structure describes a BSS (which may also be a mesh network)
2053 * for use in scan results and similar.
2055 * @channel: channel this BSS is on
2056 * @scan_width: width of the control channel
2057 * @bssid: BSSID of the BSS
2058 * @beacon_interval: the beacon interval as from the frame
2059 * @capability: the capability field in host byte order
2060 * @ies: the information elements (Note that there is no guarantee that these
2061 * are well-formed!); this is a pointer to either the beacon_ies or
2062 * proberesp_ies depending on whether Probe Response frame has been
2063 * received. It is always non-%NULL.
2064 * @beacon_ies: the information elements from the last Beacon frame
2065 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2066 * own the beacon_ies, but they're just pointers to the ones from the
2067 * @hidden_beacon_bss struct)
2068 * @proberesp_ies: the information elements from the last Probe Response frame
2069 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2070 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2071 * that holds the beacon data. @beacon_ies is still valid, of course, and
2072 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2073 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2074 * non-transmitted one (multi-BSSID support)
2075 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2076 * (multi-BSSID support)
2077 * @signal: signal strength value (type depends on the wiphy's signal_type)
2078 * @chains: bitmask for filled values in @chain_signal.
2079 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2080 * @bssid_index: index in the multiple BSS set
2081 * @max_bssid_indicator: max number of members in the BSS set
2082 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2084 struct cfg80211_bss {
2085 struct ieee80211_channel *channel;
2086 enum nl80211_bss_scan_width scan_width;
2088 const struct cfg80211_bss_ies __rcu *ies;
2089 const struct cfg80211_bss_ies __rcu *beacon_ies;
2090 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2092 struct cfg80211_bss *hidden_beacon_bss;
2093 struct cfg80211_bss *transmitted_bss;
2094 struct list_head nontrans_list;
2098 u16 beacon_interval;
2103 s8 chain_signal[IEEE80211_MAX_CHAINS];
2106 u8 max_bssid_indicator;
2108 u8 priv[0] __aligned(sizeof(void *));
2112 * ieee80211_bss_get_elem - find element with given ID
2113 * @bss: the bss to search
2114 * @id: the element ID
2116 * Note that the return value is an RCU-protected pointer, so
2117 * rcu_read_lock() must be held when calling this function.
2118 * Return: %NULL if not found.
2120 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2123 * ieee80211_bss_get_ie - find IE with given ID
2124 * @bss: the bss to search
2125 * @id: the element ID
2127 * Note that the return value is an RCU-protected pointer, so
2128 * rcu_read_lock() must be held when calling this function.
2129 * Return: %NULL if not found.
2131 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2133 return (void *)ieee80211_bss_get_elem(bss, id);
2138 * struct cfg80211_auth_request - Authentication request data
2140 * This structure provides information needed to complete IEEE 802.11
2143 * @bss: The BSS to authenticate with, the callee must obtain a reference
2144 * to it if it needs to keep it.
2145 * @auth_type: Authentication type (algorithm)
2146 * @ie: Extra IEs to add to Authentication frame or %NULL
2147 * @ie_len: Length of ie buffer in octets
2148 * @key_len: length of WEP key for shared key authentication
2149 * @key_idx: index of WEP key for shared key authentication
2150 * @key: WEP key for shared key authentication
2151 * @auth_data: Fields and elements in Authentication frames. This contains
2152 * the authentication frame body (non-IE and IE data), excluding the
2153 * Authentication algorithm number, i.e., starting at the Authentication
2154 * transaction sequence number field.
2155 * @auth_data_len: Length of auth_data buffer in octets
2157 struct cfg80211_auth_request {
2158 struct cfg80211_bss *bss;
2161 enum nl80211_auth_type auth_type;
2163 u8 key_len, key_idx;
2164 const u8 *auth_data;
2165 size_t auth_data_len;
2169 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2171 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2172 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2173 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2174 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2175 * authentication capability. Drivers can offload authentication to
2176 * userspace if this flag is set. Only applicable for cfg80211_connect()
2177 * request (connect callback).
2179 enum cfg80211_assoc_req_flags {
2180 ASSOC_REQ_DISABLE_HT = BIT(0),
2181 ASSOC_REQ_DISABLE_VHT = BIT(1),
2182 ASSOC_REQ_USE_RRM = BIT(2),
2183 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2187 * struct cfg80211_assoc_request - (Re)Association request data
2189 * This structure provides information needed to complete IEEE 802.11
2191 * @bss: The BSS to associate with. If the call is successful the driver is
2192 * given a reference that it must give back to cfg80211_send_rx_assoc()
2193 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2194 * association requests while already associating must be rejected.
2195 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2196 * @ie_len: Length of ie buffer in octets
2197 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2198 * @crypto: crypto settings
2199 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2200 * to indicate a request to reassociate within the ESS instead of a request
2201 * do the initial association with the ESS. When included, this is set to
2202 * the BSSID of the current association, i.e., to the value that is
2203 * included in the Current AP address field of the Reassociation Request
2205 * @flags: See &enum cfg80211_assoc_req_flags
2206 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2207 * will be used in ht_capa. Un-supported values will be ignored.
2208 * @ht_capa_mask: The bits of ht_capa which are to be used.
2209 * @vht_capa: VHT capability override
2210 * @vht_capa_mask: VHT capability mask indicating which fields to use
2211 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2212 * %NULL if FILS is not used.
2213 * @fils_kek_len: Length of fils_kek in octets
2214 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2215 * Request/Response frame or %NULL if FILS is not used. This field starts
2216 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2218 struct cfg80211_assoc_request {
2219 struct cfg80211_bss *bss;
2220 const u8 *ie, *prev_bssid;
2222 struct cfg80211_crypto_settings crypto;
2225 struct ieee80211_ht_cap ht_capa;
2226 struct ieee80211_ht_cap ht_capa_mask;
2227 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2229 size_t fils_kek_len;
2230 const u8 *fils_nonces;
2234 * struct cfg80211_deauth_request - Deauthentication request data
2236 * This structure provides information needed to complete IEEE 802.11
2239 * @bssid: the BSSID of the BSS to deauthenticate from
2240 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2241 * @ie_len: Length of ie buffer in octets
2242 * @reason_code: The reason code for the deauthentication
2243 * @local_state_change: if set, change local state only and
2244 * do not set a deauth frame
2246 struct cfg80211_deauth_request {
2251 bool local_state_change;
2255 * struct cfg80211_disassoc_request - Disassociation request data
2257 * This structure provides information needed to complete IEEE 802.11
2260 * @bss: the BSS to disassociate from
2261 * @ie: Extra IEs to add to Disassociation frame or %NULL
2262 * @ie_len: Length of ie buffer in octets
2263 * @reason_code: The reason code for the disassociation
2264 * @local_state_change: This is a request for a local state only, i.e., no
2265 * Disassociation frame is to be transmitted.
2267 struct cfg80211_disassoc_request {
2268 struct cfg80211_bss *bss;
2272 bool local_state_change;
2276 * struct cfg80211_ibss_params - IBSS parameters
2278 * This structure defines the IBSS parameters for the join_ibss()
2281 * @ssid: The SSID, will always be non-null.
2282 * @ssid_len: The length of the SSID, will always be non-zero.
2283 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2284 * search for IBSSs with a different BSSID.
2285 * @chandef: defines the channel to use if no other IBSS to join can be found
2286 * @channel_fixed: The channel should be fixed -- do not search for
2287 * IBSSs to join on other channels.
2288 * @ie: information element(s) to include in the beacon
2289 * @ie_len: length of that
2290 * @beacon_interval: beacon interval to use
2291 * @privacy: this is a protected network, keys will be configured
2293 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2294 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2295 * required to assume that the port is unauthorized until authorized by
2296 * user space. Otherwise, port is marked authorized by default.
2297 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2298 * port frames over NL80211 instead of the network interface.
2299 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2300 * changes the channel when a radar is detected. This is required
2301 * to operate on DFS channels.
2302 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2303 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2304 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2305 * will be used in ht_capa. Un-supported values will be ignored.
2306 * @ht_capa_mask: The bits of ht_capa which are to be used.
2307 * @wep_keys: static WEP keys, if not NULL points to an array of
2308 * CFG80211_MAX_WEP_KEYS WEP keys
2309 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2311 struct cfg80211_ibss_params {
2314 struct cfg80211_chan_def chandef;
2316 u8 ssid_len, ie_len;
2317 u16 beacon_interval;
2322 bool control_port_over_nl80211;
2323 bool userspace_handles_dfs;
2324 int mcast_rate[NUM_NL80211_BANDS];
2325 struct ieee80211_ht_cap ht_capa;
2326 struct ieee80211_ht_cap ht_capa_mask;
2327 struct key_params *wep_keys;
2332 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2334 * @behaviour: requested BSS selection behaviour.
2335 * @param: parameters for requestion behaviour.
2336 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2337 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2339 struct cfg80211_bss_selection {
2340 enum nl80211_bss_select_attr behaviour;
2342 enum nl80211_band band_pref;
2343 struct cfg80211_bss_select_adjust adjust;
2348 * struct cfg80211_connect_params - Connection parameters
2350 * This structure provides information needed to complete IEEE 802.11
2351 * authentication and association.
2353 * @channel: The channel to use or %NULL if not specified (auto-select based
2355 * @channel_hint: The channel of the recommended BSS for initial connection or
2356 * %NULL if not specified
2357 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2359 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2360 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2361 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2364 * @ssid_len: Length of ssid in octets
2365 * @auth_type: Authentication type (algorithm)
2366 * @ie: IEs for association request
2367 * @ie_len: Length of assoc_ie in octets
2368 * @privacy: indicates whether privacy-enabled APs should be used
2369 * @mfp: indicate whether management frame protection is used
2370 * @crypto: crypto settings
2371 * @key_len: length of WEP key for shared key authentication
2372 * @key_idx: index of WEP key for shared key authentication
2373 * @key: WEP key for shared key authentication
2374 * @flags: See &enum cfg80211_assoc_req_flags
2375 * @bg_scan_period: Background scan period in seconds
2376 * or -1 to indicate that default value is to be used.
2377 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2378 * will be used in ht_capa. Un-supported values will be ignored.
2379 * @ht_capa_mask: The bits of ht_capa which are to be used.
2380 * @vht_capa: VHT Capability overrides
2381 * @vht_capa_mask: The bits of vht_capa which are to be used.
2382 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2384 * @bss_select: criteria to be used for BSS selection.
2385 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2386 * to indicate a request to reassociate within the ESS instead of a request
2387 * do the initial association with the ESS. When included, this is set to
2388 * the BSSID of the current association, i.e., to the value that is
2389 * included in the Current AP address field of the Reassociation Request
2391 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2392 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2394 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2395 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2396 * %NULL if not specified. This specifies the domain name of ER server and
2397 * is used to construct FILS wrapped data IE.
2398 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2399 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2400 * messages. This is also used to construct FILS wrapped data IE.
2401 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2402 * keys in FILS or %NULL if not specified.
2403 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2404 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2405 * offload of 4-way handshake.
2407 struct cfg80211_connect_params {
2408 struct ieee80211_channel *channel;
2409 struct ieee80211_channel *channel_hint;
2411 const u8 *bssid_hint;
2414 enum nl80211_auth_type auth_type;
2418 enum nl80211_mfp mfp;
2419 struct cfg80211_crypto_settings crypto;
2421 u8 key_len, key_idx;
2424 struct ieee80211_ht_cap ht_capa;
2425 struct ieee80211_ht_cap ht_capa_mask;
2426 struct ieee80211_vht_cap vht_capa;
2427 struct ieee80211_vht_cap vht_capa_mask;
2429 struct cfg80211_bss_selection bss_select;
2430 const u8 *prev_bssid;
2431 const u8 *fils_erp_username;
2432 size_t fils_erp_username_len;
2433 const u8 *fils_erp_realm;
2434 size_t fils_erp_realm_len;
2435 u16 fils_erp_next_seq_num;
2436 const u8 *fils_erp_rrk;
2437 size_t fils_erp_rrk_len;
2442 * enum cfg80211_connect_params_changed - Connection parameters being updated
2444 * This enum provides information of all connect parameters that
2445 * have to be updated as part of update_connect_params() call.
2447 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2448 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2449 * username, erp sequence number and rrk) are updated
2450 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2452 enum cfg80211_connect_params_changed {
2453 UPDATE_ASSOC_IES = BIT(0),
2454 UPDATE_FILS_ERP_INFO = BIT(1),
2455 UPDATE_AUTH_TYPE = BIT(2),
2459 * enum wiphy_params_flags - set_wiphy_params bitfield values
2460 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2461 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2462 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2463 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2464 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2465 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2466 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2467 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2468 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2470 enum wiphy_params_flags {
2471 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2472 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2473 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2474 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2475 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2476 WIPHY_PARAM_DYN_ACK = 1 << 5,
2477 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2478 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2479 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2482 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2485 * struct cfg80211_pmksa - PMK Security Association
2487 * This structure is passed to the set/del_pmksa() method for PMKSA
2490 * @bssid: The AP's BSSID (may be %NULL).
2491 * @pmkid: The identifier to refer a PMKSA.
2492 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2493 * derivation by a FILS STA. Otherwise, %NULL.
2494 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2495 * the hash algorithm used to generate this.
2496 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2497 * cache identifier (may be %NULL).
2498 * @ssid_len: Length of the @ssid in octets.
2499 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2500 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2503 struct cfg80211_pmksa {
2514 * struct cfg80211_pkt_pattern - packet pattern
2515 * @mask: bitmask where to match pattern and where to ignore bytes,
2516 * one bit per byte, in same format as nl80211
2517 * @pattern: bytes to match where bitmask is 1
2518 * @pattern_len: length of pattern (in bytes)
2519 * @pkt_offset: packet offset (in bytes)
2521 * Internal note: @mask and @pattern are allocated in one chunk of
2522 * memory, free @mask only!
2524 struct cfg80211_pkt_pattern {
2525 const u8 *mask, *pattern;
2531 * struct cfg80211_wowlan_tcp - TCP connection parameters
2533 * @sock: (internal) socket for source port allocation
2534 * @src: source IP address
2535 * @dst: destination IP address
2536 * @dst_mac: destination MAC address
2537 * @src_port: source port
2538 * @dst_port: destination port
2539 * @payload_len: data payload length
2540 * @payload: data payload buffer
2541 * @payload_seq: payload sequence stamping configuration
2542 * @data_interval: interval at which to send data packets
2543 * @wake_len: wakeup payload match length
2544 * @wake_data: wakeup payload match data
2545 * @wake_mask: wakeup payload match mask
2546 * @tokens_size: length of the tokens buffer
2547 * @payload_tok: payload token usage configuration
2549 struct cfg80211_wowlan_tcp {
2550 struct socket *sock;
2552 u16 src_port, dst_port;
2553 u8 dst_mac[ETH_ALEN];
2556 struct nl80211_wowlan_tcp_data_seq payload_seq;
2559 const u8 *wake_data, *wake_mask;
2561 /* must be last, variable member */
2562 struct nl80211_wowlan_tcp_data_token payload_tok;
2566 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2568 * This structure defines the enabled WoWLAN triggers for the device.
2569 * @any: wake up on any activity -- special trigger if device continues
2570 * operating as normal during suspend
2571 * @disconnect: wake up if getting disconnected
2572 * @magic_pkt: wake up on receiving magic packet
2573 * @patterns: wake up on receiving packet matching a pattern
2574 * @n_patterns: number of patterns
2575 * @gtk_rekey_failure: wake up on GTK rekey failure
2576 * @eap_identity_req: wake up on EAP identity request packet
2577 * @four_way_handshake: wake up on 4-way handshake
2578 * @rfkill_release: wake up when rfkill is released
2579 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2580 * NULL if not configured.
2581 * @nd_config: configuration for the scan to be used for net detect wake.
2583 struct cfg80211_wowlan {
2584 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2585 eap_identity_req, four_way_handshake,
2587 struct cfg80211_pkt_pattern *patterns;
2588 struct cfg80211_wowlan_tcp *tcp;
2590 struct cfg80211_sched_scan_request *nd_config;
2594 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2596 * This structure defines coalesce rule for the device.
2597 * @delay: maximum coalescing delay in msecs.
2598 * @condition: condition for packet coalescence.
2599 * see &enum nl80211_coalesce_condition.
2600 * @patterns: array of packet patterns
2601 * @n_patterns: number of patterns
2603 struct cfg80211_coalesce_rules {
2605 enum nl80211_coalesce_condition condition;
2606 struct cfg80211_pkt_pattern *patterns;
2611 * struct cfg80211_coalesce - Packet coalescing settings
2613 * This structure defines coalescing settings.
2614 * @rules: array of coalesce rules
2615 * @n_rules: number of rules
2617 struct cfg80211_coalesce {
2618 struct cfg80211_coalesce_rules *rules;
2623 * struct cfg80211_wowlan_nd_match - information about the match
2625 * @ssid: SSID of the match that triggered the wake up
2626 * @n_channels: Number of channels where the match occurred. This
2627 * value may be zero if the driver can't report the channels.
2628 * @channels: center frequencies of the channels where a match
2631 struct cfg80211_wowlan_nd_match {
2632 struct cfg80211_ssid ssid;
2638 * struct cfg80211_wowlan_nd_info - net detect wake up information
2640 * @n_matches: Number of match information instances provided in
2641 * @matches. This value may be zero if the driver can't provide
2642 * match information.
2643 * @matches: Array of pointers to matches containing information about
2644 * the matches that triggered the wake up.
2646 struct cfg80211_wowlan_nd_info {
2648 struct cfg80211_wowlan_nd_match *matches[];
2652 * struct cfg80211_wowlan_wakeup - wakeup report
2653 * @disconnect: woke up by getting disconnected
2654 * @magic_pkt: woke up by receiving magic packet
2655 * @gtk_rekey_failure: woke up by GTK rekey failure
2656 * @eap_identity_req: woke up by EAP identity request packet
2657 * @four_way_handshake: woke up by 4-way handshake
2658 * @rfkill_release: woke up by rfkill being released
2659 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2660 * @packet_present_len: copied wakeup packet data
2661 * @packet_len: original wakeup packet length
2662 * @packet: The packet causing the wakeup, if any.
2663 * @packet_80211: For pattern match, magic packet and other data
2664 * frame triggers an 802.3 frame should be reported, for
2665 * disconnect due to deauth 802.11 frame. This indicates which
2667 * @tcp_match: TCP wakeup packet received
2668 * @tcp_connlost: TCP connection lost or failed to establish
2669 * @tcp_nomoretokens: TCP data ran out of tokens
2670 * @net_detect: if not %NULL, woke up because of net detect
2672 struct cfg80211_wowlan_wakeup {
2673 bool disconnect, magic_pkt, gtk_rekey_failure,
2674 eap_identity_req, four_way_handshake,
2675 rfkill_release, packet_80211,
2676 tcp_match, tcp_connlost, tcp_nomoretokens;
2678 u32 packet_present_len, packet_len;
2680 struct cfg80211_wowlan_nd_info *net_detect;
2684 * struct cfg80211_gtk_rekey_data - rekey data
2685 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2686 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2687 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2689 struct cfg80211_gtk_rekey_data {
2690 const u8 *kek, *kck, *replay_ctr;
2694 * struct cfg80211_update_ft_ies_params - FT IE Information
2696 * This structure provides information needed to update the fast transition IE
2698 * @md: The Mobility Domain ID, 2 Octet value
2699 * @ie: Fast Transition IEs
2700 * @ie_len: Length of ft_ie in octets
2702 struct cfg80211_update_ft_ies_params {
2709 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2711 * This structure provides information needed to transmit a mgmt frame
2713 * @chan: channel to use
2714 * @offchan: indicates wether off channel operation is required
2715 * @wait: duration for ROC
2716 * @buf: buffer to transmit
2717 * @len: buffer length
2718 * @no_cck: don't use cck rates for this frame
2719 * @dont_wait_for_ack: tells the low level not to wait for an ack
2720 * @n_csa_offsets: length of csa_offsets array
2721 * @csa_offsets: array of all the csa offsets in the frame
2723 struct cfg80211_mgmt_tx_params {
2724 struct ieee80211_channel *chan;
2730 bool dont_wait_for_ack;
2732 const u16 *csa_offsets;
2736 * struct cfg80211_dscp_exception - DSCP exception
2738 * @dscp: DSCP value that does not adhere to the user priority range definition
2739 * @up: user priority value to which the corresponding DSCP value belongs
2741 struct cfg80211_dscp_exception {
2747 * struct cfg80211_dscp_range - DSCP range definition for user priority
2749 * @low: lowest DSCP value of this user priority range, inclusive
2750 * @high: highest DSCP value of this user priority range, inclusive
2752 struct cfg80211_dscp_range {
2757 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2758 #define IEEE80211_QOS_MAP_MAX_EX 21
2759 #define IEEE80211_QOS_MAP_LEN_MIN 16
2760 #define IEEE80211_QOS_MAP_LEN_MAX \
2761 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2764 * struct cfg80211_qos_map - QoS Map Information
2766 * This struct defines the Interworking QoS map setting for DSCP values
2768 * @num_des: number of DSCP exceptions (0..21)
2769 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2770 * the user priority DSCP range definition
2771 * @up: DSCP range definition for a particular user priority
2773 struct cfg80211_qos_map {
2775 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2776 struct cfg80211_dscp_range up[8];
2780 * struct cfg80211_nan_conf - NAN configuration
2782 * This struct defines NAN configuration parameters
2784 * @master_pref: master preference (1 - 255)
2785 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2786 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2787 * (i.e. BIT(NL80211_BAND_2GHZ)).
2789 struct cfg80211_nan_conf {
2795 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2798 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2799 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2801 enum cfg80211_nan_conf_changes {
2802 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2803 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2807 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2809 * @filter: the content of the filter
2810 * @len: the length of the filter
2812 struct cfg80211_nan_func_filter {
2818 * struct cfg80211_nan_func - a NAN function
2820 * @type: &enum nl80211_nan_function_type
2821 * @service_id: the service ID of the function
2822 * @publish_type: &nl80211_nan_publish_type
2823 * @close_range: if true, the range should be limited. Threshold is
2824 * implementation specific.
2825 * @publish_bcast: if true, the solicited publish should be broadcasted
2826 * @subscribe_active: if true, the subscribe is active
2827 * @followup_id: the instance ID for follow up
2828 * @followup_reqid: the requestor instance ID for follow up
2829 * @followup_dest: MAC address of the recipient of the follow up
2830 * @ttl: time to live counter in DW.
2831 * @serv_spec_info: Service Specific Info
2832 * @serv_spec_info_len: Service Specific Info length
2833 * @srf_include: if true, SRF is inclusive
2834 * @srf_bf: Bloom Filter
2835 * @srf_bf_len: Bloom Filter length
2836 * @srf_bf_idx: Bloom Filter index
2837 * @srf_macs: SRF MAC addresses
2838 * @srf_num_macs: number of MAC addresses in SRF
2839 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2840 * @tx_filters: filters that should be transmitted in the SDF.
2841 * @num_rx_filters: length of &rx_filters.
2842 * @num_tx_filters: length of &tx_filters.
2843 * @instance_id: driver allocated id of the function.
2844 * @cookie: unique NAN function identifier.
2846 struct cfg80211_nan_func {
2847 enum nl80211_nan_function_type type;
2848 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2852 bool subscribe_active;
2855 struct mac_address followup_dest;
2857 const u8 *serv_spec_info;
2858 u8 serv_spec_info_len;
2863 struct mac_address *srf_macs;
2865 struct cfg80211_nan_func_filter *rx_filters;
2866 struct cfg80211_nan_func_filter *tx_filters;
2874 * struct cfg80211_pmk_conf - PMK configuration
2876 * @aa: authenticator address
2877 * @pmk_len: PMK length in bytes.
2878 * @pmk: the PMK material
2879 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2880 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
2883 struct cfg80211_pmk_conf {
2887 const u8 *pmk_r0_name;
2891 * struct cfg80211_external_auth_params - Trigger External authentication.
2893 * Commonly used across the external auth request and event interfaces.
2895 * @action: action type / trigger for external authentication. Only significant
2896 * for the authentication request event interface (driver to user space).
2897 * @bssid: BSSID of the peer with which the authentication has
2898 * to happen. Used by both the authentication request event and
2899 * authentication response command interface.
2900 * @ssid: SSID of the AP. Used by both the authentication request event and
2901 * authentication response command interface.
2902 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
2903 * authentication request event interface.
2904 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
2905 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
2906 * the real status code for failures. Used only for the authentication
2907 * response command interface (user space to driver).
2908 * @pmkid: The identifier to refer a PMKSA.
2910 struct cfg80211_external_auth_params {
2911 enum nl80211_external_auth_action action;
2912 u8 bssid[ETH_ALEN] __aligned(2);
2913 struct cfg80211_ssid ssid;
2914 unsigned int key_mgmt_suite;
2920 * struct cfg80211_ftm_responder_stats - FTM responder statistics
2922 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
2923 * indicate the relevant values in this struct for them
2924 * @success_num: number of FTM sessions in which all frames were successfully
2926 * @partial_num: number of FTM sessions in which part of frames were
2927 * successfully answered
2928 * @failed_num: number of failed FTM sessions
2929 * @asap_num: number of ASAP FTM sessions
2930 * @non_asap_num: number of non-ASAP FTM sessions
2931 * @total_duration_ms: total sessions durations - gives an indication
2932 * of how much time the responder was busy
2933 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
2934 * initiators that didn't finish successfully the negotiation phase with
2936 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
2937 * for a new scheduling although it already has scheduled FTM slot
2938 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
2940 struct cfg80211_ftm_responder_stats {
2947 u64 total_duration_ms;
2948 u32 unknown_triggers_num;
2949 u32 reschedule_requests_num;
2950 u32 out_of_window_triggers_num;
2954 * struct cfg80211_pmsr_ftm_result - FTM result
2955 * @failure_reason: if this measurement failed (PMSR status is
2956 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
2957 * reason than just "failure"
2958 * @burst_index: if reporting partial results, this is the index
2959 * in [0 .. num_bursts-1] of the burst that's being reported
2960 * @num_ftmr_attempts: number of FTM request frames transmitted
2961 * @num_ftmr_successes: number of FTM request frames acked
2962 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
2963 * fill this to indicate in how many seconds a retry is deemed possible
2965 * @num_bursts_exp: actual number of bursts exponent negotiated
2966 * @burst_duration: actual burst duration negotiated
2967 * @ftms_per_burst: actual FTMs per burst negotiated
2968 * @lci_len: length of LCI information (if present)
2969 * @civicloc_len: length of civic location information (if present)
2970 * @lci: LCI data (may be %NULL)
2971 * @civicloc: civic location data (may be %NULL)
2972 * @rssi_avg: average RSSI over FTM action frames reported
2973 * @rssi_spread: spread of the RSSI over FTM action frames reported
2974 * @tx_rate: bitrate for transmitted FTM action frame response
2975 * @rx_rate: bitrate of received FTM action frame
2976 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
2977 * @rtt_variance: variance of RTTs measured (note that standard deviation is
2978 * the square root of the variance)
2979 * @rtt_spread: spread of the RTTs measured
2980 * @dist_avg: average of distances (mm) measured
2981 * (must have either this or @rtt_avg)
2982 * @dist_variance: variance of distances measured (see also @rtt_variance)
2983 * @dist_spread: spread of distances measured (see also @rtt_spread)
2984 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
2985 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
2986 * @rssi_avg_valid: @rssi_avg is valid
2987 * @rssi_spread_valid: @rssi_spread is valid
2988 * @tx_rate_valid: @tx_rate is valid
2989 * @rx_rate_valid: @rx_rate is valid
2990 * @rtt_avg_valid: @rtt_avg is valid
2991 * @rtt_variance_valid: @rtt_variance is valid
2992 * @rtt_spread_valid: @rtt_spread is valid
2993 * @dist_avg_valid: @dist_avg is valid
2994 * @dist_variance_valid: @dist_variance is valid
2995 * @dist_spread_valid: @dist_spread is valid
2997 struct cfg80211_pmsr_ftm_result {
3000 unsigned int lci_len;
3001 unsigned int civicloc_len;
3002 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3003 u32 num_ftmr_attempts, num_ftmr_successes;
3011 struct rate_info tx_rate, rx_rate;
3019 u16 num_ftmr_attempts_valid:1,
3020 num_ftmr_successes_valid:1,
3022 rssi_spread_valid:1,
3026 rtt_variance_valid:1,
3029 dist_variance_valid:1,
3030 dist_spread_valid:1;
3034 * struct cfg80211_pmsr_result - peer measurement result
3035 * @addr: address of the peer
3036 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3037 * measurement was made)
3038 * @ap_tsf: AP's TSF at measurement time
3039 * @status: status of the measurement
3040 * @final: if reporting partial results, mark this as the last one; if not
3041 * reporting partial results always set this flag
3042 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3043 * @type: type of the measurement reported, note that we only support reporting
3044 * one type at a time, but you can report multiple results separately and
3045 * they're all aggregated for userspace.
3047 struct cfg80211_pmsr_result {
3048 u64 host_time, ap_tsf;
3049 enum nl80211_peer_measurement_status status;
3056 enum nl80211_peer_measurement_type type;
3059 struct cfg80211_pmsr_ftm_result ftm;
3064 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3065 * @requested: indicates FTM is requested
3066 * @preamble: frame preamble to use
3067 * @burst_period: burst period to use
3068 * @asap: indicates to use ASAP mode
3069 * @num_bursts_exp: number of bursts exponent
3070 * @burst_duration: burst duration
3071 * @ftms_per_burst: number of FTMs per burst
3072 * @ftmr_retries: number of retries for FTM request
3073 * @request_lci: request LCI information
3074 * @request_civicloc: request civic location information
3076 * See also nl80211 for the respective attribute documentation.
3078 struct cfg80211_pmsr_ftm_request_peer {
3079 enum nl80211_preamble preamble;
3092 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3093 * @addr: MAC address
3094 * @chandef: channel to use
3095 * @report_ap_tsf: report the associated AP's TSF
3096 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3098 struct cfg80211_pmsr_request_peer {
3100 struct cfg80211_chan_def chandef;
3102 struct cfg80211_pmsr_ftm_request_peer ftm;
3106 * struct cfg80211_pmsr_request - peer measurement request
3107 * @cookie: cookie, set by cfg80211
3108 * @nl_portid: netlink portid - used by cfg80211
3109 * @drv_data: driver data for this request, if required for aborting,
3110 * not otherwise freed or anything by cfg80211
3111 * @mac_addr: MAC address used for (randomised) request
3112 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3113 * are 0 in the mask should be randomised, bits that are 1 should
3114 * be taken from the @mac_addr
3115 * @list: used by cfg80211 to hold on to the request
3116 * @timeout: timeout (in milliseconds) for the whole operation, if
3117 * zero it means there's no timeout
3118 * @n_peers: number of peers to do measurements with
3119 * @peers: per-peer measurement request data
3121 struct cfg80211_pmsr_request {
3129 u8 mac_addr[ETH_ALEN] __aligned(2);
3130 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3132 struct list_head list;
3134 struct cfg80211_pmsr_request_peer peers[];
3138 * struct cfg80211_update_owe_info - OWE Information
3140 * This structure provides information needed for the drivers to offload OWE
3141 * (Opportunistic Wireless Encryption) processing to the user space.
3143 * Commonly used across update_owe_info request and event interfaces.
3145 * @peer: MAC address of the peer device for which the OWE processing
3147 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3148 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3149 * cannot give you the real status code for failures. Used only for
3150 * OWE update request command interface (user space to driver).
3151 * @ie: IEs obtained from the peer or constructed by the user space. These are
3152 * the IEs of the remote peer in the event from the host driver and
3153 * the constructed IEs by the user space in the request interface.
3154 * @ie_len: Length of IEs in octets.
3156 struct cfg80211_update_owe_info {
3157 u8 peer[ETH_ALEN] __aligned(2);
3164 * struct cfg80211_ops - backend description for wireless configuration
3166 * This struct is registered by fullmac card drivers and/or wireless stacks
3167 * in order to handle configuration requests on their interfaces.
3169 * All callbacks except where otherwise noted should return 0
3170 * on success or a negative error code.
3172 * All operations are currently invoked under rtnl for consistency with the
3173 * wireless extensions but this is subject to reevaluation as soon as this
3174 * code is used more widely and we have a first user without wext.
3176 * @suspend: wiphy device needs to be suspended. The variable @wow will
3177 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3178 * configured for the device.
3179 * @resume: wiphy device needs to be resumed
3180 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3181 * to call device_set_wakeup_enable() to enable/disable wakeup from
3184 * @add_virtual_intf: create a new virtual interface with the given name,
3185 * must set the struct wireless_dev's iftype. Beware: You must create
3186 * the new netdev in the wiphy's network namespace! Returns the struct
3187 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3188 * also set the address member in the wdev.
3190 * @del_virtual_intf: remove the virtual interface
3192 * @change_virtual_intf: change type/configuration of virtual interface,
3193 * keep the struct wireless_dev's iftype updated.
3195 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3196 * when adding a group key.
3198 * @get_key: get information about the key with the given parameters.
3199 * @mac_addr will be %NULL when requesting information for a group
3200 * key. All pointers given to the @callback function need not be valid
3201 * after it returns. This function should return an error if it is
3202 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3204 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3205 * and @key_index, return -ENOENT if the key doesn't exist.
3207 * @set_default_key: set the default key on an interface
3209 * @set_default_mgmt_key: set the default management frame key on an interface
3211 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3213 * @start_ap: Start acting in AP mode defined by the parameters.
3214 * @change_beacon: Change the beacon parameters for an access point mode
3215 * interface. This should reject the call when AP mode wasn't started.
3216 * @stop_ap: Stop being an AP, including stopping beaconing.
3218 * @add_station: Add a new station.
3219 * @del_station: Remove a station
3220 * @change_station: Modify a given station. Note that flags changes are not much
3221 * validated in cfg80211, in particular the auth/assoc/authorized flags
3222 * might come to the driver in invalid combinations -- make sure to check
3223 * them, also against the existing state! Drivers must call
3224 * cfg80211_check_station_change() to validate the information.
3225 * @get_station: get station information for the station identified by @mac
3226 * @dump_station: dump station callback -- resume dump at index @idx
3228 * @add_mpath: add a fixed mesh path
3229 * @del_mpath: delete a given mesh path
3230 * @change_mpath: change a given mesh path
3231 * @get_mpath: get a mesh path for the given parameters
3232 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3233 * @get_mpp: get a mesh proxy path for the given parameters
3234 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3235 * @join_mesh: join the mesh network with the specified parameters
3236 * (invoked with the wireless_dev mutex held)
3237 * @leave_mesh: leave the current mesh network
3238 * (invoked with the wireless_dev mutex held)
3240 * @get_mesh_config: Get the current mesh configuration
3242 * @update_mesh_config: Update mesh parameters on a running mesh.
3243 * The mask is a bitfield which tells us which parameters to
3244 * set, and which to leave alone.
3246 * @change_bss: Modify parameters for a given BSS.
3248 * @set_txq_params: Set TX queue parameters
3250 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3251 * as it doesn't implement join_mesh and needs to set the channel to
3252 * join the mesh instead.
3254 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3255 * interfaces are active this callback should reject the configuration.
3256 * If no interfaces are active or the device is down, the channel should
3257 * be stored for when a monitor interface becomes active.
3259 * @scan: Request to do a scan. If returning zero, the scan request is given
3260 * the driver, and will be valid until passed to cfg80211_scan_done().
3261 * For scan results, call cfg80211_inform_bss(); you can call this outside
3262 * the scan/scan_done bracket too.
3263 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3264 * indicate the status of the scan through cfg80211_scan_done().
3266 * @auth: Request to authenticate with the specified peer
3267 * (invoked with the wireless_dev mutex held)
3268 * @assoc: Request to (re)associate with the specified peer
3269 * (invoked with the wireless_dev mutex held)
3270 * @deauth: Request to deauthenticate from the specified peer
3271 * (invoked with the wireless_dev mutex held)
3272 * @disassoc: Request to disassociate from the specified peer
3273 * (invoked with the wireless_dev mutex held)
3275 * @connect: Connect to the ESS with the specified parameters. When connected,
3276 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3277 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3278 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3279 * from the AP or cfg80211_connect_timeout() if no frame with status code
3281 * The driver is allowed to roam to other BSSes within the ESS when the
3282 * other BSS matches the connect parameters. When such roaming is initiated
3283 * by the driver, the driver is expected to verify that the target matches
3284 * the configured security parameters and to use Reassociation Request
3285 * frame instead of Association Request frame.
3286 * The connect function can also be used to request the driver to perform a
3287 * specific roam when connected to an ESS. In that case, the prev_bssid
3288 * parameter is set to the BSSID of the currently associated BSS as an
3289 * indication of requesting reassociation.
3290 * In both the driver-initiated and new connect() call initiated roaming
3291 * cases, the result of roaming is indicated with a call to
3292 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3293 * @update_connect_params: Update the connect parameters while connected to a
3294 * BSS. The updated parameters can be used by driver/firmware for
3295 * subsequent BSS selection (roaming) decisions and to form the
3296 * Authentication/(Re)Association Request frames. This call does not
3297 * request an immediate disassociation or reassociation with the current
3298 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3299 * changed are defined in &enum cfg80211_connect_params_changed.
3300 * (invoked with the wireless_dev mutex held)
3301 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3302 * connection is in progress. Once done, call cfg80211_disconnected() in
3303 * case connection was already established (invoked with the
3304 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3306 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3307 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3309 * (invoked with the wireless_dev mutex held)
3310 * @leave_ibss: Leave the IBSS.
3311 * (invoked with the wireless_dev mutex held)
3313 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3316 * @set_wiphy_params: Notify that wiphy parameters have changed;
3317 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3318 * have changed. The actual parameter values are available in
3319 * struct wiphy. If returning an error, no value should be changed.
3321 * @set_tx_power: set the transmit power according to the parameters,
3322 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3323 * wdev may be %NULL if power was set for the wiphy, and will
3324 * always be %NULL unless the driver supports per-vif TX power
3325 * (as advertised by the nl80211 feature flag.)
3326 * @get_tx_power: store the current TX power into the dbm variable;
3327 * return 0 if successful
3329 * @set_wds_peer: set the WDS peer for a WDS interface
3331 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3332 * functions to adjust rfkill hw state
3334 * @dump_survey: get site survey information.
3336 * @remain_on_channel: Request the driver to remain awake on the specified
3337 * channel for the specified duration to complete an off-channel
3338 * operation (e.g., public action frame exchange). When the driver is
3339 * ready on the requested channel, it must indicate this with an event
3340 * notification by calling cfg80211_ready_on_channel().
3341 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3342 * This allows the operation to be terminated prior to timeout based on
3343 * the duration value.
3344 * @mgmt_tx: Transmit a management frame.
3345 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3346 * frame on another channel
3348 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3349 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3350 * used by the function, but 0 and 1 must not be touched. Additionally,
3351 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3352 * dump and return to userspace with an error, so be careful. If any data
3353 * was passed in from userspace then the data/len arguments will be present
3354 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3356 * @set_bitrate_mask: set the bitrate mask configuration
3358 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3359 * devices running firmwares capable of generating the (re) association
3360 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3361 * @del_pmksa: Delete a cached PMKID.
3362 * @flush_pmksa: Flush all cached PMKIDs.
3363 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3364 * allows the driver to adjust the dynamic ps timeout value.
3365 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3366 * After configuration, the driver should (soon) send an event indicating
3367 * the current level is above/below the configured threshold; this may
3368 * need some care when the configuration is changed (without first being
3370 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3371 * connection quality monitor. An event is to be sent only when the
3372 * signal level is found to be outside the two values. The driver should
3373 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3374 * If it is provided then there's no point providing @set_cqm_rssi_config.
3375 * @set_cqm_txe_config: Configure connection quality monitor TX error
3377 * @sched_scan_start: Tell the driver to start a scheduled scan.
3378 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3379 * given request id. This call must stop the scheduled scan and be ready
3380 * for starting a new one before it returns, i.e. @sched_scan_start may be
3381 * called immediately after that again and should not fail in that case.
3382 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3383 * stop (when this method returns 0).
3385 * @mgmt_frame_register: Notify driver that a management frame type was
3386 * registered. The callback is allowed to sleep.
3388 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3389 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3390 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3391 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3393 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3395 * @tdls_mgmt: Transmit a TDLS management frame.
3396 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3398 * @probe_client: probe an associated client, must return a cookie that it
3399 * later passes to cfg80211_probe_status().
3401 * @set_noack_map: Set the NoAck Map for the TIDs.
3403 * @get_channel: Get the current operating channel for the virtual interface.
3404 * For monitor interfaces, it should return %NULL unless there's a single
3405 * current monitoring channel.
3407 * @start_p2p_device: Start the given P2P device.
3408 * @stop_p2p_device: Stop the given P2P device.
3410 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3411 * Parameters include ACL policy, an array of MAC address of stations
3412 * and the number of MAC addresses. If there is already a list in driver
3413 * this new list replaces the existing one. Driver has to clear its ACL
3414 * when number of MAC addresses entries is passed as 0. Drivers which
3415 * advertise the support for MAC based ACL have to implement this callback.
3417 * @start_radar_detection: Start radar detection in the driver.
3419 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3420 * driver. If the SME is in the driver/firmware, this information can be
3421 * used in building Authentication and Reassociation Request frames.
3423 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3424 * for a given duration (milliseconds). The protocol is provided so the
3425 * driver can take the most appropriate actions.
3426 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3427 * reliability. This operation can not fail.
3428 * @set_coalesce: Set coalesce parameters.
3430 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3431 * responsible for veryfing if the switch is possible. Since this is
3432 * inherently tricky driver may decide to disconnect an interface later
3433 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3434 * everything. It should do it's best to verify requests and reject them
3435 * as soon as possible.
3437 * @set_qos_map: Set QoS mapping information to the driver
3439 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3440 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3441 * changes during the lifetime of the BSS.
3443 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3444 * with the given parameters; action frame exchange has been handled by
3445 * userspace so this just has to modify the TX path to take the TS into
3447 * If the admitted time is 0 just validate the parameters to make sure
3448 * the session can be created at all; it is valid to just always return
3449 * success for that but that may result in inefficient behaviour (handshake
3450 * with the peer followed by immediate teardown when the addition is later
3452 * @del_tx_ts: remove an existing TX TS
3454 * @join_ocb: join the OCB network with the specified parameters
3455 * (invoked with the wireless_dev mutex held)
3456 * @leave_ocb: leave the current OCB network
3457 * (invoked with the wireless_dev mutex held)
3459 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3460 * is responsible for continually initiating channel-switching operations
3461 * and returning to the base channel for communication with the AP.
3462 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3463 * peers must be on the base channel when the call completes.
3464 * @start_nan: Start the NAN interface.
3465 * @stop_nan: Stop the NAN interface.
3466 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3467 * On success @nan_func ownership is transferred to the driver and
3468 * it may access it outside of the scope of this function. The driver
3469 * should free the @nan_func when no longer needed by calling
3470 * cfg80211_free_nan_func().
3471 * On success the driver should assign an instance_id in the
3472 * provided @nan_func.
3473 * @del_nan_func: Delete a NAN function.
3474 * @nan_change_conf: changes NAN configuration. The changed parameters must
3475 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3476 * All other parameters must be ignored.
3478 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3480 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3481 * function should return phy stats, and interface stats otherwise.
3483 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3484 * If not deleted through @del_pmk the PMK remains valid until disconnect
3485 * upon which the driver should clear it.
3486 * (invoked with the wireless_dev mutex held)
3487 * @del_pmk: delete the previously configured PMK for the given authenticator.
3488 * (invoked with the wireless_dev mutex held)
3490 * @external_auth: indicates result of offloaded authentication processing from
3493 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3494 * tells the driver that the frame should not be encrypted.
3496 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3497 * Statistics should be cumulative, currently no way to reset is provided.
3498 * @start_pmsr: start peer measurement (e.g. FTM)
3499 * @abort_pmsr: abort peer measurement
3501 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3502 * but offloading OWE processing to the user space will get the updated
3503 * DH IE through this interface.
3505 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3506 * and overrule HWMP path selection algorithm.
3508 struct cfg80211_ops {
3509 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3510 int (*resume)(struct wiphy *wiphy);
3511 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3513 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3515 unsigned char name_assign_type,
3516 enum nl80211_iftype type,
3517 struct vif_params *params);
3518 int (*del_virtual_intf)(struct wiphy *wiphy,
3519 struct wireless_dev *wdev);
3520 int (*change_virtual_intf)(struct wiphy *wiphy,
3521 struct net_device *dev,
3522 enum nl80211_iftype type,
3523 struct vif_params *params);
3525 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3526 u8 key_index, bool pairwise, const u8 *mac_addr,
3527 struct key_params *params);
3528 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3529 u8 key_index, bool pairwise, const u8 *mac_addr,
3531 void (*callback)(void *cookie, struct key_params*));
3532 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3533 u8 key_index, bool pairwise, const u8 *mac_addr);
3534 int (*set_default_key)(struct wiphy *wiphy,
3535 struct net_device *netdev,
3536 u8 key_index, bool unicast, bool multicast);
3537 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3538 struct net_device *netdev,
3541 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3542 struct cfg80211_ap_settings *settings);
3543 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3544 struct cfg80211_beacon_data *info);
3545 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3548 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3550 struct station_parameters *params);
3551 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3552 struct station_del_parameters *params);
3553 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3555 struct station_parameters *params);
3556 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3557 const u8 *mac, struct station_info *sinfo);
3558 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3559 int idx, u8 *mac, struct station_info *sinfo);
3561 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3562 const u8 *dst, const u8 *next_hop);
3563 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3565 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3566 const u8 *dst, const u8 *next_hop);
3567 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3568 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3569 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3570 int idx, u8 *dst, u8 *next_hop,
3571 struct mpath_info *pinfo);
3572 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3573 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3574 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3575 int idx, u8 *dst, u8 *mpp,
3576 struct mpath_info *pinfo);
3577 int (*get_mesh_config)(struct wiphy *wiphy,
3578 struct net_device *dev,
3579 struct mesh_config *conf);
3580 int (*update_mesh_config)(struct wiphy *wiphy,
3581 struct net_device *dev, u32 mask,
3582 const struct mesh_config *nconf);
3583 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3584 const struct mesh_config *conf,
3585 const struct mesh_setup *setup);
3586 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3588 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3589 struct ocb_setup *setup);
3590 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3592 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3593 struct bss_parameters *params);
3595 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3596 struct ieee80211_txq_params *params);
3598 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3599 struct net_device *dev,
3600 struct ieee80211_channel *chan);
3602 int (*set_monitor_channel)(struct wiphy *wiphy,
3603 struct cfg80211_chan_def *chandef);
3605 int (*scan)(struct wiphy *wiphy,
3606 struct cfg80211_scan_request *request);
3607 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3609 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
3610 struct cfg80211_auth_request *req);
3611 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3612 struct cfg80211_assoc_request *req);
3613 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3614 struct cfg80211_deauth_request *req);
3615 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3616 struct cfg80211_disassoc_request *req);
3618 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
3619 struct cfg80211_connect_params *sme);
3620 int (*update_connect_params)(struct wiphy *wiphy,
3621 struct net_device *dev,
3622 struct cfg80211_connect_params *sme,
3624 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3627 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3628 struct cfg80211_ibss_params *params);
3629 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3631 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3632 int rate[NUM_NL80211_BANDS]);
3634 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3636 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3637 enum nl80211_tx_power_setting type, int mbm);
3638 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3641 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3644 void (*rfkill_poll)(struct wiphy *wiphy);
3646 #ifdef CONFIG_NL80211_TESTMODE
3647 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3648 void *data, int len);
3649 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3650 struct netlink_callback *cb,
3651 void *data, int len);
3654 int (*set_bitrate_mask)(struct wiphy *wiphy,
3655 struct net_device *dev,
3657 const struct cfg80211_bitrate_mask *mask);
3659 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3660 int idx, struct survey_info *info);
3662 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3663 struct cfg80211_pmksa *pmksa);
3664 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3665 struct cfg80211_pmksa *pmksa);
3666 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3668 int (*remain_on_channel)(struct wiphy *wiphy,
3669 struct wireless_dev *wdev,
3670 struct ieee80211_channel *chan,
3671 unsigned int duration,
3673 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
3674 struct wireless_dev *wdev,
3677 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3678 struct cfg80211_mgmt_tx_params *params,
3680 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3681 struct wireless_dev *wdev,
3684 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3685 bool enabled, int timeout);
3687 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
3688 struct net_device *dev,
3689 s32 rssi_thold, u32 rssi_hyst);
3691 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3692 struct net_device *dev,
3693 s32 rssi_low, s32 rssi_high);
3695 int (*set_cqm_txe_config)(struct wiphy *wiphy,
3696 struct net_device *dev,
3697 u32 rate, u32 pkts, u32 intvl);
3699 void (*mgmt_frame_register)(struct wiphy *wiphy,
3700 struct wireless_dev *wdev,
3701 u16 frame_type, bool reg);
3703 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3704 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3706 int (*sched_scan_start)(struct wiphy *wiphy,
3707 struct net_device *dev,
3708 struct cfg80211_sched_scan_request *request);
3709 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3712 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3713 struct cfg80211_gtk_rekey_data *data);
3715 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3716 const u8 *peer, u8 action_code, u8 dialog_token,
3717 u16 status_code, u32 peer_capability,
3718 bool initiator, const u8 *buf, size_t len);
3719 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3720 const u8 *peer, enum nl80211_tdls_operation oper);
3722 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3723 const u8 *peer, u64 *cookie);
3725 int (*set_noack_map)(struct wiphy *wiphy,
3726 struct net_device *dev,
3729 int (*get_channel)(struct wiphy *wiphy,
3730 struct wireless_dev *wdev,
3731 struct cfg80211_chan_def *chandef);
3733 int (*start_p2p_device)(struct wiphy *wiphy,
3734 struct wireless_dev *wdev);
3735 void (*stop_p2p_device)(struct wiphy *wiphy,
3736 struct wireless_dev *wdev);
3738 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3739 const struct cfg80211_acl_data *params);
3741 int (*start_radar_detection)(struct wiphy *wiphy,
3742 struct net_device *dev,
3743 struct cfg80211_chan_def *chandef,
3745 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3746 struct cfg80211_update_ft_ies_params *ftie);
3747 int (*crit_proto_start)(struct wiphy *wiphy,
3748 struct wireless_dev *wdev,
3749 enum nl80211_crit_proto_id protocol,
3751 void (*crit_proto_stop)(struct wiphy *wiphy,
3752 struct wireless_dev *wdev);
3753 int (*set_coalesce)(struct wiphy *wiphy,
3754 struct cfg80211_coalesce *coalesce);
3756 int (*channel_switch)(struct wiphy *wiphy,
3757 struct net_device *dev,
3758 struct cfg80211_csa_settings *params);
3760 int (*set_qos_map)(struct wiphy *wiphy,
3761 struct net_device *dev,
3762 struct cfg80211_qos_map *qos_map);
3764 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3765 struct cfg80211_chan_def *chandef);
3767 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3768 u8 tsid, const u8 *peer, u8 user_prio,
3770 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3771 u8 tsid, const u8 *peer);
3773 int (*tdls_channel_switch)(struct wiphy *wiphy,
3774 struct net_device *dev,
3775 const u8 *addr, u8 oper_class,
3776 struct cfg80211_chan_def *chandef);
3777 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3778 struct net_device *dev,
3780 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3781 struct cfg80211_nan_conf *conf);
3782 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3783 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3784 struct cfg80211_nan_func *nan_func);
3785 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3787 int (*nan_change_conf)(struct wiphy *wiphy,
3788 struct wireless_dev *wdev,
3789 struct cfg80211_nan_conf *conf,
3792 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
3793 struct net_device *dev,
3794 const bool enabled);
3796 int (*get_txq_stats)(struct wiphy *wiphy,
3797 struct wireless_dev *wdev,
3798 struct cfg80211_txq_stats *txqstats);
3800 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3801 const struct cfg80211_pmk_conf *conf);
3802 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3804 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3805 struct cfg80211_external_auth_params *params);
3807 int (*tx_control_port)(struct wiphy *wiphy,
3808 struct net_device *dev,
3809 const u8 *buf, size_t len,
3810 const u8 *dest, const __be16 proto,
3811 const bool noencrypt);
3813 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
3814 struct net_device *dev,
3815 struct cfg80211_ftm_responder_stats *ftm_stats);
3817 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3818 struct cfg80211_pmsr_request *request);
3819 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3820 struct cfg80211_pmsr_request *request);
3821 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
3822 struct cfg80211_update_owe_info *owe_info);
3823 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
3824 const u8 *buf, size_t len);
3828 * wireless hardware and networking interfaces structures
3829 * and registration/helper functions
3833 * enum wiphy_flags - wiphy capability flags
3835 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3837 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3838 * by default -- this flag will be set depending on the kernel's default
3839 * on wiphy_new(), but can be changed by the driver if it has a good
3840 * reason to override the default
3841 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3842 * on a VLAN interface)
3843 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3844 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3845 * control port protocol ethertype. The device also honours the
3846 * control_port_no_encrypt flag.
3847 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3848 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3849 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3850 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3852 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3853 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3854 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3855 * link setup/discovery operations internally. Setup, discovery and
3856 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3857 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3858 * used for asking the driver/firmware to perform a TDLS operation.
3859 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3860 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3861 * when there are virtual interfaces in AP mode by calling
3862 * cfg80211_report_obss_beacon().
3863 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3864 * responds to probe-requests in hardware.
3865 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3866 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3867 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3868 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3869 * beaconing mode (AP, IBSS, Mesh, ...).
3870 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3871 * before connection.
3877 WIPHY_FLAG_NETNS_OK = BIT(3),
3878 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
3879 WIPHY_FLAG_4ADDR_AP = BIT(5),
3880 WIPHY_FLAG_4ADDR_STATION = BIT(6),
3881 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
3882 WIPHY_FLAG_IBSS_RSN = BIT(8),
3883 WIPHY_FLAG_MESH_AUTH = BIT(10),
3884 /* use hole at 11 */
3885 /* use hole at 12 */
3886 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
3887 WIPHY_FLAG_AP_UAPSD = BIT(14),
3888 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
3889 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
3890 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
3891 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
3892 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
3893 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
3894 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
3895 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
3896 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
3897 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
3901 * struct ieee80211_iface_limit - limit on certain interface types
3902 * @max: maximum number of interfaces of these types
3903 * @types: interface types (bits)
3905 struct ieee80211_iface_limit {
3911 * struct ieee80211_iface_combination - possible interface combination
3913 * With this structure the driver can describe which interface
3914 * combinations it supports concurrently.
3918 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3922 * struct ieee80211_iface_limit limits1[] = {
3923 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3924 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3926 * struct ieee80211_iface_combination combination1 = {
3927 * .limits = limits1,
3928 * .n_limits = ARRAY_SIZE(limits1),
3929 * .max_interfaces = 2,
3930 * .beacon_int_infra_match = true,
3934 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3938 * struct ieee80211_iface_limit limits2[] = {
3939 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3940 * BIT(NL80211_IFTYPE_P2P_GO), },
3942 * struct ieee80211_iface_combination combination2 = {
3943 * .limits = limits2,
3944 * .n_limits = ARRAY_SIZE(limits2),
3945 * .max_interfaces = 8,
3946 * .num_different_channels = 1,
3950 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3952 * This allows for an infrastructure connection and three P2P connections.
3956 * struct ieee80211_iface_limit limits3[] = {
3957 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3958 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3959 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
3961 * struct ieee80211_iface_combination combination3 = {
3962 * .limits = limits3,
3963 * .n_limits = ARRAY_SIZE(limits3),
3964 * .max_interfaces = 4,
3965 * .num_different_channels = 2,
3969 struct ieee80211_iface_combination {
3972 * limits for the given interface types
3974 const struct ieee80211_iface_limit *limits;
3977 * @num_different_channels:
3978 * can use up to this many different channels
3980 u32 num_different_channels;
3984 * maximum number of interfaces in total allowed in this group
3990 * number of limitations
3995 * @beacon_int_infra_match:
3996 * In this combination, the beacon intervals between infrastructure
3997 * and AP types must match. This is required only in special cases.
3999 bool beacon_int_infra_match;
4002 * @radar_detect_widths:
4003 * bitmap of channel widths supported for radar detection
4005 u8 radar_detect_widths;
4008 * @radar_detect_regions:
4009 * bitmap of regions supported for radar detection
4011 u8 radar_detect_regions;
4014 * @beacon_int_min_gcd:
4015 * This interface combination supports different beacon intervals.
4018 * all beacon intervals for different interface must be same.
4020 * any beacon interval for the interface part of this combination AND
4021 * GCD of all beacon intervals from beaconing interfaces of this
4022 * combination must be greater or equal to this value.
4024 u32 beacon_int_min_gcd;
4027 struct ieee80211_txrx_stypes {
4032 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4033 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4034 * trigger that keeps the device operating as-is and
4035 * wakes up the host on any activity, for example a
4036 * received packet that passed filtering; note that the
4037 * packet should be preserved in that case
4038 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4040 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4041 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4042 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4043 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4044 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4045 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4046 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4048 enum wiphy_wowlan_support_flags {
4049 WIPHY_WOWLAN_ANY = BIT(0),
4050 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4051 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4052 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4053 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4054 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4055 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4056 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4057 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4060 struct wiphy_wowlan_tcp_support {
4061 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4062 u32 data_payload_max;
4063 u32 data_interval_max;
4064 u32 wake_payload_max;
4069 * struct wiphy_wowlan_support - WoWLAN support data
4070 * @flags: see &enum wiphy_wowlan_support_flags
4071 * @n_patterns: number of supported wakeup patterns
4072 * (see nl80211.h for the pattern definition)
4073 * @pattern_max_len: maximum length of each pattern
4074 * @pattern_min_len: minimum length of each pattern
4075 * @max_pkt_offset: maximum Rx packet offset
4076 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4077 * similar, but not necessarily identical, to max_match_sets for
4079 * See &struct cfg80211_sched_scan_request.@match_sets for more
4081 * @tcp: TCP wakeup support information
4083 struct wiphy_wowlan_support {
4086 int pattern_max_len;
4087 int pattern_min_len;
4089 int max_nd_match_sets;
4090 const struct wiphy_wowlan_tcp_support *tcp;
4094 * struct wiphy_coalesce_support - coalesce support data
4095 * @n_rules: maximum number of coalesce rules
4096 * @max_delay: maximum supported coalescing delay in msecs
4097 * @n_patterns: number of supported patterns in a rule
4098 * (see nl80211.h for the pattern definition)
4099 * @pattern_max_len: maximum length of each pattern
4100 * @pattern_min_len: minimum length of each pattern
4101 * @max_pkt_offset: maximum Rx packet offset
4103 struct wiphy_coalesce_support {
4107 int pattern_max_len;
4108 int pattern_min_len;
4113 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4114 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4115 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4116 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4117 * (must be combined with %_WDEV or %_NETDEV)
4119 enum wiphy_vendor_command_flags {
4120 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4121 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4122 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4126 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4128 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4129 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4130 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4133 enum wiphy_opmode_flag {
4134 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4135 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4136 STA_OPMODE_N_SS_CHANGED = BIT(2),
4140 * struct sta_opmode_info - Station's ht/vht operation mode information
4141 * @changed: contains value from &enum wiphy_opmode_flag
4142 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4143 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4144 * @rx_nss: new rx_nss value of a station
4147 struct sta_opmode_info {
4149 enum nl80211_smps_mode smps_mode;
4150 enum nl80211_chan_width bw;
4155 * struct wiphy_vendor_command - vendor command definition
4156 * @info: vendor command identifying information, as used in nl80211
4157 * @flags: flags, see &enum wiphy_vendor_command_flags
4158 * @doit: callback for the operation, note that wdev is %NULL if the
4159 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4160 * pointer may be %NULL if userspace provided no data at all
4161 * @dumpit: dump callback, for transferring bigger/multiple items. The
4162 * @storage points to cb->args[5], ie. is preserved over the multiple
4164 * It's recommended to not have the same sub command with both @doit and
4165 * @dumpit, so that userspace can assume certain ones are get and others
4166 * are used with dump requests.
4168 struct wiphy_vendor_command {
4169 struct nl80211_vendor_cmd_info info;
4171 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4172 const void *data, int data_len);
4173 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4174 struct sk_buff *skb, const void *data, int data_len,
4175 unsigned long *storage);
4179 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4180 * @iftype: interface type
4181 * @extended_capabilities: extended capabilities supported by the driver,
4182 * additional capabilities might be supported by userspace; these are the
4183 * 802.11 extended capabilities ("Extended Capabilities element") and are
4184 * in the same format as in the information element. See IEEE Std
4185 * 802.11-2012 8.4.2.29 for the defined fields.
4186 * @extended_capabilities_mask: mask of the valid values
4187 * @extended_capabilities_len: length of the extended capabilities
4189 struct wiphy_iftype_ext_capab {
4190 enum nl80211_iftype iftype;
4191 const u8 *extended_capabilities;
4192 const u8 *extended_capabilities_mask;
4193 u8 extended_capabilities_len;
4197 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4198 * @max_peers: maximum number of peers in a single measurement
4199 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4200 * @randomize_mac_addr: can randomize MAC address for measurement
4201 * @ftm.supported: FTM measurement is supported
4202 * @ftm.asap: ASAP-mode is supported
4203 * @ftm.non_asap: non-ASAP-mode is supported
4204 * @ftm.request_lci: can request LCI data
4205 * @ftm.request_civicloc: can request civic location data
4206 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4207 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4208 * @ftm.max_bursts_exponent: maximum burst exponent supported
4209 * (set to -1 if not limited; note that setting this will necessarily
4210 * forbid using the value 15 to let the responder pick)
4211 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4214 struct cfg80211_pmsr_capabilities {
4215 unsigned int max_peers;
4217 randomize_mac_addr:1;
4222 s8 max_bursts_exponent;
4223 u8 max_ftms_per_burst;
4233 * struct wiphy - wireless hardware description
4234 * @reg_notifier: the driver's regulatory notification callback,
4235 * note that if your driver uses wiphy_apply_custom_regulatory()
4236 * the reg_notifier's request can be passed as NULL
4237 * @regd: the driver's regulatory domain, if one was requested via
4238 * the regulatory_hint() API. This can be used by the driver
4239 * on the reg_notifier() if it chooses to ignore future
4240 * regulatory domain changes caused by other drivers.
4241 * @signal_type: signal type reported in &struct cfg80211_bss.
4242 * @cipher_suites: supported cipher suites
4243 * @n_cipher_suites: number of supported cipher suites
4244 * @akm_suites: supported AKM suites
4245 * @n_akm_suites: number of supported AKM suites
4246 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4247 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4248 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4249 * -1 = fragmentation disabled, only odd values >= 256 used
4250 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4251 * @_net: the network namespace this wiphy currently lives in
4252 * @perm_addr: permanent MAC address of this device
4253 * @addr_mask: If the device supports multiple MAC addresses by masking,
4254 * set this to a mask with variable bits set to 1, e.g. if the last
4255 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4256 * variable bits shall be determined by the interfaces added, with
4257 * interfaces not matching the mask being rejected to be brought up.
4258 * @n_addresses: number of addresses in @addresses.
4259 * @addresses: If the device has more than one address, set this pointer
4260 * to a list of addresses (6 bytes each). The first one will be used
4261 * by default for perm_addr. In this case, the mask should be set to
4262 * all-zeroes. In this case it is assumed that the device can handle
4263 * the same number of arbitrary MAC addresses.
4264 * @registered: protects ->resume and ->suspend sysfs callbacks against
4265 * unregister hardware
4266 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
4267 * automatically on wiphy renames
4268 * @dev: (virtual) struct device for this wiphy
4269 * @registered: helps synchronize suspend/resume with wiphy unregister
4270 * @wext: wireless extension handlers
4271 * @priv: driver private data (sized according to wiphy_new() parameter)
4272 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4273 * must be set by driver
4274 * @iface_combinations: Valid interface combinations array, should not
4275 * list single interface types.
4276 * @n_iface_combinations: number of entries in @iface_combinations array.
4277 * @software_iftypes: bitmask of software interface types, these are not
4278 * subject to any restrictions since they are purely managed in SW.
4279 * @flags: wiphy flags, see &enum wiphy_flags
4280 * @regulatory_flags: wiphy regulatory flags, see
4281 * &enum ieee80211_regulatory_flags
4282 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4283 * @ext_features: extended features advertised to nl80211, see
4284 * &enum nl80211_ext_feature_index.
4285 * @bss_priv_size: each BSS struct has private data allocated with it,
4286 * this variable determines its size
4287 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4289 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4290 * the device can run concurrently.
4291 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4292 * for in any given scheduled scan
4293 * @max_match_sets: maximum number of match sets the device can handle
4294 * when performing a scheduled scan, 0 if filtering is not
4296 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4297 * add to probe request frames transmitted during a scan, must not
4298 * include fixed IEs like supported rates
4299 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4301 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4302 * of iterations) for scheduled scan supported by the device.
4303 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4304 * single scan plan supported by the device.
4305 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4306 * scan plan supported by the device.
4307 * @coverage_class: current coverage class
4308 * @fw_version: firmware version for ethtool reporting
4309 * @hw_version: hardware version for ethtool reporting
4310 * @max_num_pmkids: maximum number of PMKIDs supported by device
4311 * @privid: a pointer that drivers can use to identify if an arbitrary
4312 * wiphy is theirs, e.g. in global notifiers
4313 * @bands: information about bands/channels supported by this device
4315 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4316 * transmitted through nl80211, points to an array indexed by interface
4319 * @available_antennas_tx: bitmap of antennas which are available to be
4320 * configured as TX antennas. Antenna configuration commands will be
4321 * rejected unless this or @available_antennas_rx is set.
4323 * @available_antennas_rx: bitmap of antennas which are available to be
4324 * configured as RX antennas. Antenna configuration commands will be
4325 * rejected unless this or @available_antennas_tx is set.
4327 * @probe_resp_offload:
4328 * Bitmap of supported protocols for probe response offloading.
4329 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4330 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4332 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4333 * may request, if implemented.
4335 * @wowlan: WoWLAN support information
4336 * @wowlan_config: current WoWLAN configuration; this should usually not be
4337 * used since access to it is necessarily racy, use the parameter passed
4338 * to the suspend() operation instead.
4340 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4341 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4342 * If null, then none can be over-ridden.
4343 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4344 * If null, then none can be over-ridden.
4346 * @wdev_list: the list of associated (virtual) interfaces; this list must
4347 * not be modified by the driver, but can be read with RTNL/RCU protection.
4349 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4352 * @extended_capabilities: extended capabilities supported by the driver,
4353 * additional capabilities might be supported by userspace; these are
4354 * the 802.11 extended capabilities ("Extended Capabilities element")
4355 * and are in the same format as in the information element. See
4356 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4357 * extended capabilities to be used if the capabilities are not specified
4358 * for a specific interface type in iftype_ext_capab.
4359 * @extended_capabilities_mask: mask of the valid values
4360 * @extended_capabilities_len: length of the extended capabilities
4361 * @iftype_ext_capab: array of extended capabilities per interface type
4362 * @num_iftype_ext_capab: number of interface types for which extended
4363 * capabilities are specified separately.
4364 * @coalesce: packet coalescing support information
4366 * @vendor_commands: array of vendor commands supported by the hardware
4367 * @n_vendor_commands: number of vendor commands
4368 * @vendor_events: array of vendor events supported by the hardware
4369 * @n_vendor_events: number of vendor events
4371 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4372 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4373 * driver is allowed to advertise a theoretical limit that it can reach in
4374 * some cases, but may not always reach.
4376 * @max_num_csa_counters: Number of supported csa_counters in beacons
4377 * and probe responses. This value should be set if the driver
4378 * wishes to limit the number of csa counters. Default (0) means
4380 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
4381 * frame was sent and the channel on which the frame was heard for which
4382 * the reported rssi is still valid. If a driver is able to compensate the
4383 * low rssi when a frame is heard on different channel, then it should set
4384 * this variable to the maximal offset for which it can compensate.
4385 * This value should be set in MHz.
4386 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4387 * by the driver in the .connect() callback. The bit position maps to the
4388 * attribute indices defined in &enum nl80211_bss_select_attr.
4390 * @nan_supported_bands: bands supported by the device in NAN mode, a
4391 * bitmap of &enum nl80211_band values. For instance, for
4392 * NL80211_BAND_2GHZ, bit 0 would be set
4393 * (i.e. BIT(NL80211_BAND_2GHZ)).
4395 * @txq_limit: configuration of internal TX queue frame limit
4396 * @txq_memory_limit: configuration internal TX queue memory limit
4397 * @txq_quantum: configuration of internal TX queue scheduler quantum
4399 * @support_mbssid: can HW support association with nontransmitted AP
4400 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4401 * HE AP, in order to avoid compatibility issues.
4402 * @support_mbssid must be set for this to have any effect.
4404 * @pmsr_capa: peer measurement capabilities
4407 /* assign these fields before you register the wiphy */
4409 /* permanent MAC address(es) */
4410 u8 perm_addr[ETH_ALEN];
4411 u8 addr_mask[ETH_ALEN];
4413 struct mac_address *addresses;
4415 const struct ieee80211_txrx_stypes *mgmt_stypes;
4417 const struct ieee80211_iface_combination *iface_combinations;
4418 int n_iface_combinations;
4419 u16 software_iftypes;
4423 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4424 u16 interface_modes;
4426 u16 max_acl_mac_addrs;
4428 u32 flags, regulatory_flags, features;
4429 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4433 enum cfg80211_signal_type signal_type;
4437 u8 max_sched_scan_reqs;
4438 u8 max_sched_scan_ssids;
4440 u16 max_scan_ie_len;
4441 u16 max_sched_scan_ie_len;
4442 u32 max_sched_scan_plans;
4443 u32 max_sched_scan_plan_interval;
4444 u32 max_sched_scan_plan_iterations;
4446 int n_cipher_suites;
4447 const u32 *cipher_suites;
4450 const u32 *akm_suites;
4458 char fw_version[ETHTOOL_FWVERS_LEN];
4462 const struct wiphy_wowlan_support *wowlan;
4463 struct cfg80211_wowlan *wowlan_config;
4466 u16 max_remain_on_channel_duration;
4470 u32 available_antennas_tx;
4471 u32 available_antennas_rx;
4474 * Bitmap of supported protocols for probe response offloading
4475 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
4476 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4478 u32 probe_resp_offload;
4480 const u8 *extended_capabilities, *extended_capabilities_mask;
4481 u8 extended_capabilities_len;
4483 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4484 unsigned int num_iftype_ext_capab;
4486 /* If multiple wiphys are registered and you're handed e.g.
4487 * a regular netdev with assigned ieee80211_ptr, you won't
4488 * know whether it points to a wiphy your driver has registered
4489 * or not. Assign this to something global to your driver to
4490 * help determine whether you own this wiphy or not. */
4493 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4495 /* Lets us get back the wiphy on the callback */
4496 void (*reg_notifier)(struct wiphy *wiphy,
4497 struct regulatory_request *request);
4499 /* fields below are read-only, assigned by cfg80211 */
4501 const struct ieee80211_regdomain __rcu *regd;
4503 /* the item in /sys/class/ieee80211/ points to this,
4504 * you need use set_wiphy_dev() (see below) */
4507 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
4510 /* dir in debugfs: ieee80211/<wiphyname> */
4511 struct dentry *debugfsdir;
4513 const struct ieee80211_ht_cap *ht_capa_mod_mask;
4514 const struct ieee80211_vht_cap *vht_capa_mod_mask;
4516 struct list_head wdev_list;
4518 /* the network namespace this phy lives in currently */
4519 possible_net_t _net;
4521 #ifdef CONFIG_CFG80211_WEXT
4522 const struct iw_handler_def *wext;
4525 const struct wiphy_coalesce_support *coalesce;
4527 const struct wiphy_vendor_command *vendor_commands;
4528 const struct nl80211_vendor_cmd_info *vendor_events;
4529 int n_vendor_commands, n_vendor_events;
4531 u16 max_ap_assoc_sta;
4533 u8 max_num_csa_counters;
4534 u8 max_adj_channel_rssi_comp;
4536 u32 bss_select_support;
4538 u8 nan_supported_bands;
4541 u32 txq_memory_limit;
4544 u8 support_mbssid:1,
4545 support_only_he_mbssid:1;
4547 const struct cfg80211_pmsr_capabilities *pmsr_capa;
4549 char priv[0] __aligned(NETDEV_ALIGN);
4552 static inline struct net *wiphy_net(struct wiphy *wiphy)
4554 return read_pnet(&wiphy->_net);
4557 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4559 write_pnet(&wiphy->_net, net);
4563 * wiphy_priv - return priv from wiphy
4565 * @wiphy: the wiphy whose priv pointer to return
4566 * Return: The priv of @wiphy.
4568 static inline void *wiphy_priv(struct wiphy *wiphy)
4571 return &wiphy->priv;
4575 * priv_to_wiphy - return the wiphy containing the priv
4577 * @priv: a pointer previously returned by wiphy_priv
4578 * Return: The wiphy of @priv.
4580 static inline struct wiphy *priv_to_wiphy(void *priv)
4583 return container_of(priv, struct wiphy, priv);
4587 * set_wiphy_dev - set device pointer for wiphy
4589 * @wiphy: The wiphy whose device to bind
4590 * @dev: The device to parent it to
4592 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4594 wiphy->dev.parent = dev;
4598 * wiphy_dev - get wiphy dev pointer
4600 * @wiphy: The wiphy whose device struct to look up
4601 * Return: The dev of @wiphy.
4603 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4605 return wiphy->dev.parent;
4609 * wiphy_name - get wiphy name
4611 * @wiphy: The wiphy whose name to return
4612 * Return: The name of @wiphy.
4614 static inline const char *wiphy_name(const struct wiphy *wiphy)
4616 return dev_name(&wiphy->dev);
4620 * wiphy_new_nm - create a new wiphy for use with cfg80211
4622 * @ops: The configuration operations for this device
4623 * @sizeof_priv: The size of the private area to allocate
4624 * @requested_name: Request a particular name.
4625 * NULL is valid value, and means use the default phy%d naming.
4627 * Create a new wiphy and associate the given operations with it.
4628 * @sizeof_priv bytes are allocated for private use.
4630 * Return: A pointer to the new wiphy. This pointer must be
4631 * assigned to each netdev's ieee80211_ptr for proper operation.
4633 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4634 const char *requested_name);
4637 * wiphy_new - create a new wiphy for use with cfg80211
4639 * @ops: The configuration operations for this device
4640 * @sizeof_priv: The size of the private area to allocate
4642 * Create a new wiphy and associate the given operations with it.
4643 * @sizeof_priv bytes are allocated for private use.
4645 * Return: A pointer to the new wiphy. This pointer must be
4646 * assigned to each netdev's ieee80211_ptr for proper operation.
4648 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4651 return wiphy_new_nm(ops, sizeof_priv, NULL);
4655 * wiphy_register - register a wiphy with cfg80211
4657 * @wiphy: The wiphy to register.
4659 * Return: A non-negative wiphy index or a negative error code.
4661 int wiphy_register(struct wiphy *wiphy);
4664 * wiphy_unregister - deregister a wiphy from cfg80211
4666 * @wiphy: The wiphy to unregister.
4668 * After this call, no more requests can be made with this priv
4669 * pointer, but the call may sleep to wait for an outstanding
4670 * request that is being handled.
4672 void wiphy_unregister(struct wiphy *wiphy);
4675 * wiphy_free - free wiphy
4677 * @wiphy: The wiphy to free
4679 void wiphy_free(struct wiphy *wiphy);
4681 /* internal structs */
4682 struct cfg80211_conn;
4683 struct cfg80211_internal_bss;
4684 struct cfg80211_cached_keys;
4685 struct cfg80211_cqm_config;
4688 * struct wireless_dev - wireless device state
4690 * For netdevs, this structure must be allocated by the driver
4691 * that uses the ieee80211_ptr field in struct net_device (this
4692 * is intentional so it can be allocated along with the netdev.)
4693 * It need not be registered then as netdev registration will
4694 * be intercepted by cfg80211 to see the new wireless device.
4696 * For non-netdev uses, it must also be allocated by the driver
4697 * in response to the cfg80211 callbacks that require it, as
4698 * there's no netdev registration in that case it may not be
4699 * allocated outside of callback operations that return it.
4701 * @wiphy: pointer to hardware description
4702 * @iftype: interface type
4703 * @list: (private) Used to collect the interfaces
4704 * @netdev: (private) Used to reference back to the netdev, may be %NULL
4705 * @identifier: (private) Identifier used in nl80211 to identify this
4706 * wireless device if it has no netdev
4707 * @current_bss: (private) Used by the internal configuration code
4708 * @chandef: (private) Used by the internal configuration code to track
4709 * the user-set channel definition.
4710 * @preset_chandef: (private) Used by the internal configuration code to
4711 * track the channel to be used for AP later
4712 * @bssid: (private) Used by the internal configuration code
4713 * @ssid: (private) Used by the internal configuration code
4714 * @ssid_len: (private) Used by the internal configuration code
4715 * @mesh_id_len: (private) Used by the internal configuration code
4716 * @mesh_id_up_len: (private) Used by the internal configuration code
4717 * @wext: (private) Used by the internal wireless extensions compat code
4718 * @wext.ibss: (private) IBSS data part of wext handling
4719 * @wext.connect: (private) connection handling data
4720 * @wext.keys: (private) (WEP) key data
4721 * @wext.ie: (private) extra elements for association
4722 * @wext.ie_len: (private) length of extra elements
4723 * @wext.bssid: (private) selected network BSSID
4724 * @wext.ssid: (private) selected network SSID
4725 * @wext.default_key: (private) selected default key index
4726 * @wext.default_mgmt_key: (private) selected default management key index
4727 * @wext.prev_bssid: (private) previous BSSID for reassociation
4728 * @wext.prev_bssid_valid: (private) previous BSSID validity
4729 * @use_4addr: indicates 4addr mode is used on this interface, must be
4730 * set by driver (if supported) on add_interface BEFORE registering the
4731 * netdev and may otherwise be used by driver read-only, will be update
4732 * by cfg80211 on change_interface
4733 * @mgmt_registrations: list of registrations for management frames
4734 * @mgmt_registrations_lock: lock for the list
4735 * @mtx: mutex used to lock data in this struct, may be used by drivers
4736 * and some API functions require it held
4737 * @beacon_interval: beacon interval used on this device for transmitting
4738 * beacons, 0 when not valid
4739 * @address: The address for this device, valid only if @netdev is %NULL
4740 * @is_running: true if this is a non-netdev device that has been started, e.g.
4742 * @cac_started: true if DFS channel availability check has been started
4743 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4744 * @cac_time_ms: CAC time in ms
4745 * @ps: powersave mode is enabled
4746 * @ps_timeout: dynamic powersave timeout
4747 * @ap_unexpected_nlportid: (private) netlink port ID of application
4748 * registered for unexpected class 3 frames (AP mode)
4749 * @conn: (private) cfg80211 software SME connection state machine data
4750 * @connect_keys: (private) keys to set after connection is established
4751 * @conn_bss_type: connecting/connected BSS type
4752 * @conn_owner_nlportid: (private) connection owner socket port ID
4753 * @disconnect_wk: (private) auto-disconnect work
4754 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4755 * @ibss_fixed: (private) IBSS is using fixed BSSID
4756 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4757 * @event_list: (private) list for internal event processing
4758 * @event_lock: (private) lock for event list
4759 * @owner_nlportid: (private) owner socket port ID
4760 * @nl_owner_dead: (private) owner socket went away
4761 * @cqm_config: (private) nl80211 RSSI monitor state
4762 * @pmsr_list: (private) peer measurement requests
4763 * @pmsr_lock: (private) peer measurements requests/results lock
4764 * @pmsr_free_wk: (private) peer measurements cleanup work
4766 struct wireless_dev {
4767 struct wiphy *wiphy;
4768 enum nl80211_iftype iftype;
4770 /* the remainder of this struct should be private to cfg80211 */
4771 struct list_head list;
4772 struct net_device *netdev;
4776 struct list_head mgmt_registrations;
4777 spinlock_t mgmt_registrations_lock;
4781 bool use_4addr, is_running;
4783 u8 address[ETH_ALEN] __aligned(sizeof(u16));
4785 /* currently used for IBSS and SME - might be rearranged later */
4786 u8 ssid[IEEE80211_MAX_SSID_LEN];
4787 u8 ssid_len, mesh_id_len, mesh_id_up_len;
4788 struct cfg80211_conn *conn;
4789 struct cfg80211_cached_keys *connect_keys;
4790 enum ieee80211_bss_type conn_bss_type;
4791 u32 conn_owner_nlportid;
4793 struct work_struct disconnect_wk;
4794 u8 disconnect_bssid[ETH_ALEN];
4796 struct list_head event_list;
4797 spinlock_t event_lock;
4799 struct cfg80211_internal_bss *current_bss; /* associated / joined */
4800 struct cfg80211_chan_def preset_chandef;
4801 struct cfg80211_chan_def chandef;
4804 bool ibss_dfs_possible;
4809 int beacon_interval;
4811 u32 ap_unexpected_nlportid;
4817 unsigned long cac_start_time;
4818 unsigned int cac_time_ms;
4820 #ifdef CONFIG_CFG80211_WEXT
4823 struct cfg80211_ibss_params ibss;
4824 struct cfg80211_connect_params connect;
4825 struct cfg80211_cached_keys *keys;
4829 u8 prev_bssid[ETH_ALEN];
4830 u8 ssid[IEEE80211_MAX_SSID_LEN];
4831 s8 default_key, default_mgmt_key;
4832 bool prev_bssid_valid;
4836 struct cfg80211_cqm_config *cqm_config;
4838 struct list_head pmsr_list;
4839 spinlock_t pmsr_lock;
4840 struct work_struct pmsr_free_wk;
4843 static inline u8 *wdev_address(struct wireless_dev *wdev)
4846 return wdev->netdev->dev_addr;
4847 return wdev->address;
4850 static inline bool wdev_running(struct wireless_dev *wdev)
4853 return netif_running(wdev->netdev);
4854 return wdev->is_running;
4858 * wdev_priv - return wiphy priv from wireless_dev
4860 * @wdev: The wireless device whose wiphy's priv pointer to return
4861 * Return: The wiphy priv of @wdev.
4863 static inline void *wdev_priv(struct wireless_dev *wdev)
4866 return wiphy_priv(wdev->wiphy);
4870 * DOC: Utility functions
4872 * cfg80211 offers a number of utility functions that can be useful.
4876 * ieee80211_channel_to_frequency - convert channel number to frequency
4877 * @chan: channel number
4878 * @band: band, necessary due to channel number overlap
4879 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
4881 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
4884 * ieee80211_frequency_to_channel - convert frequency to channel number
4885 * @freq: center frequency
4886 * Return: The corresponding channel, or 0 if the conversion failed.
4888 int ieee80211_frequency_to_channel(int freq);
4891 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
4893 * @wiphy: the struct wiphy to get the channel for
4894 * @freq: the center frequency of the channel
4896 * Return: The channel struct from @wiphy at @freq.
4898 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
4901 * ieee80211_get_response_rate - get basic rate for a given rate
4903 * @sband: the band to look for rates in
4904 * @basic_rates: bitmap of basic rates
4905 * @bitrate: the bitrate for which to find the basic rate
4907 * Return: The basic rate corresponding to a given bitrate, that
4908 * is the next lower bitrate contained in the basic rate map,
4909 * which is, for this function, given as a bitmap of indices of
4910 * rates in the band's bitrate table.
4912 struct ieee80211_rate *
4913 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
4914 u32 basic_rates, int bitrate);
4917 * ieee80211_mandatory_rates - get mandatory rates for a given band
4918 * @sband: the band to look for rates in
4919 * @scan_width: width of the control channel
4921 * This function returns a bitmap of the mandatory rates for the given
4922 * band, bits are set according to the rate position in the bitrates array.
4924 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4925 enum nl80211_bss_scan_width scan_width);
4928 * Radiotap parsing functions -- for controlled injection support
4930 * Implemented in net/wireless/radiotap.c
4931 * Documentation in Documentation/networking/radiotap-headers.txt
4934 struct radiotap_align_size {
4935 uint8_t align:4, size:4;
4938 struct ieee80211_radiotap_namespace {
4939 const struct radiotap_align_size *align_size;
4945 struct ieee80211_radiotap_vendor_namespaces {
4946 const struct ieee80211_radiotap_namespace *ns;
4951 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4952 * @this_arg_index: index of current arg, valid after each successful call
4953 * to ieee80211_radiotap_iterator_next()
4954 * @this_arg: pointer to current radiotap arg; it is valid after each
4955 * call to ieee80211_radiotap_iterator_next() but also after
4956 * ieee80211_radiotap_iterator_init() where it will point to
4957 * the beginning of the actual data portion
4958 * @this_arg_size: length of the current arg, for convenience
4959 * @current_namespace: pointer to the current namespace definition
4960 * (or internally %NULL if the current namespace is unknown)
4961 * @is_radiotap_ns: indicates whether the current namespace is the default
4962 * radiotap namespace or not
4964 * @_rtheader: pointer to the radiotap header we are walking through
4965 * @_max_length: length of radiotap header in cpu byte ordering
4966 * @_arg_index: next argument index
4967 * @_arg: next argument pointer
4968 * @_next_bitmap: internal pointer to next present u32
4969 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4970 * @_vns: vendor namespace definitions
4971 * @_next_ns_data: beginning of the next namespace's data
4972 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4975 * Describes the radiotap parser state. Fields prefixed with an underscore
4976 * must not be used by users of the parser, only by the parser internally.
4979 struct ieee80211_radiotap_iterator {
4980 struct ieee80211_radiotap_header *_rtheader;
4981 const struct ieee80211_radiotap_vendor_namespaces *_vns;
4982 const struct ieee80211_radiotap_namespace *current_namespace;
4984 unsigned char *_arg, *_next_ns_data;
4985 __le32 *_next_bitmap;
4987 unsigned char *this_arg;
4995 uint32_t _bitmap_shifter;
5000 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5001 struct ieee80211_radiotap_header *radiotap_header,
5003 const struct ieee80211_radiotap_vendor_namespaces *vns);
5006 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5009 extern const unsigned char rfc1042_header[6];
5010 extern const unsigned char bridge_tunnel_header[6];
5013 * ieee80211_get_hdrlen_from_skb - get header length from data
5017 * Given an skb with a raw 802.11 header at the data pointer this function
5018 * returns the 802.11 header length.
5020 * Return: The 802.11 header length in bytes (not including encryption
5021 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5024 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5027 * ieee80211_hdrlen - get header length in bytes from frame control
5028 * @fc: frame control field in little-endian format
5029 * Return: The header length in bytes.
5031 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5034 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5035 * @meshhdr: the mesh extension header, only the flags field
5036 * (first byte) will be accessed
5037 * Return: The length of the extension header, which is always at
5038 * least 6 bytes and at most 18 if address 5 and 6 are present.
5040 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5043 * DOC: Data path helpers
5045 * In addition to generic utilities, cfg80211 also offers
5046 * functions that help implement the data path for devices
5047 * that do not do the 802.11/802.3 conversion on the device.
5051 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5052 * @skb: the 802.11 data frame
5053 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5054 * of it being pushed into the SKB
5055 * @addr: the device MAC address
5056 * @iftype: the virtual interface type
5057 * @data_offset: offset of payload after the 802.11 header
5058 * Return: 0 on success. Non-zero on error.
5060 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5061 const u8 *addr, enum nl80211_iftype iftype,
5065 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5066 * @skb: the 802.11 data frame
5067 * @addr: the device MAC address
5068 * @iftype: the virtual interface type
5069 * Return: 0 on success. Non-zero on error.
5071 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5072 enum nl80211_iftype iftype)
5074 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5078 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5080 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5081 * The @list will be empty if the decode fails. The @skb must be fully
5082 * header-less before being passed in here; it is freed in this function.
5084 * @skb: The input A-MSDU frame without any headers.
5085 * @list: The output list of 802.3 frames. It must be allocated and
5086 * initialized by by the caller.
5087 * @addr: The device MAC address.
5088 * @iftype: The device interface type.
5089 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5090 * @check_da: DA to check in the inner ethernet header, or NULL
5091 * @check_sa: SA to check in the inner ethernet header, or NULL
5093 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5094 const u8 *addr, enum nl80211_iftype iftype,
5095 const unsigned int extra_headroom,
5096 const u8 *check_da, const u8 *check_sa);
5099 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5100 * @skb: the data frame
5101 * @qos_map: Interworking QoS mapping or %NULL if not in use
5102 * Return: The 802.1p/1d tag.
5104 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5105 struct cfg80211_qos_map *qos_map);
5108 * cfg80211_find_elem_match - match information element and byte array in data
5111 * @ies: data consisting of IEs
5112 * @len: length of data
5113 * @match: byte array to match
5114 * @match_len: number of bytes in the match array
5115 * @match_offset: offset in the IE data where the byte array should match.
5116 * Note the difference to cfg80211_find_ie_match() which considers
5117 * the offset to start from the element ID byte, but here we take
5118 * the data portion instead.
5120 * Return: %NULL if the element ID could not be found or if
5121 * the element is invalid (claims to be longer than the given
5122 * data) or if the byte array doesn't match; otherwise return the
5123 * requested element struct.
5125 * Note: There are no checks on the element length other than
5126 * having to fit into the given data and being large enough for the
5127 * byte array to match.
5129 const struct element *
5130 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5131 const u8 *match, unsigned int match_len,
5132 unsigned int match_offset);
5135 * cfg80211_find_ie_match - match information element and byte array in data
5138 * @ies: data consisting of IEs
5139 * @len: length of data
5140 * @match: byte array to match
5141 * @match_len: number of bytes in the match array
5142 * @match_offset: offset in the IE where the byte array should match.
5143 * If match_len is zero, this must also be set to zero.
5144 * Otherwise this must be set to 2 or more, because the first
5145 * byte is the element id, which is already compared to eid, and
5146 * the second byte is the IE length.
5148 * Return: %NULL if the element ID could not be found or if
5149 * the element is invalid (claims to be longer than the given
5150 * data) or if the byte array doesn't match, or a pointer to the first
5151 * byte of the requested element, that is the byte containing the
5154 * Note: There are no checks on the element length other than
5155 * having to fit into the given data and being large enough for the
5156 * byte array to match.
5158 static inline const u8 *
5159 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5160 const u8 *match, unsigned int match_len,
5161 unsigned int match_offset)
5163 /* match_offset can't be smaller than 2, unless match_len is
5164 * zero, in which case match_offset must be zero as well.
5166 if (WARN_ON((match_len && match_offset < 2) ||
5167 (!match_len && match_offset)))
5170 return (void *)cfg80211_find_elem_match(eid, ies, len,
5173 match_offset - 2 : 0);
5177 * cfg80211_find_elem - find information element in data
5180 * @ies: data consisting of IEs
5181 * @len: length of data
5183 * Return: %NULL if the element ID could not be found or if
5184 * the element is invalid (claims to be longer than the given
5185 * data) or if the byte array doesn't match; otherwise return the
5186 * requested element struct.
5188 * Note: There are no checks on the element length other than
5189 * having to fit into the given data.
5191 static inline const struct element *
5192 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5194 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5198 * cfg80211_find_ie - find information element in data
5201 * @ies: data consisting of IEs
5202 * @len: length of data
5204 * Return: %NULL if the element ID could not be found or if
5205 * the element is invalid (claims to be longer than the given
5206 * data), or a pointer to the first byte of the requested
5207 * element, that is the byte containing the element ID.
5209 * Note: There are no checks on the element length other than
5210 * having to fit into the given data.
5212 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5214 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5218 * cfg80211_find_ext_elem - find information element with EID Extension in data
5220 * @ext_eid: element ID Extension
5221 * @ies: data consisting of IEs
5222 * @len: length of data
5224 * Return: %NULL if the etended element could not be found or if
5225 * the element is invalid (claims to be longer than the given
5226 * data) or if the byte array doesn't match; otherwise return the
5227 * requested element struct.
5229 * Note: There are no checks on the element length other than
5230 * having to fit into the given data.
5232 static inline const struct element *
5233 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5235 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5240 * cfg80211_find_ext_ie - find information element with EID Extension in data
5242 * @ext_eid: element ID Extension
5243 * @ies: data consisting of IEs
5244 * @len: length of data
5246 * Return: %NULL if the extended element ID could not be found or if
5247 * the element is invalid (claims to be longer than the given
5248 * data), or a pointer to the first byte of the requested
5249 * element, that is the byte containing the element ID.
5251 * Note: There are no checks on the element length other than
5252 * having to fit into the given data.
5254 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5256 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5261 * cfg80211_find_vendor_elem - find vendor specific information element in data
5264 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5265 * @ies: data consisting of IEs
5266 * @len: length of data
5268 * Return: %NULL if the vendor specific element ID could not be found or if the
5269 * element is invalid (claims to be longer than the given data); otherwise
5270 * return the element structure for the requested element.
5272 * Note: There are no checks on the element length other than having to fit into
5275 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5280 * cfg80211_find_vendor_ie - find vendor specific information element in data
5283 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5284 * @ies: data consisting of IEs
5285 * @len: length of data
5287 * Return: %NULL if the vendor specific element ID could not be found or if the
5288 * element is invalid (claims to be longer than the given data), or a pointer to
5289 * the first byte of the requested element, that is the byte containing the
5292 * Note: There are no checks on the element length other than having to fit into
5295 static inline const u8 *
5296 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5297 const u8 *ies, unsigned int len)
5299 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5303 * cfg80211_send_layer2_update - send layer 2 update frame
5305 * @dev: network device
5306 * @addr: STA MAC address
5308 * Wireless drivers can use this function to update forwarding tables in bridge
5309 * devices upon STA association.
5311 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5314 * DOC: Regulatory enforcement infrastructure
5320 * regulatory_hint - driver hint to the wireless core a regulatory domain
5321 * @wiphy: the wireless device giving the hint (used only for reporting
5323 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5324 * should be in. If @rd is set this should be NULL. Note that if you
5325 * set this to NULL you should still set rd->alpha2 to some accepted
5328 * Wireless drivers can use this function to hint to the wireless core
5329 * what it believes should be the current regulatory domain by
5330 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5331 * domain should be in or by providing a completely build regulatory domain.
5332 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5333 * for a regulatory domain structure for the respective country.
5335 * The wiphy must have been registered to cfg80211 prior to this call.
5336 * For cfg80211 drivers this means you must first use wiphy_register(),
5337 * for mac80211 drivers you must first use ieee80211_register_hw().
5339 * Drivers should check the return value, its possible you can get
5342 * Return: 0 on success. -ENOMEM.
5344 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5347 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5348 * @wiphy: the wireless device we want to process the regulatory domain on
5349 * @rd: the regulatory domain informatoin to use for this wiphy
5351 * Set the regulatory domain information for self-managed wiphys, only they
5352 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5355 * Return: 0 on success. -EINVAL, -EPERM
5357 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5358 struct ieee80211_regdomain *rd);
5361 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5362 * @wiphy: the wireless device we want to process the regulatory domain on
5363 * @rd: the regulatory domain information to use for this wiphy
5365 * This functions requires the RTNL to be held and applies the new regdomain
5366 * synchronously to this wiphy. For more details see
5367 * regulatory_set_wiphy_regd().
5369 * Return: 0 on success. -EINVAL, -EPERM
5371 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5372 struct ieee80211_regdomain *rd);
5375 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5376 * @wiphy: the wireless device we want to process the regulatory domain on
5377 * @regd: the custom regulatory domain to use for this wiphy
5379 * Drivers can sometimes have custom regulatory domains which do not apply
5380 * to a specific country. Drivers can use this to apply such custom regulatory
5381 * domains. This routine must be called prior to wiphy registration. The
5382 * custom regulatory domain will be trusted completely and as such previous
5383 * default channel settings will be disregarded. If no rule is found for a
5384 * channel on the regulatory domain the channel will be disabled.
5385 * Drivers using this for a wiphy should also set the wiphy flag
5386 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5387 * that called this helper.
5389 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5390 const struct ieee80211_regdomain *regd);
5393 * freq_reg_info - get regulatory information for the given frequency
5394 * @wiphy: the wiphy for which we want to process this rule for
5395 * @center_freq: Frequency in KHz for which we want regulatory information for
5397 * Use this function to get the regulatory rule for a specific frequency on
5398 * a given wireless device. If the device has a specific regulatory domain
5399 * it wants to follow we respect that unless a country IE has been received
5400 * and processed already.
5402 * Return: A valid pointer, or, when an error occurs, for example if no rule
5403 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5404 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5405 * value will be -ERANGE if we determine the given center_freq does not even
5406 * have a regulatory rule for a frequency range in the center_freq's band.
5407 * See freq_in_rule_band() for our current definition of a band -- this is
5408 * purely subjective and right now it's 802.11 specific.
5410 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5414 * reg_initiator_name - map regulatory request initiator enum to name
5415 * @initiator: the regulatory request initiator
5417 * You can use this to map the regulatory request initiator enum to a
5418 * proper string representation.
5420 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5423 * DOC: Internal regulatory db functions
5428 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
5429 * Regulatory self-managed driver can use it to proactively
5431 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5432 * @freq: the freqency(in MHz) to be queried.
5433 * @rule: pointer to store the wmm rule from the regulatory db.
5435 * Self-managed wireless drivers can use this function to query
5436 * the internal regulatory database to check whether the given
5437 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5439 * Drivers should check the return value, its possible you can get
5442 * Return: 0 on success. -ENODATA.
5444 int reg_query_regdb_wmm(char *alpha2, int freq,
5445 struct ieee80211_reg_rule *rule);
5448 * callbacks for asynchronous cfg80211 methods, notification
5449 * functions and BSS handling helpers
5453 * cfg80211_scan_done - notify that scan finished
5455 * @request: the corresponding scan request
5456 * @info: information about the completed scan
5458 void cfg80211_scan_done(struct cfg80211_scan_request *request,
5459 struct cfg80211_scan_info *info);
5462 * cfg80211_sched_scan_results - notify that new scan results are available
5464 * @wiphy: the wiphy which got scheduled scan results
5465 * @reqid: identifier for the related scheduled scan request
5467 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
5470 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5472 * @wiphy: the wiphy on which the scheduled scan stopped
5473 * @reqid: identifier for the related scheduled scan request
5475 * The driver can call this function to inform cfg80211 that the
5476 * scheduled scan had to be stopped, for whatever reason. The driver
5477 * is then called back via the sched_scan_stop operation when done.
5479 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
5482 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5484 * @wiphy: the wiphy on which the scheduled scan stopped
5485 * @reqid: identifier for the related scheduled scan request
5487 * The driver can call this function to inform cfg80211 that the
5488 * scheduled scan had to be stopped, for whatever reason. The driver
5489 * is then called back via the sched_scan_stop operation when done.
5490 * This function should be called with rtnl locked.
5492 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
5495 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5496 * @wiphy: the wiphy reporting the BSS
5497 * @data: the BSS metadata
5498 * @mgmt: the management frame (probe response or beacon)
5499 * @len: length of the management frame
5500 * @gfp: context flags
5502 * This informs cfg80211 that BSS information was found and
5503 * the BSS should be updated/added.
5505 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5506 * Or %NULL on error.
5508 struct cfg80211_bss * __must_check
5509 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
5510 struct cfg80211_inform_bss *data,
5511 struct ieee80211_mgmt *mgmt, size_t len,
5514 static inline struct cfg80211_bss * __must_check
5515 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
5516 struct ieee80211_channel *rx_channel,
5517 enum nl80211_bss_scan_width scan_width,
5518 struct ieee80211_mgmt *mgmt, size_t len,
5519 s32 signal, gfp_t gfp)
5521 struct cfg80211_inform_bss data = {
5523 .scan_width = scan_width,
5527 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5530 static inline struct cfg80211_bss * __must_check
5531 cfg80211_inform_bss_frame(struct wiphy *wiphy,
5532 struct ieee80211_channel *rx_channel,
5533 struct ieee80211_mgmt *mgmt, size_t len,
5534 s32 signal, gfp_t gfp)
5536 struct cfg80211_inform_bss data = {
5538 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5542 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5546 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5547 * @bssid: transmitter BSSID
5548 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5549 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5550 * @new_bssid: calculated nontransmitted BSSID
5552 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
5553 u8 mbssid_index, u8 *new_bssid)
5555 u64 bssid_u64 = ether_addr_to_u64(bssid);
5556 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
5559 new_bssid_u64 = bssid_u64 & ~mask;
5561 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
5563 u64_to_ether_addr(new_bssid_u64, new_bssid);
5567 * cfg80211_is_element_inherited - returns if element ID should be inherited
5568 * @element: element to check
5569 * @non_inherit_element: non inheritance element
5571 bool cfg80211_is_element_inherited(const struct element *element,
5572 const struct element *non_inherit_element);
5575 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
5577 * @ielen: length of IEs
5578 * @mbssid_elem: current MBSSID element
5579 * @sub_elem: current MBSSID subelement (profile)
5580 * @merged_ie: location of the merged profile
5581 * @max_copy_len: max merged profile length
5583 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
5584 const struct element *mbssid_elem,
5585 const struct element *sub_elem,
5586 u8 *merged_ie, size_t max_copy_len);
5589 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
5590 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
5591 * from a beacon or probe response
5592 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
5593 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
5595 enum cfg80211_bss_frame_type {
5596 CFG80211_BSS_FTYPE_UNKNOWN,
5597 CFG80211_BSS_FTYPE_BEACON,
5598 CFG80211_BSS_FTYPE_PRESP,
5602 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
5604 * @wiphy: the wiphy reporting the BSS
5605 * @data: the BSS metadata
5606 * @ftype: frame type (if known)
5607 * @bssid: the BSSID of the BSS
5608 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5609 * @capability: the capability field sent by the peer
5610 * @beacon_interval: the beacon interval announced by the peer
5611 * @ie: additional IEs sent by the peer
5612 * @ielen: length of the additional IEs
5613 * @gfp: context flags
5615 * This informs cfg80211 that BSS information was found and
5616 * the BSS should be updated/added.
5618 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5619 * Or %NULL on error.
5621 struct cfg80211_bss * __must_check
5622 cfg80211_inform_bss_data(struct wiphy *wiphy,
5623 struct cfg80211_inform_bss *data,
5624 enum cfg80211_bss_frame_type ftype,
5625 const u8 *bssid, u64 tsf, u16 capability,
5626 u16 beacon_interval, const u8 *ie, size_t ielen,
5629 static inline struct cfg80211_bss * __must_check
5630 cfg80211_inform_bss_width(struct wiphy *wiphy,
5631 struct ieee80211_channel *rx_channel,
5632 enum nl80211_bss_scan_width scan_width,
5633 enum cfg80211_bss_frame_type ftype,
5634 const u8 *bssid, u64 tsf, u16 capability,
5635 u16 beacon_interval, const u8 *ie, size_t ielen,
5636 s32 signal, gfp_t gfp)
5638 struct cfg80211_inform_bss data = {
5640 .scan_width = scan_width,
5644 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5645 capability, beacon_interval, ie, ielen,
5649 static inline struct cfg80211_bss * __must_check
5650 cfg80211_inform_bss(struct wiphy *wiphy,
5651 struct ieee80211_channel *rx_channel,
5652 enum cfg80211_bss_frame_type ftype,
5653 const u8 *bssid, u64 tsf, u16 capability,
5654 u16 beacon_interval, const u8 *ie, size_t ielen,
5655 s32 signal, gfp_t gfp)
5657 struct cfg80211_inform_bss data = {
5659 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5663 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5664 capability, beacon_interval, ie, ielen,
5669 * cfg80211_get_bss - get a BSS reference
5670 * @wiphy: the wiphy this BSS struct belongs to
5671 * @channel: the channel to search on (or %NULL)
5672 * @bssid: the desired BSSID (or %NULL)
5673 * @ssid: the desired SSID (or %NULL)
5674 * @ssid_len: length of the SSID (or 0)
5675 * @bss_type: type of BSS, see &enum ieee80211_bss_type
5676 * @privacy: privacy filter, see &enum ieee80211_privacy
5678 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
5679 struct ieee80211_channel *channel,
5681 const u8 *ssid, size_t ssid_len,
5682 enum ieee80211_bss_type bss_type,
5683 enum ieee80211_privacy privacy);
5684 static inline struct cfg80211_bss *
5685 cfg80211_get_ibss(struct wiphy *wiphy,
5686 struct ieee80211_channel *channel,
5687 const u8 *ssid, size_t ssid_len)
5689 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
5690 IEEE80211_BSS_TYPE_IBSS,
5691 IEEE80211_PRIVACY_ANY);
5695 * cfg80211_ref_bss - reference BSS struct
5696 * @wiphy: the wiphy this BSS struct belongs to
5697 * @bss: the BSS struct to reference
5699 * Increments the refcount of the given BSS struct.
5701 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5704 * cfg80211_put_bss - unref BSS struct
5705 * @wiphy: the wiphy this BSS struct belongs to
5706 * @bss: the BSS struct
5708 * Decrements the refcount of the given BSS struct.
5710 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5713 * cfg80211_unlink_bss - unlink BSS from internal data structures
5715 * @bss: the bss to remove
5717 * This function removes the given BSS from the internal data structures
5718 * thereby making it no longer show up in scan results etc. Use this
5719 * function when you detect a BSS is gone. Normally BSSes will also time
5720 * out, so it is not necessary to use this function at all.
5722 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5724 static inline enum nl80211_bss_scan_width
5725 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5727 switch (chandef->width) {
5728 case NL80211_CHAN_WIDTH_5:
5729 return NL80211_BSS_CHAN_WIDTH_5;
5730 case NL80211_CHAN_WIDTH_10:
5731 return NL80211_BSS_CHAN_WIDTH_10;
5733 return NL80211_BSS_CHAN_WIDTH_20;
5738 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5739 * @dev: network device
5740 * @buf: authentication frame (header + body)
5741 * @len: length of the frame data
5743 * This function is called whenever an authentication, disassociation or
5744 * deauthentication frame has been received and processed in station mode.
5745 * After being asked to authenticate via cfg80211_ops::auth() the driver must
5746 * call either this function or cfg80211_auth_timeout().
5747 * After being asked to associate via cfg80211_ops::assoc() the driver must
5748 * call either this function or cfg80211_auth_timeout().
5749 * While connected, the driver must calls this for received and processed
5750 * disassociation and deauthentication frames. If the frame couldn't be used
5751 * because it was unprotected, the driver must call the function
5752 * cfg80211_rx_unprot_mlme_mgmt() instead.
5754 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5756 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5759 * cfg80211_auth_timeout - notification of timed out authentication
5760 * @dev: network device
5761 * @addr: The MAC address of the device with which the authentication timed out
5763 * This function may sleep. The caller must hold the corresponding wdev's
5766 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
5769 * cfg80211_rx_assoc_resp - notification of processed association response
5770 * @dev: network device
5771 * @bss: the BSS that association was requested with, ownership of the pointer
5772 * moves to cfg80211 in this call
5773 * @buf: (Re)Association Response frame (header + body)
5774 * @len: length of the frame data
5775 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5776 * as the AC bitmap in the QoS info field
5777 * @req_ies: information elements from the (Re)Association Request frame
5778 * @req_ies_len: length of req_ies data
5780 * After being asked to associate via cfg80211_ops::assoc() the driver must
5781 * call either this function or cfg80211_auth_timeout().
5783 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5785 void cfg80211_rx_assoc_resp(struct net_device *dev,
5786 struct cfg80211_bss *bss,
5787 const u8 *buf, size_t len,
5789 const u8 *req_ies, size_t req_ies_len);
5792 * cfg80211_assoc_timeout - notification of timed out association
5793 * @dev: network device
5794 * @bss: The BSS entry with which association timed out.
5796 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5798 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
5801 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5802 * @dev: network device
5803 * @bss: The BSS entry with which association was abandoned.
5805 * Call this whenever - for reasons reported through other API, like deauth RX,
5806 * an association attempt was abandoned.
5807 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5809 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
5812 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
5813 * @dev: network device
5814 * @buf: 802.11 frame (header + body)
5815 * @len: length of the frame data
5817 * This function is called whenever deauthentication has been processed in
5818 * station mode. This includes both received deauthentication frames and
5819 * locally generated ones. This function may sleep. The caller must hold the
5820 * corresponding wdev's mutex.
5822 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5825 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
5826 * @dev: network device
5827 * @buf: deauthentication frame (header + body)
5828 * @len: length of the frame data
5830 * This function is called whenever a received deauthentication or dissassoc
5831 * frame has been dropped in station mode because of MFP being used but the
5832 * frame was not protected. This function may sleep.
5834 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5835 const u8 *buf, size_t len);
5838 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
5839 * @dev: network device
5840 * @addr: The source MAC address of the frame
5841 * @key_type: The key type that the received frame used
5842 * @key_id: Key identifier (0..3). Can be -1 if missing.
5843 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
5844 * @gfp: allocation flags
5846 * This function is called whenever the local MAC detects a MIC failure in a
5847 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
5850 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
5851 enum nl80211_key_type key_type, int key_id,
5852 const u8 *tsc, gfp_t gfp);
5855 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
5857 * @dev: network device
5858 * @bssid: the BSSID of the IBSS joined
5859 * @channel: the channel of the IBSS joined
5860 * @gfp: allocation flags
5862 * This function notifies cfg80211 that the device joined an IBSS or
5863 * switched to a different BSSID. Before this function can be called,
5864 * either a beacon has to have been received from the IBSS, or one of
5865 * the cfg80211_inform_bss{,_frame} functions must have been called
5866 * with the locally generated beacon -- this guarantees that there is
5867 * always a scan result for this IBSS. cfg80211 will handle the rest.
5869 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
5870 struct ieee80211_channel *channel, gfp_t gfp);
5873 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
5875 * @dev: network device
5876 * @macaddr: the MAC address of the new candidate
5877 * @ie: information elements advertised by the peer candidate
5878 * @ie_len: length of the information elements buffer
5879 * @gfp: allocation flags
5881 * This function notifies cfg80211 that the mesh peer candidate has been
5882 * detected, most likely via a beacon or, less likely, via a probe response.
5883 * cfg80211 then sends a notification to userspace.
5885 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
5886 const u8 *macaddr, const u8 *ie, u8 ie_len,
5887 int sig_dbm, gfp_t gfp);
5890 * DOC: RFkill integration
5892 * RFkill integration in cfg80211 is almost invisible to drivers,
5893 * as cfg80211 automatically registers an rfkill instance for each
5894 * wireless device it knows about. Soft kill is also translated
5895 * into disconnecting and turning all interfaces off, drivers are
5896 * expected to turn off the device when all interfaces are down.
5898 * However, devices may have a hard RFkill line, in which case they
5899 * also need to interact with the rfkill subsystem, via cfg80211.
5900 * They can do this with a few helper functions documented here.
5904 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
5906 * @blocked: block status
5908 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
5911 * wiphy_rfkill_start_polling - start polling rfkill
5914 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
5917 * wiphy_rfkill_stop_polling - stop polling rfkill
5920 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
5923 * DOC: Vendor commands
5925 * Occasionally, there are special protocol or firmware features that
5926 * can't be implemented very openly. For this and similar cases, the
5927 * vendor command functionality allows implementing the features with
5928 * (typically closed-source) userspace and firmware, using nl80211 as
5929 * the configuration mechanism.
5931 * A driver supporting vendor commands must register them as an array
5932 * in struct wiphy, with handlers for each one, each command has an
5933 * OUI and sub command ID to identify it.
5935 * Note that this feature should not be (ab)used to implement protocol
5936 * features that could openly be shared across drivers. In particular,
5937 * it must never be required to use vendor commands to implement any
5938 * "normal" functionality that higher-level userspace like connection
5939 * managers etc. need.
5942 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
5943 enum nl80211_commands cmd,
5944 enum nl80211_attrs attr,
5947 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
5948 struct wireless_dev *wdev,
5949 enum nl80211_commands cmd,
5950 enum nl80211_attrs attr,
5951 unsigned int portid,
5952 int vendor_event_idx,
5953 int approxlen, gfp_t gfp);
5955 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
5958 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
5960 * @approxlen: an upper bound of the length of the data that will
5961 * be put into the skb
5963 * This function allocates and pre-fills an skb for a reply to
5964 * a vendor command. Since it is intended for a reply, calling
5965 * it outside of a vendor command's doit() operation is invalid.
5967 * The returned skb is pre-filled with some identifying data in
5968 * a way that any data that is put into the skb (with skb_put(),
5969 * nla_put() or similar) will end up being within the
5970 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
5971 * with the skb is adding data for the corresponding userspace tool
5972 * which can then read that data out of the vendor data attribute.
5973 * You must not modify the skb in any other way.
5975 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
5976 * its error code as the result of the doit() operation.
5978 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5980 static inline struct sk_buff *
5981 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5983 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
5984 NL80211_ATTR_VENDOR_DATA, approxlen);
5988 * cfg80211_vendor_cmd_reply - send the reply skb
5989 * @skb: The skb, must have been allocated with
5990 * cfg80211_vendor_cmd_alloc_reply_skb()
5992 * Since calling this function will usually be the last thing
5993 * before returning from the vendor command doit() you should
5994 * return the error code. Note that this function consumes the
5995 * skb regardless of the return value.
5997 * Return: An error code or 0 on success.
5999 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6002 * cfg80211_vendor_cmd_get_sender
6005 * Return the current netlink port ID in a vendor command handler.
6006 * Valid to call only there.
6008 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6011 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6013 * @wdev: the wireless device
6014 * @event_idx: index of the vendor event in the wiphy's vendor_events
6015 * @approxlen: an upper bound of the length of the data that will
6016 * be put into the skb
6017 * @gfp: allocation flags
6019 * This function allocates and pre-fills an skb for an event on the
6020 * vendor-specific multicast group.
6022 * If wdev != NULL, both the ifindex and identifier of the specified
6023 * wireless device are added to the event message before the vendor data
6026 * When done filling the skb, call cfg80211_vendor_event() with the
6027 * skb to send the event.
6029 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6031 static inline struct sk_buff *
6032 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6033 int approxlen, int event_idx, gfp_t gfp)
6035 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6036 NL80211_ATTR_VENDOR_DATA,
6037 0, event_idx, approxlen, gfp);
6041 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6043 * @wdev: the wireless device
6044 * @event_idx: index of the vendor event in the wiphy's vendor_events
6045 * @portid: port ID of the receiver
6046 * @approxlen: an upper bound of the length of the data that will
6047 * be put into the skb
6048 * @gfp: allocation flags
6050 * This function allocates and pre-fills an skb for an event to send to
6051 * a specific (userland) socket. This socket would previously have been
6052 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6053 * care to register a netlink notifier to see when the socket closes.
6055 * If wdev != NULL, both the ifindex and identifier of the specified
6056 * wireless device are added to the event message before the vendor data
6059 * When done filling the skb, call cfg80211_vendor_event() with the
6060 * skb to send the event.
6062 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6064 static inline struct sk_buff *
6065 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6066 struct wireless_dev *wdev,
6067 unsigned int portid, int approxlen,
6068 int event_idx, gfp_t gfp)
6070 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6071 NL80211_ATTR_VENDOR_DATA,
6072 portid, event_idx, approxlen, gfp);
6076 * cfg80211_vendor_event - send the event
6077 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6078 * @gfp: allocation flags
6080 * This function sends the given @skb, which must have been allocated
6081 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6083 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6085 __cfg80211_send_event_skb(skb, gfp);
6088 #ifdef CONFIG_NL80211_TESTMODE
6092 * Test mode is a set of utility functions to allow drivers to
6093 * interact with driver-specific tools to aid, for instance,
6094 * factory programming.
6096 * This chapter describes how drivers interact with it, for more
6097 * information see the nl80211 book's chapter on it.
6101 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6103 * @approxlen: an upper bound of the length of the data that will
6104 * be put into the skb
6106 * This function allocates and pre-fills an skb for a reply to
6107 * the testmode command. Since it is intended for a reply, calling
6108 * it outside of the @testmode_cmd operation is invalid.
6110 * The returned skb is pre-filled with the wiphy index and set up in
6111 * a way that any data that is put into the skb (with skb_put(),
6112 * nla_put() or similar) will end up being within the
6113 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6114 * with the skb is adding data for the corresponding userspace tool
6115 * which can then read that data out of the testdata attribute. You
6116 * must not modify the skb in any other way.
6118 * When done, call cfg80211_testmode_reply() with the skb and return
6119 * its error code as the result of the @testmode_cmd operation.
6121 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6123 static inline struct sk_buff *
6124 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6126 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6127 NL80211_ATTR_TESTDATA, approxlen);
6131 * cfg80211_testmode_reply - send the reply skb
6132 * @skb: The skb, must have been allocated with
6133 * cfg80211_testmode_alloc_reply_skb()
6135 * Since calling this function will usually be the last thing
6136 * before returning from the @testmode_cmd you should return
6137 * the error code. Note that this function consumes the skb
6138 * regardless of the return value.
6140 * Return: An error code or 0 on success.
6142 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6144 return cfg80211_vendor_cmd_reply(skb);
6148 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6150 * @approxlen: an upper bound of the length of the data that will
6151 * be put into the skb
6152 * @gfp: allocation flags
6154 * This function allocates and pre-fills an skb for an event on the
6155 * testmode multicast group.
6157 * The returned skb is set up in the same way as with
6158 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6159 * there, you should simply add data to it that will then end up in the
6160 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6163 * When done filling the skb, call cfg80211_testmode_event() with the
6164 * skb to send the event.
6166 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6168 static inline struct sk_buff *
6169 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6171 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6172 NL80211_ATTR_TESTDATA, 0, -1,
6177 * cfg80211_testmode_event - send the event
6178 * @skb: The skb, must have been allocated with
6179 * cfg80211_testmode_alloc_event_skb()
6180 * @gfp: allocation flags
6182 * This function sends the given @skb, which must have been allocated
6183 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6186 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6188 __cfg80211_send_event_skb(skb, gfp);
6191 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6192 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6194 #define CFG80211_TESTMODE_CMD(cmd)
6195 #define CFG80211_TESTMODE_DUMP(cmd)
6199 * struct cfg80211_fils_resp_params - FILS connection response params
6200 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6201 * @kek_len: Length of @fils_kek in octets
6202 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6203 * @erp_next_seq_num is valid.
6204 * @erp_next_seq_num: The next sequence number to use in ERP message in
6205 * FILS Authentication. This value should be specified irrespective of the
6206 * status for a FILS connection.
6207 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6208 * @pmk_len: Length of @pmk in octets
6209 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6210 * used for this FILS connection (may be %NULL).
6212 struct cfg80211_fils_resp_params {
6215 bool update_erp_next_seq_num;
6216 u16 erp_next_seq_num;
6223 * struct cfg80211_connect_resp_params - Connection response params
6224 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6225 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6226 * the real status code for failures. If this call is used to report a
6227 * failure due to a timeout (e.g., not receiving an Authentication frame
6228 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6229 * indicate that this is a failure, but without a status code.
6230 * @timeout_reason is used to report the reason for the timeout in that
6232 * @bssid: The BSSID of the AP (may be %NULL)
6233 * @bss: Entry of bss to which STA got connected to, can be obtained through
6234 * cfg80211_get_bss() (may be %NULL). Only one parameter among @bssid and
6235 * @bss needs to be specified.
6236 * @req_ie: Association request IEs (may be %NULL)
6237 * @req_ie_len: Association request IEs length
6238 * @resp_ie: Association response IEs (may be %NULL)
6239 * @resp_ie_len: Association response IEs length
6240 * @fils: FILS connection response parameters.
6241 * @timeout_reason: Reason for connection timeout. This is used when the
6242 * connection fails due to a timeout instead of an explicit rejection from
6243 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6244 * not known. This value is used only if @status < 0 to indicate that the
6245 * failure is due to a timeout and not due to explicit rejection by the AP.
6246 * This value is ignored in other cases (@status >= 0).
6248 struct cfg80211_connect_resp_params {
6251 struct cfg80211_bss *bss;
6256 struct cfg80211_fils_resp_params fils;
6257 enum nl80211_timeout_reason timeout_reason;
6261 * cfg80211_connect_done - notify cfg80211 of connection result
6263 * @dev: network device
6264 * @params: connection response parameters
6265 * @gfp: allocation flags
6267 * It should be called by the underlying driver once execution of the connection
6268 * request from connect() has been completed. This is similar to
6269 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6270 * parameters. Only one of the functions among cfg80211_connect_bss(),
6271 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6272 * and cfg80211_connect_done() should be called.
6274 void cfg80211_connect_done(struct net_device *dev,
6275 struct cfg80211_connect_resp_params *params,
6279 * cfg80211_connect_bss - notify cfg80211 of connection result
6281 * @dev: network device
6282 * @bssid: the BSSID of the AP
6283 * @bss: entry of bss to which STA got connected to, can be obtained
6284 * through cfg80211_get_bss (may be %NULL)
6285 * @req_ie: association request IEs (maybe be %NULL)
6286 * @req_ie_len: association request IEs length
6287 * @resp_ie: association response IEs (may be %NULL)
6288 * @resp_ie_len: assoc response IEs length
6289 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6290 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6291 * the real status code for failures. If this call is used to report a
6292 * failure due to a timeout (e.g., not receiving an Authentication frame
6293 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6294 * indicate that this is a failure, but without a status code.
6295 * @timeout_reason is used to report the reason for the timeout in that
6297 * @gfp: allocation flags
6298 * @timeout_reason: reason for connection timeout. This is used when the
6299 * connection fails due to a timeout instead of an explicit rejection from
6300 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6301 * not known. This value is used only if @status < 0 to indicate that the
6302 * failure is due to a timeout and not due to explicit rejection by the AP.
6303 * This value is ignored in other cases (@status >= 0).
6305 * It should be called by the underlying driver once execution of the connection
6306 * request from connect() has been completed. This is similar to
6307 * cfg80211_connect_result(), but with the option of identifying the exact bss
6308 * entry for the connection. Only one of the functions among
6309 * cfg80211_connect_bss(), cfg80211_connect_result(),
6310 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6313 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6314 struct cfg80211_bss *bss, const u8 *req_ie,
6315 size_t req_ie_len, const u8 *resp_ie,
6316 size_t resp_ie_len, int status, gfp_t gfp,
6317 enum nl80211_timeout_reason timeout_reason)
6319 struct cfg80211_connect_resp_params params;
6321 memset(¶ms, 0, sizeof(params));
6322 params.status = status;
6323 params.bssid = bssid;
6325 params.req_ie = req_ie;
6326 params.req_ie_len = req_ie_len;
6327 params.resp_ie = resp_ie;
6328 params.resp_ie_len = resp_ie_len;
6329 params.timeout_reason = timeout_reason;
6331 cfg80211_connect_done(dev, ¶ms, gfp);
6335 * cfg80211_connect_result - notify cfg80211 of connection result
6337 * @dev: network device
6338 * @bssid: the BSSID of the AP
6339 * @req_ie: association request IEs (maybe be %NULL)
6340 * @req_ie_len: association request IEs length
6341 * @resp_ie: association response IEs (may be %NULL)
6342 * @resp_ie_len: assoc response IEs length
6343 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6344 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6345 * the real status code for failures.
6346 * @gfp: allocation flags
6348 * It should be called by the underlying driver once execution of the connection
6349 * request from connect() has been completed. This is similar to
6350 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6351 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6352 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6355 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6356 const u8 *req_ie, size_t req_ie_len,
6357 const u8 *resp_ie, size_t resp_ie_len,
6358 u16 status, gfp_t gfp)
6360 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6361 resp_ie_len, status, gfp,
6362 NL80211_TIMEOUT_UNSPECIFIED);
6366 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6368 * @dev: network device
6369 * @bssid: the BSSID of the AP
6370 * @req_ie: association request IEs (maybe be %NULL)
6371 * @req_ie_len: association request IEs length
6372 * @gfp: allocation flags
6373 * @timeout_reason: reason for connection timeout.
6375 * It should be called by the underlying driver whenever connect() has failed
6376 * in a sequence where no explicit authentication/association rejection was
6377 * received from the AP. This could happen, e.g., due to not being able to send
6378 * out the Authentication or Association Request frame or timing out while
6379 * waiting for the response. Only one of the functions among
6380 * cfg80211_connect_bss(), cfg80211_connect_result(),
6381 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6384 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6385 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6386 enum nl80211_timeout_reason timeout_reason)
6388 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6389 gfp, timeout_reason);
6393 * struct cfg80211_roam_info - driver initiated roaming information
6395 * @channel: the channel of the new AP
6396 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6397 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6398 * @req_ie: association request IEs (maybe be %NULL)
6399 * @req_ie_len: association request IEs length
6400 * @resp_ie: association response IEs (may be %NULL)
6401 * @resp_ie_len: assoc response IEs length
6402 * @fils: FILS related roaming information.
6404 struct cfg80211_roam_info {
6405 struct ieee80211_channel *channel;
6406 struct cfg80211_bss *bss;
6412 struct cfg80211_fils_resp_params fils;
6416 * cfg80211_roamed - notify cfg80211 of roaming
6418 * @dev: network device
6419 * @info: information about the new BSS. struct &cfg80211_roam_info.
6420 * @gfp: allocation flags
6422 * This function may be called with the driver passing either the BSSID of the
6423 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6424 * It should be called by the underlying driver whenever it roamed from one AP
6425 * to another while connected. Drivers which have roaming implemented in
6426 * firmware should pass the bss entry to avoid a race in bss entry timeout where
6427 * the bss entry of the new AP is seen in the driver, but gets timed out by the
6428 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6429 * rdev->event_work. In case of any failures, the reference is released
6430 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6431 * released while diconneting from the current bss.
6433 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
6437 * cfg80211_port_authorized - notify cfg80211 of successful security association
6439 * @dev: network device
6440 * @bssid: the BSSID of the AP
6441 * @gfp: allocation flags
6443 * This function should be called by a driver that supports 4 way handshake
6444 * offload after a security association was successfully established (i.e.,
6445 * the 4 way handshake was completed successfully). The call to this function
6446 * should be preceded with a call to cfg80211_connect_result(),
6447 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6448 * indicate the 802.11 association.
6450 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
6454 * cfg80211_disconnected - notify cfg80211 that connection was dropped
6456 * @dev: network device
6457 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6458 * @ie_len: length of IEs
6459 * @reason: reason code for the disconnection, set it to 0 if unknown
6460 * @locally_generated: disconnection was requested locally
6461 * @gfp: allocation flags
6463 * After it calls this function, the driver should enter an idle state
6464 * and not try to connect to any AP any more.
6466 void cfg80211_disconnected(struct net_device *dev, u16 reason,
6467 const u8 *ie, size_t ie_len,
6468 bool locally_generated, gfp_t gfp);
6471 * cfg80211_ready_on_channel - notification of remain_on_channel start
6472 * @wdev: wireless device
6473 * @cookie: the request cookie
6474 * @chan: The current channel (from remain_on_channel request)
6475 * @duration: Duration in milliseconds that the driver intents to remain on the
6477 * @gfp: allocation flags
6479 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
6480 struct ieee80211_channel *chan,
6481 unsigned int duration, gfp_t gfp);
6484 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6485 * @wdev: wireless device
6486 * @cookie: the request cookie
6487 * @chan: The current channel (from remain_on_channel request)
6488 * @gfp: allocation flags
6490 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
6491 struct ieee80211_channel *chan,
6495 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6497 * @sinfo: the station information
6498 * @gfp: allocation flags
6500 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
6503 * cfg80211_sinfo_release_content - release contents of station info
6504 * @sinfo: the station information
6506 * Releases any potentially allocated sub-information of the station
6507 * information, but not the struct itself (since it's typically on
6510 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
6512 kfree(sinfo->pertid);
6516 * cfg80211_new_sta - notify userspace about station
6519 * @mac_addr: the station's address
6520 * @sinfo: the station information
6521 * @gfp: allocation flags
6523 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
6524 struct station_info *sinfo, gfp_t gfp);
6527 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6529 * @mac_addr: the station's address
6530 * @sinfo: the station information/statistics
6531 * @gfp: allocation flags
6533 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
6534 struct station_info *sinfo, gfp_t gfp);
6537 * cfg80211_del_sta - notify userspace about deletion of a station
6540 * @mac_addr: the station's address
6541 * @gfp: allocation flags
6543 static inline void cfg80211_del_sta(struct net_device *dev,
6544 const u8 *mac_addr, gfp_t gfp)
6546 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
6550 * cfg80211_conn_failed - connection request failed notification
6553 * @mac_addr: the station's address
6554 * @reason: the reason for connection failure
6555 * @gfp: allocation flags
6557 * Whenever a station tries to connect to an AP and if the station
6558 * could not connect to the AP as the AP has rejected the connection
6559 * for some reasons, this function is called.
6561 * The reason for connection failure can be any of the value from
6562 * nl80211_connect_failed_reason enum
6564 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
6565 enum nl80211_connect_failed_reason reason,
6569 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
6570 * @wdev: wireless device receiving the frame
6571 * @freq: Frequency on which the frame was received in MHz
6572 * @sig_dbm: signal strength in dBm, or 0 if unknown
6573 * @buf: Management frame (header + body)
6574 * @len: length of the frame data
6575 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
6577 * This function is called whenever an Action frame is received for a station
6578 * mode interface, but is not processed in kernel.
6580 * Return: %true if a user space application has registered for this frame.
6581 * For action frames, that makes it responsible for rejecting unrecognized
6582 * action frames; %false otherwise, in which case for action frames the
6583 * driver is responsible for rejecting the frame.
6585 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
6586 const u8 *buf, size_t len, u32 flags);
6589 * cfg80211_mgmt_tx_status - notification of TX status for management frame
6590 * @wdev: wireless device receiving the frame
6591 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
6592 * @buf: Management frame (header + body)
6593 * @len: length of the frame data
6594 * @ack: Whether frame was acknowledged
6595 * @gfp: context flags
6597 * This function is called whenever a management frame was requested to be
6598 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
6599 * transmission attempt.
6601 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
6602 const u8 *buf, size_t len, bool ack, gfp_t gfp);
6606 * cfg80211_rx_control_port - notification about a received control port frame
6607 * @dev: The device the frame matched to
6608 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
6609 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
6610 * This function does not take ownership of the skb, so the caller is
6611 * responsible for any cleanup. The caller must also ensure that
6612 * skb->protocol is set appropriately.
6613 * @unencrypted: Whether the frame was received unencrypted
6615 * This function is used to inform userspace about a received control port
6616 * frame. It should only be used if userspace indicated it wants to receive
6617 * control port frames over nl80211.
6619 * The frame is the data portion of the 802.3 or 802.11 data frame with all
6620 * network layer headers removed (e.g. the raw EAPoL frame).
6622 * Return: %true if the frame was passed to userspace
6624 bool cfg80211_rx_control_port(struct net_device *dev,
6625 struct sk_buff *skb, bool unencrypted);
6628 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
6629 * @dev: network device
6630 * @rssi_event: the triggered RSSI event
6631 * @rssi_level: new RSSI level value or 0 if not available
6632 * @gfp: context flags
6634 * This function is called when a configured connection quality monitoring
6635 * rssi threshold reached event occurs.
6637 void cfg80211_cqm_rssi_notify(struct net_device *dev,
6638 enum nl80211_cqm_rssi_threshold_event rssi_event,
6639 s32 rssi_level, gfp_t gfp);
6642 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
6643 * @dev: network device
6644 * @peer: peer's MAC address
6645 * @num_packets: how many packets were lost -- should be a fixed threshold
6646 * but probably no less than maybe 50, or maybe a throughput dependent
6647 * threshold (to account for temporary interference)
6648 * @gfp: context flags
6650 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
6651 const u8 *peer, u32 num_packets, gfp_t gfp);
6654 * cfg80211_cqm_txe_notify - TX error rate event
6655 * @dev: network device
6656 * @peer: peer's MAC address
6657 * @num_packets: how many packets were lost
6658 * @rate: % of packets which failed transmission
6659 * @intvl: interval (in s) over which the TX failure threshold was breached.
6660 * @gfp: context flags
6662 * Notify userspace when configured % TX failures over number of packets in a
6663 * given interval is exceeded.
6665 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
6666 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
6669 * cfg80211_cqm_beacon_loss_notify - beacon loss event
6670 * @dev: network device
6671 * @gfp: context flags
6673 * Notify userspace about beacon loss from the connected AP.
6675 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
6678 * cfg80211_radar_event - radar detection event
6680 * @chandef: chandef for the current channel
6681 * @gfp: context flags
6683 * This function is called when a radar is detected on the current chanenl.
6685 void cfg80211_radar_event(struct wiphy *wiphy,
6686 struct cfg80211_chan_def *chandef, gfp_t gfp);
6689 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6690 * @dev: network device
6691 * @mac: MAC address of a station which opmode got modified
6692 * @sta_opmode: station's current opmode value
6693 * @gfp: context flags
6695 * Driver should call this function when station's opmode modified via action
6698 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
6699 struct sta_opmode_info *sta_opmode,
6703 * cfg80211_cac_event - Channel availability check (CAC) event
6704 * @netdev: network device
6705 * @chandef: chandef for the current channel
6706 * @event: type of event
6707 * @gfp: context flags
6709 * This function is called when a Channel availability check (CAC) is finished
6710 * or aborted. This must be called to notify the completion of a CAC process,
6711 * also by full-MAC drivers.
6713 void cfg80211_cac_event(struct net_device *netdev,
6714 const struct cfg80211_chan_def *chandef,
6715 enum nl80211_radar_event event, gfp_t gfp);
6719 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6720 * @dev: network device
6721 * @bssid: BSSID of AP (to avoid races)
6722 * @replay_ctr: new replay counter
6723 * @gfp: allocation flags
6725 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
6726 const u8 *replay_ctr, gfp_t gfp);
6729 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
6730 * @dev: network device
6731 * @index: candidate index (the smaller the index, the higher the priority)
6732 * @bssid: BSSID of AP
6733 * @preauth: Whether AP advertises support for RSN pre-authentication
6734 * @gfp: allocation flags
6736 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
6737 const u8 *bssid, bool preauth, gfp_t gfp);
6740 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
6741 * @dev: The device the frame matched to
6742 * @addr: the transmitter address
6743 * @gfp: context flags
6745 * This function is used in AP mode (only!) to inform userspace that
6746 * a spurious class 3 frame was received, to be able to deauth the
6748 * Return: %true if the frame was passed to userspace (or this failed
6749 * for a reason other than not having a subscription.)
6751 bool cfg80211_rx_spurious_frame(struct net_device *dev,
6752 const u8 *addr, gfp_t gfp);
6755 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
6756 * @dev: The device the frame matched to
6757 * @addr: the transmitter address
6758 * @gfp: context flags
6760 * This function is used in AP mode (only!) to inform userspace that
6761 * an associated station sent a 4addr frame but that wasn't expected.
6762 * It is allowed and desirable to send this event only once for each
6763 * station to avoid event flooding.
6764 * Return: %true if the frame was passed to userspace (or this failed
6765 * for a reason other than not having a subscription.)
6767 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
6768 const u8 *addr, gfp_t gfp);
6771 * cfg80211_probe_status - notify userspace about probe status
6772 * @dev: the device the probe was sent on
6773 * @addr: the address of the peer
6774 * @cookie: the cookie filled in @probe_client previously
6775 * @acked: indicates whether probe was acked or not
6776 * @ack_signal: signal strength (in dBm) of the ACK frame.
6777 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6778 * @gfp: allocation flags
6780 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
6781 u64 cookie, bool acked, s32 ack_signal,
6782 bool is_valid_ack_signal, gfp_t gfp);
6785 * cfg80211_report_obss_beacon - report beacon from other APs
6786 * @wiphy: The wiphy that received the beacon
6788 * @len: length of the frame
6789 * @freq: frequency the frame was received on
6790 * @sig_dbm: signal strength in dBm, or 0 if unknown
6792 * Use this function to report to userspace when a beacon was
6793 * received. It is not useful to call this when there is no
6794 * netdev that is in AP/GO mode.
6796 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
6797 const u8 *frame, size_t len,
6798 int freq, int sig_dbm);
6801 * cfg80211_reg_can_beacon - check if beaconing is allowed
6803 * @chandef: the channel definition
6804 * @iftype: interface type
6806 * Return: %true if there is no secondary channel or the secondary channel(s)
6807 * can be used for beaconing (i.e. is not a radar channel etc.)
6809 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
6810 struct cfg80211_chan_def *chandef,
6811 enum nl80211_iftype iftype);
6814 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
6816 * @chandef: the channel definition
6817 * @iftype: interface type
6819 * Return: %true if there is no secondary channel or the secondary channel(s)
6820 * can be used for beaconing (i.e. is not a radar channel etc.). This version
6821 * also checks if IR-relaxation conditions apply, to allow beaconing under
6822 * more permissive conditions.
6824 * Requires the RTNL to be held.
6826 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
6827 struct cfg80211_chan_def *chandef,
6828 enum nl80211_iftype iftype);
6831 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
6832 * @dev: the device which switched channels
6833 * @chandef: the new channel definition
6835 * Caller must acquire wdev_lock, therefore must only be called from sleepable
6838 void cfg80211_ch_switch_notify(struct net_device *dev,
6839 struct cfg80211_chan_def *chandef);
6842 * cfg80211_ch_switch_started_notify - notify channel switch start
6843 * @dev: the device on which the channel switch started
6844 * @chandef: the future channel definition
6845 * @count: the number of TBTTs until the channel switch happens
6847 * Inform the userspace about the channel switch that has just
6848 * started, so that it can take appropriate actions (eg. starting
6849 * channel switch on other vifs), if necessary.
6851 void cfg80211_ch_switch_started_notify(struct net_device *dev,
6852 struct cfg80211_chan_def *chandef,
6856 * ieee80211_operating_class_to_band - convert operating class to band
6858 * @operating_class: the operating class to convert
6859 * @band: band pointer to fill
6861 * Returns %true if the conversion was successful, %false otherwise.
6863 bool ieee80211_operating_class_to_band(u8 operating_class,
6864 enum nl80211_band *band);
6867 * ieee80211_chandef_to_operating_class - convert chandef to operation class
6869 * @chandef: the chandef to convert
6870 * @op_class: a pointer to the resulting operating class
6872 * Returns %true if the conversion was successful, %false otherwise.
6874 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
6878 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
6879 * @dev: the device on which the operation is requested
6880 * @peer: the MAC address of the peer device
6881 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
6882 * NL80211_TDLS_TEARDOWN)
6883 * @reason_code: the reason code for teardown request
6884 * @gfp: allocation flags
6886 * This function is used to request userspace to perform TDLS operation that
6887 * requires knowledge of keys, i.e., link setup or teardown when the AP
6888 * connection uses encryption. This is optional mechanism for the driver to use
6889 * if it can automatically determine when a TDLS link could be useful (e.g.,
6890 * based on traffic and signal strength for a peer).
6892 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
6893 enum nl80211_tdls_operation oper,
6894 u16 reason_code, gfp_t gfp);
6897 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
6898 * @rate: given rate_info to calculate bitrate from
6900 * return 0 if MCS index >= 32
6902 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
6905 * cfg80211_unregister_wdev - remove the given wdev
6906 * @wdev: struct wireless_dev to remove
6908 * Call this function only for wdevs that have no netdev assigned,
6909 * e.g. P2P Devices. It removes the device from the list so that
6910 * it can no longer be used. It is necessary to call this function
6911 * even when cfg80211 requests the removal of the interface by
6912 * calling the del_virtual_intf() callback. The function must also
6913 * be called when the driver wishes to unregister the wdev, e.g.
6914 * when the device is unbound from the driver.
6916 * Requires the RTNL to be held.
6918 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
6921 * struct cfg80211_ft_event - FT Information Elements
6923 * @ies_len: length of the FT IE in bytes
6924 * @target_ap: target AP's MAC address
6926 * @ric_ies_len: length of the RIC IE in bytes
6928 struct cfg80211_ft_event_params {
6931 const u8 *target_ap;
6937 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
6938 * @netdev: network device
6939 * @ft_event: IE information
6941 void cfg80211_ft_event(struct net_device *netdev,
6942 struct cfg80211_ft_event_params *ft_event);
6945 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
6946 * @ies: the input IE buffer
6947 * @len: the input length
6948 * @attr: the attribute ID to find
6949 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
6950 * if the function is only called to get the needed buffer size
6951 * @bufsize: size of the output buffer
6953 * The function finds a given P2P attribute in the (vendor) IEs and
6954 * copies its contents to the given buffer.
6956 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
6957 * malformed or the attribute can't be found (respectively), or the
6958 * length of the found attribute (which can be zero).
6960 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
6961 enum ieee80211_p2p_attr_id attr,
6962 u8 *buf, unsigned int bufsize);
6965 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
6966 * @ies: the IE buffer
6967 * @ielen: the length of the IE buffer
6968 * @ids: an array with element IDs that are allowed before
6969 * the split. A WLAN_EID_EXTENSION value means that the next
6970 * EID in the list is a sub-element of the EXTENSION IE.
6971 * @n_ids: the size of the element ID array
6972 * @after_ric: array IE types that come after the RIC element
6973 * @n_after_ric: size of the @after_ric array
6974 * @offset: offset where to start splitting in the buffer
6976 * This function splits an IE buffer by updating the @offset
6977 * variable to point to the location where the buffer should be
6980 * It assumes that the given IE buffer is well-formed, this
6981 * has to be guaranteed by the caller!
6983 * It also assumes that the IEs in the buffer are ordered
6984 * correctly, if not the result of using this function will not
6985 * be ordered correctly either, i.e. it does no reordering.
6987 * The function returns the offset where the next part of the
6988 * buffer starts, which may be @ielen if the entire (remainder)
6989 * of the buffer should be used.
6991 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
6992 const u8 *ids, int n_ids,
6993 const u8 *after_ric, int n_after_ric,
6997 * ieee80211_ie_split - split an IE buffer according to ordering
6998 * @ies: the IE buffer
6999 * @ielen: the length of the IE buffer
7000 * @ids: an array with element IDs that are allowed before
7001 * the split. A WLAN_EID_EXTENSION value means that the next
7002 * EID in the list is a sub-element of the EXTENSION IE.
7003 * @n_ids: the size of the element ID array
7004 * @offset: offset where to start splitting in the buffer
7006 * This function splits an IE buffer by updating the @offset
7007 * variable to point to the location where the buffer should be
7010 * It assumes that the given IE buffer is well-formed, this
7011 * has to be guaranteed by the caller!
7013 * It also assumes that the IEs in the buffer are ordered
7014 * correctly, if not the result of using this function will not
7015 * be ordered correctly either, i.e. it does no reordering.
7017 * The function returns the offset where the next part of the
7018 * buffer starts, which may be @ielen if the entire (remainder)
7019 * of the buffer should be used.
7021 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7022 const u8 *ids, int n_ids, size_t offset)
7024 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7028 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7029 * @wdev: the wireless device reporting the wakeup
7030 * @wakeup: the wakeup report
7031 * @gfp: allocation flags
7033 * This function reports that the given device woke up. If it
7034 * caused the wakeup, report the reason(s), otherwise you may
7035 * pass %NULL as the @wakeup parameter to advertise that something
7036 * else caused the wakeup.
7038 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7039 struct cfg80211_wowlan_wakeup *wakeup,
7043 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7045 * @wdev: the wireless device for which critical protocol is stopped.
7046 * @gfp: allocation flags
7048 * This function can be called by the driver to indicate it has reverted
7049 * operation back to normal. One reason could be that the duration given
7050 * by .crit_proto_start() has expired.
7052 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7055 * ieee80211_get_num_supported_channels - get number of channels device has
7058 * Return: the number of channels supported by the device.
7060 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7063 * cfg80211_check_combinations - check interface combinations
7066 * @params: the interface combinations parameter
7068 * This function can be called by the driver to check whether a
7069 * combination of interfaces and their types are allowed according to
7070 * the interface combinations.
7072 int cfg80211_check_combinations(struct wiphy *wiphy,
7073 struct iface_combination_params *params);
7076 * cfg80211_iter_combinations - iterate over matching combinations
7079 * @params: the interface combinations parameter
7080 * @iter: function to call for each matching combination
7081 * @data: pointer to pass to iter function
7083 * This function can be called by the driver to check what possible
7084 * combinations it fits in at a given moment, e.g. for channel switching
7087 int cfg80211_iter_combinations(struct wiphy *wiphy,
7088 struct iface_combination_params *params,
7089 void (*iter)(const struct ieee80211_iface_combination *c,
7094 * cfg80211_stop_iface - trigger interface disconnection
7097 * @wdev: wireless device
7098 * @gfp: context flags
7100 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7103 * Note: This doesn't need any locks and is asynchronous.
7105 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7109 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7110 * @wiphy: the wiphy to shut down
7112 * This function shuts down all interfaces belonging to this wiphy by
7113 * calling dev_close() (and treating non-netdev interfaces as needed).
7114 * It shouldn't really be used unless there are some fatal device errors
7115 * that really can't be recovered in any other way.
7117 * Callers must hold the RTNL and be able to deal with callbacks into
7118 * the driver while the function is running.
7120 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7123 * wiphy_ext_feature_set - set the extended feature flag
7125 * @wiphy: the wiphy to modify.
7126 * @ftidx: extended feature bit index.
7128 * The extended features are flagged in multiple bytes (see
7129 * &struct wiphy.@ext_features)
7131 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7132 enum nl80211_ext_feature_index ftidx)
7136 ft_byte = &wiphy->ext_features[ftidx / 8];
7137 *ft_byte |= BIT(ftidx % 8);
7141 * wiphy_ext_feature_isset - check the extended feature flag
7143 * @wiphy: the wiphy to modify.
7144 * @ftidx: extended feature bit index.
7146 * The extended features are flagged in multiple bytes (see
7147 * &struct wiphy.@ext_features)
7150 wiphy_ext_feature_isset(struct wiphy *wiphy,
7151 enum nl80211_ext_feature_index ftidx)
7155 ft_byte = wiphy->ext_features[ftidx / 8];
7156 return (ft_byte & BIT(ftidx % 8)) != 0;
7160 * cfg80211_free_nan_func - free NAN function
7161 * @f: NAN function that should be freed
7163 * Frees all the NAN function and all it's allocated members.
7165 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7168 * struct cfg80211_nan_match_params - NAN match parameters
7169 * @type: the type of the function that triggered a match. If it is
7170 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7171 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7173 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7174 * @inst_id: the local instance id
7175 * @peer_inst_id: the instance id of the peer's function
7176 * @addr: the MAC address of the peer
7177 * @info_len: the length of the &info
7178 * @info: the Service Specific Info from the peer (if any)
7179 * @cookie: unique identifier of the corresponding function
7181 struct cfg80211_nan_match_params {
7182 enum nl80211_nan_function_type type;
7192 * cfg80211_nan_match - report a match for a NAN function.
7193 * @wdev: the wireless device reporting the match
7194 * @match: match notification parameters
7195 * @gfp: allocation flags
7197 * This function reports that the a NAN function had a match. This
7198 * can be a subscribe that had a match or a solicited publish that
7199 * was sent. It can also be a follow up that was received.
7201 void cfg80211_nan_match(struct wireless_dev *wdev,
7202 struct cfg80211_nan_match_params *match, gfp_t gfp);
7205 * cfg80211_nan_func_terminated - notify about NAN function termination.
7207 * @wdev: the wireless device reporting the match
7208 * @inst_id: the local instance id
7209 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7210 * @cookie: unique NAN function identifier
7211 * @gfp: allocation flags
7213 * This function reports that the a NAN function is terminated.
7215 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7217 enum nl80211_nan_func_term_reason reason,
7218 u64 cookie, gfp_t gfp);
7220 /* ethtool helper */
7221 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7224 * cfg80211_external_auth_request - userspace request for authentication
7225 * @netdev: network device
7226 * @params: External authentication parameters
7227 * @gfp: allocation flags
7228 * Returns: 0 on success, < 0 on error
7230 int cfg80211_external_auth_request(struct net_device *netdev,
7231 struct cfg80211_external_auth_params *params,
7235 * cfg80211_pmsr_report - report peer measurement result data
7236 * @wdev: the wireless device reporting the measurement
7237 * @req: the original measurement request
7238 * @result: the result data
7239 * @gfp: allocation flags
7241 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7242 struct cfg80211_pmsr_request *req,
7243 struct cfg80211_pmsr_result *result,
7247 * cfg80211_pmsr_complete - report peer measurement completed
7248 * @wdev: the wireless device reporting the measurement
7249 * @req: the original measurement request
7250 * @gfp: allocation flags
7252 * Report that the entire measurement completed, after this
7253 * the request pointer will no longer be valid.
7255 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7256 struct cfg80211_pmsr_request *req,
7259 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7261 /* wiphy_printk helpers, similar to dev_printk */
7263 #define wiphy_printk(level, wiphy, format, args...) \
7264 dev_printk(level, &(wiphy)->dev, format, ##args)
7265 #define wiphy_emerg(wiphy, format, args...) \
7266 dev_emerg(&(wiphy)->dev, format, ##args)
7267 #define wiphy_alert(wiphy, format, args...) \
7268 dev_alert(&(wiphy)->dev, format, ##args)
7269 #define wiphy_crit(wiphy, format, args...) \
7270 dev_crit(&(wiphy)->dev, format, ##args)
7271 #define wiphy_err(wiphy, format, args...) \
7272 dev_err(&(wiphy)->dev, format, ##args)
7273 #define wiphy_warn(wiphy, format, args...) \
7274 dev_warn(&(wiphy)->dev, format, ##args)
7275 #define wiphy_notice(wiphy, format, args...) \
7276 dev_notice(&(wiphy)->dev, format, ##args)
7277 #define wiphy_info(wiphy, format, args...) \
7278 dev_info(&(wiphy)->dev, format, ##args)
7280 #define wiphy_err_ratelimited(wiphy, format, args...) \
7281 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7282 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7283 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7285 #define wiphy_debug(wiphy, format, args...) \
7286 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7288 #define wiphy_dbg(wiphy, format, args...) \
7289 dev_dbg(&(wiphy)->dev, format, ##args)
7291 #if defined(VERBOSE_DEBUG)
7292 #define wiphy_vdbg wiphy_dbg
7294 #define wiphy_vdbg(wiphy, format, args...) \
7297 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
7303 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7304 * of using a WARN/WARN_ON to get the message out, including the
7305 * file/line information and a backtrace.
7307 #define wiphy_WARN(wiphy, format, args...) \
7308 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7311 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
7312 * @netdev: network device
7313 * @owe_info: peer's owe info
7314 * @gfp: allocation flags
7316 void cfg80211_update_owe_info_event(struct net_device *netdev,
7317 struct cfg80211_update_owe_info *owe_info,
7320 #endif /* __NET_CFG80211_H */