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