1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright 2015-2017 Intel Deutschland GmbH
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/netdevice.h>
16 #include <linux/debugfs.h>
17 #include <linux/list.h>
18 #include <linux/bug.h>
19 #include <linux/netlink.h>
20 #include <linux/skbuff.h>
21 #include <linux/nl80211.h>
22 #include <linux/if_ether.h>
23 #include <linux/ieee80211.h>
24 #include <linux/net.h>
25 #include <net/regulatory.h>
30 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
31 * userspace and drivers, and offers some utility functionality associated
32 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
33 * by all modern wireless drivers in Linux, so that they offer a consistent
34 * API through nl80211. For backward compatibility, cfg80211 also offers
35 * wireless extensions to userspace, but hides them from drivers completely.
37 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
43 * DOC: Device registration
45 * In order for a driver to use cfg80211, it must register the hardware device
46 * with cfg80211. This happens through a number of hardware capability structs
49 * The fundamental structure for each device is the 'wiphy', of which each
50 * instance describes a physical wireless device connected to the system. Each
51 * such wiphy can have zero, one, or many virtual interfaces associated with
52 * it, which need to be identified as such by pointing the network interface's
53 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
54 * the wireless part of the interface, normally this struct is embedded in the
55 * network interface's private data area. Drivers can optionally allow creating
56 * or destroying virtual interfaces on the fly, but without at least one or the
57 * ability to create some the wireless device isn't useful.
59 * Each wiphy structure contains device capability information, and also has
60 * a pointer to the various operations the driver offers. The definitions and
61 * structures here describe these capabilities in detail.
67 * wireless hardware capability structures
71 * enum ieee80211_channel_flags - channel flags
73 * Channel flags set by the regulatory control code.
75 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
76 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
77 * sending probe requests or beaconing.
78 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
79 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
81 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
83 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
84 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
85 * this flag indicates that an 80 MHz channel cannot use this
86 * channel as the control or any of the secondary channels.
87 * This may be due to the driver or due to regulatory bandwidth
89 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
90 * this flag indicates that an 160 MHz channel cannot use this
91 * channel as the control or any of the secondary channels.
92 * This may be due to the driver or due to regulatory bandwidth
94 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
95 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
96 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
98 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
102 enum ieee80211_channel_flags
{
103 IEEE80211_CHAN_DISABLED
= 1<<0,
104 IEEE80211_CHAN_NO_IR
= 1<<1,
106 IEEE80211_CHAN_RADAR
= 1<<3,
107 IEEE80211_CHAN_NO_HT40PLUS
= 1<<4,
108 IEEE80211_CHAN_NO_HT40MINUS
= 1<<5,
109 IEEE80211_CHAN_NO_OFDM
= 1<<6,
110 IEEE80211_CHAN_NO_80MHZ
= 1<<7,
111 IEEE80211_CHAN_NO_160MHZ
= 1<<8,
112 IEEE80211_CHAN_INDOOR_ONLY
= 1<<9,
113 IEEE80211_CHAN_IR_CONCURRENT
= 1<<10,
114 IEEE80211_CHAN_NO_20MHZ
= 1<<11,
115 IEEE80211_CHAN_NO_10MHZ
= 1<<12,
118 #define IEEE80211_CHAN_NO_HT40 \
119 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
121 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
122 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
125 * struct ieee80211_channel - channel definition
127 * This structure describes a single channel for use
130 * @center_freq: center frequency in MHz
131 * @hw_value: hardware-specific value for the channel
132 * @flags: channel flags from &enum ieee80211_channel_flags.
133 * @orig_flags: channel flags at registration time, used by regulatory
134 * code to support devices with additional restrictions
135 * @band: band this channel belongs to.
136 * @max_antenna_gain: maximum antenna gain in dBi
137 * @max_power: maximum transmission power (in dBm)
138 * @max_reg_power: maximum regulatory transmission power (in dBm)
139 * @beacon_found: helper to regulatory code to indicate when a beacon
140 * has been found on this channel. Use regulatory_hint_found_beacon()
141 * to enable this, this is useful only on 5 GHz band.
142 * @orig_mag: internal use
143 * @orig_mpwr: internal use
144 * @dfs_state: current state of this channel. Only relevant if radar is required
146 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
147 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
149 struct ieee80211_channel
{
150 enum nl80211_band band
;
154 int max_antenna_gain
;
159 int orig_mag
, orig_mpwr
;
160 enum nl80211_dfs_state dfs_state
;
161 unsigned long dfs_state_entered
;
162 unsigned int dfs_cac_ms
;
166 * enum ieee80211_rate_flags - rate flags
168 * Hardware/specification flags for rates. These are structured
169 * in a way that allows using the same bitrate structure for
170 * different bands/PHY modes.
172 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
173 * preamble on this bitrate; only relevant in 2.4GHz band and
175 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
176 * when used with 802.11a (on the 5 GHz band); filled by the
177 * core code when registering the wiphy.
178 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
179 * when used with 802.11b (on the 2.4 GHz band); filled by the
180 * core code when registering the wiphy.
181 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
182 * when used with 802.11g (on the 2.4 GHz band); filled by the
183 * core code when registering the wiphy.
184 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
185 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
186 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
188 enum ieee80211_rate_flags
{
189 IEEE80211_RATE_SHORT_PREAMBLE
= 1<<0,
190 IEEE80211_RATE_MANDATORY_A
= 1<<1,
191 IEEE80211_RATE_MANDATORY_B
= 1<<2,
192 IEEE80211_RATE_MANDATORY_G
= 1<<3,
193 IEEE80211_RATE_ERP_G
= 1<<4,
194 IEEE80211_RATE_SUPPORTS_5MHZ
= 1<<5,
195 IEEE80211_RATE_SUPPORTS_10MHZ
= 1<<6,
199 * enum ieee80211_bss_type - BSS type filter
201 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
202 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
203 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
204 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
205 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
207 enum ieee80211_bss_type
{
208 IEEE80211_BSS_TYPE_ESS
,
209 IEEE80211_BSS_TYPE_PBSS
,
210 IEEE80211_BSS_TYPE_IBSS
,
211 IEEE80211_BSS_TYPE_MBSS
,
212 IEEE80211_BSS_TYPE_ANY
216 * enum ieee80211_privacy - BSS privacy filter
218 * @IEEE80211_PRIVACY_ON: privacy bit set
219 * @IEEE80211_PRIVACY_OFF: privacy bit clear
220 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
222 enum ieee80211_privacy
{
223 IEEE80211_PRIVACY_ON
,
224 IEEE80211_PRIVACY_OFF
,
225 IEEE80211_PRIVACY_ANY
228 #define IEEE80211_PRIVACY(x) \
229 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
232 * struct ieee80211_rate - bitrate definition
234 * This structure describes a bitrate that an 802.11 PHY can
235 * operate with. The two values @hw_value and @hw_value_short
236 * are only for driver use when pointers to this structure are
239 * @flags: rate-specific flags
240 * @bitrate: bitrate in units of 100 Kbps
241 * @hw_value: driver/hardware value for this rate
242 * @hw_value_short: driver/hardware value for this rate when
243 * short preamble is used
245 struct ieee80211_rate
{
248 u16 hw_value
, hw_value_short
;
252 * struct ieee80211_sta_ht_cap - STA's HT capabilities
254 * This structure describes most essential parameters needed
255 * to describe 802.11n HT capabilities for an STA.
257 * @ht_supported: is HT supported by the STA
258 * @cap: HT capabilities map as described in 802.11n spec
259 * @ampdu_factor: Maximum A-MPDU length factor
260 * @ampdu_density: Minimum A-MPDU spacing
261 * @mcs: Supported MCS rates
263 struct ieee80211_sta_ht_cap
{
264 u16 cap
; /* use IEEE80211_HT_CAP_ */
268 struct ieee80211_mcs_info mcs
;
272 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
274 * This structure describes most essential parameters needed
275 * to describe 802.11ac VHT capabilities for an STA.
277 * @vht_supported: is VHT supported by the STA
278 * @cap: VHT capabilities map as described in 802.11ac spec
279 * @vht_mcs: Supported VHT MCS rates
281 struct ieee80211_sta_vht_cap
{
283 u32 cap
; /* use IEEE80211_VHT_CAP_ */
284 struct ieee80211_vht_mcs_info vht_mcs
;
288 * struct ieee80211_supported_band - frequency band definition
290 * This structure describes a frequency band a wiphy
291 * is able to operate in.
293 * @channels: Array of channels the hardware can operate in
295 * @band: the band this structure represents
296 * @n_channels: Number of channels in @channels
297 * @bitrates: Array of bitrates the hardware can operate with
298 * in this band. Must be sorted to give a valid "supported
299 * rates" IE, i.e. CCK rates first, then OFDM.
300 * @n_bitrates: Number of bitrates in @bitrates
301 * @ht_cap: HT capabilities in this band
302 * @vht_cap: VHT capabilities in this band
304 struct ieee80211_supported_band
{
305 struct ieee80211_channel
*channels
;
306 struct ieee80211_rate
*bitrates
;
307 enum nl80211_band band
;
310 struct ieee80211_sta_ht_cap ht_cap
;
311 struct ieee80211_sta_vht_cap vht_cap
;
315 * wiphy_read_of_freq_limits - read frequency limits from device tree
317 * @wiphy: the wireless device to get extra limits for
319 * Some devices may have extra limitations specified in DT. This may be useful
320 * for chipsets that normally support more bands but are limited due to board
321 * design (e.g. by antennas or external power amplifier).
323 * This function reads info from DT and uses it to *modify* channels (disable
324 * unavailable ones). It's usually a *bad* idea to use it in drivers with
325 * shared channel data as DT limitations are device specific. You should make
326 * sure to call it only if channels in wiphy are copied and can be modified
327 * without affecting other devices.
329 * As this function access device node it has to be called after set_wiphy_dev.
330 * It also modifies channels so they have to be set first.
331 * If using this helper, call it before wiphy_register().
334 void wiphy_read_of_freq_limits(struct wiphy
*wiphy
);
335 #else /* CONFIG_OF */
336 static inline void wiphy_read_of_freq_limits(struct wiphy
*wiphy
)
339 #endif /* !CONFIG_OF */
343 * Wireless hardware/device configuration structures and methods
347 * DOC: Actions and configuration
349 * Each wireless device and each virtual interface offer a set of configuration
350 * operations and other actions that are invoked by userspace. Each of these
351 * actions is described in the operations structure, and the parameters these
352 * operations use are described separately.
354 * Additionally, some operations are asynchronous and expect to get status
355 * information via some functions that drivers need to call.
357 * Scanning and BSS list handling with its associated functionality is described
358 * in a separate chapter.
361 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
362 WLAN_USER_POSITION_LEN)
365 * struct vif_params - describes virtual interface parameters
366 * @flags: monitor interface flags, unchanged if 0, otherwise
367 * %MONITOR_FLAG_CHANGED will be set
368 * @use_4addr: use 4-address frames
369 * @macaddr: address to use for this virtual interface.
370 * If this parameter is set to zero address the driver may
371 * determine the address as needed.
372 * This feature is only fully supported by drivers that enable the
373 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
374 ** only p2p devices with specified MAC.
375 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
376 * belonging to that MU-MIMO groupID; %NULL if not changed
377 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
378 * MU-MIMO packets going to the specified station; %NULL if not changed
383 u8 macaddr
[ETH_ALEN
];
384 const u8
*vht_mumimo_groups
;
385 const u8
*vht_mumimo_follow_addr
;
389 * struct key_params - key information
391 * Information about a key
394 * @key_len: length of key material
395 * @cipher: cipher suite selector
396 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
397 * with the get_key() callback, must be in little endian,
398 * length given by @seq_len.
399 * @seq_len: length of @seq.
410 * struct cfg80211_chan_def - channel definition
411 * @chan: the (control) channel
412 * @width: channel width
413 * @center_freq1: center frequency of first segment
414 * @center_freq2: center frequency of second segment
415 * (only with 80+80 MHz)
417 struct cfg80211_chan_def
{
418 struct ieee80211_channel
*chan
;
419 enum nl80211_chan_width width
;
425 * cfg80211_get_chandef_type - return old channel type from chandef
426 * @chandef: the channel definition
428 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
429 * chandef, which must have a bandwidth allowing this conversion.
431 static inline enum nl80211_channel_type
432 cfg80211_get_chandef_type(const struct cfg80211_chan_def
*chandef
)
434 switch (chandef
->width
) {
435 case NL80211_CHAN_WIDTH_20_NOHT
:
436 return NL80211_CHAN_NO_HT
;
437 case NL80211_CHAN_WIDTH_20
:
438 return NL80211_CHAN_HT20
;
439 case NL80211_CHAN_WIDTH_40
:
440 if (chandef
->center_freq1
> chandef
->chan
->center_freq
)
441 return NL80211_CHAN_HT40PLUS
;
442 return NL80211_CHAN_HT40MINUS
;
445 return NL80211_CHAN_NO_HT
;
450 * cfg80211_chandef_create - create channel definition using channel type
451 * @chandef: the channel definition struct to fill
452 * @channel: the control channel
453 * @chantype: the channel type
455 * Given a channel type, create a channel definition.
457 void cfg80211_chandef_create(struct cfg80211_chan_def
*chandef
,
458 struct ieee80211_channel
*channel
,
459 enum nl80211_channel_type chantype
);
462 * cfg80211_chandef_identical - check if two channel definitions are identical
463 * @chandef1: first channel definition
464 * @chandef2: second channel definition
466 * Return: %true if the channels defined by the channel definitions are
467 * identical, %false otherwise.
470 cfg80211_chandef_identical(const struct cfg80211_chan_def
*chandef1
,
471 const struct cfg80211_chan_def
*chandef2
)
473 return (chandef1
->chan
== chandef2
->chan
&&
474 chandef1
->width
== chandef2
->width
&&
475 chandef1
->center_freq1
== chandef2
->center_freq1
&&
476 chandef1
->center_freq2
== chandef2
->center_freq2
);
480 * cfg80211_chandef_compatible - check if two channel definitions are compatible
481 * @chandef1: first channel definition
482 * @chandef2: second channel definition
484 * Return: %NULL if the given channel definitions are incompatible,
485 * chandef1 or chandef2 otherwise.
487 const struct cfg80211_chan_def
*
488 cfg80211_chandef_compatible(const struct cfg80211_chan_def
*chandef1
,
489 const struct cfg80211_chan_def
*chandef2
);
492 * cfg80211_chandef_valid - check if a channel definition is valid
493 * @chandef: the channel definition to check
494 * Return: %true if the channel definition is valid. %false otherwise.
496 bool cfg80211_chandef_valid(const struct cfg80211_chan_def
*chandef
);
499 * cfg80211_chandef_usable - check if secondary channels can be used
500 * @wiphy: the wiphy to validate against
501 * @chandef: the channel definition to check
502 * @prohibited_flags: the regulatory channel flags that must not be set
503 * Return: %true if secondary channels are usable. %false otherwise.
505 bool cfg80211_chandef_usable(struct wiphy
*wiphy
,
506 const struct cfg80211_chan_def
*chandef
,
507 u32 prohibited_flags
);
510 * cfg80211_chandef_dfs_required - checks if radar detection is required
511 * @wiphy: the wiphy to validate against
512 * @chandef: the channel definition to check
513 * @iftype: the interface type as specified in &enum nl80211_iftype
515 * 1 if radar detection is required, 0 if it is not, < 0 on error
517 int cfg80211_chandef_dfs_required(struct wiphy
*wiphy
,
518 const struct cfg80211_chan_def
*chandef
,
519 enum nl80211_iftype iftype
);
522 * ieee80211_chandef_rate_flags - returns rate flags for a channel
524 * In some channel types, not all rates may be used - for example CCK
525 * rates may not be used in 5/10 MHz channels.
527 * @chandef: channel definition for the channel
529 * Returns: rate flags which apply for this channel
531 static inline enum ieee80211_rate_flags
532 ieee80211_chandef_rate_flags(struct cfg80211_chan_def
*chandef
)
534 switch (chandef
->width
) {
535 case NL80211_CHAN_WIDTH_5
:
536 return IEEE80211_RATE_SUPPORTS_5MHZ
;
537 case NL80211_CHAN_WIDTH_10
:
538 return IEEE80211_RATE_SUPPORTS_10MHZ
;
546 * ieee80211_chandef_max_power - maximum transmission power for the chandef
548 * In some regulations, the transmit power may depend on the configured channel
549 * bandwidth which may be defined as dBm/MHz. This function returns the actual
550 * max_power for non-standard (20 MHz) channels.
552 * @chandef: channel definition for the channel
554 * Returns: maximum allowed transmission power in dBm for the chandef
557 ieee80211_chandef_max_power(struct cfg80211_chan_def
*chandef
)
559 switch (chandef
->width
) {
560 case NL80211_CHAN_WIDTH_5
:
561 return min(chandef
->chan
->max_reg_power
- 6,
562 chandef
->chan
->max_power
);
563 case NL80211_CHAN_WIDTH_10
:
564 return min(chandef
->chan
->max_reg_power
- 3,
565 chandef
->chan
->max_power
);
569 return chandef
->chan
->max_power
;
573 * enum survey_info_flags - survey information flags
575 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
576 * @SURVEY_INFO_IN_USE: channel is currently being used
577 * @SURVEY_INFO_TIME: active time (in ms) was filled in
578 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
579 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
580 * @SURVEY_INFO_TIME_RX: receive time was filled in
581 * @SURVEY_INFO_TIME_TX: transmit time was filled in
582 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
584 * Used by the driver to indicate which info in &struct survey_info
585 * it has filled in during the get_survey().
587 enum survey_info_flags
{
588 SURVEY_INFO_NOISE_DBM
= BIT(0),
589 SURVEY_INFO_IN_USE
= BIT(1),
590 SURVEY_INFO_TIME
= BIT(2),
591 SURVEY_INFO_TIME_BUSY
= BIT(3),
592 SURVEY_INFO_TIME_EXT_BUSY
= BIT(4),
593 SURVEY_INFO_TIME_RX
= BIT(5),
594 SURVEY_INFO_TIME_TX
= BIT(6),
595 SURVEY_INFO_TIME_SCAN
= BIT(7),
599 * struct survey_info - channel survey response
601 * @channel: the channel this survey record reports, may be %NULL for a single
602 * record to report global statistics
603 * @filled: bitflag of flags from &enum survey_info_flags
604 * @noise: channel noise in dBm. This and all following fields are
606 * @time: amount of time in ms the radio was turn on (on the channel)
607 * @time_busy: amount of time the primary channel was sensed busy
608 * @time_ext_busy: amount of time the extension channel was sensed busy
609 * @time_rx: amount of time the radio spent receiving data
610 * @time_tx: amount of time the radio spent transmitting data
611 * @time_scan: amount of time the radio spent for scanning
613 * Used by dump_survey() to report back per-channel survey information.
615 * This structure can later be expanded with things like
616 * channel duty cycle etc.
619 struct ieee80211_channel
*channel
;
630 #define CFG80211_MAX_WEP_KEYS 4
633 * struct cfg80211_crypto_settings - Crypto settings
634 * @wpa_versions: indicates which, if any, WPA versions are enabled
635 * (from enum nl80211_wpa_versions)
636 * @cipher_group: group key cipher suite (or 0 if unset)
637 * @n_ciphers_pairwise: number of AP supported unicast ciphers
638 * @ciphers_pairwise: unicast key cipher suites
639 * @n_akm_suites: number of AKM suites
640 * @akm_suites: AKM suites
641 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
642 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
643 * required to assume that the port is unauthorized until authorized by
644 * user space. Otherwise, port is marked authorized by default.
645 * @control_port_ethertype: the control port protocol that should be
646 * allowed through even on unauthorized ports
647 * @control_port_no_encrypt: TRUE to prevent encryption of control port
649 * @wep_keys: static WEP keys, if not NULL points to an array of
650 * CFG80211_MAX_WEP_KEYS WEP keys
651 * @wep_tx_key: key index (0..3) of the default TX static WEP key
653 struct cfg80211_crypto_settings
{
656 int n_ciphers_pairwise
;
657 u32 ciphers_pairwise
[NL80211_MAX_NR_CIPHER_SUITES
];
659 u32 akm_suites
[NL80211_MAX_NR_AKM_SUITES
];
661 __be16 control_port_ethertype
;
662 bool control_port_no_encrypt
;
663 struct key_params
*wep_keys
;
668 * struct cfg80211_beacon_data - beacon data
669 * @head: head portion of beacon (before TIM IE)
670 * or %NULL if not changed
671 * @tail: tail portion of beacon (after TIM IE)
672 * or %NULL if not changed
673 * @head_len: length of @head
674 * @tail_len: length of @tail
675 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
676 * @beacon_ies_len: length of beacon_ies in octets
677 * @proberesp_ies: extra information element(s) to add into Probe Response
679 * @proberesp_ies_len: length of proberesp_ies in octets
680 * @assocresp_ies: extra information element(s) to add into (Re)Association
681 * Response frames or %NULL
682 * @assocresp_ies_len: length of assocresp_ies in octets
683 * @probe_resp_len: length of probe response template (@probe_resp)
684 * @probe_resp: probe response template (AP mode only)
686 struct cfg80211_beacon_data
{
687 const u8
*head
, *tail
;
688 const u8
*beacon_ies
;
689 const u8
*proberesp_ies
;
690 const u8
*assocresp_ies
;
691 const u8
*probe_resp
;
693 size_t head_len
, tail_len
;
694 size_t beacon_ies_len
;
695 size_t proberesp_ies_len
;
696 size_t assocresp_ies_len
;
697 size_t probe_resp_len
;
705 * struct cfg80211_acl_data - Access control list data
707 * @acl_policy: ACL policy to be applied on the station's
708 * entry specified by mac_addr
709 * @n_acl_entries: Number of MAC address entries passed
710 * @mac_addrs: List of MAC addresses of stations to be used for ACL
712 struct cfg80211_acl_data
{
713 enum nl80211_acl_policy acl_policy
;
717 struct mac_address mac_addrs
[];
721 * cfg80211_bitrate_mask - masks for bitrate control
723 struct cfg80211_bitrate_mask
{
726 u8 ht_mcs
[IEEE80211_HT_MCS_MASK_LEN
];
727 u16 vht_mcs
[NL80211_VHT_NSS_MAX
];
728 enum nl80211_txrate_gi gi
;
729 } control
[NUM_NL80211_BANDS
];
733 * struct cfg80211_ap_settings - AP configuration
735 * Used to configure an AP interface.
737 * @chandef: defines the channel to use
738 * @beacon: beacon data
739 * @beacon_interval: beacon interval
740 * @dtim_period: DTIM period
741 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
743 * @ssid_len: length of @ssid
744 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
745 * @crypto: crypto settings
746 * @privacy: the BSS uses privacy
747 * @auth_type: Authentication type (algorithm)
748 * @smps_mode: SMPS mode
749 * @inactivity_timeout: time in seconds to determine station's inactivity.
750 * @p2p_ctwindow: P2P CT Window
751 * @p2p_opp_ps: P2P opportunistic PS
752 * @acl: ACL configuration used by the drivers which has support for
753 * MAC address based access control
754 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
756 * @beacon_rate: bitrate to be used for beacons
757 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
758 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
759 * @ht_required: stations must support HT
760 * @vht_required: stations must support VHT
762 struct cfg80211_ap_settings
{
763 struct cfg80211_chan_def chandef
;
765 struct cfg80211_beacon_data beacon
;
767 int beacon_interval
, dtim_period
;
770 enum nl80211_hidden_ssid hidden_ssid
;
771 struct cfg80211_crypto_settings crypto
;
773 enum nl80211_auth_type auth_type
;
774 enum nl80211_smps_mode smps_mode
;
775 int inactivity_timeout
;
778 const struct cfg80211_acl_data
*acl
;
780 struct cfg80211_bitrate_mask beacon_rate
;
782 const struct ieee80211_ht_cap
*ht_cap
;
783 const struct ieee80211_vht_cap
*vht_cap
;
784 bool ht_required
, vht_required
;
788 * struct cfg80211_csa_settings - channel switch settings
790 * Used for channel switch
792 * @chandef: defines the channel to use after the switch
793 * @beacon_csa: beacon data while performing the switch
794 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
795 * @counter_offsets_presp: offsets of the counters within the probe response
796 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
797 * @n_counter_offsets_presp: number of csa counters in the probe response
798 * @beacon_after: beacon data to be used on the new channel
799 * @radar_required: whether radar detection is required on the new channel
800 * @block_tx: whether transmissions should be blocked while changing
801 * @count: number of beacons until switch
803 struct cfg80211_csa_settings
{
804 struct cfg80211_chan_def chandef
;
805 struct cfg80211_beacon_data beacon_csa
;
806 const u16
*counter_offsets_beacon
;
807 const u16
*counter_offsets_presp
;
808 unsigned int n_counter_offsets_beacon
;
809 unsigned int n_counter_offsets_presp
;
810 struct cfg80211_beacon_data beacon_after
;
817 * struct iface_combination_params - input parameters for interface combinations
819 * Used to pass interface combination parameters
821 * @num_different_channels: the number of different channels we want
822 * to use for verification
823 * @radar_detect: a bitmap where each bit corresponds to a channel
824 * width where radar detection is needed, as in the definition of
825 * &struct ieee80211_iface_combination.@radar_detect_widths
826 * @iftype_num: array with the number of interfaces of each interface
827 * type. The index is the interface type as specified in &enum
829 * @new_beacon_int: set this to the beacon interval of a new interface
830 * that's not operating yet, if such is to be checked as part of
833 struct iface_combination_params
{
834 int num_different_channels
;
836 int iftype_num
[NUM_NL80211_IFTYPES
];
841 * enum station_parameters_apply_mask - station parameter values to apply
842 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
843 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
844 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
846 * Not all station parameters have in-band "no change" signalling,
847 * for those that don't these flags will are used.
849 enum station_parameters_apply_mask
{
850 STATION_PARAM_APPLY_UAPSD
= BIT(0),
851 STATION_PARAM_APPLY_CAPABILITY
= BIT(1),
852 STATION_PARAM_APPLY_PLINK_STATE
= BIT(2),
856 * struct station_parameters - station parameters
858 * Used to change and create a new station.
860 * @vlan: vlan interface station should belong to
861 * @supported_rates: supported rates in IEEE 802.11 format
862 * (or NULL for no change)
863 * @supported_rates_len: number of supported rates
864 * @sta_flags_mask: station flags that changed
865 * (bitmask of BIT(%NL80211_STA_FLAG_...))
866 * @sta_flags_set: station flags values
867 * (bitmask of BIT(%NL80211_STA_FLAG_...))
868 * @listen_interval: listen interval or -1 for no change
869 * @aid: AID or zero for no change
870 * @peer_aid: mesh peer AID or zero for no change
871 * @plink_action: plink action to take
872 * @plink_state: set the peer link state for a station
873 * @ht_capa: HT capabilities of station
874 * @vht_capa: VHT capabilities of station
875 * @uapsd_queues: bitmap of queues configured for uapsd. same format
876 * as the AC bitmap in the QoS info field
877 * @max_sp: max Service Period. same format as the MAX_SP in the
878 * QoS info field (but already shifted down)
879 * @sta_modify_mask: bitmap indicating which parameters changed
880 * (for those that don't have a natural "no change" value),
881 * see &enum station_parameters_apply_mask
882 * @local_pm: local link-specific mesh power save mode (no change when set
884 * @capability: station capability
885 * @ext_capab: extended capabilities of the station
886 * @ext_capab_len: number of extended capabilities
887 * @supported_channels: supported channels in IEEE 802.11 format
888 * @supported_channels_len: number of supported channels
889 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
890 * @supported_oper_classes_len: number of supported operating classes
891 * @opmode_notif: operating mode field from Operating Mode Notification
892 * @opmode_notif_used: information if operating mode field is used
893 * @support_p2p_ps: information if station supports P2P PS mechanism
895 struct station_parameters
{
896 const u8
*supported_rates
;
897 struct net_device
*vlan
;
898 u32 sta_flags_mask
, sta_flags_set
;
903 u8 supported_rates_len
;
906 const struct ieee80211_ht_cap
*ht_capa
;
907 const struct ieee80211_vht_cap
*vht_capa
;
910 enum nl80211_mesh_power_mode local_pm
;
914 const u8
*supported_channels
;
915 u8 supported_channels_len
;
916 const u8
*supported_oper_classes
;
917 u8 supported_oper_classes_len
;
919 bool opmode_notif_used
;
924 * struct station_del_parameters - station deletion parameters
926 * Used to delete a station entry (or all stations).
928 * @mac: MAC address of the station to remove or NULL to remove all stations
929 * @subtype: Management frame subtype to use for indicating removal
930 * (10 = Disassociation, 12 = Deauthentication)
931 * @reason_code: Reason code for the Disassociation/Deauthentication frame
933 struct station_del_parameters
{
940 * enum cfg80211_station_type - the type of station being modified
941 * @CFG80211_STA_AP_CLIENT: client of an AP interface
942 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
943 * unassociated (update properties for this type of client is permitted)
944 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
945 * the AP MLME in the device
946 * @CFG80211_STA_AP_STA: AP station on managed interface
947 * @CFG80211_STA_IBSS: IBSS station
948 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
949 * while TDLS setup is in progress, it moves out of this state when
950 * being marked authorized; use this only if TDLS with external setup is
952 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
953 * entry that is operating, has been marked authorized by userspace)
954 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
955 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
957 enum cfg80211_station_type
{
958 CFG80211_STA_AP_CLIENT
,
959 CFG80211_STA_AP_CLIENT_UNASSOC
,
960 CFG80211_STA_AP_MLME_CLIENT
,
963 CFG80211_STA_TDLS_PEER_SETUP
,
964 CFG80211_STA_TDLS_PEER_ACTIVE
,
965 CFG80211_STA_MESH_PEER_KERNEL
,
966 CFG80211_STA_MESH_PEER_USER
,
970 * cfg80211_check_station_change - validate parameter changes
971 * @wiphy: the wiphy this operates on
972 * @params: the new parameters for a station
973 * @statype: the type of station being modified
975 * Utility function for the @change_station driver method. Call this function
976 * with the appropriate station type looking up the station (and checking that
977 * it exists). It will verify whether the station change is acceptable, and if
978 * not will return an error code. Note that it may modify the parameters for
979 * backward compatibility reasons, so don't use them before calling this.
981 int cfg80211_check_station_change(struct wiphy
*wiphy
,
982 struct station_parameters
*params
,
983 enum cfg80211_station_type statype
);
986 * enum station_info_rate_flags - bitrate info flags
988 * Used by the driver to indicate the specific rate transmission
989 * type for 802.11n transmissions.
991 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
992 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
993 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
994 * @RATE_INFO_FLAGS_60G: 60GHz MCS
996 enum rate_info_flags
{
997 RATE_INFO_FLAGS_MCS
= BIT(0),
998 RATE_INFO_FLAGS_VHT_MCS
= BIT(1),
999 RATE_INFO_FLAGS_SHORT_GI
= BIT(2),
1000 RATE_INFO_FLAGS_60G
= BIT(3),
1004 * enum rate_info_bw - rate bandwidth information
1006 * Used by the driver to indicate the rate bandwidth.
1008 * @RATE_INFO_BW_5: 5 MHz bandwidth
1009 * @RATE_INFO_BW_10: 10 MHz bandwidth
1010 * @RATE_INFO_BW_20: 20 MHz bandwidth
1011 * @RATE_INFO_BW_40: 40 MHz bandwidth
1012 * @RATE_INFO_BW_80: 80 MHz bandwidth
1013 * @RATE_INFO_BW_160: 160 MHz bandwidth
1025 * struct rate_info - bitrate information
1027 * Information about a receiving or transmitting bitrate
1029 * @flags: bitflag of flags from &enum rate_info_flags
1030 * @mcs: mcs index if struct describes a 802.11n bitrate
1031 * @legacy: bitrate in 100kbit/s for 802.11abg
1032 * @nss: number of streams (VHT only)
1033 * @bw: bandwidth (from &enum rate_info_bw)
1044 * enum station_info_rate_flags - bitrate info flags
1046 * Used by the driver to indicate the specific rate transmission
1047 * type for 802.11n transmissions.
1049 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1050 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1051 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1053 enum bss_param_flags
{
1054 BSS_PARAM_FLAGS_CTS_PROT
= 1<<0,
1055 BSS_PARAM_FLAGS_SHORT_PREAMBLE
= 1<<1,
1056 BSS_PARAM_FLAGS_SHORT_SLOT_TIME
= 1<<2,
1060 * struct sta_bss_parameters - BSS parameters for the attached station
1062 * Information about the currently associated BSS
1064 * @flags: bitflag of flags from &enum bss_param_flags
1065 * @dtim_period: DTIM period for the BSS
1066 * @beacon_interval: beacon interval
1068 struct sta_bss_parameters
{
1071 u16 beacon_interval
;
1075 * struct cfg80211_tid_stats - per-TID statistics
1076 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1077 * indicate the relevant values in this struct are filled
1078 * @rx_msdu: number of received MSDUs
1079 * @tx_msdu: number of (attempted) transmitted MSDUs
1080 * @tx_msdu_retries: number of retries (not counting the first) for
1082 * @tx_msdu_failed: number of failed transmitted MSDUs
1084 struct cfg80211_tid_stats
{
1088 u64 tx_msdu_retries
;
1092 #define IEEE80211_MAX_CHAINS 4
1095 * struct station_info - station information
1097 * Station information filled by driver for get_station() and dump_station.
1099 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1100 * indicate the relevant values in this struct for them
1101 * @connected_time: time(in secs) since a station is last connected
1102 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1103 * @rx_bytes: bytes (size of MPDUs) received from this station
1104 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1105 * @llid: mesh local link id
1106 * @plid: mesh peer link id
1107 * @plink_state: mesh peer link state
1108 * @signal: The signal strength, type depends on the wiphy's signal_type.
1109 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1110 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1111 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1112 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1113 * @chain_signal: per-chain signal strength of last received packet in dBm
1114 * @chain_signal_avg: per-chain signal strength average in dBm
1115 * @txrate: current unicast bitrate from this station
1116 * @rxrate: current unicast bitrate to this station
1117 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1118 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1119 * @tx_retries: cumulative retry counts (MPDUs)
1120 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1121 * @rx_dropped_misc: Dropped for un-specified reason.
1122 * @bss_param: current BSS parameters
1123 * @generation: generation number for nl80211 dumps.
1124 * This number should increase every time the list of stations
1125 * changes, i.e. when a station is added or removed, so that
1126 * userspace can tell whether it got a consistent snapshot.
1127 * @assoc_req_ies: IEs from (Re)Association Request.
1128 * This is used only when in AP mode with drivers that do not use
1129 * user space MLME/SME implementation. The information is provided for
1130 * the cfg80211_new_sta() calls to notify user space of the IEs.
1131 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1132 * @sta_flags: station flags mask & values
1133 * @beacon_loss_count: Number of times beacon loss event has triggered.
1134 * @t_offset: Time offset of the station relative to this host.
1135 * @local_pm: local mesh STA power save mode
1136 * @peer_pm: peer mesh STA power save mode
1137 * @nonpeer_pm: non-peer mesh STA power save mode
1138 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1139 * towards this station.
1140 * @rx_beacon: number of beacons received from this peer
1141 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1143 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1144 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1145 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1147 struct station_info
{
1160 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
1161 s8 chain_signal_avg
[IEEE80211_MAX_CHAINS
];
1163 struct rate_info txrate
;
1164 struct rate_info rxrate
;
1169 u32 rx_dropped_misc
;
1170 struct sta_bss_parameters bss_param
;
1171 struct nl80211_sta_flag_update sta_flags
;
1175 const u8
*assoc_req_ies
;
1176 size_t assoc_req_ies_len
;
1178 u32 beacon_loss_count
;
1180 enum nl80211_mesh_power_mode local_pm
;
1181 enum nl80211_mesh_power_mode peer_pm
;
1182 enum nl80211_mesh_power_mode nonpeer_pm
;
1184 u32 expected_throughput
;
1188 u8 rx_beacon_signal_avg
;
1189 struct cfg80211_tid_stats pertid
[IEEE80211_NUM_TIDS
+ 1];
1192 #if IS_ENABLED(CONFIG_CFG80211)
1194 * cfg80211_get_station - retrieve information about a given station
1195 * @dev: the device where the station is supposed to be connected to
1196 * @mac_addr: the mac address of the station of interest
1197 * @sinfo: pointer to the structure to fill with the information
1199 * Returns 0 on success and sinfo is filled with the available information
1200 * otherwise returns a negative error code and the content of sinfo has to be
1201 * considered undefined.
1203 int cfg80211_get_station(struct net_device
*dev
, const u8
*mac_addr
,
1204 struct station_info
*sinfo
);
1206 static inline int cfg80211_get_station(struct net_device
*dev
,
1208 struct station_info
*sinfo
)
1215 * enum monitor_flags - monitor flags
1217 * Monitor interface configuration flags. Note that these must be the bits
1218 * according to the nl80211 flags.
1220 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1221 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1222 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1223 * @MONITOR_FLAG_CONTROL: pass control frames
1224 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1225 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1226 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1228 enum monitor_flags
{
1229 MONITOR_FLAG_CHANGED
= 1<<__NL80211_MNTR_FLAG_INVALID
,
1230 MONITOR_FLAG_FCSFAIL
= 1<<NL80211_MNTR_FLAG_FCSFAIL
,
1231 MONITOR_FLAG_PLCPFAIL
= 1<<NL80211_MNTR_FLAG_PLCPFAIL
,
1232 MONITOR_FLAG_CONTROL
= 1<<NL80211_MNTR_FLAG_CONTROL
,
1233 MONITOR_FLAG_OTHER_BSS
= 1<<NL80211_MNTR_FLAG_OTHER_BSS
,
1234 MONITOR_FLAG_COOK_FRAMES
= 1<<NL80211_MNTR_FLAG_COOK_FRAMES
,
1235 MONITOR_FLAG_ACTIVE
= 1<<NL80211_MNTR_FLAG_ACTIVE
,
1239 * enum mpath_info_flags - mesh path information flags
1241 * Used by the driver to indicate which info in &struct mpath_info it has filled
1242 * in during get_station() or dump_station().
1244 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1245 * @MPATH_INFO_SN: @sn filled
1246 * @MPATH_INFO_METRIC: @metric filled
1247 * @MPATH_INFO_EXPTIME: @exptime filled
1248 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1249 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1250 * @MPATH_INFO_FLAGS: @flags filled
1252 enum mpath_info_flags
{
1253 MPATH_INFO_FRAME_QLEN
= BIT(0),
1254 MPATH_INFO_SN
= BIT(1),
1255 MPATH_INFO_METRIC
= BIT(2),
1256 MPATH_INFO_EXPTIME
= BIT(3),
1257 MPATH_INFO_DISCOVERY_TIMEOUT
= BIT(4),
1258 MPATH_INFO_DISCOVERY_RETRIES
= BIT(5),
1259 MPATH_INFO_FLAGS
= BIT(6),
1263 * struct mpath_info - mesh path information
1265 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1267 * @filled: bitfield of flags from &enum mpath_info_flags
1268 * @frame_qlen: number of queued frames for this destination
1269 * @sn: target sequence number
1270 * @metric: metric (cost) of this mesh path
1271 * @exptime: expiration time for the mesh path from now, in msecs
1272 * @flags: mesh path flags
1273 * @discovery_timeout: total mesh path discovery timeout, in msecs
1274 * @discovery_retries: mesh path discovery retries
1275 * @generation: generation number for nl80211 dumps.
1276 * This number should increase every time the list of mesh paths
1277 * changes, i.e. when a station is added or removed, so that
1278 * userspace can tell whether it got a consistent snapshot.
1286 u32 discovery_timeout
;
1287 u8 discovery_retries
;
1294 * struct bss_parameters - BSS parameters
1296 * Used to change BSS parameters (mainly for AP mode).
1298 * @use_cts_prot: Whether to use CTS protection
1299 * (0 = no, 1 = yes, -1 = do not change)
1300 * @use_short_preamble: Whether the use of short preambles is allowed
1301 * (0 = no, 1 = yes, -1 = do not change)
1302 * @use_short_slot_time: Whether the use of short slot time is allowed
1303 * (0 = no, 1 = yes, -1 = do not change)
1304 * @basic_rates: basic rates in IEEE 802.11 format
1305 * (or NULL for no change)
1306 * @basic_rates_len: number of basic rates
1307 * @ap_isolate: do not forward packets between connected stations
1308 * @ht_opmode: HT Operation mode
1309 * (u16 = opmode, -1 = do not change)
1310 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1311 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1313 struct bss_parameters
{
1315 int use_short_preamble
;
1316 int use_short_slot_time
;
1317 const u8
*basic_rates
;
1321 s8 p2p_ctwindow
, p2p_opp_ps
;
1325 * struct mesh_config - 802.11s mesh configuration
1327 * These parameters can be changed while the mesh is active.
1329 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1330 * by the Mesh Peering Open message
1331 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1332 * used by the Mesh Peering Open message
1333 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1334 * the mesh peering management to close a mesh peering
1335 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1337 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1338 * be sent to establish a new peer link instance in a mesh
1339 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1340 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1342 * @auto_open_plinks: whether we should automatically open peer links when we
1343 * detect compatible mesh peers
1344 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1345 * synchronize to for 11s default synchronization method
1346 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1347 * that an originator mesh STA can send to a particular path target
1348 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1349 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1350 * a path discovery in milliseconds
1351 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1352 * receiving a PREQ shall consider the forwarding information from the
1353 * root to be valid. (TU = time unit)
1354 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1355 * which a mesh STA can send only one action frame containing a PREQ
1357 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1358 * which a mesh STA can send only one Action frame containing a PERR
1360 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1361 * it takes for an HWMP information element to propagate across the mesh
1362 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1363 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1364 * announcements are transmitted
1365 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1366 * station has access to a broader network beyond the MBSS. (This is
1367 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1368 * only means that the station will announce others it's a mesh gate, but
1369 * not necessarily using the gate announcement protocol. Still keeping the
1370 * same nomenclature to be in sync with the spec)
1371 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1372 * entity (default is TRUE - forwarding entity)
1373 * @rssi_threshold: the threshold for average signal strength of candidate
1374 * station to establish a peer link
1375 * @ht_opmode: mesh HT protection mode
1377 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1378 * receiving a proactive PREQ shall consider the forwarding information to
1379 * the root mesh STA to be valid.
1381 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1382 * PREQs are transmitted.
1383 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1384 * during which a mesh STA can send only one Action frame containing
1385 * a PREQ element for root path confirmation.
1386 * @power_mode: The default mesh power save mode which will be the initial
1387 * setting for new peer links.
1388 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1389 * after transmitting its beacon.
1390 * @plink_timeout: If no tx activity is seen from a STA we've established
1391 * peering with for longer than this time (in seconds), then remove it
1392 * from the STA's list of peers. Default is 30 minutes.
1394 struct mesh_config
{
1395 u16 dot11MeshRetryTimeout
;
1396 u16 dot11MeshConfirmTimeout
;
1397 u16 dot11MeshHoldingTimeout
;
1398 u16 dot11MeshMaxPeerLinks
;
1399 u8 dot11MeshMaxRetries
;
1402 bool auto_open_plinks
;
1403 u32 dot11MeshNbrOffsetMaxNeighbor
;
1404 u8 dot11MeshHWMPmaxPREQretries
;
1405 u32 path_refresh_time
;
1406 u16 min_discovery_timeout
;
1407 u32 dot11MeshHWMPactivePathTimeout
;
1408 u16 dot11MeshHWMPpreqMinInterval
;
1409 u16 dot11MeshHWMPperrMinInterval
;
1410 u16 dot11MeshHWMPnetDiameterTraversalTime
;
1411 u8 dot11MeshHWMPRootMode
;
1412 u16 dot11MeshHWMPRannInterval
;
1413 bool dot11MeshGateAnnouncementProtocol
;
1414 bool dot11MeshForwarding
;
1417 u32 dot11MeshHWMPactivePathToRootTimeout
;
1418 u16 dot11MeshHWMProotInterval
;
1419 u16 dot11MeshHWMPconfirmationInterval
;
1420 enum nl80211_mesh_power_mode power_mode
;
1421 u16 dot11MeshAwakeWindowDuration
;
1426 * struct mesh_setup - 802.11s mesh setup configuration
1427 * @chandef: defines the channel to use
1428 * @mesh_id: the mesh ID
1429 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1430 * @sync_method: which synchronization method to use
1431 * @path_sel_proto: which path selection protocol to use
1432 * @path_metric: which metric to use
1433 * @auth_id: which authentication method this mesh is using
1434 * @ie: vendor information elements (optional)
1435 * @ie_len: length of vendor information elements
1436 * @is_authenticated: this mesh requires authentication
1437 * @is_secure: this mesh uses security
1438 * @user_mpm: userspace handles all MPM functions
1439 * @dtim_period: DTIM period to use
1440 * @beacon_interval: beacon interval to use
1441 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1442 * @basic_rates: basic rates to use when creating the mesh
1443 * @beacon_rate: bitrate to be used for beacons
1445 * These parameters are fixed when the mesh is created.
1448 struct cfg80211_chan_def chandef
;
1457 bool is_authenticated
;
1461 u16 beacon_interval
;
1462 int mcast_rate
[NUM_NL80211_BANDS
];
1464 struct cfg80211_bitrate_mask beacon_rate
;
1468 * struct ocb_setup - 802.11p OCB mode setup configuration
1469 * @chandef: defines the channel to use
1471 * These parameters are fixed when connecting to the network
1474 struct cfg80211_chan_def chandef
;
1478 * struct ieee80211_txq_params - TX queue parameters
1479 * @ac: AC identifier
1480 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1481 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1483 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1485 * @aifs: Arbitration interframe space [0..255]
1487 struct ieee80211_txq_params
{
1496 * DOC: Scanning and BSS list handling
1498 * The scanning process itself is fairly simple, but cfg80211 offers quite
1499 * a bit of helper functionality. To start a scan, the scan operation will
1500 * be invoked with a scan definition. This scan definition contains the
1501 * channels to scan, and the SSIDs to send probe requests for (including the
1502 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1503 * probe. Additionally, a scan request may contain extra information elements
1504 * that should be added to the probe request. The IEs are guaranteed to be
1505 * well-formed, and will not exceed the maximum length the driver advertised
1506 * in the wiphy structure.
1508 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1509 * it is responsible for maintaining the BSS list; the driver should not
1510 * maintain a list itself. For this notification, various functions exist.
1512 * Since drivers do not maintain a BSS list, there are also a number of
1513 * functions to search for a BSS and obtain information about it from the
1514 * BSS structure cfg80211 maintains. The BSS list is also made available
1519 * struct cfg80211_ssid - SSID description
1521 * @ssid_len: length of the ssid
1523 struct cfg80211_ssid
{
1524 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
1529 * struct cfg80211_scan_info - information about completed scan
1530 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1531 * wireless device that requested the scan is connected to. If this
1532 * information is not available, this field is left zero.
1533 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1534 * @aborted: set to true if the scan was aborted for any reason,
1535 * userspace will be notified of that
1537 struct cfg80211_scan_info
{
1539 u8 tsf_bssid
[ETH_ALEN
] __aligned(2);
1544 * struct cfg80211_scan_request - scan request description
1546 * @ssids: SSIDs to scan for (active scan only)
1547 * @n_ssids: number of SSIDs
1548 * @channels: channels to scan on.
1549 * @n_channels: total number of channels to scan
1550 * @scan_width: channel width for scanning
1551 * @ie: optional information element(s) to add into Probe Request or %NULL
1552 * @ie_len: length of ie in octets
1553 * @duration: how long to listen on each channel, in TUs. If
1554 * %duration_mandatory is not set, this is the maximum dwell time and
1555 * the actual dwell time may be shorter.
1556 * @duration_mandatory: if set, the scan duration must be as specified by the
1558 * @flags: bit field of flags controlling operation
1559 * @rates: bitmap of rates to advertise for each band
1560 * @wiphy: the wiphy this was for
1561 * @scan_start: time (in jiffies) when the scan started
1562 * @wdev: the wireless device to scan for
1563 * @info: (internal) information about completed scan
1564 * @notified: (internal) scan request was notified as done or aborted
1565 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1566 * @mac_addr: MAC address used with randomisation
1567 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1568 * are 0 in the mask should be randomised, bits that are 1 should
1569 * be taken from the @mac_addr
1570 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1572 struct cfg80211_scan_request
{
1573 struct cfg80211_ssid
*ssids
;
1576 enum nl80211_bss_scan_width scan_width
;
1580 bool duration_mandatory
;
1583 u32 rates
[NUM_NL80211_BANDS
];
1585 struct wireless_dev
*wdev
;
1587 u8 mac_addr
[ETH_ALEN
] __aligned(2);
1588 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
1589 u8 bssid
[ETH_ALEN
] __aligned(2);
1592 struct wiphy
*wiphy
;
1593 unsigned long scan_start
;
1594 struct cfg80211_scan_info info
;
1599 struct ieee80211_channel
*channels
[0];
1602 static inline void get_random_mask_addr(u8
*buf
, const u8
*addr
, const u8
*mask
)
1606 get_random_bytes(buf
, ETH_ALEN
);
1607 for (i
= 0; i
< ETH_ALEN
; i
++) {
1609 buf
[i
] |= addr
[i
] & mask
[i
];
1614 * struct cfg80211_match_set - sets of attributes to match
1616 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1617 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1619 struct cfg80211_match_set
{
1620 struct cfg80211_ssid ssid
;
1625 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1627 * @interval: interval between scheduled scan iterations. In seconds.
1628 * @iterations: number of scan iterations in this scan plan. Zero means
1630 * The last scan plan will always have this parameter set to zero,
1631 * all other scan plans will have a finite number of iterations.
1633 struct cfg80211_sched_scan_plan
{
1639 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1641 * @band: band of BSS which should match for RSSI level adjustment.
1642 * @delta: value of RSSI level adjustment.
1644 struct cfg80211_bss_select_adjust
{
1645 enum nl80211_band band
;
1650 * struct cfg80211_sched_scan_request - scheduled scan request description
1652 * @reqid: identifies this request.
1653 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1654 * @n_ssids: number of SSIDs
1655 * @n_channels: total number of channels to scan
1656 * @scan_width: channel width for scanning
1657 * @ie: optional information element(s) to add into Probe Request or %NULL
1658 * @ie_len: length of ie in octets
1659 * @flags: bit field of flags controlling operation
1660 * @match_sets: sets of parameters to be matched for a scan result
1661 * entry to be considered valid and to be passed to the host
1662 * (others are filtered out).
1663 * If ommited, all results are passed.
1664 * @n_match_sets: number of match sets
1665 * @wiphy: the wiphy this was for
1666 * @dev: the interface
1667 * @scan_start: start time of the scheduled scan
1668 * @channels: channels to scan
1669 * @min_rssi_thold: for drivers only supporting a single threshold, this
1670 * contains the minimum over all matchsets
1671 * @mac_addr: MAC address used with randomisation
1672 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1673 * are 0 in the mask should be randomised, bits that are 1 should
1674 * be taken from the @mac_addr
1675 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1676 * index must be executed first.
1677 * @n_scan_plans: number of scan plans, at least 1.
1678 * @rcu_head: RCU callback used to free the struct
1679 * @owner_nlportid: netlink portid of owner (if this should is a request
1680 * owned by a particular socket)
1681 * @nl_owner_dead: netlink owner socket was closed - this request be freed
1682 * @list: for keeping list of requests.
1683 * @delay: delay in seconds to use before starting the first scan
1684 * cycle. The driver may ignore this parameter and start
1685 * immediately (or at any other time), if this feature is not
1687 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
1688 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
1689 * reporting in connected state to cases where a matching BSS is determined
1690 * to have better or slightly worse RSSI than the current connected BSS.
1691 * The relative RSSI threshold values are ignored in disconnected state.
1692 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
1693 * to the specified band while deciding whether a better BSS is reported
1694 * using @relative_rssi. If delta is a negative number, the BSSs that
1695 * belong to the specified band will be penalized by delta dB in relative
1698 struct cfg80211_sched_scan_request
{
1700 struct cfg80211_ssid
*ssids
;
1703 enum nl80211_bss_scan_width scan_width
;
1707 struct cfg80211_match_set
*match_sets
;
1711 struct cfg80211_sched_scan_plan
*scan_plans
;
1714 u8 mac_addr
[ETH_ALEN
] __aligned(2);
1715 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
1717 bool relative_rssi_set
;
1719 struct cfg80211_bss_select_adjust rssi_adjust
;
1722 struct wiphy
*wiphy
;
1723 struct net_device
*dev
;
1724 unsigned long scan_start
;
1725 struct rcu_head rcu_head
;
1728 struct list_head list
;
1731 struct ieee80211_channel
*channels
[0];
1735 * enum cfg80211_signal_type - signal type
1737 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1738 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1739 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1741 enum cfg80211_signal_type
{
1742 CFG80211_SIGNAL_TYPE_NONE
,
1743 CFG80211_SIGNAL_TYPE_MBM
,
1744 CFG80211_SIGNAL_TYPE_UNSPEC
,
1748 * struct cfg80211_inform_bss - BSS inform data
1749 * @chan: channel the frame was received on
1750 * @scan_width: scan width that was used
1751 * @signal: signal strength value, according to the wiphy's
1753 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1754 * received; should match the time when the frame was actually
1755 * received by the device (not just by the host, in case it was
1756 * buffered on the device) and be accurate to about 10ms.
1757 * If the frame isn't buffered, just passing the return value of
1758 * ktime_get_boot_ns() is likely appropriate.
1759 * @parent_tsf: the time at the start of reception of the first octet of the
1760 * timestamp field of the frame. The time is the TSF of the BSS specified
1762 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1763 * the BSS that requested the scan in which the beacon/probe was received.
1765 struct cfg80211_inform_bss
{
1766 struct ieee80211_channel
*chan
;
1767 enum nl80211_bss_scan_width scan_width
;
1771 u8 parent_bssid
[ETH_ALEN
] __aligned(2);
1775 * struct cfg80211_bss_ies - BSS entry IE data
1776 * @tsf: TSF contained in the frame that carried these IEs
1777 * @rcu_head: internal use, for freeing
1778 * @len: length of the IEs
1779 * @from_beacon: these IEs are known to come from a beacon
1782 struct cfg80211_bss_ies
{
1784 struct rcu_head rcu_head
;
1791 * struct cfg80211_bss - BSS description
1793 * This structure describes a BSS (which may also be a mesh network)
1794 * for use in scan results and similar.
1796 * @channel: channel this BSS is on
1797 * @scan_width: width of the control channel
1798 * @bssid: BSSID of the BSS
1799 * @beacon_interval: the beacon interval as from the frame
1800 * @capability: the capability field in host byte order
1801 * @ies: the information elements (Note that there is no guarantee that these
1802 * are well-formed!); this is a pointer to either the beacon_ies or
1803 * proberesp_ies depending on whether Probe Response frame has been
1804 * received. It is always non-%NULL.
1805 * @beacon_ies: the information elements from the last Beacon frame
1806 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1807 * own the beacon_ies, but they're just pointers to the ones from the
1808 * @hidden_beacon_bss struct)
1809 * @proberesp_ies: the information elements from the last Probe Response frame
1810 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1811 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1812 * that holds the beacon data. @beacon_ies is still valid, of course, and
1813 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1814 * @signal: signal strength value (type depends on the wiphy's signal_type)
1815 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1817 struct cfg80211_bss
{
1818 struct ieee80211_channel
*channel
;
1819 enum nl80211_bss_scan_width scan_width
;
1821 const struct cfg80211_bss_ies __rcu
*ies
;
1822 const struct cfg80211_bss_ies __rcu
*beacon_ies
;
1823 const struct cfg80211_bss_ies __rcu
*proberesp_ies
;
1825 struct cfg80211_bss
*hidden_beacon_bss
;
1829 u16 beacon_interval
;
1834 u8 priv
[0] __aligned(sizeof(void *));
1838 * ieee80211_bss_get_ie - find IE with given ID
1839 * @bss: the bss to search
1842 * Note that the return value is an RCU-protected pointer, so
1843 * rcu_read_lock() must be held when calling this function.
1844 * Return: %NULL if not found.
1846 const u8
*ieee80211_bss_get_ie(struct cfg80211_bss
*bss
, u8 ie
);
1850 * struct cfg80211_auth_request - Authentication request data
1852 * This structure provides information needed to complete IEEE 802.11
1855 * @bss: The BSS to authenticate with, the callee must obtain a reference
1856 * to it if it needs to keep it.
1857 * @auth_type: Authentication type (algorithm)
1858 * @ie: Extra IEs to add to Authentication frame or %NULL
1859 * @ie_len: Length of ie buffer in octets
1860 * @key_len: length of WEP key for shared key authentication
1861 * @key_idx: index of WEP key for shared key authentication
1862 * @key: WEP key for shared key authentication
1863 * @auth_data: Fields and elements in Authentication frames. This contains
1864 * the authentication frame body (non-IE and IE data), excluding the
1865 * Authentication algorithm number, i.e., starting at the Authentication
1866 * transaction sequence number field.
1867 * @auth_data_len: Length of auth_data buffer in octets
1869 struct cfg80211_auth_request
{
1870 struct cfg80211_bss
*bss
;
1873 enum nl80211_auth_type auth_type
;
1875 u8 key_len
, key_idx
;
1876 const u8
*auth_data
;
1877 size_t auth_data_len
;
1881 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1883 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1884 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1885 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1887 enum cfg80211_assoc_req_flags
{
1888 ASSOC_REQ_DISABLE_HT
= BIT(0),
1889 ASSOC_REQ_DISABLE_VHT
= BIT(1),
1890 ASSOC_REQ_USE_RRM
= BIT(2),
1894 * struct cfg80211_assoc_request - (Re)Association request data
1896 * This structure provides information needed to complete IEEE 802.11
1898 * @bss: The BSS to associate with. If the call is successful the driver is
1899 * given a reference that it must give back to cfg80211_send_rx_assoc()
1900 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1901 * association requests while already associating must be rejected.
1902 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1903 * @ie_len: Length of ie buffer in octets
1904 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1905 * @crypto: crypto settings
1906 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1907 * to indicate a request to reassociate within the ESS instead of a request
1908 * do the initial association with the ESS. When included, this is set to
1909 * the BSSID of the current association, i.e., to the value that is
1910 * included in the Current AP address field of the Reassociation Request
1912 * @flags: See &enum cfg80211_assoc_req_flags
1913 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1914 * will be used in ht_capa. Un-supported values will be ignored.
1915 * @ht_capa_mask: The bits of ht_capa which are to be used.
1916 * @vht_capa: VHT capability override
1917 * @vht_capa_mask: VHT capability mask indicating which fields to use
1918 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
1919 * %NULL if FILS is not used.
1920 * @fils_kek_len: Length of fils_kek in octets
1921 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
1922 * Request/Response frame or %NULL if FILS is not used. This field starts
1923 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
1925 struct cfg80211_assoc_request
{
1926 struct cfg80211_bss
*bss
;
1927 const u8
*ie
, *prev_bssid
;
1929 struct cfg80211_crypto_settings crypto
;
1932 struct ieee80211_ht_cap ht_capa
;
1933 struct ieee80211_ht_cap ht_capa_mask
;
1934 struct ieee80211_vht_cap vht_capa
, vht_capa_mask
;
1936 size_t fils_kek_len
;
1937 const u8
*fils_nonces
;
1941 * struct cfg80211_deauth_request - Deauthentication request data
1943 * This structure provides information needed to complete IEEE 802.11
1946 * @bssid: the BSSID of the BSS to deauthenticate from
1947 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1948 * @ie_len: Length of ie buffer in octets
1949 * @reason_code: The reason code for the deauthentication
1950 * @local_state_change: if set, change local state only and
1951 * do not set a deauth frame
1953 struct cfg80211_deauth_request
{
1958 bool local_state_change
;
1962 * struct cfg80211_disassoc_request - Disassociation request data
1964 * This structure provides information needed to complete IEEE 802.11
1967 * @bss: the BSS to disassociate from
1968 * @ie: Extra IEs to add to Disassociation frame or %NULL
1969 * @ie_len: Length of ie buffer in octets
1970 * @reason_code: The reason code for the disassociation
1971 * @local_state_change: This is a request for a local state only, i.e., no
1972 * Disassociation frame is to be transmitted.
1974 struct cfg80211_disassoc_request
{
1975 struct cfg80211_bss
*bss
;
1979 bool local_state_change
;
1983 * struct cfg80211_ibss_params - IBSS parameters
1985 * This structure defines the IBSS parameters for the join_ibss()
1988 * @ssid: The SSID, will always be non-null.
1989 * @ssid_len: The length of the SSID, will always be non-zero.
1990 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1991 * search for IBSSs with a different BSSID.
1992 * @chandef: defines the channel to use if no other IBSS to join can be found
1993 * @channel_fixed: The channel should be fixed -- do not search for
1994 * IBSSs to join on other channels.
1995 * @ie: information element(s) to include in the beacon
1996 * @ie_len: length of that
1997 * @beacon_interval: beacon interval to use
1998 * @privacy: this is a protected network, keys will be configured
2000 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2001 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2002 * required to assume that the port is unauthorized until authorized by
2003 * user space. Otherwise, port is marked authorized by default.
2004 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2005 * changes the channel when a radar is detected. This is required
2006 * to operate on DFS channels.
2007 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2008 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2009 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2010 * will be used in ht_capa. Un-supported values will be ignored.
2011 * @ht_capa_mask: The bits of ht_capa which are to be used.
2013 struct cfg80211_ibss_params
{
2016 struct cfg80211_chan_def chandef
;
2018 u8 ssid_len
, ie_len
;
2019 u16 beacon_interval
;
2024 bool userspace_handles_dfs
;
2025 int mcast_rate
[NUM_NL80211_BANDS
];
2026 struct ieee80211_ht_cap ht_capa
;
2027 struct ieee80211_ht_cap ht_capa_mask
;
2031 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2033 * @behaviour: requested BSS selection behaviour.
2034 * @param: parameters for requestion behaviour.
2035 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2036 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2038 struct cfg80211_bss_selection
{
2039 enum nl80211_bss_select_attr behaviour
;
2041 enum nl80211_band band_pref
;
2042 struct cfg80211_bss_select_adjust adjust
;
2047 * struct cfg80211_connect_params - Connection parameters
2049 * This structure provides information needed to complete IEEE 802.11
2050 * authentication and association.
2052 * @channel: The channel to use or %NULL if not specified (auto-select based
2054 * @channel_hint: The channel of the recommended BSS for initial connection or
2055 * %NULL if not specified
2056 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2058 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2059 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2060 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2063 * @ssid_len: Length of ssid in octets
2064 * @auth_type: Authentication type (algorithm)
2065 * @ie: IEs for association request
2066 * @ie_len: Length of assoc_ie in octets
2067 * @privacy: indicates whether privacy-enabled APs should be used
2068 * @mfp: indicate whether management frame protection is used
2069 * @crypto: crypto settings
2070 * @key_len: length of WEP key for shared key authentication
2071 * @key_idx: index of WEP key for shared key authentication
2072 * @key: WEP key for shared key authentication
2073 * @flags: See &enum cfg80211_assoc_req_flags
2074 * @bg_scan_period: Background scan period in seconds
2075 * or -1 to indicate that default value is to be used.
2076 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2077 * will be used in ht_capa. Un-supported values will be ignored.
2078 * @ht_capa_mask: The bits of ht_capa which are to be used.
2079 * @vht_capa: VHT Capability overrides
2080 * @vht_capa_mask: The bits of vht_capa which are to be used.
2081 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2083 * @bss_select: criteria to be used for BSS selection.
2084 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2085 * to indicate a request to reassociate within the ESS instead of a request
2086 * do the initial association with the ESS. When included, this is set to
2087 * the BSSID of the current association, i.e., to the value that is
2088 * included in the Current AP address field of the Reassociation Request
2090 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2091 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2093 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2094 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2095 * %NULL if not specified. This specifies the domain name of ER server and
2096 * is used to construct FILS wrapped data IE.
2097 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2098 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2099 * messages. This is also used to construct FILS wrapped data IE.
2100 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2101 * keys in FILS or %NULL if not specified.
2102 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2104 struct cfg80211_connect_params
{
2105 struct ieee80211_channel
*channel
;
2106 struct ieee80211_channel
*channel_hint
;
2108 const u8
*bssid_hint
;
2111 enum nl80211_auth_type auth_type
;
2115 enum nl80211_mfp mfp
;
2116 struct cfg80211_crypto_settings crypto
;
2118 u8 key_len
, key_idx
;
2121 struct ieee80211_ht_cap ht_capa
;
2122 struct ieee80211_ht_cap ht_capa_mask
;
2123 struct ieee80211_vht_cap vht_capa
;
2124 struct ieee80211_vht_cap vht_capa_mask
;
2126 struct cfg80211_bss_selection bss_select
;
2127 const u8
*prev_bssid
;
2128 const u8
*fils_erp_username
;
2129 size_t fils_erp_username_len
;
2130 const u8
*fils_erp_realm
;
2131 size_t fils_erp_realm_len
;
2132 u16 fils_erp_next_seq_num
;
2133 const u8
*fils_erp_rrk
;
2134 size_t fils_erp_rrk_len
;
2138 * enum cfg80211_connect_params_changed - Connection parameters being updated
2140 * This enum provides information of all connect parameters that
2141 * have to be updated as part of update_connect_params() call.
2143 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2145 enum cfg80211_connect_params_changed
{
2146 UPDATE_ASSOC_IES
= BIT(0),
2150 * enum wiphy_params_flags - set_wiphy_params bitfield values
2151 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2152 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2153 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2154 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2155 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2156 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2158 enum wiphy_params_flags
{
2159 WIPHY_PARAM_RETRY_SHORT
= 1 << 0,
2160 WIPHY_PARAM_RETRY_LONG
= 1 << 1,
2161 WIPHY_PARAM_FRAG_THRESHOLD
= 1 << 2,
2162 WIPHY_PARAM_RTS_THRESHOLD
= 1 << 3,
2163 WIPHY_PARAM_COVERAGE_CLASS
= 1 << 4,
2164 WIPHY_PARAM_DYN_ACK
= 1 << 5,
2168 * struct cfg80211_pmksa - PMK Security Association
2170 * This structure is passed to the set/del_pmksa() method for PMKSA
2173 * @bssid: The AP's BSSID (may be %NULL).
2174 * @pmkid: The identifier to refer a PMKSA.
2175 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2176 * derivation by a FILS STA. Otherwise, %NULL.
2177 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2178 * the hash algorithm used to generate this.
2179 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2180 * cache identifier (may be %NULL).
2181 * @ssid_len: Length of the @ssid in octets.
2182 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2183 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2186 struct cfg80211_pmksa
{
2197 * struct cfg80211_pkt_pattern - packet pattern
2198 * @mask: bitmask where to match pattern and where to ignore bytes,
2199 * one bit per byte, in same format as nl80211
2200 * @pattern: bytes to match where bitmask is 1
2201 * @pattern_len: length of pattern (in bytes)
2202 * @pkt_offset: packet offset (in bytes)
2204 * Internal note: @mask and @pattern are allocated in one chunk of
2205 * memory, free @mask only!
2207 struct cfg80211_pkt_pattern
{
2208 const u8
*mask
, *pattern
;
2214 * struct cfg80211_wowlan_tcp - TCP connection parameters
2216 * @sock: (internal) socket for source port allocation
2217 * @src: source IP address
2218 * @dst: destination IP address
2219 * @dst_mac: destination MAC address
2220 * @src_port: source port
2221 * @dst_port: destination port
2222 * @payload_len: data payload length
2223 * @payload: data payload buffer
2224 * @payload_seq: payload sequence stamping configuration
2225 * @data_interval: interval at which to send data packets
2226 * @wake_len: wakeup payload match length
2227 * @wake_data: wakeup payload match data
2228 * @wake_mask: wakeup payload match mask
2229 * @tokens_size: length of the tokens buffer
2230 * @payload_tok: payload token usage configuration
2232 struct cfg80211_wowlan_tcp
{
2233 struct socket
*sock
;
2235 u16 src_port
, dst_port
;
2236 u8 dst_mac
[ETH_ALEN
];
2239 struct nl80211_wowlan_tcp_data_seq payload_seq
;
2242 const u8
*wake_data
, *wake_mask
;
2244 /* must be last, variable member */
2245 struct nl80211_wowlan_tcp_data_token payload_tok
;
2249 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2251 * This structure defines the enabled WoWLAN triggers for the device.
2252 * @any: wake up on any activity -- special trigger if device continues
2253 * operating as normal during suspend
2254 * @disconnect: wake up if getting disconnected
2255 * @magic_pkt: wake up on receiving magic packet
2256 * @patterns: wake up on receiving packet matching a pattern
2257 * @n_patterns: number of patterns
2258 * @gtk_rekey_failure: wake up on GTK rekey failure
2259 * @eap_identity_req: wake up on EAP identity request packet
2260 * @four_way_handshake: wake up on 4-way handshake
2261 * @rfkill_release: wake up when rfkill is released
2262 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2263 * NULL if not configured.
2264 * @nd_config: configuration for the scan to be used for net detect wake.
2266 struct cfg80211_wowlan
{
2267 bool any
, disconnect
, magic_pkt
, gtk_rekey_failure
,
2268 eap_identity_req
, four_way_handshake
,
2270 struct cfg80211_pkt_pattern
*patterns
;
2271 struct cfg80211_wowlan_tcp
*tcp
;
2273 struct cfg80211_sched_scan_request
*nd_config
;
2277 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2279 * This structure defines coalesce rule for the device.
2280 * @delay: maximum coalescing delay in msecs.
2281 * @condition: condition for packet coalescence.
2282 * see &enum nl80211_coalesce_condition.
2283 * @patterns: array of packet patterns
2284 * @n_patterns: number of patterns
2286 struct cfg80211_coalesce_rules
{
2288 enum nl80211_coalesce_condition condition
;
2289 struct cfg80211_pkt_pattern
*patterns
;
2294 * struct cfg80211_coalesce - Packet coalescing settings
2296 * This structure defines coalescing settings.
2297 * @rules: array of coalesce rules
2298 * @n_rules: number of rules
2300 struct cfg80211_coalesce
{
2301 struct cfg80211_coalesce_rules
*rules
;
2306 * struct cfg80211_wowlan_nd_match - information about the match
2308 * @ssid: SSID of the match that triggered the wake up
2309 * @n_channels: Number of channels where the match occurred. This
2310 * value may be zero if the driver can't report the channels.
2311 * @channels: center frequencies of the channels where a match
2314 struct cfg80211_wowlan_nd_match
{
2315 struct cfg80211_ssid ssid
;
2321 * struct cfg80211_wowlan_nd_info - net detect wake up information
2323 * @n_matches: Number of match information instances provided in
2324 * @matches. This value may be zero if the driver can't provide
2325 * match information.
2326 * @matches: Array of pointers to matches containing information about
2327 * the matches that triggered the wake up.
2329 struct cfg80211_wowlan_nd_info
{
2331 struct cfg80211_wowlan_nd_match
*matches
[];
2335 * struct cfg80211_wowlan_wakeup - wakeup report
2336 * @disconnect: woke up by getting disconnected
2337 * @magic_pkt: woke up by receiving magic packet
2338 * @gtk_rekey_failure: woke up by GTK rekey failure
2339 * @eap_identity_req: woke up by EAP identity request packet
2340 * @four_way_handshake: woke up by 4-way handshake
2341 * @rfkill_release: woke up by rfkill being released
2342 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2343 * @packet_present_len: copied wakeup packet data
2344 * @packet_len: original wakeup packet length
2345 * @packet: The packet causing the wakeup, if any.
2346 * @packet_80211: For pattern match, magic packet and other data
2347 * frame triggers an 802.3 frame should be reported, for
2348 * disconnect due to deauth 802.11 frame. This indicates which
2350 * @tcp_match: TCP wakeup packet received
2351 * @tcp_connlost: TCP connection lost or failed to establish
2352 * @tcp_nomoretokens: TCP data ran out of tokens
2353 * @net_detect: if not %NULL, woke up because of net detect
2355 struct cfg80211_wowlan_wakeup
{
2356 bool disconnect
, magic_pkt
, gtk_rekey_failure
,
2357 eap_identity_req
, four_way_handshake
,
2358 rfkill_release
, packet_80211
,
2359 tcp_match
, tcp_connlost
, tcp_nomoretokens
;
2361 u32 packet_present_len
, packet_len
;
2363 struct cfg80211_wowlan_nd_info
*net_detect
;
2367 * struct cfg80211_gtk_rekey_data - rekey data
2368 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2369 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2370 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2372 struct cfg80211_gtk_rekey_data
{
2373 const u8
*kek
, *kck
, *replay_ctr
;
2377 * struct cfg80211_update_ft_ies_params - FT IE Information
2379 * This structure provides information needed to update the fast transition IE
2381 * @md: The Mobility Domain ID, 2 Octet value
2382 * @ie: Fast Transition IEs
2383 * @ie_len: Length of ft_ie in octets
2385 struct cfg80211_update_ft_ies_params
{
2392 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2394 * This structure provides information needed to transmit a mgmt frame
2396 * @chan: channel to use
2397 * @offchan: indicates wether off channel operation is required
2398 * @wait: duration for ROC
2399 * @buf: buffer to transmit
2400 * @len: buffer length
2401 * @no_cck: don't use cck rates for this frame
2402 * @dont_wait_for_ack: tells the low level not to wait for an ack
2403 * @n_csa_offsets: length of csa_offsets array
2404 * @csa_offsets: array of all the csa offsets in the frame
2406 struct cfg80211_mgmt_tx_params
{
2407 struct ieee80211_channel
*chan
;
2413 bool dont_wait_for_ack
;
2415 const u16
*csa_offsets
;
2419 * struct cfg80211_dscp_exception - DSCP exception
2421 * @dscp: DSCP value that does not adhere to the user priority range definition
2422 * @up: user priority value to which the corresponding DSCP value belongs
2424 struct cfg80211_dscp_exception
{
2430 * struct cfg80211_dscp_range - DSCP range definition for user priority
2432 * @low: lowest DSCP value of this user priority range, inclusive
2433 * @high: highest DSCP value of this user priority range, inclusive
2435 struct cfg80211_dscp_range
{
2440 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2441 #define IEEE80211_QOS_MAP_MAX_EX 21
2442 #define IEEE80211_QOS_MAP_LEN_MIN 16
2443 #define IEEE80211_QOS_MAP_LEN_MAX \
2444 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2447 * struct cfg80211_qos_map - QoS Map Information
2449 * This struct defines the Interworking QoS map setting for DSCP values
2451 * @num_des: number of DSCP exceptions (0..21)
2452 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2453 * the user priority DSCP range definition
2454 * @up: DSCP range definition for a particular user priority
2456 struct cfg80211_qos_map
{
2458 struct cfg80211_dscp_exception dscp_exception
[IEEE80211_QOS_MAP_MAX_EX
];
2459 struct cfg80211_dscp_range up
[8];
2463 * struct cfg80211_nan_conf - NAN configuration
2465 * This struct defines NAN configuration parameters
2467 * @master_pref: master preference (1 - 255)
2468 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2469 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2470 * (i.e. BIT(NL80211_BAND_2GHZ)).
2472 struct cfg80211_nan_conf
{
2478 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2481 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2482 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2484 enum cfg80211_nan_conf_changes
{
2485 CFG80211_NAN_CONF_CHANGED_PREF
= BIT(0),
2486 CFG80211_NAN_CONF_CHANGED_BANDS
= BIT(1),
2490 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2492 * @filter: the content of the filter
2493 * @len: the length of the filter
2495 struct cfg80211_nan_func_filter
{
2501 * struct cfg80211_nan_func - a NAN function
2503 * @type: &enum nl80211_nan_function_type
2504 * @service_id: the service ID of the function
2505 * @publish_type: &nl80211_nan_publish_type
2506 * @close_range: if true, the range should be limited. Threshold is
2507 * implementation specific.
2508 * @publish_bcast: if true, the solicited publish should be broadcasted
2509 * @subscribe_active: if true, the subscribe is active
2510 * @followup_id: the instance ID for follow up
2511 * @followup_reqid: the requestor instance ID for follow up
2512 * @followup_dest: MAC address of the recipient of the follow up
2513 * @ttl: time to live counter in DW.
2514 * @serv_spec_info: Service Specific Info
2515 * @serv_spec_info_len: Service Specific Info length
2516 * @srf_include: if true, SRF is inclusive
2517 * @srf_bf: Bloom Filter
2518 * @srf_bf_len: Bloom Filter length
2519 * @srf_bf_idx: Bloom Filter index
2520 * @srf_macs: SRF MAC addresses
2521 * @srf_num_macs: number of MAC addresses in SRF
2522 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2523 * @tx_filters: filters that should be transmitted in the SDF.
2524 * @num_rx_filters: length of &rx_filters.
2525 * @num_tx_filters: length of &tx_filters.
2526 * @instance_id: driver allocated id of the function.
2527 * @cookie: unique NAN function identifier.
2529 struct cfg80211_nan_func
{
2530 enum nl80211_nan_function_type type
;
2531 u8 service_id
[NL80211_NAN_FUNC_SERVICE_ID_LEN
];
2535 bool subscribe_active
;
2538 struct mac_address followup_dest
;
2540 const u8
*serv_spec_info
;
2541 u8 serv_spec_info_len
;
2546 struct mac_address
*srf_macs
;
2548 struct cfg80211_nan_func_filter
*rx_filters
;
2549 struct cfg80211_nan_func_filter
*tx_filters
;
2557 * struct cfg80211_ops - backend description for wireless configuration
2559 * This struct is registered by fullmac card drivers and/or wireless stacks
2560 * in order to handle configuration requests on their interfaces.
2562 * All callbacks except where otherwise noted should return 0
2563 * on success or a negative error code.
2565 * All operations are currently invoked under rtnl for consistency with the
2566 * wireless extensions but this is subject to reevaluation as soon as this
2567 * code is used more widely and we have a first user without wext.
2569 * @suspend: wiphy device needs to be suspended. The variable @wow will
2570 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2571 * configured for the device.
2572 * @resume: wiphy device needs to be resumed
2573 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2574 * to call device_set_wakeup_enable() to enable/disable wakeup from
2577 * @add_virtual_intf: create a new virtual interface with the given name,
2578 * must set the struct wireless_dev's iftype. Beware: You must create
2579 * the new netdev in the wiphy's network namespace! Returns the struct
2580 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2581 * also set the address member in the wdev.
2583 * @del_virtual_intf: remove the virtual interface
2585 * @change_virtual_intf: change type/configuration of virtual interface,
2586 * keep the struct wireless_dev's iftype updated.
2588 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2589 * when adding a group key.
2591 * @get_key: get information about the key with the given parameters.
2592 * @mac_addr will be %NULL when requesting information for a group
2593 * key. All pointers given to the @callback function need not be valid
2594 * after it returns. This function should return an error if it is
2595 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2597 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2598 * and @key_index, return -ENOENT if the key doesn't exist.
2600 * @set_default_key: set the default key on an interface
2602 * @set_default_mgmt_key: set the default management frame key on an interface
2604 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2606 * @start_ap: Start acting in AP mode defined by the parameters.
2607 * @change_beacon: Change the beacon parameters for an access point mode
2608 * interface. This should reject the call when AP mode wasn't started.
2609 * @stop_ap: Stop being an AP, including stopping beaconing.
2611 * @add_station: Add a new station.
2612 * @del_station: Remove a station
2613 * @change_station: Modify a given station. Note that flags changes are not much
2614 * validated in cfg80211, in particular the auth/assoc/authorized flags
2615 * might come to the driver in invalid combinations -- make sure to check
2616 * them, also against the existing state! Drivers must call
2617 * cfg80211_check_station_change() to validate the information.
2618 * @get_station: get station information for the station identified by @mac
2619 * @dump_station: dump station callback -- resume dump at index @idx
2621 * @add_mpath: add a fixed mesh path
2622 * @del_mpath: delete a given mesh path
2623 * @change_mpath: change a given mesh path
2624 * @get_mpath: get a mesh path for the given parameters
2625 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2626 * @get_mpp: get a mesh proxy path for the given parameters
2627 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2628 * @join_mesh: join the mesh network with the specified parameters
2629 * (invoked with the wireless_dev mutex held)
2630 * @leave_mesh: leave the current mesh network
2631 * (invoked with the wireless_dev mutex held)
2633 * @get_mesh_config: Get the current mesh configuration
2635 * @update_mesh_config: Update mesh parameters on a running mesh.
2636 * The mask is a bitfield which tells us which parameters to
2637 * set, and which to leave alone.
2639 * @change_bss: Modify parameters for a given BSS.
2641 * @set_txq_params: Set TX queue parameters
2643 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2644 * as it doesn't implement join_mesh and needs to set the channel to
2645 * join the mesh instead.
2647 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2648 * interfaces are active this callback should reject the configuration.
2649 * If no interfaces are active or the device is down, the channel should
2650 * be stored for when a monitor interface becomes active.
2652 * @scan: Request to do a scan. If returning zero, the scan request is given
2653 * the driver, and will be valid until passed to cfg80211_scan_done().
2654 * For scan results, call cfg80211_inform_bss(); you can call this outside
2655 * the scan/scan_done bracket too.
2656 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2657 * indicate the status of the scan through cfg80211_scan_done().
2659 * @auth: Request to authenticate with the specified peer
2660 * (invoked with the wireless_dev mutex held)
2661 * @assoc: Request to (re)associate with the specified peer
2662 * (invoked with the wireless_dev mutex held)
2663 * @deauth: Request to deauthenticate from the specified peer
2664 * (invoked with the wireless_dev mutex held)
2665 * @disassoc: Request to disassociate from the specified peer
2666 * (invoked with the wireless_dev mutex held)
2668 * @connect: Connect to the ESS with the specified parameters. When connected,
2669 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2670 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2671 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2672 * from the AP or cfg80211_connect_timeout() if no frame with status code
2674 * The driver is allowed to roam to other BSSes within the ESS when the
2675 * other BSS matches the connect parameters. When such roaming is initiated
2676 * by the driver, the driver is expected to verify that the target matches
2677 * the configured security parameters and to use Reassociation Request
2678 * frame instead of Association Request frame.
2679 * The connect function can also be used to request the driver to perform a
2680 * specific roam when connected to an ESS. In that case, the prev_bssid
2681 * parameter is set to the BSSID of the currently associated BSS as an
2682 * indication of requesting reassociation.
2683 * In both the driver-initiated and new connect() call initiated roaming
2684 * cases, the result of roaming is indicated with a call to
2685 * cfg80211_roamed() or cfg80211_roamed_bss().
2686 * (invoked with the wireless_dev mutex held)
2687 * @update_connect_params: Update the connect parameters while connected to a
2688 * BSS. The updated parameters can be used by driver/firmware for
2689 * subsequent BSS selection (roaming) decisions and to form the
2690 * Authentication/(Re)Association Request frames. This call does not
2691 * request an immediate disassociation or reassociation with the current
2692 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
2693 * changed are defined in &enum cfg80211_connect_params_changed.
2694 * (invoked with the wireless_dev mutex held)
2695 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
2696 * connection is in progress. Once done, call cfg80211_disconnected() in
2697 * case connection was already established (invoked with the
2698 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
2700 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2701 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2703 * (invoked with the wireless_dev mutex held)
2704 * @leave_ibss: Leave the IBSS.
2705 * (invoked with the wireless_dev mutex held)
2707 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2710 * @set_wiphy_params: Notify that wiphy parameters have changed;
2711 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2712 * have changed. The actual parameter values are available in
2713 * struct wiphy. If returning an error, no value should be changed.
2715 * @set_tx_power: set the transmit power according to the parameters,
2716 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2717 * wdev may be %NULL if power was set for the wiphy, and will
2718 * always be %NULL unless the driver supports per-vif TX power
2719 * (as advertised by the nl80211 feature flag.)
2720 * @get_tx_power: store the current TX power into the dbm variable;
2721 * return 0 if successful
2723 * @set_wds_peer: set the WDS peer for a WDS interface
2725 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2726 * functions to adjust rfkill hw state
2728 * @dump_survey: get site survey information.
2730 * @remain_on_channel: Request the driver to remain awake on the specified
2731 * channel for the specified duration to complete an off-channel
2732 * operation (e.g., public action frame exchange). When the driver is
2733 * ready on the requested channel, it must indicate this with an event
2734 * notification by calling cfg80211_ready_on_channel().
2735 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2736 * This allows the operation to be terminated prior to timeout based on
2737 * the duration value.
2738 * @mgmt_tx: Transmit a management frame.
2739 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2740 * frame on another channel
2742 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2743 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2744 * used by the function, but 0 and 1 must not be touched. Additionally,
2745 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2746 * dump and return to userspace with an error, so be careful. If any data
2747 * was passed in from userspace then the data/len arguments will be present
2748 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2750 * @set_bitrate_mask: set the bitrate mask configuration
2752 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2753 * devices running firmwares capable of generating the (re) association
2754 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2755 * @del_pmksa: Delete a cached PMKID.
2756 * @flush_pmksa: Flush all cached PMKIDs.
2757 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2758 * allows the driver to adjust the dynamic ps timeout value.
2759 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2760 * After configuration, the driver should (soon) send an event indicating
2761 * the current level is above/below the configured threshold; this may
2762 * need some care when the configuration is changed (without first being
2764 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
2765 * connection quality monitor. An event is to be sent only when the
2766 * signal level is found to be outside the two values. The driver should
2767 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
2768 * If it is provided then there's no point providing @set_cqm_rssi_config.
2769 * @set_cqm_txe_config: Configure connection quality monitor TX error
2771 * @sched_scan_start: Tell the driver to start a scheduled scan.
2772 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2773 * call must stop the scheduled scan and be ready for starting a new one
2774 * before it returns, i.e. @sched_scan_start may be called immediately
2775 * after that again and should not fail in that case. The driver should
2776 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2777 * method returns 0.)
2779 * @mgmt_frame_register: Notify driver that a management frame type was
2780 * registered. The callback is allowed to sleep.
2782 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2783 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2784 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2785 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2787 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2789 * @tdls_mgmt: Transmit a TDLS management frame.
2790 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2792 * @probe_client: probe an associated client, must return a cookie that it
2793 * later passes to cfg80211_probe_status().
2795 * @set_noack_map: Set the NoAck Map for the TIDs.
2797 * @get_channel: Get the current operating channel for the virtual interface.
2798 * For monitor interfaces, it should return %NULL unless there's a single
2799 * current monitoring channel.
2801 * @start_p2p_device: Start the given P2P device.
2802 * @stop_p2p_device: Stop the given P2P device.
2804 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2805 * Parameters include ACL policy, an array of MAC address of stations
2806 * and the number of MAC addresses. If there is already a list in driver
2807 * this new list replaces the existing one. Driver has to clear its ACL
2808 * when number of MAC addresses entries is passed as 0. Drivers which
2809 * advertise the support for MAC based ACL have to implement this callback.
2811 * @start_radar_detection: Start radar detection in the driver.
2813 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2814 * driver. If the SME is in the driver/firmware, this information can be
2815 * used in building Authentication and Reassociation Request frames.
2817 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2818 * for a given duration (milliseconds). The protocol is provided so the
2819 * driver can take the most appropriate actions.
2820 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2821 * reliability. This operation can not fail.
2822 * @set_coalesce: Set coalesce parameters.
2824 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2825 * responsible for veryfing if the switch is possible. Since this is
2826 * inherently tricky driver may decide to disconnect an interface later
2827 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2828 * everything. It should do it's best to verify requests and reject them
2829 * as soon as possible.
2831 * @set_qos_map: Set QoS mapping information to the driver
2833 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2834 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2835 * changes during the lifetime of the BSS.
2837 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2838 * with the given parameters; action frame exchange has been handled by
2839 * userspace so this just has to modify the TX path to take the TS into
2841 * If the admitted time is 0 just validate the parameters to make sure
2842 * the session can be created at all; it is valid to just always return
2843 * success for that but that may result in inefficient behaviour (handshake
2844 * with the peer followed by immediate teardown when the addition is later
2846 * @del_tx_ts: remove an existing TX TS
2848 * @join_ocb: join the OCB network with the specified parameters
2849 * (invoked with the wireless_dev mutex held)
2850 * @leave_ocb: leave the current OCB network
2851 * (invoked with the wireless_dev mutex held)
2853 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2854 * is responsible for continually initiating channel-switching operations
2855 * and returning to the base channel for communication with the AP.
2856 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2857 * peers must be on the base channel when the call completes.
2858 * @start_nan: Start the NAN interface.
2859 * @stop_nan: Stop the NAN interface.
2860 * @add_nan_func: Add a NAN function. Returns negative value on failure.
2861 * On success @nan_func ownership is transferred to the driver and
2862 * it may access it outside of the scope of this function. The driver
2863 * should free the @nan_func when no longer needed by calling
2864 * cfg80211_free_nan_func().
2865 * On success the driver should assign an instance_id in the
2866 * provided @nan_func.
2867 * @del_nan_func: Delete a NAN function.
2868 * @nan_change_conf: changes NAN configuration. The changed parameters must
2869 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
2870 * All other parameters must be ignored.
2872 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
2874 struct cfg80211_ops
{
2875 int (*suspend
)(struct wiphy
*wiphy
, struct cfg80211_wowlan
*wow
);
2876 int (*resume
)(struct wiphy
*wiphy
);
2877 void (*set_wakeup
)(struct wiphy
*wiphy
, bool enabled
);
2879 struct wireless_dev
* (*add_virtual_intf
)(struct wiphy
*wiphy
,
2881 unsigned char name_assign_type
,
2882 enum nl80211_iftype type
,
2883 struct vif_params
*params
);
2884 int (*del_virtual_intf
)(struct wiphy
*wiphy
,
2885 struct wireless_dev
*wdev
);
2886 int (*change_virtual_intf
)(struct wiphy
*wiphy
,
2887 struct net_device
*dev
,
2888 enum nl80211_iftype type
,
2889 struct vif_params
*params
);
2891 int (*add_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2892 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
2893 struct key_params
*params
);
2894 int (*get_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2895 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
2897 void (*callback
)(void *cookie
, struct key_params
*));
2898 int (*del_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2899 u8 key_index
, bool pairwise
, const u8
*mac_addr
);
2900 int (*set_default_key
)(struct wiphy
*wiphy
,
2901 struct net_device
*netdev
,
2902 u8 key_index
, bool unicast
, bool multicast
);
2903 int (*set_default_mgmt_key
)(struct wiphy
*wiphy
,
2904 struct net_device
*netdev
,
2907 int (*start_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2908 struct cfg80211_ap_settings
*settings
);
2909 int (*change_beacon
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2910 struct cfg80211_beacon_data
*info
);
2911 int (*stop_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2914 int (*add_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2916 struct station_parameters
*params
);
2917 int (*del_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2918 struct station_del_parameters
*params
);
2919 int (*change_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2921 struct station_parameters
*params
);
2922 int (*get_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2923 const u8
*mac
, struct station_info
*sinfo
);
2924 int (*dump_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2925 int idx
, u8
*mac
, struct station_info
*sinfo
);
2927 int (*add_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2928 const u8
*dst
, const u8
*next_hop
);
2929 int (*del_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2931 int (*change_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2932 const u8
*dst
, const u8
*next_hop
);
2933 int (*get_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2934 u8
*dst
, u8
*next_hop
, struct mpath_info
*pinfo
);
2935 int (*dump_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2936 int idx
, u8
*dst
, u8
*next_hop
,
2937 struct mpath_info
*pinfo
);
2938 int (*get_mpp
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2939 u8
*dst
, u8
*mpp
, struct mpath_info
*pinfo
);
2940 int (*dump_mpp
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2941 int idx
, u8
*dst
, u8
*mpp
,
2942 struct mpath_info
*pinfo
);
2943 int (*get_mesh_config
)(struct wiphy
*wiphy
,
2944 struct net_device
*dev
,
2945 struct mesh_config
*conf
);
2946 int (*update_mesh_config
)(struct wiphy
*wiphy
,
2947 struct net_device
*dev
, u32 mask
,
2948 const struct mesh_config
*nconf
);
2949 int (*join_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2950 const struct mesh_config
*conf
,
2951 const struct mesh_setup
*setup
);
2952 int (*leave_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2954 int (*join_ocb
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2955 struct ocb_setup
*setup
);
2956 int (*leave_ocb
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2958 int (*change_bss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2959 struct bss_parameters
*params
);
2961 int (*set_txq_params
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2962 struct ieee80211_txq_params
*params
);
2964 int (*libertas_set_mesh_channel
)(struct wiphy
*wiphy
,
2965 struct net_device
*dev
,
2966 struct ieee80211_channel
*chan
);
2968 int (*set_monitor_channel
)(struct wiphy
*wiphy
,
2969 struct cfg80211_chan_def
*chandef
);
2971 int (*scan
)(struct wiphy
*wiphy
,
2972 struct cfg80211_scan_request
*request
);
2973 void (*abort_scan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
);
2975 int (*auth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2976 struct cfg80211_auth_request
*req
);
2977 int (*assoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2978 struct cfg80211_assoc_request
*req
);
2979 int (*deauth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2980 struct cfg80211_deauth_request
*req
);
2981 int (*disassoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2982 struct cfg80211_disassoc_request
*req
);
2984 int (*connect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2985 struct cfg80211_connect_params
*sme
);
2986 int (*update_connect_params
)(struct wiphy
*wiphy
,
2987 struct net_device
*dev
,
2988 struct cfg80211_connect_params
*sme
,
2990 int (*disconnect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2993 int (*join_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2994 struct cfg80211_ibss_params
*params
);
2995 int (*leave_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2997 int (*set_mcast_rate
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2998 int rate
[NUM_NL80211_BANDS
]);
3000 int (*set_wiphy_params
)(struct wiphy
*wiphy
, u32 changed
);
3002 int (*set_tx_power
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3003 enum nl80211_tx_power_setting type
, int mbm
);
3004 int (*get_tx_power
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3007 int (*set_wds_peer
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3010 void (*rfkill_poll
)(struct wiphy
*wiphy
);
3012 #ifdef CONFIG_NL80211_TESTMODE
3013 int (*testmode_cmd
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3014 void *data
, int len
);
3015 int (*testmode_dump
)(struct wiphy
*wiphy
, struct sk_buff
*skb
,
3016 struct netlink_callback
*cb
,
3017 void *data
, int len
);
3020 int (*set_bitrate_mask
)(struct wiphy
*wiphy
,
3021 struct net_device
*dev
,
3023 const struct cfg80211_bitrate_mask
*mask
);
3025 int (*dump_survey
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3026 int idx
, struct survey_info
*info
);
3028 int (*set_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3029 struct cfg80211_pmksa
*pmksa
);
3030 int (*del_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
3031 struct cfg80211_pmksa
*pmksa
);
3032 int (*flush_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
);
3034 int (*remain_on_channel
)(struct wiphy
*wiphy
,
3035 struct wireless_dev
*wdev
,
3036 struct ieee80211_channel
*chan
,
3037 unsigned int duration
,
3039 int (*cancel_remain_on_channel
)(struct wiphy
*wiphy
,
3040 struct wireless_dev
*wdev
,
3043 int (*mgmt_tx
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3044 struct cfg80211_mgmt_tx_params
*params
,
3046 int (*mgmt_tx_cancel_wait
)(struct wiphy
*wiphy
,
3047 struct wireless_dev
*wdev
,
3050 int (*set_power_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3051 bool enabled
, int timeout
);
3053 int (*set_cqm_rssi_config
)(struct wiphy
*wiphy
,
3054 struct net_device
*dev
,
3055 s32 rssi_thold
, u32 rssi_hyst
);
3057 int (*set_cqm_rssi_range_config
)(struct wiphy
*wiphy
,
3058 struct net_device
*dev
,
3059 s32 rssi_low
, s32 rssi_high
);
3061 int (*set_cqm_txe_config
)(struct wiphy
*wiphy
,
3062 struct net_device
*dev
,
3063 u32 rate
, u32 pkts
, u32 intvl
);
3065 void (*mgmt_frame_register
)(struct wiphy
*wiphy
,
3066 struct wireless_dev
*wdev
,
3067 u16 frame_type
, bool reg
);
3069 int (*set_antenna
)(struct wiphy
*wiphy
, u32 tx_ant
, u32 rx_ant
);
3070 int (*get_antenna
)(struct wiphy
*wiphy
, u32
*tx_ant
, u32
*rx_ant
);
3072 int (*sched_scan_start
)(struct wiphy
*wiphy
,
3073 struct net_device
*dev
,
3074 struct cfg80211_sched_scan_request
*request
);
3075 int (*sched_scan_stop
)(struct wiphy
*wiphy
, struct net_device
*dev
);
3077 int (*set_rekey_data
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3078 struct cfg80211_gtk_rekey_data
*data
);
3080 int (*tdls_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3081 const u8
*peer
, u8 action_code
, u8 dialog_token
,
3082 u16 status_code
, u32 peer_capability
,
3083 bool initiator
, const u8
*buf
, size_t len
);
3084 int (*tdls_oper
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3085 const u8
*peer
, enum nl80211_tdls_operation oper
);
3087 int (*probe_client
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3088 const u8
*peer
, u64
*cookie
);
3090 int (*set_noack_map
)(struct wiphy
*wiphy
,
3091 struct net_device
*dev
,
3094 int (*get_channel
)(struct wiphy
*wiphy
,
3095 struct wireless_dev
*wdev
,
3096 struct cfg80211_chan_def
*chandef
);
3098 int (*start_p2p_device
)(struct wiphy
*wiphy
,
3099 struct wireless_dev
*wdev
);
3100 void (*stop_p2p_device
)(struct wiphy
*wiphy
,
3101 struct wireless_dev
*wdev
);
3103 int (*set_mac_acl
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3104 const struct cfg80211_acl_data
*params
);
3106 int (*start_radar_detection
)(struct wiphy
*wiphy
,
3107 struct net_device
*dev
,
3108 struct cfg80211_chan_def
*chandef
,
3110 int (*update_ft_ies
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3111 struct cfg80211_update_ft_ies_params
*ftie
);
3112 int (*crit_proto_start
)(struct wiphy
*wiphy
,
3113 struct wireless_dev
*wdev
,
3114 enum nl80211_crit_proto_id protocol
,
3116 void (*crit_proto_stop
)(struct wiphy
*wiphy
,
3117 struct wireless_dev
*wdev
);
3118 int (*set_coalesce
)(struct wiphy
*wiphy
,
3119 struct cfg80211_coalesce
*coalesce
);
3121 int (*channel_switch
)(struct wiphy
*wiphy
,
3122 struct net_device
*dev
,
3123 struct cfg80211_csa_settings
*params
);
3125 int (*set_qos_map
)(struct wiphy
*wiphy
,
3126 struct net_device
*dev
,
3127 struct cfg80211_qos_map
*qos_map
);
3129 int (*set_ap_chanwidth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3130 struct cfg80211_chan_def
*chandef
);
3132 int (*add_tx_ts
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3133 u8 tsid
, const u8
*peer
, u8 user_prio
,
3135 int (*del_tx_ts
)(struct wiphy
*wiphy
, struct net_device
*dev
,
3136 u8 tsid
, const u8
*peer
);
3138 int (*tdls_channel_switch
)(struct wiphy
*wiphy
,
3139 struct net_device
*dev
,
3140 const u8
*addr
, u8 oper_class
,
3141 struct cfg80211_chan_def
*chandef
);
3142 void (*tdls_cancel_channel_switch
)(struct wiphy
*wiphy
,
3143 struct net_device
*dev
,
3145 int (*start_nan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3146 struct cfg80211_nan_conf
*conf
);
3147 void (*stop_nan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
);
3148 int (*add_nan_func
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3149 struct cfg80211_nan_func
*nan_func
);
3150 void (*del_nan_func
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3152 int (*nan_change_conf
)(struct wiphy
*wiphy
,
3153 struct wireless_dev
*wdev
,
3154 struct cfg80211_nan_conf
*conf
,
3157 int (*set_multicast_to_unicast
)(struct wiphy
*wiphy
,
3158 struct net_device
*dev
,
3159 const bool enabled
);
3163 * wireless hardware and networking interfaces structures
3164 * and registration/helper functions
3168 * enum wiphy_flags - wiphy capability flags
3170 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3172 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3173 * by default -- this flag will be set depending on the kernel's default
3174 * on wiphy_new(), but can be changed by the driver if it has a good
3175 * reason to override the default
3176 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3177 * on a VLAN interface)
3178 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3179 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3180 * control port protocol ethertype. The device also honours the
3181 * control_port_no_encrypt flag.
3182 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3183 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3184 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3185 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
3186 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3188 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3189 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3190 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3191 * link setup/discovery operations internally. Setup, discovery and
3192 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3193 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3194 * used for asking the driver/firmware to perform a TDLS operation.
3195 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3196 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3197 * when there are virtual interfaces in AP mode by calling
3198 * cfg80211_report_obss_beacon().
3199 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3200 * responds to probe-requests in hardware.
3201 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3202 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3203 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3204 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3205 * beaconing mode (AP, IBSS, Mesh, ...).
3206 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3207 * before connection.
3213 WIPHY_FLAG_NETNS_OK
= BIT(3),
3214 WIPHY_FLAG_PS_ON_BY_DEFAULT
= BIT(4),
3215 WIPHY_FLAG_4ADDR_AP
= BIT(5),
3216 WIPHY_FLAG_4ADDR_STATION
= BIT(6),
3217 WIPHY_FLAG_CONTROL_PORT_PROTOCOL
= BIT(7),
3218 WIPHY_FLAG_IBSS_RSN
= BIT(8),
3219 WIPHY_FLAG_MESH_AUTH
= BIT(10),
3220 /* use hole at 11 */
3221 /* use hole at 12 */
3222 WIPHY_FLAG_SUPPORTS_FW_ROAM
= BIT(13),
3223 WIPHY_FLAG_AP_UAPSD
= BIT(14),
3224 WIPHY_FLAG_SUPPORTS_TDLS
= BIT(15),
3225 WIPHY_FLAG_TDLS_EXTERNAL_SETUP
= BIT(16),
3226 WIPHY_FLAG_HAVE_AP_SME
= BIT(17),
3227 WIPHY_FLAG_REPORTS_OBSS
= BIT(18),
3228 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD
= BIT(19),
3229 WIPHY_FLAG_OFFCHAN_TX
= BIT(20),
3230 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL
= BIT(21),
3231 WIPHY_FLAG_SUPPORTS_5_10_MHZ
= BIT(22),
3232 WIPHY_FLAG_HAS_CHANNEL_SWITCH
= BIT(23),
3233 WIPHY_FLAG_HAS_STATIC_WEP
= BIT(24),
3237 * struct ieee80211_iface_limit - limit on certain interface types
3238 * @max: maximum number of interfaces of these types
3239 * @types: interface types (bits)
3241 struct ieee80211_iface_limit
{
3247 * struct ieee80211_iface_combination - possible interface combination
3249 * With this structure the driver can describe which interface
3250 * combinations it supports concurrently.
3254 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3258 * struct ieee80211_iface_limit limits1[] = {
3259 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3260 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3262 * struct ieee80211_iface_combination combination1 = {
3263 * .limits = limits1,
3264 * .n_limits = ARRAY_SIZE(limits1),
3265 * .max_interfaces = 2,
3266 * .beacon_int_infra_match = true,
3270 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3274 * struct ieee80211_iface_limit limits2[] = {
3275 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3276 * BIT(NL80211_IFTYPE_P2P_GO), },
3278 * struct ieee80211_iface_combination combination2 = {
3279 * .limits = limits2,
3280 * .n_limits = ARRAY_SIZE(limits2),
3281 * .max_interfaces = 8,
3282 * .num_different_channels = 1,
3286 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3288 * This allows for an infrastructure connection and three P2P connections.
3292 * struct ieee80211_iface_limit limits3[] = {
3293 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3294 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3295 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
3297 * struct ieee80211_iface_combination combination3 = {
3298 * .limits = limits3,
3299 * .n_limits = ARRAY_SIZE(limits3),
3300 * .max_interfaces = 4,
3301 * .num_different_channels = 2,
3305 struct ieee80211_iface_combination
{
3308 * limits for the given interface types
3310 const struct ieee80211_iface_limit
*limits
;
3313 * @num_different_channels:
3314 * can use up to this many different channels
3316 u32 num_different_channels
;
3320 * maximum number of interfaces in total allowed in this group
3326 * number of limitations
3331 * @beacon_int_infra_match:
3332 * In this combination, the beacon intervals between infrastructure
3333 * and AP types must match. This is required only in special cases.
3335 bool beacon_int_infra_match
;
3338 * @radar_detect_widths:
3339 * bitmap of channel widths supported for radar detection
3341 u8 radar_detect_widths
;
3344 * @radar_detect_regions:
3345 * bitmap of regions supported for radar detection
3347 u8 radar_detect_regions
;
3350 * @beacon_int_min_gcd:
3351 * This interface combination supports different beacon intervals.
3354 * all beacon intervals for different interface must be same.
3356 * any beacon interval for the interface part of this combination AND
3357 * GCD of all beacon intervals from beaconing interfaces of this
3358 * combination must be greater or equal to this value.
3360 u32 beacon_int_min_gcd
;
3363 struct ieee80211_txrx_stypes
{
3368 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3369 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3370 * trigger that keeps the device operating as-is and
3371 * wakes up the host on any activity, for example a
3372 * received packet that passed filtering; note that the
3373 * packet should be preserved in that case
3374 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3376 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3377 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3378 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3379 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3380 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3381 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3382 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3384 enum wiphy_wowlan_support_flags
{
3385 WIPHY_WOWLAN_ANY
= BIT(0),
3386 WIPHY_WOWLAN_MAGIC_PKT
= BIT(1),
3387 WIPHY_WOWLAN_DISCONNECT
= BIT(2),
3388 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY
= BIT(3),
3389 WIPHY_WOWLAN_GTK_REKEY_FAILURE
= BIT(4),
3390 WIPHY_WOWLAN_EAP_IDENTITY_REQ
= BIT(5),
3391 WIPHY_WOWLAN_4WAY_HANDSHAKE
= BIT(6),
3392 WIPHY_WOWLAN_RFKILL_RELEASE
= BIT(7),
3393 WIPHY_WOWLAN_NET_DETECT
= BIT(8),
3396 struct wiphy_wowlan_tcp_support
{
3397 const struct nl80211_wowlan_tcp_data_token_feature
*tok
;
3398 u32 data_payload_max
;
3399 u32 data_interval_max
;
3400 u32 wake_payload_max
;
3405 * struct wiphy_wowlan_support - WoWLAN support data
3406 * @flags: see &enum wiphy_wowlan_support_flags
3407 * @n_patterns: number of supported wakeup patterns
3408 * (see nl80211.h for the pattern definition)
3409 * @pattern_max_len: maximum length of each pattern
3410 * @pattern_min_len: minimum length of each pattern
3411 * @max_pkt_offset: maximum Rx packet offset
3412 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3413 * similar, but not necessarily identical, to max_match_sets for
3415 * See &struct cfg80211_sched_scan_request.@match_sets for more
3417 * @tcp: TCP wakeup support information
3419 struct wiphy_wowlan_support
{
3422 int pattern_max_len
;
3423 int pattern_min_len
;
3425 int max_nd_match_sets
;
3426 const struct wiphy_wowlan_tcp_support
*tcp
;
3430 * struct wiphy_coalesce_support - coalesce support data
3431 * @n_rules: maximum number of coalesce rules
3432 * @max_delay: maximum supported coalescing delay in msecs
3433 * @n_patterns: number of supported patterns in a rule
3434 * (see nl80211.h for the pattern definition)
3435 * @pattern_max_len: maximum length of each pattern
3436 * @pattern_min_len: minimum length of each pattern
3437 * @max_pkt_offset: maximum Rx packet offset
3439 struct wiphy_coalesce_support
{
3443 int pattern_max_len
;
3444 int pattern_min_len
;
3449 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3450 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3451 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3452 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3453 * (must be combined with %_WDEV or %_NETDEV)
3455 enum wiphy_vendor_command_flags
{
3456 WIPHY_VENDOR_CMD_NEED_WDEV
= BIT(0),
3457 WIPHY_VENDOR_CMD_NEED_NETDEV
= BIT(1),
3458 WIPHY_VENDOR_CMD_NEED_RUNNING
= BIT(2),
3462 * struct wiphy_vendor_command - vendor command definition
3463 * @info: vendor command identifying information, as used in nl80211
3464 * @flags: flags, see &enum wiphy_vendor_command_flags
3465 * @doit: callback for the operation, note that wdev is %NULL if the
3466 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3467 * pointer may be %NULL if userspace provided no data at all
3468 * @dumpit: dump callback, for transferring bigger/multiple items. The
3469 * @storage points to cb->args[5], ie. is preserved over the multiple
3471 * It's recommended to not have the same sub command with both @doit and
3472 * @dumpit, so that userspace can assume certain ones are get and others
3473 * are used with dump requests.
3475 struct wiphy_vendor_command
{
3476 struct nl80211_vendor_cmd_info info
;
3478 int (*doit
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3479 const void *data
, int data_len
);
3480 int (*dumpit
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3481 struct sk_buff
*skb
, const void *data
, int data_len
,
3482 unsigned long *storage
);
3486 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3487 * @iftype: interface type
3488 * @extended_capabilities: extended capabilities supported by the driver,
3489 * additional capabilities might be supported by userspace; these are the
3490 * 802.11 extended capabilities ("Extended Capabilities element") and are
3491 * in the same format as in the information element. See IEEE Std
3492 * 802.11-2012 8.4.2.29 for the defined fields.
3493 * @extended_capabilities_mask: mask of the valid values
3494 * @extended_capabilities_len: length of the extended capabilities
3496 struct wiphy_iftype_ext_capab
{
3497 enum nl80211_iftype iftype
;
3498 const u8
*extended_capabilities
;
3499 const u8
*extended_capabilities_mask
;
3500 u8 extended_capabilities_len
;
3504 * struct wiphy - wireless hardware description
3505 * @reg_notifier: the driver's regulatory notification callback,
3506 * note that if your driver uses wiphy_apply_custom_regulatory()
3507 * the reg_notifier's request can be passed as NULL
3508 * @regd: the driver's regulatory domain, if one was requested via
3509 * the regulatory_hint() API. This can be used by the driver
3510 * on the reg_notifier() if it chooses to ignore future
3511 * regulatory domain changes caused by other drivers.
3512 * @signal_type: signal type reported in &struct cfg80211_bss.
3513 * @cipher_suites: supported cipher suites
3514 * @n_cipher_suites: number of supported cipher suites
3515 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3516 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3517 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3518 * -1 = fragmentation disabled, only odd values >= 256 used
3519 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3520 * @_net: the network namespace this wiphy currently lives in
3521 * @perm_addr: permanent MAC address of this device
3522 * @addr_mask: If the device supports multiple MAC addresses by masking,
3523 * set this to a mask with variable bits set to 1, e.g. if the last
3524 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3525 * variable bits shall be determined by the interfaces added, with
3526 * interfaces not matching the mask being rejected to be brought up.
3527 * @n_addresses: number of addresses in @addresses.
3528 * @addresses: If the device has more than one address, set this pointer
3529 * to a list of addresses (6 bytes each). The first one will be used
3530 * by default for perm_addr. In this case, the mask should be set to
3531 * all-zeroes. In this case it is assumed that the device can handle
3532 * the same number of arbitrary MAC addresses.
3533 * @registered: protects ->resume and ->suspend sysfs callbacks against
3534 * unregister hardware
3535 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3536 * automatically on wiphy renames
3537 * @dev: (virtual) struct device for this wiphy
3538 * @registered: helps synchronize suspend/resume with wiphy unregister
3539 * @wext: wireless extension handlers
3540 * @priv: driver private data (sized according to wiphy_new() parameter)
3541 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3542 * must be set by driver
3543 * @iface_combinations: Valid interface combinations array, should not
3544 * list single interface types.
3545 * @n_iface_combinations: number of entries in @iface_combinations array.
3546 * @software_iftypes: bitmask of software interface types, these are not
3547 * subject to any restrictions since they are purely managed in SW.
3548 * @flags: wiphy flags, see &enum wiphy_flags
3549 * @regulatory_flags: wiphy regulatory flags, see
3550 * &enum ieee80211_regulatory_flags
3551 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3552 * @ext_features: extended features advertised to nl80211, see
3553 * &enum nl80211_ext_feature_index.
3554 * @bss_priv_size: each BSS struct has private data allocated with it,
3555 * this variable determines its size
3556 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3558 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
3559 * the device can run concurrently.
3560 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3561 * for in any given scheduled scan
3562 * @max_match_sets: maximum number of match sets the device can handle
3563 * when performing a scheduled scan, 0 if filtering is not
3565 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3566 * add to probe request frames transmitted during a scan, must not
3567 * include fixed IEs like supported rates
3568 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3570 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3571 * of iterations) for scheduled scan supported by the device.
3572 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3573 * single scan plan supported by the device.
3574 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3575 * scan plan supported by the device.
3576 * @coverage_class: current coverage class
3577 * @fw_version: firmware version for ethtool reporting
3578 * @hw_version: hardware version for ethtool reporting
3579 * @max_num_pmkids: maximum number of PMKIDs supported by device
3580 * @privid: a pointer that drivers can use to identify if an arbitrary
3581 * wiphy is theirs, e.g. in global notifiers
3582 * @bands: information about bands/channels supported by this device
3584 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3585 * transmitted through nl80211, points to an array indexed by interface
3588 * @available_antennas_tx: bitmap of antennas which are available to be
3589 * configured as TX antennas. Antenna configuration commands will be
3590 * rejected unless this or @available_antennas_rx is set.
3592 * @available_antennas_rx: bitmap of antennas which are available to be
3593 * configured as RX antennas. Antenna configuration commands will be
3594 * rejected unless this or @available_antennas_tx is set.
3596 * @probe_resp_offload:
3597 * Bitmap of supported protocols for probe response offloading.
3598 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3599 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3601 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3602 * may request, if implemented.
3604 * @wowlan: WoWLAN support information
3605 * @wowlan_config: current WoWLAN configuration; this should usually not be
3606 * used since access to it is necessarily racy, use the parameter passed
3607 * to the suspend() operation instead.
3609 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3610 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3611 * If null, then none can be over-ridden.
3612 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3613 * If null, then none can be over-ridden.
3615 * @wdev_list: the list of associated (virtual) interfaces; this list must
3616 * not be modified by the driver, but can be read with RTNL/RCU protection.
3618 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3621 * @extended_capabilities: extended capabilities supported by the driver,
3622 * additional capabilities might be supported by userspace; these are
3623 * the 802.11 extended capabilities ("Extended Capabilities element")
3624 * and are in the same format as in the information element. See
3625 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3626 * extended capabilities to be used if the capabilities are not specified
3627 * for a specific interface type in iftype_ext_capab.
3628 * @extended_capabilities_mask: mask of the valid values
3629 * @extended_capabilities_len: length of the extended capabilities
3630 * @iftype_ext_capab: array of extended capabilities per interface type
3631 * @num_iftype_ext_capab: number of interface types for which extended
3632 * capabilities are specified separately.
3633 * @coalesce: packet coalescing support information
3635 * @vendor_commands: array of vendor commands supported by the hardware
3636 * @n_vendor_commands: number of vendor commands
3637 * @vendor_events: array of vendor events supported by the hardware
3638 * @n_vendor_events: number of vendor events
3640 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3641 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3642 * driver is allowed to advertise a theoretical limit that it can reach in
3643 * some cases, but may not always reach.
3645 * @max_num_csa_counters: Number of supported csa_counters in beacons
3646 * and probe responses. This value should be set if the driver
3647 * wishes to limit the number of csa counters. Default (0) means
3649 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3650 * frame was sent and the channel on which the frame was heard for which
3651 * the reported rssi is still valid. If a driver is able to compensate the
3652 * low rssi when a frame is heard on different channel, then it should set
3653 * this variable to the maximal offset for which it can compensate.
3654 * This value should be set in MHz.
3655 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3656 * by the driver in the .connect() callback. The bit position maps to the
3657 * attribute indices defined in &enum nl80211_bss_select_attr.
3659 * @cookie_counter: unique generic cookie counter, used to identify objects.
3660 * @nan_supported_bands: bands supported by the device in NAN mode, a
3661 * bitmap of &enum nl80211_band values. For instance, for
3662 * NL80211_BAND_2GHZ, bit 0 would be set
3663 * (i.e. BIT(NL80211_BAND_2GHZ)).
3666 /* assign these fields before you register the wiphy */
3668 /* permanent MAC address(es) */
3669 u8 perm_addr
[ETH_ALEN
];
3670 u8 addr_mask
[ETH_ALEN
];
3672 struct mac_address
*addresses
;
3674 const struct ieee80211_txrx_stypes
*mgmt_stypes
;
3676 const struct ieee80211_iface_combination
*iface_combinations
;
3677 int n_iface_combinations
;
3678 u16 software_iftypes
;
3682 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3683 u16 interface_modes
;
3685 u16 max_acl_mac_addrs
;
3687 u32 flags
, regulatory_flags
, features
;
3688 u8 ext_features
[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES
, 8)];
3692 enum cfg80211_signal_type signal_type
;
3696 u8 max_sched_scan_reqs
;
3697 u8 max_sched_scan_ssids
;
3699 u16 max_scan_ie_len
;
3700 u16 max_sched_scan_ie_len
;
3701 u32 max_sched_scan_plans
;
3702 u32 max_sched_scan_plan_interval
;
3703 u32 max_sched_scan_plan_iterations
;
3705 int n_cipher_suites
;
3706 const u32
*cipher_suites
;
3714 char fw_version
[ETHTOOL_FWVERS_LEN
];
3718 const struct wiphy_wowlan_support
*wowlan
;
3719 struct cfg80211_wowlan
*wowlan_config
;
3722 u16 max_remain_on_channel_duration
;
3726 u32 available_antennas_tx
;
3727 u32 available_antennas_rx
;
3730 * Bitmap of supported protocols for probe response offloading
3731 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3732 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3734 u32 probe_resp_offload
;
3736 const u8
*extended_capabilities
, *extended_capabilities_mask
;
3737 u8 extended_capabilities_len
;
3739 const struct wiphy_iftype_ext_capab
*iftype_ext_capab
;
3740 unsigned int num_iftype_ext_capab
;
3742 /* If multiple wiphys are registered and you're handed e.g.
3743 * a regular netdev with assigned ieee80211_ptr, you won't
3744 * know whether it points to a wiphy your driver has registered
3745 * or not. Assign this to something global to your driver to
3746 * help determine whether you own this wiphy or not. */
3749 struct ieee80211_supported_band
*bands
[NUM_NL80211_BANDS
];
3751 /* Lets us get back the wiphy on the callback */
3752 void (*reg_notifier
)(struct wiphy
*wiphy
,
3753 struct regulatory_request
*request
);
3755 /* fields below are read-only, assigned by cfg80211 */
3757 const struct ieee80211_regdomain __rcu
*regd
;
3759 /* the item in /sys/class/ieee80211/ points to this,
3760 * you need use set_wiphy_dev() (see below) */
3763 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3766 /* dir in debugfs: ieee80211/<wiphyname> */
3767 struct dentry
*debugfsdir
;
3769 const struct ieee80211_ht_cap
*ht_capa_mod_mask
;
3770 const struct ieee80211_vht_cap
*vht_capa_mod_mask
;
3772 struct list_head wdev_list
;
3774 /* the network namespace this phy lives in currently */
3775 possible_net_t _net
;
3777 #ifdef CONFIG_CFG80211_WEXT
3778 const struct iw_handler_def
*wext
;
3781 const struct wiphy_coalesce_support
*coalesce
;
3783 const struct wiphy_vendor_command
*vendor_commands
;
3784 const struct nl80211_vendor_cmd_info
*vendor_events
;
3785 int n_vendor_commands
, n_vendor_events
;
3787 u16 max_ap_assoc_sta
;
3789 u8 max_num_csa_counters
;
3790 u8 max_adj_channel_rssi_comp
;
3792 u32 bss_select_support
;
3796 u8 nan_supported_bands
;
3798 char priv
[0] __aligned(NETDEV_ALIGN
);
3801 static inline struct net
*wiphy_net(struct wiphy
*wiphy
)
3803 return read_pnet(&wiphy
->_net
);
3806 static inline void wiphy_net_set(struct wiphy
*wiphy
, struct net
*net
)
3808 write_pnet(&wiphy
->_net
, net
);
3812 * wiphy_priv - return priv from wiphy
3814 * @wiphy: the wiphy whose priv pointer to return
3815 * Return: The priv of @wiphy.
3817 static inline void *wiphy_priv(struct wiphy
*wiphy
)
3820 return &wiphy
->priv
;
3824 * priv_to_wiphy - return the wiphy containing the priv
3826 * @priv: a pointer previously returned by wiphy_priv
3827 * Return: The wiphy of @priv.
3829 static inline struct wiphy
*priv_to_wiphy(void *priv
)
3832 return container_of(priv
, struct wiphy
, priv
);
3836 * set_wiphy_dev - set device pointer for wiphy
3838 * @wiphy: The wiphy whose device to bind
3839 * @dev: The device to parent it to
3841 static inline void set_wiphy_dev(struct wiphy
*wiphy
, struct device
*dev
)
3843 wiphy
->dev
.parent
= dev
;
3847 * wiphy_dev - get wiphy dev pointer
3849 * @wiphy: The wiphy whose device struct to look up
3850 * Return: The dev of @wiphy.
3852 static inline struct device
*wiphy_dev(struct wiphy
*wiphy
)
3854 return wiphy
->dev
.parent
;
3858 * wiphy_name - get wiphy name
3860 * @wiphy: The wiphy whose name to return
3861 * Return: The name of @wiphy.
3863 static inline const char *wiphy_name(const struct wiphy
*wiphy
)
3865 return dev_name(&wiphy
->dev
);
3869 * wiphy_new_nm - create a new wiphy for use with cfg80211
3871 * @ops: The configuration operations for this device
3872 * @sizeof_priv: The size of the private area to allocate
3873 * @requested_name: Request a particular name.
3874 * NULL is valid value, and means use the default phy%d naming.
3876 * Create a new wiphy and associate the given operations with it.
3877 * @sizeof_priv bytes are allocated for private use.
3879 * Return: A pointer to the new wiphy. This pointer must be
3880 * assigned to each netdev's ieee80211_ptr for proper operation.
3882 struct wiphy
*wiphy_new_nm(const struct cfg80211_ops
*ops
, int sizeof_priv
,
3883 const char *requested_name
);
3886 * wiphy_new - create a new wiphy for use with cfg80211
3888 * @ops: The configuration operations for this device
3889 * @sizeof_priv: The size of the private area to allocate
3891 * Create a new wiphy and associate the given operations with it.
3892 * @sizeof_priv bytes are allocated for private use.
3894 * Return: A pointer to the new wiphy. This pointer must be
3895 * assigned to each netdev's ieee80211_ptr for proper operation.
3897 static inline struct wiphy
*wiphy_new(const struct cfg80211_ops
*ops
,
3900 return wiphy_new_nm(ops
, sizeof_priv
, NULL
);
3904 * wiphy_register - register a wiphy with cfg80211
3906 * @wiphy: The wiphy to register.
3908 * Return: A non-negative wiphy index or a negative error code.
3910 int wiphy_register(struct wiphy
*wiphy
);
3913 * wiphy_unregister - deregister a wiphy from cfg80211
3915 * @wiphy: The wiphy to unregister.
3917 * After this call, no more requests can be made with this priv
3918 * pointer, but the call may sleep to wait for an outstanding
3919 * request that is being handled.
3921 void wiphy_unregister(struct wiphy
*wiphy
);
3924 * wiphy_free - free wiphy
3926 * @wiphy: The wiphy to free
3928 void wiphy_free(struct wiphy
*wiphy
);
3930 /* internal structs */
3931 struct cfg80211_conn
;
3932 struct cfg80211_internal_bss
;
3933 struct cfg80211_cached_keys
;
3934 struct cfg80211_cqm_config
;
3937 * struct wireless_dev - wireless device state
3939 * For netdevs, this structure must be allocated by the driver
3940 * that uses the ieee80211_ptr field in struct net_device (this
3941 * is intentional so it can be allocated along with the netdev.)
3942 * It need not be registered then as netdev registration will
3943 * be intercepted by cfg80211 to see the new wireless device.
3945 * For non-netdev uses, it must also be allocated by the driver
3946 * in response to the cfg80211 callbacks that require it, as
3947 * there's no netdev registration in that case it may not be
3948 * allocated outside of callback operations that return it.
3950 * @wiphy: pointer to hardware description
3951 * @iftype: interface type
3952 * @list: (private) Used to collect the interfaces
3953 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3954 * @identifier: (private) Identifier used in nl80211 to identify this
3955 * wireless device if it has no netdev
3956 * @current_bss: (private) Used by the internal configuration code
3957 * @chandef: (private) Used by the internal configuration code to track
3958 * the user-set channel definition.
3959 * @preset_chandef: (private) Used by the internal configuration code to
3960 * track the channel to be used for AP later
3961 * @bssid: (private) Used by the internal configuration code
3962 * @ssid: (private) Used by the internal configuration code
3963 * @ssid_len: (private) Used by the internal configuration code
3964 * @mesh_id_len: (private) Used by the internal configuration code
3965 * @mesh_id_up_len: (private) Used by the internal configuration code
3966 * @wext: (private) Used by the internal wireless extensions compat code
3967 * @use_4addr: indicates 4addr mode is used on this interface, must be
3968 * set by driver (if supported) on add_interface BEFORE registering the
3969 * netdev and may otherwise be used by driver read-only, will be update
3970 * by cfg80211 on change_interface
3971 * @mgmt_registrations: list of registrations for management frames
3972 * @mgmt_registrations_lock: lock for the list
3973 * @mtx: mutex used to lock data in this struct, may be used by drivers
3974 * and some API functions require it held
3975 * @beacon_interval: beacon interval used on this device for transmitting
3976 * beacons, 0 when not valid
3977 * @address: The address for this device, valid only if @netdev is %NULL
3978 * @is_running: true if this is a non-netdev device that has been started, e.g.
3980 * @cac_started: true if DFS channel availability check has been started
3981 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3982 * @cac_time_ms: CAC time in ms
3983 * @ps: powersave mode is enabled
3984 * @ps_timeout: dynamic powersave timeout
3985 * @ap_unexpected_nlportid: (private) netlink port ID of application
3986 * registered for unexpected class 3 frames (AP mode)
3987 * @conn: (private) cfg80211 software SME connection state machine data
3988 * @connect_keys: (private) keys to set after connection is established
3989 * @conn_bss_type: connecting/connected BSS type
3990 * @conn_owner_nlportid: (private) connection owner socket port ID
3991 * @disconnect_wk: (private) auto-disconnect work
3992 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
3993 * @ibss_fixed: (private) IBSS is using fixed BSSID
3994 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3995 * @event_list: (private) list for internal event processing
3996 * @event_lock: (private) lock for event list
3997 * @owner_nlportid: (private) owner socket port ID
3998 * @nl_owner_dead: (private) owner socket went away
3999 * @cqm_config: (private) nl80211 RSSI monitor state
4001 struct wireless_dev
{
4002 struct wiphy
*wiphy
;
4003 enum nl80211_iftype iftype
;
4005 /* the remainder of this struct should be private to cfg80211 */
4006 struct list_head list
;
4007 struct net_device
*netdev
;
4011 struct list_head mgmt_registrations
;
4012 spinlock_t mgmt_registrations_lock
;
4016 bool use_4addr
, is_running
;
4018 u8 address
[ETH_ALEN
] __aligned(sizeof(u16
));
4020 /* currently used for IBSS and SME - might be rearranged later */
4021 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
4022 u8 ssid_len
, mesh_id_len
, mesh_id_up_len
;
4023 struct cfg80211_conn
*conn
;
4024 struct cfg80211_cached_keys
*connect_keys
;
4025 enum ieee80211_bss_type conn_bss_type
;
4026 u32 conn_owner_nlportid
;
4028 struct work_struct disconnect_wk
;
4029 u8 disconnect_bssid
[ETH_ALEN
];
4031 struct list_head event_list
;
4032 spinlock_t event_lock
;
4034 struct cfg80211_internal_bss
*current_bss
; /* associated / joined */
4035 struct cfg80211_chan_def preset_chandef
;
4036 struct cfg80211_chan_def chandef
;
4039 bool ibss_dfs_possible
;
4044 int beacon_interval
;
4046 u32 ap_unexpected_nlportid
;
4052 unsigned long cac_start_time
;
4053 unsigned int cac_time_ms
;
4055 #ifdef CONFIG_CFG80211_WEXT
4058 struct cfg80211_ibss_params ibss
;
4059 struct cfg80211_connect_params connect
;
4060 struct cfg80211_cached_keys
*keys
;
4063 u8 bssid
[ETH_ALEN
], prev_bssid
[ETH_ALEN
];
4064 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
4065 s8 default_key
, default_mgmt_key
;
4066 bool prev_bssid_valid
;
4070 struct cfg80211_cqm_config
*cqm_config
;
4073 static inline u8
*wdev_address(struct wireless_dev
*wdev
)
4076 return wdev
->netdev
->dev_addr
;
4077 return wdev
->address
;
4080 static inline bool wdev_running(struct wireless_dev
*wdev
)
4083 return netif_running(wdev
->netdev
);
4084 return wdev
->is_running
;
4088 * wdev_priv - return wiphy priv from wireless_dev
4090 * @wdev: The wireless device whose wiphy's priv pointer to return
4091 * Return: The wiphy priv of @wdev.
4093 static inline void *wdev_priv(struct wireless_dev
*wdev
)
4096 return wiphy_priv(wdev
->wiphy
);
4100 * DOC: Utility functions
4102 * cfg80211 offers a number of utility functions that can be useful.
4106 * ieee80211_channel_to_frequency - convert channel number to frequency
4107 * @chan: channel number
4108 * @band: band, necessary due to channel number overlap
4109 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
4111 int ieee80211_channel_to_frequency(int chan
, enum nl80211_band band
);
4114 * ieee80211_frequency_to_channel - convert frequency to channel number
4115 * @freq: center frequency
4116 * Return: The corresponding channel, or 0 if the conversion failed.
4118 int ieee80211_frequency_to_channel(int freq
);
4121 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
4123 * @wiphy: the struct wiphy to get the channel for
4124 * @freq: the center frequency of the channel
4126 * Return: The channel struct from @wiphy at @freq.
4128 struct ieee80211_channel
*ieee80211_get_channel(struct wiphy
*wiphy
, int freq
);
4131 * ieee80211_get_response_rate - get basic rate for a given rate
4133 * @sband: the band to look for rates in
4134 * @basic_rates: bitmap of basic rates
4135 * @bitrate: the bitrate for which to find the basic rate
4137 * Return: The basic rate corresponding to a given bitrate, that
4138 * is the next lower bitrate contained in the basic rate map,
4139 * which is, for this function, given as a bitmap of indices of
4140 * rates in the band's bitrate table.
4142 struct ieee80211_rate
*
4143 ieee80211_get_response_rate(struct ieee80211_supported_band
*sband
,
4144 u32 basic_rates
, int bitrate
);
4147 * ieee80211_mandatory_rates - get mandatory rates for a given band
4148 * @sband: the band to look for rates in
4149 * @scan_width: width of the control channel
4151 * This function returns a bitmap of the mandatory rates for the given
4152 * band, bits are set according to the rate position in the bitrates array.
4154 u32
ieee80211_mandatory_rates(struct ieee80211_supported_band
*sband
,
4155 enum nl80211_bss_scan_width scan_width
);
4158 * Radiotap parsing functions -- for controlled injection support
4160 * Implemented in net/wireless/radiotap.c
4161 * Documentation in Documentation/networking/radiotap-headers.txt
4164 struct radiotap_align_size
{
4165 uint8_t align
:4, size
:4;
4168 struct ieee80211_radiotap_namespace
{
4169 const struct radiotap_align_size
*align_size
;
4175 struct ieee80211_radiotap_vendor_namespaces
{
4176 const struct ieee80211_radiotap_namespace
*ns
;
4181 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4182 * @this_arg_index: index of current arg, valid after each successful call
4183 * to ieee80211_radiotap_iterator_next()
4184 * @this_arg: pointer to current radiotap arg; it is valid after each
4185 * call to ieee80211_radiotap_iterator_next() but also after
4186 * ieee80211_radiotap_iterator_init() where it will point to
4187 * the beginning of the actual data portion
4188 * @this_arg_size: length of the current arg, for convenience
4189 * @current_namespace: pointer to the current namespace definition
4190 * (or internally %NULL if the current namespace is unknown)
4191 * @is_radiotap_ns: indicates whether the current namespace is the default
4192 * radiotap namespace or not
4194 * @_rtheader: pointer to the radiotap header we are walking through
4195 * @_max_length: length of radiotap header in cpu byte ordering
4196 * @_arg_index: next argument index
4197 * @_arg: next argument pointer
4198 * @_next_bitmap: internal pointer to next present u32
4199 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4200 * @_vns: vendor namespace definitions
4201 * @_next_ns_data: beginning of the next namespace's data
4202 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4205 * Describes the radiotap parser state. Fields prefixed with an underscore
4206 * must not be used by users of the parser, only by the parser internally.
4209 struct ieee80211_radiotap_iterator
{
4210 struct ieee80211_radiotap_header
*_rtheader
;
4211 const struct ieee80211_radiotap_vendor_namespaces
*_vns
;
4212 const struct ieee80211_radiotap_namespace
*current_namespace
;
4214 unsigned char *_arg
, *_next_ns_data
;
4215 __le32
*_next_bitmap
;
4217 unsigned char *this_arg
;
4225 uint32_t _bitmap_shifter
;
4230 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator
*iterator
,
4231 struct ieee80211_radiotap_header
*radiotap_header
,
4233 const struct ieee80211_radiotap_vendor_namespaces
*vns
);
4236 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator
*iterator
);
4239 extern const unsigned char rfc1042_header
[6];
4240 extern const unsigned char bridge_tunnel_header
[6];
4243 * ieee80211_get_hdrlen_from_skb - get header length from data
4247 * Given an skb with a raw 802.11 header at the data pointer this function
4248 * returns the 802.11 header length.
4250 * Return: The 802.11 header length in bytes (not including encryption
4251 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4254 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
4257 * ieee80211_hdrlen - get header length in bytes from frame control
4258 * @fc: frame control field in little-endian format
4259 * Return: The header length in bytes.
4261 unsigned int __attribute_const__
ieee80211_hdrlen(__le16 fc
);
4264 * ieee80211_get_mesh_hdrlen - get mesh extension header length
4265 * @meshhdr: the mesh extension header, only the flags field
4266 * (first byte) will be accessed
4267 * Return: The length of the extension header, which is always at
4268 * least 6 bytes and at most 18 if address 5 and 6 are present.
4270 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr
*meshhdr
);
4273 * DOC: Data path helpers
4275 * In addition to generic utilities, cfg80211 also offers
4276 * functions that help implement the data path for devices
4277 * that do not do the 802.11/802.3 conversion on the device.
4281 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4282 * @skb: the 802.11 data frame
4283 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4284 * of it being pushed into the SKB
4285 * @addr: the device MAC address
4286 * @iftype: the virtual interface type
4287 * Return: 0 on success. Non-zero on error.
4289 int ieee80211_data_to_8023_exthdr(struct sk_buff
*skb
, struct ethhdr
*ehdr
,
4290 const u8
*addr
, enum nl80211_iftype iftype
);
4293 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4294 * @skb: the 802.11 data frame
4295 * @addr: the device MAC address
4296 * @iftype: the virtual interface type
4297 * Return: 0 on success. Non-zero on error.
4299 static inline int ieee80211_data_to_8023(struct sk_buff
*skb
, const u8
*addr
,
4300 enum nl80211_iftype iftype
)
4302 return ieee80211_data_to_8023_exthdr(skb
, NULL
, addr
, iftype
);
4306 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
4307 * @skb: the 802.3 frame
4308 * @addr: the device MAC address
4309 * @iftype: the virtual interface type
4310 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
4311 * @qos: build 802.11 QoS data frame
4312 * Return: 0 on success, or a negative error code.
4314 int ieee80211_data_from_8023(struct sk_buff
*skb
, const u8
*addr
,
4315 enum nl80211_iftype iftype
, const u8
*bssid
,
4319 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
4321 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
4322 * The @list will be empty if the decode fails. The @skb must be fully
4323 * header-less before being passed in here; it is freed in this function.
4325 * @skb: The input A-MSDU frame without any headers.
4326 * @list: The output list of 802.3 frames. It must be allocated and
4327 * initialized by by the caller.
4328 * @addr: The device MAC address.
4329 * @iftype: The device interface type.
4330 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
4331 * @check_da: DA to check in the inner ethernet header, or NULL
4332 * @check_sa: SA to check in the inner ethernet header, or NULL
4334 void ieee80211_amsdu_to_8023s(struct sk_buff
*skb
, struct sk_buff_head
*list
,
4335 const u8
*addr
, enum nl80211_iftype iftype
,
4336 const unsigned int extra_headroom
,
4337 const u8
*check_da
, const u8
*check_sa
);
4340 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
4341 * @skb: the data frame
4342 * @qos_map: Interworking QoS mapping or %NULL if not in use
4343 * Return: The 802.1p/1d tag.
4345 unsigned int cfg80211_classify8021d(struct sk_buff
*skb
,
4346 struct cfg80211_qos_map
*qos_map
);
4349 * cfg80211_find_ie_match - match information element and byte array in data
4352 * @ies: data consisting of IEs
4353 * @len: length of data
4354 * @match: byte array to match
4355 * @match_len: number of bytes in the match array
4356 * @match_offset: offset in the IE where the byte array should match.
4357 * If match_len is zero, this must also be set to zero.
4358 * Otherwise this must be set to 2 or more, because the first
4359 * byte is the element id, which is already compared to eid, and
4360 * the second byte is the IE length.
4362 * Return: %NULL if the element ID could not be found or if
4363 * the element is invalid (claims to be longer than the given
4364 * data) or if the byte array doesn't match, or a pointer to the first
4365 * byte of the requested element, that is the byte containing the
4368 * Note: There are no checks on the element length other than
4369 * having to fit into the given data and being large enough for the
4370 * byte array to match.
4372 const u8
*cfg80211_find_ie_match(u8 eid
, const u8
*ies
, int len
,
4373 const u8
*match
, int match_len
,
4377 * cfg80211_find_ie - find information element in data
4380 * @ies: data consisting of IEs
4381 * @len: length of data
4383 * Return: %NULL if the element ID could not be found or if
4384 * the element is invalid (claims to be longer than the given
4385 * data), or a pointer to the first byte of the requested
4386 * element, that is the byte containing the element ID.
4388 * Note: There are no checks on the element length other than
4389 * having to fit into the given data.
4391 static inline const u8
*cfg80211_find_ie(u8 eid
, const u8
*ies
, int len
)
4393 return cfg80211_find_ie_match(eid
, ies
, len
, NULL
, 0, 0);
4397 * cfg80211_find_ext_ie - find information element with EID Extension in data
4399 * @ext_eid: element ID Extension
4400 * @ies: data consisting of IEs
4401 * @len: length of data
4403 * Return: %NULL if the extended element ID could not be found or if
4404 * the element is invalid (claims to be longer than the given
4405 * data), or a pointer to the first byte of the requested
4406 * element, that is the byte containing the element ID.
4408 * Note: There are no checks on the element length other than
4409 * having to fit into the given data.
4411 static inline const u8
*cfg80211_find_ext_ie(u8 ext_eid
, const u8
*ies
, int len
)
4413 return cfg80211_find_ie_match(WLAN_EID_EXTENSION
, ies
, len
,
4418 * cfg80211_find_vendor_ie - find vendor specific information element in data
4421 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
4422 * @ies: data consisting of IEs
4423 * @len: length of data
4425 * Return: %NULL if the vendor specific element ID could not be found or if the
4426 * element is invalid (claims to be longer than the given data), or a pointer to
4427 * the first byte of the requested element, that is the byte containing the
4430 * Note: There are no checks on the element length other than having to fit into
4433 const u8
*cfg80211_find_vendor_ie(unsigned int oui
, int oui_type
,
4434 const u8
*ies
, int len
);
4437 * DOC: Regulatory enforcement infrastructure
4443 * regulatory_hint - driver hint to the wireless core a regulatory domain
4444 * @wiphy: the wireless device giving the hint (used only for reporting
4446 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4447 * should be in. If @rd is set this should be NULL. Note that if you
4448 * set this to NULL you should still set rd->alpha2 to some accepted
4451 * Wireless drivers can use this function to hint to the wireless core
4452 * what it believes should be the current regulatory domain by
4453 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4454 * domain should be in or by providing a completely build regulatory domain.
4455 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4456 * for a regulatory domain structure for the respective country.
4458 * The wiphy must have been registered to cfg80211 prior to this call.
4459 * For cfg80211 drivers this means you must first use wiphy_register(),
4460 * for mac80211 drivers you must first use ieee80211_register_hw().
4462 * Drivers should check the return value, its possible you can get
4465 * Return: 0 on success. -ENOMEM.
4467 int regulatory_hint(struct wiphy
*wiphy
, const char *alpha2
);
4470 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4471 * @wiphy: the wireless device we want to process the regulatory domain on
4472 * @rd: the regulatory domain informatoin to use for this wiphy
4474 * Set the regulatory domain information for self-managed wiphys, only they
4475 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4478 * Return: 0 on success. -EINVAL, -EPERM
4480 int regulatory_set_wiphy_regd(struct wiphy
*wiphy
,
4481 struct ieee80211_regdomain
*rd
);
4484 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4485 * @wiphy: the wireless device we want to process the regulatory domain on
4486 * @rd: the regulatory domain information to use for this wiphy
4488 * This functions requires the RTNL to be held and applies the new regdomain
4489 * synchronously to this wiphy. For more details see
4490 * regulatory_set_wiphy_regd().
4492 * Return: 0 on success. -EINVAL, -EPERM
4494 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy
*wiphy
,
4495 struct ieee80211_regdomain
*rd
);
4498 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4499 * @wiphy: the wireless device we want to process the regulatory domain on
4500 * @regd: the custom regulatory domain to use for this wiphy
4502 * Drivers can sometimes have custom regulatory domains which do not apply
4503 * to a specific country. Drivers can use this to apply such custom regulatory
4504 * domains. This routine must be called prior to wiphy registration. The
4505 * custom regulatory domain will be trusted completely and as such previous
4506 * default channel settings will be disregarded. If no rule is found for a
4507 * channel on the regulatory domain the channel will be disabled.
4508 * Drivers using this for a wiphy should also set the wiphy flag
4509 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4510 * that called this helper.
4512 void wiphy_apply_custom_regulatory(struct wiphy
*wiphy
,
4513 const struct ieee80211_regdomain
*regd
);
4516 * freq_reg_info - get regulatory information for the given frequency
4517 * @wiphy: the wiphy for which we want to process this rule for
4518 * @center_freq: Frequency in KHz for which we want regulatory information for
4520 * Use this function to get the regulatory rule for a specific frequency on
4521 * a given wireless device. If the device has a specific regulatory domain
4522 * it wants to follow we respect that unless a country IE has been received
4523 * and processed already.
4525 * Return: A valid pointer, or, when an error occurs, for example if no rule
4526 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4527 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4528 * value will be -ERANGE if we determine the given center_freq does not even
4529 * have a regulatory rule for a frequency range in the center_freq's band.
4530 * See freq_in_rule_band() for our current definition of a band -- this is
4531 * purely subjective and right now it's 802.11 specific.
4533 const struct ieee80211_reg_rule
*freq_reg_info(struct wiphy
*wiphy
,
4537 * reg_initiator_name - map regulatory request initiator enum to name
4538 * @initiator: the regulatory request initiator
4540 * You can use this to map the regulatory request initiator enum to a
4541 * proper string representation.
4543 const char *reg_initiator_name(enum nl80211_reg_initiator initiator
);
4546 * callbacks for asynchronous cfg80211 methods, notification
4547 * functions and BSS handling helpers
4551 * cfg80211_scan_done - notify that scan finished
4553 * @request: the corresponding scan request
4554 * @info: information about the completed scan
4556 void cfg80211_scan_done(struct cfg80211_scan_request
*request
,
4557 struct cfg80211_scan_info
*info
);
4560 * cfg80211_sched_scan_results - notify that new scan results are available
4562 * @wiphy: the wiphy which got scheduled scan results
4564 void cfg80211_sched_scan_results(struct wiphy
*wiphy
);
4567 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4569 * @wiphy: the wiphy on which the scheduled scan stopped
4571 * The driver can call this function to inform cfg80211 that the
4572 * scheduled scan had to be stopped, for whatever reason. The driver
4573 * is then called back via the sched_scan_stop operation when done.
4575 void cfg80211_sched_scan_stopped(struct wiphy
*wiphy
);
4578 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4580 * @wiphy: the wiphy on which the scheduled scan stopped
4582 * The driver can call this function to inform cfg80211 that the
4583 * scheduled scan had to be stopped, for whatever reason. The driver
4584 * is then called back via the sched_scan_stop operation when done.
4585 * This function should be called with rtnl locked.
4587 void cfg80211_sched_scan_stopped_rtnl(struct wiphy
*wiphy
);
4590 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4591 * @wiphy: the wiphy reporting the BSS
4592 * @data: the BSS metadata
4593 * @mgmt: the management frame (probe response or beacon)
4594 * @len: length of the management frame
4595 * @gfp: context flags
4597 * This informs cfg80211 that BSS information was found and
4598 * the BSS should be updated/added.
4600 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4601 * Or %NULL on error.
4603 struct cfg80211_bss
* __must_check
4604 cfg80211_inform_bss_frame_data(struct wiphy
*wiphy
,
4605 struct cfg80211_inform_bss
*data
,
4606 struct ieee80211_mgmt
*mgmt
, size_t len
,
4609 static inline struct cfg80211_bss
* __must_check
4610 cfg80211_inform_bss_width_frame(struct wiphy
*wiphy
,
4611 struct ieee80211_channel
*rx_channel
,
4612 enum nl80211_bss_scan_width scan_width
,
4613 struct ieee80211_mgmt
*mgmt
, size_t len
,
4614 s32 signal
, gfp_t gfp
)
4616 struct cfg80211_inform_bss data
= {
4618 .scan_width
= scan_width
,
4622 return cfg80211_inform_bss_frame_data(wiphy
, &data
, mgmt
, len
, gfp
);
4625 static inline struct cfg80211_bss
* __must_check
4626 cfg80211_inform_bss_frame(struct wiphy
*wiphy
,
4627 struct ieee80211_channel
*rx_channel
,
4628 struct ieee80211_mgmt
*mgmt
, size_t len
,
4629 s32 signal
, gfp_t gfp
)
4631 struct cfg80211_inform_bss data
= {
4633 .scan_width
= NL80211_BSS_CHAN_WIDTH_20
,
4637 return cfg80211_inform_bss_frame_data(wiphy
, &data
, mgmt
, len
, gfp
);
4641 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4642 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4643 * from a beacon or probe response
4644 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4645 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4647 enum cfg80211_bss_frame_type
{
4648 CFG80211_BSS_FTYPE_UNKNOWN
,
4649 CFG80211_BSS_FTYPE_BEACON
,
4650 CFG80211_BSS_FTYPE_PRESP
,
4654 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4656 * @wiphy: the wiphy reporting the BSS
4657 * @data: the BSS metadata
4658 * @ftype: frame type (if known)
4659 * @bssid: the BSSID of the BSS
4660 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4661 * @capability: the capability field sent by the peer
4662 * @beacon_interval: the beacon interval announced by the peer
4663 * @ie: additional IEs sent by the peer
4664 * @ielen: length of the additional IEs
4665 * @gfp: context flags
4667 * This informs cfg80211 that BSS information was found and
4668 * the BSS should be updated/added.
4670 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4671 * Or %NULL on error.
4673 struct cfg80211_bss
* __must_check
4674 cfg80211_inform_bss_data(struct wiphy
*wiphy
,
4675 struct cfg80211_inform_bss
*data
,
4676 enum cfg80211_bss_frame_type ftype
,
4677 const u8
*bssid
, u64 tsf
, u16 capability
,
4678 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
4681 static inline struct cfg80211_bss
* __must_check
4682 cfg80211_inform_bss_width(struct wiphy
*wiphy
,
4683 struct ieee80211_channel
*rx_channel
,
4684 enum nl80211_bss_scan_width scan_width
,
4685 enum cfg80211_bss_frame_type ftype
,
4686 const u8
*bssid
, u64 tsf
, u16 capability
,
4687 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
4688 s32 signal
, gfp_t gfp
)
4690 struct cfg80211_inform_bss data
= {
4692 .scan_width
= scan_width
,
4696 return cfg80211_inform_bss_data(wiphy
, &data
, ftype
, bssid
, tsf
,
4697 capability
, beacon_interval
, ie
, ielen
,
4701 static inline struct cfg80211_bss
* __must_check
4702 cfg80211_inform_bss(struct wiphy
*wiphy
,
4703 struct ieee80211_channel
*rx_channel
,
4704 enum cfg80211_bss_frame_type ftype
,
4705 const u8
*bssid
, u64 tsf
, u16 capability
,
4706 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
4707 s32 signal
, gfp_t gfp
)
4709 struct cfg80211_inform_bss data
= {
4711 .scan_width
= NL80211_BSS_CHAN_WIDTH_20
,
4715 return cfg80211_inform_bss_data(wiphy
, &data
, ftype
, bssid
, tsf
,
4716 capability
, beacon_interval
, ie
, ielen
,
4721 * cfg80211_get_bss - get a BSS reference
4722 * @wiphy: the wiphy this BSS struct belongs to
4723 * @channel: the channel to search on (or %NULL)
4724 * @bssid: the desired BSSID (or %NULL)
4725 * @ssid: the desired SSID (or %NULL)
4726 * @ssid_len: length of the SSID (or 0)
4727 * @bss_type: type of BSS, see &enum ieee80211_bss_type
4728 * @privacy: privacy filter, see &enum ieee80211_privacy
4730 struct cfg80211_bss
*cfg80211_get_bss(struct wiphy
*wiphy
,
4731 struct ieee80211_channel
*channel
,
4733 const u8
*ssid
, size_t ssid_len
,
4734 enum ieee80211_bss_type bss_type
,
4735 enum ieee80211_privacy privacy
);
4736 static inline struct cfg80211_bss
*
4737 cfg80211_get_ibss(struct wiphy
*wiphy
,
4738 struct ieee80211_channel
*channel
,
4739 const u8
*ssid
, size_t ssid_len
)
4741 return cfg80211_get_bss(wiphy
, channel
, NULL
, ssid
, ssid_len
,
4742 IEEE80211_BSS_TYPE_IBSS
,
4743 IEEE80211_PRIVACY_ANY
);
4747 * cfg80211_ref_bss - reference BSS struct
4748 * @wiphy: the wiphy this BSS struct belongs to
4749 * @bss: the BSS struct to reference
4751 * Increments the refcount of the given BSS struct.
4753 void cfg80211_ref_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
4756 * cfg80211_put_bss - unref BSS struct
4757 * @wiphy: the wiphy this BSS struct belongs to
4758 * @bss: the BSS struct
4760 * Decrements the refcount of the given BSS struct.
4762 void cfg80211_put_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
4765 * cfg80211_unlink_bss - unlink BSS from internal data structures
4767 * @bss: the bss to remove
4769 * This function removes the given BSS from the internal data structures
4770 * thereby making it no longer show up in scan results etc. Use this
4771 * function when you detect a BSS is gone. Normally BSSes will also time
4772 * out, so it is not necessary to use this function at all.
4774 void cfg80211_unlink_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
4776 static inline enum nl80211_bss_scan_width
4777 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def
*chandef
)
4779 switch (chandef
->width
) {
4780 case NL80211_CHAN_WIDTH_5
:
4781 return NL80211_BSS_CHAN_WIDTH_5
;
4782 case NL80211_CHAN_WIDTH_10
:
4783 return NL80211_BSS_CHAN_WIDTH_10
;
4785 return NL80211_BSS_CHAN_WIDTH_20
;
4790 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4791 * @dev: network device
4792 * @buf: authentication frame (header + body)
4793 * @len: length of the frame data
4795 * This function is called whenever an authentication, disassociation or
4796 * deauthentication frame has been received and processed in station mode.
4797 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4798 * call either this function or cfg80211_auth_timeout().
4799 * After being asked to associate via cfg80211_ops::assoc() the driver must
4800 * call either this function or cfg80211_auth_timeout().
4801 * While connected, the driver must calls this for received and processed
4802 * disassociation and deauthentication frames. If the frame couldn't be used
4803 * because it was unprotected, the driver must call the function
4804 * cfg80211_rx_unprot_mlme_mgmt() instead.
4806 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4808 void cfg80211_rx_mlme_mgmt(struct net_device
*dev
, const u8
*buf
, size_t len
);
4811 * cfg80211_auth_timeout - notification of timed out authentication
4812 * @dev: network device
4813 * @addr: The MAC address of the device with which the authentication timed out
4815 * This function may sleep. The caller must hold the corresponding wdev's
4818 void cfg80211_auth_timeout(struct net_device
*dev
, const u8
*addr
);
4821 * cfg80211_rx_assoc_resp - notification of processed association response
4822 * @dev: network device
4823 * @bss: the BSS that association was requested with, ownership of the pointer
4824 * moves to cfg80211 in this call
4825 * @buf: authentication frame (header + body)
4826 * @len: length of the frame data
4827 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
4828 * as the AC bitmap in the QoS info field
4830 * After being asked to associate via cfg80211_ops::assoc() the driver must
4831 * call either this function or cfg80211_auth_timeout().
4833 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4835 void cfg80211_rx_assoc_resp(struct net_device
*dev
,
4836 struct cfg80211_bss
*bss
,
4837 const u8
*buf
, size_t len
,
4841 * cfg80211_assoc_timeout - notification of timed out association
4842 * @dev: network device
4843 * @bss: The BSS entry with which association timed out.
4845 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4847 void cfg80211_assoc_timeout(struct net_device
*dev
, struct cfg80211_bss
*bss
);
4850 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
4851 * @dev: network device
4852 * @bss: The BSS entry with which association was abandoned.
4854 * Call this whenever - for reasons reported through other API, like deauth RX,
4855 * an association attempt was abandoned.
4856 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4858 void cfg80211_abandon_assoc(struct net_device
*dev
, struct cfg80211_bss
*bss
);
4861 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4862 * @dev: network device
4863 * @buf: 802.11 frame (header + body)
4864 * @len: length of the frame data
4866 * This function is called whenever deauthentication has been processed in
4867 * station mode. This includes both received deauthentication frames and
4868 * locally generated ones. This function may sleep. The caller must hold the
4869 * corresponding wdev's mutex.
4871 void cfg80211_tx_mlme_mgmt(struct net_device
*dev
, const u8
*buf
, size_t len
);
4874 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4875 * @dev: network device
4876 * @buf: deauthentication frame (header + body)
4877 * @len: length of the frame data
4879 * This function is called whenever a received deauthentication or dissassoc
4880 * frame has been dropped in station mode because of MFP being used but the
4881 * frame was not protected. This function may sleep.
4883 void cfg80211_rx_unprot_mlme_mgmt(struct net_device
*dev
,
4884 const u8
*buf
, size_t len
);
4887 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4888 * @dev: network device
4889 * @addr: The source MAC address of the frame
4890 * @key_type: The key type that the received frame used
4891 * @key_id: Key identifier (0..3). Can be -1 if missing.
4892 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4893 * @gfp: allocation flags
4895 * This function is called whenever the local MAC detects a MIC failure in a
4896 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4899 void cfg80211_michael_mic_failure(struct net_device
*dev
, const u8
*addr
,
4900 enum nl80211_key_type key_type
, int key_id
,
4901 const u8
*tsc
, gfp_t gfp
);
4904 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4906 * @dev: network device
4907 * @bssid: the BSSID of the IBSS joined
4908 * @channel: the channel of the IBSS joined
4909 * @gfp: allocation flags
4911 * This function notifies cfg80211 that the device joined an IBSS or
4912 * switched to a different BSSID. Before this function can be called,
4913 * either a beacon has to have been received from the IBSS, or one of
4914 * the cfg80211_inform_bss{,_frame} functions must have been called
4915 * with the locally generated beacon -- this guarantees that there is
4916 * always a scan result for this IBSS. cfg80211 will handle the rest.
4918 void cfg80211_ibss_joined(struct net_device
*dev
, const u8
*bssid
,
4919 struct ieee80211_channel
*channel
, gfp_t gfp
);
4922 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4924 * @dev: network device
4925 * @macaddr: the MAC address of the new candidate
4926 * @ie: information elements advertised by the peer candidate
4927 * @ie_len: lenght of the information elements buffer
4928 * @gfp: allocation flags
4930 * This function notifies cfg80211 that the mesh peer candidate has been
4931 * detected, most likely via a beacon or, less likely, via a probe response.
4932 * cfg80211 then sends a notification to userspace.
4934 void cfg80211_notify_new_peer_candidate(struct net_device
*dev
,
4935 const u8
*macaddr
, const u8
*ie
, u8 ie_len
, gfp_t gfp
);
4938 * DOC: RFkill integration
4940 * RFkill integration in cfg80211 is almost invisible to drivers,
4941 * as cfg80211 automatically registers an rfkill instance for each
4942 * wireless device it knows about. Soft kill is also translated
4943 * into disconnecting and turning all interfaces off, drivers are
4944 * expected to turn off the device when all interfaces are down.
4946 * However, devices may have a hard RFkill line, in which case they
4947 * also need to interact with the rfkill subsystem, via cfg80211.
4948 * They can do this with a few helper functions documented here.
4952 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4954 * @blocked: block status
4956 void wiphy_rfkill_set_hw_state(struct wiphy
*wiphy
, bool blocked
);
4959 * wiphy_rfkill_start_polling - start polling rfkill
4962 void wiphy_rfkill_start_polling(struct wiphy
*wiphy
);
4965 * wiphy_rfkill_stop_polling - stop polling rfkill
4968 void wiphy_rfkill_stop_polling(struct wiphy
*wiphy
);
4971 * DOC: Vendor commands
4973 * Occasionally, there are special protocol or firmware features that
4974 * can't be implemented very openly. For this and similar cases, the
4975 * vendor command functionality allows implementing the features with
4976 * (typically closed-source) userspace and firmware, using nl80211 as
4977 * the configuration mechanism.
4979 * A driver supporting vendor commands must register them as an array
4980 * in struct wiphy, with handlers for each one, each command has an
4981 * OUI and sub command ID to identify it.
4983 * Note that this feature should not be (ab)used to implement protocol
4984 * features that could openly be shared across drivers. In particular,
4985 * it must never be required to use vendor commands to implement any
4986 * "normal" functionality that higher-level userspace like connection
4987 * managers etc. need.
4990 struct sk_buff
*__cfg80211_alloc_reply_skb(struct wiphy
*wiphy
,
4991 enum nl80211_commands cmd
,
4992 enum nl80211_attrs attr
,
4995 struct sk_buff
*__cfg80211_alloc_event_skb(struct wiphy
*wiphy
,
4996 struct wireless_dev
*wdev
,
4997 enum nl80211_commands cmd
,
4998 enum nl80211_attrs attr
,
4999 int vendor_event_idx
,
5000 int approxlen
, gfp_t gfp
);
5002 void __cfg80211_send_event_skb(struct sk_buff
*skb
, gfp_t gfp
);
5005 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
5007 * @approxlen: an upper bound of the length of the data that will
5008 * be put into the skb
5010 * This function allocates and pre-fills an skb for a reply to
5011 * a vendor command. Since it is intended for a reply, calling
5012 * it outside of a vendor command's doit() operation is invalid.
5014 * The returned skb is pre-filled with some identifying data in
5015 * a way that any data that is put into the skb (with skb_put(),
5016 * nla_put() or similar) will end up being within the
5017 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
5018 * with the skb is adding data for the corresponding userspace tool
5019 * which can then read that data out of the vendor data attribute.
5020 * You must not modify the skb in any other way.
5022 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
5023 * its error code as the result of the doit() operation.
5025 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5027 static inline struct sk_buff
*
5028 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy
*wiphy
, int approxlen
)
5030 return __cfg80211_alloc_reply_skb(wiphy
, NL80211_CMD_VENDOR
,
5031 NL80211_ATTR_VENDOR_DATA
, approxlen
);
5035 * cfg80211_vendor_cmd_reply - send the reply skb
5036 * @skb: The skb, must have been allocated with
5037 * cfg80211_vendor_cmd_alloc_reply_skb()
5039 * Since calling this function will usually be the last thing
5040 * before returning from the vendor command doit() you should
5041 * return the error code. Note that this function consumes the
5042 * skb regardless of the return value.
5044 * Return: An error code or 0 on success.
5046 int cfg80211_vendor_cmd_reply(struct sk_buff
*skb
);
5049 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
5051 * @wdev: the wireless device
5052 * @event_idx: index of the vendor event in the wiphy's vendor_events
5053 * @approxlen: an upper bound of the length of the data that will
5054 * be put into the skb
5055 * @gfp: allocation flags
5057 * This function allocates and pre-fills an skb for an event on the
5058 * vendor-specific multicast group.
5060 * If wdev != NULL, both the ifindex and identifier of the specified
5061 * wireless device are added to the event message before the vendor data
5064 * When done filling the skb, call cfg80211_vendor_event() with the
5065 * skb to send the event.
5067 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5069 static inline struct sk_buff
*
5070 cfg80211_vendor_event_alloc(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
5071 int approxlen
, int event_idx
, gfp_t gfp
)
5073 return __cfg80211_alloc_event_skb(wiphy
, wdev
, NL80211_CMD_VENDOR
,
5074 NL80211_ATTR_VENDOR_DATA
,
5075 event_idx
, approxlen
, gfp
);
5079 * cfg80211_vendor_event - send the event
5080 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
5081 * @gfp: allocation flags
5083 * This function sends the given @skb, which must have been allocated
5084 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
5086 static inline void cfg80211_vendor_event(struct sk_buff
*skb
, gfp_t gfp
)
5088 __cfg80211_send_event_skb(skb
, gfp
);
5091 #ifdef CONFIG_NL80211_TESTMODE
5095 * Test mode is a set of utility functions to allow drivers to
5096 * interact with driver-specific tools to aid, for instance,
5097 * factory programming.
5099 * This chapter describes how drivers interact with it, for more
5100 * information see the nl80211 book's chapter on it.
5104 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
5106 * @approxlen: an upper bound of the length of the data that will
5107 * be put into the skb
5109 * This function allocates and pre-fills an skb for a reply to
5110 * the testmode command. Since it is intended for a reply, calling
5111 * it outside of the @testmode_cmd operation is invalid.
5113 * The returned skb is pre-filled with the wiphy index and set up in
5114 * a way that any data that is put into the skb (with skb_put(),
5115 * nla_put() or similar) will end up being within the
5116 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
5117 * with the skb is adding data for the corresponding userspace tool
5118 * which can then read that data out of the testdata attribute. You
5119 * must not modify the skb in any other way.
5121 * When done, call cfg80211_testmode_reply() with the skb and return
5122 * its error code as the result of the @testmode_cmd operation.
5124 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5126 static inline struct sk_buff
*
5127 cfg80211_testmode_alloc_reply_skb(struct wiphy
*wiphy
, int approxlen
)
5129 return __cfg80211_alloc_reply_skb(wiphy
, NL80211_CMD_TESTMODE
,
5130 NL80211_ATTR_TESTDATA
, approxlen
);
5134 * cfg80211_testmode_reply - send the reply skb
5135 * @skb: The skb, must have been allocated with
5136 * cfg80211_testmode_alloc_reply_skb()
5138 * Since calling this function will usually be the last thing
5139 * before returning from the @testmode_cmd you should return
5140 * the error code. Note that this function consumes the skb
5141 * regardless of the return value.
5143 * Return: An error code or 0 on success.
5145 static inline int cfg80211_testmode_reply(struct sk_buff
*skb
)
5147 return cfg80211_vendor_cmd_reply(skb
);
5151 * cfg80211_testmode_alloc_event_skb - allocate testmode event
5153 * @approxlen: an upper bound of the length of the data that will
5154 * be put into the skb
5155 * @gfp: allocation flags
5157 * This function allocates and pre-fills an skb for an event on the
5158 * testmode multicast group.
5160 * The returned skb is set up in the same way as with
5161 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
5162 * there, you should simply add data to it that will then end up in the
5163 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
5166 * When done filling the skb, call cfg80211_testmode_event() with the
5167 * skb to send the event.
5169 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5171 static inline struct sk_buff
*
5172 cfg80211_testmode_alloc_event_skb(struct wiphy
*wiphy
, int approxlen
, gfp_t gfp
)
5174 return __cfg80211_alloc_event_skb(wiphy
, NULL
, NL80211_CMD_TESTMODE
,
5175 NL80211_ATTR_TESTDATA
, -1,
5180 * cfg80211_testmode_event - send the event
5181 * @skb: The skb, must have been allocated with
5182 * cfg80211_testmode_alloc_event_skb()
5183 * @gfp: allocation flags
5185 * This function sends the given @skb, which must have been allocated
5186 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
5189 static inline void cfg80211_testmode_event(struct sk_buff
*skb
, gfp_t gfp
)
5191 __cfg80211_send_event_skb(skb
, gfp
);
5194 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
5195 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
5197 #define CFG80211_TESTMODE_CMD(cmd)
5198 #define CFG80211_TESTMODE_DUMP(cmd)
5202 * struct cfg80211_connect_resp_params - Connection response params
5203 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
5204 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5205 * the real status code for failures. If this call is used to report a
5206 * failure due to a timeout (e.g., not receiving an Authentication frame
5207 * from the AP) instead of an explicit rejection by the AP, -1 is used to
5208 * indicate that this is a failure, but without a status code.
5209 * @timeout_reason is used to report the reason for the timeout in that
5211 * @bssid: The BSSID of the AP (may be %NULL)
5212 * @bss: Entry of bss to which STA got connected to, can be obtained through
5213 * cfg80211_get_bss() (may be %NULL). Only one parameter among @bssid and
5214 * @bss needs to be specified.
5215 * @req_ie: Association request IEs (may be %NULL)
5216 * @req_ie_len: Association request IEs length
5217 * @resp_ie: Association response IEs (may be %NULL)
5218 * @resp_ie_len: Association response IEs length
5219 * @fils_kek: KEK derived from a successful FILS connection (may be %NULL)
5220 * @fils_kek_len: Length of @fils_kek in octets
5221 * @update_erp_next_seq_num: Boolean value to specify whether the value in
5222 * @fils_erp_next_seq_num is valid.
5223 * @fils_erp_next_seq_num: The next sequence number to use in ERP message in
5224 * FILS Authentication. This value should be specified irrespective of the
5225 * status for a FILS connection.
5226 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
5227 * @pmk_len: Length of @pmk in octets
5228 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
5229 * used for this FILS connection (may be %NULL).
5230 * @timeout_reason: Reason for connection timeout. This is used when the
5231 * connection fails due to a timeout instead of an explicit rejection from
5232 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5233 * not known. This value is used only if @status < 0 to indicate that the
5234 * failure is due to a timeout and not due to explicit rejection by the AP.
5235 * This value is ignored in other cases (@status >= 0).
5237 struct cfg80211_connect_resp_params
{
5240 struct cfg80211_bss
*bss
;
5246 size_t fils_kek_len
;
5247 bool update_erp_next_seq_num
;
5248 u16 fils_erp_next_seq_num
;
5252 enum nl80211_timeout_reason timeout_reason
;
5256 * cfg80211_connect_done - notify cfg80211 of connection result
5258 * @dev: network device
5259 * @params: connection response parameters
5260 * @gfp: allocation flags
5262 * It should be called by the underlying driver once execution of the connection
5263 * request from connect() has been completed. This is similar to
5264 * cfg80211_connect_bss(), but takes a structure pointer for connection response
5265 * parameters. Only one of the functions among cfg80211_connect_bss(),
5266 * cfg80211_connect_result(), cfg80211_connect_timeout(),
5267 * and cfg80211_connect_done() should be called.
5269 void cfg80211_connect_done(struct net_device
*dev
,
5270 struct cfg80211_connect_resp_params
*params
,
5274 * cfg80211_connect_bss - notify cfg80211 of connection result
5276 * @dev: network device
5277 * @bssid: the BSSID of the AP
5278 * @bss: entry of bss to which STA got connected to, can be obtained
5279 * through cfg80211_get_bss (may be %NULL)
5280 * @req_ie: association request IEs (maybe be %NULL)
5281 * @req_ie_len: association request IEs length
5282 * @resp_ie: association response IEs (may be %NULL)
5283 * @resp_ie_len: assoc response IEs length
5284 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5285 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5286 * the real status code for failures. If this call is used to report a
5287 * failure due to a timeout (e.g., not receiving an Authentication frame
5288 * from the AP) instead of an explicit rejection by the AP, -1 is used to
5289 * indicate that this is a failure, but without a status code.
5290 * @timeout_reason is used to report the reason for the timeout in that
5292 * @gfp: allocation flags
5293 * @timeout_reason: reason for connection timeout. This is used when the
5294 * connection fails due to a timeout instead of an explicit rejection from
5295 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5296 * not known. This value is used only if @status < 0 to indicate that the
5297 * failure is due to a timeout and not due to explicit rejection by the AP.
5298 * This value is ignored in other cases (@status >= 0).
5300 * It should be called by the underlying driver once execution of the connection
5301 * request from connect() has been completed. This is similar to
5302 * cfg80211_connect_result(), but with the option of identifying the exact bss
5303 * entry for the connection. Only one of the functions among
5304 * cfg80211_connect_bss(), cfg80211_connect_result(),
5305 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5308 cfg80211_connect_bss(struct net_device
*dev
, const u8
*bssid
,
5309 struct cfg80211_bss
*bss
, const u8
*req_ie
,
5310 size_t req_ie_len
, const u8
*resp_ie
,
5311 size_t resp_ie_len
, int status
, gfp_t gfp
,
5312 enum nl80211_timeout_reason timeout_reason
)
5314 struct cfg80211_connect_resp_params params
;
5316 memset(¶ms
, 0, sizeof(params
));
5317 params
.status
= status
;
5318 params
.bssid
= bssid
;
5320 params
.req_ie
= req_ie
;
5321 params
.req_ie_len
= req_ie_len
;
5322 params
.resp_ie
= resp_ie
;
5323 params
.resp_ie_len
= resp_ie_len
;
5324 params
.timeout_reason
= timeout_reason
;
5326 cfg80211_connect_done(dev
, ¶ms
, gfp
);
5330 * cfg80211_connect_result - notify cfg80211 of connection result
5332 * @dev: network device
5333 * @bssid: the BSSID of the AP
5334 * @req_ie: association request IEs (maybe be %NULL)
5335 * @req_ie_len: association request IEs length
5336 * @resp_ie: association response IEs (may be %NULL)
5337 * @resp_ie_len: assoc response IEs length
5338 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5339 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5340 * the real status code for failures.
5341 * @gfp: allocation flags
5343 * It should be called by the underlying driver once execution of the connection
5344 * request from connect() has been completed. This is similar to
5345 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
5346 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
5347 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5350 cfg80211_connect_result(struct net_device
*dev
, const u8
*bssid
,
5351 const u8
*req_ie
, size_t req_ie_len
,
5352 const u8
*resp_ie
, size_t resp_ie_len
,
5353 u16 status
, gfp_t gfp
)
5355 cfg80211_connect_bss(dev
, bssid
, NULL
, req_ie
, req_ie_len
, resp_ie
,
5356 resp_ie_len
, status
, gfp
,
5357 NL80211_TIMEOUT_UNSPECIFIED
);
5361 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
5363 * @dev: network device
5364 * @bssid: the BSSID of the AP
5365 * @req_ie: association request IEs (maybe be %NULL)
5366 * @req_ie_len: association request IEs length
5367 * @gfp: allocation flags
5368 * @timeout_reason: reason for connection timeout.
5370 * It should be called by the underlying driver whenever connect() has failed
5371 * in a sequence where no explicit authentication/association rejection was
5372 * received from the AP. This could happen, e.g., due to not being able to send
5373 * out the Authentication or Association Request frame or timing out while
5374 * waiting for the response. Only one of the functions among
5375 * cfg80211_connect_bss(), cfg80211_connect_result(),
5376 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5379 cfg80211_connect_timeout(struct net_device
*dev
, const u8
*bssid
,
5380 const u8
*req_ie
, size_t req_ie_len
, gfp_t gfp
,
5381 enum nl80211_timeout_reason timeout_reason
)
5383 cfg80211_connect_bss(dev
, bssid
, NULL
, req_ie
, req_ie_len
, NULL
, 0, -1,
5384 gfp
, timeout_reason
);
5388 * cfg80211_roamed - notify cfg80211 of roaming
5390 * @dev: network device
5391 * @channel: the channel of the new AP
5392 * @bssid: the BSSID of the new AP
5393 * @req_ie: association request IEs (maybe be %NULL)
5394 * @req_ie_len: association request IEs length
5395 * @resp_ie: association response IEs (may be %NULL)
5396 * @resp_ie_len: assoc response IEs length
5397 * @gfp: allocation flags
5399 * It should be called by the underlying driver whenever it roamed
5400 * from one AP to another while connected.
5402 void cfg80211_roamed(struct net_device
*dev
,
5403 struct ieee80211_channel
*channel
,
5405 const u8
*req_ie
, size_t req_ie_len
,
5406 const u8
*resp_ie
, size_t resp_ie_len
, gfp_t gfp
);
5409 * cfg80211_roamed_bss - notify cfg80211 of roaming
5411 * @dev: network device
5412 * @bss: entry of bss to which STA got roamed
5413 * @req_ie: association request IEs (maybe be %NULL)
5414 * @req_ie_len: association request IEs length
5415 * @resp_ie: association response IEs (may be %NULL)
5416 * @resp_ie_len: assoc response IEs length
5417 * @gfp: allocation flags
5419 * This is just a wrapper to notify cfg80211 of roaming event with driver
5420 * passing bss to avoid a race in timeout of the bss entry. It should be
5421 * called by the underlying driver whenever it roamed from one AP to another
5422 * while connected. Drivers which have roaming implemented in firmware
5423 * may use this function to avoid a race in bss entry timeout where the bss
5424 * entry of the new AP is seen in the driver, but gets timed out by the time
5425 * it is accessed in __cfg80211_roamed() due to delay in scheduling
5426 * rdev->event_work. In case of any failures, the reference is released
5427 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
5428 * it will be released while diconneting from the current bss.
5430 void cfg80211_roamed_bss(struct net_device
*dev
, struct cfg80211_bss
*bss
,
5431 const u8
*req_ie
, size_t req_ie_len
,
5432 const u8
*resp_ie
, size_t resp_ie_len
, gfp_t gfp
);
5435 * cfg80211_disconnected - notify cfg80211 that connection was dropped
5437 * @dev: network device
5438 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
5439 * @ie_len: length of IEs
5440 * @reason: reason code for the disconnection, set it to 0 if unknown
5441 * @locally_generated: disconnection was requested locally
5442 * @gfp: allocation flags
5444 * After it calls this function, the driver should enter an idle state
5445 * and not try to connect to any AP any more.
5447 void cfg80211_disconnected(struct net_device
*dev
, u16 reason
,
5448 const u8
*ie
, size_t ie_len
,
5449 bool locally_generated
, gfp_t gfp
);
5452 * cfg80211_ready_on_channel - notification of remain_on_channel start
5453 * @wdev: wireless device
5454 * @cookie: the request cookie
5455 * @chan: The current channel (from remain_on_channel request)
5456 * @duration: Duration in milliseconds that the driver intents to remain on the
5458 * @gfp: allocation flags
5460 void cfg80211_ready_on_channel(struct wireless_dev
*wdev
, u64 cookie
,
5461 struct ieee80211_channel
*chan
,
5462 unsigned int duration
, gfp_t gfp
);
5465 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
5466 * @wdev: wireless device
5467 * @cookie: the request cookie
5468 * @chan: The current channel (from remain_on_channel request)
5469 * @gfp: allocation flags
5471 void cfg80211_remain_on_channel_expired(struct wireless_dev
*wdev
, u64 cookie
,
5472 struct ieee80211_channel
*chan
,
5477 * cfg80211_new_sta - notify userspace about station
5480 * @mac_addr: the station's address
5481 * @sinfo: the station information
5482 * @gfp: allocation flags
5484 void cfg80211_new_sta(struct net_device
*dev
, const u8
*mac_addr
,
5485 struct station_info
*sinfo
, gfp_t gfp
);
5488 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
5490 * @mac_addr: the station's address
5491 * @sinfo: the station information/statistics
5492 * @gfp: allocation flags
5494 void cfg80211_del_sta_sinfo(struct net_device
*dev
, const u8
*mac_addr
,
5495 struct station_info
*sinfo
, gfp_t gfp
);
5498 * cfg80211_del_sta - notify userspace about deletion of a station
5501 * @mac_addr: the station's address
5502 * @gfp: allocation flags
5504 static inline void cfg80211_del_sta(struct net_device
*dev
,
5505 const u8
*mac_addr
, gfp_t gfp
)
5507 cfg80211_del_sta_sinfo(dev
, mac_addr
, NULL
, gfp
);
5511 * cfg80211_conn_failed - connection request failed notification
5514 * @mac_addr: the station's address
5515 * @reason: the reason for connection failure
5516 * @gfp: allocation flags
5518 * Whenever a station tries to connect to an AP and if the station
5519 * could not connect to the AP as the AP has rejected the connection
5520 * for some reasons, this function is called.
5522 * The reason for connection failure can be any of the value from
5523 * nl80211_connect_failed_reason enum
5525 void cfg80211_conn_failed(struct net_device
*dev
, const u8
*mac_addr
,
5526 enum nl80211_connect_failed_reason reason
,
5530 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
5531 * @wdev: wireless device receiving the frame
5532 * @freq: Frequency on which the frame was received in MHz
5533 * @sig_dbm: signal strength in mBm, or 0 if unknown
5534 * @buf: Management frame (header + body)
5535 * @len: length of the frame data
5536 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
5538 * This function is called whenever an Action frame is received for a station
5539 * mode interface, but is not processed in kernel.
5541 * Return: %true if a user space application has registered for this frame.
5542 * For action frames, that makes it responsible for rejecting unrecognized
5543 * action frames; %false otherwise, in which case for action frames the
5544 * driver is responsible for rejecting the frame.
5546 bool cfg80211_rx_mgmt(struct wireless_dev
*wdev
, int freq
, int sig_dbm
,
5547 const u8
*buf
, size_t len
, u32 flags
);
5550 * cfg80211_mgmt_tx_status - notification of TX status for management frame
5551 * @wdev: wireless device receiving the frame
5552 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5553 * @buf: Management frame (header + body)
5554 * @len: length of the frame data
5555 * @ack: Whether frame was acknowledged
5556 * @gfp: context flags
5558 * This function is called whenever a management frame was requested to be
5559 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
5560 * transmission attempt.
5562 void cfg80211_mgmt_tx_status(struct wireless_dev
*wdev
, u64 cookie
,
5563 const u8
*buf
, size_t len
, bool ack
, gfp_t gfp
);
5567 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5568 * @dev: network device
5569 * @rssi_event: the triggered RSSI event
5570 * @rssi_level: new RSSI level value or 0 if not available
5571 * @gfp: context flags
5573 * This function is called when a configured connection quality monitoring
5574 * rssi threshold reached event occurs.
5576 void cfg80211_cqm_rssi_notify(struct net_device
*dev
,
5577 enum nl80211_cqm_rssi_threshold_event rssi_event
,
5578 s32 rssi_level
, gfp_t gfp
);
5581 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5582 * @dev: network device
5583 * @peer: peer's MAC address
5584 * @num_packets: how many packets were lost -- should be a fixed threshold
5585 * but probably no less than maybe 50, or maybe a throughput dependent
5586 * threshold (to account for temporary interference)
5587 * @gfp: context flags
5589 void cfg80211_cqm_pktloss_notify(struct net_device
*dev
,
5590 const u8
*peer
, u32 num_packets
, gfp_t gfp
);
5593 * cfg80211_cqm_txe_notify - TX error rate event
5594 * @dev: network device
5595 * @peer: peer's MAC address
5596 * @num_packets: how many packets were lost
5597 * @rate: % of packets which failed transmission
5598 * @intvl: interval (in s) over which the TX failure threshold was breached.
5599 * @gfp: context flags
5601 * Notify userspace when configured % TX failures over number of packets in a
5602 * given interval is exceeded.
5604 void cfg80211_cqm_txe_notify(struct net_device
*dev
, const u8
*peer
,
5605 u32 num_packets
, u32 rate
, u32 intvl
, gfp_t gfp
);
5608 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5609 * @dev: network device
5610 * @gfp: context flags
5612 * Notify userspace about beacon loss from the connected AP.
5614 void cfg80211_cqm_beacon_loss_notify(struct net_device
*dev
, gfp_t gfp
);
5617 * cfg80211_radar_event - radar detection event
5619 * @chandef: chandef for the current channel
5620 * @gfp: context flags
5622 * This function is called when a radar is detected on the current chanenl.
5624 void cfg80211_radar_event(struct wiphy
*wiphy
,
5625 struct cfg80211_chan_def
*chandef
, gfp_t gfp
);
5628 * cfg80211_cac_event - Channel availability check (CAC) event
5629 * @netdev: network device
5630 * @chandef: chandef for the current channel
5631 * @event: type of event
5632 * @gfp: context flags
5634 * This function is called when a Channel availability check (CAC) is finished
5635 * or aborted. This must be called to notify the completion of a CAC process,
5636 * also by full-MAC drivers.
5638 void cfg80211_cac_event(struct net_device
*netdev
,
5639 const struct cfg80211_chan_def
*chandef
,
5640 enum nl80211_radar_event event
, gfp_t gfp
);
5644 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5645 * @dev: network device
5646 * @bssid: BSSID of AP (to avoid races)
5647 * @replay_ctr: new replay counter
5648 * @gfp: allocation flags
5650 void cfg80211_gtk_rekey_notify(struct net_device
*dev
, const u8
*bssid
,
5651 const u8
*replay_ctr
, gfp_t gfp
);
5654 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5655 * @dev: network device
5656 * @index: candidate index (the smaller the index, the higher the priority)
5657 * @bssid: BSSID of AP
5658 * @preauth: Whether AP advertises support for RSN pre-authentication
5659 * @gfp: allocation flags
5661 void cfg80211_pmksa_candidate_notify(struct net_device
*dev
, int index
,
5662 const u8
*bssid
, bool preauth
, gfp_t gfp
);
5665 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5666 * @dev: The device the frame matched to
5667 * @addr: the transmitter address
5668 * @gfp: context flags
5670 * This function is used in AP mode (only!) to inform userspace that
5671 * a spurious class 3 frame was received, to be able to deauth the
5673 * Return: %true if the frame was passed to userspace (or this failed
5674 * for a reason other than not having a subscription.)
5676 bool cfg80211_rx_spurious_frame(struct net_device
*dev
,
5677 const u8
*addr
, gfp_t gfp
);
5680 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5681 * @dev: The device the frame matched to
5682 * @addr: the transmitter address
5683 * @gfp: context flags
5685 * This function is used in AP mode (only!) to inform userspace that
5686 * an associated station sent a 4addr frame but that wasn't expected.
5687 * It is allowed and desirable to send this event only once for each
5688 * station to avoid event flooding.
5689 * Return: %true if the frame was passed to userspace (or this failed
5690 * for a reason other than not having a subscription.)
5692 bool cfg80211_rx_unexpected_4addr_frame(struct net_device
*dev
,
5693 const u8
*addr
, gfp_t gfp
);
5696 * cfg80211_probe_status - notify userspace about probe status
5697 * @dev: the device the probe was sent on
5698 * @addr: the address of the peer
5699 * @cookie: the cookie filled in @probe_client previously
5700 * @acked: indicates whether probe was acked or not
5701 * @gfp: allocation flags
5703 void cfg80211_probe_status(struct net_device
*dev
, const u8
*addr
,
5704 u64 cookie
, bool acked
, gfp_t gfp
);
5707 * cfg80211_report_obss_beacon - report beacon from other APs
5708 * @wiphy: The wiphy that received the beacon
5710 * @len: length of the frame
5711 * @freq: frequency the frame was received on
5712 * @sig_dbm: signal strength in mBm, or 0 if unknown
5714 * Use this function to report to userspace when a beacon was
5715 * received. It is not useful to call this when there is no
5716 * netdev that is in AP/GO mode.
5718 void cfg80211_report_obss_beacon(struct wiphy
*wiphy
,
5719 const u8
*frame
, size_t len
,
5720 int freq
, int sig_dbm
);
5723 * cfg80211_reg_can_beacon - check if beaconing is allowed
5725 * @chandef: the channel definition
5726 * @iftype: interface type
5728 * Return: %true if there is no secondary channel or the secondary channel(s)
5729 * can be used for beaconing (i.e. is not a radar channel etc.)
5731 bool cfg80211_reg_can_beacon(struct wiphy
*wiphy
,
5732 struct cfg80211_chan_def
*chandef
,
5733 enum nl80211_iftype iftype
);
5736 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5738 * @chandef: the channel definition
5739 * @iftype: interface type
5741 * Return: %true if there is no secondary channel or the secondary channel(s)
5742 * can be used for beaconing (i.e. is not a radar channel etc.). This version
5743 * also checks if IR-relaxation conditions apply, to allow beaconing under
5744 * more permissive conditions.
5746 * Requires the RTNL to be held.
5748 bool cfg80211_reg_can_beacon_relax(struct wiphy
*wiphy
,
5749 struct cfg80211_chan_def
*chandef
,
5750 enum nl80211_iftype iftype
);
5753 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5754 * @dev: the device which switched channels
5755 * @chandef: the new channel definition
5757 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5760 void cfg80211_ch_switch_notify(struct net_device
*dev
,
5761 struct cfg80211_chan_def
*chandef
);
5764 * cfg80211_ch_switch_started_notify - notify channel switch start
5765 * @dev: the device on which the channel switch started
5766 * @chandef: the future channel definition
5767 * @count: the number of TBTTs until the channel switch happens
5769 * Inform the userspace about the channel switch that has just
5770 * started, so that it can take appropriate actions (eg. starting
5771 * channel switch on other vifs), if necessary.
5773 void cfg80211_ch_switch_started_notify(struct net_device
*dev
,
5774 struct cfg80211_chan_def
*chandef
,
5778 * ieee80211_operating_class_to_band - convert operating class to band
5780 * @operating_class: the operating class to convert
5781 * @band: band pointer to fill
5783 * Returns %true if the conversion was successful, %false otherwise.
5785 bool ieee80211_operating_class_to_band(u8 operating_class
,
5786 enum nl80211_band
*band
);
5789 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5791 * @chandef: the chandef to convert
5792 * @op_class: a pointer to the resulting operating class
5794 * Returns %true if the conversion was successful, %false otherwise.
5796 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def
*chandef
,
5800 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5801 * @dev: the device on which the operation is requested
5802 * @peer: the MAC address of the peer device
5803 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5804 * NL80211_TDLS_TEARDOWN)
5805 * @reason_code: the reason code for teardown request
5806 * @gfp: allocation flags
5808 * This function is used to request userspace to perform TDLS operation that
5809 * requires knowledge of keys, i.e., link setup or teardown when the AP
5810 * connection uses encryption. This is optional mechanism for the driver to use
5811 * if it can automatically determine when a TDLS link could be useful (e.g.,
5812 * based on traffic and signal strength for a peer).
5814 void cfg80211_tdls_oper_request(struct net_device
*dev
, const u8
*peer
,
5815 enum nl80211_tdls_operation oper
,
5816 u16 reason_code
, gfp_t gfp
);
5819 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5820 * @rate: given rate_info to calculate bitrate from
5822 * return 0 if MCS index >= 32
5824 u32
cfg80211_calculate_bitrate(struct rate_info
*rate
);
5827 * cfg80211_unregister_wdev - remove the given wdev
5828 * @wdev: struct wireless_dev to remove
5830 * Call this function only for wdevs that have no netdev assigned,
5831 * e.g. P2P Devices. It removes the device from the list so that
5832 * it can no longer be used. It is necessary to call this function
5833 * even when cfg80211 requests the removal of the interface by
5834 * calling the del_virtual_intf() callback. The function must also
5835 * be called when the driver wishes to unregister the wdev, e.g.
5836 * when the device is unbound from the driver.
5838 * Requires the RTNL to be held.
5840 void cfg80211_unregister_wdev(struct wireless_dev
*wdev
);
5843 * struct cfg80211_ft_event - FT Information Elements
5845 * @ies_len: length of the FT IE in bytes
5846 * @target_ap: target AP's MAC address
5848 * @ric_ies_len: length of the RIC IE in bytes
5850 struct cfg80211_ft_event_params
{
5853 const u8
*target_ap
;
5859 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5860 * @netdev: network device
5861 * @ft_event: IE information
5863 void cfg80211_ft_event(struct net_device
*netdev
,
5864 struct cfg80211_ft_event_params
*ft_event
);
5867 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5868 * @ies: the input IE buffer
5869 * @len: the input length
5870 * @attr: the attribute ID to find
5871 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5872 * if the function is only called to get the needed buffer size
5873 * @bufsize: size of the output buffer
5875 * The function finds a given P2P attribute in the (vendor) IEs and
5876 * copies its contents to the given buffer.
5878 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5879 * malformed or the attribute can't be found (respectively), or the
5880 * length of the found attribute (which can be zero).
5882 int cfg80211_get_p2p_attr(const u8
*ies
, unsigned int len
,
5883 enum ieee80211_p2p_attr_id attr
,
5884 u8
*buf
, unsigned int bufsize
);
5887 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5888 * @ies: the IE buffer
5889 * @ielen: the length of the IE buffer
5890 * @ids: an array with element IDs that are allowed before
5892 * @n_ids: the size of the element ID array
5893 * @after_ric: array IE types that come after the RIC element
5894 * @n_after_ric: size of the @after_ric array
5895 * @offset: offset where to start splitting in the buffer
5897 * This function splits an IE buffer by updating the @offset
5898 * variable to point to the location where the buffer should be
5901 * It assumes that the given IE buffer is well-formed, this
5902 * has to be guaranteed by the caller!
5904 * It also assumes that the IEs in the buffer are ordered
5905 * correctly, if not the result of using this function will not
5906 * be ordered correctly either, i.e. it does no reordering.
5908 * The function returns the offset where the next part of the
5909 * buffer starts, which may be @ielen if the entire (remainder)
5910 * of the buffer should be used.
5912 size_t ieee80211_ie_split_ric(const u8
*ies
, size_t ielen
,
5913 const u8
*ids
, int n_ids
,
5914 const u8
*after_ric
, int n_after_ric
,
5918 * ieee80211_ie_split - split an IE buffer according to ordering
5919 * @ies: the IE buffer
5920 * @ielen: the length of the IE buffer
5921 * @ids: an array with element IDs that are allowed before
5923 * @n_ids: the size of the element ID array
5924 * @offset: offset where to start splitting in the buffer
5926 * This function splits an IE buffer by updating the @offset
5927 * variable to point to the location where the buffer should be
5930 * It assumes that the given IE buffer is well-formed, this
5931 * has to be guaranteed by the caller!
5933 * It also assumes that the IEs in the buffer are ordered
5934 * correctly, if not the result of using this function will not
5935 * be ordered correctly either, i.e. it does no reordering.
5937 * The function returns the offset where the next part of the
5938 * buffer starts, which may be @ielen if the entire (remainder)
5939 * of the buffer should be used.
5941 static inline size_t ieee80211_ie_split(const u8
*ies
, size_t ielen
,
5942 const u8
*ids
, int n_ids
, size_t offset
)
5944 return ieee80211_ie_split_ric(ies
, ielen
, ids
, n_ids
, NULL
, 0, offset
);
5948 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5949 * @wdev: the wireless device reporting the wakeup
5950 * @wakeup: the wakeup report
5951 * @gfp: allocation flags
5953 * This function reports that the given device woke up. If it
5954 * caused the wakeup, report the reason(s), otherwise you may
5955 * pass %NULL as the @wakeup parameter to advertise that something
5956 * else caused the wakeup.
5958 void cfg80211_report_wowlan_wakeup(struct wireless_dev
*wdev
,
5959 struct cfg80211_wowlan_wakeup
*wakeup
,
5963 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5965 * @wdev: the wireless device for which critical protocol is stopped.
5966 * @gfp: allocation flags
5968 * This function can be called by the driver to indicate it has reverted
5969 * operation back to normal. One reason could be that the duration given
5970 * by .crit_proto_start() has expired.
5972 void cfg80211_crit_proto_stopped(struct wireless_dev
*wdev
, gfp_t gfp
);
5975 * ieee80211_get_num_supported_channels - get number of channels device has
5978 * Return: the number of channels supported by the device.
5980 unsigned int ieee80211_get_num_supported_channels(struct wiphy
*wiphy
);
5983 * cfg80211_check_combinations - check interface combinations
5986 * @params: the interface combinations parameter
5988 * This function can be called by the driver to check whether a
5989 * combination of interfaces and their types are allowed according to
5990 * the interface combinations.
5992 int cfg80211_check_combinations(struct wiphy
*wiphy
,
5993 struct iface_combination_params
*params
);
5996 * cfg80211_iter_combinations - iterate over matching combinations
5999 * @params: the interface combinations parameter
6000 * @iter: function to call for each matching combination
6001 * @data: pointer to pass to iter function
6003 * This function can be called by the driver to check what possible
6004 * combinations it fits in at a given moment, e.g. for channel switching
6007 int cfg80211_iter_combinations(struct wiphy
*wiphy
,
6008 struct iface_combination_params
*params
,
6009 void (*iter
)(const struct ieee80211_iface_combination
*c
,
6014 * cfg80211_stop_iface - trigger interface disconnection
6017 * @wdev: wireless device
6018 * @gfp: context flags
6020 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
6023 * Note: This doesn't need any locks and is asynchronous.
6025 void cfg80211_stop_iface(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
6029 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
6030 * @wiphy: the wiphy to shut down
6032 * This function shuts down all interfaces belonging to this wiphy by
6033 * calling dev_close() (and treating non-netdev interfaces as needed).
6034 * It shouldn't really be used unless there are some fatal device errors
6035 * that really can't be recovered in any other way.
6037 * Callers must hold the RTNL and be able to deal with callbacks into
6038 * the driver while the function is running.
6040 void cfg80211_shutdown_all_interfaces(struct wiphy
*wiphy
);
6043 * wiphy_ext_feature_set - set the extended feature flag
6045 * @wiphy: the wiphy to modify.
6046 * @ftidx: extended feature bit index.
6048 * The extended features are flagged in multiple bytes (see
6049 * &struct wiphy.@ext_features)
6051 static inline void wiphy_ext_feature_set(struct wiphy
*wiphy
,
6052 enum nl80211_ext_feature_index ftidx
)
6056 ft_byte
= &wiphy
->ext_features
[ftidx
/ 8];
6057 *ft_byte
|= BIT(ftidx
% 8);
6061 * wiphy_ext_feature_isset - check the extended feature flag
6063 * @wiphy: the wiphy to modify.
6064 * @ftidx: extended feature bit index.
6066 * The extended features are flagged in multiple bytes (see
6067 * &struct wiphy.@ext_features)
6070 wiphy_ext_feature_isset(struct wiphy
*wiphy
,
6071 enum nl80211_ext_feature_index ftidx
)
6075 ft_byte
= wiphy
->ext_features
[ftidx
/ 8];
6076 return (ft_byte
& BIT(ftidx
% 8)) != 0;
6080 * cfg80211_free_nan_func - free NAN function
6081 * @f: NAN function that should be freed
6083 * Frees all the NAN function and all it's allocated members.
6085 void cfg80211_free_nan_func(struct cfg80211_nan_func
*f
);
6088 * struct cfg80211_nan_match_params - NAN match parameters
6089 * @type: the type of the function that triggered a match. If it is
6090 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
6091 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
6093 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
6094 * @inst_id: the local instance id
6095 * @peer_inst_id: the instance id of the peer's function
6096 * @addr: the MAC address of the peer
6097 * @info_len: the length of the &info
6098 * @info: the Service Specific Info from the peer (if any)
6099 * @cookie: unique identifier of the corresponding function
6101 struct cfg80211_nan_match_params
{
6102 enum nl80211_nan_function_type type
;
6112 * cfg80211_nan_match - report a match for a NAN function.
6113 * @wdev: the wireless device reporting the match
6114 * @match: match notification parameters
6115 * @gfp: allocation flags
6117 * This function reports that the a NAN function had a match. This
6118 * can be a subscribe that had a match or a solicited publish that
6119 * was sent. It can also be a follow up that was received.
6121 void cfg80211_nan_match(struct wireless_dev
*wdev
,
6122 struct cfg80211_nan_match_params
*match
, gfp_t gfp
);
6125 * cfg80211_nan_func_terminated - notify about NAN function termination.
6127 * @wdev: the wireless device reporting the match
6128 * @inst_id: the local instance id
6129 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6130 * @cookie: unique NAN function identifier
6131 * @gfp: allocation flags
6133 * This function reports that the a NAN function is terminated.
6135 void cfg80211_nan_func_terminated(struct wireless_dev
*wdev
,
6137 enum nl80211_nan_func_term_reason reason
,
6138 u64 cookie
, gfp_t gfp
);
6140 /* ethtool helper */
6141 void cfg80211_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
);
6143 /* Logging, debugging and troubleshooting/diagnostic helpers. */
6145 /* wiphy_printk helpers, similar to dev_printk */
6147 #define wiphy_printk(level, wiphy, format, args...) \
6148 dev_printk(level, &(wiphy)->dev, format, ##args)
6149 #define wiphy_emerg(wiphy, format, args...) \
6150 dev_emerg(&(wiphy)->dev, format, ##args)
6151 #define wiphy_alert(wiphy, format, args...) \
6152 dev_alert(&(wiphy)->dev, format, ##args)
6153 #define wiphy_crit(wiphy, format, args...) \
6154 dev_crit(&(wiphy)->dev, format, ##args)
6155 #define wiphy_err(wiphy, format, args...) \
6156 dev_err(&(wiphy)->dev, format, ##args)
6157 #define wiphy_warn(wiphy, format, args...) \
6158 dev_warn(&(wiphy)->dev, format, ##args)
6159 #define wiphy_notice(wiphy, format, args...) \
6160 dev_notice(&(wiphy)->dev, format, ##args)
6161 #define wiphy_info(wiphy, format, args...) \
6162 dev_info(&(wiphy)->dev, format, ##args)
6164 #define wiphy_debug(wiphy, format, args...) \
6165 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
6167 #define wiphy_dbg(wiphy, format, args...) \
6168 dev_dbg(&(wiphy)->dev, format, ##args)
6170 #if defined(VERBOSE_DEBUG)
6171 #define wiphy_vdbg wiphy_dbg
6173 #define wiphy_vdbg(wiphy, format, args...) \
6176 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
6182 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
6183 * of using a WARN/WARN_ON to get the message out, including the
6184 * file/line information and a backtrace.
6186 #define wiphy_WARN(wiphy, format, args...) \
6187 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
6189 #endif /* __NET_CFG80211_H */