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
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #include <linux/netdevice.h>
15 #include <linux/debugfs.h>
16 #include <linux/list.h>
17 #include <linux/bug.h>
18 #include <linux/netlink.h>
19 #include <linux/skbuff.h>
20 #include <linux/nl80211.h>
21 #include <linux/if_ether.h>
22 #include <linux/ieee80211.h>
23 #include <linux/net.h>
24 #include <net/regulatory.h>
29 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
30 * userspace and drivers, and offers some utility functionality associated
31 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
32 * by all modern wireless drivers in Linux, so that they offer a consistent
33 * API through nl80211. For backward compatibility, cfg80211 also offers
34 * wireless extensions to userspace, but hides them from drivers completely.
36 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
42 * DOC: Device registration
44 * In order for a driver to use cfg80211, it must register the hardware device
45 * with cfg80211. This happens through a number of hardware capability structs
48 * The fundamental structure for each device is the 'wiphy', of which each
49 * instance describes a physical wireless device connected to the system. Each
50 * such wiphy can have zero, one, or many virtual interfaces associated with
51 * it, which need to be identified as such by pointing the network interface's
52 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
53 * the wireless part of the interface, normally this struct is embedded in the
54 * network interface's private data area. Drivers can optionally allow creating
55 * or destroying virtual interfaces on the fly, but without at least one or the
56 * ability to create some the wireless device isn't useful.
58 * Each wiphy structure contains device capability information, and also has
59 * a pointer to the various operations the driver offers. The definitions and
60 * structures here describe these capabilities in detail.
66 * wireless hardware capability structures
70 * enum ieee80211_band - supported frequency bands
72 * The bands are assigned this way because the supported
73 * bitrates differ in these bands.
75 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
76 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
77 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
78 * @IEEE80211_NUM_BANDS: number of defined bands
81 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
82 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
83 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
90 * enum ieee80211_channel_flags - channel flags
92 * Channel flags set by the regulatory control code.
94 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
95 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
96 * sending probe requests or beaconing.
97 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
98 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
100 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
102 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
103 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
104 * this flag indicates that an 80 MHz channel cannot use this
105 * channel as the control or any of the secondary channels.
106 * This may be due to the driver or due to regulatory bandwidth
108 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
109 * this flag indicates that an 160 MHz channel cannot use this
110 * channel as the control or any of the secondary channels.
111 * This may be due to the driver or due to regulatory bandwidth
113 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
114 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
115 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
117 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
121 enum ieee80211_channel_flags {
122 IEEE80211_CHAN_DISABLED = 1<<0,
123 IEEE80211_CHAN_NO_IR = 1<<1,
125 IEEE80211_CHAN_RADAR = 1<<3,
126 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
127 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
128 IEEE80211_CHAN_NO_OFDM = 1<<6,
129 IEEE80211_CHAN_NO_80MHZ = 1<<7,
130 IEEE80211_CHAN_NO_160MHZ = 1<<8,
131 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
132 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
133 IEEE80211_CHAN_NO_20MHZ = 1<<11,
134 IEEE80211_CHAN_NO_10MHZ = 1<<12,
137 #define IEEE80211_CHAN_NO_HT40 \
138 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
140 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
141 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
144 * struct ieee80211_channel - channel definition
146 * This structure describes a single channel for use
149 * @center_freq: center frequency in MHz
150 * @hw_value: hardware-specific value for the channel
151 * @flags: channel flags from &enum ieee80211_channel_flags.
152 * @orig_flags: channel flags at registration time, used by regulatory
153 * code to support devices with additional restrictions
154 * @band: band this channel belongs to.
155 * @max_antenna_gain: maximum antenna gain in dBi
156 * @max_power: maximum transmission power (in dBm)
157 * @max_reg_power: maximum regulatory transmission power (in dBm)
158 * @beacon_found: helper to regulatory code to indicate when a beacon
159 * has been found on this channel. Use regulatory_hint_found_beacon()
160 * to enable this, this is useful only on 5 GHz band.
161 * @orig_mag: internal use
162 * @orig_mpwr: internal use
163 * @dfs_state: current state of this channel. Only relevant if radar is required
165 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
166 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
168 struct ieee80211_channel {
169 enum ieee80211_band band;
173 int max_antenna_gain;
178 int orig_mag, orig_mpwr;
179 enum nl80211_dfs_state dfs_state;
180 unsigned long dfs_state_entered;
181 unsigned int dfs_cac_ms;
185 * enum ieee80211_rate_flags - rate flags
187 * Hardware/specification flags for rates. These are structured
188 * in a way that allows using the same bitrate structure for
189 * different bands/PHY modes.
191 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
192 * preamble on this bitrate; only relevant in 2.4GHz band and
194 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
195 * when used with 802.11a (on the 5 GHz band); filled by the
196 * core code when registering the wiphy.
197 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
198 * when used with 802.11b (on the 2.4 GHz band); filled by the
199 * core code when registering the wiphy.
200 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
201 * when used with 802.11g (on the 2.4 GHz band); filled by the
202 * core code when registering the wiphy.
203 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
204 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
205 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
207 enum ieee80211_rate_flags {
208 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
209 IEEE80211_RATE_MANDATORY_A = 1<<1,
210 IEEE80211_RATE_MANDATORY_B = 1<<2,
211 IEEE80211_RATE_MANDATORY_G = 1<<3,
212 IEEE80211_RATE_ERP_G = 1<<4,
213 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
214 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
218 * enum ieee80211_bss_type - BSS type filter
220 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
221 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
222 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
223 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
224 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
226 enum ieee80211_bss_type {
227 IEEE80211_BSS_TYPE_ESS,
228 IEEE80211_BSS_TYPE_PBSS,
229 IEEE80211_BSS_TYPE_IBSS,
230 IEEE80211_BSS_TYPE_MBSS,
231 IEEE80211_BSS_TYPE_ANY
235 * enum ieee80211_privacy - BSS privacy filter
237 * @IEEE80211_PRIVACY_ON: privacy bit set
238 * @IEEE80211_PRIVACY_OFF: privacy bit clear
239 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
241 enum ieee80211_privacy {
242 IEEE80211_PRIVACY_ON,
243 IEEE80211_PRIVACY_OFF,
244 IEEE80211_PRIVACY_ANY
247 #define IEEE80211_PRIVACY(x) \
248 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
251 * struct ieee80211_rate - bitrate definition
253 * This structure describes a bitrate that an 802.11 PHY can
254 * operate with. The two values @hw_value and @hw_value_short
255 * are only for driver use when pointers to this structure are
258 * @flags: rate-specific flags
259 * @bitrate: bitrate in units of 100 Kbps
260 * @hw_value: driver/hardware value for this rate
261 * @hw_value_short: driver/hardware value for this rate when
262 * short preamble is used
264 struct ieee80211_rate {
267 u16 hw_value, hw_value_short;
271 * struct ieee80211_sta_ht_cap - STA's HT capabilities
273 * This structure describes most essential parameters needed
274 * to describe 802.11n HT capabilities for an STA.
276 * @ht_supported: is HT supported by the STA
277 * @cap: HT capabilities map as described in 802.11n spec
278 * @ampdu_factor: Maximum A-MPDU length factor
279 * @ampdu_density: Minimum A-MPDU spacing
280 * @mcs: Supported MCS rates
282 struct ieee80211_sta_ht_cap {
283 u16 cap; /* use IEEE80211_HT_CAP_ */
287 struct ieee80211_mcs_info mcs;
291 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
293 * This structure describes most essential parameters needed
294 * to describe 802.11ac VHT capabilities for an STA.
296 * @vht_supported: is VHT supported by the STA
297 * @cap: VHT capabilities map as described in 802.11ac spec
298 * @vht_mcs: Supported VHT MCS rates
300 struct ieee80211_sta_vht_cap {
302 u32 cap; /* use IEEE80211_VHT_CAP_ */
303 struct ieee80211_vht_mcs_info vht_mcs;
307 * struct ieee80211_supported_band - frequency band definition
309 * This structure describes a frequency band a wiphy
310 * is able to operate in.
312 * @channels: Array of channels the hardware can operate in
314 * @band: the band this structure represents
315 * @n_channels: Number of channels in @channels
316 * @bitrates: Array of bitrates the hardware can operate with
317 * in this band. Must be sorted to give a valid "supported
318 * rates" IE, i.e. CCK rates first, then OFDM.
319 * @n_bitrates: Number of bitrates in @bitrates
320 * @ht_cap: HT capabilities in this band
321 * @vht_cap: VHT capabilities in this band
323 struct ieee80211_supported_band {
324 struct ieee80211_channel *channels;
325 struct ieee80211_rate *bitrates;
326 enum ieee80211_band band;
329 struct ieee80211_sta_ht_cap ht_cap;
330 struct ieee80211_sta_vht_cap vht_cap;
334 * Wireless hardware/device configuration structures and methods
338 * DOC: Actions and configuration
340 * Each wireless device and each virtual interface offer a set of configuration
341 * operations and other actions that are invoked by userspace. Each of these
342 * actions is described in the operations structure, and the parameters these
343 * operations use are described separately.
345 * Additionally, some operations are asynchronous and expect to get status
346 * information via some functions that drivers need to call.
348 * Scanning and BSS list handling with its associated functionality is described
349 * in a separate chapter.
353 * struct vif_params - describes virtual interface parameters
354 * @use_4addr: use 4-address frames
355 * @macaddr: address to use for this virtual interface.
356 * If this parameter is set to zero address the driver may
357 * determine the address as needed.
358 * This feature is only fully supported by drivers that enable the
359 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
360 ** only p2p devices with specified MAC.
364 u8 macaddr[ETH_ALEN];
368 * struct key_params - key information
370 * Information about a key
373 * @key_len: length of key material
374 * @cipher: cipher suite selector
375 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
376 * with the get_key() callback, must be in little endian,
377 * length given by @seq_len.
378 * @seq_len: length of @seq.
389 * struct cfg80211_chan_def - channel definition
390 * @chan: the (control) channel
391 * @width: channel width
392 * @center_freq1: center frequency of first segment
393 * @center_freq2: center frequency of second segment
394 * (only with 80+80 MHz)
396 struct cfg80211_chan_def {
397 struct ieee80211_channel *chan;
398 enum nl80211_chan_width width;
404 * cfg80211_get_chandef_type - return old channel type from chandef
405 * @chandef: the channel definition
407 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
408 * chandef, which must have a bandwidth allowing this conversion.
410 static inline enum nl80211_channel_type
411 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
413 switch (chandef->width) {
414 case NL80211_CHAN_WIDTH_20_NOHT:
415 return NL80211_CHAN_NO_HT;
416 case NL80211_CHAN_WIDTH_20:
417 return NL80211_CHAN_HT20;
418 case NL80211_CHAN_WIDTH_40:
419 if (chandef->center_freq1 > chandef->chan->center_freq)
420 return NL80211_CHAN_HT40PLUS;
421 return NL80211_CHAN_HT40MINUS;
424 return NL80211_CHAN_NO_HT;
429 * cfg80211_chandef_create - create channel definition using channel type
430 * @chandef: the channel definition struct to fill
431 * @channel: the control channel
432 * @chantype: the channel type
434 * Given a channel type, create a channel definition.
436 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
437 struct ieee80211_channel *channel,
438 enum nl80211_channel_type chantype);
441 * cfg80211_chandef_identical - check if two channel definitions are identical
442 * @chandef1: first channel definition
443 * @chandef2: second channel definition
445 * Return: %true if the channels defined by the channel definitions are
446 * identical, %false otherwise.
449 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
450 const struct cfg80211_chan_def *chandef2)
452 return (chandef1->chan == chandef2->chan &&
453 chandef1->width == chandef2->width &&
454 chandef1->center_freq1 == chandef2->center_freq1 &&
455 chandef1->center_freq2 == chandef2->center_freq2);
459 * cfg80211_chandef_compatible - check if two channel definitions are compatible
460 * @chandef1: first channel definition
461 * @chandef2: second channel definition
463 * Return: %NULL if the given channel definitions are incompatible,
464 * chandef1 or chandef2 otherwise.
466 const struct cfg80211_chan_def *
467 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
468 const struct cfg80211_chan_def *chandef2);
471 * cfg80211_chandef_valid - check if a channel definition is valid
472 * @chandef: the channel definition to check
473 * Return: %true if the channel definition is valid. %false otherwise.
475 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
478 * cfg80211_chandef_usable - check if secondary channels can be used
479 * @wiphy: the wiphy to validate against
480 * @chandef: the channel definition to check
481 * @prohibited_flags: the regulatory channel flags that must not be set
482 * Return: %true if secondary channels are usable. %false otherwise.
484 bool cfg80211_chandef_usable(struct wiphy *wiphy,
485 const struct cfg80211_chan_def *chandef,
486 u32 prohibited_flags);
489 * cfg80211_chandef_dfs_required - checks if radar detection is required
490 * @wiphy: the wiphy to validate against
491 * @chandef: the channel definition to check
492 * @iftype: the interface type as specified in &enum nl80211_iftype
494 * 1 if radar detection is required, 0 if it is not, < 0 on error
496 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
497 const struct cfg80211_chan_def *chandef,
498 enum nl80211_iftype iftype);
501 * ieee80211_chandef_rate_flags - returns rate flags for a channel
503 * In some channel types, not all rates may be used - for example CCK
504 * rates may not be used in 5/10 MHz channels.
506 * @chandef: channel definition for the channel
508 * Returns: rate flags which apply for this channel
510 static inline enum ieee80211_rate_flags
511 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
513 switch (chandef->width) {
514 case NL80211_CHAN_WIDTH_5:
515 return IEEE80211_RATE_SUPPORTS_5MHZ;
516 case NL80211_CHAN_WIDTH_10:
517 return IEEE80211_RATE_SUPPORTS_10MHZ;
525 * ieee80211_chandef_max_power - maximum transmission power for the chandef
527 * In some regulations, the transmit power may depend on the configured channel
528 * bandwidth which may be defined as dBm/MHz. This function returns the actual
529 * max_power for non-standard (20 MHz) channels.
531 * @chandef: channel definition for the channel
533 * Returns: maximum allowed transmission power in dBm for the chandef
536 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
538 switch (chandef->width) {
539 case NL80211_CHAN_WIDTH_5:
540 return min(chandef->chan->max_reg_power - 6,
541 chandef->chan->max_power);
542 case NL80211_CHAN_WIDTH_10:
543 return min(chandef->chan->max_reg_power - 3,
544 chandef->chan->max_power);
548 return chandef->chan->max_power;
552 * enum survey_info_flags - survey information flags
554 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
555 * @SURVEY_INFO_IN_USE: channel is currently being used
556 * @SURVEY_INFO_TIME: active time (in ms) was filled in
557 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
558 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
559 * @SURVEY_INFO_TIME_RX: receive time was filled in
560 * @SURVEY_INFO_TIME_TX: transmit time was filled in
561 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
563 * Used by the driver to indicate which info in &struct survey_info
564 * it has filled in during the get_survey().
566 enum survey_info_flags {
567 SURVEY_INFO_NOISE_DBM = BIT(0),
568 SURVEY_INFO_IN_USE = BIT(1),
569 SURVEY_INFO_TIME = BIT(2),
570 SURVEY_INFO_TIME_BUSY = BIT(3),
571 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
572 SURVEY_INFO_TIME_RX = BIT(5),
573 SURVEY_INFO_TIME_TX = BIT(6),
574 SURVEY_INFO_TIME_SCAN = BIT(7),
578 * struct survey_info - channel survey response
580 * @channel: the channel this survey record reports, may be %NULL for a single
581 * record to report global statistics
582 * @filled: bitflag of flags from &enum survey_info_flags
583 * @noise: channel noise in dBm. This and all following fields are
585 * @time: amount of time in ms the radio was turn on (on the channel)
586 * @time_busy: amount of time the primary channel was sensed busy
587 * @time_ext_busy: amount of time the extension channel was sensed busy
588 * @time_rx: amount of time the radio spent receiving data
589 * @time_tx: amount of time the radio spent transmitting data
590 * @time_scan: amount of time the radio spent for scanning
592 * Used by dump_survey() to report back per-channel survey information.
594 * This structure can later be expanded with things like
595 * channel duty cycle etc.
598 struct ieee80211_channel *channel;
610 * struct cfg80211_crypto_settings - Crypto settings
611 * @wpa_versions: indicates which, if any, WPA versions are enabled
612 * (from enum nl80211_wpa_versions)
613 * @cipher_group: group key cipher suite (or 0 if unset)
614 * @n_ciphers_pairwise: number of AP supported unicast ciphers
615 * @ciphers_pairwise: unicast key cipher suites
616 * @n_akm_suites: number of AKM suites
617 * @akm_suites: AKM suites
618 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
619 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
620 * required to assume that the port is unauthorized until authorized by
621 * user space. Otherwise, port is marked authorized by default.
622 * @control_port_ethertype: the control port protocol that should be
623 * allowed through even on unauthorized ports
624 * @control_port_no_encrypt: TRUE to prevent encryption of control port
627 struct cfg80211_crypto_settings {
630 int n_ciphers_pairwise;
631 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
633 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
635 __be16 control_port_ethertype;
636 bool control_port_no_encrypt;
640 * struct cfg80211_beacon_data - beacon data
641 * @head: head portion of beacon (before TIM IE)
642 * or %NULL if not changed
643 * @tail: tail portion of beacon (after TIM IE)
644 * or %NULL if not changed
645 * @head_len: length of @head
646 * @tail_len: length of @tail
647 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
648 * @beacon_ies_len: length of beacon_ies in octets
649 * @proberesp_ies: extra information element(s) to add into Probe Response
651 * @proberesp_ies_len: length of proberesp_ies in octets
652 * @assocresp_ies: extra information element(s) to add into (Re)Association
653 * Response frames or %NULL
654 * @assocresp_ies_len: length of assocresp_ies in octets
655 * @probe_resp_len: length of probe response template (@probe_resp)
656 * @probe_resp: probe response template (AP mode only)
658 struct cfg80211_beacon_data {
659 const u8 *head, *tail;
660 const u8 *beacon_ies;
661 const u8 *proberesp_ies;
662 const u8 *assocresp_ies;
663 const u8 *probe_resp;
665 size_t head_len, tail_len;
666 size_t beacon_ies_len;
667 size_t proberesp_ies_len;
668 size_t assocresp_ies_len;
669 size_t probe_resp_len;
677 * struct cfg80211_acl_data - Access control list data
679 * @acl_policy: ACL policy to be applied on the station's
680 * entry specified by mac_addr
681 * @n_acl_entries: Number of MAC address entries passed
682 * @mac_addrs: List of MAC addresses of stations to be used for ACL
684 struct cfg80211_acl_data {
685 enum nl80211_acl_policy acl_policy;
689 struct mac_address mac_addrs[];
693 * struct cfg80211_ap_settings - AP configuration
695 * Used to configure an AP interface.
697 * @chandef: defines the channel to use
698 * @beacon: beacon data
699 * @beacon_interval: beacon interval
700 * @dtim_period: DTIM period
701 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
703 * @ssid_len: length of @ssid
704 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
705 * @crypto: crypto settings
706 * @privacy: the BSS uses privacy
707 * @auth_type: Authentication type (algorithm)
708 * @smps_mode: SMPS mode
709 * @inactivity_timeout: time in seconds to determine station's inactivity.
710 * @p2p_ctwindow: P2P CT Window
711 * @p2p_opp_ps: P2P opportunistic PS
712 * @acl: ACL configuration used by the drivers which has support for
713 * MAC address based access control
715 struct cfg80211_ap_settings {
716 struct cfg80211_chan_def chandef;
718 struct cfg80211_beacon_data beacon;
720 int beacon_interval, dtim_period;
723 enum nl80211_hidden_ssid hidden_ssid;
724 struct cfg80211_crypto_settings crypto;
726 enum nl80211_auth_type auth_type;
727 enum nl80211_smps_mode smps_mode;
728 int inactivity_timeout;
731 const struct cfg80211_acl_data *acl;
735 * struct cfg80211_csa_settings - channel switch settings
737 * Used for channel switch
739 * @chandef: defines the channel to use after the switch
740 * @beacon_csa: beacon data while performing the switch
741 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
742 * @counter_offsets_presp: offsets of the counters within the probe response
743 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
744 * @n_counter_offsets_presp: number of csa counters in the probe response
745 * @beacon_after: beacon data to be used on the new channel
746 * @radar_required: whether radar detection is required on the new channel
747 * @block_tx: whether transmissions should be blocked while changing
748 * @count: number of beacons until switch
750 struct cfg80211_csa_settings {
751 struct cfg80211_chan_def chandef;
752 struct cfg80211_beacon_data beacon_csa;
753 const u16 *counter_offsets_beacon;
754 const u16 *counter_offsets_presp;
755 unsigned int n_counter_offsets_beacon;
756 unsigned int n_counter_offsets_presp;
757 struct cfg80211_beacon_data beacon_after;
764 * enum station_parameters_apply_mask - station parameter values to apply
765 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
766 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
767 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
769 * Not all station parameters have in-band "no change" signalling,
770 * for those that don't these flags will are used.
772 enum station_parameters_apply_mask {
773 STATION_PARAM_APPLY_UAPSD = BIT(0),
774 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
775 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
779 * struct station_parameters - station parameters
781 * Used to change and create a new station.
783 * @vlan: vlan interface station should belong to
784 * @supported_rates: supported rates in IEEE 802.11 format
785 * (or NULL for no change)
786 * @supported_rates_len: number of supported rates
787 * @sta_flags_mask: station flags that changed
788 * (bitmask of BIT(NL80211_STA_FLAG_...))
789 * @sta_flags_set: station flags values
790 * (bitmask of BIT(NL80211_STA_FLAG_...))
791 * @listen_interval: listen interval or -1 for no change
792 * @aid: AID or zero for no change
793 * @plink_action: plink action to take
794 * @plink_state: set the peer link state for a station
795 * @ht_capa: HT capabilities of station
796 * @vht_capa: VHT capabilities of station
797 * @uapsd_queues: bitmap of queues configured for uapsd. same format
798 * as the AC bitmap in the QoS info field
799 * @max_sp: max Service Period. same format as the MAX_SP in the
800 * QoS info field (but already shifted down)
801 * @sta_modify_mask: bitmap indicating which parameters changed
802 * (for those that don't have a natural "no change" value),
803 * see &enum station_parameters_apply_mask
804 * @local_pm: local link-specific mesh power save mode (no change when set
806 * @capability: station capability
807 * @ext_capab: extended capabilities of the station
808 * @ext_capab_len: number of extended capabilities
809 * @supported_channels: supported channels in IEEE 802.11 format
810 * @supported_channels_len: number of supported channels
811 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
812 * @supported_oper_classes_len: number of supported operating classes
813 * @opmode_notif: operating mode field from Operating Mode Notification
814 * @opmode_notif_used: information if operating mode field is used
816 struct station_parameters {
817 const u8 *supported_rates;
818 struct net_device *vlan;
819 u32 sta_flags_mask, sta_flags_set;
823 u8 supported_rates_len;
826 const struct ieee80211_ht_cap *ht_capa;
827 const struct ieee80211_vht_cap *vht_capa;
830 enum nl80211_mesh_power_mode local_pm;
834 const u8 *supported_channels;
835 u8 supported_channels_len;
836 const u8 *supported_oper_classes;
837 u8 supported_oper_classes_len;
839 bool opmode_notif_used;
843 * struct station_del_parameters - station deletion parameters
845 * Used to delete a station entry (or all stations).
847 * @mac: MAC address of the station to remove or NULL to remove all stations
848 * @subtype: Management frame subtype to use for indicating removal
849 * (10 = Disassociation, 12 = Deauthentication)
850 * @reason_code: Reason code for the Disassociation/Deauthentication frame
852 struct station_del_parameters {
859 * enum cfg80211_station_type - the type of station being modified
860 * @CFG80211_STA_AP_CLIENT: client of an AP interface
861 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
862 * unassociated (update properties for this type of client is permitted)
863 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
864 * the AP MLME in the device
865 * @CFG80211_STA_AP_STA: AP station on managed interface
866 * @CFG80211_STA_IBSS: IBSS station
867 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
868 * while TDLS setup is in progress, it moves out of this state when
869 * being marked authorized; use this only if TDLS with external setup is
871 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
872 * entry that is operating, has been marked authorized by userspace)
873 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
874 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
876 enum cfg80211_station_type {
877 CFG80211_STA_AP_CLIENT,
878 CFG80211_STA_AP_CLIENT_UNASSOC,
879 CFG80211_STA_AP_MLME_CLIENT,
882 CFG80211_STA_TDLS_PEER_SETUP,
883 CFG80211_STA_TDLS_PEER_ACTIVE,
884 CFG80211_STA_MESH_PEER_KERNEL,
885 CFG80211_STA_MESH_PEER_USER,
889 * cfg80211_check_station_change - validate parameter changes
890 * @wiphy: the wiphy this operates on
891 * @params: the new parameters for a station
892 * @statype: the type of station being modified
894 * Utility function for the @change_station driver method. Call this function
895 * with the appropriate station type looking up the station (and checking that
896 * it exists). It will verify whether the station change is acceptable, and if
897 * not will return an error code. Note that it may modify the parameters for
898 * backward compatibility reasons, so don't use them before calling this.
900 int cfg80211_check_station_change(struct wiphy *wiphy,
901 struct station_parameters *params,
902 enum cfg80211_station_type statype);
905 * enum station_info_rate_flags - bitrate info flags
907 * Used by the driver to indicate the specific rate transmission
908 * type for 802.11n transmissions.
910 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
911 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
912 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
913 * @RATE_INFO_FLAGS_60G: 60GHz MCS
915 enum rate_info_flags {
916 RATE_INFO_FLAGS_MCS = BIT(0),
917 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
918 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
919 RATE_INFO_FLAGS_60G = BIT(3),
923 * enum rate_info_bw - rate bandwidth information
925 * Used by the driver to indicate the rate bandwidth.
927 * @RATE_INFO_BW_5: 5 MHz bandwidth
928 * @RATE_INFO_BW_10: 10 MHz bandwidth
929 * @RATE_INFO_BW_20: 20 MHz bandwidth
930 * @RATE_INFO_BW_40: 40 MHz bandwidth
931 * @RATE_INFO_BW_80: 80 MHz bandwidth
932 * @RATE_INFO_BW_160: 160 MHz bandwidth
944 * struct rate_info - bitrate information
946 * Information about a receiving or transmitting bitrate
948 * @flags: bitflag of flags from &enum rate_info_flags
949 * @mcs: mcs index if struct describes a 802.11n bitrate
950 * @legacy: bitrate in 100kbit/s for 802.11abg
951 * @nss: number of streams (VHT only)
952 * @bw: bandwidth (from &enum rate_info_bw)
963 * enum station_info_rate_flags - bitrate info flags
965 * Used by the driver to indicate the specific rate transmission
966 * type for 802.11n transmissions.
968 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
969 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
970 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
972 enum bss_param_flags {
973 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
974 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
975 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
979 * struct sta_bss_parameters - BSS parameters for the attached station
981 * Information about the currently associated BSS
983 * @flags: bitflag of flags from &enum bss_param_flags
984 * @dtim_period: DTIM period for the BSS
985 * @beacon_interval: beacon interval
987 struct sta_bss_parameters {
994 * struct cfg80211_tid_stats - per-TID statistics
995 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
996 * indicate the relevant values in this struct are filled
997 * @rx_msdu: number of received MSDUs
998 * @tx_msdu: number of (attempted) transmitted MSDUs
999 * @tx_msdu_retries: number of retries (not counting the first) for
1001 * @tx_msdu_failed: number of failed transmitted MSDUs
1003 struct cfg80211_tid_stats {
1007 u64 tx_msdu_retries;
1011 #define IEEE80211_MAX_CHAINS 4
1014 * struct station_info - station information
1016 * Station information filled by driver for get_station() and dump_station.
1018 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1019 * indicate the relevant values in this struct for them
1020 * @connected_time: time(in secs) since a station is last connected
1021 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1022 * @rx_bytes: bytes (size of MPDUs) received from this station
1023 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1024 * @llid: mesh local link id
1025 * @plid: mesh peer link id
1026 * @plink_state: mesh peer link state
1027 * @signal: The signal strength, type depends on the wiphy's signal_type.
1028 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1029 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1030 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1031 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1032 * @chain_signal: per-chain signal strength of last received packet in dBm
1033 * @chain_signal_avg: per-chain signal strength average in dBm
1034 * @txrate: current unicast bitrate from this station
1035 * @rxrate: current unicast bitrate to this station
1036 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1037 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1038 * @tx_retries: cumulative retry counts (MPDUs)
1039 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1040 * @rx_dropped_misc: Dropped for un-specified reason.
1041 * @bss_param: current BSS parameters
1042 * @generation: generation number for nl80211 dumps.
1043 * This number should increase every time the list of stations
1044 * changes, i.e. when a station is added or removed, so that
1045 * userspace can tell whether it got a consistent snapshot.
1046 * @assoc_req_ies: IEs from (Re)Association Request.
1047 * This is used only when in AP mode with drivers that do not use
1048 * user space MLME/SME implementation. The information is provided for
1049 * the cfg80211_new_sta() calls to notify user space of the IEs.
1050 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1051 * @sta_flags: station flags mask & values
1052 * @beacon_loss_count: Number of times beacon loss event has triggered.
1053 * @t_offset: Time offset of the station relative to this host.
1054 * @local_pm: local mesh STA power save mode
1055 * @peer_pm: peer mesh STA power save mode
1056 * @nonpeer_pm: non-peer mesh STA power save mode
1057 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1058 * towards this station.
1059 * @rx_beacon: number of beacons received from this peer
1060 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1062 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1063 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1065 struct station_info {
1078 s8 chain_signal[IEEE80211_MAX_CHAINS];
1079 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1081 struct rate_info txrate;
1082 struct rate_info rxrate;
1087 u32 rx_dropped_misc;
1088 struct sta_bss_parameters bss_param;
1089 struct nl80211_sta_flag_update sta_flags;
1093 const u8 *assoc_req_ies;
1094 size_t assoc_req_ies_len;
1096 u32 beacon_loss_count;
1098 enum nl80211_mesh_power_mode local_pm;
1099 enum nl80211_mesh_power_mode peer_pm;
1100 enum nl80211_mesh_power_mode nonpeer_pm;
1102 u32 expected_throughput;
1105 u8 rx_beacon_signal_avg;
1106 struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1110 * cfg80211_get_station - retrieve information about a given station
1111 * @dev: the device where the station is supposed to be connected to
1112 * @mac_addr: the mac address of the station of interest
1113 * @sinfo: pointer to the structure to fill with the information
1115 * Returns 0 on success and sinfo is filled with the available information
1116 * otherwise returns a negative error code and the content of sinfo has to be
1117 * considered undefined.
1119 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1120 struct station_info *sinfo);
1123 * enum monitor_flags - monitor flags
1125 * Monitor interface configuration flags. Note that these must be the bits
1126 * according to the nl80211 flags.
1128 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1129 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1130 * @MONITOR_FLAG_CONTROL: pass control frames
1131 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1132 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1133 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1135 enum monitor_flags {
1136 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1137 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1138 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1139 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1140 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1141 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1145 * enum mpath_info_flags - mesh path information flags
1147 * Used by the driver to indicate which info in &struct mpath_info it has filled
1148 * in during get_station() or dump_station().
1150 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1151 * @MPATH_INFO_SN: @sn filled
1152 * @MPATH_INFO_METRIC: @metric filled
1153 * @MPATH_INFO_EXPTIME: @exptime filled
1154 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1155 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1156 * @MPATH_INFO_FLAGS: @flags filled
1158 enum mpath_info_flags {
1159 MPATH_INFO_FRAME_QLEN = BIT(0),
1160 MPATH_INFO_SN = BIT(1),
1161 MPATH_INFO_METRIC = BIT(2),
1162 MPATH_INFO_EXPTIME = BIT(3),
1163 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1164 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1165 MPATH_INFO_FLAGS = BIT(6),
1169 * struct mpath_info - mesh path information
1171 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1173 * @filled: bitfield of flags from &enum mpath_info_flags
1174 * @frame_qlen: number of queued frames for this destination
1175 * @sn: target sequence number
1176 * @metric: metric (cost) of this mesh path
1177 * @exptime: expiration time for the mesh path from now, in msecs
1178 * @flags: mesh path flags
1179 * @discovery_timeout: total mesh path discovery timeout, in msecs
1180 * @discovery_retries: mesh path discovery retries
1181 * @generation: generation number for nl80211 dumps.
1182 * This number should increase every time the list of mesh paths
1183 * changes, i.e. when a station is added or removed, so that
1184 * userspace can tell whether it got a consistent snapshot.
1192 u32 discovery_timeout;
1193 u8 discovery_retries;
1200 * struct bss_parameters - BSS parameters
1202 * Used to change BSS parameters (mainly for AP mode).
1204 * @use_cts_prot: Whether to use CTS protection
1205 * (0 = no, 1 = yes, -1 = do not change)
1206 * @use_short_preamble: Whether the use of short preambles is allowed
1207 * (0 = no, 1 = yes, -1 = do not change)
1208 * @use_short_slot_time: Whether the use of short slot time is allowed
1209 * (0 = no, 1 = yes, -1 = do not change)
1210 * @basic_rates: basic rates in IEEE 802.11 format
1211 * (or NULL for no change)
1212 * @basic_rates_len: number of basic rates
1213 * @ap_isolate: do not forward packets between connected stations
1214 * @ht_opmode: HT Operation mode
1215 * (u16 = opmode, -1 = do not change)
1216 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1217 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1219 struct bss_parameters {
1221 int use_short_preamble;
1222 int use_short_slot_time;
1223 const u8 *basic_rates;
1227 s8 p2p_ctwindow, p2p_opp_ps;
1231 * struct mesh_config - 802.11s mesh configuration
1233 * These parameters can be changed while the mesh is active.
1235 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1236 * by the Mesh Peering Open message
1237 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1238 * used by the Mesh Peering Open message
1239 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1240 * the mesh peering management to close a mesh peering
1241 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1243 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1244 * be sent to establish a new peer link instance in a mesh
1245 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1246 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1248 * @auto_open_plinks: whether we should automatically open peer links when we
1249 * detect compatible mesh peers
1250 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1251 * synchronize to for 11s default synchronization method
1252 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1253 * that an originator mesh STA can send to a particular path target
1254 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1255 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1256 * a path discovery in milliseconds
1257 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1258 * receiving a PREQ shall consider the forwarding information from the
1259 * root to be valid. (TU = time unit)
1260 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1261 * which a mesh STA can send only one action frame containing a PREQ
1263 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1264 * which a mesh STA can send only one Action frame containing a PERR
1266 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1267 * it takes for an HWMP information element to propagate across the mesh
1268 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1269 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1270 * announcements are transmitted
1271 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1272 * station has access to a broader network beyond the MBSS. (This is
1273 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1274 * only means that the station will announce others it's a mesh gate, but
1275 * not necessarily using the gate announcement protocol. Still keeping the
1276 * same nomenclature to be in sync with the spec)
1277 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1278 * entity (default is TRUE - forwarding entity)
1279 * @rssi_threshold: the threshold for average signal strength of candidate
1280 * station to establish a peer link
1281 * @ht_opmode: mesh HT protection mode
1283 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1284 * receiving a proactive PREQ shall consider the forwarding information to
1285 * the root mesh STA to be valid.
1287 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1288 * PREQs are transmitted.
1289 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1290 * during which a mesh STA can send only one Action frame containing
1291 * a PREQ element for root path confirmation.
1292 * @power_mode: The default mesh power save mode which will be the initial
1293 * setting for new peer links.
1294 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1295 * after transmitting its beacon.
1296 * @plink_timeout: If no tx activity is seen from a STA we've established
1297 * peering with for longer than this time (in seconds), then remove it
1298 * from the STA's list of peers. Default is 30 minutes.
1300 struct mesh_config {
1301 u16 dot11MeshRetryTimeout;
1302 u16 dot11MeshConfirmTimeout;
1303 u16 dot11MeshHoldingTimeout;
1304 u16 dot11MeshMaxPeerLinks;
1305 u8 dot11MeshMaxRetries;
1308 bool auto_open_plinks;
1309 u32 dot11MeshNbrOffsetMaxNeighbor;
1310 u8 dot11MeshHWMPmaxPREQretries;
1311 u32 path_refresh_time;
1312 u16 min_discovery_timeout;
1313 u32 dot11MeshHWMPactivePathTimeout;
1314 u16 dot11MeshHWMPpreqMinInterval;
1315 u16 dot11MeshHWMPperrMinInterval;
1316 u16 dot11MeshHWMPnetDiameterTraversalTime;
1317 u8 dot11MeshHWMPRootMode;
1318 u16 dot11MeshHWMPRannInterval;
1319 bool dot11MeshGateAnnouncementProtocol;
1320 bool dot11MeshForwarding;
1323 u32 dot11MeshHWMPactivePathToRootTimeout;
1324 u16 dot11MeshHWMProotInterval;
1325 u16 dot11MeshHWMPconfirmationInterval;
1326 enum nl80211_mesh_power_mode power_mode;
1327 u16 dot11MeshAwakeWindowDuration;
1332 * struct mesh_setup - 802.11s mesh setup configuration
1333 * @chandef: defines the channel to use
1334 * @mesh_id: the mesh ID
1335 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1336 * @sync_method: which synchronization method to use
1337 * @path_sel_proto: which path selection protocol to use
1338 * @path_metric: which metric to use
1339 * @auth_id: which authentication method this mesh is using
1340 * @ie: vendor information elements (optional)
1341 * @ie_len: length of vendor information elements
1342 * @is_authenticated: this mesh requires authentication
1343 * @is_secure: this mesh uses security
1344 * @user_mpm: userspace handles all MPM functions
1345 * @dtim_period: DTIM period to use
1346 * @beacon_interval: beacon interval to use
1347 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1348 * @basic_rates: basic rates to use when creating the mesh
1350 * These parameters are fixed when the mesh is created.
1353 struct cfg80211_chan_def chandef;
1362 bool is_authenticated;
1366 u16 beacon_interval;
1367 int mcast_rate[IEEE80211_NUM_BANDS];
1372 * struct ocb_setup - 802.11p OCB mode setup configuration
1373 * @chandef: defines the channel to use
1375 * These parameters are fixed when connecting to the network
1378 struct cfg80211_chan_def chandef;
1382 * struct ieee80211_txq_params - TX queue parameters
1383 * @ac: AC identifier
1384 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1385 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1387 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1389 * @aifs: Arbitration interframe space [0..255]
1391 struct ieee80211_txq_params {
1400 * DOC: Scanning and BSS list handling
1402 * The scanning process itself is fairly simple, but cfg80211 offers quite
1403 * a bit of helper functionality. To start a scan, the scan operation will
1404 * be invoked with a scan definition. This scan definition contains the
1405 * channels to scan, and the SSIDs to send probe requests for (including the
1406 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1407 * probe. Additionally, a scan request may contain extra information elements
1408 * that should be added to the probe request. The IEs are guaranteed to be
1409 * well-formed, and will not exceed the maximum length the driver advertised
1410 * in the wiphy structure.
1412 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1413 * it is responsible for maintaining the BSS list; the driver should not
1414 * maintain a list itself. For this notification, various functions exist.
1416 * Since drivers do not maintain a BSS list, there are also a number of
1417 * functions to search for a BSS and obtain information about it from the
1418 * BSS structure cfg80211 maintains. The BSS list is also made available
1423 * struct cfg80211_ssid - SSID description
1425 * @ssid_len: length of the ssid
1427 struct cfg80211_ssid {
1428 u8 ssid[IEEE80211_MAX_SSID_LEN];
1433 * struct cfg80211_scan_request - scan request description
1435 * @ssids: SSIDs to scan for (active scan only)
1436 * @n_ssids: number of SSIDs
1437 * @channels: channels to scan on.
1438 * @n_channels: total number of channels to scan
1439 * @scan_width: channel width for scanning
1440 * @ie: optional information element(s) to add into Probe Request or %NULL
1441 * @ie_len: length of ie in octets
1442 * @flags: bit field of flags controlling operation
1443 * @rates: bitmap of rates to advertise for each band
1444 * @wiphy: the wiphy this was for
1445 * @scan_start: time (in jiffies) when the scan started
1446 * @wdev: the wireless device to scan for
1447 * @aborted: (internal) scan request was notified as aborted
1448 * @notified: (internal) scan request was notified as done or aborted
1449 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1450 * @mac_addr: MAC address used with randomisation
1451 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1452 * are 0 in the mask should be randomised, bits that are 1 should
1453 * be taken from the @mac_addr
1455 struct cfg80211_scan_request {
1456 struct cfg80211_ssid *ssids;
1459 enum nl80211_bss_scan_width scan_width;
1464 u32 rates[IEEE80211_NUM_BANDS];
1466 struct wireless_dev *wdev;
1468 u8 mac_addr[ETH_ALEN] __aligned(2);
1469 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1472 struct wiphy *wiphy;
1473 unsigned long scan_start;
1474 bool aborted, notified;
1478 struct ieee80211_channel *channels[0];
1481 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1485 get_random_bytes(buf, ETH_ALEN);
1486 for (i = 0; i < ETH_ALEN; i++) {
1488 buf[i] |= addr[i] & mask[i];
1493 * struct cfg80211_match_set - sets of attributes to match
1495 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1496 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1498 struct cfg80211_match_set {
1499 struct cfg80211_ssid ssid;
1504 * struct cfg80211_sched_scan_request - scheduled scan request description
1506 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1507 * @n_ssids: number of SSIDs
1508 * @n_channels: total number of channels to scan
1509 * @scan_width: channel width for scanning
1510 * @interval: interval between each scheduled scan cycle
1511 * @ie: optional information element(s) to add into Probe Request or %NULL
1512 * @ie_len: length of ie in octets
1513 * @flags: bit field of flags controlling operation
1514 * @match_sets: sets of parameters to be matched for a scan result
1515 * entry to be considered valid and to be passed to the host
1516 * (others are filtered out).
1517 * If ommited, all results are passed.
1518 * @n_match_sets: number of match sets
1519 * @wiphy: the wiphy this was for
1520 * @dev: the interface
1521 * @scan_start: start time of the scheduled scan
1522 * @channels: channels to scan
1523 * @min_rssi_thold: for drivers only supporting a single threshold, this
1524 * contains the minimum over all matchsets
1525 * @mac_addr: MAC address used with randomisation
1526 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1527 * are 0 in the mask should be randomised, bits that are 1 should
1528 * be taken from the @mac_addr
1529 * @rcu_head: RCU callback used to free the struct
1530 * @owner_nlportid: netlink portid of owner (if this should is a request
1531 * owned by a particular socket)
1532 * @delay: delay in seconds to use before starting the first scan
1533 * cycle. The driver may ignore this parameter and start
1534 * immediately (or at any other time), if this feature is not
1537 struct cfg80211_sched_scan_request {
1538 struct cfg80211_ssid *ssids;
1541 enum nl80211_bss_scan_width scan_width;
1546 struct cfg80211_match_set *match_sets;
1551 u8 mac_addr[ETH_ALEN] __aligned(2);
1552 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1555 struct wiphy *wiphy;
1556 struct net_device *dev;
1557 unsigned long scan_start;
1558 struct rcu_head rcu_head;
1562 struct ieee80211_channel *channels[0];
1566 * enum cfg80211_signal_type - signal type
1568 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1569 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1570 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1572 enum cfg80211_signal_type {
1573 CFG80211_SIGNAL_TYPE_NONE,
1574 CFG80211_SIGNAL_TYPE_MBM,
1575 CFG80211_SIGNAL_TYPE_UNSPEC,
1579 * struct cfg80211_inform_bss - BSS inform data
1580 * @chan: channel the frame was received on
1581 * @scan_width: scan width that was used
1582 * @signal: signal strength value, according to the wiphy's
1584 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1585 * received; should match the time when the frame was actually
1586 * received by the device (not just by the host, in case it was
1587 * buffered on the device) and be accurate to about 10ms.
1588 * If the frame isn't buffered, just passing the return value of
1589 * ktime_get_boot_ns() is likely appropriate.
1591 struct cfg80211_inform_bss {
1592 struct ieee80211_channel *chan;
1593 enum nl80211_bss_scan_width scan_width;
1599 * struct cfg80211_bss_ie_data - BSS entry IE data
1600 * @tsf: TSF contained in the frame that carried these IEs
1601 * @rcu_head: internal use, for freeing
1602 * @len: length of the IEs
1603 * @from_beacon: these IEs are known to come from a beacon
1606 struct cfg80211_bss_ies {
1608 struct rcu_head rcu_head;
1615 * struct cfg80211_bss - BSS description
1617 * This structure describes a BSS (which may also be a mesh network)
1618 * for use in scan results and similar.
1620 * @channel: channel this BSS is on
1621 * @scan_width: width of the control channel
1622 * @bssid: BSSID of the BSS
1623 * @beacon_interval: the beacon interval as from the frame
1624 * @capability: the capability field in host byte order
1625 * @ies: the information elements (Note that there is no guarantee that these
1626 * are well-formed!); this is a pointer to either the beacon_ies or
1627 * proberesp_ies depending on whether Probe Response frame has been
1628 * received. It is always non-%NULL.
1629 * @beacon_ies: the information elements from the last Beacon frame
1630 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1631 * own the beacon_ies, but they're just pointers to the ones from the
1632 * @hidden_beacon_bss struct)
1633 * @proberesp_ies: the information elements from the last Probe Response frame
1634 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1635 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1636 * that holds the beacon data. @beacon_ies is still valid, of course, and
1637 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1638 * @signal: signal strength value (type depends on the wiphy's signal_type)
1639 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1641 struct cfg80211_bss {
1642 struct ieee80211_channel *channel;
1643 enum nl80211_bss_scan_width scan_width;
1645 const struct cfg80211_bss_ies __rcu *ies;
1646 const struct cfg80211_bss_ies __rcu *beacon_ies;
1647 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1649 struct cfg80211_bss *hidden_beacon_bss;
1653 u16 beacon_interval;
1658 u8 priv[0] __aligned(sizeof(void *));
1662 * ieee80211_bss_get_ie - find IE with given ID
1663 * @bss: the bss to search
1666 * Note that the return value is an RCU-protected pointer, so
1667 * rcu_read_lock() must be held when calling this function.
1668 * Return: %NULL if not found.
1670 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1674 * struct cfg80211_auth_request - Authentication request data
1676 * This structure provides information needed to complete IEEE 802.11
1679 * @bss: The BSS to authenticate with, the callee must obtain a reference
1680 * to it if it needs to keep it.
1681 * @auth_type: Authentication type (algorithm)
1682 * @ie: Extra IEs to add to Authentication frame or %NULL
1683 * @ie_len: Length of ie buffer in octets
1684 * @key_len: length of WEP key for shared key authentication
1685 * @key_idx: index of WEP key for shared key authentication
1686 * @key: WEP key for shared key authentication
1687 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1688 * Authentication transaction sequence number field.
1689 * @sae_data_len: Length of sae_data buffer in octets
1691 struct cfg80211_auth_request {
1692 struct cfg80211_bss *bss;
1695 enum nl80211_auth_type auth_type;
1697 u8 key_len, key_idx;
1699 size_t sae_data_len;
1703 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1705 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1706 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1707 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1709 enum cfg80211_assoc_req_flags {
1710 ASSOC_REQ_DISABLE_HT = BIT(0),
1711 ASSOC_REQ_DISABLE_VHT = BIT(1),
1712 ASSOC_REQ_USE_RRM = BIT(2),
1716 * struct cfg80211_assoc_request - (Re)Association request data
1718 * This structure provides information needed to complete IEEE 802.11
1720 * @bss: The BSS to associate with. If the call is successful the driver is
1721 * given a reference that it must give back to cfg80211_send_rx_assoc()
1722 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1723 * association requests while already associating must be rejected.
1724 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1725 * @ie_len: Length of ie buffer in octets
1726 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1727 * @crypto: crypto settings
1728 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1729 * @flags: See &enum cfg80211_assoc_req_flags
1730 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1731 * will be used in ht_capa. Un-supported values will be ignored.
1732 * @ht_capa_mask: The bits of ht_capa which are to be used.
1733 * @vht_capa: VHT capability override
1734 * @vht_capa_mask: VHT capability mask indicating which fields to use
1736 struct cfg80211_assoc_request {
1737 struct cfg80211_bss *bss;
1738 const u8 *ie, *prev_bssid;
1740 struct cfg80211_crypto_settings crypto;
1743 struct ieee80211_ht_cap ht_capa;
1744 struct ieee80211_ht_cap ht_capa_mask;
1745 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1749 * struct cfg80211_deauth_request - Deauthentication request data
1751 * This structure provides information needed to complete IEEE 802.11
1754 * @bssid: the BSSID of the BSS to deauthenticate from
1755 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1756 * @ie_len: Length of ie buffer in octets
1757 * @reason_code: The reason code for the deauthentication
1758 * @local_state_change: if set, change local state only and
1759 * do not set a deauth frame
1761 struct cfg80211_deauth_request {
1766 bool local_state_change;
1770 * struct cfg80211_disassoc_request - Disassociation request data
1772 * This structure provides information needed to complete IEEE 802.11
1775 * @bss: the BSS to disassociate from
1776 * @ie: Extra IEs to add to Disassociation frame or %NULL
1777 * @ie_len: Length of ie buffer in octets
1778 * @reason_code: The reason code for the disassociation
1779 * @local_state_change: This is a request for a local state only, i.e., no
1780 * Disassociation frame is to be transmitted.
1782 struct cfg80211_disassoc_request {
1783 struct cfg80211_bss *bss;
1787 bool local_state_change;
1791 * struct cfg80211_ibss_params - IBSS parameters
1793 * This structure defines the IBSS parameters for the join_ibss()
1796 * @ssid: The SSID, will always be non-null.
1797 * @ssid_len: The length of the SSID, will always be non-zero.
1798 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1799 * search for IBSSs with a different BSSID.
1800 * @chandef: defines the channel to use if no other IBSS to join can be found
1801 * @channel_fixed: The channel should be fixed -- do not search for
1802 * IBSSs to join on other channels.
1803 * @ie: information element(s) to include in the beacon
1804 * @ie_len: length of that
1805 * @beacon_interval: beacon interval to use
1806 * @privacy: this is a protected network, keys will be configured
1808 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1809 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1810 * required to assume that the port is unauthorized until authorized by
1811 * user space. Otherwise, port is marked authorized by default.
1812 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1813 * changes the channel when a radar is detected. This is required
1814 * to operate on DFS channels.
1815 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1816 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1817 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1818 * will be used in ht_capa. Un-supported values will be ignored.
1819 * @ht_capa_mask: The bits of ht_capa which are to be used.
1821 struct cfg80211_ibss_params {
1824 struct cfg80211_chan_def chandef;
1826 u8 ssid_len, ie_len;
1827 u16 beacon_interval;
1832 bool userspace_handles_dfs;
1833 int mcast_rate[IEEE80211_NUM_BANDS];
1834 struct ieee80211_ht_cap ht_capa;
1835 struct ieee80211_ht_cap ht_capa_mask;
1839 * struct cfg80211_connect_params - Connection parameters
1841 * This structure provides information needed to complete IEEE 802.11
1842 * authentication and association.
1844 * @channel: The channel to use or %NULL if not specified (auto-select based
1846 * @channel_hint: The channel of the recommended BSS for initial connection or
1847 * %NULL if not specified
1848 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1850 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1851 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1852 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1855 * @ssid_len: Length of ssid in octets
1856 * @auth_type: Authentication type (algorithm)
1857 * @ie: IEs for association request
1858 * @ie_len: Length of assoc_ie in octets
1859 * @privacy: indicates whether privacy-enabled APs should be used
1860 * @mfp: indicate whether management frame protection is used
1861 * @crypto: crypto settings
1862 * @key_len: length of WEP key for shared key authentication
1863 * @key_idx: index of WEP key for shared key authentication
1864 * @key: WEP key for shared key authentication
1865 * @flags: See &enum cfg80211_assoc_req_flags
1866 * @bg_scan_period: Background scan period in seconds
1867 * or -1 to indicate that default value is to be used.
1868 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1869 * will be used in ht_capa. Un-supported values will be ignored.
1870 * @ht_capa_mask: The bits of ht_capa which are to be used.
1871 * @vht_capa: VHT Capability overrides
1872 * @vht_capa_mask: The bits of vht_capa which are to be used.
1874 struct cfg80211_connect_params {
1875 struct ieee80211_channel *channel;
1876 struct ieee80211_channel *channel_hint;
1878 const u8 *bssid_hint;
1881 enum nl80211_auth_type auth_type;
1885 enum nl80211_mfp mfp;
1886 struct cfg80211_crypto_settings crypto;
1888 u8 key_len, key_idx;
1891 struct ieee80211_ht_cap ht_capa;
1892 struct ieee80211_ht_cap ht_capa_mask;
1893 struct ieee80211_vht_cap vht_capa;
1894 struct ieee80211_vht_cap vht_capa_mask;
1898 * enum wiphy_params_flags - set_wiphy_params bitfield values
1899 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1900 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1901 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1902 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1903 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1904 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1906 enum wiphy_params_flags {
1907 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1908 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1909 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1910 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1911 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1912 WIPHY_PARAM_DYN_ACK = 1 << 5,
1916 * cfg80211_bitrate_mask - masks for bitrate control
1918 struct cfg80211_bitrate_mask {
1921 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1922 u16 vht_mcs[NL80211_VHT_NSS_MAX];
1923 enum nl80211_txrate_gi gi;
1924 } control[IEEE80211_NUM_BANDS];
1927 * struct cfg80211_pmksa - PMK Security Association
1929 * This structure is passed to the set/del_pmksa() method for PMKSA
1932 * @bssid: The AP's BSSID.
1933 * @pmkid: The PMK material itself.
1935 struct cfg80211_pmksa {
1941 * struct cfg80211_pkt_pattern - packet pattern
1942 * @mask: bitmask where to match pattern and where to ignore bytes,
1943 * one bit per byte, in same format as nl80211
1944 * @pattern: bytes to match where bitmask is 1
1945 * @pattern_len: length of pattern (in bytes)
1946 * @pkt_offset: packet offset (in bytes)
1948 * Internal note: @mask and @pattern are allocated in one chunk of
1949 * memory, free @mask only!
1951 struct cfg80211_pkt_pattern {
1952 const u8 *mask, *pattern;
1958 * struct cfg80211_wowlan_tcp - TCP connection parameters
1960 * @sock: (internal) socket for source port allocation
1961 * @src: source IP address
1962 * @dst: destination IP address
1963 * @dst_mac: destination MAC address
1964 * @src_port: source port
1965 * @dst_port: destination port
1966 * @payload_len: data payload length
1967 * @payload: data payload buffer
1968 * @payload_seq: payload sequence stamping configuration
1969 * @data_interval: interval at which to send data packets
1970 * @wake_len: wakeup payload match length
1971 * @wake_data: wakeup payload match data
1972 * @wake_mask: wakeup payload match mask
1973 * @tokens_size: length of the tokens buffer
1974 * @payload_tok: payload token usage configuration
1976 struct cfg80211_wowlan_tcp {
1977 struct socket *sock;
1979 u16 src_port, dst_port;
1980 u8 dst_mac[ETH_ALEN];
1983 struct nl80211_wowlan_tcp_data_seq payload_seq;
1986 const u8 *wake_data, *wake_mask;
1988 /* must be last, variable member */
1989 struct nl80211_wowlan_tcp_data_token payload_tok;
1993 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1995 * This structure defines the enabled WoWLAN triggers for the device.
1996 * @any: wake up on any activity -- special trigger if device continues
1997 * operating as normal during suspend
1998 * @disconnect: wake up if getting disconnected
1999 * @magic_pkt: wake up on receiving magic packet
2000 * @patterns: wake up on receiving packet matching a pattern
2001 * @n_patterns: number of patterns
2002 * @gtk_rekey_failure: wake up on GTK rekey failure
2003 * @eap_identity_req: wake up on EAP identity request packet
2004 * @four_way_handshake: wake up on 4-way handshake
2005 * @rfkill_release: wake up when rfkill is released
2006 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2007 * NULL if not configured.
2008 * @nd_config: configuration for the scan to be used for net detect wake.
2010 struct cfg80211_wowlan {
2011 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2012 eap_identity_req, four_way_handshake,
2014 struct cfg80211_pkt_pattern *patterns;
2015 struct cfg80211_wowlan_tcp *tcp;
2017 struct cfg80211_sched_scan_request *nd_config;
2021 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2023 * This structure defines coalesce rule for the device.
2024 * @delay: maximum coalescing delay in msecs.
2025 * @condition: condition for packet coalescence.
2026 * see &enum nl80211_coalesce_condition.
2027 * @patterns: array of packet patterns
2028 * @n_patterns: number of patterns
2030 struct cfg80211_coalesce_rules {
2032 enum nl80211_coalesce_condition condition;
2033 struct cfg80211_pkt_pattern *patterns;
2038 * struct cfg80211_coalesce - Packet coalescing settings
2040 * This structure defines coalescing settings.
2041 * @rules: array of coalesce rules
2042 * @n_rules: number of rules
2044 struct cfg80211_coalesce {
2045 struct cfg80211_coalesce_rules *rules;
2050 * struct cfg80211_wowlan_nd_match - information about the match
2052 * @ssid: SSID of the match that triggered the wake up
2053 * @n_channels: Number of channels where the match occurred. This
2054 * value may be zero if the driver can't report the channels.
2055 * @channels: center frequencies of the channels where a match
2058 struct cfg80211_wowlan_nd_match {
2059 struct cfg80211_ssid ssid;
2065 * struct cfg80211_wowlan_nd_info - net detect wake up information
2067 * @n_matches: Number of match information instances provided in
2068 * @matches. This value may be zero if the driver can't provide
2069 * match information.
2070 * @matches: Array of pointers to matches containing information about
2071 * the matches that triggered the wake up.
2073 struct cfg80211_wowlan_nd_info {
2075 struct cfg80211_wowlan_nd_match *matches[];
2079 * struct cfg80211_wowlan_wakeup - wakeup report
2080 * @disconnect: woke up by getting disconnected
2081 * @magic_pkt: woke up by receiving magic packet
2082 * @gtk_rekey_failure: woke up by GTK rekey failure
2083 * @eap_identity_req: woke up by EAP identity request packet
2084 * @four_way_handshake: woke up by 4-way handshake
2085 * @rfkill_release: woke up by rfkill being released
2086 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2087 * @packet_present_len: copied wakeup packet data
2088 * @packet_len: original wakeup packet length
2089 * @packet: The packet causing the wakeup, if any.
2090 * @packet_80211: For pattern match, magic packet and other data
2091 * frame triggers an 802.3 frame should be reported, for
2092 * disconnect due to deauth 802.11 frame. This indicates which
2094 * @tcp_match: TCP wakeup packet received
2095 * @tcp_connlost: TCP connection lost or failed to establish
2096 * @tcp_nomoretokens: TCP data ran out of tokens
2097 * @net_detect: if not %NULL, woke up because of net detect
2099 struct cfg80211_wowlan_wakeup {
2100 bool disconnect, magic_pkt, gtk_rekey_failure,
2101 eap_identity_req, four_way_handshake,
2102 rfkill_release, packet_80211,
2103 tcp_match, tcp_connlost, tcp_nomoretokens;
2105 u32 packet_present_len, packet_len;
2107 struct cfg80211_wowlan_nd_info *net_detect;
2111 * struct cfg80211_gtk_rekey_data - rekey data
2112 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2113 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2114 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2116 struct cfg80211_gtk_rekey_data {
2117 const u8 *kek, *kck, *replay_ctr;
2121 * struct cfg80211_update_ft_ies_params - FT IE Information
2123 * This structure provides information needed to update the fast transition IE
2125 * @md: The Mobility Domain ID, 2 Octet value
2126 * @ie: Fast Transition IEs
2127 * @ie_len: Length of ft_ie in octets
2129 struct cfg80211_update_ft_ies_params {
2136 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2138 * This structure provides information needed to transmit a mgmt frame
2140 * @chan: channel to use
2141 * @offchan: indicates wether off channel operation is required
2142 * @wait: duration for ROC
2143 * @buf: buffer to transmit
2144 * @len: buffer length
2145 * @no_cck: don't use cck rates for this frame
2146 * @dont_wait_for_ack: tells the low level not to wait for an ack
2147 * @n_csa_offsets: length of csa_offsets array
2148 * @csa_offsets: array of all the csa offsets in the frame
2150 struct cfg80211_mgmt_tx_params {
2151 struct ieee80211_channel *chan;
2157 bool dont_wait_for_ack;
2159 const u16 *csa_offsets;
2163 * struct cfg80211_dscp_exception - DSCP exception
2165 * @dscp: DSCP value that does not adhere to the user priority range definition
2166 * @up: user priority value to which the corresponding DSCP value belongs
2168 struct cfg80211_dscp_exception {
2174 * struct cfg80211_dscp_range - DSCP range definition for user priority
2176 * @low: lowest DSCP value of this user priority range, inclusive
2177 * @high: highest DSCP value of this user priority range, inclusive
2179 struct cfg80211_dscp_range {
2184 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2185 #define IEEE80211_QOS_MAP_MAX_EX 21
2186 #define IEEE80211_QOS_MAP_LEN_MIN 16
2187 #define IEEE80211_QOS_MAP_LEN_MAX \
2188 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2191 * struct cfg80211_qos_map - QoS Map Information
2193 * This struct defines the Interworking QoS map setting for DSCP values
2195 * @num_des: number of DSCP exceptions (0..21)
2196 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2197 * the user priority DSCP range definition
2198 * @up: DSCP range definition for a particular user priority
2200 struct cfg80211_qos_map {
2202 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2203 struct cfg80211_dscp_range up[8];
2207 * struct cfg80211_ops - backend description for wireless configuration
2209 * This struct is registered by fullmac card drivers and/or wireless stacks
2210 * in order to handle configuration requests on their interfaces.
2212 * All callbacks except where otherwise noted should return 0
2213 * on success or a negative error code.
2215 * All operations are currently invoked under rtnl for consistency with the
2216 * wireless extensions but this is subject to reevaluation as soon as this
2217 * code is used more widely and we have a first user without wext.
2219 * @suspend: wiphy device needs to be suspended. The variable @wow will
2220 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2221 * configured for the device.
2222 * @resume: wiphy device needs to be resumed
2223 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2224 * to call device_set_wakeup_enable() to enable/disable wakeup from
2227 * @add_virtual_intf: create a new virtual interface with the given name,
2228 * must set the struct wireless_dev's iftype. Beware: You must create
2229 * the new netdev in the wiphy's network namespace! Returns the struct
2230 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2231 * also set the address member in the wdev.
2233 * @del_virtual_intf: remove the virtual interface
2235 * @change_virtual_intf: change type/configuration of virtual interface,
2236 * keep the struct wireless_dev's iftype updated.
2238 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2239 * when adding a group key.
2241 * @get_key: get information about the key with the given parameters.
2242 * @mac_addr will be %NULL when requesting information for a group
2243 * key. All pointers given to the @callback function need not be valid
2244 * after it returns. This function should return an error if it is
2245 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2247 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2248 * and @key_index, return -ENOENT if the key doesn't exist.
2250 * @set_default_key: set the default key on an interface
2252 * @set_default_mgmt_key: set the default management frame key on an interface
2254 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2256 * @start_ap: Start acting in AP mode defined by the parameters.
2257 * @change_beacon: Change the beacon parameters for an access point mode
2258 * interface. This should reject the call when AP mode wasn't started.
2259 * @stop_ap: Stop being an AP, including stopping beaconing.
2261 * @add_station: Add a new station.
2262 * @del_station: Remove a station
2263 * @change_station: Modify a given station. Note that flags changes are not much
2264 * validated in cfg80211, in particular the auth/assoc/authorized flags
2265 * might come to the driver in invalid combinations -- make sure to check
2266 * them, also against the existing state! Drivers must call
2267 * cfg80211_check_station_change() to validate the information.
2268 * @get_station: get station information for the station identified by @mac
2269 * @dump_station: dump station callback -- resume dump at index @idx
2271 * @add_mpath: add a fixed mesh path
2272 * @del_mpath: delete a given mesh path
2273 * @change_mpath: change a given mesh path
2274 * @get_mpath: get a mesh path for the given parameters
2275 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2276 * @get_mpp: get a mesh proxy path for the given parameters
2277 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2278 * @join_mesh: join the mesh network with the specified parameters
2279 * (invoked with the wireless_dev mutex held)
2280 * @leave_mesh: leave the current mesh network
2281 * (invoked with the wireless_dev mutex held)
2283 * @get_mesh_config: Get the current mesh configuration
2285 * @update_mesh_config: Update mesh parameters on a running mesh.
2286 * The mask is a bitfield which tells us which parameters to
2287 * set, and which to leave alone.
2289 * @change_bss: Modify parameters for a given BSS.
2291 * @set_txq_params: Set TX queue parameters
2293 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2294 * as it doesn't implement join_mesh and needs to set the channel to
2295 * join the mesh instead.
2297 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2298 * interfaces are active this callback should reject the configuration.
2299 * If no interfaces are active or the device is down, the channel should
2300 * be stored for when a monitor interface becomes active.
2302 * @scan: Request to do a scan. If returning zero, the scan request is given
2303 * the driver, and will be valid until passed to cfg80211_scan_done().
2304 * For scan results, call cfg80211_inform_bss(); you can call this outside
2305 * the scan/scan_done bracket too.
2307 * @auth: Request to authenticate with the specified peer
2308 * (invoked with the wireless_dev mutex held)
2309 * @assoc: Request to (re)associate with the specified peer
2310 * (invoked with the wireless_dev mutex held)
2311 * @deauth: Request to deauthenticate from the specified peer
2312 * (invoked with the wireless_dev mutex held)
2313 * @disassoc: Request to disassociate from the specified peer
2314 * (invoked with the wireless_dev mutex held)
2316 * @connect: Connect to the ESS with the specified parameters. When connected,
2317 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2318 * If the connection fails for some reason, call cfg80211_connect_result()
2319 * with the status from the AP.
2320 * (invoked with the wireless_dev mutex held)
2321 * @disconnect: Disconnect from the BSS/ESS.
2322 * (invoked with the wireless_dev mutex held)
2324 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2325 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2327 * (invoked with the wireless_dev mutex held)
2328 * @leave_ibss: Leave the IBSS.
2329 * (invoked with the wireless_dev mutex held)
2331 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2334 * @set_wiphy_params: Notify that wiphy parameters have changed;
2335 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2336 * have changed. The actual parameter values are available in
2337 * struct wiphy. If returning an error, no value should be changed.
2339 * @set_tx_power: set the transmit power according to the parameters,
2340 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2341 * wdev may be %NULL if power was set for the wiphy, and will
2342 * always be %NULL unless the driver supports per-vif TX power
2343 * (as advertised by the nl80211 feature flag.)
2344 * @get_tx_power: store the current TX power into the dbm variable;
2345 * return 0 if successful
2347 * @set_wds_peer: set the WDS peer for a WDS interface
2349 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2350 * functions to adjust rfkill hw state
2352 * @dump_survey: get site survey information.
2354 * @remain_on_channel: Request the driver to remain awake on the specified
2355 * channel for the specified duration to complete an off-channel
2356 * operation (e.g., public action frame exchange). When the driver is
2357 * ready on the requested channel, it must indicate this with an event
2358 * notification by calling cfg80211_ready_on_channel().
2359 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2360 * This allows the operation to be terminated prior to timeout based on
2361 * the duration value.
2362 * @mgmt_tx: Transmit a management frame.
2363 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2364 * frame on another channel
2366 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2367 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2368 * used by the function, but 0 and 1 must not be touched. Additionally,
2369 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2370 * dump and return to userspace with an error, so be careful. If any data
2371 * was passed in from userspace then the data/len arguments will be present
2372 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2374 * @set_bitrate_mask: set the bitrate mask configuration
2376 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2377 * devices running firmwares capable of generating the (re) association
2378 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2379 * @del_pmksa: Delete a cached PMKID.
2380 * @flush_pmksa: Flush all cached PMKIDs.
2381 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2382 * allows the driver to adjust the dynamic ps timeout value.
2383 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2384 * @set_cqm_txe_config: Configure connection quality monitor TX error
2386 * @sched_scan_start: Tell the driver to start a scheduled scan.
2387 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2388 * call must stop the scheduled scan and be ready for starting a new one
2389 * before it returns, i.e. @sched_scan_start may be called immediately
2390 * after that again and should not fail in that case. The driver should
2391 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2392 * method returns 0.)
2394 * @mgmt_frame_register: Notify driver that a management frame type was
2395 * registered. The callback is allowed to sleep.
2397 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2398 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2399 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2400 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2402 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2404 * @tdls_mgmt: Transmit a TDLS management frame.
2405 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2407 * @probe_client: probe an associated client, must return a cookie that it
2408 * later passes to cfg80211_probe_status().
2410 * @set_noack_map: Set the NoAck Map for the TIDs.
2412 * @get_channel: Get the current operating channel for the virtual interface.
2413 * For monitor interfaces, it should return %NULL unless there's a single
2414 * current monitoring channel.
2416 * @start_p2p_device: Start the given P2P device.
2417 * @stop_p2p_device: Stop the given P2P device.
2419 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2420 * Parameters include ACL policy, an array of MAC address of stations
2421 * and the number of MAC addresses. If there is already a list in driver
2422 * this new list replaces the existing one. Driver has to clear its ACL
2423 * when number of MAC addresses entries is passed as 0. Drivers which
2424 * advertise the support for MAC based ACL have to implement this callback.
2426 * @start_radar_detection: Start radar detection in the driver.
2428 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2429 * driver. If the SME is in the driver/firmware, this information can be
2430 * used in building Authentication and Reassociation Request frames.
2432 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2433 * for a given duration (milliseconds). The protocol is provided so the
2434 * driver can take the most appropriate actions.
2435 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2436 * reliability. This operation can not fail.
2437 * @set_coalesce: Set coalesce parameters.
2439 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2440 * responsible for veryfing if the switch is possible. Since this is
2441 * inherently tricky driver may decide to disconnect an interface later
2442 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2443 * everything. It should do it's best to verify requests and reject them
2444 * as soon as possible.
2446 * @set_qos_map: Set QoS mapping information to the driver
2448 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2449 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2450 * changes during the lifetime of the BSS.
2452 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2453 * with the given parameters; action frame exchange has been handled by
2454 * userspace so this just has to modify the TX path to take the TS into
2456 * If the admitted time is 0 just validate the parameters to make sure
2457 * the session can be created at all; it is valid to just always return
2458 * success for that but that may result in inefficient behaviour (handshake
2459 * with the peer followed by immediate teardown when the addition is later
2461 * @del_tx_ts: remove an existing TX TS
2463 * @join_ocb: join the OCB network with the specified parameters
2464 * (invoked with the wireless_dev mutex held)
2465 * @leave_ocb: leave the current OCB network
2466 * (invoked with the wireless_dev mutex held)
2468 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2469 * is responsible for continually initiating channel-switching operations
2470 * and returning to the base channel for communication with the AP.
2471 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2472 * peers must be on the base channel when the call completes.
2474 struct cfg80211_ops {
2475 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2476 int (*resume)(struct wiphy *wiphy);
2477 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2479 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2481 unsigned char name_assign_type,
2482 enum nl80211_iftype type,
2484 struct vif_params *params);
2485 int (*del_virtual_intf)(struct wiphy *wiphy,
2486 struct wireless_dev *wdev);
2487 int (*change_virtual_intf)(struct wiphy *wiphy,
2488 struct net_device *dev,
2489 enum nl80211_iftype type, u32 *flags,
2490 struct vif_params *params);
2492 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2493 u8 key_index, bool pairwise, const u8 *mac_addr,
2494 struct key_params *params);
2495 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2496 u8 key_index, bool pairwise, const u8 *mac_addr,
2498 void (*callback)(void *cookie, struct key_params*));
2499 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2500 u8 key_index, bool pairwise, const u8 *mac_addr);
2501 int (*set_default_key)(struct wiphy *wiphy,
2502 struct net_device *netdev,
2503 u8 key_index, bool unicast, bool multicast);
2504 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2505 struct net_device *netdev,
2508 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2509 struct cfg80211_ap_settings *settings);
2510 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2511 struct cfg80211_beacon_data *info);
2512 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2515 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2517 struct station_parameters *params);
2518 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2519 struct station_del_parameters *params);
2520 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2522 struct station_parameters *params);
2523 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2524 const u8 *mac, struct station_info *sinfo);
2525 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2526 int idx, u8 *mac, struct station_info *sinfo);
2528 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2529 const u8 *dst, const u8 *next_hop);
2530 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2532 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2533 const u8 *dst, const u8 *next_hop);
2534 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2535 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2536 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2537 int idx, u8 *dst, u8 *next_hop,
2538 struct mpath_info *pinfo);
2539 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2540 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2541 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2542 int idx, u8 *dst, u8 *mpp,
2543 struct mpath_info *pinfo);
2544 int (*get_mesh_config)(struct wiphy *wiphy,
2545 struct net_device *dev,
2546 struct mesh_config *conf);
2547 int (*update_mesh_config)(struct wiphy *wiphy,
2548 struct net_device *dev, u32 mask,
2549 const struct mesh_config *nconf);
2550 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2551 const struct mesh_config *conf,
2552 const struct mesh_setup *setup);
2553 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2555 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2556 struct ocb_setup *setup);
2557 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2559 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2560 struct bss_parameters *params);
2562 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2563 struct ieee80211_txq_params *params);
2565 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2566 struct net_device *dev,
2567 struct ieee80211_channel *chan);
2569 int (*set_monitor_channel)(struct wiphy *wiphy,
2570 struct cfg80211_chan_def *chandef);
2572 int (*scan)(struct wiphy *wiphy,
2573 struct cfg80211_scan_request *request);
2575 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2576 struct cfg80211_auth_request *req);
2577 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2578 struct cfg80211_assoc_request *req);
2579 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2580 struct cfg80211_deauth_request *req);
2581 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2582 struct cfg80211_disassoc_request *req);
2584 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2585 struct cfg80211_connect_params *sme);
2586 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2589 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2590 struct cfg80211_ibss_params *params);
2591 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2593 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2594 int rate[IEEE80211_NUM_BANDS]);
2596 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2598 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2599 enum nl80211_tx_power_setting type, int mbm);
2600 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2603 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2606 void (*rfkill_poll)(struct wiphy *wiphy);
2608 #ifdef CONFIG_NL80211_TESTMODE
2609 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2610 void *data, int len);
2611 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2612 struct netlink_callback *cb,
2613 void *data, int len);
2616 int (*set_bitrate_mask)(struct wiphy *wiphy,
2617 struct net_device *dev,
2619 const struct cfg80211_bitrate_mask *mask);
2621 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2622 int idx, struct survey_info *info);
2624 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2625 struct cfg80211_pmksa *pmksa);
2626 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2627 struct cfg80211_pmksa *pmksa);
2628 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2630 int (*remain_on_channel)(struct wiphy *wiphy,
2631 struct wireless_dev *wdev,
2632 struct ieee80211_channel *chan,
2633 unsigned int duration,
2635 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2636 struct wireless_dev *wdev,
2639 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2640 struct cfg80211_mgmt_tx_params *params,
2642 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2643 struct wireless_dev *wdev,
2646 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2647 bool enabled, int timeout);
2649 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2650 struct net_device *dev,
2651 s32 rssi_thold, u32 rssi_hyst);
2653 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2654 struct net_device *dev,
2655 u32 rate, u32 pkts, u32 intvl);
2657 void (*mgmt_frame_register)(struct wiphy *wiphy,
2658 struct wireless_dev *wdev,
2659 u16 frame_type, bool reg);
2661 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2662 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2664 int (*sched_scan_start)(struct wiphy *wiphy,
2665 struct net_device *dev,
2666 struct cfg80211_sched_scan_request *request);
2667 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2669 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2670 struct cfg80211_gtk_rekey_data *data);
2672 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2673 const u8 *peer, u8 action_code, u8 dialog_token,
2674 u16 status_code, u32 peer_capability,
2675 bool initiator, const u8 *buf, size_t len);
2676 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2677 const u8 *peer, enum nl80211_tdls_operation oper);
2679 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2680 const u8 *peer, u64 *cookie);
2682 int (*set_noack_map)(struct wiphy *wiphy,
2683 struct net_device *dev,
2686 int (*get_channel)(struct wiphy *wiphy,
2687 struct wireless_dev *wdev,
2688 struct cfg80211_chan_def *chandef);
2690 int (*start_p2p_device)(struct wiphy *wiphy,
2691 struct wireless_dev *wdev);
2692 void (*stop_p2p_device)(struct wiphy *wiphy,
2693 struct wireless_dev *wdev);
2695 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2696 const struct cfg80211_acl_data *params);
2698 int (*start_radar_detection)(struct wiphy *wiphy,
2699 struct net_device *dev,
2700 struct cfg80211_chan_def *chandef,
2702 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2703 struct cfg80211_update_ft_ies_params *ftie);
2704 int (*crit_proto_start)(struct wiphy *wiphy,
2705 struct wireless_dev *wdev,
2706 enum nl80211_crit_proto_id protocol,
2708 void (*crit_proto_stop)(struct wiphy *wiphy,
2709 struct wireless_dev *wdev);
2710 int (*set_coalesce)(struct wiphy *wiphy,
2711 struct cfg80211_coalesce *coalesce);
2713 int (*channel_switch)(struct wiphy *wiphy,
2714 struct net_device *dev,
2715 struct cfg80211_csa_settings *params);
2717 int (*set_qos_map)(struct wiphy *wiphy,
2718 struct net_device *dev,
2719 struct cfg80211_qos_map *qos_map);
2721 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2722 struct cfg80211_chan_def *chandef);
2724 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2725 u8 tsid, const u8 *peer, u8 user_prio,
2727 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2728 u8 tsid, const u8 *peer);
2730 int (*tdls_channel_switch)(struct wiphy *wiphy,
2731 struct net_device *dev,
2732 const u8 *addr, u8 oper_class,
2733 struct cfg80211_chan_def *chandef);
2734 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2735 struct net_device *dev,
2740 * wireless hardware and networking interfaces structures
2741 * and registration/helper functions
2745 * enum wiphy_flags - wiphy capability flags
2747 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2749 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2750 * by default -- this flag will be set depending on the kernel's default
2751 * on wiphy_new(), but can be changed by the driver if it has a good
2752 * reason to override the default
2753 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2754 * on a VLAN interface)
2755 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2756 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2757 * control port protocol ethertype. The device also honours the
2758 * control_port_no_encrypt flag.
2759 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2760 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2761 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2762 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2763 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2765 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2766 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2767 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2768 * link setup/discovery operations internally. Setup, discovery and
2769 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2770 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2771 * used for asking the driver/firmware to perform a TDLS operation.
2772 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2773 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2774 * when there are virtual interfaces in AP mode by calling
2775 * cfg80211_report_obss_beacon().
2776 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2777 * responds to probe-requests in hardware.
2778 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2779 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2780 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2781 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2782 * beaconing mode (AP, IBSS, Mesh, ...).
2788 WIPHY_FLAG_NETNS_OK = BIT(3),
2789 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2790 WIPHY_FLAG_4ADDR_AP = BIT(5),
2791 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2792 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2793 WIPHY_FLAG_IBSS_RSN = BIT(8),
2794 WIPHY_FLAG_MESH_AUTH = BIT(10),
2795 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2796 /* use hole at 12 */
2797 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2798 WIPHY_FLAG_AP_UAPSD = BIT(14),
2799 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2800 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2801 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2802 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2803 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2804 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2805 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2806 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2807 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2811 * struct ieee80211_iface_limit - limit on certain interface types
2812 * @max: maximum number of interfaces of these types
2813 * @types: interface types (bits)
2815 struct ieee80211_iface_limit {
2821 * struct ieee80211_iface_combination - possible interface combination
2822 * @limits: limits for the given interface types
2823 * @n_limits: number of limitations
2824 * @num_different_channels: can use up to this many different channels
2825 * @max_interfaces: maximum number of interfaces in total allowed in this
2827 * @beacon_int_infra_match: In this combination, the beacon intervals
2828 * between infrastructure and AP types must match. This is required
2829 * only in special cases.
2830 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2831 * @radar_detect_regions: bitmap of regions supported for radar detection
2833 * With this structure the driver can describe which interface
2834 * combinations it supports concurrently.
2838 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2840 * struct ieee80211_iface_limit limits1[] = {
2841 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2842 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2844 * struct ieee80211_iface_combination combination1 = {
2845 * .limits = limits1,
2846 * .n_limits = ARRAY_SIZE(limits1),
2847 * .max_interfaces = 2,
2848 * .beacon_int_infra_match = true,
2852 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2854 * struct ieee80211_iface_limit limits2[] = {
2855 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2856 * BIT(NL80211_IFTYPE_P2P_GO), },
2858 * struct ieee80211_iface_combination combination2 = {
2859 * .limits = limits2,
2860 * .n_limits = ARRAY_SIZE(limits2),
2861 * .max_interfaces = 8,
2862 * .num_different_channels = 1,
2866 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2868 * This allows for an infrastructure connection and three P2P connections.
2870 * struct ieee80211_iface_limit limits3[] = {
2871 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2872 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2873 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2875 * struct ieee80211_iface_combination combination3 = {
2876 * .limits = limits3,
2877 * .n_limits = ARRAY_SIZE(limits3),
2878 * .max_interfaces = 4,
2879 * .num_different_channels = 2,
2882 struct ieee80211_iface_combination {
2883 const struct ieee80211_iface_limit *limits;
2884 u32 num_different_channels;
2887 bool beacon_int_infra_match;
2888 u8 radar_detect_widths;
2889 u8 radar_detect_regions;
2892 struct ieee80211_txrx_stypes {
2897 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2898 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2899 * trigger that keeps the device operating as-is and
2900 * wakes up the host on any activity, for example a
2901 * received packet that passed filtering; note that the
2902 * packet should be preserved in that case
2903 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2905 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2906 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2907 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2908 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2909 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2910 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2911 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
2913 enum wiphy_wowlan_support_flags {
2914 WIPHY_WOWLAN_ANY = BIT(0),
2915 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2916 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2917 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2918 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2919 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2920 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2921 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2922 WIPHY_WOWLAN_NET_DETECT = BIT(8),
2925 struct wiphy_wowlan_tcp_support {
2926 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2927 u32 data_payload_max;
2928 u32 data_interval_max;
2929 u32 wake_payload_max;
2934 * struct wiphy_wowlan_support - WoWLAN support data
2935 * @flags: see &enum wiphy_wowlan_support_flags
2936 * @n_patterns: number of supported wakeup patterns
2937 * (see nl80211.h for the pattern definition)
2938 * @pattern_max_len: maximum length of each pattern
2939 * @pattern_min_len: minimum length of each pattern
2940 * @max_pkt_offset: maximum Rx packet offset
2941 * @max_nd_match_sets: maximum number of matchsets for net-detect,
2942 * similar, but not necessarily identical, to max_match_sets for
2944 * See &struct cfg80211_sched_scan_request.@match_sets for more
2946 * @tcp: TCP wakeup support information
2948 struct wiphy_wowlan_support {
2951 int pattern_max_len;
2952 int pattern_min_len;
2954 int max_nd_match_sets;
2955 const struct wiphy_wowlan_tcp_support *tcp;
2959 * struct wiphy_coalesce_support - coalesce support data
2960 * @n_rules: maximum number of coalesce rules
2961 * @max_delay: maximum supported coalescing delay in msecs
2962 * @n_patterns: number of supported patterns in a rule
2963 * (see nl80211.h for the pattern definition)
2964 * @pattern_max_len: maximum length of each pattern
2965 * @pattern_min_len: minimum length of each pattern
2966 * @max_pkt_offset: maximum Rx packet offset
2968 struct wiphy_coalesce_support {
2972 int pattern_max_len;
2973 int pattern_min_len;
2978 * enum wiphy_vendor_command_flags - validation flags for vendor commands
2979 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
2980 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
2981 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
2982 * (must be combined with %_WDEV or %_NETDEV)
2984 enum wiphy_vendor_command_flags {
2985 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
2986 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
2987 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
2991 * struct wiphy_vendor_command - vendor command definition
2992 * @info: vendor command identifying information, as used in nl80211
2993 * @flags: flags, see &enum wiphy_vendor_command_flags
2994 * @doit: callback for the operation, note that wdev is %NULL if the
2995 * flags didn't ask for a wdev and non-%NULL otherwise; the data
2996 * pointer may be %NULL if userspace provided no data at all
2997 * @dumpit: dump callback, for transferring bigger/multiple items. The
2998 * @storage points to cb->args[5], ie. is preserved over the multiple
3000 * It's recommended to not have the same sub command with both @doit and
3001 * @dumpit, so that userspace can assume certain ones are get and others
3002 * are used with dump requests.
3004 struct wiphy_vendor_command {
3005 struct nl80211_vendor_cmd_info info;
3007 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3008 const void *data, int data_len);
3009 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3010 struct sk_buff *skb, const void *data, int data_len,
3011 unsigned long *storage);
3015 * struct wiphy - wireless hardware description
3016 * @reg_notifier: the driver's regulatory notification callback,
3017 * note that if your driver uses wiphy_apply_custom_regulatory()
3018 * the reg_notifier's request can be passed as NULL
3019 * @regd: the driver's regulatory domain, if one was requested via
3020 * the regulatory_hint() API. This can be used by the driver
3021 * on the reg_notifier() if it chooses to ignore future
3022 * regulatory domain changes caused by other drivers.
3023 * @signal_type: signal type reported in &struct cfg80211_bss.
3024 * @cipher_suites: supported cipher suites
3025 * @n_cipher_suites: number of supported cipher suites
3026 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3027 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3028 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3029 * -1 = fragmentation disabled, only odd values >= 256 used
3030 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3031 * @_net: the network namespace this wiphy currently lives in
3032 * @perm_addr: permanent MAC address of this device
3033 * @addr_mask: If the device supports multiple MAC addresses by masking,
3034 * set this to a mask with variable bits set to 1, e.g. if the last
3035 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3036 * variable bits shall be determined by the interfaces added, with
3037 * interfaces not matching the mask being rejected to be brought up.
3038 * @n_addresses: number of addresses in @addresses.
3039 * @addresses: If the device has more than one address, set this pointer
3040 * to a list of addresses (6 bytes each). The first one will be used
3041 * by default for perm_addr. In this case, the mask should be set to
3042 * all-zeroes. In this case it is assumed that the device can handle
3043 * the same number of arbitrary MAC addresses.
3044 * @registered: protects ->resume and ->suspend sysfs callbacks against
3045 * unregister hardware
3046 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3047 * automatically on wiphy renames
3048 * @dev: (virtual) struct device for this wiphy
3049 * @registered: helps synchronize suspend/resume with wiphy unregister
3050 * @wext: wireless extension handlers
3051 * @priv: driver private data (sized according to wiphy_new() parameter)
3052 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3053 * must be set by driver
3054 * @iface_combinations: Valid interface combinations array, should not
3055 * list single interface types.
3056 * @n_iface_combinations: number of entries in @iface_combinations array.
3057 * @software_iftypes: bitmask of software interface types, these are not
3058 * subject to any restrictions since they are purely managed in SW.
3059 * @flags: wiphy flags, see &enum wiphy_flags
3060 * @regulatory_flags: wiphy regulatory flags, see
3061 * &enum ieee80211_regulatory_flags
3062 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3063 * @ext_features: extended features advertised to nl80211, see
3064 * &enum nl80211_ext_feature_index.
3065 * @bss_priv_size: each BSS struct has private data allocated with it,
3066 * this variable determines its size
3067 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3069 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3070 * for in any given scheduled scan
3071 * @max_match_sets: maximum number of match sets the device can handle
3072 * when performing a scheduled scan, 0 if filtering is not
3074 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3075 * add to probe request frames transmitted during a scan, must not
3076 * include fixed IEs like supported rates
3077 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3079 * @coverage_class: current coverage class
3080 * @fw_version: firmware version for ethtool reporting
3081 * @hw_version: hardware version for ethtool reporting
3082 * @max_num_pmkids: maximum number of PMKIDs supported by device
3083 * @privid: a pointer that drivers can use to identify if an arbitrary
3084 * wiphy is theirs, e.g. in global notifiers
3085 * @bands: information about bands/channels supported by this device
3087 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3088 * transmitted through nl80211, points to an array indexed by interface
3091 * @available_antennas_tx: bitmap of antennas which are available to be
3092 * configured as TX antennas. Antenna configuration commands will be
3093 * rejected unless this or @available_antennas_rx is set.
3095 * @available_antennas_rx: bitmap of antennas which are available to be
3096 * configured as RX antennas. Antenna configuration commands will be
3097 * rejected unless this or @available_antennas_tx is set.
3099 * @probe_resp_offload:
3100 * Bitmap of supported protocols for probe response offloading.
3101 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3102 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3104 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3105 * may request, if implemented.
3107 * @wowlan: WoWLAN support information
3108 * @wowlan_config: current WoWLAN configuration; this should usually not be
3109 * used since access to it is necessarily racy, use the parameter passed
3110 * to the suspend() operation instead.
3112 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3113 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3114 * If null, then none can be over-ridden.
3115 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3116 * If null, then none can be over-ridden.
3118 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3121 * @extended_capabilities: extended capabilities supported by the driver,
3122 * additional capabilities might be supported by userspace; these are
3123 * the 802.11 extended capabilities ("Extended Capabilities element")
3124 * and are in the same format as in the information element. See
3125 * 802.11-2012 8.4.2.29 for the defined fields.
3126 * @extended_capabilities_mask: mask of the valid values
3127 * @extended_capabilities_len: length of the extended capabilities
3128 * @coalesce: packet coalescing support information
3130 * @vendor_commands: array of vendor commands supported by the hardware
3131 * @n_vendor_commands: number of vendor commands
3132 * @vendor_events: array of vendor events supported by the hardware
3133 * @n_vendor_events: number of vendor events
3135 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3136 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3137 * driver is allowed to advertise a theoretical limit that it can reach in
3138 * some cases, but may not always reach.
3140 * @max_num_csa_counters: Number of supported csa_counters in beacons
3141 * and probe responses. This value should be set if the driver
3142 * wishes to limit the number of csa counters. Default (0) means
3144 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3145 * frame was sent and the channel on which the frame was heard for which
3146 * the reported rssi is still valid. If a driver is able to compensate the
3147 * low rssi when a frame is heard on different channel, then it should set
3148 * this variable to the maximal offset for which it can compensate.
3149 * This value should be set in MHz.
3152 /* assign these fields before you register the wiphy */
3154 /* permanent MAC address(es) */
3155 u8 perm_addr[ETH_ALEN];
3156 u8 addr_mask[ETH_ALEN];
3158 struct mac_address *addresses;
3160 const struct ieee80211_txrx_stypes *mgmt_stypes;
3162 const struct ieee80211_iface_combination *iface_combinations;
3163 int n_iface_combinations;
3164 u16 software_iftypes;
3168 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3169 u16 interface_modes;
3171 u16 max_acl_mac_addrs;
3173 u32 flags, regulatory_flags, features;
3174 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3178 enum cfg80211_signal_type signal_type;
3182 u8 max_sched_scan_ssids;
3184 u16 max_scan_ie_len;
3185 u16 max_sched_scan_ie_len;
3187 int n_cipher_suites;
3188 const u32 *cipher_suites;
3196 char fw_version[ETHTOOL_FWVERS_LEN];
3200 const struct wiphy_wowlan_support *wowlan;
3201 struct cfg80211_wowlan *wowlan_config;
3204 u16 max_remain_on_channel_duration;
3208 u32 available_antennas_tx;
3209 u32 available_antennas_rx;
3212 * Bitmap of supported protocols for probe response offloading
3213 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3214 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3216 u32 probe_resp_offload;
3218 const u8 *extended_capabilities, *extended_capabilities_mask;
3219 u8 extended_capabilities_len;
3221 /* If multiple wiphys are registered and you're handed e.g.
3222 * a regular netdev with assigned ieee80211_ptr, you won't
3223 * know whether it points to a wiphy your driver has registered
3224 * or not. Assign this to something global to your driver to
3225 * help determine whether you own this wiphy or not. */
3228 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
3230 /* Lets us get back the wiphy on the callback */
3231 void (*reg_notifier)(struct wiphy *wiphy,
3232 struct regulatory_request *request);
3234 /* fields below are read-only, assigned by cfg80211 */
3236 const struct ieee80211_regdomain __rcu *regd;
3238 /* the item in /sys/class/ieee80211/ points to this,
3239 * you need use set_wiphy_dev() (see below) */
3242 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3245 /* dir in debugfs: ieee80211/<wiphyname> */
3246 struct dentry *debugfsdir;
3248 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3249 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3251 /* the network namespace this phy lives in currently */
3252 possible_net_t _net;
3254 #ifdef CONFIG_CFG80211_WEXT
3255 const struct iw_handler_def *wext;
3258 const struct wiphy_coalesce_support *coalesce;
3260 const struct wiphy_vendor_command *vendor_commands;
3261 const struct nl80211_vendor_cmd_info *vendor_events;
3262 int n_vendor_commands, n_vendor_events;
3264 u16 max_ap_assoc_sta;
3266 u8 max_num_csa_counters;
3267 u8 max_adj_channel_rssi_comp;
3269 char priv[0] __aligned(NETDEV_ALIGN);
3272 static inline struct net *wiphy_net(struct wiphy *wiphy)
3274 return read_pnet(&wiphy->_net);
3277 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3279 write_pnet(&wiphy->_net, net);
3283 * wiphy_priv - return priv from wiphy
3285 * @wiphy: the wiphy whose priv pointer to return
3286 * Return: The priv of @wiphy.
3288 static inline void *wiphy_priv(struct wiphy *wiphy)
3291 return &wiphy->priv;
3295 * priv_to_wiphy - return the wiphy containing the priv
3297 * @priv: a pointer previously returned by wiphy_priv
3298 * Return: The wiphy of @priv.
3300 static inline struct wiphy *priv_to_wiphy(void *priv)
3303 return container_of(priv, struct wiphy, priv);
3307 * set_wiphy_dev - set device pointer for wiphy
3309 * @wiphy: The wiphy whose device to bind
3310 * @dev: The device to parent it to
3312 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3314 wiphy->dev.parent = dev;
3318 * wiphy_dev - get wiphy dev pointer
3320 * @wiphy: The wiphy whose device struct to look up
3321 * Return: The dev of @wiphy.
3323 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3325 return wiphy->dev.parent;
3329 * wiphy_name - get wiphy name
3331 * @wiphy: The wiphy whose name to return
3332 * Return: The name of @wiphy.
3334 static inline const char *wiphy_name(const struct wiphy *wiphy)
3336 return dev_name(&wiphy->dev);
3340 * wiphy_new_nm - create a new wiphy for use with cfg80211
3342 * @ops: The configuration operations for this device
3343 * @sizeof_priv: The size of the private area to allocate
3344 * @requested_name: Request a particular name.
3345 * NULL is valid value, and means use the default phy%d naming.
3347 * Create a new wiphy and associate the given operations with it.
3348 * @sizeof_priv bytes are allocated for private use.
3350 * Return: A pointer to the new wiphy. This pointer must be
3351 * assigned to each netdev's ieee80211_ptr for proper operation.
3353 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3354 const char *requested_name);
3357 * wiphy_new - create a new wiphy for use with cfg80211
3359 * @ops: The configuration operations for this device
3360 * @sizeof_priv: The size of the private area to allocate
3362 * Create a new wiphy and associate the given operations with it.
3363 * @sizeof_priv bytes are allocated for private use.
3365 * Return: A pointer to the new wiphy. This pointer must be
3366 * assigned to each netdev's ieee80211_ptr for proper operation.
3368 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3371 return wiphy_new_nm(ops, sizeof_priv, NULL);
3375 * wiphy_register - register a wiphy with cfg80211
3377 * @wiphy: The wiphy to register.
3379 * Return: A non-negative wiphy index or a negative error code.
3381 int wiphy_register(struct wiphy *wiphy);
3384 * wiphy_unregister - deregister a wiphy from cfg80211
3386 * @wiphy: The wiphy to unregister.
3388 * After this call, no more requests can be made with this priv
3389 * pointer, but the call may sleep to wait for an outstanding
3390 * request that is being handled.
3392 void wiphy_unregister(struct wiphy *wiphy);
3395 * wiphy_free - free wiphy
3397 * @wiphy: The wiphy to free
3399 void wiphy_free(struct wiphy *wiphy);
3401 /* internal structs */
3402 struct cfg80211_conn;
3403 struct cfg80211_internal_bss;
3404 struct cfg80211_cached_keys;
3407 * struct wireless_dev - wireless device state
3409 * For netdevs, this structure must be allocated by the driver
3410 * that uses the ieee80211_ptr field in struct net_device (this
3411 * is intentional so it can be allocated along with the netdev.)
3412 * It need not be registered then as netdev registration will
3413 * be intercepted by cfg80211 to see the new wireless device.
3415 * For non-netdev uses, it must also be allocated by the driver
3416 * in response to the cfg80211 callbacks that require it, as
3417 * there's no netdev registration in that case it may not be
3418 * allocated outside of callback operations that return it.
3420 * @wiphy: pointer to hardware description
3421 * @iftype: interface type
3422 * @list: (private) Used to collect the interfaces
3423 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3424 * @identifier: (private) Identifier used in nl80211 to identify this
3425 * wireless device if it has no netdev
3426 * @current_bss: (private) Used by the internal configuration code
3427 * @chandef: (private) Used by the internal configuration code to track
3428 * the user-set channel definition.
3429 * @preset_chandef: (private) Used by the internal configuration code to
3430 * track the channel to be used for AP later
3431 * @bssid: (private) Used by the internal configuration code
3432 * @ssid: (private) Used by the internal configuration code
3433 * @ssid_len: (private) Used by the internal configuration code
3434 * @mesh_id_len: (private) Used by the internal configuration code
3435 * @mesh_id_up_len: (private) Used by the internal configuration code
3436 * @wext: (private) Used by the internal wireless extensions compat code
3437 * @use_4addr: indicates 4addr mode is used on this interface, must be
3438 * set by driver (if supported) on add_interface BEFORE registering the
3439 * netdev and may otherwise be used by driver read-only, will be update
3440 * by cfg80211 on change_interface
3441 * @mgmt_registrations: list of registrations for management frames
3442 * @mgmt_registrations_lock: lock for the list
3443 * @mtx: mutex used to lock data in this struct, may be used by drivers
3444 * and some API functions require it held
3445 * @beacon_interval: beacon interval used on this device for transmitting
3446 * beacons, 0 when not valid
3447 * @address: The address for this device, valid only if @netdev is %NULL
3448 * @p2p_started: true if this is a P2P Device that has been started
3449 * @cac_started: true if DFS channel availability check has been started
3450 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3451 * @cac_time_ms: CAC time in ms
3452 * @ps: powersave mode is enabled
3453 * @ps_timeout: dynamic powersave timeout
3454 * @ap_unexpected_nlportid: (private) netlink port ID of application
3455 * registered for unexpected class 3 frames (AP mode)
3456 * @conn: (private) cfg80211 software SME connection state machine data
3457 * @connect_keys: (private) keys to set after connection is established
3458 * @ibss_fixed: (private) IBSS is using fixed BSSID
3459 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3460 * @event_list: (private) list for internal event processing
3461 * @event_lock: (private) lock for event list
3462 * @owner_nlportid: (private) owner socket port ID
3464 struct wireless_dev {
3465 struct wiphy *wiphy;
3466 enum nl80211_iftype iftype;
3468 /* the remainder of this struct should be private to cfg80211 */
3469 struct list_head list;
3470 struct net_device *netdev;
3474 struct list_head mgmt_registrations;
3475 spinlock_t mgmt_registrations_lock;
3479 bool use_4addr, p2p_started;
3481 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3483 /* currently used for IBSS and SME - might be rearranged later */
3484 u8 ssid[IEEE80211_MAX_SSID_LEN];
3485 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3486 struct cfg80211_conn *conn;
3487 struct cfg80211_cached_keys *connect_keys;
3489 struct list_head event_list;
3490 spinlock_t event_lock;
3492 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3493 struct cfg80211_chan_def preset_chandef;
3494 struct cfg80211_chan_def chandef;
3497 bool ibss_dfs_possible;
3502 int beacon_interval;
3504 u32 ap_unexpected_nlportid;
3507 unsigned long cac_start_time;
3508 unsigned int cac_time_ms;
3512 #ifdef CONFIG_CFG80211_WEXT
3515 struct cfg80211_ibss_params ibss;
3516 struct cfg80211_connect_params connect;
3517 struct cfg80211_cached_keys *keys;
3520 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3521 u8 ssid[IEEE80211_MAX_SSID_LEN];
3522 s8 default_key, default_mgmt_key;
3523 bool prev_bssid_valid;
3528 static inline u8 *wdev_address(struct wireless_dev *wdev)
3531 return wdev->netdev->dev_addr;
3532 return wdev->address;
3536 * wdev_priv - return wiphy priv from wireless_dev
3538 * @wdev: The wireless device whose wiphy's priv pointer to return
3539 * Return: The wiphy priv of @wdev.
3541 static inline void *wdev_priv(struct wireless_dev *wdev)
3544 return wiphy_priv(wdev->wiphy);
3548 * DOC: Utility functions
3550 * cfg80211 offers a number of utility functions that can be useful.
3554 * ieee80211_channel_to_frequency - convert channel number to frequency
3555 * @chan: channel number
3556 * @band: band, necessary due to channel number overlap
3557 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3559 int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3562 * ieee80211_frequency_to_channel - convert frequency to channel number
3563 * @freq: center frequency
3564 * Return: The corresponding channel, or 0 if the conversion failed.
3566 int ieee80211_frequency_to_channel(int freq);
3569 * Name indirection necessary because the ieee80211 code also has
3570 * a function named "ieee80211_get_channel", so if you include
3571 * cfg80211's header file you get cfg80211's version, if you try
3572 * to include both header files you'll (rightfully!) get a symbol
3575 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3578 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3579 * @wiphy: the struct wiphy to get the channel for
3580 * @freq: the center frequency of the channel
3581 * Return: The channel struct from @wiphy at @freq.
3583 static inline struct ieee80211_channel *
3584 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3586 return __ieee80211_get_channel(wiphy, freq);
3590 * ieee80211_get_response_rate - get basic rate for a given rate
3592 * @sband: the band to look for rates in
3593 * @basic_rates: bitmap of basic rates
3594 * @bitrate: the bitrate for which to find the basic rate
3596 * Return: The basic rate corresponding to a given bitrate, that
3597 * is the next lower bitrate contained in the basic rate map,
3598 * which is, for this function, given as a bitmap of indices of
3599 * rates in the band's bitrate table.
3601 struct ieee80211_rate *
3602 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3603 u32 basic_rates, int bitrate);
3606 * ieee80211_mandatory_rates - get mandatory rates for a given band
3607 * @sband: the band to look for rates in
3608 * @scan_width: width of the control channel
3610 * This function returns a bitmap of the mandatory rates for the given
3611 * band, bits are set according to the rate position in the bitrates array.
3613 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3614 enum nl80211_bss_scan_width scan_width);
3617 * Radiotap parsing functions -- for controlled injection support
3619 * Implemented in net/wireless/radiotap.c
3620 * Documentation in Documentation/networking/radiotap-headers.txt
3623 struct radiotap_align_size {
3624 uint8_t align:4, size:4;
3627 struct ieee80211_radiotap_namespace {
3628 const struct radiotap_align_size *align_size;
3634 struct ieee80211_radiotap_vendor_namespaces {
3635 const struct ieee80211_radiotap_namespace *ns;
3640 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3641 * @this_arg_index: index of current arg, valid after each successful call
3642 * to ieee80211_radiotap_iterator_next()
3643 * @this_arg: pointer to current radiotap arg; it is valid after each
3644 * call to ieee80211_radiotap_iterator_next() but also after
3645 * ieee80211_radiotap_iterator_init() where it will point to
3646 * the beginning of the actual data portion
3647 * @this_arg_size: length of the current arg, for convenience
3648 * @current_namespace: pointer to the current namespace definition
3649 * (or internally %NULL if the current namespace is unknown)
3650 * @is_radiotap_ns: indicates whether the current namespace is the default
3651 * radiotap namespace or not
3653 * @_rtheader: pointer to the radiotap header we are walking through
3654 * @_max_length: length of radiotap header in cpu byte ordering
3655 * @_arg_index: next argument index
3656 * @_arg: next argument pointer
3657 * @_next_bitmap: internal pointer to next present u32
3658 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3659 * @_vns: vendor namespace definitions
3660 * @_next_ns_data: beginning of the next namespace's data
3661 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3664 * Describes the radiotap parser state. Fields prefixed with an underscore
3665 * must not be used by users of the parser, only by the parser internally.
3668 struct ieee80211_radiotap_iterator {
3669 struct ieee80211_radiotap_header *_rtheader;
3670 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3671 const struct ieee80211_radiotap_namespace *current_namespace;
3673 unsigned char *_arg, *_next_ns_data;
3674 __le32 *_next_bitmap;
3676 unsigned char *this_arg;
3684 uint32_t _bitmap_shifter;
3689 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3690 struct ieee80211_radiotap_header *radiotap_header,
3692 const struct ieee80211_radiotap_vendor_namespaces *vns);
3695 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3698 extern const unsigned char rfc1042_header[6];
3699 extern const unsigned char bridge_tunnel_header[6];
3702 * ieee80211_get_hdrlen_from_skb - get header length from data
3706 * Given an skb with a raw 802.11 header at the data pointer this function
3707 * returns the 802.11 header length.
3709 * Return: The 802.11 header length in bytes (not including encryption
3710 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3713 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3716 * ieee80211_hdrlen - get header length in bytes from frame control
3717 * @fc: frame control field in little-endian format
3718 * Return: The header length in bytes.
3720 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3723 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3724 * @meshhdr: the mesh extension header, only the flags field
3725 * (first byte) will be accessed
3726 * Return: The length of the extension header, which is always at
3727 * least 6 bytes and at most 18 if address 5 and 6 are present.
3729 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3732 * DOC: Data path helpers
3734 * In addition to generic utilities, cfg80211 also offers
3735 * functions that help implement the data path for devices
3736 * that do not do the 802.11/802.3 conversion on the device.
3740 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3741 * @skb: the 802.11 data frame
3742 * @addr: the device MAC address
3743 * @iftype: the virtual interface type
3744 * Return: 0 on success. Non-zero on error.
3746 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3747 enum nl80211_iftype iftype);
3750 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3751 * @skb: the 802.3 frame
3752 * @addr: the device MAC address
3753 * @iftype: the virtual interface type
3754 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3755 * @qos: build 802.11 QoS data frame
3756 * Return: 0 on success, or a negative error code.
3758 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3759 enum nl80211_iftype iftype, const u8 *bssid,
3763 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3765 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3766 * 802.3 frames. The @list will be empty if the decode fails. The
3767 * @skb is consumed after the function returns.
3769 * @skb: The input IEEE 802.11n A-MSDU frame.
3770 * @list: The output list of 802.3 frames. It must be allocated and
3771 * initialized by by the caller.
3772 * @addr: The device MAC address.
3773 * @iftype: The device interface type.
3774 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3775 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3777 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3778 const u8 *addr, enum nl80211_iftype iftype,
3779 const unsigned int extra_headroom,
3780 bool has_80211_header);
3783 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3784 * @skb: the data frame
3785 * @qos_map: Interworking QoS mapping or %NULL if not in use
3786 * Return: The 802.1p/1d tag.
3788 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3789 struct cfg80211_qos_map *qos_map);
3792 * cfg80211_find_ie - find information element in data
3795 * @ies: data consisting of IEs
3796 * @len: length of data
3798 * Return: %NULL if the element ID could not be found or if
3799 * the element is invalid (claims to be longer than the given
3800 * data), or a pointer to the first byte of the requested
3801 * element, that is the byte containing the element ID.
3803 * Note: There are no checks on the element length other than
3804 * having to fit into the given data.
3806 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3809 * cfg80211_find_vendor_ie - find vendor specific information element in data
3812 * @oui_type: vendor-specific OUI type
3813 * @ies: data consisting of IEs
3814 * @len: length of data
3816 * Return: %NULL if the vendor specific element ID could not be found or if the
3817 * element is invalid (claims to be longer than the given data), or a pointer to
3818 * the first byte of the requested element, that is the byte containing the
3821 * Note: There are no checks on the element length other than having to fit into
3824 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3825 const u8 *ies, int len);
3828 * DOC: Regulatory enforcement infrastructure
3834 * regulatory_hint - driver hint to the wireless core a regulatory domain
3835 * @wiphy: the wireless device giving the hint (used only for reporting
3837 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3838 * should be in. If @rd is set this should be NULL. Note that if you
3839 * set this to NULL you should still set rd->alpha2 to some accepted
3842 * Wireless drivers can use this function to hint to the wireless core
3843 * what it believes should be the current regulatory domain by
3844 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3845 * domain should be in or by providing a completely build regulatory domain.
3846 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3847 * for a regulatory domain structure for the respective country.
3849 * The wiphy must have been registered to cfg80211 prior to this call.
3850 * For cfg80211 drivers this means you must first use wiphy_register(),
3851 * for mac80211 drivers you must first use ieee80211_register_hw().
3853 * Drivers should check the return value, its possible you can get
3856 * Return: 0 on success. -ENOMEM.
3858 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3861 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
3862 * @wiphy: the wireless device we want to process the regulatory domain on
3863 * @rd: the regulatory domain informatoin to use for this wiphy
3865 * Set the regulatory domain information for self-managed wiphys, only they
3866 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
3869 * Return: 0 on success. -EINVAL, -EPERM
3871 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
3872 struct ieee80211_regdomain *rd);
3875 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
3876 * @wiphy: the wireless device we want to process the regulatory domain on
3877 * @rd: the regulatory domain information to use for this wiphy
3879 * This functions requires the RTNL to be held and applies the new regdomain
3880 * synchronously to this wiphy. For more details see
3881 * regulatory_set_wiphy_regd().
3883 * Return: 0 on success. -EINVAL, -EPERM
3885 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
3886 struct ieee80211_regdomain *rd);
3889 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3890 * @wiphy: the wireless device we want to process the regulatory domain on
3891 * @regd: the custom regulatory domain to use for this wiphy
3893 * Drivers can sometimes have custom regulatory domains which do not apply
3894 * to a specific country. Drivers can use this to apply such custom regulatory
3895 * domains. This routine must be called prior to wiphy registration. The
3896 * custom regulatory domain will be trusted completely and as such previous
3897 * default channel settings will be disregarded. If no rule is found for a
3898 * channel on the regulatory domain the channel will be disabled.
3899 * Drivers using this for a wiphy should also set the wiphy flag
3900 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
3901 * that called this helper.
3903 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3904 const struct ieee80211_regdomain *regd);
3907 * freq_reg_info - get regulatory information for the given frequency
3908 * @wiphy: the wiphy for which we want to process this rule for
3909 * @center_freq: Frequency in KHz for which we want regulatory information for
3911 * Use this function to get the regulatory rule for a specific frequency on
3912 * a given wireless device. If the device has a specific regulatory domain
3913 * it wants to follow we respect that unless a country IE has been received
3914 * and processed already.
3916 * Return: A valid pointer, or, when an error occurs, for example if no rule
3917 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3918 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3919 * value will be -ERANGE if we determine the given center_freq does not even
3920 * have a regulatory rule for a frequency range in the center_freq's band.
3921 * See freq_in_rule_band() for our current definition of a band -- this is
3922 * purely subjective and right now it's 802.11 specific.
3924 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3928 * reg_initiator_name - map regulatory request initiator enum to name
3929 * @initiator: the regulatory request initiator
3931 * You can use this to map the regulatory request initiator enum to a
3932 * proper string representation.
3934 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3937 * callbacks for asynchronous cfg80211 methods, notification
3938 * functions and BSS handling helpers
3942 * cfg80211_scan_done - notify that scan finished
3944 * @request: the corresponding scan request
3945 * @aborted: set to true if the scan was aborted for any reason,
3946 * userspace will be notified of that
3948 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3951 * cfg80211_sched_scan_results - notify that new scan results are available
3953 * @wiphy: the wiphy which got scheduled scan results
3955 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3958 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3960 * @wiphy: the wiphy on which the scheduled scan stopped
3962 * The driver can call this function to inform cfg80211 that the
3963 * scheduled scan had to be stopped, for whatever reason. The driver
3964 * is then called back via the sched_scan_stop operation when done.
3966 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3969 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
3971 * @wiphy: the wiphy on which the scheduled scan stopped
3973 * The driver can call this function to inform cfg80211 that the
3974 * scheduled scan had to be stopped, for whatever reason. The driver
3975 * is then called back via the sched_scan_stop operation when done.
3976 * This function should be called with rtnl locked.
3978 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
3981 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
3982 * @wiphy: the wiphy reporting the BSS
3983 * @data: the BSS metadata
3984 * @mgmt: the management frame (probe response or beacon)
3985 * @len: length of the management frame
3986 * @gfp: context flags
3988 * This informs cfg80211 that BSS information was found and
3989 * the BSS should be updated/added.
3991 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3992 * Or %NULL on error.
3994 struct cfg80211_bss * __must_check
3995 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
3996 struct cfg80211_inform_bss *data,
3997 struct ieee80211_mgmt *mgmt, size_t len,
4000 static inline struct cfg80211_bss * __must_check
4001 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4002 struct ieee80211_channel *rx_channel,
4003 enum nl80211_bss_scan_width scan_width,
4004 struct ieee80211_mgmt *mgmt, size_t len,
4005 s32 signal, gfp_t gfp)
4007 struct cfg80211_inform_bss data = {
4009 .scan_width = scan_width,
4013 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4016 static inline struct cfg80211_bss * __must_check
4017 cfg80211_inform_bss_frame(struct wiphy *wiphy,
4018 struct ieee80211_channel *rx_channel,
4019 struct ieee80211_mgmt *mgmt, size_t len,
4020 s32 signal, gfp_t gfp)
4022 struct cfg80211_inform_bss data = {
4024 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4028 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4032 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4033 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4034 * from a beacon or probe response
4035 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4036 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4038 enum cfg80211_bss_frame_type {
4039 CFG80211_BSS_FTYPE_UNKNOWN,
4040 CFG80211_BSS_FTYPE_BEACON,
4041 CFG80211_BSS_FTYPE_PRESP,
4045 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4047 * @wiphy: the wiphy reporting the BSS
4048 * @data: the BSS metadata
4049 * @ftype: frame type (if known)
4050 * @bssid: the BSSID of the BSS
4051 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4052 * @capability: the capability field sent by the peer
4053 * @beacon_interval: the beacon interval announced by the peer
4054 * @ie: additional IEs sent by the peer
4055 * @ielen: length of the additional IEs
4056 * @gfp: context flags
4058 * This informs cfg80211 that BSS information was found and
4059 * the BSS should be updated/added.
4061 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4062 * Or %NULL on error.
4064 struct cfg80211_bss * __must_check
4065 cfg80211_inform_bss_data(struct wiphy *wiphy,
4066 struct cfg80211_inform_bss *data,
4067 enum cfg80211_bss_frame_type ftype,
4068 const u8 *bssid, u64 tsf, u16 capability,
4069 u16 beacon_interval, const u8 *ie, size_t ielen,
4072 static inline struct cfg80211_bss * __must_check
4073 cfg80211_inform_bss_width(struct wiphy *wiphy,
4074 struct ieee80211_channel *rx_channel,
4075 enum nl80211_bss_scan_width scan_width,
4076 enum cfg80211_bss_frame_type ftype,
4077 const u8 *bssid, u64 tsf, u16 capability,
4078 u16 beacon_interval, const u8 *ie, size_t ielen,
4079 s32 signal, gfp_t gfp)
4081 struct cfg80211_inform_bss data = {
4083 .scan_width = scan_width,
4087 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4088 capability, beacon_interval, ie, ielen,
4092 static inline struct cfg80211_bss * __must_check
4093 cfg80211_inform_bss(struct wiphy *wiphy,
4094 struct ieee80211_channel *rx_channel,
4095 enum cfg80211_bss_frame_type ftype,
4096 const u8 *bssid, u64 tsf, u16 capability,
4097 u16 beacon_interval, const u8 *ie, size_t ielen,
4098 s32 signal, gfp_t gfp)
4100 struct cfg80211_inform_bss data = {
4102 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4106 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4107 capability, beacon_interval, ie, ielen,
4111 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4112 struct ieee80211_channel *channel,
4114 const u8 *ssid, size_t ssid_len,
4115 enum ieee80211_bss_type bss_type,
4116 enum ieee80211_privacy);
4117 static inline struct cfg80211_bss *
4118 cfg80211_get_ibss(struct wiphy *wiphy,
4119 struct ieee80211_channel *channel,
4120 const u8 *ssid, size_t ssid_len)
4122 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4123 IEEE80211_BSS_TYPE_IBSS,
4124 IEEE80211_PRIVACY_ANY);
4128 * cfg80211_ref_bss - reference BSS struct
4129 * @wiphy: the wiphy this BSS struct belongs to
4130 * @bss: the BSS struct to reference
4132 * Increments the refcount of the given BSS struct.
4134 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4137 * cfg80211_put_bss - unref BSS struct
4138 * @wiphy: the wiphy this BSS struct belongs to
4139 * @bss: the BSS struct
4141 * Decrements the refcount of the given BSS struct.
4143 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4146 * cfg80211_unlink_bss - unlink BSS from internal data structures
4148 * @bss: the bss to remove
4150 * This function removes the given BSS from the internal data structures
4151 * thereby making it no longer show up in scan results etc. Use this
4152 * function when you detect a BSS is gone. Normally BSSes will also time
4153 * out, so it is not necessary to use this function at all.
4155 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4157 static inline enum nl80211_bss_scan_width
4158 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4160 switch (chandef->width) {
4161 case NL80211_CHAN_WIDTH_5:
4162 return NL80211_BSS_CHAN_WIDTH_5;
4163 case NL80211_CHAN_WIDTH_10:
4164 return NL80211_BSS_CHAN_WIDTH_10;
4166 return NL80211_BSS_CHAN_WIDTH_20;
4171 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4172 * @dev: network device
4173 * @buf: authentication frame (header + body)
4174 * @len: length of the frame data
4176 * This function is called whenever an authentication, disassociation or
4177 * deauthentication frame has been received and processed in station mode.
4178 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4179 * call either this function or cfg80211_auth_timeout().
4180 * After being asked to associate via cfg80211_ops::assoc() the driver must
4181 * call either this function or cfg80211_auth_timeout().
4182 * While connected, the driver must calls this for received and processed
4183 * disassociation and deauthentication frames. If the frame couldn't be used
4184 * because it was unprotected, the driver must call the function
4185 * cfg80211_rx_unprot_mlme_mgmt() instead.
4187 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4189 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4192 * cfg80211_auth_timeout - notification of timed out authentication
4193 * @dev: network device
4194 * @addr: The MAC address of the device with which the authentication timed out
4196 * This function may sleep. The caller must hold the corresponding wdev's
4199 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4202 * cfg80211_rx_assoc_resp - notification of processed association response
4203 * @dev: network device
4204 * @bss: the BSS that association was requested with, ownership of the pointer
4205 * moves to cfg80211 in this call
4206 * @buf: authentication frame (header + body)
4207 * @len: length of the frame data
4208 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4210 * After being asked to associate via cfg80211_ops::assoc() the driver must
4211 * call either this function or cfg80211_auth_timeout().
4213 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4215 void cfg80211_rx_assoc_resp(struct net_device *dev,
4216 struct cfg80211_bss *bss,
4217 const u8 *buf, size_t len,
4221 * cfg80211_assoc_timeout - notification of timed out association
4222 * @dev: network device
4223 * @bss: The BSS entry with which association timed out.
4225 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4227 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4230 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4231 * @dev: network device
4232 * @buf: 802.11 frame (header + body)
4233 * @len: length of the frame data
4235 * This function is called whenever deauthentication has been processed in
4236 * station mode. This includes both received deauthentication frames and
4237 * locally generated ones. This function may sleep. The caller must hold the
4238 * corresponding wdev's mutex.
4240 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4243 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4244 * @dev: network device
4245 * @buf: deauthentication frame (header + body)
4246 * @len: length of the frame data
4248 * This function is called whenever a received deauthentication or dissassoc
4249 * frame has been dropped in station mode because of MFP being used but the
4250 * frame was not protected. This function may sleep.
4252 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4253 const u8 *buf, size_t len);
4256 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4257 * @dev: network device
4258 * @addr: The source MAC address of the frame
4259 * @key_type: The key type that the received frame used
4260 * @key_id: Key identifier (0..3). Can be -1 if missing.
4261 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4262 * @gfp: allocation flags
4264 * This function is called whenever the local MAC detects a MIC failure in a
4265 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4268 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4269 enum nl80211_key_type key_type, int key_id,
4270 const u8 *tsc, gfp_t gfp);
4273 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4275 * @dev: network device
4276 * @bssid: the BSSID of the IBSS joined
4277 * @channel: the channel of the IBSS joined
4278 * @gfp: allocation flags
4280 * This function notifies cfg80211 that the device joined an IBSS or
4281 * switched to a different BSSID. Before this function can be called,
4282 * either a beacon has to have been received from the IBSS, or one of
4283 * the cfg80211_inform_bss{,_frame} functions must have been called
4284 * with the locally generated beacon -- this guarantees that there is
4285 * always a scan result for this IBSS. cfg80211 will handle the rest.
4287 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4288 struct ieee80211_channel *channel, gfp_t gfp);
4291 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4293 * @dev: network device
4294 * @macaddr: the MAC address of the new candidate
4295 * @ie: information elements advertised by the peer candidate
4296 * @ie_len: lenght of the information elements buffer
4297 * @gfp: allocation flags
4299 * This function notifies cfg80211 that the mesh peer candidate has been
4300 * detected, most likely via a beacon or, less likely, via a probe response.
4301 * cfg80211 then sends a notification to userspace.
4303 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4304 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4307 * DOC: RFkill integration
4309 * RFkill integration in cfg80211 is almost invisible to drivers,
4310 * as cfg80211 automatically registers an rfkill instance for each
4311 * wireless device it knows about. Soft kill is also translated
4312 * into disconnecting and turning all interfaces off, drivers are
4313 * expected to turn off the device when all interfaces are down.
4315 * However, devices may have a hard RFkill line, in which case they
4316 * also need to interact with the rfkill subsystem, via cfg80211.
4317 * They can do this with a few helper functions documented here.
4321 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4323 * @blocked: block status
4325 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4328 * wiphy_rfkill_start_polling - start polling rfkill
4331 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4334 * wiphy_rfkill_stop_polling - stop polling rfkill
4337 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4340 * DOC: Vendor commands
4342 * Occasionally, there are special protocol or firmware features that
4343 * can't be implemented very openly. For this and similar cases, the
4344 * vendor command functionality allows implementing the features with
4345 * (typically closed-source) userspace and firmware, using nl80211 as
4346 * the configuration mechanism.
4348 * A driver supporting vendor commands must register them as an array
4349 * in struct wiphy, with handlers for each one, each command has an
4350 * OUI and sub command ID to identify it.
4352 * Note that this feature should not be (ab)used to implement protocol
4353 * features that could openly be shared across drivers. In particular,
4354 * it must never be required to use vendor commands to implement any
4355 * "normal" functionality that higher-level userspace like connection
4356 * managers etc. need.
4359 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4360 enum nl80211_commands cmd,
4361 enum nl80211_attrs attr,
4364 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4365 struct wireless_dev *wdev,
4366 enum nl80211_commands cmd,
4367 enum nl80211_attrs attr,
4368 int vendor_event_idx,
4369 int approxlen, gfp_t gfp);
4371 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4374 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4376 * @approxlen: an upper bound of the length of the data that will
4377 * be put into the skb
4379 * This function allocates and pre-fills an skb for a reply to
4380 * a vendor command. Since it is intended for a reply, calling
4381 * it outside of a vendor command's doit() operation is invalid.
4383 * The returned skb is pre-filled with some identifying data in
4384 * a way that any data that is put into the skb (with skb_put(),
4385 * nla_put() or similar) will end up being within the
4386 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4387 * with the skb is adding data for the corresponding userspace tool
4388 * which can then read that data out of the vendor data attribute.
4389 * You must not modify the skb in any other way.
4391 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4392 * its error code as the result of the doit() operation.
4394 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4396 static inline struct sk_buff *
4397 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4399 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4400 NL80211_ATTR_VENDOR_DATA, approxlen);
4404 * cfg80211_vendor_cmd_reply - send the reply skb
4405 * @skb: The skb, must have been allocated with
4406 * cfg80211_vendor_cmd_alloc_reply_skb()
4408 * Since calling this function will usually be the last thing
4409 * before returning from the vendor command doit() you should
4410 * return the error code. Note that this function consumes the
4411 * skb regardless of the return value.
4413 * Return: An error code or 0 on success.
4415 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4418 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4420 * @wdev: the wireless device
4421 * @event_idx: index of the vendor event in the wiphy's vendor_events
4422 * @approxlen: an upper bound of the length of the data that will
4423 * be put into the skb
4424 * @gfp: allocation flags
4426 * This function allocates and pre-fills an skb for an event on the
4427 * vendor-specific multicast group.
4429 * If wdev != NULL, both the ifindex and identifier of the specified
4430 * wireless device are added to the event message before the vendor data
4433 * When done filling the skb, call cfg80211_vendor_event() with the
4434 * skb to send the event.
4436 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4438 static inline struct sk_buff *
4439 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4440 int approxlen, int event_idx, gfp_t gfp)
4442 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4443 NL80211_ATTR_VENDOR_DATA,
4444 event_idx, approxlen, gfp);
4448 * cfg80211_vendor_event - send the event
4449 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4450 * @gfp: allocation flags
4452 * This function sends the given @skb, which must have been allocated
4453 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4455 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4457 __cfg80211_send_event_skb(skb, gfp);
4460 #ifdef CONFIG_NL80211_TESTMODE
4464 * Test mode is a set of utility functions to allow drivers to
4465 * interact with driver-specific tools to aid, for instance,
4466 * factory programming.
4468 * This chapter describes how drivers interact with it, for more
4469 * information see the nl80211 book's chapter on it.
4473 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4475 * @approxlen: an upper bound of the length of the data that will
4476 * be put into the skb
4478 * This function allocates and pre-fills an skb for a reply to
4479 * the testmode command. Since it is intended for a reply, calling
4480 * it outside of the @testmode_cmd operation is invalid.
4482 * The returned skb is pre-filled with the wiphy index and set up in
4483 * a way that any data that is put into the skb (with skb_put(),
4484 * nla_put() or similar) will end up being within the
4485 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4486 * with the skb is adding data for the corresponding userspace tool
4487 * which can then read that data out of the testdata attribute. You
4488 * must not modify the skb in any other way.
4490 * When done, call cfg80211_testmode_reply() with the skb and return
4491 * its error code as the result of the @testmode_cmd operation.
4493 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4495 static inline struct sk_buff *
4496 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4498 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4499 NL80211_ATTR_TESTDATA, approxlen);
4503 * cfg80211_testmode_reply - send the reply skb
4504 * @skb: The skb, must have been allocated with
4505 * cfg80211_testmode_alloc_reply_skb()
4507 * Since calling this function will usually be the last thing
4508 * before returning from the @testmode_cmd you should return
4509 * the error code. Note that this function consumes the skb
4510 * regardless of the return value.
4512 * Return: An error code or 0 on success.
4514 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4516 return cfg80211_vendor_cmd_reply(skb);
4520 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4522 * @approxlen: an upper bound of the length of the data that will
4523 * be put into the skb
4524 * @gfp: allocation flags
4526 * This function allocates and pre-fills an skb for an event on the
4527 * testmode multicast group.
4529 * The returned skb is set up in the same way as with
4530 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4531 * there, you should simply add data to it that will then end up in the
4532 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4535 * When done filling the skb, call cfg80211_testmode_event() with the
4536 * skb to send the event.
4538 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4540 static inline struct sk_buff *
4541 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4543 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
4544 NL80211_ATTR_TESTDATA, -1,
4549 * cfg80211_testmode_event - send the event
4550 * @skb: The skb, must have been allocated with
4551 * cfg80211_testmode_alloc_event_skb()
4552 * @gfp: allocation flags
4554 * This function sends the given @skb, which must have been allocated
4555 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4558 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4560 __cfg80211_send_event_skb(skb, gfp);
4563 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4564 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4566 #define CFG80211_TESTMODE_CMD(cmd)
4567 #define CFG80211_TESTMODE_DUMP(cmd)
4571 * cfg80211_connect_result - notify cfg80211 of connection result
4573 * @dev: network device
4574 * @bssid: the BSSID of the AP
4575 * @req_ie: association request IEs (maybe be %NULL)
4576 * @req_ie_len: association request IEs length
4577 * @resp_ie: association response IEs (may be %NULL)
4578 * @resp_ie_len: assoc response IEs length
4579 * @status: status code, 0 for successful connection, use
4580 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4581 * the real status code for failures.
4582 * @gfp: allocation flags
4584 * It should be called by the underlying driver whenever connect() has
4587 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4588 const u8 *req_ie, size_t req_ie_len,
4589 const u8 *resp_ie, size_t resp_ie_len,
4590 u16 status, gfp_t gfp);
4593 * cfg80211_roamed - notify cfg80211 of roaming
4595 * @dev: network device
4596 * @channel: the channel of the new AP
4597 * @bssid: the BSSID of the new AP
4598 * @req_ie: association request IEs (maybe be %NULL)
4599 * @req_ie_len: association request IEs length
4600 * @resp_ie: association response IEs (may be %NULL)
4601 * @resp_ie_len: assoc response IEs length
4602 * @gfp: allocation flags
4604 * It should be called by the underlying driver whenever it roamed
4605 * from one AP to another while connected.
4607 void cfg80211_roamed(struct net_device *dev,
4608 struct ieee80211_channel *channel,
4610 const u8 *req_ie, size_t req_ie_len,
4611 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4614 * cfg80211_roamed_bss - notify cfg80211 of roaming
4616 * @dev: network device
4617 * @bss: entry of bss to which STA got roamed
4618 * @req_ie: association request IEs (maybe be %NULL)
4619 * @req_ie_len: association request IEs length
4620 * @resp_ie: association response IEs (may be %NULL)
4621 * @resp_ie_len: assoc response IEs length
4622 * @gfp: allocation flags
4624 * This is just a wrapper to notify cfg80211 of roaming event with driver
4625 * passing bss to avoid a race in timeout of the bss entry. It should be
4626 * called by the underlying driver whenever it roamed from one AP to another
4627 * while connected. Drivers which have roaming implemented in firmware
4628 * may use this function to avoid a race in bss entry timeout where the bss
4629 * entry of the new AP is seen in the driver, but gets timed out by the time
4630 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4631 * rdev->event_work. In case of any failures, the reference is released
4632 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4633 * it will be released while diconneting from the current bss.
4635 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4636 const u8 *req_ie, size_t req_ie_len,
4637 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4640 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4642 * @dev: network device
4643 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4644 * @ie_len: length of IEs
4645 * @reason: reason code for the disconnection, set it to 0 if unknown
4646 * @locally_generated: disconnection was requested locally
4647 * @gfp: allocation flags
4649 * After it calls this function, the driver should enter an idle state
4650 * and not try to connect to any AP any more.
4652 void cfg80211_disconnected(struct net_device *dev, u16 reason,
4653 const u8 *ie, size_t ie_len,
4654 bool locally_generated, gfp_t gfp);
4657 * cfg80211_ready_on_channel - notification of remain_on_channel start
4658 * @wdev: wireless device
4659 * @cookie: the request cookie
4660 * @chan: The current channel (from remain_on_channel request)
4661 * @duration: Duration in milliseconds that the driver intents to remain on the
4663 * @gfp: allocation flags
4665 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4666 struct ieee80211_channel *chan,
4667 unsigned int duration, gfp_t gfp);
4670 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4671 * @wdev: wireless device
4672 * @cookie: the request cookie
4673 * @chan: The current channel (from remain_on_channel request)
4674 * @gfp: allocation flags
4676 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4677 struct ieee80211_channel *chan,
4682 * cfg80211_new_sta - notify userspace about station
4685 * @mac_addr: the station's address
4686 * @sinfo: the station information
4687 * @gfp: allocation flags
4689 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4690 struct station_info *sinfo, gfp_t gfp);
4693 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4695 * @mac_addr: the station's address
4696 * @sinfo: the station information/statistics
4697 * @gfp: allocation flags
4699 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
4700 struct station_info *sinfo, gfp_t gfp);
4703 * cfg80211_del_sta - notify userspace about deletion of a station
4706 * @mac_addr: the station's address
4707 * @gfp: allocation flags
4709 static inline void cfg80211_del_sta(struct net_device *dev,
4710 const u8 *mac_addr, gfp_t gfp)
4712 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
4716 * cfg80211_conn_failed - connection request failed notification
4719 * @mac_addr: the station's address
4720 * @reason: the reason for connection failure
4721 * @gfp: allocation flags
4723 * Whenever a station tries to connect to an AP and if the station
4724 * could not connect to the AP as the AP has rejected the connection
4725 * for some reasons, this function is called.
4727 * The reason for connection failure can be any of the value from
4728 * nl80211_connect_failed_reason enum
4730 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4731 enum nl80211_connect_failed_reason reason,
4735 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4736 * @wdev: wireless device receiving the frame
4737 * @freq: Frequency on which the frame was received in MHz
4738 * @sig_dbm: signal strength in mBm, or 0 if unknown
4739 * @buf: Management frame (header + body)
4740 * @len: length of the frame data
4741 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4743 * This function is called whenever an Action frame is received for a station
4744 * mode interface, but is not processed in kernel.
4746 * Return: %true if a user space application has registered for this frame.
4747 * For action frames, that makes it responsible for rejecting unrecognized
4748 * action frames; %false otherwise, in which case for action frames the
4749 * driver is responsible for rejecting the frame.
4751 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4752 const u8 *buf, size_t len, u32 flags);
4755 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4756 * @wdev: wireless device receiving the frame
4757 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4758 * @buf: Management frame (header + body)
4759 * @len: length of the frame data
4760 * @ack: Whether frame was acknowledged
4761 * @gfp: context flags
4763 * This function is called whenever a management frame was requested to be
4764 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4765 * transmission attempt.
4767 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4768 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4772 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4773 * @dev: network device
4774 * @rssi_event: the triggered RSSI event
4775 * @gfp: context flags
4777 * This function is called when a configured connection quality monitoring
4778 * rssi threshold reached event occurs.
4780 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4781 enum nl80211_cqm_rssi_threshold_event rssi_event,
4785 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4786 * @dev: network device
4787 * @peer: peer's MAC address
4788 * @num_packets: how many packets were lost -- should be a fixed threshold
4789 * but probably no less than maybe 50, or maybe a throughput dependent
4790 * threshold (to account for temporary interference)
4791 * @gfp: context flags
4793 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4794 const u8 *peer, u32 num_packets, gfp_t gfp);
4797 * cfg80211_cqm_txe_notify - TX error rate event
4798 * @dev: network device
4799 * @peer: peer's MAC address
4800 * @num_packets: how many packets were lost
4801 * @rate: % of packets which failed transmission
4802 * @intvl: interval (in s) over which the TX failure threshold was breached.
4803 * @gfp: context flags
4805 * Notify userspace when configured % TX failures over number of packets in a
4806 * given interval is exceeded.
4808 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4809 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4812 * cfg80211_cqm_beacon_loss_notify - beacon loss event
4813 * @dev: network device
4814 * @gfp: context flags
4816 * Notify userspace about beacon loss from the connected AP.
4818 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
4821 * cfg80211_radar_event - radar detection event
4823 * @chandef: chandef for the current channel
4824 * @gfp: context flags
4826 * This function is called when a radar is detected on the current chanenl.
4828 void cfg80211_radar_event(struct wiphy *wiphy,
4829 struct cfg80211_chan_def *chandef, gfp_t gfp);
4832 * cfg80211_cac_event - Channel availability check (CAC) event
4833 * @netdev: network device
4834 * @chandef: chandef for the current channel
4835 * @event: type of event
4836 * @gfp: context flags
4838 * This function is called when a Channel availability check (CAC) is finished
4839 * or aborted. This must be called to notify the completion of a CAC process,
4840 * also by full-MAC drivers.
4842 void cfg80211_cac_event(struct net_device *netdev,
4843 const struct cfg80211_chan_def *chandef,
4844 enum nl80211_radar_event event, gfp_t gfp);
4848 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4849 * @dev: network device
4850 * @bssid: BSSID of AP (to avoid races)
4851 * @replay_ctr: new replay counter
4852 * @gfp: allocation flags
4854 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4855 const u8 *replay_ctr, gfp_t gfp);
4858 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4859 * @dev: network device
4860 * @index: candidate index (the smaller the index, the higher the priority)
4861 * @bssid: BSSID of AP
4862 * @preauth: Whether AP advertises support for RSN pre-authentication
4863 * @gfp: allocation flags
4865 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4866 const u8 *bssid, bool preauth, gfp_t gfp);
4869 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4870 * @dev: The device the frame matched to
4871 * @addr: the transmitter address
4872 * @gfp: context flags
4874 * This function is used in AP mode (only!) to inform userspace that
4875 * a spurious class 3 frame was received, to be able to deauth the
4877 * Return: %true if the frame was passed to userspace (or this failed
4878 * for a reason other than not having a subscription.)
4880 bool cfg80211_rx_spurious_frame(struct net_device *dev,
4881 const u8 *addr, gfp_t gfp);
4884 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4885 * @dev: The device the frame matched to
4886 * @addr: the transmitter address
4887 * @gfp: context flags
4889 * This function is used in AP mode (only!) to inform userspace that
4890 * an associated station sent a 4addr frame but that wasn't expected.
4891 * It is allowed and desirable to send this event only once for each
4892 * station to avoid event flooding.
4893 * Return: %true if the frame was passed to userspace (or this failed
4894 * for a reason other than not having a subscription.)
4896 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4897 const u8 *addr, gfp_t gfp);
4900 * cfg80211_probe_status - notify userspace about probe status
4901 * @dev: the device the probe was sent on
4902 * @addr: the address of the peer
4903 * @cookie: the cookie filled in @probe_client previously
4904 * @acked: indicates whether probe was acked or not
4905 * @gfp: allocation flags
4907 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4908 u64 cookie, bool acked, gfp_t gfp);
4911 * cfg80211_report_obss_beacon - report beacon from other APs
4912 * @wiphy: The wiphy that received the beacon
4914 * @len: length of the frame
4915 * @freq: frequency the frame was received on
4916 * @sig_dbm: signal strength in mBm, or 0 if unknown
4918 * Use this function to report to userspace when a beacon was
4919 * received. It is not useful to call this when there is no
4920 * netdev that is in AP/GO mode.
4922 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4923 const u8 *frame, size_t len,
4924 int freq, int sig_dbm);
4927 * cfg80211_reg_can_beacon - check if beaconing is allowed
4929 * @chandef: the channel definition
4930 * @iftype: interface type
4932 * Return: %true if there is no secondary channel or the secondary channel(s)
4933 * can be used for beaconing (i.e. is not a radar channel etc.)
4935 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4936 struct cfg80211_chan_def *chandef,
4937 enum nl80211_iftype iftype);
4940 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
4942 * @chandef: the channel definition
4943 * @iftype: interface type
4945 * Return: %true if there is no secondary channel or the secondary channel(s)
4946 * can be used for beaconing (i.e. is not a radar channel etc.). This version
4947 * also checks if IR-relaxation conditions apply, to allow beaconing under
4948 * more permissive conditions.
4950 * Requires the RTNL to be held.
4952 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
4953 struct cfg80211_chan_def *chandef,
4954 enum nl80211_iftype iftype);
4957 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4958 * @dev: the device which switched channels
4959 * @chandef: the new channel definition
4961 * Caller must acquire wdev_lock, therefore must only be called from sleepable
4964 void cfg80211_ch_switch_notify(struct net_device *dev,
4965 struct cfg80211_chan_def *chandef);
4968 * cfg80211_ch_switch_started_notify - notify channel switch start
4969 * @dev: the device on which the channel switch started
4970 * @chandef: the future channel definition
4971 * @count: the number of TBTTs until the channel switch happens
4973 * Inform the userspace about the channel switch that has just
4974 * started, so that it can take appropriate actions (eg. starting
4975 * channel switch on other vifs), if necessary.
4977 void cfg80211_ch_switch_started_notify(struct net_device *dev,
4978 struct cfg80211_chan_def *chandef,
4982 * ieee80211_operating_class_to_band - convert operating class to band
4984 * @operating_class: the operating class to convert
4985 * @band: band pointer to fill
4987 * Returns %true if the conversion was successful, %false otherwise.
4989 bool ieee80211_operating_class_to_band(u8 operating_class,
4990 enum ieee80211_band *band);
4993 * ieee80211_chandef_to_operating_class - convert chandef to operation class
4995 * @chandef: the chandef to convert
4996 * @op_class: a pointer to the resulting operating class
4998 * Returns %true if the conversion was successful, %false otherwise.
5000 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5004 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5005 * @dev: the device on which the operation is requested
5006 * @peer: the MAC address of the peer device
5007 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5008 * NL80211_TDLS_TEARDOWN)
5009 * @reason_code: the reason code for teardown request
5010 * @gfp: allocation flags
5012 * This function is used to request userspace to perform TDLS operation that
5013 * requires knowledge of keys, i.e., link setup or teardown when the AP
5014 * connection uses encryption. This is optional mechanism for the driver to use
5015 * if it can automatically determine when a TDLS link could be useful (e.g.,
5016 * based on traffic and signal strength for a peer).
5018 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5019 enum nl80211_tdls_operation oper,
5020 u16 reason_code, gfp_t gfp);
5023 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5024 * @rate: given rate_info to calculate bitrate from
5026 * return 0 if MCS index >= 32
5028 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5031 * cfg80211_unregister_wdev - remove the given wdev
5032 * @wdev: struct wireless_dev to remove
5034 * Call this function only for wdevs that have no netdev assigned,
5035 * e.g. P2P Devices. It removes the device from the list so that
5036 * it can no longer be used. It is necessary to call this function
5037 * even when cfg80211 requests the removal of the interface by
5038 * calling the del_virtual_intf() callback. The function must also
5039 * be called when the driver wishes to unregister the wdev, e.g.
5040 * when the device is unbound from the driver.
5042 * Requires the RTNL to be held.
5044 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5047 * struct cfg80211_ft_event - FT Information Elements
5049 * @ies_len: length of the FT IE in bytes
5050 * @target_ap: target AP's MAC address
5052 * @ric_ies_len: length of the RIC IE in bytes
5054 struct cfg80211_ft_event_params {
5057 const u8 *target_ap;
5063 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5064 * @netdev: network device
5065 * @ft_event: IE information
5067 void cfg80211_ft_event(struct net_device *netdev,
5068 struct cfg80211_ft_event_params *ft_event);
5071 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5072 * @ies: the input IE buffer
5073 * @len: the input length
5074 * @attr: the attribute ID to find
5075 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5076 * if the function is only called to get the needed buffer size
5077 * @bufsize: size of the output buffer
5079 * The function finds a given P2P attribute in the (vendor) IEs and
5080 * copies its contents to the given buffer.
5082 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5083 * malformed or the attribute can't be found (respectively), or the
5084 * length of the found attribute (which can be zero).
5086 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5087 enum ieee80211_p2p_attr_id attr,
5088 u8 *buf, unsigned int bufsize);
5091 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5092 * @ies: the IE buffer
5093 * @ielen: the length of the IE buffer
5094 * @ids: an array with element IDs that are allowed before
5096 * @n_ids: the size of the element ID array
5097 * @after_ric: array IE types that come after the RIC element
5098 * @n_after_ric: size of the @after_ric array
5099 * @offset: offset where to start splitting in the buffer
5101 * This function splits an IE buffer by updating the @offset
5102 * variable to point to the location where the buffer should be
5105 * It assumes that the given IE buffer is well-formed, this
5106 * has to be guaranteed by the caller!
5108 * It also assumes that the IEs in the buffer are ordered
5109 * correctly, if not the result of using this function will not
5110 * be ordered correctly either, i.e. it does no reordering.
5112 * The function returns the offset where the next part of the
5113 * buffer starts, which may be @ielen if the entire (remainder)
5114 * of the buffer should be used.
5116 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5117 const u8 *ids, int n_ids,
5118 const u8 *after_ric, int n_after_ric,
5122 * ieee80211_ie_split - split an IE buffer according to ordering
5123 * @ies: the IE buffer
5124 * @ielen: the length of the IE buffer
5125 * @ids: an array with element IDs that are allowed before
5127 * @n_ids: the size of the element ID array
5128 * @offset: offset where to start splitting in the buffer
5130 * This function splits an IE buffer by updating the @offset
5131 * variable to point to the location where the buffer should be
5134 * It assumes that the given IE buffer is well-formed, this
5135 * has to be guaranteed by the caller!
5137 * It also assumes that the IEs in the buffer are ordered
5138 * correctly, if not the result of using this function will not
5139 * be ordered correctly either, i.e. it does no reordering.
5141 * The function returns the offset where the next part of the
5142 * buffer starts, which may be @ielen if the entire (remainder)
5143 * of the buffer should be used.
5145 size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5146 const u8 *ids, int n_ids, size_t offset);
5149 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5150 * @wdev: the wireless device reporting the wakeup
5151 * @wakeup: the wakeup report
5152 * @gfp: allocation flags
5154 * This function reports that the given device woke up. If it
5155 * caused the wakeup, report the reason(s), otherwise you may
5156 * pass %NULL as the @wakeup parameter to advertise that something
5157 * else caused the wakeup.
5159 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5160 struct cfg80211_wowlan_wakeup *wakeup,
5164 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5166 * @wdev: the wireless device for which critical protocol is stopped.
5167 * @gfp: allocation flags
5169 * This function can be called by the driver to indicate it has reverted
5170 * operation back to normal. One reason could be that the duration given
5171 * by .crit_proto_start() has expired.
5173 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5176 * ieee80211_get_num_supported_channels - get number of channels device has
5179 * Return: the number of channels supported by the device.
5181 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5184 * cfg80211_check_combinations - check interface combinations
5187 * @num_different_channels: the number of different channels we want
5188 * to use for verification
5189 * @radar_detect: a bitmap where each bit corresponds to a channel
5190 * width where radar detection is needed, as in the definition of
5191 * &struct ieee80211_iface_combination.@radar_detect_widths
5192 * @iftype_num: array with the numbers of interfaces of each interface
5193 * type. The index is the interface type as specified in &enum
5196 * This function can be called by the driver to check whether a
5197 * combination of interfaces and their types are allowed according to
5198 * the interface combinations.
5200 int cfg80211_check_combinations(struct wiphy *wiphy,
5201 const int num_different_channels,
5202 const u8 radar_detect,
5203 const int iftype_num[NUM_NL80211_IFTYPES]);
5206 * cfg80211_iter_combinations - iterate over matching combinations
5209 * @num_different_channels: the number of different channels we want
5210 * to use for verification
5211 * @radar_detect: a bitmap where each bit corresponds to a channel
5212 * width where radar detection is needed, as in the definition of
5213 * &struct ieee80211_iface_combination.@radar_detect_widths
5214 * @iftype_num: array with the numbers of interfaces of each interface
5215 * type. The index is the interface type as specified in &enum
5217 * @iter: function to call for each matching combination
5218 * @data: pointer to pass to iter function
5220 * This function can be called by the driver to check what possible
5221 * combinations it fits in at a given moment, e.g. for channel switching
5224 int cfg80211_iter_combinations(struct wiphy *wiphy,
5225 const int num_different_channels,
5226 const u8 radar_detect,
5227 const int iftype_num[NUM_NL80211_IFTYPES],
5228 void (*iter)(const struct ieee80211_iface_combination *c,
5233 * cfg80211_stop_iface - trigger interface disconnection
5236 * @wdev: wireless device
5237 * @gfp: context flags
5239 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5242 * Note: This doesn't need any locks and is asynchronous.
5244 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5248 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5249 * @wiphy: the wiphy to shut down
5251 * This function shuts down all interfaces belonging to this wiphy by
5252 * calling dev_close() (and treating non-netdev interfaces as needed).
5253 * It shouldn't really be used unless there are some fatal device errors
5254 * that really can't be recovered in any other way.
5256 * Callers must hold the RTNL and be able to deal with callbacks into
5257 * the driver while the function is running.
5259 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5262 * wiphy_ext_feature_set - set the extended feature flag
5264 * @wiphy: the wiphy to modify.
5265 * @ftidx: extended feature bit index.
5267 * The extended features are flagged in multiple bytes (see
5268 * &struct wiphy.@ext_features)
5270 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5271 enum nl80211_ext_feature_index ftidx)
5275 ft_byte = &wiphy->ext_features[ftidx / 8];
5276 *ft_byte |= BIT(ftidx % 8);
5280 * wiphy_ext_feature_isset - check the extended feature flag
5282 * @wiphy: the wiphy to modify.
5283 * @ftidx: extended feature bit index.
5285 * The extended features are flagged in multiple bytes (see
5286 * &struct wiphy.@ext_features)
5289 wiphy_ext_feature_isset(struct wiphy *wiphy,
5290 enum nl80211_ext_feature_index ftidx)
5294 ft_byte = wiphy->ext_features[ftidx / 8];
5295 return (ft_byte & BIT(ftidx % 8)) != 0;
5298 /* ethtool helper */
5299 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5301 /* Logging, debugging and troubleshooting/diagnostic helpers. */
5303 /* wiphy_printk helpers, similar to dev_printk */
5305 #define wiphy_printk(level, wiphy, format, args...) \
5306 dev_printk(level, &(wiphy)->dev, format, ##args)
5307 #define wiphy_emerg(wiphy, format, args...) \
5308 dev_emerg(&(wiphy)->dev, format, ##args)
5309 #define wiphy_alert(wiphy, format, args...) \
5310 dev_alert(&(wiphy)->dev, format, ##args)
5311 #define wiphy_crit(wiphy, format, args...) \
5312 dev_crit(&(wiphy)->dev, format, ##args)
5313 #define wiphy_err(wiphy, format, args...) \
5314 dev_err(&(wiphy)->dev, format, ##args)
5315 #define wiphy_warn(wiphy, format, args...) \
5316 dev_warn(&(wiphy)->dev, format, ##args)
5317 #define wiphy_notice(wiphy, format, args...) \
5318 dev_notice(&(wiphy)->dev, format, ##args)
5319 #define wiphy_info(wiphy, format, args...) \
5320 dev_info(&(wiphy)->dev, format, ##args)
5322 #define wiphy_debug(wiphy, format, args...) \
5323 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5325 #define wiphy_dbg(wiphy, format, args...) \
5326 dev_dbg(&(wiphy)->dev, format, ##args)
5328 #if defined(VERBOSE_DEBUG)
5329 #define wiphy_vdbg wiphy_dbg
5331 #define wiphy_vdbg(wiphy, format, args...) \
5334 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5340 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5341 * of using a WARN/WARN_ON to get the message out, including the
5342 * file/line information and a backtrace.
5344 #define wiphy_WARN(wiphy, format, args...) \
5345 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5347 #endif /* __NET_CFG80211_H */