cfg80211.h 133.7 KB
Newer Older
1 2
#ifndef __NET_CFG80211_H
#define __NET_CFG80211_H
J
Johannes Berg 已提交
3 4 5
/*
 * 802.11 device and configuration interface
 *
6
 * Copyright 2006-2010	Johannes Berg <johannes@sipsolutions.net>
J
Johannes Berg 已提交
7 8 9 10 11
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
12

J
Johannes Berg 已提交
13 14 15
#include <linux/netdevice.h>
#include <linux/debugfs.h>
#include <linux/list.h>
16
#include <linux/bug.h>
17 18
#include <linux/netlink.h>
#include <linux/skbuff.h>
19
#include <linux/nl80211.h>
20 21
#include <linux/if_ether.h>
#include <linux/ieee80211.h>
J
Johannes Berg 已提交
22 23
#include <net/regulatory.h>

J
Johannes Berg 已提交
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
/**
 * DOC: Introduction
 *
 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
 * userspace and drivers, and offers some utility functionality associated
 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
 * by all modern wireless drivers in Linux, so that they offer a consistent
 * API through nl80211. For backward compatibility, cfg80211 also offers
 * wireless extensions to userspace, but hides them from drivers completely.
 *
 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
 * use restrictions.
 */


/**
 * DOC: Device registration
 *
 * In order for a driver to use cfg80211, it must register the hardware device
 * with cfg80211. This happens through a number of hardware capability structs
 * described below.
 *
 * The fundamental structure for each device is the 'wiphy', of which each
 * instance describes a physical wireless device connected to the system. Each
 * such wiphy can have zero, one, or many virtual interfaces associated with
 * it, which need to be identified as such by pointing the network interface's
 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
 * the wireless part of the interface, normally this struct is embedded in the
 * network interface's private data area. Drivers can optionally allow creating
 * or destroying virtual interfaces on the fly, but without at least one or the
 * ability to create some the wireless device isn't useful.
 *
 * Each wiphy structure contains device capability information, and also has
 * a pointer to the various operations the driver offers. The definitions and
 * structures here describe these capabilities in detail.
 */

61 62
struct wiphy;

63
/*
J
Johannes Berg 已提交
64 65 66 67 68 69 70 71
 * wireless hardware capability structures
 */

/**
 * enum ieee80211_band - supported frequency bands
 *
 * The bands are assigned this way because the supported
 * bitrates differ in these bands.
72
 *
J
Johannes Berg 已提交
73 74
 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
75
 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
J
Johannes Berg 已提交
76
 * @IEEE80211_NUM_BANDS: number of defined bands
77
 */
J
Johannes Berg 已提交
78
enum ieee80211_band {
79 80
	IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
	IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
81
	IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
J
Johannes Berg 已提交
82 83 84 85

	/* keep last */
	IEEE80211_NUM_BANDS
};
86

87
/**
J
Johannes Berg 已提交
88 89 90 91 92 93 94 95 96
 * enum ieee80211_channel_flags - channel flags
 *
 * Channel flags set by the regulatory control code.
 *
 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
 *	on this channel.
 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
97
 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
J
Johannes Berg 已提交
98
 * 	is not permitted.
99
 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
J
Johannes Berg 已提交
100
 * 	is not permitted.
101
 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
102
 */
J
Johannes Berg 已提交
103 104 105 106 107
enum ieee80211_channel_flags {
	IEEE80211_CHAN_DISABLED		= 1<<0,
	IEEE80211_CHAN_PASSIVE_SCAN	= 1<<1,
	IEEE80211_CHAN_NO_IBSS		= 1<<2,
	IEEE80211_CHAN_RADAR		= 1<<3,
108 109
	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
110
	IEEE80211_CHAN_NO_OFDM		= 1<<6,
111 112
};

113
#define IEEE80211_CHAN_NO_HT40 \
114
	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
115

J
Johannes Berg 已提交
116 117 118 119 120 121 122 123 124 125 126 127 128 129
/**
 * struct ieee80211_channel - channel definition
 *
 * This structure describes a single channel for use
 * with cfg80211.
 *
 * @center_freq: center frequency in MHz
 * @hw_value: hardware-specific value for the channel
 * @flags: channel flags from &enum ieee80211_channel_flags.
 * @orig_flags: channel flags at registration time, used by regulatory
 *	code to support devices with additional restrictions
 * @band: band this channel belongs to.
 * @max_antenna_gain: maximum antenna gain in dBi
 * @max_power: maximum transmission power (in dBm)
130
 * @max_reg_power: maximum regulatory transmission power (in dBm)
J
Johannes Berg 已提交
131 132
 * @beacon_found: helper to regulatory code to indicate when a beacon
 *	has been found on this channel. Use regulatory_hint_found_beacon()
133
 *	to enable this, this is useful only on 5 GHz band.
J
Johannes Berg 已提交
134 135
 * @orig_mag: internal use
 * @orig_mpwr: internal use
A
Andy Green 已提交
136
 */
J
Johannes Berg 已提交
137 138 139 140 141 142 143
struct ieee80211_channel {
	enum ieee80211_band band;
	u16 center_freq;
	u16 hw_value;
	u32 flags;
	int max_antenna_gain;
	int max_power;
144
	int max_reg_power;
J
Johannes Berg 已提交
145 146 147 148 149
	bool beacon_found;
	u32 orig_flags;
	int orig_mag, orig_mpwr;
};

A
Andy Green 已提交
150
/**
J
Johannes Berg 已提交
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
 * enum ieee80211_rate_flags - rate flags
 *
 * Hardware/specification flags for rates. These are structured
 * in a way that allows using the same bitrate structure for
 * different bands/PHY modes.
 *
 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
 *	preamble on this bitrate; only relevant in 2.4GHz band and
 *	with CCK rates.
 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
 *	when used with 802.11a (on the 5 GHz band); filled by the
 *	core code when registering the wiphy.
 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
 *	when used with 802.11b (on the 2.4 GHz band); filled by the
 *	core code when registering the wiphy.
 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
 *	when used with 802.11g (on the 2.4 GHz band); filled by the
 *	core code when registering the wiphy.
 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
A
Andy Green 已提交
170
 */
J
Johannes Berg 已提交
171 172 173 174 175 176 177
enum ieee80211_rate_flags {
	IEEE80211_RATE_SHORT_PREAMBLE	= 1<<0,
	IEEE80211_RATE_MANDATORY_A	= 1<<1,
	IEEE80211_RATE_MANDATORY_B	= 1<<2,
	IEEE80211_RATE_MANDATORY_G	= 1<<3,
	IEEE80211_RATE_ERP_G		= 1<<4,
};
A
Andy Green 已提交
178

J
Johannes Berg 已提交
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
/**
 * struct ieee80211_rate - bitrate definition
 *
 * This structure describes a bitrate that an 802.11 PHY can
 * operate with. The two values @hw_value and @hw_value_short
 * are only for driver use when pointers to this structure are
 * passed around.
 *
 * @flags: rate-specific flags
 * @bitrate: bitrate in units of 100 Kbps
 * @hw_value: driver/hardware value for this rate
 * @hw_value_short: driver/hardware value for this rate when
 *	short preamble is used
 */
struct ieee80211_rate {
	u32 flags;
	u16 bitrate;
	u16 hw_value, hw_value_short;
};
A
Andy Green 已提交
198

J
Johannes Berg 已提交
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
/**
 * struct ieee80211_sta_ht_cap - STA's HT capabilities
 *
 * This structure describes most essential parameters needed
 * to describe 802.11n HT capabilities for an STA.
 *
 * @ht_supported: is HT supported by the STA
 * @cap: HT capabilities map as described in 802.11n spec
 * @ampdu_factor: Maximum A-MPDU length factor
 * @ampdu_density: Minimum A-MPDU spacing
 * @mcs: Supported MCS rates
 */
struct ieee80211_sta_ht_cap {
	u16 cap; /* use IEEE80211_HT_CAP_ */
	bool ht_supported;
	u8 ampdu_factor;
	u8 ampdu_density;
	struct ieee80211_mcs_info mcs;
A
Andy Green 已提交
217 218
};

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
/**
 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
 *
 * This structure describes most essential parameters needed
 * to describe 802.11ac VHT capabilities for an STA.
 *
 * @vht_supported: is VHT supported by the STA
 * @cap: VHT capabilities map as described in 802.11ac spec
 * @vht_mcs: Supported VHT MCS rates
 */
struct ieee80211_sta_vht_cap {
	bool vht_supported;
	u32 cap; /* use IEEE80211_VHT_CAP_ */
	struct ieee80211_vht_mcs_info vht_mcs;
};

J
Johannes Berg 已提交
235 236 237 238 239 240 241 242 243 244 245 246 247 248
/**
 * struct ieee80211_supported_band - frequency band definition
 *
 * This structure describes a frequency band a wiphy
 * is able to operate in.
 *
 * @channels: Array of channels the hardware can operate in
 *	in this band.
 * @band: the band this structure represents
 * @n_channels: Number of channels in @channels
 * @bitrates: Array of bitrates the hardware can operate with
 *	in this band. Must be sorted to give a valid "supported
 *	rates" IE, i.e. CCK rates first, then OFDM.
 * @n_bitrates: Number of bitrates in @bitrates
J
Johannes Berg 已提交
249
 * @ht_cap: HT capabilities in this band
250
 * @vht_cap: VHT capabilities in this band
J
Johannes Berg 已提交
251 252 253 254 255 256 257 258
 */
struct ieee80211_supported_band {
	struct ieee80211_channel *channels;
	struct ieee80211_rate *bitrates;
	enum ieee80211_band band;
	int n_channels;
	int n_bitrates;
	struct ieee80211_sta_ht_cap ht_cap;
259
	struct ieee80211_sta_vht_cap vht_cap;
J
Johannes Berg 已提交
260
};
A
Andy Green 已提交
261

J
Johannes Berg 已提交
262 263 264
/*
 * Wireless hardware/device configuration structures and methods
 */
A
Andy Green 已提交
265

J
Johannes Berg 已提交
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
/**
 * DOC: Actions and configuration
 *
 * Each wireless device and each virtual interface offer a set of configuration
 * operations and other actions that are invoked by userspace. Each of these
 * actions is described in the operations structure, and the parameters these
 * operations use are described separately.
 *
 * Additionally, some operations are asynchronous and expect to get status
 * information via some functions that drivers need to call.
 *
 * Scanning and BSS list handling with its associated functionality is described
 * in a separate chapter.
 */

J
Johannes Berg 已提交
281 282
/**
 * struct vif_params - describes virtual interface parameters
283
 * @use_4addr: use 4-address frames
J
Johannes Berg 已提交
284 285
 */
struct vif_params {
286
       int use_4addr;
J
Johannes Berg 已提交
287
};
A
Andy Green 已提交
288

J
Johannes Berg 已提交
289
/**
290 291 292 293 294 295 296 297 298 299
 * struct key_params - key information
 *
 * Information about a key
 *
 * @key: key material
 * @key_len: length of key material
 * @cipher: cipher suite selector
 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
 *	with the get_key() callback, must be in little endian,
 *	length given by @seq_len.
J
Johannes Berg 已提交
300
 * @seq_len: length of @seq.
301 302 303 304 305 306 307 308 309
 */
struct key_params {
	u8 *key;
	u8 *seq;
	int key_len;
	int seq_len;
	u32 cipher;
};

310 311 312
/**
 * struct cfg80211_chan_def - channel definition
 * @chan: the (control) channel
313 314 315 316
 * @width: channel width
 * @center_freq1: center frequency of first segment
 * @center_freq2: center frequency of second segment
 *	(only with 80+80 MHz)
317 318 319
 */
struct cfg80211_chan_def {
	struct ieee80211_channel *chan;
320 321 322
	enum nl80211_chan_width width;
	u32 center_freq1;
	u32 center_freq2;
323 324
};

325 326 327 328
/**
 * cfg80211_get_chandef_type - return old channel type from chandef
 * @chandef: the channel definition
 *
329
 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
330 331
 * chandef, which must have a bandwidth allowing this conversion.
 */
332 333 334
static inline enum nl80211_channel_type
cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
{
335 336 337 338 339 340 341 342 343 344 345 346 347
	switch (chandef->width) {
	case NL80211_CHAN_WIDTH_20_NOHT:
		return NL80211_CHAN_NO_HT;
	case NL80211_CHAN_WIDTH_20:
		return NL80211_CHAN_HT20;
	case NL80211_CHAN_WIDTH_40:
		if (chandef->center_freq1 > chandef->chan->center_freq)
			return NL80211_CHAN_HT40PLUS;
		return NL80211_CHAN_HT40MINUS;
	default:
		WARN_ON(1);
		return NL80211_CHAN_NO_HT;
	}
348 349
}

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
/**
 * cfg80211_chandef_create - create channel definition using channel type
 * @chandef: the channel definition struct to fill
 * @channel: the control channel
 * @chantype: the channel type
 *
 * Given a channel type, create a channel definition.
 */
void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
			     struct ieee80211_channel *channel,
			     enum nl80211_channel_type chantype);

/**
 * cfg80211_chandef_identical - check if two channel definitions are identical
 * @chandef1: first channel definition
 * @chandef2: second channel definition
 *
367
 * Return: %true if the channels defined by the channel definitions are
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
 * identical, %false otherwise.
 */
static inline bool
cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
			   const struct cfg80211_chan_def *chandef2)
{
	return (chandef1->chan == chandef2->chan &&
		chandef1->width == chandef2->width &&
		chandef1->center_freq1 == chandef2->center_freq1 &&
		chandef1->center_freq2 == chandef2->center_freq2);
}

/**
 * cfg80211_chandef_compatible - check if two channel definitions are compatible
 * @chandef1: first channel definition
 * @chandef2: second channel definition
 *
385
 * Return: %NULL if the given channel definitions are incompatible,
386 387 388 389 390 391
 * chandef1 or chandef2 otherwise.
 */
const struct cfg80211_chan_def *
cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
			    const struct cfg80211_chan_def *chandef2);

392 393 394
/**
 * cfg80211_chandef_valid - check if a channel definition is valid
 * @chandef: the channel definition to check
395
 * Return: %true if the channel definition is valid. %false otherwise.
396 397 398 399 400 401 402
 */
bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);

/**
 * cfg80211_chandef_usable - check if secondary channels can be used
 * @wiphy: the wiphy to validate against
 * @chandef: the channel definition to check
403 404
 * @prohibited_flags: the regulatory channel flags that must not be set
 * Return: %true if secondary channels are usable. %false otherwise.
405 406 407 408 409
 */
bool cfg80211_chandef_usable(struct wiphy *wiphy,
			     const struct cfg80211_chan_def *chandef,
			     u32 prohibited_flags);

410 411 412
/**
 * enum survey_info_flags - survey information flags
 *
J
Johannes Berg 已提交
413
 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
414
 * @SURVEY_INFO_IN_USE: channel is currently being used
415 416 417 418 419
 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
J
Johannes Berg 已提交
420
 *
421 422 423 424 425
 * Used by the driver to indicate which info in &struct survey_info
 * it has filled in during the get_survey().
 */
enum survey_info_flags {
	SURVEY_INFO_NOISE_DBM = 1<<0,
426
	SURVEY_INFO_IN_USE = 1<<1,
427 428 429 430 431
	SURVEY_INFO_CHANNEL_TIME = 1<<2,
	SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
	SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
	SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
	SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
432 433 434 435 436 437 438 439 440
};

/**
 * struct survey_info - channel survey response
 *
 * @channel: the channel this survey record reports, mandatory
 * @filled: bitflag of flags from &enum survey_info_flags
 * @noise: channel noise in dBm. This and all following fields are
 *     optional
441 442 443 444 445
 * @channel_time: amount of time in ms the radio spent on the channel
 * @channel_time_busy: amount of time the primary channel was sensed busy
 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
 * @channel_time_rx: amount of time the radio spent receiving data
 * @channel_time_tx: amount of time the radio spent transmitting data
446
 *
J
Johannes Berg 已提交
447 448
 * Used by dump_survey() to report back per-channel survey information.
 *
449 450 451 452 453
 * This structure can later be expanded with things like
 * channel duty cycle etc.
 */
struct survey_info {
	struct ieee80211_channel *channel;
454 455 456 457 458
	u64 channel_time;
	u64 channel_time_busy;
	u64 channel_time_ext_busy;
	u64 channel_time_rx;
	u64 channel_time_tx;
459 460 461 462
	u32 filled;
	s8 noise;
};

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
/**
 * struct cfg80211_crypto_settings - Crypto settings
 * @wpa_versions: indicates which, if any, WPA versions are enabled
 *	(from enum nl80211_wpa_versions)
 * @cipher_group: group key cipher suite (or 0 if unset)
 * @n_ciphers_pairwise: number of AP supported unicast ciphers
 * @ciphers_pairwise: unicast key cipher suites
 * @n_akm_suites: number of AKM suites
 * @akm_suites: AKM suites
 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
 *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 *	required to assume that the port is unauthorized until authorized by
 *	user space. Otherwise, port is marked authorized by default.
 * @control_port_ethertype: the control port protocol that should be
 *	allowed through even on unauthorized ports
 * @control_port_no_encrypt: TRUE to prevent encryption of control port
 *	protocol frames.
 */
struct cfg80211_crypto_settings {
	u32 wpa_versions;
	u32 cipher_group;
	int n_ciphers_pairwise;
	u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
	int n_akm_suites;
	u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
	bool control_port;
	__be16 control_port_ethertype;
	bool control_port_no_encrypt;
};

493
/**
494
 * struct cfg80211_beacon_data - beacon data
495 496 497 498 499 500
 * @head: head portion of beacon (before TIM IE)
 *     or %NULL if not changed
 * @tail: tail portion of beacon (after TIM IE)
 *     or %NULL if not changed
 * @head_len: length of @head
 * @tail_len: length of @tail
501 502 503 504 505 506 507 508
 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
 * @beacon_ies_len: length of beacon_ies in octets
 * @proberesp_ies: extra information element(s) to add into Probe Response
 *	frames or %NULL
 * @proberesp_ies_len: length of proberesp_ies in octets
 * @assocresp_ies: extra information element(s) to add into (Re)Association
 *	Response frames or %NULL
 * @assocresp_ies_len: length of assocresp_ies in octets
509 510
 * @probe_resp_len: length of probe response template (@probe_resp)
 * @probe_resp: probe response template (AP mode only)
511
 */
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
struct cfg80211_beacon_data {
	const u8 *head, *tail;
	const u8 *beacon_ies;
	const u8 *proberesp_ies;
	const u8 *assocresp_ies;
	const u8 *probe_resp;

	size_t head_len, tail_len;
	size_t beacon_ies_len;
	size_t proberesp_ies_len;
	size_t assocresp_ies_len;
	size_t probe_resp_len;
};

/**
 * struct cfg80211_ap_settings - AP configuration
 *
 * Used to configure an AP interface.
 *
531
 * @chandef: defines the channel to use
532 533 534 535 536 537 538 539 540 541
 * @beacon: beacon data
 * @beacon_interval: beacon interval
 * @dtim_period: DTIM period
 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
 *	user space)
 * @ssid_len: length of @ssid
 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
 * @crypto: crypto settings
 * @privacy: the BSS uses privacy
 * @auth_type: Authentication type (algorithm)
542
 * @inactivity_timeout: time in seconds to determine station's inactivity.
543 544
 * @p2p_ctwindow: P2P CT Window
 * @p2p_opp_ps: P2P opportunistic PS
545 546
 */
struct cfg80211_ap_settings {
547
	struct cfg80211_chan_def chandef;
548

549 550 551
	struct cfg80211_beacon_data beacon;

	int beacon_interval, dtim_period;
552 553 554
	const u8 *ssid;
	size_t ssid_len;
	enum nl80211_hidden_ssid hidden_ssid;
555 556 557
	struct cfg80211_crypto_settings crypto;
	bool privacy;
	enum nl80211_auth_type auth_type;
558
	int inactivity_timeout;
559 560
	u8 p2p_ctwindow;
	bool p2p_opp_ps;
561 562
};

563 564 565 566 567
/**
 * enum plink_action - actions to perform in mesh peers
 *
 * @PLINK_ACTION_INVALID: action 0 is reserved
 * @PLINK_ACTION_OPEN: start mesh peer link establishment
J
Johannes Berg 已提交
568
 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
569 570 571 572 573 574 575
 */
enum plink_actions {
	PLINK_ACTION_INVALID,
	PLINK_ACTION_OPEN,
	PLINK_ACTION_BLOCK,
};

576 577 578 579 580 581 582 583 584 585 586
/**
 * enum station_parameters_apply_mask - station parameter values to apply
 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
 *
 * Not all station parameters have in-band "no change" signalling,
 * for those that don't these flags will are used.
 */
enum station_parameters_apply_mask {
	STATION_PARAM_APPLY_UAPSD = BIT(0),
};

587 588 589 590 591 592 593 594 595
/**
 * struct station_parameters - station parameters
 *
 * Used to change and create a new station.
 *
 * @vlan: vlan interface station should belong to
 * @supported_rates: supported rates in IEEE 802.11 format
 *	(or NULL for no change)
 * @supported_rates_len: number of supported rates
596 597 598 599
 * @sta_flags_mask: station flags that changed
 *	(bitmask of BIT(NL80211_STA_FLAG_...))
 * @sta_flags_set: station flags values
 *	(bitmask of BIT(NL80211_STA_FLAG_...))
600 601
 * @listen_interval: listen interval or -1 for no change
 * @aid: AID or zero for no change
J
Johannes Berg 已提交
602
 * @plink_action: plink action to take
603
 * @plink_state: set the peer link state for a station
J
Johannes Berg 已提交
604
 * @ht_capa: HT capabilities of station
M
Mahesh Palivela 已提交
605
 * @vht_capa: VHT capabilities of station
606 607 608 609
 * @uapsd_queues: bitmap of queues configured for uapsd. same format
 *	as the AC bitmap in the QoS info field
 * @max_sp: max Service Period. same format as the MAX_SP in the
 *	QoS info field (but already shifted down)
J
Johannes Berg 已提交
610 611 612
 * @sta_modify_mask: bitmap indicating which parameters changed
 *	(for those that don't have a natural "no change" value),
 *	see &enum station_parameters_apply_mask
613 614
 * @local_pm: local link-specific mesh power save mode (no change when set
 *	to unknown)
615 616 617 618
 */
struct station_parameters {
	u8 *supported_rates;
	struct net_device *vlan;
619
	u32 sta_flags_mask, sta_flags_set;
620
	u32 sta_modify_mask;
621 622 623
	int listen_interval;
	u16 aid;
	u8 supported_rates_len;
624
	u8 plink_action;
625
	u8 plink_state;
626
	struct ieee80211_ht_cap *ht_capa;
M
Mahesh Palivela 已提交
627
	struct ieee80211_vht_cap *vht_capa;
628 629
	u8 uapsd_queues;
	u8 max_sp;
630
	enum nl80211_mesh_power_mode local_pm;
631 632
};

633
/**
634
 * enum station_info_flags - station information flags
635
 *
636 637
 * Used by the driver to indicate which info in &struct station_info
 * it has filled in during get_station() or dump_station().
638
 *
639 640 641 642 643 644
 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
 * @STATION_INFO_RX_BYTES: @rx_bytes filled
 * @STATION_INFO_TX_BYTES: @tx_bytes filled
 * @STATION_INFO_LLID: @llid filled
 * @STATION_INFO_PLID: @plid filled
 * @STATION_INFO_PLINK_STATE: @plink_state filled
645
 * @STATION_INFO_SIGNAL: @signal filled
646
 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
647
 *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
648 649
 * @STATION_INFO_RX_PACKETS: @rx_packets filled
 * @STATION_INFO_TX_PACKETS: @tx_packets filled
650 651
 * @STATION_INFO_TX_RETRIES: @tx_retries filled
 * @STATION_INFO_TX_FAILED: @tx_failed filled
652
 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
653
 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
654
 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
655
 * @STATION_INFO_BSS_PARAM: @bss_param filled
656
 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
657
 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
658
 * @STATION_INFO_STA_FLAGS: @sta_flags filled
659
 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
660
 * @STATION_INFO_T_OFFSET: @t_offset filled
661 662 663
 * @STATION_INFO_LOCAL_PM: @local_pm filled
 * @STATION_INFO_PEER_PM: @peer_pm filled
 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
664
 */
665 666 667 668 669 670 671
enum station_info_flags {
	STATION_INFO_INACTIVE_TIME	= 1<<0,
	STATION_INFO_RX_BYTES		= 1<<1,
	STATION_INFO_TX_BYTES		= 1<<2,
	STATION_INFO_LLID		= 1<<3,
	STATION_INFO_PLID		= 1<<4,
	STATION_INFO_PLINK_STATE	= 1<<5,
672 673
	STATION_INFO_SIGNAL		= 1<<6,
	STATION_INFO_TX_BITRATE		= 1<<7,
674 675
	STATION_INFO_RX_PACKETS		= 1<<8,
	STATION_INFO_TX_PACKETS		= 1<<9,
676 677
	STATION_INFO_TX_RETRIES		= 1<<10,
	STATION_INFO_TX_FAILED		= 1<<11,
678
	STATION_INFO_RX_DROP_MISC	= 1<<12,
679
	STATION_INFO_SIGNAL_AVG		= 1<<13,
680
	STATION_INFO_RX_BITRATE		= 1<<14,
681
	STATION_INFO_BSS_PARAM          = 1<<15,
682
	STATION_INFO_CONNECTED_TIME	= 1<<16,
683
	STATION_INFO_ASSOC_REQ_IES	= 1<<17,
684
	STATION_INFO_STA_FLAGS		= 1<<18,
685 686
	STATION_INFO_BEACON_LOSS_COUNT	= 1<<19,
	STATION_INFO_T_OFFSET		= 1<<20,
687 688 689
	STATION_INFO_LOCAL_PM		= 1<<21,
	STATION_INFO_PEER_PM		= 1<<22,
	STATION_INFO_NONPEER_PM		= 1<<23,
690 691 692 693 694 695 696 697
};

/**
 * enum station_info_rate_flags - bitrate info flags
 *
 * Used by the driver to indicate the specific rate transmission
 * type for 802.11n transmissions.
 *
698 699 700 701 702 703
 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
704
 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
705
 * @RATE_INFO_FLAGS_60G: 60GHz MCS
706 707
 */
enum rate_info_flags {
708 709 710 711 712 713 714 715
	RATE_INFO_FLAGS_MCS			= BIT(0),
	RATE_INFO_FLAGS_VHT_MCS			= BIT(1),
	RATE_INFO_FLAGS_40_MHZ_WIDTH		= BIT(2),
	RATE_INFO_FLAGS_80_MHZ_WIDTH		= BIT(3),
	RATE_INFO_FLAGS_80P80_MHZ_WIDTH		= BIT(4),
	RATE_INFO_FLAGS_160_MHZ_WIDTH		= BIT(5),
	RATE_INFO_FLAGS_SHORT_GI		= BIT(6),
	RATE_INFO_FLAGS_60G			= BIT(7),
716 717 718 719 720 721 722 723 724 725
};

/**
 * struct rate_info - bitrate information
 *
 * Information about a receiving or transmitting bitrate
 *
 * @flags: bitflag of flags from &enum rate_info_flags
 * @mcs: mcs index if struct describes a 802.11n bitrate
 * @legacy: bitrate in 100kbit/s for 802.11abg
726
 * @nss: number of streams (VHT only)
727 728 729 730 731
 */
struct rate_info {
	u8 flags;
	u8 mcs;
	u16 legacy;
732
	u8 nss;
733 734
};

735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
/**
 * enum station_info_rate_flags - bitrate info flags
 *
 * Used by the driver to indicate the specific rate transmission
 * type for 802.11n transmissions.
 *
 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
 */
enum bss_param_flags {
	BSS_PARAM_FLAGS_CTS_PROT	= 1<<0,
	BSS_PARAM_FLAGS_SHORT_PREAMBLE	= 1<<1,
	BSS_PARAM_FLAGS_SHORT_SLOT_TIME	= 1<<2,
};

/**
 * struct sta_bss_parameters - BSS parameters for the attached station
 *
 * Information about the currently associated BSS
 *
 * @flags: bitflag of flags from &enum bss_param_flags
 * @dtim_period: DTIM period for the BSS
 * @beacon_interval: beacon interval
 */
struct sta_bss_parameters {
	u8 flags;
	u8 dtim_period;
	u16 beacon_interval;
};

766
/**
767
 * struct station_info - station information
768
 *
769
 * Station information filled by driver for get_station() and dump_station.
770
 *
771
 * @filled: bitflag of flags from &enum station_info_flags
772
 * @connected_time: time(in secs) since a station is last connected
773 774 775
 * @inactive_time: time since last station activity (tx/rx) in milliseconds
 * @rx_bytes: bytes received from this station
 * @tx_bytes: bytes transmitted to this station
776 777 778
 * @llid: mesh local link id
 * @plid: mesh peer link id
 * @plink_state: mesh peer link state
J
Johannes Berg 已提交
779 780 781 782
 * @signal: The signal strength, type depends on the wiphy's signal_type.
 *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
 *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
783 784
 * @txrate: current unicast bitrate from this station
 * @rxrate: current unicast bitrate to this station
785 786
 * @rx_packets: packets received from this station
 * @tx_packets: packets transmitted to this station
787 788
 * @tx_retries: cumulative retry counts
 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
789
 * @rx_dropped_misc:  Dropped for un-specified reason.
790
 * @bss_param: current BSS parameters
791 792 793 794
 * @generation: generation number for nl80211 dumps.
 *	This number should increase every time the list of stations
 *	changes, i.e. when a station is added or removed, so that
 *	userspace can tell whether it got a consistent snapshot.
795 796 797 798 799
 * @assoc_req_ies: IEs from (Re)Association Request.
 *	This is used only when in AP mode with drivers that do not use
 *	user space MLME/SME implementation. The information is provided for
 *	the cfg80211_new_sta() calls to notify user space of the IEs.
 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
J
Johannes Berg 已提交
800
 * @sta_flags: station flags mask & values
801
 * @beacon_loss_count: Number of times beacon loss event has triggered.
802
 * @t_offset: Time offset of the station relative to this host.
803 804 805
 * @local_pm: local mesh STA power save mode
 * @peer_pm: peer mesh STA power save mode
 * @nonpeer_pm: non-peer mesh STA power save mode
806
 */
807
struct station_info {
808
	u32 filled;
809
	u32 connected_time;
810 811 812
	u32 inactive_time;
	u32 rx_bytes;
	u32 tx_bytes;
813 814 815
	u16 llid;
	u16 plid;
	u8 plink_state;
816
	s8 signal;
817
	s8 signal_avg;
818
	struct rate_info txrate;
819
	struct rate_info rxrate;
820 821
	u32 rx_packets;
	u32 tx_packets;
822 823
	u32 tx_retries;
	u32 tx_failed;
824
	u32 rx_dropped_misc;
825
	struct sta_bss_parameters bss_param;
826
	struct nl80211_sta_flag_update sta_flags;
827 828

	int generation;
829 830 831

	const u8 *assoc_req_ies;
	size_t assoc_req_ies_len;
832

833
	u32 beacon_loss_count;
834
	s64 t_offset;
835 836 837
	enum nl80211_mesh_power_mode local_pm;
	enum nl80211_mesh_power_mode peer_pm;
	enum nl80211_mesh_power_mode nonpeer_pm;
838

839 840 841 842
	/*
	 * Note: Add a new enum station_info_flags value for each new field and
	 * use it to check which fields are initialized.
	 */
843 844
};

845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
/**
 * enum monitor_flags - monitor flags
 *
 * Monitor interface configuration flags. Note that these must be the bits
 * according to the nl80211 flags.
 *
 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
 * @MONITOR_FLAG_CONTROL: pass control frames
 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
 */
enum monitor_flags {
	MONITOR_FLAG_FCSFAIL		= 1<<NL80211_MNTR_FLAG_FCSFAIL,
	MONITOR_FLAG_PLCPFAIL		= 1<<NL80211_MNTR_FLAG_PLCPFAIL,
	MONITOR_FLAG_CONTROL		= 1<<NL80211_MNTR_FLAG_CONTROL,
	MONITOR_FLAG_OTHER_BSS		= 1<<NL80211_MNTR_FLAG_OTHER_BSS,
	MONITOR_FLAG_COOK_FRAMES	= 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
};

865 866 867 868 869 870
/**
 * enum mpath_info_flags -  mesh path information flags
 *
 * Used by the driver to indicate which info in &struct mpath_info it has filled
 * in during get_station() or dump_station().
 *
J
Johannes Berg 已提交
871 872 873 874 875 876 877
 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
 * @MPATH_INFO_SN: @sn filled
 * @MPATH_INFO_METRIC: @metric filled
 * @MPATH_INFO_EXPTIME: @exptime filled
 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
 * @MPATH_INFO_FLAGS: @flags filled
878 879 880
 */
enum mpath_info_flags {
	MPATH_INFO_FRAME_QLEN		= BIT(0),
881
	MPATH_INFO_SN			= BIT(1),
882 883 884 885 886 887 888 889 890 891 892 893 894 895
	MPATH_INFO_METRIC		= BIT(2),
	MPATH_INFO_EXPTIME		= BIT(3),
	MPATH_INFO_DISCOVERY_TIMEOUT	= BIT(4),
	MPATH_INFO_DISCOVERY_RETRIES	= BIT(5),
	MPATH_INFO_FLAGS		= BIT(6),
};

/**
 * struct mpath_info - mesh path information
 *
 * Mesh path information filled by driver for get_mpath() and dump_mpath().
 *
 * @filled: bitfield of flags from &enum mpath_info_flags
 * @frame_qlen: number of queued frames for this destination
896
 * @sn: target sequence number
897 898 899 900 901
 * @metric: metric (cost) of this mesh path
 * @exptime: expiration time for the mesh path from now, in msecs
 * @flags: mesh path flags
 * @discovery_timeout: total mesh path discovery timeout, in msecs
 * @discovery_retries: mesh path discovery retries
902 903 904 905
 * @generation: generation number for nl80211 dumps.
 *	This number should increase every time the list of mesh paths
 *	changes, i.e. when a station is added or removed, so that
 *	userspace can tell whether it got a consistent snapshot.
906 907 908 909
 */
struct mpath_info {
	u32 filled;
	u32 frame_qlen;
910
	u32 sn;
911 912 913 914 915
	u32 metric;
	u32 exptime;
	u32 discovery_timeout;
	u8 discovery_retries;
	u8 flags;
916 917

	int generation;
918 919
};

920 921 922 923 924 925 926 927 928 929 930
/**
 * struct bss_parameters - BSS parameters
 *
 * Used to change BSS parameters (mainly for AP mode).
 *
 * @use_cts_prot: Whether to use CTS protection
 *	(0 = no, 1 = yes, -1 = do not change)
 * @use_short_preamble: Whether the use of short preambles is allowed
 *	(0 = no, 1 = yes, -1 = do not change)
 * @use_short_slot_time: Whether the use of short slot time is allowed
 *	(0 = no, 1 = yes, -1 = do not change)
931 932 933
 * @basic_rates: basic rates in IEEE 802.11 format
 *	(or NULL for no change)
 * @basic_rates_len: number of basic rates
934
 * @ap_isolate: do not forward packets between connected stations
935 936
 * @ht_opmode: HT Operation mode
 * 	(u16 = opmode, -1 = do not change)
937 938
 * @p2p_ctwindow: P2P CT Window (-1 = no change)
 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
939 940 941 942 943
 */
struct bss_parameters {
	int use_cts_prot;
	int use_short_preamble;
	int use_short_slot_time;
944 945
	u8 *basic_rates;
	u8 basic_rates_len;
946
	int ap_isolate;
947
	int ht_opmode;
948
	s8 p2p_ctwindow, p2p_opp_ps;
949
};
950

951
/**
952 953 954
 * struct mesh_config - 802.11s mesh configuration
 *
 * These parameters can be changed while the mesh is active.
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
 *
 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
 *	by the Mesh Peering Open message
 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
 *	used by the Mesh Peering Open message
 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
 *	the mesh peering management to close a mesh peering
 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
 *	mesh interface
 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
 *	be sent to establish a new peer link instance in a mesh
 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
 * @element_ttl: the value of TTL field set at a mesh STA for path selection
 *	elements
 * @auto_open_plinks: whether we should automatically open peer links when we
 *	detect compatible mesh peers
 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
 *	synchronize to for 11s default synchronization method
 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
 *	that an originator mesh STA can send to a particular path target
 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
 * @min_discovery_timeout: the minimum length of time to wait until giving up on
 *	a path discovery in milliseconds
 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
 *	receiving a PREQ shall consider the forwarding information from the
 *	root to be valid. (TU = time unit)
 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
 *	which a mesh STA can send only one action frame containing a PREQ
 *	element
 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
 *	which a mesh STA can send only one Action frame containing a PERR
 *	element
 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
 *	it takes for an HWMP information element to propagate across the mesh
 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
 *	announcements are transmitted
 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
 *	station has access to a broader network beyond the MBSS. (This is
 *	missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
 *	only means that the station will announce others it's a mesh gate, but
 *	not necessarily using the gate announcement protocol. Still keeping the
 *	same nomenclature to be in sync with the spec)
 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
 *	entity (default is TRUE - forwarding entity)
 * @rssi_threshold: the threshold for average signal strength of candidate
 *	station to establish a peer link
 * @ht_opmode: mesh HT protection mode
1003 1004 1005 1006 1007 1008 1009
 *
 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
 *	receiving a proactive PREQ shall consider the forwarding information to
 *	the root mesh STA to be valid.
 *
 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
 *	PREQs are transmitted.
1010 1011 1012
 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
 *	during which a mesh STA can send only one Action frame containing
 *	a PREQ element for root path confirmation.
1013 1014 1015 1016
 * @power_mode: The default mesh power save mode which will be the initial
 *	setting for new peer links.
 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
 *	after transmitting its beacon.
1017
 */
1018 1019 1020 1021 1022
struct mesh_config {
	u16 dot11MeshRetryTimeout;
	u16 dot11MeshConfirmTimeout;
	u16 dot11MeshHoldingTimeout;
	u16 dot11MeshMaxPeerLinks;
1023 1024 1025
	u8 dot11MeshMaxRetries;
	u8 dot11MeshTTL;
	u8 element_ttl;
1026
	bool auto_open_plinks;
1027
	u32 dot11MeshNbrOffsetMaxNeighbor;
1028
	u8 dot11MeshHWMPmaxPREQretries;
1029 1030 1031 1032
	u32 path_refresh_time;
	u16 min_discovery_timeout;
	u32 dot11MeshHWMPactivePathTimeout;
	u16 dot11MeshHWMPpreqMinInterval;
1033
	u16 dot11MeshHWMPperrMinInterval;
1034
	u16 dot11MeshHWMPnetDiameterTraversalTime;
1035
	u8 dot11MeshHWMPRootMode;
1036
	u16 dot11MeshHWMPRannInterval;
1037
	bool dot11MeshGateAnnouncementProtocol;
1038
	bool dot11MeshForwarding;
1039
	s32 rssi_threshold;
1040
	u16 ht_opmode;
1041 1042
	u32 dot11MeshHWMPactivePathToRootTimeout;
	u16 dot11MeshHWMProotInterval;
1043
	u16 dot11MeshHWMPconfirmationInterval;
1044 1045
	enum nl80211_mesh_power_mode power_mode;
	u16 dot11MeshAwakeWindowDuration;
1046 1047
};

1048 1049
/**
 * struct mesh_setup - 802.11s mesh setup configuration
1050
 * @chandef: defines the channel to use
1051 1052
 * @mesh_id: the mesh ID
 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1053
 * @sync_method: which synchronization method to use
1054 1055
 * @path_sel_proto: which path selection protocol to use
 * @path_metric: which metric to use
1056 1057
 * @ie: vendor information elements (optional)
 * @ie_len: length of vendor information elements
1058 1059
 * @is_authenticated: this mesh requires authentication
 * @is_secure: this mesh uses security
1060 1061
 * @dtim_period: DTIM period to use
 * @beacon_interval: beacon interval to use
1062
 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1063 1064 1065 1066
 *
 * These parameters are fixed when the mesh is created.
 */
struct mesh_setup {
1067
	struct cfg80211_chan_def chandef;
1068 1069
	const u8 *mesh_id;
	u8 mesh_id_len;
1070 1071 1072
	u8 sync_method;
	u8 path_sel_proto;
	u8 path_metric;
1073 1074
	const u8 *ie;
	u8 ie_len;
1075
	bool is_authenticated;
1076
	bool is_secure;
1077 1078
	u8 dtim_period;
	u16 beacon_interval;
1079
	int mcast_rate[IEEE80211_NUM_BANDS];
1080 1081
};

1082 1083
/**
 * struct ieee80211_txq_params - TX queue parameters
1084
 * @ac: AC identifier
1085 1086 1087 1088 1089 1090 1091 1092
 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
 *	1..32767]
 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
 *	1..32767]
 * @aifs: Arbitration interframe space [0..255]
 */
struct ieee80211_txq_params {
1093
	enum nl80211_ac ac;
1094 1095 1096 1097 1098 1099
	u16 txop;
	u16 cwmin;
	u16 cwmax;
	u8 aifs;
};

J
Johannes Berg 已提交
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
/**
 * DOC: Scanning and BSS list handling
 *
 * The scanning process itself is fairly simple, but cfg80211 offers quite
 * a bit of helper functionality. To start a scan, the scan operation will
 * be invoked with a scan definition. This scan definition contains the
 * channels to scan, and the SSIDs to send probe requests for (including the
 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
 * probe. Additionally, a scan request may contain extra information elements
 * that should be added to the probe request. The IEs are guaranteed to be
 * well-formed, and will not exceed the maximum length the driver advertised
 * in the wiphy structure.
 *
 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
 * it is responsible for maintaining the BSS list; the driver should not
 * maintain a list itself. For this notification, various functions exist.
 *
 * Since drivers do not maintain a BSS list, there are also a number of
 * functions to search for a BSS and obtain information about it from the
 * BSS structure cfg80211 maintains. The BSS list is also made available
 * to userspace.
 */
1122

1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
/**
 * struct cfg80211_ssid - SSID description
 * @ssid: the SSID
 * @ssid_len: length of the ssid
 */
struct cfg80211_ssid {
	u8 ssid[IEEE80211_MAX_SSID_LEN];
	u8 ssid_len;
};

/**
 * struct cfg80211_scan_request - scan request description
 *
 * @ssids: SSIDs to scan for (active scan only)
 * @n_ssids: number of SSIDs
 * @channels: channels to scan on.
1139
 * @n_channels: total number of channels to scan
1140 1141
 * @ie: optional information element(s) to add into Probe Request or %NULL
 * @ie_len: length of ie in octets
1142
 * @flags: bit field of flags controlling operation
1143
 * @rates: bitmap of rates to advertise for each band
1144
 * @wiphy: the wiphy this was for
1145
 * @scan_start: time (in jiffies) when the scan started
J
Johannes Berg 已提交
1146
 * @wdev: the wireless device to scan for
J
Johannes Berg 已提交
1147
 * @aborted: (internal) scan request was notified as aborted
1148
 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1149 1150 1151 1152 1153
 */
struct cfg80211_scan_request {
	struct cfg80211_ssid *ssids;
	int n_ssids;
	u32 n_channels;
1154
	const u8 *ie;
1155
	size_t ie_len;
1156
	u32 flags;
1157

1158 1159
	u32 rates[IEEE80211_NUM_BANDS];

J
Johannes Berg 已提交
1160 1161
	struct wireless_dev *wdev;

1162 1163
	/* internal */
	struct wiphy *wiphy;
1164
	unsigned long scan_start;
J
Johannes Berg 已提交
1165
	bool aborted;
1166
	bool no_cck;
1167 1168 1169

	/* keep last */
	struct ieee80211_channel *channels[0];
1170 1171
};

1172 1173 1174 1175 1176 1177 1178 1179 1180
/**
 * struct cfg80211_match_set - sets of attributes to match
 *
 * @ssid: SSID to be matched
 */
struct cfg80211_match_set {
	struct cfg80211_ssid ssid;
};

1181 1182 1183 1184 1185 1186
/**
 * struct cfg80211_sched_scan_request - scheduled scan request description
 *
 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
 * @n_ssids: number of SSIDs
 * @n_channels: total number of channels to scan
1187
 * @interval: interval between each scheduled scan cycle
1188 1189
 * @ie: optional information element(s) to add into Probe Request or %NULL
 * @ie_len: length of ie in octets
1190
 * @flags: bit field of flags controlling operation
1191 1192 1193 1194 1195
 * @match_sets: sets of parameters to be matched for a scan result
 * 	entry to be considered valid and to be passed to the host
 * 	(others are filtered out).
 *	If ommited, all results are passed.
 * @n_match_sets: number of match sets
1196 1197 1198
 * @wiphy: the wiphy this was for
 * @dev: the interface
 * @channels: channels to scan
1199
 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1200 1201 1202 1203 1204
 */
struct cfg80211_sched_scan_request {
	struct cfg80211_ssid *ssids;
	int n_ssids;
	u32 n_channels;
1205
	u32 interval;
1206 1207
	const u8 *ie;
	size_t ie_len;
1208
	u32 flags;
1209 1210
	struct cfg80211_match_set *match_sets;
	int n_match_sets;
1211
	s32 rssi_thold;
1212 1213 1214 1215

	/* internal */
	struct wiphy *wiphy;
	struct net_device *dev;
1216
	unsigned long scan_start;
1217 1218 1219 1220 1221

	/* keep last */
	struct ieee80211_channel *channels[0];
};

1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
/**
 * enum cfg80211_signal_type - signal type
 *
 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
 */
enum cfg80211_signal_type {
	CFG80211_SIGNAL_TYPE_NONE,
	CFG80211_SIGNAL_TYPE_MBM,
	CFG80211_SIGNAL_TYPE_UNSPEC,
};

1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
/**
 * struct cfg80211_bss_ie_data - BSS entry IE data
 * @rcu_head: internal use, for freeing
 * @len: length of the IEs
 * @data: IE data
 */
struct cfg80211_bss_ies {
	struct rcu_head rcu_head;
	int len;
	u8 data[];
};

1247 1248 1249 1250 1251 1252
/**
 * struct cfg80211_bss - BSS description
 *
 * This structure describes a BSS (which may also be a mesh network)
 * for use in scan results and similar.
 *
J
Johannes Berg 已提交
1253
 * @channel: channel this BSS is on
1254 1255 1256 1257
 * @bssid: BSSID of the BSS
 * @tsf: timestamp of last received update
 * @beacon_interval: the beacon interval as from the frame
 * @capability: the capability field in host byte order
1258
 * @ies: the information elements (Note that there
1259 1260 1261 1262 1263
 *	is no guarantee that these are well-formed!); this is a pointer to
 *	either the beacon_ies or proberesp_ies depending on whether Probe
 *	Response frame has been received
 * @beacon_ies: the information elements from the last Beacon frame
 * @proberesp_ies: the information elements from the last Probe Response frame
J
Johannes Berg 已提交
1264
 * @signal: signal strength value (type depends on the wiphy's signal_type)
J
Johannes Berg 已提交
1265
 * @free_priv: function pointer to free private data
1266 1267 1268
 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
 */
struct cfg80211_bss {
1269 1270
	u64 tsf;

1271 1272
	struct ieee80211_channel *channel;

1273 1274 1275 1276 1277 1278 1279 1280
	const struct cfg80211_bss_ies __rcu *ies;
	const struct cfg80211_bss_ies __rcu *beacon_ies;
	const struct cfg80211_bss_ies __rcu *proberesp_ies;

	void (*free_priv)(struct cfg80211_bss *bss);

	s32 signal;

1281 1282 1283
	u16 beacon_interval;
	u16 capability;

1284
	u8 bssid[ETH_ALEN];
1285

J
Johannes Berg 已提交
1286
	u8 priv[0] __aligned(sizeof(void *));
1287 1288
};

1289 1290 1291 1292
/**
 * ieee80211_bss_get_ie - find IE with given ID
 * @bss: the bss to search
 * @ie: the IE ID
1293 1294 1295
 *
 * Note that the return value is an RCU-protected pointer, so
 * rcu_read_lock() must be held when calling this function.
1296
 * Return: %NULL if not found.
1297 1298 1299 1300
 */
const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);


1301 1302 1303 1304 1305
/**
 * struct cfg80211_auth_request - Authentication request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * authentication.
J
Johannes Berg 已提交
1306 1307
 *
 * @bss: The BSS to authenticate with.
1308 1309 1310
 * @auth_type: Authentication type (algorithm)
 * @ie: Extra IEs to add to Authentication frame or %NULL
 * @ie_len: Length of ie buffer in octets
J
Johannes Berg 已提交
1311 1312 1313
 * @key_len: length of WEP key for shared key authentication
 * @key_idx: index of WEP key for shared key authentication
 * @key: WEP key for shared key authentication
1314 1315 1316
 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
 *	Authentication transaction sequence number field.
 * @sae_data_len: Length of sae_data buffer in octets
1317 1318
 */
struct cfg80211_auth_request {
J
Johannes Berg 已提交
1319
	struct cfg80211_bss *bss;
1320 1321
	const u8 *ie;
	size_t ie_len;
J
Johannes Berg 已提交
1322
	enum nl80211_auth_type auth_type;
J
Johannes Berg 已提交
1323 1324
	const u8 *key;
	u8 key_len, key_idx;
1325 1326
	const u8 *sae_data;
	size_t sae_data_len;
1327 1328
};

1329 1330 1331 1332 1333 1334 1335 1336 1337
/**
 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
 *
 * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
 */
enum cfg80211_assoc_req_flags {
	ASSOC_REQ_DISABLE_HT		= BIT(0),
};

1338 1339 1340 1341 1342
/**
 * struct cfg80211_assoc_request - (Re)Association request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * (re)association.
1343 1344 1345 1346 1347
 * @bss: The BSS to associate with. If the call is successful the driver
 *	is given a reference that it must release, normally via a call to
 *	cfg80211_send_rx_assoc(), or, if association timed out, with a
 *	call to cfg80211_put_bss() (in addition to calling
 *	cfg80211_send_assoc_timeout())
1348 1349
 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
 * @ie_len: Length of ie buffer in octets
1350
 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
S
Samuel Ortiz 已提交
1351
 * @crypto: crypto settings
1352
 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1353 1354 1355 1356
 * @flags:  See &enum cfg80211_assoc_req_flags
 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
 *   will be used in ht_capa.  Un-supported values will be ignored.
 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1357 1358
 */
struct cfg80211_assoc_request {
J
Johannes Berg 已提交
1359
	struct cfg80211_bss *bss;
1360
	const u8 *ie, *prev_bssid;
1361
	size_t ie_len;
S
Samuel Ortiz 已提交
1362
	struct cfg80211_crypto_settings crypto;
J
Johannes Berg 已提交
1363
	bool use_mfp;
1364 1365 1366
	u32 flags;
	struct ieee80211_ht_cap ht_capa;
	struct ieee80211_ht_cap ht_capa_mask;
1367 1368 1369 1370 1371 1372 1373 1374
};

/**
 * struct cfg80211_deauth_request - Deauthentication request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * deauthentication.
 *
1375
 * @bssid: the BSSID of the BSS to deauthenticate from
1376 1377
 * @ie: Extra IEs to add to Deauthentication frame or %NULL
 * @ie_len: Length of ie buffer in octets
J
Johannes Berg 已提交
1378
 * @reason_code: The reason code for the deauthentication
1379 1380
 */
struct cfg80211_deauth_request {
1381
	const u8 *bssid;
1382 1383
	const u8 *ie;
	size_t ie_len;
J
Johannes Berg 已提交
1384
	u16 reason_code;
1385
	bool local_state_change;
1386 1387 1388 1389 1390 1391 1392 1393
};

/**
 * struct cfg80211_disassoc_request - Disassociation request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * disassocation.
 *
J
Johannes Berg 已提交
1394
 * @bss: the BSS to disassociate from
1395 1396
 * @ie: Extra IEs to add to Disassociation frame or %NULL
 * @ie_len: Length of ie buffer in octets
J
Johannes Berg 已提交
1397
 * @reason_code: The reason code for the disassociation
1398 1399
 * @local_state_change: This is a request for a local state only, i.e., no
 *	Disassociation frame is to be transmitted.
1400 1401
 */
struct cfg80211_disassoc_request {
J
Johannes Berg 已提交
1402
	struct cfg80211_bss *bss;
1403 1404
	const u8 *ie;
	size_t ie_len;
J
Johannes Berg 已提交
1405
	u16 reason_code;
1406
	bool local_state_change;
1407 1408
};

J
Johannes Berg 已提交
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
/**
 * struct cfg80211_ibss_params - IBSS parameters
 *
 * This structure defines the IBSS parameters for the join_ibss()
 * method.
 *
 * @ssid: The SSID, will always be non-null.
 * @ssid_len: The length of the SSID, will always be non-zero.
 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
 *	search for IBSSs with a different BSSID.
1419
 * @chandef: defines the channel to use if no other IBSS to join can be found
J
Johannes Berg 已提交
1420 1421 1422 1423
 * @channel_fixed: The channel should be fixed -- do not search for
 *	IBSSs to join on other channels.
 * @ie: information element(s) to include in the beacon
 * @ie_len: length of that
1424
 * @beacon_interval: beacon interval to use
J
Johannes Berg 已提交
1425 1426
 * @privacy: this is a protected network, keys will be configured
 *	after joining
1427 1428 1429 1430
 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
 *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 *	required to assume that the port is unauthorized until authorized by
 *	user space. Otherwise, port is marked authorized by default.
1431
 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1432
 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
J
Johannes Berg 已提交
1433 1434 1435 1436
 */
struct cfg80211_ibss_params {
	u8 *ssid;
	u8 *bssid;
1437
	struct cfg80211_chan_def chandef;
J
Johannes Berg 已提交
1438 1439
	u8 *ie;
	u8 ssid_len, ie_len;
1440
	u16 beacon_interval;
1441
	u32 basic_rates;
J
Johannes Berg 已提交
1442
	bool channel_fixed;
J
Johannes Berg 已提交
1443
	bool privacy;
1444
	bool control_port;
1445
	int mcast_rate[IEEE80211_NUM_BANDS];
J
Johannes Berg 已提交
1446 1447
};

S
Samuel Ortiz 已提交
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
/**
 * struct cfg80211_connect_params - Connection parameters
 *
 * This structure provides information needed to complete IEEE 802.11
 * authentication and association.
 *
 * @channel: The channel to use or %NULL if not specified (auto-select based
 *	on scan results)
 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
 *	results)
 * @ssid: SSID
 * @ssid_len: Length of ssid in octets
 * @auth_type: Authentication type (algorithm)
J
Johannes Berg 已提交
1461 1462
 * @ie: IEs for association request
 * @ie_len: Length of assoc_ie in octets
S
Samuel Ortiz 已提交
1463 1464
 * @privacy: indicates whether privacy-enabled APs should be used
 * @crypto: crypto settings
J
Johannes Berg 已提交
1465 1466 1467
 * @key_len: length of WEP key for shared key authentication
 * @key_idx: index of WEP key for shared key authentication
 * @key: WEP key for shared key authentication
1468
 * @flags:  See &enum cfg80211_assoc_req_flags
1469 1470
 * @bg_scan_period:  Background scan period in seconds
 *   or -1 to indicate that default value is to be used.
1471 1472 1473
 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
 *   will be used in ht_capa.  Un-supported values will be ignored.
 * @ht_capa_mask:  The bits of ht_capa which are to be used.
S
Samuel Ortiz 已提交
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
 */
struct cfg80211_connect_params {
	struct ieee80211_channel *channel;
	u8 *bssid;
	u8 *ssid;
	size_t ssid_len;
	enum nl80211_auth_type auth_type;
	u8 *ie;
	size_t ie_len;
	bool privacy;
	struct cfg80211_crypto_settings crypto;
J
Johannes Berg 已提交
1485 1486
	const u8 *key;
	u8 key_len, key_idx;
1487
	u32 flags;
1488
	int bg_scan_period;
1489 1490
	struct ieee80211_ht_cap ht_capa;
	struct ieee80211_ht_cap ht_capa_mask;
S
Samuel Ortiz 已提交
1491 1492
};

1493 1494
/**
 * enum wiphy_params_flags - set_wiphy_params bitfield values
J
Johannes Berg 已提交
1495 1496 1497 1498 1499
 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1500 1501 1502 1503 1504 1505
 */
enum wiphy_params_flags {
	WIPHY_PARAM_RETRY_SHORT		= 1 << 0,
	WIPHY_PARAM_RETRY_LONG		= 1 << 1,
	WIPHY_PARAM_FRAG_THRESHOLD	= 1 << 2,
	WIPHY_PARAM_RTS_THRESHOLD	= 1 << 3,
1506
	WIPHY_PARAM_COVERAGE_CLASS	= 1 << 4,
1507 1508
};

J
Johannes Berg 已提交
1509 1510 1511 1512 1513 1514
/*
 * cfg80211_bitrate_mask - masks for bitrate control
 */
struct cfg80211_bitrate_mask {
	struct {
		u32 legacy;
1515
		u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
J
Johannes Berg 已提交
1516 1517
	} control[IEEE80211_NUM_BANDS];
};
S
Samuel Ortiz 已提交
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
/**
 * struct cfg80211_pmksa - PMK Security Association
 *
 * This structure is passed to the set/del_pmksa() method for PMKSA
 * caching.
 *
 * @bssid: The AP's BSSID.
 * @pmkid: The PMK material itself.
 */
struct cfg80211_pmksa {
	u8 *bssid;
	u8 *pmkid;
};
J
Johannes Berg 已提交
1531

J
Johannes Berg 已提交
1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
/**
 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
 * @mask: bitmask where to match pattern and where to ignore bytes,
 *	one bit per byte, in same format as nl80211
 * @pattern: bytes to match where bitmask is 1
 * @pattern_len: length of pattern (in bytes)
 *
 * Internal note: @mask and @pattern are allocated in one chunk of
 * memory, free @mask only!
 */
struct cfg80211_wowlan_trig_pkt_pattern {
	u8 *mask, *pattern;
	int pattern_len;
};

/**
 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
 *
 * This structure defines the enabled WoWLAN triggers for the device.
 * @any: wake up on any activity -- special trigger if device continues
 *	operating as normal during suspend
 * @disconnect: wake up if getting disconnected
 * @magic_pkt: wake up on receiving magic packet
 * @patterns: wake up on receiving packet matching a pattern
 * @n_patterns: number of patterns
1557 1558 1559 1560
 * @gtk_rekey_failure: wake up on GTK rekey failure
 * @eap_identity_req: wake up on EAP identity request packet
 * @four_way_handshake: wake up on 4-way handshake
 * @rfkill_release: wake up when rfkill is released
J
Johannes Berg 已提交
1561 1562
 */
struct cfg80211_wowlan {
1563 1564 1565
	bool any, disconnect, magic_pkt, gtk_rekey_failure,
	     eap_identity_req, four_way_handshake,
	     rfkill_release;
J
Johannes Berg 已提交
1566 1567 1568 1569
	struct cfg80211_wowlan_trig_pkt_pattern *patterns;
	int n_patterns;
};

1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
/**
 * struct cfg80211_gtk_rekey_data - rekey data
 * @kek: key encryption key
 * @kck: key confirmation key
 * @replay_ctr: replay counter
 */
struct cfg80211_gtk_rekey_data {
	u8 kek[NL80211_KEK_LEN];
	u8 kck[NL80211_KCK_LEN];
	u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
};

1582 1583 1584 1585 1586 1587 1588 1589 1590
/**
 * struct cfg80211_ops - backend description for wireless configuration
 *
 * This struct is registered by fullmac card drivers and/or wireless stacks
 * in order to handle configuration requests on their interfaces.
 *
 * All callbacks except where otherwise noted should return 0
 * on success or a negative error code.
 *
1591 1592 1593 1594
 * All operations are currently invoked under rtnl for consistency with the
 * wireless extensions but this is subject to reevaluation as soon as this
 * code is used more widely and we have a first user without wext.
 *
J
Johannes Berg 已提交
1595 1596 1597
 * @suspend: wiphy device needs to be suspended. The variable @wow will
 *	be %NULL or contain the enabled Wake-on-Wireless triggers that are
 *	configured for the device.
J
Johannes Berg 已提交
1598
 * @resume: wiphy device needs to be resumed
1599 1600 1601
 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
 *	to call device_set_wakeup_enable() to enable/disable wakeup from
 *	the device.
J
Johannes Berg 已提交
1602
 *
J
Johannes Berg 已提交
1603
 * @add_virtual_intf: create a new virtual interface with the given name,
1604
 *	must set the struct wireless_dev's iftype. Beware: You must create
1605
 *	the new netdev in the wiphy's network namespace! Returns the struct
1606 1607
 *	wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
 *	also set the address member in the wdev.
1608
 *
1609
 * @del_virtual_intf: remove the virtual interface
1610
 *
J
Johannes Berg 已提交
1611 1612
 * @change_virtual_intf: change type/configuration of virtual interface,
 *	keep the struct wireless_dev's iftype updated.
1613
 *
1614 1615 1616 1617 1618 1619
 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
 *	when adding a group key.
 *
 * @get_key: get information about the key with the given parameters.
 *	@mac_addr will be %NULL when requesting information for a group
 *	key. All pointers given to the @callback function need not be valid
1620 1621
 *	after it returns. This function should return an error if it is
 *	not possible to retrieve the key, -ENOENT if it doesn't exist.
1622 1623
 *
 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1624
 *	and @key_index, return -ENOENT if the key doesn't exist.
1625 1626
 *
 * @set_default_key: set the default key on an interface
1627
 *
1628 1629
 * @set_default_mgmt_key: set the default management frame key on an interface
 *
1630 1631
 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
 *
J
Johannes Berg 已提交
1632 1633 1634 1635
 * @start_ap: Start acting in AP mode defined by the parameters.
 * @change_beacon: Change the beacon parameters for an access point mode
 *	interface. This should reject the call when AP mode wasn't started.
 * @stop_ap: Stop being an AP, including stopping beaconing.
1636 1637 1638
 *
 * @add_station: Add a new station.
 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1639 1640 1641 1642 1643 1644
 * @change_station: Modify a given station. Note that flags changes are not much
 *	validated in cfg80211, in particular the auth/assoc/authorized flags
 *	might come to the driver in invalid combinations -- make sure to check
 *	them, also against the existing state! Also, supported_rates changes are
 *	not checked in station mode -- drivers need to reject (or ignore) them
 *	for anything but TDLS peers.
J
Johannes Berg 已提交
1645 1646 1647 1648 1649 1650 1651 1652
 * @get_station: get station information for the station identified by @mac
 * @dump_station: dump station callback -- resume dump at index @idx
 *
 * @add_mpath: add a fixed mesh path
 * @del_mpath: delete a given mesh path
 * @change_mpath: change a given mesh path
 * @get_mpath: get a mesh path for the given parameters
 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1653 1654
 * @join_mesh: join the mesh network with the specified parameters
 * @leave_mesh: leave the current mesh network
1655
 *
1656
 * @get_mesh_config: Get the current mesh configuration
1657
 *
1658
 * @update_mesh_config: Update mesh parameters on a running mesh.
1659 1660 1661
 *	The mask is a bitfield which tells us which parameters to
 *	set, and which to leave alone.
 *
1662
 * @change_bss: Modify parameters for a given BSS.
1663 1664
 *
 * @set_txq_params: Set TX queue parameters
1665
 *
1666 1667 1668 1669 1670 1671 1672 1673
 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
 *	as it doesn't implement join_mesh and needs to set the channel to
 *	join the mesh instead.
 *
 * @set_monitor_channel: Set the monitor mode channel for the device. If other
 *	interfaces are active this callback should reject the configuration.
 *	If no interfaces are active or the device is down, the channel should
 *	be stored for when a monitor interface becomes active.
1674
 *
1675 1676 1677 1678
 * @scan: Request to do a scan. If returning zero, the scan request is given
 *	the driver, and will be valid until passed to cfg80211_scan_done().
 *	For scan results, call cfg80211_inform_bss(); you can call this outside
 *	the scan/scan_done bracket too.
1679 1680 1681 1682 1683
 *
 * @auth: Request to authenticate with the specified peer
 * @assoc: Request to (re)associate with the specified peer
 * @deauth: Request to deauthenticate from the specified peer
 * @disassoc: Request to disassociate from the specified peer
J
Johannes Berg 已提交
1684
 *
S
Samuel Ortiz 已提交
1685 1686 1687 1688 1689 1690
 * @connect: Connect to the ESS with the specified parameters. When connected,
 *	call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
 *	If the connection fails for some reason, call cfg80211_connect_result()
 *	with the status from the AP.
 * @disconnect: Disconnect from the BSS/ESS.
 *
J
Johannes Berg 已提交
1691 1692 1693 1694
 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
 *	cfg80211_ibss_joined(), also call that function when changing BSSID due
 *	to a merge.
 * @leave_ibss: Leave the IBSS.
1695
 *
1696 1697 1698
 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
 *	MESH mode)
 *
1699 1700 1701 1702
 * @set_wiphy_params: Notify that wiphy parameters have changed;
 *	@changed bitfield (see &enum wiphy_params_flags) describes which values
 *	have changed. The actual parameter values are available in
 *	struct wiphy. If returning an error, no value should be changed.
1703
 *
1704
 * @set_tx_power: set the transmit power according to the parameters,
1705 1706 1707 1708
 *	the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
 *	wdev may be %NULL if power was set for the wiphy, and will
 *	always be %NULL unless the driver supports per-vif TX power
 *	(as advertised by the nl80211 feature flag.)
1709
 * @get_tx_power: store the current TX power into the dbm variable;
J
Johannes Berg 已提交
1710 1711
 *	return 0 if successful
 *
J
Johannes Berg 已提交
1712 1713
 * @set_wds_peer: set the WDS peer for a WDS interface
 *
J
Johannes Berg 已提交
1714 1715
 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
 *	functions to adjust rfkill hw state
1716
 *
1717 1718
 * @dump_survey: get site survey information.
 *
1719 1720 1721 1722 1723 1724 1725 1726
 * @remain_on_channel: Request the driver to remain awake on the specified
 *	channel for the specified duration to complete an off-channel
 *	operation (e.g., public action frame exchange). When the driver is
 *	ready on the requested channel, it must indicate this with an event
 *	notification by calling cfg80211_ready_on_channel().
 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
 *	This allows the operation to be terminated prior to timeout based on
 *	the duration value.
1727 1728 1729
 * @mgmt_tx: Transmit a management frame.
 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
 *	frame on another channel
1730
 *
1731
 * @testmode_cmd: run a test mode command
W
Wey-Yi Guy 已提交
1732 1733 1734 1735 1736 1737
 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
 *	used by the function, but 0 and 1 must not be touched. Additionally,
 *	return error codes other than -ENOBUFS and -ENOENT will terminate the
 *	dump and return to userspace with an error, so be careful. If any data
 *	was passed in from userspace then the data/len arguments will be present
 *	and point to the data contained in %NL80211_ATTR_TESTDATA.
S
Samuel Ortiz 已提交
1738
 *
J
Johannes Berg 已提交
1739 1740
 * @set_bitrate_mask: set the bitrate mask configuration
 *
S
Samuel Ortiz 已提交
1741 1742 1743 1744 1745
 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
 *	devices running firmwares capable of generating the (re) association
 *	RSN IE. It allows for faster roaming between WPA2 BSSIDs.
 * @del_pmksa: Delete a cached PMKID.
 * @flush_pmksa: Flush all cached PMKIDs.
1746 1747
 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
 *	allows the driver to adjust the dynamic ps timeout value.
1748
 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1749 1750
 * @set_cqm_txe_config: Configure connection quality monitor TX error
 *	thresholds.
1751
 * @sched_scan_start: Tell the driver to start a scheduled scan.
1752
 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
S
Samuel Ortiz 已提交
1753
 *
1754 1755 1756
 * @mgmt_frame_register: Notify driver that a management frame type was
 *	registered. Note that this callback may not sleep, and cannot run
 *	concurrently with itself.
1757 1758 1759 1760 1761 1762 1763
 *
 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
 *	Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
 *	reject TX/RX mask combinations they cannot support by returning -EINVAL
 *	(also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
 *
 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1764 1765 1766 1767
 *
 * @set_ringparam: Set tx and rx ring sizes.
 *
 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1768 1769 1770
 *
 * @tdls_mgmt: Transmit a TDLS management frame.
 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
J
Johannes Berg 已提交
1771 1772 1773
 *
 * @probe_client: probe an associated client, must return a cookie that it
 *	later passes to cfg80211_probe_status().
1774 1775
 *
 * @set_noack_map: Set the NoAck Map for the TIDs.
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785
 *
 * @get_et_sset_count:  Ethtool API to get string-set count.
 *	See @ethtool_ops.get_sset_count
 *
 * @get_et_stats:  Ethtool API to get a set of u64 stats.
 *	See @ethtool_ops.get_ethtool_stats
 *
 * @get_et_strings:  Ethtool API to get a set of strings to describe stats
 *	and perhaps other supported types of ethtool data-sets.
 *	See @ethtool_ops.get_strings
1786 1787 1788 1789
 *
 * @get_channel: Get the current operating channel for the virtual interface.
 *	For monitor interfaces, it should return %NULL unless there's a single
 *	current monitoring channel.
1790 1791 1792
 *
 * @start_p2p_device: Start the given P2P device.
 * @stop_p2p_device: Stop the given P2P device.
1793 1794
 */
struct cfg80211_ops {
J
Johannes Berg 已提交
1795
	int	(*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
J
Johannes Berg 已提交
1796
	int	(*resume)(struct wiphy *wiphy);
1797
	void	(*set_wakeup)(struct wiphy *wiphy, bool enabled);
J
Johannes Berg 已提交
1798

1799
	struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
1800
						  const char *name,
1801 1802 1803 1804 1805
						  enum nl80211_iftype type,
						  u32 *flags,
						  struct vif_params *params);
	int	(*del_virtual_intf)(struct wiphy *wiphy,
				    struct wireless_dev *wdev);
1806 1807
	int	(*change_virtual_intf)(struct wiphy *wiphy,
				       struct net_device *dev,
1808 1809
				       enum nl80211_iftype type, u32 *flags,
				       struct vif_params *params);
1810 1811

	int	(*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1812
			   u8 key_index, bool pairwise, const u8 *mac_addr,
1813 1814
			   struct key_params *params);
	int	(*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1815 1816
			   u8 key_index, bool pairwise, const u8 *mac_addr,
			   void *cookie,
1817 1818
			   void (*callback)(void *cookie, struct key_params*));
	int	(*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1819
			   u8 key_index, bool pairwise, const u8 *mac_addr);
1820 1821
	int	(*set_default_key)(struct wiphy *wiphy,
				   struct net_device *netdev,
1822
				   u8 key_index, bool unicast, bool multicast);
1823 1824 1825
	int	(*set_default_mgmt_key)(struct wiphy *wiphy,
					struct net_device *netdev,
					u8 key_index);
1826

1827 1828 1829 1830 1831
	int	(*start_ap)(struct wiphy *wiphy, struct net_device *dev,
			    struct cfg80211_ap_settings *settings);
	int	(*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
				 struct cfg80211_beacon_data *info);
	int	(*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
1832 1833 1834 1835 1836 1837 1838 1839


	int	(*add_station)(struct wiphy *wiphy, struct net_device *dev,
			       u8 *mac, struct station_parameters *params);
	int	(*del_station)(struct wiphy *wiphy, struct net_device *dev,
			       u8 *mac);
	int	(*change_station)(struct wiphy *wiphy, struct net_device *dev,
				  u8 *mac, struct station_parameters *params);
1840
	int	(*get_station)(struct wiphy *wiphy, struct net_device *dev,
1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856
			       u8 *mac, struct station_info *sinfo);
	int	(*dump_station)(struct wiphy *wiphy, struct net_device *dev,
			       int idx, u8 *mac, struct station_info *sinfo);

	int	(*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
			       u8 *dst, u8 *next_hop);
	int	(*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
			       u8 *dst);
	int	(*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
				  u8 *dst, u8 *next_hop);
	int	(*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
			       u8 *dst, u8 *next_hop,
			       struct mpath_info *pinfo);
	int	(*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
			       int idx, u8 *dst, u8 *next_hop,
			       struct mpath_info *pinfo);
1857
	int	(*get_mesh_config)(struct wiphy *wiphy,
1858 1859
				struct net_device *dev,
				struct mesh_config *conf);
1860
	int	(*update_mesh_config)(struct wiphy *wiphy,
1861 1862 1863 1864 1865 1866 1867
				      struct net_device *dev, u32 mask,
				      const struct mesh_config *nconf);
	int	(*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
			     const struct mesh_config *conf,
			     const struct mesh_setup *setup);
	int	(*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);

1868 1869
	int	(*change_bss)(struct wiphy *wiphy, struct net_device *dev,
			      struct bss_parameters *params);
1870

1871
	int	(*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1872
				  struct ieee80211_txq_params *params);
1873

1874 1875 1876 1877 1878
	int	(*libertas_set_mesh_channel)(struct wiphy *wiphy,
					     struct net_device *dev,
					     struct ieee80211_channel *chan);

	int	(*set_monitor_channel)(struct wiphy *wiphy,
1879
				       struct cfg80211_chan_def *chandef);
1880

J
Johannes Berg 已提交
1881
	int	(*scan)(struct wiphy *wiphy,
1882
			struct cfg80211_scan_request *request);
1883 1884 1885 1886 1887 1888

	int	(*auth)(struct wiphy *wiphy, struct net_device *dev,
			struct cfg80211_auth_request *req);
	int	(*assoc)(struct wiphy *wiphy, struct net_device *dev,
			 struct cfg80211_assoc_request *req);
	int	(*deauth)(struct wiphy *wiphy, struct net_device *dev,
1889
			  struct cfg80211_deauth_request *req);
1890
	int	(*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1891
			    struct cfg80211_disassoc_request *req);
J
Johannes Berg 已提交
1892

S
Samuel Ortiz 已提交
1893 1894 1895 1896 1897
	int	(*connect)(struct wiphy *wiphy, struct net_device *dev,
			   struct cfg80211_connect_params *sme);
	int	(*disconnect)(struct wiphy *wiphy, struct net_device *dev,
			      u16 reason_code);

J
Johannes Berg 已提交
1898 1899 1900
	int	(*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
			     struct cfg80211_ibss_params *params);
	int	(*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1901

1902 1903 1904
	int	(*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
				  int rate[IEEE80211_NUM_BANDS]);

1905
	int	(*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1906

1907
	int	(*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
1908
				enum nl80211_tx_power_setting type, int mbm);
1909 1910
	int	(*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
				int *dbm);
J
Johannes Berg 已提交
1911

J
Johannes Berg 已提交
1912
	int	(*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
J
Johannes Berg 已提交
1913
				const u8 *addr);
J
Johannes Berg 已提交
1914

J
Johannes Berg 已提交
1915
	void	(*rfkill_poll)(struct wiphy *wiphy);
1916 1917 1918

#ifdef CONFIG_NL80211_TESTMODE
	int	(*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
W
Wey-Yi Guy 已提交
1919 1920 1921
	int	(*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
				 struct netlink_callback *cb,
				 void *data, int len);
1922
#endif
J
Johannes Berg 已提交
1923

J
Johannes Berg 已提交
1924 1925 1926 1927 1928
	int	(*set_bitrate_mask)(struct wiphy *wiphy,
				    struct net_device *dev,
				    const u8 *peer,
				    const struct cfg80211_bitrate_mask *mask);

1929 1930 1931
	int	(*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
			int idx, struct survey_info *info);

S
Samuel Ortiz 已提交
1932 1933 1934 1935 1936 1937
	int	(*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
			     struct cfg80211_pmksa *pmksa);
	int	(*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
			     struct cfg80211_pmksa *pmksa);
	int	(*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);

1938
	int	(*remain_on_channel)(struct wiphy *wiphy,
1939
				     struct wireless_dev *wdev,
1940 1941 1942 1943
				     struct ieee80211_channel *chan,
				     unsigned int duration,
				     u64 *cookie);
	int	(*cancel_remain_on_channel)(struct wiphy *wiphy,
1944
					    struct wireless_dev *wdev,
1945 1946
					    u64 cookie);

1947
	int	(*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
1948
			  struct ieee80211_channel *chan, bool offchan,
1949 1950
			  unsigned int wait, const u8 *buf, size_t len,
			  bool no_cck, bool dont_wait_for_ack, u64 *cookie);
1951
	int	(*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1952
				       struct wireless_dev *wdev,
1953
				       u64 cookie);
1954

J
Johannes Berg 已提交
1955 1956
	int	(*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
				  bool enabled, int timeout);
1957 1958 1959 1960

	int	(*set_cqm_rssi_config)(struct wiphy *wiphy,
				       struct net_device *dev,
				       s32 rssi_thold, u32 rssi_hyst);
1961

1962 1963 1964 1965
	int	(*set_cqm_txe_config)(struct wiphy *wiphy,
				      struct net_device *dev,
				      u32 rate, u32 pkts, u32 intvl);

1966
	void	(*mgmt_frame_register)(struct wiphy *wiphy,
1967
				       struct wireless_dev *wdev,
1968
				       u16 frame_type, bool reg);
1969 1970 1971

	int	(*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
	int	(*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1972 1973 1974 1975

	int	(*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
	void	(*get_ringparam)(struct wiphy *wiphy,
				 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1976 1977 1978 1979

	int	(*sched_scan_start)(struct wiphy *wiphy,
				struct net_device *dev,
				struct cfg80211_sched_scan_request *request);
1980
	int	(*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1981 1982 1983

	int	(*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
				  struct cfg80211_gtk_rekey_data *data);
1984 1985 1986 1987 1988 1989

	int	(*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
			     u8 *peer, u8 action_code,  u8 dialog_token,
			     u16 status_code, const u8 *buf, size_t len);
	int	(*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
			     u8 *peer, enum nl80211_tdls_operation oper);
J
Johannes Berg 已提交
1990 1991 1992

	int	(*probe_client)(struct wiphy *wiphy, struct net_device *dev,
				const u8 *peer, u64 *cookie);
1993

1994 1995 1996 1997
	int	(*set_noack_map)(struct wiphy *wiphy,
				  struct net_device *dev,
				  u16 noack_map);

1998 1999 2000 2001 2002 2003
	int	(*get_et_sset_count)(struct wiphy *wiphy,
				     struct net_device *dev, int sset);
	void	(*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
				struct ethtool_stats *stats, u64 *data);
	void	(*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
				  u32 sset, u8 *data);
2004

2005
	int	(*get_channel)(struct wiphy *wiphy,
2006
			       struct wireless_dev *wdev,
2007
			       struct cfg80211_chan_def *chandef);
2008 2009 2010 2011 2012

	int	(*start_p2p_device)(struct wiphy *wiphy,
				    struct wireless_dev *wdev);
	void	(*stop_p2p_device)(struct wiphy *wiphy,
				   struct wireless_dev *wdev);
2013 2014
};

J
Johannes Berg 已提交
2015 2016 2017 2018 2019 2020
/*
 * wireless hardware and networking interfaces structures
 * and registration/helper functions
 */

/**
J
Johannes Berg 已提交
2021 2022 2023
 * enum wiphy_flags - wiphy capability flags
 *
 * @WIPHY_FLAG_CUSTOM_REGULATORY:  tells us the driver for this device
J
Johannes Berg 已提交
2024 2025 2026 2027
 * 	has its own custom regulatory domain and cannot identify the
 * 	ISO / IEC 3166 alpha2 it belongs to. When this is enabled
 * 	we will disregard the first regulatory hint (when the
 * 	initiator is %REGDOM_SET_BY_CORE).
J
Johannes Berg 已提交
2028 2029
 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
 *	ignore regulatory domain settings until it gets its own regulatory
2030 2031 2032 2033 2034 2035 2036
 *	domain via its regulatory_hint() unless the regulatory hint is
 *	from a country IE. After its gets its own regulatory domain it will
 *	only allow further regulatory domain settings to further enhance
 *	compliance. For example if channel 13 and 14 are disabled by this
 *	regulatory domain no user regulatory domain can enable these channels
 *	at a later time. This can be used for devices which do not have
 *	calibration information guaranteed for frequencies or settings
2037 2038 2039
 *	outside of its regulatory domain. If used in combination with
 *	WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
 *	will be followed.
J
Johannes Berg 已提交
2040 2041 2042
 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
 *	that passive scan flags and beaconing flags may not be lifted by
 *	cfg80211 due to regulatory beacon hints. For more information on beacon
2043
 *	hints read the documenation for regulatory_hint_found_beacon()
J
Johannes Berg 已提交
2044 2045 2046 2047 2048 2049
 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
 *	wiphy at all
 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
 *	by default -- this flag will be set depending on the kernel's default
 *	on wiphy_new(), but can be changed by the driver if it has a good
 *	reason to override the default
2050 2051 2052
 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
 *	on a VLAN interface)
 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2053 2054 2055
 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
 *	control port protocol ethertype. The device also honours the
 *	control_port_no_encrypt flag.
2056
 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2057 2058
 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
 *	auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2059
 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2060 2061
 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
 *	firmware.
2062
 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2063 2064 2065 2066 2067 2068
 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
 *	link setup/discovery operations internally. Setup, discovery and
 *	teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
 *	command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
 *	used for asking the driver/firmware to perform a TDLS operation.
J
Johannes Berg 已提交
2069
 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2070 2071 2072
 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
 *	when there are virtual interfaces in AP mode by calling
 *	cfg80211_report_obss_beacon().
2073 2074
 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
 *	responds to probe-requests in hardware.
2075 2076
 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
J
Johannes Berg 已提交
2077 2078
 */
enum wiphy_flags {
2079 2080 2081 2082 2083 2084 2085 2086
	WIPHY_FLAG_CUSTOM_REGULATORY		= BIT(0),
	WIPHY_FLAG_STRICT_REGULATORY		= BIT(1),
	WIPHY_FLAG_DISABLE_BEACON_HINTS		= BIT(2),
	WIPHY_FLAG_NETNS_OK			= BIT(3),
	WIPHY_FLAG_PS_ON_BY_DEFAULT		= BIT(4),
	WIPHY_FLAG_4ADDR_AP			= BIT(5),
	WIPHY_FLAG_4ADDR_STATION		= BIT(6),
	WIPHY_FLAG_CONTROL_PORT_PROTOCOL	= BIT(7),
2087
	WIPHY_FLAG_IBSS_RSN			= BIT(8),
2088
	WIPHY_FLAG_MESH_AUTH			= BIT(10),
2089
	WIPHY_FLAG_SUPPORTS_SCHED_SCAN		= BIT(11),
2090
	/* use hole at 12 */
2091
	WIPHY_FLAG_SUPPORTS_FW_ROAM		= BIT(13),
2092
	WIPHY_FLAG_AP_UAPSD			= BIT(14),
2093 2094
	WIPHY_FLAG_SUPPORTS_TDLS		= BIT(15),
	WIPHY_FLAG_TDLS_EXTERNAL_SETUP		= BIT(16),
J
Johannes Berg 已提交
2095
	WIPHY_FLAG_HAVE_AP_SME			= BIT(17),
2096
	WIPHY_FLAG_REPORTS_OBSS			= BIT(18),
2097
	WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD	= BIT(19),
2098 2099
	WIPHY_FLAG_OFFCHAN_TX			= BIT(20),
	WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL	= BIT(21),
2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173
};

/**
 * struct ieee80211_iface_limit - limit on certain interface types
 * @max: maximum number of interfaces of these types
 * @types: interface types (bits)
 */
struct ieee80211_iface_limit {
	u16 max;
	u16 types;
};

/**
 * struct ieee80211_iface_combination - possible interface combination
 * @limits: limits for the given interface types
 * @n_limits: number of limitations
 * @num_different_channels: can use up to this many different channels
 * @max_interfaces: maximum number of interfaces in total allowed in this
 *	group
 * @beacon_int_infra_match: In this combination, the beacon intervals
 *	between infrastructure and AP types must match. This is required
 *	only in special cases.
 *
 * These examples can be expressed as follows:
 *
 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
 *
 *  struct ieee80211_iface_limit limits1[] = {
 *	{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
 *	{ .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
 *  };
 *  struct ieee80211_iface_combination combination1 = {
 *	.limits = limits1,
 *	.n_limits = ARRAY_SIZE(limits1),
 *	.max_interfaces = 2,
 *	.beacon_int_infra_match = true,
 *  };
 *
 *
 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
 *
 *  struct ieee80211_iface_limit limits2[] = {
 *	{ .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
 *			     BIT(NL80211_IFTYPE_P2P_GO), },
 *  };
 *  struct ieee80211_iface_combination combination2 = {
 *	.limits = limits2,
 *	.n_limits = ARRAY_SIZE(limits2),
 *	.max_interfaces = 8,
 *	.num_different_channels = 1,
 *  };
 *
 *
 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
 * This allows for an infrastructure connection and three P2P connections.
 *
 *  struct ieee80211_iface_limit limits3[] = {
 *	{ .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
 *	{ .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
 *			     BIT(NL80211_IFTYPE_P2P_CLIENT), },
 *  };
 *  struct ieee80211_iface_combination combination3 = {
 *	.limits = limits3,
 *	.n_limits = ARRAY_SIZE(limits3),
 *	.max_interfaces = 4,
 *	.num_different_channels = 2,
 *  };
 */
struct ieee80211_iface_combination {
	const struct ieee80211_iface_limit *limits;
	u32 num_different_channels;
	u16 max_interfaces;
	u8 n_limits;
	bool beacon_int_infra_match;
J
Johannes Berg 已提交
2174 2175
};

2176 2177 2178 2179
struct mac_address {
	u8 addr[ETH_ALEN];
};

2180 2181 2182 2183
struct ieee80211_txrx_stypes {
	u16 tx, rx;
};

J
Johannes Berg 已提交
2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
/**
 * enum wiphy_wowlan_support_flags - WoWLAN support flags
 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
 *	trigger that keeps the device operating as-is and
 *	wakes up the host on any activity, for example a
 *	received packet that passed filtering; note that the
 *	packet should be preserved in that case
 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
 *	(see nl80211.h)
 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2194 2195 2196 2197 2198
 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
J
Johannes Berg 已提交
2199 2200
 */
enum wiphy_wowlan_support_flags {
2201 2202 2203 2204 2205 2206 2207 2208
	WIPHY_WOWLAN_ANY		= BIT(0),
	WIPHY_WOWLAN_MAGIC_PKT		= BIT(1),
	WIPHY_WOWLAN_DISCONNECT		= BIT(2),
	WIPHY_WOWLAN_SUPPORTS_GTK_REKEY	= BIT(3),
	WIPHY_WOWLAN_GTK_REKEY_FAILURE	= BIT(4),
	WIPHY_WOWLAN_EAP_IDENTITY_REQ	= BIT(5),
	WIPHY_WOWLAN_4WAY_HANDSHAKE	= BIT(6),
	WIPHY_WOWLAN_RFKILL_RELEASE	= BIT(7),
J
Johannes Berg 已提交
2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225
};

/**
 * struct wiphy_wowlan_support - WoWLAN support data
 * @flags: see &enum wiphy_wowlan_support_flags
 * @n_patterns: number of supported wakeup patterns
 *	(see nl80211.h for the pattern definition)
 * @pattern_max_len: maximum length of each pattern
 * @pattern_min_len: minimum length of each pattern
 */
struct wiphy_wowlan_support {
	u32 flags;
	int n_patterns;
	int pattern_max_len;
	int pattern_min_len;
};

J
Johannes Berg 已提交
2226 2227
/**
 * struct wiphy - wireless hardware description
2228 2229 2230
 * @reg_notifier: the driver's regulatory notification callback,
 *	note that if your driver uses wiphy_apply_custom_regulatory()
 *	the reg_notifier's request can be passed as NULL
J
Johannes Berg 已提交
2231 2232 2233 2234 2235 2236 2237
 * @regd: the driver's regulatory domain, if one was requested via
 * 	the regulatory_hint() API. This can be used by the driver
 *	on the reg_notifier() if it chooses to ignore future
 *	regulatory domain changes caused by other drivers.
 * @signal_type: signal type reported in &struct cfg80211_bss.
 * @cipher_suites: supported cipher suites
 * @n_cipher_suites: number of supported cipher suites
2238 2239 2240 2241 2242
 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
 *	-1 = fragmentation disabled, only odd values >= 256 used
 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
J
Johannes Berg 已提交
2243
 * @_net: the network namespace this wiphy currently lives in
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255
 * @perm_addr: permanent MAC address of this device
 * @addr_mask: If the device supports multiple MAC addresses by masking,
 *	set this to a mask with variable bits set to 1, e.g. if the last
 *	four bits are variable then set it to 00:...:00:0f. The actual
 *	variable bits shall be determined by the interfaces added, with
 *	interfaces not matching the mask being rejected to be brought up.
 * @n_addresses: number of addresses in @addresses.
 * @addresses: If the device has more than one address, set this pointer
 *	to a list of addresses (6 bytes each). The first one will be used
 *	by default for perm_addr. In this case, the mask should be set to
 *	all-zeroes. In this case it is assumed that the device can handle
 *	the same number of arbitrary MAC addresses.
2256 2257
 * @registered: protects ->resume and ->suspend sysfs callbacks against
 *	unregister hardware
J
Johannes Berg 已提交
2258 2259 2260
 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
 *	automatically on wiphy renames
 * @dev: (virtual) struct device for this wiphy
2261
 * @registered: helps synchronize suspend/resume with wiphy unregister
J
Johannes Berg 已提交
2262 2263 2264 2265
 * @wext: wireless extension handlers
 * @priv: driver private data (sized according to wiphy_new() parameter)
 * @interface_modes: bitmask of interfaces types valid for this wiphy,
 *	must be set by driver
2266 2267 2268 2269 2270
 * @iface_combinations: Valid interface combinations array, should not
 *	list single interface types.
 * @n_iface_combinations: number of entries in @iface_combinations array.
 * @software_iftypes: bitmask of software interface types, these are not
 *	subject to any restrictions since they are purely managed in SW.
J
Johannes Berg 已提交
2271
 * @flags: wiphy flags, see &enum wiphy_flags
2272
 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
J
Johannes Berg 已提交
2273 2274 2275 2276
 * @bss_priv_size: each BSS struct has private data allocated with it,
 *	this variable determines its size
 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
 *	any given scan
2277 2278
 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
 *	for in any given scheduled scan
2279 2280 2281
 * @max_match_sets: maximum number of match sets the device can handle
 *	when performing a scheduled scan, 0 if filtering is not
 *	supported.
J
Johannes Berg 已提交
2282 2283 2284
 * @max_scan_ie_len: maximum length of user-controlled IEs device can
 *	add to probe request frames transmitted during a scan, must not
 *	include fixed IEs like supported rates
2285 2286
 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
 *	scans
J
Johannes Berg 已提交
2287 2288 2289 2290 2291 2292 2293
 * @coverage_class: current coverage class
 * @fw_version: firmware version for ethtool reporting
 * @hw_version: hardware version for ethtool reporting
 * @max_num_pmkids: maximum number of PMKIDs supported by device
 * @privid: a pointer that drivers can use to identify if an arbitrary
 *	wiphy is theirs, e.g. in global notifiers
 * @bands: information about bands/channels supported by this device
2294 2295 2296 2297
 *
 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
 *	transmitted through nl80211, points to an array indexed by interface
 *	type
2298
 *
2299 2300 2301 2302 2303 2304 2305
 * @available_antennas_tx: bitmap of antennas which are available to be
 *	configured as TX antennas. Antenna configuration commands will be
 *	rejected unless this or @available_antennas_rx is set.
 *
 * @available_antennas_rx: bitmap of antennas which are available to be
 *	configured as RX antennas. Antenna configuration commands will be
 *	rejected unless this or @available_antennas_tx is set.
2306
 *
2307 2308 2309 2310 2311
 * @probe_resp_offload:
 *	 Bitmap of supported protocols for probe response offloading.
 *	 See &enum nl80211_probe_resp_offload_support_attr. Only valid
 *	 when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
 *
2312 2313
 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
 *	may request, if implemented.
J
Johannes Berg 已提交
2314 2315
 *
 * @wowlan: WoWLAN support information
J
Johannes Berg 已提交
2316 2317
 *
 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2318 2319
 * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
 *	If null, then none can be over-ridden.
J
Johannes Berg 已提交
2320 2321 2322 2323
 */
struct wiphy {
	/* assign these fields before you register the wiphy */

2324
	/* permanent MAC address(es) */
J
Johannes Berg 已提交
2325
	u8 perm_addr[ETH_ALEN];
2326 2327 2328
	u8 addr_mask[ETH_ALEN];

	struct mac_address *addresses;
J
Johannes Berg 已提交
2329

2330 2331
	const struct ieee80211_txrx_stypes *mgmt_stypes;

2332 2333 2334 2335
	const struct ieee80211_iface_combination *iface_combinations;
	int n_iface_combinations;
	u16 software_iftypes;

2336 2337
	u16 n_addresses;

J
Johannes Berg 已提交
2338 2339 2340
	/* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
	u16 interface_modes;

2341
	u32 flags, features;
2342

J
Johannes Berg 已提交
2343 2344
	u32 ap_sme_capa;

J
Johannes Berg 已提交
2345 2346 2347 2348
	enum cfg80211_signal_type signal_type;

	int bss_priv_size;
	u8 max_scan_ssids;
2349
	u8 max_sched_scan_ssids;
2350
	u8 max_match_sets;
J
Johannes Berg 已提交
2351
	u16 max_scan_ie_len;
2352
	u16 max_sched_scan_ie_len;
J
Johannes Berg 已提交
2353 2354 2355 2356

	int n_cipher_suites;
	const u32 *cipher_suites;

2357 2358 2359 2360
	u8 retry_short;
	u8 retry_long;
	u32 frag_threshold;
	u32 rts_threshold;
2361
	u8 coverage_class;
2362

2363 2364 2365
	char fw_version[ETHTOOL_BUSINFO_LEN];
	u32 hw_version;

2366
#ifdef CONFIG_PM
J
Johannes Berg 已提交
2367
	struct wiphy_wowlan_support wowlan;
2368
#endif
J
Johannes Berg 已提交
2369

2370 2371
	u16 max_remain_on_channel_duration;

S
Samuel Ortiz 已提交
2372 2373
	u8 max_num_pmkids;

2374 2375
	u32 available_antennas_tx;
	u32 available_antennas_rx;
2376

2377 2378 2379 2380 2381 2382 2383
	/*
	 * Bitmap of supported protocols for probe response offloading
	 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
	 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
	 */
	u32 probe_resp_offload;

J
Johannes Berg 已提交
2384 2385 2386 2387 2388
	/* If multiple wiphys are registered and you're handed e.g.
	 * a regular netdev with assigned ieee80211_ptr, you won't
	 * know whether it points to a wiphy your driver has registered
	 * or not. Assign this to something global to your driver to
	 * help determine whether you own this wiphy or not. */
2389
	const void *privid;
J
Johannes Berg 已提交
2390 2391 2392 2393

	struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];

	/* Lets us get back the wiphy on the callback */
2394 2395
	void (*reg_notifier)(struct wiphy *wiphy,
			     struct regulatory_request *request);
J
Johannes Berg 已提交
2396 2397 2398

	/* fields below are read-only, assigned by cfg80211 */

2399
	const struct ieee80211_regdomain __rcu *regd;
J
Johannes Berg 已提交
2400 2401 2402 2403 2404

	/* the item in /sys/class/ieee80211/ points to this,
	 * you need use set_wiphy_dev() (see below) */
	struct device dev;

2405 2406 2407
	/* protects ->resume, ->suspend sysfs callbacks against unregister hw */
	bool registered;

J
Johannes Berg 已提交
2408 2409 2410
	/* dir in debugfs: ieee80211/<wiphyname> */
	struct dentry *debugfsdir;

2411 2412
	const struct ieee80211_ht_cap *ht_capa_mod_mask;

2413 2414 2415 2416 2417
#ifdef CONFIG_NET_NS
	/* the network namespace this phy lives in currently */
	struct net *_net;
#endif

J
Johannes Berg 已提交
2418 2419 2420 2421
#ifdef CONFIG_CFG80211_WEXT
	const struct iw_handler_def *wext;
#endif

J
Johannes Berg 已提交
2422
	char priv[0] __aligned(NETDEV_ALIGN);
J
Johannes Berg 已提交
2423 2424
};

2425 2426
static inline struct net *wiphy_net(struct wiphy *wiphy)
{
E
Eric Dumazet 已提交
2427
	return read_pnet(&wiphy->_net);
2428 2429 2430 2431
}

static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
{
E
Eric Dumazet 已提交
2432
	write_pnet(&wiphy->_net, net);
2433 2434
}

J
Johannes Berg 已提交
2435 2436 2437 2438
/**
 * wiphy_priv - return priv from wiphy
 *
 * @wiphy: the wiphy whose priv pointer to return
2439
 * Return: The priv of @wiphy.
J
Johannes Berg 已提交
2440 2441 2442 2443 2444 2445 2446
 */
static inline void *wiphy_priv(struct wiphy *wiphy)
{
	BUG_ON(!wiphy);
	return &wiphy->priv;
}

2447 2448 2449 2450
/**
 * priv_to_wiphy - return the wiphy containing the priv
 *
 * @priv: a pointer previously returned by wiphy_priv
2451
 * Return: The wiphy of @priv.
2452 2453 2454 2455 2456 2457 2458
 */
static inline struct wiphy *priv_to_wiphy(void *priv)
{
	BUG_ON(!priv);
	return container_of(priv, struct wiphy, priv);
}

J
Johannes Berg 已提交
2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473
/**
 * set_wiphy_dev - set device pointer for wiphy
 *
 * @wiphy: The wiphy whose device to bind
 * @dev: The device to parent it to
 */
static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
{
	wiphy->dev.parent = dev;
}

/**
 * wiphy_dev - get wiphy dev pointer
 *
 * @wiphy: The wiphy whose device struct to look up
2474
 * Return: The dev of @wiphy.
J
Johannes Berg 已提交
2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
 */
static inline struct device *wiphy_dev(struct wiphy *wiphy)
{
	return wiphy->dev.parent;
}

/**
 * wiphy_name - get wiphy name
 *
 * @wiphy: The wiphy whose name to return
2485
 * Return: The name of @wiphy.
J
Johannes Berg 已提交
2486
 */
2487
static inline const char *wiphy_name(const struct wiphy *wiphy)
J
Johannes Berg 已提交
2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500
{
	return dev_name(&wiphy->dev);
}

/**
 * wiphy_new - create a new wiphy for use with cfg80211
 *
 * @ops: The configuration operations for this device
 * @sizeof_priv: The size of the private area to allocate
 *
 * Create a new wiphy and associate the given operations with it.
 * @sizeof_priv bytes are allocated for private use.
 *
2501 2502
 * Return: A pointer to the new wiphy. This pointer must be
 * assigned to each netdev's ieee80211_ptr for proper operation.
J
Johannes Berg 已提交
2503
 */
2504
struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
J
Johannes Berg 已提交
2505 2506 2507 2508 2509 2510

/**
 * wiphy_register - register a wiphy with cfg80211
 *
 * @wiphy: The wiphy to register.
 *
2511
 * Return: A non-negative wiphy index or a negative error code.
J
Johannes Berg 已提交
2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532
 */
extern int wiphy_register(struct wiphy *wiphy);

/**
 * wiphy_unregister - deregister a wiphy from cfg80211
 *
 * @wiphy: The wiphy to unregister.
 *
 * After this call, no more requests can be made with this priv
 * pointer, but the call may sleep to wait for an outstanding
 * request that is being handled.
 */
extern void wiphy_unregister(struct wiphy *wiphy);

/**
 * wiphy_free - free wiphy
 *
 * @wiphy: The wiphy to free
 */
extern void wiphy_free(struct wiphy *wiphy);

J
Johannes Berg 已提交
2533
/* internal structs */
2534
struct cfg80211_conn;
J
Johannes Berg 已提交
2535
struct cfg80211_internal_bss;
J
Johannes Berg 已提交
2536
struct cfg80211_cached_keys;
J
Johannes Berg 已提交
2537

J
Johannes Berg 已提交
2538
/**
2539
 * struct wireless_dev - wireless device state
J
Johannes Berg 已提交
2540
 *
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550
 * For netdevs, this structure must be allocated by the driver
 * that uses the ieee80211_ptr field in struct net_device (this
 * is intentional so it can be allocated along with the netdev.)
 * It need not be registered then as netdev registration will
 * be intercepted by cfg80211 to see the new wireless device.
 *
 * For non-netdev uses, it must also be allocated by the driver
 * in response to the cfg80211 callbacks that require it, as
 * there's no netdev registration in that case it may not be
 * allocated outside of callback operations that return it.
J
Johannes Berg 已提交
2551 2552 2553 2554
 *
 * @wiphy: pointer to hardware description
 * @iftype: interface type
 * @list: (private) Used to collect the interfaces
2555 2556 2557
 * @netdev: (private) Used to reference back to the netdev, may be %NULL
 * @identifier: (private) Identifier used in nl80211 to identify this
 *	wireless device if it has no netdev
J
Johannes Berg 已提交
2558
 * @current_bss: (private) Used by the internal configuration code
2559
 * @channel: (private) Used by the internal configuration code to track
2560 2561 2562 2563
 *	the user-set AP, monitor and WDS channel
 * @preset_chan: (private) Used by the internal configuration code to
 *	track the channel to be used for AP later
 * @preset_chantype: (private) the corresponding channel type
J
Johannes Berg 已提交
2564 2565 2566
 * @bssid: (private) Used by the internal configuration code
 * @ssid: (private) Used by the internal configuration code
 * @ssid_len: (private) Used by the internal configuration code
2567 2568
 * @mesh_id_len: (private) Used by the internal configuration code
 * @mesh_id_up_len: (private) Used by the internal configuration code
J
Johannes Berg 已提交
2569
 * @wext: (private) Used by the internal wireless extensions compat code
2570 2571 2572 2573
 * @use_4addr: indicates 4addr mode is used on this interface, must be
 *	set by driver (if supported) on add_interface BEFORE registering the
 *	netdev and may otherwise be used by driver read-only, will be update
 *	by cfg80211 on change_interface
2574 2575
 * @mgmt_registrations: list of registrations for management frames
 * @mgmt_registrations_lock: lock for the list
J
Johannes Berg 已提交
2576 2577
 * @mtx: mutex used to lock data in this struct
 * @cleanup_work: work struct used for cleanup that can't be done directly
2578 2579
 * @beacon_interval: beacon interval used on this device for transmitting
 *	beacons, 0 when not valid
2580 2581
 * @address: The address for this device, valid only if @netdev is %NULL
 * @p2p_started: true if this is a P2P Device that has been started
J
Johannes Berg 已提交
2582 2583 2584 2585 2586
 */
struct wireless_dev {
	struct wiphy *wiphy;
	enum nl80211_iftype iftype;

J
Johannes Berg 已提交
2587
	/* the remainder of this struct should be private to cfg80211 */
J
Johannes Berg 已提交
2588 2589 2590
	struct list_head list;
	struct net_device *netdev;

2591 2592
	u32 identifier;

2593 2594
	struct list_head mgmt_registrations;
	spinlock_t mgmt_registrations_lock;
2595

J
Johannes Berg 已提交
2596 2597
	struct mutex mtx;

2598 2599
	struct work_struct cleanup_work;

2600 2601 2602
	bool use_4addr, p2p_started;

	u8 address[ETH_ALEN] __aligned(sizeof(u16));
2603

S
Samuel Ortiz 已提交
2604
	/* currently used for IBSS and SME - might be rearranged later */
J
Johannes Berg 已提交
2605
	u8 ssid[IEEE80211_MAX_SSID_LEN];
2606
	u8 ssid_len, mesh_id_len, mesh_id_up_len;
S
Samuel Ortiz 已提交
2607 2608
	enum {
		CFG80211_SME_IDLE,
2609
		CFG80211_SME_CONNECTING,
S
Samuel Ortiz 已提交
2610 2611
		CFG80211_SME_CONNECTED,
	} sme_state;
2612
	struct cfg80211_conn *conn;
J
Johannes Berg 已提交
2613
	struct cfg80211_cached_keys *connect_keys;
J
Johannes Berg 已提交
2614

J
Johannes Berg 已提交
2615 2616 2617
	struct list_head event_list;
	spinlock_t event_lock;

J
Johannes Berg 已提交
2618
	struct cfg80211_internal_bss *current_bss; /* associated / joined */
2619
	struct cfg80211_chan_def preset_chandef;
J
Johannes Berg 已提交
2620

2621 2622 2623
	/* for AP and mesh channel tracking */
	struct ieee80211_channel *channel;

2624 2625
	bool ibss_fixed;

K
Kalle Valo 已提交
2626 2627 2628
	bool ps;
	int ps_timeout;

2629 2630
	int beacon_interval;

2631
	u32 ap_unexpected_nlportid;
2632

J
Johannes Berg 已提交
2633
#ifdef CONFIG_CFG80211_WEXT
J
Johannes Berg 已提交
2634
	/* wext data */
2635
	struct {
2636 2637
		struct cfg80211_ibss_params ibss;
		struct cfg80211_connect_params connect;
J
Johannes Berg 已提交
2638
		struct cfg80211_cached_keys *keys;
2639 2640
		u8 *ie;
		size_t ie_len;
2641
		u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2642
		u8 ssid[IEEE80211_MAX_SSID_LEN];
2643
		s8 default_key, default_mgmt_key;
K
Kalle Valo 已提交
2644
		bool prev_bssid_valid;
2645
	} wext;
J
Johannes Berg 已提交
2646 2647 2648
#endif
};

2649 2650 2651 2652 2653 2654 2655
static inline u8 *wdev_address(struct wireless_dev *wdev)
{
	if (wdev->netdev)
		return wdev->netdev->dev_addr;
	return wdev->address;
}

J
Johannes Berg 已提交
2656 2657 2658 2659
/**
 * wdev_priv - return wiphy priv from wireless_dev
 *
 * @wdev: The wireless device whose wiphy's priv pointer to return
2660
 * Return: The wiphy priv of @wdev.
J
Johannes Berg 已提交
2661 2662 2663 2664 2665 2666 2667
 */
static inline void *wdev_priv(struct wireless_dev *wdev)
{
	BUG_ON(!wdev);
	return wiphy_priv(wdev->wiphy);
}

J
Johannes Berg 已提交
2668 2669 2670 2671
/**
 * DOC: Utility functions
 *
 * cfg80211 offers a number of utility functions that can be useful.
J
Johannes Berg 已提交
2672 2673 2674 2675
 */

/**
 * ieee80211_channel_to_frequency - convert channel number to frequency
J
Johannes Berg 已提交
2676
 * @chan: channel number
2677
 * @band: band, necessary due to channel number overlap
2678
 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
J
Johannes Berg 已提交
2679
 */
2680
extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
J
Johannes Berg 已提交
2681 2682 2683

/**
 * ieee80211_frequency_to_channel - convert frequency to channel number
J
Johannes Berg 已提交
2684
 * @freq: center frequency
2685
 * Return: The corresponding channel, or 0 if the conversion failed.
J
Johannes Berg 已提交
2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699
 */
extern int ieee80211_frequency_to_channel(int freq);

/*
 * Name indirection necessary because the ieee80211 code also has
 * a function named "ieee80211_get_channel", so if you include
 * cfg80211's header file you get cfg80211's version, if you try
 * to include both header files you'll (rightfully!) get a symbol
 * clash.
 */
extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
							 int freq);
/**
 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
J
Johannes Berg 已提交
2700 2701
 * @wiphy: the struct wiphy to get the channel for
 * @freq: the center frequency of the channel
2702
 * Return: The channel struct from @wiphy at @freq.
J
Johannes Berg 已提交
2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716
 */
static inline struct ieee80211_channel *
ieee80211_get_channel(struct wiphy *wiphy, int freq)
{
	return __ieee80211_get_channel(wiphy, freq);
}

/**
 * ieee80211_get_response_rate - get basic rate for a given rate
 *
 * @sband: the band to look for rates in
 * @basic_rates: bitmap of basic rates
 * @bitrate: the bitrate for which to find the basic rate
 *
2717 2718 2719 2720
 * Return: The basic rate corresponding to a given bitrate, that
 * is the next lower bitrate contained in the basic rate map,
 * which is, for this function, given as a bitmap of indices of
 * rates in the band's bitrate table.
J
Johannes Berg 已提交
2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732
 */
struct ieee80211_rate *
ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
			    u32 basic_rates, int bitrate);

/*
 * Radiotap parsing functions -- for controlled injection support
 *
 * Implemented in net/wireless/radiotap.c
 * Documentation in Documentation/networking/radiotap-headers.txt
 */

J
Johannes Berg 已提交
2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748
struct radiotap_align_size {
	uint8_t align:4, size:4;
};

struct ieee80211_radiotap_namespace {
	const struct radiotap_align_size *align_size;
	int n_bits;
	uint32_t oui;
	uint8_t subns;
};

struct ieee80211_radiotap_vendor_namespaces {
	const struct ieee80211_radiotap_namespace *ns;
	int n_ns;
};

J
Johannes Berg 已提交
2749 2750
/**
 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
J
Johannes Berg 已提交
2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775
 * @this_arg_index: index of current arg, valid after each successful call
 *	to ieee80211_radiotap_iterator_next()
 * @this_arg: pointer to current radiotap arg; it is valid after each
 *	call to ieee80211_radiotap_iterator_next() but also after
 *	ieee80211_radiotap_iterator_init() where it will point to
 *	the beginning of the actual data portion
 * @this_arg_size: length of the current arg, for convenience
 * @current_namespace: pointer to the current namespace definition
 *	(or internally %NULL if the current namespace is unknown)
 * @is_radiotap_ns: indicates whether the current namespace is the default
 *	radiotap namespace or not
 *
 * @_rtheader: pointer to the radiotap header we are walking through
 * @_max_length: length of radiotap header in cpu byte ordering
 * @_arg_index: next argument index
 * @_arg: next argument pointer
 * @_next_bitmap: internal pointer to next present u32
 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
 * @_vns: vendor namespace definitions
 * @_next_ns_data: beginning of the next namespace's data
 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
 *	next bitmap word
 *
 * Describes the radiotap parser state. Fields prefixed with an underscore
 * must not be used by users of the parser, only by the parser internally.
J
Johannes Berg 已提交
2776 2777 2778
 */

struct ieee80211_radiotap_iterator {
J
Johannes Berg 已提交
2779 2780 2781 2782 2783
	struct ieee80211_radiotap_header *_rtheader;
	const struct ieee80211_radiotap_vendor_namespaces *_vns;
	const struct ieee80211_radiotap_namespace *current_namespace;

	unsigned char *_arg, *_next_ns_data;
2784
	__le32 *_next_bitmap;
J
Johannes Berg 已提交
2785 2786

	unsigned char *this_arg;
J
Johannes Berg 已提交
2787
	int this_arg_index;
J
Johannes Berg 已提交
2788
	int this_arg_size;
J
Johannes Berg 已提交
2789

J
Johannes Berg 已提交
2790 2791 2792 2793 2794 2795
	int is_radiotap_ns;

	int _max_length;
	int _arg_index;
	uint32_t _bitmap_shifter;
	int _reset_on_ext;
J
Johannes Berg 已提交
2796 2797 2798
};

extern int ieee80211_radiotap_iterator_init(
J
Johannes Berg 已提交
2799 2800 2801
	struct ieee80211_radiotap_iterator *iterator,
	struct ieee80211_radiotap_header *radiotap_header,
	int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
J
Johannes Berg 已提交
2802 2803

extern int ieee80211_radiotap_iterator_next(
J
Johannes Berg 已提交
2804 2805
	struct ieee80211_radiotap_iterator *iterator);

J
Johannes Berg 已提交
2806

2807 2808 2809 2810 2811 2812
extern const unsigned char rfc1042_header[6];
extern const unsigned char bridge_tunnel_header[6];

/**
 * ieee80211_get_hdrlen_from_skb - get header length from data
 *
2813 2814
 * @skb: the frame
 *
2815
 * Given an skb with a raw 802.11 header at the data pointer this function
2816
 * returns the 802.11 header length.
2817
 *
2818 2819 2820
 * Return: The 802.11 header length in bytes (not including encryption
 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
 * 802.11 header.
2821 2822 2823 2824 2825 2826
 */
unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);

/**
 * ieee80211_hdrlen - get header length in bytes from frame control
 * @fc: frame control field in little-endian format
2827
 * Return: The header length in bytes.
2828
 */
2829
unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2830

2831 2832 2833 2834
/**
 * ieee80211_get_mesh_hdrlen - get mesh extension header length
 * @meshhdr: the mesh extension header, only the flags field
 *	(first byte) will be accessed
2835
 * Return: The length of the extension header, which is always at
2836 2837 2838 2839
 * least 6 bytes and at most 18 if address 5 and 6 are present.
 */
unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);

J
Johannes Berg 已提交
2840 2841 2842 2843 2844 2845 2846 2847
/**
 * DOC: Data path helpers
 *
 * In addition to generic utilities, cfg80211 also offers
 * functions that help implement the data path for devices
 * that do not do the 802.11/802.3 conversion on the device.
 */

2848 2849 2850 2851 2852
/**
 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
 * @skb: the 802.11 data frame
 * @addr: the device MAC address
 * @iftype: the virtual interface type
2853
 * Return: 0 on success. Non-zero on error.
2854
 */
Z
Zhu Yi 已提交
2855
int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2856 2857 2858 2859 2860 2861 2862 2863 2864
			   enum nl80211_iftype iftype);

/**
 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
 * @skb: the 802.3 frame
 * @addr: the device MAC address
 * @iftype: the virtual interface type
 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
 * @qos: build 802.11 QoS data frame
2865
 * Return: 0 on success, or a negative error code.
2866
 */
Z
Zhu Yi 已提交
2867
int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2868 2869
			     enum nl80211_iftype iftype, u8 *bssid, bool qos);

Z
Zhu Yi 已提交
2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882
/**
 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
 *
 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
 * 802.3 frames. The @list will be empty if the decode fails. The
 * @skb is consumed after the function returns.
 *
 * @skb: The input IEEE 802.11n A-MSDU frame.
 * @list: The output list of 802.3 frames. It must be allocated and
 *	initialized by by the caller.
 * @addr: The device MAC address.
 * @iftype: The device interface type.
 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2883
 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
Z
Zhu Yi 已提交
2884 2885 2886
 */
void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
			      const u8 *addr, enum nl80211_iftype iftype,
2887 2888
			      const unsigned int extra_headroom,
			      bool has_80211_header);
Z
Zhu Yi 已提交
2889

2890 2891 2892
/**
 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
 * @skb: the data frame
2893
 * Return: The 802.1p/1d tag.
2894 2895 2896
 */
unsigned int cfg80211_classify8021d(struct sk_buff *skb);

2897 2898 2899 2900 2901 2902 2903
/**
 * cfg80211_find_ie - find information element in data
 *
 * @eid: element ID
 * @ies: data consisting of IEs
 * @len: length of data
 *
2904 2905 2906 2907 2908 2909 2910
 * Return: %NULL if the element ID could not be found or if
 * the element is invalid (claims to be longer than the given
 * data), or a pointer to the first byte of the requested
 * element, that is the byte containing the element ID.
 *
 * Note: There are no checks on the element length other than
 * having to fit into the given data.
2911 2912 2913
 */
const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);

2914 2915 2916 2917 2918 2919 2920 2921
/**
 * cfg80211_find_vendor_ie - find vendor specific information element in data
 *
 * @oui: vendor OUI
 * @oui_type: vendor-specific OUI type
 * @ies: data consisting of IEs
 * @len: length of data
 *
2922 2923 2924 2925 2926 2927 2928
 * Return: %NULL if the vendor specific element ID could not be found or if the
 * element is invalid (claims to be longer than the given data), or a pointer to
 * the first byte of the requested element, that is the byte containing the
 * element ID.
 *
 * Note: There are no checks on the element length other than having to fit into
 * the given data.
2929 2930 2931 2932
 */
const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
				  const u8 *ies, int len);

J
Johannes Berg 已提交
2933 2934 2935 2936
/**
 * DOC: Regulatory enforcement infrastructure
 *
 * TODO
J
Johannes Berg 已提交
2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960
 */

/**
 * regulatory_hint - driver hint to the wireless core a regulatory domain
 * @wiphy: the wireless device giving the hint (used only for reporting
 *	conflicts)
 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
 * 	should be in. If @rd is set this should be NULL. Note that if you
 * 	set this to NULL you should still set rd->alpha2 to some accepted
 * 	alpha2.
 *
 * Wireless drivers can use this function to hint to the wireless core
 * what it believes should be the current regulatory domain by
 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
 * domain should be in or by providing a completely build regulatory domain.
 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
 * for a regulatory domain structure for the respective country.
 *
 * The wiphy must have been registered to cfg80211 prior to this call.
 * For cfg80211 drivers this means you must first use wiphy_register(),
 * for mac80211 drivers you must first use ieee80211_register_hw().
 *
 * Drivers should check the return value, its possible you can get
 * an -ENOMEM.
2961 2962
 *
 * Return: 0 on success. -ENOMEM.
J
Johannes Berg 已提交
2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991
 */
extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);

/**
 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
 * @wiphy: the wireless device we want to process the regulatory domain on
 * @regd: the custom regulatory domain to use for this wiphy
 *
 * Drivers can sometimes have custom regulatory domains which do not apply
 * to a specific country. Drivers can use this to apply such custom regulatory
 * domains. This routine must be called prior to wiphy registration. The
 * custom regulatory domain will be trusted completely and as such previous
 * default channel settings will be disregarded. If no rule is found for a
 * channel on the regulatory domain the channel will be disabled.
 */
extern void wiphy_apply_custom_regulatory(
	struct wiphy *wiphy,
	const struct ieee80211_regdomain *regd);

/**
 * freq_reg_info - get regulatory information for the given frequency
 * @wiphy: the wiphy for which we want to process this rule for
 * @center_freq: Frequency in KHz for which we want regulatory information for
 *
 * Use this function to get the regulatory rule for a specific frequency on
 * a given wireless device. If the device has a specific regulatory domain
 * it wants to follow we respect that unless a country IE has been received
 * and processed already.
 *
2992 2993 2994 2995 2996 2997 2998
 * Return: A valid pointer, or, when an error occurs, for example if no rule
 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
 * check and PTR_ERR() to obtain the numeric return value. The numeric return
 * value will be -ERANGE if we determine the given center_freq does not even
 * have a regulatory rule for a frequency range in the center_freq's band.
 * See freq_in_rule_band() for our current definition of a band -- this is
 * purely subjective and right now it's 802.11 specific.
J
Johannes Berg 已提交
2999
 */
3000 3001
const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
					       u32 center_freq);
J
Johannes Berg 已提交
3002 3003 3004 3005 3006 3007

/*
 * callbacks for asynchronous cfg80211 methods, notification
 * functions and BSS handling helpers
 */

3008 3009 3010 3011 3012 3013 3014 3015 3016
/**
 * cfg80211_scan_done - notify that scan finished
 *
 * @request: the corresponding scan request
 * @aborted: set to true if the scan was aborted for any reason,
 *	userspace will be notified of that
 */
void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);

3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034
/**
 * cfg80211_sched_scan_results - notify that new scan results are available
 *
 * @wiphy: the wiphy which got scheduled scan results
 */
void cfg80211_sched_scan_results(struct wiphy *wiphy);

/**
 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
 *
 * @wiphy: the wiphy on which the scheduled scan stopped
 *
 * The driver can call this function to inform cfg80211 that the
 * scheduled scan had to be stopped, for whatever reason.  The driver
 * is then called back via the sched_scan_stop operation when done.
 */
void cfg80211_sched_scan_stopped(struct wiphy *wiphy);

3035
/**
J
Johannes Berg 已提交
3036
 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
3037 3038
 *
 * @wiphy: the wiphy reporting the BSS
J
Johannes Berg 已提交
3039 3040 3041
 * @channel: The channel the frame was received on
 * @mgmt: the management frame (probe response or beacon)
 * @len: length of the management frame
J
Johannes Berg 已提交
3042
 * @signal: the signal strength, type depends on the wiphy's signal_type
3043 3044 3045 3046
 * @gfp: context flags
 *
 * This informs cfg80211 that BSS information was found and
 * the BSS should be updated/added.
3047
 *
3048 3049
 * Return: A referenced struct, must be released with cfg80211_put_bss()!
 * Or %NULL on error.
3050
 */
3051
struct cfg80211_bss * __must_check
3052 3053 3054
cfg80211_inform_bss_frame(struct wiphy *wiphy,
			  struct ieee80211_channel *channel,
			  struct ieee80211_mgmt *mgmt, size_t len,
J
Johannes Berg 已提交
3055
			  s32 signal, gfp_t gfp);
3056

J
Johannes Berg 已提交
3057 3058 3059 3060 3061 3062
/**
 * cfg80211_inform_bss - inform cfg80211 of a new BSS
 *
 * @wiphy: the wiphy reporting the BSS
 * @channel: The channel the frame was received on
 * @bssid: the BSSID of the BSS
3063
 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
J
Johannes Berg 已提交
3064 3065 3066 3067 3068 3069 3070 3071 3072
 * @capability: the capability field sent by the peer
 * @beacon_interval: the beacon interval announced by the peer
 * @ie: additional IEs sent by the peer
 * @ielen: length of the additional IEs
 * @signal: the signal strength, type depends on the wiphy's signal_type
 * @gfp: context flags
 *
 * This informs cfg80211 that BSS information was found and
 * the BSS should be updated/added.
3073
 *
3074 3075
 * Return: A referenced struct, must be released with cfg80211_put_bss()!
 * Or %NULL on error.
J
Johannes Berg 已提交
3076
 */
3077
struct cfg80211_bss * __must_check
3078 3079
cfg80211_inform_bss(struct wiphy *wiphy,
		    struct ieee80211_channel *channel,
3080 3081
		    const u8 *bssid, u64 tsf, u16 capability,
		    u16 beacon_interval, const u8 *ie, size_t ielen,
3082 3083
		    s32 signal, gfp_t gfp);

3084 3085 3086
struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
				      struct ieee80211_channel *channel,
				      const u8 *bssid,
3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097
				      const u8 *ssid, size_t ssid_len,
				      u16 capa_mask, u16 capa_val);
static inline struct cfg80211_bss *
cfg80211_get_ibss(struct wiphy *wiphy,
		  struct ieee80211_channel *channel,
		  const u8 *ssid, size_t ssid_len)
{
	return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
				WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
}

3098 3099 3100 3101
struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
				       struct ieee80211_channel *channel,
				       const u8 *meshid, size_t meshidlen,
				       const u8 *meshcfg);
3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115
/**
 * cfg80211_ref_bss - reference BSS struct
 * @bss: the BSS struct to reference
 *
 * Increments the refcount of the given BSS struct.
 */
void cfg80211_ref_bss(struct cfg80211_bss *bss);

/**
 * cfg80211_put_bss - unref BSS struct
 * @bss: the BSS struct
 *
 * Decrements the refcount of the given BSS struct.
 */
3116
void cfg80211_put_bss(struct cfg80211_bss *bss);
J
Johannes Berg 已提交
3117

3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128
/**
 * cfg80211_unlink_bss - unlink BSS from internal data structures
 * @wiphy: the wiphy
 * @bss: the bss to remove
 *
 * This function removes the given BSS from the internal data structures
 * thereby making it no longer show up in scan results etc. Use this
 * function when you detect a BSS is gone. Normally BSSes will also time
 * out, so it is not necessary to use this function at all.
 */
void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
J
Johannes Berg 已提交
3129

3130 3131 3132 3133 3134 3135 3136
/**
 * cfg80211_send_rx_auth - notification of processed authentication
 * @dev: network device
 * @buf: authentication frame (header + body)
 * @len: length of the frame data
 *
 * This function is called whenever an authentication has been processed in
3137 3138
 * station mode. The driver is required to call either this function or
 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
3139
 * call. This function may sleep.
3140
 */
3141
void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
3142

3143 3144 3145 3146
/**
 * cfg80211_send_auth_timeout - notification of timed out authentication
 * @dev: network device
 * @addr: The MAC address of the device with which the authentication timed out
3147 3148
 *
 * This function may sleep.
3149
 */
3150
void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
3151

3152 3153 3154
/**
 * cfg80211_send_rx_assoc - notification of processed association
 * @dev: network device
3155 3156
 * @bss: the BSS struct association was requested for, the struct reference
 *	is owned by cfg80211 after this call
3157 3158 3159 3160
 * @buf: (re)association response frame (header + body)
 * @len: length of the frame data
 *
 * This function is called whenever a (re)association response has been
3161 3162
 * processed in station mode. The driver is required to call either this
 * function or cfg80211_send_assoc_timeout() to indicate the result of
3163
 * cfg80211_ops::assoc() call. This function may sleep.
3164
 */
3165 3166
void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
			    const u8 *buf, size_t len);
3167

3168 3169 3170 3171
/**
 * cfg80211_send_assoc_timeout - notification of timed out association
 * @dev: network device
 * @addr: The MAC address of the device with which the association timed out
3172 3173
 *
 * This function may sleep.
3174
 */
3175
void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
3176

3177
/**
3178
 * cfg80211_send_deauth - notification of processed deauthentication
3179 3180 3181 3182 3183
 * @dev: network device
 * @buf: deauthentication frame (header + body)
 * @len: length of the frame data
 *
 * This function is called whenever deauthentication has been processed in
3184
 * station mode. This includes both received deauthentication frames and
3185
 * locally generated ones. This function may sleep.
3186
 */
3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197
void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);

/**
 * __cfg80211_send_deauth - notification of processed deauthentication
 * @dev: network device
 * @buf: deauthentication frame (header + body)
 * @len: length of the frame data
 *
 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
 */
void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3198 3199

/**
3200
 * cfg80211_send_disassoc - notification of processed disassociation
3201 3202 3203 3204 3205
 * @dev: network device
 * @buf: disassociation response frame (header + body)
 * @len: length of the frame data
 *
 * This function is called whenever disassociation has been processed in
3206
 * station mode. This includes both received disassociation frames and locally
3207
 * generated ones. This function may sleep.
3208
 */
3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220
void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);

/**
 * __cfg80211_send_disassoc - notification of processed disassociation
 * @dev: network device
 * @buf: disassociation response frame (header + body)
 * @len: length of the frame data
 *
 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
 */
void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
	size_t len);
3221

3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247
/**
 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
 * @dev: network device
 * @buf: deauthentication frame (header + body)
 * @len: length of the frame data
 *
 * This function is called whenever a received Deauthentication frame has been
 * dropped in station mode because of MFP being used but the Deauthentication
 * frame was not protected. This function may sleep.
 */
void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
				 size_t len);

/**
 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
 * @dev: network device
 * @buf: disassociation frame (header + body)
 * @len: length of the frame data
 *
 * This function is called whenever a received Disassociation frame has been
 * dropped in station mode because of MFP being used but the Disassociation
 * frame was not protected. This function may sleep.
 */
void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
				   size_t len);

3248 3249 3250 3251 3252
/**
 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
 * @dev: network device
 * @addr: The source MAC address of the frame
 * @key_type: The key type that the received frame used
3253
 * @key_id: Key identifier (0..3). Can be -1 if missing.
3254
 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3255
 * @gfp: allocation flags
3256 3257 3258 3259 3260 3261 3262
 *
 * This function is called whenever the local MAC detects a MIC failure in a
 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
 * primitive.
 */
void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
				  enum nl80211_key_type key_type, int key_id,
3263
				  const u8 *tsc, gfp_t gfp);
3264

J
Johannes Berg 已提交
3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280
/**
 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
 *
 * @dev: network device
 * @bssid: the BSSID of the IBSS joined
 * @gfp: allocation flags
 *
 * This function notifies cfg80211 that the device joined an IBSS or
 * switched to a different BSSID. Before this function can be called,
 * either a beacon has to have been received from the IBSS, or one of
 * the cfg80211_inform_bss{,_frame} functions must have been called
 * with the locally generated beacon -- this guarantees that there is
 * always a scan result for this IBSS. cfg80211 will handle the rest.
 */
void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);

3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296
/**
 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
 *
 * @dev: network device
 * @macaddr: the MAC address of the new candidate
 * @ie: information elements advertised by the peer candidate
 * @ie_len: lenght of the information elements buffer
 * @gfp: allocation flags
 *
 * This function notifies cfg80211 that the mesh peer candidate has been
 * detected, most likely via a beacon or, less likely, via a probe response.
 * cfg80211 then sends a notification to userspace.
 */
void cfg80211_notify_new_peer_candidate(struct net_device *dev,
		const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);

J
Johannes Berg 已提交
3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310
/**
 * DOC: RFkill integration
 *
 * RFkill integration in cfg80211 is almost invisible to drivers,
 * as cfg80211 automatically registers an rfkill instance for each
 * wireless device it knows about. Soft kill is also translated
 * into disconnecting and turning all interfaces off, drivers are
 * expected to turn off the device when all interfaces are down.
 *
 * However, devices may have a hard RFkill line, in which case they
 * also need to interact with the rfkill subsystem, via cfg80211.
 * They can do this with a few helper functions documented here.
 */

J
Johannes Berg 已提交
3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329
/**
 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
 * @wiphy: the wiphy
 * @blocked: block status
 */
void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);

/**
 * wiphy_rfkill_start_polling - start polling rfkill
 * @wiphy: the wiphy
 */
void wiphy_rfkill_start_polling(struct wiphy *wiphy);

/**
 * wiphy_rfkill_stop_polling - stop polling rfkill
 * @wiphy: the wiphy
 */
void wiphy_rfkill_stop_polling(struct wiphy *wiphy);

3330
#ifdef CONFIG_NL80211_TESTMODE
J
Johannes Berg 已提交
3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341
/**
 * DOC: Test mode
 *
 * Test mode is a set of utility functions to allow drivers to
 * interact with driver-specific tools to aid, for instance,
 * factory programming.
 *
 * This chapter describes how drivers interact with it, for more
 * information see the nl80211 book's chapter on it.
 */

3342 3343 3344 3345 3346 3347 3348 3349 3350 3351
/**
 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
 * @wiphy: the wiphy
 * @approxlen: an upper bound of the length of the data that will
 *	be put into the skb
 *
 * This function allocates and pre-fills an skb for a reply to
 * the testmode command. Since it is intended for a reply, calling
 * it outside of the @testmode_cmd operation is invalid.
 *
3352 3353 3354 3355 3356 3357 3358
 * The returned skb is pre-filled with the wiphy index and set up in
 * a way that any data that is put into the skb (with skb_put(),
 * nla_put() or similar) will end up being within the
 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
 * with the skb is adding data for the corresponding userspace tool
 * which can then read that data out of the testdata attribute. You
 * must not modify the skb in any other way.
3359 3360 3361
 *
 * When done, call cfg80211_testmode_reply() with the skb and return
 * its error code as the result of the @testmode_cmd operation.
3362 3363
 *
 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3364 3365 3366 3367 3368 3369 3370 3371 3372
 */
struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
						  int approxlen);

/**
 * cfg80211_testmode_reply - send the reply skb
 * @skb: The skb, must have been allocated with
 *	cfg80211_testmode_alloc_reply_skb()
 *
3373 3374 3375 3376 3377 3378
 * Since calling this function will usually be the last thing
 * before returning from the @testmode_cmd you should return
 * the error code.  Note that this function consumes the skb
 * regardless of the return value.
 *
 * Return: An error code or 0 on success.
3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391
 */
int cfg80211_testmode_reply(struct sk_buff *skb);

/**
 * cfg80211_testmode_alloc_event_skb - allocate testmode event
 * @wiphy: the wiphy
 * @approxlen: an upper bound of the length of the data that will
 *	be put into the skb
 * @gfp: allocation flags
 *
 * This function allocates and pre-fills an skb for an event on the
 * testmode multicast group.
 *
3392 3393 3394 3395 3396
 * The returned skb is set up in the same way as with
 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
 * there, you should simply add data to it that will then end up in the
 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
 * in any other way.
3397 3398 3399
 *
 * When done filling the skb, call cfg80211_testmode_event() with the
 * skb to send the event.
3400 3401
 *
 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418
 */
struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
						  int approxlen, gfp_t gfp);

/**
 * cfg80211_testmode_event - send the event
 * @skb: The skb, must have been allocated with
 *	cfg80211_testmode_alloc_event_skb()
 * @gfp: allocation flags
 *
 * This function sends the given @skb, which must have been allocated
 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
 * consumes it.
 */
void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);

#define CFG80211_TESTMODE_CMD(cmd)	.testmode_cmd = (cmd),
W
Wey-Yi Guy 已提交
3419
#define CFG80211_TESTMODE_DUMP(cmd)	.testmode_dump = (cmd),
3420 3421
#else
#define CFG80211_TESTMODE_CMD(cmd)
W
Wey-Yi Guy 已提交
3422
#define CFG80211_TESTMODE_DUMP(cmd)
3423 3424
#endif

S
Samuel Ortiz 已提交
3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450
/**
 * cfg80211_connect_result - notify cfg80211 of connection result
 *
 * @dev: network device
 * @bssid: the BSSID of the AP
 * @req_ie: association request IEs (maybe be %NULL)
 * @req_ie_len: association request IEs length
 * @resp_ie: association response IEs (may be %NULL)
 * @resp_ie_len: assoc response IEs length
 * @status: status code, 0 for successful connection, use
 *	%WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
 *	the real status code for failures.
 * @gfp: allocation flags
 *
 * It should be called by the underlying driver whenever connect() has
 * succeeded.
 */
void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
			     const u8 *req_ie, size_t req_ie_len,
			     const u8 *resp_ie, size_t resp_ie_len,
			     u16 status, gfp_t gfp);

/**
 * cfg80211_roamed - notify cfg80211 of roaming
 *
 * @dev: network device
3451
 * @channel: the channel of the new AP
S
Samuel Ortiz 已提交
3452 3453 3454 3455 3456 3457 3458 3459 3460 3461
 * @bssid: the BSSID of the new AP
 * @req_ie: association request IEs (maybe be %NULL)
 * @req_ie_len: association request IEs length
 * @resp_ie: association response IEs (may be %NULL)
 * @resp_ie_len: assoc response IEs length
 * @gfp: allocation flags
 *
 * It should be called by the underlying driver whenever it roamed
 * from one AP to another while connected.
 */
3462 3463 3464
void cfg80211_roamed(struct net_device *dev,
		     struct ieee80211_channel *channel,
		     const u8 *bssid,
S
Samuel Ortiz 已提交
3465 3466 3467
		     const u8 *req_ie, size_t req_ie_len,
		     const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);

3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493
/**
 * cfg80211_roamed_bss - notify cfg80211 of roaming
 *
 * @dev: network device
 * @bss: entry of bss to which STA got roamed
 * @req_ie: association request IEs (maybe be %NULL)
 * @req_ie_len: association request IEs length
 * @resp_ie: association response IEs (may be %NULL)
 * @resp_ie_len: assoc response IEs length
 * @gfp: allocation flags
 *
 * This is just a wrapper to notify cfg80211 of roaming event with driver
 * passing bss to avoid a race in timeout of the bss entry. It should be
 * called by the underlying driver whenever it roamed from one AP to another
 * while connected. Drivers which have roaming implemented in firmware
 * may use this function to avoid a race in bss entry timeout where the bss
 * entry of the new AP is seen in the driver, but gets timed out by the time
 * it is accessed in __cfg80211_roamed() due to delay in scheduling
 * rdev->event_work. In case of any failures, the reference is released
 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
 * it will be released while diconneting from the current bss.
 */
void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
			 const u8 *req_ie, size_t req_ie_len,
			 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);

S
Samuel Ortiz 已提交
3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508
/**
 * cfg80211_disconnected - notify cfg80211 that connection was dropped
 *
 * @dev: network device
 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
 * @ie_len: length of IEs
 * @reason: reason code for the disconnection, set it to 0 if unknown
 * @gfp: allocation flags
 *
 * After it calls this function, the driver should enter an idle state
 * and not try to connect to any AP any more.
 */
void cfg80211_disconnected(struct net_device *dev, u16 reason,
			   u8 *ie, size_t ie_len, gfp_t gfp);

3509 3510
/**
 * cfg80211_ready_on_channel - notification of remain_on_channel start
3511
 * @wdev: wireless device
3512 3513 3514 3515 3516 3517
 * @cookie: the request cookie
 * @chan: The current channel (from remain_on_channel request)
 * @duration: Duration in milliseconds that the driver intents to remain on the
 *	channel
 * @gfp: allocation flags
 */
3518
void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
3519 3520 3521 3522 3523
			       struct ieee80211_channel *chan,
			       unsigned int duration, gfp_t gfp);

/**
 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3524
 * @wdev: wireless device
3525 3526 3527 3528
 * @cookie: the request cookie
 * @chan: The current channel (from remain_on_channel request)
 * @gfp: allocation flags
 */
3529
void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
3530 3531
					struct ieee80211_channel *chan,
					gfp_t gfp);
S
Samuel Ortiz 已提交
3532

3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544

/**
 * cfg80211_new_sta - notify userspace about station
 *
 * @dev: the netdev
 * @mac_addr: the station's address
 * @sinfo: the station information
 * @gfp: allocation flags
 */
void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
		      struct station_info *sinfo, gfp_t gfp);

3545 3546 3547 3548 3549 3550 3551 3552 3553
/**
 * cfg80211_del_sta - notify userspace about deletion of a station
 *
 * @dev: the netdev
 * @mac_addr: the station's address
 * @gfp: allocation flags
 */
void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);

3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
/**
 * cfg80211_conn_failed - connection request failed notification
 *
 * @dev: the netdev
 * @mac_addr: the station's address
 * @reason: the reason for connection failure
 * @gfp: allocation flags
 *
 * Whenever a station tries to connect to an AP and if the station
 * could not connect to the AP as the AP has rejected the connection
 * for some reasons, this function is called.
 *
 * The reason for connection failure can be any of the value from
 * nl80211_connect_failed_reason enum
 */
void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
			  enum nl80211_connect_failed_reason reason,
			  gfp_t gfp);

3573
/**
3574
 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3575
 * @wdev: wireless device receiving the frame
3576
 * @freq: Frequency on which the frame was received in MHz
3577
 * @sig_dbm: signal strength in mBm, or 0 if unknown
3578
 * @buf: Management frame (header + body)
3579 3580
 * @len: length of the frame data
 * @gfp: context flags
3581
 *
3582 3583 3584 3585
 * This function is called whenever an Action frame is received for a station
 * mode interface, but is not processed in kernel.
 *
 * Return: %true if a user space application has registered for this frame.
3586 3587 3588
 * For action frames, that makes it responsible for rejecting unrecognized
 * action frames; %false otherwise, in which case for action frames the
 * driver is responsible for rejecting the frame.
3589
 */
3590
bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
3591
		      const u8 *buf, size_t len, gfp_t gfp);
3592 3593

/**
3594
 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3595
 * @wdev: wireless device receiving the frame
3596 3597
 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
 * @buf: Management frame (header + body)
3598 3599 3600 3601
 * @len: length of the frame data
 * @ack: Whether frame was acknowledged
 * @gfp: context flags
 *
3602 3603
 * This function is called whenever a management frame was requested to be
 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3604 3605
 * transmission attempt.
 */
3606
void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
3607
			     const u8 *buf, size_t len, bool ack, gfp_t gfp);
3608

3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622

/**
 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
 * @dev: network device
 * @rssi_event: the triggered RSSI event
 * @gfp: context flags
 *
 * This function is called when a configured connection quality monitoring
 * rssi threshold reached event occurs.
 */
void cfg80211_cqm_rssi_notify(struct net_device *dev,
			      enum nl80211_cqm_rssi_threshold_event rssi_event,
			      gfp_t gfp);

3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634
/**
 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
 * @dev: network device
 * @peer: peer's MAC address
 * @num_packets: how many packets were lost -- should be a fixed threshold
 *	but probably no less than maybe 50, or maybe a throughput dependent
 *	threshold (to account for temporary interference)
 * @gfp: context flags
 */
void cfg80211_cqm_pktloss_notify(struct net_device *dev,
				 const u8 *peer, u32 num_packets, gfp_t gfp);

3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649
/**
 * cfg80211_cqm_txe_notify - TX error rate event
 * @dev: network device
 * @peer: peer's MAC address
 * @num_packets: how many packets were lost
 * @rate: % of packets which failed transmission
 * @intvl: interval (in s) over which the TX failure threshold was breached.
 * @gfp: context flags
 *
 * Notify userspace when configured % TX failures over number of packets in a
 * given interval is exceeded.
 */
void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
			     u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);

3650 3651 3652 3653 3654
/**
 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
 * @dev: network device
 * @bssid: BSSID of AP (to avoid races)
 * @replay_ctr: new replay counter
J
Johannes Berg 已提交
3655
 * @gfp: allocation flags
3656 3657 3658 3659
 */
void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
			       const u8 *replay_ctr, gfp_t gfp);

3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670
/**
 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
 * @dev: network device
 * @index: candidate index (the smaller the index, the higher the priority)
 * @bssid: BSSID of AP
 * @preauth: Whether AP advertises support for RSN pre-authentication
 * @gfp: allocation flags
 */
void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
				     const u8 *bssid, bool preauth, gfp_t gfp);

3671 3672 3673 3674 3675 3676 3677 3678 3679
/**
 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
 * @dev: The device the frame matched to
 * @addr: the transmitter address
 * @gfp: context flags
 *
 * This function is used in AP mode (only!) to inform userspace that
 * a spurious class 3 frame was received, to be able to deauth the
 * sender.
3680
 * Return: %true if the frame was passed to userspace (or this failed
3681 3682 3683 3684 3685
 * for a reason other than not having a subscription.)
 */
bool cfg80211_rx_spurious_frame(struct net_device *dev,
				const u8 *addr, gfp_t gfp);

3686 3687 3688 3689 3690 3691 3692 3693 3694 3695
/**
 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
 * @dev: The device the frame matched to
 * @addr: the transmitter address
 * @gfp: context flags
 *
 * This function is used in AP mode (only!) to inform userspace that
 * an associated station sent a 4addr frame but that wasn't expected.
 * It is allowed and desirable to send this event only once for each
 * station to avoid event flooding.
3696
 * Return: %true if the frame was passed to userspace (or this failed
3697 3698 3699 3700 3701
 * for a reason other than not having a subscription.)
 */
bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
					const u8 *addr, gfp_t gfp);

J
Johannes Berg 已提交
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712
/**
 * cfg80211_probe_status - notify userspace about probe status
 * @dev: the device the probe was sent on
 * @addr: the address of the peer
 * @cookie: the cookie filled in @probe_client previously
 * @acked: indicates whether probe was acked or not
 * @gfp: allocation flags
 */
void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
			   u64 cookie, bool acked, gfp_t gfp);

3713 3714 3715 3716 3717 3718
/**
 * cfg80211_report_obss_beacon - report beacon from other APs
 * @wiphy: The wiphy that received the beacon
 * @frame: the frame
 * @len: length of the frame
 * @freq: frequency the frame was received on
3719
 * @sig_dbm: signal strength in mBm, or 0 if unknown
3720 3721 3722 3723 3724 3725 3726
 *
 * Use this function to report to userspace when a beacon was
 * received. It is not useful to call this when there is no
 * netdev that is in AP/GO mode.
 */
void cfg80211_report_obss_beacon(struct wiphy *wiphy,
				 const u8 *frame, size_t len,
3727
				 int freq, int sig_dbm);
3728

3729
/**
3730
 * cfg80211_reg_can_beacon - check if beaconing is allowed
3731
 * @wiphy: the wiphy
3732
 * @chandef: the channel definition
3733
 *
3734 3735
 * Return: %true if there is no secondary channel or the secondary channel(s)
 * can be used for beaconing (i.e. is not a radar channel etc.)
3736
 */
3737 3738
bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
			     struct cfg80211_chan_def *chandef);
3739

3740 3741 3742
/*
 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
 * @dev: the device which switched channels
3743
 * @chandef: the new channel definition
3744 3745 3746
 *
 * Acquires wdev_lock, so must only be called from sleepable driver context!
 */
3747 3748
void cfg80211_ch_switch_notify(struct net_device *dev,
			       struct cfg80211_chan_def *chandef);
3749

3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768
/*
 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
 * @dev: the device on which the operation is requested
 * @peer: the MAC address of the peer device
 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
 *	NL80211_TDLS_TEARDOWN)
 * @reason_code: the reason code for teardown request
 * @gfp: allocation flags
 *
 * This function is used to request userspace to perform TDLS operation that
 * requires knowledge of keys, i.e., link setup or teardown when the AP
 * connection uses encryption. This is optional mechanism for the driver to use
 * if it can automatically determine when a TDLS link could be useful (e.g.,
 * based on traffic and signal strength for a peer).
 */
void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
				enum nl80211_tdls_operation oper,
				u16 reason_code, gfp_t gfp);

3769 3770 3771 3772 3773 3774
/*
 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
 * @rate: given rate_info to calculate bitrate from
 *
 * return 0 if MCS index >= 32
 */
3775
u32 cfg80211_calculate_bitrate(struct rate_info *rate);
3776

3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792
/**
 * cfg80211_unregister_wdev - remove the given wdev
 * @wdev: struct wireless_dev to remove
 *
 * Call this function only for wdevs that have no netdev assigned,
 * e.g. P2P Devices. It removes the device from the list so that
 * it can no longer be used. It is necessary to call this function
 * even when cfg80211 requests the removal of the interface by
 * calling the del_virtual_intf() callback. The function must also
 * be called when the driver wishes to unregister the wdev, e.g.
 * when the device is unbound from the driver.
 *
 * Requires the RTNL to be held.
 */
void cfg80211_unregister_wdev(struct wireless_dev *wdev);

3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804
/**
 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
 * @ies: the input IE buffer
 * @len: the input length
 * @attr: the attribute ID to find
 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
 *	if the function is only called to get the needed buffer size
 * @bufsize: size of the output buffer
 *
 * The function finds a given P2P attribute in the (vendor) IEs and
 * copies its contents to the given buffer.
 *
3805 3806 3807
 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
 * malformed or the attribute can't be found (respectively), or the
 * length of the found attribute (which can be zero).
3808
 */
3809 3810 3811
int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
			  enum ieee80211_p2p_attr_id attr,
			  u8 *buf, unsigned int bufsize);
3812

3813 3814 3815 3816 3817
/* Logging, debugging and troubleshooting/diagnostic helpers. */

/* wiphy_printk helpers, similar to dev_printk */

#define wiphy_printk(level, wiphy, format, args...)		\
3818
	dev_printk(level, &(wiphy)->dev, format, ##args)
3819
#define wiphy_emerg(wiphy, format, args...)			\
3820
	dev_emerg(&(wiphy)->dev, format, ##args)
3821
#define wiphy_alert(wiphy, format, args...)			\
3822
	dev_alert(&(wiphy)->dev, format, ##args)
3823
#define wiphy_crit(wiphy, format, args...)			\
3824
	dev_crit(&(wiphy)->dev, format, ##args)
3825
#define wiphy_err(wiphy, format, args...)			\
3826
	dev_err(&(wiphy)->dev, format, ##args)
3827
#define wiphy_warn(wiphy, format, args...)			\
3828
	dev_warn(&(wiphy)->dev, format, ##args)
3829
#define wiphy_notice(wiphy, format, args...)			\
3830
	dev_notice(&(wiphy)->dev, format, ##args)
3831
#define wiphy_info(wiphy, format, args...)			\
3832
	dev_info(&(wiphy)->dev, format, ##args)
3833

3834
#define wiphy_debug(wiphy, format, args...)			\
3835
	wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3836

3837
#define wiphy_dbg(wiphy, format, args...)			\
3838
	dev_dbg(&(wiphy)->dev, format, ##args)
3839 3840 3841 3842 3843 3844 3845 3846

#if defined(VERBOSE_DEBUG)
#define wiphy_vdbg	wiphy_dbg
#else
#define wiphy_vdbg(wiphy, format, args...)				\
({									\
	if (0)								\
		wiphy_printk(KERN_DEBUG, wiphy, format, ##args);	\
3847
	0;								\
3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858
})
#endif

/*
 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
 * of using a WARN/WARN_ON to get the message out, including the
 * file/line information and a backtrace.
 */
#define wiphy_WARN(wiphy, format, args...)			\
	WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);

3859
#endif /* __NET_CFG80211_H */