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 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#include <linux/netdevice.h>
14#include <linux/debugfs.h>
15#include <linux/list.h>
16#include <linux/bug.h>
17#include <linux/netlink.h>
18#include <linux/skbuff.h>
19#include <linux/nl80211.h>
20#include <linux/if_ether.h>
21#include <linux/ieee80211.h>
22#include <net/regulatory.h>
23
24/**
25 * DOC: Introduction
26 *
27 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
28 * userspace and drivers, and offers some utility functionality associated
29 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
30 * by all modern wireless drivers in Linux, so that they offer a consistent
31 * API through nl80211. For backward compatibility, cfg80211 also offers
32 * wireless extensions to userspace, but hides them from drivers completely.
33 *
34 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
35 * use restrictions.
36 */
37
38
39/**
40 * DOC: Device registration
41 *
42 * In order for a driver to use cfg80211, it must register the hardware device
43 * with cfg80211. This happens through a number of hardware capability structs
44 * described below.
45 *
46 * The fundamental structure for each device is the 'wiphy', of which each
47 * instance describes a physical wireless device connected to the system. Each
48 * such wiphy can have zero, one, or many virtual interfaces associated with
49 * it, which need to be identified as such by pointing the network interface's
50 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
51 * the wireless part of the interface, normally this struct is embedded in the
52 * network interface's private data area. Drivers can optionally allow creating
53 * or destroying virtual interfaces on the fly, but without at least one or the
54 * ability to create some the wireless device isn't useful.
55 *
56 * Each wiphy structure contains device capability information, and also has
57 * a pointer to the various operations the driver offers. The definitions and
58 * structures here describe these capabilities in detail.
59 */
60
61/*
62 * wireless hardware capability structures
63 */
64
65/**
66 * enum ieee80211_band - supported frequency bands
67 *
68 * The bands are assigned this way because the supported
69 * bitrates differ in these bands.
70 *
71 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
72 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
73 * @IEEE80211_NUM_BANDS: number of defined bands
74 */
75enum ieee80211_band {
76 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
77 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
78
79 /* keep last */
80 IEEE80211_NUM_BANDS
81};
82
83/**
84 * enum ieee80211_channel_flags - channel flags
85 *
86 * Channel flags set by the regulatory control code.
87 *
88 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
89 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
90 * on this channel.
91 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
92 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
93 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
94 * is not permitted.
95 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
96 * is not permitted.
97 */
98enum ieee80211_channel_flags {
99 IEEE80211_CHAN_DISABLED = 1<<0,
100 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
101 IEEE80211_CHAN_NO_IBSS = 1<<2,
102 IEEE80211_CHAN_RADAR = 1<<3,
103 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
104 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
105};
106
107#define IEEE80211_CHAN_NO_HT40 \
108 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
109
110/**
111 * struct ieee80211_channel - channel definition
112 *
113 * This structure describes a single channel for use
114 * with cfg80211.
115 *
116 * @center_freq: center frequency in MHz
117 * @hw_value: hardware-specific value for the channel
118 * @flags: channel flags from &enum ieee80211_channel_flags.
119 * @orig_flags: channel flags at registration time, used by regulatory
120 * code to support devices with additional restrictions
121 * @band: band this channel belongs to.
122 * @max_antenna_gain: maximum antenna gain in dBi
123 * @max_power: maximum transmission power (in dBm)
124 * @max_reg_power: maximum regulatory transmission power (in dBm)
125 * @beacon_found: helper to regulatory code to indicate when a beacon
126 * has been found on this channel. Use regulatory_hint_found_beacon()
127 * to enable this, this is useful only on 5 GHz band.
128 * @orig_mag: internal use
129 * @orig_mpwr: internal use
130 */
131struct ieee80211_channel {
132 enum ieee80211_band band;
133 u16 center_freq;
134 u16 hw_value;
135 u32 flags;
136 int max_antenna_gain;
137 int max_power;
138 int max_reg_power;
139 bool beacon_found;
140 u32 orig_flags;
141 int orig_mag, orig_mpwr;
142};
143
144/**
145 * enum ieee80211_rate_flags - rate flags
146 *
147 * Hardware/specification flags for rates. These are structured
148 * in a way that allows using the same bitrate structure for
149 * different bands/PHY modes.
150 *
151 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
152 * preamble on this bitrate; only relevant in 2.4GHz band and
153 * with CCK rates.
154 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
155 * when used with 802.11a (on the 5 GHz band); filled by the
156 * core code when registering the wiphy.
157 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
158 * when used with 802.11b (on the 2.4 GHz band); filled by the
159 * core code when registering the wiphy.
160 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
161 * when used with 802.11g (on the 2.4 GHz band); filled by the
162 * core code when registering the wiphy.
163 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
164 */
165enum ieee80211_rate_flags {
166 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
167 IEEE80211_RATE_MANDATORY_A = 1<<1,
168 IEEE80211_RATE_MANDATORY_B = 1<<2,
169 IEEE80211_RATE_MANDATORY_G = 1<<3,
170 IEEE80211_RATE_ERP_G = 1<<4,
171};
172
173/**
174 * struct ieee80211_rate - bitrate definition
175 *
176 * This structure describes a bitrate that an 802.11 PHY can
177 * operate with. The two values @hw_value and @hw_value_short
178 * are only for driver use when pointers to this structure are
179 * passed around.
180 *
181 * @flags: rate-specific flags
182 * @bitrate: bitrate in units of 100 Kbps
183 * @hw_value: driver/hardware value for this rate
184 * @hw_value_short: driver/hardware value for this rate when
185 * short preamble is used
186 */
187struct ieee80211_rate {
188 u32 flags;
189 u16 bitrate;
190 u16 hw_value, hw_value_short;
191};
192
193/**
194 * struct ieee80211_sta_ht_cap - STA's HT capabilities
195 *
196 * This structure describes most essential parameters needed
197 * to describe 802.11n HT capabilities for an STA.
198 *
199 * @ht_supported: is HT supported by the STA
200 * @cap: HT capabilities map as described in 802.11n spec
201 * @ampdu_factor: Maximum A-MPDU length factor
202 * @ampdu_density: Minimum A-MPDU spacing
203 * @mcs: Supported MCS rates
204 */
205struct ieee80211_sta_ht_cap {
206 u16 cap; /* use IEEE80211_HT_CAP_ */
207 bool ht_supported;
208 u8 ampdu_factor;
209 u8 ampdu_density;
210 struct ieee80211_mcs_info mcs;
211};
212
213/**
214 * struct ieee80211_supported_band - frequency band definition
215 *
216 * This structure describes a frequency band a wiphy
217 * is able to operate in.
218 *
219 * @channels: Array of channels the hardware can operate in
220 * in this band.
221 * @band: the band this structure represents
222 * @n_channels: Number of channels in @channels
223 * @bitrates: Array of bitrates the hardware can operate with
224 * in this band. Must be sorted to give a valid "supported
225 * rates" IE, i.e. CCK rates first, then OFDM.
226 * @n_bitrates: Number of bitrates in @bitrates
227 * @ht_cap: HT capabilities in this band
228 */
229struct ieee80211_supported_band {
230 struct ieee80211_channel *channels;
231 struct ieee80211_rate *bitrates;
232 enum ieee80211_band band;
233 int n_channels;
234 int n_bitrates;
235 struct ieee80211_sta_ht_cap ht_cap;
236};
237
238/*
239 * Wireless hardware/device configuration structures and methods
240 */
241
242/**
243 * DOC: Actions and configuration
244 *
245 * Each wireless device and each virtual interface offer a set of configuration
246 * operations and other actions that are invoked by userspace. Each of these
247 * actions is described in the operations structure, and the parameters these
248 * operations use are described separately.
249 *
250 * Additionally, some operations are asynchronous and expect to get status
251 * information via some functions that drivers need to call.
252 *
253 * Scanning and BSS list handling with its associated functionality is described
254 * in a separate chapter.
255 */
256
257/**
258 * struct vif_params - describes virtual interface parameters
259 * @use_4addr: use 4-address frames
260 */
261struct vif_params {
262 int use_4addr;
263};
264
265/**
266 * struct key_params - key information
267 *
268 * Information about a key
269 *
270 * @key: key material
271 * @key_len: length of key material
272 * @cipher: cipher suite selector
273 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
274 * with the get_key() callback, must be in little endian,
275 * length given by @seq_len.
276 * @seq_len: length of @seq.
277 */
278struct key_params {
279 u8 *key;
280 u8 *seq;
281 int key_len;
282 int seq_len;
283 u32 cipher;
284};
285
286/**
287 * enum survey_info_flags - survey information flags
288 *
289 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
290 * @SURVEY_INFO_IN_USE: channel is currently being used
291 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
292 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
293 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
294 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
295 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
296 *
297 * Used by the driver to indicate which info in &struct survey_info
298 * it has filled in during the get_survey().
299 */
300enum survey_info_flags {
301 SURVEY_INFO_NOISE_DBM = 1<<0,
302 SURVEY_INFO_IN_USE = 1<<1,
303 SURVEY_INFO_CHANNEL_TIME = 1<<2,
304 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
305 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
306 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
307 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
308};
309
310/**
311 * struct survey_info - channel survey response
312 *
313 * @channel: the channel this survey record reports, mandatory
314 * @filled: bitflag of flags from &enum survey_info_flags
315 * @noise: channel noise in dBm. This and all following fields are
316 * optional
317 * @channel_time: amount of time in ms the radio spent on the channel
318 * @channel_time_busy: amount of time the primary channel was sensed busy
319 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
320 * @channel_time_rx: amount of time the radio spent receiving data
321 * @channel_time_tx: amount of time the radio spent transmitting data
322 *
323 * Used by dump_survey() to report back per-channel survey information.
324 *
325 * This structure can later be expanded with things like
326 * channel duty cycle etc.
327 */
328struct survey_info {
329 struct ieee80211_channel *channel;
330 u64 channel_time;
331 u64 channel_time_busy;
332 u64 channel_time_ext_busy;
333 u64 channel_time_rx;
334 u64 channel_time_tx;
335 u32 filled;
336 s8 noise;
337};
338
339/**
340 * struct cfg80211_crypto_settings - Crypto settings
341 * @wpa_versions: indicates which, if any, WPA versions are enabled
342 * (from enum nl80211_wpa_versions)
343 * @cipher_group: group key cipher suite (or 0 if unset)
344 * @n_ciphers_pairwise: number of AP supported unicast ciphers
345 * @ciphers_pairwise: unicast key cipher suites
346 * @n_akm_suites: number of AKM suites
347 * @akm_suites: AKM suites
348 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
349 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
350 * required to assume that the port is unauthorized until authorized by
351 * user space. Otherwise, port is marked authorized by default.
352 * @control_port_ethertype: the control port protocol that should be
353 * allowed through even on unauthorized ports
354 * @control_port_no_encrypt: TRUE to prevent encryption of control port
355 * protocol frames.
356 */
357struct cfg80211_crypto_settings {
358 u32 wpa_versions;
359 u32 cipher_group;
360 int n_ciphers_pairwise;
361 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
362 int n_akm_suites;
363 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
364 bool control_port;
365 __be16 control_port_ethertype;
366 bool control_port_no_encrypt;
367};
368
369/**
370 * struct cfg80211_beacon_data - beacon data
371 * @head: head portion of beacon (before TIM IE)
372 * or %NULL if not changed
373 * @tail: tail portion of beacon (after TIM IE)
374 * or %NULL if not changed
375 * @head_len: length of @head
376 * @tail_len: length of @tail
377 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
378 * @beacon_ies_len: length of beacon_ies in octets
379 * @proberesp_ies: extra information element(s) to add into Probe Response
380 * frames or %NULL
381 * @proberesp_ies_len: length of proberesp_ies in octets
382 * @assocresp_ies: extra information element(s) to add into (Re)Association
383 * Response frames or %NULL
384 * @assocresp_ies_len: length of assocresp_ies in octets
385 * @probe_resp_len: length of probe response template (@probe_resp)
386 * @probe_resp: probe response template (AP mode only)
387 */
388struct cfg80211_beacon_data {
389 const u8 *head, *tail;
390 const u8 *beacon_ies;
391 const u8 *proberesp_ies;
392 const u8 *assocresp_ies;
393 const u8 *probe_resp;
394
395 size_t head_len, tail_len;
396 size_t beacon_ies_len;
397 size_t proberesp_ies_len;
398 size_t assocresp_ies_len;
399 size_t probe_resp_len;
400};
401
402/**
403 * struct cfg80211_ap_settings - AP configuration
404 *
405 * Used to configure an AP interface.
406 *
407 * @beacon: beacon data
408 * @beacon_interval: beacon interval
409 * @dtim_period: DTIM period
410 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
411 * user space)
412 * @ssid_len: length of @ssid
413 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
414 * @crypto: crypto settings
415 * @privacy: the BSS uses privacy
416 * @auth_type: Authentication type (algorithm)
417 * @inactivity_timeout: time in seconds to determine station's inactivity.
418 */
419struct cfg80211_ap_settings {
420 struct cfg80211_beacon_data beacon;
421
422 int beacon_interval, dtim_period;
423 const u8 *ssid;
424 size_t ssid_len;
425 enum nl80211_hidden_ssid hidden_ssid;
426 struct cfg80211_crypto_settings crypto;
427 bool privacy;
428 enum nl80211_auth_type auth_type;
429 int inactivity_timeout;
430};
431
432/**
433 * enum plink_action - actions to perform in mesh peers
434 *
435 * @PLINK_ACTION_INVALID: action 0 is reserved
436 * @PLINK_ACTION_OPEN: start mesh peer link establishment
437 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
438 */
439enum plink_actions {
440 PLINK_ACTION_INVALID,
441 PLINK_ACTION_OPEN,
442 PLINK_ACTION_BLOCK,
443};
444
445/**
446 * enum station_parameters_apply_mask - station parameter values to apply
447 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
448 *
449 * Not all station parameters have in-band "no change" signalling,
450 * for those that don't these flags will are used.
451 */
452enum station_parameters_apply_mask {
453 STATION_PARAM_APPLY_UAPSD = BIT(0),
454};
455
456/**
457 * struct station_parameters - station parameters
458 *
459 * Used to change and create a new station.
460 *
461 * @vlan: vlan interface station should belong to
462 * @supported_rates: supported rates in IEEE 802.11 format
463 * (or NULL for no change)
464 * @supported_rates_len: number of supported rates
465 * @sta_flags_mask: station flags that changed
466 * (bitmask of BIT(NL80211_STA_FLAG_...))
467 * @sta_flags_set: station flags values
468 * (bitmask of BIT(NL80211_STA_FLAG_...))
469 * @listen_interval: listen interval or -1 for no change
470 * @aid: AID or zero for no change
471 * @plink_action: plink action to take
472 * @plink_state: set the peer link state for a station
473 * @ht_capa: HT capabilities of station
474 * @uapsd_queues: bitmap of queues configured for uapsd. same format
475 * as the AC bitmap in the QoS info field
476 * @max_sp: max Service Period. same format as the MAX_SP in the
477 * QoS info field (but already shifted down)
478 * @sta_modify_mask: bitmap indicating which parameters changed
479 * (for those that don't have a natural "no change" value),
480 * see &enum station_parameters_apply_mask
481 */
482struct station_parameters {
483 u8 *supported_rates;
484 struct net_device *vlan;
485 u32 sta_flags_mask, sta_flags_set;
486 u32 sta_modify_mask;
487 int listen_interval;
488 u16 aid;
489 u8 supported_rates_len;
490 u8 plink_action;
491 u8 plink_state;
492 struct ieee80211_ht_cap *ht_capa;
493 u8 uapsd_queues;
494 u8 max_sp;
495};
496
497/**
498 * enum station_info_flags - station information flags
499 *
500 * Used by the driver to indicate which info in &struct station_info
501 * it has filled in during get_station() or dump_station().
502 *
503 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
504 * @STATION_INFO_RX_BYTES: @rx_bytes filled
505 * @STATION_INFO_TX_BYTES: @tx_bytes filled
506 * @STATION_INFO_LLID: @llid filled
507 * @STATION_INFO_PLID: @plid filled
508 * @STATION_INFO_PLINK_STATE: @plink_state filled
509 * @STATION_INFO_SIGNAL: @signal filled
510 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
511 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
512 * @STATION_INFO_RX_PACKETS: @rx_packets filled
513 * @STATION_INFO_TX_PACKETS: @tx_packets filled
514 * @STATION_INFO_TX_RETRIES: @tx_retries filled
515 * @STATION_INFO_TX_FAILED: @tx_failed filled
516 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
517 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
518 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
519 * @STATION_INFO_BSS_PARAM: @bss_param filled
520 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
521 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
522 * @STATION_INFO_STA_FLAGS: @sta_flags filled
523 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
524 * @STATION_INFO_T_OFFSET: @t_offset filled
525 */
526enum station_info_flags {
527 STATION_INFO_INACTIVE_TIME = 1<<0,
528 STATION_INFO_RX_BYTES = 1<<1,
529 STATION_INFO_TX_BYTES = 1<<2,
530 STATION_INFO_LLID = 1<<3,
531 STATION_INFO_PLID = 1<<4,
532 STATION_INFO_PLINK_STATE = 1<<5,
533 STATION_INFO_SIGNAL = 1<<6,
534 STATION_INFO_TX_BITRATE = 1<<7,
535 STATION_INFO_RX_PACKETS = 1<<8,
536 STATION_INFO_TX_PACKETS = 1<<9,
537 STATION_INFO_TX_RETRIES = 1<<10,
538 STATION_INFO_TX_FAILED = 1<<11,
539 STATION_INFO_RX_DROP_MISC = 1<<12,
540 STATION_INFO_SIGNAL_AVG = 1<<13,
541 STATION_INFO_RX_BITRATE = 1<<14,
542 STATION_INFO_BSS_PARAM = 1<<15,
543 STATION_INFO_CONNECTED_TIME = 1<<16,
544 STATION_INFO_ASSOC_REQ_IES = 1<<17,
545 STATION_INFO_STA_FLAGS = 1<<18,
546 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
547 STATION_INFO_T_OFFSET = 1<<20,
548};
549
550/**
551 * enum station_info_rate_flags - bitrate info flags
552 *
553 * Used by the driver to indicate the specific rate transmission
554 * type for 802.11n transmissions.
555 *
556 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
557 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
558 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
559 */
560enum rate_info_flags {
561 RATE_INFO_FLAGS_MCS = 1<<0,
562 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
563 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
564};
565
566/**
567 * struct rate_info - bitrate information
568 *
569 * Information about a receiving or transmitting bitrate
570 *
571 * @flags: bitflag of flags from &enum rate_info_flags
572 * @mcs: mcs index if struct describes a 802.11n bitrate
573 * @legacy: bitrate in 100kbit/s for 802.11abg
574 */
575struct rate_info {
576 u8 flags;
577 u8 mcs;
578 u16 legacy;
579};
580
581/**
582 * enum station_info_rate_flags - bitrate info flags
583 *
584 * Used by the driver to indicate the specific rate transmission
585 * type for 802.11n transmissions.
586 *
587 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
588 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
589 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
590 */
591enum bss_param_flags {
592 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
593 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
594 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
595};
596
597/**
598 * struct sta_bss_parameters - BSS parameters for the attached station
599 *
600 * Information about the currently associated BSS
601 *
602 * @flags: bitflag of flags from &enum bss_param_flags
603 * @dtim_period: DTIM period for the BSS
604 * @beacon_interval: beacon interval
605 */
606struct sta_bss_parameters {
607 u8 flags;
608 u8 dtim_period;
609 u16 beacon_interval;
610};
611
612/**
613 * struct station_info - station information
614 *
615 * Station information filled by driver for get_station() and dump_station.
616 *
617 * @filled: bitflag of flags from &enum station_info_flags
618 * @connected_time: time(in secs) since a station is last connected
619 * @inactive_time: time since last station activity (tx/rx) in milliseconds
620 * @rx_bytes: bytes received from this station
621 * @tx_bytes: bytes transmitted to this station
622 * @llid: mesh local link id
623 * @plid: mesh peer link id
624 * @plink_state: mesh peer link state
625 * @signal: the signal strength, type depends on the wiphy's signal_type
626 NOTE: For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
627 * @signal_avg: avg signal strength, type depends on the wiphy's signal_type
628 NOTE: For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
629 * @txrate: current unicast bitrate from this station
630 * @rxrate: current unicast bitrate to this station
631 * @rx_packets: packets received from this station
632 * @tx_packets: packets transmitted to this station
633 * @tx_retries: cumulative retry counts
634 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
635 * @rx_dropped_misc: Dropped for un-specified reason.
636 * @bss_param: current BSS parameters
637 * @generation: generation number for nl80211 dumps.
638 * This number should increase every time the list of stations
639 * changes, i.e. when a station is added or removed, so that
640 * userspace can tell whether it got a consistent snapshot.
641 * @assoc_req_ies: IEs from (Re)Association Request.
642 * This is used only when in AP mode with drivers that do not use
643 * user space MLME/SME implementation. The information is provided for
644 * the cfg80211_new_sta() calls to notify user space of the IEs.
645 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
646 * @sta_flags: station flags mask & values
647 * @beacon_loss_count: Number of times beacon loss event has triggered.
648 * @t_offset: Time offset of the station relative to this host.
649 */
650struct station_info {
651 u32 filled;
652 u32 connected_time;
653 u32 inactive_time;
654 u32 rx_bytes;
655 u32 tx_bytes;
656 u16 llid;
657 u16 plid;
658 u8 plink_state;
659 s8 signal;
660 s8 signal_avg;
661 struct rate_info txrate;
662 struct rate_info rxrate;
663 u32 rx_packets;
664 u32 tx_packets;
665 u32 tx_retries;
666 u32 tx_failed;
667 u32 rx_dropped_misc;
668 struct sta_bss_parameters bss_param;
669 struct nl80211_sta_flag_update sta_flags;
670
671 int generation;
672
673 const u8 *assoc_req_ies;
674 size_t assoc_req_ies_len;
675
676 u32 beacon_loss_count;
677 s64 t_offset;
678
679 /*
680 * Note: Add a new enum station_info_flags value for each new field and
681 * use it to check which fields are initialized.
682 */
683};
684
685/**
686 * enum monitor_flags - monitor flags
687 *
688 * Monitor interface configuration flags. Note that these must be the bits
689 * according to the nl80211 flags.
690 *
691 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
692 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
693 * @MONITOR_FLAG_CONTROL: pass control frames
694 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
695 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
696 */
697enum monitor_flags {
698 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
699 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
700 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
701 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
702 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
703};
704
705/**
706 * enum mpath_info_flags - mesh path information flags
707 *
708 * Used by the driver to indicate which info in &struct mpath_info it has filled
709 * in during get_station() or dump_station().
710 *
711 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
712 * @MPATH_INFO_SN: @sn filled
713 * @MPATH_INFO_METRIC: @metric filled
714 * @MPATH_INFO_EXPTIME: @exptime filled
715 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
716 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
717 * @MPATH_INFO_FLAGS: @flags filled
718 */
719enum mpath_info_flags {
720 MPATH_INFO_FRAME_QLEN = BIT(0),
721 MPATH_INFO_SN = BIT(1),
722 MPATH_INFO_METRIC = BIT(2),
723 MPATH_INFO_EXPTIME = BIT(3),
724 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
725 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
726 MPATH_INFO_FLAGS = BIT(6),
727};
728
729/**
730 * struct mpath_info - mesh path information
731 *
732 * Mesh path information filled by driver for get_mpath() and dump_mpath().
733 *
734 * @filled: bitfield of flags from &enum mpath_info_flags
735 * @frame_qlen: number of queued frames for this destination
736 * @sn: target sequence number
737 * @metric: metric (cost) of this mesh path
738 * @exptime: expiration time for the mesh path from now, in msecs
739 * @flags: mesh path flags
740 * @discovery_timeout: total mesh path discovery timeout, in msecs
741 * @discovery_retries: mesh path discovery retries
742 * @generation: generation number for nl80211 dumps.
743 * This number should increase every time the list of mesh paths
744 * changes, i.e. when a station is added or removed, so that
745 * userspace can tell whether it got a consistent snapshot.
746 */
747struct mpath_info {
748 u32 filled;
749 u32 frame_qlen;
750 u32 sn;
751 u32 metric;
752 u32 exptime;
753 u32 discovery_timeout;
754 u8 discovery_retries;
755 u8 flags;
756
757 int generation;
758};
759
760/**
761 * struct bss_parameters - BSS parameters
762 *
763 * Used to change BSS parameters (mainly for AP mode).
764 *
765 * @use_cts_prot: Whether to use CTS protection
766 * (0 = no, 1 = yes, -1 = do not change)
767 * @use_short_preamble: Whether the use of short preambles is allowed
768 * (0 = no, 1 = yes, -1 = do not change)
769 * @use_short_slot_time: Whether the use of short slot time is allowed
770 * (0 = no, 1 = yes, -1 = do not change)
771 * @basic_rates: basic rates in IEEE 802.11 format
772 * (or NULL for no change)
773 * @basic_rates_len: number of basic rates
774 * @ap_isolate: do not forward packets between connected stations
775 * @ht_opmode: HT Operation mode
776 * (u16 = opmode, -1 = do not change)
777 */
778struct bss_parameters {
779 int use_cts_prot;
780 int use_short_preamble;
781 int use_short_slot_time;
782 u8 *basic_rates;
783 u8 basic_rates_len;
784 int ap_isolate;
785 int ht_opmode;
786};
787
788/*
789 * struct mesh_config - 802.11s mesh configuration
790 *
791 * These parameters can be changed while the mesh is active.
792 */
793struct mesh_config {
794 /* Timeouts in ms */
795 /* Mesh plink management parameters */
796 u16 dot11MeshRetryTimeout;
797 u16 dot11MeshConfirmTimeout;
798 u16 dot11MeshHoldingTimeout;
799 u16 dot11MeshMaxPeerLinks;
800 u8 dot11MeshMaxRetries;
801 u8 dot11MeshTTL;
802 /* ttl used in path selection information elements */
803 u8 element_ttl;
804 bool auto_open_plinks;
805 /* neighbor offset synchronization */
806 u32 dot11MeshNbrOffsetMaxNeighbor;
807 /* HWMP parameters */
808 u8 dot11MeshHWMPmaxPREQretries;
809 u32 path_refresh_time;
810 u16 min_discovery_timeout;
811 u32 dot11MeshHWMPactivePathTimeout;
812 u16 dot11MeshHWMPpreqMinInterval;
813 u16 dot11MeshHWMPperrMinInterval;
814 u16 dot11MeshHWMPnetDiameterTraversalTime;
815 u8 dot11MeshHWMPRootMode;
816 u16 dot11MeshHWMPRannInterval;
817 /* This is missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol
818 * set to true only means that the station will announce others it's a
819 * mesh gate, but not necessarily using the gate announcement protocol.
820 * Still keeping the same nomenclature to be in sync with the spec. */
821 bool dot11MeshGateAnnouncementProtocol;
822 bool dot11MeshForwarding;
823 s32 rssi_threshold;
824 u16 ht_opmode;
825};
826
827/**
828 * struct mesh_setup - 802.11s mesh setup configuration
829 * @mesh_id: the mesh ID
830 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
831 * @sync_method: which synchronization method to use
832 * @path_sel_proto: which path selection protocol to use
833 * @path_metric: which metric to use
834 * @ie: vendor information elements (optional)
835 * @ie_len: length of vendor information elements
836 * @is_authenticated: this mesh requires authentication
837 * @is_secure: this mesh uses security
838 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
839 *
840 * These parameters are fixed when the mesh is created.
841 */
842struct mesh_setup {
843 const u8 *mesh_id;
844 u8 mesh_id_len;
845 u8 sync_method;
846 u8 path_sel_proto;
847 u8 path_metric;
848 const u8 *ie;
849 u8 ie_len;
850 bool is_authenticated;
851 bool is_secure;
852 int mcast_rate[IEEE80211_NUM_BANDS];
853};
854
855/**
856 * struct ieee80211_txq_params - TX queue parameters
857 * @ac: AC identifier
858 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
859 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
860 * 1..32767]
861 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
862 * 1..32767]
863 * @aifs: Arbitration interframe space [0..255]
864 */
865struct ieee80211_txq_params {
866 enum nl80211_ac ac;
867 u16 txop;
868 u16 cwmin;
869 u16 cwmax;
870 u8 aifs;
871};
872
873/* from net/wireless.h */
874struct wiphy;
875
876/**
877 * DOC: Scanning and BSS list handling
878 *
879 * The scanning process itself is fairly simple, but cfg80211 offers quite
880 * a bit of helper functionality. To start a scan, the scan operation will
881 * be invoked with a scan definition. This scan definition contains the
882 * channels to scan, and the SSIDs to send probe requests for (including the
883 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
884 * probe. Additionally, a scan request may contain extra information elements
885 * that should be added to the probe request. The IEs are guaranteed to be
886 * well-formed, and will not exceed the maximum length the driver advertised
887 * in the wiphy structure.
888 *
889 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
890 * it is responsible for maintaining the BSS list; the driver should not
891 * maintain a list itself. For this notification, various functions exist.
892 *
893 * Since drivers do not maintain a BSS list, there are also a number of
894 * functions to search for a BSS and obtain information about it from the
895 * BSS structure cfg80211 maintains. The BSS list is also made available
896 * to userspace.
897 */
898
899/**
900 * struct cfg80211_ssid - SSID description
901 * @ssid: the SSID
902 * @ssid_len: length of the ssid
903 */
904struct cfg80211_ssid {
905 u8 ssid[IEEE80211_MAX_SSID_LEN];
906 u8 ssid_len;
907};
908
909/**
910 * struct cfg80211_scan_request - scan request description
911 *
912 * @ssids: SSIDs to scan for (active scan only)
913 * @n_ssids: number of SSIDs
914 * @channels: channels to scan on.
915 * @n_channels: total number of channels to scan
916 * @ie: optional information element(s) to add into Probe Request or %NULL
917 * @ie_len: length of ie in octets
918 * @rates: bitmap of rates to advertise for each band
919 * @wiphy: the wiphy this was for
920 * @dev: the interface
921 * @aborted: (internal) scan request was notified as aborted
922 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
923 */
924struct cfg80211_scan_request {
925 struct cfg80211_ssid *ssids;
926 int n_ssids;
927 u32 n_channels;
928 const u8 *ie;
929 size_t ie_len;
930
931 u32 rates[IEEE80211_NUM_BANDS];
932
933 /* internal */
934 struct wiphy *wiphy;
935 struct net_device *dev;
936 bool aborted;
937 bool no_cck;
938
939 /* keep last */
940 struct ieee80211_channel *channels[0];
941};
942
943/**
944 * struct cfg80211_match_set - sets of attributes to match
945 *
946 * @ssid: SSID to be matched
947 */
948struct cfg80211_match_set {
949 struct cfg80211_ssid ssid;
950};
951
952/**
953 * struct cfg80211_sched_scan_request - scheduled scan request description
954 *
955 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
956 * @n_ssids: number of SSIDs
957 * @n_channels: total number of channels to scan
958 * @interval: interval between each scheduled scan cycle
959 * @ie: optional information element(s) to add into Probe Request or %NULL
960 * @ie_len: length of ie in octets
961 * @match_sets: sets of parameters to be matched for a scan result
962 * entry to be considered valid and to be passed to the host
963 * (others are filtered out).
964 * If ommited, all results are passed.
965 * @n_match_sets: number of match sets
966 * @wiphy: the wiphy this was for
967 * @dev: the interface
968 * @channels: channels to scan
969 */
970struct cfg80211_sched_scan_request {
971 struct cfg80211_ssid *ssids;
972 int n_ssids;
973 u32 n_channels;
974 u32 interval;
975 const u8 *ie;
976 size_t ie_len;
977 struct cfg80211_match_set *match_sets;
978 int n_match_sets;
979
980 /* internal */
981 struct wiphy *wiphy;
982 struct net_device *dev;
983
984 /* keep last */
985 struct ieee80211_channel *channels[0];
986};
987
988/**
989 * enum cfg80211_signal_type - signal type
990 *
991 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
992 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
993 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
994 */
995enum cfg80211_signal_type {
996 CFG80211_SIGNAL_TYPE_NONE,
997 CFG80211_SIGNAL_TYPE_MBM,
998 CFG80211_SIGNAL_TYPE_UNSPEC,
999};
1000
1001/**
1002 * struct cfg80211_bss - BSS description
1003 *
1004 * This structure describes a BSS (which may also be a mesh network)
1005 * for use in scan results and similar.
1006 *
1007 * @channel: channel this BSS is on
1008 * @bssid: BSSID of the BSS
1009 * @tsf: timestamp of last received update
1010 * @beacon_interval: the beacon interval as from the frame
1011 * @capability: the capability field in host byte order
1012 * @information_elements: the information elements (Note that there
1013 * is no guarantee that these are well-formed!); this is a pointer to
1014 * either the beacon_ies or proberesp_ies depending on whether Probe
1015 * Response frame has been received
1016 * @len_information_elements: total length of the information elements
1017 * @beacon_ies: the information elements from the last Beacon frame
1018 * @len_beacon_ies: total length of the beacon_ies
1019 * @proberesp_ies: the information elements from the last Probe Response frame
1020 * @len_proberesp_ies: total length of the proberesp_ies
1021 * @signal: signal strength value (type depends on the wiphy's signal_type)
1022 * @free_priv: function pointer to free private data
1023 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1024 */
1025struct cfg80211_bss {
1026 struct ieee80211_channel *channel;
1027
1028 u8 bssid[ETH_ALEN];
1029 u64 tsf;
1030 u16 beacon_interval;
1031 u16 capability;
1032 u8 *information_elements;
1033 size_t len_information_elements;
1034 u8 *beacon_ies;
1035 size_t len_beacon_ies;
1036 u8 *proberesp_ies;
1037 size_t len_proberesp_ies;
1038
1039 s32 signal;
1040
1041 void (*free_priv)(struct cfg80211_bss *bss);
1042 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
1043};
1044
1045/**
1046 * ieee80211_bss_get_ie - find IE with given ID
1047 * @bss: the bss to search
1048 * @ie: the IE ID
1049 * Returns %NULL if not found.
1050 */
1051const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1052
1053
1054/**
1055 * struct cfg80211_auth_request - Authentication request data
1056 *
1057 * This structure provides information needed to complete IEEE 802.11
1058 * authentication.
1059 *
1060 * @bss: The BSS to authenticate with.
1061 * @auth_type: Authentication type (algorithm)
1062 * @ie: Extra IEs to add to Authentication frame or %NULL
1063 * @ie_len: Length of ie buffer in octets
1064 * @key_len: length of WEP key for shared key authentication
1065 * @key_idx: index of WEP key for shared key authentication
1066 * @key: WEP key for shared key authentication
1067 */
1068struct cfg80211_auth_request {
1069 struct cfg80211_bss *bss;
1070 const u8 *ie;
1071 size_t ie_len;
1072 enum nl80211_auth_type auth_type;
1073 const u8 *key;
1074 u8 key_len, key_idx;
1075};
1076
1077/**
1078 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1079 *
1080 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1081 */
1082enum cfg80211_assoc_req_flags {
1083 ASSOC_REQ_DISABLE_HT = BIT(0),
1084};
1085
1086/**
1087 * struct cfg80211_assoc_request - (Re)Association request data
1088 *
1089 * This structure provides information needed to complete IEEE 802.11
1090 * (re)association.
1091 * @bss: The BSS to associate with. If the call is successful the driver
1092 * is given a reference that it must release, normally via a call to
1093 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1094 * call to cfg80211_put_bss() (in addition to calling
1095 * cfg80211_send_assoc_timeout())
1096 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1097 * @ie_len: Length of ie buffer in octets
1098 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1099 * @crypto: crypto settings
1100 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1101 * @flags: See &enum cfg80211_assoc_req_flags
1102 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1103 * will be used in ht_capa. Un-supported values will be ignored.
1104 * @ht_capa_mask: The bits of ht_capa which are to be used.
1105 */
1106struct cfg80211_assoc_request {
1107 struct cfg80211_bss *bss;
1108 const u8 *ie, *prev_bssid;
1109 size_t ie_len;
1110 struct cfg80211_crypto_settings crypto;
1111 bool use_mfp;
1112 u32 flags;
1113 struct ieee80211_ht_cap ht_capa;
1114 struct ieee80211_ht_cap ht_capa_mask;
1115};
1116
1117/**
1118 * struct cfg80211_deauth_request - Deauthentication request data
1119 *
1120 * This structure provides information needed to complete IEEE 802.11
1121 * deauthentication.
1122 *
1123 * @bssid: the BSSID of the BSS to deauthenticate from
1124 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1125 * @ie_len: Length of ie buffer in octets
1126 * @reason_code: The reason code for the deauthentication
1127 */
1128struct cfg80211_deauth_request {
1129 const u8 *bssid;
1130 const u8 *ie;
1131 size_t ie_len;
1132 u16 reason_code;
1133};
1134
1135/**
1136 * struct cfg80211_disassoc_request - Disassociation request data
1137 *
1138 * This structure provides information needed to complete IEEE 802.11
1139 * disassocation.
1140 *
1141 * @bss: the BSS to disassociate from
1142 * @ie: Extra IEs to add to Disassociation frame or %NULL
1143 * @ie_len: Length of ie buffer in octets
1144 * @reason_code: The reason code for the disassociation
1145 * @local_state_change: This is a request for a local state only, i.e., no
1146 * Disassociation frame is to be transmitted.
1147 */
1148struct cfg80211_disassoc_request {
1149 struct cfg80211_bss *bss;
1150 const u8 *ie;
1151 size_t ie_len;
1152 u16 reason_code;
1153 bool local_state_change;
1154};
1155
1156/**
1157 * struct cfg80211_ibss_params - IBSS parameters
1158 *
1159 * This structure defines the IBSS parameters for the join_ibss()
1160 * method.
1161 *
1162 * @ssid: The SSID, will always be non-null.
1163 * @ssid_len: The length of the SSID, will always be non-zero.
1164 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1165 * search for IBSSs with a different BSSID.
1166 * @channel: The channel to use if no IBSS can be found to join.
1167 * @channel_type: channel type (HT mode)
1168 * @channel_fixed: The channel should be fixed -- do not search for
1169 * IBSSs to join on other channels.
1170 * @ie: information element(s) to include in the beacon
1171 * @ie_len: length of that
1172 * @beacon_interval: beacon interval to use
1173 * @privacy: this is a protected network, keys will be configured
1174 * after joining
1175 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1176 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1177 * required to assume that the port is unauthorized until authorized by
1178 * user space. Otherwise, port is marked authorized by default.
1179 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1180 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1181 */
1182struct cfg80211_ibss_params {
1183 u8 *ssid;
1184 u8 *bssid;
1185 struct ieee80211_channel *channel;
1186 enum nl80211_channel_type channel_type;
1187 u8 *ie;
1188 u8 ssid_len, ie_len;
1189 u16 beacon_interval;
1190 u32 basic_rates;
1191 bool channel_fixed;
1192 bool privacy;
1193 bool control_port;
1194 int mcast_rate[IEEE80211_NUM_BANDS];
1195};
1196
1197/**
1198 * struct cfg80211_connect_params - Connection parameters
1199 *
1200 * This structure provides information needed to complete IEEE 802.11
1201 * authentication and association.
1202 *
1203 * @channel: The channel to use or %NULL if not specified (auto-select based
1204 * on scan results)
1205 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1206 * results)
1207 * @ssid: SSID
1208 * @ssid_len: Length of ssid in octets
1209 * @auth_type: Authentication type (algorithm)
1210 * @ie: IEs for association request
1211 * @ie_len: Length of assoc_ie in octets
1212 * @privacy: indicates whether privacy-enabled APs should be used
1213 * @crypto: crypto settings
1214 * @key_len: length of WEP key for shared key authentication
1215 * @key_idx: index of WEP key for shared key authentication
1216 * @key: WEP key for shared key authentication
1217 * @flags: See &enum cfg80211_assoc_req_flags
1218 * @bg_scan_period: Background scan period in seconds
1219 * or -1 to indicate that default value is to be used.
1220 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1221 * will be used in ht_capa. Un-supported values will be ignored.
1222 * @ht_capa_mask: The bits of ht_capa which are to be used.
1223 */
1224struct cfg80211_connect_params {
1225 struct ieee80211_channel *channel;
1226 u8 *bssid;
1227 u8 *ssid;
1228 size_t ssid_len;
1229 enum nl80211_auth_type auth_type;
1230 u8 *ie;
1231 size_t ie_len;
1232 bool privacy;
1233 struct cfg80211_crypto_settings crypto;
1234 const u8 *key;
1235 u8 key_len, key_idx;
1236 u32 flags;
1237 int bg_scan_period;
1238 struct ieee80211_ht_cap ht_capa;
1239 struct ieee80211_ht_cap ht_capa_mask;
1240};
1241
1242/**
1243 * enum wiphy_params_flags - set_wiphy_params bitfield values
1244 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1245 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1246 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1247 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1248 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1249 */
1250enum wiphy_params_flags {
1251 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1252 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1253 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1254 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1255 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1256};
1257
1258/*
1259 * cfg80211_bitrate_mask - masks for bitrate control
1260 */
1261struct cfg80211_bitrate_mask {
1262 struct {
1263 u32 legacy;
1264 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1265 } control[IEEE80211_NUM_BANDS];
1266};
1267/**
1268 * struct cfg80211_pmksa - PMK Security Association
1269 *
1270 * This structure is passed to the set/del_pmksa() method for PMKSA
1271 * caching.
1272 *
1273 * @bssid: The AP's BSSID.
1274 * @pmkid: The PMK material itself.
1275 */
1276struct cfg80211_pmksa {
1277 u8 *bssid;
1278 u8 *pmkid;
1279};
1280
1281/**
1282 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1283 * @mask: bitmask where to match pattern and where to ignore bytes,
1284 * one bit per byte, in same format as nl80211
1285 * @pattern: bytes to match where bitmask is 1
1286 * @pattern_len: length of pattern (in bytes)
1287 *
1288 * Internal note: @mask and @pattern are allocated in one chunk of
1289 * memory, free @mask only!
1290 */
1291struct cfg80211_wowlan_trig_pkt_pattern {
1292 u8 *mask, *pattern;
1293 int pattern_len;
1294};
1295
1296/**
1297 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1298 *
1299 * This structure defines the enabled WoWLAN triggers for the device.
1300 * @any: wake up on any activity -- special trigger if device continues
1301 * operating as normal during suspend
1302 * @disconnect: wake up if getting disconnected
1303 * @magic_pkt: wake up on receiving magic packet
1304 * @patterns: wake up on receiving packet matching a pattern
1305 * @n_patterns: number of patterns
1306 * @gtk_rekey_failure: wake up on GTK rekey failure
1307 * @eap_identity_req: wake up on EAP identity request packet
1308 * @four_way_handshake: wake up on 4-way handshake
1309 * @rfkill_release: wake up when rfkill is released
1310 */
1311struct cfg80211_wowlan {
1312 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1313 eap_identity_req, four_way_handshake,
1314 rfkill_release;
1315 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1316 int n_patterns;
1317};
1318
1319/**
1320 * struct cfg80211_gtk_rekey_data - rekey data
1321 * @kek: key encryption key
1322 * @kck: key confirmation key
1323 * @replay_ctr: replay counter
1324 */
1325struct cfg80211_gtk_rekey_data {
1326 u8 kek[NL80211_KEK_LEN];
1327 u8 kck[NL80211_KCK_LEN];
1328 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1329};
1330
1331/**
1332 * struct cfg80211_ops - backend description for wireless configuration
1333 *
1334 * This struct is registered by fullmac card drivers and/or wireless stacks
1335 * in order to handle configuration requests on their interfaces.
1336 *
1337 * All callbacks except where otherwise noted should return 0
1338 * on success or a negative error code.
1339 *
1340 * All operations are currently invoked under rtnl for consistency with the
1341 * wireless extensions but this is subject to reevaluation as soon as this
1342 * code is used more widely and we have a first user without wext.
1343 *
1344 * @suspend: wiphy device needs to be suspended. The variable @wow will
1345 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1346 * configured for the device.
1347 * @resume: wiphy device needs to be resumed
1348 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1349 * to call device_set_wakeup_enable() to enable/disable wakeup from
1350 * the device.
1351 *
1352 * @add_virtual_intf: create a new virtual interface with the given name,
1353 * must set the struct wireless_dev's iftype. Beware: You must create
1354 * the new netdev in the wiphy's network namespace! Returns the netdev,
1355 * or an ERR_PTR.
1356 *
1357 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1358 *
1359 * @change_virtual_intf: change type/configuration of virtual interface,
1360 * keep the struct wireless_dev's iftype updated.
1361 *
1362 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1363 * when adding a group key.
1364 *
1365 * @get_key: get information about the key with the given parameters.
1366 * @mac_addr will be %NULL when requesting information for a group
1367 * key. All pointers given to the @callback function need not be valid
1368 * after it returns. This function should return an error if it is
1369 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1370 *
1371 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1372 * and @key_index, return -ENOENT if the key doesn't exist.
1373 *
1374 * @set_default_key: set the default key on an interface
1375 *
1376 * @set_default_mgmt_key: set the default management frame key on an interface
1377 *
1378 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1379 *
1380 * @start_ap: Start acting in AP mode defined by the parameters.
1381 * @change_beacon: Change the beacon parameters for an access point mode
1382 * interface. This should reject the call when AP mode wasn't started.
1383 * @stop_ap: Stop being an AP, including stopping beaconing.
1384 *
1385 * @add_station: Add a new station.
1386 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1387 * @change_station: Modify a given station. Note that flags changes are not much
1388 * validated in cfg80211, in particular the auth/assoc/authorized flags
1389 * might come to the driver in invalid combinations -- make sure to check
1390 * them, also against the existing state! Also, supported_rates changes are
1391 * not checked in station mode -- drivers need to reject (or ignore) them
1392 * for anything but TDLS peers.
1393 * @get_station: get station information for the station identified by @mac
1394 * @dump_station: dump station callback -- resume dump at index @idx
1395 *
1396 * @add_mpath: add a fixed mesh path
1397 * @del_mpath: delete a given mesh path
1398 * @change_mpath: change a given mesh path
1399 * @get_mpath: get a mesh path for the given parameters
1400 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1401 * @join_mesh: join the mesh network with the specified parameters
1402 * @leave_mesh: leave the current mesh network
1403 *
1404 * @get_mesh_config: Get the current mesh configuration
1405 *
1406 * @update_mesh_config: Update mesh parameters on a running mesh.
1407 * The mask is a bitfield which tells us which parameters to
1408 * set, and which to leave alone.
1409 *
1410 * @change_bss: Modify parameters for a given BSS.
1411 *
1412 * @set_txq_params: Set TX queue parameters
1413 *
1414 * @set_channel: Set channel for a given wireless interface. Some devices
1415 * may support multi-channel operation (by channel hopping) so cfg80211
1416 * doesn't verify much. Note, however, that the passed netdev may be
1417 * %NULL as well if the user requested changing the channel for the
1418 * device itself, or for a monitor interface.
1419 * @get_channel: Get the current operating channel, should return %NULL if
1420 * there's no single defined operating channel if for example the
1421 * device implements channel hopping for multi-channel virtual interfaces.
1422 *
1423 * @scan: Request to do a scan. If returning zero, the scan request is given
1424 * the driver, and will be valid until passed to cfg80211_scan_done().
1425 * For scan results, call cfg80211_inform_bss(); you can call this outside
1426 * the scan/scan_done bracket too.
1427 *
1428 * @auth: Request to authenticate with the specified peer
1429 * @assoc: Request to (re)associate with the specified peer
1430 * @deauth: Request to deauthenticate from the specified peer
1431 * @disassoc: Request to disassociate from the specified peer
1432 *
1433 * @connect: Connect to the ESS with the specified parameters. When connected,
1434 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1435 * If the connection fails for some reason, call cfg80211_connect_result()
1436 * with the status from the AP.
1437 * @disconnect: Disconnect from the BSS/ESS.
1438 *
1439 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1440 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1441 * to a merge.
1442 * @leave_ibss: Leave the IBSS.
1443 *
1444 * @set_wiphy_params: Notify that wiphy parameters have changed;
1445 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1446 * have changed. The actual parameter values are available in
1447 * struct wiphy. If returning an error, no value should be changed.
1448 *
1449 * @set_tx_power: set the transmit power according to the parameters,
1450 * the power passed is in mBm, to get dBm use MBM_TO_DBM().
1451 * @get_tx_power: store the current TX power into the dbm variable;
1452 * return 0 if successful
1453 *
1454 * @set_wds_peer: set the WDS peer for a WDS interface
1455 *
1456 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1457 * functions to adjust rfkill hw state
1458 *
1459 * @dump_survey: get site survey information.
1460 *
1461 * @remain_on_channel: Request the driver to remain awake on the specified
1462 * channel for the specified duration to complete an off-channel
1463 * operation (e.g., public action frame exchange). When the driver is
1464 * ready on the requested channel, it must indicate this with an event
1465 * notification by calling cfg80211_ready_on_channel().
1466 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1467 * This allows the operation to be terminated prior to timeout based on
1468 * the duration value.
1469 * @mgmt_tx: Transmit a management frame.
1470 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1471 * frame on another channel
1472 *
1473 * @testmode_cmd: run a test mode command
1474 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1475 * used by the function, but 0 and 1 must not be touched. Additionally,
1476 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1477 * dump and return to userspace with an error, so be careful. If any data
1478 * was passed in from userspace then the data/len arguments will be present
1479 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1480 *
1481 * @set_bitrate_mask: set the bitrate mask configuration
1482 *
1483 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1484 * devices running firmwares capable of generating the (re) association
1485 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1486 * @del_pmksa: Delete a cached PMKID.
1487 * @flush_pmksa: Flush all cached PMKIDs.
1488 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1489 * allows the driver to adjust the dynamic ps timeout value.
1490 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1491 * @sched_scan_start: Tell the driver to start a scheduled scan.
1492 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
1493 * scan. The driver_initiated flag specifies whether the driver
1494 * itself has informed that the scan has stopped.
1495 *
1496 * @mgmt_frame_register: Notify driver that a management frame type was
1497 * registered. Note that this callback may not sleep, and cannot run
1498 * concurrently with itself.
1499 *
1500 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1501 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1502 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1503 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1504 *
1505 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1506 *
1507 * @set_ringparam: Set tx and rx ring sizes.
1508 *
1509 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1510 *
1511 * @tdls_mgmt: Transmit a TDLS management frame.
1512 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1513 *
1514 * @probe_client: probe an associated client, must return a cookie that it
1515 * later passes to cfg80211_probe_status().
1516 *
1517 * @set_noack_map: Set the NoAck Map for the TIDs.
1518 *
1519 * @get_et_sset_count: Ethtool API to get string-set count.
1520 * See @ethtool_ops.get_sset_count
1521 *
1522 * @get_et_stats: Ethtool API to get a set of u64 stats.
1523 * See @ethtool_ops.get_ethtool_stats
1524 *
1525 * @get_et_strings: Ethtool API to get a set of strings to describe stats
1526 * and perhaps other supported types of ethtool data-sets.
1527 * See @ethtool_ops.get_strings
1528 */
1529struct cfg80211_ops {
1530 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1531 int (*resume)(struct wiphy *wiphy);
1532 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
1533
1534 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
1535 char *name,
1536 enum nl80211_iftype type,
1537 u32 *flags,
1538 struct vif_params *params);
1539 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1540 int (*change_virtual_intf)(struct wiphy *wiphy,
1541 struct net_device *dev,
1542 enum nl80211_iftype type, u32 *flags,
1543 struct vif_params *params);
1544
1545 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1546 u8 key_index, bool pairwise, const u8 *mac_addr,
1547 struct key_params *params);
1548 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1549 u8 key_index, bool pairwise, const u8 *mac_addr,
1550 void *cookie,
1551 void (*callback)(void *cookie, struct key_params*));
1552 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1553 u8 key_index, bool pairwise, const u8 *mac_addr);
1554 int (*set_default_key)(struct wiphy *wiphy,
1555 struct net_device *netdev,
1556 u8 key_index, bool unicast, bool multicast);
1557 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1558 struct net_device *netdev,
1559 u8 key_index);
1560
1561 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
1562 struct cfg80211_ap_settings *settings);
1563 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
1564 struct cfg80211_beacon_data *info);
1565 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
1566
1567
1568 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1569 u8 *mac, struct station_parameters *params);
1570 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1571 u8 *mac);
1572 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1573 u8 *mac, struct station_parameters *params);
1574 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1575 u8 *mac, struct station_info *sinfo);
1576 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1577 int idx, u8 *mac, struct station_info *sinfo);
1578
1579 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1580 u8 *dst, u8 *next_hop);
1581 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1582 u8 *dst);
1583 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1584 u8 *dst, u8 *next_hop);
1585 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1586 u8 *dst, u8 *next_hop,
1587 struct mpath_info *pinfo);
1588 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1589 int idx, u8 *dst, u8 *next_hop,
1590 struct mpath_info *pinfo);
1591 int (*get_mesh_config)(struct wiphy *wiphy,
1592 struct net_device *dev,
1593 struct mesh_config *conf);
1594 int (*update_mesh_config)(struct wiphy *wiphy,
1595 struct net_device *dev, u32 mask,
1596 const struct mesh_config *nconf);
1597 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1598 const struct mesh_config *conf,
1599 const struct mesh_setup *setup);
1600 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1601
1602 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1603 struct bss_parameters *params);
1604
1605 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1606 struct ieee80211_txq_params *params);
1607
1608 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
1609 struct ieee80211_channel *chan,
1610 enum nl80211_channel_type channel_type);
1611
1612 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1613 struct cfg80211_scan_request *request);
1614
1615 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1616 struct cfg80211_auth_request *req);
1617 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1618 struct cfg80211_assoc_request *req);
1619 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1620 struct cfg80211_deauth_request *req);
1621 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1622 struct cfg80211_disassoc_request *req);
1623
1624 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1625 struct cfg80211_connect_params *sme);
1626 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1627 u16 reason_code);
1628
1629 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1630 struct cfg80211_ibss_params *params);
1631 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1632
1633 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1634
1635 int (*set_tx_power)(struct wiphy *wiphy,
1636 enum nl80211_tx_power_setting type, int mbm);
1637 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1638
1639 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1640 const u8 *addr);
1641
1642 void (*rfkill_poll)(struct wiphy *wiphy);
1643
1644#ifdef CONFIG_NL80211_TESTMODE
1645 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1646 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1647 struct netlink_callback *cb,
1648 void *data, int len);
1649#endif
1650
1651 int (*set_bitrate_mask)(struct wiphy *wiphy,
1652 struct net_device *dev,
1653 const u8 *peer,
1654 const struct cfg80211_bitrate_mask *mask);
1655
1656 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1657 int idx, struct survey_info *info);
1658
1659 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1660 struct cfg80211_pmksa *pmksa);
1661 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1662 struct cfg80211_pmksa *pmksa);
1663 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1664
1665 int (*remain_on_channel)(struct wiphy *wiphy,
1666 struct net_device *dev,
1667 struct ieee80211_channel *chan,
1668 enum nl80211_channel_type channel_type,
1669 unsigned int duration,
1670 u64 *cookie);
1671 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1672 struct net_device *dev,
1673 u64 cookie);
1674
1675 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1676 struct ieee80211_channel *chan, bool offchan,
1677 enum nl80211_channel_type channel_type,
1678 bool channel_type_valid, unsigned int wait,
1679 const u8 *buf, size_t len, bool no_cck,
1680 bool dont_wait_for_ack, u64 *cookie);
1681 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1682 struct net_device *dev,
1683 u64 cookie);
1684
1685 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1686 bool enabled, int timeout);
1687
1688 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1689 struct net_device *dev,
1690 s32 rssi_thold, u32 rssi_hyst);
1691
1692 void (*mgmt_frame_register)(struct wiphy *wiphy,
1693 struct net_device *dev,
1694 u16 frame_type, bool reg);
1695
1696 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1697 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1698
1699 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1700 void (*get_ringparam)(struct wiphy *wiphy,
1701 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1702
1703 int (*sched_scan_start)(struct wiphy *wiphy,
1704 struct net_device *dev,
1705 struct cfg80211_sched_scan_request *request);
1706 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1707
1708 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
1709 struct cfg80211_gtk_rekey_data *data);
1710
1711 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1712 u8 *peer, u8 action_code, u8 dialog_token,
1713 u16 status_code, const u8 *buf, size_t len);
1714 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
1715 u8 *peer, enum nl80211_tdls_operation oper);
1716
1717 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
1718 const u8 *peer, u64 *cookie);
1719
1720 int (*set_noack_map)(struct wiphy *wiphy,
1721 struct net_device *dev,
1722 u16 noack_map);
1723
1724 struct ieee80211_channel *(*get_channel)(struct wiphy *wiphy,
1725 enum nl80211_channel_type *type);
1726
1727 int (*get_et_sset_count)(struct wiphy *wiphy,
1728 struct net_device *dev, int sset);
1729 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
1730 struct ethtool_stats *stats, u64 *data);
1731 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
1732 u32 sset, u8 *data);
1733};
1734
1735/*
1736 * wireless hardware and networking interfaces structures
1737 * and registration/helper functions
1738 */
1739
1740/**
1741 * enum wiphy_flags - wiphy capability flags
1742 *
1743 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1744 * has its own custom regulatory domain and cannot identify the
1745 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1746 * we will disregard the first regulatory hint (when the
1747 * initiator is %REGDOM_SET_BY_CORE).
1748 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1749 * ignore regulatory domain settings until it gets its own regulatory
1750 * domain via its regulatory_hint() unless the regulatory hint is
1751 * from a country IE. After its gets its own regulatory domain it will
1752 * only allow further regulatory domain settings to further enhance
1753 * compliance. For example if channel 13 and 14 are disabled by this
1754 * regulatory domain no user regulatory domain can enable these channels
1755 * at a later time. This can be used for devices which do not have
1756 * calibration information guaranteed for frequencies or settings
1757 * outside of its regulatory domain. If used in combination with
1758 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
1759 * will be followed.
1760 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1761 * that passive scan flags and beaconing flags may not be lifted by
1762 * cfg80211 due to regulatory beacon hints. For more information on beacon
1763 * hints read the documenation for regulatory_hint_found_beacon()
1764 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1765 * wiphy at all
1766 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1767 * by default -- this flag will be set depending on the kernel's default
1768 * on wiphy_new(), but can be changed by the driver if it has a good
1769 * reason to override the default
1770 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1771 * on a VLAN interface)
1772 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1773 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1774 * control port protocol ethertype. The device also honours the
1775 * control_port_no_encrypt flag.
1776 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1777 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1778 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1779 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1780 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
1781 * firmware.
1782 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
1783 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
1784 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
1785 * link setup/discovery operations internally. Setup, discovery and
1786 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
1787 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
1788 * used for asking the driver/firmware to perform a TDLS operation.
1789 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
1790 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
1791 * when there are virtual interfaces in AP mode by calling
1792 * cfg80211_report_obss_beacon().
1793 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
1794 * responds to probe-requests in hardware.
1795 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
1796 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
1797 */
1798enum wiphy_flags {
1799 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1800 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1801 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1802 WIPHY_FLAG_NETNS_OK = BIT(3),
1803 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1804 WIPHY_FLAG_4ADDR_AP = BIT(5),
1805 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1806 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1807 WIPHY_FLAG_IBSS_RSN = BIT(8),
1808 WIPHY_FLAG_MESH_AUTH = BIT(10),
1809 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
1810 /* use hole at 12 */
1811 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
1812 WIPHY_FLAG_AP_UAPSD = BIT(14),
1813 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
1814 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
1815 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
1816 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
1817 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
1818 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
1819 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
1820};
1821
1822/**
1823 * struct ieee80211_iface_limit - limit on certain interface types
1824 * @max: maximum number of interfaces of these types
1825 * @types: interface types (bits)
1826 */
1827struct ieee80211_iface_limit {
1828 u16 max;
1829 u16 types;
1830};
1831
1832/**
1833 * struct ieee80211_iface_combination - possible interface combination
1834 * @limits: limits for the given interface types
1835 * @n_limits: number of limitations
1836 * @num_different_channels: can use up to this many different channels
1837 * @max_interfaces: maximum number of interfaces in total allowed in this
1838 * group
1839 * @beacon_int_infra_match: In this combination, the beacon intervals
1840 * between infrastructure and AP types must match. This is required
1841 * only in special cases.
1842 *
1843 * These examples can be expressed as follows:
1844 *
1845 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1846 *
1847 * struct ieee80211_iface_limit limits1[] = {
1848 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1849 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1850 * };
1851 * struct ieee80211_iface_combination combination1 = {
1852 * .limits = limits1,
1853 * .n_limits = ARRAY_SIZE(limits1),
1854 * .max_interfaces = 2,
1855 * .beacon_int_infra_match = true,
1856 * };
1857 *
1858 *
1859 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1860 *
1861 * struct ieee80211_iface_limit limits2[] = {
1862 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1863 * BIT(NL80211_IFTYPE_P2P_GO), },
1864 * };
1865 * struct ieee80211_iface_combination combination2 = {
1866 * .limits = limits2,
1867 * .n_limits = ARRAY_SIZE(limits2),
1868 * .max_interfaces = 8,
1869 * .num_different_channels = 1,
1870 * };
1871 *
1872 *
1873 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
1874 * This allows for an infrastructure connection and three P2P connections.
1875 *
1876 * struct ieee80211_iface_limit limits3[] = {
1877 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1878 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
1879 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
1880 * };
1881 * struct ieee80211_iface_combination combination3 = {
1882 * .limits = limits3,
1883 * .n_limits = ARRAY_SIZE(limits3),
1884 * .max_interfaces = 4,
1885 * .num_different_channels = 2,
1886 * };
1887 */
1888struct ieee80211_iface_combination {
1889 const struct ieee80211_iface_limit *limits;
1890 u32 num_different_channels;
1891 u16 max_interfaces;
1892 u8 n_limits;
1893 bool beacon_int_infra_match;
1894};
1895
1896struct mac_address {
1897 u8 addr[ETH_ALEN];
1898};
1899
1900struct ieee80211_txrx_stypes {
1901 u16 tx, rx;
1902};
1903
1904/**
1905 * enum wiphy_wowlan_support_flags - WoWLAN support flags
1906 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
1907 * trigger that keeps the device operating as-is and
1908 * wakes up the host on any activity, for example a
1909 * received packet that passed filtering; note that the
1910 * packet should be preserved in that case
1911 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
1912 * (see nl80211.h)
1913 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
1914 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
1915 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
1916 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
1917 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
1918 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
1919 */
1920enum wiphy_wowlan_support_flags {
1921 WIPHY_WOWLAN_ANY = BIT(0),
1922 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
1923 WIPHY_WOWLAN_DISCONNECT = BIT(2),
1924 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
1925 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
1926 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
1927 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
1928 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
1929};
1930
1931/**
1932 * struct wiphy_wowlan_support - WoWLAN support data
1933 * @flags: see &enum wiphy_wowlan_support_flags
1934 * @n_patterns: number of supported wakeup patterns
1935 * (see nl80211.h for the pattern definition)
1936 * @pattern_max_len: maximum length of each pattern
1937 * @pattern_min_len: minimum length of each pattern
1938 */
1939struct wiphy_wowlan_support {
1940 u32 flags;
1941 int n_patterns;
1942 int pattern_max_len;
1943 int pattern_min_len;
1944};
1945
1946/**
1947 * struct wiphy - wireless hardware description
1948 * @reg_notifier: the driver's regulatory notification callback,
1949 * note that if your driver uses wiphy_apply_custom_regulatory()
1950 * the reg_notifier's request can be passed as NULL
1951 * @regd: the driver's regulatory domain, if one was requested via
1952 * the regulatory_hint() API. This can be used by the driver
1953 * on the reg_notifier() if it chooses to ignore future
1954 * regulatory domain changes caused by other drivers.
1955 * @signal_type: signal type reported in &struct cfg80211_bss.
1956 * @cipher_suites: supported cipher suites
1957 * @n_cipher_suites: number of supported cipher suites
1958 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1959 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1960 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1961 * -1 = fragmentation disabled, only odd values >= 256 used
1962 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1963 * @_net: the network namespace this wiphy currently lives in
1964 * @perm_addr: permanent MAC address of this device
1965 * @addr_mask: If the device supports multiple MAC addresses by masking,
1966 * set this to a mask with variable bits set to 1, e.g. if the last
1967 * four bits are variable then set it to 00:...:00:0f. The actual
1968 * variable bits shall be determined by the interfaces added, with
1969 * interfaces not matching the mask being rejected to be brought up.
1970 * @n_addresses: number of addresses in @addresses.
1971 * @addresses: If the device has more than one address, set this pointer
1972 * to a list of addresses (6 bytes each). The first one will be used
1973 * by default for perm_addr. In this case, the mask should be set to
1974 * all-zeroes. In this case it is assumed that the device can handle
1975 * the same number of arbitrary MAC addresses.
1976 * @registered: protects ->resume and ->suspend sysfs callbacks against
1977 * unregister hardware
1978 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1979 * automatically on wiphy renames
1980 * @dev: (virtual) struct device for this wiphy
1981 * @registered: helps synchronize suspend/resume with wiphy unregister
1982 * @wext: wireless extension handlers
1983 * @priv: driver private data (sized according to wiphy_new() parameter)
1984 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1985 * must be set by driver
1986 * @iface_combinations: Valid interface combinations array, should not
1987 * list single interface types.
1988 * @n_iface_combinations: number of entries in @iface_combinations array.
1989 * @software_iftypes: bitmask of software interface types, these are not
1990 * subject to any restrictions since they are purely managed in SW.
1991 * @flags: wiphy flags, see &enum wiphy_flags
1992 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
1993 * @bss_priv_size: each BSS struct has private data allocated with it,
1994 * this variable determines its size
1995 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1996 * any given scan
1997 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
1998 * for in any given scheduled scan
1999 * @max_match_sets: maximum number of match sets the device can handle
2000 * when performing a scheduled scan, 0 if filtering is not
2001 * supported.
2002 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2003 * add to probe request frames transmitted during a scan, must not
2004 * include fixed IEs like supported rates
2005 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2006 * scans
2007 * @coverage_class: current coverage class
2008 * @fw_version: firmware version for ethtool reporting
2009 * @hw_version: hardware version for ethtool reporting
2010 * @max_num_pmkids: maximum number of PMKIDs supported by device
2011 * @privid: a pointer that drivers can use to identify if an arbitrary
2012 * wiphy is theirs, e.g. in global notifiers
2013 * @bands: information about bands/channels supported by this device
2014 *
2015 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2016 * transmitted through nl80211, points to an array indexed by interface
2017 * type
2018 *
2019 * @available_antennas_tx: bitmap of antennas which are available to be
2020 * configured as TX antennas. Antenna configuration commands will be
2021 * rejected unless this or @available_antennas_rx is set.
2022 *
2023 * @available_antennas_rx: bitmap of antennas which are available to be
2024 * configured as RX antennas. Antenna configuration commands will be
2025 * rejected unless this or @available_antennas_tx is set.
2026 *
2027 * @probe_resp_offload:
2028 * Bitmap of supported protocols for probe response offloading.
2029 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2030 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2031 *
2032 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2033 * may request, if implemented.
2034 *
2035 * @wowlan: WoWLAN support information
2036 *
2037 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2038 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2039 * If null, then none can be over-ridden.
2040 */
2041struct wiphy {
2042 /* assign these fields before you register the wiphy */
2043
2044 /* permanent MAC address(es) */
2045 u8 perm_addr[ETH_ALEN];
2046 u8 addr_mask[ETH_ALEN];
2047
2048 struct mac_address *addresses;
2049
2050 const struct ieee80211_txrx_stypes *mgmt_stypes;
2051
2052 const struct ieee80211_iface_combination *iface_combinations;
2053 int n_iface_combinations;
2054 u16 software_iftypes;
2055
2056 u16 n_addresses;
2057
2058 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2059 u16 interface_modes;
2060
2061 u32 flags, features;
2062
2063 u32 ap_sme_capa;
2064
2065 enum cfg80211_signal_type signal_type;
2066
2067 int bss_priv_size;
2068 u8 max_scan_ssids;
2069 u8 max_sched_scan_ssids;
2070 u8 max_match_sets;
2071 u16 max_scan_ie_len;
2072 u16 max_sched_scan_ie_len;
2073
2074 int n_cipher_suites;
2075 const u32 *cipher_suites;
2076
2077 u8 retry_short;
2078 u8 retry_long;
2079 u32 frag_threshold;
2080 u32 rts_threshold;
2081 u8 coverage_class;
2082
2083 char fw_version[ETHTOOL_BUSINFO_LEN];
2084 u32 hw_version;
2085
2086 struct wiphy_wowlan_support wowlan;
2087
2088 u16 max_remain_on_channel_duration;
2089
2090 u8 max_num_pmkids;
2091
2092 u32 available_antennas_tx;
2093 u32 available_antennas_rx;
2094
2095 /*
2096 * Bitmap of supported protocols for probe response offloading
2097 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2098 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2099 */
2100 u32 probe_resp_offload;
2101
2102 /* If multiple wiphys are registered and you're handed e.g.
2103 * a regular netdev with assigned ieee80211_ptr, you won't
2104 * know whether it points to a wiphy your driver has registered
2105 * or not. Assign this to something global to your driver to
2106 * help determine whether you own this wiphy or not. */
2107 const void *privid;
2108
2109 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2110
2111 /* Lets us get back the wiphy on the callback */
2112 int (*reg_notifier)(struct wiphy *wiphy,
2113 struct regulatory_request *request);
2114
2115 /* fields below are read-only, assigned by cfg80211 */
2116
2117 const struct ieee80211_regdomain *regd;
2118
2119 /* the item in /sys/class/ieee80211/ points to this,
2120 * you need use set_wiphy_dev() (see below) */
2121 struct device dev;
2122
2123 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2124 bool registered;
2125
2126 /* dir in debugfs: ieee80211/<wiphyname> */
2127 struct dentry *debugfsdir;
2128
2129 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2130
2131#ifdef CONFIG_NET_NS
2132 /* the network namespace this phy lives in currently */
2133 struct net *_net;
2134#endif
2135
2136#ifdef CONFIG_CFG80211_WEXT
2137 const struct iw_handler_def *wext;
2138#endif
2139
2140 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
2141};
2142
2143static inline struct net *wiphy_net(struct wiphy *wiphy)
2144{
2145 return read_pnet(&wiphy->_net);
2146}
2147
2148static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2149{
2150 write_pnet(&wiphy->_net, net);
2151}
2152
2153/**
2154 * wiphy_priv - return priv from wiphy
2155 *
2156 * @wiphy: the wiphy whose priv pointer to return
2157 */
2158static inline void *wiphy_priv(struct wiphy *wiphy)
2159{
2160 BUG_ON(!wiphy);
2161 return &wiphy->priv;
2162}
2163
2164/**
2165 * priv_to_wiphy - return the wiphy containing the priv
2166 *
2167 * @priv: a pointer previously returned by wiphy_priv
2168 */
2169static inline struct wiphy *priv_to_wiphy(void *priv)
2170{
2171 BUG_ON(!priv);
2172 return container_of(priv, struct wiphy, priv);
2173}
2174
2175/**
2176 * set_wiphy_dev - set device pointer for wiphy
2177 *
2178 * @wiphy: The wiphy whose device to bind
2179 * @dev: The device to parent it to
2180 */
2181static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2182{
2183 wiphy->dev.parent = dev;
2184}
2185
2186/**
2187 * wiphy_dev - get wiphy dev pointer
2188 *
2189 * @wiphy: The wiphy whose device struct to look up
2190 */
2191static inline struct device *wiphy_dev(struct wiphy *wiphy)
2192{
2193 return wiphy->dev.parent;
2194}
2195
2196/**
2197 * wiphy_name - get wiphy name
2198 *
2199 * @wiphy: The wiphy whose name to return
2200 */
2201static inline const char *wiphy_name(const struct wiphy *wiphy)
2202{
2203 return dev_name(&wiphy->dev);
2204}
2205
2206/**
2207 * wiphy_new - create a new wiphy for use with cfg80211
2208 *
2209 * @ops: The configuration operations for this device
2210 * @sizeof_priv: The size of the private area to allocate
2211 *
2212 * Create a new wiphy and associate the given operations with it.
2213 * @sizeof_priv bytes are allocated for private use.
2214 *
2215 * The returned pointer must be assigned to each netdev's
2216 * ieee80211_ptr for proper operation.
2217 */
2218struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2219
2220/**
2221 * wiphy_register - register a wiphy with cfg80211
2222 *
2223 * @wiphy: The wiphy to register.
2224 *
2225 * Returns a non-negative wiphy index or a negative error code.
2226 */
2227extern int wiphy_register(struct wiphy *wiphy);
2228
2229/**
2230 * wiphy_unregister - deregister a wiphy from cfg80211
2231 *
2232 * @wiphy: The wiphy to unregister.
2233 *
2234 * After this call, no more requests can be made with this priv
2235 * pointer, but the call may sleep to wait for an outstanding
2236 * request that is being handled.
2237 */
2238extern void wiphy_unregister(struct wiphy *wiphy);
2239
2240/**
2241 * wiphy_free - free wiphy
2242 *
2243 * @wiphy: The wiphy to free
2244 */
2245extern void wiphy_free(struct wiphy *wiphy);
2246
2247/* internal structs */
2248struct cfg80211_conn;
2249struct cfg80211_internal_bss;
2250struct cfg80211_cached_keys;
2251
2252/**
2253 * struct wireless_dev - wireless per-netdev state
2254 *
2255 * This structure must be allocated by the driver/stack
2256 * that uses the ieee80211_ptr field in struct net_device
2257 * (this is intentional so it can be allocated along with
2258 * the netdev.)
2259 *
2260 * @wiphy: pointer to hardware description
2261 * @iftype: interface type
2262 * @list: (private) Used to collect the interfaces
2263 * @netdev: (private) Used to reference back to the netdev
2264 * @current_bss: (private) Used by the internal configuration code
2265 * @channel: (private) Used by the internal configuration code to track
2266 * user-set AP, monitor and WDS channels for wireless extensions
2267 * @bssid: (private) Used by the internal configuration code
2268 * @ssid: (private) Used by the internal configuration code
2269 * @ssid_len: (private) Used by the internal configuration code
2270 * @mesh_id_len: (private) Used by the internal configuration code
2271 * @mesh_id_up_len: (private) Used by the internal configuration code
2272 * @wext: (private) Used by the internal wireless extensions compat code
2273 * @use_4addr: indicates 4addr mode is used on this interface, must be
2274 * set by driver (if supported) on add_interface BEFORE registering the
2275 * netdev and may otherwise be used by driver read-only, will be update
2276 * by cfg80211 on change_interface
2277 * @mgmt_registrations: list of registrations for management frames
2278 * @mgmt_registrations_lock: lock for the list
2279 * @mtx: mutex used to lock data in this struct
2280 * @cleanup_work: work struct used for cleanup that can't be done directly
2281 * @beacon_interval: beacon interval used on this device for transmitting
2282 * beacons, 0 when not valid
2283 */
2284struct wireless_dev {
2285 struct wiphy *wiphy;
2286 enum nl80211_iftype iftype;
2287
2288 /* the remainder of this struct should be private to cfg80211 */
2289 struct list_head list;
2290 struct net_device *netdev;
2291
2292 struct list_head mgmt_registrations;
2293 spinlock_t mgmt_registrations_lock;
2294
2295 struct mutex mtx;
2296
2297 struct work_struct cleanup_work;
2298
2299 bool use_4addr;
2300
2301 /* currently used for IBSS and SME - might be rearranged later */
2302 u8 ssid[IEEE80211_MAX_SSID_LEN];
2303 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2304 enum {
2305 CFG80211_SME_IDLE,
2306 CFG80211_SME_CONNECTING,
2307 CFG80211_SME_CONNECTED,
2308 } sme_state;
2309 struct cfg80211_conn *conn;
2310 struct cfg80211_cached_keys *connect_keys;
2311
2312 struct list_head event_list;
2313 spinlock_t event_lock;
2314
2315 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2316 struct ieee80211_channel *channel;
2317
2318 bool ps;
2319 int ps_timeout;
2320
2321 int beacon_interval;
2322
2323 u32 ap_unexpected_nlpid;
2324
2325#ifdef CONFIG_CFG80211_WEXT
2326 /* wext data */
2327 struct {
2328 struct cfg80211_ibss_params ibss;
2329 struct cfg80211_connect_params connect;
2330 struct cfg80211_cached_keys *keys;
2331 u8 *ie;
2332 size_t ie_len;
2333 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2334 u8 ssid[IEEE80211_MAX_SSID_LEN];
2335 s8 default_key, default_mgmt_key;
2336 bool prev_bssid_valid;
2337 } wext;
2338#endif
2339};
2340
2341/**
2342 * wdev_priv - return wiphy priv from wireless_dev
2343 *
2344 * @wdev: The wireless device whose wiphy's priv pointer to return
2345 */
2346static inline void *wdev_priv(struct wireless_dev *wdev)
2347{
2348 BUG_ON(!wdev);
2349 return wiphy_priv(wdev->wiphy);
2350}
2351
2352/**
2353 * DOC: Utility functions
2354 *
2355 * cfg80211 offers a number of utility functions that can be useful.
2356 */
2357
2358/**
2359 * ieee80211_channel_to_frequency - convert channel number to frequency
2360 * @chan: channel number
2361 * @band: band, necessary due to channel number overlap
2362 */
2363extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2364
2365/**
2366 * ieee80211_frequency_to_channel - convert frequency to channel number
2367 * @freq: center frequency
2368 */
2369extern int ieee80211_frequency_to_channel(int freq);
2370
2371/*
2372 * Name indirection necessary because the ieee80211 code also has
2373 * a function named "ieee80211_get_channel", so if you include
2374 * cfg80211's header file you get cfg80211's version, if you try
2375 * to include both header files you'll (rightfully!) get a symbol
2376 * clash.
2377 */
2378extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2379 int freq);
2380/**
2381 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2382 * @wiphy: the struct wiphy to get the channel for
2383 * @freq: the center frequency of the channel
2384 */
2385static inline struct ieee80211_channel *
2386ieee80211_get_channel(struct wiphy *wiphy, int freq)
2387{
2388 return __ieee80211_get_channel(wiphy, freq);
2389}
2390
2391/**
2392 * ieee80211_get_response_rate - get basic rate for a given rate
2393 *
2394 * @sband: the band to look for rates in
2395 * @basic_rates: bitmap of basic rates
2396 * @bitrate: the bitrate for which to find the basic rate
2397 *
2398 * This function returns the basic rate corresponding to a given
2399 * bitrate, that is the next lower bitrate contained in the basic
2400 * rate map, which is, for this function, given as a bitmap of
2401 * indices of rates in the band's bitrate table.
2402 */
2403struct ieee80211_rate *
2404ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2405 u32 basic_rates, int bitrate);
2406
2407/*
2408 * Radiotap parsing functions -- for controlled injection support
2409 *
2410 * Implemented in net/wireless/radiotap.c
2411 * Documentation in Documentation/networking/radiotap-headers.txt
2412 */
2413
2414struct radiotap_align_size {
2415 uint8_t align:4, size:4;
2416};
2417
2418struct ieee80211_radiotap_namespace {
2419 const struct radiotap_align_size *align_size;
2420 int n_bits;
2421 uint32_t oui;
2422 uint8_t subns;
2423};
2424
2425struct ieee80211_radiotap_vendor_namespaces {
2426 const struct ieee80211_radiotap_namespace *ns;
2427 int n_ns;
2428};
2429
2430/**
2431 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2432 * @this_arg_index: index of current arg, valid after each successful call
2433 * to ieee80211_radiotap_iterator_next()
2434 * @this_arg: pointer to current radiotap arg; it is valid after each
2435 * call to ieee80211_radiotap_iterator_next() but also after
2436 * ieee80211_radiotap_iterator_init() where it will point to
2437 * the beginning of the actual data portion
2438 * @this_arg_size: length of the current arg, for convenience
2439 * @current_namespace: pointer to the current namespace definition
2440 * (or internally %NULL if the current namespace is unknown)
2441 * @is_radiotap_ns: indicates whether the current namespace is the default
2442 * radiotap namespace or not
2443 *
2444 * @_rtheader: pointer to the radiotap header we are walking through
2445 * @_max_length: length of radiotap header in cpu byte ordering
2446 * @_arg_index: next argument index
2447 * @_arg: next argument pointer
2448 * @_next_bitmap: internal pointer to next present u32
2449 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2450 * @_vns: vendor namespace definitions
2451 * @_next_ns_data: beginning of the next namespace's data
2452 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2453 * next bitmap word
2454 *
2455 * Describes the radiotap parser state. Fields prefixed with an underscore
2456 * must not be used by users of the parser, only by the parser internally.
2457 */
2458
2459struct ieee80211_radiotap_iterator {
2460 struct ieee80211_radiotap_header *_rtheader;
2461 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2462 const struct ieee80211_radiotap_namespace *current_namespace;
2463
2464 unsigned char *_arg, *_next_ns_data;
2465 __le32 *_next_bitmap;
2466
2467 unsigned char *this_arg;
2468 int this_arg_index;
2469 int this_arg_size;
2470
2471 int is_radiotap_ns;
2472
2473 int _max_length;
2474 int _arg_index;
2475 uint32_t _bitmap_shifter;
2476 int _reset_on_ext;
2477};
2478
2479extern int ieee80211_radiotap_iterator_init(
2480 struct ieee80211_radiotap_iterator *iterator,
2481 struct ieee80211_radiotap_header *radiotap_header,
2482 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2483
2484extern int ieee80211_radiotap_iterator_next(
2485 struct ieee80211_radiotap_iterator *iterator);
2486
2487
2488extern const unsigned char rfc1042_header[6];
2489extern const unsigned char bridge_tunnel_header[6];
2490
2491/**
2492 * ieee80211_get_hdrlen_from_skb - get header length from data
2493 *
2494 * Given an skb with a raw 802.11 header at the data pointer this function
2495 * returns the 802.11 header length in bytes (not including encryption
2496 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2497 * header the function returns 0.
2498 *
2499 * @skb: the frame
2500 */
2501unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2502
2503/**
2504 * ieee80211_hdrlen - get header length in bytes from frame control
2505 * @fc: frame control field in little-endian format
2506 */
2507unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2508
2509/**
2510 * DOC: Data path helpers
2511 *
2512 * In addition to generic utilities, cfg80211 also offers
2513 * functions that help implement the data path for devices
2514 * that do not do the 802.11/802.3 conversion on the device.
2515 */
2516
2517/**
2518 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2519 * @skb: the 802.11 data frame
2520 * @addr: the device MAC address
2521 * @iftype: the virtual interface type
2522 */
2523int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2524 enum nl80211_iftype iftype);
2525
2526/**
2527 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2528 * @skb: the 802.3 frame
2529 * @addr: the device MAC address
2530 * @iftype: the virtual interface type
2531 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2532 * @qos: build 802.11 QoS data frame
2533 */
2534int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2535 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2536
2537/**
2538 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2539 *
2540 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2541 * 802.3 frames. The @list will be empty if the decode fails. The
2542 * @skb is consumed after the function returns.
2543 *
2544 * @skb: The input IEEE 802.11n A-MSDU frame.
2545 * @list: The output list of 802.3 frames. It must be allocated and
2546 * initialized by by the caller.
2547 * @addr: The device MAC address.
2548 * @iftype: The device interface type.
2549 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2550 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2551 */
2552void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2553 const u8 *addr, enum nl80211_iftype iftype,
2554 const unsigned int extra_headroom,
2555 bool has_80211_header);
2556
2557/**
2558 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2559 * @skb: the data frame
2560 */
2561unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2562
2563/**
2564 * cfg80211_find_ie - find information element in data
2565 *
2566 * @eid: element ID
2567 * @ies: data consisting of IEs
2568 * @len: length of data
2569 *
2570 * This function will return %NULL if the element ID could
2571 * not be found or if the element is invalid (claims to be
2572 * longer than the given data), or a pointer to the first byte
2573 * of the requested element, that is the byte containing the
2574 * element ID. There are no checks on the element length
2575 * other than having to fit into the given data.
2576 */
2577const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2578
2579/**
2580 * cfg80211_find_vendor_ie - find vendor specific information element in data
2581 *
2582 * @oui: vendor OUI
2583 * @oui_type: vendor-specific OUI type
2584 * @ies: data consisting of IEs
2585 * @len: length of data
2586 *
2587 * This function will return %NULL if the vendor specific element ID
2588 * could not be found or if the element is invalid (claims to be
2589 * longer than the given data), or a pointer to the first byte
2590 * of the requested element, that is the byte containing the
2591 * element ID. There are no checks on the element length
2592 * other than having to fit into the given data.
2593 */
2594const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
2595 const u8 *ies, int len);
2596
2597/**
2598 * DOC: Regulatory enforcement infrastructure
2599 *
2600 * TODO
2601 */
2602
2603/**
2604 * regulatory_hint - driver hint to the wireless core a regulatory domain
2605 * @wiphy: the wireless device giving the hint (used only for reporting
2606 * conflicts)
2607 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2608 * should be in. If @rd is set this should be NULL. Note that if you
2609 * set this to NULL you should still set rd->alpha2 to some accepted
2610 * alpha2.
2611 *
2612 * Wireless drivers can use this function to hint to the wireless core
2613 * what it believes should be the current regulatory domain by
2614 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2615 * domain should be in or by providing a completely build regulatory domain.
2616 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2617 * for a regulatory domain structure for the respective country.
2618 *
2619 * The wiphy must have been registered to cfg80211 prior to this call.
2620 * For cfg80211 drivers this means you must first use wiphy_register(),
2621 * for mac80211 drivers you must first use ieee80211_register_hw().
2622 *
2623 * Drivers should check the return value, its possible you can get
2624 * an -ENOMEM.
2625 */
2626extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2627
2628/**
2629 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2630 * @wiphy: the wireless device we want to process the regulatory domain on
2631 * @regd: the custom regulatory domain to use for this wiphy
2632 *
2633 * Drivers can sometimes have custom regulatory domains which do not apply
2634 * to a specific country. Drivers can use this to apply such custom regulatory
2635 * domains. This routine must be called prior to wiphy registration. The
2636 * custom regulatory domain will be trusted completely and as such previous
2637 * default channel settings will be disregarded. If no rule is found for a
2638 * channel on the regulatory domain the channel will be disabled.
2639 */
2640extern void wiphy_apply_custom_regulatory(
2641 struct wiphy *wiphy,
2642 const struct ieee80211_regdomain *regd);
2643
2644/**
2645 * freq_reg_info - get regulatory information for the given frequency
2646 * @wiphy: the wiphy for which we want to process this rule for
2647 * @center_freq: Frequency in KHz for which we want regulatory information for
2648 * @desired_bw_khz: the desired max bandwidth you want to use per
2649 * channel. Note that this is still 20 MHz if you want to use HT40
2650 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2651 * If set to 0 we'll assume you want the standard 20 MHz.
2652 * @reg_rule: the regulatory rule which we have for this frequency
2653 *
2654 * Use this function to get the regulatory rule for a specific frequency on
2655 * a given wireless device. If the device has a specific regulatory domain
2656 * it wants to follow we respect that unless a country IE has been received
2657 * and processed already.
2658 *
2659 * Returns 0 if it was able to find a valid regulatory rule which does
2660 * apply to the given center_freq otherwise it returns non-zero. It will
2661 * also return -ERANGE if we determine the given center_freq does not even have
2662 * a regulatory rule for a frequency range in the center_freq's band. See
2663 * freq_in_rule_band() for our current definition of a band -- this is purely
2664 * subjective and right now its 802.11 specific.
2665 */
2666extern int freq_reg_info(struct wiphy *wiphy,
2667 u32 center_freq,
2668 u32 desired_bw_khz,
2669 const struct ieee80211_reg_rule **reg_rule);
2670
2671/*
2672 * callbacks for asynchronous cfg80211 methods, notification
2673 * functions and BSS handling helpers
2674 */
2675
2676/**
2677 * cfg80211_scan_done - notify that scan finished
2678 *
2679 * @request: the corresponding scan request
2680 * @aborted: set to true if the scan was aborted for any reason,
2681 * userspace will be notified of that
2682 */
2683void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2684
2685/**
2686 * cfg80211_sched_scan_results - notify that new scan results are available
2687 *
2688 * @wiphy: the wiphy which got scheduled scan results
2689 */
2690void cfg80211_sched_scan_results(struct wiphy *wiphy);
2691
2692/**
2693 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2694 *
2695 * @wiphy: the wiphy on which the scheduled scan stopped
2696 *
2697 * The driver can call this function to inform cfg80211 that the
2698 * scheduled scan had to be stopped, for whatever reason. The driver
2699 * is then called back via the sched_scan_stop operation when done.
2700 */
2701void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
2702
2703/**
2704 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2705 *
2706 * @wiphy: the wiphy reporting the BSS
2707 * @channel: The channel the frame was received on
2708 * @mgmt: the management frame (probe response or beacon)
2709 * @len: length of the management frame
2710 * @signal: the signal strength, type depends on the wiphy's signal_type
2711 * @gfp: context flags
2712 *
2713 * This informs cfg80211 that BSS information was found and
2714 * the BSS should be updated/added.
2715 *
2716 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2717 */
2718struct cfg80211_bss * __must_check
2719cfg80211_inform_bss_frame(struct wiphy *wiphy,
2720 struct ieee80211_channel *channel,
2721 struct ieee80211_mgmt *mgmt, size_t len,
2722 s32 signal, gfp_t gfp);
2723
2724/**
2725 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2726 *
2727 * @wiphy: the wiphy reporting the BSS
2728 * @channel: The channel the frame was received on
2729 * @bssid: the BSSID of the BSS
2730 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
2731 * @capability: the capability field sent by the peer
2732 * @beacon_interval: the beacon interval announced by the peer
2733 * @ie: additional IEs sent by the peer
2734 * @ielen: length of the additional IEs
2735 * @signal: the signal strength, type depends on the wiphy's signal_type
2736 * @gfp: context flags
2737 *
2738 * This informs cfg80211 that BSS information was found and
2739 * the BSS should be updated/added.
2740 *
2741 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2742 */
2743struct cfg80211_bss * __must_check
2744cfg80211_inform_bss(struct wiphy *wiphy,
2745 struct ieee80211_channel *channel,
2746 const u8 *bssid, u64 tsf, u16 capability,
2747 u16 beacon_interval, const u8 *ie, size_t ielen,
2748 s32 signal, gfp_t gfp);
2749
2750struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2751 struct ieee80211_channel *channel,
2752 const u8 *bssid,
2753 const u8 *ssid, size_t ssid_len,
2754 u16 capa_mask, u16 capa_val);
2755static inline struct cfg80211_bss *
2756cfg80211_get_ibss(struct wiphy *wiphy,
2757 struct ieee80211_channel *channel,
2758 const u8 *ssid, size_t ssid_len)
2759{
2760 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2761 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2762}
2763
2764struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2765 struct ieee80211_channel *channel,
2766 const u8 *meshid, size_t meshidlen,
2767 const u8 *meshcfg);
2768/**
2769 * cfg80211_ref_bss - reference BSS struct
2770 * @bss: the BSS struct to reference
2771 *
2772 * Increments the refcount of the given BSS struct.
2773 */
2774void cfg80211_ref_bss(struct cfg80211_bss *bss);
2775
2776/**
2777 * cfg80211_put_bss - unref BSS struct
2778 * @bss: the BSS struct
2779 *
2780 * Decrements the refcount of the given BSS struct.
2781 */
2782void cfg80211_put_bss(struct cfg80211_bss *bss);
2783
2784/**
2785 * cfg80211_unlink_bss - unlink BSS from internal data structures
2786 * @wiphy: the wiphy
2787 * @bss: the bss to remove
2788 *
2789 * This function removes the given BSS from the internal data structures
2790 * thereby making it no longer show up in scan results etc. Use this
2791 * function when you detect a BSS is gone. Normally BSSes will also time
2792 * out, so it is not necessary to use this function at all.
2793 */
2794void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2795
2796/**
2797 * cfg80211_send_rx_auth - notification of processed authentication
2798 * @dev: network device
2799 * @buf: authentication frame (header + body)
2800 * @len: length of the frame data
2801 *
2802 * This function is called whenever an authentication has been processed in
2803 * station mode. The driver is required to call either this function or
2804 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2805 * call. This function may sleep.
2806 */
2807void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2808
2809/**
2810 * cfg80211_send_auth_timeout - notification of timed out authentication
2811 * @dev: network device
2812 * @addr: The MAC address of the device with which the authentication timed out
2813 *
2814 * This function may sleep.
2815 */
2816void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2817
2818/**
2819 * cfg80211_send_rx_assoc - notification of processed association
2820 * @dev: network device
2821 * @bss: the BSS struct association was requested for, the struct reference
2822 * is owned by cfg80211 after this call
2823 * @buf: (re)association response frame (header + body)
2824 * @len: length of the frame data
2825 *
2826 * This function is called whenever a (re)association response has been
2827 * processed in station mode. The driver is required to call either this
2828 * function or cfg80211_send_assoc_timeout() to indicate the result of
2829 * cfg80211_ops::assoc() call. This function may sleep.
2830 */
2831void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
2832 const u8 *buf, size_t len);
2833
2834/**
2835 * cfg80211_send_assoc_timeout - notification of timed out association
2836 * @dev: network device
2837 * @addr: The MAC address of the device with which the association timed out
2838 *
2839 * This function may sleep.
2840 */
2841void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2842
2843/**
2844 * cfg80211_send_deauth - notification of processed deauthentication
2845 * @dev: network device
2846 * @buf: deauthentication frame (header + body)
2847 * @len: length of the frame data
2848 *
2849 * This function is called whenever deauthentication has been processed in
2850 * station mode. This includes both received deauthentication frames and
2851 * locally generated ones. This function may sleep.
2852 */
2853void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2854
2855/**
2856 * __cfg80211_send_deauth - notification of processed deauthentication
2857 * @dev: network device
2858 * @buf: deauthentication frame (header + body)
2859 * @len: length of the frame data
2860 *
2861 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2862 */
2863void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2864
2865/**
2866 * cfg80211_send_disassoc - notification of processed disassociation
2867 * @dev: network device
2868 * @buf: disassociation response frame (header + body)
2869 * @len: length of the frame data
2870 *
2871 * This function is called whenever disassociation has been processed in
2872 * station mode. This includes both received disassociation frames and locally
2873 * generated ones. This function may sleep.
2874 */
2875void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2876
2877/**
2878 * __cfg80211_send_disassoc - notification of processed disassociation
2879 * @dev: network device
2880 * @buf: disassociation response frame (header + body)
2881 * @len: length of the frame data
2882 *
2883 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2884 */
2885void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2886 size_t len);
2887
2888/**
2889 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2890 * @dev: network device
2891 * @buf: deauthentication frame (header + body)
2892 * @len: length of the frame data
2893 *
2894 * This function is called whenever a received Deauthentication frame has been
2895 * dropped in station mode because of MFP being used but the Deauthentication
2896 * frame was not protected. This function may sleep.
2897 */
2898void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
2899 size_t len);
2900
2901/**
2902 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2903 * @dev: network device
2904 * @buf: disassociation frame (header + body)
2905 * @len: length of the frame data
2906 *
2907 * This function is called whenever a received Disassociation frame has been
2908 * dropped in station mode because of MFP being used but the Disassociation
2909 * frame was not protected. This function may sleep.
2910 */
2911void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
2912 size_t len);
2913
2914/**
2915 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2916 * @dev: network device
2917 * @addr: The source MAC address of the frame
2918 * @key_type: The key type that the received frame used
2919 * @key_id: Key identifier (0..3). Can be -1 if missing.
2920 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2921 * @gfp: allocation flags
2922 *
2923 * This function is called whenever the local MAC detects a MIC failure in a
2924 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2925 * primitive.
2926 */
2927void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2928 enum nl80211_key_type key_type, int key_id,
2929 const u8 *tsc, gfp_t gfp);
2930
2931/**
2932 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2933 *
2934 * @dev: network device
2935 * @bssid: the BSSID of the IBSS joined
2936 * @gfp: allocation flags
2937 *
2938 * This function notifies cfg80211 that the device joined an IBSS or
2939 * switched to a different BSSID. Before this function can be called,
2940 * either a beacon has to have been received from the IBSS, or one of
2941 * the cfg80211_inform_bss{,_frame} functions must have been called
2942 * with the locally generated beacon -- this guarantees that there is
2943 * always a scan result for this IBSS. cfg80211 will handle the rest.
2944 */
2945void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2946
2947/**
2948 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
2949 *
2950 * @dev: network device
2951 * @macaddr: the MAC address of the new candidate
2952 * @ie: information elements advertised by the peer candidate
2953 * @ie_len: lenght of the information elements buffer
2954 * @gfp: allocation flags
2955 *
2956 * This function notifies cfg80211 that the mesh peer candidate has been
2957 * detected, most likely via a beacon or, less likely, via a probe response.
2958 * cfg80211 then sends a notification to userspace.
2959 */
2960void cfg80211_notify_new_peer_candidate(struct net_device *dev,
2961 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
2962
2963/**
2964 * DOC: RFkill integration
2965 *
2966 * RFkill integration in cfg80211 is almost invisible to drivers,
2967 * as cfg80211 automatically registers an rfkill instance for each
2968 * wireless device it knows about. Soft kill is also translated
2969 * into disconnecting and turning all interfaces off, drivers are
2970 * expected to turn off the device when all interfaces are down.
2971 *
2972 * However, devices may have a hard RFkill line, in which case they
2973 * also need to interact with the rfkill subsystem, via cfg80211.
2974 * They can do this with a few helper functions documented here.
2975 */
2976
2977/**
2978 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2979 * @wiphy: the wiphy
2980 * @blocked: block status
2981 */
2982void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2983
2984/**
2985 * wiphy_rfkill_start_polling - start polling rfkill
2986 * @wiphy: the wiphy
2987 */
2988void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2989
2990/**
2991 * wiphy_rfkill_stop_polling - stop polling rfkill
2992 * @wiphy: the wiphy
2993 */
2994void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2995
2996#ifdef CONFIG_NL80211_TESTMODE
2997/**
2998 * DOC: Test mode
2999 *
3000 * Test mode is a set of utility functions to allow drivers to
3001 * interact with driver-specific tools to aid, for instance,
3002 * factory programming.
3003 *
3004 * This chapter describes how drivers interact with it, for more
3005 * information see the nl80211 book's chapter on it.
3006 */
3007
3008/**
3009 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3010 * @wiphy: the wiphy
3011 * @approxlen: an upper bound of the length of the data that will
3012 * be put into the skb
3013 *
3014 * This function allocates and pre-fills an skb for a reply to
3015 * the testmode command. Since it is intended for a reply, calling
3016 * it outside of the @testmode_cmd operation is invalid.
3017 *
3018 * The returned skb (or %NULL if any errors happen) is pre-filled
3019 * with the wiphy index and set up in a way that any data that is
3020 * put into the skb (with skb_put(), nla_put() or similar) will end
3021 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
3022 * needs to be done with the skb is adding data for the corresponding
3023 * userspace tool which can then read that data out of the testdata
3024 * attribute. You must not modify the skb in any other way.
3025 *
3026 * When done, call cfg80211_testmode_reply() with the skb and return
3027 * its error code as the result of the @testmode_cmd operation.
3028 */
3029struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3030 int approxlen);
3031
3032/**
3033 * cfg80211_testmode_reply - send the reply skb
3034 * @skb: The skb, must have been allocated with
3035 * cfg80211_testmode_alloc_reply_skb()
3036 *
3037 * Returns an error code or 0 on success, since calling this
3038 * function will usually be the last thing before returning
3039 * from the @testmode_cmd you should return the error code.
3040 * Note that this function consumes the skb regardless of the
3041 * return value.
3042 */
3043int cfg80211_testmode_reply(struct sk_buff *skb);
3044
3045/**
3046 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3047 * @wiphy: the wiphy
3048 * @approxlen: an upper bound of the length of the data that will
3049 * be put into the skb
3050 * @gfp: allocation flags
3051 *
3052 * This function allocates and pre-fills an skb for an event on the
3053 * testmode multicast group.
3054 *
3055 * The returned skb (or %NULL if any errors happen) is set up in the
3056 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
3057 * for an event. As there, you should simply add data to it that will
3058 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
3059 * not modify the skb in any other way.
3060 *
3061 * When done filling the skb, call cfg80211_testmode_event() with the
3062 * skb to send the event.
3063 */
3064struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3065 int approxlen, gfp_t gfp);
3066
3067/**
3068 * cfg80211_testmode_event - send the event
3069 * @skb: The skb, must have been allocated with
3070 * cfg80211_testmode_alloc_event_skb()
3071 * @gfp: allocation flags
3072 *
3073 * This function sends the given @skb, which must have been allocated
3074 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3075 * consumes it.
3076 */
3077void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3078
3079#define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3080#define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3081#else
3082#define CFG80211_TESTMODE_CMD(cmd)
3083#define CFG80211_TESTMODE_DUMP(cmd)
3084#endif
3085
3086/**
3087 * cfg80211_connect_result - notify cfg80211 of connection result
3088 *
3089 * @dev: network device
3090 * @bssid: the BSSID of the AP
3091 * @req_ie: association request IEs (maybe be %NULL)
3092 * @req_ie_len: association request IEs length
3093 * @resp_ie: association response IEs (may be %NULL)
3094 * @resp_ie_len: assoc response IEs length
3095 * @status: status code, 0 for successful connection, use
3096 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3097 * the real status code for failures.
3098 * @gfp: allocation flags
3099 *
3100 * It should be called by the underlying driver whenever connect() has
3101 * succeeded.
3102 */
3103void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3104 const u8 *req_ie, size_t req_ie_len,
3105 const u8 *resp_ie, size_t resp_ie_len,
3106 u16 status, gfp_t gfp);
3107
3108/**
3109 * cfg80211_roamed - notify cfg80211 of roaming
3110 *
3111 * @dev: network device
3112 * @channel: the channel of the new AP
3113 * @bssid: the BSSID of the new AP
3114 * @req_ie: association request IEs (maybe be %NULL)
3115 * @req_ie_len: association request IEs length
3116 * @resp_ie: association response IEs (may be %NULL)
3117 * @resp_ie_len: assoc response IEs length
3118 * @gfp: allocation flags
3119 *
3120 * It should be called by the underlying driver whenever it roamed
3121 * from one AP to another while connected.
3122 */
3123void cfg80211_roamed(struct net_device *dev,
3124 struct ieee80211_channel *channel,
3125 const u8 *bssid,
3126 const u8 *req_ie, size_t req_ie_len,
3127 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3128
3129/**
3130 * cfg80211_roamed_bss - notify cfg80211 of roaming
3131 *
3132 * @dev: network device
3133 * @bss: entry of bss to which STA got roamed
3134 * @req_ie: association request IEs (maybe be %NULL)
3135 * @req_ie_len: association request IEs length
3136 * @resp_ie: association response IEs (may be %NULL)
3137 * @resp_ie_len: assoc response IEs length
3138 * @gfp: allocation flags
3139 *
3140 * This is just a wrapper to notify cfg80211 of roaming event with driver
3141 * passing bss to avoid a race in timeout of the bss entry. It should be
3142 * called by the underlying driver whenever it roamed from one AP to another
3143 * while connected. Drivers which have roaming implemented in firmware
3144 * may use this function to avoid a race in bss entry timeout where the bss
3145 * entry of the new AP is seen in the driver, but gets timed out by the time
3146 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3147 * rdev->event_work. In case of any failures, the reference is released
3148 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3149 * it will be released while diconneting from the current bss.
3150 */
3151void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3152 const u8 *req_ie, size_t req_ie_len,
3153 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3154
3155/**
3156 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3157 *
3158 * @dev: network device
3159 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3160 * @ie_len: length of IEs
3161 * @reason: reason code for the disconnection, set it to 0 if unknown
3162 * @gfp: allocation flags
3163 *
3164 * After it calls this function, the driver should enter an idle state
3165 * and not try to connect to any AP any more.
3166 */
3167void cfg80211_disconnected(struct net_device *dev, u16 reason,
3168 u8 *ie, size_t ie_len, gfp_t gfp);
3169
3170/**
3171 * cfg80211_ready_on_channel - notification of remain_on_channel start
3172 * @dev: network device
3173 * @cookie: the request cookie
3174 * @chan: The current channel (from remain_on_channel request)
3175 * @channel_type: Channel type
3176 * @duration: Duration in milliseconds that the driver intents to remain on the
3177 * channel
3178 * @gfp: allocation flags
3179 */
3180void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
3181 struct ieee80211_channel *chan,
3182 enum nl80211_channel_type channel_type,
3183 unsigned int duration, gfp_t gfp);
3184
3185/**
3186 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3187 * @dev: network device
3188 * @cookie: the request cookie
3189 * @chan: The current channel (from remain_on_channel request)
3190 * @channel_type: Channel type
3191 * @gfp: allocation flags
3192 */
3193void cfg80211_remain_on_channel_expired(struct net_device *dev,
3194 u64 cookie,
3195 struct ieee80211_channel *chan,
3196 enum nl80211_channel_type channel_type,
3197 gfp_t gfp);
3198
3199
3200/**
3201 * cfg80211_new_sta - notify userspace about station
3202 *
3203 * @dev: the netdev
3204 * @mac_addr: the station's address
3205 * @sinfo: the station information
3206 * @gfp: allocation flags
3207 */
3208void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3209 struct station_info *sinfo, gfp_t gfp);
3210
3211/**
3212 * cfg80211_del_sta - notify userspace about deletion of a station
3213 *
3214 * @dev: the netdev
3215 * @mac_addr: the station's address
3216 * @gfp: allocation flags
3217 */
3218void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3219
3220/**
3221 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3222 * @dev: network device
3223 * @freq: Frequency on which the frame was received in MHz
3224 * @sig_dbm: signal strength in mBm, or 0 if unknown
3225 * @buf: Management frame (header + body)
3226 * @len: length of the frame data
3227 * @gfp: context flags
3228 *
3229 * Returns %true if a user space application has registered for this frame.
3230 * For action frames, that makes it responsible for rejecting unrecognized
3231 * action frames; %false otherwise, in which case for action frames the
3232 * driver is responsible for rejecting the frame.
3233 *
3234 * This function is called whenever an Action frame is received for a station
3235 * mode interface, but is not processed in kernel.
3236 */
3237bool cfg80211_rx_mgmt(struct net_device *dev, int freq, int sig_dbm,
3238 const u8 *buf, size_t len, gfp_t gfp);
3239
3240/**
3241 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3242 * @dev: network device
3243 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3244 * @buf: Management frame (header + body)
3245 * @len: length of the frame data
3246 * @ack: Whether frame was acknowledged
3247 * @gfp: context flags
3248 *
3249 * This function is called whenever a management frame was requested to be
3250 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3251 * transmission attempt.
3252 */
3253void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
3254 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3255
3256
3257/**
3258 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3259 * @dev: network device
3260 * @rssi_event: the triggered RSSI event
3261 * @gfp: context flags
3262 *
3263 * This function is called when a configured connection quality monitoring
3264 * rssi threshold reached event occurs.
3265 */
3266void cfg80211_cqm_rssi_notify(struct net_device *dev,
3267 enum nl80211_cqm_rssi_threshold_event rssi_event,
3268 gfp_t gfp);
3269
3270/**
3271 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3272 * @dev: network device
3273 * @peer: peer's MAC address
3274 * @num_packets: how many packets were lost -- should be a fixed threshold
3275 * but probably no less than maybe 50, or maybe a throughput dependent
3276 * threshold (to account for temporary interference)
3277 * @gfp: context flags
3278 */
3279void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3280 const u8 *peer, u32 num_packets, gfp_t gfp);
3281
3282/**
3283 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3284 * @dev: network device
3285 * @bssid: BSSID of AP (to avoid races)
3286 * @replay_ctr: new replay counter
3287 * @gfp: allocation flags
3288 */
3289void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3290 const u8 *replay_ctr, gfp_t gfp);
3291
3292/**
3293 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3294 * @dev: network device
3295 * @index: candidate index (the smaller the index, the higher the priority)
3296 * @bssid: BSSID of AP
3297 * @preauth: Whether AP advertises support for RSN pre-authentication
3298 * @gfp: allocation flags
3299 */
3300void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3301 const u8 *bssid, bool preauth, gfp_t gfp);
3302
3303/**
3304 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3305 * @dev: The device the frame matched to
3306 * @addr: the transmitter address
3307 * @gfp: context flags
3308 *
3309 * This function is used in AP mode (only!) to inform userspace that
3310 * a spurious class 3 frame was received, to be able to deauth the
3311 * sender.
3312 * Returns %true if the frame was passed to userspace (or this failed
3313 * for a reason other than not having a subscription.)
3314 */
3315bool cfg80211_rx_spurious_frame(struct net_device *dev,
3316 const u8 *addr, gfp_t gfp);
3317
3318/**
3319 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3320 * @dev: The device the frame matched to
3321 * @addr: the transmitter address
3322 * @gfp: context flags
3323 *
3324 * This function is used in AP mode (only!) to inform userspace that
3325 * an associated station sent a 4addr frame but that wasn't expected.
3326 * It is allowed and desirable to send this event only once for each
3327 * station to avoid event flooding.
3328 * Returns %true if the frame was passed to userspace (or this failed
3329 * for a reason other than not having a subscription.)
3330 */
3331bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3332 const u8 *addr, gfp_t gfp);
3333
3334/**
3335 * cfg80211_probe_status - notify userspace about probe status
3336 * @dev: the device the probe was sent on
3337 * @addr: the address of the peer
3338 * @cookie: the cookie filled in @probe_client previously
3339 * @acked: indicates whether probe was acked or not
3340 * @gfp: allocation flags
3341 */
3342void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3343 u64 cookie, bool acked, gfp_t gfp);
3344
3345/**
3346 * cfg80211_report_obss_beacon - report beacon from other APs
3347 * @wiphy: The wiphy that received the beacon
3348 * @frame: the frame
3349 * @len: length of the frame
3350 * @freq: frequency the frame was received on
3351 * @sig_dbm: signal strength in mBm, or 0 if unknown
3352 * @gfp: allocation flags
3353 *
3354 * Use this function to report to userspace when a beacon was
3355 * received. It is not useful to call this when there is no
3356 * netdev that is in AP/GO mode.
3357 */
3358void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3359 const u8 *frame, size_t len,
3360 int freq, int sig_dbm, gfp_t gfp);
3361
3362/*
3363 * cfg80211_can_beacon_sec_chan - test if ht40 on extension channel can be used
3364 * @wiphy: the wiphy
3365 * @chan: main channel
3366 * @channel_type: HT mode
3367 */
3368bool cfg80211_can_beacon_sec_chan(struct wiphy *wiphy,
3369 struct ieee80211_channel *chan,
3370 enum nl80211_channel_type channel_type);
3371
3372/*
3373 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
3374 * @dev: the device which switched channels
3375 * @freq: new channel frequency (in MHz)
3376 * @type: channel type
3377 *
3378 * Acquires wdev_lock, so must only be called from sleepable driver context!
3379 */
3380void cfg80211_ch_switch_notify(struct net_device *dev, int freq,
3381 enum nl80211_channel_type type);
3382
3383/*
3384 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
3385 * @rate: given rate_info to calculate bitrate from
3386 *
3387 * return 0 if MCS index >= 32
3388 */
3389u16 cfg80211_calculate_bitrate(struct rate_info *rate);
3390
3391/* Logging, debugging and troubleshooting/diagnostic helpers. */
3392
3393/* wiphy_printk helpers, similar to dev_printk */
3394
3395#define wiphy_printk(level, wiphy, format, args...) \
3396 dev_printk(level, &(wiphy)->dev, format, ##args)
3397#define wiphy_emerg(wiphy, format, args...) \
3398 dev_emerg(&(wiphy)->dev, format, ##args)
3399#define wiphy_alert(wiphy, format, args...) \
3400 dev_alert(&(wiphy)->dev, format, ##args)
3401#define wiphy_crit(wiphy, format, args...) \
3402 dev_crit(&(wiphy)->dev, format, ##args)
3403#define wiphy_err(wiphy, format, args...) \
3404 dev_err(&(wiphy)->dev, format, ##args)
3405#define wiphy_warn(wiphy, format, args...) \
3406 dev_warn(&(wiphy)->dev, format, ##args)
3407#define wiphy_notice(wiphy, format, args...) \
3408 dev_notice(&(wiphy)->dev, format, ##args)
3409#define wiphy_info(wiphy, format, args...) \
3410 dev_info(&(wiphy)->dev, format, ##args)
3411
3412#define wiphy_debug(wiphy, format, args...) \
3413 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3414
3415#define wiphy_dbg(wiphy, format, args...) \
3416 dev_dbg(&(wiphy)->dev, format, ##args)
3417
3418#if defined(VERBOSE_DEBUG)
3419#define wiphy_vdbg wiphy_dbg
3420#else
3421#define wiphy_vdbg(wiphy, format, args...) \
3422({ \
3423 if (0) \
3424 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3425 0; \
3426})
3427#endif
3428
3429/*
3430 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3431 * of using a WARN/WARN_ON to get the message out, including the
3432 * file/line information and a backtrace.
3433 */
3434#define wiphy_WARN(wiphy, format, args...) \
3435 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3436
3437#endif /* __NET_CFG80211_H */