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