~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/net/cfg80211.h

Version: ~ [ linux-5.1-rc1 ] ~ [ linux-5.0.3 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.30 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.107 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.164 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.176 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.136 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.63 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.39.4 ] ~ [ linux-2.6.38.8 ] ~ [ linux-2.6.37.6 ] ~ [ linux-2.6.36.4 ] ~ [ linux-2.6.35.14 ] ~ [ linux-2.6.34.15 ] ~ [ linux-2.6.33.20 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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-2017  Intel Deutschland GmbH
  9  * Copyright (C) 2018-2019 Intel Corporation
 10  *
 11  * This program is free software; you can redistribute it and/or modify
 12  * it under the terms of the GNU General Public License version 2 as
 13  * published by the Free Software Foundation.
 14  */
 15 
 16 #include <linux/netdevice.h>
 17 #include <linux/debugfs.h>
 18 #include <linux/list.h>
 19 #include <linux/bug.h>
 20 #include <linux/netlink.h>
 21 #include <linux/skbuff.h>
 22 #include <linux/nl80211.h>
 23 #include <linux/if_ether.h>
 24 #include <linux/ieee80211.h>
 25 #include <linux/net.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 
 65 struct 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  *
102  */
103 enum ieee80211_channel_flags {
104         IEEE80211_CHAN_DISABLED         = 1<<0,
105         IEEE80211_CHAN_NO_IR            = 1<<1,
106         /* hole at 1<<2 */
107         IEEE80211_CHAN_RADAR            = 1<<3,
108         IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
109         IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
110         IEEE80211_CHAN_NO_OFDM          = 1<<6,
111         IEEE80211_CHAN_NO_80MHZ         = 1<<7,
112         IEEE80211_CHAN_NO_160MHZ        = 1<<8,
113         IEEE80211_CHAN_INDOOR_ONLY      = 1<<9,
114         IEEE80211_CHAN_IR_CONCURRENT    = 1<<10,
115         IEEE80211_CHAN_NO_20MHZ         = 1<<11,
116         IEEE80211_CHAN_NO_10MHZ         = 1<<12,
117 };
118 
119 #define IEEE80211_CHAN_NO_HT40 \
120         (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
121 
122 #define IEEE80211_DFS_MIN_CAC_TIME_MS           60000
123 #define IEEE80211_DFS_MIN_NOP_TIME_MS           (30 * 60 * 1000)
124 
125 /**
126  * struct ieee80211_channel - channel definition
127  *
128  * This structure describes a single channel for use
129  * with cfg80211.
130  *
131  * @center_freq: center frequency in MHz
132  * @hw_value: hardware-specific value for the channel
133  * @flags: channel flags from &enum ieee80211_channel_flags.
134  * @orig_flags: channel flags at registration time, used by regulatory
135  *      code to support devices with additional restrictions
136  * @band: band this channel belongs to.
137  * @max_antenna_gain: maximum antenna gain in dBi
138  * @max_power: maximum transmission power (in dBm)
139  * @max_reg_power: maximum regulatory transmission power (in dBm)
140  * @beacon_found: helper to regulatory code to indicate when a beacon
141  *      has been found on this channel. Use regulatory_hint_found_beacon()
142  *      to enable this, this is useful only on 5 GHz band.
143  * @orig_mag: internal use
144  * @orig_mpwr: internal use
145  * @dfs_state: current state of this channel. Only relevant if radar is required
146  *      on this channel.
147  * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
148  * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
149  */
150 struct ieee80211_channel {
151         enum nl80211_band band;
152         u32 center_freq;
153         u16 hw_value;
154         u32 flags;
155         int max_antenna_gain;
156         int max_power;
157         int max_reg_power;
158         bool beacon_found;
159         u32 orig_flags;
160         int orig_mag, orig_mpwr;
161         enum nl80211_dfs_state dfs_state;
162         unsigned long dfs_state_entered;
163         unsigned int dfs_cac_ms;
164 };
165 
166 /**
167  * enum ieee80211_rate_flags - rate flags
168  *
169  * Hardware/specification flags for rates. These are structured
170  * in a way that allows using the same bitrate structure for
171  * different bands/PHY modes.
172  *
173  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
174  *      preamble on this bitrate; only relevant in 2.4GHz band and
175  *      with CCK rates.
176  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
177  *      when used with 802.11a (on the 5 GHz band); filled by the
178  *      core code when registering the wiphy.
179  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
180  *      when used with 802.11b (on the 2.4 GHz band); filled by the
181  *      core code when registering the wiphy.
182  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
183  *      when used with 802.11g (on the 2.4 GHz band); filled by the
184  *      core code when registering the wiphy.
185  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
186  * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
187  * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
188  */
189 enum ieee80211_rate_flags {
190         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
191         IEEE80211_RATE_MANDATORY_A      = 1<<1,
192         IEEE80211_RATE_MANDATORY_B      = 1<<2,
193         IEEE80211_RATE_MANDATORY_G      = 1<<3,
194         IEEE80211_RATE_ERP_G            = 1<<4,
195         IEEE80211_RATE_SUPPORTS_5MHZ    = 1<<5,
196         IEEE80211_RATE_SUPPORTS_10MHZ   = 1<<6,
197 };
198 
199 /**
200  * enum ieee80211_bss_type - BSS type filter
201  *
202  * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
203  * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
204  * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
205  * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
206  * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
207  */
208 enum ieee80211_bss_type {
209         IEEE80211_BSS_TYPE_ESS,
210         IEEE80211_BSS_TYPE_PBSS,
211         IEEE80211_BSS_TYPE_IBSS,
212         IEEE80211_BSS_TYPE_MBSS,
213         IEEE80211_BSS_TYPE_ANY
214 };
215 
216 /**
217  * enum ieee80211_privacy - BSS privacy filter
218  *
219  * @IEEE80211_PRIVACY_ON: privacy bit set
220  * @IEEE80211_PRIVACY_OFF: privacy bit clear
221  * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
222  */
223 enum ieee80211_privacy {
224         IEEE80211_PRIVACY_ON,
225         IEEE80211_PRIVACY_OFF,
226         IEEE80211_PRIVACY_ANY
227 };
228 
229 #define IEEE80211_PRIVACY(x)    \
230         ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
231 
232 /**
233  * struct ieee80211_rate - bitrate definition
234  *
235  * This structure describes a bitrate that an 802.11 PHY can
236  * operate with. The two values @hw_value and @hw_value_short
237  * are only for driver use when pointers to this structure are
238  * passed around.
239  *
240  * @flags: rate-specific flags
241  * @bitrate: bitrate in units of 100 Kbps
242  * @hw_value: driver/hardware value for this rate
243  * @hw_value_short: driver/hardware value for this rate when
244  *      short preamble is used
245  */
246 struct ieee80211_rate {
247         u32 flags;
248         u16 bitrate;
249         u16 hw_value, hw_value_short;
250 };
251 
252 /**
253  * struct ieee80211_sta_ht_cap - STA's HT capabilities
254  *
255  * This structure describes most essential parameters needed
256  * to describe 802.11n HT capabilities for an STA.
257  *
258  * @ht_supported: is HT supported by the STA
259  * @cap: HT capabilities map as described in 802.11n spec
260  * @ampdu_factor: Maximum A-MPDU length factor
261  * @ampdu_density: Minimum A-MPDU spacing
262  * @mcs: Supported MCS rates
263  */
264 struct ieee80211_sta_ht_cap {
265         u16 cap; /* use IEEE80211_HT_CAP_ */
266         bool ht_supported;
267         u8 ampdu_factor;
268         u8 ampdu_density;
269         struct ieee80211_mcs_info mcs;
270 };
271 
272 /**
273  * struct ieee80211_sta_vht_cap - STA's VHT capabilities
274  *
275  * This structure describes most essential parameters needed
276  * to describe 802.11ac VHT capabilities for an STA.
277  *
278  * @vht_supported: is VHT supported by the STA
279  * @cap: VHT capabilities map as described in 802.11ac spec
280  * @vht_mcs: Supported VHT MCS rates
281  */
282 struct ieee80211_sta_vht_cap {
283         bool vht_supported;
284         u32 cap; /* use IEEE80211_VHT_CAP_ */
285         struct ieee80211_vht_mcs_info vht_mcs;
286 };
287 
288 #define IEEE80211_HE_PPE_THRES_MAX_LEN          25
289 
290 /**
291  * struct ieee80211_sta_he_cap - STA's HE capabilities
292  *
293  * This structure describes most essential parameters needed
294  * to describe 802.11ax HE capabilities for a STA.
295  *
296  * @has_he: true iff HE data is valid.
297  * @he_cap_elem: Fixed portion of the HE capabilities element.
298  * @he_mcs_nss_supp: The supported NSS/MCS combinations.
299  * @ppe_thres: Holds the PPE Thresholds data.
300  */
301 struct ieee80211_sta_he_cap {
302         bool has_he;
303         struct ieee80211_he_cap_elem he_cap_elem;
304         struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
305         u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
306 };
307 
308 /**
309  * struct ieee80211_sband_iftype_data
310  *
311  * This structure encapsulates sband data that is relevant for the
312  * interface types defined in @types_mask.  Each type in the
313  * @types_mask must be unique across all instances of iftype_data.
314  *
315  * @types_mask: interface types mask
316  * @he_cap: holds the HE capabilities
317  */
318 struct ieee80211_sband_iftype_data {
319         u16 types_mask;
320         struct ieee80211_sta_he_cap he_cap;
321 };
322 
323 /**
324  * struct ieee80211_supported_band - frequency band definition
325  *
326  * This structure describes a frequency band a wiphy
327  * is able to operate in.
328  *
329  * @channels: Array of channels the hardware can operate in
330  *      in this band.
331  * @band: the band this structure represents
332  * @n_channels: Number of channels in @channels
333  * @bitrates: Array of bitrates the hardware can operate with
334  *      in this band. Must be sorted to give a valid "supported
335  *      rates" IE, i.e. CCK rates first, then OFDM.
336  * @n_bitrates: Number of bitrates in @bitrates
337  * @ht_cap: HT capabilities in this band
338  * @vht_cap: VHT capabilities in this band
339  * @n_iftype_data: number of iftype data entries
340  * @iftype_data: interface type data entries.  Note that the bits in
341  *      @types_mask inside this structure cannot overlap (i.e. only
342  *      one occurrence of each type is allowed across all instances of
343  *      iftype_data).
344  */
345 struct ieee80211_supported_band {
346         struct ieee80211_channel *channels;
347         struct ieee80211_rate *bitrates;
348         enum nl80211_band band;
349         int n_channels;
350         int n_bitrates;
351         struct ieee80211_sta_ht_cap ht_cap;
352         struct ieee80211_sta_vht_cap vht_cap;
353         u16 n_iftype_data;
354         const struct ieee80211_sband_iftype_data *iftype_data;
355 };
356 
357 /**
358  * ieee80211_get_sband_iftype_data - return sband data for a given iftype
359  * @sband: the sband to search for the STA on
360  * @iftype: enum nl80211_iftype
361  *
362  * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
363  */
364 static inline const struct ieee80211_sband_iftype_data *
365 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
366                                 u8 iftype)
367 {
368         int i;
369 
370         if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
371                 return NULL;
372 
373         for (i = 0; i < sband->n_iftype_data; i++)  {
374                 const struct ieee80211_sband_iftype_data *data =
375                         &sband->iftype_data[i];
376 
377                 if (data->types_mask & BIT(iftype))
378                         return data;
379         }
380 
381         return NULL;
382 }
383 
384 /**
385  * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
386  * @sband: the sband to search for the STA on
387  *
388  * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
389  */
390 static inline const struct ieee80211_sta_he_cap *
391 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
392 {
393         const struct ieee80211_sband_iftype_data *data =
394                 ieee80211_get_sband_iftype_data(sband, NL80211_IFTYPE_STATION);
395 
396         if (data && data->he_cap.has_he)
397                 return &data->he_cap;
398 
399         return NULL;
400 }
401 
402 /**
403  * wiphy_read_of_freq_limits - read frequency limits from device tree
404  *
405  * @wiphy: the wireless device to get extra limits for
406  *
407  * Some devices may have extra limitations specified in DT. This may be useful
408  * for chipsets that normally support more bands but are limited due to board
409  * design (e.g. by antennas or external power amplifier).
410  *
411  * This function reads info from DT and uses it to *modify* channels (disable
412  * unavailable ones). It's usually a *bad* idea to use it in drivers with
413  * shared channel data as DT limitations are device specific. You should make
414  * sure to call it only if channels in wiphy are copied and can be modified
415  * without affecting other devices.
416  *
417  * As this function access device node it has to be called after set_wiphy_dev.
418  * It also modifies channels so they have to be set first.
419  * If using this helper, call it before wiphy_register().
420  */
421 #ifdef CONFIG_OF
422 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
423 #else /* CONFIG_OF */
424 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
425 {
426 }
427 #endif /* !CONFIG_OF */
428 
429 
430 /*
431  * Wireless hardware/device configuration structures and methods
432  */
433 
434 /**
435  * DOC: Actions and configuration
436  *
437  * Each wireless device and each virtual interface offer a set of configuration
438  * operations and other actions that are invoked by userspace. Each of these
439  * actions is described in the operations structure, and the parameters these
440  * operations use are described separately.
441  *
442  * Additionally, some operations are asynchronous and expect to get status
443  * information via some functions that drivers need to call.
444  *
445  * Scanning and BSS list handling with its associated functionality is described
446  * in a separate chapter.
447  */
448 
449 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
450                                     WLAN_USER_POSITION_LEN)
451 
452 /**
453  * struct vif_params - describes virtual interface parameters
454  * @flags: monitor interface flags, unchanged if 0, otherwise
455  *      %MONITOR_FLAG_CHANGED will be set
456  * @use_4addr: use 4-address frames
457  * @macaddr: address to use for this virtual interface.
458  *      If this parameter is set to zero address the driver may
459  *      determine the address as needed.
460  *      This feature is only fully supported by drivers that enable the
461  *      %NL80211_FEATURE_MAC_ON_CREATE flag.  Others may support creating
462  **     only p2p devices with specified MAC.
463  * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
464  *      belonging to that MU-MIMO groupID; %NULL if not changed
465  * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
466  *      MU-MIMO packets going to the specified station; %NULL if not changed
467  */
468 struct vif_params {
469         u32 flags;
470         int use_4addr;
471         u8 macaddr[ETH_ALEN];
472         const u8 *vht_mumimo_groups;
473         const u8 *vht_mumimo_follow_addr;
474 };
475 
476 /**
477  * struct key_params - key information
478  *
479  * Information about a key
480  *
481  * @key: key material
482  * @key_len: length of key material
483  * @cipher: cipher suite selector
484  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
485  *      with the get_key() callback, must be in little endian,
486  *      length given by @seq_len.
487  * @seq_len: length of @seq.
488  */
489 struct key_params {
490         const u8 *key;
491         const u8 *seq;
492         int key_len;
493         int seq_len;
494         u32 cipher;
495 };
496 
497 /**
498  * struct cfg80211_chan_def - channel definition
499  * @chan: the (control) channel
500  * @width: channel width
501  * @center_freq1: center frequency of first segment
502  * @center_freq2: center frequency of second segment
503  *      (only with 80+80 MHz)
504  */
505 struct cfg80211_chan_def {
506         struct ieee80211_channel *chan;
507         enum nl80211_chan_width width;
508         u32 center_freq1;
509         u32 center_freq2;
510 };
511 
512 /**
513  * cfg80211_get_chandef_type - return old channel type from chandef
514  * @chandef: the channel definition
515  *
516  * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
517  * chandef, which must have a bandwidth allowing this conversion.
518  */
519 static inline enum nl80211_channel_type
520 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
521 {
522         switch (chandef->width) {
523         case NL80211_CHAN_WIDTH_20_NOHT:
524                 return NL80211_CHAN_NO_HT;
525         case NL80211_CHAN_WIDTH_20:
526                 return NL80211_CHAN_HT20;
527         case NL80211_CHAN_WIDTH_40:
528                 if (chandef->center_freq1 > chandef->chan->center_freq)
529                         return NL80211_CHAN_HT40PLUS;
530                 return NL80211_CHAN_HT40MINUS;
531         default:
532                 WARN_ON(1);
533                 return NL80211_CHAN_NO_HT;
534         }
535 }
536 
537 /**
538  * cfg80211_chandef_create - create channel definition using channel type
539  * @chandef: the channel definition struct to fill
540  * @channel: the control channel
541  * @chantype: the channel type
542  *
543  * Given a channel type, create a channel definition.
544  */
545 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
546                              struct ieee80211_channel *channel,
547                              enum nl80211_channel_type chantype);
548 
549 /**
550  * cfg80211_chandef_identical - check if two channel definitions are identical
551  * @chandef1: first channel definition
552  * @chandef2: second channel definition
553  *
554  * Return: %true if the channels defined by the channel definitions are
555  * identical, %false otherwise.
556  */
557 static inline bool
558 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
559                            const struct cfg80211_chan_def *chandef2)
560 {
561         return (chandef1->chan == chandef2->chan &&
562                 chandef1->width == chandef2->width &&
563                 chandef1->center_freq1 == chandef2->center_freq1 &&
564                 chandef1->center_freq2 == chandef2->center_freq2);
565 }
566 
567 /**
568  * cfg80211_chandef_compatible - check if two channel definitions are compatible
569  * @chandef1: first channel definition
570  * @chandef2: second channel definition
571  *
572  * Return: %NULL if the given channel definitions are incompatible,
573  * chandef1 or chandef2 otherwise.
574  */
575 const struct cfg80211_chan_def *
576 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
577                             const struct cfg80211_chan_def *chandef2);
578 
579 /**
580  * cfg80211_chandef_valid - check if a channel definition is valid
581  * @chandef: the channel definition to check
582  * Return: %true if the channel definition is valid. %false otherwise.
583  */
584 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
585 
586 /**
587  * cfg80211_chandef_usable - check if secondary channels can be used
588  * @wiphy: the wiphy to validate against
589  * @chandef: the channel definition to check
590  * @prohibited_flags: the regulatory channel flags that must not be set
591  * Return: %true if secondary channels are usable. %false otherwise.
592  */
593 bool cfg80211_chandef_usable(struct wiphy *wiphy,
594                              const struct cfg80211_chan_def *chandef,
595                              u32 prohibited_flags);
596 
597 /**
598  * cfg80211_chandef_dfs_required - checks if radar detection is required
599  * @wiphy: the wiphy to validate against
600  * @chandef: the channel definition to check
601  * @iftype: the interface type as specified in &enum nl80211_iftype
602  * Returns:
603  *      1 if radar detection is required, 0 if it is not, < 0 on error
604  */
605 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
606                                   const struct cfg80211_chan_def *chandef,
607                                   enum nl80211_iftype iftype);
608 
609 /**
610  * ieee80211_chandef_rate_flags - returns rate flags for a channel
611  *
612  * In some channel types, not all rates may be used - for example CCK
613  * rates may not be used in 5/10 MHz channels.
614  *
615  * @chandef: channel definition for the channel
616  *
617  * Returns: rate flags which apply for this channel
618  */
619 static inline enum ieee80211_rate_flags
620 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
621 {
622         switch (chandef->width) {
623         case NL80211_CHAN_WIDTH_5:
624                 return IEEE80211_RATE_SUPPORTS_5MHZ;
625         case NL80211_CHAN_WIDTH_10:
626                 return IEEE80211_RATE_SUPPORTS_10MHZ;
627         default:
628                 break;
629         }
630         return 0;
631 }
632 
633 /**
634  * ieee80211_chandef_max_power - maximum transmission power for the chandef
635  *
636  * In some regulations, the transmit power may depend on the configured channel
637  * bandwidth which may be defined as dBm/MHz. This function returns the actual
638  * max_power for non-standard (20 MHz) channels.
639  *
640  * @chandef: channel definition for the channel
641  *
642  * Returns: maximum allowed transmission power in dBm for the chandef
643  */
644 static inline int
645 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
646 {
647         switch (chandef->width) {
648         case NL80211_CHAN_WIDTH_5:
649                 return min(chandef->chan->max_reg_power - 6,
650                            chandef->chan->max_power);
651         case NL80211_CHAN_WIDTH_10:
652                 return min(chandef->chan->max_reg_power - 3,
653                            chandef->chan->max_power);
654         default:
655                 break;
656         }
657         return chandef->chan->max_power;
658 }
659 
660 /**
661  * enum survey_info_flags - survey information flags
662  *
663  * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
664  * @SURVEY_INFO_IN_USE: channel is currently being used
665  * @SURVEY_INFO_TIME: active time (in ms) was filled in
666  * @SURVEY_INFO_TIME_BUSY: busy time was filled in
667  * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
668  * @SURVEY_INFO_TIME_RX: receive time was filled in
669  * @SURVEY_INFO_TIME_TX: transmit time was filled in
670  * @SURVEY_INFO_TIME_SCAN: scan time was filled in
671  *
672  * Used by the driver to indicate which info in &struct survey_info
673  * it has filled in during the get_survey().
674  */
675 enum survey_info_flags {
676         SURVEY_INFO_NOISE_DBM           = BIT(0),
677         SURVEY_INFO_IN_USE              = BIT(1),
678         SURVEY_INFO_TIME                = BIT(2),
679         SURVEY_INFO_TIME_BUSY           = BIT(3),
680         SURVEY_INFO_TIME_EXT_BUSY       = BIT(4),
681         SURVEY_INFO_TIME_RX             = BIT(5),
682         SURVEY_INFO_TIME_TX             = BIT(6),
683         SURVEY_INFO_TIME_SCAN           = BIT(7),
684 };
685 
686 /**
687  * struct survey_info - channel survey response
688  *
689  * @channel: the channel this survey record reports, may be %NULL for a single
690  *      record to report global statistics
691  * @filled: bitflag of flags from &enum survey_info_flags
692  * @noise: channel noise in dBm. This and all following fields are
693  *      optional
694  * @time: amount of time in ms the radio was turn on (on the channel)
695  * @time_busy: amount of time the primary channel was sensed busy
696  * @time_ext_busy: amount of time the extension channel was sensed busy
697  * @time_rx: amount of time the radio spent receiving data
698  * @time_tx: amount of time the radio spent transmitting data
699  * @time_scan: amount of time the radio spent for scanning
700  *
701  * Used by dump_survey() to report back per-channel survey information.
702  *
703  * This structure can later be expanded with things like
704  * channel duty cycle etc.
705  */
706 struct survey_info {
707         struct ieee80211_channel *channel;
708         u64 time;
709         u64 time_busy;
710         u64 time_ext_busy;
711         u64 time_rx;
712         u64 time_tx;
713         u64 time_scan;
714         u32 filled;
715         s8 noise;
716 };
717 
718 #define CFG80211_MAX_WEP_KEYS   4
719 
720 /**
721  * struct cfg80211_crypto_settings - Crypto settings
722  * @wpa_versions: indicates which, if any, WPA versions are enabled
723  *      (from enum nl80211_wpa_versions)
724  * @cipher_group: group key cipher suite (or 0 if unset)
725  * @n_ciphers_pairwise: number of AP supported unicast ciphers
726  * @ciphers_pairwise: unicast key cipher suites
727  * @n_akm_suites: number of AKM suites
728  * @akm_suites: AKM suites
729  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
730  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
731  *      required to assume that the port is unauthorized until authorized by
732  *      user space. Otherwise, port is marked authorized by default.
733  * @control_port_ethertype: the control port protocol that should be
734  *      allowed through even on unauthorized ports
735  * @control_port_no_encrypt: TRUE to prevent encryption of control port
736  *      protocol frames.
737  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
738  *      port frames over NL80211 instead of the network interface.
739  * @wep_keys: static WEP keys, if not NULL points to an array of
740  *      CFG80211_MAX_WEP_KEYS WEP keys
741  * @wep_tx_key: key index (0..3) of the default TX static WEP key
742  * @psk: PSK (for devices supporting 4-way-handshake offload)
743  */
744 struct cfg80211_crypto_settings {
745         u32 wpa_versions;
746         u32 cipher_group;
747         int n_ciphers_pairwise;
748         u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
749         int n_akm_suites;
750         u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
751         bool control_port;
752         __be16 control_port_ethertype;
753         bool control_port_no_encrypt;
754         bool control_port_over_nl80211;
755         struct key_params *wep_keys;
756         int wep_tx_key;
757         const u8 *psk;
758 };
759 
760 /**
761  * struct cfg80211_beacon_data - beacon data
762  * @head: head portion of beacon (before TIM IE)
763  *      or %NULL if not changed
764  * @tail: tail portion of beacon (after TIM IE)
765  *      or %NULL if not changed
766  * @head_len: length of @head
767  * @tail_len: length of @tail
768  * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
769  * @beacon_ies_len: length of beacon_ies in octets
770  * @proberesp_ies: extra information element(s) to add into Probe Response
771  *      frames or %NULL
772  * @proberesp_ies_len: length of proberesp_ies in octets
773  * @assocresp_ies: extra information element(s) to add into (Re)Association
774  *      Response frames or %NULL
775  * @assocresp_ies_len: length of assocresp_ies in octets
776  * @probe_resp_len: length of probe response template (@probe_resp)
777  * @probe_resp: probe response template (AP mode only)
778  * @ftm_responder: enable FTM responder functionality; -1 for no change
779  *      (which also implies no change in LCI/civic location data)
780  * @lci: Measurement Report element content, starting with Measurement Token
781  *      (measurement type 8)
782  * @civicloc: Measurement Report element content, starting with Measurement
783  *      Token (measurement type 11)
784  * @lci_len: LCI data length
785  * @civicloc_len: Civic location data length
786  */
787 struct cfg80211_beacon_data {
788         const u8 *head, *tail;
789         const u8 *beacon_ies;
790         const u8 *proberesp_ies;
791         const u8 *assocresp_ies;
792         const u8 *probe_resp;
793         const u8 *lci;
794         const u8 *civicloc;
795         s8 ftm_responder;
796 
797         size_t head_len, tail_len;
798         size_t beacon_ies_len;
799         size_t proberesp_ies_len;
800         size_t assocresp_ies_len;
801         size_t probe_resp_len;
802         size_t lci_len;
803         size_t civicloc_len;
804 };
805 
806 struct mac_address {
807         u8 addr[ETH_ALEN];
808 };
809 
810 /**
811  * struct cfg80211_acl_data - Access control list data
812  *
813  * @acl_policy: ACL policy to be applied on the station's
814  *      entry specified by mac_addr
815  * @n_acl_entries: Number of MAC address entries passed
816  * @mac_addrs: List of MAC addresses of stations to be used for ACL
817  */
818 struct cfg80211_acl_data {
819         enum nl80211_acl_policy acl_policy;
820         int n_acl_entries;
821 
822         /* Keep it last */
823         struct mac_address mac_addrs[];
824 };
825 
826 /*
827  * cfg80211_bitrate_mask - masks for bitrate control
828  */
829 struct cfg80211_bitrate_mask {
830         struct {
831                 u32 legacy;
832                 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
833                 u16 vht_mcs[NL80211_VHT_NSS_MAX];
834                 enum nl80211_txrate_gi gi;
835         } control[NUM_NL80211_BANDS];
836 };
837 
838 /**
839  * enum cfg80211_ap_settings_flags - AP settings flags
840  *
841  * Used by cfg80211_ap_settings
842  *
843  * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
844  */
845 enum cfg80211_ap_settings_flags {
846         AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
847 };
848 
849 /**
850  * struct cfg80211_ap_settings - AP configuration
851  *
852  * Used to configure an AP interface.
853  *
854  * @chandef: defines the channel to use
855  * @beacon: beacon data
856  * @beacon_interval: beacon interval
857  * @dtim_period: DTIM period
858  * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
859  *      user space)
860  * @ssid_len: length of @ssid
861  * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
862  * @crypto: crypto settings
863  * @privacy: the BSS uses privacy
864  * @auth_type: Authentication type (algorithm)
865  * @smps_mode: SMPS mode
866  * @inactivity_timeout: time in seconds to determine station's inactivity.
867  * @p2p_ctwindow: P2P CT Window
868  * @p2p_opp_ps: P2P opportunistic PS
869  * @acl: ACL configuration used by the drivers which has support for
870  *      MAC address based access control
871  * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
872  *      networks.
873  * @beacon_rate: bitrate to be used for beacons
874  * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
875  * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
876  * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
877  * @ht_required: stations must support HT
878  * @vht_required: stations must support VHT
879  * @flags: flags, as defined in enum cfg80211_ap_settings_flags
880  */
881 struct cfg80211_ap_settings {
882         struct cfg80211_chan_def chandef;
883 
884         struct cfg80211_beacon_data beacon;
885 
886         int beacon_interval, dtim_period;
887         const u8 *ssid;
888         size_t ssid_len;
889         enum nl80211_hidden_ssid hidden_ssid;
890         struct cfg80211_crypto_settings crypto;
891         bool privacy;
892         enum nl80211_auth_type auth_type;
893         enum nl80211_smps_mode smps_mode;
894         int inactivity_timeout;
895         u8 p2p_ctwindow;
896         bool p2p_opp_ps;
897         const struct cfg80211_acl_data *acl;
898         bool pbss;
899         struct cfg80211_bitrate_mask beacon_rate;
900 
901         const struct ieee80211_ht_cap *ht_cap;
902         const struct ieee80211_vht_cap *vht_cap;
903         const struct ieee80211_he_cap_elem *he_cap;
904         bool ht_required, vht_required;
905         u32 flags;
906 };
907 
908 /**
909  * struct cfg80211_csa_settings - channel switch settings
910  *
911  * Used for channel switch
912  *
913  * @chandef: defines the channel to use after the switch
914  * @beacon_csa: beacon data while performing the switch
915  * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
916  * @counter_offsets_presp: offsets of the counters within the probe response
917  * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
918  * @n_counter_offsets_presp: number of csa counters in the probe response
919  * @beacon_after: beacon data to be used on the new channel
920  * @radar_required: whether radar detection is required on the new channel
921  * @block_tx: whether transmissions should be blocked while changing
922  * @count: number of beacons until switch
923  */
924 struct cfg80211_csa_settings {
925         struct cfg80211_chan_def chandef;
926         struct cfg80211_beacon_data beacon_csa;
927         const u16 *counter_offsets_beacon;
928         const u16 *counter_offsets_presp;
929         unsigned int n_counter_offsets_beacon;
930         unsigned int n_counter_offsets_presp;
931         struct cfg80211_beacon_data beacon_after;
932         bool radar_required;
933         bool block_tx;
934         u8 count;
935 };
936 
937 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
938 
939 /**
940  * struct iface_combination_params - input parameters for interface combinations
941  *
942  * Used to pass interface combination parameters
943  *
944  * @num_different_channels: the number of different channels we want
945  *      to use for verification
946  * @radar_detect: a bitmap where each bit corresponds to a channel
947  *      width where radar detection is needed, as in the definition of
948  *      &struct ieee80211_iface_combination.@radar_detect_widths
949  * @iftype_num: array with the number of interfaces of each interface
950  *      type.  The index is the interface type as specified in &enum
951  *      nl80211_iftype.
952  * @new_beacon_int: set this to the beacon interval of a new interface
953  *      that's not operating yet, if such is to be checked as part of
954  *      the verification
955  */
956 struct iface_combination_params {
957         int num_different_channels;
958         u8 radar_detect;
959         int iftype_num[NUM_NL80211_IFTYPES];
960         u32 new_beacon_int;
961 };
962 
963 /**
964  * enum station_parameters_apply_mask - station parameter values to apply
965  * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
966  * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
967  * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
968  *
969  * Not all station parameters have in-band "no change" signalling,
970  * for those that don't these flags will are used.
971  */
972 enum station_parameters_apply_mask {
973         STATION_PARAM_APPLY_UAPSD = BIT(0),
974         STATION_PARAM_APPLY_CAPABILITY = BIT(1),
975         STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
976 };
977 
978 /**
979  * struct station_parameters - station parameters
980  *
981  * Used to change and create a new station.
982  *
983  * @vlan: vlan interface station should belong to
984  * @supported_rates: supported rates in IEEE 802.11 format
985  *      (or NULL for no change)
986  * @supported_rates_len: number of supported rates
987  * @sta_flags_mask: station flags that changed
988  *      (bitmask of BIT(%NL80211_STA_FLAG_...))
989  * @sta_flags_set: station flags values
990  *      (bitmask of BIT(%NL80211_STA_FLAG_...))
991  * @listen_interval: listen interval or -1 for no change
992  * @aid: AID or zero for no change
993  * @peer_aid: mesh peer AID or zero for no change
994  * @plink_action: plink action to take
995  * @plink_state: set the peer link state for a station
996  * @ht_capa: HT capabilities of station
997  * @vht_capa: VHT capabilities of station
998  * @uapsd_queues: bitmap of queues configured for uapsd. same format
999  *      as the AC bitmap in the QoS info field
1000  * @max_sp: max Service Period. same format as the MAX_SP in the
1001  *      QoS info field (but already shifted down)
1002  * @sta_modify_mask: bitmap indicating which parameters changed
1003  *      (for those that don't have a natural "no change" value),
1004  *      see &enum station_parameters_apply_mask
1005  * @local_pm: local link-specific mesh power save mode (no change when set
1006  *      to unknown)
1007  * @capability: station capability
1008  * @ext_capab: extended capabilities of the station
1009  * @ext_capab_len: number of extended capabilities
1010  * @supported_channels: supported channels in IEEE 802.11 format
1011  * @supported_channels_len: number of supported channels
1012  * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1013  * @supported_oper_classes_len: number of supported operating classes
1014  * @opmode_notif: operating mode field from Operating Mode Notification
1015  * @opmode_notif_used: information if operating mode field is used
1016  * @support_p2p_ps: information if station supports P2P PS mechanism
1017  * @he_capa: HE capabilities of station
1018  * @he_capa_len: the length of the HE capabilities
1019  * @airtime_weight: airtime scheduler weight for this station
1020  */
1021 struct station_parameters {
1022         const u8 *supported_rates;
1023         struct net_device *vlan;
1024         u32 sta_flags_mask, sta_flags_set;
1025         u32 sta_modify_mask;
1026         int listen_interval;
1027         u16 aid;
1028         u16 peer_aid;
1029         u8 supported_rates_len;
1030         u8 plink_action;
1031         u8 plink_state;
1032         const struct ieee80211_ht_cap *ht_capa;
1033         const struct ieee80211_vht_cap *vht_capa;
1034         u8 uapsd_queues;
1035         u8 max_sp;
1036         enum nl80211_mesh_power_mode local_pm;
1037         u16 capability;
1038         const u8 *ext_capab;
1039         u8 ext_capab_len;
1040         const u8 *supported_channels;
1041         u8 supported_channels_len;
1042         const u8 *supported_oper_classes;
1043         u8 supported_oper_classes_len;
1044         u8 opmode_notif;
1045         bool opmode_notif_used;
1046         int support_p2p_ps;
1047         const struct ieee80211_he_cap_elem *he_capa;
1048         u8 he_capa_len;
1049         u16 airtime_weight;
1050 };
1051 
1052 /**
1053  * struct station_del_parameters - station deletion parameters
1054  *
1055  * Used to delete a station entry (or all stations).
1056  *
1057  * @mac: MAC address of the station to remove or NULL to remove all stations
1058  * @subtype: Management frame subtype to use for indicating removal
1059  *      (10 = Disassociation, 12 = Deauthentication)
1060  * @reason_code: Reason code for the Disassociation/Deauthentication frame
1061  */
1062 struct station_del_parameters {
1063         const u8 *mac;
1064         u8 subtype;
1065         u16 reason_code;
1066 };
1067 
1068 /**
1069  * enum cfg80211_station_type - the type of station being modified
1070  * @CFG80211_STA_AP_CLIENT: client of an AP interface
1071  * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1072  *      unassociated (update properties for this type of client is permitted)
1073  * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1074  *      the AP MLME in the device
1075  * @CFG80211_STA_AP_STA: AP station on managed interface
1076  * @CFG80211_STA_IBSS: IBSS station
1077  * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1078  *      while TDLS setup is in progress, it moves out of this state when
1079  *      being marked authorized; use this only if TDLS with external setup is
1080  *      supported/used)
1081  * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1082  *      entry that is operating, has been marked authorized by userspace)
1083  * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1084  * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1085  */
1086 enum cfg80211_station_type {
1087         CFG80211_STA_AP_CLIENT,
1088         CFG80211_STA_AP_CLIENT_UNASSOC,
1089         CFG80211_STA_AP_MLME_CLIENT,
1090         CFG80211_STA_AP_STA,
1091         CFG80211_STA_IBSS,
1092         CFG80211_STA_TDLS_PEER_SETUP,
1093         CFG80211_STA_TDLS_PEER_ACTIVE,
1094         CFG80211_STA_MESH_PEER_KERNEL,
1095         CFG80211_STA_MESH_PEER_USER,
1096 };
1097 
1098 /**
1099  * cfg80211_check_station_change - validate parameter changes
1100  * @wiphy: the wiphy this operates on
1101  * @params: the new parameters for a station
1102  * @statype: the type of station being modified
1103  *
1104  * Utility function for the @change_station driver method. Call this function
1105  * with the appropriate station type looking up the station (and checking that
1106  * it exists). It will verify whether the station change is acceptable, and if
1107  * not will return an error code. Note that it may modify the parameters for
1108  * backward compatibility reasons, so don't use them before calling this.
1109  */
1110 int cfg80211_check_station_change(struct wiphy *wiphy,
1111                                   struct station_parameters *params,
1112                                   enum cfg80211_station_type statype);
1113 
1114 /**
1115  * enum station_info_rate_flags - bitrate info flags
1116  *
1117  * Used by the driver to indicate the specific rate transmission
1118  * type for 802.11n transmissions.
1119  *
1120  * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1121  * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1122  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1123  * @RATE_INFO_FLAGS_60G: 60GHz MCS
1124  * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1125  */
1126 enum rate_info_flags {
1127         RATE_INFO_FLAGS_MCS                     = BIT(0),
1128         RATE_INFO_FLAGS_VHT_MCS                 = BIT(1),
1129         RATE_INFO_FLAGS_SHORT_GI                = BIT(2),
1130         RATE_INFO_FLAGS_60G                     = BIT(3),
1131         RATE_INFO_FLAGS_HE_MCS                  = BIT(4),
1132 };
1133 
1134 /**
1135  * enum rate_info_bw - rate bandwidth information
1136  *
1137  * Used by the driver to indicate the rate bandwidth.
1138  *
1139  * @RATE_INFO_BW_5: 5 MHz bandwidth
1140  * @RATE_INFO_BW_10: 10 MHz bandwidth
1141  * @RATE_INFO_BW_20: 20 MHz bandwidth
1142  * @RATE_INFO_BW_40: 40 MHz bandwidth
1143  * @RATE_INFO_BW_80: 80 MHz bandwidth
1144  * @RATE_INFO_BW_160: 160 MHz bandwidth
1145  * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1146  */
1147 enum rate_info_bw {
1148         RATE_INFO_BW_20 = 0,
1149         RATE_INFO_BW_5,
1150         RATE_INFO_BW_10,
1151         RATE_INFO_BW_40,
1152         RATE_INFO_BW_80,
1153         RATE_INFO_BW_160,
1154         RATE_INFO_BW_HE_RU,
1155 };
1156 
1157 /**
1158  * struct rate_info - bitrate information
1159  *
1160  * Information about a receiving or transmitting bitrate
1161  *
1162  * @flags: bitflag of flags from &enum rate_info_flags
1163  * @mcs: mcs index if struct describes an HT/VHT/HE rate
1164  * @legacy: bitrate in 100kbit/s for 802.11abg
1165  * @nss: number of streams (VHT & HE only)
1166  * @bw: bandwidth (from &enum rate_info_bw)
1167  * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1168  * @he_dcm: HE DCM value
1169  * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1170  *      only valid if bw is %RATE_INFO_BW_HE_RU)
1171  */
1172 struct rate_info {
1173         u8 flags;
1174         u8 mcs;
1175         u16 legacy;
1176         u8 nss;
1177         u8 bw;
1178         u8 he_gi;
1179         u8 he_dcm;
1180         u8 he_ru_alloc;
1181 };
1182 
1183 /**
1184  * enum station_info_rate_flags - bitrate info flags
1185  *
1186  * Used by the driver to indicate the specific rate transmission
1187  * type for 802.11n transmissions.
1188  *
1189  * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1190  * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1191  * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1192  */
1193 enum bss_param_flags {
1194         BSS_PARAM_FLAGS_CTS_PROT        = 1<<0,
1195         BSS_PARAM_FLAGS_SHORT_PREAMBLE  = 1<<1,
1196         BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1197 };
1198 
1199 /**
1200  * struct sta_bss_parameters - BSS parameters for the attached station
1201  *
1202  * Information about the currently associated BSS
1203  *
1204  * @flags: bitflag of flags from &enum bss_param_flags
1205  * @dtim_period: DTIM period for the BSS
1206  * @beacon_interval: beacon interval
1207  */
1208 struct sta_bss_parameters {
1209         u8 flags;
1210         u8 dtim_period;
1211         u16 beacon_interval;
1212 };
1213 
1214 /**
1215  * struct cfg80211_txq_stats - TXQ statistics for this TID
1216  * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1217  *      indicate the relevant values in this struct are filled
1218  * @backlog_bytes: total number of bytes currently backlogged
1219  * @backlog_packets: total number of packets currently backlogged
1220  * @flows: number of new flows seen
1221  * @drops: total number of packets dropped
1222  * @ecn_marks: total number of packets marked with ECN CE
1223  * @overlimit: number of drops due to queue space overflow
1224  * @overmemory: number of drops due to memory limit overflow
1225  * @collisions: number of hash collisions
1226  * @tx_bytes: total number of bytes dequeued
1227  * @tx_packets: total number of packets dequeued
1228  * @max_flows: maximum number of flows supported
1229  */
1230 struct cfg80211_txq_stats {
1231         u32 filled;
1232         u32 backlog_bytes;
1233         u32 backlog_packets;
1234         u32 flows;
1235         u32 drops;
1236         u32 ecn_marks;
1237         u32 overlimit;
1238         u32 overmemory;
1239         u32 collisions;
1240         u32 tx_bytes;
1241         u32 tx_packets;
1242         u32 max_flows;
1243 };
1244 
1245 /**
1246  * struct cfg80211_tid_stats - per-TID statistics
1247  * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1248  *      indicate the relevant values in this struct are filled
1249  * @rx_msdu: number of received MSDUs
1250  * @tx_msdu: number of (attempted) transmitted MSDUs
1251  * @tx_msdu_retries: number of retries (not counting the first) for
1252  *      transmitted MSDUs
1253  * @tx_msdu_failed: number of failed transmitted MSDUs
1254  * @txq_stats: TXQ statistics
1255  */
1256 struct cfg80211_tid_stats {
1257         u32 filled;
1258         u64 rx_msdu;
1259         u64 tx_msdu;
1260         u64 tx_msdu_retries;
1261         u64 tx_msdu_failed;
1262         struct cfg80211_txq_stats txq_stats;
1263 };
1264 
1265 #define IEEE80211_MAX_CHAINS    4
1266 
1267 /**
1268  * struct station_info - station information
1269  *
1270  * Station information filled by driver for get_station() and dump_station.
1271  *
1272  * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1273  *      indicate the relevant values in this struct for them
1274  * @connected_time: time(in secs) since a station is last connected
1275  * @inactive_time: time since last station activity (tx/rx) in milliseconds
1276  * @rx_bytes: bytes (size of MPDUs) received from this station
1277  * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1278  * @llid: mesh local link id
1279  * @plid: mesh peer link id
1280  * @plink_state: mesh peer link state
1281  * @signal: The signal strength, type depends on the wiphy's signal_type.
1282  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1283  * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1284  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1285  * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1286  * @chain_signal: per-chain signal strength of last received packet in dBm
1287  * @chain_signal_avg: per-chain signal strength average in dBm
1288  * @txrate: current unicast bitrate from this station
1289  * @rxrate: current unicast bitrate to this station
1290  * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1291  * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1292  * @tx_retries: cumulative retry counts (MPDUs)
1293  * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1294  * @rx_dropped_misc:  Dropped for un-specified reason.
1295  * @bss_param: current BSS parameters
1296  * @generation: generation number for nl80211 dumps.
1297  *      This number should increase every time the list of stations
1298  *      changes, i.e. when a station is added or removed, so that
1299  *      userspace can tell whether it got a consistent snapshot.
1300  * @assoc_req_ies: IEs from (Re)Association Request.
1301  *      This is used only when in AP mode with drivers that do not use
1302  *      user space MLME/SME implementation. The information is provided for
1303  *      the cfg80211_new_sta() calls to notify user space of the IEs.
1304  * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1305  * @sta_flags: station flags mask & values
1306  * @beacon_loss_count: Number of times beacon loss event has triggered.
1307  * @t_offset: Time offset of the station relative to this host.
1308  * @local_pm: local mesh STA power save mode
1309  * @peer_pm: peer mesh STA power save mode
1310  * @nonpeer_pm: non-peer mesh STA power save mode
1311  * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1312  *      towards this station.
1313  * @rx_beacon: number of beacons received from this peer
1314  * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1315  *      from this peer
1316  * @connected_to_gate: true if mesh STA has a path to mesh gate
1317  * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1318  * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1319  * @airtime_weight: current airtime scheduling weight
1320  * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1321  *      (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1322  *      Note that this doesn't use the @filled bit, but is used if non-NULL.
1323  * @ack_signal: signal strength (in dBm) of the last ACK frame.
1324  * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1325  *      been sent.
1326  * @rx_mpdu_count: number of MPDUs received from this station
1327  * @fcs_err_count: number of packets (MPDUs) received from this station with
1328  *      an FCS error. This counter should be incremented only when TA of the
1329  *      received packet with an FCS error matches the peer MAC address.
1330  */
1331 struct station_info {
1332         u64 filled;
1333         u32 connected_time;
1334         u32 inactive_time;
1335         u64 rx_bytes;
1336         u64 tx_bytes;
1337         u16 llid;
1338         u16 plid;
1339         u8 plink_state;
1340         s8 signal;
1341         s8 signal_avg;
1342 
1343         u8 chains;
1344         s8 chain_signal[IEEE80211_MAX_CHAINS];
1345         s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1346 
1347         struct rate_info txrate;
1348         struct rate_info rxrate;
1349         u32 rx_packets;
1350         u32 tx_packets;
1351         u32 tx_retries;
1352         u32 tx_failed;
1353         u32 rx_dropped_misc;
1354         struct sta_bss_parameters bss_param;
1355         struct nl80211_sta_flag_update sta_flags;
1356 
1357         int generation;
1358 
1359         const u8 *assoc_req_ies;
1360         size_t assoc_req_ies_len;
1361 
1362         u32 beacon_loss_count;
1363         s64 t_offset;
1364         enum nl80211_mesh_power_mode local_pm;
1365         enum nl80211_mesh_power_mode peer_pm;
1366         enum nl80211_mesh_power_mode nonpeer_pm;
1367 
1368         u32 expected_throughput;
1369 
1370         u64 tx_duration;
1371         u64 rx_duration;
1372         u64 rx_beacon;
1373         u8 rx_beacon_signal_avg;
1374         u8 connected_to_gate;
1375 
1376         struct cfg80211_tid_stats *pertid;
1377         s8 ack_signal;
1378         s8 avg_ack_signal;
1379 
1380         u16 airtime_weight;
1381 
1382         u32 rx_mpdu_count;
1383         u32 fcs_err_count;
1384 };
1385 
1386 #if IS_ENABLED(CONFIG_CFG80211)
1387 /**
1388  * cfg80211_get_station - retrieve information about a given station
1389  * @dev: the device where the station is supposed to be connected to
1390  * @mac_addr: the mac address of the station of interest
1391  * @sinfo: pointer to the structure to fill with the information
1392  *
1393  * Returns 0 on success and sinfo is filled with the available information
1394  * otherwise returns a negative error code and the content of sinfo has to be
1395  * considered undefined.
1396  */
1397 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1398                          struct station_info *sinfo);
1399 #else
1400 static inline int cfg80211_get_station(struct net_device *dev,
1401                                        const u8 *mac_addr,
1402                                        struct station_info *sinfo)
1403 {
1404         return -ENOENT;
1405 }
1406 #endif
1407 
1408 /**
1409  * enum monitor_flags - monitor flags
1410  *
1411  * Monitor interface configuration flags. Note that these must be the bits
1412  * according to the nl80211 flags.
1413  *
1414  * @MONITOR_FLAG_CHANGED: set if the flags were changed
1415  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1416  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1417  * @MONITOR_FLAG_CONTROL: pass control frames
1418  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1419  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1420  * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1421  */
1422 enum monitor_flags {
1423         MONITOR_FLAG_CHANGED            = 1<<__NL80211_MNTR_FLAG_INVALID,
1424         MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1425         MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1426         MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
1427         MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1428         MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1429         MONITOR_FLAG_ACTIVE             = 1<<NL80211_MNTR_FLAG_ACTIVE,
1430 };
1431 
1432 /**
1433  * enum mpath_info_flags -  mesh path information flags
1434  *
1435  * Used by the driver to indicate which info in &struct mpath_info it has filled
1436  * in during get_station() or dump_station().
1437  *
1438  * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1439  * @MPATH_INFO_SN: @sn filled
1440  * @MPATH_INFO_METRIC: @metric filled
1441  * @MPATH_INFO_EXPTIME: @exptime filled
1442  * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1443  * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1444  * @MPATH_INFO_FLAGS: @flags filled
1445  * @MPATH_INFO_HOP_COUNT: @hop_count filled
1446  * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1447  */
1448 enum mpath_info_flags {
1449         MPATH_INFO_FRAME_QLEN           = BIT(0),
1450         MPATH_INFO_SN                   = BIT(1),
1451         MPATH_INFO_METRIC               = BIT(2),
1452         MPATH_INFO_EXPTIME              = BIT(3),
1453         MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
1454         MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
1455         MPATH_INFO_FLAGS                = BIT(6),
1456         MPATH_INFO_HOP_COUNT            = BIT(7),
1457         MPATH_INFO_PATH_CHANGE          = BIT(8),
1458 };
1459 
1460 /**
1461  * struct mpath_info - mesh path information
1462  *
1463  * Mesh path information filled by driver for get_mpath() and dump_mpath().
1464  *
1465  * @filled: bitfield of flags from &enum mpath_info_flags
1466  * @frame_qlen: number of queued frames for this destination
1467  * @sn: target sequence number
1468  * @metric: metric (cost) of this mesh path
1469  * @exptime: expiration time for the mesh path from now, in msecs
1470  * @flags: mesh path flags
1471  * @discovery_timeout: total mesh path discovery timeout, in msecs
1472  * @discovery_retries: mesh path discovery retries
1473  * @generation: generation number for nl80211 dumps.
1474  *      This number should increase every time the list of mesh paths
1475  *      changes, i.e. when a station is added or removed, so that
1476  *      userspace can tell whether it got a consistent snapshot.
1477  * @hop_count: hops to destination
1478  * @path_change_count: total number of path changes to destination
1479  */
1480 struct mpath_info {
1481         u32 filled;
1482         u32 frame_qlen;
1483         u32 sn;
1484         u32 metric;
1485         u32 exptime;
1486         u32 discovery_timeout;
1487         u8 discovery_retries;
1488         u8 flags;
1489         u8 hop_count;
1490         u32 path_change_count;
1491 
1492         int generation;
1493 };
1494 
1495 /**
1496  * struct bss_parameters - BSS parameters
1497  *
1498  * Used to change BSS parameters (mainly for AP mode).
1499  *
1500  * @use_cts_prot: Whether to use CTS protection
1501  *      (0 = no, 1 = yes, -1 = do not change)
1502  * @use_short_preamble: Whether the use of short preambles is allowed
1503  *      (0 = no, 1 = yes, -1 = do not change)
1504  * @use_short_slot_time: Whether the use of short slot time is allowed
1505  *      (0 = no, 1 = yes, -1 = do not change)
1506  * @basic_rates: basic rates in IEEE 802.11 format
1507  *      (or NULL for no change)
1508  * @basic_rates_len: number of basic rates
1509  * @ap_isolate: do not forward packets between connected stations
1510  * @ht_opmode: HT Operation mode
1511  *      (u16 = opmode, -1 = do not change)
1512  * @p2p_ctwindow: P2P CT Window (-1 = no change)
1513  * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1514  */
1515 struct bss_parameters {
1516         int use_cts_prot;
1517         int use_short_preamble;
1518         int use_short_slot_time;
1519         const u8 *basic_rates;
1520         u8 basic_rates_len;
1521         int ap_isolate;
1522         int ht_opmode;
1523         s8 p2p_ctwindow, p2p_opp_ps;
1524 };
1525 
1526 /**
1527  * struct mesh_config - 802.11s mesh configuration
1528  *
1529  * These parameters can be changed while the mesh is active.
1530  *
1531  * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1532  *      by the Mesh Peering Open message
1533  * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1534  *      used by the Mesh Peering Open message
1535  * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1536  *      the mesh peering management to close a mesh peering
1537  * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1538  *      mesh interface
1539  * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1540  *      be sent to establish a new peer link instance in a mesh
1541  * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1542  * @element_ttl: the value of TTL field set at a mesh STA for path selection
1543  *      elements
1544  * @auto_open_plinks: whether we should automatically open peer links when we
1545  *      detect compatible mesh peers
1546  * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1547  *      synchronize to for 11s default synchronization method
1548  * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1549  *      that an originator mesh STA can send to a particular path target
1550  * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1551  * @min_discovery_timeout: the minimum length of time to wait until giving up on
1552  *      a path discovery in milliseconds
1553  * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1554  *      receiving a PREQ shall consider the forwarding information from the
1555  *      root to be valid. (TU = time unit)
1556  * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1557  *      which a mesh STA can send only one action frame containing a PREQ
1558  *      element
1559  * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1560  *      which a mesh STA can send only one Action frame containing a PERR
1561  *      element
1562  * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1563  *      it takes for an HWMP information element to propagate across the mesh
1564  * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1565  * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1566  *      announcements are transmitted
1567  * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1568  *      station has access to a broader network beyond the MBSS. (This is
1569  *      missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1570  *      only means that the station will announce others it's a mesh gate, but
1571  *      not necessarily using the gate announcement protocol. Still keeping the
1572  *      same nomenclature to be in sync with the spec)
1573  * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1574  *      entity (default is TRUE - forwarding entity)
1575  * @rssi_threshold: the threshold for average signal strength of candidate
1576  *      station to establish a peer link
1577  * @ht_opmode: mesh HT protection mode
1578  *
1579  * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1580  *      receiving a proactive PREQ shall consider the forwarding information to
1581  *      the root mesh STA to be valid.
1582  *
1583  * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1584  *      PREQs are transmitted.
1585  * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1586  *      during which a mesh STA can send only one Action frame containing
1587  *      a PREQ element for root path confirmation.
1588  * @power_mode: The default mesh power save mode which will be the initial
1589  *      setting for new peer links.
1590  * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1591  *      after transmitting its beacon.
1592  * @plink_timeout: If no tx activity is seen from a STA we've established
1593  *      peering with for longer than this time (in seconds), then remove it
1594  *      from the STA's list of peers.  Default is 30 minutes.
1595  * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1596  *      connected to a mesh gate in mesh formation info.  If false, the
1597  *      value in mesh formation is determined by the presence of root paths
1598  *      in the mesh path table
1599  */
1600 struct mesh_config {
1601         u16 dot11MeshRetryTimeout;
1602         u16 dot11MeshConfirmTimeout;
1603         u16 dot11MeshHoldingTimeout;
1604         u16 dot11MeshMaxPeerLinks;
1605         u8 dot11MeshMaxRetries;
1606         u8 dot11MeshTTL;
1607         u8 element_ttl;
1608         bool auto_open_plinks;
1609         u32 dot11MeshNbrOffsetMaxNeighbor;
1610         u8 dot11MeshHWMPmaxPREQretries;
1611         u32 path_refresh_time;
1612         u16 min_discovery_timeout;
1613         u32 dot11MeshHWMPactivePathTimeout;
1614         u16 dot11MeshHWMPpreqMinInterval;
1615         u16 dot11MeshHWMPperrMinInterval;
1616         u16 dot11MeshHWMPnetDiameterTraversalTime;
1617         u8 dot11MeshHWMPRootMode;
1618         bool dot11MeshConnectedToMeshGate;
1619         u16 dot11MeshHWMPRannInterval;
1620         bool dot11MeshGateAnnouncementProtocol;
1621         bool dot11MeshForwarding;
1622         s32 rssi_threshold;
1623         u16 ht_opmode;
1624         u32 dot11MeshHWMPactivePathToRootTimeout;
1625         u16 dot11MeshHWMProotInterval;
1626         u16 dot11MeshHWMPconfirmationInterval;
1627         enum nl80211_mesh_power_mode power_mode;
1628         u16 dot11MeshAwakeWindowDuration;
1629         u32 plink_timeout;
1630 };
1631 
1632 /**
1633  * struct mesh_setup - 802.11s mesh setup configuration
1634  * @chandef: defines the channel to use
1635  * @mesh_id: the mesh ID
1636  * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1637  * @sync_method: which synchronization method to use
1638  * @path_sel_proto: which path selection protocol to use
1639  * @path_metric: which metric to use
1640  * @auth_id: which authentication method this mesh is using
1641  * @ie: vendor information elements (optional)
1642  * @ie_len: length of vendor information elements
1643  * @is_authenticated: this mesh requires authentication
1644  * @is_secure: this mesh uses security
1645  * @user_mpm: userspace handles all MPM functions
1646  * @dtim_period: DTIM period to use
1647  * @beacon_interval: beacon interval to use
1648  * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1649  * @basic_rates: basic rates to use when creating the mesh
1650  * @beacon_rate: bitrate to be used for beacons
1651  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1652  *      changes the channel when a radar is detected. This is required
1653  *      to operate on DFS channels.
1654  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1655  *      port frames over NL80211 instead of the network interface.
1656  *
1657  * These parameters are fixed when the mesh is created.
1658  */
1659 struct mesh_setup {
1660         struct cfg80211_chan_def chandef;
1661         const u8 *mesh_id;
1662         u8 mesh_id_len;
1663         u8 sync_method;
1664         u8 path_sel_proto;
1665         u8 path_metric;
1666         u8 auth_id;
1667         const u8 *ie;
1668         u8 ie_len;
1669         bool is_authenticated;
1670         bool is_secure;
1671         bool user_mpm;
1672         u8 dtim_period;
1673         u16 beacon_interval;
1674         int mcast_rate[NUM_NL80211_BANDS];
1675         u32 basic_rates;
1676         struct cfg80211_bitrate_mask beacon_rate;
1677         bool userspace_handles_dfs;
1678         bool control_port_over_nl80211;
1679 };
1680 
1681 /**
1682  * struct ocb_setup - 802.11p OCB mode setup configuration
1683  * @chandef: defines the channel to use
1684  *
1685  * These parameters are fixed when connecting to the network
1686  */
1687 struct ocb_setup {
1688         struct cfg80211_chan_def chandef;
1689 };
1690 
1691 /**
1692  * struct ieee80211_txq_params - TX queue parameters
1693  * @ac: AC identifier
1694  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1695  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1696  *      1..32767]
1697  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1698  *      1..32767]
1699  * @aifs: Arbitration interframe space [0..255]
1700  */
1701 struct ieee80211_txq_params {
1702         enum nl80211_ac ac;
1703         u16 txop;
1704         u16 cwmin;
1705         u16 cwmax;
1706         u8 aifs;
1707 };
1708 
1709 /**
1710  * DOC: Scanning and BSS list handling
1711  *
1712  * The scanning process itself is fairly simple, but cfg80211 offers quite
1713  * a bit of helper functionality. To start a scan, the scan operation will
1714  * be invoked with a scan definition. This scan definition contains the
1715  * channels to scan, and the SSIDs to send probe requests for (including the
1716  * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1717  * probe. Additionally, a scan request may contain extra information elements
1718  * that should be added to the probe request. The IEs are guaranteed to be
1719  * well-formed, and will not exceed the maximum length the driver advertised
1720  * in the wiphy structure.
1721  *
1722  * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1723  * it is responsible for maintaining the BSS list; the driver should not
1724  * maintain a list itself. For this notification, various functions exist.
1725  *
1726  * Since drivers do not maintain a BSS list, there are also a number of
1727  * functions to search for a BSS and obtain information about it from the
1728  * BSS structure cfg80211 maintains. The BSS list is also made available
1729  * to userspace.
1730  */
1731 
1732 /**
1733  * struct cfg80211_ssid - SSID description
1734  * @ssid: the SSID
1735  * @ssid_len: length of the ssid
1736  */
1737 struct cfg80211_ssid {
1738         u8 ssid[IEEE80211_MAX_SSID_LEN];
1739         u8 ssid_len;
1740 };
1741 
1742 /**
1743  * struct cfg80211_scan_info - information about completed scan
1744  * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1745  *      wireless device that requested the scan is connected to. If this
1746  *      information is not available, this field is left zero.
1747  * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1748  * @aborted: set to true if the scan was aborted for any reason,
1749  *      userspace will be notified of that
1750  */
1751 struct cfg80211_scan_info {
1752         u64 scan_start_tsf;
1753         u8 tsf_bssid[ETH_ALEN] __aligned(2);
1754         bool aborted;
1755 };
1756 
1757 /**
1758  * struct cfg80211_scan_request - scan request description
1759  *
1760  * @ssids: SSIDs to scan for (active scan only)
1761  * @n_ssids: number of SSIDs
1762  * @channels: channels to scan on.
1763  * @n_channels: total number of channels to scan
1764  * @scan_width: channel width for scanning
1765  * @ie: optional information element(s) to add into Probe Request or %NULL
1766  * @ie_len: length of ie in octets
1767  * @duration: how long to listen on each channel, in TUs. If
1768  *      %duration_mandatory is not set, this is the maximum dwell time and
1769  *      the actual dwell time may be shorter.
1770  * @duration_mandatory: if set, the scan duration must be as specified by the
1771  *      %duration field.
1772  * @flags: bit field of flags controlling operation
1773  * @rates: bitmap of rates to advertise for each band
1774  * @wiphy: the wiphy this was for
1775  * @scan_start: time (in jiffies) when the scan started
1776  * @wdev: the wireless device to scan for
1777  * @info: (internal) information about completed scan
1778  * @notified: (internal) scan request was notified as done or aborted
1779  * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1780  * @mac_addr: MAC address used with randomisation
1781  * @mac_addr_mask: MAC address mask used with randomisation, bits that
1782  *      are 0 in the mask should be randomised, bits that are 1 should
1783  *      be taken from the @mac_addr
1784  * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1785  */
1786 struct cfg80211_scan_request {
1787         struct cfg80211_ssid *ssids;
1788         int n_ssids;
1789         u32 n_channels;
1790         enum nl80211_bss_scan_width scan_width;
1791         const u8 *ie;
1792         size_t ie_len;
1793         u16 duration;
1794         bool duration_mandatory;
1795         u32 flags;
1796 
1797         u32 rates[NUM_NL80211_BANDS];
1798 
1799         struct wireless_dev *wdev;
1800 
1801         u8 mac_addr[ETH_ALEN] __aligned(2);
1802         u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1803         u8 bssid[ETH_ALEN] __aligned(2);
1804 
1805         /* internal */
1806         struct wiphy *wiphy;
1807         unsigned long scan_start;
1808         struct cfg80211_scan_info info;
1809         bool notified;
1810         bool no_cck;
1811 
1812         /* keep last */
1813         struct ieee80211_channel *channels[0];
1814 };
1815 
1816 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1817 {
1818         int i;
1819 
1820         get_random_bytes(buf, ETH_ALEN);
1821         for (i = 0; i < ETH_ALEN; i++) {
1822                 buf[i] &= ~mask[i];
1823                 buf[i] |= addr[i] & mask[i];
1824         }
1825 }
1826 
1827 /**
1828  * struct cfg80211_match_set - sets of attributes to match
1829  *
1830  * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1831  *      or no match (RSSI only)
1832  * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1833  *      or no match (RSSI only)
1834  * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1835  */
1836 struct cfg80211_match_set {
1837         struct cfg80211_ssid ssid;
1838         u8 bssid[ETH_ALEN];
1839         s32 rssi_thold;
1840 };
1841 
1842 /**
1843  * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1844  *
1845  * @interval: interval between scheduled scan iterations. In seconds.
1846  * @iterations: number of scan iterations in this scan plan. Zero means
1847  *      infinite loop.
1848  *      The last scan plan will always have this parameter set to zero,
1849  *      all other scan plans will have a finite number of iterations.
1850  */
1851 struct cfg80211_sched_scan_plan {
1852         u32 interval;
1853         u32 iterations;
1854 };
1855 
1856 /**
1857  * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1858  *
1859  * @band: band of BSS which should match for RSSI level adjustment.
1860  * @delta: value of RSSI level adjustment.
1861  */
1862 struct cfg80211_bss_select_adjust {
1863         enum nl80211_band band;
1864         s8 delta;
1865 };
1866 
1867 /**
1868  * struct cfg80211_sched_scan_request - scheduled scan request description
1869  *
1870  * @reqid: identifies this request.
1871  * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1872  * @n_ssids: number of SSIDs
1873  * @n_channels: total number of channels to scan
1874  * @scan_width: channel width for scanning
1875  * @ie: optional information element(s) to add into Probe Request or %NULL
1876  * @ie_len: length of ie in octets
1877  * @flags: bit field of flags controlling operation
1878  * @match_sets: sets of parameters to be matched for a scan result
1879  *      entry to be considered valid and to be passed to the host
1880  *      (others are filtered out).
1881  *      If ommited, all results are passed.
1882  * @n_match_sets: number of match sets
1883  * @report_results: indicates that results were reported for this request
1884  * @wiphy: the wiphy this was for
1885  * @dev: the interface
1886  * @scan_start: start time of the scheduled scan
1887  * @channels: channels to scan
1888  * @min_rssi_thold: for drivers only supporting a single threshold, this
1889  *      contains the minimum over all matchsets
1890  * @mac_addr: MAC address used with randomisation
1891  * @mac_addr_mask: MAC address mask used with randomisation, bits that
1892  *      are 0 in the mask should be randomised, bits that are 1 should
1893  *      be taken from the @mac_addr
1894  * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1895  *      index must be executed first.
1896  * @n_scan_plans: number of scan plans, at least 1.
1897  * @rcu_head: RCU callback used to free the struct
1898  * @owner_nlportid: netlink portid of owner (if this should is a request
1899  *      owned by a particular socket)
1900  * @nl_owner_dead: netlink owner socket was closed - this request be freed
1901  * @list: for keeping list of requests.
1902  * @delay: delay in seconds to use before starting the first scan
1903  *      cycle.  The driver may ignore this parameter and start
1904  *      immediately (or at any other time), if this feature is not
1905  *      supported.
1906  * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
1907  * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
1908  *      reporting in connected state to cases where a matching BSS is determined
1909  *      to have better or slightly worse RSSI than the current connected BSS.
1910  *      The relative RSSI threshold values are ignored in disconnected state.
1911  * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
1912  *      to the specified band while deciding whether a better BSS is reported
1913  *      using @relative_rssi. If delta is a negative number, the BSSs that
1914  *      belong to the specified band will be penalized by delta dB in relative
1915  *      comparisions.
1916  */
1917 struct cfg80211_sched_scan_request {
1918         u64 reqid;
1919         struct cfg80211_ssid *ssids;
1920         int n_ssids;
1921         u32 n_channels;
1922         enum nl80211_bss_scan_width scan_width;
1923         const u8 *ie;
1924         size_t ie_len;
1925         u32 flags;
1926         struct cfg80211_match_set *match_sets;
1927         int n_match_sets;
1928         s32 min_rssi_thold;
1929         u32 delay;
1930         struct cfg80211_sched_scan_plan *scan_plans;
1931         int n_scan_plans;
1932 
1933         u8 mac_addr[ETH_ALEN] __aligned(2);
1934         u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1935 
1936         bool relative_rssi_set;
1937         s8 relative_rssi;
1938         struct cfg80211_bss_select_adjust rssi_adjust;
1939 
1940         /* internal */
1941         struct wiphy *wiphy;
1942         struct net_device *dev;
1943         unsigned long scan_start;
1944         bool report_results;
1945         struct rcu_head rcu_head;
1946         u32 owner_nlportid;
1947         bool nl_owner_dead;
1948         struct list_head list;
1949 
1950         /* keep last */
1951         struct ieee80211_channel *channels[0];
1952 };
1953 
1954 /**
1955  * enum cfg80211_signal_type - signal type
1956  *
1957  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1958  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1959  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1960  */
1961 enum cfg80211_signal_type {
1962         CFG80211_SIGNAL_TYPE_NONE,
1963         CFG80211_SIGNAL_TYPE_MBM,
1964         CFG80211_SIGNAL_TYPE_UNSPEC,
1965 };
1966 
1967 /**
1968  * struct cfg80211_inform_bss - BSS inform data
1969  * @chan: channel the frame was received on
1970  * @scan_width: scan width that was used
1971  * @signal: signal strength value, according to the wiphy's
1972  *      signal type
1973  * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1974  *      received; should match the time when the frame was actually
1975  *      received by the device (not just by the host, in case it was
1976  *      buffered on the device) and be accurate to about 10ms.
1977  *      If the frame isn't buffered, just passing the return value of
1978  *      ktime_get_boot_ns() is likely appropriate.
1979  * @parent_tsf: the time at the start of reception of the first octet of the
1980  *      timestamp field of the frame. The time is the TSF of the BSS specified
1981  *      by %parent_bssid.
1982  * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1983  *      the BSS that requested the scan in which the beacon/probe was received.
1984  * @chains: bitmask for filled values in @chain_signal.
1985  * @chain_signal: per-chain signal strength of last received BSS in dBm.
1986  */
1987 struct cfg80211_inform_bss {
1988         struct ieee80211_channel *chan;
1989         enum nl80211_bss_scan_width scan_width;
1990         s32 signal;
1991         u64 boottime_ns;
1992         u64 parent_tsf;
1993         u8 parent_bssid[ETH_ALEN] __aligned(2);
1994         u8 chains;
1995         s8 chain_signal[IEEE80211_MAX_CHAINS];
1996 };
1997 
1998 /**
1999  * struct cfg80211_bss_ies - BSS entry IE data
2000  * @tsf: TSF contained in the frame that carried these IEs
2001  * @rcu_head: internal use, for freeing
2002  * @len: length of the IEs
2003  * @from_beacon: these IEs are known to come from a beacon
2004  * @data: IE data
2005  */
2006 struct cfg80211_bss_ies {
2007         u64 tsf;
2008         struct rcu_head rcu_head;
2009         int len;
2010         bool from_beacon;
2011         u8 data[];
2012 };
2013 
2014 /**
2015  * struct cfg80211_bss - BSS description
2016  *
2017  * This structure describes a BSS (which may also be a mesh network)
2018  * for use in scan results and similar.
2019  *
2020  * @channel: channel this BSS is on
2021  * @scan_width: width of the control channel
2022  * @bssid: BSSID of the BSS
2023  * @beacon_interval: the beacon interval as from the frame
2024  * @capability: the capability field in host byte order
2025  * @ies: the information elements (Note that there is no guarantee that these
2026  *      are well-formed!); this is a pointer to either the beacon_ies or
2027  *      proberesp_ies depending on whether Probe Response frame has been
2028  *      received. It is always non-%NULL.
2029  * @beacon_ies: the information elements from the last Beacon frame
2030  *      (implementation note: if @hidden_beacon_bss is set this struct doesn't
2031  *      own the beacon_ies, but they're just pointers to the ones from the
2032  *      @hidden_beacon_bss struct)
2033  * @proberesp_ies: the information elements from the last Probe Response frame
2034  * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2035  *      a BSS that hides the SSID in its beacon, this points to the BSS struct
2036  *      that holds the beacon data. @beacon_ies is still valid, of course, and
2037  *      points to the same data as hidden_beacon_bss->beacon_ies in that case.
2038  * @transmitted_bss: pointer to the transmitted BSS, if this is a
2039  *      non-transmitted one (multi-BSSID support)
2040  * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2041  *      (multi-BSSID support)
2042  * @signal: signal strength value (type depends on the wiphy's signal_type)
2043  * @chains: bitmask for filled values in @chain_signal.
2044  * @chain_signal: per-chain signal strength of last received BSS in dBm.
2045  * @bssid_index: index in the multiple BSS set
2046  * @max_bssid_indicator: max number of members in the BSS set
2047  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2048  */
2049 struct cfg80211_bss {
2050         struct ieee80211_channel *channel;
2051         enum nl80211_bss_scan_width scan_width;
2052 
2053         const struct cfg80211_bss_ies __rcu *ies;
2054         const struct cfg80211_bss_ies __rcu *beacon_ies;
2055         const struct cfg80211_bss_ies __rcu *proberesp_ies;
2056 
2057         struct cfg80211_bss *hidden_beacon_bss;
2058         struct cfg80211_bss *transmitted_bss;
2059         struct list_head nontrans_list;
2060 
2061         s32 signal;
2062 
2063         u16 beacon_interval;
2064         u16 capability;
2065 
2066         u8 bssid[ETH_ALEN];
2067         u8 chains;
2068         s8 chain_signal[IEEE80211_MAX_CHAINS];
2069 
2070         u8 bssid_index;
2071         u8 max_bssid_indicator;
2072 
2073         u8 priv[0] __aligned(sizeof(void *));
2074 };
2075 
2076 /**
2077  * ieee80211_bss_get_elem - find element with given ID
2078  * @bss: the bss to search
2079  * @id: the element ID
2080  *
2081  * Note that the return value is an RCU-protected pointer, so
2082  * rcu_read_lock() must be held when calling this function.
2083  * Return: %NULL if not found.
2084  */
2085 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2086 
2087 /**
2088  * ieee80211_bss_get_ie - find IE with given ID
2089  * @bss: the bss to search
2090  * @id: the element ID
2091  *
2092  * Note that the return value is an RCU-protected pointer, so
2093  * rcu_read_lock() must be held when calling this function.
2094  * Return: %NULL if not found.
2095  */
2096 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2097 {
2098         return (void *)ieee80211_bss_get_elem(bss, id);
2099 }
2100 
2101 
2102 /**
2103  * struct cfg80211_auth_request - Authentication request data
2104  *
2105  * This structure provides information needed to complete IEEE 802.11
2106  * authentication.
2107  *
2108  * @bss: The BSS to authenticate with, the callee must obtain a reference
2109  *      to it if it needs to keep it.
2110  * @auth_type: Authentication type (algorithm)
2111  * @ie: Extra IEs to add to Authentication frame or %NULL
2112  * @ie_len: Length of ie buffer in octets
2113  * @key_len: length of WEP key for shared key authentication
2114  * @key_idx: index of WEP key for shared key authentication
2115  * @key: WEP key for shared key authentication
2116  * @auth_data: Fields and elements in Authentication frames. This contains
2117  *      the authentication frame body (non-IE and IE data), excluding the
2118  *      Authentication algorithm number, i.e., starting at the Authentication
2119  *      transaction sequence number field.
2120  * @auth_data_len: Length of auth_data buffer in octets
2121  */
2122 struct cfg80211_auth_request {
2123         struct cfg80211_bss *bss;
2124         const u8 *ie;
2125         size_t ie_len;
2126         enum nl80211_auth_type auth_type;
2127         const u8 *key;
2128         u8 key_len, key_idx;
2129         const u8 *auth_data;
2130         size_t auth_data_len;
2131 };
2132 
2133 /**
2134  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2135  *
2136  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
2137  * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
2138  * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2139  * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2140  *      authentication capability. Drivers can offload authentication to
2141  *      userspace if this flag is set. Only applicable for cfg80211_connect()
2142  *      request (connect callback).
2143  */
2144 enum cfg80211_assoc_req_flags {
2145         ASSOC_REQ_DISABLE_HT                    = BIT(0),
2146         ASSOC_REQ_DISABLE_VHT                   = BIT(1),
2147         ASSOC_REQ_USE_RRM                       = BIT(2),
2148         CONNECT_REQ_EXTERNAL_AUTH_SUPPORT       = BIT(3),
2149 };
2150 
2151 /**
2152  * struct cfg80211_assoc_request - (Re)Association request data
2153  *
2154  * This structure provides information needed to complete IEEE 802.11
2155  * (re)association.
2156  * @bss: The BSS to associate with. If the call is successful the driver is
2157  *      given a reference that it must give back to cfg80211_send_rx_assoc()
2158  *      or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2159  *      association requests while already associating must be rejected.
2160  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2161  * @ie_len: Length of ie buffer in octets
2162  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2163  * @crypto: crypto settings
2164  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2165  *      to indicate a request to reassociate within the ESS instead of a request
2166  *      do the initial association with the ESS. When included, this is set to
2167  *      the BSSID of the current association, i.e., to the value that is
2168  *      included in the Current AP address field of the Reassociation Request
2169  *      frame.
2170  * @flags:  See &enum cfg80211_assoc_req_flags
2171  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2172  *      will be used in ht_capa.  Un-supported values will be ignored.
2173  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2174  * @vht_capa: VHT capability override
2175  * @vht_capa_mask: VHT capability mask indicating which fields to use
2176  * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2177  *      %NULL if FILS is not used.
2178  * @fils_kek_len: Length of fils_kek in octets
2179  * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2180  *      Request/Response frame or %NULL if FILS is not used. This field starts
2181  *      with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2182  */
2183 struct cfg80211_assoc_request {
2184         struct cfg80211_bss *bss;
2185         const u8 *ie, *prev_bssid;
2186         size_t ie_len;
2187         struct cfg80211_crypto_settings crypto;
2188         bool use_mfp;
2189         u32 flags;
2190         struct ieee80211_ht_cap ht_capa;
2191         struct ieee80211_ht_cap ht_capa_mask;
2192         struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2193         const u8 *fils_kek;
2194         size_t fils_kek_len;
2195         const u8 *fils_nonces;
2196 };
2197 
2198 /**
2199  * struct cfg80211_deauth_request - Deauthentication request data
2200  *
2201  * This structure provides information needed to complete IEEE 802.11
2202  * deauthentication.
2203  *
2204  * @bssid: the BSSID of the BSS to deauthenticate from
2205  * @ie: Extra IEs to add to Deauthentication frame or %NULL
2206  * @ie_len: Length of ie buffer in octets
2207  * @reason_code: The reason code for the deauthentication
2208  * @local_state_change: if set, change local state only and
2209  *      do not set a deauth frame
2210  */
2211 struct cfg80211_deauth_request {
2212         const u8 *bssid;
2213         const u8 *ie;
2214         size_t ie_len;
2215         u16 reason_code;
2216         bool local_state_change;
2217 };
2218 
2219 /**
2220  * struct cfg80211_disassoc_request - Disassociation request data
2221  *
2222  * This structure provides information needed to complete IEEE 802.11
2223  * disassociation.
2224  *
2225  * @bss: the BSS to disassociate from
2226  * @ie: Extra IEs to add to Disassociation frame or %NULL
2227  * @ie_len: Length of ie buffer in octets
2228  * @reason_code: The reason code for the disassociation
2229  * @local_state_change: This is a request for a local state only, i.e., no
2230  *      Disassociation frame is to be transmitted.
2231  */
2232 struct cfg80211_disassoc_request {
2233         struct cfg80211_bss *bss;
2234         const u8 *ie;
2235         size_t ie_len;
2236         u16 reason_code;
2237         bool local_state_change;
2238 };
2239 
2240 /**
2241  * struct cfg80211_ibss_params - IBSS parameters
2242  *
2243  * This structure defines the IBSS parameters for the join_ibss()
2244  * method.
2245  *
2246  * @ssid: The SSID, will always be non-null.
2247  * @ssid_len: The length of the SSID, will always be non-zero.
2248  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2249  *      search for IBSSs with a different BSSID.
2250  * @chandef: defines the channel to use if no other IBSS to join can be found
2251  * @channel_fixed: The channel should be fixed -- do not search for
2252  *      IBSSs to join on other channels.
2253  * @ie: information element(s) to include in the beacon
2254  * @ie_len: length of that
2255  * @beacon_interval: beacon interval to use
2256  * @privacy: this is a protected network, keys will be configured
2257  *      after joining
2258  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2259  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2260  *      required to assume that the port is unauthorized until authorized by
2261  *      user space. Otherwise, port is marked authorized by default.
2262  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2263  *      port frames over NL80211 instead of the network interface.
2264  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2265  *      changes the channel when a radar is detected. This is required
2266  *      to operate on DFS channels.
2267  * @basic_rates: bitmap of basic rates to use when creating the IBSS
2268  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2269  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2270  *      will be used in ht_capa.  Un-supported values will be ignored.
2271  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2272  * @wep_keys: static WEP keys, if not NULL points to an array of
2273  *      CFG80211_MAX_WEP_KEYS WEP keys
2274  * @wep_tx_key: key index (0..3) of the default TX static WEP key
2275  */
2276 struct cfg80211_ibss_params {
2277         const u8 *ssid;
2278         const u8 *bssid;
2279         struct cfg80211_chan_def chandef;
2280         const u8 *ie;
2281         u8 ssid_len, ie_len;
2282         u16 beacon_interval;
2283         u32 basic_rates;
2284         bool channel_fixed;
2285         bool privacy;
2286         bool control_port;
2287         bool control_port_over_nl80211;
2288         bool userspace_handles_dfs;
2289         int mcast_rate[NUM_NL80211_BANDS];
2290         struct ieee80211_ht_cap ht_capa;
2291         struct ieee80211_ht_cap ht_capa_mask;
2292         struct key_params *wep_keys;
2293         int wep_tx_key;
2294 };
2295 
2296 /**
2297  * struct cfg80211_bss_selection - connection parameters for BSS selection.
2298  *
2299  * @behaviour: requested BSS selection behaviour.
2300  * @param: parameters for requestion behaviour.
2301  * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2302  * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2303  */
2304 struct cfg80211_bss_selection {
2305         enum nl80211_bss_select_attr behaviour;
2306         union {
2307                 enum nl80211_band band_pref;
2308                 struct cfg80211_bss_select_adjust adjust;
2309         } param;
2310 };
2311 
2312 /**
2313  * struct cfg80211_connect_params - Connection parameters
2314  *
2315  * This structure provides information needed to complete IEEE 802.11
2316  * authentication and association.
2317  *
2318  * @channel: The channel to use or %NULL if not specified (auto-select based
2319  *      on scan results)
2320  * @channel_hint: The channel of the recommended BSS for initial connection or
2321  *      %NULL if not specified
2322  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2323  *      results)
2324  * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2325  *      %NULL if not specified. Unlike the @bssid parameter, the driver is
2326  *      allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2327  *      to use.
2328  * @ssid: SSID
2329  * @ssid_len: Length of ssid in octets
2330  * @auth_type: Authentication type (algorithm)
2331  * @ie: IEs for association request
2332  * @ie_len: Length of assoc_ie in octets
2333  * @privacy: indicates whether privacy-enabled APs should be used
2334  * @mfp: indicate whether management frame protection is used
2335  * @crypto: crypto settings
2336  * @key_len: length of WEP key for shared key authentication
2337  * @key_idx: index of WEP key for shared key authentication
2338  * @key: WEP key for shared key authentication
2339  * @flags:  See &enum cfg80211_assoc_req_flags
2340  * @bg_scan_period:  Background scan period in seconds
2341  *      or -1 to indicate that default value is to be used.
2342  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2343  *      will be used in ht_capa.  Un-supported values will be ignored.
2344  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2345  * @vht_capa:  VHT Capability overrides
2346  * @vht_capa_mask: The bits of vht_capa which are to be used.
2347  * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2348  *      networks.
2349  * @bss_select: criteria to be used for BSS selection.
2350  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2351  *      to indicate a request to reassociate within the ESS instead of a request
2352  *      do the initial association with the ESS. When included, this is set to
2353  *      the BSSID of the current association, i.e., to the value that is
2354  *      included in the Current AP address field of the Reassociation Request
2355  *      frame.
2356  * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2357  *      NAI or %NULL if not specified. This is used to construct FILS wrapped
2358  *      data IE.
2359  * @fils_erp_username_len: Length of @fils_erp_username in octets.
2360  * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2361  *      %NULL if not specified. This specifies the domain name of ER server and
2362  *      is used to construct FILS wrapped data IE.
2363  * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2364  * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2365  *      messages. This is also used to construct FILS wrapped data IE.
2366  * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2367  *      keys in FILS or %NULL if not specified.
2368  * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2369  * @want_1x: indicates user-space supports and wants to use 802.1X driver
2370  *      offload of 4-way handshake.
2371  */
2372 struct cfg80211_connect_params {
2373         struct ieee80211_channel *channel;
2374         struct ieee80211_channel *channel_hint;
2375         const u8 *bssid;
2376         const u8 *bssid_hint;
2377         const u8 *ssid;
2378         size_t ssid_len;
2379         enum nl80211_auth_type auth_type;
2380         const u8 *ie;
2381         size_t ie_len;
2382         bool privacy;
2383         enum nl80211_mfp mfp;
2384         struct cfg80211_crypto_settings crypto;
2385         const u8 *key;
2386         u8 key_len, key_idx;
2387         u32 flags;
2388         int bg_scan_period;
2389         struct ieee80211_ht_cap ht_capa;
2390         struct ieee80211_ht_cap ht_capa_mask;
2391         struct ieee80211_vht_cap vht_capa;
2392         struct ieee80211_vht_cap vht_capa_mask;
2393         bool pbss;
2394         struct cfg80211_bss_selection bss_select;
2395         const u8 *prev_bssid;
2396         const u8 *fils_erp_username;
2397         size_t fils_erp_username_len;
2398         const u8 *fils_erp_realm;
2399         size_t fils_erp_realm_len;
2400         u16 fils_erp_next_seq_num;
2401         const u8 *fils_erp_rrk;
2402         size_t fils_erp_rrk_len;
2403         bool want_1x;
2404 };
2405 
2406 /**
2407  * enum cfg80211_connect_params_changed - Connection parameters being updated
2408  *
2409  * This enum provides information of all connect parameters that
2410  * have to be updated as part of update_connect_params() call.
2411  *
2412  * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2413  * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2414  *      username, erp sequence number and rrk) are updated
2415  * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2416  */
2417 enum cfg80211_connect_params_changed {
2418         UPDATE_ASSOC_IES                = BIT(0),
2419         UPDATE_FILS_ERP_INFO            = BIT(1),
2420         UPDATE_AUTH_TYPE                = BIT(2),
2421 };
2422 
2423 /**
2424  * enum wiphy_params_flags - set_wiphy_params bitfield values
2425  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2426  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2427  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2428  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2429  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2430  * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2431  * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2432  * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2433  * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2434  */
2435 enum wiphy_params_flags {
2436         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
2437         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
2438         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
2439         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
2440         WIPHY_PARAM_COVERAGE_CLASS      = 1 << 4,
2441         WIPHY_PARAM_DYN_ACK             = 1 << 5,
2442         WIPHY_PARAM_TXQ_LIMIT           = 1 << 6,
2443         WIPHY_PARAM_TXQ_MEMORY_LIMIT    = 1 << 7,
2444         WIPHY_PARAM_TXQ_QUANTUM         = 1 << 8,
2445 };
2446 
2447 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT        256
2448 
2449 /**
2450  * struct cfg80211_pmksa - PMK Security Association
2451  *
2452  * This structure is passed to the set/del_pmksa() method for PMKSA
2453  * caching.
2454  *
2455  * @bssid: The AP's BSSID (may be %NULL).
2456  * @pmkid: The identifier to refer a PMKSA.
2457  * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2458  *      derivation by a FILS STA. Otherwise, %NULL.
2459  * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2460  *      the hash algorithm used to generate this.
2461  * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2462  *      cache identifier (may be %NULL).
2463  * @ssid_len: Length of the @ssid in octets.
2464  * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2465  *      scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2466  *      %NULL).
2467  */
2468 struct cfg80211_pmksa {
2469         const u8 *bssid;
2470         const u8 *pmkid;
2471         const u8 *pmk;
2472         size_t pmk_len;
2473         const u8 *ssid;
2474         size_t ssid_len;
2475         const u8 *cache_id;
2476 };
2477 
2478 /**
2479  * struct cfg80211_pkt_pattern - packet pattern
2480  * @mask: bitmask where to match pattern and where to ignore bytes,
2481  *      one bit per byte, in same format as nl80211
2482  * @pattern: bytes to match where bitmask is 1
2483  * @pattern_len: length of pattern (in bytes)
2484  * @pkt_offset: packet offset (in bytes)
2485  *
2486  * Internal note: @mask and @pattern are allocated in one chunk of
2487  * memory, free @mask only!
2488  */
2489 struct cfg80211_pkt_pattern {
2490         const u8 *mask, *pattern;
2491         int pattern_len;
2492         int pkt_offset;
2493 };
2494 
2495 /**
2496  * struct cfg80211_wowlan_tcp - TCP connection parameters
2497  *
2498  * @sock: (internal) socket for source port allocation
2499  * @src: source IP address
2500  * @dst: destination IP address
2501  * @dst_mac: destination MAC address
2502  * @src_port: source port
2503  * @dst_port: destination port
2504  * @payload_len: data payload length
2505  * @payload: data payload buffer
2506  * @payload_seq: payload sequence stamping configuration
2507  * @data_interval: interval at which to send data packets
2508  * @wake_len: wakeup payload match length
2509  * @wake_data: wakeup payload match data
2510  * @wake_mask: wakeup payload match mask
2511  * @tokens_size: length of the tokens buffer
2512  * @payload_tok: payload token usage configuration
2513  */
2514 struct cfg80211_wowlan_tcp {
2515         struct socket *sock;
2516         __be32 src, dst;
2517         u16 src_port, dst_port;
2518         u8 dst_mac[ETH_ALEN];
2519         int payload_len;
2520         const u8 *payload;
2521         struct nl80211_wowlan_tcp_data_seq payload_seq;
2522         u32 data_interval;
2523         u32 wake_len;
2524         const u8 *wake_data, *wake_mask;
2525         u32 tokens_size;
2526         /* must be last, variable member */
2527         struct nl80211_wowlan_tcp_data_token payload_tok;
2528 };
2529 
2530 /**
2531  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2532  *
2533  * This structure defines the enabled WoWLAN triggers for the device.
2534  * @any: wake up on any activity -- special trigger if device continues
2535  *      operating as normal during suspend
2536  * @disconnect: wake up if getting disconnected
2537  * @magic_pkt: wake up on receiving magic packet
2538  * @patterns: wake up on receiving packet matching a pattern
2539  * @n_patterns: number of patterns
2540  * @gtk_rekey_failure: wake up on GTK rekey failure
2541  * @eap_identity_req: wake up on EAP identity request packet
2542  * @four_way_handshake: wake up on 4-way handshake
2543  * @rfkill_release: wake up when rfkill is released
2544  * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2545  *      NULL if not configured.
2546  * @nd_config: configuration for the scan to be used for net detect wake.
2547  */
2548 struct cfg80211_wowlan {
2549         bool any, disconnect, magic_pkt, gtk_rekey_failure,
2550              eap_identity_req, four_way_handshake,
2551              rfkill_release;
2552         struct cfg80211_pkt_pattern *patterns;
2553         struct cfg80211_wowlan_tcp *tcp;
2554         int n_patterns;
2555         struct cfg80211_sched_scan_request *nd_config;
2556 };
2557 
2558 /**
2559  * struct cfg80211_coalesce_rules - Coalesce rule parameters
2560  *
2561  * This structure defines coalesce rule for the device.
2562  * @delay: maximum coalescing delay in msecs.
2563  * @condition: condition for packet coalescence.
2564  *      see &enum nl80211_coalesce_condition.
2565  * @patterns: array of packet patterns
2566  * @n_patterns: number of patterns
2567  */
2568 struct cfg80211_coalesce_rules {
2569         int delay;
2570         enum nl80211_coalesce_condition condition;
2571         struct cfg80211_pkt_pattern *patterns;
2572         int n_patterns;
2573 };
2574 
2575 /**
2576  * struct cfg80211_coalesce - Packet coalescing settings
2577  *
2578  * This structure defines coalescing settings.
2579  * @rules: array of coalesce rules
2580  * @n_rules: number of rules
2581  */
2582 struct cfg80211_coalesce {
2583         struct cfg80211_coalesce_rules *rules;
2584         int n_rules;
2585 };
2586 
2587 /**
2588  * struct cfg80211_wowlan_nd_match - information about the match
2589  *
2590  * @ssid: SSID of the match that triggered the wake up
2591  * @n_channels: Number of channels where the match occurred.  This
2592  *      value may be zero if the driver can't report the channels.
2593  * @channels: center frequencies of the channels where a match
2594  *      occurred (in MHz)
2595  */
2596 struct cfg80211_wowlan_nd_match {
2597         struct cfg80211_ssid ssid;
2598         int n_channels;
2599         u32 channels[];
2600 };
2601 
2602 /**
2603  * struct cfg80211_wowlan_nd_info - net detect wake up information
2604  *
2605  * @n_matches: Number of match information instances provided in
2606  *      @matches.  This value may be zero if the driver can't provide
2607  *      match information.
2608  * @matches: Array of pointers to matches containing information about
2609  *      the matches that triggered the wake up.
2610  */
2611 struct cfg80211_wowlan_nd_info {
2612         int n_matches;
2613         struct cfg80211_wowlan_nd_match *matches[];
2614 };
2615 
2616 /**
2617  * struct cfg80211_wowlan_wakeup - wakeup report
2618  * @disconnect: woke up by getting disconnected
2619  * @magic_pkt: woke up by receiving magic packet
2620  * @gtk_rekey_failure: woke up by GTK rekey failure
2621  * @eap_identity_req: woke up by EAP identity request packet
2622  * @four_way_handshake: woke up by 4-way handshake
2623  * @rfkill_release: woke up by rfkill being released
2624  * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2625  * @packet_present_len: copied wakeup packet data
2626  * @packet_len: original wakeup packet length
2627  * @packet: The packet causing the wakeup, if any.
2628  * @packet_80211:  For pattern match, magic packet and other data
2629  *      frame triggers an 802.3 frame should be reported, for
2630  *      disconnect due to deauth 802.11 frame. This indicates which
2631  *      it is.
2632  * @tcp_match: TCP wakeup packet received
2633  * @tcp_connlost: TCP connection lost or failed to establish
2634  * @tcp_nomoretokens: TCP data ran out of tokens
2635  * @net_detect: if not %NULL, woke up because of net detect
2636  */
2637 struct cfg80211_wowlan_wakeup {
2638         bool disconnect, magic_pkt, gtk_rekey_failure,
2639              eap_identity_req, four_way_handshake,
2640              rfkill_release, packet_80211,
2641              tcp_match, tcp_connlost, tcp_nomoretokens;
2642         s32 pattern_idx;
2643         u32 packet_present_len, packet_len;
2644         const void *packet;
2645         struct cfg80211_wowlan_nd_info *net_detect;
2646 };
2647 
2648 /**
2649  * struct cfg80211_gtk_rekey_data - rekey data
2650  * @kek: key encryption key (NL80211_KEK_LEN bytes)
2651  * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2652  * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2653  */
2654 struct cfg80211_gtk_rekey_data {
2655         const u8 *kek, *kck, *replay_ctr;
2656 };
2657 
2658 /**
2659  * struct cfg80211_update_ft_ies_params - FT IE Information
2660  *
2661  * This structure provides information needed to update the fast transition IE
2662  *
2663  * @md: The Mobility Domain ID, 2 Octet value
2664  * @ie: Fast Transition IEs
2665  * @ie_len: Length of ft_ie in octets
2666  */
2667 struct cfg80211_update_ft_ies_params {
2668         u16 md;
2669         const u8 *ie;
2670         size_t ie_len;
2671 };
2672 
2673 /**
2674  * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2675  *
2676  * This structure provides information needed to transmit a mgmt frame
2677  *
2678  * @chan: channel to use
2679  * @offchan: indicates wether off channel operation is required
2680  * @wait: duration for ROC
2681  * @buf: buffer to transmit
2682  * @len: buffer length
2683  * @no_cck: don't use cck rates for this frame
2684  * @dont_wait_for_ack: tells the low level not to wait for an ack
2685  * @n_csa_offsets: length of csa_offsets array
2686  * @csa_offsets: array of all the csa offsets in the frame
2687  */
2688 struct cfg80211_mgmt_tx_params {
2689         struct ieee80211_channel *chan;
2690         bool offchan;
2691         unsigned int wait;
2692         const u8 *buf;
2693         size_t len;
2694         bool no_cck;
2695         bool dont_wait_for_ack;
2696         int n_csa_offsets;
2697         const u16 *csa_offsets;
2698 };
2699 
2700 /**
2701  * struct cfg80211_dscp_exception - DSCP exception
2702  *
2703  * @dscp: DSCP value that does not adhere to the user priority range definition
2704  * @up: user priority value to which the corresponding DSCP value belongs
2705  */
2706 struct cfg80211_dscp_exception {
2707         u8 dscp;
2708         u8 up;
2709 };
2710 
2711 /**
2712  * struct cfg80211_dscp_range - DSCP range definition for user priority
2713  *
2714  * @low: lowest DSCP value of this user priority range, inclusive
2715  * @high: highest DSCP value of this user priority range, inclusive
2716  */
2717 struct cfg80211_dscp_range {
2718         u8 low;
2719         u8 high;
2720 };
2721 
2722 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2723 #define IEEE80211_QOS_MAP_MAX_EX        21
2724 #define IEEE80211_QOS_MAP_LEN_MIN       16
2725 #define IEEE80211_QOS_MAP_LEN_MAX \
2726         (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2727 
2728 /**
2729  * struct cfg80211_qos_map - QoS Map Information
2730  *
2731  * This struct defines the Interworking QoS map setting for DSCP values
2732  *
2733  * @num_des: number of DSCP exceptions (0..21)
2734  * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2735  *      the user priority DSCP range definition
2736  * @up: DSCP range definition for a particular user priority
2737  */
2738 struct cfg80211_qos_map {
2739         u8 num_des;
2740         struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2741         struct cfg80211_dscp_range up[8];
2742 };
2743 
2744 /**
2745  * struct cfg80211_nan_conf - NAN configuration
2746  *
2747  * This struct defines NAN configuration parameters
2748  *
2749  * @master_pref: master preference (1 - 255)
2750  * @bands: operating bands, a bitmap of &enum nl80211_band values.
2751  *      For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2752  *      (i.e. BIT(NL80211_BAND_2GHZ)).
2753  */
2754 struct cfg80211_nan_conf {
2755         u8 master_pref;
2756         u8 bands;
2757 };
2758 
2759 /**
2760  * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2761  * configuration
2762  *
2763  * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2764  * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2765  */
2766 enum cfg80211_nan_conf_changes {
2767         CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2768         CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2769 };
2770 
2771 /**
2772  * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2773  *
2774  * @filter: the content of the filter
2775  * @len: the length of the filter
2776  */
2777 struct cfg80211_nan_func_filter {
2778         const u8 *filter;
2779         u8 len;
2780 };
2781 
2782 /**
2783  * struct cfg80211_nan_func - a NAN function
2784  *
2785  * @type: &enum nl80211_nan_function_type
2786  * @service_id: the service ID of the function
2787  * @publish_type: &nl80211_nan_publish_type
2788  * @close_range: if true, the range should be limited. Threshold is
2789  *      implementation specific.
2790  * @publish_bcast: if true, the solicited publish should be broadcasted
2791  * @subscribe_active: if true, the subscribe is active
2792  * @followup_id: the instance ID for follow up
2793  * @followup_reqid: the requestor instance ID for follow up
2794  * @followup_dest: MAC address of the recipient of the follow up
2795  * @ttl: time to live counter in DW.
2796  * @serv_spec_info: Service Specific Info
2797  * @serv_spec_info_len: Service Specific Info length
2798  * @srf_include: if true, SRF is inclusive
2799  * @srf_bf: Bloom Filter
2800  * @srf_bf_len: Bloom Filter length
2801  * @srf_bf_idx: Bloom Filter index
2802  * @srf_macs: SRF MAC addresses
2803  * @srf_num_macs: number of MAC addresses in SRF
2804  * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2805  * @tx_filters: filters that should be transmitted in the SDF.
2806  * @num_rx_filters: length of &rx_filters.
2807  * @num_tx_filters: length of &tx_filters.
2808  * @instance_id: driver allocated id of the function.
2809  * @cookie: unique NAN function identifier.
2810  */
2811 struct cfg80211_nan_func {
2812         enum nl80211_nan_function_type type;
2813         u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2814         u8 publish_type;
2815         bool close_range;
2816         bool publish_bcast;
2817         bool subscribe_active;
2818         u8 followup_id;
2819         u8 followup_reqid;
2820         struct mac_address followup_dest;
2821         u32 ttl;
2822         const u8 *serv_spec_info;
2823         u8 serv_spec_info_len;
2824         bool srf_include;
2825         const u8 *srf_bf;
2826         u8 srf_bf_len;
2827         u8 srf_bf_idx;
2828         struct mac_address *srf_macs;
2829         int srf_num_macs;
2830         struct cfg80211_nan_func_filter *rx_filters;
2831         struct cfg80211_nan_func_filter *tx_filters;
2832         u8 num_tx_filters;
2833         u8 num_rx_filters;
2834         u8 instance_id;
2835         u64 cookie;
2836 };
2837 
2838 /**
2839  * struct cfg80211_pmk_conf - PMK configuration
2840  *
2841  * @aa: authenticator address
2842  * @pmk_len: PMK length in bytes.
2843  * @pmk: the PMK material
2844  * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2845  *      is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
2846  *      holds PMK-R0.
2847  */
2848 struct cfg80211_pmk_conf {
2849         const u8 *aa;
2850         u8 pmk_len;
2851         const u8 *pmk;
2852         const u8 *pmk_r0_name;
2853 };
2854 
2855 /**
2856  * struct cfg80211_external_auth_params - Trigger External authentication.
2857  *
2858  * Commonly used across the external auth request and event interfaces.
2859  *
2860  * @action: action type / trigger for external authentication. Only significant
2861  *      for the authentication request event interface (driver to user space).
2862  * @bssid: BSSID of the peer with which the authentication has
2863  *      to happen. Used by both the authentication request event and
2864  *      authentication response command interface.
2865  * @ssid: SSID of the AP.  Used by both the authentication request event and
2866  *      authentication response command interface.
2867  * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
2868  *      authentication request event interface.
2869  * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
2870  *      use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
2871  *      the real status code for failures. Used only for the authentication
2872  *      response command interface (user space to driver).
2873  * @pmkid: The identifier to refer a PMKSA.
2874  */
2875 struct cfg80211_external_auth_params {
2876         enum nl80211_external_auth_action action;
2877         u8 bssid[ETH_ALEN] __aligned(2);
2878         struct cfg80211_ssid ssid;
2879         unsigned int key_mgmt_suite;
2880         u16 status;
2881         const u8 *pmkid;
2882 };
2883 
2884 /**
2885  * struct cfg80211_ftm_responder_stats - FTM responder statistics
2886  *
2887  * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
2888  *      indicate the relevant values in this struct for them
2889  * @success_num: number of FTM sessions in which all frames were successfully
2890  *      answered
2891  * @partial_num: number of FTM sessions in which part of frames were
2892  *      successfully answered
2893  * @failed_num: number of failed FTM sessions
2894  * @asap_num: number of ASAP FTM sessions
2895  * @non_asap_num: number of  non-ASAP FTM sessions
2896  * @total_duration_ms: total sessions durations - gives an indication
2897  *      of how much time the responder was busy
2898  * @unknown_triggers_num: number of unknown FTM triggers - triggers from
2899  *      initiators that didn't finish successfully the negotiation phase with
2900  *      the responder
2901  * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
2902  *      for a new scheduling although it already has scheduled FTM slot
2903  * @out_of_window_triggers_num: total FTM triggers out of scheduled window
2904  */
2905 struct cfg80211_ftm_responder_stats {
2906         u32 filled;
2907         u32 success_num;
2908         u32 partial_num;
2909         u32 failed_num;
2910         u32 asap_num;
2911         u32 non_asap_num;
2912         u64 total_duration_ms;
2913         u32 unknown_triggers_num;
2914         u32 reschedule_requests_num;
2915         u32 out_of_window_triggers_num;
2916 };
2917 
2918 /**
2919  * struct cfg80211_pmsr_ftm_result - FTM result
2920  * @failure_reason: if this measurement failed (PMSR status is
2921  *      %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
2922  *      reason than just "failure"
2923  * @burst_index: if reporting partial results, this is the index
2924  *      in [0 .. num_bursts-1] of the burst that's being reported
2925  * @num_ftmr_attempts: number of FTM request frames transmitted
2926  * @num_ftmr_successes: number of FTM request frames acked
2927  * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
2928  *      fill this to indicate in how many seconds a retry is deemed possible
2929  *      by the responder
2930  * @num_bursts_exp: actual number of bursts exponent negotiated
2931  * @burst_duration: actual burst duration negotiated
2932  * @ftms_per_burst: actual FTMs per burst negotiated
2933  * @lci_len: length of LCI information (if present)
2934  * @civicloc_len: length of civic location information (if present)
2935  * @lci: LCI data (may be %NULL)
2936  * @civicloc: civic location data (may be %NULL)
2937  * @rssi_avg: average RSSI over FTM action frames reported
2938  * @rssi_spread: spread of the RSSI over FTM action frames reported
2939  * @tx_rate: bitrate for transmitted FTM action frame response
2940  * @rx_rate: bitrate of received FTM action frame
2941  * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
2942  * @rtt_variance: variance of RTTs measured (note that standard deviation is
2943  *      the square root of the variance)
2944  * @rtt_spread: spread of the RTTs measured
2945  * @dist_avg: average of distances (mm) measured
2946  *      (must have either this or @rtt_avg)
2947  * @dist_variance: variance of distances measured (see also @rtt_variance)
2948  * @dist_spread: spread of distances measured (see also @rtt_spread)
2949  * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
2950  * @num_ftmr_successes_valid: @num_ftmr_successes is valid
2951  * @rssi_avg_valid: @rssi_avg is valid
2952  * @rssi_spread_valid: @rssi_spread is valid
2953  * @tx_rate_valid: @tx_rate is valid
2954  * @rx_rate_valid: @rx_rate is valid
2955  * @rtt_avg_valid: @rtt_avg is valid
2956  * @rtt_variance_valid: @rtt_variance is valid
2957  * @rtt_spread_valid: @rtt_spread is valid
2958  * @dist_avg_valid: @dist_avg is valid
2959  * @dist_variance_valid: @dist_variance is valid
2960  * @dist_spread_valid: @dist_spread is valid
2961  */
2962 struct cfg80211_pmsr_ftm_result {
2963         const u8 *lci;
2964         const u8 *civicloc;
2965         unsigned int lci_len;
2966         unsigned int civicloc_len;
2967         enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
2968         u32 num_ftmr_attempts, num_ftmr_successes;
2969         s16 burst_index;
2970         u8 busy_retry_time;
2971         u8 num_bursts_exp;
2972         u8 burst_duration;
2973         u8 ftms_per_burst;
2974         s32 rssi_avg;
2975         s32 rssi_spread;
2976         struct rate_info tx_rate, rx_rate;
2977         s64 rtt_avg;
2978         s64 rtt_variance;
2979         s64 rtt_spread;
2980         s64 dist_avg;
2981         s64 dist_variance;
2982         s64 dist_spread;
2983 
2984         u16 num_ftmr_attempts_valid:1,
2985             num_ftmr_successes_valid:1,
2986             rssi_avg_valid:1,
2987             rssi_spread_valid:1,
2988             tx_rate_valid:1,
2989             rx_rate_valid:1,
2990             rtt_avg_valid:1,
2991             rtt_variance_valid:1,
2992             rtt_spread_valid:1,
2993             dist_avg_valid:1,
2994             dist_variance_valid:1,
2995             dist_spread_valid:1;
2996 };
2997 
2998 /**
2999  * struct cfg80211_pmsr_result - peer measurement result
3000  * @addr: address of the peer
3001  * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3002  *      measurement was made)
3003  * @ap_tsf: AP's TSF at measurement time
3004  * @status: status of the measurement
3005  * @final: if reporting partial results, mark this as the last one; if not
3006  *      reporting partial results always set this flag
3007  * @ap_tsf_valid: indicates the @ap_tsf value is valid
3008  * @type: type of the measurement reported, note that we only support reporting
3009  *      one type at a time, but you can report multiple results separately and
3010  *      they're all aggregated for userspace.
3011  */
3012 struct cfg80211_pmsr_result {
3013         u64 host_time, ap_tsf;
3014         enum nl80211_peer_measurement_status status;
3015 
3016         u8 addr[ETH_ALEN];
3017 
3018         u8 final:1,
3019            ap_tsf_valid:1;
3020 
3021         enum nl80211_peer_measurement_type type;
3022 
3023         union {
3024                 struct cfg80211_pmsr_ftm_result ftm;
3025         };
3026 };
3027 
3028 /**
3029  * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3030  * @requested: indicates FTM is requested
3031  * @preamble: frame preamble to use
3032  * @burst_period: burst period to use
3033  * @asap: indicates to use ASAP mode
3034  * @num_bursts_exp: number of bursts exponent
3035  * @burst_duration: burst duration
3036  * @ftms_per_burst: number of FTMs per burst
3037  * @ftmr_retries: number of retries for FTM request
3038  * @request_lci: request LCI information
3039  * @request_civicloc: request civic location information
3040  *
3041  * See also nl80211 for the respective attribute documentation.
3042  */
3043 struct cfg80211_pmsr_ftm_request_peer {
3044         enum nl80211_preamble preamble;
3045         u16 burst_period;
3046         u8 requested:1,
3047            asap:1,
3048            request_lci:1,
3049            request_civicloc:1;
3050         u8 num_bursts_exp;
3051         u8 burst_duration;
3052         u8 ftms_per_burst;
3053         u8 ftmr_retries;
3054 };
3055 
3056 /**
3057  * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3058  * @addr: MAC address
3059  * @chandef: channel to use
3060  * @report_ap_tsf: report the associated AP's TSF
3061  * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3062  */
3063 struct cfg80211_pmsr_request_peer {
3064         u8 addr[ETH_ALEN];
3065         struct cfg80211_chan_def chandef;
3066         u8 report_ap_tsf:1;
3067         struct cfg80211_pmsr_ftm_request_peer ftm;
3068 };
3069 
3070 /**
3071  * struct cfg80211_pmsr_request - peer measurement request
3072  * @cookie: cookie, set by cfg80211
3073  * @nl_portid: netlink portid - used by cfg80211
3074  * @drv_data: driver data for this request, if required for aborting,
3075  *      not otherwise freed or anything by cfg80211
3076  * @mac_addr: MAC address used for (randomised) request
3077  * @mac_addr_mask: MAC address mask used for randomisation, bits that
3078  *      are 0 in the mask should be randomised, bits that are 1 should
3079  *      be taken from the @mac_addr
3080  * @list: used by cfg80211 to hold on to the request
3081  * @timeout: timeout (in milliseconds) for the whole operation, if
3082  *      zero it means there's no timeout
3083  * @n_peers: number of peers to do measurements with
3084  * @peers: per-peer measurement request data
3085  */
3086 struct cfg80211_pmsr_request {
3087         u64 cookie;
3088         void *drv_data;
3089         u32 n_peers;
3090         u32 nl_portid;
3091 
3092         u32 timeout;
3093 
3094         u8 mac_addr[ETH_ALEN] __aligned(2);
3095         u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3096 
3097         struct list_head list;
3098 
3099         struct cfg80211_pmsr_request_peer peers[];
3100 };
3101 
3102 /**
3103  * struct cfg80211_ops - backend description for wireless configuration
3104  *
3105  * This struct is registered by fullmac card drivers and/or wireless stacks
3106  * in order to handle configuration requests on their interfaces.
3107  *
3108  * All callbacks except where otherwise noted should return 0
3109  * on success or a negative error code.
3110  *
3111  * All operations are currently invoked under rtnl for consistency with the
3112  * wireless extensions but this is subject to reevaluation as soon as this
3113  * code is used more widely and we have a first user without wext.
3114  *
3115  * @suspend: wiphy device needs to be suspended. The variable @wow will
3116  *      be %NULL or contain the enabled Wake-on-Wireless triggers that are
3117  *      configured for the device.
3118  * @resume: wiphy device needs to be resumed
3119  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3120  *      to call device_set_wakeup_enable() to enable/disable wakeup from
3121  *      the device.
3122  *
3123  * @add_virtual_intf: create a new virtual interface with the given name,
3124  *      must set the struct wireless_dev's iftype. Beware: You must create
3125  *      the new netdev in the wiphy's network namespace! Returns the struct
3126  *      wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3127  *      also set the address member in the wdev.
3128  *
3129  * @del_virtual_intf: remove the virtual interface
3130  *
3131  * @change_virtual_intf: change type/configuration of virtual interface,
3132  *      keep the struct wireless_dev's iftype updated.
3133  *
3134  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3135  *      when adding a group key.
3136  *
3137  * @get_key: get information about the key with the given parameters.
3138  *      @mac_addr will be %NULL when requesting information for a group
3139  *      key. All pointers given to the @callback function need not be valid
3140  *      after it returns. This function should return an error if it is
3141  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
3142  *
3143  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3144  *      and @key_index, return -ENOENT if the key doesn't exist.
3145  *
3146  * @set_default_key: set the default key on an interface
3147  *
3148  * @set_default_mgmt_key: set the default management frame key on an interface
3149  *
3150  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3151  *
3152  * @start_ap: Start acting in AP mode defined by the parameters.
3153  * @change_beacon: Change the beacon parameters for an access point mode
3154  *      interface. This should reject the call when AP mode wasn't started.
3155  * @stop_ap: Stop being an AP, including stopping beaconing.
3156  *
3157  * @add_station: Add a new station.
3158  * @del_station: Remove a station
3159  * @change_station: Modify a given station. Note that flags changes are not much
3160  *      validated in cfg80211, in particular the auth/assoc/authorized flags
3161  *      might come to the driver in invalid combinations -- make sure to check
3162  *      them, also against the existing state! Drivers must call
3163  *      cfg80211_check_station_change() to validate the information.
3164  * @get_station: get station information for the station identified by @mac
3165  * @dump_station: dump station callback -- resume dump at index @idx
3166  *
3167  * @add_mpath: add a fixed mesh path
3168  * @del_mpath: delete a given mesh path
3169  * @change_mpath: change a given mesh path
3170  * @get_mpath: get a mesh path for the given parameters
3171  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3172  * @get_mpp: get a mesh proxy path for the given parameters
3173  * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3174  * @join_mesh: join the mesh network with the specified parameters
3175  *      (invoked with the wireless_dev mutex held)
3176  * @leave_mesh: leave the current mesh network
3177  *      (invoked with the wireless_dev mutex held)
3178  *
3179  * @get_mesh_config: Get the current mesh configuration
3180  *
3181  * @update_mesh_config: Update mesh parameters on a running mesh.
3182  *      The mask is a bitfield which tells us which parameters to
3183  *      set, and which to leave alone.
3184  *
3185  * @change_bss: Modify parameters for a given BSS.
3186  *
3187  * @set_txq_params: Set TX queue parameters
3188  *
3189  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3190  *      as it doesn't implement join_mesh and needs to set the channel to
3191  *      join the mesh instead.
3192  *
3193  * @set_monitor_channel: Set the monitor mode channel for the device. If other
3194  *      interfaces are active this callback should reject the configuration.
3195  *      If no interfaces are active or the device is down, the channel should
3196  *      be stored for when a monitor interface becomes active.
3197  *
3198  * @scan: Request to do a scan. If returning zero, the scan request is given
3199  *      the driver, and will be valid until passed to cfg80211_scan_done().
3200  *      For scan results, call cfg80211_inform_bss(); you can call this outside
3201  *      the scan/scan_done bracket too.
3202  * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3203  *      indicate the status of the scan through cfg80211_scan_done().
3204  *
3205  * @auth: Request to authenticate with the specified peer
3206  *      (invoked with the wireless_dev mutex held)
3207  * @assoc: Request to (re)associate with the specified peer
3208  *      (invoked with the wireless_dev mutex held)
3209  * @deauth: Request to deauthenticate from the specified peer
3210  *      (invoked with the wireless_dev mutex held)
3211  * @disassoc: Request to disassociate from the specified peer
3212  *      (invoked with the wireless_dev mutex held)
3213  *
3214  * @connect: Connect to the ESS with the specified parameters. When connected,
3215  *      call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3216  *      %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3217  *      cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3218  *      from the AP or cfg80211_connect_timeout() if no frame with status code
3219  *      was received.
3220  *      The driver is allowed to roam to other BSSes within the ESS when the
3221  *      other BSS matches the connect parameters. When such roaming is initiated
3222  *      by the driver, the driver is expected to verify that the target matches
3223  *      the configured security parameters and to use Reassociation Request
3224  *      frame instead of Association Request frame.
3225  *      The connect function can also be used to request the driver to perform a
3226  *      specific roam when connected to an ESS. In that case, the prev_bssid
3227  *      parameter is set to the BSSID of the currently associated BSS as an
3228  *      indication of requesting reassociation.
3229  *      In both the driver-initiated and new connect() call initiated roaming
3230  *      cases, the result of roaming is indicated with a call to
3231  *      cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3232  * @update_connect_params: Update the connect parameters while connected to a
3233  *      BSS. The updated parameters can be used by driver/firmware for
3234  *      subsequent BSS selection (roaming) decisions and to form the
3235  *      Authentication/(Re)Association Request frames. This call does not
3236  *      request an immediate disassociation or reassociation with the current
3237  *      BSS, i.e., this impacts only subsequent (re)associations. The bits in
3238  *      changed are defined in &enum cfg80211_connect_params_changed.
3239  *      (invoked with the wireless_dev mutex held)
3240  * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3241  *      connection is in progress. Once done, call cfg80211_disconnected() in
3242  *      case connection was already established (invoked with the
3243  *      wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3244  *
3245  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3246  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
3247  *      to a merge.
3248  *      (invoked with the wireless_dev mutex held)
3249  * @leave_ibss: Leave the IBSS.
3250  *      (invoked with the wireless_dev mutex held)
3251  *
3252  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3253  *      MESH mode)
3254  *
3255  * @set_wiphy_params: Notify that wiphy parameters have changed;
3256  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
3257  *      have changed. The actual parameter values are available in
3258  *      struct wiphy. If returning an error, no value should be changed.
3259  *
3260  * @set_tx_power: set the transmit power according to the parameters,
3261  *      the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3262  *      wdev may be %NULL if power was set for the wiphy, and will
3263  *      always be %NULL unless the driver supports per-vif TX power
3264  *      (as advertised by the nl80211 feature flag.)
3265  * @get_tx_power: store the current TX power into the dbm variable;
3266  *      return 0 if successful
3267  *
3268  * @set_wds_peer: set the WDS peer for a WDS interface
3269  *
3270  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3271  *      functions to adjust rfkill hw state
3272  *
3273  * @dump_survey: get site survey information.
3274  *
3275  * @remain_on_channel: Request the driver to remain awake on the specified
3276  *      channel for the specified duration to complete an off-channel
3277  *      operation (e.g., public action frame exchange). When the driver is
3278  *      ready on the requested channel, it must indicate this with an event
3279  *      notification by calling cfg80211_ready_on_channel().
3280  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3281  *      This allows the operation to be terminated prior to timeout based on
3282  *      the duration value.
3283  * @mgmt_tx: Transmit a management frame.
3284  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3285  *      frame on another channel
3286  *
3287  * @testmode_cmd: run a test mode command; @wdev may be %NULL
3288  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3289  *      used by the function, but 0 and 1 must not be touched. Additionally,
3290  *      return error codes other than -ENOBUFS and -ENOENT will terminate the
3291  *      dump and return to userspace with an error, so be careful. If any data
3292  *      was passed in from userspace then the data/len arguments will be present
3293  *      and point to the data contained in %NL80211_ATTR_TESTDATA.
3294  *
3295  * @set_bitrate_mask: set the bitrate mask configuration
3296  *
3297  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3298  *      devices running firmwares capable of generating the (re) association
3299  *      RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3300  * @del_pmksa: Delete a cached PMKID.
3301  * @flush_pmksa: Flush all cached PMKIDs.
3302  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3303  *      allows the driver to adjust the dynamic ps timeout value.
3304  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3305  *      After configuration, the driver should (soon) send an event indicating
3306  *      the current level is above/below the configured threshold; this may
3307  *      need some care when the configuration is changed (without first being
3308  *      disabled.)
3309  * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3310  *      connection quality monitor.  An event is to be sent only when the
3311  *      signal level is found to be outside the two values.  The driver should
3312  *      set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3313  *      If it is provided then there's no point providing @set_cqm_rssi_config.
3314  * @set_cqm_txe_config: Configure connection quality monitor TX error
3315  *      thresholds.
3316  * @sched_scan_start: Tell the driver to start a scheduled scan.
3317  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3318  *      given request id. This call must stop the scheduled scan and be ready
3319  *      for starting a new one before it returns, i.e. @sched_scan_start may be
3320  *      called immediately after that again and should not fail in that case.
3321  *      The driver should not call cfg80211_sched_scan_stopped() for a requested
3322  *      stop (when this method returns 0).
3323  *
3324  * @mgmt_frame_register: Notify driver that a management frame type was
3325  *      registered. The callback is allowed to sleep.
3326  *
3327  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3328  *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3329  *      reject TX/RX mask combinations they cannot support by returning -EINVAL
3330  *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3331  *
3332  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3333  *
3334  * @tdls_mgmt: Transmit a TDLS management frame.
3335  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3336  *
3337  * @probe_client: probe an associated client, must return a cookie that it
3338  *      later passes to cfg80211_probe_status().
3339  *
3340  * @set_noack_map: Set the NoAck Map for the TIDs.
3341  *
3342  * @get_channel: Get the current operating channel for the virtual interface.
3343  *      For monitor interfaces, it should return %NULL unless there's a single
3344  *      current monitoring channel.
3345  *
3346  * @start_p2p_device: Start the given P2P device.
3347  * @stop_p2p_device: Stop the given P2P device.
3348  *
3349  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3350  *      Parameters include ACL policy, an array of MAC address of stations
3351  *      and the number of MAC addresses. If there is already a list in driver
3352  *      this new list replaces the existing one. Driver has to clear its ACL
3353  *      when number of MAC addresses entries is passed as 0. Drivers which
3354  *      advertise the support for MAC based ACL have to implement this callback.
3355  *
3356  * @start_radar_detection: Start radar detection in the driver.
3357  *
3358  * @update_ft_ies: Provide updated Fast BSS Transition information to the
3359  *      driver. If the SME is in the driver/firmware, this information can be
3360  *      used in building Authentication and Reassociation Request frames.
3361  *
3362  * @crit_proto_start: Indicates a critical protocol needs more link reliability
3363  *      for a given duration (milliseconds). The protocol is provided so the
3364  *      driver can take the most appropriate actions.
3365  * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3366  *      reliability. This operation can not fail.
3367  * @set_coalesce: Set coalesce parameters.
3368  *
3369  * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3370  *      responsible for veryfing if the switch is possible. Since this is
3371  *      inherently tricky driver may decide to disconnect an interface later
3372  *      with cfg80211_stop_iface(). This doesn't mean driver can accept
3373  *      everything. It should do it's best to verify requests and reject them
3374  *      as soon as possible.
3375  *
3376  * @set_qos_map: Set QoS mapping information to the driver
3377  *
3378  * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3379  *      given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3380  *      changes during the lifetime of the BSS.
3381  *
3382  * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3383  *      with the given parameters; action frame exchange has been handled by
3384  *      userspace so this just has to modify the TX path to take the TS into
3385  *      account.
3386  *      If the admitted time is 0 just validate the parameters to make sure
3387  *      the session can be created at all; it is valid to just always return
3388  *      success for that but that may result in inefficient behaviour (handshake
3389  *      with the peer followed by immediate teardown when the addition is later
3390  *      rejected)
3391  * @del_tx_ts: remove an existing TX TS
3392  *
3393  * @join_ocb: join the OCB network with the specified parameters
3394  *      (invoked with the wireless_dev mutex held)
3395  * @leave_ocb: leave the current OCB network
3396  *      (invoked with the wireless_dev mutex held)
3397  *
3398  * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3399  *      is responsible for continually initiating channel-switching operations
3400  *      and returning to the base channel for communication with the AP.
3401  * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3402  *      peers must be on the base channel when the call completes.
3403  * @start_nan: Start the NAN interface.
3404  * @stop_nan: Stop the NAN interface.
3405  * @add_nan_func: Add a NAN function. Returns negative value on failure.
3406  *      On success @nan_func ownership is transferred to the driver and
3407  *      it may access it outside of the scope of this function. The driver
3408  *      should free the @nan_func when no longer needed by calling
3409  *      cfg80211_free_nan_func().
3410  *      On success the driver should assign an instance_id in the
3411  *      provided @nan_func.
3412  * @del_nan_func: Delete a NAN function.
3413  * @nan_change_conf: changes NAN configuration. The changed parameters must
3414  *      be specified in @changes (using &enum cfg80211_nan_conf_changes);
3415  *      All other parameters must be ignored.
3416  *
3417  * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3418  *
3419  * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3420  *      function should return phy stats, and interface stats otherwise.
3421  *
3422  * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3423  *      If not deleted through @del_pmk the PMK remains valid until disconnect
3424  *      upon which the driver should clear it.
3425  *      (invoked with the wireless_dev mutex held)
3426  * @del_pmk: delete the previously configured PMK for the given authenticator.
3427  *      (invoked with the wireless_dev mutex held)
3428  *
3429  * @external_auth: indicates result of offloaded authentication processing from
3430  *     user space
3431  *
3432  * @tx_control_port: TX a control port frame (EAPoL).  The noencrypt parameter
3433  *      tells the driver that the frame should not be encrypted.
3434  *
3435  * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3436  *      Statistics should be cumulative, currently no way to reset is provided.
3437  * @start_pmsr: start peer measurement (e.g. FTM)
3438  * @abort_pmsr: abort peer measurement
3439  */
3440 struct cfg80211_ops {
3441         int     (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3442         int     (*resume)(struct wiphy *wiphy);
3443         void    (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3444 
3445         struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3446                                                   const char *name,
3447                                                   unsigned char name_assign_type,
3448                                                   enum nl80211_iftype type,
3449                                                   struct vif_params *params);
3450         int     (*del_virtual_intf)(struct wiphy *wiphy,
3451                                     struct wireless_dev *wdev);
3452         int     (*change_virtual_intf)(struct wiphy *wiphy,
3453                                        struct net_device *dev,
3454                                        enum nl80211_iftype type,
3455                                        struct vif_params *params);
3456 
3457         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3458                            u8 key_index, bool pairwise, const u8 *mac_addr,
3459                            struct key_params *params);
3460         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3461                            u8 key_index, bool pairwise, const u8 *mac_addr,
3462                            void *cookie,
3463                            void (*callback)(void *cookie, struct key_params*));
3464         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3465                            u8 key_index, bool pairwise, const u8 *mac_addr);
3466         int     (*set_default_key)(struct wiphy *wiphy,
3467                                    struct net_device *netdev,
3468                                    u8 key_index, bool unicast, bool multicast);
3469         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
3470                                         struct net_device *netdev,
3471                                         u8 key_index);
3472 
3473         int     (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3474                             struct cfg80211_ap_settings *settings);
3475         int     (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3476                                  struct cfg80211_beacon_data *info);
3477         int     (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3478 
3479 
3480         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3481                                const u8 *mac,
3482                                struct station_parameters *params);
3483         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3484                                struct station_del_parameters *params);
3485         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3486                                   const u8 *mac,
3487                                   struct station_parameters *params);
3488         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3489                                const u8 *mac, struct station_info *sinfo);
3490         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3491                                 int idx, u8 *mac, struct station_info *sinfo);
3492 
3493         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3494                                const u8 *dst, const u8 *next_hop);
3495         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3496                                const u8 *dst);
3497         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3498                                   const u8 *dst, const u8 *next_hop);
3499         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3500                              u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3501         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3502                               int idx, u8 *dst, u8 *next_hop,
3503                               struct mpath_info *pinfo);
3504         int     (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3505                            u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3506         int     (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3507                             int idx, u8 *dst, u8 *mpp,
3508                             struct mpath_info *pinfo);
3509         int     (*get_mesh_config)(struct wiphy *wiphy,
3510                                 struct net_device *dev,
3511                                 struct mesh_config *conf);
3512         int     (*update_mesh_config)(struct wiphy *wiphy,
3513                                       struct net_device *dev, u32 mask,
3514                                       const struct mesh_config *nconf);
3515         int     (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3516                              const struct mesh_config *conf,
3517                              const struct mesh_setup *setup);
3518         int     (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3519 
3520         int     (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3521                             struct ocb_setup *setup);
3522         int     (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3523 
3524         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3525                               struct bss_parameters *params);
3526 
3527         int     (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3528                                   struct ieee80211_txq_params *params);
3529 
3530         int     (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3531                                              struct net_device *dev,
3532                                              struct ieee80211_channel *chan);
3533 
3534         int     (*set_monitor_channel)(struct wiphy *wiphy,
3535                                        struct cfg80211_chan_def *chandef);
3536 
3537         int     (*scan)(struct wiphy *wiphy,
3538                         struct cfg80211_scan_request *request);
3539         void    (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3540 
3541         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
3542                         struct cfg80211_auth_request *req);
3543         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3544                          struct cfg80211_assoc_request *req);
3545         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3546                           struct cfg80211_deauth_request *req);
3547         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3548                             struct cfg80211_disassoc_request *req);
3549 
3550         int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
3551                            struct cfg80211_connect_params *sme);
3552         int     (*update_connect_params)(struct wiphy *wiphy,
3553                                          struct net_device *dev,
3554                                          struct cfg80211_connect_params *sme,
3555                                          u32 changed);
3556         int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3557                               u16 reason_code);
3558 
3559         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3560                              struct cfg80211_ibss_params *params);
3561         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3562 
3563         int     (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3564                                   int rate[NUM_NL80211_BANDS]);
3565 
3566         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3567 
3568         int     (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3569                                 enum nl80211_tx_power_setting type, int mbm);
3570         int     (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3571                                 int *dbm);
3572 
3573         int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3574                                 const u8 *addr);
3575 
3576         void    (*rfkill_poll)(struct wiphy *wiphy);
3577 
3578 #ifdef CONFIG_NL80211_TESTMODE
3579         int     (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3580                                 void *data, int len);
3581         int     (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3582                                  struct netlink_callback *cb,
3583                                  void *data, int len);
3584 #endif
3585 
3586         int     (*set_bitrate_mask)(struct wiphy *wiphy,
3587                                     struct net_device *dev,
3588                                     const u8 *peer,
3589                                     const struct cfg80211_bitrate_mask *mask);
3590 
3591         int     (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3592                         int idx, struct survey_info *info);
3593 
3594         int     (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3595                              struct cfg80211_pmksa *pmksa);
3596         int     (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3597                              struct cfg80211_pmksa *pmksa);
3598         int     (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3599 
3600         int     (*remain_on_channel)(struct wiphy *wiphy,
3601                                      struct wireless_dev *wdev,
3602                                      struct ieee80211_channel *chan,
3603                                      unsigned int duration,
3604                                      u64 *cookie);
3605         int     (*cancel_remain_on_channel)(struct wiphy *wiphy,
3606                                             struct wireless_dev *wdev,
3607                                             u64 cookie);
3608 
3609         int     (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3610                            struct cfg80211_mgmt_tx_params *params,
3611                            u64 *cookie);
3612         int     (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3613                                        struct wireless_dev *wdev,
3614                                        u64 cookie);
3615 
3616         int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3617                                   bool enabled, int timeout);
3618 
3619         int     (*set_cqm_rssi_config)(struct wiphy *wiphy,
3620                                        struct net_device *dev,
3621                                        s32 rssi_thold, u32 rssi_hyst);
3622 
3623         int     (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3624                                              struct net_device *dev,
3625                                              s32 rssi_low, s32 rssi_high);
3626 
3627         int     (*set_cqm_txe_config)(struct wiphy *wiphy,
3628                                       struct net_device *dev,
3629                                       u32 rate, u32 pkts, u32 intvl);
3630 
3631         void    (*mgmt_frame_register)(struct wiphy *wiphy,
3632                                        struct wireless_dev *wdev,
3633                                        u16 frame_type, bool reg);
3634 
3635         int     (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3636         int     (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3637 
3638         int     (*sched_scan_start)(struct wiphy *wiphy,
3639                                 struct net_device *dev,
3640                                 struct cfg80211_sched_scan_request *request);
3641         int     (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3642                                    u64 reqid);
3643 
3644         int     (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3645                                   struct cfg80211_gtk_rekey_data *data);
3646 
3647         int     (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3648                              const u8 *peer, u8 action_code,  u8 dialog_token,
3649                              u16 status_code, u32 peer_capability,
3650                              bool initiator, const u8 *buf, size_t len);
3651         int     (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3652                              const u8 *peer, enum nl80211_tdls_operation oper);
3653 
3654         int     (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3655                                 const u8 *peer, u64 *cookie);
3656 
3657         int     (*set_noack_map)(struct wiphy *wiphy,
3658                                   struct net_device *dev,
3659                                   u16 noack_map);
3660 
3661         int     (*get_channel)(struct wiphy *wiphy,
3662                                struct wireless_dev *wdev,
3663                                struct cfg80211_chan_def *chandef);
3664 
3665         int     (*start_p2p_device)(struct wiphy *wiphy,
3666                                     struct wireless_dev *wdev);
3667         void    (*stop_p2p_device)(struct wiphy *wiphy,
3668                                    struct wireless_dev *wdev);
3669 
3670         int     (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3671                                const struct cfg80211_acl_data *params);
3672 
3673         int     (*start_radar_detection)(struct wiphy *wiphy,
3674                                          struct net_device *dev,
3675                                          struct cfg80211_chan_def *chandef,
3676                                          u32 cac_time_ms);
3677         int     (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3678                                  struct cfg80211_update_ft_ies_params *ftie);
3679         int     (*crit_proto_start)(struct wiphy *wiphy,
3680                                     struct wireless_dev *wdev,
3681                                     enum nl80211_crit_proto_id protocol,
3682                                     u16 duration);
3683         void    (*crit_proto_stop)(struct wiphy *wiphy,
3684                                    struct wireless_dev *wdev);
3685         int     (*set_coalesce)(struct wiphy *wiphy,
3686                                 struct cfg80211_coalesce *coalesce);
3687 
3688         int     (*channel_switch)(struct wiphy *wiphy,
3689                                   struct net_device *dev,
3690                                   struct cfg80211_csa_settings *params);
3691 
3692         int     (*set_qos_map)(struct wiphy *wiphy,
3693                                struct net_device *dev,
3694                                struct cfg80211_qos_map *qos_map);
3695 
3696         int     (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3697                                     struct cfg80211_chan_def *chandef);
3698 
3699         int     (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3700                              u8 tsid, const u8 *peer, u8 user_prio,
3701                              u16 admitted_time);
3702         int     (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3703                              u8 tsid, const u8 *peer);
3704 
3705         int     (*tdls_channel_switch)(struct wiphy *wiphy,
3706                                        struct net_device *dev,
3707                                        const u8 *addr, u8 oper_class,
3708                                        struct cfg80211_chan_def *chandef);
3709         void    (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3710                                               struct net_device *dev,
3711                                               const u8 *addr);
3712         int     (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3713                              struct cfg80211_nan_conf *conf);
3714         void    (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3715         int     (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3716                                 struct cfg80211_nan_func *nan_func);
3717         void    (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3718                                u64 cookie);
3719         int     (*nan_change_conf)(struct wiphy *wiphy,
3720                                    struct wireless_dev *wdev,
3721                                    struct cfg80211_nan_conf *conf,
3722                                    u32 changes);
3723 
3724         int     (*set_multicast_to_unicast)(struct wiphy *wiphy,
3725                                             struct net_device *dev,
3726                                             const bool enabled);
3727 
3728         int     (*get_txq_stats)(struct wiphy *wiphy,
3729                                  struct wireless_dev *wdev,
3730                                  struct cfg80211_txq_stats *txqstats);
3731 
3732         int     (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3733                            const struct cfg80211_pmk_conf *conf);
3734         int     (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3735                            const u8 *aa);
3736         int     (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3737                                  struct cfg80211_external_auth_params *params);
3738 
3739         int     (*tx_control_port)(struct wiphy *wiphy,
3740                                    struct net_device *dev,
3741                                    const u8 *buf, size_t len,
3742                                    const u8 *dest, const __be16 proto,
3743                                    const bool noencrypt);
3744 
3745         int     (*get_ftm_responder_stats)(struct wiphy *wiphy,
3746                                 struct net_device *dev,
3747                                 struct cfg80211_ftm_responder_stats *ftm_stats);
3748 
3749         int     (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3750                               struct cfg80211_pmsr_request *request);
3751         void    (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3752                               struct cfg80211_pmsr_request *request);
3753 };
3754 
3755 /*
3756  * wireless hardware and networking interfaces structures
3757  * and registration/helper functions
3758  */
3759 
3760 /**
3761  * enum wiphy_flags - wiphy capability flags
3762  *
3763  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3764  *      wiphy at all
3765  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3766  *      by default -- this flag will be set depending on the kernel's default
3767  *      on wiphy_new(), but can be changed by the driver if it has a good
3768  *      reason to override the default
3769  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3770  *      on a VLAN interface)
3771  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3772  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3773  *      control port protocol ethertype. The device also honours the
3774  *      control_port_no_encrypt flag.
3775  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3776  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3777  *      auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3778  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3779  *      firmware.
3780  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3781  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3782  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3783  *      link setup/discovery operations internally. Setup, discovery and
3784  *      teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3785  *      command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3786  *      used for asking the driver/firmware to perform a TDLS operation.
3787  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3788  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3789  *      when there are virtual interfaces in AP mode by calling
3790  *      cfg80211_report_obss_beacon().
3791  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3792  *      responds to probe-requests in hardware.
3793  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3794  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3795  * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3796  * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3797  *      beaconing mode (AP, IBSS, Mesh, ...).
3798  * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3799  *      before connection.
3800  */
3801 enum wiphy_flags {
3802         /* use hole at 0 */
3803         /* use hole at 1 */
3804         /* use hole at 2 */
3805         WIPHY_FLAG_NETNS_OK                     = BIT(3),
3806         WIPHY_FLAG_PS_ON_BY_DEFAULT             = BIT(4),
3807         WIPHY_FLAG_4ADDR_AP                     = BIT(5),
3808         WIPHY_FLAG_4ADDR_STATION                = BIT(6),
3809         WIPHY_FLAG_CONTROL_PORT_PROTOCOL        = BIT(7),
3810         WIPHY_FLAG_IBSS_RSN                     = BIT(8),
3811         WIPHY_FLAG_MESH_AUTH                    = BIT(10),
3812         /* use hole at 11 */
3813         /* use hole at 12 */
3814         WIPHY_FLAG_SUPPORTS_FW_ROAM             = BIT(13),
3815         WIPHY_FLAG_AP_UAPSD                     = BIT(14),
3816         WIPHY_FLAG_SUPPORTS_TDLS                = BIT(15),
3817         WIPHY_FLAG_TDLS_EXTERNAL_SETUP          = BIT(16),
3818         WIPHY_FLAG_HAVE_AP_SME                  = BIT(17),
3819         WIPHY_FLAG_REPORTS_OBSS                 = BIT(18),
3820         WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD        = BIT(19),
3821         WIPHY_FLAG_OFFCHAN_TX                   = BIT(20),
3822         WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL        = BIT(21),
3823         WIPHY_FLAG_SUPPORTS_5_10_MHZ            = BIT(22),
3824         WIPHY_FLAG_HAS_CHANNEL_SWITCH           = BIT(23),
3825         WIPHY_FLAG_HAS_STATIC_WEP               = BIT(24),
3826 };
3827 
3828 /**
3829  * struct ieee80211_iface_limit - limit on certain interface types
3830  * @max: maximum number of interfaces of these types
3831  * @types: interface types (bits)
3832  */
3833 struct ieee80211_iface_limit {
3834         u16 max;
3835         u16 types;
3836 };
3837 
3838 /**
3839  * struct ieee80211_iface_combination - possible interface combination
3840  *
3841  * With this structure the driver can describe which interface
3842  * combinations it supports concurrently.
3843  *
3844  * Examples:
3845  *
3846  * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3847  *
3848  *    .. code-block:: c
3849  *
3850  *      struct ieee80211_iface_limit limits1[] = {
3851  *              { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3852  *              { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3853  *      };
3854  *      struct ieee80211_iface_combination combination1 = {
3855  *              .limits = limits1,
3856  *              .n_limits = ARRAY_SIZE(limits1),
3857  *              .max_interfaces = 2,
3858  *              .beacon_int_infra_match = true,
3859  *      };
3860  *
3861  *
3862  * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3863  *
3864  *    .. code-block:: c
3865  *
3866  *      struct ieee80211_iface_limit limits2[] = {
3867  *              { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3868  *                                   BIT(NL80211_IFTYPE_P2P_GO), },
3869  *      };
3870  *      struct ieee80211_iface_combination combination2 = {
3871  *              .limits = limits2,
3872  *              .n_limits = ARRAY_SIZE(limits2),
3873  *              .max_interfaces = 8,
3874  *              .num_different_channels = 1,
3875  *      };
3876  *
3877  *
3878  * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3879  *
3880  *    This allows for an infrastructure connection and three P2P connections.
3881  *
3882  *    .. code-block:: c
3883  *
3884  *      struct ieee80211_iface_limit limits3[] = {
3885  *              { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3886  *              { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3887  *                                   BIT(NL80211_IFTYPE_P2P_CLIENT), },
3888  *      };
3889  *      struct ieee80211_iface_combination combination3 = {
3890  *              .limits = limits3,
3891  *              .n_limits = ARRAY_SIZE(limits3),
3892  *              .max_interfaces = 4,
3893  *              .num_different_channels = 2,
3894  *      };
3895  *
3896  */
3897 struct ieee80211_iface_combination {
3898         /**
3899          * @limits:
3900          * limits for the given interface types
3901          */
3902         const struct ieee80211_iface_limit *limits;
3903 
3904         /**
3905          * @num_different_channels:
3906          * can use up to this many different channels
3907          */
3908         u32 num_different_channels;
3909 
3910         /**
3911          * @max_interfaces:
3912          * maximum number of interfaces in total allowed in this group
3913          */
3914         u16 max_interfaces;
3915 
3916         /**
3917          * @n_limits:
3918          * number of limitations
3919          */
3920         u8 n_limits;
3921 
3922         /**
3923          * @beacon_int_infra_match:
3924          * In this combination, the beacon intervals between infrastructure
3925          * and AP types must match. This is required only in special cases.
3926          */
3927         bool beacon_int_infra_match;
3928 
3929         /**
3930          * @radar_detect_widths:
3931          * bitmap of channel widths supported for radar detection
3932          */
3933         u8 radar_detect_widths;
3934 
3935         /**
3936          * @radar_detect_regions:
3937          * bitmap of regions supported for radar detection
3938          */
3939         u8 radar_detect_regions;
3940 
3941         /**
3942          * @beacon_int_min_gcd:
3943          * This interface combination supports different beacon intervals.
3944          *
3945          * = 0
3946          *   all beacon intervals for different interface must be same.
3947          * > 0
3948          *   any beacon interval for the interface part of this combination AND
3949          *   GCD of all beacon intervals from beaconing interfaces of this
3950          *   combination must be greater or equal to this value.
3951          */
3952         u32 beacon_int_min_gcd;
3953 };
3954 
3955 struct ieee80211_txrx_stypes {
3956         u16 tx, rx;
3957 };
3958 
3959 /**
3960  * enum wiphy_wowlan_support_flags - WoWLAN support flags
3961  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3962  *      trigger that keeps the device operating as-is and
3963  *      wakes up the host on any activity, for example a
3964  *      received packet that passed filtering; note that the
3965  *      packet should be preserved in that case
3966  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3967  *      (see nl80211.h)
3968  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3969  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3970  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3971  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3972  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3973  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3974  * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3975  */
3976 enum wiphy_wowlan_support_flags {
3977         WIPHY_WOWLAN_ANY                = BIT(0),
3978         WIPHY_WOWLAN_MAGIC_PKT          = BIT(1),
3979         WIPHY_WOWLAN_DISCONNECT         = BIT(2),
3980         WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3981         WIPHY_WOWLAN_GTK_REKEY_FAILURE  = BIT(4),
3982         WIPHY_WOWLAN_EAP_IDENTITY_REQ   = BIT(5),
3983         WIPHY_WOWLAN_4WAY_HANDSHAKE     = BIT(6),
3984         WIPHY_WOWLAN_RFKILL_RELEASE     = BIT(7),
3985         WIPHY_WOWLAN_NET_DETECT         = BIT(8),
3986 };
3987 
3988 struct wiphy_wowlan_tcp_support {
3989         const struct nl80211_wowlan_tcp_data_token_feature *tok;
3990         u32 data_payload_max;
3991         u32 data_interval_max;
3992         u32 wake_payload_max;
3993         bool seq;
3994 };
3995 
3996 /**
3997  * struct wiphy_wowlan_support - WoWLAN support data
3998  * @flags: see &enum wiphy_wowlan_support_flags
3999  * @n_patterns: number of supported wakeup patterns
4000  *      (see nl80211.h for the pattern definition)
4001  * @pattern_max_len: maximum length of each pattern
4002  * @pattern_min_len: minimum length of each pattern
4003  * @max_pkt_offset: maximum Rx packet offset
4004  * @max_nd_match_sets: maximum number of matchsets for net-detect,
4005  *      similar, but not necessarily identical, to max_match_sets for
4006  *      scheduled scans.
4007  *      See &struct cfg80211_sched_scan_request.@match_sets for more
4008  *      details.
4009  * @tcp: TCP wakeup support information
4010  */
4011 struct wiphy_wowlan_support {
4012         u32 flags;
4013         int n_patterns;
4014         int pattern_max_len;
4015         int pattern_min_len;
4016         int max_pkt_offset;
4017         int max_nd_match_sets;
4018         const struct wiphy_wowlan_tcp_support *tcp;
4019 };
4020 
4021 /**
4022  * struct wiphy_coalesce_support - coalesce support data
4023  * @n_rules: maximum number of coalesce rules
4024  * @max_delay: maximum supported coalescing delay in msecs
4025  * @n_patterns: number of supported patterns in a rule
4026  *      (see nl80211.h for the pattern definition)
4027  * @pattern_max_len: maximum length of each pattern
4028  * @pattern_min_len: minimum length of each pattern
4029  * @max_pkt_offset: maximum Rx packet offset
4030  */
4031 struct wiphy_coalesce_support {
4032         int n_rules;
4033         int max_delay;
4034         int n_patterns;
4035         int pattern_max_len;
4036         int pattern_min_len;
4037         int max_pkt_offset;
4038 };
4039 
4040 /**
4041  * enum wiphy_vendor_command_flags - validation flags for vendor commands
4042  * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4043  * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4044  * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4045  *      (must be combined with %_WDEV or %_NETDEV)
4046  */
4047 enum wiphy_vendor_command_flags {
4048         WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4049         WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4050         WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4051 };
4052 
4053 /**
4054  * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4055  *
4056  * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4057  * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4058  * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4059  *
4060  */
4061 enum wiphy_opmode_flag {
4062         STA_OPMODE_MAX_BW_CHANGED       = BIT(0),
4063         STA_OPMODE_SMPS_MODE_CHANGED    = BIT(1),
4064         STA_OPMODE_N_SS_CHANGED         = BIT(2),
4065 };
4066 
4067 /**
4068  * struct sta_opmode_info - Station's ht/vht operation mode information
4069  * @changed: contains value from &enum wiphy_opmode_flag
4070  * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4071  * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4072  * @rx_nss: new rx_nss value of a station
4073  */
4074 
4075 struct sta_opmode_info {
4076         u32 changed;
4077         enum nl80211_smps_mode smps_mode;
4078         enum nl80211_chan_width bw;
4079         u8 rx_nss;
4080 };
4081 
4082 /**
4083  * struct wiphy_vendor_command - vendor command definition
4084  * @info: vendor command identifying information, as used in nl80211
4085  * @flags: flags, see &enum wiphy_vendor_command_flags
4086  * @doit: callback for the operation, note that wdev is %NULL if the
4087  *      flags didn't ask for a wdev and non-%NULL otherwise; the data
4088  *      pointer may be %NULL if userspace provided no data at all
4089  * @dumpit: dump callback, for transferring bigger/multiple items. The
4090  *      @storage points to cb->args[5], ie. is preserved over the multiple
4091  *      dumpit calls.
4092  * It's recommended to not have the same sub command with both @doit and
4093  * @dumpit, so that userspace can assume certain ones are get and others
4094  * are used with dump requests.
4095  */
4096 struct wiphy_vendor_command {
4097         struct nl80211_vendor_cmd_info info;
4098         u32 flags;
4099         int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4100                     const void *data, int data_len);
4101         int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4102                       struct sk_buff *skb, const void *data, int data_len,
4103                       unsigned long *storage);
4104 };
4105 
4106 /**
4107  * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4108  * @iftype: interface type
4109  * @extended_capabilities: extended capabilities supported by the driver,
4110  *      additional capabilities might be supported by userspace; these are the
4111  *      802.11 extended capabilities ("Extended Capabilities element") and are
4112  *      in the same format as in the information element. See IEEE Std
4113  *      802.11-2012 8.4.2.29 for the defined fields.
4114  * @extended_capabilities_mask: mask of the valid values
4115  * @extended_capabilities_len: length of the extended capabilities
4116  */
4117 struct wiphy_iftype_ext_capab {
4118         enum nl80211_iftype iftype;
4119         const u8 *extended_capabilities;
4120         const u8 *extended_capabilities_mask;
4121         u8 extended_capabilities_len;
4122 };
4123 
4124 /**
4125  * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4126  * @max_peers: maximum number of peers in a single measurement
4127  * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4128  * @randomize_mac_addr: can randomize MAC address for measurement
4129  * @ftm.supported: FTM measurement is supported
4130  * @ftm.asap: ASAP-mode is supported
4131  * @ftm.non_asap: non-ASAP-mode is supported
4132  * @ftm.request_lci: can request LCI data
4133  * @ftm.request_civicloc: can request civic location data
4134  * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4135  * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4136  * @ftm.max_bursts_exponent: maximum burst exponent supported
4137  *      (set to -1 if not limited; note that setting this will necessarily
4138  *      forbid using the value 15 to let the responder pick)
4139  * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4140  *      not limited)
4141  */
4142 struct cfg80211_pmsr_capabilities {
4143         unsigned int max_peers;
4144         u8 report_ap_tsf:1,
4145            randomize_mac_addr:1;
4146 
4147         struct {
4148                 u32 preambles;
4149                 u32 bandwidths;
4150                 s8 max_bursts_exponent;
4151                 u8 max_ftms_per_burst;
4152                 u8 supported:1,
4153                    asap:1,
4154                    non_asap:1,
4155                    request_lci:1,
4156                    request_civicloc:1;
4157         } ftm;
4158 };
4159 
4160 /**
4161  * struct wiphy - wireless hardware description
4162  * @reg_notifier: the driver's regulatory notification callback,
4163  *      note that if your driver uses wiphy_apply_custom_regulatory()
4164  *      the reg_notifier's request can be passed as NULL
4165  * @regd: the driver's regulatory domain, if one was requested via
4166  *      the regulatory_hint() API. This can be used by the driver
4167  *      on the reg_notifier() if it chooses to ignore future
4168  *      regulatory domain changes caused by other drivers.
4169  * @signal_type: signal type reported in &struct cfg80211_bss.
4170  * @cipher_suites: supported cipher suites
4171  * @n_cipher_suites: number of supported cipher suites
4172  * @akm_suites: supported AKM suites
4173  * @n_akm_suites: number of supported AKM suites
4174  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4175  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4176  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4177  *      -1 = fragmentation disabled, only odd values >= 256 used
4178  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4179  * @_net: the network namespace this wiphy currently lives in
4180  * @perm_addr: permanent MAC address of this device
4181  * @addr_mask: If the device supports multiple MAC addresses by masking,
4182  *      set this to a mask with variable bits set to 1, e.g. if the last
4183  *      four bits are variable then set it to 00-00-00-00-00-0f. The actual
4184  *      variable bits shall be determined by the interfaces added, with
4185  *      interfaces not matching the mask being rejected to be brought up.
4186  * @n_addresses: number of addresses in @addresses.
4187  * @addresses: If the device has more than one address, set this pointer
4188  *      to a list of addresses (6 bytes each). The first one will be used
4189  *      by default for perm_addr. In this case, the mask should be set to
4190  *      all-zeroes. In this case it is assumed that the device can handle
4191  *      the same number of arbitrary MAC addresses.
4192  * @registered: protects ->resume and ->suspend sysfs callbacks against
4193  *      unregister hardware
4194  * @debugfsdir: debugfs directory used for this wiphy, will be renamed
4195  *      automatically on wiphy renames
4196  * @dev: (virtual) struct device for this wiphy
4197  * @registered: helps synchronize suspend/resume with wiphy unregister
4198  * @wext: wireless extension handlers
4199  * @priv: driver private data (sized according to wiphy_new() parameter)
4200  * @interface_modes: bitmask of interfaces types valid for this wiphy,
4201  *      must be set by driver
4202  * @iface_combinations: Valid interface combinations array, should not
4203  *      list single interface types.
4204  * @n_iface_combinations: number of entries in @iface_combinations array.
4205  * @software_iftypes: bitmask of software interface types, these are not
4206  *      subject to any restrictions since they are purely managed in SW.
4207  * @flags: wiphy flags, see &enum wiphy_flags
4208  * @regulatory_flags: wiphy regulatory flags, see
4209  *      &enum ieee80211_regulatory_flags
4210  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4211  * @ext_features: extended features advertised to nl80211, see
4212  *      &enum nl80211_ext_feature_index.
4213  * @bss_priv_size: each BSS struct has private data allocated with it,
4214  *      this variable determines its size
4215  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4216  *      any given scan
4217  * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4218  *      the device can run concurrently.
4219  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4220  *      for in any given scheduled scan
4221  * @max_match_sets: maximum number of match sets the device can handle
4222  *      when performing a scheduled scan, 0 if filtering is not
4223  *      supported.
4224  * @max_scan_ie_len: maximum length of user-controlled IEs device can
4225  *      add to probe request frames transmitted during a scan, must not
4226  *      include fixed IEs like supported rates
4227  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4228  *      scans
4229  * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4230  *      of iterations) for scheduled scan supported by the device.
4231  * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4232  *      single scan plan supported by the device.
4233  * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4234  *      scan plan supported by the device.
4235  * @coverage_class: current coverage class
4236  * @fw_version: firmware version for ethtool reporting
4237  * @hw_version: hardware version for ethtool reporting
4238  * @max_num_pmkids: maximum number of PMKIDs supported by device
4239  * @privid: a pointer that drivers can use to identify if an arbitrary
4240  *      wiphy is theirs, e.g. in global notifiers
4241  * @bands: information about bands/channels supported by this device
4242  *
4243  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4244  *      transmitted through nl80211, points to an array indexed by interface
4245  *      type
4246  *
4247  * @available_antennas_tx: bitmap of antennas which are available to be
4248  *      configured as TX antennas. Antenna configuration commands will be
4249  *      rejected unless this or @available_antennas_rx is set.
4250  *
4251  * @available_antennas_rx: bitmap of antennas which are available to be
4252  *      configured as RX antennas. Antenna configuration commands will be
4253  *      rejected unless this or @available_antennas_tx is set.
4254  *
4255  * @probe_resp_offload:
4256  *       Bitmap of supported protocols for probe response offloading.
4257  *       See &enum nl80211_probe_resp_offload_support_attr. Only valid
4258  *       when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4259  *
4260  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4261  *      may request, if implemented.
4262  *
4263  * @wowlan: WoWLAN support information
4264  * @wowlan_config: current WoWLAN configuration; this should usually not be
4265  *      used since access to it is necessarily racy, use the parameter passed
4266  *      to the suspend() operation instead.
4267  *
4268  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4269  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
4270  *      If null, then none can be over-ridden.
4271  * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
4272  *      If null, then none can be over-ridden.
4273  *
4274  * @wdev_list: the list of associated (virtual) interfaces; this list must
4275  *      not be modified by the driver, but can be read with RTNL/RCU protection.
4276  *
4277  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4278  *      supports for ACL.
4279  *
4280  * @extended_capabilities: extended capabilities supported by the driver,
4281  *      additional capabilities might be supported by userspace; these are
4282  *      the 802.11 extended capabilities ("Extended Capabilities element")
4283  *      and are in the same format as in the information element. See
4284  *      802.11-2012 8.4.2.29 for the defined fields. These are the default
4285  *      extended capabilities to be used if the capabilities are not specified
4286  *      for a specific interface type in iftype_ext_capab.
4287  * @extended_capabilities_mask: mask of the valid values
4288  * @extended_capabilities_len: length of the extended capabilities
4289  * @iftype_ext_capab: array of extended capabilities per interface type
4290  * @num_iftype_ext_capab: number of interface types for which extended
4291  *      capabilities are specified separately.
4292  * @coalesce: packet coalescing support information
4293  *
4294  * @vendor_commands: array of vendor commands supported by the hardware
4295  * @n_vendor_commands: number of vendor commands
4296  * @vendor_events: array of vendor events supported by the hardware
4297  * @n_vendor_events: number of vendor events
4298  *
4299  * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4300  *      (including P2P GO) or 0 to indicate no such limit is advertised. The
4301  *      driver is allowed to advertise a theoretical limit that it can reach in
4302  *      some cases, but may not always reach.
4303  *
4304  * @max_num_csa_counters: Number of supported csa_counters in beacons
4305  *      and probe responses.  This value should be set if the driver
4306  *      wishes to limit the number of csa counters. Default (0) means
4307  *      infinite.
4308  * @max_adj_channel_rssi_comp: max offset of between the channel on which the
4309  *      frame was sent and the channel on which the frame was heard for which
4310  *      the reported rssi is still valid. If a driver is able to compensate the
4311  *      low rssi when a frame is heard on different channel, then it should set
4312  *      this variable to the maximal offset for which it can compensate.
4313  *      This value should be set in MHz.
4314  * @bss_select_support: bitmask indicating the BSS selection criteria supported
4315  *      by the driver in the .connect() callback. The bit position maps to the
4316  *      attribute indices defined in &enum nl80211_bss_select_attr.
4317  *
4318  * @nan_supported_bands: bands supported by the device in NAN mode, a
4319  *      bitmap of &enum nl80211_band values.  For instance, for
4320  *      NL80211_BAND_2GHZ, bit 0 would be set
4321  *      (i.e. BIT(NL80211_BAND_2GHZ)).
4322  *
4323  * @txq_limit: configuration of internal TX queue frame limit
4324  * @txq_memory_limit: configuration internal TX queue memory limit
4325  * @txq_quantum: configuration of internal TX queue scheduler quantum
4326  *
4327  * @support_mbssid: can HW support association with nontransmitted AP
4328  * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4329  *      HE AP, in order to avoid compatibility issues.
4330  *      @support_mbssid must be set for this to have any effect.
4331  *
4332  * @pmsr_capa: peer measurement capabilities
4333  */
4334 struct wiphy {
4335         /* assign these fields before you register the wiphy */
4336 
4337         /* permanent MAC address(es) */
4338         u8 perm_addr[ETH_ALEN];
4339         u8 addr_mask[ETH_ALEN];
4340 
4341         struct mac_address *addresses;
4342 
4343         const struct ieee80211_txrx_stypes *mgmt_stypes;
4344 
4345         const struct ieee80211_iface_combination *iface_combinations;
4346         int n_iface_combinations;
4347         u16 software_iftypes;
4348 
4349         u16 n_addresses;
4350 
4351         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4352         u16 interface_modes;
4353 
4354         u16 max_acl_mac_addrs;
4355 
4356         u32 flags, regulatory_flags, features;
4357         u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4358 
4359         u32 ap_sme_capa;
4360 
4361         enum cfg80211_signal_type signal_type;
4362 
4363         int bss_priv_size;
4364         u8 max_scan_ssids;
4365         u8 max_sched_scan_reqs;
4366         u8 max_sched_scan_ssids;
4367         u8 max_match_sets;
4368         u16 max_scan_ie_len;
4369         u16 max_sched_scan_ie_len;
4370         u32 max_sched_scan_plans;
4371         u32 max_sched_scan_plan_interval;
4372         u32 max_sched_scan_plan_iterations;
4373 
4374         int n_cipher_suites;
4375         const u32 *cipher_suites;
4376 
4377         int n_akm_suites;
4378         const u32 *akm_suites;
4379 
4380         u8 retry_short;
4381         u8 retry_long;
4382         u32 frag_threshold;
4383         u32 rts_threshold;
4384         u8 coverage_class;
4385 
4386         char fw_version[ETHTOOL_FWVERS_LEN];
4387         u32 hw_version;
4388 
4389 #ifdef CONFIG_PM
4390         const struct wiphy_wowlan_support *wowlan;
4391         struct cfg80211_wowlan *wowlan_config;
4392 #endif
4393 
4394         u16 max_remain_on_channel_duration;
4395 
4396         u8 max_num_pmkids;
4397 
4398         u32 available_antennas_tx;
4399         u32 available_antennas_rx;
4400 
4401         /*
4402          * Bitmap of supported protocols for probe response offloading
4403          * see &enum nl80211_probe_resp_offload_support_attr. Only valid
4404          * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4405          */
4406         u32 probe_resp_offload;
4407 
4408         const u8 *extended_capabilities, *extended_capabilities_mask;
4409         u8 extended_capabilities_len;
4410 
4411         const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4412         unsigned int num_iftype_ext_capab;
4413 
4414         /* If multiple wiphys are registered and you're handed e.g.
4415          * a regular netdev with assigned ieee80211_ptr, you won't
4416          * know whether it points to a wiphy your driver has registered
4417          * or not. Assign this to something global to your driver to
4418          * help determine whether you own this wiphy or not. */
4419         const void *privid;
4420 
4421         struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4422 
4423         /* Lets us get back the wiphy on the callback */
4424         void (*reg_notifier)(struct wiphy *wiphy,
4425                              struct regulatory_request *request);
4426 
4427         /* fields below are read-only, assigned by cfg80211 */
4428 
4429         const struct ieee80211_regdomain __rcu *regd;
4430 
4431         /* the item in /sys/class/ieee80211/ points to this,
4432          * you need use set_wiphy_dev() (see below) */
4433         struct device dev;
4434 
4435         /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
4436         bool registered;
4437 
4438         /* dir in debugfs: ieee80211/<wiphyname> */
4439         struct dentry *debugfsdir;
4440 
4441         const struct ieee80211_ht_cap *ht_capa_mod_mask;
4442         const struct ieee80211_vht_cap *vht_capa_mod_mask;
4443 
4444         struct list_head wdev_list;
4445 
4446         /* the network namespace this phy lives in currently */
4447         possible_net_t _net;
4448 
4449 #ifdef CONFIG_CFG80211_WEXT
4450         const struct iw_handler_def *wext;
4451 #endif
4452 
4453         const struct wiphy_coalesce_support *coalesce;
4454 
4455         const struct wiphy_vendor_command *vendor_commands;
4456         const struct nl80211_vendor_cmd_info *vendor_events;
4457         int n_vendor_commands, n_vendor_events;
4458 
4459         u16 max_ap_assoc_sta;
4460 
4461         u8 max_num_csa_counters;
4462         u8 max_adj_channel_rssi_comp;
4463 
4464         u32 bss_select_support;
4465 
4466         u8 nan_supported_bands;
4467 
4468         u32 txq_limit;
4469         u32 txq_memory_limit;
4470         u32 txq_quantum;
4471 
4472         u8 support_mbssid:1,
4473            support_only_he_mbssid:1;
4474 
4475         const struct cfg80211_pmsr_capabilities *pmsr_capa;
4476 
4477         char priv[0] __aligned(NETDEV_ALIGN);
4478 };
4479 
4480 static inline struct net *wiphy_net(struct wiphy *wiphy)
4481 {
4482         return read_pnet(&wiphy->_net);
4483 }
4484 
4485 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4486 {
4487         write_pnet(&wiphy->_net, net);
4488 }
4489 
4490 /**
4491  * wiphy_priv - return priv from wiphy
4492  *
4493  * @wiphy: the wiphy whose priv pointer to return
4494  * Return: The priv of @wiphy.
4495  */
4496 static inline void *wiphy_priv(struct wiphy *wiphy)
4497 {
4498         BUG_ON(!wiphy);
4499         return &wiphy->priv;
4500 }
4501 
4502 /**
4503  * priv_to_wiphy - return the wiphy containing the priv
4504  *
4505  * @priv: a pointer previously returned by wiphy_priv
4506  * Return: The wiphy of @priv.
4507  */
4508 static inline struct wiphy *priv_to_wiphy(void *priv)
4509 {
4510         BUG_ON(!priv);
4511         return container_of(priv, struct wiphy, priv);
4512 }
4513 
4514 /**
4515  * set_wiphy_dev - set device pointer for wiphy
4516  *
4517  * @wiphy: The wiphy whose device to bind
4518  * @dev: The device to parent it to
4519  */
4520 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4521 {
4522         wiphy->dev.parent = dev;
4523 }
4524 
4525 /**
4526  * wiphy_dev - get wiphy dev pointer
4527  *
4528  * @wiphy: The wiphy whose device struct to look up
4529  * Return: The dev of @wiphy.
4530  */
4531 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4532 {
4533         return wiphy->dev.parent;
4534 }
4535 
4536 /**
4537  * wiphy_name - get wiphy name
4538  *
4539  * @wiphy: The wiphy whose name to return
4540  * Return: The name of @wiphy.
4541  */
4542 static inline const char *wiphy_name(const struct wiphy *wiphy)
4543 {
4544         return dev_name(&wiphy->dev);
4545 }
4546 
4547 /**
4548  * wiphy_new_nm - create a new wiphy for use with cfg80211
4549  *
4550  * @ops: The configuration operations for this device
4551  * @sizeof_priv: The size of the private area to allocate
4552  * @requested_name: Request a particular name.
4553  *      NULL is valid value, and means use the default phy%d naming.
4554  *
4555  * Create a new wiphy and associate the given operations with it.
4556  * @sizeof_priv bytes are allocated for private use.
4557  *
4558  * Return: A pointer to the new wiphy. This pointer must be
4559  * assigned to each netdev's ieee80211_ptr for proper operation.
4560  */
4561 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4562                            const char *requested_name);
4563 
4564 /**
4565  * wiphy_new - create a new wiphy for use with cfg80211
4566  *
4567  * @ops: The configuration operations for this device
4568  * @sizeof_priv: The size of the private area to allocate
4569  *
4570  * Create a new wiphy and associate the given operations with it.
4571  * @sizeof_priv bytes are allocated for private use.
4572  *
4573  * Return: A pointer to the new wiphy. This pointer must be
4574  * assigned to each netdev's ieee80211_ptr for proper operation.
4575  */
4576 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4577                                       int sizeof_priv)
4578 {
4579         return wiphy_new_nm(ops, sizeof_priv, NULL);
4580 }
4581 
4582 /**
4583  * wiphy_register - register a wiphy with cfg80211
4584  *
4585  * @wiphy: The wiphy to register.
4586  *
4587  * Return: A non-negative wiphy index or a negative error code.
4588  */
4589 int wiphy_register(struct wiphy *wiphy);
4590 
4591 /**
4592  * wiphy_unregister - deregister a wiphy from cfg80211
4593  *
4594  * @wiphy: The wiphy to unregister.
4595  *
4596  * After this call, no more requests can be made with this priv
4597  * pointer, but the call may sleep to wait for an outstanding
4598  * request that is being handled.
4599  */
4600 void wiphy_unregister(struct wiphy *wiphy);
4601 
4602 /**
4603  * wiphy_free - free wiphy
4604  *
4605  * @wiphy: The wiphy to free
4606  */
4607 void wiphy_free(struct wiphy *wiphy);
4608 
4609 /* internal structs */
4610 struct cfg80211_conn;
4611 struct cfg80211_internal_bss;
4612 struct cfg80211_cached_keys;
4613 struct cfg80211_cqm_config;
4614 
4615 /**
4616  * struct wireless_dev - wireless device state
4617  *
4618  * For netdevs, this structure must be allocated by the driver
4619  * that uses the ieee80211_ptr field in struct net_device (this
4620  * is intentional so it can be allocated along with the netdev.)
4621  * It need not be registered then as netdev registration will
4622  * be intercepted by cfg80211 to see the new wireless device.
4623  *
4624  * For non-netdev uses, it must also be allocated by the driver
4625  * in response to the cfg80211 callbacks that require it, as
4626  * there's no netdev registration in that case it may not be
4627  * allocated outside of callback operations that return it.
4628  *
4629  * @wiphy: pointer to hardware description
4630  * @iftype: interface type
4631  * @list: (private) Used to collect the interfaces
4632  * @netdev: (private) Used to reference back to the netdev, may be %NULL
4633  * @identifier: (private) Identifier used in nl80211 to identify this
4634  *      wireless device if it has no netdev
4635  * @current_bss: (private) Used by the internal configuration code
4636  * @chandef: (private) Used by the internal configuration code to track
4637  *      the user-set channel definition.
4638  * @preset_chandef: (private) Used by the internal configuration code to
4639  *      track the channel to be used for AP later
4640  * @bssid: (private) Used by the internal configuration code
4641  * @ssid: (private) Used by the internal configuration code
4642  * @ssid_len: (private) Used by the internal configuration code
4643  * @mesh_id_len: (private) Used by the internal configuration code
4644  * @mesh_id_up_len: (private) Used by the internal configuration code
4645  * @wext: (private) Used by the internal wireless extensions compat code
4646  * @wext.ibss: (private) IBSS data part of wext handling
4647  * @wext.connect: (private) connection handling data
4648  * @wext.keys: (private) (WEP) key data
4649  * @wext.ie: (private) extra elements for association
4650  * @wext.ie_len: (private) length of extra elements
4651  * @wext.bssid: (private) selected network BSSID
4652  * @wext.ssid: (private) selected network SSID
4653  * @wext.default_key: (private) selected default key index
4654  * @wext.default_mgmt_key: (private) selected default management key index
4655  * @wext.prev_bssid: (private) previous BSSID for reassociation
4656  * @wext.prev_bssid_valid: (private) previous BSSID validity
4657  * @use_4addr: indicates 4addr mode is used on this interface, must be
4658  *      set by driver (if supported) on add_interface BEFORE registering the
4659  *      netdev and may otherwise be used by driver read-only, will be update
4660  *      by cfg80211 on change_interface
4661  * @mgmt_registrations: list of registrations for management frames
4662  * @mgmt_registrations_lock: lock for the list
4663  * @mtx: mutex used to lock data in this struct, may be used by drivers
4664  *      and some API functions require it held
4665  * @beacon_interval: beacon interval used on this device for transmitting
4666  *      beacons, 0 when not valid
4667  * @address: The address for this device, valid only if @netdev is %NULL
4668  * @is_running: true if this is a non-netdev device that has been started, e.g.
4669  *      the P2P Device.
4670  * @cac_started: true if DFS channel availability check has been started
4671  * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4672  * @cac_time_ms: CAC time in ms
4673  * @ps: powersave mode is enabled
4674  * @ps_timeout: dynamic powersave timeout
4675  * @ap_unexpected_nlportid: (private) netlink port ID of application
4676  *      registered for unexpected class 3 frames (AP mode)
4677  * @conn: (private) cfg80211 software SME connection state machine data
4678  * @connect_keys: (private) keys to set after connection is established
4679  * @conn_bss_type: connecting/connected BSS type
4680  * @conn_owner_nlportid: (private) connection owner socket port ID
4681  * @disconnect_wk: (private) auto-disconnect work
4682  * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4683  * @ibss_fixed: (private) IBSS is using fixed BSSID
4684  * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4685  * @event_list: (private) list for internal event processing
4686  * @event_lock: (private) lock for event list
4687  * @owner_nlportid: (private) owner socket port ID
4688  * @nl_owner_dead: (private) owner socket went away
4689  * @cqm_config: (private) nl80211 RSSI monitor state
4690  * @pmsr_list: (private) peer measurement requests
4691  * @pmsr_lock: (private) peer measurements requests/results lock
4692  * @pmsr_free_wk: (private) peer measurements cleanup work
4693  */
4694 struct wireless_dev {
4695         struct wiphy *wiphy;
4696         enum nl80211_iftype iftype;
4697 
4698         /* the remainder of this struct should be private to cfg80211 */
4699         struct list_head list;
4700         struct net_device *netdev;
4701 
4702         u32 identifier;
4703 
4704         struct list_head mgmt_registrations;
4705         spinlock_t mgmt_registrations_lock;
4706 
4707         struct mutex mtx;
4708 
4709         bool use_4addr, is_running;
4710 
4711         u8 address[ETH_ALEN] __aligned(sizeof(u16));
4712 
4713         /* currently used for IBSS and SME - might be rearranged later */
4714         u8 ssid[IEEE80211_MAX_SSID_LEN];
4715         u8 ssid_len, mesh_id_len, mesh_id_up_len;
4716         struct cfg80211_conn *conn;
4717         struct cfg80211_cached_keys *connect_keys;
4718         enum ieee80211_bss_type conn_bss_type;
4719         u32 conn_owner_nlportid;
4720 
4721         struct work_struct disconnect_wk;
4722         u8 disconnect_bssid[ETH_ALEN];
4723 
4724         struct list_head event_list;
4725         spinlock_t event_lock;
4726 
4727         struct cfg80211_internal_bss *current_bss; /* associated / joined */
4728         struct cfg80211_chan_def preset_chandef;
4729         struct cfg80211_chan_def chandef;
4730 
4731         bool ibss_fixed;
4732         bool ibss_dfs_possible;
4733 
4734         bool ps;
4735         int ps_timeout;
4736 
4737         int beacon_interval;
4738 
4739         u32 ap_unexpected_nlportid;
4740 
4741         u32 owner_nlportid;
4742         bool nl_owner_dead;
4743 
4744         bool cac_started;
4745         unsigned long cac_start_time;
4746         unsigned int cac_time_ms;
4747 
4748 #ifdef CONFIG_CFG80211_WEXT
4749         /* wext data */
4750         struct {
4751                 struct cfg80211_ibss_params ibss;
4752                 struct cfg80211_connect_params connect;
4753                 struct cfg80211_cached_keys *keys;
4754                 const u8 *ie;
4755                 size_t ie_len;
4756                 u8 bssid[ETH_ALEN];
4757                 u8 prev_bssid[ETH_ALEN];
4758                 u8 ssid[IEEE80211_MAX_SSID_LEN];
4759                 s8 default_key, default_mgmt_key;
4760                 bool prev_bssid_valid;
4761         } wext;
4762 #endif
4763 
4764         struct cfg80211_cqm_config *cqm_config;
4765 
4766         struct list_head pmsr_list;
4767         spinlock_t pmsr_lock;
4768         struct work_struct pmsr_free_wk;
4769 };
4770 
4771 static inline u8 *wdev_address(struct wireless_dev *wdev)
4772 {
4773         if (wdev->netdev)
4774                 return wdev->netdev->dev_addr;
4775         return wdev->address;
4776 }
4777 
4778 static inline bool wdev_running(struct wireless_dev *wdev)
4779 {
4780         if (wdev->netdev)
4781                 return netif_running(wdev->netdev);
4782         return wdev->is_running;
4783 }
4784 
4785 /**
4786  * wdev_priv - return wiphy priv from wireless_dev
4787  *
4788  * @wdev: The wireless device whose wiphy's priv pointer to return
4789  * Return: The wiphy priv of @wdev.
4790  */
4791 static inline void *wdev_priv(struct wireless_dev *wdev)
4792 {
4793         BUG_ON(!wdev);
4794         return wiphy_priv(wdev->wiphy);
4795 }
4796 
4797 /**
4798  * DOC: Utility functions
4799  *
4800  * cfg80211 offers a number of utility functions that can be useful.
4801  */
4802 
4803 /**
4804  * ieee80211_channel_to_frequency - convert channel number to frequency
4805  * @chan: channel number
4806  * @band: band, necessary due to channel number overlap
4807  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
4808  */
4809 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
4810 
4811 /**
4812  * ieee80211_frequency_to_channel - convert frequency to channel number
4813  * @freq: center frequency
4814  * Return: The corresponding channel, or 0 if the conversion failed.
4815  */
4816 int ieee80211_frequency_to_channel(int freq);
4817 
4818 /**
4819  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
4820  *
4821  * @wiphy: the struct wiphy to get the channel for
4822  * @freq: the center frequency of the channel
4823  *
4824  * Return: The channel struct from @wiphy at @freq.
4825  */
4826 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
4827 
4828 /**
4829  * ieee80211_get_response_rate - get basic rate for a given rate
4830  *
4831  * @sband: the band to look for rates in
4832  * @basic_rates: bitmap of basic rates
4833  * @bitrate: the bitrate for which to find the basic rate
4834  *
4835  * Return: The basic rate corresponding to a given bitrate, that
4836  * is the next lower bitrate contained in the basic rate map,
4837  * which is, for this function, given as a bitmap of indices of
4838  * rates in the band's bitrate table.
4839  */
4840 struct ieee80211_rate *
4841 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
4842                             u32 basic_rates, int bitrate);
4843 
4844 /**
4845  * ieee80211_mandatory_rates - get mandatory rates for a given band
4846  * @sband: the band to look for rates in
4847  * @scan_width: width of the control channel
4848  *
4849  * This function returns a bitmap of the mandatory rates for the given
4850  * band, bits are set according to the rate position in the bitrates array.
4851  */
4852 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4853                               enum nl80211_bss_scan_width scan_width);
4854 
4855 /*
4856  * Radiotap parsing functions -- for controlled injection support
4857  *
4858  * Implemented in net/wireless/radiotap.c
4859  * Documentation in Documentation/networking/radiotap-headers.txt
4860  */
4861 
4862 struct radiotap_align_size {
4863         uint8_t align:4, size:4;
4864 };
4865 
4866 struct ieee80211_radiotap_namespace {
4867         const struct radiotap_align_size *align_size;
4868         int n_bits;
4869         uint32_t oui;
4870         uint8_t subns;
4871 };
4872 
4873 struct ieee80211_radiotap_vendor_namespaces {
4874         const struct ieee80211_radiotap_namespace *ns;
4875         int n_ns;
4876 };
4877 
4878 /**
4879  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4880  * @this_arg_index: index of current arg, valid after each successful call
4881  *      to ieee80211_radiotap_iterator_next()
4882  * @this_arg: pointer to current radiotap arg; it is valid after each
4883  *      call to ieee80211_radiotap_iterator_next() but also after
4884  *      ieee80211_radiotap_iterator_init() where it will point to
4885  *      the beginning of the actual data portion
4886  * @this_arg_size: length of the current arg, for convenience
4887  * @current_namespace: pointer to the current namespace definition
4888  *      (or internally %NULL if the current namespace is unknown)
4889  * @is_radiotap_ns: indicates whether the current namespace is the default
4890  *      radiotap namespace or not
4891  *
4892  * @_rtheader: pointer to the radiotap header we are walking through
4893  * @_max_length: length of radiotap header in cpu byte ordering
4894  * @_arg_index: next argument index
4895  * @_arg: next argument pointer
4896  * @_next_bitmap: internal pointer to next present u32
4897  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4898  * @_vns: vendor namespace definitions
4899  * @_next_ns_data: beginning of the next namespace's data
4900  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4901  *      next bitmap word
4902  *
4903  * Describes the radiotap parser state. Fields prefixed with an underscore
4904  * must not be used by users of the parser, only by the parser internally.
4905  */
4906 
4907 struct ieee80211_radiotap_iterator {
4908         struct ieee80211_radiotap_header *_rtheader;
4909         const struct ieee80211_radiotap_vendor_namespaces *_vns;
4910         const struct ieee80211_radiotap_namespace *current_namespace;
4911 
4912         unsigned char *_arg, *_next_ns_data;
4913         __le32 *_next_bitmap;
4914 
4915         unsigned char *this_arg;
4916         int this_arg_index;
4917         int this_arg_size;
4918 
4919         int is_radiotap_ns;
4920 
4921         int _max_length;
4922         int _arg_index;
4923         uint32_t _bitmap_shifter;
4924         int _reset_on_ext;
4925 };
4926 
4927 int
4928 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
4929                                  struct ieee80211_radiotap_header *radiotap_header,
4930                                  int max_length,
4931                                  const struct ieee80211_radiotap_vendor_namespaces *vns);
4932 
4933 int
4934 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
4935 
4936 
4937 extern const unsigned char rfc1042_header[6];
4938 extern const unsigned char bridge_tunnel_header[6];
4939 
4940 /**
4941  * ieee80211_get_hdrlen_from_skb - get header length from data
4942  *
4943  * @skb: the frame
4944  *
4945  * Given an skb with a raw 802.11 header at the data pointer this function
4946  * returns the 802.11 header length.
4947  *
4948  * Return: The 802.11 header length in bytes (not including encryption
4949  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4950  * 802.11 header.
4951  */
4952 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
4953 
4954 /**
4955  * ieee80211_hdrlen - get header length in bytes from frame control
4956  * @fc: frame control field in little-endian format
4957  * Return: The header length in bytes.
4958  */
4959 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
4960 
4961 /**
4962  * ieee80211_get_mesh_hdrlen - get mesh extension header length
4963  * @meshhdr: the mesh extension header, only the flags field
4964  *      (first byte) will be accessed
4965  * Return: The length of the extension header, which is always at
4966  * least 6 bytes and at most 18 if address 5 and 6 are present.
4967  */
4968 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
4969 
4970 /**
4971  * DOC: Data path helpers
4972  *
4973  * In addition to generic utilities, cfg80211 also offers
4974  * functions that help implement the data path for devices
4975  * that do not do the 802.11/802.3 conversion on the device.
4976  */
4977 
4978 /**
4979  * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4980  * @skb: the 802.11 data frame
4981  * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4982  *      of it being pushed into the SKB
4983  * @addr: the device MAC address
4984  * @iftype: the virtual interface type
4985  * @data_offset: offset of payload after the 802.11 header
4986  * Return: 0 on success. Non-zero on error.
4987  */
4988 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
4989                                   const u8 *addr, enum nl80211_iftype iftype,
4990                                   u8 data_offset);
4991 
4992 /**
4993  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4994  * @skb: the 802.11 data frame
4995  * @addr: the device MAC address
4996  * @iftype: the virtual interface type
4997  * Return: 0 on success. Non-zero on error.
4998  */
4999 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5000                                          enum nl80211_iftype iftype)
5001 {
5002         return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5003 }
5004 
5005 /**
5006  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5007  *
5008  * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5009  * The @list will be empty if the decode fails. The @skb must be fully
5010  * header-less before being passed in here; it is freed in this function.
5011  *
5012  * @skb: The input A-MSDU frame without any headers.
5013  * @list: The output list of 802.3 frames. It must be allocated and
5014  *      initialized by by the caller.
5015  * @addr: The device MAC address.
5016  * @iftype: The device interface type.
5017  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5018  * @check_da: DA to check in the inner ethernet header, or NULL
5019  * @check_sa: SA to check in the inner ethernet header, or NULL
5020  */
5021 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5022                               const u8 *addr, enum nl80211_iftype iftype,
5023                               const unsigned int extra_headroom,
5024                               const u8 *check_da, const u8 *check_sa);
5025 
5026 /**
5027  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5028  * @skb: the data frame
5029  * @qos_map: Interworking QoS mapping or %NULL if not in use
5030  * Return: The 802.1p/1d tag.
5031  */
5032 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5033                                     struct cfg80211_qos_map *qos_map);
5034 
5035 /**
5036  * cfg80211_find_elem_match - match information element and byte array in data
5037  *
5038  * @eid: element ID
5039  * @ies: data consisting of IEs
5040  * @len: length of data
5041  * @match: byte array to match
5042  * @match_len: number of bytes in the match array
5043  * @match_offset: offset in the IE data where the byte array should match.
5044  *      Note the difference to cfg80211_find_ie_match() which considers
5045  *      the offset to start from the element ID byte, but here we take
5046  *      the data portion instead.
5047  *
5048  * Return: %NULL if the element ID could not be found or if
5049  * the element is invalid (claims to be longer than the given
5050  * data) or if the byte array doesn't match; otherwise return the
5051  * requested element struct.
5052  *
5053  * Note: There are no checks on the element length other than
5054  * having to fit into the given data and being large enough for the
5055  * byte array to match.
5056  */
5057 const struct element *
5058 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5059                          const u8 *match, unsigned int match_len,
5060                          unsigned int match_offset);
5061 
5062 /**
5063  * cfg80211_find_ie_match - match information element and byte array in data
5064  *
5065  * @eid: element ID
5066  * @ies: data consisting of IEs
5067  * @len: length of data
5068  * @match: byte array to match
5069  * @match_len: number of bytes in the match array
5070  * @match_offset: offset in the IE where the byte array should match.
5071  *      If match_len is zero, this must also be set to zero.
5072  *      Otherwise this must be set to 2 or more, because the first
5073  *      byte is the element id, which is already compared to eid, and
5074  *      the second byte is the IE length.
5075  *
5076  * Return: %NULL if the element ID could not be found or if
5077  * the element is invalid (claims to be longer than the given
5078  * data) or if the byte array doesn't match, or a pointer to the first
5079  * byte of the requested element, that is the byte containing the
5080  * element ID.
5081  *
5082  * Note: There are no checks on the element length other than
5083  * having to fit into the given data and being large enough for the
5084  * byte array to match.
5085  */
5086 static inline const u8 *
5087 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5088                        const u8 *match, unsigned int match_len,
5089                        unsigned int match_offset)
5090 {
5091         /* match_offset can't be smaller than 2, unless match_len is
5092          * zero, in which case match_offset must be zero as well.
5093          */
5094         if (WARN_ON((match_len && match_offset < 2) ||
5095                     (!match_len && match_offset)))
5096                 return NULL;
5097 
5098         return (void *)cfg80211_find_elem_match(eid, ies, len,
5099                                                 match, match_len,
5100                                                 match_offset ?
5101                                                         match_offset - 2 : 0);
5102 }
5103 
5104 /**
5105  * cfg80211_find_elem - find information element in data
5106  *
5107  * @eid: element ID
5108  * @ies: data consisting of IEs
5109  * @len: length of data
5110  *
5111  * Return: %NULL if the element ID could not be found or if
5112  * the element is invalid (claims to be longer than the given
5113  * data) or if the byte array doesn't match; otherwise return the
5114  * requested element struct.
5115  *
5116  * Note: There are no checks on the element length other than
5117  * having to fit into the given data.
5118  */
5119 static inline const struct element *
5120 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5121 {
5122         return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5123 }
5124 
5125 /**
5126  * cfg80211_find_ie - find information element in data
5127  *
5128  * @eid: element ID
5129  * @ies: data consisting of IEs
5130  * @len: length of data
5131  *
5132  * Return: %NULL if the element ID could not be found or if
5133  * the element is invalid (claims to be longer than the given
5134  * data), or a pointer to the first byte of the requested
5135  * element, that is the byte containing the element ID.
5136  *
5137  * Note: There are no checks on the element length other than
5138  * having to fit into the given data.
5139  */
5140 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5141 {
5142         return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5143 }
5144 
5145 /**
5146  * cfg80211_find_ext_elem - find information element with EID Extension in data
5147  *
5148  * @ext_eid: element ID Extension
5149  * @ies: data consisting of IEs
5150  * @len: length of data
5151  *
5152  * Return: %NULL if the etended element could not be found or if
5153  * the element is invalid (claims to be longer than the given
5154  * data) or if the byte array doesn't match; otherwise return the
5155  * requested element struct.
5156  *
5157  * Note: There are no checks on the element length other than
5158  * having to fit into the given data.
5159  */
5160 static inline const struct element *
5161 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5162 {
5163         return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5164                                         &ext_eid, 1, 0);
5165 }
5166 
5167 /**
5168  * cfg80211_find_ext_ie - find information element with EID Extension in data
5169  *
5170  * @ext_eid: element ID Extension
5171  * @ies: data consisting of IEs
5172  * @len: length of data
5173  *
5174  * Return: %NULL if the extended element ID could not be found or if
5175  * the element is invalid (claims to be longer than the given
5176  * data), or a pointer to the first byte of the requested
5177  * element, that is the byte containing the element ID.
5178  *
5179  * Note: There are no checks on the element length other than
5180  * having to fit into the given data.
5181  */
5182 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5183 {
5184         return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5185                                       &ext_eid, 1, 2);
5186 }
5187 
5188 /**
5189  * cfg80211_find_vendor_elem - find vendor specific information element in data
5190  *
5191  * @oui: vendor OUI
5192  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5193  * @ies: data consisting of IEs
5194  * @len: length of data
5195  *
5196  * Return: %NULL if the vendor specific element ID could not be found or if the
5197  * element is invalid (claims to be longer than the given data); otherwise
5198  * return the element structure for the requested element.
5199  *
5200  * Note: There are no checks on the element length other than having to fit into
5201  * the given data.
5202  */
5203 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5204                                                 const u8 *ies,
5205                                                 unsigned int len);
5206 
5207 /**
5208  * cfg80211_find_vendor_ie - find vendor specific information element in data
5209  *
5210  * @oui: vendor OUI
5211  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5212  * @ies: data consisting of IEs
5213  * @len: length of data
5214  *
5215  * Return: %NULL if the vendor specific element ID could not be found or if the
5216  * element is invalid (claims to be longer than the given data), or a pointer to
5217  * the first byte of the requested element, that is the byte containing the
5218  * element ID.
5219  *
5220  * Note: There are no checks on the element length other than having to fit into
5221  * the given data.
5222  */
5223 static inline const u8 *
5224 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5225                         const u8 *ies, unsigned int len)
5226 {
5227         return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5228 }
5229 
5230 /**
5231  * cfg80211_send_layer2_update - send layer 2 update frame
5232  *
5233  * @dev: network device
5234  * @addr: STA MAC address
5235  *
5236  * Wireless drivers can use this function to update forwarding tables in bridge
5237  * devices upon STA association.
5238  */
5239 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5240 
5241 /**
5242  * DOC: Regulatory enforcement infrastructure
5243  *
5244  * TODO
5245  */
5246 
5247 /**
5248  * regulatory_hint - driver hint to the wireless core a regulatory domain
5249  * @wiphy: the wireless device giving the hint (used only for reporting
5250  *      conflicts)
5251  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5252  *      should be in. If @rd is set this should be NULL. Note that if you
5253  *      set this to NULL you should still set rd->alpha2 to some accepted
5254  *      alpha2.
5255  *
5256  * Wireless drivers can use this function to hint to the wireless core
5257  * what it believes should be the current regulatory domain by
5258  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5259  * domain should be in or by providing a completely build regulatory domain.
5260  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5261  * for a regulatory domain structure for the respective country.
5262  *
5263  * The wiphy must have been registered to cfg80211 prior to this call.
5264  * For cfg80211 drivers this means you must first use wiphy_register(),
5265  * for mac80211 drivers you must first use ieee80211_register_hw().
5266  *
5267  * Drivers should check the return value, its possible you can get
5268  * an -ENOMEM.
5269  *
5270  * Return: 0 on success. -ENOMEM.
5271  */
5272 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5273 
5274 /**
5275  * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5276  * @wiphy: the wireless device we want to process the regulatory domain on
5277  * @rd: the regulatory domain informatoin to use for this wiphy
5278  *
5279  * Set the regulatory domain information for self-managed wiphys, only they
5280  * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5281  * information.
5282  *
5283  * Return: 0 on success. -EINVAL, -EPERM
5284  */
5285 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5286                               struct ieee80211_regdomain *rd);
5287 
5288 /**
5289  * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5290  * @wiphy: the wireless device we want to process the regulatory domain on
5291  * @rd: the regulatory domain information to use for this wiphy
5292  *
5293  * This functions requires the RTNL to be held and applies the new regdomain
5294  * synchronously to this wiphy. For more details see
5295  * regulatory_set_wiphy_regd().
5296  *
5297  * Return: 0 on success. -EINVAL, -EPERM
5298  */
5299 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5300                                         struct ieee80211_regdomain *rd);
5301 
5302 /**
5303  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5304  * @wiphy: the wireless device we want to process the regulatory domain on
5305  * @regd: the custom regulatory domain to use for this wiphy
5306  *
5307  * Drivers can sometimes have custom regulatory domains which do not apply
5308  * to a specific country. Drivers can use this to apply such custom regulatory
5309  * domains. This routine must be called prior to wiphy registration. The
5310  * custom regulatory domain will be trusted completely and as such previous
5311  * default channel settings will be disregarded. If no rule is found for a
5312  * channel on the regulatory domain the channel will be disabled.
5313  * Drivers using this for a wiphy should also set the wiphy flag
5314  * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5315  * that called this helper.
5316  */
5317 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5318                                    const struct ieee80211_regdomain *regd);
5319 
5320 /**
5321  * freq_reg_info - get regulatory information for the given frequency
5322  * @wiphy: the wiphy for which we want to process this rule for
5323  * @center_freq: Frequency in KHz for which we want regulatory information for
5324  *
5325  * Use this function to get the regulatory rule for a specific frequency on
5326  * a given wireless device. If the device has a specific regulatory domain
5327  * it wants to follow we respect that unless a country IE has been received
5328  * and processed already.
5329  *
5330  * Return: A valid pointer, or, when an error occurs, for example if no rule
5331  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5332  * check and PTR_ERR() to obtain the numeric return value. The numeric return
5333  * value will be -ERANGE if we determine the given center_freq does not even
5334  * have a regulatory rule for a frequency range in the center_freq's band.
5335  * See freq_in_rule_band() for our current definition of a band -- this is
5336  * purely subjective and right now it's 802.11 specific.
5337  */
5338 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5339                                                u32 center_freq);
5340 
5341 /**
5342  * reg_initiator_name - map regulatory request initiator enum to name
5343  * @initiator: the regulatory request initiator
5344  *
5345  * You can use this to map the regulatory request initiator enum to a
5346  * proper string representation.
5347  */
5348 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5349 
5350 /**
5351  * DOC: Internal regulatory db functions
5352  *
5353  */
5354 
5355 /**
5356  * reg_query_regdb_wmm -  Query internal regulatory db for wmm rule
5357  * Regulatory self-managed driver can use it to proactively
5358  *
5359  * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5360  * @freq: the freqency(in MHz) to be queried.
5361  * @rule: pointer to store the wmm rule from the regulatory db.
5362  *
5363  * Self-managed wireless drivers can use this function to  query
5364  * the internal regulatory database to check whether the given
5365  * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5366  *
5367  * Drivers should check the return value, its possible you can get
5368  * an -ENODATA.
5369  *
5370  * Return: 0 on success. -ENODATA.
5371  */
5372 int reg_query_regdb_wmm(char *alpha2, int freq,
5373                         struct ieee80211_reg_rule *rule);
5374 
5375 /*
5376  * callbacks for asynchronous cfg80211 methods, notification
5377  * functions and BSS handling helpers
5378  */
5379 
5380 /**
5381  * cfg80211_scan_done - notify that scan finished
5382  *
5383  * @request: the corresponding scan request
5384  * @info: information about the completed scan
5385  */
5386 void cfg80211_scan_done(struct cfg80211_scan_request *request,
5387                         struct cfg80211_scan_info *info);
5388 
5389 /**
5390  * cfg80211_sched_scan_results - notify that new scan results are available
5391  *
5392  * @wiphy: the wiphy which got scheduled scan results
5393  * @reqid: identifier for the related scheduled scan request
5394  */
5395 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
5396 
5397 /**
5398  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5399  *
5400  * @wiphy: the wiphy on which the scheduled scan stopped
5401  * @reqid: identifier for the related scheduled scan request
5402  *
5403  * The driver can call this function to inform cfg80211 that the
5404  * scheduled scan had to be stopped, for whatever reason.  The driver
5405  * is then called back via the sched_scan_stop operation when done.
5406  */
5407 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
5408 
5409 /**
5410  * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5411  *
5412  * @wiphy: the wiphy on which the scheduled scan stopped
5413  * @reqid: identifier for the related scheduled scan request
5414  *
5415  * The driver can call this function to inform cfg80211 that the
5416  * scheduled scan had to be stopped, for whatever reason.  The driver
5417  * is then called back via the sched_scan_stop operation when done.
5418  * This function should be called with rtnl locked.
5419  */
5420 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
5421 
5422 /**
5423  * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5424  * @wiphy: the wiphy reporting the BSS
5425  * @data: the BSS metadata
5426  * @mgmt: the management frame (probe response or beacon)
5427  * @len: length of the management frame
5428  * @gfp: context flags
5429  *
5430  * This informs cfg80211 that BSS information was found and
5431  * the BSS should be updated/added.
5432  *
5433  * Return: A referenced struct, must be released with cfg80211_put_bss()!
5434  * Or %NULL on error.
5435  */
5436 struct cfg80211_bss * __must_check
5437 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
5438                                struct cfg80211_inform_bss *data,
5439                                struct ieee80211_mgmt *mgmt, size_t len,
5440                                gfp_t gfp);
5441 
5442 static inline struct cfg80211_bss * __must_check
5443 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
5444                                 struct ieee80211_channel *rx_channel,
5445                                 enum nl80211_bss_scan_width scan_width,
5446                                 struct ieee80211_mgmt *mgmt, size_t len,
5447                                 s32 signal, gfp_t gfp)
5448 {
5449         struct cfg80211_inform_bss data = {
5450                 .chan = rx_channel,
5451                 .scan_width = scan_width,
5452                 .signal = signal,
5453         };
5454 
5455         return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5456 }
5457 
5458 static inline struct cfg80211_bss * __must_check
5459 cfg80211_inform_bss_frame(struct wiphy *wiphy,
5460                           struct ieee80211_channel *rx_channel,
5461                           struct ieee80211_mgmt *mgmt, size_t len,
5462                           s32 signal, gfp_t gfp)
5463 {
5464         struct cfg80211_inform_bss data = {
5465                 .chan = rx_channel,
5466                 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5467                 .signal = signal,
5468         };
5469 
5470         return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5471 }
5472 
5473 /**
5474  * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5475  * @bssid: transmitter BSSID
5476  * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5477  * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5478  * @new_bssid: calculated nontransmitted BSSID
5479  */
5480 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
5481                                           u8 mbssid_index, u8 *new_bssid)
5482 {
5483         u64 bssid_u64 = ether_addr_to_u64(bssid);
5484         u64 mask = GENMASK_ULL(max_bssid - 1, 0);
5485         u64 new_bssid_u64;
5486 
5487         new_bssid_u64 = bssid_u64 & ~mask;
5488 
5489         new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
5490 
5491         u64_to_ether_addr(new_bssid_u64, new_bssid);
5492 }
5493 
5494 /**
5495  * enum cfg80211_bss_frame_type - frame type that the BSS data came from
5496  * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
5497  *      from a beacon or probe response
5498  * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
5499  * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
5500  */
5501 enum cfg80211_bss_frame_type {
5502         CFG80211_BSS_FTYPE_UNKNOWN,
5503         CFG80211_BSS_FTYPE_BEACON,
5504         CFG80211_BSS_FTYPE_PRESP,
5505 };
5506 
5507 /**
5508  * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
5509  *
5510  * @wiphy: the wiphy reporting the BSS
5511  * @data: the BSS metadata
5512  * @ftype: frame type (if known)
5513  * @bssid: the BSSID of the BSS
5514  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5515  * @capability: the capability field sent by the peer
5516  * @beacon_interval: the beacon interval announced by the peer
5517  * @ie: additional IEs sent by the peer
5518  * @ielen: length of the additional IEs
5519  * @gfp: context flags
5520  *
5521  * This informs cfg80211 that BSS information was found and
5522  * the BSS should be updated/added.
5523  *
5524  * Return: A referenced struct, must be released with cfg80211_put_bss()!
5525  * Or %NULL on error.
5526  */
5527 struct cfg80211_bss * __must_check
5528 cfg80211_inform_bss_data(struct wiphy *wiphy,
5529                          struct cfg80211_inform_bss *data,
5530                          enum cfg80211_bss_frame_type ftype,
5531                          const u8 *bssid, u64 tsf, u16 capability,
5532                          u16 beacon_interval, const u8 *ie, size_t ielen,
5533                          gfp_t gfp);
5534 
5535 static inline struct cfg80211_bss * __must_check
5536 cfg80211_inform_bss_width(struct wiphy *wiphy,
5537                           struct ieee80211_channel *rx_channel,
5538                           enum nl80211_bss_scan_width scan_width,
5539                           enum cfg80211_bss_frame_type ftype,
5540                           const u8 *bssid, u64 tsf, u16 capability,
5541                           u16 beacon_interval, const u8 *ie, size_t ielen,
5542                           s32 signal, gfp_t gfp)
5543 {
5544         struct cfg80211_inform_bss data = {
5545                 .chan = rx_channel,
5546                 .scan_width = scan_width,
5547                 .signal = signal,
5548         };
5549 
5550         return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5551                                         capability, beacon_interval, ie, ielen,
5552                                         gfp);
5553 }
5554 
5555 static inline struct cfg80211_bss * __must_check
5556 cfg80211_inform_bss(struct wiphy *wiphy,
5557                     struct ieee80211_channel *rx_channel,
5558                     enum cfg80211_bss_frame_type ftype,
5559                     const u8 *bssid, u64 tsf, u16 capability,
5560                     u16 beacon_interval, const u8 *ie, size_t ielen,
5561                     s32 signal, gfp_t gfp)
5562 {
5563         struct cfg80211_inform_bss data = {
5564                 .chan = rx_channel,
5565                 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5566                 .signal = signal,
5567         };
5568 
5569         return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5570                                         capability, beacon_interval, ie, ielen,
5571                                         gfp);
5572 }
5573 
5574 /**
5575  * cfg80211_get_bss - get a BSS reference
5576  * @wiphy: the wiphy this BSS struct belongs to
5577  * @channel: the channel to search on (or %NULL)
5578  * @bssid: the desired BSSID (or %NULL)
5579  * @ssid: the desired SSID (or %NULL)
5580  * @ssid_len: length of the SSID (or 0)
5581  * @bss_type: type of BSS, see &enum ieee80211_bss_type
5582  * @privacy: privacy filter, see &enum ieee80211_privacy
5583  */
5584 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
5585                                       struct ieee80211_channel *channel,
5586                                       const u8 *bssid,
5587                                       const u8 *ssid, size_t ssid_len,
5588                                       enum ieee80211_bss_type bss_type,
5589                                       enum ieee80211_privacy privacy);
5590 static inline struct cfg80211_bss *
5591 cfg80211_get_ibss(struct wiphy *wiphy,
5592                   struct ieee80211_channel *channel,
5593                   const u8 *ssid, size_t ssid_len)
5594 {
5595         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
5596                                 IEEE80211_BSS_TYPE_IBSS,
5597                                 IEEE80211_PRIVACY_ANY);
5598 }
5599 
5600 /**
5601  * cfg80211_ref_bss - reference BSS struct
5602  * @wiphy: the wiphy this BSS struct belongs to
5603  * @bss: the BSS struct to reference
5604  *
5605  * Increments the refcount of the given BSS struct.
5606  */
5607 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5608 
5609 /**
5610  * cfg80211_put_bss - unref BSS struct
5611  * @wiphy: the wiphy this BSS struct belongs to
5612  * @bss: the BSS struct
5613  *
5614  * Decrements the refcount of the given BSS struct.
5615  */
5616 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5617 
5618 /**
5619  * cfg80211_unlink_bss - unlink BSS from internal data structures
5620  * @wiphy: the wiphy
5621  * @bss: the bss to remove
5622  *
5623  * This function removes the given BSS from the internal data structures
5624  * thereby making it no longer show up in scan results etc. Use this
5625  * function when you detect a BSS is gone. Normally BSSes will also time
5626  * out, so it is not necessary to use this function at all.
5627  */
5628 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5629 
5630 static inline enum nl80211_bss_scan_width
5631 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5632 {
5633         switch (chandef->width) {
5634         case NL80211_CHAN_WIDTH_5:
5635                 return NL80211_BSS_CHAN_WIDTH_5;
5636         case NL80211_CHAN_WIDTH_10:
5637                 return NL80211_BSS_CHAN_WIDTH_10;
5638         default:
5639                 return NL80211_BSS_CHAN_WIDTH_20;
5640         }
5641 }
5642 
5643 /**
5644  * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5645  * @dev: network device
5646  * @buf: authentication frame (header + body)
5647  * @len: length of the frame data
5648  *
5649  * This function is called whenever an authentication, disassociation or
5650  * deauthentication frame has been received and processed in station mode.
5651  * After being asked to authenticate via cfg80211_ops::auth() the driver must
5652  * call either this function or cfg80211_auth_timeout().
5653  * After being asked to associate via cfg80211_ops::assoc() the driver must
5654  * call either this function or cfg80211_auth_timeout().
5655  * While connected, the driver must calls this for received and processed
5656  * disassociation and deauthentication frames. If the frame couldn't be used
5657  * because it was unprotected, the driver must call the function
5658  * cfg80211_rx_unprot_mlme_mgmt() instead.
5659  *
5660  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5661  */
5662 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5663 
5664 /**
5665  * cfg80211_auth_timeout - notification of timed out authentication
5666  * @dev: network device
5667  * @addr: The MAC address of the device with which the authentication timed out
5668  *
5669  * This function may sleep. The caller must hold the corresponding wdev's
5670  * mutex.
5671  */
5672 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
5673 
5674 /**
5675  * cfg80211_rx_assoc_resp - notification of processed association response
5676  * @dev: network device
5677  * @bss: the BSS that association was requested with, ownership of the pointer
5678  *      moves to cfg80211 in this call
5679  * @buf: (Re)Association Response frame (header + body)
5680  * @len: length of the frame data
5681  * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5682  *      as the AC bitmap in the QoS info field
5683  * @req_ies: information elements from the (Re)Association Request frame
5684  * @req_ies_len: length of req_ies data
5685  *
5686  * After being asked to associate via cfg80211_ops::assoc() the driver must
5687  * call either this function or cfg80211_auth_timeout().
5688  *
5689  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5690  */
5691 void cfg80211_rx_assoc_resp(struct net_device *dev,
5692                             struct cfg80211_bss *bss,
5693                             const u8 *buf, size_t len,
5694                             int uapsd_queues,
5695                             const u8 *req_ies, size_t req_ies_len);
5696 
5697 /**
5698  * cfg80211_assoc_timeout - notification of timed out association
5699  * @dev: network device
5700  * @bss: The BSS entry with which association timed out.
5701  *
5702  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5703  */
5704 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
5705 
5706 /**
5707  * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5708  * @dev: network device
5709  * @bss: The BSS entry with which association was abandoned.
5710  *
5711  * Call this whenever - for reasons reported through other API, like deauth RX,
5712  * an association attempt was abandoned.
5713  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5714  */
5715 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
5716 
5717 /**
5718  * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
5719  * @dev: network device
5720  * @buf: 802.11 frame (header + body)
5721  * @len: length of the frame data
5722  *
5723  * This function is called whenever deauthentication has been processed in
5724  * station mode. This includes both received deauthentication frames and
5725  * locally generated ones. This function may sleep. The caller must hold the
5726  * corresponding wdev's mutex.
5727  */
5728 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5729 
5730 /**
5731  * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
5732  * @dev: network device
5733  * @buf: deauthentication frame (header + body)
5734  * @len: length of the frame data
5735  *
5736  * This function is called whenever a received deauthentication or dissassoc
5737  * frame has been dropped in station mode because of MFP being used but the
5738  * frame was not protected. This function may sleep.
5739  */
5740 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5741                                   const u8 *buf, size_t len);
5742 
5743 /**
5744  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
5745  * @dev: network device
5746  * @addr: The source MAC address of the frame
5747  * @key_type: The key type that the received frame used
5748  * @key_id: Key identifier (0..3). Can be -1 if missing.
5749  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
5750  * @gfp: allocation flags
5751  *
5752  * This function is called whenever the local MAC detects a MIC failure in a
5753  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
5754  * primitive.
5755  */
5756 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
5757                                   enum nl80211_key_type key_type, int key_id,
5758                                   const u8 *tsc, gfp_t gfp);
5759 
5760 /**
5761  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
5762  *
5763  * @dev: network device
5764  * @bssid: the BSSID of the IBSS joined
5765  * @channel: the channel of the IBSS joined
5766  * @gfp: allocation flags
5767  *
5768  * This function notifies cfg80211 that the device joined an IBSS or
5769  * switched to a different BSSID. Before this function can be called,
5770  * either a beacon has to have been received from the IBSS, or one of
5771  * the cfg80211_inform_bss{,_frame} functions must have been called
5772  * with the locally generated beacon -- this guarantees that there is
5773  * always a scan result for this IBSS. cfg80211 will handle the rest.
5774  */
5775 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
5776                           struct ieee80211_channel *channel, gfp_t gfp);
5777 
5778 /**
5779  * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
5780  *
5781  * @dev: network device
5782  * @macaddr: the MAC address of the new candidate
5783  * @ie: information elements advertised by the peer candidate
5784  * @ie_len: length of the information elements buffer
5785  * @gfp: allocation flags
5786  *
5787  * This function notifies cfg80211 that the mesh peer candidate has been
5788  * detected, most likely via a beacon or, less likely, via a probe response.
5789  * cfg80211 then sends a notification to userspace.
5790  */
5791 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
5792                 const u8 *macaddr, const u8 *ie, u8 ie_len,
5793                 int sig_dbm, gfp_t gfp);
5794 
5795 /**
5796  * DOC: RFkill integration
5797  *
5798  * RFkill integration in cfg80211 is almost invisible to drivers,
5799  * as cfg80211 automatically registers an rfkill instance for each
5800  * wireless device it knows about. Soft kill is also translated
5801  * into disconnecting and turning all interfaces off, drivers are
5802  * expected to turn off the device when all interfaces are down.
5803  *
5804  * However, devices may have a hard RFkill line, in which case they
5805  * also need to interact with the rfkill subsystem, via cfg80211.
5806  * They can do this with a few helper functions documented here.
5807  */
5808 
5809 /**
5810  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
5811  * @wiphy: the wiphy
5812  * @blocked: block status
5813  */
5814 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
5815 
5816 /**
5817  * wiphy_rfkill_start_polling - start polling rfkill
5818  * @wiphy: the wiphy
5819  */
5820 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
5821 
5822 /**
5823  * wiphy_rfkill_stop_polling - stop polling rfkill
5824  * @wiphy: the wiphy
5825  */
5826 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
5827 
5828 /**
5829  * DOC: Vendor commands
5830  *
5831  * Occasionally, there are special protocol or firmware features that
5832  * can't be implemented very openly. For this and similar cases, the
5833  * vendor command functionality allows implementing the features with
5834  * (typically closed-source) userspace and firmware, using nl80211 as
5835  * the configuration mechanism.
5836  *
5837  * A driver supporting vendor commands must register them as an array
5838  * in struct wiphy, with handlers for each one, each command has an
5839  * OUI and sub command ID to identify it.
5840  *
5841  * Note that this feature should not be (ab)used to implement protocol
5842  * features that could openly be shared across drivers. In particular,
5843  * it must never be required to use vendor commands to implement any
5844  * "normal" functionality that higher-level userspace like connection
5845  * managers etc. need.
5846  */
5847 
5848 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
5849                                            enum nl80211_commands cmd,
5850                                            enum nl80211_attrs attr,
5851                                            int approxlen);
5852 
5853 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
5854                                            struct wireless_dev *wdev,
5855                                            enum nl80211_commands cmd,
5856                                            enum nl80211_attrs attr,
5857                                            unsigned int portid,
5858                                            int vendor_event_idx,
5859                                            int approxlen, gfp_t gfp);
5860 
5861 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
5862 
5863 /**
5864  * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
5865  * @wiphy: the wiphy
5866  * @approxlen: an upper bound of the length of the data that will
5867  *      be put into the skb
5868  *
5869  * This function allocates and pre-fills an skb for a reply to
5870  * a vendor command. Since it is intended for a reply, calling
5871  * it outside of a vendor command's doit() operation is invalid.
5872  *
5873  * The returned skb is pre-filled with some identifying data in
5874  * a way that any data that is put into the skb (with skb_put(),
5875  * nla_put() or similar) will end up being within the
5876  * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
5877  * with the skb is adding data for the corresponding userspace tool
5878  * which can then read that data out of the vendor data attribute.
5879  * You must not modify the skb in any other way.
5880  *
5881  * When done, call cfg80211_vendor_cmd_reply() with the skb and return
5882  * its error code as the result of the doit() operation.
5883  *
5884  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5885  */
5886 static inline struct sk_buff *
5887 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5888 {
5889         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
5890                                           NL80211_ATTR_VENDOR_DATA, approxlen);
5891 }
5892 
5893 /**
5894  * cfg80211_vendor_cmd_reply - send the reply skb
5895  * @skb: The skb, must have been allocated with
5896  *      cfg80211_vendor_cmd_alloc_reply_skb()
5897  *
5898  * Since calling this function will usually be the last thing
5899  * before returning from the vendor command doit() you should
5900  * return the error code.  Note that this function consumes the
5901  * skb regardless of the return value.
5902  *
5903  * Return: An error code or 0 on success.
5904  */
5905 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
5906 
5907 /**
5908  * cfg80211_vendor_cmd_get_sender
5909  * @wiphy: the wiphy
5910  *
5911  * Return the current netlink port ID in a vendor command handler.
5912  * Valid to call only there.
5913  */
5914 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
5915 
5916 /**
5917  * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
5918  * @wiphy: the wiphy
5919  * @wdev: the wireless device
5920  * @event_idx: index of the vendor event in the wiphy's vendor_events
5921  * @approxlen: an upper bound of the length of the data that will
5922  *      be put into the skb
5923  * @gfp: allocation flags
5924  *
5925  * This function allocates and pre-fills an skb for an event on the
5926  * vendor-specific multicast group.
5927  *
5928  * If wdev != NULL, both the ifindex and identifier of the specified
5929  * wireless device are added to the event message before the vendor data
5930  * attribute.
5931  *
5932  * When done filling the skb, call cfg80211_vendor_event() with the
5933  * skb to send the event.
5934  *
5935  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5936  */
5937 static inline struct sk_buff *
5938 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
5939                              int approxlen, int event_idx, gfp_t gfp)
5940 {
5941         return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
5942                                           NL80211_ATTR_VENDOR_DATA,
5943                                           0, event_idx, approxlen, gfp);
5944 }
5945 
5946 /**
5947  * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
5948  * @wiphy: the wiphy
5949  * @wdev: the wireless device
5950  * @event_idx: index of the vendor event in the wiphy's vendor_events
5951  * @portid: port ID of the receiver
5952  * @approxlen: an upper bound of the length of the data that will
5953  *      be put into the skb
5954  * @gfp: allocation flags
5955  *
5956  * This function allocates and pre-fills an skb for an event to send to
5957  * a specific (userland) socket. This socket would previously have been
5958  * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
5959  * care to register a netlink notifier to see when the socket closes.
5960  *
5961  * If wdev != NULL, both the ifindex and identifier of the specified
5962  * wireless device are added to the event message before the vendor data
5963  * attribute.
5964  *
5965  * When done filling the skb, call cfg80211_vendor_event() with the
5966  * skb to send the event.
5967  *
5968  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5969  */
5970 static inline struct sk_buff *
5971 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
5972                                   struct wireless_dev *wdev,
5973                                   unsigned int portid, int approxlen,
5974                                   int event_idx, gfp_t gfp)
5975 {
5976         return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
5977                                           NL80211_ATTR_VENDOR_DATA,
5978                                           portid, event_idx, approxlen, gfp);
5979 }
5980 
5981 /**
5982  * cfg80211_vendor_event - send the event
5983  * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
5984  * @gfp: allocation flags
5985  *
5986  * This function sends the given @skb, which must have been allocated
5987  * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
5988  */
5989 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
5990 {
5991         __cfg80211_send_event_skb(skb, gfp);
5992 }
5993 
5994 #ifdef CONFIG_NL80211_TESTMODE
5995 /**
5996  * DOC: Test mode
5997  *
5998  * Test mode is a set of utility functions to allow drivers to
5999  * interact with driver-specific tools to aid, for instance,
6000  * factory programming.
6001  *
6002  * This chapter describes how drivers interact with it, for more
6003  * information see the nl80211 book's chapter on it.
6004  */
6005 
6006 /**
6007  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6008  * @wiphy: the wiphy
6009  * @approxlen: an upper bound of the length of the data that will
6010  *      be put into the skb
6011  *
6012  * This function allocates and pre-fills an skb for a reply to
6013  * the testmode command. Since it is intended for a reply, calling
6014  * it outside of the @testmode_cmd operation is invalid.
6015  *
6016  * The returned skb is pre-filled with the wiphy index and set up in
6017  * a way that any data that is put into the skb (with skb_put(),
6018  * nla_put() or similar) will end up being within the
6019  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6020  * with the skb is adding data for the corresponding userspace tool
6021  * which can then read that data out of the testdata attribute. You
6022  * must not modify the skb in any other way.
6023  *
6024  * When done, call cfg80211_testmode_reply() with the skb and return
6025  * its error code as the result of the @testmode_cmd operation.
6026  *
6027  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6028  */
6029 static inline struct sk_buff *
6030 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6031 {
6032         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6033                                           NL80211_ATTR_TESTDATA, approxlen);
6034 }
6035 
6036 /**
6037  * cfg80211_testmode_reply - send the reply skb
6038  * @skb: The skb, must have been allocated with
6039  *      cfg80211_testmode_alloc_reply_skb()
6040  *
6041  * Since calling this function will usually be the last thing
6042  * before returning from the @testmode_cmd you should return
6043  * the error code.  Note that this function consumes the skb
6044  * regardless of the return value.
6045  *
6046  * Return: An error code or 0 on success.
6047  */
6048 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6049 {
6050         return cfg80211_vendor_cmd_reply(skb);
6051 }
6052 
6053 /**
6054  * cfg80211_testmode_alloc_event_skb - allocate testmode event
6055  * @wiphy: the wiphy
6056  * @approxlen: an upper bound of the length of the data that will
6057  *      be put into the skb
6058  * @gfp: allocation flags
6059  *
6060  * This function allocates and pre-fills an skb for an event on the
6061  * testmode multicast group.
6062  *
6063  * The returned skb is set up in the same way as with
6064  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6065  * there, you should simply add data to it that will then end up in the
6066  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6067  * in any other way.
6068  *
6069  * When done filling the skb, call cfg80211_testmode_event() with the
6070  * skb to send the event.
6071  *
6072  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6073  */
6074 static inline struct sk_buff *
6075 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6076 {
6077         return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6078                                           NL80211_ATTR_TESTDATA, 0, -1,
6079                                           approxlen, gfp);
6080 }
6081 
6082 /**
6083  * cfg80211_testmode_event - send the event
6084  * @skb: The skb, must have been allocated with
6085  *      cfg80211_testmode_alloc_event_skb()
6086  * @gfp: allocation flags
6087  *
6088  * This function sends the given @skb, which must have been allocated
6089  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6090  * consumes it.
6091  */
6092 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6093 {
6094         __cfg80211_send_event_skb(skb, gfp);
6095 }
6096 
6097 #define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
6098 #define CFG80211_TESTMODE_DUMP(cmd)     .testmode_dump = (cmd),
6099 #else
6100 #define CFG80211_TESTMODE_CMD(cmd)
6101 #define CFG80211_TESTMODE_DUMP(cmd)
6102 #endif
6103 
6104 /**
6105  * struct cfg80211_fils_resp_params - FILS connection response params
6106  * @kek: KEK derived from a successful FILS connection (may be %NULL)
6107  * @kek_len: Length of @fils_kek in octets
6108  * @update_erp_next_seq_num: Boolean value to specify whether the value in
6109  *      @erp_next_seq_num is valid.
6110  * @erp_next_seq_num: The next sequence number to use in ERP message in
6111  *      FILS Authentication. This value should be specified irrespective of the
6112  *      status for a FILS connection.
6113  * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6114  * @pmk_len: Length of @pmk in octets
6115  * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6116  *      used for this FILS connection (may be %NULL).
6117  */
6118 struct cfg80211_fils_resp_params {
6119         const u8 *kek;
6120         size_t kek_len;
6121         bool update_erp_next_seq_num;
6122         u16 erp_next_seq_num;
6123         const u8 *pmk;
6124         size_t pmk_len;
6125         const u8 *pmkid;
6126 };
6127 
6128 /**
6129  * struct cfg80211_connect_resp_params - Connection response params
6130  * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6131  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6132  *      the real status code for failures. If this call is used to report a
6133  *      failure due to a timeout (e.g., not receiving an Authentication frame
6134  *      from the AP) instead of an explicit rejection by the AP, -1 is used to
6135  *      indicate that this is a failure, but without a status code.
6136  *      @timeout_reason is used to report the reason for the timeout in that
6137  *      case.
6138  * @bssid: The BSSID of the AP (may be %NULL)
6139  * @bss: Entry of bss to which STA got connected to, can be obtained through
6140  *      cfg80211_get_bss() (may be %NULL). Only one parameter among @bssid and
6141  *      @bss needs to be specified.
6142  * @req_ie: Association request IEs (may be %NULL)
6143  * @req_ie_len: Association request IEs length
6144  * @resp_ie: Association response IEs (may be %NULL)
6145  * @resp_ie_len: Association response IEs length
6146  * @fils: FILS connection response parameters.
6147  * @timeout_reason: Reason for connection timeout. This is used when the
6148  *      connection fails due to a timeout instead of an explicit rejection from
6149  *      the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6150  *      not known. This value is used only if @status < 0 to indicate that the
6151  *      failure is due to a timeout and not due to explicit rejection by the AP.
6152  *      This value is ignored in other cases (@status >= 0).
6153  */
6154 struct cfg80211_connect_resp_params {
6155         int status;
6156         const u8 *bssid;
6157         struct cfg80211_bss *bss;
6158         const u8 *req_ie;
6159         size_t req_ie_len;
6160         const u8 *resp_ie;
6161         size_t resp_ie_len;
6162         struct cfg80211_fils_resp_params fils;
6163         enum nl80211_timeout_reason timeout_reason;
6164 };
6165 
6166 /**
6167  * cfg80211_connect_done - notify cfg80211 of connection result
6168  *
6169  * @dev: network device
6170  * @params: connection response parameters
6171  * @gfp: allocation flags
6172  *
6173  * It should be called by the underlying driver once execution of the connection
6174  * request from connect() has been completed. This is similar to
6175  * cfg80211_connect_bss(), but takes a structure pointer for connection response
6176  * parameters. Only one of the functions among cfg80211_connect_bss(),
6177  * cfg80211_connect_result(), cfg80211_connect_timeout(),
6178  * and cfg80211_connect_done() should be called.
6179  */
6180 void cfg80211_connect_done(struct net_device *dev,
6181                            struct cfg80211_connect_resp_params *params,
6182                            gfp_t gfp);
6183 
6184 /**
6185  * cfg80211_connect_bss - notify cfg80211 of connection result
6186  *
6187  * @dev: network device
6188  * @bssid: the BSSID of the AP
6189  * @bss: entry of bss to which STA got connected to, can be obtained
6190  *      through cfg80211_get_bss (may be %NULL)
6191  * @req_ie: association request IEs (maybe be %NULL)
6192  * @req_ie_len: association request IEs length
6193  * @resp_ie: association response IEs (may be %NULL)
6194  * @resp_ie_len: assoc response IEs length
6195  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6196  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6197  *      the real status code for failures. If this call is used to report a
6198  *      failure due to a timeout (e.g., not receiving an Authentication frame
6199  *      from the AP) instead of an explicit rejection by the AP, -1 is used to
6200  *      indicate that this is a failure, but without a status code.
6201  *      @timeout_reason is used to report the reason for the timeout in that
6202  *      case.
6203  * @gfp: allocation flags
6204  * @timeout_reason: reason for connection timeout. This is used when the
6205  *      connection fails due to a timeout instead of an explicit rejection from
6206  *      the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6207  *      not known. This value is used only if @status < 0 to indicate that the
6208  *      failure is due to a timeout and not due to explicit rejection by the AP.
6209  *      This value is ignored in other cases (@status >= 0).
6210  *
6211  * It should be called by the underlying driver once execution of the connection
6212  * request from connect() has been completed. This is similar to
6213  * cfg80211_connect_result(), but with the option of identifying the exact bss
6214  * entry for the connection. Only one of the functions among
6215  * cfg80211_connect_bss(), cfg80211_connect_result(),
6216  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6217  */
6218 static inline void
6219 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6220                      struct cfg80211_bss *bss, const u8 *req_ie,
6221                      size_t req_ie_len, const u8 *resp_ie,
6222                      size_t resp_ie_len, int status, gfp_t gfp,
6223                      enum nl80211_timeout_reason timeout_reason)
6224 {
6225         struct cfg80211_connect_resp_params params;
6226 
6227         memset(&params, 0, sizeof(params));
6228         params.status = status;
6229         params.bssid = bssid;
6230         params.bss = bss;
6231         params.req_ie = req_ie;
6232         params.req_ie_len = req_ie_len;
6233         params.resp_ie = resp_ie;
6234         params.resp_ie_len = resp_ie_len;
6235         params.timeout_reason = timeout_reason;
6236 
6237         cfg80211_connect_done(dev, &params, gfp);
6238 }
6239 
6240 /**
6241  * cfg80211_connect_result - notify cfg80211 of connection result
6242  *
6243  * @dev: network device
6244  * @bssid: the BSSID of the AP
6245  * @req_ie: association request IEs (maybe be %NULL)
6246  * @req_ie_len: association request IEs length
6247  * @resp_ie: association response IEs (may be %NULL)
6248  * @resp_ie_len: assoc response IEs length
6249  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6250  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6251  *      the real status code for failures.
6252  * @gfp: allocation flags
6253  *
6254  * It should be called by the underlying driver once execution of the connection
6255  * request from connect() has been completed. This is similar to
6256  * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6257  * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6258  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6259  */
6260 static inline void
6261 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6262                         const u8 *req_ie, size_t req_ie_len,
6263                         const u8 *resp_ie, size_t resp_ie_len,
6264                         u16 status, gfp_t gfp)
6265 {
6266         cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6267                              resp_ie_len, status, gfp,
6268                              NL80211_TIMEOUT_UNSPECIFIED);
6269 }
6270 
6271 /**
6272  * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6273  *
6274  * @dev: network device
6275  * @bssid: the BSSID of the AP
6276  * @req_ie: association request IEs (maybe be %NULL)
6277  * @req_ie_len: association request IEs length
6278  * @gfp: allocation flags
6279  * @timeout_reason: reason for connection timeout.
6280  *
6281  * It should be called by the underlying driver whenever connect() has failed
6282  * in a sequence where no explicit authentication/association rejection was
6283  * received from the AP. This could happen, e.g., due to not being able to send
6284  * out the Authentication or Association Request frame or timing out while
6285  * waiting for the response. Only one of the functions among
6286  * cfg80211_connect_bss(), cfg80211_connect_result(),
6287  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6288  */
6289 static inline void
6290 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6291                          const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6292                          enum nl80211_timeout_reason timeout_reason)
6293 {
6294         cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6295                              gfp, timeout_reason);
6296 }
6297 
6298 /**
6299  * struct cfg80211_roam_info - driver initiated roaming information
6300  *
6301  * @channel: the channel of the new AP
6302  * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6303  * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6304  * @req_ie: association request IEs (maybe be %NULL)
6305  * @req_ie_len: association request IEs length
6306  * @resp_ie: association response IEs (may be %NULL)
6307  * @resp_ie_len: assoc response IEs length
6308  * @fils: FILS related roaming information.
6309  */
6310 struct cfg80211_roam_info {
6311         struct ieee80211_channel *channel;
6312         struct cfg80211_bss *bss;
6313         const u8 *bssid;
6314         const u8 *req_ie;
6315         size_t req_ie_len;
6316         const u8 *resp_ie;
6317         size_t resp_ie_len;
6318         struct cfg80211_fils_resp_params fils;
6319 };
6320 
6321 /**
6322  * cfg80211_roamed - notify cfg80211 of roaming
6323  *
6324  * @dev: network device
6325  * @info: information about the new BSS. struct &cfg80211_roam_info.
6326  * @gfp: allocation flags
6327  *
6328  * This function may be called with the driver passing either the BSSID of the
6329  * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6330  * It should be called by the underlying driver whenever it roamed from one AP
6331  * to another while connected. Drivers which have roaming implemented in
6332  * firmware should pass the bss entry to avoid a race in bss entry timeout where
6333  * the bss entry of the new AP is seen in the driver, but gets timed out by the
6334  * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6335  * rdev->event_work. In case of any failures, the reference is released
6336  * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6337  * released while diconneting from the current bss.
6338  */
6339 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
6340                      gfp_t gfp);
6341 
6342 /**
6343  * cfg80211_port_authorized - notify cfg80211 of successful security association
6344  *
6345  * @dev: network device
6346  * @bssid: the BSSID of the AP
6347  * @gfp: allocation flags
6348  *
6349  * This function should be called by a driver that supports 4 way handshake
6350  * offload after a security association was successfully established (i.e.,
6351  * the 4 way handshake was completed successfully). The call to this function
6352  * should be preceded with a call to cfg80211_connect_result(),
6353  * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6354  * indicate the 802.11 association.
6355  */
6356 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
6357                               gfp_t gfp);
6358 
6359 /**
6360  * cfg80211_disconnected - notify cfg80211 that connection was dropped
6361  *
6362  * @dev: network device
6363  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6364  * @ie_len: length of IEs
6365  * @reason: reason code for the disconnection, set it to 0 if unknown
6366  * @locally_generated: disconnection was requested locally
6367  * @gfp: allocation flags
6368  *
6369  * After it calls this function, the driver should enter an idle state
6370  * and not try to connect to any AP any more.
6371  */
6372 void cfg80211_disconnected(struct net_device *dev, u16 reason,
6373                            const u8 *ie, size_t ie_len,
6374                            bool locally_generated, gfp_t gfp);
6375 
6376 /**
6377  * cfg80211_ready_on_channel - notification of remain_on_channel start
6378  * @wdev: wireless device
6379  * @cookie: the request cookie
6380  * @chan: The current channel (from remain_on_channel request)
6381  * @duration: Duration in milliseconds that the driver intents to remain on the
6382  *      channel
6383  * @gfp: allocation flags
6384  */
6385 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
6386                                struct ieee80211_channel *chan,
6387                                unsigned int duration, gfp_t gfp);
6388 
6389 /**
6390  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6391  * @wdev: wireless device
6392  * @cookie: the request cookie
6393  * @chan: The current channel (from remain_on_channel request)
6394  * @gfp: allocation flags
6395  */
6396 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
6397                                         struct ieee80211_channel *chan,
6398                                         gfp_t gfp);
6399 
6400 /**
6401  * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6402  *
6403  * @sinfo: the station information
6404  * @gfp: allocation flags
6405  */
6406 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
6407 
6408 /**
6409  * cfg80211_sinfo_release_content - release contents of station info
6410  * @sinfo: the station information
6411  *
6412  * Releases any potentially allocated sub-information of the station
6413  * information, but not the struct itself (since it's typically on
6414  * the stack.)
6415  */
6416 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
6417 {
6418         kfree(sinfo->pertid);
6419 }
6420 
6421 /**
6422  * cfg80211_new_sta - notify userspace about station
6423  *
6424  * @dev: the netdev
6425  * @mac_addr: the station's address
6426  * @sinfo: the station information
6427  * @gfp: allocation flags
6428  */
6429 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
6430                       struct station_info *sinfo, gfp_t gfp);
6431 
6432 /**
6433  * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6434  * @dev: the netdev
6435  * @mac_addr: the station's address
6436  * @sinfo: the station information/statistics
6437  * @gfp: allocation flags
6438  */
6439 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
6440                             struct station_info *sinfo, gfp_t gfp);
6441 
6442 /**
6443  * cfg80211_del_sta - notify userspace about deletion of a station
6444  *
6445  * @dev: the netdev
6446  * @mac_addr: the station's address
6447  * @gfp: allocation flags
6448  */
6449 static inline void cfg80211_del_sta(struct net_device *dev,
6450                                     const u8 *mac_addr, gfp_t gfp)
6451 {
6452         cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
6453 }
6454 
6455 /**
6456  * cfg80211_conn_failed - connection request failed notification
6457  *
6458  * @dev: the netdev
6459  * @mac_addr: the station's address
6460  * @reason: the reason for connection failure
6461  * @gfp: allocation flags
6462  *
6463  * Whenever a station tries to connect to an AP and if the station
6464  * could not connect to the AP as the AP has rejected the connection
6465  * for some reasons, this function is called.
6466  *
6467  * The reason for connection failure can be any of the value from
6468  * nl80211_connect_failed_reason enum
6469  */
6470 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
6471                           enum nl80211_connect_failed_reason reason,
6472                           gfp_t gfp);
6473 
6474 /**
6475  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
6476  * @wdev: wireless device receiving the frame
6477  * @freq: Frequency on which the frame was received in MHz
6478  * @sig_dbm: signal strength in dBm, or 0 if unknown
6479  * @buf: Management frame (header + body)
6480  * @len: length of the frame data
6481  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
6482  *
6483  * This function is called whenever an Action frame is received for a station
6484  * mode interface, but is not processed in kernel.
6485  *
6486  * Return: %true if a user space application has registered for this frame.
6487  * For action frames, that makes it responsible for rejecting unrecognized
6488  * action frames; %false otherwise, in which case for action frames the
6489  * driver is responsible for rejecting the frame.
6490  */
6491 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
6492                       const u8 *buf, size_t len, u32 flags);
6493 
6494 /**
6495  * cfg80211_mgmt_tx_status - notification of TX status for management frame
6496  * @wdev: wireless device receiving the frame
6497  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
6498  * @buf: Management frame (header + body)
6499  * @len: length of the frame data
6500  * @ack: Whether frame was acknowledged
6501  * @gfp: context flags
6502  *
6503  * This function is called whenever a management frame was requested to be
6504  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
6505  * transmission attempt.
6506  */
6507 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
6508                              const u8 *buf, size_t len, bool ack, gfp_t gfp);
6509 
6510 
6511 /**
6512  * cfg80211_rx_control_port - notification about a received control port frame
6513  * @dev: The device the frame matched to
6514  * @skb: The skbuf with the control port frame.  It is assumed that the skbuf
6515  *      is 802.3 formatted (with 802.3 header).  The skb can be non-linear.
6516  *      This function does not take ownership of the skb, so the caller is
6517  *      responsible for any cleanup.  The caller must also ensure that
6518  *      skb->protocol is set appropriately.
6519  * @unencrypted: Whether the frame was received unencrypted
6520  *
6521  * This function is used to inform userspace about a received control port
6522  * frame.  It should only be used if userspace indicated it wants to receive
6523  * control port frames over nl80211.
6524  *
6525  * The frame is the data portion of the 802.3 or 802.11 data frame with all
6526  * network layer headers removed (e.g. the raw EAPoL frame).
6527  *
6528  * Return: %true if the frame was passed to userspace
6529  */
6530 bool cfg80211_rx_control_port(struct net_device *dev,
6531                               struct sk_buff *skb, bool unencrypted);
6532 
6533 /**
6534  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
6535  * @dev: network device
6536  * @rssi_event: the triggered RSSI event
6537  * @rssi_level: new RSSI level value or 0 if not available
6538  * @gfp: context flags
6539  *
6540  * This function is called when a configured connection quality monitoring
6541  * rssi threshold reached event occurs.
6542  */
6543 void cfg80211_cqm_rssi_notify(struct net_device *dev,
6544                               enum nl80211_cqm_rssi_threshold_event rssi_event,
6545                               s32 rssi_level, gfp_t gfp);
6546 
6547 /**
6548  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
6549  * @dev: network device
6550  * @peer: peer's MAC address
6551  * @num_packets: how many packets were lost -- should be a fixed threshold
6552  *      but probably no less than maybe 50, or maybe a throughput dependent
6553  *      threshold (to account for temporary interference)
6554  * @gfp: context flags
6555  */
6556 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
6557                                  const u8 *peer, u32 num_packets, gfp_t gfp);
6558 
6559 /**
6560  * cfg80211_cqm_txe_notify - TX error rate event
6561  * @dev: network device
6562  * @peer: peer's MAC address
6563  * @num_packets: how many packets were lost
6564  * @rate: % of packets which failed transmission
6565  * @intvl: interval (in s) over which the TX failure threshold was breached.
6566  * @gfp: context flags
6567  *
6568  * Notify userspace when configured % TX failures over number of packets in a
6569  * given interval is exceeded.
6570  */
6571 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
6572                              u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
6573 
6574 /**
6575  * cfg80211_cqm_beacon_loss_notify - beacon loss event
6576  * @dev: network device
6577  * @gfp: context flags
6578  *
6579  * Notify userspace about beacon loss from the connected AP.
6580  */
6581 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
6582 
6583 /**
6584  * cfg80211_radar_event - radar detection event
6585  * @wiphy: the wiphy
6586  * @chandef: chandef for the current channel
6587  * @gfp: context flags
6588  *
6589  * This function is called when a radar is detected on the current chanenl.
6590  */
6591 void cfg80211_radar_event(struct wiphy *wiphy,
6592                           struct cfg80211_chan_def *chandef, gfp_t gfp);
6593 
6594 /**
6595  * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6596  * @dev: network device
6597  * @mac: MAC address of a station which opmode got modified
6598  * @sta_opmode: station's current opmode value
6599  * @gfp: context flags
6600  *
6601  * Driver should call this function when station's opmode modified via action
6602  * frame.
6603  */
6604 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
6605                                        struct sta_opmode_info *sta_opmode,
6606                                        gfp_t gfp);
6607 
6608 /**
6609  * cfg80211_cac_event - Channel availability check (CAC) event
6610  * @netdev: network device
6611  * @chandef: chandef for the current channel
6612  * @event: type of event
6613  * @gfp: context flags
6614  *
6615  * This function is called when a Channel availability check (CAC) is finished
6616  * or aborted. This must be called to notify the completion of a CAC process,
6617  * also by full-MAC drivers.
6618  */
6619 void cfg80211_cac_event(struct net_device *netdev,
6620                         const struct cfg80211_chan_def *chandef,
6621                         enum nl80211_radar_event event, gfp_t gfp);
6622 
6623 
6624 /**
6625  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6626  * @dev: network device
6627  * @bssid: BSSID of AP (to avoid races)
6628  * @replay_ctr: new replay counter
6629  * @gfp: allocation flags
6630  */
6631 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
6632                                const u8 *replay_ctr, gfp_t gfp);
6633 
6634 /**
6635  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
6636  * @dev: network device
6637  * @index: candidate index (the smaller the index, the higher the priority)
6638  * @bssid: BSSID of AP
6639  * @preauth: Whether AP advertises support for RSN pre-authentication
6640  * @gfp: allocation flags
6641  */
6642 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
6643                                      const u8 *bssid, bool preauth, gfp_t gfp);
6644 
6645 /**
6646  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
6647  * @dev: The device the frame matched to
6648  * @addr: the transmitter address
6649  * @gfp: context flags
6650  *
6651  * This function is used in AP mode (only!) to inform userspace that
6652  * a spurious class 3 frame was received, to be able to deauth the
6653  * sender.
6654  * Return: %true if the frame was passed to userspace (or this failed
6655  * for a reason other than not having a subscription.)
6656  */
6657 bool cfg80211_rx_spurious_frame(struct net_device *dev,
6658                                 const u8 *addr, gfp_t gfp);
6659 
6660 /**
6661  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
6662  * @dev: The device the frame matched to
6663  * @addr: the transmitter address
6664  * @gfp: context flags
6665  *
6666  * This function is used in AP mode (only!) to inform userspace that
6667  * an associated station sent a 4addr frame but that wasn't expected.
6668  * It is allowed and desirable to send this event only once for each
6669  * station to avoid event flooding.
6670  * Return: %true if the frame was passed to userspace (or this failed
6671  * for a reason other than not having a subscription.)
6672  */
6673 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
6674                                         const u8 *addr, gfp_t gfp);
6675 
6676 /**
6677  * cfg80211_probe_status - notify userspace about probe status
6678  * @dev: the device the probe was sent on
6679  * @addr: the address of the peer
6680  * @cookie: the cookie filled in @probe_client previously
6681  * @acked: indicates whether probe was acked or not
6682  * @ack_signal: signal strength (in dBm) of the ACK frame.
6683  * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6684  * @gfp: allocation flags
6685  */
6686 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
6687                            u64 cookie, bool acked, s32 ack_signal,
6688                            bool is_valid_ack_signal, gfp_t gfp);
6689 
6690 /**
6691  * cfg80211_report_obss_beacon - report beacon from other APs
6692  * @wiphy: The wiphy that received the beacon
6693  * @frame: the frame
6694  * @len: length of the frame
6695  * @freq: frequency the frame was received on
6696  * @sig_dbm: signal strength in dBm, or 0 if unknown
6697  *
6698  * Use this function to report to userspace when a beacon was
6699  * received. It is not useful to call this when there is no
6700  * netdev that is in AP/GO mode.
6701  */
6702 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
6703                                  const u8 *frame, size_t len,
6704                                  int freq, int sig_dbm);
6705 
6706 /**
6707  * cfg80211_reg_can_beacon - check if beaconing is allowed
6708  * @wiphy: the wiphy
6709  * @chandef: the channel definition
6710  * @iftype: interface type
6711  *
6712  * Return: %true if there is no secondary channel or the secondary channel(s)
6713  * can be used for beaconing (i.e. is not a radar channel etc.)
6714  */
6715 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
6716                              struct cfg80211_chan_def *chandef,
6717                              enum nl80211_iftype iftype);
6718 
6719 /**
6720  * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
6721  * @wiphy: the wiphy
6722  * @chandef: the channel definition
6723  * @iftype: interface type
6724  *
6725  * Return: %true if there is no secondary channel or the secondary channel(s)
6726  * can be used for beaconing (i.e. is not a radar channel etc.). This version
6727  * also checks if IR-relaxation conditions apply, to allow beaconing under
6728  * more permissive conditions.
6729  *
6730  * Requires the RTNL to be held.
6731  */
6732 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
6733                                    struct cfg80211_chan_def *chandef,
6734                                    enum nl80211_iftype iftype);
6735 
6736 /*
6737  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
6738  * @dev: the device which switched channels
6739  * @chandef: the new channel definition
6740  *
6741  * Caller must acquire wdev_lock, therefore must only be called from sleepable
6742  * driver context!
6743  */
6744 void cfg80211_ch_switch_notify(struct net_device *dev,
6745                                struct cfg80211_chan_def *chandef);
6746 
6747 /*
6748  * cfg80211_ch_switch_started_notify - notify channel switch start
6749  * @dev: the device on which the channel switch started
6750  * @chandef: the future channel definition
6751  * @count: the number of TBTTs until the channel switch happens
6752  *
6753  * Inform the userspace about the channel switch that has just
6754  * started, so that it can take appropriate actions (eg. starting
6755  * channel switch on other vifs), if necessary.
6756  */
6757 void cfg80211_ch_switch_started_notify(struct net_device *dev,
6758                                        struct cfg80211_chan_def *chandef,
6759                                        u8 count);
6760 
6761 /**
6762  * ieee80211_operating_class_to_band - convert operating class to band
6763  *
6764  * @operating_class: the operating class to convert
6765  * @band: band pointer to fill
6766  *
6767  * Returns %true if the conversion was successful, %false otherwise.
6768  */
6769 bool ieee80211_operating_class_to_band(u8 operating_class,
6770                                        enum nl80211_band *band);
6771 
6772 /**
6773  * ieee80211_chandef_to_operating_class - convert chandef to operation class
6774  *
6775  * @chandef: the chandef to convert
6776  * @op_class: a pointer to the resulting operating class
6777  *
6778  * Returns %true if the conversion was successful, %false otherwise.
6779  */
6780 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
6781                                           u8 *op_class);
6782 
6783 /*
6784  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
6785  * @dev: the device on which the operation is requested
6786  * @peer: the MAC address of the peer device
6787  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
6788  *      NL80211_TDLS_TEARDOWN)
6789  * @reason_code: the reason code for teardown request
6790  * @gfp: allocation flags
6791  *
6792  * This function is used to request userspace to perform TDLS operation that
6793  * requires knowledge of keys, i.e., link setup or teardown when the AP
6794  * connection uses encryption. This is optional mechanism for the driver to use
6795  * if it can automatically determine when a TDLS link could be useful (e.g.,
6796  * based on traffic and signal strength for a peer).
6797  */
6798 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
6799                                 enum nl80211_tdls_operation oper,
6800                                 u16 reason_code, gfp_t gfp);
6801 
6802 /*
6803  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
6804  * @rate: given rate_info to calculate bitrate from
6805  *
6806  * return 0 if MCS index >= 32
6807  */
6808 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
6809 
6810 /**
6811  * cfg80211_unregister_wdev - remove the given wdev
6812  * @wdev: struct wireless_dev to remove
6813  *
6814  * Call this function only for wdevs that have no netdev assigned,
6815  * e.g. P2P Devices. It removes the device from the list so that
6816  * it can no longer be used. It is necessary to call this function
6817  * even when cfg80211 requests the removal of the interface by
6818  * calling the del_virtual_intf() callback. The function must also
6819  * be called when the driver wishes to unregister the wdev, e.g.
6820  * when the device is unbound from the driver.
6821  *
6822  * Requires the RTNL to be held.
6823  */
6824 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
6825 
6826 /**
6827  * struct cfg80211_ft_event - FT Information Elements
6828  * @ies: FT IEs
6829  * @ies_len: length of the FT IE in bytes
6830  * @target_ap: target AP's MAC address
6831  * @ric_ies: RIC IE
6832  * @ric_ies_len: length of the RIC IE in bytes
6833  */
6834 struct cfg80211_ft_event_params {
6835         const u8 *ies;
6836         size_t ies_len;
6837         const u8 *target_ap;
6838         const u8 *ric_ies;
6839         size_t ric_ies_len;
6840 };
6841 
6842 /**
6843  * cfg80211_ft_event - notify userspace about FT IE and RIC IE
6844  * @netdev: network device
6845  * @ft_event: IE information
6846  */
6847 void cfg80211_ft_event(struct net_device *netdev,
6848                        struct cfg80211_ft_event_params *ft_event);
6849 
6850 /**
6851  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
6852  * @ies: the input IE buffer
6853  * @len: the input length
6854  * @attr: the attribute ID to find
6855  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
6856  *      if the function is only called to get the needed buffer size
6857  * @bufsize: size of the output buffer
6858  *
6859  * The function finds a given P2P attribute in the (vendor) IEs and
6860  * copies its contents to the given buffer.
6861  *
6862  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
6863  * malformed or the attribute can't be found (respectively), or the
6864  * length of the found attribute (which can be zero).
6865  */
6866 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
6867                           enum ieee80211_p2p_attr_id attr,
6868                           u8 *buf, unsigned int bufsize);
6869 
6870 /**
6871  * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
6872  * @ies: the IE buffer
6873  * @ielen: the length of the IE buffer
6874  * @ids: an array with element IDs that are allowed before
6875  *      the split. A WLAN_EID_EXTENSION value means that the next
6876  *      EID in the list is a sub-element of the EXTENSION IE.
6877  * @n_ids: the size of the element ID array
6878  * @after_ric: array IE types that come after the RIC element
6879  * @n_after_ric: size of the @after_ric array
6880  * @offset: offset where to start splitting in the buffer
6881  *
6882  * This function splits an IE buffer by updating the @offset
6883  * variable to point to the location where the buffer should be
6884  * split.
6885  *
6886  * It assumes that the given IE buffer is well-formed, this
6887  * has to be guaranteed by the caller!
6888  *
6889  * It also assumes that the IEs in the buffer are ordered
6890  * correctly, if not the result of using this function will not
6891  * be ordered correctly either, i.e. it does no reordering.
6892  *
6893  * The function returns the offset where the next part of the
6894  * buffer starts, which may be @ielen if the entire (remainder)
6895  * of the buffer should be used.
6896  */
6897 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
6898                               const u8 *ids, int n_ids,
6899                               const u8 *after_ric, int n_after_ric,
6900                               size_t offset);
6901 
6902 /**
6903  * ieee80211_ie_split - split an IE buffer according to ordering
6904  * @ies: the IE buffer
6905  * @ielen: the length of the IE buffer
6906  * @ids: an array with element IDs that are allowed before
6907  *      the split. A WLAN_EID_EXTENSION value means that the next
6908  *      EID in the list is a sub-element of the EXTENSION IE.
6909  * @n_ids: the size of the element ID array
6910  * @offset: offset where to start splitting in the buffer
6911  *
6912  * This function splits an IE buffer by updating the @offset
6913  * variable to point to the location where the buffer should be
6914  * split.
6915  *
6916  * It assumes that the given IE buffer is well-formed, this
6917  * has to be guaranteed by the caller!
6918  *
6919  * It also assumes that the IEs in the buffer are ordered
6920  * correctly, if not the result of using this function will not
6921  * be ordered correctly either, i.e. it does no reordering.
6922  *
6923  * The function returns the offset where the next part of the
6924  * buffer starts, which may be @ielen if the entire (remainder)
6925  * of the buffer should be used.
6926  */
6927 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
6928                                         const u8 *ids, int n_ids, size_t offset)
6929 {
6930         return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
6931 }
6932 
6933 /**
6934  * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
6935  * @wdev: the wireless device reporting the wakeup
6936  * @wakeup: the wakeup report
6937  * @gfp: allocation flags
6938  *
6939  * This function reports that the given device woke up. If it
6940  * caused the wakeup, report the reason(s), otherwise you may
6941  * pass %NULL as the @wakeup parameter to advertise that something
6942  * else caused the wakeup.
6943  */
6944 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
6945                                    struct cfg80211_wowlan_wakeup *wakeup,
6946                                    gfp_t gfp);
6947 
6948 /**
6949  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
6950  *
6951  * @wdev: the wireless device for which critical protocol is stopped.
6952  * @gfp: allocation flags
6953  *
6954  * This function can be called by the driver to indicate it has reverted
6955  * operation back to normal. One reason could be that the duration given
6956  * by .crit_proto_start() has expired.
6957  */
6958 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
6959 
6960 /**
6961  * ieee80211_get_num_supported_channels - get number of channels device has
6962  * @wiphy: the wiphy
6963  *
6964  * Return: the number of channels supported by the device.
6965  */
6966 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
6967 
6968 /**
6969  * cfg80211_check_combinations - check interface combinations
6970  *
6971  * @wiphy: the wiphy
6972  * @params: the interface combinations parameter
6973  *
6974  * This function can be called by the driver to check whether a
6975  * combination of interfaces and their types are allowed according to
6976  * the interface combinations.
6977  */
6978 int cfg80211_check_combinations(struct wiphy *wiphy,
6979                                 struct iface_combination_params *params);
6980 
6981 /**
6982  * cfg80211_iter_combinations - iterate over matching combinations
6983  *
6984  * @wiphy: the wiphy
6985  * @params: the interface combinations parameter
6986  * @iter: function to call for each matching combination
6987  * @data: pointer to pass to iter function
6988  *
6989  * This function can be called by the driver to check what possible
6990  * combinations it fits in at a given moment, e.g. for channel switching
6991  * purposes.
6992  */
6993 int cfg80211_iter_combinations(struct wiphy *wiphy,
6994                                struct iface_combination_params *params,
6995                                void (*iter)(const struct ieee80211_iface_combination *c,
6996                                             void *data),
6997                                void *data);
6998 
6999 /*
7000  * cfg80211_stop_iface - trigger interface disconnection
7001  *
7002  * @wiphy: the wiphy
7003  * @wdev: wireless device
7004  * @gfp: context flags
7005  *
7006  * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7007  * disconnected.
7008  *
7009  * Note: This doesn't need any locks and is asynchronous.
7010  */
7011 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7012                          gfp_t gfp);
7013 
7014 /**
7015  * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7016  * @wiphy: the wiphy to shut down
7017  *
7018  * This function shuts down all interfaces belonging to this wiphy by
7019  * calling dev_close() (and treating non-netdev interfaces as needed).
7020  * It shouldn't really be used unless there are some fatal device errors
7021  * that really can't be recovered in any other way.
7022  *
7023  * Callers must hold the RTNL and be able to deal with callbacks into
7024  * the driver while the function is running.
7025  */
7026 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7027 
7028 /**
7029  * wiphy_ext_feature_set - set the extended feature flag
7030  *
7031  * @wiphy: the wiphy to modify.
7032  * @ftidx: extended feature bit index.
7033  *
7034  * The extended features are flagged in multiple bytes (see
7035  * &struct wiphy.@ext_features)
7036  */
7037 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7038                                          enum nl80211_ext_feature_index ftidx)
7039 {
7040         u8 *ft_byte;
7041 
7042         ft_byte = &wiphy->ext_features[ftidx / 8];
7043         *ft_byte |= BIT(ftidx % 8);
7044 }
7045 
7046 /**
7047  * wiphy_ext_feature_isset - check the extended feature flag
7048  *
7049  * @wiphy: the wiphy to modify.
7050  * @ftidx: extended feature bit index.
7051  *
7052  * The extended features are flagged in multiple bytes (see
7053  * &struct wiphy.@ext_features)
7054  */
7055 static inline bool
7056 wiphy_ext_feature_isset(struct wiphy *wiphy,
7057                         enum nl80211_ext_feature_index ftidx)
7058 {
7059         u8 ft_byte;
7060 
7061         ft_byte = wiphy->ext_features[ftidx / 8];
7062         return (ft_byte & BIT(ftidx % 8)) != 0;
7063 }
7064 
7065 /**
7066  * cfg80211_free_nan_func - free NAN function
7067  * @f: NAN function that should be freed
7068  *
7069  * Frees all the NAN function and all it's allocated members.
7070  */
7071 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7072 
7073 /**
7074  * struct cfg80211_nan_match_params - NAN match parameters
7075  * @type: the type of the function that triggered a match. If it is
7076  *       %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7077  *       If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7078  *       result.
7079  *       If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7080  * @inst_id: the local instance id
7081  * @peer_inst_id: the instance id of the peer's function
7082  * @addr: the MAC address of the peer
7083  * @info_len: the length of the &info
7084  * @info: the Service Specific Info from the peer (if any)
7085  * @cookie: unique identifier of the corresponding function
7086  */
7087 struct cfg80211_nan_match_params {
7088         enum nl80211_nan_function_type type;
7089         u8 inst_id;
7090         u8 peer_inst_id;
7091         const u8 *addr;
7092         u8 info_len;
7093         const u8 *info;
7094         u64 cookie;
7095 };
7096 
7097 /**
7098  * cfg80211_nan_match - report a match for a NAN function.
7099  * @wdev: the wireless device reporting the match
7100  * @match: match notification parameters
7101  * @gfp: allocation flags
7102  *
7103  * This function reports that the a NAN function had a match. This
7104  * can be a subscribe that had a match or a solicited publish that
7105  * was sent. It can also be a follow up that was received.
7106  */
7107 void cfg80211_nan_match(struct wireless_dev *wdev,
7108                         struct cfg80211_nan_match_params *match, gfp_t gfp);
7109 
7110 /**
7111  * cfg80211_nan_func_terminated - notify about NAN function termination.
7112  *
7113  * @wdev: the wireless device reporting the match
7114  * @inst_id: the local instance id
7115  * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7116  * @cookie: unique NAN function identifier
7117  * @gfp: allocation flags
7118  *
7119  * This function reports that the a NAN function is terminated.
7120  */
7121 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7122                                   u8 inst_id,
7123                                   enum nl80211_nan_func_term_reason reason,
7124                                   u64 cookie, gfp_t gfp);
7125 
7126 /* ethtool helper */
7127 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7128 
7129 /**
7130  * cfg80211_external_auth_request - userspace request for authentication
7131  * @netdev: network device
7132  * @params: External authentication parameters
7133  * @gfp: allocation flags
7134  * Returns: 0 on success, < 0 on error
7135  */
7136 int cfg80211_external_auth_request(struct net_device *netdev,
7137                                    struct cfg80211_external_auth_params *params,
7138                                    gfp_t gfp);
7139 
7140 /**
7141  * cfg80211_pmsr_report - report peer measurement result data
7142  * @wdev: the wireless device reporting the measurement
7143  * @req: the original measurement request
7144  * @result: the result data
7145  * @gfp: allocation flags
7146  */
7147 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7148                           struct cfg80211_pmsr_request *req,
7149                           struct cfg80211_pmsr_result *result,
7150                           gfp_t gfp);
7151 
7152 /**
7153  * cfg80211_pmsr_complete - report peer measurement completed
7154  * @wdev: the wireless device reporting the measurement
7155  * @req: the original measurement request
7156  * @gfp: allocation flags
7157  *
7158  * Report that the entire measurement completed, after this
7159  * the request pointer will no longer be valid.
7160  */
7161 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7162                             struct cfg80211_pmsr_request *req,
7163                             gfp_t gfp);
7164 
7165 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7166 
7167 /* wiphy_printk helpers, similar to dev_printk */
7168 
7169 #define wiphy_printk(level, wiphy, format, args...)             \
7170         dev_printk(level, &(wiphy)->dev, format, ##args)
7171 #define wiphy_emerg(wiphy, format, args...)                     \
7172         dev_emerg(&(wiphy)->dev, format, ##args)
7173 #define wiphy_alert(wiphy, format, args...)                     \
7174         dev_alert(&(wiphy)->dev, format, ##args)
7175 #define wiphy_crit(wiphy, format, args...)                      \
7176         dev_crit(&(wiphy)->dev, format, ##args)
7177 #define wiphy_err(wiphy, format, args...)                       \
7178         dev_err(&(wiphy)->dev, format, ##args)
7179 #define wiphy_warn(wiphy, format, args...)                      \
7180         dev_warn(&(wiphy)->dev, format, ##args)
7181 #define wiphy_notice(wiphy, format, args...)                    \
7182         dev_notice(&(wiphy)->dev, format, ##args)
7183 #define wiphy_info(wiphy, format, args...)                      \
7184         dev_info(&(wiphy)->dev, format, ##args)
7185 
7186 #define wiphy_debug(wiphy, format, args...)                     \
7187         wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7188 
7189 #define wiphy_dbg(wiphy, format, args...)                       \
7190         dev_dbg(&(wiphy)->dev, format, ##args)
7191 
7192 #if defined(VERBOSE_DEBUG)
7193 #define wiphy_vdbg      wiphy_dbg
7194 #else
7195 #define wiphy_vdbg(wiphy, format, args...)                              \
7196 ({                                                                      \
7197         if (0)                                                          \
7198                 wiphy_printk(KERN_DEBUG, wiphy, format, ##args);        \
7199         0;                                                              \
7200 })
7201 #endif
7202 
7203 /*
7204  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7205  * of using a WARN/WARN_ON to get the message out, including the
7206  * file/line information and a backtrace.
7207  */
7208 #define wiphy_WARN(wiphy, format, args...)                      \
7209         WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7210 
7211 #endif /* __NET_CFG80211_H */
7212 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp