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