]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/net/cfg80211.h
cfg80211: Enable GO operation on additional channels
[mirror_ubuntu-bionic-kernel.git] / include / 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 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <linux/net.h>
23 #include <net/regulatory.h>
24
25 /**
26 * DOC: Introduction
27 *
28 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29 * userspace and drivers, and offers some utility functionality associated
30 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31 * by all modern wireless drivers in Linux, so that they offer a consistent
32 * API through nl80211. For backward compatibility, cfg80211 also offers
33 * wireless extensions to userspace, but hides them from drivers completely.
34 *
35 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
36 * use restrictions.
37 */
38
39
40 /**
41 * DOC: Device registration
42 *
43 * In order for a driver to use cfg80211, it must register the hardware device
44 * with cfg80211. This happens through a number of hardware capability structs
45 * described below.
46 *
47 * The fundamental structure for each device is the 'wiphy', of which each
48 * instance describes a physical wireless device connected to the system. Each
49 * such wiphy can have zero, one, or many virtual interfaces associated with
50 * it, which need to be identified as such by pointing the network interface's
51 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52 * the wireless part of the interface, normally this struct is embedded in the
53 * network interface's private data area. Drivers can optionally allow creating
54 * or destroying virtual interfaces on the fly, but without at least one or the
55 * ability to create some the wireless device isn't useful.
56 *
57 * Each wiphy structure contains device capability information, and also has
58 * a pointer to the various operations the driver offers. The definitions and
59 * structures here describe these capabilities in detail.
60 */
61
62 struct wiphy;
63
64 /*
65 * wireless hardware capability structures
66 */
67
68 /**
69 * enum ieee80211_band - supported frequency bands
70 *
71 * The bands are assigned this way because the supported
72 * bitrates differ in these bands.
73 *
74 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
75 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
76 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
77 * @IEEE80211_NUM_BANDS: number of defined bands
78 */
79 enum ieee80211_band {
80 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
82 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
83
84 /* keep last */
85 IEEE80211_NUM_BANDS
86 };
87
88 /**
89 * enum ieee80211_channel_flags - channel flags
90 *
91 * Channel flags set by the regulatory control code.
92 *
93 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
94 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
95 * sending probe requests or beaconing.
96 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
97 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
98 * is not permitted.
99 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
100 * is not permitted.
101 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
102 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
103 * this flag indicates that an 80 MHz channel cannot use this
104 * channel as the control or any of the secondary channels.
105 * This may be due to the driver or due to regulatory bandwidth
106 * restrictions.
107 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
108 * this flag indicates that an 160 MHz channel cannot use this
109 * channel as the control or any of the secondary channels.
110 * This may be due to the driver or due to regulatory bandwidth
111 * restrictions.
112 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
113 * @IEEE80211_CHAN_GO_CONCURRENT: see %NL80211_FREQUENCY_ATTR_GO_CONCURRENT
114 *
115 */
116 enum ieee80211_channel_flags {
117 IEEE80211_CHAN_DISABLED = 1<<0,
118 IEEE80211_CHAN_NO_IR = 1<<1,
119 /* hole at 1<<2 */
120 IEEE80211_CHAN_RADAR = 1<<3,
121 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
122 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
123 IEEE80211_CHAN_NO_OFDM = 1<<6,
124 IEEE80211_CHAN_NO_80MHZ = 1<<7,
125 IEEE80211_CHAN_NO_160MHZ = 1<<8,
126 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
127 IEEE80211_CHAN_GO_CONCURRENT = 1<<10,
128 };
129
130 #define IEEE80211_CHAN_NO_HT40 \
131 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
132
133 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
134 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
135
136 /**
137 * struct ieee80211_channel - channel definition
138 *
139 * This structure describes a single channel for use
140 * with cfg80211.
141 *
142 * @center_freq: center frequency in MHz
143 * @hw_value: hardware-specific value for the channel
144 * @flags: channel flags from &enum ieee80211_channel_flags.
145 * @orig_flags: channel flags at registration time, used by regulatory
146 * code to support devices with additional restrictions
147 * @band: band this channel belongs to.
148 * @max_antenna_gain: maximum antenna gain in dBi
149 * @max_power: maximum transmission power (in dBm)
150 * @max_reg_power: maximum regulatory transmission power (in dBm)
151 * @beacon_found: helper to regulatory code to indicate when a beacon
152 * has been found on this channel. Use regulatory_hint_found_beacon()
153 * to enable this, this is useful only on 5 GHz band.
154 * @orig_mag: internal use
155 * @orig_mpwr: internal use
156 * @dfs_state: current state of this channel. Only relevant if radar is required
157 * on this channel.
158 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
159 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
160 */
161 struct ieee80211_channel {
162 enum ieee80211_band band;
163 u16 center_freq;
164 u16 hw_value;
165 u32 flags;
166 int max_antenna_gain;
167 int max_power;
168 int max_reg_power;
169 bool beacon_found;
170 u32 orig_flags;
171 int orig_mag, orig_mpwr;
172 enum nl80211_dfs_state dfs_state;
173 unsigned long dfs_state_entered;
174 unsigned int dfs_cac_ms;
175 };
176
177 /**
178 * enum ieee80211_rate_flags - rate flags
179 *
180 * Hardware/specification flags for rates. These are structured
181 * in a way that allows using the same bitrate structure for
182 * different bands/PHY modes.
183 *
184 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
185 * preamble on this bitrate; only relevant in 2.4GHz band and
186 * with CCK rates.
187 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
188 * when used with 802.11a (on the 5 GHz band); filled by the
189 * core code when registering the wiphy.
190 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
191 * when used with 802.11b (on the 2.4 GHz band); filled by the
192 * core code when registering the wiphy.
193 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
194 * when used with 802.11g (on the 2.4 GHz band); filled by the
195 * core code when registering the wiphy.
196 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
197 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
198 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
199 */
200 enum ieee80211_rate_flags {
201 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
202 IEEE80211_RATE_MANDATORY_A = 1<<1,
203 IEEE80211_RATE_MANDATORY_B = 1<<2,
204 IEEE80211_RATE_MANDATORY_G = 1<<3,
205 IEEE80211_RATE_ERP_G = 1<<4,
206 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
207 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
208 };
209
210 /**
211 * struct ieee80211_rate - bitrate definition
212 *
213 * This structure describes a bitrate that an 802.11 PHY can
214 * operate with. The two values @hw_value and @hw_value_short
215 * are only for driver use when pointers to this structure are
216 * passed around.
217 *
218 * @flags: rate-specific flags
219 * @bitrate: bitrate in units of 100 Kbps
220 * @hw_value: driver/hardware value for this rate
221 * @hw_value_short: driver/hardware value for this rate when
222 * short preamble is used
223 */
224 struct ieee80211_rate {
225 u32 flags;
226 u16 bitrate;
227 u16 hw_value, hw_value_short;
228 };
229
230 /**
231 * struct ieee80211_sta_ht_cap - STA's HT capabilities
232 *
233 * This structure describes most essential parameters needed
234 * to describe 802.11n HT capabilities for an STA.
235 *
236 * @ht_supported: is HT supported by the STA
237 * @cap: HT capabilities map as described in 802.11n spec
238 * @ampdu_factor: Maximum A-MPDU length factor
239 * @ampdu_density: Minimum A-MPDU spacing
240 * @mcs: Supported MCS rates
241 */
242 struct ieee80211_sta_ht_cap {
243 u16 cap; /* use IEEE80211_HT_CAP_ */
244 bool ht_supported;
245 u8 ampdu_factor;
246 u8 ampdu_density;
247 struct ieee80211_mcs_info mcs;
248 };
249
250 /**
251 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
252 *
253 * This structure describes most essential parameters needed
254 * to describe 802.11ac VHT capabilities for an STA.
255 *
256 * @vht_supported: is VHT supported by the STA
257 * @cap: VHT capabilities map as described in 802.11ac spec
258 * @vht_mcs: Supported VHT MCS rates
259 */
260 struct ieee80211_sta_vht_cap {
261 bool vht_supported;
262 u32 cap; /* use IEEE80211_VHT_CAP_ */
263 struct ieee80211_vht_mcs_info vht_mcs;
264 };
265
266 /**
267 * struct ieee80211_supported_band - frequency band definition
268 *
269 * This structure describes a frequency band a wiphy
270 * is able to operate in.
271 *
272 * @channels: Array of channels the hardware can operate in
273 * in this band.
274 * @band: the band this structure represents
275 * @n_channels: Number of channels in @channels
276 * @bitrates: Array of bitrates the hardware can operate with
277 * in this band. Must be sorted to give a valid "supported
278 * rates" IE, i.e. CCK rates first, then OFDM.
279 * @n_bitrates: Number of bitrates in @bitrates
280 * @ht_cap: HT capabilities in this band
281 * @vht_cap: VHT capabilities in this band
282 */
283 struct ieee80211_supported_band {
284 struct ieee80211_channel *channels;
285 struct ieee80211_rate *bitrates;
286 enum ieee80211_band band;
287 int n_channels;
288 int n_bitrates;
289 struct ieee80211_sta_ht_cap ht_cap;
290 struct ieee80211_sta_vht_cap vht_cap;
291 };
292
293 /*
294 * Wireless hardware/device configuration structures and methods
295 */
296
297 /**
298 * DOC: Actions and configuration
299 *
300 * Each wireless device and each virtual interface offer a set of configuration
301 * operations and other actions that are invoked by userspace. Each of these
302 * actions is described in the operations structure, and the parameters these
303 * operations use are described separately.
304 *
305 * Additionally, some operations are asynchronous and expect to get status
306 * information via some functions that drivers need to call.
307 *
308 * Scanning and BSS list handling with its associated functionality is described
309 * in a separate chapter.
310 */
311
312 /**
313 * struct vif_params - describes virtual interface parameters
314 * @use_4addr: use 4-address frames
315 * @macaddr: address to use for this virtual interface. This will only
316 * be used for non-netdevice interfaces. If this parameter is set
317 * to zero address the driver may determine the address as needed.
318 */
319 struct vif_params {
320 int use_4addr;
321 u8 macaddr[ETH_ALEN];
322 };
323
324 /**
325 * struct key_params - key information
326 *
327 * Information about a key
328 *
329 * @key: key material
330 * @key_len: length of key material
331 * @cipher: cipher suite selector
332 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
333 * with the get_key() callback, must be in little endian,
334 * length given by @seq_len.
335 * @seq_len: length of @seq.
336 */
337 struct key_params {
338 u8 *key;
339 u8 *seq;
340 int key_len;
341 int seq_len;
342 u32 cipher;
343 };
344
345 /**
346 * struct cfg80211_chan_def - channel definition
347 * @chan: the (control) channel
348 * @width: channel width
349 * @center_freq1: center frequency of first segment
350 * @center_freq2: center frequency of second segment
351 * (only with 80+80 MHz)
352 */
353 struct cfg80211_chan_def {
354 struct ieee80211_channel *chan;
355 enum nl80211_chan_width width;
356 u32 center_freq1;
357 u32 center_freq2;
358 };
359
360 /**
361 * cfg80211_get_chandef_type - return old channel type from chandef
362 * @chandef: the channel definition
363 *
364 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
365 * chandef, which must have a bandwidth allowing this conversion.
366 */
367 static inline enum nl80211_channel_type
368 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
369 {
370 switch (chandef->width) {
371 case NL80211_CHAN_WIDTH_20_NOHT:
372 return NL80211_CHAN_NO_HT;
373 case NL80211_CHAN_WIDTH_20:
374 return NL80211_CHAN_HT20;
375 case NL80211_CHAN_WIDTH_40:
376 if (chandef->center_freq1 > chandef->chan->center_freq)
377 return NL80211_CHAN_HT40PLUS;
378 return NL80211_CHAN_HT40MINUS;
379 default:
380 WARN_ON(1);
381 return NL80211_CHAN_NO_HT;
382 }
383 }
384
385 /**
386 * cfg80211_chandef_create - create channel definition using channel type
387 * @chandef: the channel definition struct to fill
388 * @channel: the control channel
389 * @chantype: the channel type
390 *
391 * Given a channel type, create a channel definition.
392 */
393 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
394 struct ieee80211_channel *channel,
395 enum nl80211_channel_type chantype);
396
397 /**
398 * cfg80211_chandef_identical - check if two channel definitions are identical
399 * @chandef1: first channel definition
400 * @chandef2: second channel definition
401 *
402 * Return: %true if the channels defined by the channel definitions are
403 * identical, %false otherwise.
404 */
405 static inline bool
406 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
407 const struct cfg80211_chan_def *chandef2)
408 {
409 return (chandef1->chan == chandef2->chan &&
410 chandef1->width == chandef2->width &&
411 chandef1->center_freq1 == chandef2->center_freq1 &&
412 chandef1->center_freq2 == chandef2->center_freq2);
413 }
414
415 /**
416 * cfg80211_chandef_compatible - check if two channel definitions are compatible
417 * @chandef1: first channel definition
418 * @chandef2: second channel definition
419 *
420 * Return: %NULL if the given channel definitions are incompatible,
421 * chandef1 or chandef2 otherwise.
422 */
423 const struct cfg80211_chan_def *
424 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
425 const struct cfg80211_chan_def *chandef2);
426
427 /**
428 * cfg80211_chandef_valid - check if a channel definition is valid
429 * @chandef: the channel definition to check
430 * Return: %true if the channel definition is valid. %false otherwise.
431 */
432 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
433
434 /**
435 * cfg80211_chandef_usable - check if secondary channels can be used
436 * @wiphy: the wiphy to validate against
437 * @chandef: the channel definition to check
438 * @prohibited_flags: the regulatory channel flags that must not be set
439 * Return: %true if secondary channels are usable. %false otherwise.
440 */
441 bool cfg80211_chandef_usable(struct wiphy *wiphy,
442 const struct cfg80211_chan_def *chandef,
443 u32 prohibited_flags);
444
445 /**
446 * cfg80211_chandef_dfs_required - checks if radar detection is required
447 * @wiphy: the wiphy to validate against
448 * @chandef: the channel definition to check
449 * Return: 1 if radar detection is required, 0 if it is not, < 0 on error
450 */
451 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
452 const struct cfg80211_chan_def *chandef);
453
454 /**
455 * ieee80211_chandef_rate_flags - returns rate flags for a channel
456 *
457 * In some channel types, not all rates may be used - for example CCK
458 * rates may not be used in 5/10 MHz channels.
459 *
460 * @chandef: channel definition for the channel
461 *
462 * Returns: rate flags which apply for this channel
463 */
464 static inline enum ieee80211_rate_flags
465 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
466 {
467 switch (chandef->width) {
468 case NL80211_CHAN_WIDTH_5:
469 return IEEE80211_RATE_SUPPORTS_5MHZ;
470 case NL80211_CHAN_WIDTH_10:
471 return IEEE80211_RATE_SUPPORTS_10MHZ;
472 default:
473 break;
474 }
475 return 0;
476 }
477
478 /**
479 * ieee80211_chandef_max_power - maximum transmission power for the chandef
480 *
481 * In some regulations, the transmit power may depend on the configured channel
482 * bandwidth which may be defined as dBm/MHz. This function returns the actual
483 * max_power for non-standard (20 MHz) channels.
484 *
485 * @chandef: channel definition for the channel
486 *
487 * Returns: maximum allowed transmission power in dBm for the chandef
488 */
489 static inline int
490 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
491 {
492 switch (chandef->width) {
493 case NL80211_CHAN_WIDTH_5:
494 return min(chandef->chan->max_reg_power - 6,
495 chandef->chan->max_power);
496 case NL80211_CHAN_WIDTH_10:
497 return min(chandef->chan->max_reg_power - 3,
498 chandef->chan->max_power);
499 default:
500 break;
501 }
502 return chandef->chan->max_power;
503 }
504
505 /**
506 * enum survey_info_flags - survey information flags
507 *
508 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
509 * @SURVEY_INFO_IN_USE: channel is currently being used
510 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
511 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
512 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
513 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
514 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
515 *
516 * Used by the driver to indicate which info in &struct survey_info
517 * it has filled in during the get_survey().
518 */
519 enum survey_info_flags {
520 SURVEY_INFO_NOISE_DBM = 1<<0,
521 SURVEY_INFO_IN_USE = 1<<1,
522 SURVEY_INFO_CHANNEL_TIME = 1<<2,
523 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
524 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
525 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
526 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
527 };
528
529 /**
530 * struct survey_info - channel survey response
531 *
532 * @channel: the channel this survey record reports, mandatory
533 * @filled: bitflag of flags from &enum survey_info_flags
534 * @noise: channel noise in dBm. This and all following fields are
535 * optional
536 * @channel_time: amount of time in ms the radio spent on the channel
537 * @channel_time_busy: amount of time the primary channel was sensed busy
538 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
539 * @channel_time_rx: amount of time the radio spent receiving data
540 * @channel_time_tx: amount of time the radio spent transmitting data
541 *
542 * Used by dump_survey() to report back per-channel survey information.
543 *
544 * This structure can later be expanded with things like
545 * channel duty cycle etc.
546 */
547 struct survey_info {
548 struct ieee80211_channel *channel;
549 u64 channel_time;
550 u64 channel_time_busy;
551 u64 channel_time_ext_busy;
552 u64 channel_time_rx;
553 u64 channel_time_tx;
554 u32 filled;
555 s8 noise;
556 };
557
558 /**
559 * struct cfg80211_crypto_settings - Crypto settings
560 * @wpa_versions: indicates which, if any, WPA versions are enabled
561 * (from enum nl80211_wpa_versions)
562 * @cipher_group: group key cipher suite (or 0 if unset)
563 * @n_ciphers_pairwise: number of AP supported unicast ciphers
564 * @ciphers_pairwise: unicast key cipher suites
565 * @n_akm_suites: number of AKM suites
566 * @akm_suites: AKM suites
567 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
568 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
569 * required to assume that the port is unauthorized until authorized by
570 * user space. Otherwise, port is marked authorized by default.
571 * @control_port_ethertype: the control port protocol that should be
572 * allowed through even on unauthorized ports
573 * @control_port_no_encrypt: TRUE to prevent encryption of control port
574 * protocol frames.
575 */
576 struct cfg80211_crypto_settings {
577 u32 wpa_versions;
578 u32 cipher_group;
579 int n_ciphers_pairwise;
580 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
581 int n_akm_suites;
582 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
583 bool control_port;
584 __be16 control_port_ethertype;
585 bool control_port_no_encrypt;
586 };
587
588 /**
589 * struct cfg80211_beacon_data - beacon data
590 * @head: head portion of beacon (before TIM IE)
591 * or %NULL if not changed
592 * @tail: tail portion of beacon (after TIM IE)
593 * or %NULL if not changed
594 * @head_len: length of @head
595 * @tail_len: length of @tail
596 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
597 * @beacon_ies_len: length of beacon_ies in octets
598 * @proberesp_ies: extra information element(s) to add into Probe Response
599 * frames or %NULL
600 * @proberesp_ies_len: length of proberesp_ies in octets
601 * @assocresp_ies: extra information element(s) to add into (Re)Association
602 * Response frames or %NULL
603 * @assocresp_ies_len: length of assocresp_ies in octets
604 * @probe_resp_len: length of probe response template (@probe_resp)
605 * @probe_resp: probe response template (AP mode only)
606 */
607 struct cfg80211_beacon_data {
608 const u8 *head, *tail;
609 const u8 *beacon_ies;
610 const u8 *proberesp_ies;
611 const u8 *assocresp_ies;
612 const u8 *probe_resp;
613
614 size_t head_len, tail_len;
615 size_t beacon_ies_len;
616 size_t proberesp_ies_len;
617 size_t assocresp_ies_len;
618 size_t probe_resp_len;
619 };
620
621 struct mac_address {
622 u8 addr[ETH_ALEN];
623 };
624
625 /**
626 * struct cfg80211_acl_data - Access control list data
627 *
628 * @acl_policy: ACL policy to be applied on the station's
629 * entry specified by mac_addr
630 * @n_acl_entries: Number of MAC address entries passed
631 * @mac_addrs: List of MAC addresses of stations to be used for ACL
632 */
633 struct cfg80211_acl_data {
634 enum nl80211_acl_policy acl_policy;
635 int n_acl_entries;
636
637 /* Keep it last */
638 struct mac_address mac_addrs[];
639 };
640
641 /**
642 * struct cfg80211_ap_settings - AP configuration
643 *
644 * Used to configure an AP interface.
645 *
646 * @chandef: defines the channel to use
647 * @beacon: beacon data
648 * @beacon_interval: beacon interval
649 * @dtim_period: DTIM period
650 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
651 * user space)
652 * @ssid_len: length of @ssid
653 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
654 * @crypto: crypto settings
655 * @privacy: the BSS uses privacy
656 * @auth_type: Authentication type (algorithm)
657 * @inactivity_timeout: time in seconds to determine station's inactivity.
658 * @p2p_ctwindow: P2P CT Window
659 * @p2p_opp_ps: P2P opportunistic PS
660 * @acl: ACL configuration used by the drivers which has support for
661 * MAC address based access control
662 * @radar_required: set if radar detection is required
663 */
664 struct cfg80211_ap_settings {
665 struct cfg80211_chan_def chandef;
666
667 struct cfg80211_beacon_data beacon;
668
669 int beacon_interval, dtim_period;
670 const u8 *ssid;
671 size_t ssid_len;
672 enum nl80211_hidden_ssid hidden_ssid;
673 struct cfg80211_crypto_settings crypto;
674 bool privacy;
675 enum nl80211_auth_type auth_type;
676 int inactivity_timeout;
677 u8 p2p_ctwindow;
678 bool p2p_opp_ps;
679 const struct cfg80211_acl_data *acl;
680 bool radar_required;
681 };
682
683 /**
684 * struct cfg80211_csa_settings - channel switch settings
685 *
686 * Used for channel switch
687 *
688 * @chandef: defines the channel to use after the switch
689 * @beacon_csa: beacon data while performing the switch
690 * @counter_offset_beacon: offset for the counter within the beacon (tail)
691 * @counter_offset_presp: offset for the counter within the probe response
692 * @beacon_after: beacon data to be used on the new channel
693 * @radar_required: whether radar detection is required on the new channel
694 * @block_tx: whether transmissions should be blocked while changing
695 * @count: number of beacons until switch
696 */
697 struct cfg80211_csa_settings {
698 struct cfg80211_chan_def chandef;
699 struct cfg80211_beacon_data beacon_csa;
700 u16 counter_offset_beacon, counter_offset_presp;
701 struct cfg80211_beacon_data beacon_after;
702 bool radar_required;
703 bool block_tx;
704 u8 count;
705 };
706
707 /**
708 * enum station_parameters_apply_mask - station parameter values to apply
709 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
710 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
711 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
712 *
713 * Not all station parameters have in-band "no change" signalling,
714 * for those that don't these flags will are used.
715 */
716 enum station_parameters_apply_mask {
717 STATION_PARAM_APPLY_UAPSD = BIT(0),
718 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
719 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
720 };
721
722 /**
723 * struct station_parameters - station parameters
724 *
725 * Used to change and create a new station.
726 *
727 * @vlan: vlan interface station should belong to
728 * @supported_rates: supported rates in IEEE 802.11 format
729 * (or NULL for no change)
730 * @supported_rates_len: number of supported rates
731 * @sta_flags_mask: station flags that changed
732 * (bitmask of BIT(NL80211_STA_FLAG_...))
733 * @sta_flags_set: station flags values
734 * (bitmask of BIT(NL80211_STA_FLAG_...))
735 * @listen_interval: listen interval or -1 for no change
736 * @aid: AID or zero for no change
737 * @plink_action: plink action to take
738 * @plink_state: set the peer link state for a station
739 * @ht_capa: HT capabilities of station
740 * @vht_capa: VHT capabilities of station
741 * @uapsd_queues: bitmap of queues configured for uapsd. same format
742 * as the AC bitmap in the QoS info field
743 * @max_sp: max Service Period. same format as the MAX_SP in the
744 * QoS info field (but already shifted down)
745 * @sta_modify_mask: bitmap indicating which parameters changed
746 * (for those that don't have a natural "no change" value),
747 * see &enum station_parameters_apply_mask
748 * @local_pm: local link-specific mesh power save mode (no change when set
749 * to unknown)
750 * @capability: station capability
751 * @ext_capab: extended capabilities of the station
752 * @ext_capab_len: number of extended capabilities
753 * @supported_channels: supported channels in IEEE 802.11 format
754 * @supported_channels_len: number of supported channels
755 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
756 * @supported_oper_classes_len: number of supported operating classes
757 * @opmode_notif: operating mode field from Operating Mode Notification
758 * @opmode_notif_used: information if operating mode field is used
759 */
760 struct station_parameters {
761 const u8 *supported_rates;
762 struct net_device *vlan;
763 u32 sta_flags_mask, sta_flags_set;
764 u32 sta_modify_mask;
765 int listen_interval;
766 u16 aid;
767 u8 supported_rates_len;
768 u8 plink_action;
769 u8 plink_state;
770 const struct ieee80211_ht_cap *ht_capa;
771 const struct ieee80211_vht_cap *vht_capa;
772 u8 uapsd_queues;
773 u8 max_sp;
774 enum nl80211_mesh_power_mode local_pm;
775 u16 capability;
776 const u8 *ext_capab;
777 u8 ext_capab_len;
778 const u8 *supported_channels;
779 u8 supported_channels_len;
780 const u8 *supported_oper_classes;
781 u8 supported_oper_classes_len;
782 u8 opmode_notif;
783 bool opmode_notif_used;
784 };
785
786 /**
787 * enum cfg80211_station_type - the type of station being modified
788 * @CFG80211_STA_AP_CLIENT: client of an AP interface
789 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
790 * the AP MLME in the device
791 * @CFG80211_STA_AP_STA: AP station on managed interface
792 * @CFG80211_STA_IBSS: IBSS station
793 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
794 * while TDLS setup is in progress, it moves out of this state when
795 * being marked authorized; use this only if TDLS with external setup is
796 * supported/used)
797 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
798 * entry that is operating, has been marked authorized by userspace)
799 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
800 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
801 */
802 enum cfg80211_station_type {
803 CFG80211_STA_AP_CLIENT,
804 CFG80211_STA_AP_MLME_CLIENT,
805 CFG80211_STA_AP_STA,
806 CFG80211_STA_IBSS,
807 CFG80211_STA_TDLS_PEER_SETUP,
808 CFG80211_STA_TDLS_PEER_ACTIVE,
809 CFG80211_STA_MESH_PEER_KERNEL,
810 CFG80211_STA_MESH_PEER_USER,
811 };
812
813 /**
814 * cfg80211_check_station_change - validate parameter changes
815 * @wiphy: the wiphy this operates on
816 * @params: the new parameters for a station
817 * @statype: the type of station being modified
818 *
819 * Utility function for the @change_station driver method. Call this function
820 * with the appropriate station type looking up the station (and checking that
821 * it exists). It will verify whether the station change is acceptable, and if
822 * not will return an error code. Note that it may modify the parameters for
823 * backward compatibility reasons, so don't use them before calling this.
824 */
825 int cfg80211_check_station_change(struct wiphy *wiphy,
826 struct station_parameters *params,
827 enum cfg80211_station_type statype);
828
829 /**
830 * enum station_info_flags - station information flags
831 *
832 * Used by the driver to indicate which info in &struct station_info
833 * it has filled in during get_station() or dump_station().
834 *
835 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
836 * @STATION_INFO_RX_BYTES: @rx_bytes filled
837 * @STATION_INFO_TX_BYTES: @tx_bytes filled
838 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
839 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
840 * @STATION_INFO_LLID: @llid filled
841 * @STATION_INFO_PLID: @plid filled
842 * @STATION_INFO_PLINK_STATE: @plink_state filled
843 * @STATION_INFO_SIGNAL: @signal filled
844 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
845 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
846 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
847 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
848 * @STATION_INFO_TX_RETRIES: @tx_retries filled
849 * @STATION_INFO_TX_FAILED: @tx_failed filled
850 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
851 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
852 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
853 * @STATION_INFO_BSS_PARAM: @bss_param filled
854 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
855 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
856 * @STATION_INFO_STA_FLAGS: @sta_flags filled
857 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
858 * @STATION_INFO_T_OFFSET: @t_offset filled
859 * @STATION_INFO_LOCAL_PM: @local_pm filled
860 * @STATION_INFO_PEER_PM: @peer_pm filled
861 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
862 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
863 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
864 */
865 enum station_info_flags {
866 STATION_INFO_INACTIVE_TIME = 1<<0,
867 STATION_INFO_RX_BYTES = 1<<1,
868 STATION_INFO_TX_BYTES = 1<<2,
869 STATION_INFO_LLID = 1<<3,
870 STATION_INFO_PLID = 1<<4,
871 STATION_INFO_PLINK_STATE = 1<<5,
872 STATION_INFO_SIGNAL = 1<<6,
873 STATION_INFO_TX_BITRATE = 1<<7,
874 STATION_INFO_RX_PACKETS = 1<<8,
875 STATION_INFO_TX_PACKETS = 1<<9,
876 STATION_INFO_TX_RETRIES = 1<<10,
877 STATION_INFO_TX_FAILED = 1<<11,
878 STATION_INFO_RX_DROP_MISC = 1<<12,
879 STATION_INFO_SIGNAL_AVG = 1<<13,
880 STATION_INFO_RX_BITRATE = 1<<14,
881 STATION_INFO_BSS_PARAM = 1<<15,
882 STATION_INFO_CONNECTED_TIME = 1<<16,
883 STATION_INFO_ASSOC_REQ_IES = 1<<17,
884 STATION_INFO_STA_FLAGS = 1<<18,
885 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
886 STATION_INFO_T_OFFSET = 1<<20,
887 STATION_INFO_LOCAL_PM = 1<<21,
888 STATION_INFO_PEER_PM = 1<<22,
889 STATION_INFO_NONPEER_PM = 1<<23,
890 STATION_INFO_RX_BYTES64 = 1<<24,
891 STATION_INFO_TX_BYTES64 = 1<<25,
892 STATION_INFO_CHAIN_SIGNAL = 1<<26,
893 STATION_INFO_CHAIN_SIGNAL_AVG = 1<<27,
894 };
895
896 /**
897 * enum station_info_rate_flags - bitrate info flags
898 *
899 * Used by the driver to indicate the specific rate transmission
900 * type for 802.11n transmissions.
901 *
902 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
903 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
904 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
905 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
906 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
907 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
908 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
909 * @RATE_INFO_FLAGS_60G: 60GHz MCS
910 */
911 enum rate_info_flags {
912 RATE_INFO_FLAGS_MCS = BIT(0),
913 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
914 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
915 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
916 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
917 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
918 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
919 RATE_INFO_FLAGS_60G = BIT(7),
920 };
921
922 /**
923 * struct rate_info - bitrate information
924 *
925 * Information about a receiving or transmitting bitrate
926 *
927 * @flags: bitflag of flags from &enum rate_info_flags
928 * @mcs: mcs index if struct describes a 802.11n bitrate
929 * @legacy: bitrate in 100kbit/s for 802.11abg
930 * @nss: number of streams (VHT only)
931 */
932 struct rate_info {
933 u8 flags;
934 u8 mcs;
935 u16 legacy;
936 u8 nss;
937 };
938
939 /**
940 * enum station_info_rate_flags - bitrate info flags
941 *
942 * Used by the driver to indicate the specific rate transmission
943 * type for 802.11n transmissions.
944 *
945 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
946 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
947 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
948 */
949 enum bss_param_flags {
950 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
951 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
952 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
953 };
954
955 /**
956 * struct sta_bss_parameters - BSS parameters for the attached station
957 *
958 * Information about the currently associated BSS
959 *
960 * @flags: bitflag of flags from &enum bss_param_flags
961 * @dtim_period: DTIM period for the BSS
962 * @beacon_interval: beacon interval
963 */
964 struct sta_bss_parameters {
965 u8 flags;
966 u8 dtim_period;
967 u16 beacon_interval;
968 };
969
970 #define IEEE80211_MAX_CHAINS 4
971
972 /**
973 * struct station_info - station information
974 *
975 * Station information filled by driver for get_station() and dump_station.
976 *
977 * @filled: bitflag of flags from &enum station_info_flags
978 * @connected_time: time(in secs) since a station is last connected
979 * @inactive_time: time since last station activity (tx/rx) in milliseconds
980 * @rx_bytes: bytes received from this station
981 * @tx_bytes: bytes transmitted to this station
982 * @llid: mesh local link id
983 * @plid: mesh peer link id
984 * @plink_state: mesh peer link state
985 * @signal: The signal strength, type depends on the wiphy's signal_type.
986 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
987 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
988 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
989 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
990 * @chain_signal: per-chain signal strength of last received packet in dBm
991 * @chain_signal_avg: per-chain signal strength average in dBm
992 * @txrate: current unicast bitrate from this station
993 * @rxrate: current unicast bitrate to this station
994 * @rx_packets: packets received from this station
995 * @tx_packets: packets transmitted to this station
996 * @tx_retries: cumulative retry counts
997 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
998 * @rx_dropped_misc: Dropped for un-specified reason.
999 * @bss_param: current BSS parameters
1000 * @generation: generation number for nl80211 dumps.
1001 * This number should increase every time the list of stations
1002 * changes, i.e. when a station is added or removed, so that
1003 * userspace can tell whether it got a consistent snapshot.
1004 * @assoc_req_ies: IEs from (Re)Association Request.
1005 * This is used only when in AP mode with drivers that do not use
1006 * user space MLME/SME implementation. The information is provided for
1007 * the cfg80211_new_sta() calls to notify user space of the IEs.
1008 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1009 * @sta_flags: station flags mask & values
1010 * @beacon_loss_count: Number of times beacon loss event has triggered.
1011 * @t_offset: Time offset of the station relative to this host.
1012 * @local_pm: local mesh STA power save mode
1013 * @peer_pm: peer mesh STA power save mode
1014 * @nonpeer_pm: non-peer mesh STA power save mode
1015 */
1016 struct station_info {
1017 u32 filled;
1018 u32 connected_time;
1019 u32 inactive_time;
1020 u64 rx_bytes;
1021 u64 tx_bytes;
1022 u16 llid;
1023 u16 plid;
1024 u8 plink_state;
1025 s8 signal;
1026 s8 signal_avg;
1027
1028 u8 chains;
1029 s8 chain_signal[IEEE80211_MAX_CHAINS];
1030 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1031
1032 struct rate_info txrate;
1033 struct rate_info rxrate;
1034 u32 rx_packets;
1035 u32 tx_packets;
1036 u32 tx_retries;
1037 u32 tx_failed;
1038 u32 rx_dropped_misc;
1039 struct sta_bss_parameters bss_param;
1040 struct nl80211_sta_flag_update sta_flags;
1041
1042 int generation;
1043
1044 const u8 *assoc_req_ies;
1045 size_t assoc_req_ies_len;
1046
1047 u32 beacon_loss_count;
1048 s64 t_offset;
1049 enum nl80211_mesh_power_mode local_pm;
1050 enum nl80211_mesh_power_mode peer_pm;
1051 enum nl80211_mesh_power_mode nonpeer_pm;
1052
1053 /*
1054 * Note: Add a new enum station_info_flags value for each new field and
1055 * use it to check which fields are initialized.
1056 */
1057 };
1058
1059 /**
1060 * enum monitor_flags - monitor flags
1061 *
1062 * Monitor interface configuration flags. Note that these must be the bits
1063 * according to the nl80211 flags.
1064 *
1065 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1066 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1067 * @MONITOR_FLAG_CONTROL: pass control frames
1068 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1069 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1070 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1071 */
1072 enum monitor_flags {
1073 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1074 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1075 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1076 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1077 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1078 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1079 };
1080
1081 /**
1082 * enum mpath_info_flags - mesh path information flags
1083 *
1084 * Used by the driver to indicate which info in &struct mpath_info it has filled
1085 * in during get_station() or dump_station().
1086 *
1087 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1088 * @MPATH_INFO_SN: @sn filled
1089 * @MPATH_INFO_METRIC: @metric filled
1090 * @MPATH_INFO_EXPTIME: @exptime filled
1091 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1092 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1093 * @MPATH_INFO_FLAGS: @flags filled
1094 */
1095 enum mpath_info_flags {
1096 MPATH_INFO_FRAME_QLEN = BIT(0),
1097 MPATH_INFO_SN = BIT(1),
1098 MPATH_INFO_METRIC = BIT(2),
1099 MPATH_INFO_EXPTIME = BIT(3),
1100 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1101 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1102 MPATH_INFO_FLAGS = BIT(6),
1103 };
1104
1105 /**
1106 * struct mpath_info - mesh path information
1107 *
1108 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1109 *
1110 * @filled: bitfield of flags from &enum mpath_info_flags
1111 * @frame_qlen: number of queued frames for this destination
1112 * @sn: target sequence number
1113 * @metric: metric (cost) of this mesh path
1114 * @exptime: expiration time for the mesh path from now, in msecs
1115 * @flags: mesh path flags
1116 * @discovery_timeout: total mesh path discovery timeout, in msecs
1117 * @discovery_retries: mesh path discovery retries
1118 * @generation: generation number for nl80211 dumps.
1119 * This number should increase every time the list of mesh paths
1120 * changes, i.e. when a station is added or removed, so that
1121 * userspace can tell whether it got a consistent snapshot.
1122 */
1123 struct mpath_info {
1124 u32 filled;
1125 u32 frame_qlen;
1126 u32 sn;
1127 u32 metric;
1128 u32 exptime;
1129 u32 discovery_timeout;
1130 u8 discovery_retries;
1131 u8 flags;
1132
1133 int generation;
1134 };
1135
1136 /**
1137 * struct bss_parameters - BSS parameters
1138 *
1139 * Used to change BSS parameters (mainly for AP mode).
1140 *
1141 * @use_cts_prot: Whether to use CTS protection
1142 * (0 = no, 1 = yes, -1 = do not change)
1143 * @use_short_preamble: Whether the use of short preambles is allowed
1144 * (0 = no, 1 = yes, -1 = do not change)
1145 * @use_short_slot_time: Whether the use of short slot time is allowed
1146 * (0 = no, 1 = yes, -1 = do not change)
1147 * @basic_rates: basic rates in IEEE 802.11 format
1148 * (or NULL for no change)
1149 * @basic_rates_len: number of basic rates
1150 * @ap_isolate: do not forward packets between connected stations
1151 * @ht_opmode: HT Operation mode
1152 * (u16 = opmode, -1 = do not change)
1153 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1154 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1155 */
1156 struct bss_parameters {
1157 int use_cts_prot;
1158 int use_short_preamble;
1159 int use_short_slot_time;
1160 u8 *basic_rates;
1161 u8 basic_rates_len;
1162 int ap_isolate;
1163 int ht_opmode;
1164 s8 p2p_ctwindow, p2p_opp_ps;
1165 };
1166
1167 /**
1168 * struct mesh_config - 802.11s mesh configuration
1169 *
1170 * These parameters can be changed while the mesh is active.
1171 *
1172 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1173 * by the Mesh Peering Open message
1174 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1175 * used by the Mesh Peering Open message
1176 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1177 * the mesh peering management to close a mesh peering
1178 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1179 * mesh interface
1180 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1181 * be sent to establish a new peer link instance in a mesh
1182 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1183 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1184 * elements
1185 * @auto_open_plinks: whether we should automatically open peer links when we
1186 * detect compatible mesh peers
1187 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1188 * synchronize to for 11s default synchronization method
1189 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1190 * that an originator mesh STA can send to a particular path target
1191 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1192 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1193 * a path discovery in milliseconds
1194 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1195 * receiving a PREQ shall consider the forwarding information from the
1196 * root to be valid. (TU = time unit)
1197 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1198 * which a mesh STA can send only one action frame containing a PREQ
1199 * element
1200 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1201 * which a mesh STA can send only one Action frame containing a PERR
1202 * element
1203 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1204 * it takes for an HWMP information element to propagate across the mesh
1205 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1206 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1207 * announcements are transmitted
1208 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1209 * station has access to a broader network beyond the MBSS. (This is
1210 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1211 * only means that the station will announce others it's a mesh gate, but
1212 * not necessarily using the gate announcement protocol. Still keeping the
1213 * same nomenclature to be in sync with the spec)
1214 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1215 * entity (default is TRUE - forwarding entity)
1216 * @rssi_threshold: the threshold for average signal strength of candidate
1217 * station to establish a peer link
1218 * @ht_opmode: mesh HT protection mode
1219 *
1220 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1221 * receiving a proactive PREQ shall consider the forwarding information to
1222 * the root mesh STA to be valid.
1223 *
1224 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1225 * PREQs are transmitted.
1226 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1227 * during which a mesh STA can send only one Action frame containing
1228 * a PREQ element for root path confirmation.
1229 * @power_mode: The default mesh power save mode which will be the initial
1230 * setting for new peer links.
1231 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1232 * after transmitting its beacon.
1233 * @plink_timeout: If no tx activity is seen from a STA we've established
1234 * peering with for longer than this time (in seconds), then remove it
1235 * from the STA's list of peers. Default is 30 minutes.
1236 */
1237 struct mesh_config {
1238 u16 dot11MeshRetryTimeout;
1239 u16 dot11MeshConfirmTimeout;
1240 u16 dot11MeshHoldingTimeout;
1241 u16 dot11MeshMaxPeerLinks;
1242 u8 dot11MeshMaxRetries;
1243 u8 dot11MeshTTL;
1244 u8 element_ttl;
1245 bool auto_open_plinks;
1246 u32 dot11MeshNbrOffsetMaxNeighbor;
1247 u8 dot11MeshHWMPmaxPREQretries;
1248 u32 path_refresh_time;
1249 u16 min_discovery_timeout;
1250 u32 dot11MeshHWMPactivePathTimeout;
1251 u16 dot11MeshHWMPpreqMinInterval;
1252 u16 dot11MeshHWMPperrMinInterval;
1253 u16 dot11MeshHWMPnetDiameterTraversalTime;
1254 u8 dot11MeshHWMPRootMode;
1255 u16 dot11MeshHWMPRannInterval;
1256 bool dot11MeshGateAnnouncementProtocol;
1257 bool dot11MeshForwarding;
1258 s32 rssi_threshold;
1259 u16 ht_opmode;
1260 u32 dot11MeshHWMPactivePathToRootTimeout;
1261 u16 dot11MeshHWMProotInterval;
1262 u16 dot11MeshHWMPconfirmationInterval;
1263 enum nl80211_mesh_power_mode power_mode;
1264 u16 dot11MeshAwakeWindowDuration;
1265 u32 plink_timeout;
1266 };
1267
1268 /**
1269 * struct mesh_setup - 802.11s mesh setup configuration
1270 * @chandef: defines the channel to use
1271 * @mesh_id: the mesh ID
1272 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1273 * @sync_method: which synchronization method to use
1274 * @path_sel_proto: which path selection protocol to use
1275 * @path_metric: which metric to use
1276 * @auth_id: which authentication method this mesh is using
1277 * @ie: vendor information elements (optional)
1278 * @ie_len: length of vendor information elements
1279 * @is_authenticated: this mesh requires authentication
1280 * @is_secure: this mesh uses security
1281 * @user_mpm: userspace handles all MPM functions
1282 * @dtim_period: DTIM period to use
1283 * @beacon_interval: beacon interval to use
1284 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1285 * @basic_rates: basic rates to use when creating the mesh
1286 *
1287 * These parameters are fixed when the mesh is created.
1288 */
1289 struct mesh_setup {
1290 struct cfg80211_chan_def chandef;
1291 const u8 *mesh_id;
1292 u8 mesh_id_len;
1293 u8 sync_method;
1294 u8 path_sel_proto;
1295 u8 path_metric;
1296 u8 auth_id;
1297 const u8 *ie;
1298 u8 ie_len;
1299 bool is_authenticated;
1300 bool is_secure;
1301 bool user_mpm;
1302 u8 dtim_period;
1303 u16 beacon_interval;
1304 int mcast_rate[IEEE80211_NUM_BANDS];
1305 u32 basic_rates;
1306 };
1307
1308 /**
1309 * struct ieee80211_txq_params - TX queue parameters
1310 * @ac: AC identifier
1311 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1312 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1313 * 1..32767]
1314 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1315 * 1..32767]
1316 * @aifs: Arbitration interframe space [0..255]
1317 */
1318 struct ieee80211_txq_params {
1319 enum nl80211_ac ac;
1320 u16 txop;
1321 u16 cwmin;
1322 u16 cwmax;
1323 u8 aifs;
1324 };
1325
1326 /**
1327 * DOC: Scanning and BSS list handling
1328 *
1329 * The scanning process itself is fairly simple, but cfg80211 offers quite
1330 * a bit of helper functionality. To start a scan, the scan operation will
1331 * be invoked with a scan definition. This scan definition contains the
1332 * channels to scan, and the SSIDs to send probe requests for (including the
1333 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1334 * probe. Additionally, a scan request may contain extra information elements
1335 * that should be added to the probe request. The IEs are guaranteed to be
1336 * well-formed, and will not exceed the maximum length the driver advertised
1337 * in the wiphy structure.
1338 *
1339 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1340 * it is responsible for maintaining the BSS list; the driver should not
1341 * maintain a list itself. For this notification, various functions exist.
1342 *
1343 * Since drivers do not maintain a BSS list, there are also a number of
1344 * functions to search for a BSS and obtain information about it from the
1345 * BSS structure cfg80211 maintains. The BSS list is also made available
1346 * to userspace.
1347 */
1348
1349 /**
1350 * struct cfg80211_ssid - SSID description
1351 * @ssid: the SSID
1352 * @ssid_len: length of the ssid
1353 */
1354 struct cfg80211_ssid {
1355 u8 ssid[IEEE80211_MAX_SSID_LEN];
1356 u8 ssid_len;
1357 };
1358
1359 /**
1360 * struct cfg80211_scan_request - scan request description
1361 *
1362 * @ssids: SSIDs to scan for (active scan only)
1363 * @n_ssids: number of SSIDs
1364 * @channels: channels to scan on.
1365 * @n_channels: total number of channels to scan
1366 * @scan_width: channel width for scanning
1367 * @ie: optional information element(s) to add into Probe Request or %NULL
1368 * @ie_len: length of ie in octets
1369 * @flags: bit field of flags controlling operation
1370 * @rates: bitmap of rates to advertise for each band
1371 * @wiphy: the wiphy this was for
1372 * @scan_start: time (in jiffies) when the scan started
1373 * @wdev: the wireless device to scan for
1374 * @aborted: (internal) scan request was notified as aborted
1375 * @notified: (internal) scan request was notified as done or aborted
1376 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1377 */
1378 struct cfg80211_scan_request {
1379 struct cfg80211_ssid *ssids;
1380 int n_ssids;
1381 u32 n_channels;
1382 enum nl80211_bss_scan_width scan_width;
1383 const u8 *ie;
1384 size_t ie_len;
1385 u32 flags;
1386
1387 u32 rates[IEEE80211_NUM_BANDS];
1388
1389 struct wireless_dev *wdev;
1390
1391 /* internal */
1392 struct wiphy *wiphy;
1393 unsigned long scan_start;
1394 bool aborted, notified;
1395 bool no_cck;
1396
1397 /* keep last */
1398 struct ieee80211_channel *channels[0];
1399 };
1400
1401 /**
1402 * struct cfg80211_match_set - sets of attributes to match
1403 *
1404 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1405 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1406 */
1407 struct cfg80211_match_set {
1408 struct cfg80211_ssid ssid;
1409 s32 rssi_thold;
1410 };
1411
1412 /**
1413 * struct cfg80211_sched_scan_request - scheduled scan request description
1414 *
1415 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1416 * @n_ssids: number of SSIDs
1417 * @n_channels: total number of channels to scan
1418 * @scan_width: channel width for scanning
1419 * @interval: interval between each scheduled scan cycle
1420 * @ie: optional information element(s) to add into Probe Request or %NULL
1421 * @ie_len: length of ie in octets
1422 * @flags: bit field of flags controlling operation
1423 * @match_sets: sets of parameters to be matched for a scan result
1424 * entry to be considered valid and to be passed to the host
1425 * (others are filtered out).
1426 * If ommited, all results are passed.
1427 * @n_match_sets: number of match sets
1428 * @wiphy: the wiphy this was for
1429 * @dev: the interface
1430 * @scan_start: start time of the scheduled scan
1431 * @channels: channels to scan
1432 * @min_rssi_thold: for drivers only supporting a single threshold, this
1433 * contains the minimum over all matchsets
1434 */
1435 struct cfg80211_sched_scan_request {
1436 struct cfg80211_ssid *ssids;
1437 int n_ssids;
1438 u32 n_channels;
1439 enum nl80211_bss_scan_width scan_width;
1440 u32 interval;
1441 const u8 *ie;
1442 size_t ie_len;
1443 u32 flags;
1444 struct cfg80211_match_set *match_sets;
1445 int n_match_sets;
1446 s32 min_rssi_thold;
1447
1448 /* internal */
1449 struct wiphy *wiphy;
1450 struct net_device *dev;
1451 unsigned long scan_start;
1452
1453 /* keep last */
1454 struct ieee80211_channel *channels[0];
1455 };
1456
1457 /**
1458 * enum cfg80211_signal_type - signal type
1459 *
1460 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1461 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1462 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1463 */
1464 enum cfg80211_signal_type {
1465 CFG80211_SIGNAL_TYPE_NONE,
1466 CFG80211_SIGNAL_TYPE_MBM,
1467 CFG80211_SIGNAL_TYPE_UNSPEC,
1468 };
1469
1470 /**
1471 * struct cfg80211_bss_ie_data - BSS entry IE data
1472 * @tsf: TSF contained in the frame that carried these IEs
1473 * @rcu_head: internal use, for freeing
1474 * @len: length of the IEs
1475 * @data: IE data
1476 */
1477 struct cfg80211_bss_ies {
1478 u64 tsf;
1479 struct rcu_head rcu_head;
1480 int len;
1481 u8 data[];
1482 };
1483
1484 /**
1485 * struct cfg80211_bss - BSS description
1486 *
1487 * This structure describes a BSS (which may also be a mesh network)
1488 * for use in scan results and similar.
1489 *
1490 * @channel: channel this BSS is on
1491 * @scan_width: width of the control channel
1492 * @bssid: BSSID of the BSS
1493 * @beacon_interval: the beacon interval as from the frame
1494 * @capability: the capability field in host byte order
1495 * @ies: the information elements (Note that there is no guarantee that these
1496 * are well-formed!); this is a pointer to either the beacon_ies or
1497 * proberesp_ies depending on whether Probe Response frame has been
1498 * received. It is always non-%NULL.
1499 * @beacon_ies: the information elements from the last Beacon frame
1500 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1501 * own the beacon_ies, but they're just pointers to the ones from the
1502 * @hidden_beacon_bss struct)
1503 * @proberesp_ies: the information elements from the last Probe Response frame
1504 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1505 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1506 * that holds the beacon data. @beacon_ies is still valid, of course, and
1507 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1508 * @signal: signal strength value (type depends on the wiphy's signal_type)
1509 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1510 */
1511 struct cfg80211_bss {
1512 struct ieee80211_channel *channel;
1513 enum nl80211_bss_scan_width scan_width;
1514
1515 const struct cfg80211_bss_ies __rcu *ies;
1516 const struct cfg80211_bss_ies __rcu *beacon_ies;
1517 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1518
1519 struct cfg80211_bss *hidden_beacon_bss;
1520
1521 s32 signal;
1522
1523 u16 beacon_interval;
1524 u16 capability;
1525
1526 u8 bssid[ETH_ALEN];
1527
1528 u8 priv[0] __aligned(sizeof(void *));
1529 };
1530
1531 /**
1532 * ieee80211_bss_get_ie - find IE with given ID
1533 * @bss: the bss to search
1534 * @ie: the IE ID
1535 *
1536 * Note that the return value is an RCU-protected pointer, so
1537 * rcu_read_lock() must be held when calling this function.
1538 * Return: %NULL if not found.
1539 */
1540 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1541
1542
1543 /**
1544 * struct cfg80211_auth_request - Authentication request data
1545 *
1546 * This structure provides information needed to complete IEEE 802.11
1547 * authentication.
1548 *
1549 * @bss: The BSS to authenticate with, the callee must obtain a reference
1550 * to it if it needs to keep it.
1551 * @auth_type: Authentication type (algorithm)
1552 * @ie: Extra IEs to add to Authentication frame or %NULL
1553 * @ie_len: Length of ie buffer in octets
1554 * @key_len: length of WEP key for shared key authentication
1555 * @key_idx: index of WEP key for shared key authentication
1556 * @key: WEP key for shared key authentication
1557 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1558 * Authentication transaction sequence number field.
1559 * @sae_data_len: Length of sae_data buffer in octets
1560 */
1561 struct cfg80211_auth_request {
1562 struct cfg80211_bss *bss;
1563 const u8 *ie;
1564 size_t ie_len;
1565 enum nl80211_auth_type auth_type;
1566 const u8 *key;
1567 u8 key_len, key_idx;
1568 const u8 *sae_data;
1569 size_t sae_data_len;
1570 };
1571
1572 /**
1573 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1574 *
1575 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1576 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1577 */
1578 enum cfg80211_assoc_req_flags {
1579 ASSOC_REQ_DISABLE_HT = BIT(0),
1580 ASSOC_REQ_DISABLE_VHT = BIT(1),
1581 };
1582
1583 /**
1584 * struct cfg80211_assoc_request - (Re)Association request data
1585 *
1586 * This structure provides information needed to complete IEEE 802.11
1587 * (re)association.
1588 * @bss: The BSS to associate with. If the call is successful the driver is
1589 * given a reference that it must give back to cfg80211_send_rx_assoc()
1590 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1591 * association requests while already associating must be rejected.
1592 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1593 * @ie_len: Length of ie buffer in octets
1594 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1595 * @crypto: crypto settings
1596 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1597 * @flags: See &enum cfg80211_assoc_req_flags
1598 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1599 * will be used in ht_capa. Un-supported values will be ignored.
1600 * @ht_capa_mask: The bits of ht_capa which are to be used.
1601 * @vht_capa: VHT capability override
1602 * @vht_capa_mask: VHT capability mask indicating which fields to use
1603 */
1604 struct cfg80211_assoc_request {
1605 struct cfg80211_bss *bss;
1606 const u8 *ie, *prev_bssid;
1607 size_t ie_len;
1608 struct cfg80211_crypto_settings crypto;
1609 bool use_mfp;
1610 u32 flags;
1611 struct ieee80211_ht_cap ht_capa;
1612 struct ieee80211_ht_cap ht_capa_mask;
1613 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1614 };
1615
1616 /**
1617 * struct cfg80211_deauth_request - Deauthentication request data
1618 *
1619 * This structure provides information needed to complete IEEE 802.11
1620 * deauthentication.
1621 *
1622 * @bssid: the BSSID of the BSS to deauthenticate from
1623 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1624 * @ie_len: Length of ie buffer in octets
1625 * @reason_code: The reason code for the deauthentication
1626 * @local_state_change: if set, change local state only and
1627 * do not set a deauth frame
1628 */
1629 struct cfg80211_deauth_request {
1630 const u8 *bssid;
1631 const u8 *ie;
1632 size_t ie_len;
1633 u16 reason_code;
1634 bool local_state_change;
1635 };
1636
1637 /**
1638 * struct cfg80211_disassoc_request - Disassociation request data
1639 *
1640 * This structure provides information needed to complete IEEE 802.11
1641 * disassocation.
1642 *
1643 * @bss: the BSS to disassociate from
1644 * @ie: Extra IEs to add to Disassociation frame or %NULL
1645 * @ie_len: Length of ie buffer in octets
1646 * @reason_code: The reason code for the disassociation
1647 * @local_state_change: This is a request for a local state only, i.e., no
1648 * Disassociation frame is to be transmitted.
1649 */
1650 struct cfg80211_disassoc_request {
1651 struct cfg80211_bss *bss;
1652 const u8 *ie;
1653 size_t ie_len;
1654 u16 reason_code;
1655 bool local_state_change;
1656 };
1657
1658 /**
1659 * struct cfg80211_ibss_params - IBSS parameters
1660 *
1661 * This structure defines the IBSS parameters for the join_ibss()
1662 * method.
1663 *
1664 * @ssid: The SSID, will always be non-null.
1665 * @ssid_len: The length of the SSID, will always be non-zero.
1666 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1667 * search for IBSSs with a different BSSID.
1668 * @chandef: defines the channel to use if no other IBSS to join can be found
1669 * @channel_fixed: The channel should be fixed -- do not search for
1670 * IBSSs to join on other channels.
1671 * @ie: information element(s) to include in the beacon
1672 * @ie_len: length of that
1673 * @beacon_interval: beacon interval to use
1674 * @privacy: this is a protected network, keys will be configured
1675 * after joining
1676 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1677 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1678 * required to assume that the port is unauthorized until authorized by
1679 * user space. Otherwise, port is marked authorized by default.
1680 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1681 * changes the channel when a radar is detected. This is required
1682 * to operate on DFS channels.
1683 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1684 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1685 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1686 * will be used in ht_capa. Un-supported values will be ignored.
1687 * @ht_capa_mask: The bits of ht_capa which are to be used.
1688 */
1689 struct cfg80211_ibss_params {
1690 u8 *ssid;
1691 u8 *bssid;
1692 struct cfg80211_chan_def chandef;
1693 u8 *ie;
1694 u8 ssid_len, ie_len;
1695 u16 beacon_interval;
1696 u32 basic_rates;
1697 bool channel_fixed;
1698 bool privacy;
1699 bool control_port;
1700 bool userspace_handles_dfs;
1701 int mcast_rate[IEEE80211_NUM_BANDS];
1702 struct ieee80211_ht_cap ht_capa;
1703 struct ieee80211_ht_cap ht_capa_mask;
1704 };
1705
1706 /**
1707 * struct cfg80211_connect_params - Connection parameters
1708 *
1709 * This structure provides information needed to complete IEEE 802.11
1710 * authentication and association.
1711 *
1712 * @channel: The channel to use or %NULL if not specified (auto-select based
1713 * on scan results)
1714 * @channel_hint: The channel of the recommended BSS for initial connection or
1715 * %NULL if not specified
1716 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1717 * results)
1718 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1719 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1720 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1721 * to use.
1722 * @ssid: SSID
1723 * @ssid_len: Length of ssid in octets
1724 * @auth_type: Authentication type (algorithm)
1725 * @ie: IEs for association request
1726 * @ie_len: Length of assoc_ie in octets
1727 * @privacy: indicates whether privacy-enabled APs should be used
1728 * @mfp: indicate whether management frame protection is used
1729 * @crypto: crypto settings
1730 * @key_len: length of WEP key for shared key authentication
1731 * @key_idx: index of WEP key for shared key authentication
1732 * @key: WEP key for shared key authentication
1733 * @flags: See &enum cfg80211_assoc_req_flags
1734 * @bg_scan_period: Background scan period in seconds
1735 * or -1 to indicate that default value is to be used.
1736 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1737 * will be used in ht_capa. Un-supported values will be ignored.
1738 * @ht_capa_mask: The bits of ht_capa which are to be used.
1739 * @vht_capa: VHT Capability overrides
1740 * @vht_capa_mask: The bits of vht_capa which are to be used.
1741 */
1742 struct cfg80211_connect_params {
1743 struct ieee80211_channel *channel;
1744 struct ieee80211_channel *channel_hint;
1745 const u8 *bssid;
1746 const u8 *bssid_hint;
1747 const u8 *ssid;
1748 size_t ssid_len;
1749 enum nl80211_auth_type auth_type;
1750 const u8 *ie;
1751 size_t ie_len;
1752 bool privacy;
1753 enum nl80211_mfp mfp;
1754 struct cfg80211_crypto_settings crypto;
1755 const u8 *key;
1756 u8 key_len, key_idx;
1757 u32 flags;
1758 int bg_scan_period;
1759 struct ieee80211_ht_cap ht_capa;
1760 struct ieee80211_ht_cap ht_capa_mask;
1761 struct ieee80211_vht_cap vht_capa;
1762 struct ieee80211_vht_cap vht_capa_mask;
1763 };
1764
1765 /**
1766 * enum wiphy_params_flags - set_wiphy_params bitfield values
1767 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1768 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1769 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1770 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1771 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1772 */
1773 enum wiphy_params_flags {
1774 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1775 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1776 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1777 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1778 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1779 };
1780
1781 /*
1782 * cfg80211_bitrate_mask - masks for bitrate control
1783 */
1784 struct cfg80211_bitrate_mask {
1785 struct {
1786 u32 legacy;
1787 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1788 u16 vht_mcs[NL80211_VHT_NSS_MAX];
1789 enum nl80211_txrate_gi gi;
1790 } control[IEEE80211_NUM_BANDS];
1791 };
1792 /**
1793 * struct cfg80211_pmksa - PMK Security Association
1794 *
1795 * This structure is passed to the set/del_pmksa() method for PMKSA
1796 * caching.
1797 *
1798 * @bssid: The AP's BSSID.
1799 * @pmkid: The PMK material itself.
1800 */
1801 struct cfg80211_pmksa {
1802 u8 *bssid;
1803 u8 *pmkid;
1804 };
1805
1806 /**
1807 * struct cfg80211_pkt_pattern - packet pattern
1808 * @mask: bitmask where to match pattern and where to ignore bytes,
1809 * one bit per byte, in same format as nl80211
1810 * @pattern: bytes to match where bitmask is 1
1811 * @pattern_len: length of pattern (in bytes)
1812 * @pkt_offset: packet offset (in bytes)
1813 *
1814 * Internal note: @mask and @pattern are allocated in one chunk of
1815 * memory, free @mask only!
1816 */
1817 struct cfg80211_pkt_pattern {
1818 u8 *mask, *pattern;
1819 int pattern_len;
1820 int pkt_offset;
1821 };
1822
1823 /**
1824 * struct cfg80211_wowlan_tcp - TCP connection parameters
1825 *
1826 * @sock: (internal) socket for source port allocation
1827 * @src: source IP address
1828 * @dst: destination IP address
1829 * @dst_mac: destination MAC address
1830 * @src_port: source port
1831 * @dst_port: destination port
1832 * @payload_len: data payload length
1833 * @payload: data payload buffer
1834 * @payload_seq: payload sequence stamping configuration
1835 * @data_interval: interval at which to send data packets
1836 * @wake_len: wakeup payload match length
1837 * @wake_data: wakeup payload match data
1838 * @wake_mask: wakeup payload match mask
1839 * @tokens_size: length of the tokens buffer
1840 * @payload_tok: payload token usage configuration
1841 */
1842 struct cfg80211_wowlan_tcp {
1843 struct socket *sock;
1844 __be32 src, dst;
1845 u16 src_port, dst_port;
1846 u8 dst_mac[ETH_ALEN];
1847 int payload_len;
1848 const u8 *payload;
1849 struct nl80211_wowlan_tcp_data_seq payload_seq;
1850 u32 data_interval;
1851 u32 wake_len;
1852 const u8 *wake_data, *wake_mask;
1853 u32 tokens_size;
1854 /* must be last, variable member */
1855 struct nl80211_wowlan_tcp_data_token payload_tok;
1856 };
1857
1858 /**
1859 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1860 *
1861 * This structure defines the enabled WoWLAN triggers for the device.
1862 * @any: wake up on any activity -- special trigger if device continues
1863 * operating as normal during suspend
1864 * @disconnect: wake up if getting disconnected
1865 * @magic_pkt: wake up on receiving magic packet
1866 * @patterns: wake up on receiving packet matching a pattern
1867 * @n_patterns: number of patterns
1868 * @gtk_rekey_failure: wake up on GTK rekey failure
1869 * @eap_identity_req: wake up on EAP identity request packet
1870 * @four_way_handshake: wake up on 4-way handshake
1871 * @rfkill_release: wake up when rfkill is released
1872 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1873 * NULL if not configured.
1874 */
1875 struct cfg80211_wowlan {
1876 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1877 eap_identity_req, four_way_handshake,
1878 rfkill_release;
1879 struct cfg80211_pkt_pattern *patterns;
1880 struct cfg80211_wowlan_tcp *tcp;
1881 int n_patterns;
1882 };
1883
1884 /**
1885 * struct cfg80211_coalesce_rules - Coalesce rule parameters
1886 *
1887 * This structure defines coalesce rule for the device.
1888 * @delay: maximum coalescing delay in msecs.
1889 * @condition: condition for packet coalescence.
1890 * see &enum nl80211_coalesce_condition.
1891 * @patterns: array of packet patterns
1892 * @n_patterns: number of patterns
1893 */
1894 struct cfg80211_coalesce_rules {
1895 int delay;
1896 enum nl80211_coalesce_condition condition;
1897 struct cfg80211_pkt_pattern *patterns;
1898 int n_patterns;
1899 };
1900
1901 /**
1902 * struct cfg80211_coalesce - Packet coalescing settings
1903 *
1904 * This structure defines coalescing settings.
1905 * @rules: array of coalesce rules
1906 * @n_rules: number of rules
1907 */
1908 struct cfg80211_coalesce {
1909 struct cfg80211_coalesce_rules *rules;
1910 int n_rules;
1911 };
1912
1913 /**
1914 * struct cfg80211_wowlan_wakeup - wakeup report
1915 * @disconnect: woke up by getting disconnected
1916 * @magic_pkt: woke up by receiving magic packet
1917 * @gtk_rekey_failure: woke up by GTK rekey failure
1918 * @eap_identity_req: woke up by EAP identity request packet
1919 * @four_way_handshake: woke up by 4-way handshake
1920 * @rfkill_release: woke up by rfkill being released
1921 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
1922 * @packet_present_len: copied wakeup packet data
1923 * @packet_len: original wakeup packet length
1924 * @packet: The packet causing the wakeup, if any.
1925 * @packet_80211: For pattern match, magic packet and other data
1926 * frame triggers an 802.3 frame should be reported, for
1927 * disconnect due to deauth 802.11 frame. This indicates which
1928 * it is.
1929 * @tcp_match: TCP wakeup packet received
1930 * @tcp_connlost: TCP connection lost or failed to establish
1931 * @tcp_nomoretokens: TCP data ran out of tokens
1932 */
1933 struct cfg80211_wowlan_wakeup {
1934 bool disconnect, magic_pkt, gtk_rekey_failure,
1935 eap_identity_req, four_way_handshake,
1936 rfkill_release, packet_80211,
1937 tcp_match, tcp_connlost, tcp_nomoretokens;
1938 s32 pattern_idx;
1939 u32 packet_present_len, packet_len;
1940 const void *packet;
1941 };
1942
1943 /**
1944 * struct cfg80211_gtk_rekey_data - rekey data
1945 * @kek: key encryption key
1946 * @kck: key confirmation key
1947 * @replay_ctr: replay counter
1948 */
1949 struct cfg80211_gtk_rekey_data {
1950 u8 kek[NL80211_KEK_LEN];
1951 u8 kck[NL80211_KCK_LEN];
1952 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1953 };
1954
1955 /**
1956 * struct cfg80211_update_ft_ies_params - FT IE Information
1957 *
1958 * This structure provides information needed to update the fast transition IE
1959 *
1960 * @md: The Mobility Domain ID, 2 Octet value
1961 * @ie: Fast Transition IEs
1962 * @ie_len: Length of ft_ie in octets
1963 */
1964 struct cfg80211_update_ft_ies_params {
1965 u16 md;
1966 const u8 *ie;
1967 size_t ie_len;
1968 };
1969
1970 /**
1971 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
1972 *
1973 * This structure provides information needed to transmit a mgmt frame
1974 *
1975 * @chan: channel to use
1976 * @offchan: indicates wether off channel operation is required
1977 * @wait: duration for ROC
1978 * @buf: buffer to transmit
1979 * @len: buffer length
1980 * @no_cck: don't use cck rates for this frame
1981 * @dont_wait_for_ack: tells the low level not to wait for an ack
1982 */
1983 struct cfg80211_mgmt_tx_params {
1984 struct ieee80211_channel *chan;
1985 bool offchan;
1986 unsigned int wait;
1987 const u8 *buf;
1988 size_t len;
1989 bool no_cck;
1990 bool dont_wait_for_ack;
1991 };
1992
1993 /**
1994 * struct cfg80211_dscp_exception - DSCP exception
1995 *
1996 * @dscp: DSCP value that does not adhere to the user priority range definition
1997 * @up: user priority value to which the corresponding DSCP value belongs
1998 */
1999 struct cfg80211_dscp_exception {
2000 u8 dscp;
2001 u8 up;
2002 };
2003
2004 /**
2005 * struct cfg80211_dscp_range - DSCP range definition for user priority
2006 *
2007 * @low: lowest DSCP value of this user priority range, inclusive
2008 * @high: highest DSCP value of this user priority range, inclusive
2009 */
2010 struct cfg80211_dscp_range {
2011 u8 low;
2012 u8 high;
2013 };
2014
2015 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2016 #define IEEE80211_QOS_MAP_MAX_EX 21
2017 #define IEEE80211_QOS_MAP_LEN_MIN 16
2018 #define IEEE80211_QOS_MAP_LEN_MAX \
2019 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2020
2021 /**
2022 * struct cfg80211_qos_map - QoS Map Information
2023 *
2024 * This struct defines the Interworking QoS map setting for DSCP values
2025 *
2026 * @num_des: number of DSCP exceptions (0..21)
2027 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2028 * the user priority DSCP range definition
2029 * @up: DSCP range definition for a particular user priority
2030 */
2031 struct cfg80211_qos_map {
2032 u8 num_des;
2033 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2034 struct cfg80211_dscp_range up[8];
2035 };
2036
2037 /**
2038 * struct cfg80211_ops - backend description for wireless configuration
2039 *
2040 * This struct is registered by fullmac card drivers and/or wireless stacks
2041 * in order to handle configuration requests on their interfaces.
2042 *
2043 * All callbacks except where otherwise noted should return 0
2044 * on success or a negative error code.
2045 *
2046 * All operations are currently invoked under rtnl for consistency with the
2047 * wireless extensions but this is subject to reevaluation as soon as this
2048 * code is used more widely and we have a first user without wext.
2049 *
2050 * @suspend: wiphy device needs to be suspended. The variable @wow will
2051 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2052 * configured for the device.
2053 * @resume: wiphy device needs to be resumed
2054 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2055 * to call device_set_wakeup_enable() to enable/disable wakeup from
2056 * the device.
2057 *
2058 * @add_virtual_intf: create a new virtual interface with the given name,
2059 * must set the struct wireless_dev's iftype. Beware: You must create
2060 * the new netdev in the wiphy's network namespace! Returns the struct
2061 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2062 * also set the address member in the wdev.
2063 *
2064 * @del_virtual_intf: remove the virtual interface
2065 *
2066 * @change_virtual_intf: change type/configuration of virtual interface,
2067 * keep the struct wireless_dev's iftype updated.
2068 *
2069 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2070 * when adding a group key.
2071 *
2072 * @get_key: get information about the key with the given parameters.
2073 * @mac_addr will be %NULL when requesting information for a group
2074 * key. All pointers given to the @callback function need not be valid
2075 * after it returns. This function should return an error if it is
2076 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2077 *
2078 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2079 * and @key_index, return -ENOENT if the key doesn't exist.
2080 *
2081 * @set_default_key: set the default key on an interface
2082 *
2083 * @set_default_mgmt_key: set the default management frame key on an interface
2084 *
2085 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2086 *
2087 * @start_ap: Start acting in AP mode defined by the parameters.
2088 * @change_beacon: Change the beacon parameters for an access point mode
2089 * interface. This should reject the call when AP mode wasn't started.
2090 * @stop_ap: Stop being an AP, including stopping beaconing.
2091 *
2092 * @add_station: Add a new station.
2093 * @del_station: Remove a station; @mac may be NULL to remove all stations.
2094 * @change_station: Modify a given station. Note that flags changes are not much
2095 * validated in cfg80211, in particular the auth/assoc/authorized flags
2096 * might come to the driver in invalid combinations -- make sure to check
2097 * them, also against the existing state! Drivers must call
2098 * cfg80211_check_station_change() to validate the information.
2099 * @get_station: get station information for the station identified by @mac
2100 * @dump_station: dump station callback -- resume dump at index @idx
2101 *
2102 * @add_mpath: add a fixed mesh path
2103 * @del_mpath: delete a given mesh path
2104 * @change_mpath: change a given mesh path
2105 * @get_mpath: get a mesh path for the given parameters
2106 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2107 * @join_mesh: join the mesh network with the specified parameters
2108 * (invoked with the wireless_dev mutex held)
2109 * @leave_mesh: leave the current mesh network
2110 * (invoked with the wireless_dev mutex held)
2111 *
2112 * @get_mesh_config: Get the current mesh configuration
2113 *
2114 * @update_mesh_config: Update mesh parameters on a running mesh.
2115 * The mask is a bitfield which tells us which parameters to
2116 * set, and which to leave alone.
2117 *
2118 * @change_bss: Modify parameters for a given BSS.
2119 *
2120 * @set_txq_params: Set TX queue parameters
2121 *
2122 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2123 * as it doesn't implement join_mesh and needs to set the channel to
2124 * join the mesh instead.
2125 *
2126 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2127 * interfaces are active this callback should reject the configuration.
2128 * If no interfaces are active or the device is down, the channel should
2129 * be stored for when a monitor interface becomes active.
2130 *
2131 * @scan: Request to do a scan. If returning zero, the scan request is given
2132 * the driver, and will be valid until passed to cfg80211_scan_done().
2133 * For scan results, call cfg80211_inform_bss(); you can call this outside
2134 * the scan/scan_done bracket too.
2135 *
2136 * @auth: Request to authenticate with the specified peer
2137 * (invoked with the wireless_dev mutex held)
2138 * @assoc: Request to (re)associate with the specified peer
2139 * (invoked with the wireless_dev mutex held)
2140 * @deauth: Request to deauthenticate from the specified peer
2141 * (invoked with the wireless_dev mutex held)
2142 * @disassoc: Request to disassociate from the specified peer
2143 * (invoked with the wireless_dev mutex held)
2144 *
2145 * @connect: Connect to the ESS with the specified parameters. When connected,
2146 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2147 * If the connection fails for some reason, call cfg80211_connect_result()
2148 * with the status from the AP.
2149 * (invoked with the wireless_dev mutex held)
2150 * @disconnect: Disconnect from the BSS/ESS.
2151 * (invoked with the wireless_dev mutex held)
2152 *
2153 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2154 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2155 * to a merge.
2156 * (invoked with the wireless_dev mutex held)
2157 * @leave_ibss: Leave the IBSS.
2158 * (invoked with the wireless_dev mutex held)
2159 *
2160 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2161 * MESH mode)
2162 *
2163 * @set_wiphy_params: Notify that wiphy parameters have changed;
2164 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2165 * have changed. The actual parameter values are available in
2166 * struct wiphy. If returning an error, no value should be changed.
2167 *
2168 * @set_tx_power: set the transmit power according to the parameters,
2169 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2170 * wdev may be %NULL if power was set for the wiphy, and will
2171 * always be %NULL unless the driver supports per-vif TX power
2172 * (as advertised by the nl80211 feature flag.)
2173 * @get_tx_power: store the current TX power into the dbm variable;
2174 * return 0 if successful
2175 *
2176 * @set_wds_peer: set the WDS peer for a WDS interface
2177 *
2178 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2179 * functions to adjust rfkill hw state
2180 *
2181 * @dump_survey: get site survey information.
2182 *
2183 * @remain_on_channel: Request the driver to remain awake on the specified
2184 * channel for the specified duration to complete an off-channel
2185 * operation (e.g., public action frame exchange). When the driver is
2186 * ready on the requested channel, it must indicate this with an event
2187 * notification by calling cfg80211_ready_on_channel().
2188 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2189 * This allows the operation to be terminated prior to timeout based on
2190 * the duration value.
2191 * @mgmt_tx: Transmit a management frame.
2192 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2193 * frame on another channel
2194 *
2195 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2196 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2197 * used by the function, but 0 and 1 must not be touched. Additionally,
2198 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2199 * dump and return to userspace with an error, so be careful. If any data
2200 * was passed in from userspace then the data/len arguments will be present
2201 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2202 *
2203 * @set_bitrate_mask: set the bitrate mask configuration
2204 *
2205 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2206 * devices running firmwares capable of generating the (re) association
2207 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2208 * @del_pmksa: Delete a cached PMKID.
2209 * @flush_pmksa: Flush all cached PMKIDs.
2210 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2211 * allows the driver to adjust the dynamic ps timeout value.
2212 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2213 * @set_cqm_txe_config: Configure connection quality monitor TX error
2214 * thresholds.
2215 * @sched_scan_start: Tell the driver to start a scheduled scan.
2216 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2217 * call must stop the scheduled scan and be ready for starting a new one
2218 * before it returns, i.e. @sched_scan_start may be called immediately
2219 * after that again and should not fail in that case. The driver should
2220 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2221 * method returns 0.)
2222 *
2223 * @mgmt_frame_register: Notify driver that a management frame type was
2224 * registered. Note that this callback may not sleep, and cannot run
2225 * concurrently with itself.
2226 *
2227 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2228 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2229 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2230 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2231 *
2232 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2233 *
2234 * @set_ringparam: Set tx and rx ring sizes.
2235 *
2236 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2237 *
2238 * @tdls_mgmt: Transmit a TDLS management frame.
2239 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2240 *
2241 * @probe_client: probe an associated client, must return a cookie that it
2242 * later passes to cfg80211_probe_status().
2243 *
2244 * @set_noack_map: Set the NoAck Map for the TIDs.
2245 *
2246 * @get_et_sset_count: Ethtool API to get string-set count.
2247 * See @ethtool_ops.get_sset_count
2248 *
2249 * @get_et_stats: Ethtool API to get a set of u64 stats.
2250 * See @ethtool_ops.get_ethtool_stats
2251 *
2252 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2253 * and perhaps other supported types of ethtool data-sets.
2254 * See @ethtool_ops.get_strings
2255 *
2256 * @get_channel: Get the current operating channel for the virtual interface.
2257 * For monitor interfaces, it should return %NULL unless there's a single
2258 * current monitoring channel.
2259 *
2260 * @start_p2p_device: Start the given P2P device.
2261 * @stop_p2p_device: Stop the given P2P device.
2262 *
2263 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2264 * Parameters include ACL policy, an array of MAC address of stations
2265 * and the number of MAC addresses. If there is already a list in driver
2266 * this new list replaces the existing one. Driver has to clear its ACL
2267 * when number of MAC addresses entries is passed as 0. Drivers which
2268 * advertise the support for MAC based ACL have to implement this callback.
2269 *
2270 * @start_radar_detection: Start radar detection in the driver.
2271 *
2272 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2273 * driver. If the SME is in the driver/firmware, this information can be
2274 * used in building Authentication and Reassociation Request frames.
2275 *
2276 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2277 * for a given duration (milliseconds). The protocol is provided so the
2278 * driver can take the most appropriate actions.
2279 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2280 * reliability. This operation can not fail.
2281 * @set_coalesce: Set coalesce parameters.
2282 *
2283 * @channel_switch: initiate channel-switch procedure (with CSA)
2284 *
2285 * @set_qos_map: Set QoS mapping information to the driver
2286 */
2287 struct cfg80211_ops {
2288 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2289 int (*resume)(struct wiphy *wiphy);
2290 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2291
2292 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2293 const char *name,
2294 enum nl80211_iftype type,
2295 u32 *flags,
2296 struct vif_params *params);
2297 int (*del_virtual_intf)(struct wiphy *wiphy,
2298 struct wireless_dev *wdev);
2299 int (*change_virtual_intf)(struct wiphy *wiphy,
2300 struct net_device *dev,
2301 enum nl80211_iftype type, u32 *flags,
2302 struct vif_params *params);
2303
2304 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2305 u8 key_index, bool pairwise, const u8 *mac_addr,
2306 struct key_params *params);
2307 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2308 u8 key_index, bool pairwise, const u8 *mac_addr,
2309 void *cookie,
2310 void (*callback)(void *cookie, struct key_params*));
2311 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2312 u8 key_index, bool pairwise, const u8 *mac_addr);
2313 int (*set_default_key)(struct wiphy *wiphy,
2314 struct net_device *netdev,
2315 u8 key_index, bool unicast, bool multicast);
2316 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2317 struct net_device *netdev,
2318 u8 key_index);
2319
2320 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2321 struct cfg80211_ap_settings *settings);
2322 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2323 struct cfg80211_beacon_data *info);
2324 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2325
2326
2327 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2328 u8 *mac, struct station_parameters *params);
2329 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2330 u8 *mac);
2331 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2332 u8 *mac, struct station_parameters *params);
2333 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2334 u8 *mac, struct station_info *sinfo);
2335 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2336 int idx, u8 *mac, struct station_info *sinfo);
2337
2338 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2339 u8 *dst, u8 *next_hop);
2340 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2341 u8 *dst);
2342 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2343 u8 *dst, u8 *next_hop);
2344 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2345 u8 *dst, u8 *next_hop,
2346 struct mpath_info *pinfo);
2347 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2348 int idx, u8 *dst, u8 *next_hop,
2349 struct mpath_info *pinfo);
2350 int (*get_mesh_config)(struct wiphy *wiphy,
2351 struct net_device *dev,
2352 struct mesh_config *conf);
2353 int (*update_mesh_config)(struct wiphy *wiphy,
2354 struct net_device *dev, u32 mask,
2355 const struct mesh_config *nconf);
2356 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2357 const struct mesh_config *conf,
2358 const struct mesh_setup *setup);
2359 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2360
2361 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2362 struct bss_parameters *params);
2363
2364 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2365 struct ieee80211_txq_params *params);
2366
2367 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2368 struct net_device *dev,
2369 struct ieee80211_channel *chan);
2370
2371 int (*set_monitor_channel)(struct wiphy *wiphy,
2372 struct cfg80211_chan_def *chandef);
2373
2374 int (*scan)(struct wiphy *wiphy,
2375 struct cfg80211_scan_request *request);
2376
2377 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2378 struct cfg80211_auth_request *req);
2379 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2380 struct cfg80211_assoc_request *req);
2381 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2382 struct cfg80211_deauth_request *req);
2383 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2384 struct cfg80211_disassoc_request *req);
2385
2386 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2387 struct cfg80211_connect_params *sme);
2388 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2389 u16 reason_code);
2390
2391 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2392 struct cfg80211_ibss_params *params);
2393 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2394
2395 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2396 int rate[IEEE80211_NUM_BANDS]);
2397
2398 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2399
2400 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2401 enum nl80211_tx_power_setting type, int mbm);
2402 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2403 int *dbm);
2404
2405 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2406 const u8 *addr);
2407
2408 void (*rfkill_poll)(struct wiphy *wiphy);
2409
2410 #ifdef CONFIG_NL80211_TESTMODE
2411 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2412 void *data, int len);
2413 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2414 struct netlink_callback *cb,
2415 void *data, int len);
2416 #endif
2417
2418 int (*set_bitrate_mask)(struct wiphy *wiphy,
2419 struct net_device *dev,
2420 const u8 *peer,
2421 const struct cfg80211_bitrate_mask *mask);
2422
2423 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2424 int idx, struct survey_info *info);
2425
2426 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2427 struct cfg80211_pmksa *pmksa);
2428 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2429 struct cfg80211_pmksa *pmksa);
2430 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2431
2432 int (*remain_on_channel)(struct wiphy *wiphy,
2433 struct wireless_dev *wdev,
2434 struct ieee80211_channel *chan,
2435 unsigned int duration,
2436 u64 *cookie);
2437 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2438 struct wireless_dev *wdev,
2439 u64 cookie);
2440
2441 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2442 struct cfg80211_mgmt_tx_params *params,
2443 u64 *cookie);
2444 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2445 struct wireless_dev *wdev,
2446 u64 cookie);
2447
2448 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2449 bool enabled, int timeout);
2450
2451 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2452 struct net_device *dev,
2453 s32 rssi_thold, u32 rssi_hyst);
2454
2455 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2456 struct net_device *dev,
2457 u32 rate, u32 pkts, u32 intvl);
2458
2459 void (*mgmt_frame_register)(struct wiphy *wiphy,
2460 struct wireless_dev *wdev,
2461 u16 frame_type, bool reg);
2462
2463 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2464 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2465
2466 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
2467 void (*get_ringparam)(struct wiphy *wiphy,
2468 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2469
2470 int (*sched_scan_start)(struct wiphy *wiphy,
2471 struct net_device *dev,
2472 struct cfg80211_sched_scan_request *request);
2473 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2474
2475 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2476 struct cfg80211_gtk_rekey_data *data);
2477
2478 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2479 u8 *peer, u8 action_code, u8 dialog_token,
2480 u16 status_code, u32 peer_capability,
2481 const u8 *buf, size_t len);
2482 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2483 u8 *peer, enum nl80211_tdls_operation oper);
2484
2485 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2486 const u8 *peer, u64 *cookie);
2487
2488 int (*set_noack_map)(struct wiphy *wiphy,
2489 struct net_device *dev,
2490 u16 noack_map);
2491
2492 int (*get_et_sset_count)(struct wiphy *wiphy,
2493 struct net_device *dev, int sset);
2494 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
2495 struct ethtool_stats *stats, u64 *data);
2496 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
2497 u32 sset, u8 *data);
2498
2499 int (*get_channel)(struct wiphy *wiphy,
2500 struct wireless_dev *wdev,
2501 struct cfg80211_chan_def *chandef);
2502
2503 int (*start_p2p_device)(struct wiphy *wiphy,
2504 struct wireless_dev *wdev);
2505 void (*stop_p2p_device)(struct wiphy *wiphy,
2506 struct wireless_dev *wdev);
2507
2508 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2509 const struct cfg80211_acl_data *params);
2510
2511 int (*start_radar_detection)(struct wiphy *wiphy,
2512 struct net_device *dev,
2513 struct cfg80211_chan_def *chandef,
2514 u32 cac_time_ms);
2515 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2516 struct cfg80211_update_ft_ies_params *ftie);
2517 int (*crit_proto_start)(struct wiphy *wiphy,
2518 struct wireless_dev *wdev,
2519 enum nl80211_crit_proto_id protocol,
2520 u16 duration);
2521 void (*crit_proto_stop)(struct wiphy *wiphy,
2522 struct wireless_dev *wdev);
2523 int (*set_coalesce)(struct wiphy *wiphy,
2524 struct cfg80211_coalesce *coalesce);
2525
2526 int (*channel_switch)(struct wiphy *wiphy,
2527 struct net_device *dev,
2528 struct cfg80211_csa_settings *params);
2529 int (*set_qos_map)(struct wiphy *wiphy,
2530 struct net_device *dev,
2531 struct cfg80211_qos_map *qos_map);
2532 };
2533
2534 /*
2535 * wireless hardware and networking interfaces structures
2536 * and registration/helper functions
2537 */
2538
2539 /**
2540 * enum wiphy_flags - wiphy capability flags
2541 *
2542 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2543 * wiphy at all
2544 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2545 * by default -- this flag will be set depending on the kernel's default
2546 * on wiphy_new(), but can be changed by the driver if it has a good
2547 * reason to override the default
2548 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2549 * on a VLAN interface)
2550 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2551 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2552 * control port protocol ethertype. The device also honours the
2553 * control_port_no_encrypt flag.
2554 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2555 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2556 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2557 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2558 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2559 * firmware.
2560 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2561 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2562 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2563 * link setup/discovery operations internally. Setup, discovery and
2564 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2565 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2566 * used for asking the driver/firmware to perform a TDLS operation.
2567 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2568 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2569 * when there are virtual interfaces in AP mode by calling
2570 * cfg80211_report_obss_beacon().
2571 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2572 * responds to probe-requests in hardware.
2573 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2574 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2575 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2576 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2577 * beaconing mode (AP, IBSS, Mesh, ...).
2578 */
2579 enum wiphy_flags {
2580 /* use hole at 0 */
2581 /* use hole at 1 */
2582 /* use hole at 2 */
2583 WIPHY_FLAG_NETNS_OK = BIT(3),
2584 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2585 WIPHY_FLAG_4ADDR_AP = BIT(5),
2586 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2587 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2588 WIPHY_FLAG_IBSS_RSN = BIT(8),
2589 WIPHY_FLAG_MESH_AUTH = BIT(10),
2590 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2591 /* use hole at 12 */
2592 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2593 WIPHY_FLAG_AP_UAPSD = BIT(14),
2594 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2595 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2596 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2597 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2598 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2599 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2600 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2601 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2602 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2603 };
2604
2605 /**
2606 * struct ieee80211_iface_limit - limit on certain interface types
2607 * @max: maximum number of interfaces of these types
2608 * @types: interface types (bits)
2609 */
2610 struct ieee80211_iface_limit {
2611 u16 max;
2612 u16 types;
2613 };
2614
2615 /**
2616 * struct ieee80211_iface_combination - possible interface combination
2617 * @limits: limits for the given interface types
2618 * @n_limits: number of limitations
2619 * @num_different_channels: can use up to this many different channels
2620 * @max_interfaces: maximum number of interfaces in total allowed in this
2621 * group
2622 * @beacon_int_infra_match: In this combination, the beacon intervals
2623 * between infrastructure and AP types must match. This is required
2624 * only in special cases.
2625 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2626 *
2627 * With this structure the driver can describe which interface
2628 * combinations it supports concurrently.
2629 *
2630 * Examples:
2631 *
2632 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2633 *
2634 * struct ieee80211_iface_limit limits1[] = {
2635 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2636 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2637 * };
2638 * struct ieee80211_iface_combination combination1 = {
2639 * .limits = limits1,
2640 * .n_limits = ARRAY_SIZE(limits1),
2641 * .max_interfaces = 2,
2642 * .beacon_int_infra_match = true,
2643 * };
2644 *
2645 *
2646 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2647 *
2648 * struct ieee80211_iface_limit limits2[] = {
2649 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2650 * BIT(NL80211_IFTYPE_P2P_GO), },
2651 * };
2652 * struct ieee80211_iface_combination combination2 = {
2653 * .limits = limits2,
2654 * .n_limits = ARRAY_SIZE(limits2),
2655 * .max_interfaces = 8,
2656 * .num_different_channels = 1,
2657 * };
2658 *
2659 *
2660 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2661 *
2662 * This allows for an infrastructure connection and three P2P connections.
2663 *
2664 * struct ieee80211_iface_limit limits3[] = {
2665 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2666 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2667 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2668 * };
2669 * struct ieee80211_iface_combination combination3 = {
2670 * .limits = limits3,
2671 * .n_limits = ARRAY_SIZE(limits3),
2672 * .max_interfaces = 4,
2673 * .num_different_channels = 2,
2674 * };
2675 */
2676 struct ieee80211_iface_combination {
2677 const struct ieee80211_iface_limit *limits;
2678 u32 num_different_channels;
2679 u16 max_interfaces;
2680 u8 n_limits;
2681 bool beacon_int_infra_match;
2682 u8 radar_detect_widths;
2683 };
2684
2685 struct ieee80211_txrx_stypes {
2686 u16 tx, rx;
2687 };
2688
2689 /**
2690 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2691 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2692 * trigger that keeps the device operating as-is and
2693 * wakes up the host on any activity, for example a
2694 * received packet that passed filtering; note that the
2695 * packet should be preserved in that case
2696 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2697 * (see nl80211.h)
2698 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2699 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2700 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2701 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2702 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2703 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2704 */
2705 enum wiphy_wowlan_support_flags {
2706 WIPHY_WOWLAN_ANY = BIT(0),
2707 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2708 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2709 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2710 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2711 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2712 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2713 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2714 };
2715
2716 struct wiphy_wowlan_tcp_support {
2717 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2718 u32 data_payload_max;
2719 u32 data_interval_max;
2720 u32 wake_payload_max;
2721 bool seq;
2722 };
2723
2724 /**
2725 * struct wiphy_wowlan_support - WoWLAN support data
2726 * @flags: see &enum wiphy_wowlan_support_flags
2727 * @n_patterns: number of supported wakeup patterns
2728 * (see nl80211.h for the pattern definition)
2729 * @pattern_max_len: maximum length of each pattern
2730 * @pattern_min_len: minimum length of each pattern
2731 * @max_pkt_offset: maximum Rx packet offset
2732 * @tcp: TCP wakeup support information
2733 */
2734 struct wiphy_wowlan_support {
2735 u32 flags;
2736 int n_patterns;
2737 int pattern_max_len;
2738 int pattern_min_len;
2739 int max_pkt_offset;
2740 const struct wiphy_wowlan_tcp_support *tcp;
2741 };
2742
2743 /**
2744 * struct wiphy_coalesce_support - coalesce support data
2745 * @n_rules: maximum number of coalesce rules
2746 * @max_delay: maximum supported coalescing delay in msecs
2747 * @n_patterns: number of supported patterns in a rule
2748 * (see nl80211.h for the pattern definition)
2749 * @pattern_max_len: maximum length of each pattern
2750 * @pattern_min_len: minimum length of each pattern
2751 * @max_pkt_offset: maximum Rx packet offset
2752 */
2753 struct wiphy_coalesce_support {
2754 int n_rules;
2755 int max_delay;
2756 int n_patterns;
2757 int pattern_max_len;
2758 int pattern_min_len;
2759 int max_pkt_offset;
2760 };
2761
2762 /**
2763 * enum wiphy_vendor_command_flags - validation flags for vendor commands
2764 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
2765 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
2766 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
2767 * (must be combined with %_WDEV or %_NETDEV)
2768 */
2769 enum wiphy_vendor_command_flags {
2770 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
2771 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
2772 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
2773 };
2774
2775 /**
2776 * struct wiphy_vendor_command - vendor command definition
2777 * @info: vendor command identifying information, as used in nl80211
2778 * @flags: flags, see &enum wiphy_vendor_command_flags
2779 * @doit: callback for the operation, note that wdev is %NULL if the
2780 * flags didn't ask for a wdev and non-%NULL otherwise; the data
2781 * pointer may be %NULL if userspace provided no data at all
2782 */
2783 struct wiphy_vendor_command {
2784 struct nl80211_vendor_cmd_info info;
2785 u32 flags;
2786 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
2787 const void *data, int data_len);
2788 };
2789
2790 /**
2791 * struct wiphy - wireless hardware description
2792 * @reg_notifier: the driver's regulatory notification callback,
2793 * note that if your driver uses wiphy_apply_custom_regulatory()
2794 * the reg_notifier's request can be passed as NULL
2795 * @regd: the driver's regulatory domain, if one was requested via
2796 * the regulatory_hint() API. This can be used by the driver
2797 * on the reg_notifier() if it chooses to ignore future
2798 * regulatory domain changes caused by other drivers.
2799 * @signal_type: signal type reported in &struct cfg80211_bss.
2800 * @cipher_suites: supported cipher suites
2801 * @n_cipher_suites: number of supported cipher suites
2802 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2803 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2804 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2805 * -1 = fragmentation disabled, only odd values >= 256 used
2806 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2807 * @_net: the network namespace this wiphy currently lives in
2808 * @perm_addr: permanent MAC address of this device
2809 * @addr_mask: If the device supports multiple MAC addresses by masking,
2810 * set this to a mask with variable bits set to 1, e.g. if the last
2811 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
2812 * variable bits shall be determined by the interfaces added, with
2813 * interfaces not matching the mask being rejected to be brought up.
2814 * @n_addresses: number of addresses in @addresses.
2815 * @addresses: If the device has more than one address, set this pointer
2816 * to a list of addresses (6 bytes each). The first one will be used
2817 * by default for perm_addr. In this case, the mask should be set to
2818 * all-zeroes. In this case it is assumed that the device can handle
2819 * the same number of arbitrary MAC addresses.
2820 * @registered: protects ->resume and ->suspend sysfs callbacks against
2821 * unregister hardware
2822 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2823 * automatically on wiphy renames
2824 * @dev: (virtual) struct device for this wiphy
2825 * @registered: helps synchronize suspend/resume with wiphy unregister
2826 * @wext: wireless extension handlers
2827 * @priv: driver private data (sized according to wiphy_new() parameter)
2828 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2829 * must be set by driver
2830 * @iface_combinations: Valid interface combinations array, should not
2831 * list single interface types.
2832 * @n_iface_combinations: number of entries in @iface_combinations array.
2833 * @software_iftypes: bitmask of software interface types, these are not
2834 * subject to any restrictions since they are purely managed in SW.
2835 * @flags: wiphy flags, see &enum wiphy_flags
2836 * @regulatory_flags: wiphy regulatory flags, see
2837 * &enum ieee80211_regulatory_flags
2838 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2839 * @bss_priv_size: each BSS struct has private data allocated with it,
2840 * this variable determines its size
2841 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2842 * any given scan
2843 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2844 * for in any given scheduled scan
2845 * @max_match_sets: maximum number of match sets the device can handle
2846 * when performing a scheduled scan, 0 if filtering is not
2847 * supported.
2848 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2849 * add to probe request frames transmitted during a scan, must not
2850 * include fixed IEs like supported rates
2851 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2852 * scans
2853 * @coverage_class: current coverage class
2854 * @fw_version: firmware version for ethtool reporting
2855 * @hw_version: hardware version for ethtool reporting
2856 * @max_num_pmkids: maximum number of PMKIDs supported by device
2857 * @privid: a pointer that drivers can use to identify if an arbitrary
2858 * wiphy is theirs, e.g. in global notifiers
2859 * @bands: information about bands/channels supported by this device
2860 *
2861 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2862 * transmitted through nl80211, points to an array indexed by interface
2863 * type
2864 *
2865 * @available_antennas_tx: bitmap of antennas which are available to be
2866 * configured as TX antennas. Antenna configuration commands will be
2867 * rejected unless this or @available_antennas_rx is set.
2868 *
2869 * @available_antennas_rx: bitmap of antennas which are available to be
2870 * configured as RX antennas. Antenna configuration commands will be
2871 * rejected unless this or @available_antennas_tx is set.
2872 *
2873 * @probe_resp_offload:
2874 * Bitmap of supported protocols for probe response offloading.
2875 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2876 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2877 *
2878 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2879 * may request, if implemented.
2880 *
2881 * @wowlan: WoWLAN support information
2882 * @wowlan_config: current WoWLAN configuration; this should usually not be
2883 * used since access to it is necessarily racy, use the parameter passed
2884 * to the suspend() operation instead.
2885 *
2886 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2887 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2888 * If null, then none can be over-ridden.
2889 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
2890 * If null, then none can be over-ridden.
2891 *
2892 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
2893 * supports for ACL.
2894 *
2895 * @extended_capabilities: extended capabilities supported by the driver,
2896 * additional capabilities might be supported by userspace; these are
2897 * the 802.11 extended capabilities ("Extended Capabilities element")
2898 * and are in the same format as in the information element. See
2899 * 802.11-2012 8.4.2.29 for the defined fields.
2900 * @extended_capabilities_mask: mask of the valid values
2901 * @extended_capabilities_len: length of the extended capabilities
2902 * @coalesce: packet coalescing support information
2903 *
2904 * @vendor_commands: array of vendor commands supported by the hardware
2905 * @n_vendor_commands: number of vendor commands
2906 * @vendor_events: array of vendor events supported by the hardware
2907 * @n_vendor_events: number of vendor events
2908 *
2909 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
2910 * (including P2P GO) or 0 to indicate no such limit is advertised. The
2911 * driver is allowed to advertise a theoretical limit that it can reach in
2912 * some cases, but may not always reach.
2913 */
2914 struct wiphy {
2915 /* assign these fields before you register the wiphy */
2916
2917 /* permanent MAC address(es) */
2918 u8 perm_addr[ETH_ALEN];
2919 u8 addr_mask[ETH_ALEN];
2920
2921 struct mac_address *addresses;
2922
2923 const struct ieee80211_txrx_stypes *mgmt_stypes;
2924
2925 const struct ieee80211_iface_combination *iface_combinations;
2926 int n_iface_combinations;
2927 u16 software_iftypes;
2928
2929 u16 n_addresses;
2930
2931 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2932 u16 interface_modes;
2933
2934 u16 max_acl_mac_addrs;
2935
2936 u32 flags, regulatory_flags, features;
2937
2938 u32 ap_sme_capa;
2939
2940 enum cfg80211_signal_type signal_type;
2941
2942 int bss_priv_size;
2943 u8 max_scan_ssids;
2944 u8 max_sched_scan_ssids;
2945 u8 max_match_sets;
2946 u16 max_scan_ie_len;
2947 u16 max_sched_scan_ie_len;
2948
2949 int n_cipher_suites;
2950 const u32 *cipher_suites;
2951
2952 u8 retry_short;
2953 u8 retry_long;
2954 u32 frag_threshold;
2955 u32 rts_threshold;
2956 u8 coverage_class;
2957
2958 char fw_version[ETHTOOL_FWVERS_LEN];
2959 u32 hw_version;
2960
2961 #ifdef CONFIG_PM
2962 const struct wiphy_wowlan_support *wowlan;
2963 struct cfg80211_wowlan *wowlan_config;
2964 #endif
2965
2966 u16 max_remain_on_channel_duration;
2967
2968 u8 max_num_pmkids;
2969
2970 u32 available_antennas_tx;
2971 u32 available_antennas_rx;
2972
2973 /*
2974 * Bitmap of supported protocols for probe response offloading
2975 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2976 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2977 */
2978 u32 probe_resp_offload;
2979
2980 const u8 *extended_capabilities, *extended_capabilities_mask;
2981 u8 extended_capabilities_len;
2982
2983 /* If multiple wiphys are registered and you're handed e.g.
2984 * a regular netdev with assigned ieee80211_ptr, you won't
2985 * know whether it points to a wiphy your driver has registered
2986 * or not. Assign this to something global to your driver to
2987 * help determine whether you own this wiphy or not. */
2988 const void *privid;
2989
2990 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2991
2992 /* Lets us get back the wiphy on the callback */
2993 void (*reg_notifier)(struct wiphy *wiphy,
2994 struct regulatory_request *request);
2995
2996 /* fields below are read-only, assigned by cfg80211 */
2997
2998 const struct ieee80211_regdomain __rcu *regd;
2999
3000 /* the item in /sys/class/ieee80211/ points to this,
3001 * you need use set_wiphy_dev() (see below) */
3002 struct device dev;
3003
3004 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3005 bool registered;
3006
3007 /* dir in debugfs: ieee80211/<wiphyname> */
3008 struct dentry *debugfsdir;
3009
3010 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3011 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3012
3013 #ifdef CONFIG_NET_NS
3014 /* the network namespace this phy lives in currently */
3015 struct net *_net;
3016 #endif
3017
3018 #ifdef CONFIG_CFG80211_WEXT
3019 const struct iw_handler_def *wext;
3020 #endif
3021
3022 const struct wiphy_coalesce_support *coalesce;
3023
3024 const struct wiphy_vendor_command *vendor_commands;
3025 const struct nl80211_vendor_cmd_info *vendor_events;
3026 int n_vendor_commands, n_vendor_events;
3027
3028 u16 max_ap_assoc_sta;
3029
3030 char priv[0] __aligned(NETDEV_ALIGN);
3031 };
3032
3033 static inline struct net *wiphy_net(struct wiphy *wiphy)
3034 {
3035 return read_pnet(&wiphy->_net);
3036 }
3037
3038 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3039 {
3040 write_pnet(&wiphy->_net, net);
3041 }
3042
3043 /**
3044 * wiphy_priv - return priv from wiphy
3045 *
3046 * @wiphy: the wiphy whose priv pointer to return
3047 * Return: The priv of @wiphy.
3048 */
3049 static inline void *wiphy_priv(struct wiphy *wiphy)
3050 {
3051 BUG_ON(!wiphy);
3052 return &wiphy->priv;
3053 }
3054
3055 /**
3056 * priv_to_wiphy - return the wiphy containing the priv
3057 *
3058 * @priv: a pointer previously returned by wiphy_priv
3059 * Return: The wiphy of @priv.
3060 */
3061 static inline struct wiphy *priv_to_wiphy(void *priv)
3062 {
3063 BUG_ON(!priv);
3064 return container_of(priv, struct wiphy, priv);
3065 }
3066
3067 /**
3068 * set_wiphy_dev - set device pointer for wiphy
3069 *
3070 * @wiphy: The wiphy whose device to bind
3071 * @dev: The device to parent it to
3072 */
3073 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3074 {
3075 wiphy->dev.parent = dev;
3076 }
3077
3078 /**
3079 * wiphy_dev - get wiphy dev pointer
3080 *
3081 * @wiphy: The wiphy whose device struct to look up
3082 * Return: The dev of @wiphy.
3083 */
3084 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3085 {
3086 return wiphy->dev.parent;
3087 }
3088
3089 /**
3090 * wiphy_name - get wiphy name
3091 *
3092 * @wiphy: The wiphy whose name to return
3093 * Return: The name of @wiphy.
3094 */
3095 static inline const char *wiphy_name(const struct wiphy *wiphy)
3096 {
3097 return dev_name(&wiphy->dev);
3098 }
3099
3100 /**
3101 * wiphy_new - create a new wiphy for use with cfg80211
3102 *
3103 * @ops: The configuration operations for this device
3104 * @sizeof_priv: The size of the private area to allocate
3105 *
3106 * Create a new wiphy and associate the given operations with it.
3107 * @sizeof_priv bytes are allocated for private use.
3108 *
3109 * Return: A pointer to the new wiphy. This pointer must be
3110 * assigned to each netdev's ieee80211_ptr for proper operation.
3111 */
3112 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
3113
3114 /**
3115 * wiphy_register - register a wiphy with cfg80211
3116 *
3117 * @wiphy: The wiphy to register.
3118 *
3119 * Return: A non-negative wiphy index or a negative error code.
3120 */
3121 int wiphy_register(struct wiphy *wiphy);
3122
3123 /**
3124 * wiphy_unregister - deregister a wiphy from cfg80211
3125 *
3126 * @wiphy: The wiphy to unregister.
3127 *
3128 * After this call, no more requests can be made with this priv
3129 * pointer, but the call may sleep to wait for an outstanding
3130 * request that is being handled.
3131 */
3132 void wiphy_unregister(struct wiphy *wiphy);
3133
3134 /**
3135 * wiphy_free - free wiphy
3136 *
3137 * @wiphy: The wiphy to free
3138 */
3139 void wiphy_free(struct wiphy *wiphy);
3140
3141 /* internal structs */
3142 struct cfg80211_conn;
3143 struct cfg80211_internal_bss;
3144 struct cfg80211_cached_keys;
3145
3146 /**
3147 * struct wireless_dev - wireless device state
3148 *
3149 * For netdevs, this structure must be allocated by the driver
3150 * that uses the ieee80211_ptr field in struct net_device (this
3151 * is intentional so it can be allocated along with the netdev.)
3152 * It need not be registered then as netdev registration will
3153 * be intercepted by cfg80211 to see the new wireless device.
3154 *
3155 * For non-netdev uses, it must also be allocated by the driver
3156 * in response to the cfg80211 callbacks that require it, as
3157 * there's no netdev registration in that case it may not be
3158 * allocated outside of callback operations that return it.
3159 *
3160 * @wiphy: pointer to hardware description
3161 * @iftype: interface type
3162 * @list: (private) Used to collect the interfaces
3163 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3164 * @identifier: (private) Identifier used in nl80211 to identify this
3165 * wireless device if it has no netdev
3166 * @current_bss: (private) Used by the internal configuration code
3167 * @chandef: (private) Used by the internal configuration code to track
3168 * the user-set channel definition.
3169 * @preset_chandef: (private) Used by the internal configuration code to
3170 * track the channel to be used for AP later
3171 * @bssid: (private) Used by the internal configuration code
3172 * @ssid: (private) Used by the internal configuration code
3173 * @ssid_len: (private) Used by the internal configuration code
3174 * @mesh_id_len: (private) Used by the internal configuration code
3175 * @mesh_id_up_len: (private) Used by the internal configuration code
3176 * @wext: (private) Used by the internal wireless extensions compat code
3177 * @use_4addr: indicates 4addr mode is used on this interface, must be
3178 * set by driver (if supported) on add_interface BEFORE registering the
3179 * netdev and may otherwise be used by driver read-only, will be update
3180 * by cfg80211 on change_interface
3181 * @mgmt_registrations: list of registrations for management frames
3182 * @mgmt_registrations_lock: lock for the list
3183 * @mtx: mutex used to lock data in this struct, may be used by drivers
3184 * and some API functions require it held
3185 * @beacon_interval: beacon interval used on this device for transmitting
3186 * beacons, 0 when not valid
3187 * @address: The address for this device, valid only if @netdev is %NULL
3188 * @p2p_started: true if this is a P2P Device that has been started
3189 * @cac_started: true if DFS channel availability check has been started
3190 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3191 * @cac_time_ms: CAC time in ms
3192 * @ps: powersave mode is enabled
3193 * @ps_timeout: dynamic powersave timeout
3194 * @ap_unexpected_nlportid: (private) netlink port ID of application
3195 * registered for unexpected class 3 frames (AP mode)
3196 * @conn: (private) cfg80211 software SME connection state machine data
3197 * @connect_keys: (private) keys to set after connection is established
3198 * @ibss_fixed: (private) IBSS is using fixed BSSID
3199 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3200 * @event_list: (private) list for internal event processing
3201 * @event_lock: (private) lock for event list
3202 * @owner_nlportid: (private) owner socket port ID
3203 */
3204 struct wireless_dev {
3205 struct wiphy *wiphy;
3206 enum nl80211_iftype iftype;
3207
3208 /* the remainder of this struct should be private to cfg80211 */
3209 struct list_head list;
3210 struct net_device *netdev;
3211
3212 u32 identifier;
3213
3214 struct list_head mgmt_registrations;
3215 spinlock_t mgmt_registrations_lock;
3216
3217 struct mutex mtx;
3218
3219 bool use_4addr, p2p_started;
3220
3221 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3222
3223 /* currently used for IBSS and SME - might be rearranged later */
3224 u8 ssid[IEEE80211_MAX_SSID_LEN];
3225 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3226 struct cfg80211_conn *conn;
3227 struct cfg80211_cached_keys *connect_keys;
3228
3229 struct list_head event_list;
3230 spinlock_t event_lock;
3231
3232 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3233 struct cfg80211_chan_def preset_chandef;
3234 struct cfg80211_chan_def chandef;
3235
3236 bool ibss_fixed;
3237 bool ibss_dfs_possible;
3238
3239 bool ps;
3240 int ps_timeout;
3241
3242 int beacon_interval;
3243
3244 u32 ap_unexpected_nlportid;
3245
3246 bool cac_started;
3247 unsigned long cac_start_time;
3248 unsigned int cac_time_ms;
3249
3250 u32 owner_nlportid;
3251
3252 #ifdef CONFIG_CFG80211_WEXT
3253 /* wext data */
3254 struct {
3255 struct cfg80211_ibss_params ibss;
3256 struct cfg80211_connect_params connect;
3257 struct cfg80211_cached_keys *keys;
3258 u8 *ie;
3259 size_t ie_len;
3260 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3261 u8 ssid[IEEE80211_MAX_SSID_LEN];
3262 s8 default_key, default_mgmt_key;
3263 bool prev_bssid_valid;
3264 } wext;
3265 #endif
3266 };
3267
3268 static inline u8 *wdev_address(struct wireless_dev *wdev)
3269 {
3270 if (wdev->netdev)
3271 return wdev->netdev->dev_addr;
3272 return wdev->address;
3273 }
3274
3275 /**
3276 * wdev_priv - return wiphy priv from wireless_dev
3277 *
3278 * @wdev: The wireless device whose wiphy's priv pointer to return
3279 * Return: The wiphy priv of @wdev.
3280 */
3281 static inline void *wdev_priv(struct wireless_dev *wdev)
3282 {
3283 BUG_ON(!wdev);
3284 return wiphy_priv(wdev->wiphy);
3285 }
3286
3287 /**
3288 * DOC: Utility functions
3289 *
3290 * cfg80211 offers a number of utility functions that can be useful.
3291 */
3292
3293 /**
3294 * ieee80211_channel_to_frequency - convert channel number to frequency
3295 * @chan: channel number
3296 * @band: band, necessary due to channel number overlap
3297 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3298 */
3299 int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3300
3301 /**
3302 * ieee80211_frequency_to_channel - convert frequency to channel number
3303 * @freq: center frequency
3304 * Return: The corresponding channel, or 0 if the conversion failed.
3305 */
3306 int ieee80211_frequency_to_channel(int freq);
3307
3308 /*
3309 * Name indirection necessary because the ieee80211 code also has
3310 * a function named "ieee80211_get_channel", so if you include
3311 * cfg80211's header file you get cfg80211's version, if you try
3312 * to include both header files you'll (rightfully!) get a symbol
3313 * clash.
3314 */
3315 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3316 int freq);
3317 /**
3318 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3319 * @wiphy: the struct wiphy to get the channel for
3320 * @freq: the center frequency of the channel
3321 * Return: The channel struct from @wiphy at @freq.
3322 */
3323 static inline struct ieee80211_channel *
3324 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3325 {
3326 return __ieee80211_get_channel(wiphy, freq);
3327 }
3328
3329 /**
3330 * ieee80211_get_response_rate - get basic rate for a given rate
3331 *
3332 * @sband: the band to look for rates in
3333 * @basic_rates: bitmap of basic rates
3334 * @bitrate: the bitrate for which to find the basic rate
3335 *
3336 * Return: The basic rate corresponding to a given bitrate, that
3337 * is the next lower bitrate contained in the basic rate map,
3338 * which is, for this function, given as a bitmap of indices of
3339 * rates in the band's bitrate table.
3340 */
3341 struct ieee80211_rate *
3342 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3343 u32 basic_rates, int bitrate);
3344
3345 /**
3346 * ieee80211_mandatory_rates - get mandatory rates for a given band
3347 * @sband: the band to look for rates in
3348 * @scan_width: width of the control channel
3349 *
3350 * This function returns a bitmap of the mandatory rates for the given
3351 * band, bits are set according to the rate position in the bitrates array.
3352 */
3353 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3354 enum nl80211_bss_scan_width scan_width);
3355
3356 /*
3357 * Radiotap parsing functions -- for controlled injection support
3358 *
3359 * Implemented in net/wireless/radiotap.c
3360 * Documentation in Documentation/networking/radiotap-headers.txt
3361 */
3362
3363 struct radiotap_align_size {
3364 uint8_t align:4, size:4;
3365 };
3366
3367 struct ieee80211_radiotap_namespace {
3368 const struct radiotap_align_size *align_size;
3369 int n_bits;
3370 uint32_t oui;
3371 uint8_t subns;
3372 };
3373
3374 struct ieee80211_radiotap_vendor_namespaces {
3375 const struct ieee80211_radiotap_namespace *ns;
3376 int n_ns;
3377 };
3378
3379 /**
3380 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3381 * @this_arg_index: index of current arg, valid after each successful call
3382 * to ieee80211_radiotap_iterator_next()
3383 * @this_arg: pointer to current radiotap arg; it is valid after each
3384 * call to ieee80211_radiotap_iterator_next() but also after
3385 * ieee80211_radiotap_iterator_init() where it will point to
3386 * the beginning of the actual data portion
3387 * @this_arg_size: length of the current arg, for convenience
3388 * @current_namespace: pointer to the current namespace definition
3389 * (or internally %NULL if the current namespace is unknown)
3390 * @is_radiotap_ns: indicates whether the current namespace is the default
3391 * radiotap namespace or not
3392 *
3393 * @_rtheader: pointer to the radiotap header we are walking through
3394 * @_max_length: length of radiotap header in cpu byte ordering
3395 * @_arg_index: next argument index
3396 * @_arg: next argument pointer
3397 * @_next_bitmap: internal pointer to next present u32
3398 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3399 * @_vns: vendor namespace definitions
3400 * @_next_ns_data: beginning of the next namespace's data
3401 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3402 * next bitmap word
3403 *
3404 * Describes the radiotap parser state. Fields prefixed with an underscore
3405 * must not be used by users of the parser, only by the parser internally.
3406 */
3407
3408 struct ieee80211_radiotap_iterator {
3409 struct ieee80211_radiotap_header *_rtheader;
3410 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3411 const struct ieee80211_radiotap_namespace *current_namespace;
3412
3413 unsigned char *_arg, *_next_ns_data;
3414 __le32 *_next_bitmap;
3415
3416 unsigned char *this_arg;
3417 int this_arg_index;
3418 int this_arg_size;
3419
3420 int is_radiotap_ns;
3421
3422 int _max_length;
3423 int _arg_index;
3424 uint32_t _bitmap_shifter;
3425 int _reset_on_ext;
3426 };
3427
3428 int
3429 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3430 struct ieee80211_radiotap_header *radiotap_header,
3431 int max_length,
3432 const struct ieee80211_radiotap_vendor_namespaces *vns);
3433
3434 int
3435 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3436
3437
3438 extern const unsigned char rfc1042_header[6];
3439 extern const unsigned char bridge_tunnel_header[6];
3440
3441 /**
3442 * ieee80211_get_hdrlen_from_skb - get header length from data
3443 *
3444 * @skb: the frame
3445 *
3446 * Given an skb with a raw 802.11 header at the data pointer this function
3447 * returns the 802.11 header length.
3448 *
3449 * Return: The 802.11 header length in bytes (not including encryption
3450 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3451 * 802.11 header.
3452 */
3453 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3454
3455 /**
3456 * ieee80211_hdrlen - get header length in bytes from frame control
3457 * @fc: frame control field in little-endian format
3458 * Return: The header length in bytes.
3459 */
3460 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3461
3462 /**
3463 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3464 * @meshhdr: the mesh extension header, only the flags field
3465 * (first byte) will be accessed
3466 * Return: The length of the extension header, which is always at
3467 * least 6 bytes and at most 18 if address 5 and 6 are present.
3468 */
3469 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3470
3471 /**
3472 * DOC: Data path helpers
3473 *
3474 * In addition to generic utilities, cfg80211 also offers
3475 * functions that help implement the data path for devices
3476 * that do not do the 802.11/802.3 conversion on the device.
3477 */
3478
3479 /**
3480 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3481 * @skb: the 802.11 data frame
3482 * @addr: the device MAC address
3483 * @iftype: the virtual interface type
3484 * Return: 0 on success. Non-zero on error.
3485 */
3486 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3487 enum nl80211_iftype iftype);
3488
3489 /**
3490 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3491 * @skb: the 802.3 frame
3492 * @addr: the device MAC address
3493 * @iftype: the virtual interface type
3494 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3495 * @qos: build 802.11 QoS data frame
3496 * Return: 0 on success, or a negative error code.
3497 */
3498 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3499 enum nl80211_iftype iftype, u8 *bssid, bool qos);
3500
3501 /**
3502 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3503 *
3504 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3505 * 802.3 frames. The @list will be empty if the decode fails. The
3506 * @skb is consumed after the function returns.
3507 *
3508 * @skb: The input IEEE 802.11n A-MSDU frame.
3509 * @list: The output list of 802.3 frames. It must be allocated and
3510 * initialized by by the caller.
3511 * @addr: The device MAC address.
3512 * @iftype: The device interface type.
3513 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3514 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3515 */
3516 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3517 const u8 *addr, enum nl80211_iftype iftype,
3518 const unsigned int extra_headroom,
3519 bool has_80211_header);
3520
3521 /**
3522 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3523 * @skb: the data frame
3524 * @qos_map: Interworking QoS mapping or %NULL if not in use
3525 * Return: The 802.1p/1d tag.
3526 */
3527 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3528 struct cfg80211_qos_map *qos_map);
3529
3530 /**
3531 * cfg80211_find_ie - find information element in data
3532 *
3533 * @eid: element ID
3534 * @ies: data consisting of IEs
3535 * @len: length of data
3536 *
3537 * Return: %NULL if the element ID could not be found or if
3538 * the element is invalid (claims to be longer than the given
3539 * data), or a pointer to the first byte of the requested
3540 * element, that is the byte containing the element ID.
3541 *
3542 * Note: There are no checks on the element length other than
3543 * having to fit into the given data.
3544 */
3545 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3546
3547 /**
3548 * cfg80211_find_vendor_ie - find vendor specific information element in data
3549 *
3550 * @oui: vendor OUI
3551 * @oui_type: vendor-specific OUI type
3552 * @ies: data consisting of IEs
3553 * @len: length of data
3554 *
3555 * Return: %NULL if the vendor specific element ID could not be found or if the
3556 * element is invalid (claims to be longer than the given data), or a pointer to
3557 * the first byte of the requested element, that is the byte containing the
3558 * element ID.
3559 *
3560 * Note: There are no checks on the element length other than having to fit into
3561 * the given data.
3562 */
3563 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3564 const u8 *ies, int len);
3565
3566 /**
3567 * DOC: Regulatory enforcement infrastructure
3568 *
3569 * TODO
3570 */
3571
3572 /**
3573 * regulatory_hint - driver hint to the wireless core a regulatory domain
3574 * @wiphy: the wireless device giving the hint (used only for reporting
3575 * conflicts)
3576 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3577 * should be in. If @rd is set this should be NULL. Note that if you
3578 * set this to NULL you should still set rd->alpha2 to some accepted
3579 * alpha2.
3580 *
3581 * Wireless drivers can use this function to hint to the wireless core
3582 * what it believes should be the current regulatory domain by
3583 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3584 * domain should be in or by providing a completely build regulatory domain.
3585 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3586 * for a regulatory domain structure for the respective country.
3587 *
3588 * The wiphy must have been registered to cfg80211 prior to this call.
3589 * For cfg80211 drivers this means you must first use wiphy_register(),
3590 * for mac80211 drivers you must first use ieee80211_register_hw().
3591 *
3592 * Drivers should check the return value, its possible you can get
3593 * an -ENOMEM.
3594 *
3595 * Return: 0 on success. -ENOMEM.
3596 */
3597 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3598
3599 /**
3600 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3601 * @wiphy: the wireless device we want to process the regulatory domain on
3602 * @regd: the custom regulatory domain to use for this wiphy
3603 *
3604 * Drivers can sometimes have custom regulatory domains which do not apply
3605 * to a specific country. Drivers can use this to apply such custom regulatory
3606 * domains. This routine must be called prior to wiphy registration. The
3607 * custom regulatory domain will be trusted completely and as such previous
3608 * default channel settings will be disregarded. If no rule is found for a
3609 * channel on the regulatory domain the channel will be disabled.
3610 * Drivers using this for a wiphy should also set the wiphy flag
3611 * WIPHY_FLAG_CUSTOM_REGULATORY or cfg80211 will set it for the wiphy
3612 * that called this helper.
3613 */
3614 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3615 const struct ieee80211_regdomain *regd);
3616
3617 /**
3618 * freq_reg_info - get regulatory information for the given frequency
3619 * @wiphy: the wiphy for which we want to process this rule for
3620 * @center_freq: Frequency in KHz for which we want regulatory information for
3621 *
3622 * Use this function to get the regulatory rule for a specific frequency on
3623 * a given wireless device. If the device has a specific regulatory domain
3624 * it wants to follow we respect that unless a country IE has been received
3625 * and processed already.
3626 *
3627 * Return: A valid pointer, or, when an error occurs, for example if no rule
3628 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3629 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3630 * value will be -ERANGE if we determine the given center_freq does not even
3631 * have a regulatory rule for a frequency range in the center_freq's band.
3632 * See freq_in_rule_band() for our current definition of a band -- this is
3633 * purely subjective and right now it's 802.11 specific.
3634 */
3635 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3636 u32 center_freq);
3637
3638 /**
3639 * reg_initiator_name - map regulatory request initiator enum to name
3640 * @initiator: the regulatory request initiator
3641 *
3642 * You can use this to map the regulatory request initiator enum to a
3643 * proper string representation.
3644 */
3645 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3646
3647 /*
3648 * callbacks for asynchronous cfg80211 methods, notification
3649 * functions and BSS handling helpers
3650 */
3651
3652 /**
3653 * cfg80211_scan_done - notify that scan finished
3654 *
3655 * @request: the corresponding scan request
3656 * @aborted: set to true if the scan was aborted for any reason,
3657 * userspace will be notified of that
3658 */
3659 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3660
3661 /**
3662 * cfg80211_sched_scan_results - notify that new scan results are available
3663 *
3664 * @wiphy: the wiphy which got scheduled scan results
3665 */
3666 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3667
3668 /**
3669 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3670 *
3671 * @wiphy: the wiphy on which the scheduled scan stopped
3672 *
3673 * The driver can call this function to inform cfg80211 that the
3674 * scheduled scan had to be stopped, for whatever reason. The driver
3675 * is then called back via the sched_scan_stop operation when done.
3676 */
3677 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3678
3679 /**
3680 * cfg80211_inform_bss_width_frame - inform cfg80211 of a received BSS frame
3681 *
3682 * @wiphy: the wiphy reporting the BSS
3683 * @rx_channel: The channel the frame was received on
3684 * @scan_width: width of the control channel
3685 * @mgmt: the management frame (probe response or beacon)
3686 * @len: length of the management frame
3687 * @signal: the signal strength, type depends on the wiphy's signal_type
3688 * @gfp: context flags
3689 *
3690 * This informs cfg80211 that BSS information was found and
3691 * the BSS should be updated/added.
3692 *
3693 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3694 * Or %NULL on error.
3695 */
3696 struct cfg80211_bss * __must_check
3697 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
3698 struct ieee80211_channel *rx_channel,
3699 enum nl80211_bss_scan_width scan_width,
3700 struct ieee80211_mgmt *mgmt, size_t len,
3701 s32 signal, gfp_t gfp);
3702
3703 static inline struct cfg80211_bss * __must_check
3704 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3705 struct ieee80211_channel *rx_channel,
3706 struct ieee80211_mgmt *mgmt, size_t len,
3707 s32 signal, gfp_t gfp)
3708 {
3709 return cfg80211_inform_bss_width_frame(wiphy, rx_channel,
3710 NL80211_BSS_CHAN_WIDTH_20,
3711 mgmt, len, signal, gfp);
3712 }
3713
3714 /**
3715 * cfg80211_inform_bss - inform cfg80211 of a new BSS
3716 *
3717 * @wiphy: the wiphy reporting the BSS
3718 * @rx_channel: The channel the frame was received on
3719 * @scan_width: width of the control channel
3720 * @bssid: the BSSID of the BSS
3721 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3722 * @capability: the capability field sent by the peer
3723 * @beacon_interval: the beacon interval announced by the peer
3724 * @ie: additional IEs sent by the peer
3725 * @ielen: length of the additional IEs
3726 * @signal: the signal strength, type depends on the wiphy's signal_type
3727 * @gfp: context flags
3728 *
3729 * This informs cfg80211 that BSS information was found and
3730 * the BSS should be updated/added.
3731 *
3732 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3733 * Or %NULL on error.
3734 */
3735 struct cfg80211_bss * __must_check
3736 cfg80211_inform_bss_width(struct wiphy *wiphy,
3737 struct ieee80211_channel *rx_channel,
3738 enum nl80211_bss_scan_width scan_width,
3739 const u8 *bssid, u64 tsf, u16 capability,
3740 u16 beacon_interval, const u8 *ie, size_t ielen,
3741 s32 signal, gfp_t gfp);
3742
3743 static inline struct cfg80211_bss * __must_check
3744 cfg80211_inform_bss(struct wiphy *wiphy,
3745 struct ieee80211_channel *rx_channel,
3746 const u8 *bssid, u64 tsf, u16 capability,
3747 u16 beacon_interval, const u8 *ie, size_t ielen,
3748 s32 signal, gfp_t gfp)
3749 {
3750 return cfg80211_inform_bss_width(wiphy, rx_channel,
3751 NL80211_BSS_CHAN_WIDTH_20,
3752 bssid, tsf, capability,
3753 beacon_interval, ie, ielen, signal,
3754 gfp);
3755 }
3756
3757 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3758 struct ieee80211_channel *channel,
3759 const u8 *bssid,
3760 const u8 *ssid, size_t ssid_len,
3761 u16 capa_mask, u16 capa_val);
3762 static inline struct cfg80211_bss *
3763 cfg80211_get_ibss(struct wiphy *wiphy,
3764 struct ieee80211_channel *channel,
3765 const u8 *ssid, size_t ssid_len)
3766 {
3767 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3768 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3769 }
3770
3771 /**
3772 * cfg80211_ref_bss - reference BSS struct
3773 * @wiphy: the wiphy this BSS struct belongs to
3774 * @bss: the BSS struct to reference
3775 *
3776 * Increments the refcount of the given BSS struct.
3777 */
3778 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3779
3780 /**
3781 * cfg80211_put_bss - unref BSS struct
3782 * @wiphy: the wiphy this BSS struct belongs to
3783 * @bss: the BSS struct
3784 *
3785 * Decrements the refcount of the given BSS struct.
3786 */
3787 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3788
3789 /**
3790 * cfg80211_unlink_bss - unlink BSS from internal data structures
3791 * @wiphy: the wiphy
3792 * @bss: the bss to remove
3793 *
3794 * This function removes the given BSS from the internal data structures
3795 * thereby making it no longer show up in scan results etc. Use this
3796 * function when you detect a BSS is gone. Normally BSSes will also time
3797 * out, so it is not necessary to use this function at all.
3798 */
3799 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3800
3801 static inline enum nl80211_bss_scan_width
3802 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
3803 {
3804 switch (chandef->width) {
3805 case NL80211_CHAN_WIDTH_5:
3806 return NL80211_BSS_CHAN_WIDTH_5;
3807 case NL80211_CHAN_WIDTH_10:
3808 return NL80211_BSS_CHAN_WIDTH_10;
3809 default:
3810 return NL80211_BSS_CHAN_WIDTH_20;
3811 }
3812 }
3813
3814 /**
3815 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
3816 * @dev: network device
3817 * @buf: authentication frame (header + body)
3818 * @len: length of the frame data
3819 *
3820 * This function is called whenever an authentication, disassociation or
3821 * deauthentication frame has been received and processed in station mode.
3822 * After being asked to authenticate via cfg80211_ops::auth() the driver must
3823 * call either this function or cfg80211_auth_timeout().
3824 * After being asked to associate via cfg80211_ops::assoc() the driver must
3825 * call either this function or cfg80211_auth_timeout().
3826 * While connected, the driver must calls this for received and processed
3827 * disassociation and deauthentication frames. If the frame couldn't be used
3828 * because it was unprotected, the driver must call the function
3829 * cfg80211_rx_unprot_mlme_mgmt() instead.
3830 *
3831 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3832 */
3833 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
3834
3835 /**
3836 * cfg80211_auth_timeout - notification of timed out authentication
3837 * @dev: network device
3838 * @addr: The MAC address of the device with which the authentication timed out
3839 *
3840 * This function may sleep. The caller must hold the corresponding wdev's
3841 * mutex.
3842 */
3843 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
3844
3845 /**
3846 * cfg80211_rx_assoc_resp - notification of processed association response
3847 * @dev: network device
3848 * @bss: the BSS that association was requested with, ownership of the pointer
3849 * moves to cfg80211 in this call
3850 * @buf: authentication frame (header + body)
3851 * @len: length of the frame data
3852 *
3853 * After being asked to associate via cfg80211_ops::assoc() the driver must
3854 * call either this function or cfg80211_auth_timeout().
3855 *
3856 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3857 */
3858 void cfg80211_rx_assoc_resp(struct net_device *dev,
3859 struct cfg80211_bss *bss,
3860 const u8 *buf, size_t len);
3861
3862 /**
3863 * cfg80211_assoc_timeout - notification of timed out association
3864 * @dev: network device
3865 * @bss: The BSS entry with which association timed out.
3866 *
3867 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3868 */
3869 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
3870
3871 /**
3872 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
3873 * @dev: network device
3874 * @buf: 802.11 frame (header + body)
3875 * @len: length of the frame data
3876 *
3877 * This function is called whenever deauthentication has been processed in
3878 * station mode. This includes both received deauthentication frames and
3879 * locally generated ones. This function may sleep. The caller must hold the
3880 * corresponding wdev's mutex.
3881 */
3882 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
3883
3884 /**
3885 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
3886 * @dev: network device
3887 * @buf: deauthentication frame (header + body)
3888 * @len: length of the frame data
3889 *
3890 * This function is called whenever a received deauthentication or dissassoc
3891 * frame has been dropped in station mode because of MFP being used but the
3892 * frame was not protected. This function may sleep.
3893 */
3894 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
3895 const u8 *buf, size_t len);
3896
3897 /**
3898 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3899 * @dev: network device
3900 * @addr: The source MAC address of the frame
3901 * @key_type: The key type that the received frame used
3902 * @key_id: Key identifier (0..3). Can be -1 if missing.
3903 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3904 * @gfp: allocation flags
3905 *
3906 * This function is called whenever the local MAC detects a MIC failure in a
3907 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3908 * primitive.
3909 */
3910 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3911 enum nl80211_key_type key_type, int key_id,
3912 const u8 *tsc, gfp_t gfp);
3913
3914 /**
3915 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3916 *
3917 * @dev: network device
3918 * @bssid: the BSSID of the IBSS joined
3919 * @channel: the channel of the IBSS joined
3920 * @gfp: allocation flags
3921 *
3922 * This function notifies cfg80211 that the device joined an IBSS or
3923 * switched to a different BSSID. Before this function can be called,
3924 * either a beacon has to have been received from the IBSS, or one of
3925 * the cfg80211_inform_bss{,_frame} functions must have been called
3926 * with the locally generated beacon -- this guarantees that there is
3927 * always a scan result for this IBSS. cfg80211 will handle the rest.
3928 */
3929 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
3930 struct ieee80211_channel *channel, gfp_t gfp);
3931
3932 /**
3933 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3934 *
3935 * @dev: network device
3936 * @macaddr: the MAC address of the new candidate
3937 * @ie: information elements advertised by the peer candidate
3938 * @ie_len: lenght of the information elements buffer
3939 * @gfp: allocation flags
3940 *
3941 * This function notifies cfg80211 that the mesh peer candidate has been
3942 * detected, most likely via a beacon or, less likely, via a probe response.
3943 * cfg80211 then sends a notification to userspace.
3944 */
3945 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3946 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3947
3948 /**
3949 * DOC: RFkill integration
3950 *
3951 * RFkill integration in cfg80211 is almost invisible to drivers,
3952 * as cfg80211 automatically registers an rfkill instance for each
3953 * wireless device it knows about. Soft kill is also translated
3954 * into disconnecting and turning all interfaces off, drivers are
3955 * expected to turn off the device when all interfaces are down.
3956 *
3957 * However, devices may have a hard RFkill line, in which case they
3958 * also need to interact with the rfkill subsystem, via cfg80211.
3959 * They can do this with a few helper functions documented here.
3960 */
3961
3962 /**
3963 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3964 * @wiphy: the wiphy
3965 * @blocked: block status
3966 */
3967 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3968
3969 /**
3970 * wiphy_rfkill_start_polling - start polling rfkill
3971 * @wiphy: the wiphy
3972 */
3973 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3974
3975 /**
3976 * wiphy_rfkill_stop_polling - stop polling rfkill
3977 * @wiphy: the wiphy
3978 */
3979 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3980
3981 /**
3982 * DOC: Vendor commands
3983 *
3984 * Occasionally, there are special protocol or firmware features that
3985 * can't be implemented very openly. For this and similar cases, the
3986 * vendor command functionality allows implementing the features with
3987 * (typically closed-source) userspace and firmware, using nl80211 as
3988 * the configuration mechanism.
3989 *
3990 * A driver supporting vendor commands must register them as an array
3991 * in struct wiphy, with handlers for each one, each command has an
3992 * OUI and sub command ID to identify it.
3993 *
3994 * Note that this feature should not be (ab)used to implement protocol
3995 * features that could openly be shared across drivers. In particular,
3996 * it must never be required to use vendor commands to implement any
3997 * "normal" functionality that higher-level userspace like connection
3998 * managers etc. need.
3999 */
4000
4001 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4002 enum nl80211_commands cmd,
4003 enum nl80211_attrs attr,
4004 int approxlen);
4005
4006 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4007 enum nl80211_commands cmd,
4008 enum nl80211_attrs attr,
4009 int vendor_event_idx,
4010 int approxlen, gfp_t gfp);
4011
4012 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4013
4014 /**
4015 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4016 * @wiphy: the wiphy
4017 * @approxlen: an upper bound of the length of the data that will
4018 * be put into the skb
4019 *
4020 * This function allocates and pre-fills an skb for a reply to
4021 * a vendor command. Since it is intended for a reply, calling
4022 * it outside of a vendor command's doit() operation is invalid.
4023 *
4024 * The returned skb is pre-filled with some identifying data in
4025 * a way that any data that is put into the skb (with skb_put(),
4026 * nla_put() or similar) will end up being within the
4027 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4028 * with the skb is adding data for the corresponding userspace tool
4029 * which can then read that data out of the vendor data attribute.
4030 * You must not modify the skb in any other way.
4031 *
4032 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4033 * its error code as the result of the doit() operation.
4034 *
4035 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4036 */
4037 static inline struct sk_buff *
4038 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4039 {
4040 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4041 NL80211_ATTR_VENDOR_DATA, approxlen);
4042 }
4043
4044 /**
4045 * cfg80211_vendor_cmd_reply - send the reply skb
4046 * @skb: The skb, must have been allocated with
4047 * cfg80211_vendor_cmd_alloc_reply_skb()
4048 *
4049 * Since calling this function will usually be the last thing
4050 * before returning from the vendor command doit() you should
4051 * return the error code. Note that this function consumes the
4052 * skb regardless of the return value.
4053 *
4054 * Return: An error code or 0 on success.
4055 */
4056 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4057
4058 /**
4059 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4060 * @wiphy: the wiphy
4061 * @event_idx: index of the vendor event in the wiphy's vendor_events
4062 * @approxlen: an upper bound of the length of the data that will
4063 * be put into the skb
4064 * @gfp: allocation flags
4065 *
4066 * This function allocates and pre-fills an skb for an event on the
4067 * vendor-specific multicast group.
4068 *
4069 * When done filling the skb, call cfg80211_vendor_event() with the
4070 * skb to send the event.
4071 *
4072 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4073 */
4074 static inline struct sk_buff *
4075 cfg80211_vendor_event_alloc(struct wiphy *wiphy, int approxlen,
4076 int event_idx, gfp_t gfp)
4077 {
4078 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_VENDOR,
4079 NL80211_ATTR_VENDOR_DATA,
4080 event_idx, approxlen, gfp);
4081 }
4082
4083 /**
4084 * cfg80211_vendor_event - send the event
4085 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4086 * @gfp: allocation flags
4087 *
4088 * This function sends the given @skb, which must have been allocated
4089 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4090 */
4091 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4092 {
4093 __cfg80211_send_event_skb(skb, gfp);
4094 }
4095
4096 #ifdef CONFIG_NL80211_TESTMODE
4097 /**
4098 * DOC: Test mode
4099 *
4100 * Test mode is a set of utility functions to allow drivers to
4101 * interact with driver-specific tools to aid, for instance,
4102 * factory programming.
4103 *
4104 * This chapter describes how drivers interact with it, for more
4105 * information see the nl80211 book's chapter on it.
4106 */
4107
4108 /**
4109 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4110 * @wiphy: the wiphy
4111 * @approxlen: an upper bound of the length of the data that will
4112 * be put into the skb
4113 *
4114 * This function allocates and pre-fills an skb for a reply to
4115 * the testmode command. Since it is intended for a reply, calling
4116 * it outside of the @testmode_cmd operation is invalid.
4117 *
4118 * The returned skb is pre-filled with the wiphy index and set up in
4119 * a way that any data that is put into the skb (with skb_put(),
4120 * nla_put() or similar) will end up being within the
4121 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4122 * with the skb is adding data for the corresponding userspace tool
4123 * which can then read that data out of the testdata attribute. You
4124 * must not modify the skb in any other way.
4125 *
4126 * When done, call cfg80211_testmode_reply() with the skb and return
4127 * its error code as the result of the @testmode_cmd operation.
4128 *
4129 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4130 */
4131 static inline struct sk_buff *
4132 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4133 {
4134 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4135 NL80211_ATTR_TESTDATA, approxlen);
4136 }
4137
4138 /**
4139 * cfg80211_testmode_reply - send the reply skb
4140 * @skb: The skb, must have been allocated with
4141 * cfg80211_testmode_alloc_reply_skb()
4142 *
4143 * Since calling this function will usually be the last thing
4144 * before returning from the @testmode_cmd you should return
4145 * the error code. Note that this function consumes the skb
4146 * regardless of the return value.
4147 *
4148 * Return: An error code or 0 on success.
4149 */
4150 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4151 {
4152 return cfg80211_vendor_cmd_reply(skb);
4153 }
4154
4155 /**
4156 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4157 * @wiphy: the wiphy
4158 * @approxlen: an upper bound of the length of the data that will
4159 * be put into the skb
4160 * @gfp: allocation flags
4161 *
4162 * This function allocates and pre-fills an skb for an event on the
4163 * testmode multicast group.
4164 *
4165 * The returned skb is set up in the same way as with
4166 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4167 * there, you should simply add data to it that will then end up in the
4168 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4169 * in any other way.
4170 *
4171 * When done filling the skb, call cfg80211_testmode_event() with the
4172 * skb to send the event.
4173 *
4174 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4175 */
4176 static inline struct sk_buff *
4177 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4178 {
4179 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_TESTMODE,
4180 NL80211_ATTR_TESTDATA, -1,
4181 approxlen, gfp);
4182 }
4183
4184 /**
4185 * cfg80211_testmode_event - send the event
4186 * @skb: The skb, must have been allocated with
4187 * cfg80211_testmode_alloc_event_skb()
4188 * @gfp: allocation flags
4189 *
4190 * This function sends the given @skb, which must have been allocated
4191 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4192 * consumes it.
4193 */
4194 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4195 {
4196 __cfg80211_send_event_skb(skb, gfp);
4197 }
4198
4199 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4200 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4201 #else
4202 #define CFG80211_TESTMODE_CMD(cmd)
4203 #define CFG80211_TESTMODE_DUMP(cmd)
4204 #endif
4205
4206 /**
4207 * cfg80211_connect_result - notify cfg80211 of connection result
4208 *
4209 * @dev: network device
4210 * @bssid: the BSSID of the AP
4211 * @req_ie: association request IEs (maybe be %NULL)
4212 * @req_ie_len: association request IEs length
4213 * @resp_ie: association response IEs (may be %NULL)
4214 * @resp_ie_len: assoc response IEs length
4215 * @status: status code, 0 for successful connection, use
4216 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4217 * the real status code for failures.
4218 * @gfp: allocation flags
4219 *
4220 * It should be called by the underlying driver whenever connect() has
4221 * succeeded.
4222 */
4223 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4224 const u8 *req_ie, size_t req_ie_len,
4225 const u8 *resp_ie, size_t resp_ie_len,
4226 u16 status, gfp_t gfp);
4227
4228 /**
4229 * cfg80211_roamed - notify cfg80211 of roaming
4230 *
4231 * @dev: network device
4232 * @channel: the channel of the new AP
4233 * @bssid: the BSSID of the new AP
4234 * @req_ie: association request IEs (maybe be %NULL)
4235 * @req_ie_len: association request IEs length
4236 * @resp_ie: association response IEs (may be %NULL)
4237 * @resp_ie_len: assoc response IEs length
4238 * @gfp: allocation flags
4239 *
4240 * It should be called by the underlying driver whenever it roamed
4241 * from one AP to another while connected.
4242 */
4243 void cfg80211_roamed(struct net_device *dev,
4244 struct ieee80211_channel *channel,
4245 const u8 *bssid,
4246 const u8 *req_ie, size_t req_ie_len,
4247 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4248
4249 /**
4250 * cfg80211_roamed_bss - notify cfg80211 of roaming
4251 *
4252 * @dev: network device
4253 * @bss: entry of bss to which STA got roamed
4254 * @req_ie: association request IEs (maybe be %NULL)
4255 * @req_ie_len: association request IEs length
4256 * @resp_ie: association response IEs (may be %NULL)
4257 * @resp_ie_len: assoc response IEs length
4258 * @gfp: allocation flags
4259 *
4260 * This is just a wrapper to notify cfg80211 of roaming event with driver
4261 * passing bss to avoid a race in timeout of the bss entry. It should be
4262 * called by the underlying driver whenever it roamed from one AP to another
4263 * while connected. Drivers which have roaming implemented in firmware
4264 * may use this function to avoid a race in bss entry timeout where the bss
4265 * entry of the new AP is seen in the driver, but gets timed out by the time
4266 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4267 * rdev->event_work. In case of any failures, the reference is released
4268 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4269 * it will be released while diconneting from the current bss.
4270 */
4271 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4272 const u8 *req_ie, size_t req_ie_len,
4273 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4274
4275 /**
4276 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4277 *
4278 * @dev: network device
4279 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4280 * @ie_len: length of IEs
4281 * @reason: reason code for the disconnection, set it to 0 if unknown
4282 * @gfp: allocation flags
4283 *
4284 * After it calls this function, the driver should enter an idle state
4285 * and not try to connect to any AP any more.
4286 */
4287 void cfg80211_disconnected(struct net_device *dev, u16 reason,
4288 u8 *ie, size_t ie_len, gfp_t gfp);
4289
4290 /**
4291 * cfg80211_ready_on_channel - notification of remain_on_channel start
4292 * @wdev: wireless device
4293 * @cookie: the request cookie
4294 * @chan: The current channel (from remain_on_channel request)
4295 * @duration: Duration in milliseconds that the driver intents to remain on the
4296 * channel
4297 * @gfp: allocation flags
4298 */
4299 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4300 struct ieee80211_channel *chan,
4301 unsigned int duration, gfp_t gfp);
4302
4303 /**
4304 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4305 * @wdev: wireless device
4306 * @cookie: the request cookie
4307 * @chan: The current channel (from remain_on_channel request)
4308 * @gfp: allocation flags
4309 */
4310 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4311 struct ieee80211_channel *chan,
4312 gfp_t gfp);
4313
4314
4315 /**
4316 * cfg80211_new_sta - notify userspace about station
4317 *
4318 * @dev: the netdev
4319 * @mac_addr: the station's address
4320 * @sinfo: the station information
4321 * @gfp: allocation flags
4322 */
4323 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4324 struct station_info *sinfo, gfp_t gfp);
4325
4326 /**
4327 * cfg80211_del_sta - notify userspace about deletion of a station
4328 *
4329 * @dev: the netdev
4330 * @mac_addr: the station's address
4331 * @gfp: allocation flags
4332 */
4333 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
4334
4335 /**
4336 * cfg80211_conn_failed - connection request failed notification
4337 *
4338 * @dev: the netdev
4339 * @mac_addr: the station's address
4340 * @reason: the reason for connection failure
4341 * @gfp: allocation flags
4342 *
4343 * Whenever a station tries to connect to an AP and if the station
4344 * could not connect to the AP as the AP has rejected the connection
4345 * for some reasons, this function is called.
4346 *
4347 * The reason for connection failure can be any of the value from
4348 * nl80211_connect_failed_reason enum
4349 */
4350 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4351 enum nl80211_connect_failed_reason reason,
4352 gfp_t gfp);
4353
4354 /**
4355 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4356 * @wdev: wireless device receiving the frame
4357 * @freq: Frequency on which the frame was received in MHz
4358 * @sig_dbm: signal strength in mBm, or 0 if unknown
4359 * @buf: Management frame (header + body)
4360 * @len: length of the frame data
4361 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4362 * @gfp: context flags
4363 *
4364 * This function is called whenever an Action frame is received for a station
4365 * mode interface, but is not processed in kernel.
4366 *
4367 * Return: %true if a user space application has registered for this frame.
4368 * For action frames, that makes it responsible for rejecting unrecognized
4369 * action frames; %false otherwise, in which case for action frames the
4370 * driver is responsible for rejecting the frame.
4371 */
4372 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4373 const u8 *buf, size_t len, u32 flags, gfp_t gfp);
4374
4375 /**
4376 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4377 * @wdev: wireless device receiving the frame
4378 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4379 * @buf: Management frame (header + body)
4380 * @len: length of the frame data
4381 * @ack: Whether frame was acknowledged
4382 * @gfp: context flags
4383 *
4384 * This function is called whenever a management frame was requested to be
4385 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4386 * transmission attempt.
4387 */
4388 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4389 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4390
4391
4392 /**
4393 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4394 * @dev: network device
4395 * @rssi_event: the triggered RSSI event
4396 * @gfp: context flags
4397 *
4398 * This function is called when a configured connection quality monitoring
4399 * rssi threshold reached event occurs.
4400 */
4401 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4402 enum nl80211_cqm_rssi_threshold_event rssi_event,
4403 gfp_t gfp);
4404
4405 /**
4406 * cfg80211_radar_event - radar detection event
4407 * @wiphy: the wiphy
4408 * @chandef: chandef for the current channel
4409 * @gfp: context flags
4410 *
4411 * This function is called when a radar is detected on the current chanenl.
4412 */
4413 void cfg80211_radar_event(struct wiphy *wiphy,
4414 struct cfg80211_chan_def *chandef, gfp_t gfp);
4415
4416 /**
4417 * cfg80211_cac_event - Channel availability check (CAC) event
4418 * @netdev: network device
4419 * @chandef: chandef for the current channel
4420 * @event: type of event
4421 * @gfp: context flags
4422 *
4423 * This function is called when a Channel availability check (CAC) is finished
4424 * or aborted. This must be called to notify the completion of a CAC process,
4425 * also by full-MAC drivers.
4426 */
4427 void cfg80211_cac_event(struct net_device *netdev,
4428 const struct cfg80211_chan_def *chandef,
4429 enum nl80211_radar_event event, gfp_t gfp);
4430
4431
4432 /**
4433 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4434 * @dev: network device
4435 * @peer: peer's MAC address
4436 * @num_packets: how many packets were lost -- should be a fixed threshold
4437 * but probably no less than maybe 50, or maybe a throughput dependent
4438 * threshold (to account for temporary interference)
4439 * @gfp: context flags
4440 */
4441 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4442 const u8 *peer, u32 num_packets, gfp_t gfp);
4443
4444 /**
4445 * cfg80211_cqm_txe_notify - TX error rate event
4446 * @dev: network device
4447 * @peer: peer's MAC address
4448 * @num_packets: how many packets were lost
4449 * @rate: % of packets which failed transmission
4450 * @intvl: interval (in s) over which the TX failure threshold was breached.
4451 * @gfp: context flags
4452 *
4453 * Notify userspace when configured % TX failures over number of packets in a
4454 * given interval is exceeded.
4455 */
4456 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4457 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4458
4459 /**
4460 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4461 * @dev: network device
4462 * @bssid: BSSID of AP (to avoid races)
4463 * @replay_ctr: new replay counter
4464 * @gfp: allocation flags
4465 */
4466 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4467 const u8 *replay_ctr, gfp_t gfp);
4468
4469 /**
4470 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4471 * @dev: network device
4472 * @index: candidate index (the smaller the index, the higher the priority)
4473 * @bssid: BSSID of AP
4474 * @preauth: Whether AP advertises support for RSN pre-authentication
4475 * @gfp: allocation flags
4476 */
4477 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4478 const u8 *bssid, bool preauth, gfp_t gfp);
4479
4480 /**
4481 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4482 * @dev: The device the frame matched to
4483 * @addr: the transmitter address
4484 * @gfp: context flags
4485 *
4486 * This function is used in AP mode (only!) to inform userspace that
4487 * a spurious class 3 frame was received, to be able to deauth the
4488 * sender.
4489 * Return: %true if the frame was passed to userspace (or this failed
4490 * for a reason other than not having a subscription.)
4491 */
4492 bool cfg80211_rx_spurious_frame(struct net_device *dev,
4493 const u8 *addr, gfp_t gfp);
4494
4495 /**
4496 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4497 * @dev: The device the frame matched to
4498 * @addr: the transmitter address
4499 * @gfp: context flags
4500 *
4501 * This function is used in AP mode (only!) to inform userspace that
4502 * an associated station sent a 4addr frame but that wasn't expected.
4503 * It is allowed and desirable to send this event only once for each
4504 * station to avoid event flooding.
4505 * Return: %true if the frame was passed to userspace (or this failed
4506 * for a reason other than not having a subscription.)
4507 */
4508 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4509 const u8 *addr, gfp_t gfp);
4510
4511 /**
4512 * cfg80211_probe_status - notify userspace about probe status
4513 * @dev: the device the probe was sent on
4514 * @addr: the address of the peer
4515 * @cookie: the cookie filled in @probe_client previously
4516 * @acked: indicates whether probe was acked or not
4517 * @gfp: allocation flags
4518 */
4519 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4520 u64 cookie, bool acked, gfp_t gfp);
4521
4522 /**
4523 * cfg80211_report_obss_beacon - report beacon from other APs
4524 * @wiphy: The wiphy that received the beacon
4525 * @frame: the frame
4526 * @len: length of the frame
4527 * @freq: frequency the frame was received on
4528 * @sig_dbm: signal strength in mBm, or 0 if unknown
4529 *
4530 * Use this function to report to userspace when a beacon was
4531 * received. It is not useful to call this when there is no
4532 * netdev that is in AP/GO mode.
4533 */
4534 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4535 const u8 *frame, size_t len,
4536 int freq, int sig_dbm);
4537
4538 /**
4539 * cfg80211_reg_can_beacon - check if beaconing is allowed
4540 * @wiphy: the wiphy
4541 * @chandef: the channel definition
4542 * @iftype: interface type
4543 *
4544 * Return: %true if there is no secondary channel or the secondary channel(s)
4545 * can be used for beaconing (i.e. is not a radar channel etc.)
4546 */
4547 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4548 struct cfg80211_chan_def *chandef,
4549 enum nl80211_iftype iftype);
4550
4551 /*
4552 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4553 * @dev: the device which switched channels
4554 * @chandef: the new channel definition
4555 *
4556 * Caller must acquire wdev_lock, therefore must only be called from sleepable
4557 * driver context!
4558 */
4559 void cfg80211_ch_switch_notify(struct net_device *dev,
4560 struct cfg80211_chan_def *chandef);
4561
4562 /**
4563 * ieee80211_operating_class_to_band - convert operating class to band
4564 *
4565 * @operating_class: the operating class to convert
4566 * @band: band pointer to fill
4567 *
4568 * Returns %true if the conversion was successful, %false otherwise.
4569 */
4570 bool ieee80211_operating_class_to_band(u8 operating_class,
4571 enum ieee80211_band *band);
4572
4573 /*
4574 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4575 * @dev: the device on which the operation is requested
4576 * @peer: the MAC address of the peer device
4577 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4578 * NL80211_TDLS_TEARDOWN)
4579 * @reason_code: the reason code for teardown request
4580 * @gfp: allocation flags
4581 *
4582 * This function is used to request userspace to perform TDLS operation that
4583 * requires knowledge of keys, i.e., link setup or teardown when the AP
4584 * connection uses encryption. This is optional mechanism for the driver to use
4585 * if it can automatically determine when a TDLS link could be useful (e.g.,
4586 * based on traffic and signal strength for a peer).
4587 */
4588 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4589 enum nl80211_tdls_operation oper,
4590 u16 reason_code, gfp_t gfp);
4591
4592 /*
4593 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4594 * @rate: given rate_info to calculate bitrate from
4595 *
4596 * return 0 if MCS index >= 32
4597 */
4598 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4599
4600 /**
4601 * cfg80211_unregister_wdev - remove the given wdev
4602 * @wdev: struct wireless_dev to remove
4603 *
4604 * Call this function only for wdevs that have no netdev assigned,
4605 * e.g. P2P Devices. It removes the device from the list so that
4606 * it can no longer be used. It is necessary to call this function
4607 * even when cfg80211 requests the removal of the interface by
4608 * calling the del_virtual_intf() callback. The function must also
4609 * be called when the driver wishes to unregister the wdev, e.g.
4610 * when the device is unbound from the driver.
4611 *
4612 * Requires the RTNL to be held.
4613 */
4614 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4615
4616 /**
4617 * struct cfg80211_ft_event - FT Information Elements
4618 * @ies: FT IEs
4619 * @ies_len: length of the FT IE in bytes
4620 * @target_ap: target AP's MAC address
4621 * @ric_ies: RIC IE
4622 * @ric_ies_len: length of the RIC IE in bytes
4623 */
4624 struct cfg80211_ft_event_params {
4625 const u8 *ies;
4626 size_t ies_len;
4627 const u8 *target_ap;
4628 const u8 *ric_ies;
4629 size_t ric_ies_len;
4630 };
4631
4632 /**
4633 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
4634 * @netdev: network device
4635 * @ft_event: IE information
4636 */
4637 void cfg80211_ft_event(struct net_device *netdev,
4638 struct cfg80211_ft_event_params *ft_event);
4639
4640 /**
4641 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4642 * @ies: the input IE buffer
4643 * @len: the input length
4644 * @attr: the attribute ID to find
4645 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4646 * if the function is only called to get the needed buffer size
4647 * @bufsize: size of the output buffer
4648 *
4649 * The function finds a given P2P attribute in the (vendor) IEs and
4650 * copies its contents to the given buffer.
4651 *
4652 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4653 * malformed or the attribute can't be found (respectively), or the
4654 * length of the found attribute (which can be zero).
4655 */
4656 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4657 enum ieee80211_p2p_attr_id attr,
4658 u8 *buf, unsigned int bufsize);
4659
4660 /**
4661 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4662 * @wdev: the wireless device reporting the wakeup
4663 * @wakeup: the wakeup report
4664 * @gfp: allocation flags
4665 *
4666 * This function reports that the given device woke up. If it
4667 * caused the wakeup, report the reason(s), otherwise you may
4668 * pass %NULL as the @wakeup parameter to advertise that something
4669 * else caused the wakeup.
4670 */
4671 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4672 struct cfg80211_wowlan_wakeup *wakeup,
4673 gfp_t gfp);
4674
4675 /**
4676 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
4677 *
4678 * @wdev: the wireless device for which critical protocol is stopped.
4679 * @gfp: allocation flags
4680 *
4681 * This function can be called by the driver to indicate it has reverted
4682 * operation back to normal. One reason could be that the duration given
4683 * by .crit_proto_start() has expired.
4684 */
4685 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
4686
4687 /**
4688 * ieee80211_get_num_supported_channels - get number of channels device has
4689 * @wiphy: the wiphy
4690 *
4691 * Return: the number of channels supported by the device.
4692 */
4693 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
4694
4695 /* Logging, debugging and troubleshooting/diagnostic helpers. */
4696
4697 /* wiphy_printk helpers, similar to dev_printk */
4698
4699 #define wiphy_printk(level, wiphy, format, args...) \
4700 dev_printk(level, &(wiphy)->dev, format, ##args)
4701 #define wiphy_emerg(wiphy, format, args...) \
4702 dev_emerg(&(wiphy)->dev, format, ##args)
4703 #define wiphy_alert(wiphy, format, args...) \
4704 dev_alert(&(wiphy)->dev, format, ##args)
4705 #define wiphy_crit(wiphy, format, args...) \
4706 dev_crit(&(wiphy)->dev, format, ##args)
4707 #define wiphy_err(wiphy, format, args...) \
4708 dev_err(&(wiphy)->dev, format, ##args)
4709 #define wiphy_warn(wiphy, format, args...) \
4710 dev_warn(&(wiphy)->dev, format, ##args)
4711 #define wiphy_notice(wiphy, format, args...) \
4712 dev_notice(&(wiphy)->dev, format, ##args)
4713 #define wiphy_info(wiphy, format, args...) \
4714 dev_info(&(wiphy)->dev, format, ##args)
4715
4716 #define wiphy_debug(wiphy, format, args...) \
4717 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
4718
4719 #define wiphy_dbg(wiphy, format, args...) \
4720 dev_dbg(&(wiphy)->dev, format, ##args)
4721
4722 #if defined(VERBOSE_DEBUG)
4723 #define wiphy_vdbg wiphy_dbg
4724 #else
4725 #define wiphy_vdbg(wiphy, format, args...) \
4726 ({ \
4727 if (0) \
4728 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
4729 0; \
4730 })
4731 #endif
4732
4733 /*
4734 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
4735 * of using a WARN/WARN_ON to get the message out, including the
4736 * file/line information and a backtrace.
4737 */
4738 #define wiphy_WARN(wiphy, format, args...) \
4739 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
4740
4741 #endif /* __NET_CFG80211_H */