nl80211: improve station flags handling
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / net / cfg80211.h
CommitLineData
704232c2
JB
1#ifndef __NET_CFG80211_H
2#define __NET_CFG80211_H
d3236553
JB
3/*
4 * 802.11 device and configuration interface
5 *
6 * Copyright 2006-2009 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 */
704232c2 12
d3236553
JB
13#include <linux/netdevice.h>
14#include <linux/debugfs.h>
15#include <linux/list.h>
704232c2
JB
16#include <linux/netlink.h>
17#include <linux/skbuff.h>
55682965 18#include <linux/nl80211.h>
2a519311
JB
19#include <linux/if_ether.h>
20#include <linux/ieee80211.h>
d3236553
JB
21#include <net/regulatory.h>
22
fee52678 23/* remove once we remove the wext stuff */
d3236553
JB
24#include <net/iw_handler.h>
25#include <linux/wireless.h>
26
704232c2
JB
27
28/*
d3236553
JB
29 * wireless hardware capability structures
30 */
31
32/**
33 * enum ieee80211_band - supported frequency bands
34 *
35 * The bands are assigned this way because the supported
36 * bitrates differ in these bands.
704232c2 37 *
d3236553
JB
38 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
39 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
704232c2 40 */
d3236553
JB
41enum ieee80211_band {
42 IEEE80211_BAND_2GHZ,
43 IEEE80211_BAND_5GHZ,
44
45 /* keep last */
46 IEEE80211_NUM_BANDS
47};
704232c2 48
2ec600d6 49/**
d3236553
JB
50 * enum ieee80211_channel_flags - channel flags
51 *
52 * Channel flags set by the regulatory control code.
53 *
54 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
55 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
56 * on this channel.
57 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
58 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
59 * @IEEE80211_CHAN_NO_FAT_ABOVE: extension channel above this channel
60 * is not permitted.
61 * @IEEE80211_CHAN_NO_FAT_BELOW: extension channel below this channel
62 * is not permitted.
2ec600d6 63 */
d3236553
JB
64enum ieee80211_channel_flags {
65 IEEE80211_CHAN_DISABLED = 1<<0,
66 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
67 IEEE80211_CHAN_NO_IBSS = 1<<2,
68 IEEE80211_CHAN_RADAR = 1<<3,
69 IEEE80211_CHAN_NO_FAT_ABOVE = 1<<4,
70 IEEE80211_CHAN_NO_FAT_BELOW = 1<<5,
2ec600d6
LCC
71};
72
d3236553
JB
73/**
74 * struct ieee80211_channel - channel definition
75 *
76 * This structure describes a single channel for use
77 * with cfg80211.
78 *
79 * @center_freq: center frequency in MHz
80 * @max_bandwidth: maximum allowed bandwidth for this channel, in MHz
81 * @hw_value: hardware-specific value for the channel
82 * @flags: channel flags from &enum ieee80211_channel_flags.
83 * @orig_flags: channel flags at registration time, used by regulatory
84 * code to support devices with additional restrictions
85 * @band: band this channel belongs to.
86 * @max_antenna_gain: maximum antenna gain in dBi
87 * @max_power: maximum transmission power (in dBm)
88 * @beacon_found: helper to regulatory code to indicate when a beacon
89 * has been found on this channel. Use regulatory_hint_found_beacon()
90 * to enable this, this is is useful only on 5 GHz band.
91 * @orig_mag: internal use
92 * @orig_mpwr: internal use
179f831b 93 */
d3236553
JB
94struct ieee80211_channel {
95 enum ieee80211_band band;
96 u16 center_freq;
97 u8 max_bandwidth;
98 u16 hw_value;
99 u32 flags;
100 int max_antenna_gain;
101 int max_power;
102 bool beacon_found;
103 u32 orig_flags;
104 int orig_mag, orig_mpwr;
105};
106
179f831b 107/**
d3236553
JB
108 * enum ieee80211_rate_flags - rate flags
109 *
110 * Hardware/specification flags for rates. These are structured
111 * in a way that allows using the same bitrate structure for
112 * different bands/PHY modes.
113 *
114 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
115 * preamble on this bitrate; only relevant in 2.4GHz band and
116 * with CCK rates.
117 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
118 * when used with 802.11a (on the 5 GHz band); filled by the
119 * core code when registering the wiphy.
120 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
121 * when used with 802.11b (on the 2.4 GHz band); filled by the
122 * core code when registering the wiphy.
123 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
124 * when used with 802.11g (on the 2.4 GHz band); filled by the
125 * core code when registering the wiphy.
126 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
179f831b 127 */
d3236553
JB
128enum ieee80211_rate_flags {
129 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
130 IEEE80211_RATE_MANDATORY_A = 1<<1,
131 IEEE80211_RATE_MANDATORY_B = 1<<2,
132 IEEE80211_RATE_MANDATORY_G = 1<<3,
133 IEEE80211_RATE_ERP_G = 1<<4,
134};
179f831b 135
d3236553
JB
136/**
137 * struct ieee80211_rate - bitrate definition
138 *
139 * This structure describes a bitrate that an 802.11 PHY can
140 * operate with. The two values @hw_value and @hw_value_short
141 * are only for driver use when pointers to this structure are
142 * passed around.
143 *
144 * @flags: rate-specific flags
145 * @bitrate: bitrate in units of 100 Kbps
146 * @hw_value: driver/hardware value for this rate
147 * @hw_value_short: driver/hardware value for this rate when
148 * short preamble is used
149 */
150struct ieee80211_rate {
151 u32 flags;
152 u16 bitrate;
153 u16 hw_value, hw_value_short;
154};
179f831b 155
d3236553
JB
156/**
157 * struct ieee80211_sta_ht_cap - STA's HT capabilities
158 *
159 * This structure describes most essential parameters needed
160 * to describe 802.11n HT capabilities for an STA.
161 *
162 * @ht_supported: is HT supported by the STA
163 * @cap: HT capabilities map as described in 802.11n spec
164 * @ampdu_factor: Maximum A-MPDU length factor
165 * @ampdu_density: Minimum A-MPDU spacing
166 * @mcs: Supported MCS rates
167 */
168struct ieee80211_sta_ht_cap {
169 u16 cap; /* use IEEE80211_HT_CAP_ */
170 bool ht_supported;
171 u8 ampdu_factor;
172 u8 ampdu_density;
173 struct ieee80211_mcs_info mcs;
179f831b
AG
174};
175
d3236553
JB
176/**
177 * struct ieee80211_supported_band - frequency band definition
178 *
179 * This structure describes a frequency band a wiphy
180 * is able to operate in.
181 *
182 * @channels: Array of channels the hardware can operate in
183 * in this band.
184 * @band: the band this structure represents
185 * @n_channels: Number of channels in @channels
186 * @bitrates: Array of bitrates the hardware can operate with
187 * in this band. Must be sorted to give a valid "supported
188 * rates" IE, i.e. CCK rates first, then OFDM.
189 * @n_bitrates: Number of bitrates in @bitrates
190 */
191struct ieee80211_supported_band {
192 struct ieee80211_channel *channels;
193 struct ieee80211_rate *bitrates;
194 enum ieee80211_band band;
195 int n_channels;
196 int n_bitrates;
197 struct ieee80211_sta_ht_cap ht_cap;
198};
179f831b 199
d3236553
JB
200/*
201 * Wireless hardware/device configuration structures and methods
202 */
179f831b 203
d3236553
JB
204/**
205 * struct vif_params - describes virtual interface parameters
206 * @mesh_id: mesh ID to use
207 * @mesh_id_len: length of the mesh ID
208 */
209struct vif_params {
210 u8 *mesh_id;
211 int mesh_id_len;
212};
179f831b 213
d3236553 214/**
41ade00f
JB
215 * struct key_params - key information
216 *
217 * Information about a key
218 *
219 * @key: key material
220 * @key_len: length of key material
221 * @cipher: cipher suite selector
222 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
223 * with the get_key() callback, must be in little endian,
224 * length given by @seq_len.
225 */
226struct key_params {
227 u8 *key;
228 u8 *seq;
229 int key_len;
230 int seq_len;
231 u32 cipher;
232};
233
ed1b6cc7
JB
234/**
235 * struct beacon_parameters - beacon parameters
236 *
237 * Used to configure the beacon for an interface.
238 *
239 * @head: head portion of beacon (before TIM IE)
240 * or %NULL if not changed
241 * @tail: tail portion of beacon (after TIM IE)
242 * or %NULL if not changed
243 * @interval: beacon interval or zero if not changed
244 * @dtim_period: DTIM period or zero if not changed
245 * @head_len: length of @head
246 * @tail_len: length of @tail
247 */
248struct beacon_parameters {
249 u8 *head, *tail;
250 int interval, dtim_period;
251 int head_len, tail_len;
252};
253
2ec600d6
LCC
254/**
255 * enum plink_action - actions to perform in mesh peers
256 *
257 * @PLINK_ACTION_INVALID: action 0 is reserved
258 * @PLINK_ACTION_OPEN: start mesh peer link establishment
259 * @PLINK_ACTION_BLOCL: block traffic from this mesh peer
260 */
261enum plink_actions {
262 PLINK_ACTION_INVALID,
263 PLINK_ACTION_OPEN,
264 PLINK_ACTION_BLOCK,
265};
266
5727ef1b
JB
267/**
268 * struct station_parameters - station parameters
269 *
270 * Used to change and create a new station.
271 *
272 * @vlan: vlan interface station should belong to
273 * @supported_rates: supported rates in IEEE 802.11 format
274 * (or NULL for no change)
275 * @supported_rates_len: number of supported rates
eccb8e8f
JB
276 * @sta_flags_mask: station flags that changed
277 * (bitmask of BIT(NL80211_STA_FLAG_...))
278 * @sta_flags_set: station flags values
279 * (bitmask of BIT(NL80211_STA_FLAG_...))
5727ef1b
JB
280 * @listen_interval: listen interval or -1 for no change
281 * @aid: AID or zero for no change
282 */
283struct station_parameters {
284 u8 *supported_rates;
285 struct net_device *vlan;
eccb8e8f 286 u32 sta_flags_mask, sta_flags_set;
5727ef1b
JB
287 int listen_interval;
288 u16 aid;
289 u8 supported_rates_len;
2ec600d6 290 u8 plink_action;
36aedc90 291 struct ieee80211_ht_cap *ht_capa;
5727ef1b
JB
292};
293
fd5b74dc 294/**
2ec600d6 295 * enum station_info_flags - station information flags
fd5b74dc 296 *
2ec600d6
LCC
297 * Used by the driver to indicate which info in &struct station_info
298 * it has filled in during get_station() or dump_station().
fd5b74dc 299 *
2ec600d6
LCC
300 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
301 * @STATION_INFO_RX_BYTES: @rx_bytes filled
302 * @STATION_INFO_TX_BYTES: @tx_bytes filled
303 * @STATION_INFO_LLID: @llid filled
304 * @STATION_INFO_PLID: @plid filled
305 * @STATION_INFO_PLINK_STATE: @plink_state filled
420e7fab
HR
306 * @STATION_INFO_SIGNAL: @signal filled
307 * @STATION_INFO_TX_BITRATE: @tx_bitrate fields are filled
308 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
98c8a60a
JM
309 * @STATION_INFO_RX_PACKETS: @rx_packets filled
310 * @STATION_INFO_TX_PACKETS: @tx_packets filled
fd5b74dc 311 */
2ec600d6
LCC
312enum station_info_flags {
313 STATION_INFO_INACTIVE_TIME = 1<<0,
314 STATION_INFO_RX_BYTES = 1<<1,
315 STATION_INFO_TX_BYTES = 1<<2,
316 STATION_INFO_LLID = 1<<3,
317 STATION_INFO_PLID = 1<<4,
318 STATION_INFO_PLINK_STATE = 1<<5,
420e7fab
HR
319 STATION_INFO_SIGNAL = 1<<6,
320 STATION_INFO_TX_BITRATE = 1<<7,
98c8a60a
JM
321 STATION_INFO_RX_PACKETS = 1<<8,
322 STATION_INFO_TX_PACKETS = 1<<9,
420e7fab
HR
323};
324
325/**
326 * enum station_info_rate_flags - bitrate info flags
327 *
328 * Used by the driver to indicate the specific rate transmission
329 * type for 802.11n transmissions.
330 *
331 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
332 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
333 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
334 */
335enum rate_info_flags {
336 RATE_INFO_FLAGS_MCS = 1<<0,
337 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
338 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
339};
340
341/**
342 * struct rate_info - bitrate information
343 *
344 * Information about a receiving or transmitting bitrate
345 *
346 * @flags: bitflag of flags from &enum rate_info_flags
347 * @mcs: mcs index if struct describes a 802.11n bitrate
348 * @legacy: bitrate in 100kbit/s for 802.11abg
349 */
350struct rate_info {
351 u8 flags;
352 u8 mcs;
353 u16 legacy;
fd5b74dc
JB
354};
355
356/**
2ec600d6 357 * struct station_info - station information
fd5b74dc 358 *
2ec600d6 359 * Station information filled by driver for get_station() and dump_station.
fd5b74dc 360 *
2ec600d6 361 * @filled: bitflag of flags from &enum station_info_flags
fd5b74dc
JB
362 * @inactive_time: time since last station activity (tx/rx) in milliseconds
363 * @rx_bytes: bytes received from this station
364 * @tx_bytes: bytes transmitted to this station
2ec600d6
LCC
365 * @llid: mesh local link id
366 * @plid: mesh peer link id
367 * @plink_state: mesh peer link state
420e7fab
HR
368 * @signal: signal strength of last received packet in dBm
369 * @txrate: current unicast bitrate to this station
98c8a60a
JM
370 * @rx_packets: packets received from this station
371 * @tx_packets: packets transmitted to this station
fd5b74dc 372 */
2ec600d6 373struct station_info {
fd5b74dc
JB
374 u32 filled;
375 u32 inactive_time;
376 u32 rx_bytes;
377 u32 tx_bytes;
2ec600d6
LCC
378 u16 llid;
379 u16 plid;
380 u8 plink_state;
420e7fab
HR
381 s8 signal;
382 struct rate_info txrate;
98c8a60a
JM
383 u32 rx_packets;
384 u32 tx_packets;
fd5b74dc
JB
385};
386
66f7ac50
MW
387/**
388 * enum monitor_flags - monitor flags
389 *
390 * Monitor interface configuration flags. Note that these must be the bits
391 * according to the nl80211 flags.
392 *
393 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
394 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
395 * @MONITOR_FLAG_CONTROL: pass control frames
396 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
397 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
398 */
399enum monitor_flags {
400 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
401 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
402 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
403 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
404 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
405};
406
2ec600d6
LCC
407/**
408 * enum mpath_info_flags - mesh path information flags
409 *
410 * Used by the driver to indicate which info in &struct mpath_info it has filled
411 * in during get_station() or dump_station().
412 *
413 * MPATH_INFO_FRAME_QLEN: @frame_qlen filled
414 * MPATH_INFO_DSN: @dsn filled
415 * MPATH_INFO_METRIC: @metric filled
416 * MPATH_INFO_EXPTIME: @exptime filled
417 * MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
418 * MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
419 * MPATH_INFO_FLAGS: @flags filled
420 */
421enum mpath_info_flags {
422 MPATH_INFO_FRAME_QLEN = BIT(0),
423 MPATH_INFO_DSN = BIT(1),
424 MPATH_INFO_METRIC = BIT(2),
425 MPATH_INFO_EXPTIME = BIT(3),
426 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
427 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
428 MPATH_INFO_FLAGS = BIT(6),
429};
430
431/**
432 * struct mpath_info - mesh path information
433 *
434 * Mesh path information filled by driver for get_mpath() and dump_mpath().
435 *
436 * @filled: bitfield of flags from &enum mpath_info_flags
437 * @frame_qlen: number of queued frames for this destination
438 * @dsn: destination sequence number
439 * @metric: metric (cost) of this mesh path
440 * @exptime: expiration time for the mesh path from now, in msecs
441 * @flags: mesh path flags
442 * @discovery_timeout: total mesh path discovery timeout, in msecs
443 * @discovery_retries: mesh path discovery retries
444 */
445struct mpath_info {
446 u32 filled;
447 u32 frame_qlen;
448 u32 dsn;
449 u32 metric;
450 u32 exptime;
451 u32 discovery_timeout;
452 u8 discovery_retries;
453 u8 flags;
454};
455
9f1ba906
JM
456/**
457 * struct bss_parameters - BSS parameters
458 *
459 * Used to change BSS parameters (mainly for AP mode).
460 *
461 * @use_cts_prot: Whether to use CTS protection
462 * (0 = no, 1 = yes, -1 = do not change)
463 * @use_short_preamble: Whether the use of short preambles is allowed
464 * (0 = no, 1 = yes, -1 = do not change)
465 * @use_short_slot_time: Whether the use of short slot time is allowed
466 * (0 = no, 1 = yes, -1 = do not change)
90c97a04
JM
467 * @basic_rates: basic rates in IEEE 802.11 format
468 * (or NULL for no change)
469 * @basic_rates_len: number of basic rates
9f1ba906
JM
470 */
471struct bss_parameters {
472 int use_cts_prot;
473 int use_short_preamble;
474 int use_short_slot_time;
90c97a04
JM
475 u8 *basic_rates;
476 u8 basic_rates_len;
9f1ba906 477};
2ec600d6 478
93da9cc1 479struct mesh_config {
480 /* Timeouts in ms */
481 /* Mesh plink management parameters */
482 u16 dot11MeshRetryTimeout;
483 u16 dot11MeshConfirmTimeout;
484 u16 dot11MeshHoldingTimeout;
485 u16 dot11MeshMaxPeerLinks;
486 u8 dot11MeshMaxRetries;
487 u8 dot11MeshTTL;
488 bool auto_open_plinks;
489 /* HWMP parameters */
490 u8 dot11MeshHWMPmaxPREQretries;
491 u32 path_refresh_time;
492 u16 min_discovery_timeout;
493 u32 dot11MeshHWMPactivePathTimeout;
494 u16 dot11MeshHWMPpreqMinInterval;
495 u16 dot11MeshHWMPnetDiameterTraversalTime;
496};
497
31888487
JM
498/**
499 * struct ieee80211_txq_params - TX queue parameters
500 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
501 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
502 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
503 * 1..32767]
504 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
505 * 1..32767]
506 * @aifs: Arbitration interframe space [0..255]
507 */
508struct ieee80211_txq_params {
509 enum nl80211_txq_q queue;
510 u16 txop;
511 u16 cwmin;
512 u16 cwmax;
513 u8 aifs;
514};
515
704232c2
JB
516/* from net/wireless.h */
517struct wiphy;
518
72bdcf34
JM
519/* from net/ieee80211.h */
520struct ieee80211_channel;
521
2a519311
JB
522/**
523 * struct cfg80211_ssid - SSID description
524 * @ssid: the SSID
525 * @ssid_len: length of the ssid
526 */
527struct cfg80211_ssid {
528 u8 ssid[IEEE80211_MAX_SSID_LEN];
529 u8 ssid_len;
530};
531
532/**
533 * struct cfg80211_scan_request - scan request description
534 *
535 * @ssids: SSIDs to scan for (active scan only)
536 * @n_ssids: number of SSIDs
537 * @channels: channels to scan on.
538 * @n_channels: number of channels for each band
70692ad2
JM
539 * @ie: optional information element(s) to add into Probe Request or %NULL
540 * @ie_len: length of ie in octets
2a519311
JB
541 * @wiphy: the wiphy this was for
542 * @ifidx: the interface index
543 */
544struct cfg80211_scan_request {
545 struct cfg80211_ssid *ssids;
546 int n_ssids;
547 struct ieee80211_channel **channels;
548 u32 n_channels;
de95a54b 549 const u8 *ie;
70692ad2 550 size_t ie_len;
2a519311
JB
551
552 /* internal */
553 struct wiphy *wiphy;
554 int ifidx;
555};
556
557/**
558 * enum cfg80211_signal_type - signal type
559 *
560 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
561 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
562 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
563 */
564enum cfg80211_signal_type {
565 CFG80211_SIGNAL_TYPE_NONE,
566 CFG80211_SIGNAL_TYPE_MBM,
567 CFG80211_SIGNAL_TYPE_UNSPEC,
568};
569
570/**
571 * struct cfg80211_bss - BSS description
572 *
573 * This structure describes a BSS (which may also be a mesh network)
574 * for use in scan results and similar.
575 *
576 * @bssid: BSSID of the BSS
577 * @tsf: timestamp of last received update
578 * @beacon_interval: the beacon interval as from the frame
579 * @capability: the capability field in host byte order
580 * @information_elements: the information elements (Note that there
581 * is no guarantee that these are well-formed!)
582 * @len_information_elements: total length of the information elements
77965c97 583 * @signal: signal strength value (type depends on the wiphy's signal_type)
a08c1c1a 584 * @hold: BSS should not expire
78c1c7e1 585 * @free_priv: function pointer to free private data
2a519311
JB
586 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
587 */
588struct cfg80211_bss {
589 struct ieee80211_channel *channel;
590
591 u8 bssid[ETH_ALEN];
592 u64 tsf;
593 u16 beacon_interval;
594 u16 capability;
595 u8 *information_elements;
596 size_t len_information_elements;
597
598 s32 signal;
2a519311 599
78c1c7e1 600 void (*free_priv)(struct cfg80211_bss *bss);
2a519311
JB
601 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
602};
603
636a5d36
JM
604/**
605 * struct cfg80211_auth_request - Authentication request data
606 *
607 * This structure provides information needed to complete IEEE 802.11
608 * authentication.
609 * NOTE: This structure will likely change when more code from mac80211 is
610 * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
611 * Before using this in a driver that does not use mac80211, it would be better
612 * to check the status of that work and better yet, volunteer to work on it.
613 *
614 * @chan: The channel to use or %NULL if not specified (auto-select based on
615 * scan results)
616 * @peer_addr: The address of the peer STA (AP BSSID in infrastructure case);
617 * this field is required to be present; if the driver wants to help with
618 * BSS selection, it should use (yet to be added) MLME event to allow user
619 * space SME to be notified of roaming candidate, so that the SME can then
620 * use the authentication request with the recommended BSSID and whatever
621 * other data may be needed for authentication/association
622 * @ssid: SSID or %NULL if not yet available
623 * @ssid_len: Length of ssid in octets
624 * @auth_type: Authentication type (algorithm)
625 * @ie: Extra IEs to add to Authentication frame or %NULL
626 * @ie_len: Length of ie buffer in octets
627 */
628struct cfg80211_auth_request {
629 struct ieee80211_channel *chan;
630 u8 *peer_addr;
631 const u8 *ssid;
632 size_t ssid_len;
633 enum nl80211_auth_type auth_type;
634 const u8 *ie;
635 size_t ie_len;
636};
637
638/**
639 * struct cfg80211_assoc_request - (Re)Association request data
640 *
641 * This structure provides information needed to complete IEEE 802.11
642 * (re)association.
643 * NOTE: This structure will likely change when more code from mac80211 is
644 * moved into cfg80211 so that non-mac80211 drivers can benefit from it, too.
645 * Before using this in a driver that does not use mac80211, it would be better
646 * to check the status of that work and better yet, volunteer to work on it.
647 *
648 * @chan: The channel to use or %NULL if not specified (auto-select based on
649 * scan results)
650 * @peer_addr: The address of the peer STA (AP BSSID); this field is required
651 * to be present and the STA must be in State 2 (authenticated) with the
652 * peer STA
653 * @ssid: SSID
654 * @ssid_len: Length of ssid in octets
655 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
656 * @ie_len: Length of ie buffer in octets
dc6382ce 657 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
636a5d36
JM
658 */
659struct cfg80211_assoc_request {
660 struct ieee80211_channel *chan;
661 u8 *peer_addr;
662 const u8 *ssid;
663 size_t ssid_len;
664 const u8 *ie;
665 size_t ie_len;
dc6382ce 666 bool use_mfp;
636a5d36
JM
667};
668
669/**
670 * struct cfg80211_deauth_request - Deauthentication request data
671 *
672 * This structure provides information needed to complete IEEE 802.11
673 * deauthentication.
674 *
675 * @peer_addr: The address of the peer STA (AP BSSID); this field is required
676 * to be present and the STA must be authenticated with the peer STA
677 * @ie: Extra IEs to add to Deauthentication frame or %NULL
678 * @ie_len: Length of ie buffer in octets
679 */
680struct cfg80211_deauth_request {
681 u8 *peer_addr;
682 u16 reason_code;
683 const u8 *ie;
684 size_t ie_len;
685};
686
687/**
688 * struct cfg80211_disassoc_request - Disassociation request data
689 *
690 * This structure provides information needed to complete IEEE 802.11
691 * disassocation.
692 *
693 * @peer_addr: The address of the peer STA (AP BSSID); this field is required
694 * to be present and the STA must be associated with the peer STA
695 * @ie: Extra IEs to add to Disassociation frame or %NULL
696 * @ie_len: Length of ie buffer in octets
697 */
698struct cfg80211_disassoc_request {
699 u8 *peer_addr;
700 u16 reason_code;
701 const u8 *ie;
702 size_t ie_len;
703};
704
04a773ad
JB
705/**
706 * struct cfg80211_ibss_params - IBSS parameters
707 *
708 * This structure defines the IBSS parameters for the join_ibss()
709 * method.
710 *
711 * @ssid: The SSID, will always be non-null.
712 * @ssid_len: The length of the SSID, will always be non-zero.
713 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
714 * search for IBSSs with a different BSSID.
715 * @channel: The channel to use if no IBSS can be found to join.
716 * @channel_fixed: The channel should be fixed -- do not search for
717 * IBSSs to join on other channels.
718 * @ie: information element(s) to include in the beacon
719 * @ie_len: length of that
8e30bc55 720 * @beacon_interval: beacon interval to use
04a773ad
JB
721 */
722struct cfg80211_ibss_params {
723 u8 *ssid;
724 u8 *bssid;
725 struct ieee80211_channel *channel;
726 u8 *ie;
727 u8 ssid_len, ie_len;
8e30bc55 728 u16 beacon_interval;
04a773ad
JB
729 bool channel_fixed;
730};
731
b9a5f8ca
JM
732/**
733 * enum wiphy_params_flags - set_wiphy_params bitfield values
734 * WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
735 * WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
736 * WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
737 * WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
738 */
739enum wiphy_params_flags {
740 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
741 WIPHY_PARAM_RETRY_LONG = 1 << 1,
742 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
743 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
744};
745
704232c2
JB
746/**
747 * struct cfg80211_ops - backend description for wireless configuration
748 *
749 * This struct is registered by fullmac card drivers and/or wireless stacks
750 * in order to handle configuration requests on their interfaces.
751 *
752 * All callbacks except where otherwise noted should return 0
753 * on success or a negative error code.
754 *
43fb45cb
JB
755 * All operations are currently invoked under rtnl for consistency with the
756 * wireless extensions but this is subject to reevaluation as soon as this
757 * code is used more widely and we have a first user without wext.
758 *
0378b3f1
JB
759 * @suspend: wiphy device needs to be suspended
760 * @resume: wiphy device needs to be resumed
761 *
60719ffd
JB
762 * @add_virtual_intf: create a new virtual interface with the given name,
763 * must set the struct wireless_dev's iftype.
704232c2
JB
764 *
765 * @del_virtual_intf: remove the virtual interface determined by ifindex.
55682965 766 *
60719ffd
JB
767 * @change_virtual_intf: change type/configuration of virtual interface,
768 * keep the struct wireless_dev's iftype updated.
55682965 769 *
41ade00f
JB
770 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
771 * when adding a group key.
772 *
773 * @get_key: get information about the key with the given parameters.
774 * @mac_addr will be %NULL when requesting information for a group
775 * key. All pointers given to the @callback function need not be valid
776 * after it returns.
777 *
778 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
779 * and @key_index
780 *
781 * @set_default_key: set the default key on an interface
ed1b6cc7 782 *
3cfcf6ac
JM
783 * @set_default_mgmt_key: set the default management frame key on an interface
784 *
ed1b6cc7
JB
785 * @add_beacon: Add a beacon with given parameters, @head, @interval
786 * and @dtim_period will be valid, @tail is optional.
787 * @set_beacon: Change the beacon parameters for an access point mode
788 * interface. This should reject the call when no beacon has been
789 * configured.
790 * @del_beacon: Remove beacon configuration and stop sending the beacon.
5727ef1b
JB
791 *
792 * @add_station: Add a new station.
793 *
794 * @del_station: Remove a station; @mac may be NULL to remove all stations.
795 *
796 * @change_station: Modify a given station.
2ec600d6 797 *
93da9cc1 798 * @get_mesh_params: Put the current mesh parameters into *params
799 *
800 * @set_mesh_params: Set mesh parameters.
801 * The mask is a bitfield which tells us which parameters to
802 * set, and which to leave alone.
803 *
2ec600d6 804 * @set_mesh_cfg: set mesh parameters (by now, just mesh id)
9f1ba906
JM
805 *
806 * @change_bss: Modify parameters for a given BSS.
31888487
JM
807 *
808 * @set_txq_params: Set TX queue parameters
72bdcf34
JM
809 *
810 * @set_channel: Set channel
9aed3cc1 811 *
2a519311
JB
812 * @scan: Request to do a scan. If returning zero, the scan request is given
813 * the driver, and will be valid until passed to cfg80211_scan_done().
814 * For scan results, call cfg80211_inform_bss(); you can call this outside
815 * the scan/scan_done bracket too.
636a5d36
JM
816 *
817 * @auth: Request to authenticate with the specified peer
818 * @assoc: Request to (re)associate with the specified peer
819 * @deauth: Request to deauthenticate from the specified peer
820 * @disassoc: Request to disassociate from the specified peer
04a773ad
JB
821 *
822 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
823 * cfg80211_ibss_joined(), also call that function when changing BSSID due
824 * to a merge.
825 * @leave_ibss: Leave the IBSS.
b9a5f8ca
JM
826 *
827 * @set_wiphy_params: Notify that wiphy parameters have changed;
828 * @changed bitfield (see &enum wiphy_params_flags) describes which values
829 * have changed. The actual parameter values are available in
830 * struct wiphy. If returning an error, no value should be changed.
704232c2
JB
831 */
832struct cfg80211_ops {
0378b3f1
JB
833 int (*suspend)(struct wiphy *wiphy);
834 int (*resume)(struct wiphy *wiphy);
835
704232c2 836 int (*add_virtual_intf)(struct wiphy *wiphy, char *name,
2ec600d6
LCC
837 enum nl80211_iftype type, u32 *flags,
838 struct vif_params *params);
704232c2 839 int (*del_virtual_intf)(struct wiphy *wiphy, int ifindex);
55682965 840 int (*change_virtual_intf)(struct wiphy *wiphy, int ifindex,
2ec600d6
LCC
841 enum nl80211_iftype type, u32 *flags,
842 struct vif_params *params);
41ade00f
JB
843
844 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4e943900 845 u8 key_index, const u8 *mac_addr,
41ade00f
JB
846 struct key_params *params);
847 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4e943900 848 u8 key_index, const u8 *mac_addr, void *cookie,
41ade00f
JB
849 void (*callback)(void *cookie, struct key_params*));
850 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4e943900 851 u8 key_index, const u8 *mac_addr);
41ade00f
JB
852 int (*set_default_key)(struct wiphy *wiphy,
853 struct net_device *netdev,
854 u8 key_index);
3cfcf6ac
JM
855 int (*set_default_mgmt_key)(struct wiphy *wiphy,
856 struct net_device *netdev,
857 u8 key_index);
ed1b6cc7
JB
858
859 int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
860 struct beacon_parameters *info);
861 int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
862 struct beacon_parameters *info);
863 int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
5727ef1b
JB
864
865
866 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
867 u8 *mac, struct station_parameters *params);
868 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
869 u8 *mac);
870 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
871 u8 *mac, struct station_parameters *params);
fd5b74dc 872 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2ec600d6
LCC
873 u8 *mac, struct station_info *sinfo);
874 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
875 int idx, u8 *mac, struct station_info *sinfo);
876
877 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
878 u8 *dst, u8 *next_hop);
879 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
880 u8 *dst);
881 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
882 u8 *dst, u8 *next_hop);
883 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
884 u8 *dst, u8 *next_hop,
885 struct mpath_info *pinfo);
886 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
887 int idx, u8 *dst, u8 *next_hop,
888 struct mpath_info *pinfo);
93da9cc1 889 int (*get_mesh_params)(struct wiphy *wiphy,
890 struct net_device *dev,
891 struct mesh_config *conf);
892 int (*set_mesh_params)(struct wiphy *wiphy,
893 struct net_device *dev,
894 const struct mesh_config *nconf, u32 mask);
9f1ba906
JM
895 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
896 struct bss_parameters *params);
31888487
JM
897
898 int (*set_txq_params)(struct wiphy *wiphy,
899 struct ieee80211_txq_params *params);
72bdcf34
JM
900
901 int (*set_channel)(struct wiphy *wiphy,
902 struct ieee80211_channel *chan,
094d05dc 903 enum nl80211_channel_type channel_type);
9aed3cc1 904
2a519311
JB
905 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
906 struct cfg80211_scan_request *request);
636a5d36
JM
907
908 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
909 struct cfg80211_auth_request *req);
910 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
911 struct cfg80211_assoc_request *req);
912 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
913 struct cfg80211_deauth_request *req);
914 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
915 struct cfg80211_disassoc_request *req);
04a773ad
JB
916
917 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
918 struct cfg80211_ibss_params *params);
919 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
b9a5f8ca
JM
920
921 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
704232c2
JB
922};
923
d3236553
JB
924/*
925 * wireless hardware and networking interfaces structures
926 * and registration/helper functions
927 */
928
929/**
930 * struct wiphy - wireless hardware description
931 * @idx: the wiphy index assigned to this item
932 * @class_dev: the class device representing /sys/class/ieee80211/<wiphy-name>
933 * @custom_regulatory: tells us the driver for this device
934 * has its own custom regulatory domain and cannot identify the
935 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
936 * we will disregard the first regulatory hint (when the
937 * initiator is %REGDOM_SET_BY_CORE).
938 * @strict_regulatory: tells us the driver for this device will ignore
939 * regulatory domain settings until it gets its own regulatory domain
940 * via its regulatory_hint(). After its gets its own regulatory domain
941 * it will only allow further regulatory domain settings to further
942 * enhance compliance. For example if channel 13 and 14 are disabled
943 * by this regulatory domain no user regulatory domain can enable these
944 * channels at a later time. This can be used for devices which do not
945 * have calibration information gauranteed for frequencies or settings
946 * outside of its regulatory domain.
947 * @reg_notifier: the driver's regulatory notification callback
948 * @regd: the driver's regulatory domain, if one was requested via
949 * the regulatory_hint() API. This can be used by the driver
950 * on the reg_notifier() if it chooses to ignore future
951 * regulatory domain changes caused by other drivers.
952 * @signal_type: signal type reported in &struct cfg80211_bss.
953 * @cipher_suites: supported cipher suites
954 * @n_cipher_suites: number of supported cipher suites
b9a5f8ca
JM
955 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
956 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
957 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
958 * -1 = fragmentation disabled, only odd values >= 256 used
959 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
d3236553
JB
960 */
961struct wiphy {
962 /* assign these fields before you register the wiphy */
963
964 /* permanent MAC address */
965 u8 perm_addr[ETH_ALEN];
966
967 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
968 u16 interface_modes;
969
970 bool custom_regulatory;
971 bool strict_regulatory;
972
973 enum cfg80211_signal_type signal_type;
974
975 int bss_priv_size;
976 u8 max_scan_ssids;
977 u16 max_scan_ie_len;
978
979 int n_cipher_suites;
980 const u32 *cipher_suites;
981
b9a5f8ca
JM
982 u8 retry_short;
983 u8 retry_long;
984 u32 frag_threshold;
985 u32 rts_threshold;
986
d3236553
JB
987 /* If multiple wiphys are registered and you're handed e.g.
988 * a regular netdev with assigned ieee80211_ptr, you won't
989 * know whether it points to a wiphy your driver has registered
990 * or not. Assign this to something global to your driver to
991 * help determine whether you own this wiphy or not. */
992 void *privid;
993
994 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
995
996 /* Lets us get back the wiphy on the callback */
997 int (*reg_notifier)(struct wiphy *wiphy,
998 struct regulatory_request *request);
999
1000 /* fields below are read-only, assigned by cfg80211 */
1001
1002 const struct ieee80211_regdomain *regd;
1003
1004 /* the item in /sys/class/ieee80211/ points to this,
1005 * you need use set_wiphy_dev() (see below) */
1006 struct device dev;
1007
1008 /* dir in debugfs: ieee80211/<wiphyname> */
1009 struct dentry *debugfsdir;
1010
1011 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1012};
1013
1014/**
1015 * wiphy_priv - return priv from wiphy
1016 *
1017 * @wiphy: the wiphy whose priv pointer to return
1018 */
1019static inline void *wiphy_priv(struct wiphy *wiphy)
1020{
1021 BUG_ON(!wiphy);
1022 return &wiphy->priv;
1023}
1024
1025/**
1026 * set_wiphy_dev - set device pointer for wiphy
1027 *
1028 * @wiphy: The wiphy whose device to bind
1029 * @dev: The device to parent it to
1030 */
1031static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1032{
1033 wiphy->dev.parent = dev;
1034}
1035
1036/**
1037 * wiphy_dev - get wiphy dev pointer
1038 *
1039 * @wiphy: The wiphy whose device struct to look up
1040 */
1041static inline struct device *wiphy_dev(struct wiphy *wiphy)
1042{
1043 return wiphy->dev.parent;
1044}
1045
1046/**
1047 * wiphy_name - get wiphy name
1048 *
1049 * @wiphy: The wiphy whose name to return
1050 */
1051static inline const char *wiphy_name(struct wiphy *wiphy)
1052{
1053 return dev_name(&wiphy->dev);
1054}
1055
1056/**
1057 * wiphy_new - create a new wiphy for use with cfg80211
1058 *
1059 * @ops: The configuration operations for this device
1060 * @sizeof_priv: The size of the private area to allocate
1061 *
1062 * Create a new wiphy and associate the given operations with it.
1063 * @sizeof_priv bytes are allocated for private use.
1064 *
1065 * The returned pointer must be assigned to each netdev's
1066 * ieee80211_ptr for proper operation.
1067 */
1068struct wiphy *wiphy_new(struct cfg80211_ops *ops, int sizeof_priv);
1069
1070/**
1071 * wiphy_register - register a wiphy with cfg80211
1072 *
1073 * @wiphy: The wiphy to register.
1074 *
1075 * Returns a non-negative wiphy index or a negative error code.
1076 */
1077extern int wiphy_register(struct wiphy *wiphy);
1078
1079/**
1080 * wiphy_unregister - deregister a wiphy from cfg80211
1081 *
1082 * @wiphy: The wiphy to unregister.
1083 *
1084 * After this call, no more requests can be made with this priv
1085 * pointer, but the call may sleep to wait for an outstanding
1086 * request that is being handled.
1087 */
1088extern void wiphy_unregister(struct wiphy *wiphy);
1089
1090/**
1091 * wiphy_free - free wiphy
1092 *
1093 * @wiphy: The wiphy to free
1094 */
1095extern void wiphy_free(struct wiphy *wiphy);
1096
1097/**
1098 * struct wireless_dev - wireless per-netdev state
1099 *
1100 * This structure must be allocated by the driver/stack
1101 * that uses the ieee80211_ptr field in struct net_device
1102 * (this is intentional so it can be allocated along with
1103 * the netdev.)
1104 *
1105 * @wiphy: pointer to hardware description
1106 * @iftype: interface type
1107 * @list: (private) Used to collect the interfaces
1108 * @netdev: (private) Used to reference back to the netdev
1109 * @current_bss: (private) Used by the internal configuration code
1110 * @bssid: (private) Used by the internal configuration code
1111 * @ssid: (private) Used by the internal configuration code
1112 * @ssid_len: (private) Used by the internal configuration code
1113 * @wext: (private) Used by the internal wireless extensions compat code
1114 * @wext_bssid: (private) Used by the internal wireless extensions compat code
1115 */
1116struct wireless_dev {
1117 struct wiphy *wiphy;
1118 enum nl80211_iftype iftype;
1119
1120 /* private to the generic wireless code */
1121 struct list_head list;
1122 struct net_device *netdev;
1123
1124 /* currently used for IBSS - might be rearranged in the future */
1125 struct cfg80211_bss *current_bss;
1126 u8 bssid[ETH_ALEN];
1127 u8 ssid[IEEE80211_MAX_SSID_LEN];
1128 u8 ssid_len;
1129
1130#ifdef CONFIG_WIRELESS_EXT
1131 /* wext data */
cbe8fa9c
JB
1132 struct {
1133 struct cfg80211_ibss_params ibss;
1134 u8 bssid[ETH_ALEN];
08645126 1135 s8 default_key, default_mgmt_key;
cbe8fa9c 1136 } wext;
d3236553
JB
1137#endif
1138};
1139
1140/**
1141 * wdev_priv - return wiphy priv from wireless_dev
1142 *
1143 * @wdev: The wireless device whose wiphy's priv pointer to return
1144 */
1145static inline void *wdev_priv(struct wireless_dev *wdev)
1146{
1147 BUG_ON(!wdev);
1148 return wiphy_priv(wdev->wiphy);
1149}
1150
1151/*
1152 * Utility functions
1153 */
1154
1155/**
1156 * ieee80211_channel_to_frequency - convert channel number to frequency
1157 */
1158extern int ieee80211_channel_to_frequency(int chan);
1159
1160/**
1161 * ieee80211_frequency_to_channel - convert frequency to channel number
1162 */
1163extern int ieee80211_frequency_to_channel(int freq);
1164
1165/*
1166 * Name indirection necessary because the ieee80211 code also has
1167 * a function named "ieee80211_get_channel", so if you include
1168 * cfg80211's header file you get cfg80211's version, if you try
1169 * to include both header files you'll (rightfully!) get a symbol
1170 * clash.
1171 */
1172extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1173 int freq);
1174/**
1175 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
1176 */
1177static inline struct ieee80211_channel *
1178ieee80211_get_channel(struct wiphy *wiphy, int freq)
1179{
1180 return __ieee80211_get_channel(wiphy, freq);
1181}
1182
1183/**
1184 * ieee80211_get_response_rate - get basic rate for a given rate
1185 *
1186 * @sband: the band to look for rates in
1187 * @basic_rates: bitmap of basic rates
1188 * @bitrate: the bitrate for which to find the basic rate
1189 *
1190 * This function returns the basic rate corresponding to a given
1191 * bitrate, that is the next lower bitrate contained in the basic
1192 * rate map, which is, for this function, given as a bitmap of
1193 * indices of rates in the band's bitrate table.
1194 */
1195struct ieee80211_rate *
1196ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1197 u32 basic_rates, int bitrate);
1198
1199/*
1200 * Radiotap parsing functions -- for controlled injection support
1201 *
1202 * Implemented in net/wireless/radiotap.c
1203 * Documentation in Documentation/networking/radiotap-headers.txt
1204 */
1205
1206/**
1207 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
1208 * @rtheader: pointer to the radiotap header we are walking through
1209 * @max_length: length of radiotap header in cpu byte ordering
1210 * @this_arg_index: IEEE80211_RADIOTAP_... index of current arg
1211 * @this_arg: pointer to current radiotap arg
1212 * @arg_index: internal next argument index
1213 * @arg: internal next argument pointer
1214 * @next_bitmap: internal pointer to next present u32
1215 * @bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1216 */
1217
1218struct ieee80211_radiotap_iterator {
1219 struct ieee80211_radiotap_header *rtheader;
1220 int max_length;
1221 int this_arg_index;
1222 u8 *this_arg;
1223
1224 int arg_index;
1225 u8 *arg;
1226 __le32 *next_bitmap;
1227 u32 bitmap_shifter;
1228};
1229
1230extern int ieee80211_radiotap_iterator_init(
1231 struct ieee80211_radiotap_iterator *iterator,
1232 struct ieee80211_radiotap_header *radiotap_header,
1233 int max_length);
1234
1235extern int ieee80211_radiotap_iterator_next(
1236 struct ieee80211_radiotap_iterator *iterator);
1237
1238/*
1239 * Regulatory helper functions for wiphys
1240 */
1241
1242/**
1243 * regulatory_hint - driver hint to the wireless core a regulatory domain
1244 * @wiphy: the wireless device giving the hint (used only for reporting
1245 * conflicts)
1246 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
1247 * should be in. If @rd is set this should be NULL. Note that if you
1248 * set this to NULL you should still set rd->alpha2 to some accepted
1249 * alpha2.
1250 *
1251 * Wireless drivers can use this function to hint to the wireless core
1252 * what it believes should be the current regulatory domain by
1253 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
1254 * domain should be in or by providing a completely build regulatory domain.
1255 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
1256 * for a regulatory domain structure for the respective country.
1257 *
1258 * The wiphy must have been registered to cfg80211 prior to this call.
1259 * For cfg80211 drivers this means you must first use wiphy_register(),
1260 * for mac80211 drivers you must first use ieee80211_register_hw().
1261 *
1262 * Drivers should check the return value, its possible you can get
1263 * an -ENOMEM.
1264 */
1265extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
1266
1267/**
1268 * regulatory_hint_11d - hints a country IE as a regulatory domain
1269 * @wiphy: the wireless device giving the hint (used only for reporting
1270 * conflicts)
1271 * @country_ie: pointer to the country IE
1272 * @country_ie_len: length of the country IE
1273 *
1274 * We will intersect the rd with the what CRDA tells us should apply
1275 * for the alpha2 this country IE belongs to, this prevents APs from
1276 * sending us incorrect or outdated information against a country.
1277 */
1278extern void regulatory_hint_11d(struct wiphy *wiphy,
1279 u8 *country_ie,
1280 u8 country_ie_len);
1281/**
1282 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
1283 * @wiphy: the wireless device we want to process the regulatory domain on
1284 * @regd: the custom regulatory domain to use for this wiphy
1285 *
1286 * Drivers can sometimes have custom regulatory domains which do not apply
1287 * to a specific country. Drivers can use this to apply such custom regulatory
1288 * domains. This routine must be called prior to wiphy registration. The
1289 * custom regulatory domain will be trusted completely and as such previous
1290 * default channel settings will be disregarded. If no rule is found for a
1291 * channel on the regulatory domain the channel will be disabled.
1292 */
1293extern void wiphy_apply_custom_regulatory(
1294 struct wiphy *wiphy,
1295 const struct ieee80211_regdomain *regd);
1296
1297/**
1298 * freq_reg_info - get regulatory information for the given frequency
1299 * @wiphy: the wiphy for which we want to process this rule for
1300 * @center_freq: Frequency in KHz for which we want regulatory information for
1301 * @bandwidth: the bandwidth requirement you have in KHz, if you do not have one
1302 * you can set this to 0. If this frequency is allowed we then set
1303 * this value to the maximum allowed bandwidth.
1304 * @reg_rule: the regulatory rule which we have for this frequency
1305 *
1306 * Use this function to get the regulatory rule for a specific frequency on
1307 * a given wireless device. If the device has a specific regulatory domain
1308 * it wants to follow we respect that unless a country IE has been received
1309 * and processed already.
1310 *
1311 * Returns 0 if it was able to find a valid regulatory rule which does
1312 * apply to the given center_freq otherwise it returns non-zero. It will
1313 * also return -ERANGE if we determine the given center_freq does not even have
1314 * a regulatory rule for a frequency range in the center_freq's band. See
1315 * freq_in_rule_band() for our current definition of a band -- this is purely
1316 * subjective and right now its 802.11 specific.
1317 */
1318extern int freq_reg_info(struct wiphy *wiphy, u32 center_freq, u32 *bandwidth,
1319 const struct ieee80211_reg_rule **reg_rule);
1320
1321/*
1322 * Temporary wext handlers & helper functions
1323 *
1324 * In the future cfg80211 will simply assign the entire wext handler
1325 * structure to netdevs it manages, but we're not there yet.
1326 */
fee52678
JB
1327int cfg80211_wext_giwname(struct net_device *dev,
1328 struct iw_request_info *info,
1329 char *name, char *extra);
e60c7744
JB
1330int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
1331 u32 *mode, char *extra);
1332int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
1333 u32 *mode, char *extra);
2a519311
JB
1334int cfg80211_wext_siwscan(struct net_device *dev,
1335 struct iw_request_info *info,
1336 union iwreq_data *wrqu, char *extra);
1337int cfg80211_wext_giwscan(struct net_device *dev,
1338 struct iw_request_info *info,
1339 struct iw_point *data, char *extra);
691597cb
JB
1340int cfg80211_wext_siwmlme(struct net_device *dev,
1341 struct iw_request_info *info,
1342 struct iw_point *data, char *extra);
4aa188e1
JB
1343int cfg80211_wext_giwrange(struct net_device *dev,
1344 struct iw_request_info *info,
1345 struct iw_point *data, char *extra);
04a773ad
JB
1346int cfg80211_ibss_wext_siwfreq(struct net_device *dev,
1347 struct iw_request_info *info,
1348 struct iw_freq *freq, char *extra);
1349int cfg80211_ibss_wext_giwfreq(struct net_device *dev,
1350 struct iw_request_info *info,
1351 struct iw_freq *freq, char *extra);
1352int cfg80211_ibss_wext_siwessid(struct net_device *dev,
1353 struct iw_request_info *info,
1354 struct iw_point *data, char *ssid);
1355int cfg80211_ibss_wext_giwessid(struct net_device *dev,
1356 struct iw_request_info *info,
1357 struct iw_point *data, char *ssid);
1358int cfg80211_ibss_wext_siwap(struct net_device *dev,
1359 struct iw_request_info *info,
1360 struct sockaddr *ap_addr, char *extra);
1361int cfg80211_ibss_wext_giwap(struct net_device *dev,
1362 struct iw_request_info *info,
1363 struct sockaddr *ap_addr, char *extra);
1364
04a773ad
JB
1365struct ieee80211_channel *cfg80211_wext_freq(struct wiphy *wiphy,
1366 struct iw_freq *freq);
2a519311 1367
b9a5f8ca
JM
1368int cfg80211_wext_siwrts(struct net_device *dev,
1369 struct iw_request_info *info,
1370 struct iw_param *rts, char *extra);
1371int cfg80211_wext_giwrts(struct net_device *dev,
1372 struct iw_request_info *info,
1373 struct iw_param *rts, char *extra);
1374int cfg80211_wext_siwfrag(struct net_device *dev,
1375 struct iw_request_info *info,
1376 struct iw_param *frag, char *extra);
1377int cfg80211_wext_giwfrag(struct net_device *dev,
1378 struct iw_request_info *info,
1379 struct iw_param *frag, char *extra);
1380int cfg80211_wext_siwretry(struct net_device *dev,
1381 struct iw_request_info *info,
1382 struct iw_param *retry, char *extra);
1383int cfg80211_wext_giwretry(struct net_device *dev,
1384 struct iw_request_info *info,
1385 struct iw_param *retry, char *extra);
08645126
JB
1386int cfg80211_wext_siwencodeext(struct net_device *dev,
1387 struct iw_request_info *info,
1388 struct iw_point *erq, char *extra);
1389int cfg80211_wext_siwencode(struct net_device *dev,
1390 struct iw_request_info *info,
1391 struct iw_point *erq, char *keybuf);
1392int cfg80211_wext_giwencode(struct net_device *dev,
1393 struct iw_request_info *info,
1394 struct iw_point *erq, char *keybuf);
b9a5f8ca 1395
d3236553
JB
1396/*
1397 * callbacks for asynchronous cfg80211 methods, notification
1398 * functions and BSS handling helpers
1399 */
1400
2a519311
JB
1401/**
1402 * cfg80211_scan_done - notify that scan finished
1403 *
1404 * @request: the corresponding scan request
1405 * @aborted: set to true if the scan was aborted for any reason,
1406 * userspace will be notified of that
1407 */
1408void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
1409
1410/**
1411 * cfg80211_inform_bss - inform cfg80211 of a new BSS
1412 *
1413 * @wiphy: the wiphy reporting the BSS
1414 * @bss: the found BSS
77965c97 1415 * @signal: the signal strength, type depends on the wiphy's signal_type
2a519311
JB
1416 * @gfp: context flags
1417 *
1418 * This informs cfg80211 that BSS information was found and
1419 * the BSS should be updated/added.
1420 */
1421struct cfg80211_bss*
1422cfg80211_inform_bss_frame(struct wiphy *wiphy,
1423 struct ieee80211_channel *channel,
1424 struct ieee80211_mgmt *mgmt, size_t len,
77965c97 1425 s32 signal, gfp_t gfp);
2a519311 1426
06aa7afa
JK
1427struct cfg80211_bss*
1428cfg80211_inform_bss(struct wiphy *wiphy,
1429 struct ieee80211_channel *channel,
1430 const u8 *bssid,
1431 u64 timestamp, u16 capability, u16 beacon_interval,
1432 const u8 *ie, size_t ielen,
1433 s32 signal, gfp_t gfp);
1434
2a519311
JB
1435struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
1436 struct ieee80211_channel *channel,
1437 const u8 *bssid,
79420f09
JB
1438 const u8 *ssid, size_t ssid_len,
1439 u16 capa_mask, u16 capa_val);
1440static inline struct cfg80211_bss *
1441cfg80211_get_ibss(struct wiphy *wiphy,
1442 struct ieee80211_channel *channel,
1443 const u8 *ssid, size_t ssid_len)
1444{
1445 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
1446 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
1447}
1448
2a519311
JB
1449struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
1450 struct ieee80211_channel *channel,
1451 const u8 *meshid, size_t meshidlen,
1452 const u8 *meshcfg);
1453void cfg80211_put_bss(struct cfg80211_bss *bss);
d3236553 1454
d491af19
JB
1455/**
1456 * cfg80211_unlink_bss - unlink BSS from internal data structures
1457 * @wiphy: the wiphy
1458 * @bss: the bss to remove
1459 *
1460 * This function removes the given BSS from the internal data structures
1461 * thereby making it no longer show up in scan results etc. Use this
1462 * function when you detect a BSS is gone. Normally BSSes will also time
1463 * out, so it is not necessary to use this function at all.
1464 */
1465void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
fee52678 1466
6039f6d2
JM
1467/**
1468 * cfg80211_send_rx_auth - notification of processed authentication
1469 * @dev: network device
1470 * @buf: authentication frame (header + body)
1471 * @len: length of the frame data
1472 *
1473 * This function is called whenever an authentication has been processed in
1965c853
JM
1474 * station mode. The driver is required to call either this function or
1475 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
1476 * call.
6039f6d2
JM
1477 */
1478void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
1479
1965c853
JM
1480/**
1481 * cfg80211_send_auth_timeout - notification of timed out authentication
1482 * @dev: network device
1483 * @addr: The MAC address of the device with which the authentication timed out
1484 */
1485void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
1486
6039f6d2
JM
1487/**
1488 * cfg80211_send_rx_assoc - notification of processed association
1489 * @dev: network device
1490 * @buf: (re)association response frame (header + body)
1491 * @len: length of the frame data
1492 *
1493 * This function is called whenever a (re)association response has been
1965c853
JM
1494 * processed in station mode. The driver is required to call either this
1495 * function or cfg80211_send_assoc_timeout() to indicate the result of
1496 * cfg80211_ops::assoc() call.
6039f6d2
JM
1497 */
1498void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
1499
1965c853
JM
1500/**
1501 * cfg80211_send_assoc_timeout - notification of timed out association
1502 * @dev: network device
1503 * @addr: The MAC address of the device with which the association timed out
1504 */
1505void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
1506
6039f6d2 1507/**
53b46b84 1508 * cfg80211_send_deauth - notification of processed deauthentication
6039f6d2
JM
1509 * @dev: network device
1510 * @buf: deauthentication frame (header + body)
1511 * @len: length of the frame data
1512 *
1513 * This function is called whenever deauthentication has been processed in
53b46b84
JM
1514 * station mode. This includes both received deauthentication frames and
1515 * locally generated ones.
6039f6d2 1516 */
53b46b84 1517void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
6039f6d2
JM
1518
1519/**
53b46b84 1520 * cfg80211_send_disassoc - notification of processed disassociation
6039f6d2
JM
1521 * @dev: network device
1522 * @buf: disassociation response frame (header + body)
1523 * @len: length of the frame data
1524 *
1525 * This function is called whenever disassociation has been processed in
53b46b84
JM
1526 * station mode. This includes both received disassociation frames and locally
1527 * generated ones.
6039f6d2 1528 */
53b46b84 1529void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
6039f6d2 1530
a08c1c1a
KV
1531/**
1532 * cfg80211_hold_bss - exclude bss from expiration
1533 * @bss: bss which should not expire
1534 *
1535 * In a case when the BSS is not updated but it shouldn't expire this
1536 * function can be used to mark the BSS to be excluded from expiration.
1537 */
1538void cfg80211_hold_bss(struct cfg80211_bss *bss);
1539
1540/**
1541 * cfg80211_unhold_bss - remove expiration exception from the BSS
1542 * @bss: bss which can expire again
1543 *
1544 * This function marks the BSS to be expirable again.
1545 */
1546void cfg80211_unhold_bss(struct cfg80211_bss *bss);
1547
a3b8b056
JM
1548/**
1549 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
1550 * @dev: network device
1551 * @addr: The source MAC address of the frame
1552 * @key_type: The key type that the received frame used
1553 * @key_id: Key identifier (0..3)
1554 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
1555 *
1556 * This function is called whenever the local MAC detects a MIC failure in a
1557 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
1558 * primitive.
1559 */
1560void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
1561 enum nl80211_key_type key_type, int key_id,
1562 const u8 *tsc);
1563
04a773ad
JB
1564/**
1565 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
1566 *
1567 * @dev: network device
1568 * @bssid: the BSSID of the IBSS joined
1569 * @gfp: allocation flags
1570 *
1571 * This function notifies cfg80211 that the device joined an IBSS or
1572 * switched to a different BSSID. Before this function can be called,
1573 * either a beacon has to have been received from the IBSS, or one of
1574 * the cfg80211_inform_bss{,_frame} functions must have been called
1575 * with the locally generated beacon -- this guarantees that there is
1576 * always a scan result for this IBSS. cfg80211 will handle the rest.
1577 */
1578void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
1579
704232c2 1580#endif /* __NET_CFG80211_H */