1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __NET_CFG80211_H
3 #define __NET_CFG80211_H
5 * 802.11 device and configuration interface
7 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright 2015-2017 Intel Deutschland GmbH
10 * Copyright (C) 2018-2020 Intel Corporation
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <linux/net.h>
23 #include <net/regulatory.h>
28 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29 * userspace and drivers, and offers some utility functionality associated
30 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31 * by all modern wireless drivers in Linux, so that they offer a consistent
32 * API through nl80211. For backward compatibility, cfg80211 also offers
33 * wireless extensions to userspace, but hides them from drivers completely.
35 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
41 * DOC: Device registration
43 * In order for a driver to use cfg80211, it must register the hardware device
44 * with cfg80211. This happens through a number of hardware capability structs
47 * The fundamental structure for each device is the 'wiphy', of which each
48 * instance describes a physical wireless device connected to the system. Each
49 * such wiphy can have zero, one, or many virtual interfaces associated with
50 * it, which need to be identified as such by pointing the network interface's
51 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52 * the wireless part of the interface, normally this struct is embedded in the
53 * network interface's private data area. Drivers can optionally allow creating
54 * or destroying virtual interfaces on the fly, but without at least one or the
55 * ability to create some the wireless device isn't useful.
57 * Each wiphy structure contains device capability information, and also has
58 * a pointer to the various operations the driver offers. The definitions and
59 * structures here describe these capabilities in detail.
65 * wireless hardware capability structures
69 * enum ieee80211_channel_flags - channel flags
71 * Channel flags set by the regulatory control code.
73 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
74 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
75 * sending probe requests or beaconing.
76 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
77 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
79 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
81 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
82 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
83 * this flag indicates that an 80 MHz channel cannot use this
84 * channel as the control or any of the secondary channels.
85 * This may be due to the driver or due to regulatory bandwidth
87 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
88 * this flag indicates that an 160 MHz channel cannot use this
89 * channel as the control or any of the secondary channels.
90 * This may be due to the driver or due to regulatory bandwidth
92 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
93 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
94 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
96 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
98 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
99 * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted
101 * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted
103 * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted
105 * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted
107 * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted
111 enum ieee80211_channel_flags
{
112 IEEE80211_CHAN_DISABLED
= 1<<0,
113 IEEE80211_CHAN_NO_IR
= 1<<1,
115 IEEE80211_CHAN_RADAR
= 1<<3,
116 IEEE80211_CHAN_NO_HT40PLUS
= 1<<4,
117 IEEE80211_CHAN_NO_HT40MINUS
= 1<<5,
118 IEEE80211_CHAN_NO_OFDM
= 1<<6,
119 IEEE80211_CHAN_NO_80MHZ
= 1<<7,
120 IEEE80211_CHAN_NO_160MHZ
= 1<<8,
121 IEEE80211_CHAN_INDOOR_ONLY
= 1<<9,
122 IEEE80211_CHAN_IR_CONCURRENT
= 1<<10,
123 IEEE80211_CHAN_NO_20MHZ
= 1<<11,
124 IEEE80211_CHAN_NO_10MHZ
= 1<<12,
125 IEEE80211_CHAN_NO_HE
= 1<<13,
126 IEEE80211_CHAN_1MHZ
= 1<<14,
127 IEEE80211_CHAN_2MHZ
= 1<<15,
128 IEEE80211_CHAN_4MHZ
= 1<<16,
129 IEEE80211_CHAN_8MHZ
= 1<<17,
130 IEEE80211_CHAN_16MHZ
= 1<<18,
133 #define IEEE80211_CHAN_NO_HT40 \
134 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
136 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
137 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
140 * struct ieee80211_channel - channel definition
142 * This structure describes a single channel for use
145 * @center_freq: center frequency in MHz
146 * @freq_offset: offset from @center_freq, in KHz
147 * @hw_value: hardware-specific value for the channel
148 * @flags: channel flags from &enum ieee80211_channel_flags.
149 * @orig_flags: channel flags at registration time, used by regulatory
150 * code to support devices with additional restrictions
151 * @band: band this channel belongs to.
152 * @max_antenna_gain: maximum antenna gain in dBi
153 * @max_power: maximum transmission power (in dBm)
154 * @max_reg_power: maximum regulatory transmission power (in dBm)
155 * @beacon_found: helper to regulatory code to indicate when a beacon
156 * has been found on this channel. Use regulatory_hint_found_beacon()
157 * to enable this, this is useful only on 5 GHz band.
158 * @orig_mag: internal use
159 * @orig_mpwr: internal use
160 * @dfs_state: current state of this channel. Only relevant if radar is required
162 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
163 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
165 struct ieee80211_channel
{
166 enum nl80211_band band
;
171 int max_antenna_gain
;
176 int orig_mag
, orig_mpwr
;
177 enum nl80211_dfs_state dfs_state
;
178 unsigned long dfs_state_entered
;
179 unsigned int dfs_cac_ms
;
183 * enum ieee80211_rate_flags - rate flags
185 * Hardware/specification flags for rates. These are structured
186 * in a way that allows using the same bitrate structure for
187 * different bands/PHY modes.
189 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
190 * preamble on this bitrate; only relevant in 2.4GHz band and
192 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
193 * when used with 802.11a (on the 5 GHz band); filled by the
194 * core code when registering the wiphy.
195 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
196 * when used with 802.11b (on the 2.4 GHz band); filled by the
197 * core code when registering the wiphy.
198 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
199 * when used with 802.11g (on the 2.4 GHz band); filled by the
200 * core code when registering the wiphy.
201 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
202 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
203 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
205 enum ieee80211_rate_flags
{
206 IEEE80211_RATE_SHORT_PREAMBLE
= 1<<0,
207 IEEE80211_RATE_MANDATORY_A
= 1<<1,
208 IEEE80211_RATE_MANDATORY_B
= 1<<2,
209 IEEE80211_RATE_MANDATORY_G
= 1<<3,
210 IEEE80211_RATE_ERP_G
= 1<<4,
211 IEEE80211_RATE_SUPPORTS_5MHZ
= 1<<5,
212 IEEE80211_RATE_SUPPORTS_10MHZ
= 1<<6,
216 * enum ieee80211_bss_type - BSS type filter
218 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
219 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
220 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
221 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
222 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
224 enum ieee80211_bss_type
{
225 IEEE80211_BSS_TYPE_ESS
,
226 IEEE80211_BSS_TYPE_PBSS
,
227 IEEE80211_BSS_TYPE_IBSS
,
228 IEEE80211_BSS_TYPE_MBSS
,
229 IEEE80211_BSS_TYPE_ANY
233 * enum ieee80211_privacy - BSS privacy filter
235 * @IEEE80211_PRIVACY_ON: privacy bit set
236 * @IEEE80211_PRIVACY_OFF: privacy bit clear
237 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
239 enum ieee80211_privacy
{
240 IEEE80211_PRIVACY_ON
,
241 IEEE80211_PRIVACY_OFF
,
242 IEEE80211_PRIVACY_ANY
245 #define IEEE80211_PRIVACY(x) \
246 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
249 * struct ieee80211_rate - bitrate definition
251 * This structure describes a bitrate that an 802.11 PHY can
252 * operate with. The two values @hw_value and @hw_value_short
253 * are only for driver use when pointers to this structure are
256 * @flags: rate-specific flags
257 * @bitrate: bitrate in units of 100 Kbps
258 * @hw_value: driver/hardware value for this rate
259 * @hw_value_short: driver/hardware value for this rate when
260 * short preamble is used
262 struct ieee80211_rate
{
265 u16 hw_value
, hw_value_short
;
269 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
271 * @enable: is the feature enabled.
272 * @sr_ctrl: The SR Control field of SRP element.
273 * @non_srg_max_offset: non-SRG maximum tx power offset
274 * @min_offset: minimal tx power offset an associated station shall use
275 * @max_offset: maximum tx power offset an associated station shall use
276 * @bss_color_bitmap: bitmap that indicates the BSS color values used by
278 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
279 * used by members of the SRG
281 struct ieee80211_he_obss_pd
{
284 u8 non_srg_max_offset
;
287 u8 bss_color_bitmap
[8];
288 u8 partial_bssid_bitmap
[8];
292 * struct cfg80211_he_bss_color - AP settings for BSS coloring
294 * @color: the current color.
295 * @enabled: HE BSS color is used
296 * @partial: define the AID equation.
298 struct cfg80211_he_bss_color
{
305 * struct ieee80211_he_bss_color - AP settings for BSS coloring
307 * @color: the current color.
308 * @disabled: is the feature disabled.
309 * @partial: define the AID equation.
311 struct ieee80211_he_bss_color
{
318 * struct ieee80211_sta_ht_cap - STA's HT capabilities
320 * This structure describes most essential parameters needed
321 * to describe 802.11n HT capabilities for an STA.
323 * @ht_supported: is HT supported by the STA
324 * @cap: HT capabilities map as described in 802.11n spec
325 * @ampdu_factor: Maximum A-MPDU length factor
326 * @ampdu_density: Minimum A-MPDU spacing
327 * @mcs: Supported MCS rates
329 struct ieee80211_sta_ht_cap
{
330 u16 cap
; /* use IEEE80211_HT_CAP_ */
334 struct ieee80211_mcs_info mcs
;
338 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
340 * This structure describes most essential parameters needed
341 * to describe 802.11ac VHT capabilities for an STA.
343 * @vht_supported: is VHT supported by the STA
344 * @cap: VHT capabilities map as described in 802.11ac spec
345 * @vht_mcs: Supported VHT MCS rates
347 struct ieee80211_sta_vht_cap
{
349 u32 cap
; /* use IEEE80211_VHT_CAP_ */
350 struct ieee80211_vht_mcs_info vht_mcs
;
353 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
356 * struct ieee80211_sta_he_cap - STA's HE capabilities
358 * This structure describes most essential parameters needed
359 * to describe 802.11ax HE capabilities for a STA.
361 * @has_he: true iff HE data is valid.
362 * @he_cap_elem: Fixed portion of the HE capabilities element.
363 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
364 * @ppe_thres: Holds the PPE Thresholds data.
366 struct ieee80211_sta_he_cap
{
368 struct ieee80211_he_cap_elem he_cap_elem
;
369 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp
;
370 u8 ppe_thres
[IEEE80211_HE_PPE_THRES_MAX_LEN
];
374 * struct ieee80211_sband_iftype_data
376 * This structure encapsulates sband data that is relevant for the
377 * interface types defined in @types_mask. Each type in the
378 * @types_mask must be unique across all instances of iftype_data.
380 * @types_mask: interface types mask
381 * @he_cap: holds the HE capabilities
382 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
383 * 6 GHz band channel (and 0 may be valid value).
385 struct ieee80211_sband_iftype_data
{
387 struct ieee80211_sta_he_cap he_cap
;
388 struct ieee80211_he_6ghz_capa he_6ghz_capa
;
392 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
394 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
395 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
396 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
397 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
398 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
399 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
400 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
401 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
403 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
405 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
407 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
408 * and 4.32GHz + 4.32GHz
409 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
410 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
412 enum ieee80211_edmg_bw_config
{
413 IEEE80211_EDMG_BW_CONFIG_4
= 4,
414 IEEE80211_EDMG_BW_CONFIG_5
= 5,
415 IEEE80211_EDMG_BW_CONFIG_6
= 6,
416 IEEE80211_EDMG_BW_CONFIG_7
= 7,
417 IEEE80211_EDMG_BW_CONFIG_8
= 8,
418 IEEE80211_EDMG_BW_CONFIG_9
= 9,
419 IEEE80211_EDMG_BW_CONFIG_10
= 10,
420 IEEE80211_EDMG_BW_CONFIG_11
= 11,
421 IEEE80211_EDMG_BW_CONFIG_12
= 12,
422 IEEE80211_EDMG_BW_CONFIG_13
= 13,
423 IEEE80211_EDMG_BW_CONFIG_14
= 14,
424 IEEE80211_EDMG_BW_CONFIG_15
= 15,
428 * struct ieee80211_edmg - EDMG configuration
430 * This structure describes most essential parameters needed
431 * to describe 802.11ay EDMG configuration
433 * @channels: bitmap that indicates the 2.16 GHz channel(s)
434 * that are allowed to be used for transmissions.
435 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
436 * Set to 0 indicate EDMG not supported.
437 * @bw_config: Channel BW Configuration subfield encodes
438 * the allowed channel bandwidth configurations
440 struct ieee80211_edmg
{
442 enum ieee80211_edmg_bw_config bw_config
;
446 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
448 * This structure describes most essential parameters needed
449 * to describe 802.11ah S1G capabilities for a STA.
451 * @s1g_supported: is STA an S1G STA
452 * @cap: S1G capabilities information
453 * @nss_mcs: Supported NSS MCS set
455 struct ieee80211_sta_s1g_cap
{
457 u8 cap
[10]; /* use S1G_CAPAB_ */
462 * struct ieee80211_supported_band - frequency band definition
464 * This structure describes a frequency band a wiphy
465 * is able to operate in.
467 * @channels: Array of channels the hardware can operate with
469 * @band: the band this structure represents
470 * @n_channels: Number of channels in @channels
471 * @bitrates: Array of bitrates the hardware can operate with
472 * in this band. Must be sorted to give a valid "supported
473 * rates" IE, i.e. CCK rates first, then OFDM.
474 * @n_bitrates: Number of bitrates in @bitrates
475 * @ht_cap: HT capabilities in this band
476 * @vht_cap: VHT capabilities in this band
477 * @s1g_cap: S1G capabilities in this band
478 * @edmg_cap: EDMG capabilities in this band
479 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
480 * @n_iftype_data: number of iftype data entries
481 * @iftype_data: interface type data entries. Note that the bits in
482 * @types_mask inside this structure cannot overlap (i.e. only
483 * one occurrence of each type is allowed across all instances of
486 struct ieee80211_supported_band
{
487 struct ieee80211_channel
*channels
;
488 struct ieee80211_rate
*bitrates
;
489 enum nl80211_band band
;
492 struct ieee80211_sta_ht_cap ht_cap
;
493 struct ieee80211_sta_vht_cap vht_cap
;
494 struct ieee80211_sta_s1g_cap s1g_cap
;
495 struct ieee80211_edmg edmg_cap
;
497 const struct ieee80211_sband_iftype_data
*iftype_data
;
501 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
502 * @sband: the sband to search for the STA on
503 * @iftype: enum nl80211_iftype
505 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
507 static inline const struct ieee80211_sband_iftype_data
*
508 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band
*sband
,
513 if (WARN_ON(iftype
>= NL80211_IFTYPE_MAX
))
516 for (i
= 0; i
< sband
->n_iftype_data
; i
++) {
517 const struct ieee80211_sband_iftype_data
*data
=
518 &sband
->iftype_data
[i
];
520 if (data
->types_mask
& BIT(iftype
))
528 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
529 * @sband: the sband to search for the iftype on
530 * @iftype: enum nl80211_iftype
532 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
534 static inline const struct ieee80211_sta_he_cap
*
535 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band
*sband
,
538 const struct ieee80211_sband_iftype_data
*data
=
539 ieee80211_get_sband_iftype_data(sband
, iftype
);
541 if (data
&& data
->he_cap
.has_he
)
542 return &data
->he_cap
;
548 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
549 * @sband: the sband to search for the STA on
551 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
553 static inline const struct ieee80211_sta_he_cap
*
554 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band
*sband
)
556 return ieee80211_get_he_iftype_cap(sband
, NL80211_IFTYPE_STATION
);
560 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
561 * @sband: the sband to search for the STA on
562 * @iftype: the iftype to search for
564 * Return: the 6GHz capabilities
567 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band
*sband
,
568 enum nl80211_iftype iftype
)
570 const struct ieee80211_sband_iftype_data
*data
=
571 ieee80211_get_sband_iftype_data(sband
, iftype
);
573 if (WARN_ON(!data
|| !data
->he_cap
.has_he
))
576 return data
->he_6ghz_capa
.capa
;
580 * wiphy_read_of_freq_limits - read frequency limits from device tree
582 * @wiphy: the wireless device to get extra limits for
584 * Some devices may have extra limitations specified in DT. This may be useful
585 * for chipsets that normally support more bands but are limited due to board
586 * design (e.g. by antennas or external power amplifier).
588 * This function reads info from DT and uses it to *modify* channels (disable
589 * unavailable ones). It's usually a *bad* idea to use it in drivers with
590 * shared channel data as DT limitations are device specific. You should make
591 * sure to call it only if channels in wiphy are copied and can be modified
592 * without affecting other devices.
594 * As this function access device node it has to be called after set_wiphy_dev.
595 * It also modifies channels so they have to be set first.
596 * If using this helper, call it before wiphy_register().
599 void wiphy_read_of_freq_limits(struct wiphy
*wiphy
);
600 #else /* CONFIG_OF */
601 static inline void wiphy_read_of_freq_limits(struct wiphy
*wiphy
)
604 #endif /* !CONFIG_OF */
608 * Wireless hardware/device configuration structures and methods
612 * DOC: Actions and configuration
614 * Each wireless device and each virtual interface offer a set of configuration
615 * operations and other actions that are invoked by userspace. Each of these
616 * actions is described in the operations structure, and the parameters these
617 * operations use are described separately.
619 * Additionally, some operations are asynchronous and expect to get status
620 * information via some functions that drivers need to call.
622 * Scanning and BSS list handling with its associated functionality is described
623 * in a separate chapter.
626 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
627 WLAN_USER_POSITION_LEN)
630 * struct vif_params - describes virtual interface parameters
631 * @flags: monitor interface flags, unchanged if 0, otherwise
632 * %MONITOR_FLAG_CHANGED will be set
633 * @use_4addr: use 4-address frames
634 * @macaddr: address to use for this virtual interface.
635 * If this parameter is set to zero address the driver may
636 * determine the address as needed.
637 * This feature is only fully supported by drivers that enable the
638 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
639 ** only p2p devices with specified MAC.
640 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
641 * belonging to that MU-MIMO groupID; %NULL if not changed
642 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
643 * MU-MIMO packets going to the specified station; %NULL if not changed
648 u8 macaddr
[ETH_ALEN
];
649 const u8
*vht_mumimo_groups
;
650 const u8
*vht_mumimo_follow_addr
;
654 * struct key_params - key information
656 * Information about a key
659 * @key_len: length of key material
660 * @cipher: cipher suite selector
661 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
662 * with the get_key() callback, must be in little endian,
663 * length given by @seq_len.
664 * @seq_len: length of @seq.
665 * @vlan_id: vlan_id for VLAN group key (if nonzero)
666 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
675 enum nl80211_key_mode mode
;
679 * struct cfg80211_chan_def - channel definition
680 * @chan: the (control) channel
681 * @width: channel width
682 * @center_freq1: center frequency of first segment
683 * @center_freq2: center frequency of second segment
684 * (only with 80+80 MHz)
685 * @edmg: define the EDMG channels configuration.
686 * If edmg is requested (i.e. the .channels member is non-zero),
687 * chan will define the primary channel and all other
688 * parameters are ignored.
689 * @freq1_offset: offset from @center_freq1, in KHz
691 struct cfg80211_chan_def
{
692 struct ieee80211_channel
*chan
;
693 enum nl80211_chan_width width
;
696 struct ieee80211_edmg edmg
;
701 * cfg80211_bitrate_mask - masks for bitrate control
703 struct cfg80211_bitrate_mask
{
706 u8 ht_mcs
[IEEE80211_HT_MCS_MASK_LEN
];
707 u16 vht_mcs
[NL80211_VHT_NSS_MAX
];
708 u16 he_mcs
[NL80211_HE_NSS_MAX
];
709 enum nl80211_txrate_gi gi
;
710 enum nl80211_he_gi he_gi
;
711 enum nl80211_he_ltf he_ltf
;
712 } control
[NUM_NL80211_BANDS
];
717 * struct cfg80211_tid_cfg - TID specific configuration
718 * @config_override: Flag to notify driver to reset TID configuration
720 * @tids: bitmap of TIDs to modify
721 * @mask: bitmap of attributes indicating which parameter changed,
722 * similar to &nl80211_tid_config_supp.
723 * @noack: noack configuration value for the TID
724 * @retry_long: retry count value
725 * @retry_short: retry count value
726 * @ampdu: Enable/Disable MPDU aggregation
727 * @rtscts: Enable/Disable RTS/CTS
728 * @amsdu: Enable/Disable MSDU aggregation
729 * @txrate_type: Tx bitrate mask type
730 * @txrate_mask: Tx bitrate to be applied for the TID
732 struct cfg80211_tid_cfg
{
733 bool config_override
;
736 enum nl80211_tid_config noack
;
737 u8 retry_long
, retry_short
;
738 enum nl80211_tid_config ampdu
;
739 enum nl80211_tid_config rtscts
;
740 enum nl80211_tid_config amsdu
;
741 enum nl80211_tx_rate_setting txrate_type
;
742 struct cfg80211_bitrate_mask txrate_mask
;
746 * struct cfg80211_tid_config - TID configuration
747 * @peer: Station's MAC address
748 * @n_tid_conf: Number of TID specific configurations to be applied
749 * @tid_conf: Configuration change info
751 struct cfg80211_tid_config
{
754 struct cfg80211_tid_cfg tid_conf
[];
758 * cfg80211_get_chandef_type - return old channel type from chandef
759 * @chandef: the channel definition
761 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
762 * chandef, which must have a bandwidth allowing this conversion.
764 static inline enum nl80211_channel_type
765 cfg80211_get_chandef_type(const struct cfg80211_chan_def
*chandef
)
767 switch (chandef
->width
) {
768 case NL80211_CHAN_WIDTH_20_NOHT
:
769 return NL80211_CHAN_NO_HT
;
770 case NL80211_CHAN_WIDTH_20
:
771 return NL80211_CHAN_HT20
;
772 case NL80211_CHAN_WIDTH_40
:
773 if (chandef
->center_freq1
> chandef
->chan
->center_freq
)
774 return NL80211_CHAN_HT40PLUS
;
775 return NL80211_CHAN_HT40MINUS
;
778 return NL80211_CHAN_NO_HT
;
783 * cfg80211_chandef_create - create channel definition using channel type
784 * @chandef: the channel definition struct to fill
785 * @channel: the control channel
786 * @chantype: the channel type
788 * Given a channel type, create a channel definition.
790 void cfg80211_chandef_create(struct cfg80211_chan_def
*chandef
,
791 struct ieee80211_channel
*channel
,
792 enum nl80211_channel_type chantype
);
795 * cfg80211_chandef_identical - check if two channel definitions are identical
796 * @chandef1: first channel definition
797 * @chandef2: second channel definition
799 * Return: %true if the channels defined by the channel definitions are
800 * identical, %false otherwise.
803 cfg80211_chandef_identical(const struct cfg80211_chan_def
*chandef1
,
804 const struct cfg80211_chan_def
*chandef2
)
806 return (chandef1
->chan
== chandef2
->chan
&&
807 chandef1
->width
== chandef2
->width
&&
808 chandef1
->center_freq1
== chandef2
->center_freq1
&&
809 chandef1
->freq1_offset
== chandef2
->freq1_offset
&&
810 chandef1
->center_freq2
== chandef2
->center_freq2
);
814 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
816 * @chandef: the channel definition
818 * Return: %true if EDMG defined, %false otherwise.
821 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def
*chandef
)
823 return chandef
->edmg
.channels
|| chandef
->edmg
.bw_config
;
827 * cfg80211_chandef_compatible - check if two channel definitions are compatible
828 * @chandef1: first channel definition
829 * @chandef2: second channel definition
831 * Return: %NULL if the given channel definitions are incompatible,
832 * chandef1 or chandef2 otherwise.
834 const struct cfg80211_chan_def
*
835 cfg80211_chandef_compatible(const struct cfg80211_chan_def
*chandef1
,
836 const struct cfg80211_chan_def
*chandef2
);
839 * cfg80211_chandef_valid - check if a channel definition is valid
840 * @chandef: the channel definition to check
841 * Return: %true if the channel definition is valid. %false otherwise.
843 bool cfg80211_chandef_valid(const struct cfg80211_chan_def
*chandef
);
846 * cfg80211_chandef_usable - check if secondary channels can be used
847 * @wiphy: the wiphy to validate against
848 * @chandef: the channel definition to check
849 * @prohibited_flags: the regulatory channel flags that must not be set
850 * Return: %true if secondary channels are usable. %false otherwise.
852 bool cfg80211_chandef_usable(struct wiphy
*wiphy
,
853 const struct cfg80211_chan_def
*chandef
,
854 u32 prohibited_flags
);
857 * cfg80211_chandef_dfs_required - checks if radar detection is required
858 * @wiphy: the wiphy to validate against
859 * @chandef: the channel definition to check
860 * @iftype: the interface type as specified in &enum nl80211_iftype
862 * 1 if radar detection is required, 0 if it is not, < 0 on error
864 int cfg80211_chandef_dfs_required(struct wiphy
*wiphy
,
865 const struct cfg80211_chan_def
*chandef
,
866 enum nl80211_iftype iftype
);
869 * ieee80211_chandef_rate_flags - returns rate flags for a channel
871 * In some channel types, not all rates may be used - for example CCK
872 * rates may not be used in 5/10 MHz channels.
874 * @chandef: channel definition for the channel
876 * Returns: rate flags which apply for this channel
878 static inline enum ieee80211_rate_flags
879 ieee80211_chandef_rate_flags(struct cfg80211_chan_def
*chandef
)
881 switch (chandef
->width
) {
882 case NL80211_CHAN_WIDTH_5
:
883 return IEEE80211_RATE_SUPPORTS_5MHZ
;
884 case NL80211_CHAN_WIDTH_10
:
885 return IEEE80211_RATE_SUPPORTS_10MHZ
;
893 * ieee80211_chandef_max_power - maximum transmission power for the chandef
895 * In some regulations, the transmit power may depend on the configured channel
896 * bandwidth which may be defined as dBm/MHz. This function returns the actual
897 * max_power for non-standard (20 MHz) channels.
899 * @chandef: channel definition for the channel
901 * Returns: maximum allowed transmission power in dBm for the chandef
904 ieee80211_chandef_max_power(struct cfg80211_chan_def
*chandef
)
906 switch (chandef
->width
) {
907 case NL80211_CHAN_WIDTH_5
:
908 return min(chandef
->chan
->max_reg_power
- 6,
909 chandef
->chan
->max_power
);
910 case NL80211_CHAN_WIDTH_10
:
911 return min(chandef
->chan
->max_reg_power
- 3,
912 chandef
->chan
->max_power
);
916 return chandef
->chan
->max_power
;
920 * enum survey_info_flags - survey information flags
922 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
923 * @SURVEY_INFO_IN_USE: channel is currently being used
924 * @SURVEY_INFO_TIME: active time (in ms) was filled in
925 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
926 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
927 * @SURVEY_INFO_TIME_RX: receive time was filled in
928 * @SURVEY_INFO_TIME_TX: transmit time was filled in
929 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
930 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
932 * Used by the driver to indicate which info in &struct survey_info
933 * it has filled in during the get_survey().
935 enum survey_info_flags
{
936 SURVEY_INFO_NOISE_DBM
= BIT(0),
937 SURVEY_INFO_IN_USE
= BIT(1),
938 SURVEY_INFO_TIME
= BIT(2),
939 SURVEY_INFO_TIME_BUSY
= BIT(3),
940 SURVEY_INFO_TIME_EXT_BUSY
= BIT(4),
941 SURVEY_INFO_TIME_RX
= BIT(5),
942 SURVEY_INFO_TIME_TX
= BIT(6),
943 SURVEY_INFO_TIME_SCAN
= BIT(7),
944 SURVEY_INFO_TIME_BSS_RX
= BIT(8),
948 * struct survey_info - channel survey response
950 * @channel: the channel this survey record reports, may be %NULL for a single
951 * record to report global statistics
952 * @filled: bitflag of flags from &enum survey_info_flags
953 * @noise: channel noise in dBm. This and all following fields are
955 * @time: amount of time in ms the radio was turn on (on the channel)
956 * @time_busy: amount of time the primary channel was sensed busy
957 * @time_ext_busy: amount of time the extension channel was sensed busy
958 * @time_rx: amount of time the radio spent receiving data
959 * @time_tx: amount of time the radio spent transmitting data
960 * @time_scan: amount of time the radio spent for scanning
961 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
963 * Used by dump_survey() to report back per-channel survey information.
965 * This structure can later be expanded with things like
966 * channel duty cycle etc.
969 struct ieee80211_channel
*channel
;
981 #define CFG80211_MAX_WEP_KEYS 4
984 * struct cfg80211_crypto_settings - Crypto settings
985 * @wpa_versions: indicates which, if any, WPA versions are enabled
986 * (from enum nl80211_wpa_versions)
987 * @cipher_group: group key cipher suite (or 0 if unset)
988 * @n_ciphers_pairwise: number of AP supported unicast ciphers
989 * @ciphers_pairwise: unicast key cipher suites
990 * @n_akm_suites: number of AKM suites
991 * @akm_suites: AKM suites
992 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
993 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
994 * required to assume that the port is unauthorized until authorized by
995 * user space. Otherwise, port is marked authorized by default.
996 * @control_port_ethertype: the control port protocol that should be
997 * allowed through even on unauthorized ports
998 * @control_port_no_encrypt: TRUE to prevent encryption of control port
1000 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1001 * port frames over NL80211 instead of the network interface.
1002 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
1004 * @wep_keys: static WEP keys, if not NULL points to an array of
1005 * CFG80211_MAX_WEP_KEYS WEP keys
1006 * @wep_tx_key: key index (0..3) of the default TX static WEP key
1007 * @psk: PSK (for devices supporting 4-way-handshake offload)
1008 * @sae_pwd: password for SAE authentication (for devices supporting SAE
1010 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1012 struct cfg80211_crypto_settings
{
1015 int n_ciphers_pairwise
;
1016 u32 ciphers_pairwise
[NL80211_MAX_NR_CIPHER_SUITES
];
1018 u32 akm_suites
[NL80211_MAX_NR_AKM_SUITES
];
1020 __be16 control_port_ethertype
;
1021 bool control_port_no_encrypt
;
1022 bool control_port_over_nl80211
;
1023 bool control_port_no_preauth
;
1024 struct key_params
*wep_keys
;
1032 * struct cfg80211_beacon_data - beacon data
1033 * @head: head portion of beacon (before TIM IE)
1034 * or %NULL if not changed
1035 * @tail: tail portion of beacon (after TIM IE)
1036 * or %NULL if not changed
1037 * @head_len: length of @head
1038 * @tail_len: length of @tail
1039 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1040 * @beacon_ies_len: length of beacon_ies in octets
1041 * @proberesp_ies: extra information element(s) to add into Probe Response
1043 * @proberesp_ies_len: length of proberesp_ies in octets
1044 * @assocresp_ies: extra information element(s) to add into (Re)Association
1045 * Response frames or %NULL
1046 * @assocresp_ies_len: length of assocresp_ies in octets
1047 * @probe_resp_len: length of probe response template (@probe_resp)
1048 * @probe_resp: probe response template (AP mode only)
1049 * @ftm_responder: enable FTM responder functionality; -1 for no change
1050 * (which also implies no change in LCI/civic location data)
1051 * @lci: Measurement Report element content, starting with Measurement Token
1052 * (measurement type 8)
1053 * @civicloc: Measurement Report element content, starting with Measurement
1054 * Token (measurement type 11)
1055 * @lci_len: LCI data length
1056 * @civicloc_len: Civic location data length
1058 struct cfg80211_beacon_data
{
1059 const u8
*head
, *tail
;
1060 const u8
*beacon_ies
;
1061 const u8
*proberesp_ies
;
1062 const u8
*assocresp_ies
;
1063 const u8
*probe_resp
;
1068 size_t head_len
, tail_len
;
1069 size_t beacon_ies_len
;
1070 size_t proberesp_ies_len
;
1071 size_t assocresp_ies_len
;
1072 size_t probe_resp_len
;
1074 size_t civicloc_len
;
1077 struct mac_address
{
1082 * struct cfg80211_acl_data - Access control list data
1084 * @acl_policy: ACL policy to be applied on the station's
1085 * entry specified by mac_addr
1086 * @n_acl_entries: Number of MAC address entries passed
1087 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1089 struct cfg80211_acl_data
{
1090 enum nl80211_acl_policy acl_policy
;
1094 struct mac_address mac_addrs
[];
1098 * struct cfg80211_fils_discovery - FILS discovery parameters from
1099 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1101 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1102 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1103 * @tmpl_len: Template length
1104 * @tmpl: Template data for FILS discovery frame including the action
1107 struct cfg80211_fils_discovery
{
1115 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1116 * response parameters in 6GHz.
1118 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1119 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1121 * @tmpl_len: Template length
1122 * @tmpl: Template data for probe response
1124 struct cfg80211_unsol_bcast_probe_resp
{
1131 * enum cfg80211_ap_settings_flags - AP settings flags
1133 * Used by cfg80211_ap_settings
1135 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
1137 enum cfg80211_ap_settings_flags
{
1138 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT
= BIT(0),
1142 * struct cfg80211_ap_settings - AP configuration
1144 * Used to configure an AP interface.
1146 * @chandef: defines the channel to use
1147 * @beacon: beacon data
1148 * @beacon_interval: beacon interval
1149 * @dtim_period: DTIM period
1150 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1152 * @ssid_len: length of @ssid
1153 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1154 * @crypto: crypto settings
1155 * @privacy: the BSS uses privacy
1156 * @auth_type: Authentication type (algorithm)
1157 * @smps_mode: SMPS mode
1158 * @inactivity_timeout: time in seconds to determine station's inactivity.
1159 * @p2p_ctwindow: P2P CT Window
1160 * @p2p_opp_ps: P2P opportunistic PS
1161 * @acl: ACL configuration used by the drivers which has support for
1162 * MAC address based access control
1163 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1165 * @beacon_rate: bitrate to be used for beacons
1166 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1167 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1168 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1169 * @ht_required: stations must support HT
1170 * @vht_required: stations must support VHT
1171 * @twt_responder: Enable Target Wait Time
1172 * @he_required: stations must support HE
1173 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1174 * @he_obss_pd: OBSS Packet Detection settings
1175 * @he_bss_color: BSS Color settings
1176 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1177 * @fils_discovery: FILS discovery transmission parameters
1178 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1180 struct cfg80211_ap_settings
{
1181 struct cfg80211_chan_def chandef
;
1183 struct cfg80211_beacon_data beacon
;
1185 int beacon_interval
, dtim_period
;
1188 enum nl80211_hidden_ssid hidden_ssid
;
1189 struct cfg80211_crypto_settings crypto
;
1191 enum nl80211_auth_type auth_type
;
1192 enum nl80211_smps_mode smps_mode
;
1193 int inactivity_timeout
;
1196 const struct cfg80211_acl_data
*acl
;
1198 struct cfg80211_bitrate_mask beacon_rate
;
1200 const struct ieee80211_ht_cap
*ht_cap
;
1201 const struct ieee80211_vht_cap
*vht_cap
;
1202 const struct ieee80211_he_cap_elem
*he_cap
;
1203 const struct ieee80211_he_operation
*he_oper
;
1204 bool ht_required
, vht_required
, he_required
;
1207 struct ieee80211_he_obss_pd he_obss_pd
;
1208 struct cfg80211_he_bss_color he_bss_color
;
1209 struct cfg80211_fils_discovery fils_discovery
;
1210 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp
;
1214 * struct cfg80211_csa_settings - channel switch settings
1216 * Used for channel switch
1218 * @chandef: defines the channel to use after the switch
1219 * @beacon_csa: beacon data while performing the switch
1220 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1221 * @counter_offsets_presp: offsets of the counters within the probe response
1222 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1223 * @n_counter_offsets_presp: number of csa counters in the probe response
1224 * @beacon_after: beacon data to be used on the new channel
1225 * @radar_required: whether radar detection is required on the new channel
1226 * @block_tx: whether transmissions should be blocked while changing
1227 * @count: number of beacons until switch
1229 struct cfg80211_csa_settings
{
1230 struct cfg80211_chan_def chandef
;
1231 struct cfg80211_beacon_data beacon_csa
;
1232 const u16
*counter_offsets_beacon
;
1233 const u16
*counter_offsets_presp
;
1234 unsigned int n_counter_offsets_beacon
;
1235 unsigned int n_counter_offsets_presp
;
1236 struct cfg80211_beacon_data beacon_after
;
1237 bool radar_required
;
1242 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1245 * struct iface_combination_params - input parameters for interface combinations
1247 * Used to pass interface combination parameters
1249 * @num_different_channels: the number of different channels we want
1250 * to use for verification
1251 * @radar_detect: a bitmap where each bit corresponds to a channel
1252 * width where radar detection is needed, as in the definition of
1253 * &struct ieee80211_iface_combination.@radar_detect_widths
1254 * @iftype_num: array with the number of interfaces of each interface
1255 * type. The index is the interface type as specified in &enum
1257 * @new_beacon_int: set this to the beacon interval of a new interface
1258 * that's not operating yet, if such is to be checked as part of
1261 struct iface_combination_params
{
1262 int num_different_channels
;
1264 int iftype_num
[NUM_NL80211_IFTYPES
];
1269 * enum station_parameters_apply_mask - station parameter values to apply
1270 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1271 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1272 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1274 * Not all station parameters have in-band "no change" signalling,
1275 * for those that don't these flags will are used.
1277 enum station_parameters_apply_mask
{
1278 STATION_PARAM_APPLY_UAPSD
= BIT(0),
1279 STATION_PARAM_APPLY_CAPABILITY
= BIT(1),
1280 STATION_PARAM_APPLY_PLINK_STATE
= BIT(2),
1281 STATION_PARAM_APPLY_STA_TXPOWER
= BIT(3),
1285 * struct sta_txpwr - station txpower configuration
1287 * Used to configure txpower for station.
1289 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1290 * is not provided, the default per-interface tx power setting will be
1291 * overriding. Driver should be picking up the lowest tx power, either tx
1292 * power per-interface or per-station.
1293 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1294 * will be less than or equal to specified from userspace, whereas if TPC
1295 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1296 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1301 enum nl80211_tx_power_setting type
;
1305 * struct station_parameters - station parameters
1307 * Used to change and create a new station.
1309 * @vlan: vlan interface station should belong to
1310 * @supported_rates: supported rates in IEEE 802.11 format
1311 * (or NULL for no change)
1312 * @supported_rates_len: number of supported rates
1313 * @sta_flags_mask: station flags that changed
1314 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1315 * @sta_flags_set: station flags values
1316 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1317 * @listen_interval: listen interval or -1 for no change
1318 * @aid: AID or zero for no change
1319 * @vlan_id: VLAN ID for station (if nonzero)
1320 * @peer_aid: mesh peer AID or zero for no change
1321 * @plink_action: plink action to take
1322 * @plink_state: set the peer link state for a station
1323 * @ht_capa: HT capabilities of station
1324 * @vht_capa: VHT capabilities of station
1325 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1326 * as the AC bitmap in the QoS info field
1327 * @max_sp: max Service Period. same format as the MAX_SP in the
1328 * QoS info field (but already shifted down)
1329 * @sta_modify_mask: bitmap indicating which parameters changed
1330 * (for those that don't have a natural "no change" value),
1331 * see &enum station_parameters_apply_mask
1332 * @local_pm: local link-specific mesh power save mode (no change when set
1334 * @capability: station capability
1335 * @ext_capab: extended capabilities of the station
1336 * @ext_capab_len: number of extended capabilities
1337 * @supported_channels: supported channels in IEEE 802.11 format
1338 * @supported_channels_len: number of supported channels
1339 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1340 * @supported_oper_classes_len: number of supported operating classes
1341 * @opmode_notif: operating mode field from Operating Mode Notification
1342 * @opmode_notif_used: information if operating mode field is used
1343 * @support_p2p_ps: information if station supports P2P PS mechanism
1344 * @he_capa: HE capabilities of station
1345 * @he_capa_len: the length of the HE capabilities
1346 * @airtime_weight: airtime scheduler weight for this station
1347 * @txpwr: transmit power for an associated station
1348 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1350 struct station_parameters
{
1351 const u8
*supported_rates
;
1352 struct net_device
*vlan
;
1353 u32 sta_flags_mask
, sta_flags_set
;
1354 u32 sta_modify_mask
;
1355 int listen_interval
;
1359 u8 supported_rates_len
;
1362 const struct ieee80211_ht_cap
*ht_capa
;
1363 const struct ieee80211_vht_cap
*vht_capa
;
1366 enum nl80211_mesh_power_mode local_pm
;
1368 const u8
*ext_capab
;
1370 const u8
*supported_channels
;
1371 u8 supported_channels_len
;
1372 const u8
*supported_oper_classes
;
1373 u8 supported_oper_classes_len
;
1375 bool opmode_notif_used
;
1377 const struct ieee80211_he_cap_elem
*he_capa
;
1380 struct sta_txpwr txpwr
;
1381 const struct ieee80211_he_6ghz_capa
*he_6ghz_capa
;
1385 * struct station_del_parameters - station deletion parameters
1387 * Used to delete a station entry (or all stations).
1389 * @mac: MAC address of the station to remove or NULL to remove all stations
1390 * @subtype: Management frame subtype to use for indicating removal
1391 * (10 = Disassociation, 12 = Deauthentication)
1392 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1394 struct station_del_parameters
{
1401 * enum cfg80211_station_type - the type of station being modified
1402 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1403 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1404 * unassociated (update properties for this type of client is permitted)
1405 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1406 * the AP MLME in the device
1407 * @CFG80211_STA_AP_STA: AP station on managed interface
1408 * @CFG80211_STA_IBSS: IBSS station
1409 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1410 * while TDLS setup is in progress, it moves out of this state when
1411 * being marked authorized; use this only if TDLS with external setup is
1413 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1414 * entry that is operating, has been marked authorized by userspace)
1415 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1416 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1418 enum cfg80211_station_type
{
1419 CFG80211_STA_AP_CLIENT
,
1420 CFG80211_STA_AP_CLIENT_UNASSOC
,
1421 CFG80211_STA_AP_MLME_CLIENT
,
1422 CFG80211_STA_AP_STA
,
1424 CFG80211_STA_TDLS_PEER_SETUP
,
1425 CFG80211_STA_TDLS_PEER_ACTIVE
,
1426 CFG80211_STA_MESH_PEER_KERNEL
,
1427 CFG80211_STA_MESH_PEER_USER
,
1431 * cfg80211_check_station_change - validate parameter changes
1432 * @wiphy: the wiphy this operates on
1433 * @params: the new parameters for a station
1434 * @statype: the type of station being modified
1436 * Utility function for the @change_station driver method. Call this function
1437 * with the appropriate station type looking up the station (and checking that
1438 * it exists). It will verify whether the station change is acceptable, and if
1439 * not will return an error code. Note that it may modify the parameters for
1440 * backward compatibility reasons, so don't use them before calling this.
1442 int cfg80211_check_station_change(struct wiphy
*wiphy
,
1443 struct station_parameters
*params
,
1444 enum cfg80211_station_type statype
);
1447 * enum rate_info_flags - bitrate info flags
1449 * Used by the driver to indicate the specific rate transmission
1450 * type for 802.11n transmissions.
1452 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1453 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1454 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1455 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1456 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1457 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1459 enum rate_info_flags
{
1460 RATE_INFO_FLAGS_MCS
= BIT(0),
1461 RATE_INFO_FLAGS_VHT_MCS
= BIT(1),
1462 RATE_INFO_FLAGS_SHORT_GI
= BIT(2),
1463 RATE_INFO_FLAGS_DMG
= BIT(3),
1464 RATE_INFO_FLAGS_HE_MCS
= BIT(4),
1465 RATE_INFO_FLAGS_EDMG
= BIT(5),
1469 * enum rate_info_bw - rate bandwidth information
1471 * Used by the driver to indicate the rate bandwidth.
1473 * @RATE_INFO_BW_5: 5 MHz bandwidth
1474 * @RATE_INFO_BW_10: 10 MHz bandwidth
1475 * @RATE_INFO_BW_20: 20 MHz bandwidth
1476 * @RATE_INFO_BW_40: 40 MHz bandwidth
1477 * @RATE_INFO_BW_80: 80 MHz bandwidth
1478 * @RATE_INFO_BW_160: 160 MHz bandwidth
1479 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1482 RATE_INFO_BW_20
= 0,
1492 * struct rate_info - bitrate information
1494 * Information about a receiving or transmitting bitrate
1496 * @flags: bitflag of flags from &enum rate_info_flags
1497 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1498 * @legacy: bitrate in 100kbit/s for 802.11abg
1499 * @nss: number of streams (VHT & HE only)
1500 * @bw: bandwidth (from &enum rate_info_bw)
1501 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1502 * @he_dcm: HE DCM value
1503 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1504 * only valid if bw is %RATE_INFO_BW_HE_RU)
1505 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1520 * enum bss_param_flags - bitrate info flags
1522 * Used by the driver to indicate the specific rate transmission
1523 * type for 802.11n transmissions.
1525 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1526 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1527 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1529 enum bss_param_flags
{
1530 BSS_PARAM_FLAGS_CTS_PROT
= 1<<0,
1531 BSS_PARAM_FLAGS_SHORT_PREAMBLE
= 1<<1,
1532 BSS_PARAM_FLAGS_SHORT_SLOT_TIME
= 1<<2,
1536 * struct sta_bss_parameters - BSS parameters for the attached station
1538 * Information about the currently associated BSS
1540 * @flags: bitflag of flags from &enum bss_param_flags
1541 * @dtim_period: DTIM period for the BSS
1542 * @beacon_interval: beacon interval
1544 struct sta_bss_parameters
{
1547 u16 beacon_interval
;
1551 * struct cfg80211_txq_stats - TXQ statistics for this TID
1552 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1553 * indicate the relevant values in this struct are filled
1554 * @backlog_bytes: total number of bytes currently backlogged
1555 * @backlog_packets: total number of packets currently backlogged
1556 * @flows: number of new flows seen
1557 * @drops: total number of packets dropped
1558 * @ecn_marks: total number of packets marked with ECN CE
1559 * @overlimit: number of drops due to queue space overflow
1560 * @overmemory: number of drops due to memory limit overflow
1561 * @collisions: number of hash collisions
1562 * @tx_bytes: total number of bytes dequeued
1563 * @tx_packets: total number of packets dequeued
1564 * @max_flows: maximum number of flows supported
1566 struct cfg80211_txq_stats
{
1569 u32 backlog_packets
;
1582 * struct cfg80211_tid_stats - per-TID statistics
1583 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1584 * indicate the relevant values in this struct are filled
1585 * @rx_msdu: number of received MSDUs
1586 * @tx_msdu: number of (attempted) transmitted MSDUs
1587 * @tx_msdu_retries: number of retries (not counting the first) for
1589 * @tx_msdu_failed: number of failed transmitted MSDUs
1590 * @txq_stats: TXQ statistics
1592 struct cfg80211_tid_stats
{
1596 u64 tx_msdu_retries
;
1598 struct cfg80211_txq_stats txq_stats
;
1601 #define IEEE80211_MAX_CHAINS 4
1604 * struct station_info - station information
1606 * Station information filled by driver for get_station() and dump_station.
1608 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1609 * indicate the relevant values in this struct for them
1610 * @connected_time: time(in secs) since a station is last connected
1611 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1612 * @assoc_at: bootime (ns) of the last association
1613 * @rx_bytes: bytes (size of MPDUs) received from this station
1614 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1615 * @llid: mesh local link id
1616 * @plid: mesh peer link id
1617 * @plink_state: mesh peer link state
1618 * @signal: The signal strength, type depends on the wiphy's signal_type.
1619 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1620 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1621 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1622 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1623 * @chain_signal: per-chain signal strength of last received packet in dBm
1624 * @chain_signal_avg: per-chain signal strength average in dBm
1625 * @txrate: current unicast bitrate from this station
1626 * @rxrate: current unicast bitrate to this station
1627 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1628 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1629 * @tx_retries: cumulative retry counts (MPDUs)
1630 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1631 * @rx_dropped_misc: Dropped for un-specified reason.
1632 * @bss_param: current BSS parameters
1633 * @generation: generation number for nl80211 dumps.
1634 * This number should increase every time the list of stations
1635 * changes, i.e. when a station is added or removed, so that
1636 * userspace can tell whether it got a consistent snapshot.
1637 * @assoc_req_ies: IEs from (Re)Association Request.
1638 * This is used only when in AP mode with drivers that do not use
1639 * user space MLME/SME implementation. The information is provided for
1640 * the cfg80211_new_sta() calls to notify user space of the IEs.
1641 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1642 * @sta_flags: station flags mask & values
1643 * @beacon_loss_count: Number of times beacon loss event has triggered.
1644 * @t_offset: Time offset of the station relative to this host.
1645 * @local_pm: local mesh STA power save mode
1646 * @peer_pm: peer mesh STA power save mode
1647 * @nonpeer_pm: non-peer mesh STA power save mode
1648 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1649 * towards this station.
1650 * @rx_beacon: number of beacons received from this peer
1651 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1653 * @connected_to_gate: true if mesh STA has a path to mesh gate
1654 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1655 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1656 * @airtime_weight: current airtime scheduling weight
1657 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1658 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1659 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1660 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1661 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1663 * @rx_mpdu_count: number of MPDUs received from this station
1664 * @fcs_err_count: number of packets (MPDUs) received from this station with
1665 * an FCS error. This counter should be incremented only when TA of the
1666 * received packet with an FCS error matches the peer MAC address.
1667 * @airtime_link_metric: mesh airtime link metric.
1668 * @connected_to_as: true if mesh STA has a path to authentication server
1670 struct station_info
{
1684 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
1685 s8 chain_signal_avg
[IEEE80211_MAX_CHAINS
];
1687 struct rate_info txrate
;
1688 struct rate_info rxrate
;
1693 u32 rx_dropped_misc
;
1694 struct sta_bss_parameters bss_param
;
1695 struct nl80211_sta_flag_update sta_flags
;
1699 const u8
*assoc_req_ies
;
1700 size_t assoc_req_ies_len
;
1702 u32 beacon_loss_count
;
1704 enum nl80211_mesh_power_mode local_pm
;
1705 enum nl80211_mesh_power_mode peer_pm
;
1706 enum nl80211_mesh_power_mode nonpeer_pm
;
1708 u32 expected_throughput
;
1713 u8 rx_beacon_signal_avg
;
1714 u8 connected_to_gate
;
1716 struct cfg80211_tid_stats
*pertid
;
1725 u32 airtime_link_metric
;
1730 #if IS_ENABLED(CONFIG_CFG80211)
1732 * cfg80211_get_station - retrieve information about a given station
1733 * @dev: the device where the station is supposed to be connected to
1734 * @mac_addr: the mac address of the station of interest
1735 * @sinfo: pointer to the structure to fill with the information
1737 * Returns 0 on success and sinfo is filled with the available information
1738 * otherwise returns a negative error code and the content of sinfo has to be
1739 * considered undefined.
1741 int cfg80211_get_station(struct net_device
*dev
, const u8
*mac_addr
,
1742 struct station_info
*sinfo
);
1744 static inline int cfg80211_get_station(struct net_device
*dev
,
1746 struct station_info
*sinfo
)
1753 * enum monitor_flags - monitor flags
1755 * Monitor interface configuration flags. Note that these must be the bits
1756 * according to the nl80211 flags.
1758 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1759 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1760 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1761 * @MONITOR_FLAG_CONTROL: pass control frames
1762 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1763 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1764 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1766 enum monitor_flags
{
1767 MONITOR_FLAG_CHANGED
= 1<<__NL80211_MNTR_FLAG_INVALID
,
1768 MONITOR_FLAG_FCSFAIL
= 1<<NL80211_MNTR_FLAG_FCSFAIL
,
1769 MONITOR_FLAG_PLCPFAIL
= 1<<NL80211_MNTR_FLAG_PLCPFAIL
,
1770 MONITOR_FLAG_CONTROL
= 1<<NL80211_MNTR_FLAG_CONTROL
,
1771 MONITOR_FLAG_OTHER_BSS
= 1<<NL80211_MNTR_FLAG_OTHER_BSS
,
1772 MONITOR_FLAG_COOK_FRAMES
= 1<<NL80211_MNTR_FLAG_COOK_FRAMES
,
1773 MONITOR_FLAG_ACTIVE
= 1<<NL80211_MNTR_FLAG_ACTIVE
,
1777 * enum mpath_info_flags - mesh path information flags
1779 * Used by the driver to indicate which info in &struct mpath_info it has filled
1780 * in during get_station() or dump_station().
1782 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1783 * @MPATH_INFO_SN: @sn filled
1784 * @MPATH_INFO_METRIC: @metric filled
1785 * @MPATH_INFO_EXPTIME: @exptime filled
1786 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1787 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1788 * @MPATH_INFO_FLAGS: @flags filled
1789 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1790 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1792 enum mpath_info_flags
{
1793 MPATH_INFO_FRAME_QLEN
= BIT(0),
1794 MPATH_INFO_SN
= BIT(1),
1795 MPATH_INFO_METRIC
= BIT(2),
1796 MPATH_INFO_EXPTIME
= BIT(3),
1797 MPATH_INFO_DISCOVERY_TIMEOUT
= BIT(4),
1798 MPATH_INFO_DISCOVERY_RETRIES
= BIT(5),
1799 MPATH_INFO_FLAGS
= BIT(6),
1800 MPATH_INFO_HOP_COUNT
= BIT(7),
1801 MPATH_INFO_PATH_CHANGE
= BIT(8),
1805 * struct mpath_info - mesh path information
1807 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1809 * @filled: bitfield of flags from &enum mpath_info_flags
1810 * @frame_qlen: number of queued frames for this destination
1811 * @sn: target sequence number
1812 * @metric: metric (cost) of this mesh path
1813 * @exptime: expiration time for the mesh path from now, in msecs
1814 * @flags: mesh path flags
1815 * @discovery_timeout: total mesh path discovery timeout, in msecs
1816 * @discovery_retries: mesh path discovery retries
1817 * @generation: generation number for nl80211 dumps.
1818 * This number should increase every time the list of mesh paths
1819 * changes, i.e. when a station is added or removed, so that
1820 * userspace can tell whether it got a consistent snapshot.
1821 * @hop_count: hops to destination
1822 * @path_change_count: total number of path changes to destination
1830 u32 discovery_timeout
;
1831 u8 discovery_retries
;
1834 u32 path_change_count
;
1840 * struct bss_parameters - BSS parameters
1842 * Used to change BSS parameters (mainly for AP mode).
1844 * @use_cts_prot: Whether to use CTS protection
1845 * (0 = no, 1 = yes, -1 = do not change)
1846 * @use_short_preamble: Whether the use of short preambles is allowed
1847 * (0 = no, 1 = yes, -1 = do not change)
1848 * @use_short_slot_time: Whether the use of short slot time is allowed
1849 * (0 = no, 1 = yes, -1 = do not change)
1850 * @basic_rates: basic rates in IEEE 802.11 format
1851 * (or NULL for no change)
1852 * @basic_rates_len: number of basic rates
1853 * @ap_isolate: do not forward packets between connected stations
1854 * (0 = no, 1 = yes, -1 = do not change)
1855 * @ht_opmode: HT Operation mode
1856 * (u16 = opmode, -1 = do not change)
1857 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1858 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1860 struct bss_parameters
{
1862 int use_short_preamble
;
1863 int use_short_slot_time
;
1864 const u8
*basic_rates
;
1868 s8 p2p_ctwindow
, p2p_opp_ps
;
1872 * struct mesh_config - 802.11s mesh configuration
1874 * These parameters can be changed while the mesh is active.
1876 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1877 * by the Mesh Peering Open message
1878 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1879 * used by the Mesh Peering Open message
1880 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1881 * the mesh peering management to close a mesh peering
1882 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1884 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1885 * be sent to establish a new peer link instance in a mesh
1886 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1887 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1889 * @auto_open_plinks: whether we should automatically open peer links when we
1890 * detect compatible mesh peers
1891 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1892 * synchronize to for 11s default synchronization method
1893 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1894 * that an originator mesh STA can send to a particular path target
1895 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1896 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1897 * a path discovery in milliseconds
1898 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1899 * receiving a PREQ shall consider the forwarding information from the
1900 * root to be valid. (TU = time unit)
1901 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1902 * which a mesh STA can send only one action frame containing a PREQ
1904 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1905 * which a mesh STA can send only one Action frame containing a PERR
1907 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1908 * it takes for an HWMP information element to propagate across the mesh
1909 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1910 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1911 * announcements are transmitted
1912 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1913 * station has access to a broader network beyond the MBSS. (This is
1914 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1915 * only means that the station will announce others it's a mesh gate, but
1916 * not necessarily using the gate announcement protocol. Still keeping the
1917 * same nomenclature to be in sync with the spec)
1918 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1919 * entity (default is TRUE - forwarding entity)
1920 * @rssi_threshold: the threshold for average signal strength of candidate
1921 * station to establish a peer link
1922 * @ht_opmode: mesh HT protection mode
1924 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1925 * receiving a proactive PREQ shall consider the forwarding information to
1926 * the root mesh STA to be valid.
1928 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1929 * PREQs are transmitted.
1930 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1931 * during which a mesh STA can send only one Action frame containing
1932 * a PREQ element for root path confirmation.
1933 * @power_mode: The default mesh power save mode which will be the initial
1934 * setting for new peer links.
1935 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1936 * after transmitting its beacon.
1937 * @plink_timeout: If no tx activity is seen from a STA we've established
1938 * peering with for longer than this time (in seconds), then remove it
1939 * from the STA's list of peers. Default is 30 minutes.
1940 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1941 * connected to a mesh gate in mesh formation info. If false, the
1942 * value in mesh formation is determined by the presence of root paths
1943 * in the mesh path table
1944 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
1945 * for HWMP) if the destination is a direct neighbor. Note that this might
1946 * not be the optimal decision as a multi-hop route might be better. So
1947 * if using this setting you will likely also want to disable
1948 * dot11MeshForwarding and use another mesh routing protocol on top.
1950 struct mesh_config
{
1951 u16 dot11MeshRetryTimeout
;
1952 u16 dot11MeshConfirmTimeout
;
1953 u16 dot11MeshHoldingTimeout
;
1954 u16 dot11MeshMaxPeerLinks
;
1955 u8 dot11MeshMaxRetries
;
1958 bool auto_open_plinks
;
1959 u32 dot11MeshNbrOffsetMaxNeighbor
;
1960 u8 dot11MeshHWMPmaxPREQretries
;
1961 u32 path_refresh_time
;
1962 u16 min_discovery_timeout
;
1963 u32 dot11MeshHWMPactivePathTimeout
;
1964 u16 dot11MeshHWMPpreqMinInterval
;
1965 u16 dot11MeshHWMPperrMinInterval
;
1966 u16 dot11MeshHWMPnetDiameterTraversalTime
;
1967 u8 dot11MeshHWMPRootMode
;
1968 bool dot11MeshConnectedToMeshGate
;
1969 bool dot11MeshConnectedToAuthServer
;
1970 u16 dot11MeshHWMPRannInterval
;
1971 bool dot11MeshGateAnnouncementProtocol
;
1972 bool dot11MeshForwarding
;
1975 u32 dot11MeshHWMPactivePathToRootTimeout
;
1976 u16 dot11MeshHWMProotInterval
;
1977 u16 dot11MeshHWMPconfirmationInterval
;
1978 enum nl80211_mesh_power_mode power_mode
;
1979 u16 dot11MeshAwakeWindowDuration
;
1981 bool dot11MeshNolearn
;
1985 * struct mesh_setup - 802.11s mesh setup configuration
1986 * @chandef: defines the channel to use
1987 * @mesh_id: the mesh ID
1988 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1989 * @sync_method: which synchronization method to use
1990 * @path_sel_proto: which path selection protocol to use
1991 * @path_metric: which metric to use
1992 * @auth_id: which authentication method this mesh is using
1993 * @ie: vendor information elements (optional)
1994 * @ie_len: length of vendor information elements
1995 * @is_authenticated: this mesh requires authentication
1996 * @is_secure: this mesh uses security
1997 * @user_mpm: userspace handles all MPM functions
1998 * @dtim_period: DTIM period to use
1999 * @beacon_interval: beacon interval to use
2000 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2001 * @basic_rates: basic rates to use when creating the mesh
2002 * @beacon_rate: bitrate to be used for beacons
2003 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2004 * changes the channel when a radar is detected. This is required
2005 * to operate on DFS channels.
2006 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2007 * port frames over NL80211 instead of the network interface.
2009 * These parameters are fixed when the mesh is created.
2012 struct cfg80211_chan_def chandef
;
2021 bool is_authenticated
;
2025 u16 beacon_interval
;
2026 int mcast_rate
[NUM_NL80211_BANDS
];
2028 struct cfg80211_bitrate_mask beacon_rate
;
2029 bool userspace_handles_dfs
;
2030 bool control_port_over_nl80211
;
2034 * struct ocb_setup - 802.11p OCB mode setup configuration
2035 * @chandef: defines the channel to use
2037 * These parameters are fixed when connecting to the network
2040 struct cfg80211_chan_def chandef
;
2044 * struct ieee80211_txq_params - TX queue parameters
2045 * @ac: AC identifier
2046 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2047 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2049 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2051 * @aifs: Arbitration interframe space [0..255]
2053 struct ieee80211_txq_params
{
2062 * DOC: Scanning and BSS list handling
2064 * The scanning process itself is fairly simple, but cfg80211 offers quite
2065 * a bit of helper functionality. To start a scan, the scan operation will
2066 * be invoked with a scan definition. This scan definition contains the
2067 * channels to scan, and the SSIDs to send probe requests for (including the
2068 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2069 * probe. Additionally, a scan request may contain extra information elements
2070 * that should be added to the probe request. The IEs are guaranteed to be
2071 * well-formed, and will not exceed the maximum length the driver advertised
2072 * in the wiphy structure.
2074 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2075 * it is responsible for maintaining the BSS list; the driver should not
2076 * maintain a list itself. For this notification, various functions exist.
2078 * Since drivers do not maintain a BSS list, there are also a number of
2079 * functions to search for a BSS and obtain information about it from the
2080 * BSS structure cfg80211 maintains. The BSS list is also made available
2085 * struct cfg80211_ssid - SSID description
2087 * @ssid_len: length of the ssid
2089 struct cfg80211_ssid
{
2090 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
2095 * struct cfg80211_scan_info - information about completed scan
2096 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2097 * wireless device that requested the scan is connected to. If this
2098 * information is not available, this field is left zero.
2099 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2100 * @aborted: set to true if the scan was aborted for any reason,
2101 * userspace will be notified of that
2103 struct cfg80211_scan_info
{
2105 u8 tsf_bssid
[ETH_ALEN
] __aligned(2);
2110 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2112 * @short_bssid: short ssid to scan for
2113 * @bssid: bssid to scan for
2114 * @channel_idx: idx of the channel in the channel array in the scan request
2115 * which the above info relvant to
2116 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2117 * @short_ssid_valid: short_ssid is valid and can be used
2118 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2119 * 20 TUs before starting to send probe requests.
2121 struct cfg80211_scan_6ghz_params
{
2125 bool unsolicited_probe
;
2126 bool short_ssid_valid
;
2131 * struct cfg80211_scan_request - scan request description
2133 * @ssids: SSIDs to scan for (active scan only)
2134 * @n_ssids: number of SSIDs
2135 * @channels: channels to scan on.
2136 * @n_channels: total number of channels to scan
2137 * @scan_width: channel width for scanning
2138 * @ie: optional information element(s) to add into Probe Request or %NULL
2139 * @ie_len: length of ie in octets
2140 * @duration: how long to listen on each channel, in TUs. If
2141 * %duration_mandatory is not set, this is the maximum dwell time and
2142 * the actual dwell time may be shorter.
2143 * @duration_mandatory: if set, the scan duration must be as specified by the
2145 * @flags: bit field of flags controlling operation
2146 * @rates: bitmap of rates to advertise for each band
2147 * @wiphy: the wiphy this was for
2148 * @scan_start: time (in jiffies) when the scan started
2149 * @wdev: the wireless device to scan for
2150 * @info: (internal) information about completed scan
2151 * @notified: (internal) scan request was notified as done or aborted
2152 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2153 * @mac_addr: MAC address used with randomisation
2154 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2155 * are 0 in the mask should be randomised, bits that are 1 should
2156 * be taken from the @mac_addr
2157 * @scan_6ghz: relevant for split scan request only,
2158 * true if this is the second scan request
2159 * @n_6ghz_params: number of 6 GHz params
2160 * @scan_6ghz_params: 6 GHz params
2161 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2163 struct cfg80211_scan_request
{
2164 struct cfg80211_ssid
*ssids
;
2167 enum nl80211_bss_scan_width scan_width
;
2171 bool duration_mandatory
;
2174 u32 rates
[NUM_NL80211_BANDS
];
2176 struct wireless_dev
*wdev
;
2178 u8 mac_addr
[ETH_ALEN
] __aligned(2);
2179 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
2180 u8 bssid
[ETH_ALEN
] __aligned(2);
2183 struct wiphy
*wiphy
;
2184 unsigned long scan_start
;
2185 struct cfg80211_scan_info info
;
2190 struct cfg80211_scan_6ghz_params
*scan_6ghz_params
;
2193 struct ieee80211_channel
*channels
[];
2196 static inline void get_random_mask_addr(u8
*buf
, const u8
*addr
, const u8
*mask
)
2200 get_random_bytes(buf
, ETH_ALEN
);
2201 for (i
= 0; i
< ETH_ALEN
; i
++) {
2203 buf
[i
] |= addr
[i
] & mask
[i
];
2208 * struct cfg80211_match_set - sets of attributes to match
2210 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2211 * or no match (RSSI only)
2212 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2213 * or no match (RSSI only)
2214 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2215 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2216 * for filtering out scan results received. Drivers advertize this support
2217 * of band specific rssi based filtering through the feature capability
2218 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2219 * specific rssi thresholds take precedence over rssi_thold, if specified.
2220 * If not specified for any band, it will be assigned with rssi_thold of
2221 * corresponding matchset.
2223 struct cfg80211_match_set
{
2224 struct cfg80211_ssid ssid
;
2227 s32 per_band_rssi_thold
[NUM_NL80211_BANDS
];
2231 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2233 * @interval: interval between scheduled scan iterations. In seconds.
2234 * @iterations: number of scan iterations in this scan plan. Zero means
2236 * The last scan plan will always have this parameter set to zero,
2237 * all other scan plans will have a finite number of iterations.
2239 struct cfg80211_sched_scan_plan
{
2245 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2247 * @band: band of BSS which should match for RSSI level adjustment.
2248 * @delta: value of RSSI level adjustment.
2250 struct cfg80211_bss_select_adjust
{
2251 enum nl80211_band band
;
2256 * struct cfg80211_sched_scan_request - scheduled scan request description
2258 * @reqid: identifies this request.
2259 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2260 * @n_ssids: number of SSIDs
2261 * @n_channels: total number of channels to scan
2262 * @scan_width: channel width for scanning
2263 * @ie: optional information element(s) to add into Probe Request or %NULL
2264 * @ie_len: length of ie in octets
2265 * @flags: bit field of flags controlling operation
2266 * @match_sets: sets of parameters to be matched for a scan result
2267 * entry to be considered valid and to be passed to the host
2268 * (others are filtered out).
2269 * If ommited, all results are passed.
2270 * @n_match_sets: number of match sets
2271 * @report_results: indicates that results were reported for this request
2272 * @wiphy: the wiphy this was for
2273 * @dev: the interface
2274 * @scan_start: start time of the scheduled scan
2275 * @channels: channels to scan
2276 * @min_rssi_thold: for drivers only supporting a single threshold, this
2277 * contains the minimum over all matchsets
2278 * @mac_addr: MAC address used with randomisation
2279 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2280 * are 0 in the mask should be randomised, bits that are 1 should
2281 * be taken from the @mac_addr
2282 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2283 * index must be executed first.
2284 * @n_scan_plans: number of scan plans, at least 1.
2285 * @rcu_head: RCU callback used to free the struct
2286 * @owner_nlportid: netlink portid of owner (if this should is a request
2287 * owned by a particular socket)
2288 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2289 * @list: for keeping list of requests.
2290 * @delay: delay in seconds to use before starting the first scan
2291 * cycle. The driver may ignore this parameter and start
2292 * immediately (or at any other time), if this feature is not
2294 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2295 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2296 * reporting in connected state to cases where a matching BSS is determined
2297 * to have better or slightly worse RSSI than the current connected BSS.
2298 * The relative RSSI threshold values are ignored in disconnected state.
2299 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2300 * to the specified band while deciding whether a better BSS is reported
2301 * using @relative_rssi. If delta is a negative number, the BSSs that
2302 * belong to the specified band will be penalized by delta dB in relative
2305 struct cfg80211_sched_scan_request
{
2307 struct cfg80211_ssid
*ssids
;
2310 enum nl80211_bss_scan_width scan_width
;
2314 struct cfg80211_match_set
*match_sets
;
2318 struct cfg80211_sched_scan_plan
*scan_plans
;
2321 u8 mac_addr
[ETH_ALEN
] __aligned(2);
2322 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
2324 bool relative_rssi_set
;
2326 struct cfg80211_bss_select_adjust rssi_adjust
;
2329 struct wiphy
*wiphy
;
2330 struct net_device
*dev
;
2331 unsigned long scan_start
;
2332 bool report_results
;
2333 struct rcu_head rcu_head
;
2336 struct list_head list
;
2339 struct ieee80211_channel
*channels
[];
2343 * enum cfg80211_signal_type - signal type
2345 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2346 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2347 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2349 enum cfg80211_signal_type
{
2350 CFG80211_SIGNAL_TYPE_NONE
,
2351 CFG80211_SIGNAL_TYPE_MBM
,
2352 CFG80211_SIGNAL_TYPE_UNSPEC
,
2356 * struct cfg80211_inform_bss - BSS inform data
2357 * @chan: channel the frame was received on
2358 * @scan_width: scan width that was used
2359 * @signal: signal strength value, according to the wiphy's
2361 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2362 * received; should match the time when the frame was actually
2363 * received by the device (not just by the host, in case it was
2364 * buffered on the device) and be accurate to about 10ms.
2365 * If the frame isn't buffered, just passing the return value of
2366 * ktime_get_boottime_ns() is likely appropriate.
2367 * @parent_tsf: the time at the start of reception of the first octet of the
2368 * timestamp field of the frame. The time is the TSF of the BSS specified
2370 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2371 * the BSS that requested the scan in which the beacon/probe was received.
2372 * @chains: bitmask for filled values in @chain_signal.
2373 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2375 struct cfg80211_inform_bss
{
2376 struct ieee80211_channel
*chan
;
2377 enum nl80211_bss_scan_width scan_width
;
2381 u8 parent_bssid
[ETH_ALEN
] __aligned(2);
2383 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
2387 * struct cfg80211_bss_ies - BSS entry IE data
2388 * @tsf: TSF contained in the frame that carried these IEs
2389 * @rcu_head: internal use, for freeing
2390 * @len: length of the IEs
2391 * @from_beacon: these IEs are known to come from a beacon
2394 struct cfg80211_bss_ies
{
2396 struct rcu_head rcu_head
;
2403 * struct cfg80211_bss - BSS description
2405 * This structure describes a BSS (which may also be a mesh network)
2406 * for use in scan results and similar.
2408 * @channel: channel this BSS is on
2409 * @scan_width: width of the control channel
2410 * @bssid: BSSID of the BSS
2411 * @beacon_interval: the beacon interval as from the frame
2412 * @capability: the capability field in host byte order
2413 * @ies: the information elements (Note that there is no guarantee that these
2414 * are well-formed!); this is a pointer to either the beacon_ies or
2415 * proberesp_ies depending on whether Probe Response frame has been
2416 * received. It is always non-%NULL.
2417 * @beacon_ies: the information elements from the last Beacon frame
2418 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2419 * own the beacon_ies, but they're just pointers to the ones from the
2420 * @hidden_beacon_bss struct)
2421 * @proberesp_ies: the information elements from the last Probe Response frame
2422 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2423 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2424 * that holds the beacon data. @beacon_ies is still valid, of course, and
2425 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2426 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2427 * non-transmitted one (multi-BSSID support)
2428 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2429 * (multi-BSSID support)
2430 * @signal: signal strength value (type depends on the wiphy's signal_type)
2431 * @chains: bitmask for filled values in @chain_signal.
2432 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2433 * @bssid_index: index in the multiple BSS set
2434 * @max_bssid_indicator: max number of members in the BSS set
2435 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2437 struct cfg80211_bss
{
2438 struct ieee80211_channel
*channel
;
2439 enum nl80211_bss_scan_width scan_width
;
2441 const struct cfg80211_bss_ies __rcu
*ies
;
2442 const struct cfg80211_bss_ies __rcu
*beacon_ies
;
2443 const struct cfg80211_bss_ies __rcu
*proberesp_ies
;
2445 struct cfg80211_bss
*hidden_beacon_bss
;
2446 struct cfg80211_bss
*transmitted_bss
;
2447 struct list_head nontrans_list
;
2451 u16 beacon_interval
;
2456 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
2459 u8 max_bssid_indicator
;
2461 u8 priv
[] __aligned(sizeof(void *));
2465 * ieee80211_bss_get_elem - find element with given ID
2466 * @bss: the bss to search
2467 * @id: the element ID
2469 * Note that the return value is an RCU-protected pointer, so
2470 * rcu_read_lock() must be held when calling this function.
2471 * Return: %NULL if not found.
2473 const struct element
*ieee80211_bss_get_elem(struct cfg80211_bss
*bss
, u8 id
);
2476 * ieee80211_bss_get_ie - find IE with given ID
2477 * @bss: the bss to search
2478 * @id: the element ID
2480 * Note that the return value is an RCU-protected pointer, so
2481 * rcu_read_lock() must be held when calling this function.
2482 * Return: %NULL if not found.
2484 static inline const u8
*ieee80211_bss_get_ie(struct cfg80211_bss
*bss
, u8 id
)
2486 return (void *)ieee80211_bss_get_elem(bss
, id
);
2491 * struct cfg80211_auth_request - Authentication request data
2493 * This structure provides information needed to complete IEEE 802.11
2496 * @bss: The BSS to authenticate with, the callee must obtain a reference
2497 * to it if it needs to keep it.
2498 * @auth_type: Authentication type (algorithm)
2499 * @ie: Extra IEs to add to Authentication frame or %NULL
2500 * @ie_len: Length of ie buffer in octets
2501 * @key_len: length of WEP key for shared key authentication
2502 * @key_idx: index of WEP key for shared key authentication
2503 * @key: WEP key for shared key authentication
2504 * @auth_data: Fields and elements in Authentication frames. This contains
2505 * the authentication frame body (non-IE and IE data), excluding the
2506 * Authentication algorithm number, i.e., starting at the Authentication
2507 * transaction sequence number field.
2508 * @auth_data_len: Length of auth_data buffer in octets
2510 struct cfg80211_auth_request
{
2511 struct cfg80211_bss
*bss
;
2514 enum nl80211_auth_type auth_type
;
2516 u8 key_len
, key_idx
;
2517 const u8
*auth_data
;
2518 size_t auth_data_len
;
2522 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2524 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2525 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2526 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2527 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2528 * authentication capability. Drivers can offload authentication to
2529 * userspace if this flag is set. Only applicable for cfg80211_connect()
2530 * request (connect callback).
2532 enum cfg80211_assoc_req_flags
{
2533 ASSOC_REQ_DISABLE_HT
= BIT(0),
2534 ASSOC_REQ_DISABLE_VHT
= BIT(1),
2535 ASSOC_REQ_USE_RRM
= BIT(2),
2536 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT
= BIT(3),
2540 * struct cfg80211_assoc_request - (Re)Association request data
2542 * This structure provides information needed to complete IEEE 802.11
2544 * @bss: The BSS to associate with. If the call is successful the driver is
2545 * given a reference that it must give back to cfg80211_send_rx_assoc()
2546 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2547 * association requests while already associating must be rejected.
2548 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2549 * @ie_len: Length of ie buffer in octets
2550 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2551 * @crypto: crypto settings
2552 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2553 * to indicate a request to reassociate within the ESS instead of a request
2554 * do the initial association with the ESS. When included, this is set to
2555 * the BSSID of the current association, i.e., to the value that is
2556 * included in the Current AP address field of the Reassociation Request
2558 * @flags: See &enum cfg80211_assoc_req_flags
2559 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2560 * will be used in ht_capa. Un-supported values will be ignored.
2561 * @ht_capa_mask: The bits of ht_capa which are to be used.
2562 * @vht_capa: VHT capability override
2563 * @vht_capa_mask: VHT capability mask indicating which fields to use
2564 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2565 * %NULL if FILS is not used.
2566 * @fils_kek_len: Length of fils_kek in octets
2567 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2568 * Request/Response frame or %NULL if FILS is not used. This field starts
2569 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2570 * @s1g_capa: S1G capability override
2571 * @s1g_capa_mask: S1G capability override mask
2573 struct cfg80211_assoc_request
{
2574 struct cfg80211_bss
*bss
;
2575 const u8
*ie
, *prev_bssid
;
2577 struct cfg80211_crypto_settings crypto
;
2580 struct ieee80211_ht_cap ht_capa
;
2581 struct ieee80211_ht_cap ht_capa_mask
;
2582 struct ieee80211_vht_cap vht_capa
, vht_capa_mask
;
2584 size_t fils_kek_len
;
2585 const u8
*fils_nonces
;
2586 struct ieee80211_s1g_cap s1g_capa
, s1g_capa_mask
;
2590 * struct cfg80211_deauth_request - Deauthentication request data
2592 * This structure provides information needed to complete IEEE 802.11
2595 * @bssid: the BSSID of the BSS to deauthenticate from
2596 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2597 * @ie_len: Length of ie buffer in octets
2598 * @reason_code: The reason code for the deauthentication
2599 * @local_state_change: if set, change local state only and
2600 * do not set a deauth frame
2602 struct cfg80211_deauth_request
{
2607 bool local_state_change
;
2611 * struct cfg80211_disassoc_request - Disassociation request data
2613 * This structure provides information needed to complete IEEE 802.11
2616 * @bss: the BSS to disassociate from
2617 * @ie: Extra IEs to add to Disassociation frame or %NULL
2618 * @ie_len: Length of ie buffer in octets
2619 * @reason_code: The reason code for the disassociation
2620 * @local_state_change: This is a request for a local state only, i.e., no
2621 * Disassociation frame is to be transmitted.
2623 struct cfg80211_disassoc_request
{
2624 struct cfg80211_bss
*bss
;
2628 bool local_state_change
;
2632 * struct cfg80211_ibss_params - IBSS parameters
2634 * This structure defines the IBSS parameters for the join_ibss()
2637 * @ssid: The SSID, will always be non-null.
2638 * @ssid_len: The length of the SSID, will always be non-zero.
2639 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2640 * search for IBSSs with a different BSSID.
2641 * @chandef: defines the channel to use if no other IBSS to join can be found
2642 * @channel_fixed: The channel should be fixed -- do not search for
2643 * IBSSs to join on other channels.
2644 * @ie: information element(s) to include in the beacon
2645 * @ie_len: length of that
2646 * @beacon_interval: beacon interval to use
2647 * @privacy: this is a protected network, keys will be configured
2649 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2650 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2651 * required to assume that the port is unauthorized until authorized by
2652 * user space. Otherwise, port is marked authorized by default.
2653 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2654 * port frames over NL80211 instead of the network interface.
2655 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2656 * changes the channel when a radar is detected. This is required
2657 * to operate on DFS channels.
2658 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2659 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2660 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2661 * will be used in ht_capa. Un-supported values will be ignored.
2662 * @ht_capa_mask: The bits of ht_capa which are to be used.
2663 * @wep_keys: static WEP keys, if not NULL points to an array of
2664 * CFG80211_MAX_WEP_KEYS WEP keys
2665 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2667 struct cfg80211_ibss_params
{
2670 struct cfg80211_chan_def chandef
;
2672 u8 ssid_len
, ie_len
;
2673 u16 beacon_interval
;
2678 bool control_port_over_nl80211
;
2679 bool userspace_handles_dfs
;
2680 int mcast_rate
[NUM_NL80211_BANDS
];
2681 struct ieee80211_ht_cap ht_capa
;
2682 struct ieee80211_ht_cap ht_capa_mask
;
2683 struct key_params
*wep_keys
;
2688 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2690 * @behaviour: requested BSS selection behaviour.
2691 * @param: parameters for requestion behaviour.
2692 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2693 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2695 struct cfg80211_bss_selection
{
2696 enum nl80211_bss_select_attr behaviour
;
2698 enum nl80211_band band_pref
;
2699 struct cfg80211_bss_select_adjust adjust
;
2704 * struct cfg80211_connect_params - Connection parameters
2706 * This structure provides information needed to complete IEEE 802.11
2707 * authentication and association.
2709 * @channel: The channel to use or %NULL if not specified (auto-select based
2711 * @channel_hint: The channel of the recommended BSS for initial connection or
2712 * %NULL if not specified
2713 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2715 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2716 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2717 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2720 * @ssid_len: Length of ssid in octets
2721 * @auth_type: Authentication type (algorithm)
2722 * @ie: IEs for association request
2723 * @ie_len: Length of assoc_ie in octets
2724 * @privacy: indicates whether privacy-enabled APs should be used
2725 * @mfp: indicate whether management frame protection is used
2726 * @crypto: crypto settings
2727 * @key_len: length of WEP key for shared key authentication
2728 * @key_idx: index of WEP key for shared key authentication
2729 * @key: WEP key for shared key authentication
2730 * @flags: See &enum cfg80211_assoc_req_flags
2731 * @bg_scan_period: Background scan period in seconds
2732 * or -1 to indicate that default value is to be used.
2733 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2734 * will be used in ht_capa. Un-supported values will be ignored.
2735 * @ht_capa_mask: The bits of ht_capa which are to be used.
2736 * @vht_capa: VHT Capability overrides
2737 * @vht_capa_mask: The bits of vht_capa which are to be used.
2738 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2740 * @bss_select: criteria to be used for BSS selection.
2741 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2742 * to indicate a request to reassociate within the ESS instead of a request
2743 * do the initial association with the ESS. When included, this is set to
2744 * the BSSID of the current association, i.e., to the value that is
2745 * included in the Current AP address field of the Reassociation Request
2747 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2748 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2750 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2751 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2752 * %NULL if not specified. This specifies the domain name of ER server and
2753 * is used to construct FILS wrapped data IE.
2754 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2755 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2756 * messages. This is also used to construct FILS wrapped data IE.
2757 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2758 * keys in FILS or %NULL if not specified.
2759 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2760 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2761 * offload of 4-way handshake.
2762 * @edmg: define the EDMG channels.
2763 * This may specify multiple channels and bonding options for the driver
2764 * to choose from, based on BSS configuration.
2766 struct cfg80211_connect_params
{
2767 struct ieee80211_channel
*channel
;
2768 struct ieee80211_channel
*channel_hint
;
2770 const u8
*bssid_hint
;
2773 enum nl80211_auth_type auth_type
;
2777 enum nl80211_mfp mfp
;
2778 struct cfg80211_crypto_settings crypto
;
2780 u8 key_len
, key_idx
;
2783 struct ieee80211_ht_cap ht_capa
;
2784 struct ieee80211_ht_cap ht_capa_mask
;
2785 struct ieee80211_vht_cap vht_capa
;
2786 struct ieee80211_vht_cap vht_capa_mask
;
2788 struct cfg80211_bss_selection bss_select
;
2789 const u8
*prev_bssid
;
2790 const u8
*fils_erp_username
;
2791 size_t fils_erp_username_len
;
2792 const u8
*fils_erp_realm
;
2793 size_t fils_erp_realm_len
;
2794 u16 fils_erp_next_seq_num
;
2795 const u8
*fils_erp_rrk
;
2796 size_t fils_erp_rrk_len
;
2798 struct ieee80211_edmg edmg
;
2802 * enum cfg80211_connect_params_changed - Connection parameters being updated
2804 * This enum provides information of all connect parameters that
2805 * have to be updated as part of update_connect_params() call.
2807 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2808 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2809 * username, erp sequence number and rrk) are updated
2810 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2812 enum cfg80211_connect_params_changed
{
2813 UPDATE_ASSOC_IES
= BIT(0),
2814 UPDATE_FILS_ERP_INFO
= BIT(1),
2815 UPDATE_AUTH_TYPE
= BIT(2),
2819 * enum wiphy_params_flags - set_wiphy_params bitfield values
2820 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2821 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2822 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2823 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2824 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2825 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2826 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2827 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2828 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2830 enum wiphy_params_flags
{
2831 WIPHY_PARAM_RETRY_SHORT
= 1 << 0,
2832 WIPHY_PARAM_RETRY_LONG
= 1 << 1,
2833 WIPHY_PARAM_FRAG_THRESHOLD
= 1 << 2,
2834 WIPHY_PARAM_RTS_THRESHOLD
= 1 << 3,
2835 WIPHY_PARAM_COVERAGE_CLASS
= 1 << 4,
2836 WIPHY_PARAM_DYN_ACK
= 1 << 5,
2837 WIPHY_PARAM_TXQ_LIMIT
= 1 << 6,
2838 WIPHY_PARAM_TXQ_MEMORY_LIMIT
= 1 << 7,
2839 WIPHY_PARAM_TXQ_QUANTUM
= 1 << 8,
2842 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2844 /* The per TXQ device queue limit in airtime */
2845 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2846 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2848 /* The per interface airtime threshold to switch to lower queue limit */
2849 #define IEEE80211_AQL_THRESHOLD 24000
2852 * struct cfg80211_pmksa - PMK Security Association
2854 * This structure is passed to the set/del_pmksa() method for PMKSA
2857 * @bssid: The AP's BSSID (may be %NULL).
2858 * @pmkid: The identifier to refer a PMKSA.
2859 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2860 * derivation by a FILS STA. Otherwise, %NULL.
2861 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2862 * the hash algorithm used to generate this.
2863 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2864 * cache identifier (may be %NULL).
2865 * @ssid_len: Length of the @ssid in octets.
2866 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2867 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2869 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
2870 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
2871 * The configured PMKSA must not be used for PMKSA caching after
2872 * expiration and any keys derived from this PMK become invalid on
2873 * expiration, i.e., the current association must be dropped if the PMK
2874 * used for it expires.
2875 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
2876 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
2877 * Drivers are expected to trigger a full authentication instead of using
2878 * this PMKSA for caching when reassociating to a new BSS after this
2879 * threshold to generate a new PMK before the current one expires.
2881 struct cfg80211_pmksa
{
2890 u8 pmk_reauth_threshold
;
2894 * struct cfg80211_pkt_pattern - packet pattern
2895 * @mask: bitmask where to match pattern and where to ignore bytes,
2896 * one bit per byte, in same format as nl80211
2897 * @pattern: bytes to match where bitmask is 1
2898 * @pattern_len: length of pattern (in bytes)
2899 * @pkt_offset: packet offset (in bytes)
2901 * Internal note: @mask and @pattern are allocated in one chunk of
2902 * memory, free @mask only!
2904 struct cfg80211_pkt_pattern
{
2905 const u8
*mask
, *pattern
;
2911 * struct cfg80211_wowlan_tcp - TCP connection parameters
2913 * @sock: (internal) socket for source port allocation
2914 * @src: source IP address
2915 * @dst: destination IP address
2916 * @dst_mac: destination MAC address
2917 * @src_port: source port
2918 * @dst_port: destination port
2919 * @payload_len: data payload length
2920 * @payload: data payload buffer
2921 * @payload_seq: payload sequence stamping configuration
2922 * @data_interval: interval at which to send data packets
2923 * @wake_len: wakeup payload match length
2924 * @wake_data: wakeup payload match data
2925 * @wake_mask: wakeup payload match mask
2926 * @tokens_size: length of the tokens buffer
2927 * @payload_tok: payload token usage configuration
2929 struct cfg80211_wowlan_tcp
{
2930 struct socket
*sock
;
2932 u16 src_port
, dst_port
;
2933 u8 dst_mac
[ETH_ALEN
];
2936 struct nl80211_wowlan_tcp_data_seq payload_seq
;
2939 const u8
*wake_data
, *wake_mask
;
2941 /* must be last, variable member */
2942 struct nl80211_wowlan_tcp_data_token payload_tok
;
2946 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2948 * This structure defines the enabled WoWLAN triggers for the device.
2949 * @any: wake up on any activity -- special trigger if device continues
2950 * operating as normal during suspend
2951 * @disconnect: wake up if getting disconnected
2952 * @magic_pkt: wake up on receiving magic packet
2953 * @patterns: wake up on receiving packet matching a pattern
2954 * @n_patterns: number of patterns
2955 * @gtk_rekey_failure: wake up on GTK rekey failure
2956 * @eap_identity_req: wake up on EAP identity request packet
2957 * @four_way_handshake: wake up on 4-way handshake
2958 * @rfkill_release: wake up when rfkill is released
2959 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2960 * NULL if not configured.
2961 * @nd_config: configuration for the scan to be used for net detect wake.
2963 struct cfg80211_wowlan
{
2964 bool any
, disconnect
, magic_pkt
, gtk_rekey_failure
,
2965 eap_identity_req
, four_way_handshake
,
2967 struct cfg80211_pkt_pattern
*patterns
;
2968 struct cfg80211_wowlan_tcp
*tcp
;
2970 struct cfg80211_sched_scan_request
*nd_config
;
2974 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2976 * This structure defines coalesce rule for the device.
2977 * @delay: maximum coalescing delay in msecs.
2978 * @condition: condition for packet coalescence.
2979 * see &enum nl80211_coalesce_condition.
2980 * @patterns: array of packet patterns
2981 * @n_patterns: number of patterns
2983 struct cfg80211_coalesce_rules
{
2985 enum nl80211_coalesce_condition condition
;
2986 struct cfg80211_pkt_pattern
*patterns
;
2991 * struct cfg80211_coalesce - Packet coalescing settings
2993 * This structure defines coalescing settings.
2994 * @rules: array of coalesce rules
2995 * @n_rules: number of rules
2997 struct cfg80211_coalesce
{
2998 struct cfg80211_coalesce_rules
*rules
;
3003 * struct cfg80211_wowlan_nd_match - information about the match
3005 * @ssid: SSID of the match that triggered the wake up
3006 * @n_channels: Number of channels where the match occurred. This
3007 * value may be zero if the driver can't report the channels.
3008 * @channels: center frequencies of the channels where a match
3011 struct cfg80211_wowlan_nd_match
{
3012 struct cfg80211_ssid ssid
;
3018 * struct cfg80211_wowlan_nd_info - net detect wake up information
3020 * @n_matches: Number of match information instances provided in
3021 * @matches. This value may be zero if the driver can't provide
3022 * match information.
3023 * @matches: Array of pointers to matches containing information about
3024 * the matches that triggered the wake up.
3026 struct cfg80211_wowlan_nd_info
{
3028 struct cfg80211_wowlan_nd_match
*matches
[];
3032 * struct cfg80211_wowlan_wakeup - wakeup report
3033 * @disconnect: woke up by getting disconnected
3034 * @magic_pkt: woke up by receiving magic packet
3035 * @gtk_rekey_failure: woke up by GTK rekey failure
3036 * @eap_identity_req: woke up by EAP identity request packet
3037 * @four_way_handshake: woke up by 4-way handshake
3038 * @rfkill_release: woke up by rfkill being released
3039 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3040 * @packet_present_len: copied wakeup packet data
3041 * @packet_len: original wakeup packet length
3042 * @packet: The packet causing the wakeup, if any.
3043 * @packet_80211: For pattern match, magic packet and other data
3044 * frame triggers an 802.3 frame should be reported, for
3045 * disconnect due to deauth 802.11 frame. This indicates which
3047 * @tcp_match: TCP wakeup packet received
3048 * @tcp_connlost: TCP connection lost or failed to establish
3049 * @tcp_nomoretokens: TCP data ran out of tokens
3050 * @net_detect: if not %NULL, woke up because of net detect
3052 struct cfg80211_wowlan_wakeup
{
3053 bool disconnect
, magic_pkt
, gtk_rekey_failure
,
3054 eap_identity_req
, four_way_handshake
,
3055 rfkill_release
, packet_80211
,
3056 tcp_match
, tcp_connlost
, tcp_nomoretokens
;
3058 u32 packet_present_len
, packet_len
;
3060 struct cfg80211_wowlan_nd_info
*net_detect
;
3064 * struct cfg80211_gtk_rekey_data - rekey data
3065 * @kek: key encryption key (@kek_len bytes)
3066 * @kck: key confirmation key (@kck_len bytes)
3067 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3068 * @kek_len: length of kek
3069 * @kck_len length of kck
3070 * @akm: akm (oui, id)
3072 struct cfg80211_gtk_rekey_data
{
3073 const u8
*kek
, *kck
, *replay_ctr
;
3075 u8 kek_len
, kck_len
;
3079 * struct cfg80211_update_ft_ies_params - FT IE Information
3081 * This structure provides information needed to update the fast transition IE
3083 * @md: The Mobility Domain ID, 2 Octet value
3084 * @ie: Fast Transition IEs
3085 * @ie_len: Length of ft_ie in octets
3087 struct cfg80211_update_ft_ies_params
{
3094 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3096 * This structure provides information needed to transmit a mgmt frame
3098 * @chan: channel to use
3099 * @offchan: indicates wether off channel operation is required
3100 * @wait: duration for ROC
3101 * @buf: buffer to transmit
3102 * @len: buffer length
3103 * @no_cck: don't use cck rates for this frame
3104 * @dont_wait_for_ack: tells the low level not to wait for an ack
3105 * @n_csa_offsets: length of csa_offsets array
3106 * @csa_offsets: array of all the csa offsets in the frame
3108 struct cfg80211_mgmt_tx_params
{
3109 struct ieee80211_channel
*chan
;
3115 bool dont_wait_for_ack
;
3117 const u16
*csa_offsets
;
3121 * struct cfg80211_dscp_exception - DSCP exception
3123 * @dscp: DSCP value that does not adhere to the user priority range definition
3124 * @up: user priority value to which the corresponding DSCP value belongs
3126 struct cfg80211_dscp_exception
{
3132 * struct cfg80211_dscp_range - DSCP range definition for user priority
3134 * @low: lowest DSCP value of this user priority range, inclusive
3135 * @high: highest DSCP value of this user priority range, inclusive
3137 struct cfg80211_dscp_range
{
3142 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3143 #define IEEE80211_QOS_MAP_MAX_EX 21
3144 #define IEEE80211_QOS_MAP_LEN_MIN 16
3145 #define IEEE80211_QOS_MAP_LEN_MAX \
3146 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3149 * struct cfg80211_qos_map - QoS Map Information
3151 * This struct defines the Interworking QoS map setting for DSCP values
3153 * @num_des: number of DSCP exceptions (0..21)
3154 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3155 * the user priority DSCP range definition
3156 * @up: DSCP range definition for a particular user priority
3158 struct cfg80211_qos_map
{
3160 struct cfg80211_dscp_exception dscp_exception
[IEEE80211_QOS_MAP_MAX_EX
];
3161 struct cfg80211_dscp_range up
[8];
3165 * struct cfg80211_nan_conf - NAN configuration
3167 * This struct defines NAN configuration parameters
3169 * @master_pref: master preference (1 - 255)
3170 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3171 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3172 * (i.e. BIT(NL80211_BAND_2GHZ)).
3174 struct cfg80211_nan_conf
{
3180 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3183 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3184 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3186 enum cfg80211_nan_conf_changes
{
3187 CFG80211_NAN_CONF_CHANGED_PREF
= BIT(0),
3188 CFG80211_NAN_CONF_CHANGED_BANDS
= BIT(1),
3192 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3194 * @filter: the content of the filter
3195 * @len: the length of the filter
3197 struct cfg80211_nan_func_filter
{
3203 * struct cfg80211_nan_func - a NAN function
3205 * @type: &enum nl80211_nan_function_type
3206 * @service_id: the service ID of the function
3207 * @publish_type: &nl80211_nan_publish_type
3208 * @close_range: if true, the range should be limited. Threshold is
3209 * implementation specific.
3210 * @publish_bcast: if true, the solicited publish should be broadcasted
3211 * @subscribe_active: if true, the subscribe is active
3212 * @followup_id: the instance ID for follow up
3213 * @followup_reqid: the requestor instance ID for follow up
3214 * @followup_dest: MAC address of the recipient of the follow up
3215 * @ttl: time to live counter in DW.
3216 * @serv_spec_info: Service Specific Info
3217 * @serv_spec_info_len: Service Specific Info length
3218 * @srf_include: if true, SRF is inclusive
3219 * @srf_bf: Bloom Filter
3220 * @srf_bf_len: Bloom Filter length
3221 * @srf_bf_idx: Bloom Filter index
3222 * @srf_macs: SRF MAC addresses
3223 * @srf_num_macs: number of MAC addresses in SRF
3224 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3225 * @tx_filters: filters that should be transmitted in the SDF.
3226 * @num_rx_filters: length of &rx_filters.
3227 * @num_tx_filters: length of &tx_filters.
3228 * @instance_id: driver allocated id of the function.
3229 * @cookie: unique NAN function identifier.
3231 struct cfg80211_nan_func
{
3232 enum nl80211_nan_function_type type
;
3233 u8 service_id
[NL80211_NAN_FUNC_SERVICE_ID_LEN
];
3237 bool subscribe_active
;
3240 struct mac_address followup_dest
;
3242 const u8
*serv_spec_info
;
3243 u8 serv_spec_info_len
;
3248 struct mac_address
*srf_macs
;
3250 struct cfg80211_nan_func_filter
*rx_filters
;
3251 struct cfg80211_nan_func_filter
*tx_filters
;
3259 * struct cfg80211_pmk_conf - PMK configuration
3261 * @aa: authenticator address
3262 * @pmk_len: PMK length in bytes.
3263 * @pmk: the PMK material
3264 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3265 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3268 struct cfg80211_pmk_conf
{
3272 const u8
*pmk_r0_name
;
3276 * struct cfg80211_external_auth_params - Trigger External authentication.
3278 * Commonly used across the external auth request and event interfaces.
3280 * @action: action type / trigger for external authentication. Only significant
3281 * for the authentication request event interface (driver to user space).
3282 * @bssid: BSSID of the peer with which the authentication has
3283 * to happen. Used by both the authentication request event and
3284 * authentication response command interface.
3285 * @ssid: SSID of the AP. Used by both the authentication request event and
3286 * authentication response command interface.
3287 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3288 * authentication request event interface.
3289 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3290 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3291 * the real status code for failures. Used only for the authentication
3292 * response command interface (user space to driver).
3293 * @pmkid: The identifier to refer a PMKSA.
3295 struct cfg80211_external_auth_params
{
3296 enum nl80211_external_auth_action action
;
3297 u8 bssid
[ETH_ALEN
] __aligned(2);
3298 struct cfg80211_ssid ssid
;
3299 unsigned int key_mgmt_suite
;
3305 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3307 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3308 * indicate the relevant values in this struct for them
3309 * @success_num: number of FTM sessions in which all frames were successfully
3311 * @partial_num: number of FTM sessions in which part of frames were
3312 * successfully answered
3313 * @failed_num: number of failed FTM sessions
3314 * @asap_num: number of ASAP FTM sessions
3315 * @non_asap_num: number of non-ASAP FTM sessions
3316 * @total_duration_ms: total sessions durations - gives an indication
3317 * of how much time the responder was busy
3318 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3319 * initiators that didn't finish successfully the negotiation phase with
3321 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3322 * for a new scheduling although it already has scheduled FTM slot
3323 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3325 struct cfg80211_ftm_responder_stats
{
3332 u64 total_duration_ms
;
3333 u32 unknown_triggers_num
;
3334 u32 reschedule_requests_num
;
3335 u32 out_of_window_triggers_num
;
3339 * struct cfg80211_pmsr_ftm_result - FTM result
3340 * @failure_reason: if this measurement failed (PMSR status is
3341 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3342 * reason than just "failure"
3343 * @burst_index: if reporting partial results, this is the index
3344 * in [0 .. num_bursts-1] of the burst that's being reported
3345 * @num_ftmr_attempts: number of FTM request frames transmitted
3346 * @num_ftmr_successes: number of FTM request frames acked
3347 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3348 * fill this to indicate in how many seconds a retry is deemed possible
3350 * @num_bursts_exp: actual number of bursts exponent negotiated
3351 * @burst_duration: actual burst duration negotiated
3352 * @ftms_per_burst: actual FTMs per burst negotiated
3353 * @lci_len: length of LCI information (if present)
3354 * @civicloc_len: length of civic location information (if present)
3355 * @lci: LCI data (may be %NULL)
3356 * @civicloc: civic location data (may be %NULL)
3357 * @rssi_avg: average RSSI over FTM action frames reported
3358 * @rssi_spread: spread of the RSSI over FTM action frames reported
3359 * @tx_rate: bitrate for transmitted FTM action frame response
3360 * @rx_rate: bitrate of received FTM action frame
3361 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3362 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3363 * the square root of the variance)
3364 * @rtt_spread: spread of the RTTs measured
3365 * @dist_avg: average of distances (mm) measured
3366 * (must have either this or @rtt_avg)
3367 * @dist_variance: variance of distances measured (see also @rtt_variance)
3368 * @dist_spread: spread of distances measured (see also @rtt_spread)
3369 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3370 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3371 * @rssi_avg_valid: @rssi_avg is valid
3372 * @rssi_spread_valid: @rssi_spread is valid
3373 * @tx_rate_valid: @tx_rate is valid
3374 * @rx_rate_valid: @rx_rate is valid
3375 * @rtt_avg_valid: @rtt_avg is valid
3376 * @rtt_variance_valid: @rtt_variance is valid
3377 * @rtt_spread_valid: @rtt_spread is valid
3378 * @dist_avg_valid: @dist_avg is valid
3379 * @dist_variance_valid: @dist_variance is valid
3380 * @dist_spread_valid: @dist_spread is valid
3382 struct cfg80211_pmsr_ftm_result
{
3385 unsigned int lci_len
;
3386 unsigned int civicloc_len
;
3387 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason
;
3388 u32 num_ftmr_attempts
, num_ftmr_successes
;
3396 struct rate_info tx_rate
, rx_rate
;
3404 u16 num_ftmr_attempts_valid
:1,
3405 num_ftmr_successes_valid
:1,
3407 rssi_spread_valid
:1,
3411 rtt_variance_valid
:1,
3414 dist_variance_valid
:1,
3415 dist_spread_valid
:1;
3419 * struct cfg80211_pmsr_result - peer measurement result
3420 * @addr: address of the peer
3421 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3422 * measurement was made)
3423 * @ap_tsf: AP's TSF at measurement time
3424 * @status: status of the measurement
3425 * @final: if reporting partial results, mark this as the last one; if not
3426 * reporting partial results always set this flag
3427 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3428 * @type: type of the measurement reported, note that we only support reporting
3429 * one type at a time, but you can report multiple results separately and
3430 * they're all aggregated for userspace.
3432 struct cfg80211_pmsr_result
{
3433 u64 host_time
, ap_tsf
;
3434 enum nl80211_peer_measurement_status status
;
3441 enum nl80211_peer_measurement_type type
;
3444 struct cfg80211_pmsr_ftm_result ftm
;
3449 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3450 * @requested: indicates FTM is requested
3451 * @preamble: frame preamble to use
3452 * @burst_period: burst period to use
3453 * @asap: indicates to use ASAP mode
3454 * @num_bursts_exp: number of bursts exponent
3455 * @burst_duration: burst duration
3456 * @ftms_per_burst: number of FTMs per burst
3457 * @ftmr_retries: number of retries for FTM request
3458 * @request_lci: request LCI information
3459 * @request_civicloc: request civic location information
3460 * @trigger_based: use trigger based ranging for the measurement
3461 * If neither @trigger_based nor @non_trigger_based is set,
3462 * EDCA based ranging will be used.
3463 * @non_trigger_based: use non trigger based ranging for the measurement
3464 * If neither @trigger_based nor @non_trigger_based is set,
3465 * EDCA based ranging will be used.
3467 * See also nl80211 for the respective attribute documentation.
3469 struct cfg80211_pmsr_ftm_request_peer
{
3470 enum nl80211_preamble preamble
;
3477 non_trigger_based
:1;
3485 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3486 * @addr: MAC address
3487 * @chandef: channel to use
3488 * @report_ap_tsf: report the associated AP's TSF
3489 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3491 struct cfg80211_pmsr_request_peer
{
3493 struct cfg80211_chan_def chandef
;
3495 struct cfg80211_pmsr_ftm_request_peer ftm
;
3499 * struct cfg80211_pmsr_request - peer measurement request
3500 * @cookie: cookie, set by cfg80211
3501 * @nl_portid: netlink portid - used by cfg80211
3502 * @drv_data: driver data for this request, if required for aborting,
3503 * not otherwise freed or anything by cfg80211
3504 * @mac_addr: MAC address used for (randomised) request
3505 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3506 * are 0 in the mask should be randomised, bits that are 1 should
3507 * be taken from the @mac_addr
3508 * @list: used by cfg80211 to hold on to the request
3509 * @timeout: timeout (in milliseconds) for the whole operation, if
3510 * zero it means there's no timeout
3511 * @n_peers: number of peers to do measurements with
3512 * @peers: per-peer measurement request data
3514 struct cfg80211_pmsr_request
{
3522 u8 mac_addr
[ETH_ALEN
] __aligned(2);
3523 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
3525 struct list_head list
;
3527 struct cfg80211_pmsr_request_peer peers
[];
3531 * struct cfg80211_update_owe_info - OWE Information
3533 * This structure provides information needed for the drivers to offload OWE
3534 * (Opportunistic Wireless Encryption) processing to the user space.
3536 * Commonly used across update_owe_info request and event interfaces.
3538 * @peer: MAC address of the peer device for which the OWE processing
3540 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3541 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3542 * cannot give you the real status code for failures. Used only for
3543 * OWE update request command interface (user space to driver).
3544 * @ie: IEs obtained from the peer or constructed by the user space. These are
3545 * the IEs of the remote peer in the event from the host driver and
3546 * the constructed IEs by the user space in the request interface.
3547 * @ie_len: Length of IEs in octets.
3549 struct cfg80211_update_owe_info
{
3550 u8 peer
[ETH_ALEN
] __aligned(2);
3557 * struct mgmt_frame_regs - management frame registrations data
3558 * @global_stypes: bitmap of management frame subtypes registered
3559 * for the entire device
3560 * @interface_stypes: bitmap of management frame subtypes registered
3561 * for the given interface
3562 * @global_mcast_rx: mcast RX is needed globally for these subtypes
3563 * @interface_mcast_stypes: mcast RX is needed on this interface
3564 * for these subtypes
3566 struct mgmt_frame_regs
{
3567 u32 global_stypes
, interface_stypes
;
3568 u32 global_mcast_stypes
, interface_mcast_stypes
;
3572 * struct cfg80211_ops - backend description for wireless configuration
3574 * This struct is registered by fullmac card drivers and/or wireless stacks
3575 * in order to handle configuration requests on their interfaces.
3577 * All callbacks except where otherwise noted should return 0
3578 * on success or a negative error code.
3580 * All operations are currently invoked under rtnl for consistency with the
3581 * wireless extensions but this is subject to reevaluation as soon as this
3582 * code is used more widely and we have a first user without wext.
3584 * @suspend: wiphy device needs to be suspended. The variable @wow will
3585 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3586 * configured for the device.
3587 * @resume: wiphy device needs to be resumed
3588 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3589 * to call device_set_wakeup_enable() to enable/disable wakeup from
3592 * @add_virtual_intf: create a new virtual interface with the given name,
3593 * must set the struct wireless_dev's iftype. Beware: You must create
3594 * the new netdev in the wiphy's network namespace! Returns the struct
3595 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3596 * also set the address member in the wdev.
3598 * @del_virtual_intf: remove the virtual interface
3600 * @change_virtual_intf: change type/configuration of virtual interface,
3601 * keep the struct wireless_dev's iftype updated.
3603 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3604 * when adding a group key.
3606 * @get_key: get information about the key with the given parameters.
3607 * @mac_addr will be %NULL when requesting information for a group
3608 * key. All pointers given to the @callback function need not be valid
3609 * after it returns. This function should return an error if it is
3610 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3612 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3613 * and @key_index, return -ENOENT if the key doesn't exist.
3615 * @set_default_key: set the default key on an interface
3617 * @set_default_mgmt_key: set the default management frame key on an interface
3619 * @set_default_beacon_key: set the default Beacon frame key on an interface
3621 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3623 * @start_ap: Start acting in AP mode defined by the parameters.
3624 * @change_beacon: Change the beacon parameters for an access point mode
3625 * interface. This should reject the call when AP mode wasn't started.
3626 * @stop_ap: Stop being an AP, including stopping beaconing.
3628 * @add_station: Add a new station.
3629 * @del_station: Remove a station
3630 * @change_station: Modify a given station. Note that flags changes are not much
3631 * validated in cfg80211, in particular the auth/assoc/authorized flags
3632 * might come to the driver in invalid combinations -- make sure to check
3633 * them, also against the existing state! Drivers must call
3634 * cfg80211_check_station_change() to validate the information.
3635 * @get_station: get station information for the station identified by @mac
3636 * @dump_station: dump station callback -- resume dump at index @idx
3638 * @add_mpath: add a fixed mesh path
3639 * @del_mpath: delete a given mesh path
3640 * @change_mpath: change a given mesh path
3641 * @get_mpath: get a mesh path for the given parameters
3642 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3643 * @get_mpp: get a mesh proxy path for the given parameters
3644 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3645 * @join_mesh: join the mesh network with the specified parameters
3646 * (invoked with the wireless_dev mutex held)
3647 * @leave_mesh: leave the current mesh network
3648 * (invoked with the wireless_dev mutex held)
3650 * @get_mesh_config: Get the current mesh configuration
3652 * @update_mesh_config: Update mesh parameters on a running mesh.
3653 * The mask is a bitfield which tells us which parameters to
3654 * set, and which to leave alone.
3656 * @change_bss: Modify parameters for a given BSS.
3658 * @set_txq_params: Set TX queue parameters
3660 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3661 * as it doesn't implement join_mesh and needs to set the channel to
3662 * join the mesh instead.
3664 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3665 * interfaces are active this callback should reject the configuration.
3666 * If no interfaces are active or the device is down, the channel should
3667 * be stored for when a monitor interface becomes active.
3669 * @scan: Request to do a scan. If returning zero, the scan request is given
3670 * the driver, and will be valid until passed to cfg80211_scan_done().
3671 * For scan results, call cfg80211_inform_bss(); you can call this outside
3672 * the scan/scan_done bracket too.
3673 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3674 * indicate the status of the scan through cfg80211_scan_done().
3676 * @auth: Request to authenticate with the specified peer
3677 * (invoked with the wireless_dev mutex held)
3678 * @assoc: Request to (re)associate with the specified peer
3679 * (invoked with the wireless_dev mutex held)
3680 * @deauth: Request to deauthenticate from the specified peer
3681 * (invoked with the wireless_dev mutex held)
3682 * @disassoc: Request to disassociate from the specified peer
3683 * (invoked with the wireless_dev mutex held)
3685 * @connect: Connect to the ESS with the specified parameters. When connected,
3686 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3687 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3688 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3689 * from the AP or cfg80211_connect_timeout() if no frame with status code
3691 * The driver is allowed to roam to other BSSes within the ESS when the
3692 * other BSS matches the connect parameters. When such roaming is initiated
3693 * by the driver, the driver is expected to verify that the target matches
3694 * the configured security parameters and to use Reassociation Request
3695 * frame instead of Association Request frame.
3696 * The connect function can also be used to request the driver to perform a
3697 * specific roam when connected to an ESS. In that case, the prev_bssid
3698 * parameter is set to the BSSID of the currently associated BSS as an
3699 * indication of requesting reassociation.
3700 * In both the driver-initiated and new connect() call initiated roaming
3701 * cases, the result of roaming is indicated with a call to
3702 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3703 * @update_connect_params: Update the connect parameters while connected to a
3704 * BSS. The updated parameters can be used by driver/firmware for
3705 * subsequent BSS selection (roaming) decisions and to form the
3706 * Authentication/(Re)Association Request frames. This call does not
3707 * request an immediate disassociation or reassociation with the current
3708 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3709 * changed are defined in &enum cfg80211_connect_params_changed.
3710 * (invoked with the wireless_dev mutex held)
3711 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3712 * connection is in progress. Once done, call cfg80211_disconnected() in
3713 * case connection was already established (invoked with the
3714 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3716 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3717 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3719 * (invoked with the wireless_dev mutex held)
3720 * @leave_ibss: Leave the IBSS.
3721 * (invoked with the wireless_dev mutex held)
3723 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3726 * @set_wiphy_params: Notify that wiphy parameters have changed;
3727 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3728 * have changed. The actual parameter values are available in
3729 * struct wiphy. If returning an error, no value should be changed.
3731 * @set_tx_power: set the transmit power according to the parameters,
3732 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3733 * wdev may be %NULL if power was set for the wiphy, and will
3734 * always be %NULL unless the driver supports per-vif TX power
3735 * (as advertised by the nl80211 feature flag.)
3736 * @get_tx_power: store the current TX power into the dbm variable;
3737 * return 0 if successful
3739 * @set_wds_peer: set the WDS peer for a WDS interface
3741 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3742 * functions to adjust rfkill hw state
3744 * @dump_survey: get site survey information.
3746 * @remain_on_channel: Request the driver to remain awake on the specified
3747 * channel for the specified duration to complete an off-channel
3748 * operation (e.g., public action frame exchange). When the driver is
3749 * ready on the requested channel, it must indicate this with an event
3750 * notification by calling cfg80211_ready_on_channel().
3751 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3752 * This allows the operation to be terminated prior to timeout based on
3753 * the duration value.
3754 * @mgmt_tx: Transmit a management frame.
3755 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3756 * frame on another channel
3758 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3759 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3760 * used by the function, but 0 and 1 must not be touched. Additionally,
3761 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3762 * dump and return to userspace with an error, so be careful. If any data
3763 * was passed in from userspace then the data/len arguments will be present
3764 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3766 * @set_bitrate_mask: set the bitrate mask configuration
3768 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3769 * devices running firmwares capable of generating the (re) association
3770 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3771 * @del_pmksa: Delete a cached PMKID.
3772 * @flush_pmksa: Flush all cached PMKIDs.
3773 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3774 * allows the driver to adjust the dynamic ps timeout value.
3775 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3776 * After configuration, the driver should (soon) send an event indicating
3777 * the current level is above/below the configured threshold; this may
3778 * need some care when the configuration is changed (without first being
3780 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3781 * connection quality monitor. An event is to be sent only when the
3782 * signal level is found to be outside the two values. The driver should
3783 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3784 * If it is provided then there's no point providing @set_cqm_rssi_config.
3785 * @set_cqm_txe_config: Configure connection quality monitor TX error
3787 * @sched_scan_start: Tell the driver to start a scheduled scan.
3788 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3789 * given request id. This call must stop the scheduled scan and be ready
3790 * for starting a new one before it returns, i.e. @sched_scan_start may be
3791 * called immediately after that again and should not fail in that case.
3792 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3793 * stop (when this method returns 0).
3795 * @update_mgmt_frame_registrations: Notify the driver that management frame
3796 * registrations were updated. The callback is allowed to sleep.
3798 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3799 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3800 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3801 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3803 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3805 * @tdls_mgmt: Transmit a TDLS management frame.
3806 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3808 * @probe_client: probe an associated client, must return a cookie that it
3809 * later passes to cfg80211_probe_status().
3811 * @set_noack_map: Set the NoAck Map for the TIDs.
3813 * @get_channel: Get the current operating channel for the virtual interface.
3814 * For monitor interfaces, it should return %NULL unless there's a single
3815 * current monitoring channel.
3817 * @start_p2p_device: Start the given P2P device.
3818 * @stop_p2p_device: Stop the given P2P device.
3820 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3821 * Parameters include ACL policy, an array of MAC address of stations
3822 * and the number of MAC addresses. If there is already a list in driver
3823 * this new list replaces the existing one. Driver has to clear its ACL
3824 * when number of MAC addresses entries is passed as 0. Drivers which
3825 * advertise the support for MAC based ACL have to implement this callback.
3827 * @start_radar_detection: Start radar detection in the driver.
3829 * @end_cac: End running CAC, probably because a related CAC
3830 * was finished on another phy.
3832 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3833 * driver. If the SME is in the driver/firmware, this information can be
3834 * used in building Authentication and Reassociation Request frames.
3836 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3837 * for a given duration (milliseconds). The protocol is provided so the
3838 * driver can take the most appropriate actions.
3839 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3840 * reliability. This operation can not fail.
3841 * @set_coalesce: Set coalesce parameters.
3843 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3844 * responsible for veryfing if the switch is possible. Since this is
3845 * inherently tricky driver may decide to disconnect an interface later
3846 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3847 * everything. It should do it's best to verify requests and reject them
3848 * as soon as possible.
3850 * @set_qos_map: Set QoS mapping information to the driver
3852 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3853 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3854 * changes during the lifetime of the BSS.
3856 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3857 * with the given parameters; action frame exchange has been handled by
3858 * userspace so this just has to modify the TX path to take the TS into
3860 * If the admitted time is 0 just validate the parameters to make sure
3861 * the session can be created at all; it is valid to just always return
3862 * success for that but that may result in inefficient behaviour (handshake
3863 * with the peer followed by immediate teardown when the addition is later
3865 * @del_tx_ts: remove an existing TX TS
3867 * @join_ocb: join the OCB network with the specified parameters
3868 * (invoked with the wireless_dev mutex held)
3869 * @leave_ocb: leave the current OCB network
3870 * (invoked with the wireless_dev mutex held)
3872 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3873 * is responsible for continually initiating channel-switching operations
3874 * and returning to the base channel for communication with the AP.
3875 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3876 * peers must be on the base channel when the call completes.
3877 * @start_nan: Start the NAN interface.
3878 * @stop_nan: Stop the NAN interface.
3879 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3880 * On success @nan_func ownership is transferred to the driver and
3881 * it may access it outside of the scope of this function. The driver
3882 * should free the @nan_func when no longer needed by calling
3883 * cfg80211_free_nan_func().
3884 * On success the driver should assign an instance_id in the
3885 * provided @nan_func.
3886 * @del_nan_func: Delete a NAN function.
3887 * @nan_change_conf: changes NAN configuration. The changed parameters must
3888 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3889 * All other parameters must be ignored.
3891 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3893 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3894 * function should return phy stats, and interface stats otherwise.
3896 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3897 * If not deleted through @del_pmk the PMK remains valid until disconnect
3898 * upon which the driver should clear it.
3899 * (invoked with the wireless_dev mutex held)
3900 * @del_pmk: delete the previously configured PMK for the given authenticator.
3901 * (invoked with the wireless_dev mutex held)
3903 * @external_auth: indicates result of offloaded authentication processing from
3906 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3907 * tells the driver that the frame should not be encrypted.
3909 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3910 * Statistics should be cumulative, currently no way to reset is provided.
3911 * @start_pmsr: start peer measurement (e.g. FTM)
3912 * @abort_pmsr: abort peer measurement
3914 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3915 * but offloading OWE processing to the user space will get the updated
3916 * DH IE through this interface.
3918 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3919 * and overrule HWMP path selection algorithm.
3920 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
3921 * This callback may sleep.
3922 * @reset_tid_config: Reset TID specific configuration for the peer, for the
3923 * given TIDs. This callback may sleep.
3925 struct cfg80211_ops
{
3926 int (*suspend
)(struct wiphy
*wiphy
, struct cfg80211_wowlan
*wow
);
3927 int (*resume
)(struct wiphy
*wiphy
);
3928 void (*set_wakeup
)(struct wiphy
*wiphy
, bool enabled
);
3930 struct wireless_dev
* (*add_virtual_intf
)(struct wiphy
*wiphy
,
3932 unsigned char name_assign_type
,
3933 enum nl80211_iftype type
,
3934 struct vif_params
*params
);
3935 int (*del_virtual_intf
)(struct wiphy
*wiphy
,
3936 struct wireless_dev
*wdev
);
3937 int (*change_virtual_intf
)(struct wiphy
*wiphy
,
3938 struct net_device
*dev
,
3939 enum nl80211_iftype type
,
3940 struct vif_params
*params
);
3942 int (*add_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3943 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
3944 struct key_params
*params
);
3945 int (*get_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3946 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
3948 void (*callback
)(void *cookie
, struct key_params
*));
3949 int (*del_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3950 u8 key_index
, bool pairwise
, const u8
*mac_addr
);
3951 int (*set_default_key
)(struct wiphy
*wiphy
,
3952 struct net_device
*netdev
,
3953 u8 key_index
, bool unicast
, bool multicast
);
3954 int (*set_default_mgmt_key
)(struct wiphy
*wiphy
,
3955 struct net_device
*netdev
,
3957 int (*set_default_beacon_key
)(struct wiphy
*wiphy
,
3958 struct net_device
*netdev
,
3961 int (*start_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3962 struct cfg80211_ap_settings
*settings
);
3963 int (*change_beacon
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3964 struct cfg80211_beacon_data
*info
);
3965 int (*stop_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
);
3968 int (*add_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3970 struct station_parameters
*params
);
3971 int (*del_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3972 struct station_del_parameters
*params
);
3973 int (*change_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3975 struct station_parameters
*params
);
3976 int (*get_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3977 const u8
*mac
, struct station_info
*sinfo
);
3978 int (*dump_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3979 int idx
, u8
*mac
, struct station_info
*sinfo
);
3981 int (*add_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3982 const u8
*dst
, const u8
*next_hop
);
3983 int (*del_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3985 int (*change_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3986 const u8
*dst
, const u8
*next_hop
);
3987 int (*get_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3988 u8
*dst
, u8
*next_hop
, struct mpath_info
*pinfo
);
3989 int (*dump_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3990 int idx
, u8
*dst
, u8
*next_hop
,
3991 struct mpath_info
*pinfo
);
3992 int (*get_mpp
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3993 u8
*dst
, u8
*mpp
, struct mpath_info
*pinfo
);
3994 int (*dump_mpp
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3995 int idx
, u8
*dst
, u8
*mpp
,
3996 struct mpath_info
*pinfo
);
3997 int (*get_mesh_config
)(struct wiphy
*wiphy
,
3998 struct net_device
*dev
,
3999 struct mesh_config
*conf
);
4000 int (*update_mesh_config
)(struct wiphy
*wiphy
,
4001 struct net_device
*dev
, u32 mask
,
4002 const struct mesh_config
*nconf
);
4003 int (*join_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4004 const struct mesh_config
*conf
,
4005 const struct mesh_setup
*setup
);
4006 int (*leave_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
);
4008 int (*join_ocb
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4009 struct ocb_setup
*setup
);
4010 int (*leave_ocb
)(struct wiphy
*wiphy
, struct net_device
*dev
);
4012 int (*change_bss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4013 struct bss_parameters
*params
);
4015 int (*set_txq_params
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4016 struct ieee80211_txq_params
*params
);
4018 int (*libertas_set_mesh_channel
)(struct wiphy
*wiphy
,
4019 struct net_device
*dev
,
4020 struct ieee80211_channel
*chan
);
4022 int (*set_monitor_channel
)(struct wiphy
*wiphy
,
4023 struct cfg80211_chan_def
*chandef
);
4025 int (*scan
)(struct wiphy
*wiphy
,
4026 struct cfg80211_scan_request
*request
);
4027 void (*abort_scan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
);
4029 int (*auth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4030 struct cfg80211_auth_request
*req
);
4031 int (*assoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4032 struct cfg80211_assoc_request
*req
);
4033 int (*deauth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4034 struct cfg80211_deauth_request
*req
);
4035 int (*disassoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4036 struct cfg80211_disassoc_request
*req
);
4038 int (*connect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4039 struct cfg80211_connect_params
*sme
);
4040 int (*update_connect_params
)(struct wiphy
*wiphy
,
4041 struct net_device
*dev
,
4042 struct cfg80211_connect_params
*sme
,
4044 int (*disconnect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4047 int (*join_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4048 struct cfg80211_ibss_params
*params
);
4049 int (*leave_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
);
4051 int (*set_mcast_rate
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4052 int rate
[NUM_NL80211_BANDS
]);
4054 int (*set_wiphy_params
)(struct wiphy
*wiphy
, u32 changed
);
4056 int (*set_tx_power
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4057 enum nl80211_tx_power_setting type
, int mbm
);
4058 int (*get_tx_power
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4061 int (*set_wds_peer
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4064 void (*rfkill_poll
)(struct wiphy
*wiphy
);
4066 #ifdef CONFIG_NL80211_TESTMODE
4067 int (*testmode_cmd
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4068 void *data
, int len
);
4069 int (*testmode_dump
)(struct wiphy
*wiphy
, struct sk_buff
*skb
,
4070 struct netlink_callback
*cb
,
4071 void *data
, int len
);
4074 int (*set_bitrate_mask
)(struct wiphy
*wiphy
,
4075 struct net_device
*dev
,
4077 const struct cfg80211_bitrate_mask
*mask
);
4079 int (*dump_survey
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
4080 int idx
, struct survey_info
*info
);
4082 int (*set_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
4083 struct cfg80211_pmksa
*pmksa
);
4084 int (*del_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
4085 struct cfg80211_pmksa
*pmksa
);
4086 int (*flush_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
);
4088 int (*remain_on_channel
)(struct wiphy
*wiphy
,
4089 struct wireless_dev
*wdev
,
4090 struct ieee80211_channel
*chan
,
4091 unsigned int duration
,
4093 int (*cancel_remain_on_channel
)(struct wiphy
*wiphy
,
4094 struct wireless_dev
*wdev
,
4097 int (*mgmt_tx
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4098 struct cfg80211_mgmt_tx_params
*params
,
4100 int (*mgmt_tx_cancel_wait
)(struct wiphy
*wiphy
,
4101 struct wireless_dev
*wdev
,
4104 int (*set_power_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4105 bool enabled
, int timeout
);
4107 int (*set_cqm_rssi_config
)(struct wiphy
*wiphy
,
4108 struct net_device
*dev
,
4109 s32 rssi_thold
, u32 rssi_hyst
);
4111 int (*set_cqm_rssi_range_config
)(struct wiphy
*wiphy
,
4112 struct net_device
*dev
,
4113 s32 rssi_low
, s32 rssi_high
);
4115 int (*set_cqm_txe_config
)(struct wiphy
*wiphy
,
4116 struct net_device
*dev
,
4117 u32 rate
, u32 pkts
, u32 intvl
);
4119 void (*update_mgmt_frame_registrations
)(struct wiphy
*wiphy
,
4120 struct wireless_dev
*wdev
,
4121 struct mgmt_frame_regs
*upd
);
4123 int (*set_antenna
)(struct wiphy
*wiphy
, u32 tx_ant
, u32 rx_ant
);
4124 int (*get_antenna
)(struct wiphy
*wiphy
, u32
*tx_ant
, u32
*rx_ant
);
4126 int (*sched_scan_start
)(struct wiphy
*wiphy
,
4127 struct net_device
*dev
,
4128 struct cfg80211_sched_scan_request
*request
);
4129 int (*sched_scan_stop
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4132 int (*set_rekey_data
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4133 struct cfg80211_gtk_rekey_data
*data
);
4135 int (*tdls_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4136 const u8
*peer
, u8 action_code
, u8 dialog_token
,
4137 u16 status_code
, u32 peer_capability
,
4138 bool initiator
, const u8
*buf
, size_t len
);
4139 int (*tdls_oper
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4140 const u8
*peer
, enum nl80211_tdls_operation oper
);
4142 int (*probe_client
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4143 const u8
*peer
, u64
*cookie
);
4145 int (*set_noack_map
)(struct wiphy
*wiphy
,
4146 struct net_device
*dev
,
4149 int (*get_channel
)(struct wiphy
*wiphy
,
4150 struct wireless_dev
*wdev
,
4151 struct cfg80211_chan_def
*chandef
);
4153 int (*start_p2p_device
)(struct wiphy
*wiphy
,
4154 struct wireless_dev
*wdev
);
4155 void (*stop_p2p_device
)(struct wiphy
*wiphy
,
4156 struct wireless_dev
*wdev
);
4158 int (*set_mac_acl
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4159 const struct cfg80211_acl_data
*params
);
4161 int (*start_radar_detection
)(struct wiphy
*wiphy
,
4162 struct net_device
*dev
,
4163 struct cfg80211_chan_def
*chandef
,
4165 void (*end_cac
)(struct wiphy
*wiphy
,
4166 struct net_device
*dev
);
4167 int (*update_ft_ies
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4168 struct cfg80211_update_ft_ies_params
*ftie
);
4169 int (*crit_proto_start
)(struct wiphy
*wiphy
,
4170 struct wireless_dev
*wdev
,
4171 enum nl80211_crit_proto_id protocol
,
4173 void (*crit_proto_stop
)(struct wiphy
*wiphy
,
4174 struct wireless_dev
*wdev
);
4175 int (*set_coalesce
)(struct wiphy
*wiphy
,
4176 struct cfg80211_coalesce
*coalesce
);
4178 int (*channel_switch
)(struct wiphy
*wiphy
,
4179 struct net_device
*dev
,
4180 struct cfg80211_csa_settings
*params
);
4182 int (*set_qos_map
)(struct wiphy
*wiphy
,
4183 struct net_device
*dev
,
4184 struct cfg80211_qos_map
*qos_map
);
4186 int (*set_ap_chanwidth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4187 struct cfg80211_chan_def
*chandef
);
4189 int (*add_tx_ts
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4190 u8 tsid
, const u8
*peer
, u8 user_prio
,
4192 int (*del_tx_ts
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4193 u8 tsid
, const u8
*peer
);
4195 int (*tdls_channel_switch
)(struct wiphy
*wiphy
,
4196 struct net_device
*dev
,
4197 const u8
*addr
, u8 oper_class
,
4198 struct cfg80211_chan_def
*chandef
);
4199 void (*tdls_cancel_channel_switch
)(struct wiphy
*wiphy
,
4200 struct net_device
*dev
,
4202 int (*start_nan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4203 struct cfg80211_nan_conf
*conf
);
4204 void (*stop_nan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
);
4205 int (*add_nan_func
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4206 struct cfg80211_nan_func
*nan_func
);
4207 void (*del_nan_func
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4209 int (*nan_change_conf
)(struct wiphy
*wiphy
,
4210 struct wireless_dev
*wdev
,
4211 struct cfg80211_nan_conf
*conf
,
4214 int (*set_multicast_to_unicast
)(struct wiphy
*wiphy
,
4215 struct net_device
*dev
,
4216 const bool enabled
);
4218 int (*get_txq_stats
)(struct wiphy
*wiphy
,
4219 struct wireless_dev
*wdev
,
4220 struct cfg80211_txq_stats
*txqstats
);
4222 int (*set_pmk
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4223 const struct cfg80211_pmk_conf
*conf
);
4224 int (*del_pmk
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4226 int (*external_auth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4227 struct cfg80211_external_auth_params
*params
);
4229 int (*tx_control_port
)(struct wiphy
*wiphy
,
4230 struct net_device
*dev
,
4231 const u8
*buf
, size_t len
,
4232 const u8
*dest
, const __be16 proto
,
4233 const bool noencrypt
,
4236 int (*get_ftm_responder_stats
)(struct wiphy
*wiphy
,
4237 struct net_device
*dev
,
4238 struct cfg80211_ftm_responder_stats
*ftm_stats
);
4240 int (*start_pmsr
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4241 struct cfg80211_pmsr_request
*request
);
4242 void (*abort_pmsr
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4243 struct cfg80211_pmsr_request
*request
);
4244 int (*update_owe_info
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4245 struct cfg80211_update_owe_info
*owe_info
);
4246 int (*probe_mesh_link
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4247 const u8
*buf
, size_t len
);
4248 int (*set_tid_config
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4249 struct cfg80211_tid_config
*tid_conf
);
4250 int (*reset_tid_config
)(struct wiphy
*wiphy
, struct net_device
*dev
,
4251 const u8
*peer
, u8 tids
);
4255 * wireless hardware and networking interfaces structures
4256 * and registration/helper functions
4260 * enum wiphy_flags - wiphy capability flags
4262 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4263 * into two, first for legacy bands and second for UHB.
4264 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4266 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4267 * by default -- this flag will be set depending on the kernel's default
4268 * on wiphy_new(), but can be changed by the driver if it has a good
4269 * reason to override the default
4270 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4271 * on a VLAN interface). This flag also serves an extra purpose of
4272 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4273 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4274 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4275 * control port protocol ethertype. The device also honours the
4276 * control_port_no_encrypt flag.
4277 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4278 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4279 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4280 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4282 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4283 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4284 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4285 * link setup/discovery operations internally. Setup, discovery and
4286 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4287 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4288 * used for asking the driver/firmware to perform a TDLS operation.
4289 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4290 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4291 * when there are virtual interfaces in AP mode by calling
4292 * cfg80211_report_obss_beacon().
4293 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4294 * responds to probe-requests in hardware.
4295 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4296 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4297 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4298 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4299 * beaconing mode (AP, IBSS, Mesh, ...).
4300 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4301 * before connection.
4302 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4305 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK
= BIT(0),
4307 WIPHY_FLAG_SPLIT_SCAN_6GHZ
= BIT(2),
4308 WIPHY_FLAG_NETNS_OK
= BIT(3),
4309 WIPHY_FLAG_PS_ON_BY_DEFAULT
= BIT(4),
4310 WIPHY_FLAG_4ADDR_AP
= BIT(5),
4311 WIPHY_FLAG_4ADDR_STATION
= BIT(6),
4312 WIPHY_FLAG_CONTROL_PORT_PROTOCOL
= BIT(7),
4313 WIPHY_FLAG_IBSS_RSN
= BIT(8),
4314 WIPHY_FLAG_MESH_AUTH
= BIT(10),
4315 /* use hole at 11 */
4316 /* use hole at 12 */
4317 WIPHY_FLAG_SUPPORTS_FW_ROAM
= BIT(13),
4318 WIPHY_FLAG_AP_UAPSD
= BIT(14),
4319 WIPHY_FLAG_SUPPORTS_TDLS
= BIT(15),
4320 WIPHY_FLAG_TDLS_EXTERNAL_SETUP
= BIT(16),
4321 WIPHY_FLAG_HAVE_AP_SME
= BIT(17),
4322 WIPHY_FLAG_REPORTS_OBSS
= BIT(18),
4323 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD
= BIT(19),
4324 WIPHY_FLAG_OFFCHAN_TX
= BIT(20),
4325 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL
= BIT(21),
4326 WIPHY_FLAG_SUPPORTS_5_10_MHZ
= BIT(22),
4327 WIPHY_FLAG_HAS_CHANNEL_SWITCH
= BIT(23),
4328 WIPHY_FLAG_HAS_STATIC_WEP
= BIT(24),
4332 * struct ieee80211_iface_limit - limit on certain interface types
4333 * @max: maximum number of interfaces of these types
4334 * @types: interface types (bits)
4336 struct ieee80211_iface_limit
{
4342 * struct ieee80211_iface_combination - possible interface combination
4344 * With this structure the driver can describe which interface
4345 * combinations it supports concurrently.
4349 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4353 * struct ieee80211_iface_limit limits1[] = {
4354 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4355 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4357 * struct ieee80211_iface_combination combination1 = {
4358 * .limits = limits1,
4359 * .n_limits = ARRAY_SIZE(limits1),
4360 * .max_interfaces = 2,
4361 * .beacon_int_infra_match = true,
4365 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4369 * struct ieee80211_iface_limit limits2[] = {
4370 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4371 * BIT(NL80211_IFTYPE_P2P_GO), },
4373 * struct ieee80211_iface_combination combination2 = {
4374 * .limits = limits2,
4375 * .n_limits = ARRAY_SIZE(limits2),
4376 * .max_interfaces = 8,
4377 * .num_different_channels = 1,
4381 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4383 * This allows for an infrastructure connection and three P2P connections.
4387 * struct ieee80211_iface_limit limits3[] = {
4388 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4389 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4390 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4392 * struct ieee80211_iface_combination combination3 = {
4393 * .limits = limits3,
4394 * .n_limits = ARRAY_SIZE(limits3),
4395 * .max_interfaces = 4,
4396 * .num_different_channels = 2,
4400 struct ieee80211_iface_combination
{
4403 * limits for the given interface types
4405 const struct ieee80211_iface_limit
*limits
;
4408 * @num_different_channels:
4409 * can use up to this many different channels
4411 u32 num_different_channels
;
4415 * maximum number of interfaces in total allowed in this group
4421 * number of limitations
4426 * @beacon_int_infra_match:
4427 * In this combination, the beacon intervals between infrastructure
4428 * and AP types must match. This is required only in special cases.
4430 bool beacon_int_infra_match
;
4433 * @radar_detect_widths:
4434 * bitmap of channel widths supported for radar detection
4436 u8 radar_detect_widths
;
4439 * @radar_detect_regions:
4440 * bitmap of regions supported for radar detection
4442 u8 radar_detect_regions
;
4445 * @beacon_int_min_gcd:
4446 * This interface combination supports different beacon intervals.
4449 * all beacon intervals for different interface must be same.
4451 * any beacon interval for the interface part of this combination AND
4452 * GCD of all beacon intervals from beaconing interfaces of this
4453 * combination must be greater or equal to this value.
4455 u32 beacon_int_min_gcd
;
4458 struct ieee80211_txrx_stypes
{
4463 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4464 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4465 * trigger that keeps the device operating as-is and
4466 * wakes up the host on any activity, for example a
4467 * received packet that passed filtering; note that the
4468 * packet should be preserved in that case
4469 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4471 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4472 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4473 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4474 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4475 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4476 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4477 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4479 enum wiphy_wowlan_support_flags
{
4480 WIPHY_WOWLAN_ANY
= BIT(0),
4481 WIPHY_WOWLAN_MAGIC_PKT
= BIT(1),
4482 WIPHY_WOWLAN_DISCONNECT
= BIT(2),
4483 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY
= BIT(3),
4484 WIPHY_WOWLAN_GTK_REKEY_FAILURE
= BIT(4),
4485 WIPHY_WOWLAN_EAP_IDENTITY_REQ
= BIT(5),
4486 WIPHY_WOWLAN_4WAY_HANDSHAKE
= BIT(6),
4487 WIPHY_WOWLAN_RFKILL_RELEASE
= BIT(7),
4488 WIPHY_WOWLAN_NET_DETECT
= BIT(8),
4491 struct wiphy_wowlan_tcp_support
{
4492 const struct nl80211_wowlan_tcp_data_token_feature
*tok
;
4493 u32 data_payload_max
;
4494 u32 data_interval_max
;
4495 u32 wake_payload_max
;
4500 * struct wiphy_wowlan_support - WoWLAN support data
4501 * @flags: see &enum wiphy_wowlan_support_flags
4502 * @n_patterns: number of supported wakeup patterns
4503 * (see nl80211.h for the pattern definition)
4504 * @pattern_max_len: maximum length of each pattern
4505 * @pattern_min_len: minimum length of each pattern
4506 * @max_pkt_offset: maximum Rx packet offset
4507 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4508 * similar, but not necessarily identical, to max_match_sets for
4510 * See &struct cfg80211_sched_scan_request.@match_sets for more
4512 * @tcp: TCP wakeup support information
4514 struct wiphy_wowlan_support
{
4517 int pattern_max_len
;
4518 int pattern_min_len
;
4520 int max_nd_match_sets
;
4521 const struct wiphy_wowlan_tcp_support
*tcp
;
4525 * struct wiphy_coalesce_support - coalesce support data
4526 * @n_rules: maximum number of coalesce rules
4527 * @max_delay: maximum supported coalescing delay in msecs
4528 * @n_patterns: number of supported patterns in a rule
4529 * (see nl80211.h for the pattern definition)
4530 * @pattern_max_len: maximum length of each pattern
4531 * @pattern_min_len: minimum length of each pattern
4532 * @max_pkt_offset: maximum Rx packet offset
4534 struct wiphy_coalesce_support
{
4538 int pattern_max_len
;
4539 int pattern_min_len
;
4544 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4545 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4546 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4547 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4548 * (must be combined with %_WDEV or %_NETDEV)
4550 enum wiphy_vendor_command_flags
{
4551 WIPHY_VENDOR_CMD_NEED_WDEV
= BIT(0),
4552 WIPHY_VENDOR_CMD_NEED_NETDEV
= BIT(1),
4553 WIPHY_VENDOR_CMD_NEED_RUNNING
= BIT(2),
4557 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4559 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4560 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4561 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4564 enum wiphy_opmode_flag
{
4565 STA_OPMODE_MAX_BW_CHANGED
= BIT(0),
4566 STA_OPMODE_SMPS_MODE_CHANGED
= BIT(1),
4567 STA_OPMODE_N_SS_CHANGED
= BIT(2),
4571 * struct sta_opmode_info - Station's ht/vht operation mode information
4572 * @changed: contains value from &enum wiphy_opmode_flag
4573 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4574 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4575 * @rx_nss: new rx_nss value of a station
4578 struct sta_opmode_info
{
4580 enum nl80211_smps_mode smps_mode
;
4581 enum nl80211_chan_width bw
;
4585 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4588 * struct wiphy_vendor_command - vendor command definition
4589 * @info: vendor command identifying information, as used in nl80211
4590 * @flags: flags, see &enum wiphy_vendor_command_flags
4591 * @doit: callback for the operation, note that wdev is %NULL if the
4592 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4593 * pointer may be %NULL if userspace provided no data at all
4594 * @dumpit: dump callback, for transferring bigger/multiple items. The
4595 * @storage points to cb->args[5], ie. is preserved over the multiple
4597 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4598 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4599 * attribute is just raw data (e.g. a firmware command).
4600 * @maxattr: highest attribute number in policy
4601 * It's recommended to not have the same sub command with both @doit and
4602 * @dumpit, so that userspace can assume certain ones are get and others
4603 * are used with dump requests.
4605 struct wiphy_vendor_command
{
4606 struct nl80211_vendor_cmd_info info
;
4608 int (*doit
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4609 const void *data
, int data_len
);
4610 int (*dumpit
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4611 struct sk_buff
*skb
, const void *data
, int data_len
,
4612 unsigned long *storage
);
4613 const struct nla_policy
*policy
;
4614 unsigned int maxattr
;
4618 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4619 * @iftype: interface type
4620 * @extended_capabilities: extended capabilities supported by the driver,
4621 * additional capabilities might be supported by userspace; these are the
4622 * 802.11 extended capabilities ("Extended Capabilities element") and are
4623 * in the same format as in the information element. See IEEE Std
4624 * 802.11-2012 8.4.2.29 for the defined fields.
4625 * @extended_capabilities_mask: mask of the valid values
4626 * @extended_capabilities_len: length of the extended capabilities
4628 struct wiphy_iftype_ext_capab
{
4629 enum nl80211_iftype iftype
;
4630 const u8
*extended_capabilities
;
4631 const u8
*extended_capabilities_mask
;
4632 u8 extended_capabilities_len
;
4636 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4637 * @max_peers: maximum number of peers in a single measurement
4638 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4639 * @randomize_mac_addr: can randomize MAC address for measurement
4640 * @ftm.supported: FTM measurement is supported
4641 * @ftm.asap: ASAP-mode is supported
4642 * @ftm.non_asap: non-ASAP-mode is supported
4643 * @ftm.request_lci: can request LCI data
4644 * @ftm.request_civicloc: can request civic location data
4645 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4646 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4647 * @ftm.max_bursts_exponent: maximum burst exponent supported
4648 * (set to -1 if not limited; note that setting this will necessarily
4649 * forbid using the value 15 to let the responder pick)
4650 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4652 * @ftm.trigger_based: trigger based ranging measurement is supported
4653 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
4655 struct cfg80211_pmsr_capabilities
{
4656 unsigned int max_peers
;
4658 randomize_mac_addr
:1;
4663 s8 max_bursts_exponent
;
4664 u8 max_ftms_per_burst
;
4671 non_trigger_based
:1;
4676 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4677 * suites for interface types defined in @iftypes_mask. Each type in the
4678 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4680 * @iftypes_mask: bitmask of interfaces types
4681 * @akm_suites: points to an array of supported akm suites
4682 * @n_akm_suites: number of supported AKM suites
4684 struct wiphy_iftype_akm_suites
{
4686 const u32
*akm_suites
;
4691 * struct wiphy - wireless hardware description
4692 * @reg_notifier: the driver's regulatory notification callback,
4693 * note that if your driver uses wiphy_apply_custom_regulatory()
4694 * the reg_notifier's request can be passed as NULL
4695 * @regd: the driver's regulatory domain, if one was requested via
4696 * the regulatory_hint() API. This can be used by the driver
4697 * on the reg_notifier() if it chooses to ignore future
4698 * regulatory domain changes caused by other drivers.
4699 * @signal_type: signal type reported in &struct cfg80211_bss.
4700 * @cipher_suites: supported cipher suites
4701 * @n_cipher_suites: number of supported cipher suites
4702 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4703 * the supported AKMs not advertized for a specific interface type in
4704 * iftype_akm_suites.
4705 * @n_akm_suites: number of supported AKM suites
4706 * @iftype_akm_suites: array of supported akm suites info per interface type.
4707 * Note that the bits in @iftypes_mask inside this structure cannot
4708 * overlap (i.e. only one occurrence of each type is allowed across all
4709 * instances of iftype_akm_suites).
4710 * @num_iftype_akm_suites: number of interface types for which supported akm
4711 * suites are specified separately.
4712 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4713 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4714 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4715 * -1 = fragmentation disabled, only odd values >= 256 used
4716 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4717 * @_net: the network namespace this wiphy currently lives in
4718 * @perm_addr: permanent MAC address of this device
4719 * @addr_mask: If the device supports multiple MAC addresses by masking,
4720 * set this to a mask with variable bits set to 1, e.g. if the last
4721 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4722 * variable bits shall be determined by the interfaces added, with
4723 * interfaces not matching the mask being rejected to be brought up.
4724 * @n_addresses: number of addresses in @addresses.
4725 * @addresses: If the device has more than one address, set this pointer
4726 * to a list of addresses (6 bytes each). The first one will be used
4727 * by default for perm_addr. In this case, the mask should be set to
4728 * all-zeroes. In this case it is assumed that the device can handle
4729 * the same number of arbitrary MAC addresses.
4730 * @registered: protects ->resume and ->suspend sysfs callbacks against
4731 * unregister hardware
4732 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4733 * It will be renamed automatically on wiphy renames
4734 * @dev: (virtual) struct device for this wiphy. The item in
4735 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4737 * @wext: wireless extension handlers
4738 * @priv: driver private data (sized according to wiphy_new() parameter)
4739 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4740 * must be set by driver
4741 * @iface_combinations: Valid interface combinations array, should not
4742 * list single interface types.
4743 * @n_iface_combinations: number of entries in @iface_combinations array.
4744 * @software_iftypes: bitmask of software interface types, these are not
4745 * subject to any restrictions since they are purely managed in SW.
4746 * @flags: wiphy flags, see &enum wiphy_flags
4747 * @regulatory_flags: wiphy regulatory flags, see
4748 * &enum ieee80211_regulatory_flags
4749 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4750 * @ext_features: extended features advertised to nl80211, see
4751 * &enum nl80211_ext_feature_index.
4752 * @bss_priv_size: each BSS struct has private data allocated with it,
4753 * this variable determines its size
4754 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4756 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4757 * the device can run concurrently.
4758 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4759 * for in any given scheduled scan
4760 * @max_match_sets: maximum number of match sets the device can handle
4761 * when performing a scheduled scan, 0 if filtering is not
4763 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4764 * add to probe request frames transmitted during a scan, must not
4765 * include fixed IEs like supported rates
4766 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4768 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4769 * of iterations) for scheduled scan supported by the device.
4770 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4771 * single scan plan supported by the device.
4772 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4773 * scan plan supported by the device.
4774 * @coverage_class: current coverage class
4775 * @fw_version: firmware version for ethtool reporting
4776 * @hw_version: hardware version for ethtool reporting
4777 * @max_num_pmkids: maximum number of PMKIDs supported by device
4778 * @privid: a pointer that drivers can use to identify if an arbitrary
4779 * wiphy is theirs, e.g. in global notifiers
4780 * @bands: information about bands/channels supported by this device
4782 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4783 * transmitted through nl80211, points to an array indexed by interface
4786 * @available_antennas_tx: bitmap of antennas which are available to be
4787 * configured as TX antennas. Antenna configuration commands will be
4788 * rejected unless this or @available_antennas_rx is set.
4790 * @available_antennas_rx: bitmap of antennas which are available to be
4791 * configured as RX antennas. Antenna configuration commands will be
4792 * rejected unless this or @available_antennas_tx is set.
4794 * @probe_resp_offload:
4795 * Bitmap of supported protocols for probe response offloading.
4796 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4797 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4799 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4800 * may request, if implemented.
4802 * @wowlan: WoWLAN support information
4803 * @wowlan_config: current WoWLAN configuration; this should usually not be
4804 * used since access to it is necessarily racy, use the parameter passed
4805 * to the suspend() operation instead.
4807 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4808 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4809 * If null, then none can be over-ridden.
4810 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4811 * If null, then none can be over-ridden.
4813 * @wdev_list: the list of associated (virtual) interfaces; this list must
4814 * not be modified by the driver, but can be read with RTNL/RCU protection.
4816 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4819 * @extended_capabilities: extended capabilities supported by the driver,
4820 * additional capabilities might be supported by userspace; these are
4821 * the 802.11 extended capabilities ("Extended Capabilities element")
4822 * and are in the same format as in the information element. See
4823 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4824 * extended capabilities to be used if the capabilities are not specified
4825 * for a specific interface type in iftype_ext_capab.
4826 * @extended_capabilities_mask: mask of the valid values
4827 * @extended_capabilities_len: length of the extended capabilities
4828 * @iftype_ext_capab: array of extended capabilities per interface type
4829 * @num_iftype_ext_capab: number of interface types for which extended
4830 * capabilities are specified separately.
4831 * @coalesce: packet coalescing support information
4833 * @vendor_commands: array of vendor commands supported by the hardware
4834 * @n_vendor_commands: number of vendor commands
4835 * @vendor_events: array of vendor events supported by the hardware
4836 * @n_vendor_events: number of vendor events
4838 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4839 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4840 * driver is allowed to advertise a theoretical limit that it can reach in
4841 * some cases, but may not always reach.
4843 * @max_num_csa_counters: Number of supported csa_counters in beacons
4844 * and probe responses. This value should be set if the driver
4845 * wishes to limit the number of csa counters. Default (0) means
4847 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4848 * by the driver in the .connect() callback. The bit position maps to the
4849 * attribute indices defined in &enum nl80211_bss_select_attr.
4851 * @nan_supported_bands: bands supported by the device in NAN mode, a
4852 * bitmap of &enum nl80211_band values. For instance, for
4853 * NL80211_BAND_2GHZ, bit 0 would be set
4854 * (i.e. BIT(NL80211_BAND_2GHZ)).
4856 * @txq_limit: configuration of internal TX queue frame limit
4857 * @txq_memory_limit: configuration internal TX queue memory limit
4858 * @txq_quantum: configuration of internal TX queue scheduler quantum
4860 * @tx_queue_len: allow setting transmit queue len for drivers not using
4863 * @support_mbssid: can HW support association with nontransmitted AP
4864 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4865 * HE AP, in order to avoid compatibility issues.
4866 * @support_mbssid must be set for this to have any effect.
4868 * @pmsr_capa: peer measurement capabilities
4870 * @tid_config_support: describes the per-TID config support that the
4872 * @tid_config_support.vif: bitmap of attributes (configurations)
4873 * supported by the driver for each vif
4874 * @tid_config_support.peer: bitmap of attributes (configurations)
4875 * supported by the driver for each peer
4876 * @tid_config_support.max_retry: maximum supported retry count for
4877 * long/short retry configuration
4879 * @max_data_retry_count: maximum supported per TID retry count for
4880 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
4881 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
4884 /* assign these fields before you register the wiphy */
4886 u8 perm_addr
[ETH_ALEN
];
4887 u8 addr_mask
[ETH_ALEN
];
4889 struct mac_address
*addresses
;
4891 const struct ieee80211_txrx_stypes
*mgmt_stypes
;
4893 const struct ieee80211_iface_combination
*iface_combinations
;
4894 int n_iface_combinations
;
4895 u16 software_iftypes
;
4899 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4900 u16 interface_modes
;
4902 u16 max_acl_mac_addrs
;
4904 u32 flags
, regulatory_flags
, features
;
4905 u8 ext_features
[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES
, 8)];
4909 enum cfg80211_signal_type signal_type
;
4913 u8 max_sched_scan_reqs
;
4914 u8 max_sched_scan_ssids
;
4916 u16 max_scan_ie_len
;
4917 u16 max_sched_scan_ie_len
;
4918 u32 max_sched_scan_plans
;
4919 u32 max_sched_scan_plan_interval
;
4920 u32 max_sched_scan_plan_iterations
;
4922 int n_cipher_suites
;
4923 const u32
*cipher_suites
;
4926 const u32
*akm_suites
;
4928 const struct wiphy_iftype_akm_suites
*iftype_akm_suites
;
4929 unsigned int num_iftype_akm_suites
;
4937 char fw_version
[ETHTOOL_FWVERS_LEN
];
4941 const struct wiphy_wowlan_support
*wowlan
;
4942 struct cfg80211_wowlan
*wowlan_config
;
4945 u16 max_remain_on_channel_duration
;
4949 u32 available_antennas_tx
;
4950 u32 available_antennas_rx
;
4952 u32 probe_resp_offload
;
4954 const u8
*extended_capabilities
, *extended_capabilities_mask
;
4955 u8 extended_capabilities_len
;
4957 const struct wiphy_iftype_ext_capab
*iftype_ext_capab
;
4958 unsigned int num_iftype_ext_capab
;
4962 struct ieee80211_supported_band
*bands
[NUM_NL80211_BANDS
];
4964 void (*reg_notifier
)(struct wiphy
*wiphy
,
4965 struct regulatory_request
*request
);
4967 /* fields below are read-only, assigned by cfg80211 */
4969 const struct ieee80211_regdomain __rcu
*regd
;
4975 struct dentry
*debugfsdir
;
4977 const struct ieee80211_ht_cap
*ht_capa_mod_mask
;
4978 const struct ieee80211_vht_cap
*vht_capa_mod_mask
;
4980 struct list_head wdev_list
;
4982 possible_net_t _net
;
4984 #ifdef CONFIG_CFG80211_WEXT
4985 const struct iw_handler_def
*wext
;
4988 const struct wiphy_coalesce_support
*coalesce
;
4990 const struct wiphy_vendor_command
*vendor_commands
;
4991 const struct nl80211_vendor_cmd_info
*vendor_events
;
4992 int n_vendor_commands
, n_vendor_events
;
4994 u16 max_ap_assoc_sta
;
4996 u8 max_num_csa_counters
;
4998 u32 bss_select_support
;
5000 u8 nan_supported_bands
;
5003 u32 txq_memory_limit
;
5006 unsigned long tx_queue_len
;
5008 u8 support_mbssid
:1,
5009 support_only_he_mbssid
:1;
5011 const struct cfg80211_pmsr_capabilities
*pmsr_capa
;
5016 } tid_config_support
;
5018 u8 max_data_retry_count
;
5020 char priv
[] __aligned(NETDEV_ALIGN
);
5023 static inline struct net
*wiphy_net(struct wiphy
*wiphy
)
5025 return read_pnet(&wiphy
->_net
);
5028 static inline void wiphy_net_set(struct wiphy
*wiphy
, struct net
*net
)
5030 write_pnet(&wiphy
->_net
, net
);
5034 * wiphy_priv - return priv from wiphy
5036 * @wiphy: the wiphy whose priv pointer to return
5037 * Return: The priv of @wiphy.
5039 static inline void *wiphy_priv(struct wiphy
*wiphy
)
5042 return &wiphy
->priv
;
5046 * priv_to_wiphy - return the wiphy containing the priv
5048 * @priv: a pointer previously returned by wiphy_priv
5049 * Return: The wiphy of @priv.
5051 static inline struct wiphy
*priv_to_wiphy(void *priv
)
5054 return container_of(priv
, struct wiphy
, priv
);
5058 * set_wiphy_dev - set device pointer for wiphy
5060 * @wiphy: The wiphy whose device to bind
5061 * @dev: The device to parent it to
5063 static inline void set_wiphy_dev(struct wiphy
*wiphy
, struct device
*dev
)
5065 wiphy
->dev
.parent
= dev
;
5069 * wiphy_dev - get wiphy dev pointer
5071 * @wiphy: The wiphy whose device struct to look up
5072 * Return: The dev of @wiphy.
5074 static inline struct device
*wiphy_dev(struct wiphy
*wiphy
)
5076 return wiphy
->dev
.parent
;
5080 * wiphy_name - get wiphy name
5082 * @wiphy: The wiphy whose name to return
5083 * Return: The name of @wiphy.
5085 static inline const char *wiphy_name(const struct wiphy
*wiphy
)
5087 return dev_name(&wiphy
->dev
);
5091 * wiphy_new_nm - create a new wiphy for use with cfg80211
5093 * @ops: The configuration operations for this device
5094 * @sizeof_priv: The size of the private area to allocate
5095 * @requested_name: Request a particular name.
5096 * NULL is valid value, and means use the default phy%d naming.
5098 * Create a new wiphy and associate the given operations with it.
5099 * @sizeof_priv bytes are allocated for private use.
5101 * Return: A pointer to the new wiphy. This pointer must be
5102 * assigned to each netdev's ieee80211_ptr for proper operation.
5104 struct wiphy
*wiphy_new_nm(const struct cfg80211_ops
*ops
, int sizeof_priv
,
5105 const char *requested_name
);
5108 * wiphy_new - create a new wiphy for use with cfg80211
5110 * @ops: The configuration operations for this device
5111 * @sizeof_priv: The size of the private area to allocate
5113 * Create a new wiphy and associate the given operations with it.
5114 * @sizeof_priv bytes are allocated for private use.
5116 * Return: A pointer to the new wiphy. This pointer must be
5117 * assigned to each netdev's ieee80211_ptr for proper operation.
5119 static inline struct wiphy
*wiphy_new(const struct cfg80211_ops
*ops
,
5122 return wiphy_new_nm(ops
, sizeof_priv
, NULL
);
5126 * wiphy_register - register a wiphy with cfg80211
5128 * @wiphy: The wiphy to register.
5130 * Return: A non-negative wiphy index or a negative error code.
5132 int wiphy_register(struct wiphy
*wiphy
);
5135 * wiphy_unregister - deregister a wiphy from cfg80211
5137 * @wiphy: The wiphy to unregister.
5139 * After this call, no more requests can be made with this priv
5140 * pointer, but the call may sleep to wait for an outstanding
5141 * request that is being handled.
5143 void wiphy_unregister(struct wiphy
*wiphy
);
5146 * wiphy_free - free wiphy
5148 * @wiphy: The wiphy to free
5150 void wiphy_free(struct wiphy
*wiphy
);
5152 /* internal structs */
5153 struct cfg80211_conn
;
5154 struct cfg80211_internal_bss
;
5155 struct cfg80211_cached_keys
;
5156 struct cfg80211_cqm_config
;
5159 * struct wireless_dev - wireless device state
5161 * For netdevs, this structure must be allocated by the driver
5162 * that uses the ieee80211_ptr field in struct net_device (this
5163 * is intentional so it can be allocated along with the netdev.)
5164 * It need not be registered then as netdev registration will
5165 * be intercepted by cfg80211 to see the new wireless device.
5167 * For non-netdev uses, it must also be allocated by the driver
5168 * in response to the cfg80211 callbacks that require it, as
5169 * there's no netdev registration in that case it may not be
5170 * allocated outside of callback operations that return it.
5172 * @wiphy: pointer to hardware description
5173 * @iftype: interface type
5174 * @list: (private) Used to collect the interfaces
5175 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5176 * @identifier: (private) Identifier used in nl80211 to identify this
5177 * wireless device if it has no netdev
5178 * @current_bss: (private) Used by the internal configuration code
5179 * @chandef: (private) Used by the internal configuration code to track
5180 * the user-set channel definition.
5181 * @preset_chandef: (private) Used by the internal configuration code to
5182 * track the channel to be used for AP later
5183 * @bssid: (private) Used by the internal configuration code
5184 * @ssid: (private) Used by the internal configuration code
5185 * @ssid_len: (private) Used by the internal configuration code
5186 * @mesh_id_len: (private) Used by the internal configuration code
5187 * @mesh_id_up_len: (private) Used by the internal configuration code
5188 * @wext: (private) Used by the internal wireless extensions compat code
5189 * @wext.ibss: (private) IBSS data part of wext handling
5190 * @wext.connect: (private) connection handling data
5191 * @wext.keys: (private) (WEP) key data
5192 * @wext.ie: (private) extra elements for association
5193 * @wext.ie_len: (private) length of extra elements
5194 * @wext.bssid: (private) selected network BSSID
5195 * @wext.ssid: (private) selected network SSID
5196 * @wext.default_key: (private) selected default key index
5197 * @wext.default_mgmt_key: (private) selected default management key index
5198 * @wext.prev_bssid: (private) previous BSSID for reassociation
5199 * @wext.prev_bssid_valid: (private) previous BSSID validity
5200 * @use_4addr: indicates 4addr mode is used on this interface, must be
5201 * set by driver (if supported) on add_interface BEFORE registering the
5202 * netdev and may otherwise be used by driver read-only, will be update
5203 * by cfg80211 on change_interface
5204 * @mgmt_registrations: list of registrations for management frames
5205 * @mgmt_registrations_lock: lock for the list
5206 * @mgmt_registrations_need_update: mgmt registrations were updated,
5207 * need to propagate the update to the driver
5208 * @mtx: mutex used to lock data in this struct, may be used by drivers
5209 * and some API functions require it held
5210 * @beacon_interval: beacon interval used on this device for transmitting
5211 * beacons, 0 when not valid
5212 * @address: The address for this device, valid only if @netdev is %NULL
5213 * @is_running: true if this is a non-netdev device that has been started, e.g.
5215 * @cac_started: true if DFS channel availability check has been started
5216 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5217 * @cac_time_ms: CAC time in ms
5218 * @ps: powersave mode is enabled
5219 * @ps_timeout: dynamic powersave timeout
5220 * @ap_unexpected_nlportid: (private) netlink port ID of application
5221 * registered for unexpected class 3 frames (AP mode)
5222 * @conn: (private) cfg80211 software SME connection state machine data
5223 * @connect_keys: (private) keys to set after connection is established
5224 * @conn_bss_type: connecting/connected BSS type
5225 * @conn_owner_nlportid: (private) connection owner socket port ID
5226 * @disconnect_wk: (private) auto-disconnect work
5227 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5228 * @ibss_fixed: (private) IBSS is using fixed BSSID
5229 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
5230 * @event_list: (private) list for internal event processing
5231 * @event_lock: (private) lock for event list
5232 * @owner_nlportid: (private) owner socket port ID
5233 * @nl_owner_dead: (private) owner socket went away
5234 * @cqm_config: (private) nl80211 RSSI monitor state
5235 * @pmsr_list: (private) peer measurement requests
5236 * @pmsr_lock: (private) peer measurements requests/results lock
5237 * @pmsr_free_wk: (private) peer measurements cleanup work
5238 * @unprot_beacon_reported: (private) timestamp of last
5239 * unprotected beacon report
5241 struct wireless_dev
{
5242 struct wiphy
*wiphy
;
5243 enum nl80211_iftype iftype
;
5245 /* the remainder of this struct should be private to cfg80211 */
5246 struct list_head list
;
5247 struct net_device
*netdev
;
5251 struct list_head mgmt_registrations
;
5252 spinlock_t mgmt_registrations_lock
;
5253 u8 mgmt_registrations_need_update
:1;
5257 bool use_4addr
, is_running
;
5259 u8 address
[ETH_ALEN
] __aligned(sizeof(u16
));
5261 /* currently used for IBSS and SME - might be rearranged later */
5262 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
5263 u8 ssid_len
, mesh_id_len
, mesh_id_up_len
;
5264 struct cfg80211_conn
*conn
;
5265 struct cfg80211_cached_keys
*connect_keys
;
5266 enum ieee80211_bss_type conn_bss_type
;
5267 u32 conn_owner_nlportid
;
5269 struct work_struct disconnect_wk
;
5270 u8 disconnect_bssid
[ETH_ALEN
];
5272 struct list_head event_list
;
5273 spinlock_t event_lock
;
5275 struct cfg80211_internal_bss
*current_bss
; /* associated / joined */
5276 struct cfg80211_chan_def preset_chandef
;
5277 struct cfg80211_chan_def chandef
;
5280 bool ibss_dfs_possible
;
5285 int beacon_interval
;
5287 u32 ap_unexpected_nlportid
;
5293 unsigned long cac_start_time
;
5294 unsigned int cac_time_ms
;
5296 #ifdef CONFIG_CFG80211_WEXT
5299 struct cfg80211_ibss_params ibss
;
5300 struct cfg80211_connect_params connect
;
5301 struct cfg80211_cached_keys
*keys
;
5305 u8 prev_bssid
[ETH_ALEN
];
5306 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
5307 s8 default_key
, default_mgmt_key
;
5308 bool prev_bssid_valid
;
5312 struct cfg80211_cqm_config
*cqm_config
;
5314 struct list_head pmsr_list
;
5315 spinlock_t pmsr_lock
;
5316 struct work_struct pmsr_free_wk
;
5318 unsigned long unprot_beacon_reported
;
5321 static inline u8
*wdev_address(struct wireless_dev
*wdev
)
5324 return wdev
->netdev
->dev_addr
;
5325 return wdev
->address
;
5328 static inline bool wdev_running(struct wireless_dev
*wdev
)
5331 return netif_running(wdev
->netdev
);
5332 return wdev
->is_running
;
5336 * wdev_priv - return wiphy priv from wireless_dev
5338 * @wdev: The wireless device whose wiphy's priv pointer to return
5339 * Return: The wiphy priv of @wdev.
5341 static inline void *wdev_priv(struct wireless_dev
*wdev
)
5344 return wiphy_priv(wdev
->wiphy
);
5348 * DOC: Utility functions
5350 * cfg80211 offers a number of utility functions that can be useful.
5354 * ieee80211_channel_equal - compare two struct ieee80211_channel
5356 * @a: 1st struct ieee80211_channel
5357 * @b: 2nd struct ieee80211_channel
5358 * Return: true if center frequency of @a == @b
5361 ieee80211_channel_equal(struct ieee80211_channel
*a
,
5362 struct ieee80211_channel
*b
)
5364 return (a
->center_freq
== b
->center_freq
&&
5365 a
->freq_offset
== b
->freq_offset
);
5369 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5370 * @chan: struct ieee80211_channel to convert
5371 * Return: The corresponding frequency (in KHz)
5374 ieee80211_channel_to_khz(const struct ieee80211_channel
*chan
)
5376 return MHZ_TO_KHZ(chan
->center_freq
) + chan
->freq_offset
;
5380 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5382 * Only allowed for band NL80211_BAND_S1GHZ
5384 * Return: The allowed channel width for this center_freq
5386 enum nl80211_chan_width
5387 ieee80211_s1g_channel_width(const struct ieee80211_channel
*chan
);
5390 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5391 * @chan: channel number
5392 * @band: band, necessary due to channel number overlap
5393 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5395 u32
ieee80211_channel_to_freq_khz(int chan
, enum nl80211_band band
);
5398 * ieee80211_channel_to_frequency - convert channel number to frequency
5399 * @chan: channel number
5400 * @band: band, necessary due to channel number overlap
5401 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5404 ieee80211_channel_to_frequency(int chan
, enum nl80211_band band
)
5406 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan
, band
));
5410 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5411 * @freq: center frequency in KHz
5412 * Return: The corresponding channel, or 0 if the conversion failed.
5414 int ieee80211_freq_khz_to_channel(u32 freq
);
5417 * ieee80211_frequency_to_channel - convert frequency to channel number
5418 * @freq: center frequency in MHz
5419 * Return: The corresponding channel, or 0 if the conversion failed.
5422 ieee80211_frequency_to_channel(int freq
)
5424 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq
));
5428 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5430 * @wiphy: the struct wiphy to get the channel for
5431 * @freq: the center frequency (in KHz) of the channel
5432 * Return: The channel struct from @wiphy at @freq.
5434 struct ieee80211_channel
*
5435 ieee80211_get_channel_khz(struct wiphy
*wiphy
, u32 freq
);
5438 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5440 * @wiphy: the struct wiphy to get the channel for
5441 * @freq: the center frequency (in MHz) of the channel
5442 * Return: The channel struct from @wiphy at @freq.
5444 static inline struct ieee80211_channel
*
5445 ieee80211_get_channel(struct wiphy
*wiphy
, int freq
)
5447 return ieee80211_get_channel_khz(wiphy
, MHZ_TO_KHZ(freq
));
5451 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5452 * @chan: control channel to check
5454 * The Preferred Scanning Channels (PSC) are defined in
5455 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5457 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel
*chan
)
5459 if (chan
->band
!= NL80211_BAND_6GHZ
)
5462 return ieee80211_frequency_to_channel(chan
->center_freq
) % 16 == 5;
5466 * ieee80211_get_response_rate - get basic rate for a given rate
5468 * @sband: the band to look for rates in
5469 * @basic_rates: bitmap of basic rates
5470 * @bitrate: the bitrate for which to find the basic rate
5472 * Return: The basic rate corresponding to a given bitrate, that
5473 * is the next lower bitrate contained in the basic rate map,
5474 * which is, for this function, given as a bitmap of indices of
5475 * rates in the band's bitrate table.
5477 struct ieee80211_rate
*
5478 ieee80211_get_response_rate(struct ieee80211_supported_band
*sband
,
5479 u32 basic_rates
, int bitrate
);
5482 * ieee80211_mandatory_rates - get mandatory rates for a given band
5483 * @sband: the band to look for rates in
5484 * @scan_width: width of the control channel
5486 * This function returns a bitmap of the mandatory rates for the given
5487 * band, bits are set according to the rate position in the bitrates array.
5489 u32
ieee80211_mandatory_rates(struct ieee80211_supported_band
*sband
,
5490 enum nl80211_bss_scan_width scan_width
);
5493 * Radiotap parsing functions -- for controlled injection support
5495 * Implemented in net/wireless/radiotap.c
5496 * Documentation in Documentation/networking/radiotap-headers.rst
5499 struct radiotap_align_size
{
5500 uint8_t align
:4, size
:4;
5503 struct ieee80211_radiotap_namespace
{
5504 const struct radiotap_align_size
*align_size
;
5510 struct ieee80211_radiotap_vendor_namespaces
{
5511 const struct ieee80211_radiotap_namespace
*ns
;
5516 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5517 * @this_arg_index: index of current arg, valid after each successful call
5518 * to ieee80211_radiotap_iterator_next()
5519 * @this_arg: pointer to current radiotap arg; it is valid after each
5520 * call to ieee80211_radiotap_iterator_next() but also after
5521 * ieee80211_radiotap_iterator_init() where it will point to
5522 * the beginning of the actual data portion
5523 * @this_arg_size: length of the current arg, for convenience
5524 * @current_namespace: pointer to the current namespace definition
5525 * (or internally %NULL if the current namespace is unknown)
5526 * @is_radiotap_ns: indicates whether the current namespace is the default
5527 * radiotap namespace or not
5529 * @_rtheader: pointer to the radiotap header we are walking through
5530 * @_max_length: length of radiotap header in cpu byte ordering
5531 * @_arg_index: next argument index
5532 * @_arg: next argument pointer
5533 * @_next_bitmap: internal pointer to next present u32
5534 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5535 * @_vns: vendor namespace definitions
5536 * @_next_ns_data: beginning of the next namespace's data
5537 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5540 * Describes the radiotap parser state. Fields prefixed with an underscore
5541 * must not be used by users of the parser, only by the parser internally.
5544 struct ieee80211_radiotap_iterator
{
5545 struct ieee80211_radiotap_header
*_rtheader
;
5546 const struct ieee80211_radiotap_vendor_namespaces
*_vns
;
5547 const struct ieee80211_radiotap_namespace
*current_namespace
;
5549 unsigned char *_arg
, *_next_ns_data
;
5550 __le32
*_next_bitmap
;
5552 unsigned char *this_arg
;
5560 uint32_t _bitmap_shifter
;
5565 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator
*iterator
,
5566 struct ieee80211_radiotap_header
*radiotap_header
,
5568 const struct ieee80211_radiotap_vendor_namespaces
*vns
);
5571 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator
*iterator
);
5574 extern const unsigned char rfc1042_header
[6];
5575 extern const unsigned char bridge_tunnel_header
[6];
5578 * ieee80211_get_hdrlen_from_skb - get header length from data
5582 * Given an skb with a raw 802.11 header at the data pointer this function
5583 * returns the 802.11 header length.
5585 * Return: The 802.11 header length in bytes (not including encryption
5586 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5589 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
5592 * ieee80211_hdrlen - get header length in bytes from frame control
5593 * @fc: frame control field in little-endian format
5594 * Return: The header length in bytes.
5596 unsigned int __attribute_const__
ieee80211_hdrlen(__le16 fc
);
5599 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5600 * @meshhdr: the mesh extension header, only the flags field
5601 * (first byte) will be accessed
5602 * Return: The length of the extension header, which is always at
5603 * least 6 bytes and at most 18 if address 5 and 6 are present.
5605 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr
*meshhdr
);
5608 * DOC: Data path helpers
5610 * In addition to generic utilities, cfg80211 also offers
5611 * functions that help implement the data path for devices
5612 * that do not do the 802.11/802.3 conversion on the device.
5616 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5617 * @skb: the 802.11 data frame
5618 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5619 * of it being pushed into the SKB
5620 * @addr: the device MAC address
5621 * @iftype: the virtual interface type
5622 * @data_offset: offset of payload after the 802.11 header
5623 * Return: 0 on success. Non-zero on error.
5625 int ieee80211_data_to_8023_exthdr(struct sk_buff
*skb
, struct ethhdr
*ehdr
,
5626 const u8
*addr
, enum nl80211_iftype iftype
,
5630 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5631 * @skb: the 802.11 data frame
5632 * @addr: the device MAC address
5633 * @iftype: the virtual interface type
5634 * Return: 0 on success. Non-zero on error.
5636 static inline int ieee80211_data_to_8023(struct sk_buff
*skb
, const u8
*addr
,
5637 enum nl80211_iftype iftype
)
5639 return ieee80211_data_to_8023_exthdr(skb
, NULL
, addr
, iftype
, 0);
5643 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5645 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5646 * The @list will be empty if the decode fails. The @skb must be fully
5647 * header-less before being passed in here; it is freed in this function.
5649 * @skb: The input A-MSDU frame without any headers.
5650 * @list: The output list of 802.3 frames. It must be allocated and
5651 * initialized by the caller.
5652 * @addr: The device MAC address.
5653 * @iftype: The device interface type.
5654 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5655 * @check_da: DA to check in the inner ethernet header, or NULL
5656 * @check_sa: SA to check in the inner ethernet header, or NULL
5658 void ieee80211_amsdu_to_8023s(struct sk_buff
*skb
, struct sk_buff_head
*list
,
5659 const u8
*addr
, enum nl80211_iftype iftype
,
5660 const unsigned int extra_headroom
,
5661 const u8
*check_da
, const u8
*check_sa
);
5664 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5665 * @skb: the data frame
5666 * @qos_map: Interworking QoS mapping or %NULL if not in use
5667 * Return: The 802.1p/1d tag.
5669 unsigned int cfg80211_classify8021d(struct sk_buff
*skb
,
5670 struct cfg80211_qos_map
*qos_map
);
5673 * cfg80211_find_elem_match - match information element and byte array in data
5676 * @ies: data consisting of IEs
5677 * @len: length of data
5678 * @match: byte array to match
5679 * @match_len: number of bytes in the match array
5680 * @match_offset: offset in the IE data where the byte array should match.
5681 * Note the difference to cfg80211_find_ie_match() which considers
5682 * the offset to start from the element ID byte, but here we take
5683 * the data portion instead.
5685 * Return: %NULL if the element ID could not be found or if
5686 * the element is invalid (claims to be longer than the given
5687 * data) or if the byte array doesn't match; otherwise return the
5688 * requested element struct.
5690 * Note: There are no checks on the element length other than
5691 * having to fit into the given data and being large enough for the
5692 * byte array to match.
5694 const struct element
*
5695 cfg80211_find_elem_match(u8 eid
, const u8
*ies
, unsigned int len
,
5696 const u8
*match
, unsigned int match_len
,
5697 unsigned int match_offset
);
5700 * cfg80211_find_ie_match - match information element and byte array in data
5703 * @ies: data consisting of IEs
5704 * @len: length of data
5705 * @match: byte array to match
5706 * @match_len: number of bytes in the match array
5707 * @match_offset: offset in the IE where the byte array should match.
5708 * If match_len is zero, this must also be set to zero.
5709 * Otherwise this must be set to 2 or more, because the first
5710 * byte is the element id, which is already compared to eid, and
5711 * the second byte is the IE length.
5713 * Return: %NULL if the element ID could not be found or if
5714 * the element is invalid (claims to be longer than the given
5715 * data) or if the byte array doesn't match, or a pointer to the first
5716 * byte of the requested element, that is the byte containing the
5719 * Note: There are no checks on the element length other than
5720 * having to fit into the given data and being large enough for the
5721 * byte array to match.
5723 static inline const u8
*
5724 cfg80211_find_ie_match(u8 eid
, const u8
*ies
, unsigned int len
,
5725 const u8
*match
, unsigned int match_len
,
5726 unsigned int match_offset
)
5728 /* match_offset can't be smaller than 2, unless match_len is
5729 * zero, in which case match_offset must be zero as well.
5731 if (WARN_ON((match_len
&& match_offset
< 2) ||
5732 (!match_len
&& match_offset
)))
5735 return (void *)cfg80211_find_elem_match(eid
, ies
, len
,
5738 match_offset
- 2 : 0);
5742 * cfg80211_find_elem - find information element in data
5745 * @ies: data consisting of IEs
5746 * @len: length of data
5748 * Return: %NULL if the element ID could not be found or if
5749 * the element is invalid (claims to be longer than the given
5750 * data) or if the byte array doesn't match; otherwise return the
5751 * requested element struct.
5753 * Note: There are no checks on the element length other than
5754 * having to fit into the given data.
5756 static inline const struct element
*
5757 cfg80211_find_elem(u8 eid
, const u8
*ies
, int len
)
5759 return cfg80211_find_elem_match(eid
, ies
, len
, NULL
, 0, 0);
5763 * cfg80211_find_ie - find information element in data
5766 * @ies: data consisting of IEs
5767 * @len: length of data
5769 * Return: %NULL if the element ID could not be found or if
5770 * the element is invalid (claims to be longer than the given
5771 * data), or a pointer to the first byte of the requested
5772 * element, that is the byte containing the element ID.
5774 * Note: There are no checks on the element length other than
5775 * having to fit into the given data.
5777 static inline const u8
*cfg80211_find_ie(u8 eid
, const u8
*ies
, int len
)
5779 return cfg80211_find_ie_match(eid
, ies
, len
, NULL
, 0, 0);
5783 * cfg80211_find_ext_elem - find information element with EID Extension in data
5785 * @ext_eid: element ID Extension
5786 * @ies: data consisting of IEs
5787 * @len: length of data
5789 * Return: %NULL if the etended element could not be found or if
5790 * the element is invalid (claims to be longer than the given
5791 * data) or if the byte array doesn't match; otherwise return the
5792 * requested element struct.
5794 * Note: There are no checks on the element length other than
5795 * having to fit into the given data.
5797 static inline const struct element
*
5798 cfg80211_find_ext_elem(u8 ext_eid
, const u8
*ies
, int len
)
5800 return cfg80211_find_elem_match(WLAN_EID_EXTENSION
, ies
, len
,
5805 * cfg80211_find_ext_ie - find information element with EID Extension in data
5807 * @ext_eid: element ID Extension
5808 * @ies: data consisting of IEs
5809 * @len: length of data
5811 * Return: %NULL if the extended element ID could not be found or if
5812 * the element is invalid (claims to be longer than the given
5813 * data), or a pointer to the first byte of the requested
5814 * element, that is the byte containing the element ID.
5816 * Note: There are no checks on the element length other than
5817 * having to fit into the given data.
5819 static inline const u8
*cfg80211_find_ext_ie(u8 ext_eid
, const u8
*ies
, int len
)
5821 return cfg80211_find_ie_match(WLAN_EID_EXTENSION
, ies
, len
,
5826 * cfg80211_find_vendor_elem - find vendor specific information element in data
5829 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5830 * @ies: data consisting of IEs
5831 * @len: length of data
5833 * Return: %NULL if the vendor specific element ID could not be found or if the
5834 * element is invalid (claims to be longer than the given data); otherwise
5835 * return the element structure for the requested element.
5837 * Note: There are no checks on the element length other than having to fit into
5840 const struct element
*cfg80211_find_vendor_elem(unsigned int oui
, int oui_type
,
5845 * cfg80211_find_vendor_ie - find vendor specific information element in data
5848 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5849 * @ies: data consisting of IEs
5850 * @len: length of data
5852 * Return: %NULL if the vendor specific element ID could not be found or if the
5853 * element is invalid (claims to be longer than the given data), or a pointer to
5854 * the first byte of the requested element, that is the byte containing the
5857 * Note: There are no checks on the element length other than having to fit into
5860 static inline const u8
*
5861 cfg80211_find_vendor_ie(unsigned int oui
, int oui_type
,
5862 const u8
*ies
, unsigned int len
)
5864 return (void *)cfg80211_find_vendor_elem(oui
, oui_type
, ies
, len
);
5868 * cfg80211_send_layer2_update - send layer 2 update frame
5870 * @dev: network device
5871 * @addr: STA MAC address
5873 * Wireless drivers can use this function to update forwarding tables in bridge
5874 * devices upon STA association.
5876 void cfg80211_send_layer2_update(struct net_device
*dev
, const u8
*addr
);
5879 * DOC: Regulatory enforcement infrastructure
5885 * regulatory_hint - driver hint to the wireless core a regulatory domain
5886 * @wiphy: the wireless device giving the hint (used only for reporting
5888 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5889 * should be in. If @rd is set this should be NULL. Note that if you
5890 * set this to NULL you should still set rd->alpha2 to some accepted
5893 * Wireless drivers can use this function to hint to the wireless core
5894 * what it believes should be the current regulatory domain by
5895 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5896 * domain should be in or by providing a completely build regulatory domain.
5897 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5898 * for a regulatory domain structure for the respective country.
5900 * The wiphy must have been registered to cfg80211 prior to this call.
5901 * For cfg80211 drivers this means you must first use wiphy_register(),
5902 * for mac80211 drivers you must first use ieee80211_register_hw().
5904 * Drivers should check the return value, its possible you can get
5907 * Return: 0 on success. -ENOMEM.
5909 int regulatory_hint(struct wiphy
*wiphy
, const char *alpha2
);
5912 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5913 * @wiphy: the wireless device we want to process the regulatory domain on
5914 * @rd: the regulatory domain informatoin to use for this wiphy
5916 * Set the regulatory domain information for self-managed wiphys, only they
5917 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5920 * Return: 0 on success. -EINVAL, -EPERM
5922 int regulatory_set_wiphy_regd(struct wiphy
*wiphy
,
5923 struct ieee80211_regdomain
*rd
);
5926 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5927 * @wiphy: the wireless device we want to process the regulatory domain on
5928 * @rd: the regulatory domain information to use for this wiphy
5930 * This functions requires the RTNL to be held and applies the new regdomain
5931 * synchronously to this wiphy. For more details see
5932 * regulatory_set_wiphy_regd().
5934 * Return: 0 on success. -EINVAL, -EPERM
5936 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy
*wiphy
,
5937 struct ieee80211_regdomain
*rd
);
5940 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5941 * @wiphy: the wireless device we want to process the regulatory domain on
5942 * @regd: the custom regulatory domain to use for this wiphy
5944 * Drivers can sometimes have custom regulatory domains which do not apply
5945 * to a specific country. Drivers can use this to apply such custom regulatory
5946 * domains. This routine must be called prior to wiphy registration. The
5947 * custom regulatory domain will be trusted completely and as such previous
5948 * default channel settings will be disregarded. If no rule is found for a
5949 * channel on the regulatory domain the channel will be disabled.
5950 * Drivers using this for a wiphy should also set the wiphy flag
5951 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5952 * that called this helper.
5954 void wiphy_apply_custom_regulatory(struct wiphy
*wiphy
,
5955 const struct ieee80211_regdomain
*regd
);
5958 * freq_reg_info - get regulatory information for the given frequency
5959 * @wiphy: the wiphy for which we want to process this rule for
5960 * @center_freq: Frequency in KHz for which we want regulatory information for
5962 * Use this function to get the regulatory rule for a specific frequency on
5963 * a given wireless device. If the device has a specific regulatory domain
5964 * it wants to follow we respect that unless a country IE has been received
5965 * and processed already.
5967 * Return: A valid pointer, or, when an error occurs, for example if no rule
5968 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5969 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5970 * value will be -ERANGE if we determine the given center_freq does not even
5971 * have a regulatory rule for a frequency range in the center_freq's band.
5972 * See freq_in_rule_band() for our current definition of a band -- this is
5973 * purely subjective and right now it's 802.11 specific.
5975 const struct ieee80211_reg_rule
*freq_reg_info(struct wiphy
*wiphy
,
5979 * reg_initiator_name - map regulatory request initiator enum to name
5980 * @initiator: the regulatory request initiator
5982 * You can use this to map the regulatory request initiator enum to a
5983 * proper string representation.
5985 const char *reg_initiator_name(enum nl80211_reg_initiator initiator
);
5988 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
5989 * @wiphy: wiphy for which pre-CAC capability is checked.
5991 * Pre-CAC is allowed only in some regdomains (notable ETSI).
5993 bool regulatory_pre_cac_allowed(struct wiphy
*wiphy
);
5996 * DOC: Internal regulatory db functions
6001 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6002 * Regulatory self-managed driver can use it to proactively
6004 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6005 * @freq: the freqency(in MHz) to be queried.
6006 * @rule: pointer to store the wmm rule from the regulatory db.
6008 * Self-managed wireless drivers can use this function to query
6009 * the internal regulatory database to check whether the given
6010 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6012 * Drivers should check the return value, its possible you can get
6015 * Return: 0 on success. -ENODATA.
6017 int reg_query_regdb_wmm(char *alpha2
, int freq
,
6018 struct ieee80211_reg_rule
*rule
);
6021 * callbacks for asynchronous cfg80211 methods, notification
6022 * functions and BSS handling helpers
6026 * cfg80211_scan_done - notify that scan finished
6028 * @request: the corresponding scan request
6029 * @info: information about the completed scan
6031 void cfg80211_scan_done(struct cfg80211_scan_request
*request
,
6032 struct cfg80211_scan_info
*info
);
6035 * cfg80211_sched_scan_results - notify that new scan results are available
6037 * @wiphy: the wiphy which got scheduled scan results
6038 * @reqid: identifier for the related scheduled scan request
6040 void cfg80211_sched_scan_results(struct wiphy
*wiphy
, u64 reqid
);
6043 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6045 * @wiphy: the wiphy on which the scheduled scan stopped
6046 * @reqid: identifier for the related scheduled scan request
6048 * The driver can call this function to inform cfg80211 that the
6049 * scheduled scan had to be stopped, for whatever reason. The driver
6050 * is then called back via the sched_scan_stop operation when done.
6052 void cfg80211_sched_scan_stopped(struct wiphy
*wiphy
, u64 reqid
);
6055 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
6057 * @wiphy: the wiphy on which the scheduled scan stopped
6058 * @reqid: identifier for the related scheduled scan request
6060 * The driver can call this function to inform cfg80211 that the
6061 * scheduled scan had to be stopped, for whatever reason. The driver
6062 * is then called back via the sched_scan_stop operation when done.
6063 * This function should be called with rtnl locked.
6065 void cfg80211_sched_scan_stopped_rtnl(struct wiphy
*wiphy
, u64 reqid
);
6068 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6069 * @wiphy: the wiphy reporting the BSS
6070 * @data: the BSS metadata
6071 * @mgmt: the management frame (probe response or beacon)
6072 * @len: length of the management frame
6073 * @gfp: context flags
6075 * This informs cfg80211 that BSS information was found and
6076 * the BSS should be updated/added.
6078 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6079 * Or %NULL on error.
6081 struct cfg80211_bss
* __must_check
6082 cfg80211_inform_bss_frame_data(struct wiphy
*wiphy
,
6083 struct cfg80211_inform_bss
*data
,
6084 struct ieee80211_mgmt
*mgmt
, size_t len
,
6087 static inline struct cfg80211_bss
* __must_check
6088 cfg80211_inform_bss_width_frame(struct wiphy
*wiphy
,
6089 struct ieee80211_channel
*rx_channel
,
6090 enum nl80211_bss_scan_width scan_width
,
6091 struct ieee80211_mgmt
*mgmt
, size_t len
,
6092 s32 signal
, gfp_t gfp
)
6094 struct cfg80211_inform_bss data
= {
6096 .scan_width
= scan_width
,
6100 return cfg80211_inform_bss_frame_data(wiphy
, &data
, mgmt
, len
, gfp
);
6103 static inline struct cfg80211_bss
* __must_check
6104 cfg80211_inform_bss_frame(struct wiphy
*wiphy
,
6105 struct ieee80211_channel
*rx_channel
,
6106 struct ieee80211_mgmt
*mgmt
, size_t len
,
6107 s32 signal
, gfp_t gfp
)
6109 struct cfg80211_inform_bss data
= {
6111 .scan_width
= NL80211_BSS_CHAN_WIDTH_20
,
6115 return cfg80211_inform_bss_frame_data(wiphy
, &data
, mgmt
, len
, gfp
);
6119 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6120 * @bssid: transmitter BSSID
6121 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6122 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6123 * @new_bssid: calculated nontransmitted BSSID
6125 static inline void cfg80211_gen_new_bssid(const u8
*bssid
, u8 max_bssid
,
6126 u8 mbssid_index
, u8
*new_bssid
)
6128 u64 bssid_u64
= ether_addr_to_u64(bssid
);
6129 u64 mask
= GENMASK_ULL(max_bssid
- 1, 0);
6132 new_bssid_u64
= bssid_u64
& ~mask
;
6134 new_bssid_u64
|= ((bssid_u64
& mask
) + mbssid_index
) & mask
;
6136 u64_to_ether_addr(new_bssid_u64
, new_bssid
);
6140 * cfg80211_is_element_inherited - returns if element ID should be inherited
6141 * @element: element to check
6142 * @non_inherit_element: non inheritance element
6144 bool cfg80211_is_element_inherited(const struct element
*element
,
6145 const struct element
*non_inherit_element
);
6148 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6150 * @ielen: length of IEs
6151 * @mbssid_elem: current MBSSID element
6152 * @sub_elem: current MBSSID subelement (profile)
6153 * @merged_ie: location of the merged profile
6154 * @max_copy_len: max merged profile length
6156 size_t cfg80211_merge_profile(const u8
*ie
, size_t ielen
,
6157 const struct element
*mbssid_elem
,
6158 const struct element
*sub_elem
,
6159 u8
*merged_ie
, size_t max_copy_len
);
6162 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6163 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6164 * from a beacon or probe response
6165 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6166 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6168 enum cfg80211_bss_frame_type
{
6169 CFG80211_BSS_FTYPE_UNKNOWN
,
6170 CFG80211_BSS_FTYPE_BEACON
,
6171 CFG80211_BSS_FTYPE_PRESP
,
6175 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6177 * @wiphy: the wiphy reporting the BSS
6178 * @data: the BSS metadata
6179 * @ftype: frame type (if known)
6180 * @bssid: the BSSID of the BSS
6181 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6182 * @capability: the capability field sent by the peer
6183 * @beacon_interval: the beacon interval announced by the peer
6184 * @ie: additional IEs sent by the peer
6185 * @ielen: length of the additional IEs
6186 * @gfp: context flags
6188 * This informs cfg80211 that BSS information was found and
6189 * the BSS should be updated/added.
6191 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6192 * Or %NULL on error.
6194 struct cfg80211_bss
* __must_check
6195 cfg80211_inform_bss_data(struct wiphy
*wiphy
,
6196 struct cfg80211_inform_bss
*data
,
6197 enum cfg80211_bss_frame_type ftype
,
6198 const u8
*bssid
, u64 tsf
, u16 capability
,
6199 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
6202 static inline struct cfg80211_bss
* __must_check
6203 cfg80211_inform_bss_width(struct wiphy
*wiphy
,
6204 struct ieee80211_channel
*rx_channel
,
6205 enum nl80211_bss_scan_width scan_width
,
6206 enum cfg80211_bss_frame_type ftype
,
6207 const u8
*bssid
, u64 tsf
, u16 capability
,
6208 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
6209 s32 signal
, gfp_t gfp
)
6211 struct cfg80211_inform_bss data
= {
6213 .scan_width
= scan_width
,
6217 return cfg80211_inform_bss_data(wiphy
, &data
, ftype
, bssid
, tsf
,
6218 capability
, beacon_interval
, ie
, ielen
,
6222 static inline struct cfg80211_bss
* __must_check
6223 cfg80211_inform_bss(struct wiphy
*wiphy
,
6224 struct ieee80211_channel
*rx_channel
,
6225 enum cfg80211_bss_frame_type ftype
,
6226 const u8
*bssid
, u64 tsf
, u16 capability
,
6227 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
6228 s32 signal
, gfp_t gfp
)
6230 struct cfg80211_inform_bss data
= {
6232 .scan_width
= NL80211_BSS_CHAN_WIDTH_20
,
6236 return cfg80211_inform_bss_data(wiphy
, &data
, ftype
, bssid
, tsf
,
6237 capability
, beacon_interval
, ie
, ielen
,
6242 * cfg80211_get_bss - get a BSS reference
6243 * @wiphy: the wiphy this BSS struct belongs to
6244 * @channel: the channel to search on (or %NULL)
6245 * @bssid: the desired BSSID (or %NULL)
6246 * @ssid: the desired SSID (or %NULL)
6247 * @ssid_len: length of the SSID (or 0)
6248 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6249 * @privacy: privacy filter, see &enum ieee80211_privacy
6251 struct cfg80211_bss
*cfg80211_get_bss(struct wiphy
*wiphy
,
6252 struct ieee80211_channel
*channel
,
6254 const u8
*ssid
, size_t ssid_len
,
6255 enum ieee80211_bss_type bss_type
,
6256 enum ieee80211_privacy privacy
);
6257 static inline struct cfg80211_bss
*
6258 cfg80211_get_ibss(struct wiphy
*wiphy
,
6259 struct ieee80211_channel
*channel
,
6260 const u8
*ssid
, size_t ssid_len
)
6262 return cfg80211_get_bss(wiphy
, channel
, NULL
, ssid
, ssid_len
,
6263 IEEE80211_BSS_TYPE_IBSS
,
6264 IEEE80211_PRIVACY_ANY
);
6268 * cfg80211_ref_bss - reference BSS struct
6269 * @wiphy: the wiphy this BSS struct belongs to
6270 * @bss: the BSS struct to reference
6272 * Increments the refcount of the given BSS struct.
6274 void cfg80211_ref_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
6277 * cfg80211_put_bss - unref BSS struct
6278 * @wiphy: the wiphy this BSS struct belongs to
6279 * @bss: the BSS struct
6281 * Decrements the refcount of the given BSS struct.
6283 void cfg80211_put_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
6286 * cfg80211_unlink_bss - unlink BSS from internal data structures
6288 * @bss: the bss to remove
6290 * This function removes the given BSS from the internal data structures
6291 * thereby making it no longer show up in scan results etc. Use this
6292 * function when you detect a BSS is gone. Normally BSSes will also time
6293 * out, so it is not necessary to use this function at all.
6295 void cfg80211_unlink_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
6298 * cfg80211_bss_iter - iterate all BSS entries
6300 * This function iterates over the BSS entries associated with the given wiphy
6301 * and calls the callback for the iterated BSS. The iterator function is not
6302 * allowed to call functions that might modify the internal state of the BSS DB.
6305 * @chandef: if given, the iterator function will be called only if the channel
6306 * of the currently iterated BSS is a subset of the given channel.
6307 * @iter: the iterator function to call
6308 * @iter_data: an argument to the iterator function
6310 void cfg80211_bss_iter(struct wiphy
*wiphy
,
6311 struct cfg80211_chan_def
*chandef
,
6312 void (*iter
)(struct wiphy
*wiphy
,
6313 struct cfg80211_bss
*bss
,
6317 static inline enum nl80211_bss_scan_width
6318 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def
*chandef
)
6320 switch (chandef
->width
) {
6321 case NL80211_CHAN_WIDTH_5
:
6322 return NL80211_BSS_CHAN_WIDTH_5
;
6323 case NL80211_CHAN_WIDTH_10
:
6324 return NL80211_BSS_CHAN_WIDTH_10
;
6326 return NL80211_BSS_CHAN_WIDTH_20
;
6331 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6332 * @dev: network device
6333 * @buf: authentication frame (header + body)
6334 * @len: length of the frame data
6336 * This function is called whenever an authentication, disassociation or
6337 * deauthentication frame has been received and processed in station mode.
6338 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6339 * call either this function or cfg80211_auth_timeout().
6340 * After being asked to associate via cfg80211_ops::assoc() the driver must
6341 * call either this function or cfg80211_auth_timeout().
6342 * While connected, the driver must calls this for received and processed
6343 * disassociation and deauthentication frames. If the frame couldn't be used
6344 * because it was unprotected, the driver must call the function
6345 * cfg80211_rx_unprot_mlme_mgmt() instead.
6347 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6349 void cfg80211_rx_mlme_mgmt(struct net_device
*dev
, const u8
*buf
, size_t len
);
6352 * cfg80211_auth_timeout - notification of timed out authentication
6353 * @dev: network device
6354 * @addr: The MAC address of the device with which the authentication timed out
6356 * This function may sleep. The caller must hold the corresponding wdev's
6359 void cfg80211_auth_timeout(struct net_device
*dev
, const u8
*addr
);
6362 * cfg80211_rx_assoc_resp - notification of processed association response
6363 * @dev: network device
6364 * @bss: the BSS that association was requested with, ownership of the pointer
6365 * moves to cfg80211 in this call
6366 * @buf: (Re)Association Response frame (header + body)
6367 * @len: length of the frame data
6368 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6369 * as the AC bitmap in the QoS info field
6370 * @req_ies: information elements from the (Re)Association Request frame
6371 * @req_ies_len: length of req_ies data
6373 * After being asked to associate via cfg80211_ops::assoc() the driver must
6374 * call either this function or cfg80211_auth_timeout().
6376 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6378 void cfg80211_rx_assoc_resp(struct net_device
*dev
,
6379 struct cfg80211_bss
*bss
,
6380 const u8
*buf
, size_t len
,
6382 const u8
*req_ies
, size_t req_ies_len
);
6385 * cfg80211_assoc_timeout - notification of timed out association
6386 * @dev: network device
6387 * @bss: The BSS entry with which association timed out.
6389 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6391 void cfg80211_assoc_timeout(struct net_device
*dev
, struct cfg80211_bss
*bss
);
6394 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6395 * @dev: network device
6396 * @bss: The BSS entry with which association was abandoned.
6398 * Call this whenever - for reasons reported through other API, like deauth RX,
6399 * an association attempt was abandoned.
6400 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6402 void cfg80211_abandon_assoc(struct net_device
*dev
, struct cfg80211_bss
*bss
);
6405 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6406 * @dev: network device
6407 * @buf: 802.11 frame (header + body)
6408 * @len: length of the frame data
6410 * This function is called whenever deauthentication has been processed in
6411 * station mode. This includes both received deauthentication frames and
6412 * locally generated ones. This function may sleep. The caller must hold the
6413 * corresponding wdev's mutex.
6415 void cfg80211_tx_mlme_mgmt(struct net_device
*dev
, const u8
*buf
, size_t len
);
6418 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6419 * @dev: network device
6420 * @buf: received management frame (header + body)
6421 * @len: length of the frame data
6423 * This function is called whenever a received deauthentication or dissassoc
6424 * frame has been dropped in station mode because of MFP being used but the
6425 * frame was not protected. This is also used to notify reception of a Beacon
6426 * frame that was dropped because it did not include a valid MME MIC while
6427 * beacon protection was enabled (BIGTK configured in station mode).
6429 * This function may sleep.
6431 void cfg80211_rx_unprot_mlme_mgmt(struct net_device
*dev
,
6432 const u8
*buf
, size_t len
);
6435 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6436 * @dev: network device
6437 * @addr: The source MAC address of the frame
6438 * @key_type: The key type that the received frame used
6439 * @key_id: Key identifier (0..3). Can be -1 if missing.
6440 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6441 * @gfp: allocation flags
6443 * This function is called whenever the local MAC detects a MIC failure in a
6444 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6447 void cfg80211_michael_mic_failure(struct net_device
*dev
, const u8
*addr
,
6448 enum nl80211_key_type key_type
, int key_id
,
6449 const u8
*tsc
, gfp_t gfp
);
6452 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6454 * @dev: network device
6455 * @bssid: the BSSID of the IBSS joined
6456 * @channel: the channel of the IBSS joined
6457 * @gfp: allocation flags
6459 * This function notifies cfg80211 that the device joined an IBSS or
6460 * switched to a different BSSID. Before this function can be called,
6461 * either a beacon has to have been received from the IBSS, or one of
6462 * the cfg80211_inform_bss{,_frame} functions must have been called
6463 * with the locally generated beacon -- this guarantees that there is
6464 * always a scan result for this IBSS. cfg80211 will handle the rest.
6466 void cfg80211_ibss_joined(struct net_device
*dev
, const u8
*bssid
,
6467 struct ieee80211_channel
*channel
, gfp_t gfp
);
6470 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
6473 * @dev: network device
6474 * @macaddr: the MAC address of the new candidate
6475 * @ie: information elements advertised by the peer candidate
6476 * @ie_len: length of the information elements buffer
6477 * @gfp: allocation flags
6479 * This function notifies cfg80211 that the mesh peer candidate has been
6480 * detected, most likely via a beacon or, less likely, via a probe response.
6481 * cfg80211 then sends a notification to userspace.
6483 void cfg80211_notify_new_peer_candidate(struct net_device
*dev
,
6484 const u8
*macaddr
, const u8
*ie
, u8 ie_len
,
6485 int sig_dbm
, gfp_t gfp
);
6488 * DOC: RFkill integration
6490 * RFkill integration in cfg80211 is almost invisible to drivers,
6491 * as cfg80211 automatically registers an rfkill instance for each
6492 * wireless device it knows about. Soft kill is also translated
6493 * into disconnecting and turning all interfaces off, drivers are
6494 * expected to turn off the device when all interfaces are down.
6496 * However, devices may have a hard RFkill line, in which case they
6497 * also need to interact with the rfkill subsystem, via cfg80211.
6498 * They can do this with a few helper functions documented here.
6502 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6504 * @blocked: block status
6506 void wiphy_rfkill_set_hw_state(struct wiphy
*wiphy
, bool blocked
);
6509 * wiphy_rfkill_start_polling - start polling rfkill
6512 void wiphy_rfkill_start_polling(struct wiphy
*wiphy
);
6515 * wiphy_rfkill_stop_polling - stop polling rfkill
6518 void wiphy_rfkill_stop_polling(struct wiphy
*wiphy
);
6521 * DOC: Vendor commands
6523 * Occasionally, there are special protocol or firmware features that
6524 * can't be implemented very openly. For this and similar cases, the
6525 * vendor command functionality allows implementing the features with
6526 * (typically closed-source) userspace and firmware, using nl80211 as
6527 * the configuration mechanism.
6529 * A driver supporting vendor commands must register them as an array
6530 * in struct wiphy, with handlers for each one, each command has an
6531 * OUI and sub command ID to identify it.
6533 * Note that this feature should not be (ab)used to implement protocol
6534 * features that could openly be shared across drivers. In particular,
6535 * it must never be required to use vendor commands to implement any
6536 * "normal" functionality that higher-level userspace like connection
6537 * managers etc. need.
6540 struct sk_buff
*__cfg80211_alloc_reply_skb(struct wiphy
*wiphy
,
6541 enum nl80211_commands cmd
,
6542 enum nl80211_attrs attr
,
6545 struct sk_buff
*__cfg80211_alloc_event_skb(struct wiphy
*wiphy
,
6546 struct wireless_dev
*wdev
,
6547 enum nl80211_commands cmd
,
6548 enum nl80211_attrs attr
,
6549 unsigned int portid
,
6550 int vendor_event_idx
,
6551 int approxlen
, gfp_t gfp
);
6553 void __cfg80211_send_event_skb(struct sk_buff
*skb
, gfp_t gfp
);
6556 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6558 * @approxlen: an upper bound of the length of the data that will
6559 * be put into the skb
6561 * This function allocates and pre-fills an skb for a reply to
6562 * a vendor command. Since it is intended for a reply, calling
6563 * it outside of a vendor command's doit() operation is invalid.
6565 * The returned skb is pre-filled with some identifying data in
6566 * a way that any data that is put into the skb (with skb_put(),
6567 * nla_put() or similar) will end up being within the
6568 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6569 * with the skb is adding data for the corresponding userspace tool
6570 * which can then read that data out of the vendor data attribute.
6571 * You must not modify the skb in any other way.
6573 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6574 * its error code as the result of the doit() operation.
6576 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6578 static inline struct sk_buff
*
6579 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy
*wiphy
, int approxlen
)
6581 return __cfg80211_alloc_reply_skb(wiphy
, NL80211_CMD_VENDOR
,
6582 NL80211_ATTR_VENDOR_DATA
, approxlen
);
6586 * cfg80211_vendor_cmd_reply - send the reply skb
6587 * @skb: The skb, must have been allocated with
6588 * cfg80211_vendor_cmd_alloc_reply_skb()
6590 * Since calling this function will usually be the last thing
6591 * before returning from the vendor command doit() you should
6592 * return the error code. Note that this function consumes the
6593 * skb regardless of the return value.
6595 * Return: An error code or 0 on success.
6597 int cfg80211_vendor_cmd_reply(struct sk_buff
*skb
);
6600 * cfg80211_vendor_cmd_get_sender
6603 * Return the current netlink port ID in a vendor command handler.
6604 * Valid to call only there.
6606 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy
*wiphy
);
6609 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6611 * @wdev: the wireless device
6612 * @event_idx: index of the vendor event in the wiphy's vendor_events
6613 * @approxlen: an upper bound of the length of the data that will
6614 * be put into the skb
6615 * @gfp: allocation flags
6617 * This function allocates and pre-fills an skb for an event on the
6618 * vendor-specific multicast group.
6620 * If wdev != NULL, both the ifindex and identifier of the specified
6621 * wireless device are added to the event message before the vendor data
6624 * When done filling the skb, call cfg80211_vendor_event() with the
6625 * skb to send the event.
6627 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6629 static inline struct sk_buff
*
6630 cfg80211_vendor_event_alloc(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
6631 int approxlen
, int event_idx
, gfp_t gfp
)
6633 return __cfg80211_alloc_event_skb(wiphy
, wdev
, NL80211_CMD_VENDOR
,
6634 NL80211_ATTR_VENDOR_DATA
,
6635 0, event_idx
, approxlen
, gfp
);
6639 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6641 * @wdev: the wireless device
6642 * @event_idx: index of the vendor event in the wiphy's vendor_events
6643 * @portid: port ID of the receiver
6644 * @approxlen: an upper bound of the length of the data that will
6645 * be put into the skb
6646 * @gfp: allocation flags
6648 * This function allocates and pre-fills an skb for an event to send to
6649 * a specific (userland) socket. This socket would previously have been
6650 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6651 * care to register a netlink notifier to see when the socket closes.
6653 * If wdev != NULL, both the ifindex and identifier of the specified
6654 * wireless device are added to the event message before the vendor data
6657 * When done filling the skb, call cfg80211_vendor_event() with the
6658 * skb to send the event.
6660 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6662 static inline struct sk_buff
*
6663 cfg80211_vendor_event_alloc_ucast(struct wiphy
*wiphy
,
6664 struct wireless_dev
*wdev
,
6665 unsigned int portid
, int approxlen
,
6666 int event_idx
, gfp_t gfp
)
6668 return __cfg80211_alloc_event_skb(wiphy
, wdev
, NL80211_CMD_VENDOR
,
6669 NL80211_ATTR_VENDOR_DATA
,
6670 portid
, event_idx
, approxlen
, gfp
);
6674 * cfg80211_vendor_event - send the event
6675 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6676 * @gfp: allocation flags
6678 * This function sends the given @skb, which must have been allocated
6679 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6681 static inline void cfg80211_vendor_event(struct sk_buff
*skb
, gfp_t gfp
)
6683 __cfg80211_send_event_skb(skb
, gfp
);
6686 #ifdef CONFIG_NL80211_TESTMODE
6690 * Test mode is a set of utility functions to allow drivers to
6691 * interact with driver-specific tools to aid, for instance,
6692 * factory programming.
6694 * This chapter describes how drivers interact with it, for more
6695 * information see the nl80211 book's chapter on it.
6699 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6701 * @approxlen: an upper bound of the length of the data that will
6702 * be put into the skb
6704 * This function allocates and pre-fills an skb for a reply to
6705 * the testmode command. Since it is intended for a reply, calling
6706 * it outside of the @testmode_cmd operation is invalid.
6708 * The returned skb is pre-filled with the wiphy index and set up in
6709 * a way that any data that is put into the skb (with skb_put(),
6710 * nla_put() or similar) will end up being within the
6711 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6712 * with the skb is adding data for the corresponding userspace tool
6713 * which can then read that data out of the testdata attribute. You
6714 * must not modify the skb in any other way.
6716 * When done, call cfg80211_testmode_reply() with the skb and return
6717 * its error code as the result of the @testmode_cmd operation.
6719 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6721 static inline struct sk_buff
*
6722 cfg80211_testmode_alloc_reply_skb(struct wiphy
*wiphy
, int approxlen
)
6724 return __cfg80211_alloc_reply_skb(wiphy
, NL80211_CMD_TESTMODE
,
6725 NL80211_ATTR_TESTDATA
, approxlen
);
6729 * cfg80211_testmode_reply - send the reply skb
6730 * @skb: The skb, must have been allocated with
6731 * cfg80211_testmode_alloc_reply_skb()
6733 * Since calling this function will usually be the last thing
6734 * before returning from the @testmode_cmd you should return
6735 * the error code. Note that this function consumes the skb
6736 * regardless of the return value.
6738 * Return: An error code or 0 on success.
6740 static inline int cfg80211_testmode_reply(struct sk_buff
*skb
)
6742 return cfg80211_vendor_cmd_reply(skb
);
6746 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6748 * @approxlen: an upper bound of the length of the data that will
6749 * be put into the skb
6750 * @gfp: allocation flags
6752 * This function allocates and pre-fills an skb for an event on the
6753 * testmode multicast group.
6755 * The returned skb is set up in the same way as with
6756 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6757 * there, you should simply add data to it that will then end up in the
6758 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6761 * When done filling the skb, call cfg80211_testmode_event() with the
6762 * skb to send the event.
6764 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6766 static inline struct sk_buff
*
6767 cfg80211_testmode_alloc_event_skb(struct wiphy
*wiphy
, int approxlen
, gfp_t gfp
)
6769 return __cfg80211_alloc_event_skb(wiphy
, NULL
, NL80211_CMD_TESTMODE
,
6770 NL80211_ATTR_TESTDATA
, 0, -1,
6775 * cfg80211_testmode_event - send the event
6776 * @skb: The skb, must have been allocated with
6777 * cfg80211_testmode_alloc_event_skb()
6778 * @gfp: allocation flags
6780 * This function sends the given @skb, which must have been allocated
6781 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6784 static inline void cfg80211_testmode_event(struct sk_buff
*skb
, gfp_t gfp
)
6786 __cfg80211_send_event_skb(skb
, gfp
);
6789 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6790 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6792 #define CFG80211_TESTMODE_CMD(cmd)
6793 #define CFG80211_TESTMODE_DUMP(cmd)
6797 * struct cfg80211_fils_resp_params - FILS connection response params
6798 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6799 * @kek_len: Length of @fils_kek in octets
6800 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6801 * @erp_next_seq_num is valid.
6802 * @erp_next_seq_num: The next sequence number to use in ERP message in
6803 * FILS Authentication. This value should be specified irrespective of the
6804 * status for a FILS connection.
6805 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6806 * @pmk_len: Length of @pmk in octets
6807 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6808 * used for this FILS connection (may be %NULL).
6810 struct cfg80211_fils_resp_params
{
6813 bool update_erp_next_seq_num
;
6814 u16 erp_next_seq_num
;
6821 * struct cfg80211_connect_resp_params - Connection response params
6822 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6823 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6824 * the real status code for failures. If this call is used to report a
6825 * failure due to a timeout (e.g., not receiving an Authentication frame
6826 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6827 * indicate that this is a failure, but without a status code.
6828 * @timeout_reason is used to report the reason for the timeout in that
6830 * @bssid: The BSSID of the AP (may be %NULL)
6831 * @bss: Entry of bss to which STA got connected to, can be obtained through
6832 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6833 * bss from the connect_request and hold a reference to it and return
6834 * through this param to avoid a warning if the bss is expired during the
6835 * connection, esp. for those drivers implementing connect op.
6836 * Only one parameter among @bssid and @bss needs to be specified.
6837 * @req_ie: Association request IEs (may be %NULL)
6838 * @req_ie_len: Association request IEs length
6839 * @resp_ie: Association response IEs (may be %NULL)
6840 * @resp_ie_len: Association response IEs length
6841 * @fils: FILS connection response parameters.
6842 * @timeout_reason: Reason for connection timeout. This is used when the
6843 * connection fails due to a timeout instead of an explicit rejection from
6844 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6845 * not known. This value is used only if @status < 0 to indicate that the
6846 * failure is due to a timeout and not due to explicit rejection by the AP.
6847 * This value is ignored in other cases (@status >= 0).
6849 struct cfg80211_connect_resp_params
{
6852 struct cfg80211_bss
*bss
;
6857 struct cfg80211_fils_resp_params fils
;
6858 enum nl80211_timeout_reason timeout_reason
;
6862 * cfg80211_connect_done - notify cfg80211 of connection result
6864 * @dev: network device
6865 * @params: connection response parameters
6866 * @gfp: allocation flags
6868 * It should be called by the underlying driver once execution of the connection
6869 * request from connect() has been completed. This is similar to
6870 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6871 * parameters. Only one of the functions among cfg80211_connect_bss(),
6872 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6873 * and cfg80211_connect_done() should be called.
6875 void cfg80211_connect_done(struct net_device
*dev
,
6876 struct cfg80211_connect_resp_params
*params
,
6880 * cfg80211_connect_bss - notify cfg80211 of connection result
6882 * @dev: network device
6883 * @bssid: the BSSID of the AP
6884 * @bss: Entry of bss to which STA got connected to, can be obtained through
6885 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6886 * bss from the connect_request and hold a reference to it and return
6887 * through this param to avoid a warning if the bss is expired during the
6888 * connection, esp. for those drivers implementing connect op.
6889 * Only one parameter among @bssid and @bss needs to be specified.
6890 * @req_ie: association request IEs (maybe be %NULL)
6891 * @req_ie_len: association request IEs length
6892 * @resp_ie: association response IEs (may be %NULL)
6893 * @resp_ie_len: assoc response IEs length
6894 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6895 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6896 * the real status code for failures. If this call is used to report a
6897 * failure due to a timeout (e.g., not receiving an Authentication frame
6898 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6899 * indicate that this is a failure, but without a status code.
6900 * @timeout_reason is used to report the reason for the timeout in that
6902 * @gfp: allocation flags
6903 * @timeout_reason: reason for connection timeout. This is used when the
6904 * connection fails due to a timeout instead of an explicit rejection from
6905 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6906 * not known. This value is used only if @status < 0 to indicate that the
6907 * failure is due to a timeout and not due to explicit rejection by the AP.
6908 * This value is ignored in other cases (@status >= 0).
6910 * It should be called by the underlying driver once execution of the connection
6911 * request from connect() has been completed. This is similar to
6912 * cfg80211_connect_result(), but with the option of identifying the exact bss
6913 * entry for the connection. Only one of the functions among
6914 * cfg80211_connect_bss(), cfg80211_connect_result(),
6915 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6918 cfg80211_connect_bss(struct net_device
*dev
, const u8
*bssid
,
6919 struct cfg80211_bss
*bss
, const u8
*req_ie
,
6920 size_t req_ie_len
, const u8
*resp_ie
,
6921 size_t resp_ie_len
, int status
, gfp_t gfp
,
6922 enum nl80211_timeout_reason timeout_reason
)
6924 struct cfg80211_connect_resp_params params
;
6926 memset(¶ms
, 0, sizeof(params
));
6927 params
.status
= status
;
6928 params
.bssid
= bssid
;
6930 params
.req_ie
= req_ie
;
6931 params
.req_ie_len
= req_ie_len
;
6932 params
.resp_ie
= resp_ie
;
6933 params
.resp_ie_len
= resp_ie_len
;
6934 params
.timeout_reason
= timeout_reason
;
6936 cfg80211_connect_done(dev
, ¶ms
, gfp
);
6940 * cfg80211_connect_result - notify cfg80211 of connection result
6942 * @dev: network device
6943 * @bssid: the BSSID of the AP
6944 * @req_ie: association request IEs (maybe be %NULL)
6945 * @req_ie_len: association request IEs length
6946 * @resp_ie: association response IEs (may be %NULL)
6947 * @resp_ie_len: assoc response IEs length
6948 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6949 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6950 * the real status code for failures.
6951 * @gfp: allocation flags
6953 * It should be called by the underlying driver once execution of the connection
6954 * request from connect() has been completed. This is similar to
6955 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6956 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6957 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6960 cfg80211_connect_result(struct net_device
*dev
, const u8
*bssid
,
6961 const u8
*req_ie
, size_t req_ie_len
,
6962 const u8
*resp_ie
, size_t resp_ie_len
,
6963 u16 status
, gfp_t gfp
)
6965 cfg80211_connect_bss(dev
, bssid
, NULL
, req_ie
, req_ie_len
, resp_ie
,
6966 resp_ie_len
, status
, gfp
,
6967 NL80211_TIMEOUT_UNSPECIFIED
);
6971 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6973 * @dev: network device
6974 * @bssid: the BSSID of the AP
6975 * @req_ie: association request IEs (maybe be %NULL)
6976 * @req_ie_len: association request IEs length
6977 * @gfp: allocation flags
6978 * @timeout_reason: reason for connection timeout.
6980 * It should be called by the underlying driver whenever connect() has failed
6981 * in a sequence where no explicit authentication/association rejection was
6982 * received from the AP. This could happen, e.g., due to not being able to send
6983 * out the Authentication or Association Request frame or timing out while
6984 * waiting for the response. Only one of the functions among
6985 * cfg80211_connect_bss(), cfg80211_connect_result(),
6986 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6989 cfg80211_connect_timeout(struct net_device
*dev
, const u8
*bssid
,
6990 const u8
*req_ie
, size_t req_ie_len
, gfp_t gfp
,
6991 enum nl80211_timeout_reason timeout_reason
)
6993 cfg80211_connect_bss(dev
, bssid
, NULL
, req_ie
, req_ie_len
, NULL
, 0, -1,
6994 gfp
, timeout_reason
);
6998 * struct cfg80211_roam_info - driver initiated roaming information
7000 * @channel: the channel of the new AP
7001 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
7002 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
7003 * @req_ie: association request IEs (maybe be %NULL)
7004 * @req_ie_len: association request IEs length
7005 * @resp_ie: association response IEs (may be %NULL)
7006 * @resp_ie_len: assoc response IEs length
7007 * @fils: FILS related roaming information.
7009 struct cfg80211_roam_info
{
7010 struct ieee80211_channel
*channel
;
7011 struct cfg80211_bss
*bss
;
7017 struct cfg80211_fils_resp_params fils
;
7021 * cfg80211_roamed - notify cfg80211 of roaming
7023 * @dev: network device
7024 * @info: information about the new BSS. struct &cfg80211_roam_info.
7025 * @gfp: allocation flags
7027 * This function may be called with the driver passing either the BSSID of the
7028 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7029 * It should be called by the underlying driver whenever it roamed from one AP
7030 * to another while connected. Drivers which have roaming implemented in
7031 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7032 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7033 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7034 * rdev->event_work. In case of any failures, the reference is released
7035 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7036 * released while disconnecting from the current bss.
7038 void cfg80211_roamed(struct net_device
*dev
, struct cfg80211_roam_info
*info
,
7042 * cfg80211_port_authorized - notify cfg80211 of successful security association
7044 * @dev: network device
7045 * @bssid: the BSSID of the AP
7046 * @gfp: allocation flags
7048 * This function should be called by a driver that supports 4 way handshake
7049 * offload after a security association was successfully established (i.e.,
7050 * the 4 way handshake was completed successfully). The call to this function
7051 * should be preceded with a call to cfg80211_connect_result(),
7052 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7053 * indicate the 802.11 association.
7055 void cfg80211_port_authorized(struct net_device
*dev
, const u8
*bssid
,
7059 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7061 * @dev: network device
7062 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7063 * @ie_len: length of IEs
7064 * @reason: reason code for the disconnection, set it to 0 if unknown
7065 * @locally_generated: disconnection was requested locally
7066 * @gfp: allocation flags
7068 * After it calls this function, the driver should enter an idle state
7069 * and not try to connect to any AP any more.
7071 void cfg80211_disconnected(struct net_device
*dev
, u16 reason
,
7072 const u8
*ie
, size_t ie_len
,
7073 bool locally_generated
, gfp_t gfp
);
7076 * cfg80211_ready_on_channel - notification of remain_on_channel start
7077 * @wdev: wireless device
7078 * @cookie: the request cookie
7079 * @chan: The current channel (from remain_on_channel request)
7080 * @duration: Duration in milliseconds that the driver intents to remain on the
7082 * @gfp: allocation flags
7084 void cfg80211_ready_on_channel(struct wireless_dev
*wdev
, u64 cookie
,
7085 struct ieee80211_channel
*chan
,
7086 unsigned int duration
, gfp_t gfp
);
7089 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7090 * @wdev: wireless device
7091 * @cookie: the request cookie
7092 * @chan: The current channel (from remain_on_channel request)
7093 * @gfp: allocation flags
7095 void cfg80211_remain_on_channel_expired(struct wireless_dev
*wdev
, u64 cookie
,
7096 struct ieee80211_channel
*chan
,
7100 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7101 * @wdev: wireless device
7102 * @cookie: the requested cookie
7103 * @chan: The current channel (from tx_mgmt request)
7104 * @gfp: allocation flags
7106 void cfg80211_tx_mgmt_expired(struct wireless_dev
*wdev
, u64 cookie
,
7107 struct ieee80211_channel
*chan
, gfp_t gfp
);
7110 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7112 * @sinfo: the station information
7113 * @gfp: allocation flags
7115 int cfg80211_sinfo_alloc_tid_stats(struct station_info
*sinfo
, gfp_t gfp
);
7118 * cfg80211_sinfo_release_content - release contents of station info
7119 * @sinfo: the station information
7121 * Releases any potentially allocated sub-information of the station
7122 * information, but not the struct itself (since it's typically on
7125 static inline void cfg80211_sinfo_release_content(struct station_info
*sinfo
)
7127 kfree(sinfo
->pertid
);
7131 * cfg80211_new_sta - notify userspace about station
7134 * @mac_addr: the station's address
7135 * @sinfo: the station information
7136 * @gfp: allocation flags
7138 void cfg80211_new_sta(struct net_device
*dev
, const u8
*mac_addr
,
7139 struct station_info
*sinfo
, gfp_t gfp
);
7142 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7144 * @mac_addr: the station's address
7145 * @sinfo: the station information/statistics
7146 * @gfp: allocation flags
7148 void cfg80211_del_sta_sinfo(struct net_device
*dev
, const u8
*mac_addr
,
7149 struct station_info
*sinfo
, gfp_t gfp
);
7152 * cfg80211_del_sta - notify userspace about deletion of a station
7155 * @mac_addr: the station's address
7156 * @gfp: allocation flags
7158 static inline void cfg80211_del_sta(struct net_device
*dev
,
7159 const u8
*mac_addr
, gfp_t gfp
)
7161 cfg80211_del_sta_sinfo(dev
, mac_addr
, NULL
, gfp
);
7165 * cfg80211_conn_failed - connection request failed notification
7168 * @mac_addr: the station's address
7169 * @reason: the reason for connection failure
7170 * @gfp: allocation flags
7172 * Whenever a station tries to connect to an AP and if the station
7173 * could not connect to the AP as the AP has rejected the connection
7174 * for some reasons, this function is called.
7176 * The reason for connection failure can be any of the value from
7177 * nl80211_connect_failed_reason enum
7179 void cfg80211_conn_failed(struct net_device
*dev
, const u8
*mac_addr
,
7180 enum nl80211_connect_failed_reason reason
,
7184 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7185 * @wdev: wireless device receiving the frame
7186 * @freq: Frequency on which the frame was received in KHz
7187 * @sig_dbm: signal strength in dBm, or 0 if unknown
7188 * @buf: Management frame (header + body)
7189 * @len: length of the frame data
7190 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7192 * This function is called whenever an Action frame is received for a station
7193 * mode interface, but is not processed in kernel.
7195 * Return: %true if a user space application has registered for this frame.
7196 * For action frames, that makes it responsible for rejecting unrecognized
7197 * action frames; %false otherwise, in which case for action frames the
7198 * driver is responsible for rejecting the frame.
7200 bool cfg80211_rx_mgmt_khz(struct wireless_dev
*wdev
, int freq
, int sig_dbm
,
7201 const u8
*buf
, size_t len
, u32 flags
);
7204 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7205 * @wdev: wireless device receiving the frame
7206 * @freq: Frequency on which the frame was received in MHz
7207 * @sig_dbm: signal strength in dBm, or 0 if unknown
7208 * @buf: Management frame (header + body)
7209 * @len: length of the frame data
7210 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7212 * This function is called whenever an Action frame is received for a station
7213 * mode interface, but is not processed in kernel.
7215 * Return: %true if a user space application has registered for this frame.
7216 * For action frames, that makes it responsible for rejecting unrecognized
7217 * action frames; %false otherwise, in which case for action frames the
7218 * driver is responsible for rejecting the frame.
7220 static inline bool cfg80211_rx_mgmt(struct wireless_dev
*wdev
, int freq
,
7221 int sig_dbm
, const u8
*buf
, size_t len
,
7224 return cfg80211_rx_mgmt_khz(wdev
, MHZ_TO_KHZ(freq
), sig_dbm
, buf
, len
,
7229 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7230 * @wdev: wireless device receiving the frame
7231 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7232 * @buf: Management frame (header + body)
7233 * @len: length of the frame data
7234 * @ack: Whether frame was acknowledged
7235 * @gfp: context flags
7237 * This function is called whenever a management frame was requested to be
7238 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7239 * transmission attempt.
7241 void cfg80211_mgmt_tx_status(struct wireless_dev
*wdev
, u64 cookie
,
7242 const u8
*buf
, size_t len
, bool ack
, gfp_t gfp
);
7245 * cfg80211_control_port_tx_status - notification of TX status for control
7247 * @wdev: wireless device receiving the frame
7248 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7249 * @buf: Data frame (header + body)
7250 * @len: length of the frame data
7251 * @ack: Whether frame was acknowledged
7252 * @gfp: context flags
7254 * This function is called whenever a control port frame was requested to be
7255 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7256 * the transmission attempt.
7258 void cfg80211_control_port_tx_status(struct wireless_dev
*wdev
, u64 cookie
,
7259 const u8
*buf
, size_t len
, bool ack
,
7263 * cfg80211_rx_control_port - notification about a received control port frame
7264 * @dev: The device the frame matched to
7265 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7266 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7267 * This function does not take ownership of the skb, so the caller is
7268 * responsible for any cleanup. The caller must also ensure that
7269 * skb->protocol is set appropriately.
7270 * @unencrypted: Whether the frame was received unencrypted
7272 * This function is used to inform userspace about a received control port
7273 * frame. It should only be used if userspace indicated it wants to receive
7274 * control port frames over nl80211.
7276 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7277 * network layer headers removed (e.g. the raw EAPoL frame).
7279 * Return: %true if the frame was passed to userspace
7281 bool cfg80211_rx_control_port(struct net_device
*dev
,
7282 struct sk_buff
*skb
, bool unencrypted
);
7285 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
7286 * @dev: network device
7287 * @rssi_event: the triggered RSSI event
7288 * @rssi_level: new RSSI level value or 0 if not available
7289 * @gfp: context flags
7291 * This function is called when a configured connection quality monitoring
7292 * rssi threshold reached event occurs.
7294 void cfg80211_cqm_rssi_notify(struct net_device
*dev
,
7295 enum nl80211_cqm_rssi_threshold_event rssi_event
,
7296 s32 rssi_level
, gfp_t gfp
);
7299 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
7300 * @dev: network device
7301 * @peer: peer's MAC address
7302 * @num_packets: how many packets were lost -- should be a fixed threshold
7303 * but probably no less than maybe 50, or maybe a throughput dependent
7304 * threshold (to account for temporary interference)
7305 * @gfp: context flags
7307 void cfg80211_cqm_pktloss_notify(struct net_device
*dev
,
7308 const u8
*peer
, u32 num_packets
, gfp_t gfp
);
7311 * cfg80211_cqm_txe_notify - TX error rate event
7312 * @dev: network device
7313 * @peer: peer's MAC address
7314 * @num_packets: how many packets were lost
7315 * @rate: % of packets which failed transmission
7316 * @intvl: interval (in s) over which the TX failure threshold was breached.
7317 * @gfp: context flags
7319 * Notify userspace when configured % TX failures over number of packets in a
7320 * given interval is exceeded.
7322 void cfg80211_cqm_txe_notify(struct net_device
*dev
, const u8
*peer
,
7323 u32 num_packets
, u32 rate
, u32 intvl
, gfp_t gfp
);
7326 * cfg80211_cqm_beacon_loss_notify - beacon loss event
7327 * @dev: network device
7328 * @gfp: context flags
7330 * Notify userspace about beacon loss from the connected AP.
7332 void cfg80211_cqm_beacon_loss_notify(struct net_device
*dev
, gfp_t gfp
);
7335 * cfg80211_radar_event - radar detection event
7337 * @chandef: chandef for the current channel
7338 * @gfp: context flags
7340 * This function is called when a radar is detected on the current chanenl.
7342 void cfg80211_radar_event(struct wiphy
*wiphy
,
7343 struct cfg80211_chan_def
*chandef
, gfp_t gfp
);
7346 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
7347 * @dev: network device
7348 * @mac: MAC address of a station which opmode got modified
7349 * @sta_opmode: station's current opmode value
7350 * @gfp: context flags
7352 * Driver should call this function when station's opmode modified via action
7355 void cfg80211_sta_opmode_change_notify(struct net_device
*dev
, const u8
*mac
,
7356 struct sta_opmode_info
*sta_opmode
,
7360 * cfg80211_cac_event - Channel availability check (CAC) event
7361 * @netdev: network device
7362 * @chandef: chandef for the current channel
7363 * @event: type of event
7364 * @gfp: context flags
7366 * This function is called when a Channel availability check (CAC) is finished
7367 * or aborted. This must be called to notify the completion of a CAC process,
7368 * also by full-MAC drivers.
7370 void cfg80211_cac_event(struct net_device
*netdev
,
7371 const struct cfg80211_chan_def
*chandef
,
7372 enum nl80211_radar_event event
, gfp_t gfp
);
7376 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
7377 * @dev: network device
7378 * @bssid: BSSID of AP (to avoid races)
7379 * @replay_ctr: new replay counter
7380 * @gfp: allocation flags
7382 void cfg80211_gtk_rekey_notify(struct net_device
*dev
, const u8
*bssid
,
7383 const u8
*replay_ctr
, gfp_t gfp
);
7386 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7387 * @dev: network device
7388 * @index: candidate index (the smaller the index, the higher the priority)
7389 * @bssid: BSSID of AP
7390 * @preauth: Whether AP advertises support for RSN pre-authentication
7391 * @gfp: allocation flags
7393 void cfg80211_pmksa_candidate_notify(struct net_device
*dev
, int index
,
7394 const u8
*bssid
, bool preauth
, gfp_t gfp
);
7397 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7398 * @dev: The device the frame matched to
7399 * @addr: the transmitter address
7400 * @gfp: context flags
7402 * This function is used in AP mode (only!) to inform userspace that
7403 * a spurious class 3 frame was received, to be able to deauth the
7405 * Return: %true if the frame was passed to userspace (or this failed
7406 * for a reason other than not having a subscription.)
7408 bool cfg80211_rx_spurious_frame(struct net_device
*dev
,
7409 const u8
*addr
, gfp_t gfp
);
7412 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7413 * @dev: The device the frame matched to
7414 * @addr: the transmitter address
7415 * @gfp: context flags
7417 * This function is used in AP mode (only!) to inform userspace that
7418 * an associated station sent a 4addr frame but that wasn't expected.
7419 * It is allowed and desirable to send this event only once for each
7420 * station to avoid event flooding.
7421 * Return: %true if the frame was passed to userspace (or this failed
7422 * for a reason other than not having a subscription.)
7424 bool cfg80211_rx_unexpected_4addr_frame(struct net_device
*dev
,
7425 const u8
*addr
, gfp_t gfp
);
7428 * cfg80211_probe_status - notify userspace about probe status
7429 * @dev: the device the probe was sent on
7430 * @addr: the address of the peer
7431 * @cookie: the cookie filled in @probe_client previously
7432 * @acked: indicates whether probe was acked or not
7433 * @ack_signal: signal strength (in dBm) of the ACK frame.
7434 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7435 * @gfp: allocation flags
7437 void cfg80211_probe_status(struct net_device
*dev
, const u8
*addr
,
7438 u64 cookie
, bool acked
, s32 ack_signal
,
7439 bool is_valid_ack_signal
, gfp_t gfp
);
7442 * cfg80211_report_obss_beacon_khz - report beacon from other APs
7443 * @wiphy: The wiphy that received the beacon
7445 * @len: length of the frame
7446 * @freq: frequency the frame was received on in KHz
7447 * @sig_dbm: signal strength in dBm, or 0 if unknown
7449 * Use this function to report to userspace when a beacon was
7450 * received. It is not useful to call this when there is no
7451 * netdev that is in AP/GO mode.
7453 void cfg80211_report_obss_beacon_khz(struct wiphy
*wiphy
, const u8
*frame
,
7454 size_t len
, int freq
, int sig_dbm
);
7457 * cfg80211_report_obss_beacon - report beacon from other APs
7458 * @wiphy: The wiphy that received the beacon
7460 * @len: length of the frame
7461 * @freq: frequency the frame was received on
7462 * @sig_dbm: signal strength in dBm, or 0 if unknown
7464 * Use this function to report to userspace when a beacon was
7465 * received. It is not useful to call this when there is no
7466 * netdev that is in AP/GO mode.
7468 static inline void cfg80211_report_obss_beacon(struct wiphy
*wiphy
,
7469 const u8
*frame
, size_t len
,
7470 int freq
, int sig_dbm
)
7472 cfg80211_report_obss_beacon_khz(wiphy
, frame
, len
, MHZ_TO_KHZ(freq
),
7477 * cfg80211_reg_can_beacon - check if beaconing is allowed
7479 * @chandef: the channel definition
7480 * @iftype: interface type
7482 * Return: %true if there is no secondary channel or the secondary channel(s)
7483 * can be used for beaconing (i.e. is not a radar channel etc.)
7485 bool cfg80211_reg_can_beacon(struct wiphy
*wiphy
,
7486 struct cfg80211_chan_def
*chandef
,
7487 enum nl80211_iftype iftype
);
7490 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7492 * @chandef: the channel definition
7493 * @iftype: interface type
7495 * Return: %true if there is no secondary channel or the secondary channel(s)
7496 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7497 * also checks if IR-relaxation conditions apply, to allow beaconing under
7498 * more permissive conditions.
7500 * Requires the RTNL to be held.
7502 bool cfg80211_reg_can_beacon_relax(struct wiphy
*wiphy
,
7503 struct cfg80211_chan_def
*chandef
,
7504 enum nl80211_iftype iftype
);
7507 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7508 * @dev: the device which switched channels
7509 * @chandef: the new channel definition
7511 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7514 void cfg80211_ch_switch_notify(struct net_device
*dev
,
7515 struct cfg80211_chan_def
*chandef
);
7518 * cfg80211_ch_switch_started_notify - notify channel switch start
7519 * @dev: the device on which the channel switch started
7520 * @chandef: the future channel definition
7521 * @count: the number of TBTTs until the channel switch happens
7523 * Inform the userspace about the channel switch that has just
7524 * started, so that it can take appropriate actions (eg. starting
7525 * channel switch on other vifs), if necessary.
7527 void cfg80211_ch_switch_started_notify(struct net_device
*dev
,
7528 struct cfg80211_chan_def
*chandef
,
7532 * ieee80211_operating_class_to_band - convert operating class to band
7534 * @operating_class: the operating class to convert
7535 * @band: band pointer to fill
7537 * Returns %true if the conversion was successful, %false otherwise.
7539 bool ieee80211_operating_class_to_band(u8 operating_class
,
7540 enum nl80211_band
*band
);
7543 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7545 * @chandef: the chandef to convert
7546 * @op_class: a pointer to the resulting operating class
7548 * Returns %true if the conversion was successful, %false otherwise.
7550 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def
*chandef
,
7554 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
7556 * @chandef: the chandef to convert
7558 * Returns the center frequency of chandef (1st segment) in KHz.
7561 ieee80211_chandef_to_khz(const struct cfg80211_chan_def
*chandef
)
7563 return MHZ_TO_KHZ(chandef
->center_freq1
) + chandef
->freq1_offset
;
7567 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7568 * @dev: the device on which the operation is requested
7569 * @peer: the MAC address of the peer device
7570 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7571 * NL80211_TDLS_TEARDOWN)
7572 * @reason_code: the reason code for teardown request
7573 * @gfp: allocation flags
7575 * This function is used to request userspace to perform TDLS operation that
7576 * requires knowledge of keys, i.e., link setup or teardown when the AP
7577 * connection uses encryption. This is optional mechanism for the driver to use
7578 * if it can automatically determine when a TDLS link could be useful (e.g.,
7579 * based on traffic and signal strength for a peer).
7581 void cfg80211_tdls_oper_request(struct net_device
*dev
, const u8
*peer
,
7582 enum nl80211_tdls_operation oper
,
7583 u16 reason_code
, gfp_t gfp
);
7586 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7587 * @rate: given rate_info to calculate bitrate from
7589 * return 0 if MCS index >= 32
7591 u32
cfg80211_calculate_bitrate(struct rate_info
*rate
);
7594 * cfg80211_unregister_wdev - remove the given wdev
7595 * @wdev: struct wireless_dev to remove
7597 * Call this function only for wdevs that have no netdev assigned,
7598 * e.g. P2P Devices. It removes the device from the list so that
7599 * it can no longer be used. It is necessary to call this function
7600 * even when cfg80211 requests the removal of the interface by
7601 * calling the del_virtual_intf() callback. The function must also
7602 * be called when the driver wishes to unregister the wdev, e.g.
7603 * when the device is unbound from the driver.
7605 * Requires the RTNL to be held.
7607 void cfg80211_unregister_wdev(struct wireless_dev
*wdev
);
7610 * struct cfg80211_ft_event_params - FT Information Elements
7612 * @ies_len: length of the FT IE in bytes
7613 * @target_ap: target AP's MAC address
7615 * @ric_ies_len: length of the RIC IE in bytes
7617 struct cfg80211_ft_event_params
{
7620 const u8
*target_ap
;
7626 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7627 * @netdev: network device
7628 * @ft_event: IE information
7630 void cfg80211_ft_event(struct net_device
*netdev
,
7631 struct cfg80211_ft_event_params
*ft_event
);
7634 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7635 * @ies: the input IE buffer
7636 * @len: the input length
7637 * @attr: the attribute ID to find
7638 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7639 * if the function is only called to get the needed buffer size
7640 * @bufsize: size of the output buffer
7642 * The function finds a given P2P attribute in the (vendor) IEs and
7643 * copies its contents to the given buffer.
7645 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7646 * malformed or the attribute can't be found (respectively), or the
7647 * length of the found attribute (which can be zero).
7649 int cfg80211_get_p2p_attr(const u8
*ies
, unsigned int len
,
7650 enum ieee80211_p2p_attr_id attr
,
7651 u8
*buf
, unsigned int bufsize
);
7654 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7655 * @ies: the IE buffer
7656 * @ielen: the length of the IE buffer
7657 * @ids: an array with element IDs that are allowed before
7658 * the split. A WLAN_EID_EXTENSION value means that the next
7659 * EID in the list is a sub-element of the EXTENSION IE.
7660 * @n_ids: the size of the element ID array
7661 * @after_ric: array IE types that come after the RIC element
7662 * @n_after_ric: size of the @after_ric array
7663 * @offset: offset where to start splitting in the buffer
7665 * This function splits an IE buffer by updating the @offset
7666 * variable to point to the location where the buffer should be
7669 * It assumes that the given IE buffer is well-formed, this
7670 * has to be guaranteed by the caller!
7672 * It also assumes that the IEs in the buffer are ordered
7673 * correctly, if not the result of using this function will not
7674 * be ordered correctly either, i.e. it does no reordering.
7676 * The function returns the offset where the next part of the
7677 * buffer starts, which may be @ielen if the entire (remainder)
7678 * of the buffer should be used.
7680 size_t ieee80211_ie_split_ric(const u8
*ies
, size_t ielen
,
7681 const u8
*ids
, int n_ids
,
7682 const u8
*after_ric
, int n_after_ric
,
7686 * ieee80211_ie_split - split an IE buffer according to ordering
7687 * @ies: the IE buffer
7688 * @ielen: the length of the IE buffer
7689 * @ids: an array with element IDs that are allowed before
7690 * the split. A WLAN_EID_EXTENSION value means that the next
7691 * EID in the list is a sub-element of the EXTENSION IE.
7692 * @n_ids: the size of the element ID array
7693 * @offset: offset where to start splitting in the buffer
7695 * This function splits an IE buffer by updating the @offset
7696 * variable to point to the location where the buffer should be
7699 * It assumes that the given IE buffer is well-formed, this
7700 * has to be guaranteed by the caller!
7702 * It also assumes that the IEs in the buffer are ordered
7703 * correctly, if not the result of using this function will not
7704 * be ordered correctly either, i.e. it does no reordering.
7706 * The function returns the offset where the next part of the
7707 * buffer starts, which may be @ielen if the entire (remainder)
7708 * of the buffer should be used.
7710 static inline size_t ieee80211_ie_split(const u8
*ies
, size_t ielen
,
7711 const u8
*ids
, int n_ids
, size_t offset
)
7713 return ieee80211_ie_split_ric(ies
, ielen
, ids
, n_ids
, NULL
, 0, offset
);
7717 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7718 * @wdev: the wireless device reporting the wakeup
7719 * @wakeup: the wakeup report
7720 * @gfp: allocation flags
7722 * This function reports that the given device woke up. If it
7723 * caused the wakeup, report the reason(s), otherwise you may
7724 * pass %NULL as the @wakeup parameter to advertise that something
7725 * else caused the wakeup.
7727 void cfg80211_report_wowlan_wakeup(struct wireless_dev
*wdev
,
7728 struct cfg80211_wowlan_wakeup
*wakeup
,
7732 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7734 * @wdev: the wireless device for which critical protocol is stopped.
7735 * @gfp: allocation flags
7737 * This function can be called by the driver to indicate it has reverted
7738 * operation back to normal. One reason could be that the duration given
7739 * by .crit_proto_start() has expired.
7741 void cfg80211_crit_proto_stopped(struct wireless_dev
*wdev
, gfp_t gfp
);
7744 * ieee80211_get_num_supported_channels - get number of channels device has
7747 * Return: the number of channels supported by the device.
7749 unsigned int ieee80211_get_num_supported_channels(struct wiphy
*wiphy
);
7752 * cfg80211_check_combinations - check interface combinations
7755 * @params: the interface combinations parameter
7757 * This function can be called by the driver to check whether a
7758 * combination of interfaces and their types are allowed according to
7759 * the interface combinations.
7761 int cfg80211_check_combinations(struct wiphy
*wiphy
,
7762 struct iface_combination_params
*params
);
7765 * cfg80211_iter_combinations - iterate over matching combinations
7768 * @params: the interface combinations parameter
7769 * @iter: function to call for each matching combination
7770 * @data: pointer to pass to iter function
7772 * This function can be called by the driver to check what possible
7773 * combinations it fits in at a given moment, e.g. for channel switching
7776 int cfg80211_iter_combinations(struct wiphy
*wiphy
,
7777 struct iface_combination_params
*params
,
7778 void (*iter
)(const struct ieee80211_iface_combination
*c
,
7783 * cfg80211_stop_iface - trigger interface disconnection
7786 * @wdev: wireless device
7787 * @gfp: context flags
7789 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7792 * Note: This doesn't need any locks and is asynchronous.
7794 void cfg80211_stop_iface(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
7798 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7799 * @wiphy: the wiphy to shut down
7801 * This function shuts down all interfaces belonging to this wiphy by
7802 * calling dev_close() (and treating non-netdev interfaces as needed).
7803 * It shouldn't really be used unless there are some fatal device errors
7804 * that really can't be recovered in any other way.
7806 * Callers must hold the RTNL and be able to deal with callbacks into
7807 * the driver while the function is running.
7809 void cfg80211_shutdown_all_interfaces(struct wiphy
*wiphy
);
7812 * wiphy_ext_feature_set - set the extended feature flag
7814 * @wiphy: the wiphy to modify.
7815 * @ftidx: extended feature bit index.
7817 * The extended features are flagged in multiple bytes (see
7818 * &struct wiphy.@ext_features)
7820 static inline void wiphy_ext_feature_set(struct wiphy
*wiphy
,
7821 enum nl80211_ext_feature_index ftidx
)
7825 ft_byte
= &wiphy
->ext_features
[ftidx
/ 8];
7826 *ft_byte
|= BIT(ftidx
% 8);
7830 * wiphy_ext_feature_isset - check the extended feature flag
7832 * @wiphy: the wiphy to modify.
7833 * @ftidx: extended feature bit index.
7835 * The extended features are flagged in multiple bytes (see
7836 * &struct wiphy.@ext_features)
7839 wiphy_ext_feature_isset(struct wiphy
*wiphy
,
7840 enum nl80211_ext_feature_index ftidx
)
7844 ft_byte
= wiphy
->ext_features
[ftidx
/ 8];
7845 return (ft_byte
& BIT(ftidx
% 8)) != 0;
7849 * cfg80211_free_nan_func - free NAN function
7850 * @f: NAN function that should be freed
7852 * Frees all the NAN function and all it's allocated members.
7854 void cfg80211_free_nan_func(struct cfg80211_nan_func
*f
);
7857 * struct cfg80211_nan_match_params - NAN match parameters
7858 * @type: the type of the function that triggered a match. If it is
7859 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7860 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7862 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7863 * @inst_id: the local instance id
7864 * @peer_inst_id: the instance id of the peer's function
7865 * @addr: the MAC address of the peer
7866 * @info_len: the length of the &info
7867 * @info: the Service Specific Info from the peer (if any)
7868 * @cookie: unique identifier of the corresponding function
7870 struct cfg80211_nan_match_params
{
7871 enum nl80211_nan_function_type type
;
7881 * cfg80211_nan_match - report a match for a NAN function.
7882 * @wdev: the wireless device reporting the match
7883 * @match: match notification parameters
7884 * @gfp: allocation flags
7886 * This function reports that the a NAN function had a match. This
7887 * can be a subscribe that had a match or a solicited publish that
7888 * was sent. It can also be a follow up that was received.
7890 void cfg80211_nan_match(struct wireless_dev
*wdev
,
7891 struct cfg80211_nan_match_params
*match
, gfp_t gfp
);
7894 * cfg80211_nan_func_terminated - notify about NAN function termination.
7896 * @wdev: the wireless device reporting the match
7897 * @inst_id: the local instance id
7898 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7899 * @cookie: unique NAN function identifier
7900 * @gfp: allocation flags
7902 * This function reports that the a NAN function is terminated.
7904 void cfg80211_nan_func_terminated(struct wireless_dev
*wdev
,
7906 enum nl80211_nan_func_term_reason reason
,
7907 u64 cookie
, gfp_t gfp
);
7909 /* ethtool helper */
7910 void cfg80211_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
);
7913 * cfg80211_external_auth_request - userspace request for authentication
7914 * @netdev: network device
7915 * @params: External authentication parameters
7916 * @gfp: allocation flags
7917 * Returns: 0 on success, < 0 on error
7919 int cfg80211_external_auth_request(struct net_device
*netdev
,
7920 struct cfg80211_external_auth_params
*params
,
7924 * cfg80211_pmsr_report - report peer measurement result data
7925 * @wdev: the wireless device reporting the measurement
7926 * @req: the original measurement request
7927 * @result: the result data
7928 * @gfp: allocation flags
7930 void cfg80211_pmsr_report(struct wireless_dev
*wdev
,
7931 struct cfg80211_pmsr_request
*req
,
7932 struct cfg80211_pmsr_result
*result
,
7936 * cfg80211_pmsr_complete - report peer measurement completed
7937 * @wdev: the wireless device reporting the measurement
7938 * @req: the original measurement request
7939 * @gfp: allocation flags
7941 * Report that the entire measurement completed, after this
7942 * the request pointer will no longer be valid.
7944 void cfg80211_pmsr_complete(struct wireless_dev
*wdev
,
7945 struct cfg80211_pmsr_request
*req
,
7949 * cfg80211_iftype_allowed - check whether the interface can be allowed
7951 * @iftype: interface type
7952 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7953 * @check_swif: check iftype against software interfaces
7955 * Check whether the interface is allowed to operate; additionally, this API
7956 * can be used to check iftype against the software interfaces when
7957 * check_swif is '1'.
7959 bool cfg80211_iftype_allowed(struct wiphy
*wiphy
, enum nl80211_iftype iftype
,
7960 bool is_4addr
, u8 check_swif
);
7963 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7965 /* wiphy_printk helpers, similar to dev_printk */
7967 #define wiphy_printk(level, wiphy, format, args...) \
7968 dev_printk(level, &(wiphy)->dev, format, ##args)
7969 #define wiphy_emerg(wiphy, format, args...) \
7970 dev_emerg(&(wiphy)->dev, format, ##args)
7971 #define wiphy_alert(wiphy, format, args...) \
7972 dev_alert(&(wiphy)->dev, format, ##args)
7973 #define wiphy_crit(wiphy, format, args...) \
7974 dev_crit(&(wiphy)->dev, format, ##args)
7975 #define wiphy_err(wiphy, format, args...) \
7976 dev_err(&(wiphy)->dev, format, ##args)
7977 #define wiphy_warn(wiphy, format, args...) \
7978 dev_warn(&(wiphy)->dev, format, ##args)
7979 #define wiphy_notice(wiphy, format, args...) \
7980 dev_notice(&(wiphy)->dev, format, ##args)
7981 #define wiphy_info(wiphy, format, args...) \
7982 dev_info(&(wiphy)->dev, format, ##args)
7984 #define wiphy_err_ratelimited(wiphy, format, args...) \
7985 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7986 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7987 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7989 #define wiphy_debug(wiphy, format, args...) \
7990 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7992 #define wiphy_dbg(wiphy, format, args...) \
7993 dev_dbg(&(wiphy)->dev, format, ##args)
7995 #if defined(VERBOSE_DEBUG)
7996 #define wiphy_vdbg wiphy_dbg
7998 #define wiphy_vdbg(wiphy, format, args...) \
8001 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8007 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8008 * of using a WARN/WARN_ON to get the message out, including the
8009 * file/line information and a backtrace.
8011 #define wiphy_WARN(wiphy, format, args...) \
8012 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8015 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8016 * @netdev: network device
8017 * @owe_info: peer's owe info
8018 * @gfp: allocation flags
8020 void cfg80211_update_owe_info_event(struct net_device
*netdev
,
8021 struct cfg80211_update_owe_info
*owe_info
,
8025 * cfg80211_bss_flush - resets all the scan entries
8028 void cfg80211_bss_flush(struct wiphy
*wiphy
);
8030 #endif /* __NET_CFG80211_H */