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