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 * @plink_action: plink action to take
784 * @plink_state: set the peer link state for a station
785 * @ht_capa: HT capabilities of station
786 * @vht_capa: VHT capabilities of station
787 * @uapsd_queues: bitmap of queues configured for uapsd. same format
788 * as the AC bitmap in the QoS info field
789 * @max_sp: max Service Period. same format as the MAX_SP in the
790 * QoS info field (but already shifted down)
791 * @sta_modify_mask: bitmap indicating which parameters changed
792 * (for those that don't have a natural "no change" value),
793 * see &enum station_parameters_apply_mask
794 * @local_pm: local link-specific mesh power save mode (no change when set
796 * @capability: station capability
797 * @ext_capab: extended capabilities of the station
798 * @ext_capab_len: number of extended capabilities
799 * @supported_channels: supported channels in IEEE 802.11 format
800 * @supported_channels_len: number of supported channels
801 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
802 * @supported_oper_classes_len: number of supported operating classes
803 * @opmode_notif: operating mode field from Operating Mode Notification
804 * @opmode_notif_used: information if operating mode field is used
805 * @support_p2p_ps: information if station supports P2P PS mechanism
807 struct station_parameters {
808 const u8 *supported_rates;
809 struct net_device *vlan;
810 u32 sta_flags_mask, sta_flags_set;
814 u8 supported_rates_len;
817 const struct ieee80211_ht_cap *ht_capa;
818 const struct ieee80211_vht_cap *vht_capa;
821 enum nl80211_mesh_power_mode local_pm;
825 const u8 *supported_channels;
826 u8 supported_channels_len;
827 const u8 *supported_oper_classes;
828 u8 supported_oper_classes_len;
830 bool opmode_notif_used;
835 * struct station_del_parameters - station deletion parameters
837 * Used to delete a station entry (or all stations).
839 * @mac: MAC address of the station to remove or NULL to remove all stations
840 * @subtype: Management frame subtype to use for indicating removal
841 * (10 = Disassociation, 12 = Deauthentication)
842 * @reason_code: Reason code for the Disassociation/Deauthentication frame
844 struct station_del_parameters {
851 * enum cfg80211_station_type - the type of station being modified
852 * @CFG80211_STA_AP_CLIENT: client of an AP interface
853 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
854 * unassociated (update properties for this type of client is permitted)
855 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
856 * the AP MLME in the device
857 * @CFG80211_STA_AP_STA: AP station on managed interface
858 * @CFG80211_STA_IBSS: IBSS station
859 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
860 * while TDLS setup is in progress, it moves out of this state when
861 * being marked authorized; use this only if TDLS with external setup is
863 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
864 * entry that is operating, has been marked authorized by userspace)
865 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
866 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
868 enum cfg80211_station_type {
869 CFG80211_STA_AP_CLIENT,
870 CFG80211_STA_AP_CLIENT_UNASSOC,
871 CFG80211_STA_AP_MLME_CLIENT,
874 CFG80211_STA_TDLS_PEER_SETUP,
875 CFG80211_STA_TDLS_PEER_ACTIVE,
876 CFG80211_STA_MESH_PEER_KERNEL,
877 CFG80211_STA_MESH_PEER_USER,
881 * cfg80211_check_station_change - validate parameter changes
882 * @wiphy: the wiphy this operates on
883 * @params: the new parameters for a station
884 * @statype: the type of station being modified
886 * Utility function for the @change_station driver method. Call this function
887 * with the appropriate station type looking up the station (and checking that
888 * it exists). It will verify whether the station change is acceptable, and if
889 * not will return an error code. Note that it may modify the parameters for
890 * backward compatibility reasons, so don't use them before calling this.
892 int cfg80211_check_station_change(struct wiphy *wiphy,
893 struct station_parameters *params,
894 enum cfg80211_station_type statype);
897 * enum station_info_rate_flags - bitrate info flags
899 * Used by the driver to indicate the specific rate transmission
900 * type for 802.11n transmissions.
902 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
903 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
904 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
905 * @RATE_INFO_FLAGS_60G: 60GHz MCS
907 enum rate_info_flags {
908 RATE_INFO_FLAGS_MCS = BIT(0),
909 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
910 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
911 RATE_INFO_FLAGS_60G = BIT(3),
915 * enum rate_info_bw - rate bandwidth information
917 * Used by the driver to indicate the rate bandwidth.
919 * @RATE_INFO_BW_5: 5 MHz bandwidth
920 * @RATE_INFO_BW_10: 10 MHz bandwidth
921 * @RATE_INFO_BW_20: 20 MHz bandwidth
922 * @RATE_INFO_BW_40: 40 MHz bandwidth
923 * @RATE_INFO_BW_80: 80 MHz bandwidth
924 * @RATE_INFO_BW_160: 160 MHz bandwidth
936 * struct rate_info - bitrate information
938 * Information about a receiving or transmitting bitrate
940 * @flags: bitflag of flags from &enum rate_info_flags
941 * @mcs: mcs index if struct describes a 802.11n bitrate
942 * @legacy: bitrate in 100kbit/s for 802.11abg
943 * @nss: number of streams (VHT only)
944 * @bw: bandwidth (from &enum rate_info_bw)
955 * enum station_info_rate_flags - bitrate info flags
957 * Used by the driver to indicate the specific rate transmission
958 * type for 802.11n transmissions.
960 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
961 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
962 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
964 enum bss_param_flags {
965 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
966 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
967 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
971 * struct sta_bss_parameters - BSS parameters for the attached station
973 * Information about the currently associated BSS
975 * @flags: bitflag of flags from &enum bss_param_flags
976 * @dtim_period: DTIM period for the BSS
977 * @beacon_interval: beacon interval
979 struct sta_bss_parameters {
986 * struct cfg80211_tid_stats - per-TID statistics
987 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
988 * indicate the relevant values in this struct are filled
989 * @rx_msdu: number of received MSDUs
990 * @tx_msdu: number of (attempted) transmitted MSDUs
991 * @tx_msdu_retries: number of retries (not counting the first) for
993 * @tx_msdu_failed: number of failed transmitted MSDUs
995 struct cfg80211_tid_stats {
1003 #define IEEE80211_MAX_CHAINS 4
1006 * struct station_info - station information
1008 * Station information filled by driver for get_station() and dump_station.
1010 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1011 * indicate the relevant values in this struct for them
1012 * @connected_time: time(in secs) since a station is last connected
1013 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1014 * @rx_bytes: bytes (size of MPDUs) received from this station
1015 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1016 * @llid: mesh local link id
1017 * @plid: mesh peer link id
1018 * @plink_state: mesh peer link state
1019 * @signal: The signal strength, type depends on the wiphy's signal_type.
1020 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1021 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1022 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1023 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1024 * @chain_signal: per-chain signal strength of last received packet in dBm
1025 * @chain_signal_avg: per-chain signal strength average in dBm
1026 * @txrate: current unicast bitrate from this station
1027 * @rxrate: current unicast bitrate to this station
1028 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1029 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1030 * @tx_retries: cumulative retry counts (MPDUs)
1031 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1032 * @rx_dropped_misc: Dropped for un-specified reason.
1033 * @bss_param: current BSS parameters
1034 * @generation: generation number for nl80211 dumps.
1035 * This number should increase every time the list of stations
1036 * changes, i.e. when a station is added or removed, so that
1037 * userspace can tell whether it got a consistent snapshot.
1038 * @assoc_req_ies: IEs from (Re)Association Request.
1039 * This is used only when in AP mode with drivers that do not use
1040 * user space MLME/SME implementation. The information is provided for
1041 * the cfg80211_new_sta() calls to notify user space of the IEs.
1042 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1043 * @sta_flags: station flags mask & values
1044 * @beacon_loss_count: Number of times beacon loss event has triggered.
1045 * @t_offset: Time offset of the station relative to this host.
1046 * @local_pm: local mesh STA power save mode
1047 * @peer_pm: peer mesh STA power save mode
1048 * @nonpeer_pm: non-peer mesh STA power save mode
1049 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1050 * towards this station.
1051 * @rx_beacon: number of beacons received from this peer
1052 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1054 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1055 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1056 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1058 struct station_info {
1071 s8 chain_signal[IEEE80211_MAX_CHAINS];
1072 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1074 struct rate_info txrate;
1075 struct rate_info rxrate;
1080 u32 rx_dropped_misc;
1081 struct sta_bss_parameters bss_param;
1082 struct nl80211_sta_flag_update sta_flags;
1086 const u8 *assoc_req_ies;
1087 size_t assoc_req_ies_len;
1089 u32 beacon_loss_count;
1091 enum nl80211_mesh_power_mode local_pm;
1092 enum nl80211_mesh_power_mode peer_pm;
1093 enum nl80211_mesh_power_mode nonpeer_pm;
1095 u32 expected_throughput;
1099 u8 rx_beacon_signal_avg;
1100 struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1104 * cfg80211_get_station - retrieve information about a given station
1105 * @dev: the device where the station is supposed to be connected to
1106 * @mac_addr: the mac address of the station of interest
1107 * @sinfo: pointer to the structure to fill with the information
1109 * Returns 0 on success and sinfo is filled with the available information
1110 * otherwise returns a negative error code and the content of sinfo has to be
1111 * considered undefined.
1113 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1114 struct station_info *sinfo);
1117 * enum monitor_flags - monitor flags
1119 * Monitor interface configuration flags. Note that these must be the bits
1120 * according to the nl80211 flags.
1122 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1123 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1124 * @MONITOR_FLAG_CONTROL: pass control frames
1125 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1126 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1127 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1129 enum monitor_flags {
1130 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1131 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1132 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1133 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1134 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1135 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1139 * enum mpath_info_flags - mesh path information flags
1141 * Used by the driver to indicate which info in &struct mpath_info it has filled
1142 * in during get_station() or dump_station().
1144 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1145 * @MPATH_INFO_SN: @sn filled
1146 * @MPATH_INFO_METRIC: @metric filled
1147 * @MPATH_INFO_EXPTIME: @exptime filled
1148 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1149 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1150 * @MPATH_INFO_FLAGS: @flags filled
1152 enum mpath_info_flags {
1153 MPATH_INFO_FRAME_QLEN = BIT(0),
1154 MPATH_INFO_SN = BIT(1),
1155 MPATH_INFO_METRIC = BIT(2),
1156 MPATH_INFO_EXPTIME = BIT(3),
1157 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1158 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1159 MPATH_INFO_FLAGS = BIT(6),
1163 * struct mpath_info - mesh path information
1165 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1167 * @filled: bitfield of flags from &enum mpath_info_flags
1168 * @frame_qlen: number of queued frames for this destination
1169 * @sn: target sequence number
1170 * @metric: metric (cost) of this mesh path
1171 * @exptime: expiration time for the mesh path from now, in msecs
1172 * @flags: mesh path flags
1173 * @discovery_timeout: total mesh path discovery timeout, in msecs
1174 * @discovery_retries: mesh path discovery retries
1175 * @generation: generation number for nl80211 dumps.
1176 * This number should increase every time the list of mesh paths
1177 * changes, i.e. when a station is added or removed, so that
1178 * userspace can tell whether it got a consistent snapshot.
1186 u32 discovery_timeout;
1187 u8 discovery_retries;
1194 * struct bss_parameters - BSS parameters
1196 * Used to change BSS parameters (mainly for AP mode).
1198 * @use_cts_prot: Whether to use CTS protection
1199 * (0 = no, 1 = yes, -1 = do not change)
1200 * @use_short_preamble: Whether the use of short preambles is allowed
1201 * (0 = no, 1 = yes, -1 = do not change)
1202 * @use_short_slot_time: Whether the use of short slot time is allowed
1203 * (0 = no, 1 = yes, -1 = do not change)
1204 * @basic_rates: basic rates in IEEE 802.11 format
1205 * (or NULL for no change)
1206 * @basic_rates_len: number of basic rates
1207 * @ap_isolate: do not forward packets between connected stations
1208 * @ht_opmode: HT Operation mode
1209 * (u16 = opmode, -1 = do not change)
1210 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1211 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1213 struct bss_parameters {
1215 int use_short_preamble;
1216 int use_short_slot_time;
1217 const u8 *basic_rates;
1221 s8 p2p_ctwindow, p2p_opp_ps;
1225 * struct mesh_config - 802.11s mesh configuration
1227 * These parameters can be changed while the mesh is active.
1229 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1230 * by the Mesh Peering Open message
1231 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1232 * used by the Mesh Peering Open message
1233 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1234 * the mesh peering management to close a mesh peering
1235 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1237 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1238 * be sent to establish a new peer link instance in a mesh
1239 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1240 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1242 * @auto_open_plinks: whether we should automatically open peer links when we
1243 * detect compatible mesh peers
1244 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1245 * synchronize to for 11s default synchronization method
1246 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1247 * that an originator mesh STA can send to a particular path target
1248 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1249 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1250 * a path discovery in milliseconds
1251 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1252 * receiving a PREQ shall consider the forwarding information from the
1253 * root to be valid. (TU = time unit)
1254 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1255 * which a mesh STA can send only one action frame containing a PREQ
1257 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1258 * which a mesh STA can send only one Action frame containing a PERR
1260 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1261 * it takes for an HWMP information element to propagate across the mesh
1262 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1263 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1264 * announcements are transmitted
1265 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1266 * station has access to a broader network beyond the MBSS. (This is
1267 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1268 * only means that the station will announce others it's a mesh gate, but
1269 * not necessarily using the gate announcement protocol. Still keeping the
1270 * same nomenclature to be in sync with the spec)
1271 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1272 * entity (default is TRUE - forwarding entity)
1273 * @rssi_threshold: the threshold for average signal strength of candidate
1274 * station to establish a peer link
1275 * @ht_opmode: mesh HT protection mode
1277 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1278 * receiving a proactive PREQ shall consider the forwarding information to
1279 * the root mesh STA to be valid.
1281 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1282 * PREQs are transmitted.
1283 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1284 * during which a mesh STA can send only one Action frame containing
1285 * a PREQ element for root path confirmation.
1286 * @power_mode: The default mesh power save mode which will be the initial
1287 * setting for new peer links.
1288 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1289 * after transmitting its beacon.
1290 * @plink_timeout: If no tx activity is seen from a STA we've established
1291 * peering with for longer than this time (in seconds), then remove it
1292 * from the STA's list of peers. Default is 30 minutes.
1294 struct mesh_config {
1295 u16 dot11MeshRetryTimeout;
1296 u16 dot11MeshConfirmTimeout;
1297 u16 dot11MeshHoldingTimeout;
1298 u16 dot11MeshMaxPeerLinks;
1299 u8 dot11MeshMaxRetries;
1302 bool auto_open_plinks;
1303 u32 dot11MeshNbrOffsetMaxNeighbor;
1304 u8 dot11MeshHWMPmaxPREQretries;
1305 u32 path_refresh_time;
1306 u16 min_discovery_timeout;
1307 u32 dot11MeshHWMPactivePathTimeout;
1308 u16 dot11MeshHWMPpreqMinInterval;
1309 u16 dot11MeshHWMPperrMinInterval;
1310 u16 dot11MeshHWMPnetDiameterTraversalTime;
1311 u8 dot11MeshHWMPRootMode;
1312 u16 dot11MeshHWMPRannInterval;
1313 bool dot11MeshGateAnnouncementProtocol;
1314 bool dot11MeshForwarding;
1317 u32 dot11MeshHWMPactivePathToRootTimeout;
1318 u16 dot11MeshHWMProotInterval;
1319 u16 dot11MeshHWMPconfirmationInterval;
1320 enum nl80211_mesh_power_mode power_mode;
1321 u16 dot11MeshAwakeWindowDuration;
1326 * struct mesh_setup - 802.11s mesh setup configuration
1327 * @chandef: defines the channel to use
1328 * @mesh_id: the mesh ID
1329 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1330 * @sync_method: which synchronization method to use
1331 * @path_sel_proto: which path selection protocol to use
1332 * @path_metric: which metric to use
1333 * @auth_id: which authentication method this mesh is using
1334 * @ie: vendor information elements (optional)
1335 * @ie_len: length of vendor information elements
1336 * @is_authenticated: this mesh requires authentication
1337 * @is_secure: this mesh uses security
1338 * @user_mpm: userspace handles all MPM functions
1339 * @dtim_period: DTIM period to use
1340 * @beacon_interval: beacon interval to use
1341 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1342 * @basic_rates: basic rates to use when creating the mesh
1344 * These parameters are fixed when the mesh is created.
1347 struct cfg80211_chan_def chandef;
1356 bool is_authenticated;
1360 u16 beacon_interval;
1361 int mcast_rate[NUM_NL80211_BANDS];
1366 * struct ocb_setup - 802.11p OCB mode setup configuration
1367 * @chandef: defines the channel to use
1369 * These parameters are fixed when connecting to the network
1372 struct cfg80211_chan_def chandef;
1376 * struct ieee80211_txq_params - TX queue parameters
1377 * @ac: AC identifier
1378 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1379 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1381 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1383 * @aifs: Arbitration interframe space [0..255]
1385 struct ieee80211_txq_params {
1394 * DOC: Scanning and BSS list handling
1396 * The scanning process itself is fairly simple, but cfg80211 offers quite
1397 * a bit of helper functionality. To start a scan, the scan operation will
1398 * be invoked with a scan definition. This scan definition contains the
1399 * channels to scan, and the SSIDs to send probe requests for (including the
1400 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1401 * probe. Additionally, a scan request may contain extra information elements
1402 * that should be added to the probe request. The IEs are guaranteed to be
1403 * well-formed, and will not exceed the maximum length the driver advertised
1404 * in the wiphy structure.
1406 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1407 * it is responsible for maintaining the BSS list; the driver should not
1408 * maintain a list itself. For this notification, various functions exist.
1410 * Since drivers do not maintain a BSS list, there are also a number of
1411 * functions to search for a BSS and obtain information about it from the
1412 * BSS structure cfg80211 maintains. The BSS list is also made available
1417 * struct cfg80211_ssid - SSID description
1419 * @ssid_len: length of the ssid
1421 struct cfg80211_ssid {
1422 u8 ssid[IEEE80211_MAX_SSID_LEN];
1427 * struct cfg80211_scan_info - information about completed scan
1428 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1429 * wireless device that requested the scan is connected to. If this
1430 * information is not available, this field is left zero.
1431 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1432 * @aborted: set to true if the scan was aborted for any reason,
1433 * userspace will be notified of that
1435 struct cfg80211_scan_info {
1437 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1442 * struct cfg80211_scan_request - scan request description
1444 * @ssids: SSIDs to scan for (active scan only)
1445 * @n_ssids: number of SSIDs
1446 * @channels: channels to scan on.
1447 * @n_channels: total number of channels to scan
1448 * @scan_width: channel width for scanning
1449 * @ie: optional information element(s) to add into Probe Request or %NULL
1450 * @ie_len: length of ie in octets
1451 * @duration: how long to listen on each channel, in TUs. If
1452 * %duration_mandatory is not set, this is the maximum dwell time and
1453 * the actual dwell time may be shorter.
1454 * @duration_mandatory: if set, the scan duration must be as specified by the
1456 * @flags: bit field of flags controlling operation
1457 * @rates: bitmap of rates to advertise for each band
1458 * @wiphy: the wiphy this was for
1459 * @scan_start: time (in jiffies) when the scan started
1460 * @wdev: the wireless device to scan for
1461 * @info: (internal) information about completed scan
1462 * @notified: (internal) scan request was notified as done or aborted
1463 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1464 * @mac_addr: MAC address used with randomisation
1465 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1466 * are 0 in the mask should be randomised, bits that are 1 should
1467 * be taken from the @mac_addr
1468 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1470 struct cfg80211_scan_request {
1471 struct cfg80211_ssid *ssids;
1474 enum nl80211_bss_scan_width scan_width;
1478 bool duration_mandatory;
1481 u32 rates[NUM_NL80211_BANDS];
1483 struct wireless_dev *wdev;
1485 u8 mac_addr[ETH_ALEN] __aligned(2);
1486 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1487 u8 bssid[ETH_ALEN] __aligned(2);
1490 struct wiphy *wiphy;
1491 unsigned long scan_start;
1492 struct cfg80211_scan_info info;
1497 struct ieee80211_channel *channels[0];
1500 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1504 get_random_bytes(buf, ETH_ALEN);
1505 for (i = 0; i < ETH_ALEN; i++) {
1507 buf[i] |= addr[i] & mask[i];
1512 * struct cfg80211_match_set - sets of attributes to match
1514 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1515 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1517 struct cfg80211_match_set {
1518 struct cfg80211_ssid ssid;
1523 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1525 * @interval: interval between scheduled scan iterations. In seconds.
1526 * @iterations: number of scan iterations in this scan plan. Zero means
1528 * The last scan plan will always have this parameter set to zero,
1529 * all other scan plans will have a finite number of iterations.
1531 struct cfg80211_sched_scan_plan {
1537 * struct cfg80211_sched_scan_request - scheduled scan request description
1539 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1540 * @n_ssids: number of SSIDs
1541 * @n_channels: total number of channels to scan
1542 * @scan_width: channel width for scanning
1543 * @ie: optional information element(s) to add into Probe Request or %NULL
1544 * @ie_len: length of ie in octets
1545 * @flags: bit field of flags controlling operation
1546 * @match_sets: sets of parameters to be matched for a scan result
1547 * entry to be considered valid and to be passed to the host
1548 * (others are filtered out).
1549 * If ommited, all results are passed.
1550 * @n_match_sets: number of match sets
1551 * @wiphy: the wiphy this was for
1552 * @dev: the interface
1553 * @scan_start: start time of the scheduled scan
1554 * @channels: channels to scan
1555 * @min_rssi_thold: for drivers only supporting a single threshold, this
1556 * contains the minimum over all matchsets
1557 * @mac_addr: MAC address used with randomisation
1558 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1559 * are 0 in the mask should be randomised, bits that are 1 should
1560 * be taken from the @mac_addr
1561 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1562 * index must be executed first.
1563 * @n_scan_plans: number of scan plans, at least 1.
1564 * @rcu_head: RCU callback used to free the struct
1565 * @owner_nlportid: netlink portid of owner (if this should is a request
1566 * owned by a particular socket)
1567 * @delay: delay in seconds to use before starting the first scan
1568 * cycle. The driver may ignore this parameter and start
1569 * immediately (or at any other time), if this feature is not
1572 struct cfg80211_sched_scan_request {
1573 struct cfg80211_ssid *ssids;
1576 enum nl80211_bss_scan_width scan_width;
1580 struct cfg80211_match_set *match_sets;
1584 struct cfg80211_sched_scan_plan *scan_plans;
1587 u8 mac_addr[ETH_ALEN] __aligned(2);
1588 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1591 struct wiphy *wiphy;
1592 struct net_device *dev;
1593 unsigned long scan_start;
1594 struct rcu_head rcu_head;
1598 struct ieee80211_channel *channels[0];
1602 * enum cfg80211_signal_type - signal type
1604 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1605 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1606 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1608 enum cfg80211_signal_type {
1609 CFG80211_SIGNAL_TYPE_NONE,
1610 CFG80211_SIGNAL_TYPE_MBM,
1611 CFG80211_SIGNAL_TYPE_UNSPEC,
1615 * struct cfg80211_inform_bss - BSS inform data
1616 * @chan: channel the frame was received on
1617 * @scan_width: scan width that was used
1618 * @signal: signal strength value, according to the wiphy's
1620 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1621 * received; should match the time when the frame was actually
1622 * received by the device (not just by the host, in case it was
1623 * buffered on the device) and be accurate to about 10ms.
1624 * If the frame isn't buffered, just passing the return value of
1625 * ktime_get_boot_ns() is likely appropriate.
1626 * @parent_tsf: the time at the start of reception of the first octet of the
1627 * timestamp field of the frame. The time is the TSF of the BSS specified
1629 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1630 * the BSS that requested the scan in which the beacon/probe was received.
1632 struct cfg80211_inform_bss {
1633 struct ieee80211_channel *chan;
1634 enum nl80211_bss_scan_width scan_width;
1638 u8 parent_bssid[ETH_ALEN] __aligned(2);
1642 * struct cfg80211_bss_ies - BSS entry IE data
1643 * @tsf: TSF contained in the frame that carried these IEs
1644 * @rcu_head: internal use, for freeing
1645 * @len: length of the IEs
1646 * @from_beacon: these IEs are known to come from a beacon
1649 struct cfg80211_bss_ies {
1651 struct rcu_head rcu_head;
1658 * struct cfg80211_bss - BSS description
1660 * This structure describes a BSS (which may also be a mesh network)
1661 * for use in scan results and similar.
1663 * @channel: channel this BSS is on
1664 * @scan_width: width of the control channel
1665 * @bssid: BSSID of the BSS
1666 * @beacon_interval: the beacon interval as from the frame
1667 * @capability: the capability field in host byte order
1668 * @ies: the information elements (Note that there is no guarantee that these
1669 * are well-formed!); this is a pointer to either the beacon_ies or
1670 * proberesp_ies depending on whether Probe Response frame has been
1671 * received. It is always non-%NULL.
1672 * @beacon_ies: the information elements from the last Beacon frame
1673 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1674 * own the beacon_ies, but they're just pointers to the ones from the
1675 * @hidden_beacon_bss struct)
1676 * @proberesp_ies: the information elements from the last Probe Response frame
1677 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1678 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1679 * that holds the beacon data. @beacon_ies is still valid, of course, and
1680 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1681 * @signal: signal strength value (type depends on the wiphy's signal_type)
1682 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1684 struct cfg80211_bss {
1685 struct ieee80211_channel *channel;
1686 enum nl80211_bss_scan_width scan_width;
1688 const struct cfg80211_bss_ies __rcu *ies;
1689 const struct cfg80211_bss_ies __rcu *beacon_ies;
1690 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1692 struct cfg80211_bss *hidden_beacon_bss;
1696 u16 beacon_interval;
1701 u8 priv[0] __aligned(sizeof(void *));
1705 * ieee80211_bss_get_ie - find IE with given ID
1706 * @bss: the bss to search
1709 * Note that the return value is an RCU-protected pointer, so
1710 * rcu_read_lock() must be held when calling this function.
1711 * Return: %NULL if not found.
1713 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1717 * struct cfg80211_auth_request - Authentication request data
1719 * This structure provides information needed to complete IEEE 802.11
1722 * @bss: The BSS to authenticate with, the callee must obtain a reference
1723 * to it if it needs to keep it.
1724 * @auth_type: Authentication type (algorithm)
1725 * @ie: Extra IEs to add to Authentication frame or %NULL
1726 * @ie_len: Length of ie buffer in octets
1727 * @key_len: length of WEP key for shared key authentication
1728 * @key_idx: index of WEP key for shared key authentication
1729 * @key: WEP key for shared key authentication
1730 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1731 * Authentication transaction sequence number field.
1732 * @sae_data_len: Length of sae_data buffer in octets
1734 struct cfg80211_auth_request {
1735 struct cfg80211_bss *bss;
1738 enum nl80211_auth_type auth_type;
1740 u8 key_len, key_idx;
1742 size_t sae_data_len;
1746 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1748 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1749 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1750 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1752 enum cfg80211_assoc_req_flags {
1753 ASSOC_REQ_DISABLE_HT = BIT(0),
1754 ASSOC_REQ_DISABLE_VHT = BIT(1),
1755 ASSOC_REQ_USE_RRM = BIT(2),
1759 * struct cfg80211_assoc_request - (Re)Association request data
1761 * This structure provides information needed to complete IEEE 802.11
1763 * @bss: The BSS to associate with. If the call is successful the driver is
1764 * given a reference that it must give back to cfg80211_send_rx_assoc()
1765 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1766 * association requests while already associating must be rejected.
1767 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1768 * @ie_len: Length of ie buffer in octets
1769 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1770 * @crypto: crypto settings
1771 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1772 * to indicate a request to reassociate within the ESS instead of a request
1773 * do the initial association with the ESS. When included, this is set to
1774 * the BSSID of the current association, i.e., to the value that is
1775 * included in the Current AP address field of the Reassociation Request
1777 * @flags: See &enum cfg80211_assoc_req_flags
1778 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1779 * will be used in ht_capa. Un-supported values will be ignored.
1780 * @ht_capa_mask: The bits of ht_capa which are to be used.
1781 * @vht_capa: VHT capability override
1782 * @vht_capa_mask: VHT capability mask indicating which fields to use
1784 struct cfg80211_assoc_request {
1785 struct cfg80211_bss *bss;
1786 const u8 *ie, *prev_bssid;
1788 struct cfg80211_crypto_settings crypto;
1791 struct ieee80211_ht_cap ht_capa;
1792 struct ieee80211_ht_cap ht_capa_mask;
1793 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1797 * struct cfg80211_deauth_request - Deauthentication request data
1799 * This structure provides information needed to complete IEEE 802.11
1802 * @bssid: the BSSID of the BSS to deauthenticate from
1803 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1804 * @ie_len: Length of ie buffer in octets
1805 * @reason_code: The reason code for the deauthentication
1806 * @local_state_change: if set, change local state only and
1807 * do not set a deauth frame
1809 struct cfg80211_deauth_request {
1814 bool local_state_change;
1818 * struct cfg80211_disassoc_request - Disassociation request data
1820 * This structure provides information needed to complete IEEE 802.11
1823 * @bss: the BSS to disassociate from
1824 * @ie: Extra IEs to add to Disassociation frame or %NULL
1825 * @ie_len: Length of ie buffer in octets
1826 * @reason_code: The reason code for the disassociation
1827 * @local_state_change: This is a request for a local state only, i.e., no
1828 * Disassociation frame is to be transmitted.
1830 struct cfg80211_disassoc_request {
1831 struct cfg80211_bss *bss;
1835 bool local_state_change;
1839 * struct cfg80211_ibss_params - IBSS parameters
1841 * This structure defines the IBSS parameters for the join_ibss()
1844 * @ssid: The SSID, will always be non-null.
1845 * @ssid_len: The length of the SSID, will always be non-zero.
1846 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1847 * search for IBSSs with a different BSSID.
1848 * @chandef: defines the channel to use if no other IBSS to join can be found
1849 * @channel_fixed: The channel should be fixed -- do not search for
1850 * IBSSs to join on other channels.
1851 * @ie: information element(s) to include in the beacon
1852 * @ie_len: length of that
1853 * @beacon_interval: beacon interval to use
1854 * @privacy: this is a protected network, keys will be configured
1856 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1857 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1858 * required to assume that the port is unauthorized until authorized by
1859 * user space. Otherwise, port is marked authorized by default.
1860 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1861 * changes the channel when a radar is detected. This is required
1862 * to operate on DFS channels.
1863 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1864 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1865 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1866 * will be used in ht_capa. Un-supported values will be ignored.
1867 * @ht_capa_mask: The bits of ht_capa which are to be used.
1869 struct cfg80211_ibss_params {
1872 struct cfg80211_chan_def chandef;
1874 u8 ssid_len, ie_len;
1875 u16 beacon_interval;
1880 bool userspace_handles_dfs;
1881 int mcast_rate[NUM_NL80211_BANDS];
1882 struct ieee80211_ht_cap ht_capa;
1883 struct ieee80211_ht_cap ht_capa_mask;
1887 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1889 * @band: band of BSS which should match for RSSI level adjustment.
1890 * @delta: value of RSSI level adjustment.
1892 struct cfg80211_bss_select_adjust {
1893 enum nl80211_band band;
1898 * struct cfg80211_bss_selection - connection parameters for BSS selection.
1900 * @behaviour: requested BSS selection behaviour.
1901 * @param: parameters for requestion behaviour.
1902 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
1903 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
1905 struct cfg80211_bss_selection {
1906 enum nl80211_bss_select_attr behaviour;
1908 enum nl80211_band band_pref;
1909 struct cfg80211_bss_select_adjust adjust;
1914 * struct cfg80211_connect_params - Connection parameters
1916 * This structure provides information needed to complete IEEE 802.11
1917 * authentication and association.
1919 * @channel: The channel to use or %NULL if not specified (auto-select based
1921 * @channel_hint: The channel of the recommended BSS for initial connection or
1922 * %NULL if not specified
1923 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1925 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1926 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1927 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1930 * @ssid_len: Length of ssid in octets
1931 * @auth_type: Authentication type (algorithm)
1932 * @ie: IEs for association request
1933 * @ie_len: Length of assoc_ie in octets
1934 * @privacy: indicates whether privacy-enabled APs should be used
1935 * @mfp: indicate whether management frame protection is used
1936 * @crypto: crypto settings
1937 * @key_len: length of WEP key for shared key authentication
1938 * @key_idx: index of WEP key for shared key authentication
1939 * @key: WEP key for shared key authentication
1940 * @flags: See &enum cfg80211_assoc_req_flags
1941 * @bg_scan_period: Background scan period in seconds
1942 * or -1 to indicate that default value is to be used.
1943 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1944 * will be used in ht_capa. Un-supported values will be ignored.
1945 * @ht_capa_mask: The bits of ht_capa which are to be used.
1946 * @vht_capa: VHT Capability overrides
1947 * @vht_capa_mask: The bits of vht_capa which are to be used.
1948 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
1950 * @bss_select: criteria to be used for BSS selection.
1951 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1952 * to indicate a request to reassociate within the ESS instead of a request
1953 * do the initial association with the ESS. When included, this is set to
1954 * the BSSID of the current association, i.e., to the value that is
1955 * included in the Current AP address field of the Reassociation Request
1958 struct cfg80211_connect_params {
1959 struct ieee80211_channel *channel;
1960 struct ieee80211_channel *channel_hint;
1962 const u8 *bssid_hint;
1965 enum nl80211_auth_type auth_type;
1969 enum nl80211_mfp mfp;
1970 struct cfg80211_crypto_settings crypto;
1972 u8 key_len, key_idx;
1975 struct ieee80211_ht_cap ht_capa;
1976 struct ieee80211_ht_cap ht_capa_mask;
1977 struct ieee80211_vht_cap vht_capa;
1978 struct ieee80211_vht_cap vht_capa_mask;
1980 struct cfg80211_bss_selection bss_select;
1981 const u8 *prev_bssid;
1985 * enum wiphy_params_flags - set_wiphy_params bitfield values
1986 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1987 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1988 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1989 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1990 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1991 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1993 enum wiphy_params_flags {
1994 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1995 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1996 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1997 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1998 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1999 WIPHY_PARAM_DYN_ACK = 1 << 5,
2003 * cfg80211_bitrate_mask - masks for bitrate control
2005 struct cfg80211_bitrate_mask {
2008 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
2009 u16 vht_mcs[NL80211_VHT_NSS_MAX];
2010 enum nl80211_txrate_gi gi;
2011 } control[NUM_NL80211_BANDS];
2014 * struct cfg80211_pmksa - PMK Security Association
2016 * This structure is passed to the set/del_pmksa() method for PMKSA
2019 * @bssid: The AP's BSSID.
2020 * @pmkid: The PMK material itself.
2022 struct cfg80211_pmksa {
2028 * struct cfg80211_pkt_pattern - packet pattern
2029 * @mask: bitmask where to match pattern and where to ignore bytes,
2030 * one bit per byte, in same format as nl80211
2031 * @pattern: bytes to match where bitmask is 1
2032 * @pattern_len: length of pattern (in bytes)
2033 * @pkt_offset: packet offset (in bytes)
2035 * Internal note: @mask and @pattern are allocated in one chunk of
2036 * memory, free @mask only!
2038 struct cfg80211_pkt_pattern {
2039 const u8 *mask, *pattern;
2045 * struct cfg80211_wowlan_tcp - TCP connection parameters
2047 * @sock: (internal) socket for source port allocation
2048 * @src: source IP address
2049 * @dst: destination IP address
2050 * @dst_mac: destination MAC address
2051 * @src_port: source port
2052 * @dst_port: destination port
2053 * @payload_len: data payload length
2054 * @payload: data payload buffer
2055 * @payload_seq: payload sequence stamping configuration
2056 * @data_interval: interval at which to send data packets
2057 * @wake_len: wakeup payload match length
2058 * @wake_data: wakeup payload match data
2059 * @wake_mask: wakeup payload match mask
2060 * @tokens_size: length of the tokens buffer
2061 * @payload_tok: payload token usage configuration
2063 struct cfg80211_wowlan_tcp {
2064 struct socket *sock;
2066 u16 src_port, dst_port;
2067 u8 dst_mac[ETH_ALEN];
2070 struct nl80211_wowlan_tcp_data_seq payload_seq;
2073 const u8 *wake_data, *wake_mask;
2075 /* must be last, variable member */
2076 struct nl80211_wowlan_tcp_data_token payload_tok;
2080 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2082 * This structure defines the enabled WoWLAN triggers for the device.
2083 * @any: wake up on any activity -- special trigger if device continues
2084 * operating as normal during suspend
2085 * @disconnect: wake up if getting disconnected
2086 * @magic_pkt: wake up on receiving magic packet
2087 * @patterns: wake up on receiving packet matching a pattern
2088 * @n_patterns: number of patterns
2089 * @gtk_rekey_failure: wake up on GTK rekey failure
2090 * @eap_identity_req: wake up on EAP identity request packet
2091 * @four_way_handshake: wake up on 4-way handshake
2092 * @rfkill_release: wake up when rfkill is released
2093 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2094 * NULL if not configured.
2095 * @nd_config: configuration for the scan to be used for net detect wake.
2097 struct cfg80211_wowlan {
2098 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2099 eap_identity_req, four_way_handshake,
2101 struct cfg80211_pkt_pattern *patterns;
2102 struct cfg80211_wowlan_tcp *tcp;
2104 struct cfg80211_sched_scan_request *nd_config;
2108 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2110 * This structure defines coalesce rule for the device.
2111 * @delay: maximum coalescing delay in msecs.
2112 * @condition: condition for packet coalescence.
2113 * see &enum nl80211_coalesce_condition.
2114 * @patterns: array of packet patterns
2115 * @n_patterns: number of patterns
2117 struct cfg80211_coalesce_rules {
2119 enum nl80211_coalesce_condition condition;
2120 struct cfg80211_pkt_pattern *patterns;
2125 * struct cfg80211_coalesce - Packet coalescing settings
2127 * This structure defines coalescing settings.
2128 * @rules: array of coalesce rules
2129 * @n_rules: number of rules
2131 struct cfg80211_coalesce {
2132 struct cfg80211_coalesce_rules *rules;
2137 * struct cfg80211_wowlan_nd_match - information about the match
2139 * @ssid: SSID of the match that triggered the wake up
2140 * @n_channels: Number of channels where the match occurred. This
2141 * value may be zero if the driver can't report the channels.
2142 * @channels: center frequencies of the channels where a match
2145 struct cfg80211_wowlan_nd_match {
2146 struct cfg80211_ssid ssid;
2152 * struct cfg80211_wowlan_nd_info - net detect wake up information
2154 * @n_matches: Number of match information instances provided in
2155 * @matches. This value may be zero if the driver can't provide
2156 * match information.
2157 * @matches: Array of pointers to matches containing information about
2158 * the matches that triggered the wake up.
2160 struct cfg80211_wowlan_nd_info {
2162 struct cfg80211_wowlan_nd_match *matches[];
2166 * struct cfg80211_wowlan_wakeup - wakeup report
2167 * @disconnect: woke up by getting disconnected
2168 * @magic_pkt: woke up by receiving magic packet
2169 * @gtk_rekey_failure: woke up by GTK rekey failure
2170 * @eap_identity_req: woke up by EAP identity request packet
2171 * @four_way_handshake: woke up by 4-way handshake
2172 * @rfkill_release: woke up by rfkill being released
2173 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2174 * @packet_present_len: copied wakeup packet data
2175 * @packet_len: original wakeup packet length
2176 * @packet: The packet causing the wakeup, if any.
2177 * @packet_80211: For pattern match, magic packet and other data
2178 * frame triggers an 802.3 frame should be reported, for
2179 * disconnect due to deauth 802.11 frame. This indicates which
2181 * @tcp_match: TCP wakeup packet received
2182 * @tcp_connlost: TCP connection lost or failed to establish
2183 * @tcp_nomoretokens: TCP data ran out of tokens
2184 * @net_detect: if not %NULL, woke up because of net detect
2186 struct cfg80211_wowlan_wakeup {
2187 bool disconnect, magic_pkt, gtk_rekey_failure,
2188 eap_identity_req, four_way_handshake,
2189 rfkill_release, packet_80211,
2190 tcp_match, tcp_connlost, tcp_nomoretokens;
2192 u32 packet_present_len, packet_len;
2194 struct cfg80211_wowlan_nd_info *net_detect;
2198 * struct cfg80211_gtk_rekey_data - rekey data
2199 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2200 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2201 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2203 struct cfg80211_gtk_rekey_data {
2204 const u8 *kek, *kck, *replay_ctr;
2208 * struct cfg80211_update_ft_ies_params - FT IE Information
2210 * This structure provides information needed to update the fast transition IE
2212 * @md: The Mobility Domain ID, 2 Octet value
2213 * @ie: Fast Transition IEs
2214 * @ie_len: Length of ft_ie in octets
2216 struct cfg80211_update_ft_ies_params {
2223 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2225 * This structure provides information needed to transmit a mgmt frame
2227 * @chan: channel to use
2228 * @offchan: indicates wether off channel operation is required
2229 * @wait: duration for ROC
2230 * @buf: buffer to transmit
2231 * @len: buffer length
2232 * @no_cck: don't use cck rates for this frame
2233 * @dont_wait_for_ack: tells the low level not to wait for an ack
2234 * @n_csa_offsets: length of csa_offsets array
2235 * @csa_offsets: array of all the csa offsets in the frame
2237 struct cfg80211_mgmt_tx_params {
2238 struct ieee80211_channel *chan;
2244 bool dont_wait_for_ack;
2246 const u16 *csa_offsets;
2250 * struct cfg80211_dscp_exception - DSCP exception
2252 * @dscp: DSCP value that does not adhere to the user priority range definition
2253 * @up: user priority value to which the corresponding DSCP value belongs
2255 struct cfg80211_dscp_exception {
2261 * struct cfg80211_dscp_range - DSCP range definition for user priority
2263 * @low: lowest DSCP value of this user priority range, inclusive
2264 * @high: highest DSCP value of this user priority range, inclusive
2266 struct cfg80211_dscp_range {
2271 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2272 #define IEEE80211_QOS_MAP_MAX_EX 21
2273 #define IEEE80211_QOS_MAP_LEN_MIN 16
2274 #define IEEE80211_QOS_MAP_LEN_MAX \
2275 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2278 * struct cfg80211_qos_map - QoS Map Information
2280 * This struct defines the Interworking QoS map setting for DSCP values
2282 * @num_des: number of DSCP exceptions (0..21)
2283 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2284 * the user priority DSCP range definition
2285 * @up: DSCP range definition for a particular user priority
2287 struct cfg80211_qos_map {
2289 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2290 struct cfg80211_dscp_range up[8];
2294 * struct cfg80211_ops - backend description for wireless configuration
2296 * This struct is registered by fullmac card drivers and/or wireless stacks
2297 * in order to handle configuration requests on their interfaces.
2299 * All callbacks except where otherwise noted should return 0
2300 * on success or a negative error code.
2302 * All operations are currently invoked under rtnl for consistency with the
2303 * wireless extensions but this is subject to reevaluation as soon as this
2304 * code is used more widely and we have a first user without wext.
2306 * @suspend: wiphy device needs to be suspended. The variable @wow will
2307 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2308 * configured for the device.
2309 * @resume: wiphy device needs to be resumed
2310 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2311 * to call device_set_wakeup_enable() to enable/disable wakeup from
2314 * @add_virtual_intf: create a new virtual interface with the given name,
2315 * must set the struct wireless_dev's iftype. Beware: You must create
2316 * the new netdev in the wiphy's network namespace! Returns the struct
2317 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2318 * also set the address member in the wdev.
2320 * @del_virtual_intf: remove the virtual interface
2322 * @change_virtual_intf: change type/configuration of virtual interface,
2323 * keep the struct wireless_dev's iftype updated.
2325 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2326 * when adding a group key.
2328 * @get_key: get information about the key with the given parameters.
2329 * @mac_addr will be %NULL when requesting information for a group
2330 * key. All pointers given to the @callback function need not be valid
2331 * after it returns. This function should return an error if it is
2332 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2334 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2335 * and @key_index, return -ENOENT if the key doesn't exist.
2337 * @set_default_key: set the default key on an interface
2339 * @set_default_mgmt_key: set the default management frame key on an interface
2341 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2343 * @start_ap: Start acting in AP mode defined by the parameters.
2344 * @change_beacon: Change the beacon parameters for an access point mode
2345 * interface. This should reject the call when AP mode wasn't started.
2346 * @stop_ap: Stop being an AP, including stopping beaconing.
2348 * @add_station: Add a new station.
2349 * @del_station: Remove a station
2350 * @change_station: Modify a given station. Note that flags changes are not much
2351 * validated in cfg80211, in particular the auth/assoc/authorized flags
2352 * might come to the driver in invalid combinations -- make sure to check
2353 * them, also against the existing state! Drivers must call
2354 * cfg80211_check_station_change() to validate the information.
2355 * @get_station: get station information for the station identified by @mac
2356 * @dump_station: dump station callback -- resume dump at index @idx
2358 * @add_mpath: add a fixed mesh path
2359 * @del_mpath: delete a given mesh path
2360 * @change_mpath: change a given mesh path
2361 * @get_mpath: get a mesh path for the given parameters
2362 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2363 * @get_mpp: get a mesh proxy path for the given parameters
2364 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2365 * @join_mesh: join the mesh network with the specified parameters
2366 * (invoked with the wireless_dev mutex held)
2367 * @leave_mesh: leave the current mesh network
2368 * (invoked with the wireless_dev mutex held)
2370 * @get_mesh_config: Get the current mesh configuration
2372 * @update_mesh_config: Update mesh parameters on a running mesh.
2373 * The mask is a bitfield which tells us which parameters to
2374 * set, and which to leave alone.
2376 * @change_bss: Modify parameters for a given BSS.
2378 * @set_txq_params: Set TX queue parameters
2380 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2381 * as it doesn't implement join_mesh and needs to set the channel to
2382 * join the mesh instead.
2384 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2385 * interfaces are active this callback should reject the configuration.
2386 * If no interfaces are active or the device is down, the channel should
2387 * be stored for when a monitor interface becomes active.
2389 * @scan: Request to do a scan. If returning zero, the scan request is given
2390 * the driver, and will be valid until passed to cfg80211_scan_done().
2391 * For scan results, call cfg80211_inform_bss(); you can call this outside
2392 * the scan/scan_done bracket too.
2393 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2394 * indicate the status of the scan through cfg80211_scan_done().
2396 * @auth: Request to authenticate with the specified peer
2397 * (invoked with the wireless_dev mutex held)
2398 * @assoc: Request to (re)associate with the specified peer
2399 * (invoked with the wireless_dev mutex held)
2400 * @deauth: Request to deauthenticate from the specified peer
2401 * (invoked with the wireless_dev mutex held)
2402 * @disassoc: Request to disassociate from the specified peer
2403 * (invoked with the wireless_dev mutex held)
2405 * @connect: Connect to the ESS with the specified parameters. When connected,
2406 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2407 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2408 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2409 * from the AP or cfg80211_connect_timeout() if no frame with status code
2411 * The driver is allowed to roam to other BSSes within the ESS when the
2412 * other BSS matches the connect parameters. When such roaming is initiated
2413 * by the driver, the driver is expected to verify that the target matches
2414 * the configured security parameters and to use Reassociation Request
2415 * frame instead of Association Request frame.
2416 * The connect function can also be used to request the driver to perform a
2417 * specific roam when connected to an ESS. In that case, the prev_bssid
2418 * parameter is set to the BSSID of the currently associated BSS as an
2419 * indication of requesting reassociation.
2420 * In both the driver-initiated and new connect() call initiated roaming
2421 * cases, the result of roaming is indicated with a call to
2422 * cfg80211_roamed() or cfg80211_roamed_bss().
2423 * (invoked with the wireless_dev mutex held)
2424 * @disconnect: Disconnect from the BSS/ESS.
2425 * (invoked with the wireless_dev mutex held)
2427 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2428 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2430 * (invoked with the wireless_dev mutex held)
2431 * @leave_ibss: Leave the IBSS.
2432 * (invoked with the wireless_dev mutex held)
2434 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2437 * @set_wiphy_params: Notify that wiphy parameters have changed;
2438 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2439 * have changed. The actual parameter values are available in
2440 * struct wiphy. If returning an error, no value should be changed.
2442 * @set_tx_power: set the transmit power according to the parameters,
2443 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2444 * wdev may be %NULL if power was set for the wiphy, and will
2445 * always be %NULL unless the driver supports per-vif TX power
2446 * (as advertised by the nl80211 feature flag.)
2447 * @get_tx_power: store the current TX power into the dbm variable;
2448 * return 0 if successful
2450 * @set_wds_peer: set the WDS peer for a WDS interface
2452 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2453 * functions to adjust rfkill hw state
2455 * @dump_survey: get site survey information.
2457 * @remain_on_channel: Request the driver to remain awake on the specified
2458 * channel for the specified duration to complete an off-channel
2459 * operation (e.g., public action frame exchange). When the driver is
2460 * ready on the requested channel, it must indicate this with an event
2461 * notification by calling cfg80211_ready_on_channel().
2462 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2463 * This allows the operation to be terminated prior to timeout based on
2464 * the duration value.
2465 * @mgmt_tx: Transmit a management frame.
2466 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2467 * frame on another channel
2469 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2470 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2471 * used by the function, but 0 and 1 must not be touched. Additionally,
2472 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2473 * dump and return to userspace with an error, so be careful. If any data
2474 * was passed in from userspace then the data/len arguments will be present
2475 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2477 * @set_bitrate_mask: set the bitrate mask configuration
2479 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2480 * devices running firmwares capable of generating the (re) association
2481 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2482 * @del_pmksa: Delete a cached PMKID.
2483 * @flush_pmksa: Flush all cached PMKIDs.
2484 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2485 * allows the driver to adjust the dynamic ps timeout value.
2486 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2487 * After configuration, the driver should (soon) send an event indicating
2488 * the current level is above/below the configured threshold; this may
2489 * need some care when the configuration is changed (without first being
2491 * @set_cqm_txe_config: Configure connection quality monitor TX error
2493 * @sched_scan_start: Tell the driver to start a scheduled scan.
2494 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2495 * call must stop the scheduled scan and be ready for starting a new one
2496 * before it returns, i.e. @sched_scan_start may be called immediately
2497 * after that again and should not fail in that case. The driver should
2498 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2499 * method returns 0.)
2501 * @mgmt_frame_register: Notify driver that a management frame type was
2502 * registered. The callback is allowed to sleep.
2504 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2505 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2506 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2507 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2509 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2511 * @tdls_mgmt: Transmit a TDLS management frame.
2512 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2514 * @probe_client: probe an associated client, must return a cookie that it
2515 * later passes to cfg80211_probe_status().
2517 * @set_noack_map: Set the NoAck Map for the TIDs.
2519 * @get_channel: Get the current operating channel for the virtual interface.
2520 * For monitor interfaces, it should return %NULL unless there's a single
2521 * current monitoring channel.
2523 * @start_p2p_device: Start the given P2P device.
2524 * @stop_p2p_device: Stop the given P2P device.
2526 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2527 * Parameters include ACL policy, an array of MAC address of stations
2528 * and the number of MAC addresses. If there is already a list in driver
2529 * this new list replaces the existing one. Driver has to clear its ACL
2530 * when number of MAC addresses entries is passed as 0. Drivers which
2531 * advertise the support for MAC based ACL have to implement this callback.
2533 * @start_radar_detection: Start radar detection in the driver.
2535 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2536 * driver. If the SME is in the driver/firmware, this information can be
2537 * used in building Authentication and Reassociation Request frames.
2539 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2540 * for a given duration (milliseconds). The protocol is provided so the
2541 * driver can take the most appropriate actions.
2542 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2543 * reliability. This operation can not fail.
2544 * @set_coalesce: Set coalesce parameters.
2546 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2547 * responsible for veryfing if the switch is possible. Since this is
2548 * inherently tricky driver may decide to disconnect an interface later
2549 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2550 * everything. It should do it's best to verify requests and reject them
2551 * as soon as possible.
2553 * @set_qos_map: Set QoS mapping information to the driver
2555 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2556 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2557 * changes during the lifetime of the BSS.
2559 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2560 * with the given parameters; action frame exchange has been handled by
2561 * userspace so this just has to modify the TX path to take the TS into
2563 * If the admitted time is 0 just validate the parameters to make sure
2564 * the session can be created at all; it is valid to just always return
2565 * success for that but that may result in inefficient behaviour (handshake
2566 * with the peer followed by immediate teardown when the addition is later
2568 * @del_tx_ts: remove an existing TX TS
2570 * @join_ocb: join the OCB network with the specified parameters
2571 * (invoked with the wireless_dev mutex held)
2572 * @leave_ocb: leave the current OCB network
2573 * (invoked with the wireless_dev mutex held)
2575 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2576 * is responsible for continually initiating channel-switching operations
2577 * and returning to the base channel for communication with the AP.
2578 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2579 * peers must be on the base channel when the call completes.
2581 struct cfg80211_ops {
2582 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2583 int (*resume)(struct wiphy *wiphy);
2584 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2586 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2588 unsigned char name_assign_type,
2589 enum nl80211_iftype type,
2591 struct vif_params *params);
2592 int (*del_virtual_intf)(struct wiphy *wiphy,
2593 struct wireless_dev *wdev);
2594 int (*change_virtual_intf)(struct wiphy *wiphy,
2595 struct net_device *dev,
2596 enum nl80211_iftype type, u32 *flags,
2597 struct vif_params *params);
2599 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2600 u8 key_index, bool pairwise, const u8 *mac_addr,
2601 struct key_params *params);
2602 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2603 u8 key_index, bool pairwise, const u8 *mac_addr,
2605 void (*callback)(void *cookie, struct key_params*));
2606 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2607 u8 key_index, bool pairwise, const u8 *mac_addr);
2608 int (*set_default_key)(struct wiphy *wiphy,
2609 struct net_device *netdev,
2610 u8 key_index, bool unicast, bool multicast);
2611 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2612 struct net_device *netdev,
2615 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2616 struct cfg80211_ap_settings *settings);
2617 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2618 struct cfg80211_beacon_data *info);
2619 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2622 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2624 struct station_parameters *params);
2625 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2626 struct station_del_parameters *params);
2627 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2629 struct station_parameters *params);
2630 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2631 const u8 *mac, struct station_info *sinfo);
2632 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2633 int idx, u8 *mac, struct station_info *sinfo);
2635 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2636 const u8 *dst, const u8 *next_hop);
2637 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2639 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2640 const u8 *dst, const u8 *next_hop);
2641 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2642 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2643 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2644 int idx, u8 *dst, u8 *next_hop,
2645 struct mpath_info *pinfo);
2646 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2647 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2648 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2649 int idx, u8 *dst, u8 *mpp,
2650 struct mpath_info *pinfo);
2651 int (*get_mesh_config)(struct wiphy *wiphy,
2652 struct net_device *dev,
2653 struct mesh_config *conf);
2654 int (*update_mesh_config)(struct wiphy *wiphy,
2655 struct net_device *dev, u32 mask,
2656 const struct mesh_config *nconf);
2657 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2658 const struct mesh_config *conf,
2659 const struct mesh_setup *setup);
2660 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2662 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2663 struct ocb_setup *setup);
2664 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2666 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2667 struct bss_parameters *params);
2669 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2670 struct ieee80211_txq_params *params);
2672 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2673 struct net_device *dev,
2674 struct ieee80211_channel *chan);
2676 int (*set_monitor_channel)(struct wiphy *wiphy,
2677 struct cfg80211_chan_def *chandef);
2679 int (*scan)(struct wiphy *wiphy,
2680 struct cfg80211_scan_request *request);
2681 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
2683 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2684 struct cfg80211_auth_request *req);
2685 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2686 struct cfg80211_assoc_request *req);
2687 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2688 struct cfg80211_deauth_request *req);
2689 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2690 struct cfg80211_disassoc_request *req);
2692 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2693 struct cfg80211_connect_params *sme);
2694 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2697 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2698 struct cfg80211_ibss_params *params);
2699 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2701 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2702 int rate[NUM_NL80211_BANDS]);
2704 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2706 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2707 enum nl80211_tx_power_setting type, int mbm);
2708 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2711 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2714 void (*rfkill_poll)(struct wiphy *wiphy);
2716 #ifdef CONFIG_NL80211_TESTMODE
2717 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2718 void *data, int len);
2719 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2720 struct netlink_callback *cb,
2721 void *data, int len);
2724 int (*set_bitrate_mask)(struct wiphy *wiphy,
2725 struct net_device *dev,
2727 const struct cfg80211_bitrate_mask *mask);
2729 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2730 int idx, struct survey_info *info);
2732 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2733 struct cfg80211_pmksa *pmksa);
2734 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2735 struct cfg80211_pmksa *pmksa);
2736 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2738 int (*remain_on_channel)(struct wiphy *wiphy,
2739 struct wireless_dev *wdev,
2740 struct ieee80211_channel *chan,
2741 unsigned int duration,
2743 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2744 struct wireless_dev *wdev,
2747 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2748 struct cfg80211_mgmt_tx_params *params,
2750 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2751 struct wireless_dev *wdev,
2754 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2755 bool enabled, int timeout);
2757 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2758 struct net_device *dev,
2759 s32 rssi_thold, u32 rssi_hyst);
2761 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2762 struct net_device *dev,
2763 u32 rate, u32 pkts, u32 intvl);
2765 void (*mgmt_frame_register)(struct wiphy *wiphy,
2766 struct wireless_dev *wdev,
2767 u16 frame_type, bool reg);
2769 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2770 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2772 int (*sched_scan_start)(struct wiphy *wiphy,
2773 struct net_device *dev,
2774 struct cfg80211_sched_scan_request *request);
2775 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2777 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2778 struct cfg80211_gtk_rekey_data *data);
2780 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2781 const u8 *peer, u8 action_code, u8 dialog_token,
2782 u16 status_code, u32 peer_capability,
2783 bool initiator, const u8 *buf, size_t len);
2784 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2785 const u8 *peer, enum nl80211_tdls_operation oper);
2787 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2788 const u8 *peer, u64 *cookie);
2790 int (*set_noack_map)(struct wiphy *wiphy,
2791 struct net_device *dev,
2794 int (*get_channel)(struct wiphy *wiphy,
2795 struct wireless_dev *wdev,
2796 struct cfg80211_chan_def *chandef);
2798 int (*start_p2p_device)(struct wiphy *wiphy,
2799 struct wireless_dev *wdev);
2800 void (*stop_p2p_device)(struct wiphy *wiphy,
2801 struct wireless_dev *wdev);
2803 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2804 const struct cfg80211_acl_data *params);
2806 int (*start_radar_detection)(struct wiphy *wiphy,
2807 struct net_device *dev,
2808 struct cfg80211_chan_def *chandef,
2810 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2811 struct cfg80211_update_ft_ies_params *ftie);
2812 int (*crit_proto_start)(struct wiphy *wiphy,
2813 struct wireless_dev *wdev,
2814 enum nl80211_crit_proto_id protocol,
2816 void (*crit_proto_stop)(struct wiphy *wiphy,
2817 struct wireless_dev *wdev);
2818 int (*set_coalesce)(struct wiphy *wiphy,
2819 struct cfg80211_coalesce *coalesce);
2821 int (*channel_switch)(struct wiphy *wiphy,
2822 struct net_device *dev,
2823 struct cfg80211_csa_settings *params);
2825 int (*set_qos_map)(struct wiphy *wiphy,
2826 struct net_device *dev,
2827 struct cfg80211_qos_map *qos_map);
2829 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2830 struct cfg80211_chan_def *chandef);
2832 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2833 u8 tsid, const u8 *peer, u8 user_prio,
2835 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2836 u8 tsid, const u8 *peer);
2838 int (*tdls_channel_switch)(struct wiphy *wiphy,
2839 struct net_device *dev,
2840 const u8 *addr, u8 oper_class,
2841 struct cfg80211_chan_def *chandef);
2842 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2843 struct net_device *dev,
2848 * wireless hardware and networking interfaces structures
2849 * and registration/helper functions
2853 * enum wiphy_flags - wiphy capability flags
2855 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2857 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2858 * by default -- this flag will be set depending on the kernel's default
2859 * on wiphy_new(), but can be changed by the driver if it has a good
2860 * reason to override the default
2861 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2862 * on a VLAN interface)
2863 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2864 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2865 * control port protocol ethertype. The device also honours the
2866 * control_port_no_encrypt flag.
2867 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2868 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2869 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2870 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2871 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2873 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2874 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2875 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2876 * link setup/discovery operations internally. Setup, discovery and
2877 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2878 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2879 * used for asking the driver/firmware to perform a TDLS operation.
2880 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2881 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2882 * when there are virtual interfaces in AP mode by calling
2883 * cfg80211_report_obss_beacon().
2884 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2885 * responds to probe-requests in hardware.
2886 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2887 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2888 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2889 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2890 * beaconing mode (AP, IBSS, Mesh, ...).
2896 WIPHY_FLAG_NETNS_OK = BIT(3),
2897 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2898 WIPHY_FLAG_4ADDR_AP = BIT(5),
2899 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2900 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2901 WIPHY_FLAG_IBSS_RSN = BIT(8),
2902 WIPHY_FLAG_MESH_AUTH = BIT(10),
2903 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2904 /* use hole at 12 */
2905 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2906 WIPHY_FLAG_AP_UAPSD = BIT(14),
2907 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2908 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2909 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2910 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2911 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2912 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2913 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2914 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2915 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2919 * struct ieee80211_iface_limit - limit on certain interface types
2920 * @max: maximum number of interfaces of these types
2921 * @types: interface types (bits)
2923 struct ieee80211_iface_limit {
2929 * struct ieee80211_iface_combination - possible interface combination
2930 * @limits: limits for the given interface types
2931 * @n_limits: number of limitations
2932 * @num_different_channels: can use up to this many different channels
2933 * @max_interfaces: maximum number of interfaces in total allowed in this
2935 * @beacon_int_infra_match: In this combination, the beacon intervals
2936 * between infrastructure and AP types must match. This is required
2937 * only in special cases.
2938 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2939 * @radar_detect_regions: bitmap of regions supported for radar detection
2941 * With this structure the driver can describe which interface
2942 * combinations it supports concurrently.
2946 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2948 * struct ieee80211_iface_limit limits1[] = {
2949 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2950 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2952 * struct ieee80211_iface_combination combination1 = {
2953 * .limits = limits1,
2954 * .n_limits = ARRAY_SIZE(limits1),
2955 * .max_interfaces = 2,
2956 * .beacon_int_infra_match = true,
2960 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2962 * struct ieee80211_iface_limit limits2[] = {
2963 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2964 * BIT(NL80211_IFTYPE_P2P_GO), },
2966 * struct ieee80211_iface_combination combination2 = {
2967 * .limits = limits2,
2968 * .n_limits = ARRAY_SIZE(limits2),
2969 * .max_interfaces = 8,
2970 * .num_different_channels = 1,
2974 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2976 * This allows for an infrastructure connection and three P2P connections.
2978 * struct ieee80211_iface_limit limits3[] = {
2979 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2980 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2981 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2983 * struct ieee80211_iface_combination combination3 = {
2984 * .limits = limits3,
2985 * .n_limits = ARRAY_SIZE(limits3),
2986 * .max_interfaces = 4,
2987 * .num_different_channels = 2,
2990 struct ieee80211_iface_combination {
2991 const struct ieee80211_iface_limit *limits;
2992 u32 num_different_channels;
2995 bool beacon_int_infra_match;
2996 u8 radar_detect_widths;
2997 u8 radar_detect_regions;
3000 struct ieee80211_txrx_stypes {
3005 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3006 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3007 * trigger that keeps the device operating as-is and
3008 * wakes up the host on any activity, for example a
3009 * received packet that passed filtering; note that the
3010 * packet should be preserved in that case
3011 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3013 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3014 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3015 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3016 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3017 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3018 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3019 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3021 enum wiphy_wowlan_support_flags {
3022 WIPHY_WOWLAN_ANY = BIT(0),
3023 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
3024 WIPHY_WOWLAN_DISCONNECT = BIT(2),
3025 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3026 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
3027 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
3028 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
3029 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
3030 WIPHY_WOWLAN_NET_DETECT = BIT(8),
3033 struct wiphy_wowlan_tcp_support {
3034 const struct nl80211_wowlan_tcp_data_token_feature *tok;
3035 u32 data_payload_max;
3036 u32 data_interval_max;
3037 u32 wake_payload_max;
3042 * struct wiphy_wowlan_support - WoWLAN support data
3043 * @flags: see &enum wiphy_wowlan_support_flags
3044 * @n_patterns: number of supported wakeup patterns
3045 * (see nl80211.h for the pattern definition)
3046 * @pattern_max_len: maximum length of each pattern
3047 * @pattern_min_len: minimum length of each pattern
3048 * @max_pkt_offset: maximum Rx packet offset
3049 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3050 * similar, but not necessarily identical, to max_match_sets for
3052 * See &struct cfg80211_sched_scan_request.@match_sets for more
3054 * @tcp: TCP wakeup support information
3056 struct wiphy_wowlan_support {
3059 int pattern_max_len;
3060 int pattern_min_len;
3062 int max_nd_match_sets;
3063 const struct wiphy_wowlan_tcp_support *tcp;
3067 * struct wiphy_coalesce_support - coalesce support data
3068 * @n_rules: maximum number of coalesce rules
3069 * @max_delay: maximum supported coalescing delay in msecs
3070 * @n_patterns: number of supported patterns in a rule
3071 * (see nl80211.h for the pattern definition)
3072 * @pattern_max_len: maximum length of each pattern
3073 * @pattern_min_len: minimum length of each pattern
3074 * @max_pkt_offset: maximum Rx packet offset
3076 struct wiphy_coalesce_support {
3080 int pattern_max_len;
3081 int pattern_min_len;
3086 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3087 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3088 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3089 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3090 * (must be combined with %_WDEV or %_NETDEV)
3092 enum wiphy_vendor_command_flags {
3093 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3094 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3095 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3099 * struct wiphy_vendor_command - vendor command definition
3100 * @info: vendor command identifying information, as used in nl80211
3101 * @flags: flags, see &enum wiphy_vendor_command_flags
3102 * @doit: callback for the operation, note that wdev is %NULL if the
3103 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3104 * pointer may be %NULL if userspace provided no data at all
3105 * @dumpit: dump callback, for transferring bigger/multiple items. The
3106 * @storage points to cb->args[5], ie. is preserved over the multiple
3108 * It's recommended to not have the same sub command with both @doit and
3109 * @dumpit, so that userspace can assume certain ones are get and others
3110 * are used with dump requests.
3112 struct wiphy_vendor_command {
3113 struct nl80211_vendor_cmd_info info;
3115 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3116 const void *data, int data_len);
3117 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3118 struct sk_buff *skb, const void *data, int data_len,
3119 unsigned long *storage);
3123 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3124 * @iftype: interface type
3125 * @extended_capabilities: extended capabilities supported by the driver,
3126 * additional capabilities might be supported by userspace; these are the
3127 * 802.11 extended capabilities ("Extended Capabilities element") and are
3128 * in the same format as in the information element. See IEEE Std
3129 * 802.11-2012 8.4.2.29 for the defined fields.
3130 * @extended_capabilities_mask: mask of the valid values
3131 * @extended_capabilities_len: length of the extended capabilities
3133 struct wiphy_iftype_ext_capab {
3134 enum nl80211_iftype iftype;
3135 const u8 *extended_capabilities;
3136 const u8 *extended_capabilities_mask;
3137 u8 extended_capabilities_len;
3141 * struct wiphy - wireless hardware description
3142 * @reg_notifier: the driver's regulatory notification callback,
3143 * note that if your driver uses wiphy_apply_custom_regulatory()
3144 * the reg_notifier's request can be passed as NULL
3145 * @regd: the driver's regulatory domain, if one was requested via
3146 * the regulatory_hint() API. This can be used by the driver
3147 * on the reg_notifier() if it chooses to ignore future
3148 * regulatory domain changes caused by other drivers.
3149 * @signal_type: signal type reported in &struct cfg80211_bss.
3150 * @cipher_suites: supported cipher suites
3151 * @n_cipher_suites: number of supported cipher suites
3152 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3153 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3154 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3155 * -1 = fragmentation disabled, only odd values >= 256 used
3156 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3157 * @_net: the network namespace this wiphy currently lives in
3158 * @perm_addr: permanent MAC address of this device
3159 * @addr_mask: If the device supports multiple MAC addresses by masking,
3160 * set this to a mask with variable bits set to 1, e.g. if the last
3161 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3162 * variable bits shall be determined by the interfaces added, with
3163 * interfaces not matching the mask being rejected to be brought up.
3164 * @n_addresses: number of addresses in @addresses.
3165 * @addresses: If the device has more than one address, set this pointer
3166 * to a list of addresses (6 bytes each). The first one will be used
3167 * by default for perm_addr. In this case, the mask should be set to
3168 * all-zeroes. In this case it is assumed that the device can handle
3169 * the same number of arbitrary MAC addresses.
3170 * @registered: protects ->resume and ->suspend sysfs callbacks against
3171 * unregister hardware
3172 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3173 * automatically on wiphy renames
3174 * @dev: (virtual) struct device for this wiphy
3175 * @registered: helps synchronize suspend/resume with wiphy unregister
3176 * @wext: wireless extension handlers
3177 * @priv: driver private data (sized according to wiphy_new() parameter)
3178 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3179 * must be set by driver
3180 * @iface_combinations: Valid interface combinations array, should not
3181 * list single interface types.
3182 * @n_iface_combinations: number of entries in @iface_combinations array.
3183 * @software_iftypes: bitmask of software interface types, these are not
3184 * subject to any restrictions since they are purely managed in SW.
3185 * @flags: wiphy flags, see &enum wiphy_flags
3186 * @regulatory_flags: wiphy regulatory flags, see
3187 * &enum ieee80211_regulatory_flags
3188 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3189 * @ext_features: extended features advertised to nl80211, see
3190 * &enum nl80211_ext_feature_index.
3191 * @bss_priv_size: each BSS struct has private data allocated with it,
3192 * this variable determines its size
3193 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3195 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3196 * for in any given scheduled scan
3197 * @max_match_sets: maximum number of match sets the device can handle
3198 * when performing a scheduled scan, 0 if filtering is not
3200 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3201 * add to probe request frames transmitted during a scan, must not
3202 * include fixed IEs like supported rates
3203 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3205 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3206 * of iterations) for scheduled scan supported by the device.
3207 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3208 * single scan plan supported by the device.
3209 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3210 * scan plan supported by the device.
3211 * @coverage_class: current coverage class
3212 * @fw_version: firmware version for ethtool reporting
3213 * @hw_version: hardware version for ethtool reporting
3214 * @max_num_pmkids: maximum number of PMKIDs supported by device
3215 * @privid: a pointer that drivers can use to identify if an arbitrary
3216 * wiphy is theirs, e.g. in global notifiers
3217 * @bands: information about bands/channels supported by this device
3219 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3220 * transmitted through nl80211, points to an array indexed by interface
3223 * @available_antennas_tx: bitmap of antennas which are available to be
3224 * configured as TX antennas. Antenna configuration commands will be
3225 * rejected unless this or @available_antennas_rx is set.
3227 * @available_antennas_rx: bitmap of antennas which are available to be
3228 * configured as RX antennas. Antenna configuration commands will be
3229 * rejected unless this or @available_antennas_tx is set.
3231 * @probe_resp_offload:
3232 * Bitmap of supported protocols for probe response offloading.
3233 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3234 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3236 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3237 * may request, if implemented.
3239 * @wowlan: WoWLAN support information
3240 * @wowlan_config: current WoWLAN configuration; this should usually not be
3241 * used since access to it is necessarily racy, use the parameter passed
3242 * to the suspend() operation instead.
3244 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3245 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3246 * If null, then none can be over-ridden.
3247 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3248 * If null, then none can be over-ridden.
3250 * @wdev_list: the list of associated (virtual) interfaces; this list must
3251 * not be modified by the driver, but can be read with RTNL/RCU protection.
3253 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3256 * @extended_capabilities: extended capabilities supported by the driver,
3257 * additional capabilities might be supported by userspace; these are
3258 * the 802.11 extended capabilities ("Extended Capabilities element")
3259 * and are in the same format as in the information element. See
3260 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3261 * extended capabilities to be used if the capabilities are not specified
3262 * for a specific interface type in iftype_ext_capab.
3263 * @extended_capabilities_mask: mask of the valid values
3264 * @extended_capabilities_len: length of the extended capabilities
3265 * @iftype_ext_capab: array of extended capabilities per interface type
3266 * @num_iftype_ext_capab: number of interface types for which extended
3267 * capabilities are specified separately.
3268 * @coalesce: packet coalescing support information
3270 * @vendor_commands: array of vendor commands supported by the hardware
3271 * @n_vendor_commands: number of vendor commands
3272 * @vendor_events: array of vendor events supported by the hardware
3273 * @n_vendor_events: number of vendor events
3275 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3276 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3277 * driver is allowed to advertise a theoretical limit that it can reach in
3278 * some cases, but may not always reach.
3280 * @max_num_csa_counters: Number of supported csa_counters in beacons
3281 * and probe responses. This value should be set if the driver
3282 * wishes to limit the number of csa counters. Default (0) means
3284 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3285 * frame was sent and the channel on which the frame was heard for which
3286 * the reported rssi is still valid. If a driver is able to compensate the
3287 * low rssi when a frame is heard on different channel, then it should set
3288 * this variable to the maximal offset for which it can compensate.
3289 * This value should be set in MHz.
3290 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3291 * by the driver in the .connect() callback. The bit position maps to the
3292 * attribute indices defined in &enum nl80211_bss_select_attr.
3295 /* assign these fields before you register the wiphy */
3297 /* permanent MAC address(es) */
3298 u8 perm_addr[ETH_ALEN];
3299 u8 addr_mask[ETH_ALEN];
3301 struct mac_address *addresses;
3303 const struct ieee80211_txrx_stypes *mgmt_stypes;
3305 const struct ieee80211_iface_combination *iface_combinations;
3306 int n_iface_combinations;
3307 u16 software_iftypes;
3311 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3312 u16 interface_modes;
3314 u16 max_acl_mac_addrs;
3316 u32 flags, regulatory_flags, features;
3317 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3321 enum cfg80211_signal_type signal_type;
3325 u8 max_sched_scan_ssids;
3327 u16 max_scan_ie_len;
3328 u16 max_sched_scan_ie_len;
3329 u32 max_sched_scan_plans;
3330 u32 max_sched_scan_plan_interval;
3331 u32 max_sched_scan_plan_iterations;
3333 int n_cipher_suites;
3334 const u32 *cipher_suites;
3342 char fw_version[ETHTOOL_FWVERS_LEN];
3346 const struct wiphy_wowlan_support *wowlan;
3347 struct cfg80211_wowlan *wowlan_config;
3350 u16 max_remain_on_channel_duration;
3354 u32 available_antennas_tx;
3355 u32 available_antennas_rx;
3358 * Bitmap of supported protocols for probe response offloading
3359 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3360 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3362 u32 probe_resp_offload;
3364 const u8 *extended_capabilities, *extended_capabilities_mask;
3365 u8 extended_capabilities_len;
3367 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3368 unsigned int num_iftype_ext_capab;
3370 /* If multiple wiphys are registered and you're handed e.g.
3371 * a regular netdev with assigned ieee80211_ptr, you won't
3372 * know whether it points to a wiphy your driver has registered
3373 * or not. Assign this to something global to your driver to
3374 * help determine whether you own this wiphy or not. */
3377 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
3379 /* Lets us get back the wiphy on the callback */
3380 void (*reg_notifier)(struct wiphy *wiphy,
3381 struct regulatory_request *request);
3383 /* fields below are read-only, assigned by cfg80211 */
3385 const struct ieee80211_regdomain __rcu *regd;
3387 /* the item in /sys/class/ieee80211/ points to this,
3388 * you need use set_wiphy_dev() (see below) */
3391 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3394 /* dir in debugfs: ieee80211/<wiphyname> */
3395 struct dentry *debugfsdir;
3397 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3398 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3400 struct list_head wdev_list;
3402 /* the network namespace this phy lives in currently */
3403 possible_net_t _net;
3405 #ifdef CONFIG_CFG80211_WEXT
3406 const struct iw_handler_def *wext;
3409 const struct wiphy_coalesce_support *coalesce;
3411 const struct wiphy_vendor_command *vendor_commands;
3412 const struct nl80211_vendor_cmd_info *vendor_events;
3413 int n_vendor_commands, n_vendor_events;
3415 u16 max_ap_assoc_sta;
3417 u8 max_num_csa_counters;
3418 u8 max_adj_channel_rssi_comp;
3420 u32 bss_select_support;
3422 char priv[0] __aligned(NETDEV_ALIGN);
3425 static inline struct net *wiphy_net(struct wiphy *wiphy)
3427 return read_pnet(&wiphy->_net);
3430 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3432 write_pnet(&wiphy->_net, net);
3436 * wiphy_priv - return priv from wiphy
3438 * @wiphy: the wiphy whose priv pointer to return
3439 * Return: The priv of @wiphy.
3441 static inline void *wiphy_priv(struct wiphy *wiphy)
3444 return &wiphy->priv;
3448 * priv_to_wiphy - return the wiphy containing the priv
3450 * @priv: a pointer previously returned by wiphy_priv
3451 * Return: The wiphy of @priv.
3453 static inline struct wiphy *priv_to_wiphy(void *priv)
3456 return container_of(priv, struct wiphy, priv);
3460 * set_wiphy_dev - set device pointer for wiphy
3462 * @wiphy: The wiphy whose device to bind
3463 * @dev: The device to parent it to
3465 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3467 wiphy->dev.parent = dev;
3471 * wiphy_dev - get wiphy dev pointer
3473 * @wiphy: The wiphy whose device struct to look up
3474 * Return: The dev of @wiphy.
3476 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3478 return wiphy->dev.parent;
3482 * wiphy_name - get wiphy name
3484 * @wiphy: The wiphy whose name to return
3485 * Return: The name of @wiphy.
3487 static inline const char *wiphy_name(const struct wiphy *wiphy)
3489 return dev_name(&wiphy->dev);
3493 * wiphy_new_nm - create a new wiphy for use with cfg80211
3495 * @ops: The configuration operations for this device
3496 * @sizeof_priv: The size of the private area to allocate
3497 * @requested_name: Request a particular name.
3498 * NULL is valid value, and means use the default phy%d naming.
3500 * Create a new wiphy and associate the given operations with it.
3501 * @sizeof_priv bytes are allocated for private use.
3503 * Return: A pointer to the new wiphy. This pointer must be
3504 * assigned to each netdev's ieee80211_ptr for proper operation.
3506 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3507 const char *requested_name);
3510 * wiphy_new - create a new wiphy for use with cfg80211
3512 * @ops: The configuration operations for this device
3513 * @sizeof_priv: The size of the private area to allocate
3515 * Create a new wiphy and associate the given operations with it.
3516 * @sizeof_priv bytes are allocated for private use.
3518 * Return: A pointer to the new wiphy. This pointer must be
3519 * assigned to each netdev's ieee80211_ptr for proper operation.
3521 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3524 return wiphy_new_nm(ops, sizeof_priv, NULL);
3528 * wiphy_register - register a wiphy with cfg80211
3530 * @wiphy: The wiphy to register.
3532 * Return: A non-negative wiphy index or a negative error code.
3534 int wiphy_register(struct wiphy *wiphy);
3537 * wiphy_unregister - deregister a wiphy from cfg80211
3539 * @wiphy: The wiphy to unregister.
3541 * After this call, no more requests can be made with this priv
3542 * pointer, but the call may sleep to wait for an outstanding
3543 * request that is being handled.
3545 void wiphy_unregister(struct wiphy *wiphy);
3548 * wiphy_free - free wiphy
3550 * @wiphy: The wiphy to free
3552 void wiphy_free(struct wiphy *wiphy);
3554 /* internal structs */
3555 struct cfg80211_conn;
3556 struct cfg80211_internal_bss;
3557 struct cfg80211_cached_keys;
3560 * struct wireless_dev - wireless device state
3562 * For netdevs, this structure must be allocated by the driver
3563 * that uses the ieee80211_ptr field in struct net_device (this
3564 * is intentional so it can be allocated along with the netdev.)
3565 * It need not be registered then as netdev registration will
3566 * be intercepted by cfg80211 to see the new wireless device.
3568 * For non-netdev uses, it must also be allocated by the driver
3569 * in response to the cfg80211 callbacks that require it, as
3570 * there's no netdev registration in that case it may not be
3571 * allocated outside of callback operations that return it.
3573 * @wiphy: pointer to hardware description
3574 * @iftype: interface type
3575 * @list: (private) Used to collect the interfaces
3576 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3577 * @identifier: (private) Identifier used in nl80211 to identify this
3578 * wireless device if it has no netdev
3579 * @current_bss: (private) Used by the internal configuration code
3580 * @chandef: (private) Used by the internal configuration code to track
3581 * the user-set channel definition.
3582 * @preset_chandef: (private) Used by the internal configuration code to
3583 * track the channel to be used for AP later
3584 * @bssid: (private) Used by the internal configuration code
3585 * @ssid: (private) Used by the internal configuration code
3586 * @ssid_len: (private) Used by the internal configuration code
3587 * @mesh_id_len: (private) Used by the internal configuration code
3588 * @mesh_id_up_len: (private) Used by the internal configuration code
3589 * @wext: (private) Used by the internal wireless extensions compat code
3590 * @use_4addr: indicates 4addr mode is used on this interface, must be
3591 * set by driver (if supported) on add_interface BEFORE registering the
3592 * netdev and may otherwise be used by driver read-only, will be update
3593 * by cfg80211 on change_interface
3594 * @mgmt_registrations: list of registrations for management frames
3595 * @mgmt_registrations_lock: lock for the list
3596 * @mtx: mutex used to lock data in this struct, may be used by drivers
3597 * and some API functions require it held
3598 * @beacon_interval: beacon interval used on this device for transmitting
3599 * beacons, 0 when not valid
3600 * @address: The address for this device, valid only if @netdev is %NULL
3601 * @p2p_started: true if this is a P2P Device that has been started
3602 * @cac_started: true if DFS channel availability check has been started
3603 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3604 * @cac_time_ms: CAC time in ms
3605 * @ps: powersave mode is enabled
3606 * @ps_timeout: dynamic powersave timeout
3607 * @ap_unexpected_nlportid: (private) netlink port ID of application
3608 * registered for unexpected class 3 frames (AP mode)
3609 * @conn: (private) cfg80211 software SME connection state machine data
3610 * @connect_keys: (private) keys to set after connection is established
3611 * @conn_bss_type: connecting/connected BSS type
3612 * @ibss_fixed: (private) IBSS is using fixed BSSID
3613 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3614 * @event_list: (private) list for internal event processing
3615 * @event_lock: (private) lock for event list
3616 * @owner_nlportid: (private) owner socket port ID
3618 struct wireless_dev {
3619 struct wiphy *wiphy;
3620 enum nl80211_iftype iftype;
3622 /* the remainder of this struct should be private to cfg80211 */
3623 struct list_head list;
3624 struct net_device *netdev;
3628 struct list_head mgmt_registrations;
3629 spinlock_t mgmt_registrations_lock;
3633 bool use_4addr, p2p_started;
3635 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3637 /* currently used for IBSS and SME - might be rearranged later */
3638 u8 ssid[IEEE80211_MAX_SSID_LEN];
3639 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3640 struct cfg80211_conn *conn;
3641 struct cfg80211_cached_keys *connect_keys;
3642 enum ieee80211_bss_type conn_bss_type;
3644 struct list_head event_list;
3645 spinlock_t event_lock;
3647 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3648 struct cfg80211_chan_def preset_chandef;
3649 struct cfg80211_chan_def chandef;
3652 bool ibss_dfs_possible;
3657 int beacon_interval;
3659 u32 ap_unexpected_nlportid;
3662 unsigned long cac_start_time;
3663 unsigned int cac_time_ms;
3667 #ifdef CONFIG_CFG80211_WEXT
3670 struct cfg80211_ibss_params ibss;
3671 struct cfg80211_connect_params connect;
3672 struct cfg80211_cached_keys *keys;
3675 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3676 u8 ssid[IEEE80211_MAX_SSID_LEN];
3677 s8 default_key, default_mgmt_key;
3678 bool prev_bssid_valid;
3683 static inline u8 *wdev_address(struct wireless_dev *wdev)
3686 return wdev->netdev->dev_addr;
3687 return wdev->address;
3691 * wdev_priv - return wiphy priv from wireless_dev
3693 * @wdev: The wireless device whose wiphy's priv pointer to return
3694 * Return: The wiphy priv of @wdev.
3696 static inline void *wdev_priv(struct wireless_dev *wdev)
3699 return wiphy_priv(wdev->wiphy);
3703 * DOC: Utility functions
3705 * cfg80211 offers a number of utility functions that can be useful.
3709 * ieee80211_channel_to_frequency - convert channel number to frequency
3710 * @chan: channel number
3711 * @band: band, necessary due to channel number overlap
3712 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3714 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
3717 * ieee80211_frequency_to_channel - convert frequency to channel number
3718 * @freq: center frequency
3719 * Return: The corresponding channel, or 0 if the conversion failed.
3721 int ieee80211_frequency_to_channel(int freq);
3724 * Name indirection necessary because the ieee80211 code also has
3725 * a function named "ieee80211_get_channel", so if you include
3726 * cfg80211's header file you get cfg80211's version, if you try
3727 * to include both header files you'll (rightfully!) get a symbol
3730 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3733 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3734 * @wiphy: the struct wiphy to get the channel for
3735 * @freq: the center frequency of the channel
3736 * Return: The channel struct from @wiphy at @freq.
3738 static inline struct ieee80211_channel *
3739 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3741 return __ieee80211_get_channel(wiphy, freq);
3745 * ieee80211_get_response_rate - get basic rate for a given rate
3747 * @sband: the band to look for rates in
3748 * @basic_rates: bitmap of basic rates
3749 * @bitrate: the bitrate for which to find the basic rate
3751 * Return: The basic rate corresponding to a given bitrate, that
3752 * is the next lower bitrate contained in the basic rate map,
3753 * which is, for this function, given as a bitmap of indices of
3754 * rates in the band's bitrate table.
3756 struct ieee80211_rate *
3757 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3758 u32 basic_rates, int bitrate);
3761 * ieee80211_mandatory_rates - get mandatory rates for a given band
3762 * @sband: the band to look for rates in
3763 * @scan_width: width of the control channel
3765 * This function returns a bitmap of the mandatory rates for the given
3766 * band, bits are set according to the rate position in the bitrates array.
3768 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3769 enum nl80211_bss_scan_width scan_width);
3772 * Radiotap parsing functions -- for controlled injection support
3774 * Implemented in net/wireless/radiotap.c
3775 * Documentation in Documentation/networking/radiotap-headers.txt
3778 struct radiotap_align_size {
3779 uint8_t align:4, size:4;
3782 struct ieee80211_radiotap_namespace {
3783 const struct radiotap_align_size *align_size;
3789 struct ieee80211_radiotap_vendor_namespaces {
3790 const struct ieee80211_radiotap_namespace *ns;
3795 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3796 * @this_arg_index: index of current arg, valid after each successful call
3797 * to ieee80211_radiotap_iterator_next()
3798 * @this_arg: pointer to current radiotap arg; it is valid after each
3799 * call to ieee80211_radiotap_iterator_next() but also after
3800 * ieee80211_radiotap_iterator_init() where it will point to
3801 * the beginning of the actual data portion
3802 * @this_arg_size: length of the current arg, for convenience
3803 * @current_namespace: pointer to the current namespace definition
3804 * (or internally %NULL if the current namespace is unknown)
3805 * @is_radiotap_ns: indicates whether the current namespace is the default
3806 * radiotap namespace or not
3808 * @_rtheader: pointer to the radiotap header we are walking through
3809 * @_max_length: length of radiotap header in cpu byte ordering
3810 * @_arg_index: next argument index
3811 * @_arg: next argument pointer
3812 * @_next_bitmap: internal pointer to next present u32
3813 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3814 * @_vns: vendor namespace definitions
3815 * @_next_ns_data: beginning of the next namespace's data
3816 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3819 * Describes the radiotap parser state. Fields prefixed with an underscore
3820 * must not be used by users of the parser, only by the parser internally.
3823 struct ieee80211_radiotap_iterator {
3824 struct ieee80211_radiotap_header *_rtheader;
3825 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3826 const struct ieee80211_radiotap_namespace *current_namespace;
3828 unsigned char *_arg, *_next_ns_data;
3829 __le32 *_next_bitmap;
3831 unsigned char *this_arg;
3839 uint32_t _bitmap_shifter;
3844 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3845 struct ieee80211_radiotap_header *radiotap_header,
3847 const struct ieee80211_radiotap_vendor_namespaces *vns);
3850 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3853 extern const unsigned char rfc1042_header[6];
3854 extern const unsigned char bridge_tunnel_header[6];
3857 * ieee80211_get_hdrlen_from_skb - get header length from data
3861 * Given an skb with a raw 802.11 header at the data pointer this function
3862 * returns the 802.11 header length.
3864 * Return: The 802.11 header length in bytes (not including encryption
3865 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3868 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3871 * ieee80211_hdrlen - get header length in bytes from frame control
3872 * @fc: frame control field in little-endian format
3873 * Return: The header length in bytes.
3875 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3878 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3879 * @meshhdr: the mesh extension header, only the flags field
3880 * (first byte) will be accessed
3881 * Return: The length of the extension header, which is always at
3882 * least 6 bytes and at most 18 if address 5 and 6 are present.
3884 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3887 * DOC: Data path helpers
3889 * In addition to generic utilities, cfg80211 also offers
3890 * functions that help implement the data path for devices
3891 * that do not do the 802.11/802.3 conversion on the device.
3895 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3896 * @skb: the 802.11 data frame
3897 * @addr: the device MAC address
3898 * @iftype: the virtual interface type
3899 * Return: 0 on success. Non-zero on error.
3901 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3902 enum nl80211_iftype iftype);
3905 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3906 * @skb: the 802.3 frame
3907 * @addr: the device MAC address
3908 * @iftype: the virtual interface type
3909 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3910 * @qos: build 802.11 QoS data frame
3911 * Return: 0 on success, or a negative error code.
3913 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3914 enum nl80211_iftype iftype, const u8 *bssid,
3918 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3920 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3921 * 802.3 frames. The @list will be empty if the decode fails. The
3922 * @skb is consumed after the function returns.
3924 * @skb: The input IEEE 802.11n A-MSDU frame.
3925 * @list: The output list of 802.3 frames. It must be allocated and
3926 * initialized by by the caller.
3927 * @addr: The device MAC address.
3928 * @iftype: The device interface type.
3929 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3930 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3932 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3933 const u8 *addr, enum nl80211_iftype iftype,
3934 const unsigned int extra_headroom,
3935 bool has_80211_header);
3938 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3939 * @skb: the data frame
3940 * @qos_map: Interworking QoS mapping or %NULL if not in use
3941 * Return: The 802.1p/1d tag.
3943 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3944 struct cfg80211_qos_map *qos_map);
3947 * cfg80211_find_ie - find information element in data
3950 * @ies: data consisting of IEs
3951 * @len: length of data
3953 * Return: %NULL if the element ID could not be found or if
3954 * the element is invalid (claims to be longer than the given
3955 * data), or a pointer to the first byte of the requested
3956 * element, that is the byte containing the element ID.
3958 * Note: There are no checks on the element length other than
3959 * having to fit into the given data.
3961 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3964 * cfg80211_find_vendor_ie - find vendor specific information element in data
3967 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
3968 * @ies: data consisting of IEs
3969 * @len: length of data
3971 * Return: %NULL if the vendor specific element ID could not be found or if the
3972 * element is invalid (claims to be longer than the given data), or a pointer to
3973 * the first byte of the requested element, that is the byte containing the
3976 * Note: There are no checks on the element length other than having to fit into
3979 const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
3980 const u8 *ies, int len);
3983 * DOC: Regulatory enforcement infrastructure
3989 * regulatory_hint - driver hint to the wireless core a regulatory domain
3990 * @wiphy: the wireless device giving the hint (used only for reporting
3992 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3993 * should be in. If @rd is set this should be NULL. Note that if you
3994 * set this to NULL you should still set rd->alpha2 to some accepted
3997 * Wireless drivers can use this function to hint to the wireless core
3998 * what it believes should be the current regulatory domain by
3999 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4000 * domain should be in or by providing a completely build regulatory domain.
4001 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4002 * for a regulatory domain structure for the respective country.
4004 * The wiphy must have been registered to cfg80211 prior to this call.
4005 * For cfg80211 drivers this means you must first use wiphy_register(),
4006 * for mac80211 drivers you must first use ieee80211_register_hw().
4008 * Drivers should check the return value, its possible you can get
4011 * Return: 0 on success. -ENOMEM.
4013 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4016 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4017 * @wiphy: the wireless device we want to process the regulatory domain on
4018 * @rd: the regulatory domain informatoin to use for this wiphy
4020 * Set the regulatory domain information for self-managed wiphys, only they
4021 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4024 * Return: 0 on success. -EINVAL, -EPERM
4026 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4027 struct ieee80211_regdomain *rd);
4030 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4031 * @wiphy: the wireless device we want to process the regulatory domain on
4032 * @rd: the regulatory domain information to use for this wiphy
4034 * This functions requires the RTNL to be held and applies the new regdomain
4035 * synchronously to this wiphy. For more details see
4036 * regulatory_set_wiphy_regd().
4038 * Return: 0 on success. -EINVAL, -EPERM
4040 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4041 struct ieee80211_regdomain *rd);
4044 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4045 * @wiphy: the wireless device we want to process the regulatory domain on
4046 * @regd: the custom regulatory domain to use for this wiphy
4048 * Drivers can sometimes have custom regulatory domains which do not apply
4049 * to a specific country. Drivers can use this to apply such custom regulatory
4050 * domains. This routine must be called prior to wiphy registration. The
4051 * custom regulatory domain will be trusted completely and as such previous
4052 * default channel settings will be disregarded. If no rule is found for a
4053 * channel on the regulatory domain the channel will be disabled.
4054 * Drivers using this for a wiphy should also set the wiphy flag
4055 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4056 * that called this helper.
4058 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4059 const struct ieee80211_regdomain *regd);
4062 * freq_reg_info - get regulatory information for the given frequency
4063 * @wiphy: the wiphy for which we want to process this rule for
4064 * @center_freq: Frequency in KHz for which we want regulatory information for
4066 * Use this function to get the regulatory rule for a specific frequency on
4067 * a given wireless device. If the device has a specific regulatory domain
4068 * it wants to follow we respect that unless a country IE has been received
4069 * and processed already.
4071 * Return: A valid pointer, or, when an error occurs, for example if no rule
4072 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4073 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4074 * value will be -ERANGE if we determine the given center_freq does not even
4075 * have a regulatory rule for a frequency range in the center_freq's band.
4076 * See freq_in_rule_band() for our current definition of a band -- this is
4077 * purely subjective and right now it's 802.11 specific.
4079 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4083 * reg_initiator_name - map regulatory request initiator enum to name
4084 * @initiator: the regulatory request initiator
4086 * You can use this to map the regulatory request initiator enum to a
4087 * proper string representation.
4089 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4092 * callbacks for asynchronous cfg80211 methods, notification
4093 * functions and BSS handling helpers
4097 * cfg80211_scan_done - notify that scan finished
4099 * @request: the corresponding scan request
4100 * @info: information about the completed scan
4102 void cfg80211_scan_done(struct cfg80211_scan_request *request,
4103 struct cfg80211_scan_info *info);
4106 * cfg80211_sched_scan_results - notify that new scan results are available
4108 * @wiphy: the wiphy which got scheduled scan results
4110 void cfg80211_sched_scan_results(struct wiphy *wiphy);
4113 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4115 * @wiphy: the wiphy on which the scheduled scan stopped
4117 * The driver can call this function to inform cfg80211 that the
4118 * scheduled scan had to be stopped, for whatever reason. The driver
4119 * is then called back via the sched_scan_stop operation when done.
4121 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
4124 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4126 * @wiphy: the wiphy on which the scheduled scan stopped
4128 * The driver can call this function to inform cfg80211 that the
4129 * scheduled scan had to be stopped, for whatever reason. The driver
4130 * is then called back via the sched_scan_stop operation when done.
4131 * This function should be called with rtnl locked.
4133 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
4136 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4137 * @wiphy: the wiphy reporting the BSS
4138 * @data: the BSS metadata
4139 * @mgmt: the management frame (probe response or beacon)
4140 * @len: length of the management frame
4141 * @gfp: context flags
4143 * This informs cfg80211 that BSS information was found and
4144 * the BSS should be updated/added.
4146 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4147 * Or %NULL on error.
4149 struct cfg80211_bss * __must_check
4150 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4151 struct cfg80211_inform_bss *data,
4152 struct ieee80211_mgmt *mgmt, size_t len,
4155 static inline struct cfg80211_bss * __must_check
4156 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4157 struct ieee80211_channel *rx_channel,
4158 enum nl80211_bss_scan_width scan_width,
4159 struct ieee80211_mgmt *mgmt, size_t len,
4160 s32 signal, gfp_t gfp)
4162 struct cfg80211_inform_bss data = {
4164 .scan_width = scan_width,
4168 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4171 static inline struct cfg80211_bss * __must_check
4172 cfg80211_inform_bss_frame(struct wiphy *wiphy,
4173 struct ieee80211_channel *rx_channel,
4174 struct ieee80211_mgmt *mgmt, size_t len,
4175 s32 signal, gfp_t gfp)
4177 struct cfg80211_inform_bss data = {
4179 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4183 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4187 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4188 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4189 * from a beacon or probe response
4190 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4191 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4193 enum cfg80211_bss_frame_type {
4194 CFG80211_BSS_FTYPE_UNKNOWN,
4195 CFG80211_BSS_FTYPE_BEACON,
4196 CFG80211_BSS_FTYPE_PRESP,
4200 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4202 * @wiphy: the wiphy reporting the BSS
4203 * @data: the BSS metadata
4204 * @ftype: frame type (if known)
4205 * @bssid: the BSSID of the BSS
4206 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4207 * @capability: the capability field sent by the peer
4208 * @beacon_interval: the beacon interval announced by the peer
4209 * @ie: additional IEs sent by the peer
4210 * @ielen: length of the additional IEs
4211 * @gfp: context flags
4213 * This informs cfg80211 that BSS information was found and
4214 * the BSS should be updated/added.
4216 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4217 * Or %NULL on error.
4219 struct cfg80211_bss * __must_check
4220 cfg80211_inform_bss_data(struct wiphy *wiphy,
4221 struct cfg80211_inform_bss *data,
4222 enum cfg80211_bss_frame_type ftype,
4223 const u8 *bssid, u64 tsf, u16 capability,
4224 u16 beacon_interval, const u8 *ie, size_t ielen,
4227 static inline struct cfg80211_bss * __must_check
4228 cfg80211_inform_bss_width(struct wiphy *wiphy,
4229 struct ieee80211_channel *rx_channel,
4230 enum nl80211_bss_scan_width scan_width,
4231 enum cfg80211_bss_frame_type ftype,
4232 const u8 *bssid, u64 tsf, u16 capability,
4233 u16 beacon_interval, const u8 *ie, size_t ielen,
4234 s32 signal, gfp_t gfp)
4236 struct cfg80211_inform_bss data = {
4238 .scan_width = scan_width,
4242 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4243 capability, beacon_interval, ie, ielen,
4247 static inline struct cfg80211_bss * __must_check
4248 cfg80211_inform_bss(struct wiphy *wiphy,
4249 struct ieee80211_channel *rx_channel,
4250 enum cfg80211_bss_frame_type ftype,
4251 const u8 *bssid, u64 tsf, u16 capability,
4252 u16 beacon_interval, const u8 *ie, size_t ielen,
4253 s32 signal, gfp_t gfp)
4255 struct cfg80211_inform_bss data = {
4257 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4261 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4262 capability, beacon_interval, ie, ielen,
4266 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4267 struct ieee80211_channel *channel,
4269 const u8 *ssid, size_t ssid_len,
4270 enum ieee80211_bss_type bss_type,
4271 enum ieee80211_privacy);
4272 static inline struct cfg80211_bss *
4273 cfg80211_get_ibss(struct wiphy *wiphy,
4274 struct ieee80211_channel *channel,
4275 const u8 *ssid, size_t ssid_len)
4277 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4278 IEEE80211_BSS_TYPE_IBSS,
4279 IEEE80211_PRIVACY_ANY);
4283 * cfg80211_ref_bss - reference BSS struct
4284 * @wiphy: the wiphy this BSS struct belongs to
4285 * @bss: the BSS struct to reference
4287 * Increments the refcount of the given BSS struct.
4289 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4292 * cfg80211_put_bss - unref BSS struct
4293 * @wiphy: the wiphy this BSS struct belongs to
4294 * @bss: the BSS struct
4296 * Decrements the refcount of the given BSS struct.
4298 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4301 * cfg80211_unlink_bss - unlink BSS from internal data structures
4303 * @bss: the bss to remove
4305 * This function removes the given BSS from the internal data structures
4306 * thereby making it no longer show up in scan results etc. Use this
4307 * function when you detect a BSS is gone. Normally BSSes will also time
4308 * out, so it is not necessary to use this function at all.
4310 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4312 static inline enum nl80211_bss_scan_width
4313 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4315 switch (chandef->width) {
4316 case NL80211_CHAN_WIDTH_5:
4317 return NL80211_BSS_CHAN_WIDTH_5;
4318 case NL80211_CHAN_WIDTH_10:
4319 return NL80211_BSS_CHAN_WIDTH_10;
4321 return NL80211_BSS_CHAN_WIDTH_20;
4326 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4327 * @dev: network device
4328 * @buf: authentication frame (header + body)
4329 * @len: length of the frame data
4331 * This function is called whenever an authentication, disassociation or
4332 * deauthentication frame has been received and processed in station mode.
4333 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4334 * call either this function or cfg80211_auth_timeout().
4335 * After being asked to associate via cfg80211_ops::assoc() the driver must
4336 * call either this function or cfg80211_auth_timeout().
4337 * While connected, the driver must calls this for received and processed
4338 * disassociation and deauthentication frames. If the frame couldn't be used
4339 * because it was unprotected, the driver must call the function
4340 * cfg80211_rx_unprot_mlme_mgmt() instead.
4342 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4344 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4347 * cfg80211_auth_timeout - notification of timed out authentication
4348 * @dev: network device
4349 * @addr: The MAC address of the device with which the authentication timed out
4351 * This function may sleep. The caller must hold the corresponding wdev's
4354 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4357 * cfg80211_rx_assoc_resp - notification of processed association response
4358 * @dev: network device
4359 * @bss: the BSS that association was requested with, ownership of the pointer
4360 * moves to cfg80211 in this call
4361 * @buf: authentication frame (header + body)
4362 * @len: length of the frame data
4363 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4365 * After being asked to associate via cfg80211_ops::assoc() the driver must
4366 * call either this function or cfg80211_auth_timeout().
4368 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4370 void cfg80211_rx_assoc_resp(struct net_device *dev,
4371 struct cfg80211_bss *bss,
4372 const u8 *buf, size_t len,
4376 * cfg80211_assoc_timeout - notification of timed out association
4377 * @dev: network device
4378 * @bss: The BSS entry with which association timed out.
4380 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4382 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4385 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4386 * @dev: network device
4387 * @buf: 802.11 frame (header + body)
4388 * @len: length of the frame data
4390 * This function is called whenever deauthentication has been processed in
4391 * station mode. This includes both received deauthentication frames and
4392 * locally generated ones. This function may sleep. The caller must hold the
4393 * corresponding wdev's mutex.
4395 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4398 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4399 * @dev: network device
4400 * @buf: deauthentication frame (header + body)
4401 * @len: length of the frame data
4403 * This function is called whenever a received deauthentication or dissassoc
4404 * frame has been dropped in station mode because of MFP being used but the
4405 * frame was not protected. This function may sleep.
4407 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4408 const u8 *buf, size_t len);
4411 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4412 * @dev: network device
4413 * @addr: The source MAC address of the frame
4414 * @key_type: The key type that the received frame used
4415 * @key_id: Key identifier (0..3). Can be -1 if missing.
4416 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4417 * @gfp: allocation flags
4419 * This function is called whenever the local MAC detects a MIC failure in a
4420 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4423 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4424 enum nl80211_key_type key_type, int key_id,
4425 const u8 *tsc, gfp_t gfp);
4428 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4430 * @dev: network device
4431 * @bssid: the BSSID of the IBSS joined
4432 * @channel: the channel of the IBSS joined
4433 * @gfp: allocation flags
4435 * This function notifies cfg80211 that the device joined an IBSS or
4436 * switched to a different BSSID. Before this function can be called,
4437 * either a beacon has to have been received from the IBSS, or one of
4438 * the cfg80211_inform_bss{,_frame} functions must have been called
4439 * with the locally generated beacon -- this guarantees that there is
4440 * always a scan result for this IBSS. cfg80211 will handle the rest.
4442 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4443 struct ieee80211_channel *channel, gfp_t gfp);
4446 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4448 * @dev: network device
4449 * @macaddr: the MAC address of the new candidate
4450 * @ie: information elements advertised by the peer candidate
4451 * @ie_len: lenght of the information elements buffer
4452 * @gfp: allocation flags
4454 * This function notifies cfg80211 that the mesh peer candidate has been
4455 * detected, most likely via a beacon or, less likely, via a probe response.
4456 * cfg80211 then sends a notification to userspace.
4458 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4459 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4462 * DOC: RFkill integration
4464 * RFkill integration in cfg80211 is almost invisible to drivers,
4465 * as cfg80211 automatically registers an rfkill instance for each
4466 * wireless device it knows about. Soft kill is also translated
4467 * into disconnecting and turning all interfaces off, drivers are
4468 * expected to turn off the device when all interfaces are down.
4470 * However, devices may have a hard RFkill line, in which case they
4471 * also need to interact with the rfkill subsystem, via cfg80211.
4472 * They can do this with a few helper functions documented here.
4476 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4478 * @blocked: block status
4480 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4483 * wiphy_rfkill_start_polling - start polling rfkill
4486 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4489 * wiphy_rfkill_stop_polling - stop polling rfkill
4492 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4495 * DOC: Vendor commands
4497 * Occasionally, there are special protocol or firmware features that
4498 * can't be implemented very openly. For this and similar cases, the
4499 * vendor command functionality allows implementing the features with
4500 * (typically closed-source) userspace and firmware, using nl80211 as
4501 * the configuration mechanism.
4503 * A driver supporting vendor commands must register them as an array
4504 * in struct wiphy, with handlers for each one, each command has an
4505 * OUI and sub command ID to identify it.
4507 * Note that this feature should not be (ab)used to implement protocol
4508 * features that could openly be shared across drivers. In particular,
4509 * it must never be required to use vendor commands to implement any
4510 * "normal" functionality that higher-level userspace like connection
4511 * managers etc. need.
4514 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4515 enum nl80211_commands cmd,
4516 enum nl80211_attrs attr,
4519 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4520 struct wireless_dev *wdev,
4521 enum nl80211_commands cmd,
4522 enum nl80211_attrs attr,
4523 int vendor_event_idx,
4524 int approxlen, gfp_t gfp);
4526 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4529 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4531 * @approxlen: an upper bound of the length of the data that will
4532 * be put into the skb
4534 * This function allocates and pre-fills an skb for a reply to
4535 * a vendor command. Since it is intended for a reply, calling
4536 * it outside of a vendor command's doit() operation is invalid.
4538 * The returned skb is pre-filled with some identifying data in
4539 * a way that any data that is put into the skb (with skb_put(),
4540 * nla_put() or similar) will end up being within the
4541 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4542 * with the skb is adding data for the corresponding userspace tool
4543 * which can then read that data out of the vendor data attribute.
4544 * You must not modify the skb in any other way.
4546 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4547 * its error code as the result of the doit() operation.
4549 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4551 static inline struct sk_buff *
4552 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4554 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4555 NL80211_ATTR_VENDOR_DATA, approxlen);
4559 * cfg80211_vendor_cmd_reply - send the reply skb
4560 * @skb: The skb, must have been allocated with
4561 * cfg80211_vendor_cmd_alloc_reply_skb()
4563 * Since calling this function will usually be the last thing
4564 * before returning from the vendor command doit() you should
4565 * return the error code. Note that this function consumes the
4566 * skb regardless of the return value.
4568 * Return: An error code or 0 on success.
4570 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4573 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4575 * @wdev: the wireless device
4576 * @event_idx: index of the vendor event in the wiphy's vendor_events
4577 * @approxlen: an upper bound of the length of the data that will
4578 * be put into the skb
4579 * @gfp: allocation flags
4581 * This function allocates and pre-fills an skb for an event on the
4582 * vendor-specific multicast group.
4584 * If wdev != NULL, both the ifindex and identifier of the specified
4585 * wireless device are added to the event message before the vendor data
4588 * When done filling the skb, call cfg80211_vendor_event() with the
4589 * skb to send the event.
4591 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4593 static inline struct sk_buff *
4594 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4595 int approxlen, int event_idx, gfp_t gfp)
4597 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4598 NL80211_ATTR_VENDOR_DATA,
4599 event_idx, approxlen, gfp);
4603 * cfg80211_vendor_event - send the event
4604 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4605 * @gfp: allocation flags
4607 * This function sends the given @skb, which must have been allocated
4608 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4610 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4612 __cfg80211_send_event_skb(skb, gfp);
4615 #ifdef CONFIG_NL80211_TESTMODE
4619 * Test mode is a set of utility functions to allow drivers to
4620 * interact with driver-specific tools to aid, for instance,
4621 * factory programming.
4623 * This chapter describes how drivers interact with it, for more
4624 * information see the nl80211 book's chapter on it.
4628 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4630 * @approxlen: an upper bound of the length of the data that will
4631 * be put into the skb
4633 * This function allocates and pre-fills an skb for a reply to
4634 * the testmode command. Since it is intended for a reply, calling
4635 * it outside of the @testmode_cmd operation is invalid.
4637 * The returned skb is pre-filled with the wiphy index and set up in
4638 * a way that any data that is put into the skb (with skb_put(),
4639 * nla_put() or similar) will end up being within the
4640 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4641 * with the skb is adding data for the corresponding userspace tool
4642 * which can then read that data out of the testdata attribute. You
4643 * must not modify the skb in any other way.
4645 * When done, call cfg80211_testmode_reply() with the skb and return
4646 * its error code as the result of the @testmode_cmd operation.
4648 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4650 static inline struct sk_buff *
4651 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4653 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4654 NL80211_ATTR_TESTDATA, approxlen);
4658 * cfg80211_testmode_reply - send the reply skb
4659 * @skb: The skb, must have been allocated with
4660 * cfg80211_testmode_alloc_reply_skb()
4662 * Since calling this function will usually be the last thing
4663 * before returning from the @testmode_cmd you should return
4664 * the error code. Note that this function consumes the skb
4665 * regardless of the return value.
4667 * Return: An error code or 0 on success.
4669 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4671 return cfg80211_vendor_cmd_reply(skb);
4675 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4677 * @approxlen: an upper bound of the length of the data that will
4678 * be put into the skb
4679 * @gfp: allocation flags
4681 * This function allocates and pre-fills an skb for an event on the
4682 * testmode multicast group.
4684 * The returned skb is set up in the same way as with
4685 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4686 * there, you should simply add data to it that will then end up in the
4687 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4690 * When done filling the skb, call cfg80211_testmode_event() with the
4691 * skb to send the event.
4693 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4695 static inline struct sk_buff *
4696 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4698 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
4699 NL80211_ATTR_TESTDATA, -1,
4704 * cfg80211_testmode_event - send the event
4705 * @skb: The skb, must have been allocated with
4706 * cfg80211_testmode_alloc_event_skb()
4707 * @gfp: allocation flags
4709 * This function sends the given @skb, which must have been allocated
4710 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4713 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4715 __cfg80211_send_event_skb(skb, gfp);
4718 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4719 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4721 #define CFG80211_TESTMODE_CMD(cmd)
4722 #define CFG80211_TESTMODE_DUMP(cmd)
4726 * cfg80211_connect_bss - notify cfg80211 of connection result
4728 * @dev: network device
4729 * @bssid: the BSSID of the AP
4730 * @bss: entry of bss to which STA got connected to, can be obtained
4731 * through cfg80211_get_bss (may be %NULL)
4732 * @req_ie: association request IEs (maybe be %NULL)
4733 * @req_ie_len: association request IEs length
4734 * @resp_ie: association response IEs (may be %NULL)
4735 * @resp_ie_len: assoc response IEs length
4736 * @status: status code, 0 for successful connection, use
4737 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4738 * the real status code for failures.
4739 * @gfp: allocation flags
4741 * It should be called by the underlying driver whenever connect() has
4742 * succeeded. This is similar to cfg80211_connect_result(), but with the
4743 * option of identifying the exact bss entry for the connection. Only one of
4744 * these functions should be called.
4746 void cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
4747 struct cfg80211_bss *bss, const u8 *req_ie,
4748 size_t req_ie_len, const u8 *resp_ie,
4749 size_t resp_ie_len, int status, gfp_t gfp);
4752 * cfg80211_connect_result - notify cfg80211 of connection result
4754 * @dev: network device
4755 * @bssid: the BSSID of the AP
4756 * @req_ie: association request IEs (maybe be %NULL)
4757 * @req_ie_len: association request IEs length
4758 * @resp_ie: association response IEs (may be %NULL)
4759 * @resp_ie_len: assoc response IEs length
4760 * @status: status code, 0 for successful connection, use
4761 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4762 * the real status code for failures.
4763 * @gfp: allocation flags
4765 * It should be called by the underlying driver whenever connect() has
4769 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4770 const u8 *req_ie, size_t req_ie_len,
4771 const u8 *resp_ie, size_t resp_ie_len,
4772 u16 status, gfp_t gfp)
4774 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
4775 resp_ie_len, status, gfp);
4779 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
4781 * @dev: network device
4782 * @bssid: the BSSID of the AP
4783 * @req_ie: association request IEs (maybe be %NULL)
4784 * @req_ie_len: association request IEs length
4785 * @gfp: allocation flags
4787 * It should be called by the underlying driver whenever connect() has failed
4788 * in a sequence where no explicit authentication/association rejection was
4789 * received from the AP. This could happen, e.g., due to not being able to send
4790 * out the Authentication or Association Request frame or timing out while
4791 * waiting for the response.
4794 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
4795 const u8 *req_ie, size_t req_ie_len, gfp_t gfp)
4797 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
4802 * cfg80211_roamed - notify cfg80211 of roaming
4804 * @dev: network device
4805 * @channel: the channel of the new AP
4806 * @bssid: the BSSID of the new AP
4807 * @req_ie: association request IEs (maybe be %NULL)
4808 * @req_ie_len: association request IEs length
4809 * @resp_ie: association response IEs (may be %NULL)
4810 * @resp_ie_len: assoc response IEs length
4811 * @gfp: allocation flags
4813 * It should be called by the underlying driver whenever it roamed
4814 * from one AP to another while connected.
4816 void cfg80211_roamed(struct net_device *dev,
4817 struct ieee80211_channel *channel,
4819 const u8 *req_ie, size_t req_ie_len,
4820 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4823 * cfg80211_roamed_bss - notify cfg80211 of roaming
4825 * @dev: network device
4826 * @bss: entry of bss to which STA got roamed
4827 * @req_ie: association request IEs (maybe be %NULL)
4828 * @req_ie_len: association request IEs length
4829 * @resp_ie: association response IEs (may be %NULL)
4830 * @resp_ie_len: assoc response IEs length
4831 * @gfp: allocation flags
4833 * This is just a wrapper to notify cfg80211 of roaming event with driver
4834 * passing bss to avoid a race in timeout of the bss entry. It should be
4835 * called by the underlying driver whenever it roamed from one AP to another
4836 * while connected. Drivers which have roaming implemented in firmware
4837 * may use this function to avoid a race in bss entry timeout where the bss
4838 * entry of the new AP is seen in the driver, but gets timed out by the time
4839 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4840 * rdev->event_work. In case of any failures, the reference is released
4841 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4842 * it will be released while diconneting from the current bss.
4844 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4845 const u8 *req_ie, size_t req_ie_len,
4846 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4849 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4851 * @dev: network device
4852 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4853 * @ie_len: length of IEs
4854 * @reason: reason code for the disconnection, set it to 0 if unknown
4855 * @locally_generated: disconnection was requested locally
4856 * @gfp: allocation flags
4858 * After it calls this function, the driver should enter an idle state
4859 * and not try to connect to any AP any more.
4861 void cfg80211_disconnected(struct net_device *dev, u16 reason,
4862 const u8 *ie, size_t ie_len,
4863 bool locally_generated, gfp_t gfp);
4866 * cfg80211_ready_on_channel - notification of remain_on_channel start
4867 * @wdev: wireless device
4868 * @cookie: the request cookie
4869 * @chan: The current channel (from remain_on_channel request)
4870 * @duration: Duration in milliseconds that the driver intents to remain on the
4872 * @gfp: allocation flags
4874 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4875 struct ieee80211_channel *chan,
4876 unsigned int duration, gfp_t gfp);
4879 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4880 * @wdev: wireless device
4881 * @cookie: the request cookie
4882 * @chan: The current channel (from remain_on_channel request)
4883 * @gfp: allocation flags
4885 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4886 struct ieee80211_channel *chan,
4891 * cfg80211_new_sta - notify userspace about station
4894 * @mac_addr: the station's address
4895 * @sinfo: the station information
4896 * @gfp: allocation flags
4898 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4899 struct station_info *sinfo, gfp_t gfp);
4902 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4904 * @mac_addr: the station's address
4905 * @sinfo: the station information/statistics
4906 * @gfp: allocation flags
4908 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
4909 struct station_info *sinfo, gfp_t gfp);
4912 * cfg80211_del_sta - notify userspace about deletion of a station
4915 * @mac_addr: the station's address
4916 * @gfp: allocation flags
4918 static inline void cfg80211_del_sta(struct net_device *dev,
4919 const u8 *mac_addr, gfp_t gfp)
4921 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
4925 * cfg80211_conn_failed - connection request failed notification
4928 * @mac_addr: the station's address
4929 * @reason: the reason for connection failure
4930 * @gfp: allocation flags
4932 * Whenever a station tries to connect to an AP and if the station
4933 * could not connect to the AP as the AP has rejected the connection
4934 * for some reasons, this function is called.
4936 * The reason for connection failure can be any of the value from
4937 * nl80211_connect_failed_reason enum
4939 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4940 enum nl80211_connect_failed_reason reason,
4944 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4945 * @wdev: wireless device receiving the frame
4946 * @freq: Frequency on which the frame was received in MHz
4947 * @sig_dbm: signal strength in mBm, or 0 if unknown
4948 * @buf: Management frame (header + body)
4949 * @len: length of the frame data
4950 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4952 * This function is called whenever an Action frame is received for a station
4953 * mode interface, but is not processed in kernel.
4955 * Return: %true if a user space application has registered for this frame.
4956 * For action frames, that makes it responsible for rejecting unrecognized
4957 * action frames; %false otherwise, in which case for action frames the
4958 * driver is responsible for rejecting the frame.
4960 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4961 const u8 *buf, size_t len, u32 flags);
4964 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4965 * @wdev: wireless device receiving the frame
4966 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4967 * @buf: Management frame (header + body)
4968 * @len: length of the frame data
4969 * @ack: Whether frame was acknowledged
4970 * @gfp: context flags
4972 * This function is called whenever a management frame was requested to be
4973 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4974 * transmission attempt.
4976 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4977 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4981 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4982 * @dev: network device
4983 * @rssi_event: the triggered RSSI event
4984 * @gfp: context flags
4986 * This function is called when a configured connection quality monitoring
4987 * rssi threshold reached event occurs.
4989 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4990 enum nl80211_cqm_rssi_threshold_event rssi_event,
4994 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4995 * @dev: network device
4996 * @peer: peer's MAC address
4997 * @num_packets: how many packets were lost -- should be a fixed threshold
4998 * but probably no less than maybe 50, or maybe a throughput dependent
4999 * threshold (to account for temporary interference)
5000 * @gfp: context flags
5002 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5003 const u8 *peer, u32 num_packets, gfp_t gfp);
5006 * cfg80211_cqm_txe_notify - TX error rate event
5007 * @dev: network device
5008 * @peer: peer's MAC address
5009 * @num_packets: how many packets were lost
5010 * @rate: % of packets which failed transmission
5011 * @intvl: interval (in s) over which the TX failure threshold was breached.
5012 * @gfp: context flags
5014 * Notify userspace when configured % TX failures over number of packets in a
5015 * given interval is exceeded.
5017 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5018 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5021 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5022 * @dev: network device
5023 * @gfp: context flags
5025 * Notify userspace about beacon loss from the connected AP.
5027 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5030 * cfg80211_radar_event - radar detection event
5032 * @chandef: chandef for the current channel
5033 * @gfp: context flags
5035 * This function is called when a radar is detected on the current chanenl.
5037 void cfg80211_radar_event(struct wiphy *wiphy,
5038 struct cfg80211_chan_def *chandef, gfp_t gfp);
5041 * cfg80211_cac_event - Channel availability check (CAC) event
5042 * @netdev: network device
5043 * @chandef: chandef for the current channel
5044 * @event: type of event
5045 * @gfp: context flags
5047 * This function is called when a Channel availability check (CAC) is finished
5048 * or aborted. This must be called to notify the completion of a CAC process,
5049 * also by full-MAC drivers.
5051 void cfg80211_cac_event(struct net_device *netdev,
5052 const struct cfg80211_chan_def *chandef,
5053 enum nl80211_radar_event event, gfp_t gfp);
5057 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5058 * @dev: network device
5059 * @bssid: BSSID of AP (to avoid races)
5060 * @replay_ctr: new replay counter
5061 * @gfp: allocation flags
5063 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5064 const u8 *replay_ctr, gfp_t gfp);
5067 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5068 * @dev: network device
5069 * @index: candidate index (the smaller the index, the higher the priority)
5070 * @bssid: BSSID of AP
5071 * @preauth: Whether AP advertises support for RSN pre-authentication
5072 * @gfp: allocation flags
5074 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5075 const u8 *bssid, bool preauth, gfp_t gfp);
5078 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5079 * @dev: The device the frame matched to
5080 * @addr: the transmitter address
5081 * @gfp: context flags
5083 * This function is used in AP mode (only!) to inform userspace that
5084 * a spurious class 3 frame was received, to be able to deauth the
5086 * Return: %true if the frame was passed to userspace (or this failed
5087 * for a reason other than not having a subscription.)
5089 bool cfg80211_rx_spurious_frame(struct net_device *dev,
5090 const u8 *addr, gfp_t gfp);
5093 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5094 * @dev: The device the frame matched to
5095 * @addr: the transmitter address
5096 * @gfp: context flags
5098 * This function is used in AP mode (only!) to inform userspace that
5099 * an associated station sent a 4addr frame but that wasn't expected.
5100 * It is allowed and desirable to send this event only once for each
5101 * station to avoid event flooding.
5102 * Return: %true if the frame was passed to userspace (or this failed
5103 * for a reason other than not having a subscription.)
5105 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5106 const u8 *addr, gfp_t gfp);
5109 * cfg80211_probe_status - notify userspace about probe status
5110 * @dev: the device the probe was sent on
5111 * @addr: the address of the peer
5112 * @cookie: the cookie filled in @probe_client previously
5113 * @acked: indicates whether probe was acked or not
5114 * @gfp: allocation flags
5116 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
5117 u64 cookie, bool acked, gfp_t gfp);
5120 * cfg80211_report_obss_beacon - report beacon from other APs
5121 * @wiphy: The wiphy that received the beacon
5123 * @len: length of the frame
5124 * @freq: frequency the frame was received on
5125 * @sig_dbm: signal strength in mBm, or 0 if unknown
5127 * Use this function to report to userspace when a beacon was
5128 * received. It is not useful to call this when there is no
5129 * netdev that is in AP/GO mode.
5131 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
5132 const u8 *frame, size_t len,
5133 int freq, int sig_dbm);
5136 * cfg80211_reg_can_beacon - check if beaconing is allowed
5138 * @chandef: the channel definition
5139 * @iftype: interface type
5141 * Return: %true if there is no secondary channel or the secondary channel(s)
5142 * can be used for beaconing (i.e. is not a radar channel etc.)
5144 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
5145 struct cfg80211_chan_def *chandef,
5146 enum nl80211_iftype iftype);
5149 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5151 * @chandef: the channel definition
5152 * @iftype: interface type
5154 * Return: %true if there is no secondary channel or the secondary channel(s)
5155 * can be used for beaconing (i.e. is not a radar channel etc.). This version
5156 * also checks if IR-relaxation conditions apply, to allow beaconing under
5157 * more permissive conditions.
5159 * Requires the RTNL to be held.
5161 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
5162 struct cfg80211_chan_def *chandef,
5163 enum nl80211_iftype iftype);
5166 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5167 * @dev: the device which switched channels
5168 * @chandef: the new channel definition
5170 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5173 void cfg80211_ch_switch_notify(struct net_device *dev,
5174 struct cfg80211_chan_def *chandef);
5177 * cfg80211_ch_switch_started_notify - notify channel switch start
5178 * @dev: the device on which the channel switch started
5179 * @chandef: the future channel definition
5180 * @count: the number of TBTTs until the channel switch happens
5182 * Inform the userspace about the channel switch that has just
5183 * started, so that it can take appropriate actions (eg. starting
5184 * channel switch on other vifs), if necessary.
5186 void cfg80211_ch_switch_started_notify(struct net_device *dev,
5187 struct cfg80211_chan_def *chandef,
5191 * ieee80211_operating_class_to_band - convert operating class to band
5193 * @operating_class: the operating class to convert
5194 * @band: band pointer to fill
5196 * Returns %true if the conversion was successful, %false otherwise.
5198 bool ieee80211_operating_class_to_band(u8 operating_class,
5199 enum nl80211_band *band);
5202 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5204 * @chandef: the chandef to convert
5205 * @op_class: a pointer to the resulting operating class
5207 * Returns %true if the conversion was successful, %false otherwise.
5209 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5213 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5214 * @dev: the device on which the operation is requested
5215 * @peer: the MAC address of the peer device
5216 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5217 * NL80211_TDLS_TEARDOWN)
5218 * @reason_code: the reason code for teardown request
5219 * @gfp: allocation flags
5221 * This function is used to request userspace to perform TDLS operation that
5222 * requires knowledge of keys, i.e., link setup or teardown when the AP
5223 * connection uses encryption. This is optional mechanism for the driver to use
5224 * if it can automatically determine when a TDLS link could be useful (e.g.,
5225 * based on traffic and signal strength for a peer).
5227 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5228 enum nl80211_tdls_operation oper,
5229 u16 reason_code, gfp_t gfp);
5232 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5233 * @rate: given rate_info to calculate bitrate from
5235 * return 0 if MCS index >= 32
5237 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5240 * cfg80211_unregister_wdev - remove the given wdev
5241 * @wdev: struct wireless_dev to remove
5243 * Call this function only for wdevs that have no netdev assigned,
5244 * e.g. P2P Devices. It removes the device from the list so that
5245 * it can no longer be used. It is necessary to call this function
5246 * even when cfg80211 requests the removal of the interface by
5247 * calling the del_virtual_intf() callback. The function must also
5248 * be called when the driver wishes to unregister the wdev, e.g.
5249 * when the device is unbound from the driver.
5251 * Requires the RTNL to be held.
5253 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5256 * struct cfg80211_ft_event - FT Information Elements
5258 * @ies_len: length of the FT IE in bytes
5259 * @target_ap: target AP's MAC address
5261 * @ric_ies_len: length of the RIC IE in bytes
5263 struct cfg80211_ft_event_params {
5266 const u8 *target_ap;
5272 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5273 * @netdev: network device
5274 * @ft_event: IE information
5276 void cfg80211_ft_event(struct net_device *netdev,
5277 struct cfg80211_ft_event_params *ft_event);
5280 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5281 * @ies: the input IE buffer
5282 * @len: the input length
5283 * @attr: the attribute ID to find
5284 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5285 * if the function is only called to get the needed buffer size
5286 * @bufsize: size of the output buffer
5288 * The function finds a given P2P attribute in the (vendor) IEs and
5289 * copies its contents to the given buffer.
5291 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5292 * malformed or the attribute can't be found (respectively), or the
5293 * length of the found attribute (which can be zero).
5295 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5296 enum ieee80211_p2p_attr_id attr,
5297 u8 *buf, unsigned int bufsize);
5300 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5301 * @ies: the IE buffer
5302 * @ielen: the length of the IE buffer
5303 * @ids: an array with element IDs that are allowed before
5305 * @n_ids: the size of the element ID array
5306 * @after_ric: array IE types that come after the RIC element
5307 * @n_after_ric: size of the @after_ric array
5308 * @offset: offset where to start splitting in the buffer
5310 * This function splits an IE buffer by updating the @offset
5311 * variable to point to the location where the buffer should be
5314 * It assumes that the given IE buffer is well-formed, this
5315 * has to be guaranteed by the caller!
5317 * It also assumes that the IEs in the buffer are ordered
5318 * correctly, if not the result of using this function will not
5319 * be ordered correctly either, i.e. it does no reordering.
5321 * The function returns the offset where the next part of the
5322 * buffer starts, which may be @ielen if the entire (remainder)
5323 * of the buffer should be used.
5325 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5326 const u8 *ids, int n_ids,
5327 const u8 *after_ric, int n_after_ric,
5331 * ieee80211_ie_split - split an IE buffer according to ordering
5332 * @ies: the IE buffer
5333 * @ielen: the length of the IE buffer
5334 * @ids: an array with element IDs that are allowed before
5336 * @n_ids: the size of the element ID array
5337 * @offset: offset where to start splitting in the buffer
5339 * This function splits an IE buffer by updating the @offset
5340 * variable to point to the location where the buffer should be
5343 * It assumes that the given IE buffer is well-formed, this
5344 * has to be guaranteed by the caller!
5346 * It also assumes that the IEs in the buffer are ordered
5347 * correctly, if not the result of using this function will not
5348 * be ordered correctly either, i.e. it does no reordering.
5350 * The function returns the offset where the next part of the
5351 * buffer starts, which may be @ielen if the entire (remainder)
5352 * of the buffer should be used.
5354 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5355 const u8 *ids, int n_ids, size_t offset)
5357 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
5361 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5362 * @wdev: the wireless device reporting the wakeup
5363 * @wakeup: the wakeup report
5364 * @gfp: allocation flags
5366 * This function reports that the given device woke up. If it
5367 * caused the wakeup, report the reason(s), otherwise you may
5368 * pass %NULL as the @wakeup parameter to advertise that something
5369 * else caused the wakeup.
5371 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5372 struct cfg80211_wowlan_wakeup *wakeup,
5376 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5378 * @wdev: the wireless device for which critical protocol is stopped.
5379 * @gfp: allocation flags
5381 * This function can be called by the driver to indicate it has reverted
5382 * operation back to normal. One reason could be that the duration given
5383 * by .crit_proto_start() has expired.
5385 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5388 * ieee80211_get_num_supported_channels - get number of channels device has
5391 * Return: the number of channels supported by the device.
5393 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5396 * cfg80211_check_combinations - check interface combinations
5399 * @num_different_channels: the number of different channels we want
5400 * to use for verification
5401 * @radar_detect: a bitmap where each bit corresponds to a channel
5402 * width where radar detection is needed, as in the definition of
5403 * &struct ieee80211_iface_combination.@radar_detect_widths
5404 * @iftype_num: array with the numbers of interfaces of each interface
5405 * type. The index is the interface type as specified in &enum
5408 * This function can be called by the driver to check whether a
5409 * combination of interfaces and their types are allowed according to
5410 * the interface combinations.
5412 int cfg80211_check_combinations(struct wiphy *wiphy,
5413 const int num_different_channels,
5414 const u8 radar_detect,
5415 const int iftype_num[NUM_NL80211_IFTYPES]);
5418 * cfg80211_iter_combinations - iterate over matching combinations
5421 * @num_different_channels: the number of different channels we want
5422 * to use for verification
5423 * @radar_detect: a bitmap where each bit corresponds to a channel
5424 * width where radar detection is needed, as in the definition of
5425 * &struct ieee80211_iface_combination.@radar_detect_widths
5426 * @iftype_num: array with the numbers of interfaces of each interface
5427 * type. The index is the interface type as specified in &enum
5429 * @iter: function to call for each matching combination
5430 * @data: pointer to pass to iter function
5432 * This function can be called by the driver to check what possible
5433 * combinations it fits in at a given moment, e.g. for channel switching
5436 int cfg80211_iter_combinations(struct wiphy *wiphy,
5437 const int num_different_channels,
5438 const u8 radar_detect,
5439 const int iftype_num[NUM_NL80211_IFTYPES],
5440 void (*iter)(const struct ieee80211_iface_combination *c,
5445 * cfg80211_stop_iface - trigger interface disconnection
5448 * @wdev: wireless device
5449 * @gfp: context flags
5451 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5454 * Note: This doesn't need any locks and is asynchronous.
5456 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5460 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5461 * @wiphy: the wiphy to shut down
5463 * This function shuts down all interfaces belonging to this wiphy by
5464 * calling dev_close() (and treating non-netdev interfaces as needed).
5465 * It shouldn't really be used unless there are some fatal device errors
5466 * that really can't be recovered in any other way.
5468 * Callers must hold the RTNL and be able to deal with callbacks into
5469 * the driver while the function is running.
5471 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5474 * wiphy_ext_feature_set - set the extended feature flag
5476 * @wiphy: the wiphy to modify.
5477 * @ftidx: extended feature bit index.
5479 * The extended features are flagged in multiple bytes (see
5480 * &struct wiphy.@ext_features)
5482 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5483 enum nl80211_ext_feature_index ftidx)
5487 ft_byte = &wiphy->ext_features[ftidx / 8];
5488 *ft_byte |= BIT(ftidx % 8);
5492 * wiphy_ext_feature_isset - check the extended feature flag
5494 * @wiphy: the wiphy to modify.
5495 * @ftidx: extended feature bit index.
5497 * The extended features are flagged in multiple bytes (see
5498 * &struct wiphy.@ext_features)
5501 wiphy_ext_feature_isset(struct wiphy *wiphy,
5502 enum nl80211_ext_feature_index ftidx)
5506 ft_byte = wiphy->ext_features[ftidx / 8];
5507 return (ft_byte & BIT(ftidx % 8)) != 0;
5510 /* ethtool helper */
5511 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5513 /* Logging, debugging and troubleshooting/diagnostic helpers. */
5515 /* wiphy_printk helpers, similar to dev_printk */
5517 #define wiphy_printk(level, wiphy, format, args...) \
5518 dev_printk(level, &(wiphy)->dev, format, ##args)
5519 #define wiphy_emerg(wiphy, format, args...) \
5520 dev_emerg(&(wiphy)->dev, format, ##args)
5521 #define wiphy_alert(wiphy, format, args...) \
5522 dev_alert(&(wiphy)->dev, format, ##args)
5523 #define wiphy_crit(wiphy, format, args...) \
5524 dev_crit(&(wiphy)->dev, format, ##args)
5525 #define wiphy_err(wiphy, format, args...) \
5526 dev_err(&(wiphy)->dev, format, ##args)
5527 #define wiphy_warn(wiphy, format, args...) \
5528 dev_warn(&(wiphy)->dev, format, ##args)
5529 #define wiphy_notice(wiphy, format, args...) \
5530 dev_notice(&(wiphy)->dev, format, ##args)
5531 #define wiphy_info(wiphy, format, args...) \
5532 dev_info(&(wiphy)->dev, format, ##args)
5534 #define wiphy_debug(wiphy, format, args...) \
5535 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5537 #define wiphy_dbg(wiphy, format, args...) \
5538 dev_dbg(&(wiphy)->dev, format, ##args)
5540 #if defined(VERBOSE_DEBUG)
5541 #define wiphy_vdbg wiphy_dbg
5543 #define wiphy_vdbg(wiphy, format, args...) \
5546 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5552 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5553 * of using a WARN/WARN_ON to get the message out, including the
5554 * file/line information and a backtrace.
5556 #define wiphy_WARN(wiphy, format, args...) \
5557 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5559 #endif /* __NET_CFG80211_H */