1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __NET_CFG80211_H
3 #define __NET_CFG80211_H
5 * 802.11 device and configuration interface
7 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright 2015-2017 Intel Deutschland GmbH
10 * Copyright (C) 2018-2019 Intel Corporation
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <linux/net.h>
23 #include <net/regulatory.h>
28 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29 * userspace and drivers, and offers some utility functionality associated
30 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31 * by all modern wireless drivers in Linux, so that they offer a consistent
32 * API through nl80211. For backward compatibility, cfg80211 also offers
33 * wireless extensions to userspace, but hides them from drivers completely.
35 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
41 * DOC: Device registration
43 * In order for a driver to use cfg80211, it must register the hardware device
44 * with cfg80211. This happens through a number of hardware capability structs
47 * The fundamental structure for each device is the 'wiphy', of which each
48 * instance describes a physical wireless device connected to the system. Each
49 * such wiphy can have zero, one, or many virtual interfaces associated with
50 * it, which need to be identified as such by pointing the network interface's
51 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52 * the wireless part of the interface, normally this struct is embedded in the
53 * network interface's private data area. Drivers can optionally allow creating
54 * or destroying virtual interfaces on the fly, but without at least one or the
55 * ability to create some the wireless device isn't useful.
57 * Each wiphy structure contains device capability information, and also has
58 * a pointer to the various operations the driver offers. The definitions and
59 * structures here describe these capabilities in detail.
65 * wireless hardware capability structures
69 * enum ieee80211_channel_flags - channel flags
71 * Channel flags set by the regulatory control code.
73 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
74 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
75 * sending probe requests or beaconing.
76 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
77 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
79 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
81 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
82 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
83 * this flag indicates that an 80 MHz channel cannot use this
84 * channel as the control or any of the secondary channels.
85 * This may be due to the driver or due to regulatory bandwidth
87 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
88 * this flag indicates that an 160 MHz channel cannot use this
89 * channel as the control or any of the secondary channels.
90 * This may be due to the driver or due to regulatory bandwidth
92 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
93 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
94 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
96 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
100 enum ieee80211_channel_flags
{
101 IEEE80211_CHAN_DISABLED
= 1<<0,
102 IEEE80211_CHAN_NO_IR
= 1<<1,
104 IEEE80211_CHAN_RADAR
= 1<<3,
105 IEEE80211_CHAN_NO_HT40PLUS
= 1<<4,
106 IEEE80211_CHAN_NO_HT40MINUS
= 1<<5,
107 IEEE80211_CHAN_NO_OFDM
= 1<<6,
108 IEEE80211_CHAN_NO_80MHZ
= 1<<7,
109 IEEE80211_CHAN_NO_160MHZ
= 1<<8,
110 IEEE80211_CHAN_INDOOR_ONLY
= 1<<9,
111 IEEE80211_CHAN_IR_CONCURRENT
= 1<<10,
112 IEEE80211_CHAN_NO_20MHZ
= 1<<11,
113 IEEE80211_CHAN_NO_10MHZ
= 1<<12,
116 #define IEEE80211_CHAN_NO_HT40 \
117 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
119 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
120 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
123 * struct ieee80211_channel - channel definition
125 * This structure describes a single channel for use
128 * @center_freq: center frequency in MHz
129 * @hw_value: hardware-specific value for the channel
130 * @flags: channel flags from &enum ieee80211_channel_flags.
131 * @orig_flags: channel flags at registration time, used by regulatory
132 * code to support devices with additional restrictions
133 * @band: band this channel belongs to.
134 * @max_antenna_gain: maximum antenna gain in dBi
135 * @max_power: maximum transmission power (in dBm)
136 * @max_reg_power: maximum regulatory transmission power (in dBm)
137 * @beacon_found: helper to regulatory code to indicate when a beacon
138 * has been found on this channel. Use regulatory_hint_found_beacon()
139 * to enable this, this is useful only on 5 GHz band.
140 * @orig_mag: internal use
141 * @orig_mpwr: internal use
142 * @dfs_state: current state of this channel. Only relevant if radar is required
144 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
145 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
147 struct ieee80211_channel
{
148 enum nl80211_band band
;
152 int max_antenna_gain
;
157 int orig_mag
, orig_mpwr
;
158 enum nl80211_dfs_state dfs_state
;
159 unsigned long dfs_state_entered
;
160 unsigned int dfs_cac_ms
;
164 * enum ieee80211_rate_flags - rate flags
166 * Hardware/specification flags for rates. These are structured
167 * in a way that allows using the same bitrate structure for
168 * different bands/PHY modes.
170 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
171 * preamble on this bitrate; only relevant in 2.4GHz band and
173 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
174 * when used with 802.11a (on the 5 GHz band); filled by the
175 * core code when registering the wiphy.
176 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
177 * when used with 802.11b (on the 2.4 GHz band); filled by the
178 * core code when registering the wiphy.
179 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
180 * when used with 802.11g (on the 2.4 GHz band); filled by the
181 * core code when registering the wiphy.
182 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
183 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
184 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
186 enum ieee80211_rate_flags
{
187 IEEE80211_RATE_SHORT_PREAMBLE
= 1<<0,
188 IEEE80211_RATE_MANDATORY_A
= 1<<1,
189 IEEE80211_RATE_MANDATORY_B
= 1<<2,
190 IEEE80211_RATE_MANDATORY_G
= 1<<3,
191 IEEE80211_RATE_ERP_G
= 1<<4,
192 IEEE80211_RATE_SUPPORTS_5MHZ
= 1<<5,
193 IEEE80211_RATE_SUPPORTS_10MHZ
= 1<<6,
197 * enum ieee80211_bss_type - BSS type filter
199 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
200 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
201 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
202 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
203 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
205 enum ieee80211_bss_type
{
206 IEEE80211_BSS_TYPE_ESS
,
207 IEEE80211_BSS_TYPE_PBSS
,
208 IEEE80211_BSS_TYPE_IBSS
,
209 IEEE80211_BSS_TYPE_MBSS
,
210 IEEE80211_BSS_TYPE_ANY
214 * enum ieee80211_privacy - BSS privacy filter
216 * @IEEE80211_PRIVACY_ON: privacy bit set
217 * @IEEE80211_PRIVACY_OFF: privacy bit clear
218 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
220 enum ieee80211_privacy
{
221 IEEE80211_PRIVACY_ON
,
222 IEEE80211_PRIVACY_OFF
,
223 IEEE80211_PRIVACY_ANY
226 #define IEEE80211_PRIVACY(x) \
227 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
230 * struct ieee80211_rate - bitrate definition
232 * This structure describes a bitrate that an 802.11 PHY can
233 * operate with. The two values @hw_value and @hw_value_short
234 * are only for driver use when pointers to this structure are
237 * @flags: rate-specific flags
238 * @bitrate: bitrate in units of 100 Kbps
239 * @hw_value: driver/hardware value for this rate
240 * @hw_value_short: driver/hardware value for this rate when
241 * short preamble is used
243 struct ieee80211_rate
{
246 u16 hw_value
, hw_value_short
;
250 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
252 * @enable: is the feature enabled.
253 * @min_offset: minimal tx power offset an associated station shall use
254 * @max_offset: maximum tx power offset an associated station shall use
256 struct ieee80211_he_obss_pd
{
263 * struct ieee80211_sta_ht_cap - STA's HT capabilities
265 * This structure describes most essential parameters needed
266 * to describe 802.11n HT capabilities for an STA.
268 * @ht_supported: is HT supported by the STA
269 * @cap: HT capabilities map as described in 802.11n spec
270 * @ampdu_factor: Maximum A-MPDU length factor
271 * @ampdu_density: Minimum A-MPDU spacing
272 * @mcs: Supported MCS rates
274 struct ieee80211_sta_ht_cap
{
275 u16 cap
; /* use IEEE80211_HT_CAP_ */
279 struct ieee80211_mcs_info mcs
;
283 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
285 * This structure describes most essential parameters needed
286 * to describe 802.11ac VHT capabilities for an STA.
288 * @vht_supported: is VHT supported by the STA
289 * @cap: VHT capabilities map as described in 802.11ac spec
290 * @vht_mcs: Supported VHT MCS rates
292 struct ieee80211_sta_vht_cap
{
294 u32 cap
; /* use IEEE80211_VHT_CAP_ */
295 struct ieee80211_vht_mcs_info vht_mcs
;
298 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
301 * struct ieee80211_sta_he_cap - STA's HE capabilities
303 * This structure describes most essential parameters needed
304 * to describe 802.11ax HE capabilities for a STA.
306 * @has_he: true iff HE data is valid.
307 * @he_cap_elem: Fixed portion of the HE capabilities element.
308 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
309 * @ppe_thres: Holds the PPE Thresholds data.
311 struct ieee80211_sta_he_cap
{
313 struct ieee80211_he_cap_elem he_cap_elem
;
314 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp
;
315 u8 ppe_thres
[IEEE80211_HE_PPE_THRES_MAX_LEN
];
319 * struct ieee80211_sband_iftype_data
321 * This structure encapsulates sband data that is relevant for the
322 * interface types defined in @types_mask. Each type in the
323 * @types_mask must be unique across all instances of iftype_data.
325 * @types_mask: interface types mask
326 * @he_cap: holds the HE capabilities
328 struct ieee80211_sband_iftype_data
{
330 struct ieee80211_sta_he_cap he_cap
;
334 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
336 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
337 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
338 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
339 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
340 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
341 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
342 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
343 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
345 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
347 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
349 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
350 * and 4.32GHz + 4.32GHz
351 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
352 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
354 enum ieee80211_edmg_bw_config
{
355 IEEE80211_EDMG_BW_CONFIG_4
= 4,
356 IEEE80211_EDMG_BW_CONFIG_5
= 5,
357 IEEE80211_EDMG_BW_CONFIG_6
= 6,
358 IEEE80211_EDMG_BW_CONFIG_7
= 7,
359 IEEE80211_EDMG_BW_CONFIG_8
= 8,
360 IEEE80211_EDMG_BW_CONFIG_9
= 9,
361 IEEE80211_EDMG_BW_CONFIG_10
= 10,
362 IEEE80211_EDMG_BW_CONFIG_11
= 11,
363 IEEE80211_EDMG_BW_CONFIG_12
= 12,
364 IEEE80211_EDMG_BW_CONFIG_13
= 13,
365 IEEE80211_EDMG_BW_CONFIG_14
= 14,
366 IEEE80211_EDMG_BW_CONFIG_15
= 15,
370 * struct ieee80211_edmg - EDMG configuration
372 * This structure describes most essential parameters needed
373 * to describe 802.11ay EDMG configuration
375 * @channels: bitmap that indicates the 2.16 GHz channel(s)
376 * that are allowed to be used for transmissions.
377 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
378 * Set to 0 indicate EDMG not supported.
379 * @bw_config: Channel BW Configuration subfield encodes
380 * the allowed channel bandwidth configurations
382 struct ieee80211_edmg
{
384 enum ieee80211_edmg_bw_config bw_config
;
388 * struct ieee80211_supported_band - frequency band definition
390 * This structure describes a frequency band a wiphy
391 * is able to operate in.
393 * @channels: Array of channels the hardware can operate in
395 * @band: the band this structure represents
396 * @n_channels: Number of channels in @channels
397 * @bitrates: Array of bitrates the hardware can operate with
398 * in this band. Must be sorted to give a valid "supported
399 * rates" IE, i.e. CCK rates first, then OFDM.
400 * @n_bitrates: Number of bitrates in @bitrates
401 * @ht_cap: HT capabilities in this band
402 * @vht_cap: VHT capabilities in this band
403 * @edmg_cap: EDMG capabilities in this band
404 * @n_iftype_data: number of iftype data entries
405 * @iftype_data: interface type data entries. Note that the bits in
406 * @types_mask inside this structure cannot overlap (i.e. only
407 * one occurrence of each type is allowed across all instances of
410 struct ieee80211_supported_band
{
411 struct ieee80211_channel
*channels
;
412 struct ieee80211_rate
*bitrates
;
413 enum nl80211_band band
;
416 struct ieee80211_sta_ht_cap ht_cap
;
417 struct ieee80211_sta_vht_cap vht_cap
;
418 struct ieee80211_edmg edmg_cap
;
420 const struct ieee80211_sband_iftype_data
*iftype_data
;
424 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
425 * @sband: the sband to search for the STA on
426 * @iftype: enum nl80211_iftype
428 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
430 static inline const struct ieee80211_sband_iftype_data
*
431 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band
*sband
,
436 if (WARN_ON(iftype
>= NL80211_IFTYPE_MAX
))
439 for (i
= 0; i
< sband
->n_iftype_data
; i
++) {
440 const struct ieee80211_sband_iftype_data
*data
=
441 &sband
->iftype_data
[i
];
443 if (data
->types_mask
& BIT(iftype
))
451 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
452 * @sband: the sband to search for the iftype on
453 * @iftype: enum nl80211_iftype
455 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
457 static inline const struct ieee80211_sta_he_cap
*
458 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band
*sband
,
461 const struct ieee80211_sband_iftype_data
*data
=
462 ieee80211_get_sband_iftype_data(sband
, iftype
);
464 if (data
&& data
->he_cap
.has_he
)
465 return &data
->he_cap
;
471 * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
472 * @sband: the sband to search for the STA on
474 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
476 static inline const struct ieee80211_sta_he_cap
*
477 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band
*sband
)
479 return ieee80211_get_he_iftype_cap(sband
, NL80211_IFTYPE_STATION
);
483 * wiphy_read_of_freq_limits - read frequency limits from device tree
485 * @wiphy: the wireless device to get extra limits for
487 * Some devices may have extra limitations specified in DT. This may be useful
488 * for chipsets that normally support more bands but are limited due to board
489 * design (e.g. by antennas or external power amplifier).
491 * This function reads info from DT and uses it to *modify* channels (disable
492 * unavailable ones). It's usually a *bad* idea to use it in drivers with
493 * shared channel data as DT limitations are device specific. You should make
494 * sure to call it only if channels in wiphy are copied and can be modified
495 * without affecting other devices.
497 * As this function access device node it has to be called after set_wiphy_dev.
498 * It also modifies channels so they have to be set first.
499 * If using this helper, call it before wiphy_register().
502 void wiphy_read_of_freq_limits(struct wiphy
*wiphy
);
503 #else /* CONFIG_OF */
504 static inline void wiphy_read_of_freq_limits(struct wiphy
*wiphy
)
507 #endif /* !CONFIG_OF */
511 * Wireless hardware/device configuration structures and methods
515 * DOC: Actions and configuration
517 * Each wireless device and each virtual interface offer a set of configuration
518 * operations and other actions that are invoked by userspace. Each of these
519 * actions is described in the operations structure, and the parameters these
520 * operations use are described separately.
522 * Additionally, some operations are asynchronous and expect to get status
523 * information via some functions that drivers need to call.
525 * Scanning and BSS list handling with its associated functionality is described
526 * in a separate chapter.
529 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
530 WLAN_USER_POSITION_LEN)
533 * struct vif_params - describes virtual interface parameters
534 * @flags: monitor interface flags, unchanged if 0, otherwise
535 * %MONITOR_FLAG_CHANGED will be set
536 * @use_4addr: use 4-address frames
537 * @macaddr: address to use for this virtual interface.
538 * If this parameter is set to zero address the driver may
539 * determine the address as needed.
540 * This feature is only fully supported by drivers that enable the
541 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
542 ** only p2p devices with specified MAC.
543 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
544 * belonging to that MU-MIMO groupID; %NULL if not changed
545 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
546 * MU-MIMO packets going to the specified station; %NULL if not changed
551 u8 macaddr
[ETH_ALEN
];
552 const u8
*vht_mumimo_groups
;
553 const u8
*vht_mumimo_follow_addr
;
557 * struct key_params - key information
559 * Information about a key
562 * @key_len: length of key material
563 * @cipher: cipher suite selector
564 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
565 * with the get_key() callback, must be in little endian,
566 * length given by @seq_len.
567 * @seq_len: length of @seq.
568 * @vlan_id: vlan_id for VLAN group key (if nonzero)
569 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
578 enum nl80211_key_mode mode
;
582 * struct cfg80211_chan_def - channel definition
583 * @chan: the (control) channel
584 * @width: channel width
585 * @center_freq1: center frequency of first segment
586 * @center_freq2: center frequency of second segment
587 * (only with 80+80 MHz)
588 * @edmg: define the EDMG channels configuration.
589 * If edmg is requested (i.e. the .channels member is non-zero),
590 * chan will define the primary channel and all other
591 * parameters are ignored.
593 struct cfg80211_chan_def
{
594 struct ieee80211_channel
*chan
;
595 enum nl80211_chan_width width
;
598 struct ieee80211_edmg edmg
;
602 * cfg80211_get_chandef_type - return old channel type from chandef
603 * @chandef: the channel definition
605 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
606 * chandef, which must have a bandwidth allowing this conversion.
608 static inline enum nl80211_channel_type
609 cfg80211_get_chandef_type(const struct cfg80211_chan_def
*chandef
)
611 switch (chandef
->width
) {
612 case NL80211_CHAN_WIDTH_20_NOHT
:
613 return NL80211_CHAN_NO_HT
;
614 case NL80211_CHAN_WIDTH_20
:
615 return NL80211_CHAN_HT20
;
616 case NL80211_CHAN_WIDTH_40
:
617 if (chandef
->center_freq1
> chandef
->chan
->center_freq
)
618 return NL80211_CHAN_HT40PLUS
;
619 return NL80211_CHAN_HT40MINUS
;
622 return NL80211_CHAN_NO_HT
;
627 * cfg80211_chandef_create - create channel definition using channel type
628 * @chandef: the channel definition struct to fill
629 * @channel: the control channel
630 * @chantype: the channel type
632 * Given a channel type, create a channel definition.
634 void cfg80211_chandef_create(struct cfg80211_chan_def
*chandef
,
635 struct ieee80211_channel
*channel
,
636 enum nl80211_channel_type chantype
);
639 * cfg80211_chandef_identical - check if two channel definitions are identical
640 * @chandef1: first channel definition
641 * @chandef2: second channel definition
643 * Return: %true if the channels defined by the channel definitions are
644 * identical, %false otherwise.
647 cfg80211_chandef_identical(const struct cfg80211_chan_def
*chandef1
,
648 const struct cfg80211_chan_def
*chandef2
)
650 return (chandef1
->chan
== chandef2
->chan
&&
651 chandef1
->width
== chandef2
->width
&&
652 chandef1
->center_freq1
== chandef2
->center_freq1
&&
653 chandef1
->center_freq2
== chandef2
->center_freq2
);
657 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
659 * @chandef: the channel definition
661 * Return: %true if EDMG defined, %false otherwise.
664 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def
*chandef
)
666 return chandef
->edmg
.channels
|| chandef
->edmg
.bw_config
;
670 * cfg80211_chandef_compatible - check if two channel definitions are compatible
671 * @chandef1: first channel definition
672 * @chandef2: second channel definition
674 * Return: %NULL if the given channel definitions are incompatible,
675 * chandef1 or chandef2 otherwise.
677 const struct cfg80211_chan_def
*
678 cfg80211_chandef_compatible(const struct cfg80211_chan_def
*chandef1
,
679 const struct cfg80211_chan_def
*chandef2
);
682 * cfg80211_chandef_valid - check if a channel definition is valid
683 * @chandef: the channel definition to check
684 * Return: %true if the channel definition is valid. %false otherwise.
686 bool cfg80211_chandef_valid(const struct cfg80211_chan_def
*chandef
);
689 * cfg80211_chandef_usable - check if secondary channels can be used
690 * @wiphy: the wiphy to validate against
691 * @chandef: the channel definition to check
692 * @prohibited_flags: the regulatory channel flags that must not be set
693 * Return: %true if secondary channels are usable. %false otherwise.
695 bool cfg80211_chandef_usable(struct wiphy
*wiphy
,
696 const struct cfg80211_chan_def
*chandef
,
697 u32 prohibited_flags
);
700 * cfg80211_chandef_dfs_required - checks if radar detection is required
701 * @wiphy: the wiphy to validate against
702 * @chandef: the channel definition to check
703 * @iftype: the interface type as specified in &enum nl80211_iftype
705 * 1 if radar detection is required, 0 if it is not, < 0 on error
707 int cfg80211_chandef_dfs_required(struct wiphy
*wiphy
,
708 const struct cfg80211_chan_def
*chandef
,
709 enum nl80211_iftype iftype
);
712 * ieee80211_chandef_rate_flags - returns rate flags for a channel
714 * In some channel types, not all rates may be used - for example CCK
715 * rates may not be used in 5/10 MHz channels.
717 * @chandef: channel definition for the channel
719 * Returns: rate flags which apply for this channel
721 static inline enum ieee80211_rate_flags
722 ieee80211_chandef_rate_flags(struct cfg80211_chan_def
*chandef
)
724 switch (chandef
->width
) {
725 case NL80211_CHAN_WIDTH_5
:
726 return IEEE80211_RATE_SUPPORTS_5MHZ
;
727 case NL80211_CHAN_WIDTH_10
:
728 return IEEE80211_RATE_SUPPORTS_10MHZ
;
736 * ieee80211_chandef_max_power - maximum transmission power for the chandef
738 * In some regulations, the transmit power may depend on the configured channel
739 * bandwidth which may be defined as dBm/MHz. This function returns the actual
740 * max_power for non-standard (20 MHz) channels.
742 * @chandef: channel definition for the channel
744 * Returns: maximum allowed transmission power in dBm for the chandef
747 ieee80211_chandef_max_power(struct cfg80211_chan_def
*chandef
)
749 switch (chandef
->width
) {
750 case NL80211_CHAN_WIDTH_5
:
751 return min(chandef
->chan
->max_reg_power
- 6,
752 chandef
->chan
->max_power
);
753 case NL80211_CHAN_WIDTH_10
:
754 return min(chandef
->chan
->max_reg_power
- 3,
755 chandef
->chan
->max_power
);
759 return chandef
->chan
->max_power
;
763 * enum survey_info_flags - survey information flags
765 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
766 * @SURVEY_INFO_IN_USE: channel is currently being used
767 * @SURVEY_INFO_TIME: active time (in ms) was filled in
768 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
769 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
770 * @SURVEY_INFO_TIME_RX: receive time was filled in
771 * @SURVEY_INFO_TIME_TX: transmit time was filled in
772 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
773 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
775 * Used by the driver to indicate which info in &struct survey_info
776 * it has filled in during the get_survey().
778 enum survey_info_flags
{
779 SURVEY_INFO_NOISE_DBM
= BIT(0),
780 SURVEY_INFO_IN_USE
= BIT(1),
781 SURVEY_INFO_TIME
= BIT(2),
782 SURVEY_INFO_TIME_BUSY
= BIT(3),
783 SURVEY_INFO_TIME_EXT_BUSY
= BIT(4),
784 SURVEY_INFO_TIME_RX
= BIT(5),
785 SURVEY_INFO_TIME_TX
= BIT(6),
786 SURVEY_INFO_TIME_SCAN
= BIT(7),
787 SURVEY_INFO_TIME_BSS_RX
= BIT(8),
791 * struct survey_info - channel survey response
793 * @channel: the channel this survey record reports, may be %NULL for a single
794 * record to report global statistics
795 * @filled: bitflag of flags from &enum survey_info_flags
796 * @noise: channel noise in dBm. This and all following fields are
798 * @time: amount of time in ms the radio was turn on (on the channel)
799 * @time_busy: amount of time the primary channel was sensed busy
800 * @time_ext_busy: amount of time the extension channel was sensed busy
801 * @time_rx: amount of time the radio spent receiving data
802 * @time_tx: amount of time the radio spent transmitting data
803 * @time_scan: amount of time the radio spent for scanning
804 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
806 * Used by dump_survey() to report back per-channel survey information.
808 * This structure can later be expanded with things like
809 * channel duty cycle etc.
812 struct ieee80211_channel
*channel
;
824 #define CFG80211_MAX_WEP_KEYS 4
827 * struct cfg80211_crypto_settings - Crypto settings
828 * @wpa_versions: indicates which, if any, WPA versions are enabled
829 * (from enum nl80211_wpa_versions)
830 * @cipher_group: group key cipher suite (or 0 if unset)
831 * @n_ciphers_pairwise: number of AP supported unicast ciphers
832 * @ciphers_pairwise: unicast key cipher suites
833 * @n_akm_suites: number of AKM suites
834 * @akm_suites: AKM suites
835 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
836 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
837 * required to assume that the port is unauthorized until authorized by
838 * user space. Otherwise, port is marked authorized by default.
839 * @control_port_ethertype: the control port protocol that should be
840 * allowed through even on unauthorized ports
841 * @control_port_no_encrypt: TRUE to prevent encryption of control port
843 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
844 * port frames over NL80211 instead of the network interface.
845 * @wep_keys: static WEP keys, if not NULL points to an array of
846 * CFG80211_MAX_WEP_KEYS WEP keys
847 * @wep_tx_key: key index (0..3) of the default TX static WEP key
848 * @psk: PSK (for devices supporting 4-way-handshake offload)
849 * @sae_pwd: password for SAE authentication (for devices supporting SAE
851 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
853 struct cfg80211_crypto_settings
{
856 int n_ciphers_pairwise
;
857 u32 ciphers_pairwise
[NL80211_MAX_NR_CIPHER_SUITES
];
859 u32 akm_suites
[NL80211_MAX_NR_AKM_SUITES
];
861 __be16 control_port_ethertype
;
862 bool control_port_no_encrypt
;
863 bool control_port_over_nl80211
;
864 struct key_params
*wep_keys
;
872 * struct cfg80211_beacon_data - beacon data
873 * @head: head portion of beacon (before TIM IE)
874 * or %NULL if not changed
875 * @tail: tail portion of beacon (after TIM IE)
876 * or %NULL if not changed
877 * @head_len: length of @head
878 * @tail_len: length of @tail
879 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
880 * @beacon_ies_len: length of beacon_ies in octets
881 * @proberesp_ies: extra information element(s) to add into Probe Response
883 * @proberesp_ies_len: length of proberesp_ies in octets
884 * @assocresp_ies: extra information element(s) to add into (Re)Association
885 * Response frames or %NULL
886 * @assocresp_ies_len: length of assocresp_ies in octets
887 * @probe_resp_len: length of probe response template (@probe_resp)
888 * @probe_resp: probe response template (AP mode only)
889 * @ftm_responder: enable FTM responder functionality; -1 for no change
890 * (which also implies no change in LCI/civic location data)
891 * @lci: Measurement Report element content, starting with Measurement Token
892 * (measurement type 8)
893 * @civicloc: Measurement Report element content, starting with Measurement
894 * Token (measurement type 11)
895 * @lci_len: LCI data length
896 * @civicloc_len: Civic location data length
898 struct cfg80211_beacon_data
{
899 const u8
*head
, *tail
;
900 const u8
*beacon_ies
;
901 const u8
*proberesp_ies
;
902 const u8
*assocresp_ies
;
903 const u8
*probe_resp
;
908 size_t head_len
, tail_len
;
909 size_t beacon_ies_len
;
910 size_t proberesp_ies_len
;
911 size_t assocresp_ies_len
;
912 size_t probe_resp_len
;
922 * struct cfg80211_acl_data - Access control list data
924 * @acl_policy: ACL policy to be applied on the station's
925 * entry specified by mac_addr
926 * @n_acl_entries: Number of MAC address entries passed
927 * @mac_addrs: List of MAC addresses of stations to be used for ACL
929 struct cfg80211_acl_data
{
930 enum nl80211_acl_policy acl_policy
;
934 struct mac_address mac_addrs
[];
938 * cfg80211_bitrate_mask - masks for bitrate control
940 struct cfg80211_bitrate_mask
{
943 u8 ht_mcs
[IEEE80211_HT_MCS_MASK_LEN
];
944 u16 vht_mcs
[NL80211_VHT_NSS_MAX
];
945 enum nl80211_txrate_gi gi
;
946 } control
[NUM_NL80211_BANDS
];
950 * enum cfg80211_ap_settings_flags - AP settings flags
952 * Used by cfg80211_ap_settings
954 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
956 enum cfg80211_ap_settings_flags
{
957 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT
= BIT(0),
961 * struct cfg80211_ap_settings - AP configuration
963 * Used to configure an AP interface.
965 * @chandef: defines the channel to use
966 * @beacon: beacon data
967 * @beacon_interval: beacon interval
968 * @dtim_period: DTIM period
969 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
971 * @ssid_len: length of @ssid
972 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
973 * @crypto: crypto settings
974 * @privacy: the BSS uses privacy
975 * @auth_type: Authentication type (algorithm)
976 * @smps_mode: SMPS mode
977 * @inactivity_timeout: time in seconds to determine station's inactivity.
978 * @p2p_ctwindow: P2P CT Window
979 * @p2p_opp_ps: P2P opportunistic PS
980 * @acl: ACL configuration used by the drivers which has support for
981 * MAC address based access control
982 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
984 * @beacon_rate: bitrate to be used for beacons
985 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
986 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
987 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
988 * @ht_required: stations must support HT
989 * @vht_required: stations must support VHT
990 * @twt_responder: Enable Target Wait Time
991 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
992 * @he_obss_pd: OBSS Packet Detection settings
994 struct cfg80211_ap_settings
{
995 struct cfg80211_chan_def chandef
;
997 struct cfg80211_beacon_data beacon
;
999 int beacon_interval
, dtim_period
;
1002 enum nl80211_hidden_ssid hidden_ssid
;
1003 struct cfg80211_crypto_settings crypto
;
1005 enum nl80211_auth_type auth_type
;
1006 enum nl80211_smps_mode smps_mode
;
1007 int inactivity_timeout
;
1010 const struct cfg80211_acl_data
*acl
;
1012 struct cfg80211_bitrate_mask beacon_rate
;
1014 const struct ieee80211_ht_cap
*ht_cap
;
1015 const struct ieee80211_vht_cap
*vht_cap
;
1016 const struct ieee80211_he_cap_elem
*he_cap
;
1017 bool ht_required
, vht_required
;
1020 struct ieee80211_he_obss_pd he_obss_pd
;
1024 * struct cfg80211_csa_settings - channel switch settings
1026 * Used for channel switch
1028 * @chandef: defines the channel to use after the switch
1029 * @beacon_csa: beacon data while performing the switch
1030 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1031 * @counter_offsets_presp: offsets of the counters within the probe response
1032 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1033 * @n_counter_offsets_presp: number of csa counters in the probe response
1034 * @beacon_after: beacon data to be used on the new channel
1035 * @radar_required: whether radar detection is required on the new channel
1036 * @block_tx: whether transmissions should be blocked while changing
1037 * @count: number of beacons until switch
1039 struct cfg80211_csa_settings
{
1040 struct cfg80211_chan_def chandef
;
1041 struct cfg80211_beacon_data beacon_csa
;
1042 const u16
*counter_offsets_beacon
;
1043 const u16
*counter_offsets_presp
;
1044 unsigned int n_counter_offsets_beacon
;
1045 unsigned int n_counter_offsets_presp
;
1046 struct cfg80211_beacon_data beacon_after
;
1047 bool radar_required
;
1052 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1055 * struct iface_combination_params - input parameters for interface combinations
1057 * Used to pass interface combination parameters
1059 * @num_different_channels: the number of different channels we want
1060 * to use for verification
1061 * @radar_detect: a bitmap where each bit corresponds to a channel
1062 * width where radar detection is needed, as in the definition of
1063 * &struct ieee80211_iface_combination.@radar_detect_widths
1064 * @iftype_num: array with the number of interfaces of each interface
1065 * type. The index is the interface type as specified in &enum
1067 * @new_beacon_int: set this to the beacon interval of a new interface
1068 * that's not operating yet, if such is to be checked as part of
1071 struct iface_combination_params
{
1072 int num_different_channels
;
1074 int iftype_num
[NUM_NL80211_IFTYPES
];
1079 * enum station_parameters_apply_mask - station parameter values to apply
1080 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1081 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1082 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1084 * Not all station parameters have in-band "no change" signalling,
1085 * for those that don't these flags will are used.
1087 enum station_parameters_apply_mask
{
1088 STATION_PARAM_APPLY_UAPSD
= BIT(0),
1089 STATION_PARAM_APPLY_CAPABILITY
= BIT(1),
1090 STATION_PARAM_APPLY_PLINK_STATE
= BIT(2),
1091 STATION_PARAM_APPLY_STA_TXPOWER
= BIT(3),
1095 * struct sta_txpwr - station txpower configuration
1097 * Used to configure txpower for station.
1099 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1100 * is not provided, the default per-interface tx power setting will be
1101 * overriding. Driver should be picking up the lowest tx power, either tx
1102 * power per-interface or per-station.
1103 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1104 * will be less than or equal to specified from userspace, whereas if TPC
1105 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1106 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1111 enum nl80211_tx_power_setting type
;
1115 * struct station_parameters - station parameters
1117 * Used to change and create a new station.
1119 * @vlan: vlan interface station should belong to
1120 * @supported_rates: supported rates in IEEE 802.11 format
1121 * (or NULL for no change)
1122 * @supported_rates_len: number of supported rates
1123 * @sta_flags_mask: station flags that changed
1124 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1125 * @sta_flags_set: station flags values
1126 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1127 * @listen_interval: listen interval or -1 for no change
1128 * @aid: AID or zero for no change
1129 * @vlan_id: VLAN ID for station (if nonzero)
1130 * @peer_aid: mesh peer AID or zero for no change
1131 * @plink_action: plink action to take
1132 * @plink_state: set the peer link state for a station
1133 * @ht_capa: HT capabilities of station
1134 * @vht_capa: VHT capabilities of station
1135 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1136 * as the AC bitmap in the QoS info field
1137 * @max_sp: max Service Period. same format as the MAX_SP in the
1138 * QoS info field (but already shifted down)
1139 * @sta_modify_mask: bitmap indicating which parameters changed
1140 * (for those that don't have a natural "no change" value),
1141 * see &enum station_parameters_apply_mask
1142 * @local_pm: local link-specific mesh power save mode (no change when set
1144 * @capability: station capability
1145 * @ext_capab: extended capabilities of the station
1146 * @ext_capab_len: number of extended capabilities
1147 * @supported_channels: supported channels in IEEE 802.11 format
1148 * @supported_channels_len: number of supported channels
1149 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1150 * @supported_oper_classes_len: number of supported operating classes
1151 * @opmode_notif: operating mode field from Operating Mode Notification
1152 * @opmode_notif_used: information if operating mode field is used
1153 * @support_p2p_ps: information if station supports P2P PS mechanism
1154 * @he_capa: HE capabilities of station
1155 * @he_capa_len: the length of the HE capabilities
1156 * @airtime_weight: airtime scheduler weight for this station
1158 struct station_parameters
{
1159 const u8
*supported_rates
;
1160 struct net_device
*vlan
;
1161 u32 sta_flags_mask
, sta_flags_set
;
1162 u32 sta_modify_mask
;
1163 int listen_interval
;
1167 u8 supported_rates_len
;
1170 const struct ieee80211_ht_cap
*ht_capa
;
1171 const struct ieee80211_vht_cap
*vht_capa
;
1174 enum nl80211_mesh_power_mode local_pm
;
1176 const u8
*ext_capab
;
1178 const u8
*supported_channels
;
1179 u8 supported_channels_len
;
1180 const u8
*supported_oper_classes
;
1181 u8 supported_oper_classes_len
;
1183 bool opmode_notif_used
;
1185 const struct ieee80211_he_cap_elem
*he_capa
;
1188 struct sta_txpwr txpwr
;
1192 * struct station_del_parameters - station deletion parameters
1194 * Used to delete a station entry (or all stations).
1196 * @mac: MAC address of the station to remove or NULL to remove all stations
1197 * @subtype: Management frame subtype to use for indicating removal
1198 * (10 = Disassociation, 12 = Deauthentication)
1199 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1201 struct station_del_parameters
{
1208 * enum cfg80211_station_type - the type of station being modified
1209 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1210 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1211 * unassociated (update properties for this type of client is permitted)
1212 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1213 * the AP MLME in the device
1214 * @CFG80211_STA_AP_STA: AP station on managed interface
1215 * @CFG80211_STA_IBSS: IBSS station
1216 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1217 * while TDLS setup is in progress, it moves out of this state when
1218 * being marked authorized; use this only if TDLS with external setup is
1220 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1221 * entry that is operating, has been marked authorized by userspace)
1222 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1223 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1225 enum cfg80211_station_type
{
1226 CFG80211_STA_AP_CLIENT
,
1227 CFG80211_STA_AP_CLIENT_UNASSOC
,
1228 CFG80211_STA_AP_MLME_CLIENT
,
1229 CFG80211_STA_AP_STA
,
1231 CFG80211_STA_TDLS_PEER_SETUP
,
1232 CFG80211_STA_TDLS_PEER_ACTIVE
,
1233 CFG80211_STA_MESH_PEER_KERNEL
,
1234 CFG80211_STA_MESH_PEER_USER
,
1238 * cfg80211_check_station_change - validate parameter changes
1239 * @wiphy: the wiphy this operates on
1240 * @params: the new parameters for a station
1241 * @statype: the type of station being modified
1243 * Utility function for the @change_station driver method. Call this function
1244 * with the appropriate station type looking up the station (and checking that
1245 * it exists). It will verify whether the station change is acceptable, and if
1246 * not will return an error code. Note that it may modify the parameters for
1247 * backward compatibility reasons, so don't use them before calling this.
1249 int cfg80211_check_station_change(struct wiphy
*wiphy
,
1250 struct station_parameters
*params
,
1251 enum cfg80211_station_type statype
);
1254 * enum station_info_rate_flags - bitrate info flags
1256 * Used by the driver to indicate the specific rate transmission
1257 * type for 802.11n transmissions.
1259 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1260 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1261 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1262 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1263 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1264 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1266 enum rate_info_flags
{
1267 RATE_INFO_FLAGS_MCS
= BIT(0),
1268 RATE_INFO_FLAGS_VHT_MCS
= BIT(1),
1269 RATE_INFO_FLAGS_SHORT_GI
= BIT(2),
1270 RATE_INFO_FLAGS_DMG
= BIT(3),
1271 RATE_INFO_FLAGS_HE_MCS
= BIT(4),
1272 RATE_INFO_FLAGS_EDMG
= BIT(5),
1276 * enum rate_info_bw - rate bandwidth information
1278 * Used by the driver to indicate the rate bandwidth.
1280 * @RATE_INFO_BW_5: 5 MHz bandwidth
1281 * @RATE_INFO_BW_10: 10 MHz bandwidth
1282 * @RATE_INFO_BW_20: 20 MHz bandwidth
1283 * @RATE_INFO_BW_40: 40 MHz bandwidth
1284 * @RATE_INFO_BW_80: 80 MHz bandwidth
1285 * @RATE_INFO_BW_160: 160 MHz bandwidth
1286 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1289 RATE_INFO_BW_20
= 0,
1299 * struct rate_info - bitrate information
1301 * Information about a receiving or transmitting bitrate
1303 * @flags: bitflag of flags from &enum rate_info_flags
1304 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1305 * @legacy: bitrate in 100kbit/s for 802.11abg
1306 * @nss: number of streams (VHT & HE only)
1307 * @bw: bandwidth (from &enum rate_info_bw)
1308 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1309 * @he_dcm: HE DCM value
1310 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1311 * only valid if bw is %RATE_INFO_BW_HE_RU)
1312 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1327 * enum station_info_rate_flags - bitrate info flags
1329 * Used by the driver to indicate the specific rate transmission
1330 * type for 802.11n transmissions.
1332 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1333 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1334 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1336 enum bss_param_flags
{
1337 BSS_PARAM_FLAGS_CTS_PROT
= 1<<0,
1338 BSS_PARAM_FLAGS_SHORT_PREAMBLE
= 1<<1,
1339 BSS_PARAM_FLAGS_SHORT_SLOT_TIME
= 1<<2,
1343 * struct sta_bss_parameters - BSS parameters for the attached station
1345 * Information about the currently associated BSS
1347 * @flags: bitflag of flags from &enum bss_param_flags
1348 * @dtim_period: DTIM period for the BSS
1349 * @beacon_interval: beacon interval
1351 struct sta_bss_parameters
{
1354 u16 beacon_interval
;
1358 * struct cfg80211_txq_stats - TXQ statistics for this TID
1359 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1360 * indicate the relevant values in this struct are filled
1361 * @backlog_bytes: total number of bytes currently backlogged
1362 * @backlog_packets: total number of packets currently backlogged
1363 * @flows: number of new flows seen
1364 * @drops: total number of packets dropped
1365 * @ecn_marks: total number of packets marked with ECN CE
1366 * @overlimit: number of drops due to queue space overflow
1367 * @overmemory: number of drops due to memory limit overflow
1368 * @collisions: number of hash collisions
1369 * @tx_bytes: total number of bytes dequeued
1370 * @tx_packets: total number of packets dequeued
1371 * @max_flows: maximum number of flows supported
1373 struct cfg80211_txq_stats
{
1376 u32 backlog_packets
;
1389 * struct cfg80211_tid_stats - per-TID statistics
1390 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1391 * indicate the relevant values in this struct are filled
1392 * @rx_msdu: number of received MSDUs
1393 * @tx_msdu: number of (attempted) transmitted MSDUs
1394 * @tx_msdu_retries: number of retries (not counting the first) for
1396 * @tx_msdu_failed: number of failed transmitted MSDUs
1397 * @txq_stats: TXQ statistics
1399 struct cfg80211_tid_stats
{
1403 u64 tx_msdu_retries
;
1405 struct cfg80211_txq_stats txq_stats
;
1408 #define IEEE80211_MAX_CHAINS 4
1411 * struct station_info - station information
1413 * Station information filled by driver for get_station() and dump_station.
1415 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1416 * indicate the relevant values in this struct for them
1417 * @connected_time: time(in secs) since a station is last connected
1418 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1419 * @assoc_at: bootime (ns) of the last association
1420 * @rx_bytes: bytes (size of MPDUs) received from this station
1421 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1422 * @llid: mesh local link id
1423 * @plid: mesh peer link id
1424 * @plink_state: mesh peer link state
1425 * @signal: The signal strength, type depends on the wiphy's signal_type.
1426 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1427 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1428 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1429 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1430 * @chain_signal: per-chain signal strength of last received packet in dBm
1431 * @chain_signal_avg: per-chain signal strength average in dBm
1432 * @txrate: current unicast bitrate from this station
1433 * @rxrate: current unicast bitrate to this station
1434 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1435 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1436 * @tx_retries: cumulative retry counts (MPDUs)
1437 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1438 * @rx_dropped_misc: Dropped for un-specified reason.
1439 * @bss_param: current BSS parameters
1440 * @generation: generation number for nl80211 dumps.
1441 * This number should increase every time the list of stations
1442 * changes, i.e. when a station is added or removed, so that
1443 * userspace can tell whether it got a consistent snapshot.
1444 * @assoc_req_ies: IEs from (Re)Association Request.
1445 * This is used only when in AP mode with drivers that do not use
1446 * user space MLME/SME implementation. The information is provided for
1447 * the cfg80211_new_sta() calls to notify user space of the IEs.
1448 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1449 * @sta_flags: station flags mask & values
1450 * @beacon_loss_count: Number of times beacon loss event has triggered.
1451 * @t_offset: Time offset of the station relative to this host.
1452 * @local_pm: local mesh STA power save mode
1453 * @peer_pm: peer mesh STA power save mode
1454 * @nonpeer_pm: non-peer mesh STA power save mode
1455 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1456 * towards this station.
1457 * @rx_beacon: number of beacons received from this peer
1458 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1460 * @connected_to_gate: true if mesh STA has a path to mesh gate
1461 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1462 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1463 * @airtime_weight: current airtime scheduling weight
1464 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1465 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1466 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1467 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1468 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1470 * @rx_mpdu_count: number of MPDUs received from this station
1471 * @fcs_err_count: number of packets (MPDUs) received from this station with
1472 * an FCS error. This counter should be incremented only when TA of the
1473 * received packet with an FCS error matches the peer MAC address.
1474 * @airtime_link_metric: mesh airtime link metric.
1476 struct station_info
{
1490 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
1491 s8 chain_signal_avg
[IEEE80211_MAX_CHAINS
];
1493 struct rate_info txrate
;
1494 struct rate_info rxrate
;
1499 u32 rx_dropped_misc
;
1500 struct sta_bss_parameters bss_param
;
1501 struct nl80211_sta_flag_update sta_flags
;
1505 const u8
*assoc_req_ies
;
1506 size_t assoc_req_ies_len
;
1508 u32 beacon_loss_count
;
1510 enum nl80211_mesh_power_mode local_pm
;
1511 enum nl80211_mesh_power_mode peer_pm
;
1512 enum nl80211_mesh_power_mode nonpeer_pm
;
1514 u32 expected_throughput
;
1519 u8 rx_beacon_signal_avg
;
1520 u8 connected_to_gate
;
1522 struct cfg80211_tid_stats
*pertid
;
1531 u32 airtime_link_metric
;
1534 #if IS_ENABLED(CONFIG_CFG80211)
1536 * cfg80211_get_station - retrieve information about a given station
1537 * @dev: the device where the station is supposed to be connected to
1538 * @mac_addr: the mac address of the station of interest
1539 * @sinfo: pointer to the structure to fill with the information
1541 * Returns 0 on success and sinfo is filled with the available information
1542 * otherwise returns a negative error code and the content of sinfo has to be
1543 * considered undefined.
1545 int cfg80211_get_station(struct net_device
*dev
, const u8
*mac_addr
,
1546 struct station_info
*sinfo
);
1548 static inline int cfg80211_get_station(struct net_device
*dev
,
1550 struct station_info
*sinfo
)
1557 * enum monitor_flags - monitor flags
1559 * Monitor interface configuration flags. Note that these must be the bits
1560 * according to the nl80211 flags.
1562 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1563 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1564 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1565 * @MONITOR_FLAG_CONTROL: pass control frames
1566 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1567 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1568 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1570 enum monitor_flags
{
1571 MONITOR_FLAG_CHANGED
= 1<<__NL80211_MNTR_FLAG_INVALID
,
1572 MONITOR_FLAG_FCSFAIL
= 1<<NL80211_MNTR_FLAG_FCSFAIL
,
1573 MONITOR_FLAG_PLCPFAIL
= 1<<NL80211_MNTR_FLAG_PLCPFAIL
,
1574 MONITOR_FLAG_CONTROL
= 1<<NL80211_MNTR_FLAG_CONTROL
,
1575 MONITOR_FLAG_OTHER_BSS
= 1<<NL80211_MNTR_FLAG_OTHER_BSS
,
1576 MONITOR_FLAG_COOK_FRAMES
= 1<<NL80211_MNTR_FLAG_COOK_FRAMES
,
1577 MONITOR_FLAG_ACTIVE
= 1<<NL80211_MNTR_FLAG_ACTIVE
,
1581 * enum mpath_info_flags - mesh path information flags
1583 * Used by the driver to indicate which info in &struct mpath_info it has filled
1584 * in during get_station() or dump_station().
1586 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1587 * @MPATH_INFO_SN: @sn filled
1588 * @MPATH_INFO_METRIC: @metric filled
1589 * @MPATH_INFO_EXPTIME: @exptime filled
1590 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1591 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1592 * @MPATH_INFO_FLAGS: @flags filled
1593 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1594 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1596 enum mpath_info_flags
{
1597 MPATH_INFO_FRAME_QLEN
= BIT(0),
1598 MPATH_INFO_SN
= BIT(1),
1599 MPATH_INFO_METRIC
= BIT(2),
1600 MPATH_INFO_EXPTIME
= BIT(3),
1601 MPATH_INFO_DISCOVERY_TIMEOUT
= BIT(4),
1602 MPATH_INFO_DISCOVERY_RETRIES
= BIT(5),
1603 MPATH_INFO_FLAGS
= BIT(6),
1604 MPATH_INFO_HOP_COUNT
= BIT(7),
1605 MPATH_INFO_PATH_CHANGE
= BIT(8),
1609 * struct mpath_info - mesh path information
1611 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1613 * @filled: bitfield of flags from &enum mpath_info_flags
1614 * @frame_qlen: number of queued frames for this destination
1615 * @sn: target sequence number
1616 * @metric: metric (cost) of this mesh path
1617 * @exptime: expiration time for the mesh path from now, in msecs
1618 * @flags: mesh path flags
1619 * @discovery_timeout: total mesh path discovery timeout, in msecs
1620 * @discovery_retries: mesh path discovery retries
1621 * @generation: generation number for nl80211 dumps.
1622 * This number should increase every time the list of mesh paths
1623 * changes, i.e. when a station is added or removed, so that
1624 * userspace can tell whether it got a consistent snapshot.
1625 * @hop_count: hops to destination
1626 * @path_change_count: total number of path changes to destination
1634 u32 discovery_timeout
;
1635 u8 discovery_retries
;
1638 u32 path_change_count
;
1644 * struct bss_parameters - BSS parameters
1646 * Used to change BSS parameters (mainly for AP mode).
1648 * @use_cts_prot: Whether to use CTS protection
1649 * (0 = no, 1 = yes, -1 = do not change)
1650 * @use_short_preamble: Whether the use of short preambles is allowed
1651 * (0 = no, 1 = yes, -1 = do not change)
1652 * @use_short_slot_time: Whether the use of short slot time is allowed
1653 * (0 = no, 1 = yes, -1 = do not change)
1654 * @basic_rates: basic rates in IEEE 802.11 format
1655 * (or NULL for no change)
1656 * @basic_rates_len: number of basic rates
1657 * @ap_isolate: do not forward packets between connected stations
1658 * @ht_opmode: HT Operation mode
1659 * (u16 = opmode, -1 = do not change)
1660 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1661 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1663 struct bss_parameters
{
1665 int use_short_preamble
;
1666 int use_short_slot_time
;
1667 const u8
*basic_rates
;
1671 s8 p2p_ctwindow
, p2p_opp_ps
;
1675 * struct mesh_config - 802.11s mesh configuration
1677 * These parameters can be changed while the mesh is active.
1679 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1680 * by the Mesh Peering Open message
1681 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1682 * used by the Mesh Peering Open message
1683 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1684 * the mesh peering management to close a mesh peering
1685 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1687 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1688 * be sent to establish a new peer link instance in a mesh
1689 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1690 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1692 * @auto_open_plinks: whether we should automatically open peer links when we
1693 * detect compatible mesh peers
1694 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1695 * synchronize to for 11s default synchronization method
1696 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1697 * that an originator mesh STA can send to a particular path target
1698 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1699 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1700 * a path discovery in milliseconds
1701 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1702 * receiving a PREQ shall consider the forwarding information from the
1703 * root to be valid. (TU = time unit)
1704 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1705 * which a mesh STA can send only one action frame containing a PREQ
1707 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1708 * which a mesh STA can send only one Action frame containing a PERR
1710 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1711 * it takes for an HWMP information element to propagate across the mesh
1712 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1713 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1714 * announcements are transmitted
1715 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1716 * station has access to a broader network beyond the MBSS. (This is
1717 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1718 * only means that the station will announce others it's a mesh gate, but
1719 * not necessarily using the gate announcement protocol. Still keeping the
1720 * same nomenclature to be in sync with the spec)
1721 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1722 * entity (default is TRUE - forwarding entity)
1723 * @rssi_threshold: the threshold for average signal strength of candidate
1724 * station to establish a peer link
1725 * @ht_opmode: mesh HT protection mode
1727 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1728 * receiving a proactive PREQ shall consider the forwarding information to
1729 * the root mesh STA to be valid.
1731 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1732 * PREQs are transmitted.
1733 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1734 * during which a mesh STA can send only one Action frame containing
1735 * a PREQ element for root path confirmation.
1736 * @power_mode: The default mesh power save mode which will be the initial
1737 * setting for new peer links.
1738 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1739 * after transmitting its beacon.
1740 * @plink_timeout: If no tx activity is seen from a STA we've established
1741 * peering with for longer than this time (in seconds), then remove it
1742 * from the STA's list of peers. Default is 30 minutes.
1743 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1744 * connected to a mesh gate in mesh formation info. If false, the
1745 * value in mesh formation is determined by the presence of root paths
1746 * in the mesh path table
1748 struct mesh_config
{
1749 u16 dot11MeshRetryTimeout
;
1750 u16 dot11MeshConfirmTimeout
;
1751 u16 dot11MeshHoldingTimeout
;
1752 u16 dot11MeshMaxPeerLinks
;
1753 u8 dot11MeshMaxRetries
;
1756 bool auto_open_plinks
;
1757 u32 dot11MeshNbrOffsetMaxNeighbor
;
1758 u8 dot11MeshHWMPmaxPREQretries
;
1759 u32 path_refresh_time
;
1760 u16 min_discovery_timeout
;
1761 u32 dot11MeshHWMPactivePathTimeout
;
1762 u16 dot11MeshHWMPpreqMinInterval
;
1763 u16 dot11MeshHWMPperrMinInterval
;
1764 u16 dot11MeshHWMPnetDiameterTraversalTime
;
1765 u8 dot11MeshHWMPRootMode
;
1766 bool dot11MeshConnectedToMeshGate
;
1767 u16 dot11MeshHWMPRannInterval
;
1768 bool dot11MeshGateAnnouncementProtocol
;
1769 bool dot11MeshForwarding
;
1772 u32 dot11MeshHWMPactivePathToRootTimeout
;
1773 u16 dot11MeshHWMProotInterval
;
1774 u16 dot11MeshHWMPconfirmationInterval
;
1775 enum nl80211_mesh_power_mode power_mode
;
1776 u16 dot11MeshAwakeWindowDuration
;
1781 * struct mesh_setup - 802.11s mesh setup configuration
1782 * @chandef: defines the channel to use
1783 * @mesh_id: the mesh ID
1784 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1785 * @sync_method: which synchronization method to use
1786 * @path_sel_proto: which path selection protocol to use
1787 * @path_metric: which metric to use
1788 * @auth_id: which authentication method this mesh is using
1789 * @ie: vendor information elements (optional)
1790 * @ie_len: length of vendor information elements
1791 * @is_authenticated: this mesh requires authentication
1792 * @is_secure: this mesh uses security
1793 * @user_mpm: userspace handles all MPM functions
1794 * @dtim_period: DTIM period to use
1795 * @beacon_interval: beacon interval to use
1796 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1797 * @basic_rates: basic rates to use when creating the mesh
1798 * @beacon_rate: bitrate to be used for beacons
1799 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1800 * changes the channel when a radar is detected. This is required
1801 * to operate on DFS channels.
1802 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1803 * port frames over NL80211 instead of the network interface.
1805 * These parameters are fixed when the mesh is created.
1808 struct cfg80211_chan_def chandef
;
1817 bool is_authenticated
;
1821 u16 beacon_interval
;
1822 int mcast_rate
[NUM_NL80211_BANDS
];
1824 struct cfg80211_bitrate_mask beacon_rate
;
1825 bool userspace_handles_dfs
;
1826 bool control_port_over_nl80211
;
1830 * struct ocb_setup - 802.11p OCB mode setup configuration
1831 * @chandef: defines the channel to use
1833 * These parameters are fixed when connecting to the network
1836 struct cfg80211_chan_def chandef
;
1840 * struct ieee80211_txq_params - TX queue parameters
1841 * @ac: AC identifier
1842 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1843 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1845 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1847 * @aifs: Arbitration interframe space [0..255]
1849 struct ieee80211_txq_params
{
1858 * DOC: Scanning and BSS list handling
1860 * The scanning process itself is fairly simple, but cfg80211 offers quite
1861 * a bit of helper functionality. To start a scan, the scan operation will
1862 * be invoked with a scan definition. This scan definition contains the
1863 * channels to scan, and the SSIDs to send probe requests for (including the
1864 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1865 * probe. Additionally, a scan request may contain extra information elements
1866 * that should be added to the probe request. The IEs are guaranteed to be
1867 * well-formed, and will not exceed the maximum length the driver advertised
1868 * in the wiphy structure.
1870 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1871 * it is responsible for maintaining the BSS list; the driver should not
1872 * maintain a list itself. For this notification, various functions exist.
1874 * Since drivers do not maintain a BSS list, there are also a number of
1875 * functions to search for a BSS and obtain information about it from the
1876 * BSS structure cfg80211 maintains. The BSS list is also made available
1881 * struct cfg80211_ssid - SSID description
1883 * @ssid_len: length of the ssid
1885 struct cfg80211_ssid
{
1886 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
1891 * struct cfg80211_scan_info - information about completed scan
1892 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1893 * wireless device that requested the scan is connected to. If this
1894 * information is not available, this field is left zero.
1895 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1896 * @aborted: set to true if the scan was aborted for any reason,
1897 * userspace will be notified of that
1899 struct cfg80211_scan_info
{
1901 u8 tsf_bssid
[ETH_ALEN
] __aligned(2);
1906 * struct cfg80211_scan_request - scan request description
1908 * @ssids: SSIDs to scan for (active scan only)
1909 * @n_ssids: number of SSIDs
1910 * @channels: channels to scan on.
1911 * @n_channels: total number of channels to scan
1912 * @scan_width: channel width for scanning
1913 * @ie: optional information element(s) to add into Probe Request or %NULL
1914 * @ie_len: length of ie in octets
1915 * @duration: how long to listen on each channel, in TUs. If
1916 * %duration_mandatory is not set, this is the maximum dwell time and
1917 * the actual dwell time may be shorter.
1918 * @duration_mandatory: if set, the scan duration must be as specified by the
1920 * @flags: bit field of flags controlling operation
1921 * @rates: bitmap of rates to advertise for each band
1922 * @wiphy: the wiphy this was for
1923 * @scan_start: time (in jiffies) when the scan started
1924 * @wdev: the wireless device to scan for
1925 * @info: (internal) information about completed scan
1926 * @notified: (internal) scan request was notified as done or aborted
1927 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1928 * @mac_addr: MAC address used with randomisation
1929 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1930 * are 0 in the mask should be randomised, bits that are 1 should
1931 * be taken from the @mac_addr
1932 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1934 struct cfg80211_scan_request
{
1935 struct cfg80211_ssid
*ssids
;
1938 enum nl80211_bss_scan_width scan_width
;
1942 bool duration_mandatory
;
1945 u32 rates
[NUM_NL80211_BANDS
];
1947 struct wireless_dev
*wdev
;
1949 u8 mac_addr
[ETH_ALEN
] __aligned(2);
1950 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
1951 u8 bssid
[ETH_ALEN
] __aligned(2);
1954 struct wiphy
*wiphy
;
1955 unsigned long scan_start
;
1956 struct cfg80211_scan_info info
;
1961 struct ieee80211_channel
*channels
[0];
1964 static inline void get_random_mask_addr(u8
*buf
, const u8
*addr
, const u8
*mask
)
1968 get_random_bytes(buf
, ETH_ALEN
);
1969 for (i
= 0; i
< ETH_ALEN
; i
++) {
1971 buf
[i
] |= addr
[i
] & mask
[i
];
1976 * struct cfg80211_match_set - sets of attributes to match
1978 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1979 * or no match (RSSI only)
1980 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1981 * or no match (RSSI only)
1982 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1983 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
1984 * for filtering out scan results received. Drivers advertize this support
1985 * of band specific rssi based filtering through the feature capability
1986 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
1987 * specific rssi thresholds take precedence over rssi_thold, if specified.
1988 * If not specified for any band, it will be assigned with rssi_thold of
1989 * corresponding matchset.
1991 struct cfg80211_match_set
{
1992 struct cfg80211_ssid ssid
;
1995 s32 per_band_rssi_thold
[NUM_NL80211_BANDS
];
1999 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2001 * @interval: interval between scheduled scan iterations. In seconds.
2002 * @iterations: number of scan iterations in this scan plan. Zero means
2004 * The last scan plan will always have this parameter set to zero,
2005 * all other scan plans will have a finite number of iterations.
2007 struct cfg80211_sched_scan_plan
{
2013 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2015 * @band: band of BSS which should match for RSSI level adjustment.
2016 * @delta: value of RSSI level adjustment.
2018 struct cfg80211_bss_select_adjust
{
2019 enum nl80211_band band
;
2024 * struct cfg80211_sched_scan_request - scheduled scan request description
2026 * @reqid: identifies this request.
2027 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2028 * @n_ssids: number of SSIDs
2029 * @n_channels: total number of channels to scan
2030 * @scan_width: channel width for scanning
2031 * @ie: optional information element(s) to add into Probe Request or %NULL
2032 * @ie_len: length of ie in octets
2033 * @flags: bit field of flags controlling operation
2034 * @match_sets: sets of parameters to be matched for a scan result
2035 * entry to be considered valid and to be passed to the host
2036 * (others are filtered out).
2037 * If ommited, all results are passed.
2038 * @n_match_sets: number of match sets
2039 * @report_results: indicates that results were reported for this request
2040 * @wiphy: the wiphy this was for
2041 * @dev: the interface
2042 * @scan_start: start time of the scheduled scan
2043 * @channels: channels to scan
2044 * @min_rssi_thold: for drivers only supporting a single threshold, this
2045 * contains the minimum over all matchsets
2046 * @mac_addr: MAC address used with randomisation
2047 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2048 * are 0 in the mask should be randomised, bits that are 1 should
2049 * be taken from the @mac_addr
2050 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2051 * index must be executed first.
2052 * @n_scan_plans: number of scan plans, at least 1.
2053 * @rcu_head: RCU callback used to free the struct
2054 * @owner_nlportid: netlink portid of owner (if this should is a request
2055 * owned by a particular socket)
2056 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2057 * @list: for keeping list of requests.
2058 * @delay: delay in seconds to use before starting the first scan
2059 * cycle. The driver may ignore this parameter and start
2060 * immediately (or at any other time), if this feature is not
2062 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2063 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2064 * reporting in connected state to cases where a matching BSS is determined
2065 * to have better or slightly worse RSSI than the current connected BSS.
2066 * The relative RSSI threshold values are ignored in disconnected state.
2067 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2068 * to the specified band while deciding whether a better BSS is reported
2069 * using @relative_rssi. If delta is a negative number, the BSSs that
2070 * belong to the specified band will be penalized by delta dB in relative
2073 struct cfg80211_sched_scan_request
{
2075 struct cfg80211_ssid
*ssids
;
2078 enum nl80211_bss_scan_width scan_width
;
2082 struct cfg80211_match_set
*match_sets
;
2086 struct cfg80211_sched_scan_plan
*scan_plans
;
2089 u8 mac_addr
[ETH_ALEN
] __aligned(2);
2090 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
2092 bool relative_rssi_set
;
2094 struct cfg80211_bss_select_adjust rssi_adjust
;
2097 struct wiphy
*wiphy
;
2098 struct net_device
*dev
;
2099 unsigned long scan_start
;
2100 bool report_results
;
2101 struct rcu_head rcu_head
;
2104 struct list_head list
;
2107 struct ieee80211_channel
*channels
[0];
2111 * enum cfg80211_signal_type - signal type
2113 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2114 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2115 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2117 enum cfg80211_signal_type
{
2118 CFG80211_SIGNAL_TYPE_NONE
,
2119 CFG80211_SIGNAL_TYPE_MBM
,
2120 CFG80211_SIGNAL_TYPE_UNSPEC
,
2124 * struct cfg80211_inform_bss - BSS inform data
2125 * @chan: channel the frame was received on
2126 * @scan_width: scan width that was used
2127 * @signal: signal strength value, according to the wiphy's
2129 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2130 * received; should match the time when the frame was actually
2131 * received by the device (not just by the host, in case it was
2132 * buffered on the device) and be accurate to about 10ms.
2133 * If the frame isn't buffered, just passing the return value of
2134 * ktime_get_boottime_ns() is likely appropriate.
2135 * @parent_tsf: the time at the start of reception of the first octet of the
2136 * timestamp field of the frame. The time is the TSF of the BSS specified
2138 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2139 * the BSS that requested the scan in which the beacon/probe was received.
2140 * @chains: bitmask for filled values in @chain_signal.
2141 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2143 struct cfg80211_inform_bss
{
2144 struct ieee80211_channel
*chan
;
2145 enum nl80211_bss_scan_width scan_width
;
2149 u8 parent_bssid
[ETH_ALEN
] __aligned(2);
2151 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
2155 * struct cfg80211_bss_ies - BSS entry IE data
2156 * @tsf: TSF contained in the frame that carried these IEs
2157 * @rcu_head: internal use, for freeing
2158 * @len: length of the IEs
2159 * @from_beacon: these IEs are known to come from a beacon
2162 struct cfg80211_bss_ies
{
2164 struct rcu_head rcu_head
;
2171 * struct cfg80211_bss - BSS description
2173 * This structure describes a BSS (which may also be a mesh network)
2174 * for use in scan results and similar.
2176 * @channel: channel this BSS is on
2177 * @scan_width: width of the control channel
2178 * @bssid: BSSID of the BSS
2179 * @beacon_interval: the beacon interval as from the frame
2180 * @capability: the capability field in host byte order
2181 * @ies: the information elements (Note that there is no guarantee that these
2182 * are well-formed!); this is a pointer to either the beacon_ies or
2183 * proberesp_ies depending on whether Probe Response frame has been
2184 * received. It is always non-%NULL.
2185 * @beacon_ies: the information elements from the last Beacon frame
2186 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2187 * own the beacon_ies, but they're just pointers to the ones from the
2188 * @hidden_beacon_bss struct)
2189 * @proberesp_ies: the information elements from the last Probe Response frame
2190 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2191 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2192 * that holds the beacon data. @beacon_ies is still valid, of course, and
2193 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2194 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2195 * non-transmitted one (multi-BSSID support)
2196 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2197 * (multi-BSSID support)
2198 * @signal: signal strength value (type depends on the wiphy's signal_type)
2199 * @chains: bitmask for filled values in @chain_signal.
2200 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2201 * @bssid_index: index in the multiple BSS set
2202 * @max_bssid_indicator: max number of members in the BSS set
2203 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2205 struct cfg80211_bss
{
2206 struct ieee80211_channel
*channel
;
2207 enum nl80211_bss_scan_width scan_width
;
2209 const struct cfg80211_bss_ies __rcu
*ies
;
2210 const struct cfg80211_bss_ies __rcu
*beacon_ies
;
2211 const struct cfg80211_bss_ies __rcu
*proberesp_ies
;
2213 struct cfg80211_bss
*hidden_beacon_bss
;
2214 struct cfg80211_bss
*transmitted_bss
;
2215 struct list_head nontrans_list
;
2219 u16 beacon_interval
;
2224 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
2227 u8 max_bssid_indicator
;
2229 u8 priv
[0] __aligned(sizeof(void *));
2233 * ieee80211_bss_get_elem - find element with given ID
2234 * @bss: the bss to search
2235 * @id: the element ID
2237 * Note that the return value is an RCU-protected pointer, so
2238 * rcu_read_lock() must be held when calling this function.
2239 * Return: %NULL if not found.
2241 const struct element
*ieee80211_bss_get_elem(struct cfg80211_bss
*bss
, u8 id
);
2244 * ieee80211_bss_get_ie - find IE with given ID
2245 * @bss: the bss to search
2246 * @id: the element ID
2248 * Note that the return value is an RCU-protected pointer, so
2249 * rcu_read_lock() must be held when calling this function.
2250 * Return: %NULL if not found.
2252 static inline const u8
*ieee80211_bss_get_ie(struct cfg80211_bss
*bss
, u8 id
)
2254 return (void *)ieee80211_bss_get_elem(bss
, id
);
2259 * struct cfg80211_auth_request - Authentication request data
2261 * This structure provides information needed to complete IEEE 802.11
2264 * @bss: The BSS to authenticate with, the callee must obtain a reference
2265 * to it if it needs to keep it.
2266 * @auth_type: Authentication type (algorithm)
2267 * @ie: Extra IEs to add to Authentication frame or %NULL
2268 * @ie_len: Length of ie buffer in octets
2269 * @key_len: length of WEP key for shared key authentication
2270 * @key_idx: index of WEP key for shared key authentication
2271 * @key: WEP key for shared key authentication
2272 * @auth_data: Fields and elements in Authentication frames. This contains
2273 * the authentication frame body (non-IE and IE data), excluding the
2274 * Authentication algorithm number, i.e., starting at the Authentication
2275 * transaction sequence number field.
2276 * @auth_data_len: Length of auth_data buffer in octets
2278 struct cfg80211_auth_request
{
2279 struct cfg80211_bss
*bss
;
2282 enum nl80211_auth_type auth_type
;
2284 u8 key_len
, key_idx
;
2285 const u8
*auth_data
;
2286 size_t auth_data_len
;
2290 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2292 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2293 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2294 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2295 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2296 * authentication capability. Drivers can offload authentication to
2297 * userspace if this flag is set. Only applicable for cfg80211_connect()
2298 * request (connect callback).
2300 enum cfg80211_assoc_req_flags
{
2301 ASSOC_REQ_DISABLE_HT
= BIT(0),
2302 ASSOC_REQ_DISABLE_VHT
= BIT(1),
2303 ASSOC_REQ_USE_RRM
= BIT(2),
2304 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT
= BIT(3),
2308 * struct cfg80211_assoc_request - (Re)Association request data
2310 * This structure provides information needed to complete IEEE 802.11
2312 * @bss: The BSS to associate with. If the call is successful the driver is
2313 * given a reference that it must give back to cfg80211_send_rx_assoc()
2314 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2315 * association requests while already associating must be rejected.
2316 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2317 * @ie_len: Length of ie buffer in octets
2318 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2319 * @crypto: crypto settings
2320 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2321 * to indicate a request to reassociate within the ESS instead of a request
2322 * do the initial association with the ESS. When included, this is set to
2323 * the BSSID of the current association, i.e., to the value that is
2324 * included in the Current AP address field of the Reassociation Request
2326 * @flags: See &enum cfg80211_assoc_req_flags
2327 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2328 * will be used in ht_capa. Un-supported values will be ignored.
2329 * @ht_capa_mask: The bits of ht_capa which are to be used.
2330 * @vht_capa: VHT capability override
2331 * @vht_capa_mask: VHT capability mask indicating which fields to use
2332 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2333 * %NULL if FILS is not used.
2334 * @fils_kek_len: Length of fils_kek in octets
2335 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2336 * Request/Response frame or %NULL if FILS is not used. This field starts
2337 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2339 struct cfg80211_assoc_request
{
2340 struct cfg80211_bss
*bss
;
2341 const u8
*ie
, *prev_bssid
;
2343 struct cfg80211_crypto_settings crypto
;
2346 struct ieee80211_ht_cap ht_capa
;
2347 struct ieee80211_ht_cap ht_capa_mask
;
2348 struct ieee80211_vht_cap vht_capa
, vht_capa_mask
;
2350 size_t fils_kek_len
;
2351 const u8
*fils_nonces
;
2355 * struct cfg80211_deauth_request - Deauthentication request data
2357 * This structure provides information needed to complete IEEE 802.11
2360 * @bssid: the BSSID of the BSS to deauthenticate from
2361 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2362 * @ie_len: Length of ie buffer in octets
2363 * @reason_code: The reason code for the deauthentication
2364 * @local_state_change: if set, change local state only and
2365 * do not set a deauth frame
2367 struct cfg80211_deauth_request
{
2372 bool local_state_change
;
2376 * struct cfg80211_disassoc_request - Disassociation request data
2378 * This structure provides information needed to complete IEEE 802.11
2381 * @bss: the BSS to disassociate from
2382 * @ie: Extra IEs to add to Disassociation frame or %NULL
2383 * @ie_len: Length of ie buffer in octets
2384 * @reason_code: The reason code for the disassociation
2385 * @local_state_change: This is a request for a local state only, i.e., no
2386 * Disassociation frame is to be transmitted.
2388 struct cfg80211_disassoc_request
{
2389 struct cfg80211_bss
*bss
;
2393 bool local_state_change
;
2397 * struct cfg80211_ibss_params - IBSS parameters
2399 * This structure defines the IBSS parameters for the join_ibss()
2402 * @ssid: The SSID, will always be non-null.
2403 * @ssid_len: The length of the SSID, will always be non-zero.
2404 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2405 * search for IBSSs with a different BSSID.
2406 * @chandef: defines the channel to use if no other IBSS to join can be found
2407 * @channel_fixed: The channel should be fixed -- do not search for
2408 * IBSSs to join on other channels.
2409 * @ie: information element(s) to include in the beacon
2410 * @ie_len: length of that
2411 * @beacon_interval: beacon interval to use
2412 * @privacy: this is a protected network, keys will be configured
2414 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2415 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2416 * required to assume that the port is unauthorized until authorized by
2417 * user space. Otherwise, port is marked authorized by default.
2418 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2419 * port frames over NL80211 instead of the network interface.
2420 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2421 * changes the channel when a radar is detected. This is required
2422 * to operate on DFS channels.
2423 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2424 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2425 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2426 * will be used in ht_capa. Un-supported values will be ignored.
2427 * @ht_capa_mask: The bits of ht_capa which are to be used.
2428 * @wep_keys: static WEP keys, if not NULL points to an array of
2429 * CFG80211_MAX_WEP_KEYS WEP keys
2430 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2432 struct cfg80211_ibss_params
{
2435 struct cfg80211_chan_def chandef
;
2437 u8 ssid_len
, ie_len
;
2438 u16 beacon_interval
;
2443 bool control_port_over_nl80211
;
2444 bool userspace_handles_dfs
;
2445 int mcast_rate
[NUM_NL80211_BANDS
];
2446 struct ieee80211_ht_cap ht_capa
;
2447 struct ieee80211_ht_cap ht_capa_mask
;
2448 struct key_params
*wep_keys
;
2453 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2455 * @behaviour: requested BSS selection behaviour.
2456 * @param: parameters for requestion behaviour.
2457 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2458 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2460 struct cfg80211_bss_selection
{
2461 enum nl80211_bss_select_attr behaviour
;
2463 enum nl80211_band band_pref
;
2464 struct cfg80211_bss_select_adjust adjust
;
2469 * struct cfg80211_connect_params - Connection parameters
2471 * This structure provides information needed to complete IEEE 802.11
2472 * authentication and association.
2474 * @channel: The channel to use or %NULL if not specified (auto-select based
2476 * @channel_hint: The channel of the recommended BSS for initial connection or
2477 * %NULL if not specified
2478 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2480 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2481 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2482 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2485 * @ssid_len: Length of ssid in octets
2486 * @auth_type: Authentication type (algorithm)
2487 * @ie: IEs for association request
2488 * @ie_len: Length of assoc_ie in octets
2489 * @privacy: indicates whether privacy-enabled APs should be used
2490 * @mfp: indicate whether management frame protection is used
2491 * @crypto: crypto settings
2492 * @key_len: length of WEP key for shared key authentication
2493 * @key_idx: index of WEP key for shared key authentication
2494 * @key: WEP key for shared key authentication
2495 * @flags: See &enum cfg80211_assoc_req_flags
2496 * @bg_scan_period: Background scan period in seconds
2497 * or -1 to indicate that default value is to be used.
2498 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2499 * will be used in ht_capa. Un-supported values will be ignored.
2500 * @ht_capa_mask: The bits of ht_capa which are to be used.
2501 * @vht_capa: VHT Capability overrides
2502 * @vht_capa_mask: The bits of vht_capa which are to be used.
2503 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2505 * @bss_select: criteria to be used for BSS selection.
2506 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2507 * to indicate a request to reassociate within the ESS instead of a request
2508 * do the initial association with the ESS. When included, this is set to
2509 * the BSSID of the current association, i.e., to the value that is
2510 * included in the Current AP address field of the Reassociation Request
2512 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2513 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2515 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2516 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2517 * %NULL if not specified. This specifies the domain name of ER server and
2518 * is used to construct FILS wrapped data IE.
2519 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2520 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2521 * messages. This is also used to construct FILS wrapped data IE.
2522 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2523 * keys in FILS or %NULL if not specified.
2524 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2525 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2526 * offload of 4-way handshake.
2527 * @edmg: define the EDMG channels.
2528 * This may specify multiple channels and bonding options for the driver
2529 * to choose from, based on BSS configuration.
2531 struct cfg80211_connect_params
{
2532 struct ieee80211_channel
*channel
;
2533 struct ieee80211_channel
*channel_hint
;
2535 const u8
*bssid_hint
;
2538 enum nl80211_auth_type auth_type
;
2542 enum nl80211_mfp mfp
;
2543 struct cfg80211_crypto_settings crypto
;
2545 u8 key_len
, key_idx
;
2548 struct ieee80211_ht_cap ht_capa
;
2549 struct ieee80211_ht_cap ht_capa_mask
;
2550 struct ieee80211_vht_cap vht_capa
;
2551 struct ieee80211_vht_cap vht_capa_mask
;
2553 struct cfg80211_bss_selection bss_select
;
2554 const u8
*prev_bssid
;
2555 const u8
*fils_erp_username
;
2556 size_t fils_erp_username_len
;
2557 const u8
*fils_erp_realm
;
2558 size_t fils_erp_realm_len
;
2559 u16 fils_erp_next_seq_num
;
2560 const u8
*fils_erp_rrk
;
2561 size_t fils_erp_rrk_len
;
2563 struct ieee80211_edmg edmg
;
2567 * enum cfg80211_connect_params_changed - Connection parameters being updated
2569 * This enum provides information of all connect parameters that
2570 * have to be updated as part of update_connect_params() call.
2572 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2573 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2574 * username, erp sequence number and rrk) are updated
2575 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2577 enum cfg80211_connect_params_changed
{
2578 UPDATE_ASSOC_IES
= BIT(0),
2579 UPDATE_FILS_ERP_INFO
= BIT(1),
2580 UPDATE_AUTH_TYPE
= BIT(2),
2584 * enum wiphy_params_flags - set_wiphy_params bitfield values
2585 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2586 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2587 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2588 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2589 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2590 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2591 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2592 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2593 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2595 enum wiphy_params_flags
{
2596 WIPHY_PARAM_RETRY_SHORT
= 1 << 0,
2597 WIPHY_PARAM_RETRY_LONG
= 1 << 1,
2598 WIPHY_PARAM_FRAG_THRESHOLD
= 1 << 2,
2599 WIPHY_PARAM_RTS_THRESHOLD
= 1 << 3,
2600 WIPHY_PARAM_COVERAGE_CLASS
= 1 << 4,
2601 WIPHY_PARAM_DYN_ACK
= 1 << 5,
2602 WIPHY_PARAM_TXQ_LIMIT
= 1 << 6,
2603 WIPHY_PARAM_TXQ_MEMORY_LIMIT
= 1 << 7,
2604 WIPHY_PARAM_TXQ_QUANTUM
= 1 << 8,
2607 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2609 /* The per TXQ device queue limit in airtime */
2610 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2611 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2613 /* The per interface airtime threshold to switch to lower queue limit */
2614 #define IEEE80211_AQL_THRESHOLD 24000
2617 * struct cfg80211_pmksa - PMK Security Association
2619 * This structure is passed to the set/del_pmksa() method for PMKSA
2622 * @bssid: The AP's BSSID (may be %NULL).
2623 * @pmkid: The identifier to refer a PMKSA.
2624 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2625 * derivation by a FILS STA. Otherwise, %NULL.
2626 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2627 * the hash algorithm used to generate this.
2628 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2629 * cache identifier (may be %NULL).
2630 * @ssid_len: Length of the @ssid in octets.
2631 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2632 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2635 struct cfg80211_pmksa
{
2646 * struct cfg80211_pkt_pattern - packet pattern
2647 * @mask: bitmask where to match pattern and where to ignore bytes,
2648 * one bit per byte, in same format as nl80211
2649 * @pattern: bytes to match where bitmask is 1
2650 * @pattern_len: length of pattern (in bytes)
2651 * @pkt_offset: packet offset (in bytes)
2653 * Internal note: @mask and @pattern are allocated in one chunk of
2654 * memory, free @mask only!
2656 struct cfg80211_pkt_pattern
{
2657 const u8
*mask
, *pattern
;
2663 * struct cfg80211_wowlan_tcp - TCP connection parameters
2665 * @sock: (internal) socket for source port allocation
2666 * @src: source IP address
2667 * @dst: destination IP address
2668 * @dst_mac: destination MAC address
2669 * @src_port: source port
2670 * @dst_port: destination port
2671 * @payload_len: data payload length
2672 * @payload: data payload buffer
2673 * @payload_seq: payload sequence stamping configuration
2674 * @data_interval: interval at which to send data packets
2675 * @wake_len: wakeup payload match length
2676 * @wake_data: wakeup payload match data
2677 * @wake_mask: wakeup payload match mask
2678 * @tokens_size: length of the tokens buffer
2679 * @payload_tok: payload token usage configuration
2681 struct cfg80211_wowlan_tcp
{
2682 struct socket
*sock
;
2684 u16 src_port
, dst_port
;
2685 u8 dst_mac
[ETH_ALEN
];
2688 struct nl80211_wowlan_tcp_data_seq payload_seq
;
2691 const u8
*wake_data
, *wake_mask
;
2693 /* must be last, variable member */
2694 struct nl80211_wowlan_tcp_data_token payload_tok
;
2698 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2700 * This structure defines the enabled WoWLAN triggers for the device.
2701 * @any: wake up on any activity -- special trigger if device continues
2702 * operating as normal during suspend
2703 * @disconnect: wake up if getting disconnected
2704 * @magic_pkt: wake up on receiving magic packet
2705 * @patterns: wake up on receiving packet matching a pattern
2706 * @n_patterns: number of patterns
2707 * @gtk_rekey_failure: wake up on GTK rekey failure
2708 * @eap_identity_req: wake up on EAP identity request packet
2709 * @four_way_handshake: wake up on 4-way handshake
2710 * @rfkill_release: wake up when rfkill is released
2711 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2712 * NULL if not configured.
2713 * @nd_config: configuration for the scan to be used for net detect wake.
2715 struct cfg80211_wowlan
{
2716 bool any
, disconnect
, magic_pkt
, gtk_rekey_failure
,
2717 eap_identity_req
, four_way_handshake
,
2719 struct cfg80211_pkt_pattern
*patterns
;
2720 struct cfg80211_wowlan_tcp
*tcp
;
2722 struct cfg80211_sched_scan_request
*nd_config
;
2726 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2728 * This structure defines coalesce rule for the device.
2729 * @delay: maximum coalescing delay in msecs.
2730 * @condition: condition for packet coalescence.
2731 * see &enum nl80211_coalesce_condition.
2732 * @patterns: array of packet patterns
2733 * @n_patterns: number of patterns
2735 struct cfg80211_coalesce_rules
{
2737 enum nl80211_coalesce_condition condition
;
2738 struct cfg80211_pkt_pattern
*patterns
;
2743 * struct cfg80211_coalesce - Packet coalescing settings
2745 * This structure defines coalescing settings.
2746 * @rules: array of coalesce rules
2747 * @n_rules: number of rules
2749 struct cfg80211_coalesce
{
2750 struct cfg80211_coalesce_rules
*rules
;
2755 * struct cfg80211_wowlan_nd_match - information about the match
2757 * @ssid: SSID of the match that triggered the wake up
2758 * @n_channels: Number of channels where the match occurred. This
2759 * value may be zero if the driver can't report the channels.
2760 * @channels: center frequencies of the channels where a match
2763 struct cfg80211_wowlan_nd_match
{
2764 struct cfg80211_ssid ssid
;
2770 * struct cfg80211_wowlan_nd_info - net detect wake up information
2772 * @n_matches: Number of match information instances provided in
2773 * @matches. This value may be zero if the driver can't provide
2774 * match information.
2775 * @matches: Array of pointers to matches containing information about
2776 * the matches that triggered the wake up.
2778 struct cfg80211_wowlan_nd_info
{
2780 struct cfg80211_wowlan_nd_match
*matches
[];
2784 * struct cfg80211_wowlan_wakeup - wakeup report
2785 * @disconnect: woke up by getting disconnected
2786 * @magic_pkt: woke up by receiving magic packet
2787 * @gtk_rekey_failure: woke up by GTK rekey failure
2788 * @eap_identity_req: woke up by EAP identity request packet
2789 * @four_way_handshake: woke up by 4-way handshake
2790 * @rfkill_release: woke up by rfkill being released
2791 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2792 * @packet_present_len: copied wakeup packet data
2793 * @packet_len: original wakeup packet length
2794 * @packet: The packet causing the wakeup, if any.
2795 * @packet_80211: For pattern match, magic packet and other data
2796 * frame triggers an 802.3 frame should be reported, for
2797 * disconnect due to deauth 802.11 frame. This indicates which
2799 * @tcp_match: TCP wakeup packet received
2800 * @tcp_connlost: TCP connection lost or failed to establish
2801 * @tcp_nomoretokens: TCP data ran out of tokens
2802 * @net_detect: if not %NULL, woke up because of net detect
2804 struct cfg80211_wowlan_wakeup
{
2805 bool disconnect
, magic_pkt
, gtk_rekey_failure
,
2806 eap_identity_req
, four_way_handshake
,
2807 rfkill_release
, packet_80211
,
2808 tcp_match
, tcp_connlost
, tcp_nomoretokens
;
2810 u32 packet_present_len
, packet_len
;
2812 struct cfg80211_wowlan_nd_info
*net_detect
;
2816 * struct cfg80211_gtk_rekey_data - rekey data
2817 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2818 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2819 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2821 struct cfg80211_gtk_rekey_data
{
2822 const u8
*kek
, *kck
, *replay_ctr
;
2826 * struct cfg80211_update_ft_ies_params - FT IE Information
2828 * This structure provides information needed to update the fast transition IE
2830 * @md: The Mobility Domain ID, 2 Octet value
2831 * @ie: Fast Transition IEs
2832 * @ie_len: Length of ft_ie in octets
2834 struct cfg80211_update_ft_ies_params
{
2841 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2843 * This structure provides information needed to transmit a mgmt frame
2845 * @chan: channel to use
2846 * @offchan: indicates wether off channel operation is required
2847 * @wait: duration for ROC
2848 * @buf: buffer to transmit
2849 * @len: buffer length
2850 * @no_cck: don't use cck rates for this frame
2851 * @dont_wait_for_ack: tells the low level not to wait for an ack
2852 * @n_csa_offsets: length of csa_offsets array
2853 * @csa_offsets: array of all the csa offsets in the frame
2855 struct cfg80211_mgmt_tx_params
{
2856 struct ieee80211_channel
*chan
;
2862 bool dont_wait_for_ack
;
2864 const u16
*csa_offsets
;
2868 * struct cfg80211_dscp_exception - DSCP exception
2870 * @dscp: DSCP value that does not adhere to the user priority range definition
2871 * @up: user priority value to which the corresponding DSCP value belongs
2873 struct cfg80211_dscp_exception
{
2879 * struct cfg80211_dscp_range - DSCP range definition for user priority
2881 * @low: lowest DSCP value of this user priority range, inclusive
2882 * @high: highest DSCP value of this user priority range, inclusive
2884 struct cfg80211_dscp_range
{
2889 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2890 #define IEEE80211_QOS_MAP_MAX_EX 21
2891 #define IEEE80211_QOS_MAP_LEN_MIN 16
2892 #define IEEE80211_QOS_MAP_LEN_MAX \
2893 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2896 * struct cfg80211_qos_map - QoS Map Information
2898 * This struct defines the Interworking QoS map setting for DSCP values
2900 * @num_des: number of DSCP exceptions (0..21)
2901 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2902 * the user priority DSCP range definition
2903 * @up: DSCP range definition for a particular user priority
2905 struct cfg80211_qos_map
{
2907 struct cfg80211_dscp_exception dscp_exception
[IEEE80211_QOS_MAP_MAX_EX
];
2908 struct cfg80211_dscp_range up
[8];
2912 * struct cfg80211_nan_conf - NAN configuration
2914 * This struct defines NAN configuration parameters
2916 * @master_pref: master preference (1 - 255)
2917 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2918 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2919 * (i.e. BIT(NL80211_BAND_2GHZ)).
2921 struct cfg80211_nan_conf
{
2927 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2930 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2931 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2933 enum cfg80211_nan_conf_changes
{
2934 CFG80211_NAN_CONF_CHANGED_PREF
= BIT(0),
2935 CFG80211_NAN_CONF_CHANGED_BANDS
= BIT(1),
2939 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2941 * @filter: the content of the filter
2942 * @len: the length of the filter
2944 struct cfg80211_nan_func_filter
{
2950 * struct cfg80211_nan_func - a NAN function
2952 * @type: &enum nl80211_nan_function_type
2953 * @service_id: the service ID of the function
2954 * @publish_type: &nl80211_nan_publish_type
2955 * @close_range: if true, the range should be limited. Threshold is
2956 * implementation specific.
2957 * @publish_bcast: if true, the solicited publish should be broadcasted
2958 * @subscribe_active: if true, the subscribe is active
2959 * @followup_id: the instance ID for follow up
2960 * @followup_reqid: the requestor instance ID for follow up
2961 * @followup_dest: MAC address of the recipient of the follow up
2962 * @ttl: time to live counter in DW.
2963 * @serv_spec_info: Service Specific Info
2964 * @serv_spec_info_len: Service Specific Info length
2965 * @srf_include: if true, SRF is inclusive
2966 * @srf_bf: Bloom Filter
2967 * @srf_bf_len: Bloom Filter length
2968 * @srf_bf_idx: Bloom Filter index
2969 * @srf_macs: SRF MAC addresses
2970 * @srf_num_macs: number of MAC addresses in SRF
2971 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2972 * @tx_filters: filters that should be transmitted in the SDF.
2973 * @num_rx_filters: length of &rx_filters.
2974 * @num_tx_filters: length of &tx_filters.
2975 * @instance_id: driver allocated id of the function.
2976 * @cookie: unique NAN function identifier.
2978 struct cfg80211_nan_func
{
2979 enum nl80211_nan_function_type type
;
2980 u8 service_id
[NL80211_NAN_FUNC_SERVICE_ID_LEN
];
2984 bool subscribe_active
;
2987 struct mac_address followup_dest
;
2989 const u8
*serv_spec_info
;
2990 u8 serv_spec_info_len
;
2995 struct mac_address
*srf_macs
;
2997 struct cfg80211_nan_func_filter
*rx_filters
;
2998 struct cfg80211_nan_func_filter
*tx_filters
;
3006 * struct cfg80211_pmk_conf - PMK configuration
3008 * @aa: authenticator address
3009 * @pmk_len: PMK length in bytes.
3010 * @pmk: the PMK material
3011 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3012 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3015 struct cfg80211_pmk_conf
{
3019 const u8
*pmk_r0_name
;
3023 * struct cfg80211_external_auth_params - Trigger External authentication.
3025 * Commonly used across the external auth request and event interfaces.
3027 * @action: action type / trigger for external authentication. Only significant
3028 * for the authentication request event interface (driver to user space).
3029 * @bssid: BSSID of the peer with which the authentication has
3030 * to happen. Used by both the authentication request event and
3031 * authentication response command interface.
3032 * @ssid: SSID of the AP. Used by both the authentication request event and
3033 * authentication response command interface.
3034 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3035 * authentication request event interface.
3036 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3037 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3038 * the real status code for failures. Used only for the authentication
3039 * response command interface (user space to driver).
3040 * @pmkid: The identifier to refer a PMKSA.
3042 struct cfg80211_external_auth_params
{
3043 enum nl80211_external_auth_action action
;
3044 u8 bssid
[ETH_ALEN
] __aligned(2);
3045 struct cfg80211_ssid ssid
;
3046 unsigned int key_mgmt_suite
;
3052 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3054 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3055 * indicate the relevant values in this struct for them
3056 * @success_num: number of FTM sessions in which all frames were successfully
3058 * @partial_num: number of FTM sessions in which part of frames were
3059 * successfully answered
3060 * @failed_num: number of failed FTM sessions
3061 * @asap_num: number of ASAP FTM sessions
3062 * @non_asap_num: number of non-ASAP FTM sessions
3063 * @total_duration_ms: total sessions durations - gives an indication
3064 * of how much time the responder was busy
3065 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3066 * initiators that didn't finish successfully the negotiation phase with
3068 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3069 * for a new scheduling although it already has scheduled FTM slot
3070 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3072 struct cfg80211_ftm_responder_stats
{
3079 u64 total_duration_ms
;
3080 u32 unknown_triggers_num
;
3081 u32 reschedule_requests_num
;
3082 u32 out_of_window_triggers_num
;
3086 * struct cfg80211_pmsr_ftm_result - FTM result
3087 * @failure_reason: if this measurement failed (PMSR status is
3088 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3089 * reason than just "failure"
3090 * @burst_index: if reporting partial results, this is the index
3091 * in [0 .. num_bursts-1] of the burst that's being reported
3092 * @num_ftmr_attempts: number of FTM request frames transmitted
3093 * @num_ftmr_successes: number of FTM request frames acked
3094 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3095 * fill this to indicate in how many seconds a retry is deemed possible
3097 * @num_bursts_exp: actual number of bursts exponent negotiated
3098 * @burst_duration: actual burst duration negotiated
3099 * @ftms_per_burst: actual FTMs per burst negotiated
3100 * @lci_len: length of LCI information (if present)
3101 * @civicloc_len: length of civic location information (if present)
3102 * @lci: LCI data (may be %NULL)
3103 * @civicloc: civic location data (may be %NULL)
3104 * @rssi_avg: average RSSI over FTM action frames reported
3105 * @rssi_spread: spread of the RSSI over FTM action frames reported
3106 * @tx_rate: bitrate for transmitted FTM action frame response
3107 * @rx_rate: bitrate of received FTM action frame
3108 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3109 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3110 * the square root of the variance)
3111 * @rtt_spread: spread of the RTTs measured
3112 * @dist_avg: average of distances (mm) measured
3113 * (must have either this or @rtt_avg)
3114 * @dist_variance: variance of distances measured (see also @rtt_variance)
3115 * @dist_spread: spread of distances measured (see also @rtt_spread)
3116 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3117 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3118 * @rssi_avg_valid: @rssi_avg is valid
3119 * @rssi_spread_valid: @rssi_spread is valid
3120 * @tx_rate_valid: @tx_rate is valid
3121 * @rx_rate_valid: @rx_rate is valid
3122 * @rtt_avg_valid: @rtt_avg is valid
3123 * @rtt_variance_valid: @rtt_variance is valid
3124 * @rtt_spread_valid: @rtt_spread is valid
3125 * @dist_avg_valid: @dist_avg is valid
3126 * @dist_variance_valid: @dist_variance is valid
3127 * @dist_spread_valid: @dist_spread is valid
3129 struct cfg80211_pmsr_ftm_result
{
3132 unsigned int lci_len
;
3133 unsigned int civicloc_len
;
3134 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason
;
3135 u32 num_ftmr_attempts
, num_ftmr_successes
;
3143 struct rate_info tx_rate
, rx_rate
;
3151 u16 num_ftmr_attempts_valid
:1,
3152 num_ftmr_successes_valid
:1,
3154 rssi_spread_valid
:1,
3158 rtt_variance_valid
:1,
3161 dist_variance_valid
:1,
3162 dist_spread_valid
:1;
3166 * struct cfg80211_pmsr_result - peer measurement result
3167 * @addr: address of the peer
3168 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3169 * measurement was made)
3170 * @ap_tsf: AP's TSF at measurement time
3171 * @status: status of the measurement
3172 * @final: if reporting partial results, mark this as the last one; if not
3173 * reporting partial results always set this flag
3174 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3175 * @type: type of the measurement reported, note that we only support reporting
3176 * one type at a time, but you can report multiple results separately and
3177 * they're all aggregated for userspace.
3179 struct cfg80211_pmsr_result
{
3180 u64 host_time
, ap_tsf
;
3181 enum nl80211_peer_measurement_status status
;
3188 enum nl80211_peer_measurement_type type
;
3191 struct cfg80211_pmsr_ftm_result ftm
;
3196 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3197 * @requested: indicates FTM is requested
3198 * @preamble: frame preamble to use
3199 * @burst_period: burst period to use
3200 * @asap: indicates to use ASAP mode
3201 * @num_bursts_exp: number of bursts exponent
3202 * @burst_duration: burst duration
3203 * @ftms_per_burst: number of FTMs per burst
3204 * @ftmr_retries: number of retries for FTM request
3205 * @request_lci: request LCI information
3206 * @request_civicloc: request civic location information
3208 * See also nl80211 for the respective attribute documentation.
3210 struct cfg80211_pmsr_ftm_request_peer
{
3211 enum nl80211_preamble preamble
;
3224 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3225 * @addr: MAC address
3226 * @chandef: channel to use
3227 * @report_ap_tsf: report the associated AP's TSF
3228 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3230 struct cfg80211_pmsr_request_peer
{
3232 struct cfg80211_chan_def chandef
;
3234 struct cfg80211_pmsr_ftm_request_peer ftm
;
3238 * struct cfg80211_pmsr_request - peer measurement request
3239 * @cookie: cookie, set by cfg80211
3240 * @nl_portid: netlink portid - used by cfg80211
3241 * @drv_data: driver data for this request, if required for aborting,
3242 * not otherwise freed or anything by cfg80211
3243 * @mac_addr: MAC address used for (randomised) request
3244 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3245 * are 0 in the mask should be randomised, bits that are 1 should
3246 * be taken from the @mac_addr
3247 * @list: used by cfg80211 to hold on to the request
3248 * @timeout: timeout (in milliseconds) for the whole operation, if
3249 * zero it means there's no timeout
3250 * @n_peers: number of peers to do measurements with
3251 * @peers: per-peer measurement request data
3253 struct cfg80211_pmsr_request
{
3261 u8 mac_addr
[ETH_ALEN
] __aligned(2);
3262 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
3264 struct list_head list
;
3266 struct cfg80211_pmsr_request_peer peers
[];
3270 * struct cfg80211_update_owe_info - OWE Information
3272 * This structure provides information needed for the drivers to offload OWE
3273 * (Opportunistic Wireless Encryption) processing to the user space.
3275 * Commonly used across update_owe_info request and event interfaces.
3277 * @peer: MAC address of the peer device for which the OWE processing
3279 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3280 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3281 * cannot give you the real status code for failures. Used only for
3282 * OWE update request command interface (user space to driver).
3283 * @ie: IEs obtained from the peer or constructed by the user space. These are
3284 * the IEs of the remote peer in the event from the host driver and
3285 * the constructed IEs by the user space in the request interface.
3286 * @ie_len: Length of IEs in octets.
3288 struct cfg80211_update_owe_info
{
3289 u8 peer
[ETH_ALEN
] __aligned(2);
3296 * struct cfg80211_ops - backend description for wireless configuration
3298 * This struct is registered by fullmac card drivers and/or wireless stacks
3299 * in order to handle configuration requests on their interfaces.
3301 * All callbacks except where otherwise noted should return 0
3302 * on success or a negative error code.
3304 * All operations are currently invoked under rtnl for consistency with the
3305 * wireless extensions but this is subject to reevaluation as soon as this
3306 * code is used more widely and we have a first user without wext.
3308 * @suspend: wiphy device needs to be suspended. The variable @wow will
3309 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3310 * configured for the device.
3311 * @resume: wiphy device needs to be resumed
3312 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3313 * to call device_set_wakeup_enable() to enable/disable wakeup from
3316 * @add_virtual_intf: create a new virtual interface with the given name,
3317 * must set the struct wireless_dev's iftype. Beware: You must create
3318 * the new netdev in the wiphy's network namespace! Returns the struct
3319 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3320 * also set the address member in the wdev.
3322 * @del_virtual_intf: remove the virtual interface
3324 * @change_virtual_intf: change type/configuration of virtual interface,
3325 * keep the struct wireless_dev's iftype updated.
3327 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3328 * when adding a group key.
3330 * @get_key: get information about the key with the given parameters.
3331 * @mac_addr will be %NULL when requesting information for a group
3332 * key. All pointers given to the @callback function need not be valid
3333 * after it returns. This function should return an error if it is
3334 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3336 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3337 * and @key_index, return -ENOENT if the key doesn't exist.
3339 * @set_default_key: set the default key on an interface
3341 * @set_default_mgmt_key: set the default management frame key on an interface
3343 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3345 * @start_ap: Start acting in AP mode defined by the parameters.
3346 * @change_beacon: Change the beacon parameters for an access point mode
3347 * interface. This should reject the call when AP mode wasn't started.
3348 * @stop_ap: Stop being an AP, including stopping beaconing.
3350 * @add_station: Add a new station.
3351 * @del_station: Remove a station
3352 * @change_station: Modify a given station. Note that flags changes are not much
3353 * validated in cfg80211, in particular the auth/assoc/authorized flags
3354 * might come to the driver in invalid combinations -- make sure to check
3355 * them, also against the existing state! Drivers must call
3356 * cfg80211_check_station_change() to validate the information.
3357 * @get_station: get station information for the station identified by @mac
3358 * @dump_station: dump station callback -- resume dump at index @idx
3360 * @add_mpath: add a fixed mesh path
3361 * @del_mpath: delete a given mesh path
3362 * @change_mpath: change a given mesh path
3363 * @get_mpath: get a mesh path for the given parameters
3364 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3365 * @get_mpp: get a mesh proxy path for the given parameters
3366 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3367 * @join_mesh: join the mesh network with the specified parameters
3368 * (invoked with the wireless_dev mutex held)
3369 * @leave_mesh: leave the current mesh network
3370 * (invoked with the wireless_dev mutex held)
3372 * @get_mesh_config: Get the current mesh configuration
3374 * @update_mesh_config: Update mesh parameters on a running mesh.
3375 * The mask is a bitfield which tells us which parameters to
3376 * set, and which to leave alone.
3378 * @change_bss: Modify parameters for a given BSS.
3380 * @set_txq_params: Set TX queue parameters
3382 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3383 * as it doesn't implement join_mesh and needs to set the channel to
3384 * join the mesh instead.
3386 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3387 * interfaces are active this callback should reject the configuration.
3388 * If no interfaces are active or the device is down, the channel should
3389 * be stored for when a monitor interface becomes active.
3391 * @scan: Request to do a scan. If returning zero, the scan request is given
3392 * the driver, and will be valid until passed to cfg80211_scan_done().
3393 * For scan results, call cfg80211_inform_bss(); you can call this outside
3394 * the scan/scan_done bracket too.
3395 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3396 * indicate the status of the scan through cfg80211_scan_done().
3398 * @auth: Request to authenticate with the specified peer
3399 * (invoked with the wireless_dev mutex held)
3400 * @assoc: Request to (re)associate with the specified peer
3401 * (invoked with the wireless_dev mutex held)
3402 * @deauth: Request to deauthenticate from the specified peer
3403 * (invoked with the wireless_dev mutex held)
3404 * @disassoc: Request to disassociate from the specified peer
3405 * (invoked with the wireless_dev mutex held)
3407 * @connect: Connect to the ESS with the specified parameters. When connected,
3408 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3409 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3410 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3411 * from the AP or cfg80211_connect_timeout() if no frame with status code
3413 * The driver is allowed to roam to other BSSes within the ESS when the
3414 * other BSS matches the connect parameters. When such roaming is initiated
3415 * by the driver, the driver is expected to verify that the target matches
3416 * the configured security parameters and to use Reassociation Request
3417 * frame instead of Association Request frame.
3418 * The connect function can also be used to request the driver to perform a
3419 * specific roam when connected to an ESS. In that case, the prev_bssid
3420 * parameter is set to the BSSID of the currently associated BSS as an
3421 * indication of requesting reassociation.
3422 * In both the driver-initiated and new connect() call initiated roaming
3423 * cases, the result of roaming is indicated with a call to
3424 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3425 * @update_connect_params: Update the connect parameters while connected to a
3426 * BSS. The updated parameters can be used by driver/firmware for
3427 * subsequent BSS selection (roaming) decisions and to form the
3428 * Authentication/(Re)Association Request frames. This call does not
3429 * request an immediate disassociation or reassociation with the current
3430 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3431 * changed are defined in &enum cfg80211_connect_params_changed.
3432 * (invoked with the wireless_dev mutex held)
3433 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3434 * connection is in progress. Once done, call cfg80211_disconnected() in
3435 * case connection was already established (invoked with the
3436 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3438 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3439 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3441 * (invoked with the wireless_dev mutex held)
3442 * @leave_ibss: Leave the IBSS.
3443 * (invoked with the wireless_dev mutex held)
3445 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3448 * @set_wiphy_params: Notify that wiphy parameters have changed;
3449 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3450 * have changed. The actual parameter values are available in
3451 * struct wiphy. If returning an error, no value should be changed.
3453 * @set_tx_power: set the transmit power according to the parameters,
3454 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3455 * wdev may be %NULL if power was set for the wiphy, and will
3456 * always be %NULL unless the driver supports per-vif TX power
3457 * (as advertised by the nl80211 feature flag.)
3458 * @get_tx_power: store the current TX power into the dbm variable;
3459 * return 0 if successful
3461 * @set_wds_peer: set the WDS peer for a WDS interface
3463 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3464 * functions to adjust rfkill hw state
3466 * @dump_survey: get site survey information.
3468 * @remain_on_channel: Request the driver to remain awake on the specified
3469 * channel for the specified duration to complete an off-channel
3470 * operation (e.g., public action frame exchange). When the driver is
3471 * ready on the requested channel, it must indicate this with an event
3472 * notification by calling cfg80211_ready_on_channel().
3473 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3474 * This allows the operation to be terminated prior to timeout based on
3475 * the duration value.
3476 * @mgmt_tx: Transmit a management frame.
3477 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3478 * frame on another channel
3480 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3481 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3482 * used by the function, but 0 and 1 must not be touched. Additionally,
3483 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3484 * dump and return to userspace with an error, so be careful. If any data
3485 * was passed in from userspace then the data/len arguments will be present
3486 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3488 * @set_bitrate_mask: set the bitrate mask configuration
3490 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3491 * devices running firmwares capable of generating the (re) association
3492 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3493 * @del_pmksa: Delete a cached PMKID.
3494 * @flush_pmksa: Flush all cached PMKIDs.
3495 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3496 * allows the driver to adjust the dynamic ps timeout value.
3497 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3498 * After configuration, the driver should (soon) send an event indicating
3499 * the current level is above/below the configured threshold; this may
3500 * need some care when the configuration is changed (without first being
3502 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3503 * connection quality monitor. An event is to be sent only when the
3504 * signal level is found to be outside the two values. The driver should
3505 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3506 * If it is provided then there's no point providing @set_cqm_rssi_config.
3507 * @set_cqm_txe_config: Configure connection quality monitor TX error
3509 * @sched_scan_start: Tell the driver to start a scheduled scan.
3510 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3511 * given request id. This call must stop the scheduled scan and be ready
3512 * for starting a new one before it returns, i.e. @sched_scan_start may be
3513 * called immediately after that again and should not fail in that case.
3514 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3515 * stop (when this method returns 0).
3517 * @mgmt_frame_register: Notify driver that a management frame type was
3518 * registered. The callback is allowed to sleep.
3520 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3521 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3522 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3523 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3525 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3527 * @tdls_mgmt: Transmit a TDLS management frame.
3528 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3530 * @probe_client: probe an associated client, must return a cookie that it
3531 * later passes to cfg80211_probe_status().
3533 * @set_noack_map: Set the NoAck Map for the TIDs.
3535 * @get_channel: Get the current operating channel for the virtual interface.
3536 * For monitor interfaces, it should return %NULL unless there's a single
3537 * current monitoring channel.
3539 * @start_p2p_device: Start the given P2P device.
3540 * @stop_p2p_device: Stop the given P2P device.
3542 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3543 * Parameters include ACL policy, an array of MAC address of stations
3544 * and the number of MAC addresses. If there is already a list in driver
3545 * this new list replaces the existing one. Driver has to clear its ACL
3546 * when number of MAC addresses entries is passed as 0. Drivers which
3547 * advertise the support for MAC based ACL have to implement this callback.
3549 * @start_radar_detection: Start radar detection in the driver.
3551 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3552 * driver. If the SME is in the driver/firmware, this information can be
3553 * used in building Authentication and Reassociation Request frames.
3555 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3556 * for a given duration (milliseconds). The protocol is provided so the
3557 * driver can take the most appropriate actions.
3558 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3559 * reliability. This operation can not fail.
3560 * @set_coalesce: Set coalesce parameters.
3562 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3563 * responsible for veryfing if the switch is possible. Since this is
3564 * inherently tricky driver may decide to disconnect an interface later
3565 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3566 * everything. It should do it's best to verify requests and reject them
3567 * as soon as possible.
3569 * @set_qos_map: Set QoS mapping information to the driver
3571 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3572 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3573 * changes during the lifetime of the BSS.
3575 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3576 * with the given parameters; action frame exchange has been handled by
3577 * userspace so this just has to modify the TX path to take the TS into
3579 * If the admitted time is 0 just validate the parameters to make sure
3580 * the session can be created at all; it is valid to just always return
3581 * success for that but that may result in inefficient behaviour (handshake
3582 * with the peer followed by immediate teardown when the addition is later
3584 * @del_tx_ts: remove an existing TX TS
3586 * @join_ocb: join the OCB network with the specified parameters
3587 * (invoked with the wireless_dev mutex held)
3588 * @leave_ocb: leave the current OCB network
3589 * (invoked with the wireless_dev mutex held)
3591 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3592 * is responsible for continually initiating channel-switching operations
3593 * and returning to the base channel for communication with the AP.
3594 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3595 * peers must be on the base channel when the call completes.
3596 * @start_nan: Start the NAN interface.
3597 * @stop_nan: Stop the NAN interface.
3598 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3599 * On success @nan_func ownership is transferred to the driver and
3600 * it may access it outside of the scope of this function. The driver
3601 * should free the @nan_func when no longer needed by calling
3602 * cfg80211_free_nan_func().
3603 * On success the driver should assign an instance_id in the
3604 * provided @nan_func.
3605 * @del_nan_func: Delete a NAN function.
3606 * @nan_change_conf: changes NAN configuration. The changed parameters must
3607 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3608 * All other parameters must be ignored.
3610 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3612 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3613 * function should return phy stats, and interface stats otherwise.
3615 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3616 * If not deleted through @del_pmk the PMK remains valid until disconnect
3617 * upon which the driver should clear it.
3618 * (invoked with the wireless_dev mutex held)
3619 * @del_pmk: delete the previously configured PMK for the given authenticator.
3620 * (invoked with the wireless_dev mutex held)
3622 * @external_auth: indicates result of offloaded authentication processing from
3625 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3626 * tells the driver that the frame should not be encrypted.
3628 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3629 * Statistics should be cumulative, currently no way to reset is provided.
3630 * @start_pmsr: start peer measurement (e.g. FTM)
3631 * @abort_pmsr: abort peer measurement
3633 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3634 * but offloading OWE processing to the user space will get the updated
3635 * DH IE through this interface.
3637 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3638 * and overrule HWMP path selection algorithm.
3640 struct cfg80211_ops
{
3641 int (*suspend
)(struct wiphy
*wiphy
, struct cfg80211_wowlan
*wow
);
3642 int (*resume
)(struct wiphy
*wiphy
);
3643 void (*set_wakeup
)(struct wiphy
*wiphy
, bool enabled
);
3645 struct wireless_dev
* (*add_virtual_intf
)(struct wiphy
*wiphy
,
3647 unsigned char name_assign_type
,
3648 enum nl80211_iftype type
,
3649 struct vif_params
*params
);
3650 int (*del_virtual_intf
)(struct wiphy
*wiphy
,
3651 struct wireless_dev
*wdev
);
3652 int (*change_virtual_intf
)(struct wiphy
*wiphy
,
3653 struct net_device
*dev
,
3654 enum nl80211_iftype type
,
3655 struct vif_params
*params
);
3657 int (*add_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3658 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
3659 struct key_params
*params
);
3660 int (*get_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3661 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
3663 void (*callback
)(void *cookie
, struct key_params
*));
3664 int (*del_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3665 u8 key_index
, bool pairwise
, const u8
*mac_addr
);
3666 int (*set_default_key
)(struct wiphy
*wiphy
,
3667 struct net_device
*netdev
,
3668 u8 key_index
, bool unicast
, bool multicast
);
3669 int (*set_default_mgmt_key
)(struct wiphy
*wiphy
,
3670 struct net_device
*netdev
,
3673 int (*start_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3674 struct cfg80211_ap_settings
*settings
);
3675 int (*change_beacon
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3676 struct cfg80211_beacon_data
*info
);
3677 int (*stop_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
);
3680 int (*add_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3682 struct station_parameters
*params
);
3683 int (*del_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3684 struct station_del_parameters
*params
);
3685 int (*change_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3687 struct station_parameters
*params
);
3688 int (*get_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3689 const u8
*mac
, struct station_info
*sinfo
);
3690 int (*dump_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3691 int idx
, u8
*mac
, struct station_info
*sinfo
);
3693 int (*add_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3694 const u8
*dst
, const u8
*next_hop
);
3695 int (*del_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3697 int (*change_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3698 const u8
*dst
, const u8
*next_hop
);
3699 int (*get_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3700 u8
*dst
, u8
*next_hop
, struct mpath_info
*pinfo
);
3701 int (*dump_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3702 int idx
, u8
*dst
, u8
*next_hop
,
3703 struct mpath_info
*pinfo
);
3704 int (*get_mpp
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3705 u8
*dst
, u8
*mpp
, struct mpath_info
*pinfo
);
3706 int (*dump_mpp
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3707 int idx
, u8
*dst
, u8
*mpp
,
3708 struct mpath_info
*pinfo
);
3709 int (*get_mesh_config
)(struct wiphy
*wiphy
,
3710 struct net_device
*dev
,
3711 struct mesh_config
*conf
);
3712 int (*update_mesh_config
)(struct wiphy
*wiphy
,
3713 struct net_device
*dev
, u32 mask
,
3714 const struct mesh_config
*nconf
);
3715 int (*join_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3716 const struct mesh_config
*conf
,
3717 const struct mesh_setup
*setup
);
3718 int (*leave_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
);
3720 int (*join_ocb
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3721 struct ocb_setup
*setup
);
3722 int (*leave_ocb
)(struct wiphy
*wiphy
, struct net_device
*dev
);
3724 int (*change_bss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3725 struct bss_parameters
*params
);
3727 int (*set_txq_params
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3728 struct ieee80211_txq_params
*params
);
3730 int (*libertas_set_mesh_channel
)(struct wiphy
*wiphy
,
3731 struct net_device
*dev
,
3732 struct ieee80211_channel
*chan
);
3734 int (*set_monitor_channel
)(struct wiphy
*wiphy
,
3735 struct cfg80211_chan_def
*chandef
);
3737 int (*scan
)(struct wiphy
*wiphy
,
3738 struct cfg80211_scan_request
*request
);
3739 void (*abort_scan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
);
3741 int (*auth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3742 struct cfg80211_auth_request
*req
);
3743 int (*assoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3744 struct cfg80211_assoc_request
*req
);
3745 int (*deauth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3746 struct cfg80211_deauth_request
*req
);
3747 int (*disassoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3748 struct cfg80211_disassoc_request
*req
);
3750 int (*connect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3751 struct cfg80211_connect_params
*sme
);
3752 int (*update_connect_params
)(struct wiphy
*wiphy
,
3753 struct net_device
*dev
,
3754 struct cfg80211_connect_params
*sme
,
3756 int (*disconnect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3759 int (*join_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3760 struct cfg80211_ibss_params
*params
);
3761 int (*leave_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
);
3763 int (*set_mcast_rate
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3764 int rate
[NUM_NL80211_BANDS
]);
3766 int (*set_wiphy_params
)(struct wiphy
*wiphy
, u32 changed
);
3768 int (*set_tx_power
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3769 enum nl80211_tx_power_setting type
, int mbm
);
3770 int (*get_tx_power
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3773 int (*set_wds_peer
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3776 void (*rfkill_poll
)(struct wiphy
*wiphy
);
3778 #ifdef CONFIG_NL80211_TESTMODE
3779 int (*testmode_cmd
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3780 void *data
, int len
);
3781 int (*testmode_dump
)(struct wiphy
*wiphy
, struct sk_buff
*skb
,
3782 struct netlink_callback
*cb
,
3783 void *data
, int len
);
3786 int (*set_bitrate_mask
)(struct wiphy
*wiphy
,
3787 struct net_device
*dev
,
3789 const struct cfg80211_bitrate_mask
*mask
);
3791 int (*dump_survey
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3792 int idx
, struct survey_info
*info
);
3794 int (*set_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3795 struct cfg80211_pmksa
*pmksa
);
3796 int (*del_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3797 struct cfg80211_pmksa
*pmksa
);
3798 int (*flush_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
);
3800 int (*remain_on_channel
)(struct wiphy
*wiphy
,
3801 struct wireless_dev
*wdev
,
3802 struct ieee80211_channel
*chan
,
3803 unsigned int duration
,
3805 int (*cancel_remain_on_channel
)(struct wiphy
*wiphy
,
3806 struct wireless_dev
*wdev
,
3809 int (*mgmt_tx
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3810 struct cfg80211_mgmt_tx_params
*params
,
3812 int (*mgmt_tx_cancel_wait
)(struct wiphy
*wiphy
,
3813 struct wireless_dev
*wdev
,
3816 int (*set_power_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3817 bool enabled
, int timeout
);
3819 int (*set_cqm_rssi_config
)(struct wiphy
*wiphy
,
3820 struct net_device
*dev
,
3821 s32 rssi_thold
, u32 rssi_hyst
);
3823 int (*set_cqm_rssi_range_config
)(struct wiphy
*wiphy
,
3824 struct net_device
*dev
,
3825 s32 rssi_low
, s32 rssi_high
);
3827 int (*set_cqm_txe_config
)(struct wiphy
*wiphy
,
3828 struct net_device
*dev
,
3829 u32 rate
, u32 pkts
, u32 intvl
);
3831 void (*mgmt_frame_register
)(struct wiphy
*wiphy
,
3832 struct wireless_dev
*wdev
,
3833 u16 frame_type
, bool reg
);
3835 int (*set_antenna
)(struct wiphy
*wiphy
, u32 tx_ant
, u32 rx_ant
);
3836 int (*get_antenna
)(struct wiphy
*wiphy
, u32
*tx_ant
, u32
*rx_ant
);
3838 int (*sched_scan_start
)(struct wiphy
*wiphy
,
3839 struct net_device
*dev
,
3840 struct cfg80211_sched_scan_request
*request
);
3841 int (*sched_scan_stop
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3844 int (*set_rekey_data
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3845 struct cfg80211_gtk_rekey_data
*data
);
3847 int (*tdls_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3848 const u8
*peer
, u8 action_code
, u8 dialog_token
,
3849 u16 status_code
, u32 peer_capability
,
3850 bool initiator
, const u8
*buf
, size_t len
);
3851 int (*tdls_oper
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3852 const u8
*peer
, enum nl80211_tdls_operation oper
);
3854 int (*probe_client
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3855 const u8
*peer
, u64
*cookie
);
3857 int (*set_noack_map
)(struct wiphy
*wiphy
,
3858 struct net_device
*dev
,
3861 int (*get_channel
)(struct wiphy
*wiphy
,
3862 struct wireless_dev
*wdev
,
3863 struct cfg80211_chan_def
*chandef
);
3865 int (*start_p2p_device
)(struct wiphy
*wiphy
,
3866 struct wireless_dev
*wdev
);
3867 void (*stop_p2p_device
)(struct wiphy
*wiphy
,
3868 struct wireless_dev
*wdev
);
3870 int (*set_mac_acl
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3871 const struct cfg80211_acl_data
*params
);
3873 int (*start_radar_detection
)(struct wiphy
*wiphy
,
3874 struct net_device
*dev
,
3875 struct cfg80211_chan_def
*chandef
,
3877 int (*update_ft_ies
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3878 struct cfg80211_update_ft_ies_params
*ftie
);
3879 int (*crit_proto_start
)(struct wiphy
*wiphy
,
3880 struct wireless_dev
*wdev
,
3881 enum nl80211_crit_proto_id protocol
,
3883 void (*crit_proto_stop
)(struct wiphy
*wiphy
,
3884 struct wireless_dev
*wdev
);
3885 int (*set_coalesce
)(struct wiphy
*wiphy
,
3886 struct cfg80211_coalesce
*coalesce
);
3888 int (*channel_switch
)(struct wiphy
*wiphy
,
3889 struct net_device
*dev
,
3890 struct cfg80211_csa_settings
*params
);
3892 int (*set_qos_map
)(struct wiphy
*wiphy
,
3893 struct net_device
*dev
,
3894 struct cfg80211_qos_map
*qos_map
);
3896 int (*set_ap_chanwidth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3897 struct cfg80211_chan_def
*chandef
);
3899 int (*add_tx_ts
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3900 u8 tsid
, const u8
*peer
, u8 user_prio
,
3902 int (*del_tx_ts
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3903 u8 tsid
, const u8
*peer
);
3905 int (*tdls_channel_switch
)(struct wiphy
*wiphy
,
3906 struct net_device
*dev
,
3907 const u8
*addr
, u8 oper_class
,
3908 struct cfg80211_chan_def
*chandef
);
3909 void (*tdls_cancel_channel_switch
)(struct wiphy
*wiphy
,
3910 struct net_device
*dev
,
3912 int (*start_nan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3913 struct cfg80211_nan_conf
*conf
);
3914 void (*stop_nan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
);
3915 int (*add_nan_func
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3916 struct cfg80211_nan_func
*nan_func
);
3917 void (*del_nan_func
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3919 int (*nan_change_conf
)(struct wiphy
*wiphy
,
3920 struct wireless_dev
*wdev
,
3921 struct cfg80211_nan_conf
*conf
,
3924 int (*set_multicast_to_unicast
)(struct wiphy
*wiphy
,
3925 struct net_device
*dev
,
3926 const bool enabled
);
3928 int (*get_txq_stats
)(struct wiphy
*wiphy
,
3929 struct wireless_dev
*wdev
,
3930 struct cfg80211_txq_stats
*txqstats
);
3932 int (*set_pmk
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3933 const struct cfg80211_pmk_conf
*conf
);
3934 int (*del_pmk
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3936 int (*external_auth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3937 struct cfg80211_external_auth_params
*params
);
3939 int (*tx_control_port
)(struct wiphy
*wiphy
,
3940 struct net_device
*dev
,
3941 const u8
*buf
, size_t len
,
3942 const u8
*dest
, const __be16 proto
,
3943 const bool noencrypt
);
3945 int (*get_ftm_responder_stats
)(struct wiphy
*wiphy
,
3946 struct net_device
*dev
,
3947 struct cfg80211_ftm_responder_stats
*ftm_stats
);
3949 int (*start_pmsr
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3950 struct cfg80211_pmsr_request
*request
);
3951 void (*abort_pmsr
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3952 struct cfg80211_pmsr_request
*request
);
3953 int (*update_owe_info
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3954 struct cfg80211_update_owe_info
*owe_info
);
3955 int (*probe_mesh_link
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3956 const u8
*buf
, size_t len
);
3960 * wireless hardware and networking interfaces structures
3961 * and registration/helper functions
3965 * enum wiphy_flags - wiphy capability flags
3967 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3969 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3970 * by default -- this flag will be set depending on the kernel's default
3971 * on wiphy_new(), but can be changed by the driver if it has a good
3972 * reason to override the default
3973 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3974 * on a VLAN interface). This flag also serves an extra purpose of
3975 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
3976 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3977 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3978 * control port protocol ethertype. The device also honours the
3979 * control_port_no_encrypt flag.
3980 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3981 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3982 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3983 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3985 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3986 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3987 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3988 * link setup/discovery operations internally. Setup, discovery and
3989 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3990 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3991 * used for asking the driver/firmware to perform a TDLS operation.
3992 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3993 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3994 * when there are virtual interfaces in AP mode by calling
3995 * cfg80211_report_obss_beacon().
3996 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3997 * responds to probe-requests in hardware.
3998 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3999 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4000 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4001 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4002 * beaconing mode (AP, IBSS, Mesh, ...).
4003 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4004 * before connection.
4010 WIPHY_FLAG_NETNS_OK
= BIT(3),
4011 WIPHY_FLAG_PS_ON_BY_DEFAULT
= BIT(4),
4012 WIPHY_FLAG_4ADDR_AP
= BIT(5),
4013 WIPHY_FLAG_4ADDR_STATION
= BIT(6),
4014 WIPHY_FLAG_CONTROL_PORT_PROTOCOL
= BIT(7),
4015 WIPHY_FLAG_IBSS_RSN
= BIT(8),
4016 WIPHY_FLAG_MESH_AUTH
= BIT(10),
4017 /* use hole at 11 */
4018 /* use hole at 12 */
4019 WIPHY_FLAG_SUPPORTS_FW_ROAM
= BIT(13),
4020 WIPHY_FLAG_AP_UAPSD
= BIT(14),
4021 WIPHY_FLAG_SUPPORTS_TDLS
= BIT(15),
4022 WIPHY_FLAG_TDLS_EXTERNAL_SETUP
= BIT(16),
4023 WIPHY_FLAG_HAVE_AP_SME
= BIT(17),
4024 WIPHY_FLAG_REPORTS_OBSS
= BIT(18),
4025 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD
= BIT(19),
4026 WIPHY_FLAG_OFFCHAN_TX
= BIT(20),
4027 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL
= BIT(21),
4028 WIPHY_FLAG_SUPPORTS_5_10_MHZ
= BIT(22),
4029 WIPHY_FLAG_HAS_CHANNEL_SWITCH
= BIT(23),
4030 WIPHY_FLAG_HAS_STATIC_WEP
= BIT(24),
4034 * struct ieee80211_iface_limit - limit on certain interface types
4035 * @max: maximum number of interfaces of these types
4036 * @types: interface types (bits)
4038 struct ieee80211_iface_limit
{
4044 * struct ieee80211_iface_combination - possible interface combination
4046 * With this structure the driver can describe which interface
4047 * combinations it supports concurrently.
4051 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4055 * struct ieee80211_iface_limit limits1[] = {
4056 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4057 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4059 * struct ieee80211_iface_combination combination1 = {
4060 * .limits = limits1,
4061 * .n_limits = ARRAY_SIZE(limits1),
4062 * .max_interfaces = 2,
4063 * .beacon_int_infra_match = true,
4067 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4071 * struct ieee80211_iface_limit limits2[] = {
4072 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4073 * BIT(NL80211_IFTYPE_P2P_GO), },
4075 * struct ieee80211_iface_combination combination2 = {
4076 * .limits = limits2,
4077 * .n_limits = ARRAY_SIZE(limits2),
4078 * .max_interfaces = 8,
4079 * .num_different_channels = 1,
4083 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4085 * This allows for an infrastructure connection and three P2P connections.
4089 * struct ieee80211_iface_limit limits3[] = {
4090 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4091 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4092 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4094 * struct ieee80211_iface_combination combination3 = {
4095 * .limits = limits3,
4096 * .n_limits = ARRAY_SIZE(limits3),
4097 * .max_interfaces = 4,
4098 * .num_different_channels = 2,
4102 struct ieee80211_iface_combination
{
4105 * limits for the given interface types
4107 const struct ieee80211_iface_limit
*limits
;
4110 * @num_different_channels:
4111 * can use up to this many different channels
4113 u32 num_different_channels
;
4117 * maximum number of interfaces in total allowed in this group
4123 * number of limitations
4128 * @beacon_int_infra_match:
4129 * In this combination, the beacon intervals between infrastructure
4130 * and AP types must match. This is required only in special cases.
4132 bool beacon_int_infra_match
;
4135 * @radar_detect_widths:
4136 * bitmap of channel widths supported for radar detection
4138 u8 radar_detect_widths
;
4141 * @radar_detect_regions:
4142 * bitmap of regions supported for radar detection
4144 u8 radar_detect_regions
;
4147 * @beacon_int_min_gcd:
4148 * This interface combination supports different beacon intervals.
4151 * all beacon intervals for different interface must be same.
4153 * any beacon interval for the interface part of this combination AND
4154 * GCD of all beacon intervals from beaconing interfaces of this
4155 * combination must be greater or equal to this value.
4157 u32 beacon_int_min_gcd
;
4160 struct ieee80211_txrx_stypes
{
4165 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4166 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4167 * trigger that keeps the device operating as-is and
4168 * wakes up the host on any activity, for example a
4169 * received packet that passed filtering; note that the
4170 * packet should be preserved in that case
4171 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4173 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4174 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4175 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4176 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4177 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4178 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4179 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4181 enum wiphy_wowlan_support_flags
{
4182 WIPHY_WOWLAN_ANY
= BIT(0),
4183 WIPHY_WOWLAN_MAGIC_PKT
= BIT(1),
4184 WIPHY_WOWLAN_DISCONNECT
= BIT(2),
4185 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY
= BIT(3),
4186 WIPHY_WOWLAN_GTK_REKEY_FAILURE
= BIT(4),
4187 WIPHY_WOWLAN_EAP_IDENTITY_REQ
= BIT(5),
4188 WIPHY_WOWLAN_4WAY_HANDSHAKE
= BIT(6),
4189 WIPHY_WOWLAN_RFKILL_RELEASE
= BIT(7),
4190 WIPHY_WOWLAN_NET_DETECT
= BIT(8),
4193 struct wiphy_wowlan_tcp_support
{
4194 const struct nl80211_wowlan_tcp_data_token_feature
*tok
;
4195 u32 data_payload_max
;
4196 u32 data_interval_max
;
4197 u32 wake_payload_max
;
4202 * struct wiphy_wowlan_support - WoWLAN support data
4203 * @flags: see &enum wiphy_wowlan_support_flags
4204 * @n_patterns: number of supported wakeup patterns
4205 * (see nl80211.h for the pattern definition)
4206 * @pattern_max_len: maximum length of each pattern
4207 * @pattern_min_len: minimum length of each pattern
4208 * @max_pkt_offset: maximum Rx packet offset
4209 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4210 * similar, but not necessarily identical, to max_match_sets for
4212 * See &struct cfg80211_sched_scan_request.@match_sets for more
4214 * @tcp: TCP wakeup support information
4216 struct wiphy_wowlan_support
{
4219 int pattern_max_len
;
4220 int pattern_min_len
;
4222 int max_nd_match_sets
;
4223 const struct wiphy_wowlan_tcp_support
*tcp
;
4227 * struct wiphy_coalesce_support - coalesce support data
4228 * @n_rules: maximum number of coalesce rules
4229 * @max_delay: maximum supported coalescing delay in msecs
4230 * @n_patterns: number of supported patterns in a rule
4231 * (see nl80211.h for the pattern definition)
4232 * @pattern_max_len: maximum length of each pattern
4233 * @pattern_min_len: minimum length of each pattern
4234 * @max_pkt_offset: maximum Rx packet offset
4236 struct wiphy_coalesce_support
{
4240 int pattern_max_len
;
4241 int pattern_min_len
;
4246 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4247 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4248 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4249 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4250 * (must be combined with %_WDEV or %_NETDEV)
4252 enum wiphy_vendor_command_flags
{
4253 WIPHY_VENDOR_CMD_NEED_WDEV
= BIT(0),
4254 WIPHY_VENDOR_CMD_NEED_NETDEV
= BIT(1),
4255 WIPHY_VENDOR_CMD_NEED_RUNNING
= BIT(2),
4259 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4261 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4262 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4263 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4266 enum wiphy_opmode_flag
{
4267 STA_OPMODE_MAX_BW_CHANGED
= BIT(0),
4268 STA_OPMODE_SMPS_MODE_CHANGED
= BIT(1),
4269 STA_OPMODE_N_SS_CHANGED
= BIT(2),
4273 * struct sta_opmode_info - Station's ht/vht operation mode information
4274 * @changed: contains value from &enum wiphy_opmode_flag
4275 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4276 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4277 * @rx_nss: new rx_nss value of a station
4280 struct sta_opmode_info
{
4282 enum nl80211_smps_mode smps_mode
;
4283 enum nl80211_chan_width bw
;
4287 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4290 * struct wiphy_vendor_command - vendor command definition
4291 * @info: vendor command identifying information, as used in nl80211
4292 * @flags: flags, see &enum wiphy_vendor_command_flags
4293 * @doit: callback for the operation, note that wdev is %NULL if the
4294 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4295 * pointer may be %NULL if userspace provided no data at all
4296 * @dumpit: dump callback, for transferring bigger/multiple items. The
4297 * @storage points to cb->args[5], ie. is preserved over the multiple
4299 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4300 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4301 * attribute is just raw data (e.g. a firmware command).
4302 * @maxattr: highest attribute number in policy
4303 * It's recommended to not have the same sub command with both @doit and
4304 * @dumpit, so that userspace can assume certain ones are get and others
4305 * are used with dump requests.
4307 struct wiphy_vendor_command
{
4308 struct nl80211_vendor_cmd_info info
;
4310 int (*doit
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4311 const void *data
, int data_len
);
4312 int (*dumpit
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4313 struct sk_buff
*skb
, const void *data
, int data_len
,
4314 unsigned long *storage
);
4315 const struct nla_policy
*policy
;
4316 unsigned int maxattr
;
4320 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4321 * @iftype: interface type
4322 * @extended_capabilities: extended capabilities supported by the driver,
4323 * additional capabilities might be supported by userspace; these are the
4324 * 802.11 extended capabilities ("Extended Capabilities element") and are
4325 * in the same format as in the information element. See IEEE Std
4326 * 802.11-2012 8.4.2.29 for the defined fields.
4327 * @extended_capabilities_mask: mask of the valid values
4328 * @extended_capabilities_len: length of the extended capabilities
4330 struct wiphy_iftype_ext_capab
{
4331 enum nl80211_iftype iftype
;
4332 const u8
*extended_capabilities
;
4333 const u8
*extended_capabilities_mask
;
4334 u8 extended_capabilities_len
;
4338 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4339 * @max_peers: maximum number of peers in a single measurement
4340 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4341 * @randomize_mac_addr: can randomize MAC address for measurement
4342 * @ftm.supported: FTM measurement is supported
4343 * @ftm.asap: ASAP-mode is supported
4344 * @ftm.non_asap: non-ASAP-mode is supported
4345 * @ftm.request_lci: can request LCI data
4346 * @ftm.request_civicloc: can request civic location data
4347 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4348 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4349 * @ftm.max_bursts_exponent: maximum burst exponent supported
4350 * (set to -1 if not limited; note that setting this will necessarily
4351 * forbid using the value 15 to let the responder pick)
4352 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4355 struct cfg80211_pmsr_capabilities
{
4356 unsigned int max_peers
;
4358 randomize_mac_addr
:1;
4363 s8 max_bursts_exponent
;
4364 u8 max_ftms_per_burst
;
4374 * struct wiphy - wireless hardware description
4375 * @reg_notifier: the driver's regulatory notification callback,
4376 * note that if your driver uses wiphy_apply_custom_regulatory()
4377 * the reg_notifier's request can be passed as NULL
4378 * @regd: the driver's regulatory domain, if one was requested via
4379 * the regulatory_hint() API. This can be used by the driver
4380 * on the reg_notifier() if it chooses to ignore future
4381 * regulatory domain changes caused by other drivers.
4382 * @signal_type: signal type reported in &struct cfg80211_bss.
4383 * @cipher_suites: supported cipher suites
4384 * @n_cipher_suites: number of supported cipher suites
4385 * @akm_suites: supported AKM suites
4386 * @n_akm_suites: number of supported AKM suites
4387 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4388 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4389 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4390 * -1 = fragmentation disabled, only odd values >= 256 used
4391 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4392 * @_net: the network namespace this wiphy currently lives in
4393 * @perm_addr: permanent MAC address of this device
4394 * @addr_mask: If the device supports multiple MAC addresses by masking,
4395 * set this to a mask with variable bits set to 1, e.g. if the last
4396 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4397 * variable bits shall be determined by the interfaces added, with
4398 * interfaces not matching the mask being rejected to be brought up.
4399 * @n_addresses: number of addresses in @addresses.
4400 * @addresses: If the device has more than one address, set this pointer
4401 * to a list of addresses (6 bytes each). The first one will be used
4402 * by default for perm_addr. In this case, the mask should be set to
4403 * all-zeroes. In this case it is assumed that the device can handle
4404 * the same number of arbitrary MAC addresses.
4405 * @registered: protects ->resume and ->suspend sysfs callbacks against
4406 * unregister hardware
4407 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
4408 * automatically on wiphy renames
4409 * @dev: (virtual) struct device for this wiphy
4410 * @registered: helps synchronize suspend/resume with wiphy unregister
4411 * @wext: wireless extension handlers
4412 * @priv: driver private data (sized according to wiphy_new() parameter)
4413 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4414 * must be set by driver
4415 * @iface_combinations: Valid interface combinations array, should not
4416 * list single interface types.
4417 * @n_iface_combinations: number of entries in @iface_combinations array.
4418 * @software_iftypes: bitmask of software interface types, these are not
4419 * subject to any restrictions since they are purely managed in SW.
4420 * @flags: wiphy flags, see &enum wiphy_flags
4421 * @regulatory_flags: wiphy regulatory flags, see
4422 * &enum ieee80211_regulatory_flags
4423 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4424 * @ext_features: extended features advertised to nl80211, see
4425 * &enum nl80211_ext_feature_index.
4426 * @bss_priv_size: each BSS struct has private data allocated with it,
4427 * this variable determines its size
4428 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4430 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4431 * the device can run concurrently.
4432 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4433 * for in any given scheduled scan
4434 * @max_match_sets: maximum number of match sets the device can handle
4435 * when performing a scheduled scan, 0 if filtering is not
4437 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4438 * add to probe request frames transmitted during a scan, must not
4439 * include fixed IEs like supported rates
4440 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4442 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4443 * of iterations) for scheduled scan supported by the device.
4444 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4445 * single scan plan supported by the device.
4446 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4447 * scan plan supported by the device.
4448 * @coverage_class: current coverage class
4449 * @fw_version: firmware version for ethtool reporting
4450 * @hw_version: hardware version for ethtool reporting
4451 * @max_num_pmkids: maximum number of PMKIDs supported by device
4452 * @privid: a pointer that drivers can use to identify if an arbitrary
4453 * wiphy is theirs, e.g. in global notifiers
4454 * @bands: information about bands/channels supported by this device
4456 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4457 * transmitted through nl80211, points to an array indexed by interface
4460 * @available_antennas_tx: bitmap of antennas which are available to be
4461 * configured as TX antennas. Antenna configuration commands will be
4462 * rejected unless this or @available_antennas_rx is set.
4464 * @available_antennas_rx: bitmap of antennas which are available to be
4465 * configured as RX antennas. Antenna configuration commands will be
4466 * rejected unless this or @available_antennas_tx is set.
4468 * @probe_resp_offload:
4469 * Bitmap of supported protocols for probe response offloading.
4470 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4471 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4473 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4474 * may request, if implemented.
4476 * @wowlan: WoWLAN support information
4477 * @wowlan_config: current WoWLAN configuration; this should usually not be
4478 * used since access to it is necessarily racy, use the parameter passed
4479 * to the suspend() operation instead.
4481 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4482 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4483 * If null, then none can be over-ridden.
4484 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4485 * If null, then none can be over-ridden.
4487 * @wdev_list: the list of associated (virtual) interfaces; this list must
4488 * not be modified by the driver, but can be read with RTNL/RCU protection.
4490 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4493 * @extended_capabilities: extended capabilities supported by the driver,
4494 * additional capabilities might be supported by userspace; these are
4495 * the 802.11 extended capabilities ("Extended Capabilities element")
4496 * and are in the same format as in the information element. See
4497 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4498 * extended capabilities to be used if the capabilities are not specified
4499 * for a specific interface type in iftype_ext_capab.
4500 * @extended_capabilities_mask: mask of the valid values
4501 * @extended_capabilities_len: length of the extended capabilities
4502 * @iftype_ext_capab: array of extended capabilities per interface type
4503 * @num_iftype_ext_capab: number of interface types for which extended
4504 * capabilities are specified separately.
4505 * @coalesce: packet coalescing support information
4507 * @vendor_commands: array of vendor commands supported by the hardware
4508 * @n_vendor_commands: number of vendor commands
4509 * @vendor_events: array of vendor events supported by the hardware
4510 * @n_vendor_events: number of vendor events
4512 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4513 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4514 * driver is allowed to advertise a theoretical limit that it can reach in
4515 * some cases, but may not always reach.
4517 * @max_num_csa_counters: Number of supported csa_counters in beacons
4518 * and probe responses. This value should be set if the driver
4519 * wishes to limit the number of csa counters. Default (0) means
4521 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
4522 * frame was sent and the channel on which the frame was heard for which
4523 * the reported rssi is still valid. If a driver is able to compensate the
4524 * low rssi when a frame is heard on different channel, then it should set
4525 * this variable to the maximal offset for which it can compensate.
4526 * This value should be set in MHz.
4527 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4528 * by the driver in the .connect() callback. The bit position maps to the
4529 * attribute indices defined in &enum nl80211_bss_select_attr.
4531 * @nan_supported_bands: bands supported by the device in NAN mode, a
4532 * bitmap of &enum nl80211_band values. For instance, for
4533 * NL80211_BAND_2GHZ, bit 0 would be set
4534 * (i.e. BIT(NL80211_BAND_2GHZ)).
4536 * @txq_limit: configuration of internal TX queue frame limit
4537 * @txq_memory_limit: configuration internal TX queue memory limit
4538 * @txq_quantum: configuration of internal TX queue scheduler quantum
4540 * @support_mbssid: can HW support association with nontransmitted AP
4541 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4542 * HE AP, in order to avoid compatibility issues.
4543 * @support_mbssid must be set for this to have any effect.
4545 * @pmsr_capa: peer measurement capabilities
4548 /* assign these fields before you register the wiphy */
4550 /* permanent MAC address(es) */
4551 u8 perm_addr
[ETH_ALEN
];
4552 u8 addr_mask
[ETH_ALEN
];
4554 struct mac_address
*addresses
;
4556 const struct ieee80211_txrx_stypes
*mgmt_stypes
;
4558 const struct ieee80211_iface_combination
*iface_combinations
;
4559 int n_iface_combinations
;
4560 u16 software_iftypes
;
4564 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4565 u16 interface_modes
;
4567 u16 max_acl_mac_addrs
;
4569 u32 flags
, regulatory_flags
, features
;
4570 u8 ext_features
[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES
, 8)];
4574 enum cfg80211_signal_type signal_type
;
4578 u8 max_sched_scan_reqs
;
4579 u8 max_sched_scan_ssids
;
4581 u16 max_scan_ie_len
;
4582 u16 max_sched_scan_ie_len
;
4583 u32 max_sched_scan_plans
;
4584 u32 max_sched_scan_plan_interval
;
4585 u32 max_sched_scan_plan_iterations
;
4587 int n_cipher_suites
;
4588 const u32
*cipher_suites
;
4591 const u32
*akm_suites
;
4599 char fw_version
[ETHTOOL_FWVERS_LEN
];
4603 const struct wiphy_wowlan_support
*wowlan
;
4604 struct cfg80211_wowlan
*wowlan_config
;
4607 u16 max_remain_on_channel_duration
;
4611 u32 available_antennas_tx
;
4612 u32 available_antennas_rx
;
4615 * Bitmap of supported protocols for probe response offloading
4616 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
4617 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4619 u32 probe_resp_offload
;
4621 const u8
*extended_capabilities
, *extended_capabilities_mask
;
4622 u8 extended_capabilities_len
;
4624 const struct wiphy_iftype_ext_capab
*iftype_ext_capab
;
4625 unsigned int num_iftype_ext_capab
;
4627 /* If multiple wiphys are registered and you're handed e.g.
4628 * a regular netdev with assigned ieee80211_ptr, you won't
4629 * know whether it points to a wiphy your driver has registered
4630 * or not. Assign this to something global to your driver to
4631 * help determine whether you own this wiphy or not. */
4634 struct ieee80211_supported_band
*bands
[NUM_NL80211_BANDS
];
4636 /* Lets us get back the wiphy on the callback */
4637 void (*reg_notifier
)(struct wiphy
*wiphy
,
4638 struct regulatory_request
*request
);
4640 /* fields below are read-only, assigned by cfg80211 */
4642 const struct ieee80211_regdomain __rcu
*regd
;
4644 /* the item in /sys/class/ieee80211/ points to this,
4645 * you need use set_wiphy_dev() (see below) */
4648 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
4651 /* dir in debugfs: ieee80211/<wiphyname> */
4652 struct dentry
*debugfsdir
;
4654 const struct ieee80211_ht_cap
*ht_capa_mod_mask
;
4655 const struct ieee80211_vht_cap
*vht_capa_mod_mask
;
4657 struct list_head wdev_list
;
4659 /* the network namespace this phy lives in currently */
4660 possible_net_t _net
;
4662 #ifdef CONFIG_CFG80211_WEXT
4663 const struct iw_handler_def
*wext
;
4666 const struct wiphy_coalesce_support
*coalesce
;
4668 const struct wiphy_vendor_command
*vendor_commands
;
4669 const struct nl80211_vendor_cmd_info
*vendor_events
;
4670 int n_vendor_commands
, n_vendor_events
;
4672 u16 max_ap_assoc_sta
;
4674 u8 max_num_csa_counters
;
4675 u8 max_adj_channel_rssi_comp
;
4677 u32 bss_select_support
;
4679 u8 nan_supported_bands
;
4682 u32 txq_memory_limit
;
4685 u8 support_mbssid
:1,
4686 support_only_he_mbssid
:1;
4688 const struct cfg80211_pmsr_capabilities
*pmsr_capa
;
4690 char priv
[0] __aligned(NETDEV_ALIGN
);
4693 static inline struct net
*wiphy_net(struct wiphy
*wiphy
)
4695 return read_pnet(&wiphy
->_net
);
4698 static inline void wiphy_net_set(struct wiphy
*wiphy
, struct net
*net
)
4700 write_pnet(&wiphy
->_net
, net
);
4704 * wiphy_priv - return priv from wiphy
4706 * @wiphy: the wiphy whose priv pointer to return
4707 * Return: The priv of @wiphy.
4709 static inline void *wiphy_priv(struct wiphy
*wiphy
)
4712 return &wiphy
->priv
;
4716 * priv_to_wiphy - return the wiphy containing the priv
4718 * @priv: a pointer previously returned by wiphy_priv
4719 * Return: The wiphy of @priv.
4721 static inline struct wiphy
*priv_to_wiphy(void *priv
)
4724 return container_of(priv
, struct wiphy
, priv
);
4728 * set_wiphy_dev - set device pointer for wiphy
4730 * @wiphy: The wiphy whose device to bind
4731 * @dev: The device to parent it to
4733 static inline void set_wiphy_dev(struct wiphy
*wiphy
, struct device
*dev
)
4735 wiphy
->dev
.parent
= dev
;
4739 * wiphy_dev - get wiphy dev pointer
4741 * @wiphy: The wiphy whose device struct to look up
4742 * Return: The dev of @wiphy.
4744 static inline struct device
*wiphy_dev(struct wiphy
*wiphy
)
4746 return wiphy
->dev
.parent
;
4750 * wiphy_name - get wiphy name
4752 * @wiphy: The wiphy whose name to return
4753 * Return: The name of @wiphy.
4755 static inline const char *wiphy_name(const struct wiphy
*wiphy
)
4757 return dev_name(&wiphy
->dev
);
4761 * wiphy_new_nm - create a new wiphy for use with cfg80211
4763 * @ops: The configuration operations for this device
4764 * @sizeof_priv: The size of the private area to allocate
4765 * @requested_name: Request a particular name.
4766 * NULL is valid value, and means use the default phy%d naming.
4768 * Create a new wiphy and associate the given operations with it.
4769 * @sizeof_priv bytes are allocated for private use.
4771 * Return: A pointer to the new wiphy. This pointer must be
4772 * assigned to each netdev's ieee80211_ptr for proper operation.
4774 struct wiphy
*wiphy_new_nm(const struct cfg80211_ops
*ops
, int sizeof_priv
,
4775 const char *requested_name
);
4778 * wiphy_new - create a new wiphy for use with cfg80211
4780 * @ops: The configuration operations for this device
4781 * @sizeof_priv: The size of the private area to allocate
4783 * Create a new wiphy and associate the given operations with it.
4784 * @sizeof_priv bytes are allocated for private use.
4786 * Return: A pointer to the new wiphy. This pointer must be
4787 * assigned to each netdev's ieee80211_ptr for proper operation.
4789 static inline struct wiphy
*wiphy_new(const struct cfg80211_ops
*ops
,
4792 return wiphy_new_nm(ops
, sizeof_priv
, NULL
);
4796 * wiphy_register - register a wiphy with cfg80211
4798 * @wiphy: The wiphy to register.
4800 * Return: A non-negative wiphy index or a negative error code.
4802 int wiphy_register(struct wiphy
*wiphy
);
4805 * wiphy_unregister - deregister a wiphy from cfg80211
4807 * @wiphy: The wiphy to unregister.
4809 * After this call, no more requests can be made with this priv
4810 * pointer, but the call may sleep to wait for an outstanding
4811 * request that is being handled.
4813 void wiphy_unregister(struct wiphy
*wiphy
);
4816 * wiphy_free - free wiphy
4818 * @wiphy: The wiphy to free
4820 void wiphy_free(struct wiphy
*wiphy
);
4822 /* internal structs */
4823 struct cfg80211_conn
;
4824 struct cfg80211_internal_bss
;
4825 struct cfg80211_cached_keys
;
4826 struct cfg80211_cqm_config
;
4829 * struct wireless_dev - wireless device state
4831 * For netdevs, this structure must be allocated by the driver
4832 * that uses the ieee80211_ptr field in struct net_device (this
4833 * is intentional so it can be allocated along with the netdev.)
4834 * It need not be registered then as netdev registration will
4835 * be intercepted by cfg80211 to see the new wireless device.
4837 * For non-netdev uses, it must also be allocated by the driver
4838 * in response to the cfg80211 callbacks that require it, as
4839 * there's no netdev registration in that case it may not be
4840 * allocated outside of callback operations that return it.
4842 * @wiphy: pointer to hardware description
4843 * @iftype: interface type
4844 * @list: (private) Used to collect the interfaces
4845 * @netdev: (private) Used to reference back to the netdev, may be %NULL
4846 * @identifier: (private) Identifier used in nl80211 to identify this
4847 * wireless device if it has no netdev
4848 * @current_bss: (private) Used by the internal configuration code
4849 * @chandef: (private) Used by the internal configuration code to track
4850 * the user-set channel definition.
4851 * @preset_chandef: (private) Used by the internal configuration code to
4852 * track the channel to be used for AP later
4853 * @bssid: (private) Used by the internal configuration code
4854 * @ssid: (private) Used by the internal configuration code
4855 * @ssid_len: (private) Used by the internal configuration code
4856 * @mesh_id_len: (private) Used by the internal configuration code
4857 * @mesh_id_up_len: (private) Used by the internal configuration code
4858 * @wext: (private) Used by the internal wireless extensions compat code
4859 * @wext.ibss: (private) IBSS data part of wext handling
4860 * @wext.connect: (private) connection handling data
4861 * @wext.keys: (private) (WEP) key data
4862 * @wext.ie: (private) extra elements for association
4863 * @wext.ie_len: (private) length of extra elements
4864 * @wext.bssid: (private) selected network BSSID
4865 * @wext.ssid: (private) selected network SSID
4866 * @wext.default_key: (private) selected default key index
4867 * @wext.default_mgmt_key: (private) selected default management key index
4868 * @wext.prev_bssid: (private) previous BSSID for reassociation
4869 * @wext.prev_bssid_valid: (private) previous BSSID validity
4870 * @use_4addr: indicates 4addr mode is used on this interface, must be
4871 * set by driver (if supported) on add_interface BEFORE registering the
4872 * netdev and may otherwise be used by driver read-only, will be update
4873 * by cfg80211 on change_interface
4874 * @mgmt_registrations: list of registrations for management frames
4875 * @mgmt_registrations_lock: lock for the list
4876 * @mtx: mutex used to lock data in this struct, may be used by drivers
4877 * and some API functions require it held
4878 * @beacon_interval: beacon interval used on this device for transmitting
4879 * beacons, 0 when not valid
4880 * @address: The address for this device, valid only if @netdev is %NULL
4881 * @is_running: true if this is a non-netdev device that has been started, e.g.
4883 * @cac_started: true if DFS channel availability check has been started
4884 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4885 * @cac_time_ms: CAC time in ms
4886 * @ps: powersave mode is enabled
4887 * @ps_timeout: dynamic powersave timeout
4888 * @ap_unexpected_nlportid: (private) netlink port ID of application
4889 * registered for unexpected class 3 frames (AP mode)
4890 * @conn: (private) cfg80211 software SME connection state machine data
4891 * @connect_keys: (private) keys to set after connection is established
4892 * @conn_bss_type: connecting/connected BSS type
4893 * @conn_owner_nlportid: (private) connection owner socket port ID
4894 * @disconnect_wk: (private) auto-disconnect work
4895 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4896 * @ibss_fixed: (private) IBSS is using fixed BSSID
4897 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4898 * @event_list: (private) list for internal event processing
4899 * @event_lock: (private) lock for event list
4900 * @owner_nlportid: (private) owner socket port ID
4901 * @nl_owner_dead: (private) owner socket went away
4902 * @cqm_config: (private) nl80211 RSSI monitor state
4903 * @pmsr_list: (private) peer measurement requests
4904 * @pmsr_lock: (private) peer measurements requests/results lock
4905 * @pmsr_free_wk: (private) peer measurements cleanup work
4907 struct wireless_dev
{
4908 struct wiphy
*wiphy
;
4909 enum nl80211_iftype iftype
;
4911 /* the remainder of this struct should be private to cfg80211 */
4912 struct list_head list
;
4913 struct net_device
*netdev
;
4917 struct list_head mgmt_registrations
;
4918 spinlock_t mgmt_registrations_lock
;
4922 bool use_4addr
, is_running
;
4924 u8 address
[ETH_ALEN
] __aligned(sizeof(u16
));
4926 /* currently used for IBSS and SME - might be rearranged later */
4927 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
4928 u8 ssid_len
, mesh_id_len
, mesh_id_up_len
;
4929 struct cfg80211_conn
*conn
;
4930 struct cfg80211_cached_keys
*connect_keys
;
4931 enum ieee80211_bss_type conn_bss_type
;
4932 u32 conn_owner_nlportid
;
4934 struct work_struct disconnect_wk
;
4935 u8 disconnect_bssid
[ETH_ALEN
];
4937 struct list_head event_list
;
4938 spinlock_t event_lock
;
4940 struct cfg80211_internal_bss
*current_bss
; /* associated / joined */
4941 struct cfg80211_chan_def preset_chandef
;
4942 struct cfg80211_chan_def chandef
;
4945 bool ibss_dfs_possible
;
4950 int beacon_interval
;
4952 u32 ap_unexpected_nlportid
;
4958 unsigned long cac_start_time
;
4959 unsigned int cac_time_ms
;
4961 #ifdef CONFIG_CFG80211_WEXT
4964 struct cfg80211_ibss_params ibss
;
4965 struct cfg80211_connect_params connect
;
4966 struct cfg80211_cached_keys
*keys
;
4970 u8 prev_bssid
[ETH_ALEN
];
4971 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
4972 s8 default_key
, default_mgmt_key
;
4973 bool prev_bssid_valid
;
4977 struct cfg80211_cqm_config
*cqm_config
;
4979 struct list_head pmsr_list
;
4980 spinlock_t pmsr_lock
;
4981 struct work_struct pmsr_free_wk
;
4984 static inline u8
*wdev_address(struct wireless_dev
*wdev
)
4987 return wdev
->netdev
->dev_addr
;
4988 return wdev
->address
;
4991 static inline bool wdev_running(struct wireless_dev
*wdev
)
4994 return netif_running(wdev
->netdev
);
4995 return wdev
->is_running
;
4999 * wdev_priv - return wiphy priv from wireless_dev
5001 * @wdev: The wireless device whose wiphy's priv pointer to return
5002 * Return: The wiphy priv of @wdev.
5004 static inline void *wdev_priv(struct wireless_dev
*wdev
)
5007 return wiphy_priv(wdev
->wiphy
);
5011 * DOC: Utility functions
5013 * cfg80211 offers a number of utility functions that can be useful.
5017 * ieee80211_channel_to_frequency - convert channel number to frequency
5018 * @chan: channel number
5019 * @band: band, necessary due to channel number overlap
5020 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5022 int ieee80211_channel_to_frequency(int chan
, enum nl80211_band band
);
5025 * ieee80211_frequency_to_channel - convert frequency to channel number
5026 * @freq: center frequency
5027 * Return: The corresponding channel, or 0 if the conversion failed.
5029 int ieee80211_frequency_to_channel(int freq
);
5032 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5034 * @wiphy: the struct wiphy to get the channel for
5035 * @freq: the center frequency of the channel
5037 * Return: The channel struct from @wiphy at @freq.
5039 struct ieee80211_channel
*ieee80211_get_channel(struct wiphy
*wiphy
, int freq
);
5042 * ieee80211_get_response_rate - get basic rate for a given rate
5044 * @sband: the band to look for rates in
5045 * @basic_rates: bitmap of basic rates
5046 * @bitrate: the bitrate for which to find the basic rate
5048 * Return: The basic rate corresponding to a given bitrate, that
5049 * is the next lower bitrate contained in the basic rate map,
5050 * which is, for this function, given as a bitmap of indices of
5051 * rates in the band's bitrate table.
5053 struct ieee80211_rate
*
5054 ieee80211_get_response_rate(struct ieee80211_supported_band
*sband
,
5055 u32 basic_rates
, int bitrate
);
5058 * ieee80211_mandatory_rates - get mandatory rates for a given band
5059 * @sband: the band to look for rates in
5060 * @scan_width: width of the control channel
5062 * This function returns a bitmap of the mandatory rates for the given
5063 * band, bits are set according to the rate position in the bitrates array.
5065 u32
ieee80211_mandatory_rates(struct ieee80211_supported_band
*sband
,
5066 enum nl80211_bss_scan_width scan_width
);
5069 * Radiotap parsing functions -- for controlled injection support
5071 * Implemented in net/wireless/radiotap.c
5072 * Documentation in Documentation/networking/radiotap-headers.txt
5075 struct radiotap_align_size
{
5076 uint8_t align
:4, size
:4;
5079 struct ieee80211_radiotap_namespace
{
5080 const struct radiotap_align_size
*align_size
;
5086 struct ieee80211_radiotap_vendor_namespaces
{
5087 const struct ieee80211_radiotap_namespace
*ns
;
5092 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5093 * @this_arg_index: index of current arg, valid after each successful call
5094 * to ieee80211_radiotap_iterator_next()
5095 * @this_arg: pointer to current radiotap arg; it is valid after each
5096 * call to ieee80211_radiotap_iterator_next() but also after
5097 * ieee80211_radiotap_iterator_init() where it will point to
5098 * the beginning of the actual data portion
5099 * @this_arg_size: length of the current arg, for convenience
5100 * @current_namespace: pointer to the current namespace definition
5101 * (or internally %NULL if the current namespace is unknown)
5102 * @is_radiotap_ns: indicates whether the current namespace is the default
5103 * radiotap namespace or not
5105 * @_rtheader: pointer to the radiotap header we are walking through
5106 * @_max_length: length of radiotap header in cpu byte ordering
5107 * @_arg_index: next argument index
5108 * @_arg: next argument pointer
5109 * @_next_bitmap: internal pointer to next present u32
5110 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5111 * @_vns: vendor namespace definitions
5112 * @_next_ns_data: beginning of the next namespace's data
5113 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5116 * Describes the radiotap parser state. Fields prefixed with an underscore
5117 * must not be used by users of the parser, only by the parser internally.
5120 struct ieee80211_radiotap_iterator
{
5121 struct ieee80211_radiotap_header
*_rtheader
;
5122 const struct ieee80211_radiotap_vendor_namespaces
*_vns
;
5123 const struct ieee80211_radiotap_namespace
*current_namespace
;
5125 unsigned char *_arg
, *_next_ns_data
;
5126 __le32
*_next_bitmap
;
5128 unsigned char *this_arg
;
5136 uint32_t _bitmap_shifter
;
5141 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator
*iterator
,
5142 struct ieee80211_radiotap_header
*radiotap_header
,
5144 const struct ieee80211_radiotap_vendor_namespaces
*vns
);
5147 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator
*iterator
);
5150 extern const unsigned char rfc1042_header
[6];
5151 extern const unsigned char bridge_tunnel_header
[6];
5154 * ieee80211_get_hdrlen_from_skb - get header length from data
5158 * Given an skb with a raw 802.11 header at the data pointer this function
5159 * returns the 802.11 header length.
5161 * Return: The 802.11 header length in bytes (not including encryption
5162 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5165 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
5168 * ieee80211_hdrlen - get header length in bytes from frame control
5169 * @fc: frame control field in little-endian format
5170 * Return: The header length in bytes.
5172 unsigned int __attribute_const__
ieee80211_hdrlen(__le16 fc
);
5175 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5176 * @meshhdr: the mesh extension header, only the flags field
5177 * (first byte) will be accessed
5178 * Return: The length of the extension header, which is always at
5179 * least 6 bytes and at most 18 if address 5 and 6 are present.
5181 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr
*meshhdr
);
5184 * DOC: Data path helpers
5186 * In addition to generic utilities, cfg80211 also offers
5187 * functions that help implement the data path for devices
5188 * that do not do the 802.11/802.3 conversion on the device.
5192 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5193 * @skb: the 802.11 data frame
5194 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5195 * of it being pushed into the SKB
5196 * @addr: the device MAC address
5197 * @iftype: the virtual interface type
5198 * @data_offset: offset of payload after the 802.11 header
5199 * Return: 0 on success. Non-zero on error.
5201 int ieee80211_data_to_8023_exthdr(struct sk_buff
*skb
, struct ethhdr
*ehdr
,
5202 const u8
*addr
, enum nl80211_iftype iftype
,
5206 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5207 * @skb: the 802.11 data frame
5208 * @addr: the device MAC address
5209 * @iftype: the virtual interface type
5210 * Return: 0 on success. Non-zero on error.
5212 static inline int ieee80211_data_to_8023(struct sk_buff
*skb
, const u8
*addr
,
5213 enum nl80211_iftype iftype
)
5215 return ieee80211_data_to_8023_exthdr(skb
, NULL
, addr
, iftype
, 0);
5219 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5221 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5222 * The @list will be empty if the decode fails. The @skb must be fully
5223 * header-less before being passed in here; it is freed in this function.
5225 * @skb: The input A-MSDU frame without any headers.
5226 * @list: The output list of 802.3 frames. It must be allocated and
5227 * initialized by by the caller.
5228 * @addr: The device MAC address.
5229 * @iftype: The device interface type.
5230 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5231 * @check_da: DA to check in the inner ethernet header, or NULL
5232 * @check_sa: SA to check in the inner ethernet header, or NULL
5234 void ieee80211_amsdu_to_8023s(struct sk_buff
*skb
, struct sk_buff_head
*list
,
5235 const u8
*addr
, enum nl80211_iftype iftype
,
5236 const unsigned int extra_headroom
,
5237 const u8
*check_da
, const u8
*check_sa
);
5240 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5241 * @skb: the data frame
5242 * @qos_map: Interworking QoS mapping or %NULL if not in use
5243 * Return: The 802.1p/1d tag.
5245 unsigned int cfg80211_classify8021d(struct sk_buff
*skb
,
5246 struct cfg80211_qos_map
*qos_map
);
5249 * cfg80211_find_elem_match - match information element and byte array in data
5252 * @ies: data consisting of IEs
5253 * @len: length of data
5254 * @match: byte array to match
5255 * @match_len: number of bytes in the match array
5256 * @match_offset: offset in the IE data where the byte array should match.
5257 * Note the difference to cfg80211_find_ie_match() which considers
5258 * the offset to start from the element ID byte, but here we take
5259 * the data portion instead.
5261 * Return: %NULL if the element ID could not be found or if
5262 * the element is invalid (claims to be longer than the given
5263 * data) or if the byte array doesn't match; otherwise return the
5264 * requested element struct.
5266 * Note: There are no checks on the element length other than
5267 * having to fit into the given data and being large enough for the
5268 * byte array to match.
5270 const struct element
*
5271 cfg80211_find_elem_match(u8 eid
, const u8
*ies
, unsigned int len
,
5272 const u8
*match
, unsigned int match_len
,
5273 unsigned int match_offset
);
5276 * cfg80211_find_ie_match - match information element and byte array in data
5279 * @ies: data consisting of IEs
5280 * @len: length of data
5281 * @match: byte array to match
5282 * @match_len: number of bytes in the match array
5283 * @match_offset: offset in the IE where the byte array should match.
5284 * If match_len is zero, this must also be set to zero.
5285 * Otherwise this must be set to 2 or more, because the first
5286 * byte is the element id, which is already compared to eid, and
5287 * the second byte is the IE length.
5289 * Return: %NULL if the element ID could not be found or if
5290 * the element is invalid (claims to be longer than the given
5291 * data) or if the byte array doesn't match, or a pointer to the first
5292 * byte of the requested element, that is the byte containing the
5295 * Note: There are no checks on the element length other than
5296 * having to fit into the given data and being large enough for the
5297 * byte array to match.
5299 static inline const u8
*
5300 cfg80211_find_ie_match(u8 eid
, const u8
*ies
, unsigned int len
,
5301 const u8
*match
, unsigned int match_len
,
5302 unsigned int match_offset
)
5304 /* match_offset can't be smaller than 2, unless match_len is
5305 * zero, in which case match_offset must be zero as well.
5307 if (WARN_ON((match_len
&& match_offset
< 2) ||
5308 (!match_len
&& match_offset
)))
5311 return (void *)cfg80211_find_elem_match(eid
, ies
, len
,
5314 match_offset
- 2 : 0);
5318 * cfg80211_find_elem - find information element in data
5321 * @ies: data consisting of IEs
5322 * @len: length of data
5324 * Return: %NULL if the element ID could not be found or if
5325 * the element is invalid (claims to be longer than the given
5326 * data) or if the byte array doesn't match; otherwise return the
5327 * requested element struct.
5329 * Note: There are no checks on the element length other than
5330 * having to fit into the given data.
5332 static inline const struct element
*
5333 cfg80211_find_elem(u8 eid
, const u8
*ies
, int len
)
5335 return cfg80211_find_elem_match(eid
, ies
, len
, NULL
, 0, 0);
5339 * cfg80211_find_ie - find information element in data
5342 * @ies: data consisting of IEs
5343 * @len: length of data
5345 * Return: %NULL if the element ID could not be found or if
5346 * the element is invalid (claims to be longer than the given
5347 * data), or a pointer to the first byte of the requested
5348 * element, that is the byte containing the element ID.
5350 * Note: There are no checks on the element length other than
5351 * having to fit into the given data.
5353 static inline const u8
*cfg80211_find_ie(u8 eid
, const u8
*ies
, int len
)
5355 return cfg80211_find_ie_match(eid
, ies
, len
, NULL
, 0, 0);
5359 * cfg80211_find_ext_elem - find information element with EID Extension in data
5361 * @ext_eid: element ID Extension
5362 * @ies: data consisting of IEs
5363 * @len: length of data
5365 * Return: %NULL if the etended element could not be found or if
5366 * the element is invalid (claims to be longer than the given
5367 * data) or if the byte array doesn't match; otherwise return the
5368 * requested element struct.
5370 * Note: There are no checks on the element length other than
5371 * having to fit into the given data.
5373 static inline const struct element
*
5374 cfg80211_find_ext_elem(u8 ext_eid
, const u8
*ies
, int len
)
5376 return cfg80211_find_elem_match(WLAN_EID_EXTENSION
, ies
, len
,
5381 * cfg80211_find_ext_ie - find information element with EID Extension in data
5383 * @ext_eid: element ID Extension
5384 * @ies: data consisting of IEs
5385 * @len: length of data
5387 * Return: %NULL if the extended element ID could not be found or if
5388 * the element is invalid (claims to be longer than the given
5389 * data), or a pointer to the first byte of the requested
5390 * element, that is the byte containing the element ID.
5392 * Note: There are no checks on the element length other than
5393 * having to fit into the given data.
5395 static inline const u8
*cfg80211_find_ext_ie(u8 ext_eid
, const u8
*ies
, int len
)
5397 return cfg80211_find_ie_match(WLAN_EID_EXTENSION
, ies
, len
,
5402 * cfg80211_find_vendor_elem - find vendor specific information element in data
5405 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5406 * @ies: data consisting of IEs
5407 * @len: length of data
5409 * Return: %NULL if the vendor specific element ID could not be found or if the
5410 * element is invalid (claims to be longer than the given data); otherwise
5411 * return the element structure for the requested element.
5413 * Note: There are no checks on the element length other than having to fit into
5416 const struct element
*cfg80211_find_vendor_elem(unsigned int oui
, int oui_type
,
5421 * cfg80211_find_vendor_ie - find vendor specific information element in data
5424 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5425 * @ies: data consisting of IEs
5426 * @len: length of data
5428 * Return: %NULL if the vendor specific element ID could not be found or if the
5429 * element is invalid (claims to be longer than the given data), or a pointer to
5430 * the first byte of the requested element, that is the byte containing the
5433 * Note: There are no checks on the element length other than having to fit into
5436 static inline const u8
*
5437 cfg80211_find_vendor_ie(unsigned int oui
, int oui_type
,
5438 const u8
*ies
, unsigned int len
)
5440 return (void *)cfg80211_find_vendor_elem(oui
, oui_type
, ies
, len
);
5444 * cfg80211_send_layer2_update - send layer 2 update frame
5446 * @dev: network device
5447 * @addr: STA MAC address
5449 * Wireless drivers can use this function to update forwarding tables in bridge
5450 * devices upon STA association.
5452 void cfg80211_send_layer2_update(struct net_device
*dev
, const u8
*addr
);
5455 * DOC: Regulatory enforcement infrastructure
5461 * regulatory_hint - driver hint to the wireless core a regulatory domain
5462 * @wiphy: the wireless device giving the hint (used only for reporting
5464 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5465 * should be in. If @rd is set this should be NULL. Note that if you
5466 * set this to NULL you should still set rd->alpha2 to some accepted
5469 * Wireless drivers can use this function to hint to the wireless core
5470 * what it believes should be the current regulatory domain by
5471 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5472 * domain should be in or by providing a completely build regulatory domain.
5473 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5474 * for a regulatory domain structure for the respective country.
5476 * The wiphy must have been registered to cfg80211 prior to this call.
5477 * For cfg80211 drivers this means you must first use wiphy_register(),
5478 * for mac80211 drivers you must first use ieee80211_register_hw().
5480 * Drivers should check the return value, its possible you can get
5483 * Return: 0 on success. -ENOMEM.
5485 int regulatory_hint(struct wiphy
*wiphy
, const char *alpha2
);
5488 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5489 * @wiphy: the wireless device we want to process the regulatory domain on
5490 * @rd: the regulatory domain informatoin to use for this wiphy
5492 * Set the regulatory domain information for self-managed wiphys, only they
5493 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5496 * Return: 0 on success. -EINVAL, -EPERM
5498 int regulatory_set_wiphy_regd(struct wiphy
*wiphy
,
5499 struct ieee80211_regdomain
*rd
);
5502 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5503 * @wiphy: the wireless device we want to process the regulatory domain on
5504 * @rd: the regulatory domain information to use for this wiphy
5506 * This functions requires the RTNL to be held and applies the new regdomain
5507 * synchronously to this wiphy. For more details see
5508 * regulatory_set_wiphy_regd().
5510 * Return: 0 on success. -EINVAL, -EPERM
5512 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy
*wiphy
,
5513 struct ieee80211_regdomain
*rd
);
5516 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5517 * @wiphy: the wireless device we want to process the regulatory domain on
5518 * @regd: the custom regulatory domain to use for this wiphy
5520 * Drivers can sometimes have custom regulatory domains which do not apply
5521 * to a specific country. Drivers can use this to apply such custom regulatory
5522 * domains. This routine must be called prior to wiphy registration. The
5523 * custom regulatory domain will be trusted completely and as such previous
5524 * default channel settings will be disregarded. If no rule is found for a
5525 * channel on the regulatory domain the channel will be disabled.
5526 * Drivers using this for a wiphy should also set the wiphy flag
5527 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5528 * that called this helper.
5530 void wiphy_apply_custom_regulatory(struct wiphy
*wiphy
,
5531 const struct ieee80211_regdomain
*regd
);
5534 * freq_reg_info - get regulatory information for the given frequency
5535 * @wiphy: the wiphy for which we want to process this rule for
5536 * @center_freq: Frequency in KHz for which we want regulatory information for
5538 * Use this function to get the regulatory rule for a specific frequency on
5539 * a given wireless device. If the device has a specific regulatory domain
5540 * it wants to follow we respect that unless a country IE has been received
5541 * and processed already.
5543 * Return: A valid pointer, or, when an error occurs, for example if no rule
5544 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5545 * check and PTR_ERR() to obtain the numeric return value. The numeric return
5546 * value will be -ERANGE if we determine the given center_freq does not even
5547 * have a regulatory rule for a frequency range in the center_freq's band.
5548 * See freq_in_rule_band() for our current definition of a band -- this is
5549 * purely subjective and right now it's 802.11 specific.
5551 const struct ieee80211_reg_rule
*freq_reg_info(struct wiphy
*wiphy
,
5555 * reg_initiator_name - map regulatory request initiator enum to name
5556 * @initiator: the regulatory request initiator
5558 * You can use this to map the regulatory request initiator enum to a
5559 * proper string representation.
5561 const char *reg_initiator_name(enum nl80211_reg_initiator initiator
);
5564 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
5565 * @wiphy: wiphy for which pre-CAC capability is checked.
5567 * Pre-CAC is allowed only in some regdomains (notable ETSI).
5569 bool regulatory_pre_cac_allowed(struct wiphy
*wiphy
);
5572 * DOC: Internal regulatory db functions
5577 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
5578 * Regulatory self-managed driver can use it to proactively
5580 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5581 * @freq: the freqency(in MHz) to be queried.
5582 * @rule: pointer to store the wmm rule from the regulatory db.
5584 * Self-managed wireless drivers can use this function to query
5585 * the internal regulatory database to check whether the given
5586 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5588 * Drivers should check the return value, its possible you can get
5591 * Return: 0 on success. -ENODATA.
5593 int reg_query_regdb_wmm(char *alpha2
, int freq
,
5594 struct ieee80211_reg_rule
*rule
);
5597 * callbacks for asynchronous cfg80211 methods, notification
5598 * functions and BSS handling helpers
5602 * cfg80211_scan_done - notify that scan finished
5604 * @request: the corresponding scan request
5605 * @info: information about the completed scan
5607 void cfg80211_scan_done(struct cfg80211_scan_request
*request
,
5608 struct cfg80211_scan_info
*info
);
5611 * cfg80211_sched_scan_results - notify that new scan results are available
5613 * @wiphy: the wiphy which got scheduled scan results
5614 * @reqid: identifier for the related scheduled scan request
5616 void cfg80211_sched_scan_results(struct wiphy
*wiphy
, u64 reqid
);
5619 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5621 * @wiphy: the wiphy on which the scheduled scan stopped
5622 * @reqid: identifier for the related scheduled scan request
5624 * The driver can call this function to inform cfg80211 that the
5625 * scheduled scan had to be stopped, for whatever reason. The driver
5626 * is then called back via the sched_scan_stop operation when done.
5628 void cfg80211_sched_scan_stopped(struct wiphy
*wiphy
, u64 reqid
);
5631 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5633 * @wiphy: the wiphy on which the scheduled scan stopped
5634 * @reqid: identifier for the related scheduled scan request
5636 * The driver can call this function to inform cfg80211 that the
5637 * scheduled scan had to be stopped, for whatever reason. The driver
5638 * is then called back via the sched_scan_stop operation when done.
5639 * This function should be called with rtnl locked.
5641 void cfg80211_sched_scan_stopped_rtnl(struct wiphy
*wiphy
, u64 reqid
);
5644 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5645 * @wiphy: the wiphy reporting the BSS
5646 * @data: the BSS metadata
5647 * @mgmt: the management frame (probe response or beacon)
5648 * @len: length of the management frame
5649 * @gfp: context flags
5651 * This informs cfg80211 that BSS information was found and
5652 * the BSS should be updated/added.
5654 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5655 * Or %NULL on error.
5657 struct cfg80211_bss
* __must_check
5658 cfg80211_inform_bss_frame_data(struct wiphy
*wiphy
,
5659 struct cfg80211_inform_bss
*data
,
5660 struct ieee80211_mgmt
*mgmt
, size_t len
,
5663 static inline struct cfg80211_bss
* __must_check
5664 cfg80211_inform_bss_width_frame(struct wiphy
*wiphy
,
5665 struct ieee80211_channel
*rx_channel
,
5666 enum nl80211_bss_scan_width scan_width
,
5667 struct ieee80211_mgmt
*mgmt
, size_t len
,
5668 s32 signal
, gfp_t gfp
)
5670 struct cfg80211_inform_bss data
= {
5672 .scan_width
= scan_width
,
5676 return cfg80211_inform_bss_frame_data(wiphy
, &data
, mgmt
, len
, gfp
);
5679 static inline struct cfg80211_bss
* __must_check
5680 cfg80211_inform_bss_frame(struct wiphy
*wiphy
,
5681 struct ieee80211_channel
*rx_channel
,
5682 struct ieee80211_mgmt
*mgmt
, size_t len
,
5683 s32 signal
, gfp_t gfp
)
5685 struct cfg80211_inform_bss data
= {
5687 .scan_width
= NL80211_BSS_CHAN_WIDTH_20
,
5691 return cfg80211_inform_bss_frame_data(wiphy
, &data
, mgmt
, len
, gfp
);
5695 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5696 * @bssid: transmitter BSSID
5697 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5698 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5699 * @new_bssid: calculated nontransmitted BSSID
5701 static inline void cfg80211_gen_new_bssid(const u8
*bssid
, u8 max_bssid
,
5702 u8 mbssid_index
, u8
*new_bssid
)
5704 u64 bssid_u64
= ether_addr_to_u64(bssid
);
5705 u64 mask
= GENMASK_ULL(max_bssid
- 1, 0);
5708 new_bssid_u64
= bssid_u64
& ~mask
;
5710 new_bssid_u64
|= ((bssid_u64
& mask
) + mbssid_index
) & mask
;
5712 u64_to_ether_addr(new_bssid_u64
, new_bssid
);
5716 * cfg80211_is_element_inherited - returns if element ID should be inherited
5717 * @element: element to check
5718 * @non_inherit_element: non inheritance element
5720 bool cfg80211_is_element_inherited(const struct element
*element
,
5721 const struct element
*non_inherit_element
);
5724 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
5726 * @ielen: length of IEs
5727 * @mbssid_elem: current MBSSID element
5728 * @sub_elem: current MBSSID subelement (profile)
5729 * @merged_ie: location of the merged profile
5730 * @max_copy_len: max merged profile length
5732 size_t cfg80211_merge_profile(const u8
*ie
, size_t ielen
,
5733 const struct element
*mbssid_elem
,
5734 const struct element
*sub_elem
,
5735 u8
*merged_ie
, size_t max_copy_len
);
5738 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
5739 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
5740 * from a beacon or probe response
5741 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
5742 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
5744 enum cfg80211_bss_frame_type
{
5745 CFG80211_BSS_FTYPE_UNKNOWN
,
5746 CFG80211_BSS_FTYPE_BEACON
,
5747 CFG80211_BSS_FTYPE_PRESP
,
5751 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
5753 * @wiphy: the wiphy reporting the BSS
5754 * @data: the BSS metadata
5755 * @ftype: frame type (if known)
5756 * @bssid: the BSSID of the BSS
5757 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5758 * @capability: the capability field sent by the peer
5759 * @beacon_interval: the beacon interval announced by the peer
5760 * @ie: additional IEs sent by the peer
5761 * @ielen: length of the additional IEs
5762 * @gfp: context flags
5764 * This informs cfg80211 that BSS information was found and
5765 * the BSS should be updated/added.
5767 * Return: A referenced struct, must be released with cfg80211_put_bss()!
5768 * Or %NULL on error.
5770 struct cfg80211_bss
* __must_check
5771 cfg80211_inform_bss_data(struct wiphy
*wiphy
,
5772 struct cfg80211_inform_bss
*data
,
5773 enum cfg80211_bss_frame_type ftype
,
5774 const u8
*bssid
, u64 tsf
, u16 capability
,
5775 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
5778 static inline struct cfg80211_bss
* __must_check
5779 cfg80211_inform_bss_width(struct wiphy
*wiphy
,
5780 struct ieee80211_channel
*rx_channel
,
5781 enum nl80211_bss_scan_width scan_width
,
5782 enum cfg80211_bss_frame_type ftype
,
5783 const u8
*bssid
, u64 tsf
, u16 capability
,
5784 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
5785 s32 signal
, gfp_t gfp
)
5787 struct cfg80211_inform_bss data
= {
5789 .scan_width
= scan_width
,
5793 return cfg80211_inform_bss_data(wiphy
, &data
, ftype
, bssid
, tsf
,
5794 capability
, beacon_interval
, ie
, ielen
,
5798 static inline struct cfg80211_bss
* __must_check
5799 cfg80211_inform_bss(struct wiphy
*wiphy
,
5800 struct ieee80211_channel
*rx_channel
,
5801 enum cfg80211_bss_frame_type ftype
,
5802 const u8
*bssid
, u64 tsf
, u16 capability
,
5803 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
5804 s32 signal
, gfp_t gfp
)
5806 struct cfg80211_inform_bss data
= {
5808 .scan_width
= NL80211_BSS_CHAN_WIDTH_20
,
5812 return cfg80211_inform_bss_data(wiphy
, &data
, ftype
, bssid
, tsf
,
5813 capability
, beacon_interval
, ie
, ielen
,
5818 * cfg80211_get_bss - get a BSS reference
5819 * @wiphy: the wiphy this BSS struct belongs to
5820 * @channel: the channel to search on (or %NULL)
5821 * @bssid: the desired BSSID (or %NULL)
5822 * @ssid: the desired SSID (or %NULL)
5823 * @ssid_len: length of the SSID (or 0)
5824 * @bss_type: type of BSS, see &enum ieee80211_bss_type
5825 * @privacy: privacy filter, see &enum ieee80211_privacy
5827 struct cfg80211_bss
*cfg80211_get_bss(struct wiphy
*wiphy
,
5828 struct ieee80211_channel
*channel
,
5830 const u8
*ssid
, size_t ssid_len
,
5831 enum ieee80211_bss_type bss_type
,
5832 enum ieee80211_privacy privacy
);
5833 static inline struct cfg80211_bss
*
5834 cfg80211_get_ibss(struct wiphy
*wiphy
,
5835 struct ieee80211_channel
*channel
,
5836 const u8
*ssid
, size_t ssid_len
)
5838 return cfg80211_get_bss(wiphy
, channel
, NULL
, ssid
, ssid_len
,
5839 IEEE80211_BSS_TYPE_IBSS
,
5840 IEEE80211_PRIVACY_ANY
);
5844 * cfg80211_ref_bss - reference BSS struct
5845 * @wiphy: the wiphy this BSS struct belongs to
5846 * @bss: the BSS struct to reference
5848 * Increments the refcount of the given BSS struct.
5850 void cfg80211_ref_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
5853 * cfg80211_put_bss - unref BSS struct
5854 * @wiphy: the wiphy this BSS struct belongs to
5855 * @bss: the BSS struct
5857 * Decrements the refcount of the given BSS struct.
5859 void cfg80211_put_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
5862 * cfg80211_unlink_bss - unlink BSS from internal data structures
5864 * @bss: the bss to remove
5866 * This function removes the given BSS from the internal data structures
5867 * thereby making it no longer show up in scan results etc. Use this
5868 * function when you detect a BSS is gone. Normally BSSes will also time
5869 * out, so it is not necessary to use this function at all.
5871 void cfg80211_unlink_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
5874 * cfg80211_bss_iter - iterate all BSS entries
5876 * This function iterates over the BSS entries associated with the given wiphy
5877 * and calls the callback for the iterated BSS. The iterator function is not
5878 * allowed to call functions that might modify the internal state of the BSS DB.
5881 * @chandef: if given, the iterator function will be called only if the channel
5882 * of the currently iterated BSS is a subset of the given channel.
5883 * @iter: the iterator function to call
5884 * @iter_data: an argument to the iterator function
5886 void cfg80211_bss_iter(struct wiphy
*wiphy
,
5887 struct cfg80211_chan_def
*chandef
,
5888 void (*iter
)(struct wiphy
*wiphy
,
5889 struct cfg80211_bss
*bss
,
5893 static inline enum nl80211_bss_scan_width
5894 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def
*chandef
)
5896 switch (chandef
->width
) {
5897 case NL80211_CHAN_WIDTH_5
:
5898 return NL80211_BSS_CHAN_WIDTH_5
;
5899 case NL80211_CHAN_WIDTH_10
:
5900 return NL80211_BSS_CHAN_WIDTH_10
;
5902 return NL80211_BSS_CHAN_WIDTH_20
;
5907 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5908 * @dev: network device
5909 * @buf: authentication frame (header + body)
5910 * @len: length of the frame data
5912 * This function is called whenever an authentication, disassociation or
5913 * deauthentication frame has been received and processed in station mode.
5914 * After being asked to authenticate via cfg80211_ops::auth() the driver must
5915 * call either this function or cfg80211_auth_timeout().
5916 * After being asked to associate via cfg80211_ops::assoc() the driver must
5917 * call either this function or cfg80211_auth_timeout().
5918 * While connected, the driver must calls this for received and processed
5919 * disassociation and deauthentication frames. If the frame couldn't be used
5920 * because it was unprotected, the driver must call the function
5921 * cfg80211_rx_unprot_mlme_mgmt() instead.
5923 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5925 void cfg80211_rx_mlme_mgmt(struct net_device
*dev
, const u8
*buf
, size_t len
);
5928 * cfg80211_auth_timeout - notification of timed out authentication
5929 * @dev: network device
5930 * @addr: The MAC address of the device with which the authentication timed out
5932 * This function may sleep. The caller must hold the corresponding wdev's
5935 void cfg80211_auth_timeout(struct net_device
*dev
, const u8
*addr
);
5938 * cfg80211_rx_assoc_resp - notification of processed association response
5939 * @dev: network device
5940 * @bss: the BSS that association was requested with, ownership of the pointer
5941 * moves to cfg80211 in this call
5942 * @buf: (Re)Association Response frame (header + body)
5943 * @len: length of the frame data
5944 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5945 * as the AC bitmap in the QoS info field
5946 * @req_ies: information elements from the (Re)Association Request frame
5947 * @req_ies_len: length of req_ies data
5949 * After being asked to associate via cfg80211_ops::assoc() the driver must
5950 * call either this function or cfg80211_auth_timeout().
5952 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5954 void cfg80211_rx_assoc_resp(struct net_device
*dev
,
5955 struct cfg80211_bss
*bss
,
5956 const u8
*buf
, size_t len
,
5958 const u8
*req_ies
, size_t req_ies_len
);
5961 * cfg80211_assoc_timeout - notification of timed out association
5962 * @dev: network device
5963 * @bss: The BSS entry with which association timed out.
5965 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5967 void cfg80211_assoc_timeout(struct net_device
*dev
, struct cfg80211_bss
*bss
);
5970 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5971 * @dev: network device
5972 * @bss: The BSS entry with which association was abandoned.
5974 * Call this whenever - for reasons reported through other API, like deauth RX,
5975 * an association attempt was abandoned.
5976 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5978 void cfg80211_abandon_assoc(struct net_device
*dev
, struct cfg80211_bss
*bss
);
5981 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
5982 * @dev: network device
5983 * @buf: 802.11 frame (header + body)
5984 * @len: length of the frame data
5986 * This function is called whenever deauthentication has been processed in
5987 * station mode. This includes both received deauthentication frames and
5988 * locally generated ones. This function may sleep. The caller must hold the
5989 * corresponding wdev's mutex.
5991 void cfg80211_tx_mlme_mgmt(struct net_device
*dev
, const u8
*buf
, size_t len
);
5994 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
5995 * @dev: network device
5996 * @buf: deauthentication frame (header + body)
5997 * @len: length of the frame data
5999 * This function is called whenever a received deauthentication or dissassoc
6000 * frame has been dropped in station mode because of MFP being used but the
6001 * frame was not protected. This function may sleep.
6003 void cfg80211_rx_unprot_mlme_mgmt(struct net_device
*dev
,
6004 const u8
*buf
, size_t len
);
6007 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6008 * @dev: network device
6009 * @addr: The source MAC address of the frame
6010 * @key_type: The key type that the received frame used
6011 * @key_id: Key identifier (0..3). Can be -1 if missing.
6012 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6013 * @gfp: allocation flags
6015 * This function is called whenever the local MAC detects a MIC failure in a
6016 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6019 void cfg80211_michael_mic_failure(struct net_device
*dev
, const u8
*addr
,
6020 enum nl80211_key_type key_type
, int key_id
,
6021 const u8
*tsc
, gfp_t gfp
);
6024 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6026 * @dev: network device
6027 * @bssid: the BSSID of the IBSS joined
6028 * @channel: the channel of the IBSS joined
6029 * @gfp: allocation flags
6031 * This function notifies cfg80211 that the device joined an IBSS or
6032 * switched to a different BSSID. Before this function can be called,
6033 * either a beacon has to have been received from the IBSS, or one of
6034 * the cfg80211_inform_bss{,_frame} functions must have been called
6035 * with the locally generated beacon -- this guarantees that there is
6036 * always a scan result for this IBSS. cfg80211 will handle the rest.
6038 void cfg80211_ibss_joined(struct net_device
*dev
, const u8
*bssid
,
6039 struct ieee80211_channel
*channel
, gfp_t gfp
);
6042 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
6044 * @dev: network device
6045 * @macaddr: the MAC address of the new candidate
6046 * @ie: information elements advertised by the peer candidate
6047 * @ie_len: length of the information elements buffer
6048 * @gfp: allocation flags
6050 * This function notifies cfg80211 that the mesh peer candidate has been
6051 * detected, most likely via a beacon or, less likely, via a probe response.
6052 * cfg80211 then sends a notification to userspace.
6054 void cfg80211_notify_new_peer_candidate(struct net_device
*dev
,
6055 const u8
*macaddr
, const u8
*ie
, u8 ie_len
,
6056 int sig_dbm
, gfp_t gfp
);
6059 * DOC: RFkill integration
6061 * RFkill integration in cfg80211 is almost invisible to drivers,
6062 * as cfg80211 automatically registers an rfkill instance for each
6063 * wireless device it knows about. Soft kill is also translated
6064 * into disconnecting and turning all interfaces off, drivers are
6065 * expected to turn off the device when all interfaces are down.
6067 * However, devices may have a hard RFkill line, in which case they
6068 * also need to interact with the rfkill subsystem, via cfg80211.
6069 * They can do this with a few helper functions documented here.
6073 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6075 * @blocked: block status
6077 void wiphy_rfkill_set_hw_state(struct wiphy
*wiphy
, bool blocked
);
6080 * wiphy_rfkill_start_polling - start polling rfkill
6083 void wiphy_rfkill_start_polling(struct wiphy
*wiphy
);
6086 * wiphy_rfkill_stop_polling - stop polling rfkill
6089 void wiphy_rfkill_stop_polling(struct wiphy
*wiphy
);
6092 * DOC: Vendor commands
6094 * Occasionally, there are special protocol or firmware features that
6095 * can't be implemented very openly. For this and similar cases, the
6096 * vendor command functionality allows implementing the features with
6097 * (typically closed-source) userspace and firmware, using nl80211 as
6098 * the configuration mechanism.
6100 * A driver supporting vendor commands must register them as an array
6101 * in struct wiphy, with handlers for each one, each command has an
6102 * OUI and sub command ID to identify it.
6104 * Note that this feature should not be (ab)used to implement protocol
6105 * features that could openly be shared across drivers. In particular,
6106 * it must never be required to use vendor commands to implement any
6107 * "normal" functionality that higher-level userspace like connection
6108 * managers etc. need.
6111 struct sk_buff
*__cfg80211_alloc_reply_skb(struct wiphy
*wiphy
,
6112 enum nl80211_commands cmd
,
6113 enum nl80211_attrs attr
,
6116 struct sk_buff
*__cfg80211_alloc_event_skb(struct wiphy
*wiphy
,
6117 struct wireless_dev
*wdev
,
6118 enum nl80211_commands cmd
,
6119 enum nl80211_attrs attr
,
6120 unsigned int portid
,
6121 int vendor_event_idx
,
6122 int approxlen
, gfp_t gfp
);
6124 void __cfg80211_send_event_skb(struct sk_buff
*skb
, gfp_t gfp
);
6127 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6129 * @approxlen: an upper bound of the length of the data that will
6130 * be put into the skb
6132 * This function allocates and pre-fills an skb for a reply to
6133 * a vendor command. Since it is intended for a reply, calling
6134 * it outside of a vendor command's doit() operation is invalid.
6136 * The returned skb is pre-filled with some identifying data in
6137 * a way that any data that is put into the skb (with skb_put(),
6138 * nla_put() or similar) will end up being within the
6139 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6140 * with the skb is adding data for the corresponding userspace tool
6141 * which can then read that data out of the vendor data attribute.
6142 * You must not modify the skb in any other way.
6144 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6145 * its error code as the result of the doit() operation.
6147 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6149 static inline struct sk_buff
*
6150 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy
*wiphy
, int approxlen
)
6152 return __cfg80211_alloc_reply_skb(wiphy
, NL80211_CMD_VENDOR
,
6153 NL80211_ATTR_VENDOR_DATA
, approxlen
);
6157 * cfg80211_vendor_cmd_reply - send the reply skb
6158 * @skb: The skb, must have been allocated with
6159 * cfg80211_vendor_cmd_alloc_reply_skb()
6161 * Since calling this function will usually be the last thing
6162 * before returning from the vendor command doit() you should
6163 * return the error code. Note that this function consumes the
6164 * skb regardless of the return value.
6166 * Return: An error code or 0 on success.
6168 int cfg80211_vendor_cmd_reply(struct sk_buff
*skb
);
6171 * cfg80211_vendor_cmd_get_sender
6174 * Return the current netlink port ID in a vendor command handler.
6175 * Valid to call only there.
6177 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy
*wiphy
);
6180 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6182 * @wdev: the wireless device
6183 * @event_idx: index of the vendor event in the wiphy's vendor_events
6184 * @approxlen: an upper bound of the length of the data that will
6185 * be put into the skb
6186 * @gfp: allocation flags
6188 * This function allocates and pre-fills an skb for an event on the
6189 * vendor-specific multicast group.
6191 * If wdev != NULL, both the ifindex and identifier of the specified
6192 * wireless device are added to the event message before the vendor data
6195 * When done filling the skb, call cfg80211_vendor_event() with the
6196 * skb to send the event.
6198 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6200 static inline struct sk_buff
*
6201 cfg80211_vendor_event_alloc(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
6202 int approxlen
, int event_idx
, gfp_t gfp
)
6204 return __cfg80211_alloc_event_skb(wiphy
, wdev
, NL80211_CMD_VENDOR
,
6205 NL80211_ATTR_VENDOR_DATA
,
6206 0, event_idx
, approxlen
, gfp
);
6210 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6212 * @wdev: the wireless device
6213 * @event_idx: index of the vendor event in the wiphy's vendor_events
6214 * @portid: port ID of the receiver
6215 * @approxlen: an upper bound of the length of the data that will
6216 * be put into the skb
6217 * @gfp: allocation flags
6219 * This function allocates and pre-fills an skb for an event to send to
6220 * a specific (userland) socket. This socket would previously have been
6221 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6222 * care to register a netlink notifier to see when the socket closes.
6224 * If wdev != NULL, both the ifindex and identifier of the specified
6225 * wireless device are added to the event message before the vendor data
6228 * When done filling the skb, call cfg80211_vendor_event() with the
6229 * skb to send the event.
6231 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6233 static inline struct sk_buff
*
6234 cfg80211_vendor_event_alloc_ucast(struct wiphy
*wiphy
,
6235 struct wireless_dev
*wdev
,
6236 unsigned int portid
, int approxlen
,
6237 int event_idx
, gfp_t gfp
)
6239 return __cfg80211_alloc_event_skb(wiphy
, wdev
, NL80211_CMD_VENDOR
,
6240 NL80211_ATTR_VENDOR_DATA
,
6241 portid
, event_idx
, approxlen
, gfp
);
6245 * cfg80211_vendor_event - send the event
6246 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6247 * @gfp: allocation flags
6249 * This function sends the given @skb, which must have been allocated
6250 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6252 static inline void cfg80211_vendor_event(struct sk_buff
*skb
, gfp_t gfp
)
6254 __cfg80211_send_event_skb(skb
, gfp
);
6257 #ifdef CONFIG_NL80211_TESTMODE
6261 * Test mode is a set of utility functions to allow drivers to
6262 * interact with driver-specific tools to aid, for instance,
6263 * factory programming.
6265 * This chapter describes how drivers interact with it, for more
6266 * information see the nl80211 book's chapter on it.
6270 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6272 * @approxlen: an upper bound of the length of the data that will
6273 * be put into the skb
6275 * This function allocates and pre-fills an skb for a reply to
6276 * the testmode command. Since it is intended for a reply, calling
6277 * it outside of the @testmode_cmd operation is invalid.
6279 * The returned skb is pre-filled with the wiphy index and set up in
6280 * a way that any data that is put into the skb (with skb_put(),
6281 * nla_put() or similar) will end up being within the
6282 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6283 * with the skb is adding data for the corresponding userspace tool
6284 * which can then read that data out of the testdata attribute. You
6285 * must not modify the skb in any other way.
6287 * When done, call cfg80211_testmode_reply() with the skb and return
6288 * its error code as the result of the @testmode_cmd operation.
6290 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6292 static inline struct sk_buff
*
6293 cfg80211_testmode_alloc_reply_skb(struct wiphy
*wiphy
, int approxlen
)
6295 return __cfg80211_alloc_reply_skb(wiphy
, NL80211_CMD_TESTMODE
,
6296 NL80211_ATTR_TESTDATA
, approxlen
);
6300 * cfg80211_testmode_reply - send the reply skb
6301 * @skb: The skb, must have been allocated with
6302 * cfg80211_testmode_alloc_reply_skb()
6304 * Since calling this function will usually be the last thing
6305 * before returning from the @testmode_cmd you should return
6306 * the error code. Note that this function consumes the skb
6307 * regardless of the return value.
6309 * Return: An error code or 0 on success.
6311 static inline int cfg80211_testmode_reply(struct sk_buff
*skb
)
6313 return cfg80211_vendor_cmd_reply(skb
);
6317 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6319 * @approxlen: an upper bound of the length of the data that will
6320 * be put into the skb
6321 * @gfp: allocation flags
6323 * This function allocates and pre-fills an skb for an event on the
6324 * testmode multicast group.
6326 * The returned skb is set up in the same way as with
6327 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6328 * there, you should simply add data to it that will then end up in the
6329 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6332 * When done filling the skb, call cfg80211_testmode_event() with the
6333 * skb to send the event.
6335 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6337 static inline struct sk_buff
*
6338 cfg80211_testmode_alloc_event_skb(struct wiphy
*wiphy
, int approxlen
, gfp_t gfp
)
6340 return __cfg80211_alloc_event_skb(wiphy
, NULL
, NL80211_CMD_TESTMODE
,
6341 NL80211_ATTR_TESTDATA
, 0, -1,
6346 * cfg80211_testmode_event - send the event
6347 * @skb: The skb, must have been allocated with
6348 * cfg80211_testmode_alloc_event_skb()
6349 * @gfp: allocation flags
6351 * This function sends the given @skb, which must have been allocated
6352 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6355 static inline void cfg80211_testmode_event(struct sk_buff
*skb
, gfp_t gfp
)
6357 __cfg80211_send_event_skb(skb
, gfp
);
6360 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6361 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6363 #define CFG80211_TESTMODE_CMD(cmd)
6364 #define CFG80211_TESTMODE_DUMP(cmd)
6368 * struct cfg80211_fils_resp_params - FILS connection response params
6369 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6370 * @kek_len: Length of @fils_kek in octets
6371 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6372 * @erp_next_seq_num is valid.
6373 * @erp_next_seq_num: The next sequence number to use in ERP message in
6374 * FILS Authentication. This value should be specified irrespective of the
6375 * status for a FILS connection.
6376 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6377 * @pmk_len: Length of @pmk in octets
6378 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6379 * used for this FILS connection (may be %NULL).
6381 struct cfg80211_fils_resp_params
{
6384 bool update_erp_next_seq_num
;
6385 u16 erp_next_seq_num
;
6392 * struct cfg80211_connect_resp_params - Connection response params
6393 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6394 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6395 * the real status code for failures. If this call is used to report a
6396 * failure due to a timeout (e.g., not receiving an Authentication frame
6397 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6398 * indicate that this is a failure, but without a status code.
6399 * @timeout_reason is used to report the reason for the timeout in that
6401 * @bssid: The BSSID of the AP (may be %NULL)
6402 * @bss: Entry of bss to which STA got connected to, can be obtained through
6403 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6404 * bss from the connect_request and hold a reference to it and return
6405 * through this param to avoid a warning if the bss is expired during the
6406 * connection, esp. for those drivers implementing connect op.
6407 * Only one parameter among @bssid and @bss needs to be specified.
6408 * @req_ie: Association request IEs (may be %NULL)
6409 * @req_ie_len: Association request IEs length
6410 * @resp_ie: Association response IEs (may be %NULL)
6411 * @resp_ie_len: Association response IEs length
6412 * @fils: FILS connection response parameters.
6413 * @timeout_reason: Reason for connection timeout. This is used when the
6414 * connection fails due to a timeout instead of an explicit rejection from
6415 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6416 * not known. This value is used only if @status < 0 to indicate that the
6417 * failure is due to a timeout and not due to explicit rejection by the AP.
6418 * This value is ignored in other cases (@status >= 0).
6420 struct cfg80211_connect_resp_params
{
6423 struct cfg80211_bss
*bss
;
6428 struct cfg80211_fils_resp_params fils
;
6429 enum nl80211_timeout_reason timeout_reason
;
6433 * cfg80211_connect_done - notify cfg80211 of connection result
6435 * @dev: network device
6436 * @params: connection response parameters
6437 * @gfp: allocation flags
6439 * It should be called by the underlying driver once execution of the connection
6440 * request from connect() has been completed. This is similar to
6441 * cfg80211_connect_bss(), but takes a structure pointer for connection response
6442 * parameters. Only one of the functions among cfg80211_connect_bss(),
6443 * cfg80211_connect_result(), cfg80211_connect_timeout(),
6444 * and cfg80211_connect_done() should be called.
6446 void cfg80211_connect_done(struct net_device
*dev
,
6447 struct cfg80211_connect_resp_params
*params
,
6451 * cfg80211_connect_bss - notify cfg80211 of connection result
6453 * @dev: network device
6454 * @bssid: the BSSID of the AP
6455 * @bss: Entry of bss to which STA got connected to, can be obtained through
6456 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6457 * bss from the connect_request and hold a reference to it and return
6458 * through this param to avoid a warning if the bss is expired during the
6459 * connection, esp. for those drivers implementing connect op.
6460 * Only one parameter among @bssid and @bss needs to be specified.
6461 * @req_ie: association request IEs (maybe be %NULL)
6462 * @req_ie_len: association request IEs length
6463 * @resp_ie: association response IEs (may be %NULL)
6464 * @resp_ie_len: assoc response IEs length
6465 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6466 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6467 * the real status code for failures. If this call is used to report a
6468 * failure due to a timeout (e.g., not receiving an Authentication frame
6469 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6470 * indicate that this is a failure, but without a status code.
6471 * @timeout_reason is used to report the reason for the timeout in that
6473 * @gfp: allocation flags
6474 * @timeout_reason: reason for connection timeout. This is used when the
6475 * connection fails due to a timeout instead of an explicit rejection from
6476 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6477 * not known. This value is used only if @status < 0 to indicate that the
6478 * failure is due to a timeout and not due to explicit rejection by the AP.
6479 * This value is ignored in other cases (@status >= 0).
6481 * It should be called by the underlying driver once execution of the connection
6482 * request from connect() has been completed. This is similar to
6483 * cfg80211_connect_result(), but with the option of identifying the exact bss
6484 * entry for the connection. Only one of the functions among
6485 * cfg80211_connect_bss(), cfg80211_connect_result(),
6486 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6489 cfg80211_connect_bss(struct net_device
*dev
, const u8
*bssid
,
6490 struct cfg80211_bss
*bss
, const u8
*req_ie
,
6491 size_t req_ie_len
, const u8
*resp_ie
,
6492 size_t resp_ie_len
, int status
, gfp_t gfp
,
6493 enum nl80211_timeout_reason timeout_reason
)
6495 struct cfg80211_connect_resp_params params
;
6497 memset(¶ms
, 0, sizeof(params
));
6498 params
.status
= status
;
6499 params
.bssid
= bssid
;
6501 params
.req_ie
= req_ie
;
6502 params
.req_ie_len
= req_ie_len
;
6503 params
.resp_ie
= resp_ie
;
6504 params
.resp_ie_len
= resp_ie_len
;
6505 params
.timeout_reason
= timeout_reason
;
6507 cfg80211_connect_done(dev
, ¶ms
, gfp
);
6511 * cfg80211_connect_result - notify cfg80211 of connection result
6513 * @dev: network device
6514 * @bssid: the BSSID of the AP
6515 * @req_ie: association request IEs (maybe be %NULL)
6516 * @req_ie_len: association request IEs length
6517 * @resp_ie: association response IEs (may be %NULL)
6518 * @resp_ie_len: assoc response IEs length
6519 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6520 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6521 * the real status code for failures.
6522 * @gfp: allocation flags
6524 * It should be called by the underlying driver once execution of the connection
6525 * request from connect() has been completed. This is similar to
6526 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6527 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6528 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6531 cfg80211_connect_result(struct net_device
*dev
, const u8
*bssid
,
6532 const u8
*req_ie
, size_t req_ie_len
,
6533 const u8
*resp_ie
, size_t resp_ie_len
,
6534 u16 status
, gfp_t gfp
)
6536 cfg80211_connect_bss(dev
, bssid
, NULL
, req_ie
, req_ie_len
, resp_ie
,
6537 resp_ie_len
, status
, gfp
,
6538 NL80211_TIMEOUT_UNSPECIFIED
);
6542 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6544 * @dev: network device
6545 * @bssid: the BSSID of the AP
6546 * @req_ie: association request IEs (maybe be %NULL)
6547 * @req_ie_len: association request IEs length
6548 * @gfp: allocation flags
6549 * @timeout_reason: reason for connection timeout.
6551 * It should be called by the underlying driver whenever connect() has failed
6552 * in a sequence where no explicit authentication/association rejection was
6553 * received from the AP. This could happen, e.g., due to not being able to send
6554 * out the Authentication or Association Request frame or timing out while
6555 * waiting for the response. Only one of the functions among
6556 * cfg80211_connect_bss(), cfg80211_connect_result(),
6557 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6560 cfg80211_connect_timeout(struct net_device
*dev
, const u8
*bssid
,
6561 const u8
*req_ie
, size_t req_ie_len
, gfp_t gfp
,
6562 enum nl80211_timeout_reason timeout_reason
)
6564 cfg80211_connect_bss(dev
, bssid
, NULL
, req_ie
, req_ie_len
, NULL
, 0, -1,
6565 gfp
, timeout_reason
);
6569 * struct cfg80211_roam_info - driver initiated roaming information
6571 * @channel: the channel of the new AP
6572 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6573 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6574 * @req_ie: association request IEs (maybe be %NULL)
6575 * @req_ie_len: association request IEs length
6576 * @resp_ie: association response IEs (may be %NULL)
6577 * @resp_ie_len: assoc response IEs length
6578 * @fils: FILS related roaming information.
6580 struct cfg80211_roam_info
{
6581 struct ieee80211_channel
*channel
;
6582 struct cfg80211_bss
*bss
;
6588 struct cfg80211_fils_resp_params fils
;
6592 * cfg80211_roamed - notify cfg80211 of roaming
6594 * @dev: network device
6595 * @info: information about the new BSS. struct &cfg80211_roam_info.
6596 * @gfp: allocation flags
6598 * This function may be called with the driver passing either the BSSID of the
6599 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6600 * It should be called by the underlying driver whenever it roamed from one AP
6601 * to another while connected. Drivers which have roaming implemented in
6602 * firmware should pass the bss entry to avoid a race in bss entry timeout where
6603 * the bss entry of the new AP is seen in the driver, but gets timed out by the
6604 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6605 * rdev->event_work. In case of any failures, the reference is released
6606 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6607 * released while disconnecting from the current bss.
6609 void cfg80211_roamed(struct net_device
*dev
, struct cfg80211_roam_info
*info
,
6613 * cfg80211_port_authorized - notify cfg80211 of successful security association
6615 * @dev: network device
6616 * @bssid: the BSSID of the AP
6617 * @gfp: allocation flags
6619 * This function should be called by a driver that supports 4 way handshake
6620 * offload after a security association was successfully established (i.e.,
6621 * the 4 way handshake was completed successfully). The call to this function
6622 * should be preceded with a call to cfg80211_connect_result(),
6623 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6624 * indicate the 802.11 association.
6626 void cfg80211_port_authorized(struct net_device
*dev
, const u8
*bssid
,
6630 * cfg80211_disconnected - notify cfg80211 that connection was dropped
6632 * @dev: network device
6633 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6634 * @ie_len: length of IEs
6635 * @reason: reason code for the disconnection, set it to 0 if unknown
6636 * @locally_generated: disconnection was requested locally
6637 * @gfp: allocation flags
6639 * After it calls this function, the driver should enter an idle state
6640 * and not try to connect to any AP any more.
6642 void cfg80211_disconnected(struct net_device
*dev
, u16 reason
,
6643 const u8
*ie
, size_t ie_len
,
6644 bool locally_generated
, gfp_t gfp
);
6647 * cfg80211_ready_on_channel - notification of remain_on_channel start
6648 * @wdev: wireless device
6649 * @cookie: the request cookie
6650 * @chan: The current channel (from remain_on_channel request)
6651 * @duration: Duration in milliseconds that the driver intents to remain on the
6653 * @gfp: allocation flags
6655 void cfg80211_ready_on_channel(struct wireless_dev
*wdev
, u64 cookie
,
6656 struct ieee80211_channel
*chan
,
6657 unsigned int duration
, gfp_t gfp
);
6660 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6661 * @wdev: wireless device
6662 * @cookie: the request cookie
6663 * @chan: The current channel (from remain_on_channel request)
6664 * @gfp: allocation flags
6666 void cfg80211_remain_on_channel_expired(struct wireless_dev
*wdev
, u64 cookie
,
6667 struct ieee80211_channel
*chan
,
6671 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
6672 * @wdev: wireless device
6673 * @cookie: the requested cookie
6674 * @chan: The current channel (from tx_mgmt request)
6675 * @gfp: allocation flags
6677 void cfg80211_tx_mgmt_expired(struct wireless_dev
*wdev
, u64 cookie
,
6678 struct ieee80211_channel
*chan
, gfp_t gfp
);
6681 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6683 * @sinfo: the station information
6684 * @gfp: allocation flags
6686 int cfg80211_sinfo_alloc_tid_stats(struct station_info
*sinfo
, gfp_t gfp
);
6689 * cfg80211_sinfo_release_content - release contents of station info
6690 * @sinfo: the station information
6692 * Releases any potentially allocated sub-information of the station
6693 * information, but not the struct itself (since it's typically on
6696 static inline void cfg80211_sinfo_release_content(struct station_info
*sinfo
)
6698 kfree(sinfo
->pertid
);
6702 * cfg80211_new_sta - notify userspace about station
6705 * @mac_addr: the station's address
6706 * @sinfo: the station information
6707 * @gfp: allocation flags
6709 void cfg80211_new_sta(struct net_device
*dev
, const u8
*mac_addr
,
6710 struct station_info
*sinfo
, gfp_t gfp
);
6713 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6715 * @mac_addr: the station's address
6716 * @sinfo: the station information/statistics
6717 * @gfp: allocation flags
6719 void cfg80211_del_sta_sinfo(struct net_device
*dev
, const u8
*mac_addr
,
6720 struct station_info
*sinfo
, gfp_t gfp
);
6723 * cfg80211_del_sta - notify userspace about deletion of a station
6726 * @mac_addr: the station's address
6727 * @gfp: allocation flags
6729 static inline void cfg80211_del_sta(struct net_device
*dev
,
6730 const u8
*mac_addr
, gfp_t gfp
)
6732 cfg80211_del_sta_sinfo(dev
, mac_addr
, NULL
, gfp
);
6736 * cfg80211_conn_failed - connection request failed notification
6739 * @mac_addr: the station's address
6740 * @reason: the reason for connection failure
6741 * @gfp: allocation flags
6743 * Whenever a station tries to connect to an AP and if the station
6744 * could not connect to the AP as the AP has rejected the connection
6745 * for some reasons, this function is called.
6747 * The reason for connection failure can be any of the value from
6748 * nl80211_connect_failed_reason enum
6750 void cfg80211_conn_failed(struct net_device
*dev
, const u8
*mac_addr
,
6751 enum nl80211_connect_failed_reason reason
,
6755 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
6756 * @wdev: wireless device receiving the frame
6757 * @freq: Frequency on which the frame was received in MHz
6758 * @sig_dbm: signal strength in dBm, or 0 if unknown
6759 * @buf: Management frame (header + body)
6760 * @len: length of the frame data
6761 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
6763 * This function is called whenever an Action frame is received for a station
6764 * mode interface, but is not processed in kernel.
6766 * Return: %true if a user space application has registered for this frame.
6767 * For action frames, that makes it responsible for rejecting unrecognized
6768 * action frames; %false otherwise, in which case for action frames the
6769 * driver is responsible for rejecting the frame.
6771 bool cfg80211_rx_mgmt(struct wireless_dev
*wdev
, int freq
, int sig_dbm
,
6772 const u8
*buf
, size_t len
, u32 flags
);
6775 * cfg80211_mgmt_tx_status - notification of TX status for management frame
6776 * @wdev: wireless device receiving the frame
6777 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
6778 * @buf: Management frame (header + body)
6779 * @len: length of the frame data
6780 * @ack: Whether frame was acknowledged
6781 * @gfp: context flags
6783 * This function is called whenever a management frame was requested to be
6784 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
6785 * transmission attempt.
6787 void cfg80211_mgmt_tx_status(struct wireless_dev
*wdev
, u64 cookie
,
6788 const u8
*buf
, size_t len
, bool ack
, gfp_t gfp
);
6792 * cfg80211_rx_control_port - notification about a received control port frame
6793 * @dev: The device the frame matched to
6794 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
6795 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
6796 * This function does not take ownership of the skb, so the caller is
6797 * responsible for any cleanup. The caller must also ensure that
6798 * skb->protocol is set appropriately.
6799 * @unencrypted: Whether the frame was received unencrypted
6801 * This function is used to inform userspace about a received control port
6802 * frame. It should only be used if userspace indicated it wants to receive
6803 * control port frames over nl80211.
6805 * The frame is the data portion of the 802.3 or 802.11 data frame with all
6806 * network layer headers removed (e.g. the raw EAPoL frame).
6808 * Return: %true if the frame was passed to userspace
6810 bool cfg80211_rx_control_port(struct net_device
*dev
,
6811 struct sk_buff
*skb
, bool unencrypted
);
6814 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
6815 * @dev: network device
6816 * @rssi_event: the triggered RSSI event
6817 * @rssi_level: new RSSI level value or 0 if not available
6818 * @gfp: context flags
6820 * This function is called when a configured connection quality monitoring
6821 * rssi threshold reached event occurs.
6823 void cfg80211_cqm_rssi_notify(struct net_device
*dev
,
6824 enum nl80211_cqm_rssi_threshold_event rssi_event
,
6825 s32 rssi_level
, gfp_t gfp
);
6828 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
6829 * @dev: network device
6830 * @peer: peer's MAC address
6831 * @num_packets: how many packets were lost -- should be a fixed threshold
6832 * but probably no less than maybe 50, or maybe a throughput dependent
6833 * threshold (to account for temporary interference)
6834 * @gfp: context flags
6836 void cfg80211_cqm_pktloss_notify(struct net_device
*dev
,
6837 const u8
*peer
, u32 num_packets
, gfp_t gfp
);
6840 * cfg80211_cqm_txe_notify - TX error rate event
6841 * @dev: network device
6842 * @peer: peer's MAC address
6843 * @num_packets: how many packets were lost
6844 * @rate: % of packets which failed transmission
6845 * @intvl: interval (in s) over which the TX failure threshold was breached.
6846 * @gfp: context flags
6848 * Notify userspace when configured % TX failures over number of packets in a
6849 * given interval is exceeded.
6851 void cfg80211_cqm_txe_notify(struct net_device
*dev
, const u8
*peer
,
6852 u32 num_packets
, u32 rate
, u32 intvl
, gfp_t gfp
);
6855 * cfg80211_cqm_beacon_loss_notify - beacon loss event
6856 * @dev: network device
6857 * @gfp: context flags
6859 * Notify userspace about beacon loss from the connected AP.
6861 void cfg80211_cqm_beacon_loss_notify(struct net_device
*dev
, gfp_t gfp
);
6864 * cfg80211_radar_event - radar detection event
6866 * @chandef: chandef for the current channel
6867 * @gfp: context flags
6869 * This function is called when a radar is detected on the current chanenl.
6871 void cfg80211_radar_event(struct wiphy
*wiphy
,
6872 struct cfg80211_chan_def
*chandef
, gfp_t gfp
);
6875 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6876 * @dev: network device
6877 * @mac: MAC address of a station which opmode got modified
6878 * @sta_opmode: station's current opmode value
6879 * @gfp: context flags
6881 * Driver should call this function when station's opmode modified via action
6884 void cfg80211_sta_opmode_change_notify(struct net_device
*dev
, const u8
*mac
,
6885 struct sta_opmode_info
*sta_opmode
,
6889 * cfg80211_cac_event - Channel availability check (CAC) event
6890 * @netdev: network device
6891 * @chandef: chandef for the current channel
6892 * @event: type of event
6893 * @gfp: context flags
6895 * This function is called when a Channel availability check (CAC) is finished
6896 * or aborted. This must be called to notify the completion of a CAC process,
6897 * also by full-MAC drivers.
6899 void cfg80211_cac_event(struct net_device
*netdev
,
6900 const struct cfg80211_chan_def
*chandef
,
6901 enum nl80211_radar_event event
, gfp_t gfp
);
6905 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6906 * @dev: network device
6907 * @bssid: BSSID of AP (to avoid races)
6908 * @replay_ctr: new replay counter
6909 * @gfp: allocation flags
6911 void cfg80211_gtk_rekey_notify(struct net_device
*dev
, const u8
*bssid
,
6912 const u8
*replay_ctr
, gfp_t gfp
);
6915 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
6916 * @dev: network device
6917 * @index: candidate index (the smaller the index, the higher the priority)
6918 * @bssid: BSSID of AP
6919 * @preauth: Whether AP advertises support for RSN pre-authentication
6920 * @gfp: allocation flags
6922 void cfg80211_pmksa_candidate_notify(struct net_device
*dev
, int index
,
6923 const u8
*bssid
, bool preauth
, gfp_t gfp
);
6926 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
6927 * @dev: The device the frame matched to
6928 * @addr: the transmitter address
6929 * @gfp: context flags
6931 * This function is used in AP mode (only!) to inform userspace that
6932 * a spurious class 3 frame was received, to be able to deauth the
6934 * Return: %true if the frame was passed to userspace (or this failed
6935 * for a reason other than not having a subscription.)
6937 bool cfg80211_rx_spurious_frame(struct net_device
*dev
,
6938 const u8
*addr
, gfp_t gfp
);
6941 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
6942 * @dev: The device the frame matched to
6943 * @addr: the transmitter address
6944 * @gfp: context flags
6946 * This function is used in AP mode (only!) to inform userspace that
6947 * an associated station sent a 4addr frame but that wasn't expected.
6948 * It is allowed and desirable to send this event only once for each
6949 * station to avoid event flooding.
6950 * Return: %true if the frame was passed to userspace (or this failed
6951 * for a reason other than not having a subscription.)
6953 bool cfg80211_rx_unexpected_4addr_frame(struct net_device
*dev
,
6954 const u8
*addr
, gfp_t gfp
);
6957 * cfg80211_probe_status - notify userspace about probe status
6958 * @dev: the device the probe was sent on
6959 * @addr: the address of the peer
6960 * @cookie: the cookie filled in @probe_client previously
6961 * @acked: indicates whether probe was acked or not
6962 * @ack_signal: signal strength (in dBm) of the ACK frame.
6963 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6964 * @gfp: allocation flags
6966 void cfg80211_probe_status(struct net_device
*dev
, const u8
*addr
,
6967 u64 cookie
, bool acked
, s32 ack_signal
,
6968 bool is_valid_ack_signal
, gfp_t gfp
);
6971 * cfg80211_report_obss_beacon - report beacon from other APs
6972 * @wiphy: The wiphy that received the beacon
6974 * @len: length of the frame
6975 * @freq: frequency the frame was received on
6976 * @sig_dbm: signal strength in dBm, or 0 if unknown
6978 * Use this function to report to userspace when a beacon was
6979 * received. It is not useful to call this when there is no
6980 * netdev that is in AP/GO mode.
6982 void cfg80211_report_obss_beacon(struct wiphy
*wiphy
,
6983 const u8
*frame
, size_t len
,
6984 int freq
, int sig_dbm
);
6987 * cfg80211_reg_can_beacon - check if beaconing is allowed
6989 * @chandef: the channel definition
6990 * @iftype: interface type
6992 * Return: %true if there is no secondary channel or the secondary channel(s)
6993 * can be used for beaconing (i.e. is not a radar channel etc.)
6995 bool cfg80211_reg_can_beacon(struct wiphy
*wiphy
,
6996 struct cfg80211_chan_def
*chandef
,
6997 enum nl80211_iftype iftype
);
7000 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7002 * @chandef: the channel definition
7003 * @iftype: interface type
7005 * Return: %true if there is no secondary channel or the secondary channel(s)
7006 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7007 * also checks if IR-relaxation conditions apply, to allow beaconing under
7008 * more permissive conditions.
7010 * Requires the RTNL to be held.
7012 bool cfg80211_reg_can_beacon_relax(struct wiphy
*wiphy
,
7013 struct cfg80211_chan_def
*chandef
,
7014 enum nl80211_iftype iftype
);
7017 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7018 * @dev: the device which switched channels
7019 * @chandef: the new channel definition
7021 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7024 void cfg80211_ch_switch_notify(struct net_device
*dev
,
7025 struct cfg80211_chan_def
*chandef
);
7028 * cfg80211_ch_switch_started_notify - notify channel switch start
7029 * @dev: the device on which the channel switch started
7030 * @chandef: the future channel definition
7031 * @count: the number of TBTTs until the channel switch happens
7033 * Inform the userspace about the channel switch that has just
7034 * started, so that it can take appropriate actions (eg. starting
7035 * channel switch on other vifs), if necessary.
7037 void cfg80211_ch_switch_started_notify(struct net_device
*dev
,
7038 struct cfg80211_chan_def
*chandef
,
7042 * ieee80211_operating_class_to_band - convert operating class to band
7044 * @operating_class: the operating class to convert
7045 * @band: band pointer to fill
7047 * Returns %true if the conversion was successful, %false otherwise.
7049 bool ieee80211_operating_class_to_band(u8 operating_class
,
7050 enum nl80211_band
*band
);
7053 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7055 * @chandef: the chandef to convert
7056 * @op_class: a pointer to the resulting operating class
7058 * Returns %true if the conversion was successful, %false otherwise.
7060 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def
*chandef
,
7064 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7065 * @dev: the device on which the operation is requested
7066 * @peer: the MAC address of the peer device
7067 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7068 * NL80211_TDLS_TEARDOWN)
7069 * @reason_code: the reason code for teardown request
7070 * @gfp: allocation flags
7072 * This function is used to request userspace to perform TDLS operation that
7073 * requires knowledge of keys, i.e., link setup or teardown when the AP
7074 * connection uses encryption. This is optional mechanism for the driver to use
7075 * if it can automatically determine when a TDLS link could be useful (e.g.,
7076 * based on traffic and signal strength for a peer).
7078 void cfg80211_tdls_oper_request(struct net_device
*dev
, const u8
*peer
,
7079 enum nl80211_tdls_operation oper
,
7080 u16 reason_code
, gfp_t gfp
);
7083 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7084 * @rate: given rate_info to calculate bitrate from
7086 * return 0 if MCS index >= 32
7088 u32
cfg80211_calculate_bitrate(struct rate_info
*rate
);
7091 * cfg80211_unregister_wdev - remove the given wdev
7092 * @wdev: struct wireless_dev to remove
7094 * Call this function only for wdevs that have no netdev assigned,
7095 * e.g. P2P Devices. It removes the device from the list so that
7096 * it can no longer be used. It is necessary to call this function
7097 * even when cfg80211 requests the removal of the interface by
7098 * calling the del_virtual_intf() callback. The function must also
7099 * be called when the driver wishes to unregister the wdev, e.g.
7100 * when the device is unbound from the driver.
7102 * Requires the RTNL to be held.
7104 void cfg80211_unregister_wdev(struct wireless_dev
*wdev
);
7107 * struct cfg80211_ft_event - FT Information Elements
7109 * @ies_len: length of the FT IE in bytes
7110 * @target_ap: target AP's MAC address
7112 * @ric_ies_len: length of the RIC IE in bytes
7114 struct cfg80211_ft_event_params
{
7117 const u8
*target_ap
;
7123 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7124 * @netdev: network device
7125 * @ft_event: IE information
7127 void cfg80211_ft_event(struct net_device
*netdev
,
7128 struct cfg80211_ft_event_params
*ft_event
);
7131 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7132 * @ies: the input IE buffer
7133 * @len: the input length
7134 * @attr: the attribute ID to find
7135 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7136 * if the function is only called to get the needed buffer size
7137 * @bufsize: size of the output buffer
7139 * The function finds a given P2P attribute in the (vendor) IEs and
7140 * copies its contents to the given buffer.
7142 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7143 * malformed or the attribute can't be found (respectively), or the
7144 * length of the found attribute (which can be zero).
7146 int cfg80211_get_p2p_attr(const u8
*ies
, unsigned int len
,
7147 enum ieee80211_p2p_attr_id attr
,
7148 u8
*buf
, unsigned int bufsize
);
7151 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7152 * @ies: the IE buffer
7153 * @ielen: the length of the IE buffer
7154 * @ids: an array with element IDs that are allowed before
7155 * the split. A WLAN_EID_EXTENSION value means that the next
7156 * EID in the list is a sub-element of the EXTENSION IE.
7157 * @n_ids: the size of the element ID array
7158 * @after_ric: array IE types that come after the RIC element
7159 * @n_after_ric: size of the @after_ric array
7160 * @offset: offset where to start splitting in the buffer
7162 * This function splits an IE buffer by updating the @offset
7163 * variable to point to the location where the buffer should be
7166 * It assumes that the given IE buffer is well-formed, this
7167 * has to be guaranteed by the caller!
7169 * It also assumes that the IEs in the buffer are ordered
7170 * correctly, if not the result of using this function will not
7171 * be ordered correctly either, i.e. it does no reordering.
7173 * The function returns the offset where the next part of the
7174 * buffer starts, which may be @ielen if the entire (remainder)
7175 * of the buffer should be used.
7177 size_t ieee80211_ie_split_ric(const u8
*ies
, size_t ielen
,
7178 const u8
*ids
, int n_ids
,
7179 const u8
*after_ric
, int n_after_ric
,
7183 * ieee80211_ie_split - split an IE buffer according to ordering
7184 * @ies: the IE buffer
7185 * @ielen: the length of the IE buffer
7186 * @ids: an array with element IDs that are allowed before
7187 * the split. A WLAN_EID_EXTENSION value means that the next
7188 * EID in the list is a sub-element of the EXTENSION IE.
7189 * @n_ids: the size of the element ID array
7190 * @offset: offset where to start splitting in the buffer
7192 * This function splits an IE buffer by updating the @offset
7193 * variable to point to the location where the buffer should be
7196 * It assumes that the given IE buffer is well-formed, this
7197 * has to be guaranteed by the caller!
7199 * It also assumes that the IEs in the buffer are ordered
7200 * correctly, if not the result of using this function will not
7201 * be ordered correctly either, i.e. it does no reordering.
7203 * The function returns the offset where the next part of the
7204 * buffer starts, which may be @ielen if the entire (remainder)
7205 * of the buffer should be used.
7207 static inline size_t ieee80211_ie_split(const u8
*ies
, size_t ielen
,
7208 const u8
*ids
, int n_ids
, size_t offset
)
7210 return ieee80211_ie_split_ric(ies
, ielen
, ids
, n_ids
, NULL
, 0, offset
);
7214 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7215 * @wdev: the wireless device reporting the wakeup
7216 * @wakeup: the wakeup report
7217 * @gfp: allocation flags
7219 * This function reports that the given device woke up. If it
7220 * caused the wakeup, report the reason(s), otherwise you may
7221 * pass %NULL as the @wakeup parameter to advertise that something
7222 * else caused the wakeup.
7224 void cfg80211_report_wowlan_wakeup(struct wireless_dev
*wdev
,
7225 struct cfg80211_wowlan_wakeup
*wakeup
,
7229 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7231 * @wdev: the wireless device for which critical protocol is stopped.
7232 * @gfp: allocation flags
7234 * This function can be called by the driver to indicate it has reverted
7235 * operation back to normal. One reason could be that the duration given
7236 * by .crit_proto_start() has expired.
7238 void cfg80211_crit_proto_stopped(struct wireless_dev
*wdev
, gfp_t gfp
);
7241 * ieee80211_get_num_supported_channels - get number of channels device has
7244 * Return: the number of channels supported by the device.
7246 unsigned int ieee80211_get_num_supported_channels(struct wiphy
*wiphy
);
7249 * cfg80211_check_combinations - check interface combinations
7252 * @params: the interface combinations parameter
7254 * This function can be called by the driver to check whether a
7255 * combination of interfaces and their types are allowed according to
7256 * the interface combinations.
7258 int cfg80211_check_combinations(struct wiphy
*wiphy
,
7259 struct iface_combination_params
*params
);
7262 * cfg80211_iter_combinations - iterate over matching combinations
7265 * @params: the interface combinations parameter
7266 * @iter: function to call for each matching combination
7267 * @data: pointer to pass to iter function
7269 * This function can be called by the driver to check what possible
7270 * combinations it fits in at a given moment, e.g. for channel switching
7273 int cfg80211_iter_combinations(struct wiphy
*wiphy
,
7274 struct iface_combination_params
*params
,
7275 void (*iter
)(const struct ieee80211_iface_combination
*c
,
7280 * cfg80211_stop_iface - trigger interface disconnection
7283 * @wdev: wireless device
7284 * @gfp: context flags
7286 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7289 * Note: This doesn't need any locks and is asynchronous.
7291 void cfg80211_stop_iface(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
7295 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7296 * @wiphy: the wiphy to shut down
7298 * This function shuts down all interfaces belonging to this wiphy by
7299 * calling dev_close() (and treating non-netdev interfaces as needed).
7300 * It shouldn't really be used unless there are some fatal device errors
7301 * that really can't be recovered in any other way.
7303 * Callers must hold the RTNL and be able to deal with callbacks into
7304 * the driver while the function is running.
7306 void cfg80211_shutdown_all_interfaces(struct wiphy
*wiphy
);
7309 * wiphy_ext_feature_set - set the extended feature flag
7311 * @wiphy: the wiphy to modify.
7312 * @ftidx: extended feature bit index.
7314 * The extended features are flagged in multiple bytes (see
7315 * &struct wiphy.@ext_features)
7317 static inline void wiphy_ext_feature_set(struct wiphy
*wiphy
,
7318 enum nl80211_ext_feature_index ftidx
)
7322 ft_byte
= &wiphy
->ext_features
[ftidx
/ 8];
7323 *ft_byte
|= BIT(ftidx
% 8);
7327 * wiphy_ext_feature_isset - check the extended feature flag
7329 * @wiphy: the wiphy to modify.
7330 * @ftidx: extended feature bit index.
7332 * The extended features are flagged in multiple bytes (see
7333 * &struct wiphy.@ext_features)
7336 wiphy_ext_feature_isset(struct wiphy
*wiphy
,
7337 enum nl80211_ext_feature_index ftidx
)
7341 ft_byte
= wiphy
->ext_features
[ftidx
/ 8];
7342 return (ft_byte
& BIT(ftidx
% 8)) != 0;
7346 * cfg80211_free_nan_func - free NAN function
7347 * @f: NAN function that should be freed
7349 * Frees all the NAN function and all it's allocated members.
7351 void cfg80211_free_nan_func(struct cfg80211_nan_func
*f
);
7354 * struct cfg80211_nan_match_params - NAN match parameters
7355 * @type: the type of the function that triggered a match. If it is
7356 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7357 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7359 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7360 * @inst_id: the local instance id
7361 * @peer_inst_id: the instance id of the peer's function
7362 * @addr: the MAC address of the peer
7363 * @info_len: the length of the &info
7364 * @info: the Service Specific Info from the peer (if any)
7365 * @cookie: unique identifier of the corresponding function
7367 struct cfg80211_nan_match_params
{
7368 enum nl80211_nan_function_type type
;
7378 * cfg80211_nan_match - report a match for a NAN function.
7379 * @wdev: the wireless device reporting the match
7380 * @match: match notification parameters
7381 * @gfp: allocation flags
7383 * This function reports that the a NAN function had a match. This
7384 * can be a subscribe that had a match or a solicited publish that
7385 * was sent. It can also be a follow up that was received.
7387 void cfg80211_nan_match(struct wireless_dev
*wdev
,
7388 struct cfg80211_nan_match_params
*match
, gfp_t gfp
);
7391 * cfg80211_nan_func_terminated - notify about NAN function termination.
7393 * @wdev: the wireless device reporting the match
7394 * @inst_id: the local instance id
7395 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7396 * @cookie: unique NAN function identifier
7397 * @gfp: allocation flags
7399 * This function reports that the a NAN function is terminated.
7401 void cfg80211_nan_func_terminated(struct wireless_dev
*wdev
,
7403 enum nl80211_nan_func_term_reason reason
,
7404 u64 cookie
, gfp_t gfp
);
7406 /* ethtool helper */
7407 void cfg80211_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
);
7410 * cfg80211_external_auth_request - userspace request for authentication
7411 * @netdev: network device
7412 * @params: External authentication parameters
7413 * @gfp: allocation flags
7414 * Returns: 0 on success, < 0 on error
7416 int cfg80211_external_auth_request(struct net_device
*netdev
,
7417 struct cfg80211_external_auth_params
*params
,
7421 * cfg80211_pmsr_report - report peer measurement result data
7422 * @wdev: the wireless device reporting the measurement
7423 * @req: the original measurement request
7424 * @result: the result data
7425 * @gfp: allocation flags
7427 void cfg80211_pmsr_report(struct wireless_dev
*wdev
,
7428 struct cfg80211_pmsr_request
*req
,
7429 struct cfg80211_pmsr_result
*result
,
7433 * cfg80211_pmsr_complete - report peer measurement completed
7434 * @wdev: the wireless device reporting the measurement
7435 * @req: the original measurement request
7436 * @gfp: allocation flags
7438 * Report that the entire measurement completed, after this
7439 * the request pointer will no longer be valid.
7441 void cfg80211_pmsr_complete(struct wireless_dev
*wdev
,
7442 struct cfg80211_pmsr_request
*req
,
7446 * cfg80211_iftype_allowed - check whether the interface can be allowed
7448 * @iftype: interface type
7449 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7450 * @check_swif: check iftype against software interfaces
7452 * Check whether the interface is allowed to operate; additionally, this API
7453 * can be used to check iftype against the software interfaces when
7454 * check_swif is '1'.
7456 bool cfg80211_iftype_allowed(struct wiphy
*wiphy
, enum nl80211_iftype iftype
,
7457 bool is_4addr
, u8 check_swif
);
7460 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7462 /* wiphy_printk helpers, similar to dev_printk */
7464 #define wiphy_printk(level, wiphy, format, args...) \
7465 dev_printk(level, &(wiphy)->dev, format, ##args)
7466 #define wiphy_emerg(wiphy, format, args...) \
7467 dev_emerg(&(wiphy)->dev, format, ##args)
7468 #define wiphy_alert(wiphy, format, args...) \
7469 dev_alert(&(wiphy)->dev, format, ##args)
7470 #define wiphy_crit(wiphy, format, args...) \
7471 dev_crit(&(wiphy)->dev, format, ##args)
7472 #define wiphy_err(wiphy, format, args...) \
7473 dev_err(&(wiphy)->dev, format, ##args)
7474 #define wiphy_warn(wiphy, format, args...) \
7475 dev_warn(&(wiphy)->dev, format, ##args)
7476 #define wiphy_notice(wiphy, format, args...) \
7477 dev_notice(&(wiphy)->dev, format, ##args)
7478 #define wiphy_info(wiphy, format, args...) \
7479 dev_info(&(wiphy)->dev, format, ##args)
7481 #define wiphy_err_ratelimited(wiphy, format, args...) \
7482 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7483 #define wiphy_warn_ratelimited(wiphy, format, args...) \
7484 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7486 #define wiphy_debug(wiphy, format, args...) \
7487 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7489 #define wiphy_dbg(wiphy, format, args...) \
7490 dev_dbg(&(wiphy)->dev, format, ##args)
7492 #if defined(VERBOSE_DEBUG)
7493 #define wiphy_vdbg wiphy_dbg
7495 #define wiphy_vdbg(wiphy, format, args...) \
7498 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
7504 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7505 * of using a WARN/WARN_ON to get the message out, including the
7506 * file/line information and a backtrace.
7508 #define wiphy_WARN(wiphy, format, args...) \
7509 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7512 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
7513 * @netdev: network device
7514 * @owe_info: peer's owe info
7515 * @gfp: allocation flags
7517 void cfg80211_update_owe_info_event(struct net_device
*netdev
,
7518 struct cfg80211_update_owe_info
*owe_info
,
7521 #endif /* __NET_CFG80211_H */