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