Loading...
1#ifndef __NET_CFG80211_H
2#define __NET_CFG80211_H
3/*
4 * 802.11 device and configuration interface
5 *
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright 2015 Intel Deutschland GmbH
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
13 */
14
15#include <linux/netdevice.h>
16#include <linux/debugfs.h>
17#include <linux/list.h>
18#include <linux/bug.h>
19#include <linux/netlink.h>
20#include <linux/skbuff.h>
21#include <linux/nl80211.h>
22#include <linux/if_ether.h>
23#include <linux/ieee80211.h>
24#include <linux/net.h>
25#include <net/regulatory.h>
26
27/**
28 * DOC: Introduction
29 *
30 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
31 * userspace and drivers, and offers some utility functionality associated
32 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
33 * by all modern wireless drivers in Linux, so that they offer a consistent
34 * API through nl80211. For backward compatibility, cfg80211 also offers
35 * wireless extensions to userspace, but hides them from drivers completely.
36 *
37 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
38 * use restrictions.
39 */
40
41
42/**
43 * DOC: Device registration
44 *
45 * In order for a driver to use cfg80211, it must register the hardware device
46 * with cfg80211. This happens through a number of hardware capability structs
47 * described below.
48 *
49 * The fundamental structure for each device is the 'wiphy', of which each
50 * instance describes a physical wireless device connected to the system. Each
51 * such wiphy can have zero, one, or many virtual interfaces associated with
52 * it, which need to be identified as such by pointing the network interface's
53 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
54 * the wireless part of the interface, normally this struct is embedded in the
55 * network interface's private data area. Drivers can optionally allow creating
56 * or destroying virtual interfaces on the fly, but without at least one or the
57 * ability to create some the wireless device isn't useful.
58 *
59 * Each wiphy structure contains device capability information, and also has
60 * a pointer to the various operations the driver offers. The definitions and
61 * structures here describe these capabilities in detail.
62 */
63
64struct wiphy;
65
66/*
67 * wireless hardware capability structures
68 */
69
70/**
71 * enum ieee80211_band - supported frequency bands
72 *
73 * The bands are assigned this way because the supported
74 * bitrates differ in these bands.
75 *
76 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
77 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
78 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
79 * @IEEE80211_NUM_BANDS: number of defined bands
80 */
81enum ieee80211_band {
82 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
83 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
84 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
85
86 /* keep last */
87 IEEE80211_NUM_BANDS
88};
89
90/**
91 * enum ieee80211_channel_flags - channel flags
92 *
93 * Channel flags set by the regulatory control code.
94 *
95 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
96 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
97 * sending probe requests or beaconing.
98 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
99 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
100 * is not permitted.
101 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
102 * is not permitted.
103 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
104 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
105 * this flag indicates that an 80 MHz channel cannot use this
106 * channel as the control or any of the secondary channels.
107 * This may be due to the driver or due to regulatory bandwidth
108 * restrictions.
109 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
110 * this flag indicates that an 160 MHz channel cannot use this
111 * channel as the control or any of the secondary channels.
112 * This may be due to the driver or due to regulatory bandwidth
113 * restrictions.
114 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
115 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
116 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
117 * on this channel.
118 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
119 * on this channel.
120 *
121 */
122enum ieee80211_channel_flags {
123 IEEE80211_CHAN_DISABLED = 1<<0,
124 IEEE80211_CHAN_NO_IR = 1<<1,
125 /* hole at 1<<2 */
126 IEEE80211_CHAN_RADAR = 1<<3,
127 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
128 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
129 IEEE80211_CHAN_NO_OFDM = 1<<6,
130 IEEE80211_CHAN_NO_80MHZ = 1<<7,
131 IEEE80211_CHAN_NO_160MHZ = 1<<8,
132 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
133 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
134 IEEE80211_CHAN_NO_20MHZ = 1<<11,
135 IEEE80211_CHAN_NO_10MHZ = 1<<12,
136};
137
138#define IEEE80211_CHAN_NO_HT40 \
139 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
140
141#define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
142#define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
143
144/**
145 * struct ieee80211_channel - channel definition
146 *
147 * This structure describes a single channel for use
148 * with cfg80211.
149 *
150 * @center_freq: center frequency in MHz
151 * @hw_value: hardware-specific value for the channel
152 * @flags: channel flags from &enum ieee80211_channel_flags.
153 * @orig_flags: channel flags at registration time, used by regulatory
154 * code to support devices with additional restrictions
155 * @band: band this channel belongs to.
156 * @max_antenna_gain: maximum antenna gain in dBi
157 * @max_power: maximum transmission power (in dBm)
158 * @max_reg_power: maximum regulatory transmission power (in dBm)
159 * @beacon_found: helper to regulatory code to indicate when a beacon
160 * has been found on this channel. Use regulatory_hint_found_beacon()
161 * to enable this, this is useful only on 5 GHz band.
162 * @orig_mag: internal use
163 * @orig_mpwr: internal use
164 * @dfs_state: current state of this channel. Only relevant if radar is required
165 * on this channel.
166 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
167 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
168 */
169struct ieee80211_channel {
170 enum ieee80211_band band;
171 u16 center_freq;
172 u16 hw_value;
173 u32 flags;
174 int max_antenna_gain;
175 int max_power;
176 int max_reg_power;
177 bool beacon_found;
178 u32 orig_flags;
179 int orig_mag, orig_mpwr;
180 enum nl80211_dfs_state dfs_state;
181 unsigned long dfs_state_entered;
182 unsigned int dfs_cac_ms;
183};
184
185/**
186 * enum ieee80211_rate_flags - rate flags
187 *
188 * Hardware/specification flags for rates. These are structured
189 * in a way that allows using the same bitrate structure for
190 * different bands/PHY modes.
191 *
192 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
193 * preamble on this bitrate; only relevant in 2.4GHz band and
194 * with CCK rates.
195 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
196 * when used with 802.11a (on the 5 GHz band); filled by the
197 * core code when registering the wiphy.
198 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
199 * when used with 802.11b (on the 2.4 GHz band); filled by the
200 * core code when registering the wiphy.
201 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
202 * when used with 802.11g (on the 2.4 GHz band); filled by the
203 * core code when registering the wiphy.
204 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
205 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
206 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
207 */
208enum ieee80211_rate_flags {
209 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
210 IEEE80211_RATE_MANDATORY_A = 1<<1,
211 IEEE80211_RATE_MANDATORY_B = 1<<2,
212 IEEE80211_RATE_MANDATORY_G = 1<<3,
213 IEEE80211_RATE_ERP_G = 1<<4,
214 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
215 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
216};
217
218/**
219 * enum ieee80211_bss_type - BSS type filter
220 *
221 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
222 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
223 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
224 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
225 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
226 */
227enum ieee80211_bss_type {
228 IEEE80211_BSS_TYPE_ESS,
229 IEEE80211_BSS_TYPE_PBSS,
230 IEEE80211_BSS_TYPE_IBSS,
231 IEEE80211_BSS_TYPE_MBSS,
232 IEEE80211_BSS_TYPE_ANY
233};
234
235/**
236 * enum ieee80211_privacy - BSS privacy filter
237 *
238 * @IEEE80211_PRIVACY_ON: privacy bit set
239 * @IEEE80211_PRIVACY_OFF: privacy bit clear
240 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
241 */
242enum ieee80211_privacy {
243 IEEE80211_PRIVACY_ON,
244 IEEE80211_PRIVACY_OFF,
245 IEEE80211_PRIVACY_ANY
246};
247
248#define IEEE80211_PRIVACY(x) \
249 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
250
251/**
252 * struct ieee80211_rate - bitrate definition
253 *
254 * This structure describes a bitrate that an 802.11 PHY can
255 * operate with. The two values @hw_value and @hw_value_short
256 * are only for driver use when pointers to this structure are
257 * passed around.
258 *
259 * @flags: rate-specific flags
260 * @bitrate: bitrate in units of 100 Kbps
261 * @hw_value: driver/hardware value for this rate
262 * @hw_value_short: driver/hardware value for this rate when
263 * short preamble is used
264 */
265struct ieee80211_rate {
266 u32 flags;
267 u16 bitrate;
268 u16 hw_value, hw_value_short;
269};
270
271/**
272 * struct ieee80211_sta_ht_cap - STA's HT capabilities
273 *
274 * This structure describes most essential parameters needed
275 * to describe 802.11n HT capabilities for an STA.
276 *
277 * @ht_supported: is HT supported by the STA
278 * @cap: HT capabilities map as described in 802.11n spec
279 * @ampdu_factor: Maximum A-MPDU length factor
280 * @ampdu_density: Minimum A-MPDU spacing
281 * @mcs: Supported MCS rates
282 */
283struct ieee80211_sta_ht_cap {
284 u16 cap; /* use IEEE80211_HT_CAP_ */
285 bool ht_supported;
286 u8 ampdu_factor;
287 u8 ampdu_density;
288 struct ieee80211_mcs_info mcs;
289};
290
291/**
292 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
293 *
294 * This structure describes most essential parameters needed
295 * to describe 802.11ac VHT capabilities for an STA.
296 *
297 * @vht_supported: is VHT supported by the STA
298 * @cap: VHT capabilities map as described in 802.11ac spec
299 * @vht_mcs: Supported VHT MCS rates
300 */
301struct ieee80211_sta_vht_cap {
302 bool vht_supported;
303 u32 cap; /* use IEEE80211_VHT_CAP_ */
304 struct ieee80211_vht_mcs_info vht_mcs;
305};
306
307/**
308 * struct ieee80211_supported_band - frequency band definition
309 *
310 * This structure describes a frequency band a wiphy
311 * is able to operate in.
312 *
313 * @channels: Array of channels the hardware can operate in
314 * in this band.
315 * @band: the band this structure represents
316 * @n_channels: Number of channels in @channels
317 * @bitrates: Array of bitrates the hardware can operate with
318 * in this band. Must be sorted to give a valid "supported
319 * rates" IE, i.e. CCK rates first, then OFDM.
320 * @n_bitrates: Number of bitrates in @bitrates
321 * @ht_cap: HT capabilities in this band
322 * @vht_cap: VHT capabilities in this band
323 */
324struct ieee80211_supported_band {
325 struct ieee80211_channel *channels;
326 struct ieee80211_rate *bitrates;
327 enum ieee80211_band band;
328 int n_channels;
329 int n_bitrates;
330 struct ieee80211_sta_ht_cap ht_cap;
331 struct ieee80211_sta_vht_cap vht_cap;
332};
333
334/*
335 * Wireless hardware/device configuration structures and methods
336 */
337
338/**
339 * DOC: Actions and configuration
340 *
341 * Each wireless device and each virtual interface offer a set of configuration
342 * operations and other actions that are invoked by userspace. Each of these
343 * actions is described in the operations structure, and the parameters these
344 * operations use are described separately.
345 *
346 * Additionally, some operations are asynchronous and expect to get status
347 * information via some functions that drivers need to call.
348 *
349 * Scanning and BSS list handling with its associated functionality is described
350 * in a separate chapter.
351 */
352
353/**
354 * struct vif_params - describes virtual interface parameters
355 * @use_4addr: use 4-address frames
356 * @macaddr: address to use for this virtual interface.
357 * If this parameter is set to zero address the driver may
358 * determine the address as needed.
359 * This feature is only fully supported by drivers that enable the
360 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
361 ** only p2p devices with specified MAC.
362 */
363struct vif_params {
364 int use_4addr;
365 u8 macaddr[ETH_ALEN];
366};
367
368/**
369 * struct key_params - key information
370 *
371 * Information about a key
372 *
373 * @key: key material
374 * @key_len: length of key material
375 * @cipher: cipher suite selector
376 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
377 * with the get_key() callback, must be in little endian,
378 * length given by @seq_len.
379 * @seq_len: length of @seq.
380 */
381struct key_params {
382 const u8 *key;
383 const u8 *seq;
384 int key_len;
385 int seq_len;
386 u32 cipher;
387};
388
389/**
390 * struct cfg80211_chan_def - channel definition
391 * @chan: the (control) channel
392 * @width: channel width
393 * @center_freq1: center frequency of first segment
394 * @center_freq2: center frequency of second segment
395 * (only with 80+80 MHz)
396 */
397struct cfg80211_chan_def {
398 struct ieee80211_channel *chan;
399 enum nl80211_chan_width width;
400 u32 center_freq1;
401 u32 center_freq2;
402};
403
404/**
405 * cfg80211_get_chandef_type - return old channel type from chandef
406 * @chandef: the channel definition
407 *
408 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
409 * chandef, which must have a bandwidth allowing this conversion.
410 */
411static inline enum nl80211_channel_type
412cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
413{
414 switch (chandef->width) {
415 case NL80211_CHAN_WIDTH_20_NOHT:
416 return NL80211_CHAN_NO_HT;
417 case NL80211_CHAN_WIDTH_20:
418 return NL80211_CHAN_HT20;
419 case NL80211_CHAN_WIDTH_40:
420 if (chandef->center_freq1 > chandef->chan->center_freq)
421 return NL80211_CHAN_HT40PLUS;
422 return NL80211_CHAN_HT40MINUS;
423 default:
424 WARN_ON(1);
425 return NL80211_CHAN_NO_HT;
426 }
427}
428
429/**
430 * cfg80211_chandef_create - create channel definition using channel type
431 * @chandef: the channel definition struct to fill
432 * @channel: the control channel
433 * @chantype: the channel type
434 *
435 * Given a channel type, create a channel definition.
436 */
437void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
438 struct ieee80211_channel *channel,
439 enum nl80211_channel_type chantype);
440
441/**
442 * cfg80211_chandef_identical - check if two channel definitions are identical
443 * @chandef1: first channel definition
444 * @chandef2: second channel definition
445 *
446 * Return: %true if the channels defined by the channel definitions are
447 * identical, %false otherwise.
448 */
449static inline bool
450cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
451 const struct cfg80211_chan_def *chandef2)
452{
453 return (chandef1->chan == chandef2->chan &&
454 chandef1->width == chandef2->width &&
455 chandef1->center_freq1 == chandef2->center_freq1 &&
456 chandef1->center_freq2 == chandef2->center_freq2);
457}
458
459/**
460 * cfg80211_chandef_compatible - check if two channel definitions are compatible
461 * @chandef1: first channel definition
462 * @chandef2: second channel definition
463 *
464 * Return: %NULL if the given channel definitions are incompatible,
465 * chandef1 or chandef2 otherwise.
466 */
467const struct cfg80211_chan_def *
468cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
469 const struct cfg80211_chan_def *chandef2);
470
471/**
472 * cfg80211_chandef_valid - check if a channel definition is valid
473 * @chandef: the channel definition to check
474 * Return: %true if the channel definition is valid. %false otherwise.
475 */
476bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
477
478/**
479 * cfg80211_chandef_usable - check if secondary channels can be used
480 * @wiphy: the wiphy to validate against
481 * @chandef: the channel definition to check
482 * @prohibited_flags: the regulatory channel flags that must not be set
483 * Return: %true if secondary channels are usable. %false otherwise.
484 */
485bool cfg80211_chandef_usable(struct wiphy *wiphy,
486 const struct cfg80211_chan_def *chandef,
487 u32 prohibited_flags);
488
489/**
490 * cfg80211_chandef_dfs_required - checks if radar detection is required
491 * @wiphy: the wiphy to validate against
492 * @chandef: the channel definition to check
493 * @iftype: the interface type as specified in &enum nl80211_iftype
494 * Returns:
495 * 1 if radar detection is required, 0 if it is not, < 0 on error
496 */
497int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
498 const struct cfg80211_chan_def *chandef,
499 enum nl80211_iftype iftype);
500
501/**
502 * ieee80211_chandef_rate_flags - returns rate flags for a channel
503 *
504 * In some channel types, not all rates may be used - for example CCK
505 * rates may not be used in 5/10 MHz channels.
506 *
507 * @chandef: channel definition for the channel
508 *
509 * Returns: rate flags which apply for this channel
510 */
511static inline enum ieee80211_rate_flags
512ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
513{
514 switch (chandef->width) {
515 case NL80211_CHAN_WIDTH_5:
516 return IEEE80211_RATE_SUPPORTS_5MHZ;
517 case NL80211_CHAN_WIDTH_10:
518 return IEEE80211_RATE_SUPPORTS_10MHZ;
519 default:
520 break;
521 }
522 return 0;
523}
524
525/**
526 * ieee80211_chandef_max_power - maximum transmission power for the chandef
527 *
528 * In some regulations, the transmit power may depend on the configured channel
529 * bandwidth which may be defined as dBm/MHz. This function returns the actual
530 * max_power for non-standard (20 MHz) channels.
531 *
532 * @chandef: channel definition for the channel
533 *
534 * Returns: maximum allowed transmission power in dBm for the chandef
535 */
536static inline int
537ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
538{
539 switch (chandef->width) {
540 case NL80211_CHAN_WIDTH_5:
541 return min(chandef->chan->max_reg_power - 6,
542 chandef->chan->max_power);
543 case NL80211_CHAN_WIDTH_10:
544 return min(chandef->chan->max_reg_power - 3,
545 chandef->chan->max_power);
546 default:
547 break;
548 }
549 return chandef->chan->max_power;
550}
551
552/**
553 * enum survey_info_flags - survey information flags
554 *
555 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
556 * @SURVEY_INFO_IN_USE: channel is currently being used
557 * @SURVEY_INFO_TIME: active time (in ms) was filled in
558 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
559 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
560 * @SURVEY_INFO_TIME_RX: receive time was filled in
561 * @SURVEY_INFO_TIME_TX: transmit time was filled in
562 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
563 *
564 * Used by the driver to indicate which info in &struct survey_info
565 * it has filled in during the get_survey().
566 */
567enum survey_info_flags {
568 SURVEY_INFO_NOISE_DBM = BIT(0),
569 SURVEY_INFO_IN_USE = BIT(1),
570 SURVEY_INFO_TIME = BIT(2),
571 SURVEY_INFO_TIME_BUSY = BIT(3),
572 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
573 SURVEY_INFO_TIME_RX = BIT(5),
574 SURVEY_INFO_TIME_TX = BIT(6),
575 SURVEY_INFO_TIME_SCAN = BIT(7),
576};
577
578/**
579 * struct survey_info - channel survey response
580 *
581 * @channel: the channel this survey record reports, may be %NULL for a single
582 * record to report global statistics
583 * @filled: bitflag of flags from &enum survey_info_flags
584 * @noise: channel noise in dBm. This and all following fields are
585 * optional
586 * @time: amount of time in ms the radio was turn on (on the channel)
587 * @time_busy: amount of time the primary channel was sensed busy
588 * @time_ext_busy: amount of time the extension channel was sensed busy
589 * @time_rx: amount of time the radio spent receiving data
590 * @time_tx: amount of time the radio spent transmitting data
591 * @time_scan: amount of time the radio spent for scanning
592 *
593 * Used by dump_survey() to report back per-channel survey information.
594 *
595 * This structure can later be expanded with things like
596 * channel duty cycle etc.
597 */
598struct survey_info {
599 struct ieee80211_channel *channel;
600 u64 time;
601 u64 time_busy;
602 u64 time_ext_busy;
603 u64 time_rx;
604 u64 time_tx;
605 u64 time_scan;
606 u32 filled;
607 s8 noise;
608};
609
610/**
611 * struct cfg80211_crypto_settings - Crypto settings
612 * @wpa_versions: indicates which, if any, WPA versions are enabled
613 * (from enum nl80211_wpa_versions)
614 * @cipher_group: group key cipher suite (or 0 if unset)
615 * @n_ciphers_pairwise: number of AP supported unicast ciphers
616 * @ciphers_pairwise: unicast key cipher suites
617 * @n_akm_suites: number of AKM suites
618 * @akm_suites: AKM suites
619 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
620 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
621 * required to assume that the port is unauthorized until authorized by
622 * user space. Otherwise, port is marked authorized by default.
623 * @control_port_ethertype: the control port protocol that should be
624 * allowed through even on unauthorized ports
625 * @control_port_no_encrypt: TRUE to prevent encryption of control port
626 * protocol frames.
627 */
628struct cfg80211_crypto_settings {
629 u32 wpa_versions;
630 u32 cipher_group;
631 int n_ciphers_pairwise;
632 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
633 int n_akm_suites;
634 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
635 bool control_port;
636 __be16 control_port_ethertype;
637 bool control_port_no_encrypt;
638};
639
640/**
641 * struct cfg80211_beacon_data - beacon data
642 * @head: head portion of beacon (before TIM IE)
643 * or %NULL if not changed
644 * @tail: tail portion of beacon (after TIM IE)
645 * or %NULL if not changed
646 * @head_len: length of @head
647 * @tail_len: length of @tail
648 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
649 * @beacon_ies_len: length of beacon_ies in octets
650 * @proberesp_ies: extra information element(s) to add into Probe Response
651 * frames or %NULL
652 * @proberesp_ies_len: length of proberesp_ies in octets
653 * @assocresp_ies: extra information element(s) to add into (Re)Association
654 * Response frames or %NULL
655 * @assocresp_ies_len: length of assocresp_ies in octets
656 * @probe_resp_len: length of probe response template (@probe_resp)
657 * @probe_resp: probe response template (AP mode only)
658 */
659struct cfg80211_beacon_data {
660 const u8 *head, *tail;
661 const u8 *beacon_ies;
662 const u8 *proberesp_ies;
663 const u8 *assocresp_ies;
664 const u8 *probe_resp;
665
666 size_t head_len, tail_len;
667 size_t beacon_ies_len;
668 size_t proberesp_ies_len;
669 size_t assocresp_ies_len;
670 size_t probe_resp_len;
671};
672
673struct mac_address {
674 u8 addr[ETH_ALEN];
675};
676
677/**
678 * struct cfg80211_acl_data - Access control list data
679 *
680 * @acl_policy: ACL policy to be applied on the station's
681 * entry specified by mac_addr
682 * @n_acl_entries: Number of MAC address entries passed
683 * @mac_addrs: List of MAC addresses of stations to be used for ACL
684 */
685struct cfg80211_acl_data {
686 enum nl80211_acl_policy acl_policy;
687 int n_acl_entries;
688
689 /* Keep it last */
690 struct mac_address mac_addrs[];
691};
692
693/**
694 * struct cfg80211_ap_settings - AP configuration
695 *
696 * Used to configure an AP interface.
697 *
698 * @chandef: defines the channel to use
699 * @beacon: beacon data
700 * @beacon_interval: beacon interval
701 * @dtim_period: DTIM period
702 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
703 * user space)
704 * @ssid_len: length of @ssid
705 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
706 * @crypto: crypto settings
707 * @privacy: the BSS uses privacy
708 * @auth_type: Authentication type (algorithm)
709 * @smps_mode: SMPS mode
710 * @inactivity_timeout: time in seconds to determine station's inactivity.
711 * @p2p_ctwindow: P2P CT Window
712 * @p2p_opp_ps: P2P opportunistic PS
713 * @acl: ACL configuration used by the drivers which has support for
714 * MAC address based access control
715 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
716 * networks.
717 */
718struct cfg80211_ap_settings {
719 struct cfg80211_chan_def chandef;
720
721 struct cfg80211_beacon_data beacon;
722
723 int beacon_interval, dtim_period;
724 const u8 *ssid;
725 size_t ssid_len;
726 enum nl80211_hidden_ssid hidden_ssid;
727 struct cfg80211_crypto_settings crypto;
728 bool privacy;
729 enum nl80211_auth_type auth_type;
730 enum nl80211_smps_mode smps_mode;
731 int inactivity_timeout;
732 u8 p2p_ctwindow;
733 bool p2p_opp_ps;
734 const struct cfg80211_acl_data *acl;
735 bool pbss;
736};
737
738/**
739 * struct cfg80211_csa_settings - channel switch settings
740 *
741 * Used for channel switch
742 *
743 * @chandef: defines the channel to use after the switch
744 * @beacon_csa: beacon data while performing the switch
745 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
746 * @counter_offsets_presp: offsets of the counters within the probe response
747 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
748 * @n_counter_offsets_presp: number of csa counters in the probe response
749 * @beacon_after: beacon data to be used on the new channel
750 * @radar_required: whether radar detection is required on the new channel
751 * @block_tx: whether transmissions should be blocked while changing
752 * @count: number of beacons until switch
753 */
754struct cfg80211_csa_settings {
755 struct cfg80211_chan_def chandef;
756 struct cfg80211_beacon_data beacon_csa;
757 const u16 *counter_offsets_beacon;
758 const u16 *counter_offsets_presp;
759 unsigned int n_counter_offsets_beacon;
760 unsigned int n_counter_offsets_presp;
761 struct cfg80211_beacon_data beacon_after;
762 bool radar_required;
763 bool block_tx;
764 u8 count;
765};
766
767/**
768 * enum station_parameters_apply_mask - station parameter values to apply
769 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
770 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
771 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
772 *
773 * Not all station parameters have in-band "no change" signalling,
774 * for those that don't these flags will are used.
775 */
776enum station_parameters_apply_mask {
777 STATION_PARAM_APPLY_UAPSD = BIT(0),
778 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
779 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
780};
781
782/**
783 * struct station_parameters - station parameters
784 *
785 * Used to change and create a new station.
786 *
787 * @vlan: vlan interface station should belong to
788 * @supported_rates: supported rates in IEEE 802.11 format
789 * (or NULL for no change)
790 * @supported_rates_len: number of supported rates
791 * @sta_flags_mask: station flags that changed
792 * (bitmask of BIT(NL80211_STA_FLAG_...))
793 * @sta_flags_set: station flags values
794 * (bitmask of BIT(NL80211_STA_FLAG_...))
795 * @listen_interval: listen interval or -1 for no change
796 * @aid: AID or zero for no change
797 * @plink_action: plink action to take
798 * @plink_state: set the peer link state for a station
799 * @ht_capa: HT capabilities of station
800 * @vht_capa: VHT capabilities of station
801 * @uapsd_queues: bitmap of queues configured for uapsd. same format
802 * as the AC bitmap in the QoS info field
803 * @max_sp: max Service Period. same format as the MAX_SP in the
804 * QoS info field (but already shifted down)
805 * @sta_modify_mask: bitmap indicating which parameters changed
806 * (for those that don't have a natural "no change" value),
807 * see &enum station_parameters_apply_mask
808 * @local_pm: local link-specific mesh power save mode (no change when set
809 * to unknown)
810 * @capability: station capability
811 * @ext_capab: extended capabilities of the station
812 * @ext_capab_len: number of extended capabilities
813 * @supported_channels: supported channels in IEEE 802.11 format
814 * @supported_channels_len: number of supported channels
815 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
816 * @supported_oper_classes_len: number of supported operating classes
817 * @opmode_notif: operating mode field from Operating Mode Notification
818 * @opmode_notif_used: information if operating mode field is used
819 */
820struct station_parameters {
821 const u8 *supported_rates;
822 struct net_device *vlan;
823 u32 sta_flags_mask, sta_flags_set;
824 u32 sta_modify_mask;
825 int listen_interval;
826 u16 aid;
827 u8 supported_rates_len;
828 u8 plink_action;
829 u8 plink_state;
830 const struct ieee80211_ht_cap *ht_capa;
831 const struct ieee80211_vht_cap *vht_capa;
832 u8 uapsd_queues;
833 u8 max_sp;
834 enum nl80211_mesh_power_mode local_pm;
835 u16 capability;
836 const u8 *ext_capab;
837 u8 ext_capab_len;
838 const u8 *supported_channels;
839 u8 supported_channels_len;
840 const u8 *supported_oper_classes;
841 u8 supported_oper_classes_len;
842 u8 opmode_notif;
843 bool opmode_notif_used;
844};
845
846/**
847 * struct station_del_parameters - station deletion parameters
848 *
849 * Used to delete a station entry (or all stations).
850 *
851 * @mac: MAC address of the station to remove or NULL to remove all stations
852 * @subtype: Management frame subtype to use for indicating removal
853 * (10 = Disassociation, 12 = Deauthentication)
854 * @reason_code: Reason code for the Disassociation/Deauthentication frame
855 */
856struct station_del_parameters {
857 const u8 *mac;
858 u8 subtype;
859 u16 reason_code;
860};
861
862/**
863 * enum cfg80211_station_type - the type of station being modified
864 * @CFG80211_STA_AP_CLIENT: client of an AP interface
865 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
866 * unassociated (update properties for this type of client is permitted)
867 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
868 * the AP MLME in the device
869 * @CFG80211_STA_AP_STA: AP station on managed interface
870 * @CFG80211_STA_IBSS: IBSS station
871 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
872 * while TDLS setup is in progress, it moves out of this state when
873 * being marked authorized; use this only if TDLS with external setup is
874 * supported/used)
875 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
876 * entry that is operating, has been marked authorized by userspace)
877 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
878 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
879 */
880enum cfg80211_station_type {
881 CFG80211_STA_AP_CLIENT,
882 CFG80211_STA_AP_CLIENT_UNASSOC,
883 CFG80211_STA_AP_MLME_CLIENT,
884 CFG80211_STA_AP_STA,
885 CFG80211_STA_IBSS,
886 CFG80211_STA_TDLS_PEER_SETUP,
887 CFG80211_STA_TDLS_PEER_ACTIVE,
888 CFG80211_STA_MESH_PEER_KERNEL,
889 CFG80211_STA_MESH_PEER_USER,
890};
891
892/**
893 * cfg80211_check_station_change - validate parameter changes
894 * @wiphy: the wiphy this operates on
895 * @params: the new parameters for a station
896 * @statype: the type of station being modified
897 *
898 * Utility function for the @change_station driver method. Call this function
899 * with the appropriate station type looking up the station (and checking that
900 * it exists). It will verify whether the station change is acceptable, and if
901 * not will return an error code. Note that it may modify the parameters for
902 * backward compatibility reasons, so don't use them before calling this.
903 */
904int cfg80211_check_station_change(struct wiphy *wiphy,
905 struct station_parameters *params,
906 enum cfg80211_station_type statype);
907
908/**
909 * enum station_info_rate_flags - bitrate info flags
910 *
911 * Used by the driver to indicate the specific rate transmission
912 * type for 802.11n transmissions.
913 *
914 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
915 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
916 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
917 * @RATE_INFO_FLAGS_60G: 60GHz MCS
918 */
919enum rate_info_flags {
920 RATE_INFO_FLAGS_MCS = BIT(0),
921 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
922 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
923 RATE_INFO_FLAGS_60G = BIT(3),
924};
925
926/**
927 * enum rate_info_bw - rate bandwidth information
928 *
929 * Used by the driver to indicate the rate bandwidth.
930 *
931 * @RATE_INFO_BW_5: 5 MHz bandwidth
932 * @RATE_INFO_BW_10: 10 MHz bandwidth
933 * @RATE_INFO_BW_20: 20 MHz bandwidth
934 * @RATE_INFO_BW_40: 40 MHz bandwidth
935 * @RATE_INFO_BW_80: 80 MHz bandwidth
936 * @RATE_INFO_BW_160: 160 MHz bandwidth
937 */
938enum rate_info_bw {
939 RATE_INFO_BW_5,
940 RATE_INFO_BW_10,
941 RATE_INFO_BW_20,
942 RATE_INFO_BW_40,
943 RATE_INFO_BW_80,
944 RATE_INFO_BW_160,
945};
946
947/**
948 * struct rate_info - bitrate information
949 *
950 * Information about a receiving or transmitting bitrate
951 *
952 * @flags: bitflag of flags from &enum rate_info_flags
953 * @mcs: mcs index if struct describes a 802.11n bitrate
954 * @legacy: bitrate in 100kbit/s for 802.11abg
955 * @nss: number of streams (VHT only)
956 * @bw: bandwidth (from &enum rate_info_bw)
957 */
958struct rate_info {
959 u8 flags;
960 u8 mcs;
961 u16 legacy;
962 u8 nss;
963 u8 bw;
964};
965
966/**
967 * enum station_info_rate_flags - bitrate info flags
968 *
969 * Used by the driver to indicate the specific rate transmission
970 * type for 802.11n transmissions.
971 *
972 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
973 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
974 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
975 */
976enum bss_param_flags {
977 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
978 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
979 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
980};
981
982/**
983 * struct sta_bss_parameters - BSS parameters for the attached station
984 *
985 * Information about the currently associated BSS
986 *
987 * @flags: bitflag of flags from &enum bss_param_flags
988 * @dtim_period: DTIM period for the BSS
989 * @beacon_interval: beacon interval
990 */
991struct sta_bss_parameters {
992 u8 flags;
993 u8 dtim_period;
994 u16 beacon_interval;
995};
996
997/**
998 * struct cfg80211_tid_stats - per-TID statistics
999 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1000 * indicate the relevant values in this struct are filled
1001 * @rx_msdu: number of received MSDUs
1002 * @tx_msdu: number of (attempted) transmitted MSDUs
1003 * @tx_msdu_retries: number of retries (not counting the first) for
1004 * transmitted MSDUs
1005 * @tx_msdu_failed: number of failed transmitted MSDUs
1006 */
1007struct cfg80211_tid_stats {
1008 u32 filled;
1009 u64 rx_msdu;
1010 u64 tx_msdu;
1011 u64 tx_msdu_retries;
1012 u64 tx_msdu_failed;
1013};
1014
1015#define IEEE80211_MAX_CHAINS 4
1016
1017/**
1018 * struct station_info - station information
1019 *
1020 * Station information filled by driver for get_station() and dump_station.
1021 *
1022 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1023 * indicate the relevant values in this struct for them
1024 * @connected_time: time(in secs) since a station is last connected
1025 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1026 * @rx_bytes: bytes (size of MPDUs) received from this station
1027 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1028 * @llid: mesh local link id
1029 * @plid: mesh peer link id
1030 * @plink_state: mesh peer link state
1031 * @signal: The signal strength, type depends on the wiphy's signal_type.
1032 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1033 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1034 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1035 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1036 * @chain_signal: per-chain signal strength of last received packet in dBm
1037 * @chain_signal_avg: per-chain signal strength average in dBm
1038 * @txrate: current unicast bitrate from this station
1039 * @rxrate: current unicast bitrate to this station
1040 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1041 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1042 * @tx_retries: cumulative retry counts (MPDUs)
1043 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1044 * @rx_dropped_misc: Dropped for un-specified reason.
1045 * @bss_param: current BSS parameters
1046 * @generation: generation number for nl80211 dumps.
1047 * This number should increase every time the list of stations
1048 * changes, i.e. when a station is added or removed, so that
1049 * userspace can tell whether it got a consistent snapshot.
1050 * @assoc_req_ies: IEs from (Re)Association Request.
1051 * This is used only when in AP mode with drivers that do not use
1052 * user space MLME/SME implementation. The information is provided for
1053 * the cfg80211_new_sta() calls to notify user space of the IEs.
1054 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1055 * @sta_flags: station flags mask & values
1056 * @beacon_loss_count: Number of times beacon loss event has triggered.
1057 * @t_offset: Time offset of the station relative to this host.
1058 * @local_pm: local mesh STA power save mode
1059 * @peer_pm: peer mesh STA power save mode
1060 * @nonpeer_pm: non-peer mesh STA power save mode
1061 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1062 * towards this station.
1063 * @rx_beacon: number of beacons received from this peer
1064 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1065 * from this peer
1066 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1067 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1068 */
1069struct station_info {
1070 u32 filled;
1071 u32 connected_time;
1072 u32 inactive_time;
1073 u64 rx_bytes;
1074 u64 tx_bytes;
1075 u16 llid;
1076 u16 plid;
1077 u8 plink_state;
1078 s8 signal;
1079 s8 signal_avg;
1080
1081 u8 chains;
1082 s8 chain_signal[IEEE80211_MAX_CHAINS];
1083 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1084
1085 struct rate_info txrate;
1086 struct rate_info rxrate;
1087 u32 rx_packets;
1088 u32 tx_packets;
1089 u32 tx_retries;
1090 u32 tx_failed;
1091 u32 rx_dropped_misc;
1092 struct sta_bss_parameters bss_param;
1093 struct nl80211_sta_flag_update sta_flags;
1094
1095 int generation;
1096
1097 const u8 *assoc_req_ies;
1098 size_t assoc_req_ies_len;
1099
1100 u32 beacon_loss_count;
1101 s64 t_offset;
1102 enum nl80211_mesh_power_mode local_pm;
1103 enum nl80211_mesh_power_mode peer_pm;
1104 enum nl80211_mesh_power_mode nonpeer_pm;
1105
1106 u32 expected_throughput;
1107
1108 u64 rx_beacon;
1109 u8 rx_beacon_signal_avg;
1110 struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1111};
1112
1113/**
1114 * cfg80211_get_station - retrieve information about a given station
1115 * @dev: the device where the station is supposed to be connected to
1116 * @mac_addr: the mac address of the station of interest
1117 * @sinfo: pointer to the structure to fill with the information
1118 *
1119 * Returns 0 on success and sinfo is filled with the available information
1120 * otherwise returns a negative error code and the content of sinfo has to be
1121 * considered undefined.
1122 */
1123int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1124 struct station_info *sinfo);
1125
1126/**
1127 * enum monitor_flags - monitor flags
1128 *
1129 * Monitor interface configuration flags. Note that these must be the bits
1130 * according to the nl80211 flags.
1131 *
1132 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1133 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1134 * @MONITOR_FLAG_CONTROL: pass control frames
1135 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1136 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1137 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1138 */
1139enum monitor_flags {
1140 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1141 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1142 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1143 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1144 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1145 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1146};
1147
1148/**
1149 * enum mpath_info_flags - mesh path information flags
1150 *
1151 * Used by the driver to indicate which info in &struct mpath_info it has filled
1152 * in during get_station() or dump_station().
1153 *
1154 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1155 * @MPATH_INFO_SN: @sn filled
1156 * @MPATH_INFO_METRIC: @metric filled
1157 * @MPATH_INFO_EXPTIME: @exptime filled
1158 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1159 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1160 * @MPATH_INFO_FLAGS: @flags filled
1161 */
1162enum mpath_info_flags {
1163 MPATH_INFO_FRAME_QLEN = BIT(0),
1164 MPATH_INFO_SN = BIT(1),
1165 MPATH_INFO_METRIC = BIT(2),
1166 MPATH_INFO_EXPTIME = BIT(3),
1167 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1168 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1169 MPATH_INFO_FLAGS = BIT(6),
1170};
1171
1172/**
1173 * struct mpath_info - mesh path information
1174 *
1175 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1176 *
1177 * @filled: bitfield of flags from &enum mpath_info_flags
1178 * @frame_qlen: number of queued frames for this destination
1179 * @sn: target sequence number
1180 * @metric: metric (cost) of this mesh path
1181 * @exptime: expiration time for the mesh path from now, in msecs
1182 * @flags: mesh path flags
1183 * @discovery_timeout: total mesh path discovery timeout, in msecs
1184 * @discovery_retries: mesh path discovery retries
1185 * @generation: generation number for nl80211 dumps.
1186 * This number should increase every time the list of mesh paths
1187 * changes, i.e. when a station is added or removed, so that
1188 * userspace can tell whether it got a consistent snapshot.
1189 */
1190struct mpath_info {
1191 u32 filled;
1192 u32 frame_qlen;
1193 u32 sn;
1194 u32 metric;
1195 u32 exptime;
1196 u32 discovery_timeout;
1197 u8 discovery_retries;
1198 u8 flags;
1199
1200 int generation;
1201};
1202
1203/**
1204 * struct bss_parameters - BSS parameters
1205 *
1206 * Used to change BSS parameters (mainly for AP mode).
1207 *
1208 * @use_cts_prot: Whether to use CTS protection
1209 * (0 = no, 1 = yes, -1 = do not change)
1210 * @use_short_preamble: Whether the use of short preambles is allowed
1211 * (0 = no, 1 = yes, -1 = do not change)
1212 * @use_short_slot_time: Whether the use of short slot time is allowed
1213 * (0 = no, 1 = yes, -1 = do not change)
1214 * @basic_rates: basic rates in IEEE 802.11 format
1215 * (or NULL for no change)
1216 * @basic_rates_len: number of basic rates
1217 * @ap_isolate: do not forward packets between connected stations
1218 * @ht_opmode: HT Operation mode
1219 * (u16 = opmode, -1 = do not change)
1220 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1221 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1222 */
1223struct bss_parameters {
1224 int use_cts_prot;
1225 int use_short_preamble;
1226 int use_short_slot_time;
1227 const u8 *basic_rates;
1228 u8 basic_rates_len;
1229 int ap_isolate;
1230 int ht_opmode;
1231 s8 p2p_ctwindow, p2p_opp_ps;
1232};
1233
1234/**
1235 * struct mesh_config - 802.11s mesh configuration
1236 *
1237 * These parameters can be changed while the mesh is active.
1238 *
1239 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1240 * by the Mesh Peering Open message
1241 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1242 * used by the Mesh Peering Open message
1243 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1244 * the mesh peering management to close a mesh peering
1245 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1246 * mesh interface
1247 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1248 * be sent to establish a new peer link instance in a mesh
1249 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1250 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1251 * elements
1252 * @auto_open_plinks: whether we should automatically open peer links when we
1253 * detect compatible mesh peers
1254 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1255 * synchronize to for 11s default synchronization method
1256 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1257 * that an originator mesh STA can send to a particular path target
1258 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1259 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1260 * a path discovery in milliseconds
1261 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1262 * receiving a PREQ shall consider the forwarding information from the
1263 * root to be valid. (TU = time unit)
1264 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1265 * which a mesh STA can send only one action frame containing a PREQ
1266 * element
1267 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1268 * which a mesh STA can send only one Action frame containing a PERR
1269 * element
1270 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1271 * it takes for an HWMP information element to propagate across the mesh
1272 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1273 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1274 * announcements are transmitted
1275 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1276 * station has access to a broader network beyond the MBSS. (This is
1277 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1278 * only means that the station will announce others it's a mesh gate, but
1279 * not necessarily using the gate announcement protocol. Still keeping the
1280 * same nomenclature to be in sync with the spec)
1281 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1282 * entity (default is TRUE - forwarding entity)
1283 * @rssi_threshold: the threshold for average signal strength of candidate
1284 * station to establish a peer link
1285 * @ht_opmode: mesh HT protection mode
1286 *
1287 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1288 * receiving a proactive PREQ shall consider the forwarding information to
1289 * the root mesh STA to be valid.
1290 *
1291 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1292 * PREQs are transmitted.
1293 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1294 * during which a mesh STA can send only one Action frame containing
1295 * a PREQ element for root path confirmation.
1296 * @power_mode: The default mesh power save mode which will be the initial
1297 * setting for new peer links.
1298 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1299 * after transmitting its beacon.
1300 * @plink_timeout: If no tx activity is seen from a STA we've established
1301 * peering with for longer than this time (in seconds), then remove it
1302 * from the STA's list of peers. Default is 30 minutes.
1303 */
1304struct mesh_config {
1305 u16 dot11MeshRetryTimeout;
1306 u16 dot11MeshConfirmTimeout;
1307 u16 dot11MeshHoldingTimeout;
1308 u16 dot11MeshMaxPeerLinks;
1309 u8 dot11MeshMaxRetries;
1310 u8 dot11MeshTTL;
1311 u8 element_ttl;
1312 bool auto_open_plinks;
1313 u32 dot11MeshNbrOffsetMaxNeighbor;
1314 u8 dot11MeshHWMPmaxPREQretries;
1315 u32 path_refresh_time;
1316 u16 min_discovery_timeout;
1317 u32 dot11MeshHWMPactivePathTimeout;
1318 u16 dot11MeshHWMPpreqMinInterval;
1319 u16 dot11MeshHWMPperrMinInterval;
1320 u16 dot11MeshHWMPnetDiameterTraversalTime;
1321 u8 dot11MeshHWMPRootMode;
1322 u16 dot11MeshHWMPRannInterval;
1323 bool dot11MeshGateAnnouncementProtocol;
1324 bool dot11MeshForwarding;
1325 s32 rssi_threshold;
1326 u16 ht_opmode;
1327 u32 dot11MeshHWMPactivePathToRootTimeout;
1328 u16 dot11MeshHWMProotInterval;
1329 u16 dot11MeshHWMPconfirmationInterval;
1330 enum nl80211_mesh_power_mode power_mode;
1331 u16 dot11MeshAwakeWindowDuration;
1332 u32 plink_timeout;
1333};
1334
1335/**
1336 * struct mesh_setup - 802.11s mesh setup configuration
1337 * @chandef: defines the channel to use
1338 * @mesh_id: the mesh ID
1339 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1340 * @sync_method: which synchronization method to use
1341 * @path_sel_proto: which path selection protocol to use
1342 * @path_metric: which metric to use
1343 * @auth_id: which authentication method this mesh is using
1344 * @ie: vendor information elements (optional)
1345 * @ie_len: length of vendor information elements
1346 * @is_authenticated: this mesh requires authentication
1347 * @is_secure: this mesh uses security
1348 * @user_mpm: userspace handles all MPM functions
1349 * @dtim_period: DTIM period to use
1350 * @beacon_interval: beacon interval to use
1351 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1352 * @basic_rates: basic rates to use when creating the mesh
1353 *
1354 * These parameters are fixed when the mesh is created.
1355 */
1356struct mesh_setup {
1357 struct cfg80211_chan_def chandef;
1358 const u8 *mesh_id;
1359 u8 mesh_id_len;
1360 u8 sync_method;
1361 u8 path_sel_proto;
1362 u8 path_metric;
1363 u8 auth_id;
1364 const u8 *ie;
1365 u8 ie_len;
1366 bool is_authenticated;
1367 bool is_secure;
1368 bool user_mpm;
1369 u8 dtim_period;
1370 u16 beacon_interval;
1371 int mcast_rate[IEEE80211_NUM_BANDS];
1372 u32 basic_rates;
1373};
1374
1375/**
1376 * struct ocb_setup - 802.11p OCB mode setup configuration
1377 * @chandef: defines the channel to use
1378 *
1379 * These parameters are fixed when connecting to the network
1380 */
1381struct ocb_setup {
1382 struct cfg80211_chan_def chandef;
1383};
1384
1385/**
1386 * struct ieee80211_txq_params - TX queue parameters
1387 * @ac: AC identifier
1388 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1389 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1390 * 1..32767]
1391 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1392 * 1..32767]
1393 * @aifs: Arbitration interframe space [0..255]
1394 */
1395struct ieee80211_txq_params {
1396 enum nl80211_ac ac;
1397 u16 txop;
1398 u16 cwmin;
1399 u16 cwmax;
1400 u8 aifs;
1401};
1402
1403/**
1404 * DOC: Scanning and BSS list handling
1405 *
1406 * The scanning process itself is fairly simple, but cfg80211 offers quite
1407 * a bit of helper functionality. To start a scan, the scan operation will
1408 * be invoked with a scan definition. This scan definition contains the
1409 * channels to scan, and the SSIDs to send probe requests for (including the
1410 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1411 * probe. Additionally, a scan request may contain extra information elements
1412 * that should be added to the probe request. The IEs are guaranteed to be
1413 * well-formed, and will not exceed the maximum length the driver advertised
1414 * in the wiphy structure.
1415 *
1416 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1417 * it is responsible for maintaining the BSS list; the driver should not
1418 * maintain a list itself. For this notification, various functions exist.
1419 *
1420 * Since drivers do not maintain a BSS list, there are also a number of
1421 * functions to search for a BSS and obtain information about it from the
1422 * BSS structure cfg80211 maintains. The BSS list is also made available
1423 * to userspace.
1424 */
1425
1426/**
1427 * struct cfg80211_ssid - SSID description
1428 * @ssid: the SSID
1429 * @ssid_len: length of the ssid
1430 */
1431struct cfg80211_ssid {
1432 u8 ssid[IEEE80211_MAX_SSID_LEN];
1433 u8 ssid_len;
1434};
1435
1436/**
1437 * struct cfg80211_scan_request - scan request description
1438 *
1439 * @ssids: SSIDs to scan for (active scan only)
1440 * @n_ssids: number of SSIDs
1441 * @channels: channels to scan on.
1442 * @n_channels: total number of channels to scan
1443 * @scan_width: channel width for scanning
1444 * @ie: optional information element(s) to add into Probe Request or %NULL
1445 * @ie_len: length of ie in octets
1446 * @flags: bit field of flags controlling operation
1447 * @rates: bitmap of rates to advertise for each band
1448 * @wiphy: the wiphy this was for
1449 * @scan_start: time (in jiffies) when the scan started
1450 * @wdev: the wireless device to scan for
1451 * @aborted: (internal) scan request was notified as aborted
1452 * @notified: (internal) scan request was notified as done or aborted
1453 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1454 * @mac_addr: MAC address used with randomisation
1455 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1456 * are 0 in the mask should be randomised, bits that are 1 should
1457 * be taken from the @mac_addr
1458 */
1459struct cfg80211_scan_request {
1460 struct cfg80211_ssid *ssids;
1461 int n_ssids;
1462 u32 n_channels;
1463 enum nl80211_bss_scan_width scan_width;
1464 const u8 *ie;
1465 size_t ie_len;
1466 u32 flags;
1467
1468 u32 rates[IEEE80211_NUM_BANDS];
1469
1470 struct wireless_dev *wdev;
1471
1472 u8 mac_addr[ETH_ALEN] __aligned(2);
1473 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1474
1475 /* internal */
1476 struct wiphy *wiphy;
1477 unsigned long scan_start;
1478 bool aborted, notified;
1479 bool no_cck;
1480
1481 /* keep last */
1482 struct ieee80211_channel *channels[0];
1483};
1484
1485static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1486{
1487 int i;
1488
1489 get_random_bytes(buf, ETH_ALEN);
1490 for (i = 0; i < ETH_ALEN; i++) {
1491 buf[i] &= ~mask[i];
1492 buf[i] |= addr[i] & mask[i];
1493 }
1494}
1495
1496/**
1497 * struct cfg80211_match_set - sets of attributes to match
1498 *
1499 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1500 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1501 */
1502struct cfg80211_match_set {
1503 struct cfg80211_ssid ssid;
1504 s32 rssi_thold;
1505};
1506
1507/**
1508 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1509 *
1510 * @interval: interval between scheduled scan iterations. In seconds.
1511 * @iterations: number of scan iterations in this scan plan. Zero means
1512 * infinite loop.
1513 * The last scan plan will always have this parameter set to zero,
1514 * all other scan plans will have a finite number of iterations.
1515 */
1516struct cfg80211_sched_scan_plan {
1517 u32 interval;
1518 u32 iterations;
1519};
1520
1521/**
1522 * struct cfg80211_sched_scan_request - scheduled scan request description
1523 *
1524 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1525 * @n_ssids: number of SSIDs
1526 * @n_channels: total number of channels to scan
1527 * @scan_width: channel width for scanning
1528 * @ie: optional information element(s) to add into Probe Request or %NULL
1529 * @ie_len: length of ie in octets
1530 * @flags: bit field of flags controlling operation
1531 * @match_sets: sets of parameters to be matched for a scan result
1532 * entry to be considered valid and to be passed to the host
1533 * (others are filtered out).
1534 * If ommited, all results are passed.
1535 * @n_match_sets: number of match sets
1536 * @wiphy: the wiphy this was for
1537 * @dev: the interface
1538 * @scan_start: start time of the scheduled scan
1539 * @channels: channels to scan
1540 * @min_rssi_thold: for drivers only supporting a single threshold, this
1541 * contains the minimum over all matchsets
1542 * @mac_addr: MAC address used with randomisation
1543 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1544 * are 0 in the mask should be randomised, bits that are 1 should
1545 * be taken from the @mac_addr
1546 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1547 * index must be executed first.
1548 * @n_scan_plans: number of scan plans, at least 1.
1549 * @rcu_head: RCU callback used to free the struct
1550 * @owner_nlportid: netlink portid of owner (if this should is a request
1551 * owned by a particular socket)
1552 * @delay: delay in seconds to use before starting the first scan
1553 * cycle. The driver may ignore this parameter and start
1554 * immediately (or at any other time), if this feature is not
1555 * supported.
1556 */
1557struct cfg80211_sched_scan_request {
1558 struct cfg80211_ssid *ssids;
1559 int n_ssids;
1560 u32 n_channels;
1561 enum nl80211_bss_scan_width scan_width;
1562 const u8 *ie;
1563 size_t ie_len;
1564 u32 flags;
1565 struct cfg80211_match_set *match_sets;
1566 int n_match_sets;
1567 s32 min_rssi_thold;
1568 u32 delay;
1569 struct cfg80211_sched_scan_plan *scan_plans;
1570 int n_scan_plans;
1571
1572 u8 mac_addr[ETH_ALEN] __aligned(2);
1573 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1574
1575 /* internal */
1576 struct wiphy *wiphy;
1577 struct net_device *dev;
1578 unsigned long scan_start;
1579 struct rcu_head rcu_head;
1580 u32 owner_nlportid;
1581
1582 /* keep last */
1583 struct ieee80211_channel *channels[0];
1584};
1585
1586/**
1587 * enum cfg80211_signal_type - signal type
1588 *
1589 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1590 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1591 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1592 */
1593enum cfg80211_signal_type {
1594 CFG80211_SIGNAL_TYPE_NONE,
1595 CFG80211_SIGNAL_TYPE_MBM,
1596 CFG80211_SIGNAL_TYPE_UNSPEC,
1597};
1598
1599/**
1600 * struct cfg80211_inform_bss - BSS inform data
1601 * @chan: channel the frame was received on
1602 * @scan_width: scan width that was used
1603 * @signal: signal strength value, according to the wiphy's
1604 * signal type
1605 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1606 * received; should match the time when the frame was actually
1607 * received by the device (not just by the host, in case it was
1608 * buffered on the device) and be accurate to about 10ms.
1609 * If the frame isn't buffered, just passing the return value of
1610 * ktime_get_boot_ns() is likely appropriate.
1611 */
1612struct cfg80211_inform_bss {
1613 struct ieee80211_channel *chan;
1614 enum nl80211_bss_scan_width scan_width;
1615 s32 signal;
1616 u64 boottime_ns;
1617};
1618
1619/**
1620 * struct cfg80211_bss_ie_data - BSS entry IE data
1621 * @tsf: TSF contained in the frame that carried these IEs
1622 * @rcu_head: internal use, for freeing
1623 * @len: length of the IEs
1624 * @from_beacon: these IEs are known to come from a beacon
1625 * @data: IE data
1626 */
1627struct cfg80211_bss_ies {
1628 u64 tsf;
1629 struct rcu_head rcu_head;
1630 int len;
1631 bool from_beacon;
1632 u8 data[];
1633};
1634
1635/**
1636 * struct cfg80211_bss - BSS description
1637 *
1638 * This structure describes a BSS (which may also be a mesh network)
1639 * for use in scan results and similar.
1640 *
1641 * @channel: channel this BSS is on
1642 * @scan_width: width of the control channel
1643 * @bssid: BSSID of the BSS
1644 * @beacon_interval: the beacon interval as from the frame
1645 * @capability: the capability field in host byte order
1646 * @ies: the information elements (Note that there is no guarantee that these
1647 * are well-formed!); this is a pointer to either the beacon_ies or
1648 * proberesp_ies depending on whether Probe Response frame has been
1649 * received. It is always non-%NULL.
1650 * @beacon_ies: the information elements from the last Beacon frame
1651 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1652 * own the beacon_ies, but they're just pointers to the ones from the
1653 * @hidden_beacon_bss struct)
1654 * @proberesp_ies: the information elements from the last Probe Response frame
1655 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1656 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1657 * that holds the beacon data. @beacon_ies is still valid, of course, and
1658 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1659 * @signal: signal strength value (type depends on the wiphy's signal_type)
1660 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1661 */
1662struct cfg80211_bss {
1663 struct ieee80211_channel *channel;
1664 enum nl80211_bss_scan_width scan_width;
1665
1666 const struct cfg80211_bss_ies __rcu *ies;
1667 const struct cfg80211_bss_ies __rcu *beacon_ies;
1668 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1669
1670 struct cfg80211_bss *hidden_beacon_bss;
1671
1672 s32 signal;
1673
1674 u16 beacon_interval;
1675 u16 capability;
1676
1677 u8 bssid[ETH_ALEN];
1678
1679 u8 priv[0] __aligned(sizeof(void *));
1680};
1681
1682/**
1683 * ieee80211_bss_get_ie - find IE with given ID
1684 * @bss: the bss to search
1685 * @ie: the IE ID
1686 *
1687 * Note that the return value is an RCU-protected pointer, so
1688 * rcu_read_lock() must be held when calling this function.
1689 * Return: %NULL if not found.
1690 */
1691const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1692
1693
1694/**
1695 * struct cfg80211_auth_request - Authentication request data
1696 *
1697 * This structure provides information needed to complete IEEE 802.11
1698 * authentication.
1699 *
1700 * @bss: The BSS to authenticate with, the callee must obtain a reference
1701 * to it if it needs to keep it.
1702 * @auth_type: Authentication type (algorithm)
1703 * @ie: Extra IEs to add to Authentication frame or %NULL
1704 * @ie_len: Length of ie buffer in octets
1705 * @key_len: length of WEP key for shared key authentication
1706 * @key_idx: index of WEP key for shared key authentication
1707 * @key: WEP key for shared key authentication
1708 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1709 * Authentication transaction sequence number field.
1710 * @sae_data_len: Length of sae_data buffer in octets
1711 */
1712struct cfg80211_auth_request {
1713 struct cfg80211_bss *bss;
1714 const u8 *ie;
1715 size_t ie_len;
1716 enum nl80211_auth_type auth_type;
1717 const u8 *key;
1718 u8 key_len, key_idx;
1719 const u8 *sae_data;
1720 size_t sae_data_len;
1721};
1722
1723/**
1724 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1725 *
1726 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1727 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1728 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1729 */
1730enum cfg80211_assoc_req_flags {
1731 ASSOC_REQ_DISABLE_HT = BIT(0),
1732 ASSOC_REQ_DISABLE_VHT = BIT(1),
1733 ASSOC_REQ_USE_RRM = BIT(2),
1734};
1735
1736/**
1737 * struct cfg80211_assoc_request - (Re)Association request data
1738 *
1739 * This structure provides information needed to complete IEEE 802.11
1740 * (re)association.
1741 * @bss: The BSS to associate with. If the call is successful the driver is
1742 * given a reference that it must give back to cfg80211_send_rx_assoc()
1743 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1744 * association requests while already associating must be rejected.
1745 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1746 * @ie_len: Length of ie buffer in octets
1747 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1748 * @crypto: crypto settings
1749 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1750 * @flags: See &enum cfg80211_assoc_req_flags
1751 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1752 * will be used in ht_capa. Un-supported values will be ignored.
1753 * @ht_capa_mask: The bits of ht_capa which are to be used.
1754 * @vht_capa: VHT capability override
1755 * @vht_capa_mask: VHT capability mask indicating which fields to use
1756 */
1757struct cfg80211_assoc_request {
1758 struct cfg80211_bss *bss;
1759 const u8 *ie, *prev_bssid;
1760 size_t ie_len;
1761 struct cfg80211_crypto_settings crypto;
1762 bool use_mfp;
1763 u32 flags;
1764 struct ieee80211_ht_cap ht_capa;
1765 struct ieee80211_ht_cap ht_capa_mask;
1766 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1767};
1768
1769/**
1770 * struct cfg80211_deauth_request - Deauthentication request data
1771 *
1772 * This structure provides information needed to complete IEEE 802.11
1773 * deauthentication.
1774 *
1775 * @bssid: the BSSID of the BSS to deauthenticate from
1776 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1777 * @ie_len: Length of ie buffer in octets
1778 * @reason_code: The reason code for the deauthentication
1779 * @local_state_change: if set, change local state only and
1780 * do not set a deauth frame
1781 */
1782struct cfg80211_deauth_request {
1783 const u8 *bssid;
1784 const u8 *ie;
1785 size_t ie_len;
1786 u16 reason_code;
1787 bool local_state_change;
1788};
1789
1790/**
1791 * struct cfg80211_disassoc_request - Disassociation request data
1792 *
1793 * This structure provides information needed to complete IEEE 802.11
1794 * disassocation.
1795 *
1796 * @bss: the BSS to disassociate from
1797 * @ie: Extra IEs to add to Disassociation frame or %NULL
1798 * @ie_len: Length of ie buffer in octets
1799 * @reason_code: The reason code for the disassociation
1800 * @local_state_change: This is a request for a local state only, i.e., no
1801 * Disassociation frame is to be transmitted.
1802 */
1803struct cfg80211_disassoc_request {
1804 struct cfg80211_bss *bss;
1805 const u8 *ie;
1806 size_t ie_len;
1807 u16 reason_code;
1808 bool local_state_change;
1809};
1810
1811/**
1812 * struct cfg80211_ibss_params - IBSS parameters
1813 *
1814 * This structure defines the IBSS parameters for the join_ibss()
1815 * method.
1816 *
1817 * @ssid: The SSID, will always be non-null.
1818 * @ssid_len: The length of the SSID, will always be non-zero.
1819 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1820 * search for IBSSs with a different BSSID.
1821 * @chandef: defines the channel to use if no other IBSS to join can be found
1822 * @channel_fixed: The channel should be fixed -- do not search for
1823 * IBSSs to join on other channels.
1824 * @ie: information element(s) to include in the beacon
1825 * @ie_len: length of that
1826 * @beacon_interval: beacon interval to use
1827 * @privacy: this is a protected network, keys will be configured
1828 * after joining
1829 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1830 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1831 * required to assume that the port is unauthorized until authorized by
1832 * user space. Otherwise, port is marked authorized by default.
1833 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1834 * changes the channel when a radar is detected. This is required
1835 * to operate on DFS channels.
1836 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1837 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1838 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1839 * will be used in ht_capa. Un-supported values will be ignored.
1840 * @ht_capa_mask: The bits of ht_capa which are to be used.
1841 */
1842struct cfg80211_ibss_params {
1843 const u8 *ssid;
1844 const u8 *bssid;
1845 struct cfg80211_chan_def chandef;
1846 const u8 *ie;
1847 u8 ssid_len, ie_len;
1848 u16 beacon_interval;
1849 u32 basic_rates;
1850 bool channel_fixed;
1851 bool privacy;
1852 bool control_port;
1853 bool userspace_handles_dfs;
1854 int mcast_rate[IEEE80211_NUM_BANDS];
1855 struct ieee80211_ht_cap ht_capa;
1856 struct ieee80211_ht_cap ht_capa_mask;
1857};
1858
1859/**
1860 * struct cfg80211_connect_params - Connection parameters
1861 *
1862 * This structure provides information needed to complete IEEE 802.11
1863 * authentication and association.
1864 *
1865 * @channel: The channel to use or %NULL if not specified (auto-select based
1866 * on scan results)
1867 * @channel_hint: The channel of the recommended BSS for initial connection or
1868 * %NULL if not specified
1869 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1870 * results)
1871 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1872 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1873 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1874 * to use.
1875 * @ssid: SSID
1876 * @ssid_len: Length of ssid in octets
1877 * @auth_type: Authentication type (algorithm)
1878 * @ie: IEs for association request
1879 * @ie_len: Length of assoc_ie in octets
1880 * @privacy: indicates whether privacy-enabled APs should be used
1881 * @mfp: indicate whether management frame protection is used
1882 * @crypto: crypto settings
1883 * @key_len: length of WEP key for shared key authentication
1884 * @key_idx: index of WEP key for shared key authentication
1885 * @key: WEP key for shared key authentication
1886 * @flags: See &enum cfg80211_assoc_req_flags
1887 * @bg_scan_period: Background scan period in seconds
1888 * or -1 to indicate that default value is to be used.
1889 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1890 * will be used in ht_capa. Un-supported values will be ignored.
1891 * @ht_capa_mask: The bits of ht_capa which are to be used.
1892 * @vht_capa: VHT Capability overrides
1893 * @vht_capa_mask: The bits of vht_capa which are to be used.
1894 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
1895 * networks.
1896 */
1897struct cfg80211_connect_params {
1898 struct ieee80211_channel *channel;
1899 struct ieee80211_channel *channel_hint;
1900 const u8 *bssid;
1901 const u8 *bssid_hint;
1902 const u8 *ssid;
1903 size_t ssid_len;
1904 enum nl80211_auth_type auth_type;
1905 const u8 *ie;
1906 size_t ie_len;
1907 bool privacy;
1908 enum nl80211_mfp mfp;
1909 struct cfg80211_crypto_settings crypto;
1910 const u8 *key;
1911 u8 key_len, key_idx;
1912 u32 flags;
1913 int bg_scan_period;
1914 struct ieee80211_ht_cap ht_capa;
1915 struct ieee80211_ht_cap ht_capa_mask;
1916 struct ieee80211_vht_cap vht_capa;
1917 struct ieee80211_vht_cap vht_capa_mask;
1918 bool pbss;
1919};
1920
1921/**
1922 * enum wiphy_params_flags - set_wiphy_params bitfield values
1923 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1924 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1925 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1926 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1927 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1928 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1929 */
1930enum wiphy_params_flags {
1931 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1932 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1933 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1934 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1935 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1936 WIPHY_PARAM_DYN_ACK = 1 << 5,
1937};
1938
1939/*
1940 * cfg80211_bitrate_mask - masks for bitrate control
1941 */
1942struct cfg80211_bitrate_mask {
1943 struct {
1944 u32 legacy;
1945 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1946 u16 vht_mcs[NL80211_VHT_NSS_MAX];
1947 enum nl80211_txrate_gi gi;
1948 } control[IEEE80211_NUM_BANDS];
1949};
1950/**
1951 * struct cfg80211_pmksa - PMK Security Association
1952 *
1953 * This structure is passed to the set/del_pmksa() method for PMKSA
1954 * caching.
1955 *
1956 * @bssid: The AP's BSSID.
1957 * @pmkid: The PMK material itself.
1958 */
1959struct cfg80211_pmksa {
1960 const u8 *bssid;
1961 const u8 *pmkid;
1962};
1963
1964/**
1965 * struct cfg80211_pkt_pattern - packet pattern
1966 * @mask: bitmask where to match pattern and where to ignore bytes,
1967 * one bit per byte, in same format as nl80211
1968 * @pattern: bytes to match where bitmask is 1
1969 * @pattern_len: length of pattern (in bytes)
1970 * @pkt_offset: packet offset (in bytes)
1971 *
1972 * Internal note: @mask and @pattern are allocated in one chunk of
1973 * memory, free @mask only!
1974 */
1975struct cfg80211_pkt_pattern {
1976 const u8 *mask, *pattern;
1977 int pattern_len;
1978 int pkt_offset;
1979};
1980
1981/**
1982 * struct cfg80211_wowlan_tcp - TCP connection parameters
1983 *
1984 * @sock: (internal) socket for source port allocation
1985 * @src: source IP address
1986 * @dst: destination IP address
1987 * @dst_mac: destination MAC address
1988 * @src_port: source port
1989 * @dst_port: destination port
1990 * @payload_len: data payload length
1991 * @payload: data payload buffer
1992 * @payload_seq: payload sequence stamping configuration
1993 * @data_interval: interval at which to send data packets
1994 * @wake_len: wakeup payload match length
1995 * @wake_data: wakeup payload match data
1996 * @wake_mask: wakeup payload match mask
1997 * @tokens_size: length of the tokens buffer
1998 * @payload_tok: payload token usage configuration
1999 */
2000struct cfg80211_wowlan_tcp {
2001 struct socket *sock;
2002 __be32 src, dst;
2003 u16 src_port, dst_port;
2004 u8 dst_mac[ETH_ALEN];
2005 int payload_len;
2006 const u8 *payload;
2007 struct nl80211_wowlan_tcp_data_seq payload_seq;
2008 u32 data_interval;
2009 u32 wake_len;
2010 const u8 *wake_data, *wake_mask;
2011 u32 tokens_size;
2012 /* must be last, variable member */
2013 struct nl80211_wowlan_tcp_data_token payload_tok;
2014};
2015
2016/**
2017 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2018 *
2019 * This structure defines the enabled WoWLAN triggers for the device.
2020 * @any: wake up on any activity -- special trigger if device continues
2021 * operating as normal during suspend
2022 * @disconnect: wake up if getting disconnected
2023 * @magic_pkt: wake up on receiving magic packet
2024 * @patterns: wake up on receiving packet matching a pattern
2025 * @n_patterns: number of patterns
2026 * @gtk_rekey_failure: wake up on GTK rekey failure
2027 * @eap_identity_req: wake up on EAP identity request packet
2028 * @four_way_handshake: wake up on 4-way handshake
2029 * @rfkill_release: wake up when rfkill is released
2030 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2031 * NULL if not configured.
2032 * @nd_config: configuration for the scan to be used for net detect wake.
2033 */
2034struct cfg80211_wowlan {
2035 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2036 eap_identity_req, four_way_handshake,
2037 rfkill_release;
2038 struct cfg80211_pkt_pattern *patterns;
2039 struct cfg80211_wowlan_tcp *tcp;
2040 int n_patterns;
2041 struct cfg80211_sched_scan_request *nd_config;
2042};
2043
2044/**
2045 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2046 *
2047 * This structure defines coalesce rule for the device.
2048 * @delay: maximum coalescing delay in msecs.
2049 * @condition: condition for packet coalescence.
2050 * see &enum nl80211_coalesce_condition.
2051 * @patterns: array of packet patterns
2052 * @n_patterns: number of patterns
2053 */
2054struct cfg80211_coalesce_rules {
2055 int delay;
2056 enum nl80211_coalesce_condition condition;
2057 struct cfg80211_pkt_pattern *patterns;
2058 int n_patterns;
2059};
2060
2061/**
2062 * struct cfg80211_coalesce - Packet coalescing settings
2063 *
2064 * This structure defines coalescing settings.
2065 * @rules: array of coalesce rules
2066 * @n_rules: number of rules
2067 */
2068struct cfg80211_coalesce {
2069 struct cfg80211_coalesce_rules *rules;
2070 int n_rules;
2071};
2072
2073/**
2074 * struct cfg80211_wowlan_nd_match - information about the match
2075 *
2076 * @ssid: SSID of the match that triggered the wake up
2077 * @n_channels: Number of channels where the match occurred. This
2078 * value may be zero if the driver can't report the channels.
2079 * @channels: center frequencies of the channels where a match
2080 * occurred (in MHz)
2081 */
2082struct cfg80211_wowlan_nd_match {
2083 struct cfg80211_ssid ssid;
2084 int n_channels;
2085 u32 channels[];
2086};
2087
2088/**
2089 * struct cfg80211_wowlan_nd_info - net detect wake up information
2090 *
2091 * @n_matches: Number of match information instances provided in
2092 * @matches. This value may be zero if the driver can't provide
2093 * match information.
2094 * @matches: Array of pointers to matches containing information about
2095 * the matches that triggered the wake up.
2096 */
2097struct cfg80211_wowlan_nd_info {
2098 int n_matches;
2099 struct cfg80211_wowlan_nd_match *matches[];
2100};
2101
2102/**
2103 * struct cfg80211_wowlan_wakeup - wakeup report
2104 * @disconnect: woke up by getting disconnected
2105 * @magic_pkt: woke up by receiving magic packet
2106 * @gtk_rekey_failure: woke up by GTK rekey failure
2107 * @eap_identity_req: woke up by EAP identity request packet
2108 * @four_way_handshake: woke up by 4-way handshake
2109 * @rfkill_release: woke up by rfkill being released
2110 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2111 * @packet_present_len: copied wakeup packet data
2112 * @packet_len: original wakeup packet length
2113 * @packet: The packet causing the wakeup, if any.
2114 * @packet_80211: For pattern match, magic packet and other data
2115 * frame triggers an 802.3 frame should be reported, for
2116 * disconnect due to deauth 802.11 frame. This indicates which
2117 * it is.
2118 * @tcp_match: TCP wakeup packet received
2119 * @tcp_connlost: TCP connection lost or failed to establish
2120 * @tcp_nomoretokens: TCP data ran out of tokens
2121 * @net_detect: if not %NULL, woke up because of net detect
2122 */
2123struct cfg80211_wowlan_wakeup {
2124 bool disconnect, magic_pkt, gtk_rekey_failure,
2125 eap_identity_req, four_way_handshake,
2126 rfkill_release, packet_80211,
2127 tcp_match, tcp_connlost, tcp_nomoretokens;
2128 s32 pattern_idx;
2129 u32 packet_present_len, packet_len;
2130 const void *packet;
2131 struct cfg80211_wowlan_nd_info *net_detect;
2132};
2133
2134/**
2135 * struct cfg80211_gtk_rekey_data - rekey data
2136 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2137 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2138 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2139 */
2140struct cfg80211_gtk_rekey_data {
2141 const u8 *kek, *kck, *replay_ctr;
2142};
2143
2144/**
2145 * struct cfg80211_update_ft_ies_params - FT IE Information
2146 *
2147 * This structure provides information needed to update the fast transition IE
2148 *
2149 * @md: The Mobility Domain ID, 2 Octet value
2150 * @ie: Fast Transition IEs
2151 * @ie_len: Length of ft_ie in octets
2152 */
2153struct cfg80211_update_ft_ies_params {
2154 u16 md;
2155 const u8 *ie;
2156 size_t ie_len;
2157};
2158
2159/**
2160 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2161 *
2162 * This structure provides information needed to transmit a mgmt frame
2163 *
2164 * @chan: channel to use
2165 * @offchan: indicates wether off channel operation is required
2166 * @wait: duration for ROC
2167 * @buf: buffer to transmit
2168 * @len: buffer length
2169 * @no_cck: don't use cck rates for this frame
2170 * @dont_wait_for_ack: tells the low level not to wait for an ack
2171 * @n_csa_offsets: length of csa_offsets array
2172 * @csa_offsets: array of all the csa offsets in the frame
2173 */
2174struct cfg80211_mgmt_tx_params {
2175 struct ieee80211_channel *chan;
2176 bool offchan;
2177 unsigned int wait;
2178 const u8 *buf;
2179 size_t len;
2180 bool no_cck;
2181 bool dont_wait_for_ack;
2182 int n_csa_offsets;
2183 const u16 *csa_offsets;
2184};
2185
2186/**
2187 * struct cfg80211_dscp_exception - DSCP exception
2188 *
2189 * @dscp: DSCP value that does not adhere to the user priority range definition
2190 * @up: user priority value to which the corresponding DSCP value belongs
2191 */
2192struct cfg80211_dscp_exception {
2193 u8 dscp;
2194 u8 up;
2195};
2196
2197/**
2198 * struct cfg80211_dscp_range - DSCP range definition for user priority
2199 *
2200 * @low: lowest DSCP value of this user priority range, inclusive
2201 * @high: highest DSCP value of this user priority range, inclusive
2202 */
2203struct cfg80211_dscp_range {
2204 u8 low;
2205 u8 high;
2206};
2207
2208/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2209#define IEEE80211_QOS_MAP_MAX_EX 21
2210#define IEEE80211_QOS_MAP_LEN_MIN 16
2211#define IEEE80211_QOS_MAP_LEN_MAX \
2212 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2213
2214/**
2215 * struct cfg80211_qos_map - QoS Map Information
2216 *
2217 * This struct defines the Interworking QoS map setting for DSCP values
2218 *
2219 * @num_des: number of DSCP exceptions (0..21)
2220 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2221 * the user priority DSCP range definition
2222 * @up: DSCP range definition for a particular user priority
2223 */
2224struct cfg80211_qos_map {
2225 u8 num_des;
2226 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2227 struct cfg80211_dscp_range up[8];
2228};
2229
2230/**
2231 * struct cfg80211_ops - backend description for wireless configuration
2232 *
2233 * This struct is registered by fullmac card drivers and/or wireless stacks
2234 * in order to handle configuration requests on their interfaces.
2235 *
2236 * All callbacks except where otherwise noted should return 0
2237 * on success or a negative error code.
2238 *
2239 * All operations are currently invoked under rtnl for consistency with the
2240 * wireless extensions but this is subject to reevaluation as soon as this
2241 * code is used more widely and we have a first user without wext.
2242 *
2243 * @suspend: wiphy device needs to be suspended. The variable @wow will
2244 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2245 * configured for the device.
2246 * @resume: wiphy device needs to be resumed
2247 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2248 * to call device_set_wakeup_enable() to enable/disable wakeup from
2249 * the device.
2250 *
2251 * @add_virtual_intf: create a new virtual interface with the given name,
2252 * must set the struct wireless_dev's iftype. Beware: You must create
2253 * the new netdev in the wiphy's network namespace! Returns the struct
2254 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2255 * also set the address member in the wdev.
2256 *
2257 * @del_virtual_intf: remove the virtual interface
2258 *
2259 * @change_virtual_intf: change type/configuration of virtual interface,
2260 * keep the struct wireless_dev's iftype updated.
2261 *
2262 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2263 * when adding a group key.
2264 *
2265 * @get_key: get information about the key with the given parameters.
2266 * @mac_addr will be %NULL when requesting information for a group
2267 * key. All pointers given to the @callback function need not be valid
2268 * after it returns. This function should return an error if it is
2269 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2270 *
2271 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2272 * and @key_index, return -ENOENT if the key doesn't exist.
2273 *
2274 * @set_default_key: set the default key on an interface
2275 *
2276 * @set_default_mgmt_key: set the default management frame key on an interface
2277 *
2278 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2279 *
2280 * @start_ap: Start acting in AP mode defined by the parameters.
2281 * @change_beacon: Change the beacon parameters for an access point mode
2282 * interface. This should reject the call when AP mode wasn't started.
2283 * @stop_ap: Stop being an AP, including stopping beaconing.
2284 *
2285 * @add_station: Add a new station.
2286 * @del_station: Remove a station
2287 * @change_station: Modify a given station. Note that flags changes are not much
2288 * validated in cfg80211, in particular the auth/assoc/authorized flags
2289 * might come to the driver in invalid combinations -- make sure to check
2290 * them, also against the existing state! Drivers must call
2291 * cfg80211_check_station_change() to validate the information.
2292 * @get_station: get station information for the station identified by @mac
2293 * @dump_station: dump station callback -- resume dump at index @idx
2294 *
2295 * @add_mpath: add a fixed mesh path
2296 * @del_mpath: delete a given mesh path
2297 * @change_mpath: change a given mesh path
2298 * @get_mpath: get a mesh path for the given parameters
2299 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2300 * @get_mpp: get a mesh proxy path for the given parameters
2301 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2302 * @join_mesh: join the mesh network with the specified parameters
2303 * (invoked with the wireless_dev mutex held)
2304 * @leave_mesh: leave the current mesh network
2305 * (invoked with the wireless_dev mutex held)
2306 *
2307 * @get_mesh_config: Get the current mesh configuration
2308 *
2309 * @update_mesh_config: Update mesh parameters on a running mesh.
2310 * The mask is a bitfield which tells us which parameters to
2311 * set, and which to leave alone.
2312 *
2313 * @change_bss: Modify parameters for a given BSS.
2314 *
2315 * @set_txq_params: Set TX queue parameters
2316 *
2317 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2318 * as it doesn't implement join_mesh and needs to set the channel to
2319 * join the mesh instead.
2320 *
2321 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2322 * interfaces are active this callback should reject the configuration.
2323 * If no interfaces are active or the device is down, the channel should
2324 * be stored for when a monitor interface becomes active.
2325 *
2326 * @scan: Request to do a scan. If returning zero, the scan request is given
2327 * the driver, and will be valid until passed to cfg80211_scan_done().
2328 * For scan results, call cfg80211_inform_bss(); you can call this outside
2329 * the scan/scan_done bracket too.
2330 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2331 * indicate the status of the scan through cfg80211_scan_done().
2332 *
2333 * @auth: Request to authenticate with the specified peer
2334 * (invoked with the wireless_dev mutex held)
2335 * @assoc: Request to (re)associate with the specified peer
2336 * (invoked with the wireless_dev mutex held)
2337 * @deauth: Request to deauthenticate from the specified peer
2338 * (invoked with the wireless_dev mutex held)
2339 * @disassoc: Request to disassociate from the specified peer
2340 * (invoked with the wireless_dev mutex held)
2341 *
2342 * @connect: Connect to the ESS with the specified parameters. When connected,
2343 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2344 * If the connection fails for some reason, call cfg80211_connect_result()
2345 * with the status from the AP.
2346 * (invoked with the wireless_dev mutex held)
2347 * @disconnect: Disconnect from the BSS/ESS.
2348 * (invoked with the wireless_dev mutex held)
2349 *
2350 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2351 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2352 * to a merge.
2353 * (invoked with the wireless_dev mutex held)
2354 * @leave_ibss: Leave the IBSS.
2355 * (invoked with the wireless_dev mutex held)
2356 *
2357 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2358 * MESH mode)
2359 *
2360 * @set_wiphy_params: Notify that wiphy parameters have changed;
2361 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2362 * have changed. The actual parameter values are available in
2363 * struct wiphy. If returning an error, no value should be changed.
2364 *
2365 * @set_tx_power: set the transmit power according to the parameters,
2366 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2367 * wdev may be %NULL if power was set for the wiphy, and will
2368 * always be %NULL unless the driver supports per-vif TX power
2369 * (as advertised by the nl80211 feature flag.)
2370 * @get_tx_power: store the current TX power into the dbm variable;
2371 * return 0 if successful
2372 *
2373 * @set_wds_peer: set the WDS peer for a WDS interface
2374 *
2375 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2376 * functions to adjust rfkill hw state
2377 *
2378 * @dump_survey: get site survey information.
2379 *
2380 * @remain_on_channel: Request the driver to remain awake on the specified
2381 * channel for the specified duration to complete an off-channel
2382 * operation (e.g., public action frame exchange). When the driver is
2383 * ready on the requested channel, it must indicate this with an event
2384 * notification by calling cfg80211_ready_on_channel().
2385 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2386 * This allows the operation to be terminated prior to timeout based on
2387 * the duration value.
2388 * @mgmt_tx: Transmit a management frame.
2389 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2390 * frame on another channel
2391 *
2392 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2393 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2394 * used by the function, but 0 and 1 must not be touched. Additionally,
2395 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2396 * dump and return to userspace with an error, so be careful. If any data
2397 * was passed in from userspace then the data/len arguments will be present
2398 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2399 *
2400 * @set_bitrate_mask: set the bitrate mask configuration
2401 *
2402 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2403 * devices running firmwares capable of generating the (re) association
2404 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2405 * @del_pmksa: Delete a cached PMKID.
2406 * @flush_pmksa: Flush all cached PMKIDs.
2407 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2408 * allows the driver to adjust the dynamic ps timeout value.
2409 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2410 * After configuration, the driver should (soon) send an event indicating
2411 * the current level is above/below the configured threshold; this may
2412 * need some care when the configuration is changed (without first being
2413 * disabled.)
2414 * @set_cqm_txe_config: Configure connection quality monitor TX error
2415 * thresholds.
2416 * @sched_scan_start: Tell the driver to start a scheduled scan.
2417 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2418 * call must stop the scheduled scan and be ready for starting a new one
2419 * before it returns, i.e. @sched_scan_start may be called immediately
2420 * after that again and should not fail in that case. The driver should
2421 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2422 * method returns 0.)
2423 *
2424 * @mgmt_frame_register: Notify driver that a management frame type was
2425 * registered. The callback is allowed to sleep.
2426 *
2427 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2428 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2429 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2430 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2431 *
2432 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2433 *
2434 * @tdls_mgmt: Transmit a TDLS management frame.
2435 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2436 *
2437 * @probe_client: probe an associated client, must return a cookie that it
2438 * later passes to cfg80211_probe_status().
2439 *
2440 * @set_noack_map: Set the NoAck Map for the TIDs.
2441 *
2442 * @get_channel: Get the current operating channel for the virtual interface.
2443 * For monitor interfaces, it should return %NULL unless there's a single
2444 * current monitoring channel.
2445 *
2446 * @start_p2p_device: Start the given P2P device.
2447 * @stop_p2p_device: Stop the given P2P device.
2448 *
2449 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2450 * Parameters include ACL policy, an array of MAC address of stations
2451 * and the number of MAC addresses. If there is already a list in driver
2452 * this new list replaces the existing one. Driver has to clear its ACL
2453 * when number of MAC addresses entries is passed as 0. Drivers which
2454 * advertise the support for MAC based ACL have to implement this callback.
2455 *
2456 * @start_radar_detection: Start radar detection in the driver.
2457 *
2458 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2459 * driver. If the SME is in the driver/firmware, this information can be
2460 * used in building Authentication and Reassociation Request frames.
2461 *
2462 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2463 * for a given duration (milliseconds). The protocol is provided so the
2464 * driver can take the most appropriate actions.
2465 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2466 * reliability. This operation can not fail.
2467 * @set_coalesce: Set coalesce parameters.
2468 *
2469 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2470 * responsible for veryfing if the switch is possible. Since this is
2471 * inherently tricky driver may decide to disconnect an interface later
2472 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2473 * everything. It should do it's best to verify requests and reject them
2474 * as soon as possible.
2475 *
2476 * @set_qos_map: Set QoS mapping information to the driver
2477 *
2478 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2479 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2480 * changes during the lifetime of the BSS.
2481 *
2482 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2483 * with the given parameters; action frame exchange has been handled by
2484 * userspace so this just has to modify the TX path to take the TS into
2485 * account.
2486 * If the admitted time is 0 just validate the parameters to make sure
2487 * the session can be created at all; it is valid to just always return
2488 * success for that but that may result in inefficient behaviour (handshake
2489 * with the peer followed by immediate teardown when the addition is later
2490 * rejected)
2491 * @del_tx_ts: remove an existing TX TS
2492 *
2493 * @join_ocb: join the OCB network with the specified parameters
2494 * (invoked with the wireless_dev mutex held)
2495 * @leave_ocb: leave the current OCB network
2496 * (invoked with the wireless_dev mutex held)
2497 *
2498 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2499 * is responsible for continually initiating channel-switching operations
2500 * and returning to the base channel for communication with the AP.
2501 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2502 * peers must be on the base channel when the call completes.
2503 */
2504struct cfg80211_ops {
2505 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2506 int (*resume)(struct wiphy *wiphy);
2507 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2508
2509 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2510 const char *name,
2511 unsigned char name_assign_type,
2512 enum nl80211_iftype type,
2513 u32 *flags,
2514 struct vif_params *params);
2515 int (*del_virtual_intf)(struct wiphy *wiphy,
2516 struct wireless_dev *wdev);
2517 int (*change_virtual_intf)(struct wiphy *wiphy,
2518 struct net_device *dev,
2519 enum nl80211_iftype type, u32 *flags,
2520 struct vif_params *params);
2521
2522 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2523 u8 key_index, bool pairwise, const u8 *mac_addr,
2524 struct key_params *params);
2525 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2526 u8 key_index, bool pairwise, const u8 *mac_addr,
2527 void *cookie,
2528 void (*callback)(void *cookie, struct key_params*));
2529 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2530 u8 key_index, bool pairwise, const u8 *mac_addr);
2531 int (*set_default_key)(struct wiphy *wiphy,
2532 struct net_device *netdev,
2533 u8 key_index, bool unicast, bool multicast);
2534 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2535 struct net_device *netdev,
2536 u8 key_index);
2537
2538 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2539 struct cfg80211_ap_settings *settings);
2540 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2541 struct cfg80211_beacon_data *info);
2542 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2543
2544
2545 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2546 const u8 *mac,
2547 struct station_parameters *params);
2548 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2549 struct station_del_parameters *params);
2550 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2551 const u8 *mac,
2552 struct station_parameters *params);
2553 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2554 const u8 *mac, struct station_info *sinfo);
2555 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2556 int idx, u8 *mac, struct station_info *sinfo);
2557
2558 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2559 const u8 *dst, const u8 *next_hop);
2560 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2561 const u8 *dst);
2562 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2563 const u8 *dst, const u8 *next_hop);
2564 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2565 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2566 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2567 int idx, u8 *dst, u8 *next_hop,
2568 struct mpath_info *pinfo);
2569 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2570 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2571 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2572 int idx, u8 *dst, u8 *mpp,
2573 struct mpath_info *pinfo);
2574 int (*get_mesh_config)(struct wiphy *wiphy,
2575 struct net_device *dev,
2576 struct mesh_config *conf);
2577 int (*update_mesh_config)(struct wiphy *wiphy,
2578 struct net_device *dev, u32 mask,
2579 const struct mesh_config *nconf);
2580 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2581 const struct mesh_config *conf,
2582 const struct mesh_setup *setup);
2583 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2584
2585 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2586 struct ocb_setup *setup);
2587 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2588
2589 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2590 struct bss_parameters *params);
2591
2592 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2593 struct ieee80211_txq_params *params);
2594
2595 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2596 struct net_device *dev,
2597 struct ieee80211_channel *chan);
2598
2599 int (*set_monitor_channel)(struct wiphy *wiphy,
2600 struct cfg80211_chan_def *chandef);
2601
2602 int (*scan)(struct wiphy *wiphy,
2603 struct cfg80211_scan_request *request);
2604 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
2605
2606 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2607 struct cfg80211_auth_request *req);
2608 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2609 struct cfg80211_assoc_request *req);
2610 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2611 struct cfg80211_deauth_request *req);
2612 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2613 struct cfg80211_disassoc_request *req);
2614
2615 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2616 struct cfg80211_connect_params *sme);
2617 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2618 u16 reason_code);
2619
2620 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2621 struct cfg80211_ibss_params *params);
2622 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2623
2624 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2625 int rate[IEEE80211_NUM_BANDS]);
2626
2627 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2628
2629 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2630 enum nl80211_tx_power_setting type, int mbm);
2631 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2632 int *dbm);
2633
2634 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2635 const u8 *addr);
2636
2637 void (*rfkill_poll)(struct wiphy *wiphy);
2638
2639#ifdef CONFIG_NL80211_TESTMODE
2640 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2641 void *data, int len);
2642 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2643 struct netlink_callback *cb,
2644 void *data, int len);
2645#endif
2646
2647 int (*set_bitrate_mask)(struct wiphy *wiphy,
2648 struct net_device *dev,
2649 const u8 *peer,
2650 const struct cfg80211_bitrate_mask *mask);
2651
2652 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2653 int idx, struct survey_info *info);
2654
2655 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2656 struct cfg80211_pmksa *pmksa);
2657 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2658 struct cfg80211_pmksa *pmksa);
2659 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2660
2661 int (*remain_on_channel)(struct wiphy *wiphy,
2662 struct wireless_dev *wdev,
2663 struct ieee80211_channel *chan,
2664 unsigned int duration,
2665 u64 *cookie);
2666 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2667 struct wireless_dev *wdev,
2668 u64 cookie);
2669
2670 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2671 struct cfg80211_mgmt_tx_params *params,
2672 u64 *cookie);
2673 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2674 struct wireless_dev *wdev,
2675 u64 cookie);
2676
2677 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2678 bool enabled, int timeout);
2679
2680 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2681 struct net_device *dev,
2682 s32 rssi_thold, u32 rssi_hyst);
2683
2684 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2685 struct net_device *dev,
2686 u32 rate, u32 pkts, u32 intvl);
2687
2688 void (*mgmt_frame_register)(struct wiphy *wiphy,
2689 struct wireless_dev *wdev,
2690 u16 frame_type, bool reg);
2691
2692 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2693 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2694
2695 int (*sched_scan_start)(struct wiphy *wiphy,
2696 struct net_device *dev,
2697 struct cfg80211_sched_scan_request *request);
2698 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2699
2700 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2701 struct cfg80211_gtk_rekey_data *data);
2702
2703 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2704 const u8 *peer, u8 action_code, u8 dialog_token,
2705 u16 status_code, u32 peer_capability,
2706 bool initiator, const u8 *buf, size_t len);
2707 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2708 const u8 *peer, enum nl80211_tdls_operation oper);
2709
2710 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2711 const u8 *peer, u64 *cookie);
2712
2713 int (*set_noack_map)(struct wiphy *wiphy,
2714 struct net_device *dev,
2715 u16 noack_map);
2716
2717 int (*get_channel)(struct wiphy *wiphy,
2718 struct wireless_dev *wdev,
2719 struct cfg80211_chan_def *chandef);
2720
2721 int (*start_p2p_device)(struct wiphy *wiphy,
2722 struct wireless_dev *wdev);
2723 void (*stop_p2p_device)(struct wiphy *wiphy,
2724 struct wireless_dev *wdev);
2725
2726 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2727 const struct cfg80211_acl_data *params);
2728
2729 int (*start_radar_detection)(struct wiphy *wiphy,
2730 struct net_device *dev,
2731 struct cfg80211_chan_def *chandef,
2732 u32 cac_time_ms);
2733 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2734 struct cfg80211_update_ft_ies_params *ftie);
2735 int (*crit_proto_start)(struct wiphy *wiphy,
2736 struct wireless_dev *wdev,
2737 enum nl80211_crit_proto_id protocol,
2738 u16 duration);
2739 void (*crit_proto_stop)(struct wiphy *wiphy,
2740 struct wireless_dev *wdev);
2741 int (*set_coalesce)(struct wiphy *wiphy,
2742 struct cfg80211_coalesce *coalesce);
2743
2744 int (*channel_switch)(struct wiphy *wiphy,
2745 struct net_device *dev,
2746 struct cfg80211_csa_settings *params);
2747
2748 int (*set_qos_map)(struct wiphy *wiphy,
2749 struct net_device *dev,
2750 struct cfg80211_qos_map *qos_map);
2751
2752 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2753 struct cfg80211_chan_def *chandef);
2754
2755 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2756 u8 tsid, const u8 *peer, u8 user_prio,
2757 u16 admitted_time);
2758 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2759 u8 tsid, const u8 *peer);
2760
2761 int (*tdls_channel_switch)(struct wiphy *wiphy,
2762 struct net_device *dev,
2763 const u8 *addr, u8 oper_class,
2764 struct cfg80211_chan_def *chandef);
2765 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2766 struct net_device *dev,
2767 const u8 *addr);
2768};
2769
2770/*
2771 * wireless hardware and networking interfaces structures
2772 * and registration/helper functions
2773 */
2774
2775/**
2776 * enum wiphy_flags - wiphy capability flags
2777 *
2778 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2779 * wiphy at all
2780 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2781 * by default -- this flag will be set depending on the kernel's default
2782 * on wiphy_new(), but can be changed by the driver if it has a good
2783 * reason to override the default
2784 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2785 * on a VLAN interface)
2786 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2787 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2788 * control port protocol ethertype. The device also honours the
2789 * control_port_no_encrypt flag.
2790 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2791 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2792 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2793 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2794 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2795 * firmware.
2796 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2797 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2798 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2799 * link setup/discovery operations internally. Setup, discovery and
2800 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2801 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2802 * used for asking the driver/firmware to perform a TDLS operation.
2803 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2804 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2805 * when there are virtual interfaces in AP mode by calling
2806 * cfg80211_report_obss_beacon().
2807 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2808 * responds to probe-requests in hardware.
2809 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2810 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2811 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2812 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2813 * beaconing mode (AP, IBSS, Mesh, ...).
2814 */
2815enum wiphy_flags {
2816 /* use hole at 0 */
2817 /* use hole at 1 */
2818 /* use hole at 2 */
2819 WIPHY_FLAG_NETNS_OK = BIT(3),
2820 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2821 WIPHY_FLAG_4ADDR_AP = BIT(5),
2822 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2823 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2824 WIPHY_FLAG_IBSS_RSN = BIT(8),
2825 WIPHY_FLAG_MESH_AUTH = BIT(10),
2826 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2827 /* use hole at 12 */
2828 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2829 WIPHY_FLAG_AP_UAPSD = BIT(14),
2830 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2831 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2832 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2833 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2834 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2835 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2836 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2837 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2838 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2839};
2840
2841/**
2842 * struct ieee80211_iface_limit - limit on certain interface types
2843 * @max: maximum number of interfaces of these types
2844 * @types: interface types (bits)
2845 */
2846struct ieee80211_iface_limit {
2847 u16 max;
2848 u16 types;
2849};
2850
2851/**
2852 * struct ieee80211_iface_combination - possible interface combination
2853 * @limits: limits for the given interface types
2854 * @n_limits: number of limitations
2855 * @num_different_channels: can use up to this many different channels
2856 * @max_interfaces: maximum number of interfaces in total allowed in this
2857 * group
2858 * @beacon_int_infra_match: In this combination, the beacon intervals
2859 * between infrastructure and AP types must match. This is required
2860 * only in special cases.
2861 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2862 * @radar_detect_regions: bitmap of regions supported for radar detection
2863 *
2864 * With this structure the driver can describe which interface
2865 * combinations it supports concurrently.
2866 *
2867 * Examples:
2868 *
2869 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2870 *
2871 * struct ieee80211_iface_limit limits1[] = {
2872 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2873 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2874 * };
2875 * struct ieee80211_iface_combination combination1 = {
2876 * .limits = limits1,
2877 * .n_limits = ARRAY_SIZE(limits1),
2878 * .max_interfaces = 2,
2879 * .beacon_int_infra_match = true,
2880 * };
2881 *
2882 *
2883 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2884 *
2885 * struct ieee80211_iface_limit limits2[] = {
2886 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2887 * BIT(NL80211_IFTYPE_P2P_GO), },
2888 * };
2889 * struct ieee80211_iface_combination combination2 = {
2890 * .limits = limits2,
2891 * .n_limits = ARRAY_SIZE(limits2),
2892 * .max_interfaces = 8,
2893 * .num_different_channels = 1,
2894 * };
2895 *
2896 *
2897 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2898 *
2899 * This allows for an infrastructure connection and three P2P connections.
2900 *
2901 * struct ieee80211_iface_limit limits3[] = {
2902 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2903 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2904 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2905 * };
2906 * struct ieee80211_iface_combination combination3 = {
2907 * .limits = limits3,
2908 * .n_limits = ARRAY_SIZE(limits3),
2909 * .max_interfaces = 4,
2910 * .num_different_channels = 2,
2911 * };
2912 */
2913struct ieee80211_iface_combination {
2914 const struct ieee80211_iface_limit *limits;
2915 u32 num_different_channels;
2916 u16 max_interfaces;
2917 u8 n_limits;
2918 bool beacon_int_infra_match;
2919 u8 radar_detect_widths;
2920 u8 radar_detect_regions;
2921};
2922
2923struct ieee80211_txrx_stypes {
2924 u16 tx, rx;
2925};
2926
2927/**
2928 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2929 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2930 * trigger that keeps the device operating as-is and
2931 * wakes up the host on any activity, for example a
2932 * received packet that passed filtering; note that the
2933 * packet should be preserved in that case
2934 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2935 * (see nl80211.h)
2936 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2937 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2938 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2939 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2940 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2941 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2942 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
2943 */
2944enum wiphy_wowlan_support_flags {
2945 WIPHY_WOWLAN_ANY = BIT(0),
2946 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2947 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2948 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2949 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2950 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2951 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2952 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2953 WIPHY_WOWLAN_NET_DETECT = BIT(8),
2954};
2955
2956struct wiphy_wowlan_tcp_support {
2957 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2958 u32 data_payload_max;
2959 u32 data_interval_max;
2960 u32 wake_payload_max;
2961 bool seq;
2962};
2963
2964/**
2965 * struct wiphy_wowlan_support - WoWLAN support data
2966 * @flags: see &enum wiphy_wowlan_support_flags
2967 * @n_patterns: number of supported wakeup patterns
2968 * (see nl80211.h for the pattern definition)
2969 * @pattern_max_len: maximum length of each pattern
2970 * @pattern_min_len: minimum length of each pattern
2971 * @max_pkt_offset: maximum Rx packet offset
2972 * @max_nd_match_sets: maximum number of matchsets for net-detect,
2973 * similar, but not necessarily identical, to max_match_sets for
2974 * scheduled scans.
2975 * See &struct cfg80211_sched_scan_request.@match_sets for more
2976 * details.
2977 * @tcp: TCP wakeup support information
2978 */
2979struct wiphy_wowlan_support {
2980 u32 flags;
2981 int n_patterns;
2982 int pattern_max_len;
2983 int pattern_min_len;
2984 int max_pkt_offset;
2985 int max_nd_match_sets;
2986 const struct wiphy_wowlan_tcp_support *tcp;
2987};
2988
2989/**
2990 * struct wiphy_coalesce_support - coalesce support data
2991 * @n_rules: maximum number of coalesce rules
2992 * @max_delay: maximum supported coalescing delay in msecs
2993 * @n_patterns: number of supported patterns in a rule
2994 * (see nl80211.h for the pattern definition)
2995 * @pattern_max_len: maximum length of each pattern
2996 * @pattern_min_len: minimum length of each pattern
2997 * @max_pkt_offset: maximum Rx packet offset
2998 */
2999struct wiphy_coalesce_support {
3000 int n_rules;
3001 int max_delay;
3002 int n_patterns;
3003 int pattern_max_len;
3004 int pattern_min_len;
3005 int max_pkt_offset;
3006};
3007
3008/**
3009 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3010 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3011 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3012 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3013 * (must be combined with %_WDEV or %_NETDEV)
3014 */
3015enum wiphy_vendor_command_flags {
3016 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3017 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3018 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3019};
3020
3021/**
3022 * struct wiphy_vendor_command - vendor command definition
3023 * @info: vendor command identifying information, as used in nl80211
3024 * @flags: flags, see &enum wiphy_vendor_command_flags
3025 * @doit: callback for the operation, note that wdev is %NULL if the
3026 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3027 * pointer may be %NULL if userspace provided no data at all
3028 * @dumpit: dump callback, for transferring bigger/multiple items. The
3029 * @storage points to cb->args[5], ie. is preserved over the multiple
3030 * dumpit calls.
3031 * It's recommended to not have the same sub command with both @doit and
3032 * @dumpit, so that userspace can assume certain ones are get and others
3033 * are used with dump requests.
3034 */
3035struct wiphy_vendor_command {
3036 struct nl80211_vendor_cmd_info info;
3037 u32 flags;
3038 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3039 const void *data, int data_len);
3040 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3041 struct sk_buff *skb, const void *data, int data_len,
3042 unsigned long *storage);
3043};
3044
3045/**
3046 * struct wiphy - wireless hardware description
3047 * @reg_notifier: the driver's regulatory notification callback,
3048 * note that if your driver uses wiphy_apply_custom_regulatory()
3049 * the reg_notifier's request can be passed as NULL
3050 * @regd: the driver's regulatory domain, if one was requested via
3051 * the regulatory_hint() API. This can be used by the driver
3052 * on the reg_notifier() if it chooses to ignore future
3053 * regulatory domain changes caused by other drivers.
3054 * @signal_type: signal type reported in &struct cfg80211_bss.
3055 * @cipher_suites: supported cipher suites
3056 * @n_cipher_suites: number of supported cipher suites
3057 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3058 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3059 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3060 * -1 = fragmentation disabled, only odd values >= 256 used
3061 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3062 * @_net: the network namespace this wiphy currently lives in
3063 * @perm_addr: permanent MAC address of this device
3064 * @addr_mask: If the device supports multiple MAC addresses by masking,
3065 * set this to a mask with variable bits set to 1, e.g. if the last
3066 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3067 * variable bits shall be determined by the interfaces added, with
3068 * interfaces not matching the mask being rejected to be brought up.
3069 * @n_addresses: number of addresses in @addresses.
3070 * @addresses: If the device has more than one address, set this pointer
3071 * to a list of addresses (6 bytes each). The first one will be used
3072 * by default for perm_addr. In this case, the mask should be set to
3073 * all-zeroes. In this case it is assumed that the device can handle
3074 * the same number of arbitrary MAC addresses.
3075 * @registered: protects ->resume and ->suspend sysfs callbacks against
3076 * unregister hardware
3077 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3078 * automatically on wiphy renames
3079 * @dev: (virtual) struct device for this wiphy
3080 * @registered: helps synchronize suspend/resume with wiphy unregister
3081 * @wext: wireless extension handlers
3082 * @priv: driver private data (sized according to wiphy_new() parameter)
3083 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3084 * must be set by driver
3085 * @iface_combinations: Valid interface combinations array, should not
3086 * list single interface types.
3087 * @n_iface_combinations: number of entries in @iface_combinations array.
3088 * @software_iftypes: bitmask of software interface types, these are not
3089 * subject to any restrictions since they are purely managed in SW.
3090 * @flags: wiphy flags, see &enum wiphy_flags
3091 * @regulatory_flags: wiphy regulatory flags, see
3092 * &enum ieee80211_regulatory_flags
3093 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3094 * @ext_features: extended features advertised to nl80211, see
3095 * &enum nl80211_ext_feature_index.
3096 * @bss_priv_size: each BSS struct has private data allocated with it,
3097 * this variable determines its size
3098 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3099 * any given scan
3100 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3101 * for in any given scheduled scan
3102 * @max_match_sets: maximum number of match sets the device can handle
3103 * when performing a scheduled scan, 0 if filtering is not
3104 * supported.
3105 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3106 * add to probe request frames transmitted during a scan, must not
3107 * include fixed IEs like supported rates
3108 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3109 * scans
3110 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3111 * of iterations) for scheduled scan supported by the device.
3112 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3113 * single scan plan supported by the device.
3114 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3115 * scan plan supported by the device.
3116 * @coverage_class: current coverage class
3117 * @fw_version: firmware version for ethtool reporting
3118 * @hw_version: hardware version for ethtool reporting
3119 * @max_num_pmkids: maximum number of PMKIDs supported by device
3120 * @privid: a pointer that drivers can use to identify if an arbitrary
3121 * wiphy is theirs, e.g. in global notifiers
3122 * @bands: information about bands/channels supported by this device
3123 *
3124 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3125 * transmitted through nl80211, points to an array indexed by interface
3126 * type
3127 *
3128 * @available_antennas_tx: bitmap of antennas which are available to be
3129 * configured as TX antennas. Antenna configuration commands will be
3130 * rejected unless this or @available_antennas_rx is set.
3131 *
3132 * @available_antennas_rx: bitmap of antennas which are available to be
3133 * configured as RX antennas. Antenna configuration commands will be
3134 * rejected unless this or @available_antennas_tx is set.
3135 *
3136 * @probe_resp_offload:
3137 * Bitmap of supported protocols for probe response offloading.
3138 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3139 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3140 *
3141 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3142 * may request, if implemented.
3143 *
3144 * @wowlan: WoWLAN support information
3145 * @wowlan_config: current WoWLAN configuration; this should usually not be
3146 * used since access to it is necessarily racy, use the parameter passed
3147 * to the suspend() operation instead.
3148 *
3149 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3150 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3151 * If null, then none can be over-ridden.
3152 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3153 * If null, then none can be over-ridden.
3154 *
3155 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3156 * supports for ACL.
3157 *
3158 * @extended_capabilities: extended capabilities supported by the driver,
3159 * additional capabilities might be supported by userspace; these are
3160 * the 802.11 extended capabilities ("Extended Capabilities element")
3161 * and are in the same format as in the information element. See
3162 * 802.11-2012 8.4.2.29 for the defined fields.
3163 * @extended_capabilities_mask: mask of the valid values
3164 * @extended_capabilities_len: length of the extended capabilities
3165 * @coalesce: packet coalescing support information
3166 *
3167 * @vendor_commands: array of vendor commands supported by the hardware
3168 * @n_vendor_commands: number of vendor commands
3169 * @vendor_events: array of vendor events supported by the hardware
3170 * @n_vendor_events: number of vendor events
3171 *
3172 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3173 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3174 * driver is allowed to advertise a theoretical limit that it can reach in
3175 * some cases, but may not always reach.
3176 *
3177 * @max_num_csa_counters: Number of supported csa_counters in beacons
3178 * and probe responses. This value should be set if the driver
3179 * wishes to limit the number of csa counters. Default (0) means
3180 * infinite.
3181 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3182 * frame was sent and the channel on which the frame was heard for which
3183 * the reported rssi is still valid. If a driver is able to compensate the
3184 * low rssi when a frame is heard on different channel, then it should set
3185 * this variable to the maximal offset for which it can compensate.
3186 * This value should be set in MHz.
3187 */
3188struct wiphy {
3189 /* assign these fields before you register the wiphy */
3190
3191 /* permanent MAC address(es) */
3192 u8 perm_addr[ETH_ALEN];
3193 u8 addr_mask[ETH_ALEN];
3194
3195 struct mac_address *addresses;
3196
3197 const struct ieee80211_txrx_stypes *mgmt_stypes;
3198
3199 const struct ieee80211_iface_combination *iface_combinations;
3200 int n_iface_combinations;
3201 u16 software_iftypes;
3202
3203 u16 n_addresses;
3204
3205 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3206 u16 interface_modes;
3207
3208 u16 max_acl_mac_addrs;
3209
3210 u32 flags, regulatory_flags, features;
3211 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3212
3213 u32 ap_sme_capa;
3214
3215 enum cfg80211_signal_type signal_type;
3216
3217 int bss_priv_size;
3218 u8 max_scan_ssids;
3219 u8 max_sched_scan_ssids;
3220 u8 max_match_sets;
3221 u16 max_scan_ie_len;
3222 u16 max_sched_scan_ie_len;
3223 u32 max_sched_scan_plans;
3224 u32 max_sched_scan_plan_interval;
3225 u32 max_sched_scan_plan_iterations;
3226
3227 int n_cipher_suites;
3228 const u32 *cipher_suites;
3229
3230 u8 retry_short;
3231 u8 retry_long;
3232 u32 frag_threshold;
3233 u32 rts_threshold;
3234 u8 coverage_class;
3235
3236 char fw_version[ETHTOOL_FWVERS_LEN];
3237 u32 hw_version;
3238
3239#ifdef CONFIG_PM
3240 const struct wiphy_wowlan_support *wowlan;
3241 struct cfg80211_wowlan *wowlan_config;
3242#endif
3243
3244 u16 max_remain_on_channel_duration;
3245
3246 u8 max_num_pmkids;
3247
3248 u32 available_antennas_tx;
3249 u32 available_antennas_rx;
3250
3251 /*
3252 * Bitmap of supported protocols for probe response offloading
3253 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3254 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3255 */
3256 u32 probe_resp_offload;
3257
3258 const u8 *extended_capabilities, *extended_capabilities_mask;
3259 u8 extended_capabilities_len;
3260
3261 /* If multiple wiphys are registered and you're handed e.g.
3262 * a regular netdev with assigned ieee80211_ptr, you won't
3263 * know whether it points to a wiphy your driver has registered
3264 * or not. Assign this to something global to your driver to
3265 * help determine whether you own this wiphy or not. */
3266 const void *privid;
3267
3268 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
3269
3270 /* Lets us get back the wiphy on the callback */
3271 void (*reg_notifier)(struct wiphy *wiphy,
3272 struct regulatory_request *request);
3273
3274 /* fields below are read-only, assigned by cfg80211 */
3275
3276 const struct ieee80211_regdomain __rcu *regd;
3277
3278 /* the item in /sys/class/ieee80211/ points to this,
3279 * you need use set_wiphy_dev() (see below) */
3280 struct device dev;
3281
3282 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3283 bool registered;
3284
3285 /* dir in debugfs: ieee80211/<wiphyname> */
3286 struct dentry *debugfsdir;
3287
3288 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3289 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3290
3291 /* the network namespace this phy lives in currently */
3292 possible_net_t _net;
3293
3294#ifdef CONFIG_CFG80211_WEXT
3295 const struct iw_handler_def *wext;
3296#endif
3297
3298 const struct wiphy_coalesce_support *coalesce;
3299
3300 const struct wiphy_vendor_command *vendor_commands;
3301 const struct nl80211_vendor_cmd_info *vendor_events;
3302 int n_vendor_commands, n_vendor_events;
3303
3304 u16 max_ap_assoc_sta;
3305
3306 u8 max_num_csa_counters;
3307 u8 max_adj_channel_rssi_comp;
3308
3309 char priv[0] __aligned(NETDEV_ALIGN);
3310};
3311
3312static inline struct net *wiphy_net(struct wiphy *wiphy)
3313{
3314 return read_pnet(&wiphy->_net);
3315}
3316
3317static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3318{
3319 write_pnet(&wiphy->_net, net);
3320}
3321
3322/**
3323 * wiphy_priv - return priv from wiphy
3324 *
3325 * @wiphy: the wiphy whose priv pointer to return
3326 * Return: The priv of @wiphy.
3327 */
3328static inline void *wiphy_priv(struct wiphy *wiphy)
3329{
3330 BUG_ON(!wiphy);
3331 return &wiphy->priv;
3332}
3333
3334/**
3335 * priv_to_wiphy - return the wiphy containing the priv
3336 *
3337 * @priv: a pointer previously returned by wiphy_priv
3338 * Return: The wiphy of @priv.
3339 */
3340static inline struct wiphy *priv_to_wiphy(void *priv)
3341{
3342 BUG_ON(!priv);
3343 return container_of(priv, struct wiphy, priv);
3344}
3345
3346/**
3347 * set_wiphy_dev - set device pointer for wiphy
3348 *
3349 * @wiphy: The wiphy whose device to bind
3350 * @dev: The device to parent it to
3351 */
3352static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3353{
3354 wiphy->dev.parent = dev;
3355}
3356
3357/**
3358 * wiphy_dev - get wiphy dev pointer
3359 *
3360 * @wiphy: The wiphy whose device struct to look up
3361 * Return: The dev of @wiphy.
3362 */
3363static inline struct device *wiphy_dev(struct wiphy *wiphy)
3364{
3365 return wiphy->dev.parent;
3366}
3367
3368/**
3369 * wiphy_name - get wiphy name
3370 *
3371 * @wiphy: The wiphy whose name to return
3372 * Return: The name of @wiphy.
3373 */
3374static inline const char *wiphy_name(const struct wiphy *wiphy)
3375{
3376 return dev_name(&wiphy->dev);
3377}
3378
3379/**
3380 * wiphy_new_nm - create a new wiphy for use with cfg80211
3381 *
3382 * @ops: The configuration operations for this device
3383 * @sizeof_priv: The size of the private area to allocate
3384 * @requested_name: Request a particular name.
3385 * NULL is valid value, and means use the default phy%d naming.
3386 *
3387 * Create a new wiphy and associate the given operations with it.
3388 * @sizeof_priv bytes are allocated for private use.
3389 *
3390 * Return: A pointer to the new wiphy. This pointer must be
3391 * assigned to each netdev's ieee80211_ptr for proper operation.
3392 */
3393struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3394 const char *requested_name);
3395
3396/**
3397 * wiphy_new - create a new wiphy for use with cfg80211
3398 *
3399 * @ops: The configuration operations for this device
3400 * @sizeof_priv: The size of the private area to allocate
3401 *
3402 * Create a new wiphy and associate the given operations with it.
3403 * @sizeof_priv bytes are allocated for private use.
3404 *
3405 * Return: A pointer to the new wiphy. This pointer must be
3406 * assigned to each netdev's ieee80211_ptr for proper operation.
3407 */
3408static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3409 int sizeof_priv)
3410{
3411 return wiphy_new_nm(ops, sizeof_priv, NULL);
3412}
3413
3414/**
3415 * wiphy_register - register a wiphy with cfg80211
3416 *
3417 * @wiphy: The wiphy to register.
3418 *
3419 * Return: A non-negative wiphy index or a negative error code.
3420 */
3421int wiphy_register(struct wiphy *wiphy);
3422
3423/**
3424 * wiphy_unregister - deregister a wiphy from cfg80211
3425 *
3426 * @wiphy: The wiphy to unregister.
3427 *
3428 * After this call, no more requests can be made with this priv
3429 * pointer, but the call may sleep to wait for an outstanding
3430 * request that is being handled.
3431 */
3432void wiphy_unregister(struct wiphy *wiphy);
3433
3434/**
3435 * wiphy_free - free wiphy
3436 *
3437 * @wiphy: The wiphy to free
3438 */
3439void wiphy_free(struct wiphy *wiphy);
3440
3441/* internal structs */
3442struct cfg80211_conn;
3443struct cfg80211_internal_bss;
3444struct cfg80211_cached_keys;
3445
3446/**
3447 * struct wireless_dev - wireless device state
3448 *
3449 * For netdevs, this structure must be allocated by the driver
3450 * that uses the ieee80211_ptr field in struct net_device (this
3451 * is intentional so it can be allocated along with the netdev.)
3452 * It need not be registered then as netdev registration will
3453 * be intercepted by cfg80211 to see the new wireless device.
3454 *
3455 * For non-netdev uses, it must also be allocated by the driver
3456 * in response to the cfg80211 callbacks that require it, as
3457 * there's no netdev registration in that case it may not be
3458 * allocated outside of callback operations that return it.
3459 *
3460 * @wiphy: pointer to hardware description
3461 * @iftype: interface type
3462 * @list: (private) Used to collect the interfaces
3463 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3464 * @identifier: (private) Identifier used in nl80211 to identify this
3465 * wireless device if it has no netdev
3466 * @current_bss: (private) Used by the internal configuration code
3467 * @chandef: (private) Used by the internal configuration code to track
3468 * the user-set channel definition.
3469 * @preset_chandef: (private) Used by the internal configuration code to
3470 * track the channel to be used for AP later
3471 * @bssid: (private) Used by the internal configuration code
3472 * @ssid: (private) Used by the internal configuration code
3473 * @ssid_len: (private) Used by the internal configuration code
3474 * @mesh_id_len: (private) Used by the internal configuration code
3475 * @mesh_id_up_len: (private) Used by the internal configuration code
3476 * @wext: (private) Used by the internal wireless extensions compat code
3477 * @use_4addr: indicates 4addr mode is used on this interface, must be
3478 * set by driver (if supported) on add_interface BEFORE registering the
3479 * netdev and may otherwise be used by driver read-only, will be update
3480 * by cfg80211 on change_interface
3481 * @mgmt_registrations: list of registrations for management frames
3482 * @mgmt_registrations_lock: lock for the list
3483 * @mtx: mutex used to lock data in this struct, may be used by drivers
3484 * and some API functions require it held
3485 * @beacon_interval: beacon interval used on this device for transmitting
3486 * beacons, 0 when not valid
3487 * @address: The address for this device, valid only if @netdev is %NULL
3488 * @p2p_started: true if this is a P2P Device that has been started
3489 * @cac_started: true if DFS channel availability check has been started
3490 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3491 * @cac_time_ms: CAC time in ms
3492 * @ps: powersave mode is enabled
3493 * @ps_timeout: dynamic powersave timeout
3494 * @ap_unexpected_nlportid: (private) netlink port ID of application
3495 * registered for unexpected class 3 frames (AP mode)
3496 * @conn: (private) cfg80211 software SME connection state machine data
3497 * @connect_keys: (private) keys to set after connection is established
3498 * @conn_bss_type: connecting/connected BSS type
3499 * @ibss_fixed: (private) IBSS is using fixed BSSID
3500 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3501 * @event_list: (private) list for internal event processing
3502 * @event_lock: (private) lock for event list
3503 * @owner_nlportid: (private) owner socket port ID
3504 */
3505struct wireless_dev {
3506 struct wiphy *wiphy;
3507 enum nl80211_iftype iftype;
3508
3509 /* the remainder of this struct should be private to cfg80211 */
3510 struct list_head list;
3511 struct net_device *netdev;
3512
3513 u32 identifier;
3514
3515 struct list_head mgmt_registrations;
3516 spinlock_t mgmt_registrations_lock;
3517
3518 struct mutex mtx;
3519
3520 bool use_4addr, p2p_started;
3521
3522 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3523
3524 /* currently used for IBSS and SME - might be rearranged later */
3525 u8 ssid[IEEE80211_MAX_SSID_LEN];
3526 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3527 struct cfg80211_conn *conn;
3528 struct cfg80211_cached_keys *connect_keys;
3529 enum ieee80211_bss_type conn_bss_type;
3530
3531 struct list_head event_list;
3532 spinlock_t event_lock;
3533
3534 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3535 struct cfg80211_chan_def preset_chandef;
3536 struct cfg80211_chan_def chandef;
3537
3538 bool ibss_fixed;
3539 bool ibss_dfs_possible;
3540
3541 bool ps;
3542 int ps_timeout;
3543
3544 int beacon_interval;
3545
3546 u32 ap_unexpected_nlportid;
3547
3548 bool cac_started;
3549 unsigned long cac_start_time;
3550 unsigned int cac_time_ms;
3551
3552 u32 owner_nlportid;
3553
3554#ifdef CONFIG_CFG80211_WEXT
3555 /* wext data */
3556 struct {
3557 struct cfg80211_ibss_params ibss;
3558 struct cfg80211_connect_params connect;
3559 struct cfg80211_cached_keys *keys;
3560 const u8 *ie;
3561 size_t ie_len;
3562 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3563 u8 ssid[IEEE80211_MAX_SSID_LEN];
3564 s8 default_key, default_mgmt_key;
3565 bool prev_bssid_valid;
3566 } wext;
3567#endif
3568};
3569
3570static inline u8 *wdev_address(struct wireless_dev *wdev)
3571{
3572 if (wdev->netdev)
3573 return wdev->netdev->dev_addr;
3574 return wdev->address;
3575}
3576
3577/**
3578 * wdev_priv - return wiphy priv from wireless_dev
3579 *
3580 * @wdev: The wireless device whose wiphy's priv pointer to return
3581 * Return: The wiphy priv of @wdev.
3582 */
3583static inline void *wdev_priv(struct wireless_dev *wdev)
3584{
3585 BUG_ON(!wdev);
3586 return wiphy_priv(wdev->wiphy);
3587}
3588
3589/**
3590 * DOC: Utility functions
3591 *
3592 * cfg80211 offers a number of utility functions that can be useful.
3593 */
3594
3595/**
3596 * ieee80211_channel_to_frequency - convert channel number to frequency
3597 * @chan: channel number
3598 * @band: band, necessary due to channel number overlap
3599 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3600 */
3601int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3602
3603/**
3604 * ieee80211_frequency_to_channel - convert frequency to channel number
3605 * @freq: center frequency
3606 * Return: The corresponding channel, or 0 if the conversion failed.
3607 */
3608int ieee80211_frequency_to_channel(int freq);
3609
3610/*
3611 * Name indirection necessary because the ieee80211 code also has
3612 * a function named "ieee80211_get_channel", so if you include
3613 * cfg80211's header file you get cfg80211's version, if you try
3614 * to include both header files you'll (rightfully!) get a symbol
3615 * clash.
3616 */
3617struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3618 int freq);
3619/**
3620 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3621 * @wiphy: the struct wiphy to get the channel for
3622 * @freq: the center frequency of the channel
3623 * Return: The channel struct from @wiphy at @freq.
3624 */
3625static inline struct ieee80211_channel *
3626ieee80211_get_channel(struct wiphy *wiphy, int freq)
3627{
3628 return __ieee80211_get_channel(wiphy, freq);
3629}
3630
3631/**
3632 * ieee80211_get_response_rate - get basic rate for a given rate
3633 *
3634 * @sband: the band to look for rates in
3635 * @basic_rates: bitmap of basic rates
3636 * @bitrate: the bitrate for which to find the basic rate
3637 *
3638 * Return: The basic rate corresponding to a given bitrate, that
3639 * is the next lower bitrate contained in the basic rate map,
3640 * which is, for this function, given as a bitmap of indices of
3641 * rates in the band's bitrate table.
3642 */
3643struct ieee80211_rate *
3644ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3645 u32 basic_rates, int bitrate);
3646
3647/**
3648 * ieee80211_mandatory_rates - get mandatory rates for a given band
3649 * @sband: the band to look for rates in
3650 * @scan_width: width of the control channel
3651 *
3652 * This function returns a bitmap of the mandatory rates for the given
3653 * band, bits are set according to the rate position in the bitrates array.
3654 */
3655u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3656 enum nl80211_bss_scan_width scan_width);
3657
3658/*
3659 * Radiotap parsing functions -- for controlled injection support
3660 *
3661 * Implemented in net/wireless/radiotap.c
3662 * Documentation in Documentation/networking/radiotap-headers.txt
3663 */
3664
3665struct radiotap_align_size {
3666 uint8_t align:4, size:4;
3667};
3668
3669struct ieee80211_radiotap_namespace {
3670 const struct radiotap_align_size *align_size;
3671 int n_bits;
3672 uint32_t oui;
3673 uint8_t subns;
3674};
3675
3676struct ieee80211_radiotap_vendor_namespaces {
3677 const struct ieee80211_radiotap_namespace *ns;
3678 int n_ns;
3679};
3680
3681/**
3682 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3683 * @this_arg_index: index of current arg, valid after each successful call
3684 * to ieee80211_radiotap_iterator_next()
3685 * @this_arg: pointer to current radiotap arg; it is valid after each
3686 * call to ieee80211_radiotap_iterator_next() but also after
3687 * ieee80211_radiotap_iterator_init() where it will point to
3688 * the beginning of the actual data portion
3689 * @this_arg_size: length of the current arg, for convenience
3690 * @current_namespace: pointer to the current namespace definition
3691 * (or internally %NULL if the current namespace is unknown)
3692 * @is_radiotap_ns: indicates whether the current namespace is the default
3693 * radiotap namespace or not
3694 *
3695 * @_rtheader: pointer to the radiotap header we are walking through
3696 * @_max_length: length of radiotap header in cpu byte ordering
3697 * @_arg_index: next argument index
3698 * @_arg: next argument pointer
3699 * @_next_bitmap: internal pointer to next present u32
3700 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3701 * @_vns: vendor namespace definitions
3702 * @_next_ns_data: beginning of the next namespace's data
3703 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3704 * next bitmap word
3705 *
3706 * Describes the radiotap parser state. Fields prefixed with an underscore
3707 * must not be used by users of the parser, only by the parser internally.
3708 */
3709
3710struct ieee80211_radiotap_iterator {
3711 struct ieee80211_radiotap_header *_rtheader;
3712 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3713 const struct ieee80211_radiotap_namespace *current_namespace;
3714
3715 unsigned char *_arg, *_next_ns_data;
3716 __le32 *_next_bitmap;
3717
3718 unsigned char *this_arg;
3719 int this_arg_index;
3720 int this_arg_size;
3721
3722 int is_radiotap_ns;
3723
3724 int _max_length;
3725 int _arg_index;
3726 uint32_t _bitmap_shifter;
3727 int _reset_on_ext;
3728};
3729
3730int
3731ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3732 struct ieee80211_radiotap_header *radiotap_header,
3733 int max_length,
3734 const struct ieee80211_radiotap_vendor_namespaces *vns);
3735
3736int
3737ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3738
3739
3740extern const unsigned char rfc1042_header[6];
3741extern const unsigned char bridge_tunnel_header[6];
3742
3743/**
3744 * ieee80211_get_hdrlen_from_skb - get header length from data
3745 *
3746 * @skb: the frame
3747 *
3748 * Given an skb with a raw 802.11 header at the data pointer this function
3749 * returns the 802.11 header length.
3750 *
3751 * Return: The 802.11 header length in bytes (not including encryption
3752 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3753 * 802.11 header.
3754 */
3755unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3756
3757/**
3758 * ieee80211_hdrlen - get header length in bytes from frame control
3759 * @fc: frame control field in little-endian format
3760 * Return: The header length in bytes.
3761 */
3762unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3763
3764/**
3765 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3766 * @meshhdr: the mesh extension header, only the flags field
3767 * (first byte) will be accessed
3768 * Return: The length of the extension header, which is always at
3769 * least 6 bytes and at most 18 if address 5 and 6 are present.
3770 */
3771unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3772
3773/**
3774 * DOC: Data path helpers
3775 *
3776 * In addition to generic utilities, cfg80211 also offers
3777 * functions that help implement the data path for devices
3778 * that do not do the 802.11/802.3 conversion on the device.
3779 */
3780
3781/**
3782 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3783 * @skb: the 802.11 data frame
3784 * @addr: the device MAC address
3785 * @iftype: the virtual interface type
3786 * Return: 0 on success. Non-zero on error.
3787 */
3788int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3789 enum nl80211_iftype iftype);
3790
3791/**
3792 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3793 * @skb: the 802.3 frame
3794 * @addr: the device MAC address
3795 * @iftype: the virtual interface type
3796 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3797 * @qos: build 802.11 QoS data frame
3798 * Return: 0 on success, or a negative error code.
3799 */
3800int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3801 enum nl80211_iftype iftype, const u8 *bssid,
3802 bool qos);
3803
3804/**
3805 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3806 *
3807 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3808 * 802.3 frames. The @list will be empty if the decode fails. The
3809 * @skb is consumed after the function returns.
3810 *
3811 * @skb: The input IEEE 802.11n A-MSDU frame.
3812 * @list: The output list of 802.3 frames. It must be allocated and
3813 * initialized by by the caller.
3814 * @addr: The device MAC address.
3815 * @iftype: The device interface type.
3816 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3817 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3818 */
3819void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3820 const u8 *addr, enum nl80211_iftype iftype,
3821 const unsigned int extra_headroom,
3822 bool has_80211_header);
3823
3824/**
3825 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3826 * @skb: the data frame
3827 * @qos_map: Interworking QoS mapping or %NULL if not in use
3828 * Return: The 802.1p/1d tag.
3829 */
3830unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3831 struct cfg80211_qos_map *qos_map);
3832
3833/**
3834 * cfg80211_find_ie - find information element in data
3835 *
3836 * @eid: element ID
3837 * @ies: data consisting of IEs
3838 * @len: length of data
3839 *
3840 * Return: %NULL if the element ID could not be found or if
3841 * the element is invalid (claims to be longer than the given
3842 * data), or a pointer to the first byte of the requested
3843 * element, that is the byte containing the element ID.
3844 *
3845 * Note: There are no checks on the element length other than
3846 * having to fit into the given data.
3847 */
3848const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3849
3850/**
3851 * cfg80211_find_vendor_ie - find vendor specific information element in data
3852 *
3853 * @oui: vendor OUI
3854 * @oui_type: vendor-specific OUI type
3855 * @ies: data consisting of IEs
3856 * @len: length of data
3857 *
3858 * Return: %NULL if the vendor specific element ID could not be found or if the
3859 * element is invalid (claims to be longer than the given data), or a pointer to
3860 * the first byte of the requested element, that is the byte containing the
3861 * element ID.
3862 *
3863 * Note: There are no checks on the element length other than having to fit into
3864 * the given data.
3865 */
3866const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3867 const u8 *ies, int len);
3868
3869/**
3870 * DOC: Regulatory enforcement infrastructure
3871 *
3872 * TODO
3873 */
3874
3875/**
3876 * regulatory_hint - driver hint to the wireless core a regulatory domain
3877 * @wiphy: the wireless device giving the hint (used only for reporting
3878 * conflicts)
3879 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3880 * should be in. If @rd is set this should be NULL. Note that if you
3881 * set this to NULL you should still set rd->alpha2 to some accepted
3882 * alpha2.
3883 *
3884 * Wireless drivers can use this function to hint to the wireless core
3885 * what it believes should be the current regulatory domain by
3886 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3887 * domain should be in or by providing a completely build regulatory domain.
3888 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3889 * for a regulatory domain structure for the respective country.
3890 *
3891 * The wiphy must have been registered to cfg80211 prior to this call.
3892 * For cfg80211 drivers this means you must first use wiphy_register(),
3893 * for mac80211 drivers you must first use ieee80211_register_hw().
3894 *
3895 * Drivers should check the return value, its possible you can get
3896 * an -ENOMEM.
3897 *
3898 * Return: 0 on success. -ENOMEM.
3899 */
3900int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3901
3902/**
3903 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
3904 * @wiphy: the wireless device we want to process the regulatory domain on
3905 * @rd: the regulatory domain informatoin to use for this wiphy
3906 *
3907 * Set the regulatory domain information for self-managed wiphys, only they
3908 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
3909 * information.
3910 *
3911 * Return: 0 on success. -EINVAL, -EPERM
3912 */
3913int regulatory_set_wiphy_regd(struct wiphy *wiphy,
3914 struct ieee80211_regdomain *rd);
3915
3916/**
3917 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
3918 * @wiphy: the wireless device we want to process the regulatory domain on
3919 * @rd: the regulatory domain information to use for this wiphy
3920 *
3921 * This functions requires the RTNL to be held and applies the new regdomain
3922 * synchronously to this wiphy. For more details see
3923 * regulatory_set_wiphy_regd().
3924 *
3925 * Return: 0 on success. -EINVAL, -EPERM
3926 */
3927int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
3928 struct ieee80211_regdomain *rd);
3929
3930/**
3931 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3932 * @wiphy: the wireless device we want to process the regulatory domain on
3933 * @regd: the custom regulatory domain to use for this wiphy
3934 *
3935 * Drivers can sometimes have custom regulatory domains which do not apply
3936 * to a specific country. Drivers can use this to apply such custom regulatory
3937 * domains. This routine must be called prior to wiphy registration. The
3938 * custom regulatory domain will be trusted completely and as such previous
3939 * default channel settings will be disregarded. If no rule is found for a
3940 * channel on the regulatory domain the channel will be disabled.
3941 * Drivers using this for a wiphy should also set the wiphy flag
3942 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
3943 * that called this helper.
3944 */
3945void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3946 const struct ieee80211_regdomain *regd);
3947
3948/**
3949 * freq_reg_info - get regulatory information for the given frequency
3950 * @wiphy: the wiphy for which we want to process this rule for
3951 * @center_freq: Frequency in KHz for which we want regulatory information for
3952 *
3953 * Use this function to get the regulatory rule for a specific frequency on
3954 * a given wireless device. If the device has a specific regulatory domain
3955 * it wants to follow we respect that unless a country IE has been received
3956 * and processed already.
3957 *
3958 * Return: A valid pointer, or, when an error occurs, for example if no rule
3959 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3960 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3961 * value will be -ERANGE if we determine the given center_freq does not even
3962 * have a regulatory rule for a frequency range in the center_freq's band.
3963 * See freq_in_rule_band() for our current definition of a band -- this is
3964 * purely subjective and right now it's 802.11 specific.
3965 */
3966const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3967 u32 center_freq);
3968
3969/**
3970 * reg_initiator_name - map regulatory request initiator enum to name
3971 * @initiator: the regulatory request initiator
3972 *
3973 * You can use this to map the regulatory request initiator enum to a
3974 * proper string representation.
3975 */
3976const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3977
3978/*
3979 * callbacks for asynchronous cfg80211 methods, notification
3980 * functions and BSS handling helpers
3981 */
3982
3983/**
3984 * cfg80211_scan_done - notify that scan finished
3985 *
3986 * @request: the corresponding scan request
3987 * @aborted: set to true if the scan was aborted for any reason,
3988 * userspace will be notified of that
3989 */
3990void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3991
3992/**
3993 * cfg80211_sched_scan_results - notify that new scan results are available
3994 *
3995 * @wiphy: the wiphy which got scheduled scan results
3996 */
3997void cfg80211_sched_scan_results(struct wiphy *wiphy);
3998
3999/**
4000 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4001 *
4002 * @wiphy: the wiphy on which the scheduled scan stopped
4003 *
4004 * The driver can call this function to inform cfg80211 that the
4005 * scheduled scan had to be stopped, for whatever reason. The driver
4006 * is then called back via the sched_scan_stop operation when done.
4007 */
4008void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
4009
4010/**
4011 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4012 *
4013 * @wiphy: the wiphy on which the scheduled scan stopped
4014 *
4015 * The driver can call this function to inform cfg80211 that the
4016 * scheduled scan had to be stopped, for whatever reason. The driver
4017 * is then called back via the sched_scan_stop operation when done.
4018 * This function should be called with rtnl locked.
4019 */
4020void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
4021
4022/**
4023 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4024 * @wiphy: the wiphy reporting the BSS
4025 * @data: the BSS metadata
4026 * @mgmt: the management frame (probe response or beacon)
4027 * @len: length of the management frame
4028 * @gfp: context flags
4029 *
4030 * This informs cfg80211 that BSS information was found and
4031 * the BSS should be updated/added.
4032 *
4033 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4034 * Or %NULL on error.
4035 */
4036struct cfg80211_bss * __must_check
4037cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4038 struct cfg80211_inform_bss *data,
4039 struct ieee80211_mgmt *mgmt, size_t len,
4040 gfp_t gfp);
4041
4042static inline struct cfg80211_bss * __must_check
4043cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4044 struct ieee80211_channel *rx_channel,
4045 enum nl80211_bss_scan_width scan_width,
4046 struct ieee80211_mgmt *mgmt, size_t len,
4047 s32 signal, gfp_t gfp)
4048{
4049 struct cfg80211_inform_bss data = {
4050 .chan = rx_channel,
4051 .scan_width = scan_width,
4052 .signal = signal,
4053 };
4054
4055 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4056}
4057
4058static inline struct cfg80211_bss * __must_check
4059cfg80211_inform_bss_frame(struct wiphy *wiphy,
4060 struct ieee80211_channel *rx_channel,
4061 struct ieee80211_mgmt *mgmt, size_t len,
4062 s32 signal, gfp_t gfp)
4063{
4064 struct cfg80211_inform_bss data = {
4065 .chan = rx_channel,
4066 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4067 .signal = signal,
4068 };
4069
4070 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4071}
4072
4073/**
4074 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4075 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4076 * from a beacon or probe response
4077 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4078 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4079 */
4080enum cfg80211_bss_frame_type {
4081 CFG80211_BSS_FTYPE_UNKNOWN,
4082 CFG80211_BSS_FTYPE_BEACON,
4083 CFG80211_BSS_FTYPE_PRESP,
4084};
4085
4086/**
4087 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4088 *
4089 * @wiphy: the wiphy reporting the BSS
4090 * @data: the BSS metadata
4091 * @ftype: frame type (if known)
4092 * @bssid: the BSSID of the BSS
4093 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4094 * @capability: the capability field sent by the peer
4095 * @beacon_interval: the beacon interval announced by the peer
4096 * @ie: additional IEs sent by the peer
4097 * @ielen: length of the additional IEs
4098 * @gfp: context flags
4099 *
4100 * This informs cfg80211 that BSS information was found and
4101 * the BSS should be updated/added.
4102 *
4103 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4104 * Or %NULL on error.
4105 */
4106struct cfg80211_bss * __must_check
4107cfg80211_inform_bss_data(struct wiphy *wiphy,
4108 struct cfg80211_inform_bss *data,
4109 enum cfg80211_bss_frame_type ftype,
4110 const u8 *bssid, u64 tsf, u16 capability,
4111 u16 beacon_interval, const u8 *ie, size_t ielen,
4112 gfp_t gfp);
4113
4114static inline struct cfg80211_bss * __must_check
4115cfg80211_inform_bss_width(struct wiphy *wiphy,
4116 struct ieee80211_channel *rx_channel,
4117 enum nl80211_bss_scan_width scan_width,
4118 enum cfg80211_bss_frame_type ftype,
4119 const u8 *bssid, u64 tsf, u16 capability,
4120 u16 beacon_interval, const u8 *ie, size_t ielen,
4121 s32 signal, gfp_t gfp)
4122{
4123 struct cfg80211_inform_bss data = {
4124 .chan = rx_channel,
4125 .scan_width = scan_width,
4126 .signal = signal,
4127 };
4128
4129 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4130 capability, beacon_interval, ie, ielen,
4131 gfp);
4132}
4133
4134static inline struct cfg80211_bss * __must_check
4135cfg80211_inform_bss(struct wiphy *wiphy,
4136 struct ieee80211_channel *rx_channel,
4137 enum cfg80211_bss_frame_type ftype,
4138 const u8 *bssid, u64 tsf, u16 capability,
4139 u16 beacon_interval, const u8 *ie, size_t ielen,
4140 s32 signal, gfp_t gfp)
4141{
4142 struct cfg80211_inform_bss data = {
4143 .chan = rx_channel,
4144 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4145 .signal = signal,
4146 };
4147
4148 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4149 capability, beacon_interval, ie, ielen,
4150 gfp);
4151}
4152
4153struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4154 struct ieee80211_channel *channel,
4155 const u8 *bssid,
4156 const u8 *ssid, size_t ssid_len,
4157 enum ieee80211_bss_type bss_type,
4158 enum ieee80211_privacy);
4159static inline struct cfg80211_bss *
4160cfg80211_get_ibss(struct wiphy *wiphy,
4161 struct ieee80211_channel *channel,
4162 const u8 *ssid, size_t ssid_len)
4163{
4164 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4165 IEEE80211_BSS_TYPE_IBSS,
4166 IEEE80211_PRIVACY_ANY);
4167}
4168
4169/**
4170 * cfg80211_ref_bss - reference BSS struct
4171 * @wiphy: the wiphy this BSS struct belongs to
4172 * @bss: the BSS struct to reference
4173 *
4174 * Increments the refcount of the given BSS struct.
4175 */
4176void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4177
4178/**
4179 * cfg80211_put_bss - unref BSS struct
4180 * @wiphy: the wiphy this BSS struct belongs to
4181 * @bss: the BSS struct
4182 *
4183 * Decrements the refcount of the given BSS struct.
4184 */
4185void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4186
4187/**
4188 * cfg80211_unlink_bss - unlink BSS from internal data structures
4189 * @wiphy: the wiphy
4190 * @bss: the bss to remove
4191 *
4192 * This function removes the given BSS from the internal data structures
4193 * thereby making it no longer show up in scan results etc. Use this
4194 * function when you detect a BSS is gone. Normally BSSes will also time
4195 * out, so it is not necessary to use this function at all.
4196 */
4197void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4198
4199static inline enum nl80211_bss_scan_width
4200cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4201{
4202 switch (chandef->width) {
4203 case NL80211_CHAN_WIDTH_5:
4204 return NL80211_BSS_CHAN_WIDTH_5;
4205 case NL80211_CHAN_WIDTH_10:
4206 return NL80211_BSS_CHAN_WIDTH_10;
4207 default:
4208 return NL80211_BSS_CHAN_WIDTH_20;
4209 }
4210}
4211
4212/**
4213 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4214 * @dev: network device
4215 * @buf: authentication frame (header + body)
4216 * @len: length of the frame data
4217 *
4218 * This function is called whenever an authentication, disassociation or
4219 * deauthentication frame has been received and processed in station mode.
4220 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4221 * call either this function or cfg80211_auth_timeout().
4222 * After being asked to associate via cfg80211_ops::assoc() the driver must
4223 * call either this function or cfg80211_auth_timeout().
4224 * While connected, the driver must calls this for received and processed
4225 * disassociation and deauthentication frames. If the frame couldn't be used
4226 * because it was unprotected, the driver must call the function
4227 * cfg80211_rx_unprot_mlme_mgmt() instead.
4228 *
4229 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4230 */
4231void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4232
4233/**
4234 * cfg80211_auth_timeout - notification of timed out authentication
4235 * @dev: network device
4236 * @addr: The MAC address of the device with which the authentication timed out
4237 *
4238 * This function may sleep. The caller must hold the corresponding wdev's
4239 * mutex.
4240 */
4241void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4242
4243/**
4244 * cfg80211_rx_assoc_resp - notification of processed association response
4245 * @dev: network device
4246 * @bss: the BSS that association was requested with, ownership of the pointer
4247 * moves to cfg80211 in this call
4248 * @buf: authentication frame (header + body)
4249 * @len: length of the frame data
4250 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4251 *
4252 * After being asked to associate via cfg80211_ops::assoc() the driver must
4253 * call either this function or cfg80211_auth_timeout().
4254 *
4255 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4256 */
4257void cfg80211_rx_assoc_resp(struct net_device *dev,
4258 struct cfg80211_bss *bss,
4259 const u8 *buf, size_t len,
4260 int uapsd_queues);
4261
4262/**
4263 * cfg80211_assoc_timeout - notification of timed out association
4264 * @dev: network device
4265 * @bss: The BSS entry with which association timed out.
4266 *
4267 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4268 */
4269void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4270
4271/**
4272 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4273 * @dev: network device
4274 * @buf: 802.11 frame (header + body)
4275 * @len: length of the frame data
4276 *
4277 * This function is called whenever deauthentication has been processed in
4278 * station mode. This includes both received deauthentication frames and
4279 * locally generated ones. This function may sleep. The caller must hold the
4280 * corresponding wdev's mutex.
4281 */
4282void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4283
4284/**
4285 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4286 * @dev: network device
4287 * @buf: deauthentication frame (header + body)
4288 * @len: length of the frame data
4289 *
4290 * This function is called whenever a received deauthentication or dissassoc
4291 * frame has been dropped in station mode because of MFP being used but the
4292 * frame was not protected. This function may sleep.
4293 */
4294void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4295 const u8 *buf, size_t len);
4296
4297/**
4298 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4299 * @dev: network device
4300 * @addr: The source MAC address of the frame
4301 * @key_type: The key type that the received frame used
4302 * @key_id: Key identifier (0..3). Can be -1 if missing.
4303 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4304 * @gfp: allocation flags
4305 *
4306 * This function is called whenever the local MAC detects a MIC failure in a
4307 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4308 * primitive.
4309 */
4310void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4311 enum nl80211_key_type key_type, int key_id,
4312 const u8 *tsc, gfp_t gfp);
4313
4314/**
4315 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4316 *
4317 * @dev: network device
4318 * @bssid: the BSSID of the IBSS joined
4319 * @channel: the channel of the IBSS joined
4320 * @gfp: allocation flags
4321 *
4322 * This function notifies cfg80211 that the device joined an IBSS or
4323 * switched to a different BSSID. Before this function can be called,
4324 * either a beacon has to have been received from the IBSS, or one of
4325 * the cfg80211_inform_bss{,_frame} functions must have been called
4326 * with the locally generated beacon -- this guarantees that there is
4327 * always a scan result for this IBSS. cfg80211 will handle the rest.
4328 */
4329void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4330 struct ieee80211_channel *channel, gfp_t gfp);
4331
4332/**
4333 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4334 *
4335 * @dev: network device
4336 * @macaddr: the MAC address of the new candidate
4337 * @ie: information elements advertised by the peer candidate
4338 * @ie_len: lenght of the information elements buffer
4339 * @gfp: allocation flags
4340 *
4341 * This function notifies cfg80211 that the mesh peer candidate has been
4342 * detected, most likely via a beacon or, less likely, via a probe response.
4343 * cfg80211 then sends a notification to userspace.
4344 */
4345void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4346 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4347
4348/**
4349 * DOC: RFkill integration
4350 *
4351 * RFkill integration in cfg80211 is almost invisible to drivers,
4352 * as cfg80211 automatically registers an rfkill instance for each
4353 * wireless device it knows about. Soft kill is also translated
4354 * into disconnecting and turning all interfaces off, drivers are
4355 * expected to turn off the device when all interfaces are down.
4356 *
4357 * However, devices may have a hard RFkill line, in which case they
4358 * also need to interact with the rfkill subsystem, via cfg80211.
4359 * They can do this with a few helper functions documented here.
4360 */
4361
4362/**
4363 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4364 * @wiphy: the wiphy
4365 * @blocked: block status
4366 */
4367void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4368
4369/**
4370 * wiphy_rfkill_start_polling - start polling rfkill
4371 * @wiphy: the wiphy
4372 */
4373void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4374
4375/**
4376 * wiphy_rfkill_stop_polling - stop polling rfkill
4377 * @wiphy: the wiphy
4378 */
4379void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4380
4381/**
4382 * DOC: Vendor commands
4383 *
4384 * Occasionally, there are special protocol or firmware features that
4385 * can't be implemented very openly. For this and similar cases, the
4386 * vendor command functionality allows implementing the features with
4387 * (typically closed-source) userspace and firmware, using nl80211 as
4388 * the configuration mechanism.
4389 *
4390 * A driver supporting vendor commands must register them as an array
4391 * in struct wiphy, with handlers for each one, each command has an
4392 * OUI and sub command ID to identify it.
4393 *
4394 * Note that this feature should not be (ab)used to implement protocol
4395 * features that could openly be shared across drivers. In particular,
4396 * it must never be required to use vendor commands to implement any
4397 * "normal" functionality that higher-level userspace like connection
4398 * managers etc. need.
4399 */
4400
4401struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4402 enum nl80211_commands cmd,
4403 enum nl80211_attrs attr,
4404 int approxlen);
4405
4406struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4407 struct wireless_dev *wdev,
4408 enum nl80211_commands cmd,
4409 enum nl80211_attrs attr,
4410 int vendor_event_idx,
4411 int approxlen, gfp_t gfp);
4412
4413void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4414
4415/**
4416 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4417 * @wiphy: the wiphy
4418 * @approxlen: an upper bound of the length of the data that will
4419 * be put into the skb
4420 *
4421 * This function allocates and pre-fills an skb for a reply to
4422 * a vendor command. Since it is intended for a reply, calling
4423 * it outside of a vendor command's doit() operation is invalid.
4424 *
4425 * The returned skb is pre-filled with some identifying data in
4426 * a way that any data that is put into the skb (with skb_put(),
4427 * nla_put() or similar) will end up being within the
4428 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4429 * with the skb is adding data for the corresponding userspace tool
4430 * which can then read that data out of the vendor data attribute.
4431 * You must not modify the skb in any other way.
4432 *
4433 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4434 * its error code as the result of the doit() operation.
4435 *
4436 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4437 */
4438static inline struct sk_buff *
4439cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4440{
4441 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4442 NL80211_ATTR_VENDOR_DATA, approxlen);
4443}
4444
4445/**
4446 * cfg80211_vendor_cmd_reply - send the reply skb
4447 * @skb: The skb, must have been allocated with
4448 * cfg80211_vendor_cmd_alloc_reply_skb()
4449 *
4450 * Since calling this function will usually be the last thing
4451 * before returning from the vendor command doit() you should
4452 * return the error code. Note that this function consumes the
4453 * skb regardless of the return value.
4454 *
4455 * Return: An error code or 0 on success.
4456 */
4457int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4458
4459/**
4460 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4461 * @wiphy: the wiphy
4462 * @wdev: the wireless device
4463 * @event_idx: index of the vendor event in the wiphy's vendor_events
4464 * @approxlen: an upper bound of the length of the data that will
4465 * be put into the skb
4466 * @gfp: allocation flags
4467 *
4468 * This function allocates and pre-fills an skb for an event on the
4469 * vendor-specific multicast group.
4470 *
4471 * If wdev != NULL, both the ifindex and identifier of the specified
4472 * wireless device are added to the event message before the vendor data
4473 * attribute.
4474 *
4475 * When done filling the skb, call cfg80211_vendor_event() with the
4476 * skb to send the event.
4477 *
4478 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4479 */
4480static inline struct sk_buff *
4481cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4482 int approxlen, int event_idx, gfp_t gfp)
4483{
4484 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4485 NL80211_ATTR_VENDOR_DATA,
4486 event_idx, approxlen, gfp);
4487}
4488
4489/**
4490 * cfg80211_vendor_event - send the event
4491 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4492 * @gfp: allocation flags
4493 *
4494 * This function sends the given @skb, which must have been allocated
4495 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4496 */
4497static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4498{
4499 __cfg80211_send_event_skb(skb, gfp);
4500}
4501
4502#ifdef CONFIG_NL80211_TESTMODE
4503/**
4504 * DOC: Test mode
4505 *
4506 * Test mode is a set of utility functions to allow drivers to
4507 * interact with driver-specific tools to aid, for instance,
4508 * factory programming.
4509 *
4510 * This chapter describes how drivers interact with it, for more
4511 * information see the nl80211 book's chapter on it.
4512 */
4513
4514/**
4515 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4516 * @wiphy: the wiphy
4517 * @approxlen: an upper bound of the length of the data that will
4518 * be put into the skb
4519 *
4520 * This function allocates and pre-fills an skb for a reply to
4521 * the testmode command. Since it is intended for a reply, calling
4522 * it outside of the @testmode_cmd operation is invalid.
4523 *
4524 * The returned skb is pre-filled with the wiphy index and set up in
4525 * a way that any data that is put into the skb (with skb_put(),
4526 * nla_put() or similar) will end up being within the
4527 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4528 * with the skb is adding data for the corresponding userspace tool
4529 * which can then read that data out of the testdata attribute. You
4530 * must not modify the skb in any other way.
4531 *
4532 * When done, call cfg80211_testmode_reply() with the skb and return
4533 * its error code as the result of the @testmode_cmd operation.
4534 *
4535 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4536 */
4537static inline struct sk_buff *
4538cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4539{
4540 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4541 NL80211_ATTR_TESTDATA, approxlen);
4542}
4543
4544/**
4545 * cfg80211_testmode_reply - send the reply skb
4546 * @skb: The skb, must have been allocated with
4547 * cfg80211_testmode_alloc_reply_skb()
4548 *
4549 * Since calling this function will usually be the last thing
4550 * before returning from the @testmode_cmd you should return
4551 * the error code. Note that this function consumes the skb
4552 * regardless of the return value.
4553 *
4554 * Return: An error code or 0 on success.
4555 */
4556static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4557{
4558 return cfg80211_vendor_cmd_reply(skb);
4559}
4560
4561/**
4562 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4563 * @wiphy: the wiphy
4564 * @approxlen: an upper bound of the length of the data that will
4565 * be put into the skb
4566 * @gfp: allocation flags
4567 *
4568 * This function allocates and pre-fills an skb for an event on the
4569 * testmode multicast group.
4570 *
4571 * The returned skb is set up in the same way as with
4572 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4573 * there, you should simply add data to it that will then end up in the
4574 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4575 * in any other way.
4576 *
4577 * When done filling the skb, call cfg80211_testmode_event() with the
4578 * skb to send the event.
4579 *
4580 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4581 */
4582static inline struct sk_buff *
4583cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4584{
4585 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
4586 NL80211_ATTR_TESTDATA, -1,
4587 approxlen, gfp);
4588}
4589
4590/**
4591 * cfg80211_testmode_event - send the event
4592 * @skb: The skb, must have been allocated with
4593 * cfg80211_testmode_alloc_event_skb()
4594 * @gfp: allocation flags
4595 *
4596 * This function sends the given @skb, which must have been allocated
4597 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4598 * consumes it.
4599 */
4600static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4601{
4602 __cfg80211_send_event_skb(skb, gfp);
4603}
4604
4605#define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4606#define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4607#else
4608#define CFG80211_TESTMODE_CMD(cmd)
4609#define CFG80211_TESTMODE_DUMP(cmd)
4610#endif
4611
4612/**
4613 * cfg80211_connect_result - notify cfg80211 of connection result
4614 *
4615 * @dev: network device
4616 * @bssid: the BSSID of the AP
4617 * @req_ie: association request IEs (maybe be %NULL)
4618 * @req_ie_len: association request IEs length
4619 * @resp_ie: association response IEs (may be %NULL)
4620 * @resp_ie_len: assoc response IEs length
4621 * @status: status code, 0 for successful connection, use
4622 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4623 * the real status code for failures.
4624 * @gfp: allocation flags
4625 *
4626 * It should be called by the underlying driver whenever connect() has
4627 * succeeded.
4628 */
4629void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4630 const u8 *req_ie, size_t req_ie_len,
4631 const u8 *resp_ie, size_t resp_ie_len,
4632 u16 status, gfp_t gfp);
4633
4634/**
4635 * cfg80211_roamed - notify cfg80211 of roaming
4636 *
4637 * @dev: network device
4638 * @channel: the channel of the new AP
4639 * @bssid: the BSSID of the new AP
4640 * @req_ie: association request IEs (maybe be %NULL)
4641 * @req_ie_len: association request IEs length
4642 * @resp_ie: association response IEs (may be %NULL)
4643 * @resp_ie_len: assoc response IEs length
4644 * @gfp: allocation flags
4645 *
4646 * It should be called by the underlying driver whenever it roamed
4647 * from one AP to another while connected.
4648 */
4649void cfg80211_roamed(struct net_device *dev,
4650 struct ieee80211_channel *channel,
4651 const u8 *bssid,
4652 const u8 *req_ie, size_t req_ie_len,
4653 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4654
4655/**
4656 * cfg80211_roamed_bss - notify cfg80211 of roaming
4657 *
4658 * @dev: network device
4659 * @bss: entry of bss to which STA got roamed
4660 * @req_ie: association request IEs (maybe be %NULL)
4661 * @req_ie_len: association request IEs length
4662 * @resp_ie: association response IEs (may be %NULL)
4663 * @resp_ie_len: assoc response IEs length
4664 * @gfp: allocation flags
4665 *
4666 * This is just a wrapper to notify cfg80211 of roaming event with driver
4667 * passing bss to avoid a race in timeout of the bss entry. It should be
4668 * called by the underlying driver whenever it roamed from one AP to another
4669 * while connected. Drivers which have roaming implemented in firmware
4670 * may use this function to avoid a race in bss entry timeout where the bss
4671 * entry of the new AP is seen in the driver, but gets timed out by the time
4672 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4673 * rdev->event_work. In case of any failures, the reference is released
4674 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4675 * it will be released while diconneting from the current bss.
4676 */
4677void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4678 const u8 *req_ie, size_t req_ie_len,
4679 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4680
4681/**
4682 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4683 *
4684 * @dev: network device
4685 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4686 * @ie_len: length of IEs
4687 * @reason: reason code for the disconnection, set it to 0 if unknown
4688 * @locally_generated: disconnection was requested locally
4689 * @gfp: allocation flags
4690 *
4691 * After it calls this function, the driver should enter an idle state
4692 * and not try to connect to any AP any more.
4693 */
4694void cfg80211_disconnected(struct net_device *dev, u16 reason,
4695 const u8 *ie, size_t ie_len,
4696 bool locally_generated, gfp_t gfp);
4697
4698/**
4699 * cfg80211_ready_on_channel - notification of remain_on_channel start
4700 * @wdev: wireless device
4701 * @cookie: the request cookie
4702 * @chan: The current channel (from remain_on_channel request)
4703 * @duration: Duration in milliseconds that the driver intents to remain on the
4704 * channel
4705 * @gfp: allocation flags
4706 */
4707void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4708 struct ieee80211_channel *chan,
4709 unsigned int duration, gfp_t gfp);
4710
4711/**
4712 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4713 * @wdev: wireless device
4714 * @cookie: the request cookie
4715 * @chan: The current channel (from remain_on_channel request)
4716 * @gfp: allocation flags
4717 */
4718void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4719 struct ieee80211_channel *chan,
4720 gfp_t gfp);
4721
4722
4723/**
4724 * cfg80211_new_sta - notify userspace about station
4725 *
4726 * @dev: the netdev
4727 * @mac_addr: the station's address
4728 * @sinfo: the station information
4729 * @gfp: allocation flags
4730 */
4731void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4732 struct station_info *sinfo, gfp_t gfp);
4733
4734/**
4735 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4736 * @dev: the netdev
4737 * @mac_addr: the station's address
4738 * @sinfo: the station information/statistics
4739 * @gfp: allocation flags
4740 */
4741void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
4742 struct station_info *sinfo, gfp_t gfp);
4743
4744/**
4745 * cfg80211_del_sta - notify userspace about deletion of a station
4746 *
4747 * @dev: the netdev
4748 * @mac_addr: the station's address
4749 * @gfp: allocation flags
4750 */
4751static inline void cfg80211_del_sta(struct net_device *dev,
4752 const u8 *mac_addr, gfp_t gfp)
4753{
4754 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
4755}
4756
4757/**
4758 * cfg80211_conn_failed - connection request failed notification
4759 *
4760 * @dev: the netdev
4761 * @mac_addr: the station's address
4762 * @reason: the reason for connection failure
4763 * @gfp: allocation flags
4764 *
4765 * Whenever a station tries to connect to an AP and if the station
4766 * could not connect to the AP as the AP has rejected the connection
4767 * for some reasons, this function is called.
4768 *
4769 * The reason for connection failure can be any of the value from
4770 * nl80211_connect_failed_reason enum
4771 */
4772void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4773 enum nl80211_connect_failed_reason reason,
4774 gfp_t gfp);
4775
4776/**
4777 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4778 * @wdev: wireless device receiving the frame
4779 * @freq: Frequency on which the frame was received in MHz
4780 * @sig_dbm: signal strength in mBm, or 0 if unknown
4781 * @buf: Management frame (header + body)
4782 * @len: length of the frame data
4783 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4784 *
4785 * This function is called whenever an Action frame is received for a station
4786 * mode interface, but is not processed in kernel.
4787 *
4788 * Return: %true if a user space application has registered for this frame.
4789 * For action frames, that makes it responsible for rejecting unrecognized
4790 * action frames; %false otherwise, in which case for action frames the
4791 * driver is responsible for rejecting the frame.
4792 */
4793bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4794 const u8 *buf, size_t len, u32 flags);
4795
4796/**
4797 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4798 * @wdev: wireless device receiving the frame
4799 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4800 * @buf: Management frame (header + body)
4801 * @len: length of the frame data
4802 * @ack: Whether frame was acknowledged
4803 * @gfp: context flags
4804 *
4805 * This function is called whenever a management frame was requested to be
4806 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4807 * transmission attempt.
4808 */
4809void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4810 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4811
4812
4813/**
4814 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4815 * @dev: network device
4816 * @rssi_event: the triggered RSSI event
4817 * @gfp: context flags
4818 *
4819 * This function is called when a configured connection quality monitoring
4820 * rssi threshold reached event occurs.
4821 */
4822void cfg80211_cqm_rssi_notify(struct net_device *dev,
4823 enum nl80211_cqm_rssi_threshold_event rssi_event,
4824 gfp_t gfp);
4825
4826/**
4827 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4828 * @dev: network device
4829 * @peer: peer's MAC address
4830 * @num_packets: how many packets were lost -- should be a fixed threshold
4831 * but probably no less than maybe 50, or maybe a throughput dependent
4832 * threshold (to account for temporary interference)
4833 * @gfp: context flags
4834 */
4835void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4836 const u8 *peer, u32 num_packets, gfp_t gfp);
4837
4838/**
4839 * cfg80211_cqm_txe_notify - TX error rate event
4840 * @dev: network device
4841 * @peer: peer's MAC address
4842 * @num_packets: how many packets were lost
4843 * @rate: % of packets which failed transmission
4844 * @intvl: interval (in s) over which the TX failure threshold was breached.
4845 * @gfp: context flags
4846 *
4847 * Notify userspace when configured % TX failures over number of packets in a
4848 * given interval is exceeded.
4849 */
4850void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4851 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4852
4853/**
4854 * cfg80211_cqm_beacon_loss_notify - beacon loss event
4855 * @dev: network device
4856 * @gfp: context flags
4857 *
4858 * Notify userspace about beacon loss from the connected AP.
4859 */
4860void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
4861
4862/**
4863 * cfg80211_radar_event - radar detection event
4864 * @wiphy: the wiphy
4865 * @chandef: chandef for the current channel
4866 * @gfp: context flags
4867 *
4868 * This function is called when a radar is detected on the current chanenl.
4869 */
4870void cfg80211_radar_event(struct wiphy *wiphy,
4871 struct cfg80211_chan_def *chandef, gfp_t gfp);
4872
4873/**
4874 * cfg80211_cac_event - Channel availability check (CAC) event
4875 * @netdev: network device
4876 * @chandef: chandef for the current channel
4877 * @event: type of event
4878 * @gfp: context flags
4879 *
4880 * This function is called when a Channel availability check (CAC) is finished
4881 * or aborted. This must be called to notify the completion of a CAC process,
4882 * also by full-MAC drivers.
4883 */
4884void cfg80211_cac_event(struct net_device *netdev,
4885 const struct cfg80211_chan_def *chandef,
4886 enum nl80211_radar_event event, gfp_t gfp);
4887
4888
4889/**
4890 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4891 * @dev: network device
4892 * @bssid: BSSID of AP (to avoid races)
4893 * @replay_ctr: new replay counter
4894 * @gfp: allocation flags
4895 */
4896void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4897 const u8 *replay_ctr, gfp_t gfp);
4898
4899/**
4900 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4901 * @dev: network device
4902 * @index: candidate index (the smaller the index, the higher the priority)
4903 * @bssid: BSSID of AP
4904 * @preauth: Whether AP advertises support for RSN pre-authentication
4905 * @gfp: allocation flags
4906 */
4907void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4908 const u8 *bssid, bool preauth, gfp_t gfp);
4909
4910/**
4911 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4912 * @dev: The device the frame matched to
4913 * @addr: the transmitter address
4914 * @gfp: context flags
4915 *
4916 * This function is used in AP mode (only!) to inform userspace that
4917 * a spurious class 3 frame was received, to be able to deauth the
4918 * sender.
4919 * Return: %true if the frame was passed to userspace (or this failed
4920 * for a reason other than not having a subscription.)
4921 */
4922bool cfg80211_rx_spurious_frame(struct net_device *dev,
4923 const u8 *addr, gfp_t gfp);
4924
4925/**
4926 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4927 * @dev: The device the frame matched to
4928 * @addr: the transmitter address
4929 * @gfp: context flags
4930 *
4931 * This function is used in AP mode (only!) to inform userspace that
4932 * an associated station sent a 4addr frame but that wasn't expected.
4933 * It is allowed and desirable to send this event only once for each
4934 * station to avoid event flooding.
4935 * Return: %true if the frame was passed to userspace (or this failed
4936 * for a reason other than not having a subscription.)
4937 */
4938bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4939 const u8 *addr, gfp_t gfp);
4940
4941/**
4942 * cfg80211_probe_status - notify userspace about probe status
4943 * @dev: the device the probe was sent on
4944 * @addr: the address of the peer
4945 * @cookie: the cookie filled in @probe_client previously
4946 * @acked: indicates whether probe was acked or not
4947 * @gfp: allocation flags
4948 */
4949void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4950 u64 cookie, bool acked, gfp_t gfp);
4951
4952/**
4953 * cfg80211_report_obss_beacon - report beacon from other APs
4954 * @wiphy: The wiphy that received the beacon
4955 * @frame: the frame
4956 * @len: length of the frame
4957 * @freq: frequency the frame was received on
4958 * @sig_dbm: signal strength in mBm, or 0 if unknown
4959 *
4960 * Use this function to report to userspace when a beacon was
4961 * received. It is not useful to call this when there is no
4962 * netdev that is in AP/GO mode.
4963 */
4964void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4965 const u8 *frame, size_t len,
4966 int freq, int sig_dbm);
4967
4968/**
4969 * cfg80211_reg_can_beacon - check if beaconing is allowed
4970 * @wiphy: the wiphy
4971 * @chandef: the channel definition
4972 * @iftype: interface type
4973 *
4974 * Return: %true if there is no secondary channel or the secondary channel(s)
4975 * can be used for beaconing (i.e. is not a radar channel etc.)
4976 */
4977bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4978 struct cfg80211_chan_def *chandef,
4979 enum nl80211_iftype iftype);
4980
4981/**
4982 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
4983 * @wiphy: the wiphy
4984 * @chandef: the channel definition
4985 * @iftype: interface type
4986 *
4987 * Return: %true if there is no secondary channel or the secondary channel(s)
4988 * can be used for beaconing (i.e. is not a radar channel etc.). This version
4989 * also checks if IR-relaxation conditions apply, to allow beaconing under
4990 * more permissive conditions.
4991 *
4992 * Requires the RTNL to be held.
4993 */
4994bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
4995 struct cfg80211_chan_def *chandef,
4996 enum nl80211_iftype iftype);
4997
4998/*
4999 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5000 * @dev: the device which switched channels
5001 * @chandef: the new channel definition
5002 *
5003 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5004 * driver context!
5005 */
5006void cfg80211_ch_switch_notify(struct net_device *dev,
5007 struct cfg80211_chan_def *chandef);
5008
5009/*
5010 * cfg80211_ch_switch_started_notify - notify channel switch start
5011 * @dev: the device on which the channel switch started
5012 * @chandef: the future channel definition
5013 * @count: the number of TBTTs until the channel switch happens
5014 *
5015 * Inform the userspace about the channel switch that has just
5016 * started, so that it can take appropriate actions (eg. starting
5017 * channel switch on other vifs), if necessary.
5018 */
5019void cfg80211_ch_switch_started_notify(struct net_device *dev,
5020 struct cfg80211_chan_def *chandef,
5021 u8 count);
5022
5023/**
5024 * ieee80211_operating_class_to_band - convert operating class to band
5025 *
5026 * @operating_class: the operating class to convert
5027 * @band: band pointer to fill
5028 *
5029 * Returns %true if the conversion was successful, %false otherwise.
5030 */
5031bool ieee80211_operating_class_to_band(u8 operating_class,
5032 enum ieee80211_band *band);
5033
5034/**
5035 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5036 *
5037 * @chandef: the chandef to convert
5038 * @op_class: a pointer to the resulting operating class
5039 *
5040 * Returns %true if the conversion was successful, %false otherwise.
5041 */
5042bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5043 u8 *op_class);
5044
5045/*
5046 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5047 * @dev: the device on which the operation is requested
5048 * @peer: the MAC address of the peer device
5049 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5050 * NL80211_TDLS_TEARDOWN)
5051 * @reason_code: the reason code for teardown request
5052 * @gfp: allocation flags
5053 *
5054 * This function is used to request userspace to perform TDLS operation that
5055 * requires knowledge of keys, i.e., link setup or teardown when the AP
5056 * connection uses encryption. This is optional mechanism for the driver to use
5057 * if it can automatically determine when a TDLS link could be useful (e.g.,
5058 * based on traffic and signal strength for a peer).
5059 */
5060void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5061 enum nl80211_tdls_operation oper,
5062 u16 reason_code, gfp_t gfp);
5063
5064/*
5065 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5066 * @rate: given rate_info to calculate bitrate from
5067 *
5068 * return 0 if MCS index >= 32
5069 */
5070u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5071
5072/**
5073 * cfg80211_unregister_wdev - remove the given wdev
5074 * @wdev: struct wireless_dev to remove
5075 *
5076 * Call this function only for wdevs that have no netdev assigned,
5077 * e.g. P2P Devices. It removes the device from the list so that
5078 * it can no longer be used. It is necessary to call this function
5079 * even when cfg80211 requests the removal of the interface by
5080 * calling the del_virtual_intf() callback. The function must also
5081 * be called when the driver wishes to unregister the wdev, e.g.
5082 * when the device is unbound from the driver.
5083 *
5084 * Requires the RTNL to be held.
5085 */
5086void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5087
5088/**
5089 * struct cfg80211_ft_event - FT Information Elements
5090 * @ies: FT IEs
5091 * @ies_len: length of the FT IE in bytes
5092 * @target_ap: target AP's MAC address
5093 * @ric_ies: RIC IE
5094 * @ric_ies_len: length of the RIC IE in bytes
5095 */
5096struct cfg80211_ft_event_params {
5097 const u8 *ies;
5098 size_t ies_len;
5099 const u8 *target_ap;
5100 const u8 *ric_ies;
5101 size_t ric_ies_len;
5102};
5103
5104/**
5105 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5106 * @netdev: network device
5107 * @ft_event: IE information
5108 */
5109void cfg80211_ft_event(struct net_device *netdev,
5110 struct cfg80211_ft_event_params *ft_event);
5111
5112/**
5113 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5114 * @ies: the input IE buffer
5115 * @len: the input length
5116 * @attr: the attribute ID to find
5117 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5118 * if the function is only called to get the needed buffer size
5119 * @bufsize: size of the output buffer
5120 *
5121 * The function finds a given P2P attribute in the (vendor) IEs and
5122 * copies its contents to the given buffer.
5123 *
5124 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5125 * malformed or the attribute can't be found (respectively), or the
5126 * length of the found attribute (which can be zero).
5127 */
5128int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5129 enum ieee80211_p2p_attr_id attr,
5130 u8 *buf, unsigned int bufsize);
5131
5132/**
5133 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5134 * @ies: the IE buffer
5135 * @ielen: the length of the IE buffer
5136 * @ids: an array with element IDs that are allowed before
5137 * the split
5138 * @n_ids: the size of the element ID array
5139 * @after_ric: array IE types that come after the RIC element
5140 * @n_after_ric: size of the @after_ric array
5141 * @offset: offset where to start splitting in the buffer
5142 *
5143 * This function splits an IE buffer by updating the @offset
5144 * variable to point to the location where the buffer should be
5145 * split.
5146 *
5147 * It assumes that the given IE buffer is well-formed, this
5148 * has to be guaranteed by the caller!
5149 *
5150 * It also assumes that the IEs in the buffer are ordered
5151 * correctly, if not the result of using this function will not
5152 * be ordered correctly either, i.e. it does no reordering.
5153 *
5154 * The function returns the offset where the next part of the
5155 * buffer starts, which may be @ielen if the entire (remainder)
5156 * of the buffer should be used.
5157 */
5158size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5159 const u8 *ids, int n_ids,
5160 const u8 *after_ric, int n_after_ric,
5161 size_t offset);
5162
5163/**
5164 * ieee80211_ie_split - split an IE buffer according to ordering
5165 * @ies: the IE buffer
5166 * @ielen: the length of the IE buffer
5167 * @ids: an array with element IDs that are allowed before
5168 * the split
5169 * @n_ids: the size of the element ID array
5170 * @offset: offset where to start splitting in the buffer
5171 *
5172 * This function splits an IE buffer by updating the @offset
5173 * variable to point to the location where the buffer should be
5174 * split.
5175 *
5176 * It assumes that the given IE buffer is well-formed, this
5177 * has to be guaranteed by the caller!
5178 *
5179 * It also assumes that the IEs in the buffer are ordered
5180 * correctly, if not the result of using this function will not
5181 * be ordered correctly either, i.e. it does no reordering.
5182 *
5183 * The function returns the offset where the next part of the
5184 * buffer starts, which may be @ielen if the entire (remainder)
5185 * of the buffer should be used.
5186 */
5187static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5188 const u8 *ids, int n_ids, size_t offset)
5189{
5190 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
5191}
5192
5193/**
5194 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5195 * @wdev: the wireless device reporting the wakeup
5196 * @wakeup: the wakeup report
5197 * @gfp: allocation flags
5198 *
5199 * This function reports that the given device woke up. If it
5200 * caused the wakeup, report the reason(s), otherwise you may
5201 * pass %NULL as the @wakeup parameter to advertise that something
5202 * else caused the wakeup.
5203 */
5204void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5205 struct cfg80211_wowlan_wakeup *wakeup,
5206 gfp_t gfp);
5207
5208/**
5209 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5210 *
5211 * @wdev: the wireless device for which critical protocol is stopped.
5212 * @gfp: allocation flags
5213 *
5214 * This function can be called by the driver to indicate it has reverted
5215 * operation back to normal. One reason could be that the duration given
5216 * by .crit_proto_start() has expired.
5217 */
5218void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5219
5220/**
5221 * ieee80211_get_num_supported_channels - get number of channels device has
5222 * @wiphy: the wiphy
5223 *
5224 * Return: the number of channels supported by the device.
5225 */
5226unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5227
5228/**
5229 * cfg80211_check_combinations - check interface combinations
5230 *
5231 * @wiphy: the wiphy
5232 * @num_different_channels: the number of different channels we want
5233 * to use for verification
5234 * @radar_detect: a bitmap where each bit corresponds to a channel
5235 * width where radar detection is needed, as in the definition of
5236 * &struct ieee80211_iface_combination.@radar_detect_widths
5237 * @iftype_num: array with the numbers of interfaces of each interface
5238 * type. The index is the interface type as specified in &enum
5239 * nl80211_iftype.
5240 *
5241 * This function can be called by the driver to check whether a
5242 * combination of interfaces and their types are allowed according to
5243 * the interface combinations.
5244 */
5245int cfg80211_check_combinations(struct wiphy *wiphy,
5246 const int num_different_channels,
5247 const u8 radar_detect,
5248 const int iftype_num[NUM_NL80211_IFTYPES]);
5249
5250/**
5251 * cfg80211_iter_combinations - iterate over matching combinations
5252 *
5253 * @wiphy: the wiphy
5254 * @num_different_channels: the number of different channels we want
5255 * to use for verification
5256 * @radar_detect: a bitmap where each bit corresponds to a channel
5257 * width where radar detection is needed, as in the definition of
5258 * &struct ieee80211_iface_combination.@radar_detect_widths
5259 * @iftype_num: array with the numbers of interfaces of each interface
5260 * type. The index is the interface type as specified in &enum
5261 * nl80211_iftype.
5262 * @iter: function to call for each matching combination
5263 * @data: pointer to pass to iter function
5264 *
5265 * This function can be called by the driver to check what possible
5266 * combinations it fits in at a given moment, e.g. for channel switching
5267 * purposes.
5268 */
5269int cfg80211_iter_combinations(struct wiphy *wiphy,
5270 const int num_different_channels,
5271 const u8 radar_detect,
5272 const int iftype_num[NUM_NL80211_IFTYPES],
5273 void (*iter)(const struct ieee80211_iface_combination *c,
5274 void *data),
5275 void *data);
5276
5277/*
5278 * cfg80211_stop_iface - trigger interface disconnection
5279 *
5280 * @wiphy: the wiphy
5281 * @wdev: wireless device
5282 * @gfp: context flags
5283 *
5284 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5285 * disconnected.
5286 *
5287 * Note: This doesn't need any locks and is asynchronous.
5288 */
5289void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5290 gfp_t gfp);
5291
5292/**
5293 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5294 * @wiphy: the wiphy to shut down
5295 *
5296 * This function shuts down all interfaces belonging to this wiphy by
5297 * calling dev_close() (and treating non-netdev interfaces as needed).
5298 * It shouldn't really be used unless there are some fatal device errors
5299 * that really can't be recovered in any other way.
5300 *
5301 * Callers must hold the RTNL and be able to deal with callbacks into
5302 * the driver while the function is running.
5303 */
5304void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5305
5306/**
5307 * wiphy_ext_feature_set - set the extended feature flag
5308 *
5309 * @wiphy: the wiphy to modify.
5310 * @ftidx: extended feature bit index.
5311 *
5312 * The extended features are flagged in multiple bytes (see
5313 * &struct wiphy.@ext_features)
5314 */
5315static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5316 enum nl80211_ext_feature_index ftidx)
5317{
5318 u8 *ft_byte;
5319
5320 ft_byte = &wiphy->ext_features[ftidx / 8];
5321 *ft_byte |= BIT(ftidx % 8);
5322}
5323
5324/**
5325 * wiphy_ext_feature_isset - check the extended feature flag
5326 *
5327 * @wiphy: the wiphy to modify.
5328 * @ftidx: extended feature bit index.
5329 *
5330 * The extended features are flagged in multiple bytes (see
5331 * &struct wiphy.@ext_features)
5332 */
5333static inline bool
5334wiphy_ext_feature_isset(struct wiphy *wiphy,
5335 enum nl80211_ext_feature_index ftidx)
5336{
5337 u8 ft_byte;
5338
5339 ft_byte = wiphy->ext_features[ftidx / 8];
5340 return (ft_byte & BIT(ftidx % 8)) != 0;
5341}
5342
5343/* ethtool helper */
5344void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5345
5346/* Logging, debugging and troubleshooting/diagnostic helpers. */
5347
5348/* wiphy_printk helpers, similar to dev_printk */
5349
5350#define wiphy_printk(level, wiphy, format, args...) \
5351 dev_printk(level, &(wiphy)->dev, format, ##args)
5352#define wiphy_emerg(wiphy, format, args...) \
5353 dev_emerg(&(wiphy)->dev, format, ##args)
5354#define wiphy_alert(wiphy, format, args...) \
5355 dev_alert(&(wiphy)->dev, format, ##args)
5356#define wiphy_crit(wiphy, format, args...) \
5357 dev_crit(&(wiphy)->dev, format, ##args)
5358#define wiphy_err(wiphy, format, args...) \
5359 dev_err(&(wiphy)->dev, format, ##args)
5360#define wiphy_warn(wiphy, format, args...) \
5361 dev_warn(&(wiphy)->dev, format, ##args)
5362#define wiphy_notice(wiphy, format, args...) \
5363 dev_notice(&(wiphy)->dev, format, ##args)
5364#define wiphy_info(wiphy, format, args...) \
5365 dev_info(&(wiphy)->dev, format, ##args)
5366
5367#define wiphy_debug(wiphy, format, args...) \
5368 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5369
5370#define wiphy_dbg(wiphy, format, args...) \
5371 dev_dbg(&(wiphy)->dev, format, ##args)
5372
5373#if defined(VERBOSE_DEBUG)
5374#define wiphy_vdbg wiphy_dbg
5375#else
5376#define wiphy_vdbg(wiphy, format, args...) \
5377({ \
5378 if (0) \
5379 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5380 0; \
5381})
5382#endif
5383
5384/*
5385 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5386 * of using a WARN/WARN_ON to get the message out, including the
5387 * file/line information and a backtrace.
5388 */
5389#define wiphy_WARN(wiphy, format, args...) \
5390 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5391
5392#endif /* __NET_CFG80211_H */
1/* SPDX-License-Identifier: GPL-2.0-only */
2#ifndef __NET_CFG80211_H
3#define __NET_CFG80211_H
4/*
5 * 802.11 device and configuration interface
6 *
7 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright 2015-2017 Intel Deutschland GmbH
10 * Copyright (C) 2018-2021 Intel Corporation
11 */
12
13#include <linux/ethtool.h>
14#include <uapi/linux/rfkill.h>
15#include <linux/netdevice.h>
16#include <linux/debugfs.h>
17#include <linux/list.h>
18#include <linux/bug.h>
19#include <linux/netlink.h>
20#include <linux/skbuff.h>
21#include <linux/nl80211.h>
22#include <linux/if_ether.h>
23#include <linux/ieee80211.h>
24#include <linux/net.h>
25#include <linux/rfkill.h>
26#include <net/regulatory.h>
27
28/**
29 * DOC: Introduction
30 *
31 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32 * userspace and drivers, and offers some utility functionality associated
33 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34 * by all modern wireless drivers in Linux, so that they offer a consistent
35 * API through nl80211. For backward compatibility, cfg80211 also offers
36 * wireless extensions to userspace, but hides them from drivers completely.
37 *
38 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
39 * use restrictions.
40 */
41
42
43/**
44 * DOC: Device registration
45 *
46 * In order for a driver to use cfg80211, it must register the hardware device
47 * with cfg80211. This happens through a number of hardware capability structs
48 * described below.
49 *
50 * The fundamental structure for each device is the 'wiphy', of which each
51 * instance describes a physical wireless device connected to the system. Each
52 * such wiphy can have zero, one, or many virtual interfaces associated with
53 * it, which need to be identified as such by pointing the network interface's
54 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55 * the wireless part of the interface, normally this struct is embedded in the
56 * network interface's private data area. Drivers can optionally allow creating
57 * or destroying virtual interfaces on the fly, but without at least one or the
58 * ability to create some the wireless device isn't useful.
59 *
60 * Each wiphy structure contains device capability information, and also has
61 * a pointer to the various operations the driver offers. The definitions and
62 * structures here describe these capabilities in detail.
63 */
64
65struct wiphy;
66
67/*
68 * wireless hardware capability structures
69 */
70
71/**
72 * enum ieee80211_channel_flags - channel flags
73 *
74 * Channel flags set by the regulatory control code.
75 *
76 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
77 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
78 * sending probe requests or beaconing.
79 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
80 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
81 * is not permitted.
82 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
83 * is not permitted.
84 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
85 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
86 * this flag indicates that an 80 MHz channel cannot use this
87 * channel as the control or any of the secondary channels.
88 * This may be due to the driver or due to regulatory bandwidth
89 * restrictions.
90 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
91 * this flag indicates that an 160 MHz channel cannot use this
92 * channel as the control or any of the secondary channels.
93 * This may be due to the driver or due to regulatory bandwidth
94 * restrictions.
95 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
96 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
97 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
98 * on this channel.
99 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
100 * on this channel.
101 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
102 * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted
103 * on this channel.
104 * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted
105 * on this channel.
106 * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted
107 * on this channel.
108 * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted
109 * on this channel.
110 * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted
111 * on this channel.
112 * @IEEE80211_CHAN_NO_320MHZ: If the driver supports 320 MHz on the band,
113 * this flag indicates that a 320 MHz channel cannot use this
114 * channel as the control or any of the secondary channels.
115 * This may be due to the driver or due to regulatory bandwidth
116 * restrictions.
117 * @IEEE80211_CHAN_NO_EHT: EHT operation is not permitted on this channel.
118 */
119enum ieee80211_channel_flags {
120 IEEE80211_CHAN_DISABLED = 1<<0,
121 IEEE80211_CHAN_NO_IR = 1<<1,
122 /* hole at 1<<2 */
123 IEEE80211_CHAN_RADAR = 1<<3,
124 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
125 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
126 IEEE80211_CHAN_NO_OFDM = 1<<6,
127 IEEE80211_CHAN_NO_80MHZ = 1<<7,
128 IEEE80211_CHAN_NO_160MHZ = 1<<8,
129 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
130 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
131 IEEE80211_CHAN_NO_20MHZ = 1<<11,
132 IEEE80211_CHAN_NO_10MHZ = 1<<12,
133 IEEE80211_CHAN_NO_HE = 1<<13,
134 IEEE80211_CHAN_1MHZ = 1<<14,
135 IEEE80211_CHAN_2MHZ = 1<<15,
136 IEEE80211_CHAN_4MHZ = 1<<16,
137 IEEE80211_CHAN_8MHZ = 1<<17,
138 IEEE80211_CHAN_16MHZ = 1<<18,
139 IEEE80211_CHAN_NO_320MHZ = 1<<19,
140 IEEE80211_CHAN_NO_EHT = 1<<20,
141};
142
143#define IEEE80211_CHAN_NO_HT40 \
144 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
145
146#define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
147#define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
148
149/**
150 * struct ieee80211_channel - channel definition
151 *
152 * This structure describes a single channel for use
153 * with cfg80211.
154 *
155 * @center_freq: center frequency in MHz
156 * @freq_offset: offset from @center_freq, in KHz
157 * @hw_value: hardware-specific value for the channel
158 * @flags: channel flags from &enum ieee80211_channel_flags.
159 * @orig_flags: channel flags at registration time, used by regulatory
160 * code to support devices with additional restrictions
161 * @band: band this channel belongs to.
162 * @max_antenna_gain: maximum antenna gain in dBi
163 * @max_power: maximum transmission power (in dBm)
164 * @max_reg_power: maximum regulatory transmission power (in dBm)
165 * @beacon_found: helper to regulatory code to indicate when a beacon
166 * has been found on this channel. Use regulatory_hint_found_beacon()
167 * to enable this, this is useful only on 5 GHz band.
168 * @orig_mag: internal use
169 * @orig_mpwr: internal use
170 * @dfs_state: current state of this channel. Only relevant if radar is required
171 * on this channel.
172 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
173 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
174 */
175struct ieee80211_channel {
176 enum nl80211_band band;
177 u32 center_freq;
178 u16 freq_offset;
179 u16 hw_value;
180 u32 flags;
181 int max_antenna_gain;
182 int max_power;
183 int max_reg_power;
184 bool beacon_found;
185 u32 orig_flags;
186 int orig_mag, orig_mpwr;
187 enum nl80211_dfs_state dfs_state;
188 unsigned long dfs_state_entered;
189 unsigned int dfs_cac_ms;
190};
191
192/**
193 * enum ieee80211_rate_flags - rate flags
194 *
195 * Hardware/specification flags for rates. These are structured
196 * in a way that allows using the same bitrate structure for
197 * different bands/PHY modes.
198 *
199 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
200 * preamble on this bitrate; only relevant in 2.4GHz band and
201 * with CCK rates.
202 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
203 * when used with 802.11a (on the 5 GHz band); filled by the
204 * core code when registering the wiphy.
205 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
206 * when used with 802.11b (on the 2.4 GHz band); filled by the
207 * core code when registering the wiphy.
208 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
209 * when used with 802.11g (on the 2.4 GHz band); filled by the
210 * core code when registering the wiphy.
211 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
212 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
213 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
214 */
215enum ieee80211_rate_flags {
216 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
217 IEEE80211_RATE_MANDATORY_A = 1<<1,
218 IEEE80211_RATE_MANDATORY_B = 1<<2,
219 IEEE80211_RATE_MANDATORY_G = 1<<3,
220 IEEE80211_RATE_ERP_G = 1<<4,
221 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
222 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
223};
224
225/**
226 * enum ieee80211_bss_type - BSS type filter
227 *
228 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
229 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
230 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
231 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
232 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
233 */
234enum ieee80211_bss_type {
235 IEEE80211_BSS_TYPE_ESS,
236 IEEE80211_BSS_TYPE_PBSS,
237 IEEE80211_BSS_TYPE_IBSS,
238 IEEE80211_BSS_TYPE_MBSS,
239 IEEE80211_BSS_TYPE_ANY
240};
241
242/**
243 * enum ieee80211_privacy - BSS privacy filter
244 *
245 * @IEEE80211_PRIVACY_ON: privacy bit set
246 * @IEEE80211_PRIVACY_OFF: privacy bit clear
247 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
248 */
249enum ieee80211_privacy {
250 IEEE80211_PRIVACY_ON,
251 IEEE80211_PRIVACY_OFF,
252 IEEE80211_PRIVACY_ANY
253};
254
255#define IEEE80211_PRIVACY(x) \
256 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
257
258/**
259 * struct ieee80211_rate - bitrate definition
260 *
261 * This structure describes a bitrate that an 802.11 PHY can
262 * operate with. The two values @hw_value and @hw_value_short
263 * are only for driver use when pointers to this structure are
264 * passed around.
265 *
266 * @flags: rate-specific flags
267 * @bitrate: bitrate in units of 100 Kbps
268 * @hw_value: driver/hardware value for this rate
269 * @hw_value_short: driver/hardware value for this rate when
270 * short preamble is used
271 */
272struct ieee80211_rate {
273 u32 flags;
274 u16 bitrate;
275 u16 hw_value, hw_value_short;
276};
277
278/**
279 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
280 *
281 * @enable: is the feature enabled.
282 * @sr_ctrl: The SR Control field of SRP element.
283 * @non_srg_max_offset: non-SRG maximum tx power offset
284 * @min_offset: minimal tx power offset an associated station shall use
285 * @max_offset: maximum tx power offset an associated station shall use
286 * @bss_color_bitmap: bitmap that indicates the BSS color values used by
287 * members of the SRG
288 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
289 * used by members of the SRG
290 */
291struct ieee80211_he_obss_pd {
292 bool enable;
293 u8 sr_ctrl;
294 u8 non_srg_max_offset;
295 u8 min_offset;
296 u8 max_offset;
297 u8 bss_color_bitmap[8];
298 u8 partial_bssid_bitmap[8];
299};
300
301/**
302 * struct cfg80211_he_bss_color - AP settings for BSS coloring
303 *
304 * @color: the current color.
305 * @enabled: HE BSS color is used
306 * @partial: define the AID equation.
307 */
308struct cfg80211_he_bss_color {
309 u8 color;
310 bool enabled;
311 bool partial;
312};
313
314/**
315 * struct ieee80211_sta_ht_cap - STA's HT capabilities
316 *
317 * This structure describes most essential parameters needed
318 * to describe 802.11n HT capabilities for an STA.
319 *
320 * @ht_supported: is HT supported by the STA
321 * @cap: HT capabilities map as described in 802.11n spec
322 * @ampdu_factor: Maximum A-MPDU length factor
323 * @ampdu_density: Minimum A-MPDU spacing
324 * @mcs: Supported MCS rates
325 */
326struct ieee80211_sta_ht_cap {
327 u16 cap; /* use IEEE80211_HT_CAP_ */
328 bool ht_supported;
329 u8 ampdu_factor;
330 u8 ampdu_density;
331 struct ieee80211_mcs_info mcs;
332};
333
334/**
335 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
336 *
337 * This structure describes most essential parameters needed
338 * to describe 802.11ac VHT capabilities for an STA.
339 *
340 * @vht_supported: is VHT supported by the STA
341 * @cap: VHT capabilities map as described in 802.11ac spec
342 * @vht_mcs: Supported VHT MCS rates
343 */
344struct ieee80211_sta_vht_cap {
345 bool vht_supported;
346 u32 cap; /* use IEEE80211_VHT_CAP_ */
347 struct ieee80211_vht_mcs_info vht_mcs;
348};
349
350#define IEEE80211_HE_PPE_THRES_MAX_LEN 25
351
352/**
353 * struct ieee80211_sta_he_cap - STA's HE capabilities
354 *
355 * This structure describes most essential parameters needed
356 * to describe 802.11ax HE capabilities for a STA.
357 *
358 * @has_he: true iff HE data is valid.
359 * @he_cap_elem: Fixed portion of the HE capabilities element.
360 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
361 * @ppe_thres: Holds the PPE Thresholds data.
362 */
363struct ieee80211_sta_he_cap {
364 bool has_he;
365 struct ieee80211_he_cap_elem he_cap_elem;
366 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
367 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
368};
369
370/**
371 * struct ieee80211_eht_mcs_nss_supp - EHT max supported NSS per MCS
372 *
373 * See P802.11be_D1.3 Table 9-401k - "Subfields of the Supported EHT-MCS
374 * and NSS Set field"
375 *
376 * @only_20mhz: MCS/NSS support for 20 MHz-only STA.
377 * @bw: MCS/NSS support for 80, 160 and 320 MHz
378 * @bw._80: MCS/NSS support for BW <= 80 MHz
379 * @bw._160: MCS/NSS support for BW = 160 MHz
380 * @bw._320: MCS/NSS support for BW = 320 MHz
381 */
382struct ieee80211_eht_mcs_nss_supp {
383 union {
384 struct ieee80211_eht_mcs_nss_supp_20mhz_only only_20mhz;
385 struct {
386 struct ieee80211_eht_mcs_nss_supp_bw _80;
387 struct ieee80211_eht_mcs_nss_supp_bw _160;
388 struct ieee80211_eht_mcs_nss_supp_bw _320;
389 } __packed bw;
390 } __packed;
391} __packed;
392
393#define IEEE80211_EHT_PPE_THRES_MAX_LEN 32
394
395/**
396 * struct ieee80211_sta_eht_cap - STA's EHT capabilities
397 *
398 * This structure describes most essential parameters needed
399 * to describe 802.11be EHT capabilities for a STA.
400 *
401 * @has_eht: true iff EHT data is valid.
402 * @eht_cap_elem: Fixed portion of the eht capabilities element.
403 * @eht_mcs_nss_supp: The supported NSS/MCS combinations.
404 * @eht_ppe_thres: Holds the PPE Thresholds data.
405 */
406struct ieee80211_sta_eht_cap {
407 bool has_eht;
408 struct ieee80211_eht_cap_elem_fixed eht_cap_elem;
409 struct ieee80211_eht_mcs_nss_supp eht_mcs_nss_supp;
410 u8 eht_ppe_thres[IEEE80211_EHT_PPE_THRES_MAX_LEN];
411};
412
413/**
414 * struct ieee80211_sband_iftype_data - sband data per interface type
415 *
416 * This structure encapsulates sband data that is relevant for the
417 * interface types defined in @types_mask. Each type in the
418 * @types_mask must be unique across all instances of iftype_data.
419 *
420 * @types_mask: interface types mask
421 * @he_cap: holds the HE capabilities
422 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
423 * 6 GHz band channel (and 0 may be valid value).
424 * @eht_cap: STA's EHT capabilities
425 * @vendor_elems: vendor element(s) to advertise
426 * @vendor_elems.data: vendor element(s) data
427 * @vendor_elems.len: vendor element(s) length
428 */
429struct ieee80211_sband_iftype_data {
430 u16 types_mask;
431 struct ieee80211_sta_he_cap he_cap;
432 struct ieee80211_he_6ghz_capa he_6ghz_capa;
433 struct ieee80211_sta_eht_cap eht_cap;
434 struct {
435 const u8 *data;
436 unsigned int len;
437 } vendor_elems;
438};
439
440/**
441 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
442 *
443 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
444 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
445 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
446 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
447 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
448 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
449 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
450 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
451 * 2.16GHz+2.16GHz
452 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
453 * 4.32GHz + 4.32GHz
454 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
455 * 4.32GHz + 4.32GHz
456 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
457 * and 4.32GHz + 4.32GHz
458 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
459 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
460 */
461enum ieee80211_edmg_bw_config {
462 IEEE80211_EDMG_BW_CONFIG_4 = 4,
463 IEEE80211_EDMG_BW_CONFIG_5 = 5,
464 IEEE80211_EDMG_BW_CONFIG_6 = 6,
465 IEEE80211_EDMG_BW_CONFIG_7 = 7,
466 IEEE80211_EDMG_BW_CONFIG_8 = 8,
467 IEEE80211_EDMG_BW_CONFIG_9 = 9,
468 IEEE80211_EDMG_BW_CONFIG_10 = 10,
469 IEEE80211_EDMG_BW_CONFIG_11 = 11,
470 IEEE80211_EDMG_BW_CONFIG_12 = 12,
471 IEEE80211_EDMG_BW_CONFIG_13 = 13,
472 IEEE80211_EDMG_BW_CONFIG_14 = 14,
473 IEEE80211_EDMG_BW_CONFIG_15 = 15,
474};
475
476/**
477 * struct ieee80211_edmg - EDMG configuration
478 *
479 * This structure describes most essential parameters needed
480 * to describe 802.11ay EDMG configuration
481 *
482 * @channels: bitmap that indicates the 2.16 GHz channel(s)
483 * that are allowed to be used for transmissions.
484 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
485 * Set to 0 indicate EDMG not supported.
486 * @bw_config: Channel BW Configuration subfield encodes
487 * the allowed channel bandwidth configurations
488 */
489struct ieee80211_edmg {
490 u8 channels;
491 enum ieee80211_edmg_bw_config bw_config;
492};
493
494/**
495 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
496 *
497 * This structure describes most essential parameters needed
498 * to describe 802.11ah S1G capabilities for a STA.
499 *
500 * @s1g: is STA an S1G STA
501 * @cap: S1G capabilities information
502 * @nss_mcs: Supported NSS MCS set
503 */
504struct ieee80211_sta_s1g_cap {
505 bool s1g;
506 u8 cap[10]; /* use S1G_CAPAB_ */
507 u8 nss_mcs[5];
508};
509
510/**
511 * struct ieee80211_supported_band - frequency band definition
512 *
513 * This structure describes a frequency band a wiphy
514 * is able to operate in.
515 *
516 * @channels: Array of channels the hardware can operate with
517 * in this band.
518 * @band: the band this structure represents
519 * @n_channels: Number of channels in @channels
520 * @bitrates: Array of bitrates the hardware can operate with
521 * in this band. Must be sorted to give a valid "supported
522 * rates" IE, i.e. CCK rates first, then OFDM.
523 * @n_bitrates: Number of bitrates in @bitrates
524 * @ht_cap: HT capabilities in this band
525 * @vht_cap: VHT capabilities in this band
526 * @s1g_cap: S1G capabilities in this band
527 * @edmg_cap: EDMG capabilities in this band
528 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
529 * @n_iftype_data: number of iftype data entries
530 * @iftype_data: interface type data entries. Note that the bits in
531 * @types_mask inside this structure cannot overlap (i.e. only
532 * one occurrence of each type is allowed across all instances of
533 * iftype_data).
534 */
535struct ieee80211_supported_band {
536 struct ieee80211_channel *channels;
537 struct ieee80211_rate *bitrates;
538 enum nl80211_band band;
539 int n_channels;
540 int n_bitrates;
541 struct ieee80211_sta_ht_cap ht_cap;
542 struct ieee80211_sta_vht_cap vht_cap;
543 struct ieee80211_sta_s1g_cap s1g_cap;
544 struct ieee80211_edmg edmg_cap;
545 u16 n_iftype_data;
546 const struct ieee80211_sband_iftype_data *iftype_data;
547};
548
549/**
550 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
551 * @sband: the sband to search for the STA on
552 * @iftype: enum nl80211_iftype
553 *
554 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
555 */
556static inline const struct ieee80211_sband_iftype_data *
557ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
558 u8 iftype)
559{
560 int i;
561
562 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
563 return NULL;
564
565 for (i = 0; i < sband->n_iftype_data; i++) {
566 const struct ieee80211_sband_iftype_data *data =
567 &sband->iftype_data[i];
568
569 if (data->types_mask & BIT(iftype))
570 return data;
571 }
572
573 return NULL;
574}
575
576/**
577 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
578 * @sband: the sband to search for the iftype on
579 * @iftype: enum nl80211_iftype
580 *
581 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
582 */
583static inline const struct ieee80211_sta_he_cap *
584ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
585 u8 iftype)
586{
587 const struct ieee80211_sband_iftype_data *data =
588 ieee80211_get_sband_iftype_data(sband, iftype);
589
590 if (data && data->he_cap.has_he)
591 return &data->he_cap;
592
593 return NULL;
594}
595
596/**
597 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
598 * @sband: the sband to search for the STA on
599 * @iftype: the iftype to search for
600 *
601 * Return: the 6GHz capabilities
602 */
603static inline __le16
604ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
605 enum nl80211_iftype iftype)
606{
607 const struct ieee80211_sband_iftype_data *data =
608 ieee80211_get_sband_iftype_data(sband, iftype);
609
610 if (WARN_ON(!data || !data->he_cap.has_he))
611 return 0;
612
613 return data->he_6ghz_capa.capa;
614}
615
616/**
617 * ieee80211_get_eht_iftype_cap - return ETH capabilities for an sband's iftype
618 * @sband: the sband to search for the iftype on
619 * @iftype: enum nl80211_iftype
620 *
621 * Return: pointer to the struct ieee80211_sta_eht_cap, or NULL is none found
622 */
623static inline const struct ieee80211_sta_eht_cap *
624ieee80211_get_eht_iftype_cap(const struct ieee80211_supported_band *sband,
625 enum nl80211_iftype iftype)
626{
627 const struct ieee80211_sband_iftype_data *data =
628 ieee80211_get_sband_iftype_data(sband, iftype);
629
630 if (data && data->eht_cap.has_eht)
631 return &data->eht_cap;
632
633 return NULL;
634}
635
636/**
637 * wiphy_read_of_freq_limits - read frequency limits from device tree
638 *
639 * @wiphy: the wireless device to get extra limits for
640 *
641 * Some devices may have extra limitations specified in DT. This may be useful
642 * for chipsets that normally support more bands but are limited due to board
643 * design (e.g. by antennas or external power amplifier).
644 *
645 * This function reads info from DT and uses it to *modify* channels (disable
646 * unavailable ones). It's usually a *bad* idea to use it in drivers with
647 * shared channel data as DT limitations are device specific. You should make
648 * sure to call it only if channels in wiphy are copied and can be modified
649 * without affecting other devices.
650 *
651 * As this function access device node it has to be called after set_wiphy_dev.
652 * It also modifies channels so they have to be set first.
653 * If using this helper, call it before wiphy_register().
654 */
655#ifdef CONFIG_OF
656void wiphy_read_of_freq_limits(struct wiphy *wiphy);
657#else /* CONFIG_OF */
658static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
659{
660}
661#endif /* !CONFIG_OF */
662
663
664/*
665 * Wireless hardware/device configuration structures and methods
666 */
667
668/**
669 * DOC: Actions and configuration
670 *
671 * Each wireless device and each virtual interface offer a set of configuration
672 * operations and other actions that are invoked by userspace. Each of these
673 * actions is described in the operations structure, and the parameters these
674 * operations use are described separately.
675 *
676 * Additionally, some operations are asynchronous and expect to get status
677 * information via some functions that drivers need to call.
678 *
679 * Scanning and BSS list handling with its associated functionality is described
680 * in a separate chapter.
681 */
682
683#define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
684 WLAN_USER_POSITION_LEN)
685
686/**
687 * struct vif_params - describes virtual interface parameters
688 * @flags: monitor interface flags, unchanged if 0, otherwise
689 * %MONITOR_FLAG_CHANGED will be set
690 * @use_4addr: use 4-address frames
691 * @macaddr: address to use for this virtual interface.
692 * If this parameter is set to zero address the driver may
693 * determine the address as needed.
694 * This feature is only fully supported by drivers that enable the
695 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
696 ** only p2p devices with specified MAC.
697 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
698 * belonging to that MU-MIMO groupID; %NULL if not changed
699 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
700 * MU-MIMO packets going to the specified station; %NULL if not changed
701 */
702struct vif_params {
703 u32 flags;
704 int use_4addr;
705 u8 macaddr[ETH_ALEN];
706 const u8 *vht_mumimo_groups;
707 const u8 *vht_mumimo_follow_addr;
708};
709
710/**
711 * struct key_params - key information
712 *
713 * Information about a key
714 *
715 * @key: key material
716 * @key_len: length of key material
717 * @cipher: cipher suite selector
718 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
719 * with the get_key() callback, must be in little endian,
720 * length given by @seq_len.
721 * @seq_len: length of @seq.
722 * @vlan_id: vlan_id for VLAN group key (if nonzero)
723 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
724 */
725struct key_params {
726 const u8 *key;
727 const u8 *seq;
728 int key_len;
729 int seq_len;
730 u16 vlan_id;
731 u32 cipher;
732 enum nl80211_key_mode mode;
733};
734
735/**
736 * struct cfg80211_chan_def - channel definition
737 * @chan: the (control) channel
738 * @width: channel width
739 * @center_freq1: center frequency of first segment
740 * @center_freq2: center frequency of second segment
741 * (only with 80+80 MHz)
742 * @edmg: define the EDMG channels configuration.
743 * If edmg is requested (i.e. the .channels member is non-zero),
744 * chan will define the primary channel and all other
745 * parameters are ignored.
746 * @freq1_offset: offset from @center_freq1, in KHz
747 */
748struct cfg80211_chan_def {
749 struct ieee80211_channel *chan;
750 enum nl80211_chan_width width;
751 u32 center_freq1;
752 u32 center_freq2;
753 struct ieee80211_edmg edmg;
754 u16 freq1_offset;
755};
756
757/*
758 * cfg80211_bitrate_mask - masks for bitrate control
759 */
760struct cfg80211_bitrate_mask {
761 struct {
762 u32 legacy;
763 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
764 u16 vht_mcs[NL80211_VHT_NSS_MAX];
765 u16 he_mcs[NL80211_HE_NSS_MAX];
766 enum nl80211_txrate_gi gi;
767 enum nl80211_he_gi he_gi;
768 enum nl80211_he_ltf he_ltf;
769 } control[NUM_NL80211_BANDS];
770};
771
772
773/**
774 * struct cfg80211_tid_cfg - TID specific configuration
775 * @config_override: Flag to notify driver to reset TID configuration
776 * of the peer.
777 * @tids: bitmap of TIDs to modify
778 * @mask: bitmap of attributes indicating which parameter changed,
779 * similar to &nl80211_tid_config_supp.
780 * @noack: noack configuration value for the TID
781 * @retry_long: retry count value
782 * @retry_short: retry count value
783 * @ampdu: Enable/Disable MPDU aggregation
784 * @rtscts: Enable/Disable RTS/CTS
785 * @amsdu: Enable/Disable MSDU aggregation
786 * @txrate_type: Tx bitrate mask type
787 * @txrate_mask: Tx bitrate to be applied for the TID
788 */
789struct cfg80211_tid_cfg {
790 bool config_override;
791 u8 tids;
792 u64 mask;
793 enum nl80211_tid_config noack;
794 u8 retry_long, retry_short;
795 enum nl80211_tid_config ampdu;
796 enum nl80211_tid_config rtscts;
797 enum nl80211_tid_config amsdu;
798 enum nl80211_tx_rate_setting txrate_type;
799 struct cfg80211_bitrate_mask txrate_mask;
800};
801
802/**
803 * struct cfg80211_tid_config - TID configuration
804 * @peer: Station's MAC address
805 * @n_tid_conf: Number of TID specific configurations to be applied
806 * @tid_conf: Configuration change info
807 */
808struct cfg80211_tid_config {
809 const u8 *peer;
810 u32 n_tid_conf;
811 struct cfg80211_tid_cfg tid_conf[];
812};
813
814/**
815 * struct cfg80211_fils_aad - FILS AAD data
816 * @macaddr: STA MAC address
817 * @kek: FILS KEK
818 * @kek_len: FILS KEK length
819 * @snonce: STA Nonce
820 * @anonce: AP Nonce
821 */
822struct cfg80211_fils_aad {
823 const u8 *macaddr;
824 const u8 *kek;
825 u8 kek_len;
826 const u8 *snonce;
827 const u8 *anonce;
828};
829
830/**
831 * cfg80211_get_chandef_type - return old channel type from chandef
832 * @chandef: the channel definition
833 *
834 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
835 * chandef, which must have a bandwidth allowing this conversion.
836 */
837static inline enum nl80211_channel_type
838cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
839{
840 switch (chandef->width) {
841 case NL80211_CHAN_WIDTH_20_NOHT:
842 return NL80211_CHAN_NO_HT;
843 case NL80211_CHAN_WIDTH_20:
844 return NL80211_CHAN_HT20;
845 case NL80211_CHAN_WIDTH_40:
846 if (chandef->center_freq1 > chandef->chan->center_freq)
847 return NL80211_CHAN_HT40PLUS;
848 return NL80211_CHAN_HT40MINUS;
849 default:
850 WARN_ON(1);
851 return NL80211_CHAN_NO_HT;
852 }
853}
854
855/**
856 * cfg80211_chandef_create - create channel definition using channel type
857 * @chandef: the channel definition struct to fill
858 * @channel: the control channel
859 * @chantype: the channel type
860 *
861 * Given a channel type, create a channel definition.
862 */
863void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
864 struct ieee80211_channel *channel,
865 enum nl80211_channel_type chantype);
866
867/**
868 * cfg80211_chandef_identical - check if two channel definitions are identical
869 * @chandef1: first channel definition
870 * @chandef2: second channel definition
871 *
872 * Return: %true if the channels defined by the channel definitions are
873 * identical, %false otherwise.
874 */
875static inline bool
876cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
877 const struct cfg80211_chan_def *chandef2)
878{
879 return (chandef1->chan == chandef2->chan &&
880 chandef1->width == chandef2->width &&
881 chandef1->center_freq1 == chandef2->center_freq1 &&
882 chandef1->freq1_offset == chandef2->freq1_offset &&
883 chandef1->center_freq2 == chandef2->center_freq2);
884}
885
886/**
887 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
888 *
889 * @chandef: the channel definition
890 *
891 * Return: %true if EDMG defined, %false otherwise.
892 */
893static inline bool
894cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
895{
896 return chandef->edmg.channels || chandef->edmg.bw_config;
897}
898
899/**
900 * cfg80211_chandef_compatible - check if two channel definitions are compatible
901 * @chandef1: first channel definition
902 * @chandef2: second channel definition
903 *
904 * Return: %NULL if the given channel definitions are incompatible,
905 * chandef1 or chandef2 otherwise.
906 */
907const struct cfg80211_chan_def *
908cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
909 const struct cfg80211_chan_def *chandef2);
910
911/**
912 * cfg80211_chandef_valid - check if a channel definition is valid
913 * @chandef: the channel definition to check
914 * Return: %true if the channel definition is valid. %false otherwise.
915 */
916bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
917
918/**
919 * cfg80211_chandef_usable - check if secondary channels can be used
920 * @wiphy: the wiphy to validate against
921 * @chandef: the channel definition to check
922 * @prohibited_flags: the regulatory channel flags that must not be set
923 * Return: %true if secondary channels are usable. %false otherwise.
924 */
925bool cfg80211_chandef_usable(struct wiphy *wiphy,
926 const struct cfg80211_chan_def *chandef,
927 u32 prohibited_flags);
928
929/**
930 * cfg80211_chandef_dfs_required - checks if radar detection is required
931 * @wiphy: the wiphy to validate against
932 * @chandef: the channel definition to check
933 * @iftype: the interface type as specified in &enum nl80211_iftype
934 * Returns:
935 * 1 if radar detection is required, 0 if it is not, < 0 on error
936 */
937int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
938 const struct cfg80211_chan_def *chandef,
939 enum nl80211_iftype iftype);
940
941/**
942 * ieee80211_chanwidth_rate_flags - return rate flags for channel width
943 * @width: the channel width of the channel
944 *
945 * In some channel types, not all rates may be used - for example CCK
946 * rates may not be used in 5/10 MHz channels.
947 *
948 * Returns: rate flags which apply for this channel width
949 */
950static inline enum ieee80211_rate_flags
951ieee80211_chanwidth_rate_flags(enum nl80211_chan_width width)
952{
953 switch (width) {
954 case NL80211_CHAN_WIDTH_5:
955 return IEEE80211_RATE_SUPPORTS_5MHZ;
956 case NL80211_CHAN_WIDTH_10:
957 return IEEE80211_RATE_SUPPORTS_10MHZ;
958 default:
959 break;
960 }
961 return 0;
962}
963
964/**
965 * ieee80211_chandef_rate_flags - returns rate flags for a channel
966 * @chandef: channel definition for the channel
967 *
968 * See ieee80211_chanwidth_rate_flags().
969 *
970 * Returns: rate flags which apply for this channel
971 */
972static inline enum ieee80211_rate_flags
973ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
974{
975 return ieee80211_chanwidth_rate_flags(chandef->width);
976}
977
978/**
979 * ieee80211_chandef_max_power - maximum transmission power for the chandef
980 *
981 * In some regulations, the transmit power may depend on the configured channel
982 * bandwidth which may be defined as dBm/MHz. This function returns the actual
983 * max_power for non-standard (20 MHz) channels.
984 *
985 * @chandef: channel definition for the channel
986 *
987 * Returns: maximum allowed transmission power in dBm for the chandef
988 */
989static inline int
990ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
991{
992 switch (chandef->width) {
993 case NL80211_CHAN_WIDTH_5:
994 return min(chandef->chan->max_reg_power - 6,
995 chandef->chan->max_power);
996 case NL80211_CHAN_WIDTH_10:
997 return min(chandef->chan->max_reg_power - 3,
998 chandef->chan->max_power);
999 default:
1000 break;
1001 }
1002 return chandef->chan->max_power;
1003}
1004
1005/**
1006 * cfg80211_any_usable_channels - check for usable channels
1007 * @wiphy: the wiphy to check for
1008 * @band_mask: which bands to check on
1009 * @prohibited_flags: which channels to not consider usable,
1010 * %IEEE80211_CHAN_DISABLED is always taken into account
1011 */
1012bool cfg80211_any_usable_channels(struct wiphy *wiphy,
1013 unsigned long band_mask,
1014 u32 prohibited_flags);
1015
1016/**
1017 * enum survey_info_flags - survey information flags
1018 *
1019 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
1020 * @SURVEY_INFO_IN_USE: channel is currently being used
1021 * @SURVEY_INFO_TIME: active time (in ms) was filled in
1022 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
1023 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
1024 * @SURVEY_INFO_TIME_RX: receive time was filled in
1025 * @SURVEY_INFO_TIME_TX: transmit time was filled in
1026 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
1027 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
1028 *
1029 * Used by the driver to indicate which info in &struct survey_info
1030 * it has filled in during the get_survey().
1031 */
1032enum survey_info_flags {
1033 SURVEY_INFO_NOISE_DBM = BIT(0),
1034 SURVEY_INFO_IN_USE = BIT(1),
1035 SURVEY_INFO_TIME = BIT(2),
1036 SURVEY_INFO_TIME_BUSY = BIT(3),
1037 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
1038 SURVEY_INFO_TIME_RX = BIT(5),
1039 SURVEY_INFO_TIME_TX = BIT(6),
1040 SURVEY_INFO_TIME_SCAN = BIT(7),
1041 SURVEY_INFO_TIME_BSS_RX = BIT(8),
1042};
1043
1044/**
1045 * struct survey_info - channel survey response
1046 *
1047 * @channel: the channel this survey record reports, may be %NULL for a single
1048 * record to report global statistics
1049 * @filled: bitflag of flags from &enum survey_info_flags
1050 * @noise: channel noise in dBm. This and all following fields are
1051 * optional
1052 * @time: amount of time in ms the radio was turn on (on the channel)
1053 * @time_busy: amount of time the primary channel was sensed busy
1054 * @time_ext_busy: amount of time the extension channel was sensed busy
1055 * @time_rx: amount of time the radio spent receiving data
1056 * @time_tx: amount of time the radio spent transmitting data
1057 * @time_scan: amount of time the radio spent for scanning
1058 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
1059 *
1060 * Used by dump_survey() to report back per-channel survey information.
1061 *
1062 * This structure can later be expanded with things like
1063 * channel duty cycle etc.
1064 */
1065struct survey_info {
1066 struct ieee80211_channel *channel;
1067 u64 time;
1068 u64 time_busy;
1069 u64 time_ext_busy;
1070 u64 time_rx;
1071 u64 time_tx;
1072 u64 time_scan;
1073 u64 time_bss_rx;
1074 u32 filled;
1075 s8 noise;
1076};
1077
1078#define CFG80211_MAX_WEP_KEYS 4
1079#define CFG80211_MAX_NUM_AKM_SUITES 10
1080
1081/**
1082 * struct cfg80211_crypto_settings - Crypto settings
1083 * @wpa_versions: indicates which, if any, WPA versions are enabled
1084 * (from enum nl80211_wpa_versions)
1085 * @cipher_group: group key cipher suite (or 0 if unset)
1086 * @n_ciphers_pairwise: number of AP supported unicast ciphers
1087 * @ciphers_pairwise: unicast key cipher suites
1088 * @n_akm_suites: number of AKM suites
1089 * @akm_suites: AKM suites
1090 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
1091 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1092 * required to assume that the port is unauthorized until authorized by
1093 * user space. Otherwise, port is marked authorized by default.
1094 * @control_port_ethertype: the control port protocol that should be
1095 * allowed through even on unauthorized ports
1096 * @control_port_no_encrypt: TRUE to prevent encryption of control port
1097 * protocol frames.
1098 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1099 * port frames over NL80211 instead of the network interface.
1100 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
1101 * port for mac80211
1102 * @wep_keys: static WEP keys, if not NULL points to an array of
1103 * CFG80211_MAX_WEP_KEYS WEP keys
1104 * @wep_tx_key: key index (0..3) of the default TX static WEP key
1105 * @psk: PSK (for devices supporting 4-way-handshake offload)
1106 * @sae_pwd: password for SAE authentication (for devices supporting SAE
1107 * offload)
1108 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1109 * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
1110 *
1111 * NL80211_SAE_PWE_UNSPECIFIED
1112 * Not-specified, used to indicate userspace did not specify any
1113 * preference. The driver should follow its internal policy in
1114 * such a scenario.
1115 *
1116 * NL80211_SAE_PWE_HUNT_AND_PECK
1117 * Allow hunting-and-pecking loop only
1118 *
1119 * NL80211_SAE_PWE_HASH_TO_ELEMENT
1120 * Allow hash-to-element only
1121 *
1122 * NL80211_SAE_PWE_BOTH
1123 * Allow either hunting-and-pecking loop or hash-to-element
1124 */
1125struct cfg80211_crypto_settings {
1126 u32 wpa_versions;
1127 u32 cipher_group;
1128 int n_ciphers_pairwise;
1129 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1130 int n_akm_suites;
1131 u32 akm_suites[CFG80211_MAX_NUM_AKM_SUITES];
1132 bool control_port;
1133 __be16 control_port_ethertype;
1134 bool control_port_no_encrypt;
1135 bool control_port_over_nl80211;
1136 bool control_port_no_preauth;
1137 struct key_params *wep_keys;
1138 int wep_tx_key;
1139 const u8 *psk;
1140 const u8 *sae_pwd;
1141 u8 sae_pwd_len;
1142 enum nl80211_sae_pwe_mechanism sae_pwe;
1143};
1144
1145/**
1146 * struct cfg80211_mbssid_config - AP settings for multi bssid
1147 *
1148 * @tx_wdev: pointer to the transmitted interface in the MBSSID set
1149 * @index: index of this AP in the multi bssid group.
1150 * @ema: set to true if the beacons should be sent out in EMA mode.
1151 */
1152struct cfg80211_mbssid_config {
1153 struct wireless_dev *tx_wdev;
1154 u8 index;
1155 bool ema;
1156};
1157
1158/**
1159 * struct cfg80211_mbssid_elems - Multiple BSSID elements
1160 *
1161 * @cnt: Number of elements in array %elems.
1162 *
1163 * @elem: Array of multiple BSSID element(s) to be added into Beacon frames.
1164 * @elem.data: Data for multiple BSSID elements.
1165 * @elem.len: Length of data.
1166 */
1167struct cfg80211_mbssid_elems {
1168 u8 cnt;
1169 struct {
1170 const u8 *data;
1171 size_t len;
1172 } elem[];
1173};
1174
1175/**
1176 * struct cfg80211_beacon_data - beacon data
1177 * @link_id: the link ID for the AP MLD link sending this beacon
1178 * @head: head portion of beacon (before TIM IE)
1179 * or %NULL if not changed
1180 * @tail: tail portion of beacon (after TIM IE)
1181 * or %NULL if not changed
1182 * @head_len: length of @head
1183 * @tail_len: length of @tail
1184 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1185 * @beacon_ies_len: length of beacon_ies in octets
1186 * @proberesp_ies: extra information element(s) to add into Probe Response
1187 * frames or %NULL
1188 * @proberesp_ies_len: length of proberesp_ies in octets
1189 * @assocresp_ies: extra information element(s) to add into (Re)Association
1190 * Response frames or %NULL
1191 * @assocresp_ies_len: length of assocresp_ies in octets
1192 * @probe_resp_len: length of probe response template (@probe_resp)
1193 * @probe_resp: probe response template (AP mode only)
1194 * @mbssid_ies: multiple BSSID elements
1195 * @ftm_responder: enable FTM responder functionality; -1 for no change
1196 * (which also implies no change in LCI/civic location data)
1197 * @lci: Measurement Report element content, starting with Measurement Token
1198 * (measurement type 8)
1199 * @civicloc: Measurement Report element content, starting with Measurement
1200 * Token (measurement type 11)
1201 * @lci_len: LCI data length
1202 * @civicloc_len: Civic location data length
1203 * @he_bss_color: BSS Color settings
1204 * @he_bss_color_valid: indicates whether bss color
1205 * attribute is present in beacon data or not.
1206 */
1207struct cfg80211_beacon_data {
1208 unsigned int link_id;
1209
1210 const u8 *head, *tail;
1211 const u8 *beacon_ies;
1212 const u8 *proberesp_ies;
1213 const u8 *assocresp_ies;
1214 const u8 *probe_resp;
1215 const u8 *lci;
1216 const u8 *civicloc;
1217 struct cfg80211_mbssid_elems *mbssid_ies;
1218 s8 ftm_responder;
1219
1220 size_t head_len, tail_len;
1221 size_t beacon_ies_len;
1222 size_t proberesp_ies_len;
1223 size_t assocresp_ies_len;
1224 size_t probe_resp_len;
1225 size_t lci_len;
1226 size_t civicloc_len;
1227 struct cfg80211_he_bss_color he_bss_color;
1228 bool he_bss_color_valid;
1229};
1230
1231struct mac_address {
1232 u8 addr[ETH_ALEN];
1233};
1234
1235/**
1236 * struct cfg80211_acl_data - Access control list data
1237 *
1238 * @acl_policy: ACL policy to be applied on the station's
1239 * entry specified by mac_addr
1240 * @n_acl_entries: Number of MAC address entries passed
1241 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1242 */
1243struct cfg80211_acl_data {
1244 enum nl80211_acl_policy acl_policy;
1245 int n_acl_entries;
1246
1247 /* Keep it last */
1248 struct mac_address mac_addrs[];
1249};
1250
1251/**
1252 * struct cfg80211_fils_discovery - FILS discovery parameters from
1253 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1254 *
1255 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1256 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1257 * @tmpl_len: Template length
1258 * @tmpl: Template data for FILS discovery frame including the action
1259 * frame headers.
1260 */
1261struct cfg80211_fils_discovery {
1262 u32 min_interval;
1263 u32 max_interval;
1264 size_t tmpl_len;
1265 const u8 *tmpl;
1266};
1267
1268/**
1269 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1270 * response parameters in 6GHz.
1271 *
1272 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1273 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1274 * scanning
1275 * @tmpl_len: Template length
1276 * @tmpl: Template data for probe response
1277 */
1278struct cfg80211_unsol_bcast_probe_resp {
1279 u32 interval;
1280 size_t tmpl_len;
1281 const u8 *tmpl;
1282};
1283
1284/**
1285 * struct cfg80211_ap_settings - AP configuration
1286 *
1287 * Used to configure an AP interface.
1288 *
1289 * @chandef: defines the channel to use
1290 * @beacon: beacon data
1291 * @beacon_interval: beacon interval
1292 * @dtim_period: DTIM period
1293 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1294 * user space)
1295 * @ssid_len: length of @ssid
1296 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1297 * @crypto: crypto settings
1298 * @privacy: the BSS uses privacy
1299 * @auth_type: Authentication type (algorithm)
1300 * @smps_mode: SMPS mode
1301 * @inactivity_timeout: time in seconds to determine station's inactivity.
1302 * @p2p_ctwindow: P2P CT Window
1303 * @p2p_opp_ps: P2P opportunistic PS
1304 * @acl: ACL configuration used by the drivers which has support for
1305 * MAC address based access control
1306 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1307 * networks.
1308 * @beacon_rate: bitrate to be used for beacons
1309 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1310 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1311 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1312 * @eht_cap: EHT capabilities (or %NULL if EHT isn't enabled)
1313 * @eht_oper: EHT operation IE (or %NULL if EHT isn't enabled)
1314 * @ht_required: stations must support HT
1315 * @vht_required: stations must support VHT
1316 * @twt_responder: Enable Target Wait Time
1317 * @he_required: stations must support HE
1318 * @sae_h2e_required: stations must support direct H2E technique in SAE
1319 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1320 * @he_obss_pd: OBSS Packet Detection settings
1321 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1322 * @fils_discovery: FILS discovery transmission parameters
1323 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1324 * @mbssid_config: AP settings for multiple bssid
1325 */
1326struct cfg80211_ap_settings {
1327 struct cfg80211_chan_def chandef;
1328
1329 struct cfg80211_beacon_data beacon;
1330
1331 int beacon_interval, dtim_period;
1332 const u8 *ssid;
1333 size_t ssid_len;
1334 enum nl80211_hidden_ssid hidden_ssid;
1335 struct cfg80211_crypto_settings crypto;
1336 bool privacy;
1337 enum nl80211_auth_type auth_type;
1338 enum nl80211_smps_mode smps_mode;
1339 int inactivity_timeout;
1340 u8 p2p_ctwindow;
1341 bool p2p_opp_ps;
1342 const struct cfg80211_acl_data *acl;
1343 bool pbss;
1344 struct cfg80211_bitrate_mask beacon_rate;
1345
1346 const struct ieee80211_ht_cap *ht_cap;
1347 const struct ieee80211_vht_cap *vht_cap;
1348 const struct ieee80211_he_cap_elem *he_cap;
1349 const struct ieee80211_he_operation *he_oper;
1350 const struct ieee80211_eht_cap_elem *eht_cap;
1351 const struct ieee80211_eht_operation *eht_oper;
1352 bool ht_required, vht_required, he_required, sae_h2e_required;
1353 bool twt_responder;
1354 u32 flags;
1355 struct ieee80211_he_obss_pd he_obss_pd;
1356 struct cfg80211_fils_discovery fils_discovery;
1357 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1358 struct cfg80211_mbssid_config mbssid_config;
1359};
1360
1361/**
1362 * struct cfg80211_csa_settings - channel switch settings
1363 *
1364 * Used for channel switch
1365 *
1366 * @chandef: defines the channel to use after the switch
1367 * @beacon_csa: beacon data while performing the switch
1368 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1369 * @counter_offsets_presp: offsets of the counters within the probe response
1370 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1371 * @n_counter_offsets_presp: number of csa counters in the probe response
1372 * @beacon_after: beacon data to be used on the new channel
1373 * @radar_required: whether radar detection is required on the new channel
1374 * @block_tx: whether transmissions should be blocked while changing
1375 * @count: number of beacons until switch
1376 */
1377struct cfg80211_csa_settings {
1378 struct cfg80211_chan_def chandef;
1379 struct cfg80211_beacon_data beacon_csa;
1380 const u16 *counter_offsets_beacon;
1381 const u16 *counter_offsets_presp;
1382 unsigned int n_counter_offsets_beacon;
1383 unsigned int n_counter_offsets_presp;
1384 struct cfg80211_beacon_data beacon_after;
1385 bool radar_required;
1386 bool block_tx;
1387 u8 count;
1388};
1389
1390/**
1391 * struct cfg80211_color_change_settings - color change settings
1392 *
1393 * Used for bss color change
1394 *
1395 * @beacon_color_change: beacon data while performing the color countdown
1396 * @counter_offset_beacon: offsets of the counters within the beacon (tail)
1397 * @counter_offset_presp: offsets of the counters within the probe response
1398 * @beacon_next: beacon data to be used after the color change
1399 * @count: number of beacons until the color change
1400 * @color: the color used after the change
1401 */
1402struct cfg80211_color_change_settings {
1403 struct cfg80211_beacon_data beacon_color_change;
1404 u16 counter_offset_beacon;
1405 u16 counter_offset_presp;
1406 struct cfg80211_beacon_data beacon_next;
1407 u8 count;
1408 u8 color;
1409};
1410
1411/**
1412 * struct iface_combination_params - input parameters for interface combinations
1413 *
1414 * Used to pass interface combination parameters
1415 *
1416 * @num_different_channels: the number of different channels we want
1417 * to use for verification
1418 * @radar_detect: a bitmap where each bit corresponds to a channel
1419 * width where radar detection is needed, as in the definition of
1420 * &struct ieee80211_iface_combination.@radar_detect_widths
1421 * @iftype_num: array with the number of interfaces of each interface
1422 * type. The index is the interface type as specified in &enum
1423 * nl80211_iftype.
1424 * @new_beacon_int: set this to the beacon interval of a new interface
1425 * that's not operating yet, if such is to be checked as part of
1426 * the verification
1427 */
1428struct iface_combination_params {
1429 int num_different_channels;
1430 u8 radar_detect;
1431 int iftype_num[NUM_NL80211_IFTYPES];
1432 u32 new_beacon_int;
1433};
1434
1435/**
1436 * enum station_parameters_apply_mask - station parameter values to apply
1437 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1438 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1439 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1440 * @STATION_PARAM_APPLY_STA_TXPOWER: apply tx power for STA
1441 *
1442 * Not all station parameters have in-band "no change" signalling,
1443 * for those that don't these flags will are used.
1444 */
1445enum station_parameters_apply_mask {
1446 STATION_PARAM_APPLY_UAPSD = BIT(0),
1447 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1448 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1449};
1450
1451/**
1452 * struct sta_txpwr - station txpower configuration
1453 *
1454 * Used to configure txpower for station.
1455 *
1456 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1457 * is not provided, the default per-interface tx power setting will be
1458 * overriding. Driver should be picking up the lowest tx power, either tx
1459 * power per-interface or per-station.
1460 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1461 * will be less than or equal to specified from userspace, whereas if TPC
1462 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1463 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1464 * per peer TPC.
1465 */
1466struct sta_txpwr {
1467 s16 power;
1468 enum nl80211_tx_power_setting type;
1469};
1470
1471/**
1472 * struct link_station_parameters - link station parameters
1473 *
1474 * Used to change and create a new link station.
1475 *
1476 * @mld_mac: MAC address of the station
1477 * @link_id: the link id (-1 for non-MLD station)
1478 * @link_mac: MAC address of the link
1479 * @supported_rates: supported rates in IEEE 802.11 format
1480 * (or NULL for no change)
1481 * @supported_rates_len: number of supported rates
1482 * @ht_capa: HT capabilities of station
1483 * @vht_capa: VHT capabilities of station
1484 * @opmode_notif: operating mode field from Operating Mode Notification
1485 * @opmode_notif_used: information if operating mode field is used
1486 * @he_capa: HE capabilities of station
1487 * @he_capa_len: the length of the HE capabilities
1488 * @txpwr: transmit power for an associated station
1489 * @txpwr_set: txpwr field is set
1490 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1491 * @eht_capa: EHT capabilities of station
1492 * @eht_capa_len: the length of the EHT capabilities
1493 */
1494struct link_station_parameters {
1495 const u8 *mld_mac;
1496 int link_id;
1497 const u8 *link_mac;
1498 const u8 *supported_rates;
1499 u8 supported_rates_len;
1500 const struct ieee80211_ht_cap *ht_capa;
1501 const struct ieee80211_vht_cap *vht_capa;
1502 u8 opmode_notif;
1503 bool opmode_notif_used;
1504 const struct ieee80211_he_cap_elem *he_capa;
1505 u8 he_capa_len;
1506 struct sta_txpwr txpwr;
1507 bool txpwr_set;
1508 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1509 const struct ieee80211_eht_cap_elem *eht_capa;
1510 u8 eht_capa_len;
1511};
1512
1513/**
1514 * struct link_station_del_parameters - link station deletion parameters
1515 *
1516 * Used to delete a link station entry (or all stations).
1517 *
1518 * @mld_mac: MAC address of the station
1519 * @link_id: the link id
1520 */
1521struct link_station_del_parameters {
1522 const u8 *mld_mac;
1523 u32 link_id;
1524};
1525
1526/**
1527 * struct station_parameters - station parameters
1528 *
1529 * Used to change and create a new station.
1530 *
1531 * @vlan: vlan interface station should belong to
1532 * @sta_flags_mask: station flags that changed
1533 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1534 * @sta_flags_set: station flags values
1535 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1536 * @listen_interval: listen interval or -1 for no change
1537 * @aid: AID or zero for no change
1538 * @vlan_id: VLAN ID for station (if nonzero)
1539 * @peer_aid: mesh peer AID or zero for no change
1540 * @plink_action: plink action to take
1541 * @plink_state: set the peer link state for a station
1542 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1543 * as the AC bitmap in the QoS info field
1544 * @max_sp: max Service Period. same format as the MAX_SP in the
1545 * QoS info field (but already shifted down)
1546 * @sta_modify_mask: bitmap indicating which parameters changed
1547 * (for those that don't have a natural "no change" value),
1548 * see &enum station_parameters_apply_mask
1549 * @local_pm: local link-specific mesh power save mode (no change when set
1550 * to unknown)
1551 * @capability: station capability
1552 * @ext_capab: extended capabilities of the station
1553 * @ext_capab_len: number of extended capabilities
1554 * @supported_channels: supported channels in IEEE 802.11 format
1555 * @supported_channels_len: number of supported channels
1556 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1557 * @supported_oper_classes_len: number of supported operating classes
1558 * @support_p2p_ps: information if station supports P2P PS mechanism
1559 * @airtime_weight: airtime scheduler weight for this station
1560 * @link_sta_params: link related params.
1561 */
1562struct station_parameters {
1563 struct net_device *vlan;
1564 u32 sta_flags_mask, sta_flags_set;
1565 u32 sta_modify_mask;
1566 int listen_interval;
1567 u16 aid;
1568 u16 vlan_id;
1569 u16 peer_aid;
1570 u8 plink_action;
1571 u8 plink_state;
1572 u8 uapsd_queues;
1573 u8 max_sp;
1574 enum nl80211_mesh_power_mode local_pm;
1575 u16 capability;
1576 const u8 *ext_capab;
1577 u8 ext_capab_len;
1578 const u8 *supported_channels;
1579 u8 supported_channels_len;
1580 const u8 *supported_oper_classes;
1581 u8 supported_oper_classes_len;
1582 int support_p2p_ps;
1583 u16 airtime_weight;
1584 struct link_station_parameters link_sta_params;
1585};
1586
1587/**
1588 * struct station_del_parameters - station deletion parameters
1589 *
1590 * Used to delete a station entry (or all stations).
1591 *
1592 * @mac: MAC address of the station to remove or NULL to remove all stations
1593 * @subtype: Management frame subtype to use for indicating removal
1594 * (10 = Disassociation, 12 = Deauthentication)
1595 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1596 */
1597struct station_del_parameters {
1598 const u8 *mac;
1599 u8 subtype;
1600 u16 reason_code;
1601};
1602
1603/**
1604 * enum cfg80211_station_type - the type of station being modified
1605 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1606 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1607 * unassociated (update properties for this type of client is permitted)
1608 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1609 * the AP MLME in the device
1610 * @CFG80211_STA_AP_STA: AP station on managed interface
1611 * @CFG80211_STA_IBSS: IBSS station
1612 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1613 * while TDLS setup is in progress, it moves out of this state when
1614 * being marked authorized; use this only if TDLS with external setup is
1615 * supported/used)
1616 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1617 * entry that is operating, has been marked authorized by userspace)
1618 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1619 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1620 */
1621enum cfg80211_station_type {
1622 CFG80211_STA_AP_CLIENT,
1623 CFG80211_STA_AP_CLIENT_UNASSOC,
1624 CFG80211_STA_AP_MLME_CLIENT,
1625 CFG80211_STA_AP_STA,
1626 CFG80211_STA_IBSS,
1627 CFG80211_STA_TDLS_PEER_SETUP,
1628 CFG80211_STA_TDLS_PEER_ACTIVE,
1629 CFG80211_STA_MESH_PEER_KERNEL,
1630 CFG80211_STA_MESH_PEER_USER,
1631};
1632
1633/**
1634 * cfg80211_check_station_change - validate parameter changes
1635 * @wiphy: the wiphy this operates on
1636 * @params: the new parameters for a station
1637 * @statype: the type of station being modified
1638 *
1639 * Utility function for the @change_station driver method. Call this function
1640 * with the appropriate station type looking up the station (and checking that
1641 * it exists). It will verify whether the station change is acceptable, and if
1642 * not will return an error code. Note that it may modify the parameters for
1643 * backward compatibility reasons, so don't use them before calling this.
1644 */
1645int cfg80211_check_station_change(struct wiphy *wiphy,
1646 struct station_parameters *params,
1647 enum cfg80211_station_type statype);
1648
1649/**
1650 * enum rate_info_flags - bitrate info flags
1651 *
1652 * Used by the driver to indicate the specific rate transmission
1653 * type for 802.11n transmissions.
1654 *
1655 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1656 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1657 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1658 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1659 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1660 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1661 * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS
1662 * @RATE_INFO_FLAGS_EHT_MCS: EHT MCS information
1663 */
1664enum rate_info_flags {
1665 RATE_INFO_FLAGS_MCS = BIT(0),
1666 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1667 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1668 RATE_INFO_FLAGS_DMG = BIT(3),
1669 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1670 RATE_INFO_FLAGS_EDMG = BIT(5),
1671 RATE_INFO_FLAGS_EXTENDED_SC_DMG = BIT(6),
1672 RATE_INFO_FLAGS_EHT_MCS = BIT(7),
1673};
1674
1675/**
1676 * enum rate_info_bw - rate bandwidth information
1677 *
1678 * Used by the driver to indicate the rate bandwidth.
1679 *
1680 * @RATE_INFO_BW_5: 5 MHz bandwidth
1681 * @RATE_INFO_BW_10: 10 MHz bandwidth
1682 * @RATE_INFO_BW_20: 20 MHz bandwidth
1683 * @RATE_INFO_BW_40: 40 MHz bandwidth
1684 * @RATE_INFO_BW_80: 80 MHz bandwidth
1685 * @RATE_INFO_BW_160: 160 MHz bandwidth
1686 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1687 * @RATE_INFO_BW_320: 320 MHz bandwidth
1688 * @RATE_INFO_BW_EHT_RU: bandwidth determined by EHT RU allocation
1689 */
1690enum rate_info_bw {
1691 RATE_INFO_BW_20 = 0,
1692 RATE_INFO_BW_5,
1693 RATE_INFO_BW_10,
1694 RATE_INFO_BW_40,
1695 RATE_INFO_BW_80,
1696 RATE_INFO_BW_160,
1697 RATE_INFO_BW_HE_RU,
1698 RATE_INFO_BW_320,
1699 RATE_INFO_BW_EHT_RU,
1700};
1701
1702/**
1703 * struct rate_info - bitrate information
1704 *
1705 * Information about a receiving or transmitting bitrate
1706 *
1707 * @flags: bitflag of flags from &enum rate_info_flags
1708 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1709 * @legacy: bitrate in 100kbit/s for 802.11abg
1710 * @nss: number of streams (VHT & HE only)
1711 * @bw: bandwidth (from &enum rate_info_bw)
1712 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1713 * @he_dcm: HE DCM value
1714 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1715 * only valid if bw is %RATE_INFO_BW_HE_RU)
1716 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1717 * @eht_gi: EHT guard interval (from &enum nl80211_eht_gi)
1718 * @eht_ru_alloc: EHT RU allocation (from &enum nl80211_eht_ru_alloc,
1719 * only valid if bw is %RATE_INFO_BW_EHT_RU)
1720 */
1721struct rate_info {
1722 u8 flags;
1723 u8 mcs;
1724 u16 legacy;
1725 u8 nss;
1726 u8 bw;
1727 u8 he_gi;
1728 u8 he_dcm;
1729 u8 he_ru_alloc;
1730 u8 n_bonded_ch;
1731 u8 eht_gi;
1732 u8 eht_ru_alloc;
1733};
1734
1735/**
1736 * enum bss_param_flags - bitrate info flags
1737 *
1738 * Used by the driver to indicate the specific rate transmission
1739 * type for 802.11n transmissions.
1740 *
1741 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1742 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1743 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1744 */
1745enum bss_param_flags {
1746 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1747 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1748 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1749};
1750
1751/**
1752 * struct sta_bss_parameters - BSS parameters for the attached station
1753 *
1754 * Information about the currently associated BSS
1755 *
1756 * @flags: bitflag of flags from &enum bss_param_flags
1757 * @dtim_period: DTIM period for the BSS
1758 * @beacon_interval: beacon interval
1759 */
1760struct sta_bss_parameters {
1761 u8 flags;
1762 u8 dtim_period;
1763 u16 beacon_interval;
1764};
1765
1766/**
1767 * struct cfg80211_txq_stats - TXQ statistics for this TID
1768 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1769 * indicate the relevant values in this struct are filled
1770 * @backlog_bytes: total number of bytes currently backlogged
1771 * @backlog_packets: total number of packets currently backlogged
1772 * @flows: number of new flows seen
1773 * @drops: total number of packets dropped
1774 * @ecn_marks: total number of packets marked with ECN CE
1775 * @overlimit: number of drops due to queue space overflow
1776 * @overmemory: number of drops due to memory limit overflow
1777 * @collisions: number of hash collisions
1778 * @tx_bytes: total number of bytes dequeued
1779 * @tx_packets: total number of packets dequeued
1780 * @max_flows: maximum number of flows supported
1781 */
1782struct cfg80211_txq_stats {
1783 u32 filled;
1784 u32 backlog_bytes;
1785 u32 backlog_packets;
1786 u32 flows;
1787 u32 drops;
1788 u32 ecn_marks;
1789 u32 overlimit;
1790 u32 overmemory;
1791 u32 collisions;
1792 u32 tx_bytes;
1793 u32 tx_packets;
1794 u32 max_flows;
1795};
1796
1797/**
1798 * struct cfg80211_tid_stats - per-TID statistics
1799 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1800 * indicate the relevant values in this struct are filled
1801 * @rx_msdu: number of received MSDUs
1802 * @tx_msdu: number of (attempted) transmitted MSDUs
1803 * @tx_msdu_retries: number of retries (not counting the first) for
1804 * transmitted MSDUs
1805 * @tx_msdu_failed: number of failed transmitted MSDUs
1806 * @txq_stats: TXQ statistics
1807 */
1808struct cfg80211_tid_stats {
1809 u32 filled;
1810 u64 rx_msdu;
1811 u64 tx_msdu;
1812 u64 tx_msdu_retries;
1813 u64 tx_msdu_failed;
1814 struct cfg80211_txq_stats txq_stats;
1815};
1816
1817#define IEEE80211_MAX_CHAINS 4
1818
1819/**
1820 * struct station_info - station information
1821 *
1822 * Station information filled by driver for get_station() and dump_station.
1823 *
1824 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1825 * indicate the relevant values in this struct for them
1826 * @connected_time: time(in secs) since a station is last connected
1827 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1828 * @assoc_at: bootime (ns) of the last association
1829 * @rx_bytes: bytes (size of MPDUs) received from this station
1830 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1831 * @llid: mesh local link id
1832 * @plid: mesh peer link id
1833 * @plink_state: mesh peer link state
1834 * @signal: The signal strength, type depends on the wiphy's signal_type.
1835 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1836 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1837 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1838 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1839 * @chain_signal: per-chain signal strength of last received packet in dBm
1840 * @chain_signal_avg: per-chain signal strength average in dBm
1841 * @txrate: current unicast bitrate from this station
1842 * @rxrate: current unicast bitrate to this station
1843 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1844 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1845 * @tx_retries: cumulative retry counts (MPDUs)
1846 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1847 * @rx_dropped_misc: Dropped for un-specified reason.
1848 * @bss_param: current BSS parameters
1849 * @generation: generation number for nl80211 dumps.
1850 * This number should increase every time the list of stations
1851 * changes, i.e. when a station is added or removed, so that
1852 * userspace can tell whether it got a consistent snapshot.
1853 * @assoc_req_ies: IEs from (Re)Association Request.
1854 * This is used only when in AP mode with drivers that do not use
1855 * user space MLME/SME implementation. The information is provided for
1856 * the cfg80211_new_sta() calls to notify user space of the IEs.
1857 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1858 * @sta_flags: station flags mask & values
1859 * @beacon_loss_count: Number of times beacon loss event has triggered.
1860 * @t_offset: Time offset of the station relative to this host.
1861 * @local_pm: local mesh STA power save mode
1862 * @peer_pm: peer mesh STA power save mode
1863 * @nonpeer_pm: non-peer mesh STA power save mode
1864 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1865 * towards this station.
1866 * @rx_beacon: number of beacons received from this peer
1867 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1868 * from this peer
1869 * @connected_to_gate: true if mesh STA has a path to mesh gate
1870 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1871 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1872 * @airtime_weight: current airtime scheduling weight
1873 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1874 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1875 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1876 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1877 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1878 * been sent.
1879 * @rx_mpdu_count: number of MPDUs received from this station
1880 * @fcs_err_count: number of packets (MPDUs) received from this station with
1881 * an FCS error. This counter should be incremented only when TA of the
1882 * received packet with an FCS error matches the peer MAC address.
1883 * @airtime_link_metric: mesh airtime link metric.
1884 * @connected_to_as: true if mesh STA has a path to authentication server
1885 */
1886struct station_info {
1887 u64 filled;
1888 u32 connected_time;
1889 u32 inactive_time;
1890 u64 assoc_at;
1891 u64 rx_bytes;
1892 u64 tx_bytes;
1893 u16 llid;
1894 u16 plid;
1895 u8 plink_state;
1896 s8 signal;
1897 s8 signal_avg;
1898
1899 u8 chains;
1900 s8 chain_signal[IEEE80211_MAX_CHAINS];
1901 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1902
1903 struct rate_info txrate;
1904 struct rate_info rxrate;
1905 u32 rx_packets;
1906 u32 tx_packets;
1907 u32 tx_retries;
1908 u32 tx_failed;
1909 u32 rx_dropped_misc;
1910 struct sta_bss_parameters bss_param;
1911 struct nl80211_sta_flag_update sta_flags;
1912
1913 int generation;
1914
1915 const u8 *assoc_req_ies;
1916 size_t assoc_req_ies_len;
1917
1918 u32 beacon_loss_count;
1919 s64 t_offset;
1920 enum nl80211_mesh_power_mode local_pm;
1921 enum nl80211_mesh_power_mode peer_pm;
1922 enum nl80211_mesh_power_mode nonpeer_pm;
1923
1924 u32 expected_throughput;
1925
1926 u64 tx_duration;
1927 u64 rx_duration;
1928 u64 rx_beacon;
1929 u8 rx_beacon_signal_avg;
1930 u8 connected_to_gate;
1931
1932 struct cfg80211_tid_stats *pertid;
1933 s8 ack_signal;
1934 s8 avg_ack_signal;
1935
1936 u16 airtime_weight;
1937
1938 u32 rx_mpdu_count;
1939 u32 fcs_err_count;
1940
1941 u32 airtime_link_metric;
1942
1943 u8 connected_to_as;
1944};
1945
1946/**
1947 * struct cfg80211_sar_sub_specs - sub specs limit
1948 * @power: power limitation in 0.25dbm
1949 * @freq_range_index: index the power limitation applies to
1950 */
1951struct cfg80211_sar_sub_specs {
1952 s32 power;
1953 u32 freq_range_index;
1954};
1955
1956/**
1957 * struct cfg80211_sar_specs - sar limit specs
1958 * @type: it's set with power in 0.25dbm or other types
1959 * @num_sub_specs: number of sar sub specs
1960 * @sub_specs: memory to hold the sar sub specs
1961 */
1962struct cfg80211_sar_specs {
1963 enum nl80211_sar_type type;
1964 u32 num_sub_specs;
1965 struct cfg80211_sar_sub_specs sub_specs[];
1966};
1967
1968
1969/**
1970 * struct cfg80211_sar_freq_ranges - sar frequency ranges
1971 * @start_freq: start range edge frequency
1972 * @end_freq: end range edge frequency
1973 */
1974struct cfg80211_sar_freq_ranges {
1975 u32 start_freq;
1976 u32 end_freq;
1977};
1978
1979/**
1980 * struct cfg80211_sar_capa - sar limit capability
1981 * @type: it's set via power in 0.25dbm or other types
1982 * @num_freq_ranges: number of frequency ranges
1983 * @freq_ranges: memory to hold the freq ranges.
1984 *
1985 * Note: WLAN driver may append new ranges or split an existing
1986 * range to small ones and then append them.
1987 */
1988struct cfg80211_sar_capa {
1989 enum nl80211_sar_type type;
1990 u32 num_freq_ranges;
1991 const struct cfg80211_sar_freq_ranges *freq_ranges;
1992};
1993
1994#if IS_ENABLED(CONFIG_CFG80211)
1995/**
1996 * cfg80211_get_station - retrieve information about a given station
1997 * @dev: the device where the station is supposed to be connected to
1998 * @mac_addr: the mac address of the station of interest
1999 * @sinfo: pointer to the structure to fill with the information
2000 *
2001 * Returns 0 on success and sinfo is filled with the available information
2002 * otherwise returns a negative error code and the content of sinfo has to be
2003 * considered undefined.
2004 */
2005int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
2006 struct station_info *sinfo);
2007#else
2008static inline int cfg80211_get_station(struct net_device *dev,
2009 const u8 *mac_addr,
2010 struct station_info *sinfo)
2011{
2012 return -ENOENT;
2013}
2014#endif
2015
2016/**
2017 * enum monitor_flags - monitor flags
2018 *
2019 * Monitor interface configuration flags. Note that these must be the bits
2020 * according to the nl80211 flags.
2021 *
2022 * @MONITOR_FLAG_CHANGED: set if the flags were changed
2023 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
2024 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
2025 * @MONITOR_FLAG_CONTROL: pass control frames
2026 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
2027 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
2028 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
2029 */
2030enum monitor_flags {
2031 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
2032 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
2033 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
2034 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
2035 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
2036 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
2037 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
2038};
2039
2040/**
2041 * enum mpath_info_flags - mesh path information flags
2042 *
2043 * Used by the driver to indicate which info in &struct mpath_info it has filled
2044 * in during get_station() or dump_station().
2045 *
2046 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
2047 * @MPATH_INFO_SN: @sn filled
2048 * @MPATH_INFO_METRIC: @metric filled
2049 * @MPATH_INFO_EXPTIME: @exptime filled
2050 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
2051 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
2052 * @MPATH_INFO_FLAGS: @flags filled
2053 * @MPATH_INFO_HOP_COUNT: @hop_count filled
2054 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
2055 */
2056enum mpath_info_flags {
2057 MPATH_INFO_FRAME_QLEN = BIT(0),
2058 MPATH_INFO_SN = BIT(1),
2059 MPATH_INFO_METRIC = BIT(2),
2060 MPATH_INFO_EXPTIME = BIT(3),
2061 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
2062 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
2063 MPATH_INFO_FLAGS = BIT(6),
2064 MPATH_INFO_HOP_COUNT = BIT(7),
2065 MPATH_INFO_PATH_CHANGE = BIT(8),
2066};
2067
2068/**
2069 * struct mpath_info - mesh path information
2070 *
2071 * Mesh path information filled by driver for get_mpath() and dump_mpath().
2072 *
2073 * @filled: bitfield of flags from &enum mpath_info_flags
2074 * @frame_qlen: number of queued frames for this destination
2075 * @sn: target sequence number
2076 * @metric: metric (cost) of this mesh path
2077 * @exptime: expiration time for the mesh path from now, in msecs
2078 * @flags: mesh path flags
2079 * @discovery_timeout: total mesh path discovery timeout, in msecs
2080 * @discovery_retries: mesh path discovery retries
2081 * @generation: generation number for nl80211 dumps.
2082 * This number should increase every time the list of mesh paths
2083 * changes, i.e. when a station is added or removed, so that
2084 * userspace can tell whether it got a consistent snapshot.
2085 * @hop_count: hops to destination
2086 * @path_change_count: total number of path changes to destination
2087 */
2088struct mpath_info {
2089 u32 filled;
2090 u32 frame_qlen;
2091 u32 sn;
2092 u32 metric;
2093 u32 exptime;
2094 u32 discovery_timeout;
2095 u8 discovery_retries;
2096 u8 flags;
2097 u8 hop_count;
2098 u32 path_change_count;
2099
2100 int generation;
2101};
2102
2103/**
2104 * struct bss_parameters - BSS parameters
2105 *
2106 * Used to change BSS parameters (mainly for AP mode).
2107 *
2108 * @link_id: link_id or -1 for non-MLD
2109 * @use_cts_prot: Whether to use CTS protection
2110 * (0 = no, 1 = yes, -1 = do not change)
2111 * @use_short_preamble: Whether the use of short preambles is allowed
2112 * (0 = no, 1 = yes, -1 = do not change)
2113 * @use_short_slot_time: Whether the use of short slot time is allowed
2114 * (0 = no, 1 = yes, -1 = do not change)
2115 * @basic_rates: basic rates in IEEE 802.11 format
2116 * (or NULL for no change)
2117 * @basic_rates_len: number of basic rates
2118 * @ap_isolate: do not forward packets between connected stations
2119 * (0 = no, 1 = yes, -1 = do not change)
2120 * @ht_opmode: HT Operation mode
2121 * (u16 = opmode, -1 = do not change)
2122 * @p2p_ctwindow: P2P CT Window (-1 = no change)
2123 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
2124 */
2125struct bss_parameters {
2126 int link_id;
2127 int use_cts_prot;
2128 int use_short_preamble;
2129 int use_short_slot_time;
2130 const u8 *basic_rates;
2131 u8 basic_rates_len;
2132 int ap_isolate;
2133 int ht_opmode;
2134 s8 p2p_ctwindow, p2p_opp_ps;
2135};
2136
2137/**
2138 * struct mesh_config - 802.11s mesh configuration
2139 *
2140 * These parameters can be changed while the mesh is active.
2141 *
2142 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
2143 * by the Mesh Peering Open message
2144 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
2145 * used by the Mesh Peering Open message
2146 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
2147 * the mesh peering management to close a mesh peering
2148 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
2149 * mesh interface
2150 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
2151 * be sent to establish a new peer link instance in a mesh
2152 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
2153 * @element_ttl: the value of TTL field set at a mesh STA for path selection
2154 * elements
2155 * @auto_open_plinks: whether we should automatically open peer links when we
2156 * detect compatible mesh peers
2157 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
2158 * synchronize to for 11s default synchronization method
2159 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
2160 * that an originator mesh STA can send to a particular path target
2161 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
2162 * @min_discovery_timeout: the minimum length of time to wait until giving up on
2163 * a path discovery in milliseconds
2164 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
2165 * receiving a PREQ shall consider the forwarding information from the
2166 * root to be valid. (TU = time unit)
2167 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
2168 * which a mesh STA can send only one action frame containing a PREQ
2169 * element
2170 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
2171 * which a mesh STA can send only one Action frame containing a PERR
2172 * element
2173 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
2174 * it takes for an HWMP information element to propagate across the mesh
2175 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
2176 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
2177 * announcements are transmitted
2178 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
2179 * station has access to a broader network beyond the MBSS. (This is
2180 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
2181 * only means that the station will announce others it's a mesh gate, but
2182 * not necessarily using the gate announcement protocol. Still keeping the
2183 * same nomenclature to be in sync with the spec)
2184 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
2185 * entity (default is TRUE - forwarding entity)
2186 * @rssi_threshold: the threshold for average signal strength of candidate
2187 * station to establish a peer link
2188 * @ht_opmode: mesh HT protection mode
2189 *
2190 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
2191 * receiving a proactive PREQ shall consider the forwarding information to
2192 * the root mesh STA to be valid.
2193 *
2194 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
2195 * PREQs are transmitted.
2196 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
2197 * during which a mesh STA can send only one Action frame containing
2198 * a PREQ element for root path confirmation.
2199 * @power_mode: The default mesh power save mode which will be the initial
2200 * setting for new peer links.
2201 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
2202 * after transmitting its beacon.
2203 * @plink_timeout: If no tx activity is seen from a STA we've established
2204 * peering with for longer than this time (in seconds), then remove it
2205 * from the STA's list of peers. Default is 30 minutes.
2206 * @dot11MeshConnectedToAuthServer: if set to true then this mesh STA
2207 * will advertise that it is connected to a authentication server
2208 * in the mesh formation field.
2209 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
2210 * connected to a mesh gate in mesh formation info. If false, the
2211 * value in mesh formation is determined by the presence of root paths
2212 * in the mesh path table
2213 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
2214 * for HWMP) if the destination is a direct neighbor. Note that this might
2215 * not be the optimal decision as a multi-hop route might be better. So
2216 * if using this setting you will likely also want to disable
2217 * dot11MeshForwarding and use another mesh routing protocol on top.
2218 */
2219struct mesh_config {
2220 u16 dot11MeshRetryTimeout;
2221 u16 dot11MeshConfirmTimeout;
2222 u16 dot11MeshHoldingTimeout;
2223 u16 dot11MeshMaxPeerLinks;
2224 u8 dot11MeshMaxRetries;
2225 u8 dot11MeshTTL;
2226 u8 element_ttl;
2227 bool auto_open_plinks;
2228 u32 dot11MeshNbrOffsetMaxNeighbor;
2229 u8 dot11MeshHWMPmaxPREQretries;
2230 u32 path_refresh_time;
2231 u16 min_discovery_timeout;
2232 u32 dot11MeshHWMPactivePathTimeout;
2233 u16 dot11MeshHWMPpreqMinInterval;
2234 u16 dot11MeshHWMPperrMinInterval;
2235 u16 dot11MeshHWMPnetDiameterTraversalTime;
2236 u8 dot11MeshHWMPRootMode;
2237 bool dot11MeshConnectedToMeshGate;
2238 bool dot11MeshConnectedToAuthServer;
2239 u16 dot11MeshHWMPRannInterval;
2240 bool dot11MeshGateAnnouncementProtocol;
2241 bool dot11MeshForwarding;
2242 s32 rssi_threshold;
2243 u16 ht_opmode;
2244 u32 dot11MeshHWMPactivePathToRootTimeout;
2245 u16 dot11MeshHWMProotInterval;
2246 u16 dot11MeshHWMPconfirmationInterval;
2247 enum nl80211_mesh_power_mode power_mode;
2248 u16 dot11MeshAwakeWindowDuration;
2249 u32 plink_timeout;
2250 bool dot11MeshNolearn;
2251};
2252
2253/**
2254 * struct mesh_setup - 802.11s mesh setup configuration
2255 * @chandef: defines the channel to use
2256 * @mesh_id: the mesh ID
2257 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
2258 * @sync_method: which synchronization method to use
2259 * @path_sel_proto: which path selection protocol to use
2260 * @path_metric: which metric to use
2261 * @auth_id: which authentication method this mesh is using
2262 * @ie: vendor information elements (optional)
2263 * @ie_len: length of vendor information elements
2264 * @is_authenticated: this mesh requires authentication
2265 * @is_secure: this mesh uses security
2266 * @user_mpm: userspace handles all MPM functions
2267 * @dtim_period: DTIM period to use
2268 * @beacon_interval: beacon interval to use
2269 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2270 * @basic_rates: basic rates to use when creating the mesh
2271 * @beacon_rate: bitrate to be used for beacons
2272 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2273 * changes the channel when a radar is detected. This is required
2274 * to operate on DFS channels.
2275 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2276 * port frames over NL80211 instead of the network interface.
2277 *
2278 * These parameters are fixed when the mesh is created.
2279 */
2280struct mesh_setup {
2281 struct cfg80211_chan_def chandef;
2282 const u8 *mesh_id;
2283 u8 mesh_id_len;
2284 u8 sync_method;
2285 u8 path_sel_proto;
2286 u8 path_metric;
2287 u8 auth_id;
2288 const u8 *ie;
2289 u8 ie_len;
2290 bool is_authenticated;
2291 bool is_secure;
2292 bool user_mpm;
2293 u8 dtim_period;
2294 u16 beacon_interval;
2295 int mcast_rate[NUM_NL80211_BANDS];
2296 u32 basic_rates;
2297 struct cfg80211_bitrate_mask beacon_rate;
2298 bool userspace_handles_dfs;
2299 bool control_port_over_nl80211;
2300};
2301
2302/**
2303 * struct ocb_setup - 802.11p OCB mode setup configuration
2304 * @chandef: defines the channel to use
2305 *
2306 * These parameters are fixed when connecting to the network
2307 */
2308struct ocb_setup {
2309 struct cfg80211_chan_def chandef;
2310};
2311
2312/**
2313 * struct ieee80211_txq_params - TX queue parameters
2314 * @ac: AC identifier
2315 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2316 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2317 * 1..32767]
2318 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2319 * 1..32767]
2320 * @aifs: Arbitration interframe space [0..255]
2321 * @link_id: link_id or -1 for non-MLD
2322 */
2323struct ieee80211_txq_params {
2324 enum nl80211_ac ac;
2325 u16 txop;
2326 u16 cwmin;
2327 u16 cwmax;
2328 u8 aifs;
2329 int link_id;
2330};
2331
2332/**
2333 * DOC: Scanning and BSS list handling
2334 *
2335 * The scanning process itself is fairly simple, but cfg80211 offers quite
2336 * a bit of helper functionality. To start a scan, the scan operation will
2337 * be invoked with a scan definition. This scan definition contains the
2338 * channels to scan, and the SSIDs to send probe requests for (including the
2339 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2340 * probe. Additionally, a scan request may contain extra information elements
2341 * that should be added to the probe request. The IEs are guaranteed to be
2342 * well-formed, and will not exceed the maximum length the driver advertised
2343 * in the wiphy structure.
2344 *
2345 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2346 * it is responsible for maintaining the BSS list; the driver should not
2347 * maintain a list itself. For this notification, various functions exist.
2348 *
2349 * Since drivers do not maintain a BSS list, there are also a number of
2350 * functions to search for a BSS and obtain information about it from the
2351 * BSS structure cfg80211 maintains. The BSS list is also made available
2352 * to userspace.
2353 */
2354
2355/**
2356 * struct cfg80211_ssid - SSID description
2357 * @ssid: the SSID
2358 * @ssid_len: length of the ssid
2359 */
2360struct cfg80211_ssid {
2361 u8 ssid[IEEE80211_MAX_SSID_LEN];
2362 u8 ssid_len;
2363};
2364
2365/**
2366 * struct cfg80211_scan_info - information about completed scan
2367 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2368 * wireless device that requested the scan is connected to. If this
2369 * information is not available, this field is left zero.
2370 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2371 * @aborted: set to true if the scan was aborted for any reason,
2372 * userspace will be notified of that
2373 */
2374struct cfg80211_scan_info {
2375 u64 scan_start_tsf;
2376 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2377 bool aborted;
2378};
2379
2380/**
2381 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2382 *
2383 * @short_ssid: short ssid to scan for
2384 * @bssid: bssid to scan for
2385 * @channel_idx: idx of the channel in the channel array in the scan request
2386 * which the above info relvant to
2387 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2388 * @short_ssid_valid: @short_ssid is valid and can be used
2389 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2390 * 20 TUs before starting to send probe requests.
2391 */
2392struct cfg80211_scan_6ghz_params {
2393 u32 short_ssid;
2394 u32 channel_idx;
2395 u8 bssid[ETH_ALEN];
2396 bool unsolicited_probe;
2397 bool short_ssid_valid;
2398 bool psc_no_listen;
2399};
2400
2401/**
2402 * struct cfg80211_scan_request - scan request description
2403 *
2404 * @ssids: SSIDs to scan for (active scan only)
2405 * @n_ssids: number of SSIDs
2406 * @channels: channels to scan on.
2407 * @n_channels: total number of channels to scan
2408 * @scan_width: channel width for scanning
2409 * @ie: optional information element(s) to add into Probe Request or %NULL
2410 * @ie_len: length of ie in octets
2411 * @duration: how long to listen on each channel, in TUs. If
2412 * %duration_mandatory is not set, this is the maximum dwell time and
2413 * the actual dwell time may be shorter.
2414 * @duration_mandatory: if set, the scan duration must be as specified by the
2415 * %duration field.
2416 * @flags: bit field of flags controlling operation
2417 * @rates: bitmap of rates to advertise for each band
2418 * @wiphy: the wiphy this was for
2419 * @scan_start: time (in jiffies) when the scan started
2420 * @wdev: the wireless device to scan for
2421 * @info: (internal) information about completed scan
2422 * @notified: (internal) scan request was notified as done or aborted
2423 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2424 * @mac_addr: MAC address used with randomisation
2425 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2426 * are 0 in the mask should be randomised, bits that are 1 should
2427 * be taken from the @mac_addr
2428 * @scan_6ghz: relevant for split scan request only,
2429 * true if this is the second scan request
2430 * @n_6ghz_params: number of 6 GHz params
2431 * @scan_6ghz_params: 6 GHz params
2432 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2433 */
2434struct cfg80211_scan_request {
2435 struct cfg80211_ssid *ssids;
2436 int n_ssids;
2437 u32 n_channels;
2438 enum nl80211_bss_scan_width scan_width;
2439 const u8 *ie;
2440 size_t ie_len;
2441 u16 duration;
2442 bool duration_mandatory;
2443 u32 flags;
2444
2445 u32 rates[NUM_NL80211_BANDS];
2446
2447 struct wireless_dev *wdev;
2448
2449 u8 mac_addr[ETH_ALEN] __aligned(2);
2450 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2451 u8 bssid[ETH_ALEN] __aligned(2);
2452
2453 /* internal */
2454 struct wiphy *wiphy;
2455 unsigned long scan_start;
2456 struct cfg80211_scan_info info;
2457 bool notified;
2458 bool no_cck;
2459 bool scan_6ghz;
2460 u32 n_6ghz_params;
2461 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2462
2463 /* keep last */
2464 struct ieee80211_channel *channels[];
2465};
2466
2467static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2468{
2469 int i;
2470
2471 get_random_bytes(buf, ETH_ALEN);
2472 for (i = 0; i < ETH_ALEN; i++) {
2473 buf[i] &= ~mask[i];
2474 buf[i] |= addr[i] & mask[i];
2475 }
2476}
2477
2478/**
2479 * struct cfg80211_match_set - sets of attributes to match
2480 *
2481 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2482 * or no match (RSSI only)
2483 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2484 * or no match (RSSI only)
2485 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2486 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2487 * for filtering out scan results received. Drivers advertize this support
2488 * of band specific rssi based filtering through the feature capability
2489 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2490 * specific rssi thresholds take precedence over rssi_thold, if specified.
2491 * If not specified for any band, it will be assigned with rssi_thold of
2492 * corresponding matchset.
2493 */
2494struct cfg80211_match_set {
2495 struct cfg80211_ssid ssid;
2496 u8 bssid[ETH_ALEN];
2497 s32 rssi_thold;
2498 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2499};
2500
2501/**
2502 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2503 *
2504 * @interval: interval between scheduled scan iterations. In seconds.
2505 * @iterations: number of scan iterations in this scan plan. Zero means
2506 * infinite loop.
2507 * The last scan plan will always have this parameter set to zero,
2508 * all other scan plans will have a finite number of iterations.
2509 */
2510struct cfg80211_sched_scan_plan {
2511 u32 interval;
2512 u32 iterations;
2513};
2514
2515/**
2516 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2517 *
2518 * @band: band of BSS which should match for RSSI level adjustment.
2519 * @delta: value of RSSI level adjustment.
2520 */
2521struct cfg80211_bss_select_adjust {
2522 enum nl80211_band band;
2523 s8 delta;
2524};
2525
2526/**
2527 * struct cfg80211_sched_scan_request - scheduled scan request description
2528 *
2529 * @reqid: identifies this request.
2530 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2531 * @n_ssids: number of SSIDs
2532 * @n_channels: total number of channels to scan
2533 * @scan_width: channel width for scanning
2534 * @ie: optional information element(s) to add into Probe Request or %NULL
2535 * @ie_len: length of ie in octets
2536 * @flags: bit field of flags controlling operation
2537 * @match_sets: sets of parameters to be matched for a scan result
2538 * entry to be considered valid and to be passed to the host
2539 * (others are filtered out).
2540 * If ommited, all results are passed.
2541 * @n_match_sets: number of match sets
2542 * @report_results: indicates that results were reported for this request
2543 * @wiphy: the wiphy this was for
2544 * @dev: the interface
2545 * @scan_start: start time of the scheduled scan
2546 * @channels: channels to scan
2547 * @min_rssi_thold: for drivers only supporting a single threshold, this
2548 * contains the minimum over all matchsets
2549 * @mac_addr: MAC address used with randomisation
2550 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2551 * are 0 in the mask should be randomised, bits that are 1 should
2552 * be taken from the @mac_addr
2553 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2554 * index must be executed first.
2555 * @n_scan_plans: number of scan plans, at least 1.
2556 * @rcu_head: RCU callback used to free the struct
2557 * @owner_nlportid: netlink portid of owner (if this should is a request
2558 * owned by a particular socket)
2559 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2560 * @list: for keeping list of requests.
2561 * @delay: delay in seconds to use before starting the first scan
2562 * cycle. The driver may ignore this parameter and start
2563 * immediately (or at any other time), if this feature is not
2564 * supported.
2565 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2566 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2567 * reporting in connected state to cases where a matching BSS is determined
2568 * to have better or slightly worse RSSI than the current connected BSS.
2569 * The relative RSSI threshold values are ignored in disconnected state.
2570 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2571 * to the specified band while deciding whether a better BSS is reported
2572 * using @relative_rssi. If delta is a negative number, the BSSs that
2573 * belong to the specified band will be penalized by delta dB in relative
2574 * comparisions.
2575 */
2576struct cfg80211_sched_scan_request {
2577 u64 reqid;
2578 struct cfg80211_ssid *ssids;
2579 int n_ssids;
2580 u32 n_channels;
2581 enum nl80211_bss_scan_width scan_width;
2582 const u8 *ie;
2583 size_t ie_len;
2584 u32 flags;
2585 struct cfg80211_match_set *match_sets;
2586 int n_match_sets;
2587 s32 min_rssi_thold;
2588 u32 delay;
2589 struct cfg80211_sched_scan_plan *scan_plans;
2590 int n_scan_plans;
2591
2592 u8 mac_addr[ETH_ALEN] __aligned(2);
2593 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2594
2595 bool relative_rssi_set;
2596 s8 relative_rssi;
2597 struct cfg80211_bss_select_adjust rssi_adjust;
2598
2599 /* internal */
2600 struct wiphy *wiphy;
2601 struct net_device *dev;
2602 unsigned long scan_start;
2603 bool report_results;
2604 struct rcu_head rcu_head;
2605 u32 owner_nlportid;
2606 bool nl_owner_dead;
2607 struct list_head list;
2608
2609 /* keep last */
2610 struct ieee80211_channel *channels[];
2611};
2612
2613/**
2614 * enum cfg80211_signal_type - signal type
2615 *
2616 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2617 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2618 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2619 */
2620enum cfg80211_signal_type {
2621 CFG80211_SIGNAL_TYPE_NONE,
2622 CFG80211_SIGNAL_TYPE_MBM,
2623 CFG80211_SIGNAL_TYPE_UNSPEC,
2624};
2625
2626/**
2627 * struct cfg80211_inform_bss - BSS inform data
2628 * @chan: channel the frame was received on
2629 * @scan_width: scan width that was used
2630 * @signal: signal strength value, according to the wiphy's
2631 * signal type
2632 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2633 * received; should match the time when the frame was actually
2634 * received by the device (not just by the host, in case it was
2635 * buffered on the device) and be accurate to about 10ms.
2636 * If the frame isn't buffered, just passing the return value of
2637 * ktime_get_boottime_ns() is likely appropriate.
2638 * @parent_tsf: the time at the start of reception of the first octet of the
2639 * timestamp field of the frame. The time is the TSF of the BSS specified
2640 * by %parent_bssid.
2641 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2642 * the BSS that requested the scan in which the beacon/probe was received.
2643 * @chains: bitmask for filled values in @chain_signal.
2644 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2645 */
2646struct cfg80211_inform_bss {
2647 struct ieee80211_channel *chan;
2648 enum nl80211_bss_scan_width scan_width;
2649 s32 signal;
2650 u64 boottime_ns;
2651 u64 parent_tsf;
2652 u8 parent_bssid[ETH_ALEN] __aligned(2);
2653 u8 chains;
2654 s8 chain_signal[IEEE80211_MAX_CHAINS];
2655};
2656
2657/**
2658 * struct cfg80211_bss_ies - BSS entry IE data
2659 * @tsf: TSF contained in the frame that carried these IEs
2660 * @rcu_head: internal use, for freeing
2661 * @len: length of the IEs
2662 * @from_beacon: these IEs are known to come from a beacon
2663 * @data: IE data
2664 */
2665struct cfg80211_bss_ies {
2666 u64 tsf;
2667 struct rcu_head rcu_head;
2668 int len;
2669 bool from_beacon;
2670 u8 data[];
2671};
2672
2673/**
2674 * struct cfg80211_bss - BSS description
2675 *
2676 * This structure describes a BSS (which may also be a mesh network)
2677 * for use in scan results and similar.
2678 *
2679 * @channel: channel this BSS is on
2680 * @scan_width: width of the control channel
2681 * @bssid: BSSID of the BSS
2682 * @beacon_interval: the beacon interval as from the frame
2683 * @capability: the capability field in host byte order
2684 * @ies: the information elements (Note that there is no guarantee that these
2685 * are well-formed!); this is a pointer to either the beacon_ies or
2686 * proberesp_ies depending on whether Probe Response frame has been
2687 * received. It is always non-%NULL.
2688 * @beacon_ies: the information elements from the last Beacon frame
2689 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2690 * own the beacon_ies, but they're just pointers to the ones from the
2691 * @hidden_beacon_bss struct)
2692 * @proberesp_ies: the information elements from the last Probe Response frame
2693 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2694 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2695 * that holds the beacon data. @beacon_ies is still valid, of course, and
2696 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2697 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2698 * non-transmitted one (multi-BSSID support)
2699 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2700 * (multi-BSSID support)
2701 * @signal: signal strength value (type depends on the wiphy's signal_type)
2702 * @chains: bitmask for filled values in @chain_signal.
2703 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2704 * @bssid_index: index in the multiple BSS set
2705 * @max_bssid_indicator: max number of members in the BSS set
2706 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2707 */
2708struct cfg80211_bss {
2709 struct ieee80211_channel *channel;
2710 enum nl80211_bss_scan_width scan_width;
2711
2712 const struct cfg80211_bss_ies __rcu *ies;
2713 const struct cfg80211_bss_ies __rcu *beacon_ies;
2714 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2715
2716 struct cfg80211_bss *hidden_beacon_bss;
2717 struct cfg80211_bss *transmitted_bss;
2718 struct list_head nontrans_list;
2719
2720 s32 signal;
2721
2722 u16 beacon_interval;
2723 u16 capability;
2724
2725 u8 bssid[ETH_ALEN];
2726 u8 chains;
2727 s8 chain_signal[IEEE80211_MAX_CHAINS];
2728
2729 u8 bssid_index;
2730 u8 max_bssid_indicator;
2731
2732 u8 priv[] __aligned(sizeof(void *));
2733};
2734
2735/**
2736 * ieee80211_bss_get_elem - find element with given ID
2737 * @bss: the bss to search
2738 * @id: the element ID
2739 *
2740 * Note that the return value is an RCU-protected pointer, so
2741 * rcu_read_lock() must be held when calling this function.
2742 * Return: %NULL if not found.
2743 */
2744const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2745
2746/**
2747 * ieee80211_bss_get_ie - find IE with given ID
2748 * @bss: the bss to search
2749 * @id: the element ID
2750 *
2751 * Note that the return value is an RCU-protected pointer, so
2752 * rcu_read_lock() must be held when calling this function.
2753 * Return: %NULL if not found.
2754 */
2755static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2756{
2757 return (const void *)ieee80211_bss_get_elem(bss, id);
2758}
2759
2760
2761/**
2762 * struct cfg80211_auth_request - Authentication request data
2763 *
2764 * This structure provides information needed to complete IEEE 802.11
2765 * authentication.
2766 *
2767 * @bss: The BSS to authenticate with, the callee must obtain a reference
2768 * to it if it needs to keep it.
2769 * @auth_type: Authentication type (algorithm)
2770 * @ie: Extra IEs to add to Authentication frame or %NULL
2771 * @ie_len: Length of ie buffer in octets
2772 * @key_len: length of WEP key for shared key authentication
2773 * @key_idx: index of WEP key for shared key authentication
2774 * @key: WEP key for shared key authentication
2775 * @auth_data: Fields and elements in Authentication frames. This contains
2776 * the authentication frame body (non-IE and IE data), excluding the
2777 * Authentication algorithm number, i.e., starting at the Authentication
2778 * transaction sequence number field.
2779 * @auth_data_len: Length of auth_data buffer in octets
2780 * @link_id: if >= 0, indicates authentication should be done as an MLD,
2781 * the interface address is included as the MLD address and the
2782 * necessary link (with the given link_id) will be created (and
2783 * given an MLD address) by the driver
2784 * @ap_mld_addr: AP MLD address in case of authentication request with
2785 * an AP MLD, valid iff @link_id >= 0
2786 */
2787struct cfg80211_auth_request {
2788 struct cfg80211_bss *bss;
2789 const u8 *ie;
2790 size_t ie_len;
2791 enum nl80211_auth_type auth_type;
2792 const u8 *key;
2793 u8 key_len;
2794 s8 key_idx;
2795 const u8 *auth_data;
2796 size_t auth_data_len;
2797 s8 link_id;
2798 const u8 *ap_mld_addr;
2799};
2800
2801/**
2802 * struct cfg80211_assoc_link - per-link information for MLO association
2803 * @bss: the BSS pointer, see also &struct cfg80211_assoc_request::bss;
2804 * if this is %NULL for a link, that link is not requested
2805 * @elems: extra elements for the per-STA profile for this link
2806 * @elems_len: length of the elements
2807 */
2808struct cfg80211_assoc_link {
2809 struct cfg80211_bss *bss;
2810 const u8 *elems;
2811 size_t elems_len;
2812};
2813
2814/**
2815 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2816 *
2817 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2818 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2819 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2820 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2821 * authentication capability. Drivers can offload authentication to
2822 * userspace if this flag is set. Only applicable for cfg80211_connect()
2823 * request (connect callback).
2824 * @ASSOC_REQ_DISABLE_HE: Disable HE
2825 * @ASSOC_REQ_DISABLE_EHT: Disable EHT
2826 * @CONNECT_REQ_MLO_SUPPORT: Userspace indicates support for handling MLD links.
2827 * Drivers shall disable MLO features for the current association if this
2828 * flag is not set.
2829 */
2830enum cfg80211_assoc_req_flags {
2831 ASSOC_REQ_DISABLE_HT = BIT(0),
2832 ASSOC_REQ_DISABLE_VHT = BIT(1),
2833 ASSOC_REQ_USE_RRM = BIT(2),
2834 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2835 ASSOC_REQ_DISABLE_HE = BIT(4),
2836 ASSOC_REQ_DISABLE_EHT = BIT(5),
2837 CONNECT_REQ_MLO_SUPPORT = BIT(6),
2838};
2839
2840/**
2841 * struct cfg80211_assoc_request - (Re)Association request data
2842 *
2843 * This structure provides information needed to complete IEEE 802.11
2844 * (re)association.
2845 * @bss: The BSS to associate with. If the call is successful the driver is
2846 * given a reference that it must give back to cfg80211_send_rx_assoc()
2847 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2848 * association requests while already associating must be rejected.
2849 * This also applies to the @links.bss parameter, which is used instead
2850 * of this one (it is %NULL) for MLO associations.
2851 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2852 * @ie_len: Length of ie buffer in octets
2853 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2854 * @crypto: crypto settings
2855 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2856 * to indicate a request to reassociate within the ESS instead of a request
2857 * do the initial association with the ESS. When included, this is set to
2858 * the BSSID of the current association, i.e., to the value that is
2859 * included in the Current AP address field of the Reassociation Request
2860 * frame.
2861 * @flags: See &enum cfg80211_assoc_req_flags
2862 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2863 * will be used in ht_capa. Un-supported values will be ignored.
2864 * @ht_capa_mask: The bits of ht_capa which are to be used.
2865 * @vht_capa: VHT capability override
2866 * @vht_capa_mask: VHT capability mask indicating which fields to use
2867 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2868 * %NULL if FILS is not used.
2869 * @fils_kek_len: Length of fils_kek in octets
2870 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2871 * Request/Response frame or %NULL if FILS is not used. This field starts
2872 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2873 * @s1g_capa: S1G capability override
2874 * @s1g_capa_mask: S1G capability override mask
2875 * @links: per-link information for MLO connections
2876 * @link_id: >= 0 for MLO connections, where links are given, and indicates
2877 * the link on which the association request should be sent
2878 * @ap_mld_addr: AP MLD address in case of MLO association request,
2879 * valid iff @link_id >= 0
2880 */
2881struct cfg80211_assoc_request {
2882 struct cfg80211_bss *bss;
2883 const u8 *ie, *prev_bssid;
2884 size_t ie_len;
2885 struct cfg80211_crypto_settings crypto;
2886 bool use_mfp;
2887 u32 flags;
2888 struct ieee80211_ht_cap ht_capa;
2889 struct ieee80211_ht_cap ht_capa_mask;
2890 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2891 const u8 *fils_kek;
2892 size_t fils_kek_len;
2893 const u8 *fils_nonces;
2894 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2895 struct cfg80211_assoc_link links[IEEE80211_MLD_MAX_NUM_LINKS];
2896 const u8 *ap_mld_addr;
2897 s8 link_id;
2898};
2899
2900/**
2901 * struct cfg80211_deauth_request - Deauthentication request data
2902 *
2903 * This structure provides information needed to complete IEEE 802.11
2904 * deauthentication.
2905 *
2906 * @bssid: the BSSID or AP MLD address to deauthenticate from
2907 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2908 * @ie_len: Length of ie buffer in octets
2909 * @reason_code: The reason code for the deauthentication
2910 * @local_state_change: if set, change local state only and
2911 * do not set a deauth frame
2912 */
2913struct cfg80211_deauth_request {
2914 const u8 *bssid;
2915 const u8 *ie;
2916 size_t ie_len;
2917 u16 reason_code;
2918 bool local_state_change;
2919};
2920
2921/**
2922 * struct cfg80211_disassoc_request - Disassociation request data
2923 *
2924 * This structure provides information needed to complete IEEE 802.11
2925 * disassociation.
2926 *
2927 * @ap_addr: the BSSID or AP MLD address to disassociate from
2928 * @ie: Extra IEs to add to Disassociation frame or %NULL
2929 * @ie_len: Length of ie buffer in octets
2930 * @reason_code: The reason code for the disassociation
2931 * @local_state_change: This is a request for a local state only, i.e., no
2932 * Disassociation frame is to be transmitted.
2933 */
2934struct cfg80211_disassoc_request {
2935 const u8 *ap_addr;
2936 const u8 *ie;
2937 size_t ie_len;
2938 u16 reason_code;
2939 bool local_state_change;
2940};
2941
2942/**
2943 * struct cfg80211_ibss_params - IBSS parameters
2944 *
2945 * This structure defines the IBSS parameters for the join_ibss()
2946 * method.
2947 *
2948 * @ssid: The SSID, will always be non-null.
2949 * @ssid_len: The length of the SSID, will always be non-zero.
2950 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2951 * search for IBSSs with a different BSSID.
2952 * @chandef: defines the channel to use if no other IBSS to join can be found
2953 * @channel_fixed: The channel should be fixed -- do not search for
2954 * IBSSs to join on other channels.
2955 * @ie: information element(s) to include in the beacon
2956 * @ie_len: length of that
2957 * @beacon_interval: beacon interval to use
2958 * @privacy: this is a protected network, keys will be configured
2959 * after joining
2960 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2961 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2962 * required to assume that the port is unauthorized until authorized by
2963 * user space. Otherwise, port is marked authorized by default.
2964 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2965 * port frames over NL80211 instead of the network interface.
2966 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2967 * changes the channel when a radar is detected. This is required
2968 * to operate on DFS channels.
2969 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2970 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2971 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2972 * will be used in ht_capa. Un-supported values will be ignored.
2973 * @ht_capa_mask: The bits of ht_capa which are to be used.
2974 * @wep_keys: static WEP keys, if not NULL points to an array of
2975 * CFG80211_MAX_WEP_KEYS WEP keys
2976 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2977 */
2978struct cfg80211_ibss_params {
2979 const u8 *ssid;
2980 const u8 *bssid;
2981 struct cfg80211_chan_def chandef;
2982 const u8 *ie;
2983 u8 ssid_len, ie_len;
2984 u16 beacon_interval;
2985 u32 basic_rates;
2986 bool channel_fixed;
2987 bool privacy;
2988 bool control_port;
2989 bool control_port_over_nl80211;
2990 bool userspace_handles_dfs;
2991 int mcast_rate[NUM_NL80211_BANDS];
2992 struct ieee80211_ht_cap ht_capa;
2993 struct ieee80211_ht_cap ht_capa_mask;
2994 struct key_params *wep_keys;
2995 int wep_tx_key;
2996};
2997
2998/**
2999 * struct cfg80211_bss_selection - connection parameters for BSS selection.
3000 *
3001 * @behaviour: requested BSS selection behaviour.
3002 * @param: parameters for requestion behaviour.
3003 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
3004 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
3005 */
3006struct cfg80211_bss_selection {
3007 enum nl80211_bss_select_attr behaviour;
3008 union {
3009 enum nl80211_band band_pref;
3010 struct cfg80211_bss_select_adjust adjust;
3011 } param;
3012};
3013
3014/**
3015 * struct cfg80211_connect_params - Connection parameters
3016 *
3017 * This structure provides information needed to complete IEEE 802.11
3018 * authentication and association.
3019 *
3020 * @channel: The channel to use or %NULL if not specified (auto-select based
3021 * on scan results)
3022 * @channel_hint: The channel of the recommended BSS for initial connection or
3023 * %NULL if not specified
3024 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
3025 * results)
3026 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
3027 * %NULL if not specified. Unlike the @bssid parameter, the driver is
3028 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
3029 * to use.
3030 * @ssid: SSID
3031 * @ssid_len: Length of ssid in octets
3032 * @auth_type: Authentication type (algorithm)
3033 * @ie: IEs for association request
3034 * @ie_len: Length of assoc_ie in octets
3035 * @privacy: indicates whether privacy-enabled APs should be used
3036 * @mfp: indicate whether management frame protection is used
3037 * @crypto: crypto settings
3038 * @key_len: length of WEP key for shared key authentication
3039 * @key_idx: index of WEP key for shared key authentication
3040 * @key: WEP key for shared key authentication
3041 * @flags: See &enum cfg80211_assoc_req_flags
3042 * @bg_scan_period: Background scan period in seconds
3043 * or -1 to indicate that default value is to be used.
3044 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
3045 * will be used in ht_capa. Un-supported values will be ignored.
3046 * @ht_capa_mask: The bits of ht_capa which are to be used.
3047 * @vht_capa: VHT Capability overrides
3048 * @vht_capa_mask: The bits of vht_capa which are to be used.
3049 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
3050 * networks.
3051 * @bss_select: criteria to be used for BSS selection.
3052 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
3053 * to indicate a request to reassociate within the ESS instead of a request
3054 * do the initial association with the ESS. When included, this is set to
3055 * the BSSID of the current association, i.e., to the value that is
3056 * included in the Current AP address field of the Reassociation Request
3057 * frame.
3058 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
3059 * NAI or %NULL if not specified. This is used to construct FILS wrapped
3060 * data IE.
3061 * @fils_erp_username_len: Length of @fils_erp_username in octets.
3062 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
3063 * %NULL if not specified. This specifies the domain name of ER server and
3064 * is used to construct FILS wrapped data IE.
3065 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
3066 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
3067 * messages. This is also used to construct FILS wrapped data IE.
3068 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
3069 * keys in FILS or %NULL if not specified.
3070 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
3071 * @want_1x: indicates user-space supports and wants to use 802.1X driver
3072 * offload of 4-way handshake.
3073 * @edmg: define the EDMG channels.
3074 * This may specify multiple channels and bonding options for the driver
3075 * to choose from, based on BSS configuration.
3076 */
3077struct cfg80211_connect_params {
3078 struct ieee80211_channel *channel;
3079 struct ieee80211_channel *channel_hint;
3080 const u8 *bssid;
3081 const u8 *bssid_hint;
3082 const u8 *ssid;
3083 size_t ssid_len;
3084 enum nl80211_auth_type auth_type;
3085 const u8 *ie;
3086 size_t ie_len;
3087 bool privacy;
3088 enum nl80211_mfp mfp;
3089 struct cfg80211_crypto_settings crypto;
3090 const u8 *key;
3091 u8 key_len, key_idx;
3092 u32 flags;
3093 int bg_scan_period;
3094 struct ieee80211_ht_cap ht_capa;
3095 struct ieee80211_ht_cap ht_capa_mask;
3096 struct ieee80211_vht_cap vht_capa;
3097 struct ieee80211_vht_cap vht_capa_mask;
3098 bool pbss;
3099 struct cfg80211_bss_selection bss_select;
3100 const u8 *prev_bssid;
3101 const u8 *fils_erp_username;
3102 size_t fils_erp_username_len;
3103 const u8 *fils_erp_realm;
3104 size_t fils_erp_realm_len;
3105 u16 fils_erp_next_seq_num;
3106 const u8 *fils_erp_rrk;
3107 size_t fils_erp_rrk_len;
3108 bool want_1x;
3109 struct ieee80211_edmg edmg;
3110};
3111
3112/**
3113 * enum cfg80211_connect_params_changed - Connection parameters being updated
3114 *
3115 * This enum provides information of all connect parameters that
3116 * have to be updated as part of update_connect_params() call.
3117 *
3118 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
3119 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
3120 * username, erp sequence number and rrk) are updated
3121 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
3122 */
3123enum cfg80211_connect_params_changed {
3124 UPDATE_ASSOC_IES = BIT(0),
3125 UPDATE_FILS_ERP_INFO = BIT(1),
3126 UPDATE_AUTH_TYPE = BIT(2),
3127};
3128
3129/**
3130 * enum wiphy_params_flags - set_wiphy_params bitfield values
3131 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
3132 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
3133 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
3134 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
3135 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
3136 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
3137 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
3138 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
3139 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
3140 */
3141enum wiphy_params_flags {
3142 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
3143 WIPHY_PARAM_RETRY_LONG = 1 << 1,
3144 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
3145 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
3146 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
3147 WIPHY_PARAM_DYN_ACK = 1 << 5,
3148 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
3149 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
3150 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
3151};
3152
3153#define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
3154
3155/* The per TXQ device queue limit in airtime */
3156#define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
3157#define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
3158
3159/* The per interface airtime threshold to switch to lower queue limit */
3160#define IEEE80211_AQL_THRESHOLD 24000
3161
3162/**
3163 * struct cfg80211_pmksa - PMK Security Association
3164 *
3165 * This structure is passed to the set/del_pmksa() method for PMKSA
3166 * caching.
3167 *
3168 * @bssid: The AP's BSSID (may be %NULL).
3169 * @pmkid: The identifier to refer a PMKSA.
3170 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
3171 * derivation by a FILS STA. Otherwise, %NULL.
3172 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
3173 * the hash algorithm used to generate this.
3174 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
3175 * cache identifier (may be %NULL).
3176 * @ssid_len: Length of the @ssid in octets.
3177 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
3178 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
3179 * %NULL).
3180 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
3181 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
3182 * The configured PMKSA must not be used for PMKSA caching after
3183 * expiration and any keys derived from this PMK become invalid on
3184 * expiration, i.e., the current association must be dropped if the PMK
3185 * used for it expires.
3186 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
3187 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
3188 * Drivers are expected to trigger a full authentication instead of using
3189 * this PMKSA for caching when reassociating to a new BSS after this
3190 * threshold to generate a new PMK before the current one expires.
3191 */
3192struct cfg80211_pmksa {
3193 const u8 *bssid;
3194 const u8 *pmkid;
3195 const u8 *pmk;
3196 size_t pmk_len;
3197 const u8 *ssid;
3198 size_t ssid_len;
3199 const u8 *cache_id;
3200 u32 pmk_lifetime;
3201 u8 pmk_reauth_threshold;
3202};
3203
3204/**
3205 * struct cfg80211_pkt_pattern - packet pattern
3206 * @mask: bitmask where to match pattern and where to ignore bytes,
3207 * one bit per byte, in same format as nl80211
3208 * @pattern: bytes to match where bitmask is 1
3209 * @pattern_len: length of pattern (in bytes)
3210 * @pkt_offset: packet offset (in bytes)
3211 *
3212 * Internal note: @mask and @pattern are allocated in one chunk of
3213 * memory, free @mask only!
3214 */
3215struct cfg80211_pkt_pattern {
3216 const u8 *mask, *pattern;
3217 int pattern_len;
3218 int pkt_offset;
3219};
3220
3221/**
3222 * struct cfg80211_wowlan_tcp - TCP connection parameters
3223 *
3224 * @sock: (internal) socket for source port allocation
3225 * @src: source IP address
3226 * @dst: destination IP address
3227 * @dst_mac: destination MAC address
3228 * @src_port: source port
3229 * @dst_port: destination port
3230 * @payload_len: data payload length
3231 * @payload: data payload buffer
3232 * @payload_seq: payload sequence stamping configuration
3233 * @data_interval: interval at which to send data packets
3234 * @wake_len: wakeup payload match length
3235 * @wake_data: wakeup payload match data
3236 * @wake_mask: wakeup payload match mask
3237 * @tokens_size: length of the tokens buffer
3238 * @payload_tok: payload token usage configuration
3239 */
3240struct cfg80211_wowlan_tcp {
3241 struct socket *sock;
3242 __be32 src, dst;
3243 u16 src_port, dst_port;
3244 u8 dst_mac[ETH_ALEN];
3245 int payload_len;
3246 const u8 *payload;
3247 struct nl80211_wowlan_tcp_data_seq payload_seq;
3248 u32 data_interval;
3249 u32 wake_len;
3250 const u8 *wake_data, *wake_mask;
3251 u32 tokens_size;
3252 /* must be last, variable member */
3253 struct nl80211_wowlan_tcp_data_token payload_tok;
3254};
3255
3256/**
3257 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3258 *
3259 * This structure defines the enabled WoWLAN triggers for the device.
3260 * @any: wake up on any activity -- special trigger if device continues
3261 * operating as normal during suspend
3262 * @disconnect: wake up if getting disconnected
3263 * @magic_pkt: wake up on receiving magic packet
3264 * @patterns: wake up on receiving packet matching a pattern
3265 * @n_patterns: number of patterns
3266 * @gtk_rekey_failure: wake up on GTK rekey failure
3267 * @eap_identity_req: wake up on EAP identity request packet
3268 * @four_way_handshake: wake up on 4-way handshake
3269 * @rfkill_release: wake up when rfkill is released
3270 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3271 * NULL if not configured.
3272 * @nd_config: configuration for the scan to be used for net detect wake.
3273 */
3274struct cfg80211_wowlan {
3275 bool any, disconnect, magic_pkt, gtk_rekey_failure,
3276 eap_identity_req, four_way_handshake,
3277 rfkill_release;
3278 struct cfg80211_pkt_pattern *patterns;
3279 struct cfg80211_wowlan_tcp *tcp;
3280 int n_patterns;
3281 struct cfg80211_sched_scan_request *nd_config;
3282};
3283
3284/**
3285 * struct cfg80211_coalesce_rules - Coalesce rule parameters
3286 *
3287 * This structure defines coalesce rule for the device.
3288 * @delay: maximum coalescing delay in msecs.
3289 * @condition: condition for packet coalescence.
3290 * see &enum nl80211_coalesce_condition.
3291 * @patterns: array of packet patterns
3292 * @n_patterns: number of patterns
3293 */
3294struct cfg80211_coalesce_rules {
3295 int delay;
3296 enum nl80211_coalesce_condition condition;
3297 struct cfg80211_pkt_pattern *patterns;
3298 int n_patterns;
3299};
3300
3301/**
3302 * struct cfg80211_coalesce - Packet coalescing settings
3303 *
3304 * This structure defines coalescing settings.
3305 * @rules: array of coalesce rules
3306 * @n_rules: number of rules
3307 */
3308struct cfg80211_coalesce {
3309 struct cfg80211_coalesce_rules *rules;
3310 int n_rules;
3311};
3312
3313/**
3314 * struct cfg80211_wowlan_nd_match - information about the match
3315 *
3316 * @ssid: SSID of the match that triggered the wake up
3317 * @n_channels: Number of channels where the match occurred. This
3318 * value may be zero if the driver can't report the channels.
3319 * @channels: center frequencies of the channels where a match
3320 * occurred (in MHz)
3321 */
3322struct cfg80211_wowlan_nd_match {
3323 struct cfg80211_ssid ssid;
3324 int n_channels;
3325 u32 channels[];
3326};
3327
3328/**
3329 * struct cfg80211_wowlan_nd_info - net detect wake up information
3330 *
3331 * @n_matches: Number of match information instances provided in
3332 * @matches. This value may be zero if the driver can't provide
3333 * match information.
3334 * @matches: Array of pointers to matches containing information about
3335 * the matches that triggered the wake up.
3336 */
3337struct cfg80211_wowlan_nd_info {
3338 int n_matches;
3339 struct cfg80211_wowlan_nd_match *matches[];
3340};
3341
3342/**
3343 * struct cfg80211_wowlan_wakeup - wakeup report
3344 * @disconnect: woke up by getting disconnected
3345 * @magic_pkt: woke up by receiving magic packet
3346 * @gtk_rekey_failure: woke up by GTK rekey failure
3347 * @eap_identity_req: woke up by EAP identity request packet
3348 * @four_way_handshake: woke up by 4-way handshake
3349 * @rfkill_release: woke up by rfkill being released
3350 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3351 * @packet_present_len: copied wakeup packet data
3352 * @packet_len: original wakeup packet length
3353 * @packet: The packet causing the wakeup, if any.
3354 * @packet_80211: For pattern match, magic packet and other data
3355 * frame triggers an 802.3 frame should be reported, for
3356 * disconnect due to deauth 802.11 frame. This indicates which
3357 * it is.
3358 * @tcp_match: TCP wakeup packet received
3359 * @tcp_connlost: TCP connection lost or failed to establish
3360 * @tcp_nomoretokens: TCP data ran out of tokens
3361 * @net_detect: if not %NULL, woke up because of net detect
3362 */
3363struct cfg80211_wowlan_wakeup {
3364 bool disconnect, magic_pkt, gtk_rekey_failure,
3365 eap_identity_req, four_way_handshake,
3366 rfkill_release, packet_80211,
3367 tcp_match, tcp_connlost, tcp_nomoretokens;
3368 s32 pattern_idx;
3369 u32 packet_present_len, packet_len;
3370 const void *packet;
3371 struct cfg80211_wowlan_nd_info *net_detect;
3372};
3373
3374/**
3375 * struct cfg80211_gtk_rekey_data - rekey data
3376 * @kek: key encryption key (@kek_len bytes)
3377 * @kck: key confirmation key (@kck_len bytes)
3378 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3379 * @kek_len: length of kek
3380 * @kck_len: length of kck
3381 * @akm: akm (oui, id)
3382 */
3383struct cfg80211_gtk_rekey_data {
3384 const u8 *kek, *kck, *replay_ctr;
3385 u32 akm;
3386 u8 kek_len, kck_len;
3387};
3388
3389/**
3390 * struct cfg80211_update_ft_ies_params - FT IE Information
3391 *
3392 * This structure provides information needed to update the fast transition IE
3393 *
3394 * @md: The Mobility Domain ID, 2 Octet value
3395 * @ie: Fast Transition IEs
3396 * @ie_len: Length of ft_ie in octets
3397 */
3398struct cfg80211_update_ft_ies_params {
3399 u16 md;
3400 const u8 *ie;
3401 size_t ie_len;
3402};
3403
3404/**
3405 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3406 *
3407 * This structure provides information needed to transmit a mgmt frame
3408 *
3409 * @chan: channel to use
3410 * @offchan: indicates wether off channel operation is required
3411 * @wait: duration for ROC
3412 * @buf: buffer to transmit
3413 * @len: buffer length
3414 * @no_cck: don't use cck rates for this frame
3415 * @dont_wait_for_ack: tells the low level not to wait for an ack
3416 * @n_csa_offsets: length of csa_offsets array
3417 * @csa_offsets: array of all the csa offsets in the frame
3418 * @link_id: for MLO, the link ID to transmit on, -1 if not given; note
3419 * that the link ID isn't validated (much), it's in range but the
3420 * link might not exist (or be used by the receiver STA)
3421 */
3422struct cfg80211_mgmt_tx_params {
3423 struct ieee80211_channel *chan;
3424 bool offchan;
3425 unsigned int wait;
3426 const u8 *buf;
3427 size_t len;
3428 bool no_cck;
3429 bool dont_wait_for_ack;
3430 int n_csa_offsets;
3431 const u16 *csa_offsets;
3432 int link_id;
3433};
3434
3435/**
3436 * struct cfg80211_dscp_exception - DSCP exception
3437 *
3438 * @dscp: DSCP value that does not adhere to the user priority range definition
3439 * @up: user priority value to which the corresponding DSCP value belongs
3440 */
3441struct cfg80211_dscp_exception {
3442 u8 dscp;
3443 u8 up;
3444};
3445
3446/**
3447 * struct cfg80211_dscp_range - DSCP range definition for user priority
3448 *
3449 * @low: lowest DSCP value of this user priority range, inclusive
3450 * @high: highest DSCP value of this user priority range, inclusive
3451 */
3452struct cfg80211_dscp_range {
3453 u8 low;
3454 u8 high;
3455};
3456
3457/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3458#define IEEE80211_QOS_MAP_MAX_EX 21
3459#define IEEE80211_QOS_MAP_LEN_MIN 16
3460#define IEEE80211_QOS_MAP_LEN_MAX \
3461 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3462
3463/**
3464 * struct cfg80211_qos_map - QoS Map Information
3465 *
3466 * This struct defines the Interworking QoS map setting for DSCP values
3467 *
3468 * @num_des: number of DSCP exceptions (0..21)
3469 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3470 * the user priority DSCP range definition
3471 * @up: DSCP range definition for a particular user priority
3472 */
3473struct cfg80211_qos_map {
3474 u8 num_des;
3475 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3476 struct cfg80211_dscp_range up[8];
3477};
3478
3479/**
3480 * struct cfg80211_nan_conf - NAN configuration
3481 *
3482 * This struct defines NAN configuration parameters
3483 *
3484 * @master_pref: master preference (1 - 255)
3485 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3486 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3487 * (i.e. BIT(NL80211_BAND_2GHZ)).
3488 */
3489struct cfg80211_nan_conf {
3490 u8 master_pref;
3491 u8 bands;
3492};
3493
3494/**
3495 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3496 * configuration
3497 *
3498 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3499 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3500 */
3501enum cfg80211_nan_conf_changes {
3502 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3503 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3504};
3505
3506/**
3507 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3508 *
3509 * @filter: the content of the filter
3510 * @len: the length of the filter
3511 */
3512struct cfg80211_nan_func_filter {
3513 const u8 *filter;
3514 u8 len;
3515};
3516
3517/**
3518 * struct cfg80211_nan_func - a NAN function
3519 *
3520 * @type: &enum nl80211_nan_function_type
3521 * @service_id: the service ID of the function
3522 * @publish_type: &nl80211_nan_publish_type
3523 * @close_range: if true, the range should be limited. Threshold is
3524 * implementation specific.
3525 * @publish_bcast: if true, the solicited publish should be broadcasted
3526 * @subscribe_active: if true, the subscribe is active
3527 * @followup_id: the instance ID for follow up
3528 * @followup_reqid: the requestor instance ID for follow up
3529 * @followup_dest: MAC address of the recipient of the follow up
3530 * @ttl: time to live counter in DW.
3531 * @serv_spec_info: Service Specific Info
3532 * @serv_spec_info_len: Service Specific Info length
3533 * @srf_include: if true, SRF is inclusive
3534 * @srf_bf: Bloom Filter
3535 * @srf_bf_len: Bloom Filter length
3536 * @srf_bf_idx: Bloom Filter index
3537 * @srf_macs: SRF MAC addresses
3538 * @srf_num_macs: number of MAC addresses in SRF
3539 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3540 * @tx_filters: filters that should be transmitted in the SDF.
3541 * @num_rx_filters: length of &rx_filters.
3542 * @num_tx_filters: length of &tx_filters.
3543 * @instance_id: driver allocated id of the function.
3544 * @cookie: unique NAN function identifier.
3545 */
3546struct cfg80211_nan_func {
3547 enum nl80211_nan_function_type type;
3548 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3549 u8 publish_type;
3550 bool close_range;
3551 bool publish_bcast;
3552 bool subscribe_active;
3553 u8 followup_id;
3554 u8 followup_reqid;
3555 struct mac_address followup_dest;
3556 u32 ttl;
3557 const u8 *serv_spec_info;
3558 u8 serv_spec_info_len;
3559 bool srf_include;
3560 const u8 *srf_bf;
3561 u8 srf_bf_len;
3562 u8 srf_bf_idx;
3563 struct mac_address *srf_macs;
3564 int srf_num_macs;
3565 struct cfg80211_nan_func_filter *rx_filters;
3566 struct cfg80211_nan_func_filter *tx_filters;
3567 u8 num_tx_filters;
3568 u8 num_rx_filters;
3569 u8 instance_id;
3570 u64 cookie;
3571};
3572
3573/**
3574 * struct cfg80211_pmk_conf - PMK configuration
3575 *
3576 * @aa: authenticator address
3577 * @pmk_len: PMK length in bytes.
3578 * @pmk: the PMK material
3579 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3580 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3581 * holds PMK-R0.
3582 */
3583struct cfg80211_pmk_conf {
3584 const u8 *aa;
3585 u8 pmk_len;
3586 const u8 *pmk;
3587 const u8 *pmk_r0_name;
3588};
3589
3590/**
3591 * struct cfg80211_external_auth_params - Trigger External authentication.
3592 *
3593 * Commonly used across the external auth request and event interfaces.
3594 *
3595 * @action: action type / trigger for external authentication. Only significant
3596 * for the authentication request event interface (driver to user space).
3597 * @bssid: BSSID of the peer with which the authentication has
3598 * to happen. Used by both the authentication request event and
3599 * authentication response command interface.
3600 * @ssid: SSID of the AP. Used by both the authentication request event and
3601 * authentication response command interface.
3602 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3603 * authentication request event interface.
3604 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3605 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3606 * the real status code for failures. Used only for the authentication
3607 * response command interface (user space to driver).
3608 * @pmkid: The identifier to refer a PMKSA.
3609 */
3610struct cfg80211_external_auth_params {
3611 enum nl80211_external_auth_action action;
3612 u8 bssid[ETH_ALEN] __aligned(2);
3613 struct cfg80211_ssid ssid;
3614 unsigned int key_mgmt_suite;
3615 u16 status;
3616 const u8 *pmkid;
3617};
3618
3619/**
3620 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3621 *
3622 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3623 * indicate the relevant values in this struct for them
3624 * @success_num: number of FTM sessions in which all frames were successfully
3625 * answered
3626 * @partial_num: number of FTM sessions in which part of frames were
3627 * successfully answered
3628 * @failed_num: number of failed FTM sessions
3629 * @asap_num: number of ASAP FTM sessions
3630 * @non_asap_num: number of non-ASAP FTM sessions
3631 * @total_duration_ms: total sessions durations - gives an indication
3632 * of how much time the responder was busy
3633 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3634 * initiators that didn't finish successfully the negotiation phase with
3635 * the responder
3636 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3637 * for a new scheduling although it already has scheduled FTM slot
3638 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3639 */
3640struct cfg80211_ftm_responder_stats {
3641 u32 filled;
3642 u32 success_num;
3643 u32 partial_num;
3644 u32 failed_num;
3645 u32 asap_num;
3646 u32 non_asap_num;
3647 u64 total_duration_ms;
3648 u32 unknown_triggers_num;
3649 u32 reschedule_requests_num;
3650 u32 out_of_window_triggers_num;
3651};
3652
3653/**
3654 * struct cfg80211_pmsr_ftm_result - FTM result
3655 * @failure_reason: if this measurement failed (PMSR status is
3656 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3657 * reason than just "failure"
3658 * @burst_index: if reporting partial results, this is the index
3659 * in [0 .. num_bursts-1] of the burst that's being reported
3660 * @num_ftmr_attempts: number of FTM request frames transmitted
3661 * @num_ftmr_successes: number of FTM request frames acked
3662 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3663 * fill this to indicate in how many seconds a retry is deemed possible
3664 * by the responder
3665 * @num_bursts_exp: actual number of bursts exponent negotiated
3666 * @burst_duration: actual burst duration negotiated
3667 * @ftms_per_burst: actual FTMs per burst negotiated
3668 * @lci_len: length of LCI information (if present)
3669 * @civicloc_len: length of civic location information (if present)
3670 * @lci: LCI data (may be %NULL)
3671 * @civicloc: civic location data (may be %NULL)
3672 * @rssi_avg: average RSSI over FTM action frames reported
3673 * @rssi_spread: spread of the RSSI over FTM action frames reported
3674 * @tx_rate: bitrate for transmitted FTM action frame response
3675 * @rx_rate: bitrate of received FTM action frame
3676 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3677 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3678 * the square root of the variance)
3679 * @rtt_spread: spread of the RTTs measured
3680 * @dist_avg: average of distances (mm) measured
3681 * (must have either this or @rtt_avg)
3682 * @dist_variance: variance of distances measured (see also @rtt_variance)
3683 * @dist_spread: spread of distances measured (see also @rtt_spread)
3684 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3685 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3686 * @rssi_avg_valid: @rssi_avg is valid
3687 * @rssi_spread_valid: @rssi_spread is valid
3688 * @tx_rate_valid: @tx_rate is valid
3689 * @rx_rate_valid: @rx_rate is valid
3690 * @rtt_avg_valid: @rtt_avg is valid
3691 * @rtt_variance_valid: @rtt_variance is valid
3692 * @rtt_spread_valid: @rtt_spread is valid
3693 * @dist_avg_valid: @dist_avg is valid
3694 * @dist_variance_valid: @dist_variance is valid
3695 * @dist_spread_valid: @dist_spread is valid
3696 */
3697struct cfg80211_pmsr_ftm_result {
3698 const u8 *lci;
3699 const u8 *civicloc;
3700 unsigned int lci_len;
3701 unsigned int civicloc_len;
3702 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3703 u32 num_ftmr_attempts, num_ftmr_successes;
3704 s16 burst_index;
3705 u8 busy_retry_time;
3706 u8 num_bursts_exp;
3707 u8 burst_duration;
3708 u8 ftms_per_burst;
3709 s32 rssi_avg;
3710 s32 rssi_spread;
3711 struct rate_info tx_rate, rx_rate;
3712 s64 rtt_avg;
3713 s64 rtt_variance;
3714 s64 rtt_spread;
3715 s64 dist_avg;
3716 s64 dist_variance;
3717 s64 dist_spread;
3718
3719 u16 num_ftmr_attempts_valid:1,
3720 num_ftmr_successes_valid:1,
3721 rssi_avg_valid:1,
3722 rssi_spread_valid:1,
3723 tx_rate_valid:1,
3724 rx_rate_valid:1,
3725 rtt_avg_valid:1,
3726 rtt_variance_valid:1,
3727 rtt_spread_valid:1,
3728 dist_avg_valid:1,
3729 dist_variance_valid:1,
3730 dist_spread_valid:1;
3731};
3732
3733/**
3734 * struct cfg80211_pmsr_result - peer measurement result
3735 * @addr: address of the peer
3736 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3737 * measurement was made)
3738 * @ap_tsf: AP's TSF at measurement time
3739 * @status: status of the measurement
3740 * @final: if reporting partial results, mark this as the last one; if not
3741 * reporting partial results always set this flag
3742 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3743 * @type: type of the measurement reported, note that we only support reporting
3744 * one type at a time, but you can report multiple results separately and
3745 * they're all aggregated for userspace.
3746 * @ftm: FTM result
3747 */
3748struct cfg80211_pmsr_result {
3749 u64 host_time, ap_tsf;
3750 enum nl80211_peer_measurement_status status;
3751
3752 u8 addr[ETH_ALEN];
3753
3754 u8 final:1,
3755 ap_tsf_valid:1;
3756
3757 enum nl80211_peer_measurement_type type;
3758
3759 union {
3760 struct cfg80211_pmsr_ftm_result ftm;
3761 };
3762};
3763
3764/**
3765 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3766 * @requested: indicates FTM is requested
3767 * @preamble: frame preamble to use
3768 * @burst_period: burst period to use
3769 * @asap: indicates to use ASAP mode
3770 * @num_bursts_exp: number of bursts exponent
3771 * @burst_duration: burst duration
3772 * @ftms_per_burst: number of FTMs per burst
3773 * @ftmr_retries: number of retries for FTM request
3774 * @request_lci: request LCI information
3775 * @request_civicloc: request civic location information
3776 * @trigger_based: use trigger based ranging for the measurement
3777 * If neither @trigger_based nor @non_trigger_based is set,
3778 * EDCA based ranging will be used.
3779 * @non_trigger_based: use non trigger based ranging for the measurement
3780 * If neither @trigger_based nor @non_trigger_based is set,
3781 * EDCA based ranging will be used.
3782 * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
3783 * @trigger_based or @non_trigger_based is set.
3784 * @bss_color: the bss color of the responder. Optional. Set to zero to
3785 * indicate the driver should set the BSS color. Only valid if
3786 * @non_trigger_based or @trigger_based is set.
3787 *
3788 * See also nl80211 for the respective attribute documentation.
3789 */
3790struct cfg80211_pmsr_ftm_request_peer {
3791 enum nl80211_preamble preamble;
3792 u16 burst_period;
3793 u8 requested:1,
3794 asap:1,
3795 request_lci:1,
3796 request_civicloc:1,
3797 trigger_based:1,
3798 non_trigger_based:1,
3799 lmr_feedback:1;
3800 u8 num_bursts_exp;
3801 u8 burst_duration;
3802 u8 ftms_per_burst;
3803 u8 ftmr_retries;
3804 u8 bss_color;
3805};
3806
3807/**
3808 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3809 * @addr: MAC address
3810 * @chandef: channel to use
3811 * @report_ap_tsf: report the associated AP's TSF
3812 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3813 */
3814struct cfg80211_pmsr_request_peer {
3815 u8 addr[ETH_ALEN];
3816 struct cfg80211_chan_def chandef;
3817 u8 report_ap_tsf:1;
3818 struct cfg80211_pmsr_ftm_request_peer ftm;
3819};
3820
3821/**
3822 * struct cfg80211_pmsr_request - peer measurement request
3823 * @cookie: cookie, set by cfg80211
3824 * @nl_portid: netlink portid - used by cfg80211
3825 * @drv_data: driver data for this request, if required for aborting,
3826 * not otherwise freed or anything by cfg80211
3827 * @mac_addr: MAC address used for (randomised) request
3828 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3829 * are 0 in the mask should be randomised, bits that are 1 should
3830 * be taken from the @mac_addr
3831 * @list: used by cfg80211 to hold on to the request
3832 * @timeout: timeout (in milliseconds) for the whole operation, if
3833 * zero it means there's no timeout
3834 * @n_peers: number of peers to do measurements with
3835 * @peers: per-peer measurement request data
3836 */
3837struct cfg80211_pmsr_request {
3838 u64 cookie;
3839 void *drv_data;
3840 u32 n_peers;
3841 u32 nl_portid;
3842
3843 u32 timeout;
3844
3845 u8 mac_addr[ETH_ALEN] __aligned(2);
3846 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3847
3848 struct list_head list;
3849
3850 struct cfg80211_pmsr_request_peer peers[];
3851};
3852
3853/**
3854 * struct cfg80211_update_owe_info - OWE Information
3855 *
3856 * This structure provides information needed for the drivers to offload OWE
3857 * (Opportunistic Wireless Encryption) processing to the user space.
3858 *
3859 * Commonly used across update_owe_info request and event interfaces.
3860 *
3861 * @peer: MAC address of the peer device for which the OWE processing
3862 * has to be done.
3863 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3864 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3865 * cannot give you the real status code for failures. Used only for
3866 * OWE update request command interface (user space to driver).
3867 * @ie: IEs obtained from the peer or constructed by the user space. These are
3868 * the IEs of the remote peer in the event from the host driver and
3869 * the constructed IEs by the user space in the request interface.
3870 * @ie_len: Length of IEs in octets.
3871 */
3872struct cfg80211_update_owe_info {
3873 u8 peer[ETH_ALEN] __aligned(2);
3874 u16 status;
3875 const u8 *ie;
3876 size_t ie_len;
3877};
3878
3879/**
3880 * struct mgmt_frame_regs - management frame registrations data
3881 * @global_stypes: bitmap of management frame subtypes registered
3882 * for the entire device
3883 * @interface_stypes: bitmap of management frame subtypes registered
3884 * for the given interface
3885 * @global_mcast_stypes: mcast RX is needed globally for these subtypes
3886 * @interface_mcast_stypes: mcast RX is needed on this interface
3887 * for these subtypes
3888 */
3889struct mgmt_frame_regs {
3890 u32 global_stypes, interface_stypes;
3891 u32 global_mcast_stypes, interface_mcast_stypes;
3892};
3893
3894/**
3895 * struct cfg80211_ops - backend description for wireless configuration
3896 *
3897 * This struct is registered by fullmac card drivers and/or wireless stacks
3898 * in order to handle configuration requests on their interfaces.
3899 *
3900 * All callbacks except where otherwise noted should return 0
3901 * on success or a negative error code.
3902 *
3903 * All operations are invoked with the wiphy mutex held. The RTNL may be
3904 * held in addition (due to wireless extensions) but this cannot be relied
3905 * upon except in cases where documented below. Note that due to ordering,
3906 * the RTNL also cannot be acquired in any handlers.
3907 *
3908 * @suspend: wiphy device needs to be suspended. The variable @wow will
3909 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3910 * configured for the device.
3911 * @resume: wiphy device needs to be resumed
3912 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3913 * to call device_set_wakeup_enable() to enable/disable wakeup from
3914 * the device.
3915 *
3916 * @add_virtual_intf: create a new virtual interface with the given name,
3917 * must set the struct wireless_dev's iftype. Beware: You must create
3918 * the new netdev in the wiphy's network namespace! Returns the struct
3919 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3920 * also set the address member in the wdev.
3921 * This additionally holds the RTNL to be able to do netdev changes.
3922 *
3923 * @del_virtual_intf: remove the virtual interface
3924 * This additionally holds the RTNL to be able to do netdev changes.
3925 *
3926 * @change_virtual_intf: change type/configuration of virtual interface,
3927 * keep the struct wireless_dev's iftype updated.
3928 * This additionally holds the RTNL to be able to do netdev changes.
3929 *
3930 * @add_intf_link: Add a new MLO link to the given interface. Note that
3931 * the wdev->link[] data structure has been updated, so the new link
3932 * address is available.
3933 * @del_intf_link: Remove an MLO link from the given interface.
3934 *
3935 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3936 * when adding a group key. @link_id will be -1 for non-MLO connection.
3937 * For MLO connection, @link_id will be >= 0 for group key and -1 for
3938 * pairwise key, @mac_addr will be peer's MLD address for MLO pairwise key.
3939 *
3940 * @get_key: get information about the key with the given parameters.
3941 * @mac_addr will be %NULL when requesting information for a group
3942 * key. All pointers given to the @callback function need not be valid
3943 * after it returns. This function should return an error if it is
3944 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3945 * @link_id will be -1 for non-MLO connection. For MLO connection,
3946 * @link_id will be >= 0 for group key and -1 for pairwise key, @mac_addr
3947 * will be peer's MLD address for MLO pairwise key.
3948 *
3949 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3950 * and @key_index, return -ENOENT if the key doesn't exist. @link_id will
3951 * be -1 for non-MLO connection. For MLO connection, @link_id will be >= 0
3952 * for group key and -1 for pairwise key, @mac_addr will be peer's MLD
3953 * address for MLO pairwise key.
3954 *
3955 * @set_default_key: set the default key on an interface. @link_id will be >= 0
3956 * for MLO connection and -1 for non-MLO connection.
3957 *
3958 * @set_default_mgmt_key: set the default management frame key on an interface.
3959 * @link_id will be >= 0 for MLO connection and -1 for non-MLO connection.
3960 *
3961 * @set_default_beacon_key: set the default Beacon frame key on an interface.
3962 * @link_id will be >= 0 for MLO connection and -1 for non-MLO connection.
3963 *
3964 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3965 *
3966 * @start_ap: Start acting in AP mode defined by the parameters.
3967 * @change_beacon: Change the beacon parameters for an access point mode
3968 * interface. This should reject the call when AP mode wasn't started.
3969 * @stop_ap: Stop being an AP, including stopping beaconing.
3970 *
3971 * @add_station: Add a new station.
3972 * @del_station: Remove a station
3973 * @change_station: Modify a given station. Note that flags changes are not much
3974 * validated in cfg80211, in particular the auth/assoc/authorized flags
3975 * might come to the driver in invalid combinations -- make sure to check
3976 * them, also against the existing state! Drivers must call
3977 * cfg80211_check_station_change() to validate the information.
3978 * @get_station: get station information for the station identified by @mac
3979 * @dump_station: dump station callback -- resume dump at index @idx
3980 *
3981 * @add_mpath: add a fixed mesh path
3982 * @del_mpath: delete a given mesh path
3983 * @change_mpath: change a given mesh path
3984 * @get_mpath: get a mesh path for the given parameters
3985 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3986 * @get_mpp: get a mesh proxy path for the given parameters
3987 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3988 * @join_mesh: join the mesh network with the specified parameters
3989 * (invoked with the wireless_dev mutex held)
3990 * @leave_mesh: leave the current mesh network
3991 * (invoked with the wireless_dev mutex held)
3992 *
3993 * @get_mesh_config: Get the current mesh configuration
3994 *
3995 * @update_mesh_config: Update mesh parameters on a running mesh.
3996 * The mask is a bitfield which tells us which parameters to
3997 * set, and which to leave alone.
3998 *
3999 * @change_bss: Modify parameters for a given BSS.
4000 *
4001 * @set_txq_params: Set TX queue parameters
4002 *
4003 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
4004 * as it doesn't implement join_mesh and needs to set the channel to
4005 * join the mesh instead.
4006 *
4007 * @set_monitor_channel: Set the monitor mode channel for the device. If other
4008 * interfaces are active this callback should reject the configuration.
4009 * If no interfaces are active or the device is down, the channel should
4010 * be stored for when a monitor interface becomes active.
4011 *
4012 * @scan: Request to do a scan. If returning zero, the scan request is given
4013 * the driver, and will be valid until passed to cfg80211_scan_done().
4014 * For scan results, call cfg80211_inform_bss(); you can call this outside
4015 * the scan/scan_done bracket too.
4016 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
4017 * indicate the status of the scan through cfg80211_scan_done().
4018 *
4019 * @auth: Request to authenticate with the specified peer
4020 * (invoked with the wireless_dev mutex held)
4021 * @assoc: Request to (re)associate with the specified peer
4022 * (invoked with the wireless_dev mutex held)
4023 * @deauth: Request to deauthenticate from the specified peer
4024 * (invoked with the wireless_dev mutex held)
4025 * @disassoc: Request to disassociate from the specified peer
4026 * (invoked with the wireless_dev mutex held)
4027 *
4028 * @connect: Connect to the ESS with the specified parameters. When connected,
4029 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
4030 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
4031 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
4032 * from the AP or cfg80211_connect_timeout() if no frame with status code
4033 * was received.
4034 * The driver is allowed to roam to other BSSes within the ESS when the
4035 * other BSS matches the connect parameters. When such roaming is initiated
4036 * by the driver, the driver is expected to verify that the target matches
4037 * the configured security parameters and to use Reassociation Request
4038 * frame instead of Association Request frame.
4039 * The connect function can also be used to request the driver to perform a
4040 * specific roam when connected to an ESS. In that case, the prev_bssid
4041 * parameter is set to the BSSID of the currently associated BSS as an
4042 * indication of requesting reassociation.
4043 * In both the driver-initiated and new connect() call initiated roaming
4044 * cases, the result of roaming is indicated with a call to
4045 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
4046 * @update_connect_params: Update the connect parameters while connected to a
4047 * BSS. The updated parameters can be used by driver/firmware for
4048 * subsequent BSS selection (roaming) decisions and to form the
4049 * Authentication/(Re)Association Request frames. This call does not
4050 * request an immediate disassociation or reassociation with the current
4051 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
4052 * changed are defined in &enum cfg80211_connect_params_changed.
4053 * (invoked with the wireless_dev mutex held)
4054 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
4055 * connection is in progress. Once done, call cfg80211_disconnected() in
4056 * case connection was already established (invoked with the
4057 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
4058 *
4059 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
4060 * cfg80211_ibss_joined(), also call that function when changing BSSID due
4061 * to a merge.
4062 * (invoked with the wireless_dev mutex held)
4063 * @leave_ibss: Leave the IBSS.
4064 * (invoked with the wireless_dev mutex held)
4065 *
4066 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
4067 * MESH mode)
4068 *
4069 * @set_wiphy_params: Notify that wiphy parameters have changed;
4070 * @changed bitfield (see &enum wiphy_params_flags) describes which values
4071 * have changed. The actual parameter values are available in
4072 * struct wiphy. If returning an error, no value should be changed.
4073 *
4074 * @set_tx_power: set the transmit power according to the parameters,
4075 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
4076 * wdev may be %NULL if power was set for the wiphy, and will
4077 * always be %NULL unless the driver supports per-vif TX power
4078 * (as advertised by the nl80211 feature flag.)
4079 * @get_tx_power: store the current TX power into the dbm variable;
4080 * return 0 if successful
4081 *
4082 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
4083 * functions to adjust rfkill hw state
4084 *
4085 * @dump_survey: get site survey information.
4086 *
4087 * @remain_on_channel: Request the driver to remain awake on the specified
4088 * channel for the specified duration to complete an off-channel
4089 * operation (e.g., public action frame exchange). When the driver is
4090 * ready on the requested channel, it must indicate this with an event
4091 * notification by calling cfg80211_ready_on_channel().
4092 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
4093 * This allows the operation to be terminated prior to timeout based on
4094 * the duration value.
4095 * @mgmt_tx: Transmit a management frame.
4096 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
4097 * frame on another channel
4098 *
4099 * @testmode_cmd: run a test mode command; @wdev may be %NULL
4100 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
4101 * used by the function, but 0 and 1 must not be touched. Additionally,
4102 * return error codes other than -ENOBUFS and -ENOENT will terminate the
4103 * dump and return to userspace with an error, so be careful. If any data
4104 * was passed in from userspace then the data/len arguments will be present
4105 * and point to the data contained in %NL80211_ATTR_TESTDATA.
4106 *
4107 * @set_bitrate_mask: set the bitrate mask configuration
4108 *
4109 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
4110 * devices running firmwares capable of generating the (re) association
4111 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
4112 * @del_pmksa: Delete a cached PMKID.
4113 * @flush_pmksa: Flush all cached PMKIDs.
4114 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
4115 * allows the driver to adjust the dynamic ps timeout value.
4116 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
4117 * After configuration, the driver should (soon) send an event indicating
4118 * the current level is above/below the configured threshold; this may
4119 * need some care when the configuration is changed (without first being
4120 * disabled.)
4121 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
4122 * connection quality monitor. An event is to be sent only when the
4123 * signal level is found to be outside the two values. The driver should
4124 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
4125 * If it is provided then there's no point providing @set_cqm_rssi_config.
4126 * @set_cqm_txe_config: Configure connection quality monitor TX error
4127 * thresholds.
4128 * @sched_scan_start: Tell the driver to start a scheduled scan.
4129 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
4130 * given request id. This call must stop the scheduled scan and be ready
4131 * for starting a new one before it returns, i.e. @sched_scan_start may be
4132 * called immediately after that again and should not fail in that case.
4133 * The driver should not call cfg80211_sched_scan_stopped() for a requested
4134 * stop (when this method returns 0).
4135 *
4136 * @update_mgmt_frame_registrations: Notify the driver that management frame
4137 * registrations were updated. The callback is allowed to sleep.
4138 *
4139 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
4140 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
4141 * reject TX/RX mask combinations they cannot support by returning -EINVAL
4142 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
4143 *
4144 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4145 *
4146 * @tdls_mgmt: Transmit a TDLS management frame.
4147 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
4148 *
4149 * @probe_client: probe an associated client, must return a cookie that it
4150 * later passes to cfg80211_probe_status().
4151 *
4152 * @set_noack_map: Set the NoAck Map for the TIDs.
4153 *
4154 * @get_channel: Get the current operating channel for the virtual interface.
4155 * For monitor interfaces, it should return %NULL unless there's a single
4156 * current monitoring channel.
4157 *
4158 * @start_p2p_device: Start the given P2P device.
4159 * @stop_p2p_device: Stop the given P2P device.
4160 *
4161 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
4162 * Parameters include ACL policy, an array of MAC address of stations
4163 * and the number of MAC addresses. If there is already a list in driver
4164 * this new list replaces the existing one. Driver has to clear its ACL
4165 * when number of MAC addresses entries is passed as 0. Drivers which
4166 * advertise the support for MAC based ACL have to implement this callback.
4167 *
4168 * @start_radar_detection: Start radar detection in the driver.
4169 *
4170 * @end_cac: End running CAC, probably because a related CAC
4171 * was finished on another phy.
4172 *
4173 * @update_ft_ies: Provide updated Fast BSS Transition information to the
4174 * driver. If the SME is in the driver/firmware, this information can be
4175 * used in building Authentication and Reassociation Request frames.
4176 *
4177 * @crit_proto_start: Indicates a critical protocol needs more link reliability
4178 * for a given duration (milliseconds). The protocol is provided so the
4179 * driver can take the most appropriate actions.
4180 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
4181 * reliability. This operation can not fail.
4182 * @set_coalesce: Set coalesce parameters.
4183 *
4184 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
4185 * responsible for veryfing if the switch is possible. Since this is
4186 * inherently tricky driver may decide to disconnect an interface later
4187 * with cfg80211_stop_iface(). This doesn't mean driver can accept
4188 * everything. It should do it's best to verify requests and reject them
4189 * as soon as possible.
4190 *
4191 * @set_qos_map: Set QoS mapping information to the driver
4192 *
4193 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
4194 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
4195 * changes during the lifetime of the BSS.
4196 *
4197 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
4198 * with the given parameters; action frame exchange has been handled by
4199 * userspace so this just has to modify the TX path to take the TS into
4200 * account.
4201 * If the admitted time is 0 just validate the parameters to make sure
4202 * the session can be created at all; it is valid to just always return
4203 * success for that but that may result in inefficient behaviour (handshake
4204 * with the peer followed by immediate teardown when the addition is later
4205 * rejected)
4206 * @del_tx_ts: remove an existing TX TS
4207 *
4208 * @join_ocb: join the OCB network with the specified parameters
4209 * (invoked with the wireless_dev mutex held)
4210 * @leave_ocb: leave the current OCB network
4211 * (invoked with the wireless_dev mutex held)
4212 *
4213 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4214 * is responsible for continually initiating channel-switching operations
4215 * and returning to the base channel for communication with the AP.
4216 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4217 * peers must be on the base channel when the call completes.
4218 * @start_nan: Start the NAN interface.
4219 * @stop_nan: Stop the NAN interface.
4220 * @add_nan_func: Add a NAN function. Returns negative value on failure.
4221 * On success @nan_func ownership is transferred to the driver and
4222 * it may access it outside of the scope of this function. The driver
4223 * should free the @nan_func when no longer needed by calling
4224 * cfg80211_free_nan_func().
4225 * On success the driver should assign an instance_id in the
4226 * provided @nan_func.
4227 * @del_nan_func: Delete a NAN function.
4228 * @nan_change_conf: changes NAN configuration. The changed parameters must
4229 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
4230 * All other parameters must be ignored.
4231 *
4232 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
4233 *
4234 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
4235 * function should return phy stats, and interface stats otherwise.
4236 *
4237 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
4238 * If not deleted through @del_pmk the PMK remains valid until disconnect
4239 * upon which the driver should clear it.
4240 * (invoked with the wireless_dev mutex held)
4241 * @del_pmk: delete the previously configured PMK for the given authenticator.
4242 * (invoked with the wireless_dev mutex held)
4243 *
4244 * @external_auth: indicates result of offloaded authentication processing from
4245 * user space
4246 *
4247 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
4248 * tells the driver that the frame should not be encrypted.
4249 *
4250 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4251 * Statistics should be cumulative, currently no way to reset is provided.
4252 * @start_pmsr: start peer measurement (e.g. FTM)
4253 * @abort_pmsr: abort peer measurement
4254 *
4255 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
4256 * but offloading OWE processing to the user space will get the updated
4257 * DH IE through this interface.
4258 *
4259 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
4260 * and overrule HWMP path selection algorithm.
4261 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
4262 * This callback may sleep.
4263 * @reset_tid_config: Reset TID specific configuration for the peer, for the
4264 * given TIDs. This callback may sleep.
4265 *
4266 * @set_sar_specs: Update the SAR (TX power) settings.
4267 *
4268 * @color_change: Initiate a color change.
4269 *
4270 * @set_fils_aad: Set FILS AAD data to the AP driver so that the driver can use
4271 * those to decrypt (Re)Association Request and encrypt (Re)Association
4272 * Response frame.
4273 *
4274 * @set_radar_background: Configure dedicated offchannel chain available for
4275 * radar/CAC detection on some hw. This chain can't be used to transmit
4276 * or receive frames and it is bounded to a running wdev.
4277 * Background radar/CAC detection allows to avoid the CAC downtime
4278 * switching to a different channel during CAC detection on the selected
4279 * radar channel.
4280 * The caller is expected to set chandef pointer to NULL in order to
4281 * disable background CAC/radar detection.
4282 * @add_link_station: Add a link to a station.
4283 * @mod_link_station: Modify a link of a station.
4284 * @del_link_station: Remove a link of a station.
4285 */
4286struct cfg80211_ops {
4287 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
4288 int (*resume)(struct wiphy *wiphy);
4289 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
4290
4291 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
4292 const char *name,
4293 unsigned char name_assign_type,
4294 enum nl80211_iftype type,
4295 struct vif_params *params);
4296 int (*del_virtual_intf)(struct wiphy *wiphy,
4297 struct wireless_dev *wdev);
4298 int (*change_virtual_intf)(struct wiphy *wiphy,
4299 struct net_device *dev,
4300 enum nl80211_iftype type,
4301 struct vif_params *params);
4302
4303 int (*add_intf_link)(struct wiphy *wiphy,
4304 struct wireless_dev *wdev,
4305 unsigned int link_id);
4306 void (*del_intf_link)(struct wiphy *wiphy,
4307 struct wireless_dev *wdev,
4308 unsigned int link_id);
4309
4310 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4311 int link_id, u8 key_index, bool pairwise,
4312 const u8 *mac_addr, struct key_params *params);
4313 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4314 int link_id, u8 key_index, bool pairwise,
4315 const u8 *mac_addr, void *cookie,
4316 void (*callback)(void *cookie, struct key_params*));
4317 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4318 int link_id, u8 key_index, bool pairwise,
4319 const u8 *mac_addr);
4320 int (*set_default_key)(struct wiphy *wiphy,
4321 struct net_device *netdev, int link_id,
4322 u8 key_index, bool unicast, bool multicast);
4323 int (*set_default_mgmt_key)(struct wiphy *wiphy,
4324 struct net_device *netdev, int link_id,
4325 u8 key_index);
4326 int (*set_default_beacon_key)(struct wiphy *wiphy,
4327 struct net_device *netdev,
4328 int link_id,
4329 u8 key_index);
4330
4331 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4332 struct cfg80211_ap_settings *settings);
4333 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4334 struct cfg80211_beacon_data *info);
4335 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev,
4336 unsigned int link_id);
4337
4338
4339 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
4340 const u8 *mac,
4341 struct station_parameters *params);
4342 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
4343 struct station_del_parameters *params);
4344 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
4345 const u8 *mac,
4346 struct station_parameters *params);
4347 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
4348 const u8 *mac, struct station_info *sinfo);
4349 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4350 int idx, u8 *mac, struct station_info *sinfo);
4351
4352 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4353 const u8 *dst, const u8 *next_hop);
4354 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4355 const u8 *dst);
4356 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4357 const u8 *dst, const u8 *next_hop);
4358 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4359 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4360 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4361 int idx, u8 *dst, u8 *next_hop,
4362 struct mpath_info *pinfo);
4363 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4364 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4365 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4366 int idx, u8 *dst, u8 *mpp,
4367 struct mpath_info *pinfo);
4368 int (*get_mesh_config)(struct wiphy *wiphy,
4369 struct net_device *dev,
4370 struct mesh_config *conf);
4371 int (*update_mesh_config)(struct wiphy *wiphy,
4372 struct net_device *dev, u32 mask,
4373 const struct mesh_config *nconf);
4374 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4375 const struct mesh_config *conf,
4376 const struct mesh_setup *setup);
4377 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4378
4379 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4380 struct ocb_setup *setup);
4381 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4382
4383 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4384 struct bss_parameters *params);
4385
4386 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4387 struct ieee80211_txq_params *params);
4388
4389 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4390 struct net_device *dev,
4391 struct ieee80211_channel *chan);
4392
4393 int (*set_monitor_channel)(struct wiphy *wiphy,
4394 struct cfg80211_chan_def *chandef);
4395
4396 int (*scan)(struct wiphy *wiphy,
4397 struct cfg80211_scan_request *request);
4398 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4399
4400 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4401 struct cfg80211_auth_request *req);
4402 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4403 struct cfg80211_assoc_request *req);
4404 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4405 struct cfg80211_deauth_request *req);
4406 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4407 struct cfg80211_disassoc_request *req);
4408
4409 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4410 struct cfg80211_connect_params *sme);
4411 int (*update_connect_params)(struct wiphy *wiphy,
4412 struct net_device *dev,
4413 struct cfg80211_connect_params *sme,
4414 u32 changed);
4415 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4416 u16 reason_code);
4417
4418 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4419 struct cfg80211_ibss_params *params);
4420 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4421
4422 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4423 int rate[NUM_NL80211_BANDS]);
4424
4425 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4426
4427 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4428 enum nl80211_tx_power_setting type, int mbm);
4429 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4430 int *dbm);
4431
4432 void (*rfkill_poll)(struct wiphy *wiphy);
4433
4434#ifdef CONFIG_NL80211_TESTMODE
4435 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4436 void *data, int len);
4437 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4438 struct netlink_callback *cb,
4439 void *data, int len);
4440#endif
4441
4442 int (*set_bitrate_mask)(struct wiphy *wiphy,
4443 struct net_device *dev,
4444 unsigned int link_id,
4445 const u8 *peer,
4446 const struct cfg80211_bitrate_mask *mask);
4447
4448 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4449 int idx, struct survey_info *info);
4450
4451 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4452 struct cfg80211_pmksa *pmksa);
4453 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4454 struct cfg80211_pmksa *pmksa);
4455 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4456
4457 int (*remain_on_channel)(struct wiphy *wiphy,
4458 struct wireless_dev *wdev,
4459 struct ieee80211_channel *chan,
4460 unsigned int duration,
4461 u64 *cookie);
4462 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4463 struct wireless_dev *wdev,
4464 u64 cookie);
4465
4466 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4467 struct cfg80211_mgmt_tx_params *params,
4468 u64 *cookie);
4469 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4470 struct wireless_dev *wdev,
4471 u64 cookie);
4472
4473 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4474 bool enabled, int timeout);
4475
4476 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4477 struct net_device *dev,
4478 s32 rssi_thold, u32 rssi_hyst);
4479
4480 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4481 struct net_device *dev,
4482 s32 rssi_low, s32 rssi_high);
4483
4484 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4485 struct net_device *dev,
4486 u32 rate, u32 pkts, u32 intvl);
4487
4488 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4489 struct wireless_dev *wdev,
4490 struct mgmt_frame_regs *upd);
4491
4492 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4493 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4494
4495 int (*sched_scan_start)(struct wiphy *wiphy,
4496 struct net_device *dev,
4497 struct cfg80211_sched_scan_request *request);
4498 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4499 u64 reqid);
4500
4501 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4502 struct cfg80211_gtk_rekey_data *data);
4503
4504 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4505 const u8 *peer, u8 action_code, u8 dialog_token,
4506 u16 status_code, u32 peer_capability,
4507 bool initiator, const u8 *buf, size_t len);
4508 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4509 const u8 *peer, enum nl80211_tdls_operation oper);
4510
4511 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4512 const u8 *peer, u64 *cookie);
4513
4514 int (*set_noack_map)(struct wiphy *wiphy,
4515 struct net_device *dev,
4516 u16 noack_map);
4517
4518 int (*get_channel)(struct wiphy *wiphy,
4519 struct wireless_dev *wdev,
4520 unsigned int link_id,
4521 struct cfg80211_chan_def *chandef);
4522
4523 int (*start_p2p_device)(struct wiphy *wiphy,
4524 struct wireless_dev *wdev);
4525 void (*stop_p2p_device)(struct wiphy *wiphy,
4526 struct wireless_dev *wdev);
4527
4528 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4529 const struct cfg80211_acl_data *params);
4530
4531 int (*start_radar_detection)(struct wiphy *wiphy,
4532 struct net_device *dev,
4533 struct cfg80211_chan_def *chandef,
4534 u32 cac_time_ms);
4535 void (*end_cac)(struct wiphy *wiphy,
4536 struct net_device *dev);
4537 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4538 struct cfg80211_update_ft_ies_params *ftie);
4539 int (*crit_proto_start)(struct wiphy *wiphy,
4540 struct wireless_dev *wdev,
4541 enum nl80211_crit_proto_id protocol,
4542 u16 duration);
4543 void (*crit_proto_stop)(struct wiphy *wiphy,
4544 struct wireless_dev *wdev);
4545 int (*set_coalesce)(struct wiphy *wiphy,
4546 struct cfg80211_coalesce *coalesce);
4547
4548 int (*channel_switch)(struct wiphy *wiphy,
4549 struct net_device *dev,
4550 struct cfg80211_csa_settings *params);
4551
4552 int (*set_qos_map)(struct wiphy *wiphy,
4553 struct net_device *dev,
4554 struct cfg80211_qos_map *qos_map);
4555
4556 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4557 unsigned int link_id,
4558 struct cfg80211_chan_def *chandef);
4559
4560 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4561 u8 tsid, const u8 *peer, u8 user_prio,
4562 u16 admitted_time);
4563 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4564 u8 tsid, const u8 *peer);
4565
4566 int (*tdls_channel_switch)(struct wiphy *wiphy,
4567 struct net_device *dev,
4568 const u8 *addr, u8 oper_class,
4569 struct cfg80211_chan_def *chandef);
4570 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4571 struct net_device *dev,
4572 const u8 *addr);
4573 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4574 struct cfg80211_nan_conf *conf);
4575 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4576 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4577 struct cfg80211_nan_func *nan_func);
4578 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4579 u64 cookie);
4580 int (*nan_change_conf)(struct wiphy *wiphy,
4581 struct wireless_dev *wdev,
4582 struct cfg80211_nan_conf *conf,
4583 u32 changes);
4584
4585 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4586 struct net_device *dev,
4587 const bool enabled);
4588
4589 int (*get_txq_stats)(struct wiphy *wiphy,
4590 struct wireless_dev *wdev,
4591 struct cfg80211_txq_stats *txqstats);
4592
4593 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4594 const struct cfg80211_pmk_conf *conf);
4595 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4596 const u8 *aa);
4597 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4598 struct cfg80211_external_auth_params *params);
4599
4600 int (*tx_control_port)(struct wiphy *wiphy,
4601 struct net_device *dev,
4602 const u8 *buf, size_t len,
4603 const u8 *dest, const __be16 proto,
4604 const bool noencrypt, int link_id,
4605 u64 *cookie);
4606
4607 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4608 struct net_device *dev,
4609 struct cfg80211_ftm_responder_stats *ftm_stats);
4610
4611 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4612 struct cfg80211_pmsr_request *request);
4613 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4614 struct cfg80211_pmsr_request *request);
4615 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4616 struct cfg80211_update_owe_info *owe_info);
4617 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4618 const u8 *buf, size_t len);
4619 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4620 struct cfg80211_tid_config *tid_conf);
4621 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4622 const u8 *peer, u8 tids);
4623 int (*set_sar_specs)(struct wiphy *wiphy,
4624 struct cfg80211_sar_specs *sar);
4625 int (*color_change)(struct wiphy *wiphy,
4626 struct net_device *dev,
4627 struct cfg80211_color_change_settings *params);
4628 int (*set_fils_aad)(struct wiphy *wiphy, struct net_device *dev,
4629 struct cfg80211_fils_aad *fils_aad);
4630 int (*set_radar_background)(struct wiphy *wiphy,
4631 struct cfg80211_chan_def *chandef);
4632 int (*add_link_station)(struct wiphy *wiphy, struct net_device *dev,
4633 struct link_station_parameters *params);
4634 int (*mod_link_station)(struct wiphy *wiphy, struct net_device *dev,
4635 struct link_station_parameters *params);
4636 int (*del_link_station)(struct wiphy *wiphy, struct net_device *dev,
4637 struct link_station_del_parameters *params);
4638};
4639
4640/*
4641 * wireless hardware and networking interfaces structures
4642 * and registration/helper functions
4643 */
4644
4645/**
4646 * enum wiphy_flags - wiphy capability flags
4647 *
4648 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4649 * into two, first for legacy bands and second for UHB.
4650 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4651 * wiphy at all
4652 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4653 * by default -- this flag will be set depending on the kernel's default
4654 * on wiphy_new(), but can be changed by the driver if it has a good
4655 * reason to override the default
4656 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4657 * on a VLAN interface). This flag also serves an extra purpose of
4658 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4659 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4660 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4661 * control port protocol ethertype. The device also honours the
4662 * control_port_no_encrypt flag.
4663 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4664 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4665 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4666 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4667 * firmware.
4668 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4669 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4670 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4671 * link setup/discovery operations internally. Setup, discovery and
4672 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4673 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4674 * used for asking the driver/firmware to perform a TDLS operation.
4675 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4676 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4677 * when there are virtual interfaces in AP mode by calling
4678 * cfg80211_report_obss_beacon().
4679 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4680 * responds to probe-requests in hardware.
4681 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4682 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4683 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4684 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4685 * beaconing mode (AP, IBSS, Mesh, ...).
4686 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4687 * before connection.
4688 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4689 * @WIPHY_FLAG_SUPPORTS_MLO: This is a temporary flag gating the MLO APIs,
4690 * in order to not have them reachable in normal drivers, until we have
4691 * complete feature/interface combinations/etc. advertisement. No driver
4692 * should set this flag for now.
4693 */
4694enum wiphy_flags {
4695 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4696 WIPHY_FLAG_SUPPORTS_MLO = BIT(1),
4697 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4698 WIPHY_FLAG_NETNS_OK = BIT(3),
4699 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4700 WIPHY_FLAG_4ADDR_AP = BIT(5),
4701 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4702 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4703 WIPHY_FLAG_IBSS_RSN = BIT(8),
4704 WIPHY_FLAG_MESH_AUTH = BIT(10),
4705 /* use hole at 11 */
4706 /* use hole at 12 */
4707 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4708 WIPHY_FLAG_AP_UAPSD = BIT(14),
4709 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4710 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4711 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4712 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4713 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4714 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4715 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4716 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4717 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4718 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4719};
4720
4721/**
4722 * struct ieee80211_iface_limit - limit on certain interface types
4723 * @max: maximum number of interfaces of these types
4724 * @types: interface types (bits)
4725 */
4726struct ieee80211_iface_limit {
4727 u16 max;
4728 u16 types;
4729};
4730
4731/**
4732 * struct ieee80211_iface_combination - possible interface combination
4733 *
4734 * With this structure the driver can describe which interface
4735 * combinations it supports concurrently.
4736 *
4737 * Examples:
4738 *
4739 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4740 *
4741 * .. code-block:: c
4742 *
4743 * struct ieee80211_iface_limit limits1[] = {
4744 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4745 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP), },
4746 * };
4747 * struct ieee80211_iface_combination combination1 = {
4748 * .limits = limits1,
4749 * .n_limits = ARRAY_SIZE(limits1),
4750 * .max_interfaces = 2,
4751 * .beacon_int_infra_match = true,
4752 * };
4753 *
4754 *
4755 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4756 *
4757 * .. code-block:: c
4758 *
4759 * struct ieee80211_iface_limit limits2[] = {
4760 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4761 * BIT(NL80211_IFTYPE_P2P_GO), },
4762 * };
4763 * struct ieee80211_iface_combination combination2 = {
4764 * .limits = limits2,
4765 * .n_limits = ARRAY_SIZE(limits2),
4766 * .max_interfaces = 8,
4767 * .num_different_channels = 1,
4768 * };
4769 *
4770 *
4771 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4772 *
4773 * This allows for an infrastructure connection and three P2P connections.
4774 *
4775 * .. code-block:: c
4776 *
4777 * struct ieee80211_iface_limit limits3[] = {
4778 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4779 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4780 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4781 * };
4782 * struct ieee80211_iface_combination combination3 = {
4783 * .limits = limits3,
4784 * .n_limits = ARRAY_SIZE(limits3),
4785 * .max_interfaces = 4,
4786 * .num_different_channels = 2,
4787 * };
4788 *
4789 */
4790struct ieee80211_iface_combination {
4791 /**
4792 * @limits:
4793 * limits for the given interface types
4794 */
4795 const struct ieee80211_iface_limit *limits;
4796
4797 /**
4798 * @num_different_channels:
4799 * can use up to this many different channels
4800 */
4801 u32 num_different_channels;
4802
4803 /**
4804 * @max_interfaces:
4805 * maximum number of interfaces in total allowed in this group
4806 */
4807 u16 max_interfaces;
4808
4809 /**
4810 * @n_limits:
4811 * number of limitations
4812 */
4813 u8 n_limits;
4814
4815 /**
4816 * @beacon_int_infra_match:
4817 * In this combination, the beacon intervals between infrastructure
4818 * and AP types must match. This is required only in special cases.
4819 */
4820 bool beacon_int_infra_match;
4821
4822 /**
4823 * @radar_detect_widths:
4824 * bitmap of channel widths supported for radar detection
4825 */
4826 u8 radar_detect_widths;
4827
4828 /**
4829 * @radar_detect_regions:
4830 * bitmap of regions supported for radar detection
4831 */
4832 u8 radar_detect_regions;
4833
4834 /**
4835 * @beacon_int_min_gcd:
4836 * This interface combination supports different beacon intervals.
4837 *
4838 * = 0
4839 * all beacon intervals for different interface must be same.
4840 * > 0
4841 * any beacon interval for the interface part of this combination AND
4842 * GCD of all beacon intervals from beaconing interfaces of this
4843 * combination must be greater or equal to this value.
4844 */
4845 u32 beacon_int_min_gcd;
4846};
4847
4848struct ieee80211_txrx_stypes {
4849 u16 tx, rx;
4850};
4851
4852/**
4853 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4854 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4855 * trigger that keeps the device operating as-is and
4856 * wakes up the host on any activity, for example a
4857 * received packet that passed filtering; note that the
4858 * packet should be preserved in that case
4859 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4860 * (see nl80211.h)
4861 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4862 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4863 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4864 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4865 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4866 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4867 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4868 */
4869enum wiphy_wowlan_support_flags {
4870 WIPHY_WOWLAN_ANY = BIT(0),
4871 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4872 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4873 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4874 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4875 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4876 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4877 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4878 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4879};
4880
4881struct wiphy_wowlan_tcp_support {
4882 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4883 u32 data_payload_max;
4884 u32 data_interval_max;
4885 u32 wake_payload_max;
4886 bool seq;
4887};
4888
4889/**
4890 * struct wiphy_wowlan_support - WoWLAN support data
4891 * @flags: see &enum wiphy_wowlan_support_flags
4892 * @n_patterns: number of supported wakeup patterns
4893 * (see nl80211.h for the pattern definition)
4894 * @pattern_max_len: maximum length of each pattern
4895 * @pattern_min_len: minimum length of each pattern
4896 * @max_pkt_offset: maximum Rx packet offset
4897 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4898 * similar, but not necessarily identical, to max_match_sets for
4899 * scheduled scans.
4900 * See &struct cfg80211_sched_scan_request.@match_sets for more
4901 * details.
4902 * @tcp: TCP wakeup support information
4903 */
4904struct wiphy_wowlan_support {
4905 u32 flags;
4906 int n_patterns;
4907 int pattern_max_len;
4908 int pattern_min_len;
4909 int max_pkt_offset;
4910 int max_nd_match_sets;
4911 const struct wiphy_wowlan_tcp_support *tcp;
4912};
4913
4914/**
4915 * struct wiphy_coalesce_support - coalesce support data
4916 * @n_rules: maximum number of coalesce rules
4917 * @max_delay: maximum supported coalescing delay in msecs
4918 * @n_patterns: number of supported patterns in a rule
4919 * (see nl80211.h for the pattern definition)
4920 * @pattern_max_len: maximum length of each pattern
4921 * @pattern_min_len: minimum length of each pattern
4922 * @max_pkt_offset: maximum Rx packet offset
4923 */
4924struct wiphy_coalesce_support {
4925 int n_rules;
4926 int max_delay;
4927 int n_patterns;
4928 int pattern_max_len;
4929 int pattern_min_len;
4930 int max_pkt_offset;
4931};
4932
4933/**
4934 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4935 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4936 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4937 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4938 * (must be combined with %_WDEV or %_NETDEV)
4939 */
4940enum wiphy_vendor_command_flags {
4941 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4942 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4943 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4944};
4945
4946/**
4947 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4948 *
4949 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4950 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4951 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4952 *
4953 */
4954enum wiphy_opmode_flag {
4955 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4956 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4957 STA_OPMODE_N_SS_CHANGED = BIT(2),
4958};
4959
4960/**
4961 * struct sta_opmode_info - Station's ht/vht operation mode information
4962 * @changed: contains value from &enum wiphy_opmode_flag
4963 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4964 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4965 * @rx_nss: new rx_nss value of a station
4966 */
4967
4968struct sta_opmode_info {
4969 u32 changed;
4970 enum nl80211_smps_mode smps_mode;
4971 enum nl80211_chan_width bw;
4972 u8 rx_nss;
4973};
4974
4975#define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4976
4977/**
4978 * struct wiphy_vendor_command - vendor command definition
4979 * @info: vendor command identifying information, as used in nl80211
4980 * @flags: flags, see &enum wiphy_vendor_command_flags
4981 * @doit: callback for the operation, note that wdev is %NULL if the
4982 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4983 * pointer may be %NULL if userspace provided no data at all
4984 * @dumpit: dump callback, for transferring bigger/multiple items. The
4985 * @storage points to cb->args[5], ie. is preserved over the multiple
4986 * dumpit calls.
4987 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4988 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4989 * attribute is just raw data (e.g. a firmware command).
4990 * @maxattr: highest attribute number in policy
4991 * It's recommended to not have the same sub command with both @doit and
4992 * @dumpit, so that userspace can assume certain ones are get and others
4993 * are used with dump requests.
4994 */
4995struct wiphy_vendor_command {
4996 struct nl80211_vendor_cmd_info info;
4997 u32 flags;
4998 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4999 const void *data, int data_len);
5000 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
5001 struct sk_buff *skb, const void *data, int data_len,
5002 unsigned long *storage);
5003 const struct nla_policy *policy;
5004 unsigned int maxattr;
5005};
5006
5007/**
5008 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
5009 * @iftype: interface type
5010 * @extended_capabilities: extended capabilities supported by the driver,
5011 * additional capabilities might be supported by userspace; these are the
5012 * 802.11 extended capabilities ("Extended Capabilities element") and are
5013 * in the same format as in the information element. See IEEE Std
5014 * 802.11-2012 8.4.2.29 for the defined fields.
5015 * @extended_capabilities_mask: mask of the valid values
5016 * @extended_capabilities_len: length of the extended capabilities
5017 * @eml_capabilities: EML capabilities (for MLO)
5018 * @mld_capa_and_ops: MLD capabilities and operations (for MLO)
5019 */
5020struct wiphy_iftype_ext_capab {
5021 enum nl80211_iftype iftype;
5022 const u8 *extended_capabilities;
5023 const u8 *extended_capabilities_mask;
5024 u8 extended_capabilities_len;
5025 u16 eml_capabilities;
5026 u16 mld_capa_and_ops;
5027};
5028
5029/**
5030 * cfg80211_get_iftype_ext_capa - lookup interface type extended capability
5031 * @wiphy: the wiphy to look up from
5032 * @type: the interface type to look up
5033 */
5034const struct wiphy_iftype_ext_capab *
5035cfg80211_get_iftype_ext_capa(struct wiphy *wiphy, enum nl80211_iftype type);
5036
5037/**
5038 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
5039 * @max_peers: maximum number of peers in a single measurement
5040 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
5041 * @randomize_mac_addr: can randomize MAC address for measurement
5042 * @ftm: FTM measurement data
5043 * @ftm.supported: FTM measurement is supported
5044 * @ftm.asap: ASAP-mode is supported
5045 * @ftm.non_asap: non-ASAP-mode is supported
5046 * @ftm.request_lci: can request LCI data
5047 * @ftm.request_civicloc: can request civic location data
5048 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
5049 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
5050 * @ftm.max_bursts_exponent: maximum burst exponent supported
5051 * (set to -1 if not limited; note that setting this will necessarily
5052 * forbid using the value 15 to let the responder pick)
5053 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
5054 * not limited)
5055 * @ftm.trigger_based: trigger based ranging measurement is supported
5056 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
5057 */
5058struct cfg80211_pmsr_capabilities {
5059 unsigned int max_peers;
5060 u8 report_ap_tsf:1,
5061 randomize_mac_addr:1;
5062
5063 struct {
5064 u32 preambles;
5065 u32 bandwidths;
5066 s8 max_bursts_exponent;
5067 u8 max_ftms_per_burst;
5068 u8 supported:1,
5069 asap:1,
5070 non_asap:1,
5071 request_lci:1,
5072 request_civicloc:1,
5073 trigger_based:1,
5074 non_trigger_based:1;
5075 } ftm;
5076};
5077
5078/**
5079 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
5080 * suites for interface types defined in @iftypes_mask. Each type in the
5081 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
5082 *
5083 * @iftypes_mask: bitmask of interfaces types
5084 * @akm_suites: points to an array of supported akm suites
5085 * @n_akm_suites: number of supported AKM suites
5086 */
5087struct wiphy_iftype_akm_suites {
5088 u16 iftypes_mask;
5089 const u32 *akm_suites;
5090 int n_akm_suites;
5091};
5092
5093/**
5094 * struct wiphy - wireless hardware description
5095 * @mtx: mutex for the data (structures) of this device
5096 * @reg_notifier: the driver's regulatory notification callback,
5097 * note that if your driver uses wiphy_apply_custom_regulatory()
5098 * the reg_notifier's request can be passed as NULL
5099 * @regd: the driver's regulatory domain, if one was requested via
5100 * the regulatory_hint() API. This can be used by the driver
5101 * on the reg_notifier() if it chooses to ignore future
5102 * regulatory domain changes caused by other drivers.
5103 * @signal_type: signal type reported in &struct cfg80211_bss.
5104 * @cipher_suites: supported cipher suites
5105 * @n_cipher_suites: number of supported cipher suites
5106 * @akm_suites: supported AKM suites. These are the default AKMs supported if
5107 * the supported AKMs not advertized for a specific interface type in
5108 * iftype_akm_suites.
5109 * @n_akm_suites: number of supported AKM suites
5110 * @iftype_akm_suites: array of supported akm suites info per interface type.
5111 * Note that the bits in @iftypes_mask inside this structure cannot
5112 * overlap (i.e. only one occurrence of each type is allowed across all
5113 * instances of iftype_akm_suites).
5114 * @num_iftype_akm_suites: number of interface types for which supported akm
5115 * suites are specified separately.
5116 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
5117 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
5118 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
5119 * -1 = fragmentation disabled, only odd values >= 256 used
5120 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
5121 * @_net: the network namespace this wiphy currently lives in
5122 * @perm_addr: permanent MAC address of this device
5123 * @addr_mask: If the device supports multiple MAC addresses by masking,
5124 * set this to a mask with variable bits set to 1, e.g. if the last
5125 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
5126 * variable bits shall be determined by the interfaces added, with
5127 * interfaces not matching the mask being rejected to be brought up.
5128 * @n_addresses: number of addresses in @addresses.
5129 * @addresses: If the device has more than one address, set this pointer
5130 * to a list of addresses (6 bytes each). The first one will be used
5131 * by default for perm_addr. In this case, the mask should be set to
5132 * all-zeroes. In this case it is assumed that the device can handle
5133 * the same number of arbitrary MAC addresses.
5134 * @registered: protects ->resume and ->suspend sysfs callbacks against
5135 * unregister hardware
5136 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
5137 * It will be renamed automatically on wiphy renames
5138 * @dev: (virtual) struct device for this wiphy. The item in
5139 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
5140 * (see below).
5141 * @wext: wireless extension handlers
5142 * @priv: driver private data (sized according to wiphy_new() parameter)
5143 * @interface_modes: bitmask of interfaces types valid for this wiphy,
5144 * must be set by driver
5145 * @iface_combinations: Valid interface combinations array, should not
5146 * list single interface types.
5147 * @n_iface_combinations: number of entries in @iface_combinations array.
5148 * @software_iftypes: bitmask of software interface types, these are not
5149 * subject to any restrictions since they are purely managed in SW.
5150 * @flags: wiphy flags, see &enum wiphy_flags
5151 * @regulatory_flags: wiphy regulatory flags, see
5152 * &enum ieee80211_regulatory_flags
5153 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
5154 * @ext_features: extended features advertised to nl80211, see
5155 * &enum nl80211_ext_feature_index.
5156 * @bss_priv_size: each BSS struct has private data allocated with it,
5157 * this variable determines its size
5158 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
5159 * any given scan
5160 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
5161 * the device can run concurrently.
5162 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
5163 * for in any given scheduled scan
5164 * @max_match_sets: maximum number of match sets the device can handle
5165 * when performing a scheduled scan, 0 if filtering is not
5166 * supported.
5167 * @max_scan_ie_len: maximum length of user-controlled IEs device can
5168 * add to probe request frames transmitted during a scan, must not
5169 * include fixed IEs like supported rates
5170 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
5171 * scans
5172 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
5173 * of iterations) for scheduled scan supported by the device.
5174 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
5175 * single scan plan supported by the device.
5176 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
5177 * scan plan supported by the device.
5178 * @coverage_class: current coverage class
5179 * @fw_version: firmware version for ethtool reporting
5180 * @hw_version: hardware version for ethtool reporting
5181 * @max_num_pmkids: maximum number of PMKIDs supported by device
5182 * @privid: a pointer that drivers can use to identify if an arbitrary
5183 * wiphy is theirs, e.g. in global notifiers
5184 * @bands: information about bands/channels supported by this device
5185 *
5186 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
5187 * transmitted through nl80211, points to an array indexed by interface
5188 * type
5189 *
5190 * @available_antennas_tx: bitmap of antennas which are available to be
5191 * configured as TX antennas. Antenna configuration commands will be
5192 * rejected unless this or @available_antennas_rx is set.
5193 *
5194 * @available_antennas_rx: bitmap of antennas which are available to be
5195 * configured as RX antennas. Antenna configuration commands will be
5196 * rejected unless this or @available_antennas_tx is set.
5197 *
5198 * @probe_resp_offload:
5199 * Bitmap of supported protocols for probe response offloading.
5200 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
5201 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
5202 *
5203 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
5204 * may request, if implemented.
5205 *
5206 * @wowlan: WoWLAN support information
5207 * @wowlan_config: current WoWLAN configuration; this should usually not be
5208 * used since access to it is necessarily racy, use the parameter passed
5209 * to the suspend() operation instead.
5210 *
5211 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
5212 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
5213 * If null, then none can be over-ridden.
5214 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
5215 * If null, then none can be over-ridden.
5216 *
5217 * @wdev_list: the list of associated (virtual) interfaces; this list must
5218 * not be modified by the driver, but can be read with RTNL/RCU protection.
5219 *
5220 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
5221 * supports for ACL.
5222 *
5223 * @extended_capabilities: extended capabilities supported by the driver,
5224 * additional capabilities might be supported by userspace; these are
5225 * the 802.11 extended capabilities ("Extended Capabilities element")
5226 * and are in the same format as in the information element. See
5227 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
5228 * extended capabilities to be used if the capabilities are not specified
5229 * for a specific interface type in iftype_ext_capab.
5230 * @extended_capabilities_mask: mask of the valid values
5231 * @extended_capabilities_len: length of the extended capabilities
5232 * @iftype_ext_capab: array of extended capabilities per interface type
5233 * @num_iftype_ext_capab: number of interface types for which extended
5234 * capabilities are specified separately.
5235 * @coalesce: packet coalescing support information
5236 *
5237 * @vendor_commands: array of vendor commands supported by the hardware
5238 * @n_vendor_commands: number of vendor commands
5239 * @vendor_events: array of vendor events supported by the hardware
5240 * @n_vendor_events: number of vendor events
5241 *
5242 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
5243 * (including P2P GO) or 0 to indicate no such limit is advertised. The
5244 * driver is allowed to advertise a theoretical limit that it can reach in
5245 * some cases, but may not always reach.
5246 *
5247 * @max_num_csa_counters: Number of supported csa_counters in beacons
5248 * and probe responses. This value should be set if the driver
5249 * wishes to limit the number of csa counters. Default (0) means
5250 * infinite.
5251 * @bss_select_support: bitmask indicating the BSS selection criteria supported
5252 * by the driver in the .connect() callback. The bit position maps to the
5253 * attribute indices defined in &enum nl80211_bss_select_attr.
5254 *
5255 * @nan_supported_bands: bands supported by the device in NAN mode, a
5256 * bitmap of &enum nl80211_band values. For instance, for
5257 * NL80211_BAND_2GHZ, bit 0 would be set
5258 * (i.e. BIT(NL80211_BAND_2GHZ)).
5259 *
5260 * @txq_limit: configuration of internal TX queue frame limit
5261 * @txq_memory_limit: configuration internal TX queue memory limit
5262 * @txq_quantum: configuration of internal TX queue scheduler quantum
5263 *
5264 * @tx_queue_len: allow setting transmit queue len for drivers not using
5265 * wake_tx_queue
5266 *
5267 * @support_mbssid: can HW support association with nontransmitted AP
5268 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
5269 * HE AP, in order to avoid compatibility issues.
5270 * @support_mbssid must be set for this to have any effect.
5271 *
5272 * @pmsr_capa: peer measurement capabilities
5273 *
5274 * @tid_config_support: describes the per-TID config support that the
5275 * device has
5276 * @tid_config_support.vif: bitmap of attributes (configurations)
5277 * supported by the driver for each vif
5278 * @tid_config_support.peer: bitmap of attributes (configurations)
5279 * supported by the driver for each peer
5280 * @tid_config_support.max_retry: maximum supported retry count for
5281 * long/short retry configuration
5282 *
5283 * @max_data_retry_count: maximum supported per TID retry count for
5284 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
5285 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
5286 * @sar_capa: SAR control capabilities
5287 * @rfkill: a pointer to the rfkill structure
5288 *
5289 * @mbssid_max_interfaces: maximum number of interfaces supported by the driver
5290 * in a multiple BSSID set. This field must be set to a non-zero value
5291 * by the driver to advertise MBSSID support.
5292 * @ema_max_profile_periodicity: maximum profile periodicity supported by
5293 * the driver. Setting this field to a non-zero value indicates that the
5294 * driver supports enhanced multi-BSSID advertisements (EMA AP).
5295 * @max_num_akm_suites: maximum number of AKM suites allowed for
5296 * configuration through %NL80211_CMD_CONNECT, %NL80211_CMD_ASSOCIATE and
5297 * %NL80211_CMD_START_AP. Set to NL80211_MAX_NR_AKM_SUITES if not set by
5298 * driver. If set by driver minimum allowed value is
5299 * NL80211_MAX_NR_AKM_SUITES in order to avoid compatibility issues with
5300 * legacy userspace and maximum allowed value is
5301 * CFG80211_MAX_NUM_AKM_SUITES.
5302 */
5303struct wiphy {
5304 struct mutex mtx;
5305
5306 /* assign these fields before you register the wiphy */
5307
5308 u8 perm_addr[ETH_ALEN];
5309 u8 addr_mask[ETH_ALEN];
5310
5311 struct mac_address *addresses;
5312
5313 const struct ieee80211_txrx_stypes *mgmt_stypes;
5314
5315 const struct ieee80211_iface_combination *iface_combinations;
5316 int n_iface_combinations;
5317 u16 software_iftypes;
5318
5319 u16 n_addresses;
5320
5321 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
5322 u16 interface_modes;
5323
5324 u16 max_acl_mac_addrs;
5325
5326 u32 flags, regulatory_flags, features;
5327 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
5328
5329 u32 ap_sme_capa;
5330
5331 enum cfg80211_signal_type signal_type;
5332
5333 int bss_priv_size;
5334 u8 max_scan_ssids;
5335 u8 max_sched_scan_reqs;
5336 u8 max_sched_scan_ssids;
5337 u8 max_match_sets;
5338 u16 max_scan_ie_len;
5339 u16 max_sched_scan_ie_len;
5340 u32 max_sched_scan_plans;
5341 u32 max_sched_scan_plan_interval;
5342 u32 max_sched_scan_plan_iterations;
5343
5344 int n_cipher_suites;
5345 const u32 *cipher_suites;
5346
5347 int n_akm_suites;
5348 const u32 *akm_suites;
5349
5350 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
5351 unsigned int num_iftype_akm_suites;
5352
5353 u8 retry_short;
5354 u8 retry_long;
5355 u32 frag_threshold;
5356 u32 rts_threshold;
5357 u8 coverage_class;
5358
5359 char fw_version[ETHTOOL_FWVERS_LEN];
5360 u32 hw_version;
5361
5362#ifdef CONFIG_PM
5363 const struct wiphy_wowlan_support *wowlan;
5364 struct cfg80211_wowlan *wowlan_config;
5365#endif
5366
5367 u16 max_remain_on_channel_duration;
5368
5369 u8 max_num_pmkids;
5370
5371 u32 available_antennas_tx;
5372 u32 available_antennas_rx;
5373
5374 u32 probe_resp_offload;
5375
5376 const u8 *extended_capabilities, *extended_capabilities_mask;
5377 u8 extended_capabilities_len;
5378
5379 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5380 unsigned int num_iftype_ext_capab;
5381
5382 const void *privid;
5383
5384 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5385
5386 void (*reg_notifier)(struct wiphy *wiphy,
5387 struct regulatory_request *request);
5388
5389 /* fields below are read-only, assigned by cfg80211 */
5390
5391 const struct ieee80211_regdomain __rcu *regd;
5392
5393 struct device dev;
5394
5395 bool registered;
5396
5397 struct dentry *debugfsdir;
5398
5399 const struct ieee80211_ht_cap *ht_capa_mod_mask;
5400 const struct ieee80211_vht_cap *vht_capa_mod_mask;
5401
5402 struct list_head wdev_list;
5403
5404 possible_net_t _net;
5405
5406#ifdef CONFIG_CFG80211_WEXT
5407 const struct iw_handler_def *wext;
5408#endif
5409
5410 const struct wiphy_coalesce_support *coalesce;
5411
5412 const struct wiphy_vendor_command *vendor_commands;
5413 const struct nl80211_vendor_cmd_info *vendor_events;
5414 int n_vendor_commands, n_vendor_events;
5415
5416 u16 max_ap_assoc_sta;
5417
5418 u8 max_num_csa_counters;
5419
5420 u32 bss_select_support;
5421
5422 u8 nan_supported_bands;
5423
5424 u32 txq_limit;
5425 u32 txq_memory_limit;
5426 u32 txq_quantum;
5427
5428 unsigned long tx_queue_len;
5429
5430 u8 support_mbssid:1,
5431 support_only_he_mbssid:1;
5432
5433 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5434
5435 struct {
5436 u64 peer, vif;
5437 u8 max_retry;
5438 } tid_config_support;
5439
5440 u8 max_data_retry_count;
5441
5442 const struct cfg80211_sar_capa *sar_capa;
5443
5444 struct rfkill *rfkill;
5445
5446 u8 mbssid_max_interfaces;
5447 u8 ema_max_profile_periodicity;
5448 u16 max_num_akm_suites;
5449
5450 char priv[] __aligned(NETDEV_ALIGN);
5451};
5452
5453static inline struct net *wiphy_net(struct wiphy *wiphy)
5454{
5455 return read_pnet(&wiphy->_net);
5456}
5457
5458static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5459{
5460 write_pnet(&wiphy->_net, net);
5461}
5462
5463/**
5464 * wiphy_priv - return priv from wiphy
5465 *
5466 * @wiphy: the wiphy whose priv pointer to return
5467 * Return: The priv of @wiphy.
5468 */
5469static inline void *wiphy_priv(struct wiphy *wiphy)
5470{
5471 BUG_ON(!wiphy);
5472 return &wiphy->priv;
5473}
5474
5475/**
5476 * priv_to_wiphy - return the wiphy containing the priv
5477 *
5478 * @priv: a pointer previously returned by wiphy_priv
5479 * Return: The wiphy of @priv.
5480 */
5481static inline struct wiphy *priv_to_wiphy(void *priv)
5482{
5483 BUG_ON(!priv);
5484 return container_of(priv, struct wiphy, priv);
5485}
5486
5487/**
5488 * set_wiphy_dev - set device pointer for wiphy
5489 *
5490 * @wiphy: The wiphy whose device to bind
5491 * @dev: The device to parent it to
5492 */
5493static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5494{
5495 wiphy->dev.parent = dev;
5496}
5497
5498/**
5499 * wiphy_dev - get wiphy dev pointer
5500 *
5501 * @wiphy: The wiphy whose device struct to look up
5502 * Return: The dev of @wiphy.
5503 */
5504static inline struct device *wiphy_dev(struct wiphy *wiphy)
5505{
5506 return wiphy->dev.parent;
5507}
5508
5509/**
5510 * wiphy_name - get wiphy name
5511 *
5512 * @wiphy: The wiphy whose name to return
5513 * Return: The name of @wiphy.
5514 */
5515static inline const char *wiphy_name(const struct wiphy *wiphy)
5516{
5517 return dev_name(&wiphy->dev);
5518}
5519
5520/**
5521 * wiphy_new_nm - create a new wiphy for use with cfg80211
5522 *
5523 * @ops: The configuration operations for this device
5524 * @sizeof_priv: The size of the private area to allocate
5525 * @requested_name: Request a particular name.
5526 * NULL is valid value, and means use the default phy%d naming.
5527 *
5528 * Create a new wiphy and associate the given operations with it.
5529 * @sizeof_priv bytes are allocated for private use.
5530 *
5531 * Return: A pointer to the new wiphy. This pointer must be
5532 * assigned to each netdev's ieee80211_ptr for proper operation.
5533 */
5534struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5535 const char *requested_name);
5536
5537/**
5538 * wiphy_new - create a new wiphy for use with cfg80211
5539 *
5540 * @ops: The configuration operations for this device
5541 * @sizeof_priv: The size of the private area to allocate
5542 *
5543 * Create a new wiphy and associate the given operations with it.
5544 * @sizeof_priv bytes are allocated for private use.
5545 *
5546 * Return: A pointer to the new wiphy. This pointer must be
5547 * assigned to each netdev's ieee80211_ptr for proper operation.
5548 */
5549static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5550 int sizeof_priv)
5551{
5552 return wiphy_new_nm(ops, sizeof_priv, NULL);
5553}
5554
5555/**
5556 * wiphy_register - register a wiphy with cfg80211
5557 *
5558 * @wiphy: The wiphy to register.
5559 *
5560 * Return: A non-negative wiphy index or a negative error code.
5561 */
5562int wiphy_register(struct wiphy *wiphy);
5563
5564/* this is a define for better error reporting (file/line) */
5565#define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
5566
5567/**
5568 * rcu_dereference_wiphy - rcu_dereference with debug checking
5569 * @wiphy: the wiphy to check the locking on
5570 * @p: The pointer to read, prior to dereferencing
5571 *
5572 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
5573 * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
5574 */
5575#define rcu_dereference_wiphy(wiphy, p) \
5576 rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
5577
5578/**
5579 * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
5580 * @wiphy: the wiphy to check the locking on
5581 * @p: The pointer to read, prior to dereferencing
5582 *
5583 * Return the value of the specified RCU-protected pointer, but omit the
5584 * READ_ONCE(), because caller holds the wiphy mutex used for updates.
5585 */
5586#define wiphy_dereference(wiphy, p) \
5587 rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
5588
5589/**
5590 * get_wiphy_regdom - get custom regdomain for the given wiphy
5591 * @wiphy: the wiphy to get the regdomain from
5592 */
5593const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
5594
5595/**
5596 * wiphy_unregister - deregister a wiphy from cfg80211
5597 *
5598 * @wiphy: The wiphy to unregister.
5599 *
5600 * After this call, no more requests can be made with this priv
5601 * pointer, but the call may sleep to wait for an outstanding
5602 * request that is being handled.
5603 */
5604void wiphy_unregister(struct wiphy *wiphy);
5605
5606/**
5607 * wiphy_free - free wiphy
5608 *
5609 * @wiphy: The wiphy to free
5610 */
5611void wiphy_free(struct wiphy *wiphy);
5612
5613/* internal structs */
5614struct cfg80211_conn;
5615struct cfg80211_internal_bss;
5616struct cfg80211_cached_keys;
5617struct cfg80211_cqm_config;
5618
5619/**
5620 * wiphy_lock - lock the wiphy
5621 * @wiphy: the wiphy to lock
5622 *
5623 * This is mostly exposed so it can be done around registering and
5624 * unregistering netdevs that aren't created through cfg80211 calls,
5625 * since that requires locking in cfg80211 when the notifiers is
5626 * called, but that cannot differentiate which way it's called.
5627 *
5628 * When cfg80211 ops are called, the wiphy is already locked.
5629 */
5630static inline void wiphy_lock(struct wiphy *wiphy)
5631 __acquires(&wiphy->mtx)
5632{
5633 mutex_lock(&wiphy->mtx);
5634 __acquire(&wiphy->mtx);
5635}
5636
5637/**
5638 * wiphy_unlock - unlock the wiphy again
5639 * @wiphy: the wiphy to unlock
5640 */
5641static inline void wiphy_unlock(struct wiphy *wiphy)
5642 __releases(&wiphy->mtx)
5643{
5644 __release(&wiphy->mtx);
5645 mutex_unlock(&wiphy->mtx);
5646}
5647
5648/**
5649 * struct wireless_dev - wireless device state
5650 *
5651 * For netdevs, this structure must be allocated by the driver
5652 * that uses the ieee80211_ptr field in struct net_device (this
5653 * is intentional so it can be allocated along with the netdev.)
5654 * It need not be registered then as netdev registration will
5655 * be intercepted by cfg80211 to see the new wireless device,
5656 * however, drivers must lock the wiphy before registering or
5657 * unregistering netdevs if they pre-create any netdevs (in ops
5658 * called from cfg80211, the wiphy is already locked.)
5659 *
5660 * For non-netdev uses, it must also be allocated by the driver
5661 * in response to the cfg80211 callbacks that require it, as
5662 * there's no netdev registration in that case it may not be
5663 * allocated outside of callback operations that return it.
5664 *
5665 * @wiphy: pointer to hardware description
5666 * @iftype: interface type
5667 * @registered: is this wdev already registered with cfg80211
5668 * @registering: indicates we're doing registration under wiphy lock
5669 * for the notifier
5670 * @list: (private) Used to collect the interfaces
5671 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5672 * @identifier: (private) Identifier used in nl80211 to identify this
5673 * wireless device if it has no netdev
5674 * @u: union containing data specific to @iftype
5675 * @connected: indicates if connected or not (STA mode)
5676 * @bssid: (private) Used by the internal configuration code
5677 * @wext: (private) Used by the internal wireless extensions compat code
5678 * @wext.ibss: (private) IBSS data part of wext handling
5679 * @wext.connect: (private) connection handling data
5680 * @wext.keys: (private) (WEP) key data
5681 * @wext.ie: (private) extra elements for association
5682 * @wext.ie_len: (private) length of extra elements
5683 * @wext.bssid: (private) selected network BSSID
5684 * @wext.ssid: (private) selected network SSID
5685 * @wext.default_key: (private) selected default key index
5686 * @wext.default_mgmt_key: (private) selected default management key index
5687 * @wext.prev_bssid: (private) previous BSSID for reassociation
5688 * @wext.prev_bssid_valid: (private) previous BSSID validity
5689 * @use_4addr: indicates 4addr mode is used on this interface, must be
5690 * set by driver (if supported) on add_interface BEFORE registering the
5691 * netdev and may otherwise be used by driver read-only, will be update
5692 * by cfg80211 on change_interface
5693 * @mgmt_registrations: list of registrations for management frames
5694 * @mgmt_registrations_need_update: mgmt registrations were updated,
5695 * need to propagate the update to the driver
5696 * @mtx: mutex used to lock data in this struct, may be used by drivers
5697 * and some API functions require it held
5698 * @beacon_interval: beacon interval used on this device for transmitting
5699 * beacons, 0 when not valid
5700 * @address: The address for this device, valid only if @netdev is %NULL
5701 * @is_running: true if this is a non-netdev device that has been started, e.g.
5702 * the P2P Device.
5703 * @cac_started: true if DFS channel availability check has been started
5704 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5705 * @cac_time_ms: CAC time in ms
5706 * @ps: powersave mode is enabled
5707 * @ps_timeout: dynamic powersave timeout
5708 * @ap_unexpected_nlportid: (private) netlink port ID of application
5709 * registered for unexpected class 3 frames (AP mode)
5710 * @conn: (private) cfg80211 software SME connection state machine data
5711 * @connect_keys: (private) keys to set after connection is established
5712 * @conn_bss_type: connecting/connected BSS type
5713 * @conn_owner_nlportid: (private) connection owner socket port ID
5714 * @disconnect_wk: (private) auto-disconnect work
5715 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5716 * @event_list: (private) list for internal event processing
5717 * @event_lock: (private) lock for event list
5718 * @owner_nlportid: (private) owner socket port ID
5719 * @nl_owner_dead: (private) owner socket went away
5720 * @cqm_config: (private) nl80211 RSSI monitor state
5721 * @pmsr_list: (private) peer measurement requests
5722 * @pmsr_lock: (private) peer measurements requests/results lock
5723 * @pmsr_free_wk: (private) peer measurements cleanup work
5724 * @unprot_beacon_reported: (private) timestamp of last
5725 * unprotected beacon report
5726 * @links: array of %IEEE80211_MLD_MAX_NUM_LINKS elements containing @addr
5727 * @ap and @client for each link
5728 * @valid_links: bitmap describing what elements of @links are valid
5729 */
5730struct wireless_dev {
5731 struct wiphy *wiphy;
5732 enum nl80211_iftype iftype;
5733
5734 /* the remainder of this struct should be private to cfg80211 */
5735 struct list_head list;
5736 struct net_device *netdev;
5737
5738 u32 identifier;
5739
5740 struct list_head mgmt_registrations;
5741 u8 mgmt_registrations_need_update:1;
5742
5743 struct mutex mtx;
5744
5745 bool use_4addr, is_running, registered, registering;
5746
5747 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5748
5749 /* currently used for IBSS and SME - might be rearranged later */
5750 struct cfg80211_conn *conn;
5751 struct cfg80211_cached_keys *connect_keys;
5752 enum ieee80211_bss_type conn_bss_type;
5753 u32 conn_owner_nlportid;
5754
5755 struct work_struct disconnect_wk;
5756 u8 disconnect_bssid[ETH_ALEN];
5757
5758 struct list_head event_list;
5759 spinlock_t event_lock;
5760
5761 u8 connected:1;
5762
5763 bool ps;
5764 int ps_timeout;
5765
5766 u32 ap_unexpected_nlportid;
5767
5768 u32 owner_nlportid;
5769 bool nl_owner_dead;
5770
5771 /* FIXME: need to rework radar detection for MLO */
5772 bool cac_started;
5773 unsigned long cac_start_time;
5774 unsigned int cac_time_ms;
5775
5776#ifdef CONFIG_CFG80211_WEXT
5777 /* wext data */
5778 struct {
5779 struct cfg80211_ibss_params ibss;
5780 struct cfg80211_connect_params connect;
5781 struct cfg80211_cached_keys *keys;
5782 const u8 *ie;
5783 size_t ie_len;
5784 u8 bssid[ETH_ALEN];
5785 u8 prev_bssid[ETH_ALEN];
5786 u8 ssid[IEEE80211_MAX_SSID_LEN];
5787 s8 default_key, default_mgmt_key;
5788 bool prev_bssid_valid;
5789 } wext;
5790#endif
5791
5792 struct cfg80211_cqm_config *cqm_config;
5793
5794 struct list_head pmsr_list;
5795 spinlock_t pmsr_lock;
5796 struct work_struct pmsr_free_wk;
5797
5798 unsigned long unprot_beacon_reported;
5799
5800 union {
5801 struct {
5802 u8 connected_addr[ETH_ALEN] __aligned(2);
5803 u8 ssid[IEEE80211_MAX_SSID_LEN];
5804 u8 ssid_len;
5805 } client;
5806 struct {
5807 int beacon_interval;
5808 struct cfg80211_chan_def preset_chandef;
5809 struct cfg80211_chan_def chandef;
5810 u8 id[IEEE80211_MAX_SSID_LEN];
5811 u8 id_len, id_up_len;
5812 } mesh;
5813 struct {
5814 struct cfg80211_chan_def preset_chandef;
5815 u8 ssid[IEEE80211_MAX_SSID_LEN];
5816 u8 ssid_len;
5817 } ap;
5818 struct {
5819 struct cfg80211_internal_bss *current_bss;
5820 struct cfg80211_chan_def chandef;
5821 int beacon_interval;
5822 u8 ssid[IEEE80211_MAX_SSID_LEN];
5823 u8 ssid_len;
5824 } ibss;
5825 struct {
5826 struct cfg80211_chan_def chandef;
5827 } ocb;
5828 } u;
5829
5830 struct {
5831 u8 addr[ETH_ALEN] __aligned(2);
5832 union {
5833 struct {
5834 unsigned int beacon_interval;
5835 struct cfg80211_chan_def chandef;
5836 } ap;
5837 struct {
5838 struct cfg80211_internal_bss *current_bss;
5839 } client;
5840 };
5841 } links[IEEE80211_MLD_MAX_NUM_LINKS];
5842 u16 valid_links;
5843};
5844
5845static inline const u8 *wdev_address(struct wireless_dev *wdev)
5846{
5847 if (wdev->netdev)
5848 return wdev->netdev->dev_addr;
5849 return wdev->address;
5850}
5851
5852static inline bool wdev_running(struct wireless_dev *wdev)
5853{
5854 if (wdev->netdev)
5855 return netif_running(wdev->netdev);
5856 return wdev->is_running;
5857}
5858
5859/**
5860 * wdev_priv - return wiphy priv from wireless_dev
5861 *
5862 * @wdev: The wireless device whose wiphy's priv pointer to return
5863 * Return: The wiphy priv of @wdev.
5864 */
5865static inline void *wdev_priv(struct wireless_dev *wdev)
5866{
5867 BUG_ON(!wdev);
5868 return wiphy_priv(wdev->wiphy);
5869}
5870
5871/**
5872 * wdev_chandef - return chandef pointer from wireless_dev
5873 * @wdev: the wdev
5874 * @link_id: the link ID for MLO
5875 *
5876 * Return: The chandef depending on the mode, or %NULL.
5877 */
5878struct cfg80211_chan_def *wdev_chandef(struct wireless_dev *wdev,
5879 unsigned int link_id);
5880
5881static inline void WARN_INVALID_LINK_ID(struct wireless_dev *wdev,
5882 unsigned int link_id)
5883{
5884 WARN_ON(link_id && !wdev->valid_links);
5885 WARN_ON(wdev->valid_links &&
5886 !(wdev->valid_links & BIT(link_id)));
5887}
5888
5889#define for_each_valid_link(link_info, link_id) \
5890 for (link_id = 0; \
5891 link_id < ((link_info)->valid_links ? \
5892 ARRAY_SIZE((link_info)->links) : 1); \
5893 link_id++) \
5894 if (!(link_info)->valid_links || \
5895 ((link_info)->valid_links & BIT(link_id)))
5896
5897/**
5898 * DOC: Utility functions
5899 *
5900 * cfg80211 offers a number of utility functions that can be useful.
5901 */
5902
5903/**
5904 * ieee80211_channel_equal - compare two struct ieee80211_channel
5905 *
5906 * @a: 1st struct ieee80211_channel
5907 * @b: 2nd struct ieee80211_channel
5908 * Return: true if center frequency of @a == @b
5909 */
5910static inline bool
5911ieee80211_channel_equal(struct ieee80211_channel *a,
5912 struct ieee80211_channel *b)
5913{
5914 return (a->center_freq == b->center_freq &&
5915 a->freq_offset == b->freq_offset);
5916}
5917
5918/**
5919 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5920 * @chan: struct ieee80211_channel to convert
5921 * Return: The corresponding frequency (in KHz)
5922 */
5923static inline u32
5924ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5925{
5926 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5927}
5928
5929/**
5930 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5931 *
5932 * Only allowed for band NL80211_BAND_S1GHZ
5933 * @chan: channel
5934 * Return: The allowed channel width for this center_freq
5935 */
5936enum nl80211_chan_width
5937ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5938
5939/**
5940 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5941 * @chan: channel number
5942 * @band: band, necessary due to channel number overlap
5943 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5944 */
5945u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5946
5947/**
5948 * ieee80211_channel_to_frequency - convert channel number to frequency
5949 * @chan: channel number
5950 * @band: band, necessary due to channel number overlap
5951 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5952 */
5953static inline int
5954ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5955{
5956 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5957}
5958
5959/**
5960 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5961 * @freq: center frequency in KHz
5962 * Return: The corresponding channel, or 0 if the conversion failed.
5963 */
5964int ieee80211_freq_khz_to_channel(u32 freq);
5965
5966/**
5967 * ieee80211_frequency_to_channel - convert frequency to channel number
5968 * @freq: center frequency in MHz
5969 * Return: The corresponding channel, or 0 if the conversion failed.
5970 */
5971static inline int
5972ieee80211_frequency_to_channel(int freq)
5973{
5974 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5975}
5976
5977/**
5978 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5979 * frequency
5980 * @wiphy: the struct wiphy to get the channel for
5981 * @freq: the center frequency (in KHz) of the channel
5982 * Return: The channel struct from @wiphy at @freq.
5983 */
5984struct ieee80211_channel *
5985ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5986
5987/**
5988 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5989 *
5990 * @wiphy: the struct wiphy to get the channel for
5991 * @freq: the center frequency (in MHz) of the channel
5992 * Return: The channel struct from @wiphy at @freq.
5993 */
5994static inline struct ieee80211_channel *
5995ieee80211_get_channel(struct wiphy *wiphy, int freq)
5996{
5997 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5998}
5999
6000/**
6001 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
6002 * @chan: control channel to check
6003 *
6004 * The Preferred Scanning Channels (PSC) are defined in
6005 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
6006 */
6007static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
6008{
6009 if (chan->band != NL80211_BAND_6GHZ)
6010 return false;
6011
6012 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
6013}
6014
6015/**
6016 * ieee80211_get_response_rate - get basic rate for a given rate
6017 *
6018 * @sband: the band to look for rates in
6019 * @basic_rates: bitmap of basic rates
6020 * @bitrate: the bitrate for which to find the basic rate
6021 *
6022 * Return: The basic rate corresponding to a given bitrate, that
6023 * is the next lower bitrate contained in the basic rate map,
6024 * which is, for this function, given as a bitmap of indices of
6025 * rates in the band's bitrate table.
6026 */
6027const struct ieee80211_rate *
6028ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
6029 u32 basic_rates, int bitrate);
6030
6031/**
6032 * ieee80211_mandatory_rates - get mandatory rates for a given band
6033 * @sband: the band to look for rates in
6034 * @scan_width: width of the control channel
6035 *
6036 * This function returns a bitmap of the mandatory rates for the given
6037 * band, bits are set according to the rate position in the bitrates array.
6038 */
6039u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
6040 enum nl80211_bss_scan_width scan_width);
6041
6042/*
6043 * Radiotap parsing functions -- for controlled injection support
6044 *
6045 * Implemented in net/wireless/radiotap.c
6046 * Documentation in Documentation/networking/radiotap-headers.rst
6047 */
6048
6049struct radiotap_align_size {
6050 uint8_t align:4, size:4;
6051};
6052
6053struct ieee80211_radiotap_namespace {
6054 const struct radiotap_align_size *align_size;
6055 int n_bits;
6056 uint32_t oui;
6057 uint8_t subns;
6058};
6059
6060struct ieee80211_radiotap_vendor_namespaces {
6061 const struct ieee80211_radiotap_namespace *ns;
6062 int n_ns;
6063};
6064
6065/**
6066 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
6067 * @this_arg_index: index of current arg, valid after each successful call
6068 * to ieee80211_radiotap_iterator_next()
6069 * @this_arg: pointer to current radiotap arg; it is valid after each
6070 * call to ieee80211_radiotap_iterator_next() but also after
6071 * ieee80211_radiotap_iterator_init() where it will point to
6072 * the beginning of the actual data portion
6073 * @this_arg_size: length of the current arg, for convenience
6074 * @current_namespace: pointer to the current namespace definition
6075 * (or internally %NULL if the current namespace is unknown)
6076 * @is_radiotap_ns: indicates whether the current namespace is the default
6077 * radiotap namespace or not
6078 *
6079 * @_rtheader: pointer to the radiotap header we are walking through
6080 * @_max_length: length of radiotap header in cpu byte ordering
6081 * @_arg_index: next argument index
6082 * @_arg: next argument pointer
6083 * @_next_bitmap: internal pointer to next present u32
6084 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
6085 * @_vns: vendor namespace definitions
6086 * @_next_ns_data: beginning of the next namespace's data
6087 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
6088 * next bitmap word
6089 *
6090 * Describes the radiotap parser state. Fields prefixed with an underscore
6091 * must not be used by users of the parser, only by the parser internally.
6092 */
6093
6094struct ieee80211_radiotap_iterator {
6095 struct ieee80211_radiotap_header *_rtheader;
6096 const struct ieee80211_radiotap_vendor_namespaces *_vns;
6097 const struct ieee80211_radiotap_namespace *current_namespace;
6098
6099 unsigned char *_arg, *_next_ns_data;
6100 __le32 *_next_bitmap;
6101
6102 unsigned char *this_arg;
6103 int this_arg_index;
6104 int this_arg_size;
6105
6106 int is_radiotap_ns;
6107
6108 int _max_length;
6109 int _arg_index;
6110 uint32_t _bitmap_shifter;
6111 int _reset_on_ext;
6112};
6113
6114int
6115ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
6116 struct ieee80211_radiotap_header *radiotap_header,
6117 int max_length,
6118 const struct ieee80211_radiotap_vendor_namespaces *vns);
6119
6120int
6121ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
6122
6123
6124extern const unsigned char rfc1042_header[6];
6125extern const unsigned char bridge_tunnel_header[6];
6126
6127/**
6128 * ieee80211_get_hdrlen_from_skb - get header length from data
6129 *
6130 * @skb: the frame
6131 *
6132 * Given an skb with a raw 802.11 header at the data pointer this function
6133 * returns the 802.11 header length.
6134 *
6135 * Return: The 802.11 header length in bytes (not including encryption
6136 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
6137 * 802.11 header.
6138 */
6139unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
6140
6141/**
6142 * ieee80211_hdrlen - get header length in bytes from frame control
6143 * @fc: frame control field in little-endian format
6144 * Return: The header length in bytes.
6145 */
6146unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
6147
6148/**
6149 * ieee80211_get_mesh_hdrlen - get mesh extension header length
6150 * @meshhdr: the mesh extension header, only the flags field
6151 * (first byte) will be accessed
6152 * Return: The length of the extension header, which is always at
6153 * least 6 bytes and at most 18 if address 5 and 6 are present.
6154 */
6155unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
6156
6157/**
6158 * DOC: Data path helpers
6159 *
6160 * In addition to generic utilities, cfg80211 also offers
6161 * functions that help implement the data path for devices
6162 * that do not do the 802.11/802.3 conversion on the device.
6163 */
6164
6165/**
6166 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
6167 * @skb: the 802.11 data frame
6168 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
6169 * of it being pushed into the SKB
6170 * @addr: the device MAC address
6171 * @iftype: the virtual interface type
6172 * @data_offset: offset of payload after the 802.11 header
6173 * @is_amsdu: true if the 802.11 header is A-MSDU
6174 * Return: 0 on success. Non-zero on error.
6175 */
6176int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
6177 const u8 *addr, enum nl80211_iftype iftype,
6178 u8 data_offset, bool is_amsdu);
6179
6180/**
6181 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
6182 * @skb: the 802.11 data frame
6183 * @addr: the device MAC address
6184 * @iftype: the virtual interface type
6185 * Return: 0 on success. Non-zero on error.
6186 */
6187static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
6188 enum nl80211_iftype iftype)
6189{
6190 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
6191}
6192
6193/**
6194 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
6195 *
6196 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
6197 * The @list will be empty if the decode fails. The @skb must be fully
6198 * header-less before being passed in here; it is freed in this function.
6199 *
6200 * @skb: The input A-MSDU frame without any headers.
6201 * @list: The output list of 802.3 frames. It must be allocated and
6202 * initialized by the caller.
6203 * @addr: The device MAC address.
6204 * @iftype: The device interface type.
6205 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
6206 * @check_da: DA to check in the inner ethernet header, or NULL
6207 * @check_sa: SA to check in the inner ethernet header, or NULL
6208 */
6209void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
6210 const u8 *addr, enum nl80211_iftype iftype,
6211 const unsigned int extra_headroom,
6212 const u8 *check_da, const u8 *check_sa);
6213
6214/**
6215 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
6216 * @skb: the data frame
6217 * @qos_map: Interworking QoS mapping or %NULL if not in use
6218 * Return: The 802.1p/1d tag.
6219 */
6220unsigned int cfg80211_classify8021d(struct sk_buff *skb,
6221 struct cfg80211_qos_map *qos_map);
6222
6223/**
6224 * cfg80211_find_elem_match - match information element and byte array in data
6225 *
6226 * @eid: element ID
6227 * @ies: data consisting of IEs
6228 * @len: length of data
6229 * @match: byte array to match
6230 * @match_len: number of bytes in the match array
6231 * @match_offset: offset in the IE data where the byte array should match.
6232 * Note the difference to cfg80211_find_ie_match() which considers
6233 * the offset to start from the element ID byte, but here we take
6234 * the data portion instead.
6235 *
6236 * Return: %NULL if the element ID could not be found or if
6237 * the element is invalid (claims to be longer than the given
6238 * data) or if the byte array doesn't match; otherwise return the
6239 * requested element struct.
6240 *
6241 * Note: There are no checks on the element length other than
6242 * having to fit into the given data and being large enough for the
6243 * byte array to match.
6244 */
6245const struct element *
6246cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
6247 const u8 *match, unsigned int match_len,
6248 unsigned int match_offset);
6249
6250/**
6251 * cfg80211_find_ie_match - match information element and byte array in data
6252 *
6253 * @eid: element ID
6254 * @ies: data consisting of IEs
6255 * @len: length of data
6256 * @match: byte array to match
6257 * @match_len: number of bytes in the match array
6258 * @match_offset: offset in the IE where the byte array should match.
6259 * If match_len is zero, this must also be set to zero.
6260 * Otherwise this must be set to 2 or more, because the first
6261 * byte is the element id, which is already compared to eid, and
6262 * the second byte is the IE length.
6263 *
6264 * Return: %NULL if the element ID could not be found or if
6265 * the element is invalid (claims to be longer than the given
6266 * data) or if the byte array doesn't match, or a pointer to the first
6267 * byte of the requested element, that is the byte containing the
6268 * element ID.
6269 *
6270 * Note: There are no checks on the element length other than
6271 * having to fit into the given data and being large enough for the
6272 * byte array to match.
6273 */
6274static inline const u8 *
6275cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
6276 const u8 *match, unsigned int match_len,
6277 unsigned int match_offset)
6278{
6279 /* match_offset can't be smaller than 2, unless match_len is
6280 * zero, in which case match_offset must be zero as well.
6281 */
6282 if (WARN_ON((match_len && match_offset < 2) ||
6283 (!match_len && match_offset)))
6284 return NULL;
6285
6286 return (const void *)cfg80211_find_elem_match(eid, ies, len,
6287 match, match_len,
6288 match_offset ?
6289 match_offset - 2 : 0);
6290}
6291
6292/**
6293 * cfg80211_find_elem - find information element in data
6294 *
6295 * @eid: element ID
6296 * @ies: data consisting of IEs
6297 * @len: length of data
6298 *
6299 * Return: %NULL if the element ID could not be found or if
6300 * the element is invalid (claims to be longer than the given
6301 * data) or if the byte array doesn't match; otherwise return the
6302 * requested element struct.
6303 *
6304 * Note: There are no checks on the element length other than
6305 * having to fit into the given data.
6306 */
6307static inline const struct element *
6308cfg80211_find_elem(u8 eid, const u8 *ies, int len)
6309{
6310 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
6311}
6312
6313/**
6314 * cfg80211_find_ie - find information element in data
6315 *
6316 * @eid: element ID
6317 * @ies: data consisting of IEs
6318 * @len: length of data
6319 *
6320 * Return: %NULL if the element ID could not be found or if
6321 * the element is invalid (claims to be longer than the given
6322 * data), or a pointer to the first byte of the requested
6323 * element, that is the byte containing the element ID.
6324 *
6325 * Note: There are no checks on the element length other than
6326 * having to fit into the given data.
6327 */
6328static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
6329{
6330 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
6331}
6332
6333/**
6334 * cfg80211_find_ext_elem - find information element with EID Extension in data
6335 *
6336 * @ext_eid: element ID Extension
6337 * @ies: data consisting of IEs
6338 * @len: length of data
6339 *
6340 * Return: %NULL if the etended element could not be found or if
6341 * the element is invalid (claims to be longer than the given
6342 * data) or if the byte array doesn't match; otherwise return the
6343 * requested element struct.
6344 *
6345 * Note: There are no checks on the element length other than
6346 * having to fit into the given data.
6347 */
6348static inline const struct element *
6349cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
6350{
6351 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
6352 &ext_eid, 1, 0);
6353}
6354
6355/**
6356 * cfg80211_find_ext_ie - find information element with EID Extension in data
6357 *
6358 * @ext_eid: element ID Extension
6359 * @ies: data consisting of IEs
6360 * @len: length of data
6361 *
6362 * Return: %NULL if the extended element ID could not be found or if
6363 * the element is invalid (claims to be longer than the given
6364 * data), or a pointer to the first byte of the requested
6365 * element, that is the byte containing the element ID.
6366 *
6367 * Note: There are no checks on the element length other than
6368 * having to fit into the given data.
6369 */
6370static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
6371{
6372 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
6373 &ext_eid, 1, 2);
6374}
6375
6376/**
6377 * cfg80211_find_vendor_elem - find vendor specific information element in data
6378 *
6379 * @oui: vendor OUI
6380 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6381 * @ies: data consisting of IEs
6382 * @len: length of data
6383 *
6384 * Return: %NULL if the vendor specific element ID could not be found or if the
6385 * element is invalid (claims to be longer than the given data); otherwise
6386 * return the element structure for the requested element.
6387 *
6388 * Note: There are no checks on the element length other than having to fit into
6389 * the given data.
6390 */
6391const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
6392 const u8 *ies,
6393 unsigned int len);
6394
6395/**
6396 * cfg80211_find_vendor_ie - find vendor specific information element in data
6397 *
6398 * @oui: vendor OUI
6399 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6400 * @ies: data consisting of IEs
6401 * @len: length of data
6402 *
6403 * Return: %NULL if the vendor specific element ID could not be found or if the
6404 * element is invalid (claims to be longer than the given data), or a pointer to
6405 * the first byte of the requested element, that is the byte containing the
6406 * element ID.
6407 *
6408 * Note: There are no checks on the element length other than having to fit into
6409 * the given data.
6410 */
6411static inline const u8 *
6412cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
6413 const u8 *ies, unsigned int len)
6414{
6415 return (const void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
6416}
6417
6418/**
6419 * cfg80211_send_layer2_update - send layer 2 update frame
6420 *
6421 * @dev: network device
6422 * @addr: STA MAC address
6423 *
6424 * Wireless drivers can use this function to update forwarding tables in bridge
6425 * devices upon STA association.
6426 */
6427void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
6428
6429/**
6430 * DOC: Regulatory enforcement infrastructure
6431 *
6432 * TODO
6433 */
6434
6435/**
6436 * regulatory_hint - driver hint to the wireless core a regulatory domain
6437 * @wiphy: the wireless device giving the hint (used only for reporting
6438 * conflicts)
6439 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
6440 * should be in. If @rd is set this should be NULL. Note that if you
6441 * set this to NULL you should still set rd->alpha2 to some accepted
6442 * alpha2.
6443 *
6444 * Wireless drivers can use this function to hint to the wireless core
6445 * what it believes should be the current regulatory domain by
6446 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
6447 * domain should be in or by providing a completely build regulatory domain.
6448 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
6449 * for a regulatory domain structure for the respective country.
6450 *
6451 * The wiphy must have been registered to cfg80211 prior to this call.
6452 * For cfg80211 drivers this means you must first use wiphy_register(),
6453 * for mac80211 drivers you must first use ieee80211_register_hw().
6454 *
6455 * Drivers should check the return value, its possible you can get
6456 * an -ENOMEM.
6457 *
6458 * Return: 0 on success. -ENOMEM.
6459 */
6460int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
6461
6462/**
6463 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
6464 * @wiphy: the wireless device we want to process the regulatory domain on
6465 * @rd: the regulatory domain informatoin to use for this wiphy
6466 *
6467 * Set the regulatory domain information for self-managed wiphys, only they
6468 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
6469 * information.
6470 *
6471 * Return: 0 on success. -EINVAL, -EPERM
6472 */
6473int regulatory_set_wiphy_regd(struct wiphy *wiphy,
6474 struct ieee80211_regdomain *rd);
6475
6476/**
6477 * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
6478 * @wiphy: the wireless device we want to process the regulatory domain on
6479 * @rd: the regulatory domain information to use for this wiphy
6480 *
6481 * This functions requires the RTNL and the wiphy mutex to be held and
6482 * applies the new regdomain synchronously to this wiphy. For more details
6483 * see regulatory_set_wiphy_regd().
6484 *
6485 * Return: 0 on success. -EINVAL, -EPERM
6486 */
6487int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
6488 struct ieee80211_regdomain *rd);
6489
6490/**
6491 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
6492 * @wiphy: the wireless device we want to process the regulatory domain on
6493 * @regd: the custom regulatory domain to use for this wiphy
6494 *
6495 * Drivers can sometimes have custom regulatory domains which do not apply
6496 * to a specific country. Drivers can use this to apply such custom regulatory
6497 * domains. This routine must be called prior to wiphy registration. The
6498 * custom regulatory domain will be trusted completely and as such previous
6499 * default channel settings will be disregarded. If no rule is found for a
6500 * channel on the regulatory domain the channel will be disabled.
6501 * Drivers using this for a wiphy should also set the wiphy flag
6502 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
6503 * that called this helper.
6504 */
6505void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
6506 const struct ieee80211_regdomain *regd);
6507
6508/**
6509 * freq_reg_info - get regulatory information for the given frequency
6510 * @wiphy: the wiphy for which we want to process this rule for
6511 * @center_freq: Frequency in KHz for which we want regulatory information for
6512 *
6513 * Use this function to get the regulatory rule for a specific frequency on
6514 * a given wireless device. If the device has a specific regulatory domain
6515 * it wants to follow we respect that unless a country IE has been received
6516 * and processed already.
6517 *
6518 * Return: A valid pointer, or, when an error occurs, for example if no rule
6519 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
6520 * check and PTR_ERR() to obtain the numeric return value. The numeric return
6521 * value will be -ERANGE if we determine the given center_freq does not even
6522 * have a regulatory rule for a frequency range in the center_freq's band.
6523 * See freq_in_rule_band() for our current definition of a band -- this is
6524 * purely subjective and right now it's 802.11 specific.
6525 */
6526const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
6527 u32 center_freq);
6528
6529/**
6530 * reg_initiator_name - map regulatory request initiator enum to name
6531 * @initiator: the regulatory request initiator
6532 *
6533 * You can use this to map the regulatory request initiator enum to a
6534 * proper string representation.
6535 */
6536const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
6537
6538/**
6539 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
6540 * @wiphy: wiphy for which pre-CAC capability is checked.
6541 *
6542 * Pre-CAC is allowed only in some regdomains (notable ETSI).
6543 */
6544bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
6545
6546/**
6547 * DOC: Internal regulatory db functions
6548 *
6549 */
6550
6551/**
6552 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6553 * Regulatory self-managed driver can use it to proactively
6554 *
6555 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6556 * @freq: the freqency(in MHz) to be queried.
6557 * @rule: pointer to store the wmm rule from the regulatory db.
6558 *
6559 * Self-managed wireless drivers can use this function to query
6560 * the internal regulatory database to check whether the given
6561 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6562 *
6563 * Drivers should check the return value, its possible you can get
6564 * an -ENODATA.
6565 *
6566 * Return: 0 on success. -ENODATA.
6567 */
6568int reg_query_regdb_wmm(char *alpha2, int freq,
6569 struct ieee80211_reg_rule *rule);
6570
6571/*
6572 * callbacks for asynchronous cfg80211 methods, notification
6573 * functions and BSS handling helpers
6574 */
6575
6576/**
6577 * cfg80211_scan_done - notify that scan finished
6578 *
6579 * @request: the corresponding scan request
6580 * @info: information about the completed scan
6581 */
6582void cfg80211_scan_done(struct cfg80211_scan_request *request,
6583 struct cfg80211_scan_info *info);
6584
6585/**
6586 * cfg80211_sched_scan_results - notify that new scan results are available
6587 *
6588 * @wiphy: the wiphy which got scheduled scan results
6589 * @reqid: identifier for the related scheduled scan request
6590 */
6591void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6592
6593/**
6594 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6595 *
6596 * @wiphy: the wiphy on which the scheduled scan stopped
6597 * @reqid: identifier for the related scheduled scan request
6598 *
6599 * The driver can call this function to inform cfg80211 that the
6600 * scheduled scan had to be stopped, for whatever reason. The driver
6601 * is then called back via the sched_scan_stop operation when done.
6602 */
6603void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6604
6605/**
6606 * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
6607 *
6608 * @wiphy: the wiphy on which the scheduled scan stopped
6609 * @reqid: identifier for the related scheduled scan request
6610 *
6611 * The driver can call this function to inform cfg80211 that the
6612 * scheduled scan had to be stopped, for whatever reason. The driver
6613 * is then called back via the sched_scan_stop operation when done.
6614 * This function should be called with the wiphy mutex held.
6615 */
6616void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
6617
6618/**
6619 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6620 * @wiphy: the wiphy reporting the BSS
6621 * @data: the BSS metadata
6622 * @mgmt: the management frame (probe response or beacon)
6623 * @len: length of the management frame
6624 * @gfp: context flags
6625 *
6626 * This informs cfg80211 that BSS information was found and
6627 * the BSS should be updated/added.
6628 *
6629 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6630 * Or %NULL on error.
6631 */
6632struct cfg80211_bss * __must_check
6633cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
6634 struct cfg80211_inform_bss *data,
6635 struct ieee80211_mgmt *mgmt, size_t len,
6636 gfp_t gfp);
6637
6638static inline struct cfg80211_bss * __must_check
6639cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6640 struct ieee80211_channel *rx_channel,
6641 enum nl80211_bss_scan_width scan_width,
6642 struct ieee80211_mgmt *mgmt, size_t len,
6643 s32 signal, gfp_t gfp)
6644{
6645 struct cfg80211_inform_bss data = {
6646 .chan = rx_channel,
6647 .scan_width = scan_width,
6648 .signal = signal,
6649 };
6650
6651 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6652}
6653
6654static inline struct cfg80211_bss * __must_check
6655cfg80211_inform_bss_frame(struct wiphy *wiphy,
6656 struct ieee80211_channel *rx_channel,
6657 struct ieee80211_mgmt *mgmt, size_t len,
6658 s32 signal, gfp_t gfp)
6659{
6660 struct cfg80211_inform_bss data = {
6661 .chan = rx_channel,
6662 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6663 .signal = signal,
6664 };
6665
6666 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6667}
6668
6669/**
6670 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6671 * @bssid: transmitter BSSID
6672 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6673 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6674 * @new_bssid: calculated nontransmitted BSSID
6675 */
6676static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6677 u8 mbssid_index, u8 *new_bssid)
6678{
6679 u64 bssid_u64 = ether_addr_to_u64(bssid);
6680 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6681 u64 new_bssid_u64;
6682
6683 new_bssid_u64 = bssid_u64 & ~mask;
6684
6685 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6686
6687 u64_to_ether_addr(new_bssid_u64, new_bssid);
6688}
6689
6690/**
6691 * cfg80211_is_element_inherited - returns if element ID should be inherited
6692 * @element: element to check
6693 * @non_inherit_element: non inheritance element
6694 */
6695bool cfg80211_is_element_inherited(const struct element *element,
6696 const struct element *non_inherit_element);
6697
6698/**
6699 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6700 * @ie: ies
6701 * @ielen: length of IEs
6702 * @mbssid_elem: current MBSSID element
6703 * @sub_elem: current MBSSID subelement (profile)
6704 * @merged_ie: location of the merged profile
6705 * @max_copy_len: max merged profile length
6706 */
6707size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6708 const struct element *mbssid_elem,
6709 const struct element *sub_elem,
6710 u8 *merged_ie, size_t max_copy_len);
6711
6712/**
6713 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6714 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6715 * from a beacon or probe response
6716 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6717 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6718 */
6719enum cfg80211_bss_frame_type {
6720 CFG80211_BSS_FTYPE_UNKNOWN,
6721 CFG80211_BSS_FTYPE_BEACON,
6722 CFG80211_BSS_FTYPE_PRESP,
6723};
6724
6725/**
6726 * cfg80211_get_ies_channel_number - returns the channel number from ies
6727 * @ie: IEs
6728 * @ielen: length of IEs
6729 * @band: enum nl80211_band of the channel
6730 * @ftype: frame type
6731 *
6732 * Returns the channel number, or -1 if none could be determined.
6733 */
6734int cfg80211_get_ies_channel_number(const u8 *ie, size_t ielen,
6735 enum nl80211_band band,
6736 enum cfg80211_bss_frame_type ftype);
6737
6738/**
6739 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6740 *
6741 * @wiphy: the wiphy reporting the BSS
6742 * @data: the BSS metadata
6743 * @ftype: frame type (if known)
6744 * @bssid: the BSSID of the BSS
6745 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6746 * @capability: the capability field sent by the peer
6747 * @beacon_interval: the beacon interval announced by the peer
6748 * @ie: additional IEs sent by the peer
6749 * @ielen: length of the additional IEs
6750 * @gfp: context flags
6751 *
6752 * This informs cfg80211 that BSS information was found and
6753 * the BSS should be updated/added.
6754 *
6755 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6756 * Or %NULL on error.
6757 */
6758struct cfg80211_bss * __must_check
6759cfg80211_inform_bss_data(struct wiphy *wiphy,
6760 struct cfg80211_inform_bss *data,
6761 enum cfg80211_bss_frame_type ftype,
6762 const u8 *bssid, u64 tsf, u16 capability,
6763 u16 beacon_interval, const u8 *ie, size_t ielen,
6764 gfp_t gfp);
6765
6766static inline struct cfg80211_bss * __must_check
6767cfg80211_inform_bss_width(struct wiphy *wiphy,
6768 struct ieee80211_channel *rx_channel,
6769 enum nl80211_bss_scan_width scan_width,
6770 enum cfg80211_bss_frame_type ftype,
6771 const u8 *bssid, u64 tsf, u16 capability,
6772 u16 beacon_interval, const u8 *ie, size_t ielen,
6773 s32 signal, gfp_t gfp)
6774{
6775 struct cfg80211_inform_bss data = {
6776 .chan = rx_channel,
6777 .scan_width = scan_width,
6778 .signal = signal,
6779 };
6780
6781 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6782 capability, beacon_interval, ie, ielen,
6783 gfp);
6784}
6785
6786static inline struct cfg80211_bss * __must_check
6787cfg80211_inform_bss(struct wiphy *wiphy,
6788 struct ieee80211_channel *rx_channel,
6789 enum cfg80211_bss_frame_type ftype,
6790 const u8 *bssid, u64 tsf, u16 capability,
6791 u16 beacon_interval, const u8 *ie, size_t ielen,
6792 s32 signal, gfp_t gfp)
6793{
6794 struct cfg80211_inform_bss data = {
6795 .chan = rx_channel,
6796 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6797 .signal = signal,
6798 };
6799
6800 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6801 capability, beacon_interval, ie, ielen,
6802 gfp);
6803}
6804
6805/**
6806 * cfg80211_get_bss - get a BSS reference
6807 * @wiphy: the wiphy this BSS struct belongs to
6808 * @channel: the channel to search on (or %NULL)
6809 * @bssid: the desired BSSID (or %NULL)
6810 * @ssid: the desired SSID (or %NULL)
6811 * @ssid_len: length of the SSID (or 0)
6812 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6813 * @privacy: privacy filter, see &enum ieee80211_privacy
6814 */
6815struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6816 struct ieee80211_channel *channel,
6817 const u8 *bssid,
6818 const u8 *ssid, size_t ssid_len,
6819 enum ieee80211_bss_type bss_type,
6820 enum ieee80211_privacy privacy);
6821static inline struct cfg80211_bss *
6822cfg80211_get_ibss(struct wiphy *wiphy,
6823 struct ieee80211_channel *channel,
6824 const u8 *ssid, size_t ssid_len)
6825{
6826 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6827 IEEE80211_BSS_TYPE_IBSS,
6828 IEEE80211_PRIVACY_ANY);
6829}
6830
6831/**
6832 * cfg80211_ref_bss - reference BSS struct
6833 * @wiphy: the wiphy this BSS struct belongs to
6834 * @bss: the BSS struct to reference
6835 *
6836 * Increments the refcount of the given BSS struct.
6837 */
6838void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6839
6840/**
6841 * cfg80211_put_bss - unref BSS struct
6842 * @wiphy: the wiphy this BSS struct belongs to
6843 * @bss: the BSS struct
6844 *
6845 * Decrements the refcount of the given BSS struct.
6846 */
6847void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6848
6849/**
6850 * cfg80211_unlink_bss - unlink BSS from internal data structures
6851 * @wiphy: the wiphy
6852 * @bss: the bss to remove
6853 *
6854 * This function removes the given BSS from the internal data structures
6855 * thereby making it no longer show up in scan results etc. Use this
6856 * function when you detect a BSS is gone. Normally BSSes will also time
6857 * out, so it is not necessary to use this function at all.
6858 */
6859void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6860
6861/**
6862 * cfg80211_bss_iter - iterate all BSS entries
6863 *
6864 * This function iterates over the BSS entries associated with the given wiphy
6865 * and calls the callback for the iterated BSS. The iterator function is not
6866 * allowed to call functions that might modify the internal state of the BSS DB.
6867 *
6868 * @wiphy: the wiphy
6869 * @chandef: if given, the iterator function will be called only if the channel
6870 * of the currently iterated BSS is a subset of the given channel.
6871 * @iter: the iterator function to call
6872 * @iter_data: an argument to the iterator function
6873 */
6874void cfg80211_bss_iter(struct wiphy *wiphy,
6875 struct cfg80211_chan_def *chandef,
6876 void (*iter)(struct wiphy *wiphy,
6877 struct cfg80211_bss *bss,
6878 void *data),
6879 void *iter_data);
6880
6881static inline enum nl80211_bss_scan_width
6882cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6883{
6884 switch (chandef->width) {
6885 case NL80211_CHAN_WIDTH_5:
6886 return NL80211_BSS_CHAN_WIDTH_5;
6887 case NL80211_CHAN_WIDTH_10:
6888 return NL80211_BSS_CHAN_WIDTH_10;
6889 default:
6890 return NL80211_BSS_CHAN_WIDTH_20;
6891 }
6892}
6893
6894/**
6895 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6896 * @dev: network device
6897 * @buf: authentication frame (header + body)
6898 * @len: length of the frame data
6899 *
6900 * This function is called whenever an authentication, disassociation or
6901 * deauthentication frame has been received and processed in station mode.
6902 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6903 * call either this function or cfg80211_auth_timeout().
6904 * After being asked to associate via cfg80211_ops::assoc() the driver must
6905 * call either this function or cfg80211_auth_timeout().
6906 * While connected, the driver must calls this for received and processed
6907 * disassociation and deauthentication frames. If the frame couldn't be used
6908 * because it was unprotected, the driver must call the function
6909 * cfg80211_rx_unprot_mlme_mgmt() instead.
6910 *
6911 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6912 */
6913void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6914
6915/**
6916 * cfg80211_auth_timeout - notification of timed out authentication
6917 * @dev: network device
6918 * @addr: The MAC address of the device with which the authentication timed out
6919 *
6920 * This function may sleep. The caller must hold the corresponding wdev's
6921 * mutex.
6922 */
6923void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6924
6925/**
6926 * struct cfg80211_rx_assoc_resp - association response data
6927 * @bss: the BSS that association was requested with, ownership of the pointer
6928 * moves to cfg80211 in the call to cfg80211_rx_assoc_resp()
6929 * @buf: (Re)Association Response frame (header + body)
6930 * @len: length of the frame data
6931 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6932 * as the AC bitmap in the QoS info field
6933 * @req_ies: information elements from the (Re)Association Request frame
6934 * @req_ies_len: length of req_ies data
6935 * @ap_mld_addr: AP MLD address (in case of MLO)
6936 * @links: per-link information indexed by link ID, use links[0] for
6937 * non-MLO connections
6938 * @links.status: Set this (along with a BSS pointer) for links that
6939 * were rejected by the AP.
6940 */
6941struct cfg80211_rx_assoc_resp {
6942 const u8 *buf;
6943 size_t len;
6944 const u8 *req_ies;
6945 size_t req_ies_len;
6946 int uapsd_queues;
6947 const u8 *ap_mld_addr;
6948 struct {
6949 const u8 *addr;
6950 struct cfg80211_bss *bss;
6951 u16 status;
6952 } links[IEEE80211_MLD_MAX_NUM_LINKS];
6953};
6954
6955/**
6956 * cfg80211_rx_assoc_resp - notification of processed association response
6957 * @dev: network device
6958 * @data: association response data, &struct cfg80211_rx_assoc_resp
6959 *
6960 * After being asked to associate via cfg80211_ops::assoc() the driver must
6961 * call either this function or cfg80211_auth_timeout().
6962 *
6963 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6964 */
6965void cfg80211_rx_assoc_resp(struct net_device *dev,
6966 struct cfg80211_rx_assoc_resp *data);
6967
6968/**
6969 * struct cfg80211_assoc_failure - association failure data
6970 * @ap_mld_addr: AP MLD address, or %NULL
6971 * @bss: list of BSSes, must use entry 0 for non-MLO connections
6972 * (@ap_mld_addr is %NULL)
6973 * @timeout: indicates the association failed due to timeout, otherwise
6974 * the association was abandoned for a reason reported through some
6975 * other API (e.g. deauth RX)
6976 */
6977struct cfg80211_assoc_failure {
6978 const u8 *ap_mld_addr;
6979 struct cfg80211_bss *bss[IEEE80211_MLD_MAX_NUM_LINKS];
6980 bool timeout;
6981};
6982
6983/**
6984 * cfg80211_assoc_failure - notification of association failure
6985 * @dev: network device
6986 * @data: data describing the association failure
6987 *
6988 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6989 */
6990void cfg80211_assoc_failure(struct net_device *dev,
6991 struct cfg80211_assoc_failure *data);
6992
6993/**
6994 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6995 * @dev: network device
6996 * @buf: 802.11 frame (header + body)
6997 * @len: length of the frame data
6998 * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
6999 *
7000 * This function is called whenever deauthentication has been processed in
7001 * station mode. This includes both received deauthentication frames and
7002 * locally generated ones. This function may sleep. The caller must hold the
7003 * corresponding wdev's mutex.
7004 */
7005void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
7006 bool reconnect);
7007
7008/**
7009 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
7010 * @dev: network device
7011 * @buf: received management frame (header + body)
7012 * @len: length of the frame data
7013 *
7014 * This function is called whenever a received deauthentication or dissassoc
7015 * frame has been dropped in station mode because of MFP being used but the
7016 * frame was not protected. This is also used to notify reception of a Beacon
7017 * frame that was dropped because it did not include a valid MME MIC while
7018 * beacon protection was enabled (BIGTK configured in station mode).
7019 *
7020 * This function may sleep.
7021 */
7022void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
7023 const u8 *buf, size_t len);
7024
7025/**
7026 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
7027 * @dev: network device
7028 * @addr: The source MAC address of the frame
7029 * @key_type: The key type that the received frame used
7030 * @key_id: Key identifier (0..3). Can be -1 if missing.
7031 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
7032 * @gfp: allocation flags
7033 *
7034 * This function is called whenever the local MAC detects a MIC failure in a
7035 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
7036 * primitive.
7037 */
7038void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
7039 enum nl80211_key_type key_type, int key_id,
7040 const u8 *tsc, gfp_t gfp);
7041
7042/**
7043 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
7044 *
7045 * @dev: network device
7046 * @bssid: the BSSID of the IBSS joined
7047 * @channel: the channel of the IBSS joined
7048 * @gfp: allocation flags
7049 *
7050 * This function notifies cfg80211 that the device joined an IBSS or
7051 * switched to a different BSSID. Before this function can be called,
7052 * either a beacon has to have been received from the IBSS, or one of
7053 * the cfg80211_inform_bss{,_frame} functions must have been called
7054 * with the locally generated beacon -- this guarantees that there is
7055 * always a scan result for this IBSS. cfg80211 will handle the rest.
7056 */
7057void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
7058 struct ieee80211_channel *channel, gfp_t gfp);
7059
7060/**
7061 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
7062 * candidate
7063 *
7064 * @dev: network device
7065 * @macaddr: the MAC address of the new candidate
7066 * @ie: information elements advertised by the peer candidate
7067 * @ie_len: length of the information elements buffer
7068 * @sig_dbm: signal level in dBm
7069 * @gfp: allocation flags
7070 *
7071 * This function notifies cfg80211 that the mesh peer candidate has been
7072 * detected, most likely via a beacon or, less likely, via a probe response.
7073 * cfg80211 then sends a notification to userspace.
7074 */
7075void cfg80211_notify_new_peer_candidate(struct net_device *dev,
7076 const u8 *macaddr, const u8 *ie, u8 ie_len,
7077 int sig_dbm, gfp_t gfp);
7078
7079/**
7080 * DOC: RFkill integration
7081 *
7082 * RFkill integration in cfg80211 is almost invisible to drivers,
7083 * as cfg80211 automatically registers an rfkill instance for each
7084 * wireless device it knows about. Soft kill is also translated
7085 * into disconnecting and turning all interfaces off, drivers are
7086 * expected to turn off the device when all interfaces are down.
7087 *
7088 * However, devices may have a hard RFkill line, in which case they
7089 * also need to interact with the rfkill subsystem, via cfg80211.
7090 * They can do this with a few helper functions documented here.
7091 */
7092
7093/**
7094 * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
7095 * @wiphy: the wiphy
7096 * @blocked: block status
7097 * @reason: one of reasons in &enum rfkill_hard_block_reasons
7098 */
7099void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
7100 enum rfkill_hard_block_reasons reason);
7101
7102static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
7103{
7104 wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
7105 RFKILL_HARD_BLOCK_SIGNAL);
7106}
7107
7108/**
7109 * wiphy_rfkill_start_polling - start polling rfkill
7110 * @wiphy: the wiphy
7111 */
7112void wiphy_rfkill_start_polling(struct wiphy *wiphy);
7113
7114/**
7115 * wiphy_rfkill_stop_polling - stop polling rfkill
7116 * @wiphy: the wiphy
7117 */
7118static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy)
7119{
7120 rfkill_pause_polling(wiphy->rfkill);
7121}
7122
7123/**
7124 * DOC: Vendor commands
7125 *
7126 * Occasionally, there are special protocol or firmware features that
7127 * can't be implemented very openly. For this and similar cases, the
7128 * vendor command functionality allows implementing the features with
7129 * (typically closed-source) userspace and firmware, using nl80211 as
7130 * the configuration mechanism.
7131 *
7132 * A driver supporting vendor commands must register them as an array
7133 * in struct wiphy, with handlers for each one, each command has an
7134 * OUI and sub command ID to identify it.
7135 *
7136 * Note that this feature should not be (ab)used to implement protocol
7137 * features that could openly be shared across drivers. In particular,
7138 * it must never be required to use vendor commands to implement any
7139 * "normal" functionality that higher-level userspace like connection
7140 * managers etc. need.
7141 */
7142
7143struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
7144 enum nl80211_commands cmd,
7145 enum nl80211_attrs attr,
7146 int approxlen);
7147
7148struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
7149 struct wireless_dev *wdev,
7150 enum nl80211_commands cmd,
7151 enum nl80211_attrs attr,
7152 unsigned int portid,
7153 int vendor_event_idx,
7154 int approxlen, gfp_t gfp);
7155
7156void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
7157
7158/**
7159 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
7160 * @wiphy: the wiphy
7161 * @approxlen: an upper bound of the length of the data that will
7162 * be put into the skb
7163 *
7164 * This function allocates and pre-fills an skb for a reply to
7165 * a vendor command. Since it is intended for a reply, calling
7166 * it outside of a vendor command's doit() operation is invalid.
7167 *
7168 * The returned skb is pre-filled with some identifying data in
7169 * a way that any data that is put into the skb (with skb_put(),
7170 * nla_put() or similar) will end up being within the
7171 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
7172 * with the skb is adding data for the corresponding userspace tool
7173 * which can then read that data out of the vendor data attribute.
7174 * You must not modify the skb in any other way.
7175 *
7176 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
7177 * its error code as the result of the doit() operation.
7178 *
7179 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7180 */
7181static inline struct sk_buff *
7182cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
7183{
7184 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
7185 NL80211_ATTR_VENDOR_DATA, approxlen);
7186}
7187
7188/**
7189 * cfg80211_vendor_cmd_reply - send the reply skb
7190 * @skb: The skb, must have been allocated with
7191 * cfg80211_vendor_cmd_alloc_reply_skb()
7192 *
7193 * Since calling this function will usually be the last thing
7194 * before returning from the vendor command doit() you should
7195 * return the error code. Note that this function consumes the
7196 * skb regardless of the return value.
7197 *
7198 * Return: An error code or 0 on success.
7199 */
7200int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
7201
7202/**
7203 * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
7204 * @wiphy: the wiphy
7205 *
7206 * Return the current netlink port ID in a vendor command handler.
7207 * Valid to call only there.
7208 */
7209unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
7210
7211/**
7212 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
7213 * @wiphy: the wiphy
7214 * @wdev: the wireless device
7215 * @event_idx: index of the vendor event in the wiphy's vendor_events
7216 * @approxlen: an upper bound of the length of the data that will
7217 * be put into the skb
7218 * @gfp: allocation flags
7219 *
7220 * This function allocates and pre-fills an skb for an event on the
7221 * vendor-specific multicast group.
7222 *
7223 * If wdev != NULL, both the ifindex and identifier of the specified
7224 * wireless device are added to the event message before the vendor data
7225 * attribute.
7226 *
7227 * When done filling the skb, call cfg80211_vendor_event() with the
7228 * skb to send the event.
7229 *
7230 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7231 */
7232static inline struct sk_buff *
7233cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
7234 int approxlen, int event_idx, gfp_t gfp)
7235{
7236 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
7237 NL80211_ATTR_VENDOR_DATA,
7238 0, event_idx, approxlen, gfp);
7239}
7240
7241/**
7242 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
7243 * @wiphy: the wiphy
7244 * @wdev: the wireless device
7245 * @event_idx: index of the vendor event in the wiphy's vendor_events
7246 * @portid: port ID of the receiver
7247 * @approxlen: an upper bound of the length of the data that will
7248 * be put into the skb
7249 * @gfp: allocation flags
7250 *
7251 * This function allocates and pre-fills an skb for an event to send to
7252 * a specific (userland) socket. This socket would previously have been
7253 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
7254 * care to register a netlink notifier to see when the socket closes.
7255 *
7256 * If wdev != NULL, both the ifindex and identifier of the specified
7257 * wireless device are added to the event message before the vendor data
7258 * attribute.
7259 *
7260 * When done filling the skb, call cfg80211_vendor_event() with the
7261 * skb to send the event.
7262 *
7263 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7264 */
7265static inline struct sk_buff *
7266cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
7267 struct wireless_dev *wdev,
7268 unsigned int portid, int approxlen,
7269 int event_idx, gfp_t gfp)
7270{
7271 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
7272 NL80211_ATTR_VENDOR_DATA,
7273 portid, event_idx, approxlen, gfp);
7274}
7275
7276/**
7277 * cfg80211_vendor_event - send the event
7278 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
7279 * @gfp: allocation flags
7280 *
7281 * This function sends the given @skb, which must have been allocated
7282 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
7283 */
7284static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
7285{
7286 __cfg80211_send_event_skb(skb, gfp);
7287}
7288
7289#ifdef CONFIG_NL80211_TESTMODE
7290/**
7291 * DOC: Test mode
7292 *
7293 * Test mode is a set of utility functions to allow drivers to
7294 * interact with driver-specific tools to aid, for instance,
7295 * factory programming.
7296 *
7297 * This chapter describes how drivers interact with it, for more
7298 * information see the nl80211 book's chapter on it.
7299 */
7300
7301/**
7302 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
7303 * @wiphy: the wiphy
7304 * @approxlen: an upper bound of the length of the data that will
7305 * be put into the skb
7306 *
7307 * This function allocates and pre-fills an skb for a reply to
7308 * the testmode command. Since it is intended for a reply, calling
7309 * it outside of the @testmode_cmd operation is invalid.
7310 *
7311 * The returned skb is pre-filled with the wiphy index and set up in
7312 * a way that any data that is put into the skb (with skb_put(),
7313 * nla_put() or similar) will end up being within the
7314 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
7315 * with the skb is adding data for the corresponding userspace tool
7316 * which can then read that data out of the testdata attribute. You
7317 * must not modify the skb in any other way.
7318 *
7319 * When done, call cfg80211_testmode_reply() with the skb and return
7320 * its error code as the result of the @testmode_cmd operation.
7321 *
7322 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7323 */
7324static inline struct sk_buff *
7325cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
7326{
7327 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
7328 NL80211_ATTR_TESTDATA, approxlen);
7329}
7330
7331/**
7332 * cfg80211_testmode_reply - send the reply skb
7333 * @skb: The skb, must have been allocated with
7334 * cfg80211_testmode_alloc_reply_skb()
7335 *
7336 * Since calling this function will usually be the last thing
7337 * before returning from the @testmode_cmd you should return
7338 * the error code. Note that this function consumes the skb
7339 * regardless of the return value.
7340 *
7341 * Return: An error code or 0 on success.
7342 */
7343static inline int cfg80211_testmode_reply(struct sk_buff *skb)
7344{
7345 return cfg80211_vendor_cmd_reply(skb);
7346}
7347
7348/**
7349 * cfg80211_testmode_alloc_event_skb - allocate testmode event
7350 * @wiphy: the wiphy
7351 * @approxlen: an upper bound of the length of the data that will
7352 * be put into the skb
7353 * @gfp: allocation flags
7354 *
7355 * This function allocates and pre-fills an skb for an event on the
7356 * testmode multicast group.
7357 *
7358 * The returned skb is set up in the same way as with
7359 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
7360 * there, you should simply add data to it that will then end up in the
7361 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
7362 * in any other way.
7363 *
7364 * When done filling the skb, call cfg80211_testmode_event() with the
7365 * skb to send the event.
7366 *
7367 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7368 */
7369static inline struct sk_buff *
7370cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
7371{
7372 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
7373 NL80211_ATTR_TESTDATA, 0, -1,
7374 approxlen, gfp);
7375}
7376
7377/**
7378 * cfg80211_testmode_event - send the event
7379 * @skb: The skb, must have been allocated with
7380 * cfg80211_testmode_alloc_event_skb()
7381 * @gfp: allocation flags
7382 *
7383 * This function sends the given @skb, which must have been allocated
7384 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
7385 * consumes it.
7386 */
7387static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
7388{
7389 __cfg80211_send_event_skb(skb, gfp);
7390}
7391
7392#define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
7393#define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
7394#else
7395#define CFG80211_TESTMODE_CMD(cmd)
7396#define CFG80211_TESTMODE_DUMP(cmd)
7397#endif
7398
7399/**
7400 * struct cfg80211_fils_resp_params - FILS connection response params
7401 * @kek: KEK derived from a successful FILS connection (may be %NULL)
7402 * @kek_len: Length of @fils_kek in octets
7403 * @update_erp_next_seq_num: Boolean value to specify whether the value in
7404 * @erp_next_seq_num is valid.
7405 * @erp_next_seq_num: The next sequence number to use in ERP message in
7406 * FILS Authentication. This value should be specified irrespective of the
7407 * status for a FILS connection.
7408 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
7409 * @pmk_len: Length of @pmk in octets
7410 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
7411 * used for this FILS connection (may be %NULL).
7412 */
7413struct cfg80211_fils_resp_params {
7414 const u8 *kek;
7415 size_t kek_len;
7416 bool update_erp_next_seq_num;
7417 u16 erp_next_seq_num;
7418 const u8 *pmk;
7419 size_t pmk_len;
7420 const u8 *pmkid;
7421};
7422
7423/**
7424 * struct cfg80211_connect_resp_params - Connection response params
7425 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
7426 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7427 * the real status code for failures. If this call is used to report a
7428 * failure due to a timeout (e.g., not receiving an Authentication frame
7429 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7430 * indicate that this is a failure, but without a status code.
7431 * @timeout_reason is used to report the reason for the timeout in that
7432 * case.
7433 * @req_ie: Association request IEs (may be %NULL)
7434 * @req_ie_len: Association request IEs length
7435 * @resp_ie: Association response IEs (may be %NULL)
7436 * @resp_ie_len: Association response IEs length
7437 * @fils: FILS connection response parameters.
7438 * @timeout_reason: Reason for connection timeout. This is used when the
7439 * connection fails due to a timeout instead of an explicit rejection from
7440 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7441 * not known. This value is used only if @status < 0 to indicate that the
7442 * failure is due to a timeout and not due to explicit rejection by the AP.
7443 * This value is ignored in other cases (@status >= 0).
7444 * @valid_links: For MLO connection, BIT mask of the valid link ids. Otherwise
7445 * zero.
7446 * @ap_mld_addr: For MLO connection, MLD address of the AP. Otherwise %NULL.
7447 * @links : For MLO connection, contains link info for the valid links indicated
7448 * using @valid_links. For non-MLO connection, links[0] contains the
7449 * connected AP info.
7450 * @links.addr: For MLO connection, MAC address of the STA link. Otherwise
7451 * %NULL.
7452 * @links.bssid: For MLO connection, MAC address of the AP link. For non-MLO
7453 * connection, links[0].bssid points to the BSSID of the AP (may be %NULL).
7454 * @links.bss: For MLO connection, entry of bss to which STA link is connected.
7455 * For non-MLO connection, links[0].bss points to entry of bss to which STA
7456 * is connected. It can be obtained through cfg80211_get_bss() (may be
7457 * %NULL). It is recommended to store the bss from the connect_request and
7458 * hold a reference to it and return through this param to avoid a warning
7459 * if the bss is expired during the connection, esp. for those drivers
7460 * implementing connect op. Only one parameter among @bssid and @bss needs
7461 * to be specified.
7462 * @links.status: per-link status code, to report a status code that's not
7463 * %WLAN_STATUS_SUCCESS for a given link, it must also be in the
7464 * @valid_links bitmap and may have a BSS pointer (which is then released)
7465 */
7466struct cfg80211_connect_resp_params {
7467 int status;
7468 const u8 *req_ie;
7469 size_t req_ie_len;
7470 const u8 *resp_ie;
7471 size_t resp_ie_len;
7472 struct cfg80211_fils_resp_params fils;
7473 enum nl80211_timeout_reason timeout_reason;
7474
7475 const u8 *ap_mld_addr;
7476 u16 valid_links;
7477 struct {
7478 const u8 *addr;
7479 const u8 *bssid;
7480 struct cfg80211_bss *bss;
7481 u16 status;
7482 } links[IEEE80211_MLD_MAX_NUM_LINKS];
7483};
7484
7485/**
7486 * cfg80211_connect_done - notify cfg80211 of connection result
7487 *
7488 * @dev: network device
7489 * @params: connection response parameters
7490 * @gfp: allocation flags
7491 *
7492 * It should be called by the underlying driver once execution of the connection
7493 * request from connect() has been completed. This is similar to
7494 * cfg80211_connect_bss(), but takes a structure pointer for connection response
7495 * parameters. Only one of the functions among cfg80211_connect_bss(),
7496 * cfg80211_connect_result(), cfg80211_connect_timeout(),
7497 * and cfg80211_connect_done() should be called.
7498 */
7499void cfg80211_connect_done(struct net_device *dev,
7500 struct cfg80211_connect_resp_params *params,
7501 gfp_t gfp);
7502
7503/**
7504 * cfg80211_connect_bss - notify cfg80211 of connection result
7505 *
7506 * @dev: network device
7507 * @bssid: the BSSID of the AP
7508 * @bss: Entry of bss to which STA got connected to, can be obtained through
7509 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7510 * bss from the connect_request and hold a reference to it and return
7511 * through this param to avoid a warning if the bss is expired during the
7512 * connection, esp. for those drivers implementing connect op.
7513 * Only one parameter among @bssid and @bss needs to be specified.
7514 * @req_ie: association request IEs (maybe be %NULL)
7515 * @req_ie_len: association request IEs length
7516 * @resp_ie: association response IEs (may be %NULL)
7517 * @resp_ie_len: assoc response IEs length
7518 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7519 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7520 * the real status code for failures. If this call is used to report a
7521 * failure due to a timeout (e.g., not receiving an Authentication frame
7522 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7523 * indicate that this is a failure, but without a status code.
7524 * @timeout_reason is used to report the reason for the timeout in that
7525 * case.
7526 * @gfp: allocation flags
7527 * @timeout_reason: reason for connection timeout. This is used when the
7528 * connection fails due to a timeout instead of an explicit rejection from
7529 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7530 * not known. This value is used only if @status < 0 to indicate that the
7531 * failure is due to a timeout and not due to explicit rejection by the AP.
7532 * This value is ignored in other cases (@status >= 0).
7533 *
7534 * It should be called by the underlying driver once execution of the connection
7535 * request from connect() has been completed. This is similar to
7536 * cfg80211_connect_result(), but with the option of identifying the exact bss
7537 * entry for the connection. Only one of the functions among
7538 * cfg80211_connect_bss(), cfg80211_connect_result(),
7539 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7540 */
7541static inline void
7542cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
7543 struct cfg80211_bss *bss, const u8 *req_ie,
7544 size_t req_ie_len, const u8 *resp_ie,
7545 size_t resp_ie_len, int status, gfp_t gfp,
7546 enum nl80211_timeout_reason timeout_reason)
7547{
7548 struct cfg80211_connect_resp_params params;
7549
7550 memset(¶ms, 0, sizeof(params));
7551 params.status = status;
7552 params.links[0].bssid = bssid;
7553 params.links[0].bss = bss;
7554 params.req_ie = req_ie;
7555 params.req_ie_len = req_ie_len;
7556 params.resp_ie = resp_ie;
7557 params.resp_ie_len = resp_ie_len;
7558 params.timeout_reason = timeout_reason;
7559
7560 cfg80211_connect_done(dev, ¶ms, gfp);
7561}
7562
7563/**
7564 * cfg80211_connect_result - notify cfg80211 of connection result
7565 *
7566 * @dev: network device
7567 * @bssid: the BSSID of the AP
7568 * @req_ie: association request IEs (maybe be %NULL)
7569 * @req_ie_len: association request IEs length
7570 * @resp_ie: association response IEs (may be %NULL)
7571 * @resp_ie_len: assoc response IEs length
7572 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7573 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7574 * the real status code for failures.
7575 * @gfp: allocation flags
7576 *
7577 * It should be called by the underlying driver once execution of the connection
7578 * request from connect() has been completed. This is similar to
7579 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
7580 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
7581 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7582 */
7583static inline void
7584cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
7585 const u8 *req_ie, size_t req_ie_len,
7586 const u8 *resp_ie, size_t resp_ie_len,
7587 u16 status, gfp_t gfp)
7588{
7589 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
7590 resp_ie_len, status, gfp,
7591 NL80211_TIMEOUT_UNSPECIFIED);
7592}
7593
7594/**
7595 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
7596 *
7597 * @dev: network device
7598 * @bssid: the BSSID of the AP
7599 * @req_ie: association request IEs (maybe be %NULL)
7600 * @req_ie_len: association request IEs length
7601 * @gfp: allocation flags
7602 * @timeout_reason: reason for connection timeout.
7603 *
7604 * It should be called by the underlying driver whenever connect() has failed
7605 * in a sequence where no explicit authentication/association rejection was
7606 * received from the AP. This could happen, e.g., due to not being able to send
7607 * out the Authentication or Association Request frame or timing out while
7608 * waiting for the response. Only one of the functions among
7609 * cfg80211_connect_bss(), cfg80211_connect_result(),
7610 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7611 */
7612static inline void
7613cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
7614 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
7615 enum nl80211_timeout_reason timeout_reason)
7616{
7617 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
7618 gfp, timeout_reason);
7619}
7620
7621/**
7622 * struct cfg80211_roam_info - driver initiated roaming information
7623 *
7624 * @req_ie: association request IEs (maybe be %NULL)
7625 * @req_ie_len: association request IEs length
7626 * @resp_ie: association response IEs (may be %NULL)
7627 * @resp_ie_len: assoc response IEs length
7628 * @fils: FILS related roaming information.
7629 * @valid_links: For MLO roaming, BIT mask of the new valid links is set.
7630 * Otherwise zero.
7631 * @ap_mld_addr: For MLO roaming, MLD address of the new AP. Otherwise %NULL.
7632 * @links : For MLO roaming, contains new link info for the valid links set in
7633 * @valid_links. For non-MLO roaming, links[0] contains the new AP info.
7634 * @links.addr: For MLO roaming, MAC address of the STA link. Otherwise %NULL.
7635 * @links.bssid: For MLO roaming, MAC address of the new AP link. For non-MLO
7636 * roaming, links[0].bssid points to the BSSID of the new AP. May be
7637 * %NULL if %links.bss is set.
7638 * @links.channel: the channel of the new AP.
7639 * @links.bss: For MLO roaming, entry of new bss to which STA link got
7640 * roamed. For non-MLO roaming, links[0].bss points to entry of bss to
7641 * which STA got roamed (may be %NULL if %links.bssid is set)
7642 */
7643struct cfg80211_roam_info {
7644 const u8 *req_ie;
7645 size_t req_ie_len;
7646 const u8 *resp_ie;
7647 size_t resp_ie_len;
7648 struct cfg80211_fils_resp_params fils;
7649
7650 const u8 *ap_mld_addr;
7651 u16 valid_links;
7652 struct {
7653 const u8 *addr;
7654 const u8 *bssid;
7655 struct ieee80211_channel *channel;
7656 struct cfg80211_bss *bss;
7657 } links[IEEE80211_MLD_MAX_NUM_LINKS];
7658};
7659
7660/**
7661 * cfg80211_roamed - notify cfg80211 of roaming
7662 *
7663 * @dev: network device
7664 * @info: information about the new BSS. struct &cfg80211_roam_info.
7665 * @gfp: allocation flags
7666 *
7667 * This function may be called with the driver passing either the BSSID of the
7668 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7669 * It should be called by the underlying driver whenever it roamed from one AP
7670 * to another while connected. Drivers which have roaming implemented in
7671 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7672 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7673 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7674 * rdev->event_work. In case of any failures, the reference is released
7675 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7676 * released while disconnecting from the current bss.
7677 */
7678void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7679 gfp_t gfp);
7680
7681/**
7682 * cfg80211_port_authorized - notify cfg80211 of successful security association
7683 *
7684 * @dev: network device
7685 * @bssid: the BSSID of the AP
7686 * @td_bitmap: transition disable policy
7687 * @td_bitmap_len: Length of transition disable policy
7688 * @gfp: allocation flags
7689 *
7690 * This function should be called by a driver that supports 4 way handshake
7691 * offload after a security association was successfully established (i.e.,
7692 * the 4 way handshake was completed successfully). The call to this function
7693 * should be preceded with a call to cfg80211_connect_result(),
7694 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7695 * indicate the 802.11 association.
7696 */
7697void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7698 const u8* td_bitmap, u8 td_bitmap_len, gfp_t gfp);
7699
7700/**
7701 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7702 *
7703 * @dev: network device
7704 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7705 * @ie_len: length of IEs
7706 * @reason: reason code for the disconnection, set it to 0 if unknown
7707 * @locally_generated: disconnection was requested locally
7708 * @gfp: allocation flags
7709 *
7710 * After it calls this function, the driver should enter an idle state
7711 * and not try to connect to any AP any more.
7712 */
7713void cfg80211_disconnected(struct net_device *dev, u16 reason,
7714 const u8 *ie, size_t ie_len,
7715 bool locally_generated, gfp_t gfp);
7716
7717/**
7718 * cfg80211_ready_on_channel - notification of remain_on_channel start
7719 * @wdev: wireless device
7720 * @cookie: the request cookie
7721 * @chan: The current channel (from remain_on_channel request)
7722 * @duration: Duration in milliseconds that the driver intents to remain on the
7723 * channel
7724 * @gfp: allocation flags
7725 */
7726void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7727 struct ieee80211_channel *chan,
7728 unsigned int duration, gfp_t gfp);
7729
7730/**
7731 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7732 * @wdev: wireless device
7733 * @cookie: the request cookie
7734 * @chan: The current channel (from remain_on_channel request)
7735 * @gfp: allocation flags
7736 */
7737void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7738 struct ieee80211_channel *chan,
7739 gfp_t gfp);
7740
7741/**
7742 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7743 * @wdev: wireless device
7744 * @cookie: the requested cookie
7745 * @chan: The current channel (from tx_mgmt request)
7746 * @gfp: allocation flags
7747 */
7748void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7749 struct ieee80211_channel *chan, gfp_t gfp);
7750
7751/**
7752 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7753 *
7754 * @sinfo: the station information
7755 * @gfp: allocation flags
7756 */
7757int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7758
7759/**
7760 * cfg80211_sinfo_release_content - release contents of station info
7761 * @sinfo: the station information
7762 *
7763 * Releases any potentially allocated sub-information of the station
7764 * information, but not the struct itself (since it's typically on
7765 * the stack.)
7766 */
7767static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7768{
7769 kfree(sinfo->pertid);
7770}
7771
7772/**
7773 * cfg80211_new_sta - notify userspace about station
7774 *
7775 * @dev: the netdev
7776 * @mac_addr: the station's address
7777 * @sinfo: the station information
7778 * @gfp: allocation flags
7779 */
7780void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7781 struct station_info *sinfo, gfp_t gfp);
7782
7783/**
7784 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7785 * @dev: the netdev
7786 * @mac_addr: the station's address
7787 * @sinfo: the station information/statistics
7788 * @gfp: allocation flags
7789 */
7790void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7791 struct station_info *sinfo, gfp_t gfp);
7792
7793/**
7794 * cfg80211_del_sta - notify userspace about deletion of a station
7795 *
7796 * @dev: the netdev
7797 * @mac_addr: the station's address
7798 * @gfp: allocation flags
7799 */
7800static inline void cfg80211_del_sta(struct net_device *dev,
7801 const u8 *mac_addr, gfp_t gfp)
7802{
7803 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7804}
7805
7806/**
7807 * cfg80211_conn_failed - connection request failed notification
7808 *
7809 * @dev: the netdev
7810 * @mac_addr: the station's address
7811 * @reason: the reason for connection failure
7812 * @gfp: allocation flags
7813 *
7814 * Whenever a station tries to connect to an AP and if the station
7815 * could not connect to the AP as the AP has rejected the connection
7816 * for some reasons, this function is called.
7817 *
7818 * The reason for connection failure can be any of the value from
7819 * nl80211_connect_failed_reason enum
7820 */
7821void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7822 enum nl80211_connect_failed_reason reason,
7823 gfp_t gfp);
7824
7825/**
7826 * struct cfg80211_rx_info - received management frame info
7827 *
7828 * @freq: Frequency on which the frame was received in kHz
7829 * @sig_dbm: signal strength in dBm, or 0 if unknown
7830 * @have_link_id: indicates the frame was received on a link of
7831 * an MLD, i.e. the @link_id field is valid
7832 * @link_id: the ID of the link the frame was received on
7833 * @buf: Management frame (header + body)
7834 * @len: length of the frame data
7835 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7836 * @rx_tstamp: Hardware timestamp of frame RX in nanoseconds
7837 * @ack_tstamp: Hardware timestamp of ack TX in nanoseconds
7838 */
7839struct cfg80211_rx_info {
7840 int freq;
7841 int sig_dbm;
7842 bool have_link_id;
7843 u8 link_id;
7844 const u8 *buf;
7845 size_t len;
7846 u32 flags;
7847 u64 rx_tstamp;
7848 u64 ack_tstamp;
7849};
7850
7851/**
7852 * cfg80211_rx_mgmt_ext - management frame notification with extended info
7853 * @wdev: wireless device receiving the frame
7854 * @info: RX info as defined in struct cfg80211_rx_info
7855 *
7856 * This function is called whenever an Action frame is received for a station
7857 * mode interface, but is not processed in kernel.
7858 *
7859 * Return: %true if a user space application has registered for this frame.
7860 * For action frames, that makes it responsible for rejecting unrecognized
7861 * action frames; %false otherwise, in which case for action frames the
7862 * driver is responsible for rejecting the frame.
7863 */
7864bool cfg80211_rx_mgmt_ext(struct wireless_dev *wdev,
7865 struct cfg80211_rx_info *info);
7866
7867/**
7868 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7869 * @wdev: wireless device receiving the frame
7870 * @freq: Frequency on which the frame was received in KHz
7871 * @sig_dbm: signal strength in dBm, or 0 if unknown
7872 * @buf: Management frame (header + body)
7873 * @len: length of the frame data
7874 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7875 *
7876 * This function is called whenever an Action frame is received for a station
7877 * mode interface, but is not processed in kernel.
7878 *
7879 * Return: %true if a user space application has registered for this frame.
7880 * For action frames, that makes it responsible for rejecting unrecognized
7881 * action frames; %false otherwise, in which case for action frames the
7882 * driver is responsible for rejecting the frame.
7883 */
7884static inline bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq,
7885 int sig_dbm, const u8 *buf, size_t len,
7886 u32 flags)
7887{
7888 struct cfg80211_rx_info info = {
7889 .freq = freq,
7890 .sig_dbm = sig_dbm,
7891 .buf = buf,
7892 .len = len,
7893 .flags = flags
7894 };
7895
7896 return cfg80211_rx_mgmt_ext(wdev, &info);
7897}
7898
7899/**
7900 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7901 * @wdev: wireless device receiving the frame
7902 * @freq: Frequency on which the frame was received in MHz
7903 * @sig_dbm: signal strength in dBm, or 0 if unknown
7904 * @buf: Management frame (header + body)
7905 * @len: length of the frame data
7906 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7907 *
7908 * This function is called whenever an Action frame is received for a station
7909 * mode interface, but is not processed in kernel.
7910 *
7911 * Return: %true if a user space application has registered for this frame.
7912 * For action frames, that makes it responsible for rejecting unrecognized
7913 * action frames; %false otherwise, in which case for action frames the
7914 * driver is responsible for rejecting the frame.
7915 */
7916static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7917 int sig_dbm, const u8 *buf, size_t len,
7918 u32 flags)
7919{
7920 struct cfg80211_rx_info info = {
7921 .freq = MHZ_TO_KHZ(freq),
7922 .sig_dbm = sig_dbm,
7923 .buf = buf,
7924 .len = len,
7925 .flags = flags
7926 };
7927
7928 return cfg80211_rx_mgmt_ext(wdev, &info);
7929}
7930
7931/**
7932 * struct cfg80211_tx_status - TX status for management frame information
7933 *
7934 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7935 * @tx_tstamp: hardware TX timestamp in nanoseconds
7936 * @ack_tstamp: hardware ack RX timestamp in nanoseconds
7937 * @buf: Management frame (header + body)
7938 * @len: length of the frame data
7939 * @ack: Whether frame was acknowledged
7940 */
7941struct cfg80211_tx_status {
7942 u64 cookie;
7943 u64 tx_tstamp;
7944 u64 ack_tstamp;
7945 const u8 *buf;
7946 size_t len;
7947 bool ack;
7948};
7949
7950/**
7951 * cfg80211_mgmt_tx_status_ext - TX status notification with extended info
7952 * @wdev: wireless device receiving the frame
7953 * @status: TX status data
7954 * @gfp: context flags
7955 *
7956 * This function is called whenever a management frame was requested to be
7957 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7958 * transmission attempt with extended info.
7959 */
7960void cfg80211_mgmt_tx_status_ext(struct wireless_dev *wdev,
7961 struct cfg80211_tx_status *status, gfp_t gfp);
7962
7963/**
7964 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7965 * @wdev: wireless device receiving the frame
7966 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7967 * @buf: Management frame (header + body)
7968 * @len: length of the frame data
7969 * @ack: Whether frame was acknowledged
7970 * @gfp: context flags
7971 *
7972 * This function is called whenever a management frame was requested to be
7973 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7974 * transmission attempt.
7975 */
7976static inline void cfg80211_mgmt_tx_status(struct wireless_dev *wdev,
7977 u64 cookie, const u8 *buf,
7978 size_t len, bool ack, gfp_t gfp)
7979{
7980 struct cfg80211_tx_status status = {
7981 .cookie = cookie,
7982 .buf = buf,
7983 .len = len,
7984 .ack = ack
7985 };
7986
7987 cfg80211_mgmt_tx_status_ext(wdev, &status, gfp);
7988}
7989
7990/**
7991 * cfg80211_control_port_tx_status - notification of TX status for control
7992 * port frames
7993 * @wdev: wireless device receiving the frame
7994 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7995 * @buf: Data frame (header + body)
7996 * @len: length of the frame data
7997 * @ack: Whether frame was acknowledged
7998 * @gfp: context flags
7999 *
8000 * This function is called whenever a control port frame was requested to be
8001 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
8002 * the transmission attempt.
8003 */
8004void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
8005 const u8 *buf, size_t len, bool ack,
8006 gfp_t gfp);
8007
8008/**
8009 * cfg80211_rx_control_port - notification about a received control port frame
8010 * @dev: The device the frame matched to
8011 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
8012 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
8013 * This function does not take ownership of the skb, so the caller is
8014 * responsible for any cleanup. The caller must also ensure that
8015 * skb->protocol is set appropriately.
8016 * @unencrypted: Whether the frame was received unencrypted
8017 *
8018 * This function is used to inform userspace about a received control port
8019 * frame. It should only be used if userspace indicated it wants to receive
8020 * control port frames over nl80211.
8021 *
8022 * The frame is the data portion of the 802.3 or 802.11 data frame with all
8023 * network layer headers removed (e.g. the raw EAPoL frame).
8024 *
8025 * Return: %true if the frame was passed to userspace
8026 */
8027bool cfg80211_rx_control_port(struct net_device *dev,
8028 struct sk_buff *skb, bool unencrypted);
8029
8030/**
8031 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
8032 * @dev: network device
8033 * @rssi_event: the triggered RSSI event
8034 * @rssi_level: new RSSI level value or 0 if not available
8035 * @gfp: context flags
8036 *
8037 * This function is called when a configured connection quality monitoring
8038 * rssi threshold reached event occurs.
8039 */
8040void cfg80211_cqm_rssi_notify(struct net_device *dev,
8041 enum nl80211_cqm_rssi_threshold_event rssi_event,
8042 s32 rssi_level, gfp_t gfp);
8043
8044/**
8045 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
8046 * @dev: network device
8047 * @peer: peer's MAC address
8048 * @num_packets: how many packets were lost -- should be a fixed threshold
8049 * but probably no less than maybe 50, or maybe a throughput dependent
8050 * threshold (to account for temporary interference)
8051 * @gfp: context flags
8052 */
8053void cfg80211_cqm_pktloss_notify(struct net_device *dev,
8054 const u8 *peer, u32 num_packets, gfp_t gfp);
8055
8056/**
8057 * cfg80211_cqm_txe_notify - TX error rate event
8058 * @dev: network device
8059 * @peer: peer's MAC address
8060 * @num_packets: how many packets were lost
8061 * @rate: % of packets which failed transmission
8062 * @intvl: interval (in s) over which the TX failure threshold was breached.
8063 * @gfp: context flags
8064 *
8065 * Notify userspace when configured % TX failures over number of packets in a
8066 * given interval is exceeded.
8067 */
8068void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
8069 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
8070
8071/**
8072 * cfg80211_cqm_beacon_loss_notify - beacon loss event
8073 * @dev: network device
8074 * @gfp: context flags
8075 *
8076 * Notify userspace about beacon loss from the connected AP.
8077 */
8078void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
8079
8080/**
8081 * __cfg80211_radar_event - radar detection event
8082 * @wiphy: the wiphy
8083 * @chandef: chandef for the current channel
8084 * @offchan: the radar has been detected on the offchannel chain
8085 * @gfp: context flags
8086 *
8087 * This function is called when a radar is detected on the current chanenl.
8088 */
8089void __cfg80211_radar_event(struct wiphy *wiphy,
8090 struct cfg80211_chan_def *chandef,
8091 bool offchan, gfp_t gfp);
8092
8093static inline void
8094cfg80211_radar_event(struct wiphy *wiphy,
8095 struct cfg80211_chan_def *chandef,
8096 gfp_t gfp)
8097{
8098 __cfg80211_radar_event(wiphy, chandef, false, gfp);
8099}
8100
8101static inline void
8102cfg80211_background_radar_event(struct wiphy *wiphy,
8103 struct cfg80211_chan_def *chandef,
8104 gfp_t gfp)
8105{
8106 __cfg80211_radar_event(wiphy, chandef, true, gfp);
8107}
8108
8109/**
8110 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
8111 * @dev: network device
8112 * @mac: MAC address of a station which opmode got modified
8113 * @sta_opmode: station's current opmode value
8114 * @gfp: context flags
8115 *
8116 * Driver should call this function when station's opmode modified via action
8117 * frame.
8118 */
8119void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
8120 struct sta_opmode_info *sta_opmode,
8121 gfp_t gfp);
8122
8123/**
8124 * cfg80211_cac_event - Channel availability check (CAC) event
8125 * @netdev: network device
8126 * @chandef: chandef for the current channel
8127 * @event: type of event
8128 * @gfp: context flags
8129 *
8130 * This function is called when a Channel availability check (CAC) is finished
8131 * or aborted. This must be called to notify the completion of a CAC process,
8132 * also by full-MAC drivers.
8133 */
8134void cfg80211_cac_event(struct net_device *netdev,
8135 const struct cfg80211_chan_def *chandef,
8136 enum nl80211_radar_event event, gfp_t gfp);
8137
8138/**
8139 * cfg80211_background_cac_abort - Channel Availability Check offchan abort event
8140 * @wiphy: the wiphy
8141 *
8142 * This function is called by the driver when a Channel Availability Check
8143 * (CAC) is aborted by a offchannel dedicated chain.
8144 */
8145void cfg80211_background_cac_abort(struct wiphy *wiphy);
8146
8147/**
8148 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
8149 * @dev: network device
8150 * @bssid: BSSID of AP (to avoid races)
8151 * @replay_ctr: new replay counter
8152 * @gfp: allocation flags
8153 */
8154void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
8155 const u8 *replay_ctr, gfp_t gfp);
8156
8157/**
8158 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
8159 * @dev: network device
8160 * @index: candidate index (the smaller the index, the higher the priority)
8161 * @bssid: BSSID of AP
8162 * @preauth: Whether AP advertises support for RSN pre-authentication
8163 * @gfp: allocation flags
8164 */
8165void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
8166 const u8 *bssid, bool preauth, gfp_t gfp);
8167
8168/**
8169 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
8170 * @dev: The device the frame matched to
8171 * @addr: the transmitter address
8172 * @gfp: context flags
8173 *
8174 * This function is used in AP mode (only!) to inform userspace that
8175 * a spurious class 3 frame was received, to be able to deauth the
8176 * sender.
8177 * Return: %true if the frame was passed to userspace (or this failed
8178 * for a reason other than not having a subscription.)
8179 */
8180bool cfg80211_rx_spurious_frame(struct net_device *dev,
8181 const u8 *addr, gfp_t gfp);
8182
8183/**
8184 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
8185 * @dev: The device the frame matched to
8186 * @addr: the transmitter address
8187 * @gfp: context flags
8188 *
8189 * This function is used in AP mode (only!) to inform userspace that
8190 * an associated station sent a 4addr frame but that wasn't expected.
8191 * It is allowed and desirable to send this event only once for each
8192 * station to avoid event flooding.
8193 * Return: %true if the frame was passed to userspace (or this failed
8194 * for a reason other than not having a subscription.)
8195 */
8196bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
8197 const u8 *addr, gfp_t gfp);
8198
8199/**
8200 * cfg80211_probe_status - notify userspace about probe status
8201 * @dev: the device the probe was sent on
8202 * @addr: the address of the peer
8203 * @cookie: the cookie filled in @probe_client previously
8204 * @acked: indicates whether probe was acked or not
8205 * @ack_signal: signal strength (in dBm) of the ACK frame.
8206 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
8207 * @gfp: allocation flags
8208 */
8209void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
8210 u64 cookie, bool acked, s32 ack_signal,
8211 bool is_valid_ack_signal, gfp_t gfp);
8212
8213/**
8214 * cfg80211_report_obss_beacon_khz - report beacon from other APs
8215 * @wiphy: The wiphy that received the beacon
8216 * @frame: the frame
8217 * @len: length of the frame
8218 * @freq: frequency the frame was received on in KHz
8219 * @sig_dbm: signal strength in dBm, or 0 if unknown
8220 *
8221 * Use this function to report to userspace when a beacon was
8222 * received. It is not useful to call this when there is no
8223 * netdev that is in AP/GO mode.
8224 */
8225void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
8226 size_t len, int freq, int sig_dbm);
8227
8228/**
8229 * cfg80211_report_obss_beacon - report beacon from other APs
8230 * @wiphy: The wiphy that received the beacon
8231 * @frame: the frame
8232 * @len: length of the frame
8233 * @freq: frequency the frame was received on
8234 * @sig_dbm: signal strength in dBm, or 0 if unknown
8235 *
8236 * Use this function to report to userspace when a beacon was
8237 * received. It is not useful to call this when there is no
8238 * netdev that is in AP/GO mode.
8239 */
8240static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
8241 const u8 *frame, size_t len,
8242 int freq, int sig_dbm)
8243{
8244 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
8245 sig_dbm);
8246}
8247
8248/**
8249 * cfg80211_reg_can_beacon - check if beaconing is allowed
8250 * @wiphy: the wiphy
8251 * @chandef: the channel definition
8252 * @iftype: interface type
8253 *
8254 * Return: %true if there is no secondary channel or the secondary channel(s)
8255 * can be used for beaconing (i.e. is not a radar channel etc.)
8256 */
8257bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
8258 struct cfg80211_chan_def *chandef,
8259 enum nl80211_iftype iftype);
8260
8261/**
8262 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
8263 * @wiphy: the wiphy
8264 * @chandef: the channel definition
8265 * @iftype: interface type
8266 *
8267 * Return: %true if there is no secondary channel or the secondary channel(s)
8268 * can be used for beaconing (i.e. is not a radar channel etc.). This version
8269 * also checks if IR-relaxation conditions apply, to allow beaconing under
8270 * more permissive conditions.
8271 *
8272 * Requires the wiphy mutex to be held.
8273 */
8274bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
8275 struct cfg80211_chan_def *chandef,
8276 enum nl80211_iftype iftype);
8277
8278/*
8279 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
8280 * @dev: the device which switched channels
8281 * @chandef: the new channel definition
8282 * @link_id: the link ID for MLO, must be 0 for non-MLO
8283 *
8284 * Caller must acquire wdev_lock, therefore must only be called from sleepable
8285 * driver context!
8286 */
8287void cfg80211_ch_switch_notify(struct net_device *dev,
8288 struct cfg80211_chan_def *chandef,
8289 unsigned int link_id);
8290
8291/*
8292 * cfg80211_ch_switch_started_notify - notify channel switch start
8293 * @dev: the device on which the channel switch started
8294 * @chandef: the future channel definition
8295 * @link_id: the link ID for MLO, must be 0 for non-MLO
8296 * @count: the number of TBTTs until the channel switch happens
8297 * @quiet: whether or not immediate quiet was requested by the AP
8298 *
8299 * Inform the userspace about the channel switch that has just
8300 * started, so that it can take appropriate actions (eg. starting
8301 * channel switch on other vifs), if necessary.
8302 */
8303void cfg80211_ch_switch_started_notify(struct net_device *dev,
8304 struct cfg80211_chan_def *chandef,
8305 unsigned int link_id, u8 count,
8306 bool quiet);
8307
8308/**
8309 * ieee80211_operating_class_to_band - convert operating class to band
8310 *
8311 * @operating_class: the operating class to convert
8312 * @band: band pointer to fill
8313 *
8314 * Returns %true if the conversion was successful, %false otherwise.
8315 */
8316bool ieee80211_operating_class_to_band(u8 operating_class,
8317 enum nl80211_band *band);
8318
8319/**
8320 * ieee80211_chandef_to_operating_class - convert chandef to operation class
8321 *
8322 * @chandef: the chandef to convert
8323 * @op_class: a pointer to the resulting operating class
8324 *
8325 * Returns %true if the conversion was successful, %false otherwise.
8326 */
8327bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
8328 u8 *op_class);
8329
8330/**
8331 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
8332 *
8333 * @chandef: the chandef to convert
8334 *
8335 * Returns the center frequency of chandef (1st segment) in KHz.
8336 */
8337static inline u32
8338ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
8339{
8340 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
8341}
8342
8343/*
8344 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
8345 * @dev: the device on which the operation is requested
8346 * @peer: the MAC address of the peer device
8347 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
8348 * NL80211_TDLS_TEARDOWN)
8349 * @reason_code: the reason code for teardown request
8350 * @gfp: allocation flags
8351 *
8352 * This function is used to request userspace to perform TDLS operation that
8353 * requires knowledge of keys, i.e., link setup or teardown when the AP
8354 * connection uses encryption. This is optional mechanism for the driver to use
8355 * if it can automatically determine when a TDLS link could be useful (e.g.,
8356 * based on traffic and signal strength for a peer).
8357 */
8358void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
8359 enum nl80211_tdls_operation oper,
8360 u16 reason_code, gfp_t gfp);
8361
8362/*
8363 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
8364 * @rate: given rate_info to calculate bitrate from
8365 *
8366 * return 0 if MCS index >= 32
8367 */
8368u32 cfg80211_calculate_bitrate(struct rate_info *rate);
8369
8370/**
8371 * cfg80211_unregister_wdev - remove the given wdev
8372 * @wdev: struct wireless_dev to remove
8373 *
8374 * This function removes the device so it can no longer be used. It is necessary
8375 * to call this function even when cfg80211 requests the removal of the device
8376 * by calling the del_virtual_intf() callback. The function must also be called
8377 * when the driver wishes to unregister the wdev, e.g. when the hardware device
8378 * is unbound from the driver.
8379 *
8380 * Requires the RTNL and wiphy mutex to be held.
8381 */
8382void cfg80211_unregister_wdev(struct wireless_dev *wdev);
8383
8384/**
8385 * cfg80211_register_netdevice - register the given netdev
8386 * @dev: the netdev to register
8387 *
8388 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
8389 * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
8390 * held. Otherwise, both register_netdevice() and register_netdev() are usable
8391 * instead as well.
8392 *
8393 * Requires the RTNL and wiphy mutex to be held.
8394 */
8395int cfg80211_register_netdevice(struct net_device *dev);
8396
8397/**
8398 * cfg80211_unregister_netdevice - unregister the given netdev
8399 * @dev: the netdev to register
8400 *
8401 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
8402 * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
8403 * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
8404 * usable instead as well.
8405 *
8406 * Requires the RTNL and wiphy mutex to be held.
8407 */
8408static inline void cfg80211_unregister_netdevice(struct net_device *dev)
8409{
8410#if IS_ENABLED(CONFIG_CFG80211)
8411 cfg80211_unregister_wdev(dev->ieee80211_ptr);
8412#endif
8413}
8414
8415/**
8416 * struct cfg80211_ft_event_params - FT Information Elements
8417 * @ies: FT IEs
8418 * @ies_len: length of the FT IE in bytes
8419 * @target_ap: target AP's MAC address
8420 * @ric_ies: RIC IE
8421 * @ric_ies_len: length of the RIC IE in bytes
8422 */
8423struct cfg80211_ft_event_params {
8424 const u8 *ies;
8425 size_t ies_len;
8426 const u8 *target_ap;
8427 const u8 *ric_ies;
8428 size_t ric_ies_len;
8429};
8430
8431/**
8432 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
8433 * @netdev: network device
8434 * @ft_event: IE information
8435 */
8436void cfg80211_ft_event(struct net_device *netdev,
8437 struct cfg80211_ft_event_params *ft_event);
8438
8439/**
8440 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
8441 * @ies: the input IE buffer
8442 * @len: the input length
8443 * @attr: the attribute ID to find
8444 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
8445 * if the function is only called to get the needed buffer size
8446 * @bufsize: size of the output buffer
8447 *
8448 * The function finds a given P2P attribute in the (vendor) IEs and
8449 * copies its contents to the given buffer.
8450 *
8451 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
8452 * malformed or the attribute can't be found (respectively), or the
8453 * length of the found attribute (which can be zero).
8454 */
8455int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
8456 enum ieee80211_p2p_attr_id attr,
8457 u8 *buf, unsigned int bufsize);
8458
8459/**
8460 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
8461 * @ies: the IE buffer
8462 * @ielen: the length of the IE buffer
8463 * @ids: an array with element IDs that are allowed before
8464 * the split. A WLAN_EID_EXTENSION value means that the next
8465 * EID in the list is a sub-element of the EXTENSION IE.
8466 * @n_ids: the size of the element ID array
8467 * @after_ric: array IE types that come after the RIC element
8468 * @n_after_ric: size of the @after_ric array
8469 * @offset: offset where to start splitting in the buffer
8470 *
8471 * This function splits an IE buffer by updating the @offset
8472 * variable to point to the location where the buffer should be
8473 * split.
8474 *
8475 * It assumes that the given IE buffer is well-formed, this
8476 * has to be guaranteed by the caller!
8477 *
8478 * It also assumes that the IEs in the buffer are ordered
8479 * correctly, if not the result of using this function will not
8480 * be ordered correctly either, i.e. it does no reordering.
8481 *
8482 * The function returns the offset where the next part of the
8483 * buffer starts, which may be @ielen if the entire (remainder)
8484 * of the buffer should be used.
8485 */
8486size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
8487 const u8 *ids, int n_ids,
8488 const u8 *after_ric, int n_after_ric,
8489 size_t offset);
8490
8491/**
8492 * ieee80211_ie_split - split an IE buffer according to ordering
8493 * @ies: the IE buffer
8494 * @ielen: the length of the IE buffer
8495 * @ids: an array with element IDs that are allowed before
8496 * the split. A WLAN_EID_EXTENSION value means that the next
8497 * EID in the list is a sub-element of the EXTENSION IE.
8498 * @n_ids: the size of the element ID array
8499 * @offset: offset where to start splitting in the buffer
8500 *
8501 * This function splits an IE buffer by updating the @offset
8502 * variable to point to the location where the buffer should be
8503 * split.
8504 *
8505 * It assumes that the given IE buffer is well-formed, this
8506 * has to be guaranteed by the caller!
8507 *
8508 * It also assumes that the IEs in the buffer are ordered
8509 * correctly, if not the result of using this function will not
8510 * be ordered correctly either, i.e. it does no reordering.
8511 *
8512 * The function returns the offset where the next part of the
8513 * buffer starts, which may be @ielen if the entire (remainder)
8514 * of the buffer should be used.
8515 */
8516static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
8517 const u8 *ids, int n_ids, size_t offset)
8518{
8519 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
8520}
8521
8522/**
8523 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
8524 * @wdev: the wireless device reporting the wakeup
8525 * @wakeup: the wakeup report
8526 * @gfp: allocation flags
8527 *
8528 * This function reports that the given device woke up. If it
8529 * caused the wakeup, report the reason(s), otherwise you may
8530 * pass %NULL as the @wakeup parameter to advertise that something
8531 * else caused the wakeup.
8532 */
8533void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
8534 struct cfg80211_wowlan_wakeup *wakeup,
8535 gfp_t gfp);
8536
8537/**
8538 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
8539 *
8540 * @wdev: the wireless device for which critical protocol is stopped.
8541 * @gfp: allocation flags
8542 *
8543 * This function can be called by the driver to indicate it has reverted
8544 * operation back to normal. One reason could be that the duration given
8545 * by .crit_proto_start() has expired.
8546 */
8547void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
8548
8549/**
8550 * ieee80211_get_num_supported_channels - get number of channels device has
8551 * @wiphy: the wiphy
8552 *
8553 * Return: the number of channels supported by the device.
8554 */
8555unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
8556
8557/**
8558 * cfg80211_check_combinations - check interface combinations
8559 *
8560 * @wiphy: the wiphy
8561 * @params: the interface combinations parameter
8562 *
8563 * This function can be called by the driver to check whether a
8564 * combination of interfaces and their types are allowed according to
8565 * the interface combinations.
8566 */
8567int cfg80211_check_combinations(struct wiphy *wiphy,
8568 struct iface_combination_params *params);
8569
8570/**
8571 * cfg80211_iter_combinations - iterate over matching combinations
8572 *
8573 * @wiphy: the wiphy
8574 * @params: the interface combinations parameter
8575 * @iter: function to call for each matching combination
8576 * @data: pointer to pass to iter function
8577 *
8578 * This function can be called by the driver to check what possible
8579 * combinations it fits in at a given moment, e.g. for channel switching
8580 * purposes.
8581 */
8582int cfg80211_iter_combinations(struct wiphy *wiphy,
8583 struct iface_combination_params *params,
8584 void (*iter)(const struct ieee80211_iface_combination *c,
8585 void *data),
8586 void *data);
8587
8588/*
8589 * cfg80211_stop_iface - trigger interface disconnection
8590 *
8591 * @wiphy: the wiphy
8592 * @wdev: wireless device
8593 * @gfp: context flags
8594 *
8595 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
8596 * disconnected.
8597 *
8598 * Note: This doesn't need any locks and is asynchronous.
8599 */
8600void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
8601 gfp_t gfp);
8602
8603/**
8604 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
8605 * @wiphy: the wiphy to shut down
8606 *
8607 * This function shuts down all interfaces belonging to this wiphy by
8608 * calling dev_close() (and treating non-netdev interfaces as needed).
8609 * It shouldn't really be used unless there are some fatal device errors
8610 * that really can't be recovered in any other way.
8611 *
8612 * Callers must hold the RTNL and be able to deal with callbacks into
8613 * the driver while the function is running.
8614 */
8615void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
8616
8617/**
8618 * wiphy_ext_feature_set - set the extended feature flag
8619 *
8620 * @wiphy: the wiphy to modify.
8621 * @ftidx: extended feature bit index.
8622 *
8623 * The extended features are flagged in multiple bytes (see
8624 * &struct wiphy.@ext_features)
8625 */
8626static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
8627 enum nl80211_ext_feature_index ftidx)
8628{
8629 u8 *ft_byte;
8630
8631 ft_byte = &wiphy->ext_features[ftidx / 8];
8632 *ft_byte |= BIT(ftidx % 8);
8633}
8634
8635/**
8636 * wiphy_ext_feature_isset - check the extended feature flag
8637 *
8638 * @wiphy: the wiphy to modify.
8639 * @ftidx: extended feature bit index.
8640 *
8641 * The extended features are flagged in multiple bytes (see
8642 * &struct wiphy.@ext_features)
8643 */
8644static inline bool
8645wiphy_ext_feature_isset(struct wiphy *wiphy,
8646 enum nl80211_ext_feature_index ftidx)
8647{
8648 u8 ft_byte;
8649
8650 ft_byte = wiphy->ext_features[ftidx / 8];
8651 return (ft_byte & BIT(ftidx % 8)) != 0;
8652}
8653
8654/**
8655 * cfg80211_free_nan_func - free NAN function
8656 * @f: NAN function that should be freed
8657 *
8658 * Frees all the NAN function and all it's allocated members.
8659 */
8660void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
8661
8662/**
8663 * struct cfg80211_nan_match_params - NAN match parameters
8664 * @type: the type of the function that triggered a match. If it is
8665 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
8666 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
8667 * result.
8668 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
8669 * @inst_id: the local instance id
8670 * @peer_inst_id: the instance id of the peer's function
8671 * @addr: the MAC address of the peer
8672 * @info_len: the length of the &info
8673 * @info: the Service Specific Info from the peer (if any)
8674 * @cookie: unique identifier of the corresponding function
8675 */
8676struct cfg80211_nan_match_params {
8677 enum nl80211_nan_function_type type;
8678 u8 inst_id;
8679 u8 peer_inst_id;
8680 const u8 *addr;
8681 u8 info_len;
8682 const u8 *info;
8683 u64 cookie;
8684};
8685
8686/**
8687 * cfg80211_nan_match - report a match for a NAN function.
8688 * @wdev: the wireless device reporting the match
8689 * @match: match notification parameters
8690 * @gfp: allocation flags
8691 *
8692 * This function reports that the a NAN function had a match. This
8693 * can be a subscribe that had a match or a solicited publish that
8694 * was sent. It can also be a follow up that was received.
8695 */
8696void cfg80211_nan_match(struct wireless_dev *wdev,
8697 struct cfg80211_nan_match_params *match, gfp_t gfp);
8698
8699/**
8700 * cfg80211_nan_func_terminated - notify about NAN function termination.
8701 *
8702 * @wdev: the wireless device reporting the match
8703 * @inst_id: the local instance id
8704 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
8705 * @cookie: unique NAN function identifier
8706 * @gfp: allocation flags
8707 *
8708 * This function reports that the a NAN function is terminated.
8709 */
8710void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
8711 u8 inst_id,
8712 enum nl80211_nan_func_term_reason reason,
8713 u64 cookie, gfp_t gfp);
8714
8715/* ethtool helper */
8716void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
8717
8718/**
8719 * cfg80211_external_auth_request - userspace request for authentication
8720 * @netdev: network device
8721 * @params: External authentication parameters
8722 * @gfp: allocation flags
8723 * Returns: 0 on success, < 0 on error
8724 */
8725int cfg80211_external_auth_request(struct net_device *netdev,
8726 struct cfg80211_external_auth_params *params,
8727 gfp_t gfp);
8728
8729/**
8730 * cfg80211_pmsr_report - report peer measurement result data
8731 * @wdev: the wireless device reporting the measurement
8732 * @req: the original measurement request
8733 * @result: the result data
8734 * @gfp: allocation flags
8735 */
8736void cfg80211_pmsr_report(struct wireless_dev *wdev,
8737 struct cfg80211_pmsr_request *req,
8738 struct cfg80211_pmsr_result *result,
8739 gfp_t gfp);
8740
8741/**
8742 * cfg80211_pmsr_complete - report peer measurement completed
8743 * @wdev: the wireless device reporting the measurement
8744 * @req: the original measurement request
8745 * @gfp: allocation flags
8746 *
8747 * Report that the entire measurement completed, after this
8748 * the request pointer will no longer be valid.
8749 */
8750void cfg80211_pmsr_complete(struct wireless_dev *wdev,
8751 struct cfg80211_pmsr_request *req,
8752 gfp_t gfp);
8753
8754/**
8755 * cfg80211_iftype_allowed - check whether the interface can be allowed
8756 * @wiphy: the wiphy
8757 * @iftype: interface type
8758 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
8759 * @check_swif: check iftype against software interfaces
8760 *
8761 * Check whether the interface is allowed to operate; additionally, this API
8762 * can be used to check iftype against the software interfaces when
8763 * check_swif is '1'.
8764 */
8765bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
8766 bool is_4addr, u8 check_swif);
8767
8768
8769/**
8770 * cfg80211_assoc_comeback - notification of association that was
8771 * temporarly rejected with a comeback
8772 * @netdev: network device
8773 * @ap_addr: AP (MLD) address that rejected the assocation
8774 * @timeout: timeout interval value TUs.
8775 *
8776 * this function may sleep. the caller must hold the corresponding wdev's mutex.
8777 */
8778void cfg80211_assoc_comeback(struct net_device *netdev,
8779 const u8 *ap_addr, u32 timeout);
8780
8781/* Logging, debugging and troubleshooting/diagnostic helpers. */
8782
8783/* wiphy_printk helpers, similar to dev_printk */
8784
8785#define wiphy_printk(level, wiphy, format, args...) \
8786 dev_printk(level, &(wiphy)->dev, format, ##args)
8787#define wiphy_emerg(wiphy, format, args...) \
8788 dev_emerg(&(wiphy)->dev, format, ##args)
8789#define wiphy_alert(wiphy, format, args...) \
8790 dev_alert(&(wiphy)->dev, format, ##args)
8791#define wiphy_crit(wiphy, format, args...) \
8792 dev_crit(&(wiphy)->dev, format, ##args)
8793#define wiphy_err(wiphy, format, args...) \
8794 dev_err(&(wiphy)->dev, format, ##args)
8795#define wiphy_warn(wiphy, format, args...) \
8796 dev_warn(&(wiphy)->dev, format, ##args)
8797#define wiphy_notice(wiphy, format, args...) \
8798 dev_notice(&(wiphy)->dev, format, ##args)
8799#define wiphy_info(wiphy, format, args...) \
8800 dev_info(&(wiphy)->dev, format, ##args)
8801#define wiphy_info_once(wiphy, format, args...) \
8802 dev_info_once(&(wiphy)->dev, format, ##args)
8803
8804#define wiphy_err_ratelimited(wiphy, format, args...) \
8805 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
8806#define wiphy_warn_ratelimited(wiphy, format, args...) \
8807 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
8808
8809#define wiphy_debug(wiphy, format, args...) \
8810 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
8811
8812#define wiphy_dbg(wiphy, format, args...) \
8813 dev_dbg(&(wiphy)->dev, format, ##args)
8814
8815#if defined(VERBOSE_DEBUG)
8816#define wiphy_vdbg wiphy_dbg
8817#else
8818#define wiphy_vdbg(wiphy, format, args...) \
8819({ \
8820 if (0) \
8821 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8822 0; \
8823})
8824#endif
8825
8826/*
8827 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8828 * of using a WARN/WARN_ON to get the message out, including the
8829 * file/line information and a backtrace.
8830 */
8831#define wiphy_WARN(wiphy, format, args...) \
8832 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8833
8834/**
8835 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8836 * @netdev: network device
8837 * @owe_info: peer's owe info
8838 * @gfp: allocation flags
8839 */
8840void cfg80211_update_owe_info_event(struct net_device *netdev,
8841 struct cfg80211_update_owe_info *owe_info,
8842 gfp_t gfp);
8843
8844/**
8845 * cfg80211_bss_flush - resets all the scan entries
8846 * @wiphy: the wiphy
8847 */
8848void cfg80211_bss_flush(struct wiphy *wiphy);
8849
8850/**
8851 * cfg80211_bss_color_notify - notify about bss color event
8852 * @dev: network device
8853 * @gfp: allocation flags
8854 * @cmd: the actual event we want to notify
8855 * @count: the number of TBTTs until the color change happens
8856 * @color_bitmap: representations of the colors that the local BSS is aware of
8857 */
8858int cfg80211_bss_color_notify(struct net_device *dev, gfp_t gfp,
8859 enum nl80211_commands cmd, u8 count,
8860 u64 color_bitmap);
8861
8862/**
8863 * cfg80211_obss_color_collision_notify - notify about bss color collision
8864 * @dev: network device
8865 * @color_bitmap: representations of the colors that the local BSS is aware of
8866 * @gfp: allocation flags
8867 */
8868static inline int cfg80211_obss_color_collision_notify(struct net_device *dev,
8869 u64 color_bitmap, gfp_t gfp)
8870{
8871 return cfg80211_bss_color_notify(dev, gfp,
8872 NL80211_CMD_OBSS_COLOR_COLLISION,
8873 0, color_bitmap);
8874}
8875
8876/**
8877 * cfg80211_color_change_started_notify - notify color change start
8878 * @dev: the device on which the color is switched
8879 * @count: the number of TBTTs until the color change happens
8880 *
8881 * Inform the userspace about the color change that has started.
8882 */
8883static inline int cfg80211_color_change_started_notify(struct net_device *dev,
8884 u8 count)
8885{
8886 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8887 NL80211_CMD_COLOR_CHANGE_STARTED,
8888 count, 0);
8889}
8890
8891/**
8892 * cfg80211_color_change_aborted_notify - notify color change abort
8893 * @dev: the device on which the color is switched
8894 *
8895 * Inform the userspace about the color change that has aborted.
8896 */
8897static inline int cfg80211_color_change_aborted_notify(struct net_device *dev)
8898{
8899 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8900 NL80211_CMD_COLOR_CHANGE_ABORTED,
8901 0, 0);
8902}
8903
8904/**
8905 * cfg80211_color_change_notify - notify color change completion
8906 * @dev: the device on which the color was switched
8907 *
8908 * Inform the userspace about the color change that has completed.
8909 */
8910static inline int cfg80211_color_change_notify(struct net_device *dev)
8911{
8912 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8913 NL80211_CMD_COLOR_CHANGE_COMPLETED,
8914 0, 0);
8915}
8916
8917#endif /* __NET_CFG80211_H */