Loading...
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 *
113 */
114enum ieee80211_channel_flags {
115 IEEE80211_CHAN_DISABLED = 1<<0,
116 IEEE80211_CHAN_NO_IR = 1<<1,
117 /* hole at 1<<2 */
118 IEEE80211_CHAN_RADAR = 1<<3,
119 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
120 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
121 IEEE80211_CHAN_NO_OFDM = 1<<6,
122 IEEE80211_CHAN_NO_80MHZ = 1<<7,
123 IEEE80211_CHAN_NO_160MHZ = 1<<8,
124 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
125 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
126 IEEE80211_CHAN_NO_20MHZ = 1<<11,
127 IEEE80211_CHAN_NO_10MHZ = 1<<12,
128 IEEE80211_CHAN_NO_HE = 1<<13,
129 IEEE80211_CHAN_1MHZ = 1<<14,
130 IEEE80211_CHAN_2MHZ = 1<<15,
131 IEEE80211_CHAN_4MHZ = 1<<16,
132 IEEE80211_CHAN_8MHZ = 1<<17,
133 IEEE80211_CHAN_16MHZ = 1<<18,
134};
135
136#define IEEE80211_CHAN_NO_HT40 \
137 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
138
139#define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
140#define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
141
142/**
143 * struct ieee80211_channel - channel definition
144 *
145 * This structure describes a single channel for use
146 * with cfg80211.
147 *
148 * @center_freq: center frequency in MHz
149 * @freq_offset: offset from @center_freq, in KHz
150 * @hw_value: hardware-specific value for the channel
151 * @flags: channel flags from &enum ieee80211_channel_flags.
152 * @orig_flags: channel flags at registration time, used by regulatory
153 * code to support devices with additional restrictions
154 * @band: band this channel belongs to.
155 * @max_antenna_gain: maximum antenna gain in dBi
156 * @max_power: maximum transmission power (in dBm)
157 * @max_reg_power: maximum regulatory transmission power (in dBm)
158 * @beacon_found: helper to regulatory code to indicate when a beacon
159 * has been found on this channel. Use regulatory_hint_found_beacon()
160 * to enable this, this is useful only on 5 GHz band.
161 * @orig_mag: internal use
162 * @orig_mpwr: internal use
163 * @dfs_state: current state of this channel. Only relevant if radar is required
164 * on this channel.
165 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
166 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
167 */
168struct ieee80211_channel {
169 enum nl80211_band band;
170 u32 center_freq;
171 u16 freq_offset;
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_he_obss_pd - AP settings for spatial reuse
273 *
274 * @enable: is the feature enabled.
275 * @sr_ctrl: The SR Control field of SRP element.
276 * @non_srg_max_offset: non-SRG maximum tx power offset
277 * @min_offset: minimal tx power offset an associated station shall use
278 * @max_offset: maximum tx power offset an associated station shall use
279 * @bss_color_bitmap: bitmap that indicates the BSS color values used by
280 * members of the SRG
281 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
282 * used by members of the SRG
283 */
284struct ieee80211_he_obss_pd {
285 bool enable;
286 u8 sr_ctrl;
287 u8 non_srg_max_offset;
288 u8 min_offset;
289 u8 max_offset;
290 u8 bss_color_bitmap[8];
291 u8 partial_bssid_bitmap[8];
292};
293
294/**
295 * struct cfg80211_he_bss_color - AP settings for BSS coloring
296 *
297 * @color: the current color.
298 * @enabled: HE BSS color is used
299 * @partial: define the AID equation.
300 */
301struct cfg80211_he_bss_color {
302 u8 color;
303 bool enabled;
304 bool partial;
305};
306
307/**
308 * struct ieee80211_sta_ht_cap - STA's HT capabilities
309 *
310 * This structure describes most essential parameters needed
311 * to describe 802.11n HT capabilities for an STA.
312 *
313 * @ht_supported: is HT supported by the STA
314 * @cap: HT capabilities map as described in 802.11n spec
315 * @ampdu_factor: Maximum A-MPDU length factor
316 * @ampdu_density: Minimum A-MPDU spacing
317 * @mcs: Supported MCS rates
318 */
319struct ieee80211_sta_ht_cap {
320 u16 cap; /* use IEEE80211_HT_CAP_ */
321 bool ht_supported;
322 u8 ampdu_factor;
323 u8 ampdu_density;
324 struct ieee80211_mcs_info mcs;
325};
326
327/**
328 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
329 *
330 * This structure describes most essential parameters needed
331 * to describe 802.11ac VHT capabilities for an STA.
332 *
333 * @vht_supported: is VHT supported by the STA
334 * @cap: VHT capabilities map as described in 802.11ac spec
335 * @vht_mcs: Supported VHT MCS rates
336 */
337struct ieee80211_sta_vht_cap {
338 bool vht_supported;
339 u32 cap; /* use IEEE80211_VHT_CAP_ */
340 struct ieee80211_vht_mcs_info vht_mcs;
341};
342
343#define IEEE80211_HE_PPE_THRES_MAX_LEN 25
344
345/**
346 * struct ieee80211_sta_he_cap - STA's HE capabilities
347 *
348 * This structure describes most essential parameters needed
349 * to describe 802.11ax HE capabilities for a STA.
350 *
351 * @has_he: true iff HE data is valid.
352 * @he_cap_elem: Fixed portion of the HE capabilities element.
353 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
354 * @ppe_thres: Holds the PPE Thresholds data.
355 */
356struct ieee80211_sta_he_cap {
357 bool has_he;
358 struct ieee80211_he_cap_elem he_cap_elem;
359 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
360 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
361};
362
363/**
364 * struct ieee80211_sband_iftype_data - sband data per interface type
365 *
366 * This structure encapsulates sband data that is relevant for the
367 * interface types defined in @types_mask. Each type in the
368 * @types_mask must be unique across all instances of iftype_data.
369 *
370 * @types_mask: interface types mask
371 * @he_cap: holds the HE capabilities
372 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
373 * 6 GHz band channel (and 0 may be valid value).
374 * @vendor_elems: vendor element(s) to advertise
375 * @vendor_elems.data: vendor element(s) data
376 * @vendor_elems.len: vendor element(s) length
377 */
378struct ieee80211_sband_iftype_data {
379 u16 types_mask;
380 struct ieee80211_sta_he_cap he_cap;
381 struct ieee80211_he_6ghz_capa he_6ghz_capa;
382 struct {
383 const u8 *data;
384 unsigned int len;
385 } vendor_elems;
386};
387
388/**
389 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
390 *
391 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
392 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
393 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
394 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
395 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
396 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
397 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
398 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
399 * 2.16GHz+2.16GHz
400 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
401 * 4.32GHz + 4.32GHz
402 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
403 * 4.32GHz + 4.32GHz
404 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
405 * and 4.32GHz + 4.32GHz
406 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
407 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
408 */
409enum ieee80211_edmg_bw_config {
410 IEEE80211_EDMG_BW_CONFIG_4 = 4,
411 IEEE80211_EDMG_BW_CONFIG_5 = 5,
412 IEEE80211_EDMG_BW_CONFIG_6 = 6,
413 IEEE80211_EDMG_BW_CONFIG_7 = 7,
414 IEEE80211_EDMG_BW_CONFIG_8 = 8,
415 IEEE80211_EDMG_BW_CONFIG_9 = 9,
416 IEEE80211_EDMG_BW_CONFIG_10 = 10,
417 IEEE80211_EDMG_BW_CONFIG_11 = 11,
418 IEEE80211_EDMG_BW_CONFIG_12 = 12,
419 IEEE80211_EDMG_BW_CONFIG_13 = 13,
420 IEEE80211_EDMG_BW_CONFIG_14 = 14,
421 IEEE80211_EDMG_BW_CONFIG_15 = 15,
422};
423
424/**
425 * struct ieee80211_edmg - EDMG configuration
426 *
427 * This structure describes most essential parameters needed
428 * to describe 802.11ay EDMG configuration
429 *
430 * @channels: bitmap that indicates the 2.16 GHz channel(s)
431 * that are allowed to be used for transmissions.
432 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
433 * Set to 0 indicate EDMG not supported.
434 * @bw_config: Channel BW Configuration subfield encodes
435 * the allowed channel bandwidth configurations
436 */
437struct ieee80211_edmg {
438 u8 channels;
439 enum ieee80211_edmg_bw_config bw_config;
440};
441
442/**
443 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
444 *
445 * This structure describes most essential parameters needed
446 * to describe 802.11ah S1G capabilities for a STA.
447 *
448 * @s1g_supported: is STA an S1G STA
449 * @cap: S1G capabilities information
450 * @nss_mcs: Supported NSS MCS set
451 */
452struct ieee80211_sta_s1g_cap {
453 bool s1g;
454 u8 cap[10]; /* use S1G_CAPAB_ */
455 u8 nss_mcs[5];
456};
457
458/**
459 * struct ieee80211_supported_band - frequency band definition
460 *
461 * This structure describes a frequency band a wiphy
462 * is able to operate in.
463 *
464 * @channels: Array of channels the hardware can operate with
465 * in this band.
466 * @band: the band this structure represents
467 * @n_channels: Number of channels in @channels
468 * @bitrates: Array of bitrates the hardware can operate with
469 * in this band. Must be sorted to give a valid "supported
470 * rates" IE, i.e. CCK rates first, then OFDM.
471 * @n_bitrates: Number of bitrates in @bitrates
472 * @ht_cap: HT capabilities in this band
473 * @vht_cap: VHT capabilities in this band
474 * @s1g_cap: S1G capabilities in this band
475 * @edmg_cap: EDMG capabilities in this band
476 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
477 * @n_iftype_data: number of iftype data entries
478 * @iftype_data: interface type data entries. Note that the bits in
479 * @types_mask inside this structure cannot overlap (i.e. only
480 * one occurrence of each type is allowed across all instances of
481 * iftype_data).
482 */
483struct ieee80211_supported_band {
484 struct ieee80211_channel *channels;
485 struct ieee80211_rate *bitrates;
486 enum nl80211_band band;
487 int n_channels;
488 int n_bitrates;
489 struct ieee80211_sta_ht_cap ht_cap;
490 struct ieee80211_sta_vht_cap vht_cap;
491 struct ieee80211_sta_s1g_cap s1g_cap;
492 struct ieee80211_edmg edmg_cap;
493 u16 n_iftype_data;
494 const struct ieee80211_sband_iftype_data *iftype_data;
495};
496
497/**
498 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
499 * @sband: the sband to search for the STA on
500 * @iftype: enum nl80211_iftype
501 *
502 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
503 */
504static inline const struct ieee80211_sband_iftype_data *
505ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
506 u8 iftype)
507{
508 int i;
509
510 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
511 return NULL;
512
513 for (i = 0; i < sband->n_iftype_data; i++) {
514 const struct ieee80211_sband_iftype_data *data =
515 &sband->iftype_data[i];
516
517 if (data->types_mask & BIT(iftype))
518 return data;
519 }
520
521 return NULL;
522}
523
524/**
525 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
526 * @sband: the sband to search for the iftype on
527 * @iftype: enum nl80211_iftype
528 *
529 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
530 */
531static inline const struct ieee80211_sta_he_cap *
532ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
533 u8 iftype)
534{
535 const struct ieee80211_sband_iftype_data *data =
536 ieee80211_get_sband_iftype_data(sband, iftype);
537
538 if (data && data->he_cap.has_he)
539 return &data->he_cap;
540
541 return NULL;
542}
543
544/**
545 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
546 * @sband: the sband to search for the STA on
547 * @iftype: the iftype to search for
548 *
549 * Return: the 6GHz capabilities
550 */
551static inline __le16
552ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
553 enum nl80211_iftype iftype)
554{
555 const struct ieee80211_sband_iftype_data *data =
556 ieee80211_get_sband_iftype_data(sband, iftype);
557
558 if (WARN_ON(!data || !data->he_cap.has_he))
559 return 0;
560
561 return data->he_6ghz_capa.capa;
562}
563
564/**
565 * wiphy_read_of_freq_limits - read frequency limits from device tree
566 *
567 * @wiphy: the wireless device to get extra limits for
568 *
569 * Some devices may have extra limitations specified in DT. This may be useful
570 * for chipsets that normally support more bands but are limited due to board
571 * design (e.g. by antennas or external power amplifier).
572 *
573 * This function reads info from DT and uses it to *modify* channels (disable
574 * unavailable ones). It's usually a *bad* idea to use it in drivers with
575 * shared channel data as DT limitations are device specific. You should make
576 * sure to call it only if channels in wiphy are copied and can be modified
577 * without affecting other devices.
578 *
579 * As this function access device node it has to be called after set_wiphy_dev.
580 * It also modifies channels so they have to be set first.
581 * If using this helper, call it before wiphy_register().
582 */
583#ifdef CONFIG_OF
584void wiphy_read_of_freq_limits(struct wiphy *wiphy);
585#else /* CONFIG_OF */
586static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
587{
588}
589#endif /* !CONFIG_OF */
590
591
592/*
593 * Wireless hardware/device configuration structures and methods
594 */
595
596/**
597 * DOC: Actions and configuration
598 *
599 * Each wireless device and each virtual interface offer a set of configuration
600 * operations and other actions that are invoked by userspace. Each of these
601 * actions is described in the operations structure, and the parameters these
602 * operations use are described separately.
603 *
604 * Additionally, some operations are asynchronous and expect to get status
605 * information via some functions that drivers need to call.
606 *
607 * Scanning and BSS list handling with its associated functionality is described
608 * in a separate chapter.
609 */
610
611#define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
612 WLAN_USER_POSITION_LEN)
613
614/**
615 * struct vif_params - describes virtual interface parameters
616 * @flags: monitor interface flags, unchanged if 0, otherwise
617 * %MONITOR_FLAG_CHANGED will be set
618 * @use_4addr: use 4-address frames
619 * @macaddr: address to use for this virtual interface.
620 * If this parameter is set to zero address the driver may
621 * determine the address as needed.
622 * This feature is only fully supported by drivers that enable the
623 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
624 ** only p2p devices with specified MAC.
625 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
626 * belonging to that MU-MIMO groupID; %NULL if not changed
627 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
628 * MU-MIMO packets going to the specified station; %NULL if not changed
629 */
630struct vif_params {
631 u32 flags;
632 int use_4addr;
633 u8 macaddr[ETH_ALEN];
634 const u8 *vht_mumimo_groups;
635 const u8 *vht_mumimo_follow_addr;
636};
637
638/**
639 * struct key_params - key information
640 *
641 * Information about a key
642 *
643 * @key: key material
644 * @key_len: length of key material
645 * @cipher: cipher suite selector
646 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
647 * with the get_key() callback, must be in little endian,
648 * length given by @seq_len.
649 * @seq_len: length of @seq.
650 * @vlan_id: vlan_id for VLAN group key (if nonzero)
651 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
652 */
653struct key_params {
654 const u8 *key;
655 const u8 *seq;
656 int key_len;
657 int seq_len;
658 u16 vlan_id;
659 u32 cipher;
660 enum nl80211_key_mode mode;
661};
662
663/**
664 * struct cfg80211_chan_def - channel definition
665 * @chan: the (control) channel
666 * @width: channel width
667 * @center_freq1: center frequency of first segment
668 * @center_freq2: center frequency of second segment
669 * (only with 80+80 MHz)
670 * @edmg: define the EDMG channels configuration.
671 * If edmg is requested (i.e. the .channels member is non-zero),
672 * chan will define the primary channel and all other
673 * parameters are ignored.
674 * @freq1_offset: offset from @center_freq1, in KHz
675 */
676struct cfg80211_chan_def {
677 struct ieee80211_channel *chan;
678 enum nl80211_chan_width width;
679 u32 center_freq1;
680 u32 center_freq2;
681 struct ieee80211_edmg edmg;
682 u16 freq1_offset;
683};
684
685/*
686 * cfg80211_bitrate_mask - masks for bitrate control
687 */
688struct cfg80211_bitrate_mask {
689 struct {
690 u32 legacy;
691 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
692 u16 vht_mcs[NL80211_VHT_NSS_MAX];
693 u16 he_mcs[NL80211_HE_NSS_MAX];
694 enum nl80211_txrate_gi gi;
695 enum nl80211_he_gi he_gi;
696 enum nl80211_he_ltf he_ltf;
697 } control[NUM_NL80211_BANDS];
698};
699
700
701/**
702 * struct cfg80211_tid_cfg - TID specific configuration
703 * @config_override: Flag to notify driver to reset TID configuration
704 * of the peer.
705 * @tids: bitmap of TIDs to modify
706 * @mask: bitmap of attributes indicating which parameter changed,
707 * similar to &nl80211_tid_config_supp.
708 * @noack: noack configuration value for the TID
709 * @retry_long: retry count value
710 * @retry_short: retry count value
711 * @ampdu: Enable/Disable MPDU aggregation
712 * @rtscts: Enable/Disable RTS/CTS
713 * @amsdu: Enable/Disable MSDU aggregation
714 * @txrate_type: Tx bitrate mask type
715 * @txrate_mask: Tx bitrate to be applied for the TID
716 */
717struct cfg80211_tid_cfg {
718 bool config_override;
719 u8 tids;
720 u64 mask;
721 enum nl80211_tid_config noack;
722 u8 retry_long, retry_short;
723 enum nl80211_tid_config ampdu;
724 enum nl80211_tid_config rtscts;
725 enum nl80211_tid_config amsdu;
726 enum nl80211_tx_rate_setting txrate_type;
727 struct cfg80211_bitrate_mask txrate_mask;
728};
729
730/**
731 * struct cfg80211_tid_config - TID configuration
732 * @peer: Station's MAC address
733 * @n_tid_conf: Number of TID specific configurations to be applied
734 * @tid_conf: Configuration change info
735 */
736struct cfg80211_tid_config {
737 const u8 *peer;
738 u32 n_tid_conf;
739 struct cfg80211_tid_cfg tid_conf[];
740};
741
742/**
743 * cfg80211_get_chandef_type - return old channel type from chandef
744 * @chandef: the channel definition
745 *
746 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
747 * chandef, which must have a bandwidth allowing this conversion.
748 */
749static inline enum nl80211_channel_type
750cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
751{
752 switch (chandef->width) {
753 case NL80211_CHAN_WIDTH_20_NOHT:
754 return NL80211_CHAN_NO_HT;
755 case NL80211_CHAN_WIDTH_20:
756 return NL80211_CHAN_HT20;
757 case NL80211_CHAN_WIDTH_40:
758 if (chandef->center_freq1 > chandef->chan->center_freq)
759 return NL80211_CHAN_HT40PLUS;
760 return NL80211_CHAN_HT40MINUS;
761 default:
762 WARN_ON(1);
763 return NL80211_CHAN_NO_HT;
764 }
765}
766
767/**
768 * cfg80211_chandef_create - create channel definition using channel type
769 * @chandef: the channel definition struct to fill
770 * @channel: the control channel
771 * @chantype: the channel type
772 *
773 * Given a channel type, create a channel definition.
774 */
775void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
776 struct ieee80211_channel *channel,
777 enum nl80211_channel_type chantype);
778
779/**
780 * cfg80211_chandef_identical - check if two channel definitions are identical
781 * @chandef1: first channel definition
782 * @chandef2: second channel definition
783 *
784 * Return: %true if the channels defined by the channel definitions are
785 * identical, %false otherwise.
786 */
787static inline bool
788cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
789 const struct cfg80211_chan_def *chandef2)
790{
791 return (chandef1->chan == chandef2->chan &&
792 chandef1->width == chandef2->width &&
793 chandef1->center_freq1 == chandef2->center_freq1 &&
794 chandef1->freq1_offset == chandef2->freq1_offset &&
795 chandef1->center_freq2 == chandef2->center_freq2);
796}
797
798/**
799 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
800 *
801 * @chandef: the channel definition
802 *
803 * Return: %true if EDMG defined, %false otherwise.
804 */
805static inline bool
806cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
807{
808 return chandef->edmg.channels || chandef->edmg.bw_config;
809}
810
811/**
812 * cfg80211_chandef_compatible - check if two channel definitions are compatible
813 * @chandef1: first channel definition
814 * @chandef2: second channel definition
815 *
816 * Return: %NULL if the given channel definitions are incompatible,
817 * chandef1 or chandef2 otherwise.
818 */
819const struct cfg80211_chan_def *
820cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
821 const struct cfg80211_chan_def *chandef2);
822
823/**
824 * cfg80211_chandef_valid - check if a channel definition is valid
825 * @chandef: the channel definition to check
826 * Return: %true if the channel definition is valid. %false otherwise.
827 */
828bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
829
830/**
831 * cfg80211_chandef_usable - check if secondary channels can be used
832 * @wiphy: the wiphy to validate against
833 * @chandef: the channel definition to check
834 * @prohibited_flags: the regulatory channel flags that must not be set
835 * Return: %true if secondary channels are usable. %false otherwise.
836 */
837bool cfg80211_chandef_usable(struct wiphy *wiphy,
838 const struct cfg80211_chan_def *chandef,
839 u32 prohibited_flags);
840
841/**
842 * cfg80211_chandef_dfs_required - checks if radar detection is required
843 * @wiphy: the wiphy to validate against
844 * @chandef: the channel definition to check
845 * @iftype: the interface type as specified in &enum nl80211_iftype
846 * Returns:
847 * 1 if radar detection is required, 0 if it is not, < 0 on error
848 */
849int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
850 const struct cfg80211_chan_def *chandef,
851 enum nl80211_iftype iftype);
852
853/**
854 * ieee80211_chandef_rate_flags - returns rate flags for a channel
855 *
856 * In some channel types, not all rates may be used - for example CCK
857 * rates may not be used in 5/10 MHz channels.
858 *
859 * @chandef: channel definition for the channel
860 *
861 * Returns: rate flags which apply for this channel
862 */
863static inline enum ieee80211_rate_flags
864ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
865{
866 switch (chandef->width) {
867 case NL80211_CHAN_WIDTH_5:
868 return IEEE80211_RATE_SUPPORTS_5MHZ;
869 case NL80211_CHAN_WIDTH_10:
870 return IEEE80211_RATE_SUPPORTS_10MHZ;
871 default:
872 break;
873 }
874 return 0;
875}
876
877/**
878 * ieee80211_chandef_max_power - maximum transmission power for the chandef
879 *
880 * In some regulations, the transmit power may depend on the configured channel
881 * bandwidth which may be defined as dBm/MHz. This function returns the actual
882 * max_power for non-standard (20 MHz) channels.
883 *
884 * @chandef: channel definition for the channel
885 *
886 * Returns: maximum allowed transmission power in dBm for the chandef
887 */
888static inline int
889ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
890{
891 switch (chandef->width) {
892 case NL80211_CHAN_WIDTH_5:
893 return min(chandef->chan->max_reg_power - 6,
894 chandef->chan->max_power);
895 case NL80211_CHAN_WIDTH_10:
896 return min(chandef->chan->max_reg_power - 3,
897 chandef->chan->max_power);
898 default:
899 break;
900 }
901 return chandef->chan->max_power;
902}
903
904/**
905 * cfg80211_any_usable_channels - check for usable channels
906 * @wiphy: the wiphy to check for
907 * @band_mask: which bands to check on
908 * @prohibited_flags: which channels to not consider usable,
909 * %IEEE80211_CHAN_DISABLED is always taken into account
910 */
911bool cfg80211_any_usable_channels(struct wiphy *wiphy,
912 unsigned long band_mask,
913 u32 prohibited_flags);
914
915/**
916 * enum survey_info_flags - survey information flags
917 *
918 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
919 * @SURVEY_INFO_IN_USE: channel is currently being used
920 * @SURVEY_INFO_TIME: active time (in ms) was filled in
921 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
922 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
923 * @SURVEY_INFO_TIME_RX: receive time was filled in
924 * @SURVEY_INFO_TIME_TX: transmit time was filled in
925 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
926 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
927 *
928 * Used by the driver to indicate which info in &struct survey_info
929 * it has filled in during the get_survey().
930 */
931enum survey_info_flags {
932 SURVEY_INFO_NOISE_DBM = BIT(0),
933 SURVEY_INFO_IN_USE = BIT(1),
934 SURVEY_INFO_TIME = BIT(2),
935 SURVEY_INFO_TIME_BUSY = BIT(3),
936 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
937 SURVEY_INFO_TIME_RX = BIT(5),
938 SURVEY_INFO_TIME_TX = BIT(6),
939 SURVEY_INFO_TIME_SCAN = BIT(7),
940 SURVEY_INFO_TIME_BSS_RX = BIT(8),
941};
942
943/**
944 * struct survey_info - channel survey response
945 *
946 * @channel: the channel this survey record reports, may be %NULL for a single
947 * record to report global statistics
948 * @filled: bitflag of flags from &enum survey_info_flags
949 * @noise: channel noise in dBm. This and all following fields are
950 * optional
951 * @time: amount of time in ms the radio was turn on (on the channel)
952 * @time_busy: amount of time the primary channel was sensed busy
953 * @time_ext_busy: amount of time the extension channel was sensed busy
954 * @time_rx: amount of time the radio spent receiving data
955 * @time_tx: amount of time the radio spent transmitting data
956 * @time_scan: amount of time the radio spent for scanning
957 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
958 *
959 * Used by dump_survey() to report back per-channel survey information.
960 *
961 * This structure can later be expanded with things like
962 * channel duty cycle etc.
963 */
964struct survey_info {
965 struct ieee80211_channel *channel;
966 u64 time;
967 u64 time_busy;
968 u64 time_ext_busy;
969 u64 time_rx;
970 u64 time_tx;
971 u64 time_scan;
972 u64 time_bss_rx;
973 u32 filled;
974 s8 noise;
975};
976
977#define CFG80211_MAX_WEP_KEYS 4
978
979/**
980 * struct cfg80211_crypto_settings - Crypto settings
981 * @wpa_versions: indicates which, if any, WPA versions are enabled
982 * (from enum nl80211_wpa_versions)
983 * @cipher_group: group key cipher suite (or 0 if unset)
984 * @n_ciphers_pairwise: number of AP supported unicast ciphers
985 * @ciphers_pairwise: unicast key cipher suites
986 * @n_akm_suites: number of AKM suites
987 * @akm_suites: AKM suites
988 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
989 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
990 * required to assume that the port is unauthorized until authorized by
991 * user space. Otherwise, port is marked authorized by default.
992 * @control_port_ethertype: the control port protocol that should be
993 * allowed through even on unauthorized ports
994 * @control_port_no_encrypt: TRUE to prevent encryption of control port
995 * protocol frames.
996 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
997 * port frames over NL80211 instead of the network interface.
998 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
999 * port for mac80211
1000 * @wep_keys: static WEP keys, if not NULL points to an array of
1001 * CFG80211_MAX_WEP_KEYS WEP keys
1002 * @wep_tx_key: key index (0..3) of the default TX static WEP key
1003 * @psk: PSK (for devices supporting 4-way-handshake offload)
1004 * @sae_pwd: password for SAE authentication (for devices supporting SAE
1005 * offload)
1006 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1007 * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
1008 *
1009 * NL80211_SAE_PWE_UNSPECIFIED
1010 * Not-specified, used to indicate userspace did not specify any
1011 * preference. The driver should follow its internal policy in
1012 * such a scenario.
1013 *
1014 * NL80211_SAE_PWE_HUNT_AND_PECK
1015 * Allow hunting-and-pecking loop only
1016 *
1017 * NL80211_SAE_PWE_HASH_TO_ELEMENT
1018 * Allow hash-to-element only
1019 *
1020 * NL80211_SAE_PWE_BOTH
1021 * Allow either hunting-and-pecking loop or hash-to-element
1022 */
1023struct cfg80211_crypto_settings {
1024 u32 wpa_versions;
1025 u32 cipher_group;
1026 int n_ciphers_pairwise;
1027 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1028 int n_akm_suites;
1029 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
1030 bool control_port;
1031 __be16 control_port_ethertype;
1032 bool control_port_no_encrypt;
1033 bool control_port_over_nl80211;
1034 bool control_port_no_preauth;
1035 struct key_params *wep_keys;
1036 int wep_tx_key;
1037 const u8 *psk;
1038 const u8 *sae_pwd;
1039 u8 sae_pwd_len;
1040 enum nl80211_sae_pwe_mechanism sae_pwe;
1041};
1042
1043/**
1044 * struct cfg80211_beacon_data - beacon data
1045 * @head: head portion of beacon (before TIM IE)
1046 * or %NULL if not changed
1047 * @tail: tail portion of beacon (after TIM IE)
1048 * or %NULL if not changed
1049 * @head_len: length of @head
1050 * @tail_len: length of @tail
1051 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1052 * @beacon_ies_len: length of beacon_ies in octets
1053 * @proberesp_ies: extra information element(s) to add into Probe Response
1054 * frames or %NULL
1055 * @proberesp_ies_len: length of proberesp_ies in octets
1056 * @assocresp_ies: extra information element(s) to add into (Re)Association
1057 * Response frames or %NULL
1058 * @assocresp_ies_len: length of assocresp_ies in octets
1059 * @probe_resp_len: length of probe response template (@probe_resp)
1060 * @probe_resp: probe response template (AP mode only)
1061 * @ftm_responder: enable FTM responder functionality; -1 for no change
1062 * (which also implies no change in LCI/civic location data)
1063 * @lci: Measurement Report element content, starting with Measurement Token
1064 * (measurement type 8)
1065 * @civicloc: Measurement Report element content, starting with Measurement
1066 * Token (measurement type 11)
1067 * @lci_len: LCI data length
1068 * @civicloc_len: Civic location data length
1069 */
1070struct cfg80211_beacon_data {
1071 const u8 *head, *tail;
1072 const u8 *beacon_ies;
1073 const u8 *proberesp_ies;
1074 const u8 *assocresp_ies;
1075 const u8 *probe_resp;
1076 const u8 *lci;
1077 const u8 *civicloc;
1078 s8 ftm_responder;
1079
1080 size_t head_len, tail_len;
1081 size_t beacon_ies_len;
1082 size_t proberesp_ies_len;
1083 size_t assocresp_ies_len;
1084 size_t probe_resp_len;
1085 size_t lci_len;
1086 size_t civicloc_len;
1087};
1088
1089struct mac_address {
1090 u8 addr[ETH_ALEN];
1091};
1092
1093/**
1094 * struct cfg80211_acl_data - Access control list data
1095 *
1096 * @acl_policy: ACL policy to be applied on the station's
1097 * entry specified by mac_addr
1098 * @n_acl_entries: Number of MAC address entries passed
1099 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1100 */
1101struct cfg80211_acl_data {
1102 enum nl80211_acl_policy acl_policy;
1103 int n_acl_entries;
1104
1105 /* Keep it last */
1106 struct mac_address mac_addrs[];
1107};
1108
1109/**
1110 * struct cfg80211_fils_discovery - FILS discovery parameters from
1111 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1112 *
1113 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1114 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1115 * @tmpl_len: Template length
1116 * @tmpl: Template data for FILS discovery frame including the action
1117 * frame headers.
1118 */
1119struct cfg80211_fils_discovery {
1120 u32 min_interval;
1121 u32 max_interval;
1122 size_t tmpl_len;
1123 const u8 *tmpl;
1124};
1125
1126/**
1127 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1128 * response parameters in 6GHz.
1129 *
1130 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1131 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1132 * scanning
1133 * @tmpl_len: Template length
1134 * @tmpl: Template data for probe response
1135 */
1136struct cfg80211_unsol_bcast_probe_resp {
1137 u32 interval;
1138 size_t tmpl_len;
1139 const u8 *tmpl;
1140};
1141
1142/**
1143 * enum cfg80211_ap_settings_flags - AP settings flags
1144 *
1145 * Used by cfg80211_ap_settings
1146 *
1147 * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
1148 */
1149enum cfg80211_ap_settings_flags {
1150 AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
1151};
1152
1153/**
1154 * struct cfg80211_ap_settings - AP configuration
1155 *
1156 * Used to configure an AP interface.
1157 *
1158 * @chandef: defines the channel to use
1159 * @beacon: beacon data
1160 * @beacon_interval: beacon interval
1161 * @dtim_period: DTIM period
1162 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1163 * user space)
1164 * @ssid_len: length of @ssid
1165 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1166 * @crypto: crypto settings
1167 * @privacy: the BSS uses privacy
1168 * @auth_type: Authentication type (algorithm)
1169 * @smps_mode: SMPS mode
1170 * @inactivity_timeout: time in seconds to determine station's inactivity.
1171 * @p2p_ctwindow: P2P CT Window
1172 * @p2p_opp_ps: P2P opportunistic PS
1173 * @acl: ACL configuration used by the drivers which has support for
1174 * MAC address based access control
1175 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1176 * networks.
1177 * @beacon_rate: bitrate to be used for beacons
1178 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1179 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1180 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1181 * @ht_required: stations must support HT
1182 * @vht_required: stations must support VHT
1183 * @twt_responder: Enable Target Wait Time
1184 * @he_required: stations must support HE
1185 * @sae_h2e_required: stations must support direct H2E technique in SAE
1186 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1187 * @he_obss_pd: OBSS Packet Detection settings
1188 * @he_bss_color: BSS Color settings
1189 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1190 * @fils_discovery: FILS discovery transmission parameters
1191 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1192 */
1193struct cfg80211_ap_settings {
1194 struct cfg80211_chan_def chandef;
1195
1196 struct cfg80211_beacon_data beacon;
1197
1198 int beacon_interval, dtim_period;
1199 const u8 *ssid;
1200 size_t ssid_len;
1201 enum nl80211_hidden_ssid hidden_ssid;
1202 struct cfg80211_crypto_settings crypto;
1203 bool privacy;
1204 enum nl80211_auth_type auth_type;
1205 enum nl80211_smps_mode smps_mode;
1206 int inactivity_timeout;
1207 u8 p2p_ctwindow;
1208 bool p2p_opp_ps;
1209 const struct cfg80211_acl_data *acl;
1210 bool pbss;
1211 struct cfg80211_bitrate_mask beacon_rate;
1212
1213 const struct ieee80211_ht_cap *ht_cap;
1214 const struct ieee80211_vht_cap *vht_cap;
1215 const struct ieee80211_he_cap_elem *he_cap;
1216 const struct ieee80211_he_operation *he_oper;
1217 bool ht_required, vht_required, he_required, sae_h2e_required;
1218 bool twt_responder;
1219 u32 flags;
1220 struct ieee80211_he_obss_pd he_obss_pd;
1221 struct cfg80211_he_bss_color he_bss_color;
1222 struct cfg80211_fils_discovery fils_discovery;
1223 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1224};
1225
1226/**
1227 * struct cfg80211_csa_settings - channel switch settings
1228 *
1229 * Used for channel switch
1230 *
1231 * @chandef: defines the channel to use after the switch
1232 * @beacon_csa: beacon data while performing the switch
1233 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1234 * @counter_offsets_presp: offsets of the counters within the probe response
1235 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1236 * @n_counter_offsets_presp: number of csa counters in the probe response
1237 * @beacon_after: beacon data to be used on the new channel
1238 * @radar_required: whether radar detection is required on the new channel
1239 * @block_tx: whether transmissions should be blocked while changing
1240 * @count: number of beacons until switch
1241 */
1242struct cfg80211_csa_settings {
1243 struct cfg80211_chan_def chandef;
1244 struct cfg80211_beacon_data beacon_csa;
1245 const u16 *counter_offsets_beacon;
1246 const u16 *counter_offsets_presp;
1247 unsigned int n_counter_offsets_beacon;
1248 unsigned int n_counter_offsets_presp;
1249 struct cfg80211_beacon_data beacon_after;
1250 bool radar_required;
1251 bool block_tx;
1252 u8 count;
1253};
1254
1255/**
1256 * struct iface_combination_params - input parameters for interface combinations
1257 *
1258 * Used to pass interface combination parameters
1259 *
1260 * @num_different_channels: the number of different channels we want
1261 * to use for verification
1262 * @radar_detect: a bitmap where each bit corresponds to a channel
1263 * width where radar detection is needed, as in the definition of
1264 * &struct ieee80211_iface_combination.@radar_detect_widths
1265 * @iftype_num: array with the number of interfaces of each interface
1266 * type. The index is the interface type as specified in &enum
1267 * nl80211_iftype.
1268 * @new_beacon_int: set this to the beacon interval of a new interface
1269 * that's not operating yet, if such is to be checked as part of
1270 * the verification
1271 */
1272struct iface_combination_params {
1273 int num_different_channels;
1274 u8 radar_detect;
1275 int iftype_num[NUM_NL80211_IFTYPES];
1276 u32 new_beacon_int;
1277};
1278
1279/**
1280 * enum station_parameters_apply_mask - station parameter values to apply
1281 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1282 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1283 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1284 *
1285 * Not all station parameters have in-band "no change" signalling,
1286 * for those that don't these flags will are used.
1287 */
1288enum station_parameters_apply_mask {
1289 STATION_PARAM_APPLY_UAPSD = BIT(0),
1290 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1291 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1292 STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1293};
1294
1295/**
1296 * struct sta_txpwr - station txpower configuration
1297 *
1298 * Used to configure txpower for station.
1299 *
1300 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1301 * is not provided, the default per-interface tx power setting will be
1302 * overriding. Driver should be picking up the lowest tx power, either tx
1303 * power per-interface or per-station.
1304 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1305 * will be less than or equal to specified from userspace, whereas if TPC
1306 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1307 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1308 * per peer TPC.
1309 */
1310struct sta_txpwr {
1311 s16 power;
1312 enum nl80211_tx_power_setting type;
1313};
1314
1315/**
1316 * struct station_parameters - station parameters
1317 *
1318 * Used to change and create a new station.
1319 *
1320 * @vlan: vlan interface station should belong to
1321 * @supported_rates: supported rates in IEEE 802.11 format
1322 * (or NULL for no change)
1323 * @supported_rates_len: number of supported rates
1324 * @sta_flags_mask: station flags that changed
1325 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1326 * @sta_flags_set: station flags values
1327 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1328 * @listen_interval: listen interval or -1 for no change
1329 * @aid: AID or zero for no change
1330 * @vlan_id: VLAN ID for station (if nonzero)
1331 * @peer_aid: mesh peer AID or zero for no change
1332 * @plink_action: plink action to take
1333 * @plink_state: set the peer link state for a station
1334 * @ht_capa: HT capabilities of station
1335 * @vht_capa: VHT capabilities of station
1336 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1337 * as the AC bitmap in the QoS info field
1338 * @max_sp: max Service Period. same format as the MAX_SP in the
1339 * QoS info field (but already shifted down)
1340 * @sta_modify_mask: bitmap indicating which parameters changed
1341 * (for those that don't have a natural "no change" value),
1342 * see &enum station_parameters_apply_mask
1343 * @local_pm: local link-specific mesh power save mode (no change when set
1344 * to unknown)
1345 * @capability: station capability
1346 * @ext_capab: extended capabilities of the station
1347 * @ext_capab_len: number of extended capabilities
1348 * @supported_channels: supported channels in IEEE 802.11 format
1349 * @supported_channels_len: number of supported channels
1350 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1351 * @supported_oper_classes_len: number of supported operating classes
1352 * @opmode_notif: operating mode field from Operating Mode Notification
1353 * @opmode_notif_used: information if operating mode field is used
1354 * @support_p2p_ps: information if station supports P2P PS mechanism
1355 * @he_capa: HE capabilities of station
1356 * @he_capa_len: the length of the HE capabilities
1357 * @airtime_weight: airtime scheduler weight for this station
1358 * @txpwr: transmit power for an associated station
1359 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1360 */
1361struct station_parameters {
1362 const u8 *supported_rates;
1363 struct net_device *vlan;
1364 u32 sta_flags_mask, sta_flags_set;
1365 u32 sta_modify_mask;
1366 int listen_interval;
1367 u16 aid;
1368 u16 vlan_id;
1369 u16 peer_aid;
1370 u8 supported_rates_len;
1371 u8 plink_action;
1372 u8 plink_state;
1373 const struct ieee80211_ht_cap *ht_capa;
1374 const struct ieee80211_vht_cap *vht_capa;
1375 u8 uapsd_queues;
1376 u8 max_sp;
1377 enum nl80211_mesh_power_mode local_pm;
1378 u16 capability;
1379 const u8 *ext_capab;
1380 u8 ext_capab_len;
1381 const u8 *supported_channels;
1382 u8 supported_channels_len;
1383 const u8 *supported_oper_classes;
1384 u8 supported_oper_classes_len;
1385 u8 opmode_notif;
1386 bool opmode_notif_used;
1387 int support_p2p_ps;
1388 const struct ieee80211_he_cap_elem *he_capa;
1389 u8 he_capa_len;
1390 u16 airtime_weight;
1391 struct sta_txpwr txpwr;
1392 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1393};
1394
1395/**
1396 * struct station_del_parameters - station deletion parameters
1397 *
1398 * Used to delete a station entry (or all stations).
1399 *
1400 * @mac: MAC address of the station to remove or NULL to remove all stations
1401 * @subtype: Management frame subtype to use for indicating removal
1402 * (10 = Disassociation, 12 = Deauthentication)
1403 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1404 */
1405struct station_del_parameters {
1406 const u8 *mac;
1407 u8 subtype;
1408 u16 reason_code;
1409};
1410
1411/**
1412 * enum cfg80211_station_type - the type of station being modified
1413 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1414 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1415 * unassociated (update properties for this type of client is permitted)
1416 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1417 * the AP MLME in the device
1418 * @CFG80211_STA_AP_STA: AP station on managed interface
1419 * @CFG80211_STA_IBSS: IBSS station
1420 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1421 * while TDLS setup is in progress, it moves out of this state when
1422 * being marked authorized; use this only if TDLS with external setup is
1423 * supported/used)
1424 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1425 * entry that is operating, has been marked authorized by userspace)
1426 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1427 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1428 */
1429enum cfg80211_station_type {
1430 CFG80211_STA_AP_CLIENT,
1431 CFG80211_STA_AP_CLIENT_UNASSOC,
1432 CFG80211_STA_AP_MLME_CLIENT,
1433 CFG80211_STA_AP_STA,
1434 CFG80211_STA_IBSS,
1435 CFG80211_STA_TDLS_PEER_SETUP,
1436 CFG80211_STA_TDLS_PEER_ACTIVE,
1437 CFG80211_STA_MESH_PEER_KERNEL,
1438 CFG80211_STA_MESH_PEER_USER,
1439};
1440
1441/**
1442 * cfg80211_check_station_change - validate parameter changes
1443 * @wiphy: the wiphy this operates on
1444 * @params: the new parameters for a station
1445 * @statype: the type of station being modified
1446 *
1447 * Utility function for the @change_station driver method. Call this function
1448 * with the appropriate station type looking up the station (and checking that
1449 * it exists). It will verify whether the station change is acceptable, and if
1450 * not will return an error code. Note that it may modify the parameters for
1451 * backward compatibility reasons, so don't use them before calling this.
1452 */
1453int cfg80211_check_station_change(struct wiphy *wiphy,
1454 struct station_parameters *params,
1455 enum cfg80211_station_type statype);
1456
1457/**
1458 * enum rate_info_flags - bitrate info flags
1459 *
1460 * Used by the driver to indicate the specific rate transmission
1461 * type for 802.11n transmissions.
1462 *
1463 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1464 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1465 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1466 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1467 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1468 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1469 * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS
1470 */
1471enum rate_info_flags {
1472 RATE_INFO_FLAGS_MCS = BIT(0),
1473 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1474 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1475 RATE_INFO_FLAGS_DMG = BIT(3),
1476 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1477 RATE_INFO_FLAGS_EDMG = BIT(5),
1478 RATE_INFO_FLAGS_EXTENDED_SC_DMG = BIT(6),
1479};
1480
1481/**
1482 * enum rate_info_bw - rate bandwidth information
1483 *
1484 * Used by the driver to indicate the rate bandwidth.
1485 *
1486 * @RATE_INFO_BW_5: 5 MHz bandwidth
1487 * @RATE_INFO_BW_10: 10 MHz bandwidth
1488 * @RATE_INFO_BW_20: 20 MHz bandwidth
1489 * @RATE_INFO_BW_40: 40 MHz bandwidth
1490 * @RATE_INFO_BW_80: 80 MHz bandwidth
1491 * @RATE_INFO_BW_160: 160 MHz bandwidth
1492 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1493 */
1494enum rate_info_bw {
1495 RATE_INFO_BW_20 = 0,
1496 RATE_INFO_BW_5,
1497 RATE_INFO_BW_10,
1498 RATE_INFO_BW_40,
1499 RATE_INFO_BW_80,
1500 RATE_INFO_BW_160,
1501 RATE_INFO_BW_HE_RU,
1502};
1503
1504/**
1505 * struct rate_info - bitrate information
1506 *
1507 * Information about a receiving or transmitting bitrate
1508 *
1509 * @flags: bitflag of flags from &enum rate_info_flags
1510 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1511 * @legacy: bitrate in 100kbit/s for 802.11abg
1512 * @nss: number of streams (VHT & HE only)
1513 * @bw: bandwidth (from &enum rate_info_bw)
1514 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1515 * @he_dcm: HE DCM value
1516 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1517 * only valid if bw is %RATE_INFO_BW_HE_RU)
1518 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1519 */
1520struct rate_info {
1521 u8 flags;
1522 u8 mcs;
1523 u16 legacy;
1524 u8 nss;
1525 u8 bw;
1526 u8 he_gi;
1527 u8 he_dcm;
1528 u8 he_ru_alloc;
1529 u8 n_bonded_ch;
1530};
1531
1532/**
1533 * enum bss_param_flags - bitrate info flags
1534 *
1535 * Used by the driver to indicate the specific rate transmission
1536 * type for 802.11n transmissions.
1537 *
1538 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1539 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1540 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1541 */
1542enum bss_param_flags {
1543 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1544 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1545 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1546};
1547
1548/**
1549 * struct sta_bss_parameters - BSS parameters for the attached station
1550 *
1551 * Information about the currently associated BSS
1552 *
1553 * @flags: bitflag of flags from &enum bss_param_flags
1554 * @dtim_period: DTIM period for the BSS
1555 * @beacon_interval: beacon interval
1556 */
1557struct sta_bss_parameters {
1558 u8 flags;
1559 u8 dtim_period;
1560 u16 beacon_interval;
1561};
1562
1563/**
1564 * struct cfg80211_txq_stats - TXQ statistics for this TID
1565 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1566 * indicate the relevant values in this struct are filled
1567 * @backlog_bytes: total number of bytes currently backlogged
1568 * @backlog_packets: total number of packets currently backlogged
1569 * @flows: number of new flows seen
1570 * @drops: total number of packets dropped
1571 * @ecn_marks: total number of packets marked with ECN CE
1572 * @overlimit: number of drops due to queue space overflow
1573 * @overmemory: number of drops due to memory limit overflow
1574 * @collisions: number of hash collisions
1575 * @tx_bytes: total number of bytes dequeued
1576 * @tx_packets: total number of packets dequeued
1577 * @max_flows: maximum number of flows supported
1578 */
1579struct cfg80211_txq_stats {
1580 u32 filled;
1581 u32 backlog_bytes;
1582 u32 backlog_packets;
1583 u32 flows;
1584 u32 drops;
1585 u32 ecn_marks;
1586 u32 overlimit;
1587 u32 overmemory;
1588 u32 collisions;
1589 u32 tx_bytes;
1590 u32 tx_packets;
1591 u32 max_flows;
1592};
1593
1594/**
1595 * struct cfg80211_tid_stats - per-TID statistics
1596 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1597 * indicate the relevant values in this struct are filled
1598 * @rx_msdu: number of received MSDUs
1599 * @tx_msdu: number of (attempted) transmitted MSDUs
1600 * @tx_msdu_retries: number of retries (not counting the first) for
1601 * transmitted MSDUs
1602 * @tx_msdu_failed: number of failed transmitted MSDUs
1603 * @txq_stats: TXQ statistics
1604 */
1605struct cfg80211_tid_stats {
1606 u32 filled;
1607 u64 rx_msdu;
1608 u64 tx_msdu;
1609 u64 tx_msdu_retries;
1610 u64 tx_msdu_failed;
1611 struct cfg80211_txq_stats txq_stats;
1612};
1613
1614#define IEEE80211_MAX_CHAINS 4
1615
1616/**
1617 * struct station_info - station information
1618 *
1619 * Station information filled by driver for get_station() and dump_station.
1620 *
1621 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1622 * indicate the relevant values in this struct for them
1623 * @connected_time: time(in secs) since a station is last connected
1624 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1625 * @assoc_at: bootime (ns) of the last association
1626 * @rx_bytes: bytes (size of MPDUs) received from this station
1627 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1628 * @llid: mesh local link id
1629 * @plid: mesh peer link id
1630 * @plink_state: mesh peer link state
1631 * @signal: The signal strength, type depends on the wiphy's signal_type.
1632 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1633 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1634 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1635 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1636 * @chain_signal: per-chain signal strength of last received packet in dBm
1637 * @chain_signal_avg: per-chain signal strength average in dBm
1638 * @txrate: current unicast bitrate from this station
1639 * @rxrate: current unicast bitrate to this station
1640 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1641 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1642 * @tx_retries: cumulative retry counts (MPDUs)
1643 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1644 * @rx_dropped_misc: Dropped for un-specified reason.
1645 * @bss_param: current BSS parameters
1646 * @generation: generation number for nl80211 dumps.
1647 * This number should increase every time the list of stations
1648 * changes, i.e. when a station is added or removed, so that
1649 * userspace can tell whether it got a consistent snapshot.
1650 * @assoc_req_ies: IEs from (Re)Association Request.
1651 * This is used only when in AP mode with drivers that do not use
1652 * user space MLME/SME implementation. The information is provided for
1653 * the cfg80211_new_sta() calls to notify user space of the IEs.
1654 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1655 * @sta_flags: station flags mask & values
1656 * @beacon_loss_count: Number of times beacon loss event has triggered.
1657 * @t_offset: Time offset of the station relative to this host.
1658 * @local_pm: local mesh STA power save mode
1659 * @peer_pm: peer mesh STA power save mode
1660 * @nonpeer_pm: non-peer mesh STA power save mode
1661 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1662 * towards this station.
1663 * @rx_beacon: number of beacons received from this peer
1664 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1665 * from this peer
1666 * @connected_to_gate: true if mesh STA has a path to mesh gate
1667 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1668 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1669 * @airtime_weight: current airtime scheduling weight
1670 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1671 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1672 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1673 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1674 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1675 * been sent.
1676 * @rx_mpdu_count: number of MPDUs received from this station
1677 * @fcs_err_count: number of packets (MPDUs) received from this station with
1678 * an FCS error. This counter should be incremented only when TA of the
1679 * received packet with an FCS error matches the peer MAC address.
1680 * @airtime_link_metric: mesh airtime link metric.
1681 * @connected_to_as: true if mesh STA has a path to authentication server
1682 */
1683struct station_info {
1684 u64 filled;
1685 u32 connected_time;
1686 u32 inactive_time;
1687 u64 assoc_at;
1688 u64 rx_bytes;
1689 u64 tx_bytes;
1690 u16 llid;
1691 u16 plid;
1692 u8 plink_state;
1693 s8 signal;
1694 s8 signal_avg;
1695
1696 u8 chains;
1697 s8 chain_signal[IEEE80211_MAX_CHAINS];
1698 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1699
1700 struct rate_info txrate;
1701 struct rate_info rxrate;
1702 u32 rx_packets;
1703 u32 tx_packets;
1704 u32 tx_retries;
1705 u32 tx_failed;
1706 u32 rx_dropped_misc;
1707 struct sta_bss_parameters bss_param;
1708 struct nl80211_sta_flag_update sta_flags;
1709
1710 int generation;
1711
1712 const u8 *assoc_req_ies;
1713 size_t assoc_req_ies_len;
1714
1715 u32 beacon_loss_count;
1716 s64 t_offset;
1717 enum nl80211_mesh_power_mode local_pm;
1718 enum nl80211_mesh_power_mode peer_pm;
1719 enum nl80211_mesh_power_mode nonpeer_pm;
1720
1721 u32 expected_throughput;
1722
1723 u64 tx_duration;
1724 u64 rx_duration;
1725 u64 rx_beacon;
1726 u8 rx_beacon_signal_avg;
1727 u8 connected_to_gate;
1728
1729 struct cfg80211_tid_stats *pertid;
1730 s8 ack_signal;
1731 s8 avg_ack_signal;
1732
1733 u16 airtime_weight;
1734
1735 u32 rx_mpdu_count;
1736 u32 fcs_err_count;
1737
1738 u32 airtime_link_metric;
1739
1740 u8 connected_to_as;
1741};
1742
1743/**
1744 * struct cfg80211_sar_sub_specs - sub specs limit
1745 * @power: power limitation in 0.25dbm
1746 * @freq_range_index: index the power limitation applies to
1747 */
1748struct cfg80211_sar_sub_specs {
1749 s32 power;
1750 u32 freq_range_index;
1751};
1752
1753/**
1754 * struct cfg80211_sar_specs - sar limit specs
1755 * @type: it's set with power in 0.25dbm or other types
1756 * @num_sub_specs: number of sar sub specs
1757 * @sub_specs: memory to hold the sar sub specs
1758 */
1759struct cfg80211_sar_specs {
1760 enum nl80211_sar_type type;
1761 u32 num_sub_specs;
1762 struct cfg80211_sar_sub_specs sub_specs[];
1763};
1764
1765
1766/**
1767 * struct cfg80211_sar_freq_ranges - sar frequency ranges
1768 * @start_freq: start range edge frequency
1769 * @end_freq: end range edge frequency
1770 */
1771struct cfg80211_sar_freq_ranges {
1772 u32 start_freq;
1773 u32 end_freq;
1774};
1775
1776/**
1777 * struct cfg80211_sar_capa - sar limit capability
1778 * @type: it's set via power in 0.25dbm or other types
1779 * @num_freq_ranges: number of frequency ranges
1780 * @freq_ranges: memory to hold the freq ranges.
1781 *
1782 * Note: WLAN driver may append new ranges or split an existing
1783 * range to small ones and then append them.
1784 */
1785struct cfg80211_sar_capa {
1786 enum nl80211_sar_type type;
1787 u32 num_freq_ranges;
1788 const struct cfg80211_sar_freq_ranges *freq_ranges;
1789};
1790
1791#if IS_ENABLED(CONFIG_CFG80211)
1792/**
1793 * cfg80211_get_station - retrieve information about a given station
1794 * @dev: the device where the station is supposed to be connected to
1795 * @mac_addr: the mac address of the station of interest
1796 * @sinfo: pointer to the structure to fill with the information
1797 *
1798 * Returns 0 on success and sinfo is filled with the available information
1799 * otherwise returns a negative error code and the content of sinfo has to be
1800 * considered undefined.
1801 */
1802int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1803 struct station_info *sinfo);
1804#else
1805static inline int cfg80211_get_station(struct net_device *dev,
1806 const u8 *mac_addr,
1807 struct station_info *sinfo)
1808{
1809 return -ENOENT;
1810}
1811#endif
1812
1813/**
1814 * enum monitor_flags - monitor flags
1815 *
1816 * Monitor interface configuration flags. Note that these must be the bits
1817 * according to the nl80211 flags.
1818 *
1819 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1820 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1821 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1822 * @MONITOR_FLAG_CONTROL: pass control frames
1823 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1824 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1825 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1826 */
1827enum monitor_flags {
1828 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1829 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1830 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1831 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1832 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1833 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1834 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1835};
1836
1837/**
1838 * enum mpath_info_flags - mesh path information flags
1839 *
1840 * Used by the driver to indicate which info in &struct mpath_info it has filled
1841 * in during get_station() or dump_station().
1842 *
1843 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1844 * @MPATH_INFO_SN: @sn filled
1845 * @MPATH_INFO_METRIC: @metric filled
1846 * @MPATH_INFO_EXPTIME: @exptime filled
1847 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1848 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1849 * @MPATH_INFO_FLAGS: @flags filled
1850 * @MPATH_INFO_HOP_COUNT: @hop_count filled
1851 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1852 */
1853enum mpath_info_flags {
1854 MPATH_INFO_FRAME_QLEN = BIT(0),
1855 MPATH_INFO_SN = BIT(1),
1856 MPATH_INFO_METRIC = BIT(2),
1857 MPATH_INFO_EXPTIME = BIT(3),
1858 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1859 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1860 MPATH_INFO_FLAGS = BIT(6),
1861 MPATH_INFO_HOP_COUNT = BIT(7),
1862 MPATH_INFO_PATH_CHANGE = BIT(8),
1863};
1864
1865/**
1866 * struct mpath_info - mesh path information
1867 *
1868 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1869 *
1870 * @filled: bitfield of flags from &enum mpath_info_flags
1871 * @frame_qlen: number of queued frames for this destination
1872 * @sn: target sequence number
1873 * @metric: metric (cost) of this mesh path
1874 * @exptime: expiration time for the mesh path from now, in msecs
1875 * @flags: mesh path flags
1876 * @discovery_timeout: total mesh path discovery timeout, in msecs
1877 * @discovery_retries: mesh path discovery retries
1878 * @generation: generation number for nl80211 dumps.
1879 * This number should increase every time the list of mesh paths
1880 * changes, i.e. when a station is added or removed, so that
1881 * userspace can tell whether it got a consistent snapshot.
1882 * @hop_count: hops to destination
1883 * @path_change_count: total number of path changes to destination
1884 */
1885struct mpath_info {
1886 u32 filled;
1887 u32 frame_qlen;
1888 u32 sn;
1889 u32 metric;
1890 u32 exptime;
1891 u32 discovery_timeout;
1892 u8 discovery_retries;
1893 u8 flags;
1894 u8 hop_count;
1895 u32 path_change_count;
1896
1897 int generation;
1898};
1899
1900/**
1901 * struct bss_parameters - BSS parameters
1902 *
1903 * Used to change BSS parameters (mainly for AP mode).
1904 *
1905 * @use_cts_prot: Whether to use CTS protection
1906 * (0 = no, 1 = yes, -1 = do not change)
1907 * @use_short_preamble: Whether the use of short preambles is allowed
1908 * (0 = no, 1 = yes, -1 = do not change)
1909 * @use_short_slot_time: Whether the use of short slot time is allowed
1910 * (0 = no, 1 = yes, -1 = do not change)
1911 * @basic_rates: basic rates in IEEE 802.11 format
1912 * (or NULL for no change)
1913 * @basic_rates_len: number of basic rates
1914 * @ap_isolate: do not forward packets between connected stations
1915 * (0 = no, 1 = yes, -1 = do not change)
1916 * @ht_opmode: HT Operation mode
1917 * (u16 = opmode, -1 = do not change)
1918 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1919 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1920 */
1921struct bss_parameters {
1922 int use_cts_prot;
1923 int use_short_preamble;
1924 int use_short_slot_time;
1925 const u8 *basic_rates;
1926 u8 basic_rates_len;
1927 int ap_isolate;
1928 int ht_opmode;
1929 s8 p2p_ctwindow, p2p_opp_ps;
1930};
1931
1932/**
1933 * struct mesh_config - 802.11s mesh configuration
1934 *
1935 * These parameters can be changed while the mesh is active.
1936 *
1937 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1938 * by the Mesh Peering Open message
1939 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1940 * used by the Mesh Peering Open message
1941 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1942 * the mesh peering management to close a mesh peering
1943 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1944 * mesh interface
1945 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1946 * be sent to establish a new peer link instance in a mesh
1947 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1948 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1949 * elements
1950 * @auto_open_plinks: whether we should automatically open peer links when we
1951 * detect compatible mesh peers
1952 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1953 * synchronize to for 11s default synchronization method
1954 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1955 * that an originator mesh STA can send to a particular path target
1956 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1957 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1958 * a path discovery in milliseconds
1959 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1960 * receiving a PREQ shall consider the forwarding information from the
1961 * root to be valid. (TU = time unit)
1962 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1963 * which a mesh STA can send only one action frame containing a PREQ
1964 * element
1965 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1966 * which a mesh STA can send only one Action frame containing a PERR
1967 * element
1968 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1969 * it takes for an HWMP information element to propagate across the mesh
1970 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1971 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1972 * announcements are transmitted
1973 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1974 * station has access to a broader network beyond the MBSS. (This is
1975 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1976 * only means that the station will announce others it's a mesh gate, but
1977 * not necessarily using the gate announcement protocol. Still keeping the
1978 * same nomenclature to be in sync with the spec)
1979 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1980 * entity (default is TRUE - forwarding entity)
1981 * @rssi_threshold: the threshold for average signal strength of candidate
1982 * station to establish a peer link
1983 * @ht_opmode: mesh HT protection mode
1984 *
1985 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1986 * receiving a proactive PREQ shall consider the forwarding information to
1987 * the root mesh STA to be valid.
1988 *
1989 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1990 * PREQs are transmitted.
1991 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1992 * during which a mesh STA can send only one Action frame containing
1993 * a PREQ element for root path confirmation.
1994 * @power_mode: The default mesh power save mode which will be the initial
1995 * setting for new peer links.
1996 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1997 * after transmitting its beacon.
1998 * @plink_timeout: If no tx activity is seen from a STA we've established
1999 * peering with for longer than this time (in seconds), then remove it
2000 * from the STA's list of peers. Default is 30 minutes.
2001 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
2002 * connected to a mesh gate in mesh formation info. If false, the
2003 * value in mesh formation is determined by the presence of root paths
2004 * in the mesh path table
2005 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
2006 * for HWMP) if the destination is a direct neighbor. Note that this might
2007 * not be the optimal decision as a multi-hop route might be better. So
2008 * if using this setting you will likely also want to disable
2009 * dot11MeshForwarding and use another mesh routing protocol on top.
2010 */
2011struct mesh_config {
2012 u16 dot11MeshRetryTimeout;
2013 u16 dot11MeshConfirmTimeout;
2014 u16 dot11MeshHoldingTimeout;
2015 u16 dot11MeshMaxPeerLinks;
2016 u8 dot11MeshMaxRetries;
2017 u8 dot11MeshTTL;
2018 u8 element_ttl;
2019 bool auto_open_plinks;
2020 u32 dot11MeshNbrOffsetMaxNeighbor;
2021 u8 dot11MeshHWMPmaxPREQretries;
2022 u32 path_refresh_time;
2023 u16 min_discovery_timeout;
2024 u32 dot11MeshHWMPactivePathTimeout;
2025 u16 dot11MeshHWMPpreqMinInterval;
2026 u16 dot11MeshHWMPperrMinInterval;
2027 u16 dot11MeshHWMPnetDiameterTraversalTime;
2028 u8 dot11MeshHWMPRootMode;
2029 bool dot11MeshConnectedToMeshGate;
2030 bool dot11MeshConnectedToAuthServer;
2031 u16 dot11MeshHWMPRannInterval;
2032 bool dot11MeshGateAnnouncementProtocol;
2033 bool dot11MeshForwarding;
2034 s32 rssi_threshold;
2035 u16 ht_opmode;
2036 u32 dot11MeshHWMPactivePathToRootTimeout;
2037 u16 dot11MeshHWMProotInterval;
2038 u16 dot11MeshHWMPconfirmationInterval;
2039 enum nl80211_mesh_power_mode power_mode;
2040 u16 dot11MeshAwakeWindowDuration;
2041 u32 plink_timeout;
2042 bool dot11MeshNolearn;
2043};
2044
2045/**
2046 * struct mesh_setup - 802.11s mesh setup configuration
2047 * @chandef: defines the channel to use
2048 * @mesh_id: the mesh ID
2049 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
2050 * @sync_method: which synchronization method to use
2051 * @path_sel_proto: which path selection protocol to use
2052 * @path_metric: which metric to use
2053 * @auth_id: which authentication method this mesh is using
2054 * @ie: vendor information elements (optional)
2055 * @ie_len: length of vendor information elements
2056 * @is_authenticated: this mesh requires authentication
2057 * @is_secure: this mesh uses security
2058 * @user_mpm: userspace handles all MPM functions
2059 * @dtim_period: DTIM period to use
2060 * @beacon_interval: beacon interval to use
2061 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2062 * @basic_rates: basic rates to use when creating the mesh
2063 * @beacon_rate: bitrate to be used for beacons
2064 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2065 * changes the channel when a radar is detected. This is required
2066 * to operate on DFS channels.
2067 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2068 * port frames over NL80211 instead of the network interface.
2069 *
2070 * These parameters are fixed when the mesh is created.
2071 */
2072struct mesh_setup {
2073 struct cfg80211_chan_def chandef;
2074 const u8 *mesh_id;
2075 u8 mesh_id_len;
2076 u8 sync_method;
2077 u8 path_sel_proto;
2078 u8 path_metric;
2079 u8 auth_id;
2080 const u8 *ie;
2081 u8 ie_len;
2082 bool is_authenticated;
2083 bool is_secure;
2084 bool user_mpm;
2085 u8 dtim_period;
2086 u16 beacon_interval;
2087 int mcast_rate[NUM_NL80211_BANDS];
2088 u32 basic_rates;
2089 struct cfg80211_bitrate_mask beacon_rate;
2090 bool userspace_handles_dfs;
2091 bool control_port_over_nl80211;
2092};
2093
2094/**
2095 * struct ocb_setup - 802.11p OCB mode setup configuration
2096 * @chandef: defines the channel to use
2097 *
2098 * These parameters are fixed when connecting to the network
2099 */
2100struct ocb_setup {
2101 struct cfg80211_chan_def chandef;
2102};
2103
2104/**
2105 * struct ieee80211_txq_params - TX queue parameters
2106 * @ac: AC identifier
2107 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2108 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2109 * 1..32767]
2110 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2111 * 1..32767]
2112 * @aifs: Arbitration interframe space [0..255]
2113 */
2114struct ieee80211_txq_params {
2115 enum nl80211_ac ac;
2116 u16 txop;
2117 u16 cwmin;
2118 u16 cwmax;
2119 u8 aifs;
2120};
2121
2122/**
2123 * DOC: Scanning and BSS list handling
2124 *
2125 * The scanning process itself is fairly simple, but cfg80211 offers quite
2126 * a bit of helper functionality. To start a scan, the scan operation will
2127 * be invoked with a scan definition. This scan definition contains the
2128 * channels to scan, and the SSIDs to send probe requests for (including the
2129 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2130 * probe. Additionally, a scan request may contain extra information elements
2131 * that should be added to the probe request. The IEs are guaranteed to be
2132 * well-formed, and will not exceed the maximum length the driver advertised
2133 * in the wiphy structure.
2134 *
2135 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2136 * it is responsible for maintaining the BSS list; the driver should not
2137 * maintain a list itself. For this notification, various functions exist.
2138 *
2139 * Since drivers do not maintain a BSS list, there are also a number of
2140 * functions to search for a BSS and obtain information about it from the
2141 * BSS structure cfg80211 maintains. The BSS list is also made available
2142 * to userspace.
2143 */
2144
2145/**
2146 * struct cfg80211_ssid - SSID description
2147 * @ssid: the SSID
2148 * @ssid_len: length of the ssid
2149 */
2150struct cfg80211_ssid {
2151 u8 ssid[IEEE80211_MAX_SSID_LEN];
2152 u8 ssid_len;
2153};
2154
2155/**
2156 * struct cfg80211_scan_info - information about completed scan
2157 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2158 * wireless device that requested the scan is connected to. If this
2159 * information is not available, this field is left zero.
2160 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2161 * @aborted: set to true if the scan was aborted for any reason,
2162 * userspace will be notified of that
2163 */
2164struct cfg80211_scan_info {
2165 u64 scan_start_tsf;
2166 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2167 bool aborted;
2168};
2169
2170/**
2171 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2172 *
2173 * @short_bssid: short ssid to scan for
2174 * @bssid: bssid to scan for
2175 * @channel_idx: idx of the channel in the channel array in the scan request
2176 * which the above info relvant to
2177 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2178 * @short_ssid_valid: short_ssid is valid and can be used
2179 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2180 * 20 TUs before starting to send probe requests.
2181 */
2182struct cfg80211_scan_6ghz_params {
2183 u32 short_ssid;
2184 u32 channel_idx;
2185 u8 bssid[ETH_ALEN];
2186 bool unsolicited_probe;
2187 bool short_ssid_valid;
2188 bool psc_no_listen;
2189};
2190
2191/**
2192 * struct cfg80211_scan_request - scan request description
2193 *
2194 * @ssids: SSIDs to scan for (active scan only)
2195 * @n_ssids: number of SSIDs
2196 * @channels: channels to scan on.
2197 * @n_channels: total number of channels to scan
2198 * @scan_width: channel width for scanning
2199 * @ie: optional information element(s) to add into Probe Request or %NULL
2200 * @ie_len: length of ie in octets
2201 * @duration: how long to listen on each channel, in TUs. If
2202 * %duration_mandatory is not set, this is the maximum dwell time and
2203 * the actual dwell time may be shorter.
2204 * @duration_mandatory: if set, the scan duration must be as specified by the
2205 * %duration field.
2206 * @flags: bit field of flags controlling operation
2207 * @rates: bitmap of rates to advertise for each band
2208 * @wiphy: the wiphy this was for
2209 * @scan_start: time (in jiffies) when the scan started
2210 * @wdev: the wireless device to scan for
2211 * @info: (internal) information about completed scan
2212 * @notified: (internal) scan request was notified as done or aborted
2213 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2214 * @mac_addr: MAC address used with randomisation
2215 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2216 * are 0 in the mask should be randomised, bits that are 1 should
2217 * be taken from the @mac_addr
2218 * @scan_6ghz: relevant for split scan request only,
2219 * true if this is the second scan request
2220 * @n_6ghz_params: number of 6 GHz params
2221 * @scan_6ghz_params: 6 GHz params
2222 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2223 */
2224struct cfg80211_scan_request {
2225 struct cfg80211_ssid *ssids;
2226 int n_ssids;
2227 u32 n_channels;
2228 enum nl80211_bss_scan_width scan_width;
2229 const u8 *ie;
2230 size_t ie_len;
2231 u16 duration;
2232 bool duration_mandatory;
2233 u32 flags;
2234
2235 u32 rates[NUM_NL80211_BANDS];
2236
2237 struct wireless_dev *wdev;
2238
2239 u8 mac_addr[ETH_ALEN] __aligned(2);
2240 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2241 u8 bssid[ETH_ALEN] __aligned(2);
2242
2243 /* internal */
2244 struct wiphy *wiphy;
2245 unsigned long scan_start;
2246 struct cfg80211_scan_info info;
2247 bool notified;
2248 bool no_cck;
2249 bool scan_6ghz;
2250 u32 n_6ghz_params;
2251 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2252
2253 /* keep last */
2254 struct ieee80211_channel *channels[];
2255};
2256
2257static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2258{
2259 int i;
2260
2261 get_random_bytes(buf, ETH_ALEN);
2262 for (i = 0; i < ETH_ALEN; i++) {
2263 buf[i] &= ~mask[i];
2264 buf[i] |= addr[i] & mask[i];
2265 }
2266}
2267
2268/**
2269 * struct cfg80211_match_set - sets of attributes to match
2270 *
2271 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2272 * or no match (RSSI only)
2273 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2274 * or no match (RSSI only)
2275 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2276 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2277 * for filtering out scan results received. Drivers advertize this support
2278 * of band specific rssi based filtering through the feature capability
2279 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2280 * specific rssi thresholds take precedence over rssi_thold, if specified.
2281 * If not specified for any band, it will be assigned with rssi_thold of
2282 * corresponding matchset.
2283 */
2284struct cfg80211_match_set {
2285 struct cfg80211_ssid ssid;
2286 u8 bssid[ETH_ALEN];
2287 s32 rssi_thold;
2288 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2289};
2290
2291/**
2292 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2293 *
2294 * @interval: interval between scheduled scan iterations. In seconds.
2295 * @iterations: number of scan iterations in this scan plan. Zero means
2296 * infinite loop.
2297 * The last scan plan will always have this parameter set to zero,
2298 * all other scan plans will have a finite number of iterations.
2299 */
2300struct cfg80211_sched_scan_plan {
2301 u32 interval;
2302 u32 iterations;
2303};
2304
2305/**
2306 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2307 *
2308 * @band: band of BSS which should match for RSSI level adjustment.
2309 * @delta: value of RSSI level adjustment.
2310 */
2311struct cfg80211_bss_select_adjust {
2312 enum nl80211_band band;
2313 s8 delta;
2314};
2315
2316/**
2317 * struct cfg80211_sched_scan_request - scheduled scan request description
2318 *
2319 * @reqid: identifies this request.
2320 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2321 * @n_ssids: number of SSIDs
2322 * @n_channels: total number of channels to scan
2323 * @scan_width: channel width for scanning
2324 * @ie: optional information element(s) to add into Probe Request or %NULL
2325 * @ie_len: length of ie in octets
2326 * @flags: bit field of flags controlling operation
2327 * @match_sets: sets of parameters to be matched for a scan result
2328 * entry to be considered valid and to be passed to the host
2329 * (others are filtered out).
2330 * If ommited, all results are passed.
2331 * @n_match_sets: number of match sets
2332 * @report_results: indicates that results were reported for this request
2333 * @wiphy: the wiphy this was for
2334 * @dev: the interface
2335 * @scan_start: start time of the scheduled scan
2336 * @channels: channels to scan
2337 * @min_rssi_thold: for drivers only supporting a single threshold, this
2338 * contains the minimum over all matchsets
2339 * @mac_addr: MAC address used with randomisation
2340 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2341 * are 0 in the mask should be randomised, bits that are 1 should
2342 * be taken from the @mac_addr
2343 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2344 * index must be executed first.
2345 * @n_scan_plans: number of scan plans, at least 1.
2346 * @rcu_head: RCU callback used to free the struct
2347 * @owner_nlportid: netlink portid of owner (if this should is a request
2348 * owned by a particular socket)
2349 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2350 * @list: for keeping list of requests.
2351 * @delay: delay in seconds to use before starting the first scan
2352 * cycle. The driver may ignore this parameter and start
2353 * immediately (or at any other time), if this feature is not
2354 * supported.
2355 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2356 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2357 * reporting in connected state to cases where a matching BSS is determined
2358 * to have better or slightly worse RSSI than the current connected BSS.
2359 * The relative RSSI threshold values are ignored in disconnected state.
2360 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2361 * to the specified band while deciding whether a better BSS is reported
2362 * using @relative_rssi. If delta is a negative number, the BSSs that
2363 * belong to the specified band will be penalized by delta dB in relative
2364 * comparisions.
2365 */
2366struct cfg80211_sched_scan_request {
2367 u64 reqid;
2368 struct cfg80211_ssid *ssids;
2369 int n_ssids;
2370 u32 n_channels;
2371 enum nl80211_bss_scan_width scan_width;
2372 const u8 *ie;
2373 size_t ie_len;
2374 u32 flags;
2375 struct cfg80211_match_set *match_sets;
2376 int n_match_sets;
2377 s32 min_rssi_thold;
2378 u32 delay;
2379 struct cfg80211_sched_scan_plan *scan_plans;
2380 int n_scan_plans;
2381
2382 u8 mac_addr[ETH_ALEN] __aligned(2);
2383 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2384
2385 bool relative_rssi_set;
2386 s8 relative_rssi;
2387 struct cfg80211_bss_select_adjust rssi_adjust;
2388
2389 /* internal */
2390 struct wiphy *wiphy;
2391 struct net_device *dev;
2392 unsigned long scan_start;
2393 bool report_results;
2394 struct rcu_head rcu_head;
2395 u32 owner_nlportid;
2396 bool nl_owner_dead;
2397 struct list_head list;
2398
2399 /* keep last */
2400 struct ieee80211_channel *channels[];
2401};
2402
2403/**
2404 * enum cfg80211_signal_type - signal type
2405 *
2406 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2407 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2408 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2409 */
2410enum cfg80211_signal_type {
2411 CFG80211_SIGNAL_TYPE_NONE,
2412 CFG80211_SIGNAL_TYPE_MBM,
2413 CFG80211_SIGNAL_TYPE_UNSPEC,
2414};
2415
2416/**
2417 * struct cfg80211_inform_bss - BSS inform data
2418 * @chan: channel the frame was received on
2419 * @scan_width: scan width that was used
2420 * @signal: signal strength value, according to the wiphy's
2421 * signal type
2422 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2423 * received; should match the time when the frame was actually
2424 * received by the device (not just by the host, in case it was
2425 * buffered on the device) and be accurate to about 10ms.
2426 * If the frame isn't buffered, just passing the return value of
2427 * ktime_get_boottime_ns() is likely appropriate.
2428 * @parent_tsf: the time at the start of reception of the first octet of the
2429 * timestamp field of the frame. The time is the TSF of the BSS specified
2430 * by %parent_bssid.
2431 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2432 * the BSS that requested the scan in which the beacon/probe was received.
2433 * @chains: bitmask for filled values in @chain_signal.
2434 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2435 */
2436struct cfg80211_inform_bss {
2437 struct ieee80211_channel *chan;
2438 enum nl80211_bss_scan_width scan_width;
2439 s32 signal;
2440 u64 boottime_ns;
2441 u64 parent_tsf;
2442 u8 parent_bssid[ETH_ALEN] __aligned(2);
2443 u8 chains;
2444 s8 chain_signal[IEEE80211_MAX_CHAINS];
2445};
2446
2447/**
2448 * struct cfg80211_bss_ies - BSS entry IE data
2449 * @tsf: TSF contained in the frame that carried these IEs
2450 * @rcu_head: internal use, for freeing
2451 * @len: length of the IEs
2452 * @from_beacon: these IEs are known to come from a beacon
2453 * @data: IE data
2454 */
2455struct cfg80211_bss_ies {
2456 u64 tsf;
2457 struct rcu_head rcu_head;
2458 int len;
2459 bool from_beacon;
2460 u8 data[];
2461};
2462
2463/**
2464 * struct cfg80211_bss - BSS description
2465 *
2466 * This structure describes a BSS (which may also be a mesh network)
2467 * for use in scan results and similar.
2468 *
2469 * @channel: channel this BSS is on
2470 * @scan_width: width of the control channel
2471 * @bssid: BSSID of the BSS
2472 * @beacon_interval: the beacon interval as from the frame
2473 * @capability: the capability field in host byte order
2474 * @ies: the information elements (Note that there is no guarantee that these
2475 * are well-formed!); this is a pointer to either the beacon_ies or
2476 * proberesp_ies depending on whether Probe Response frame has been
2477 * received. It is always non-%NULL.
2478 * @beacon_ies: the information elements from the last Beacon frame
2479 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2480 * own the beacon_ies, but they're just pointers to the ones from the
2481 * @hidden_beacon_bss struct)
2482 * @proberesp_ies: the information elements from the last Probe Response frame
2483 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2484 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2485 * that holds the beacon data. @beacon_ies is still valid, of course, and
2486 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2487 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2488 * non-transmitted one (multi-BSSID support)
2489 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2490 * (multi-BSSID support)
2491 * @signal: signal strength value (type depends on the wiphy's signal_type)
2492 * @chains: bitmask for filled values in @chain_signal.
2493 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2494 * @bssid_index: index in the multiple BSS set
2495 * @max_bssid_indicator: max number of members in the BSS set
2496 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2497 */
2498struct cfg80211_bss {
2499 struct ieee80211_channel *channel;
2500 enum nl80211_bss_scan_width scan_width;
2501
2502 const struct cfg80211_bss_ies __rcu *ies;
2503 const struct cfg80211_bss_ies __rcu *beacon_ies;
2504 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2505
2506 struct cfg80211_bss *hidden_beacon_bss;
2507 struct cfg80211_bss *transmitted_bss;
2508 struct list_head nontrans_list;
2509
2510 s32 signal;
2511
2512 u16 beacon_interval;
2513 u16 capability;
2514
2515 u8 bssid[ETH_ALEN];
2516 u8 chains;
2517 s8 chain_signal[IEEE80211_MAX_CHAINS];
2518
2519 u8 bssid_index;
2520 u8 max_bssid_indicator;
2521
2522 u8 priv[] __aligned(sizeof(void *));
2523};
2524
2525/**
2526 * ieee80211_bss_get_elem - find element with given ID
2527 * @bss: the bss to search
2528 * @id: the element ID
2529 *
2530 * Note that the return value is an RCU-protected pointer, so
2531 * rcu_read_lock() must be held when calling this function.
2532 * Return: %NULL if not found.
2533 */
2534const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2535
2536/**
2537 * ieee80211_bss_get_ie - find IE with given ID
2538 * @bss: the bss to search
2539 * @id: the element ID
2540 *
2541 * Note that the return value is an RCU-protected pointer, so
2542 * rcu_read_lock() must be held when calling this function.
2543 * Return: %NULL if not found.
2544 */
2545static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2546{
2547 return (void *)ieee80211_bss_get_elem(bss, id);
2548}
2549
2550
2551/**
2552 * struct cfg80211_auth_request - Authentication request data
2553 *
2554 * This structure provides information needed to complete IEEE 802.11
2555 * authentication.
2556 *
2557 * @bss: The BSS to authenticate with, the callee must obtain a reference
2558 * to it if it needs to keep it.
2559 * @auth_type: Authentication type (algorithm)
2560 * @ie: Extra IEs to add to Authentication frame or %NULL
2561 * @ie_len: Length of ie buffer in octets
2562 * @key_len: length of WEP key for shared key authentication
2563 * @key_idx: index of WEP key for shared key authentication
2564 * @key: WEP key for shared key authentication
2565 * @auth_data: Fields and elements in Authentication frames. This contains
2566 * the authentication frame body (non-IE and IE data), excluding the
2567 * Authentication algorithm number, i.e., starting at the Authentication
2568 * transaction sequence number field.
2569 * @auth_data_len: Length of auth_data buffer in octets
2570 */
2571struct cfg80211_auth_request {
2572 struct cfg80211_bss *bss;
2573 const u8 *ie;
2574 size_t ie_len;
2575 enum nl80211_auth_type auth_type;
2576 const u8 *key;
2577 u8 key_len, key_idx;
2578 const u8 *auth_data;
2579 size_t auth_data_len;
2580};
2581
2582/**
2583 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2584 *
2585 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2586 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2587 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2588 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2589 * authentication capability. Drivers can offload authentication to
2590 * userspace if this flag is set. Only applicable for cfg80211_connect()
2591 * request (connect callback).
2592 * @ASSOC_REQ_DISABLE_HE: Disable HE
2593 */
2594enum cfg80211_assoc_req_flags {
2595 ASSOC_REQ_DISABLE_HT = BIT(0),
2596 ASSOC_REQ_DISABLE_VHT = BIT(1),
2597 ASSOC_REQ_USE_RRM = BIT(2),
2598 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2599 ASSOC_REQ_DISABLE_HE = BIT(4),
2600};
2601
2602/**
2603 * struct cfg80211_assoc_request - (Re)Association request data
2604 *
2605 * This structure provides information needed to complete IEEE 802.11
2606 * (re)association.
2607 * @bss: The BSS to associate with. If the call is successful the driver is
2608 * given a reference that it must give back to cfg80211_send_rx_assoc()
2609 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2610 * association requests while already associating must be rejected.
2611 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2612 * @ie_len: Length of ie buffer in octets
2613 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2614 * @crypto: crypto settings
2615 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2616 * to indicate a request to reassociate within the ESS instead of a request
2617 * do the initial association with the ESS. When included, this is set to
2618 * the BSSID of the current association, i.e., to the value that is
2619 * included in the Current AP address field of the Reassociation Request
2620 * frame.
2621 * @flags: See &enum cfg80211_assoc_req_flags
2622 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2623 * will be used in ht_capa. Un-supported values will be ignored.
2624 * @ht_capa_mask: The bits of ht_capa which are to be used.
2625 * @vht_capa: VHT capability override
2626 * @vht_capa_mask: VHT capability mask indicating which fields to use
2627 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2628 * %NULL if FILS is not used.
2629 * @fils_kek_len: Length of fils_kek in octets
2630 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2631 * Request/Response frame or %NULL if FILS is not used. This field starts
2632 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2633 * @s1g_capa: S1G capability override
2634 * @s1g_capa_mask: S1G capability override mask
2635 */
2636struct cfg80211_assoc_request {
2637 struct cfg80211_bss *bss;
2638 const u8 *ie, *prev_bssid;
2639 size_t ie_len;
2640 struct cfg80211_crypto_settings crypto;
2641 bool use_mfp;
2642 u32 flags;
2643 struct ieee80211_ht_cap ht_capa;
2644 struct ieee80211_ht_cap ht_capa_mask;
2645 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2646 const u8 *fils_kek;
2647 size_t fils_kek_len;
2648 const u8 *fils_nonces;
2649 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2650};
2651
2652/**
2653 * struct cfg80211_deauth_request - Deauthentication request data
2654 *
2655 * This structure provides information needed to complete IEEE 802.11
2656 * deauthentication.
2657 *
2658 * @bssid: the BSSID of the BSS to deauthenticate from
2659 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2660 * @ie_len: Length of ie buffer in octets
2661 * @reason_code: The reason code for the deauthentication
2662 * @local_state_change: if set, change local state only and
2663 * do not set a deauth frame
2664 */
2665struct cfg80211_deauth_request {
2666 const u8 *bssid;
2667 const u8 *ie;
2668 size_t ie_len;
2669 u16 reason_code;
2670 bool local_state_change;
2671};
2672
2673/**
2674 * struct cfg80211_disassoc_request - Disassociation request data
2675 *
2676 * This structure provides information needed to complete IEEE 802.11
2677 * disassociation.
2678 *
2679 * @bss: the BSS to disassociate from
2680 * @ie: Extra IEs to add to Disassociation frame or %NULL
2681 * @ie_len: Length of ie buffer in octets
2682 * @reason_code: The reason code for the disassociation
2683 * @local_state_change: This is a request for a local state only, i.e., no
2684 * Disassociation frame is to be transmitted.
2685 */
2686struct cfg80211_disassoc_request {
2687 struct cfg80211_bss *bss;
2688 const u8 *ie;
2689 size_t ie_len;
2690 u16 reason_code;
2691 bool local_state_change;
2692};
2693
2694/**
2695 * struct cfg80211_ibss_params - IBSS parameters
2696 *
2697 * This structure defines the IBSS parameters for the join_ibss()
2698 * method.
2699 *
2700 * @ssid: The SSID, will always be non-null.
2701 * @ssid_len: The length of the SSID, will always be non-zero.
2702 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2703 * search for IBSSs with a different BSSID.
2704 * @chandef: defines the channel to use if no other IBSS to join can be found
2705 * @channel_fixed: The channel should be fixed -- do not search for
2706 * IBSSs to join on other channels.
2707 * @ie: information element(s) to include in the beacon
2708 * @ie_len: length of that
2709 * @beacon_interval: beacon interval to use
2710 * @privacy: this is a protected network, keys will be configured
2711 * after joining
2712 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2713 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2714 * required to assume that the port is unauthorized until authorized by
2715 * user space. Otherwise, port is marked authorized by default.
2716 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2717 * port frames over NL80211 instead of the network interface.
2718 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2719 * changes the channel when a radar is detected. This is required
2720 * to operate on DFS channels.
2721 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2722 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2723 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2724 * will be used in ht_capa. Un-supported values will be ignored.
2725 * @ht_capa_mask: The bits of ht_capa which are to be used.
2726 * @wep_keys: static WEP keys, if not NULL points to an array of
2727 * CFG80211_MAX_WEP_KEYS WEP keys
2728 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2729 */
2730struct cfg80211_ibss_params {
2731 const u8 *ssid;
2732 const u8 *bssid;
2733 struct cfg80211_chan_def chandef;
2734 const u8 *ie;
2735 u8 ssid_len, ie_len;
2736 u16 beacon_interval;
2737 u32 basic_rates;
2738 bool channel_fixed;
2739 bool privacy;
2740 bool control_port;
2741 bool control_port_over_nl80211;
2742 bool userspace_handles_dfs;
2743 int mcast_rate[NUM_NL80211_BANDS];
2744 struct ieee80211_ht_cap ht_capa;
2745 struct ieee80211_ht_cap ht_capa_mask;
2746 struct key_params *wep_keys;
2747 int wep_tx_key;
2748};
2749
2750/**
2751 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2752 *
2753 * @behaviour: requested BSS selection behaviour.
2754 * @param: parameters for requestion behaviour.
2755 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2756 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2757 */
2758struct cfg80211_bss_selection {
2759 enum nl80211_bss_select_attr behaviour;
2760 union {
2761 enum nl80211_band band_pref;
2762 struct cfg80211_bss_select_adjust adjust;
2763 } param;
2764};
2765
2766/**
2767 * struct cfg80211_connect_params - Connection parameters
2768 *
2769 * This structure provides information needed to complete IEEE 802.11
2770 * authentication and association.
2771 *
2772 * @channel: The channel to use or %NULL if not specified (auto-select based
2773 * on scan results)
2774 * @channel_hint: The channel of the recommended BSS for initial connection or
2775 * %NULL if not specified
2776 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2777 * results)
2778 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2779 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2780 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2781 * to use.
2782 * @ssid: SSID
2783 * @ssid_len: Length of ssid in octets
2784 * @auth_type: Authentication type (algorithm)
2785 * @ie: IEs for association request
2786 * @ie_len: Length of assoc_ie in octets
2787 * @privacy: indicates whether privacy-enabled APs should be used
2788 * @mfp: indicate whether management frame protection is used
2789 * @crypto: crypto settings
2790 * @key_len: length of WEP key for shared key authentication
2791 * @key_idx: index of WEP key for shared key authentication
2792 * @key: WEP key for shared key authentication
2793 * @flags: See &enum cfg80211_assoc_req_flags
2794 * @bg_scan_period: Background scan period in seconds
2795 * or -1 to indicate that default value is to be used.
2796 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2797 * will be used in ht_capa. Un-supported values will be ignored.
2798 * @ht_capa_mask: The bits of ht_capa which are to be used.
2799 * @vht_capa: VHT Capability overrides
2800 * @vht_capa_mask: The bits of vht_capa which are to be used.
2801 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2802 * networks.
2803 * @bss_select: criteria to be used for BSS selection.
2804 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2805 * to indicate a request to reassociate within the ESS instead of a request
2806 * do the initial association with the ESS. When included, this is set to
2807 * the BSSID of the current association, i.e., to the value that is
2808 * included in the Current AP address field of the Reassociation Request
2809 * frame.
2810 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2811 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2812 * data IE.
2813 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2814 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2815 * %NULL if not specified. This specifies the domain name of ER server and
2816 * is used to construct FILS wrapped data IE.
2817 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2818 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2819 * messages. This is also used to construct FILS wrapped data IE.
2820 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2821 * keys in FILS or %NULL if not specified.
2822 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2823 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2824 * offload of 4-way handshake.
2825 * @edmg: define the EDMG channels.
2826 * This may specify multiple channels and bonding options for the driver
2827 * to choose from, based on BSS configuration.
2828 */
2829struct cfg80211_connect_params {
2830 struct ieee80211_channel *channel;
2831 struct ieee80211_channel *channel_hint;
2832 const u8 *bssid;
2833 const u8 *bssid_hint;
2834 const u8 *ssid;
2835 size_t ssid_len;
2836 enum nl80211_auth_type auth_type;
2837 const u8 *ie;
2838 size_t ie_len;
2839 bool privacy;
2840 enum nl80211_mfp mfp;
2841 struct cfg80211_crypto_settings crypto;
2842 const u8 *key;
2843 u8 key_len, key_idx;
2844 u32 flags;
2845 int bg_scan_period;
2846 struct ieee80211_ht_cap ht_capa;
2847 struct ieee80211_ht_cap ht_capa_mask;
2848 struct ieee80211_vht_cap vht_capa;
2849 struct ieee80211_vht_cap vht_capa_mask;
2850 bool pbss;
2851 struct cfg80211_bss_selection bss_select;
2852 const u8 *prev_bssid;
2853 const u8 *fils_erp_username;
2854 size_t fils_erp_username_len;
2855 const u8 *fils_erp_realm;
2856 size_t fils_erp_realm_len;
2857 u16 fils_erp_next_seq_num;
2858 const u8 *fils_erp_rrk;
2859 size_t fils_erp_rrk_len;
2860 bool want_1x;
2861 struct ieee80211_edmg edmg;
2862};
2863
2864/**
2865 * enum cfg80211_connect_params_changed - Connection parameters being updated
2866 *
2867 * This enum provides information of all connect parameters that
2868 * have to be updated as part of update_connect_params() call.
2869 *
2870 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2871 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2872 * username, erp sequence number and rrk) are updated
2873 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2874 */
2875enum cfg80211_connect_params_changed {
2876 UPDATE_ASSOC_IES = BIT(0),
2877 UPDATE_FILS_ERP_INFO = BIT(1),
2878 UPDATE_AUTH_TYPE = BIT(2),
2879};
2880
2881/**
2882 * enum wiphy_params_flags - set_wiphy_params bitfield values
2883 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2884 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2885 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2886 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2887 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2888 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2889 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2890 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2891 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2892 */
2893enum wiphy_params_flags {
2894 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2895 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2896 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2897 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2898 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2899 WIPHY_PARAM_DYN_ACK = 1 << 5,
2900 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2901 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2902 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
2903};
2904
2905#define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
2906
2907/* The per TXQ device queue limit in airtime */
2908#define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
2909#define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
2910
2911/* The per interface airtime threshold to switch to lower queue limit */
2912#define IEEE80211_AQL_THRESHOLD 24000
2913
2914/**
2915 * struct cfg80211_pmksa - PMK Security Association
2916 *
2917 * This structure is passed to the set/del_pmksa() method for PMKSA
2918 * caching.
2919 *
2920 * @bssid: The AP's BSSID (may be %NULL).
2921 * @pmkid: The identifier to refer a PMKSA.
2922 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2923 * derivation by a FILS STA. Otherwise, %NULL.
2924 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2925 * the hash algorithm used to generate this.
2926 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2927 * cache identifier (may be %NULL).
2928 * @ssid_len: Length of the @ssid in octets.
2929 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2930 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2931 * %NULL).
2932 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
2933 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
2934 * The configured PMKSA must not be used for PMKSA caching after
2935 * expiration and any keys derived from this PMK become invalid on
2936 * expiration, i.e., the current association must be dropped if the PMK
2937 * used for it expires.
2938 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
2939 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
2940 * Drivers are expected to trigger a full authentication instead of using
2941 * this PMKSA for caching when reassociating to a new BSS after this
2942 * threshold to generate a new PMK before the current one expires.
2943 */
2944struct cfg80211_pmksa {
2945 const u8 *bssid;
2946 const u8 *pmkid;
2947 const u8 *pmk;
2948 size_t pmk_len;
2949 const u8 *ssid;
2950 size_t ssid_len;
2951 const u8 *cache_id;
2952 u32 pmk_lifetime;
2953 u8 pmk_reauth_threshold;
2954};
2955
2956/**
2957 * struct cfg80211_pkt_pattern - packet pattern
2958 * @mask: bitmask where to match pattern and where to ignore bytes,
2959 * one bit per byte, in same format as nl80211
2960 * @pattern: bytes to match where bitmask is 1
2961 * @pattern_len: length of pattern (in bytes)
2962 * @pkt_offset: packet offset (in bytes)
2963 *
2964 * Internal note: @mask and @pattern are allocated in one chunk of
2965 * memory, free @mask only!
2966 */
2967struct cfg80211_pkt_pattern {
2968 const u8 *mask, *pattern;
2969 int pattern_len;
2970 int pkt_offset;
2971};
2972
2973/**
2974 * struct cfg80211_wowlan_tcp - TCP connection parameters
2975 *
2976 * @sock: (internal) socket for source port allocation
2977 * @src: source IP address
2978 * @dst: destination IP address
2979 * @dst_mac: destination MAC address
2980 * @src_port: source port
2981 * @dst_port: destination port
2982 * @payload_len: data payload length
2983 * @payload: data payload buffer
2984 * @payload_seq: payload sequence stamping configuration
2985 * @data_interval: interval at which to send data packets
2986 * @wake_len: wakeup payload match length
2987 * @wake_data: wakeup payload match data
2988 * @wake_mask: wakeup payload match mask
2989 * @tokens_size: length of the tokens buffer
2990 * @payload_tok: payload token usage configuration
2991 */
2992struct cfg80211_wowlan_tcp {
2993 struct socket *sock;
2994 __be32 src, dst;
2995 u16 src_port, dst_port;
2996 u8 dst_mac[ETH_ALEN];
2997 int payload_len;
2998 const u8 *payload;
2999 struct nl80211_wowlan_tcp_data_seq payload_seq;
3000 u32 data_interval;
3001 u32 wake_len;
3002 const u8 *wake_data, *wake_mask;
3003 u32 tokens_size;
3004 /* must be last, variable member */
3005 struct nl80211_wowlan_tcp_data_token payload_tok;
3006};
3007
3008/**
3009 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3010 *
3011 * This structure defines the enabled WoWLAN triggers for the device.
3012 * @any: wake up on any activity -- special trigger if device continues
3013 * operating as normal during suspend
3014 * @disconnect: wake up if getting disconnected
3015 * @magic_pkt: wake up on receiving magic packet
3016 * @patterns: wake up on receiving packet matching a pattern
3017 * @n_patterns: number of patterns
3018 * @gtk_rekey_failure: wake up on GTK rekey failure
3019 * @eap_identity_req: wake up on EAP identity request packet
3020 * @four_way_handshake: wake up on 4-way handshake
3021 * @rfkill_release: wake up when rfkill is released
3022 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3023 * NULL if not configured.
3024 * @nd_config: configuration for the scan to be used for net detect wake.
3025 */
3026struct cfg80211_wowlan {
3027 bool any, disconnect, magic_pkt, gtk_rekey_failure,
3028 eap_identity_req, four_way_handshake,
3029 rfkill_release;
3030 struct cfg80211_pkt_pattern *patterns;
3031 struct cfg80211_wowlan_tcp *tcp;
3032 int n_patterns;
3033 struct cfg80211_sched_scan_request *nd_config;
3034};
3035
3036/**
3037 * struct cfg80211_coalesce_rules - Coalesce rule parameters
3038 *
3039 * This structure defines coalesce rule for the device.
3040 * @delay: maximum coalescing delay in msecs.
3041 * @condition: condition for packet coalescence.
3042 * see &enum nl80211_coalesce_condition.
3043 * @patterns: array of packet patterns
3044 * @n_patterns: number of patterns
3045 */
3046struct cfg80211_coalesce_rules {
3047 int delay;
3048 enum nl80211_coalesce_condition condition;
3049 struct cfg80211_pkt_pattern *patterns;
3050 int n_patterns;
3051};
3052
3053/**
3054 * struct cfg80211_coalesce - Packet coalescing settings
3055 *
3056 * This structure defines coalescing settings.
3057 * @rules: array of coalesce rules
3058 * @n_rules: number of rules
3059 */
3060struct cfg80211_coalesce {
3061 struct cfg80211_coalesce_rules *rules;
3062 int n_rules;
3063};
3064
3065/**
3066 * struct cfg80211_wowlan_nd_match - information about the match
3067 *
3068 * @ssid: SSID of the match that triggered the wake up
3069 * @n_channels: Number of channels where the match occurred. This
3070 * value may be zero if the driver can't report the channels.
3071 * @channels: center frequencies of the channels where a match
3072 * occurred (in MHz)
3073 */
3074struct cfg80211_wowlan_nd_match {
3075 struct cfg80211_ssid ssid;
3076 int n_channels;
3077 u32 channels[];
3078};
3079
3080/**
3081 * struct cfg80211_wowlan_nd_info - net detect wake up information
3082 *
3083 * @n_matches: Number of match information instances provided in
3084 * @matches. This value may be zero if the driver can't provide
3085 * match information.
3086 * @matches: Array of pointers to matches containing information about
3087 * the matches that triggered the wake up.
3088 */
3089struct cfg80211_wowlan_nd_info {
3090 int n_matches;
3091 struct cfg80211_wowlan_nd_match *matches[];
3092};
3093
3094/**
3095 * struct cfg80211_wowlan_wakeup - wakeup report
3096 * @disconnect: woke up by getting disconnected
3097 * @magic_pkt: woke up by receiving magic packet
3098 * @gtk_rekey_failure: woke up by GTK rekey failure
3099 * @eap_identity_req: woke up by EAP identity request packet
3100 * @four_way_handshake: woke up by 4-way handshake
3101 * @rfkill_release: woke up by rfkill being released
3102 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3103 * @packet_present_len: copied wakeup packet data
3104 * @packet_len: original wakeup packet length
3105 * @packet: The packet causing the wakeup, if any.
3106 * @packet_80211: For pattern match, magic packet and other data
3107 * frame triggers an 802.3 frame should be reported, for
3108 * disconnect due to deauth 802.11 frame. This indicates which
3109 * it is.
3110 * @tcp_match: TCP wakeup packet received
3111 * @tcp_connlost: TCP connection lost or failed to establish
3112 * @tcp_nomoretokens: TCP data ran out of tokens
3113 * @net_detect: if not %NULL, woke up because of net detect
3114 */
3115struct cfg80211_wowlan_wakeup {
3116 bool disconnect, magic_pkt, gtk_rekey_failure,
3117 eap_identity_req, four_way_handshake,
3118 rfkill_release, packet_80211,
3119 tcp_match, tcp_connlost, tcp_nomoretokens;
3120 s32 pattern_idx;
3121 u32 packet_present_len, packet_len;
3122 const void *packet;
3123 struct cfg80211_wowlan_nd_info *net_detect;
3124};
3125
3126/**
3127 * struct cfg80211_gtk_rekey_data - rekey data
3128 * @kek: key encryption key (@kek_len bytes)
3129 * @kck: key confirmation key (@kck_len bytes)
3130 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3131 * @kek_len: length of kek
3132 * @kck_len length of kck
3133 * @akm: akm (oui, id)
3134 */
3135struct cfg80211_gtk_rekey_data {
3136 const u8 *kek, *kck, *replay_ctr;
3137 u32 akm;
3138 u8 kek_len, kck_len;
3139};
3140
3141/**
3142 * struct cfg80211_update_ft_ies_params - FT IE Information
3143 *
3144 * This structure provides information needed to update the fast transition IE
3145 *
3146 * @md: The Mobility Domain ID, 2 Octet value
3147 * @ie: Fast Transition IEs
3148 * @ie_len: Length of ft_ie in octets
3149 */
3150struct cfg80211_update_ft_ies_params {
3151 u16 md;
3152 const u8 *ie;
3153 size_t ie_len;
3154};
3155
3156/**
3157 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3158 *
3159 * This structure provides information needed to transmit a mgmt frame
3160 *
3161 * @chan: channel to use
3162 * @offchan: indicates wether off channel operation is required
3163 * @wait: duration for ROC
3164 * @buf: buffer to transmit
3165 * @len: buffer length
3166 * @no_cck: don't use cck rates for this frame
3167 * @dont_wait_for_ack: tells the low level not to wait for an ack
3168 * @n_csa_offsets: length of csa_offsets array
3169 * @csa_offsets: array of all the csa offsets in the frame
3170 */
3171struct cfg80211_mgmt_tx_params {
3172 struct ieee80211_channel *chan;
3173 bool offchan;
3174 unsigned int wait;
3175 const u8 *buf;
3176 size_t len;
3177 bool no_cck;
3178 bool dont_wait_for_ack;
3179 int n_csa_offsets;
3180 const u16 *csa_offsets;
3181};
3182
3183/**
3184 * struct cfg80211_dscp_exception - DSCP exception
3185 *
3186 * @dscp: DSCP value that does not adhere to the user priority range definition
3187 * @up: user priority value to which the corresponding DSCP value belongs
3188 */
3189struct cfg80211_dscp_exception {
3190 u8 dscp;
3191 u8 up;
3192};
3193
3194/**
3195 * struct cfg80211_dscp_range - DSCP range definition for user priority
3196 *
3197 * @low: lowest DSCP value of this user priority range, inclusive
3198 * @high: highest DSCP value of this user priority range, inclusive
3199 */
3200struct cfg80211_dscp_range {
3201 u8 low;
3202 u8 high;
3203};
3204
3205/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3206#define IEEE80211_QOS_MAP_MAX_EX 21
3207#define IEEE80211_QOS_MAP_LEN_MIN 16
3208#define IEEE80211_QOS_MAP_LEN_MAX \
3209 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3210
3211/**
3212 * struct cfg80211_qos_map - QoS Map Information
3213 *
3214 * This struct defines the Interworking QoS map setting for DSCP values
3215 *
3216 * @num_des: number of DSCP exceptions (0..21)
3217 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3218 * the user priority DSCP range definition
3219 * @up: DSCP range definition for a particular user priority
3220 */
3221struct cfg80211_qos_map {
3222 u8 num_des;
3223 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3224 struct cfg80211_dscp_range up[8];
3225};
3226
3227/**
3228 * struct cfg80211_nan_conf - NAN configuration
3229 *
3230 * This struct defines NAN configuration parameters
3231 *
3232 * @master_pref: master preference (1 - 255)
3233 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3234 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3235 * (i.e. BIT(NL80211_BAND_2GHZ)).
3236 */
3237struct cfg80211_nan_conf {
3238 u8 master_pref;
3239 u8 bands;
3240};
3241
3242/**
3243 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3244 * configuration
3245 *
3246 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3247 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3248 */
3249enum cfg80211_nan_conf_changes {
3250 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3251 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3252};
3253
3254/**
3255 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3256 *
3257 * @filter: the content of the filter
3258 * @len: the length of the filter
3259 */
3260struct cfg80211_nan_func_filter {
3261 const u8 *filter;
3262 u8 len;
3263};
3264
3265/**
3266 * struct cfg80211_nan_func - a NAN function
3267 *
3268 * @type: &enum nl80211_nan_function_type
3269 * @service_id: the service ID of the function
3270 * @publish_type: &nl80211_nan_publish_type
3271 * @close_range: if true, the range should be limited. Threshold is
3272 * implementation specific.
3273 * @publish_bcast: if true, the solicited publish should be broadcasted
3274 * @subscribe_active: if true, the subscribe is active
3275 * @followup_id: the instance ID for follow up
3276 * @followup_reqid: the requestor instance ID for follow up
3277 * @followup_dest: MAC address of the recipient of the follow up
3278 * @ttl: time to live counter in DW.
3279 * @serv_spec_info: Service Specific Info
3280 * @serv_spec_info_len: Service Specific Info length
3281 * @srf_include: if true, SRF is inclusive
3282 * @srf_bf: Bloom Filter
3283 * @srf_bf_len: Bloom Filter length
3284 * @srf_bf_idx: Bloom Filter index
3285 * @srf_macs: SRF MAC addresses
3286 * @srf_num_macs: number of MAC addresses in SRF
3287 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3288 * @tx_filters: filters that should be transmitted in the SDF.
3289 * @num_rx_filters: length of &rx_filters.
3290 * @num_tx_filters: length of &tx_filters.
3291 * @instance_id: driver allocated id of the function.
3292 * @cookie: unique NAN function identifier.
3293 */
3294struct cfg80211_nan_func {
3295 enum nl80211_nan_function_type type;
3296 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3297 u8 publish_type;
3298 bool close_range;
3299 bool publish_bcast;
3300 bool subscribe_active;
3301 u8 followup_id;
3302 u8 followup_reqid;
3303 struct mac_address followup_dest;
3304 u32 ttl;
3305 const u8 *serv_spec_info;
3306 u8 serv_spec_info_len;
3307 bool srf_include;
3308 const u8 *srf_bf;
3309 u8 srf_bf_len;
3310 u8 srf_bf_idx;
3311 struct mac_address *srf_macs;
3312 int srf_num_macs;
3313 struct cfg80211_nan_func_filter *rx_filters;
3314 struct cfg80211_nan_func_filter *tx_filters;
3315 u8 num_tx_filters;
3316 u8 num_rx_filters;
3317 u8 instance_id;
3318 u64 cookie;
3319};
3320
3321/**
3322 * struct cfg80211_pmk_conf - PMK configuration
3323 *
3324 * @aa: authenticator address
3325 * @pmk_len: PMK length in bytes.
3326 * @pmk: the PMK material
3327 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3328 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3329 * holds PMK-R0.
3330 */
3331struct cfg80211_pmk_conf {
3332 const u8 *aa;
3333 u8 pmk_len;
3334 const u8 *pmk;
3335 const u8 *pmk_r0_name;
3336};
3337
3338/**
3339 * struct cfg80211_external_auth_params - Trigger External authentication.
3340 *
3341 * Commonly used across the external auth request and event interfaces.
3342 *
3343 * @action: action type / trigger for external authentication. Only significant
3344 * for the authentication request event interface (driver to user space).
3345 * @bssid: BSSID of the peer with which the authentication has
3346 * to happen. Used by both the authentication request event and
3347 * authentication response command interface.
3348 * @ssid: SSID of the AP. Used by both the authentication request event and
3349 * authentication response command interface.
3350 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3351 * authentication request event interface.
3352 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3353 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3354 * the real status code for failures. Used only for the authentication
3355 * response command interface (user space to driver).
3356 * @pmkid: The identifier to refer a PMKSA.
3357 */
3358struct cfg80211_external_auth_params {
3359 enum nl80211_external_auth_action action;
3360 u8 bssid[ETH_ALEN] __aligned(2);
3361 struct cfg80211_ssid ssid;
3362 unsigned int key_mgmt_suite;
3363 u16 status;
3364 const u8 *pmkid;
3365};
3366
3367/**
3368 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3369 *
3370 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3371 * indicate the relevant values in this struct for them
3372 * @success_num: number of FTM sessions in which all frames were successfully
3373 * answered
3374 * @partial_num: number of FTM sessions in which part of frames were
3375 * successfully answered
3376 * @failed_num: number of failed FTM sessions
3377 * @asap_num: number of ASAP FTM sessions
3378 * @non_asap_num: number of non-ASAP FTM sessions
3379 * @total_duration_ms: total sessions durations - gives an indication
3380 * of how much time the responder was busy
3381 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3382 * initiators that didn't finish successfully the negotiation phase with
3383 * the responder
3384 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3385 * for a new scheduling although it already has scheduled FTM slot
3386 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3387 */
3388struct cfg80211_ftm_responder_stats {
3389 u32 filled;
3390 u32 success_num;
3391 u32 partial_num;
3392 u32 failed_num;
3393 u32 asap_num;
3394 u32 non_asap_num;
3395 u64 total_duration_ms;
3396 u32 unknown_triggers_num;
3397 u32 reschedule_requests_num;
3398 u32 out_of_window_triggers_num;
3399};
3400
3401/**
3402 * struct cfg80211_pmsr_ftm_result - FTM result
3403 * @failure_reason: if this measurement failed (PMSR status is
3404 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3405 * reason than just "failure"
3406 * @burst_index: if reporting partial results, this is the index
3407 * in [0 .. num_bursts-1] of the burst that's being reported
3408 * @num_ftmr_attempts: number of FTM request frames transmitted
3409 * @num_ftmr_successes: number of FTM request frames acked
3410 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3411 * fill this to indicate in how many seconds a retry is deemed possible
3412 * by the responder
3413 * @num_bursts_exp: actual number of bursts exponent negotiated
3414 * @burst_duration: actual burst duration negotiated
3415 * @ftms_per_burst: actual FTMs per burst negotiated
3416 * @lci_len: length of LCI information (if present)
3417 * @civicloc_len: length of civic location information (if present)
3418 * @lci: LCI data (may be %NULL)
3419 * @civicloc: civic location data (may be %NULL)
3420 * @rssi_avg: average RSSI over FTM action frames reported
3421 * @rssi_spread: spread of the RSSI over FTM action frames reported
3422 * @tx_rate: bitrate for transmitted FTM action frame response
3423 * @rx_rate: bitrate of received FTM action frame
3424 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3425 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3426 * the square root of the variance)
3427 * @rtt_spread: spread of the RTTs measured
3428 * @dist_avg: average of distances (mm) measured
3429 * (must have either this or @rtt_avg)
3430 * @dist_variance: variance of distances measured (see also @rtt_variance)
3431 * @dist_spread: spread of distances measured (see also @rtt_spread)
3432 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3433 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3434 * @rssi_avg_valid: @rssi_avg is valid
3435 * @rssi_spread_valid: @rssi_spread is valid
3436 * @tx_rate_valid: @tx_rate is valid
3437 * @rx_rate_valid: @rx_rate is valid
3438 * @rtt_avg_valid: @rtt_avg is valid
3439 * @rtt_variance_valid: @rtt_variance is valid
3440 * @rtt_spread_valid: @rtt_spread is valid
3441 * @dist_avg_valid: @dist_avg is valid
3442 * @dist_variance_valid: @dist_variance is valid
3443 * @dist_spread_valid: @dist_spread is valid
3444 */
3445struct cfg80211_pmsr_ftm_result {
3446 const u8 *lci;
3447 const u8 *civicloc;
3448 unsigned int lci_len;
3449 unsigned int civicloc_len;
3450 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3451 u32 num_ftmr_attempts, num_ftmr_successes;
3452 s16 burst_index;
3453 u8 busy_retry_time;
3454 u8 num_bursts_exp;
3455 u8 burst_duration;
3456 u8 ftms_per_burst;
3457 s32 rssi_avg;
3458 s32 rssi_spread;
3459 struct rate_info tx_rate, rx_rate;
3460 s64 rtt_avg;
3461 s64 rtt_variance;
3462 s64 rtt_spread;
3463 s64 dist_avg;
3464 s64 dist_variance;
3465 s64 dist_spread;
3466
3467 u16 num_ftmr_attempts_valid:1,
3468 num_ftmr_successes_valid:1,
3469 rssi_avg_valid:1,
3470 rssi_spread_valid:1,
3471 tx_rate_valid:1,
3472 rx_rate_valid:1,
3473 rtt_avg_valid:1,
3474 rtt_variance_valid:1,
3475 rtt_spread_valid:1,
3476 dist_avg_valid:1,
3477 dist_variance_valid:1,
3478 dist_spread_valid:1;
3479};
3480
3481/**
3482 * struct cfg80211_pmsr_result - peer measurement result
3483 * @addr: address of the peer
3484 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3485 * measurement was made)
3486 * @ap_tsf: AP's TSF at measurement time
3487 * @status: status of the measurement
3488 * @final: if reporting partial results, mark this as the last one; if not
3489 * reporting partial results always set this flag
3490 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3491 * @type: type of the measurement reported, note that we only support reporting
3492 * one type at a time, but you can report multiple results separately and
3493 * they're all aggregated for userspace.
3494 */
3495struct cfg80211_pmsr_result {
3496 u64 host_time, ap_tsf;
3497 enum nl80211_peer_measurement_status status;
3498
3499 u8 addr[ETH_ALEN];
3500
3501 u8 final:1,
3502 ap_tsf_valid:1;
3503
3504 enum nl80211_peer_measurement_type type;
3505
3506 union {
3507 struct cfg80211_pmsr_ftm_result ftm;
3508 };
3509};
3510
3511/**
3512 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3513 * @requested: indicates FTM is requested
3514 * @preamble: frame preamble to use
3515 * @burst_period: burst period to use
3516 * @asap: indicates to use ASAP mode
3517 * @num_bursts_exp: number of bursts exponent
3518 * @burst_duration: burst duration
3519 * @ftms_per_burst: number of FTMs per burst
3520 * @ftmr_retries: number of retries for FTM request
3521 * @request_lci: request LCI information
3522 * @request_civicloc: request civic location information
3523 * @trigger_based: use trigger based ranging for the measurement
3524 * If neither @trigger_based nor @non_trigger_based is set,
3525 * EDCA based ranging will be used.
3526 * @non_trigger_based: use non trigger based ranging for the measurement
3527 * If neither @trigger_based nor @non_trigger_based is set,
3528 * EDCA based ranging will be used.
3529 * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
3530 * @trigger_based or @non_trigger_based is set.
3531 * @bss_color: the bss color of the responder. Optional. Set to zero to
3532 * indicate the driver should set the BSS color. Only valid if
3533 * @non_trigger_based or @trigger_based is set.
3534 *
3535 * See also nl80211 for the respective attribute documentation.
3536 */
3537struct cfg80211_pmsr_ftm_request_peer {
3538 enum nl80211_preamble preamble;
3539 u16 burst_period;
3540 u8 requested:1,
3541 asap:1,
3542 request_lci:1,
3543 request_civicloc:1,
3544 trigger_based:1,
3545 non_trigger_based:1,
3546 lmr_feedback:1;
3547 u8 num_bursts_exp;
3548 u8 burst_duration;
3549 u8 ftms_per_burst;
3550 u8 ftmr_retries;
3551 u8 bss_color;
3552};
3553
3554/**
3555 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3556 * @addr: MAC address
3557 * @chandef: channel to use
3558 * @report_ap_tsf: report the associated AP's TSF
3559 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3560 */
3561struct cfg80211_pmsr_request_peer {
3562 u8 addr[ETH_ALEN];
3563 struct cfg80211_chan_def chandef;
3564 u8 report_ap_tsf:1;
3565 struct cfg80211_pmsr_ftm_request_peer ftm;
3566};
3567
3568/**
3569 * struct cfg80211_pmsr_request - peer measurement request
3570 * @cookie: cookie, set by cfg80211
3571 * @nl_portid: netlink portid - used by cfg80211
3572 * @drv_data: driver data for this request, if required for aborting,
3573 * not otherwise freed or anything by cfg80211
3574 * @mac_addr: MAC address used for (randomised) request
3575 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3576 * are 0 in the mask should be randomised, bits that are 1 should
3577 * be taken from the @mac_addr
3578 * @list: used by cfg80211 to hold on to the request
3579 * @timeout: timeout (in milliseconds) for the whole operation, if
3580 * zero it means there's no timeout
3581 * @n_peers: number of peers to do measurements with
3582 * @peers: per-peer measurement request data
3583 */
3584struct cfg80211_pmsr_request {
3585 u64 cookie;
3586 void *drv_data;
3587 u32 n_peers;
3588 u32 nl_portid;
3589
3590 u32 timeout;
3591
3592 u8 mac_addr[ETH_ALEN] __aligned(2);
3593 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3594
3595 struct list_head list;
3596
3597 struct cfg80211_pmsr_request_peer peers[];
3598};
3599
3600/**
3601 * struct cfg80211_update_owe_info - OWE Information
3602 *
3603 * This structure provides information needed for the drivers to offload OWE
3604 * (Opportunistic Wireless Encryption) processing to the user space.
3605 *
3606 * Commonly used across update_owe_info request and event interfaces.
3607 *
3608 * @peer: MAC address of the peer device for which the OWE processing
3609 * has to be done.
3610 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3611 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3612 * cannot give you the real status code for failures. Used only for
3613 * OWE update request command interface (user space to driver).
3614 * @ie: IEs obtained from the peer or constructed by the user space. These are
3615 * the IEs of the remote peer in the event from the host driver and
3616 * the constructed IEs by the user space in the request interface.
3617 * @ie_len: Length of IEs in octets.
3618 */
3619struct cfg80211_update_owe_info {
3620 u8 peer[ETH_ALEN] __aligned(2);
3621 u16 status;
3622 const u8 *ie;
3623 size_t ie_len;
3624};
3625
3626/**
3627 * struct mgmt_frame_regs - management frame registrations data
3628 * @global_stypes: bitmap of management frame subtypes registered
3629 * for the entire device
3630 * @interface_stypes: bitmap of management frame subtypes registered
3631 * for the given interface
3632 * @global_mcast_rx: mcast RX is needed globally for these subtypes
3633 * @interface_mcast_stypes: mcast RX is needed on this interface
3634 * for these subtypes
3635 */
3636struct mgmt_frame_regs {
3637 u32 global_stypes, interface_stypes;
3638 u32 global_mcast_stypes, interface_mcast_stypes;
3639};
3640
3641/**
3642 * struct cfg80211_ops - backend description for wireless configuration
3643 *
3644 * This struct is registered by fullmac card drivers and/or wireless stacks
3645 * in order to handle configuration requests on their interfaces.
3646 *
3647 * All callbacks except where otherwise noted should return 0
3648 * on success or a negative error code.
3649 *
3650 * All operations are invoked with the wiphy mutex held. The RTNL may be
3651 * held in addition (due to wireless extensions) but this cannot be relied
3652 * upon except in cases where documented below. Note that due to ordering,
3653 * the RTNL also cannot be acquired in any handlers.
3654 *
3655 * @suspend: wiphy device needs to be suspended. The variable @wow will
3656 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3657 * configured for the device.
3658 * @resume: wiphy device needs to be resumed
3659 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3660 * to call device_set_wakeup_enable() to enable/disable wakeup from
3661 * the device.
3662 *
3663 * @add_virtual_intf: create a new virtual interface with the given name,
3664 * must set the struct wireless_dev's iftype. Beware: You must create
3665 * the new netdev in the wiphy's network namespace! Returns the struct
3666 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3667 * also set the address member in the wdev.
3668 * This additionally holds the RTNL to be able to do netdev changes.
3669 *
3670 * @del_virtual_intf: remove the virtual interface
3671 * This additionally holds the RTNL to be able to do netdev changes.
3672 *
3673 * @change_virtual_intf: change type/configuration of virtual interface,
3674 * keep the struct wireless_dev's iftype updated.
3675 * This additionally holds the RTNL to be able to do netdev changes.
3676 *
3677 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3678 * when adding a group key.
3679 *
3680 * @get_key: get information about the key with the given parameters.
3681 * @mac_addr will be %NULL when requesting information for a group
3682 * key. All pointers given to the @callback function need not be valid
3683 * after it returns. This function should return an error if it is
3684 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3685 *
3686 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3687 * and @key_index, return -ENOENT if the key doesn't exist.
3688 *
3689 * @set_default_key: set the default key on an interface
3690 *
3691 * @set_default_mgmt_key: set the default management frame key on an interface
3692 *
3693 * @set_default_beacon_key: set the default Beacon frame key on an interface
3694 *
3695 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3696 *
3697 * @start_ap: Start acting in AP mode defined by the parameters.
3698 * @change_beacon: Change the beacon parameters for an access point mode
3699 * interface. This should reject the call when AP mode wasn't started.
3700 * @stop_ap: Stop being an AP, including stopping beaconing.
3701 *
3702 * @add_station: Add a new station.
3703 * @del_station: Remove a station
3704 * @change_station: Modify a given station. Note that flags changes are not much
3705 * validated in cfg80211, in particular the auth/assoc/authorized flags
3706 * might come to the driver in invalid combinations -- make sure to check
3707 * them, also against the existing state! Drivers must call
3708 * cfg80211_check_station_change() to validate the information.
3709 * @get_station: get station information for the station identified by @mac
3710 * @dump_station: dump station callback -- resume dump at index @idx
3711 *
3712 * @add_mpath: add a fixed mesh path
3713 * @del_mpath: delete a given mesh path
3714 * @change_mpath: change a given mesh path
3715 * @get_mpath: get a mesh path for the given parameters
3716 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3717 * @get_mpp: get a mesh proxy path for the given parameters
3718 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3719 * @join_mesh: join the mesh network with the specified parameters
3720 * (invoked with the wireless_dev mutex held)
3721 * @leave_mesh: leave the current mesh network
3722 * (invoked with the wireless_dev mutex held)
3723 *
3724 * @get_mesh_config: Get the current mesh configuration
3725 *
3726 * @update_mesh_config: Update mesh parameters on a running mesh.
3727 * The mask is a bitfield which tells us which parameters to
3728 * set, and which to leave alone.
3729 *
3730 * @change_bss: Modify parameters for a given BSS.
3731 *
3732 * @set_txq_params: Set TX queue parameters
3733 *
3734 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3735 * as it doesn't implement join_mesh and needs to set the channel to
3736 * join the mesh instead.
3737 *
3738 * @set_monitor_channel: Set the monitor mode channel for the device. If other
3739 * interfaces are active this callback should reject the configuration.
3740 * If no interfaces are active or the device is down, the channel should
3741 * be stored for when a monitor interface becomes active.
3742 *
3743 * @scan: Request to do a scan. If returning zero, the scan request is given
3744 * the driver, and will be valid until passed to cfg80211_scan_done().
3745 * For scan results, call cfg80211_inform_bss(); you can call this outside
3746 * the scan/scan_done bracket too.
3747 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3748 * indicate the status of the scan through cfg80211_scan_done().
3749 *
3750 * @auth: Request to authenticate with the specified peer
3751 * (invoked with the wireless_dev mutex held)
3752 * @assoc: Request to (re)associate with the specified peer
3753 * (invoked with the wireless_dev mutex held)
3754 * @deauth: Request to deauthenticate from the specified peer
3755 * (invoked with the wireless_dev mutex held)
3756 * @disassoc: Request to disassociate from the specified peer
3757 * (invoked with the wireless_dev mutex held)
3758 *
3759 * @connect: Connect to the ESS with the specified parameters. When connected,
3760 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3761 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3762 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3763 * from the AP or cfg80211_connect_timeout() if no frame with status code
3764 * was received.
3765 * The driver is allowed to roam to other BSSes within the ESS when the
3766 * other BSS matches the connect parameters. When such roaming is initiated
3767 * by the driver, the driver is expected to verify that the target matches
3768 * the configured security parameters and to use Reassociation Request
3769 * frame instead of Association Request frame.
3770 * The connect function can also be used to request the driver to perform a
3771 * specific roam when connected to an ESS. In that case, the prev_bssid
3772 * parameter is set to the BSSID of the currently associated BSS as an
3773 * indication of requesting reassociation.
3774 * In both the driver-initiated and new connect() call initiated roaming
3775 * cases, the result of roaming is indicated with a call to
3776 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3777 * @update_connect_params: Update the connect parameters while connected to a
3778 * BSS. The updated parameters can be used by driver/firmware for
3779 * subsequent BSS selection (roaming) decisions and to form the
3780 * Authentication/(Re)Association Request frames. This call does not
3781 * request an immediate disassociation or reassociation with the current
3782 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
3783 * changed are defined in &enum cfg80211_connect_params_changed.
3784 * (invoked with the wireless_dev mutex held)
3785 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3786 * connection is in progress. Once done, call cfg80211_disconnected() in
3787 * case connection was already established (invoked with the
3788 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3789 *
3790 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3791 * cfg80211_ibss_joined(), also call that function when changing BSSID due
3792 * to a merge.
3793 * (invoked with the wireless_dev mutex held)
3794 * @leave_ibss: Leave the IBSS.
3795 * (invoked with the wireless_dev mutex held)
3796 *
3797 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3798 * MESH mode)
3799 *
3800 * @set_wiphy_params: Notify that wiphy parameters have changed;
3801 * @changed bitfield (see &enum wiphy_params_flags) describes which values
3802 * have changed. The actual parameter values are available in
3803 * struct wiphy. If returning an error, no value should be changed.
3804 *
3805 * @set_tx_power: set the transmit power according to the parameters,
3806 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3807 * wdev may be %NULL if power was set for the wiphy, and will
3808 * always be %NULL unless the driver supports per-vif TX power
3809 * (as advertised by the nl80211 feature flag.)
3810 * @get_tx_power: store the current TX power into the dbm variable;
3811 * return 0 if successful
3812 *
3813 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3814 * functions to adjust rfkill hw state
3815 *
3816 * @dump_survey: get site survey information.
3817 *
3818 * @remain_on_channel: Request the driver to remain awake on the specified
3819 * channel for the specified duration to complete an off-channel
3820 * operation (e.g., public action frame exchange). When the driver is
3821 * ready on the requested channel, it must indicate this with an event
3822 * notification by calling cfg80211_ready_on_channel().
3823 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3824 * This allows the operation to be terminated prior to timeout based on
3825 * the duration value.
3826 * @mgmt_tx: Transmit a management frame.
3827 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3828 * frame on another channel
3829 *
3830 * @testmode_cmd: run a test mode command; @wdev may be %NULL
3831 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3832 * used by the function, but 0 and 1 must not be touched. Additionally,
3833 * return error codes other than -ENOBUFS and -ENOENT will terminate the
3834 * dump and return to userspace with an error, so be careful. If any data
3835 * was passed in from userspace then the data/len arguments will be present
3836 * and point to the data contained in %NL80211_ATTR_TESTDATA.
3837 *
3838 * @set_bitrate_mask: set the bitrate mask configuration
3839 *
3840 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3841 * devices running firmwares capable of generating the (re) association
3842 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3843 * @del_pmksa: Delete a cached PMKID.
3844 * @flush_pmksa: Flush all cached PMKIDs.
3845 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3846 * allows the driver to adjust the dynamic ps timeout value.
3847 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3848 * After configuration, the driver should (soon) send an event indicating
3849 * the current level is above/below the configured threshold; this may
3850 * need some care when the configuration is changed (without first being
3851 * disabled.)
3852 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3853 * connection quality monitor. An event is to be sent only when the
3854 * signal level is found to be outside the two values. The driver should
3855 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3856 * If it is provided then there's no point providing @set_cqm_rssi_config.
3857 * @set_cqm_txe_config: Configure connection quality monitor TX error
3858 * thresholds.
3859 * @sched_scan_start: Tell the driver to start a scheduled scan.
3860 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3861 * given request id. This call must stop the scheduled scan and be ready
3862 * for starting a new one before it returns, i.e. @sched_scan_start may be
3863 * called immediately after that again and should not fail in that case.
3864 * The driver should not call cfg80211_sched_scan_stopped() for a requested
3865 * stop (when this method returns 0).
3866 *
3867 * @update_mgmt_frame_registrations: Notify the driver that management frame
3868 * registrations were updated. The callback is allowed to sleep.
3869 *
3870 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3871 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3872 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3873 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3874 *
3875 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3876 *
3877 * @tdls_mgmt: Transmit a TDLS management frame.
3878 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3879 *
3880 * @probe_client: probe an associated client, must return a cookie that it
3881 * later passes to cfg80211_probe_status().
3882 *
3883 * @set_noack_map: Set the NoAck Map for the TIDs.
3884 *
3885 * @get_channel: Get the current operating channel for the virtual interface.
3886 * For monitor interfaces, it should return %NULL unless there's a single
3887 * current monitoring channel.
3888 *
3889 * @start_p2p_device: Start the given P2P device.
3890 * @stop_p2p_device: Stop the given P2P device.
3891 *
3892 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3893 * Parameters include ACL policy, an array of MAC address of stations
3894 * and the number of MAC addresses. If there is already a list in driver
3895 * this new list replaces the existing one. Driver has to clear its ACL
3896 * when number of MAC addresses entries is passed as 0. Drivers which
3897 * advertise the support for MAC based ACL have to implement this callback.
3898 *
3899 * @start_radar_detection: Start radar detection in the driver.
3900 *
3901 * @end_cac: End running CAC, probably because a related CAC
3902 * was finished on another phy.
3903 *
3904 * @update_ft_ies: Provide updated Fast BSS Transition information to the
3905 * driver. If the SME is in the driver/firmware, this information can be
3906 * used in building Authentication and Reassociation Request frames.
3907 *
3908 * @crit_proto_start: Indicates a critical protocol needs more link reliability
3909 * for a given duration (milliseconds). The protocol is provided so the
3910 * driver can take the most appropriate actions.
3911 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3912 * reliability. This operation can not fail.
3913 * @set_coalesce: Set coalesce parameters.
3914 *
3915 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3916 * responsible for veryfing if the switch is possible. Since this is
3917 * inherently tricky driver may decide to disconnect an interface later
3918 * with cfg80211_stop_iface(). This doesn't mean driver can accept
3919 * everything. It should do it's best to verify requests and reject them
3920 * as soon as possible.
3921 *
3922 * @set_qos_map: Set QoS mapping information to the driver
3923 *
3924 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3925 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3926 * changes during the lifetime of the BSS.
3927 *
3928 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3929 * with the given parameters; action frame exchange has been handled by
3930 * userspace so this just has to modify the TX path to take the TS into
3931 * account.
3932 * If the admitted time is 0 just validate the parameters to make sure
3933 * the session can be created at all; it is valid to just always return
3934 * success for that but that may result in inefficient behaviour (handshake
3935 * with the peer followed by immediate teardown when the addition is later
3936 * rejected)
3937 * @del_tx_ts: remove an existing TX TS
3938 *
3939 * @join_ocb: join the OCB network with the specified parameters
3940 * (invoked with the wireless_dev mutex held)
3941 * @leave_ocb: leave the current OCB network
3942 * (invoked with the wireless_dev mutex held)
3943 *
3944 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3945 * is responsible for continually initiating channel-switching operations
3946 * and returning to the base channel for communication with the AP.
3947 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3948 * peers must be on the base channel when the call completes.
3949 * @start_nan: Start the NAN interface.
3950 * @stop_nan: Stop the NAN interface.
3951 * @add_nan_func: Add a NAN function. Returns negative value on failure.
3952 * On success @nan_func ownership is transferred to the driver and
3953 * it may access it outside of the scope of this function. The driver
3954 * should free the @nan_func when no longer needed by calling
3955 * cfg80211_free_nan_func().
3956 * On success the driver should assign an instance_id in the
3957 * provided @nan_func.
3958 * @del_nan_func: Delete a NAN function.
3959 * @nan_change_conf: changes NAN configuration. The changed parameters must
3960 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3961 * All other parameters must be ignored.
3962 *
3963 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3964 *
3965 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3966 * function should return phy stats, and interface stats otherwise.
3967 *
3968 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3969 * If not deleted through @del_pmk the PMK remains valid until disconnect
3970 * upon which the driver should clear it.
3971 * (invoked with the wireless_dev mutex held)
3972 * @del_pmk: delete the previously configured PMK for the given authenticator.
3973 * (invoked with the wireless_dev mutex held)
3974 *
3975 * @external_auth: indicates result of offloaded authentication processing from
3976 * user space
3977 *
3978 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3979 * tells the driver that the frame should not be encrypted.
3980 *
3981 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3982 * Statistics should be cumulative, currently no way to reset is provided.
3983 * @start_pmsr: start peer measurement (e.g. FTM)
3984 * @abort_pmsr: abort peer measurement
3985 *
3986 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3987 * but offloading OWE processing to the user space will get the updated
3988 * DH IE through this interface.
3989 *
3990 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3991 * and overrule HWMP path selection algorithm.
3992 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
3993 * This callback may sleep.
3994 * @reset_tid_config: Reset TID specific configuration for the peer, for the
3995 * given TIDs. This callback may sleep.
3996 *
3997 * @set_sar_specs: Update the SAR (TX power) settings.
3998 */
3999struct cfg80211_ops {
4000 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
4001 int (*resume)(struct wiphy *wiphy);
4002 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
4003
4004 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
4005 const char *name,
4006 unsigned char name_assign_type,
4007 enum nl80211_iftype type,
4008 struct vif_params *params);
4009 int (*del_virtual_intf)(struct wiphy *wiphy,
4010 struct wireless_dev *wdev);
4011 int (*change_virtual_intf)(struct wiphy *wiphy,
4012 struct net_device *dev,
4013 enum nl80211_iftype type,
4014 struct vif_params *params);
4015
4016 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4017 u8 key_index, bool pairwise, const u8 *mac_addr,
4018 struct key_params *params);
4019 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4020 u8 key_index, bool pairwise, const u8 *mac_addr,
4021 void *cookie,
4022 void (*callback)(void *cookie, struct key_params*));
4023 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4024 u8 key_index, bool pairwise, const u8 *mac_addr);
4025 int (*set_default_key)(struct wiphy *wiphy,
4026 struct net_device *netdev,
4027 u8 key_index, bool unicast, bool multicast);
4028 int (*set_default_mgmt_key)(struct wiphy *wiphy,
4029 struct net_device *netdev,
4030 u8 key_index);
4031 int (*set_default_beacon_key)(struct wiphy *wiphy,
4032 struct net_device *netdev,
4033 u8 key_index);
4034
4035 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4036 struct cfg80211_ap_settings *settings);
4037 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4038 struct cfg80211_beacon_data *info);
4039 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
4040
4041
4042 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
4043 const u8 *mac,
4044 struct station_parameters *params);
4045 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
4046 struct station_del_parameters *params);
4047 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
4048 const u8 *mac,
4049 struct station_parameters *params);
4050 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
4051 const u8 *mac, struct station_info *sinfo);
4052 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4053 int idx, u8 *mac, struct station_info *sinfo);
4054
4055 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4056 const u8 *dst, const u8 *next_hop);
4057 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4058 const u8 *dst);
4059 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4060 const u8 *dst, const u8 *next_hop);
4061 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4062 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4063 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4064 int idx, u8 *dst, u8 *next_hop,
4065 struct mpath_info *pinfo);
4066 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4067 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4068 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4069 int idx, u8 *dst, u8 *mpp,
4070 struct mpath_info *pinfo);
4071 int (*get_mesh_config)(struct wiphy *wiphy,
4072 struct net_device *dev,
4073 struct mesh_config *conf);
4074 int (*update_mesh_config)(struct wiphy *wiphy,
4075 struct net_device *dev, u32 mask,
4076 const struct mesh_config *nconf);
4077 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4078 const struct mesh_config *conf,
4079 const struct mesh_setup *setup);
4080 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4081
4082 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4083 struct ocb_setup *setup);
4084 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4085
4086 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4087 struct bss_parameters *params);
4088
4089 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4090 struct ieee80211_txq_params *params);
4091
4092 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4093 struct net_device *dev,
4094 struct ieee80211_channel *chan);
4095
4096 int (*set_monitor_channel)(struct wiphy *wiphy,
4097 struct cfg80211_chan_def *chandef);
4098
4099 int (*scan)(struct wiphy *wiphy,
4100 struct cfg80211_scan_request *request);
4101 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4102
4103 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4104 struct cfg80211_auth_request *req);
4105 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4106 struct cfg80211_assoc_request *req);
4107 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4108 struct cfg80211_deauth_request *req);
4109 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4110 struct cfg80211_disassoc_request *req);
4111
4112 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4113 struct cfg80211_connect_params *sme);
4114 int (*update_connect_params)(struct wiphy *wiphy,
4115 struct net_device *dev,
4116 struct cfg80211_connect_params *sme,
4117 u32 changed);
4118 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4119 u16 reason_code);
4120
4121 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4122 struct cfg80211_ibss_params *params);
4123 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4124
4125 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4126 int rate[NUM_NL80211_BANDS]);
4127
4128 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4129
4130 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4131 enum nl80211_tx_power_setting type, int mbm);
4132 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4133 int *dbm);
4134
4135 void (*rfkill_poll)(struct wiphy *wiphy);
4136
4137#ifdef CONFIG_NL80211_TESTMODE
4138 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4139 void *data, int len);
4140 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4141 struct netlink_callback *cb,
4142 void *data, int len);
4143#endif
4144
4145 int (*set_bitrate_mask)(struct wiphy *wiphy,
4146 struct net_device *dev,
4147 const u8 *peer,
4148 const struct cfg80211_bitrate_mask *mask);
4149
4150 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4151 int idx, struct survey_info *info);
4152
4153 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4154 struct cfg80211_pmksa *pmksa);
4155 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4156 struct cfg80211_pmksa *pmksa);
4157 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4158
4159 int (*remain_on_channel)(struct wiphy *wiphy,
4160 struct wireless_dev *wdev,
4161 struct ieee80211_channel *chan,
4162 unsigned int duration,
4163 u64 *cookie);
4164 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4165 struct wireless_dev *wdev,
4166 u64 cookie);
4167
4168 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4169 struct cfg80211_mgmt_tx_params *params,
4170 u64 *cookie);
4171 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4172 struct wireless_dev *wdev,
4173 u64 cookie);
4174
4175 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4176 bool enabled, int timeout);
4177
4178 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4179 struct net_device *dev,
4180 s32 rssi_thold, u32 rssi_hyst);
4181
4182 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4183 struct net_device *dev,
4184 s32 rssi_low, s32 rssi_high);
4185
4186 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4187 struct net_device *dev,
4188 u32 rate, u32 pkts, u32 intvl);
4189
4190 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4191 struct wireless_dev *wdev,
4192 struct mgmt_frame_regs *upd);
4193
4194 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4195 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4196
4197 int (*sched_scan_start)(struct wiphy *wiphy,
4198 struct net_device *dev,
4199 struct cfg80211_sched_scan_request *request);
4200 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4201 u64 reqid);
4202
4203 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4204 struct cfg80211_gtk_rekey_data *data);
4205
4206 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4207 const u8 *peer, u8 action_code, u8 dialog_token,
4208 u16 status_code, u32 peer_capability,
4209 bool initiator, const u8 *buf, size_t len);
4210 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4211 const u8 *peer, enum nl80211_tdls_operation oper);
4212
4213 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4214 const u8 *peer, u64 *cookie);
4215
4216 int (*set_noack_map)(struct wiphy *wiphy,
4217 struct net_device *dev,
4218 u16 noack_map);
4219
4220 int (*get_channel)(struct wiphy *wiphy,
4221 struct wireless_dev *wdev,
4222 struct cfg80211_chan_def *chandef);
4223
4224 int (*start_p2p_device)(struct wiphy *wiphy,
4225 struct wireless_dev *wdev);
4226 void (*stop_p2p_device)(struct wiphy *wiphy,
4227 struct wireless_dev *wdev);
4228
4229 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4230 const struct cfg80211_acl_data *params);
4231
4232 int (*start_radar_detection)(struct wiphy *wiphy,
4233 struct net_device *dev,
4234 struct cfg80211_chan_def *chandef,
4235 u32 cac_time_ms);
4236 void (*end_cac)(struct wiphy *wiphy,
4237 struct net_device *dev);
4238 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4239 struct cfg80211_update_ft_ies_params *ftie);
4240 int (*crit_proto_start)(struct wiphy *wiphy,
4241 struct wireless_dev *wdev,
4242 enum nl80211_crit_proto_id protocol,
4243 u16 duration);
4244 void (*crit_proto_stop)(struct wiphy *wiphy,
4245 struct wireless_dev *wdev);
4246 int (*set_coalesce)(struct wiphy *wiphy,
4247 struct cfg80211_coalesce *coalesce);
4248
4249 int (*channel_switch)(struct wiphy *wiphy,
4250 struct net_device *dev,
4251 struct cfg80211_csa_settings *params);
4252
4253 int (*set_qos_map)(struct wiphy *wiphy,
4254 struct net_device *dev,
4255 struct cfg80211_qos_map *qos_map);
4256
4257 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4258 struct cfg80211_chan_def *chandef);
4259
4260 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4261 u8 tsid, const u8 *peer, u8 user_prio,
4262 u16 admitted_time);
4263 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4264 u8 tsid, const u8 *peer);
4265
4266 int (*tdls_channel_switch)(struct wiphy *wiphy,
4267 struct net_device *dev,
4268 const u8 *addr, u8 oper_class,
4269 struct cfg80211_chan_def *chandef);
4270 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4271 struct net_device *dev,
4272 const u8 *addr);
4273 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4274 struct cfg80211_nan_conf *conf);
4275 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4276 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4277 struct cfg80211_nan_func *nan_func);
4278 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4279 u64 cookie);
4280 int (*nan_change_conf)(struct wiphy *wiphy,
4281 struct wireless_dev *wdev,
4282 struct cfg80211_nan_conf *conf,
4283 u32 changes);
4284
4285 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4286 struct net_device *dev,
4287 const bool enabled);
4288
4289 int (*get_txq_stats)(struct wiphy *wiphy,
4290 struct wireless_dev *wdev,
4291 struct cfg80211_txq_stats *txqstats);
4292
4293 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4294 const struct cfg80211_pmk_conf *conf);
4295 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4296 const u8 *aa);
4297 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4298 struct cfg80211_external_auth_params *params);
4299
4300 int (*tx_control_port)(struct wiphy *wiphy,
4301 struct net_device *dev,
4302 const u8 *buf, size_t len,
4303 const u8 *dest, const __be16 proto,
4304 const bool noencrypt,
4305 u64 *cookie);
4306
4307 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4308 struct net_device *dev,
4309 struct cfg80211_ftm_responder_stats *ftm_stats);
4310
4311 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4312 struct cfg80211_pmsr_request *request);
4313 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4314 struct cfg80211_pmsr_request *request);
4315 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4316 struct cfg80211_update_owe_info *owe_info);
4317 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4318 const u8 *buf, size_t len);
4319 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4320 struct cfg80211_tid_config *tid_conf);
4321 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4322 const u8 *peer, u8 tids);
4323 int (*set_sar_specs)(struct wiphy *wiphy,
4324 struct cfg80211_sar_specs *sar);
4325};
4326
4327/*
4328 * wireless hardware and networking interfaces structures
4329 * and registration/helper functions
4330 */
4331
4332/**
4333 * enum wiphy_flags - wiphy capability flags
4334 *
4335 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4336 * into two, first for legacy bands and second for UHB.
4337 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4338 * wiphy at all
4339 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4340 * by default -- this flag will be set depending on the kernel's default
4341 * on wiphy_new(), but can be changed by the driver if it has a good
4342 * reason to override the default
4343 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4344 * on a VLAN interface). This flag also serves an extra purpose of
4345 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4346 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4347 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4348 * control port protocol ethertype. The device also honours the
4349 * control_port_no_encrypt flag.
4350 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4351 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4352 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4353 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4354 * firmware.
4355 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4356 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4357 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4358 * link setup/discovery operations internally. Setup, discovery and
4359 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4360 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4361 * used for asking the driver/firmware to perform a TDLS operation.
4362 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4363 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4364 * when there are virtual interfaces in AP mode by calling
4365 * cfg80211_report_obss_beacon().
4366 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4367 * responds to probe-requests in hardware.
4368 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4369 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4370 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4371 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4372 * beaconing mode (AP, IBSS, Mesh, ...).
4373 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4374 * before connection.
4375 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4376 */
4377enum wiphy_flags {
4378 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4379 /* use hole at 1 */
4380 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4381 WIPHY_FLAG_NETNS_OK = BIT(3),
4382 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4383 WIPHY_FLAG_4ADDR_AP = BIT(5),
4384 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4385 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4386 WIPHY_FLAG_IBSS_RSN = BIT(8),
4387 WIPHY_FLAG_MESH_AUTH = BIT(10),
4388 /* use hole at 11 */
4389 /* use hole at 12 */
4390 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4391 WIPHY_FLAG_AP_UAPSD = BIT(14),
4392 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4393 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4394 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4395 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4396 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4397 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4398 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4399 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4400 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4401 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4402};
4403
4404/**
4405 * struct ieee80211_iface_limit - limit on certain interface types
4406 * @max: maximum number of interfaces of these types
4407 * @types: interface types (bits)
4408 */
4409struct ieee80211_iface_limit {
4410 u16 max;
4411 u16 types;
4412};
4413
4414/**
4415 * struct ieee80211_iface_combination - possible interface combination
4416 *
4417 * With this structure the driver can describe which interface
4418 * combinations it supports concurrently.
4419 *
4420 * Examples:
4421 *
4422 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4423 *
4424 * .. code-block:: c
4425 *
4426 * struct ieee80211_iface_limit limits1[] = {
4427 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4428 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4429 * };
4430 * struct ieee80211_iface_combination combination1 = {
4431 * .limits = limits1,
4432 * .n_limits = ARRAY_SIZE(limits1),
4433 * .max_interfaces = 2,
4434 * .beacon_int_infra_match = true,
4435 * };
4436 *
4437 *
4438 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4439 *
4440 * .. code-block:: c
4441 *
4442 * struct ieee80211_iface_limit limits2[] = {
4443 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4444 * BIT(NL80211_IFTYPE_P2P_GO), },
4445 * };
4446 * struct ieee80211_iface_combination combination2 = {
4447 * .limits = limits2,
4448 * .n_limits = ARRAY_SIZE(limits2),
4449 * .max_interfaces = 8,
4450 * .num_different_channels = 1,
4451 * };
4452 *
4453 *
4454 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4455 *
4456 * This allows for an infrastructure connection and three P2P connections.
4457 *
4458 * .. code-block:: c
4459 *
4460 * struct ieee80211_iface_limit limits3[] = {
4461 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4462 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4463 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4464 * };
4465 * struct ieee80211_iface_combination combination3 = {
4466 * .limits = limits3,
4467 * .n_limits = ARRAY_SIZE(limits3),
4468 * .max_interfaces = 4,
4469 * .num_different_channels = 2,
4470 * };
4471 *
4472 */
4473struct ieee80211_iface_combination {
4474 /**
4475 * @limits:
4476 * limits for the given interface types
4477 */
4478 const struct ieee80211_iface_limit *limits;
4479
4480 /**
4481 * @num_different_channels:
4482 * can use up to this many different channels
4483 */
4484 u32 num_different_channels;
4485
4486 /**
4487 * @max_interfaces:
4488 * maximum number of interfaces in total allowed in this group
4489 */
4490 u16 max_interfaces;
4491
4492 /**
4493 * @n_limits:
4494 * number of limitations
4495 */
4496 u8 n_limits;
4497
4498 /**
4499 * @beacon_int_infra_match:
4500 * In this combination, the beacon intervals between infrastructure
4501 * and AP types must match. This is required only in special cases.
4502 */
4503 bool beacon_int_infra_match;
4504
4505 /**
4506 * @radar_detect_widths:
4507 * bitmap of channel widths supported for radar detection
4508 */
4509 u8 radar_detect_widths;
4510
4511 /**
4512 * @radar_detect_regions:
4513 * bitmap of regions supported for radar detection
4514 */
4515 u8 radar_detect_regions;
4516
4517 /**
4518 * @beacon_int_min_gcd:
4519 * This interface combination supports different beacon intervals.
4520 *
4521 * = 0
4522 * all beacon intervals for different interface must be same.
4523 * > 0
4524 * any beacon interval for the interface part of this combination AND
4525 * GCD of all beacon intervals from beaconing interfaces of this
4526 * combination must be greater or equal to this value.
4527 */
4528 u32 beacon_int_min_gcd;
4529};
4530
4531struct ieee80211_txrx_stypes {
4532 u16 tx, rx;
4533};
4534
4535/**
4536 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4537 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4538 * trigger that keeps the device operating as-is and
4539 * wakes up the host on any activity, for example a
4540 * received packet that passed filtering; note that the
4541 * packet should be preserved in that case
4542 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4543 * (see nl80211.h)
4544 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4545 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4546 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4547 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4548 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4549 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4550 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4551 */
4552enum wiphy_wowlan_support_flags {
4553 WIPHY_WOWLAN_ANY = BIT(0),
4554 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4555 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4556 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4557 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4558 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4559 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4560 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4561 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4562};
4563
4564struct wiphy_wowlan_tcp_support {
4565 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4566 u32 data_payload_max;
4567 u32 data_interval_max;
4568 u32 wake_payload_max;
4569 bool seq;
4570};
4571
4572/**
4573 * struct wiphy_wowlan_support - WoWLAN support data
4574 * @flags: see &enum wiphy_wowlan_support_flags
4575 * @n_patterns: number of supported wakeup patterns
4576 * (see nl80211.h for the pattern definition)
4577 * @pattern_max_len: maximum length of each pattern
4578 * @pattern_min_len: minimum length of each pattern
4579 * @max_pkt_offset: maximum Rx packet offset
4580 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4581 * similar, but not necessarily identical, to max_match_sets for
4582 * scheduled scans.
4583 * See &struct cfg80211_sched_scan_request.@match_sets for more
4584 * details.
4585 * @tcp: TCP wakeup support information
4586 */
4587struct wiphy_wowlan_support {
4588 u32 flags;
4589 int n_patterns;
4590 int pattern_max_len;
4591 int pattern_min_len;
4592 int max_pkt_offset;
4593 int max_nd_match_sets;
4594 const struct wiphy_wowlan_tcp_support *tcp;
4595};
4596
4597/**
4598 * struct wiphy_coalesce_support - coalesce support data
4599 * @n_rules: maximum number of coalesce rules
4600 * @max_delay: maximum supported coalescing delay in msecs
4601 * @n_patterns: number of supported patterns in a rule
4602 * (see nl80211.h for the pattern definition)
4603 * @pattern_max_len: maximum length of each pattern
4604 * @pattern_min_len: minimum length of each pattern
4605 * @max_pkt_offset: maximum Rx packet offset
4606 */
4607struct wiphy_coalesce_support {
4608 int n_rules;
4609 int max_delay;
4610 int n_patterns;
4611 int pattern_max_len;
4612 int pattern_min_len;
4613 int max_pkt_offset;
4614};
4615
4616/**
4617 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4618 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4619 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4620 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4621 * (must be combined with %_WDEV or %_NETDEV)
4622 */
4623enum wiphy_vendor_command_flags {
4624 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4625 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4626 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4627};
4628
4629/**
4630 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4631 *
4632 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4633 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4634 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4635 *
4636 */
4637enum wiphy_opmode_flag {
4638 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
4639 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
4640 STA_OPMODE_N_SS_CHANGED = BIT(2),
4641};
4642
4643/**
4644 * struct sta_opmode_info - Station's ht/vht operation mode information
4645 * @changed: contains value from &enum wiphy_opmode_flag
4646 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4647 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4648 * @rx_nss: new rx_nss value of a station
4649 */
4650
4651struct sta_opmode_info {
4652 u32 changed;
4653 enum nl80211_smps_mode smps_mode;
4654 enum nl80211_chan_width bw;
4655 u8 rx_nss;
4656};
4657
4658#define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4659
4660/**
4661 * struct wiphy_vendor_command - vendor command definition
4662 * @info: vendor command identifying information, as used in nl80211
4663 * @flags: flags, see &enum wiphy_vendor_command_flags
4664 * @doit: callback for the operation, note that wdev is %NULL if the
4665 * flags didn't ask for a wdev and non-%NULL otherwise; the data
4666 * pointer may be %NULL if userspace provided no data at all
4667 * @dumpit: dump callback, for transferring bigger/multiple items. The
4668 * @storage points to cb->args[5], ie. is preserved over the multiple
4669 * dumpit calls.
4670 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4671 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4672 * attribute is just raw data (e.g. a firmware command).
4673 * @maxattr: highest attribute number in policy
4674 * It's recommended to not have the same sub command with both @doit and
4675 * @dumpit, so that userspace can assume certain ones are get and others
4676 * are used with dump requests.
4677 */
4678struct wiphy_vendor_command {
4679 struct nl80211_vendor_cmd_info info;
4680 u32 flags;
4681 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4682 const void *data, int data_len);
4683 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4684 struct sk_buff *skb, const void *data, int data_len,
4685 unsigned long *storage);
4686 const struct nla_policy *policy;
4687 unsigned int maxattr;
4688};
4689
4690/**
4691 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4692 * @iftype: interface type
4693 * @extended_capabilities: extended capabilities supported by the driver,
4694 * additional capabilities might be supported by userspace; these are the
4695 * 802.11 extended capabilities ("Extended Capabilities element") and are
4696 * in the same format as in the information element. See IEEE Std
4697 * 802.11-2012 8.4.2.29 for the defined fields.
4698 * @extended_capabilities_mask: mask of the valid values
4699 * @extended_capabilities_len: length of the extended capabilities
4700 */
4701struct wiphy_iftype_ext_capab {
4702 enum nl80211_iftype iftype;
4703 const u8 *extended_capabilities;
4704 const u8 *extended_capabilities_mask;
4705 u8 extended_capabilities_len;
4706};
4707
4708/**
4709 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4710 * @max_peers: maximum number of peers in a single measurement
4711 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4712 * @randomize_mac_addr: can randomize MAC address for measurement
4713 * @ftm.supported: FTM measurement is supported
4714 * @ftm.asap: ASAP-mode is supported
4715 * @ftm.non_asap: non-ASAP-mode is supported
4716 * @ftm.request_lci: can request LCI data
4717 * @ftm.request_civicloc: can request civic location data
4718 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4719 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4720 * @ftm.max_bursts_exponent: maximum burst exponent supported
4721 * (set to -1 if not limited; note that setting this will necessarily
4722 * forbid using the value 15 to let the responder pick)
4723 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4724 * not limited)
4725 * @ftm.trigger_based: trigger based ranging measurement is supported
4726 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
4727 */
4728struct cfg80211_pmsr_capabilities {
4729 unsigned int max_peers;
4730 u8 report_ap_tsf:1,
4731 randomize_mac_addr:1;
4732
4733 struct {
4734 u32 preambles;
4735 u32 bandwidths;
4736 s8 max_bursts_exponent;
4737 u8 max_ftms_per_burst;
4738 u8 supported:1,
4739 asap:1,
4740 non_asap:1,
4741 request_lci:1,
4742 request_civicloc:1,
4743 trigger_based:1,
4744 non_trigger_based:1;
4745 } ftm;
4746};
4747
4748/**
4749 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
4750 * suites for interface types defined in @iftypes_mask. Each type in the
4751 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
4752 *
4753 * @iftypes_mask: bitmask of interfaces types
4754 * @akm_suites: points to an array of supported akm suites
4755 * @n_akm_suites: number of supported AKM suites
4756 */
4757struct wiphy_iftype_akm_suites {
4758 u16 iftypes_mask;
4759 const u32 *akm_suites;
4760 int n_akm_suites;
4761};
4762
4763/**
4764 * struct wiphy - wireless hardware description
4765 * @mtx: mutex for the data (structures) of this device
4766 * @reg_notifier: the driver's regulatory notification callback,
4767 * note that if your driver uses wiphy_apply_custom_regulatory()
4768 * the reg_notifier's request can be passed as NULL
4769 * @regd: the driver's regulatory domain, if one was requested via
4770 * the regulatory_hint() API. This can be used by the driver
4771 * on the reg_notifier() if it chooses to ignore future
4772 * regulatory domain changes caused by other drivers.
4773 * @signal_type: signal type reported in &struct cfg80211_bss.
4774 * @cipher_suites: supported cipher suites
4775 * @n_cipher_suites: number of supported cipher suites
4776 * @akm_suites: supported AKM suites. These are the default AKMs supported if
4777 * the supported AKMs not advertized for a specific interface type in
4778 * iftype_akm_suites.
4779 * @n_akm_suites: number of supported AKM suites
4780 * @iftype_akm_suites: array of supported akm suites info per interface type.
4781 * Note that the bits in @iftypes_mask inside this structure cannot
4782 * overlap (i.e. only one occurrence of each type is allowed across all
4783 * instances of iftype_akm_suites).
4784 * @num_iftype_akm_suites: number of interface types for which supported akm
4785 * suites are specified separately.
4786 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4787 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4788 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4789 * -1 = fragmentation disabled, only odd values >= 256 used
4790 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4791 * @_net: the network namespace this wiphy currently lives in
4792 * @perm_addr: permanent MAC address of this device
4793 * @addr_mask: If the device supports multiple MAC addresses by masking,
4794 * set this to a mask with variable bits set to 1, e.g. if the last
4795 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
4796 * variable bits shall be determined by the interfaces added, with
4797 * interfaces not matching the mask being rejected to be brought up.
4798 * @n_addresses: number of addresses in @addresses.
4799 * @addresses: If the device has more than one address, set this pointer
4800 * to a list of addresses (6 bytes each). The first one will be used
4801 * by default for perm_addr. In this case, the mask should be set to
4802 * all-zeroes. In this case it is assumed that the device can handle
4803 * the same number of arbitrary MAC addresses.
4804 * @registered: protects ->resume and ->suspend sysfs callbacks against
4805 * unregister hardware
4806 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
4807 * It will be renamed automatically on wiphy renames
4808 * @dev: (virtual) struct device for this wiphy. The item in
4809 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
4810 * (see below).
4811 * @wext: wireless extension handlers
4812 * @priv: driver private data (sized according to wiphy_new() parameter)
4813 * @interface_modes: bitmask of interfaces types valid for this wiphy,
4814 * must be set by driver
4815 * @iface_combinations: Valid interface combinations array, should not
4816 * list single interface types.
4817 * @n_iface_combinations: number of entries in @iface_combinations array.
4818 * @software_iftypes: bitmask of software interface types, these are not
4819 * subject to any restrictions since they are purely managed in SW.
4820 * @flags: wiphy flags, see &enum wiphy_flags
4821 * @regulatory_flags: wiphy regulatory flags, see
4822 * &enum ieee80211_regulatory_flags
4823 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4824 * @ext_features: extended features advertised to nl80211, see
4825 * &enum nl80211_ext_feature_index.
4826 * @bss_priv_size: each BSS struct has private data allocated with it,
4827 * this variable determines its size
4828 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4829 * any given scan
4830 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4831 * the device can run concurrently.
4832 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4833 * for in any given scheduled scan
4834 * @max_match_sets: maximum number of match sets the device can handle
4835 * when performing a scheduled scan, 0 if filtering is not
4836 * supported.
4837 * @max_scan_ie_len: maximum length of user-controlled IEs device can
4838 * add to probe request frames transmitted during a scan, must not
4839 * include fixed IEs like supported rates
4840 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4841 * scans
4842 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4843 * of iterations) for scheduled scan supported by the device.
4844 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4845 * single scan plan supported by the device.
4846 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4847 * scan plan supported by the device.
4848 * @coverage_class: current coverage class
4849 * @fw_version: firmware version for ethtool reporting
4850 * @hw_version: hardware version for ethtool reporting
4851 * @max_num_pmkids: maximum number of PMKIDs supported by device
4852 * @privid: a pointer that drivers can use to identify if an arbitrary
4853 * wiphy is theirs, e.g. in global notifiers
4854 * @bands: information about bands/channels supported by this device
4855 *
4856 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4857 * transmitted through nl80211, points to an array indexed by interface
4858 * type
4859 *
4860 * @available_antennas_tx: bitmap of antennas which are available to be
4861 * configured as TX antennas. Antenna configuration commands will be
4862 * rejected unless this or @available_antennas_rx is set.
4863 *
4864 * @available_antennas_rx: bitmap of antennas which are available to be
4865 * configured as RX antennas. Antenna configuration commands will be
4866 * rejected unless this or @available_antennas_tx is set.
4867 *
4868 * @probe_resp_offload:
4869 * Bitmap of supported protocols for probe response offloading.
4870 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
4871 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4872 *
4873 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4874 * may request, if implemented.
4875 *
4876 * @wowlan: WoWLAN support information
4877 * @wowlan_config: current WoWLAN configuration; this should usually not be
4878 * used since access to it is necessarily racy, use the parameter passed
4879 * to the suspend() operation instead.
4880 *
4881 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4882 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
4883 * If null, then none can be over-ridden.
4884 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
4885 * If null, then none can be over-ridden.
4886 *
4887 * @wdev_list: the list of associated (virtual) interfaces; this list must
4888 * not be modified by the driver, but can be read with RTNL/RCU protection.
4889 *
4890 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4891 * supports for ACL.
4892 *
4893 * @extended_capabilities: extended capabilities supported by the driver,
4894 * additional capabilities might be supported by userspace; these are
4895 * the 802.11 extended capabilities ("Extended Capabilities element")
4896 * and are in the same format as in the information element. See
4897 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
4898 * extended capabilities to be used if the capabilities are not specified
4899 * for a specific interface type in iftype_ext_capab.
4900 * @extended_capabilities_mask: mask of the valid values
4901 * @extended_capabilities_len: length of the extended capabilities
4902 * @iftype_ext_capab: array of extended capabilities per interface type
4903 * @num_iftype_ext_capab: number of interface types for which extended
4904 * capabilities are specified separately.
4905 * @coalesce: packet coalescing support information
4906 *
4907 * @vendor_commands: array of vendor commands supported by the hardware
4908 * @n_vendor_commands: number of vendor commands
4909 * @vendor_events: array of vendor events supported by the hardware
4910 * @n_vendor_events: number of vendor events
4911 *
4912 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4913 * (including P2P GO) or 0 to indicate no such limit is advertised. The
4914 * driver is allowed to advertise a theoretical limit that it can reach in
4915 * some cases, but may not always reach.
4916 *
4917 * @max_num_csa_counters: Number of supported csa_counters in beacons
4918 * and probe responses. This value should be set if the driver
4919 * wishes to limit the number of csa counters. Default (0) means
4920 * infinite.
4921 * @bss_select_support: bitmask indicating the BSS selection criteria supported
4922 * by the driver in the .connect() callback. The bit position maps to the
4923 * attribute indices defined in &enum nl80211_bss_select_attr.
4924 *
4925 * @nan_supported_bands: bands supported by the device in NAN mode, a
4926 * bitmap of &enum nl80211_band values. For instance, for
4927 * NL80211_BAND_2GHZ, bit 0 would be set
4928 * (i.e. BIT(NL80211_BAND_2GHZ)).
4929 *
4930 * @txq_limit: configuration of internal TX queue frame limit
4931 * @txq_memory_limit: configuration internal TX queue memory limit
4932 * @txq_quantum: configuration of internal TX queue scheduler quantum
4933 *
4934 * @tx_queue_len: allow setting transmit queue len for drivers not using
4935 * wake_tx_queue
4936 *
4937 * @support_mbssid: can HW support association with nontransmitted AP
4938 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4939 * HE AP, in order to avoid compatibility issues.
4940 * @support_mbssid must be set for this to have any effect.
4941 *
4942 * @pmsr_capa: peer measurement capabilities
4943 *
4944 * @tid_config_support: describes the per-TID config support that the
4945 * device has
4946 * @tid_config_support.vif: bitmap of attributes (configurations)
4947 * supported by the driver for each vif
4948 * @tid_config_support.peer: bitmap of attributes (configurations)
4949 * supported by the driver for each peer
4950 * @tid_config_support.max_retry: maximum supported retry count for
4951 * long/short retry configuration
4952 *
4953 * @max_data_retry_count: maximum supported per TID retry count for
4954 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
4955 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
4956 * @sar_capa: SAR control capabilities
4957 * @rfkill: a pointer to the rfkill structure
4958 */
4959struct wiphy {
4960 struct mutex mtx;
4961
4962 /* assign these fields before you register the wiphy */
4963
4964 u8 perm_addr[ETH_ALEN];
4965 u8 addr_mask[ETH_ALEN];
4966
4967 struct mac_address *addresses;
4968
4969 const struct ieee80211_txrx_stypes *mgmt_stypes;
4970
4971 const struct ieee80211_iface_combination *iface_combinations;
4972 int n_iface_combinations;
4973 u16 software_iftypes;
4974
4975 u16 n_addresses;
4976
4977 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4978 u16 interface_modes;
4979
4980 u16 max_acl_mac_addrs;
4981
4982 u32 flags, regulatory_flags, features;
4983 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4984
4985 u32 ap_sme_capa;
4986
4987 enum cfg80211_signal_type signal_type;
4988
4989 int bss_priv_size;
4990 u8 max_scan_ssids;
4991 u8 max_sched_scan_reqs;
4992 u8 max_sched_scan_ssids;
4993 u8 max_match_sets;
4994 u16 max_scan_ie_len;
4995 u16 max_sched_scan_ie_len;
4996 u32 max_sched_scan_plans;
4997 u32 max_sched_scan_plan_interval;
4998 u32 max_sched_scan_plan_iterations;
4999
5000 int n_cipher_suites;
5001 const u32 *cipher_suites;
5002
5003 int n_akm_suites;
5004 const u32 *akm_suites;
5005
5006 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
5007 unsigned int num_iftype_akm_suites;
5008
5009 u8 retry_short;
5010 u8 retry_long;
5011 u32 frag_threshold;
5012 u32 rts_threshold;
5013 u8 coverage_class;
5014
5015 char fw_version[ETHTOOL_FWVERS_LEN];
5016 u32 hw_version;
5017
5018#ifdef CONFIG_PM
5019 const struct wiphy_wowlan_support *wowlan;
5020 struct cfg80211_wowlan *wowlan_config;
5021#endif
5022
5023 u16 max_remain_on_channel_duration;
5024
5025 u8 max_num_pmkids;
5026
5027 u32 available_antennas_tx;
5028 u32 available_antennas_rx;
5029
5030 u32 probe_resp_offload;
5031
5032 const u8 *extended_capabilities, *extended_capabilities_mask;
5033 u8 extended_capabilities_len;
5034
5035 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5036 unsigned int num_iftype_ext_capab;
5037
5038 const void *privid;
5039
5040 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5041
5042 void (*reg_notifier)(struct wiphy *wiphy,
5043 struct regulatory_request *request);
5044
5045 /* fields below are read-only, assigned by cfg80211 */
5046
5047 const struct ieee80211_regdomain __rcu *regd;
5048
5049 struct device dev;
5050
5051 bool registered;
5052
5053 struct dentry *debugfsdir;
5054
5055 const struct ieee80211_ht_cap *ht_capa_mod_mask;
5056 const struct ieee80211_vht_cap *vht_capa_mod_mask;
5057
5058 struct list_head wdev_list;
5059
5060 possible_net_t _net;
5061
5062#ifdef CONFIG_CFG80211_WEXT
5063 const struct iw_handler_def *wext;
5064#endif
5065
5066 const struct wiphy_coalesce_support *coalesce;
5067
5068 const struct wiphy_vendor_command *vendor_commands;
5069 const struct nl80211_vendor_cmd_info *vendor_events;
5070 int n_vendor_commands, n_vendor_events;
5071
5072 u16 max_ap_assoc_sta;
5073
5074 u8 max_num_csa_counters;
5075
5076 u32 bss_select_support;
5077
5078 u8 nan_supported_bands;
5079
5080 u32 txq_limit;
5081 u32 txq_memory_limit;
5082 u32 txq_quantum;
5083
5084 unsigned long tx_queue_len;
5085
5086 u8 support_mbssid:1,
5087 support_only_he_mbssid:1;
5088
5089 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5090
5091 struct {
5092 u64 peer, vif;
5093 u8 max_retry;
5094 } tid_config_support;
5095
5096 u8 max_data_retry_count;
5097
5098 const struct cfg80211_sar_capa *sar_capa;
5099
5100 struct rfkill *rfkill;
5101
5102 char priv[] __aligned(NETDEV_ALIGN);
5103};
5104
5105static inline struct net *wiphy_net(struct wiphy *wiphy)
5106{
5107 return read_pnet(&wiphy->_net);
5108}
5109
5110static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5111{
5112 write_pnet(&wiphy->_net, net);
5113}
5114
5115/**
5116 * wiphy_priv - return priv from wiphy
5117 *
5118 * @wiphy: the wiphy whose priv pointer to return
5119 * Return: The priv of @wiphy.
5120 */
5121static inline void *wiphy_priv(struct wiphy *wiphy)
5122{
5123 BUG_ON(!wiphy);
5124 return &wiphy->priv;
5125}
5126
5127/**
5128 * priv_to_wiphy - return the wiphy containing the priv
5129 *
5130 * @priv: a pointer previously returned by wiphy_priv
5131 * Return: The wiphy of @priv.
5132 */
5133static inline struct wiphy *priv_to_wiphy(void *priv)
5134{
5135 BUG_ON(!priv);
5136 return container_of(priv, struct wiphy, priv);
5137}
5138
5139/**
5140 * set_wiphy_dev - set device pointer for wiphy
5141 *
5142 * @wiphy: The wiphy whose device to bind
5143 * @dev: The device to parent it to
5144 */
5145static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5146{
5147 wiphy->dev.parent = dev;
5148}
5149
5150/**
5151 * wiphy_dev - get wiphy dev pointer
5152 *
5153 * @wiphy: The wiphy whose device struct to look up
5154 * Return: The dev of @wiphy.
5155 */
5156static inline struct device *wiphy_dev(struct wiphy *wiphy)
5157{
5158 return wiphy->dev.parent;
5159}
5160
5161/**
5162 * wiphy_name - get wiphy name
5163 *
5164 * @wiphy: The wiphy whose name to return
5165 * Return: The name of @wiphy.
5166 */
5167static inline const char *wiphy_name(const struct wiphy *wiphy)
5168{
5169 return dev_name(&wiphy->dev);
5170}
5171
5172/**
5173 * wiphy_new_nm - create a new wiphy for use with cfg80211
5174 *
5175 * @ops: The configuration operations for this device
5176 * @sizeof_priv: The size of the private area to allocate
5177 * @requested_name: Request a particular name.
5178 * NULL is valid value, and means use the default phy%d naming.
5179 *
5180 * Create a new wiphy and associate the given operations with it.
5181 * @sizeof_priv bytes are allocated for private use.
5182 *
5183 * Return: A pointer to the new wiphy. This pointer must be
5184 * assigned to each netdev's ieee80211_ptr for proper operation.
5185 */
5186struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5187 const char *requested_name);
5188
5189/**
5190 * wiphy_new - create a new wiphy for use with cfg80211
5191 *
5192 * @ops: The configuration operations for this device
5193 * @sizeof_priv: The size of the private area to allocate
5194 *
5195 * Create a new wiphy and associate the given operations with it.
5196 * @sizeof_priv bytes are allocated for private use.
5197 *
5198 * Return: A pointer to the new wiphy. This pointer must be
5199 * assigned to each netdev's ieee80211_ptr for proper operation.
5200 */
5201static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5202 int sizeof_priv)
5203{
5204 return wiphy_new_nm(ops, sizeof_priv, NULL);
5205}
5206
5207/**
5208 * wiphy_register - register a wiphy with cfg80211
5209 *
5210 * @wiphy: The wiphy to register.
5211 *
5212 * Return: A non-negative wiphy index or a negative error code.
5213 */
5214int wiphy_register(struct wiphy *wiphy);
5215
5216/* this is a define for better error reporting (file/line) */
5217#define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
5218
5219/**
5220 * rcu_dereference_wiphy - rcu_dereference with debug checking
5221 * @wiphy: the wiphy to check the locking on
5222 * @p: The pointer to read, prior to dereferencing
5223 *
5224 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
5225 * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
5226 */
5227#define rcu_dereference_wiphy(wiphy, p) \
5228 rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
5229
5230/**
5231 * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
5232 * @wiphy: the wiphy to check the locking on
5233 * @p: The pointer to read, prior to dereferencing
5234 *
5235 * Return the value of the specified RCU-protected pointer, but omit the
5236 * READ_ONCE(), because caller holds the wiphy mutex used for updates.
5237 */
5238#define wiphy_dereference(wiphy, p) \
5239 rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
5240
5241/**
5242 * get_wiphy_regdom - get custom regdomain for the given wiphy
5243 * @wiphy: the wiphy to get the regdomain from
5244 */
5245const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
5246
5247/**
5248 * wiphy_unregister - deregister a wiphy from cfg80211
5249 *
5250 * @wiphy: The wiphy to unregister.
5251 *
5252 * After this call, no more requests can be made with this priv
5253 * pointer, but the call may sleep to wait for an outstanding
5254 * request that is being handled.
5255 */
5256void wiphy_unregister(struct wiphy *wiphy);
5257
5258/**
5259 * wiphy_free - free wiphy
5260 *
5261 * @wiphy: The wiphy to free
5262 */
5263void wiphy_free(struct wiphy *wiphy);
5264
5265/* internal structs */
5266struct cfg80211_conn;
5267struct cfg80211_internal_bss;
5268struct cfg80211_cached_keys;
5269struct cfg80211_cqm_config;
5270
5271/**
5272 * wiphy_lock - lock the wiphy
5273 * @wiphy: the wiphy to lock
5274 *
5275 * This is mostly exposed so it can be done around registering and
5276 * unregistering netdevs that aren't created through cfg80211 calls,
5277 * since that requires locking in cfg80211 when the notifiers is
5278 * called, but that cannot differentiate which way it's called.
5279 *
5280 * When cfg80211 ops are called, the wiphy is already locked.
5281 */
5282static inline void wiphy_lock(struct wiphy *wiphy)
5283 __acquires(&wiphy->mtx)
5284{
5285 mutex_lock(&wiphy->mtx);
5286 __acquire(&wiphy->mtx);
5287}
5288
5289/**
5290 * wiphy_unlock - unlock the wiphy again
5291 * @wiphy: the wiphy to unlock
5292 */
5293static inline void wiphy_unlock(struct wiphy *wiphy)
5294 __releases(&wiphy->mtx)
5295{
5296 __release(&wiphy->mtx);
5297 mutex_unlock(&wiphy->mtx);
5298}
5299
5300/**
5301 * struct wireless_dev - wireless device state
5302 *
5303 * For netdevs, this structure must be allocated by the driver
5304 * that uses the ieee80211_ptr field in struct net_device (this
5305 * is intentional so it can be allocated along with the netdev.)
5306 * It need not be registered then as netdev registration will
5307 * be intercepted by cfg80211 to see the new wireless device,
5308 * however, drivers must lock the wiphy before registering or
5309 * unregistering netdevs if they pre-create any netdevs (in ops
5310 * called from cfg80211, the wiphy is already locked.)
5311 *
5312 * For non-netdev uses, it must also be allocated by the driver
5313 * in response to the cfg80211 callbacks that require it, as
5314 * there's no netdev registration in that case it may not be
5315 * allocated outside of callback operations that return it.
5316 *
5317 * @wiphy: pointer to hardware description
5318 * @iftype: interface type
5319 * @registered: is this wdev already registered with cfg80211
5320 * @registering: indicates we're doing registration under wiphy lock
5321 * for the notifier
5322 * @list: (private) Used to collect the interfaces
5323 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5324 * @identifier: (private) Identifier used in nl80211 to identify this
5325 * wireless device if it has no netdev
5326 * @current_bss: (private) Used by the internal configuration code
5327 * @chandef: (private) Used by the internal configuration code to track
5328 * the user-set channel definition.
5329 * @preset_chandef: (private) Used by the internal configuration code to
5330 * track the channel to be used for AP later
5331 * @bssid: (private) Used by the internal configuration code
5332 * @ssid: (private) Used by the internal configuration code
5333 * @ssid_len: (private) Used by the internal configuration code
5334 * @mesh_id_len: (private) Used by the internal configuration code
5335 * @mesh_id_up_len: (private) Used by the internal configuration code
5336 * @wext: (private) Used by the internal wireless extensions compat code
5337 * @wext.ibss: (private) IBSS data part of wext handling
5338 * @wext.connect: (private) connection handling data
5339 * @wext.keys: (private) (WEP) key data
5340 * @wext.ie: (private) extra elements for association
5341 * @wext.ie_len: (private) length of extra elements
5342 * @wext.bssid: (private) selected network BSSID
5343 * @wext.ssid: (private) selected network SSID
5344 * @wext.default_key: (private) selected default key index
5345 * @wext.default_mgmt_key: (private) selected default management key index
5346 * @wext.prev_bssid: (private) previous BSSID for reassociation
5347 * @wext.prev_bssid_valid: (private) previous BSSID validity
5348 * @use_4addr: indicates 4addr mode is used on this interface, must be
5349 * set by driver (if supported) on add_interface BEFORE registering the
5350 * netdev and may otherwise be used by driver read-only, will be update
5351 * by cfg80211 on change_interface
5352 * @mgmt_registrations: list of registrations for management frames
5353 * @mgmt_registrations_lock: lock for the list
5354 * @mgmt_registrations_need_update: mgmt registrations were updated,
5355 * need to propagate the update to the driver
5356 * @mtx: mutex used to lock data in this struct, may be used by drivers
5357 * and some API functions require it held
5358 * @beacon_interval: beacon interval used on this device for transmitting
5359 * beacons, 0 when not valid
5360 * @address: The address for this device, valid only if @netdev is %NULL
5361 * @is_running: true if this is a non-netdev device that has been started, e.g.
5362 * the P2P Device.
5363 * @cac_started: true if DFS channel availability check has been started
5364 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5365 * @cac_time_ms: CAC time in ms
5366 * @ps: powersave mode is enabled
5367 * @ps_timeout: dynamic powersave timeout
5368 * @ap_unexpected_nlportid: (private) netlink port ID of application
5369 * registered for unexpected class 3 frames (AP mode)
5370 * @conn: (private) cfg80211 software SME connection state machine data
5371 * @connect_keys: (private) keys to set after connection is established
5372 * @conn_bss_type: connecting/connected BSS type
5373 * @conn_owner_nlportid: (private) connection owner socket port ID
5374 * @disconnect_wk: (private) auto-disconnect work
5375 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5376 * @ibss_fixed: (private) IBSS is using fixed BSSID
5377 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
5378 * @event_list: (private) list for internal event processing
5379 * @event_lock: (private) lock for event list
5380 * @owner_nlportid: (private) owner socket port ID
5381 * @nl_owner_dead: (private) owner socket went away
5382 * @cqm_config: (private) nl80211 RSSI monitor state
5383 * @pmsr_list: (private) peer measurement requests
5384 * @pmsr_lock: (private) peer measurements requests/results lock
5385 * @pmsr_free_wk: (private) peer measurements cleanup work
5386 * @unprot_beacon_reported: (private) timestamp of last
5387 * unprotected beacon report
5388 */
5389struct wireless_dev {
5390 struct wiphy *wiphy;
5391 enum nl80211_iftype iftype;
5392
5393 /* the remainder of this struct should be private to cfg80211 */
5394 struct list_head list;
5395 struct net_device *netdev;
5396
5397 u32 identifier;
5398
5399 struct list_head mgmt_registrations;
5400 spinlock_t mgmt_registrations_lock;
5401 u8 mgmt_registrations_need_update:1;
5402
5403 struct mutex mtx;
5404
5405 bool use_4addr, is_running, registered, registering;
5406
5407 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5408
5409 /* currently used for IBSS and SME - might be rearranged later */
5410 u8 ssid[IEEE80211_MAX_SSID_LEN];
5411 u8 ssid_len, mesh_id_len, mesh_id_up_len;
5412 struct cfg80211_conn *conn;
5413 struct cfg80211_cached_keys *connect_keys;
5414 enum ieee80211_bss_type conn_bss_type;
5415 u32 conn_owner_nlportid;
5416
5417 struct work_struct disconnect_wk;
5418 u8 disconnect_bssid[ETH_ALEN];
5419
5420 struct list_head event_list;
5421 spinlock_t event_lock;
5422
5423 struct cfg80211_internal_bss *current_bss; /* associated / joined */
5424 struct cfg80211_chan_def preset_chandef;
5425 struct cfg80211_chan_def chandef;
5426
5427 bool ibss_fixed;
5428 bool ibss_dfs_possible;
5429
5430 bool ps;
5431 int ps_timeout;
5432
5433 int beacon_interval;
5434
5435 u32 ap_unexpected_nlportid;
5436
5437 u32 owner_nlportid;
5438 bool nl_owner_dead;
5439
5440 bool cac_started;
5441 unsigned long cac_start_time;
5442 unsigned int cac_time_ms;
5443
5444#ifdef CONFIG_CFG80211_WEXT
5445 /* wext data */
5446 struct {
5447 struct cfg80211_ibss_params ibss;
5448 struct cfg80211_connect_params connect;
5449 struct cfg80211_cached_keys *keys;
5450 const u8 *ie;
5451 size_t ie_len;
5452 u8 bssid[ETH_ALEN];
5453 u8 prev_bssid[ETH_ALEN];
5454 u8 ssid[IEEE80211_MAX_SSID_LEN];
5455 s8 default_key, default_mgmt_key;
5456 bool prev_bssid_valid;
5457 } wext;
5458#endif
5459
5460 struct cfg80211_cqm_config *cqm_config;
5461
5462 struct list_head pmsr_list;
5463 spinlock_t pmsr_lock;
5464 struct work_struct pmsr_free_wk;
5465
5466 unsigned long unprot_beacon_reported;
5467};
5468
5469static inline u8 *wdev_address(struct wireless_dev *wdev)
5470{
5471 if (wdev->netdev)
5472 return wdev->netdev->dev_addr;
5473 return wdev->address;
5474}
5475
5476static inline bool wdev_running(struct wireless_dev *wdev)
5477{
5478 if (wdev->netdev)
5479 return netif_running(wdev->netdev);
5480 return wdev->is_running;
5481}
5482
5483/**
5484 * wdev_priv - return wiphy priv from wireless_dev
5485 *
5486 * @wdev: The wireless device whose wiphy's priv pointer to return
5487 * Return: The wiphy priv of @wdev.
5488 */
5489static inline void *wdev_priv(struct wireless_dev *wdev)
5490{
5491 BUG_ON(!wdev);
5492 return wiphy_priv(wdev->wiphy);
5493}
5494
5495/**
5496 * DOC: Utility functions
5497 *
5498 * cfg80211 offers a number of utility functions that can be useful.
5499 */
5500
5501/**
5502 * ieee80211_channel_equal - compare two struct ieee80211_channel
5503 *
5504 * @a: 1st struct ieee80211_channel
5505 * @b: 2nd struct ieee80211_channel
5506 * Return: true if center frequency of @a == @b
5507 */
5508static inline bool
5509ieee80211_channel_equal(struct ieee80211_channel *a,
5510 struct ieee80211_channel *b)
5511{
5512 return (a->center_freq == b->center_freq &&
5513 a->freq_offset == b->freq_offset);
5514}
5515
5516/**
5517 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5518 * @chan: struct ieee80211_channel to convert
5519 * Return: The corresponding frequency (in KHz)
5520 */
5521static inline u32
5522ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5523{
5524 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5525}
5526
5527/**
5528 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5529 *
5530 * Only allowed for band NL80211_BAND_S1GHZ
5531 * @chan: channel
5532 * Return: The allowed channel width for this center_freq
5533 */
5534enum nl80211_chan_width
5535ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5536
5537/**
5538 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5539 * @chan: channel number
5540 * @band: band, necessary due to channel number overlap
5541 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5542 */
5543u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
5544
5545/**
5546 * ieee80211_channel_to_frequency - convert channel number to frequency
5547 * @chan: channel number
5548 * @band: band, necessary due to channel number overlap
5549 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5550 */
5551static inline int
5552ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
5553{
5554 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
5555}
5556
5557/**
5558 * ieee80211_freq_khz_to_channel - convert frequency to channel number
5559 * @freq: center frequency in KHz
5560 * Return: The corresponding channel, or 0 if the conversion failed.
5561 */
5562int ieee80211_freq_khz_to_channel(u32 freq);
5563
5564/**
5565 * ieee80211_frequency_to_channel - convert frequency to channel number
5566 * @freq: center frequency in MHz
5567 * Return: The corresponding channel, or 0 if the conversion failed.
5568 */
5569static inline int
5570ieee80211_frequency_to_channel(int freq)
5571{
5572 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
5573}
5574
5575/**
5576 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
5577 * frequency
5578 * @wiphy: the struct wiphy to get the channel for
5579 * @freq: the center frequency (in KHz) of the channel
5580 * Return: The channel struct from @wiphy at @freq.
5581 */
5582struct ieee80211_channel *
5583ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
5584
5585/**
5586 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5587 *
5588 * @wiphy: the struct wiphy to get the channel for
5589 * @freq: the center frequency (in MHz) of the channel
5590 * Return: The channel struct from @wiphy at @freq.
5591 */
5592static inline struct ieee80211_channel *
5593ieee80211_get_channel(struct wiphy *wiphy, int freq)
5594{
5595 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
5596}
5597
5598/**
5599 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
5600 * @chan: control channel to check
5601 *
5602 * The Preferred Scanning Channels (PSC) are defined in
5603 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
5604 */
5605static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
5606{
5607 if (chan->band != NL80211_BAND_6GHZ)
5608 return false;
5609
5610 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
5611}
5612
5613/**
5614 * ieee80211_get_response_rate - get basic rate for a given rate
5615 *
5616 * @sband: the band to look for rates in
5617 * @basic_rates: bitmap of basic rates
5618 * @bitrate: the bitrate for which to find the basic rate
5619 *
5620 * Return: The basic rate corresponding to a given bitrate, that
5621 * is the next lower bitrate contained in the basic rate map,
5622 * which is, for this function, given as a bitmap of indices of
5623 * rates in the band's bitrate table.
5624 */
5625const struct ieee80211_rate *
5626ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5627 u32 basic_rates, int bitrate);
5628
5629/**
5630 * ieee80211_mandatory_rates - get mandatory rates for a given band
5631 * @sband: the band to look for rates in
5632 * @scan_width: width of the control channel
5633 *
5634 * This function returns a bitmap of the mandatory rates for the given
5635 * band, bits are set according to the rate position in the bitrates array.
5636 */
5637u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5638 enum nl80211_bss_scan_width scan_width);
5639
5640/*
5641 * Radiotap parsing functions -- for controlled injection support
5642 *
5643 * Implemented in net/wireless/radiotap.c
5644 * Documentation in Documentation/networking/radiotap-headers.rst
5645 */
5646
5647struct radiotap_align_size {
5648 uint8_t align:4, size:4;
5649};
5650
5651struct ieee80211_radiotap_namespace {
5652 const struct radiotap_align_size *align_size;
5653 int n_bits;
5654 uint32_t oui;
5655 uint8_t subns;
5656};
5657
5658struct ieee80211_radiotap_vendor_namespaces {
5659 const struct ieee80211_radiotap_namespace *ns;
5660 int n_ns;
5661};
5662
5663/**
5664 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5665 * @this_arg_index: index of current arg, valid after each successful call
5666 * to ieee80211_radiotap_iterator_next()
5667 * @this_arg: pointer to current radiotap arg; it is valid after each
5668 * call to ieee80211_radiotap_iterator_next() but also after
5669 * ieee80211_radiotap_iterator_init() where it will point to
5670 * the beginning of the actual data portion
5671 * @this_arg_size: length of the current arg, for convenience
5672 * @current_namespace: pointer to the current namespace definition
5673 * (or internally %NULL if the current namespace is unknown)
5674 * @is_radiotap_ns: indicates whether the current namespace is the default
5675 * radiotap namespace or not
5676 *
5677 * @_rtheader: pointer to the radiotap header we are walking through
5678 * @_max_length: length of radiotap header in cpu byte ordering
5679 * @_arg_index: next argument index
5680 * @_arg: next argument pointer
5681 * @_next_bitmap: internal pointer to next present u32
5682 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5683 * @_vns: vendor namespace definitions
5684 * @_next_ns_data: beginning of the next namespace's data
5685 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5686 * next bitmap word
5687 *
5688 * Describes the radiotap parser state. Fields prefixed with an underscore
5689 * must not be used by users of the parser, only by the parser internally.
5690 */
5691
5692struct ieee80211_radiotap_iterator {
5693 struct ieee80211_radiotap_header *_rtheader;
5694 const struct ieee80211_radiotap_vendor_namespaces *_vns;
5695 const struct ieee80211_radiotap_namespace *current_namespace;
5696
5697 unsigned char *_arg, *_next_ns_data;
5698 __le32 *_next_bitmap;
5699
5700 unsigned char *this_arg;
5701 int this_arg_index;
5702 int this_arg_size;
5703
5704 int is_radiotap_ns;
5705
5706 int _max_length;
5707 int _arg_index;
5708 uint32_t _bitmap_shifter;
5709 int _reset_on_ext;
5710};
5711
5712int
5713ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5714 struct ieee80211_radiotap_header *radiotap_header,
5715 int max_length,
5716 const struct ieee80211_radiotap_vendor_namespaces *vns);
5717
5718int
5719ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5720
5721
5722extern const unsigned char rfc1042_header[6];
5723extern const unsigned char bridge_tunnel_header[6];
5724
5725/**
5726 * ieee80211_get_hdrlen_from_skb - get header length from data
5727 *
5728 * @skb: the frame
5729 *
5730 * Given an skb with a raw 802.11 header at the data pointer this function
5731 * returns the 802.11 header length.
5732 *
5733 * Return: The 802.11 header length in bytes (not including encryption
5734 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5735 * 802.11 header.
5736 */
5737unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5738
5739/**
5740 * ieee80211_hdrlen - get header length in bytes from frame control
5741 * @fc: frame control field in little-endian format
5742 * Return: The header length in bytes.
5743 */
5744unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5745
5746/**
5747 * ieee80211_get_mesh_hdrlen - get mesh extension header length
5748 * @meshhdr: the mesh extension header, only the flags field
5749 * (first byte) will be accessed
5750 * Return: The length of the extension header, which is always at
5751 * least 6 bytes and at most 18 if address 5 and 6 are present.
5752 */
5753unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5754
5755/**
5756 * DOC: Data path helpers
5757 *
5758 * In addition to generic utilities, cfg80211 also offers
5759 * functions that help implement the data path for devices
5760 * that do not do the 802.11/802.3 conversion on the device.
5761 */
5762
5763/**
5764 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5765 * @skb: the 802.11 data frame
5766 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5767 * of it being pushed into the SKB
5768 * @addr: the device MAC address
5769 * @iftype: the virtual interface type
5770 * @data_offset: offset of payload after the 802.11 header
5771 * Return: 0 on success. Non-zero on error.
5772 */
5773int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5774 const u8 *addr, enum nl80211_iftype iftype,
5775 u8 data_offset, bool is_amsdu);
5776
5777/**
5778 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5779 * @skb: the 802.11 data frame
5780 * @addr: the device MAC address
5781 * @iftype: the virtual interface type
5782 * Return: 0 on success. Non-zero on error.
5783 */
5784static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5785 enum nl80211_iftype iftype)
5786{
5787 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
5788}
5789
5790/**
5791 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5792 *
5793 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5794 * The @list will be empty if the decode fails. The @skb must be fully
5795 * header-less before being passed in here; it is freed in this function.
5796 *
5797 * @skb: The input A-MSDU frame without any headers.
5798 * @list: The output list of 802.3 frames. It must be allocated and
5799 * initialized by the caller.
5800 * @addr: The device MAC address.
5801 * @iftype: The device interface type.
5802 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5803 * @check_da: DA to check in the inner ethernet header, or NULL
5804 * @check_sa: SA to check in the inner ethernet header, or NULL
5805 */
5806void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5807 const u8 *addr, enum nl80211_iftype iftype,
5808 const unsigned int extra_headroom,
5809 const u8 *check_da, const u8 *check_sa);
5810
5811/**
5812 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5813 * @skb: the data frame
5814 * @qos_map: Interworking QoS mapping or %NULL if not in use
5815 * Return: The 802.1p/1d tag.
5816 */
5817unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5818 struct cfg80211_qos_map *qos_map);
5819
5820/**
5821 * cfg80211_find_elem_match - match information element and byte array in data
5822 *
5823 * @eid: element ID
5824 * @ies: data consisting of IEs
5825 * @len: length of data
5826 * @match: byte array to match
5827 * @match_len: number of bytes in the match array
5828 * @match_offset: offset in the IE data where the byte array should match.
5829 * Note the difference to cfg80211_find_ie_match() which considers
5830 * the offset to start from the element ID byte, but here we take
5831 * the data portion instead.
5832 *
5833 * Return: %NULL if the element ID could not be found or if
5834 * the element is invalid (claims to be longer than the given
5835 * data) or if the byte array doesn't match; otherwise return the
5836 * requested element struct.
5837 *
5838 * Note: There are no checks on the element length other than
5839 * having to fit into the given data and being large enough for the
5840 * byte array to match.
5841 */
5842const struct element *
5843cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5844 const u8 *match, unsigned int match_len,
5845 unsigned int match_offset);
5846
5847/**
5848 * cfg80211_find_ie_match - match information element and byte array in data
5849 *
5850 * @eid: element ID
5851 * @ies: data consisting of IEs
5852 * @len: length of data
5853 * @match: byte array to match
5854 * @match_len: number of bytes in the match array
5855 * @match_offset: offset in the IE where the byte array should match.
5856 * If match_len is zero, this must also be set to zero.
5857 * Otherwise this must be set to 2 or more, because the first
5858 * byte is the element id, which is already compared to eid, and
5859 * the second byte is the IE length.
5860 *
5861 * Return: %NULL if the element ID could not be found or if
5862 * the element is invalid (claims to be longer than the given
5863 * data) or if the byte array doesn't match, or a pointer to the first
5864 * byte of the requested element, that is the byte containing the
5865 * element ID.
5866 *
5867 * Note: There are no checks on the element length other than
5868 * having to fit into the given data and being large enough for the
5869 * byte array to match.
5870 */
5871static inline const u8 *
5872cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5873 const u8 *match, unsigned int match_len,
5874 unsigned int match_offset)
5875{
5876 /* match_offset can't be smaller than 2, unless match_len is
5877 * zero, in which case match_offset must be zero as well.
5878 */
5879 if (WARN_ON((match_len && match_offset < 2) ||
5880 (!match_len && match_offset)))
5881 return NULL;
5882
5883 return (void *)cfg80211_find_elem_match(eid, ies, len,
5884 match, match_len,
5885 match_offset ?
5886 match_offset - 2 : 0);
5887}
5888
5889/**
5890 * cfg80211_find_elem - find information element in data
5891 *
5892 * @eid: element ID
5893 * @ies: data consisting of IEs
5894 * @len: length of data
5895 *
5896 * Return: %NULL if the element ID could not be found or if
5897 * the element is invalid (claims to be longer than the given
5898 * data) or if the byte array doesn't match; otherwise return the
5899 * requested element struct.
5900 *
5901 * Note: There are no checks on the element length other than
5902 * having to fit into the given data.
5903 */
5904static inline const struct element *
5905cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5906{
5907 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5908}
5909
5910/**
5911 * cfg80211_find_ie - find information element in data
5912 *
5913 * @eid: element ID
5914 * @ies: data consisting of IEs
5915 * @len: length of data
5916 *
5917 * Return: %NULL if the element ID could not be found or if
5918 * the element is invalid (claims to be longer than the given
5919 * data), or a pointer to the first byte of the requested
5920 * element, that is the byte containing the element ID.
5921 *
5922 * Note: There are no checks on the element length other than
5923 * having to fit into the given data.
5924 */
5925static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5926{
5927 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5928}
5929
5930/**
5931 * cfg80211_find_ext_elem - find information element with EID Extension in data
5932 *
5933 * @ext_eid: element ID Extension
5934 * @ies: data consisting of IEs
5935 * @len: length of data
5936 *
5937 * Return: %NULL if the etended element could not be found or if
5938 * the element is invalid (claims to be longer than the given
5939 * data) or if the byte array doesn't match; otherwise return the
5940 * requested element struct.
5941 *
5942 * Note: There are no checks on the element length other than
5943 * having to fit into the given data.
5944 */
5945static inline const struct element *
5946cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5947{
5948 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5949 &ext_eid, 1, 0);
5950}
5951
5952/**
5953 * cfg80211_find_ext_ie - find information element with EID Extension in data
5954 *
5955 * @ext_eid: element ID Extension
5956 * @ies: data consisting of IEs
5957 * @len: length of data
5958 *
5959 * Return: %NULL if the extended element ID could not be found or if
5960 * the element is invalid (claims to be longer than the given
5961 * data), or a pointer to the first byte of the requested
5962 * element, that is the byte containing the element ID.
5963 *
5964 * Note: There are no checks on the element length other than
5965 * having to fit into the given data.
5966 */
5967static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5968{
5969 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5970 &ext_eid, 1, 2);
5971}
5972
5973/**
5974 * cfg80211_find_vendor_elem - find vendor specific information element in data
5975 *
5976 * @oui: vendor OUI
5977 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5978 * @ies: data consisting of IEs
5979 * @len: length of data
5980 *
5981 * Return: %NULL if the vendor specific element ID could not be found or if the
5982 * element is invalid (claims to be longer than the given data); otherwise
5983 * return the element structure for the requested element.
5984 *
5985 * Note: There are no checks on the element length other than having to fit into
5986 * the given data.
5987 */
5988const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5989 const u8 *ies,
5990 unsigned int len);
5991
5992/**
5993 * cfg80211_find_vendor_ie - find vendor specific information element in data
5994 *
5995 * @oui: vendor OUI
5996 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5997 * @ies: data consisting of IEs
5998 * @len: length of data
5999 *
6000 * Return: %NULL if the vendor specific element ID could not be found or if the
6001 * element is invalid (claims to be longer than the given data), or a pointer to
6002 * the first byte of the requested element, that is the byte containing the
6003 * element ID.
6004 *
6005 * Note: There are no checks on the element length other than having to fit into
6006 * the given data.
6007 */
6008static inline const u8 *
6009cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
6010 const u8 *ies, unsigned int len)
6011{
6012 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
6013}
6014
6015/**
6016 * cfg80211_send_layer2_update - send layer 2 update frame
6017 *
6018 * @dev: network device
6019 * @addr: STA MAC address
6020 *
6021 * Wireless drivers can use this function to update forwarding tables in bridge
6022 * devices upon STA association.
6023 */
6024void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
6025
6026/**
6027 * DOC: Regulatory enforcement infrastructure
6028 *
6029 * TODO
6030 */
6031
6032/**
6033 * regulatory_hint - driver hint to the wireless core a regulatory domain
6034 * @wiphy: the wireless device giving the hint (used only for reporting
6035 * conflicts)
6036 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
6037 * should be in. If @rd is set this should be NULL. Note that if you
6038 * set this to NULL you should still set rd->alpha2 to some accepted
6039 * alpha2.
6040 *
6041 * Wireless drivers can use this function to hint to the wireless core
6042 * what it believes should be the current regulatory domain by
6043 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
6044 * domain should be in or by providing a completely build regulatory domain.
6045 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
6046 * for a regulatory domain structure for the respective country.
6047 *
6048 * The wiphy must have been registered to cfg80211 prior to this call.
6049 * For cfg80211 drivers this means you must first use wiphy_register(),
6050 * for mac80211 drivers you must first use ieee80211_register_hw().
6051 *
6052 * Drivers should check the return value, its possible you can get
6053 * an -ENOMEM.
6054 *
6055 * Return: 0 on success. -ENOMEM.
6056 */
6057int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
6058
6059/**
6060 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
6061 * @wiphy: the wireless device we want to process the regulatory domain on
6062 * @rd: the regulatory domain informatoin to use for this wiphy
6063 *
6064 * Set the regulatory domain information for self-managed wiphys, only they
6065 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
6066 * information.
6067 *
6068 * Return: 0 on success. -EINVAL, -EPERM
6069 */
6070int regulatory_set_wiphy_regd(struct wiphy *wiphy,
6071 struct ieee80211_regdomain *rd);
6072
6073/**
6074 * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
6075 * @wiphy: the wireless device we want to process the regulatory domain on
6076 * @rd: the regulatory domain information to use for this wiphy
6077 *
6078 * This functions requires the RTNL and the wiphy mutex to be held and
6079 * applies the new regdomain synchronously to this wiphy. For more details
6080 * see regulatory_set_wiphy_regd().
6081 *
6082 * Return: 0 on success. -EINVAL, -EPERM
6083 */
6084int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
6085 struct ieee80211_regdomain *rd);
6086
6087/**
6088 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
6089 * @wiphy: the wireless device we want to process the regulatory domain on
6090 * @regd: the custom regulatory domain to use for this wiphy
6091 *
6092 * Drivers can sometimes have custom regulatory domains which do not apply
6093 * to a specific country. Drivers can use this to apply such custom regulatory
6094 * domains. This routine must be called prior to wiphy registration. The
6095 * custom regulatory domain will be trusted completely and as such previous
6096 * default channel settings will be disregarded. If no rule is found for a
6097 * channel on the regulatory domain the channel will be disabled.
6098 * Drivers using this for a wiphy should also set the wiphy flag
6099 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
6100 * that called this helper.
6101 */
6102void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
6103 const struct ieee80211_regdomain *regd);
6104
6105/**
6106 * freq_reg_info - get regulatory information for the given frequency
6107 * @wiphy: the wiphy for which we want to process this rule for
6108 * @center_freq: Frequency in KHz for which we want regulatory information for
6109 *
6110 * Use this function to get the regulatory rule for a specific frequency on
6111 * a given wireless device. If the device has a specific regulatory domain
6112 * it wants to follow we respect that unless a country IE has been received
6113 * and processed already.
6114 *
6115 * Return: A valid pointer, or, when an error occurs, for example if no rule
6116 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
6117 * check and PTR_ERR() to obtain the numeric return value. The numeric return
6118 * value will be -ERANGE if we determine the given center_freq does not even
6119 * have a regulatory rule for a frequency range in the center_freq's band.
6120 * See freq_in_rule_band() for our current definition of a band -- this is
6121 * purely subjective and right now it's 802.11 specific.
6122 */
6123const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
6124 u32 center_freq);
6125
6126/**
6127 * reg_initiator_name - map regulatory request initiator enum to name
6128 * @initiator: the regulatory request initiator
6129 *
6130 * You can use this to map the regulatory request initiator enum to a
6131 * proper string representation.
6132 */
6133const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
6134
6135/**
6136 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
6137 * @wiphy: wiphy for which pre-CAC capability is checked.
6138 *
6139 * Pre-CAC is allowed only in some regdomains (notable ETSI).
6140 */
6141bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
6142
6143/**
6144 * DOC: Internal regulatory db functions
6145 *
6146 */
6147
6148/**
6149 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6150 * Regulatory self-managed driver can use it to proactively
6151 *
6152 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6153 * @freq: the freqency(in MHz) to be queried.
6154 * @rule: pointer to store the wmm rule from the regulatory db.
6155 *
6156 * Self-managed wireless drivers can use this function to query
6157 * the internal regulatory database to check whether the given
6158 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6159 *
6160 * Drivers should check the return value, its possible you can get
6161 * an -ENODATA.
6162 *
6163 * Return: 0 on success. -ENODATA.
6164 */
6165int reg_query_regdb_wmm(char *alpha2, int freq,
6166 struct ieee80211_reg_rule *rule);
6167
6168/*
6169 * callbacks for asynchronous cfg80211 methods, notification
6170 * functions and BSS handling helpers
6171 */
6172
6173/**
6174 * cfg80211_scan_done - notify that scan finished
6175 *
6176 * @request: the corresponding scan request
6177 * @info: information about the completed scan
6178 */
6179void cfg80211_scan_done(struct cfg80211_scan_request *request,
6180 struct cfg80211_scan_info *info);
6181
6182/**
6183 * cfg80211_sched_scan_results - notify that new scan results are available
6184 *
6185 * @wiphy: the wiphy which got scheduled scan results
6186 * @reqid: identifier for the related scheduled scan request
6187 */
6188void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6189
6190/**
6191 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6192 *
6193 * @wiphy: the wiphy on which the scheduled scan stopped
6194 * @reqid: identifier for the related scheduled scan request
6195 *
6196 * The driver can call this function to inform cfg80211 that the
6197 * scheduled scan had to be stopped, for whatever reason. The driver
6198 * is then called back via the sched_scan_stop operation when done.
6199 */
6200void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6201
6202/**
6203 * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
6204 *
6205 * @wiphy: the wiphy on which the scheduled scan stopped
6206 * @reqid: identifier for the related scheduled scan request
6207 *
6208 * The driver can call this function to inform cfg80211 that the
6209 * scheduled scan had to be stopped, for whatever reason. The driver
6210 * is then called back via the sched_scan_stop operation when done.
6211 * This function should be called with the wiphy mutex held.
6212 */
6213void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
6214
6215/**
6216 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6217 * @wiphy: the wiphy reporting the BSS
6218 * @data: the BSS metadata
6219 * @mgmt: the management frame (probe response or beacon)
6220 * @len: length of the management frame
6221 * @gfp: context flags
6222 *
6223 * This informs cfg80211 that BSS information was found and
6224 * the BSS should be updated/added.
6225 *
6226 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6227 * Or %NULL on error.
6228 */
6229struct cfg80211_bss * __must_check
6230cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
6231 struct cfg80211_inform_bss *data,
6232 struct ieee80211_mgmt *mgmt, size_t len,
6233 gfp_t gfp);
6234
6235static inline struct cfg80211_bss * __must_check
6236cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6237 struct ieee80211_channel *rx_channel,
6238 enum nl80211_bss_scan_width scan_width,
6239 struct ieee80211_mgmt *mgmt, size_t len,
6240 s32 signal, gfp_t gfp)
6241{
6242 struct cfg80211_inform_bss data = {
6243 .chan = rx_channel,
6244 .scan_width = scan_width,
6245 .signal = signal,
6246 };
6247
6248 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6249}
6250
6251static inline struct cfg80211_bss * __must_check
6252cfg80211_inform_bss_frame(struct wiphy *wiphy,
6253 struct ieee80211_channel *rx_channel,
6254 struct ieee80211_mgmt *mgmt, size_t len,
6255 s32 signal, gfp_t gfp)
6256{
6257 struct cfg80211_inform_bss data = {
6258 .chan = rx_channel,
6259 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6260 .signal = signal,
6261 };
6262
6263 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6264}
6265
6266/**
6267 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6268 * @bssid: transmitter BSSID
6269 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6270 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6271 * @new_bssid: calculated nontransmitted BSSID
6272 */
6273static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6274 u8 mbssid_index, u8 *new_bssid)
6275{
6276 u64 bssid_u64 = ether_addr_to_u64(bssid);
6277 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6278 u64 new_bssid_u64;
6279
6280 new_bssid_u64 = bssid_u64 & ~mask;
6281
6282 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6283
6284 u64_to_ether_addr(new_bssid_u64, new_bssid);
6285}
6286
6287/**
6288 * cfg80211_is_element_inherited - returns if element ID should be inherited
6289 * @element: element to check
6290 * @non_inherit_element: non inheritance element
6291 */
6292bool cfg80211_is_element_inherited(const struct element *element,
6293 const struct element *non_inherit_element);
6294
6295/**
6296 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6297 * @ie: ies
6298 * @ielen: length of IEs
6299 * @mbssid_elem: current MBSSID element
6300 * @sub_elem: current MBSSID subelement (profile)
6301 * @merged_ie: location of the merged profile
6302 * @max_copy_len: max merged profile length
6303 */
6304size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6305 const struct element *mbssid_elem,
6306 const struct element *sub_elem,
6307 u8 *merged_ie, size_t max_copy_len);
6308
6309/**
6310 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6311 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6312 * from a beacon or probe response
6313 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6314 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6315 */
6316enum cfg80211_bss_frame_type {
6317 CFG80211_BSS_FTYPE_UNKNOWN,
6318 CFG80211_BSS_FTYPE_BEACON,
6319 CFG80211_BSS_FTYPE_PRESP,
6320};
6321
6322/**
6323 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6324 *
6325 * @wiphy: the wiphy reporting the BSS
6326 * @data: the BSS metadata
6327 * @ftype: frame type (if known)
6328 * @bssid: the BSSID of the BSS
6329 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6330 * @capability: the capability field sent by the peer
6331 * @beacon_interval: the beacon interval announced by the peer
6332 * @ie: additional IEs sent by the peer
6333 * @ielen: length of the additional IEs
6334 * @gfp: context flags
6335 *
6336 * This informs cfg80211 that BSS information was found and
6337 * the BSS should be updated/added.
6338 *
6339 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6340 * Or %NULL on error.
6341 */
6342struct cfg80211_bss * __must_check
6343cfg80211_inform_bss_data(struct wiphy *wiphy,
6344 struct cfg80211_inform_bss *data,
6345 enum cfg80211_bss_frame_type ftype,
6346 const u8 *bssid, u64 tsf, u16 capability,
6347 u16 beacon_interval, const u8 *ie, size_t ielen,
6348 gfp_t gfp);
6349
6350static inline struct cfg80211_bss * __must_check
6351cfg80211_inform_bss_width(struct wiphy *wiphy,
6352 struct ieee80211_channel *rx_channel,
6353 enum nl80211_bss_scan_width scan_width,
6354 enum cfg80211_bss_frame_type ftype,
6355 const u8 *bssid, u64 tsf, u16 capability,
6356 u16 beacon_interval, const u8 *ie, size_t ielen,
6357 s32 signal, gfp_t gfp)
6358{
6359 struct cfg80211_inform_bss data = {
6360 .chan = rx_channel,
6361 .scan_width = scan_width,
6362 .signal = signal,
6363 };
6364
6365 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6366 capability, beacon_interval, ie, ielen,
6367 gfp);
6368}
6369
6370static inline struct cfg80211_bss * __must_check
6371cfg80211_inform_bss(struct wiphy *wiphy,
6372 struct ieee80211_channel *rx_channel,
6373 enum cfg80211_bss_frame_type ftype,
6374 const u8 *bssid, u64 tsf, u16 capability,
6375 u16 beacon_interval, const u8 *ie, size_t ielen,
6376 s32 signal, gfp_t gfp)
6377{
6378 struct cfg80211_inform_bss data = {
6379 .chan = rx_channel,
6380 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6381 .signal = signal,
6382 };
6383
6384 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6385 capability, beacon_interval, ie, ielen,
6386 gfp);
6387}
6388
6389/**
6390 * cfg80211_get_bss - get a BSS reference
6391 * @wiphy: the wiphy this BSS struct belongs to
6392 * @channel: the channel to search on (or %NULL)
6393 * @bssid: the desired BSSID (or %NULL)
6394 * @ssid: the desired SSID (or %NULL)
6395 * @ssid_len: length of the SSID (or 0)
6396 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6397 * @privacy: privacy filter, see &enum ieee80211_privacy
6398 */
6399struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6400 struct ieee80211_channel *channel,
6401 const u8 *bssid,
6402 const u8 *ssid, size_t ssid_len,
6403 enum ieee80211_bss_type bss_type,
6404 enum ieee80211_privacy privacy);
6405static inline struct cfg80211_bss *
6406cfg80211_get_ibss(struct wiphy *wiphy,
6407 struct ieee80211_channel *channel,
6408 const u8 *ssid, size_t ssid_len)
6409{
6410 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6411 IEEE80211_BSS_TYPE_IBSS,
6412 IEEE80211_PRIVACY_ANY);
6413}
6414
6415/**
6416 * cfg80211_ref_bss - reference BSS struct
6417 * @wiphy: the wiphy this BSS struct belongs to
6418 * @bss: the BSS struct to reference
6419 *
6420 * Increments the refcount of the given BSS struct.
6421 */
6422void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6423
6424/**
6425 * cfg80211_put_bss - unref BSS struct
6426 * @wiphy: the wiphy this BSS struct belongs to
6427 * @bss: the BSS struct
6428 *
6429 * Decrements the refcount of the given BSS struct.
6430 */
6431void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6432
6433/**
6434 * cfg80211_unlink_bss - unlink BSS from internal data structures
6435 * @wiphy: the wiphy
6436 * @bss: the bss to remove
6437 *
6438 * This function removes the given BSS from the internal data structures
6439 * thereby making it no longer show up in scan results etc. Use this
6440 * function when you detect a BSS is gone. Normally BSSes will also time
6441 * out, so it is not necessary to use this function at all.
6442 */
6443void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6444
6445/**
6446 * cfg80211_bss_iter - iterate all BSS entries
6447 *
6448 * This function iterates over the BSS entries associated with the given wiphy
6449 * and calls the callback for the iterated BSS. The iterator function is not
6450 * allowed to call functions that might modify the internal state of the BSS DB.
6451 *
6452 * @wiphy: the wiphy
6453 * @chandef: if given, the iterator function will be called only if the channel
6454 * of the currently iterated BSS is a subset of the given channel.
6455 * @iter: the iterator function to call
6456 * @iter_data: an argument to the iterator function
6457 */
6458void cfg80211_bss_iter(struct wiphy *wiphy,
6459 struct cfg80211_chan_def *chandef,
6460 void (*iter)(struct wiphy *wiphy,
6461 struct cfg80211_bss *bss,
6462 void *data),
6463 void *iter_data);
6464
6465static inline enum nl80211_bss_scan_width
6466cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6467{
6468 switch (chandef->width) {
6469 case NL80211_CHAN_WIDTH_5:
6470 return NL80211_BSS_CHAN_WIDTH_5;
6471 case NL80211_CHAN_WIDTH_10:
6472 return NL80211_BSS_CHAN_WIDTH_10;
6473 default:
6474 return NL80211_BSS_CHAN_WIDTH_20;
6475 }
6476}
6477
6478/**
6479 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6480 * @dev: network device
6481 * @buf: authentication frame (header + body)
6482 * @len: length of the frame data
6483 *
6484 * This function is called whenever an authentication, disassociation or
6485 * deauthentication frame has been received and processed in station mode.
6486 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6487 * call either this function or cfg80211_auth_timeout().
6488 * After being asked to associate via cfg80211_ops::assoc() the driver must
6489 * call either this function or cfg80211_auth_timeout().
6490 * While connected, the driver must calls this for received and processed
6491 * disassociation and deauthentication frames. If the frame couldn't be used
6492 * because it was unprotected, the driver must call the function
6493 * cfg80211_rx_unprot_mlme_mgmt() instead.
6494 *
6495 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6496 */
6497void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6498
6499/**
6500 * cfg80211_auth_timeout - notification of timed out authentication
6501 * @dev: network device
6502 * @addr: The MAC address of the device with which the authentication timed out
6503 *
6504 * This function may sleep. The caller must hold the corresponding wdev's
6505 * mutex.
6506 */
6507void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6508
6509/**
6510 * cfg80211_rx_assoc_resp - notification of processed association response
6511 * @dev: network device
6512 * @bss: the BSS that association was requested with, ownership of the pointer
6513 * moves to cfg80211 in this call
6514 * @buf: (Re)Association Response frame (header + body)
6515 * @len: length of the frame data
6516 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6517 * as the AC bitmap in the QoS info field
6518 * @req_ies: information elements from the (Re)Association Request frame
6519 * @req_ies_len: length of req_ies data
6520 *
6521 * After being asked to associate via cfg80211_ops::assoc() the driver must
6522 * call either this function or cfg80211_auth_timeout().
6523 *
6524 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6525 */
6526void cfg80211_rx_assoc_resp(struct net_device *dev,
6527 struct cfg80211_bss *bss,
6528 const u8 *buf, size_t len,
6529 int uapsd_queues,
6530 const u8 *req_ies, size_t req_ies_len);
6531
6532/**
6533 * cfg80211_assoc_timeout - notification of timed out association
6534 * @dev: network device
6535 * @bss: The BSS entry with which association timed out.
6536 *
6537 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6538 */
6539void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
6540
6541/**
6542 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
6543 * @dev: network device
6544 * @bss: The BSS entry with which association was abandoned.
6545 *
6546 * Call this whenever - for reasons reported through other API, like deauth RX,
6547 * an association attempt was abandoned.
6548 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6549 */
6550void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
6551
6552/**
6553 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
6554 * @dev: network device
6555 * @buf: 802.11 frame (header + body)
6556 * @len: length of the frame data
6557 * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
6558 *
6559 * This function is called whenever deauthentication has been processed in
6560 * station mode. This includes both received deauthentication frames and
6561 * locally generated ones. This function may sleep. The caller must hold the
6562 * corresponding wdev's mutex.
6563 */
6564void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
6565 bool reconnect);
6566
6567/**
6568 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
6569 * @dev: network device
6570 * @buf: received management frame (header + body)
6571 * @len: length of the frame data
6572 *
6573 * This function is called whenever a received deauthentication or dissassoc
6574 * frame has been dropped in station mode because of MFP being used but the
6575 * frame was not protected. This is also used to notify reception of a Beacon
6576 * frame that was dropped because it did not include a valid MME MIC while
6577 * beacon protection was enabled (BIGTK configured in station mode).
6578 *
6579 * This function may sleep.
6580 */
6581void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
6582 const u8 *buf, size_t len);
6583
6584/**
6585 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6586 * @dev: network device
6587 * @addr: The source MAC address of the frame
6588 * @key_type: The key type that the received frame used
6589 * @key_id: Key identifier (0..3). Can be -1 if missing.
6590 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6591 * @gfp: allocation flags
6592 *
6593 * This function is called whenever the local MAC detects a MIC failure in a
6594 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6595 * primitive.
6596 */
6597void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6598 enum nl80211_key_type key_type, int key_id,
6599 const u8 *tsc, gfp_t gfp);
6600
6601/**
6602 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6603 *
6604 * @dev: network device
6605 * @bssid: the BSSID of the IBSS joined
6606 * @channel: the channel of the IBSS joined
6607 * @gfp: allocation flags
6608 *
6609 * This function notifies cfg80211 that the device joined an IBSS or
6610 * switched to a different BSSID. Before this function can be called,
6611 * either a beacon has to have been received from the IBSS, or one of
6612 * the cfg80211_inform_bss{,_frame} functions must have been called
6613 * with the locally generated beacon -- this guarantees that there is
6614 * always a scan result for this IBSS. cfg80211 will handle the rest.
6615 */
6616void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6617 struct ieee80211_channel *channel, gfp_t gfp);
6618
6619/**
6620 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
6621 * candidate
6622 *
6623 * @dev: network device
6624 * @macaddr: the MAC address of the new candidate
6625 * @ie: information elements advertised by the peer candidate
6626 * @ie_len: length of the information elements buffer
6627 * @gfp: allocation flags
6628 *
6629 * This function notifies cfg80211 that the mesh peer candidate has been
6630 * detected, most likely via a beacon or, less likely, via a probe response.
6631 * cfg80211 then sends a notification to userspace.
6632 */
6633void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6634 const u8 *macaddr, const u8 *ie, u8 ie_len,
6635 int sig_dbm, gfp_t gfp);
6636
6637/**
6638 * DOC: RFkill integration
6639 *
6640 * RFkill integration in cfg80211 is almost invisible to drivers,
6641 * as cfg80211 automatically registers an rfkill instance for each
6642 * wireless device it knows about. Soft kill is also translated
6643 * into disconnecting and turning all interfaces off, drivers are
6644 * expected to turn off the device when all interfaces are down.
6645 *
6646 * However, devices may have a hard RFkill line, in which case they
6647 * also need to interact with the rfkill subsystem, via cfg80211.
6648 * They can do this with a few helper functions documented here.
6649 */
6650
6651/**
6652 * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
6653 * @wiphy: the wiphy
6654 * @blocked: block status
6655 * @reason: one of reasons in &enum rfkill_hard_block_reasons
6656 */
6657void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
6658 enum rfkill_hard_block_reasons reason);
6659
6660static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
6661{
6662 wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
6663 RFKILL_HARD_BLOCK_SIGNAL);
6664}
6665
6666/**
6667 * wiphy_rfkill_start_polling - start polling rfkill
6668 * @wiphy: the wiphy
6669 */
6670void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6671
6672/**
6673 * wiphy_rfkill_stop_polling - stop polling rfkill
6674 * @wiphy: the wiphy
6675 */
6676static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy)
6677{
6678 rfkill_pause_polling(wiphy->rfkill);
6679}
6680
6681/**
6682 * DOC: Vendor commands
6683 *
6684 * Occasionally, there are special protocol or firmware features that
6685 * can't be implemented very openly. For this and similar cases, the
6686 * vendor command functionality allows implementing the features with
6687 * (typically closed-source) userspace and firmware, using nl80211 as
6688 * the configuration mechanism.
6689 *
6690 * A driver supporting vendor commands must register them as an array
6691 * in struct wiphy, with handlers for each one, each command has an
6692 * OUI and sub command ID to identify it.
6693 *
6694 * Note that this feature should not be (ab)used to implement protocol
6695 * features that could openly be shared across drivers. In particular,
6696 * it must never be required to use vendor commands to implement any
6697 * "normal" functionality that higher-level userspace like connection
6698 * managers etc. need.
6699 */
6700
6701struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6702 enum nl80211_commands cmd,
6703 enum nl80211_attrs attr,
6704 int approxlen);
6705
6706struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6707 struct wireless_dev *wdev,
6708 enum nl80211_commands cmd,
6709 enum nl80211_attrs attr,
6710 unsigned int portid,
6711 int vendor_event_idx,
6712 int approxlen, gfp_t gfp);
6713
6714void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6715
6716/**
6717 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6718 * @wiphy: the wiphy
6719 * @approxlen: an upper bound of the length of the data that will
6720 * be put into the skb
6721 *
6722 * This function allocates and pre-fills an skb for a reply to
6723 * a vendor command. Since it is intended for a reply, calling
6724 * it outside of a vendor command's doit() operation is invalid.
6725 *
6726 * The returned skb is pre-filled with some identifying data in
6727 * a way that any data that is put into the skb (with skb_put(),
6728 * nla_put() or similar) will end up being within the
6729 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6730 * with the skb is adding data for the corresponding userspace tool
6731 * which can then read that data out of the vendor data attribute.
6732 * You must not modify the skb in any other way.
6733 *
6734 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6735 * its error code as the result of the doit() operation.
6736 *
6737 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6738 */
6739static inline struct sk_buff *
6740cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6741{
6742 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6743 NL80211_ATTR_VENDOR_DATA, approxlen);
6744}
6745
6746/**
6747 * cfg80211_vendor_cmd_reply - send the reply skb
6748 * @skb: The skb, must have been allocated with
6749 * cfg80211_vendor_cmd_alloc_reply_skb()
6750 *
6751 * Since calling this function will usually be the last thing
6752 * before returning from the vendor command doit() you should
6753 * return the error code. Note that this function consumes the
6754 * skb regardless of the return value.
6755 *
6756 * Return: An error code or 0 on success.
6757 */
6758int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6759
6760/**
6761 * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
6762 * @wiphy: the wiphy
6763 *
6764 * Return the current netlink port ID in a vendor command handler.
6765 * Valid to call only there.
6766 */
6767unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6768
6769/**
6770 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6771 * @wiphy: the wiphy
6772 * @wdev: the wireless device
6773 * @event_idx: index of the vendor event in the wiphy's vendor_events
6774 * @approxlen: an upper bound of the length of the data that will
6775 * be put into the skb
6776 * @gfp: allocation flags
6777 *
6778 * This function allocates and pre-fills an skb for an event on the
6779 * vendor-specific multicast group.
6780 *
6781 * If wdev != NULL, both the ifindex and identifier of the specified
6782 * wireless device are added to the event message before the vendor data
6783 * attribute.
6784 *
6785 * When done filling the skb, call cfg80211_vendor_event() with the
6786 * skb to send the event.
6787 *
6788 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6789 */
6790static inline struct sk_buff *
6791cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6792 int approxlen, int event_idx, gfp_t gfp)
6793{
6794 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6795 NL80211_ATTR_VENDOR_DATA,
6796 0, event_idx, approxlen, gfp);
6797}
6798
6799/**
6800 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6801 * @wiphy: the wiphy
6802 * @wdev: the wireless device
6803 * @event_idx: index of the vendor event in the wiphy's vendor_events
6804 * @portid: port ID of the receiver
6805 * @approxlen: an upper bound of the length of the data that will
6806 * be put into the skb
6807 * @gfp: allocation flags
6808 *
6809 * This function allocates and pre-fills an skb for an event to send to
6810 * a specific (userland) socket. This socket would previously have been
6811 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6812 * care to register a netlink notifier to see when the socket closes.
6813 *
6814 * If wdev != NULL, both the ifindex and identifier of the specified
6815 * wireless device are added to the event message before the vendor data
6816 * attribute.
6817 *
6818 * When done filling the skb, call cfg80211_vendor_event() with the
6819 * skb to send the event.
6820 *
6821 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6822 */
6823static inline struct sk_buff *
6824cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6825 struct wireless_dev *wdev,
6826 unsigned int portid, int approxlen,
6827 int event_idx, gfp_t gfp)
6828{
6829 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6830 NL80211_ATTR_VENDOR_DATA,
6831 portid, event_idx, approxlen, gfp);
6832}
6833
6834/**
6835 * cfg80211_vendor_event - send the event
6836 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6837 * @gfp: allocation flags
6838 *
6839 * This function sends the given @skb, which must have been allocated
6840 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6841 */
6842static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6843{
6844 __cfg80211_send_event_skb(skb, gfp);
6845}
6846
6847#ifdef CONFIG_NL80211_TESTMODE
6848/**
6849 * DOC: Test mode
6850 *
6851 * Test mode is a set of utility functions to allow drivers to
6852 * interact with driver-specific tools to aid, for instance,
6853 * factory programming.
6854 *
6855 * This chapter describes how drivers interact with it, for more
6856 * information see the nl80211 book's chapter on it.
6857 */
6858
6859/**
6860 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6861 * @wiphy: the wiphy
6862 * @approxlen: an upper bound of the length of the data that will
6863 * be put into the skb
6864 *
6865 * This function allocates and pre-fills an skb for a reply to
6866 * the testmode command. Since it is intended for a reply, calling
6867 * it outside of the @testmode_cmd operation is invalid.
6868 *
6869 * The returned skb is pre-filled with the wiphy index and set up in
6870 * a way that any data that is put into the skb (with skb_put(),
6871 * nla_put() or similar) will end up being within the
6872 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6873 * with the skb is adding data for the corresponding userspace tool
6874 * which can then read that data out of the testdata attribute. You
6875 * must not modify the skb in any other way.
6876 *
6877 * When done, call cfg80211_testmode_reply() with the skb and return
6878 * its error code as the result of the @testmode_cmd operation.
6879 *
6880 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6881 */
6882static inline struct sk_buff *
6883cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6884{
6885 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6886 NL80211_ATTR_TESTDATA, approxlen);
6887}
6888
6889/**
6890 * cfg80211_testmode_reply - send the reply skb
6891 * @skb: The skb, must have been allocated with
6892 * cfg80211_testmode_alloc_reply_skb()
6893 *
6894 * Since calling this function will usually be the last thing
6895 * before returning from the @testmode_cmd you should return
6896 * the error code. Note that this function consumes the skb
6897 * regardless of the return value.
6898 *
6899 * Return: An error code or 0 on success.
6900 */
6901static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6902{
6903 return cfg80211_vendor_cmd_reply(skb);
6904}
6905
6906/**
6907 * cfg80211_testmode_alloc_event_skb - allocate testmode event
6908 * @wiphy: the wiphy
6909 * @approxlen: an upper bound of the length of the data that will
6910 * be put into the skb
6911 * @gfp: allocation flags
6912 *
6913 * This function allocates and pre-fills an skb for an event on the
6914 * testmode multicast group.
6915 *
6916 * The returned skb is set up in the same way as with
6917 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6918 * there, you should simply add data to it that will then end up in the
6919 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6920 * in any other way.
6921 *
6922 * When done filling the skb, call cfg80211_testmode_event() with the
6923 * skb to send the event.
6924 *
6925 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6926 */
6927static inline struct sk_buff *
6928cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6929{
6930 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6931 NL80211_ATTR_TESTDATA, 0, -1,
6932 approxlen, gfp);
6933}
6934
6935/**
6936 * cfg80211_testmode_event - send the event
6937 * @skb: The skb, must have been allocated with
6938 * cfg80211_testmode_alloc_event_skb()
6939 * @gfp: allocation flags
6940 *
6941 * This function sends the given @skb, which must have been allocated
6942 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6943 * consumes it.
6944 */
6945static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6946{
6947 __cfg80211_send_event_skb(skb, gfp);
6948}
6949
6950#define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
6951#define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
6952#else
6953#define CFG80211_TESTMODE_CMD(cmd)
6954#define CFG80211_TESTMODE_DUMP(cmd)
6955#endif
6956
6957/**
6958 * struct cfg80211_fils_resp_params - FILS connection response params
6959 * @kek: KEK derived from a successful FILS connection (may be %NULL)
6960 * @kek_len: Length of @fils_kek in octets
6961 * @update_erp_next_seq_num: Boolean value to specify whether the value in
6962 * @erp_next_seq_num is valid.
6963 * @erp_next_seq_num: The next sequence number to use in ERP message in
6964 * FILS Authentication. This value should be specified irrespective of the
6965 * status for a FILS connection.
6966 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6967 * @pmk_len: Length of @pmk in octets
6968 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6969 * used for this FILS connection (may be %NULL).
6970 */
6971struct cfg80211_fils_resp_params {
6972 const u8 *kek;
6973 size_t kek_len;
6974 bool update_erp_next_seq_num;
6975 u16 erp_next_seq_num;
6976 const u8 *pmk;
6977 size_t pmk_len;
6978 const u8 *pmkid;
6979};
6980
6981/**
6982 * struct cfg80211_connect_resp_params - Connection response params
6983 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6984 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6985 * the real status code for failures. If this call is used to report a
6986 * failure due to a timeout (e.g., not receiving an Authentication frame
6987 * from the AP) instead of an explicit rejection by the AP, -1 is used to
6988 * indicate that this is a failure, but without a status code.
6989 * @timeout_reason is used to report the reason for the timeout in that
6990 * case.
6991 * @bssid: The BSSID of the AP (may be %NULL)
6992 * @bss: Entry of bss to which STA got connected to, can be obtained through
6993 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6994 * bss from the connect_request and hold a reference to it and return
6995 * through this param to avoid a warning if the bss is expired during the
6996 * connection, esp. for those drivers implementing connect op.
6997 * Only one parameter among @bssid and @bss needs to be specified.
6998 * @req_ie: Association request IEs (may be %NULL)
6999 * @req_ie_len: Association request IEs length
7000 * @resp_ie: Association response IEs (may be %NULL)
7001 * @resp_ie_len: Association response IEs length
7002 * @fils: FILS connection response parameters.
7003 * @timeout_reason: Reason for connection timeout. This is used when the
7004 * connection fails due to a timeout instead of an explicit rejection from
7005 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7006 * not known. This value is used only if @status < 0 to indicate that the
7007 * failure is due to a timeout and not due to explicit rejection by the AP.
7008 * This value is ignored in other cases (@status >= 0).
7009 */
7010struct cfg80211_connect_resp_params {
7011 int status;
7012 const u8 *bssid;
7013 struct cfg80211_bss *bss;
7014 const u8 *req_ie;
7015 size_t req_ie_len;
7016 const u8 *resp_ie;
7017 size_t resp_ie_len;
7018 struct cfg80211_fils_resp_params fils;
7019 enum nl80211_timeout_reason timeout_reason;
7020};
7021
7022/**
7023 * cfg80211_connect_done - notify cfg80211 of connection result
7024 *
7025 * @dev: network device
7026 * @params: connection response parameters
7027 * @gfp: allocation flags
7028 *
7029 * It should be called by the underlying driver once execution of the connection
7030 * request from connect() has been completed. This is similar to
7031 * cfg80211_connect_bss(), but takes a structure pointer for connection response
7032 * parameters. Only one of the functions among cfg80211_connect_bss(),
7033 * cfg80211_connect_result(), cfg80211_connect_timeout(),
7034 * and cfg80211_connect_done() should be called.
7035 */
7036void cfg80211_connect_done(struct net_device *dev,
7037 struct cfg80211_connect_resp_params *params,
7038 gfp_t gfp);
7039
7040/**
7041 * cfg80211_connect_bss - notify cfg80211 of connection result
7042 *
7043 * @dev: network device
7044 * @bssid: the BSSID of the AP
7045 * @bss: Entry of bss to which STA got connected to, can be obtained through
7046 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7047 * bss from the connect_request and hold a reference to it and return
7048 * through this param to avoid a warning if the bss is expired during the
7049 * connection, esp. for those drivers implementing connect op.
7050 * Only one parameter among @bssid and @bss needs to be specified.
7051 * @req_ie: association request IEs (maybe be %NULL)
7052 * @req_ie_len: association request IEs length
7053 * @resp_ie: association response IEs (may be %NULL)
7054 * @resp_ie_len: assoc response IEs length
7055 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7056 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7057 * the real status code for failures. If this call is used to report a
7058 * failure due to a timeout (e.g., not receiving an Authentication frame
7059 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7060 * indicate that this is a failure, but without a status code.
7061 * @timeout_reason is used to report the reason for the timeout in that
7062 * case.
7063 * @gfp: allocation flags
7064 * @timeout_reason: reason for connection timeout. This is used when the
7065 * connection fails due to a timeout instead of an explicit rejection from
7066 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7067 * not known. This value is used only if @status < 0 to indicate that the
7068 * failure is due to a timeout and not due to explicit rejection by the AP.
7069 * This value is ignored in other cases (@status >= 0).
7070 *
7071 * It should be called by the underlying driver once execution of the connection
7072 * request from connect() has been completed. This is similar to
7073 * cfg80211_connect_result(), but with the option of identifying the exact bss
7074 * entry for the connection. Only one of the functions among
7075 * cfg80211_connect_bss(), cfg80211_connect_result(),
7076 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7077 */
7078static inline void
7079cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
7080 struct cfg80211_bss *bss, const u8 *req_ie,
7081 size_t req_ie_len, const u8 *resp_ie,
7082 size_t resp_ie_len, int status, gfp_t gfp,
7083 enum nl80211_timeout_reason timeout_reason)
7084{
7085 struct cfg80211_connect_resp_params params;
7086
7087 memset(¶ms, 0, sizeof(params));
7088 params.status = status;
7089 params.bssid = bssid;
7090 params.bss = bss;
7091 params.req_ie = req_ie;
7092 params.req_ie_len = req_ie_len;
7093 params.resp_ie = resp_ie;
7094 params.resp_ie_len = resp_ie_len;
7095 params.timeout_reason = timeout_reason;
7096
7097 cfg80211_connect_done(dev, ¶ms, gfp);
7098}
7099
7100/**
7101 * cfg80211_connect_result - notify cfg80211 of connection result
7102 *
7103 * @dev: network device
7104 * @bssid: the BSSID of the AP
7105 * @req_ie: association request IEs (maybe be %NULL)
7106 * @req_ie_len: association request IEs length
7107 * @resp_ie: association response IEs (may be %NULL)
7108 * @resp_ie_len: assoc response IEs length
7109 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7110 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7111 * the real status code for failures.
7112 * @gfp: allocation flags
7113 *
7114 * It should be called by the underlying driver once execution of the connection
7115 * request from connect() has been completed. This is similar to
7116 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
7117 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
7118 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7119 */
7120static inline void
7121cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
7122 const u8 *req_ie, size_t req_ie_len,
7123 const u8 *resp_ie, size_t resp_ie_len,
7124 u16 status, gfp_t gfp)
7125{
7126 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
7127 resp_ie_len, status, gfp,
7128 NL80211_TIMEOUT_UNSPECIFIED);
7129}
7130
7131/**
7132 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
7133 *
7134 * @dev: network device
7135 * @bssid: the BSSID of the AP
7136 * @req_ie: association request IEs (maybe be %NULL)
7137 * @req_ie_len: association request IEs length
7138 * @gfp: allocation flags
7139 * @timeout_reason: reason for connection timeout.
7140 *
7141 * It should be called by the underlying driver whenever connect() has failed
7142 * in a sequence where no explicit authentication/association rejection was
7143 * received from the AP. This could happen, e.g., due to not being able to send
7144 * out the Authentication or Association Request frame or timing out while
7145 * waiting for the response. Only one of the functions among
7146 * cfg80211_connect_bss(), cfg80211_connect_result(),
7147 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7148 */
7149static inline void
7150cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
7151 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
7152 enum nl80211_timeout_reason timeout_reason)
7153{
7154 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
7155 gfp, timeout_reason);
7156}
7157
7158/**
7159 * struct cfg80211_roam_info - driver initiated roaming information
7160 *
7161 * @channel: the channel of the new AP
7162 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
7163 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
7164 * @req_ie: association request IEs (maybe be %NULL)
7165 * @req_ie_len: association request IEs length
7166 * @resp_ie: association response IEs (may be %NULL)
7167 * @resp_ie_len: assoc response IEs length
7168 * @fils: FILS related roaming information.
7169 */
7170struct cfg80211_roam_info {
7171 struct ieee80211_channel *channel;
7172 struct cfg80211_bss *bss;
7173 const u8 *bssid;
7174 const u8 *req_ie;
7175 size_t req_ie_len;
7176 const u8 *resp_ie;
7177 size_t resp_ie_len;
7178 struct cfg80211_fils_resp_params fils;
7179};
7180
7181/**
7182 * cfg80211_roamed - notify cfg80211 of roaming
7183 *
7184 * @dev: network device
7185 * @info: information about the new BSS. struct &cfg80211_roam_info.
7186 * @gfp: allocation flags
7187 *
7188 * This function may be called with the driver passing either the BSSID of the
7189 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7190 * It should be called by the underlying driver whenever it roamed from one AP
7191 * to another while connected. Drivers which have roaming implemented in
7192 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7193 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7194 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7195 * rdev->event_work. In case of any failures, the reference is released
7196 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7197 * released while disconnecting from the current bss.
7198 */
7199void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7200 gfp_t gfp);
7201
7202/**
7203 * cfg80211_port_authorized - notify cfg80211 of successful security association
7204 *
7205 * @dev: network device
7206 * @bssid: the BSSID of the AP
7207 * @gfp: allocation flags
7208 *
7209 * This function should be called by a driver that supports 4 way handshake
7210 * offload after a security association was successfully established (i.e.,
7211 * the 4 way handshake was completed successfully). The call to this function
7212 * should be preceded with a call to cfg80211_connect_result(),
7213 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7214 * indicate the 802.11 association.
7215 */
7216void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7217 gfp_t gfp);
7218
7219/**
7220 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7221 *
7222 * @dev: network device
7223 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7224 * @ie_len: length of IEs
7225 * @reason: reason code for the disconnection, set it to 0 if unknown
7226 * @locally_generated: disconnection was requested locally
7227 * @gfp: allocation flags
7228 *
7229 * After it calls this function, the driver should enter an idle state
7230 * and not try to connect to any AP any more.
7231 */
7232void cfg80211_disconnected(struct net_device *dev, u16 reason,
7233 const u8 *ie, size_t ie_len,
7234 bool locally_generated, gfp_t gfp);
7235
7236/**
7237 * cfg80211_ready_on_channel - notification of remain_on_channel start
7238 * @wdev: wireless device
7239 * @cookie: the request cookie
7240 * @chan: The current channel (from remain_on_channel request)
7241 * @duration: Duration in milliseconds that the driver intents to remain on the
7242 * channel
7243 * @gfp: allocation flags
7244 */
7245void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7246 struct ieee80211_channel *chan,
7247 unsigned int duration, gfp_t gfp);
7248
7249/**
7250 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7251 * @wdev: wireless device
7252 * @cookie: the request cookie
7253 * @chan: The current channel (from remain_on_channel request)
7254 * @gfp: allocation flags
7255 */
7256void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7257 struct ieee80211_channel *chan,
7258 gfp_t gfp);
7259
7260/**
7261 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7262 * @wdev: wireless device
7263 * @cookie: the requested cookie
7264 * @chan: The current channel (from tx_mgmt request)
7265 * @gfp: allocation flags
7266 */
7267void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7268 struct ieee80211_channel *chan, gfp_t gfp);
7269
7270/**
7271 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7272 *
7273 * @sinfo: the station information
7274 * @gfp: allocation flags
7275 */
7276int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7277
7278/**
7279 * cfg80211_sinfo_release_content - release contents of station info
7280 * @sinfo: the station information
7281 *
7282 * Releases any potentially allocated sub-information of the station
7283 * information, but not the struct itself (since it's typically on
7284 * the stack.)
7285 */
7286static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7287{
7288 kfree(sinfo->pertid);
7289}
7290
7291/**
7292 * cfg80211_new_sta - notify userspace about station
7293 *
7294 * @dev: the netdev
7295 * @mac_addr: the station's address
7296 * @sinfo: the station information
7297 * @gfp: allocation flags
7298 */
7299void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7300 struct station_info *sinfo, gfp_t gfp);
7301
7302/**
7303 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7304 * @dev: the netdev
7305 * @mac_addr: the station's address
7306 * @sinfo: the station information/statistics
7307 * @gfp: allocation flags
7308 */
7309void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7310 struct station_info *sinfo, gfp_t gfp);
7311
7312/**
7313 * cfg80211_del_sta - notify userspace about deletion of a station
7314 *
7315 * @dev: the netdev
7316 * @mac_addr: the station's address
7317 * @gfp: allocation flags
7318 */
7319static inline void cfg80211_del_sta(struct net_device *dev,
7320 const u8 *mac_addr, gfp_t gfp)
7321{
7322 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7323}
7324
7325/**
7326 * cfg80211_conn_failed - connection request failed notification
7327 *
7328 * @dev: the netdev
7329 * @mac_addr: the station's address
7330 * @reason: the reason for connection failure
7331 * @gfp: allocation flags
7332 *
7333 * Whenever a station tries to connect to an AP and if the station
7334 * could not connect to the AP as the AP has rejected the connection
7335 * for some reasons, this function is called.
7336 *
7337 * The reason for connection failure can be any of the value from
7338 * nl80211_connect_failed_reason enum
7339 */
7340void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7341 enum nl80211_connect_failed_reason reason,
7342 gfp_t gfp);
7343
7344/**
7345 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7346 * @wdev: wireless device receiving the frame
7347 * @freq: Frequency on which the frame was received in KHz
7348 * @sig_dbm: signal strength in dBm, or 0 if unknown
7349 * @buf: Management frame (header + body)
7350 * @len: length of the frame data
7351 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7352 *
7353 * This function is called whenever an Action frame is received for a station
7354 * mode interface, but is not processed in kernel.
7355 *
7356 * Return: %true if a user space application has registered for this frame.
7357 * For action frames, that makes it responsible for rejecting unrecognized
7358 * action frames; %false otherwise, in which case for action frames the
7359 * driver is responsible for rejecting the frame.
7360 */
7361bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq, int sig_dbm,
7362 const u8 *buf, size_t len, u32 flags);
7363
7364/**
7365 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7366 * @wdev: wireless device receiving the frame
7367 * @freq: Frequency on which the frame was received in MHz
7368 * @sig_dbm: signal strength in dBm, or 0 if unknown
7369 * @buf: Management frame (header + body)
7370 * @len: length of the frame data
7371 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7372 *
7373 * This function is called whenever an Action frame is received for a station
7374 * mode interface, but is not processed in kernel.
7375 *
7376 * Return: %true if a user space application has registered for this frame.
7377 * For action frames, that makes it responsible for rejecting unrecognized
7378 * action frames; %false otherwise, in which case for action frames the
7379 * driver is responsible for rejecting the frame.
7380 */
7381static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7382 int sig_dbm, const u8 *buf, size_t len,
7383 u32 flags)
7384{
7385 return cfg80211_rx_mgmt_khz(wdev, MHZ_TO_KHZ(freq), sig_dbm, buf, len,
7386 flags);
7387}
7388
7389/**
7390 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7391 * @wdev: wireless device receiving the frame
7392 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7393 * @buf: Management frame (header + body)
7394 * @len: length of the frame data
7395 * @ack: Whether frame was acknowledged
7396 * @gfp: context flags
7397 *
7398 * This function is called whenever a management frame was requested to be
7399 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7400 * transmission attempt.
7401 */
7402void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
7403 const u8 *buf, size_t len, bool ack, gfp_t gfp);
7404
7405/**
7406 * cfg80211_control_port_tx_status - notification of TX status for control
7407 * port frames
7408 * @wdev: wireless device receiving the frame
7409 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
7410 * @buf: Data frame (header + body)
7411 * @len: length of the frame data
7412 * @ack: Whether frame was acknowledged
7413 * @gfp: context flags
7414 *
7415 * This function is called whenever a control port frame was requested to be
7416 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
7417 * the transmission attempt.
7418 */
7419void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
7420 const u8 *buf, size_t len, bool ack,
7421 gfp_t gfp);
7422
7423/**
7424 * cfg80211_rx_control_port - notification about a received control port frame
7425 * @dev: The device the frame matched to
7426 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
7427 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
7428 * This function does not take ownership of the skb, so the caller is
7429 * responsible for any cleanup. The caller must also ensure that
7430 * skb->protocol is set appropriately.
7431 * @unencrypted: Whether the frame was received unencrypted
7432 *
7433 * This function is used to inform userspace about a received control port
7434 * frame. It should only be used if userspace indicated it wants to receive
7435 * control port frames over nl80211.
7436 *
7437 * The frame is the data portion of the 802.3 or 802.11 data frame with all
7438 * network layer headers removed (e.g. the raw EAPoL frame).
7439 *
7440 * Return: %true if the frame was passed to userspace
7441 */
7442bool cfg80211_rx_control_port(struct net_device *dev,
7443 struct sk_buff *skb, bool unencrypted);
7444
7445/**
7446 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
7447 * @dev: network device
7448 * @rssi_event: the triggered RSSI event
7449 * @rssi_level: new RSSI level value or 0 if not available
7450 * @gfp: context flags
7451 *
7452 * This function is called when a configured connection quality monitoring
7453 * rssi threshold reached event occurs.
7454 */
7455void cfg80211_cqm_rssi_notify(struct net_device *dev,
7456 enum nl80211_cqm_rssi_threshold_event rssi_event,
7457 s32 rssi_level, gfp_t gfp);
7458
7459/**
7460 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
7461 * @dev: network device
7462 * @peer: peer's MAC address
7463 * @num_packets: how many packets were lost -- should be a fixed threshold
7464 * but probably no less than maybe 50, or maybe a throughput dependent
7465 * threshold (to account for temporary interference)
7466 * @gfp: context flags
7467 */
7468void cfg80211_cqm_pktloss_notify(struct net_device *dev,
7469 const u8 *peer, u32 num_packets, gfp_t gfp);
7470
7471/**
7472 * cfg80211_cqm_txe_notify - TX error rate event
7473 * @dev: network device
7474 * @peer: peer's MAC address
7475 * @num_packets: how many packets were lost
7476 * @rate: % of packets which failed transmission
7477 * @intvl: interval (in s) over which the TX failure threshold was breached.
7478 * @gfp: context flags
7479 *
7480 * Notify userspace when configured % TX failures over number of packets in a
7481 * given interval is exceeded.
7482 */
7483void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
7484 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
7485
7486/**
7487 * cfg80211_cqm_beacon_loss_notify - beacon loss event
7488 * @dev: network device
7489 * @gfp: context flags
7490 *
7491 * Notify userspace about beacon loss from the connected AP.
7492 */
7493void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
7494
7495/**
7496 * cfg80211_radar_event - radar detection event
7497 * @wiphy: the wiphy
7498 * @chandef: chandef for the current channel
7499 * @gfp: context flags
7500 *
7501 * This function is called when a radar is detected on the current chanenl.
7502 */
7503void cfg80211_radar_event(struct wiphy *wiphy,
7504 struct cfg80211_chan_def *chandef, gfp_t gfp);
7505
7506/**
7507 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
7508 * @dev: network device
7509 * @mac: MAC address of a station which opmode got modified
7510 * @sta_opmode: station's current opmode value
7511 * @gfp: context flags
7512 *
7513 * Driver should call this function when station's opmode modified via action
7514 * frame.
7515 */
7516void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
7517 struct sta_opmode_info *sta_opmode,
7518 gfp_t gfp);
7519
7520/**
7521 * cfg80211_cac_event - Channel availability check (CAC) event
7522 * @netdev: network device
7523 * @chandef: chandef for the current channel
7524 * @event: type of event
7525 * @gfp: context flags
7526 *
7527 * This function is called when a Channel availability check (CAC) is finished
7528 * or aborted. This must be called to notify the completion of a CAC process,
7529 * also by full-MAC drivers.
7530 */
7531void cfg80211_cac_event(struct net_device *netdev,
7532 const struct cfg80211_chan_def *chandef,
7533 enum nl80211_radar_event event, gfp_t gfp);
7534
7535
7536/**
7537 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
7538 * @dev: network device
7539 * @bssid: BSSID of AP (to avoid races)
7540 * @replay_ctr: new replay counter
7541 * @gfp: allocation flags
7542 */
7543void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
7544 const u8 *replay_ctr, gfp_t gfp);
7545
7546/**
7547 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
7548 * @dev: network device
7549 * @index: candidate index (the smaller the index, the higher the priority)
7550 * @bssid: BSSID of AP
7551 * @preauth: Whether AP advertises support for RSN pre-authentication
7552 * @gfp: allocation flags
7553 */
7554void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
7555 const u8 *bssid, bool preauth, gfp_t gfp);
7556
7557/**
7558 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
7559 * @dev: The device the frame matched to
7560 * @addr: the transmitter address
7561 * @gfp: context flags
7562 *
7563 * This function is used in AP mode (only!) to inform userspace that
7564 * a spurious class 3 frame was received, to be able to deauth the
7565 * sender.
7566 * Return: %true if the frame was passed to userspace (or this failed
7567 * for a reason other than not having a subscription.)
7568 */
7569bool cfg80211_rx_spurious_frame(struct net_device *dev,
7570 const u8 *addr, gfp_t gfp);
7571
7572/**
7573 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
7574 * @dev: The device the frame matched to
7575 * @addr: the transmitter address
7576 * @gfp: context flags
7577 *
7578 * This function is used in AP mode (only!) to inform userspace that
7579 * an associated station sent a 4addr frame but that wasn't expected.
7580 * It is allowed and desirable to send this event only once for each
7581 * station to avoid event flooding.
7582 * Return: %true if the frame was passed to userspace (or this failed
7583 * for a reason other than not having a subscription.)
7584 */
7585bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
7586 const u8 *addr, gfp_t gfp);
7587
7588/**
7589 * cfg80211_probe_status - notify userspace about probe status
7590 * @dev: the device the probe was sent on
7591 * @addr: the address of the peer
7592 * @cookie: the cookie filled in @probe_client previously
7593 * @acked: indicates whether probe was acked or not
7594 * @ack_signal: signal strength (in dBm) of the ACK frame.
7595 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
7596 * @gfp: allocation flags
7597 */
7598void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
7599 u64 cookie, bool acked, s32 ack_signal,
7600 bool is_valid_ack_signal, gfp_t gfp);
7601
7602/**
7603 * cfg80211_report_obss_beacon_khz - report beacon from other APs
7604 * @wiphy: The wiphy that received the beacon
7605 * @frame: the frame
7606 * @len: length of the frame
7607 * @freq: frequency the frame was received on in KHz
7608 * @sig_dbm: signal strength in dBm, or 0 if unknown
7609 *
7610 * Use this function to report to userspace when a beacon was
7611 * received. It is not useful to call this when there is no
7612 * netdev that is in AP/GO mode.
7613 */
7614void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
7615 size_t len, int freq, int sig_dbm);
7616
7617/**
7618 * cfg80211_report_obss_beacon - report beacon from other APs
7619 * @wiphy: The wiphy that received the beacon
7620 * @frame: the frame
7621 * @len: length of the frame
7622 * @freq: frequency the frame was received on
7623 * @sig_dbm: signal strength in dBm, or 0 if unknown
7624 *
7625 * Use this function to report to userspace when a beacon was
7626 * received. It is not useful to call this when there is no
7627 * netdev that is in AP/GO mode.
7628 */
7629static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
7630 const u8 *frame, size_t len,
7631 int freq, int sig_dbm)
7632{
7633 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
7634 sig_dbm);
7635}
7636
7637/**
7638 * cfg80211_reg_can_beacon - check if beaconing is allowed
7639 * @wiphy: the wiphy
7640 * @chandef: the channel definition
7641 * @iftype: interface type
7642 *
7643 * Return: %true if there is no secondary channel or the secondary channel(s)
7644 * can be used for beaconing (i.e. is not a radar channel etc.)
7645 */
7646bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
7647 struct cfg80211_chan_def *chandef,
7648 enum nl80211_iftype iftype);
7649
7650/**
7651 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
7652 * @wiphy: the wiphy
7653 * @chandef: the channel definition
7654 * @iftype: interface type
7655 *
7656 * Return: %true if there is no secondary channel or the secondary channel(s)
7657 * can be used for beaconing (i.e. is not a radar channel etc.). This version
7658 * also checks if IR-relaxation conditions apply, to allow beaconing under
7659 * more permissive conditions.
7660 *
7661 * Requires the wiphy mutex to be held.
7662 */
7663bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7664 struct cfg80211_chan_def *chandef,
7665 enum nl80211_iftype iftype);
7666
7667/*
7668 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7669 * @dev: the device which switched channels
7670 * @chandef: the new channel definition
7671 *
7672 * Caller must acquire wdev_lock, therefore must only be called from sleepable
7673 * driver context!
7674 */
7675void cfg80211_ch_switch_notify(struct net_device *dev,
7676 struct cfg80211_chan_def *chandef);
7677
7678/*
7679 * cfg80211_ch_switch_started_notify - notify channel switch start
7680 * @dev: the device on which the channel switch started
7681 * @chandef: the future channel definition
7682 * @count: the number of TBTTs until the channel switch happens
7683 * @quiet: whether or not immediate quiet was requested by the AP
7684 *
7685 * Inform the userspace about the channel switch that has just
7686 * started, so that it can take appropriate actions (eg. starting
7687 * channel switch on other vifs), if necessary.
7688 */
7689void cfg80211_ch_switch_started_notify(struct net_device *dev,
7690 struct cfg80211_chan_def *chandef,
7691 u8 count, bool quiet);
7692
7693/**
7694 * ieee80211_operating_class_to_band - convert operating class to band
7695 *
7696 * @operating_class: the operating class to convert
7697 * @band: band pointer to fill
7698 *
7699 * Returns %true if the conversion was successful, %false otherwise.
7700 */
7701bool ieee80211_operating_class_to_band(u8 operating_class,
7702 enum nl80211_band *band);
7703
7704/**
7705 * ieee80211_chandef_to_operating_class - convert chandef to operation class
7706 *
7707 * @chandef: the chandef to convert
7708 * @op_class: a pointer to the resulting operating class
7709 *
7710 * Returns %true if the conversion was successful, %false otherwise.
7711 */
7712bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7713 u8 *op_class);
7714
7715/**
7716 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
7717 *
7718 * @chandef: the chandef to convert
7719 *
7720 * Returns the center frequency of chandef (1st segment) in KHz.
7721 */
7722static inline u32
7723ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
7724{
7725 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
7726}
7727
7728/*
7729 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7730 * @dev: the device on which the operation is requested
7731 * @peer: the MAC address of the peer device
7732 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7733 * NL80211_TDLS_TEARDOWN)
7734 * @reason_code: the reason code for teardown request
7735 * @gfp: allocation flags
7736 *
7737 * This function is used to request userspace to perform TDLS operation that
7738 * requires knowledge of keys, i.e., link setup or teardown when the AP
7739 * connection uses encryption. This is optional mechanism for the driver to use
7740 * if it can automatically determine when a TDLS link could be useful (e.g.,
7741 * based on traffic and signal strength for a peer).
7742 */
7743void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7744 enum nl80211_tdls_operation oper,
7745 u16 reason_code, gfp_t gfp);
7746
7747/*
7748 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7749 * @rate: given rate_info to calculate bitrate from
7750 *
7751 * return 0 if MCS index >= 32
7752 */
7753u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7754
7755/**
7756 * cfg80211_unregister_wdev - remove the given wdev
7757 * @wdev: struct wireless_dev to remove
7758 *
7759 * This function removes the device so it can no longer be used. It is necessary
7760 * to call this function even when cfg80211 requests the removal of the device
7761 * by calling the del_virtual_intf() callback. The function must also be called
7762 * when the driver wishes to unregister the wdev, e.g. when the hardware device
7763 * is unbound from the driver.
7764 *
7765 * Requires the RTNL and wiphy mutex to be held.
7766 */
7767void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7768
7769/**
7770 * cfg80211_register_netdevice - register the given netdev
7771 * @dev: the netdev to register
7772 *
7773 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
7774 * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
7775 * held. Otherwise, both register_netdevice() and register_netdev() are usable
7776 * instead as well.
7777 *
7778 * Requires the RTNL and wiphy mutex to be held.
7779 */
7780int cfg80211_register_netdevice(struct net_device *dev);
7781
7782/**
7783 * cfg80211_unregister_netdevice - unregister the given netdev
7784 * @dev: the netdev to register
7785 *
7786 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
7787 * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
7788 * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
7789 * usable instead as well.
7790 *
7791 * Requires the RTNL and wiphy mutex to be held.
7792 */
7793static inline void cfg80211_unregister_netdevice(struct net_device *dev)
7794{
7795 cfg80211_unregister_wdev(dev->ieee80211_ptr);
7796}
7797
7798/**
7799 * struct cfg80211_ft_event_params - FT Information Elements
7800 * @ies: FT IEs
7801 * @ies_len: length of the FT IE in bytes
7802 * @target_ap: target AP's MAC address
7803 * @ric_ies: RIC IE
7804 * @ric_ies_len: length of the RIC IE in bytes
7805 */
7806struct cfg80211_ft_event_params {
7807 const u8 *ies;
7808 size_t ies_len;
7809 const u8 *target_ap;
7810 const u8 *ric_ies;
7811 size_t ric_ies_len;
7812};
7813
7814/**
7815 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7816 * @netdev: network device
7817 * @ft_event: IE information
7818 */
7819void cfg80211_ft_event(struct net_device *netdev,
7820 struct cfg80211_ft_event_params *ft_event);
7821
7822/**
7823 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7824 * @ies: the input IE buffer
7825 * @len: the input length
7826 * @attr: the attribute ID to find
7827 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7828 * if the function is only called to get the needed buffer size
7829 * @bufsize: size of the output buffer
7830 *
7831 * The function finds a given P2P attribute in the (vendor) IEs and
7832 * copies its contents to the given buffer.
7833 *
7834 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7835 * malformed or the attribute can't be found (respectively), or the
7836 * length of the found attribute (which can be zero).
7837 */
7838int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7839 enum ieee80211_p2p_attr_id attr,
7840 u8 *buf, unsigned int bufsize);
7841
7842/**
7843 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7844 * @ies: the IE buffer
7845 * @ielen: the length of the IE buffer
7846 * @ids: an array with element IDs that are allowed before
7847 * the split. A WLAN_EID_EXTENSION value means that the next
7848 * EID in the list is a sub-element of the EXTENSION IE.
7849 * @n_ids: the size of the element ID array
7850 * @after_ric: array IE types that come after the RIC element
7851 * @n_after_ric: size of the @after_ric array
7852 * @offset: offset where to start splitting in the buffer
7853 *
7854 * This function splits an IE buffer by updating the @offset
7855 * variable to point to the location where the buffer should be
7856 * split.
7857 *
7858 * It assumes that the given IE buffer is well-formed, this
7859 * has to be guaranteed by the caller!
7860 *
7861 * It also assumes that the IEs in the buffer are ordered
7862 * correctly, if not the result of using this function will not
7863 * be ordered correctly either, i.e. it does no reordering.
7864 *
7865 * The function returns the offset where the next part of the
7866 * buffer starts, which may be @ielen if the entire (remainder)
7867 * of the buffer should be used.
7868 */
7869size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7870 const u8 *ids, int n_ids,
7871 const u8 *after_ric, int n_after_ric,
7872 size_t offset);
7873
7874/**
7875 * ieee80211_ie_split - split an IE buffer according to ordering
7876 * @ies: the IE buffer
7877 * @ielen: the length of the IE buffer
7878 * @ids: an array with element IDs that are allowed before
7879 * the split. A WLAN_EID_EXTENSION value means that the next
7880 * EID in the list is a sub-element of the EXTENSION IE.
7881 * @n_ids: the size of the element ID array
7882 * @offset: offset where to start splitting in the buffer
7883 *
7884 * This function splits an IE buffer by updating the @offset
7885 * variable to point to the location where the buffer should be
7886 * split.
7887 *
7888 * It assumes that the given IE buffer is well-formed, this
7889 * has to be guaranteed by the caller!
7890 *
7891 * It also assumes that the IEs in the buffer are ordered
7892 * correctly, if not the result of using this function will not
7893 * be ordered correctly either, i.e. it does no reordering.
7894 *
7895 * The function returns the offset where the next part of the
7896 * buffer starts, which may be @ielen if the entire (remainder)
7897 * of the buffer should be used.
7898 */
7899static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7900 const u8 *ids, int n_ids, size_t offset)
7901{
7902 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7903}
7904
7905/**
7906 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7907 * @wdev: the wireless device reporting the wakeup
7908 * @wakeup: the wakeup report
7909 * @gfp: allocation flags
7910 *
7911 * This function reports that the given device woke up. If it
7912 * caused the wakeup, report the reason(s), otherwise you may
7913 * pass %NULL as the @wakeup parameter to advertise that something
7914 * else caused the wakeup.
7915 */
7916void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7917 struct cfg80211_wowlan_wakeup *wakeup,
7918 gfp_t gfp);
7919
7920/**
7921 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7922 *
7923 * @wdev: the wireless device for which critical protocol is stopped.
7924 * @gfp: allocation flags
7925 *
7926 * This function can be called by the driver to indicate it has reverted
7927 * operation back to normal. One reason could be that the duration given
7928 * by .crit_proto_start() has expired.
7929 */
7930void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7931
7932/**
7933 * ieee80211_get_num_supported_channels - get number of channels device has
7934 * @wiphy: the wiphy
7935 *
7936 * Return: the number of channels supported by the device.
7937 */
7938unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7939
7940/**
7941 * cfg80211_check_combinations - check interface combinations
7942 *
7943 * @wiphy: the wiphy
7944 * @params: the interface combinations parameter
7945 *
7946 * This function can be called by the driver to check whether a
7947 * combination of interfaces and their types are allowed according to
7948 * the interface combinations.
7949 */
7950int cfg80211_check_combinations(struct wiphy *wiphy,
7951 struct iface_combination_params *params);
7952
7953/**
7954 * cfg80211_iter_combinations - iterate over matching combinations
7955 *
7956 * @wiphy: the wiphy
7957 * @params: the interface combinations parameter
7958 * @iter: function to call for each matching combination
7959 * @data: pointer to pass to iter function
7960 *
7961 * This function can be called by the driver to check what possible
7962 * combinations it fits in at a given moment, e.g. for channel switching
7963 * purposes.
7964 */
7965int cfg80211_iter_combinations(struct wiphy *wiphy,
7966 struct iface_combination_params *params,
7967 void (*iter)(const struct ieee80211_iface_combination *c,
7968 void *data),
7969 void *data);
7970
7971/*
7972 * cfg80211_stop_iface - trigger interface disconnection
7973 *
7974 * @wiphy: the wiphy
7975 * @wdev: wireless device
7976 * @gfp: context flags
7977 *
7978 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7979 * disconnected.
7980 *
7981 * Note: This doesn't need any locks and is asynchronous.
7982 */
7983void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7984 gfp_t gfp);
7985
7986/**
7987 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7988 * @wiphy: the wiphy to shut down
7989 *
7990 * This function shuts down all interfaces belonging to this wiphy by
7991 * calling dev_close() (and treating non-netdev interfaces as needed).
7992 * It shouldn't really be used unless there are some fatal device errors
7993 * that really can't be recovered in any other way.
7994 *
7995 * Callers must hold the RTNL and be able to deal with callbacks into
7996 * the driver while the function is running.
7997 */
7998void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7999
8000/**
8001 * wiphy_ext_feature_set - set the extended feature flag
8002 *
8003 * @wiphy: the wiphy to modify.
8004 * @ftidx: extended feature bit index.
8005 *
8006 * The extended features are flagged in multiple bytes (see
8007 * &struct wiphy.@ext_features)
8008 */
8009static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
8010 enum nl80211_ext_feature_index ftidx)
8011{
8012 u8 *ft_byte;
8013
8014 ft_byte = &wiphy->ext_features[ftidx / 8];
8015 *ft_byte |= BIT(ftidx % 8);
8016}
8017
8018/**
8019 * wiphy_ext_feature_isset - check the extended feature flag
8020 *
8021 * @wiphy: the wiphy to modify.
8022 * @ftidx: extended feature bit index.
8023 *
8024 * The extended features are flagged in multiple bytes (see
8025 * &struct wiphy.@ext_features)
8026 */
8027static inline bool
8028wiphy_ext_feature_isset(struct wiphy *wiphy,
8029 enum nl80211_ext_feature_index ftidx)
8030{
8031 u8 ft_byte;
8032
8033 ft_byte = wiphy->ext_features[ftidx / 8];
8034 return (ft_byte & BIT(ftidx % 8)) != 0;
8035}
8036
8037/**
8038 * cfg80211_free_nan_func - free NAN function
8039 * @f: NAN function that should be freed
8040 *
8041 * Frees all the NAN function and all it's allocated members.
8042 */
8043void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
8044
8045/**
8046 * struct cfg80211_nan_match_params - NAN match parameters
8047 * @type: the type of the function that triggered a match. If it is
8048 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
8049 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
8050 * result.
8051 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
8052 * @inst_id: the local instance id
8053 * @peer_inst_id: the instance id of the peer's function
8054 * @addr: the MAC address of the peer
8055 * @info_len: the length of the &info
8056 * @info: the Service Specific Info from the peer (if any)
8057 * @cookie: unique identifier of the corresponding function
8058 */
8059struct cfg80211_nan_match_params {
8060 enum nl80211_nan_function_type type;
8061 u8 inst_id;
8062 u8 peer_inst_id;
8063 const u8 *addr;
8064 u8 info_len;
8065 const u8 *info;
8066 u64 cookie;
8067};
8068
8069/**
8070 * cfg80211_nan_match - report a match for a NAN function.
8071 * @wdev: the wireless device reporting the match
8072 * @match: match notification parameters
8073 * @gfp: allocation flags
8074 *
8075 * This function reports that the a NAN function had a match. This
8076 * can be a subscribe that had a match or a solicited publish that
8077 * was sent. It can also be a follow up that was received.
8078 */
8079void cfg80211_nan_match(struct wireless_dev *wdev,
8080 struct cfg80211_nan_match_params *match, gfp_t gfp);
8081
8082/**
8083 * cfg80211_nan_func_terminated - notify about NAN function termination.
8084 *
8085 * @wdev: the wireless device reporting the match
8086 * @inst_id: the local instance id
8087 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
8088 * @cookie: unique NAN function identifier
8089 * @gfp: allocation flags
8090 *
8091 * This function reports that the a NAN function is terminated.
8092 */
8093void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
8094 u8 inst_id,
8095 enum nl80211_nan_func_term_reason reason,
8096 u64 cookie, gfp_t gfp);
8097
8098/* ethtool helper */
8099void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
8100
8101/**
8102 * cfg80211_external_auth_request - userspace request for authentication
8103 * @netdev: network device
8104 * @params: External authentication parameters
8105 * @gfp: allocation flags
8106 * Returns: 0 on success, < 0 on error
8107 */
8108int cfg80211_external_auth_request(struct net_device *netdev,
8109 struct cfg80211_external_auth_params *params,
8110 gfp_t gfp);
8111
8112/**
8113 * cfg80211_pmsr_report - report peer measurement result data
8114 * @wdev: the wireless device reporting the measurement
8115 * @req: the original measurement request
8116 * @result: the result data
8117 * @gfp: allocation flags
8118 */
8119void cfg80211_pmsr_report(struct wireless_dev *wdev,
8120 struct cfg80211_pmsr_request *req,
8121 struct cfg80211_pmsr_result *result,
8122 gfp_t gfp);
8123
8124/**
8125 * cfg80211_pmsr_complete - report peer measurement completed
8126 * @wdev: the wireless device reporting the measurement
8127 * @req: the original measurement request
8128 * @gfp: allocation flags
8129 *
8130 * Report that the entire measurement completed, after this
8131 * the request pointer will no longer be valid.
8132 */
8133void cfg80211_pmsr_complete(struct wireless_dev *wdev,
8134 struct cfg80211_pmsr_request *req,
8135 gfp_t gfp);
8136
8137/**
8138 * cfg80211_iftype_allowed - check whether the interface can be allowed
8139 * @wiphy: the wiphy
8140 * @iftype: interface type
8141 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
8142 * @check_swif: check iftype against software interfaces
8143 *
8144 * Check whether the interface is allowed to operate; additionally, this API
8145 * can be used to check iftype against the software interfaces when
8146 * check_swif is '1'.
8147 */
8148bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
8149 bool is_4addr, u8 check_swif);
8150
8151
8152/* Logging, debugging and troubleshooting/diagnostic helpers. */
8153
8154/* wiphy_printk helpers, similar to dev_printk */
8155
8156#define wiphy_printk(level, wiphy, format, args...) \
8157 dev_printk(level, &(wiphy)->dev, format, ##args)
8158#define wiphy_emerg(wiphy, format, args...) \
8159 dev_emerg(&(wiphy)->dev, format, ##args)
8160#define wiphy_alert(wiphy, format, args...) \
8161 dev_alert(&(wiphy)->dev, format, ##args)
8162#define wiphy_crit(wiphy, format, args...) \
8163 dev_crit(&(wiphy)->dev, format, ##args)
8164#define wiphy_err(wiphy, format, args...) \
8165 dev_err(&(wiphy)->dev, format, ##args)
8166#define wiphy_warn(wiphy, format, args...) \
8167 dev_warn(&(wiphy)->dev, format, ##args)
8168#define wiphy_notice(wiphy, format, args...) \
8169 dev_notice(&(wiphy)->dev, format, ##args)
8170#define wiphy_info(wiphy, format, args...) \
8171 dev_info(&(wiphy)->dev, format, ##args)
8172#define wiphy_info_once(wiphy, format, args...) \
8173 dev_info_once(&(wiphy)->dev, format, ##args)
8174
8175#define wiphy_err_ratelimited(wiphy, format, args...) \
8176 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
8177#define wiphy_warn_ratelimited(wiphy, format, args...) \
8178 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
8179
8180#define wiphy_debug(wiphy, format, args...) \
8181 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
8182
8183#define wiphy_dbg(wiphy, format, args...) \
8184 dev_dbg(&(wiphy)->dev, format, ##args)
8185
8186#if defined(VERBOSE_DEBUG)
8187#define wiphy_vdbg wiphy_dbg
8188#else
8189#define wiphy_vdbg(wiphy, format, args...) \
8190({ \
8191 if (0) \
8192 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8193 0; \
8194})
8195#endif
8196
8197/*
8198 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8199 * of using a WARN/WARN_ON to get the message out, including the
8200 * file/line information and a backtrace.
8201 */
8202#define wiphy_WARN(wiphy, format, args...) \
8203 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8204
8205/**
8206 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8207 * @netdev: network device
8208 * @owe_info: peer's owe info
8209 * @gfp: allocation flags
8210 */
8211void cfg80211_update_owe_info_event(struct net_device *netdev,
8212 struct cfg80211_update_owe_info *owe_info,
8213 gfp_t gfp);
8214
8215/**
8216 * cfg80211_bss_flush - resets all the scan entries
8217 * @wiphy: the wiphy
8218 */
8219void cfg80211_bss_flush(struct wiphy *wiphy);
8220
8221#endif /* __NET_CFG80211_H */
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-2016 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_channel_flags - channel flags
72 *
73 * Channel flags set by the regulatory control code.
74 *
75 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
76 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
77 * sending probe requests or beaconing.
78 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
79 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
80 * is not permitted.
81 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
82 * is not permitted.
83 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
84 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
85 * this flag indicates that an 80 MHz channel cannot use this
86 * channel as the control or any of the secondary channels.
87 * This may be due to the driver or due to regulatory bandwidth
88 * restrictions.
89 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
90 * this flag indicates that an 160 MHz channel cannot use this
91 * channel as the control or any of the secondary channels.
92 * This may be due to the driver or due to regulatory bandwidth
93 * restrictions.
94 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
95 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
96 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
97 * on this channel.
98 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
99 * on this channel.
100 *
101 */
102enum ieee80211_channel_flags {
103 IEEE80211_CHAN_DISABLED = 1<<0,
104 IEEE80211_CHAN_NO_IR = 1<<1,
105 /* hole at 1<<2 */
106 IEEE80211_CHAN_RADAR = 1<<3,
107 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
108 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
109 IEEE80211_CHAN_NO_OFDM = 1<<6,
110 IEEE80211_CHAN_NO_80MHZ = 1<<7,
111 IEEE80211_CHAN_NO_160MHZ = 1<<8,
112 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
113 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
114 IEEE80211_CHAN_NO_20MHZ = 1<<11,
115 IEEE80211_CHAN_NO_10MHZ = 1<<12,
116};
117
118#define IEEE80211_CHAN_NO_HT40 \
119 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
120
121#define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
122#define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
123
124/**
125 * struct ieee80211_channel - channel definition
126 *
127 * This structure describes a single channel for use
128 * with cfg80211.
129 *
130 * @center_freq: center frequency in MHz
131 * @hw_value: hardware-specific value for the channel
132 * @flags: channel flags from &enum ieee80211_channel_flags.
133 * @orig_flags: channel flags at registration time, used by regulatory
134 * code to support devices with additional restrictions
135 * @band: band this channel belongs to.
136 * @max_antenna_gain: maximum antenna gain in dBi
137 * @max_power: maximum transmission power (in dBm)
138 * @max_reg_power: maximum regulatory transmission power (in dBm)
139 * @beacon_found: helper to regulatory code to indicate when a beacon
140 * has been found on this channel. Use regulatory_hint_found_beacon()
141 * to enable this, this is useful only on 5 GHz band.
142 * @orig_mag: internal use
143 * @orig_mpwr: internal use
144 * @dfs_state: current state of this channel. Only relevant if radar is required
145 * on this channel.
146 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
147 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
148 */
149struct ieee80211_channel {
150 enum nl80211_band band;
151 u16 center_freq;
152 u16 hw_value;
153 u32 flags;
154 int max_antenna_gain;
155 int max_power;
156 int max_reg_power;
157 bool beacon_found;
158 u32 orig_flags;
159 int orig_mag, orig_mpwr;
160 enum nl80211_dfs_state dfs_state;
161 unsigned long dfs_state_entered;
162 unsigned int dfs_cac_ms;
163};
164
165/**
166 * enum ieee80211_rate_flags - rate flags
167 *
168 * Hardware/specification flags for rates. These are structured
169 * in a way that allows using the same bitrate structure for
170 * different bands/PHY modes.
171 *
172 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
173 * preamble on this bitrate; only relevant in 2.4GHz band and
174 * with CCK rates.
175 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
176 * when used with 802.11a (on the 5 GHz band); filled by the
177 * core code when registering the wiphy.
178 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
179 * when used with 802.11b (on the 2.4 GHz band); filled by the
180 * core code when registering the wiphy.
181 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
182 * when used with 802.11g (on the 2.4 GHz band); filled by the
183 * core code when registering the wiphy.
184 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
185 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
186 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
187 */
188enum ieee80211_rate_flags {
189 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
190 IEEE80211_RATE_MANDATORY_A = 1<<1,
191 IEEE80211_RATE_MANDATORY_B = 1<<2,
192 IEEE80211_RATE_MANDATORY_G = 1<<3,
193 IEEE80211_RATE_ERP_G = 1<<4,
194 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
195 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
196};
197
198/**
199 * enum ieee80211_bss_type - BSS type filter
200 *
201 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
202 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
203 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
204 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
205 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
206 */
207enum ieee80211_bss_type {
208 IEEE80211_BSS_TYPE_ESS,
209 IEEE80211_BSS_TYPE_PBSS,
210 IEEE80211_BSS_TYPE_IBSS,
211 IEEE80211_BSS_TYPE_MBSS,
212 IEEE80211_BSS_TYPE_ANY
213};
214
215/**
216 * enum ieee80211_privacy - BSS privacy filter
217 *
218 * @IEEE80211_PRIVACY_ON: privacy bit set
219 * @IEEE80211_PRIVACY_OFF: privacy bit clear
220 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
221 */
222enum ieee80211_privacy {
223 IEEE80211_PRIVACY_ON,
224 IEEE80211_PRIVACY_OFF,
225 IEEE80211_PRIVACY_ANY
226};
227
228#define IEEE80211_PRIVACY(x) \
229 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
230
231/**
232 * struct ieee80211_rate - bitrate definition
233 *
234 * This structure describes a bitrate that an 802.11 PHY can
235 * operate with. The two values @hw_value and @hw_value_short
236 * are only for driver use when pointers to this structure are
237 * passed around.
238 *
239 * @flags: rate-specific flags
240 * @bitrate: bitrate in units of 100 Kbps
241 * @hw_value: driver/hardware value for this rate
242 * @hw_value_short: driver/hardware value for this rate when
243 * short preamble is used
244 */
245struct ieee80211_rate {
246 u32 flags;
247 u16 bitrate;
248 u16 hw_value, hw_value_short;
249};
250
251/**
252 * struct ieee80211_sta_ht_cap - STA's HT capabilities
253 *
254 * This structure describes most essential parameters needed
255 * to describe 802.11n HT capabilities for an STA.
256 *
257 * @ht_supported: is HT supported by the STA
258 * @cap: HT capabilities map as described in 802.11n spec
259 * @ampdu_factor: Maximum A-MPDU length factor
260 * @ampdu_density: Minimum A-MPDU spacing
261 * @mcs: Supported MCS rates
262 */
263struct ieee80211_sta_ht_cap {
264 u16 cap; /* use IEEE80211_HT_CAP_ */
265 bool ht_supported;
266 u8 ampdu_factor;
267 u8 ampdu_density;
268 struct ieee80211_mcs_info mcs;
269};
270
271/**
272 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
273 *
274 * This structure describes most essential parameters needed
275 * to describe 802.11ac VHT capabilities for an STA.
276 *
277 * @vht_supported: is VHT supported by the STA
278 * @cap: VHT capabilities map as described in 802.11ac spec
279 * @vht_mcs: Supported VHT MCS rates
280 */
281struct ieee80211_sta_vht_cap {
282 bool vht_supported;
283 u32 cap; /* use IEEE80211_VHT_CAP_ */
284 struct ieee80211_vht_mcs_info vht_mcs;
285};
286
287/**
288 * struct ieee80211_supported_band - frequency band definition
289 *
290 * This structure describes a frequency band a wiphy
291 * is able to operate in.
292 *
293 * @channels: Array of channels the hardware can operate in
294 * in this band.
295 * @band: the band this structure represents
296 * @n_channels: Number of channels in @channels
297 * @bitrates: Array of bitrates the hardware can operate with
298 * in this band. Must be sorted to give a valid "supported
299 * rates" IE, i.e. CCK rates first, then OFDM.
300 * @n_bitrates: Number of bitrates in @bitrates
301 * @ht_cap: HT capabilities in this band
302 * @vht_cap: VHT capabilities in this band
303 */
304struct ieee80211_supported_band {
305 struct ieee80211_channel *channels;
306 struct ieee80211_rate *bitrates;
307 enum nl80211_band band;
308 int n_channels;
309 int n_bitrates;
310 struct ieee80211_sta_ht_cap ht_cap;
311 struct ieee80211_sta_vht_cap vht_cap;
312};
313
314/*
315 * Wireless hardware/device configuration structures and methods
316 */
317
318/**
319 * DOC: Actions and configuration
320 *
321 * Each wireless device and each virtual interface offer a set of configuration
322 * operations and other actions that are invoked by userspace. Each of these
323 * actions is described in the operations structure, and the parameters these
324 * operations use are described separately.
325 *
326 * Additionally, some operations are asynchronous and expect to get status
327 * information via some functions that drivers need to call.
328 *
329 * Scanning and BSS list handling with its associated functionality is described
330 * in a separate chapter.
331 */
332
333#define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
334 WLAN_USER_POSITION_LEN)
335
336/**
337 * struct vif_params - describes virtual interface parameters
338 * @use_4addr: use 4-address frames
339 * @macaddr: address to use for this virtual interface.
340 * If this parameter is set to zero address the driver may
341 * determine the address as needed.
342 * This feature is only fully supported by drivers that enable the
343 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
344 ** only p2p devices with specified MAC.
345 * @vht_mumimo_groups: MU-MIMO groupID. used for monitoring only
346 * packets belonging to that MU-MIMO groupID.
347 */
348struct vif_params {
349 int use_4addr;
350 u8 macaddr[ETH_ALEN];
351 u8 vht_mumimo_groups[VHT_MUMIMO_GROUPS_DATA_LEN];
352};
353
354/**
355 * struct key_params - key information
356 *
357 * Information about a key
358 *
359 * @key: key material
360 * @key_len: length of key material
361 * @cipher: cipher suite selector
362 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
363 * with the get_key() callback, must be in little endian,
364 * length given by @seq_len.
365 * @seq_len: length of @seq.
366 */
367struct key_params {
368 const u8 *key;
369 const u8 *seq;
370 int key_len;
371 int seq_len;
372 u32 cipher;
373};
374
375/**
376 * struct cfg80211_chan_def - channel definition
377 * @chan: the (control) channel
378 * @width: channel width
379 * @center_freq1: center frequency of first segment
380 * @center_freq2: center frequency of second segment
381 * (only with 80+80 MHz)
382 */
383struct cfg80211_chan_def {
384 struct ieee80211_channel *chan;
385 enum nl80211_chan_width width;
386 u32 center_freq1;
387 u32 center_freq2;
388};
389
390/**
391 * cfg80211_get_chandef_type - return old channel type from chandef
392 * @chandef: the channel definition
393 *
394 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
395 * chandef, which must have a bandwidth allowing this conversion.
396 */
397static inline enum nl80211_channel_type
398cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
399{
400 switch (chandef->width) {
401 case NL80211_CHAN_WIDTH_20_NOHT:
402 return NL80211_CHAN_NO_HT;
403 case NL80211_CHAN_WIDTH_20:
404 return NL80211_CHAN_HT20;
405 case NL80211_CHAN_WIDTH_40:
406 if (chandef->center_freq1 > chandef->chan->center_freq)
407 return NL80211_CHAN_HT40PLUS;
408 return NL80211_CHAN_HT40MINUS;
409 default:
410 WARN_ON(1);
411 return NL80211_CHAN_NO_HT;
412 }
413}
414
415/**
416 * cfg80211_chandef_create - create channel definition using channel type
417 * @chandef: the channel definition struct to fill
418 * @channel: the control channel
419 * @chantype: the channel type
420 *
421 * Given a channel type, create a channel definition.
422 */
423void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
424 struct ieee80211_channel *channel,
425 enum nl80211_channel_type chantype);
426
427/**
428 * cfg80211_chandef_identical - check if two channel definitions are identical
429 * @chandef1: first channel definition
430 * @chandef2: second channel definition
431 *
432 * Return: %true if the channels defined by the channel definitions are
433 * identical, %false otherwise.
434 */
435static inline bool
436cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
437 const struct cfg80211_chan_def *chandef2)
438{
439 return (chandef1->chan == chandef2->chan &&
440 chandef1->width == chandef2->width &&
441 chandef1->center_freq1 == chandef2->center_freq1 &&
442 chandef1->center_freq2 == chandef2->center_freq2);
443}
444
445/**
446 * cfg80211_chandef_compatible - check if two channel definitions are compatible
447 * @chandef1: first channel definition
448 * @chandef2: second channel definition
449 *
450 * Return: %NULL if the given channel definitions are incompatible,
451 * chandef1 or chandef2 otherwise.
452 */
453const struct cfg80211_chan_def *
454cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
455 const struct cfg80211_chan_def *chandef2);
456
457/**
458 * cfg80211_chandef_valid - check if a channel definition is valid
459 * @chandef: the channel definition to check
460 * Return: %true if the channel definition is valid. %false otherwise.
461 */
462bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
463
464/**
465 * cfg80211_chandef_usable - check if secondary channels can be used
466 * @wiphy: the wiphy to validate against
467 * @chandef: the channel definition to check
468 * @prohibited_flags: the regulatory channel flags that must not be set
469 * Return: %true if secondary channels are usable. %false otherwise.
470 */
471bool cfg80211_chandef_usable(struct wiphy *wiphy,
472 const struct cfg80211_chan_def *chandef,
473 u32 prohibited_flags);
474
475/**
476 * cfg80211_chandef_dfs_required - checks if radar detection is required
477 * @wiphy: the wiphy to validate against
478 * @chandef: the channel definition to check
479 * @iftype: the interface type as specified in &enum nl80211_iftype
480 * Returns:
481 * 1 if radar detection is required, 0 if it is not, < 0 on error
482 */
483int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
484 const struct cfg80211_chan_def *chandef,
485 enum nl80211_iftype iftype);
486
487/**
488 * ieee80211_chandef_rate_flags - returns rate flags for a channel
489 *
490 * In some channel types, not all rates may be used - for example CCK
491 * rates may not be used in 5/10 MHz channels.
492 *
493 * @chandef: channel definition for the channel
494 *
495 * Returns: rate flags which apply for this channel
496 */
497static inline enum ieee80211_rate_flags
498ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
499{
500 switch (chandef->width) {
501 case NL80211_CHAN_WIDTH_5:
502 return IEEE80211_RATE_SUPPORTS_5MHZ;
503 case NL80211_CHAN_WIDTH_10:
504 return IEEE80211_RATE_SUPPORTS_10MHZ;
505 default:
506 break;
507 }
508 return 0;
509}
510
511/**
512 * ieee80211_chandef_max_power - maximum transmission power for the chandef
513 *
514 * In some regulations, the transmit power may depend on the configured channel
515 * bandwidth which may be defined as dBm/MHz. This function returns the actual
516 * max_power for non-standard (20 MHz) channels.
517 *
518 * @chandef: channel definition for the channel
519 *
520 * Returns: maximum allowed transmission power in dBm for the chandef
521 */
522static inline int
523ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
524{
525 switch (chandef->width) {
526 case NL80211_CHAN_WIDTH_5:
527 return min(chandef->chan->max_reg_power - 6,
528 chandef->chan->max_power);
529 case NL80211_CHAN_WIDTH_10:
530 return min(chandef->chan->max_reg_power - 3,
531 chandef->chan->max_power);
532 default:
533 break;
534 }
535 return chandef->chan->max_power;
536}
537
538/**
539 * enum survey_info_flags - survey information flags
540 *
541 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
542 * @SURVEY_INFO_IN_USE: channel is currently being used
543 * @SURVEY_INFO_TIME: active time (in ms) was filled in
544 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
545 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
546 * @SURVEY_INFO_TIME_RX: receive time was filled in
547 * @SURVEY_INFO_TIME_TX: transmit time was filled in
548 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
549 *
550 * Used by the driver to indicate which info in &struct survey_info
551 * it has filled in during the get_survey().
552 */
553enum survey_info_flags {
554 SURVEY_INFO_NOISE_DBM = BIT(0),
555 SURVEY_INFO_IN_USE = BIT(1),
556 SURVEY_INFO_TIME = BIT(2),
557 SURVEY_INFO_TIME_BUSY = BIT(3),
558 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
559 SURVEY_INFO_TIME_RX = BIT(5),
560 SURVEY_INFO_TIME_TX = BIT(6),
561 SURVEY_INFO_TIME_SCAN = BIT(7),
562};
563
564/**
565 * struct survey_info - channel survey response
566 *
567 * @channel: the channel this survey record reports, may be %NULL for a single
568 * record to report global statistics
569 * @filled: bitflag of flags from &enum survey_info_flags
570 * @noise: channel noise in dBm. This and all following fields are
571 * optional
572 * @time: amount of time in ms the radio was turn on (on the channel)
573 * @time_busy: amount of time the primary channel was sensed busy
574 * @time_ext_busy: amount of time the extension channel was sensed busy
575 * @time_rx: amount of time the radio spent receiving data
576 * @time_tx: amount of time the radio spent transmitting data
577 * @time_scan: amount of time the radio spent for scanning
578 *
579 * Used by dump_survey() to report back per-channel survey information.
580 *
581 * This structure can later be expanded with things like
582 * channel duty cycle etc.
583 */
584struct survey_info {
585 struct ieee80211_channel *channel;
586 u64 time;
587 u64 time_busy;
588 u64 time_ext_busy;
589 u64 time_rx;
590 u64 time_tx;
591 u64 time_scan;
592 u32 filled;
593 s8 noise;
594};
595
596#define CFG80211_MAX_WEP_KEYS 4
597
598/**
599 * struct cfg80211_crypto_settings - Crypto settings
600 * @wpa_versions: indicates which, if any, WPA versions are enabled
601 * (from enum nl80211_wpa_versions)
602 * @cipher_group: group key cipher suite (or 0 if unset)
603 * @n_ciphers_pairwise: number of AP supported unicast ciphers
604 * @ciphers_pairwise: unicast key cipher suites
605 * @n_akm_suites: number of AKM suites
606 * @akm_suites: AKM suites
607 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
608 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
609 * required to assume that the port is unauthorized until authorized by
610 * user space. Otherwise, port is marked authorized by default.
611 * @control_port_ethertype: the control port protocol that should be
612 * allowed through even on unauthorized ports
613 * @control_port_no_encrypt: TRUE to prevent encryption of control port
614 * protocol frames.
615 * @wep_keys: static WEP keys, if not NULL points to an array of
616 * CFG80211_MAX_WEP_KEYS WEP keys
617 * @wep_tx_key: key index (0..3) of the default TX static WEP key
618 */
619struct cfg80211_crypto_settings {
620 u32 wpa_versions;
621 u32 cipher_group;
622 int n_ciphers_pairwise;
623 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
624 int n_akm_suites;
625 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
626 bool control_port;
627 __be16 control_port_ethertype;
628 bool control_port_no_encrypt;
629 struct key_params *wep_keys;
630 int wep_tx_key;
631};
632
633/**
634 * struct cfg80211_beacon_data - beacon data
635 * @head: head portion of beacon (before TIM IE)
636 * or %NULL if not changed
637 * @tail: tail portion of beacon (after TIM IE)
638 * or %NULL if not changed
639 * @head_len: length of @head
640 * @tail_len: length of @tail
641 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
642 * @beacon_ies_len: length of beacon_ies in octets
643 * @proberesp_ies: extra information element(s) to add into Probe Response
644 * frames or %NULL
645 * @proberesp_ies_len: length of proberesp_ies in octets
646 * @assocresp_ies: extra information element(s) to add into (Re)Association
647 * Response frames or %NULL
648 * @assocresp_ies_len: length of assocresp_ies in octets
649 * @probe_resp_len: length of probe response template (@probe_resp)
650 * @probe_resp: probe response template (AP mode only)
651 */
652struct cfg80211_beacon_data {
653 const u8 *head, *tail;
654 const u8 *beacon_ies;
655 const u8 *proberesp_ies;
656 const u8 *assocresp_ies;
657 const u8 *probe_resp;
658
659 size_t head_len, tail_len;
660 size_t beacon_ies_len;
661 size_t proberesp_ies_len;
662 size_t assocresp_ies_len;
663 size_t probe_resp_len;
664};
665
666struct mac_address {
667 u8 addr[ETH_ALEN];
668};
669
670/**
671 * struct cfg80211_acl_data - Access control list data
672 *
673 * @acl_policy: ACL policy to be applied on the station's
674 * entry specified by mac_addr
675 * @n_acl_entries: Number of MAC address entries passed
676 * @mac_addrs: List of MAC addresses of stations to be used for ACL
677 */
678struct cfg80211_acl_data {
679 enum nl80211_acl_policy acl_policy;
680 int n_acl_entries;
681
682 /* Keep it last */
683 struct mac_address mac_addrs[];
684};
685
686/*
687 * cfg80211_bitrate_mask - masks for bitrate control
688 */
689struct cfg80211_bitrate_mask {
690 struct {
691 u32 legacy;
692 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
693 u16 vht_mcs[NL80211_VHT_NSS_MAX];
694 enum nl80211_txrate_gi gi;
695 } control[NUM_NL80211_BANDS];
696};
697
698/**
699 * struct cfg80211_ap_settings - AP configuration
700 *
701 * Used to configure an AP interface.
702 *
703 * @chandef: defines the channel to use
704 * @beacon: beacon data
705 * @beacon_interval: beacon interval
706 * @dtim_period: DTIM period
707 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
708 * user space)
709 * @ssid_len: length of @ssid
710 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
711 * @crypto: crypto settings
712 * @privacy: the BSS uses privacy
713 * @auth_type: Authentication type (algorithm)
714 * @smps_mode: SMPS mode
715 * @inactivity_timeout: time in seconds to determine station's inactivity.
716 * @p2p_ctwindow: P2P CT Window
717 * @p2p_opp_ps: P2P opportunistic PS
718 * @acl: ACL configuration used by the drivers which has support for
719 * MAC address based access control
720 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
721 * networks.
722 * @beacon_rate: bitrate to be used for beacons
723 */
724struct cfg80211_ap_settings {
725 struct cfg80211_chan_def chandef;
726
727 struct cfg80211_beacon_data beacon;
728
729 int beacon_interval, dtim_period;
730 const u8 *ssid;
731 size_t ssid_len;
732 enum nl80211_hidden_ssid hidden_ssid;
733 struct cfg80211_crypto_settings crypto;
734 bool privacy;
735 enum nl80211_auth_type auth_type;
736 enum nl80211_smps_mode smps_mode;
737 int inactivity_timeout;
738 u8 p2p_ctwindow;
739 bool p2p_opp_ps;
740 const struct cfg80211_acl_data *acl;
741 bool pbss;
742 struct cfg80211_bitrate_mask beacon_rate;
743};
744
745/**
746 * struct cfg80211_csa_settings - channel switch settings
747 *
748 * Used for channel switch
749 *
750 * @chandef: defines the channel to use after the switch
751 * @beacon_csa: beacon data while performing the switch
752 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
753 * @counter_offsets_presp: offsets of the counters within the probe response
754 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
755 * @n_counter_offsets_presp: number of csa counters in the probe response
756 * @beacon_after: beacon data to be used on the new channel
757 * @radar_required: whether radar detection is required on the new channel
758 * @block_tx: whether transmissions should be blocked while changing
759 * @count: number of beacons until switch
760 */
761struct cfg80211_csa_settings {
762 struct cfg80211_chan_def chandef;
763 struct cfg80211_beacon_data beacon_csa;
764 const u16 *counter_offsets_beacon;
765 const u16 *counter_offsets_presp;
766 unsigned int n_counter_offsets_beacon;
767 unsigned int n_counter_offsets_presp;
768 struct cfg80211_beacon_data beacon_after;
769 bool radar_required;
770 bool block_tx;
771 u8 count;
772};
773
774/**
775 * struct iface_combination_params - input parameters for interface combinations
776 *
777 * Used to pass interface combination parameters
778 *
779 * @num_different_channels: the number of different channels we want
780 * to use for verification
781 * @radar_detect: a bitmap where each bit corresponds to a channel
782 * width where radar detection is needed, as in the definition of
783 * &struct ieee80211_iface_combination.@radar_detect_widths
784 * @iftype_num: array with the number of interfaces of each interface
785 * type. The index is the interface type as specified in &enum
786 * nl80211_iftype.
787 * @new_beacon_int: set this to the beacon interval of a new interface
788 * that's not operating yet, if such is to be checked as part of
789 * the verification
790 */
791struct iface_combination_params {
792 int num_different_channels;
793 u8 radar_detect;
794 int iftype_num[NUM_NL80211_IFTYPES];
795 u32 new_beacon_int;
796};
797
798/**
799 * enum station_parameters_apply_mask - station parameter values to apply
800 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
801 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
802 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
803 *
804 * Not all station parameters have in-band "no change" signalling,
805 * for those that don't these flags will are used.
806 */
807enum station_parameters_apply_mask {
808 STATION_PARAM_APPLY_UAPSD = BIT(0),
809 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
810 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
811};
812
813/**
814 * struct station_parameters - station parameters
815 *
816 * Used to change and create a new station.
817 *
818 * @vlan: vlan interface station should belong to
819 * @supported_rates: supported rates in IEEE 802.11 format
820 * (or NULL for no change)
821 * @supported_rates_len: number of supported rates
822 * @sta_flags_mask: station flags that changed
823 * (bitmask of BIT(%NL80211_STA_FLAG_...))
824 * @sta_flags_set: station flags values
825 * (bitmask of BIT(%NL80211_STA_FLAG_...))
826 * @listen_interval: listen interval or -1 for no change
827 * @aid: AID or zero for no change
828 * @peer_aid: mesh peer AID or zero for no change
829 * @plink_action: plink action to take
830 * @plink_state: set the peer link state for a station
831 * @ht_capa: HT capabilities of station
832 * @vht_capa: VHT capabilities of station
833 * @uapsd_queues: bitmap of queues configured for uapsd. same format
834 * as the AC bitmap in the QoS info field
835 * @max_sp: max Service Period. same format as the MAX_SP in the
836 * QoS info field (but already shifted down)
837 * @sta_modify_mask: bitmap indicating which parameters changed
838 * (for those that don't have a natural "no change" value),
839 * see &enum station_parameters_apply_mask
840 * @local_pm: local link-specific mesh power save mode (no change when set
841 * to unknown)
842 * @capability: station capability
843 * @ext_capab: extended capabilities of the station
844 * @ext_capab_len: number of extended capabilities
845 * @supported_channels: supported channels in IEEE 802.11 format
846 * @supported_channels_len: number of supported channels
847 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
848 * @supported_oper_classes_len: number of supported operating classes
849 * @opmode_notif: operating mode field from Operating Mode Notification
850 * @opmode_notif_used: information if operating mode field is used
851 * @support_p2p_ps: information if station supports P2P PS mechanism
852 */
853struct station_parameters {
854 const u8 *supported_rates;
855 struct net_device *vlan;
856 u32 sta_flags_mask, sta_flags_set;
857 u32 sta_modify_mask;
858 int listen_interval;
859 u16 aid;
860 u16 peer_aid;
861 u8 supported_rates_len;
862 u8 plink_action;
863 u8 plink_state;
864 const struct ieee80211_ht_cap *ht_capa;
865 const struct ieee80211_vht_cap *vht_capa;
866 u8 uapsd_queues;
867 u8 max_sp;
868 enum nl80211_mesh_power_mode local_pm;
869 u16 capability;
870 const u8 *ext_capab;
871 u8 ext_capab_len;
872 const u8 *supported_channels;
873 u8 supported_channels_len;
874 const u8 *supported_oper_classes;
875 u8 supported_oper_classes_len;
876 u8 opmode_notif;
877 bool opmode_notif_used;
878 int support_p2p_ps;
879};
880
881/**
882 * struct station_del_parameters - station deletion parameters
883 *
884 * Used to delete a station entry (or all stations).
885 *
886 * @mac: MAC address of the station to remove or NULL to remove all stations
887 * @subtype: Management frame subtype to use for indicating removal
888 * (10 = Disassociation, 12 = Deauthentication)
889 * @reason_code: Reason code for the Disassociation/Deauthentication frame
890 */
891struct station_del_parameters {
892 const u8 *mac;
893 u8 subtype;
894 u16 reason_code;
895};
896
897/**
898 * enum cfg80211_station_type - the type of station being modified
899 * @CFG80211_STA_AP_CLIENT: client of an AP interface
900 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
901 * unassociated (update properties for this type of client is permitted)
902 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
903 * the AP MLME in the device
904 * @CFG80211_STA_AP_STA: AP station on managed interface
905 * @CFG80211_STA_IBSS: IBSS station
906 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
907 * while TDLS setup is in progress, it moves out of this state when
908 * being marked authorized; use this only if TDLS with external setup is
909 * supported/used)
910 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
911 * entry that is operating, has been marked authorized by userspace)
912 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
913 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
914 */
915enum cfg80211_station_type {
916 CFG80211_STA_AP_CLIENT,
917 CFG80211_STA_AP_CLIENT_UNASSOC,
918 CFG80211_STA_AP_MLME_CLIENT,
919 CFG80211_STA_AP_STA,
920 CFG80211_STA_IBSS,
921 CFG80211_STA_TDLS_PEER_SETUP,
922 CFG80211_STA_TDLS_PEER_ACTIVE,
923 CFG80211_STA_MESH_PEER_KERNEL,
924 CFG80211_STA_MESH_PEER_USER,
925};
926
927/**
928 * cfg80211_check_station_change - validate parameter changes
929 * @wiphy: the wiphy this operates on
930 * @params: the new parameters for a station
931 * @statype: the type of station being modified
932 *
933 * Utility function for the @change_station driver method. Call this function
934 * with the appropriate station type looking up the station (and checking that
935 * it exists). It will verify whether the station change is acceptable, and if
936 * not will return an error code. Note that it may modify the parameters for
937 * backward compatibility reasons, so don't use them before calling this.
938 */
939int cfg80211_check_station_change(struct wiphy *wiphy,
940 struct station_parameters *params,
941 enum cfg80211_station_type statype);
942
943/**
944 * enum station_info_rate_flags - bitrate info flags
945 *
946 * Used by the driver to indicate the specific rate transmission
947 * type for 802.11n transmissions.
948 *
949 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
950 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
951 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
952 * @RATE_INFO_FLAGS_60G: 60GHz MCS
953 */
954enum rate_info_flags {
955 RATE_INFO_FLAGS_MCS = BIT(0),
956 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
957 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
958 RATE_INFO_FLAGS_60G = BIT(3),
959};
960
961/**
962 * enum rate_info_bw - rate bandwidth information
963 *
964 * Used by the driver to indicate the rate bandwidth.
965 *
966 * @RATE_INFO_BW_5: 5 MHz bandwidth
967 * @RATE_INFO_BW_10: 10 MHz bandwidth
968 * @RATE_INFO_BW_20: 20 MHz bandwidth
969 * @RATE_INFO_BW_40: 40 MHz bandwidth
970 * @RATE_INFO_BW_80: 80 MHz bandwidth
971 * @RATE_INFO_BW_160: 160 MHz bandwidth
972 */
973enum rate_info_bw {
974 RATE_INFO_BW_5,
975 RATE_INFO_BW_10,
976 RATE_INFO_BW_20,
977 RATE_INFO_BW_40,
978 RATE_INFO_BW_80,
979 RATE_INFO_BW_160,
980};
981
982/**
983 * struct rate_info - bitrate information
984 *
985 * Information about a receiving or transmitting bitrate
986 *
987 * @flags: bitflag of flags from &enum rate_info_flags
988 * @mcs: mcs index if struct describes a 802.11n bitrate
989 * @legacy: bitrate in 100kbit/s for 802.11abg
990 * @nss: number of streams (VHT only)
991 * @bw: bandwidth (from &enum rate_info_bw)
992 */
993struct rate_info {
994 u8 flags;
995 u8 mcs;
996 u16 legacy;
997 u8 nss;
998 u8 bw;
999};
1000
1001/**
1002 * enum station_info_rate_flags - bitrate info flags
1003 *
1004 * Used by the driver to indicate the specific rate transmission
1005 * type for 802.11n transmissions.
1006 *
1007 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1008 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1009 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1010 */
1011enum bss_param_flags {
1012 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1013 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1014 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1015};
1016
1017/**
1018 * struct sta_bss_parameters - BSS parameters for the attached station
1019 *
1020 * Information about the currently associated BSS
1021 *
1022 * @flags: bitflag of flags from &enum bss_param_flags
1023 * @dtim_period: DTIM period for the BSS
1024 * @beacon_interval: beacon interval
1025 */
1026struct sta_bss_parameters {
1027 u8 flags;
1028 u8 dtim_period;
1029 u16 beacon_interval;
1030};
1031
1032/**
1033 * struct cfg80211_tid_stats - per-TID statistics
1034 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1035 * indicate the relevant values in this struct are filled
1036 * @rx_msdu: number of received MSDUs
1037 * @tx_msdu: number of (attempted) transmitted MSDUs
1038 * @tx_msdu_retries: number of retries (not counting the first) for
1039 * transmitted MSDUs
1040 * @tx_msdu_failed: number of failed transmitted MSDUs
1041 */
1042struct cfg80211_tid_stats {
1043 u32 filled;
1044 u64 rx_msdu;
1045 u64 tx_msdu;
1046 u64 tx_msdu_retries;
1047 u64 tx_msdu_failed;
1048};
1049
1050#define IEEE80211_MAX_CHAINS 4
1051
1052/**
1053 * struct station_info - station information
1054 *
1055 * Station information filled by driver for get_station() and dump_station.
1056 *
1057 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1058 * indicate the relevant values in this struct for them
1059 * @connected_time: time(in secs) since a station is last connected
1060 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1061 * @rx_bytes: bytes (size of MPDUs) received from this station
1062 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1063 * @llid: mesh local link id
1064 * @plid: mesh peer link id
1065 * @plink_state: mesh peer link state
1066 * @signal: The signal strength, type depends on the wiphy's signal_type.
1067 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1068 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1069 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1070 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1071 * @chain_signal: per-chain signal strength of last received packet in dBm
1072 * @chain_signal_avg: per-chain signal strength average in dBm
1073 * @txrate: current unicast bitrate from this station
1074 * @rxrate: current unicast bitrate to this station
1075 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1076 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1077 * @tx_retries: cumulative retry counts (MPDUs)
1078 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1079 * @rx_dropped_misc: Dropped for un-specified reason.
1080 * @bss_param: current BSS parameters
1081 * @generation: generation number for nl80211 dumps.
1082 * This number should increase every time the list of stations
1083 * changes, i.e. when a station is added or removed, so that
1084 * userspace can tell whether it got a consistent snapshot.
1085 * @assoc_req_ies: IEs from (Re)Association Request.
1086 * This is used only when in AP mode with drivers that do not use
1087 * user space MLME/SME implementation. The information is provided for
1088 * the cfg80211_new_sta() calls to notify user space of the IEs.
1089 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1090 * @sta_flags: station flags mask & values
1091 * @beacon_loss_count: Number of times beacon loss event has triggered.
1092 * @t_offset: Time offset of the station relative to this host.
1093 * @local_pm: local mesh STA power save mode
1094 * @peer_pm: peer mesh STA power save mode
1095 * @nonpeer_pm: non-peer mesh STA power save mode
1096 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1097 * towards this station.
1098 * @rx_beacon: number of beacons received from this peer
1099 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1100 * from this peer
1101 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1102 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1103 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1104 */
1105struct station_info {
1106 u64 filled;
1107 u32 connected_time;
1108 u32 inactive_time;
1109 u64 rx_bytes;
1110 u64 tx_bytes;
1111 u16 llid;
1112 u16 plid;
1113 u8 plink_state;
1114 s8 signal;
1115 s8 signal_avg;
1116
1117 u8 chains;
1118 s8 chain_signal[IEEE80211_MAX_CHAINS];
1119 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1120
1121 struct rate_info txrate;
1122 struct rate_info rxrate;
1123 u32 rx_packets;
1124 u32 tx_packets;
1125 u32 tx_retries;
1126 u32 tx_failed;
1127 u32 rx_dropped_misc;
1128 struct sta_bss_parameters bss_param;
1129 struct nl80211_sta_flag_update sta_flags;
1130
1131 int generation;
1132
1133 const u8 *assoc_req_ies;
1134 size_t assoc_req_ies_len;
1135
1136 u32 beacon_loss_count;
1137 s64 t_offset;
1138 enum nl80211_mesh_power_mode local_pm;
1139 enum nl80211_mesh_power_mode peer_pm;
1140 enum nl80211_mesh_power_mode nonpeer_pm;
1141
1142 u32 expected_throughput;
1143
1144 u64 rx_beacon;
1145 u64 rx_duration;
1146 u8 rx_beacon_signal_avg;
1147 struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1148};
1149
1150#if IS_ENABLED(CONFIG_CFG80211)
1151/**
1152 * cfg80211_get_station - retrieve information about a given station
1153 * @dev: the device where the station is supposed to be connected to
1154 * @mac_addr: the mac address of the station of interest
1155 * @sinfo: pointer to the structure to fill with the information
1156 *
1157 * Returns 0 on success and sinfo is filled with the available information
1158 * otherwise returns a negative error code and the content of sinfo has to be
1159 * considered undefined.
1160 */
1161int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1162 struct station_info *sinfo);
1163#else
1164static inline int cfg80211_get_station(struct net_device *dev,
1165 const u8 *mac_addr,
1166 struct station_info *sinfo)
1167{
1168 return -ENOENT;
1169}
1170#endif
1171
1172/**
1173 * enum monitor_flags - monitor flags
1174 *
1175 * Monitor interface configuration flags. Note that these must be the bits
1176 * according to the nl80211 flags.
1177 *
1178 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1179 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1180 * @MONITOR_FLAG_CONTROL: pass control frames
1181 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1182 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1183 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1184 */
1185enum monitor_flags {
1186 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1187 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1188 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1189 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1190 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1191 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1192};
1193
1194/**
1195 * enum mpath_info_flags - mesh path information flags
1196 *
1197 * Used by the driver to indicate which info in &struct mpath_info it has filled
1198 * in during get_station() or dump_station().
1199 *
1200 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1201 * @MPATH_INFO_SN: @sn filled
1202 * @MPATH_INFO_METRIC: @metric filled
1203 * @MPATH_INFO_EXPTIME: @exptime filled
1204 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1205 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1206 * @MPATH_INFO_FLAGS: @flags filled
1207 */
1208enum mpath_info_flags {
1209 MPATH_INFO_FRAME_QLEN = BIT(0),
1210 MPATH_INFO_SN = BIT(1),
1211 MPATH_INFO_METRIC = BIT(2),
1212 MPATH_INFO_EXPTIME = BIT(3),
1213 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1214 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1215 MPATH_INFO_FLAGS = BIT(6),
1216};
1217
1218/**
1219 * struct mpath_info - mesh path information
1220 *
1221 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1222 *
1223 * @filled: bitfield of flags from &enum mpath_info_flags
1224 * @frame_qlen: number of queued frames for this destination
1225 * @sn: target sequence number
1226 * @metric: metric (cost) of this mesh path
1227 * @exptime: expiration time for the mesh path from now, in msecs
1228 * @flags: mesh path flags
1229 * @discovery_timeout: total mesh path discovery timeout, in msecs
1230 * @discovery_retries: mesh path discovery retries
1231 * @generation: generation number for nl80211 dumps.
1232 * This number should increase every time the list of mesh paths
1233 * changes, i.e. when a station is added or removed, so that
1234 * userspace can tell whether it got a consistent snapshot.
1235 */
1236struct mpath_info {
1237 u32 filled;
1238 u32 frame_qlen;
1239 u32 sn;
1240 u32 metric;
1241 u32 exptime;
1242 u32 discovery_timeout;
1243 u8 discovery_retries;
1244 u8 flags;
1245
1246 int generation;
1247};
1248
1249/**
1250 * struct bss_parameters - BSS parameters
1251 *
1252 * Used to change BSS parameters (mainly for AP mode).
1253 *
1254 * @use_cts_prot: Whether to use CTS protection
1255 * (0 = no, 1 = yes, -1 = do not change)
1256 * @use_short_preamble: Whether the use of short preambles is allowed
1257 * (0 = no, 1 = yes, -1 = do not change)
1258 * @use_short_slot_time: Whether the use of short slot time is allowed
1259 * (0 = no, 1 = yes, -1 = do not change)
1260 * @basic_rates: basic rates in IEEE 802.11 format
1261 * (or NULL for no change)
1262 * @basic_rates_len: number of basic rates
1263 * @ap_isolate: do not forward packets between connected stations
1264 * @ht_opmode: HT Operation mode
1265 * (u16 = opmode, -1 = do not change)
1266 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1267 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1268 */
1269struct bss_parameters {
1270 int use_cts_prot;
1271 int use_short_preamble;
1272 int use_short_slot_time;
1273 const u8 *basic_rates;
1274 u8 basic_rates_len;
1275 int ap_isolate;
1276 int ht_opmode;
1277 s8 p2p_ctwindow, p2p_opp_ps;
1278};
1279
1280/**
1281 * struct mesh_config - 802.11s mesh configuration
1282 *
1283 * These parameters can be changed while the mesh is active.
1284 *
1285 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1286 * by the Mesh Peering Open message
1287 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1288 * used by the Mesh Peering Open message
1289 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1290 * the mesh peering management to close a mesh peering
1291 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1292 * mesh interface
1293 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1294 * be sent to establish a new peer link instance in a mesh
1295 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1296 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1297 * elements
1298 * @auto_open_plinks: whether we should automatically open peer links when we
1299 * detect compatible mesh peers
1300 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1301 * synchronize to for 11s default synchronization method
1302 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1303 * that an originator mesh STA can send to a particular path target
1304 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1305 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1306 * a path discovery in milliseconds
1307 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1308 * receiving a PREQ shall consider the forwarding information from the
1309 * root to be valid. (TU = time unit)
1310 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1311 * which a mesh STA can send only one action frame containing a PREQ
1312 * element
1313 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1314 * which a mesh STA can send only one Action frame containing a PERR
1315 * element
1316 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1317 * it takes for an HWMP information element to propagate across the mesh
1318 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1319 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1320 * announcements are transmitted
1321 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1322 * station has access to a broader network beyond the MBSS. (This is
1323 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1324 * only means that the station will announce others it's a mesh gate, but
1325 * not necessarily using the gate announcement protocol. Still keeping the
1326 * same nomenclature to be in sync with the spec)
1327 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1328 * entity (default is TRUE - forwarding entity)
1329 * @rssi_threshold: the threshold for average signal strength of candidate
1330 * station to establish a peer link
1331 * @ht_opmode: mesh HT protection mode
1332 *
1333 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1334 * receiving a proactive PREQ shall consider the forwarding information to
1335 * the root mesh STA to be valid.
1336 *
1337 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1338 * PREQs are transmitted.
1339 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1340 * during which a mesh STA can send only one Action frame containing
1341 * a PREQ element for root path confirmation.
1342 * @power_mode: The default mesh power save mode which will be the initial
1343 * setting for new peer links.
1344 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1345 * after transmitting its beacon.
1346 * @plink_timeout: If no tx activity is seen from a STA we've established
1347 * peering with for longer than this time (in seconds), then remove it
1348 * from the STA's list of peers. Default is 30 minutes.
1349 */
1350struct mesh_config {
1351 u16 dot11MeshRetryTimeout;
1352 u16 dot11MeshConfirmTimeout;
1353 u16 dot11MeshHoldingTimeout;
1354 u16 dot11MeshMaxPeerLinks;
1355 u8 dot11MeshMaxRetries;
1356 u8 dot11MeshTTL;
1357 u8 element_ttl;
1358 bool auto_open_plinks;
1359 u32 dot11MeshNbrOffsetMaxNeighbor;
1360 u8 dot11MeshHWMPmaxPREQretries;
1361 u32 path_refresh_time;
1362 u16 min_discovery_timeout;
1363 u32 dot11MeshHWMPactivePathTimeout;
1364 u16 dot11MeshHWMPpreqMinInterval;
1365 u16 dot11MeshHWMPperrMinInterval;
1366 u16 dot11MeshHWMPnetDiameterTraversalTime;
1367 u8 dot11MeshHWMPRootMode;
1368 u16 dot11MeshHWMPRannInterval;
1369 bool dot11MeshGateAnnouncementProtocol;
1370 bool dot11MeshForwarding;
1371 s32 rssi_threshold;
1372 u16 ht_opmode;
1373 u32 dot11MeshHWMPactivePathToRootTimeout;
1374 u16 dot11MeshHWMProotInterval;
1375 u16 dot11MeshHWMPconfirmationInterval;
1376 enum nl80211_mesh_power_mode power_mode;
1377 u16 dot11MeshAwakeWindowDuration;
1378 u32 plink_timeout;
1379};
1380
1381/**
1382 * struct mesh_setup - 802.11s mesh setup configuration
1383 * @chandef: defines the channel to use
1384 * @mesh_id: the mesh ID
1385 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1386 * @sync_method: which synchronization method to use
1387 * @path_sel_proto: which path selection protocol to use
1388 * @path_metric: which metric to use
1389 * @auth_id: which authentication method this mesh is using
1390 * @ie: vendor information elements (optional)
1391 * @ie_len: length of vendor information elements
1392 * @is_authenticated: this mesh requires authentication
1393 * @is_secure: this mesh uses security
1394 * @user_mpm: userspace handles all MPM functions
1395 * @dtim_period: DTIM period to use
1396 * @beacon_interval: beacon interval to use
1397 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1398 * @basic_rates: basic rates to use when creating the mesh
1399 * @beacon_rate: bitrate to be used for beacons
1400 *
1401 * These parameters are fixed when the mesh is created.
1402 */
1403struct mesh_setup {
1404 struct cfg80211_chan_def chandef;
1405 const u8 *mesh_id;
1406 u8 mesh_id_len;
1407 u8 sync_method;
1408 u8 path_sel_proto;
1409 u8 path_metric;
1410 u8 auth_id;
1411 const u8 *ie;
1412 u8 ie_len;
1413 bool is_authenticated;
1414 bool is_secure;
1415 bool user_mpm;
1416 u8 dtim_period;
1417 u16 beacon_interval;
1418 int mcast_rate[NUM_NL80211_BANDS];
1419 u32 basic_rates;
1420 struct cfg80211_bitrate_mask beacon_rate;
1421};
1422
1423/**
1424 * struct ocb_setup - 802.11p OCB mode setup configuration
1425 * @chandef: defines the channel to use
1426 *
1427 * These parameters are fixed when connecting to the network
1428 */
1429struct ocb_setup {
1430 struct cfg80211_chan_def chandef;
1431};
1432
1433/**
1434 * struct ieee80211_txq_params - TX queue parameters
1435 * @ac: AC identifier
1436 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1437 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1438 * 1..32767]
1439 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1440 * 1..32767]
1441 * @aifs: Arbitration interframe space [0..255]
1442 */
1443struct ieee80211_txq_params {
1444 enum nl80211_ac ac;
1445 u16 txop;
1446 u16 cwmin;
1447 u16 cwmax;
1448 u8 aifs;
1449};
1450
1451/**
1452 * DOC: Scanning and BSS list handling
1453 *
1454 * The scanning process itself is fairly simple, but cfg80211 offers quite
1455 * a bit of helper functionality. To start a scan, the scan operation will
1456 * be invoked with a scan definition. This scan definition contains the
1457 * channels to scan, and the SSIDs to send probe requests for (including the
1458 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1459 * probe. Additionally, a scan request may contain extra information elements
1460 * that should be added to the probe request. The IEs are guaranteed to be
1461 * well-formed, and will not exceed the maximum length the driver advertised
1462 * in the wiphy structure.
1463 *
1464 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1465 * it is responsible for maintaining the BSS list; the driver should not
1466 * maintain a list itself. For this notification, various functions exist.
1467 *
1468 * Since drivers do not maintain a BSS list, there are also a number of
1469 * functions to search for a BSS and obtain information about it from the
1470 * BSS structure cfg80211 maintains. The BSS list is also made available
1471 * to userspace.
1472 */
1473
1474/**
1475 * struct cfg80211_ssid - SSID description
1476 * @ssid: the SSID
1477 * @ssid_len: length of the ssid
1478 */
1479struct cfg80211_ssid {
1480 u8 ssid[IEEE80211_MAX_SSID_LEN];
1481 u8 ssid_len;
1482};
1483
1484/**
1485 * struct cfg80211_scan_info - information about completed scan
1486 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1487 * wireless device that requested the scan is connected to. If this
1488 * information is not available, this field is left zero.
1489 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1490 * @aborted: set to true if the scan was aborted for any reason,
1491 * userspace will be notified of that
1492 */
1493struct cfg80211_scan_info {
1494 u64 scan_start_tsf;
1495 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1496 bool aborted;
1497};
1498
1499/**
1500 * struct cfg80211_scan_request - scan request description
1501 *
1502 * @ssids: SSIDs to scan for (active scan only)
1503 * @n_ssids: number of SSIDs
1504 * @channels: channels to scan on.
1505 * @n_channels: total number of channels to scan
1506 * @scan_width: channel width for scanning
1507 * @ie: optional information element(s) to add into Probe Request or %NULL
1508 * @ie_len: length of ie in octets
1509 * @duration: how long to listen on each channel, in TUs. If
1510 * %duration_mandatory is not set, this is the maximum dwell time and
1511 * the actual dwell time may be shorter.
1512 * @duration_mandatory: if set, the scan duration must be as specified by the
1513 * %duration field.
1514 * @flags: bit field of flags controlling operation
1515 * @rates: bitmap of rates to advertise for each band
1516 * @wiphy: the wiphy this was for
1517 * @scan_start: time (in jiffies) when the scan started
1518 * @wdev: the wireless device to scan for
1519 * @info: (internal) information about completed scan
1520 * @notified: (internal) scan request was notified as done or aborted
1521 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1522 * @mac_addr: MAC address used with randomisation
1523 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1524 * are 0 in the mask should be randomised, bits that are 1 should
1525 * be taken from the @mac_addr
1526 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1527 */
1528struct cfg80211_scan_request {
1529 struct cfg80211_ssid *ssids;
1530 int n_ssids;
1531 u32 n_channels;
1532 enum nl80211_bss_scan_width scan_width;
1533 const u8 *ie;
1534 size_t ie_len;
1535 u16 duration;
1536 bool duration_mandatory;
1537 u32 flags;
1538
1539 u32 rates[NUM_NL80211_BANDS];
1540
1541 struct wireless_dev *wdev;
1542
1543 u8 mac_addr[ETH_ALEN] __aligned(2);
1544 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1545 u8 bssid[ETH_ALEN] __aligned(2);
1546
1547 /* internal */
1548 struct wiphy *wiphy;
1549 unsigned long scan_start;
1550 struct cfg80211_scan_info info;
1551 bool notified;
1552 bool no_cck;
1553
1554 /* keep last */
1555 struct ieee80211_channel *channels[0];
1556};
1557
1558static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1559{
1560 int i;
1561
1562 get_random_bytes(buf, ETH_ALEN);
1563 for (i = 0; i < ETH_ALEN; i++) {
1564 buf[i] &= ~mask[i];
1565 buf[i] |= addr[i] & mask[i];
1566 }
1567}
1568
1569/**
1570 * struct cfg80211_match_set - sets of attributes to match
1571 *
1572 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1573 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1574 */
1575struct cfg80211_match_set {
1576 struct cfg80211_ssid ssid;
1577 s32 rssi_thold;
1578};
1579
1580/**
1581 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1582 *
1583 * @interval: interval between scheduled scan iterations. In seconds.
1584 * @iterations: number of scan iterations in this scan plan. Zero means
1585 * infinite loop.
1586 * The last scan plan will always have this parameter set to zero,
1587 * all other scan plans will have a finite number of iterations.
1588 */
1589struct cfg80211_sched_scan_plan {
1590 u32 interval;
1591 u32 iterations;
1592};
1593
1594/**
1595 * struct cfg80211_sched_scan_request - scheduled scan request description
1596 *
1597 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1598 * @n_ssids: number of SSIDs
1599 * @n_channels: total number of channels to scan
1600 * @scan_width: channel width for scanning
1601 * @ie: optional information element(s) to add into Probe Request or %NULL
1602 * @ie_len: length of ie in octets
1603 * @flags: bit field of flags controlling operation
1604 * @match_sets: sets of parameters to be matched for a scan result
1605 * entry to be considered valid and to be passed to the host
1606 * (others are filtered out).
1607 * If ommited, all results are passed.
1608 * @n_match_sets: number of match sets
1609 * @wiphy: the wiphy this was for
1610 * @dev: the interface
1611 * @scan_start: start time of the scheduled scan
1612 * @channels: channels to scan
1613 * @min_rssi_thold: for drivers only supporting a single threshold, this
1614 * contains the minimum over all matchsets
1615 * @mac_addr: MAC address used with randomisation
1616 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1617 * are 0 in the mask should be randomised, bits that are 1 should
1618 * be taken from the @mac_addr
1619 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1620 * index must be executed first.
1621 * @n_scan_plans: number of scan plans, at least 1.
1622 * @rcu_head: RCU callback used to free the struct
1623 * @owner_nlportid: netlink portid of owner (if this should is a request
1624 * owned by a particular socket)
1625 * @delay: delay in seconds to use before starting the first scan
1626 * cycle. The driver may ignore this parameter and start
1627 * immediately (or at any other time), if this feature is not
1628 * supported.
1629 */
1630struct cfg80211_sched_scan_request {
1631 struct cfg80211_ssid *ssids;
1632 int n_ssids;
1633 u32 n_channels;
1634 enum nl80211_bss_scan_width scan_width;
1635 const u8 *ie;
1636 size_t ie_len;
1637 u32 flags;
1638 struct cfg80211_match_set *match_sets;
1639 int n_match_sets;
1640 s32 min_rssi_thold;
1641 u32 delay;
1642 struct cfg80211_sched_scan_plan *scan_plans;
1643 int n_scan_plans;
1644
1645 u8 mac_addr[ETH_ALEN] __aligned(2);
1646 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1647
1648 /* internal */
1649 struct wiphy *wiphy;
1650 struct net_device *dev;
1651 unsigned long scan_start;
1652 struct rcu_head rcu_head;
1653 u32 owner_nlportid;
1654
1655 /* keep last */
1656 struct ieee80211_channel *channels[0];
1657};
1658
1659/**
1660 * enum cfg80211_signal_type - signal type
1661 *
1662 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1663 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1664 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1665 */
1666enum cfg80211_signal_type {
1667 CFG80211_SIGNAL_TYPE_NONE,
1668 CFG80211_SIGNAL_TYPE_MBM,
1669 CFG80211_SIGNAL_TYPE_UNSPEC,
1670};
1671
1672/**
1673 * struct cfg80211_inform_bss - BSS inform data
1674 * @chan: channel the frame was received on
1675 * @scan_width: scan width that was used
1676 * @signal: signal strength value, according to the wiphy's
1677 * signal type
1678 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1679 * received; should match the time when the frame was actually
1680 * received by the device (not just by the host, in case it was
1681 * buffered on the device) and be accurate to about 10ms.
1682 * If the frame isn't buffered, just passing the return value of
1683 * ktime_get_boot_ns() is likely appropriate.
1684 * @parent_tsf: the time at the start of reception of the first octet of the
1685 * timestamp field of the frame. The time is the TSF of the BSS specified
1686 * by %parent_bssid.
1687 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1688 * the BSS that requested the scan in which the beacon/probe was received.
1689 */
1690struct cfg80211_inform_bss {
1691 struct ieee80211_channel *chan;
1692 enum nl80211_bss_scan_width scan_width;
1693 s32 signal;
1694 u64 boottime_ns;
1695 u64 parent_tsf;
1696 u8 parent_bssid[ETH_ALEN] __aligned(2);
1697};
1698
1699/**
1700 * struct cfg80211_bss_ies - BSS entry IE data
1701 * @tsf: TSF contained in the frame that carried these IEs
1702 * @rcu_head: internal use, for freeing
1703 * @len: length of the IEs
1704 * @from_beacon: these IEs are known to come from a beacon
1705 * @data: IE data
1706 */
1707struct cfg80211_bss_ies {
1708 u64 tsf;
1709 struct rcu_head rcu_head;
1710 int len;
1711 bool from_beacon;
1712 u8 data[];
1713};
1714
1715/**
1716 * struct cfg80211_bss - BSS description
1717 *
1718 * This structure describes a BSS (which may also be a mesh network)
1719 * for use in scan results and similar.
1720 *
1721 * @channel: channel this BSS is on
1722 * @scan_width: width of the control channel
1723 * @bssid: BSSID of the BSS
1724 * @beacon_interval: the beacon interval as from the frame
1725 * @capability: the capability field in host byte order
1726 * @ies: the information elements (Note that there is no guarantee that these
1727 * are well-formed!); this is a pointer to either the beacon_ies or
1728 * proberesp_ies depending on whether Probe Response frame has been
1729 * received. It is always non-%NULL.
1730 * @beacon_ies: the information elements from the last Beacon frame
1731 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1732 * own the beacon_ies, but they're just pointers to the ones from the
1733 * @hidden_beacon_bss struct)
1734 * @proberesp_ies: the information elements from the last Probe Response frame
1735 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1736 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1737 * that holds the beacon data. @beacon_ies is still valid, of course, and
1738 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1739 * @signal: signal strength value (type depends on the wiphy's signal_type)
1740 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1741 */
1742struct cfg80211_bss {
1743 struct ieee80211_channel *channel;
1744 enum nl80211_bss_scan_width scan_width;
1745
1746 const struct cfg80211_bss_ies __rcu *ies;
1747 const struct cfg80211_bss_ies __rcu *beacon_ies;
1748 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1749
1750 struct cfg80211_bss *hidden_beacon_bss;
1751
1752 s32 signal;
1753
1754 u16 beacon_interval;
1755 u16 capability;
1756
1757 u8 bssid[ETH_ALEN];
1758
1759 u8 priv[0] __aligned(sizeof(void *));
1760};
1761
1762/**
1763 * ieee80211_bss_get_ie - find IE with given ID
1764 * @bss: the bss to search
1765 * @ie: the IE ID
1766 *
1767 * Note that the return value is an RCU-protected pointer, so
1768 * rcu_read_lock() must be held when calling this function.
1769 * Return: %NULL if not found.
1770 */
1771const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1772
1773
1774/**
1775 * struct cfg80211_auth_request - Authentication request data
1776 *
1777 * This structure provides information needed to complete IEEE 802.11
1778 * authentication.
1779 *
1780 * @bss: The BSS to authenticate with, the callee must obtain a reference
1781 * to it if it needs to keep it.
1782 * @auth_type: Authentication type (algorithm)
1783 * @ie: Extra IEs to add to Authentication frame or %NULL
1784 * @ie_len: Length of ie buffer in octets
1785 * @key_len: length of WEP key for shared key authentication
1786 * @key_idx: index of WEP key for shared key authentication
1787 * @key: WEP key for shared key authentication
1788 * @auth_data: Fields and elements in Authentication frames. This contains
1789 * the authentication frame body (non-IE and IE data), excluding the
1790 * Authentication algorithm number, i.e., starting at the Authentication
1791 * transaction sequence number field.
1792 * @auth_data_len: Length of auth_data buffer in octets
1793 */
1794struct cfg80211_auth_request {
1795 struct cfg80211_bss *bss;
1796 const u8 *ie;
1797 size_t ie_len;
1798 enum nl80211_auth_type auth_type;
1799 const u8 *key;
1800 u8 key_len, key_idx;
1801 const u8 *auth_data;
1802 size_t auth_data_len;
1803};
1804
1805/**
1806 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1807 *
1808 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1809 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1810 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1811 */
1812enum cfg80211_assoc_req_flags {
1813 ASSOC_REQ_DISABLE_HT = BIT(0),
1814 ASSOC_REQ_DISABLE_VHT = BIT(1),
1815 ASSOC_REQ_USE_RRM = BIT(2),
1816};
1817
1818/**
1819 * struct cfg80211_assoc_request - (Re)Association request data
1820 *
1821 * This structure provides information needed to complete IEEE 802.11
1822 * (re)association.
1823 * @bss: The BSS to associate with. If the call is successful the driver is
1824 * given a reference that it must give back to cfg80211_send_rx_assoc()
1825 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1826 * association requests while already associating must be rejected.
1827 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1828 * @ie_len: Length of ie buffer in octets
1829 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1830 * @crypto: crypto settings
1831 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1832 * to indicate a request to reassociate within the ESS instead of a request
1833 * do the initial association with the ESS. When included, this is set to
1834 * the BSSID of the current association, i.e., to the value that is
1835 * included in the Current AP address field of the Reassociation Request
1836 * frame.
1837 * @flags: See &enum cfg80211_assoc_req_flags
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 * @vht_capa: VHT capability override
1842 * @vht_capa_mask: VHT capability mask indicating which fields to use
1843 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
1844 * %NULL if FILS is not used.
1845 * @fils_kek_len: Length of fils_kek in octets
1846 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
1847 * Request/Response frame or %NULL if FILS is not used. This field starts
1848 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
1849 */
1850struct cfg80211_assoc_request {
1851 struct cfg80211_bss *bss;
1852 const u8 *ie, *prev_bssid;
1853 size_t ie_len;
1854 struct cfg80211_crypto_settings crypto;
1855 bool use_mfp;
1856 u32 flags;
1857 struct ieee80211_ht_cap ht_capa;
1858 struct ieee80211_ht_cap ht_capa_mask;
1859 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1860 const u8 *fils_kek;
1861 size_t fils_kek_len;
1862 const u8 *fils_nonces;
1863};
1864
1865/**
1866 * struct cfg80211_deauth_request - Deauthentication request data
1867 *
1868 * This structure provides information needed to complete IEEE 802.11
1869 * deauthentication.
1870 *
1871 * @bssid: the BSSID of the BSS to deauthenticate from
1872 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1873 * @ie_len: Length of ie buffer in octets
1874 * @reason_code: The reason code for the deauthentication
1875 * @local_state_change: if set, change local state only and
1876 * do not set a deauth frame
1877 */
1878struct cfg80211_deauth_request {
1879 const u8 *bssid;
1880 const u8 *ie;
1881 size_t ie_len;
1882 u16 reason_code;
1883 bool local_state_change;
1884};
1885
1886/**
1887 * struct cfg80211_disassoc_request - Disassociation request data
1888 *
1889 * This structure provides information needed to complete IEEE 802.11
1890 * disassocation.
1891 *
1892 * @bss: the BSS to disassociate from
1893 * @ie: Extra IEs to add to Disassociation frame or %NULL
1894 * @ie_len: Length of ie buffer in octets
1895 * @reason_code: The reason code for the disassociation
1896 * @local_state_change: This is a request for a local state only, i.e., no
1897 * Disassociation frame is to be transmitted.
1898 */
1899struct cfg80211_disassoc_request {
1900 struct cfg80211_bss *bss;
1901 const u8 *ie;
1902 size_t ie_len;
1903 u16 reason_code;
1904 bool local_state_change;
1905};
1906
1907/**
1908 * struct cfg80211_ibss_params - IBSS parameters
1909 *
1910 * This structure defines the IBSS parameters for the join_ibss()
1911 * method.
1912 *
1913 * @ssid: The SSID, will always be non-null.
1914 * @ssid_len: The length of the SSID, will always be non-zero.
1915 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1916 * search for IBSSs with a different BSSID.
1917 * @chandef: defines the channel to use if no other IBSS to join can be found
1918 * @channel_fixed: The channel should be fixed -- do not search for
1919 * IBSSs to join on other channels.
1920 * @ie: information element(s) to include in the beacon
1921 * @ie_len: length of that
1922 * @beacon_interval: beacon interval to use
1923 * @privacy: this is a protected network, keys will be configured
1924 * after joining
1925 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1926 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1927 * required to assume that the port is unauthorized until authorized by
1928 * user space. Otherwise, port is marked authorized by default.
1929 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1930 * changes the channel when a radar is detected. This is required
1931 * to operate on DFS channels.
1932 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1933 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1934 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1935 * will be used in ht_capa. Un-supported values will be ignored.
1936 * @ht_capa_mask: The bits of ht_capa which are to be used.
1937 */
1938struct cfg80211_ibss_params {
1939 const u8 *ssid;
1940 const u8 *bssid;
1941 struct cfg80211_chan_def chandef;
1942 const u8 *ie;
1943 u8 ssid_len, ie_len;
1944 u16 beacon_interval;
1945 u32 basic_rates;
1946 bool channel_fixed;
1947 bool privacy;
1948 bool control_port;
1949 bool userspace_handles_dfs;
1950 int mcast_rate[NUM_NL80211_BANDS];
1951 struct ieee80211_ht_cap ht_capa;
1952 struct ieee80211_ht_cap ht_capa_mask;
1953};
1954
1955/**
1956 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1957 *
1958 * @band: band of BSS which should match for RSSI level adjustment.
1959 * @delta: value of RSSI level adjustment.
1960 */
1961struct cfg80211_bss_select_adjust {
1962 enum nl80211_band band;
1963 s8 delta;
1964};
1965
1966/**
1967 * struct cfg80211_bss_selection - connection parameters for BSS selection.
1968 *
1969 * @behaviour: requested BSS selection behaviour.
1970 * @param: parameters for requestion behaviour.
1971 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
1972 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
1973 */
1974struct cfg80211_bss_selection {
1975 enum nl80211_bss_select_attr behaviour;
1976 union {
1977 enum nl80211_band band_pref;
1978 struct cfg80211_bss_select_adjust adjust;
1979 } param;
1980};
1981
1982/**
1983 * struct cfg80211_connect_params - Connection parameters
1984 *
1985 * This structure provides information needed to complete IEEE 802.11
1986 * authentication and association.
1987 *
1988 * @channel: The channel to use or %NULL if not specified (auto-select based
1989 * on scan results)
1990 * @channel_hint: The channel of the recommended BSS for initial connection or
1991 * %NULL if not specified
1992 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1993 * results)
1994 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1995 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1996 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1997 * to use.
1998 * @ssid: SSID
1999 * @ssid_len: Length of ssid in octets
2000 * @auth_type: Authentication type (algorithm)
2001 * @ie: IEs for association request
2002 * @ie_len: Length of assoc_ie in octets
2003 * @privacy: indicates whether privacy-enabled APs should be used
2004 * @mfp: indicate whether management frame protection is used
2005 * @crypto: crypto settings
2006 * @key_len: length of WEP key for shared key authentication
2007 * @key_idx: index of WEP key for shared key authentication
2008 * @key: WEP key for shared key authentication
2009 * @flags: See &enum cfg80211_assoc_req_flags
2010 * @bg_scan_period: Background scan period in seconds
2011 * or -1 to indicate that default value is to be used.
2012 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2013 * will be used in ht_capa. Un-supported values will be ignored.
2014 * @ht_capa_mask: The bits of ht_capa which are to be used.
2015 * @vht_capa: VHT Capability overrides
2016 * @vht_capa_mask: The bits of vht_capa which are to be used.
2017 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2018 * networks.
2019 * @bss_select: criteria to be used for BSS selection.
2020 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2021 * to indicate a request to reassociate within the ESS instead of a request
2022 * do the initial association with the ESS. When included, this is set to
2023 * the BSSID of the current association, i.e., to the value that is
2024 * included in the Current AP address field of the Reassociation Request
2025 * frame.
2026 */
2027struct cfg80211_connect_params {
2028 struct ieee80211_channel *channel;
2029 struct ieee80211_channel *channel_hint;
2030 const u8 *bssid;
2031 const u8 *bssid_hint;
2032 const u8 *ssid;
2033 size_t ssid_len;
2034 enum nl80211_auth_type auth_type;
2035 const u8 *ie;
2036 size_t ie_len;
2037 bool privacy;
2038 enum nl80211_mfp mfp;
2039 struct cfg80211_crypto_settings crypto;
2040 const u8 *key;
2041 u8 key_len, key_idx;
2042 u32 flags;
2043 int bg_scan_period;
2044 struct ieee80211_ht_cap ht_capa;
2045 struct ieee80211_ht_cap ht_capa_mask;
2046 struct ieee80211_vht_cap vht_capa;
2047 struct ieee80211_vht_cap vht_capa_mask;
2048 bool pbss;
2049 struct cfg80211_bss_selection bss_select;
2050 const u8 *prev_bssid;
2051};
2052
2053/**
2054 * enum cfg80211_connect_params_changed - Connection parameters being updated
2055 *
2056 * This enum provides information of all connect parameters that
2057 * have to be updated as part of update_connect_params() call.
2058 *
2059 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2060 */
2061enum cfg80211_connect_params_changed {
2062 UPDATE_ASSOC_IES = BIT(0),
2063};
2064
2065/**
2066 * enum wiphy_params_flags - set_wiphy_params bitfield values
2067 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2068 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2069 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2070 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2071 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2072 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2073 */
2074enum wiphy_params_flags {
2075 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2076 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2077 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2078 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2079 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2080 WIPHY_PARAM_DYN_ACK = 1 << 5,
2081};
2082
2083/**
2084 * struct cfg80211_pmksa - PMK Security Association
2085 *
2086 * This structure is passed to the set/del_pmksa() method for PMKSA
2087 * caching.
2088 *
2089 * @bssid: The AP's BSSID.
2090 * @pmkid: The PMK material itself.
2091 */
2092struct cfg80211_pmksa {
2093 const u8 *bssid;
2094 const u8 *pmkid;
2095};
2096
2097/**
2098 * struct cfg80211_pkt_pattern - packet pattern
2099 * @mask: bitmask where to match pattern and where to ignore bytes,
2100 * one bit per byte, in same format as nl80211
2101 * @pattern: bytes to match where bitmask is 1
2102 * @pattern_len: length of pattern (in bytes)
2103 * @pkt_offset: packet offset (in bytes)
2104 *
2105 * Internal note: @mask and @pattern are allocated in one chunk of
2106 * memory, free @mask only!
2107 */
2108struct cfg80211_pkt_pattern {
2109 const u8 *mask, *pattern;
2110 int pattern_len;
2111 int pkt_offset;
2112};
2113
2114/**
2115 * struct cfg80211_wowlan_tcp - TCP connection parameters
2116 *
2117 * @sock: (internal) socket for source port allocation
2118 * @src: source IP address
2119 * @dst: destination IP address
2120 * @dst_mac: destination MAC address
2121 * @src_port: source port
2122 * @dst_port: destination port
2123 * @payload_len: data payload length
2124 * @payload: data payload buffer
2125 * @payload_seq: payload sequence stamping configuration
2126 * @data_interval: interval at which to send data packets
2127 * @wake_len: wakeup payload match length
2128 * @wake_data: wakeup payload match data
2129 * @wake_mask: wakeup payload match mask
2130 * @tokens_size: length of the tokens buffer
2131 * @payload_tok: payload token usage configuration
2132 */
2133struct cfg80211_wowlan_tcp {
2134 struct socket *sock;
2135 __be32 src, dst;
2136 u16 src_port, dst_port;
2137 u8 dst_mac[ETH_ALEN];
2138 int payload_len;
2139 const u8 *payload;
2140 struct nl80211_wowlan_tcp_data_seq payload_seq;
2141 u32 data_interval;
2142 u32 wake_len;
2143 const u8 *wake_data, *wake_mask;
2144 u32 tokens_size;
2145 /* must be last, variable member */
2146 struct nl80211_wowlan_tcp_data_token payload_tok;
2147};
2148
2149/**
2150 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2151 *
2152 * This structure defines the enabled WoWLAN triggers for the device.
2153 * @any: wake up on any activity -- special trigger if device continues
2154 * operating as normal during suspend
2155 * @disconnect: wake up if getting disconnected
2156 * @magic_pkt: wake up on receiving magic packet
2157 * @patterns: wake up on receiving packet matching a pattern
2158 * @n_patterns: number of patterns
2159 * @gtk_rekey_failure: wake up on GTK rekey failure
2160 * @eap_identity_req: wake up on EAP identity request packet
2161 * @four_way_handshake: wake up on 4-way handshake
2162 * @rfkill_release: wake up when rfkill is released
2163 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2164 * NULL if not configured.
2165 * @nd_config: configuration for the scan to be used for net detect wake.
2166 */
2167struct cfg80211_wowlan {
2168 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2169 eap_identity_req, four_way_handshake,
2170 rfkill_release;
2171 struct cfg80211_pkt_pattern *patterns;
2172 struct cfg80211_wowlan_tcp *tcp;
2173 int n_patterns;
2174 struct cfg80211_sched_scan_request *nd_config;
2175};
2176
2177/**
2178 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2179 *
2180 * This structure defines coalesce rule for the device.
2181 * @delay: maximum coalescing delay in msecs.
2182 * @condition: condition for packet coalescence.
2183 * see &enum nl80211_coalesce_condition.
2184 * @patterns: array of packet patterns
2185 * @n_patterns: number of patterns
2186 */
2187struct cfg80211_coalesce_rules {
2188 int delay;
2189 enum nl80211_coalesce_condition condition;
2190 struct cfg80211_pkt_pattern *patterns;
2191 int n_patterns;
2192};
2193
2194/**
2195 * struct cfg80211_coalesce - Packet coalescing settings
2196 *
2197 * This structure defines coalescing settings.
2198 * @rules: array of coalesce rules
2199 * @n_rules: number of rules
2200 */
2201struct cfg80211_coalesce {
2202 struct cfg80211_coalesce_rules *rules;
2203 int n_rules;
2204};
2205
2206/**
2207 * struct cfg80211_wowlan_nd_match - information about the match
2208 *
2209 * @ssid: SSID of the match that triggered the wake up
2210 * @n_channels: Number of channels where the match occurred. This
2211 * value may be zero if the driver can't report the channels.
2212 * @channels: center frequencies of the channels where a match
2213 * occurred (in MHz)
2214 */
2215struct cfg80211_wowlan_nd_match {
2216 struct cfg80211_ssid ssid;
2217 int n_channels;
2218 u32 channels[];
2219};
2220
2221/**
2222 * struct cfg80211_wowlan_nd_info - net detect wake up information
2223 *
2224 * @n_matches: Number of match information instances provided in
2225 * @matches. This value may be zero if the driver can't provide
2226 * match information.
2227 * @matches: Array of pointers to matches containing information about
2228 * the matches that triggered the wake up.
2229 */
2230struct cfg80211_wowlan_nd_info {
2231 int n_matches;
2232 struct cfg80211_wowlan_nd_match *matches[];
2233};
2234
2235/**
2236 * struct cfg80211_wowlan_wakeup - wakeup report
2237 * @disconnect: woke up by getting disconnected
2238 * @magic_pkt: woke up by receiving magic packet
2239 * @gtk_rekey_failure: woke up by GTK rekey failure
2240 * @eap_identity_req: woke up by EAP identity request packet
2241 * @four_way_handshake: woke up by 4-way handshake
2242 * @rfkill_release: woke up by rfkill being released
2243 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2244 * @packet_present_len: copied wakeup packet data
2245 * @packet_len: original wakeup packet length
2246 * @packet: The packet causing the wakeup, if any.
2247 * @packet_80211: For pattern match, magic packet and other data
2248 * frame triggers an 802.3 frame should be reported, for
2249 * disconnect due to deauth 802.11 frame. This indicates which
2250 * it is.
2251 * @tcp_match: TCP wakeup packet received
2252 * @tcp_connlost: TCP connection lost or failed to establish
2253 * @tcp_nomoretokens: TCP data ran out of tokens
2254 * @net_detect: if not %NULL, woke up because of net detect
2255 */
2256struct cfg80211_wowlan_wakeup {
2257 bool disconnect, magic_pkt, gtk_rekey_failure,
2258 eap_identity_req, four_way_handshake,
2259 rfkill_release, packet_80211,
2260 tcp_match, tcp_connlost, tcp_nomoretokens;
2261 s32 pattern_idx;
2262 u32 packet_present_len, packet_len;
2263 const void *packet;
2264 struct cfg80211_wowlan_nd_info *net_detect;
2265};
2266
2267/**
2268 * struct cfg80211_gtk_rekey_data - rekey data
2269 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2270 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2271 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2272 */
2273struct cfg80211_gtk_rekey_data {
2274 const u8 *kek, *kck, *replay_ctr;
2275};
2276
2277/**
2278 * struct cfg80211_update_ft_ies_params - FT IE Information
2279 *
2280 * This structure provides information needed to update the fast transition IE
2281 *
2282 * @md: The Mobility Domain ID, 2 Octet value
2283 * @ie: Fast Transition IEs
2284 * @ie_len: Length of ft_ie in octets
2285 */
2286struct cfg80211_update_ft_ies_params {
2287 u16 md;
2288 const u8 *ie;
2289 size_t ie_len;
2290};
2291
2292/**
2293 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2294 *
2295 * This structure provides information needed to transmit a mgmt frame
2296 *
2297 * @chan: channel to use
2298 * @offchan: indicates wether off channel operation is required
2299 * @wait: duration for ROC
2300 * @buf: buffer to transmit
2301 * @len: buffer length
2302 * @no_cck: don't use cck rates for this frame
2303 * @dont_wait_for_ack: tells the low level not to wait for an ack
2304 * @n_csa_offsets: length of csa_offsets array
2305 * @csa_offsets: array of all the csa offsets in the frame
2306 */
2307struct cfg80211_mgmt_tx_params {
2308 struct ieee80211_channel *chan;
2309 bool offchan;
2310 unsigned int wait;
2311 const u8 *buf;
2312 size_t len;
2313 bool no_cck;
2314 bool dont_wait_for_ack;
2315 int n_csa_offsets;
2316 const u16 *csa_offsets;
2317};
2318
2319/**
2320 * struct cfg80211_dscp_exception - DSCP exception
2321 *
2322 * @dscp: DSCP value that does not adhere to the user priority range definition
2323 * @up: user priority value to which the corresponding DSCP value belongs
2324 */
2325struct cfg80211_dscp_exception {
2326 u8 dscp;
2327 u8 up;
2328};
2329
2330/**
2331 * struct cfg80211_dscp_range - DSCP range definition for user priority
2332 *
2333 * @low: lowest DSCP value of this user priority range, inclusive
2334 * @high: highest DSCP value of this user priority range, inclusive
2335 */
2336struct cfg80211_dscp_range {
2337 u8 low;
2338 u8 high;
2339};
2340
2341/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2342#define IEEE80211_QOS_MAP_MAX_EX 21
2343#define IEEE80211_QOS_MAP_LEN_MIN 16
2344#define IEEE80211_QOS_MAP_LEN_MAX \
2345 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2346
2347/**
2348 * struct cfg80211_qos_map - QoS Map Information
2349 *
2350 * This struct defines the Interworking QoS map setting for DSCP values
2351 *
2352 * @num_des: number of DSCP exceptions (0..21)
2353 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2354 * the user priority DSCP range definition
2355 * @up: DSCP range definition for a particular user priority
2356 */
2357struct cfg80211_qos_map {
2358 u8 num_des;
2359 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2360 struct cfg80211_dscp_range up[8];
2361};
2362
2363/**
2364 * struct cfg80211_nan_conf - NAN configuration
2365 *
2366 * This struct defines NAN configuration parameters
2367 *
2368 * @master_pref: master preference (1 - 255)
2369 * @dual: dual band operation mode, see &enum nl80211_nan_dual_band_conf
2370 */
2371struct cfg80211_nan_conf {
2372 u8 master_pref;
2373 u8 dual;
2374};
2375
2376/**
2377 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2378 * configuration
2379 *
2380 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2381 * @CFG80211_NAN_CONF_CHANGED_DUAL: dual band operation
2382 */
2383enum cfg80211_nan_conf_changes {
2384 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2385 CFG80211_NAN_CONF_CHANGED_DUAL = BIT(1),
2386};
2387
2388/**
2389 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2390 *
2391 * @filter: the content of the filter
2392 * @len: the length of the filter
2393 */
2394struct cfg80211_nan_func_filter {
2395 const u8 *filter;
2396 u8 len;
2397};
2398
2399/**
2400 * struct cfg80211_nan_func - a NAN function
2401 *
2402 * @type: &enum nl80211_nan_function_type
2403 * @service_id: the service ID of the function
2404 * @publish_type: &nl80211_nan_publish_type
2405 * @close_range: if true, the range should be limited. Threshold is
2406 * implementation specific.
2407 * @publish_bcast: if true, the solicited publish should be broadcasted
2408 * @subscribe_active: if true, the subscribe is active
2409 * @followup_id: the instance ID for follow up
2410 * @followup_reqid: the requestor instance ID for follow up
2411 * @followup_dest: MAC address of the recipient of the follow up
2412 * @ttl: time to live counter in DW.
2413 * @serv_spec_info: Service Specific Info
2414 * @serv_spec_info_len: Service Specific Info length
2415 * @srf_include: if true, SRF is inclusive
2416 * @srf_bf: Bloom Filter
2417 * @srf_bf_len: Bloom Filter length
2418 * @srf_bf_idx: Bloom Filter index
2419 * @srf_macs: SRF MAC addresses
2420 * @srf_num_macs: number of MAC addresses in SRF
2421 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2422 * @tx_filters: filters that should be transmitted in the SDF.
2423 * @num_rx_filters: length of &rx_filters.
2424 * @num_tx_filters: length of &tx_filters.
2425 * @instance_id: driver allocated id of the function.
2426 * @cookie: unique NAN function identifier.
2427 */
2428struct cfg80211_nan_func {
2429 enum nl80211_nan_function_type type;
2430 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2431 u8 publish_type;
2432 bool close_range;
2433 bool publish_bcast;
2434 bool subscribe_active;
2435 u8 followup_id;
2436 u8 followup_reqid;
2437 struct mac_address followup_dest;
2438 u32 ttl;
2439 const u8 *serv_spec_info;
2440 u8 serv_spec_info_len;
2441 bool srf_include;
2442 const u8 *srf_bf;
2443 u8 srf_bf_len;
2444 u8 srf_bf_idx;
2445 struct mac_address *srf_macs;
2446 int srf_num_macs;
2447 struct cfg80211_nan_func_filter *rx_filters;
2448 struct cfg80211_nan_func_filter *tx_filters;
2449 u8 num_tx_filters;
2450 u8 num_rx_filters;
2451 u8 instance_id;
2452 u64 cookie;
2453};
2454
2455/**
2456 * struct cfg80211_ops - backend description for wireless configuration
2457 *
2458 * This struct is registered by fullmac card drivers and/or wireless stacks
2459 * in order to handle configuration requests on their interfaces.
2460 *
2461 * All callbacks except where otherwise noted should return 0
2462 * on success or a negative error code.
2463 *
2464 * All operations are currently invoked under rtnl for consistency with the
2465 * wireless extensions but this is subject to reevaluation as soon as this
2466 * code is used more widely and we have a first user without wext.
2467 *
2468 * @suspend: wiphy device needs to be suspended. The variable @wow will
2469 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2470 * configured for the device.
2471 * @resume: wiphy device needs to be resumed
2472 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2473 * to call device_set_wakeup_enable() to enable/disable wakeup from
2474 * the device.
2475 *
2476 * @add_virtual_intf: create a new virtual interface with the given name,
2477 * must set the struct wireless_dev's iftype. Beware: You must create
2478 * the new netdev in the wiphy's network namespace! Returns the struct
2479 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2480 * also set the address member in the wdev.
2481 *
2482 * @del_virtual_intf: remove the virtual interface
2483 *
2484 * @change_virtual_intf: change type/configuration of virtual interface,
2485 * keep the struct wireless_dev's iftype updated.
2486 *
2487 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2488 * when adding a group key.
2489 *
2490 * @get_key: get information about the key with the given parameters.
2491 * @mac_addr will be %NULL when requesting information for a group
2492 * key. All pointers given to the @callback function need not be valid
2493 * after it returns. This function should return an error if it is
2494 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2495 *
2496 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2497 * and @key_index, return -ENOENT if the key doesn't exist.
2498 *
2499 * @set_default_key: set the default key on an interface
2500 *
2501 * @set_default_mgmt_key: set the default management frame key on an interface
2502 *
2503 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2504 *
2505 * @start_ap: Start acting in AP mode defined by the parameters.
2506 * @change_beacon: Change the beacon parameters for an access point mode
2507 * interface. This should reject the call when AP mode wasn't started.
2508 * @stop_ap: Stop being an AP, including stopping beaconing.
2509 *
2510 * @add_station: Add a new station.
2511 * @del_station: Remove a station
2512 * @change_station: Modify a given station. Note that flags changes are not much
2513 * validated in cfg80211, in particular the auth/assoc/authorized flags
2514 * might come to the driver in invalid combinations -- make sure to check
2515 * them, also against the existing state! Drivers must call
2516 * cfg80211_check_station_change() to validate the information.
2517 * @get_station: get station information for the station identified by @mac
2518 * @dump_station: dump station callback -- resume dump at index @idx
2519 *
2520 * @add_mpath: add a fixed mesh path
2521 * @del_mpath: delete a given mesh path
2522 * @change_mpath: change a given mesh path
2523 * @get_mpath: get a mesh path for the given parameters
2524 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2525 * @get_mpp: get a mesh proxy path for the given parameters
2526 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2527 * @join_mesh: join the mesh network with the specified parameters
2528 * (invoked with the wireless_dev mutex held)
2529 * @leave_mesh: leave the current mesh network
2530 * (invoked with the wireless_dev mutex held)
2531 *
2532 * @get_mesh_config: Get the current mesh configuration
2533 *
2534 * @update_mesh_config: Update mesh parameters on a running mesh.
2535 * The mask is a bitfield which tells us which parameters to
2536 * set, and which to leave alone.
2537 *
2538 * @change_bss: Modify parameters for a given BSS.
2539 *
2540 * @set_txq_params: Set TX queue parameters
2541 *
2542 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2543 * as it doesn't implement join_mesh and needs to set the channel to
2544 * join the mesh instead.
2545 *
2546 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2547 * interfaces are active this callback should reject the configuration.
2548 * If no interfaces are active or the device is down, the channel should
2549 * be stored for when a monitor interface becomes active.
2550 *
2551 * @scan: Request to do a scan. If returning zero, the scan request is given
2552 * the driver, and will be valid until passed to cfg80211_scan_done().
2553 * For scan results, call cfg80211_inform_bss(); you can call this outside
2554 * the scan/scan_done bracket too.
2555 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2556 * indicate the status of the scan through cfg80211_scan_done().
2557 *
2558 * @auth: Request to authenticate with the specified peer
2559 * (invoked with the wireless_dev mutex held)
2560 * @assoc: Request to (re)associate with the specified peer
2561 * (invoked with the wireless_dev mutex held)
2562 * @deauth: Request to deauthenticate from the specified peer
2563 * (invoked with the wireless_dev mutex held)
2564 * @disassoc: Request to disassociate from the specified peer
2565 * (invoked with the wireless_dev mutex held)
2566 *
2567 * @connect: Connect to the ESS with the specified parameters. When connected,
2568 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2569 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2570 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2571 * from the AP or cfg80211_connect_timeout() if no frame with status code
2572 * was received.
2573 * The driver is allowed to roam to other BSSes within the ESS when the
2574 * other BSS matches the connect parameters. When such roaming is initiated
2575 * by the driver, the driver is expected to verify that the target matches
2576 * the configured security parameters and to use Reassociation Request
2577 * frame instead of Association Request frame.
2578 * The connect function can also be used to request the driver to perform a
2579 * specific roam when connected to an ESS. In that case, the prev_bssid
2580 * parameter is set to the BSSID of the currently associated BSS as an
2581 * indication of requesting reassociation.
2582 * In both the driver-initiated and new connect() call initiated roaming
2583 * cases, the result of roaming is indicated with a call to
2584 * cfg80211_roamed() or cfg80211_roamed_bss().
2585 * (invoked with the wireless_dev mutex held)
2586 * @update_connect_params: Update the connect parameters while connected to a
2587 * BSS. The updated parameters can be used by driver/firmware for
2588 * subsequent BSS selection (roaming) decisions and to form the
2589 * Authentication/(Re)Association Request frames. This call does not
2590 * request an immediate disassociation or reassociation with the current
2591 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
2592 * changed are defined in &enum cfg80211_connect_params_changed.
2593 * (invoked with the wireless_dev mutex held)
2594 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
2595 * connection is in progress. Once done, call cfg80211_disconnected() in
2596 * case connection was already established (invoked with the
2597 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
2598 *
2599 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2600 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2601 * to a merge.
2602 * (invoked with the wireless_dev mutex held)
2603 * @leave_ibss: Leave the IBSS.
2604 * (invoked with the wireless_dev mutex held)
2605 *
2606 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2607 * MESH mode)
2608 *
2609 * @set_wiphy_params: Notify that wiphy parameters have changed;
2610 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2611 * have changed. The actual parameter values are available in
2612 * struct wiphy. If returning an error, no value should be changed.
2613 *
2614 * @set_tx_power: set the transmit power according to the parameters,
2615 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2616 * wdev may be %NULL if power was set for the wiphy, and will
2617 * always be %NULL unless the driver supports per-vif TX power
2618 * (as advertised by the nl80211 feature flag.)
2619 * @get_tx_power: store the current TX power into the dbm variable;
2620 * return 0 if successful
2621 *
2622 * @set_wds_peer: set the WDS peer for a WDS interface
2623 *
2624 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2625 * functions to adjust rfkill hw state
2626 *
2627 * @dump_survey: get site survey information.
2628 *
2629 * @remain_on_channel: Request the driver to remain awake on the specified
2630 * channel for the specified duration to complete an off-channel
2631 * operation (e.g., public action frame exchange). When the driver is
2632 * ready on the requested channel, it must indicate this with an event
2633 * notification by calling cfg80211_ready_on_channel().
2634 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2635 * This allows the operation to be terminated prior to timeout based on
2636 * the duration value.
2637 * @mgmt_tx: Transmit a management frame.
2638 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2639 * frame on another channel
2640 *
2641 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2642 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2643 * used by the function, but 0 and 1 must not be touched. Additionally,
2644 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2645 * dump and return to userspace with an error, so be careful. If any data
2646 * was passed in from userspace then the data/len arguments will be present
2647 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2648 *
2649 * @set_bitrate_mask: set the bitrate mask configuration
2650 *
2651 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2652 * devices running firmwares capable of generating the (re) association
2653 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2654 * @del_pmksa: Delete a cached PMKID.
2655 * @flush_pmksa: Flush all cached PMKIDs.
2656 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2657 * allows the driver to adjust the dynamic ps timeout value.
2658 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2659 * After configuration, the driver should (soon) send an event indicating
2660 * the current level is above/below the configured threshold; this may
2661 * need some care when the configuration is changed (without first being
2662 * disabled.)
2663 * @set_cqm_txe_config: Configure connection quality monitor TX error
2664 * thresholds.
2665 * @sched_scan_start: Tell the driver to start a scheduled scan.
2666 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2667 * call must stop the scheduled scan and be ready for starting a new one
2668 * before it returns, i.e. @sched_scan_start may be called immediately
2669 * after that again and should not fail in that case. The driver should
2670 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2671 * method returns 0.)
2672 *
2673 * @mgmt_frame_register: Notify driver that a management frame type was
2674 * registered. The callback is allowed to sleep.
2675 *
2676 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2677 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2678 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2679 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2680 *
2681 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2682 *
2683 * @tdls_mgmt: Transmit a TDLS management frame.
2684 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2685 *
2686 * @probe_client: probe an associated client, must return a cookie that it
2687 * later passes to cfg80211_probe_status().
2688 *
2689 * @set_noack_map: Set the NoAck Map for the TIDs.
2690 *
2691 * @get_channel: Get the current operating channel for the virtual interface.
2692 * For monitor interfaces, it should return %NULL unless there's a single
2693 * current monitoring channel.
2694 *
2695 * @start_p2p_device: Start the given P2P device.
2696 * @stop_p2p_device: Stop the given P2P device.
2697 *
2698 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2699 * Parameters include ACL policy, an array of MAC address of stations
2700 * and the number of MAC addresses. If there is already a list in driver
2701 * this new list replaces the existing one. Driver has to clear its ACL
2702 * when number of MAC addresses entries is passed as 0. Drivers which
2703 * advertise the support for MAC based ACL have to implement this callback.
2704 *
2705 * @start_radar_detection: Start radar detection in the driver.
2706 *
2707 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2708 * driver. If the SME is in the driver/firmware, this information can be
2709 * used in building Authentication and Reassociation Request frames.
2710 *
2711 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2712 * for a given duration (milliseconds). The protocol is provided so the
2713 * driver can take the most appropriate actions.
2714 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2715 * reliability. This operation can not fail.
2716 * @set_coalesce: Set coalesce parameters.
2717 *
2718 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2719 * responsible for veryfing if the switch is possible. Since this is
2720 * inherently tricky driver may decide to disconnect an interface later
2721 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2722 * everything. It should do it's best to verify requests and reject them
2723 * as soon as possible.
2724 *
2725 * @set_qos_map: Set QoS mapping information to the driver
2726 *
2727 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2728 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2729 * changes during the lifetime of the BSS.
2730 *
2731 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2732 * with the given parameters; action frame exchange has been handled by
2733 * userspace so this just has to modify the TX path to take the TS into
2734 * account.
2735 * If the admitted time is 0 just validate the parameters to make sure
2736 * the session can be created at all; it is valid to just always return
2737 * success for that but that may result in inefficient behaviour (handshake
2738 * with the peer followed by immediate teardown when the addition is later
2739 * rejected)
2740 * @del_tx_ts: remove an existing TX TS
2741 *
2742 * @join_ocb: join the OCB network with the specified parameters
2743 * (invoked with the wireless_dev mutex held)
2744 * @leave_ocb: leave the current OCB network
2745 * (invoked with the wireless_dev mutex held)
2746 *
2747 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2748 * is responsible for continually initiating channel-switching operations
2749 * and returning to the base channel for communication with the AP.
2750 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2751 * peers must be on the base channel when the call completes.
2752 * @start_nan: Start the NAN interface.
2753 * @stop_nan: Stop the NAN interface.
2754 * @add_nan_func: Add a NAN function. Returns negative value on failure.
2755 * On success @nan_func ownership is transferred to the driver and
2756 * it may access it outside of the scope of this function. The driver
2757 * should free the @nan_func when no longer needed by calling
2758 * cfg80211_free_nan_func().
2759 * On success the driver should assign an instance_id in the
2760 * provided @nan_func.
2761 * @del_nan_func: Delete a NAN function.
2762 * @nan_change_conf: changes NAN configuration. The changed parameters must
2763 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
2764 * All other parameters must be ignored.
2765 *
2766 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
2767 */
2768struct cfg80211_ops {
2769 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2770 int (*resume)(struct wiphy *wiphy);
2771 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2772
2773 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2774 const char *name,
2775 unsigned char name_assign_type,
2776 enum nl80211_iftype type,
2777 u32 *flags,
2778 struct vif_params *params);
2779 int (*del_virtual_intf)(struct wiphy *wiphy,
2780 struct wireless_dev *wdev);
2781 int (*change_virtual_intf)(struct wiphy *wiphy,
2782 struct net_device *dev,
2783 enum nl80211_iftype type, u32 *flags,
2784 struct vif_params *params);
2785
2786 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2787 u8 key_index, bool pairwise, const u8 *mac_addr,
2788 struct key_params *params);
2789 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2790 u8 key_index, bool pairwise, const u8 *mac_addr,
2791 void *cookie,
2792 void (*callback)(void *cookie, struct key_params*));
2793 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2794 u8 key_index, bool pairwise, const u8 *mac_addr);
2795 int (*set_default_key)(struct wiphy *wiphy,
2796 struct net_device *netdev,
2797 u8 key_index, bool unicast, bool multicast);
2798 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2799 struct net_device *netdev,
2800 u8 key_index);
2801
2802 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2803 struct cfg80211_ap_settings *settings);
2804 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2805 struct cfg80211_beacon_data *info);
2806 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2807
2808
2809 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2810 const u8 *mac,
2811 struct station_parameters *params);
2812 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2813 struct station_del_parameters *params);
2814 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2815 const u8 *mac,
2816 struct station_parameters *params);
2817 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2818 const u8 *mac, struct station_info *sinfo);
2819 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2820 int idx, u8 *mac, struct station_info *sinfo);
2821
2822 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2823 const u8 *dst, const u8 *next_hop);
2824 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2825 const u8 *dst);
2826 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2827 const u8 *dst, const u8 *next_hop);
2828 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2829 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2830 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2831 int idx, u8 *dst, u8 *next_hop,
2832 struct mpath_info *pinfo);
2833 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2834 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2835 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2836 int idx, u8 *dst, u8 *mpp,
2837 struct mpath_info *pinfo);
2838 int (*get_mesh_config)(struct wiphy *wiphy,
2839 struct net_device *dev,
2840 struct mesh_config *conf);
2841 int (*update_mesh_config)(struct wiphy *wiphy,
2842 struct net_device *dev, u32 mask,
2843 const struct mesh_config *nconf);
2844 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2845 const struct mesh_config *conf,
2846 const struct mesh_setup *setup);
2847 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2848
2849 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2850 struct ocb_setup *setup);
2851 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2852
2853 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2854 struct bss_parameters *params);
2855
2856 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2857 struct ieee80211_txq_params *params);
2858
2859 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2860 struct net_device *dev,
2861 struct ieee80211_channel *chan);
2862
2863 int (*set_monitor_channel)(struct wiphy *wiphy,
2864 struct cfg80211_chan_def *chandef);
2865
2866 int (*scan)(struct wiphy *wiphy,
2867 struct cfg80211_scan_request *request);
2868 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
2869
2870 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2871 struct cfg80211_auth_request *req);
2872 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2873 struct cfg80211_assoc_request *req);
2874 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2875 struct cfg80211_deauth_request *req);
2876 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2877 struct cfg80211_disassoc_request *req);
2878
2879 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2880 struct cfg80211_connect_params *sme);
2881 int (*update_connect_params)(struct wiphy *wiphy,
2882 struct net_device *dev,
2883 struct cfg80211_connect_params *sme,
2884 u32 changed);
2885 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2886 u16 reason_code);
2887
2888 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2889 struct cfg80211_ibss_params *params);
2890 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2891
2892 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2893 int rate[NUM_NL80211_BANDS]);
2894
2895 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2896
2897 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2898 enum nl80211_tx_power_setting type, int mbm);
2899 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2900 int *dbm);
2901
2902 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2903 const u8 *addr);
2904
2905 void (*rfkill_poll)(struct wiphy *wiphy);
2906
2907#ifdef CONFIG_NL80211_TESTMODE
2908 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2909 void *data, int len);
2910 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2911 struct netlink_callback *cb,
2912 void *data, int len);
2913#endif
2914
2915 int (*set_bitrate_mask)(struct wiphy *wiphy,
2916 struct net_device *dev,
2917 const u8 *peer,
2918 const struct cfg80211_bitrate_mask *mask);
2919
2920 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2921 int idx, struct survey_info *info);
2922
2923 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2924 struct cfg80211_pmksa *pmksa);
2925 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2926 struct cfg80211_pmksa *pmksa);
2927 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2928
2929 int (*remain_on_channel)(struct wiphy *wiphy,
2930 struct wireless_dev *wdev,
2931 struct ieee80211_channel *chan,
2932 unsigned int duration,
2933 u64 *cookie);
2934 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2935 struct wireless_dev *wdev,
2936 u64 cookie);
2937
2938 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2939 struct cfg80211_mgmt_tx_params *params,
2940 u64 *cookie);
2941 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2942 struct wireless_dev *wdev,
2943 u64 cookie);
2944
2945 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2946 bool enabled, int timeout);
2947
2948 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2949 struct net_device *dev,
2950 s32 rssi_thold, u32 rssi_hyst);
2951
2952 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2953 struct net_device *dev,
2954 u32 rate, u32 pkts, u32 intvl);
2955
2956 void (*mgmt_frame_register)(struct wiphy *wiphy,
2957 struct wireless_dev *wdev,
2958 u16 frame_type, bool reg);
2959
2960 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2961 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2962
2963 int (*sched_scan_start)(struct wiphy *wiphy,
2964 struct net_device *dev,
2965 struct cfg80211_sched_scan_request *request);
2966 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2967
2968 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2969 struct cfg80211_gtk_rekey_data *data);
2970
2971 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2972 const u8 *peer, u8 action_code, u8 dialog_token,
2973 u16 status_code, u32 peer_capability,
2974 bool initiator, const u8 *buf, size_t len);
2975 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2976 const u8 *peer, enum nl80211_tdls_operation oper);
2977
2978 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2979 const u8 *peer, u64 *cookie);
2980
2981 int (*set_noack_map)(struct wiphy *wiphy,
2982 struct net_device *dev,
2983 u16 noack_map);
2984
2985 int (*get_channel)(struct wiphy *wiphy,
2986 struct wireless_dev *wdev,
2987 struct cfg80211_chan_def *chandef);
2988
2989 int (*start_p2p_device)(struct wiphy *wiphy,
2990 struct wireless_dev *wdev);
2991 void (*stop_p2p_device)(struct wiphy *wiphy,
2992 struct wireless_dev *wdev);
2993
2994 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2995 const struct cfg80211_acl_data *params);
2996
2997 int (*start_radar_detection)(struct wiphy *wiphy,
2998 struct net_device *dev,
2999 struct cfg80211_chan_def *chandef,
3000 u32 cac_time_ms);
3001 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3002 struct cfg80211_update_ft_ies_params *ftie);
3003 int (*crit_proto_start)(struct wiphy *wiphy,
3004 struct wireless_dev *wdev,
3005 enum nl80211_crit_proto_id protocol,
3006 u16 duration);
3007 void (*crit_proto_stop)(struct wiphy *wiphy,
3008 struct wireless_dev *wdev);
3009 int (*set_coalesce)(struct wiphy *wiphy,
3010 struct cfg80211_coalesce *coalesce);
3011
3012 int (*channel_switch)(struct wiphy *wiphy,
3013 struct net_device *dev,
3014 struct cfg80211_csa_settings *params);
3015
3016 int (*set_qos_map)(struct wiphy *wiphy,
3017 struct net_device *dev,
3018 struct cfg80211_qos_map *qos_map);
3019
3020 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3021 struct cfg80211_chan_def *chandef);
3022
3023 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3024 u8 tsid, const u8 *peer, u8 user_prio,
3025 u16 admitted_time);
3026 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3027 u8 tsid, const u8 *peer);
3028
3029 int (*tdls_channel_switch)(struct wiphy *wiphy,
3030 struct net_device *dev,
3031 const u8 *addr, u8 oper_class,
3032 struct cfg80211_chan_def *chandef);
3033 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3034 struct net_device *dev,
3035 const u8 *addr);
3036 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3037 struct cfg80211_nan_conf *conf);
3038 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3039 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3040 struct cfg80211_nan_func *nan_func);
3041 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3042 u64 cookie);
3043 int (*nan_change_conf)(struct wiphy *wiphy,
3044 struct wireless_dev *wdev,
3045 struct cfg80211_nan_conf *conf,
3046 u32 changes);
3047
3048 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
3049 struct net_device *dev,
3050 const bool enabled);
3051};
3052
3053/*
3054 * wireless hardware and networking interfaces structures
3055 * and registration/helper functions
3056 */
3057
3058/**
3059 * enum wiphy_flags - wiphy capability flags
3060 *
3061 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3062 * wiphy at all
3063 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3064 * by default -- this flag will be set depending on the kernel's default
3065 * on wiphy_new(), but can be changed by the driver if it has a good
3066 * reason to override the default
3067 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3068 * on a VLAN interface)
3069 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3070 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3071 * control port protocol ethertype. The device also honours the
3072 * control_port_no_encrypt flag.
3073 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3074 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3075 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3076 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
3077 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3078 * firmware.
3079 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3080 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3081 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3082 * link setup/discovery operations internally. Setup, discovery and
3083 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3084 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3085 * used for asking the driver/firmware to perform a TDLS operation.
3086 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3087 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3088 * when there are virtual interfaces in AP mode by calling
3089 * cfg80211_report_obss_beacon().
3090 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3091 * responds to probe-requests in hardware.
3092 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3093 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3094 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3095 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3096 * beaconing mode (AP, IBSS, Mesh, ...).
3097 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3098 * before connection.
3099 */
3100enum wiphy_flags {
3101 /* use hole at 0 */
3102 /* use hole at 1 */
3103 /* use hole at 2 */
3104 WIPHY_FLAG_NETNS_OK = BIT(3),
3105 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
3106 WIPHY_FLAG_4ADDR_AP = BIT(5),
3107 WIPHY_FLAG_4ADDR_STATION = BIT(6),
3108 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
3109 WIPHY_FLAG_IBSS_RSN = BIT(8),
3110 WIPHY_FLAG_MESH_AUTH = BIT(10),
3111 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
3112 /* use hole at 12 */
3113 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
3114 WIPHY_FLAG_AP_UAPSD = BIT(14),
3115 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
3116 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
3117 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
3118 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
3119 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
3120 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
3121 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
3122 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
3123 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
3124 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
3125};
3126
3127/**
3128 * struct ieee80211_iface_limit - limit on certain interface types
3129 * @max: maximum number of interfaces of these types
3130 * @types: interface types (bits)
3131 */
3132struct ieee80211_iface_limit {
3133 u16 max;
3134 u16 types;
3135};
3136
3137/**
3138 * struct ieee80211_iface_combination - possible interface combination
3139 * @limits: limits for the given interface types
3140 * @n_limits: number of limitations
3141 * @num_different_channels: can use up to this many different channels
3142 * @max_interfaces: maximum number of interfaces in total allowed in this
3143 * group
3144 * @beacon_int_infra_match: In this combination, the beacon intervals
3145 * between infrastructure and AP types must match. This is required
3146 * only in special cases.
3147 * @radar_detect_widths: bitmap of channel widths supported for radar detection
3148 * @radar_detect_regions: bitmap of regions supported for radar detection
3149 * @beacon_int_min_gcd: This interface combination supports different
3150 * beacon intervals.
3151 * = 0 - all beacon intervals for different interface must be same.
3152 * > 0 - any beacon interval for the interface part of this combination AND
3153 * *GCD* of all beacon intervals from beaconing interfaces of this
3154 * combination must be greater or equal to this value.
3155 *
3156 * With this structure the driver can describe which interface
3157 * combinations it supports concurrently.
3158 *
3159 * Examples:
3160 *
3161 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3162 *
3163 * .. code-block:: c
3164 *
3165 * struct ieee80211_iface_limit limits1[] = {
3166 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3167 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3168 * };
3169 * struct ieee80211_iface_combination combination1 = {
3170 * .limits = limits1,
3171 * .n_limits = ARRAY_SIZE(limits1),
3172 * .max_interfaces = 2,
3173 * .beacon_int_infra_match = true,
3174 * };
3175 *
3176 *
3177 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3178 *
3179 * .. code-block:: c
3180 *
3181 * struct ieee80211_iface_limit limits2[] = {
3182 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3183 * BIT(NL80211_IFTYPE_P2P_GO), },
3184 * };
3185 * struct ieee80211_iface_combination combination2 = {
3186 * .limits = limits2,
3187 * .n_limits = ARRAY_SIZE(limits2),
3188 * .max_interfaces = 8,
3189 * .num_different_channels = 1,
3190 * };
3191 *
3192 *
3193 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3194 *
3195 * This allows for an infrastructure connection and three P2P connections.
3196 *
3197 * .. code-block:: c
3198 *
3199 * struct ieee80211_iface_limit limits3[] = {
3200 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3201 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3202 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
3203 * };
3204 * struct ieee80211_iface_combination combination3 = {
3205 * .limits = limits3,
3206 * .n_limits = ARRAY_SIZE(limits3),
3207 * .max_interfaces = 4,
3208 * .num_different_channels = 2,
3209 * };
3210 *
3211 */
3212struct ieee80211_iface_combination {
3213 const struct ieee80211_iface_limit *limits;
3214 u32 num_different_channels;
3215 u16 max_interfaces;
3216 u8 n_limits;
3217 bool beacon_int_infra_match;
3218 u8 radar_detect_widths;
3219 u8 radar_detect_regions;
3220 u32 beacon_int_min_gcd;
3221};
3222
3223struct ieee80211_txrx_stypes {
3224 u16 tx, rx;
3225};
3226
3227/**
3228 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3229 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3230 * trigger that keeps the device operating as-is and
3231 * wakes up the host on any activity, for example a
3232 * received packet that passed filtering; note that the
3233 * packet should be preserved in that case
3234 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3235 * (see nl80211.h)
3236 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3237 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3238 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3239 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3240 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3241 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3242 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3243 */
3244enum wiphy_wowlan_support_flags {
3245 WIPHY_WOWLAN_ANY = BIT(0),
3246 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
3247 WIPHY_WOWLAN_DISCONNECT = BIT(2),
3248 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3249 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
3250 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
3251 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
3252 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
3253 WIPHY_WOWLAN_NET_DETECT = BIT(8),
3254};
3255
3256struct wiphy_wowlan_tcp_support {
3257 const struct nl80211_wowlan_tcp_data_token_feature *tok;
3258 u32 data_payload_max;
3259 u32 data_interval_max;
3260 u32 wake_payload_max;
3261 bool seq;
3262};
3263
3264/**
3265 * struct wiphy_wowlan_support - WoWLAN support data
3266 * @flags: see &enum wiphy_wowlan_support_flags
3267 * @n_patterns: number of supported wakeup patterns
3268 * (see nl80211.h for the pattern definition)
3269 * @pattern_max_len: maximum length of each pattern
3270 * @pattern_min_len: minimum length of each pattern
3271 * @max_pkt_offset: maximum Rx packet offset
3272 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3273 * similar, but not necessarily identical, to max_match_sets for
3274 * scheduled scans.
3275 * See &struct cfg80211_sched_scan_request.@match_sets for more
3276 * details.
3277 * @tcp: TCP wakeup support information
3278 */
3279struct wiphy_wowlan_support {
3280 u32 flags;
3281 int n_patterns;
3282 int pattern_max_len;
3283 int pattern_min_len;
3284 int max_pkt_offset;
3285 int max_nd_match_sets;
3286 const struct wiphy_wowlan_tcp_support *tcp;
3287};
3288
3289/**
3290 * struct wiphy_coalesce_support - coalesce support data
3291 * @n_rules: maximum number of coalesce rules
3292 * @max_delay: maximum supported coalescing delay in msecs
3293 * @n_patterns: number of supported patterns in a rule
3294 * (see nl80211.h for the pattern definition)
3295 * @pattern_max_len: maximum length of each pattern
3296 * @pattern_min_len: minimum length of each pattern
3297 * @max_pkt_offset: maximum Rx packet offset
3298 */
3299struct wiphy_coalesce_support {
3300 int n_rules;
3301 int max_delay;
3302 int n_patterns;
3303 int pattern_max_len;
3304 int pattern_min_len;
3305 int max_pkt_offset;
3306};
3307
3308/**
3309 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3310 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3311 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3312 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3313 * (must be combined with %_WDEV or %_NETDEV)
3314 */
3315enum wiphy_vendor_command_flags {
3316 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3317 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3318 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3319};
3320
3321/**
3322 * struct wiphy_vendor_command - vendor command definition
3323 * @info: vendor command identifying information, as used in nl80211
3324 * @flags: flags, see &enum wiphy_vendor_command_flags
3325 * @doit: callback for the operation, note that wdev is %NULL if the
3326 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3327 * pointer may be %NULL if userspace provided no data at all
3328 * @dumpit: dump callback, for transferring bigger/multiple items. The
3329 * @storage points to cb->args[5], ie. is preserved over the multiple
3330 * dumpit calls.
3331 * It's recommended to not have the same sub command with both @doit and
3332 * @dumpit, so that userspace can assume certain ones are get and others
3333 * are used with dump requests.
3334 */
3335struct wiphy_vendor_command {
3336 struct nl80211_vendor_cmd_info info;
3337 u32 flags;
3338 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3339 const void *data, int data_len);
3340 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3341 struct sk_buff *skb, const void *data, int data_len,
3342 unsigned long *storage);
3343};
3344
3345/**
3346 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3347 * @iftype: interface type
3348 * @extended_capabilities: extended capabilities supported by the driver,
3349 * additional capabilities might be supported by userspace; these are the
3350 * 802.11 extended capabilities ("Extended Capabilities element") and are
3351 * in the same format as in the information element. See IEEE Std
3352 * 802.11-2012 8.4.2.29 for the defined fields.
3353 * @extended_capabilities_mask: mask of the valid values
3354 * @extended_capabilities_len: length of the extended capabilities
3355 */
3356struct wiphy_iftype_ext_capab {
3357 enum nl80211_iftype iftype;
3358 const u8 *extended_capabilities;
3359 const u8 *extended_capabilities_mask;
3360 u8 extended_capabilities_len;
3361};
3362
3363/**
3364 * struct wiphy - wireless hardware description
3365 * @reg_notifier: the driver's regulatory notification callback,
3366 * note that if your driver uses wiphy_apply_custom_regulatory()
3367 * the reg_notifier's request can be passed as NULL
3368 * @regd: the driver's regulatory domain, if one was requested via
3369 * the regulatory_hint() API. This can be used by the driver
3370 * on the reg_notifier() if it chooses to ignore future
3371 * regulatory domain changes caused by other drivers.
3372 * @signal_type: signal type reported in &struct cfg80211_bss.
3373 * @cipher_suites: supported cipher suites
3374 * @n_cipher_suites: number of supported cipher suites
3375 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3376 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3377 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3378 * -1 = fragmentation disabled, only odd values >= 256 used
3379 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3380 * @_net: the network namespace this wiphy currently lives in
3381 * @perm_addr: permanent MAC address of this device
3382 * @addr_mask: If the device supports multiple MAC addresses by masking,
3383 * set this to a mask with variable bits set to 1, e.g. if the last
3384 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3385 * variable bits shall be determined by the interfaces added, with
3386 * interfaces not matching the mask being rejected to be brought up.
3387 * @n_addresses: number of addresses in @addresses.
3388 * @addresses: If the device has more than one address, set this pointer
3389 * to a list of addresses (6 bytes each). The first one will be used
3390 * by default for perm_addr. In this case, the mask should be set to
3391 * all-zeroes. In this case it is assumed that the device can handle
3392 * the same number of arbitrary MAC addresses.
3393 * @registered: protects ->resume and ->suspend sysfs callbacks against
3394 * unregister hardware
3395 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3396 * automatically on wiphy renames
3397 * @dev: (virtual) struct device for this wiphy
3398 * @registered: helps synchronize suspend/resume with wiphy unregister
3399 * @wext: wireless extension handlers
3400 * @priv: driver private data (sized according to wiphy_new() parameter)
3401 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3402 * must be set by driver
3403 * @iface_combinations: Valid interface combinations array, should not
3404 * list single interface types.
3405 * @n_iface_combinations: number of entries in @iface_combinations array.
3406 * @software_iftypes: bitmask of software interface types, these are not
3407 * subject to any restrictions since they are purely managed in SW.
3408 * @flags: wiphy flags, see &enum wiphy_flags
3409 * @regulatory_flags: wiphy regulatory flags, see
3410 * &enum ieee80211_regulatory_flags
3411 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3412 * @ext_features: extended features advertised to nl80211, see
3413 * &enum nl80211_ext_feature_index.
3414 * @bss_priv_size: each BSS struct has private data allocated with it,
3415 * this variable determines its size
3416 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3417 * any given scan
3418 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3419 * for in any given scheduled scan
3420 * @max_match_sets: maximum number of match sets the device can handle
3421 * when performing a scheduled scan, 0 if filtering is not
3422 * supported.
3423 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3424 * add to probe request frames transmitted during a scan, must not
3425 * include fixed IEs like supported rates
3426 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3427 * scans
3428 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3429 * of iterations) for scheduled scan supported by the device.
3430 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3431 * single scan plan supported by the device.
3432 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3433 * scan plan supported by the device.
3434 * @coverage_class: current coverage class
3435 * @fw_version: firmware version for ethtool reporting
3436 * @hw_version: hardware version for ethtool reporting
3437 * @max_num_pmkids: maximum number of PMKIDs supported by device
3438 * @privid: a pointer that drivers can use to identify if an arbitrary
3439 * wiphy is theirs, e.g. in global notifiers
3440 * @bands: information about bands/channels supported by this device
3441 *
3442 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3443 * transmitted through nl80211, points to an array indexed by interface
3444 * type
3445 *
3446 * @available_antennas_tx: bitmap of antennas which are available to be
3447 * configured as TX antennas. Antenna configuration commands will be
3448 * rejected unless this or @available_antennas_rx is set.
3449 *
3450 * @available_antennas_rx: bitmap of antennas which are available to be
3451 * configured as RX antennas. Antenna configuration commands will be
3452 * rejected unless this or @available_antennas_tx is set.
3453 *
3454 * @probe_resp_offload:
3455 * Bitmap of supported protocols for probe response offloading.
3456 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3457 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3458 *
3459 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3460 * may request, if implemented.
3461 *
3462 * @wowlan: WoWLAN support information
3463 * @wowlan_config: current WoWLAN configuration; this should usually not be
3464 * used since access to it is necessarily racy, use the parameter passed
3465 * to the suspend() operation instead.
3466 *
3467 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3468 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3469 * If null, then none can be over-ridden.
3470 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3471 * If null, then none can be over-ridden.
3472 *
3473 * @wdev_list: the list of associated (virtual) interfaces; this list must
3474 * not be modified by the driver, but can be read with RTNL/RCU protection.
3475 *
3476 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3477 * supports for ACL.
3478 *
3479 * @extended_capabilities: extended capabilities supported by the driver,
3480 * additional capabilities might be supported by userspace; these are
3481 * the 802.11 extended capabilities ("Extended Capabilities element")
3482 * and are in the same format as in the information element. See
3483 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3484 * extended capabilities to be used if the capabilities are not specified
3485 * for a specific interface type in iftype_ext_capab.
3486 * @extended_capabilities_mask: mask of the valid values
3487 * @extended_capabilities_len: length of the extended capabilities
3488 * @iftype_ext_capab: array of extended capabilities per interface type
3489 * @num_iftype_ext_capab: number of interface types for which extended
3490 * capabilities are specified separately.
3491 * @coalesce: packet coalescing support information
3492 *
3493 * @vendor_commands: array of vendor commands supported by the hardware
3494 * @n_vendor_commands: number of vendor commands
3495 * @vendor_events: array of vendor events supported by the hardware
3496 * @n_vendor_events: number of vendor events
3497 *
3498 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3499 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3500 * driver is allowed to advertise a theoretical limit that it can reach in
3501 * some cases, but may not always reach.
3502 *
3503 * @max_num_csa_counters: Number of supported csa_counters in beacons
3504 * and probe responses. This value should be set if the driver
3505 * wishes to limit the number of csa counters. Default (0) means
3506 * infinite.
3507 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3508 * frame was sent and the channel on which the frame was heard for which
3509 * the reported rssi is still valid. If a driver is able to compensate the
3510 * low rssi when a frame is heard on different channel, then it should set
3511 * this variable to the maximal offset for which it can compensate.
3512 * This value should be set in MHz.
3513 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3514 * by the driver in the .connect() callback. The bit position maps to the
3515 * attribute indices defined in &enum nl80211_bss_select_attr.
3516 *
3517 * @cookie_counter: unique generic cookie counter, used to identify objects.
3518 */
3519struct wiphy {
3520 /* assign these fields before you register the wiphy */
3521
3522 /* permanent MAC address(es) */
3523 u8 perm_addr[ETH_ALEN];
3524 u8 addr_mask[ETH_ALEN];
3525
3526 struct mac_address *addresses;
3527
3528 const struct ieee80211_txrx_stypes *mgmt_stypes;
3529
3530 const struct ieee80211_iface_combination *iface_combinations;
3531 int n_iface_combinations;
3532 u16 software_iftypes;
3533
3534 u16 n_addresses;
3535
3536 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3537 u16 interface_modes;
3538
3539 u16 max_acl_mac_addrs;
3540
3541 u32 flags, regulatory_flags, features;
3542 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3543
3544 u32 ap_sme_capa;
3545
3546 enum cfg80211_signal_type signal_type;
3547
3548 int bss_priv_size;
3549 u8 max_scan_ssids;
3550 u8 max_sched_scan_ssids;
3551 u8 max_match_sets;
3552 u16 max_scan_ie_len;
3553 u16 max_sched_scan_ie_len;
3554 u32 max_sched_scan_plans;
3555 u32 max_sched_scan_plan_interval;
3556 u32 max_sched_scan_plan_iterations;
3557
3558 int n_cipher_suites;
3559 const u32 *cipher_suites;
3560
3561 u8 retry_short;
3562 u8 retry_long;
3563 u32 frag_threshold;
3564 u32 rts_threshold;
3565 u8 coverage_class;
3566
3567 char fw_version[ETHTOOL_FWVERS_LEN];
3568 u32 hw_version;
3569
3570#ifdef CONFIG_PM
3571 const struct wiphy_wowlan_support *wowlan;
3572 struct cfg80211_wowlan *wowlan_config;
3573#endif
3574
3575 u16 max_remain_on_channel_duration;
3576
3577 u8 max_num_pmkids;
3578
3579 u32 available_antennas_tx;
3580 u32 available_antennas_rx;
3581
3582 /*
3583 * Bitmap of supported protocols for probe response offloading
3584 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3585 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3586 */
3587 u32 probe_resp_offload;
3588
3589 const u8 *extended_capabilities, *extended_capabilities_mask;
3590 u8 extended_capabilities_len;
3591
3592 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3593 unsigned int num_iftype_ext_capab;
3594
3595 /* If multiple wiphys are registered and you're handed e.g.
3596 * a regular netdev with assigned ieee80211_ptr, you won't
3597 * know whether it points to a wiphy your driver has registered
3598 * or not. Assign this to something global to your driver to
3599 * help determine whether you own this wiphy or not. */
3600 const void *privid;
3601
3602 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
3603
3604 /* Lets us get back the wiphy on the callback */
3605 void (*reg_notifier)(struct wiphy *wiphy,
3606 struct regulatory_request *request);
3607
3608 /* fields below are read-only, assigned by cfg80211 */
3609
3610 const struct ieee80211_regdomain __rcu *regd;
3611
3612 /* the item in /sys/class/ieee80211/ points to this,
3613 * you need use set_wiphy_dev() (see below) */
3614 struct device dev;
3615
3616 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3617 bool registered;
3618
3619 /* dir in debugfs: ieee80211/<wiphyname> */
3620 struct dentry *debugfsdir;
3621
3622 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3623 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3624
3625 struct list_head wdev_list;
3626
3627 /* the network namespace this phy lives in currently */
3628 possible_net_t _net;
3629
3630#ifdef CONFIG_CFG80211_WEXT
3631 const struct iw_handler_def *wext;
3632#endif
3633
3634 const struct wiphy_coalesce_support *coalesce;
3635
3636 const struct wiphy_vendor_command *vendor_commands;
3637 const struct nl80211_vendor_cmd_info *vendor_events;
3638 int n_vendor_commands, n_vendor_events;
3639
3640 u16 max_ap_assoc_sta;
3641
3642 u8 max_num_csa_counters;
3643 u8 max_adj_channel_rssi_comp;
3644
3645 u32 bss_select_support;
3646
3647 u64 cookie_counter;
3648
3649 char priv[0] __aligned(NETDEV_ALIGN);
3650};
3651
3652static inline struct net *wiphy_net(struct wiphy *wiphy)
3653{
3654 return read_pnet(&wiphy->_net);
3655}
3656
3657static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3658{
3659 write_pnet(&wiphy->_net, net);
3660}
3661
3662/**
3663 * wiphy_priv - return priv from wiphy
3664 *
3665 * @wiphy: the wiphy whose priv pointer to return
3666 * Return: The priv of @wiphy.
3667 */
3668static inline void *wiphy_priv(struct wiphy *wiphy)
3669{
3670 BUG_ON(!wiphy);
3671 return &wiphy->priv;
3672}
3673
3674/**
3675 * priv_to_wiphy - return the wiphy containing the priv
3676 *
3677 * @priv: a pointer previously returned by wiphy_priv
3678 * Return: The wiphy of @priv.
3679 */
3680static inline struct wiphy *priv_to_wiphy(void *priv)
3681{
3682 BUG_ON(!priv);
3683 return container_of(priv, struct wiphy, priv);
3684}
3685
3686/**
3687 * set_wiphy_dev - set device pointer for wiphy
3688 *
3689 * @wiphy: The wiphy whose device to bind
3690 * @dev: The device to parent it to
3691 */
3692static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3693{
3694 wiphy->dev.parent = dev;
3695}
3696
3697/**
3698 * wiphy_dev - get wiphy dev pointer
3699 *
3700 * @wiphy: The wiphy whose device struct to look up
3701 * Return: The dev of @wiphy.
3702 */
3703static inline struct device *wiphy_dev(struct wiphy *wiphy)
3704{
3705 return wiphy->dev.parent;
3706}
3707
3708/**
3709 * wiphy_name - get wiphy name
3710 *
3711 * @wiphy: The wiphy whose name to return
3712 * Return: The name of @wiphy.
3713 */
3714static inline const char *wiphy_name(const struct wiphy *wiphy)
3715{
3716 return dev_name(&wiphy->dev);
3717}
3718
3719/**
3720 * wiphy_new_nm - create a new wiphy for use with cfg80211
3721 *
3722 * @ops: The configuration operations for this device
3723 * @sizeof_priv: The size of the private area to allocate
3724 * @requested_name: Request a particular name.
3725 * NULL is valid value, and means use the default phy%d naming.
3726 *
3727 * Create a new wiphy and associate the given operations with it.
3728 * @sizeof_priv bytes are allocated for private use.
3729 *
3730 * Return: A pointer to the new wiphy. This pointer must be
3731 * assigned to each netdev's ieee80211_ptr for proper operation.
3732 */
3733struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3734 const char *requested_name);
3735
3736/**
3737 * wiphy_new - create a new wiphy for use with cfg80211
3738 *
3739 * @ops: The configuration operations for this device
3740 * @sizeof_priv: The size of the private area to allocate
3741 *
3742 * Create a new wiphy and associate the given operations with it.
3743 * @sizeof_priv bytes are allocated for private use.
3744 *
3745 * Return: A pointer to the new wiphy. This pointer must be
3746 * assigned to each netdev's ieee80211_ptr for proper operation.
3747 */
3748static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3749 int sizeof_priv)
3750{
3751 return wiphy_new_nm(ops, sizeof_priv, NULL);
3752}
3753
3754/**
3755 * wiphy_register - register a wiphy with cfg80211
3756 *
3757 * @wiphy: The wiphy to register.
3758 *
3759 * Return: A non-negative wiphy index or a negative error code.
3760 */
3761int wiphy_register(struct wiphy *wiphy);
3762
3763/**
3764 * wiphy_unregister - deregister a wiphy from cfg80211
3765 *
3766 * @wiphy: The wiphy to unregister.
3767 *
3768 * After this call, no more requests can be made with this priv
3769 * pointer, but the call may sleep to wait for an outstanding
3770 * request that is being handled.
3771 */
3772void wiphy_unregister(struct wiphy *wiphy);
3773
3774/**
3775 * wiphy_free - free wiphy
3776 *
3777 * @wiphy: The wiphy to free
3778 */
3779void wiphy_free(struct wiphy *wiphy);
3780
3781/* internal structs */
3782struct cfg80211_conn;
3783struct cfg80211_internal_bss;
3784struct cfg80211_cached_keys;
3785
3786/**
3787 * struct wireless_dev - wireless device state
3788 *
3789 * For netdevs, this structure must be allocated by the driver
3790 * that uses the ieee80211_ptr field in struct net_device (this
3791 * is intentional so it can be allocated along with the netdev.)
3792 * It need not be registered then as netdev registration will
3793 * be intercepted by cfg80211 to see the new wireless device.
3794 *
3795 * For non-netdev uses, it must also be allocated by the driver
3796 * in response to the cfg80211 callbacks that require it, as
3797 * there's no netdev registration in that case it may not be
3798 * allocated outside of callback operations that return it.
3799 *
3800 * @wiphy: pointer to hardware description
3801 * @iftype: interface type
3802 * @list: (private) Used to collect the interfaces
3803 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3804 * @identifier: (private) Identifier used in nl80211 to identify this
3805 * wireless device if it has no netdev
3806 * @current_bss: (private) Used by the internal configuration code
3807 * @chandef: (private) Used by the internal configuration code to track
3808 * the user-set channel definition.
3809 * @preset_chandef: (private) Used by the internal configuration code to
3810 * track the channel to be used for AP later
3811 * @bssid: (private) Used by the internal configuration code
3812 * @ssid: (private) Used by the internal configuration code
3813 * @ssid_len: (private) Used by the internal configuration code
3814 * @mesh_id_len: (private) Used by the internal configuration code
3815 * @mesh_id_up_len: (private) Used by the internal configuration code
3816 * @wext: (private) Used by the internal wireless extensions compat code
3817 * @use_4addr: indicates 4addr mode is used on this interface, must be
3818 * set by driver (if supported) on add_interface BEFORE registering the
3819 * netdev and may otherwise be used by driver read-only, will be update
3820 * by cfg80211 on change_interface
3821 * @mgmt_registrations: list of registrations for management frames
3822 * @mgmt_registrations_lock: lock for the list
3823 * @mtx: mutex used to lock data in this struct, may be used by drivers
3824 * and some API functions require it held
3825 * @beacon_interval: beacon interval used on this device for transmitting
3826 * beacons, 0 when not valid
3827 * @address: The address for this device, valid only if @netdev is %NULL
3828 * @is_running: true if this is a non-netdev device that has been started, e.g.
3829 * the P2P Device.
3830 * @cac_started: true if DFS channel availability check has been started
3831 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3832 * @cac_time_ms: CAC time in ms
3833 * @ps: powersave mode is enabled
3834 * @ps_timeout: dynamic powersave timeout
3835 * @ap_unexpected_nlportid: (private) netlink port ID of application
3836 * registered for unexpected class 3 frames (AP mode)
3837 * @conn: (private) cfg80211 software SME connection state machine data
3838 * @connect_keys: (private) keys to set after connection is established
3839 * @conn_bss_type: connecting/connected BSS type
3840 * @ibss_fixed: (private) IBSS is using fixed BSSID
3841 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3842 * @event_list: (private) list for internal event processing
3843 * @event_lock: (private) lock for event list
3844 * @owner_nlportid: (private) owner socket port ID
3845 */
3846struct wireless_dev {
3847 struct wiphy *wiphy;
3848 enum nl80211_iftype iftype;
3849
3850 /* the remainder of this struct should be private to cfg80211 */
3851 struct list_head list;
3852 struct net_device *netdev;
3853
3854 u32 identifier;
3855
3856 struct list_head mgmt_registrations;
3857 spinlock_t mgmt_registrations_lock;
3858
3859 struct mutex mtx;
3860
3861 bool use_4addr, is_running;
3862
3863 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3864
3865 /* currently used for IBSS and SME - might be rearranged later */
3866 u8 ssid[IEEE80211_MAX_SSID_LEN];
3867 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3868 struct cfg80211_conn *conn;
3869 struct cfg80211_cached_keys *connect_keys;
3870 enum ieee80211_bss_type conn_bss_type;
3871
3872 struct list_head event_list;
3873 spinlock_t event_lock;
3874
3875 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3876 struct cfg80211_chan_def preset_chandef;
3877 struct cfg80211_chan_def chandef;
3878
3879 bool ibss_fixed;
3880 bool ibss_dfs_possible;
3881
3882 bool ps;
3883 int ps_timeout;
3884
3885 int beacon_interval;
3886
3887 u32 ap_unexpected_nlportid;
3888
3889 bool cac_started;
3890 unsigned long cac_start_time;
3891 unsigned int cac_time_ms;
3892
3893 u32 owner_nlportid;
3894
3895#ifdef CONFIG_CFG80211_WEXT
3896 /* wext data */
3897 struct {
3898 struct cfg80211_ibss_params ibss;
3899 struct cfg80211_connect_params connect;
3900 struct cfg80211_cached_keys *keys;
3901 const u8 *ie;
3902 size_t ie_len;
3903 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3904 u8 ssid[IEEE80211_MAX_SSID_LEN];
3905 s8 default_key, default_mgmt_key;
3906 bool prev_bssid_valid;
3907 } wext;
3908#endif
3909};
3910
3911static inline u8 *wdev_address(struct wireless_dev *wdev)
3912{
3913 if (wdev->netdev)
3914 return wdev->netdev->dev_addr;
3915 return wdev->address;
3916}
3917
3918static inline bool wdev_running(struct wireless_dev *wdev)
3919{
3920 if (wdev->netdev)
3921 return netif_running(wdev->netdev);
3922 return wdev->is_running;
3923}
3924
3925/**
3926 * wdev_priv - return wiphy priv from wireless_dev
3927 *
3928 * @wdev: The wireless device whose wiphy's priv pointer to return
3929 * Return: The wiphy priv of @wdev.
3930 */
3931static inline void *wdev_priv(struct wireless_dev *wdev)
3932{
3933 BUG_ON(!wdev);
3934 return wiphy_priv(wdev->wiphy);
3935}
3936
3937/**
3938 * DOC: Utility functions
3939 *
3940 * cfg80211 offers a number of utility functions that can be useful.
3941 */
3942
3943/**
3944 * ieee80211_channel_to_frequency - convert channel number to frequency
3945 * @chan: channel number
3946 * @band: band, necessary due to channel number overlap
3947 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3948 */
3949int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
3950
3951/**
3952 * ieee80211_frequency_to_channel - convert frequency to channel number
3953 * @freq: center frequency
3954 * Return: The corresponding channel, or 0 if the conversion failed.
3955 */
3956int ieee80211_frequency_to_channel(int freq);
3957
3958/*
3959 * Name indirection necessary because the ieee80211 code also has
3960 * a function named "ieee80211_get_channel", so if you include
3961 * cfg80211's header file you get cfg80211's version, if you try
3962 * to include both header files you'll (rightfully!) get a symbol
3963 * clash.
3964 */
3965struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3966 int freq);
3967/**
3968 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3969 * @wiphy: the struct wiphy to get the channel for
3970 * @freq: the center frequency of the channel
3971 * Return: The channel struct from @wiphy at @freq.
3972 */
3973static inline struct ieee80211_channel *
3974ieee80211_get_channel(struct wiphy *wiphy, int freq)
3975{
3976 return __ieee80211_get_channel(wiphy, freq);
3977}
3978
3979/**
3980 * ieee80211_get_response_rate - get basic rate for a given rate
3981 *
3982 * @sband: the band to look for rates in
3983 * @basic_rates: bitmap of basic rates
3984 * @bitrate: the bitrate for which to find the basic rate
3985 *
3986 * Return: The basic rate corresponding to a given bitrate, that
3987 * is the next lower bitrate contained in the basic rate map,
3988 * which is, for this function, given as a bitmap of indices of
3989 * rates in the band's bitrate table.
3990 */
3991struct ieee80211_rate *
3992ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3993 u32 basic_rates, int bitrate);
3994
3995/**
3996 * ieee80211_mandatory_rates - get mandatory rates for a given band
3997 * @sband: the band to look for rates in
3998 * @scan_width: width of the control channel
3999 *
4000 * This function returns a bitmap of the mandatory rates for the given
4001 * band, bits are set according to the rate position in the bitrates array.
4002 */
4003u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4004 enum nl80211_bss_scan_width scan_width);
4005
4006/*
4007 * Radiotap parsing functions -- for controlled injection support
4008 *
4009 * Implemented in net/wireless/radiotap.c
4010 * Documentation in Documentation/networking/radiotap-headers.txt
4011 */
4012
4013struct radiotap_align_size {
4014 uint8_t align:4, size:4;
4015};
4016
4017struct ieee80211_radiotap_namespace {
4018 const struct radiotap_align_size *align_size;
4019 int n_bits;
4020 uint32_t oui;
4021 uint8_t subns;
4022};
4023
4024struct ieee80211_radiotap_vendor_namespaces {
4025 const struct ieee80211_radiotap_namespace *ns;
4026 int n_ns;
4027};
4028
4029/**
4030 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4031 * @this_arg_index: index of current arg, valid after each successful call
4032 * to ieee80211_radiotap_iterator_next()
4033 * @this_arg: pointer to current radiotap arg; it is valid after each
4034 * call to ieee80211_radiotap_iterator_next() but also after
4035 * ieee80211_radiotap_iterator_init() where it will point to
4036 * the beginning of the actual data portion
4037 * @this_arg_size: length of the current arg, for convenience
4038 * @current_namespace: pointer to the current namespace definition
4039 * (or internally %NULL if the current namespace is unknown)
4040 * @is_radiotap_ns: indicates whether the current namespace is the default
4041 * radiotap namespace or not
4042 *
4043 * @_rtheader: pointer to the radiotap header we are walking through
4044 * @_max_length: length of radiotap header in cpu byte ordering
4045 * @_arg_index: next argument index
4046 * @_arg: next argument pointer
4047 * @_next_bitmap: internal pointer to next present u32
4048 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4049 * @_vns: vendor namespace definitions
4050 * @_next_ns_data: beginning of the next namespace's data
4051 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4052 * next bitmap word
4053 *
4054 * Describes the radiotap parser state. Fields prefixed with an underscore
4055 * must not be used by users of the parser, only by the parser internally.
4056 */
4057
4058struct ieee80211_radiotap_iterator {
4059 struct ieee80211_radiotap_header *_rtheader;
4060 const struct ieee80211_radiotap_vendor_namespaces *_vns;
4061 const struct ieee80211_radiotap_namespace *current_namespace;
4062
4063 unsigned char *_arg, *_next_ns_data;
4064 __le32 *_next_bitmap;
4065
4066 unsigned char *this_arg;
4067 int this_arg_index;
4068 int this_arg_size;
4069
4070 int is_radiotap_ns;
4071
4072 int _max_length;
4073 int _arg_index;
4074 uint32_t _bitmap_shifter;
4075 int _reset_on_ext;
4076};
4077
4078int
4079ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
4080 struct ieee80211_radiotap_header *radiotap_header,
4081 int max_length,
4082 const struct ieee80211_radiotap_vendor_namespaces *vns);
4083
4084int
4085ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
4086
4087
4088extern const unsigned char rfc1042_header[6];
4089extern const unsigned char bridge_tunnel_header[6];
4090
4091/**
4092 * ieee80211_get_hdrlen_from_skb - get header length from data
4093 *
4094 * @skb: the frame
4095 *
4096 * Given an skb with a raw 802.11 header at the data pointer this function
4097 * returns the 802.11 header length.
4098 *
4099 * Return: The 802.11 header length in bytes (not including encryption
4100 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4101 * 802.11 header.
4102 */
4103unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
4104
4105/**
4106 * ieee80211_hdrlen - get header length in bytes from frame control
4107 * @fc: frame control field in little-endian format
4108 * Return: The header length in bytes.
4109 */
4110unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
4111
4112/**
4113 * ieee80211_get_mesh_hdrlen - get mesh extension header length
4114 * @meshhdr: the mesh extension header, only the flags field
4115 * (first byte) will be accessed
4116 * Return: The length of the extension header, which is always at
4117 * least 6 bytes and at most 18 if address 5 and 6 are present.
4118 */
4119unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
4120
4121/**
4122 * DOC: Data path helpers
4123 *
4124 * In addition to generic utilities, cfg80211 also offers
4125 * functions that help implement the data path for devices
4126 * that do not do the 802.11/802.3 conversion on the device.
4127 */
4128
4129/**
4130 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4131 * @skb: the 802.11 data frame
4132 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4133 * of it being pushed into the SKB
4134 * @addr: the device MAC address
4135 * @iftype: the virtual interface type
4136 * Return: 0 on success. Non-zero on error.
4137 */
4138int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
4139 const u8 *addr, enum nl80211_iftype iftype);
4140
4141/**
4142 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4143 * @skb: the 802.11 data frame
4144 * @addr: the device MAC address
4145 * @iftype: the virtual interface type
4146 * Return: 0 on success. Non-zero on error.
4147 */
4148static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
4149 enum nl80211_iftype iftype)
4150{
4151 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype);
4152}
4153
4154/**
4155 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
4156 * @skb: the 802.3 frame
4157 * @addr: the device MAC address
4158 * @iftype: the virtual interface type
4159 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
4160 * @qos: build 802.11 QoS data frame
4161 * Return: 0 on success, or a negative error code.
4162 */
4163int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
4164 enum nl80211_iftype iftype, const u8 *bssid,
4165 bool qos);
4166
4167/**
4168 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
4169 *
4170 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
4171 * The @list will be empty if the decode fails. The @skb must be fully
4172 * header-less before being passed in here; it is freed in this function.
4173 *
4174 * @skb: The input A-MSDU frame without any headers.
4175 * @list: The output list of 802.3 frames. It must be allocated and
4176 * initialized by by the caller.
4177 * @addr: The device MAC address.
4178 * @iftype: The device interface type.
4179 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
4180 * @check_da: DA to check in the inner ethernet header, or NULL
4181 * @check_sa: SA to check in the inner ethernet header, or NULL
4182 */
4183void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
4184 const u8 *addr, enum nl80211_iftype iftype,
4185 const unsigned int extra_headroom,
4186 const u8 *check_da, const u8 *check_sa);
4187
4188/**
4189 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
4190 * @skb: the data frame
4191 * @qos_map: Interworking QoS mapping or %NULL if not in use
4192 * Return: The 802.1p/1d tag.
4193 */
4194unsigned int cfg80211_classify8021d(struct sk_buff *skb,
4195 struct cfg80211_qos_map *qos_map);
4196
4197/**
4198 * cfg80211_find_ie_match - match information element and byte array in data
4199 *
4200 * @eid: element ID
4201 * @ies: data consisting of IEs
4202 * @len: length of data
4203 * @match: byte array to match
4204 * @match_len: number of bytes in the match array
4205 * @match_offset: offset in the IE where the byte array should match.
4206 * If match_len is zero, this must also be set to zero.
4207 * Otherwise this must be set to 2 or more, because the first
4208 * byte is the element id, which is already compared to eid, and
4209 * the second byte is the IE length.
4210 *
4211 * Return: %NULL if the element ID could not be found or if
4212 * the element is invalid (claims to be longer than the given
4213 * data) or if the byte array doesn't match, or a pointer to the first
4214 * byte of the requested element, that is the byte containing the
4215 * element ID.
4216 *
4217 * Note: There are no checks on the element length other than
4218 * having to fit into the given data and being large enough for the
4219 * byte array to match.
4220 */
4221const u8 *cfg80211_find_ie_match(u8 eid, const u8 *ies, int len,
4222 const u8 *match, int match_len,
4223 int match_offset);
4224
4225/**
4226 * cfg80211_find_ie - find information element in data
4227 *
4228 * @eid: element ID
4229 * @ies: data consisting of IEs
4230 * @len: length of data
4231 *
4232 * Return: %NULL if the element ID could not be found or if
4233 * the element is invalid (claims to be longer than the given
4234 * data), or a pointer to the first byte of the requested
4235 * element, that is the byte containing the element ID.
4236 *
4237 * Note: There are no checks on the element length other than
4238 * having to fit into the given data.
4239 */
4240static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
4241{
4242 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
4243}
4244
4245/**
4246 * cfg80211_find_ext_ie - find information element with EID Extension in data
4247 *
4248 * @ext_eid: element ID Extension
4249 * @ies: data consisting of IEs
4250 * @len: length of data
4251 *
4252 * Return: %NULL if the extended element ID could not be found or if
4253 * the element is invalid (claims to be longer than the given
4254 * data), or a pointer to the first byte of the requested
4255 * element, that is the byte containing the element ID.
4256 *
4257 * Note: There are no checks on the element length other than
4258 * having to fit into the given data.
4259 */
4260static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
4261{
4262 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
4263 &ext_eid, 1, 2);
4264}
4265
4266/**
4267 * cfg80211_find_vendor_ie - find vendor specific information element in data
4268 *
4269 * @oui: vendor OUI
4270 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
4271 * @ies: data consisting of IEs
4272 * @len: length of data
4273 *
4274 * Return: %NULL if the vendor specific element ID could not be found or if the
4275 * element is invalid (claims to be longer than the given data), or a pointer to
4276 * the first byte of the requested element, that is the byte containing the
4277 * element ID.
4278 *
4279 * Note: There are no checks on the element length other than having to fit into
4280 * the given data.
4281 */
4282const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
4283 const u8 *ies, int len);
4284
4285/**
4286 * DOC: Regulatory enforcement infrastructure
4287 *
4288 * TODO
4289 */
4290
4291/**
4292 * regulatory_hint - driver hint to the wireless core a regulatory domain
4293 * @wiphy: the wireless device giving the hint (used only for reporting
4294 * conflicts)
4295 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4296 * should be in. If @rd is set this should be NULL. Note that if you
4297 * set this to NULL you should still set rd->alpha2 to some accepted
4298 * alpha2.
4299 *
4300 * Wireless drivers can use this function to hint to the wireless core
4301 * what it believes should be the current regulatory domain by
4302 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4303 * domain should be in or by providing a completely build regulatory domain.
4304 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4305 * for a regulatory domain structure for the respective country.
4306 *
4307 * The wiphy must have been registered to cfg80211 prior to this call.
4308 * For cfg80211 drivers this means you must first use wiphy_register(),
4309 * for mac80211 drivers you must first use ieee80211_register_hw().
4310 *
4311 * Drivers should check the return value, its possible you can get
4312 * an -ENOMEM.
4313 *
4314 * Return: 0 on success. -ENOMEM.
4315 */
4316int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4317
4318/**
4319 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4320 * @wiphy: the wireless device we want to process the regulatory domain on
4321 * @rd: the regulatory domain informatoin to use for this wiphy
4322 *
4323 * Set the regulatory domain information for self-managed wiphys, only they
4324 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4325 * information.
4326 *
4327 * Return: 0 on success. -EINVAL, -EPERM
4328 */
4329int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4330 struct ieee80211_regdomain *rd);
4331
4332/**
4333 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4334 * @wiphy: the wireless device we want to process the regulatory domain on
4335 * @rd: the regulatory domain information to use for this wiphy
4336 *
4337 * This functions requires the RTNL to be held and applies the new regdomain
4338 * synchronously to this wiphy. For more details see
4339 * regulatory_set_wiphy_regd().
4340 *
4341 * Return: 0 on success. -EINVAL, -EPERM
4342 */
4343int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4344 struct ieee80211_regdomain *rd);
4345
4346/**
4347 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4348 * @wiphy: the wireless device we want to process the regulatory domain on
4349 * @regd: the custom regulatory domain to use for this wiphy
4350 *
4351 * Drivers can sometimes have custom regulatory domains which do not apply
4352 * to a specific country. Drivers can use this to apply such custom regulatory
4353 * domains. This routine must be called prior to wiphy registration. The
4354 * custom regulatory domain will be trusted completely and as such previous
4355 * default channel settings will be disregarded. If no rule is found for a
4356 * channel on the regulatory domain the channel will be disabled.
4357 * Drivers using this for a wiphy should also set the wiphy flag
4358 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4359 * that called this helper.
4360 */
4361void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4362 const struct ieee80211_regdomain *regd);
4363
4364/**
4365 * freq_reg_info - get regulatory information for the given frequency
4366 * @wiphy: the wiphy for which we want to process this rule for
4367 * @center_freq: Frequency in KHz for which we want regulatory information for
4368 *
4369 * Use this function to get the regulatory rule for a specific frequency on
4370 * a given wireless device. If the device has a specific regulatory domain
4371 * it wants to follow we respect that unless a country IE has been received
4372 * and processed already.
4373 *
4374 * Return: A valid pointer, or, when an error occurs, for example if no rule
4375 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4376 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4377 * value will be -ERANGE if we determine the given center_freq does not even
4378 * have a regulatory rule for a frequency range in the center_freq's band.
4379 * See freq_in_rule_band() for our current definition of a band -- this is
4380 * purely subjective and right now it's 802.11 specific.
4381 */
4382const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4383 u32 center_freq);
4384
4385/**
4386 * reg_initiator_name - map regulatory request initiator enum to name
4387 * @initiator: the regulatory request initiator
4388 *
4389 * You can use this to map the regulatory request initiator enum to a
4390 * proper string representation.
4391 */
4392const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4393
4394/*
4395 * callbacks for asynchronous cfg80211 methods, notification
4396 * functions and BSS handling helpers
4397 */
4398
4399/**
4400 * cfg80211_scan_done - notify that scan finished
4401 *
4402 * @request: the corresponding scan request
4403 * @info: information about the completed scan
4404 */
4405void cfg80211_scan_done(struct cfg80211_scan_request *request,
4406 struct cfg80211_scan_info *info);
4407
4408/**
4409 * cfg80211_sched_scan_results - notify that new scan results are available
4410 *
4411 * @wiphy: the wiphy which got scheduled scan results
4412 */
4413void cfg80211_sched_scan_results(struct wiphy *wiphy);
4414
4415/**
4416 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4417 *
4418 * @wiphy: the wiphy on which the scheduled scan stopped
4419 *
4420 * The driver can call this function to inform cfg80211 that the
4421 * scheduled scan had to be stopped, for whatever reason. The driver
4422 * is then called back via the sched_scan_stop operation when done.
4423 */
4424void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
4425
4426/**
4427 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4428 *
4429 * @wiphy: the wiphy on which the scheduled scan stopped
4430 *
4431 * The driver can call this function to inform cfg80211 that the
4432 * scheduled scan had to be stopped, for whatever reason. The driver
4433 * is then called back via the sched_scan_stop operation when done.
4434 * This function should be called with rtnl locked.
4435 */
4436void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
4437
4438/**
4439 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4440 * @wiphy: the wiphy reporting the BSS
4441 * @data: the BSS metadata
4442 * @mgmt: the management frame (probe response or beacon)
4443 * @len: length of the management frame
4444 * @gfp: context flags
4445 *
4446 * This informs cfg80211 that BSS information was found and
4447 * the BSS should be updated/added.
4448 *
4449 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4450 * Or %NULL on error.
4451 */
4452struct cfg80211_bss * __must_check
4453cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4454 struct cfg80211_inform_bss *data,
4455 struct ieee80211_mgmt *mgmt, size_t len,
4456 gfp_t gfp);
4457
4458static inline struct cfg80211_bss * __must_check
4459cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4460 struct ieee80211_channel *rx_channel,
4461 enum nl80211_bss_scan_width scan_width,
4462 struct ieee80211_mgmt *mgmt, size_t len,
4463 s32 signal, gfp_t gfp)
4464{
4465 struct cfg80211_inform_bss data = {
4466 .chan = rx_channel,
4467 .scan_width = scan_width,
4468 .signal = signal,
4469 };
4470
4471 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4472}
4473
4474static inline struct cfg80211_bss * __must_check
4475cfg80211_inform_bss_frame(struct wiphy *wiphy,
4476 struct ieee80211_channel *rx_channel,
4477 struct ieee80211_mgmt *mgmt, size_t len,
4478 s32 signal, gfp_t gfp)
4479{
4480 struct cfg80211_inform_bss data = {
4481 .chan = rx_channel,
4482 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4483 .signal = signal,
4484 };
4485
4486 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4487}
4488
4489/**
4490 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4491 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4492 * from a beacon or probe response
4493 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4494 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4495 */
4496enum cfg80211_bss_frame_type {
4497 CFG80211_BSS_FTYPE_UNKNOWN,
4498 CFG80211_BSS_FTYPE_BEACON,
4499 CFG80211_BSS_FTYPE_PRESP,
4500};
4501
4502/**
4503 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4504 *
4505 * @wiphy: the wiphy reporting the BSS
4506 * @data: the BSS metadata
4507 * @ftype: frame type (if known)
4508 * @bssid: the BSSID of the BSS
4509 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4510 * @capability: the capability field sent by the peer
4511 * @beacon_interval: the beacon interval announced by the peer
4512 * @ie: additional IEs sent by the peer
4513 * @ielen: length of the additional IEs
4514 * @gfp: context flags
4515 *
4516 * This informs cfg80211 that BSS information was found and
4517 * the BSS should be updated/added.
4518 *
4519 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4520 * Or %NULL on error.
4521 */
4522struct cfg80211_bss * __must_check
4523cfg80211_inform_bss_data(struct wiphy *wiphy,
4524 struct cfg80211_inform_bss *data,
4525 enum cfg80211_bss_frame_type ftype,
4526 const u8 *bssid, u64 tsf, u16 capability,
4527 u16 beacon_interval, const u8 *ie, size_t ielen,
4528 gfp_t gfp);
4529
4530static inline struct cfg80211_bss * __must_check
4531cfg80211_inform_bss_width(struct wiphy *wiphy,
4532 struct ieee80211_channel *rx_channel,
4533 enum nl80211_bss_scan_width scan_width,
4534 enum cfg80211_bss_frame_type ftype,
4535 const u8 *bssid, u64 tsf, u16 capability,
4536 u16 beacon_interval, const u8 *ie, size_t ielen,
4537 s32 signal, gfp_t gfp)
4538{
4539 struct cfg80211_inform_bss data = {
4540 .chan = rx_channel,
4541 .scan_width = scan_width,
4542 .signal = signal,
4543 };
4544
4545 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4546 capability, beacon_interval, ie, ielen,
4547 gfp);
4548}
4549
4550static inline struct cfg80211_bss * __must_check
4551cfg80211_inform_bss(struct wiphy *wiphy,
4552 struct ieee80211_channel *rx_channel,
4553 enum cfg80211_bss_frame_type ftype,
4554 const u8 *bssid, u64 tsf, u16 capability,
4555 u16 beacon_interval, const u8 *ie, size_t ielen,
4556 s32 signal, gfp_t gfp)
4557{
4558 struct cfg80211_inform_bss data = {
4559 .chan = rx_channel,
4560 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4561 .signal = signal,
4562 };
4563
4564 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4565 capability, beacon_interval, ie, ielen,
4566 gfp);
4567}
4568
4569struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4570 struct ieee80211_channel *channel,
4571 const u8 *bssid,
4572 const u8 *ssid, size_t ssid_len,
4573 enum ieee80211_bss_type bss_type,
4574 enum ieee80211_privacy);
4575static inline struct cfg80211_bss *
4576cfg80211_get_ibss(struct wiphy *wiphy,
4577 struct ieee80211_channel *channel,
4578 const u8 *ssid, size_t ssid_len)
4579{
4580 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4581 IEEE80211_BSS_TYPE_IBSS,
4582 IEEE80211_PRIVACY_ANY);
4583}
4584
4585/**
4586 * cfg80211_ref_bss - reference BSS struct
4587 * @wiphy: the wiphy this BSS struct belongs to
4588 * @bss: the BSS struct to reference
4589 *
4590 * Increments the refcount of the given BSS struct.
4591 */
4592void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4593
4594/**
4595 * cfg80211_put_bss - unref BSS struct
4596 * @wiphy: the wiphy this BSS struct belongs to
4597 * @bss: the BSS struct
4598 *
4599 * Decrements the refcount of the given BSS struct.
4600 */
4601void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4602
4603/**
4604 * cfg80211_unlink_bss - unlink BSS from internal data structures
4605 * @wiphy: the wiphy
4606 * @bss: the bss to remove
4607 *
4608 * This function removes the given BSS from the internal data structures
4609 * thereby making it no longer show up in scan results etc. Use this
4610 * function when you detect a BSS is gone. Normally BSSes will also time
4611 * out, so it is not necessary to use this function at all.
4612 */
4613void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4614
4615static inline enum nl80211_bss_scan_width
4616cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4617{
4618 switch (chandef->width) {
4619 case NL80211_CHAN_WIDTH_5:
4620 return NL80211_BSS_CHAN_WIDTH_5;
4621 case NL80211_CHAN_WIDTH_10:
4622 return NL80211_BSS_CHAN_WIDTH_10;
4623 default:
4624 return NL80211_BSS_CHAN_WIDTH_20;
4625 }
4626}
4627
4628/**
4629 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4630 * @dev: network device
4631 * @buf: authentication frame (header + body)
4632 * @len: length of the frame data
4633 *
4634 * This function is called whenever an authentication, disassociation or
4635 * deauthentication frame has been received and processed in station mode.
4636 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4637 * call either this function or cfg80211_auth_timeout().
4638 * After being asked to associate via cfg80211_ops::assoc() the driver must
4639 * call either this function or cfg80211_auth_timeout().
4640 * While connected, the driver must calls this for received and processed
4641 * disassociation and deauthentication frames. If the frame couldn't be used
4642 * because it was unprotected, the driver must call the function
4643 * cfg80211_rx_unprot_mlme_mgmt() instead.
4644 *
4645 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4646 */
4647void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4648
4649/**
4650 * cfg80211_auth_timeout - notification of timed out authentication
4651 * @dev: network device
4652 * @addr: The MAC address of the device with which the authentication timed out
4653 *
4654 * This function may sleep. The caller must hold the corresponding wdev's
4655 * mutex.
4656 */
4657void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4658
4659/**
4660 * cfg80211_rx_assoc_resp - notification of processed association response
4661 * @dev: network device
4662 * @bss: the BSS that association was requested with, ownership of the pointer
4663 * moves to cfg80211 in this call
4664 * @buf: authentication frame (header + body)
4665 * @len: length of the frame data
4666 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
4667 * as the AC bitmap in the QoS info field
4668 *
4669 * After being asked to associate via cfg80211_ops::assoc() the driver must
4670 * call either this function or cfg80211_auth_timeout().
4671 *
4672 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4673 */
4674void cfg80211_rx_assoc_resp(struct net_device *dev,
4675 struct cfg80211_bss *bss,
4676 const u8 *buf, size_t len,
4677 int uapsd_queues);
4678
4679/**
4680 * cfg80211_assoc_timeout - notification of timed out association
4681 * @dev: network device
4682 * @bss: The BSS entry with which association timed out.
4683 *
4684 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4685 */
4686void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4687
4688/**
4689 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
4690 * @dev: network device
4691 * @bss: The BSS entry with which association was abandoned.
4692 *
4693 * Call this whenever - for reasons reported through other API, like deauth RX,
4694 * an association attempt was abandoned.
4695 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4696 */
4697void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
4698
4699/**
4700 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4701 * @dev: network device
4702 * @buf: 802.11 frame (header + body)
4703 * @len: length of the frame data
4704 *
4705 * This function is called whenever deauthentication has been processed in
4706 * station mode. This includes both received deauthentication frames and
4707 * locally generated ones. This function may sleep. The caller must hold the
4708 * corresponding wdev's mutex.
4709 */
4710void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4711
4712/**
4713 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4714 * @dev: network device
4715 * @buf: deauthentication frame (header + body)
4716 * @len: length of the frame data
4717 *
4718 * This function is called whenever a received deauthentication or dissassoc
4719 * frame has been dropped in station mode because of MFP being used but the
4720 * frame was not protected. This function may sleep.
4721 */
4722void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4723 const u8 *buf, size_t len);
4724
4725/**
4726 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4727 * @dev: network device
4728 * @addr: The source MAC address of the frame
4729 * @key_type: The key type that the received frame used
4730 * @key_id: Key identifier (0..3). Can be -1 if missing.
4731 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4732 * @gfp: allocation flags
4733 *
4734 * This function is called whenever the local MAC detects a MIC failure in a
4735 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4736 * primitive.
4737 */
4738void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4739 enum nl80211_key_type key_type, int key_id,
4740 const u8 *tsc, gfp_t gfp);
4741
4742/**
4743 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4744 *
4745 * @dev: network device
4746 * @bssid: the BSSID of the IBSS joined
4747 * @channel: the channel of the IBSS joined
4748 * @gfp: allocation flags
4749 *
4750 * This function notifies cfg80211 that the device joined an IBSS or
4751 * switched to a different BSSID. Before this function can be called,
4752 * either a beacon has to have been received from the IBSS, or one of
4753 * the cfg80211_inform_bss{,_frame} functions must have been called
4754 * with the locally generated beacon -- this guarantees that there is
4755 * always a scan result for this IBSS. cfg80211 will handle the rest.
4756 */
4757void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4758 struct ieee80211_channel *channel, gfp_t gfp);
4759
4760/**
4761 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4762 *
4763 * @dev: network device
4764 * @macaddr: the MAC address of the new candidate
4765 * @ie: information elements advertised by the peer candidate
4766 * @ie_len: lenght of the information elements buffer
4767 * @gfp: allocation flags
4768 *
4769 * This function notifies cfg80211 that the mesh peer candidate has been
4770 * detected, most likely via a beacon or, less likely, via a probe response.
4771 * cfg80211 then sends a notification to userspace.
4772 */
4773void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4774 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4775
4776/**
4777 * DOC: RFkill integration
4778 *
4779 * RFkill integration in cfg80211 is almost invisible to drivers,
4780 * as cfg80211 automatically registers an rfkill instance for each
4781 * wireless device it knows about. Soft kill is also translated
4782 * into disconnecting and turning all interfaces off, drivers are
4783 * expected to turn off the device when all interfaces are down.
4784 *
4785 * However, devices may have a hard RFkill line, in which case they
4786 * also need to interact with the rfkill subsystem, via cfg80211.
4787 * They can do this with a few helper functions documented here.
4788 */
4789
4790/**
4791 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4792 * @wiphy: the wiphy
4793 * @blocked: block status
4794 */
4795void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4796
4797/**
4798 * wiphy_rfkill_start_polling - start polling rfkill
4799 * @wiphy: the wiphy
4800 */
4801void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4802
4803/**
4804 * wiphy_rfkill_stop_polling - stop polling rfkill
4805 * @wiphy: the wiphy
4806 */
4807void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4808
4809/**
4810 * DOC: Vendor commands
4811 *
4812 * Occasionally, there are special protocol or firmware features that
4813 * can't be implemented very openly. For this and similar cases, the
4814 * vendor command functionality allows implementing the features with
4815 * (typically closed-source) userspace and firmware, using nl80211 as
4816 * the configuration mechanism.
4817 *
4818 * A driver supporting vendor commands must register them as an array
4819 * in struct wiphy, with handlers for each one, each command has an
4820 * OUI and sub command ID to identify it.
4821 *
4822 * Note that this feature should not be (ab)used to implement protocol
4823 * features that could openly be shared across drivers. In particular,
4824 * it must never be required to use vendor commands to implement any
4825 * "normal" functionality that higher-level userspace like connection
4826 * managers etc. need.
4827 */
4828
4829struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4830 enum nl80211_commands cmd,
4831 enum nl80211_attrs attr,
4832 int approxlen);
4833
4834struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4835 struct wireless_dev *wdev,
4836 enum nl80211_commands cmd,
4837 enum nl80211_attrs attr,
4838 int vendor_event_idx,
4839 int approxlen, gfp_t gfp);
4840
4841void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4842
4843/**
4844 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4845 * @wiphy: the wiphy
4846 * @approxlen: an upper bound of the length of the data that will
4847 * be put into the skb
4848 *
4849 * This function allocates and pre-fills an skb for a reply to
4850 * a vendor command. Since it is intended for a reply, calling
4851 * it outside of a vendor command's doit() operation is invalid.
4852 *
4853 * The returned skb is pre-filled with some identifying data in
4854 * a way that any data that is put into the skb (with skb_put(),
4855 * nla_put() or similar) will end up being within the
4856 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4857 * with the skb is adding data for the corresponding userspace tool
4858 * which can then read that data out of the vendor data attribute.
4859 * You must not modify the skb in any other way.
4860 *
4861 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4862 * its error code as the result of the doit() operation.
4863 *
4864 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4865 */
4866static inline struct sk_buff *
4867cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4868{
4869 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4870 NL80211_ATTR_VENDOR_DATA, approxlen);
4871}
4872
4873/**
4874 * cfg80211_vendor_cmd_reply - send the reply skb
4875 * @skb: The skb, must have been allocated with
4876 * cfg80211_vendor_cmd_alloc_reply_skb()
4877 *
4878 * Since calling this function will usually be the last thing
4879 * before returning from the vendor command doit() you should
4880 * return the error code. Note that this function consumes the
4881 * skb regardless of the return value.
4882 *
4883 * Return: An error code or 0 on success.
4884 */
4885int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4886
4887/**
4888 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4889 * @wiphy: the wiphy
4890 * @wdev: the wireless device
4891 * @event_idx: index of the vendor event in the wiphy's vendor_events
4892 * @approxlen: an upper bound of the length of the data that will
4893 * be put into the skb
4894 * @gfp: allocation flags
4895 *
4896 * This function allocates and pre-fills an skb for an event on the
4897 * vendor-specific multicast group.
4898 *
4899 * If wdev != NULL, both the ifindex and identifier of the specified
4900 * wireless device are added to the event message before the vendor data
4901 * attribute.
4902 *
4903 * When done filling the skb, call cfg80211_vendor_event() with the
4904 * skb to send the event.
4905 *
4906 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4907 */
4908static inline struct sk_buff *
4909cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4910 int approxlen, int event_idx, gfp_t gfp)
4911{
4912 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4913 NL80211_ATTR_VENDOR_DATA,
4914 event_idx, approxlen, gfp);
4915}
4916
4917/**
4918 * cfg80211_vendor_event - send the event
4919 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4920 * @gfp: allocation flags
4921 *
4922 * This function sends the given @skb, which must have been allocated
4923 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4924 */
4925static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4926{
4927 __cfg80211_send_event_skb(skb, gfp);
4928}
4929
4930#ifdef CONFIG_NL80211_TESTMODE
4931/**
4932 * DOC: Test mode
4933 *
4934 * Test mode is a set of utility functions to allow drivers to
4935 * interact with driver-specific tools to aid, for instance,
4936 * factory programming.
4937 *
4938 * This chapter describes how drivers interact with it, for more
4939 * information see the nl80211 book's chapter on it.
4940 */
4941
4942/**
4943 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4944 * @wiphy: the wiphy
4945 * @approxlen: an upper bound of the length of the data that will
4946 * be put into the skb
4947 *
4948 * This function allocates and pre-fills an skb for a reply to
4949 * the testmode command. Since it is intended for a reply, calling
4950 * it outside of the @testmode_cmd operation is invalid.
4951 *
4952 * The returned skb is pre-filled with the wiphy index and set up in
4953 * a way that any data that is put into the skb (with skb_put(),
4954 * nla_put() or similar) will end up being within the
4955 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4956 * with the skb is adding data for the corresponding userspace tool
4957 * which can then read that data out of the testdata attribute. You
4958 * must not modify the skb in any other way.
4959 *
4960 * When done, call cfg80211_testmode_reply() with the skb and return
4961 * its error code as the result of the @testmode_cmd operation.
4962 *
4963 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4964 */
4965static inline struct sk_buff *
4966cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4967{
4968 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4969 NL80211_ATTR_TESTDATA, approxlen);
4970}
4971
4972/**
4973 * cfg80211_testmode_reply - send the reply skb
4974 * @skb: The skb, must have been allocated with
4975 * cfg80211_testmode_alloc_reply_skb()
4976 *
4977 * Since calling this function will usually be the last thing
4978 * before returning from the @testmode_cmd you should return
4979 * the error code. Note that this function consumes the skb
4980 * regardless of the return value.
4981 *
4982 * Return: An error code or 0 on success.
4983 */
4984static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4985{
4986 return cfg80211_vendor_cmd_reply(skb);
4987}
4988
4989/**
4990 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4991 * @wiphy: the wiphy
4992 * @approxlen: an upper bound of the length of the data that will
4993 * be put into the skb
4994 * @gfp: allocation flags
4995 *
4996 * This function allocates and pre-fills an skb for an event on the
4997 * testmode multicast group.
4998 *
4999 * The returned skb is set up in the same way as with
5000 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
5001 * there, you should simply add data to it that will then end up in the
5002 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
5003 * in any other way.
5004 *
5005 * When done filling the skb, call cfg80211_testmode_event() with the
5006 * skb to send the event.
5007 *
5008 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5009 */
5010static inline struct sk_buff *
5011cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
5012{
5013 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
5014 NL80211_ATTR_TESTDATA, -1,
5015 approxlen, gfp);
5016}
5017
5018/**
5019 * cfg80211_testmode_event - send the event
5020 * @skb: The skb, must have been allocated with
5021 * cfg80211_testmode_alloc_event_skb()
5022 * @gfp: allocation flags
5023 *
5024 * This function sends the given @skb, which must have been allocated
5025 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
5026 * consumes it.
5027 */
5028static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
5029{
5030 __cfg80211_send_event_skb(skb, gfp);
5031}
5032
5033#define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
5034#define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
5035#else
5036#define CFG80211_TESTMODE_CMD(cmd)
5037#define CFG80211_TESTMODE_DUMP(cmd)
5038#endif
5039
5040/**
5041 * cfg80211_connect_bss - notify cfg80211 of connection result
5042 *
5043 * @dev: network device
5044 * @bssid: the BSSID of the AP
5045 * @bss: entry of bss to which STA got connected to, can be obtained
5046 * through cfg80211_get_bss (may be %NULL)
5047 * @req_ie: association request IEs (maybe be %NULL)
5048 * @req_ie_len: association request IEs length
5049 * @resp_ie: association response IEs (may be %NULL)
5050 * @resp_ie_len: assoc response IEs length
5051 * @status: status code, 0 for successful connection, use
5052 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5053 * the real status code for failures.
5054 * @gfp: allocation flags
5055 *
5056 * It should be called by the underlying driver whenever connect() has
5057 * succeeded. This is similar to cfg80211_connect_result(), but with the
5058 * option of identifying the exact bss entry for the connection. Only one of
5059 * these functions should be called.
5060 */
5061void cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
5062 struct cfg80211_bss *bss, const u8 *req_ie,
5063 size_t req_ie_len, const u8 *resp_ie,
5064 size_t resp_ie_len, int status, gfp_t gfp);
5065
5066/**
5067 * cfg80211_connect_result - notify cfg80211 of connection result
5068 *
5069 * @dev: network device
5070 * @bssid: the BSSID of the AP
5071 * @req_ie: association request IEs (maybe be %NULL)
5072 * @req_ie_len: association request IEs length
5073 * @resp_ie: association response IEs (may be %NULL)
5074 * @resp_ie_len: assoc response IEs length
5075 * @status: status code, 0 for successful connection, use
5076 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5077 * the real status code for failures.
5078 * @gfp: allocation flags
5079 *
5080 * It should be called by the underlying driver whenever connect() has
5081 * succeeded.
5082 */
5083static inline void
5084cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
5085 const u8 *req_ie, size_t req_ie_len,
5086 const u8 *resp_ie, size_t resp_ie_len,
5087 u16 status, gfp_t gfp)
5088{
5089 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
5090 resp_ie_len, status, gfp);
5091}
5092
5093/**
5094 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
5095 *
5096 * @dev: network device
5097 * @bssid: the BSSID of the AP
5098 * @req_ie: association request IEs (maybe be %NULL)
5099 * @req_ie_len: association request IEs length
5100 * @gfp: allocation flags
5101 *
5102 * It should be called by the underlying driver whenever connect() has failed
5103 * in a sequence where no explicit authentication/association rejection was
5104 * received from the AP. This could happen, e.g., due to not being able to send
5105 * out the Authentication or Association Request frame or timing out while
5106 * waiting for the response.
5107 */
5108static inline void
5109cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
5110 const u8 *req_ie, size_t req_ie_len, gfp_t gfp)
5111{
5112 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
5113 gfp);
5114}
5115
5116/**
5117 * cfg80211_roamed - notify cfg80211 of roaming
5118 *
5119 * @dev: network device
5120 * @channel: the channel of the new AP
5121 * @bssid: the BSSID of the new AP
5122 * @req_ie: association request IEs (maybe be %NULL)
5123 * @req_ie_len: association request IEs length
5124 * @resp_ie: association response IEs (may be %NULL)
5125 * @resp_ie_len: assoc response IEs length
5126 * @gfp: allocation flags
5127 *
5128 * It should be called by the underlying driver whenever it roamed
5129 * from one AP to another while connected.
5130 */
5131void cfg80211_roamed(struct net_device *dev,
5132 struct ieee80211_channel *channel,
5133 const u8 *bssid,
5134 const u8 *req_ie, size_t req_ie_len,
5135 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
5136
5137/**
5138 * cfg80211_roamed_bss - notify cfg80211 of roaming
5139 *
5140 * @dev: network device
5141 * @bss: entry of bss to which STA got roamed
5142 * @req_ie: association request IEs (maybe be %NULL)
5143 * @req_ie_len: association request IEs length
5144 * @resp_ie: association response IEs (may be %NULL)
5145 * @resp_ie_len: assoc response IEs length
5146 * @gfp: allocation flags
5147 *
5148 * This is just a wrapper to notify cfg80211 of roaming event with driver
5149 * passing bss to avoid a race in timeout of the bss entry. It should be
5150 * called by the underlying driver whenever it roamed from one AP to another
5151 * while connected. Drivers which have roaming implemented in firmware
5152 * may use this function to avoid a race in bss entry timeout where the bss
5153 * entry of the new AP is seen in the driver, but gets timed out by the time
5154 * it is accessed in __cfg80211_roamed() due to delay in scheduling
5155 * rdev->event_work. In case of any failures, the reference is released
5156 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
5157 * it will be released while diconneting from the current bss.
5158 */
5159void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
5160 const u8 *req_ie, size_t req_ie_len,
5161 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
5162
5163/**
5164 * cfg80211_disconnected - notify cfg80211 that connection was dropped
5165 *
5166 * @dev: network device
5167 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
5168 * @ie_len: length of IEs
5169 * @reason: reason code for the disconnection, set it to 0 if unknown
5170 * @locally_generated: disconnection was requested locally
5171 * @gfp: allocation flags
5172 *
5173 * After it calls this function, the driver should enter an idle state
5174 * and not try to connect to any AP any more.
5175 */
5176void cfg80211_disconnected(struct net_device *dev, u16 reason,
5177 const u8 *ie, size_t ie_len,
5178 bool locally_generated, gfp_t gfp);
5179
5180/**
5181 * cfg80211_ready_on_channel - notification of remain_on_channel start
5182 * @wdev: wireless device
5183 * @cookie: the request cookie
5184 * @chan: The current channel (from remain_on_channel request)
5185 * @duration: Duration in milliseconds that the driver intents to remain on the
5186 * channel
5187 * @gfp: allocation flags
5188 */
5189void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
5190 struct ieee80211_channel *chan,
5191 unsigned int duration, gfp_t gfp);
5192
5193/**
5194 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
5195 * @wdev: wireless device
5196 * @cookie: the request cookie
5197 * @chan: The current channel (from remain_on_channel request)
5198 * @gfp: allocation flags
5199 */
5200void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
5201 struct ieee80211_channel *chan,
5202 gfp_t gfp);
5203
5204
5205/**
5206 * cfg80211_new_sta - notify userspace about station
5207 *
5208 * @dev: the netdev
5209 * @mac_addr: the station's address
5210 * @sinfo: the station information
5211 * @gfp: allocation flags
5212 */
5213void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
5214 struct station_info *sinfo, gfp_t gfp);
5215
5216/**
5217 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
5218 * @dev: the netdev
5219 * @mac_addr: the station's address
5220 * @sinfo: the station information/statistics
5221 * @gfp: allocation flags
5222 */
5223void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
5224 struct station_info *sinfo, gfp_t gfp);
5225
5226/**
5227 * cfg80211_del_sta - notify userspace about deletion of a station
5228 *
5229 * @dev: the netdev
5230 * @mac_addr: the station's address
5231 * @gfp: allocation flags
5232 */
5233static inline void cfg80211_del_sta(struct net_device *dev,
5234 const u8 *mac_addr, gfp_t gfp)
5235{
5236 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
5237}
5238
5239/**
5240 * cfg80211_conn_failed - connection request failed notification
5241 *
5242 * @dev: the netdev
5243 * @mac_addr: the station's address
5244 * @reason: the reason for connection failure
5245 * @gfp: allocation flags
5246 *
5247 * Whenever a station tries to connect to an AP and if the station
5248 * could not connect to the AP as the AP has rejected the connection
5249 * for some reasons, this function is called.
5250 *
5251 * The reason for connection failure can be any of the value from
5252 * nl80211_connect_failed_reason enum
5253 */
5254void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
5255 enum nl80211_connect_failed_reason reason,
5256 gfp_t gfp);
5257
5258/**
5259 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
5260 * @wdev: wireless device receiving the frame
5261 * @freq: Frequency on which the frame was received in MHz
5262 * @sig_dbm: signal strength in mBm, or 0 if unknown
5263 * @buf: Management frame (header + body)
5264 * @len: length of the frame data
5265 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
5266 *
5267 * This function is called whenever an Action frame is received for a station
5268 * mode interface, but is not processed in kernel.
5269 *
5270 * Return: %true if a user space application has registered for this frame.
5271 * For action frames, that makes it responsible for rejecting unrecognized
5272 * action frames; %false otherwise, in which case for action frames the
5273 * driver is responsible for rejecting the frame.
5274 */
5275bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
5276 const u8 *buf, size_t len, u32 flags);
5277
5278/**
5279 * cfg80211_mgmt_tx_status - notification of TX status for management frame
5280 * @wdev: wireless device receiving the frame
5281 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5282 * @buf: Management frame (header + body)
5283 * @len: length of the frame data
5284 * @ack: Whether frame was acknowledged
5285 * @gfp: context flags
5286 *
5287 * This function is called whenever a management frame was requested to be
5288 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
5289 * transmission attempt.
5290 */
5291void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
5292 const u8 *buf, size_t len, bool ack, gfp_t gfp);
5293
5294
5295/**
5296 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5297 * @dev: network device
5298 * @rssi_event: the triggered RSSI event
5299 * @gfp: context flags
5300 *
5301 * This function is called when a configured connection quality monitoring
5302 * rssi threshold reached event occurs.
5303 */
5304void cfg80211_cqm_rssi_notify(struct net_device *dev,
5305 enum nl80211_cqm_rssi_threshold_event rssi_event,
5306 gfp_t gfp);
5307
5308/**
5309 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5310 * @dev: network device
5311 * @peer: peer's MAC address
5312 * @num_packets: how many packets were lost -- should be a fixed threshold
5313 * but probably no less than maybe 50, or maybe a throughput dependent
5314 * threshold (to account for temporary interference)
5315 * @gfp: context flags
5316 */
5317void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5318 const u8 *peer, u32 num_packets, gfp_t gfp);
5319
5320/**
5321 * cfg80211_cqm_txe_notify - TX error rate event
5322 * @dev: network device
5323 * @peer: peer's MAC address
5324 * @num_packets: how many packets were lost
5325 * @rate: % of packets which failed transmission
5326 * @intvl: interval (in s) over which the TX failure threshold was breached.
5327 * @gfp: context flags
5328 *
5329 * Notify userspace when configured % TX failures over number of packets in a
5330 * given interval is exceeded.
5331 */
5332void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5333 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5334
5335/**
5336 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5337 * @dev: network device
5338 * @gfp: context flags
5339 *
5340 * Notify userspace about beacon loss from the connected AP.
5341 */
5342void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5343
5344/**
5345 * cfg80211_radar_event - radar detection event
5346 * @wiphy: the wiphy
5347 * @chandef: chandef for the current channel
5348 * @gfp: context flags
5349 *
5350 * This function is called when a radar is detected on the current chanenl.
5351 */
5352void cfg80211_radar_event(struct wiphy *wiphy,
5353 struct cfg80211_chan_def *chandef, gfp_t gfp);
5354
5355/**
5356 * cfg80211_cac_event - Channel availability check (CAC) event
5357 * @netdev: network device
5358 * @chandef: chandef for the current channel
5359 * @event: type of event
5360 * @gfp: context flags
5361 *
5362 * This function is called when a Channel availability check (CAC) is finished
5363 * or aborted. This must be called to notify the completion of a CAC process,
5364 * also by full-MAC drivers.
5365 */
5366void cfg80211_cac_event(struct net_device *netdev,
5367 const struct cfg80211_chan_def *chandef,
5368 enum nl80211_radar_event event, gfp_t gfp);
5369
5370
5371/**
5372 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5373 * @dev: network device
5374 * @bssid: BSSID of AP (to avoid races)
5375 * @replay_ctr: new replay counter
5376 * @gfp: allocation flags
5377 */
5378void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5379 const u8 *replay_ctr, gfp_t gfp);
5380
5381/**
5382 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5383 * @dev: network device
5384 * @index: candidate index (the smaller the index, the higher the priority)
5385 * @bssid: BSSID of AP
5386 * @preauth: Whether AP advertises support for RSN pre-authentication
5387 * @gfp: allocation flags
5388 */
5389void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5390 const u8 *bssid, bool preauth, gfp_t gfp);
5391
5392/**
5393 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5394 * @dev: The device the frame matched to
5395 * @addr: the transmitter address
5396 * @gfp: context flags
5397 *
5398 * This function is used in AP mode (only!) to inform userspace that
5399 * a spurious class 3 frame was received, to be able to deauth the
5400 * sender.
5401 * Return: %true if the frame was passed to userspace (or this failed
5402 * for a reason other than not having a subscription.)
5403 */
5404bool cfg80211_rx_spurious_frame(struct net_device *dev,
5405 const u8 *addr, gfp_t gfp);
5406
5407/**
5408 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5409 * @dev: The device the frame matched to
5410 * @addr: the transmitter address
5411 * @gfp: context flags
5412 *
5413 * This function is used in AP mode (only!) to inform userspace that
5414 * an associated station sent a 4addr frame but that wasn't expected.
5415 * It is allowed and desirable to send this event only once for each
5416 * station to avoid event flooding.
5417 * Return: %true if the frame was passed to userspace (or this failed
5418 * for a reason other than not having a subscription.)
5419 */
5420bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5421 const u8 *addr, gfp_t gfp);
5422
5423/**
5424 * cfg80211_probe_status - notify userspace about probe status
5425 * @dev: the device the probe was sent on
5426 * @addr: the address of the peer
5427 * @cookie: the cookie filled in @probe_client previously
5428 * @acked: indicates whether probe was acked or not
5429 * @gfp: allocation flags
5430 */
5431void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
5432 u64 cookie, bool acked, gfp_t gfp);
5433
5434/**
5435 * cfg80211_report_obss_beacon - report beacon from other APs
5436 * @wiphy: The wiphy that received the beacon
5437 * @frame: the frame
5438 * @len: length of the frame
5439 * @freq: frequency the frame was received on
5440 * @sig_dbm: signal strength in mBm, or 0 if unknown
5441 *
5442 * Use this function to report to userspace when a beacon was
5443 * received. It is not useful to call this when there is no
5444 * netdev that is in AP/GO mode.
5445 */
5446void cfg80211_report_obss_beacon(struct wiphy *wiphy,
5447 const u8 *frame, size_t len,
5448 int freq, int sig_dbm);
5449
5450/**
5451 * cfg80211_reg_can_beacon - check if beaconing is allowed
5452 * @wiphy: the wiphy
5453 * @chandef: the channel definition
5454 * @iftype: interface type
5455 *
5456 * Return: %true if there is no secondary channel or the secondary channel(s)
5457 * can be used for beaconing (i.e. is not a radar channel etc.)
5458 */
5459bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
5460 struct cfg80211_chan_def *chandef,
5461 enum nl80211_iftype iftype);
5462
5463/**
5464 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5465 * @wiphy: the wiphy
5466 * @chandef: the channel definition
5467 * @iftype: interface type
5468 *
5469 * Return: %true if there is no secondary channel or the secondary channel(s)
5470 * can be used for beaconing (i.e. is not a radar channel etc.). This version
5471 * also checks if IR-relaxation conditions apply, to allow beaconing under
5472 * more permissive conditions.
5473 *
5474 * Requires the RTNL to be held.
5475 */
5476bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
5477 struct cfg80211_chan_def *chandef,
5478 enum nl80211_iftype iftype);
5479
5480/*
5481 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5482 * @dev: the device which switched channels
5483 * @chandef: the new channel definition
5484 *
5485 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5486 * driver context!
5487 */
5488void cfg80211_ch_switch_notify(struct net_device *dev,
5489 struct cfg80211_chan_def *chandef);
5490
5491/*
5492 * cfg80211_ch_switch_started_notify - notify channel switch start
5493 * @dev: the device on which the channel switch started
5494 * @chandef: the future channel definition
5495 * @count: the number of TBTTs until the channel switch happens
5496 *
5497 * Inform the userspace about the channel switch that has just
5498 * started, so that it can take appropriate actions (eg. starting
5499 * channel switch on other vifs), if necessary.
5500 */
5501void cfg80211_ch_switch_started_notify(struct net_device *dev,
5502 struct cfg80211_chan_def *chandef,
5503 u8 count);
5504
5505/**
5506 * ieee80211_operating_class_to_band - convert operating class to band
5507 *
5508 * @operating_class: the operating class to convert
5509 * @band: band pointer to fill
5510 *
5511 * Returns %true if the conversion was successful, %false otherwise.
5512 */
5513bool ieee80211_operating_class_to_band(u8 operating_class,
5514 enum nl80211_band *band);
5515
5516/**
5517 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5518 *
5519 * @chandef: the chandef to convert
5520 * @op_class: a pointer to the resulting operating class
5521 *
5522 * Returns %true if the conversion was successful, %false otherwise.
5523 */
5524bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5525 u8 *op_class);
5526
5527/*
5528 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5529 * @dev: the device on which the operation is requested
5530 * @peer: the MAC address of the peer device
5531 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5532 * NL80211_TDLS_TEARDOWN)
5533 * @reason_code: the reason code for teardown request
5534 * @gfp: allocation flags
5535 *
5536 * This function is used to request userspace to perform TDLS operation that
5537 * requires knowledge of keys, i.e., link setup or teardown when the AP
5538 * connection uses encryption. This is optional mechanism for the driver to use
5539 * if it can automatically determine when a TDLS link could be useful (e.g.,
5540 * based on traffic and signal strength for a peer).
5541 */
5542void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5543 enum nl80211_tdls_operation oper,
5544 u16 reason_code, gfp_t gfp);
5545
5546/*
5547 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5548 * @rate: given rate_info to calculate bitrate from
5549 *
5550 * return 0 if MCS index >= 32
5551 */
5552u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5553
5554/**
5555 * cfg80211_unregister_wdev - remove the given wdev
5556 * @wdev: struct wireless_dev to remove
5557 *
5558 * Call this function only for wdevs that have no netdev assigned,
5559 * e.g. P2P Devices. It removes the device from the list so that
5560 * it can no longer be used. It is necessary to call this function
5561 * even when cfg80211 requests the removal of the interface by
5562 * calling the del_virtual_intf() callback. The function must also
5563 * be called when the driver wishes to unregister the wdev, e.g.
5564 * when the device is unbound from the driver.
5565 *
5566 * Requires the RTNL to be held.
5567 */
5568void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5569
5570/**
5571 * struct cfg80211_ft_event - FT Information Elements
5572 * @ies: FT IEs
5573 * @ies_len: length of the FT IE in bytes
5574 * @target_ap: target AP's MAC address
5575 * @ric_ies: RIC IE
5576 * @ric_ies_len: length of the RIC IE in bytes
5577 */
5578struct cfg80211_ft_event_params {
5579 const u8 *ies;
5580 size_t ies_len;
5581 const u8 *target_ap;
5582 const u8 *ric_ies;
5583 size_t ric_ies_len;
5584};
5585
5586/**
5587 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5588 * @netdev: network device
5589 * @ft_event: IE information
5590 */
5591void cfg80211_ft_event(struct net_device *netdev,
5592 struct cfg80211_ft_event_params *ft_event);
5593
5594/**
5595 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5596 * @ies: the input IE buffer
5597 * @len: the input length
5598 * @attr: the attribute ID to find
5599 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5600 * if the function is only called to get the needed buffer size
5601 * @bufsize: size of the output buffer
5602 *
5603 * The function finds a given P2P attribute in the (vendor) IEs and
5604 * copies its contents to the given buffer.
5605 *
5606 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5607 * malformed or the attribute can't be found (respectively), or the
5608 * length of the found attribute (which can be zero).
5609 */
5610int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5611 enum ieee80211_p2p_attr_id attr,
5612 u8 *buf, unsigned int bufsize);
5613
5614/**
5615 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5616 * @ies: the IE buffer
5617 * @ielen: the length of the IE buffer
5618 * @ids: an array with element IDs that are allowed before
5619 * the split
5620 * @n_ids: the size of the element ID array
5621 * @after_ric: array IE types that come after the RIC element
5622 * @n_after_ric: size of the @after_ric array
5623 * @offset: offset where to start splitting in the buffer
5624 *
5625 * This function splits an IE buffer by updating the @offset
5626 * variable to point to the location where the buffer should be
5627 * split.
5628 *
5629 * It assumes that the given IE buffer is well-formed, this
5630 * has to be guaranteed by the caller!
5631 *
5632 * It also assumes that the IEs in the buffer are ordered
5633 * correctly, if not the result of using this function will not
5634 * be ordered correctly either, i.e. it does no reordering.
5635 *
5636 * The function returns the offset where the next part of the
5637 * buffer starts, which may be @ielen if the entire (remainder)
5638 * of the buffer should be used.
5639 */
5640size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5641 const u8 *ids, int n_ids,
5642 const u8 *after_ric, int n_after_ric,
5643 size_t offset);
5644
5645/**
5646 * ieee80211_ie_split - split an IE buffer according to ordering
5647 * @ies: the IE buffer
5648 * @ielen: the length of the IE buffer
5649 * @ids: an array with element IDs that are allowed before
5650 * the split
5651 * @n_ids: the size of the element ID array
5652 * @offset: offset where to start splitting in the buffer
5653 *
5654 * This function splits an IE buffer by updating the @offset
5655 * variable to point to the location where the buffer should be
5656 * split.
5657 *
5658 * It assumes that the given IE buffer is well-formed, this
5659 * has to be guaranteed by the caller!
5660 *
5661 * It also assumes that the IEs in the buffer are ordered
5662 * correctly, if not the result of using this function will not
5663 * be ordered correctly either, i.e. it does no reordering.
5664 *
5665 * The function returns the offset where the next part of the
5666 * buffer starts, which may be @ielen if the entire (remainder)
5667 * of the buffer should be used.
5668 */
5669static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5670 const u8 *ids, int n_ids, size_t offset)
5671{
5672 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
5673}
5674
5675/**
5676 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5677 * @wdev: the wireless device reporting the wakeup
5678 * @wakeup: the wakeup report
5679 * @gfp: allocation flags
5680 *
5681 * This function reports that the given device woke up. If it
5682 * caused the wakeup, report the reason(s), otherwise you may
5683 * pass %NULL as the @wakeup parameter to advertise that something
5684 * else caused the wakeup.
5685 */
5686void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5687 struct cfg80211_wowlan_wakeup *wakeup,
5688 gfp_t gfp);
5689
5690/**
5691 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5692 *
5693 * @wdev: the wireless device for which critical protocol is stopped.
5694 * @gfp: allocation flags
5695 *
5696 * This function can be called by the driver to indicate it has reverted
5697 * operation back to normal. One reason could be that the duration given
5698 * by .crit_proto_start() has expired.
5699 */
5700void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5701
5702/**
5703 * ieee80211_get_num_supported_channels - get number of channels device has
5704 * @wiphy: the wiphy
5705 *
5706 * Return: the number of channels supported by the device.
5707 */
5708unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5709
5710/**
5711 * cfg80211_check_combinations - check interface combinations
5712 *
5713 * @wiphy: the wiphy
5714 * @params: the interface combinations parameter
5715 *
5716 * This function can be called by the driver to check whether a
5717 * combination of interfaces and their types are allowed according to
5718 * the interface combinations.
5719 */
5720int cfg80211_check_combinations(struct wiphy *wiphy,
5721 struct iface_combination_params *params);
5722
5723/**
5724 * cfg80211_iter_combinations - iterate over matching combinations
5725 *
5726 * @wiphy: the wiphy
5727 * @params: the interface combinations parameter
5728 * @iter: function to call for each matching combination
5729 * @data: pointer to pass to iter function
5730 *
5731 * This function can be called by the driver to check what possible
5732 * combinations it fits in at a given moment, e.g. for channel switching
5733 * purposes.
5734 */
5735int cfg80211_iter_combinations(struct wiphy *wiphy,
5736 struct iface_combination_params *params,
5737 void (*iter)(const struct ieee80211_iface_combination *c,
5738 void *data),
5739 void *data);
5740
5741/*
5742 * cfg80211_stop_iface - trigger interface disconnection
5743 *
5744 * @wiphy: the wiphy
5745 * @wdev: wireless device
5746 * @gfp: context flags
5747 *
5748 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5749 * disconnected.
5750 *
5751 * Note: This doesn't need any locks and is asynchronous.
5752 */
5753void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5754 gfp_t gfp);
5755
5756/**
5757 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5758 * @wiphy: the wiphy to shut down
5759 *
5760 * This function shuts down all interfaces belonging to this wiphy by
5761 * calling dev_close() (and treating non-netdev interfaces as needed).
5762 * It shouldn't really be used unless there are some fatal device errors
5763 * that really can't be recovered in any other way.
5764 *
5765 * Callers must hold the RTNL and be able to deal with callbacks into
5766 * the driver while the function is running.
5767 */
5768void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5769
5770/**
5771 * wiphy_ext_feature_set - set the extended feature flag
5772 *
5773 * @wiphy: the wiphy to modify.
5774 * @ftidx: extended feature bit index.
5775 *
5776 * The extended features are flagged in multiple bytes (see
5777 * &struct wiphy.@ext_features)
5778 */
5779static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5780 enum nl80211_ext_feature_index ftidx)
5781{
5782 u8 *ft_byte;
5783
5784 ft_byte = &wiphy->ext_features[ftidx / 8];
5785 *ft_byte |= BIT(ftidx % 8);
5786}
5787
5788/**
5789 * wiphy_ext_feature_isset - check the extended feature flag
5790 *
5791 * @wiphy: the wiphy to modify.
5792 * @ftidx: extended feature bit index.
5793 *
5794 * The extended features are flagged in multiple bytes (see
5795 * &struct wiphy.@ext_features)
5796 */
5797static inline bool
5798wiphy_ext_feature_isset(struct wiphy *wiphy,
5799 enum nl80211_ext_feature_index ftidx)
5800{
5801 u8 ft_byte;
5802
5803 ft_byte = wiphy->ext_features[ftidx / 8];
5804 return (ft_byte & BIT(ftidx % 8)) != 0;
5805}
5806
5807/**
5808 * cfg80211_free_nan_func - free NAN function
5809 * @f: NAN function that should be freed
5810 *
5811 * Frees all the NAN function and all it's allocated members.
5812 */
5813void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
5814
5815/**
5816 * struct cfg80211_nan_match_params - NAN match parameters
5817 * @type: the type of the function that triggered a match. If it is
5818 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
5819 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
5820 * result.
5821 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
5822 * @inst_id: the local instance id
5823 * @peer_inst_id: the instance id of the peer's function
5824 * @addr: the MAC address of the peer
5825 * @info_len: the length of the &info
5826 * @info: the Service Specific Info from the peer (if any)
5827 * @cookie: unique identifier of the corresponding function
5828 */
5829struct cfg80211_nan_match_params {
5830 enum nl80211_nan_function_type type;
5831 u8 inst_id;
5832 u8 peer_inst_id;
5833 const u8 *addr;
5834 u8 info_len;
5835 const u8 *info;
5836 u64 cookie;
5837};
5838
5839/**
5840 * cfg80211_nan_match - report a match for a NAN function.
5841 * @wdev: the wireless device reporting the match
5842 * @match: match notification parameters
5843 * @gfp: allocation flags
5844 *
5845 * This function reports that the a NAN function had a match. This
5846 * can be a subscribe that had a match or a solicited publish that
5847 * was sent. It can also be a follow up that was received.
5848 */
5849void cfg80211_nan_match(struct wireless_dev *wdev,
5850 struct cfg80211_nan_match_params *match, gfp_t gfp);
5851
5852/**
5853 * cfg80211_nan_func_terminated - notify about NAN function termination.
5854 *
5855 * @wdev: the wireless device reporting the match
5856 * @inst_id: the local instance id
5857 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
5858 * @cookie: unique NAN function identifier
5859 * @gfp: allocation flags
5860 *
5861 * This function reports that the a NAN function is terminated.
5862 */
5863void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
5864 u8 inst_id,
5865 enum nl80211_nan_func_term_reason reason,
5866 u64 cookie, gfp_t gfp);
5867
5868/* ethtool helper */
5869void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5870
5871/* Logging, debugging and troubleshooting/diagnostic helpers. */
5872
5873/* wiphy_printk helpers, similar to dev_printk */
5874
5875#define wiphy_printk(level, wiphy, format, args...) \
5876 dev_printk(level, &(wiphy)->dev, format, ##args)
5877#define wiphy_emerg(wiphy, format, args...) \
5878 dev_emerg(&(wiphy)->dev, format, ##args)
5879#define wiphy_alert(wiphy, format, args...) \
5880 dev_alert(&(wiphy)->dev, format, ##args)
5881#define wiphy_crit(wiphy, format, args...) \
5882 dev_crit(&(wiphy)->dev, format, ##args)
5883#define wiphy_err(wiphy, format, args...) \
5884 dev_err(&(wiphy)->dev, format, ##args)
5885#define wiphy_warn(wiphy, format, args...) \
5886 dev_warn(&(wiphy)->dev, format, ##args)
5887#define wiphy_notice(wiphy, format, args...) \
5888 dev_notice(&(wiphy)->dev, format, ##args)
5889#define wiphy_info(wiphy, format, args...) \
5890 dev_info(&(wiphy)->dev, format, ##args)
5891
5892#define wiphy_debug(wiphy, format, args...) \
5893 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5894
5895#define wiphy_dbg(wiphy, format, args...) \
5896 dev_dbg(&(wiphy)->dev, format, ##args)
5897
5898#if defined(VERBOSE_DEBUG)
5899#define wiphy_vdbg wiphy_dbg
5900#else
5901#define wiphy_vdbg(wiphy, format, args...) \
5902({ \
5903 if (0) \
5904 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5905 0; \
5906})
5907#endif
5908
5909/*
5910 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5911 * of using a WARN/WARN_ON to get the message out, including the
5912 * file/line information and a backtrace.
5913 */
5914#define wiphy_WARN(wiphy, format, args...) \
5915 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5916
5917#endif /* __NET_CFG80211_H */