cfg80211.h 168.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>
22
#include <linux/net.h>
J
Johannes Berg 已提交
23 24
#include <net/regulatory.h>

J
Johannes Berg 已提交
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 61
/**
 * 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.
 */

62 63
struct wiphy;

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

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

	/* keep last */
	IEEE80211_NUM_BANDS
};
87

88
/**
J
Johannes Berg 已提交
89 90 91 92 93
 * enum ieee80211_channel_flags - channel flags
 *
 * Channel flags set by the regulatory control code.
 *
 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
94 95
 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
 * 	sending probe requests or beaconing.
J
Johannes Berg 已提交
96
 * @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 103 104 105 106 107 108 109 110 111
 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
 *	this flag indicates that an 80 MHz channel cannot use this
 *	channel as the control or any of the secondary channels.
 *	This may be due to the driver or due to regulatory bandwidth
 *	restrictions.
 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
 *	this flag indicates that an 160 MHz channel cannot use this
 *	channel as the control or any of the secondary channels.
 *	This may be due to the driver or due to regulatory bandwidth
 *	restrictions.
112 113
 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
 * @IEEE80211_CHAN_GO_CONCURRENT: see %NL80211_FREQUENCY_ATTR_GO_CONCURRENT
114 115 116 117
 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
 *	on this channel.
 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
 *	on this channel.
118
 *
119
 */
J
Johannes Berg 已提交
120 121
enum ieee80211_channel_flags {
	IEEE80211_CHAN_DISABLED		= 1<<0,
122 123
	IEEE80211_CHAN_NO_IR		= 1<<1,
	/* hole at 1<<2 */
J
Johannes Berg 已提交
124
	IEEE80211_CHAN_RADAR		= 1<<3,
125 126
	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
127
	IEEE80211_CHAN_NO_OFDM		= 1<<6,
128 129
	IEEE80211_CHAN_NO_80MHZ		= 1<<7,
	IEEE80211_CHAN_NO_160MHZ	= 1<<8,
130 131
	IEEE80211_CHAN_INDOOR_ONLY	= 1<<9,
	IEEE80211_CHAN_GO_CONCURRENT	= 1<<10,
132 133
	IEEE80211_CHAN_NO_20MHZ		= 1<<11,
	IEEE80211_CHAN_NO_10MHZ		= 1<<12,
134 135
};

136
#define IEEE80211_CHAN_NO_HT40 \
137
	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
138

139 140 141
#define IEEE80211_DFS_MIN_CAC_TIME_MS		60000
#define IEEE80211_DFS_MIN_NOP_TIME_MS		(30 * 60 * 1000)

J
Johannes Berg 已提交
142 143 144 145 146 147 148 149 150 151 152 153 154 155
/**
 * 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)
156
 * @max_reg_power: maximum regulatory transmission power (in dBm)
J
Johannes Berg 已提交
157 158
 * @beacon_found: helper to regulatory code to indicate when a beacon
 *	has been found on this channel. Use regulatory_hint_found_beacon()
159
 *	to enable this, this is useful only on 5 GHz band.
J
Johannes Berg 已提交
160 161
 * @orig_mag: internal use
 * @orig_mpwr: internal use
162 163 164
 * @dfs_state: current state of this channel. Only relevant if radar is required
 *	on this channel.
 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
165
 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
A
Andy Green 已提交
166
 */
J
Johannes Berg 已提交
167 168 169 170 171 172 173
struct ieee80211_channel {
	enum ieee80211_band band;
	u16 center_freq;
	u16 hw_value;
	u32 flags;
	int max_antenna_gain;
	int max_power;
174
	int max_reg_power;
J
Johannes Berg 已提交
175 176 177
	bool beacon_found;
	u32 orig_flags;
	int orig_mag, orig_mpwr;
178 179
	enum nl80211_dfs_state dfs_state;
	unsigned long dfs_state_entered;
180
	unsigned int dfs_cac_ms;
J
Johannes Berg 已提交
181 182
};

A
Andy Green 已提交
183
/**
J
Johannes Berg 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
 * 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.
203 204
 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
A
Andy Green 已提交
205
 */
J
Johannes Berg 已提交
206 207 208 209 210 211
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,
212 213
	IEEE80211_RATE_SUPPORTS_5MHZ	= 1<<5,
	IEEE80211_RATE_SUPPORTS_10MHZ	= 1<<6,
J
Johannes Berg 已提交
214
};
A
Andy Green 已提交
215

J
Johannes Berg 已提交
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
/**
 * 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 已提交
235

J
Johannes Berg 已提交
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
/**
 * 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 已提交
254 255
};

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
/**
 * 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 已提交
272 273 274 275 276 277 278 279 280 281 282 283 284 285
/**
 * 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 已提交
286
 * @ht_cap: HT capabilities in this band
287
 * @vht_cap: VHT capabilities in this band
J
Johannes Berg 已提交
288 289 290 291 292 293 294 295
 */
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;
296
	struct ieee80211_sta_vht_cap vht_cap;
J
Johannes Berg 已提交
297
};
A
Andy Green 已提交
298

J
Johannes Berg 已提交
299 300 301
/*
 * Wireless hardware/device configuration structures and methods
 */
A
Andy Green 已提交
302

J
Johannes Berg 已提交
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
/**
 * 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 已提交
318 319
/**
 * struct vif_params - describes virtual interface parameters
320
 * @use_4addr: use 4-address frames
321 322 323
 * @macaddr: address to use for this virtual interface. This will only
 * 	be used for non-netdevice interfaces. If this parameter is set
 * 	to zero address the driver may determine the address as needed.
J
Johannes Berg 已提交
324 325
 */
struct vif_params {
326
       int use_4addr;
327
       u8 macaddr[ETH_ALEN];
J
Johannes Berg 已提交
328
};
A
Andy Green 已提交
329

J
Johannes Berg 已提交
330
/**
331 332 333 334 335 336 337 338 339 340
 * 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 已提交
341
 * @seq_len: length of @seq.
342 343 344 345 346 347 348 349 350
 */
struct key_params {
	u8 *key;
	u8 *seq;
	int key_len;
	int seq_len;
	u32 cipher;
};

351 352 353
/**
 * struct cfg80211_chan_def - channel definition
 * @chan: the (control) channel
354 355 356 357
 * @width: channel width
 * @center_freq1: center frequency of first segment
 * @center_freq2: center frequency of second segment
 *	(only with 80+80 MHz)
358 359 360
 */
struct cfg80211_chan_def {
	struct ieee80211_channel *chan;
361 362 363
	enum nl80211_chan_width width;
	u32 center_freq1;
	u32 center_freq2;
364 365
};

366 367 368 369
/**
 * cfg80211_get_chandef_type - return old channel type from chandef
 * @chandef: the channel definition
 *
370
 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
371 372
 * chandef, which must have a bandwidth allowing this conversion.
 */
373 374 375
static inline enum nl80211_channel_type
cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
{
376 377 378 379 380 381 382 383 384 385 386 387 388
	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;
	}
389 390
}

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
/**
 * 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
 *
408
 * Return: %true if the channels defined by the channel definitions are
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
 * 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
 *
426
 * Return: %NULL if the given channel definitions are incompatible,
427 428 429 430 431 432
 * chandef1 or chandef2 otherwise.
 */
const struct cfg80211_chan_def *
cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
			    const struct cfg80211_chan_def *chandef2);

433 434 435
/**
 * cfg80211_chandef_valid - check if a channel definition is valid
 * @chandef: the channel definition to check
436
 * Return: %true if the channel definition is valid. %false otherwise.
437 438 439 440 441 442 443
 */
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
444 445
 * @prohibited_flags: the regulatory channel flags that must not be set
 * Return: %true if secondary channels are usable. %false otherwise.
446 447 448 449 450
 */
bool cfg80211_chandef_usable(struct wiphy *wiphy,
			     const struct cfg80211_chan_def *chandef,
			     u32 prohibited_flags);

451 452 453 454
/**
 * cfg80211_chandef_dfs_required - checks if radar detection is required
 * @wiphy: the wiphy to validate against
 * @chandef: the channel definition to check
455 456 457
 * @iftype: the interface type as specified in &enum nl80211_iftype
 * Returns:
 *	1 if radar detection is required, 0 if it is not, < 0 on error
458 459
 */
int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
460
				  const struct cfg80211_chan_def *chandef,
L
Luciano Coelho 已提交
461
				  enum nl80211_iftype iftype);
462

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
/**
 * ieee80211_chandef_rate_flags - returns rate flags for a channel
 *
 * In some channel types, not all rates may be used - for example CCK
 * rates may not be used in 5/10 MHz channels.
 *
 * @chandef: channel definition for the channel
 *
 * Returns: rate flags which apply for this channel
 */
static inline enum ieee80211_rate_flags
ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
{
	switch (chandef->width) {
	case NL80211_CHAN_WIDTH_5:
		return IEEE80211_RATE_SUPPORTS_5MHZ;
	case NL80211_CHAN_WIDTH_10:
		return IEEE80211_RATE_SUPPORTS_10MHZ;
	default:
		break;
	}
	return 0;
}

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
/**
 * ieee80211_chandef_max_power - maximum transmission power for the chandef
 *
 * In some regulations, the transmit power may depend on the configured channel
 * bandwidth which may be defined as dBm/MHz. This function returns the actual
 * max_power for non-standard (20 MHz) channels.
 *
 * @chandef: channel definition for the channel
 *
 * Returns: maximum allowed transmission power in dBm for the chandef
 */
static inline int
ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
{
	switch (chandef->width) {
	case NL80211_CHAN_WIDTH_5:
		return min(chandef->chan->max_reg_power - 6,
			   chandef->chan->max_power);
	case NL80211_CHAN_WIDTH_10:
		return min(chandef->chan->max_reg_power - 3,
			   chandef->chan->max_power);
	default:
		break;
	}
	return chandef->chan->max_power;
}

514 515 516
/**
 * enum survey_info_flags - survey information flags
 *
J
Johannes Berg 已提交
517
 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
518
 * @SURVEY_INFO_IN_USE: channel is currently being used
519 520 521 522 523
 * @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 已提交
524
 *
525 526 527 528 529
 * 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,
530
	SURVEY_INFO_IN_USE = 1<<1,
531 532 533 534 535
	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,
536 537 538 539 540 541 542 543
};

/**
 * 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
544
 *	optional
545 546 547 548 549
 * @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
550
 *
J
Johannes Berg 已提交
551 552
 * Used by dump_survey() to report back per-channel survey information.
 *
553 554 555 556 557
 * This structure can later be expanded with things like
 * channel duty cycle etc.
 */
struct survey_info {
	struct ieee80211_channel *channel;
558 559 560 561 562
	u64 channel_time;
	u64 channel_time_busy;
	u64 channel_time_ext_busy;
	u64 channel_time_rx;
	u64 channel_time_tx;
563 564 565 566
	u32 filled;
	s8 noise;
};

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
/**
 * 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;
};

597
/**
598
 * struct cfg80211_beacon_data - beacon data
599
 * @head: head portion of beacon (before TIM IE)
600
 *	or %NULL if not changed
601
 * @tail: tail portion of beacon (after TIM IE)
602
 *	or %NULL if not changed
603 604
 * @head_len: length of @head
 * @tail_len: length of @tail
605 606 607 608 609 610 611 612
 * @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
613 614
 * @probe_resp_len: length of probe response template (@probe_resp)
 * @probe_resp: probe response template (AP mode only)
615
 */
616 617 618 619 620 621 622 623 624 625 626 627 628 629
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;
};

630 631 632 633
struct mac_address {
	u8 addr[ETH_ALEN];
};

634 635 636 637
/**
 * struct cfg80211_acl_data - Access control list data
 *
 * @acl_policy: ACL policy to be applied on the station's
J
Johannes Berg 已提交
638
 *	entry specified by mac_addr
639 640 641 642 643 644 645 646 647 648 649
 * @n_acl_entries: Number of MAC address entries passed
 * @mac_addrs: List of MAC addresses of stations to be used for ACL
 */
struct cfg80211_acl_data {
	enum nl80211_acl_policy acl_policy;
	int n_acl_entries;

	/* Keep it last */
	struct mac_address mac_addrs[];
};

650 651 652 653 654
/**
 * struct cfg80211_ap_settings - AP configuration
 *
 * Used to configure an AP interface.
 *
655
 * @chandef: defines the channel to use
656 657 658 659 660 661 662 663 664 665
 * @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)
666
 * @inactivity_timeout: time in seconds to determine station's inactivity.
667 668
 * @p2p_ctwindow: P2P CT Window
 * @p2p_opp_ps: P2P opportunistic PS
669 670
 * @acl: ACL configuration used by the drivers which has support for
 *	MAC address based access control
671 672
 */
struct cfg80211_ap_settings {
673
	struct cfg80211_chan_def chandef;
674

675 676 677
	struct cfg80211_beacon_data beacon;

	int beacon_interval, dtim_period;
678 679 680
	const u8 *ssid;
	size_t ssid_len;
	enum nl80211_hidden_ssid hidden_ssid;
681 682 683
	struct cfg80211_crypto_settings crypto;
	bool privacy;
	enum nl80211_auth_type auth_type;
684
	int inactivity_timeout;
685 686
	u8 p2p_ctwindow;
	bool p2p_opp_ps;
687
	const struct cfg80211_acl_data *acl;
688 689
};

690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
/**
 * struct cfg80211_csa_settings - channel switch settings
 *
 * Used for channel switch
 *
 * @chandef: defines the channel to use after the switch
 * @beacon_csa: beacon data while performing the switch
 * @counter_offset_beacon: offset for the counter within the beacon (tail)
 * @counter_offset_presp: offset for the counter within the probe response
 * @beacon_after: beacon data to be used on the new channel
 * @radar_required: whether radar detection is required on the new channel
 * @block_tx: whether transmissions should be blocked while changing
 * @count: number of beacons until switch
 */
struct cfg80211_csa_settings {
	struct cfg80211_chan_def chandef;
	struct cfg80211_beacon_data beacon_csa;
	u16 counter_offset_beacon, counter_offset_presp;
	struct cfg80211_beacon_data beacon_after;
	bool radar_required;
	bool block_tx;
	u8 count;
};

714 715 716
/**
 * enum station_parameters_apply_mask - station parameter values to apply
 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
717
 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
718
 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
719 720 721 722 723 724
 *
 * 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),
725
	STATION_PARAM_APPLY_CAPABILITY = BIT(1),
726
	STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
727 728
};

729 730 731 732 733 734 735 736 737
/**
 * 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
738 739 740 741
 * @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_...))
742 743
 * @listen_interval: listen interval or -1 for no change
 * @aid: AID or zero for no change
J
Johannes Berg 已提交
744
 * @plink_action: plink action to take
745
 * @plink_state: set the peer link state for a station
J
Johannes Berg 已提交
746
 * @ht_capa: HT capabilities of station
M
Mahesh Palivela 已提交
747
 * @vht_capa: VHT capabilities of station
748 749 750 751
 * @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 已提交
752 753 754
 * @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
755 756
 * @local_pm: local link-specific mesh power save mode (no change when set
 *	to unknown)
757 758 759
 * @capability: station capability
 * @ext_capab: extended capabilities of the station
 * @ext_capab_len: number of extended capabilities
760 761 762 763
 * @supported_channels: supported channels in IEEE 802.11 format
 * @supported_channels_len: number of supported channels
 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
 * @supported_oper_classes_len: number of supported operating classes
764 765
 * @opmode_notif: operating mode field from Operating Mode Notification
 * @opmode_notif_used: information if operating mode field is used
766 767
 */
struct station_parameters {
768
	const u8 *supported_rates;
769
	struct net_device *vlan;
770
	u32 sta_flags_mask, sta_flags_set;
771
	u32 sta_modify_mask;
772 773 774
	int listen_interval;
	u16 aid;
	u8 supported_rates_len;
775
	u8 plink_action;
776
	u8 plink_state;
777 778
	const struct ieee80211_ht_cap *ht_capa;
	const struct ieee80211_vht_cap *vht_capa;
779 780
	u8 uapsd_queues;
	u8 max_sp;
781
	enum nl80211_mesh_power_mode local_pm;
782
	u16 capability;
783
	const u8 *ext_capab;
784
	u8 ext_capab_len;
785 786 787 788
	const u8 *supported_channels;
	u8 supported_channels_len;
	const u8 *supported_oper_classes;
	u8 supported_oper_classes_len;
789 790
	u8 opmode_notif;
	bool opmode_notif_used;
791 792
};

793 794 795 796 797 798 799 800 801 802 803 804 805
/**
 * enum cfg80211_station_type - the type of station being modified
 * @CFG80211_STA_AP_CLIENT: client of an AP interface
 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
 *	the AP MLME in the device
 * @CFG80211_STA_AP_STA: AP station on managed interface
 * @CFG80211_STA_IBSS: IBSS station
 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
 *	while TDLS setup is in progress, it moves out of this state when
 *	being marked authorized; use this only if TDLS with external setup is
 *	supported/used)
 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
 *	entry that is operating, has been marked authorized by userspace)
806 807
 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
808 809 810 811 812 813 814 815
 */
enum cfg80211_station_type {
	CFG80211_STA_AP_CLIENT,
	CFG80211_STA_AP_MLME_CLIENT,
	CFG80211_STA_AP_STA,
	CFG80211_STA_IBSS,
	CFG80211_STA_TDLS_PEER_SETUP,
	CFG80211_STA_TDLS_PEER_ACTIVE,
816 817
	CFG80211_STA_MESH_PEER_KERNEL,
	CFG80211_STA_MESH_PEER_USER,
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
};

/**
 * cfg80211_check_station_change - validate parameter changes
 * @wiphy: the wiphy this operates on
 * @params: the new parameters for a station
 * @statype: the type of station being modified
 *
 * Utility function for the @change_station driver method. Call this function
 * with the appropriate station type looking up the station (and checking that
 * it exists). It will verify whether the station change is acceptable, and if
 * not will return an error code. Note that it may modify the parameters for
 * backward compatibility reasons, so don't use them before calling this.
 */
int cfg80211_check_station_change(struct wiphy *wiphy,
				  struct station_parameters *params,
				  enum cfg80211_station_type statype);

836
/**
837
 * enum station_info_flags - station information flags
838
 *
839 840
 * Used by the driver to indicate which info in &struct station_info
 * it has filled in during get_station() or dump_station().
841
 *
842 843 844
 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
 * @STATION_INFO_RX_BYTES: @rx_bytes filled
 * @STATION_INFO_TX_BYTES: @tx_bytes filled
J
Johannes Berg 已提交
845 846
 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
847 848 849
 * @STATION_INFO_LLID: @llid filled
 * @STATION_INFO_PLID: @plid filled
 * @STATION_INFO_PLINK_STATE: @plink_state filled
850
 * @STATION_INFO_SIGNAL: @signal filled
851
 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
852
 *	(tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
853 854
 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
855 856
 * @STATION_INFO_TX_RETRIES: @tx_retries filled
 * @STATION_INFO_TX_FAILED: @tx_failed filled
857
 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
858
 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
859
 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
860
 * @STATION_INFO_BSS_PARAM: @bss_param filled
861
 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
862
 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
863
 * @STATION_INFO_STA_FLAGS: @sta_flags filled
864
 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
865
 * @STATION_INFO_T_OFFSET: @t_offset filled
866 867 868
 * @STATION_INFO_LOCAL_PM: @local_pm filled
 * @STATION_INFO_PEER_PM: @peer_pm filled
 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
869 870
 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
871
 */
872 873 874 875 876 877 878
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,
879 880
	STATION_INFO_SIGNAL		= 1<<6,
	STATION_INFO_TX_BITRATE		= 1<<7,
881 882
	STATION_INFO_RX_PACKETS		= 1<<8,
	STATION_INFO_TX_PACKETS		= 1<<9,
883 884
	STATION_INFO_TX_RETRIES		= 1<<10,
	STATION_INFO_TX_FAILED		= 1<<11,
885
	STATION_INFO_RX_DROP_MISC	= 1<<12,
886
	STATION_INFO_SIGNAL_AVG		= 1<<13,
887
	STATION_INFO_RX_BITRATE		= 1<<14,
888
	STATION_INFO_BSS_PARAM          = 1<<15,
889
	STATION_INFO_CONNECTED_TIME	= 1<<16,
890
	STATION_INFO_ASSOC_REQ_IES	= 1<<17,
891
	STATION_INFO_STA_FLAGS		= 1<<18,
892 893
	STATION_INFO_BEACON_LOSS_COUNT	= 1<<19,
	STATION_INFO_T_OFFSET		= 1<<20,
894 895 896
	STATION_INFO_LOCAL_PM		= 1<<21,
	STATION_INFO_PEER_PM		= 1<<22,
	STATION_INFO_NONPEER_PM		= 1<<23,
897 898
	STATION_INFO_RX_BYTES64		= 1<<24,
	STATION_INFO_TX_BYTES64		= 1<<25,
899 900
	STATION_INFO_CHAIN_SIGNAL	= 1<<26,
	STATION_INFO_CHAIN_SIGNAL_AVG	= 1<<27,
901 902 903 904 905 906 907 908
};

/**
 * enum station_info_rate_flags - bitrate info flags
 *
 * Used by the driver to indicate the specific rate transmission
 * type for 802.11n transmissions.
 *
909 910 911 912 913 914
 * @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
915
 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
916
 * @RATE_INFO_FLAGS_60G: 60GHz MCS
917 918
 */
enum rate_info_flags {
919 920 921 922 923 924 925 926
	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),
927 928 929 930 931 932 933 934 935 936
};

/**
 * 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
937
 * @nss: number of streams (VHT only)
938 939 940 941 942
 */
struct rate_info {
	u8 flags;
	u8 mcs;
	u16 legacy;
943
	u8 nss;
944 945
};

946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
/**
 * 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;
};

977 978
#define IEEE80211_MAX_CHAINS	4

979
/**
980
 * struct station_info - station information
981
 *
982
 * Station information filled by driver for get_station() and dump_station.
983
 *
984
 * @filled: bitflag of flags from &enum station_info_flags
985
 * @connected_time: time(in secs) since a station is last connected
986 987 988
 * @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
989 990 991
 * @llid: mesh local link id
 * @plid: mesh peer link id
 * @plink_state: mesh peer link state
J
Johannes Berg 已提交
992 993 994 995
 * @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_.
996 997 998
 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
 * @chain_signal: per-chain signal strength of last received packet in dBm
 * @chain_signal_avg: per-chain signal strength average in dBm
999 1000
 * @txrate: current unicast bitrate from this station
 * @rxrate: current unicast bitrate to this station
1001 1002
 * @rx_packets: packets received from this station
 * @tx_packets: packets transmitted to this station
1003 1004
 * @tx_retries: cumulative retry counts
 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
1005
 * @rx_dropped_misc:  Dropped for un-specified reason.
1006
 * @bss_param: current BSS parameters
1007 1008 1009 1010
 * @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.
1011 1012 1013 1014 1015
 * @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 已提交
1016
 * @sta_flags: station flags mask & values
1017
 * @beacon_loss_count: Number of times beacon loss event has triggered.
1018
 * @t_offset: Time offset of the station relative to this host.
1019 1020 1021
 * @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
1022
 */
1023
struct station_info {
1024
	u32 filled;
1025
	u32 connected_time;
1026
	u32 inactive_time;
1027 1028
	u64 rx_bytes;
	u64 tx_bytes;
1029 1030 1031
	u16 llid;
	u16 plid;
	u8 plink_state;
1032
	s8 signal;
1033
	s8 signal_avg;
1034 1035 1036 1037 1038

	u8 chains;
	s8 chain_signal[IEEE80211_MAX_CHAINS];
	s8 chain_signal_avg[IEEE80211_MAX_CHAINS];

1039
	struct rate_info txrate;
1040
	struct rate_info rxrate;
1041 1042
	u32 rx_packets;
	u32 tx_packets;
1043 1044
	u32 tx_retries;
	u32 tx_failed;
1045
	u32 rx_dropped_misc;
1046
	struct sta_bss_parameters bss_param;
1047
	struct nl80211_sta_flag_update sta_flags;
1048 1049

	int generation;
1050 1051 1052

	const u8 *assoc_req_ies;
	size_t assoc_req_ies_len;
1053

1054
	u32 beacon_loss_count;
1055
	s64 t_offset;
1056 1057 1058
	enum nl80211_mesh_power_mode local_pm;
	enum nl80211_mesh_power_mode peer_pm;
	enum nl80211_mesh_power_mode nonpeer_pm;
1059

1060 1061 1062 1063
	/*
	 * Note: Add a new enum station_info_flags value for each new field and
	 * use it to check which fields are initialized.
	 */
1064 1065
};

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
/**
 * 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
1077
 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1078 1079 1080 1081 1082 1083 1084
 */
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,
1085
	MONITOR_FLAG_ACTIVE		= 1<<NL80211_MNTR_FLAG_ACTIVE,
1086 1087
};

1088 1089 1090 1091 1092 1093
/**
 * 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 已提交
1094 1095 1096 1097 1098 1099 1100
 * @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
1101 1102 1103
 */
enum mpath_info_flags {
	MPATH_INFO_FRAME_QLEN		= BIT(0),
1104
	MPATH_INFO_SN			= BIT(1),
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
	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
1119
 * @sn: target sequence number
1120 1121 1122 1123 1124
 * @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
1125 1126 1127 1128
 * @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.
1129 1130 1131 1132
 */
struct mpath_info {
	u32 filled;
	u32 frame_qlen;
1133
	u32 sn;
1134 1135 1136 1137 1138
	u32 metric;
	u32 exptime;
	u32 discovery_timeout;
	u8 discovery_retries;
	u8 flags;
1139 1140

	int generation;
1141 1142
};

1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
/**
 * 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)
1154 1155 1156
 * @basic_rates: basic rates in IEEE 802.11 format
 *	(or NULL for no change)
 * @basic_rates_len: number of basic rates
1157
 * @ap_isolate: do not forward packets between connected stations
1158 1159
 * @ht_opmode: HT Operation mode
 * 	(u16 = opmode, -1 = do not change)
1160 1161
 * @p2p_ctwindow: P2P CT Window (-1 = no change)
 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1162 1163 1164 1165 1166
 */
struct bss_parameters {
	int use_cts_prot;
	int use_short_preamble;
	int use_short_slot_time;
1167 1168
	u8 *basic_rates;
	u8 basic_rates_len;
1169
	int ap_isolate;
1170
	int ht_opmode;
1171
	s8 p2p_ctwindow, p2p_opp_ps;
1172
};
1173

1174
/**
1175 1176 1177
 * struct mesh_config - 802.11s mesh configuration
 *
 * These parameters can be changed while the mesh is active.
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
 *
 * @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
1226 1227 1228 1229 1230 1231 1232
 *
 * @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.
1233 1234 1235
 * @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.
1236 1237 1238 1239
 * @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.
1240 1241 1242
 * @plink_timeout: If no tx activity is seen from a STA we've established
 *	peering with for longer than this time (in seconds), then remove it
 *	from the STA's list of peers.  Default is 30 minutes.
1243
 */
1244 1245 1246 1247 1248
struct mesh_config {
	u16 dot11MeshRetryTimeout;
	u16 dot11MeshConfirmTimeout;
	u16 dot11MeshHoldingTimeout;
	u16 dot11MeshMaxPeerLinks;
1249 1250 1251
	u8 dot11MeshMaxRetries;
	u8 dot11MeshTTL;
	u8 element_ttl;
1252
	bool auto_open_plinks;
1253
	u32 dot11MeshNbrOffsetMaxNeighbor;
1254
	u8 dot11MeshHWMPmaxPREQretries;
1255 1256 1257 1258
	u32 path_refresh_time;
	u16 min_discovery_timeout;
	u32 dot11MeshHWMPactivePathTimeout;
	u16 dot11MeshHWMPpreqMinInterval;
1259
	u16 dot11MeshHWMPperrMinInterval;
1260
	u16 dot11MeshHWMPnetDiameterTraversalTime;
1261
	u8 dot11MeshHWMPRootMode;
1262
	u16 dot11MeshHWMPRannInterval;
1263
	bool dot11MeshGateAnnouncementProtocol;
1264
	bool dot11MeshForwarding;
1265
	s32 rssi_threshold;
1266
	u16 ht_opmode;
1267 1268
	u32 dot11MeshHWMPactivePathToRootTimeout;
	u16 dot11MeshHWMProotInterval;
1269
	u16 dot11MeshHWMPconfirmationInterval;
1270 1271
	enum nl80211_mesh_power_mode power_mode;
	u16 dot11MeshAwakeWindowDuration;
1272
	u32 plink_timeout;
1273 1274
};

1275 1276
/**
 * struct mesh_setup - 802.11s mesh setup configuration
1277
 * @chandef: defines the channel to use
1278 1279
 * @mesh_id: the mesh ID
 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1280
 * @sync_method: which synchronization method to use
1281 1282
 * @path_sel_proto: which path selection protocol to use
 * @path_metric: which metric to use
1283
 * @auth_id: which authentication method this mesh is using
1284 1285
 * @ie: vendor information elements (optional)
 * @ie_len: length of vendor information elements
1286 1287
 * @is_authenticated: this mesh requires authentication
 * @is_secure: this mesh uses security
1288
 * @user_mpm: userspace handles all MPM functions
1289 1290
 * @dtim_period: DTIM period to use
 * @beacon_interval: beacon interval to use
1291
 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1292
 * @basic_rates: basic rates to use when creating the mesh
1293 1294 1295 1296
 *
 * These parameters are fixed when the mesh is created.
 */
struct mesh_setup {
1297
	struct cfg80211_chan_def chandef;
1298 1299
	const u8 *mesh_id;
	u8 mesh_id_len;
1300 1301 1302
	u8 sync_method;
	u8 path_sel_proto;
	u8 path_metric;
1303
	u8 auth_id;
1304 1305
	const u8 *ie;
	u8 ie_len;
1306
	bool is_authenticated;
1307
	bool is_secure;
1308
	bool user_mpm;
1309 1310
	u8 dtim_period;
	u16 beacon_interval;
1311
	int mcast_rate[IEEE80211_NUM_BANDS];
1312
	u32 basic_rates;
1313 1314
};

1315 1316
/**
 * struct ieee80211_txq_params - TX queue parameters
1317
 * @ac: AC identifier
1318 1319 1320 1321 1322 1323 1324 1325
 * @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 {
1326
	enum nl80211_ac ac;
1327 1328 1329 1330 1331 1332
	u16 txop;
	u16 cwmin;
	u16 cwmax;
	u8 aifs;
};

J
Johannes Berg 已提交
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
/**
 * 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.
 */
1355

1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
/**
 * 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.
1372
 * @n_channels: total number of channels to scan
1373
 * @scan_width: channel width for scanning
1374 1375
 * @ie: optional information element(s) to add into Probe Request or %NULL
 * @ie_len: length of ie in octets
1376
 * @flags: bit field of flags controlling operation
1377
 * @rates: bitmap of rates to advertise for each band
1378
 * @wiphy: the wiphy this was for
1379
 * @scan_start: time (in jiffies) when the scan started
J
Johannes Berg 已提交
1380
 * @wdev: the wireless device to scan for
J
Johannes Berg 已提交
1381
 * @aborted: (internal) scan request was notified as aborted
1382
 * @notified: (internal) scan request was notified as done or aborted
1383
 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1384 1385 1386 1387 1388
 */
struct cfg80211_scan_request {
	struct cfg80211_ssid *ssids;
	int n_ssids;
	u32 n_channels;
1389
	enum nl80211_bss_scan_width scan_width;
1390
	const u8 *ie;
1391
	size_t ie_len;
1392
	u32 flags;
1393

1394 1395
	u32 rates[IEEE80211_NUM_BANDS];

J
Johannes Berg 已提交
1396 1397
	struct wireless_dev *wdev;

1398 1399
	/* internal */
	struct wiphy *wiphy;
1400
	unsigned long scan_start;
1401
	bool aborted, notified;
1402
	bool no_cck;
1403 1404 1405

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

1408 1409 1410
/**
 * struct cfg80211_match_set - sets of attributes to match
 *
1411 1412
 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1413 1414 1415
 */
struct cfg80211_match_set {
	struct cfg80211_ssid ssid;
1416
	s32 rssi_thold;
1417 1418
};

1419 1420 1421 1422 1423 1424
/**
 * 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
1425
 * @scan_width: channel width for scanning
1426
 * @interval: interval between each scheduled scan cycle
1427 1428
 * @ie: optional information element(s) to add into Probe Request or %NULL
 * @ie_len: length of ie in octets
1429
 * @flags: bit field of flags controlling operation
1430 1431 1432 1433 1434
 * @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
1435 1436
 * @wiphy: the wiphy this was for
 * @dev: the interface
J
Johannes Berg 已提交
1437
 * @scan_start: start time of the scheduled scan
1438
 * @channels: channels to scan
1439 1440
 * @min_rssi_thold: for drivers only supporting a single threshold, this
 *	contains the minimum over all matchsets
1441 1442 1443 1444 1445
 */
struct cfg80211_sched_scan_request {
	struct cfg80211_ssid *ssids;
	int n_ssids;
	u32 n_channels;
1446
	enum nl80211_bss_scan_width scan_width;
1447
	u32 interval;
1448 1449
	const u8 *ie;
	size_t ie_len;
1450
	u32 flags;
1451 1452
	struct cfg80211_match_set *match_sets;
	int n_match_sets;
1453
	s32 min_rssi_thold;
1454 1455 1456 1457

	/* internal */
	struct wiphy *wiphy;
	struct net_device *dev;
1458
	unsigned long scan_start;
1459 1460 1461 1462 1463

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

1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
/**
 * 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,
};

1477 1478
/**
 * struct cfg80211_bss_ie_data - BSS entry IE data
J
Johannes Berg 已提交
1479
 * @tsf: TSF contained in the frame that carried these IEs
1480 1481 1482 1483 1484
 * @rcu_head: internal use, for freeing
 * @len: length of the IEs
 * @data: IE data
 */
struct cfg80211_bss_ies {
J
Johannes Berg 已提交
1485
	u64 tsf;
1486 1487 1488 1489 1490
	struct rcu_head rcu_head;
	int len;
	u8 data[];
};

1491 1492 1493 1494 1495 1496
/**
 * 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 已提交
1497
 * @channel: channel this BSS is on
1498
 * @scan_width: width of the control channel
1499 1500 1501
 * @bssid: BSSID of the BSS
 * @beacon_interval: the beacon interval as from the frame
 * @capability: the capability field in host byte order
1502 1503 1504 1505
 * @ies: the information elements (Note that there 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. It is always non-%NULL.
1506
 * @beacon_ies: the information elements from the last Beacon frame
1507 1508 1509
 *	(implementation note: if @hidden_beacon_bss is set this struct doesn't
 *	own the beacon_ies, but they're just pointers to the ones from the
 *	@hidden_beacon_bss struct)
1510
 * @proberesp_ies: the information elements from the last Probe Response frame
1511 1512 1513 1514
 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
 *	a BSS that hides the SSID in its beacon, this points to the BSS struct
 *	that holds the beacon data. @beacon_ies is still valid, of course, and
 *	points to the same data as hidden_beacon_bss->beacon_ies in that case.
J
Johannes Berg 已提交
1515
 * @signal: signal strength value (type depends on the wiphy's signal_type)
1516 1517 1518 1519
 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
 */
struct cfg80211_bss {
	struct ieee80211_channel *channel;
1520
	enum nl80211_bss_scan_width scan_width;
1521

1522 1523 1524 1525
	const struct cfg80211_bss_ies __rcu *ies;
	const struct cfg80211_bss_ies __rcu *beacon_ies;
	const struct cfg80211_bss_ies __rcu *proberesp_ies;

1526
	struct cfg80211_bss *hidden_beacon_bss;
1527 1528 1529

	s32 signal;

1530 1531 1532
	u16 beacon_interval;
	u16 capability;

1533
	u8 bssid[ETH_ALEN];
1534

J
Johannes Berg 已提交
1535
	u8 priv[0] __aligned(sizeof(void *));
1536 1537
};

1538 1539 1540 1541
/**
 * ieee80211_bss_get_ie - find IE with given ID
 * @bss: the bss to search
 * @ie: the IE ID
1542 1543 1544
 *
 * Note that the return value is an RCU-protected pointer, so
 * rcu_read_lock() must be held when calling this function.
1545
 * Return: %NULL if not found.
1546 1547 1548 1549
 */
const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);


1550 1551 1552 1553 1554
/**
 * struct cfg80211_auth_request - Authentication request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * authentication.
J
Johannes Berg 已提交
1555
 *
1556 1557
 * @bss: The BSS to authenticate with, the callee must obtain a reference
 *	to it if it needs to keep it.
1558 1559 1560
 * @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 已提交
1561 1562 1563
 * @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
1564 1565 1566
 * @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
1567 1568
 */
struct cfg80211_auth_request {
J
Johannes Berg 已提交
1569
	struct cfg80211_bss *bss;
1570 1571
	const u8 *ie;
	size_t ie_len;
J
Johannes Berg 已提交
1572
	enum nl80211_auth_type auth_type;
J
Johannes Berg 已提交
1573 1574
	const u8 *key;
	u8 key_len, key_idx;
1575 1576
	const u8 *sae_data;
	size_t sae_data_len;
1577 1578
};

1579 1580 1581 1582
/**
 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
 *
 * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
1583
 * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
1584 1585 1586
 */
enum cfg80211_assoc_req_flags {
	ASSOC_REQ_DISABLE_HT		= BIT(0),
1587
	ASSOC_REQ_DISABLE_VHT		= BIT(1),
1588 1589
};

1590 1591 1592 1593 1594
/**
 * struct cfg80211_assoc_request - (Re)Association request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * (re)association.
1595 1596 1597 1598
 * @bss: The BSS to associate with. If the call is successful the driver is
 *	given a reference that it must give back to cfg80211_send_rx_assoc()
 *	or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
 *	association requests while already associating must be rejected.
1599 1600
 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
 * @ie_len: Length of ie buffer in octets
1601
 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
S
Samuel Ortiz 已提交
1602
 * @crypto: crypto settings
1603
 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1604 1605
 * @flags:  See &enum cfg80211_assoc_req_flags
 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1606
 *	will be used in ht_capa.  Un-supported values will be ignored.
1607
 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1608 1609
 * @vht_capa: VHT capability override
 * @vht_capa_mask: VHT capability mask indicating which fields to use
1610 1611
 */
struct cfg80211_assoc_request {
J
Johannes Berg 已提交
1612
	struct cfg80211_bss *bss;
1613
	const u8 *ie, *prev_bssid;
1614
	size_t ie_len;
S
Samuel Ortiz 已提交
1615
	struct cfg80211_crypto_settings crypto;
J
Johannes Berg 已提交
1616
	bool use_mfp;
1617 1618 1619
	u32 flags;
	struct ieee80211_ht_cap ht_capa;
	struct ieee80211_ht_cap ht_capa_mask;
1620
	struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1621 1622 1623 1624 1625 1626 1627 1628
};

/**
 * struct cfg80211_deauth_request - Deauthentication request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * deauthentication.
 *
1629
 * @bssid: the BSSID of the BSS to deauthenticate from
1630 1631
 * @ie: Extra IEs to add to Deauthentication frame or %NULL
 * @ie_len: Length of ie buffer in octets
J
Johannes Berg 已提交
1632
 * @reason_code: The reason code for the deauthentication
J
Johannes Berg 已提交
1633 1634
 * @local_state_change: if set, change local state only and
 *	do not set a deauth frame
1635 1636
 */
struct cfg80211_deauth_request {
1637
	const u8 *bssid;
1638 1639
	const u8 *ie;
	size_t ie_len;
J
Johannes Berg 已提交
1640
	u16 reason_code;
1641
	bool local_state_change;
1642 1643 1644 1645 1646 1647 1648 1649
};

/**
 * struct cfg80211_disassoc_request - Disassociation request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * disassocation.
 *
J
Johannes Berg 已提交
1650
 * @bss: the BSS to disassociate from
1651 1652
 * @ie: Extra IEs to add to Disassociation frame or %NULL
 * @ie_len: Length of ie buffer in octets
J
Johannes Berg 已提交
1653
 * @reason_code: The reason code for the disassociation
1654 1655
 * @local_state_change: This is a request for a local state only, i.e., no
 *	Disassociation frame is to be transmitted.
1656 1657
 */
struct cfg80211_disassoc_request {
J
Johannes Berg 已提交
1658
	struct cfg80211_bss *bss;
1659 1660
	const u8 *ie;
	size_t ie_len;
J
Johannes Berg 已提交
1661
	u16 reason_code;
1662
	bool local_state_change;
1663 1664
};

J
Johannes Berg 已提交
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
/**
 * 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.
1675
 * @chandef: defines the channel to use if no other IBSS to join can be found
J
Johannes Berg 已提交
1676 1677 1678 1679
 * @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
1680
 * @beacon_interval: beacon interval to use
J
Johannes Berg 已提交
1681 1682
 * @privacy: this is a protected network, keys will be configured
 *	after joining
1683 1684 1685 1686
 * @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.
1687 1688 1689
 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
 *	changes the channel when a radar is detected. This is required
 *	to operate on DFS channels.
1690
 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1691
 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1692
 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1693
 *	will be used in ht_capa.  Un-supported values will be ignored.
1694
 * @ht_capa_mask:  The bits of ht_capa which are to be used.
J
Johannes Berg 已提交
1695 1696 1697 1698
 */
struct cfg80211_ibss_params {
	u8 *ssid;
	u8 *bssid;
1699
	struct cfg80211_chan_def chandef;
J
Johannes Berg 已提交
1700 1701
	u8 *ie;
	u8 ssid_len, ie_len;
1702
	u16 beacon_interval;
1703
	u32 basic_rates;
J
Johannes Berg 已提交
1704
	bool channel_fixed;
J
Johannes Berg 已提交
1705
	bool privacy;
1706
	bool control_port;
1707
	bool userspace_handles_dfs;
1708
	int mcast_rate[IEEE80211_NUM_BANDS];
1709 1710
	struct ieee80211_ht_cap ht_capa;
	struct ieee80211_ht_cap ht_capa_mask;
J
Johannes Berg 已提交
1711 1712
};

S
Samuel Ortiz 已提交
1713 1714 1715 1716 1717 1718 1719 1720
/**
 * 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)
1721 1722
 * @channel_hint: The channel of the recommended BSS for initial connection or
 *	%NULL if not specified
S
Samuel Ortiz 已提交
1723 1724
 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
 *	results)
1725 1726 1727 1728
 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
 *	%NULL if not specified. Unlike the @bssid parameter, the driver is
 *	allowed to ignore this @bssid_hint if it has knowledge of a better BSS
 *	to use.
S
Samuel Ortiz 已提交
1729 1730 1731
 * @ssid: SSID
 * @ssid_len: Length of ssid in octets
 * @auth_type: Authentication type (algorithm)
J
Johannes Berg 已提交
1732 1733
 * @ie: IEs for association request
 * @ie_len: Length of assoc_ie in octets
S
Samuel Ortiz 已提交
1734
 * @privacy: indicates whether privacy-enabled APs should be used
1735
 * @mfp: indicate whether management frame protection is used
S
Samuel Ortiz 已提交
1736
 * @crypto: crypto settings
J
Johannes Berg 已提交
1737 1738 1739
 * @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
1740
 * @flags:  See &enum cfg80211_assoc_req_flags
1741
 * @bg_scan_period:  Background scan period in seconds
1742
 *	or -1 to indicate that default value is to be used.
1743
 * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
1744
 *	will be used in ht_capa.  Un-supported values will be ignored.
1745
 * @ht_capa_mask:  The bits of ht_capa which are to be used.
1746 1747
 * @vht_capa:  VHT Capability overrides
 * @vht_capa_mask: The bits of vht_capa which are to be used.
S
Samuel Ortiz 已提交
1748 1749 1750
 */
struct cfg80211_connect_params {
	struct ieee80211_channel *channel;
1751
	struct ieee80211_channel *channel_hint;
1752
	const u8 *bssid;
1753
	const u8 *bssid_hint;
1754
	const u8 *ssid;
S
Samuel Ortiz 已提交
1755 1756
	size_t ssid_len;
	enum nl80211_auth_type auth_type;
1757
	const u8 *ie;
S
Samuel Ortiz 已提交
1758 1759
	size_t ie_len;
	bool privacy;
1760
	enum nl80211_mfp mfp;
S
Samuel Ortiz 已提交
1761
	struct cfg80211_crypto_settings crypto;
J
Johannes Berg 已提交
1762 1763
	const u8 *key;
	u8 key_len, key_idx;
1764
	u32 flags;
1765
	int bg_scan_period;
1766 1767
	struct ieee80211_ht_cap ht_capa;
	struct ieee80211_ht_cap ht_capa_mask;
1768 1769
	struct ieee80211_vht_cap vht_capa;
	struct ieee80211_vht_cap vht_capa_mask;
S
Samuel Ortiz 已提交
1770 1771
};

1772 1773
/**
 * enum wiphy_params_flags - set_wiphy_params bitfield values
J
Johannes Berg 已提交
1774 1775 1776 1777 1778
 * @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
1779 1780 1781 1782 1783 1784
 */
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,
1785
	WIPHY_PARAM_COVERAGE_CLASS	= 1 << 4,
1786 1787
};

J
Johannes Berg 已提交
1788 1789 1790 1791 1792 1793
/*
 * cfg80211_bitrate_mask - masks for bitrate control
 */
struct cfg80211_bitrate_mask {
	struct {
		u32 legacy;
1794
		u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1795
		u16 vht_mcs[NL80211_VHT_NSS_MAX];
1796
		enum nl80211_txrate_gi gi;
J
Johannes Berg 已提交
1797 1798
	} control[IEEE80211_NUM_BANDS];
};
S
Samuel Ortiz 已提交
1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
/**
 * 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 已提交
1812

J
Johannes Berg 已提交
1813
/**
1814
 * struct cfg80211_pkt_pattern - packet pattern
J
Johannes Berg 已提交
1815 1816 1817 1818
 * @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)
1819
 * @pkt_offset: packet offset (in bytes)
J
Johannes Berg 已提交
1820 1821 1822 1823
 *
 * Internal note: @mask and @pattern are allocated in one chunk of
 * memory, free @mask only!
 */
1824
struct cfg80211_pkt_pattern {
J
Johannes Berg 已提交
1825 1826
	u8 *mask, *pattern;
	int pattern_len;
1827
	int pkt_offset;
J
Johannes Berg 已提交
1828 1829
};

1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
/**
 * struct cfg80211_wowlan_tcp - TCP connection parameters
 *
 * @sock: (internal) socket for source port allocation
 * @src: source IP address
 * @dst: destination IP address
 * @dst_mac: destination MAC address
 * @src_port: source port
 * @dst_port: destination port
 * @payload_len: data payload length
 * @payload: data payload buffer
 * @payload_seq: payload sequence stamping configuration
 * @data_interval: interval at which to send data packets
 * @wake_len: wakeup payload match length
 * @wake_data: wakeup payload match data
 * @wake_mask: wakeup payload match mask
 * @tokens_size: length of the tokens buffer
 * @payload_tok: payload token usage configuration
 */
struct cfg80211_wowlan_tcp {
	struct socket *sock;
	__be32 src, dst;
	u16 src_port, dst_port;
	u8 dst_mac[ETH_ALEN];
	int payload_len;
	const u8 *payload;
	struct nl80211_wowlan_tcp_data_seq payload_seq;
	u32 data_interval;
	u32 wake_len;
	const u8 *wake_data, *wake_mask;
	u32 tokens_size;
	/* must be last, variable member */
	struct nl80211_wowlan_tcp_data_token payload_tok;
J
Johannes Berg 已提交
1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874
};

/**
 * 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
1875 1876 1877 1878
 * @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
1879 1880
 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
 *	NULL if not configured.
J
Johannes Berg 已提交
1881 1882
 */
struct cfg80211_wowlan {
1883 1884 1885
	bool any, disconnect, magic_pkt, gtk_rekey_failure,
	     eap_identity_req, four_way_handshake,
	     rfkill_release;
1886
	struct cfg80211_pkt_pattern *patterns;
1887
	struct cfg80211_wowlan_tcp *tcp;
J
Johannes Berg 已提交
1888 1889 1890
	int n_patterns;
};

1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919
/**
 * struct cfg80211_coalesce_rules - Coalesce rule parameters
 *
 * This structure defines coalesce rule for the device.
 * @delay: maximum coalescing delay in msecs.
 * @condition: condition for packet coalescence.
 *	see &enum nl80211_coalesce_condition.
 * @patterns: array of packet patterns
 * @n_patterns: number of patterns
 */
struct cfg80211_coalesce_rules {
	int delay;
	enum nl80211_coalesce_condition condition;
	struct cfg80211_pkt_pattern *patterns;
	int n_patterns;
};

/**
 * struct cfg80211_coalesce - Packet coalescing settings
 *
 * This structure defines coalescing settings.
 * @rules: array of coalesce rules
 * @n_rules: number of rules
 */
struct cfg80211_coalesce {
	struct cfg80211_coalesce_rules *rules;
	int n_rules;
};

1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935
/**
 * struct cfg80211_wowlan_wakeup - wakeup report
 * @disconnect: woke up by getting disconnected
 * @magic_pkt: woke up by receiving magic packet
 * @gtk_rekey_failure: woke up by GTK rekey failure
 * @eap_identity_req: woke up by EAP identity request packet
 * @four_way_handshake: woke up by 4-way handshake
 * @rfkill_release: woke up by rfkill being released
 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
 * @packet_present_len: copied wakeup packet data
 * @packet_len: original wakeup packet length
 * @packet: The packet causing the wakeup, if any.
 * @packet_80211:  For pattern match, magic packet and other data
 *	frame triggers an 802.3 frame should be reported, for
 *	disconnect due to deauth 802.11 frame. This indicates which
 *	it is.
1936 1937 1938
 * @tcp_match: TCP wakeup packet received
 * @tcp_connlost: TCP connection lost or failed to establish
 * @tcp_nomoretokens: TCP data ran out of tokens
1939 1940 1941 1942
 */
struct cfg80211_wowlan_wakeup {
	bool disconnect, magic_pkt, gtk_rekey_failure,
	     eap_identity_req, four_way_handshake,
1943 1944
	     rfkill_release, packet_80211,
	     tcp_match, tcp_connlost, tcp_nomoretokens;
1945 1946 1947 1948 1949
	s32 pattern_idx;
	u32 packet_present_len, packet_len;
	const void *packet;
};

1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
/**
 * 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];
};

1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976
/**
 * struct cfg80211_update_ft_ies_params - FT IE Information
 *
 * This structure provides information needed to update the fast transition IE
 *
 * @md: The Mobility Domain ID, 2 Octet value
 * @ie: Fast Transition IEs
 * @ie_len: Length of ft_ie in octets
 */
struct cfg80211_update_ft_ies_params {
	u16 md;
	const u8 *ie;
	size_t ie_len;
};

1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999
/**
 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
 *
 * This structure provides information needed to transmit a mgmt frame
 *
 * @chan: channel to use
 * @offchan: indicates wether off channel operation is required
 * @wait: duration for ROC
 * @buf: buffer to transmit
 * @len: buffer length
 * @no_cck: don't use cck rates for this frame
 * @dont_wait_for_ack: tells the low level not to wait for an ack
 */
struct cfg80211_mgmt_tx_params {
	struct ieee80211_channel *chan;
	bool offchan;
	unsigned int wait;
	const u8 *buf;
	size_t len;
	bool no_cck;
	bool dont_wait_for_ack;
};

2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
/**
 * struct cfg80211_dscp_exception - DSCP exception
 *
 * @dscp: DSCP value that does not adhere to the user priority range definition
 * @up: user priority value to which the corresponding DSCP value belongs
 */
struct cfg80211_dscp_exception {
	u8 dscp;
	u8 up;
};

/**
 * struct cfg80211_dscp_range - DSCP range definition for user priority
 *
 * @low: lowest DSCP value of this user priority range, inclusive
 * @high: highest DSCP value of this user priority range, inclusive
 */
struct cfg80211_dscp_range {
	u8 low;
	u8 high;
};

/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
#define IEEE80211_QOS_MAP_MAX_EX	21
#define IEEE80211_QOS_MAP_LEN_MIN	16
#define IEEE80211_QOS_MAP_LEN_MAX \
	(IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)

/**
 * struct cfg80211_qos_map - QoS Map Information
 *
 * This struct defines the Interworking QoS map setting for DSCP values
 *
 * @num_des: number of DSCP exceptions (0..21)
 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
 *	the user priority DSCP range definition
 * @up: DSCP range definition for a particular user priority
 */
struct cfg80211_qos_map {
	u8 num_des;
	struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
	struct cfg80211_dscp_range up[8];
};

2044 2045 2046 2047 2048 2049 2050 2051 2052
/**
 * 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.
 *
2053 2054 2055 2056
 * 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 已提交
2057 2058 2059
 * @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 已提交
2060
 * @resume: wiphy device needs to be resumed
2061 2062 2063
 * @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 已提交
2064
 *
J
Johannes Berg 已提交
2065
 * @add_virtual_intf: create a new virtual interface with the given name,
2066
 *	must set the struct wireless_dev's iftype. Beware: You must create
2067
 *	the new netdev in the wiphy's network namespace! Returns the struct
2068 2069
 *	wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
 *	also set the address member in the wdev.
2070
 *
2071
 * @del_virtual_intf: remove the virtual interface
2072
 *
J
Johannes Berg 已提交
2073 2074
 * @change_virtual_intf: change type/configuration of virtual interface,
 *	keep the struct wireless_dev's iftype updated.
2075
 *
2076 2077 2078 2079 2080 2081
 * @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
2082 2083
 *	after it returns. This function should return an error if it is
 *	not possible to retrieve the key, -ENOENT if it doesn't exist.
2084 2085
 *
 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2086
 *	and @key_index, return -ENOENT if the key doesn't exist.
2087 2088
 *
 * @set_default_key: set the default key on an interface
2089
 *
2090 2091
 * @set_default_mgmt_key: set the default management frame key on an interface
 *
2092 2093
 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
 *
J
Johannes Berg 已提交
2094 2095 2096 2097
 * @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.
2098 2099 2100
 *
 * @add_station: Add a new station.
 * @del_station: Remove a station; @mac may be NULL to remove all stations.
2101 2102 2103
 * @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
2104 2105
 *	them, also against the existing state! Drivers must call
 *	cfg80211_check_station_change() to validate the information.
J
Johannes Berg 已提交
2106 2107 2108 2109 2110 2111 2112 2113
 * @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
2114
 * @join_mesh: join the mesh network with the specified parameters
2115
 *	(invoked with the wireless_dev mutex held)
2116
 * @leave_mesh: leave the current mesh network
2117
 *	(invoked with the wireless_dev mutex held)
2118
 *
2119
 * @get_mesh_config: Get the current mesh configuration
2120
 *
2121
 * @update_mesh_config: Update mesh parameters on a running mesh.
2122 2123 2124
 *	The mask is a bitfield which tells us which parameters to
 *	set, and which to leave alone.
 *
2125
 * @change_bss: Modify parameters for a given BSS.
2126 2127
 *
 * @set_txq_params: Set TX queue parameters
2128
 *
2129 2130 2131 2132 2133 2134 2135 2136
 * @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.
2137
 *
2138 2139 2140 2141
 * @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.
2142 2143
 *
 * @auth: Request to authenticate with the specified peer
2144
 *	(invoked with the wireless_dev mutex held)
2145
 * @assoc: Request to (re)associate with the specified peer
2146
 *	(invoked with the wireless_dev mutex held)
2147
 * @deauth: Request to deauthenticate from the specified peer
2148
 *	(invoked with the wireless_dev mutex held)
2149
 * @disassoc: Request to disassociate from the specified peer
2150
 *	(invoked with the wireless_dev mutex held)
J
Johannes Berg 已提交
2151
 *
S
Samuel Ortiz 已提交
2152 2153 2154 2155
 * @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.
2156
 *	(invoked with the wireless_dev mutex held)
S
Samuel Ortiz 已提交
2157
 * @disconnect: Disconnect from the BSS/ESS.
2158
 *	(invoked with the wireless_dev mutex held)
S
Samuel Ortiz 已提交
2159
 *
J
Johannes Berg 已提交
2160 2161 2162
 * @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.
2163
 *	(invoked with the wireless_dev mutex held)
J
Johannes Berg 已提交
2164
 * @leave_ibss: Leave the IBSS.
2165
 *	(invoked with the wireless_dev mutex held)
2166
 *
2167 2168 2169
 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
 *	MESH mode)
 *
2170 2171 2172 2173
 * @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.
2174
 *
2175
 * @set_tx_power: set the transmit power according to the parameters,
2176 2177 2178 2179
 *	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.)
2180
 * @get_tx_power: store the current TX power into the dbm variable;
J
Johannes Berg 已提交
2181 2182
 *	return 0 if successful
 *
J
Johannes Berg 已提交
2183 2184
 * @set_wds_peer: set the WDS peer for a WDS interface
 *
J
Johannes Berg 已提交
2185 2186
 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
 *	functions to adjust rfkill hw state
2187
 *
2188 2189
 * @dump_survey: get site survey information.
 *
2190 2191 2192 2193 2194 2195 2196 2197
 * @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.
2198 2199 2200
 * @mgmt_tx: Transmit a management frame.
 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
 *	frame on another channel
2201
 *
2202
 * @testmode_cmd: run a test mode command; @wdev may be %NULL
W
Wey-Yi Guy 已提交
2203 2204 2205 2206 2207 2208
 * @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 已提交
2209
 *
J
Johannes Berg 已提交
2210 2211
 * @set_bitrate_mask: set the bitrate mask configuration
 *
S
Samuel Ortiz 已提交
2212 2213 2214 2215 2216
 * @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.
2217 2218
 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
 *	allows the driver to adjust the dynamic ps timeout value.
2219
 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2220 2221
 * @set_cqm_txe_config: Configure connection quality monitor TX error
 *	thresholds.
2222
 * @sched_scan_start: Tell the driver to start a scheduled scan.
2223 2224 2225 2226 2227 2228
 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
 *	call must stop the scheduled scan and be ready for starting a new one
 *	before it returns, i.e. @sched_scan_start may be called immediately
 *	after that again and should not fail in that case. The driver should
 *	not call cfg80211_sched_scan_stopped() for a requested stop (when this
 *	method returns 0.)
S
Samuel Ortiz 已提交
2229
 *
2230 2231 2232
 * @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.
2233 2234 2235 2236 2237 2238 2239
 *
 * @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).
2240 2241 2242 2243
 *
 * @set_ringparam: Set tx and rx ring sizes.
 *
 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2244 2245 2246
 *
 * @tdls_mgmt: Transmit a TDLS management frame.
 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
J
Johannes Berg 已提交
2247 2248 2249
 *
 * @probe_client: probe an associated client, must return a cookie that it
 *	later passes to cfg80211_probe_status().
2250 2251
 *
 * @set_noack_map: Set the NoAck Map for the TIDs.
2252 2253 2254 2255 2256 2257 2258 2259 2260 2261
 *
 * @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
2262 2263 2264 2265
 *
 * @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.
2266 2267 2268
 *
 * @start_p2p_device: Start the given P2P device.
 * @stop_p2p_device: Stop the given P2P device.
2269 2270 2271 2272 2273 2274 2275
 *
 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
 *	Parameters include ACL policy, an array of MAC address of stations
 *	and the number of MAC addresses. If there is already a list in driver
 *	this new list replaces the existing one. Driver has to clear its ACL
 *	when number of MAC addresses entries is passed as 0. Drivers which
 *	advertise the support for MAC based ACL have to implement this callback.
2276 2277
 *
 * @start_radar_detection: Start radar detection in the driver.
2278 2279 2280 2281
 *
 * @update_ft_ies: Provide updated Fast BSS Transition information to the
 *	driver. If the SME is in the driver/firmware, this information can be
 *	used in building Authentication and Reassociation Request frames.
2282 2283 2284 2285 2286 2287
 *
 * @crit_proto_start: Indicates a critical protocol needs more link reliability
 *	for a given duration (milliseconds). The protocol is provided so the
 *	driver can take the most appropriate actions.
 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
 *	reliability. This operation can not fail.
2288
 * @set_coalesce: Set coalesce parameters.
2289 2290
 *
 * @channel_switch: initiate channel-switch procedure (with CSA)
2291 2292
 *
 * @set_qos_map: Set QoS mapping information to the driver
2293 2294 2295 2296
 *
 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
 *	given interface This is used e.g. for dynamic HT 20/40 MHz channel width
 *	changes during the lifetime of the BSS.
2297 2298
 */
struct cfg80211_ops {
J
Johannes Berg 已提交
2299
	int	(*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
J
Johannes Berg 已提交
2300
	int	(*resume)(struct wiphy *wiphy);
2301
	void	(*set_wakeup)(struct wiphy *wiphy, bool enabled);
J
Johannes Berg 已提交
2302

2303
	struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2304
						  const char *name,
2305 2306 2307 2308 2309
						  enum nl80211_iftype type,
						  u32 *flags,
						  struct vif_params *params);
	int	(*del_virtual_intf)(struct wiphy *wiphy,
				    struct wireless_dev *wdev);
2310 2311
	int	(*change_virtual_intf)(struct wiphy *wiphy,
				       struct net_device *dev,
2312 2313
				       enum nl80211_iftype type, u32 *flags,
				       struct vif_params *params);
2314 2315

	int	(*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2316
			   u8 key_index, bool pairwise, const u8 *mac_addr,
2317 2318
			   struct key_params *params);
	int	(*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2319 2320
			   u8 key_index, bool pairwise, const u8 *mac_addr,
			   void *cookie,
2321 2322
			   void (*callback)(void *cookie, struct key_params*));
	int	(*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2323
			   u8 key_index, bool pairwise, const u8 *mac_addr);
2324 2325
	int	(*set_default_key)(struct wiphy *wiphy,
				   struct net_device *netdev,
2326
				   u8 key_index, bool unicast, bool multicast);
2327 2328 2329
	int	(*set_default_mgmt_key)(struct wiphy *wiphy,
					struct net_device *netdev,
					u8 key_index);
2330

2331 2332 2333 2334 2335
	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);
2336 2337 2338 2339 2340 2341 2342 2343


	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);
2344
	int	(*get_station)(struct wiphy *wiphy, struct net_device *dev,
2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
			       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);
2361
	int	(*get_mesh_config)(struct wiphy *wiphy,
2362 2363
				struct net_device *dev,
				struct mesh_config *conf);
2364
	int	(*update_mesh_config)(struct wiphy *wiphy,
2365 2366 2367 2368 2369 2370 2371
				      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);

2372 2373
	int	(*change_bss)(struct wiphy *wiphy, struct net_device *dev,
			      struct bss_parameters *params);
2374

2375
	int	(*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2376
				  struct ieee80211_txq_params *params);
2377

2378 2379 2380 2381 2382
	int	(*libertas_set_mesh_channel)(struct wiphy *wiphy,
					     struct net_device *dev,
					     struct ieee80211_channel *chan);

	int	(*set_monitor_channel)(struct wiphy *wiphy,
2383
				       struct cfg80211_chan_def *chandef);
2384

J
Johannes Berg 已提交
2385
	int	(*scan)(struct wiphy *wiphy,
2386
			struct cfg80211_scan_request *request);
2387 2388 2389 2390 2391 2392

	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,
2393
			  struct cfg80211_deauth_request *req);
2394
	int	(*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2395
			    struct cfg80211_disassoc_request *req);
J
Johannes Berg 已提交
2396

S
Samuel Ortiz 已提交
2397 2398 2399 2400 2401
	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 已提交
2402 2403 2404
	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);
2405

2406 2407 2408
	int	(*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
				  int rate[IEEE80211_NUM_BANDS]);

2409
	int	(*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2410

2411
	int	(*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2412
				enum nl80211_tx_power_setting type, int mbm);
2413 2414
	int	(*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
				int *dbm);
J
Johannes Berg 已提交
2415

J
Johannes Berg 已提交
2416
	int	(*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
J
Johannes Berg 已提交
2417
				const u8 *addr);
J
Johannes Berg 已提交
2418

J
Johannes Berg 已提交
2419
	void	(*rfkill_poll)(struct wiphy *wiphy);
2420 2421

#ifdef CONFIG_NL80211_TESTMODE
2422 2423
	int	(*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
				void *data, int len);
W
Wey-Yi Guy 已提交
2424 2425 2426
	int	(*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
				 struct netlink_callback *cb,
				 void *data, int len);
2427
#endif
J
Johannes Berg 已提交
2428

J
Johannes Berg 已提交
2429 2430 2431 2432 2433
	int	(*set_bitrate_mask)(struct wiphy *wiphy,
				    struct net_device *dev,
				    const u8 *peer,
				    const struct cfg80211_bitrate_mask *mask);

2434 2435 2436
	int	(*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
			int idx, struct survey_info *info);

S
Samuel Ortiz 已提交
2437 2438 2439 2440 2441 2442
	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);

2443
	int	(*remain_on_channel)(struct wiphy *wiphy,
2444
				     struct wireless_dev *wdev,
2445 2446 2447 2448
				     struct ieee80211_channel *chan,
				     unsigned int duration,
				     u64 *cookie);
	int	(*cancel_remain_on_channel)(struct wiphy *wiphy,
2449
					    struct wireless_dev *wdev,
2450 2451
					    u64 cookie);

2452
	int	(*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2453 2454
			   struct cfg80211_mgmt_tx_params *params,
			   u64 *cookie);
2455
	int	(*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2456
				       struct wireless_dev *wdev,
2457
				       u64 cookie);
2458

J
Johannes Berg 已提交
2459 2460
	int	(*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
				  bool enabled, int timeout);
2461 2462 2463 2464

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

2466 2467 2468 2469
	int	(*set_cqm_txe_config)(struct wiphy *wiphy,
				      struct net_device *dev,
				      u32 rate, u32 pkts, u32 intvl);

2470
	void	(*mgmt_frame_register)(struct wiphy *wiphy,
2471
				       struct wireless_dev *wdev,
2472
				       u16 frame_type, bool reg);
2473 2474 2475

	int	(*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
	int	(*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2476 2477 2478 2479

	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);
2480 2481 2482 2483

	int	(*sched_scan_start)(struct wiphy *wiphy,
				struct net_device *dev,
				struct cfg80211_sched_scan_request *request);
2484
	int	(*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2485 2486 2487

	int	(*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
				  struct cfg80211_gtk_rekey_data *data);
2488 2489 2490

	int	(*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
			     u8 *peer, u8 action_code,  u8 dialog_token,
2491 2492
			     u16 status_code, u32 peer_capability,
			     const u8 *buf, size_t len);
2493 2494
	int	(*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
			     u8 *peer, enum nl80211_tdls_operation oper);
J
Johannes Berg 已提交
2495 2496 2497

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

2499 2500 2501 2502
	int	(*set_noack_map)(struct wiphy *wiphy,
				  struct net_device *dev,
				  u16 noack_map);

2503 2504 2505 2506 2507 2508
	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);
2509

2510
	int	(*get_channel)(struct wiphy *wiphy,
2511
			       struct wireless_dev *wdev,
2512
			       struct cfg80211_chan_def *chandef);
2513 2514 2515 2516 2517

	int	(*start_p2p_device)(struct wiphy *wiphy,
				    struct wireless_dev *wdev);
	void	(*stop_p2p_device)(struct wiphy *wiphy,
				   struct wireless_dev *wdev);
2518 2519 2520

	int	(*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
			       const struct cfg80211_acl_data *params);
2521 2522 2523

	int	(*start_radar_detection)(struct wiphy *wiphy,
					 struct net_device *dev,
2524 2525
					 struct cfg80211_chan_def *chandef,
					 u32 cac_time_ms);
2526 2527
	int	(*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
				 struct cfg80211_update_ft_ies_params *ftie);
2528 2529 2530 2531 2532 2533
	int	(*crit_proto_start)(struct wiphy *wiphy,
				    struct wireless_dev *wdev,
				    enum nl80211_crit_proto_id protocol,
				    u16 duration);
	void	(*crit_proto_stop)(struct wiphy *wiphy,
				   struct wireless_dev *wdev);
2534 2535
	int	(*set_coalesce)(struct wiphy *wiphy,
				struct cfg80211_coalesce *coalesce);
2536 2537 2538 2539

	int	(*channel_switch)(struct wiphy *wiphy,
				  struct net_device *dev,
				  struct cfg80211_csa_settings *params);
2540

2541 2542 2543
	int     (*set_qos_map)(struct wiphy *wiphy,
			       struct net_device *dev,
			       struct cfg80211_qos_map *qos_map);
2544 2545 2546

	int	(*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
				    struct cfg80211_chan_def *chandef);
2547 2548
};

J
Johannes Berg 已提交
2549 2550 2551 2552 2553 2554
/*
 * wireless hardware and networking interfaces structures
 * and registration/helper functions
 */

/**
J
Johannes Berg 已提交
2555 2556 2557 2558 2559 2560 2561 2562
 * enum wiphy_flags - wiphy capability flags
 *
 * @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
2563 2564 2565
 * @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
2566 2567 2568
 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
 *	control port protocol ethertype. The device also honours the
 *	control_port_no_encrypt flag.
2569
 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2570 2571
 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
 *	auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2572
 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2573 2574
 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
 *	firmware.
2575
 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2576 2577 2578 2579 2580 2581
 * @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 已提交
2582
 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2583 2584 2585
 * @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().
2586 2587
 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
 *	responds to probe-requests in hardware.
2588 2589
 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2590
 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2591 2592
 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
 *	beaconing mode (AP, IBSS, Mesh, ...).
J
Johannes Berg 已提交
2593 2594
 */
enum wiphy_flags {
2595 2596 2597
	/* use hole at 0 */
	/* use hole at 1 */
	/* use hole at 2 */
2598 2599 2600 2601 2602
	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),
2603
	WIPHY_FLAG_IBSS_RSN			= BIT(8),
2604
	WIPHY_FLAG_MESH_AUTH			= BIT(10),
2605
	WIPHY_FLAG_SUPPORTS_SCHED_SCAN		= BIT(11),
2606
	/* use hole at 12 */
2607
	WIPHY_FLAG_SUPPORTS_FW_ROAM		= BIT(13),
2608
	WIPHY_FLAG_AP_UAPSD			= BIT(14),
2609 2610
	WIPHY_FLAG_SUPPORTS_TDLS		= BIT(15),
	WIPHY_FLAG_TDLS_EXTERNAL_SETUP		= BIT(16),
J
Johannes Berg 已提交
2611
	WIPHY_FLAG_HAVE_AP_SME			= BIT(17),
2612
	WIPHY_FLAG_REPORTS_OBSS			= BIT(18),
2613
	WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD	= BIT(19),
2614 2615
	WIPHY_FLAG_OFFCHAN_TX			= BIT(20),
	WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL	= BIT(21),
2616
	WIPHY_FLAG_SUPPORTS_5_10_MHZ		= BIT(22),
2617
	WIPHY_FLAG_HAS_CHANNEL_SWITCH		= BIT(23),
2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639
};

/**
 * 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.
2640
 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2641
 *
2642 2643
 * With this structure the driver can describe which interface
 * combinations it supports concurrently.
2644
 *
2645 2646 2647
 * Examples:
 *
 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660
 *
 *  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,
 *  };
 *
 *
2661
 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674
 *
 *  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,
 *  };
 *
 *
2675 2676
 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
 *
2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696
 * 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;
2697
	u8 radar_detect_widths;
J
Johannes Berg 已提交
2698 2699
};

2700 2701 2702 2703
struct ieee80211_txrx_stypes {
	u16 tx, rx;
};

J
Johannes Berg 已提交
2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
/**
 * 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
2714 2715 2716 2717 2718
 * @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 已提交
2719 2720
 */
enum wiphy_wowlan_support_flags {
2721 2722 2723 2724 2725 2726 2727 2728
	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 已提交
2729 2730
};

2731 2732 2733 2734 2735 2736 2737 2738
struct wiphy_wowlan_tcp_support {
	const struct nl80211_wowlan_tcp_data_token_feature *tok;
	u32 data_payload_max;
	u32 data_interval_max;
	u32 wake_payload_max;
	bool seq;
};

J
Johannes Berg 已提交
2739 2740 2741 2742 2743 2744 2745
/**
 * 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
2746
 * @max_pkt_offset: maximum Rx packet offset
2747
 * @tcp: TCP wakeup support information
J
Johannes Berg 已提交
2748 2749 2750 2751 2752 2753
 */
struct wiphy_wowlan_support {
	u32 flags;
	int n_patterns;
	int pattern_max_len;
	int pattern_min_len;
2754
	int max_pkt_offset;
2755
	const struct wiphy_wowlan_tcp_support *tcp;
J
Johannes Berg 已提交
2756 2757
};

2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776
/**
 * struct wiphy_coalesce_support - coalesce support data
 * @n_rules: maximum number of coalesce rules
 * @max_delay: maximum supported coalescing delay in msecs
 * @n_patterns: number of supported patterns in a rule
 *	(see nl80211.h for the pattern definition)
 * @pattern_max_len: maximum length of each pattern
 * @pattern_min_len: minimum length of each pattern
 * @max_pkt_offset: maximum Rx packet offset
 */
struct wiphy_coalesce_support {
	int n_rules;
	int max_delay;
	int n_patterns;
	int pattern_max_len;
	int pattern_min_len;
	int max_pkt_offset;
};

J
Johannes Berg 已提交
2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804
/**
 * enum wiphy_vendor_command_flags - validation flags for vendor commands
 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
 *	(must be combined with %_WDEV or %_NETDEV)
 */
enum wiphy_vendor_command_flags {
	WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
	WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
	WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
};

/**
 * struct wiphy_vendor_command - vendor command definition
 * @info: vendor command identifying information, as used in nl80211
 * @flags: flags, see &enum wiphy_vendor_command_flags
 * @doit: callback for the operation, note that wdev is %NULL if the
 *	flags didn't ask for a wdev and non-%NULL otherwise; the data
 *	pointer may be %NULL if userspace provided no data at all
 */
struct wiphy_vendor_command {
	struct nl80211_vendor_cmd_info info;
	u32 flags;
	int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
		    const void *data, int data_len);
};

J
Johannes Berg 已提交
2805 2806
/**
 * struct wiphy - wireless hardware description
2807 2808 2809
 * @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 已提交
2810 2811 2812 2813 2814 2815 2816
 * @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
2817 2818 2819 2820 2821
 * @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 已提交
2822
 * @_net: the network namespace this wiphy currently lives in
2823 2824 2825
 * @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
2826
 *	four bits are variable then set it to 00-00-00-00-00-0f. The actual
2827 2828 2829 2830 2831 2832 2833 2834
 *	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.
2835 2836
 * @registered: protects ->resume and ->suspend sysfs callbacks against
 *	unregister hardware
J
Johannes Berg 已提交
2837 2838 2839
 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
 *	automatically on wiphy renames
 * @dev: (virtual) struct device for this wiphy
2840
 * @registered: helps synchronize suspend/resume with wiphy unregister
J
Johannes Berg 已提交
2841 2842 2843 2844
 * @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
2845 2846 2847 2848 2849
 * @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 已提交
2850
 * @flags: wiphy flags, see &enum wiphy_flags
2851 2852
 * @regulatory_flags: wiphy regulatory flags, see
 *	&enum ieee80211_regulatory_flags
2853
 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
J
Johannes Berg 已提交
2854 2855 2856 2857
 * @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
2858 2859
 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
 *	for in any given scheduled scan
2860 2861 2862
 * @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 已提交
2863 2864 2865
 * @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
2866 2867
 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
 *	scans
J
Johannes Berg 已提交
2868 2869 2870 2871 2872 2873 2874
 * @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
2875 2876 2877 2878
 *
 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
 *	transmitted through nl80211, points to an array indexed by interface
 *	type
2879
 *
2880 2881 2882 2883 2884 2885 2886
 * @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.
2887
 *
2888 2889 2890 2891 2892
 * @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.
 *
2893 2894
 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
 *	may request, if implemented.
J
Johannes Berg 已提交
2895 2896
 *
 * @wowlan: WoWLAN support information
2897 2898 2899
 * @wowlan_config: current WoWLAN configuration; this should usually not be
 *	used since access to it is necessarily racy, use the parameter passed
 *	to the suspend() operation instead.
J
Johannes Berg 已提交
2900 2901
 *
 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2902 2903
 * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
 *	If null, then none can be over-ridden.
2904 2905
 * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
 *	If null, then none can be over-ridden.
2906 2907 2908
 *
 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
 *	supports for ACL.
2909 2910 2911 2912 2913 2914 2915 2916
 *
 * @extended_capabilities: extended capabilities supported by the driver,
 *	additional capabilities might be supported by userspace; these are
 *	the 802.11 extended capabilities ("Extended Capabilities element")
 *	and are in the same format as in the information element. See
 *	802.11-2012 8.4.2.29 for the defined fields.
 * @extended_capabilities_mask: mask of the valid values
 * @extended_capabilities_len: length of the extended capabilities
2917
 * @coalesce: packet coalescing support information
J
Johannes Berg 已提交
2918 2919 2920
 *
 * @vendor_commands: array of vendor commands supported by the hardware
 * @n_vendor_commands: number of vendor commands
2921 2922
 * @vendor_events: array of vendor events supported by the hardware
 * @n_vendor_events: number of vendor events
2923 2924 2925 2926 2927
 *
 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
 *	(including P2P GO) or 0 to indicate no such limit is advertised. The
 *	driver is allowed to advertise a theoretical limit that it can reach in
 *	some cases, but may not always reach.
J
Johannes Berg 已提交
2928 2929 2930 2931
 */
struct wiphy {
	/* assign these fields before you register the wiphy */

2932
	/* permanent MAC address(es) */
J
Johannes Berg 已提交
2933
	u8 perm_addr[ETH_ALEN];
2934 2935 2936
	u8 addr_mask[ETH_ALEN];

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

2938 2939
	const struct ieee80211_txrx_stypes *mgmt_stypes;

2940 2941 2942 2943
	const struct ieee80211_iface_combination *iface_combinations;
	int n_iface_combinations;
	u16 software_iftypes;

2944 2945
	u16 n_addresses;

J
Johannes Berg 已提交
2946 2947 2948
	/* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
	u16 interface_modes;

2949 2950
	u16 max_acl_mac_addrs;

2951
	u32 flags, regulatory_flags, features;
2952

J
Johannes Berg 已提交
2953 2954
	u32 ap_sme_capa;

J
Johannes Berg 已提交
2955 2956 2957 2958
	enum cfg80211_signal_type signal_type;

	int bss_priv_size;
	u8 max_scan_ssids;
2959
	u8 max_sched_scan_ssids;
2960
	u8 max_match_sets;
J
Johannes Berg 已提交
2961
	u16 max_scan_ie_len;
2962
	u16 max_sched_scan_ie_len;
J
Johannes Berg 已提交
2963 2964 2965 2966

	int n_cipher_suites;
	const u32 *cipher_suites;

2967 2968 2969 2970
	u8 retry_short;
	u8 retry_long;
	u32 frag_threshold;
	u32 rts_threshold;
2971
	u8 coverage_class;
2972

2973
	char fw_version[ETHTOOL_FWVERS_LEN];
2974 2975
	u32 hw_version;

2976
#ifdef CONFIG_PM
2977
	const struct wiphy_wowlan_support *wowlan;
2978
	struct cfg80211_wowlan *wowlan_config;
2979
#endif
J
Johannes Berg 已提交
2980

2981 2982
	u16 max_remain_on_channel_duration;

S
Samuel Ortiz 已提交
2983 2984
	u8 max_num_pmkids;

2985 2986
	u32 available_antennas_tx;
	u32 available_antennas_rx;
2987

2988 2989 2990 2991 2992 2993 2994
	/*
	 * 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;

2995 2996 2997
	const u8 *extended_capabilities, *extended_capabilities_mask;
	u8 extended_capabilities_len;

J
Johannes Berg 已提交
2998 2999 3000 3001 3002
	/* 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. */
3003
	const void *privid;
J
Johannes Berg 已提交
3004 3005 3006 3007

	struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];

	/* Lets us get back the wiphy on the callback */
3008 3009
	void (*reg_notifier)(struct wiphy *wiphy,
			     struct regulatory_request *request);
J
Johannes Berg 已提交
3010 3011 3012

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

3013
	const struct ieee80211_regdomain __rcu *regd;
J
Johannes Berg 已提交
3014 3015 3016 3017 3018

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

3019 3020 3021
	/* protects ->resume, ->suspend sysfs callbacks against unregister hw */
	bool registered;

J
Johannes Berg 已提交
3022 3023 3024
	/* dir in debugfs: ieee80211/<wiphyname> */
	struct dentry *debugfsdir;

3025
	const struct ieee80211_ht_cap *ht_capa_mod_mask;
3026
	const struct ieee80211_vht_cap *vht_capa_mod_mask;
3027

3028 3029 3030 3031 3032
#ifdef CONFIG_NET_NS
	/* the network namespace this phy lives in currently */
	struct net *_net;
#endif

J
Johannes Berg 已提交
3033 3034 3035 3036
#ifdef CONFIG_CFG80211_WEXT
	const struct iw_handler_def *wext;
#endif

3037 3038
	const struct wiphy_coalesce_support *coalesce;

J
Johannes Berg 已提交
3039
	const struct wiphy_vendor_command *vendor_commands;
3040 3041
	const struct nl80211_vendor_cmd_info *vendor_events;
	int n_vendor_commands, n_vendor_events;
J
Johannes Berg 已提交
3042

3043 3044
	u16 max_ap_assoc_sta;

J
Johannes Berg 已提交
3045
	char priv[0] __aligned(NETDEV_ALIGN);
J
Johannes Berg 已提交
3046 3047
};

3048 3049
static inline struct net *wiphy_net(struct wiphy *wiphy)
{
E
Eric Dumazet 已提交
3050
	return read_pnet(&wiphy->_net);
3051 3052 3053 3054
}

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

J
Johannes Berg 已提交
3058 3059 3060 3061
/**
 * wiphy_priv - return priv from wiphy
 *
 * @wiphy: the wiphy whose priv pointer to return
3062
 * Return: The priv of @wiphy.
J
Johannes Berg 已提交
3063 3064 3065 3066 3067 3068 3069
 */
static inline void *wiphy_priv(struct wiphy *wiphy)
{
	BUG_ON(!wiphy);
	return &wiphy->priv;
}

3070 3071 3072 3073
/**
 * priv_to_wiphy - return the wiphy containing the priv
 *
 * @priv: a pointer previously returned by wiphy_priv
3074
 * Return: The wiphy of @priv.
3075 3076 3077 3078 3079 3080 3081
 */
static inline struct wiphy *priv_to_wiphy(void *priv)
{
	BUG_ON(!priv);
	return container_of(priv, struct wiphy, priv);
}

J
Johannes Berg 已提交
3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096
/**
 * 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
3097
 * Return: The dev of @wiphy.
J
Johannes Berg 已提交
3098 3099 3100 3101 3102 3103 3104 3105 3106 3107
 */
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
3108
 * Return: The name of @wiphy.
J
Johannes Berg 已提交
3109
 */
3110
static inline const char *wiphy_name(const struct wiphy *wiphy)
J
Johannes Berg 已提交
3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
{
	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.
 *
3124 3125
 * Return: A pointer to the new wiphy. This pointer must be
 * assigned to each netdev's ieee80211_ptr for proper operation.
J
Johannes Berg 已提交
3126
 */
3127
struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
J
Johannes Berg 已提交
3128 3129 3130 3131 3132 3133

/**
 * wiphy_register - register a wiphy with cfg80211
 *
 * @wiphy: The wiphy to register.
 *
3134
 * Return: A non-negative wiphy index or a negative error code.
J
Johannes Berg 已提交
3135
 */
3136
int wiphy_register(struct wiphy *wiphy);
J
Johannes Berg 已提交
3137 3138 3139 3140 3141 3142 3143 3144 3145 3146

/**
 * 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.
 */
3147
void wiphy_unregister(struct wiphy *wiphy);
J
Johannes Berg 已提交
3148 3149 3150 3151 3152 3153

/**
 * wiphy_free - free wiphy
 *
 * @wiphy: The wiphy to free
 */
3154
void wiphy_free(struct wiphy *wiphy);
J
Johannes Berg 已提交
3155

J
Johannes Berg 已提交
3156
/* internal structs */
3157
struct cfg80211_conn;
J
Johannes Berg 已提交
3158
struct cfg80211_internal_bss;
J
Johannes Berg 已提交
3159
struct cfg80211_cached_keys;
J
Johannes Berg 已提交
3160

J
Johannes Berg 已提交
3161
/**
3162
 * struct wireless_dev - wireless device state
J
Johannes Berg 已提交
3163
 *
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173
 * 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 已提交
3174 3175 3176 3177
 *
 * @wiphy: pointer to hardware description
 * @iftype: interface type
 * @list: (private) Used to collect the interfaces
3178 3179 3180
 * @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 已提交
3181
 * @current_bss: (private) Used by the internal configuration code
3182 3183
 * @chandef: (private) Used by the internal configuration code to track
 *	the user-set channel definition.
J
Johannes Berg 已提交
3184
 * @preset_chandef: (private) Used by the internal configuration code to
3185
 *	track the channel to be used for AP later
J
Johannes Berg 已提交
3186 3187 3188
 * @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
3189 3190
 * @mesh_id_len: (private) Used by the internal configuration code
 * @mesh_id_up_len: (private) Used by the internal configuration code
J
Johannes Berg 已提交
3191
 * @wext: (private) Used by the internal wireless extensions compat code
3192 3193 3194 3195
 * @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
3196 3197
 * @mgmt_registrations: list of registrations for management frames
 * @mgmt_registrations_lock: lock for the list
3198 3199
 * @mtx: mutex used to lock data in this struct, may be used by drivers
 *	and some API functions require it held
3200 3201
 * @beacon_interval: beacon interval used on this device for transmitting
 *	beacons, 0 when not valid
3202 3203
 * @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
3204 3205
 * @cac_started: true if DFS channel availability check has been started
 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3206
 * @cac_time_ms: CAC time in ms
J
Johannes Berg 已提交
3207 3208 3209 3210 3211 3212 3213
 * @ps: powersave mode is enabled
 * @ps_timeout: dynamic powersave timeout
 * @ap_unexpected_nlportid: (private) netlink port ID of application
 *	registered for unexpected class 3 frames (AP mode)
 * @conn: (private) cfg80211 software SME connection state machine data
 * @connect_keys: (private) keys to set after connection is established
 * @ibss_fixed: (private) IBSS is using fixed BSSID
3214
 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
J
Johannes Berg 已提交
3215 3216
 * @event_list: (private) list for internal event processing
 * @event_lock: (private) lock for event list
3217
 * @owner_nlportid: (private) owner socket port ID
J
Johannes Berg 已提交
3218 3219 3220 3221 3222
 */
struct wireless_dev {
	struct wiphy *wiphy;
	enum nl80211_iftype iftype;

J
Johannes Berg 已提交
3223
	/* the remainder of this struct should be private to cfg80211 */
J
Johannes Berg 已提交
3224 3225 3226
	struct list_head list;
	struct net_device *netdev;

3227 3228
	u32 identifier;

3229 3230
	struct list_head mgmt_registrations;
	spinlock_t mgmt_registrations_lock;
3231

J
Johannes Berg 已提交
3232 3233
	struct mutex mtx;

3234 3235 3236
	bool use_4addr, p2p_started;

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

S
Samuel Ortiz 已提交
3238
	/* currently used for IBSS and SME - might be rearranged later */
J
Johannes Berg 已提交
3239
	u8 ssid[IEEE80211_MAX_SSID_LEN];
3240
	u8 ssid_len, mesh_id_len, mesh_id_up_len;
3241
	struct cfg80211_conn *conn;
J
Johannes Berg 已提交
3242
	struct cfg80211_cached_keys *connect_keys;
J
Johannes Berg 已提交
3243

J
Johannes Berg 已提交
3244 3245 3246
	struct list_head event_list;
	spinlock_t event_lock;

J
Johannes Berg 已提交
3247
	struct cfg80211_internal_bss *current_bss; /* associated / joined */
3248
	struct cfg80211_chan_def preset_chandef;
3249
	struct cfg80211_chan_def chandef;
3250

3251
	bool ibss_fixed;
3252
	bool ibss_dfs_possible;
3253

K
Kalle Valo 已提交
3254 3255 3256
	bool ps;
	int ps_timeout;

3257 3258
	int beacon_interval;

3259
	u32 ap_unexpected_nlportid;
3260

3261 3262
	bool cac_started;
	unsigned long cac_start_time;
3263
	unsigned int cac_time_ms;
3264

3265 3266
	u32 owner_nlportid;

J
Johannes Berg 已提交
3267
#ifdef CONFIG_CFG80211_WEXT
J
Johannes Berg 已提交
3268
	/* wext data */
3269
	struct {
3270 3271
		struct cfg80211_ibss_params ibss;
		struct cfg80211_connect_params connect;
J
Johannes Berg 已提交
3272
		struct cfg80211_cached_keys *keys;
3273 3274
		u8 *ie;
		size_t ie_len;
3275
		u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3276
		u8 ssid[IEEE80211_MAX_SSID_LEN];
3277
		s8 default_key, default_mgmt_key;
K
Kalle Valo 已提交
3278
		bool prev_bssid_valid;
3279
	} wext;
J
Johannes Berg 已提交
3280 3281 3282
#endif
};

3283 3284 3285 3286 3287 3288 3289
static inline u8 *wdev_address(struct wireless_dev *wdev)
{
	if (wdev->netdev)
		return wdev->netdev->dev_addr;
	return wdev->address;
}

J
Johannes Berg 已提交
3290 3291 3292 3293
/**
 * wdev_priv - return wiphy priv from wireless_dev
 *
 * @wdev: The wireless device whose wiphy's priv pointer to return
3294
 * Return: The wiphy priv of @wdev.
J
Johannes Berg 已提交
3295 3296 3297 3298 3299 3300 3301
 */
static inline void *wdev_priv(struct wireless_dev *wdev)
{
	BUG_ON(!wdev);
	return wiphy_priv(wdev->wiphy);
}

J
Johannes Berg 已提交
3302 3303 3304 3305
/**
 * DOC: Utility functions
 *
 * cfg80211 offers a number of utility functions that can be useful.
J
Johannes Berg 已提交
3306 3307 3308 3309
 */

/**
 * ieee80211_channel_to_frequency - convert channel number to frequency
J
Johannes Berg 已提交
3310
 * @chan: channel number
3311
 * @band: band, necessary due to channel number overlap
3312
 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
J
Johannes Berg 已提交
3313
 */
3314
int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
J
Johannes Berg 已提交
3315 3316 3317

/**
 * ieee80211_frequency_to_channel - convert frequency to channel number
J
Johannes Berg 已提交
3318
 * @freq: center frequency
3319
 * Return: The corresponding channel, or 0 if the conversion failed.
J
Johannes Berg 已提交
3320
 */
3321
int ieee80211_frequency_to_channel(int freq);
J
Johannes Berg 已提交
3322 3323 3324 3325 3326 3327 3328 3329

/*
 * 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.
 */
3330 3331
struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
						  int freq);
J
Johannes Berg 已提交
3332 3333
/**
 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
J
Johannes Berg 已提交
3334 3335
 * @wiphy: the struct wiphy to get the channel for
 * @freq: the center frequency of the channel
3336
 * Return: The channel struct from @wiphy at @freq.
J
Johannes Berg 已提交
3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350
 */
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
 *
3351 3352 3353 3354
 * 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 已提交
3355 3356 3357 3358 3359
 */
struct ieee80211_rate *
ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
			    u32 basic_rates, int bitrate);

3360 3361 3362
/**
 * ieee80211_mandatory_rates - get mandatory rates for a given band
 * @sband: the band to look for rates in
3363
 * @scan_width: width of the control channel
3364 3365 3366 3367
 *
 * This function returns a bitmap of the mandatory rates for the given
 * band, bits are set according to the rate position in the bitrates array.
 */
3368 3369
u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
			      enum nl80211_bss_scan_width scan_width);
3370

J
Johannes Berg 已提交
3371 3372 3373 3374 3375 3376 3377
/*
 * Radiotap parsing functions -- for controlled injection support
 *
 * Implemented in net/wireless/radiotap.c
 * Documentation in Documentation/networking/radiotap-headers.txt
 */

J
Johannes Berg 已提交
3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393
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 已提交
3394 3395
/**
 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
J
Johannes Berg 已提交
3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420
 * @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 已提交
3421 3422 3423
 */

struct ieee80211_radiotap_iterator {
J
Johannes Berg 已提交
3424 3425 3426 3427 3428
	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;
3429
	__le32 *_next_bitmap;
J
Johannes Berg 已提交
3430 3431

	unsigned char *this_arg;
J
Johannes Berg 已提交
3432
	int this_arg_index;
J
Johannes Berg 已提交
3433
	int this_arg_size;
J
Johannes Berg 已提交
3434

J
Johannes Berg 已提交
3435 3436 3437 3438 3439 3440
	int is_radiotap_ns;

	int _max_length;
	int _arg_index;
	uint32_t _bitmap_shifter;
	int _reset_on_ext;
J
Johannes Berg 已提交
3441 3442
};

3443 3444 3445 3446 3447
int
ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
				 struct ieee80211_radiotap_header *radiotap_header,
				 int max_length,
				 const struct ieee80211_radiotap_vendor_namespaces *vns);
J
Johannes Berg 已提交
3448

3449 3450
int
ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
J
Johannes Berg 已提交
3451

J
Johannes Berg 已提交
3452

3453 3454 3455 3456 3457 3458
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
 *
3459 3460
 * @skb: the frame
 *
3461
 * Given an skb with a raw 802.11 header at the data pointer this function
3462
 * returns the 802.11 header length.
3463
 *
3464 3465 3466
 * 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.
3467 3468 3469 3470 3471 3472
 */
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
3473
 * Return: The header length in bytes.
3474
 */
3475
unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3476

3477 3478 3479 3480
/**
 * ieee80211_get_mesh_hdrlen - get mesh extension header length
 * @meshhdr: the mesh extension header, only the flags field
 *	(first byte) will be accessed
3481
 * Return: The length of the extension header, which is always at
3482 3483 3484 3485
 * 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 已提交
3486 3487 3488 3489 3490 3491 3492 3493
/**
 * 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.
 */

3494 3495 3496 3497 3498
/**
 * 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
3499
 * Return: 0 on success. Non-zero on error.
3500
 */
Z
Zhu Yi 已提交
3501
int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3502 3503 3504 3505 3506 3507 3508 3509 3510
			   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
3511
 * Return: 0 on success, or a negative error code.
3512
 */
Z
Zhu Yi 已提交
3513
int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3514 3515
			     enum nl80211_iftype iftype, u8 *bssid, bool qos);

Z
Zhu Yi 已提交
3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528
/**
 * 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.
3529
 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
Z
Zhu Yi 已提交
3530 3531 3532
 */
void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
			      const u8 *addr, enum nl80211_iftype iftype,
3533 3534
			      const unsigned int extra_headroom,
			      bool has_80211_header);
Z
Zhu Yi 已提交
3535

3536 3537 3538
/**
 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
 * @skb: the data frame
3539
 * @qos_map: Interworking QoS mapping or %NULL if not in use
3540
 * Return: The 802.1p/1d tag.
3541
 */
3542 3543
unsigned int cfg80211_classify8021d(struct sk_buff *skb,
				    struct cfg80211_qos_map *qos_map);
3544

3545 3546 3547 3548 3549 3550 3551
/**
 * cfg80211_find_ie - find information element in data
 *
 * @eid: element ID
 * @ies: data consisting of IEs
 * @len: length of data
 *
3552 3553 3554 3555 3556 3557 3558
 * 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.
3559 3560 3561
 */
const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);

3562 3563 3564 3565 3566 3567 3568 3569
/**
 * 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
 *
3570 3571 3572 3573 3574 3575 3576
 * 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.
3577 3578 3579 3580
 */
const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
				  const u8 *ies, int len);

J
Johannes Berg 已提交
3581 3582 3583 3584
/**
 * DOC: Regulatory enforcement infrastructure
 *
 * TODO
J
Johannes Berg 已提交
3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608
 */

/**
 * 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.
3609 3610
 *
 * Return: 0 on success. -ENOMEM.
J
Johannes Berg 已提交
3611
 */
3612
int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
J
Johannes Berg 已提交
3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624

/**
 * 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.
3625
 * Drivers using this for a wiphy should also set the wiphy flag
3626
 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
3627
 * that called this helper.
J
Johannes Berg 已提交
3628
 */
3629 3630
void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
				   const struct ieee80211_regdomain *regd);
J
Johannes Berg 已提交
3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641

/**
 * 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.
 *
3642 3643 3644 3645 3646 3647 3648
 * 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 已提交
3649
 */
3650 3651
const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
					       u32 center_freq);
J
Johannes Berg 已提交
3652

3653 3654 3655 3656 3657 3658 3659 3660 3661
/**
 * reg_initiator_name - map regulatory request initiator enum to name
 * @initiator: the regulatory request initiator
 *
 * You can use this to map the regulatory request initiator enum to a
 * proper string representation.
 */
const char *reg_initiator_name(enum nl80211_reg_initiator initiator);

J
Johannes Berg 已提交
3662 3663 3664 3665 3666
/*
 * callbacks for asynchronous cfg80211 methods, notification
 * functions and BSS handling helpers
 */

3667 3668 3669 3670 3671 3672 3673 3674 3675
/**
 * 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);

3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693
/**
 * 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);

3694
/**
3695
 * cfg80211_inform_bss_width_frame - inform cfg80211 of a received BSS frame
3696 3697
 *
 * @wiphy: the wiphy reporting the BSS
3698
 * @rx_channel: The channel the frame was received on
3699
 * @scan_width: width of the control channel
J
Johannes Berg 已提交
3700 3701
 * @mgmt: the management frame (probe response or beacon)
 * @len: length of the management frame
J
Johannes Berg 已提交
3702
 * @signal: the signal strength, type depends on the wiphy's signal_type
3703 3704 3705 3706
 * @gfp: context flags
 *
 * This informs cfg80211 that BSS information was found and
 * the BSS should be updated/added.
3707
 *
3708 3709
 * Return: A referenced struct, must be released with cfg80211_put_bss()!
 * Or %NULL on error.
3710
 */
3711
struct cfg80211_bss * __must_check
3712
cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
3713
				struct ieee80211_channel *rx_channel,
3714 3715 3716 3717 3718
				enum nl80211_bss_scan_width scan_width,
				struct ieee80211_mgmt *mgmt, size_t len,
				s32 signal, gfp_t gfp);

static inline struct cfg80211_bss * __must_check
3719
cfg80211_inform_bss_frame(struct wiphy *wiphy,
3720
			  struct ieee80211_channel *rx_channel,
3721
			  struct ieee80211_mgmt *mgmt, size_t len,
3722 3723
			  s32 signal, gfp_t gfp)
{
3724
	return cfg80211_inform_bss_width_frame(wiphy, rx_channel,
3725 3726 3727
					       NL80211_BSS_CHAN_WIDTH_20,
					       mgmt, len, signal, gfp);
}
3728

J
Johannes Berg 已提交
3729 3730 3731 3732
/**
 * cfg80211_inform_bss - inform cfg80211 of a new BSS
 *
 * @wiphy: the wiphy reporting the BSS
3733
 * @rx_channel: The channel the frame was received on
3734
 * @scan_width: width of the control channel
J
Johannes Berg 已提交
3735
 * @bssid: the BSSID of the BSS
3736
 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
J
Johannes Berg 已提交
3737 3738 3739 3740 3741 3742 3743 3744 3745
 * @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.
3746
 *
3747 3748
 * Return: A referenced struct, must be released with cfg80211_put_bss()!
 * Or %NULL on error.
J
Johannes Berg 已提交
3749
 */
3750
struct cfg80211_bss * __must_check
3751
cfg80211_inform_bss_width(struct wiphy *wiphy,
3752
			  struct ieee80211_channel *rx_channel,
3753 3754 3755 3756 3757 3758
			  enum nl80211_bss_scan_width scan_width,
			  const u8 *bssid, u64 tsf, u16 capability,
			  u16 beacon_interval, const u8 *ie, size_t ielen,
			  s32 signal, gfp_t gfp);

static inline struct cfg80211_bss * __must_check
3759
cfg80211_inform_bss(struct wiphy *wiphy,
3760
		    struct ieee80211_channel *rx_channel,
3761 3762
		    const u8 *bssid, u64 tsf, u16 capability,
		    u16 beacon_interval, const u8 *ie, size_t ielen,
3763 3764
		    s32 signal, gfp_t gfp)
{
3765
	return cfg80211_inform_bss_width(wiphy, rx_channel,
3766 3767 3768 3769 3770
					 NL80211_BSS_CHAN_WIDTH_20,
					 bssid, tsf, capability,
					 beacon_interval, ie, ielen, signal,
					 gfp);
}
3771

3772 3773 3774
struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
				      struct ieee80211_channel *channel,
				      const u8 *bssid,
3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785
				      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);
}

3786 3787
/**
 * cfg80211_ref_bss - reference BSS struct
3788
 * @wiphy: the wiphy this BSS struct belongs to
3789 3790 3791 3792
 * @bss: the BSS struct to reference
 *
 * Increments the refcount of the given BSS struct.
 */
3793
void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3794 3795 3796

/**
 * cfg80211_put_bss - unref BSS struct
3797
 * @wiphy: the wiphy this BSS struct belongs to
3798 3799 3800 3801
 * @bss: the BSS struct
 *
 * Decrements the refcount of the given BSS struct.
 */
3802
void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
J
Johannes Berg 已提交
3803

3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814
/**
 * 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 已提交
3815

3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828
static inline enum nl80211_bss_scan_width
cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
{
	switch (chandef->width) {
	case NL80211_CHAN_WIDTH_5:
		return NL80211_BSS_CHAN_WIDTH_5;
	case NL80211_CHAN_WIDTH_10:
		return NL80211_BSS_CHAN_WIDTH_10;
	default:
		return NL80211_BSS_CHAN_WIDTH_20;
	}
}

3829
/**
3830
 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
3831 3832 3833 3834
 * @dev: network device
 * @buf: authentication frame (header + body)
 * @len: length of the frame data
 *
3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846
 * This function is called whenever an authentication, disassociation or
 * deauthentication frame has been received and processed in station mode.
 * After being asked to authenticate via cfg80211_ops::auth() the driver must
 * call either this function or cfg80211_auth_timeout().
 * After being asked to associate via cfg80211_ops::assoc() the driver must
 * call either this function or cfg80211_auth_timeout().
 * While connected, the driver must calls this for received and processed
 * disassociation and deauthentication frames. If the frame couldn't be used
 * because it was unprotected, the driver must call the function
 * cfg80211_rx_unprot_mlme_mgmt() instead.
 *
 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3847
 */
3848
void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
3849

3850
/**
3851
 * cfg80211_auth_timeout - notification of timed out authentication
3852 3853
 * @dev: network device
 * @addr: The MAC address of the device with which the authentication timed out
3854
 *
3855 3856
 * This function may sleep. The caller must hold the corresponding wdev's
 * mutex.
3857
 */
3858
void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
3859

3860
/**
3861
 * cfg80211_rx_assoc_resp - notification of processed association response
3862
 * @dev: network device
3863 3864 3865
 * @bss: the BSS that association was requested with, ownership of the pointer
 *	moves to cfg80211 in this call
 * @buf: authentication frame (header + body)
3866 3867
 * @len: length of the frame data
 *
3868 3869 3870 3871
 * After being asked to associate via cfg80211_ops::assoc() the driver must
 * call either this function or cfg80211_auth_timeout().
 *
 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3872
 */
3873 3874
void cfg80211_rx_assoc_resp(struct net_device *dev,
			    struct cfg80211_bss *bss,
3875
			    const u8 *buf, size_t len);
3876

3877
/**
3878
 * cfg80211_assoc_timeout - notification of timed out association
3879
 * @dev: network device
3880
 * @bss: The BSS entry with which association timed out.
3881
 *
3882
 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3883
 */
3884
void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
3885

3886
/**
3887
 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
3888
 * @dev: network device
3889
 * @buf: 802.11 frame (header + body)
3890 3891 3892
 * @len: length of the frame data
 *
 * This function is called whenever deauthentication has been processed in
3893
 * station mode. This includes both received deauthentication frames and
3894 3895
 * locally generated ones. This function may sleep. The caller must hold the
 * corresponding wdev's mutex.
3896
 */
3897
void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
3898

3899
/**
3900
 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
3901 3902 3903 3904
 * @dev: network device
 * @buf: deauthentication frame (header + body)
 * @len: length of the frame data
 *
3905 3906
 * This function is called whenever a received deauthentication or dissassoc
 * frame has been dropped in station mode because of MFP being used but the
3907 3908
 * frame was not protected. This function may sleep.
 */
3909 3910
void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
				  const u8 *buf, size_t len);
3911

3912 3913 3914 3915 3916
/**
 * 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
3917
 * @key_id: Key identifier (0..3). Can be -1 if missing.
3918
 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3919
 * @gfp: allocation flags
3920 3921 3922 3923 3924 3925 3926
 *
 * 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,
3927
				  const u8 *tsc, gfp_t gfp);
3928

J
Johannes Berg 已提交
3929 3930 3931 3932 3933
/**
 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
 *
 * @dev: network device
 * @bssid: the BSSID of the IBSS joined
3934
 * @channel: the channel of the IBSS joined
J
Johannes Berg 已提交
3935 3936 3937 3938 3939 3940 3941 3942 3943
 * @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.
 */
3944 3945
void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
			  struct ieee80211_channel *channel, gfp_t gfp);
J
Johannes Berg 已提交
3946

3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962
/**
 * 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 已提交
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976
/**
 * 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 已提交
3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995
/**
 * 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);

J
Johannes Berg 已提交
3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020
/**
 * DOC: Vendor commands
 *
 * Occasionally, there are special protocol or firmware features that
 * can't be implemented very openly. For this and similar cases, the
 * vendor command functionality allows implementing the features with
 * (typically closed-source) userspace and firmware, using nl80211 as
 * the configuration mechanism.
 *
 * A driver supporting vendor commands must register them as an array
 * in struct wiphy, with handlers for each one, each command has an
 * OUI and sub command ID to identify it.
 *
 * Note that this feature should not be (ab)used to implement protocol
 * features that could openly be shared across drivers. In particular,
 * it must never be required to use vendor commands to implement any
 * "normal" functionality that higher-level userspace like connection
 * managers etc. need.
 */

struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
					   enum nl80211_commands cmd,
					   enum nl80211_attrs attr,
					   int approxlen);

4021 4022 4023 4024 4025 4026 4027 4028
struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
					   enum nl80211_commands cmd,
					   enum nl80211_attrs attr,
					   int vendor_event_idx,
					   int approxlen, gfp_t gfp);

void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);

J
Johannes Berg 已提交
4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072
/**
 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command 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
 * a vendor command. Since it is intended for a reply, calling
 * it outside of a vendor command's doit() operation is invalid.
 *
 * The returned skb is pre-filled with some identifying data 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_VENDOR_DATA 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 vendor data attribute.
 * You must not modify the skb in any other way.
 *
 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
 * its error code as the result of the doit() operation.
 *
 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
 */
static inline struct sk_buff *
cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
{
	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
					  NL80211_ATTR_VENDOR_DATA, approxlen);
}

/**
 * cfg80211_vendor_cmd_reply - send the reply skb
 * @skb: The skb, must have been allocated with
 *	cfg80211_vendor_cmd_alloc_reply_skb()
 *
 * Since calling this function will usually be the last thing
 * before returning from the vendor command doit() 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.
 */
int cfg80211_vendor_cmd_reply(struct sk_buff *skb);

4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110
/**
 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
 * @wiphy: the wiphy
 * @event_idx: index of the vendor event in the wiphy's vendor_events
 * @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
 * vendor-specific multicast group.
 *
 * When done filling the skb, call cfg80211_vendor_event() with the
 * skb to send the event.
 *
 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
 */
static inline struct sk_buff *
cfg80211_vendor_event_alloc(struct wiphy *wiphy, int approxlen,
			    int event_idx, gfp_t gfp)
{
	return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_VENDOR,
					  NL80211_ATTR_VENDOR_DATA,
					  event_idx, approxlen, gfp);
}

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

4111
#ifdef CONFIG_NL80211_TESTMODE
J
Johannes Berg 已提交
4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122
/**
 * 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.
 */

4123 4124 4125 4126 4127 4128 4129 4130 4131 4132
/**
 * 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.
 *
4133 4134 4135 4136 4137 4138 4139
 * 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.
4140 4141 4142
 *
 * When done, call cfg80211_testmode_reply() with the skb and return
 * its error code as the result of the @testmode_cmd operation.
4143 4144
 *
 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4145
 */
J
Johannes Berg 已提交
4146 4147 4148 4149 4150 4151
static inline struct sk_buff *
cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
{
	return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
					  NL80211_ATTR_TESTDATA, approxlen);
}
4152 4153 4154 4155 4156 4157

/**
 * cfg80211_testmode_reply - send the reply skb
 * @skb: The skb, must have been allocated with
 *	cfg80211_testmode_alloc_reply_skb()
 *
4158 4159 4160 4161 4162 4163
 * 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.
4164
 */
J
Johannes Berg 已提交
4165 4166 4167 4168
static inline int cfg80211_testmode_reply(struct sk_buff *skb)
{
	return cfg80211_vendor_cmd_reply(skb);
}
4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179

/**
 * 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.
 *
4180 4181 4182 4183 4184
 * 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.
4185 4186 4187
 *
 * When done filling the skb, call cfg80211_testmode_event() with the
 * skb to send the event.
4188 4189
 *
 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4190
 */
4191 4192 4193 4194 4195 4196 4197
static inline struct sk_buff *
cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
{
	return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_TESTMODE,
					  NL80211_ATTR_TESTDATA, -1,
					  approxlen, gfp);
}
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208

/**
 * 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.
 */
4209 4210 4211 4212
static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
{
	__cfg80211_send_event_skb(skb, gfp);
}
4213 4214

#define CFG80211_TESTMODE_CMD(cmd)	.testmode_cmd = (cmd),
W
Wey-Yi Guy 已提交
4215
#define CFG80211_TESTMODE_DUMP(cmd)	.testmode_dump = (cmd),
4216 4217
#else
#define CFG80211_TESTMODE_CMD(cmd)
W
Wey-Yi Guy 已提交
4218
#define CFG80211_TESTMODE_DUMP(cmd)
4219 4220
#endif

S
Samuel Ortiz 已提交
4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246
/**
 * 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
4247
 * @channel: the channel of the new AP
S
Samuel Ortiz 已提交
4248 4249 4250 4251 4252 4253 4254 4255 4256 4257
 * @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.
 */
4258 4259 4260
void cfg80211_roamed(struct net_device *dev,
		     struct ieee80211_channel *channel,
		     const u8 *bssid,
S
Samuel Ortiz 已提交
4261 4262 4263
		     const u8 *req_ie, size_t req_ie_len,
		     const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);

4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289
/**
 * 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 已提交
4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304
/**
 * 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);

4305 4306
/**
 * cfg80211_ready_on_channel - notification of remain_on_channel start
4307
 * @wdev: wireless device
4308 4309 4310 4311 4312 4313
 * @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
 */
4314
void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4315 4316 4317 4318 4319
			       struct ieee80211_channel *chan,
			       unsigned int duration, gfp_t gfp);

/**
 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4320
 * @wdev: wireless device
4321 4322 4323 4324
 * @cookie: the request cookie
 * @chan: The current channel (from remain_on_channel request)
 * @gfp: allocation flags
 */
4325
void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4326 4327
					struct ieee80211_channel *chan,
					gfp_t gfp);
S
Samuel Ortiz 已提交
4328

4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340

/**
 * 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);

4341 4342 4343 4344 4345 4346 4347 4348 4349
/**
 * 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);

4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368
/**
 * 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);

4369
/**
4370
 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4371
 * @wdev: wireless device receiving the frame
4372
 * @freq: Frequency on which the frame was received in MHz
4373
 * @sig_dbm: signal strength in mBm, or 0 if unknown
4374
 * @buf: Management frame (header + body)
4375
 * @len: length of the frame data
4376
 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4377
 * @gfp: context flags
4378
 *
4379 4380 4381 4382
 * 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.
4383 4384 4385
 * 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.
4386
 */
4387
bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4388
		      const u8 *buf, size_t len, u32 flags, gfp_t gfp);
4389 4390

/**
4391
 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4392
 * @wdev: wireless device receiving the frame
4393 4394
 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
 * @buf: Management frame (header + body)
4395 4396 4397 4398
 * @len: length of the frame data
 * @ack: Whether frame was acknowledged
 * @gfp: context flags
 *
4399 4400
 * 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
4401 4402
 * transmission attempt.
 */
4403
void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4404
			     const u8 *buf, size_t len, bool ack, gfp_t gfp);
4405

4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419

/**
 * 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);

4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433
/**
 * cfg80211_radar_event - radar detection event
 * @wiphy: the wiphy
 * @chandef: chandef for the current channel
 * @gfp: context flags
 *
 * This function is called when a radar is detected on the current chanenl.
 */
void cfg80211_radar_event(struct wiphy *wiphy,
			  struct cfg80211_chan_def *chandef, gfp_t gfp);

/**
 * cfg80211_cac_event - Channel availability check (CAC) event
 * @netdev: network device
4434
 * @chandef: chandef for the current channel
4435 4436 4437 4438 4439 4440 4441 4442
 * @event: type of event
 * @gfp: context flags
 *
 * This function is called when a Channel availability check (CAC) is finished
 * or aborted. This must be called to notify the completion of a CAC process,
 * also by full-MAC drivers.
 */
void cfg80211_cac_event(struct net_device *netdev,
4443
			const struct cfg80211_chan_def *chandef,
4444 4445 4446
			enum nl80211_radar_event event, gfp_t gfp);


4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458
/**
 * 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);

4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473
/**
 * 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);

4474 4475 4476 4477 4478
/**
 * 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 已提交
4479
 * @gfp: allocation flags
4480 4481 4482 4483
 */
void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
			       const u8 *replay_ctr, gfp_t gfp);

4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494
/**
 * 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);

4495 4496 4497 4498 4499 4500 4501 4502 4503
/**
 * 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.
4504
 * Return: %true if the frame was passed to userspace (or this failed
4505 4506 4507 4508 4509
 * for a reason other than not having a subscription.)
 */
bool cfg80211_rx_spurious_frame(struct net_device *dev,
				const u8 *addr, gfp_t gfp);

4510 4511 4512 4513 4514 4515 4516 4517 4518 4519
/**
 * 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.
4520
 * Return: %true if the frame was passed to userspace (or this failed
4521 4522 4523 4524 4525
 * 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 已提交
4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536
/**
 * 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);

4537 4538 4539 4540 4541 4542
/**
 * 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
4543
 * @sig_dbm: signal strength in mBm, or 0 if unknown
4544 4545 4546 4547 4548 4549 4550
 *
 * 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,
4551
				 int freq, int sig_dbm);
4552

4553
/**
4554
 * cfg80211_reg_can_beacon - check if beaconing is allowed
4555
 * @wiphy: the wiphy
4556
 * @chandef: the channel definition
4557
 * @iftype: interface type
4558
 *
4559 4560
 * 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.)
4561
 */
4562
bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4563 4564
			     struct cfg80211_chan_def *chandef,
			     enum nl80211_iftype iftype);
4565

4566 4567 4568
/*
 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
 * @dev: the device which switched channels
4569
 * @chandef: the new channel definition
4570
 *
4571 4572
 * Caller must acquire wdev_lock, therefore must only be called from sleepable
 * driver context!
4573
 */
4574 4575
void cfg80211_ch_switch_notify(struct net_device *dev,
			       struct cfg80211_chan_def *chandef);
4576

4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587
/**
 * ieee80211_operating_class_to_band - convert operating class to band
 *
 * @operating_class: the operating class to convert
 * @band: band pointer to fill
 *
 * Returns %true if the conversion was successful, %false otherwise.
 */
bool ieee80211_operating_class_to_band(u8 operating_class,
				       enum ieee80211_band *band);

4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606
/*
 * 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);

4607 4608 4609 4610 4611 4612
/*
 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
 * @rate: given rate_info to calculate bitrate from
 *
 * return 0 if MCS index >= 32
 */
4613
u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4614

4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630
/**
 * 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);

4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654
/**
 * struct cfg80211_ft_event - FT Information Elements
 * @ies: FT IEs
 * @ies_len: length of the FT IE in bytes
 * @target_ap: target AP's MAC address
 * @ric_ies: RIC IE
 * @ric_ies_len: length of the RIC IE in bytes
 */
struct cfg80211_ft_event_params {
	const u8 *ies;
	size_t ies_len;
	const u8 *target_ap;
	const u8 *ric_ies;
	size_t ric_ies_len;
};

/**
 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
 * @netdev: network device
 * @ft_event: IE information
 */
void cfg80211_ft_event(struct net_device *netdev,
		       struct cfg80211_ft_event_params *ft_event);

4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666
/**
 * 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.
 *
4667 4668 4669
 * 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).
4670
 */
4671 4672 4673
int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
			  enum ieee80211_p2p_attr_id attr,
			  u8 *buf, unsigned int bufsize);
4674

4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689
/**
 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
 * @wdev: the wireless device reporting the wakeup
 * @wakeup: the wakeup report
 * @gfp: allocation flags
 *
 * This function reports that the given device woke up. If it
 * caused the wakeup, report the reason(s), otherwise you may
 * pass %NULL as the @wakeup parameter to advertise that something
 * else caused the wakeup.
 */
void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
				   struct cfg80211_wowlan_wakeup *wakeup,
				   gfp_t gfp);

4690 4691 4692 4693
/**
 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
 *
 * @wdev: the wireless device for which critical protocol is stopped.
4694
 * @gfp: allocation flags
4695 4696 4697 4698 4699 4700 4701
 *
 * This function can be called by the driver to indicate it has reverted
 * operation back to normal. One reason could be that the duration given
 * by .crit_proto_start() has expired.
 */
void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);

4702 4703 4704 4705 4706 4707 4708 4709
/**
 * ieee80211_get_num_supported_channels - get number of channels device has
 * @wiphy: the wiphy
 *
 * Return: the number of channels supported by the device.
 */
unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);

4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731
/**
 * cfg80211_check_combinations - check interface combinations
 *
 * @wiphy: the wiphy
 * @num_different_channels: the number of different channels we want
 *	to use for verification
 * @radar_detect: a bitmap where each bit corresponds to a channel
 *	width where radar detection is needed, as in the definition of
 *	&struct ieee80211_iface_combination.@radar_detect_widths
 * @iftype_num: array with the numbers of interfaces of each interface
 *	type.  The index is the interface type as specified in &enum
 *	nl80211_iftype.
 *
 * This function can be called by the driver to check whether a
 * combination of interfaces and their types are allowed according to
 * the interface combinations.
 */
int cfg80211_check_combinations(struct wiphy *wiphy,
				const int num_different_channels,
				const u8 radar_detect,
				const int iftype_num[NUM_NL80211_IFTYPES]);

4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758
/**
 * cfg80211_iter_combinations - iterate over matching combinations
 *
 * @wiphy: the wiphy
 * @num_different_channels: the number of different channels we want
 *	to use for verification
 * @radar_detect: a bitmap where each bit corresponds to a channel
 *	width where radar detection is needed, as in the definition of
 *	&struct ieee80211_iface_combination.@radar_detect_widths
 * @iftype_num: array with the numbers of interfaces of each interface
 *	type.  The index is the interface type as specified in &enum
 *	nl80211_iftype.
 * @iter: function to call for each matching combination
 * @data: pointer to pass to iter function
 *
 * This function can be called by the driver to check what possible
 * combinations it fits in at a given moment, e.g. for channel switching
 * purposes.
 */
int cfg80211_iter_combinations(struct wiphy *wiphy,
			       const int num_different_channels,
			       const u8 radar_detect,
			       const int iftype_num[NUM_NL80211_IFTYPES],
			       void (*iter)(const struct ieee80211_iface_combination *c,
					    void *data),
			       void *data);

4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773
/*
 * cfg80211_stop_iface - trigger interface disconnection
 *
 * @wiphy: the wiphy
 * @wdev: wireless device
 * @gfp: context flags
 *
 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
 * disconnected.
 *
 * Note: This doesn't need any locks and is asynchronous.
 */
void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
			 gfp_t gfp);

4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787
/**
 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
 * @wiphy: the wiphy to shut down
 *
 * This function shuts down all interfaces belonging to this wiphy by
 * calling dev_close() (and treating non-netdev interfaces as needed).
 * It shouldn't really be used unless there are some fatal device errors
 * that really can't be recovered in any other way.
 *
 * Callers must hold the RTNL and be able to deal with callbacks into
 * the driver while the function is running.
 */
void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);

4788 4789 4790 4791 4792
/* Logging, debugging and troubleshooting/diagnostic helpers. */

/* wiphy_printk helpers, similar to dev_printk */

#define wiphy_printk(level, wiphy, format, args...)		\
4793
	dev_printk(level, &(wiphy)->dev, format, ##args)
4794
#define wiphy_emerg(wiphy, format, args...)			\
4795
	dev_emerg(&(wiphy)->dev, format, ##args)
4796
#define wiphy_alert(wiphy, format, args...)			\
4797
	dev_alert(&(wiphy)->dev, format, ##args)
4798
#define wiphy_crit(wiphy, format, args...)			\
4799
	dev_crit(&(wiphy)->dev, format, ##args)
4800
#define wiphy_err(wiphy, format, args...)			\
4801
	dev_err(&(wiphy)->dev, format, ##args)
4802
#define wiphy_warn(wiphy, format, args...)			\
4803
	dev_warn(&(wiphy)->dev, format, ##args)
4804
#define wiphy_notice(wiphy, format, args...)			\
4805
	dev_notice(&(wiphy)->dev, format, ##args)
4806
#define wiphy_info(wiphy, format, args...)			\
4807
	dev_info(&(wiphy)->dev, format, ##args)
4808

4809
#define wiphy_debug(wiphy, format, args...)			\
4810
	wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
4811

4812
#define wiphy_dbg(wiphy, format, args...)			\
4813
	dev_dbg(&(wiphy)->dev, format, ##args)
4814 4815 4816 4817 4818 4819 4820 4821

#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);	\
4822
	0;								\
4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833
})
#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);

4834
#endif /* __NET_CFG80211_H */