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 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.
498 * struct cfg80211_chan_def - channel definition
499 * @chan: the (control) channel
500 * @width: channel width
501 * @center_freq1: center frequency of first segment
502 * @center_freq2: center frequency of second segment
503 * (only with 80+80 MHz)
505 struct cfg80211_chan_def {
506 struct ieee80211_channel *chan;
507 enum nl80211_chan_width width;
513 * cfg80211_get_chandef_type - return old channel type from chandef
514 * @chandef: the channel definition
516 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
517 * chandef, which must have a bandwidth allowing this conversion.
519 static inline enum nl80211_channel_type
520 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
522 switch (chandef->width) {
523 case NL80211_CHAN_WIDTH_20_NOHT:
524 return NL80211_CHAN_NO_HT;
525 case NL80211_CHAN_WIDTH_20:
526 return NL80211_CHAN_HT20;
527 case NL80211_CHAN_WIDTH_40:
528 if (chandef->center_freq1 > chandef->chan->center_freq)
529 return NL80211_CHAN_HT40PLUS;
530 return NL80211_CHAN_HT40MINUS;
533 return NL80211_CHAN_NO_HT;
538 * cfg80211_chandef_create - create channel definition using channel type
539 * @chandef: the channel definition struct to fill
540 * @channel: the control channel
541 * @chantype: the channel type
543 * Given a channel type, create a channel definition.
545 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
546 struct ieee80211_channel *channel,
547 enum nl80211_channel_type chantype);
550 * cfg80211_chandef_identical - check if two channel definitions are identical
551 * @chandef1: first channel definition
552 * @chandef2: second channel definition
554 * Return: %true if the channels defined by the channel definitions are
555 * identical, %false otherwise.
558 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
559 const struct cfg80211_chan_def *chandef2)
561 return (chandef1->chan == chandef2->chan &&
562 chandef1->width == chandef2->width &&
563 chandef1->center_freq1 == chandef2->center_freq1 &&
564 chandef1->center_freq2 == chandef2->center_freq2);
568 * cfg80211_chandef_compatible - check if two channel definitions are compatible
569 * @chandef1: first channel definition
570 * @chandef2: second channel definition
572 * Return: %NULL if the given channel definitions are incompatible,
573 * chandef1 or chandef2 otherwise.
575 const struct cfg80211_chan_def *
576 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
577 const struct cfg80211_chan_def *chandef2);
580 * cfg80211_chandef_valid - check if a channel definition is valid
581 * @chandef: the channel definition to check
582 * Return: %true if the channel definition is valid. %false otherwise.
584 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
587 * cfg80211_chandef_usable - check if secondary channels can be used
588 * @wiphy: the wiphy to validate against
589 * @chandef: the channel definition to check
590 * @prohibited_flags: the regulatory channel flags that must not be set
591 * Return: %true if secondary channels are usable. %false otherwise.
593 bool cfg80211_chandef_usable(struct wiphy *wiphy,
594 const struct cfg80211_chan_def *chandef,
595 u32 prohibited_flags);
598 * cfg80211_chandef_dfs_required - checks if radar detection is required
599 * @wiphy: the wiphy to validate against
600 * @chandef: the channel definition to check
601 * @iftype: the interface type as specified in &enum nl80211_iftype
603 * 1 if radar detection is required, 0 if it is not, < 0 on error
605 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
606 const struct cfg80211_chan_def *chandef,
607 enum nl80211_iftype iftype);
610 * ieee80211_chandef_rate_flags - returns rate flags for a channel
612 * In some channel types, not all rates may be used - for example CCK
613 * rates may not be used in 5/10 MHz channels.
615 * @chandef: channel definition for the channel
617 * Returns: rate flags which apply for this channel
619 static inline enum ieee80211_rate_flags
620 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
622 switch (chandef->width) {
623 case NL80211_CHAN_WIDTH_5:
624 return IEEE80211_RATE_SUPPORTS_5MHZ;
625 case NL80211_CHAN_WIDTH_10:
626 return IEEE80211_RATE_SUPPORTS_10MHZ;
634 * ieee80211_chandef_max_power - maximum transmission power for the chandef
636 * In some regulations, the transmit power may depend on the configured channel
637 * bandwidth which may be defined as dBm/MHz. This function returns the actual
638 * max_power for non-standard (20 MHz) channels.
640 * @chandef: channel definition for the channel
642 * Returns: maximum allowed transmission power in dBm for the chandef
645 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
647 switch (chandef->width) {
648 case NL80211_CHAN_WIDTH_5:
649 return min(chandef->chan->max_reg_power - 6,
650 chandef->chan->max_power);
651 case NL80211_CHAN_WIDTH_10:
652 return min(chandef->chan->max_reg_power - 3,
653 chandef->chan->max_power);
657 return chandef->chan->max_power;
661 * enum survey_info_flags - survey information flags
663 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
664 * @SURVEY_INFO_IN_USE: channel is currently being used
665 * @SURVEY_INFO_TIME: active time (in ms) was filled in
666 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
667 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
668 * @SURVEY_INFO_TIME_RX: receive time was filled in
669 * @SURVEY_INFO_TIME_TX: transmit time was filled in
670 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
672 * Used by the driver to indicate which info in &struct survey_info
673 * it has filled in during the get_survey().
675 enum survey_info_flags {
676 SURVEY_INFO_NOISE_DBM = BIT(0),
677 SURVEY_INFO_IN_USE = BIT(1),
678 SURVEY_INFO_TIME = BIT(2),
679 SURVEY_INFO_TIME_BUSY = BIT(3),
680 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
681 SURVEY_INFO_TIME_RX = BIT(5),
682 SURVEY_INFO_TIME_TX = BIT(6),
683 SURVEY_INFO_TIME_SCAN = BIT(7),
687 * struct survey_info - channel survey response
689 * @channel: the channel this survey record reports, may be %NULL for a single
690 * record to report global statistics
691 * @filled: bitflag of flags from &enum survey_info_flags
692 * @noise: channel noise in dBm. This and all following fields are
694 * @time: amount of time in ms the radio was turn on (on the channel)
695 * @time_busy: amount of time the primary channel was sensed busy
696 * @time_ext_busy: amount of time the extension channel was sensed busy
697 * @time_rx: amount of time the radio spent receiving data
698 * @time_tx: amount of time the radio spent transmitting data
699 * @time_scan: amount of time the radio spent for scanning
701 * Used by dump_survey() to report back per-channel survey information.
703 * This structure can later be expanded with things like
704 * channel duty cycle etc.
707 struct ieee80211_channel *channel;
718 #define CFG80211_MAX_WEP_KEYS 4
721 * struct cfg80211_crypto_settings - Crypto settings
722 * @wpa_versions: indicates which, if any, WPA versions are enabled
723 * (from enum nl80211_wpa_versions)
724 * @cipher_group: group key cipher suite (or 0 if unset)
725 * @n_ciphers_pairwise: number of AP supported unicast ciphers
726 * @ciphers_pairwise: unicast key cipher suites
727 * @n_akm_suites: number of AKM suites
728 * @akm_suites: AKM suites
729 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
730 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
731 * required to assume that the port is unauthorized until authorized by
732 * user space. Otherwise, port is marked authorized by default.
733 * @control_port_ethertype: the control port protocol that should be
734 * allowed through even on unauthorized ports
735 * @control_port_no_encrypt: TRUE to prevent encryption of control port
737 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
738 * port frames over NL80211 instead of the network interface.
739 * @wep_keys: static WEP keys, if not NULL points to an array of
740 * CFG80211_MAX_WEP_KEYS WEP keys
741 * @wep_tx_key: key index (0..3) of the default TX static WEP key
742 * @psk: PSK (for devices supporting 4-way-handshake offload)
744 struct cfg80211_crypto_settings {
747 int n_ciphers_pairwise;
748 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
750 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
752 __be16 control_port_ethertype;
753 bool control_port_no_encrypt;
754 bool control_port_over_nl80211;
755 struct key_params *wep_keys;
761 * struct cfg80211_beacon_data - beacon data
762 * @head: head portion of beacon (before TIM IE)
763 * or %NULL if not changed
764 * @tail: tail portion of beacon (after TIM IE)
765 * or %NULL if not changed
766 * @head_len: length of @head
767 * @tail_len: length of @tail
768 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
769 * @beacon_ies_len: length of beacon_ies in octets
770 * @proberesp_ies: extra information element(s) to add into Probe Response
772 * @proberesp_ies_len: length of proberesp_ies in octets
773 * @assocresp_ies: extra information element(s) to add into (Re)Association
774 * Response frames or %NULL
775 * @assocresp_ies_len: length of assocresp_ies in octets
776 * @probe_resp_len: length of probe response template (@probe_resp)
777 * @probe_resp: probe response template (AP mode only)
779 struct cfg80211_beacon_data {
780 const u8 *head, *tail;
781 const u8 *beacon_ies;
782 const u8 *proberesp_ies;
783 const u8 *assocresp_ies;
784 const u8 *probe_resp;
786 size_t head_len, tail_len;
787 size_t beacon_ies_len;
788 size_t proberesp_ies_len;
789 size_t assocresp_ies_len;
790 size_t probe_resp_len;
798 * struct cfg80211_acl_data - Access control list data
800 * @acl_policy: ACL policy to be applied on the station's
801 * entry specified by mac_addr
802 * @n_acl_entries: Number of MAC address entries passed
803 * @mac_addrs: List of MAC addresses of stations to be used for ACL
805 struct cfg80211_acl_data {
806 enum nl80211_acl_policy acl_policy;
810 struct mac_address mac_addrs[];
814 * cfg80211_bitrate_mask - masks for bitrate control
816 struct cfg80211_bitrate_mask {
819 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
820 u16 vht_mcs[NL80211_VHT_NSS_MAX];
821 enum nl80211_txrate_gi gi;
822 } control[NUM_NL80211_BANDS];
826 * struct cfg80211_ap_settings - AP configuration
828 * Used to configure an AP interface.
830 * @chandef: defines the channel to use
831 * @beacon: beacon data
832 * @beacon_interval: beacon interval
833 * @dtim_period: DTIM period
834 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
836 * @ssid_len: length of @ssid
837 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
838 * @crypto: crypto settings
839 * @privacy: the BSS uses privacy
840 * @auth_type: Authentication type (algorithm)
841 * @smps_mode: SMPS mode
842 * @inactivity_timeout: time in seconds to determine station's inactivity.
843 * @p2p_ctwindow: P2P CT Window
844 * @p2p_opp_ps: P2P opportunistic PS
845 * @acl: ACL configuration used by the drivers which has support for
846 * MAC address based access control
847 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
849 * @beacon_rate: bitrate to be used for beacons
850 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
851 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
852 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
853 * @ht_required: stations must support HT
854 * @vht_required: stations must support VHT
856 struct cfg80211_ap_settings {
857 struct cfg80211_chan_def chandef;
859 struct cfg80211_beacon_data beacon;
861 int beacon_interval, dtim_period;
864 enum nl80211_hidden_ssid hidden_ssid;
865 struct cfg80211_crypto_settings crypto;
867 enum nl80211_auth_type auth_type;
868 enum nl80211_smps_mode smps_mode;
869 int inactivity_timeout;
872 const struct cfg80211_acl_data *acl;
874 struct cfg80211_bitrate_mask beacon_rate;
876 const struct ieee80211_ht_cap *ht_cap;
877 const struct ieee80211_vht_cap *vht_cap;
878 const struct ieee80211_he_cap_elem *he_cap;
879 bool ht_required, vht_required;
883 * struct cfg80211_csa_settings - channel switch settings
885 * Used for channel switch
887 * @chandef: defines the channel to use after the switch
888 * @beacon_csa: beacon data while performing the switch
889 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
890 * @counter_offsets_presp: offsets of the counters within the probe response
891 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
892 * @n_counter_offsets_presp: number of csa counters in the probe response
893 * @beacon_after: beacon data to be used on the new channel
894 * @radar_required: whether radar detection is required on the new channel
895 * @block_tx: whether transmissions should be blocked while changing
896 * @count: number of beacons until switch
898 struct cfg80211_csa_settings {
899 struct cfg80211_chan_def chandef;
900 struct cfg80211_beacon_data beacon_csa;
901 const u16 *counter_offsets_beacon;
902 const u16 *counter_offsets_presp;
903 unsigned int n_counter_offsets_beacon;
904 unsigned int n_counter_offsets_presp;
905 struct cfg80211_beacon_data beacon_after;
911 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
914 * struct iface_combination_params - input parameters for interface combinations
916 * Used to pass interface combination parameters
918 * @num_different_channels: the number of different channels we want
919 * to use for verification
920 * @radar_detect: a bitmap where each bit corresponds to a channel
921 * width where radar detection is needed, as in the definition of
922 * &struct ieee80211_iface_combination.@radar_detect_widths
923 * @iftype_num: array with the number of interfaces of each interface
924 * type. The index is the interface type as specified in &enum
926 * @new_beacon_int: set this to the beacon interval of a new interface
927 * that's not operating yet, if such is to be checked as part of
930 struct iface_combination_params {
931 int num_different_channels;
933 int iftype_num[NUM_NL80211_IFTYPES];
938 * enum station_parameters_apply_mask - station parameter values to apply
939 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
940 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
941 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
943 * Not all station parameters have in-band "no change" signalling,
944 * for those that don't these flags will are used.
946 enum station_parameters_apply_mask {
947 STATION_PARAM_APPLY_UAPSD = BIT(0),
948 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
949 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
953 * struct station_parameters - station parameters
955 * Used to change and create a new station.
957 * @vlan: vlan interface station should belong to
958 * @supported_rates: supported rates in IEEE 802.11 format
959 * (or NULL for no change)
960 * @supported_rates_len: number of supported rates
961 * @sta_flags_mask: station flags that changed
962 * (bitmask of BIT(%NL80211_STA_FLAG_...))
963 * @sta_flags_set: station flags values
964 * (bitmask of BIT(%NL80211_STA_FLAG_...))
965 * @listen_interval: listen interval or -1 for no change
966 * @aid: AID or zero for no change
967 * @peer_aid: mesh peer AID or zero for no change
968 * @plink_action: plink action to take
969 * @plink_state: set the peer link state for a station
970 * @ht_capa: HT capabilities of station
971 * @vht_capa: VHT capabilities of station
972 * @uapsd_queues: bitmap of queues configured for uapsd. same format
973 * as the AC bitmap in the QoS info field
974 * @max_sp: max Service Period. same format as the MAX_SP in the
975 * QoS info field (but already shifted down)
976 * @sta_modify_mask: bitmap indicating which parameters changed
977 * (for those that don't have a natural "no change" value),
978 * see &enum station_parameters_apply_mask
979 * @local_pm: local link-specific mesh power save mode (no change when set
981 * @capability: station capability
982 * @ext_capab: extended capabilities of the station
983 * @ext_capab_len: number of extended capabilities
984 * @supported_channels: supported channels in IEEE 802.11 format
985 * @supported_channels_len: number of supported channels
986 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
987 * @supported_oper_classes_len: number of supported operating classes
988 * @opmode_notif: operating mode field from Operating Mode Notification
989 * @opmode_notif_used: information if operating mode field is used
990 * @support_p2p_ps: information if station supports P2P PS mechanism
991 * @he_capa: HE capabilities of station
992 * @he_capa_len: the length of the HE capabilities
994 struct station_parameters {
995 const u8 *supported_rates;
996 struct net_device *vlan;
997 u32 sta_flags_mask, sta_flags_set;
1002 u8 supported_rates_len;
1005 const struct ieee80211_ht_cap *ht_capa;
1006 const struct ieee80211_vht_cap *vht_capa;
1009 enum nl80211_mesh_power_mode local_pm;
1011 const u8 *ext_capab;
1013 const u8 *supported_channels;
1014 u8 supported_channels_len;
1015 const u8 *supported_oper_classes;
1016 u8 supported_oper_classes_len;
1018 bool opmode_notif_used;
1020 const struct ieee80211_he_cap_elem *he_capa;
1025 * struct station_del_parameters - station deletion parameters
1027 * Used to delete a station entry (or all stations).
1029 * @mac: MAC address of the station to remove or NULL to remove all stations
1030 * @subtype: Management frame subtype to use for indicating removal
1031 * (10 = Disassociation, 12 = Deauthentication)
1032 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1034 struct station_del_parameters {
1041 * enum cfg80211_station_type - the type of station being modified
1042 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1043 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1044 * unassociated (update properties for this type of client is permitted)
1045 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1046 * the AP MLME in the device
1047 * @CFG80211_STA_AP_STA: AP station on managed interface
1048 * @CFG80211_STA_IBSS: IBSS station
1049 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1050 * while TDLS setup is in progress, it moves out of this state when
1051 * being marked authorized; use this only if TDLS with external setup is
1053 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1054 * entry that is operating, has been marked authorized by userspace)
1055 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1056 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1058 enum cfg80211_station_type {
1059 CFG80211_STA_AP_CLIENT,
1060 CFG80211_STA_AP_CLIENT_UNASSOC,
1061 CFG80211_STA_AP_MLME_CLIENT,
1062 CFG80211_STA_AP_STA,
1064 CFG80211_STA_TDLS_PEER_SETUP,
1065 CFG80211_STA_TDLS_PEER_ACTIVE,
1066 CFG80211_STA_MESH_PEER_KERNEL,
1067 CFG80211_STA_MESH_PEER_USER,
1071 * cfg80211_check_station_change - validate parameter changes
1072 * @wiphy: the wiphy this operates on
1073 * @params: the new parameters for a station
1074 * @statype: the type of station being modified
1076 * Utility function for the @change_station driver method. Call this function
1077 * with the appropriate station type looking up the station (and checking that
1078 * it exists). It will verify whether the station change is acceptable, and if
1079 * not will return an error code. Note that it may modify the parameters for
1080 * backward compatibility reasons, so don't use them before calling this.
1082 int cfg80211_check_station_change(struct wiphy *wiphy,
1083 struct station_parameters *params,
1084 enum cfg80211_station_type statype);
1087 * enum station_info_rate_flags - bitrate info flags
1089 * Used by the driver to indicate the specific rate transmission
1090 * type for 802.11n transmissions.
1092 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1093 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1094 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1095 * @RATE_INFO_FLAGS_60G: 60GHz MCS
1096 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1098 enum rate_info_flags {
1099 RATE_INFO_FLAGS_MCS = BIT(0),
1100 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1101 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1102 RATE_INFO_FLAGS_60G = BIT(3),
1103 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1107 * enum rate_info_bw - rate bandwidth information
1109 * Used by the driver to indicate the rate bandwidth.
1111 * @RATE_INFO_BW_5: 5 MHz bandwidth
1112 * @RATE_INFO_BW_10: 10 MHz bandwidth
1113 * @RATE_INFO_BW_20: 20 MHz bandwidth
1114 * @RATE_INFO_BW_40: 40 MHz bandwidth
1115 * @RATE_INFO_BW_80: 80 MHz bandwidth
1116 * @RATE_INFO_BW_160: 160 MHz bandwidth
1117 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1120 RATE_INFO_BW_20 = 0,
1130 * struct rate_info - bitrate information
1132 * Information about a receiving or transmitting bitrate
1134 * @flags: bitflag of flags from &enum rate_info_flags
1135 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1136 * @legacy: bitrate in 100kbit/s for 802.11abg
1137 * @nss: number of streams (VHT & HE only)
1138 * @bw: bandwidth (from &enum rate_info_bw)
1139 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1140 * @he_dcm: HE DCM value
1141 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1142 * only valid if bw is %RATE_INFO_BW_HE_RU)
1156 * enum station_info_rate_flags - bitrate info flags
1158 * Used by the driver to indicate the specific rate transmission
1159 * type for 802.11n transmissions.
1161 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1162 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1163 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1165 enum bss_param_flags {
1166 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1167 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1168 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1172 * struct sta_bss_parameters - BSS parameters for the attached station
1174 * Information about the currently associated BSS
1176 * @flags: bitflag of flags from &enum bss_param_flags
1177 * @dtim_period: DTIM period for the BSS
1178 * @beacon_interval: beacon interval
1180 struct sta_bss_parameters {
1183 u16 beacon_interval;
1187 * struct cfg80211_txq_stats - TXQ statistics for this TID
1188 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1189 * indicate the relevant values in this struct are filled
1190 * @backlog_bytes: total number of bytes currently backlogged
1191 * @backlog_packets: total number of packets currently backlogged
1192 * @flows: number of new flows seen
1193 * @drops: total number of packets dropped
1194 * @ecn_marks: total number of packets marked with ECN CE
1195 * @overlimit: number of drops due to queue space overflow
1196 * @overmemory: number of drops due to memory limit overflow
1197 * @collisions: number of hash collisions
1198 * @tx_bytes: total number of bytes dequeued
1199 * @tx_packets: total number of packets dequeued
1200 * @max_flows: maximum number of flows supported
1202 struct cfg80211_txq_stats {
1205 u32 backlog_packets;
1218 * struct cfg80211_tid_stats - per-TID statistics
1219 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1220 * indicate the relevant values in this struct are filled
1221 * @rx_msdu: number of received MSDUs
1222 * @tx_msdu: number of (attempted) transmitted MSDUs
1223 * @tx_msdu_retries: number of retries (not counting the first) for
1225 * @tx_msdu_failed: number of failed transmitted MSDUs
1226 * @txq_stats: TXQ statistics
1228 struct cfg80211_tid_stats {
1232 u64 tx_msdu_retries;
1234 struct cfg80211_txq_stats txq_stats;
1237 #define IEEE80211_MAX_CHAINS 4
1240 * struct station_info - station information
1242 * Station information filled by driver for get_station() and dump_station.
1244 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1245 * indicate the relevant values in this struct for them
1246 * @connected_time: time(in secs) since a station is last connected
1247 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1248 * @rx_bytes: bytes (size of MPDUs) received from this station
1249 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1250 * @llid: mesh local link id
1251 * @plid: mesh peer link id
1252 * @plink_state: mesh peer link state
1253 * @signal: The signal strength, type depends on the wiphy's signal_type.
1254 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1255 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1256 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1257 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1258 * @chain_signal: per-chain signal strength of last received packet in dBm
1259 * @chain_signal_avg: per-chain signal strength average in dBm
1260 * @txrate: current unicast bitrate from this station
1261 * @rxrate: current unicast bitrate to this station
1262 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1263 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1264 * @tx_retries: cumulative retry counts (MPDUs)
1265 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1266 * @rx_dropped_misc: Dropped for un-specified reason.
1267 * @bss_param: current BSS parameters
1268 * @generation: generation number for nl80211 dumps.
1269 * This number should increase every time the list of stations
1270 * changes, i.e. when a station is added or removed, so that
1271 * userspace can tell whether it got a consistent snapshot.
1272 * @assoc_req_ies: IEs from (Re)Association Request.
1273 * This is used only when in AP mode with drivers that do not use
1274 * user space MLME/SME implementation. The information is provided for
1275 * the cfg80211_new_sta() calls to notify user space of the IEs.
1276 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1277 * @sta_flags: station flags mask & values
1278 * @beacon_loss_count: Number of times beacon loss event has triggered.
1279 * @t_offset: Time offset of the station relative to this host.
1280 * @local_pm: local mesh STA power save mode
1281 * @peer_pm: peer mesh STA power save mode
1282 * @nonpeer_pm: non-peer mesh STA power save mode
1283 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1284 * towards this station.
1285 * @rx_beacon: number of beacons received from this peer
1286 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1288 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1289 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1290 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1291 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1292 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1293 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1296 struct station_info {
1309 s8 chain_signal[IEEE80211_MAX_CHAINS];
1310 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1312 struct rate_info txrate;
1313 struct rate_info rxrate;
1318 u32 rx_dropped_misc;
1319 struct sta_bss_parameters bss_param;
1320 struct nl80211_sta_flag_update sta_flags;
1324 const u8 *assoc_req_ies;
1325 size_t assoc_req_ies_len;
1327 u32 beacon_loss_count;
1329 enum nl80211_mesh_power_mode local_pm;
1330 enum nl80211_mesh_power_mode peer_pm;
1331 enum nl80211_mesh_power_mode nonpeer_pm;
1333 u32 expected_throughput;
1337 u8 rx_beacon_signal_avg;
1338 struct cfg80211_tid_stats *pertid;
1343 #if IS_ENABLED(CONFIG_CFG80211)
1345 * cfg80211_get_station - retrieve information about a given station
1346 * @dev: the device where the station is supposed to be connected to
1347 * @mac_addr: the mac address of the station of interest
1348 * @sinfo: pointer to the structure to fill with the information
1350 * Returns 0 on success and sinfo is filled with the available information
1351 * otherwise returns a negative error code and the content of sinfo has to be
1352 * considered undefined.
1354 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1355 struct station_info *sinfo);
1357 static inline int cfg80211_get_station(struct net_device *dev,
1359 struct station_info *sinfo)
1366 * enum monitor_flags - monitor flags
1368 * Monitor interface configuration flags. Note that these must be the bits
1369 * according to the nl80211 flags.
1371 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1372 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1373 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1374 * @MONITOR_FLAG_CONTROL: pass control frames
1375 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1376 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1377 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1379 enum monitor_flags {
1380 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1381 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1382 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1383 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1384 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1385 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1386 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1390 * enum mpath_info_flags - mesh path information flags
1392 * Used by the driver to indicate which info in &struct mpath_info it has filled
1393 * in during get_station() or dump_station().
1395 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1396 * @MPATH_INFO_SN: @sn filled
1397 * @MPATH_INFO_METRIC: @metric filled
1398 * @MPATH_INFO_EXPTIME: @exptime filled
1399 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1400 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1401 * @MPATH_INFO_FLAGS: @flags filled
1403 enum mpath_info_flags {
1404 MPATH_INFO_FRAME_QLEN = BIT(0),
1405 MPATH_INFO_SN = BIT(1),
1406 MPATH_INFO_METRIC = BIT(2),
1407 MPATH_INFO_EXPTIME = BIT(3),
1408 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1409 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1410 MPATH_INFO_FLAGS = BIT(6),
1414 * struct mpath_info - mesh path information
1416 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1418 * @filled: bitfield of flags from &enum mpath_info_flags
1419 * @frame_qlen: number of queued frames for this destination
1420 * @sn: target sequence number
1421 * @metric: metric (cost) of this mesh path
1422 * @exptime: expiration time for the mesh path from now, in msecs
1423 * @flags: mesh path flags
1424 * @discovery_timeout: total mesh path discovery timeout, in msecs
1425 * @discovery_retries: mesh path discovery retries
1426 * @generation: generation number for nl80211 dumps.
1427 * This number should increase every time the list of mesh paths
1428 * changes, i.e. when a station is added or removed, so that
1429 * userspace can tell whether it got a consistent snapshot.
1437 u32 discovery_timeout;
1438 u8 discovery_retries;
1445 * struct bss_parameters - BSS parameters
1447 * Used to change BSS parameters (mainly for AP mode).
1449 * @use_cts_prot: Whether to use CTS protection
1450 * (0 = no, 1 = yes, -1 = do not change)
1451 * @use_short_preamble: Whether the use of short preambles is allowed
1452 * (0 = no, 1 = yes, -1 = do not change)
1453 * @use_short_slot_time: Whether the use of short slot time is allowed
1454 * (0 = no, 1 = yes, -1 = do not change)
1455 * @basic_rates: basic rates in IEEE 802.11 format
1456 * (or NULL for no change)
1457 * @basic_rates_len: number of basic rates
1458 * @ap_isolate: do not forward packets between connected stations
1459 * @ht_opmode: HT Operation mode
1460 * (u16 = opmode, -1 = do not change)
1461 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1462 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1464 struct bss_parameters {
1466 int use_short_preamble;
1467 int use_short_slot_time;
1468 const u8 *basic_rates;
1472 s8 p2p_ctwindow, p2p_opp_ps;
1476 * struct mesh_config - 802.11s mesh configuration
1478 * These parameters can be changed while the mesh is active.
1480 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1481 * by the Mesh Peering Open message
1482 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1483 * used by the Mesh Peering Open message
1484 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1485 * the mesh peering management to close a mesh peering
1486 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1488 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1489 * be sent to establish a new peer link instance in a mesh
1490 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1491 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1493 * @auto_open_plinks: whether we should automatically open peer links when we
1494 * detect compatible mesh peers
1495 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1496 * synchronize to for 11s default synchronization method
1497 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1498 * that an originator mesh STA can send to a particular path target
1499 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1500 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1501 * a path discovery in milliseconds
1502 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1503 * receiving a PREQ shall consider the forwarding information from the
1504 * root to be valid. (TU = time unit)
1505 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1506 * which a mesh STA can send only one action frame containing a PREQ
1508 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1509 * which a mesh STA can send only one Action frame containing a PERR
1511 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1512 * it takes for an HWMP information element to propagate across the mesh
1513 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1514 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1515 * announcements are transmitted
1516 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1517 * station has access to a broader network beyond the MBSS. (This is
1518 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1519 * only means that the station will announce others it's a mesh gate, but
1520 * not necessarily using the gate announcement protocol. Still keeping the
1521 * same nomenclature to be in sync with the spec)
1522 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1523 * entity (default is TRUE - forwarding entity)
1524 * @rssi_threshold: the threshold for average signal strength of candidate
1525 * station to establish a peer link
1526 * @ht_opmode: mesh HT protection mode
1528 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1529 * receiving a proactive PREQ shall consider the forwarding information to
1530 * the root mesh STA to be valid.
1532 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1533 * PREQs are transmitted.
1534 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1535 * during which a mesh STA can send only one Action frame containing
1536 * a PREQ element for root path confirmation.
1537 * @power_mode: The default mesh power save mode which will be the initial
1538 * setting for new peer links.
1539 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1540 * after transmitting its beacon.
1541 * @plink_timeout: If no tx activity is seen from a STA we've established
1542 * peering with for longer than this time (in seconds), then remove it
1543 * from the STA's list of peers. Default is 30 minutes.
1545 struct mesh_config {
1546 u16 dot11MeshRetryTimeout;
1547 u16 dot11MeshConfirmTimeout;
1548 u16 dot11MeshHoldingTimeout;
1549 u16 dot11MeshMaxPeerLinks;
1550 u8 dot11MeshMaxRetries;
1553 bool auto_open_plinks;
1554 u32 dot11MeshNbrOffsetMaxNeighbor;
1555 u8 dot11MeshHWMPmaxPREQretries;
1556 u32 path_refresh_time;
1557 u16 min_discovery_timeout;
1558 u32 dot11MeshHWMPactivePathTimeout;
1559 u16 dot11MeshHWMPpreqMinInterval;
1560 u16 dot11MeshHWMPperrMinInterval;
1561 u16 dot11MeshHWMPnetDiameterTraversalTime;
1562 u8 dot11MeshHWMPRootMode;
1563 u16 dot11MeshHWMPRannInterval;
1564 bool dot11MeshGateAnnouncementProtocol;
1565 bool dot11MeshForwarding;
1568 u32 dot11MeshHWMPactivePathToRootTimeout;
1569 u16 dot11MeshHWMProotInterval;
1570 u16 dot11MeshHWMPconfirmationInterval;
1571 enum nl80211_mesh_power_mode power_mode;
1572 u16 dot11MeshAwakeWindowDuration;
1577 * struct mesh_setup - 802.11s mesh setup configuration
1578 * @chandef: defines the channel to use
1579 * @mesh_id: the mesh ID
1580 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1581 * @sync_method: which synchronization method to use
1582 * @path_sel_proto: which path selection protocol to use
1583 * @path_metric: which metric to use
1584 * @auth_id: which authentication method this mesh is using
1585 * @ie: vendor information elements (optional)
1586 * @ie_len: length of vendor information elements
1587 * @is_authenticated: this mesh requires authentication
1588 * @is_secure: this mesh uses security
1589 * @user_mpm: userspace handles all MPM functions
1590 * @dtim_period: DTIM period to use
1591 * @beacon_interval: beacon interval to use
1592 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1593 * @basic_rates: basic rates to use when creating the mesh
1594 * @beacon_rate: bitrate to be used for beacons
1595 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1596 * changes the channel when a radar is detected. This is required
1597 * to operate on DFS channels.
1598 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1599 * port frames over NL80211 instead of the network interface.
1601 * These parameters are fixed when the mesh is created.
1604 struct cfg80211_chan_def chandef;
1613 bool is_authenticated;
1617 u16 beacon_interval;
1618 int mcast_rate[NUM_NL80211_BANDS];
1620 struct cfg80211_bitrate_mask beacon_rate;
1621 bool userspace_handles_dfs;
1622 bool control_port_over_nl80211;
1626 * struct ocb_setup - 802.11p OCB mode setup configuration
1627 * @chandef: defines the channel to use
1629 * These parameters are fixed when connecting to the network
1632 struct cfg80211_chan_def chandef;
1636 * struct ieee80211_txq_params - TX queue parameters
1637 * @ac: AC identifier
1638 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1639 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1641 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1643 * @aifs: Arbitration interframe space [0..255]
1645 struct ieee80211_txq_params {
1654 * DOC: Scanning and BSS list handling
1656 * The scanning process itself is fairly simple, but cfg80211 offers quite
1657 * a bit of helper functionality. To start a scan, the scan operation will
1658 * be invoked with a scan definition. This scan definition contains the
1659 * channels to scan, and the SSIDs to send probe requests for (including the
1660 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1661 * probe. Additionally, a scan request may contain extra information elements
1662 * that should be added to the probe request. The IEs are guaranteed to be
1663 * well-formed, and will not exceed the maximum length the driver advertised
1664 * in the wiphy structure.
1666 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1667 * it is responsible for maintaining the BSS list; the driver should not
1668 * maintain a list itself. For this notification, various functions exist.
1670 * Since drivers do not maintain a BSS list, there are also a number of
1671 * functions to search for a BSS and obtain information about it from the
1672 * BSS structure cfg80211 maintains. The BSS list is also made available
1677 * struct cfg80211_ssid - SSID description
1679 * @ssid_len: length of the ssid
1681 struct cfg80211_ssid {
1682 u8 ssid[IEEE80211_MAX_SSID_LEN];
1687 * struct cfg80211_scan_info - information about completed scan
1688 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1689 * wireless device that requested the scan is connected to. If this
1690 * information is not available, this field is left zero.
1691 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1692 * @aborted: set to true if the scan was aborted for any reason,
1693 * userspace will be notified of that
1695 struct cfg80211_scan_info {
1697 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1702 * struct cfg80211_scan_request - scan request description
1704 * @ssids: SSIDs to scan for (active scan only)
1705 * @n_ssids: number of SSIDs
1706 * @channels: channels to scan on.
1707 * @n_channels: total number of channels to scan
1708 * @scan_width: channel width for scanning
1709 * @ie: optional information element(s) to add into Probe Request or %NULL
1710 * @ie_len: length of ie in octets
1711 * @duration: how long to listen on each channel, in TUs. If
1712 * %duration_mandatory is not set, this is the maximum dwell time and
1713 * the actual dwell time may be shorter.
1714 * @duration_mandatory: if set, the scan duration must be as specified by the
1716 * @flags: bit field of flags controlling operation
1717 * @rates: bitmap of rates to advertise for each band
1718 * @wiphy: the wiphy this was for
1719 * @scan_start: time (in jiffies) when the scan started
1720 * @wdev: the wireless device to scan for
1721 * @info: (internal) information about completed scan
1722 * @notified: (internal) scan request was notified as done or aborted
1723 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1724 * @mac_addr: MAC address used with randomisation
1725 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1726 * are 0 in the mask should be randomised, bits that are 1 should
1727 * be taken from the @mac_addr
1728 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1730 struct cfg80211_scan_request {
1731 struct cfg80211_ssid *ssids;
1734 enum nl80211_bss_scan_width scan_width;
1738 bool duration_mandatory;
1741 u32 rates[NUM_NL80211_BANDS];
1743 struct wireless_dev *wdev;
1745 u8 mac_addr[ETH_ALEN] __aligned(2);
1746 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1747 u8 bssid[ETH_ALEN] __aligned(2);
1750 struct wiphy *wiphy;
1751 unsigned long scan_start;
1752 struct cfg80211_scan_info info;
1757 struct ieee80211_channel *channels[0];
1760 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1764 get_random_bytes(buf, ETH_ALEN);
1765 for (i = 0; i < ETH_ALEN; i++) {
1767 buf[i] |= addr[i] & mask[i];
1772 * struct cfg80211_match_set - sets of attributes to match
1774 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1775 * or no match (RSSI only)
1776 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1777 * or no match (RSSI only)
1778 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1780 struct cfg80211_match_set {
1781 struct cfg80211_ssid ssid;
1787 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1789 * @interval: interval between scheduled scan iterations. In seconds.
1790 * @iterations: number of scan iterations in this scan plan. Zero means
1792 * The last scan plan will always have this parameter set to zero,
1793 * all other scan plans will have a finite number of iterations.
1795 struct cfg80211_sched_scan_plan {
1801 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1803 * @band: band of BSS which should match for RSSI level adjustment.
1804 * @delta: value of RSSI level adjustment.
1806 struct cfg80211_bss_select_adjust {
1807 enum nl80211_band band;
1812 * struct cfg80211_sched_scan_request - scheduled scan request description
1814 * @reqid: identifies this request.
1815 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1816 * @n_ssids: number of SSIDs
1817 * @n_channels: total number of channels to scan
1818 * @scan_width: channel width for scanning
1819 * @ie: optional information element(s) to add into Probe Request or %NULL
1820 * @ie_len: length of ie in octets
1821 * @flags: bit field of flags controlling operation
1822 * @match_sets: sets of parameters to be matched for a scan result
1823 * entry to be considered valid and to be passed to the host
1824 * (others are filtered out).
1825 * If ommited, all results are passed.
1826 * @n_match_sets: number of match sets
1827 * @report_results: indicates that results were reported for this request
1828 * @wiphy: the wiphy this was for
1829 * @dev: the interface
1830 * @scan_start: start time of the scheduled scan
1831 * @channels: channels to scan
1832 * @min_rssi_thold: for drivers only supporting a single threshold, this
1833 * contains the minimum over all matchsets
1834 * @mac_addr: MAC address used with randomisation
1835 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1836 * are 0 in the mask should be randomised, bits that are 1 should
1837 * be taken from the @mac_addr
1838 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1839 * index must be executed first.
1840 * @n_scan_plans: number of scan plans, at least 1.
1841 * @rcu_head: RCU callback used to free the struct
1842 * @owner_nlportid: netlink portid of owner (if this should is a request
1843 * owned by a particular socket)
1844 * @nl_owner_dead: netlink owner socket was closed - this request be freed
1845 * @list: for keeping list of requests.
1846 * @delay: delay in seconds to use before starting the first scan
1847 * cycle. The driver may ignore this parameter and start
1848 * immediately (or at any other time), if this feature is not
1850 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
1851 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
1852 * reporting in connected state to cases where a matching BSS is determined
1853 * to have better or slightly worse RSSI than the current connected BSS.
1854 * The relative RSSI threshold values are ignored in disconnected state.
1855 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
1856 * to the specified band while deciding whether a better BSS is reported
1857 * using @relative_rssi. If delta is a negative number, the BSSs that
1858 * belong to the specified band will be penalized by delta dB in relative
1861 struct cfg80211_sched_scan_request {
1863 struct cfg80211_ssid *ssids;
1866 enum nl80211_bss_scan_width scan_width;
1870 struct cfg80211_match_set *match_sets;
1874 struct cfg80211_sched_scan_plan *scan_plans;
1877 u8 mac_addr[ETH_ALEN] __aligned(2);
1878 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1880 bool relative_rssi_set;
1882 struct cfg80211_bss_select_adjust rssi_adjust;
1885 struct wiphy *wiphy;
1886 struct net_device *dev;
1887 unsigned long scan_start;
1888 bool report_results;
1889 struct rcu_head rcu_head;
1892 struct list_head list;
1895 struct ieee80211_channel *channels[0];
1899 * enum cfg80211_signal_type - signal type
1901 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1902 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1903 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1905 enum cfg80211_signal_type {
1906 CFG80211_SIGNAL_TYPE_NONE,
1907 CFG80211_SIGNAL_TYPE_MBM,
1908 CFG80211_SIGNAL_TYPE_UNSPEC,
1912 * struct cfg80211_inform_bss - BSS inform data
1913 * @chan: channel the frame was received on
1914 * @scan_width: scan width that was used
1915 * @signal: signal strength value, according to the wiphy's
1917 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1918 * received; should match the time when the frame was actually
1919 * received by the device (not just by the host, in case it was
1920 * buffered on the device) and be accurate to about 10ms.
1921 * If the frame isn't buffered, just passing the return value of
1922 * ktime_get_boot_ns() is likely appropriate.
1923 * @parent_tsf: the time at the start of reception of the first octet of the
1924 * timestamp field of the frame. The time is the TSF of the BSS specified
1926 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1927 * the BSS that requested the scan in which the beacon/probe was received.
1928 * @chains: bitmask for filled values in @chain_signal.
1929 * @chain_signal: per-chain signal strength of last received BSS in dBm.
1931 struct cfg80211_inform_bss {
1932 struct ieee80211_channel *chan;
1933 enum nl80211_bss_scan_width scan_width;
1937 u8 parent_bssid[ETH_ALEN] __aligned(2);
1939 s8 chain_signal[IEEE80211_MAX_CHAINS];
1943 * struct cfg80211_bss_ies - BSS entry IE data
1944 * @tsf: TSF contained in the frame that carried these IEs
1945 * @rcu_head: internal use, for freeing
1946 * @len: length of the IEs
1947 * @from_beacon: these IEs are known to come from a beacon
1950 struct cfg80211_bss_ies {
1952 struct rcu_head rcu_head;
1959 * struct cfg80211_bss - BSS description
1961 * This structure describes a BSS (which may also be a mesh network)
1962 * for use in scan results and similar.
1964 * @channel: channel this BSS is on
1965 * @scan_width: width of the control channel
1966 * @bssid: BSSID of the BSS
1967 * @beacon_interval: the beacon interval as from the frame
1968 * @capability: the capability field in host byte order
1969 * @ies: the information elements (Note that there is no guarantee that these
1970 * are well-formed!); this is a pointer to either the beacon_ies or
1971 * proberesp_ies depending on whether Probe Response frame has been
1972 * received. It is always non-%NULL.
1973 * @beacon_ies: the information elements from the last Beacon frame
1974 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1975 * own the beacon_ies, but they're just pointers to the ones from the
1976 * @hidden_beacon_bss struct)
1977 * @proberesp_ies: the information elements from the last Probe Response frame
1978 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1979 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1980 * that holds the beacon data. @beacon_ies is still valid, of course, and
1981 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1982 * @signal: signal strength value (type depends on the wiphy's signal_type)
1983 * @chains: bitmask for filled values in @chain_signal.
1984 * @chain_signal: per-chain signal strength of last received BSS in dBm.
1985 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1987 struct cfg80211_bss {
1988 struct ieee80211_channel *channel;
1989 enum nl80211_bss_scan_width scan_width;
1991 const struct cfg80211_bss_ies __rcu *ies;
1992 const struct cfg80211_bss_ies __rcu *beacon_ies;
1993 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1995 struct cfg80211_bss *hidden_beacon_bss;
1999 u16 beacon_interval;
2004 s8 chain_signal[IEEE80211_MAX_CHAINS];
2006 u8 priv[0] __aligned(sizeof(void *));
2010 * ieee80211_bss_get_ie - find IE with given ID
2011 * @bss: the bss to search
2014 * Note that the return value is an RCU-protected pointer, so
2015 * rcu_read_lock() must be held when calling this function.
2016 * Return: %NULL if not found.
2018 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
2022 * struct cfg80211_auth_request - Authentication request data
2024 * This structure provides information needed to complete IEEE 802.11
2027 * @bss: The BSS to authenticate with, the callee must obtain a reference
2028 * to it if it needs to keep it.
2029 * @auth_type: Authentication type (algorithm)
2030 * @ie: Extra IEs to add to Authentication frame or %NULL
2031 * @ie_len: Length of ie buffer in octets
2032 * @key_len: length of WEP key for shared key authentication
2033 * @key_idx: index of WEP key for shared key authentication
2034 * @key: WEP key for shared key authentication
2035 * @auth_data: Fields and elements in Authentication frames. This contains
2036 * the authentication frame body (non-IE and IE data), excluding the
2037 * Authentication algorithm number, i.e., starting at the Authentication
2038 * transaction sequence number field.
2039 * @auth_data_len: Length of auth_data buffer in octets
2041 struct cfg80211_auth_request {
2042 struct cfg80211_bss *bss;
2045 enum nl80211_auth_type auth_type;
2047 u8 key_len, key_idx;
2048 const u8 *auth_data;
2049 size_t auth_data_len;
2053 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2055 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2056 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2057 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2058 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2059 * authentication capability. Drivers can offload authentication to
2060 * userspace if this flag is set. Only applicable for cfg80211_connect()
2061 * request (connect callback).
2063 enum cfg80211_assoc_req_flags {
2064 ASSOC_REQ_DISABLE_HT = BIT(0),
2065 ASSOC_REQ_DISABLE_VHT = BIT(1),
2066 ASSOC_REQ_USE_RRM = BIT(2),
2067 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2071 * struct cfg80211_assoc_request - (Re)Association request data
2073 * This structure provides information needed to complete IEEE 802.11
2075 * @bss: The BSS to associate with. If the call is successful the driver is
2076 * given a reference that it must give back to cfg80211_send_rx_assoc()
2077 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2078 * association requests while already associating must be rejected.
2079 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2080 * @ie_len: Length of ie buffer in octets
2081 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2082 * @crypto: crypto settings
2083 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2084 * to indicate a request to reassociate within the ESS instead of a request
2085 * do the initial association with the ESS. When included, this is set to
2086 * the BSSID of the current association, i.e., to the value that is
2087 * included in the Current AP address field of the Reassociation Request
2089 * @flags: See &enum cfg80211_assoc_req_flags
2090 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2091 * will be used in ht_capa. Un-supported values will be ignored.
2092 * @ht_capa_mask: The bits of ht_capa which are to be used.
2093 * @vht_capa: VHT capability override
2094 * @vht_capa_mask: VHT capability mask indicating which fields to use
2095 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2096 * %NULL if FILS is not used.
2097 * @fils_kek_len: Length of fils_kek in octets
2098 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2099 * Request/Response frame or %NULL if FILS is not used. This field starts
2100 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2102 struct cfg80211_assoc_request {
2103 struct cfg80211_bss *bss;
2104 const u8 *ie, *prev_bssid;
2106 struct cfg80211_crypto_settings crypto;
2109 struct ieee80211_ht_cap ht_capa;
2110 struct ieee80211_ht_cap ht_capa_mask;
2111 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2113 size_t fils_kek_len;
2114 const u8 *fils_nonces;
2118 * struct cfg80211_deauth_request - Deauthentication request data
2120 * This structure provides information needed to complete IEEE 802.11
2123 * @bssid: the BSSID of the BSS to deauthenticate from
2124 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2125 * @ie_len: Length of ie buffer in octets
2126 * @reason_code: The reason code for the deauthentication
2127 * @local_state_change: if set, change local state only and
2128 * do not set a deauth frame
2130 struct cfg80211_deauth_request {
2135 bool local_state_change;
2139 * struct cfg80211_disassoc_request - Disassociation request data
2141 * This structure provides information needed to complete IEEE 802.11
2144 * @bss: the BSS to disassociate from
2145 * @ie: Extra IEs to add to Disassociation frame or %NULL
2146 * @ie_len: Length of ie buffer in octets
2147 * @reason_code: The reason code for the disassociation
2148 * @local_state_change: This is a request for a local state only, i.e., no
2149 * Disassociation frame is to be transmitted.
2151 struct cfg80211_disassoc_request {
2152 struct cfg80211_bss *bss;
2156 bool local_state_change;
2160 * struct cfg80211_ibss_params - IBSS parameters
2162 * This structure defines the IBSS parameters for the join_ibss()
2165 * @ssid: The SSID, will always be non-null.
2166 * @ssid_len: The length of the SSID, will always be non-zero.
2167 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2168 * search for IBSSs with a different BSSID.
2169 * @chandef: defines the channel to use if no other IBSS to join can be found
2170 * @channel_fixed: The channel should be fixed -- do not search for
2171 * IBSSs to join on other channels.
2172 * @ie: information element(s) to include in the beacon
2173 * @ie_len: length of that
2174 * @beacon_interval: beacon interval to use
2175 * @privacy: this is a protected network, keys will be configured
2177 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2178 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2179 * required to assume that the port is unauthorized until authorized by
2180 * user space. Otherwise, port is marked authorized by default.
2181 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2182 * port frames over NL80211 instead of the network interface.
2183 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2184 * changes the channel when a radar is detected. This is required
2185 * to operate on DFS channels.
2186 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2187 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2188 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2189 * will be used in ht_capa. Un-supported values will be ignored.
2190 * @ht_capa_mask: The bits of ht_capa which are to be used.
2191 * @wep_keys: static WEP keys, if not NULL points to an array of
2192 * CFG80211_MAX_WEP_KEYS WEP keys
2193 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2195 struct cfg80211_ibss_params {
2198 struct cfg80211_chan_def chandef;
2200 u8 ssid_len, ie_len;
2201 u16 beacon_interval;
2206 bool control_port_over_nl80211;
2207 bool userspace_handles_dfs;
2208 int mcast_rate[NUM_NL80211_BANDS];
2209 struct ieee80211_ht_cap ht_capa;
2210 struct ieee80211_ht_cap ht_capa_mask;
2211 struct key_params *wep_keys;
2216 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2218 * @behaviour: requested BSS selection behaviour.
2219 * @param: parameters for requestion behaviour.
2220 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2221 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2223 struct cfg80211_bss_selection {
2224 enum nl80211_bss_select_attr behaviour;
2226 enum nl80211_band band_pref;
2227 struct cfg80211_bss_select_adjust adjust;
2232 * struct cfg80211_connect_params - Connection parameters
2234 * This structure provides information needed to complete IEEE 802.11
2235 * authentication and association.
2237 * @channel: The channel to use or %NULL if not specified (auto-select based
2239 * @channel_hint: The channel of the recommended BSS for initial connection or
2240 * %NULL if not specified
2241 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2243 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2244 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2245 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2248 * @ssid_len: Length of ssid in octets
2249 * @auth_type: Authentication type (algorithm)
2250 * @ie: IEs for association request
2251 * @ie_len: Length of assoc_ie in octets
2252 * @privacy: indicates whether privacy-enabled APs should be used
2253 * @mfp: indicate whether management frame protection is used
2254 * @crypto: crypto settings
2255 * @key_len: length of WEP key for shared key authentication
2256 * @key_idx: index of WEP key for shared key authentication
2257 * @key: WEP key for shared key authentication
2258 * @flags: See &enum cfg80211_assoc_req_flags
2259 * @bg_scan_period: Background scan period in seconds
2260 * or -1 to indicate that default value is to be used.
2261 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2262 * will be used in ht_capa. Un-supported values will be ignored.
2263 * @ht_capa_mask: The bits of ht_capa which are to be used.
2264 * @vht_capa: VHT Capability overrides
2265 * @vht_capa_mask: The bits of vht_capa which are to be used.
2266 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2268 * @bss_select: criteria to be used for BSS selection.
2269 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2270 * to indicate a request to reassociate within the ESS instead of a request
2271 * do the initial association with the ESS. When included, this is set to
2272 * the BSSID of the current association, i.e., to the value that is
2273 * included in the Current AP address field of the Reassociation Request
2275 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2276 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2278 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2279 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2280 * %NULL if not specified. This specifies the domain name of ER server and
2281 * is used to construct FILS wrapped data IE.
2282 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2283 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2284 * messages. This is also used to construct FILS wrapped data IE.
2285 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2286 * keys in FILS or %NULL if not specified.
2287 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2288 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2289 * offload of 4-way handshake.
2291 struct cfg80211_connect_params {
2292 struct ieee80211_channel *channel;
2293 struct ieee80211_channel *channel_hint;
2295 const u8 *bssid_hint;
2298 enum nl80211_auth_type auth_type;
2302 enum nl80211_mfp mfp;
2303 struct cfg80211_crypto_settings crypto;
2305 u8 key_len, key_idx;
2308 struct ieee80211_ht_cap ht_capa;
2309 struct ieee80211_ht_cap ht_capa_mask;
2310 struct ieee80211_vht_cap vht_capa;
2311 struct ieee80211_vht_cap vht_capa_mask;
2313 struct cfg80211_bss_selection bss_select;
2314 const u8 *prev_bssid;
2315 const u8 *fils_erp_username;
2316 size_t fils_erp_username_len;
2317 const u8 *fils_erp_realm;
2318 size_t fils_erp_realm_len;
2319 u16 fils_erp_next_seq_num;
2320 const u8 *fils_erp_rrk;
2321 size_t fils_erp_rrk_len;
2326 * enum cfg80211_connect_params_changed - Connection parameters being updated
2328 * This enum provides information of all connect parameters that
2329 * have to be updated as part of update_connect_params() call.
2331 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2332 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2333 * username, erp sequence number and rrk) are updated
2334 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2336 enum cfg80211_connect_params_changed {
2337 UPDATE_ASSOC_IES = BIT(0),
2338 UPDATE_FILS_ERP_INFO = BIT(1),
2339 UPDATE_AUTH_TYPE = BIT(2),
2343 * enum wiphy_params_flags - set_wiphy_params bitfield values
2344 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2345 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2346 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2347 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2348 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2349 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2350 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2351 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2352 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2354 enum wiphy_params_flags {
2355 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2356 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2357 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2358 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2359 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2360 WIPHY_PARAM_DYN_ACK = 1 << 5,
2361 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2362 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2363 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2367 * struct cfg80211_pmksa - PMK Security Association
2369 * This structure is passed to the set/del_pmksa() method for PMKSA
2372 * @bssid: The AP's BSSID (may be %NULL).
2373 * @pmkid: The identifier to refer a PMKSA.
2374 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2375 * derivation by a FILS STA. Otherwise, %NULL.
2376 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2377 * the hash algorithm used to generate this.
2378 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2379 * cache identifier (may be %NULL).
2380 * @ssid_len: Length of the @ssid in octets.
2381 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2382 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2385 struct cfg80211_pmksa {
2396 * struct cfg80211_pkt_pattern - packet pattern
2397 * @mask: bitmask where to match pattern and where to ignore bytes,
2398 * one bit per byte, in same format as nl80211
2399 * @pattern: bytes to match where bitmask is 1
2400 * @pattern_len: length of pattern (in bytes)
2401 * @pkt_offset: packet offset (in bytes)
2403 * Internal note: @mask and @pattern are allocated in one chunk of
2404 * memory, free @mask only!
2406 struct cfg80211_pkt_pattern {
2407 const u8 *mask, *pattern;
2413 * struct cfg80211_wowlan_tcp - TCP connection parameters
2415 * @sock: (internal) socket for source port allocation
2416 * @src: source IP address
2417 * @dst: destination IP address
2418 * @dst_mac: destination MAC address
2419 * @src_port: source port
2420 * @dst_port: destination port
2421 * @payload_len: data payload length
2422 * @payload: data payload buffer
2423 * @payload_seq: payload sequence stamping configuration
2424 * @data_interval: interval at which to send data packets
2425 * @wake_len: wakeup payload match length
2426 * @wake_data: wakeup payload match data
2427 * @wake_mask: wakeup payload match mask
2428 * @tokens_size: length of the tokens buffer
2429 * @payload_tok: payload token usage configuration
2431 struct cfg80211_wowlan_tcp {
2432 struct socket *sock;
2434 u16 src_port, dst_port;
2435 u8 dst_mac[ETH_ALEN];
2438 struct nl80211_wowlan_tcp_data_seq payload_seq;
2441 const u8 *wake_data, *wake_mask;
2443 /* must be last, variable member */
2444 struct nl80211_wowlan_tcp_data_token payload_tok;
2448 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2450 * This structure defines the enabled WoWLAN triggers for the device.
2451 * @any: wake up on any activity -- special trigger if device continues
2452 * operating as normal during suspend
2453 * @disconnect: wake up if getting disconnected
2454 * @magic_pkt: wake up on receiving magic packet
2455 * @patterns: wake up on receiving packet matching a pattern
2456 * @n_patterns: number of patterns
2457 * @gtk_rekey_failure: wake up on GTK rekey failure
2458 * @eap_identity_req: wake up on EAP identity request packet
2459 * @four_way_handshake: wake up on 4-way handshake
2460 * @rfkill_release: wake up when rfkill is released
2461 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2462 * NULL if not configured.
2463 * @nd_config: configuration for the scan to be used for net detect wake.
2465 struct cfg80211_wowlan {
2466 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2467 eap_identity_req, four_way_handshake,
2469 struct cfg80211_pkt_pattern *patterns;
2470 struct cfg80211_wowlan_tcp *tcp;
2472 struct cfg80211_sched_scan_request *nd_config;
2476 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2478 * This structure defines coalesce rule for the device.
2479 * @delay: maximum coalescing delay in msecs.
2480 * @condition: condition for packet coalescence.
2481 * see &enum nl80211_coalesce_condition.
2482 * @patterns: array of packet patterns
2483 * @n_patterns: number of patterns
2485 struct cfg80211_coalesce_rules {
2487 enum nl80211_coalesce_condition condition;
2488 struct cfg80211_pkt_pattern *patterns;
2493 * struct cfg80211_coalesce - Packet coalescing settings
2495 * This structure defines coalescing settings.
2496 * @rules: array of coalesce rules
2497 * @n_rules: number of rules
2499 struct cfg80211_coalesce {
2500 struct cfg80211_coalesce_rules *rules;
2505 * struct cfg80211_wowlan_nd_match - information about the match
2507 * @ssid: SSID of the match that triggered the wake up
2508 * @n_channels: Number of channels where the match occurred. This
2509 * value may be zero if the driver can't report the channels.
2510 * @channels: center frequencies of the channels where a match
2513 struct cfg80211_wowlan_nd_match {
2514 struct cfg80211_ssid ssid;
2520 * struct cfg80211_wowlan_nd_info - net detect wake up information
2522 * @n_matches: Number of match information instances provided in
2523 * @matches. This value may be zero if the driver can't provide
2524 * match information.
2525 * @matches: Array of pointers to matches containing information about
2526 * the matches that triggered the wake up.
2528 struct cfg80211_wowlan_nd_info {
2530 struct cfg80211_wowlan_nd_match *matches[];
2534 * struct cfg80211_wowlan_wakeup - wakeup report
2535 * @disconnect: woke up by getting disconnected
2536 * @magic_pkt: woke up by receiving magic packet
2537 * @gtk_rekey_failure: woke up by GTK rekey failure
2538 * @eap_identity_req: woke up by EAP identity request packet
2539 * @four_way_handshake: woke up by 4-way handshake
2540 * @rfkill_release: woke up by rfkill being released
2541 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2542 * @packet_present_len: copied wakeup packet data
2543 * @packet_len: original wakeup packet length
2544 * @packet: The packet causing the wakeup, if any.
2545 * @packet_80211: For pattern match, magic packet and other data
2546 * frame triggers an 802.3 frame should be reported, for
2547 * disconnect due to deauth 802.11 frame. This indicates which
2549 * @tcp_match: TCP wakeup packet received
2550 * @tcp_connlost: TCP connection lost or failed to establish
2551 * @tcp_nomoretokens: TCP data ran out of tokens
2552 * @net_detect: if not %NULL, woke up because of net detect
2554 struct cfg80211_wowlan_wakeup {
2555 bool disconnect, magic_pkt, gtk_rekey_failure,
2556 eap_identity_req, four_way_handshake,
2557 rfkill_release, packet_80211,
2558 tcp_match, tcp_connlost, tcp_nomoretokens;
2560 u32 packet_present_len, packet_len;
2562 struct cfg80211_wowlan_nd_info *net_detect;
2566 * struct cfg80211_gtk_rekey_data - rekey data
2567 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2568 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2569 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2571 struct cfg80211_gtk_rekey_data {
2572 const u8 *kek, *kck, *replay_ctr;
2576 * struct cfg80211_update_ft_ies_params - FT IE Information
2578 * This structure provides information needed to update the fast transition IE
2580 * @md: The Mobility Domain ID, 2 Octet value
2581 * @ie: Fast Transition IEs
2582 * @ie_len: Length of ft_ie in octets
2584 struct cfg80211_update_ft_ies_params {
2591 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2593 * This structure provides information needed to transmit a mgmt frame
2595 * @chan: channel to use
2596 * @offchan: indicates wether off channel operation is required
2597 * @wait: duration for ROC
2598 * @buf: buffer to transmit
2599 * @len: buffer length
2600 * @no_cck: don't use cck rates for this frame
2601 * @dont_wait_for_ack: tells the low level not to wait for an ack
2602 * @n_csa_offsets: length of csa_offsets array
2603 * @csa_offsets: array of all the csa offsets in the frame
2605 struct cfg80211_mgmt_tx_params {
2606 struct ieee80211_channel *chan;
2612 bool dont_wait_for_ack;
2614 const u16 *csa_offsets;
2618 * struct cfg80211_dscp_exception - DSCP exception
2620 * @dscp: DSCP value that does not adhere to the user priority range definition
2621 * @up: user priority value to which the corresponding DSCP value belongs
2623 struct cfg80211_dscp_exception {
2629 * struct cfg80211_dscp_range - DSCP range definition for user priority
2631 * @low: lowest DSCP value of this user priority range, inclusive
2632 * @high: highest DSCP value of this user priority range, inclusive
2634 struct cfg80211_dscp_range {
2639 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2640 #define IEEE80211_QOS_MAP_MAX_EX 21
2641 #define IEEE80211_QOS_MAP_LEN_MIN 16
2642 #define IEEE80211_QOS_MAP_LEN_MAX \
2643 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2646 * struct cfg80211_qos_map - QoS Map Information
2648 * This struct defines the Interworking QoS map setting for DSCP values
2650 * @num_des: number of DSCP exceptions (0..21)
2651 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2652 * the user priority DSCP range definition
2653 * @up: DSCP range definition for a particular user priority
2655 struct cfg80211_qos_map {
2657 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2658 struct cfg80211_dscp_range up[8];
2662 * struct cfg80211_nan_conf - NAN configuration
2664 * This struct defines NAN configuration parameters
2666 * @master_pref: master preference (1 - 255)
2667 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2668 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2669 * (i.e. BIT(NL80211_BAND_2GHZ)).
2671 struct cfg80211_nan_conf {
2677 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2680 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2681 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2683 enum cfg80211_nan_conf_changes {
2684 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2685 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2689 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2691 * @filter: the content of the filter
2692 * @len: the length of the filter
2694 struct cfg80211_nan_func_filter {
2700 * struct cfg80211_nan_func - a NAN function
2702 * @type: &enum nl80211_nan_function_type
2703 * @service_id: the service ID of the function
2704 * @publish_type: &nl80211_nan_publish_type
2705 * @close_range: if true, the range should be limited. Threshold is
2706 * implementation specific.
2707 * @publish_bcast: if true, the solicited publish should be broadcasted
2708 * @subscribe_active: if true, the subscribe is active
2709 * @followup_id: the instance ID for follow up
2710 * @followup_reqid: the requestor instance ID for follow up
2711 * @followup_dest: MAC address of the recipient of the follow up
2712 * @ttl: time to live counter in DW.
2713 * @serv_spec_info: Service Specific Info
2714 * @serv_spec_info_len: Service Specific Info length
2715 * @srf_include: if true, SRF is inclusive
2716 * @srf_bf: Bloom Filter
2717 * @srf_bf_len: Bloom Filter length
2718 * @srf_bf_idx: Bloom Filter index
2719 * @srf_macs: SRF MAC addresses
2720 * @srf_num_macs: number of MAC addresses in SRF
2721 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2722 * @tx_filters: filters that should be transmitted in the SDF.
2723 * @num_rx_filters: length of &rx_filters.
2724 * @num_tx_filters: length of &tx_filters.
2725 * @instance_id: driver allocated id of the function.
2726 * @cookie: unique NAN function identifier.
2728 struct cfg80211_nan_func {
2729 enum nl80211_nan_function_type type;
2730 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2734 bool subscribe_active;
2737 struct mac_address followup_dest;
2739 const u8 *serv_spec_info;
2740 u8 serv_spec_info_len;
2745 struct mac_address *srf_macs;
2747 struct cfg80211_nan_func_filter *rx_filters;
2748 struct cfg80211_nan_func_filter *tx_filters;
2756 * struct cfg80211_pmk_conf - PMK configuration
2758 * @aa: authenticator address
2759 * @pmk_len: PMK length in bytes.
2760 * @pmk: the PMK material
2761 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2762 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
2765 struct cfg80211_pmk_conf {
2769 const u8 *pmk_r0_name;
2773 * struct cfg80211_external_auth_params - Trigger External authentication.
2775 * Commonly used across the external auth request and event interfaces.
2777 * @action: action type / trigger for external authentication. Only significant
2778 * for the authentication request event interface (driver to user space).
2779 * @bssid: BSSID of the peer with which the authentication has
2780 * to happen. Used by both the authentication request event and
2781 * authentication response command interface.
2782 * @ssid: SSID of the AP. Used by both the authentication request event and
2783 * authentication response command interface.
2784 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
2785 * authentication request event interface.
2786 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
2787 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
2788 * the real status code for failures. Used only for the authentication
2789 * response command interface (user space to driver).
2791 struct cfg80211_external_auth_params {
2792 enum nl80211_external_auth_action action;
2793 u8 bssid[ETH_ALEN] __aligned(2);
2794 struct cfg80211_ssid ssid;
2795 unsigned int key_mgmt_suite;
2800 * struct cfg80211_ops - backend description for wireless configuration
2802 * This struct is registered by fullmac card drivers and/or wireless stacks
2803 * in order to handle configuration requests on their interfaces.
2805 * All callbacks except where otherwise noted should return 0
2806 * on success or a negative error code.
2808 * All operations are currently invoked under rtnl for consistency with the
2809 * wireless extensions but this is subject to reevaluation as soon as this
2810 * code is used more widely and we have a first user without wext.
2812 * @suspend: wiphy device needs to be suspended. The variable @wow will
2813 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2814 * configured for the device.
2815 * @resume: wiphy device needs to be resumed
2816 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2817 * to call device_set_wakeup_enable() to enable/disable wakeup from
2820 * @add_virtual_intf: create a new virtual interface with the given name,
2821 * must set the struct wireless_dev's iftype. Beware: You must create
2822 * the new netdev in the wiphy's network namespace! Returns the struct
2823 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2824 * also set the address member in the wdev.
2826 * @del_virtual_intf: remove the virtual interface
2828 * @change_virtual_intf: change type/configuration of virtual interface,
2829 * keep the struct wireless_dev's iftype updated.
2831 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2832 * when adding a group key.
2834 * @get_key: get information about the key with the given parameters.
2835 * @mac_addr will be %NULL when requesting information for a group
2836 * key. All pointers given to the @callback function need not be valid
2837 * after it returns. This function should return an error if it is
2838 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2840 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2841 * and @key_index, return -ENOENT if the key doesn't exist.
2843 * @set_default_key: set the default key on an interface
2845 * @set_default_mgmt_key: set the default management frame key on an interface
2847 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2849 * @start_ap: Start acting in AP mode defined by the parameters.
2850 * @change_beacon: Change the beacon parameters for an access point mode
2851 * interface. This should reject the call when AP mode wasn't started.
2852 * @stop_ap: Stop being an AP, including stopping beaconing.
2854 * @add_station: Add a new station.
2855 * @del_station: Remove a station
2856 * @change_station: Modify a given station. Note that flags changes are not much
2857 * validated in cfg80211, in particular the auth/assoc/authorized flags
2858 * might come to the driver in invalid combinations -- make sure to check
2859 * them, also against the existing state! Drivers must call
2860 * cfg80211_check_station_change() to validate the information.
2861 * @get_station: get station information for the station identified by @mac
2862 * @dump_station: dump station callback -- resume dump at index @idx
2864 * @add_mpath: add a fixed mesh path
2865 * @del_mpath: delete a given mesh path
2866 * @change_mpath: change a given mesh path
2867 * @get_mpath: get a mesh path for the given parameters
2868 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2869 * @get_mpp: get a mesh proxy path for the given parameters
2870 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2871 * @join_mesh: join the mesh network with the specified parameters
2872 * (invoked with the wireless_dev mutex held)
2873 * @leave_mesh: leave the current mesh network
2874 * (invoked with the wireless_dev mutex held)
2876 * @get_mesh_config: Get the current mesh configuration
2878 * @update_mesh_config: Update mesh parameters on a running mesh.
2879 * The mask is a bitfield which tells us which parameters to
2880 * set, and which to leave alone.
2882 * @change_bss: Modify parameters for a given BSS.
2884 * @set_txq_params: Set TX queue parameters
2886 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2887 * as it doesn't implement join_mesh and needs to set the channel to
2888 * join the mesh instead.
2890 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2891 * interfaces are active this callback should reject the configuration.
2892 * If no interfaces are active or the device is down, the channel should
2893 * be stored for when a monitor interface becomes active.
2895 * @scan: Request to do a scan. If returning zero, the scan request is given
2896 * the driver, and will be valid until passed to cfg80211_scan_done().
2897 * For scan results, call cfg80211_inform_bss(); you can call this outside
2898 * the scan/scan_done bracket too.
2899 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2900 * indicate the status of the scan through cfg80211_scan_done().
2902 * @auth: Request to authenticate with the specified peer
2903 * (invoked with the wireless_dev mutex held)
2904 * @assoc: Request to (re)associate with the specified peer
2905 * (invoked with the wireless_dev mutex held)
2906 * @deauth: Request to deauthenticate from the specified peer
2907 * (invoked with the wireless_dev mutex held)
2908 * @disassoc: Request to disassociate from the specified peer
2909 * (invoked with the wireless_dev mutex held)
2911 * @connect: Connect to the ESS with the specified parameters. When connected,
2912 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2913 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2914 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2915 * from the AP or cfg80211_connect_timeout() if no frame with status code
2917 * The driver is allowed to roam to other BSSes within the ESS when the
2918 * other BSS matches the connect parameters. When such roaming is initiated
2919 * by the driver, the driver is expected to verify that the target matches
2920 * the configured security parameters and to use Reassociation Request
2921 * frame instead of Association Request frame.
2922 * The connect function can also be used to request the driver to perform a
2923 * specific roam when connected to an ESS. In that case, the prev_bssid
2924 * parameter is set to the BSSID of the currently associated BSS as an
2925 * indication of requesting reassociation.
2926 * In both the driver-initiated and new connect() call initiated roaming
2927 * cases, the result of roaming is indicated with a call to
2928 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
2929 * @update_connect_params: Update the connect parameters while connected to a
2930 * BSS. The updated parameters can be used by driver/firmware for
2931 * subsequent BSS selection (roaming) decisions and to form the
2932 * Authentication/(Re)Association Request frames. This call does not
2933 * request an immediate disassociation or reassociation with the current
2934 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
2935 * changed are defined in &enum cfg80211_connect_params_changed.
2936 * (invoked with the wireless_dev mutex held)
2937 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
2938 * connection is in progress. Once done, call cfg80211_disconnected() in
2939 * case connection was already established (invoked with the
2940 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
2942 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2943 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2945 * (invoked with the wireless_dev mutex held)
2946 * @leave_ibss: Leave the IBSS.
2947 * (invoked with the wireless_dev mutex held)
2949 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2952 * @set_wiphy_params: Notify that wiphy parameters have changed;
2953 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2954 * have changed. The actual parameter values are available in
2955 * struct wiphy. If returning an error, no value should be changed.
2957 * @set_tx_power: set the transmit power according to the parameters,
2958 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2959 * wdev may be %NULL if power was set for the wiphy, and will
2960 * always be %NULL unless the driver supports per-vif TX power
2961 * (as advertised by the nl80211 feature flag.)
2962 * @get_tx_power: store the current TX power into the dbm variable;
2963 * return 0 if successful
2965 * @set_wds_peer: set the WDS peer for a WDS interface
2967 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2968 * functions to adjust rfkill hw state
2970 * @dump_survey: get site survey information.
2972 * @remain_on_channel: Request the driver to remain awake on the specified
2973 * channel for the specified duration to complete an off-channel
2974 * operation (e.g., public action frame exchange). When the driver is
2975 * ready on the requested channel, it must indicate this with an event
2976 * notification by calling cfg80211_ready_on_channel().
2977 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2978 * This allows the operation to be terminated prior to timeout based on
2979 * the duration value.
2980 * @mgmt_tx: Transmit a management frame.
2981 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2982 * frame on another channel
2984 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2985 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2986 * used by the function, but 0 and 1 must not be touched. Additionally,
2987 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2988 * dump and return to userspace with an error, so be careful. If any data
2989 * was passed in from userspace then the data/len arguments will be present
2990 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2992 * @set_bitrate_mask: set the bitrate mask configuration
2994 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2995 * devices running firmwares capable of generating the (re) association
2996 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2997 * @del_pmksa: Delete a cached PMKID.
2998 * @flush_pmksa: Flush all cached PMKIDs.
2999 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3000 * allows the driver to adjust the dynamic ps timeout value.
3001 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3002 * After configuration, the driver should (soon) send an event indicating
3003 * the current level is above/below the configured threshold; this may
3004 * need some care when the configuration is changed (without first being
3006 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3007 * connection quality monitor. An event is to be sent only when the
3008 * signal level is found to be outside the two values. The driver should
3009 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3010 * If it is provided then there's no point providing @set_cqm_rssi_config.
3011 * @set_cqm_txe_config: Configure connection quality monitor TX error
3013 * @sched_scan_start: Tell the driver to start a scheduled scan.
3014 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3015 * given request id. This call must stop the scheduled scan and be ready
3016 * for starting a new one before it returns, i.e. @sched_scan_start may be
3017 * called immediately after that again and should not fail in that case.
3018 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3019 * stop (when this method returns 0).
3021 * @mgmt_frame_register: Notify driver that a management frame type was
3022 * registered. The callback is allowed to sleep.
3024 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3025 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3026 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3027 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3029 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3031 * @tdls_mgmt: Transmit a TDLS management frame.
3032 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3034 * @probe_client: probe an associated client, must return a cookie that it
3035 * later passes to cfg80211_probe_status().
3037 * @set_noack_map: Set the NoAck Map for the TIDs.
3039 * @get_channel: Get the current operating channel for the virtual interface.
3040 * For monitor interfaces, it should return %NULL unless there's a single
3041 * current monitoring channel.
3043 * @start_p2p_device: Start the given P2P device.
3044 * @stop_p2p_device: Stop the given P2P device.
3046 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3047 * Parameters include ACL policy, an array of MAC address of stations
3048 * and the number of MAC addresses. If there is already a list in driver
3049 * this new list replaces the existing one. Driver has to clear its ACL
3050 * when number of MAC addresses entries is passed as 0. Drivers which
3051 * advertise the support for MAC based ACL have to implement this callback.
3053 * @start_radar_detection: Start radar detection in the driver.
3055 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3056 * driver. If the SME is in the driver/firmware, this information can be
3057 * used in building Authentication and Reassociation Request frames.
3059 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3060 * for a given duration (milliseconds). The protocol is provided so the
3061 * driver can take the most appropriate actions.
3062 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3063 * reliability. This operation can not fail.
3064 * @set_coalesce: Set coalesce parameters.
3066 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3067 * responsible for veryfing if the switch is possible. Since this is
3068 * inherently tricky driver may decide to disconnect an interface later
3069 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3070 * everything. It should do it's best to verify requests and reject them
3071 * as soon as possible.
3073 * @set_qos_map: Set QoS mapping information to the driver
3075 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3076 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3077 * changes during the lifetime of the BSS.
3079 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3080 * with the given parameters; action frame exchange has been handled by
3081 * userspace so this just has to modify the TX path to take the TS into
3083 * If the admitted time is 0 just validate the parameters to make sure
3084 * the session can be created at all; it is valid to just always return
3085 * success for that but that may result in inefficient behaviour (handshake
3086 * with the peer followed by immediate teardown when the addition is later
3088 * @del_tx_ts: remove an existing TX TS
3090 * @join_ocb: join the OCB network with the specified parameters
3091 * (invoked with the wireless_dev mutex held)
3092 * @leave_ocb: leave the current OCB network
3093 * (invoked with the wireless_dev mutex held)
3095 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3096 * is responsible for continually initiating channel-switching operations
3097 * and returning to the base channel for communication with the AP.
3098 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3099 * peers must be on the base channel when the call completes.
3100 * @start_nan: Start the NAN interface.
3101 * @stop_nan: Stop the NAN interface.
3102 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3103 * On success @nan_func ownership is transferred to the driver and
3104 * it may access it outside of the scope of this function. The driver
3105 * should free the @nan_func when no longer needed by calling
3106 * cfg80211_free_nan_func().
3107 * On success the driver should assign an instance_id in the
3108 * provided @nan_func.
3109 * @del_nan_func: Delete a NAN function.
3110 * @nan_change_conf: changes NAN configuration. The changed parameters must
3111 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3112 * All other parameters must be ignored.
3114 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3116 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3117 * function should return phy stats, and interface stats otherwise.
3119 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3120 * If not deleted through @del_pmk the PMK remains valid until disconnect
3121 * upon which the driver should clear it.
3122 * (invoked with the wireless_dev mutex held)
3123 * @del_pmk: delete the previously configured PMK for the given authenticator.
3124 * (invoked with the wireless_dev mutex held)
3126 * @external_auth: indicates result of offloaded authentication processing from
3129 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3130 * tells the driver that the frame should not be encrypted.
3132 struct cfg80211_ops {
3133 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3134 int (*resume)(struct wiphy *wiphy);
3135 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3137 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3139 unsigned char name_assign_type,
3140 enum nl80211_iftype type,
3141 struct vif_params *params);
3142 int (*del_virtual_intf)(struct wiphy *wiphy,
3143 struct wireless_dev *wdev);
3144 int (*change_virtual_intf)(struct wiphy *wiphy,
3145 struct net_device *dev,
3146 enum nl80211_iftype type,
3147 struct vif_params *params);
3149 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3150 u8 key_index, bool pairwise, const u8 *mac_addr,
3151 struct key_params *params);
3152 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3153 u8 key_index, bool pairwise, const u8 *mac_addr,
3155 void (*callback)(void *cookie, struct key_params*));
3156 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3157 u8 key_index, bool pairwise, const u8 *mac_addr);
3158 int (*set_default_key)(struct wiphy *wiphy,
3159 struct net_device *netdev,
3160 u8 key_index, bool unicast, bool multicast);
3161 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3162 struct net_device *netdev,
3165 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3166 struct cfg80211_ap_settings *settings);
3167 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3168 struct cfg80211_beacon_data *info);
3169 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3172 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3174 struct station_parameters *params);
3175 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3176 struct station_del_parameters *params);
3177 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3179 struct station_parameters *params);
3180 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3181 const u8 *mac, struct station_info *sinfo);
3182 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3183 int idx, u8 *mac, struct station_info *sinfo);
3185 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3186 const u8 *dst, const u8 *next_hop);
3187 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3189 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3190 const u8 *dst, const u8 *next_hop);
3191 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3192 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3193 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3194 int idx, u8 *dst, u8 *next_hop,
3195 struct mpath_info *pinfo);
3196 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3197 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3198 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3199 int idx, u8 *dst, u8 *mpp,
3200 struct mpath_info *pinfo);
3201 int (*get_mesh_config)(struct wiphy *wiphy,
3202 struct net_device *dev,
3203 struct mesh_config *conf);
3204 int (*update_mesh_config)(struct wiphy *wiphy,
3205 struct net_device *dev, u32 mask,
3206 const struct mesh_config *nconf);
3207 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3208 const struct mesh_config *conf,
3209 const struct mesh_setup *setup);
3210 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3212 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3213 struct ocb_setup *setup);
3214 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3216 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3217 struct bss_parameters *params);
3219 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3220 struct ieee80211_txq_params *params);
3222 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3223 struct net_device *dev,
3224 struct ieee80211_channel *chan);
3226 int (*set_monitor_channel)(struct wiphy *wiphy,
3227 struct cfg80211_chan_def *chandef);
3229 int (*scan)(struct wiphy *wiphy,
3230 struct cfg80211_scan_request *request);
3231 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3233 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
3234 struct cfg80211_auth_request *req);
3235 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3236 struct cfg80211_assoc_request *req);
3237 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3238 struct cfg80211_deauth_request *req);
3239 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3240 struct cfg80211_disassoc_request *req);
3242 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
3243 struct cfg80211_connect_params *sme);
3244 int (*update_connect_params)(struct wiphy *wiphy,
3245 struct net_device *dev,
3246 struct cfg80211_connect_params *sme,
3248 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3251 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3252 struct cfg80211_ibss_params *params);
3253 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3255 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3256 int rate[NUM_NL80211_BANDS]);
3258 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3260 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3261 enum nl80211_tx_power_setting type, int mbm);
3262 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3265 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3268 void (*rfkill_poll)(struct wiphy *wiphy);
3270 #ifdef CONFIG_NL80211_TESTMODE
3271 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3272 void *data, int len);
3273 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3274 struct netlink_callback *cb,
3275 void *data, int len);
3278 int (*set_bitrate_mask)(struct wiphy *wiphy,
3279 struct net_device *dev,
3281 const struct cfg80211_bitrate_mask *mask);
3283 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3284 int idx, struct survey_info *info);
3286 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3287 struct cfg80211_pmksa *pmksa);
3288 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3289 struct cfg80211_pmksa *pmksa);
3290 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3292 int (*remain_on_channel)(struct wiphy *wiphy,
3293 struct wireless_dev *wdev,
3294 struct ieee80211_channel *chan,
3295 unsigned int duration,
3297 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
3298 struct wireless_dev *wdev,
3301 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3302 struct cfg80211_mgmt_tx_params *params,
3304 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3305 struct wireless_dev *wdev,
3308 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3309 bool enabled, int timeout);
3311 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
3312 struct net_device *dev,
3313 s32 rssi_thold, u32 rssi_hyst);
3315 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3316 struct net_device *dev,
3317 s32 rssi_low, s32 rssi_high);
3319 int (*set_cqm_txe_config)(struct wiphy *wiphy,
3320 struct net_device *dev,
3321 u32 rate, u32 pkts, u32 intvl);
3323 void (*mgmt_frame_register)(struct wiphy *wiphy,
3324 struct wireless_dev *wdev,
3325 u16 frame_type, bool reg);
3327 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3328 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3330 int (*sched_scan_start)(struct wiphy *wiphy,
3331 struct net_device *dev,
3332 struct cfg80211_sched_scan_request *request);
3333 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3336 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3337 struct cfg80211_gtk_rekey_data *data);
3339 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3340 const u8 *peer, u8 action_code, u8 dialog_token,
3341 u16 status_code, u32 peer_capability,
3342 bool initiator, const u8 *buf, size_t len);
3343 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3344 const u8 *peer, enum nl80211_tdls_operation oper);
3346 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3347 const u8 *peer, u64 *cookie);
3349 int (*set_noack_map)(struct wiphy *wiphy,
3350 struct net_device *dev,
3353 int (*get_channel)(struct wiphy *wiphy,
3354 struct wireless_dev *wdev,
3355 struct cfg80211_chan_def *chandef);
3357 int (*start_p2p_device)(struct wiphy *wiphy,
3358 struct wireless_dev *wdev);
3359 void (*stop_p2p_device)(struct wiphy *wiphy,
3360 struct wireless_dev *wdev);
3362 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3363 const struct cfg80211_acl_data *params);
3365 int (*start_radar_detection)(struct wiphy *wiphy,
3366 struct net_device *dev,
3367 struct cfg80211_chan_def *chandef,
3369 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3370 struct cfg80211_update_ft_ies_params *ftie);
3371 int (*crit_proto_start)(struct wiphy *wiphy,
3372 struct wireless_dev *wdev,
3373 enum nl80211_crit_proto_id protocol,
3375 void (*crit_proto_stop)(struct wiphy *wiphy,
3376 struct wireless_dev *wdev);
3377 int (*set_coalesce)(struct wiphy *wiphy,
3378 struct cfg80211_coalesce *coalesce);
3380 int (*channel_switch)(struct wiphy *wiphy,
3381 struct net_device *dev,
3382 struct cfg80211_csa_settings *params);
3384 int (*set_qos_map)(struct wiphy *wiphy,
3385 struct net_device *dev,
3386 struct cfg80211_qos_map *qos_map);
3388 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3389 struct cfg80211_chan_def *chandef);
3391 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3392 u8 tsid, const u8 *peer, u8 user_prio,
3394 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3395 u8 tsid, const u8 *peer);
3397 int (*tdls_channel_switch)(struct wiphy *wiphy,
3398 struct net_device *dev,
3399 const u8 *addr, u8 oper_class,
3400 struct cfg80211_chan_def *chandef);
3401 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3402 struct net_device *dev,
3404 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3405 struct cfg80211_nan_conf *conf);
3406 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3407 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3408 struct cfg80211_nan_func *nan_func);
3409 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3411 int (*nan_change_conf)(struct wiphy *wiphy,
3412 struct wireless_dev *wdev,
3413 struct cfg80211_nan_conf *conf,
3416 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
3417 struct net_device *dev,
3418 const bool enabled);
3420 int (*get_txq_stats)(struct wiphy *wiphy,
3421 struct wireless_dev *wdev,
3422 struct cfg80211_txq_stats *txqstats);
3424 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3425 const struct cfg80211_pmk_conf *conf);
3426 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3428 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3429 struct cfg80211_external_auth_params *params);
3431 int (*tx_control_port)(struct wiphy *wiphy,
3432 struct net_device *dev,
3433 const u8 *buf, size_t len,
3434 const u8 *dest, const __be16 proto,
3435 const bool noencrypt);
3439 * wireless hardware and networking interfaces structures
3440 * and registration/helper functions
3444 * enum wiphy_flags - wiphy capability flags
3446 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3448 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3449 * by default -- this flag will be set depending on the kernel's default
3450 * on wiphy_new(), but can be changed by the driver if it has a good
3451 * reason to override the default
3452 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3453 * on a VLAN interface)
3454 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3455 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3456 * control port protocol ethertype. The device also honours the
3457 * control_port_no_encrypt flag.
3458 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3459 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3460 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3461 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3463 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3464 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3465 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3466 * link setup/discovery operations internally. Setup, discovery and
3467 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3468 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3469 * used for asking the driver/firmware to perform a TDLS operation.
3470 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3471 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3472 * when there are virtual interfaces in AP mode by calling
3473 * cfg80211_report_obss_beacon().
3474 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3475 * responds to probe-requests in hardware.
3476 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3477 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3478 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3479 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3480 * beaconing mode (AP, IBSS, Mesh, ...).
3481 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3482 * before connection.
3488 WIPHY_FLAG_NETNS_OK = BIT(3),
3489 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
3490 WIPHY_FLAG_4ADDR_AP = BIT(5),
3491 WIPHY_FLAG_4ADDR_STATION = BIT(6),
3492 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
3493 WIPHY_FLAG_IBSS_RSN = BIT(8),
3494 WIPHY_FLAG_MESH_AUTH = BIT(10),
3495 /* use hole at 11 */
3496 /* use hole at 12 */
3497 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
3498 WIPHY_FLAG_AP_UAPSD = BIT(14),
3499 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
3500 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
3501 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
3502 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
3503 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
3504 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
3505 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
3506 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
3507 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
3508 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
3512 * struct ieee80211_iface_limit - limit on certain interface types
3513 * @max: maximum number of interfaces of these types
3514 * @types: interface types (bits)
3516 struct ieee80211_iface_limit {
3522 * struct ieee80211_iface_combination - possible interface combination
3524 * With this structure the driver can describe which interface
3525 * combinations it supports concurrently.
3529 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3533 * struct ieee80211_iface_limit limits1[] = {
3534 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3535 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3537 * struct ieee80211_iface_combination combination1 = {
3538 * .limits = limits1,
3539 * .n_limits = ARRAY_SIZE(limits1),
3540 * .max_interfaces = 2,
3541 * .beacon_int_infra_match = true,
3545 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3549 * struct ieee80211_iface_limit limits2[] = {
3550 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3551 * BIT(NL80211_IFTYPE_P2P_GO), },
3553 * struct ieee80211_iface_combination combination2 = {
3554 * .limits = limits2,
3555 * .n_limits = ARRAY_SIZE(limits2),
3556 * .max_interfaces = 8,
3557 * .num_different_channels = 1,
3561 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3563 * This allows for an infrastructure connection and three P2P connections.
3567 * struct ieee80211_iface_limit limits3[] = {
3568 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3569 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3570 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
3572 * struct ieee80211_iface_combination combination3 = {
3573 * .limits = limits3,
3574 * .n_limits = ARRAY_SIZE(limits3),
3575 * .max_interfaces = 4,
3576 * .num_different_channels = 2,
3580 struct ieee80211_iface_combination {
3583 * limits for the given interface types
3585 const struct ieee80211_iface_limit *limits;
3588 * @num_different_channels:
3589 * can use up to this many different channels
3591 u32 num_different_channels;
3595 * maximum number of interfaces in total allowed in this group
3601 * number of limitations
3606 * @beacon_int_infra_match:
3607 * In this combination, the beacon intervals between infrastructure
3608 * and AP types must match. This is required only in special cases.
3610 bool beacon_int_infra_match;
3613 * @radar_detect_widths:
3614 * bitmap of channel widths supported for radar detection
3616 u8 radar_detect_widths;
3619 * @radar_detect_regions:
3620 * bitmap of regions supported for radar detection
3622 u8 radar_detect_regions;
3625 * @beacon_int_min_gcd:
3626 * This interface combination supports different beacon intervals.
3629 * all beacon intervals for different interface must be same.
3631 * any beacon interval for the interface part of this combination AND
3632 * GCD of all beacon intervals from beaconing interfaces of this
3633 * combination must be greater or equal to this value.
3635 u32 beacon_int_min_gcd;
3638 struct ieee80211_txrx_stypes {
3643 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3644 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3645 * trigger that keeps the device operating as-is and
3646 * wakes up the host on any activity, for example a
3647 * received packet that passed filtering; note that the
3648 * packet should be preserved in that case
3649 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3651 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3652 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3653 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3654 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3655 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3656 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3657 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3659 enum wiphy_wowlan_support_flags {
3660 WIPHY_WOWLAN_ANY = BIT(0),
3661 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
3662 WIPHY_WOWLAN_DISCONNECT = BIT(2),
3663 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3664 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
3665 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
3666 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
3667 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
3668 WIPHY_WOWLAN_NET_DETECT = BIT(8),
3671 struct wiphy_wowlan_tcp_support {
3672 const struct nl80211_wowlan_tcp_data_token_feature *tok;
3673 u32 data_payload_max;
3674 u32 data_interval_max;
3675 u32 wake_payload_max;
3680 * struct wiphy_wowlan_support - WoWLAN support data
3681 * @flags: see &enum wiphy_wowlan_support_flags
3682 * @n_patterns: number of supported wakeup patterns
3683 * (see nl80211.h for the pattern definition)
3684 * @pattern_max_len: maximum length of each pattern
3685 * @pattern_min_len: minimum length of each pattern
3686 * @max_pkt_offset: maximum Rx packet offset
3687 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3688 * similar, but not necessarily identical, to max_match_sets for
3690 * See &struct cfg80211_sched_scan_request.@match_sets for more
3692 * @tcp: TCP wakeup support information
3694 struct wiphy_wowlan_support {
3697 int pattern_max_len;
3698 int pattern_min_len;
3700 int max_nd_match_sets;
3701 const struct wiphy_wowlan_tcp_support *tcp;
3705 * struct wiphy_coalesce_support - coalesce support data
3706 * @n_rules: maximum number of coalesce rules
3707 * @max_delay: maximum supported coalescing delay in msecs
3708 * @n_patterns: number of supported patterns in a rule
3709 * (see nl80211.h for the pattern definition)
3710 * @pattern_max_len: maximum length of each pattern
3711 * @pattern_min_len: minimum length of each pattern
3712 * @max_pkt_offset: maximum Rx packet offset
3714 struct wiphy_coalesce_support {
3718 int pattern_max_len;
3719 int pattern_min_len;
3724 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3725 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3726 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3727 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3728 * (must be combined with %_WDEV or %_NETDEV)
3730 enum wiphy_vendor_command_flags {
3731 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3732 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3733 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3737 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
3739 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
3740 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
3741 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
3744 enum wiphy_opmode_flag {
3745 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
3746 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
3747 STA_OPMODE_N_SS_CHANGED = BIT(2),
3751 * struct sta_opmode_info - Station's ht/vht operation mode information
3752 * @changed: contains value from &enum wiphy_opmode_flag
3753 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
3754 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
3755 * @rx_nss: new rx_nss value of a station
3758 struct sta_opmode_info {
3760 enum nl80211_smps_mode smps_mode;
3761 enum nl80211_chan_width bw;
3766 * struct wiphy_vendor_command - vendor command definition
3767 * @info: vendor command identifying information, as used in nl80211
3768 * @flags: flags, see &enum wiphy_vendor_command_flags
3769 * @doit: callback for the operation, note that wdev is %NULL if the
3770 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3771 * pointer may be %NULL if userspace provided no data at all
3772 * @dumpit: dump callback, for transferring bigger/multiple items. The
3773 * @storage points to cb->args[5], ie. is preserved over the multiple
3775 * It's recommended to not have the same sub command with both @doit and
3776 * @dumpit, so that userspace can assume certain ones are get and others
3777 * are used with dump requests.
3779 struct wiphy_vendor_command {
3780 struct nl80211_vendor_cmd_info info;
3782 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3783 const void *data, int data_len);
3784 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3785 struct sk_buff *skb, const void *data, int data_len,
3786 unsigned long *storage);
3790 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3791 * @iftype: interface type
3792 * @extended_capabilities: extended capabilities supported by the driver,
3793 * additional capabilities might be supported by userspace; these are the
3794 * 802.11 extended capabilities ("Extended Capabilities element") and are
3795 * in the same format as in the information element. See IEEE Std
3796 * 802.11-2012 8.4.2.29 for the defined fields.
3797 * @extended_capabilities_mask: mask of the valid values
3798 * @extended_capabilities_len: length of the extended capabilities
3800 struct wiphy_iftype_ext_capab {
3801 enum nl80211_iftype iftype;
3802 const u8 *extended_capabilities;
3803 const u8 *extended_capabilities_mask;
3804 u8 extended_capabilities_len;
3808 * struct wiphy - wireless hardware description
3809 * @reg_notifier: the driver's regulatory notification callback,
3810 * note that if your driver uses wiphy_apply_custom_regulatory()
3811 * the reg_notifier's request can be passed as NULL
3812 * @regd: the driver's regulatory domain, if one was requested via
3813 * the regulatory_hint() API. This can be used by the driver
3814 * on the reg_notifier() if it chooses to ignore future
3815 * regulatory domain changes caused by other drivers.
3816 * @signal_type: signal type reported in &struct cfg80211_bss.
3817 * @cipher_suites: supported cipher suites
3818 * @n_cipher_suites: number of supported cipher suites
3819 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3820 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3821 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3822 * -1 = fragmentation disabled, only odd values >= 256 used
3823 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3824 * @_net: the network namespace this wiphy currently lives in
3825 * @perm_addr: permanent MAC address of this device
3826 * @addr_mask: If the device supports multiple MAC addresses by masking,
3827 * set this to a mask with variable bits set to 1, e.g. if the last
3828 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3829 * variable bits shall be determined by the interfaces added, with
3830 * interfaces not matching the mask being rejected to be brought up.
3831 * @n_addresses: number of addresses in @addresses.
3832 * @addresses: If the device has more than one address, set this pointer
3833 * to a list of addresses (6 bytes each). The first one will be used
3834 * by default for perm_addr. In this case, the mask should be set to
3835 * all-zeroes. In this case it is assumed that the device can handle
3836 * the same number of arbitrary MAC addresses.
3837 * @registered: protects ->resume and ->suspend sysfs callbacks against
3838 * unregister hardware
3839 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3840 * automatically on wiphy renames
3841 * @dev: (virtual) struct device for this wiphy
3842 * @registered: helps synchronize suspend/resume with wiphy unregister
3843 * @wext: wireless extension handlers
3844 * @priv: driver private data (sized according to wiphy_new() parameter)
3845 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3846 * must be set by driver
3847 * @iface_combinations: Valid interface combinations array, should not
3848 * list single interface types.
3849 * @n_iface_combinations: number of entries in @iface_combinations array.
3850 * @software_iftypes: bitmask of software interface types, these are not
3851 * subject to any restrictions since they are purely managed in SW.
3852 * @flags: wiphy flags, see &enum wiphy_flags
3853 * @regulatory_flags: wiphy regulatory flags, see
3854 * &enum ieee80211_regulatory_flags
3855 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3856 * @ext_features: extended features advertised to nl80211, see
3857 * &enum nl80211_ext_feature_index.
3858 * @bss_priv_size: each BSS struct has private data allocated with it,
3859 * this variable determines its size
3860 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3862 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
3863 * the device can run concurrently.
3864 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3865 * for in any given scheduled scan
3866 * @max_match_sets: maximum number of match sets the device can handle
3867 * when performing a scheduled scan, 0 if filtering is not
3869 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3870 * add to probe request frames transmitted during a scan, must not
3871 * include fixed IEs like supported rates
3872 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3874 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3875 * of iterations) for scheduled scan supported by the device.
3876 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3877 * single scan plan supported by the device.
3878 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3879 * scan plan supported by the device.
3880 * @coverage_class: current coverage class
3881 * @fw_version: firmware version for ethtool reporting
3882 * @hw_version: hardware version for ethtool reporting
3883 * @max_num_pmkids: maximum number of PMKIDs supported by device
3884 * @privid: a pointer that drivers can use to identify if an arbitrary
3885 * wiphy is theirs, e.g. in global notifiers
3886 * @bands: information about bands/channels supported by this device
3888 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3889 * transmitted through nl80211, points to an array indexed by interface
3892 * @available_antennas_tx: bitmap of antennas which are available to be
3893 * configured as TX antennas. Antenna configuration commands will be
3894 * rejected unless this or @available_antennas_rx is set.
3896 * @available_antennas_rx: bitmap of antennas which are available to be
3897 * configured as RX antennas. Antenna configuration commands will be
3898 * rejected unless this or @available_antennas_tx is set.
3900 * @probe_resp_offload:
3901 * Bitmap of supported protocols for probe response offloading.
3902 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3903 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3905 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3906 * may request, if implemented.
3908 * @wowlan: WoWLAN support information
3909 * @wowlan_config: current WoWLAN configuration; this should usually not be
3910 * used since access to it is necessarily racy, use the parameter passed
3911 * to the suspend() operation instead.
3913 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3914 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3915 * If null, then none can be over-ridden.
3916 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3917 * If null, then none can be over-ridden.
3919 * @wdev_list: the list of associated (virtual) interfaces; this list must
3920 * not be modified by the driver, but can be read with RTNL/RCU protection.
3922 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3925 * @extended_capabilities: extended capabilities supported by the driver,
3926 * additional capabilities might be supported by userspace; these are
3927 * the 802.11 extended capabilities ("Extended Capabilities element")
3928 * and are in the same format as in the information element. See
3929 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3930 * extended capabilities to be used if the capabilities are not specified
3931 * for a specific interface type in iftype_ext_capab.
3932 * @extended_capabilities_mask: mask of the valid values
3933 * @extended_capabilities_len: length of the extended capabilities
3934 * @iftype_ext_capab: array of extended capabilities per interface type
3935 * @num_iftype_ext_capab: number of interface types for which extended
3936 * capabilities are specified separately.
3937 * @coalesce: packet coalescing support information
3939 * @vendor_commands: array of vendor commands supported by the hardware
3940 * @n_vendor_commands: number of vendor commands
3941 * @vendor_events: array of vendor events supported by the hardware
3942 * @n_vendor_events: number of vendor events
3944 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3945 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3946 * driver is allowed to advertise a theoretical limit that it can reach in
3947 * some cases, but may not always reach.
3949 * @max_num_csa_counters: Number of supported csa_counters in beacons
3950 * and probe responses. This value should be set if the driver
3951 * wishes to limit the number of csa counters. Default (0) means
3953 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3954 * frame was sent and the channel on which the frame was heard for which
3955 * the reported rssi is still valid. If a driver is able to compensate the
3956 * low rssi when a frame is heard on different channel, then it should set
3957 * this variable to the maximal offset for which it can compensate.
3958 * This value should be set in MHz.
3959 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3960 * by the driver in the .connect() callback. The bit position maps to the
3961 * attribute indices defined in &enum nl80211_bss_select_attr.
3963 * @cookie_counter: unique generic cookie counter, used to identify objects.
3964 * @nan_supported_bands: bands supported by the device in NAN mode, a
3965 * bitmap of &enum nl80211_band values. For instance, for
3966 * NL80211_BAND_2GHZ, bit 0 would be set
3967 * (i.e. BIT(NL80211_BAND_2GHZ)).
3969 * @txq_limit: configuration of internal TX queue frame limit
3970 * @txq_memory_limit: configuration internal TX queue memory limit
3971 * @txq_quantum: configuration of internal TX queue scheduler quantum
3974 /* assign these fields before you register the wiphy */
3976 /* permanent MAC address(es) */
3977 u8 perm_addr[ETH_ALEN];
3978 u8 addr_mask[ETH_ALEN];
3980 struct mac_address *addresses;
3982 const struct ieee80211_txrx_stypes *mgmt_stypes;
3984 const struct ieee80211_iface_combination *iface_combinations;
3985 int n_iface_combinations;
3986 u16 software_iftypes;
3990 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3991 u16 interface_modes;
3993 u16 max_acl_mac_addrs;
3995 u32 flags, regulatory_flags, features;
3996 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4000 enum cfg80211_signal_type signal_type;
4004 u8 max_sched_scan_reqs;
4005 u8 max_sched_scan_ssids;
4007 u16 max_scan_ie_len;
4008 u16 max_sched_scan_ie_len;
4009 u32 max_sched_scan_plans;
4010 u32 max_sched_scan_plan_interval;
4011 u32 max_sched_scan_plan_iterations;
4013 int n_cipher_suites;
4014 const u32 *cipher_suites;
4022 char fw_version[ETHTOOL_FWVERS_LEN];
4026 const struct wiphy_wowlan_support *wowlan;
4027 struct cfg80211_wowlan *wowlan_config;
4030 u16 max_remain_on_channel_duration;
4034 u32 available_antennas_tx;
4035 u32 available_antennas_rx;
4038 * Bitmap of supported protocols for probe response offloading
4039 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
4040 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4042 u32 probe_resp_offload;
4044 const u8 *extended_capabilities, *extended_capabilities_mask;
4045 u8 extended_capabilities_len;
4047 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4048 unsigned int num_iftype_ext_capab;
4050 /* If multiple wiphys are registered and you're handed e.g.
4051 * a regular netdev with assigned ieee80211_ptr, you won't
4052 * know whether it points to a wiphy your driver has registered
4053 * or not. Assign this to something global to your driver to
4054 * help determine whether you own this wiphy or not. */
4057 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4059 /* Lets us get back the wiphy on the callback */
4060 void (*reg_notifier)(struct wiphy *wiphy,
4061 struct regulatory_request *request);
4063 /* fields below are read-only, assigned by cfg80211 */
4065 const struct ieee80211_regdomain __rcu *regd;
4067 /* the item in /sys/class/ieee80211/ points to this,
4068 * you need use set_wiphy_dev() (see below) */
4071 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
4074 /* dir in debugfs: ieee80211/<wiphyname> */
4075 struct dentry *debugfsdir;
4077 const struct ieee80211_ht_cap *ht_capa_mod_mask;
4078 const struct ieee80211_vht_cap *vht_capa_mod_mask;
4080 struct list_head wdev_list;
4082 /* the network namespace this phy lives in currently */
4083 possible_net_t _net;
4085 #ifdef CONFIG_CFG80211_WEXT
4086 const struct iw_handler_def *wext;
4089 const struct wiphy_coalesce_support *coalesce;
4091 const struct wiphy_vendor_command *vendor_commands;
4092 const struct nl80211_vendor_cmd_info *vendor_events;
4093 int n_vendor_commands, n_vendor_events;
4095 u16 max_ap_assoc_sta;
4097 u8 max_num_csa_counters;
4098 u8 max_adj_channel_rssi_comp;
4100 u32 bss_select_support;
4104 u8 nan_supported_bands;
4107 u32 txq_memory_limit;
4110 char priv[0] __aligned(NETDEV_ALIGN);
4113 static inline struct net *wiphy_net(struct wiphy *wiphy)
4115 return read_pnet(&wiphy->_net);
4118 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4120 write_pnet(&wiphy->_net, net);
4124 * wiphy_priv - return priv from wiphy
4126 * @wiphy: the wiphy whose priv pointer to return
4127 * Return: The priv of @wiphy.
4129 static inline void *wiphy_priv(struct wiphy *wiphy)
4132 return &wiphy->priv;
4136 * priv_to_wiphy - return the wiphy containing the priv
4138 * @priv: a pointer previously returned by wiphy_priv
4139 * Return: The wiphy of @priv.
4141 static inline struct wiphy *priv_to_wiphy(void *priv)
4144 return container_of(priv, struct wiphy, priv);
4148 * set_wiphy_dev - set device pointer for wiphy
4150 * @wiphy: The wiphy whose device to bind
4151 * @dev: The device to parent it to
4153 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4155 wiphy->dev.parent = dev;
4159 * wiphy_dev - get wiphy dev pointer
4161 * @wiphy: The wiphy whose device struct to look up
4162 * Return: The dev of @wiphy.
4164 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4166 return wiphy->dev.parent;
4170 * wiphy_name - get wiphy name
4172 * @wiphy: The wiphy whose name to return
4173 * Return: The name of @wiphy.
4175 static inline const char *wiphy_name(const struct wiphy *wiphy)
4177 return dev_name(&wiphy->dev);
4181 * wiphy_new_nm - create a new wiphy for use with cfg80211
4183 * @ops: The configuration operations for this device
4184 * @sizeof_priv: The size of the private area to allocate
4185 * @requested_name: Request a particular name.
4186 * NULL is valid value, and means use the default phy%d naming.
4188 * Create a new wiphy and associate the given operations with it.
4189 * @sizeof_priv bytes are allocated for private use.
4191 * Return: A pointer to the new wiphy. This pointer must be
4192 * assigned to each netdev's ieee80211_ptr for proper operation.
4194 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4195 const char *requested_name);
4198 * wiphy_new - create a new wiphy for use with cfg80211
4200 * @ops: The configuration operations for this device
4201 * @sizeof_priv: The size of the private area to allocate
4203 * Create a new wiphy and associate the given operations with it.
4204 * @sizeof_priv bytes are allocated for private use.
4206 * Return: A pointer to the new wiphy. This pointer must be
4207 * assigned to each netdev's ieee80211_ptr for proper operation.
4209 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4212 return wiphy_new_nm(ops, sizeof_priv, NULL);
4216 * wiphy_register - register a wiphy with cfg80211
4218 * @wiphy: The wiphy to register.
4220 * Return: A non-negative wiphy index or a negative error code.
4222 int wiphy_register(struct wiphy *wiphy);
4225 * wiphy_unregister - deregister a wiphy from cfg80211
4227 * @wiphy: The wiphy to unregister.
4229 * After this call, no more requests can be made with this priv
4230 * pointer, but the call may sleep to wait for an outstanding
4231 * request that is being handled.
4233 void wiphy_unregister(struct wiphy *wiphy);
4236 * wiphy_free - free wiphy
4238 * @wiphy: The wiphy to free
4240 void wiphy_free(struct wiphy *wiphy);
4242 /* internal structs */
4243 struct cfg80211_conn;
4244 struct cfg80211_internal_bss;
4245 struct cfg80211_cached_keys;
4246 struct cfg80211_cqm_config;
4249 * struct wireless_dev - wireless device state
4251 * For netdevs, this structure must be allocated by the driver
4252 * that uses the ieee80211_ptr field in struct net_device (this
4253 * is intentional so it can be allocated along with the netdev.)
4254 * It need not be registered then as netdev registration will
4255 * be intercepted by cfg80211 to see the new wireless device.
4257 * For non-netdev uses, it must also be allocated by the driver
4258 * in response to the cfg80211 callbacks that require it, as
4259 * there's no netdev registration in that case it may not be
4260 * allocated outside of callback operations that return it.
4262 * @wiphy: pointer to hardware description
4263 * @iftype: interface type
4264 * @list: (private) Used to collect the interfaces
4265 * @netdev: (private) Used to reference back to the netdev, may be %NULL
4266 * @identifier: (private) Identifier used in nl80211 to identify this
4267 * wireless device if it has no netdev
4268 * @current_bss: (private) Used by the internal configuration code
4269 * @chandef: (private) Used by the internal configuration code to track
4270 * the user-set channel definition.
4271 * @preset_chandef: (private) Used by the internal configuration code to
4272 * track the channel to be used for AP later
4273 * @bssid: (private) Used by the internal configuration code
4274 * @ssid: (private) Used by the internal configuration code
4275 * @ssid_len: (private) Used by the internal configuration code
4276 * @mesh_id_len: (private) Used by the internal configuration code
4277 * @mesh_id_up_len: (private) Used by the internal configuration code
4278 * @wext: (private) Used by the internal wireless extensions compat code
4279 * @use_4addr: indicates 4addr mode is used on this interface, must be
4280 * set by driver (if supported) on add_interface BEFORE registering the
4281 * netdev and may otherwise be used by driver read-only, will be update
4282 * by cfg80211 on change_interface
4283 * @mgmt_registrations: list of registrations for management frames
4284 * @mgmt_registrations_lock: lock for the list
4285 * @mtx: mutex used to lock data in this struct, may be used by drivers
4286 * and some API functions require it held
4287 * @beacon_interval: beacon interval used on this device for transmitting
4288 * beacons, 0 when not valid
4289 * @address: The address for this device, valid only if @netdev is %NULL
4290 * @is_running: true if this is a non-netdev device that has been started, e.g.
4292 * @cac_started: true if DFS channel availability check has been started
4293 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4294 * @cac_time_ms: CAC time in ms
4295 * @ps: powersave mode is enabled
4296 * @ps_timeout: dynamic powersave timeout
4297 * @ap_unexpected_nlportid: (private) netlink port ID of application
4298 * registered for unexpected class 3 frames (AP mode)
4299 * @conn: (private) cfg80211 software SME connection state machine data
4300 * @connect_keys: (private) keys to set after connection is established
4301 * @conn_bss_type: connecting/connected BSS type
4302 * @conn_owner_nlportid: (private) connection owner socket port ID
4303 * @disconnect_wk: (private) auto-disconnect work
4304 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4305 * @ibss_fixed: (private) IBSS is using fixed BSSID
4306 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4307 * @event_list: (private) list for internal event processing
4308 * @event_lock: (private) lock for event list
4309 * @owner_nlportid: (private) owner socket port ID
4310 * @nl_owner_dead: (private) owner socket went away
4311 * @cqm_config: (private) nl80211 RSSI monitor state
4313 struct wireless_dev {
4314 struct wiphy *wiphy;
4315 enum nl80211_iftype iftype;
4317 /* the remainder of this struct should be private to cfg80211 */
4318 struct list_head list;
4319 struct net_device *netdev;
4323 struct list_head mgmt_registrations;
4324 spinlock_t mgmt_registrations_lock;
4328 bool use_4addr, is_running;
4330 u8 address[ETH_ALEN] __aligned(sizeof(u16));
4332 /* currently used for IBSS and SME - might be rearranged later */
4333 u8 ssid[IEEE80211_MAX_SSID_LEN];
4334 u8 ssid_len, mesh_id_len, mesh_id_up_len;
4335 struct cfg80211_conn *conn;
4336 struct cfg80211_cached_keys *connect_keys;
4337 enum ieee80211_bss_type conn_bss_type;
4338 u32 conn_owner_nlportid;
4340 struct work_struct disconnect_wk;
4341 u8 disconnect_bssid[ETH_ALEN];
4343 struct list_head event_list;
4344 spinlock_t event_lock;
4346 struct cfg80211_internal_bss *current_bss; /* associated / joined */
4347 struct cfg80211_chan_def preset_chandef;
4348 struct cfg80211_chan_def chandef;
4351 bool ibss_dfs_possible;
4356 int beacon_interval;
4358 u32 ap_unexpected_nlportid;
4364 unsigned long cac_start_time;
4365 unsigned int cac_time_ms;
4367 #ifdef CONFIG_CFG80211_WEXT
4370 struct cfg80211_ibss_params ibss;
4371 struct cfg80211_connect_params connect;
4372 struct cfg80211_cached_keys *keys;
4375 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
4376 u8 ssid[IEEE80211_MAX_SSID_LEN];
4377 s8 default_key, default_mgmt_key;
4378 bool prev_bssid_valid;
4382 struct cfg80211_cqm_config *cqm_config;
4385 static inline u8 *wdev_address(struct wireless_dev *wdev)
4388 return wdev->netdev->dev_addr;
4389 return wdev->address;
4392 static inline bool wdev_running(struct wireless_dev *wdev)
4395 return netif_running(wdev->netdev);
4396 return wdev->is_running;
4400 * wdev_priv - return wiphy priv from wireless_dev
4402 * @wdev: The wireless device whose wiphy's priv pointer to return
4403 * Return: The wiphy priv of @wdev.
4405 static inline void *wdev_priv(struct wireless_dev *wdev)
4408 return wiphy_priv(wdev->wiphy);
4412 * DOC: Utility functions
4414 * cfg80211 offers a number of utility functions that can be useful.
4418 * ieee80211_channel_to_frequency - convert channel number to frequency
4419 * @chan: channel number
4420 * @band: band, necessary due to channel number overlap
4421 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
4423 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
4426 * ieee80211_frequency_to_channel - convert frequency to channel number
4427 * @freq: center frequency
4428 * Return: The corresponding channel, or 0 if the conversion failed.
4430 int ieee80211_frequency_to_channel(int freq);
4433 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
4435 * @wiphy: the struct wiphy to get the channel for
4436 * @freq: the center frequency of the channel
4438 * Return: The channel struct from @wiphy at @freq.
4440 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
4443 * ieee80211_get_response_rate - get basic rate for a given rate
4445 * @sband: the band to look for rates in
4446 * @basic_rates: bitmap of basic rates
4447 * @bitrate: the bitrate for which to find the basic rate
4449 * Return: The basic rate corresponding to a given bitrate, that
4450 * is the next lower bitrate contained in the basic rate map,
4451 * which is, for this function, given as a bitmap of indices of
4452 * rates in the band's bitrate table.
4454 struct ieee80211_rate *
4455 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
4456 u32 basic_rates, int bitrate);
4459 * ieee80211_mandatory_rates - get mandatory rates for a given band
4460 * @sband: the band to look for rates in
4461 * @scan_width: width of the control channel
4463 * This function returns a bitmap of the mandatory rates for the given
4464 * band, bits are set according to the rate position in the bitrates array.
4466 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4467 enum nl80211_bss_scan_width scan_width);
4470 * Radiotap parsing functions -- for controlled injection support
4472 * Implemented in net/wireless/radiotap.c
4473 * Documentation in Documentation/networking/radiotap-headers.txt
4476 struct radiotap_align_size {
4477 uint8_t align:4, size:4;
4480 struct ieee80211_radiotap_namespace {
4481 const struct radiotap_align_size *align_size;
4487 struct ieee80211_radiotap_vendor_namespaces {
4488 const struct ieee80211_radiotap_namespace *ns;
4493 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4494 * @this_arg_index: index of current arg, valid after each successful call
4495 * to ieee80211_radiotap_iterator_next()
4496 * @this_arg: pointer to current radiotap arg; it is valid after each
4497 * call to ieee80211_radiotap_iterator_next() but also after
4498 * ieee80211_radiotap_iterator_init() where it will point to
4499 * the beginning of the actual data portion
4500 * @this_arg_size: length of the current arg, for convenience
4501 * @current_namespace: pointer to the current namespace definition
4502 * (or internally %NULL if the current namespace is unknown)
4503 * @is_radiotap_ns: indicates whether the current namespace is the default
4504 * radiotap namespace or not
4506 * @_rtheader: pointer to the radiotap header we are walking through
4507 * @_max_length: length of radiotap header in cpu byte ordering
4508 * @_arg_index: next argument index
4509 * @_arg: next argument pointer
4510 * @_next_bitmap: internal pointer to next present u32
4511 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4512 * @_vns: vendor namespace definitions
4513 * @_next_ns_data: beginning of the next namespace's data
4514 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4517 * Describes the radiotap parser state. Fields prefixed with an underscore
4518 * must not be used by users of the parser, only by the parser internally.
4521 struct ieee80211_radiotap_iterator {
4522 struct ieee80211_radiotap_header *_rtheader;
4523 const struct ieee80211_radiotap_vendor_namespaces *_vns;
4524 const struct ieee80211_radiotap_namespace *current_namespace;
4526 unsigned char *_arg, *_next_ns_data;
4527 __le32 *_next_bitmap;
4529 unsigned char *this_arg;
4537 uint32_t _bitmap_shifter;
4542 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
4543 struct ieee80211_radiotap_header *radiotap_header,
4545 const struct ieee80211_radiotap_vendor_namespaces *vns);
4548 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
4551 extern const unsigned char rfc1042_header[6];
4552 extern const unsigned char bridge_tunnel_header[6];
4555 * ieee80211_get_hdrlen_from_skb - get header length from data
4559 * Given an skb with a raw 802.11 header at the data pointer this function
4560 * returns the 802.11 header length.
4562 * Return: The 802.11 header length in bytes (not including encryption
4563 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4566 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
4569 * ieee80211_hdrlen - get header length in bytes from frame control
4570 * @fc: frame control field in little-endian format
4571 * Return: The header length in bytes.
4573 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
4576 * ieee80211_get_mesh_hdrlen - get mesh extension header length
4577 * @meshhdr: the mesh extension header, only the flags field
4578 * (first byte) will be accessed
4579 * Return: The length of the extension header, which is always at
4580 * least 6 bytes and at most 18 if address 5 and 6 are present.
4582 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
4585 * DOC: Data path helpers
4587 * In addition to generic utilities, cfg80211 also offers
4588 * functions that help implement the data path for devices
4589 * that do not do the 802.11/802.3 conversion on the device.
4593 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4594 * @skb: the 802.11 data frame
4595 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4596 * of it being pushed into the SKB
4597 * @addr: the device MAC address
4598 * @iftype: the virtual interface type
4599 * @data_offset: offset of payload after the 802.11 header
4600 * Return: 0 on success. Non-zero on error.
4602 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
4603 const u8 *addr, enum nl80211_iftype iftype,
4607 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4608 * @skb: the 802.11 data frame
4609 * @addr: the device MAC address
4610 * @iftype: the virtual interface type
4611 * Return: 0 on success. Non-zero on error.
4613 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
4614 enum nl80211_iftype iftype)
4616 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
4620 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
4622 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
4623 * The @list will be empty if the decode fails. The @skb must be fully
4624 * header-less before being passed in here; it is freed in this function.
4626 * @skb: The input A-MSDU frame without any headers.
4627 * @list: The output list of 802.3 frames. It must be allocated and
4628 * initialized by by the caller.
4629 * @addr: The device MAC address.
4630 * @iftype: The device interface type.
4631 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
4632 * @check_da: DA to check in the inner ethernet header, or NULL
4633 * @check_sa: SA to check in the inner ethernet header, or NULL
4635 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
4636 const u8 *addr, enum nl80211_iftype iftype,
4637 const unsigned int extra_headroom,
4638 const u8 *check_da, const u8 *check_sa);
4641 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
4642 * @skb: the data frame
4643 * @qos_map: Interworking QoS mapping or %NULL if not in use
4644 * Return: The 802.1p/1d tag.
4646 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
4647 struct cfg80211_qos_map *qos_map);
4650 * cfg80211_find_ie_match - match information element and byte array in data
4653 * @ies: data consisting of IEs
4654 * @len: length of data
4655 * @match: byte array to match
4656 * @match_len: number of bytes in the match array
4657 * @match_offset: offset in the IE where the byte array should match.
4658 * If match_len is zero, this must also be set to zero.
4659 * Otherwise this must be set to 2 or more, because the first
4660 * byte is the element id, which is already compared to eid, and
4661 * the second byte is the IE length.
4663 * Return: %NULL if the element ID could not be found or if
4664 * the element is invalid (claims to be longer than the given
4665 * data) or if the byte array doesn't match, or a pointer to the first
4666 * byte of the requested element, that is the byte containing the
4669 * Note: There are no checks on the element length other than
4670 * having to fit into the given data and being large enough for the
4671 * byte array to match.
4673 const u8 *cfg80211_find_ie_match(u8 eid, const u8 *ies, int len,
4674 const u8 *match, int match_len,
4678 * cfg80211_find_ie - find information element in data
4681 * @ies: data consisting of IEs
4682 * @len: length of data
4684 * Return: %NULL if the element ID could not be found or if
4685 * the element is invalid (claims to be longer than the given
4686 * data), or a pointer to the first byte of the requested
4687 * element, that is the byte containing the element ID.
4689 * Note: There are no checks on the element length other than
4690 * having to fit into the given data.
4692 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
4694 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
4698 * cfg80211_find_ext_ie - find information element with EID Extension in data
4700 * @ext_eid: element ID Extension
4701 * @ies: data consisting of IEs
4702 * @len: length of data
4704 * Return: %NULL if the extended element ID could not be found or if
4705 * the element is invalid (claims to be longer than the given
4706 * data), or a pointer to the first byte of the requested
4707 * element, that is the byte containing the element ID.
4709 * Note: There are no checks on the element length other than
4710 * having to fit into the given data.
4712 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
4714 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
4719 * cfg80211_find_vendor_ie - find vendor specific information element in data
4722 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
4723 * @ies: data consisting of IEs
4724 * @len: length of data
4726 * Return: %NULL if the vendor specific element ID could not be found or if the
4727 * element is invalid (claims to be longer than the given data), or a pointer to
4728 * the first byte of the requested element, that is the byte containing the
4731 * Note: There are no checks on the element length other than having to fit into
4734 const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
4735 const u8 *ies, int len);
4738 * cfg80211_send_layer2_update - send layer 2 update frame
4740 * @dev: network device
4741 * @addr: STA MAC address
4743 * Wireless drivers can use this function to update forwarding tables in bridge
4744 * devices upon STA association.
4746 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
4749 * DOC: Regulatory enforcement infrastructure
4755 * regulatory_hint - driver hint to the wireless core a regulatory domain
4756 * @wiphy: the wireless device giving the hint (used only for reporting
4758 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4759 * should be in. If @rd is set this should be NULL. Note that if you
4760 * set this to NULL you should still set rd->alpha2 to some accepted
4763 * Wireless drivers can use this function to hint to the wireless core
4764 * what it believes should be the current regulatory domain by
4765 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4766 * domain should be in or by providing a completely build regulatory domain.
4767 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4768 * for a regulatory domain structure for the respective country.
4770 * The wiphy must have been registered to cfg80211 prior to this call.
4771 * For cfg80211 drivers this means you must first use wiphy_register(),
4772 * for mac80211 drivers you must first use ieee80211_register_hw().
4774 * Drivers should check the return value, its possible you can get
4777 * Return: 0 on success. -ENOMEM.
4779 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4782 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4783 * @wiphy: the wireless device we want to process the regulatory domain on
4784 * @rd: the regulatory domain informatoin to use for this wiphy
4786 * Set the regulatory domain information for self-managed wiphys, only they
4787 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4790 * Return: 0 on success. -EINVAL, -EPERM
4792 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4793 struct ieee80211_regdomain *rd);
4796 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4797 * @wiphy: the wireless device we want to process the regulatory domain on
4798 * @rd: the regulatory domain information to use for this wiphy
4800 * This functions requires the RTNL to be held and applies the new regdomain
4801 * synchronously to this wiphy. For more details see
4802 * regulatory_set_wiphy_regd().
4804 * Return: 0 on success. -EINVAL, -EPERM
4806 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4807 struct ieee80211_regdomain *rd);
4810 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4811 * @wiphy: the wireless device we want to process the regulatory domain on
4812 * @regd: the custom regulatory domain to use for this wiphy
4814 * Drivers can sometimes have custom regulatory domains which do not apply
4815 * to a specific country. Drivers can use this to apply such custom regulatory
4816 * domains. This routine must be called prior to wiphy registration. The
4817 * custom regulatory domain will be trusted completely and as such previous
4818 * default channel settings will be disregarded. If no rule is found for a
4819 * channel on the regulatory domain the channel will be disabled.
4820 * Drivers using this for a wiphy should also set the wiphy flag
4821 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4822 * that called this helper.
4824 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4825 const struct ieee80211_regdomain *regd);
4828 * freq_reg_info - get regulatory information for the given frequency
4829 * @wiphy: the wiphy for which we want to process this rule for
4830 * @center_freq: Frequency in KHz for which we want regulatory information for
4832 * Use this function to get the regulatory rule for a specific frequency on
4833 * a given wireless device. If the device has a specific regulatory domain
4834 * it wants to follow we respect that unless a country IE has been received
4835 * and processed already.
4837 * Return: A valid pointer, or, when an error occurs, for example if no rule
4838 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4839 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4840 * value will be -ERANGE if we determine the given center_freq does not even
4841 * have a regulatory rule for a frequency range in the center_freq's band.
4842 * See freq_in_rule_band() for our current definition of a band -- this is
4843 * purely subjective and right now it's 802.11 specific.
4845 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4849 * reg_initiator_name - map regulatory request initiator enum to name
4850 * @initiator: the regulatory request initiator
4852 * You can use this to map the regulatory request initiator enum to a
4853 * proper string representation.
4855 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4858 * DOC: Internal regulatory db functions
4863 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
4864 * Regulatory self-managed driver can use it to proactively
4866 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
4867 * @freq: the freqency(in MHz) to be queried.
4868 * @ptr: pointer where the regdb wmm data is to be stored (or %NULL if
4869 * irrelevant). This can be used later for deduplication.
4870 * @rule: pointer to store the wmm rule from the regulatory db.
4872 * Self-managed wireless drivers can use this function to query
4873 * the internal regulatory database to check whether the given
4874 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
4876 * Drivers should check the return value, its possible you can get
4879 * Return: 0 on success. -ENODATA.
4881 int reg_query_regdb_wmm(char *alpha2, int freq,
4882 struct ieee80211_reg_rule *rule);
4885 * callbacks for asynchronous cfg80211 methods, notification
4886 * functions and BSS handling helpers
4890 * cfg80211_scan_done - notify that scan finished
4892 * @request: the corresponding scan request
4893 * @info: information about the completed scan
4895 void cfg80211_scan_done(struct cfg80211_scan_request *request,
4896 struct cfg80211_scan_info *info);
4899 * cfg80211_sched_scan_results - notify that new scan results are available
4901 * @wiphy: the wiphy which got scheduled scan results
4902 * @reqid: identifier for the related scheduled scan request
4904 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
4907 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4909 * @wiphy: the wiphy on which the scheduled scan stopped
4910 * @reqid: identifier for the related scheduled scan request
4912 * The driver can call this function to inform cfg80211 that the
4913 * scheduled scan had to be stopped, for whatever reason. The driver
4914 * is then called back via the sched_scan_stop operation when done.
4916 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
4919 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4921 * @wiphy: the wiphy on which the scheduled scan stopped
4922 * @reqid: identifier for the related scheduled scan request
4924 * The driver can call this function to inform cfg80211 that the
4925 * scheduled scan had to be stopped, for whatever reason. The driver
4926 * is then called back via the sched_scan_stop operation when done.
4927 * This function should be called with rtnl locked.
4929 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
4932 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4933 * @wiphy: the wiphy reporting the BSS
4934 * @data: the BSS metadata
4935 * @mgmt: the management frame (probe response or beacon)
4936 * @len: length of the management frame
4937 * @gfp: context flags
4939 * This informs cfg80211 that BSS information was found and
4940 * the BSS should be updated/added.
4942 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4943 * Or %NULL on error.
4945 struct cfg80211_bss * __must_check
4946 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4947 struct cfg80211_inform_bss *data,
4948 struct ieee80211_mgmt *mgmt, size_t len,
4951 static inline struct cfg80211_bss * __must_check
4952 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4953 struct ieee80211_channel *rx_channel,
4954 enum nl80211_bss_scan_width scan_width,
4955 struct ieee80211_mgmt *mgmt, size_t len,
4956 s32 signal, gfp_t gfp)
4958 struct cfg80211_inform_bss data = {
4960 .scan_width = scan_width,
4964 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4967 static inline struct cfg80211_bss * __must_check
4968 cfg80211_inform_bss_frame(struct wiphy *wiphy,
4969 struct ieee80211_channel *rx_channel,
4970 struct ieee80211_mgmt *mgmt, size_t len,
4971 s32 signal, gfp_t gfp)
4973 struct cfg80211_inform_bss data = {
4975 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4979 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4983 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4984 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4985 * from a beacon or probe response
4986 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4987 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4989 enum cfg80211_bss_frame_type {
4990 CFG80211_BSS_FTYPE_UNKNOWN,
4991 CFG80211_BSS_FTYPE_BEACON,
4992 CFG80211_BSS_FTYPE_PRESP,
4996 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4998 * @wiphy: the wiphy reporting the BSS
4999 * @data: the BSS metadata
5000 * @ftype: frame type (if known)
5001 * @bssid: the BSSID of the BSS
5002 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5003 * @capability: the capability field sent by the peer
5004 * @beacon_interval: the beacon interval announced by the peer
5005 * @ie: additional IEs sent by the peer
5006 * @ielen: length of the additional IEs
5007 * @gfp: context flags
5009 * This informs cfg80211 that BSS information was found and
5010 * the BSS should be updated/added.
5012 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5013 * Or %NULL on error.
5015 struct cfg80211_bss * __must_check
5016 cfg80211_inform_bss_data(struct wiphy *wiphy,
5017 struct cfg80211_inform_bss *data,
5018 enum cfg80211_bss_frame_type ftype,
5019 const u8 *bssid, u64 tsf, u16 capability,
5020 u16 beacon_interval, const u8 *ie, size_t ielen,
5023 static inline struct cfg80211_bss * __must_check
5024 cfg80211_inform_bss_width(struct wiphy *wiphy,
5025 struct ieee80211_channel *rx_channel,
5026 enum nl80211_bss_scan_width scan_width,
5027 enum cfg80211_bss_frame_type ftype,
5028 const u8 *bssid, u64 tsf, u16 capability,
5029 u16 beacon_interval, const u8 *ie, size_t ielen,
5030 s32 signal, gfp_t gfp)
5032 struct cfg80211_inform_bss data = {
5034 .scan_width = scan_width,
5038 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5039 capability, beacon_interval, ie, ielen,
5043 static inline struct cfg80211_bss * __must_check
5044 cfg80211_inform_bss(struct wiphy *wiphy,
5045 struct ieee80211_channel *rx_channel,
5046 enum cfg80211_bss_frame_type ftype,
5047 const u8 *bssid, u64 tsf, u16 capability,
5048 u16 beacon_interval, const u8 *ie, size_t ielen,
5049 s32 signal, gfp_t gfp)
5051 struct cfg80211_inform_bss data = {
5053 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5057 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5058 capability, beacon_interval, ie, ielen,
5063 * cfg80211_get_bss - get a BSS reference
5064 * @wiphy: the wiphy this BSS struct belongs to
5065 * @channel: the channel to search on (or %NULL)
5066 * @bssid: the desired BSSID (or %NULL)
5067 * @ssid: the desired SSID (or %NULL)
5068 * @ssid_len: length of the SSID (or 0)
5069 * @bss_type: type of BSS, see &enum ieee80211_bss_type
5070 * @privacy: privacy filter, see &enum ieee80211_privacy
5072 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
5073 struct ieee80211_channel *channel,
5075 const u8 *ssid, size_t ssid_len,
5076 enum ieee80211_bss_type bss_type,
5077 enum ieee80211_privacy privacy);
5078 static inline struct cfg80211_bss *
5079 cfg80211_get_ibss(struct wiphy *wiphy,
5080 struct ieee80211_channel *channel,
5081 const u8 *ssid, size_t ssid_len)
5083 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
5084 IEEE80211_BSS_TYPE_IBSS,
5085 IEEE80211_PRIVACY_ANY);
5089 * cfg80211_ref_bss - reference BSS struct
5090 * @wiphy: the wiphy this BSS struct belongs to
5091 * @bss: the BSS struct to reference
5093 * Increments the refcount of the given BSS struct.
5095 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5098 * cfg80211_put_bss - unref BSS struct
5099 * @wiphy: the wiphy this BSS struct belongs to
5100 * @bss: the BSS struct
5102 * Decrements the refcount of the given BSS struct.
5104 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5107 * cfg80211_unlink_bss - unlink BSS from internal data structures
5109 * @bss: the bss to remove
5111 * This function removes the given BSS from the internal data structures
5112 * thereby making it no longer show up in scan results etc. Use this
5113 * function when you detect a BSS is gone. Normally BSSes will also time
5114 * out, so it is not necessary to use this function at all.
5116 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5118 static inline enum nl80211_bss_scan_width
5119 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5121 switch (chandef->width) {
5122 case NL80211_CHAN_WIDTH_5:
5123 return NL80211_BSS_CHAN_WIDTH_5;
5124 case NL80211_CHAN_WIDTH_10:
5125 return NL80211_BSS_CHAN_WIDTH_10;
5127 return NL80211_BSS_CHAN_WIDTH_20;
5132 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5133 * @dev: network device
5134 * @buf: authentication frame (header + body)
5135 * @len: length of the frame data
5137 * This function is called whenever an authentication, disassociation or
5138 * deauthentication frame has been received and processed in station mode.
5139 * After being asked to authenticate via cfg80211_ops::auth() the driver must
5140 * call either this function or cfg80211_auth_timeout().
5141 * After being asked to associate via cfg80211_ops::assoc() the driver must
5142 * call either this function or cfg80211_auth_timeout().
5143 * While connected, the driver must calls this for received and processed
5144 * disassociation and deauthentication frames. If the frame couldn't be used
5145 * because it was unprotected, the driver must call the function
5146 * cfg80211_rx_unprot_mlme_mgmt() instead.
5148 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5150 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5153 * cfg80211_auth_timeout - notification of timed out authentication
5154 * @dev: network device
5155 * @addr: The MAC address of the device with which the authentication timed out
5157 * This function may sleep. The caller must hold the corresponding wdev's
5160 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
5163 * cfg80211_rx_assoc_resp - notification of processed association response
5164 * @dev: network device
5165 * @bss: the BSS that association was requested with, ownership of the pointer
5166 * moves to cfg80211 in this call
5167 * @buf: authentication frame (header + body)
5168 * @len: length of the frame data
5169 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5170 * as the AC bitmap in the QoS info field
5172 * After being asked to associate via cfg80211_ops::assoc() the driver must
5173 * call either this function or cfg80211_auth_timeout().
5175 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5177 void cfg80211_rx_assoc_resp(struct net_device *dev,
5178 struct cfg80211_bss *bss,
5179 const u8 *buf, size_t len,
5183 * cfg80211_assoc_timeout - notification of timed out association
5184 * @dev: network device
5185 * @bss: The BSS entry with which association timed out.
5187 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5189 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
5192 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5193 * @dev: network device
5194 * @bss: The BSS entry with which association was abandoned.
5196 * Call this whenever - for reasons reported through other API, like deauth RX,
5197 * an association attempt was abandoned.
5198 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5200 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
5203 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
5204 * @dev: network device
5205 * @buf: 802.11 frame (header + body)
5206 * @len: length of the frame data
5208 * This function is called whenever deauthentication has been processed in
5209 * station mode. This includes both received deauthentication frames and
5210 * locally generated ones. This function may sleep. The caller must hold the
5211 * corresponding wdev's mutex.
5213 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5216 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
5217 * @dev: network device
5218 * @buf: deauthentication frame (header + body)
5219 * @len: length of the frame data
5221 * This function is called whenever a received deauthentication or dissassoc
5222 * frame has been dropped in station mode because of MFP being used but the
5223 * frame was not protected. This function may sleep.
5225 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5226 const u8 *buf, size_t len);
5229 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
5230 * @dev: network device
5231 * @addr: The source MAC address of the frame
5232 * @key_type: The key type that the received frame used
5233 * @key_id: Key identifier (0..3). Can be -1 if missing.
5234 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
5235 * @gfp: allocation flags
5237 * This function is called whenever the local MAC detects a MIC failure in a
5238 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
5241 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
5242 enum nl80211_key_type key_type, int key_id,
5243 const u8 *tsc, gfp_t gfp);
5246 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
5248 * @dev: network device
5249 * @bssid: the BSSID of the IBSS joined
5250 * @channel: the channel of the IBSS joined
5251 * @gfp: allocation flags
5253 * This function notifies cfg80211 that the device joined an IBSS or
5254 * switched to a different BSSID. Before this function can be called,
5255 * either a beacon has to have been received from the IBSS, or one of
5256 * the cfg80211_inform_bss{,_frame} functions must have been called
5257 * with the locally generated beacon -- this guarantees that there is
5258 * always a scan result for this IBSS. cfg80211 will handle the rest.
5260 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
5261 struct ieee80211_channel *channel, gfp_t gfp);
5264 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
5266 * @dev: network device
5267 * @macaddr: the MAC address of the new candidate
5268 * @ie: information elements advertised by the peer candidate
5269 * @ie_len: lenght of the information elements buffer
5270 * @gfp: allocation flags
5272 * This function notifies cfg80211 that the mesh peer candidate has been
5273 * detected, most likely via a beacon or, less likely, via a probe response.
5274 * cfg80211 then sends a notification to userspace.
5276 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
5277 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
5280 * DOC: RFkill integration
5282 * RFkill integration in cfg80211 is almost invisible to drivers,
5283 * as cfg80211 automatically registers an rfkill instance for each
5284 * wireless device it knows about. Soft kill is also translated
5285 * into disconnecting and turning all interfaces off, drivers are
5286 * expected to turn off the device when all interfaces are down.
5288 * However, devices may have a hard RFkill line, in which case they
5289 * also need to interact with the rfkill subsystem, via cfg80211.
5290 * They can do this with a few helper functions documented here.
5294 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
5296 * @blocked: block status
5298 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
5301 * wiphy_rfkill_start_polling - start polling rfkill
5304 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
5307 * wiphy_rfkill_stop_polling - stop polling rfkill
5310 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
5313 * DOC: Vendor commands
5315 * Occasionally, there are special protocol or firmware features that
5316 * can't be implemented very openly. For this and similar cases, the
5317 * vendor command functionality allows implementing the features with
5318 * (typically closed-source) userspace and firmware, using nl80211 as
5319 * the configuration mechanism.
5321 * A driver supporting vendor commands must register them as an array
5322 * in struct wiphy, with handlers for each one, each command has an
5323 * OUI and sub command ID to identify it.
5325 * Note that this feature should not be (ab)used to implement protocol
5326 * features that could openly be shared across drivers. In particular,
5327 * it must never be required to use vendor commands to implement any
5328 * "normal" functionality that higher-level userspace like connection
5329 * managers etc. need.
5332 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
5333 enum nl80211_commands cmd,
5334 enum nl80211_attrs attr,
5337 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
5338 struct wireless_dev *wdev,
5339 enum nl80211_commands cmd,
5340 enum nl80211_attrs attr,
5341 int vendor_event_idx,
5342 int approxlen, gfp_t gfp);
5344 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
5347 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
5349 * @approxlen: an upper bound of the length of the data that will
5350 * be put into the skb
5352 * This function allocates and pre-fills an skb for a reply to
5353 * a vendor command. Since it is intended for a reply, calling
5354 * it outside of a vendor command's doit() operation is invalid.
5356 * The returned skb is pre-filled with some identifying data in
5357 * a way that any data that is put into the skb (with skb_put(),
5358 * nla_put() or similar) will end up being within the
5359 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
5360 * with the skb is adding data for the corresponding userspace tool
5361 * which can then read that data out of the vendor data attribute.
5362 * You must not modify the skb in any other way.
5364 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
5365 * its error code as the result of the doit() operation.
5367 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5369 static inline struct sk_buff *
5370 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5372 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
5373 NL80211_ATTR_VENDOR_DATA, approxlen);
5377 * cfg80211_vendor_cmd_reply - send the reply skb
5378 * @skb: The skb, must have been allocated with
5379 * cfg80211_vendor_cmd_alloc_reply_skb()
5381 * Since calling this function will usually be the last thing
5382 * before returning from the vendor command doit() you should
5383 * return the error code. Note that this function consumes the
5384 * skb regardless of the return value.
5386 * Return: An error code or 0 on success.
5388 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
5391 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
5393 * @wdev: the wireless device
5394 * @event_idx: index of the vendor event in the wiphy's vendor_events
5395 * @approxlen: an upper bound of the length of the data that will
5396 * be put into the skb
5397 * @gfp: allocation flags
5399 * This function allocates and pre-fills an skb for an event on the
5400 * vendor-specific multicast group.
5402 * If wdev != NULL, both the ifindex and identifier of the specified
5403 * wireless device are added to the event message before the vendor data
5406 * When done filling the skb, call cfg80211_vendor_event() with the
5407 * skb to send the event.
5409 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5411 static inline struct sk_buff *
5412 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
5413 int approxlen, int event_idx, gfp_t gfp)
5415 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
5416 NL80211_ATTR_VENDOR_DATA,
5417 event_idx, approxlen, gfp);
5421 * cfg80211_vendor_event - send the event
5422 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
5423 * @gfp: allocation flags
5425 * This function sends the given @skb, which must have been allocated
5426 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
5428 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
5430 __cfg80211_send_event_skb(skb, gfp);
5433 #ifdef CONFIG_NL80211_TESTMODE
5437 * Test mode is a set of utility functions to allow drivers to
5438 * interact with driver-specific tools to aid, for instance,
5439 * factory programming.
5441 * This chapter describes how drivers interact with it, for more
5442 * information see the nl80211 book's chapter on it.
5446 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
5448 * @approxlen: an upper bound of the length of the data that will
5449 * be put into the skb
5451 * This function allocates and pre-fills an skb for a reply to
5452 * the testmode command. Since it is intended for a reply, calling
5453 * it outside of the @testmode_cmd operation is invalid.
5455 * The returned skb is pre-filled with the wiphy index and set up in
5456 * a way that any data that is put into the skb (with skb_put(),
5457 * nla_put() or similar) will end up being within the
5458 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
5459 * with the skb is adding data for the corresponding userspace tool
5460 * which can then read that data out of the testdata attribute. You
5461 * must not modify the skb in any other way.
5463 * When done, call cfg80211_testmode_reply() with the skb and return
5464 * its error code as the result of the @testmode_cmd operation.
5466 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5468 static inline struct sk_buff *
5469 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5471 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
5472 NL80211_ATTR_TESTDATA, approxlen);
5476 * cfg80211_testmode_reply - send the reply skb
5477 * @skb: The skb, must have been allocated with
5478 * cfg80211_testmode_alloc_reply_skb()
5480 * Since calling this function will usually be the last thing
5481 * before returning from the @testmode_cmd you should return
5482 * the error code. Note that this function consumes the skb
5483 * regardless of the return value.
5485 * Return: An error code or 0 on success.
5487 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
5489 return cfg80211_vendor_cmd_reply(skb);
5493 * cfg80211_testmode_alloc_event_skb - allocate testmode event
5495 * @approxlen: an upper bound of the length of the data that will
5496 * be put into the skb
5497 * @gfp: allocation flags
5499 * This function allocates and pre-fills an skb for an event on the
5500 * testmode multicast group.
5502 * The returned skb is set up in the same way as with
5503 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
5504 * there, you should simply add data to it that will then end up in the
5505 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
5508 * When done filling the skb, call cfg80211_testmode_event() with the
5509 * skb to send the event.
5511 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5513 static inline struct sk_buff *
5514 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
5516 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
5517 NL80211_ATTR_TESTDATA, -1,
5522 * cfg80211_testmode_event - send the event
5523 * @skb: The skb, must have been allocated with
5524 * cfg80211_testmode_alloc_event_skb()
5525 * @gfp: allocation flags
5527 * This function sends the given @skb, which must have been allocated
5528 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
5531 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
5533 __cfg80211_send_event_skb(skb, gfp);
5536 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
5537 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
5539 #define CFG80211_TESTMODE_CMD(cmd)
5540 #define CFG80211_TESTMODE_DUMP(cmd)
5544 * struct cfg80211_fils_resp_params - FILS connection response params
5545 * @kek: KEK derived from a successful FILS connection (may be %NULL)
5546 * @kek_len: Length of @fils_kek in octets
5547 * @update_erp_next_seq_num: Boolean value to specify whether the value in
5548 * @erp_next_seq_num is valid.
5549 * @erp_next_seq_num: The next sequence number to use in ERP message in
5550 * FILS Authentication. This value should be specified irrespective of the
5551 * status for a FILS connection.
5552 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
5553 * @pmk_len: Length of @pmk in octets
5554 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
5555 * used for this FILS connection (may be %NULL).
5557 struct cfg80211_fils_resp_params {
5560 bool update_erp_next_seq_num;
5561 u16 erp_next_seq_num;
5568 * struct cfg80211_connect_resp_params - Connection response params
5569 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
5570 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5571 * the real status code for failures. If this call is used to report a
5572 * failure due to a timeout (e.g., not receiving an Authentication frame
5573 * from the AP) instead of an explicit rejection by the AP, -1 is used to
5574 * indicate that this is a failure, but without a status code.
5575 * @timeout_reason is used to report the reason for the timeout in that
5577 * @bssid: The BSSID of the AP (may be %NULL)
5578 * @bss: Entry of bss to which STA got connected to, can be obtained through
5579 * cfg80211_get_bss() (may be %NULL). Only one parameter among @bssid and
5580 * @bss needs to be specified.
5581 * @req_ie: Association request IEs (may be %NULL)
5582 * @req_ie_len: Association request IEs length
5583 * @resp_ie: Association response IEs (may be %NULL)
5584 * @resp_ie_len: Association response IEs length
5585 * @fils: FILS connection response parameters.
5586 * @timeout_reason: Reason for connection timeout. This is used when the
5587 * connection fails due to a timeout instead of an explicit rejection from
5588 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5589 * not known. This value is used only if @status < 0 to indicate that the
5590 * failure is due to a timeout and not due to explicit rejection by the AP.
5591 * This value is ignored in other cases (@status >= 0).
5593 struct cfg80211_connect_resp_params {
5596 struct cfg80211_bss *bss;
5601 struct cfg80211_fils_resp_params fils;
5602 enum nl80211_timeout_reason timeout_reason;
5606 * cfg80211_connect_done - notify cfg80211 of connection result
5608 * @dev: network device
5609 * @params: connection response parameters
5610 * @gfp: allocation flags
5612 * It should be called by the underlying driver once execution of the connection
5613 * request from connect() has been completed. This is similar to
5614 * cfg80211_connect_bss(), but takes a structure pointer for connection response
5615 * parameters. Only one of the functions among cfg80211_connect_bss(),
5616 * cfg80211_connect_result(), cfg80211_connect_timeout(),
5617 * and cfg80211_connect_done() should be called.
5619 void cfg80211_connect_done(struct net_device *dev,
5620 struct cfg80211_connect_resp_params *params,
5624 * cfg80211_connect_bss - notify cfg80211 of connection result
5626 * @dev: network device
5627 * @bssid: the BSSID of the AP
5628 * @bss: entry of bss to which STA got connected to, can be obtained
5629 * through cfg80211_get_bss (may be %NULL)
5630 * @req_ie: association request IEs (maybe be %NULL)
5631 * @req_ie_len: association request IEs length
5632 * @resp_ie: association response IEs (may be %NULL)
5633 * @resp_ie_len: assoc response IEs length
5634 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5635 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5636 * the real status code for failures. If this call is used to report a
5637 * failure due to a timeout (e.g., not receiving an Authentication frame
5638 * from the AP) instead of an explicit rejection by the AP, -1 is used to
5639 * indicate that this is a failure, but without a status code.
5640 * @timeout_reason is used to report the reason for the timeout in that
5642 * @gfp: allocation flags
5643 * @timeout_reason: reason for connection timeout. This is used when the
5644 * connection fails due to a timeout instead of an explicit rejection from
5645 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5646 * not known. This value is used only if @status < 0 to indicate that the
5647 * failure is due to a timeout and not due to explicit rejection by the AP.
5648 * This value is ignored in other cases (@status >= 0).
5650 * It should be called by the underlying driver once execution of the connection
5651 * request from connect() has been completed. This is similar to
5652 * cfg80211_connect_result(), but with the option of identifying the exact bss
5653 * entry for the connection. Only one of the functions among
5654 * cfg80211_connect_bss(), cfg80211_connect_result(),
5655 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5658 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
5659 struct cfg80211_bss *bss, const u8 *req_ie,
5660 size_t req_ie_len, const u8 *resp_ie,
5661 size_t resp_ie_len, int status, gfp_t gfp,
5662 enum nl80211_timeout_reason timeout_reason)
5664 struct cfg80211_connect_resp_params params;
5666 memset(¶ms, 0, sizeof(params));
5667 params.status = status;
5668 params.bssid = bssid;
5670 params.req_ie = req_ie;
5671 params.req_ie_len = req_ie_len;
5672 params.resp_ie = resp_ie;
5673 params.resp_ie_len = resp_ie_len;
5674 params.timeout_reason = timeout_reason;
5676 cfg80211_connect_done(dev, ¶ms, gfp);
5680 * cfg80211_connect_result - notify cfg80211 of connection result
5682 * @dev: network device
5683 * @bssid: the BSSID of the AP
5684 * @req_ie: association request IEs (maybe be %NULL)
5685 * @req_ie_len: association request IEs length
5686 * @resp_ie: association response IEs (may be %NULL)
5687 * @resp_ie_len: assoc response IEs length
5688 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5689 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5690 * the real status code for failures.
5691 * @gfp: allocation flags
5693 * It should be called by the underlying driver once execution of the connection
5694 * request from connect() has been completed. This is similar to
5695 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
5696 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
5697 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5700 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
5701 const u8 *req_ie, size_t req_ie_len,
5702 const u8 *resp_ie, size_t resp_ie_len,
5703 u16 status, gfp_t gfp)
5705 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
5706 resp_ie_len, status, gfp,
5707 NL80211_TIMEOUT_UNSPECIFIED);
5711 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
5713 * @dev: network device
5714 * @bssid: the BSSID of the AP
5715 * @req_ie: association request IEs (maybe be %NULL)
5716 * @req_ie_len: association request IEs length
5717 * @gfp: allocation flags
5718 * @timeout_reason: reason for connection timeout.
5720 * It should be called by the underlying driver whenever connect() has failed
5721 * in a sequence where no explicit authentication/association rejection was
5722 * received from the AP. This could happen, e.g., due to not being able to send
5723 * out the Authentication or Association Request frame or timing out while
5724 * waiting for the response. Only one of the functions among
5725 * cfg80211_connect_bss(), cfg80211_connect_result(),
5726 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5729 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
5730 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
5731 enum nl80211_timeout_reason timeout_reason)
5733 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
5734 gfp, timeout_reason);
5738 * struct cfg80211_roam_info - driver initiated roaming information
5740 * @channel: the channel of the new AP
5741 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
5742 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
5743 * @req_ie: association request IEs (maybe be %NULL)
5744 * @req_ie_len: association request IEs length
5745 * @resp_ie: association response IEs (may be %NULL)
5746 * @resp_ie_len: assoc response IEs length
5747 * @fils: FILS related roaming information.
5749 struct cfg80211_roam_info {
5750 struct ieee80211_channel *channel;
5751 struct cfg80211_bss *bss;
5757 struct cfg80211_fils_resp_params fils;
5761 * cfg80211_roamed - notify cfg80211 of roaming
5763 * @dev: network device
5764 * @info: information about the new BSS. struct &cfg80211_roam_info.
5765 * @gfp: allocation flags
5767 * This function may be called with the driver passing either the BSSID of the
5768 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
5769 * It should be called by the underlying driver whenever it roamed from one AP
5770 * to another while connected. Drivers which have roaming implemented in
5771 * firmware should pass the bss entry to avoid a race in bss entry timeout where
5772 * the bss entry of the new AP is seen in the driver, but gets timed out by the
5773 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
5774 * rdev->event_work. In case of any failures, the reference is released
5775 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
5776 * released while diconneting from the current bss.
5778 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
5782 * cfg80211_port_authorized - notify cfg80211 of successful security association
5784 * @dev: network device
5785 * @bssid: the BSSID of the AP
5786 * @gfp: allocation flags
5788 * This function should be called by a driver that supports 4 way handshake
5789 * offload after a security association was successfully established (i.e.,
5790 * the 4 way handshake was completed successfully). The call to this function
5791 * should be preceded with a call to cfg80211_connect_result(),
5792 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
5793 * indicate the 802.11 association.
5795 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
5799 * cfg80211_disconnected - notify cfg80211 that connection was dropped
5801 * @dev: network device
5802 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
5803 * @ie_len: length of IEs
5804 * @reason: reason code for the disconnection, set it to 0 if unknown
5805 * @locally_generated: disconnection was requested locally
5806 * @gfp: allocation flags
5808 * After it calls this function, the driver should enter an idle state
5809 * and not try to connect to any AP any more.
5811 void cfg80211_disconnected(struct net_device *dev, u16 reason,
5812 const u8 *ie, size_t ie_len,
5813 bool locally_generated, gfp_t gfp);
5816 * cfg80211_ready_on_channel - notification of remain_on_channel start
5817 * @wdev: wireless device
5818 * @cookie: the request cookie
5819 * @chan: The current channel (from remain_on_channel request)
5820 * @duration: Duration in milliseconds that the driver intents to remain on the
5822 * @gfp: allocation flags
5824 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
5825 struct ieee80211_channel *chan,
5826 unsigned int duration, gfp_t gfp);
5829 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
5830 * @wdev: wireless device
5831 * @cookie: the request cookie
5832 * @chan: The current channel (from remain_on_channel request)
5833 * @gfp: allocation flags
5835 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
5836 struct ieee80211_channel *chan,
5840 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
5842 * @sinfo: the station information
5843 * @gfp: allocation flags
5845 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
5848 * cfg80211_sinfo_release_content - release contents of station info
5849 * @sinfo: the station information
5851 * Releases any potentially allocated sub-information of the station
5852 * information, but not the struct itself (since it's typically on
5855 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
5857 kfree(sinfo->pertid);
5861 * cfg80211_new_sta - notify userspace about station
5864 * @mac_addr: the station's address
5865 * @sinfo: the station information
5866 * @gfp: allocation flags
5868 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
5869 struct station_info *sinfo, gfp_t gfp);
5872 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
5874 * @mac_addr: the station's address
5875 * @sinfo: the station information/statistics
5876 * @gfp: allocation flags
5878 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
5879 struct station_info *sinfo, gfp_t gfp);
5882 * cfg80211_del_sta - notify userspace about deletion of a station
5885 * @mac_addr: the station's address
5886 * @gfp: allocation flags
5888 static inline void cfg80211_del_sta(struct net_device *dev,
5889 const u8 *mac_addr, gfp_t gfp)
5891 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
5895 * cfg80211_conn_failed - connection request failed notification
5898 * @mac_addr: the station's address
5899 * @reason: the reason for connection failure
5900 * @gfp: allocation flags
5902 * Whenever a station tries to connect to an AP and if the station
5903 * could not connect to the AP as the AP has rejected the connection
5904 * for some reasons, this function is called.
5906 * The reason for connection failure can be any of the value from
5907 * nl80211_connect_failed_reason enum
5909 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
5910 enum nl80211_connect_failed_reason reason,
5914 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
5915 * @wdev: wireless device receiving the frame
5916 * @freq: Frequency on which the frame was received in MHz
5917 * @sig_dbm: signal strength in dBm, or 0 if unknown
5918 * @buf: Management frame (header + body)
5919 * @len: length of the frame data
5920 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
5922 * This function is called whenever an Action frame is received for a station
5923 * mode interface, but is not processed in kernel.
5925 * Return: %true if a user space application has registered for this frame.
5926 * For action frames, that makes it responsible for rejecting unrecognized
5927 * action frames; %false otherwise, in which case for action frames the
5928 * driver is responsible for rejecting the frame.
5930 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
5931 const u8 *buf, size_t len, u32 flags);
5934 * cfg80211_mgmt_tx_status - notification of TX status for management frame
5935 * @wdev: wireless device receiving the frame
5936 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5937 * @buf: Management frame (header + body)
5938 * @len: length of the frame data
5939 * @ack: Whether frame was acknowledged
5940 * @gfp: context flags
5942 * This function is called whenever a management frame was requested to be
5943 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
5944 * transmission attempt.
5946 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
5947 const u8 *buf, size_t len, bool ack, gfp_t gfp);
5951 * cfg80211_rx_control_port - notification about a received control port frame
5952 * @dev: The device the frame matched to
5953 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
5954 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
5955 * This function does not take ownership of the skb, so the caller is
5956 * responsible for any cleanup. The caller must also ensure that
5957 * skb->protocol is set appropriately.
5958 * @unencrypted: Whether the frame was received unencrypted
5960 * This function is used to inform userspace about a received control port
5961 * frame. It should only be used if userspace indicated it wants to receive
5962 * control port frames over nl80211.
5964 * The frame is the data portion of the 802.3 or 802.11 data frame with all
5965 * network layer headers removed (e.g. the raw EAPoL frame).
5967 * Return: %true if the frame was passed to userspace
5969 bool cfg80211_rx_control_port(struct net_device *dev,
5970 struct sk_buff *skb, bool unencrypted);
5973 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5974 * @dev: network device
5975 * @rssi_event: the triggered RSSI event
5976 * @rssi_level: new RSSI level value or 0 if not available
5977 * @gfp: context flags
5979 * This function is called when a configured connection quality monitoring
5980 * rssi threshold reached event occurs.
5982 void cfg80211_cqm_rssi_notify(struct net_device *dev,
5983 enum nl80211_cqm_rssi_threshold_event rssi_event,
5984 s32 rssi_level, gfp_t gfp);
5987 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5988 * @dev: network device
5989 * @peer: peer's MAC address
5990 * @num_packets: how many packets were lost -- should be a fixed threshold
5991 * but probably no less than maybe 50, or maybe a throughput dependent
5992 * threshold (to account for temporary interference)
5993 * @gfp: context flags
5995 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5996 const u8 *peer, u32 num_packets, gfp_t gfp);
5999 * cfg80211_cqm_txe_notify - TX error rate event
6000 * @dev: network device
6001 * @peer: peer's MAC address
6002 * @num_packets: how many packets were lost
6003 * @rate: % of packets which failed transmission
6004 * @intvl: interval (in s) over which the TX failure threshold was breached.
6005 * @gfp: context flags
6007 * Notify userspace when configured % TX failures over number of packets in a
6008 * given interval is exceeded.
6010 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
6011 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
6014 * cfg80211_cqm_beacon_loss_notify - beacon loss event
6015 * @dev: network device
6016 * @gfp: context flags
6018 * Notify userspace about beacon loss from the connected AP.
6020 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
6023 * cfg80211_radar_event - radar detection event
6025 * @chandef: chandef for the current channel
6026 * @gfp: context flags
6028 * This function is called when a radar is detected on the current chanenl.
6030 void cfg80211_radar_event(struct wiphy *wiphy,
6031 struct cfg80211_chan_def *chandef, gfp_t gfp);
6034 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6035 * @dev: network device
6036 * @mac: MAC address of a station which opmode got modified
6037 * @sta_opmode: station's current opmode value
6038 * @gfp: context flags
6040 * Driver should call this function when station's opmode modified via action
6043 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
6044 struct sta_opmode_info *sta_opmode,
6048 * cfg80211_cac_event - Channel availability check (CAC) event
6049 * @netdev: network device
6050 * @chandef: chandef for the current channel
6051 * @event: type of event
6052 * @gfp: context flags
6054 * This function is called when a Channel availability check (CAC) is finished
6055 * or aborted. This must be called to notify the completion of a CAC process,
6056 * also by full-MAC drivers.
6058 void cfg80211_cac_event(struct net_device *netdev,
6059 const struct cfg80211_chan_def *chandef,
6060 enum nl80211_radar_event event, gfp_t gfp);
6064 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6065 * @dev: network device
6066 * @bssid: BSSID of AP (to avoid races)
6067 * @replay_ctr: new replay counter
6068 * @gfp: allocation flags
6070 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
6071 const u8 *replay_ctr, gfp_t gfp);
6074 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
6075 * @dev: network device
6076 * @index: candidate index (the smaller the index, the higher the priority)
6077 * @bssid: BSSID of AP
6078 * @preauth: Whether AP advertises support for RSN pre-authentication
6079 * @gfp: allocation flags
6081 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
6082 const u8 *bssid, bool preauth, gfp_t gfp);
6085 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
6086 * @dev: The device the frame matched to
6087 * @addr: the transmitter address
6088 * @gfp: context flags
6090 * This function is used in AP mode (only!) to inform userspace that
6091 * a spurious class 3 frame was received, to be able to deauth the
6093 * Return: %true if the frame was passed to userspace (or this failed
6094 * for a reason other than not having a subscription.)
6096 bool cfg80211_rx_spurious_frame(struct net_device *dev,
6097 const u8 *addr, gfp_t gfp);
6100 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
6101 * @dev: The device the frame matched to
6102 * @addr: the transmitter address
6103 * @gfp: context flags
6105 * This function is used in AP mode (only!) to inform userspace that
6106 * an associated station sent a 4addr frame but that wasn't expected.
6107 * It is allowed and desirable to send this event only once for each
6108 * station to avoid event flooding.
6109 * Return: %true if the frame was passed to userspace (or this failed
6110 * for a reason other than not having a subscription.)
6112 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
6113 const u8 *addr, gfp_t gfp);
6116 * cfg80211_probe_status - notify userspace about probe status
6117 * @dev: the device the probe was sent on
6118 * @addr: the address of the peer
6119 * @cookie: the cookie filled in @probe_client previously
6120 * @acked: indicates whether probe was acked or not
6121 * @ack_signal: signal strength (in dBm) of the ACK frame.
6122 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6123 * @gfp: allocation flags
6125 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
6126 u64 cookie, bool acked, s32 ack_signal,
6127 bool is_valid_ack_signal, gfp_t gfp);
6130 * cfg80211_report_obss_beacon - report beacon from other APs
6131 * @wiphy: The wiphy that received the beacon
6133 * @len: length of the frame
6134 * @freq: frequency the frame was received on
6135 * @sig_dbm: signal strength in dBm, or 0 if unknown
6137 * Use this function to report to userspace when a beacon was
6138 * received. It is not useful to call this when there is no
6139 * netdev that is in AP/GO mode.
6141 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
6142 const u8 *frame, size_t len,
6143 int freq, int sig_dbm);
6146 * cfg80211_reg_can_beacon - check if beaconing is allowed
6148 * @chandef: the channel definition
6149 * @iftype: interface type
6151 * Return: %true if there is no secondary channel or the secondary channel(s)
6152 * can be used for beaconing (i.e. is not a radar channel etc.)
6154 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
6155 struct cfg80211_chan_def *chandef,
6156 enum nl80211_iftype iftype);
6159 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
6161 * @chandef: the channel definition
6162 * @iftype: interface type
6164 * Return: %true if there is no secondary channel or the secondary channel(s)
6165 * can be used for beaconing (i.e. is not a radar channel etc.). This version
6166 * also checks if IR-relaxation conditions apply, to allow beaconing under
6167 * more permissive conditions.
6169 * Requires the RTNL to be held.
6171 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
6172 struct cfg80211_chan_def *chandef,
6173 enum nl80211_iftype iftype);
6176 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
6177 * @dev: the device which switched channels
6178 * @chandef: the new channel definition
6180 * Caller must acquire wdev_lock, therefore must only be called from sleepable
6183 void cfg80211_ch_switch_notify(struct net_device *dev,
6184 struct cfg80211_chan_def *chandef);
6187 * cfg80211_ch_switch_started_notify - notify channel switch start
6188 * @dev: the device on which the channel switch started
6189 * @chandef: the future channel definition
6190 * @count: the number of TBTTs until the channel switch happens
6192 * Inform the userspace about the channel switch that has just
6193 * started, so that it can take appropriate actions (eg. starting
6194 * channel switch on other vifs), if necessary.
6196 void cfg80211_ch_switch_started_notify(struct net_device *dev,
6197 struct cfg80211_chan_def *chandef,
6201 * ieee80211_operating_class_to_band - convert operating class to band
6203 * @operating_class: the operating class to convert
6204 * @band: band pointer to fill
6206 * Returns %true if the conversion was successful, %false otherwise.
6208 bool ieee80211_operating_class_to_band(u8 operating_class,
6209 enum nl80211_band *band);
6212 * ieee80211_chandef_to_operating_class - convert chandef to operation class
6214 * @chandef: the chandef to convert
6215 * @op_class: a pointer to the resulting operating class
6217 * Returns %true if the conversion was successful, %false otherwise.
6219 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
6223 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
6224 * @dev: the device on which the operation is requested
6225 * @peer: the MAC address of the peer device
6226 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
6227 * NL80211_TDLS_TEARDOWN)
6228 * @reason_code: the reason code for teardown request
6229 * @gfp: allocation flags
6231 * This function is used to request userspace to perform TDLS operation that
6232 * requires knowledge of keys, i.e., link setup or teardown when the AP
6233 * connection uses encryption. This is optional mechanism for the driver to use
6234 * if it can automatically determine when a TDLS link could be useful (e.g.,
6235 * based on traffic and signal strength for a peer).
6237 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
6238 enum nl80211_tdls_operation oper,
6239 u16 reason_code, gfp_t gfp);
6242 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
6243 * @rate: given rate_info to calculate bitrate from
6245 * return 0 if MCS index >= 32
6247 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
6250 * cfg80211_unregister_wdev - remove the given wdev
6251 * @wdev: struct wireless_dev to remove
6253 * Call this function only for wdevs that have no netdev assigned,
6254 * e.g. P2P Devices. It removes the device from the list so that
6255 * it can no longer be used. It is necessary to call this function
6256 * even when cfg80211 requests the removal of the interface by
6257 * calling the del_virtual_intf() callback. The function must also
6258 * be called when the driver wishes to unregister the wdev, e.g.
6259 * when the device is unbound from the driver.
6261 * Requires the RTNL to be held.
6263 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
6266 * struct cfg80211_ft_event - FT Information Elements
6268 * @ies_len: length of the FT IE in bytes
6269 * @target_ap: target AP's MAC address
6271 * @ric_ies_len: length of the RIC IE in bytes
6273 struct cfg80211_ft_event_params {
6276 const u8 *target_ap;
6282 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
6283 * @netdev: network device
6284 * @ft_event: IE information
6286 void cfg80211_ft_event(struct net_device *netdev,
6287 struct cfg80211_ft_event_params *ft_event);
6290 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
6291 * @ies: the input IE buffer
6292 * @len: the input length
6293 * @attr: the attribute ID to find
6294 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
6295 * if the function is only called to get the needed buffer size
6296 * @bufsize: size of the output buffer
6298 * The function finds a given P2P attribute in the (vendor) IEs and
6299 * copies its contents to the given buffer.
6301 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
6302 * malformed or the attribute can't be found (respectively), or the
6303 * length of the found attribute (which can be zero).
6305 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
6306 enum ieee80211_p2p_attr_id attr,
6307 u8 *buf, unsigned int bufsize);
6310 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
6311 * @ies: the IE buffer
6312 * @ielen: the length of the IE buffer
6313 * @ids: an array with element IDs that are allowed before
6314 * the split. A WLAN_EID_EXTENSION value means that the next
6315 * EID in the list is a sub-element of the EXTENSION IE.
6316 * @n_ids: the size of the element ID array
6317 * @after_ric: array IE types that come after the RIC element
6318 * @n_after_ric: size of the @after_ric array
6319 * @offset: offset where to start splitting in the buffer
6321 * This function splits an IE buffer by updating the @offset
6322 * variable to point to the location where the buffer should be
6325 * It assumes that the given IE buffer is well-formed, this
6326 * has to be guaranteed by the caller!
6328 * It also assumes that the IEs in the buffer are ordered
6329 * correctly, if not the result of using this function will not
6330 * be ordered correctly either, i.e. it does no reordering.
6332 * The function returns the offset where the next part of the
6333 * buffer starts, which may be @ielen if the entire (remainder)
6334 * of the buffer should be used.
6336 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
6337 const u8 *ids, int n_ids,
6338 const u8 *after_ric, int n_after_ric,
6342 * ieee80211_ie_split - split an IE buffer according to ordering
6343 * @ies: the IE buffer
6344 * @ielen: the length of the IE buffer
6345 * @ids: an array with element IDs that are allowed before
6346 * the split. A WLAN_EID_EXTENSION value means that the next
6347 * EID in the list is a sub-element of the EXTENSION IE.
6348 * @n_ids: the size of the element ID array
6349 * @offset: offset where to start splitting in the buffer
6351 * This function splits an IE buffer by updating the @offset
6352 * variable to point to the location where the buffer should be
6355 * It assumes that the given IE buffer is well-formed, this
6356 * has to be guaranteed by the caller!
6358 * It also assumes that the IEs in the buffer are ordered
6359 * correctly, if not the result of using this function will not
6360 * be ordered correctly either, i.e. it does no reordering.
6362 * The function returns the offset where the next part of the
6363 * buffer starts, which may be @ielen if the entire (remainder)
6364 * of the buffer should be used.
6366 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
6367 const u8 *ids, int n_ids, size_t offset)
6369 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
6373 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
6374 * @wdev: the wireless device reporting the wakeup
6375 * @wakeup: the wakeup report
6376 * @gfp: allocation flags
6378 * This function reports that the given device woke up. If it
6379 * caused the wakeup, report the reason(s), otherwise you may
6380 * pass %NULL as the @wakeup parameter to advertise that something
6381 * else caused the wakeup.
6383 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
6384 struct cfg80211_wowlan_wakeup *wakeup,
6388 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
6390 * @wdev: the wireless device for which critical protocol is stopped.
6391 * @gfp: allocation flags
6393 * This function can be called by the driver to indicate it has reverted
6394 * operation back to normal. One reason could be that the duration given
6395 * by .crit_proto_start() has expired.
6397 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
6400 * ieee80211_get_num_supported_channels - get number of channels device has
6403 * Return: the number of channels supported by the device.
6405 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
6408 * cfg80211_check_combinations - check interface combinations
6411 * @params: the interface combinations parameter
6413 * This function can be called by the driver to check whether a
6414 * combination of interfaces and their types are allowed according to
6415 * the interface combinations.
6417 int cfg80211_check_combinations(struct wiphy *wiphy,
6418 struct iface_combination_params *params);
6421 * cfg80211_iter_combinations - iterate over matching combinations
6424 * @params: the interface combinations parameter
6425 * @iter: function to call for each matching combination
6426 * @data: pointer to pass to iter function
6428 * This function can be called by the driver to check what possible
6429 * combinations it fits in at a given moment, e.g. for channel switching
6432 int cfg80211_iter_combinations(struct wiphy *wiphy,
6433 struct iface_combination_params *params,
6434 void (*iter)(const struct ieee80211_iface_combination *c,
6439 * cfg80211_stop_iface - trigger interface disconnection
6442 * @wdev: wireless device
6443 * @gfp: context flags
6445 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
6448 * Note: This doesn't need any locks and is asynchronous.
6450 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
6454 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
6455 * @wiphy: the wiphy to shut down
6457 * This function shuts down all interfaces belonging to this wiphy by
6458 * calling dev_close() (and treating non-netdev interfaces as needed).
6459 * It shouldn't really be used unless there are some fatal device errors
6460 * that really can't be recovered in any other way.
6462 * Callers must hold the RTNL and be able to deal with callbacks into
6463 * the driver while the function is running.
6465 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
6468 * wiphy_ext_feature_set - set the extended feature flag
6470 * @wiphy: the wiphy to modify.
6471 * @ftidx: extended feature bit index.
6473 * The extended features are flagged in multiple bytes (see
6474 * &struct wiphy.@ext_features)
6476 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
6477 enum nl80211_ext_feature_index ftidx)
6481 ft_byte = &wiphy->ext_features[ftidx / 8];
6482 *ft_byte |= BIT(ftidx % 8);
6486 * wiphy_ext_feature_isset - check the extended feature flag
6488 * @wiphy: the wiphy to modify.
6489 * @ftidx: extended feature bit index.
6491 * The extended features are flagged in multiple bytes (see
6492 * &struct wiphy.@ext_features)
6495 wiphy_ext_feature_isset(struct wiphy *wiphy,
6496 enum nl80211_ext_feature_index ftidx)
6500 ft_byte = wiphy->ext_features[ftidx / 8];
6501 return (ft_byte & BIT(ftidx % 8)) != 0;
6505 * cfg80211_free_nan_func - free NAN function
6506 * @f: NAN function that should be freed
6508 * Frees all the NAN function and all it's allocated members.
6510 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
6513 * struct cfg80211_nan_match_params - NAN match parameters
6514 * @type: the type of the function that triggered a match. If it is
6515 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
6516 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
6518 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
6519 * @inst_id: the local instance id
6520 * @peer_inst_id: the instance id of the peer's function
6521 * @addr: the MAC address of the peer
6522 * @info_len: the length of the &info
6523 * @info: the Service Specific Info from the peer (if any)
6524 * @cookie: unique identifier of the corresponding function
6526 struct cfg80211_nan_match_params {
6527 enum nl80211_nan_function_type type;
6537 * cfg80211_nan_match - report a match for a NAN function.
6538 * @wdev: the wireless device reporting the match
6539 * @match: match notification parameters
6540 * @gfp: allocation flags
6542 * This function reports that the a NAN function had a match. This
6543 * can be a subscribe that had a match or a solicited publish that
6544 * was sent. It can also be a follow up that was received.
6546 void cfg80211_nan_match(struct wireless_dev *wdev,
6547 struct cfg80211_nan_match_params *match, gfp_t gfp);
6550 * cfg80211_nan_func_terminated - notify about NAN function termination.
6552 * @wdev: the wireless device reporting the match
6553 * @inst_id: the local instance id
6554 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6555 * @cookie: unique NAN function identifier
6556 * @gfp: allocation flags
6558 * This function reports that the a NAN function is terminated.
6560 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
6562 enum nl80211_nan_func_term_reason reason,
6563 u64 cookie, gfp_t gfp);
6565 /* ethtool helper */
6566 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
6569 * cfg80211_external_auth_request - userspace request for authentication
6570 * @netdev: network device
6571 * @params: External authentication parameters
6572 * @gfp: allocation flags
6573 * Returns: 0 on success, < 0 on error
6575 int cfg80211_external_auth_request(struct net_device *netdev,
6576 struct cfg80211_external_auth_params *params,
6579 /* Logging, debugging and troubleshooting/diagnostic helpers. */
6581 /* wiphy_printk helpers, similar to dev_printk */
6583 #define wiphy_printk(level, wiphy, format, args...) \
6584 dev_printk(level, &(wiphy)->dev, format, ##args)
6585 #define wiphy_emerg(wiphy, format, args...) \
6586 dev_emerg(&(wiphy)->dev, format, ##args)
6587 #define wiphy_alert(wiphy, format, args...) \
6588 dev_alert(&(wiphy)->dev, format, ##args)
6589 #define wiphy_crit(wiphy, format, args...) \
6590 dev_crit(&(wiphy)->dev, format, ##args)
6591 #define wiphy_err(wiphy, format, args...) \
6592 dev_err(&(wiphy)->dev, format, ##args)
6593 #define wiphy_warn(wiphy, format, args...) \
6594 dev_warn(&(wiphy)->dev, format, ##args)
6595 #define wiphy_notice(wiphy, format, args...) \
6596 dev_notice(&(wiphy)->dev, format, ##args)
6597 #define wiphy_info(wiphy, format, args...) \
6598 dev_info(&(wiphy)->dev, format, ##args)
6600 #define wiphy_debug(wiphy, format, args...) \
6601 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
6603 #define wiphy_dbg(wiphy, format, args...) \
6604 dev_dbg(&(wiphy)->dev, format, ##args)
6606 #if defined(VERBOSE_DEBUG)
6607 #define wiphy_vdbg wiphy_dbg
6609 #define wiphy_vdbg(wiphy, format, args...) \
6612 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
6618 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
6619 * of using a WARN/WARN_ON to get the message out, including the
6620 * file/line information and a backtrace.
6622 #define wiphy_WARN(wiphy, format, args...) \
6623 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
6625 #endif /* __NET_CFG80211_H */