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 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 * Wireless hardware/device configuration structures and methods
319 * DOC: Actions and configuration
321 * Each wireless device and each virtual interface offer a set of configuration
322 * operations and other actions that are invoked by userspace. Each of these
323 * actions is described in the operations structure, and the parameters these
324 * operations use are described separately.
326 * Additionally, some operations are asynchronous and expect to get status
327 * information via some functions that drivers need to call.
329 * Scanning and BSS list handling with its associated functionality is described
330 * in a separate chapter.
333 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
334 WLAN_USER_POSITION_LEN)
337 * struct vif_params - describes virtual interface parameters
338 * @use_4addr: use 4-address frames
339 * @macaddr: address to use for this virtual interface.
340 * If this parameter is set to zero address the driver may
341 * determine the address as needed.
342 * This feature is only fully supported by drivers that enable the
343 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
344 ** only p2p devices with specified MAC.
345 * @vht_mumimo_groups: MU-MIMO groupID. used for monitoring only
346 * packets belonging to that MU-MIMO groupID.
350 u8 macaddr
[ETH_ALEN
];
351 u8 vht_mumimo_groups
[VHT_MUMIMO_GROUPS_DATA_LEN
];
355 * struct key_params - key information
357 * Information about a key
360 * @key_len: length of key material
361 * @cipher: cipher suite selector
362 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
363 * with the get_key() callback, must be in little endian,
364 * length given by @seq_len.
365 * @seq_len: length of @seq.
376 * struct cfg80211_chan_def - channel definition
377 * @chan: the (control) channel
378 * @width: channel width
379 * @center_freq1: center frequency of first segment
380 * @center_freq2: center frequency of second segment
381 * (only with 80+80 MHz)
383 struct cfg80211_chan_def
{
384 struct ieee80211_channel
*chan
;
385 enum nl80211_chan_width width
;
391 * cfg80211_get_chandef_type - return old channel type from chandef
392 * @chandef: the channel definition
394 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
395 * chandef, which must have a bandwidth allowing this conversion.
397 static inline enum nl80211_channel_type
398 cfg80211_get_chandef_type(const struct cfg80211_chan_def
*chandef
)
400 switch (chandef
->width
) {
401 case NL80211_CHAN_WIDTH_20_NOHT
:
402 return NL80211_CHAN_NO_HT
;
403 case NL80211_CHAN_WIDTH_20
:
404 return NL80211_CHAN_HT20
;
405 case NL80211_CHAN_WIDTH_40
:
406 if (chandef
->center_freq1
> chandef
->chan
->center_freq
)
407 return NL80211_CHAN_HT40PLUS
;
408 return NL80211_CHAN_HT40MINUS
;
411 return NL80211_CHAN_NO_HT
;
416 * cfg80211_chandef_create - create channel definition using channel type
417 * @chandef: the channel definition struct to fill
418 * @channel: the control channel
419 * @chantype: the channel type
421 * Given a channel type, create a channel definition.
423 void cfg80211_chandef_create(struct cfg80211_chan_def
*chandef
,
424 struct ieee80211_channel
*channel
,
425 enum nl80211_channel_type chantype
);
428 * cfg80211_chandef_identical - check if two channel definitions are identical
429 * @chandef1: first channel definition
430 * @chandef2: second channel definition
432 * Return: %true if the channels defined by the channel definitions are
433 * identical, %false otherwise.
436 cfg80211_chandef_identical(const struct cfg80211_chan_def
*chandef1
,
437 const struct cfg80211_chan_def
*chandef2
)
439 return (chandef1
->chan
== chandef2
->chan
&&
440 chandef1
->width
== chandef2
->width
&&
441 chandef1
->center_freq1
== chandef2
->center_freq1
&&
442 chandef1
->center_freq2
== chandef2
->center_freq2
);
446 * cfg80211_chandef_compatible - check if two channel definitions are compatible
447 * @chandef1: first channel definition
448 * @chandef2: second channel definition
450 * Return: %NULL if the given channel definitions are incompatible,
451 * chandef1 or chandef2 otherwise.
453 const struct cfg80211_chan_def
*
454 cfg80211_chandef_compatible(const struct cfg80211_chan_def
*chandef1
,
455 const struct cfg80211_chan_def
*chandef2
);
458 * cfg80211_chandef_valid - check if a channel definition is valid
459 * @chandef: the channel definition to check
460 * Return: %true if the channel definition is valid. %false otherwise.
462 bool cfg80211_chandef_valid(const struct cfg80211_chan_def
*chandef
);
465 * cfg80211_chandef_usable - check if secondary channels can be used
466 * @wiphy: the wiphy to validate against
467 * @chandef: the channel definition to check
468 * @prohibited_flags: the regulatory channel flags that must not be set
469 * Return: %true if secondary channels are usable. %false otherwise.
471 bool cfg80211_chandef_usable(struct wiphy
*wiphy
,
472 const struct cfg80211_chan_def
*chandef
,
473 u32 prohibited_flags
);
476 * cfg80211_chandef_dfs_required - checks if radar detection is required
477 * @wiphy: the wiphy to validate against
478 * @chandef: the channel definition to check
479 * @iftype: the interface type as specified in &enum nl80211_iftype
481 * 1 if radar detection is required, 0 if it is not, < 0 on error
483 int cfg80211_chandef_dfs_required(struct wiphy
*wiphy
,
484 const struct cfg80211_chan_def
*chandef
,
485 enum nl80211_iftype iftype
);
488 * ieee80211_chandef_rate_flags - returns rate flags for a channel
490 * In some channel types, not all rates may be used - for example CCK
491 * rates may not be used in 5/10 MHz channels.
493 * @chandef: channel definition for the channel
495 * Returns: rate flags which apply for this channel
497 static inline enum ieee80211_rate_flags
498 ieee80211_chandef_rate_flags(struct cfg80211_chan_def
*chandef
)
500 switch (chandef
->width
) {
501 case NL80211_CHAN_WIDTH_5
:
502 return IEEE80211_RATE_SUPPORTS_5MHZ
;
503 case NL80211_CHAN_WIDTH_10
:
504 return IEEE80211_RATE_SUPPORTS_10MHZ
;
512 * ieee80211_chandef_max_power - maximum transmission power for the chandef
514 * In some regulations, the transmit power may depend on the configured channel
515 * bandwidth which may be defined as dBm/MHz. This function returns the actual
516 * max_power for non-standard (20 MHz) channels.
518 * @chandef: channel definition for the channel
520 * Returns: maximum allowed transmission power in dBm for the chandef
523 ieee80211_chandef_max_power(struct cfg80211_chan_def
*chandef
)
525 switch (chandef
->width
) {
526 case NL80211_CHAN_WIDTH_5
:
527 return min(chandef
->chan
->max_reg_power
- 6,
528 chandef
->chan
->max_power
);
529 case NL80211_CHAN_WIDTH_10
:
530 return min(chandef
->chan
->max_reg_power
- 3,
531 chandef
->chan
->max_power
);
535 return chandef
->chan
->max_power
;
539 * enum survey_info_flags - survey information flags
541 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
542 * @SURVEY_INFO_IN_USE: channel is currently being used
543 * @SURVEY_INFO_TIME: active time (in ms) was filled in
544 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
545 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
546 * @SURVEY_INFO_TIME_RX: receive time was filled in
547 * @SURVEY_INFO_TIME_TX: transmit time was filled in
548 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
550 * Used by the driver to indicate which info in &struct survey_info
551 * it has filled in during the get_survey().
553 enum survey_info_flags
{
554 SURVEY_INFO_NOISE_DBM
= BIT(0),
555 SURVEY_INFO_IN_USE
= BIT(1),
556 SURVEY_INFO_TIME
= BIT(2),
557 SURVEY_INFO_TIME_BUSY
= BIT(3),
558 SURVEY_INFO_TIME_EXT_BUSY
= BIT(4),
559 SURVEY_INFO_TIME_RX
= BIT(5),
560 SURVEY_INFO_TIME_TX
= BIT(6),
561 SURVEY_INFO_TIME_SCAN
= BIT(7),
565 * struct survey_info - channel survey response
567 * @channel: the channel this survey record reports, may be %NULL for a single
568 * record to report global statistics
569 * @filled: bitflag of flags from &enum survey_info_flags
570 * @noise: channel noise in dBm. This and all following fields are
572 * @time: amount of time in ms the radio was turn on (on the channel)
573 * @time_busy: amount of time the primary channel was sensed busy
574 * @time_ext_busy: amount of time the extension channel was sensed busy
575 * @time_rx: amount of time the radio spent receiving data
576 * @time_tx: amount of time the radio spent transmitting data
577 * @time_scan: amount of time the radio spent for scanning
579 * Used by dump_survey() to report back per-channel survey information.
581 * This structure can later be expanded with things like
582 * channel duty cycle etc.
585 struct ieee80211_channel
*channel
;
597 * struct cfg80211_crypto_settings - Crypto settings
598 * @wpa_versions: indicates which, if any, WPA versions are enabled
599 * (from enum nl80211_wpa_versions)
600 * @cipher_group: group key cipher suite (or 0 if unset)
601 * @n_ciphers_pairwise: number of AP supported unicast ciphers
602 * @ciphers_pairwise: unicast key cipher suites
603 * @n_akm_suites: number of AKM suites
604 * @akm_suites: AKM suites
605 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
606 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
607 * required to assume that the port is unauthorized until authorized by
608 * user space. Otherwise, port is marked authorized by default.
609 * @control_port_ethertype: the control port protocol that should be
610 * allowed through even on unauthorized ports
611 * @control_port_no_encrypt: TRUE to prevent encryption of control port
614 struct cfg80211_crypto_settings
{
617 int n_ciphers_pairwise
;
618 u32 ciphers_pairwise
[NL80211_MAX_NR_CIPHER_SUITES
];
620 u32 akm_suites
[NL80211_MAX_NR_AKM_SUITES
];
622 __be16 control_port_ethertype
;
623 bool control_port_no_encrypt
;
627 * struct cfg80211_beacon_data - beacon data
628 * @head: head portion of beacon (before TIM IE)
629 * or %NULL if not changed
630 * @tail: tail portion of beacon (after TIM IE)
631 * or %NULL if not changed
632 * @head_len: length of @head
633 * @tail_len: length of @tail
634 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
635 * @beacon_ies_len: length of beacon_ies in octets
636 * @proberesp_ies: extra information element(s) to add into Probe Response
638 * @proberesp_ies_len: length of proberesp_ies in octets
639 * @assocresp_ies: extra information element(s) to add into (Re)Association
640 * Response frames or %NULL
641 * @assocresp_ies_len: length of assocresp_ies in octets
642 * @probe_resp_len: length of probe response template (@probe_resp)
643 * @probe_resp: probe response template (AP mode only)
645 struct cfg80211_beacon_data
{
646 const u8
*head
, *tail
;
647 const u8
*beacon_ies
;
648 const u8
*proberesp_ies
;
649 const u8
*assocresp_ies
;
650 const u8
*probe_resp
;
652 size_t head_len
, tail_len
;
653 size_t beacon_ies_len
;
654 size_t proberesp_ies_len
;
655 size_t assocresp_ies_len
;
656 size_t probe_resp_len
;
664 * struct cfg80211_acl_data - Access control list data
666 * @acl_policy: ACL policy to be applied on the station's
667 * entry specified by mac_addr
668 * @n_acl_entries: Number of MAC address entries passed
669 * @mac_addrs: List of MAC addresses of stations to be used for ACL
671 struct cfg80211_acl_data
{
672 enum nl80211_acl_policy acl_policy
;
676 struct mac_address mac_addrs
[];
680 * struct cfg80211_ap_settings - AP configuration
682 * Used to configure an AP interface.
684 * @chandef: defines the channel to use
685 * @beacon: beacon data
686 * @beacon_interval: beacon interval
687 * @dtim_period: DTIM period
688 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
690 * @ssid_len: length of @ssid
691 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
692 * @crypto: crypto settings
693 * @privacy: the BSS uses privacy
694 * @auth_type: Authentication type (algorithm)
695 * @smps_mode: SMPS mode
696 * @inactivity_timeout: time in seconds to determine station's inactivity.
697 * @p2p_ctwindow: P2P CT Window
698 * @p2p_opp_ps: P2P opportunistic PS
699 * @acl: ACL configuration used by the drivers which has support for
700 * MAC address based access control
701 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
704 struct cfg80211_ap_settings
{
705 struct cfg80211_chan_def chandef
;
707 struct cfg80211_beacon_data beacon
;
709 int beacon_interval
, dtim_period
;
712 enum nl80211_hidden_ssid hidden_ssid
;
713 struct cfg80211_crypto_settings crypto
;
715 enum nl80211_auth_type auth_type
;
716 enum nl80211_smps_mode smps_mode
;
717 int inactivity_timeout
;
720 const struct cfg80211_acl_data
*acl
;
725 * struct cfg80211_csa_settings - channel switch settings
727 * Used for channel switch
729 * @chandef: defines the channel to use after the switch
730 * @beacon_csa: beacon data while performing the switch
731 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
732 * @counter_offsets_presp: offsets of the counters within the probe response
733 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
734 * @n_counter_offsets_presp: number of csa counters in the probe response
735 * @beacon_after: beacon data to be used on the new channel
736 * @radar_required: whether radar detection is required on the new channel
737 * @block_tx: whether transmissions should be blocked while changing
738 * @count: number of beacons until switch
740 struct cfg80211_csa_settings
{
741 struct cfg80211_chan_def chandef
;
742 struct cfg80211_beacon_data beacon_csa
;
743 const u16
*counter_offsets_beacon
;
744 const u16
*counter_offsets_presp
;
745 unsigned int n_counter_offsets_beacon
;
746 unsigned int n_counter_offsets_presp
;
747 struct cfg80211_beacon_data beacon_after
;
754 * enum station_parameters_apply_mask - station parameter values to apply
755 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
756 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
757 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
759 * Not all station parameters have in-band "no change" signalling,
760 * for those that don't these flags will are used.
762 enum station_parameters_apply_mask
{
763 STATION_PARAM_APPLY_UAPSD
= BIT(0),
764 STATION_PARAM_APPLY_CAPABILITY
= BIT(1),
765 STATION_PARAM_APPLY_PLINK_STATE
= BIT(2),
769 * struct station_parameters - station parameters
771 * Used to change and create a new station.
773 * @vlan: vlan interface station should belong to
774 * @supported_rates: supported rates in IEEE 802.11 format
775 * (or NULL for no change)
776 * @supported_rates_len: number of supported rates
777 * @sta_flags_mask: station flags that changed
778 * (bitmask of BIT(NL80211_STA_FLAG_...))
779 * @sta_flags_set: station flags values
780 * (bitmask of BIT(NL80211_STA_FLAG_...))
781 * @listen_interval: listen interval or -1 for no change
782 * @aid: AID or zero for no change
783 * @peer_aid: mesh peer AID or zero for no change
784 * @plink_action: plink action to take
785 * @plink_state: set the peer link state for a station
786 * @ht_capa: HT capabilities of station
787 * @vht_capa: VHT capabilities of station
788 * @uapsd_queues: bitmap of queues configured for uapsd. same format
789 * as the AC bitmap in the QoS info field
790 * @max_sp: max Service Period. same format as the MAX_SP in the
791 * QoS info field (but already shifted down)
792 * @sta_modify_mask: bitmap indicating which parameters changed
793 * (for those that don't have a natural "no change" value),
794 * see &enum station_parameters_apply_mask
795 * @local_pm: local link-specific mesh power save mode (no change when set
797 * @capability: station capability
798 * @ext_capab: extended capabilities of the station
799 * @ext_capab_len: number of extended capabilities
800 * @supported_channels: supported channels in IEEE 802.11 format
801 * @supported_channels_len: number of supported channels
802 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
803 * @supported_oper_classes_len: number of supported operating classes
804 * @opmode_notif: operating mode field from Operating Mode Notification
805 * @opmode_notif_used: information if operating mode field is used
806 * @support_p2p_ps: information if station supports P2P PS mechanism
808 struct station_parameters
{
809 const u8
*supported_rates
;
810 struct net_device
*vlan
;
811 u32 sta_flags_mask
, sta_flags_set
;
816 u8 supported_rates_len
;
819 const struct ieee80211_ht_cap
*ht_capa
;
820 const struct ieee80211_vht_cap
*vht_capa
;
823 enum nl80211_mesh_power_mode local_pm
;
827 const u8
*supported_channels
;
828 u8 supported_channels_len
;
829 const u8
*supported_oper_classes
;
830 u8 supported_oper_classes_len
;
832 bool opmode_notif_used
;
837 * struct station_del_parameters - station deletion parameters
839 * Used to delete a station entry (or all stations).
841 * @mac: MAC address of the station to remove or NULL to remove all stations
842 * @subtype: Management frame subtype to use for indicating removal
843 * (10 = Disassociation, 12 = Deauthentication)
844 * @reason_code: Reason code for the Disassociation/Deauthentication frame
846 struct station_del_parameters
{
853 * enum cfg80211_station_type - the type of station being modified
854 * @CFG80211_STA_AP_CLIENT: client of an AP interface
855 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
856 * unassociated (update properties for this type of client is permitted)
857 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
858 * the AP MLME in the device
859 * @CFG80211_STA_AP_STA: AP station on managed interface
860 * @CFG80211_STA_IBSS: IBSS station
861 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
862 * while TDLS setup is in progress, it moves out of this state when
863 * being marked authorized; use this only if TDLS with external setup is
865 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
866 * entry that is operating, has been marked authorized by userspace)
867 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
868 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
870 enum cfg80211_station_type
{
871 CFG80211_STA_AP_CLIENT
,
872 CFG80211_STA_AP_CLIENT_UNASSOC
,
873 CFG80211_STA_AP_MLME_CLIENT
,
876 CFG80211_STA_TDLS_PEER_SETUP
,
877 CFG80211_STA_TDLS_PEER_ACTIVE
,
878 CFG80211_STA_MESH_PEER_KERNEL
,
879 CFG80211_STA_MESH_PEER_USER
,
883 * cfg80211_check_station_change - validate parameter changes
884 * @wiphy: the wiphy this operates on
885 * @params: the new parameters for a station
886 * @statype: the type of station being modified
888 * Utility function for the @change_station driver method. Call this function
889 * with the appropriate station type looking up the station (and checking that
890 * it exists). It will verify whether the station change is acceptable, and if
891 * not will return an error code. Note that it may modify the parameters for
892 * backward compatibility reasons, so don't use them before calling this.
894 int cfg80211_check_station_change(struct wiphy
*wiphy
,
895 struct station_parameters
*params
,
896 enum cfg80211_station_type statype
);
899 * enum station_info_rate_flags - bitrate info flags
901 * Used by the driver to indicate the specific rate transmission
902 * type for 802.11n transmissions.
904 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
905 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
906 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
907 * @RATE_INFO_FLAGS_60G: 60GHz MCS
909 enum rate_info_flags
{
910 RATE_INFO_FLAGS_MCS
= BIT(0),
911 RATE_INFO_FLAGS_VHT_MCS
= BIT(1),
912 RATE_INFO_FLAGS_SHORT_GI
= BIT(2),
913 RATE_INFO_FLAGS_60G
= BIT(3),
917 * enum rate_info_bw - rate bandwidth information
919 * Used by the driver to indicate the rate bandwidth.
921 * @RATE_INFO_BW_5: 5 MHz bandwidth
922 * @RATE_INFO_BW_10: 10 MHz bandwidth
923 * @RATE_INFO_BW_20: 20 MHz bandwidth
924 * @RATE_INFO_BW_40: 40 MHz bandwidth
925 * @RATE_INFO_BW_80: 80 MHz bandwidth
926 * @RATE_INFO_BW_160: 160 MHz bandwidth
938 * struct rate_info - bitrate information
940 * Information about a receiving or transmitting bitrate
942 * @flags: bitflag of flags from &enum rate_info_flags
943 * @mcs: mcs index if struct describes a 802.11n bitrate
944 * @legacy: bitrate in 100kbit/s for 802.11abg
945 * @nss: number of streams (VHT only)
946 * @bw: bandwidth (from &enum rate_info_bw)
957 * enum station_info_rate_flags - bitrate info flags
959 * Used by the driver to indicate the specific rate transmission
960 * type for 802.11n transmissions.
962 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
963 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
964 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
966 enum bss_param_flags
{
967 BSS_PARAM_FLAGS_CTS_PROT
= 1<<0,
968 BSS_PARAM_FLAGS_SHORT_PREAMBLE
= 1<<1,
969 BSS_PARAM_FLAGS_SHORT_SLOT_TIME
= 1<<2,
973 * struct sta_bss_parameters - BSS parameters for the attached station
975 * Information about the currently associated BSS
977 * @flags: bitflag of flags from &enum bss_param_flags
978 * @dtim_period: DTIM period for the BSS
979 * @beacon_interval: beacon interval
981 struct sta_bss_parameters
{
988 * struct cfg80211_tid_stats - per-TID statistics
989 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
990 * indicate the relevant values in this struct are filled
991 * @rx_msdu: number of received MSDUs
992 * @tx_msdu: number of (attempted) transmitted MSDUs
993 * @tx_msdu_retries: number of retries (not counting the first) for
995 * @tx_msdu_failed: number of failed transmitted MSDUs
997 struct cfg80211_tid_stats
{
1001 u64 tx_msdu_retries
;
1005 #define IEEE80211_MAX_CHAINS 4
1008 * struct station_info - station information
1010 * Station information filled by driver for get_station() and dump_station.
1012 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1013 * indicate the relevant values in this struct for them
1014 * @connected_time: time(in secs) since a station is last connected
1015 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1016 * @rx_bytes: bytes (size of MPDUs) received from this station
1017 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1018 * @llid: mesh local link id
1019 * @plid: mesh peer link id
1020 * @plink_state: mesh peer link state
1021 * @signal: The signal strength, type depends on the wiphy's signal_type.
1022 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1023 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1024 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1025 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1026 * @chain_signal: per-chain signal strength of last received packet in dBm
1027 * @chain_signal_avg: per-chain signal strength average in dBm
1028 * @txrate: current unicast bitrate from this station
1029 * @rxrate: current unicast bitrate to this station
1030 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1031 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1032 * @tx_retries: cumulative retry counts (MPDUs)
1033 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1034 * @rx_dropped_misc: Dropped for un-specified reason.
1035 * @bss_param: current BSS parameters
1036 * @generation: generation number for nl80211 dumps.
1037 * This number should increase every time the list of stations
1038 * changes, i.e. when a station is added or removed, so that
1039 * userspace can tell whether it got a consistent snapshot.
1040 * @assoc_req_ies: IEs from (Re)Association Request.
1041 * This is used only when in AP mode with drivers that do not use
1042 * user space MLME/SME implementation. The information is provided for
1043 * the cfg80211_new_sta() calls to notify user space of the IEs.
1044 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1045 * @sta_flags: station flags mask & values
1046 * @beacon_loss_count: Number of times beacon loss event has triggered.
1047 * @t_offset: Time offset of the station relative to this host.
1048 * @local_pm: local mesh STA power save mode
1049 * @peer_pm: peer mesh STA power save mode
1050 * @nonpeer_pm: non-peer mesh STA power save mode
1051 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1052 * towards this station.
1053 * @rx_beacon: number of beacons received from this peer
1054 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1056 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1057 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1058 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1060 struct station_info
{
1073 s8 chain_signal
[IEEE80211_MAX_CHAINS
];
1074 s8 chain_signal_avg
[IEEE80211_MAX_CHAINS
];
1076 struct rate_info txrate
;
1077 struct rate_info rxrate
;
1082 u32 rx_dropped_misc
;
1083 struct sta_bss_parameters bss_param
;
1084 struct nl80211_sta_flag_update sta_flags
;
1088 const u8
*assoc_req_ies
;
1089 size_t assoc_req_ies_len
;
1091 u32 beacon_loss_count
;
1093 enum nl80211_mesh_power_mode local_pm
;
1094 enum nl80211_mesh_power_mode peer_pm
;
1095 enum nl80211_mesh_power_mode nonpeer_pm
;
1097 u32 expected_throughput
;
1101 u8 rx_beacon_signal_avg
;
1102 struct cfg80211_tid_stats pertid
[IEEE80211_NUM_TIDS
+ 1];
1105 #if IS_ENABLED(CONFIG_CFG80211)
1107 * cfg80211_get_station - retrieve information about a given station
1108 * @dev: the device where the station is supposed to be connected to
1109 * @mac_addr: the mac address of the station of interest
1110 * @sinfo: pointer to the structure to fill with the information
1112 * Returns 0 on success and sinfo is filled with the available information
1113 * otherwise returns a negative error code and the content of sinfo has to be
1114 * considered undefined.
1116 int cfg80211_get_station(struct net_device
*dev
, const u8
*mac_addr
,
1117 struct station_info
*sinfo
);
1119 static inline int cfg80211_get_station(struct net_device
*dev
,
1121 struct station_info
*sinfo
)
1128 * enum monitor_flags - monitor flags
1130 * Monitor interface configuration flags. Note that these must be the bits
1131 * according to the nl80211 flags.
1133 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1134 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1135 * @MONITOR_FLAG_CONTROL: pass control frames
1136 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1137 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1138 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1140 enum monitor_flags
{
1141 MONITOR_FLAG_FCSFAIL
= 1<<NL80211_MNTR_FLAG_FCSFAIL
,
1142 MONITOR_FLAG_PLCPFAIL
= 1<<NL80211_MNTR_FLAG_PLCPFAIL
,
1143 MONITOR_FLAG_CONTROL
= 1<<NL80211_MNTR_FLAG_CONTROL
,
1144 MONITOR_FLAG_OTHER_BSS
= 1<<NL80211_MNTR_FLAG_OTHER_BSS
,
1145 MONITOR_FLAG_COOK_FRAMES
= 1<<NL80211_MNTR_FLAG_COOK_FRAMES
,
1146 MONITOR_FLAG_ACTIVE
= 1<<NL80211_MNTR_FLAG_ACTIVE
,
1150 * enum mpath_info_flags - mesh path information flags
1152 * Used by the driver to indicate which info in &struct mpath_info it has filled
1153 * in during get_station() or dump_station().
1155 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1156 * @MPATH_INFO_SN: @sn filled
1157 * @MPATH_INFO_METRIC: @metric filled
1158 * @MPATH_INFO_EXPTIME: @exptime filled
1159 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1160 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1161 * @MPATH_INFO_FLAGS: @flags filled
1163 enum mpath_info_flags
{
1164 MPATH_INFO_FRAME_QLEN
= BIT(0),
1165 MPATH_INFO_SN
= BIT(1),
1166 MPATH_INFO_METRIC
= BIT(2),
1167 MPATH_INFO_EXPTIME
= BIT(3),
1168 MPATH_INFO_DISCOVERY_TIMEOUT
= BIT(4),
1169 MPATH_INFO_DISCOVERY_RETRIES
= BIT(5),
1170 MPATH_INFO_FLAGS
= BIT(6),
1174 * struct mpath_info - mesh path information
1176 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1178 * @filled: bitfield of flags from &enum mpath_info_flags
1179 * @frame_qlen: number of queued frames for this destination
1180 * @sn: target sequence number
1181 * @metric: metric (cost) of this mesh path
1182 * @exptime: expiration time for the mesh path from now, in msecs
1183 * @flags: mesh path flags
1184 * @discovery_timeout: total mesh path discovery timeout, in msecs
1185 * @discovery_retries: mesh path discovery retries
1186 * @generation: generation number for nl80211 dumps.
1187 * This number should increase every time the list of mesh paths
1188 * changes, i.e. when a station is added or removed, so that
1189 * userspace can tell whether it got a consistent snapshot.
1197 u32 discovery_timeout
;
1198 u8 discovery_retries
;
1205 * struct bss_parameters - BSS parameters
1207 * Used to change BSS parameters (mainly for AP mode).
1209 * @use_cts_prot: Whether to use CTS protection
1210 * (0 = no, 1 = yes, -1 = do not change)
1211 * @use_short_preamble: Whether the use of short preambles is allowed
1212 * (0 = no, 1 = yes, -1 = do not change)
1213 * @use_short_slot_time: Whether the use of short slot time is allowed
1214 * (0 = no, 1 = yes, -1 = do not change)
1215 * @basic_rates: basic rates in IEEE 802.11 format
1216 * (or NULL for no change)
1217 * @basic_rates_len: number of basic rates
1218 * @ap_isolate: do not forward packets between connected stations
1219 * @ht_opmode: HT Operation mode
1220 * (u16 = opmode, -1 = do not change)
1221 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1222 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1224 struct bss_parameters
{
1226 int use_short_preamble
;
1227 int use_short_slot_time
;
1228 const u8
*basic_rates
;
1232 s8 p2p_ctwindow
, p2p_opp_ps
;
1236 * struct mesh_config - 802.11s mesh configuration
1238 * These parameters can be changed while the mesh is active.
1240 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1241 * by the Mesh Peering Open message
1242 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1243 * used by the Mesh Peering Open message
1244 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1245 * the mesh peering management to close a mesh peering
1246 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1248 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1249 * be sent to establish a new peer link instance in a mesh
1250 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1251 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1253 * @auto_open_plinks: whether we should automatically open peer links when we
1254 * detect compatible mesh peers
1255 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1256 * synchronize to for 11s default synchronization method
1257 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1258 * that an originator mesh STA can send to a particular path target
1259 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1260 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1261 * a path discovery in milliseconds
1262 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1263 * receiving a PREQ shall consider the forwarding information from the
1264 * root to be valid. (TU = time unit)
1265 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1266 * which a mesh STA can send only one action frame containing a PREQ
1268 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1269 * which a mesh STA can send only one Action frame containing a PERR
1271 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1272 * it takes for an HWMP information element to propagate across the mesh
1273 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1274 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1275 * announcements are transmitted
1276 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1277 * station has access to a broader network beyond the MBSS. (This is
1278 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1279 * only means that the station will announce others it's a mesh gate, but
1280 * not necessarily using the gate announcement protocol. Still keeping the
1281 * same nomenclature to be in sync with the spec)
1282 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1283 * entity (default is TRUE - forwarding entity)
1284 * @rssi_threshold: the threshold for average signal strength of candidate
1285 * station to establish a peer link
1286 * @ht_opmode: mesh HT protection mode
1288 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1289 * receiving a proactive PREQ shall consider the forwarding information to
1290 * the root mesh STA to be valid.
1292 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1293 * PREQs are transmitted.
1294 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1295 * during which a mesh STA can send only one Action frame containing
1296 * a PREQ element for root path confirmation.
1297 * @power_mode: The default mesh power save mode which will be the initial
1298 * setting for new peer links.
1299 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1300 * after transmitting its beacon.
1301 * @plink_timeout: If no tx activity is seen from a STA we've established
1302 * peering with for longer than this time (in seconds), then remove it
1303 * from the STA's list of peers. Default is 30 minutes.
1305 struct mesh_config
{
1306 u16 dot11MeshRetryTimeout
;
1307 u16 dot11MeshConfirmTimeout
;
1308 u16 dot11MeshHoldingTimeout
;
1309 u16 dot11MeshMaxPeerLinks
;
1310 u8 dot11MeshMaxRetries
;
1313 bool auto_open_plinks
;
1314 u32 dot11MeshNbrOffsetMaxNeighbor
;
1315 u8 dot11MeshHWMPmaxPREQretries
;
1316 u32 path_refresh_time
;
1317 u16 min_discovery_timeout
;
1318 u32 dot11MeshHWMPactivePathTimeout
;
1319 u16 dot11MeshHWMPpreqMinInterval
;
1320 u16 dot11MeshHWMPperrMinInterval
;
1321 u16 dot11MeshHWMPnetDiameterTraversalTime
;
1322 u8 dot11MeshHWMPRootMode
;
1323 u16 dot11MeshHWMPRannInterval
;
1324 bool dot11MeshGateAnnouncementProtocol
;
1325 bool dot11MeshForwarding
;
1328 u32 dot11MeshHWMPactivePathToRootTimeout
;
1329 u16 dot11MeshHWMProotInterval
;
1330 u16 dot11MeshHWMPconfirmationInterval
;
1331 enum nl80211_mesh_power_mode power_mode
;
1332 u16 dot11MeshAwakeWindowDuration
;
1337 * struct mesh_setup - 802.11s mesh setup configuration
1338 * @chandef: defines the channel to use
1339 * @mesh_id: the mesh ID
1340 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1341 * @sync_method: which synchronization method to use
1342 * @path_sel_proto: which path selection protocol to use
1343 * @path_metric: which metric to use
1344 * @auth_id: which authentication method this mesh is using
1345 * @ie: vendor information elements (optional)
1346 * @ie_len: length of vendor information elements
1347 * @is_authenticated: this mesh requires authentication
1348 * @is_secure: this mesh uses security
1349 * @user_mpm: userspace handles all MPM functions
1350 * @dtim_period: DTIM period to use
1351 * @beacon_interval: beacon interval to use
1352 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1353 * @basic_rates: basic rates to use when creating the mesh
1355 * These parameters are fixed when the mesh is created.
1358 struct cfg80211_chan_def chandef
;
1367 bool is_authenticated
;
1371 u16 beacon_interval
;
1372 int mcast_rate
[NUM_NL80211_BANDS
];
1377 * struct ocb_setup - 802.11p OCB mode setup configuration
1378 * @chandef: defines the channel to use
1380 * These parameters are fixed when connecting to the network
1383 struct cfg80211_chan_def chandef
;
1387 * struct ieee80211_txq_params - TX queue parameters
1388 * @ac: AC identifier
1389 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1390 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1392 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1394 * @aifs: Arbitration interframe space [0..255]
1396 struct ieee80211_txq_params
{
1405 * DOC: Scanning and BSS list handling
1407 * The scanning process itself is fairly simple, but cfg80211 offers quite
1408 * a bit of helper functionality. To start a scan, the scan operation will
1409 * be invoked with a scan definition. This scan definition contains the
1410 * channels to scan, and the SSIDs to send probe requests for (including the
1411 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1412 * probe. Additionally, a scan request may contain extra information elements
1413 * that should be added to the probe request. The IEs are guaranteed to be
1414 * well-formed, and will not exceed the maximum length the driver advertised
1415 * in the wiphy structure.
1417 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1418 * it is responsible for maintaining the BSS list; the driver should not
1419 * maintain a list itself. For this notification, various functions exist.
1421 * Since drivers do not maintain a BSS list, there are also a number of
1422 * functions to search for a BSS and obtain information about it from the
1423 * BSS structure cfg80211 maintains. The BSS list is also made available
1428 * struct cfg80211_ssid - SSID description
1430 * @ssid_len: length of the ssid
1432 struct cfg80211_ssid
{
1433 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
1438 * struct cfg80211_scan_info - information about completed scan
1439 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1440 * wireless device that requested the scan is connected to. If this
1441 * information is not available, this field is left zero.
1442 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1443 * @aborted: set to true if the scan was aborted for any reason,
1444 * userspace will be notified of that
1446 struct cfg80211_scan_info
{
1448 u8 tsf_bssid
[ETH_ALEN
] __aligned(2);
1453 * struct cfg80211_scan_request - scan request description
1455 * @ssids: SSIDs to scan for (active scan only)
1456 * @n_ssids: number of SSIDs
1457 * @channels: channels to scan on.
1458 * @n_channels: total number of channels to scan
1459 * @scan_width: channel width for scanning
1460 * @ie: optional information element(s) to add into Probe Request or %NULL
1461 * @ie_len: length of ie in octets
1462 * @duration: how long to listen on each channel, in TUs. If
1463 * %duration_mandatory is not set, this is the maximum dwell time and
1464 * the actual dwell time may be shorter.
1465 * @duration_mandatory: if set, the scan duration must be as specified by the
1467 * @flags: bit field of flags controlling operation
1468 * @rates: bitmap of rates to advertise for each band
1469 * @wiphy: the wiphy this was for
1470 * @scan_start: time (in jiffies) when the scan started
1471 * @wdev: the wireless device to scan for
1472 * @info: (internal) information about completed scan
1473 * @notified: (internal) scan request was notified as done or aborted
1474 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1475 * @mac_addr: MAC address used with randomisation
1476 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1477 * are 0 in the mask should be randomised, bits that are 1 should
1478 * be taken from the @mac_addr
1479 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1481 struct cfg80211_scan_request
{
1482 struct cfg80211_ssid
*ssids
;
1485 enum nl80211_bss_scan_width scan_width
;
1489 bool duration_mandatory
;
1492 u32 rates
[NUM_NL80211_BANDS
];
1494 struct wireless_dev
*wdev
;
1496 u8 mac_addr
[ETH_ALEN
] __aligned(2);
1497 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
1498 u8 bssid
[ETH_ALEN
] __aligned(2);
1501 struct wiphy
*wiphy
;
1502 unsigned long scan_start
;
1503 struct cfg80211_scan_info info
;
1508 struct ieee80211_channel
*channels
[0];
1511 static inline void get_random_mask_addr(u8
*buf
, const u8
*addr
, const u8
*mask
)
1515 get_random_bytes(buf
, ETH_ALEN
);
1516 for (i
= 0; i
< ETH_ALEN
; i
++) {
1518 buf
[i
] |= addr
[i
] & mask
[i
];
1523 * struct cfg80211_match_set - sets of attributes to match
1525 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1526 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1528 struct cfg80211_match_set
{
1529 struct cfg80211_ssid ssid
;
1534 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1536 * @interval: interval between scheduled scan iterations. In seconds.
1537 * @iterations: number of scan iterations in this scan plan. Zero means
1539 * The last scan plan will always have this parameter set to zero,
1540 * all other scan plans will have a finite number of iterations.
1542 struct cfg80211_sched_scan_plan
{
1548 * struct cfg80211_sched_scan_request - scheduled scan request description
1550 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1551 * @n_ssids: number of SSIDs
1552 * @n_channels: total number of channels to scan
1553 * @scan_width: channel width for scanning
1554 * @ie: optional information element(s) to add into Probe Request or %NULL
1555 * @ie_len: length of ie in octets
1556 * @flags: bit field of flags controlling operation
1557 * @match_sets: sets of parameters to be matched for a scan result
1558 * entry to be considered valid and to be passed to the host
1559 * (others are filtered out).
1560 * If ommited, all results are passed.
1561 * @n_match_sets: number of match sets
1562 * @wiphy: the wiphy this was for
1563 * @dev: the interface
1564 * @scan_start: start time of the scheduled scan
1565 * @channels: channels to scan
1566 * @min_rssi_thold: for drivers only supporting a single threshold, this
1567 * contains the minimum over all matchsets
1568 * @mac_addr: MAC address used with randomisation
1569 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1570 * are 0 in the mask should be randomised, bits that are 1 should
1571 * be taken from the @mac_addr
1572 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1573 * index must be executed first.
1574 * @n_scan_plans: number of scan plans, at least 1.
1575 * @rcu_head: RCU callback used to free the struct
1576 * @owner_nlportid: netlink portid of owner (if this should is a request
1577 * owned by a particular socket)
1578 * @delay: delay in seconds to use before starting the first scan
1579 * cycle. The driver may ignore this parameter and start
1580 * immediately (or at any other time), if this feature is not
1583 struct cfg80211_sched_scan_request
{
1584 struct cfg80211_ssid
*ssids
;
1587 enum nl80211_bss_scan_width scan_width
;
1591 struct cfg80211_match_set
*match_sets
;
1595 struct cfg80211_sched_scan_plan
*scan_plans
;
1598 u8 mac_addr
[ETH_ALEN
] __aligned(2);
1599 u8 mac_addr_mask
[ETH_ALEN
] __aligned(2);
1602 struct wiphy
*wiphy
;
1603 struct net_device
*dev
;
1604 unsigned long scan_start
;
1605 struct rcu_head rcu_head
;
1609 struct ieee80211_channel
*channels
[0];
1613 * enum cfg80211_signal_type - signal type
1615 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1616 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1617 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1619 enum cfg80211_signal_type
{
1620 CFG80211_SIGNAL_TYPE_NONE
,
1621 CFG80211_SIGNAL_TYPE_MBM
,
1622 CFG80211_SIGNAL_TYPE_UNSPEC
,
1626 * struct cfg80211_inform_bss - BSS inform data
1627 * @chan: channel the frame was received on
1628 * @scan_width: scan width that was used
1629 * @signal: signal strength value, according to the wiphy's
1631 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1632 * received; should match the time when the frame was actually
1633 * received by the device (not just by the host, in case it was
1634 * buffered on the device) and be accurate to about 10ms.
1635 * If the frame isn't buffered, just passing the return value of
1636 * ktime_get_boot_ns() is likely appropriate.
1637 * @parent_tsf: the time at the start of reception of the first octet of the
1638 * timestamp field of the frame. The time is the TSF of the BSS specified
1640 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1641 * the BSS that requested the scan in which the beacon/probe was received.
1643 struct cfg80211_inform_bss
{
1644 struct ieee80211_channel
*chan
;
1645 enum nl80211_bss_scan_width scan_width
;
1649 u8 parent_bssid
[ETH_ALEN
] __aligned(2);
1653 * struct cfg80211_bss_ies - BSS entry IE data
1654 * @tsf: TSF contained in the frame that carried these IEs
1655 * @rcu_head: internal use, for freeing
1656 * @len: length of the IEs
1657 * @from_beacon: these IEs are known to come from a beacon
1660 struct cfg80211_bss_ies
{
1662 struct rcu_head rcu_head
;
1669 * struct cfg80211_bss - BSS description
1671 * This structure describes a BSS (which may also be a mesh network)
1672 * for use in scan results and similar.
1674 * @channel: channel this BSS is on
1675 * @scan_width: width of the control channel
1676 * @bssid: BSSID of the BSS
1677 * @beacon_interval: the beacon interval as from the frame
1678 * @capability: the capability field in host byte order
1679 * @ies: the information elements (Note that there is no guarantee that these
1680 * are well-formed!); this is a pointer to either the beacon_ies or
1681 * proberesp_ies depending on whether Probe Response frame has been
1682 * received. It is always non-%NULL.
1683 * @beacon_ies: the information elements from the last Beacon frame
1684 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1685 * own the beacon_ies, but they're just pointers to the ones from the
1686 * @hidden_beacon_bss struct)
1687 * @proberesp_ies: the information elements from the last Probe Response frame
1688 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1689 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1690 * that holds the beacon data. @beacon_ies is still valid, of course, and
1691 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1692 * @signal: signal strength value (type depends on the wiphy's signal_type)
1693 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1695 struct cfg80211_bss
{
1696 struct ieee80211_channel
*channel
;
1697 enum nl80211_bss_scan_width scan_width
;
1699 const struct cfg80211_bss_ies __rcu
*ies
;
1700 const struct cfg80211_bss_ies __rcu
*beacon_ies
;
1701 const struct cfg80211_bss_ies __rcu
*proberesp_ies
;
1703 struct cfg80211_bss
*hidden_beacon_bss
;
1707 u16 beacon_interval
;
1712 u8 priv
[0] __aligned(sizeof(void *));
1716 * ieee80211_bss_get_ie - find IE with given ID
1717 * @bss: the bss to search
1720 * Note that the return value is an RCU-protected pointer, so
1721 * rcu_read_lock() must be held when calling this function.
1722 * Return: %NULL if not found.
1724 const u8
*ieee80211_bss_get_ie(struct cfg80211_bss
*bss
, u8 ie
);
1728 * struct cfg80211_auth_request - Authentication request data
1730 * This structure provides information needed to complete IEEE 802.11
1733 * @bss: The BSS to authenticate with, the callee must obtain a reference
1734 * to it if it needs to keep it.
1735 * @auth_type: Authentication type (algorithm)
1736 * @ie: Extra IEs to add to Authentication frame or %NULL
1737 * @ie_len: Length of ie buffer in octets
1738 * @key_len: length of WEP key for shared key authentication
1739 * @key_idx: index of WEP key for shared key authentication
1740 * @key: WEP key for shared key authentication
1741 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1742 * Authentication transaction sequence number field.
1743 * @sae_data_len: Length of sae_data buffer in octets
1745 struct cfg80211_auth_request
{
1746 struct cfg80211_bss
*bss
;
1749 enum nl80211_auth_type auth_type
;
1751 u8 key_len
, key_idx
;
1753 size_t sae_data_len
;
1757 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1759 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1760 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1761 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1763 enum cfg80211_assoc_req_flags
{
1764 ASSOC_REQ_DISABLE_HT
= BIT(0),
1765 ASSOC_REQ_DISABLE_VHT
= BIT(1),
1766 ASSOC_REQ_USE_RRM
= BIT(2),
1770 * struct cfg80211_assoc_request - (Re)Association request data
1772 * This structure provides information needed to complete IEEE 802.11
1774 * @bss: The BSS to associate with. If the call is successful the driver is
1775 * given a reference that it must give back to cfg80211_send_rx_assoc()
1776 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1777 * association requests while already associating must be rejected.
1778 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1779 * @ie_len: Length of ie buffer in octets
1780 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1781 * @crypto: crypto settings
1782 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1783 * to indicate a request to reassociate within the ESS instead of a request
1784 * do the initial association with the ESS. When included, this is set to
1785 * the BSSID of the current association, i.e., to the value that is
1786 * included in the Current AP address field of the Reassociation Request
1788 * @flags: See &enum cfg80211_assoc_req_flags
1789 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1790 * will be used in ht_capa. Un-supported values will be ignored.
1791 * @ht_capa_mask: The bits of ht_capa which are to be used.
1792 * @vht_capa: VHT capability override
1793 * @vht_capa_mask: VHT capability mask indicating which fields to use
1795 struct cfg80211_assoc_request
{
1796 struct cfg80211_bss
*bss
;
1797 const u8
*ie
, *prev_bssid
;
1799 struct cfg80211_crypto_settings crypto
;
1802 struct ieee80211_ht_cap ht_capa
;
1803 struct ieee80211_ht_cap ht_capa_mask
;
1804 struct ieee80211_vht_cap vht_capa
, vht_capa_mask
;
1808 * struct cfg80211_deauth_request - Deauthentication request data
1810 * This structure provides information needed to complete IEEE 802.11
1813 * @bssid: the BSSID of the BSS to deauthenticate from
1814 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1815 * @ie_len: Length of ie buffer in octets
1816 * @reason_code: The reason code for the deauthentication
1817 * @local_state_change: if set, change local state only and
1818 * do not set a deauth frame
1820 struct cfg80211_deauth_request
{
1825 bool local_state_change
;
1829 * struct cfg80211_disassoc_request - Disassociation request data
1831 * This structure provides information needed to complete IEEE 802.11
1834 * @bss: the BSS to disassociate from
1835 * @ie: Extra IEs to add to Disassociation frame or %NULL
1836 * @ie_len: Length of ie buffer in octets
1837 * @reason_code: The reason code for the disassociation
1838 * @local_state_change: This is a request for a local state only, i.e., no
1839 * Disassociation frame is to be transmitted.
1841 struct cfg80211_disassoc_request
{
1842 struct cfg80211_bss
*bss
;
1846 bool local_state_change
;
1850 * struct cfg80211_ibss_params - IBSS parameters
1852 * This structure defines the IBSS parameters for the join_ibss()
1855 * @ssid: The SSID, will always be non-null.
1856 * @ssid_len: The length of the SSID, will always be non-zero.
1857 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1858 * search for IBSSs with a different BSSID.
1859 * @chandef: defines the channel to use if no other IBSS to join can be found
1860 * @channel_fixed: The channel should be fixed -- do not search for
1861 * IBSSs to join on other channels.
1862 * @ie: information element(s) to include in the beacon
1863 * @ie_len: length of that
1864 * @beacon_interval: beacon interval to use
1865 * @privacy: this is a protected network, keys will be configured
1867 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1868 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1869 * required to assume that the port is unauthorized until authorized by
1870 * user space. Otherwise, port is marked authorized by default.
1871 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1872 * changes the channel when a radar is detected. This is required
1873 * to operate on DFS channels.
1874 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1875 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1876 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1877 * will be used in ht_capa. Un-supported values will be ignored.
1878 * @ht_capa_mask: The bits of ht_capa which are to be used.
1880 struct cfg80211_ibss_params
{
1883 struct cfg80211_chan_def chandef
;
1885 u8 ssid_len
, ie_len
;
1886 u16 beacon_interval
;
1891 bool userspace_handles_dfs
;
1892 int mcast_rate
[NUM_NL80211_BANDS
];
1893 struct ieee80211_ht_cap ht_capa
;
1894 struct ieee80211_ht_cap ht_capa_mask
;
1898 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1900 * @band: band of BSS which should match for RSSI level adjustment.
1901 * @delta: value of RSSI level adjustment.
1903 struct cfg80211_bss_select_adjust
{
1904 enum nl80211_band band
;
1909 * struct cfg80211_bss_selection - connection parameters for BSS selection.
1911 * @behaviour: requested BSS selection behaviour.
1912 * @param: parameters for requestion behaviour.
1913 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
1914 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
1916 struct cfg80211_bss_selection
{
1917 enum nl80211_bss_select_attr behaviour
;
1919 enum nl80211_band band_pref
;
1920 struct cfg80211_bss_select_adjust adjust
;
1925 * struct cfg80211_connect_params - Connection parameters
1927 * This structure provides information needed to complete IEEE 802.11
1928 * authentication and association.
1930 * @channel: The channel to use or %NULL if not specified (auto-select based
1932 * @channel_hint: The channel of the recommended BSS for initial connection or
1933 * %NULL if not specified
1934 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1936 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1937 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1938 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1941 * @ssid_len: Length of ssid in octets
1942 * @auth_type: Authentication type (algorithm)
1943 * @ie: IEs for association request
1944 * @ie_len: Length of assoc_ie in octets
1945 * @privacy: indicates whether privacy-enabled APs should be used
1946 * @mfp: indicate whether management frame protection is used
1947 * @crypto: crypto settings
1948 * @key_len: length of WEP key for shared key authentication
1949 * @key_idx: index of WEP key for shared key authentication
1950 * @key: WEP key for shared key authentication
1951 * @flags: See &enum cfg80211_assoc_req_flags
1952 * @bg_scan_period: Background scan period in seconds
1953 * or -1 to indicate that default value is to be used.
1954 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1955 * will be used in ht_capa. Un-supported values will be ignored.
1956 * @ht_capa_mask: The bits of ht_capa which are to be used.
1957 * @vht_capa: VHT Capability overrides
1958 * @vht_capa_mask: The bits of vht_capa which are to be used.
1959 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
1961 * @bss_select: criteria to be used for BSS selection.
1962 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1963 * to indicate a request to reassociate within the ESS instead of a request
1964 * do the initial association with the ESS. When included, this is set to
1965 * the BSSID of the current association, i.e., to the value that is
1966 * included in the Current AP address field of the Reassociation Request
1969 struct cfg80211_connect_params
{
1970 struct ieee80211_channel
*channel
;
1971 struct ieee80211_channel
*channel_hint
;
1973 const u8
*bssid_hint
;
1976 enum nl80211_auth_type auth_type
;
1980 enum nl80211_mfp mfp
;
1981 struct cfg80211_crypto_settings crypto
;
1983 u8 key_len
, key_idx
;
1986 struct ieee80211_ht_cap ht_capa
;
1987 struct ieee80211_ht_cap ht_capa_mask
;
1988 struct ieee80211_vht_cap vht_capa
;
1989 struct ieee80211_vht_cap vht_capa_mask
;
1991 struct cfg80211_bss_selection bss_select
;
1992 const u8
*prev_bssid
;
1996 * enum wiphy_params_flags - set_wiphy_params bitfield values
1997 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1998 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1999 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2000 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2001 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2002 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2004 enum wiphy_params_flags
{
2005 WIPHY_PARAM_RETRY_SHORT
= 1 << 0,
2006 WIPHY_PARAM_RETRY_LONG
= 1 << 1,
2007 WIPHY_PARAM_FRAG_THRESHOLD
= 1 << 2,
2008 WIPHY_PARAM_RTS_THRESHOLD
= 1 << 3,
2009 WIPHY_PARAM_COVERAGE_CLASS
= 1 << 4,
2010 WIPHY_PARAM_DYN_ACK
= 1 << 5,
2014 * cfg80211_bitrate_mask - masks for bitrate control
2016 struct cfg80211_bitrate_mask
{
2019 u8 ht_mcs
[IEEE80211_HT_MCS_MASK_LEN
];
2020 u16 vht_mcs
[NL80211_VHT_NSS_MAX
];
2021 enum nl80211_txrate_gi gi
;
2022 } control
[NUM_NL80211_BANDS
];
2025 * struct cfg80211_pmksa - PMK Security Association
2027 * This structure is passed to the set/del_pmksa() method for PMKSA
2030 * @bssid: The AP's BSSID.
2031 * @pmkid: The PMK material itself.
2033 struct cfg80211_pmksa
{
2039 * struct cfg80211_pkt_pattern - packet pattern
2040 * @mask: bitmask where to match pattern and where to ignore bytes,
2041 * one bit per byte, in same format as nl80211
2042 * @pattern: bytes to match where bitmask is 1
2043 * @pattern_len: length of pattern (in bytes)
2044 * @pkt_offset: packet offset (in bytes)
2046 * Internal note: @mask and @pattern are allocated in one chunk of
2047 * memory, free @mask only!
2049 struct cfg80211_pkt_pattern
{
2050 const u8
*mask
, *pattern
;
2056 * struct cfg80211_wowlan_tcp - TCP connection parameters
2058 * @sock: (internal) socket for source port allocation
2059 * @src: source IP address
2060 * @dst: destination IP address
2061 * @dst_mac: destination MAC address
2062 * @src_port: source port
2063 * @dst_port: destination port
2064 * @payload_len: data payload length
2065 * @payload: data payload buffer
2066 * @payload_seq: payload sequence stamping configuration
2067 * @data_interval: interval at which to send data packets
2068 * @wake_len: wakeup payload match length
2069 * @wake_data: wakeup payload match data
2070 * @wake_mask: wakeup payload match mask
2071 * @tokens_size: length of the tokens buffer
2072 * @payload_tok: payload token usage configuration
2074 struct cfg80211_wowlan_tcp
{
2075 struct socket
*sock
;
2077 u16 src_port
, dst_port
;
2078 u8 dst_mac
[ETH_ALEN
];
2081 struct nl80211_wowlan_tcp_data_seq payload_seq
;
2084 const u8
*wake_data
, *wake_mask
;
2086 /* must be last, variable member */
2087 struct nl80211_wowlan_tcp_data_token payload_tok
;
2091 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2093 * This structure defines the enabled WoWLAN triggers for the device.
2094 * @any: wake up on any activity -- special trigger if device continues
2095 * operating as normal during suspend
2096 * @disconnect: wake up if getting disconnected
2097 * @magic_pkt: wake up on receiving magic packet
2098 * @patterns: wake up on receiving packet matching a pattern
2099 * @n_patterns: number of patterns
2100 * @gtk_rekey_failure: wake up on GTK rekey failure
2101 * @eap_identity_req: wake up on EAP identity request packet
2102 * @four_way_handshake: wake up on 4-way handshake
2103 * @rfkill_release: wake up when rfkill is released
2104 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2105 * NULL if not configured.
2106 * @nd_config: configuration for the scan to be used for net detect wake.
2108 struct cfg80211_wowlan
{
2109 bool any
, disconnect
, magic_pkt
, gtk_rekey_failure
,
2110 eap_identity_req
, four_way_handshake
,
2112 struct cfg80211_pkt_pattern
*patterns
;
2113 struct cfg80211_wowlan_tcp
*tcp
;
2115 struct cfg80211_sched_scan_request
*nd_config
;
2119 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2121 * This structure defines coalesce rule for the device.
2122 * @delay: maximum coalescing delay in msecs.
2123 * @condition: condition for packet coalescence.
2124 * see &enum nl80211_coalesce_condition.
2125 * @patterns: array of packet patterns
2126 * @n_patterns: number of patterns
2128 struct cfg80211_coalesce_rules
{
2130 enum nl80211_coalesce_condition condition
;
2131 struct cfg80211_pkt_pattern
*patterns
;
2136 * struct cfg80211_coalesce - Packet coalescing settings
2138 * This structure defines coalescing settings.
2139 * @rules: array of coalesce rules
2140 * @n_rules: number of rules
2142 struct cfg80211_coalesce
{
2143 struct cfg80211_coalesce_rules
*rules
;
2148 * struct cfg80211_wowlan_nd_match - information about the match
2150 * @ssid: SSID of the match that triggered the wake up
2151 * @n_channels: Number of channels where the match occurred. This
2152 * value may be zero if the driver can't report the channels.
2153 * @channels: center frequencies of the channels where a match
2156 struct cfg80211_wowlan_nd_match
{
2157 struct cfg80211_ssid ssid
;
2163 * struct cfg80211_wowlan_nd_info - net detect wake up information
2165 * @n_matches: Number of match information instances provided in
2166 * @matches. This value may be zero if the driver can't provide
2167 * match information.
2168 * @matches: Array of pointers to matches containing information about
2169 * the matches that triggered the wake up.
2171 struct cfg80211_wowlan_nd_info
{
2173 struct cfg80211_wowlan_nd_match
*matches
[];
2177 * struct cfg80211_wowlan_wakeup - wakeup report
2178 * @disconnect: woke up by getting disconnected
2179 * @magic_pkt: woke up by receiving magic packet
2180 * @gtk_rekey_failure: woke up by GTK rekey failure
2181 * @eap_identity_req: woke up by EAP identity request packet
2182 * @four_way_handshake: woke up by 4-way handshake
2183 * @rfkill_release: woke up by rfkill being released
2184 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2185 * @packet_present_len: copied wakeup packet data
2186 * @packet_len: original wakeup packet length
2187 * @packet: The packet causing the wakeup, if any.
2188 * @packet_80211: For pattern match, magic packet and other data
2189 * frame triggers an 802.3 frame should be reported, for
2190 * disconnect due to deauth 802.11 frame. This indicates which
2192 * @tcp_match: TCP wakeup packet received
2193 * @tcp_connlost: TCP connection lost or failed to establish
2194 * @tcp_nomoretokens: TCP data ran out of tokens
2195 * @net_detect: if not %NULL, woke up because of net detect
2197 struct cfg80211_wowlan_wakeup
{
2198 bool disconnect
, magic_pkt
, gtk_rekey_failure
,
2199 eap_identity_req
, four_way_handshake
,
2200 rfkill_release
, packet_80211
,
2201 tcp_match
, tcp_connlost
, tcp_nomoretokens
;
2203 u32 packet_present_len
, packet_len
;
2205 struct cfg80211_wowlan_nd_info
*net_detect
;
2209 * struct cfg80211_gtk_rekey_data - rekey data
2210 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2211 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2212 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2214 struct cfg80211_gtk_rekey_data
{
2215 const u8
*kek
, *kck
, *replay_ctr
;
2219 * struct cfg80211_update_ft_ies_params - FT IE Information
2221 * This structure provides information needed to update the fast transition IE
2223 * @md: The Mobility Domain ID, 2 Octet value
2224 * @ie: Fast Transition IEs
2225 * @ie_len: Length of ft_ie in octets
2227 struct cfg80211_update_ft_ies_params
{
2234 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2236 * This structure provides information needed to transmit a mgmt frame
2238 * @chan: channel to use
2239 * @offchan: indicates wether off channel operation is required
2240 * @wait: duration for ROC
2241 * @buf: buffer to transmit
2242 * @len: buffer length
2243 * @no_cck: don't use cck rates for this frame
2244 * @dont_wait_for_ack: tells the low level not to wait for an ack
2245 * @n_csa_offsets: length of csa_offsets array
2246 * @csa_offsets: array of all the csa offsets in the frame
2248 struct cfg80211_mgmt_tx_params
{
2249 struct ieee80211_channel
*chan
;
2255 bool dont_wait_for_ack
;
2257 const u16
*csa_offsets
;
2261 * struct cfg80211_dscp_exception - DSCP exception
2263 * @dscp: DSCP value that does not adhere to the user priority range definition
2264 * @up: user priority value to which the corresponding DSCP value belongs
2266 struct cfg80211_dscp_exception
{
2272 * struct cfg80211_dscp_range - DSCP range definition for user priority
2274 * @low: lowest DSCP value of this user priority range, inclusive
2275 * @high: highest DSCP value of this user priority range, inclusive
2277 struct cfg80211_dscp_range
{
2282 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2283 #define IEEE80211_QOS_MAP_MAX_EX 21
2284 #define IEEE80211_QOS_MAP_LEN_MIN 16
2285 #define IEEE80211_QOS_MAP_LEN_MAX \
2286 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2289 * struct cfg80211_qos_map - QoS Map Information
2291 * This struct defines the Interworking QoS map setting for DSCP values
2293 * @num_des: number of DSCP exceptions (0..21)
2294 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2295 * the user priority DSCP range definition
2296 * @up: DSCP range definition for a particular user priority
2298 struct cfg80211_qos_map
{
2300 struct cfg80211_dscp_exception dscp_exception
[IEEE80211_QOS_MAP_MAX_EX
];
2301 struct cfg80211_dscp_range up
[8];
2305 * struct cfg80211_ops - backend description for wireless configuration
2307 * This struct is registered by fullmac card drivers and/or wireless stacks
2308 * in order to handle configuration requests on their interfaces.
2310 * All callbacks except where otherwise noted should return 0
2311 * on success or a negative error code.
2313 * All operations are currently invoked under rtnl for consistency with the
2314 * wireless extensions but this is subject to reevaluation as soon as this
2315 * code is used more widely and we have a first user without wext.
2317 * @suspend: wiphy device needs to be suspended. The variable @wow will
2318 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2319 * configured for the device.
2320 * @resume: wiphy device needs to be resumed
2321 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2322 * to call device_set_wakeup_enable() to enable/disable wakeup from
2325 * @add_virtual_intf: create a new virtual interface with the given name,
2326 * must set the struct wireless_dev's iftype. Beware: You must create
2327 * the new netdev in the wiphy's network namespace! Returns the struct
2328 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2329 * also set the address member in the wdev.
2331 * @del_virtual_intf: remove the virtual interface
2333 * @change_virtual_intf: change type/configuration of virtual interface,
2334 * keep the struct wireless_dev's iftype updated.
2336 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2337 * when adding a group key.
2339 * @get_key: get information about the key with the given parameters.
2340 * @mac_addr will be %NULL when requesting information for a group
2341 * key. All pointers given to the @callback function need not be valid
2342 * after it returns. This function should return an error if it is
2343 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2345 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2346 * and @key_index, return -ENOENT if the key doesn't exist.
2348 * @set_default_key: set the default key on an interface
2350 * @set_default_mgmt_key: set the default management frame key on an interface
2352 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2354 * @start_ap: Start acting in AP mode defined by the parameters.
2355 * @change_beacon: Change the beacon parameters for an access point mode
2356 * interface. This should reject the call when AP mode wasn't started.
2357 * @stop_ap: Stop being an AP, including stopping beaconing.
2359 * @add_station: Add a new station.
2360 * @del_station: Remove a station
2361 * @change_station: Modify a given station. Note that flags changes are not much
2362 * validated in cfg80211, in particular the auth/assoc/authorized flags
2363 * might come to the driver in invalid combinations -- make sure to check
2364 * them, also against the existing state! Drivers must call
2365 * cfg80211_check_station_change() to validate the information.
2366 * @get_station: get station information for the station identified by @mac
2367 * @dump_station: dump station callback -- resume dump at index @idx
2369 * @add_mpath: add a fixed mesh path
2370 * @del_mpath: delete a given mesh path
2371 * @change_mpath: change a given mesh path
2372 * @get_mpath: get a mesh path for the given parameters
2373 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2374 * @get_mpp: get a mesh proxy path for the given parameters
2375 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2376 * @join_mesh: join the mesh network with the specified parameters
2377 * (invoked with the wireless_dev mutex held)
2378 * @leave_mesh: leave the current mesh network
2379 * (invoked with the wireless_dev mutex held)
2381 * @get_mesh_config: Get the current mesh configuration
2383 * @update_mesh_config: Update mesh parameters on a running mesh.
2384 * The mask is a bitfield which tells us which parameters to
2385 * set, and which to leave alone.
2387 * @change_bss: Modify parameters for a given BSS.
2389 * @set_txq_params: Set TX queue parameters
2391 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2392 * as it doesn't implement join_mesh and needs to set the channel to
2393 * join the mesh instead.
2395 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2396 * interfaces are active this callback should reject the configuration.
2397 * If no interfaces are active or the device is down, the channel should
2398 * be stored for when a monitor interface becomes active.
2400 * @scan: Request to do a scan. If returning zero, the scan request is given
2401 * the driver, and will be valid until passed to cfg80211_scan_done().
2402 * For scan results, call cfg80211_inform_bss(); you can call this outside
2403 * the scan/scan_done bracket too.
2404 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2405 * indicate the status of the scan through cfg80211_scan_done().
2407 * @auth: Request to authenticate with the specified peer
2408 * (invoked with the wireless_dev mutex held)
2409 * @assoc: Request to (re)associate with the specified peer
2410 * (invoked with the wireless_dev mutex held)
2411 * @deauth: Request to deauthenticate from the specified peer
2412 * (invoked with the wireless_dev mutex held)
2413 * @disassoc: Request to disassociate from the specified peer
2414 * (invoked with the wireless_dev mutex held)
2416 * @connect: Connect to the ESS with the specified parameters. When connected,
2417 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2418 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2419 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2420 * from the AP or cfg80211_connect_timeout() if no frame with status code
2422 * The driver is allowed to roam to other BSSes within the ESS when the
2423 * other BSS matches the connect parameters. When such roaming is initiated
2424 * by the driver, the driver is expected to verify that the target matches
2425 * the configured security parameters and to use Reassociation Request
2426 * frame instead of Association Request frame.
2427 * The connect function can also be used to request the driver to perform a
2428 * specific roam when connected to an ESS. In that case, the prev_bssid
2429 * parameter is set to the BSSID of the currently associated BSS as an
2430 * indication of requesting reassociation.
2431 * In both the driver-initiated and new connect() call initiated roaming
2432 * cases, the result of roaming is indicated with a call to
2433 * cfg80211_roamed() or cfg80211_roamed_bss().
2434 * (invoked with the wireless_dev mutex held)
2435 * @disconnect: Disconnect from the BSS/ESS. Once done, call
2436 * cfg80211_disconnected().
2437 * (invoked with the wireless_dev mutex held)
2439 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2440 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2442 * (invoked with the wireless_dev mutex held)
2443 * @leave_ibss: Leave the IBSS.
2444 * (invoked with the wireless_dev mutex held)
2446 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2449 * @set_wiphy_params: Notify that wiphy parameters have changed;
2450 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2451 * have changed. The actual parameter values are available in
2452 * struct wiphy. If returning an error, no value should be changed.
2454 * @set_tx_power: set the transmit power according to the parameters,
2455 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2456 * wdev may be %NULL if power was set for the wiphy, and will
2457 * always be %NULL unless the driver supports per-vif TX power
2458 * (as advertised by the nl80211 feature flag.)
2459 * @get_tx_power: store the current TX power into the dbm variable;
2460 * return 0 if successful
2462 * @set_wds_peer: set the WDS peer for a WDS interface
2464 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2465 * functions to adjust rfkill hw state
2467 * @dump_survey: get site survey information.
2469 * @remain_on_channel: Request the driver to remain awake on the specified
2470 * channel for the specified duration to complete an off-channel
2471 * operation (e.g., public action frame exchange). When the driver is
2472 * ready on the requested channel, it must indicate this with an event
2473 * notification by calling cfg80211_ready_on_channel().
2474 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2475 * This allows the operation to be terminated prior to timeout based on
2476 * the duration value.
2477 * @mgmt_tx: Transmit a management frame.
2478 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2479 * frame on another channel
2481 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2482 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2483 * used by the function, but 0 and 1 must not be touched. Additionally,
2484 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2485 * dump and return to userspace with an error, so be careful. If any data
2486 * was passed in from userspace then the data/len arguments will be present
2487 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2489 * @set_bitrate_mask: set the bitrate mask configuration
2491 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2492 * devices running firmwares capable of generating the (re) association
2493 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2494 * @del_pmksa: Delete a cached PMKID.
2495 * @flush_pmksa: Flush all cached PMKIDs.
2496 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2497 * allows the driver to adjust the dynamic ps timeout value.
2498 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2499 * After configuration, the driver should (soon) send an event indicating
2500 * the current level is above/below the configured threshold; this may
2501 * need some care when the configuration is changed (without first being
2503 * @set_cqm_txe_config: Configure connection quality monitor TX error
2505 * @sched_scan_start: Tell the driver to start a scheduled scan.
2506 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2507 * call must stop the scheduled scan and be ready for starting a new one
2508 * before it returns, i.e. @sched_scan_start may be called immediately
2509 * after that again and should not fail in that case. The driver should
2510 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2511 * method returns 0.)
2513 * @mgmt_frame_register: Notify driver that a management frame type was
2514 * registered. The callback is allowed to sleep.
2516 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2517 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2518 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2519 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2521 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2523 * @tdls_mgmt: Transmit a TDLS management frame.
2524 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2526 * @probe_client: probe an associated client, must return a cookie that it
2527 * later passes to cfg80211_probe_status().
2529 * @set_noack_map: Set the NoAck Map for the TIDs.
2531 * @get_channel: Get the current operating channel for the virtual interface.
2532 * For monitor interfaces, it should return %NULL unless there's a single
2533 * current monitoring channel.
2535 * @start_p2p_device: Start the given P2P device.
2536 * @stop_p2p_device: Stop the given P2P device.
2538 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2539 * Parameters include ACL policy, an array of MAC address of stations
2540 * and the number of MAC addresses. If there is already a list in driver
2541 * this new list replaces the existing one. Driver has to clear its ACL
2542 * when number of MAC addresses entries is passed as 0. Drivers which
2543 * advertise the support for MAC based ACL have to implement this callback.
2545 * @start_radar_detection: Start radar detection in the driver.
2547 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2548 * driver. If the SME is in the driver/firmware, this information can be
2549 * used in building Authentication and Reassociation Request frames.
2551 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2552 * for a given duration (milliseconds). The protocol is provided so the
2553 * driver can take the most appropriate actions.
2554 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2555 * reliability. This operation can not fail.
2556 * @set_coalesce: Set coalesce parameters.
2558 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2559 * responsible for veryfing if the switch is possible. Since this is
2560 * inherently tricky driver may decide to disconnect an interface later
2561 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2562 * everything. It should do it's best to verify requests and reject them
2563 * as soon as possible.
2565 * @set_qos_map: Set QoS mapping information to the driver
2567 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2568 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2569 * changes during the lifetime of the BSS.
2571 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2572 * with the given parameters; action frame exchange has been handled by
2573 * userspace so this just has to modify the TX path to take the TS into
2575 * If the admitted time is 0 just validate the parameters to make sure
2576 * the session can be created at all; it is valid to just always return
2577 * success for that but that may result in inefficient behaviour (handshake
2578 * with the peer followed by immediate teardown when the addition is later
2580 * @del_tx_ts: remove an existing TX TS
2582 * @join_ocb: join the OCB network with the specified parameters
2583 * (invoked with the wireless_dev mutex held)
2584 * @leave_ocb: leave the current OCB network
2585 * (invoked with the wireless_dev mutex held)
2587 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2588 * is responsible for continually initiating channel-switching operations
2589 * and returning to the base channel for communication with the AP.
2590 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2591 * peers must be on the base channel when the call completes.
2593 struct cfg80211_ops
{
2594 int (*suspend
)(struct wiphy
*wiphy
, struct cfg80211_wowlan
*wow
);
2595 int (*resume
)(struct wiphy
*wiphy
);
2596 void (*set_wakeup
)(struct wiphy
*wiphy
, bool enabled
);
2598 struct wireless_dev
* (*add_virtual_intf
)(struct wiphy
*wiphy
,
2600 unsigned char name_assign_type
,
2601 enum nl80211_iftype type
,
2603 struct vif_params
*params
);
2604 int (*del_virtual_intf
)(struct wiphy
*wiphy
,
2605 struct wireless_dev
*wdev
);
2606 int (*change_virtual_intf
)(struct wiphy
*wiphy
,
2607 struct net_device
*dev
,
2608 enum nl80211_iftype type
, u32
*flags
,
2609 struct vif_params
*params
);
2611 int (*add_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2612 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
2613 struct key_params
*params
);
2614 int (*get_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2615 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
2617 void (*callback
)(void *cookie
, struct key_params
*));
2618 int (*del_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2619 u8 key_index
, bool pairwise
, const u8
*mac_addr
);
2620 int (*set_default_key
)(struct wiphy
*wiphy
,
2621 struct net_device
*netdev
,
2622 u8 key_index
, bool unicast
, bool multicast
);
2623 int (*set_default_mgmt_key
)(struct wiphy
*wiphy
,
2624 struct net_device
*netdev
,
2627 int (*start_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2628 struct cfg80211_ap_settings
*settings
);
2629 int (*change_beacon
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2630 struct cfg80211_beacon_data
*info
);
2631 int (*stop_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2634 int (*add_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2636 struct station_parameters
*params
);
2637 int (*del_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2638 struct station_del_parameters
*params
);
2639 int (*change_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2641 struct station_parameters
*params
);
2642 int (*get_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2643 const u8
*mac
, struct station_info
*sinfo
);
2644 int (*dump_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2645 int idx
, u8
*mac
, struct station_info
*sinfo
);
2647 int (*add_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2648 const u8
*dst
, const u8
*next_hop
);
2649 int (*del_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2651 int (*change_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2652 const u8
*dst
, const u8
*next_hop
);
2653 int (*get_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2654 u8
*dst
, u8
*next_hop
, struct mpath_info
*pinfo
);
2655 int (*dump_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2656 int idx
, u8
*dst
, u8
*next_hop
,
2657 struct mpath_info
*pinfo
);
2658 int (*get_mpp
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2659 u8
*dst
, u8
*mpp
, struct mpath_info
*pinfo
);
2660 int (*dump_mpp
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2661 int idx
, u8
*dst
, u8
*mpp
,
2662 struct mpath_info
*pinfo
);
2663 int (*get_mesh_config
)(struct wiphy
*wiphy
,
2664 struct net_device
*dev
,
2665 struct mesh_config
*conf
);
2666 int (*update_mesh_config
)(struct wiphy
*wiphy
,
2667 struct net_device
*dev
, u32 mask
,
2668 const struct mesh_config
*nconf
);
2669 int (*join_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2670 const struct mesh_config
*conf
,
2671 const struct mesh_setup
*setup
);
2672 int (*leave_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2674 int (*join_ocb
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2675 struct ocb_setup
*setup
);
2676 int (*leave_ocb
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2678 int (*change_bss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2679 struct bss_parameters
*params
);
2681 int (*set_txq_params
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2682 struct ieee80211_txq_params
*params
);
2684 int (*libertas_set_mesh_channel
)(struct wiphy
*wiphy
,
2685 struct net_device
*dev
,
2686 struct ieee80211_channel
*chan
);
2688 int (*set_monitor_channel
)(struct wiphy
*wiphy
,
2689 struct cfg80211_chan_def
*chandef
);
2691 int (*scan
)(struct wiphy
*wiphy
,
2692 struct cfg80211_scan_request
*request
);
2693 void (*abort_scan
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
);
2695 int (*auth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2696 struct cfg80211_auth_request
*req
);
2697 int (*assoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2698 struct cfg80211_assoc_request
*req
);
2699 int (*deauth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2700 struct cfg80211_deauth_request
*req
);
2701 int (*disassoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2702 struct cfg80211_disassoc_request
*req
);
2704 int (*connect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2705 struct cfg80211_connect_params
*sme
);
2706 int (*disconnect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2709 int (*join_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2710 struct cfg80211_ibss_params
*params
);
2711 int (*leave_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2713 int (*set_mcast_rate
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2714 int rate
[NUM_NL80211_BANDS
]);
2716 int (*set_wiphy_params
)(struct wiphy
*wiphy
, u32 changed
);
2718 int (*set_tx_power
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
2719 enum nl80211_tx_power_setting type
, int mbm
);
2720 int (*get_tx_power
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
2723 int (*set_wds_peer
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2726 void (*rfkill_poll
)(struct wiphy
*wiphy
);
2728 #ifdef CONFIG_NL80211_TESTMODE
2729 int (*testmode_cmd
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
2730 void *data
, int len
);
2731 int (*testmode_dump
)(struct wiphy
*wiphy
, struct sk_buff
*skb
,
2732 struct netlink_callback
*cb
,
2733 void *data
, int len
);
2736 int (*set_bitrate_mask
)(struct wiphy
*wiphy
,
2737 struct net_device
*dev
,
2739 const struct cfg80211_bitrate_mask
*mask
);
2741 int (*dump_survey
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2742 int idx
, struct survey_info
*info
);
2744 int (*set_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2745 struct cfg80211_pmksa
*pmksa
);
2746 int (*del_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
2747 struct cfg80211_pmksa
*pmksa
);
2748 int (*flush_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
);
2750 int (*remain_on_channel
)(struct wiphy
*wiphy
,
2751 struct wireless_dev
*wdev
,
2752 struct ieee80211_channel
*chan
,
2753 unsigned int duration
,
2755 int (*cancel_remain_on_channel
)(struct wiphy
*wiphy
,
2756 struct wireless_dev
*wdev
,
2759 int (*mgmt_tx
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
2760 struct cfg80211_mgmt_tx_params
*params
,
2762 int (*mgmt_tx_cancel_wait
)(struct wiphy
*wiphy
,
2763 struct wireless_dev
*wdev
,
2766 int (*set_power_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2767 bool enabled
, int timeout
);
2769 int (*set_cqm_rssi_config
)(struct wiphy
*wiphy
,
2770 struct net_device
*dev
,
2771 s32 rssi_thold
, u32 rssi_hyst
);
2773 int (*set_cqm_txe_config
)(struct wiphy
*wiphy
,
2774 struct net_device
*dev
,
2775 u32 rate
, u32 pkts
, u32 intvl
);
2777 void (*mgmt_frame_register
)(struct wiphy
*wiphy
,
2778 struct wireless_dev
*wdev
,
2779 u16 frame_type
, bool reg
);
2781 int (*set_antenna
)(struct wiphy
*wiphy
, u32 tx_ant
, u32 rx_ant
);
2782 int (*get_antenna
)(struct wiphy
*wiphy
, u32
*tx_ant
, u32
*rx_ant
);
2784 int (*sched_scan_start
)(struct wiphy
*wiphy
,
2785 struct net_device
*dev
,
2786 struct cfg80211_sched_scan_request
*request
);
2787 int (*sched_scan_stop
)(struct wiphy
*wiphy
, struct net_device
*dev
);
2789 int (*set_rekey_data
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2790 struct cfg80211_gtk_rekey_data
*data
);
2792 int (*tdls_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2793 const u8
*peer
, u8 action_code
, u8 dialog_token
,
2794 u16 status_code
, u32 peer_capability
,
2795 bool initiator
, const u8
*buf
, size_t len
);
2796 int (*tdls_oper
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2797 const u8
*peer
, enum nl80211_tdls_operation oper
);
2799 int (*probe_client
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2800 const u8
*peer
, u64
*cookie
);
2802 int (*set_noack_map
)(struct wiphy
*wiphy
,
2803 struct net_device
*dev
,
2806 int (*get_channel
)(struct wiphy
*wiphy
,
2807 struct wireless_dev
*wdev
,
2808 struct cfg80211_chan_def
*chandef
);
2810 int (*start_p2p_device
)(struct wiphy
*wiphy
,
2811 struct wireless_dev
*wdev
);
2812 void (*stop_p2p_device
)(struct wiphy
*wiphy
,
2813 struct wireless_dev
*wdev
);
2815 int (*set_mac_acl
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2816 const struct cfg80211_acl_data
*params
);
2818 int (*start_radar_detection
)(struct wiphy
*wiphy
,
2819 struct net_device
*dev
,
2820 struct cfg80211_chan_def
*chandef
,
2822 int (*update_ft_ies
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2823 struct cfg80211_update_ft_ies_params
*ftie
);
2824 int (*crit_proto_start
)(struct wiphy
*wiphy
,
2825 struct wireless_dev
*wdev
,
2826 enum nl80211_crit_proto_id protocol
,
2828 void (*crit_proto_stop
)(struct wiphy
*wiphy
,
2829 struct wireless_dev
*wdev
);
2830 int (*set_coalesce
)(struct wiphy
*wiphy
,
2831 struct cfg80211_coalesce
*coalesce
);
2833 int (*channel_switch
)(struct wiphy
*wiphy
,
2834 struct net_device
*dev
,
2835 struct cfg80211_csa_settings
*params
);
2837 int (*set_qos_map
)(struct wiphy
*wiphy
,
2838 struct net_device
*dev
,
2839 struct cfg80211_qos_map
*qos_map
);
2841 int (*set_ap_chanwidth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2842 struct cfg80211_chan_def
*chandef
);
2844 int (*add_tx_ts
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2845 u8 tsid
, const u8
*peer
, u8 user_prio
,
2847 int (*del_tx_ts
)(struct wiphy
*wiphy
, struct net_device
*dev
,
2848 u8 tsid
, const u8
*peer
);
2850 int (*tdls_channel_switch
)(struct wiphy
*wiphy
,
2851 struct net_device
*dev
,
2852 const u8
*addr
, u8 oper_class
,
2853 struct cfg80211_chan_def
*chandef
);
2854 void (*tdls_cancel_channel_switch
)(struct wiphy
*wiphy
,
2855 struct net_device
*dev
,
2860 * wireless hardware and networking interfaces structures
2861 * and registration/helper functions
2865 * enum wiphy_flags - wiphy capability flags
2867 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2869 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2870 * by default -- this flag will be set depending on the kernel's default
2871 * on wiphy_new(), but can be changed by the driver if it has a good
2872 * reason to override the default
2873 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2874 * on a VLAN interface)
2875 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2876 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2877 * control port protocol ethertype. The device also honours the
2878 * control_port_no_encrypt flag.
2879 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2880 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2881 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2882 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2883 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2885 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2886 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2887 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2888 * link setup/discovery operations internally. Setup, discovery and
2889 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2890 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2891 * used for asking the driver/firmware to perform a TDLS operation.
2892 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2893 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2894 * when there are virtual interfaces in AP mode by calling
2895 * cfg80211_report_obss_beacon().
2896 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2897 * responds to probe-requests in hardware.
2898 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2899 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2900 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2901 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2902 * beaconing mode (AP, IBSS, Mesh, ...).
2908 WIPHY_FLAG_NETNS_OK
= BIT(3),
2909 WIPHY_FLAG_PS_ON_BY_DEFAULT
= BIT(4),
2910 WIPHY_FLAG_4ADDR_AP
= BIT(5),
2911 WIPHY_FLAG_4ADDR_STATION
= BIT(6),
2912 WIPHY_FLAG_CONTROL_PORT_PROTOCOL
= BIT(7),
2913 WIPHY_FLAG_IBSS_RSN
= BIT(8),
2914 WIPHY_FLAG_MESH_AUTH
= BIT(10),
2915 WIPHY_FLAG_SUPPORTS_SCHED_SCAN
= BIT(11),
2916 /* use hole at 12 */
2917 WIPHY_FLAG_SUPPORTS_FW_ROAM
= BIT(13),
2918 WIPHY_FLAG_AP_UAPSD
= BIT(14),
2919 WIPHY_FLAG_SUPPORTS_TDLS
= BIT(15),
2920 WIPHY_FLAG_TDLS_EXTERNAL_SETUP
= BIT(16),
2921 WIPHY_FLAG_HAVE_AP_SME
= BIT(17),
2922 WIPHY_FLAG_REPORTS_OBSS
= BIT(18),
2923 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD
= BIT(19),
2924 WIPHY_FLAG_OFFCHAN_TX
= BIT(20),
2925 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL
= BIT(21),
2926 WIPHY_FLAG_SUPPORTS_5_10_MHZ
= BIT(22),
2927 WIPHY_FLAG_HAS_CHANNEL_SWITCH
= BIT(23),
2931 * struct ieee80211_iface_limit - limit on certain interface types
2932 * @max: maximum number of interfaces of these types
2933 * @types: interface types (bits)
2935 struct ieee80211_iface_limit
{
2941 * struct ieee80211_iface_combination - possible interface combination
2942 * @limits: limits for the given interface types
2943 * @n_limits: number of limitations
2944 * @num_different_channels: can use up to this many different channels
2945 * @max_interfaces: maximum number of interfaces in total allowed in this
2947 * @beacon_int_infra_match: In this combination, the beacon intervals
2948 * between infrastructure and AP types must match. This is required
2949 * only in special cases.
2950 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2951 * @radar_detect_regions: bitmap of regions supported for radar detection
2953 * With this structure the driver can describe which interface
2954 * combinations it supports concurrently.
2958 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2960 * struct ieee80211_iface_limit limits1[] = {
2961 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2962 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2964 * struct ieee80211_iface_combination combination1 = {
2965 * .limits = limits1,
2966 * .n_limits = ARRAY_SIZE(limits1),
2967 * .max_interfaces = 2,
2968 * .beacon_int_infra_match = true,
2972 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2974 * struct ieee80211_iface_limit limits2[] = {
2975 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2976 * BIT(NL80211_IFTYPE_P2P_GO), },
2978 * struct ieee80211_iface_combination combination2 = {
2979 * .limits = limits2,
2980 * .n_limits = ARRAY_SIZE(limits2),
2981 * .max_interfaces = 8,
2982 * .num_different_channels = 1,
2986 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2988 * This allows for an infrastructure connection and three P2P connections.
2990 * struct ieee80211_iface_limit limits3[] = {
2991 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2992 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2993 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2995 * struct ieee80211_iface_combination combination3 = {
2996 * .limits = limits3,
2997 * .n_limits = ARRAY_SIZE(limits3),
2998 * .max_interfaces = 4,
2999 * .num_different_channels = 2,
3002 struct ieee80211_iface_combination
{
3003 const struct ieee80211_iface_limit
*limits
;
3004 u32 num_different_channels
;
3007 bool beacon_int_infra_match
;
3008 u8 radar_detect_widths
;
3009 u8 radar_detect_regions
;
3012 struct ieee80211_txrx_stypes
{
3017 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3018 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3019 * trigger that keeps the device operating as-is and
3020 * wakes up the host on any activity, for example a
3021 * received packet that passed filtering; note that the
3022 * packet should be preserved in that case
3023 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3025 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3026 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3027 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3028 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3029 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3030 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3031 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3033 enum wiphy_wowlan_support_flags
{
3034 WIPHY_WOWLAN_ANY
= BIT(0),
3035 WIPHY_WOWLAN_MAGIC_PKT
= BIT(1),
3036 WIPHY_WOWLAN_DISCONNECT
= BIT(2),
3037 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY
= BIT(3),
3038 WIPHY_WOWLAN_GTK_REKEY_FAILURE
= BIT(4),
3039 WIPHY_WOWLAN_EAP_IDENTITY_REQ
= BIT(5),
3040 WIPHY_WOWLAN_4WAY_HANDSHAKE
= BIT(6),
3041 WIPHY_WOWLAN_RFKILL_RELEASE
= BIT(7),
3042 WIPHY_WOWLAN_NET_DETECT
= BIT(8),
3045 struct wiphy_wowlan_tcp_support
{
3046 const struct nl80211_wowlan_tcp_data_token_feature
*tok
;
3047 u32 data_payload_max
;
3048 u32 data_interval_max
;
3049 u32 wake_payload_max
;
3054 * struct wiphy_wowlan_support - WoWLAN support data
3055 * @flags: see &enum wiphy_wowlan_support_flags
3056 * @n_patterns: number of supported wakeup patterns
3057 * (see nl80211.h for the pattern definition)
3058 * @pattern_max_len: maximum length of each pattern
3059 * @pattern_min_len: minimum length of each pattern
3060 * @max_pkt_offset: maximum Rx packet offset
3061 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3062 * similar, but not necessarily identical, to max_match_sets for
3064 * See &struct cfg80211_sched_scan_request.@match_sets for more
3066 * @tcp: TCP wakeup support information
3068 struct wiphy_wowlan_support
{
3071 int pattern_max_len
;
3072 int pattern_min_len
;
3074 int max_nd_match_sets
;
3075 const struct wiphy_wowlan_tcp_support
*tcp
;
3079 * struct wiphy_coalesce_support - coalesce support data
3080 * @n_rules: maximum number of coalesce rules
3081 * @max_delay: maximum supported coalescing delay in msecs
3082 * @n_patterns: number of supported patterns in a rule
3083 * (see nl80211.h for the pattern definition)
3084 * @pattern_max_len: maximum length of each pattern
3085 * @pattern_min_len: minimum length of each pattern
3086 * @max_pkt_offset: maximum Rx packet offset
3088 struct wiphy_coalesce_support
{
3092 int pattern_max_len
;
3093 int pattern_min_len
;
3098 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3099 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3100 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3101 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3102 * (must be combined with %_WDEV or %_NETDEV)
3104 enum wiphy_vendor_command_flags
{
3105 WIPHY_VENDOR_CMD_NEED_WDEV
= BIT(0),
3106 WIPHY_VENDOR_CMD_NEED_NETDEV
= BIT(1),
3107 WIPHY_VENDOR_CMD_NEED_RUNNING
= BIT(2),
3111 * struct wiphy_vendor_command - vendor command definition
3112 * @info: vendor command identifying information, as used in nl80211
3113 * @flags: flags, see &enum wiphy_vendor_command_flags
3114 * @doit: callback for the operation, note that wdev is %NULL if the
3115 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3116 * pointer may be %NULL if userspace provided no data at all
3117 * @dumpit: dump callback, for transferring bigger/multiple items. The
3118 * @storage points to cb->args[5], ie. is preserved over the multiple
3120 * It's recommended to not have the same sub command with both @doit and
3121 * @dumpit, so that userspace can assume certain ones are get and others
3122 * are used with dump requests.
3124 struct wiphy_vendor_command
{
3125 struct nl80211_vendor_cmd_info info
;
3127 int (*doit
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3128 const void *data
, int data_len
);
3129 int (*dumpit
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
3130 struct sk_buff
*skb
, const void *data
, int data_len
,
3131 unsigned long *storage
);
3135 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3136 * @iftype: interface type
3137 * @extended_capabilities: extended capabilities supported by the driver,
3138 * additional capabilities might be supported by userspace; these are the
3139 * 802.11 extended capabilities ("Extended Capabilities element") and are
3140 * in the same format as in the information element. See IEEE Std
3141 * 802.11-2012 8.4.2.29 for the defined fields.
3142 * @extended_capabilities_mask: mask of the valid values
3143 * @extended_capabilities_len: length of the extended capabilities
3145 struct wiphy_iftype_ext_capab
{
3146 enum nl80211_iftype iftype
;
3147 const u8
*extended_capabilities
;
3148 const u8
*extended_capabilities_mask
;
3149 u8 extended_capabilities_len
;
3153 * struct wiphy - wireless hardware description
3154 * @reg_notifier: the driver's regulatory notification callback,
3155 * note that if your driver uses wiphy_apply_custom_regulatory()
3156 * the reg_notifier's request can be passed as NULL
3157 * @regd: the driver's regulatory domain, if one was requested via
3158 * the regulatory_hint() API. This can be used by the driver
3159 * on the reg_notifier() if it chooses to ignore future
3160 * regulatory domain changes caused by other drivers.
3161 * @signal_type: signal type reported in &struct cfg80211_bss.
3162 * @cipher_suites: supported cipher suites
3163 * @n_cipher_suites: number of supported cipher suites
3164 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3165 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3166 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3167 * -1 = fragmentation disabled, only odd values >= 256 used
3168 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3169 * @_net: the network namespace this wiphy currently lives in
3170 * @perm_addr: permanent MAC address of this device
3171 * @addr_mask: If the device supports multiple MAC addresses by masking,
3172 * set this to a mask with variable bits set to 1, e.g. if the last
3173 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3174 * variable bits shall be determined by the interfaces added, with
3175 * interfaces not matching the mask being rejected to be brought up.
3176 * @n_addresses: number of addresses in @addresses.
3177 * @addresses: If the device has more than one address, set this pointer
3178 * to a list of addresses (6 bytes each). The first one will be used
3179 * by default for perm_addr. In this case, the mask should be set to
3180 * all-zeroes. In this case it is assumed that the device can handle
3181 * the same number of arbitrary MAC addresses.
3182 * @registered: protects ->resume and ->suspend sysfs callbacks against
3183 * unregister hardware
3184 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3185 * automatically on wiphy renames
3186 * @dev: (virtual) struct device for this wiphy
3187 * @registered: helps synchronize suspend/resume with wiphy unregister
3188 * @wext: wireless extension handlers
3189 * @priv: driver private data (sized according to wiphy_new() parameter)
3190 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3191 * must be set by driver
3192 * @iface_combinations: Valid interface combinations array, should not
3193 * list single interface types.
3194 * @n_iface_combinations: number of entries in @iface_combinations array.
3195 * @software_iftypes: bitmask of software interface types, these are not
3196 * subject to any restrictions since they are purely managed in SW.
3197 * @flags: wiphy flags, see &enum wiphy_flags
3198 * @regulatory_flags: wiphy regulatory flags, see
3199 * &enum ieee80211_regulatory_flags
3200 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3201 * @ext_features: extended features advertised to nl80211, see
3202 * &enum nl80211_ext_feature_index.
3203 * @bss_priv_size: each BSS struct has private data allocated with it,
3204 * this variable determines its size
3205 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3207 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3208 * for in any given scheduled scan
3209 * @max_match_sets: maximum number of match sets the device can handle
3210 * when performing a scheduled scan, 0 if filtering is not
3212 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3213 * add to probe request frames transmitted during a scan, must not
3214 * include fixed IEs like supported rates
3215 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3217 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3218 * of iterations) for scheduled scan supported by the device.
3219 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3220 * single scan plan supported by the device.
3221 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3222 * scan plan supported by the device.
3223 * @coverage_class: current coverage class
3224 * @fw_version: firmware version for ethtool reporting
3225 * @hw_version: hardware version for ethtool reporting
3226 * @max_num_pmkids: maximum number of PMKIDs supported by device
3227 * @privid: a pointer that drivers can use to identify if an arbitrary
3228 * wiphy is theirs, e.g. in global notifiers
3229 * @bands: information about bands/channels supported by this device
3231 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3232 * transmitted through nl80211, points to an array indexed by interface
3235 * @available_antennas_tx: bitmap of antennas which are available to be
3236 * configured as TX antennas. Antenna configuration commands will be
3237 * rejected unless this or @available_antennas_rx is set.
3239 * @available_antennas_rx: bitmap of antennas which are available to be
3240 * configured as RX antennas. Antenna configuration commands will be
3241 * rejected unless this or @available_antennas_tx is set.
3243 * @probe_resp_offload:
3244 * Bitmap of supported protocols for probe response offloading.
3245 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3246 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3248 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3249 * may request, if implemented.
3251 * @wowlan: WoWLAN support information
3252 * @wowlan_config: current WoWLAN configuration; this should usually not be
3253 * used since access to it is necessarily racy, use the parameter passed
3254 * to the suspend() operation instead.
3256 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3257 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3258 * If null, then none can be over-ridden.
3259 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3260 * If null, then none can be over-ridden.
3262 * @wdev_list: the list of associated (virtual) interfaces; this list must
3263 * not be modified by the driver, but can be read with RTNL/RCU protection.
3265 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3268 * @extended_capabilities: extended capabilities supported by the driver,
3269 * additional capabilities might be supported by userspace; these are
3270 * the 802.11 extended capabilities ("Extended Capabilities element")
3271 * and are in the same format as in the information element. See
3272 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3273 * extended capabilities to be used if the capabilities are not specified
3274 * for a specific interface type in iftype_ext_capab.
3275 * @extended_capabilities_mask: mask of the valid values
3276 * @extended_capabilities_len: length of the extended capabilities
3277 * @iftype_ext_capab: array of extended capabilities per interface type
3278 * @num_iftype_ext_capab: number of interface types for which extended
3279 * capabilities are specified separately.
3280 * @coalesce: packet coalescing support information
3282 * @vendor_commands: array of vendor commands supported by the hardware
3283 * @n_vendor_commands: number of vendor commands
3284 * @vendor_events: array of vendor events supported by the hardware
3285 * @n_vendor_events: number of vendor events
3287 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3288 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3289 * driver is allowed to advertise a theoretical limit that it can reach in
3290 * some cases, but may not always reach.
3292 * @max_num_csa_counters: Number of supported csa_counters in beacons
3293 * and probe responses. This value should be set if the driver
3294 * wishes to limit the number of csa counters. Default (0) means
3296 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3297 * frame was sent and the channel on which the frame was heard for which
3298 * the reported rssi is still valid. If a driver is able to compensate the
3299 * low rssi when a frame is heard on different channel, then it should set
3300 * this variable to the maximal offset for which it can compensate.
3301 * This value should be set in MHz.
3302 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3303 * by the driver in the .connect() callback. The bit position maps to the
3304 * attribute indices defined in &enum nl80211_bss_select_attr.
3307 /* assign these fields before you register the wiphy */
3309 /* permanent MAC address(es) */
3310 u8 perm_addr
[ETH_ALEN
];
3311 u8 addr_mask
[ETH_ALEN
];
3313 struct mac_address
*addresses
;
3315 const struct ieee80211_txrx_stypes
*mgmt_stypes
;
3317 const struct ieee80211_iface_combination
*iface_combinations
;
3318 int n_iface_combinations
;
3319 u16 software_iftypes
;
3323 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3324 u16 interface_modes
;
3326 u16 max_acl_mac_addrs
;
3328 u32 flags
, regulatory_flags
, features
;
3329 u8 ext_features
[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES
, 8)];
3333 enum cfg80211_signal_type signal_type
;
3337 u8 max_sched_scan_ssids
;
3339 u16 max_scan_ie_len
;
3340 u16 max_sched_scan_ie_len
;
3341 u32 max_sched_scan_plans
;
3342 u32 max_sched_scan_plan_interval
;
3343 u32 max_sched_scan_plan_iterations
;
3345 int n_cipher_suites
;
3346 const u32
*cipher_suites
;
3354 char fw_version
[ETHTOOL_FWVERS_LEN
];
3358 const struct wiphy_wowlan_support
*wowlan
;
3359 struct cfg80211_wowlan
*wowlan_config
;
3362 u16 max_remain_on_channel_duration
;
3366 u32 available_antennas_tx
;
3367 u32 available_antennas_rx
;
3370 * Bitmap of supported protocols for probe response offloading
3371 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3372 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3374 u32 probe_resp_offload
;
3376 const u8
*extended_capabilities
, *extended_capabilities_mask
;
3377 u8 extended_capabilities_len
;
3379 const struct wiphy_iftype_ext_capab
*iftype_ext_capab
;
3380 unsigned int num_iftype_ext_capab
;
3382 /* If multiple wiphys are registered and you're handed e.g.
3383 * a regular netdev with assigned ieee80211_ptr, you won't
3384 * know whether it points to a wiphy your driver has registered
3385 * or not. Assign this to something global to your driver to
3386 * help determine whether you own this wiphy or not. */
3389 struct ieee80211_supported_band
*bands
[NUM_NL80211_BANDS
];
3391 /* Lets us get back the wiphy on the callback */
3392 void (*reg_notifier
)(struct wiphy
*wiphy
,
3393 struct regulatory_request
*request
);
3395 /* fields below are read-only, assigned by cfg80211 */
3397 const struct ieee80211_regdomain __rcu
*regd
;
3399 /* the item in /sys/class/ieee80211/ points to this,
3400 * you need use set_wiphy_dev() (see below) */
3403 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3406 /* dir in debugfs: ieee80211/<wiphyname> */
3407 struct dentry
*debugfsdir
;
3409 const struct ieee80211_ht_cap
*ht_capa_mod_mask
;
3410 const struct ieee80211_vht_cap
*vht_capa_mod_mask
;
3412 struct list_head wdev_list
;
3414 /* the network namespace this phy lives in currently */
3415 possible_net_t _net
;
3417 #ifdef CONFIG_CFG80211_WEXT
3418 const struct iw_handler_def
*wext
;
3421 const struct wiphy_coalesce_support
*coalesce
;
3423 const struct wiphy_vendor_command
*vendor_commands
;
3424 const struct nl80211_vendor_cmd_info
*vendor_events
;
3425 int n_vendor_commands
, n_vendor_events
;
3427 u16 max_ap_assoc_sta
;
3429 u8 max_num_csa_counters
;
3430 u8 max_adj_channel_rssi_comp
;
3432 u32 bss_select_support
;
3434 char priv
[0] __aligned(NETDEV_ALIGN
);
3437 static inline struct net
*wiphy_net(struct wiphy
*wiphy
)
3439 return read_pnet(&wiphy
->_net
);
3442 static inline void wiphy_net_set(struct wiphy
*wiphy
, struct net
*net
)
3444 write_pnet(&wiphy
->_net
, net
);
3448 * wiphy_priv - return priv from wiphy
3450 * @wiphy: the wiphy whose priv pointer to return
3451 * Return: The priv of @wiphy.
3453 static inline void *wiphy_priv(struct wiphy
*wiphy
)
3456 return &wiphy
->priv
;
3460 * priv_to_wiphy - return the wiphy containing the priv
3462 * @priv: a pointer previously returned by wiphy_priv
3463 * Return: The wiphy of @priv.
3465 static inline struct wiphy
*priv_to_wiphy(void *priv
)
3468 return container_of(priv
, struct wiphy
, priv
);
3472 * set_wiphy_dev - set device pointer for wiphy
3474 * @wiphy: The wiphy whose device to bind
3475 * @dev: The device to parent it to
3477 static inline void set_wiphy_dev(struct wiphy
*wiphy
, struct device
*dev
)
3479 wiphy
->dev
.parent
= dev
;
3483 * wiphy_dev - get wiphy dev pointer
3485 * @wiphy: The wiphy whose device struct to look up
3486 * Return: The dev of @wiphy.
3488 static inline struct device
*wiphy_dev(struct wiphy
*wiphy
)
3490 return wiphy
->dev
.parent
;
3494 * wiphy_name - get wiphy name
3496 * @wiphy: The wiphy whose name to return
3497 * Return: The name of @wiphy.
3499 static inline const char *wiphy_name(const struct wiphy
*wiphy
)
3501 return dev_name(&wiphy
->dev
);
3505 * wiphy_new_nm - create a new wiphy for use with cfg80211
3507 * @ops: The configuration operations for this device
3508 * @sizeof_priv: The size of the private area to allocate
3509 * @requested_name: Request a particular name.
3510 * NULL is valid value, and means use the default phy%d naming.
3512 * Create a new wiphy and associate the given operations with it.
3513 * @sizeof_priv bytes are allocated for private use.
3515 * Return: A pointer to the new wiphy. This pointer must be
3516 * assigned to each netdev's ieee80211_ptr for proper operation.
3518 struct wiphy
*wiphy_new_nm(const struct cfg80211_ops
*ops
, int sizeof_priv
,
3519 const char *requested_name
);
3522 * wiphy_new - create a new wiphy for use with cfg80211
3524 * @ops: The configuration operations for this device
3525 * @sizeof_priv: The size of the private area to allocate
3527 * Create a new wiphy and associate the given operations with it.
3528 * @sizeof_priv bytes are allocated for private use.
3530 * Return: A pointer to the new wiphy. This pointer must be
3531 * assigned to each netdev's ieee80211_ptr for proper operation.
3533 static inline struct wiphy
*wiphy_new(const struct cfg80211_ops
*ops
,
3536 return wiphy_new_nm(ops
, sizeof_priv
, NULL
);
3540 * wiphy_register - register a wiphy with cfg80211
3542 * @wiphy: The wiphy to register.
3544 * Return: A non-negative wiphy index or a negative error code.
3546 int wiphy_register(struct wiphy
*wiphy
);
3549 * wiphy_unregister - deregister a wiphy from cfg80211
3551 * @wiphy: The wiphy to unregister.
3553 * After this call, no more requests can be made with this priv
3554 * pointer, but the call may sleep to wait for an outstanding
3555 * request that is being handled.
3557 void wiphy_unregister(struct wiphy
*wiphy
);
3560 * wiphy_free - free wiphy
3562 * @wiphy: The wiphy to free
3564 void wiphy_free(struct wiphy
*wiphy
);
3566 /* internal structs */
3567 struct cfg80211_conn
;
3568 struct cfg80211_internal_bss
;
3569 struct cfg80211_cached_keys
;
3572 * struct wireless_dev - wireless device state
3574 * For netdevs, this structure must be allocated by the driver
3575 * that uses the ieee80211_ptr field in struct net_device (this
3576 * is intentional so it can be allocated along with the netdev.)
3577 * It need not be registered then as netdev registration will
3578 * be intercepted by cfg80211 to see the new wireless device.
3580 * For non-netdev uses, it must also be allocated by the driver
3581 * in response to the cfg80211 callbacks that require it, as
3582 * there's no netdev registration in that case it may not be
3583 * allocated outside of callback operations that return it.
3585 * @wiphy: pointer to hardware description
3586 * @iftype: interface type
3587 * @list: (private) Used to collect the interfaces
3588 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3589 * @identifier: (private) Identifier used in nl80211 to identify this
3590 * wireless device if it has no netdev
3591 * @current_bss: (private) Used by the internal configuration code
3592 * @chandef: (private) Used by the internal configuration code to track
3593 * the user-set channel definition.
3594 * @preset_chandef: (private) Used by the internal configuration code to
3595 * track the channel to be used for AP later
3596 * @bssid: (private) Used by the internal configuration code
3597 * @ssid: (private) Used by the internal configuration code
3598 * @ssid_len: (private) Used by the internal configuration code
3599 * @mesh_id_len: (private) Used by the internal configuration code
3600 * @mesh_id_up_len: (private) Used by the internal configuration code
3601 * @wext: (private) Used by the internal wireless extensions compat code
3602 * @use_4addr: indicates 4addr mode is used on this interface, must be
3603 * set by driver (if supported) on add_interface BEFORE registering the
3604 * netdev and may otherwise be used by driver read-only, will be update
3605 * by cfg80211 on change_interface
3606 * @mgmt_registrations: list of registrations for management frames
3607 * @mgmt_registrations_lock: lock for the list
3608 * @mtx: mutex used to lock data in this struct, may be used by drivers
3609 * and some API functions require it held
3610 * @beacon_interval: beacon interval used on this device for transmitting
3611 * beacons, 0 when not valid
3612 * @address: The address for this device, valid only if @netdev is %NULL
3613 * @p2p_started: true if this is a P2P Device that has been started
3614 * @cac_started: true if DFS channel availability check has been started
3615 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3616 * @cac_time_ms: CAC time in ms
3617 * @ps: powersave mode is enabled
3618 * @ps_timeout: dynamic powersave timeout
3619 * @ap_unexpected_nlportid: (private) netlink port ID of application
3620 * registered for unexpected class 3 frames (AP mode)
3621 * @conn: (private) cfg80211 software SME connection state machine data
3622 * @connect_keys: (private) keys to set after connection is established
3623 * @conn_bss_type: connecting/connected BSS type
3624 * @ibss_fixed: (private) IBSS is using fixed BSSID
3625 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3626 * @event_list: (private) list for internal event processing
3627 * @event_lock: (private) lock for event list
3628 * @owner_nlportid: (private) owner socket port ID
3630 struct wireless_dev
{
3631 struct wiphy
*wiphy
;
3632 enum nl80211_iftype iftype
;
3634 /* the remainder of this struct should be private to cfg80211 */
3635 struct list_head list
;
3636 struct net_device
*netdev
;
3640 struct list_head mgmt_registrations
;
3641 spinlock_t mgmt_registrations_lock
;
3645 bool use_4addr
, p2p_started
;
3647 u8 address
[ETH_ALEN
] __aligned(sizeof(u16
));
3649 /* currently used for IBSS and SME - might be rearranged later */
3650 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
3651 u8 ssid_len
, mesh_id_len
, mesh_id_up_len
;
3652 struct cfg80211_conn
*conn
;
3653 struct cfg80211_cached_keys
*connect_keys
;
3654 enum ieee80211_bss_type conn_bss_type
;
3656 struct list_head event_list
;
3657 spinlock_t event_lock
;
3659 struct cfg80211_internal_bss
*current_bss
; /* associated / joined */
3660 struct cfg80211_chan_def preset_chandef
;
3661 struct cfg80211_chan_def chandef
;
3664 bool ibss_dfs_possible
;
3669 int beacon_interval
;
3671 u32 ap_unexpected_nlportid
;
3674 unsigned long cac_start_time
;
3675 unsigned int cac_time_ms
;
3679 #ifdef CONFIG_CFG80211_WEXT
3682 struct cfg80211_ibss_params ibss
;
3683 struct cfg80211_connect_params connect
;
3684 struct cfg80211_cached_keys
*keys
;
3687 u8 bssid
[ETH_ALEN
], prev_bssid
[ETH_ALEN
];
3688 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
3689 s8 default_key
, default_mgmt_key
;
3690 bool prev_bssid_valid
;
3695 static inline u8
*wdev_address(struct wireless_dev
*wdev
)
3698 return wdev
->netdev
->dev_addr
;
3699 return wdev
->address
;
3703 * wdev_priv - return wiphy priv from wireless_dev
3705 * @wdev: The wireless device whose wiphy's priv pointer to return
3706 * Return: The wiphy priv of @wdev.
3708 static inline void *wdev_priv(struct wireless_dev
*wdev
)
3711 return wiphy_priv(wdev
->wiphy
);
3715 * DOC: Utility functions
3717 * cfg80211 offers a number of utility functions that can be useful.
3721 * ieee80211_channel_to_frequency - convert channel number to frequency
3722 * @chan: channel number
3723 * @band: band, necessary due to channel number overlap
3724 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3726 int ieee80211_channel_to_frequency(int chan
, enum nl80211_band band
);
3729 * ieee80211_frequency_to_channel - convert frequency to channel number
3730 * @freq: center frequency
3731 * Return: The corresponding channel, or 0 if the conversion failed.
3733 int ieee80211_frequency_to_channel(int freq
);
3736 * Name indirection necessary because the ieee80211 code also has
3737 * a function named "ieee80211_get_channel", so if you include
3738 * cfg80211's header file you get cfg80211's version, if you try
3739 * to include both header files you'll (rightfully!) get a symbol
3742 struct ieee80211_channel
*__ieee80211_get_channel(struct wiphy
*wiphy
,
3745 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3746 * @wiphy: the struct wiphy to get the channel for
3747 * @freq: the center frequency of the channel
3748 * Return: The channel struct from @wiphy at @freq.
3750 static inline struct ieee80211_channel
*
3751 ieee80211_get_channel(struct wiphy
*wiphy
, int freq
)
3753 return __ieee80211_get_channel(wiphy
, freq
);
3757 * ieee80211_get_response_rate - get basic rate for a given rate
3759 * @sband: the band to look for rates in
3760 * @basic_rates: bitmap of basic rates
3761 * @bitrate: the bitrate for which to find the basic rate
3763 * Return: The basic rate corresponding to a given bitrate, that
3764 * is the next lower bitrate contained in the basic rate map,
3765 * which is, for this function, given as a bitmap of indices of
3766 * rates in the band's bitrate table.
3768 struct ieee80211_rate
*
3769 ieee80211_get_response_rate(struct ieee80211_supported_band
*sband
,
3770 u32 basic_rates
, int bitrate
);
3773 * ieee80211_mandatory_rates - get mandatory rates for a given band
3774 * @sband: the band to look for rates in
3775 * @scan_width: width of the control channel
3777 * This function returns a bitmap of the mandatory rates for the given
3778 * band, bits are set according to the rate position in the bitrates array.
3780 u32
ieee80211_mandatory_rates(struct ieee80211_supported_band
*sband
,
3781 enum nl80211_bss_scan_width scan_width
);
3784 * Radiotap parsing functions -- for controlled injection support
3786 * Implemented in net/wireless/radiotap.c
3787 * Documentation in Documentation/networking/radiotap-headers.txt
3790 struct radiotap_align_size
{
3791 uint8_t align
:4, size
:4;
3794 struct ieee80211_radiotap_namespace
{
3795 const struct radiotap_align_size
*align_size
;
3801 struct ieee80211_radiotap_vendor_namespaces
{
3802 const struct ieee80211_radiotap_namespace
*ns
;
3807 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3808 * @this_arg_index: index of current arg, valid after each successful call
3809 * to ieee80211_radiotap_iterator_next()
3810 * @this_arg: pointer to current radiotap arg; it is valid after each
3811 * call to ieee80211_radiotap_iterator_next() but also after
3812 * ieee80211_radiotap_iterator_init() where it will point to
3813 * the beginning of the actual data portion
3814 * @this_arg_size: length of the current arg, for convenience
3815 * @current_namespace: pointer to the current namespace definition
3816 * (or internally %NULL if the current namespace is unknown)
3817 * @is_radiotap_ns: indicates whether the current namespace is the default
3818 * radiotap namespace or not
3820 * @_rtheader: pointer to the radiotap header we are walking through
3821 * @_max_length: length of radiotap header in cpu byte ordering
3822 * @_arg_index: next argument index
3823 * @_arg: next argument pointer
3824 * @_next_bitmap: internal pointer to next present u32
3825 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3826 * @_vns: vendor namespace definitions
3827 * @_next_ns_data: beginning of the next namespace's data
3828 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3831 * Describes the radiotap parser state. Fields prefixed with an underscore
3832 * must not be used by users of the parser, only by the parser internally.
3835 struct ieee80211_radiotap_iterator
{
3836 struct ieee80211_radiotap_header
*_rtheader
;
3837 const struct ieee80211_radiotap_vendor_namespaces
*_vns
;
3838 const struct ieee80211_radiotap_namespace
*current_namespace
;
3840 unsigned char *_arg
, *_next_ns_data
;
3841 __le32
*_next_bitmap
;
3843 unsigned char *this_arg
;
3851 uint32_t _bitmap_shifter
;
3856 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator
*iterator
,
3857 struct ieee80211_radiotap_header
*radiotap_header
,
3859 const struct ieee80211_radiotap_vendor_namespaces
*vns
);
3862 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator
*iterator
);
3865 extern const unsigned char rfc1042_header
[6];
3866 extern const unsigned char bridge_tunnel_header
[6];
3869 * ieee80211_get_hdrlen_from_skb - get header length from data
3873 * Given an skb with a raw 802.11 header at the data pointer this function
3874 * returns the 802.11 header length.
3876 * Return: The 802.11 header length in bytes (not including encryption
3877 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3880 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
3883 * ieee80211_hdrlen - get header length in bytes from frame control
3884 * @fc: frame control field in little-endian format
3885 * Return: The header length in bytes.
3887 unsigned int __attribute_const__
ieee80211_hdrlen(__le16 fc
);
3890 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3891 * @meshhdr: the mesh extension header, only the flags field
3892 * (first byte) will be accessed
3893 * Return: The length of the extension header, which is always at
3894 * least 6 bytes and at most 18 if address 5 and 6 are present.
3896 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr
*meshhdr
);
3899 * DOC: Data path helpers
3901 * In addition to generic utilities, cfg80211 also offers
3902 * functions that help implement the data path for devices
3903 * that do not do the 802.11/802.3 conversion on the device.
3907 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3908 * @skb: the 802.11 data frame
3909 * @addr: the device MAC address
3910 * @iftype: the virtual interface type
3911 * Return: 0 on success. Non-zero on error.
3913 int ieee80211_data_to_8023(struct sk_buff
*skb
, const u8
*addr
,
3914 enum nl80211_iftype iftype
);
3917 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3918 * @skb: the 802.3 frame
3919 * @addr: the device MAC address
3920 * @iftype: the virtual interface type
3921 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3922 * @qos: build 802.11 QoS data frame
3923 * Return: 0 on success, or a negative error code.
3925 int ieee80211_data_from_8023(struct sk_buff
*skb
, const u8
*addr
,
3926 enum nl80211_iftype iftype
, const u8
*bssid
,
3930 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3932 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3933 * 802.3 frames. The @list will be empty if the decode fails. The
3934 * @skb is consumed after the function returns.
3936 * @skb: The input IEEE 802.11n A-MSDU frame.
3937 * @list: The output list of 802.3 frames. It must be allocated and
3938 * initialized by by the caller.
3939 * @addr: The device MAC address.
3940 * @iftype: The device interface type.
3941 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3942 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3944 void ieee80211_amsdu_to_8023s(struct sk_buff
*skb
, struct sk_buff_head
*list
,
3945 const u8
*addr
, enum nl80211_iftype iftype
,
3946 const unsigned int extra_headroom
,
3947 bool has_80211_header
);
3950 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3951 * @skb: the data frame
3952 * @qos_map: Interworking QoS mapping or %NULL if not in use
3953 * Return: The 802.1p/1d tag.
3955 unsigned int cfg80211_classify8021d(struct sk_buff
*skb
,
3956 struct cfg80211_qos_map
*qos_map
);
3959 * cfg80211_find_ie - find information element in data
3962 * @ies: data consisting of IEs
3963 * @len: length of data
3965 * Return: %NULL if the element ID could not be found or if
3966 * the element is invalid (claims to be longer than the given
3967 * data), or a pointer to the first byte of the requested
3968 * element, that is the byte containing the element ID.
3970 * Note: There are no checks on the element length other than
3971 * having to fit into the given data.
3973 const u8
*cfg80211_find_ie(u8 eid
, const u8
*ies
, int len
);
3976 * cfg80211_find_vendor_ie - find vendor specific information element in data
3979 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
3980 * @ies: data consisting of IEs
3981 * @len: length of data
3983 * Return: %NULL if the vendor specific element ID could not be found or if the
3984 * element is invalid (claims to be longer than the given data), or a pointer to
3985 * the first byte of the requested element, that is the byte containing the
3988 * Note: There are no checks on the element length other than having to fit into
3991 const u8
*cfg80211_find_vendor_ie(unsigned int oui
, int oui_type
,
3992 const u8
*ies
, int len
);
3995 * DOC: Regulatory enforcement infrastructure
4001 * regulatory_hint - driver hint to the wireless core a regulatory domain
4002 * @wiphy: the wireless device giving the hint (used only for reporting
4004 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4005 * should be in. If @rd is set this should be NULL. Note that if you
4006 * set this to NULL you should still set rd->alpha2 to some accepted
4009 * Wireless drivers can use this function to hint to the wireless core
4010 * what it believes should be the current regulatory domain by
4011 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4012 * domain should be in or by providing a completely build regulatory domain.
4013 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4014 * for a regulatory domain structure for the respective country.
4016 * The wiphy must have been registered to cfg80211 prior to this call.
4017 * For cfg80211 drivers this means you must first use wiphy_register(),
4018 * for mac80211 drivers you must first use ieee80211_register_hw().
4020 * Drivers should check the return value, its possible you can get
4023 * Return: 0 on success. -ENOMEM.
4025 int regulatory_hint(struct wiphy
*wiphy
, const char *alpha2
);
4028 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4029 * @wiphy: the wireless device we want to process the regulatory domain on
4030 * @rd: the regulatory domain informatoin to use for this wiphy
4032 * Set the regulatory domain information for self-managed wiphys, only they
4033 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4036 * Return: 0 on success. -EINVAL, -EPERM
4038 int regulatory_set_wiphy_regd(struct wiphy
*wiphy
,
4039 struct ieee80211_regdomain
*rd
);
4042 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4043 * @wiphy: the wireless device we want to process the regulatory domain on
4044 * @rd: the regulatory domain information to use for this wiphy
4046 * This functions requires the RTNL to be held and applies the new regdomain
4047 * synchronously to this wiphy. For more details see
4048 * regulatory_set_wiphy_regd().
4050 * Return: 0 on success. -EINVAL, -EPERM
4052 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy
*wiphy
,
4053 struct ieee80211_regdomain
*rd
);
4056 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4057 * @wiphy: the wireless device we want to process the regulatory domain on
4058 * @regd: the custom regulatory domain to use for this wiphy
4060 * Drivers can sometimes have custom regulatory domains which do not apply
4061 * to a specific country. Drivers can use this to apply such custom regulatory
4062 * domains. This routine must be called prior to wiphy registration. The
4063 * custom regulatory domain will be trusted completely and as such previous
4064 * default channel settings will be disregarded. If no rule is found for a
4065 * channel on the regulatory domain the channel will be disabled.
4066 * Drivers using this for a wiphy should also set the wiphy flag
4067 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4068 * that called this helper.
4070 void wiphy_apply_custom_regulatory(struct wiphy
*wiphy
,
4071 const struct ieee80211_regdomain
*regd
);
4074 * freq_reg_info - get regulatory information for the given frequency
4075 * @wiphy: the wiphy for which we want to process this rule for
4076 * @center_freq: Frequency in KHz for which we want regulatory information for
4078 * Use this function to get the regulatory rule for a specific frequency on
4079 * a given wireless device. If the device has a specific regulatory domain
4080 * it wants to follow we respect that unless a country IE has been received
4081 * and processed already.
4083 * Return: A valid pointer, or, when an error occurs, for example if no rule
4084 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4085 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4086 * value will be -ERANGE if we determine the given center_freq does not even
4087 * have a regulatory rule for a frequency range in the center_freq's band.
4088 * See freq_in_rule_band() for our current definition of a band -- this is
4089 * purely subjective and right now it's 802.11 specific.
4091 const struct ieee80211_reg_rule
*freq_reg_info(struct wiphy
*wiphy
,
4095 * reg_initiator_name - map regulatory request initiator enum to name
4096 * @initiator: the regulatory request initiator
4098 * You can use this to map the regulatory request initiator enum to a
4099 * proper string representation.
4101 const char *reg_initiator_name(enum nl80211_reg_initiator initiator
);
4104 * callbacks for asynchronous cfg80211 methods, notification
4105 * functions and BSS handling helpers
4109 * cfg80211_scan_done - notify that scan finished
4111 * @request: the corresponding scan request
4112 * @info: information about the completed scan
4114 void cfg80211_scan_done(struct cfg80211_scan_request
*request
,
4115 struct cfg80211_scan_info
*info
);
4118 * cfg80211_sched_scan_results - notify that new scan results are available
4120 * @wiphy: the wiphy which got scheduled scan results
4122 void cfg80211_sched_scan_results(struct wiphy
*wiphy
);
4125 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4127 * @wiphy: the wiphy on which the scheduled scan stopped
4129 * The driver can call this function to inform cfg80211 that the
4130 * scheduled scan had to be stopped, for whatever reason. The driver
4131 * is then called back via the sched_scan_stop operation when done.
4133 void cfg80211_sched_scan_stopped(struct wiphy
*wiphy
);
4136 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4138 * @wiphy: the wiphy on which the scheduled scan stopped
4140 * The driver can call this function to inform cfg80211 that the
4141 * scheduled scan had to be stopped, for whatever reason. The driver
4142 * is then called back via the sched_scan_stop operation when done.
4143 * This function should be called with rtnl locked.
4145 void cfg80211_sched_scan_stopped_rtnl(struct wiphy
*wiphy
);
4148 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4149 * @wiphy: the wiphy reporting the BSS
4150 * @data: the BSS metadata
4151 * @mgmt: the management frame (probe response or beacon)
4152 * @len: length of the management frame
4153 * @gfp: context flags
4155 * This informs cfg80211 that BSS information was found and
4156 * the BSS should be updated/added.
4158 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4159 * Or %NULL on error.
4161 struct cfg80211_bss
* __must_check
4162 cfg80211_inform_bss_frame_data(struct wiphy
*wiphy
,
4163 struct cfg80211_inform_bss
*data
,
4164 struct ieee80211_mgmt
*mgmt
, size_t len
,
4167 static inline struct cfg80211_bss
* __must_check
4168 cfg80211_inform_bss_width_frame(struct wiphy
*wiphy
,
4169 struct ieee80211_channel
*rx_channel
,
4170 enum nl80211_bss_scan_width scan_width
,
4171 struct ieee80211_mgmt
*mgmt
, size_t len
,
4172 s32 signal
, gfp_t gfp
)
4174 struct cfg80211_inform_bss data
= {
4176 .scan_width
= scan_width
,
4180 return cfg80211_inform_bss_frame_data(wiphy
, &data
, mgmt
, len
, gfp
);
4183 static inline struct cfg80211_bss
* __must_check
4184 cfg80211_inform_bss_frame(struct wiphy
*wiphy
,
4185 struct ieee80211_channel
*rx_channel
,
4186 struct ieee80211_mgmt
*mgmt
, size_t len
,
4187 s32 signal
, gfp_t gfp
)
4189 struct cfg80211_inform_bss data
= {
4191 .scan_width
= NL80211_BSS_CHAN_WIDTH_20
,
4195 return cfg80211_inform_bss_frame_data(wiphy
, &data
, mgmt
, len
, gfp
);
4199 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4200 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4201 * from a beacon or probe response
4202 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4203 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4205 enum cfg80211_bss_frame_type
{
4206 CFG80211_BSS_FTYPE_UNKNOWN
,
4207 CFG80211_BSS_FTYPE_BEACON
,
4208 CFG80211_BSS_FTYPE_PRESP
,
4212 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4214 * @wiphy: the wiphy reporting the BSS
4215 * @data: the BSS metadata
4216 * @ftype: frame type (if known)
4217 * @bssid: the BSSID of the BSS
4218 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4219 * @capability: the capability field sent by the peer
4220 * @beacon_interval: the beacon interval announced by the peer
4221 * @ie: additional IEs sent by the peer
4222 * @ielen: length of the additional IEs
4223 * @gfp: context flags
4225 * This informs cfg80211 that BSS information was found and
4226 * the BSS should be updated/added.
4228 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4229 * Or %NULL on error.
4231 struct cfg80211_bss
* __must_check
4232 cfg80211_inform_bss_data(struct wiphy
*wiphy
,
4233 struct cfg80211_inform_bss
*data
,
4234 enum cfg80211_bss_frame_type ftype
,
4235 const u8
*bssid
, u64 tsf
, u16 capability
,
4236 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
4239 static inline struct cfg80211_bss
* __must_check
4240 cfg80211_inform_bss_width(struct wiphy
*wiphy
,
4241 struct ieee80211_channel
*rx_channel
,
4242 enum nl80211_bss_scan_width scan_width
,
4243 enum cfg80211_bss_frame_type ftype
,
4244 const u8
*bssid
, u64 tsf
, u16 capability
,
4245 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
4246 s32 signal
, gfp_t gfp
)
4248 struct cfg80211_inform_bss data
= {
4250 .scan_width
= scan_width
,
4254 return cfg80211_inform_bss_data(wiphy
, &data
, ftype
, bssid
, tsf
,
4255 capability
, beacon_interval
, ie
, ielen
,
4259 static inline struct cfg80211_bss
* __must_check
4260 cfg80211_inform_bss(struct wiphy
*wiphy
,
4261 struct ieee80211_channel
*rx_channel
,
4262 enum cfg80211_bss_frame_type ftype
,
4263 const u8
*bssid
, u64 tsf
, u16 capability
,
4264 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
4265 s32 signal
, gfp_t gfp
)
4267 struct cfg80211_inform_bss data
= {
4269 .scan_width
= NL80211_BSS_CHAN_WIDTH_20
,
4273 return cfg80211_inform_bss_data(wiphy
, &data
, ftype
, bssid
, tsf
,
4274 capability
, beacon_interval
, ie
, ielen
,
4278 struct cfg80211_bss
*cfg80211_get_bss(struct wiphy
*wiphy
,
4279 struct ieee80211_channel
*channel
,
4281 const u8
*ssid
, size_t ssid_len
,
4282 enum ieee80211_bss_type bss_type
,
4283 enum ieee80211_privacy
);
4284 static inline struct cfg80211_bss
*
4285 cfg80211_get_ibss(struct wiphy
*wiphy
,
4286 struct ieee80211_channel
*channel
,
4287 const u8
*ssid
, size_t ssid_len
)
4289 return cfg80211_get_bss(wiphy
, channel
, NULL
, ssid
, ssid_len
,
4290 IEEE80211_BSS_TYPE_IBSS
,
4291 IEEE80211_PRIVACY_ANY
);
4295 * cfg80211_ref_bss - reference BSS struct
4296 * @wiphy: the wiphy this BSS struct belongs to
4297 * @bss: the BSS struct to reference
4299 * Increments the refcount of the given BSS struct.
4301 void cfg80211_ref_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
4304 * cfg80211_put_bss - unref BSS struct
4305 * @wiphy: the wiphy this BSS struct belongs to
4306 * @bss: the BSS struct
4308 * Decrements the refcount of the given BSS struct.
4310 void cfg80211_put_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
4313 * cfg80211_unlink_bss - unlink BSS from internal data structures
4315 * @bss: the bss to remove
4317 * This function removes the given BSS from the internal data structures
4318 * thereby making it no longer show up in scan results etc. Use this
4319 * function when you detect a BSS is gone. Normally BSSes will also time
4320 * out, so it is not necessary to use this function at all.
4322 void cfg80211_unlink_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
4324 static inline enum nl80211_bss_scan_width
4325 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def
*chandef
)
4327 switch (chandef
->width
) {
4328 case NL80211_CHAN_WIDTH_5
:
4329 return NL80211_BSS_CHAN_WIDTH_5
;
4330 case NL80211_CHAN_WIDTH_10
:
4331 return NL80211_BSS_CHAN_WIDTH_10
;
4333 return NL80211_BSS_CHAN_WIDTH_20
;
4338 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4339 * @dev: network device
4340 * @buf: authentication frame (header + body)
4341 * @len: length of the frame data
4343 * This function is called whenever an authentication, disassociation or
4344 * deauthentication frame has been received and processed in station mode.
4345 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4346 * call either this function or cfg80211_auth_timeout().
4347 * After being asked to associate via cfg80211_ops::assoc() the driver must
4348 * call either this function or cfg80211_auth_timeout().
4349 * While connected, the driver must calls this for received and processed
4350 * disassociation and deauthentication frames. If the frame couldn't be used
4351 * because it was unprotected, the driver must call the function
4352 * cfg80211_rx_unprot_mlme_mgmt() instead.
4354 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4356 void cfg80211_rx_mlme_mgmt(struct net_device
*dev
, const u8
*buf
, size_t len
);
4359 * cfg80211_auth_timeout - notification of timed out authentication
4360 * @dev: network device
4361 * @addr: The MAC address of the device with which the authentication timed out
4363 * This function may sleep. The caller must hold the corresponding wdev's
4366 void cfg80211_auth_timeout(struct net_device
*dev
, const u8
*addr
);
4369 * cfg80211_rx_assoc_resp - notification of processed association response
4370 * @dev: network device
4371 * @bss: the BSS that association was requested with, ownership of the pointer
4372 * moves to cfg80211 in this call
4373 * @buf: authentication frame (header + body)
4374 * @len: length of the frame data
4375 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4377 * After being asked to associate via cfg80211_ops::assoc() the driver must
4378 * call either this function or cfg80211_auth_timeout().
4380 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4382 void cfg80211_rx_assoc_resp(struct net_device
*dev
,
4383 struct cfg80211_bss
*bss
,
4384 const u8
*buf
, size_t len
,
4388 * cfg80211_assoc_timeout - notification of timed out association
4389 * @dev: network device
4390 * @bss: The BSS entry with which association timed out.
4392 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4394 void cfg80211_assoc_timeout(struct net_device
*dev
, struct cfg80211_bss
*bss
);
4397 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4398 * @dev: network device
4399 * @buf: 802.11 frame (header + body)
4400 * @len: length of the frame data
4402 * This function is called whenever deauthentication has been processed in
4403 * station mode. This includes both received deauthentication frames and
4404 * locally generated ones. This function may sleep. The caller must hold the
4405 * corresponding wdev's mutex.
4407 void cfg80211_tx_mlme_mgmt(struct net_device
*dev
, const u8
*buf
, size_t len
);
4410 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4411 * @dev: network device
4412 * @buf: deauthentication frame (header + body)
4413 * @len: length of the frame data
4415 * This function is called whenever a received deauthentication or dissassoc
4416 * frame has been dropped in station mode because of MFP being used but the
4417 * frame was not protected. This function may sleep.
4419 void cfg80211_rx_unprot_mlme_mgmt(struct net_device
*dev
,
4420 const u8
*buf
, size_t len
);
4423 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4424 * @dev: network device
4425 * @addr: The source MAC address of the frame
4426 * @key_type: The key type that the received frame used
4427 * @key_id: Key identifier (0..3). Can be -1 if missing.
4428 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4429 * @gfp: allocation flags
4431 * This function is called whenever the local MAC detects a MIC failure in a
4432 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4435 void cfg80211_michael_mic_failure(struct net_device
*dev
, const u8
*addr
,
4436 enum nl80211_key_type key_type
, int key_id
,
4437 const u8
*tsc
, gfp_t gfp
);
4440 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4442 * @dev: network device
4443 * @bssid: the BSSID of the IBSS joined
4444 * @channel: the channel of the IBSS joined
4445 * @gfp: allocation flags
4447 * This function notifies cfg80211 that the device joined an IBSS or
4448 * switched to a different BSSID. Before this function can be called,
4449 * either a beacon has to have been received from the IBSS, or one of
4450 * the cfg80211_inform_bss{,_frame} functions must have been called
4451 * with the locally generated beacon -- this guarantees that there is
4452 * always a scan result for this IBSS. cfg80211 will handle the rest.
4454 void cfg80211_ibss_joined(struct net_device
*dev
, const u8
*bssid
,
4455 struct ieee80211_channel
*channel
, gfp_t gfp
);
4458 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4460 * @dev: network device
4461 * @macaddr: the MAC address of the new candidate
4462 * @ie: information elements advertised by the peer candidate
4463 * @ie_len: lenght of the information elements buffer
4464 * @gfp: allocation flags
4466 * This function notifies cfg80211 that the mesh peer candidate has been
4467 * detected, most likely via a beacon or, less likely, via a probe response.
4468 * cfg80211 then sends a notification to userspace.
4470 void cfg80211_notify_new_peer_candidate(struct net_device
*dev
,
4471 const u8
*macaddr
, const u8
*ie
, u8 ie_len
, gfp_t gfp
);
4474 * DOC: RFkill integration
4476 * RFkill integration in cfg80211 is almost invisible to drivers,
4477 * as cfg80211 automatically registers an rfkill instance for each
4478 * wireless device it knows about. Soft kill is also translated
4479 * into disconnecting and turning all interfaces off, drivers are
4480 * expected to turn off the device when all interfaces are down.
4482 * However, devices may have a hard RFkill line, in which case they
4483 * also need to interact with the rfkill subsystem, via cfg80211.
4484 * They can do this with a few helper functions documented here.
4488 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4490 * @blocked: block status
4492 void wiphy_rfkill_set_hw_state(struct wiphy
*wiphy
, bool blocked
);
4495 * wiphy_rfkill_start_polling - start polling rfkill
4498 void wiphy_rfkill_start_polling(struct wiphy
*wiphy
);
4501 * wiphy_rfkill_stop_polling - stop polling rfkill
4504 void wiphy_rfkill_stop_polling(struct wiphy
*wiphy
);
4507 * DOC: Vendor commands
4509 * Occasionally, there are special protocol or firmware features that
4510 * can't be implemented very openly. For this and similar cases, the
4511 * vendor command functionality allows implementing the features with
4512 * (typically closed-source) userspace and firmware, using nl80211 as
4513 * the configuration mechanism.
4515 * A driver supporting vendor commands must register them as an array
4516 * in struct wiphy, with handlers for each one, each command has an
4517 * OUI and sub command ID to identify it.
4519 * Note that this feature should not be (ab)used to implement protocol
4520 * features that could openly be shared across drivers. In particular,
4521 * it must never be required to use vendor commands to implement any
4522 * "normal" functionality that higher-level userspace like connection
4523 * managers etc. need.
4526 struct sk_buff
*__cfg80211_alloc_reply_skb(struct wiphy
*wiphy
,
4527 enum nl80211_commands cmd
,
4528 enum nl80211_attrs attr
,
4531 struct sk_buff
*__cfg80211_alloc_event_skb(struct wiphy
*wiphy
,
4532 struct wireless_dev
*wdev
,
4533 enum nl80211_commands cmd
,
4534 enum nl80211_attrs attr
,
4535 int vendor_event_idx
,
4536 int approxlen
, gfp_t gfp
);
4538 void __cfg80211_send_event_skb(struct sk_buff
*skb
, gfp_t gfp
);
4541 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4543 * @approxlen: an upper bound of the length of the data that will
4544 * be put into the skb
4546 * This function allocates and pre-fills an skb for a reply to
4547 * a vendor command. Since it is intended for a reply, calling
4548 * it outside of a vendor command's doit() operation is invalid.
4550 * The returned skb is pre-filled with some identifying data in
4551 * a way that any data that is put into the skb (with skb_put(),
4552 * nla_put() or similar) will end up being within the
4553 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4554 * with the skb is adding data for the corresponding userspace tool
4555 * which can then read that data out of the vendor data attribute.
4556 * You must not modify the skb in any other way.
4558 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4559 * its error code as the result of the doit() operation.
4561 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4563 static inline struct sk_buff
*
4564 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy
*wiphy
, int approxlen
)
4566 return __cfg80211_alloc_reply_skb(wiphy
, NL80211_CMD_VENDOR
,
4567 NL80211_ATTR_VENDOR_DATA
, approxlen
);
4571 * cfg80211_vendor_cmd_reply - send the reply skb
4572 * @skb: The skb, must have been allocated with
4573 * cfg80211_vendor_cmd_alloc_reply_skb()
4575 * Since calling this function will usually be the last thing
4576 * before returning from the vendor command doit() you should
4577 * return the error code. Note that this function consumes the
4578 * skb regardless of the return value.
4580 * Return: An error code or 0 on success.
4582 int cfg80211_vendor_cmd_reply(struct sk_buff
*skb
);
4585 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4587 * @wdev: the wireless device
4588 * @event_idx: index of the vendor event in the wiphy's vendor_events
4589 * @approxlen: an upper bound of the length of the data that will
4590 * be put into the skb
4591 * @gfp: allocation flags
4593 * This function allocates and pre-fills an skb for an event on the
4594 * vendor-specific multicast group.
4596 * If wdev != NULL, both the ifindex and identifier of the specified
4597 * wireless device are added to the event message before the vendor data
4600 * When done filling the skb, call cfg80211_vendor_event() with the
4601 * skb to send the event.
4603 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4605 static inline struct sk_buff
*
4606 cfg80211_vendor_event_alloc(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
4607 int approxlen
, int event_idx
, gfp_t gfp
)
4609 return __cfg80211_alloc_event_skb(wiphy
, wdev
, NL80211_CMD_VENDOR
,
4610 NL80211_ATTR_VENDOR_DATA
,
4611 event_idx
, approxlen
, gfp
);
4615 * cfg80211_vendor_event - send the event
4616 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4617 * @gfp: allocation flags
4619 * This function sends the given @skb, which must have been allocated
4620 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4622 static inline void cfg80211_vendor_event(struct sk_buff
*skb
, gfp_t gfp
)
4624 __cfg80211_send_event_skb(skb
, gfp
);
4627 #ifdef CONFIG_NL80211_TESTMODE
4631 * Test mode is a set of utility functions to allow drivers to
4632 * interact with driver-specific tools to aid, for instance,
4633 * factory programming.
4635 * This chapter describes how drivers interact with it, for more
4636 * information see the nl80211 book's chapter on it.
4640 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4642 * @approxlen: an upper bound of the length of the data that will
4643 * be put into the skb
4645 * This function allocates and pre-fills an skb for a reply to
4646 * the testmode command. Since it is intended for a reply, calling
4647 * it outside of the @testmode_cmd operation is invalid.
4649 * The returned skb is pre-filled with the wiphy index and set up in
4650 * a way that any data that is put into the skb (with skb_put(),
4651 * nla_put() or similar) will end up being within the
4652 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4653 * with the skb is adding data for the corresponding userspace tool
4654 * which can then read that data out of the testdata attribute. You
4655 * must not modify the skb in any other way.
4657 * When done, call cfg80211_testmode_reply() with the skb and return
4658 * its error code as the result of the @testmode_cmd operation.
4660 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4662 static inline struct sk_buff
*
4663 cfg80211_testmode_alloc_reply_skb(struct wiphy
*wiphy
, int approxlen
)
4665 return __cfg80211_alloc_reply_skb(wiphy
, NL80211_CMD_TESTMODE
,
4666 NL80211_ATTR_TESTDATA
, approxlen
);
4670 * cfg80211_testmode_reply - send the reply skb
4671 * @skb: The skb, must have been allocated with
4672 * cfg80211_testmode_alloc_reply_skb()
4674 * Since calling this function will usually be the last thing
4675 * before returning from the @testmode_cmd you should return
4676 * the error code. Note that this function consumes the skb
4677 * regardless of the return value.
4679 * Return: An error code or 0 on success.
4681 static inline int cfg80211_testmode_reply(struct sk_buff
*skb
)
4683 return cfg80211_vendor_cmd_reply(skb
);
4687 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4689 * @approxlen: an upper bound of the length of the data that will
4690 * be put into the skb
4691 * @gfp: allocation flags
4693 * This function allocates and pre-fills an skb for an event on the
4694 * testmode multicast group.
4696 * The returned skb is set up in the same way as with
4697 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4698 * there, you should simply add data to it that will then end up in the
4699 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4702 * When done filling the skb, call cfg80211_testmode_event() with the
4703 * skb to send the event.
4705 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4707 static inline struct sk_buff
*
4708 cfg80211_testmode_alloc_event_skb(struct wiphy
*wiphy
, int approxlen
, gfp_t gfp
)
4710 return __cfg80211_alloc_event_skb(wiphy
, NULL
, NL80211_CMD_TESTMODE
,
4711 NL80211_ATTR_TESTDATA
, -1,
4716 * cfg80211_testmode_event - send the event
4717 * @skb: The skb, must have been allocated with
4718 * cfg80211_testmode_alloc_event_skb()
4719 * @gfp: allocation flags
4721 * This function sends the given @skb, which must have been allocated
4722 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4725 static inline void cfg80211_testmode_event(struct sk_buff
*skb
, gfp_t gfp
)
4727 __cfg80211_send_event_skb(skb
, gfp
);
4730 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4731 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4733 #define CFG80211_TESTMODE_CMD(cmd)
4734 #define CFG80211_TESTMODE_DUMP(cmd)
4738 * cfg80211_connect_bss - notify cfg80211 of connection result
4740 * @dev: network device
4741 * @bssid: the BSSID of the AP
4742 * @bss: entry of bss to which STA got connected to, can be obtained
4743 * through cfg80211_get_bss (may be %NULL)
4744 * @req_ie: association request IEs (maybe be %NULL)
4745 * @req_ie_len: association request IEs length
4746 * @resp_ie: association response IEs (may be %NULL)
4747 * @resp_ie_len: assoc response IEs length
4748 * @status: status code, 0 for successful connection, use
4749 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4750 * the real status code for failures.
4751 * @gfp: allocation flags
4753 * It should be called by the underlying driver whenever connect() has
4754 * succeeded. This is similar to cfg80211_connect_result(), but with the
4755 * option of identifying the exact bss entry for the connection. Only one of
4756 * these functions should be called.
4758 void cfg80211_connect_bss(struct net_device
*dev
, const u8
*bssid
,
4759 struct cfg80211_bss
*bss
, const u8
*req_ie
,
4760 size_t req_ie_len
, const u8
*resp_ie
,
4761 size_t resp_ie_len
, int status
, gfp_t gfp
);
4764 * cfg80211_connect_result - notify cfg80211 of connection result
4766 * @dev: network device
4767 * @bssid: the BSSID of the AP
4768 * @req_ie: association request IEs (maybe be %NULL)
4769 * @req_ie_len: association request IEs length
4770 * @resp_ie: association response IEs (may be %NULL)
4771 * @resp_ie_len: assoc response IEs length
4772 * @status: status code, 0 for successful connection, use
4773 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4774 * the real status code for failures.
4775 * @gfp: allocation flags
4777 * It should be called by the underlying driver whenever connect() has
4781 cfg80211_connect_result(struct net_device
*dev
, const u8
*bssid
,
4782 const u8
*req_ie
, size_t req_ie_len
,
4783 const u8
*resp_ie
, size_t resp_ie_len
,
4784 u16 status
, gfp_t gfp
)
4786 cfg80211_connect_bss(dev
, bssid
, NULL
, req_ie
, req_ie_len
, resp_ie
,
4787 resp_ie_len
, status
, gfp
);
4791 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
4793 * @dev: network device
4794 * @bssid: the BSSID of the AP
4795 * @req_ie: association request IEs (maybe be %NULL)
4796 * @req_ie_len: association request IEs length
4797 * @gfp: allocation flags
4799 * It should be called by the underlying driver whenever connect() has failed
4800 * in a sequence where no explicit authentication/association rejection was
4801 * received from the AP. This could happen, e.g., due to not being able to send
4802 * out the Authentication or Association Request frame or timing out while
4803 * waiting for the response.
4806 cfg80211_connect_timeout(struct net_device
*dev
, const u8
*bssid
,
4807 const u8
*req_ie
, size_t req_ie_len
, gfp_t gfp
)
4809 cfg80211_connect_bss(dev
, bssid
, NULL
, req_ie
, req_ie_len
, NULL
, 0, -1,
4814 * cfg80211_roamed - notify cfg80211 of roaming
4816 * @dev: network device
4817 * @channel: the channel of the new AP
4818 * @bssid: the BSSID of the new AP
4819 * @req_ie: association request IEs (maybe be %NULL)
4820 * @req_ie_len: association request IEs length
4821 * @resp_ie: association response IEs (may be %NULL)
4822 * @resp_ie_len: assoc response IEs length
4823 * @gfp: allocation flags
4825 * It should be called by the underlying driver whenever it roamed
4826 * from one AP to another while connected.
4828 void cfg80211_roamed(struct net_device
*dev
,
4829 struct ieee80211_channel
*channel
,
4831 const u8
*req_ie
, size_t req_ie_len
,
4832 const u8
*resp_ie
, size_t resp_ie_len
, gfp_t gfp
);
4835 * cfg80211_roamed_bss - notify cfg80211 of roaming
4837 * @dev: network device
4838 * @bss: entry of bss to which STA got roamed
4839 * @req_ie: association request IEs (maybe be %NULL)
4840 * @req_ie_len: association request IEs length
4841 * @resp_ie: association response IEs (may be %NULL)
4842 * @resp_ie_len: assoc response IEs length
4843 * @gfp: allocation flags
4845 * This is just a wrapper to notify cfg80211 of roaming event with driver
4846 * passing bss to avoid a race in timeout of the bss entry. It should be
4847 * called by the underlying driver whenever it roamed from one AP to another
4848 * while connected. Drivers which have roaming implemented in firmware
4849 * may use this function to avoid a race in bss entry timeout where the bss
4850 * entry of the new AP is seen in the driver, but gets timed out by the time
4851 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4852 * rdev->event_work. In case of any failures, the reference is released
4853 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4854 * it will be released while diconneting from the current bss.
4856 void cfg80211_roamed_bss(struct net_device
*dev
, struct cfg80211_bss
*bss
,
4857 const u8
*req_ie
, size_t req_ie_len
,
4858 const u8
*resp_ie
, size_t resp_ie_len
, gfp_t gfp
);
4861 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4863 * @dev: network device
4864 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4865 * @ie_len: length of IEs
4866 * @reason: reason code for the disconnection, set it to 0 if unknown
4867 * @locally_generated: disconnection was requested locally
4868 * @gfp: allocation flags
4870 * After it calls this function, the driver should enter an idle state
4871 * and not try to connect to any AP any more.
4873 void cfg80211_disconnected(struct net_device
*dev
, u16 reason
,
4874 const u8
*ie
, size_t ie_len
,
4875 bool locally_generated
, gfp_t gfp
);
4878 * cfg80211_ready_on_channel - notification of remain_on_channel start
4879 * @wdev: wireless device
4880 * @cookie: the request cookie
4881 * @chan: The current channel (from remain_on_channel request)
4882 * @duration: Duration in milliseconds that the driver intents to remain on the
4884 * @gfp: allocation flags
4886 void cfg80211_ready_on_channel(struct wireless_dev
*wdev
, u64 cookie
,
4887 struct ieee80211_channel
*chan
,
4888 unsigned int duration
, gfp_t gfp
);
4891 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4892 * @wdev: wireless device
4893 * @cookie: the request cookie
4894 * @chan: The current channel (from remain_on_channel request)
4895 * @gfp: allocation flags
4897 void cfg80211_remain_on_channel_expired(struct wireless_dev
*wdev
, u64 cookie
,
4898 struct ieee80211_channel
*chan
,
4903 * cfg80211_new_sta - notify userspace about station
4906 * @mac_addr: the station's address
4907 * @sinfo: the station information
4908 * @gfp: allocation flags
4910 void cfg80211_new_sta(struct net_device
*dev
, const u8
*mac_addr
,
4911 struct station_info
*sinfo
, gfp_t gfp
);
4914 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4916 * @mac_addr: the station's address
4917 * @sinfo: the station information/statistics
4918 * @gfp: allocation flags
4920 void cfg80211_del_sta_sinfo(struct net_device
*dev
, const u8
*mac_addr
,
4921 struct station_info
*sinfo
, gfp_t gfp
);
4924 * cfg80211_del_sta - notify userspace about deletion of a station
4927 * @mac_addr: the station's address
4928 * @gfp: allocation flags
4930 static inline void cfg80211_del_sta(struct net_device
*dev
,
4931 const u8
*mac_addr
, gfp_t gfp
)
4933 cfg80211_del_sta_sinfo(dev
, mac_addr
, NULL
, gfp
);
4937 * cfg80211_conn_failed - connection request failed notification
4940 * @mac_addr: the station's address
4941 * @reason: the reason for connection failure
4942 * @gfp: allocation flags
4944 * Whenever a station tries to connect to an AP and if the station
4945 * could not connect to the AP as the AP has rejected the connection
4946 * for some reasons, this function is called.
4948 * The reason for connection failure can be any of the value from
4949 * nl80211_connect_failed_reason enum
4951 void cfg80211_conn_failed(struct net_device
*dev
, const u8
*mac_addr
,
4952 enum nl80211_connect_failed_reason reason
,
4956 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4957 * @wdev: wireless device receiving the frame
4958 * @freq: Frequency on which the frame was received in MHz
4959 * @sig_dbm: signal strength in mBm, or 0 if unknown
4960 * @buf: Management frame (header + body)
4961 * @len: length of the frame data
4962 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4964 * This function is called whenever an Action frame is received for a station
4965 * mode interface, but is not processed in kernel.
4967 * Return: %true if a user space application has registered for this frame.
4968 * For action frames, that makes it responsible for rejecting unrecognized
4969 * action frames; %false otherwise, in which case for action frames the
4970 * driver is responsible for rejecting the frame.
4972 bool cfg80211_rx_mgmt(struct wireless_dev
*wdev
, int freq
, int sig_dbm
,
4973 const u8
*buf
, size_t len
, u32 flags
);
4976 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4977 * @wdev: wireless device receiving the frame
4978 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4979 * @buf: Management frame (header + body)
4980 * @len: length of the frame data
4981 * @ack: Whether frame was acknowledged
4982 * @gfp: context flags
4984 * This function is called whenever a management frame was requested to be
4985 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4986 * transmission attempt.
4988 void cfg80211_mgmt_tx_status(struct wireless_dev
*wdev
, u64 cookie
,
4989 const u8
*buf
, size_t len
, bool ack
, gfp_t gfp
);
4993 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4994 * @dev: network device
4995 * @rssi_event: the triggered RSSI event
4996 * @gfp: context flags
4998 * This function is called when a configured connection quality monitoring
4999 * rssi threshold reached event occurs.
5001 void cfg80211_cqm_rssi_notify(struct net_device
*dev
,
5002 enum nl80211_cqm_rssi_threshold_event rssi_event
,
5006 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5007 * @dev: network device
5008 * @peer: peer's MAC address
5009 * @num_packets: how many packets were lost -- should be a fixed threshold
5010 * but probably no less than maybe 50, or maybe a throughput dependent
5011 * threshold (to account for temporary interference)
5012 * @gfp: context flags
5014 void cfg80211_cqm_pktloss_notify(struct net_device
*dev
,
5015 const u8
*peer
, u32 num_packets
, gfp_t gfp
);
5018 * cfg80211_cqm_txe_notify - TX error rate event
5019 * @dev: network device
5020 * @peer: peer's MAC address
5021 * @num_packets: how many packets were lost
5022 * @rate: % of packets which failed transmission
5023 * @intvl: interval (in s) over which the TX failure threshold was breached.
5024 * @gfp: context flags
5026 * Notify userspace when configured % TX failures over number of packets in a
5027 * given interval is exceeded.
5029 void cfg80211_cqm_txe_notify(struct net_device
*dev
, const u8
*peer
,
5030 u32 num_packets
, u32 rate
, u32 intvl
, gfp_t gfp
);
5033 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5034 * @dev: network device
5035 * @gfp: context flags
5037 * Notify userspace about beacon loss from the connected AP.
5039 void cfg80211_cqm_beacon_loss_notify(struct net_device
*dev
, gfp_t gfp
);
5042 * cfg80211_radar_event - radar detection event
5044 * @chandef: chandef for the current channel
5045 * @gfp: context flags
5047 * This function is called when a radar is detected on the current chanenl.
5049 void cfg80211_radar_event(struct wiphy
*wiphy
,
5050 struct cfg80211_chan_def
*chandef
, gfp_t gfp
);
5053 * cfg80211_cac_event - Channel availability check (CAC) event
5054 * @netdev: network device
5055 * @chandef: chandef for the current channel
5056 * @event: type of event
5057 * @gfp: context flags
5059 * This function is called when a Channel availability check (CAC) is finished
5060 * or aborted. This must be called to notify the completion of a CAC process,
5061 * also by full-MAC drivers.
5063 void cfg80211_cac_event(struct net_device
*netdev
,
5064 const struct cfg80211_chan_def
*chandef
,
5065 enum nl80211_radar_event event
, gfp_t gfp
);
5069 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5070 * @dev: network device
5071 * @bssid: BSSID of AP (to avoid races)
5072 * @replay_ctr: new replay counter
5073 * @gfp: allocation flags
5075 void cfg80211_gtk_rekey_notify(struct net_device
*dev
, const u8
*bssid
,
5076 const u8
*replay_ctr
, gfp_t gfp
);
5079 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5080 * @dev: network device
5081 * @index: candidate index (the smaller the index, the higher the priority)
5082 * @bssid: BSSID of AP
5083 * @preauth: Whether AP advertises support for RSN pre-authentication
5084 * @gfp: allocation flags
5086 void cfg80211_pmksa_candidate_notify(struct net_device
*dev
, int index
,
5087 const u8
*bssid
, bool preauth
, gfp_t gfp
);
5090 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5091 * @dev: The device the frame matched to
5092 * @addr: the transmitter address
5093 * @gfp: context flags
5095 * This function is used in AP mode (only!) to inform userspace that
5096 * a spurious class 3 frame was received, to be able to deauth the
5098 * Return: %true if the frame was passed to userspace (or this failed
5099 * for a reason other than not having a subscription.)
5101 bool cfg80211_rx_spurious_frame(struct net_device
*dev
,
5102 const u8
*addr
, gfp_t gfp
);
5105 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5106 * @dev: The device the frame matched to
5107 * @addr: the transmitter address
5108 * @gfp: context flags
5110 * This function is used in AP mode (only!) to inform userspace that
5111 * an associated station sent a 4addr frame but that wasn't expected.
5112 * It is allowed and desirable to send this event only once for each
5113 * station to avoid event flooding.
5114 * Return: %true if the frame was passed to userspace (or this failed
5115 * for a reason other than not having a subscription.)
5117 bool cfg80211_rx_unexpected_4addr_frame(struct net_device
*dev
,
5118 const u8
*addr
, gfp_t gfp
);
5121 * cfg80211_probe_status - notify userspace about probe status
5122 * @dev: the device the probe was sent on
5123 * @addr: the address of the peer
5124 * @cookie: the cookie filled in @probe_client previously
5125 * @acked: indicates whether probe was acked or not
5126 * @gfp: allocation flags
5128 void cfg80211_probe_status(struct net_device
*dev
, const u8
*addr
,
5129 u64 cookie
, bool acked
, gfp_t gfp
);
5132 * cfg80211_report_obss_beacon - report beacon from other APs
5133 * @wiphy: The wiphy that received the beacon
5135 * @len: length of the frame
5136 * @freq: frequency the frame was received on
5137 * @sig_dbm: signal strength in mBm, or 0 if unknown
5139 * Use this function to report to userspace when a beacon was
5140 * received. It is not useful to call this when there is no
5141 * netdev that is in AP/GO mode.
5143 void cfg80211_report_obss_beacon(struct wiphy
*wiphy
,
5144 const u8
*frame
, size_t len
,
5145 int freq
, int sig_dbm
);
5148 * cfg80211_reg_can_beacon - check if beaconing is allowed
5150 * @chandef: the channel definition
5151 * @iftype: interface type
5153 * Return: %true if there is no secondary channel or the secondary channel(s)
5154 * can be used for beaconing (i.e. is not a radar channel etc.)
5156 bool cfg80211_reg_can_beacon(struct wiphy
*wiphy
,
5157 struct cfg80211_chan_def
*chandef
,
5158 enum nl80211_iftype iftype
);
5161 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5163 * @chandef: the channel definition
5164 * @iftype: interface type
5166 * Return: %true if there is no secondary channel or the secondary channel(s)
5167 * can be used for beaconing (i.e. is not a radar channel etc.). This version
5168 * also checks if IR-relaxation conditions apply, to allow beaconing under
5169 * more permissive conditions.
5171 * Requires the RTNL to be held.
5173 bool cfg80211_reg_can_beacon_relax(struct wiphy
*wiphy
,
5174 struct cfg80211_chan_def
*chandef
,
5175 enum nl80211_iftype iftype
);
5178 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5179 * @dev: the device which switched channels
5180 * @chandef: the new channel definition
5182 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5185 void cfg80211_ch_switch_notify(struct net_device
*dev
,
5186 struct cfg80211_chan_def
*chandef
);
5189 * cfg80211_ch_switch_started_notify - notify channel switch start
5190 * @dev: the device on which the channel switch started
5191 * @chandef: the future channel definition
5192 * @count: the number of TBTTs until the channel switch happens
5194 * Inform the userspace about the channel switch that has just
5195 * started, so that it can take appropriate actions (eg. starting
5196 * channel switch on other vifs), if necessary.
5198 void cfg80211_ch_switch_started_notify(struct net_device
*dev
,
5199 struct cfg80211_chan_def
*chandef
,
5203 * ieee80211_operating_class_to_band - convert operating class to band
5205 * @operating_class: the operating class to convert
5206 * @band: band pointer to fill
5208 * Returns %true if the conversion was successful, %false otherwise.
5210 bool ieee80211_operating_class_to_band(u8 operating_class
,
5211 enum nl80211_band
*band
);
5214 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5216 * @chandef: the chandef to convert
5217 * @op_class: a pointer to the resulting operating class
5219 * Returns %true if the conversion was successful, %false otherwise.
5221 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def
*chandef
,
5225 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5226 * @dev: the device on which the operation is requested
5227 * @peer: the MAC address of the peer device
5228 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5229 * NL80211_TDLS_TEARDOWN)
5230 * @reason_code: the reason code for teardown request
5231 * @gfp: allocation flags
5233 * This function is used to request userspace to perform TDLS operation that
5234 * requires knowledge of keys, i.e., link setup or teardown when the AP
5235 * connection uses encryption. This is optional mechanism for the driver to use
5236 * if it can automatically determine when a TDLS link could be useful (e.g.,
5237 * based on traffic and signal strength for a peer).
5239 void cfg80211_tdls_oper_request(struct net_device
*dev
, const u8
*peer
,
5240 enum nl80211_tdls_operation oper
,
5241 u16 reason_code
, gfp_t gfp
);
5244 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5245 * @rate: given rate_info to calculate bitrate from
5247 * return 0 if MCS index >= 32
5249 u32
cfg80211_calculate_bitrate(struct rate_info
*rate
);
5252 * cfg80211_unregister_wdev - remove the given wdev
5253 * @wdev: struct wireless_dev to remove
5255 * Call this function only for wdevs that have no netdev assigned,
5256 * e.g. P2P Devices. It removes the device from the list so that
5257 * it can no longer be used. It is necessary to call this function
5258 * even when cfg80211 requests the removal of the interface by
5259 * calling the del_virtual_intf() callback. The function must also
5260 * be called when the driver wishes to unregister the wdev, e.g.
5261 * when the device is unbound from the driver.
5263 * Requires the RTNL to be held.
5265 void cfg80211_unregister_wdev(struct wireless_dev
*wdev
);
5268 * struct cfg80211_ft_event - FT Information Elements
5270 * @ies_len: length of the FT IE in bytes
5271 * @target_ap: target AP's MAC address
5273 * @ric_ies_len: length of the RIC IE in bytes
5275 struct cfg80211_ft_event_params
{
5278 const u8
*target_ap
;
5284 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5285 * @netdev: network device
5286 * @ft_event: IE information
5288 void cfg80211_ft_event(struct net_device
*netdev
,
5289 struct cfg80211_ft_event_params
*ft_event
);
5292 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5293 * @ies: the input IE buffer
5294 * @len: the input length
5295 * @attr: the attribute ID to find
5296 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5297 * if the function is only called to get the needed buffer size
5298 * @bufsize: size of the output buffer
5300 * The function finds a given P2P attribute in the (vendor) IEs and
5301 * copies its contents to the given buffer.
5303 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5304 * malformed or the attribute can't be found (respectively), or the
5305 * length of the found attribute (which can be zero).
5307 int cfg80211_get_p2p_attr(const u8
*ies
, unsigned int len
,
5308 enum ieee80211_p2p_attr_id attr
,
5309 u8
*buf
, unsigned int bufsize
);
5312 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5313 * @ies: the IE buffer
5314 * @ielen: the length of the IE buffer
5315 * @ids: an array with element IDs that are allowed before
5317 * @n_ids: the size of the element ID array
5318 * @after_ric: array IE types that come after the RIC element
5319 * @n_after_ric: size of the @after_ric array
5320 * @offset: offset where to start splitting in the buffer
5322 * This function splits an IE buffer by updating the @offset
5323 * variable to point to the location where the buffer should be
5326 * It assumes that the given IE buffer is well-formed, this
5327 * has to be guaranteed by the caller!
5329 * It also assumes that the IEs in the buffer are ordered
5330 * correctly, if not the result of using this function will not
5331 * be ordered correctly either, i.e. it does no reordering.
5333 * The function returns the offset where the next part of the
5334 * buffer starts, which may be @ielen if the entire (remainder)
5335 * of the buffer should be used.
5337 size_t ieee80211_ie_split_ric(const u8
*ies
, size_t ielen
,
5338 const u8
*ids
, int n_ids
,
5339 const u8
*after_ric
, int n_after_ric
,
5343 * ieee80211_ie_split - split an IE buffer according to ordering
5344 * @ies: the IE buffer
5345 * @ielen: the length of the IE buffer
5346 * @ids: an array with element IDs that are allowed before
5348 * @n_ids: the size of the element ID array
5349 * @offset: offset where to start splitting in the buffer
5351 * This function splits an IE buffer by updating the @offset
5352 * variable to point to the location where the buffer should be
5355 * It assumes that the given IE buffer is well-formed, this
5356 * has to be guaranteed by the caller!
5358 * It also assumes that the IEs in the buffer are ordered
5359 * correctly, if not the result of using this function will not
5360 * be ordered correctly either, i.e. it does no reordering.
5362 * The function returns the offset where the next part of the
5363 * buffer starts, which may be @ielen if the entire (remainder)
5364 * of the buffer should be used.
5366 static inline size_t ieee80211_ie_split(const u8
*ies
, size_t ielen
,
5367 const u8
*ids
, int n_ids
, size_t offset
)
5369 return ieee80211_ie_split_ric(ies
, ielen
, ids
, n_ids
, NULL
, 0, offset
);
5373 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5374 * @wdev: the wireless device reporting the wakeup
5375 * @wakeup: the wakeup report
5376 * @gfp: allocation flags
5378 * This function reports that the given device woke up. If it
5379 * caused the wakeup, report the reason(s), otherwise you may
5380 * pass %NULL as the @wakeup parameter to advertise that something
5381 * else caused the wakeup.
5383 void cfg80211_report_wowlan_wakeup(struct wireless_dev
*wdev
,
5384 struct cfg80211_wowlan_wakeup
*wakeup
,
5388 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5390 * @wdev: the wireless device for which critical protocol is stopped.
5391 * @gfp: allocation flags
5393 * This function can be called by the driver to indicate it has reverted
5394 * operation back to normal. One reason could be that the duration given
5395 * by .crit_proto_start() has expired.
5397 void cfg80211_crit_proto_stopped(struct wireless_dev
*wdev
, gfp_t gfp
);
5400 * ieee80211_get_num_supported_channels - get number of channels device has
5403 * Return: the number of channels supported by the device.
5405 unsigned int ieee80211_get_num_supported_channels(struct wiphy
*wiphy
);
5408 * cfg80211_check_combinations - check interface combinations
5411 * @num_different_channels: the number of different channels we want
5412 * to use for verification
5413 * @radar_detect: a bitmap where each bit corresponds to a channel
5414 * width where radar detection is needed, as in the definition of
5415 * &struct ieee80211_iface_combination.@radar_detect_widths
5416 * @iftype_num: array with the numbers of interfaces of each interface
5417 * type. The index is the interface type as specified in &enum
5420 * This function can be called by the driver to check whether a
5421 * combination of interfaces and their types are allowed according to
5422 * the interface combinations.
5424 int cfg80211_check_combinations(struct wiphy
*wiphy
,
5425 const int num_different_channels
,
5426 const u8 radar_detect
,
5427 const int iftype_num
[NUM_NL80211_IFTYPES
]);
5430 * cfg80211_iter_combinations - iterate over matching combinations
5433 * @num_different_channels: the number of different channels we want
5434 * to use for verification
5435 * @radar_detect: a bitmap where each bit corresponds to a channel
5436 * width where radar detection is needed, as in the definition of
5437 * &struct ieee80211_iface_combination.@radar_detect_widths
5438 * @iftype_num: array with the numbers of interfaces of each interface
5439 * type. The index is the interface type as specified in &enum
5441 * @iter: function to call for each matching combination
5442 * @data: pointer to pass to iter function
5444 * This function can be called by the driver to check what possible
5445 * combinations it fits in at a given moment, e.g. for channel switching
5448 int cfg80211_iter_combinations(struct wiphy
*wiphy
,
5449 const int num_different_channels
,
5450 const u8 radar_detect
,
5451 const int iftype_num
[NUM_NL80211_IFTYPES
],
5452 void (*iter
)(const struct ieee80211_iface_combination
*c
,
5457 * cfg80211_stop_iface - trigger interface disconnection
5460 * @wdev: wireless device
5461 * @gfp: context flags
5463 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5466 * Note: This doesn't need any locks and is asynchronous.
5468 void cfg80211_stop_iface(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
5472 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5473 * @wiphy: the wiphy to shut down
5475 * This function shuts down all interfaces belonging to this wiphy by
5476 * calling dev_close() (and treating non-netdev interfaces as needed).
5477 * It shouldn't really be used unless there are some fatal device errors
5478 * that really can't be recovered in any other way.
5480 * Callers must hold the RTNL and be able to deal with callbacks into
5481 * the driver while the function is running.
5483 void cfg80211_shutdown_all_interfaces(struct wiphy
*wiphy
);
5486 * wiphy_ext_feature_set - set the extended feature flag
5488 * @wiphy: the wiphy to modify.
5489 * @ftidx: extended feature bit index.
5491 * The extended features are flagged in multiple bytes (see
5492 * &struct wiphy.@ext_features)
5494 static inline void wiphy_ext_feature_set(struct wiphy
*wiphy
,
5495 enum nl80211_ext_feature_index ftidx
)
5499 ft_byte
= &wiphy
->ext_features
[ftidx
/ 8];
5500 *ft_byte
|= BIT(ftidx
% 8);
5504 * wiphy_ext_feature_isset - check the extended feature flag
5506 * @wiphy: the wiphy to modify.
5507 * @ftidx: extended feature bit index.
5509 * The extended features are flagged in multiple bytes (see
5510 * &struct wiphy.@ext_features)
5513 wiphy_ext_feature_isset(struct wiphy
*wiphy
,
5514 enum nl80211_ext_feature_index ftidx
)
5518 ft_byte
= wiphy
->ext_features
[ftidx
/ 8];
5519 return (ft_byte
& BIT(ftidx
% 8)) != 0;
5522 /* ethtool helper */
5523 void cfg80211_get_drvinfo(struct net_device
*dev
, struct ethtool_drvinfo
*info
);
5525 /* Logging, debugging and troubleshooting/diagnostic helpers. */
5527 /* wiphy_printk helpers, similar to dev_printk */
5529 #define wiphy_printk(level, wiphy, format, args...) \
5530 dev_printk(level, &(wiphy)->dev, format, ##args)
5531 #define wiphy_emerg(wiphy, format, args...) \
5532 dev_emerg(&(wiphy)->dev, format, ##args)
5533 #define wiphy_alert(wiphy, format, args...) \
5534 dev_alert(&(wiphy)->dev, format, ##args)
5535 #define wiphy_crit(wiphy, format, args...) \
5536 dev_crit(&(wiphy)->dev, format, ##args)
5537 #define wiphy_err(wiphy, format, args...) \
5538 dev_err(&(wiphy)->dev, format, ##args)
5539 #define wiphy_warn(wiphy, format, args...) \
5540 dev_warn(&(wiphy)->dev, format, ##args)
5541 #define wiphy_notice(wiphy, format, args...) \
5542 dev_notice(&(wiphy)->dev, format, ##args)
5543 #define wiphy_info(wiphy, format, args...) \
5544 dev_info(&(wiphy)->dev, format, ##args)
5546 #define wiphy_debug(wiphy, format, args...) \
5547 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5549 #define wiphy_dbg(wiphy, format, args...) \
5550 dev_dbg(&(wiphy)->dev, format, ##args)
5552 #if defined(VERBOSE_DEBUG)
5553 #define wiphy_vdbg wiphy_dbg
5555 #define wiphy_vdbg(wiphy, format, args...) \
5558 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5564 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5565 * of using a WARN/WARN_ON to get the message out, including the
5566 * file/line information and a backtrace.
5568 #define wiphy_WARN(wiphy, format, args...) \
5569 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5571 #endif /* __NET_CFG80211_H */